From 54bd2e7c5c868bae4426a47c1254df3954104522 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 5 Feb 2025 06:55:08 +0000 Subject: [PATCH] deploy: 18f183f48b59444fa3257cf55114bd21286fcf45 --- 404.html | 2 +- assets/js/0028a090.a380af4b.js | 1 - assets/js/0028a090.a94482e8.js | 1 + assets/js/{05632a52.3fd7ce82.js => 05632a52.8538abf4.js} | 2 +- assets/js/13fdae3b.53df0513.js | 1 + assets/js/13fdae3b.f0293d27.js | 1 - assets/js/1f73ca32.03dc5da3.js | 1 - assets/js/1f73ca32.e34356e0.js | 1 + assets/js/{2304e9ae.0fd4454c.js => 2304e9ae.4e6965bb.js} | 2 +- assets/js/28b19cd2.339692dc.js | 1 - assets/js/28b19cd2.5f8c6828.js | 1 + assets/js/{2c586be5.27d9bbd6.js => 2c586be5.b14fac44.js} | 2 +- assets/js/{377084eb.9fbdad2a.js => 377084eb.8bd89dab.js} | 2 +- assets/js/{451a5132.96a74160.js => 451a5132.0072a94c.js} | 2 +- assets/js/{52d5c0f9.bfb8a30b.js => 52d5c0f9.7cfe3494.js} | 2 +- assets/js/{5a2de241.cdeb663e.js => 5a2de241.4d9dbd85.js} | 2 +- assets/js/5c04ee3b.5ef75d8a.js | 1 + assets/js/5c04ee3b.88bc73b1.js | 1 - assets/js/{5ce9853b.efeea564.js => 5ce9853b.28eaefb4.js} | 2 +- assets/js/70853c19.77dd1140.js | 1 - assets/js/70853c19.9bc6455d.js | 1 + assets/js/770b40a9.523b2d80.js | 1 + assets/js/770b40a9.f67103b7.js | 1 - assets/js/{78b2b753.6a17860a.js => 78b2b753.f380f604.js} | 2 +- assets/js/7b076186.35a41943.js | 1 + assets/js/7b076186.cd43640b.js | 1 - assets/js/8a725248.6792c484.js | 1 + assets/js/8a725248.a9980afb.js | 1 - assets/js/8a855f99.4657d57d.js | 1 + assets/js/8a855f99.64ee91b4.js | 1 - assets/js/a2bc1463.7b31efc4.js | 1 - assets/js/a2bc1463.a7b94822.js | 1 + assets/js/{a88a3db3.cfc4bd5c.js => a88a3db3.e09eee0c.js} | 2 +- assets/js/a9f09360.553c32a0.js | 1 + assets/js/a9f09360.7b2c4570.js | 1 - assets/js/{ada7accb.4c376fed.js => ada7accb.40681dfc.js} | 2 +- assets/js/ae010e44.9a975364.js | 1 - assets/js/ae010e44.a965d111.js | 1 + assets/js/bbdfc22d.3855f22e.js | 1 + assets/js/bbdfc22d.c296f0c4.js | 1 - assets/js/bfe4b778.6b36ff91.js | 1 + assets/js/bfe4b778.953e8551.js | 1 - assets/js/f0ff4a36.28386b54.js | 1 + assets/js/f0ff4a36.d1136268.js | 1 - assets/js/fa40969b.e283f01a.js | 1 + assets/js/fa40969b.e9a4c1eb.js | 1 - .../js/{runtime~main.0f6d8860.js => runtime~main.a74dc2c1.js} | 2 +- blog/archive/index.html | 2 +- blog/first-blog-post/index.html | 2 +- blog/index.html | 2 +- blog/long-blog-post/index.html | 2 +- blog/mdx-blog-post/index.html | 2 +- blog/tags/docusaurus/index.html | 2 +- blog/tags/facebook/index.html | 2 +- blog/tags/hello/index.html | 2 +- blog/tags/hola/index.html | 2 +- blog/tags/index.html | 2 +- blog/welcome/index.html | 2 +- docs/API-docs/contactlist/index.html | 2 +- docs/API-docs/createcontact/index.html | 2 +- docs/API-docs/createdocument/index.html | 2 +- docs/API-docs/createdocumentwithtemplateid/index.html | 2 +- docs/API-docs/createfolder/index.html | 2 +- docs/API-docs/createtemplate/index.html | 2 +- docs/API-docs/delete-template/index.html | 2 +- docs/API-docs/delete-webhook/index.html | 2 +- docs/API-docs/deletecontact/index.html | 2 +- docs/API-docs/deletedocument/index.html | 2 +- docs/API-docs/deletefolder/index.html | 2 +- docs/API-docs/draftdocument/index.html | 2 +- docs/API-docs/drafttemplate/index.html | 2 +- docs/API-docs/folderlist/index.html | 2 +- docs/API-docs/get-template/index.html | 2 +- docs/API-docs/get-user/index.html | 2 +- docs/API-docs/get-webhook/index.html | 2 +- docs/API-docs/getcontact/index.html | 2 +- docs/API-docs/getdocument/index.html | 2 +- docs/API-docs/getdocumentlist/index.html | 2 +- docs/API-docs/getfolder/index.html | 2 +- docs/API-docs/gettemplatelist/index.html | 2 +- docs/API-docs/intro/index.html | 2 +- docs/API-docs/opensign-api-v-1/index.html | 2 +- docs/API-docs/resendrequestmail/index.html | 2 +- docs/API-docs/save-update-webhook/index.html | 2 +- docs/API-docs/selfsign/index.html | 2 +- docs/API-docs/update-document/index.html | 2 +- docs/API-docs/update-template/index.html | 2 +- docs/API-docs/updatefolder/index.html | 2 +- docs/category/cloud-storage/index.html | 2 +- docs/category/create-new-opensign-document/index.html | 2 +- docs/category/docker/index.html | 2 +- docs/category/faqs/index.html | 2 +- docs/category/guides/index.html | 2 +- docs/category/manage-docs-using-opensign-drive/index.html | 2 +- docs/category/reports/index.html | 2 +- docs/category/settings/index.html | 2 +- docs/category/templates/index.html | 2 +- docs/contribute/CODE_OF_CONDUCT/index.html | 2 +- docs/contribute/COMMUNITY/index.html | 2 +- docs/contribute/INSTALLATION/index.html | 2 +- docs/contribute/REPORTING_GUIDELINES/index.html | 2 +- docs/contribute/intro/index.html | 2 +- .../index.html | 2 +- docs/help/FAQs/index.html | 2 +- docs/help/New-Document/enforce-email-verification/index.html | 2 +- docs/help/New-Document/navigate-between-pages/index.html | 2 +- docs/help/New-Document/request-signatures/index.html | 2 +- docs/help/New-Document/sign-yourself/index.html | 2 +- docs/help/OpenSign™ Drive/create-document/index.html | 2 +- docs/help/OpenSign™ Drive/list-grid-view/index.html | 2 +- docs/help/OpenSign™ Drive/organize-documents/index.html | 2 +- docs/help/OpenSign™ Drive/rename-document/index.html | 2 +- docs/help/Reports/completed/index.html | 2 +- docs/help/Reports/contactbook/index.html | 2 +- docs/help/Reports/declined/index.html | 2 +- docs/help/Reports/drafts/index.html | 2 +- docs/help/Reports/expired/index.html | 2 +- docs/help/Reports/in-progress/index.html | 2 +- docs/help/Reports/need-your-sign/index.html | 2 +- docs/help/Settings/disabledocumentid/index.html | 2 +- docs/help/Settings/manage-users/index.html | 2 +- docs/help/Settings/my-signature/index.html | 2 +- docs/help/Templates/create-template/index.html | 2 +- docs/help/Templates/embed-template/index.html | 2 +- docs/help/Templates/publicTemplate/index.html | 2 +- docs/help/Templates/quick-send/index.html | 2 +- docs/help/Templates/use-template/index.html | 2 +- docs/help/intro/index.html | 2 +- docs/intro/index.html | 2 +- docs/self-host/One-click-Install/DigitalOcean/index.html | 2 +- docs/self-host/cloud-storage/s3/index.html | 2 +- docs/self-host/docker/run-locally/index.html | 2 +- docs/self-host/docker/upgrade-deployment/index.html | 2 +- docs/self-host/guides/env-variables/index.html | 2 +- .../index.html | 2 +- docs/self-host/guides/upgrade-to-v2.1.0/index.html | 2 +- docs/self-host/intro/index.html | 2 +- index.html | 2 +- markdown-page/index.html | 2 +- 139 files changed, 122 insertions(+), 122 deletions(-) delete mode 100644 assets/js/0028a090.a380af4b.js create mode 100644 assets/js/0028a090.a94482e8.js rename assets/js/{05632a52.3fd7ce82.js => 05632a52.8538abf4.js} (59%) create mode 100644 assets/js/13fdae3b.53df0513.js delete mode 100644 assets/js/13fdae3b.f0293d27.js delete mode 100644 assets/js/1f73ca32.03dc5da3.js create mode 100644 assets/js/1f73ca32.e34356e0.js rename assets/js/{2304e9ae.0fd4454c.js => 2304e9ae.4e6965bb.js} (54%) delete mode 100644 assets/js/28b19cd2.339692dc.js create mode 100644 assets/js/28b19cd2.5f8c6828.js rename assets/js/{2c586be5.27d9bbd6.js => 2c586be5.b14fac44.js} (72%) rename assets/js/{377084eb.9fbdad2a.js => 377084eb.8bd89dab.js} (62%) rename assets/js/{451a5132.96a74160.js => 451a5132.0072a94c.js} (59%) rename assets/js/{52d5c0f9.bfb8a30b.js => 52d5c0f9.7cfe3494.js} (52%) rename assets/js/{5a2de241.cdeb663e.js => 5a2de241.4d9dbd85.js} (54%) create mode 100644 assets/js/5c04ee3b.5ef75d8a.js delete mode 100644 assets/js/5c04ee3b.88bc73b1.js rename assets/js/{5ce9853b.efeea564.js => 5ce9853b.28eaefb4.js} (59%) delete mode 100644 assets/js/70853c19.77dd1140.js create mode 100644 assets/js/70853c19.9bc6455d.js create mode 100644 assets/js/770b40a9.523b2d80.js delete mode 100644 assets/js/770b40a9.f67103b7.js rename assets/js/{78b2b753.6a17860a.js => 78b2b753.f380f604.js} (57%) create mode 100644 assets/js/7b076186.35a41943.js delete mode 100644 assets/js/7b076186.cd43640b.js create mode 100644 assets/js/8a725248.6792c484.js delete mode 100644 assets/js/8a725248.a9980afb.js create mode 100644 assets/js/8a855f99.4657d57d.js delete mode 100644 assets/js/8a855f99.64ee91b4.js delete mode 100644 assets/js/a2bc1463.7b31efc4.js create mode 100644 assets/js/a2bc1463.a7b94822.js rename assets/js/{a88a3db3.cfc4bd5c.js => a88a3db3.e09eee0c.js} (61%) create mode 100644 assets/js/a9f09360.553c32a0.js delete mode 100644 assets/js/a9f09360.7b2c4570.js rename assets/js/{ada7accb.4c376fed.js => ada7accb.40681dfc.js} (57%) delete mode 100644 assets/js/ae010e44.9a975364.js create mode 100644 assets/js/ae010e44.a965d111.js create mode 100644 assets/js/bbdfc22d.3855f22e.js delete mode 100644 assets/js/bbdfc22d.c296f0c4.js create mode 100644 assets/js/bfe4b778.6b36ff91.js delete mode 100644 assets/js/bfe4b778.953e8551.js create mode 100644 assets/js/f0ff4a36.28386b54.js delete mode 100644 assets/js/f0ff4a36.d1136268.js create mode 100644 assets/js/fa40969b.e283f01a.js delete mode 100644 assets/js/fa40969b.e9a4c1eb.js rename assets/js/{runtime~main.0f6d8860.js => runtime~main.a74dc2c1.js} (67%) diff --git a/404.html b/404.html index e573bfa11..5b331921b 100644 --- a/404.html +++ b/404.html @@ -5,7 +5,7 @@ Page Not Found | OpenSign™ - + diff --git a/assets/js/0028a090.a380af4b.js b/assets/js/0028a090.a380af4b.js deleted file mode 100644 index e17c3fffa..000000000 --- a/assets/js/0028a090.a380af4b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7917],{58760:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>f,contentTitle:()=>u,default:()=>y,frontMatter:()=>m,metadata:()=>x,toc:()=>j});var i=s(85893),t=s(11151),a=s(58219),l=(s(62316),s(51039)),r=s.n(l),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),h=s(9472),p=s(85162);const m={id:"drafttemplate",title:"Draft Template",description:"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.",sidebar_label:"Draft Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztO9tyGzeyv4KdlySsISXSsuKwTp06iq04dKzLseT4IqpkcKZJwpoBxgBGFO3i237Jftp+yaluAMMhRUqyndrV1uGLLQ4ajUajb2h0f4ksH5moexadQl5k3IKJzuMoBZNoUVihZNSNTsfAwjB7pvnQCjlie8c9BpIPMjCsNKANs4olGhAoKY1VufiMo8wGzDEzoK9wLjdskJVQaCGtYUOl2QgkaE6IU5WUOeDARNgxKzSkMBQSUmasLhNbajAt9rpQkpkyScCYYZm5lYWSTA0Zr9aMmR0DkarBlloaxlkpxacSWKOhBh8hsb200WA/pmDESHILKRIXpl+I9KeYTcYiGbOESzYA3GqKO/UEQ43cAccxJWlNU0AihgKBPbIW20tTgTTyLJvGjLNGo9RZo8GEYYVWVyKFNKymhkNkKSfWMiEt6CFPgHgFiEWOaJmAnHGZsiFPRCbsIhtZKozVYlDiyq2+7MtTUXTZ6yJTPGVTVWp2/Oy3ObhVDL+dNRrPYFCO2Oteo3H+49jawnS3tnhRtFQBErmV8YFpJSrfShGwSIfEK9CAWIlfwI3IpoynKZuIdATW0IFIlqhiyhKldCqkE42Cj4DJMh+ANjHtJlcamJCMMw08nTatapYG2IuTo0NkQ85tix1npYmr5VKhIbHZ1KFH9oRd/eBOZ3cHZUjIUcxyfolcEpZ9KkVyids2IOlovci0+pIxxvqy0XiDNFccEsbLecqYHQvDJjAYK3XJ4AqHJyLLmNViNALdaBCSDx8+OGRf3H+ENyLwftRl/cjj60dxHSAIaD/q9qNnR09fH+wfnl70nvWjOtRQZOCwVCCvX71cQiV5vgx0uHewvwylrIc6zoAbYBquBEzoOPDE3XYDI5Ym14yGw7E0jghAGxw7m39f4MkyrSe954f7r25S6vmXc5EtAO4f7PVeroAsxkouojz+/ehwFc5S1zD2Dp87VtahZvMf5wv782e454/0tHewf3K6d3Acps/68sOHDyRPJ2VRKI0C9MapRRcFpS9/hUxNGNdAMpioPFeSFVzzHCxZ2DG3NKzhUyk0pM5E8iwL+tVFNE3WaNhpAd1Gg/VkKhJUMWcupgWghXTQLQeKqoegJ95kOdCaQqJNc2YJNW3CnZUoMjRICKoBrZ0VV7CI+DpmU0T8DFCwHNqx0uKzkpZnJFVXoK1IeFY3BkggmVDLNZmyQglpw1e/AnvnlR5tAqm6t1ZIWorsyoWkEQPsimclGE/VJGZjpOoVFBoMWW6PF1kpUzYGMRqvXY+nH0tjFxCz0gR7HKjwa4VzIvYCsW3IMwNMDBd4mfNLqK3GVOH8RIv9OmUpDHmZ2ZgJtGNWl9Bih8oyXhSZSMjHoltwDqzU0KRT9gLhCUGdQiKOnZ9Bz5IK9DFosXCQUPg5gTqUNOeYcHtkj+2YS6bk0kEnKlMa0S/JEH1fZCRLlLQgbYvtXXGREfVut4YJmWRlCmyQ8eQyphAhZhqdIh7LFLJMTWIn8gRCrpqYTgxiBjIUQyVxA1L55YWZO+PWKRqwSqNwLLCa1hCmzlXvC4YKF0YWBCVjZHpiYlzMPqoBs8JmEKPKFlxOY5a64AOu7UBdxywZQ3JJf2meCsUGpbVKun2lWhWpmkjPy6GS1ojPKzQyjHw9Qzsx24nZbsyexKy9HbN2J2btnZi1d2PWfhKzznbMOp2YdXZi1tl1ZHWeeFbzir91Atodx2RbYy572NxFy/tSGNJsNJmmssKTBSvcl+0WazQqfaLP5MLJVfUj1C/yyRVIP4qZG0Oz2Y+67Zj5D9foDh51fg4AU/y9i9x1vyf4u42n4X6P8Xen3Zczv2iHiLE8L24hBIf/eiLCTy9P+NF7634UTBt+RJvkYBf9tycLB2bzDT3CDQkprOCZWb+nAPHwtjWnbGlnO7gzkt712/JRy0PbUyArjJDtdENka2tDwQwQIZ0lFjxuzb3NGg64RR8aAzxV37v/Xdx/ZbPWM6ECeXicqJP2vez4uUXhAdnt9czwAA+PFXPCvpcRT5AR6LfWcwFHHx4LPFVhwMcCbmx7p9l+3Oxsd3YW2IB3cweQ5800bU6n0+9kobtBY3jk16dg0wezLgbEJMhQq3zFTYUuEnMoHz7R3yG6P8CYfgBVHgYTD4tpnJByqAfkVqV8+oNxqMLUKo5D+HkUN62RSUNIB6VfkrESiSceYUL0NsDbIGUhmsj4dOvgYKvGSvexmeeBvyx8xd9NYn39a5630rS1DLtwQrWvOUvTmK34vnogTVme5+u+uwF0l335CyqCD93W64IH+Neowwqpn6+/VlfmAzxVMqP16XK3WleW/MtYhNyPlxu2BKBhVGZcwzXeUo1LqtRyKt9uiZa0KCjRPMynSy3dB12GkTjBfjzyofxPXsBxB4sI8Mvd825srI5EwwiuCYfLISMxIqXMbozp3jHe+Xi4MSDb50lD+pXwQmByIQNr6SvYpLWKCHdotYs5HuryvdyAXdgMNyzMXHE1p9Oni0Z7m/yev5fc4vg8xMMz+zXKwqBLdrj8XZRzH7pEQ5j/rewYdD86r+a4Kzmktbls1WR2fos+sbnSpJDxAWQ3de3e2lDfjpesGnNwIBeyyiQQyduBAhrl10ujfnC2Qs/ctusCHox7UJPAZ5YJE9Ipi0yrz/b5JsoDSnAvEQNgYQIbVCL53SJfEXY/mXcWwR/PHUsgHCPAKtcXVrtjhYWjqTMGceRCirzMq6TlsMIaWJZ7L1/nF87ER5awQv14b6zAr+9Ywb8SrVmgL9uUWghJCTIMbHUw6EEenmWoUXa3C/wWm7HgNr/V4X29JoZ91TVxhZ9EUOchKy0069WwxY7QK2HG1E3CHFiSQGExX/a9OlqRfD8dbVMqqZ4jW++Z6lD/ahlcJ0z3kc4luv8yOfRw3xd8IdfuJ4z1bfwHCeQC2fcOllxCMHfPUOuygTmJ3kMzhp6sJdcfxZEqqJ5ByV4adaMUqybCW30UE2ow9leVTqPul8in8PFPnyDHmVsfDdZffIlMMoac41+BJKzYwHffKA7PqlEcUc4GyzeQaVHXPx9HMd4wCnxnA4M4aF73S4ByD+JR7O/tUTdyL+VRHME1zwsE9p8YyETh5ZhQzMKKt+GqvsxxGfqjqlxAPPg8+I1oaOpsqWTlmzDVMczmfJ0j41rzabRcHRPeBcM1zs2rHj6yadAVYVEjqrcqAoviSFjI66usOTWtvp7TCSjcCaV2v3YuHQvPv3pNnEfP7d8y0b/DrOD5PbnkRm8uvHhke3h/hDRE083502nM6MmidZfEBHjaLR/V13Sx4Y01T9c9qdde8sxYlVmKb2TAdYtetr+5FIeqsXiWlFQdVPmIhZ1VpFY7a8/i6PruzVyzRDXDez37MYOhZWVRgGaJ0hL0T/VM3IPZXGdnZxZH07u3N/2P3N7PeHiTu3f3hgod5kUg/w5aHz2ZxdH4blp/r0ox/o3E7uzO5r7Ol/lUFYIDlU4vgt2a3QUYnArCYblZTx7pFHSNEQOlMuDyBid6QxdkKfYDxiI/+HQXvaALbYJDcdVnGhLAahzKYAdbxXzQ4Z7XmX/ExNhsHz9QzGjKgUEoGfAZh3AAoaINyzAdhHBljFQjADwZY/2cdVTxIT7/UxURVpCp0gTyxtzQM34GGJbaMQhXuCLkaDFGrHGHKjjqe2/VTwe/oJOjUtSj0+N78JIi2KYrZnN+2u3S4WBHp8dYlySGPg5rsdem4kRgLV8AYRgXsSvBQ+1CZdunLukAkjiiQhndvDSx5SuCmuwmQakwKymK5ynQqvT2BuJ5OSQekSot1mH6+lNmLBRmgY9ERcXIU1XeRyrv4CRno5JeUyyqbChSorTsvK5ISFfXS/eftNShlMqLBUJike+cT4ErCFTDHzOQxk3nbMiNBR1jsS9yXpd4v6lQwnUBWoBMYCULNDjWXZR6Zdy0yIPFIp3Xr176Itiwh6CUA9RAhxhSVhYkNaQJVfFYOLnlrd8IlEjKLlBHQF+sC9MWyaQiL6weJu33abcCtMGaac2UHnEpPvsaaidJAxjzbEjWt3pTw5owXDfQjNgW6Qvm959//weSSpJ6kau0kl5zf8E6xjI+aypjZBUVE0MGruQ6vAhURs7EwbAZH8vhw4CmBD5tSxW4H7gWxtZqjsJz302lfAXIz6RGA/l+VCUUNDmta1VFl69tmqOjyiixWK5W+Z4lAbzdhzgnM78IevuHNZhKGhcGd7a38b+lCDSUiofi5Xn1fDb9WxTf/xZ6ewweqpZXieRcSn4dd343hcyTMQrJGkWbg9/u3+u36y2YvhgPnifiSLzovf7cax+KnunJV4+Tp73d3mXx9s+nL35pwfRFO+n8OX3b+dO+e5OZ3kclkt9fjN/LP83g6ePy3dv3+t3bnn735pXlbx7vDeRYDp7/JpLp44+DzrZ4+fTF9vs37cng+W/b7//8pXhPyH/bfn95uZ3kh08Hcg9hindv/1ccfdx/dPB5//PB6f71wefslxY//PTx6XXyy8Hl/m7zfU83D44Gf3z8ZItXj9NHh2/F7hM4gDfydPtlEtWlQchMSLgIR31B+77Aw56RUOysOvYTlYMdk6xTdbpWWP5euPpuq6eMj7iQDFmn/0IpAK2Vvv1Mv46y2xixs7190a6Y8PgmE3qSXnuoE+RUXYL81+60vrx1yyOp1zlJvbPfkXBANB4tbLb+3W3SQFJqYadR9+xLdN3khWi68e7Z+ew8jpCxChNPhTJEMbfjqBttLeehsCGHkhxnN8RmwjHc+70cENV7pVXsQCWXbmukr5VSXgltHaaWcdPG5YA081hzNC+H/OqS6y1U3K12a7u1Hc3iL0tIDJcpPgDd0G5eiK2r9ooZK23BWmhj+UjIUfPWWedz1p7g8bsTXmDwPDVRiD8AcxP+/OpQcSSQiWPgGN3jiaFUvZpn/faDbIR83MoU21wIlpNmIWe2kAZbdqIrElu1vNZZSCpRnqhKE0XzHUVVKgf/rJIzZ3NRr/IgIQ3SpvxBZ2eHLto/t+lG+ugJXfZ2dmfnjsO1iw8lVuvRu0v5L4Sh/tNiWBZFK8OghfBjTfQR4jwhh4oO1DP5qAB5gmE0SvxV++bNGbJE5VXlcgD/59//QTOCt6dl/saOSs0KNQGN7WnUnpXBtcDAFYGJMEMhFeXPeZ6BMZgtlBZGrrNMjKiUIUSDCS/4ABu8MNYU0ipXPlSzXabF3owB3zFw6AftqjquIEN7xTKlqOcJg6jSqrzevcYmSl8OkSRsTBtgQwMYvHZBmAJyzGWCwZ/TDwqrsMcL4+tCCwOMixyBqUdtOBSJQMRoZTVPLMu55COKj2K6wSMXitCOoNUAr0lGZaW7CGBTBIB1W6Q3jRZ7hhcv2jh+TMFykUHq7gAmdncwb3R9D9kA77sFLi8SMPNasAyuQJM9cDfoMstYoay71WKAWD9bRGQ1lwZzBI6gcDQV+3ykTmukfNpi+LCBDg4vaCgAmZCX2J3TZGeVmL2BgREW5tmLyWRywzb9tDjnubDjcsA0FGo+b0QfyZLVp1c/fkJLAjo3R8MTbMFMQki1Zs0tAt7yPpIn5CODfeCF+J/lCeivMpGANFDzaHvPj1+yK/aotb3gMu5B8NbL3tP9w5N9xIsOyulfcB3k1XIua0tRW2rVpbqsubUXlk0366abddPNuulm3XSzMrbpZt10s266WTfdrJtu1k0366abddPN2t90s/Y33aybbtZNN+umm3XOhk0366abddPNuulm3XSzbrpZN92sm27WTTfrppt108266WbddLNuuln/v3Sz+novDBy3iowLWSvadbWFZ0s9rudxNMbaw+5Z9OULvla/1tlshp8/laCxcPE8jq64Fpg9p7LFOJTLYYHZJUyjbvTUPQY0T3H52Ik9VaAsVWtitZ+bsUeHfytsvTzy+OjkNIqjge/DzVWKczSfYI8un0TdCG02tfNWlev0/UuUcTkqqeYtcnixyo+XdrxYInhJJYL+j1rpHJfTGpWLtYNuK/gvbmzlhP/CKpA/YPrfFbgbWTvB8zZA4wmez2az/wM1YMGT",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/drafttemplate",title:"Draft Template",description:"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.",source:"@site/docs/API-docs/drafttemplate.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/drafttemplate",permalink:"/docs/API-docs/drafttemplate",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"drafttemplate",title:"Draft Template",description:"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.",sidebar_label:"Draft Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztO9tyGzeyv4KdlySsISXSsuKwTp06iq04dKzLseT4IqpkcKZJwpoBxgBGFO3i237Jftp+yaluAMMhRUqyndrV1uGLLQ4ajUajb2h0f4ksH5moexadQl5k3IKJzuMoBZNoUVihZNSNTsfAwjB7pvnQCjlie8c9BpIPMjCsNKANs4olGhAoKY1VufiMo8wGzDEzoK9wLjdskJVQaCGtYUOl2QgkaE6IU5WUOeDARNgxKzSkMBQSUmasLhNbajAt9rpQkpkyScCYYZm5lYWSTA0Zr9aMmR0DkarBlloaxlkpxacSWKOhBh8hsb200WA/pmDESHILKRIXpl+I9KeYTcYiGbOESzYA3GqKO/UEQ43cAccxJWlNU0AihgKBPbIW20tTgTTyLJvGjLNGo9RZo8GEYYVWVyKFNKymhkNkKSfWMiEt6CFPgHgFiEWOaJmAnHGZsiFPRCbsIhtZKozVYlDiyq2+7MtTUXTZ6yJTPGVTVWp2/Oy3ObhVDL+dNRrPYFCO2Oteo3H+49jawnS3tnhRtFQBErmV8YFpJSrfShGwSIfEK9CAWIlfwI3IpoynKZuIdATW0IFIlqhiyhKldCqkE42Cj4DJMh+ANjHtJlcamJCMMw08nTatapYG2IuTo0NkQ85tix1npYmr5VKhIbHZ1KFH9oRd/eBOZ3cHZUjIUcxyfolcEpZ9KkVyids2IOlovci0+pIxxvqy0XiDNFccEsbLecqYHQvDJjAYK3XJ4AqHJyLLmNViNALdaBCSDx8+OGRf3H+ENyLwftRl/cjj60dxHSAIaD/q9qNnR09fH+wfnl70nvWjOtRQZOCwVCCvX71cQiV5vgx0uHewvwylrIc6zoAbYBquBEzoOPDE3XYDI5Ym14yGw7E0jghAGxw7m39f4MkyrSe954f7r25S6vmXc5EtAO4f7PVeroAsxkouojz+/ehwFc5S1zD2Dp87VtahZvMf5wv782e454/0tHewf3K6d3Acps/68sOHDyRPJ2VRKI0C9MapRRcFpS9/hUxNGNdAMpioPFeSFVzzHCxZ2DG3NKzhUyk0pM5E8iwL+tVFNE3WaNhpAd1Gg/VkKhJUMWcupgWghXTQLQeKqoegJ95kOdCaQqJNc2YJNW3CnZUoMjRICKoBrZ0VV7CI+DpmU0T8DFCwHNqx0uKzkpZnJFVXoK1IeFY3BkggmVDLNZmyQglpw1e/AnvnlR5tAqm6t1ZIWorsyoWkEQPsimclGE/VJGZjpOoVFBoMWW6PF1kpUzYGMRqvXY+nH0tjFxCz0gR7HKjwa4VzIvYCsW3IMwNMDBd4mfNLqK3GVOH8RIv9OmUpDHmZ2ZgJtGNWl9Bih8oyXhSZSMjHoltwDqzU0KRT9gLhCUGdQiKOnZ9Bz5IK9DFosXCQUPg5gTqUNOeYcHtkj+2YS6bk0kEnKlMa0S/JEH1fZCRLlLQgbYvtXXGREfVut4YJmWRlCmyQ8eQyphAhZhqdIh7LFLJMTWIn8gRCrpqYTgxiBjIUQyVxA1L55YWZO+PWKRqwSqNwLLCa1hCmzlXvC4YKF0YWBCVjZHpiYlzMPqoBs8JmEKPKFlxOY5a64AOu7UBdxywZQ3JJf2meCsUGpbVKun2lWhWpmkjPy6GS1ojPKzQyjHw9Qzsx24nZbsyexKy9HbN2J2btnZi1d2PWfhKzznbMOp2YdXZi1tl1ZHWeeFbzir91Atodx2RbYy572NxFy/tSGNJsNJmmssKTBSvcl+0WazQqfaLP5MLJVfUj1C/yyRVIP4qZG0Oz2Y+67Zj5D9foDh51fg4AU/y9i9x1vyf4u42n4X6P8Xen3Zczv2iHiLE8L24hBIf/eiLCTy9P+NF7634UTBt+RJvkYBf9tycLB2bzDT3CDQkprOCZWb+nAPHwtjWnbGlnO7gzkt712/JRy0PbUyArjJDtdENka2tDwQwQIZ0lFjxuzb3NGg64RR8aAzxV37v/Xdx/ZbPWM6ECeXicqJP2vez4uUXhAdnt9czwAA+PFXPCvpcRT5AR6LfWcwFHHx4LPFVhwMcCbmx7p9l+3Oxsd3YW2IB3cweQ5800bU6n0+9kobtBY3jk16dg0wezLgbEJMhQq3zFTYUuEnMoHz7R3yG6P8CYfgBVHgYTD4tpnJByqAfkVqV8+oNxqMLUKo5D+HkUN62RSUNIB6VfkrESiSceYUL0NsDbIGUhmsj4dOvgYKvGSvexmeeBvyx8xd9NYn39a5630rS1DLtwQrWvOUvTmK34vnogTVme5+u+uwF0l335CyqCD93W64IH+Neowwqpn6+/VlfmAzxVMqP16XK3WleW/MtYhNyPlxu2BKBhVGZcwzXeUo1LqtRyKt9uiZa0KCjRPMynSy3dB12GkTjBfjzyofxPXsBxB4sI8Mvd825srI5EwwiuCYfLISMxIqXMbozp3jHe+Xi4MSDb50lD+pXwQmByIQNr6SvYpLWKCHdotYs5HuryvdyAXdgMNyzMXHE1p9Oni0Z7m/yev5fc4vg8xMMz+zXKwqBLdrj8XZRzH7pEQ5j/rewYdD86r+a4Kzmktbls1WR2fos+sbnSpJDxAWQ3de3e2lDfjpesGnNwIBeyyiQQyduBAhrl10ujfnC2Qs/ctusCHox7UJPAZ5YJE9Ipi0yrz/b5JsoDSnAvEQNgYQIbVCL53SJfEXY/mXcWwR/PHUsgHCPAKtcXVrtjhYWjqTMGceRCirzMq6TlsMIaWJZ7L1/nF87ER5awQv14b6zAr+9Ywb8SrVmgL9uUWghJCTIMbHUw6EEenmWoUXa3C/wWm7HgNr/V4X29JoZ91TVxhZ9EUOchKy0069WwxY7QK2HG1E3CHFiSQGExX/a9OlqRfD8dbVMqqZ4jW++Z6lD/ahlcJ0z3kc4luv8yOfRw3xd8IdfuJ4z1bfwHCeQC2fcOllxCMHfPUOuygTmJ3kMzhp6sJdcfxZEqqJ5ByV4adaMUqybCW30UE2ow9leVTqPul8in8PFPnyDHmVsfDdZffIlMMoac41+BJKzYwHffKA7PqlEcUc4GyzeQaVHXPx9HMd4wCnxnA4M4aF73S4ByD+JR7O/tUTdyL+VRHME1zwsE9p8YyETh5ZhQzMKKt+GqvsxxGfqjqlxAPPg8+I1oaOpsqWTlmzDVMczmfJ0j41rzabRcHRPeBcM1zs2rHj6yadAVYVEjqrcqAoviSFjI66usOTWtvp7TCSjcCaV2v3YuHQvPv3pNnEfP7d8y0b/DrOD5PbnkRm8uvHhke3h/hDRE083502nM6MmidZfEBHjaLR/V13Sx4Y01T9c9qdde8sxYlVmKb2TAdYtetr+5FIeqsXiWlFQdVPmIhZ1VpFY7a8/i6PruzVyzRDXDez37MYOhZWVRgGaJ0hL0T/VM3IPZXGdnZxZH07u3N/2P3N7PeHiTu3f3hgod5kUg/w5aHz2ZxdH4blp/r0ox/o3E7uzO5r7Ol/lUFYIDlU4vgt2a3QUYnArCYblZTx7pFHSNEQOlMuDyBid6QxdkKfYDxiI/+HQXvaALbYJDcdVnGhLAahzKYAdbxXzQ4Z7XmX/ExNhsHz9QzGjKgUEoGfAZh3AAoaINyzAdhHBljFQjADwZY/2cdVTxIT7/UxURVpCp0gTyxtzQM34GGJbaMQhXuCLkaDFGrHGHKjjqe2/VTwe/oJOjUtSj0+N78JIi2KYrZnN+2u3S4WBHp8dYlySGPg5rsdem4kRgLV8AYRgXsSvBQ+1CZdunLukAkjiiQhndvDSx5SuCmuwmQakwKymK5ynQqvT2BuJ5OSQekSot1mH6+lNmLBRmgY9ERcXIU1XeRyrv4CRno5JeUyyqbChSorTsvK5ISFfXS/eftNShlMqLBUJike+cT4ErCFTDHzOQxk3nbMiNBR1jsS9yXpd4v6lQwnUBWoBMYCULNDjWXZR6Zdy0yIPFIp3Xr176Itiwh6CUA9RAhxhSVhYkNaQJVfFYOLnlrd8IlEjKLlBHQF+sC9MWyaQiL6weJu33abcCtMGaac2UHnEpPvsaaidJAxjzbEjWt3pTw5owXDfQjNgW6Qvm959//weSSpJ6kau0kl5zf8E6xjI+aypjZBUVE0MGruQ6vAhURs7EwbAZH8vhw4CmBD5tSxW4H7gWxtZqjsJz302lfAXIz6RGA/l+VCUUNDmta1VFl69tmqOjyiixWK5W+Z4lAbzdhzgnM78IevuHNZhKGhcGd7a38b+lCDSUiofi5Xn1fDb9WxTf/xZ6ewweqpZXieRcSn4dd343hcyTMQrJGkWbg9/u3+u36y2YvhgPnifiSLzovf7cax+KnunJV4+Tp73d3mXx9s+nL35pwfRFO+n8OX3b+dO+e5OZ3kclkt9fjN/LP83g6ePy3dv3+t3bnn735pXlbx7vDeRYDp7/JpLp44+DzrZ4+fTF9vs37cng+W/b7//8pXhPyH/bfn95uZ3kh08Hcg9hindv/1ccfdx/dPB5//PB6f71wefslxY//PTx6XXyy8Hl/m7zfU83D44Gf3z8ZItXj9NHh2/F7hM4gDfydPtlEtWlQchMSLgIR31B+77Aw56RUOysOvYTlYMdk6xTdbpWWP5euPpuq6eMj7iQDFmn/0IpAK2Vvv1Mv46y2xixs7190a6Y8PgmE3qSXnuoE+RUXYL81+60vrx1yyOp1zlJvbPfkXBANB4tbLb+3W3SQFJqYadR9+xLdN3khWi68e7Z+ew8jpCxChNPhTJEMbfjqBttLeehsCGHkhxnN8RmwjHc+70cENV7pVXsQCWXbmukr5VSXgltHaaWcdPG5YA081hzNC+H/OqS6y1U3K12a7u1Hc3iL0tIDJcpPgDd0G5eiK2r9ooZK23BWmhj+UjIUfPWWedz1p7g8bsTXmDwPDVRiD8AcxP+/OpQcSSQiWPgGN3jiaFUvZpn/faDbIR83MoU21wIlpNmIWe2kAZbdqIrElu1vNZZSCpRnqhKE0XzHUVVKgf/rJIzZ3NRr/IgIQ3SpvxBZ2eHLto/t+lG+ugJXfZ2dmfnjsO1iw8lVuvRu0v5L4Sh/tNiWBZFK8OghfBjTfQR4jwhh4oO1DP5qAB5gmE0SvxV++bNGbJE5VXlcgD/59//QTOCt6dl/saOSs0KNQGN7WnUnpXBtcDAFYGJMEMhFeXPeZ6BMZgtlBZGrrNMjKiUIUSDCS/4ABu8MNYU0ipXPlSzXabF3owB3zFw6AftqjquIEN7xTKlqOcJg6jSqrzevcYmSl8OkSRsTBtgQwMYvHZBmAJyzGWCwZ/TDwqrsMcL4+tCCwOMixyBqUdtOBSJQMRoZTVPLMu55COKj2K6wSMXitCOoNUAr0lGZaW7CGBTBIB1W6Q3jRZ7hhcv2jh+TMFykUHq7gAmdncwb3R9D9kA77sFLi8SMPNasAyuQJM9cDfoMstYoay71WKAWD9bRGQ1lwZzBI6gcDQV+3ykTmukfNpi+LCBDg4vaCgAmZCX2J3TZGeVmL2BgREW5tmLyWRywzb9tDjnubDjcsA0FGo+b0QfyZLVp1c/fkJLAjo3R8MTbMFMQki1Zs0tAt7yPpIn5CODfeCF+J/lCeivMpGANFDzaHvPj1+yK/aotb3gMu5B8NbL3tP9w5N9xIsOyulfcB3k1XIua0tRW2rVpbqsubUXlk0366abddPNuulm3XSzMrbpZt10s266WTfdrJtu1k0366abddPN2t90s/Y33aybbtZNN+umm3XOhk0366abddPNuulm3XSzbrpZN92sm27WTTfrppt108266WbddLNuuln/v3Sz+novDBy3iowLWSvadbWFZ0s9rudxNMbaw+5Z9OULvla/1tlshp8/laCxcPE8jq64Fpg9p7LFOJTLYYHZJUyjbvTUPQY0T3H52Ik9VaAsVWtitZ+bsUeHfytsvTzy+OjkNIqjge/DzVWKczSfYI8un0TdCG02tfNWlev0/UuUcTkqqeYtcnixyo+XdrxYInhJJYL+j1rpHJfTGpWLtYNuK/gvbmzlhP/CKpA/YPrfFbgbWTvB8zZA4wmez2az/wM1YMGT",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Resend request mail",permalink:"/docs/API-docs/resendrequestmail"},next:{title:"Create Template",permalink:"/docs/API-docs/createtemplate"}},f={},j=[{value:"Request",id:"request",level:2}];function g(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,t.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(n.p,{children:"Draft Template"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/drafttemplate"}),"\n",(0,i.jsxs)(n.p,{children:["The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique ",(0,i.jsx)(n.strong,{children:"objectId"})," (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a ",(0,i.jsx)(n.strong,{children:"url"})," is provided, which offers a user interface for editing the template and facilitating document distribution."]}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"When document is created this webhook event will trigger"})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:' {\n "event": "created",\n "objectId":"DOCUMENT_ID"\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE",\n "url": "SIGNING_URL"\n }\n ],\n "createdAt": "TIMESTAMP"\n }\n'})}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified.This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"name", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job title:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"job title", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"company", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"date", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": { \n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression":"",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0, \n "maxselections": 0 \n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"dropdown", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"radio button", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "readonly": false,\n "required": true, \n "name": "radio button",\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(n.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded file"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample note"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample description"}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})}),(0,i.jsx)("span",{className:"openapi-schema__divider"}),(0,i.jsx)("span",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("div",{style:{marginTop:".5rem",marginBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"You can provide signer optionally if you it as default signer"})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"redirect_url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_sender_name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"name or email of the person or organization on the behalf of which you are sending the mail.",example:"opensign\u2122"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(a.Z,{children:[(0,i.jsxs)(p.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Template created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bh2Hspnmch"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://app.opensignlabs.com/drafttemplate/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2VtYWlsIjoicHJhZnVsbC5uYXZrYXIrYWRtaW5AbnhnbGFicy5jb20iLCJ0ZW1wbGF0ZV9pZCI6IkF0Zkk0cmNCbnAiLCJpYXQiOjE3MzEzMTExMzl9.aNqjCxc9MkE6-ZIr-MObKjqtpR5d3NXi68eMeWnT0Lc"}})]})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "objectId": "Bh2Hspnmch",\n "url": "https://app.opensignlabs.com/drafttemplate/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2VtYWlsIjoicHJhZnVsbC5uYXZrYXIrYWRtaW5AbnhnbGFicy5jb20iLCJ0ZW1wbGF0ZV9pZCI6IkF0Zkk0cmNCbnAiLCJpYXQiOjE3MzEzMTExMzl9.aNqjCxc9MkE6-ZIr-MObKjqtpR5d3NXi68eMeWnT0Lc"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(p.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(p.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/0028a090.a94482e8.js b/assets/js/0028a090.a94482e8.js new file mode 100644 index 000000000..00f0e9502 --- /dev/null +++ b/assets/js/0028a090.a94482e8.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7917],{58760:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>j,contentTitle:()=>u,default:()=>y,frontMatter:()=>h,metadata:()=>x,toc:()=>g});var i=s(85893),a=s(11151),t=s(58219),r=(s(62316),s(51039)),l=s.n(r),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),m=s(9472),p=s(85162);const h={id:"drafttemplate",title:"Draft Template",description:"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.",sidebar_label:"Draft Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztO+1yGzmOr8LtPzOjasmW4ngyqqur8ySejDLxx8XO5MNyOVQ3JDHuJjsk27KS0r99kn20fZIrgGSrJUu2k0zteuv0J7GaIAiAAAiCwJfI8pGJumfRKeRFxi2Y6DyOUjCJFoUVSkbd6HQMLAyzZ5oPrZAjtnfcYyD5IAPDSgPaMKtYogGBktJYlYvPOMpswBwzA/oK53LDBlkJhRbSGjZUmo1AguaEOFVJmQMOTIQds0JDCkMhIWXG6jKxpQbTYq8LJZkpkwSMGZaZW1koydSQ8WrNmNkxEKkabKmlYZyVUnwqgTUaavAREttLGw32YwpGjCS3kCJxYfqFSH+K2WQskjFLuGQDQFZT5NQTDDVyBxzHlKQ1TQGJGAoE9shabC9NBdLIs2waM84ajVJnjQYThhVaXYkU0rCaGg5RpJxEy4S0oIc8AZIVIBY5omUCcsZlyoY8EZmwi2JkqTBWi0GJK7f6si9PRdFlr4tM8ZRNVanZ8bPf5uBWMfx21mg8g0E5Yq97jcb5j2NrC9Pd2uJF0VIFSJRWxgemlah8K0XAIh2SrEADYiV5ATcimzKepmwi0hFYQxsiWaKKKUuU0qmQTjUKPgImy3wA2sTETa40MCEZZxp4Om1a1SwNsBcnR4cohpzbFjvOShNXy6VCQ2KzqUOP4glc/eB2Z3cHdUjIUcxyfolSEpZ9KkVyiWwbkLS1XmVafckYY33ZaLxBmisJCeP1PGXMjoVhExiMlbpkcIXDE5FlzGoxGoFuNAjJhw8fHLIv7j/CGxF4P+qyfuTx9aO4DhAUtB91+9Gzo6evD/YPTy96z/pRHWooMnBYKpDXr14uoZI8XwY63DvYX4ZS1kMdZ8ANMA1XAia0Hbjjjt0giKXJNafhcCyNIwLQBsfO5t8XZLJM60nv+eH+q5uUevnlXGQLgPsHe72XKyCLsZKLKI9/PzpchbPUNYy9w+dOlHWo2fzH+QJ/fg/3/Jae9g72T073Do7D9FlffvjwgfTppCwKpVGB3jiz6KKi9OWvkKkJ4xpIBxOV50qygmuegyUPO+aWhjV8KoWG1LlInmXBvrqIpskaDTstoNtosJ5MRYIm5tzFtAD0kA665UDR9BD0xLssB1ozSPRpzi2hpU248xJFhg4JQTWgt7PiChYRX8dsioifASqWQztWWnxW0vKMtOoKtBUJz+rOAAkkF2q5JldWKCFt+OpXYO+80aNPIFP33gpJS1FcuZA0YoBd8awE46maxGyMVL2CQoMhz+3xoihlysYgRuO16/H0Y2nsAmJWmuCPAxV+rbBPJF4gsQ15ZoCJ4YIsc34JtdWYKtw50WK/TlkKQ15mNmYC/ZjVJbTYobKMF0UmEjpj8VhwB1ipoUm77BXCE4I2hUQcu3MGT5ZU4BmDHgsHCYWfE6hDTXMHE7JH/tiOuWRKLm10ojKlEf2SDtH3RUGyREkL0rbY3hUXGVHvuDVMyCQrU2CDjCeXMYUIMdN4KOK2TCHL1CR2Kk8gdFST0ElAzECGaqgkMiCVX16Y+WHcOkUHVlkUjgVR0xrC1KXqz4KhwoVRBMHIGLmemAQXs49qwKywGcRosgWX05ilLviAaztQ1zFLxpBc0l+ap0KxQWmtko6vVKsiVRPpZTlU0hrxeYVFhpGvF2gnZjsx243Zk5i1t2PW7sSsvROz9m7M2k9i1tmOWacTs85OzDq7jqzOEy9qXsm3TkC744Rsa8JlD1u66HlfCkOWjS7TVF54suCF+7LdYo1GZU/0mY5wOqr6EdoXnckVSD+KmRtDt9mPuu2Y+Q/XeBw86vwcAKb4exel635P8Hcbd8P9HuPvTrsvZ37RDhFjeV7cQggO//VEhJ9en/CjP637UXBt+BF9koNdPL89WTgwmzP0CBkSUljBM7OepwDx8NiaU7bE2Q5yRtq7ni0ftTw0ngJZYYR8pxsiX1sbCm6ACOksieBxa37arJGAW/ShCcBT9b387yL/lc9aL4QK5OFJok7a94rj5xaFB+S31wvDAzw8UcwJ+15BPEFB4Lm1Xgo4+vBE4KkKAz4WcGPbO83242Znu7OzIAa8mzuAPG+maXM6nX6nCN0NGsMjvz4Fmz6YdTEgJkGGWuUrbip0kZhD+fCJ/g7R/QHG9AOo8jCYeFhM44SUQz0gtyrl0x+MQxWmVnEcws+juGmNTBpCOij9koyVSDzxCBOitwHeBikL0UTBp1sHB1s1UbqPzTwP8mXhK/5ukujrX/O8laatZdiFHap9zVmaxmzF99UDacryPF/33Q3gcdmXv6Ah+NBtvS14gH+NOazQ+vn6a21lPsBTJTNany53q21l6XwZi5D78XrDlgA0jMqMa7jGW6pxSZVaTuXbPdGSFQUjmof5dKml+6DLMJIk2I9HPpT/ySs4crCIAL/cPe8GY3UkGkZwTThcDhmJESlldmNM947xzsfDjQHFPk8a0q+EFwKTCxlYS1/BJq1VRLhNq13McVOX7+UG7AIz3LAwc8XVnHafLhrtbTr3/L3kloPPQzw8t1+jLAy6ZIfL30U596FLNIT538qOQfej82qOu5JDWpvLVk1m57fYE5sbTQoZH0B209bubQ11drxm1YSDA7mQVSaBSN4OFNAov14a9YOzFXbm2K4reHDuwUyCnFkmTEinLAqtPtvnmygPKMG9RAyAhQlsUKnkd6t8Rdj9dN55BL89dyyBcIwAq1xfWO2OFRa2pi4YxJELKfIyr5KWwwprEFnuT/m6vHAmPrKEFerbe2MFfn3HCv6VaM0Cfdmm1EJISpBjYKuDQQ/y8DxDjbK7j8Bv8RkLx+a3Hnhfb4mBr7olrjgnEdSdkJUVmvVm2GJHeCphxtRNwhxYkkBhMV/2vTZakXw/G21TKqmeI1t/MtWh/tU6uE6Z7qOdS3T/ZXro4b4v+EKp3U8Z62z8BynkAtn3DpZcQjB3z1DrsoE5qd5Dc4aerKWjP4ojVVA9g5K9NOpGKVZNhLf6KCbUYOyvKp1G3S+RT+Hjnz5BjjO3Phqsv/gSmWQMOce/AklYsYHvvlEcnlWjOKKcDZZvoNCirn8+jmK8YRT4zgYGcdC87pcA5R7Eo9jf26Nu5F7KoziCa54XCOw/MZCJwssxoZiFFW/DVX2Z4zL0R1W5gHjwefAb0dDU2VLJyjdhqmOYzeU6R8a15tNouTomvAuGa5ybVz18ZNNgK8KiRVRvVQQWxZGwkNdXWbNrWn29pBNQyAmldr92Lm0Lz796TZxHz+3fMtG/w6yQ+T2l5EZvLry4ZXt4f4Q0RNPN+dNpzOjJonWXxgR44paP6mu62PDGmqfrntRrL3lmrMosxTcy4LpFL9vfXIpD1Vg8S0qqDqrOiAXOKlIrztqzOLq+m5lrlqhmeK9nP2YwtKwsCtAsUVqC/qmeiXswzHV2dmZxNL2bvel/JHs/4+ZN7ubuDRU6zItA/h20Pnoyi6Px3bT+XpVi/BuJ3dmdzc86X+ZTVQgOVDq9CH5rdhdgOFQQDsvNevJIp6BrghgolQGXNyTRG7ogS7EfMBb5wae76AVdaBMOFFd9piEBrMahDHbwVcwHHe55nflHTIzN9vEDxYymHBiEkgGfcQgHECrasAzTQQhXxkg1AsCTMdbPWUcVH+LzP1URYQWZKk0gb8wNPeNngGGpHYNwhStCjhZjxJp0qIKjznurvjv4BQ85KkU9Oj2+hywpgm26YjZ3TjsuHQ52dHqMdUli6OOwFnttKkkE0fIFEIZxEbsSPNQuVL596pIOIEkiKpTRzUsTW74iqMluEpQKs5KieJ4CrUpvbyCel0PiFqnSYh2mrz9lxkJhFuRIVFSCPFXlfbTyDklyNirpNcWiyYYiJUrLzuuKhHR1vXT/SUsdSqm8WiAkFvnO5RSkgkA1/DEDadx0zobcWNAxFvui5HWJ95sKJVwXoAXIBFaKQIMT3UWpV8ZNizJYLNJ5/eqlL4INPASjHKAFOsSQsrIgrSFLqIrHws4ts34jUCItu0AbAX2xLkxbJJOKvLB6mKzfp90K0AZrpjVTesSl+OxrqJ0mDWDMsyF53+pNDWvCcN1AM2JbpC+433/+/R9IKmnqRa7SSnvN/RXrGMv4rKmckVVUTAwZuJLr8CJQOTkTB8dmfCyHDwOaEvjEliqQH7gWxtZqjsJz302jfAUoz6RGA539aEqoaHJat6qKLl/bNEdHlVFisVytOnuWFPD2M8QdMvOLoPd/WIOppHFhcGd7G/9bikBDqXgoXp5Xz2fTv0Xx/W+ht8fgoWp5lUrOteTXced3U8g8GaOSrDG0Ofjt53v9dr0F0xfjwfNEHIkXvdefe+1D0TM9+epx8rS327ss3v759MUvLZi+aCedP6dvO3/ad28y0/uoRPL7i/F7+acZPH1cvnv7Xr9729Pv3ryy/M3jvYEcy8Hz30Qyffxx0NkWL5++2H7/pj0ZPP9t+/2fvxTvCflv2+8vL7eT/PDpQO4hTPHu7f+Ko4/7jw4+738+ON2/Pvic/dLih58+Pr1Ofjm43N9tvu/p5sHR4I+Pn2zx6nH66PCt2H0CB/BGnm6/TKK6NgiZCQkXYasviO8L3OwZKcXOqm0/UTnYMek6VadrheXvhavvtnrK+IgLyVB0+i/UAtBa6dv39Osou00QO9vbF+1KCI9vCqEn6bWHOkFO1SXIfy2n9eWtWx5Jvc5J653/joQDovFogdn6d8ekgaTUwk6j7tmX6LrJC9F0492z89l5HKFgFSaeCmWIYm7HUTfaWs5DYUMOJTnOvjgbrAzNcJnie8wNY+OF2LpqR7N4ecZK01wLbSwfCTlq3jrrfM7pCe6GE/gCv/NMQSH+AEwVeHHWoeJIoBaMgWOwjQLETX41T8Lth60K6bGVGa/5niznsEIKayErtXymrcgz1dJMZyHHQ2mbKmsTzTmKqswK/lnlSs7mmlelJUJWok3X+c7ODt17f27TBfHRE7p77ezOzp2Ea/cQynPWg2mXgV+ICv2nxSgpilZGJQvRwJpgIIRdQg4VbagX8lEB8gSjWjSbq/bNiyxkicqrQuIA/s+//4NmhMOXlvkbOyo1K9QENHaLUbdUBtcC40gEJsIMRTiUzuZ5BsZg8k5aGLlGLzGiyoIQnCW84APst8LQT0irXDVPzZWYFnszBnxWwKEftCuyuIIM3QfLlKIWJIxpSqvyejMZmyh9OUSSsE9sgP0FYPAWBGEKyDGXCcZizj4oysGWKwx3Cy0MMC5yBKaWseFQJAIRo9PTPLEs55KPKFyJ6UKNUihCd4BWA7y1GJWVLi7HHgUA61ikJ4YWe4b3IGIcP6ZgucggdSG5id2VyPtA39I1wOtngcuLBMy8NCuDK9DkD9yFtswyVijrLpkYr9X3FhFZzaXBK7sjKGxNJT4fONMaKZ+2GL4z4HmD9yVUgEzIS2yWabKzSs3ewMAIC/NkwmQyueGbflqc81zYcTlgGgo1nzeij+TJ6tOrHz+hJwGdm6PhCXZEJiHCWbPmFgFv+SOLJ3RkBf/AC/E/yxPw+MhEAtJA7YDZe378kl2xR63tKK5543sQvPWy93T/8GQf8eJ54eyv3dpubVMGVBmbc1lbirpEq6bRZcutPXhsmks3zaWb5tJNc+mmuZSxTXPpprl001y6aS7dNJdumks3zaWb5tL+prm0v2ku3TSXbppLN82lczFsmks3zaWb5tJNc+mmuXTTXLppLt00l26aSzfNpZvm0k1z6aa5dNNc+v+ludTXe2HguFVkXMhaDa0r9Ttbajk9j6MxlgJ2z6IvX/C1+rXOZjP8/KkEjXWE53F0xbXA7DlVEcahXA4LzC5hGnWjp+4xoHmKy8dO7akCZal4Eqv93Iw92vxbYevVisdHJ6dRHA18W2yuUpyj+QRbZvkk6kbos6m7tiokp+9foozLUUk1b5HDi1V+vLTjxRLBSyoR9H/USue4nNaoXKwddKzgv8jYygn/hVUgf8D0vytwN7J2gpdtgMYdPJ/NZv8HGPOZ6A==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/drafttemplate",title:"Draft Template",description:"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.",source:"@site/docs/API-docs/drafttemplate.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/drafttemplate",permalink:"/docs/API-docs/drafttemplate",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"drafttemplate",title:"Draft Template",description:"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.",sidebar_label:"Draft Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztO+1yGzmOr8LtPzOjasmW4ngyqqur8ySejDLxx8XO5MNyOVQ3JDHuJjsk27KS0r99kn20fZIrgGSrJUu2k0zteuv0J7GaIAiAAAiCwJfI8pGJumfRKeRFxi2Y6DyOUjCJFoUVSkbd6HQMLAyzZ5oPrZAjtnfcYyD5IAPDSgPaMKtYogGBktJYlYvPOMpswBwzA/oK53LDBlkJhRbSGjZUmo1AguaEOFVJmQMOTIQds0JDCkMhIWXG6jKxpQbTYq8LJZkpkwSMGZaZW1koydSQ8WrNmNkxEKkabKmlYZyVUnwqgTUaavAREttLGw32YwpGjCS3kCJxYfqFSH+K2WQskjFLuGQDQFZT5NQTDDVyBxzHlKQ1TQGJGAoE9shabC9NBdLIs2waM84ajVJnjQYThhVaXYkU0rCaGg5RpJxEy4S0oIc8AZIVIBY5omUCcsZlyoY8EZmwi2JkqTBWi0GJK7f6si9PRdFlr4tM8ZRNVanZ8bPf5uBWMfx21mg8g0E5Yq97jcb5j2NrC9Pd2uJF0VIFSJRWxgemlah8K0XAIh2SrEADYiV5ATcimzKepmwi0hFYQxsiWaKKKUuU0qmQTjUKPgImy3wA2sTETa40MCEZZxp4Om1a1SwNsBcnR4cohpzbFjvOShNXy6VCQ2KzqUOP4glc/eB2Z3cHdUjIUcxyfolSEpZ9KkVyiWwbkLS1XmVafckYY33ZaLxBmisJCeP1PGXMjoVhExiMlbpkcIXDE5FlzGoxGoFuNAjJhw8fHLIv7j/CGxF4P+qyfuTx9aO4DhAUtB91+9Gzo6evD/YPTy96z/pRHWooMnBYKpDXr14uoZI8XwY63DvYX4ZS1kMdZ8ANMA1XAia0Hbjjjt0giKXJNafhcCyNIwLQBsfO5t8XZLJM60nv+eH+q5uUevnlXGQLgPsHe72XKyCLsZKLKI9/PzpchbPUNYy9w+dOlHWo2fzH+QJ/fg/3/Jae9g72T073Do7D9FlffvjwgfTppCwKpVGB3jiz6KKi9OWvkKkJ4xpIBxOV50qygmuegyUPO+aWhjV8KoWG1LlInmXBvrqIpskaDTstoNtosJ5MRYIm5tzFtAD0kA665UDR9BD0xLssB1ozSPRpzi2hpU248xJFhg4JQTWgt7PiChYRX8dsioifASqWQztWWnxW0vKMtOoKtBUJz+rOAAkkF2q5JldWKCFt+OpXYO+80aNPIFP33gpJS1FcuZA0YoBd8awE46maxGyMVL2CQoMhz+3xoihlysYgRuO16/H0Y2nsAmJWmuCPAxV+rbBPJF4gsQ15ZoCJ4YIsc34JtdWYKtw50WK/TlkKQ15mNmYC/ZjVJbTYobKMF0UmEjpj8VhwB1ipoUm77BXCE4I2hUQcu3MGT5ZU4BmDHgsHCYWfE6hDTXMHE7JH/tiOuWRKLm10ojKlEf2SDtH3RUGyREkL0rbY3hUXGVHvuDVMyCQrU2CDjCeXMYUIMdN4KOK2TCHL1CR2Kk8gdFST0ElAzECGaqgkMiCVX16Y+WHcOkUHVlkUjgVR0xrC1KXqz4KhwoVRBMHIGLmemAQXs49qwKywGcRosgWX05ilLviAaztQ1zFLxpBc0l+ap0KxQWmtko6vVKsiVRPpZTlU0hrxeYVFhpGvF2gnZjsx243Zk5i1t2PW7sSsvROz9m7M2k9i1tmOWacTs85OzDq7jqzOEy9qXsm3TkC744Rsa8JlD1u66HlfCkOWjS7TVF54suCF+7LdYo1GZU/0mY5wOqr6EdoXnckVSD+KmRtDt9mPuu2Y+Q/XeBw86vwcAKb4exel635P8Hcbd8P9HuPvTrsvZ37RDhFjeV7cQggO//VEhJ9en/CjP637UXBt+BF9koNdPL89WTgwmzP0CBkSUljBM7OepwDx8NiaU7bE2Q5yRtq7ni0ftTw0ngJZYYR8pxsiX1sbCm6ACOksieBxa37arJGAW/ShCcBT9b387yL/lc9aL4QK5OFJok7a94rj5xaFB+S31wvDAzw8UcwJ+15BPEFB4Lm1Xgo4+vBE4KkKAz4WcGPbO83242Znu7OzIAa8mzuAPG+maXM6nX6nCN0NGsMjvz4Fmz6YdTEgJkGGWuUrbip0kZhD+fCJ/g7R/QHG9AOo8jCYeFhM44SUQz0gtyrl0x+MQxWmVnEcws+juGmNTBpCOij9koyVSDzxCBOitwHeBikL0UTBp1sHB1s1UbqPzTwP8mXhK/5ukujrX/O8laatZdiFHap9zVmaxmzF99UDacryPF/33Q3gcdmXv6Ah+NBtvS14gH+NOazQ+vn6a21lPsBTJTNany53q21l6XwZi5D78XrDlgA0jMqMa7jGW6pxSZVaTuXbPdGSFQUjmof5dKml+6DLMJIk2I9HPpT/ySs4crCIAL/cPe8GY3UkGkZwTThcDhmJESlldmNM947xzsfDjQHFPk8a0q+EFwKTCxlYS1/BJq1VRLhNq13McVOX7+UG7AIz3LAwc8XVnHafLhrtbTr3/L3kloPPQzw8t1+jLAy6ZIfL30U596FLNIT538qOQfej82qOu5JDWpvLVk1m57fYE5sbTQoZH0B209bubQ11drxm1YSDA7mQVSaBSN4OFNAov14a9YOzFXbm2K4reHDuwUyCnFkmTEinLAqtPtvnmygPKMG9RAyAhQlsUKnkd6t8Rdj9dN55BL89dyyBcIwAq1xfWO2OFRa2pi4YxJELKfIyr5KWwwprEFnuT/m6vHAmPrKEFerbe2MFfn3HCv6VaM0Cfdmm1EJISpBjYKuDQQ/y8DxDjbK7j8Bv8RkLx+a3Hnhfb4mBr7olrjgnEdSdkJUVmvVm2GJHeCphxtRNwhxYkkBhMV/2vTZakXw/G21TKqmeI1t/MtWh/tU6uE6Z7qOdS3T/ZXro4b4v+EKp3U8Z62z8BynkAtn3DpZcQjB3z1DrsoE5qd5Dc4aerKWjP4ojVVA9g5K9NOpGKVZNhLf6KCbUYOyvKp1G3S+RT+Hjnz5BjjO3Phqsv/gSmWQMOce/AklYsYHvvlEcnlWjOKKcDZZvoNCirn8+jmK8YRT4zgYGcdC87pcA5R7Eo9jf26Nu5F7KoziCa54XCOw/MZCJwssxoZiFFW/DVX2Z4zL0R1W5gHjwefAb0dDU2VLJyjdhqmOYzeU6R8a15tNouTomvAuGa5ybVz18ZNNgK8KiRVRvVQQWxZGwkNdXWbNrWn29pBNQyAmldr92Lm0Lz796TZxHz+3fMtG/w6yQ+T2l5EZvLry4ZXt4f4Q0RNPN+dNpzOjJonWXxgR44paP6mu62PDGmqfrntRrL3lmrMosxTcy4LpFL9vfXIpD1Vg8S0qqDqrOiAXOKlIrztqzOLq+m5lrlqhmeK9nP2YwtKwsCtAsUVqC/qmeiXswzHV2dmZxNL2bvel/JHs/4+ZN7ubuDRU6zItA/h20Pnoyi6Px3bT+XpVi/BuJ3dmdzc86X+ZTVQgOVDq9CH5rdhdgOFQQDsvNevJIp6BrghgolQGXNyTRG7ogS7EfMBb5wae76AVdaBMOFFd9piEBrMahDHbwVcwHHe55nflHTIzN9vEDxYymHBiEkgGfcQgHECrasAzTQQhXxkg1AsCTMdbPWUcVH+LzP1URYQWZKk0gb8wNPeNngGGpHYNwhStCjhZjxJp0qIKjznurvjv4BQ85KkU9Oj2+hywpgm26YjZ3TjsuHQ52dHqMdUli6OOwFnttKkkE0fIFEIZxEbsSPNQuVL596pIOIEkiKpTRzUsTW74iqMluEpQKs5KieJ4CrUpvbyCel0PiFqnSYh2mrz9lxkJhFuRIVFSCPFXlfbTyDklyNirpNcWiyYYiJUrLzuuKhHR1vXT/SUsdSqm8WiAkFvnO5RSkgkA1/DEDadx0zobcWNAxFvui5HWJ95sKJVwXoAXIBFaKQIMT3UWpV8ZNizJYLNJ5/eqlL4INPASjHKAFOsSQsrIgrSFLqIrHws4ts34jUCItu0AbAX2xLkxbJJOKvLB6mKzfp90K0AZrpjVTesSl+OxrqJ0mDWDMsyF53+pNDWvCcN1AM2JbpC+433/+/R9IKmnqRa7SSnvN/RXrGMv4rKmckVVUTAwZuJLr8CJQOTkTB8dmfCyHDwOaEvjEliqQH7gWxtZqjsJz302jfAUoz6RGA539aEqoaHJat6qKLl/bNEdHlVFisVytOnuWFPD2M8QdMvOLoPd/WIOppHFhcGd7G/9bikBDqXgoXp5Xz2fTv0Xx/W+ht8fgoWp5lUrOteTXced3U8g8GaOSrDG0Ofjt53v9dr0F0xfjwfNEHIkXvdefe+1D0TM9+epx8rS327ss3v759MUvLZi+aCedP6dvO3/ad28y0/uoRPL7i/F7+acZPH1cvnv7Xr9729Pv3ryy/M3jvYEcy8Hz30Qyffxx0NkWL5++2H7/pj0ZPP9t+/2fvxTvCflv2+8vL7eT/PDpQO4hTPHu7f+Ko4/7jw4+738+ON2/Pvic/dLih58+Pr1Ofjm43N9tvu/p5sHR4I+Pn2zx6nH66PCt2H0CB/BGnm6/TKK6NgiZCQkXYasviO8L3OwZKcXOqm0/UTnYMek6VadrheXvhavvtnrK+IgLyVB0+i/UAtBa6dv39Osou00QO9vbF+1KCI9vCqEn6bWHOkFO1SXIfy2n9eWtWx5Jvc5J653/joQDovFogdn6d8ekgaTUwk6j7tmX6LrJC9F0492z89l5HKFgFSaeCmWIYm7HUTfaWs5DYUMOJTnOvjgbrAzNcJnie8wNY+OF2LpqR7N4ecZK01wLbSwfCTlq3jrrfM7pCe6GE/gCv/NMQSH+AEwVeHHWoeJIoBaMgWOwjQLETX41T8Lth60K6bGVGa/5niznsEIKayErtXymrcgz1dJMZyHHQ2mbKmsTzTmKqswK/lnlSs7mmlelJUJWok3X+c7ODt17f27TBfHRE7p77ezOzp2Ea/cQynPWg2mXgV+ICv2nxSgpilZGJQvRwJpgIIRdQg4VbagX8lEB8gSjWjSbq/bNiyxkicqrQuIA/s+//4NmhMOXlvkbOyo1K9QENHaLUbdUBtcC40gEJsIMRTiUzuZ5BsZg8k5aGLlGLzGiyoIQnCW84APst8LQT0irXDVPzZWYFnszBnxWwKEftCuyuIIM3QfLlKIWJIxpSqvyejMZmyh9OUSSsE9sgP0FYPAWBGEKyDGXCcZizj4oysGWKwx3Cy0MMC5yBKaWseFQJAIRo9PTPLEs55KPKFyJ6UKNUihCd4BWA7y1GJWVLi7HHgUA61ikJ4YWe4b3IGIcP6ZgucggdSG5id2VyPtA39I1wOtngcuLBMy8NCuDK9DkD9yFtswyVijrLpkYr9X3FhFZzaXBK7sjKGxNJT4fONMaKZ+2GL4z4HmD9yVUgEzIS2yWabKzSs3ewMAIC/NkwmQyueGbflqc81zYcTlgGgo1nzeij+TJ6tOrHz+hJwGdm6PhCXZEJiHCWbPmFgFv+SOLJ3RkBf/AC/E/yxPw+MhEAtJA7YDZe378kl2xR63tKK5543sQvPWy93T/8GQf8eJ54eyv3dpubVMGVBmbc1lbirpEq6bRZcutPXhsmks3zaWb5tJNc+mmuZSxTXPpprl001y6aS7dNJdumks3zaWb5tL+prm0v2ku3TSXbppLN82lczFsmks3zaWb5tJNc+mmuXTTXLppLt00l26aSzfNpZvm0k1z6aa5dNNc+v+ludTXe2HguFVkXMhaDa0r9Ttbajk9j6MxlgJ2z6IvX/C1+rXOZjP8/KkEjXWE53F0xbXA7DlVEcahXA4LzC5hGnWjp+4xoHmKy8dO7akCZal4Eqv93Iw92vxbYevVisdHJ6dRHA18W2yuUpyj+QRbZvkk6kbos6m7tiokp+9foozLUUk1b5HDi1V+vLTjxRLBSyoR9H/USue4nNaoXKwddKzgv8jYygn/hVUgf8D0vytwN7J2gpdtgMYdPJ/NZv8HGPOZ6A==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Resend request mail",permalink:"/docs/API-docs/resendrequestmail"},next:{title:"Create Template",permalink:"/docs/API-docs/createtemplate"}},j={},g=[{value:"Request",id:"request",level:2}];function f(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(n.p,{children:"Draft Template"})}),"\n",(0,i.jsx)(l(),{method:"post",path:"/drafttemplate"}),"\n",(0,i.jsxs)(n.p,{children:["The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique ",(0,i.jsx)(n.strong,{children:"objectId"})," (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a ",(0,i.jsx)(n.strong,{children:"url"})," is provided, which offers a user interface for editing the template and facilitating document distribution."]}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"When document is created this webhook event will trigger"})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:' {\n "event": "created",\n "objectId":"DOCUMENT_ID"\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE",\n "url": "SIGNING_URL"\n }\n ],\n "createdAt": "TIMESTAMP"\n }\n'})}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified.This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"name", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job title:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"job title", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"company", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"date", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": { \n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression":"",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0, \n "maxselections": 0 \n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"dropdown", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"radio button", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "readonly": false,\n "required": true, \n "name": "radio button",\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(n.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded file"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample note"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample description"}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})}),(0,i.jsx)("span",{className:"openapi-schema__divider"}),(0,i.jsx)("span",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("div",{style:{marginTop:".5rem",marginBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"You can provide signer optionally if you it as default signer"})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"redirect_url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_sender_name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"name or email of the person or organization on the behalf of which you are sending the mail.",example:"opensign\u2122"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(t.Z,{children:[(0,i.jsxs)(p.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Template created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bh2Hspnmch"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://app.opensignlabs.com/drafttemplate/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2VtYWlsIjoicHJhZnVsbC5uYXZrYXIrYWRtaW5AbnhnbGFicy5jb20iLCJ0ZW1wbGF0ZV9pZCI6IkF0Zkk0cmNCbnAiLCJpYXQiOjE3MzEzMTExMzl9.aNqjCxc9MkE6-ZIr-MObKjqtpR5d3NXi68eMeWnT0Lc"}})]})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "objectId": "Bh2Hspnmch",\n "url": "https://app.opensignlabs.com/drafttemplate/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2VtYWlsIjoicHJhZnVsbC5uYXZrYXIrYWRtaW5AbnhnbGFicy5jb20iLCJ0ZW1wbGF0ZV9pZCI6IkF0Zkk0cmNCbnAiLCJpYXQiOjE3MzEzMTExMzl9.aNqjCxc9MkE6-ZIr-MObKjqtpR5d3NXi68eMeWnT0Lc"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(p.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(p.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/05632a52.3fd7ce82.js b/assets/js/05632a52.8538abf4.js similarity index 59% rename from assets/js/05632a52.3fd7ce82.js rename to assets/js/05632a52.8538abf4.js index 6146b5c3c..9412ec976 100644 --- a/assets/js/05632a52.3fd7ce82.js +++ b/assets/js/05632a52.8538abf4.js @@ -1 +1 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4651],{97717:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>u,contentTitle:()=>j,default:()=>b,frontMatter:()=>x,metadata:()=>g,toc:()=>v});var t=s(85893),l=s(11151),n=s(58219),i=(s(62316),s(51039)),r=s.n(i),o=(s(82723),s(9487)),c=s(41429),m=s(5397),p=s(4667),d=s(9472),h=s(85162);const x={id:"getcontact",title:"Get Contact",description:"The Get Contact API allows you to retrieve details about a specific contact.",sidebar_label:"Get Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V21v2zYQ/itXflkLKH5J0w4ThqFBV6RBu7ZYMhRYagQn6SwxoUiWpGQbhr7tl+yn7ZcMJ8m2nLjFMhQFAscm7+053j1HrkXA3Iv4Srw0OmAavJhFIiOfOmmDNFrE4rIgOKMAvQScfjgHVMosPKxMBcGAo+Ak1QQZBZTKAyamCoDgLaVyLlNIO92RiISx5JBNn2ciFjmFfk9EwqLDkgI5jmgtNJYkYtHvX8tMREJyRBZDIe6GaZIbSsN5BmYOO5OOPlfSUSbi4CqKhA8rxUa9LK0iEQlaWmUyEvEclWeBtKASRbwWYWVbyeCkzkUk5saVGIYrtMTWSizs62lSpMeFTUTTzNitt0Z78mzoeDLhf/vh+ipNyft5pWCbERG1YEkHlkdrlUzbjfGNZ6X1/eg61Jw7x2aC7FxukvFgHMU0KZbHN1Y0UZ//hxm4MQQJEatTiVL9D/2E6EW/MEpNyaZsYfSDQzmZPp0et39sInWEgbLTcMjMTul4cvz0aDo5mvx4OX0en/wUP3s+mkwmf4pILMsWTV+VGYYWZZBBDX9XNvsOfpq7Yn3F9w04VNj0QtOw1smhWrwwJYVC6hwWpAMsnNF5BFYReoLgVoA5Sg0KA7lH365IyTnjvp6mh0XWDGBLraSm600jXp9MJtfTbRJO7idhQ2/aBJibSmffF+kB91+Hc3J9vIXz7D6cc12jklnL1pfmlvT3hTN0Hzr394tWdkLtvtgDO1zvQHpKKyfDqp0MyyO08qjbj69mzLhcJ6afKO0oCYWIxbiv/vF6N0UawdZcvRkzd3phgXlO7nWVtLGfVsHAbya97QBWTolYFCFYH4/HtXShszTynVpRJcxZ4w8O55VS77C+RTc2lvR4OpqMJqKJ1neMeNRZYpYjFvIy1woT39pAK8f19IAGWvsAaR8wlzo/+qrWbJfgCy6C7pz30rw9bbTyDa3EZj7sSfUDuiDMyLUnLvXctMr92b63pC9krtvs1tN7Y/wjqdSUxNeKUBBsxP/56+9WIzNpVZIObeE+gveVA2sW5HiOos5grmgpE0UHbimesFTkvVqB1IFyh4Egk7kMqICzwjSTosVEKsmlzmKGtR0MusWP4GNBoSDHWz84AoSMalLcIaCM4VJhf1gFU7Y++phhYdztnEOKACGpvNTkPXiijQrpAnVKsDmLCIwD1EA6kLNOegKUJQvPjQOaz2Uq2TAXt2P2KFFjTuwsAo6bs2CdqWVGHpxJKh/AG1W1QNhjSRQ6iJoo8yP4VdbUAefFbp5QBnnFJiJITUbQtznD0Bkk5ANYdi9Tao36gC6AoppcW3vtSXI/gDXMPxIV39KGZ8uGgkPteaJ3AW2OZps+6wxfmVofGa5G8El/0jwhoPLEBaCkvvXxJ30EV9sy+0iJl4Fmjzf9sFgs7vXBk32dMxmKKgFH1uz08nax7Zqh+vbHExGJQK707+cX5GqZUt+EX/A5boXHPSvzhGZm7e5M3GMv7iowQyqZkvY04NDTsw9voYano8kePf2HgMdvz1++enfxiu0yGXb9t6EpYY0PJeqBq8Ej4G7brnej5Vu/F3rWCbQMY6tQtpOiBbruWf5K7O778eC1MItEYXxggfU6QU9/ONU0vPy5IseTZBaJGp3EhKmJR4H0/D3bvga+CPLx7/3D4gkcfngcDHvDoJrps0ZV8S8RiVta7T90mlkTbViUA+sETtOUbBio3hvie5Pw7NWliARWnKMhe9+27N1/YesHw9qn9S4A/uQJc1DhZz7oN7T6ZSve7XxRoce3keYUzZqm+Re2cQkl",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,g={id:"API-docs/getcontact",title:"Get Contact",description:"The Get Contact API allows you to retrieve details about a specific contact.",source:"@site/docs/API-docs/getcontact.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getcontact",permalink:"/docs/API-docs/getcontact",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getcontact",title:"Get Contact",description:"The Get Contact API allows you to retrieve details about a specific contact.",sidebar_label:"Get Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V21v2zYQ/itXflkLKH5J0w4ThqFBV6RBu7ZYMhRYagQn6SwxoUiWpGQbhr7tl+yn7ZcMJ8m2nLjFMhQFAscm7+053j1HrkXA3Iv4Srw0OmAavJhFIiOfOmmDNFrE4rIgOKMAvQScfjgHVMosPKxMBcGAo+Ak1QQZBZTKAyamCoDgLaVyLlNIO92RiISx5JBNn2ciFjmFfk9EwqLDkgI5jmgtNJYkYtHvX8tMREJyRBZDIe6GaZIbSsN5BmYOO5OOPlfSUSbi4CqKhA8rxUa9LK0iEQlaWmUyEvEclWeBtKASRbwWYWVbyeCkzkUk5saVGIYrtMTWSizs62lSpMeFTUTTzNitt0Z78mzoeDLhf/vh+ipNyft5pWCbERG1YEkHlkdrlUzbjfGNZ6X1/eg61Jw7x2aC7FxukvFgHMU0KZbHN1Y0UZ//hxm4MQQJEatTiVL9D/2E6EW/MEpNyaZsYfSDQzmZPp0et39sInWEgbLTcMjMTul4cvz0aDo5mvx4OX0en/wUP3s+mkwmf4pILMsWTV+VGYYWZZBBDX9XNvsOfpq7Yn3F9w04VNj0QtOw1smhWrwwJYVC6hwWpAMsnNF5BFYReoLgVoA5Sg0KA7lH365IyTnjvp6mh0XWDGBLraSm600jXp9MJtfTbRJO7idhQ2/aBJibSmffF+kB91+Hc3J9vIXz7D6cc12jklnL1pfmlvT3hTN0Hzr394tWdkLtvtgDO1zvQHpKKyfDqp0MyyO08qjbj69mzLhcJ6afKO0oCYWIxbiv/vF6N0UawdZcvRkzd3phgXlO7nWVtLGfVsHAbya97QBWTolYFCFYH4/HtXShszTynVpRJcxZ4w8O55VS77C+RTc2lvR4OpqMJqKJ1neMeNRZYpYjFvIy1woT39pAK8f19IAGWvsAaR8wlzo/+qrWbJfgCy6C7pz30rw9bbTyDa3EZj7sSfUDuiDMyLUnLvXctMr92b63pC9krtvs1tN7Y/wjqdSUxNeKUBBsxP/56+9WIzNpVZIObeE+gveVA2sW5HiOos5grmgpE0UHbimesFTkvVqB1IFyh4Egk7kMqICzwjSTosVEKsmlzmKGtR0MusWP4GNBoSDHWz84AoSMalLcIaCM4VJhf1gFU7Y++phhYdztnEOKACGpvNTkPXiijQrpAnVKsDmLCIwD1EA6kLNOegKUJQvPjQOaz2Uq2TAXt2P2KFFjTuwsAo6bs2CdqWVGHpxJKh/AG1W1QNhjSRQ6iJoo8yP4VdbUAefFbp5QBnnFJiJITUbQtznD0Bkk5ANYdi9Tao36gC6AoppcW3vtSXI/gDXMPxIV39KGZ8uGgkPteaJ3AW2OZps+6wxfmVofGa5G8El/0jwhoPLEBaCkvvXxJ30EV9sy+0iJl4Fmjzf9sFgs7vXBk32dMxmKKgFH1uz08nax7Zqh+vbHExGJQK707+cX5GqZUt+EX/A5boXHPSvzhGZm7e5M3GMv7iowQyqZkvY04NDTsw9voYano8kePf2HgMdvz1++enfxiu0yGXb9t6EpYY0PJeqBq8Ej4G7brnej5Vu/F3rWCbQMY6tQtpOiBbruWf5K7O778eC1MItEYXxggfU6QU9/ONU0vPy5IseTZBaJGp3EhKmJR4H0/D3bvga+CPLx7/3D4gkcfngcDHvDoJrps0ZV8S8RiVta7T90mlkTbViUA+sETtOUbBio3hvie5Pw7NWliARWnKMhe9+27N1/YesHw9qn9S4A/uQJc1DhZz7oN7T6ZSve7XxRoce3keYUzZqm+Re2cQkl",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Contact",permalink:"/docs/API-docs/createcontact"},next:{title:"Delete Contact",permalink:"/docs/API-docs/deletecontact"}},u={},v=[{value:"Request",id:"request",level:2}];function f(e){const a={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Get Contact"})}),"\n",(0,t.jsx)(r(),{method:"get",path:"/contact/{contact_id}"}),"\n",(0,t.jsx)(a.p,{children:"The Get Contact API allows you to retrieve details about a specific contact."}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(a.p,{children:"Path Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(c.Z,{className:"paramsItem",param:{name:"contact_id",in:"path",description:"objectId of contact",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(n.Z,{children:[(0,t.jsxs)(h.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"successful operation"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(m.Z,{responseExample:'{\n "objectId": "ph1bhx2jp",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "4131231231",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"400",value:"400",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(m.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Contact not found!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Contact not found!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(m.Z,{responseExample:'{\n "error": "Contact not found!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4651],{97717:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>j,default:()=>v,frontMatter:()=>x,metadata:()=>u,toc:()=>f});var t=s(85893),l=s(11151),n=s(58219),i=(s(62316),s(51039)),r=s.n(i),c=(s(82723),s(9487)),o=s(41429),d=s(5397),p=s(4667),m=s(9472),h=s(85162);const x={id:"getcontact",title:"Get Contact",description:"The Get Contact API allows you to retrieve details about a specific contact.",sidebar_label:"Get Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V21r3EYQ/iuT/dIE5HtxnJSKUmLS4JqGJtQugTqHWUlz0tqr3c3u6F449K2/pD+tv6TMSnfW2ZdQlxAw55N23p7ZmWfmNoJkGUR6JV5bQzKnIGaJKDDkXjlS1ohUXFYIZ0jQS8Dp+3OQWttlgLVtgCx4JK9wgVAgSaUDyMw2BBKCw1zNVQ55pzsSibAOvWTT54VIRYnUn4lEOOlljYSeI9oII2sUqejPr1UhEqE4IiepEvfDtNkN5nRegJ3DnUmPnxrlsRAp+QYTEWit2WhQtdMoEoErp22BIp1LHVggr7CWIt0IWrsoSV6ZUiRibn0tafgGVzJaSYX7ZZpV+XHlMtG2M3YbnDUBAxs6nkz43364oclzDGHeaNhlRCQRLBpieemcVnk8GN8EVto8jK5DzbnzbIZU53KbjEfjqKZZtTq+caJN+vw/zsCNRcgQWR1rqfT/0M8QX/UvRrmt2ZSrrHl0KCfT59Pj+Mcmco+SsDilQ2bulI4nx8+PppOjyfeX05fpyQ/pi5ejyWTyp0jEqo5o+qosJEWUpEgPnxtXfAM/7X2xvuL7BhwqbHuhbVnr5FAtXtgaqVKmhCUagqW3pkzAaZQBgfwaZCmVAS0J/ZOvV6TovfVfTtPjImsHsJXRyuD1thGvTyaT6+kuCScPk7ClN2MJ5rYxxbdFesD9l+GcXB/v4Lx4COfcLKRWRWTrS3uL5tvCGbqnzv3DolWdUDwXe2CH7zuQAfPGK1rHybA6kk4ddefp1YwZl+vE9hMljhKqRCrGffWPN3dTpBVszS+2Y6bxWqSiInIhHY+DNEVmVyPr0ARVGi2zwDQ0lk6NF0wl9zWkc4+QDiRLZcqjL2rN7vBe8J10ad9DvUu+dOpXXIstXe9J9fOyQlmgjxegzNxG5T7V7xyaC1WaeFGL6YOp+gF1bmvkKU8Vwlb8n7/+jhqFzZsaDcU6egLvGg/OLtHzWJOmgLnGlco0HlgaAspaYwh6DcoQll4SQqFKRVIDZ4W7PpdOZkorrjwWs6ztYVC8YQQfKqQKPR995xEkFLhAzQUL2tpbtkMWZEO2jj76mGFp/e2cQ0pAQtYEZTAECIhbFTSVNDnC9i4SsB6kATSE3nkVEKSqWXhuPeB8rnLFhrnWPDdzLY0skZ0lwHFzFpy3C1VgAG+zJhAEq5sIhD3WiNRBNIhFGMHPaoEdcH7Z0TsWUDZsIoHcFgh91zEMU0CGgcCxe5VjNBpIegKNC/Sx9uJNzhutwVmmAyU1L03Du2VD5KUJPGC7gLZXs0uf85Y3mOijkOsRfDQfDRM2NAG5ALQytyH9aI7galdmHzALinD2dNsPy+XyQR8829c5U1Q1GXh09k6vjC9j1wzVdw/PRCIIfR3ezS/QL1SOfRN+xuc4Co97kuSByUTXrTDcY6/uKzBhaZWjCTigtNOz929hAc9HE5EMOv8/BDx+e/76zW8Xb9guc1PXf9PRZDSJK5ANVEszcDXYye+37eaO6b/2+t6zDuGKxk5LFYk7At30pHsl7tbvdLC8zxJR2UAssNlkMuAfXrctv/7UoGdinyViIb2SGVPT1UYUKvD3Yrecfxbk09/7Pf8ZHP4dcDDsLYMaps+F1A0/iUTc4nr/d0c7a5Mti3JgncBpnqOjgeqDmbo3mM7eXIpEyIZzNGTv28je/Re2fjCsfVrvAuBPnjAHFX7ki/4V1z/txLuTzyr0+LbSnKJZ27b/AmTU4Ws=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,u={id:"API-docs/getcontact",title:"Get Contact",description:"The Get Contact API allows you to retrieve details about a specific contact.",source:"@site/docs/API-docs/getcontact.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getcontact",permalink:"/docs/API-docs/getcontact",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getcontact",title:"Get Contact",description:"The Get Contact API allows you to retrieve details about a specific contact.",sidebar_label:"Get Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V21r3EYQ/iuT/dIE5HtxnJSKUmLS4JqGJtQugTqHWUlz0tqr3c3u6F449K2/pD+tv6TMSnfW2ZdQlxAw55N23p7ZmWfmNoJkGUR6JV5bQzKnIGaJKDDkXjlS1ohUXFYIZ0jQS8Dp+3OQWttlgLVtgCx4JK9wgVAgSaUDyMw2BBKCw1zNVQ55pzsSibAOvWTT54VIRYnUn4lEOOlljYSeI9oII2sUqejPr1UhEqE4IiepEvfDtNkN5nRegJ3DnUmPnxrlsRAp+QYTEWit2WhQtdMoEoErp22BIp1LHVggr7CWIt0IWrsoSV6ZUiRibn0tafgGVzJaSYX7ZZpV+XHlMtG2M3YbnDUBAxs6nkz43364oclzDGHeaNhlRCQRLBpieemcVnk8GN8EVto8jK5DzbnzbIZU53KbjEfjqKZZtTq+caJN+vw/zsCNRcgQWR1rqfT/0M8QX/UvRrmt2ZSrrHl0KCfT59Pj+Mcmco+SsDilQ2bulI4nx8+PppOjyfeX05fpyQ/pi5ejyWTyp0jEqo5o+qosJEWUpEgPnxtXfAM/7X2xvuL7BhwqbHuhbVnr5FAtXtgaqVKmhCUagqW3pkzAaZQBgfwaZCmVAS0J/ZOvV6TovfVfTtPjImsHsJXRyuD1thGvTyaT6+kuCScPk7ClN2MJ5rYxxbdFesD9l+GcXB/v4Lx4COfcLKRWRWTrS3uL5tvCGbqnzv3DolWdUDwXe2CH7zuQAfPGK1rHybA6kk4ddefp1YwZl+vE9hMljhKqRCrGffWPN3dTpBVszS+2Y6bxWqSiInIhHY+DNEVmVyPr0ARVGi2zwDQ0lk6NF0wl9zWkc4+QDiRLZcqjL2rN7vBe8J10ad9DvUu+dOpXXIstXe9J9fOyQlmgjxegzNxG5T7V7xyaC1WaeFGL6YOp+gF1bmvkKU8Vwlb8n7/+jhqFzZsaDcU6egLvGg/OLtHzWJOmgLnGlco0HlgaAspaYwh6DcoQll4SQqFKRVIDZ4W7PpdOZkorrjwWs6ztYVC8YQQfKqQKPR995xEkFLhAzQUL2tpbtkMWZEO2jj76mGFp/e2cQ0pAQtYEZTAECIhbFTSVNDnC9i4SsB6kATSE3nkVEKSqWXhuPeB8rnLFhrnWPDdzLY0skZ0lwHFzFpy3C1VgAG+zJhAEq5sIhD3WiNRBNIhFGMHPaoEdcH7Z0TsWUDZsIoHcFgh91zEMU0CGgcCxe5VjNBpIegKNC/Sx9uJNzhutwVmmAyU1L03Du2VD5KUJPGC7gLZXs0uf85Y3mOijkOsRfDQfDRM2NAG5ALQytyH9aI7galdmHzALinD2dNsPy+XyQR8829c5U1Q1GXh09k6vjC9j1wzVdw/PRCIIfR3ezS/QL1SOfRN+xuc4Co97kuSByUTXrTDcY6/uKzBhaZWjCTigtNOz929hAc9HE5EMOv8/BDx+e/76zW8Xb9guc1PXf9PRZDSJK5ANVEszcDXYye+37eaO6b/2+t6zDuGKxk5LFYk7At30pHsl7tbvdLC8zxJR2UAssNlkMuAfXrctv/7UoGdinyViIb2SGVPT1UYUKvD3Yrecfxbk09/7Pf8ZHP4dcDDsLYMaps+F1A0/iUTc4nr/d0c7a5Mti3JgncBpnqOjgeqDmbo3mM7eXIpEyIZzNGTv28je/Re2fjCsfVrvAuBPnjAHFX7ki/4V1z/txLuTzyr0+LbSnKJZ27b/AmTU4Ws=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Contact",permalink:"/docs/API-docs/createcontact"},next:{title:"Delete Contact",permalink:"/docs/API-docs/deletecontact"}},g={},f=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Get Contact"})}),"\n",(0,t.jsx)(r(),{method:"get",path:"/contact/{contact_id}"}),"\n",(0,t.jsx)(a.p,{children:"The Get Contact API allows you to retrieve details about a specific contact."}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(a.p,{children:"Path Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(o.Z,{className:"paramsItem",param:{name:"contact_id",in:"path",description:"objectId of contact",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(n.Z,{children:[(0,t.jsxs)(h.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"successful operation"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "objectId": "ph1bhx2jp",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "4131231231",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"400",value:"400",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Contact not found!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Contact not found!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Contact not found!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/13fdae3b.53df0513.js b/assets/js/13fdae3b.53df0513.js new file mode 100644 index 000000000..1d86f7d3e --- /dev/null +++ b/assets/js/13fdae3b.53df0513.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6113],{21598:(e,l,s)=>{s.r(l),s.d(l,{assets:()=>j,contentTitle:()=>u,default:()=>f,frontMatter:()=>p,metadata:()=>x,toc:()=>b});var a=s(85893),o=s(11151),n=s(58219),t=(s(62316),s(51039)),i=s.n(t),d=(s(82723),s(9487)),r=(s(41429),s(5397)),c=s(4667),h=s(9472),m=s(85162);const p={id:"delete-webhook",title:"Delete Webhook",description:"The Delete Webhook API allow you to delete webhook url",sidebar_label:"Delete Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vttu20YQ/ZXxvrQBaElOk4cSRdGgNgIjRhNADvwgC8aQHJEbLXe3u0tKgsC3fkk/rV9SzFLUzY3RFkVfdNk5czmzM4fcioClF+lMPFBWGbMU80QU5HMnbZBGi1TcVwTXpCgQ7DDw7tMtoFJmBRvTQDBQ9PbVzt44JRJhLDnkILeFSEUPGbIkwpG3RnvyIt2K15MJf50mnjZ5Tt4vGgX7UCIRudGBdGA8WqtkHg3jL56dtsLnFdXIv8LGkkiFyb5QHkQirOMwQfYpHflGhSOcD07qUiSC1lhbxUcD3772Avy+IrW5EF2XiCBDREqtpKangdTT68nk6XvRdYx5M3nznNxnTw60CbAwjS4u/jte5JxxL9M6z/0SES5+oPH2OY1b3aKSRZyIe7Mk/f8yOU4f+vRc6rpW7Kex7ilFULSLE6rH5z1JT3njZNiIdLYV60u08rK3p7N5N09ETaEyh3HmmjFUIhXj1X6yPbmWnI8heBNSUYVgfToee9RFZtYjY0l7WWqFmR/lph6jleP2SnTJuQda+w/QPmApdXn5otf8wHLKN9E3+4TrvuVo5QfaiGRo5TEqEZInoCIsyMW2S70w0XnX4I+W9FSWOl5PeyXOleWBVG5qYgEJFcEA/+O336NHYfKmJh3i9FzAx8aBNStyLAioC1goWstM0UGO/KBHnrBW5L3agNSBSoeBoJClDKiAuyJ1CTlazKSSPG8MM+zt4Ghk/QgeKgoVOTZ94wgQCmpJ8ZiCMmbJcYIBbIKpY45dzbAybrngkhJAyBovNXkPnmhwIV2hzgmGu0jAOEANpAM566QnQFkzeGEc0GIhc8mBebkc5gFq1FgSJ0uA6+YuWGdaWZAHZ7LGB/BGNZEIZ6yJQk9RExV+BNeypZ44HxYUUCoqoGw4RAK5KQh2u8Y0dAEZ+QCW08ucYlAf0AVQ1JKLsxdvkgUSrGERkKjALE7ulgMFh9ovjKv7goar2bfPOsNKG3MUuBnBo37UUx6WxhMPgJJ66dNHfQmz/Zg9UOZloPm3wz6sVqtne/Dq1Oe9DFWTgSNrDn5lPIxbc+y+//NKJCKQq/3HxZRcK3PaLeFXco4jeLyTRsyjNFKNUvU79tO5A8uUkjlpT0dC9u79pzto4bvRRCRHm/83Ch7f3f5888v0huOyNvX7dzWajCZ8ZI0PNeqjVKcP/PPN3R4k/t+/HuwkJtA6jK1CGbU5struRHUmVoeXksr4wEfbbYaePjvVdXz8a0OO1XqeiBadxIyVZzbvkkGYWIWXtOH25TlZfsy0qJpe3c4eTicKf31zd3N/IxKBDRdzrInLqIm7H5xgMOnNUfhTsexr4E/W7b90+IEb94E2P+7hveWrDjuKA5pbOO+67k+/h3Ic",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/delete-webhook",title:"Delete Webhook",description:"The Delete Webhook API allow you to delete webhook url",source:"@site/docs/API-docs/delete-webhook.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/delete-webhook",permalink:"/docs/API-docs/delete-webhook",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"delete-webhook",title:"Delete Webhook",description:"The Delete Webhook API allow you to delete webhook url",sidebar_label:"Delete Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vttu20YQ/ZXxvrQBaElOk4cSRdGgNgIjRhNADvwgC8aQHJEbLXe3u0tKgsC3fkk/rV9SzFLUzY3RFkVfdNk5czmzM4fcioClF+lMPFBWGbMU80QU5HMnbZBGi1TcVwTXpCgQ7DDw7tMtoFJmBRvTQDBQ9PbVzt44JRJhLDnkILeFSEUPGbIkwpG3RnvyIt2K15MJf50mnjZ5Tt4vGgX7UCIRudGBdGA8WqtkHg3jL56dtsLnFdXIv8LGkkiFyb5QHkQirOMwQfYpHflGhSOcD07qUiSC1lhbxUcD3772Avy+IrW5EF2XiCBDREqtpKangdTT68nk6XvRdYx5M3nznNxnTw60CbAwjS4u/jte5JxxL9M6z/0SES5+oPH2OY1b3aKSRZyIe7Mk/f8yOU4f+vRc6rpW7Kex7ilFULSLE6rH5z1JT3njZNiIdLYV60u08rK3p7N5N09ETaEyh3HmmjFUIhXj1X6yPbmWnI8heBNSUYVgfToee9RFZtYjY0l7WWqFmR/lph6jleP2SnTJuQda+w/QPmApdXn5otf8wHLKN9E3+4TrvuVo5QfaiGRo5TEqEZInoCIsyMW2S70w0XnX4I+W9FSWOl5PeyXOleWBVG5qYgEJFcEA/+O336NHYfKmJh3i9FzAx8aBNStyLAioC1goWstM0UGO/KBHnrBW5L3agNSBSoeBoJClDKiAuyJ1CTlazKSSPG8MM+zt4Ghk/QgeKgoVOTZ94wgQCmpJ8ZiCMmbJcYIBbIKpY45dzbAybrngkhJAyBovNXkPnmhwIV2hzgmGu0jAOEANpAM566QnQFkzeGEc0GIhc8mBebkc5gFq1FgSJ0uA6+YuWGdaWZAHZ7LGB/BGNZEIZ6yJQk9RExV+BNeypZ44HxYUUCoqoGw4RAK5KQh2u8Y0dAEZ+QCW08ucYlAf0AVQ1JKLsxdvkgUSrGERkKjALE7ulgMFh9ovjKv7goar2bfPOsNKG3MUuBnBo37UUx6WxhMPgJJ66dNHfQmz/Zg9UOZloPm3wz6sVqtne/Dq1Oe9DFWTgSNrDn5lPIxbc+y+//NKJCKQq/3HxZRcK3PaLeFXco4jeLyTRsyjNFKNUvU79tO5A8uUkjlpT0dC9u79pzto4bvRRCRHm/83Ch7f3f5888v0huOyNvX7dzWajCZ8ZI0PNeqjVKcP/PPN3R4k/t+/HuwkJtA6jK1CGbU5struRHUmVoeXksr4wEfbbYaePjvVdXz8a0OO1XqeiBadxIyVZzbvkkGYWIWXtOH25TlZfsy0qJpe3c4eTicKf31zd3N/IxKBDRdzrInLqIm7H5xgMOnNUfhTsexr4E/W7b90+IEb94E2P+7hveWrDjuKA5pbOO+67k+/h3Ic",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Save or Update Webhook",permalink:"/docs/API-docs/save-update-webhook"},next:{title:"Create Folder",permalink:"/docs/API-docs/createfolder"}},j={},b=[{value:"Request",id:"request",level:2}];function k(e){const l={h2:"h2",p:"p",...(0,o.a)(),...e.components},{Details:s}=l;return s||function(e,l){throw new Error("Expected "+(l?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)("h1",{className:"openapi__heading",children:(0,a.jsx)(l.p,{children:"Delete Webhook"})}),"\n",(0,a.jsx)(i(),{method:"delete",path:"/webhook"}),"\n",(0,a.jsx)(l.p,{children:"The Delete Webhook API allow you to delete webhook url"}),"\n",(0,a.jsx)(l.h2,{id:"request",children:"Request"}),"\n",(0,a.jsx)("div",{children:(0,a.jsx)("div",{children:(0,a.jsxs)(n.Z,{children:[(0,a.jsxs)(m.default,{label:"200",value:"200",children:[(0,a.jsx)("div",{children:(0,a.jsx)(l.p,{children:"Successful operation"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(l.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"result",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Webhook deleted successfully!"}})})]})}),(0,a.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(r.Z,{responseExample:'{\n "result": "Webhook deleted successfully!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(m.default,{label:"404",value:"404",children:[(0,a.jsx)("div",{children:(0,a.jsx)(l.p,{children:"User not found!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(l.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"User not found!"}})})]})}),(0,a.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(r.Z,{responseExample:'{\n "error": "User not found!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(m.default,{label:"405",value:"405",children:[(0,a.jsx)("div",{children:(0,a.jsx)(l.p,{children:"Invalid API Token!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(l.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,a.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(r.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function f(e={}){const{wrapper:l}={...(0,o.a)(),...e.components};return l?(0,a.jsx)(l,{...e,children:(0,a.jsx)(k,{...e})}):k(e)}}}]); \ No newline at end of file diff --git a/assets/js/13fdae3b.f0293d27.js b/assets/js/13fdae3b.f0293d27.js deleted file mode 100644 index ecec07080..000000000 --- a/assets/js/13fdae3b.f0293d27.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6113],{21598:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>j,contentTitle:()=>x,default:()=>k,frontMatter:()=>m,metadata:()=>u,toc:()=>b});var l=a(85893),i=a(11151),n=a(58219),o=(a(62316),a(51039)),t=a.n(o),d=(a(82723),a(9487)),r=(a(41429),a(5397)),c=a(4667),h=a(9472),p=a(85162);const m={id:"delete-webhook",title:"Delete Webhook",description:"The Delete Webhook API allow you to delete webhook url",sidebar_label:"Delete Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vt1u2zYUfpUT3mwFFMvp2osZw7BgCbqgXRPAKXLhGMGRdCyxpkiOpGQbhu/2JHu0PclwKMt/aYNtGHZjSzy/3/n5qLUIWHoxmogHyipj5mKaiIJ87qQN0mgxEvcVwRUpCgRbHbi8uwFUyixgZRoIBopOvtjKG6dEIowlh+zkphAj0an0URLhyFujPXkxWovXwyH/HQceN3lO3s8aBTtXIhG50YF0YH20Vsk8CtLPno3WwucV1chPYWVJjITJPlMeRCKsYzdBdiEd+UaFAz0fnNSlSAQtsbaKj3q8Xe4F+F1GanUmNptEBBmiptRKanrqQT29Hg6fvhebDeu8Gb55Du6TJwfaBJiZRhdn/x0ucs64l2Gdxn4JCCffw3j7HMaNblHJIk7EvZmT/n+RHIYPXXhOdVkrttNYd5CiUpSLI6iH5x1IT3njZFiJ0WQtludo5XknH02mm2kiagqV2Y8z54yhEiORLnaT7cm15Hx0cTLRCyxLcr80Wcz4sgkGfjX5vIPFWzMSVQjWj9K0lS50nga+M6uabJCbOr1zyBP4Eds5utRY0unFYDgYik2yPnHiUReZWQ5YyctSK8x89IFWpu3FFyzQ2n+g7QOWUpfnL1pN92Udc+u77h4Vd9djtPI9rUTS9+5QKxGSi1gRFuRin6WemWi87eitJT2WpY7VbS/EKZU9kMpNTcxYoSLo1f/8/Y9oUZi8qUmHOK5ncNs4sGZBjhkIdQEzRUuZKdrzn+8J0BPWirxXK5A6UOkwEBSylAEVcFWkLiFHi5lUkgec1QxbOzjYET+Ah4pCRY5F3zgChIJaUrwXoIzhUeF42ARTxxjbnGFh3HzGKSWAkDVeavIePFFvQrpCnRP0vUjAOEANpAM566QnQFmz8sw4oNlM5pId8zY7zAPUqLEkDpYA581VsM60siAPzmSND+CNaiIQjlgThQ6iJir8AK5kSx1wPiwooFRUQNmwiwRyUxBsl5th6AIy8gEsh5c5Rac+oAugqCUXZy92kvcBrGHWkajAzI56y46CQ+1nxtVdQn1rduWzzjC1xxgFrgbwqB/1mIel8cQDoKSe+9GjPofJbsweKPMy0PTbfh8Wi8WzPXh1bPNOhqrJwJE1e7syHsatOTTfvbwSiQjkan87G5NrZU7bJfxKzDQqp1suxjxyMdUoVbdjP50aMC8qmZP2dMCcl+/uPkAL3w2GR/T0NxJOP9z8fP1xfM1+mQy7/etpSljjQ436INTxF8bp5q73d8q//x7ZUkygZUitQhkvg4hqvWXxiVjsv4Iq4wMfrdcZevrk1GbDx7815Ph6mCaiRScxY+aZTDdJT0xM+3NacfnynCzfay2qpmO3k9vw6Eq5uv5wfX8tEoENJ3PIifPIidsHDtCL9OrA/TFZdjnwL/P2Fw1+4MK9p9WPO/VO8lWDLcRem0s43Ww2fwFai5nH",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,u={id:"API-docs/delete-webhook",title:"Delete Webhook",description:"The Delete Webhook API allow you to delete webhook url",source:"@site/docs/API-docs/delete-webhook.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/delete-webhook",permalink:"/docs/API-docs/delete-webhook",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"delete-webhook",title:"Delete Webhook",description:"The Delete Webhook API allow you to delete webhook url",sidebar_label:"Delete Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vt1u2zYUfpUT3mwFFMvp2osZw7BgCbqgXRPAKXLhGMGRdCyxpkiOpGQbhu/2JHu0PclwKMt/aYNtGHZjSzy/3/n5qLUIWHoxmogHyipj5mKaiIJ87qQN0mgxEvcVwRUpCgRbHbi8uwFUyixgZRoIBopOvtjKG6dEIowlh+zkphAj0an0URLhyFujPXkxWovXwyH/HQceN3lO3s8aBTtXIhG50YF0YH20Vsk8CtLPno3WwucV1chPYWVJjITJPlMeRCKsYzdBdiEd+UaFAz0fnNSlSAQtsbaKj3q8Xe4F+F1GanUmNptEBBmiptRKanrqQT29Hg6fvhebDeu8Gb55Du6TJwfaBJiZRhdn/x0ucs64l2Gdxn4JCCffw3j7HMaNblHJIk7EvZmT/n+RHIYPXXhOdVkrttNYd5CiUpSLI6iH5x1IT3njZFiJ0WQtludo5XknH02mm2kiagqV2Y8z54yhEiORLnaT7cm15Hx0cTLRCyxLcr80Wcz4sgkGfjX5vIPFWzMSVQjWj9K0lS50nga+M6uabJCbOr1zyBP4Eds5utRY0unFYDgYik2yPnHiUReZWQ5YyctSK8x89IFWpu3FFyzQ2n+g7QOWUpfnL1pN92Udc+u77h4Vd9djtPI9rUTS9+5QKxGSi1gRFuRin6WemWi87eitJT2WpY7VbS/EKZU9kMpNTcxYoSLo1f/8/Y9oUZi8qUmHOK5ncNs4sGZBjhkIdQEzRUuZKdrzn+8J0BPWirxXK5A6UOkwEBSylAEVcFWkLiFHi5lUkgec1QxbOzjYET+Ah4pCRY5F3zgChIJaUrwXoIzhUeF42ARTxxjbnGFh3HzGKSWAkDVeavIePFFvQrpCnRP0vUjAOEANpAM566QnQFmz8sw4oNlM5pId8zY7zAPUqLEkDpYA581VsM60siAPzmSND+CNaiIQjlgThQ6iJir8AK5kSx1wPiwooFRUQNmwiwRyUxBsl5th6AIy8gEsh5c5Rac+oAugqCUXZy92kvcBrGHWkajAzI56y46CQ+1nxtVdQn1rduWzzjC1xxgFrgbwqB/1mIel8cQDoKSe+9GjPofJbsweKPMy0PTbfh8Wi8WzPXh1bPNOhqrJwJE1e7syHsatOTTfvbwSiQjkan87G5NrZU7bJfxKzDQqp1suxjxyMdUoVbdjP50aMC8qmZP2dMCcl+/uPkAL3w2GR/T0NxJOP9z8fP1xfM1+mQy7/etpSljjQ436INTxF8bp5q73d8q//x7ZUkygZUitQhkvg4hqvWXxiVjsv4Iq4wMfrdcZevrk1GbDx7815Ph6mCaiRScxY+aZTDdJT0xM+3NacfnynCzfay2qpmO3k9vw6Eq5uv5wfX8tEoENJ3PIifPIidsHDtCL9OrA/TFZdjnwL/P2Fw1+4MK9p9WPO/VO8lWDLcRem0s43Ww2fwFai5nH",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Save or Update Webhook",permalink:"/docs/API-docs/save-update-webhook"},next:{title:"Create Folder",permalink:"/docs/API-docs/createfolder"}},j={},b=[{value:"Request",id:"request",level:2}];function f(e){const s={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Delete Webhook"})}),"\n",(0,l.jsx)(t(),{method:"delete",path:"/webhook"}),"\n",(0,l.jsx)(s.p,{children:"The Delete Webhook API allow you to delete webhook url"}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(p.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"result",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Webhook deleted successfully!"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(r.Z,{responseExample:'{\n "result": "Webhook deleted successfully!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"User not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"User not found!"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(r.Z,{responseExample:'{\n "error": "User not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(r.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function k(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/1f73ca32.03dc5da3.js b/assets/js/1f73ca32.03dc5da3.js deleted file mode 100644 index b653b72af..000000000 --- a/assets/js/1f73ca32.03dc5da3.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2832],{8484:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>j,contentTitle:()=>x,default:()=>f,frontMatter:()=>u,metadata:()=>h,toc:()=>g});var l=s(85893),t=s(11151),i=s(58219),n=(s(62316),s(51039)),o=s.n(n),r=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),m=s(9472),p=s(85162);const u={id:"get-user",title:"Get your account details",description:"The Get User API enables you to get your own account details.",sidebar_label:"Get your account details",hide_title:!0,hide_table_of_contents:!0,api:"eJy9VttuGzcQ/ZUJX9oAa0m+JGmFoojbpo6TNAlgBwHqCMEsd7RLi0uyJHdlQdBbv6Sf1i8phquVJTkJarTIi60l58x9znApIpZBjK/Eu0BeTDJRUJBeuaisEWNxWRGcUQS+hdO350AGc00BFraBaKGkyD892LkBlNI2JkJBEZUOA5EJ68gj6zovxFiUFJOZTHgKzppAQYyX4mg04n+7li8aKSmEaaNho0RkQloTyUSWR+e0kulieB0YtBRBVlQj/4oLR2IsbH5NMopMOM9qoupMdsfs1EYyRK9MKTIxtb7GuH1CN1g7zUK/nqnZ0XFevXshVpkwWNN9NbywBD8RMZxqVPq++GtLOdHT9cFA2ppVucqae7ty8ujxk++Ojw6PjlnFtc0vVdT31lJQy3Bpa4dmcV+0dWSCKk1S4QkjFafxU0puIUejo+ODw9HB6Mnl4ePxyffjR48Ho9Hod5GJmzrls6uLKDCmPMcurM1344qvYGe1L9Zw62+Jdd8rFjwZndydgDRzxkaY2sYUD/6/5ifvrf9y7Pu2V1t+K6OVoY/9CH9k5/swHt0N49y0qFWR2OPSzsh83Ui2zcfO/N3SqE4o3YudULfPuyADycaruBDjq6W4OUCnDrr78dVkNclETbGya7ZjhzFWYiyGJcWm475AviUfEn6P8+ZYluSfN3ly97SJFn6zctbF1HgtxqKK0YXxcNgqHztNg9DBqiZnOhi+9ThttH6N7Qz9kAdseDgYDUZilS33lAQ0RW5vBv0UasxD0oFODdvDTyDQuXtIh4ilMuXBF1GT25xecN270u5kdlNgdOolLURPvTtSmVCcxIqwSIPF31ObwOtyvnFkLlRpUnbbQ7G/7d6TlrYmXmyxIujF//7zr4QorGxqMjH16gN403hwdk6edxSaAqaablSuKQmj1na+2ZOBsNYUgl6AMpFKj5GgUKWKqIGzokwJEh3mSivubhaz3WrdGpAwgPcVxYo8X33jCRAKaknzUIC2lluF7WETbZ1srH2GufWzKbuUAULeBGUoBAhEPYRMhUYS9LXIwHpAA2QieedVIEBVs/DUeqDpVEnFinmUPcoINRosiY1lwH5zFpy3rSoogLd5EyIEq5sUCFusqX89GKIiDOAX1VIXOB92zwgqoGxYRQbSFgTryeYwTAE5hQiOzStJSWmI6CNoasmn3kuV5HkAZ5lyFGqw053asqLo0QReVJ1DfWk26XPe8nMk2ShwMYAP5oO54GZpAnEDaGVmYfzBHMDVps3eUx5UpMm3/TzM5/M7c/BwF3OmYtXk4MnZW1yZDtPUbMM3Hw9FJiL5OryZXpBvlaT1EH7G5jAJD9dEjDIR8fo5wjP2dB/ApKiVJBNoizZPz96+ghaOB6MdevoXDg9fnf/87PXFM9bLZNjNX09TwtkQazRbps76Vtl7ZO7P8PJ2tfznx+uacyLdxKHTqNJqSGEu17R+JXpan2SisiHy0XKZY6B3Xq9WfPxHQ56XxSQTLXrFHqRVkfVMxXtgRgvOp5TkeGm0qJuO7vZ2486COXt2KTKBDXuyzZCzxJDrH6y9vzKLLd271Nk5wH+ZxT8J+IFT+JIWP27Eu5vPAtbx9dKcv8lqtfoHAVdJMg==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,h={id:"API-docs/get-user",title:"Get your account details",description:"The Get User API enables you to get your own account details.",source:"@site/docs/API-docs/get-user.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/get-user",permalink:"/docs/API-docs/get-user",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"get-user",title:"Get your account details",description:"The Get User API enables you to get your own account details.",sidebar_label:"Get your account details",hide_title:!0,hide_table_of_contents:!0,api:"eJy9VttuGzcQ/ZUJX9oAa0m+JGmFoojbpo6TNAlgBwHqCMEsd7RLi0uyJHdlQdBbv6Sf1i8phquVJTkJarTIi60l58x9znApIpZBjK/Eu0BeTDJRUJBeuaisEWNxWRGcUQS+hdO350AGc00BFraBaKGkyD892LkBlNI2JkJBEZUOA5EJ68gj6zovxFiUFJOZTHgKzppAQYyX4mg04n+7li8aKSmEaaNho0RkQloTyUSWR+e0kulieB0YtBRBVlQj/4oLR2IsbH5NMopMOM9qoupMdsfs1EYyRK9MKTIxtb7GuH1CN1g7zUK/nqnZ0XFevXshVpkwWNN9NbywBD8RMZxqVPq++GtLOdHT9cFA2ppVucqae7ty8ujxk++Ojw6PjlnFtc0vVdT31lJQy3Bpa4dmcV+0dWSCKk1S4QkjFafxU0puIUejo+ODw9HB6Mnl4ePxyffjR48Ho9Hod5GJmzrls6uLKDCmPMcurM1344qvYGe1L9Zw62+Jdd8rFjwZndydgDRzxkaY2sYUD/6/5ifvrf9y7Pu2V1t+K6OVoY/9CH9k5/swHt0N49y0qFWR2OPSzsh83Ui2zcfO/N3SqE4o3YudULfPuyADycaruBDjq6W4OUCnDrr78dVkNclETbGya7ZjhzFWYiyGJcWm475AviUfEn6P8+ZYluSfN3ly97SJFn6zctbF1HgtxqKK0YXxcNgqHztNg9DBqiZnOhi+9ThttH6N7Qz9kAdseDgYDUZilS33lAQ0RW5vBv0UasxD0oFODdvDTyDQuXtIh4ilMuXBF1GT25xecN270u5kdlNgdOolLURPvTtSmVCcxIqwSIPF31ObwOtyvnFkLlRpUnbbQ7G/7d6TlrYmXmyxIujF//7zr4QorGxqMjH16gN403hwdk6edxSaAqaablSuKQmj1na+2ZOBsNYUgl6AMpFKj5GgUKWKqIGzokwJEh3mSivubhaz3WrdGpAwgPcVxYo8X33jCRAKaknzUIC2lluF7WETbZ1srH2GufWzKbuUAULeBGUoBAhEPYRMhUYS9LXIwHpAA2QieedVIEBVs/DUeqDpVEnFinmUPcoINRosiY1lwH5zFpy3rSoogLd5EyIEq5sUCFusqX89GKIiDOAX1VIXOB92zwgqoGxYRQbSFgTryeYwTAE5hQiOzStJSWmI6CNoasmn3kuV5HkAZ5lyFGqw053asqLo0QReVJ1DfWk26XPe8nMk2ShwMYAP5oO54GZpAnEDaGVmYfzBHMDVps3eUx5UpMm3/TzM5/M7c/BwF3OmYtXk4MnZW1yZDtPUbMM3Hw9FJiL5OryZXpBvlaT1EH7G5jAJD9dEjDIR8fo5wjP2dB/ApKiVJBNoizZPz96+ghaOB6MdevoXDg9fnf/87PXFM9bLZNjNX09TwtkQazRbps76Vtl7ZO7P8PJ2tfznx+uacyLdxKHTqNJqSGEu17R+JXpan2SisiHy0XKZY6B3Xq9WfPxHQ56XxSQTLXrFHqRVkfVMxXtgRgvOp5TkeGm0qJuO7vZ2486COXt2KTKBDXuyzZCzxJDrH6y9vzKLLd271Nk5wH+ZxT8J+IFT+JIWP27Eu5vPAtbx9dKcv8lqtfoHAVdJMg==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Introduction",permalink:"/docs/API-docs/opensign-api-v-1"},next:{title:"Create Contact",permalink:"/docs/API-docs/createcontact"}},j={},g=[{value:"Request",id:"request",level:2}];function y(e){const a={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Get your account details"})}),"\n",(0,l.jsx)(o(),{method:"get",path:"/getuser"}),"\n",(0,l.jsx)(a.p,{children:"The Get User API enables you to get your own account details."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(p.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Joe Bee"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4567832123"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"jobTitle",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"dev"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"company",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"opensign"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "objectId": "FGik23bhUJ",\n "name": "Joe Bee",\n "email": "joebee@example.com",\n "phone": "4567832123",\n "jobTitle": "dev",\n "company": "opensign",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"User not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"User not found!"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "User not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function f(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/1f73ca32.e34356e0.js b/assets/js/1f73ca32.e34356e0.js new file mode 100644 index 000000000..1e69f101f --- /dev/null +++ b/assets/js/1f73ca32.e34356e0.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2832],{8484:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>j,contentTitle:()=>h,default:()=>b,frontMatter:()=>u,metadata:()=>x,toc:()=>g});var i=a(85893),l=a(11151),t=a(58219),n=(a(62316),a(51039)),r=a.n(n),o=(a(82723),a(9487)),c=(a(41429),a(5397)),d=a(4667),m=a(9472),p=a(85162);const u={id:"get-user",title:"Get your account details",description:"The Get User API enables you to get your own account details.",sidebar_label:"Get your account details",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v2zYQ/itXftkKKLbz2k0YhmZbF6QtlgJJEGCJUVDSWWJMkRx5kmMY/rZfsp+2XzIcZTm20xYLNvSLLZL33BvvnuNCkCyDSG/FdUAvxokoMOReOVLWiFRcVQhnSMCncPrhHNDITGOAuW2ALJRI/OnBzgzIPLeNISiQpNJhIBJhHXrJus4LkYoSKZpJhMfgrAkYRLoQB6MR/21bvmzyHEOYNBrWSkQicmsIDbG8dE6rPB4M7wODFiLkFdaSv2juUKTCZveYk0iE86yGVGey22an1pKBvDKlSMTE+lrS5g4+yNppFvr1TE0PDrPq+q1YJsLIGp+r4a1F+AmR4VhLpZ+Lv7eYIb5ebQxyW7MqV1nzbFeOjk9efXd4sH9wyCrubXalSD9bS4Etw3NbO2nmz0Vbhyao0kQVHiVhcUqfUvIIORgdHO7tj/ZGr672T9Kj79Pjk8FoNPpdJOKhjvns7kUUkmKeqQtrvW5c8RXsLHfFGi79DbFuvWTBo9HR0w6IPWcswcQ2pnjx/xU/em/9l2Pftb3c8FsZrQx+7Fv4Izvfh3H8NIxz00qtisgeV3aK5utGsmmeOvNPr0Z1QvFcbIW6ud8FGTBvvKK5SG8X4mFPOrXXnae34+U4ETVSZVdsxw5LqkQqhiVS03FfQN+iDxHfeC1SURG5kA6HQZoisw+Dvim0zAJ3+FA6NWz3xTLZRUjnniEdSJbKlHtfRI0fQ7zka+gyvRXoOt/SqXc4Fz0TbkklQvH1VyiLWOe8ntgIXmX3wqG5VKWJd9Pui93hc4M6tzXynKEKoRf/+8+/IqKweVOjoVg6L+Ci8eDsDD2PDGkKmGh8UJnGKCy1trP12Aooa40h6DkoQ1h6SQiFKhVJDZwVZUrIpZOZ0oqLjcVsN+k26jUM4KZCqtDz0TceQUKBLWquUdDWTlkPWZAN2TraWPkMM+unE3YpAQlZE5TBECAg9hA0lTQ5Qn8XCVgP0gAaQu+8CghS1Sw8sR5wMlG5YsXcWV7mBLU0skQ2lgD7zVlw3raqwADeZk0gCFY3MRC2WGM/zA1iEQbwi2qxC5w3u6mOBZQNq0ggtwXCqtE4DFNAhoHAsXmVY1QaSHoCjS36WHvxJieN1uAsM4CSGuxk625ZEXlpAs+NzqH+atbpc97y6yDaKOR8AHfmzlxysTQBuQC0MtOQ3pk9uF2X2Q1mQRGOv+37YTabPemDl9uYM0VVk4FHZx9xZdyMXbMJXy9eikQQ+jpcTC7RtyrHVRN+xuYwCg9XvCjzyIur1wH32OtdAHOUVjmagBssdnr24T20cDgYiWSj8/+Fw8P35z+/+e3yDetlbur6b38wGozi68IGqqXZMHXWl8rOm2+3hxePTP+f35IrziF8oKHTUkWmjmEuVix7K3qWHSeisoF4a7HIZMBrr5dL3v6jQc/cPU5EK71iDyJzJz1TMS1Pcc75zHN0zOGt1E1Hdzujaovvz95ciUTIhj3ZZMhpZMjVB2vvj8x8Q/c2dXYO8C+z+CcBP3AK3+H8x7V4d/JZwCq+XprzN14ul/8AL/4hhw==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},h=void 0,x={id:"API-docs/get-user",title:"Get your account details",description:"The Get User API enables you to get your own account details.",source:"@site/docs/API-docs/get-user.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/get-user",permalink:"/docs/API-docs/get-user",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"get-user",title:"Get your account details",description:"The Get User API enables you to get your own account details.",sidebar_label:"Get your account details",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v2zYQ/itXftkKKLbz2k0YhmZbF6QtlgJJEGCJUVDSWWJMkRx5kmMY/rZfsp+2XzIcZTm20xYLNvSLLZL33BvvnuNCkCyDSG/FdUAvxokoMOReOVLWiFRcVQhnSMCncPrhHNDITGOAuW2ALJRI/OnBzgzIPLeNISiQpNJhIBJhHXrJus4LkYoSKZpJhMfgrAkYRLoQB6MR/21bvmzyHEOYNBrWSkQicmsIDbG8dE6rPB4M7wODFiLkFdaSv2juUKTCZveYk0iE86yGVGey22an1pKBvDKlSMTE+lrS5g4+yNppFvr1TE0PDrPq+q1YJsLIGp+r4a1F+AmR4VhLpZ+Lv7eYIb5ebQxyW7MqV1nzbFeOjk9efXd4sH9wyCrubXalSD9bS4Etw3NbO2nmz0Vbhyao0kQVHiVhcUqfUvIIORgdHO7tj/ZGr672T9Kj79Pjk8FoNPpdJOKhjvns7kUUkmKeqQtrvW5c8RXsLHfFGi79DbFuvWTBo9HR0w6IPWcswcQ2pnjx/xU/em/9l2Pftb3c8FsZrQx+7Fv4Izvfh3H8NIxz00qtisgeV3aK5utGsmmeOvNPr0Z1QvFcbIW6ud8FGTBvvKK5SG8X4mFPOrXXnae34+U4ETVSZVdsxw5LqkQqhiVS03FfQN+iDxHfeC1SURG5kA6HQZoisw+Dvim0zAJ3+FA6NWz3xTLZRUjnniEdSJbKlHtfRI0fQ7zka+gyvRXoOt/SqXc4Fz0TbkklQvH1VyiLWOe8ntgIXmX3wqG5VKWJd9Pui93hc4M6tzXynKEKoRf/+8+/IqKweVOjoVg6L+Ci8eDsDD2PDGkKmGh8UJnGKCy1trP12Aooa40h6DkoQ1h6SQiFKhVJDZwVZUrIpZOZ0oqLjcVsN+k26jUM4KZCqtDz0TceQUKBLWquUdDWTlkPWZAN2TraWPkMM+unE3YpAQlZE5TBECAg9hA0lTQ5Qn8XCVgP0gAaQu+8CghS1Sw8sR5wMlG5YsXcWV7mBLU0skQ2lgD7zVlw3raqwADeZk0gCFY3MRC2WGM/zA1iEQbwi2qxC5w3u6mOBZQNq0ggtwXCqtE4DFNAhoHAsXmVY1QaSHoCjS36WHvxJieN1uAsM4CSGuxk625ZEXlpAs+NzqH+atbpc97y6yDaKOR8AHfmzlxysTQBuQC0MtOQ3pk9uF2X2Q1mQRGOv+37YTabPemDl9uYM0VVk4FHZx9xZdyMXbMJXy9eikQQ+jpcTC7RtyrHVRN+xuYwCg9XvCjzyIur1wH32OtdAHOUVjmagBssdnr24T20cDgYiWSj8/+Fw8P35z+/+e3yDetlbur6b38wGozi68IGqqXZMHXWl8rOm2+3hxePTP+f35IrziF8oKHTUkWmjmEuVix7K3qWHSeisoF4a7HIZMBrr5dL3v6jQc/cPU5EK71iDyJzJz1TMS1Pcc75zHN0zOGt1E1Hdzujaovvz95ciUTIhj3ZZMhpZMjVB2vvj8x8Q/c2dXYO8C+z+CcBP3AK3+H8x7V4d/JZwCq+XprzN14ul/8AL/4hhw==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Introduction",permalink:"/docs/API-docs/opensign-api-v-1"},next:{title:"Create Contact",permalink:"/docs/API-docs/createcontact"}},j={},g=[{value:"Request",id:"request",level:2}];function v(e){const s={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(s.p,{children:"Get your account details"})}),"\n",(0,i.jsx)(r(),{method:"get",path:"/getuser"}),"\n",(0,i.jsx)(s.p,{children:"The Get User API enables you to get your own account details."}),"\n",(0,i.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(t.Z,{children:[(0,i.jsxs)(p.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Successful operation"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Joe Bee"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4567832123"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"jobTitle",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"dev"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"company",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"opensign"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "objectId": "FGik23bhUJ",\n "name": "Joe Bee",\n "email": "joebee@example.com",\n "phone": "4567832123",\n "jobTitle": "dev",\n "company": "opensign",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(p.default,{label:"404",value:"404",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"User not found!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"User not found!"}})})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "error": "User not found!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(p.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/2304e9ae.0fd4454c.js b/assets/js/2304e9ae.4e6965bb.js similarity index 54% rename from assets/js/2304e9ae.0fd4454c.js rename to assets/js/2304e9ae.4e6965bb.js index 0fcc6f086..975c97c15 100644 --- a/assets/js/2304e9ae.0fd4454c.js +++ b/assets/js/2304e9ae.4e6965bb.js @@ -1 +1 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7964],{31898:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>j,contentTitle:()=>x,default:()=>y,frontMatter:()=>h,metadata:()=>u,toc:()=>f});var l=s(85893),r=s(11151),n=s(58219),i=(s(62316),s(51039)),d=s.n(i),t=(s(82723),s(9487)),o=(s(41429),s(5397)),c=s(4667),m=s(9472),p=s(85162);const h={id:"createfolder",title:"Create Folder",description:"The Create Folder API allows you to create folder.",sidebar_label:"Create Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJzNV+9u2zYQf5Urv2wFFNtJmw4ThmFZ13VZuyZYMhRYYgQn6SyxpkiWpOwYhr/tSfZoe5LhSCuxnTRYhqHYlyAm7+/v7n5HLUXA2ov8QvxoVEVOjDNRkS+dtEEaLXJx3hC8dISBIInA0ekxoFJm7mFhOggGynQ/ifcDkQljySEbOK5ELtJ1uhWZcPSxIx++N9VC5Msdd6fOzGRFUJAyc7DosKVA7o4XkYnS6EA6sA20Vskyehx+8GxoKXzZUIv8HzuUjipOM2lrbIlTDQtLIhem+EBlEJmwjiMPkjzrJdl3LJsve1kfnNS1yMTEuBbD5gldY2sVC2ma93GuMmHRkQ4JPQbkcbbEapWJIEP8kYxeFYzdii9ucwuuo3jgrdE+ZXAwGt2FONlYw1mB78qSvJ90Si2ePAbWh8FLx49P1zb7RXN98MEycv+PCvx8oNEfTuUpsa01bkfhPjO3Sgejg2d7+6O90Vfn+y/y51/nhy8Go9Hod5GJ61axbmzCXFQYot2+xP3vzlafwc9qVyyBVlFAqby403rcdatMPL+vsc5MS6GRuoY56QBzZ3SdgVWEniC4BWCNUoPCQO4/7DRyzriHQXpcZJsDJ7WSmq76qbp6Phpd7d+AcHgXhGM9QyWryJLnZkr682a66T4k93drLJNQvBdbyW6epyQ9lZ2TYSHyi6W43kMr99J9fjFejTPBwBpmeWt8jBhDI3Ix3CF9T25GzkcrO10zx7om91NXxKCPumDgF1NOU2adUyIXTQjW58PhTLqQLA18Umu6YlCadnjqkBnsHc6m6IbGkh7uD0aDkVhlyx0jHnVVmOsBC3lZa4WFjzbQyuFs/x4NtPYR0j5gLXW996DW+BbZM65+KvAWvjdlRivf0EJkffk2pTIhGcSGMA1nJripfr1dsa/61tjeZ5sEeZcfBXeF1BMTo1h3x4klfSZrHcs02xe7L4X3pErTEq/q0BD04n/98WfUqEzZtaRDbP0ncNI5sGZObtIpQF3BRNG1LBTd877whK0i79UCpA5UO34HVLKWARUwvDzZJVospJI8LCxmWNvBxrz5AbxvKDTk+OoLR4BQ0YwUzxgoY7jn2B92wbTRxzpmmBs3nXBIGSAUnZeavAdP1KuQblCXBH1RMzAOUAPpQM466QlQtiw8MQ5oMpGlZMPMDA7LAC1qrImdZcBxMwo2PYY8OFN0PoA3qouJsMeWKKQUNVHlB/CDnFFKnA8Tg1MFdccmMihNRbAmCk5DV1CQD2DZvSwpGvUBXQBFM3KxiWMlebDAGmYwiQrMZKu2bCg41J5XaAqoL80NfNYZfmNEHxUuBnCpLzWTMnSeuAGU1FOfX+o9uLhps/dUeBlo/GU/WPP5/M5APd3WeS1D0xXgyJpbvToexvHbVL/58VRkIpBr/cnkjNxMlrSe5k/4HEbh4ZrXsYy8Ti1KlYb1u10FniYlS9KeNlj46PXpW5jBs8Foi+f+QcDDt8cvX707e8V2mVXT/PV8F5m4Rb3hausBvzu4y9v19O9e+2uaCnQdhlahjDslJrRcr4OL7W+AcSYa3hb5hVguC/T0m1OrFR9/7MjxqhlnYoZOYsHMczFeZT3D8f6Y0oJzSkHvnbN3FlddIsud/coEnTSOypJseFB2c6Gdnpydi0wU6++U1lSs43DO3zA4F7m4FJcifu3EoYyfGny+FAp13WHN8skuEzN2DMUmq08jq6//4cz6K73YiHKb7lMq/JcTu1fhG67ZG1p8eyOebj6psMa2l+YCjler1d/Qj+OO",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,u={id:"API-docs/createfolder",title:"Create Folder",description:"The Create Folder API allows you to create folder.",source:"@site/docs/API-docs/createfolder.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createfolder",permalink:"/docs/API-docs/createfolder",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createfolder",title:"Create Folder",description:"The Create Folder API allows you to create folder.",sidebar_label:"Create Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJzNV+9u2zYQf5Urv2wFFNtJmw4ThmFZ13VZuyZYMhRYYgQn6SyxpkiWpOwYhr/tSfZoe5LhSCuxnTRYhqHYlyAm7+/v7n5HLUXA2ov8QvxoVEVOjDNRkS+dtEEaLXJx3hC8dISBIInA0ekxoFJm7mFhOggGynQ/ifcDkQljySEbOK5ELtJ1uhWZcPSxIx++N9VC5Msdd6fOzGRFUJAyc7DosKVA7o4XkYnS6EA6sA20Vskyehx+8GxoKXzZUIv8HzuUjipOM2lrbIlTDQtLIhem+EBlEJmwjiMPkjzrJdl3LJsve1kfnNS1yMTEuBbD5gldY2sVC2ma93GuMmHRkQ4JPQbkcbbEapWJIEP8kYxeFYzdii9ucwuuo3jgrdE+ZXAwGt2FONlYw1mB78qSvJ90Si2ePAbWh8FLx49P1zb7RXN98MEycv+PCvx8oNEfTuUpsa01bkfhPjO3Sgejg2d7+6O90Vfn+y/y51/nhy8Go9Hod5GJ61axbmzCXFQYot2+xP3vzlafwc9qVyyBVlFAqby403rcdatMPL+vsc5MS6GRuoY56QBzZ3SdgVWEniC4BWCNUoPCQO4/7DRyzriHQXpcZJsDJ7WSmq76qbp6Phpd7d+AcHgXhGM9QyWryJLnZkr682a66T4k93drLJNQvBdbyW6epyQ9lZ2TYSHyi6W43kMr99J9fjFejTPBwBpmeWt8jBhDI3Ix3CF9T25GzkcrO10zx7om91NXxKCPumDgF1NOU2adUyIXTQjW58PhTLqQLA18Umu6YlCadnjqkBnsHc6m6IbGkh7uD0aDkVhlyx0jHnVVmOsBC3lZa4WFjzbQyuFs/x4NtPYR0j5gLXW996DW+BbZM65+KvAWvjdlRivf0EJkffk2pTIhGcSGMA1nJripfr1dsa/61tjeZ5sEeZcfBXeF1BMTo1h3x4klfSZrHcs02xe7L4X3pErTEq/q0BD04n/98WfUqEzZtaRDbP0ncNI5sGZObtIpQF3BRNG1LBTd877whK0i79UCpA5UO34HVLKWARUwvDzZJVospJI8LCxmWNvBxrz5AbxvKDTk+OoLR4BQ0YwUzxgoY7jn2B92wbTRxzpmmBs3nXBIGSAUnZeavAdP1KuQblCXBH1RMzAOUAPpQM466QlQtiw8MQ5oMpGlZMPMDA7LAC1qrImdZcBxMwo2PYY8OFN0PoA3qouJsMeWKKQUNVHlB/CDnFFKnA8Tg1MFdccmMihNRbAmCk5DV1CQD2DZvSwpGvUBXQBFM3KxiWMlebDAGmYwiQrMZKu2bCg41J5XaAqoL80NfNYZfmNEHxUuBnCpLzWTMnSeuAGU1FOfX+o9uLhps/dUeBlo/GU/WPP5/M5APd3WeS1D0xXgyJpbvToexvHbVL/58VRkIpBr/cnkjNxMlrSe5k/4HEbh4ZrXsYy8Ti1KlYb1u10FniYlS9KeNlj46PXpW5jBs8Foi+f+QcDDt8cvX707e8V2mVXT/PV8F5m4Rb3hausBvzu4y9v19O9e+2uaCnQdhlahjDslJrRcr4OL7W+AcSYa3hb5hVguC/T0m1OrFR9/7MjxqhlnYoZOYsHMczFeZT3D8f6Y0oJzSkHvnbN3FlddIsud/coEnTSOypJseFB2c6Gdnpydi0wU6++U1lSs43DO3zA4F7m4FJcifu3EoYyfGny+FAp13WHN8skuEzN2DMUmq08jq6//4cz6K73YiHKb7lMq/JcTu1fhG67ZG1p8eyOebj6psMa2l+YCjler1d/Qj+OO",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete Webhook",permalink:"/docs/API-docs/delete-webhook"},next:{title:"Get Folder",permalink:"/docs/API-docs/getfolder"}},j={},f=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,r.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Create Folder"})}),"\n",(0,l.jsx)(d(),{method:"post",path:"/createfolder"}),"\n",(0,l.jsx)(a.p,{children:"The Create Folder API allows you to create folder."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsx)(t.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(a.p,{children:"Body"})}),(0,l.jsx)("strong",{className:"openapi-schema__required",children:(0,l.jsx)(a.p,{children:"required"})})]}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(a.p,{children:"Provide below parameter to create folder"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"folderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new folder"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"parentFolderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(p.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"folder created successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"folderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new folder"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"parentFolderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"J2nas5kiPe"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "objectId": "ph1bhx2jp",\n "folderName": "new folder",\n "parentFolderId": "J2nas5kiPe",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,r.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7964],{31898:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>u,contentTitle:()=>x,default:()=>y,frontMatter:()=>h,metadata:()=>j,toc:()=>f});var l=s(85893),r=s(11151),i=s(58219),t=(s(62316),s(51039)),n=s.n(t),d=(s(82723),s(9487)),o=(s(41429),s(5397)),m=s(4667),c=s(9472),p=s(85162);const h={id:"createfolder",title:"Create Folder",description:"The Create Folder API allows you to create folder.",sidebar_label:"Create Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJzNV9tuGzcQ/RVmXtoAa12cS9FFUdRN08BNEBu1iwCVBWN2d7RixCUZkitZEPTWL+mn9UuKIbW2Lo5RF0XQF0FLzvXMzJndFQSsPeQj+NmoihyMM6jIl07aII2GHC6nJF45wkAiiYiT81OBSpmFF0vTimBEme4n8b4HGRhLDtnAaQU5pOt0Cxk4+tSSDz+aagn5as/duTNzWZEoSJmFsOiwoUDuwAtkUBodSAe2gdYqWUaP/Y+eDa3Al1NqkP+xQ+mo4jSTtsaGONWwtAQ5mOIjlQEysI4jD5I86yXZ9yybrzpZH5zUNWQwMa7BsH1CN9hYxUKaFl2c6wwsOtIhoceAPM4WrNcZBBniQzJ6XTB2a764yy24luKBt0b7lMHxYHAIcbKxgbMSvi1L8n7SKrV88hhYHwYvHT8+XTsdFtOb44+Wkft/VOCXY43+xUyeE9va4HYS7jNzp3Q8OH52NBwcDb65HL7Mn3+bv3jZGwwGv0MGN41i3diEOVQYot2uxN1za6sv4Ge9L5ZAqyigVB4OWo+7bp3B8/sa68I0FKZS12JBOoiFM7rOhFWEnkRwS4E1Si0UBnL/YaeRc8Y9DNLjItseOKmV1HTdTdX188HgengLwotDEE71HJWsIktemhnpL5vptvuQ3B/WWCaheA87yW6fpyQ9la2TYQn5aAU3R2jlUbrPR+P1OAMG1jDLW+NjxBimkEN/j/Q9uTk5H620TkEO0xCsz/t9j7oqzE3PWNJe1lph4XulafpoZX8+hHW2r4HWPkLaB6ylro8e1BrfJXrBxUh476R7izpa+ZaWkHVobktlILkJpoRpVjLgGv96t/Fed5XaXS/bfHVIV8BFknpiYhSbYp1Z0hey1rHU8yHsL+4PpErTEG/OMCXRif/1x59RozJl25AOsROfiLPWCWsW5CatEqgrMVF0IwtF96x7T9go8l4thdSBasdruZK1DKgEw8uDVqLFQirJvctihrWd2Gp/3xMfphSm5PjqK0cCRUVzUtzyQhkzYzvBCGyDaaKPTcxiYdxswiFlAkXReqnJe+GJOhXSU9Qlia6omTBOoBakAznrpCeBsmHhiXGCJhNZSjbMg+qwDKJBjTWxs0xw3IyCTe8mXjhTtD4Ib1QbE2GPDVFIKWqiyvfET3JOKXE+TIRKlahbNpGJ0lQkNnPLaehKFOSDsOxelhSN+oAuCEVzcrGJYyV5UwtrmFAkKmEmO7VlQ8Gh9rzRUkBdaW7hs87wyo8+Klz2xJW+0syRovXEDaCknvn8Sh+J0W2bfaDCy0Djr7vBWiwWBwP1dFfnjQzTthCOrLnTq+NhHL9t9duHp5BBINf4s8kFubksaTPNn/HZj8L9Dc1iGWmWGpQqDesP+wo8TUqWpD1tkeLJm/N3Yi6e9QaQbVHIPwi4/+701ev3F6/ZLpNcmr9hb9AbxJcP40ODesvVzvv0/uCu7rbFv3v53tBUoJvQtwplpPiY0GrDzqPdV/JxBlMm73wEq1WBnn5zar3m408tOWb+cQZzdBILZp7ReJ11DMd0PqMl55SCPrpk7yyu2kSWe+uOCTppnJQl2fCg7PZ+OT+7uIQMis1nQ2Mq1nG44E8KXEAOV3AF8eMjDmV88+fzFSjUdYs1yye7TMzYMhTbrD6LrL75w5l1V3q5FeUu3adU+JcTu1fhO67ZW1p+fyuebj6rsMG2k+YCjtfr9d+wVLvj",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/createfolder",title:"Create Folder",description:"The Create Folder API allows you to create folder.",source:"@site/docs/API-docs/createfolder.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createfolder",permalink:"/docs/API-docs/createfolder",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createfolder",title:"Create Folder",description:"The Create Folder API allows you to create folder.",sidebar_label:"Create Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJzNV9tuGzcQ/RVmXtoAa12cS9FFUdRN08BNEBu1iwCVBWN2d7RixCUZkitZEPTWL+mn9UuKIbW2Lo5RF0XQF0FLzvXMzJndFQSsPeQj+NmoihyMM6jIl07aII2GHC6nJF45wkAiiYiT81OBSpmFF0vTimBEme4n8b4HGRhLDtnAaQU5pOt0Cxk4+tSSDz+aagn5as/duTNzWZEoSJmFsOiwoUDuwAtkUBodSAe2gdYqWUaP/Y+eDa3Al1NqkP+xQ+mo4jSTtsaGONWwtAQ5mOIjlQEysI4jD5I86yXZ9yybrzpZH5zUNWQwMa7BsH1CN9hYxUKaFl2c6wwsOtIhoceAPM4WrNcZBBniQzJ6XTB2a764yy24luKBt0b7lMHxYHAIcbKxgbMSvi1L8n7SKrV88hhYHwYvHT8+XTsdFtOb44+Wkft/VOCXY43+xUyeE9va4HYS7jNzp3Q8OH52NBwcDb65HL7Mn3+bv3jZGwwGv0MGN41i3diEOVQYot2uxN1za6sv4Ge9L5ZAqyigVB4OWo+7bp3B8/sa68I0FKZS12JBOoiFM7rOhFWEnkRwS4E1Si0UBnL/YaeRc8Y9DNLjItseOKmV1HTdTdX188HgengLwotDEE71HJWsIktemhnpL5vptvuQ3B/WWCaheA87yW6fpyQ9la2TYQn5aAU3R2jlUbrPR+P1OAMG1jDLW+NjxBimkEN/j/Q9uTk5H620TkEO0xCsz/t9j7oqzE3PWNJe1lph4XulafpoZX8+hHW2r4HWPkLaB6ylro8e1BrfJXrBxUh476R7izpa+ZaWkHVobktlILkJpoRpVjLgGv96t/Fed5XaXS/bfHVIV8BFknpiYhSbYp1Z0hey1rHU8yHsL+4PpErTEG/OMCXRif/1x59RozJl25AOsROfiLPWCWsW5CatEqgrMVF0IwtF96x7T9go8l4thdSBasdruZK1DKgEw8uDVqLFQirJvctihrWd2Gp/3xMfphSm5PjqK0cCRUVzUtzyQhkzYzvBCGyDaaKPTcxiYdxswiFlAkXReqnJe+GJOhXSU9Qlia6omTBOoBakAznrpCeBsmHhiXGCJhNZSjbMg+qwDKJBjTWxs0xw3IyCTe8mXjhTtD4Ib1QbE2GPDVFIKWqiyvfET3JOKXE+TIRKlahbNpGJ0lQkNnPLaehKFOSDsOxelhSN+oAuCEVzcrGJYyV5UwtrmFAkKmEmO7VlQ8Gh9rzRUkBdaW7hs87wyo8+Klz2xJW+0syRovXEDaCknvn8Sh+J0W2bfaDCy0Djr7vBWiwWBwP1dFfnjQzTthCOrLnTq+NhHL9t9duHp5BBINf4s8kFubksaTPNn/HZj8L9Dc1iGWmWGpQqDesP+wo8TUqWpD1tkeLJm/N3Yi6e9QaQbVHIPwi4/+701ev3F6/ZLpNcmr9hb9AbxJcP40ODesvVzvv0/uCu7rbFv3v53tBUoJvQtwplpPiY0GrDzqPdV/JxBlMm73wEq1WBnn5zar3m408tOWb+cQZzdBILZp7ReJ11DMd0PqMl55SCPrpk7yyu2kSWe+uOCTppnJQl2fCg7PZ+OT+7uIQMis1nQ2Mq1nG44E8KXEAOV3AF8eMjDmV88+fzFSjUdYs1yye7TMzYMhTbrD6LrL75w5l1V3q5FeUu3adU+JcTu1fhO67ZW1p+fyuebj6rsMG2k+YCjtfr9d+wVLvj",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete Webhook",permalink:"/docs/API-docs/delete-webhook"},next:{title:"Get Folder",permalink:"/docs/API-docs/getfolder"}},u={},f=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,r.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Create Folder"})}),"\n",(0,l.jsx)(n(),{method:"post",path:"/createfolder"}),"\n",(0,l.jsx)(a.p,{children:"The Create Folder API allows you to create folder."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(a.p,{children:"Body"})}),(0,l.jsx)("strong",{className:"openapi-schema__required",children:(0,l.jsx)(a.p,{children:"required"})})]}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(a.p,{children:"Provide below parameter to create folder"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"folderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new folder"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"parentFolderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(p.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"folder created successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"folderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new folder"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"parentFolderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"J2nas5kiPe"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "objectId": "ph1bhx2jp",\n "folderName": "new folder",\n "parentFolderId": "J2nas5kiPe",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,r.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/28b19cd2.339692dc.js b/assets/js/28b19cd2.339692dc.js deleted file mode 100644 index 65f0fc287..000000000 --- a/assets/js/28b19cd2.339692dc.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6033],{99442:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>b,contentTitle:()=>g,default:()=>v,frontMatter:()=>u,metadata:()=>f,toc:()=>j});var i=s(85893),t=s(11151),n=s(58219),l=(s(62316),s(51039)),r=s.n(l),o=(s(82723),s(9487)),m=s(41429),d=s(5397),c=s(4667),p=s(9472),h=s(85162);const u={id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztWd1u28YSfpXJ3jgJaMl2knMhFAdNnaA12lMbsYNc2IawJIfi2stddn8ks4Lu+iR9tD5JMbskRf3YcYCD3pwDBEm0mpmdnd9vRkvm+MyyyTX7oDNfoXKW3SYsR5sZUTuhFZuwqxLh1CB3CB0VvL84Ay6lXlhotAenYYYKDdEoXEDeSYO0gTtvHdRGz0Uu1AwcVrXkDqciB6GsQ56DLsDXUvNAwIOIQkh8KRS4EqHQpiKalFv811vQBlKhuGleAc7RNOBEhUEPhZiTMllUl/eKjOCqvdaSNDBYE0UuG/AW83CbhYwrSLHlzqEwuqKvDQjl0BQ8Q+AOrl+//oCpn8Hns9evb1+WztV2Mh7zuh7pGpUVMyV5akeZrsY5EdZ58YqU9ja8f23OTicy5+hGsYTpmowotDrL2YS1irRvWAhXdsYTOUtYzQ2v0KEhDy6Z4hWyCRvYlyVMkAdr7kq27Vad3mHmzoLxO0VYwgz+5oXBnE2c8Zgw6xpJYq2oakkE+FBLnSObFFxaIshKrDibLJlr6kDpjFAzljByG3fDE3zgQcqE1T8dp2V2UtYpW61u47Vo3Q86b0hUppVD5ei/vK6lyIJRxneWVF8O7lyre83I8mSM26RTJb6RTGXIsk6gDewt4VpnbgxvyFwOq+H5IwKMpkfsvnj9vvdZpr1TXDm2ShhWXMgnTRQIhgLuNH7ffqJIIinRwU/deqcRUkQirkutvkJ9fPKG/rw5ZqtVwpxw4XQz6AbRNL1szUbUhZY5GorSp24gRSyqfLptgFRriVztBOVVKSz0cb1VYmyNmSgaWJToSjTheMGVgyDdEkmKYKk+EXXUdgRUv3IsuJcO5lx6BGHhhlF437ARnBUhJeM3mj5sqDCgBa5yUBoOwn1T60NwHIzbz6nOm4M1pwVusNVZYN6rEIj7KmhhIaQkvakOxSLQ24+u7aKnu26fwTdteOqt0xWEa1qmUPPIINx5g9Am2whOuQKhMulzbAstGZyqFCyXXQhMQ2SsVrBcki/RTCkQV6tkfUB3bRyE6IsnBjMU8w2u/gjXjP3ZgBUfamGaac5de5DpquaqGSogZkqo2dQbuVqNdoJv7Zln223HTK3HSMj/gMVInTN1bnI0z8jXswIshnQ7oGA9SEAr2UTLCGNdm4UxyFuFw7ePWVko4QSXshnBxz6rrU8tUalO3jprnBGzGRrMoaUIzAlQswTkWRnrQdCKF5TQdHttcC60t516JbdAlpJIfd+VKGK6CDUbwQ9Nl7sJDKxDlWHj7aM9qUvI5EqftqI/8GbYXJSvUjQ7Ng1ohkBMywU5byzdFpAKfcFl5gNuiO4GcjeVrkZ700OeYXfpb+r1O35H2aF4KvH86uIZnqYHwWGsjjocRh9EGXB+dQFzNKJoW/UIPtveT53j+QYJZDpHmAseXZ/AohRZSdZvoCLMiCr4K5by4Lc1nAvgAw5hV6Fc2L0aJbGbUKr6oNo+wZALg5mTTQgg7R3wPBfEziVYh7Xd8HLQojfklfbPyZmvWJLDzIs8eNqbvnCjsckARBNwNj4jZgu5Nx2wbIOWKDO0dm2nzipENJCfACob2TkU3Do0CXgV8K7xNWVDJxIfajQCVYb7TRCb1Lrcfb3gEhXh4pj5OvbhGo3Vio61mXElfo+xoqOfUiy5LIg2BgtBgNBmUeWdDUjaZl3rYPlff/xJJS7EwbTSeR8b9vluu0BTCWf7QuQ0hQigxDjwWJ+VwO26wNmkK2o2Aet4VduEnufwwYVn6Zregw/COnrCQuQzdBbEYyH/Ccme2UCHMKhQoJIbVTOM2V4vp7fEBaglbDwdwqM97n0UHk6H+DC02RURbw4R4cDWWtmInk+OjuifrU6iyHQUtNARR4BHqTFDB95Qd1h/KYre+1zaDu8RSZ/MmmDiQliM9Z+kdFNPAhVaa/mMRppnTxtPTwWd7G+dhco7cfL7QzY/uaDo9ObpSWGfgHYE3ZoX6IX0wG+U1g/5oXO2Tim8lM2LjUFBKCkUTjuHTE+OjqYn5P9Vwt7udXH0WMnnqA5CZe2DnZB1F80U+N1grA0o3W0PsCfhUodMcWXbrGkgC5whBv9rHkVjtPlW+11I5JZKkvP1+iVR8Nds+PboaJplvRHf7cuTOZciDxuYK32P6sU/8Nz144bXu3g9qfpQhaBtVxAiEoXv2cZrh+fxkRYzb4Rrwgrj4ZDX4jB+P7m+pcVAha7UtAyptQ0a0y5jwsabdWi8HBSiFSOxZt4tRjYNeLnghBh/8ml4xHvvNPxHZ/fxpSH7+oSaC+OipJGNbKVPw2LnwnBKiV/5/J6bMTWY8fHoaHTEVslyS4jlKk/1w+5yiNdiPD/ew7F3lfQotXV8JtTs8Emu27WlLykaosM37L1ehtTiZ6Qsat05pGo3SiVyGhDIgRRkn9bbm49dqAzWLNfdxmS4Fum3Ijurjv7ibp3RbzOGK4vb4RKCsc1FQ9xdbQ3OjG0OhB1TP+5Ern2Y/fjdBlpuV19D2Ncd7cKgDfjxCProUJRQhQ6eaDPmvEZFa5cQqvPjHVDyBWWm47hAfbwj/+uPPwNHlx7hmhdw7g3UeoGm8DKU3ELigyBYuLvPtcgridbKJmw/Z2G3m4uZcISEW0yY8ZqnQgoqIESm4wgyqEF2BF/W65oDE5ayOEdJdQek1vcBtmng3ukq3NG1n4U29wWplACHlJanBA4sYseCquQqo0obAzvAKq7i3FAb6vtcVERMKBqLQmSCBFO1NDxzUHHFZwEfJUB6kxXaVmPB6JSGEKuljzDbaagQXXwibZrtCD7QWBMeHkYvdFxIzCPCtkmccNrQpmeoHFIM23CeOZFhHEIcNw4krbJDIsfp2UsJtXZxoiWAOPQtCXKGKxs243Hsa13Tm68dAcIdOW9GcKNu1CUFi7dIASCFureTG3UI132YfcHUCofrrfZisdgpKq82eX4UrvQprdT1mm8WDkMJGrL3H16xhDk0lT0vLtHMRdbhmEfuHAficdvreNyDdQWE1+L7bQbqO1JkqCwOOtP7Hy9+gTm8GR1t1PpnKDz+5ez046+XH0kudZaYf13ND92p4mpw1fZPJgGkDxbtG4k82Hj///eWf/D3lrbj0Sw2riUXaoDAI9K43pp4WMImw59YbhNWEjKZXLPlkgz2mfZqdPybR0Ow5jZhc24EtYoIR+Ionvc949FIePmpnaNewSO/1uzVv2vjinp4GOlir7vHZuv3odXtKul6OakWKU6jAodXJGctYQdZEhSJHO+zDGv3JO0Qyl2cX16xhHVr2Sr8nMQMX9DvT3zBJuyG3bDwc1g/nYfzJZNczXwYaliUSxCEe/LUEL/cB/zS/odettcmm8AmPoX+poftZfiO8vBnbP7dk8dvHmVobdtRk39uV6vV31HxemA=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},g=void 0,f={id:"API-docs/createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",source:"@site/docs/API-docs/createdocumentwithtemplateid.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createdocumentwithtemplateid",permalink:"/docs/API-docs/createdocumentwithtemplateid",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztWd1u28YSfpXJ3jgJaMl2knMhFAdNnaA12lMbsYNc2IawJIfi2stddn8ks4Lu+iR9tD5JMbskRf3YcYCD3pwDBEm0mpmdnd9vRkvm+MyyyTX7oDNfoXKW3SYsR5sZUTuhFZuwqxLh1CB3CB0VvL84Ay6lXlhotAenYYYKDdEoXEDeSYO0gTtvHdRGz0Uu1AwcVrXkDqciB6GsQ56DLsDXUvNAwIOIQkh8KRS4EqHQpiKalFv811vQBlKhuGleAc7RNOBEhUEPhZiTMllUl/eKjOCqvdaSNDBYE0UuG/AW83CbhYwrSLHlzqEwuqKvDQjl0BQ8Q+AOrl+//oCpn8Hns9evb1+WztV2Mh7zuh7pGpUVMyV5akeZrsY5EdZ58YqU9ja8f23OTicy5+hGsYTpmowotDrL2YS1irRvWAhXdsYTOUtYzQ2v0KEhDy6Z4hWyCRvYlyVMkAdr7kq27Vad3mHmzoLxO0VYwgz+5oXBnE2c8Zgw6xpJYq2oakkE+FBLnSObFFxaIshKrDibLJlr6kDpjFAzljByG3fDE3zgQcqE1T8dp2V2UtYpW61u47Vo3Q86b0hUppVD5ei/vK6lyIJRxneWVF8O7lyre83I8mSM26RTJb6RTGXIsk6gDewt4VpnbgxvyFwOq+H5IwKMpkfsvnj9vvdZpr1TXDm2ShhWXMgnTRQIhgLuNH7ffqJIIinRwU/deqcRUkQirkutvkJ9fPKG/rw5ZqtVwpxw4XQz6AbRNL1szUbUhZY5GorSp24gRSyqfLptgFRriVztBOVVKSz0cb1VYmyNmSgaWJToSjTheMGVgyDdEkmKYKk+EXXUdgRUv3IsuJcO5lx6BGHhhlF437ARnBUhJeM3mj5sqDCgBa5yUBoOwn1T60NwHIzbz6nOm4M1pwVusNVZYN6rEIj7KmhhIaQkvakOxSLQ24+u7aKnu26fwTdteOqt0xWEa1qmUPPIINx5g9Am2whOuQKhMulzbAstGZyqFCyXXQhMQ2SsVrBcki/RTCkQV6tkfUB3bRyE6IsnBjMU8w2u/gjXjP3ZgBUfamGaac5de5DpquaqGSogZkqo2dQbuVqNdoJv7Zln223HTK3HSMj/gMVInTN1bnI0z8jXswIshnQ7oGA9SEAr2UTLCGNdm4UxyFuFw7ePWVko4QSXshnBxz6rrU8tUalO3jprnBGzGRrMoaUIzAlQswTkWRnrQdCKF5TQdHttcC60t516JbdAlpJIfd+VKGK6CDUbwQ9Nl7sJDKxDlWHj7aM9qUvI5EqftqI/8GbYXJSvUjQ7Ng1ohkBMywU5byzdFpAKfcFl5gNuiO4GcjeVrkZ700OeYXfpb+r1O35H2aF4KvH86uIZnqYHwWGsjjocRh9EGXB+dQFzNKJoW/UIPtveT53j+QYJZDpHmAseXZ/AohRZSdZvoCLMiCr4K5by4Lc1nAvgAw5hV6Fc2L0aJbGbUKr6oNo+wZALg5mTTQgg7R3wPBfEziVYh7Xd8HLQojfklfbPyZmvWJLDzIs8eNqbvnCjsckARBNwNj4jZgu5Nx2wbIOWKDO0dm2nzipENJCfACob2TkU3Do0CXgV8K7xNWVDJxIfajQCVYb7TRCb1Lrcfb3gEhXh4pj5OvbhGo3Vio61mXElfo+xoqOfUiy5LIg2BgtBgNBmUeWdDUjaZl3rYPlff/xJJS7EwbTSeR8b9vluu0BTCWf7QuQ0hQigxDjwWJ+VwO26wNmkK2o2Aet4VduEnufwwYVn6Zregw/COnrCQuQzdBbEYyH/Ccme2UCHMKhQoJIbVTOM2V4vp7fEBaglbDwdwqM97n0UHk6H+DC02RURbw4R4cDWWtmInk+OjuifrU6iyHQUtNARR4BHqTFDB95Qd1h/KYre+1zaDu8RSZ/MmmDiQliM9Z+kdFNPAhVaa/mMRppnTxtPTwWd7G+dhco7cfL7QzY/uaDo9ObpSWGfgHYE3ZoX6IX0wG+U1g/5oXO2Tim8lM2LjUFBKCkUTjuHTE+OjqYn5P9Vwt7udXH0WMnnqA5CZe2DnZB1F80U+N1grA0o3W0PsCfhUodMcWXbrGkgC5whBv9rHkVjtPlW+11I5JZKkvP1+iVR8Nds+PboaJplvRHf7cuTOZciDxuYK32P6sU/8Nz144bXu3g9qfpQhaBtVxAiEoXv2cZrh+fxkRYzb4Rrwgrj4ZDX4jB+P7m+pcVAha7UtAyptQ0a0y5jwsabdWi8HBSiFSOxZt4tRjYNeLnghBh/8ml4xHvvNPxHZ/fxpSH7+oSaC+OipJGNbKVPw2LnwnBKiV/5/J6bMTWY8fHoaHTEVslyS4jlKk/1w+5yiNdiPD/ew7F3lfQotXV8JtTs8Emu27WlLykaosM37L1ehtTiZ6Qsat05pGo3SiVyGhDIgRRkn9bbm49dqAzWLNfdxmS4Fum3Ijurjv7ibp3RbzOGK4vb4RKCsc1FQ9xdbQ3OjG0OhB1TP+5Ern2Y/fjdBlpuV19D2Ncd7cKgDfjxCProUJRQhQ6eaDPmvEZFa5cQqvPjHVDyBWWm47hAfbwj/+uPPwNHlx7hmhdw7g3UeoGm8DKU3ELigyBYuLvPtcgridbKJmw/Z2G3m4uZcISEW0yY8ZqnQgoqIESm4wgyqEF2BF/W65oDE5ayOEdJdQek1vcBtmng3ukq3NG1n4U29wWplACHlJanBA4sYseCquQqo0obAzvAKq7i3FAb6vtcVERMKBqLQmSCBFO1NDxzUHHFZwEfJUB6kxXaVmPB6JSGEKuljzDbaagQXXwibZrtCD7QWBMeHkYvdFxIzCPCtkmccNrQpmeoHFIM23CeOZFhHEIcNw4krbJDIsfp2UsJtXZxoiWAOPQtCXKGKxs243Hsa13Tm68dAcIdOW9GcKNu1CUFi7dIASCFureTG3UI132YfcHUCofrrfZisdgpKq82eX4UrvQprdT1mm8WDkMJGrL3H16xhDk0lT0vLtHMRdbhmEfuHAficdvreNyDdQWE1+L7bQbqO1JkqCwOOtP7Hy9+gTm8GR1t1PpnKDz+5ez046+XH0kudZaYf13ND92p4mpw1fZPJgGkDxbtG4k82Hj///eWf/D3lrbj0Sw2riUXaoDAI9K43pp4WMImw59YbhNWEjKZXLPlkgz2mfZqdPybR0Ow5jZhc24EtYoIR+Ionvc949FIePmpnaNewSO/1uzVv2vjinp4GOlir7vHZuv3odXtKul6OakWKU6jAodXJGctYQdZEhSJHO+zDGv3JO0Qyl2cX16xhHVr2Sr8nMQMX9DvT3zBJuyG3bDwc1g/nYfzJZNczXwYaliUSxCEe/LUEL/cB/zS/odettcmm8AmPoX+poftZfiO8vBnbP7dk8dvHmVobdtRk39uV6vV31HxemA=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Document",permalink:"/docs/API-docs/createdocument"},next:{title:"Get Document",permalink:"/docs/API-docs/getdocument"}},b={},j=[{value:"Request",id:"request",level:2}];function x(e){const a={a:"a",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(a.p,{children:"Create Document from Template"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/createdocument/{template_id}"}),"\n",(0,i.jsxs)(a.p,{children:["The Create Document API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at ",(0,i.jsx)(a.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(a.strong,{children:"Debug UI"})})," or using the Create Template API."]}),"\n",(0,i.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,i.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(a.p,{children:"Path Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsx)("ul",{children:(0,i.jsx)(m.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"objectId of Template",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(a.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(a.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(a.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(a.p,{children:"object[]"})}),(0,i.jsx)("span",{className:"openapi-schema__divider"}),(0,i.jsx)("span",{className:"openapi-schema__required",children:(0,i.jsx)(a.p,{children:"required"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(a.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Accoutnant"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"mail",qualifierMessage:void 0,schema:{type:"string",format:"mail",example:"joe@example.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"123123131"}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(a.p,{children:"]"})})})]})]})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"send_email",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used.\n",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"timeToCompleteDays",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_sender_name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"name or email of the person or organization on the behalf of which you are sending the mail.",example:"opensign\u2122"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(n.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"In success response you will get url in response if you are also signer in document otherwise only get objectId, messsage"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://example.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Document sent successfully!"}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://example.com",\n "message": "Document sent successfully!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"If you haven't add widgets and signers in template or not provide signers along with their roles in body"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please setup template properly!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Please setup template properly!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,i.jsx)(a,{...e,children:(0,i.jsx)(x,{...e})}):x(e)}}}]); \ No newline at end of file diff --git a/assets/js/28b19cd2.5f8c6828.js b/assets/js/28b19cd2.5f8c6828.js new file mode 100644 index 000000000..9b2ad15e1 --- /dev/null +++ b/assets/js/28b19cd2.5f8c6828.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6033],{99442:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>g,toc:()=>j});var i=a(85893),t=a(11151),r=a(58219),l=(a(62316),a(51039)),n=a.n(l),o=(a(82723),a(9487)),m=a(41429),c=a(5397),d=a(4667),p=a(9472),h=a(85162);const u={id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztWc1u20gSfpVKXxwHtGQ7yR6ExWIyTjBrzGBsxA5ysA2hSRbFtpvdnP6RzBF0myeZR5snWVQ3SVE/dhxgMZddIEiiVnV1/ddXpSVzfGbZ5IZ91JmvUDnL7hKWo82MqJ3Qik3YdYlwZpA7hI4KPlyeA5dSLyw02oPTMEOFhmgULiDvuEHawL23Dmqj5yIXagYOq1pyh1ORg1DWIc9BF+BrqXkg4IFFISS+FgpciVBoUxFNyi3+4x1oA6lQ3DSHgHM0DThRYZBDIeYkTBbF5b0gI7hun7XEDQzWRJHLBrzFPLxmIeMKUmxv51AYXdHXBoRyaAqeIXAHN2/efMTUz+DL+Zs3d69L52o7GY95XY90jcqKmZI8taNMV+OcCOu8OCShvQ36r83ZyUTmHN0qljBdkxGFVuc5m7BWkFaHhXBlZzyRs4TV3PAKHRry4JIpXiGbsIF9WcIEebDmrmTbbtXpPWbuPBi/E4QlzOBvXhjM2cQZjwmzrpHE1oqqlkSAj7XUObJJwaUlgqzEirPJkrmmDpTOCDVjCSO3cTc8wUceuExY/e+TtMxOyzplq9VdfBat+1HnDbHKtHKoHP2X17UUWTDK+N6S6MvBm2txbxhZnoxxl3SiRB3JVIYs6wTacL0lXMvMjeENmcthNTx/goHRpMSuxmv9PmSZ9k5x5dgqYVhxIZ81USAYMrjX+EP7iSKJuEQHP/fqvUZIEYm4LrX6BvXJ6Vv68/aErVYJc8KF082gG0TT9Ko1G1EXWuZoKEqfe4EEsajy6bYBUq0lcrUTlNelsNDH9VaJsTVmomhgUaIr0YTjBVcOAndLJCmCpfpE1FHaEVD9yrHgXjqYc+kRhIVbRuF9y0ZwXoSUjN9o+rAhwoAWuMpBaTgI702tD8FxMG4/pzpvDtY3LXCDrcwC816EQNxXQQsLISXJTXUoFoHefvRsFz3dc/sMvmnDM2+driA8014KNY8Mwp03CG2yjeCMKxAqkz7HttCSwalKwXLZhcA0RMZqBcsl+RLNlAJxtUrWB/TWxkGIvnhiMEMx37jVH+H6Yn82uIqPtTDNNOeuPch0VXPVDAUQMyXUbOqNXK1GO8G39syL7bZjptZjxOR/wGIkzrm6MDmaF+TreQEWQ7odULAeJKCVbKJlhLGuzcIY5K3A4dunrCyUcIJL2YzgU5/V1qeWqFTHb501zojZDA3m0FKEywlQswTkWRnrQZCKF5TQ9HptcC60t514JbdAlpJIfd+VKGK6CDUbwY9Nl7sJDKxDlWFD99Ge1CVkcq3PWtYfeTNsLspXKZodmwY0QyCmvQU5byy9FpAKfcFl5gNuiO4GcjeVrkZ700OeYXfpX+rlO3lP2aF4KvHi+vIFniaF4ChWRx0Oow8iD7i4voQ5GlG0rXoEX2zvp87xfIMEMp0jzAWPrk9gUYqsJOs3UBFmRBX8FUt58NsazgXwAUewK1Au7F6JkthNKFV9EG0fY8iFwczJJgSQ9g54ngu6ziVYh7Xd8HKQojfktfYvyZlvWJLDzIs8eNqbvnCjsckARBNwNj6jyxZybzpg2QYtUWZo7dpOnVWIaMA/AVQ2XudQcOvQJOBVwLvG15QNHUt8rNEIVBnuN0FsUuty9+2CS1SEi2Pm69iHazRWKzrWZsaV+D3Gio5+SrHksiDaGCwEAUKbRZV3NiBum3Wtg+V//fEnlbgQB9NK531s2Je77RJNJZztC5HTFCKAEuPAY31WArfrAmeTrqjZBKzjVW0TUs/howtq6Zr0wUdhHamwEPkMnQXxVMh/RrJnNpAhDCoUqORG1QxjtpfL6S12AWoJG0+H8GiPe5+Eh9MhPgxtdkXEm0NEOLC1Vjai59PjY/pnq5MoMh0FLXTEEeBRaszQgTfUHdZfiqL3Ppe2w3tE0iezJpi4EBZj/Scu3dSTQIXWWj6jkebF08bzU0HH+3tnofJenP7+mM1PLyk6vXl+UtjHoB1Bt+YF0pAU/E5u/ZAfOmfrlMJL2bzaGBSEkkLhtHPI9PT4eHpK/l8l7N1eF0ePlXyO6iBU1j7YCVl30UyB3w3G2oDS3fYAexIudcgUV7bNmgaycDPE4H/No2iMNt9rv0uJ3FJJcr5eaxIZf8uG746Pp1nWG/H9vjyZcynysIG51g+oXv0N6q6VGz7v4vMk6mMVgrZdQYhIFL5nG9oOz6OSFjNvhGvCCuPxiNfiKH4/ubmjxUCFrtS0DKm1DRLTLmPCxpt1aLwcFKIVI7Zm3i1GQkb1SWK5ylP9uLur4bUYz0/YKtm+sXez8yS1dXwm1Ozo2Vt3a8WvyDnR/hvqr3cTtfgZKahb6w6p2gVPiZzwOtmTfP55vUz51HlusPW46RYYwy1Fv6TY2Tz0D3fbhX65MNwg3A13Aoxtzv1xlbQ1xzK2OZ91l/rpI97aB6FP3m+A13YTNURh3dEuKtlAA0+AgQ7UCFXo4Ik2gC9qVLQFCeE/P9nBCF9RZjqid2qrHflff/wZbnTRGp55BRfeQK0XaAovQwUsJD4KQmm761WLvJJorWzCMnIWVq25mAlHwLSFaBmveSqkoHwmMh0ngkFJsCP4ut6eHJiwI8U5SioDILV+CChKA/dOV+GNrhsstHkoSKQEOKS0y6RebRG7K6hKrjIqfDGwA8rhKsL42lAb5qIiYgK1WBQiE8SYipfhmYOKKz4LcCUBkpus0FZ+C0anNBNYLX1EvU5DheiiirT4tSP4SFNGUDxMQui4kJhHwGuTOHC0oU1qqBxSDMtpnjmRYZwJHDcOJG2WQyLHYdZLCbV2ccAkvDb0LTFyhisbFtVxCmtd05uvReThjZw3I7hVt+qKgsVbpACQQj3Yya06gps+zL5iaoXD9ZJ5sVjsFJXDzTs/CVf6lDbcen1vFg5DCRpe7z8csoQ5NJW9KK7QzEXWwYon3hwH4nHbenhcS3UFhNfih+0L1AakyFBZHDSKDz9d/gJzeDs6ZsmgjL5A4PEv52effr36RHyp0Mf8Oxkdj47D9lNbV3E1eGr7F4yAmQd7741EHiyg///zx9/480fb8Wg0GteSCzUAxLHx32wNICxhk+EvHncJKwkoTG7YckkG+0JrLjr+zaMhlHGXsDk3glpFaIXtZJz3PePJSHj9uR1rDuGJH0/2yt+1cUU9PExYsdc9YLP1c83qbpV0vZxEixRnUYCja+Kz5rAD9AiKxBsfsgxr9yztEFldXlxds4R1W9Iq/LrDDF/Qz0F8wSbslt2y8OtUPyyH8yWTXM18mDFY5EsQhHvy1BC/PAT80v6HNNtrk01gE1Whv0mxvRf+SXn4Mzb/6snjN09eaG3bUZN/7lar1X8ARXhStQ==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,g={id:"API-docs/createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",source:"@site/docs/API-docs/createdocumentwithtemplateid.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createdocumentwithtemplateid",permalink:"/docs/API-docs/createdocumentwithtemplateid",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztWc1u20gSfpVKXxwHtGQ7yR6ExWIyTjBrzGBsxA5ysA2hSRbFtpvdnP6RzBF0myeZR5snWVQ3SVE/dhxgMZddIEiiVnV1/ddXpSVzfGbZ5IZ91JmvUDnL7hKWo82MqJ3Qik3YdYlwZpA7hI4KPlyeA5dSLyw02oPTMEOFhmgULiDvuEHawL23Dmqj5yIXagYOq1pyh1ORg1DWIc9BF+BrqXkg4IFFISS+FgpciVBoUxFNyi3+4x1oA6lQ3DSHgHM0DThRYZBDIeYkTBbF5b0gI7hun7XEDQzWRJHLBrzFPLxmIeMKUmxv51AYXdHXBoRyaAqeIXAHN2/efMTUz+DL+Zs3d69L52o7GY95XY90jcqKmZI8taNMV+OcCOu8OCShvQ36r83ZyUTmHN0qljBdkxGFVuc5m7BWkFaHhXBlZzyRs4TV3PAKHRry4JIpXiGbsIF9WcIEebDmrmTbbtXpPWbuPBi/E4QlzOBvXhjM2cQZjwmzrpHE1oqqlkSAj7XUObJJwaUlgqzEirPJkrmmDpTOCDVjCSO3cTc8wUceuExY/e+TtMxOyzplq9VdfBat+1HnDbHKtHKoHP2X17UUWTDK+N6S6MvBm2txbxhZnoxxl3SiRB3JVIYs6wTacL0lXMvMjeENmcthNTx/goHRpMSuxmv9PmSZ9k5x5dgqYVhxIZ81USAYMrjX+EP7iSKJuEQHP/fqvUZIEYm4LrX6BvXJ6Vv68/aErVYJc8KF082gG0TT9Ko1G1EXWuZoKEqfe4EEsajy6bYBUq0lcrUTlNelsNDH9VaJsTVmomhgUaIr0YTjBVcOAndLJCmCpfpE1FHaEVD9yrHgXjqYc+kRhIVbRuF9y0ZwXoSUjN9o+rAhwoAWuMpBaTgI702tD8FxMG4/pzpvDtY3LXCDrcwC816EQNxXQQsLISXJTXUoFoHefvRsFz3dc/sMvmnDM2+driA8014KNY8Mwp03CG2yjeCMKxAqkz7HttCSwalKwXLZhcA0RMZqBcsl+RLNlAJxtUrWB/TWxkGIvnhiMEMx37jVH+H6Yn82uIqPtTDNNOeuPch0VXPVDAUQMyXUbOqNXK1GO8G39syL7bZjptZjxOR/wGIkzrm6MDmaF+TreQEWQ7odULAeJKCVbKJlhLGuzcIY5K3A4dunrCyUcIJL2YzgU5/V1qeWqFTHb501zojZDA3m0FKEywlQswTkWRnrQZCKF5TQ9HptcC60t514JbdAlpJIfd+VKGK6CDUbwY9Nl7sJDKxDlWFD99Ge1CVkcq3PWtYfeTNsLspXKZodmwY0QyCmvQU5byy9FpAKfcFl5gNuiO4GcjeVrkZ700OeYXfpX+rlO3lP2aF4KvHi+vIFniaF4ChWRx0Oow8iD7i4voQ5GlG0rXoEX2zvp87xfIMEMp0jzAWPrk9gUYqsJOs3UBFmRBX8FUt58NsazgXwAUewK1Au7F6JkthNKFV9EG0fY8iFwczJJgSQ9g54ngu6ziVYh7Xd8HKQojfktfYvyZlvWJLDzIs8eNqbvnCjsckARBNwNj6jyxZybzpg2QYtUWZo7dpOnVWIaMA/AVQ2XudQcOvQJOBVwLvG15QNHUt8rNEIVBnuN0FsUuty9+2CS1SEi2Pm69iHazRWKzrWZsaV+D3Gio5+SrHksiDaGCwEAUKbRZV3NiBum3Wtg+V//fEnlbgQB9NK531s2Je77RJNJZztC5HTFCKAEuPAY31WArfrAmeTrqjZBKzjVW0TUs/howtq6Zr0wUdhHamwEPkMnQXxVMh/RrJnNpAhDCoUqORG1QxjtpfL6S12AWoJG0+H8GiPe5+Eh9MhPgxtdkXEm0NEOLC1Vjai59PjY/pnq5MoMh0FLXTEEeBRaszQgTfUHdZfiqL3Ppe2w3tE0iezJpi4EBZj/Scu3dSTQIXWWj6jkebF08bzU0HH+3tnofJenP7+mM1PLyk6vXl+UtjHoB1Bt+YF0pAU/E5u/ZAfOmfrlMJL2bzaGBSEkkLhtHPI9PT4eHpK/l8l7N1eF0ePlXyO6iBU1j7YCVl30UyB3w3G2oDS3fYAexIudcgUV7bNmgaycDPE4H/No2iMNt9rv0uJ3FJJcr5eaxIZf8uG746Pp1nWG/H9vjyZcynysIG51g+oXv0N6q6VGz7v4vMk6mMVgrZdQYhIFL5nG9oOz6OSFjNvhGvCCuPxiNfiKH4/ubmjxUCFrtS0DKm1DRLTLmPCxpt1aLwcFKIVI7Zm3i1GQkb1SWK5ylP9uLur4bUYz0/YKtm+sXez8yS1dXwm1Ozo2Vt3a8WvyDnR/hvqr3cTtfgZKahb6w6p2gVPiZzwOtmTfP55vUz51HlusPW46RYYwy1Fv6TY2Tz0D3fbhX65MNwg3A13Aoxtzv1xlbQ1xzK2OZ91l/rpI97aB6FP3m+A13YTNURh3dEuKtlAA0+AgQ7UCFXo4Ik2gC9qVLQFCeE/P9nBCF9RZjqid2qrHflff/wZbnTRGp55BRfeQK0XaAovQwUsJD4KQmm761WLvJJorWzCMnIWVq25mAlHwLSFaBmveSqkoHwmMh0ngkFJsCP4ut6eHJiwI8U5SioDILV+CChKA/dOV+GNrhsstHkoSKQEOKS0y6RebRG7K6hKrjIqfDGwA8rhKsL42lAb5qIiYgK1WBQiE8SYipfhmYOKKz4LcCUBkpus0FZ+C0anNBNYLX1EvU5DheiiirT4tSP4SFNGUDxMQui4kJhHwGuTOHC0oU1qqBxSDMtpnjmRYZwJHDcOJG2WQyLHYdZLCbV2ccAkvDb0LTFyhisbFtVxCmtd05uvReThjZw3I7hVt+qKgsVbpACQQj3Yya06gps+zL5iaoXD9ZJ5sVjsFJXDzTs/CVf6lDbcen1vFg5DCRpe7z8csoQ5NJW9KK7QzEXWwYon3hwH4nHbenhcS3UFhNfih+0L1AakyFBZHDSKDz9d/gJzeDs6ZsmgjL5A4PEv52effr36RHyp0Mf8Oxkdj47D9lNbV3E1eGr7F4yAmQd7741EHiyg///zx9/480fb8Wg0GteSCzUAxLHx32wNICxhk+EvHncJKwkoTG7YckkG+0JrLjr+zaMhlHGXsDk3glpFaIXtZJz3PePJSHj9uR1rDuGJH0/2yt+1cUU9PExYsdc9YLP1c83qbpV0vZxEixRnUYCja+Kz5rAD9AiKxBsfsgxr9yztEFldXlxds4R1W9Iq/LrDDF/Qz0F8wSbslt2y8OtUPyyH8yWTXM18mDFY5EsQhHvy1BC/PAT80v6HNNtrk01gE1Whv0mxvRf+SXn4Mzb/6snjN09eaG3bUZN/7lar1X8ARXhStQ==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Document",permalink:"/docs/API-docs/createdocument"},next:{title:"Get Document",permalink:"/docs/API-docs/getdocument"}},f={},j=[{value:"Request",id:"request",level:2}];function y(e){const s={a:"a",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(s.p,{children:"Create Document from Template"})}),"\n",(0,i.jsx)(n(),{method:"post",path:"/createdocument/{template_id}"}),"\n",(0,i.jsxs)(s.p,{children:["The Create Document API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at ",(0,i.jsx)(s.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(s.strong,{children:"Debug UI"})})," or using the Create Template API."]}),"\n",(0,i.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,i.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(s.p,{children:"Path Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsx)("ul",{children:(0,i.jsx)(m.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"objectId of Template",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(s.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(s.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"object[]"})}),(0,i.jsx)("span",{className:"openapi-schema__divider"}),(0,i.jsx)("span",{className:"openapi-schema__required",children:(0,i.jsx)(s.p,{children:"required"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Accoutnant"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"mail",qualifierMessage:void 0,schema:{type:"string",format:"mail",example:"joe@example.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"123123131"}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"send_email",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used.\n",example:!0}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"timeToCompleteDays",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"email_sender_name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"name or email of the person or organization on the behalf of which you are sending the mail.",example:"opensign\u2122"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(r.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"In success response you will get url in response if you are also signer in document otherwise only get objectId, messsage"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://example.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Document sent successfully!"}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://example.com",\n "message": "Document sent successfully!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"If you haven't add widgets and signers in template or not provide signers along with their roles in body"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please setup template properly!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "error": "Please setup template properly!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,t.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/2c586be5.27d9bbd6.js b/assets/js/2c586be5.b14fac44.js similarity index 72% rename from assets/js/2c586be5.27d9bbd6.js rename to assets/js/2c586be5.b14fac44.js index b60ca1feb..73061daca 100644 --- a/assets/js/2c586be5.27d9bbd6.js +++ b/assets/js/2c586be5.b14fac44.js @@ -1 +1 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9697],{45212:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>j,contentTitle:()=>u,default:()=>y,frontMatter:()=>p,metadata:()=>x,toc:()=>g});var i=s(85893),a=s(11151),t=s(58219),l=(s(62316),s(51039)),r=s.n(l),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),m=s(9472),h=s(85162);const p={id:"createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file.",sidebar_label:"Create Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztO+1yGzeSr9I7fxyrRpRIy45XdXW1jp3b1W1iqWK5UluSSgFnmiSsGWACYEQxKv7bJ9lH2ye56gYwHxQpyXEqq9TRPywO0AAaje5Gf+E2cWJqk8Oz5J3O6hKVs8lFmuRoMyMrJ7VKDpPTGcJbg8IhRCh4c3IEoij03EJt0VhwGqao0BCUwjnkcT4YL6Ay+lrmUk0hF07AXLoZjIXFVweAKtM55jCRBQ7O1bk6ldUhfKwKLXJY6NrAybv/aWajZajtbGfnHY7rKXw82tm5+GrmXGUP9/ZEVQ10hcrKqSrE2A4yXe7lBFjlk+cpzGdokGaFTChAYWWxAJHnMJf5FJ1Nwc1QQaarBWRam1wq4dCmUIkpgqrLMRqbglA5lNogSAUCDIp8sev0bm0R/vfD8XuYaFMKN4CTorZps1wuDWauWPjp3QybXT2zkRrWGammKZTiiqglHfxcy+yKtm1R5fSXBr45OWJa7ex8qKtKG4c5/Oi3cLizQz3fYKHnIAwyfKbLUiuohBElOj6umXDcbfDnWhrM/aGIooi0ODxXu7Cz4xYVHu7swJHKZUbE4AmpFfQkwA48KBGJQD9UmMmJDKAd0oFWMJ/JbMY0mQt/nlUhMo+mQVth5uQ19ie+SWFBE79DpSMGM23kL1o5UfBxXKNxMhNF99gIQQK1ThhH5Ky0VC62hhXgH+F46PT4UAJfEWo5EauUinsswrUoarQBq3kKM8LqB6wMWmb1MC8RUuUwQzmdbVxP5J9q63oTQ20JzS4WYa14SkxeZLJNRGER5KRHy1JcYWc10CzDohjANwvIcSLqwqUgieOcqXEA77UDUVWFzMS4QOJcIOERrja4y6cc2CEgokTJZ3zCEo0WBORyMkFDwkmdPEUYE7EjPmtVAEuOmwkFWq0cdKYLbWj6FR7i9j4hIdPKoXIDeHMtZMHY+91akCor6hxhXIjsKoVxUWMKBnMvuQskvZUGLUQgIGwgOhMILBbEhlrRBpQOy0sLNmCVD+B0Jm0rUNQZac2LSNslaxDbiaaViQZRxgBLIYuUKZfCJz0GJ12BKUlsJdQiJYWJKTi8cWN9k0I2w+yKfxmRSw3j2jmt/MZyo6tcz1Ug5kQrZ+Uva0Qy9nw+RUcpHKTwKoXXKQz3UxiOUhgepDB8lcLwdQqj/RRGoxRGBymMXnm0Rq8DrUVD4C4Cw5GnsvvjUJcU73fSsmiTxrSNEp73lPC5Gg5gZ6cRKG7+6aefztXtuQI4T0jAzpPD86QBOU9S8H2kN8+Tw2EKoeHmPDmEF6OvI8CCvl8Rdf33nL6HdBr+e0bfo+G5WoZFR4yME2V1DyLU/dsjET8DP1Ejr0xtUbdRIyklD0s9dG7U2qBFHct2Qy9oQ1JJJ0VhN+8pQjy9bbWYrezsgHbG3Lt5W9z99PYU0Yo9rDx9FyvbTldUA4zIaIUELwftdbOBAn7Rp0aAgNWX7v8V7b/RWZuJ0IA8PUp0UftScnw9YPuA9fZmYgSAp0eKFrEvJcRrIgTdW5upQL1PjwQBq9gRbAHft3+wO3y5O9ofHfTIQG6UByjL3TzfXSwWX0hCYIKReRTWZ2szWLPeCCQPdmJ0ucZVYU+ihQrmE/+O5v33ZNSPo72LOfmI7IRE46bxDrsWudO5WDyzfqo4tLHjCL614hYdNLmL8GBPOZtpmQXkCSZab2NyBgdEhF0ifL73/fd7HVL6xt2yjPSF2Erfu0z6bmtZDvJ8sArbO6FOawl5nsKa9vUdeQ5lWW5q9x10XZ6rP5MgBNNtsywEgN9HHNZwfbv+RllpO0SuVcHrs3e3XlZW7peZVKEj8A2sABic1oUweENuqpVaMV1+A020IkVRiFozn71adgg5ZuApAV8dB1P+eWBw2kF/Amp5eNydjXUnMTjFG54jq63TJSEjc0EzpGDrbEZOn4geA5G9je/wVyYqSdGFAp3jVnTZYB0S/tA6njkd6qpjbtH1NiMsxJFrfHM+fXY0hvt87wW/5J6LL0A8PbXfwSx2+mgHdZ+dJ6UIpksywfa3djM058lFM8b75Jh3xsK6wXBxjzxBKzQ5FmKMxV1Ze7Q0dLcTOKtDHOoopWpCCYzyfsSAe8XNSm/oXK6RM7/tLoNH5R7FJNIZCmljPKVPtO7oEHDiMKBC5MjiGCEOoKBtlOIvZfkGsUfwfFQI4XQeWIHggAGbWF9c7B6hohV6J9OlC81RSiXLumyClpNm1kixMlzyXXLRSAqFxxW6p3tnBXHzwAoUIdy8wLkacmQhxiRYL8B6WzCAPD3F0MHs4Rvw16iM3q35a++7zxfEuK+uIK65JgnUX5CNENrNUjiAY7qUKGLqB1EILMuwchQu+1IRbVB+3LU05EhSN0S2+WLqQv3ePLiJmR7DnSt4/2Z8GOC+zPYiqj2OGbvb+AMxZA/tR9tKPh5Y+jTUpmBgyaz31JRhQGvl5k/SRFeUU5VaHeXJYZJxGjbmDZOU50brvtH5Ijm8TUIIn36GADkN3ftkKZF7m9hshqWgXxEnSv1S6jVJOQaNxiZpwjEbygMT1ZLDRI8/YUarVYbQcRItzcHjDm8jlM9dJmnw25PDxCc1kzTBG1FWBJysZH2rfJIs44L3TdW0tFNZ/tEkUWkeSg/+ymne01BGpcRT/VZTo8N3YmE7E/r7OllNkNMY4t4sjIJcLCwJRG29ZZWJIqsL8tjxppJm0YQP2G3vHGeDaLNSg+jw5bI9oxYlYYxYJGkiHZbd9g1nZvTnEzpDTZThwO7njv2kcYz4l9BA+Xg+J1F+NhafNMIY+YyqmVafPX44ejEcDV8MRzRDyNP8ejr63rsY9BnjDfmXmEdre7fNrabAKY3BQ8wZ4XnbYooPM+Ppppx7J9NnZ7oucsqhoTADTn3/6qqKPn83l8jgAW5epsnNw5u5gUzvxoQ+fFXgxEFdVWgg00ahed6N1D2ZzY0ODpZpsnh4e4s/5Pa+psObP7y7H7kSoq0S+U/g+uL1Mk1mD+P6t6ZW4z+I7MGrZXsZrtz1l2OdLy6j3lo+BBgvCoKb6CJHQ/bDXX3VqhrSMFRjdLmq58daFyjUGkXTy9GHajCy5siQC6Hq+QzJHG6NPJ69tSuD2eexpbw/rkQPpSXrzdR4ngzgaNKxUtnjXy0TiLCcslcanvF6l7ZmNf5sL3wTjZ5166GoRKUN0UcUGBgcllXBBUVzWRSEN93rA2j+saHWUJIQiNdlXPjhq+Ktj1LygmFQvxoHgqk3gLdCNQUZ/cIHuL1t2IC5Y7mE21s6VTSXdOkul2nbQGv1Gvhe9S0GM5TXvVFNE7YDm7bOUG/iXJKJ4xtC7quLgJwqqaaXtSmWy8EdNmzP6NF0u0OmcHY0yf8DihE6R+rY5GgeIblHE+9oaXhGzPosRLyZMtJYF+TRs3tA2CexNlA51DGQf/ZtI9+2HluCUnG+Vn6ckdMpUtVhgODBoUwIRTbzmoGxEhMSba4kNHgtdW0jejNhG5M7JwjpxUWqad9P7FCHq7i6ex+sE11FdUXHpyePoCV7sbteE3nnz+/SzwHHpydUmygnwRUbwEfbUCKSVvRAgFwjuJYili815tvCBx5RMUW82uwVkg5CVeAu3EUol3YtRmmbBWkqee9M3Bav0hHp2lHVrAwVWdZhZXt0ZCwaQp7q+jFc+QAlBUxrTqg6upWjauTMTFtbKJV1pvZBV8hrE8spA1sQZIbWtnSKVCGgzvwpoLJ+uICJsA5NCrWSRHlTU4yjmRJvKjQSVYZrSWDQk44k92Ft1q/T+/jDd6FkOe4hCuWYJNBPjDnUFXMNS0JTQBpPbnXrG7RtR+U9jCYXemoTpD+E3is0Vitq1mYqlPzFc7P2nDTGmSgmbGA1aXW+dFHlEWearY9ftLD+/c9/EarMqZelzhvutY9nrBMq5XW2UUZOc+k3Fujr1GNSsFFyNo2KzQZ3jXKDhnN4vC1d0X7wRlrXKTuMGf+7QvkDEj2zDg5s3pMoEaOpRVeqGrxCeWM7HRtesl+y2piXKwx4v5no7cg2FhT0H9Vha2W9pzva36c/fZI27wDCpEQ84q5JXRSLPyXp4wNR97vZvnm96Xqf3zz7JEe/3GTXoxNimw2id+8EwcyvTUGl/XReu80JcBSjQ1mpCqnwMpLtcrS/fzkk2i7T5GAd+T7oEt2MeYaIODeaiv6rAgUVoZsFiKmQCsjoNL8hNdEYbe73Aj4Ps/uIcNAjwsu7RDhSnDjlpySn+grV77vT7vLOL0+o3pTMK14PJtIDcX/S22y33W/SYlYb6RbJ4dltcrMrKrnr+w/PLpYXaUKE1RTErbRljIWbJYfJ3p2YrkVzzUG+szt8MxdkN/2tHjPab2qn4XudXfm9MZs3nHstjfMzDawfNqvH7KWeGEFy+l5cXwmzRyp2bzjYH+wny/R2ZRIrVE7Z1Duerqjk3vVwzYi1fvFGaOvEVKrp7r2jLlrafqDz90fco3Abxqvk35HieOEAu1BpIomIMxRkJtOREVv90EbQv43MEWPb68LVLROsBqBj/LkXUl4fUR6+7MRyz2JYliOtTaB1Xey02VeMhjbB0E58sxPePGsloIkkxkDikCNwo4MDDlV9PeSYzovXHC45eLVknm1DB0nSDw9wImPVyU2SvvMWBzWuSRjV2tc+MdczFENT33BqZ+4ZKj0DYYN9EC0xqSaaOSUc33GF6gMZuiRK18O74SssMl02zwsi+L//+S8eEY+dl/kTHNcGKj1HM6n9G4VJgTeSTMvOU7kYHEFRFmhtsQCyKKf8aC6XU643ivZaJioxloUklUZg2icLOlrRDuDHNrzyzPjSq2ssSBNCoTW/ISMzp3a65DXitT3X5mpCKKUgYEzPjtCSY4RxCKqZUBmZZ17w2PChN3NkAVdGWgQhSwImSxwnE5lJtge0ckZkDkqhxJQtmJTDaESFKj4aMnpMjozVRe1NdXq6hOj8FjnzOIB35BrxxjlJgk7IAnNvpdvUe0lBNsKbvDF5pBUtLzO0bcFmgddoWNF4H7cuCqi0834nmXDds6WJnBHKknkQEjThaBryBVua18jFYgCUfqSrk1woYoBCqiv/gu6sYbMfcWylwzaEOJ/P7yi95/0xf5VuVo/BYKXbcVNuZBXZHd58PCelg6a0x5MPaK5lFg2aDWvuMfBeuH2Fj1ZFJSQq+ZfVAXQTFjJDZbFzV77568l3cA0vBvu9u+gRCO99d/T22/cfvqV56ebz8hfvJL4vS6E6S628Rl0V3U4edPt4dft4dft4dft4dft49Y/zvHL7eHX7eHX7eHX7eHX7eHX7eHX7ePUJkGL7eHX7eHX7eHX7eHX7eHX7eHX7eHX7eHX7eHX7eHX7eHX7ePVpvBXcPl7dPl59Ugy5fbwaH6+G2hOyG/eqQkjVqcbz5U9nq09aL9JkRvVRh2fJ7S0lFj9SxTs1/1yjoeKqizS5FkZS9JxLq9JY0UPVLldIZSdvfTJg95TWTz3fcy57paKMCpL8iDd8+vfCdku4To4/nCZpEp8olDqnMUbM6UmumCeHCSltfr7bVKly+21SCDWtuQAn8fNSIZKo3axfxXTFVUzhR6eOR6hFB8t+eZPfCv1PG1s74L8o9/13XPx3A+57Ng4ItI3QdIQXy+Xy/wCBgs6d",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file.",source:"@site/docs/API-docs/createdocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createdocument",permalink:"/docs/API-docs/createdocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file.",sidebar_label:"Create Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztO+1yGzeSr9I7fxyrRpRIy45XdXW1jp3b1W1iqWK5UluSSgFnmiSsGWACYEQxKv7bJ9lH2ye56gYwHxQpyXEqq9TRPywO0AAaje5Gf+E2cWJqk8Oz5J3O6hKVs8lFmuRoMyMrJ7VKDpPTGcJbg8IhRCh4c3IEoij03EJt0VhwGqao0BCUwjnkcT4YL6Ay+lrmUk0hF07AXLoZjIXFVweAKtM55jCRBQ7O1bk6ldUhfKwKLXJY6NrAybv/aWajZajtbGfnHY7rKXw82tm5+GrmXGUP9/ZEVQ10hcrKqSrE2A4yXe7lBFjlk+cpzGdokGaFTChAYWWxAJHnMJf5FJ1Nwc1QQaarBWRam1wq4dCmUIkpgqrLMRqbglA5lNogSAUCDIp8sev0bm0R/vfD8XuYaFMKN4CTorZps1wuDWauWPjp3QybXT2zkRrWGammKZTiiqglHfxcy+yKtm1R5fSXBr45OWJa7ex8qKtKG4c5/Oi3cLizQz3fYKHnIAwyfKbLUiuohBElOj6umXDcbfDnWhrM/aGIooi0ODxXu7Cz4xYVHu7swJHKZUbE4AmpFfQkwA48KBGJQD9UmMmJDKAd0oFWMJ/JbMY0mQt/nlUhMo+mQVth5uQ19ie+SWFBE79DpSMGM23kL1o5UfBxXKNxMhNF99gIQQK1ThhH5Ky0VC62hhXgH+F46PT4UAJfEWo5EauUinsswrUoarQBq3kKM8LqB6wMWmb1MC8RUuUwQzmdbVxP5J9q63oTQ20JzS4WYa14SkxeZLJNRGER5KRHy1JcYWc10CzDohjANwvIcSLqwqUgieOcqXEA77UDUVWFzMS4QOJcIOERrja4y6cc2CEgokTJZ3zCEo0WBORyMkFDwkmdPEUYE7EjPmtVAEuOmwkFWq0cdKYLbWj6FR7i9j4hIdPKoXIDeHMtZMHY+91akCor6hxhXIjsKoVxUWMKBnMvuQskvZUGLUQgIGwgOhMILBbEhlrRBpQOy0sLNmCVD+B0Jm0rUNQZac2LSNslaxDbiaaViQZRxgBLIYuUKZfCJz0GJ12BKUlsJdQiJYWJKTi8cWN9k0I2w+yKfxmRSw3j2jmt/MZyo6tcz1Ug5kQrZ+Uva0Qy9nw+RUcpHKTwKoXXKQz3UxiOUhgepDB8lcLwdQqj/RRGoxRGBymMXnm0Rq8DrUVD4C4Cw5GnsvvjUJcU73fSsmiTxrSNEp73lPC5Gg5gZ6cRKG7+6aefztXtuQI4T0jAzpPD86QBOU9S8H2kN8+Tw2EKoeHmPDmEF6OvI8CCvl8Rdf33nL6HdBr+e0bfo+G5WoZFR4yME2V1DyLU/dsjET8DP1Ejr0xtUbdRIyklD0s9dG7U2qBFHct2Qy9oQ1JJJ0VhN+8pQjy9bbWYrezsgHbG3Lt5W9z99PYU0Yo9rDx9FyvbTldUA4zIaIUELwftdbOBAn7Rp0aAgNWX7v8V7b/RWZuJ0IA8PUp0UftScnw9YPuA9fZmYgSAp0eKFrEvJcRrIgTdW5upQL1PjwQBq9gRbAHft3+wO3y5O9ofHfTIQG6UByjL3TzfXSwWX0hCYIKReRTWZ2szWLPeCCQPdmJ0ucZVYU+ihQrmE/+O5v33ZNSPo72LOfmI7IRE46bxDrsWudO5WDyzfqo4tLHjCL614hYdNLmL8GBPOZtpmQXkCSZab2NyBgdEhF0ifL73/fd7HVL6xt2yjPSF2Erfu0z6bmtZDvJ8sArbO6FOawl5nsKa9vUdeQ5lWW5q9x10XZ6rP5MgBNNtsywEgN9HHNZwfbv+RllpO0SuVcHrs3e3XlZW7peZVKEj8A2sABic1oUweENuqpVaMV1+A020IkVRiFozn71adgg5ZuApAV8dB1P+eWBw2kF/Amp5eNydjXUnMTjFG54jq63TJSEjc0EzpGDrbEZOn4geA5G9je/wVyYqSdGFAp3jVnTZYB0S/tA6njkd6qpjbtH1NiMsxJFrfHM+fXY0hvt87wW/5J6LL0A8PbXfwSx2+mgHdZ+dJ6UIpksywfa3djM058lFM8b75Jh3xsK6wXBxjzxBKzQ5FmKMxV1Ze7Q0dLcTOKtDHOoopWpCCYzyfsSAe8XNSm/oXK6RM7/tLoNH5R7FJNIZCmljPKVPtO7oEHDiMKBC5MjiGCEOoKBtlOIvZfkGsUfwfFQI4XQeWIHggAGbWF9c7B6hohV6J9OlC81RSiXLumyClpNm1kixMlzyXXLRSAqFxxW6p3tnBXHzwAoUIdy8wLkacmQhxiRYL8B6WzCAPD3F0MHs4Rvw16iM3q35a++7zxfEuK+uIK65JgnUX5CNENrNUjiAY7qUKGLqB1EILMuwchQu+1IRbVB+3LU05EhSN0S2+WLqQv3ePLiJmR7DnSt4/2Z8GOC+zPYiqj2OGbvb+AMxZA/tR9tKPh5Y+jTUpmBgyaz31JRhQGvl5k/SRFeUU5VaHeXJYZJxGjbmDZOU50brvtH5Ijm8TUIIn36GADkN3ftkKZF7m9hshqWgXxEnSv1S6jVJOQaNxiZpwjEbygMT1ZLDRI8/YUarVYbQcRItzcHjDm8jlM9dJmnw25PDxCc1kzTBG1FWBJysZH2rfJIs44L3TdW0tFNZ/tEkUWkeSg/+ymne01BGpcRT/VZTo8N3YmE7E/r7OllNkNMY4t4sjIJcLCwJRG29ZZWJIqsL8tjxppJm0YQP2G3vHGeDaLNSg+jw5bI9oxYlYYxYJGkiHZbd9g1nZvTnEzpDTZThwO7njv2kcYz4l9BA+Xg+J1F+NhafNMIY+YyqmVafPX44ejEcDV8MRzRDyNP8ejr63rsY9BnjDfmXmEdre7fNrabAKY3BQ8wZ4XnbYooPM+Ppppx7J9NnZ7oucsqhoTADTn3/6qqKPn83l8jgAW5epsnNw5u5gUzvxoQ+fFXgxEFdVWgg00ahed6N1D2ZzY0ODpZpsnh4e4s/5Pa+psObP7y7H7kSoq0S+U/g+uL1Mk1mD+P6t6ZW4z+I7MGrZXsZrtz1l2OdLy6j3lo+BBgvCoKb6CJHQ/bDXX3VqhrSMFRjdLmq58daFyjUGkXTy9GHajCy5siQC6Hq+QzJHG6NPJ69tSuD2eexpbw/rkQPpSXrzdR4ngzgaNKxUtnjXy0TiLCcslcanvF6l7ZmNf5sL3wTjZ5166GoRKUN0UcUGBgcllXBBUVzWRSEN93rA2j+saHWUJIQiNdlXPjhq+Ktj1LygmFQvxoHgqk3gLdCNQUZ/cIHuL1t2IC5Y7mE21s6VTSXdOkul2nbQGv1Gvhe9S0GM5TXvVFNE7YDm7bOUG/iXJKJ4xtC7quLgJwqqaaXtSmWy8EdNmzP6NF0u0OmcHY0yf8DihE6R+rY5GgeIblHE+9oaXhGzPosRLyZMtJYF+TRs3tA2CexNlA51DGQf/ZtI9+2HluCUnG+Vn6ckdMpUtVhgODBoUwIRTbzmoGxEhMSba4kNHgtdW0jejNhG5M7JwjpxUWqad9P7FCHq7i6ex+sE11FdUXHpyePoCV7sbteE3nnz+/SzwHHpydUmygnwRUbwEfbUCKSVvRAgFwjuJYili815tvCBx5RMUW82uwVkg5CVeAu3EUol3YtRmmbBWkqee9M3Bav0hHp2lHVrAwVWdZhZXt0ZCwaQp7q+jFc+QAlBUxrTqg6upWjauTMTFtbKJV1pvZBV8hrE8spA1sQZIbWtnSKVCGgzvwpoLJ+uICJsA5NCrWSRHlTU4yjmRJvKjQSVYZrSWDQk44k92Ft1q/T+/jDd6FkOe4hCuWYJNBPjDnUFXMNS0JTQBpPbnXrG7RtR+U9jCYXemoTpD+E3is0Vitq1mYqlPzFc7P2nDTGmSgmbGA1aXW+dFHlEWearY9ftLD+/c9/EarMqZelzhvutY9nrBMq5XW2UUZOc+k3Fujr1GNSsFFyNo2KzQZ3jXKDhnN4vC1d0X7wRlrXKTuMGf+7QvkDEj2zDg5s3pMoEaOpRVeqGrxCeWM7HRtesl+y2piXKwx4v5no7cg2FhT0H9Vha2W9pzva36c/fZI27wDCpEQ84q5JXRSLPyXp4wNR97vZvnm96Xqf3zz7JEe/3GTXoxNimw2id+8EwcyvTUGl/XReu80JcBSjQ1mpCqnwMpLtcrS/fzkk2i7T5GAd+T7oEt2MeYaIODeaiv6rAgUVoZsFiKmQCsjoNL8hNdEYbe73Aj4Ps/uIcNAjwsu7RDhSnDjlpySn+grV77vT7vLOL0+o3pTMK14PJtIDcX/S22y33W/SYlYb6RbJ4dltcrMrKrnr+w/PLpYXaUKE1RTErbRljIWbJYfJ3p2YrkVzzUG+szt8MxdkN/2tHjPab2qn4XudXfm9MZs3nHstjfMzDawfNqvH7KWeGEFy+l5cXwmzRyp2bzjYH+wny/R2ZRIrVE7Z1Duerqjk3vVwzYi1fvFGaOvEVKrp7r2jLlrafqDz90fco3Abxqvk35HieOEAu1BpIomIMxRkJtOREVv90EbQv43MEWPb68LVLROsBqBj/LkXUl4fUR6+7MRyz2JYliOtTaB1Xey02VeMhjbB0E58sxPePGsloIkkxkDikCNwo4MDDlV9PeSYzovXHC45eLVknm1DB0nSDw9wImPVyU2SvvMWBzWuSRjV2tc+MdczFENT33BqZ+4ZKj0DYYN9EC0xqSaaOSUc33GF6gMZuiRK18O74SssMl02zwsi+L//+S8eEY+dl/kTHNcGKj1HM6n9G4VJgTeSTMvOU7kYHEFRFmhtsQCyKKf8aC6XU643ivZaJioxloUklUZg2icLOlrRDuDHNrzyzPjSq2ssSBNCoTW/ISMzp3a65DXitT3X5mpCKKUgYEzPjtCSY4RxCKqZUBmZZ17w2PChN3NkAVdGWgQhSwImSxwnE5lJtge0ckZkDkqhxJQtmJTDaESFKj4aMnpMjozVRe1NdXq6hOj8FjnzOIB35BrxxjlJgk7IAnNvpdvUe0lBNsKbvDF5pBUtLzO0bcFmgddoWNF4H7cuCqi0834nmXDds6WJnBHKknkQEjThaBryBVua18jFYgCUfqSrk1woYoBCqiv/gu6sYbMfcWylwzaEOJ/P7yi95/0xf5VuVo/BYKXbcVNuZBXZHd58PCelg6a0x5MPaK5lFg2aDWvuMfBeuH2Fj1ZFJSQq+ZfVAXQTFjJDZbFzV77568l3cA0vBvu9u+gRCO99d/T22/cfvqV56ebz8hfvJL4vS6E6S628Rl0V3U4edPt4dft4dft4dft4dft49Y/zvHL7eHX7eHX7eHX7eHX7eHX7eHX7ePUJkGL7eHX7eHX7eHX7eHX7eHX7eHX7eHX7eHX7eHX7eHX7eHX7ePVpvBXcPl7dPl59Ugy5fbwaH6+G2hOyG/eqQkjVqcbz5U9nq09aL9JkRvVRh2fJ7S0lFj9SxTs1/1yjoeKqizS5FkZS9JxLq9JY0UPVLldIZSdvfTJg95TWTz3fcy57paKMCpL8iDd8+vfCdku4To4/nCZpEp8olDqnMUbM6UmumCeHCSltfr7bVKly+21SCDWtuQAn8fNSIZKo3axfxXTFVUzhR6eOR6hFB8t+eZPfCv1PG1s74L8o9/13XPx3A+57Ng4ItI3QdIQXy+Xy/wCBgs6d",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Draft Document",permalink:"/docs/API-docs/draftdocument"},next:{title:"Create Document from Template",permalink:"/docs/API-docs/createdocumentwithtemplateid"}},j={},g=[{value:"Request",id:"request",level:2}];function f(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(n.p,{children:"Create Document"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/createdocument"}),"\n",(0,i.jsx)(n.p,{children:"The Create Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"name", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job title:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"job title", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"company", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"date", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": { \n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression":"",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0, \n "maxselections": 0 \n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"dropdown", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"radio button", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "readonly": false,\n "required": true, \n "name": "radio button",\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(n.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded pdf"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Note"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"timeToCompleteDays",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})}),(0,i.jsx)("span",{className:"openapi-schema__divider"}),(0,i.jsx)("span",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"send_email",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"redirect_url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_sender_name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"name or email of the person or organization on the behalf of which you are sending the mail.",example:"opensign\u2122"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(t.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Document created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://url-to-sign-document.com"}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://url-to-sign-document.com"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9697],{45212:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>j,contentTitle:()=>u,default:()=>y,frontMatter:()=>p,metadata:()=>x,toc:()=>g});var i=s(85893),a=s(11151),t=s(58219),l=(s(62316),s(51039)),r=s.n(l),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),m=s(9472),h=s(85162);const p={id:"createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file.",sidebar_label:"Create Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztO+1yGzeSr9I7fxyrRpRIy45XdXW1jp3b1W0SqWK5UluSSgFnmiSsGWACYEQxKv7bJ9lH2ye56gYwHxQpyXYqq9TRPywO0AAaje5Gf+E2cWJqk8Oz5J3O6hKVs8lFmuRoMyMrJ7VKDpPTGcJbg8IhRCh4c3IEoij03EJt0VhwGqao0BCUwjnkcT4YL6Ay+lrmUk0hF07AXLoZjIXFVweAKtM55jCRBQ7O1bk6ldUhfKgKLXJY6NrAybv/aWajZajtbGfnHY7rKXw42tm5+GrmXGUP9/ZEVQ10hcrKqSrE2A4yXe7lBFjlk+cpzGdokGaFTChAYWWxAJHnMJf5FJ1Nwc1QQaarBWRam1wq4dCmUIkpgqrLMRqbglA5lNogSAUCDIp8sev0bm0R/vf98Q8w0aYUbgAnRW3TZrlcGsxcsfDTuxk2u3pmIzWsM1JNUyjFFVFLOvilltkVbduiyukvDXxzcsS02tl5X1eVNg5z+Mlv4XBnh3q+wULPQRhk+EyXpVZQCSNKdHxcM+G42+AvtTSY+0MRRRFpcXiudmFnxy0qPNzZgSOVy4yIwRNSK+hJgB14UCISgb6vMJMTGUA7pAOtYD6T2YxpMhf+PKtCZB5Ng7bCzMlr7E98k8KCJn6HSkcMZtrIX7VyouDjuEbjZCaK7rERggRqnTCOyFlpqVxsDSvAP8Lx0OnxoQS+ItRyIlYpFfdYhGtR1GgDVvMUZoTVj1gZtMzqYV4ipMphhnI627ieyD/W1vUmhtoSml0swlrxlJi8yGSbiMIiyEmPlqW4ws5qoFmGRTGAbxaQ40TUhUtBEsc5U+MAftAORFUVMhPjAolzgYRHuNrgLp9yYIeAiBIln/EJSzRaEJDLyQQNCSd18hRhTMSO+KxVASw5biYUaLVy0JkutKHpV3iI2/uEhEwrh8oN4M21kAVj73drQaqsqHOEcSGyqxTGRY0pGMy95C6Q9FYatBCBgLCB6EwgsFgQG2pFG1A6LC8t2IBVPoDTmbStQFFnpDUvIm2XrEFsJ5pWJhpEGQMshSxSplwKH/UYnHQFpiSxlVCLlBQmpuDwxo31TQrZDLMr/mVELjWMa+e08hvLja5yPVeBmBOtnJW/rhHJ2PPpFB2lcJDCqxRepzDcT2E4SmF4kMLwVQrD1ymM9lMYjVIYHaQweuXRGr0OtBYNgbsIDEeeyu6PQ11SvN9Jy6JNGtM2SnjeU8LnajiAnZ1GoLj5559/Ple35wrgPCEBO08Oz5MG5DxJwfeR3jxPDocphIab8+QQXoy+jgAL+n5F1PXfc/oe0mn47xl9j4bnahkWHTEyTpTVPYhQ92+PRPwM/ESNvDK1Rd1GjaSUPCz10LlRa4MWdSzbDb2gDUklnRSF3bynCPH0ttVitrKzA9oZc+/mbXH309tTRCv2sPL0XaxsO11RDTAioxUSvBy0180GCvhFnxoBAlZfuv9XtP9GZ20mQgPy9CjRRe1LyfH1gO0D1tubiREAnh4pWsS+lBCviRB0b22mAvU+PRIErGJHsAV83/7B7vDl7mh/dNAjA7lRHqAsd/N8d7FYfCEJgQlG5lFYn63NYM16I5A82InR5RpXhT2JFiqYT/w7mvffk1E/jvYu5uQjshMSjZvGO+xa5E7nYvHM+qni0MaOI/jWilt00OQuwoM95WymZRaQJ5hovY3JGRwQEXaJ8Pne99/vdUjpG3fLMtIXYit97zLpu61lOcjzwSps74Q6rSXkeQpr2td35DmUZbmp3XfQdXmu/kyCEEy3zbIQAH4fcVjD9e36G2Wl7RC5VgWvz97dellZuV9mUoWOwDewAmBwWhfC4A25qVZqxXT5DTTRihRFIWrNfPZq2SHkmIGnBHx1HEz554HBaQf9Cajl4XF3NtadxOAUb3iOrLZOl4SMzAXNkIKtsxk5fSJ6DET2Nr7DX5moJEUXCnSOW9Flg3VI+EPreOZ0qKuOuUXX24ywEEeu8c359NnRGO7zvRf8knsuvgDx9NR+B7PY6aMd1H12npQimC7JBNvf2s3QnCcXzRjvk2PeGQvrBsPFPfIErdDkWIgxFndl7dHS0N1O4KwOcaijlKoJJTDK+xED7hU3K72hc7lGzvy2uwwelXsUk0hnKKSN8ZQ+0bqjQ8CJw4AKkSOLY4Q4gIK2UYq/lOUbxB7B81EhhNN5YAWCAwZsYn1xsXuEilbonUyXLjRHKZUs67IJWk6aWSPFynDJd8lFIykUHlfonu6dFcTNAytQhHDzAudqyJGFGJNgvQDrbcEA8vQUQwezh2/Az1EZvVvzc++7TxfEuK+uIK65JgnUX5CNENrNUjiAY7qUKGLqB1EILMuwchQu+1IRbVB+3LU05EhSN0S2+WLqQv3ePLiJmR7DnSt4/2Z8GOC+zPYiqj2OGbvb+AMxZA/tR9tKPh5Y+jTUpmBgyaz31JRhQGvl5k/SRFeUU5VaHeXJYZJxGjbmDZOU50brvtH5Ijm8TUIIn36GADkN3ftoKZF7m9hshqWgXxEnSv1S6jVJOQaNxiZpwjEbygMT1ZLDRI8/YkarVYbQcRItzcHjDm8jlM9dJmnw25PDxCc1kzTBG1FWBJysZH2rfJIs44L3TdW0tFNZ/tEkUWkeSg9+5jQ/0FBGpcRT/VZTo8N3YmE7E/r7OllNkNMY4t4sjIJcLCwJRG29ZZWJIqsL8tjxppJm0YQP2G3vHGeDaLNSg+jw5bI9oxYlYYxYJGkiHZbd9g1nZvSnEzpDTZThwO6njv2ocYz4l9BA+Xg+J1F+MhYfNcIY+YyqmVafPH44ejEcDV8MRzRDyNN8Ph19710M+ozxhvxLzKO1vdvmVlPglMbgIeaM8LxtMcWHmfF0U869k+mzM10XOeXQUJgBp74/u6qiz9/NJTJ4gJuXaXLz8GZuINO7MaEPXxU4cVBXFRrItFFonncjdU9mc6ODg2WaLB7e3uIPub2v6fDmD+/uJ66EaKtE/hO4vni9TJPZw7j+ranV+A8ie/Bq2V6GK3f95Vjni8uot5YPAcaLguAmusjRkP1wV1+1qoY0DNUYXa7q+bHWBQq1RtH0cvShGoysOTLkQqh6PkMyh1sjj2dv7cpg9nlsKe+PK9FDacl6MzWeJwM4mnSsVPb4V8sEIiyn7JWGZ7zepa1ZjT/bC99Eo2fdeigqUWlD9BEFBgaHZVVwQdFcFgXhTff6AJp/bKg1lCQE4nUZF374qnjro5S8YBjUr8aBYOoN4K1QTUFGv/ABbm8bNmDuWC7h9pZOFc0lXbrLZdo20Fq9Br5XfYvBDOV1b1TThO3Apq0z1Js4l2Ti+IaQ++oiIKdKqullbYrlcnCHDdszejTd7pApnB1N8v+AYoTOkTo2OZpHSO7RxDtaGp4Rsz4LEW+mjDTWBXn07B4Q9kmsDVQOdQzkn33byLetx5agVJyvlR9n5HSKVHUYIHhwKBNCkc28ZmCsxIREmysJDV5LXduI3kzYxuTOCUJ6cZFq2vcTO9ThKq7u3gfrRFdRXdHx6ckjaMle7K7XRN7587v0c8Dx6QnVJspJcMUG8ME2lIikFT0QINcIrqWI5UuN+bbwgUdUTBGvNnuFpINQFbgLdxHKpV2LUdpmQZpK3jsTt8WrdES6dlQ1K0NFlnVY2R4dGYuGkKe6fgxXPkBJAdOaE6qObuWoGjkz09YWSmWdqX3QFfLaxHLKwBYEmaG1LZ0iVQioM38KqKwfLmAirEOTQq0kUd7UFONopsSbCo1EleFaEhj0pCPJfVib9ev0Pvz4XShZjnuIQjkmCfQTYw51xVzDktAUkMaTW936Bm3bUXkPo8mFntoE6Q+h9wqN1YqatZkKJX/13Kw9J41xJooJG1hNWp0vXVR5xJlm6+MXLax///NfhCpz6mWp84Z77eMZ64RKeZ1tlJHTXPqNBfo69ZgUbJScTaNis8Fdo9yg4Rweb0tXtB+8kdZ1yg5jxv+uUP6IRM+sgwOb9yRKxGhq0ZWqBq9Q3thOx4aX7JesNublCgPebyZ6O7KNBQX9R3XYWlnv6Y729+lPn6TNO4AwKRGPuGtSF8XiT0n6+EDU/W62b15vut7nN88+ytGvN9n16ITYZoPo3TtBMPNrU1BpP53XbnMCHMXoUFaqQiq8jGS7HO3vXw6Jtss0OVhHvve6RDdjniEizo2mov+qQEFF6GYBYiqkAjI6zW9ITTRGm/u9gE/D7D4iHPSI8PIuEY4UJ075KcmpvkL1++60u7zzyxOqNyXziteDifRA3J/0Nttt95u0mNVGukVyeHab3OyKSu76/sOzi+VFmhBhNQVxK20ZY+FmyWGydyema9Fcc5Dv7NazbsONVqickpt3HE9Ryb3rYbJMV0esdVM3QlsnplJNd+8dddFu9T0dh6d4b8NtVK2Sf0cKqwV6dqHSRBIbzFCQ1UoUpFP+sQ1ofxvPKoaa10WP2zNZjQfHcHAvwrs+wDt82QmtnsUoKQc+m7jnulBms68YnGxik51wYyfaeNYyZBPYi3G9IQfERgcHHDn6esghlhevOXpx8GrJLNR68knS99Y5r7DqcyZJ35eKgxpPIYxqzV2fJ+vZbaGpb8e0M/fsht59veG6joaRVBPNnBKO77hC9Z7sThLI6+HdaBIWmS6bav8I/u9//otHxGPnZf4Ex7WBSs/RTGr/ZGBS4I0kS6/zci3GKlCUBVpbLIAMvCm/YcvllMt/ovmUiUqMZSFJwxCY9rH7jpKyA/ipjXY8M74S6hoLUkxQaM1PusjqqJ0ueY14i861uZoQSikIGNMrILTkp2AcgmomVEbWkhc8tkPoCRsZpJWRFkHIkoDJMMbJRGaSr2etnBGZg1IoMWWDIuWoFlGhim94jB6TX2F1UXvLmV4SITq/RU4EDuAdeSq8cc5ZoBOywNwbzTb1TkuQjfBEbkwOYkXLywxtWz9Z4DUaVjTe5ayLAirtvBtIFlX3bGkiZ4SydFuHfEk4moZ8wbTlNXKxGABlA+kmI4+GGKCQ6so/aDtr2OwnHFvpsI3ozefzO0rveX/MX6Wb1WMwWOl23JQbWUV2hzcfz0npoCnt8eQ9mmuZRftiw5p7DLwXLkPhg0dRCYlK/mV1AF1MhcxQWexcXW/+evIdXMOLwX6SdtT8IxDe++7o7bc/vP+W5qWLyMvfcLA/2Oc0hLauFKqz1Mrj0FXR7aQlt29Jt29Jt29Jt29Jt29J/zivHbdvSbdvSbdvSbdvSbdvSbdvSbdvSZ8AKbZvSbdvSbdvSbdvSbdvSbdvSbdvSbdvSbdvSbdvSbdvSbdvSZ/G073tW9LtW9InxZDbt6TxLWmoPSG7ca8qhFSd4jhfjXS2+sL0Ik1mVK50eJbc3lJi8QMVoFPzLzUaqnW6SJNrYSRFz7nSKY0VPVTtcoVUdvLWJwN2T2n91PM957JXCryoIMmPeMOnfy9st6Lq5Pj9aZIm8cVAqXMaY8ScXsiKeXKYkNLm17RN0Si33yaFUNOaC3ASPy8VIonazfpVTFdcxRR+dOp4hFp0sOyXN/mt0P+0sbUD/oty33/HxX834L5n44BA2whNR3ixXC7/D1M7pvI=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file.",source:"@site/docs/API-docs/createdocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createdocument",permalink:"/docs/API-docs/createdocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file.",sidebar_label:"Create Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztO+1yGzeSr9I7fxyrRpRIy45XdXW1jp3b1W0SqWK5UluSSgFnmiSsGWACYEQxKv7bJ9lH2ye56gYwHxQpyXYqq9TRPywO0AAaje5Gf+E2cWJqk8Oz5J3O6hKVs8lFmuRoMyMrJ7VKDpPTGcJbg8IhRCh4c3IEoij03EJt0VhwGqao0BCUwjnkcT4YL6Ay+lrmUk0hF07AXLoZjIXFVweAKtM55jCRBQ7O1bk6ldUhfKgKLXJY6NrAybv/aWajZajtbGfnHY7rKXw42tm5+GrmXGUP9/ZEVQ10hcrKqSrE2A4yXe7lBFjlk+cpzGdokGaFTChAYWWxAJHnMJf5FJ1Nwc1QQaarBWRam1wq4dCmUIkpgqrLMRqbglA5lNogSAUCDIp8sev0bm0R/vf98Q8w0aYUbgAnRW3TZrlcGsxcsfDTuxk2u3pmIzWsM1JNUyjFFVFLOvilltkVbduiyukvDXxzcsS02tl5X1eVNg5z+Mlv4XBnh3q+wULPQRhk+EyXpVZQCSNKdHxcM+G42+AvtTSY+0MRRRFpcXiudmFnxy0qPNzZgSOVy4yIwRNSK+hJgB14UCISgb6vMJMTGUA7pAOtYD6T2YxpMhf+PKtCZB5Ng7bCzMlr7E98k8KCJn6HSkcMZtrIX7VyouDjuEbjZCaK7rERggRqnTCOyFlpqVxsDSvAP8Lx0OnxoQS+ItRyIlYpFfdYhGtR1GgDVvMUZoTVj1gZtMzqYV4ipMphhnI627ieyD/W1vUmhtoSml0swlrxlJi8yGSbiMIiyEmPlqW4ws5qoFmGRTGAbxaQ40TUhUtBEsc5U+MAftAORFUVMhPjAolzgYRHuNrgLp9yYIeAiBIln/EJSzRaEJDLyQQNCSd18hRhTMSO+KxVASw5biYUaLVy0JkutKHpV3iI2/uEhEwrh8oN4M21kAVj73drQaqsqHOEcSGyqxTGRY0pGMy95C6Q9FYatBCBgLCB6EwgsFgQG2pFG1A6LC8t2IBVPoDTmbStQFFnpDUvIm2XrEFsJ5pWJhpEGQMshSxSplwKH/UYnHQFpiSxlVCLlBQmpuDwxo31TQrZDLMr/mVELjWMa+e08hvLja5yPVeBmBOtnJW/rhHJ2PPpFB2lcJDCqxRepzDcT2E4SmF4kMLwVQrD1ymM9lMYjVIYHaQweuXRGr0OtBYNgbsIDEeeyu6PQ11SvN9Jy6JNGtM2SnjeU8LnajiAnZ1GoLj5559/Ple35wrgPCEBO08Oz5MG5DxJwfeR3jxPDocphIab8+QQXoy+jgAL+n5F1PXfc/oe0mn47xl9j4bnahkWHTEyTpTVPYhQ92+PRPwM/ESNvDK1Rd1GjaSUPCz10LlRa4MWdSzbDb2gDUklnRSF3bynCPH0ttVitrKzA9oZc+/mbXH309tTRCv2sPL0XaxsO11RDTAioxUSvBy0180GCvhFnxoBAlZfuv9XtP9GZ20mQgPy9CjRRe1LyfH1gO0D1tubiREAnh4pWsS+lBCviRB0b22mAvU+PRIErGJHsAV83/7B7vDl7mh/dNAjA7lRHqAsd/N8d7FYfCEJgQlG5lFYn63NYM16I5A82InR5RpXhT2JFiqYT/w7mvffk1E/jvYu5uQjshMSjZvGO+xa5E7nYvHM+qni0MaOI/jWilt00OQuwoM95WymZRaQJ5hovY3JGRwQEXaJ8Pne99/vdUjpG3fLMtIXYit97zLpu61lOcjzwSps74Q6rSXkeQpr2td35DmUZbmp3XfQdXmu/kyCEEy3zbIQAH4fcVjD9e36G2Wl7RC5VgWvz97dellZuV9mUoWOwDewAmBwWhfC4A25qVZqxXT5DTTRihRFIWrNfPZq2SHkmIGnBHx1HEz554HBaQf9Cajl4XF3NtadxOAUb3iOrLZOl4SMzAXNkIKtsxk5fSJ6DET2Nr7DX5moJEUXCnSOW9Flg3VI+EPreOZ0qKuOuUXX24ywEEeu8c359NnRGO7zvRf8knsuvgDx9NR+B7PY6aMd1H12npQimC7JBNvf2s3QnCcXzRjvk2PeGQvrBsPFPfIErdDkWIgxFndl7dHS0N1O4KwOcaijlKoJJTDK+xED7hU3K72hc7lGzvy2uwwelXsUk0hnKKSN8ZQ+0bqjQ8CJw4AKkSOLY4Q4gIK2UYq/lOUbxB7B81EhhNN5YAWCAwZsYn1xsXuEilbonUyXLjRHKZUs67IJWk6aWSPFynDJd8lFIykUHlfonu6dFcTNAytQhHDzAudqyJGFGJNgvQDrbcEA8vQUQwezh2/Az1EZvVvzc++7TxfEuK+uIK65JgnUX5CNENrNUjiAY7qUKGLqB1EILMuwchQu+1IRbVB+3LU05EhSN0S2+WLqQv3ePLiJmR7DnSt4/2Z8GOC+zPYiqj2OGbvb+AMxZA/tR9tKPh5Y+jTUpmBgyaz31JRhQGvl5k/SRFeUU5VaHeXJYZJxGjbmDZOU50brvtH5Ijm8TUIIn36GADkN3ftoKZF7m9hshqWgXxEnSv1S6jVJOQaNxiZpwjEbygMT1ZLDRI8/YkarVYbQcRItzcHjDm8jlM9dJmnw25PDxCc1kzTBG1FWBJysZH2rfJIs44L3TdW0tFNZ/tEkUWkeSg9+5jQ/0FBGpcRT/VZTo8N3YmE7E/r7OllNkNMY4t4sjIJcLCwJRG29ZZWJIqsL8tjxppJm0YQP2G3vHGeDaLNSg+jw5bI9oxYlYYxYJGkiHZbd9g1nZvSnEzpDTZThwO6njv2ocYz4l9BA+Xg+J1F+MhYfNcIY+YyqmVafPH44ejEcDV8MRzRDyNN8Ph19710M+ozxhvxLzKO1vdvmVlPglMbgIeaM8LxtMcWHmfF0U869k+mzM10XOeXQUJgBp74/u6qiz9/NJTJ4gJuXaXLz8GZuINO7MaEPXxU4cVBXFRrItFFonncjdU9mc6ODg2WaLB7e3uIPub2v6fDmD+/uJ66EaKtE/hO4vni9TJPZw7j+ranV+A8ie/Bq2V6GK3f95Vjni8uot5YPAcaLguAmusjRkP1wV1+1qoY0DNUYXa7q+bHWBQq1RtH0cvShGoysOTLkQqh6PkMyh1sjj2dv7cpg9nlsKe+PK9FDacl6MzWeJwM4mnSsVPb4V8sEIiyn7JWGZ7zepa1ZjT/bC99Eo2fdeigqUWlD9BEFBgaHZVVwQdFcFgXhTff6AJp/bKg1lCQE4nUZF374qnjro5S8YBjUr8aBYOoN4K1QTUFGv/ABbm8bNmDuWC7h9pZOFc0lXbrLZdo20Fq9Br5XfYvBDOV1b1TThO3Apq0z1Js4l2Ti+IaQ++oiIKdKqullbYrlcnCHDdszejTd7pApnB1N8v+AYoTOkTo2OZpHSO7RxDtaGp4Rsz4LEW+mjDTWBXn07B4Q9kmsDVQOdQzkn33byLetx5agVJyvlR9n5HSKVHUYIHhwKBNCkc28ZmCsxIREmysJDV5LXduI3kzYxuTOCUJ6cZFq2vcTO9ThKq7u3gfrRFdRXdHx6ckjaMle7K7XRN7587v0c8Dx6QnVJspJcMUG8ME2lIikFT0QINcIrqWI5UuN+bbwgUdUTBGvNnuFpINQFbgLdxHKpV2LUdpmQZpK3jsTt8WrdES6dlQ1K0NFlnVY2R4dGYuGkKe6fgxXPkBJAdOaE6qObuWoGjkz09YWSmWdqX3QFfLaxHLKwBYEmaG1LZ0iVQioM38KqKwfLmAirEOTQq0kUd7UFONopsSbCo1EleFaEhj0pCPJfVib9ev0Pvz4XShZjnuIQjkmCfQTYw51xVzDktAUkMaTW936Bm3bUXkPo8mFntoE6Q+h9wqN1YqatZkKJX/13Kw9J41xJooJG1hNWp0vXVR5xJlm6+MXLax///NfhCpz6mWp84Z77eMZ64RKeZ1tlJHTXPqNBfo69ZgUbJScTaNis8Fdo9yg4Rweb0tXtB+8kdZ1yg5jxv+uUP6IRM+sgwOb9yRKxGhq0ZWqBq9Q3thOx4aX7JesNublCgPebyZ6O7KNBQX9R3XYWlnv6Y729+lPn6TNO4AwKRGPuGtSF8XiT0n6+EDU/W62b15vut7nN88+ytGvN9n16ITYZoPo3TtBMPNrU1BpP53XbnMCHMXoUFaqQiq8jGS7HO3vXw6Jtss0OVhHvve6RDdjniEizo2mov+qQEFF6GYBYiqkAjI6zW9ITTRGm/u9gE/D7D4iHPSI8PIuEY4UJ075KcmpvkL1++60u7zzyxOqNyXziteDifRA3J/0Nttt95u0mNVGukVyeHab3OyKSu76/sOzi+VFmhBhNQVxK20ZY+FmyWGydyema9Fcc5Dv7NazbsONVqickpt3HE9Ryb3rYbJMV0esdVM3QlsnplJNd+8dddFu9T0dh6d4b8NtVK2Sf0cKqwV6dqHSRBIbzFCQ1UoUpFP+sQ1ofxvPKoaa10WP2zNZjQfHcHAvwrs+wDt82QmtnsUoKQc+m7jnulBms68YnGxik51wYyfaeNYyZBPYi3G9IQfERgcHHDn6esghlhevOXpx8GrJLNR68knS99Y5r7DqcyZJ35eKgxpPIYxqzV2fJ+vZbaGpb8e0M/fsht59veG6joaRVBPNnBKO77hC9Z7sThLI6+HdaBIWmS6bav8I/u9//otHxGPnZf4Ex7WBSs/RTGr/ZGBS4I0kS6/zci3GKlCUBVpbLIAMvCm/YcvllMt/ovmUiUqMZSFJwxCY9rH7jpKyA/ipjXY8M74S6hoLUkxQaM1PusjqqJ0ueY14i861uZoQSikIGNMrILTkp2AcgmomVEbWkhc8tkPoCRsZpJWRFkHIkoDJMMbJRGaSr2etnBGZg1IoMWWDIuWoFlGhim94jB6TX2F1UXvLmV4SITq/RU4EDuAdeSq8cc5ZoBOywNwbzTb1TkuQjfBEbkwOYkXLywxtWz9Z4DUaVjTe5ayLAirtvBtIFlX3bGkiZ4SydFuHfEk4moZ8wbTlNXKxGABlA+kmI4+GGKCQ6so/aDtr2OwnHFvpsI3ozefzO0rveX/MX6Wb1WMwWOl23JQbWUV2hzcfz0npoCnt8eQ9mmuZRftiw5p7DLwXLkPhg0dRCYlK/mV1AF1MhcxQWexcXW/+evIdXMOLwX6SdtT8IxDe++7o7bc/vP+W5qWLyMvfcLA/2Oc0hLauFKqz1Mrj0FXR7aQlt29Jt29Jt29Jt29Jt29J/zivHbdvSbdvSbdvSbdvSbdvSbdvSbdvSZ8AKbZvSbdvSbdvSbdvSbdvSbdvSbdvSbdvSbdvSbdvSbdvSbdvSZ/G073tW9LtW9InxZDbt6TxLWmoPSG7ca8qhFSd4jhfjXS2+sL0Ik1mVK50eJbc3lJi8QMVoFPzLzUaqnW6SJNrYSRFz7nSKY0VPVTtcoVUdvLWJwN2T2n91PM957JXCryoIMmPeMOnfy9st6Lq5Pj9aZIm8cVAqXMaY8ScXsiKeXKYkNLm17RN0Si33yaFUNOaC3ASPy8VIonazfpVTFdcxRR+dOp4hFp0sOyXN/mt0P+0sbUD/oty33/HxX834L5n44BA2whNR3ixXC7/D1M7pvI=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Draft Document",permalink:"/docs/API-docs/draftdocument"},next:{title:"Create Document from Template",permalink:"/docs/API-docs/createdocumentwithtemplateid"}},j={},g=[{value:"Request",id:"request",level:2}];function b(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(n.p,{children:"Create Document"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/createdocument"}),"\n",(0,i.jsx)(n.p,{children:"The Create Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"name", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job title:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"job title", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"company", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"date", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": { \n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression":"",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0, \n "maxselections": 0 \n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"dropdown", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"radio button", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "readonly": false,\n "required": true, \n "name": "radio button",\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(n.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded pdf"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Note"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"timeToCompleteDays",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})}),(0,i.jsx)("span",{className:"openapi-schema__divider"}),(0,i.jsx)("span",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"send_email",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"redirect_url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_sender_name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"name or email of the person or organization on the behalf of which you are sending the mail.",example:"opensign\u2122"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(t.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Document created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://url-to-sign-document.com"}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://url-to-sign-document.com"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:n}={...(0,a.a)(),...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/377084eb.9fbdad2a.js b/assets/js/377084eb.8bd89dab.js similarity index 62% rename from assets/js/377084eb.9fbdad2a.js rename to assets/js/377084eb.8bd89dab.js index 543c13714..d4197f69d 100644 --- a/assets/js/377084eb.9fbdad2a.js +++ b/assets/js/377084eb.8bd89dab.js @@ -1 +1 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8106],{56181:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>x,default:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>f});var l=s(85893),i=s(11151),t=s(58219),r=(s(62316),s(51039)),n=s.n(r),m=(s(82723),s(9487)),c=s(41429),o=s(5397),d=s(4667),p=s(9472),h=s(85162);const u={id:"get-template",title:"Get Template",description:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.",sidebar_label:"Get Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzVWOluHLkRfpVa/skaaM0hy/JmEAQrZA2vsJu1ESkwEHsgsLtrummxSS5ZPQcG/S9PkkfLkwTFPjSjGY8sJDCQP9I0WV9drIvcCpJFELOP4hYrpyVhEPNE5Bgyrxwpa8RM3JYIb5GgJ4Gr99cgtbarABtbA1nwSF7hEiFHkkoHkKmtCSQEh5laqAyoA48GNgEC+iWCDJDqGp1XhgIsrIfMoyRlCshtVlfIyytFJTiPOS6UwRwC+Tqj2mMYiURYh16ytte5mIkCqZchEuGklxUSejZzK4ysUMxEr86dykUiFJvpJJXise3XP4FdDMoDlZLAIOaBrU4RFkhZiczD4++18piLGfkaExFoo1lSUJXTrAiunbY5itlC6sAEWYmVFLOtoI2LlOSVKUQiFtZXktoVU4immTP74KwJGBhwPpnwv31VQ51lGMKi1jD4QyQis4bQENNL57TK4sb4c2DQ9lALm37GjNhxntmQakW2y+zf0/q2K7iW0eqZWE9/Tk0Vzt8XokkEKeLVQxYPgBB/DC5nlLH0BGg4oEjasEo6R/+tzGqD6pSCrT4QCZsHRzzEYacwq66eclFJ5MJsPO7BdUA/ymzFaLsye3afclbMM9trlYigChPzZEBL7+WGE4SwCk9709unVM/Qfp3DPluEFKNaWEmln6ROEX/sFnpfuNKaJ8RcvLo8n7784fWU6VcqL5D+C/vb3UN5+4l6xaUTc1hKXWOAM2C/Sy5mCQSSlRs9EXwDPSu93hFo6ipFv4seVgb0+cVFk4jNM1Gvp+yfZ4Je/tAkonwm6OKST04W+Ezc9Gha3bQhfdcfbXOKKmZmQJNfm3d+v3yk1mqUZlcgl/kmETGJML+i04F2Pjl/eTadnE1e304vZxd/nL26HE0mk3+IRKyrGN1dZ8q7otcr2X/XLv8mctDIVOOtrb/OfI+58pjRXe2P5uipOGZxcY64q2zOU0JsTeG03Ng9+aD2zdntF4/Pl0+9ScTFsa55YyukkoeNFRqClbemSMBplAGB/AZkIZUBZuO/+9+1U/TePlGmn6fZblwro5XBu35kuLuYTO6mgxMuDp1wu9M+YWFrk39bU4/JP23Qxd3lYNCrQ4OuzVJqlcdJ9dbeo/m29uyKp1b8YcSqlijuiz1jd9dbIwNmtVe0iSPs+kw6ddbuzz7OeTrkSLHd7BtnXirFTAwDwni7M+82gvn5ZT8RP8qHlSwK9D/XadT+qiYLf7XZfWtiTPJh/lgqTy2nUWhhZZ1y8x2/93JRa/2bXN5LP7YOzXg6mowmokm2j5gEafLUrkdMxI1NyzREHtKp8XJ6BCGdewZ1IFkoU5ydRM0fXHzDYdCe9J6jH2YCp35BHgq6c9yl6q4SJco4zDX8vbAR3J3uO4eG20307nJ6MBx8QJ3ZCvl6QSVCT/7vf/4rIvobUQzd7+Bd7cHZFXqe+qXJYaFxrVJ97I4WUFYaQ9AbUIaw8JxwuSoUSR1HEC41mXQyVVpxsDOZZbSHnXwJI/hQIpXoeesPHkFCjkvUnCOgreVQYXmyJltFGZ3OsLL+fsEqJSAhrYMyGPgWiD0ETSlNhtCfRQLWgzSAhtA7rwKCVBUT8zURFwuVKWbMme1lRlBJIwtkYQmw3uwF5+1S5RjA27QOBMHqOhrCEitEak2Mt7oR/KSW2BrOi+11FnMoamaRQGZzhC7R2QyTQ4qBwLF4lWFkGkh6Ao1L9DH24klyPoCzXIGU1Hyr3D1bZkRemsD9slWoP5rBfc5bvuBFGbncjOCT+WS4S0AdkANAK3MfZp/MGXwcwuwDpkERzr/v82G1Wh3kwYt9zFtFZZ2CR2cfcEVcjFmzCx8+XohEEPoqvFvcoF+qrL+pfEHmOBKPu7oss1iXu1Gfc+zHxwCukVplaALuVNGrt+9/hSW8HE32ytNXKDz+9fovb367ecN8uRi2+deXKeFsoEqaHVG7byCP83b70F3+D95LukpGuKax01LF/tMNcG3v+PgwPCVitvtaMk9EaQMxyXabyoB/97ppePn3Gj13qHkiltIrHiPbBqMC/86Hl48veu77v3WPKC/g6x9ejhrT12rDhTpetHjeTMQ9bh69/jRzvqS0BZu1bSmusgwd7WAPJoa9tvv2za1IhKyp3G8U97FRdD+Y+1G99jtIqwD/5WZ2FPAnjqhfcPPngbzd+SKgs6+nZh/Nm6b5D8v0664=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/get-template",title:"Get Template",description:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.",source:"@site/docs/API-docs/get-template.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/get-template",permalink:"/docs/API-docs/get-template",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"get-template",title:"Get Template",description:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.",sidebar_label:"Get Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzVWOluHLkRfpVa/skaaM0hy/JmEAQrZA2vsJu1ESkwEHsgsLtrummxSS5ZPQcG/S9PkkfLkwTFPjSjGY8sJDCQP9I0WV9drIvcCpJFELOP4hYrpyVhEPNE5Bgyrxwpa8RM3JYIb5GgJ4Gr99cgtbarABtbA1nwSF7hEiFHkkoHkKmtCSQEh5laqAyoA48GNgEC+iWCDJDqGp1XhgIsrIfMoyRlCshtVlfIyytFJTiPOS6UwRwC+Tqj2mMYiURYh16ytte5mIkCqZchEuGklxUSejZzK4ysUMxEr86dykUiFJvpJJXise3XP4FdDMoDlZLAIOaBrU4RFkhZiczD4++18piLGfkaExFoo1lSUJXTrAiunbY5itlC6sAEWYmVFLOtoI2LlOSVKUQiFtZXktoVU4immTP74KwJGBhwPpnwv31VQ51lGMKi1jD4QyQis4bQENNL57TK4sb4c2DQ9lALm37GjNhxntmQakW2y+zf0/q2K7iW0eqZWE9/Tk0Vzt8XokkEKeLVQxYPgBB/DC5nlLH0BGg4oEjasEo6R/+tzGqD6pSCrT4QCZsHRzzEYacwq66eclFJ5MJsPO7BdUA/ymzFaLsye3afclbMM9trlYigChPzZEBL7+WGE4SwCk9709unVM/Qfp3DPluEFKNaWEmln6ROEX/sFnpfuNKaJ8RcvLo8n7784fWU6VcqL5D+C/vb3UN5+4l6xaUTc1hKXWOAM2C/Sy5mCQSSlRs9EXwDPSu93hFo6ipFv4seVgb0+cVFk4jNM1Gvp+yfZ4Je/tAkonwm6OKST04W+Ezc9Gha3bQhfdcfbXOKKmZmQJNfm3d+v3yk1mqUZlcgl/kmETGJML+i04F2Pjl/eTadnE1e304vZxd/nL26HE0mk3+IRKyrGN1dZ8q7otcr2X/XLv8mctDIVOOtrb/OfI+58pjRXe2P5uipOGZxcY64q2zOU0JsTeG03Ng9+aD2zdntF4/Pl0+9ScTFsa55YyukkoeNFRqClbemSMBplAGB/AZkIZUBZuO/+9+1U/TePlGmn6fZblwro5XBu35kuLuYTO6mgxMuDp1wu9M+YWFrk39bU4/JP23Qxd3lYNCrQ4OuzVJqlcdJ9dbeo/m29uyKp1b8YcSqlijuiz1jd9dbIwNmtVe0iSPs+kw6ddbuzz7OeTrkSLHd7BtnXirFTAwDwni7M+82gvn5ZT8RP8qHlSwK9D/XadT+qiYLf7XZfWtiTPJh/lgqTy2nUWhhZZ1y8x2/93JRa/2bXN5LP7YOzXg6mowmokm2j5gEafLUrkdMxI1NyzREHtKp8XJ6BCGdewZ1IFkoU5ydRM0fXHzDYdCe9J6jH2YCp35BHgq6c9yl6q4SJco4zDX8vbAR3J3uO4eG20307nJ6MBx8QJ3ZCvl6QSVCT/7vf/4rIvobUQzd7+Bd7cHZFXqe+qXJYaFxrVJ97I4WUFYaQ9AbUIaw8JxwuSoUSR1HEC41mXQyVVpxsDOZZbSHnXwJI/hQIpXoeesPHkFCjkvUnCOgreVQYXmyJltFGZ3OsLL+fsEqJSAhrYMyGPgWiD0ETSlNhtCfRQLWgzSAhtA7rwKCVBUT8zURFwuVKWbMme1lRlBJIwtkYQmw3uwF5+1S5RjA27QOBMHqOhrCEitEak2Mt7oR/KSW2BrOi+11FnMoamaRQGZzhC7R2QyTQ4qBwLF4lWFkGkh6Ao1L9DH24klyPoCzXIGU1Hyr3D1bZkRemsD9slWoP5rBfc5bvuBFGbncjOCT+WS4S0AdkANAK3MfZp/MGXwcwuwDpkERzr/v82G1Wh3kwYt9zFtFZZ2CR2cfcEVcjFmzCx8+XohEEPoqvFvcoF+qrL+pfEHmOBKPu7oss1iXu1Gfc+zHxwCukVplaALuVNGrt+9/hSW8HE32ytNXKDz+9fovb367ecN8uRi2+deXKeFsoEqaHVG7byCP83b70F3+D95LukpGuKax01LF/tMNcG3v+PgwPCVitvtaMk9EaQMxyXabyoB/97ppePn3Gj13qHkiltIrHiPbBqMC/86Hl48veu77v3WPKC/g6x9ejhrT12rDhTpetHjeTMQ9bh69/jRzvqS0BZu1bSmusgwd7WAPJoa9tvv2za1IhKyp3G8U97FRdD+Y+1G99jtIqwD/5WZ2FPAnjqhfcPPngbzd+SKgs6+nZh/Nm6b5D8v0664=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Template",permalink:"/docs/API-docs/createtemplate"},next:{title:"Update Template",permalink:"/docs/API-docs/update-template"}},g={},f=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Get Template"})}),"\n",(0,l.jsx)(n(),{method:"get",path:"/template/{template_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of template that needs to be fetched",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"strng"}}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"sample template"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template note"}}),(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"folder"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder name"}})]})]})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}}),(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"signers"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(a.p,{children:"Array ["})})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"widgets"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(a.p,{children:"Array ["})})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(a.p,{children:"]"})})})]})]})}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(a.p,{children:"]"})})})]})]})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!0}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!0}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"redirect_url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "objectId": "x1Hbnms2Pg",\n "title": "sample template",\n "note": "template note",\n "folder": {\n "objectId": "x1Hbnms2Pg",\n "name": "folder name"\n },\n "file": "https://templateuser.com",\n "owner": "template creator name",\n "signers": [\n {\n "role": "ceo",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871",\n "widgets": [\n {\n "type": "signature",\n "x": 244,\n "y": 71,\n "w": 38,\n "h": 46,\n "page": 1\n }\n ]\n }\n ],\n "sendInOrder": true,\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z",\n "enableTour": true,\n "redirect_url": "",\n "allow_modifications": false\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8106],{56181:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>x,default:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>g});var l=s(85893),i=s(11151),t=s(58219),n=(s(62316),s(51039)),r=s.n(n),m=(s(82723),s(9487)),c=s(41429),o=s(5397),p=s(4667),d=s(9472),h=s(85162);const u={id:"get-template",title:"Get Template",description:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.",sidebar_label:"Get Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzVWOluHLkRfpVa/skaaM0hy/JmEAQrZA1H2MXaWCkwEHsgsLtrummxSS5ZPQeE/pcnyaPtkwTFPtSjkUcWEhjIH2marK8u1kXeCZJFEIuP4horpyVhEMtE5Bgyrxwpa8RCXJcIb5GgJ4GL95cgtbabADtbA1nwSF7hGiFHkkoHkKmtCSQEh5laqQyoA08GNgEC+jWCDJDqGp1XhgKsrIfMoyRlCshtVlfIyxtFJTiPOa6UwRwC+Tqj2mOYiERYh16ytpe5WIgCqZchEuGklxUSejbzThhZoViIXp0blYtEKDbTSSrFQ9svfwK7GpQHKiWBQcwDW50irJCyEpmHx99r5TEXC/I1JiLQTrOkoCqnWRHcOm1zFIuV1IEJshIrKRZ3gnYuUpJXphCJWFlfSWpXTCGaZsnsg7MmYGDA6WzG//ZVDXWWYQirWsPgD5GIzBpCQ0wvndMqixvTz4FBd4da2PQzZsSO88yGVCuyXWb/Hte3XcGtjFYvxHb+99RU4fR9IZpEkCJePWRxDwjxx+ByRhlLT4CGA4qkDaukc/Tfyqw2qI4p2OoDkbC5d8R9HHYKs+rqKReVRC4sptMeXAf0k8xWjLYbs2f3MWfFPLO9VokIqjAxTwa09F7uOEEIq/C0N719SvUM7dc57LNFSDGqhZVU+knqFPHHbqH3hSuteULM2avz0/nLH17PmX6j8gLpv7C/3T2Ut5+oF1w6MYe11DUGOAH2u+RilkAgWbnJE8E30LPS25FAU1cp+jF6WBnQp2dnTSJ2z0S9nrN/ngl6+UOTiPKZoLNzPjlZ4DNx80fT6qoN6Zv+aJtjVDEzA5r80rzz++UjtVajNGOBXOabRMQkwvyCjgfa6ez05cl8djJ7fT0/X5z9efHqfDKbzf4pErGtYnR3nSnvil6vZP9du/ybyEEjU43Xtv468z3mymNGN7V/NEePxTGLi3PETWVznhJiawrH5cbuyQe1b864Xzw8Xz71JhFnj3XNK1shlTxsbNAQbLw1RQJOowwI5HcgC6kMMBv/3f+unaL39oky/TzNxnGtjFYGb/qR4eZsNruZD044O3TC9ah9wsrWJv+2pj4m/7hBZzfng0GvDg26NGupVR4n1Wt7i+bb2jMWT634w4hVLVHcF3vGjtdbIwNmtVe0iyPs9kQ6ddLuLz4ueTrkSLHd7BtnXirFQgwDwvRuNO82gvn5dT8Rx8QdZoogTZ7a7cQ6NNxntEwD99OpdGq65jb5ECGdewZ1IFkoU5wcRS3vLb7iU2kdv2f3fYt26mfkHt25dUzVTfYlyjhbNfy9shHcOfudQ8PVPx7Ven7Qqz+gzmyFPO1TidCT//Gvf0dEf0GJkfQdvKs9OLtBz0O4NDmsNG5Vqh+7MgWUlcYQ9A6UISw8x3+uCkVSx4mAMz+TTqZKK449JrOM9jAK3zCBDyVSiZ63/uQRJOS4Rs0hC9raW+ZDFmRNtooyOp1hY/3tilVKQEJaB2Uw8KUMewiaUpoMoT+LBKwHaQANoXdeBQSpKibmWxuuVipTzJgTzcuMoJJGFsjCEmC92QvO27XKMYC3aR0IgtV1NIQlVojUmhgvWRP4Sa2xNZwX29sl5lDUzCKBzOYIXd6xGSaHFAOBY/Eqw8g0kPQEGtfoY+zFk1zVWoOzXBCU1HzJG58tMyIvTeD21SrUH83gPuct37eijFzuJvDJfDJctKEOyAGglbkNi0/mBD4OYfYB06AIl9/3+bDZbA7y4MU+5q2isk7Bo7P3uCIuxqwZw4ePFyIRhL4K71ZX6Ncq6y8OX5A5jcTTrkzKLJbJbvLmHPvxIYBLllYZmoCjonbx9v0vsIaXk5lIRpn/FQpPf7n825tfr94wX65Nbf7NJ7PJLM7yNlAlzUjU+EniYd7e3Rf7/4Pni66SEW5p6rRUsR1081Rbyj/ezzKJWIwfL5aJKG0gJrm7S2XAf3jdNLz8e42eG8YyEWvpFU91sd7nKvDvfHiI+KLnvv+te9N4AV//DvKoMX2tNlyo472Hx79E3OLuwWNMs+Q7Q1uwWduW4iLL0NEIe9DA97rg2zfXIhGypnK/UdzGRtH9YO6P6rXfQVoF+C83s0cBf+GI+hl3fx3I250vAjr7emr20bJpmv8ArOjEAw==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/get-template",title:"Get Template",description:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.",source:"@site/docs/API-docs/get-template.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/get-template",permalink:"/docs/API-docs/get-template",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"get-template",title:"Get Template",description:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.",sidebar_label:"Get Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzVWOluHLkRfpVa/skaaM0hy/JmEAQrZA1H2MXaWCkwEHsgsLtrummxSS5ZPQeE/pcnyaPtkwTFPtSjkUcWEhjIH2marK8u1kXeCZJFEIuP4horpyVhEMtE5Bgyrxwpa8RCXJcIb5GgJ4GL95cgtbabADtbA1nwSF7hGiFHkkoHkKmtCSQEh5laqQyoA08GNgEC+jWCDJDqGp1XhgKsrIfMoyRlCshtVlfIyxtFJTiPOa6UwRwC+Tqj2mOYiERYh16ytpe5WIgCqZchEuGklxUSejbzThhZoViIXp0blYtEKDbTSSrFQ9svfwK7GpQHKiWBQcwDW50irJCyEpmHx99r5TEXC/I1JiLQTrOkoCqnWRHcOm1zFIuV1IEJshIrKRZ3gnYuUpJXphCJWFlfSWpXTCGaZsnsg7MmYGDA6WzG//ZVDXWWYQirWsPgD5GIzBpCQ0wvndMqixvTz4FBd4da2PQzZsSO88yGVCuyXWb/Hte3XcGtjFYvxHb+99RU4fR9IZpEkCJePWRxDwjxx+ByRhlLT4CGA4qkDaukc/Tfyqw2qI4p2OoDkbC5d8R9HHYKs+rqKReVRC4sptMeXAf0k8xWjLYbs2f3MWfFPLO9VokIqjAxTwa09F7uOEEIq/C0N719SvUM7dc57LNFSDGqhZVU+knqFPHHbqH3hSuteULM2avz0/nLH17PmX6j8gLpv7C/3T2Ut5+oF1w6MYe11DUGOAH2u+RilkAgWbnJE8E30LPS25FAU1cp+jF6WBnQp2dnTSJ2z0S9nrN/ngl6+UOTiPKZoLNzPjlZ4DNx80fT6qoN6Zv+aJtjVDEzA5r80rzz++UjtVajNGOBXOabRMQkwvyCjgfa6ez05cl8djJ7fT0/X5z9efHqfDKbzf4pErGtYnR3nSnvil6vZP9du/ybyEEjU43Xtv468z3mymNGN7V/NEePxTGLi3PETWVznhJiawrH5cbuyQe1b864Xzw8Xz71JhFnj3XNK1shlTxsbNAQbLw1RQJOowwI5HcgC6kMMBv/3f+unaL39oky/TzNxnGtjFYGb/qR4eZsNruZD044O3TC9ah9wsrWJv+2pj4m/7hBZzfng0GvDg26NGupVR4n1Wt7i+bb2jMWT634w4hVLVHcF3vGjtdbIwNmtVe0iyPs9kQ6ddLuLz4ueTrkSLHd7BtnXirFQgwDwvRuNO82gvn5dT8Rx8QdZoogTZ7a7cQ6NNxntEwD99OpdGq65jb5ECGdewZ1IFkoU5wcRS3vLb7iU2kdv2f3fYt26mfkHt25dUzVTfYlyjhbNfy9shHcOfudQ8PVPx7Ven7Qqz+gzmyFPO1TidCT//Gvf0dEf0GJkfQdvKs9OLtBz0O4NDmsNG5Vqh+7MgWUlcYQ9A6UISw8x3+uCkVSx4mAMz+TTqZKK449JrOM9jAK3zCBDyVSiZ63/uQRJOS4Rs0hC9raW+ZDFmRNtooyOp1hY/3tilVKQEJaB2Uw8KUMewiaUpoMoT+LBKwHaQANoXdeBQSpKibmWxuuVipTzJgTzcuMoJJGFsjCEmC92QvO27XKMYC3aR0IgtV1NIQlVojUmhgvWRP4Sa2xNZwX29sl5lDUzCKBzOYIXd6xGSaHFAOBY/Eqw8g0kPQEGtfoY+zFk1zVWoOzXBCU1HzJG58tMyIvTeD21SrUH83gPuct37eijFzuJvDJfDJctKEOyAGglbkNi0/mBD4OYfYB06AIl9/3+bDZbA7y4MU+5q2isk7Bo7P3uCIuxqwZw4ePFyIRhL4K71ZX6Ncq6y8OX5A5jcTTrkzKLJbJbvLmHPvxIYBLllYZmoCjonbx9v0vsIaXk5lIRpn/FQpPf7n825tfr94wX65Nbf7NJ7PJLM7yNlAlzUjU+EniYd7e3Rf7/4Pni66SEW5p6rRUsR1081Rbyj/ezzKJWIwfL5aJKG0gJrm7S2XAf3jdNLz8e42eG8YyEWvpFU91sd7nKvDvfHiI+KLnvv+te9N4AV//DvKoMX2tNlyo472Hx79E3OLuwWNMs+Q7Q1uwWduW4iLL0NEIe9DA97rg2zfXIhGypnK/UdzGRtH9YO6P6rXfQVoF+C83s0cBf+GI+hl3fx3I250vAjr7emr20bJpmv8ArOjEAw==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Template",permalink:"/docs/API-docs/createtemplate"},next:{title:"Update Template",permalink:"/docs/API-docs/update-template"}},f={},g=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Get Template"})}),"\n",(0,l.jsx)(r(),{method:"get",path:"/template/{template_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of template that needs to be fetched",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"strng"}}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"sample template"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template note"}}),(0,l.jsx)(p.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"folder"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder name"}})]})]})}),(0,l.jsx)(p.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}}),(0,l.jsx)(p.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"signers"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(a.p,{children:"Array ["})})}),(0,l.jsx)(p.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,l.jsx)(p.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"widgets"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(a.p,{children:"Array ["})})}),(0,l.jsx)(p.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(a.p,{children:"]"})})})]})]})}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(a.p,{children:"]"})})})]})]})}),(0,l.jsx)(p.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!0}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!0}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"redirect_url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "objectId": "x1Hbnms2Pg",\n "title": "sample template",\n "note": "template note",\n "folder": {\n "objectId": "x1Hbnms2Pg",\n "name": "folder name"\n },\n "file": "https://templateuser.com",\n "owner": "template creator name",\n "signers": [\n {\n "role": "ceo",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871",\n "widgets": [\n {\n "type": "signature",\n "x": 244,\n "y": 71,\n "w": 38,\n "h": 46,\n "page": 1\n }\n ]\n }\n ],\n "sendInOrder": true,\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z",\n "enableTour": true,\n "redirect_url": "",\n "allow_modifications": false\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/451a5132.96a74160.js b/assets/js/451a5132.0072a94c.js similarity index 59% rename from assets/js/451a5132.96a74160.js rename to assets/js/451a5132.0072a94c.js index 6b507cfe0..0d4c59c13 100644 --- a/assets/js/451a5132.96a74160.js +++ b/assets/js/451a5132.0072a94c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7286],{12072:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>j,contentTitle:()=>x,default:()=>v,frontMatter:()=>u,metadata:()=>f,toc:()=>g});var l=a(85893),r=a(11151),i=a(58219),n=(a(62316),a(51039)),t=a.n(n),o=(a(82723),a(9487)),d=a(41429),m=a(5397),p=a(4667),c=a(9472),h=a(85162);const u={id:"folderlist",title:"Get folder list",description:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId",sidebar_label:"Get folder list",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V+tu2zYUfhWWf7YCii2nTYcZw7Bg67qsXRsgGQosNYIj6VhiTZEseeQLDP/bk+zR9iTDoaxYTpyuGbr+iSPyXL5zP1xLgjLI8ZX82eoCvZwkssCQe+VIWSPH8rJC0d6JVyqQOD0/E1g7u0AfxMo2gqzwSF7hHAUIzTR2KqYty0JRJWz7axsSDjwaauWdFTKR1qEHVnVWyLFsuViGTKQDDzUSesa3lgZqlGN5R4JilB8a9Ct5G7vN3mNOZ8UOkEykxw+N8ljI8RR0wEQGWmmMyn0tE4lLp22Bu+u8whrkeC1p5ZgukFemlElkAOqf4BJqF4XJzSa5waxVreg21E/GQb7Zg1HDUtVNLccnaZp0oExTZ+jlpodhlPYghJlynw3B/TrTzYTlBmdNwMC0x2nKP/uBCU2eYwjTRoubBJCJzK0hNMT04JxWebwYvg/MtL4LoI0vp4pnMaRalR5Do6lHB94DG6wI6/Dv/F3aPDTmrhpl1fL4vWOXtPn2Onr/YWIMLrps3SS38/2Bsn49NhBOZuocb8v6r8hCk/XQ5R6BsDilQ6J2jMfp8ZOjUXqUfnM5ejZ++u345NkgTdM/ZCKXtWbebZoWQBEpKdL978YVX0BP76A18dpjkJv+uTJaGbzuUvz6OE2vR0+YZpPIp4dy/cLWSJUypVigIbHw1pSJcBohoCC/ElCCMkIDoX/0+YoAvbf+4956GLKPeeEpe+HGCSd3nXBm5qBVEafHpZ2h+bKW9tVTq56h7ueEaonivdwztn/eGhkwb7yiVZxMyyNw6qi9H19NuAWyYy1PtBLbUUaVHMvh3nwL6OfdcLuVMgsoS/S/NFlEfNqQFb/ZfNaa1Xgtx7IicmE8HM6Vp1bSILRsVZMNclsPzz1MG61fw3wGfmgdmuFokA5SyWNhX0gAU2R2OWCioEqjIQtRBjg1nI8OcIBzD6AOBKUy5dFHuSY7t15w6Nvo7jl319Gdeonc0rex61Ntp1yFEJvUhr+nNjJvI/rGoblQpYnenY/u7A1vUee2Rl5tqELRkf/951+Ro7B5U6OhmK6PxJvGi7gP8TgDU4ipxqXKNEZi0NoubjalgFBrDEGvhDKEpQdCUahSEWjBXuFqzMFBprTiBGcyy9xe9GokDMTbCqlCz1dfed68Cpyj5roQ2lpOFdYHDdk66thiFgvrZ1OGlAgQWROUwRBEQOxY0FRgchRdLBLe38AINITeeRVQgKqZeGq9wOlU5YoFczV7yEnUYKBEVpYIxs1ecN7OVYFBeJs1gUSwuomGsMYakVoTDWIRBuInNcfWcD4skEBpLETZsIhE5LZAsS1uNsMUIsNAwrF6lWMUGgg8CY1z9DH3YiS5HoSz3HUUaF4L+7FlQeTBBJ6BLaAuNDfuc97y5hJ1FLAaiHfmneFGKpqAnABamVkYvzNH4uomzd5iFhTh5OuuHhaLxZ06eLzP80JR1WTCo7M7vjIexqrps998PJaJJPR1eDO9QD9XOW6L8B6dw0g83PZiyGMvxhqUbmvsh9sM3Be1ytEE7HXO0xfnr8RcPBmke+3pEwAPX539+Pz1xXOWy82wrb+uTUlnA9VgeqpeIHVvi20b3Svd9W6o/N8vl20nIlzS0GlQcWZE49fbfn/Vf89MElnZQHy6XmcQ8HevNxs+btfxOAVUgEz3FvJ7bTv4sjmIaIarQ6+mOeimfackB/S2TN2z5VNot++LHemEP7xi2jgUk64hs6Etz2meo+sruLMF7I3SF88vZSKhYdf2B8EsDoLtPyy9uzKrnuz9CdEC4L9s00GG7zhfXuLq+xvy9uZehq19HTW7f7LZbP4Bq/FPzg==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,f={id:"API-docs/folderlist",title:"Get folder list",description:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId",source:"@site/docs/API-docs/folderlist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/folderlist",permalink:"/docs/API-docs/folderlist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"folderlist",title:"Get folder list",description:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId",sidebar_label:"Get folder list",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V+tu2zYUfhWWf7YCii2nTYcZw7Bg67qsXRsgGQosNYIj6VhiTZEseeQLDP/bk+zR9iTDoaxYTpyuGbr+iSPyXL5zP1xLgjLI8ZX82eoCvZwkssCQe+VIWSPH8rJC0d6JVyqQOD0/E1g7u0AfxMo2gqzwSF7hHAUIzTR2KqYty0JRJWz7axsSDjwaauWdFTKR1qEHVnVWyLFsuViGTKQDDzUSesa3lgZqlGN5R4JilB8a9Ct5G7vN3mNOZ8UOkEykxw+N8ljI8RR0wEQGWmmMyn0tE4lLp22Bu+u8whrkeC1p5ZgukFemlElkAOqf4BJqF4XJzSa5waxVreg21E/GQb7Zg1HDUtVNLccnaZp0oExTZ+jlpodhlPYghJlynw3B/TrTzYTlBmdNwMC0x2nKP/uBCU2eYwjTRoubBJCJzK0hNMT04JxWebwYvg/MtL4LoI0vp4pnMaRalR5Do6lHB94DG6wI6/Dv/F3aPDTmrhpl1fL4vWOXtPn2Onr/YWIMLrps3SS38/2Bsn49NhBOZuocb8v6r8hCk/XQ5R6BsDilQ6J2jMfp8ZOjUXqUfnM5ejZ++u345NkgTdM/ZCKXtWbebZoWQBEpKdL978YVX0BP76A18dpjkJv+uTJaGbzuUvz6OE2vR0+YZpPIp4dy/cLWSJUypVigIbHw1pSJcBohoCC/ElCCMkIDoX/0+YoAvbf+4956GLKPeeEpe+HGCSd3nXBm5qBVEafHpZ2h+bKW9tVTq56h7ueEaonivdwztn/eGhkwb7yiVZxMyyNw6qi9H19NuAWyYy1PtBLbUUaVHMvh3nwL6OfdcLuVMgsoS/S/NFlEfNqQFb/ZfNaa1Xgtx7IicmE8HM6Vp1bSILRsVZMNclsPzz1MG61fw3wGfmgdmuFokA5SyWNhX0gAU2R2OWCioEqjIQtRBjg1nI8OcIBzD6AOBKUy5dFHuSY7t15w6Nvo7jl319Gdeonc0rex61Ntp1yFEJvUhr+nNjJvI/rGoblQpYnenY/u7A1vUee2Rl5tqELRkf/951+Ro7B5U6OhmK6PxJvGi7gP8TgDU4ipxqXKNEZi0NoubjalgFBrDEGvhDKEpQdCUahSEWjBXuFqzMFBprTiBGcyy9xe9GokDMTbCqlCz1dfed68Cpyj5roQ2lpOFdYHDdk66thiFgvrZ1OGlAgQWROUwRBEQOxY0FRgchRdLBLe38AINITeeRVQgKqZeGq9wOlU5YoFczV7yEnUYKBEVpYIxs1ecN7OVYFBeJs1gUSwuomGsMYakVoTDWIRBuInNcfWcD4skEBpLETZsIhE5LZAsS1uNsMUIsNAwrF6lWMUGgg8CY1z9DH3YiS5HoSz3HUUaF4L+7FlQeTBBJ6BLaAuNDfuc97y5hJ1FLAaiHfmneFGKpqAnABamVkYvzNH4uomzd5iFhTh5OuuHhaLxZ06eLzP80JR1WTCo7M7vjIexqrps998PJaJJPR1eDO9QD9XOW6L8B6dw0g83PZiyGMvxhqUbmvsh9sM3Be1ytEE7HXO0xfnr8RcPBmke+3pEwAPX539+Pz1xXOWy82wrb+uTUlnA9VgeqpeIHVvi20b3Svd9W6o/N8vl20nIlzS0GlQcWZE49fbfn/Vf89MElnZQHy6XmcQ8HevNxs+btfxOAVUgEz3FvJ7bTv4sjmIaIarQ6+mOeimfackB/S2TN2z5VNot++LHemEP7xi2jgUk64hs6Etz2meo+sruLMF7I3SF88vZSKhYdf2B8EsDoLtPyy9uzKrnuz9CdEC4L9s00GG7zhfXuLq+xvy9uZehq19HTW7f7LZbP4Bq/FPzg==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete Folder",permalink:"/docs/API-docs/deletefolder"}},j={},g=[{value:"Request",id:"request",level:2}];function y(e){const s={h2:"h2",p:"p",...(0,r.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Get folder list"})}),"\n",(0,l.jsx)(t(),{method:"get",path:"/folderlist"}),"\n",(0,l.jsx)(s.p,{children:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId"}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Query Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsxs)("ul",{children:[(0,l.jsx)(d.Z,{className:"paramsItem",param:{name:"parentFolderId",in:"query",description:"objectId of folder",required:!1,style:"form",explode:!1,schema:{type:"string",format:"string",example:""}}}),(0,l.jsx)(d.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,l.jsx)(d.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(p.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"folderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new folder"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"parentFolderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"J2nas5kiPe"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"parentFolderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new sub folder"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "result": [\n {\n "objectId": "ph1bhx2jp",\n "folderName": "new folder",\n "parentFolderId": "J2nas5kiPe",\n "parentFolderName": "new sub folder",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7286],{12072:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>j,contentTitle:()=>u,default:()=>y,frontMatter:()=>x,metadata:()=>f,toc:()=>g});var l=a(85893),r=a(11151),i=a(58219),t=(a(62316),a(51039)),n=a.n(t),o=(a(82723),a(9487)),d=a(41429),m=a(5397),c=a(4667),p=a(9472),h=a(85162);const x={id:"folderlist",title:"Get folder list",description:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId",sidebar_label:"Get folder list",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V+tu2zYUfhWWf7YCii2nTYcZw7Bg64KsQVsgGQosNYIj6VhiTZEseeQLDP/bk+zR9iTDoSxbzqVrhq5/4og8l+/cD9eSoAxyfC1/tbpALyeJLDDkXjlS1sixvKpQtHfiQgUSp2/PBdbOLtAHsbKNICs8klc4RwFCM42dimnLslBUCdv+2oaEA4+GWnnnhUykdeiBVZ0XcixbLpYhE+nAQ42EnvGtpYEa5VjekaAY5ccG/Urexm6zD5jTebEHJBPp8WOjPBZyPAUdMJGBVhqjcl/LROLSaVvg/jqvsAY5XktaOaYL5JUpZRIZgPonuITaRWFys0l2mLWqFd2G+tk4yDcHMGpYqrqp5fgkTZMOlGnqDL3c9DCM0h6EMFPuiyF4WGe6mbDc4KwJGJj2OE355zAwoclzDGHaaLFLAJnI3BpCQ0wPzmmVx4vhh8BM67sA2vhyqngWQ6pV6TE0mnp04D2wwYqwDv/O36XNY2PuqlFWLY8/OHZJm2+vo/cfJ8bgosvWTXI73x8p67djA+Fkpt7ibVn/FVlosh663CMQFqd0n6g943F6/OxolB6l312NXoyffz8+eTFI0/QPmchlrZl3m6YFUERKinT/u3HFV9DTO2hNvPEY5KZ/roxWBm+6FL85TtOb0TOm2STy+X25fmlrpEqZUizQkFh4a8pEOI0QUJBfCShBGaGB0D/5ckWA3lv/aW89DtmnvPCcvbBzwsldJ5ybOWhVxOlxZWdovq6lffXUqmeohzmhWqJ4Lw+M7Z+3RgbMG69oFSfT8gicOmrvx9cTboHsWMsTrcR2lFElx3J4MN8C+nk33Bqv5VhWRC6Mh8MApsjscmAdmqBKoyELg9zWQ3BqOB9J7uuHHODcI6gDQalMefRJrsneykuOROvsA1v3DdapV8gdduvKPtV26FQIsWds+HtqI/PWwW8cmktVmhie+ejOGH+HOrc18qZBFYqO/O8//4ochc2bGg3F7Hki3jRexPWEpwuYQkw1LlWmMRKD1naxW1wCQq0xBL0SyhCWHghFoUpFoAV7hYsjBweZ0orzjcksc3vRS9kwEO8qpAo9X33jeREqcI6a01Roa2csh6yAhmwddWwxi4X1sylDSgSIrAnKYAgiIHYsaCowOYouFgmvU2AEGkLvvAooQNVMPLVe4HSqcsWCubg85CRqMFAiK0sE42YvOG/nqsAgvM2aQCJY3URDWGONSK2JBrEIA/GLmmNrOB8WSKA0FqJsWEQiclug2NYam2EKkWEg4Vi9yjEKDQSehMY5+ph7MZLTRmvhLDcBBZq3tH5sWRB5MIFHUguoC83Ofc5bXiSijgJWA/HevDfc10QTkBNAKzML4/fmSFzv0uwdZkERTr7t6mGxWNypg6eHPGeKqiYTHp3d85XxMFZNn3338VQmktDX4c30Ev1c5bgtwgd0DiPxcNsaIY+tEWtQuq2xn24zcJvSKkcTsNfITs/eXoi5eDZIZdKr/M8APLw4//nl68uXLJd7U1t/o0E6SOP+YAPVYHqqzpC6VX/b1Q5Kd73v8f/3Q2LbiQiXNHQaVGzh0fj1tv1e958Xk0RWNhCfrtcZBPzd682Gj9vtmJtyoQJkurcfP2jbvQ+NexHNcHXfI2YOummfDck9elum7hXxObTbdX9POuEPr5g2zqika8hsaMtzmufo+gruDOWDyXb28komEhp2bX8QzOIg2P7D0rsrs+rJPpwQLQD+yzbdy/AD58srXP24I29vHmTY2tdRs/snm83mH/CpKCM=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,f={id:"API-docs/folderlist",title:"Get folder list",description:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId",source:"@site/docs/API-docs/folderlist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/folderlist",permalink:"/docs/API-docs/folderlist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"folderlist",title:"Get folder list",description:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId",sidebar_label:"Get folder list",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V+tu2zYUfhWWf7YCii2nTYcZw7Bg64KsQVsgGQosNYIj6VhiTZEseeQLDP/bk+zR9iTDoSxbzqVrhq5/4og8l+/cD9eSoAxyfC1/tbpALyeJLDDkXjlS1sixvKpQtHfiQgUSp2/PBdbOLtAHsbKNICs8klc4RwFCM42dimnLslBUCdv+2oaEA4+GWnnnhUykdeiBVZ0XcixbLpYhE+nAQ42EnvGtpYEa5VjekaAY5ccG/Urexm6zD5jTebEHJBPp8WOjPBZyPAUdMJGBVhqjcl/LROLSaVvg/jqvsAY5XktaOaYL5JUpZRIZgPonuITaRWFys0l2mLWqFd2G+tk4yDcHMGpYqrqp5fgkTZMOlGnqDL3c9DCM0h6EMFPuiyF4WGe6mbDc4KwJGJj2OE355zAwoclzDGHaaLFLAJnI3BpCQ0wPzmmVx4vhh8BM67sA2vhyqngWQ6pV6TE0mnp04D2wwYqwDv/O36XNY2PuqlFWLY8/OHZJm2+vo/cfJ8bgosvWTXI73x8p67djA+Fkpt7ibVn/FVlosh663CMQFqd0n6g943F6/OxolB6l312NXoyffz8+eTFI0/QPmchlrZl3m6YFUERKinT/u3HFV9DTO2hNvPEY5KZ/roxWBm+6FL85TtOb0TOm2STy+X25fmlrpEqZUizQkFh4a8pEOI0QUJBfCShBGaGB0D/5ckWA3lv/aW89DtmnvPCcvbBzwsldJ5ybOWhVxOlxZWdovq6lffXUqmeohzmhWqJ4Lw+M7Z+3RgbMG69oFSfT8gicOmrvx9cTboHsWMsTrcR2lFElx3J4MN8C+nk33Bqv5VhWRC6Mh8MApsjscmAdmqBKoyELg9zWQ3BqOB9J7uuHHODcI6gDQalMefRJrsneykuOROvsA1v3DdapV8gdduvKPtV26FQIsWds+HtqI/PWwW8cmktVmhie+ejOGH+HOrc18qZBFYqO/O8//4ochc2bGg3F7Hki3jRexPWEpwuYQkw1LlWmMRKD1naxW1wCQq0xBL0SyhCWHghFoUpFoAV7hYsjBweZ0orzjcksc3vRS9kwEO8qpAo9X33jeREqcI6a01Roa2csh6yAhmwddWwxi4X1sylDSgSIrAnKYAgiIHYsaCowOYouFgmvU2AEGkLvvAooQNVMPLVe4HSqcsWCubg85CRqMFAiK0sE42YvOG/nqsAgvM2aQCJY3URDWGONSK2JBrEIA/GLmmNrOB8WSKA0FqJsWEQiclug2NYam2EKkWEg4Vi9yjEKDQSehMY5+ph7MZLTRmvhLDcBBZq3tH5sWRB5MIFHUguoC83Ofc5bXiSijgJWA/HevDfc10QTkBNAKzML4/fmSFzv0uwdZkERTr7t6mGxWNypg6eHPGeKqiYTHp3d85XxMFZNn3338VQmktDX4c30Ev1c5bgtwgd0DiPxcNsaIY+tEWtQuq2xn24zcJvSKkcTsNfITs/eXoi5eDZIZdKr/M8APLw4//nl68uXLJd7U1t/o0E6SOP+YAPVYHqqzpC6VX/b1Q5Kd73v8f/3Q2LbiQiXNHQaVGzh0fj1tv1e958Xk0RWNhCfrtcZBPzd682Gj9vtmJtyoQJkurcfP2jbvQ+NexHNcHXfI2YOummfDck9elum7hXxObTbdX9POuEPr5g2zqika8hsaMtzmufo+gruDOWDyXb28komEhp2bX8QzOIg2P7D0rsrs+rJPpwQLQD+yzbdy/AD58srXP24I29vHmTY2tdRs/snm83mH/CpKCM=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete Folder",permalink:"/docs/API-docs/deletefolder"}},j={},g=[{value:"Request",id:"request",level:2}];function v(e){const s={h2:"h2",p:"p",...(0,r.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Get folder list"})}),"\n",(0,l.jsx)(n(),{method:"get",path:"/folderlist"}),"\n",(0,l.jsx)(s.p,{children:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId"}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Query Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsxs)("ul",{children:[(0,l.jsx)(d.Z,{className:"paramsItem",param:{name:"parentFolderId",in:"query",description:"objectId of folder",required:!1,style:"form",explode:!1,schema:{type:"string",format:"string",example:""}}}),(0,l.jsx)(d.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,l.jsx)(d.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"folderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new folder"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"parentFolderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"J2nas5kiPe"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"parentFolderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new sub folder"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "result": [\n {\n "objectId": "ph1bhx2jp",\n "folderName": "new folder",\n "parentFolderId": "J2nas5kiPe",\n "parentFolderName": "new sub folder",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/52d5c0f9.bfb8a30b.js b/assets/js/52d5c0f9.7cfe3494.js similarity index 52% rename from assets/js/52d5c0f9.bfb8a30b.js rename to assets/js/52d5c0f9.7cfe3494.js index df916a724..c4c29b80c 100644 --- a/assets/js/52d5c0f9.bfb8a30b.js +++ b/assets/js/52d5c0f9.7cfe3494.js @@ -1 +1 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8468],{65313:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>y,contentTitle:()=>x,default:()=>g,frontMatter:()=>h,metadata:()=>j,toc:()=>f});var l=a(85893),n=a(11151),t=a(58219),i=(a(62316),a(51039)),r=a.n(i),o=(a(82723),a(9487)),d=a(41429),c=a(5397),m=a(4667),p=a(9472),u=a(85162);const h={id:"deletedocument",title:"Delete Document",description:"The Delete document API allows you to remove specific document from your documents.",sidebar_label:"Delete Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vttu20YQ/ZXNvjQBaEm+JEWJoqhbG4mRNDFqFwHqCMaQHJIbL3c3u0tKgsC3fkk/rV9SzJKUKFsxEqDNiy2SZ+4zZ2bNPRSOxzf8TKd1hco7Po94hi61wnihFY/5dYnsDCV6ZFmPYqeXFwyk1AvHVrpmXjOLlW6QOYOpyEW6heZWVwSym1duwiOuDVogCxcZj3kW9A8AHnEDFir0aMm7NVdQIcF6wK3IeMQFeWfAl/y+y5dWNyJDppOPmPqLjOl865DXrDPHI27xUy0sZjz2tsaIO7+SZMiJykgC4NJInSGPc5COAGmJFfB4zf3KBKS3QhU84rm2FfjxG1xC0BJzUx4l5RG4jLftnKw6o5VDR3qOZjP6txvAUI7e04y5Ok3RubyWcvWERzzVylOm4jUHY6RIQy6nHx2Jrx+62WWCEmsp8150xocE7Qto6/4vS3LevDLHvI2GWp36x4WOZkfHB4ezg9n314cv4pMf4ucvJrPZ7E8e8WUlSXYoKngkvV54uX1uH8C6mo2B/ZuWwCf70nilK/SlUAVbUDIXVqsiYkYiOGTerhgUIBST4NH+h1lFa7V9PDtf51k7ilooKRTeDj10ezKb3R5uknDySC8p7Vmua5V921D32X88oJPb401Azx8GdKEakCILJHSt71B923jG5n1n/mG3ig4UvvOdYMfvuyAdprUVfhWYbnkARhx03+ObOdEFdYresmRgR1/ymE8HTpuuR8zYclJpm4E7743EAooC7as6CQGc1l6z33R610VZW8ljXnpvXDydNsL6TtPEdWJlnUxSXU0vLRAVvYXmDuxUG1TTw8lsMuNttL6nxIHKEr2cEMiJQklIXNABRkybwz0SYMxXoJ2HQqji4FGp+TbLV9QJXbF3cr0pORjxGlc8Gko5RvVLp0TI0IayC5XrINwX+J1BdSUKFbLbHD5YTe9RprpC2kK+RDbA//nr7yAx1DF07xP2rrbM6AXavJYMVMZyiUuRSNyzgR1CJdE5uWJCeSws0MYWhfAgGWWF2CYFA4mQgvqdYLpbzaORcRP2vkRfoqVP31lkwDJsUNKYMKk1tQrZg9rrCsZXwULbu5xcihiwpHZCoXPMIQ4iqEpQKbKhFhHTloFiqDxaY4VDBqIicK4twzwXqSDFNNwWUs8qUFAgGYsY+U1ZMN2yd8zqpHaeOS3rEAhZrBB9F6JCzNyEnYkGu8DDSYIehMSMFTWpiFiqM2T9rFMYKmMJOs8MmRcpBqXOg/VMYoM29F6oJM0DM5pISICki2NcW1LkLShHZ0J/DvWl2aTPWE07PtjIYDVhH9QHRYuC1Q6pAaRQdy7+oA7YzabN3mPihMf502EeFovFgzl4tivzUviyTphFo7dyRXgZpmYsvnl4xiPu0VbuXX6FthEp9kP4GZvTAJ721AxpoGasQMhuxn6+L0A0KUWKyuGISE9fXr5hDTuezHbo6Qscnr65+PX87dU56SUy7OZvoClutPMVqJGp/sg9216hO6O73u6Y/+km7gnI49JPjQQRNkeIed1T/g0f3cjx+ByeR7zUzhNkvU7A4R9Wti29/lSjpd0yj3gDVkBCPEV7QTj6nW1u289G+/T3/kx+xr74st4by8Cwiui1AVnTE4/4Ha7uXfftvI0GmiVnO8RpmqLxI9kHq35nX56dvzm/PucRh5qSN2b4u8Dw/Q8ysNe1XervfKC/tIX2CvxITfAaVz9t4N2Xzwr0IQ5oStO8bdt/AT6Bvns=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/deletedocument",title:"Delete Document",description:"The Delete document API allows you to remove specific document from your documents.",source:"@site/docs/API-docs/deletedocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/deletedocument",permalink:"/docs/API-docs/deletedocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"deletedocument",title:"Delete Document",description:"The Delete document API allows you to remove specific document from your documents.",sidebar_label:"Delete Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vttu20YQ/ZXNvjQBaEm+JEWJoqhbG4mRNDFqFwHqCMaQHJIbL3c3u0tKgsC3fkk/rV9SzJKUKFsxEqDNiy2SZ+4zZ2bNPRSOxzf8TKd1hco7Po94hi61wnihFY/5dYnsDCV6ZFmPYqeXFwyk1AvHVrpmXjOLlW6QOYOpyEW6heZWVwSym1duwiOuDVogCxcZj3kW9A8AHnEDFir0aMm7NVdQIcF6wK3IeMQFeWfAl/y+y5dWNyJDppOPmPqLjOl865DXrDPHI27xUy0sZjz2tsaIO7+SZMiJykgC4NJInSGPc5COAGmJFfB4zf3KBKS3QhU84rm2FfjxG1xC0BJzUx4l5RG4jLftnKw6o5VDR3qOZjP6txvAUI7e04y5Ok3RubyWcvWERzzVylOm4jUHY6RIQy6nHx2Jrx+62WWCEmsp8150xocE7Qto6/4vS3LevDLHvI2GWp36x4WOZkfHB4ezg9n314cv4pMf4ucvJrPZ7E8e8WUlSXYoKngkvV54uX1uH8C6mo2B/ZuWwCf70nilK/SlUAVbUDIXVqsiYkYiOGTerhgUIBST4NH+h1lFa7V9PDtf51k7ilooKRTeDj10ezKb3R5uknDySC8p7Vmua5V921D32X88oJPb401Azx8GdKEakCILJHSt71B923jG5n1n/mG3ig4UvvOdYMfvuyAdprUVfhWYbnkARhx03+ObOdEFdYresmRgR1/ymE8HTpuuR8zYclJpm4E7743EAooC7as6CQGc1l6z33R610VZW8ljXnpvXDydNsL6TtPEdWJlnUxSXU0vLRAVvYXmDuxUG1TTw8lsMuNttL6nxIHKEr2cEMiJQklIXNABRkybwz0SYMxXoJ2HQqji4FGp+TbLV9QJXbF3cr0pORjxGlc8Gko5RvVLp0TI0IayC5XrINwX+J1BdSUKFbLbHD5YTe9RprpC2kK+RDbA//nr7yAx1DF07xP2rrbM6AXavJYMVMZyiUuRSNyzgR1CJdE5uWJCeSws0MYWhfAgGWWF2CYFA4mQgvqdYLpbzaORcRP2vkRfoqVP31lkwDJsUNKYMKk1tQrZg9rrCsZXwULbu5xcihiwpHZCoXPMIQ4iqEpQKbKhFhHTloFiqDxaY4VDBqIicK4twzwXqSDFNNwWUs8qUFAgGYsY+U1ZMN2yd8zqpHaeOS3rEAhZrBB9F6JCzNyEnYkGu8DDSYIehMSMFTWpiFiqM2T9rFMYKmMJOs8MmRcpBqXOg/VMYoM29F6oJM0DM5pISICki2NcW1LkLShHZ0J/DvWl2aTPWE07PtjIYDVhH9QHRYuC1Q6pAaRQdy7+oA7YzabN3mPihMf502EeFovFgzl4tivzUviyTphFo7dyRXgZpmYsvnl4xiPu0VbuXX6FthEp9kP4GZvTAJ721AxpoGasQMhuxn6+L0A0KUWKyuGISE9fXr5hDTuezHbo6Qscnr65+PX87dU56SUy7OZvoClutPMVqJGp/sg9216hO6O73u6Y/+km7gnI49JPjQQRNkeIed1T/g0f3cjx+ByeR7zUzhNkvU7A4R9Wti29/lSjpd0yj3gDVkBCPEV7QTj6nW1u289G+/T3/kx+xr74st4by8Cwiui1AVnTE4/4Ha7uXfftvI0GmiVnO8RpmqLxI9kHq35nX56dvzm/PucRh5qSN2b4u8Dw/Q8ysNe1XervfKC/tIX2CvxITfAaVz9t4N2Xzwr0IQ5oStO8bdt/AT6Bvns=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Update Document",permalink:"/docs/API-docs/update-document"},next:{title:"Get Document list from status",permalink:"/docs/API-docs/getdocumentlist"}},y={},f=[{value:"Request",id:"request",level:2}];function v(e){const s={h2:"h2",p:"p",...(0,n.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Delete Document"})}),"\n",(0,l.jsx)(r(),{method:"delete",path:"/document/{document_id}"}),"\n",(0,l.jsx)(s.p,{children:"The Delete document API allows you to remove specific document from your documents."}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(d.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"Provide objectId of document to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(u.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Document deleted successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bxh2aspHp3"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"deletedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "objectId": "Bxh2aspHp3",\n "deletedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Document not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Document not found!"}})})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function g(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8468],{65313:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>j,toc:()=>g});var l=a(85893),t=a(11151),n=a(58219),i=(a(62316),a(51039)),d=a.n(i),r=(a(82723),a(9487)),o=a(41429),c=a(5397),m=a(4667),p=a(9472),h=a(85162);const u={id:"deletedocument",title:"Delete Document",description:"The Delete document API allows you to remove specific document from your documents.",sidebar_label:"Delete Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vttu20YQ/ZXJvjQBaEm+JEWJoqhbG6mRIAlqFwHqCMaIHJIbL3c3u0tdIPCtX9JP65cUw4tEWYqRAG1eJHJ5Zud+ZtYiYO5FfCsuTFKVpIMX00ik5BMnbZBGi1jcFAQXpCgQpB0Kzt9dASplFh5WpoJgwFFp5gTeUiIzmWyhmTMlg9zmyI9EJIwlh6zhKhWxSJv7e4CIhEWHJQVybN1aaCyJYR3gTqYiEpKtsxgK8dDkd87MZUpgZh8pCVcpmGxrUDDQqhORcPSpko5SEQdXUSR8WClW5GVpFQNoaZVJScQZKs+ApKASRbwWYWUbZHBS5yISmXElhuEJLbG5JRa2OJkVJ+hTUddT1uqt0Z4833MymfDfrgN9OjpLU/BVkpD3WaXU6omIRGJ04EjFa4HWKpk0sRx/9Cy+3jezjQQH1nHkg2yV9wE65NDW/F+WbLz9zZ6KOupzdR4eFzqZnJweHU+OJt/fHL+Iz36In78YTSaTP0UklqVi2T6pGIjvDTKo7Xu9B2tzNgR2JzWDzw6F8dqUFAqpc1hwMBfO6DwCqwg9QXArwBylBoWB3H8YVXLOuMej83WW1QOvpVZS011fQ3dnk8nd8SYIZ4/UkjYBMlPp9Nu6ekj/4w6d3Z1uHHq+79CVnqOSaUNCN+ae9Lf1Z6g+tOr3q1W2oOa72HF2eN466SmpnAyrhumWR2jlUfs9vp0yXXClmC1LNuwYChGLcc9p4/WAGWvBV7p5z52VUyIWRQjWx+OxR53OzHJkLGkvc61w5keJKcdo5Xh+LOrooQRa+xVoHzCXOj96VGq6dfqaE9PGfsf1TQbQyle0ElEf2SGqmwEFYUquyYLUmWmEu3i/taSvZa6bbM2P9ybFe1KJKYmHQigIevg/f/3dSPRhbYrpCbytHFizIJdVClCnkClaypmiAwPRE5aKvFcrkDpQ7pAHqMxlQAUcFW7+BC3OpJJcfgwz7aQcVLAfwfuCQkGOP33nCBBSmpPiqgVlzD3fEwxgFUyJwyG9MO4+Y5MiQJhVXmryHjxRL0K6QJ0Q9LmIwDhADaQDOeukJ0BZMjgzDijLZCL5Yu41h0mAEjXmxMoiYLs5CradvR6cmVU+gDeqahxhjSVRaF3URKkfwYWcU+t4syFQQKkohbziKyJITErQtR67oVOYkQ9gWb1MqLnUB3QBFM3JNbXXZJInJVjDnCBR8QIwzC1fFBxqz1O720661GzCZ53hkdvoSHE1gg/6g2behsoTF4CS+t7HH/QR3G7K7D3NvAw0fdr3w2Kx2OuDZ7syL2Uoqhk4smYrlzeHTdcMxTcvz0QkArnSv82uyc1lQl0TfkbnuAGPO6bEpGFKKlGqtsd+fijArKVkQtrTgNfOX757DXM4HU1ENOj8LzB4/Prq18s315d8L3NT23/Ho8lowkfW+FCiHqjqds6L7VK407rrLeX/TytqR0CBlmFsFcqGyBuf1x0D34rByhoPt9NpJArjA0PW6xl6+sOpuubjTxU5pvppJOboJM6Yp27XIpWen9PNqvlZb5/+3m2tz+CLF92DvvQMq5le56gqfhORuKfVg2W7ntZRT7NsbIs4TxKyYSC7N3l3xtfF5evLm0sRCaw4eEOGv28YvntgBQdN26X+1gb+5Sl0UOBHLoJXtPppA2+/fFagc7FHc5imdV3/C4jaltA=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/deletedocument",title:"Delete Document",description:"The Delete document API allows you to remove specific document from your documents.",source:"@site/docs/API-docs/deletedocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/deletedocument",permalink:"/docs/API-docs/deletedocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"deletedocument",title:"Delete Document",description:"The Delete document API allows you to remove specific document from your documents.",sidebar_label:"Delete Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vttu20YQ/ZXJvjQBaEm+JEWJoqhbG6mRIAlqFwHqCMaIHJIbL3c3u0tdIPCtX9JP65cUw4tEWYqRAG1eJHJ5Zud+ZtYiYO5FfCsuTFKVpIMX00ik5BMnbZBGi1jcFAQXpCgQpB0Kzt9dASplFh5WpoJgwFFp5gTeUiIzmWyhmTMlg9zmyI9EJIwlh6zhKhWxSJv7e4CIhEWHJQVybN1aaCyJYR3gTqYiEpKtsxgK8dDkd87MZUpgZh8pCVcpmGxrUDDQqhORcPSpko5SEQdXUSR8WClW5GVpFQNoaZVJScQZKs+ApKASRbwWYWUbZHBS5yISmXElhuEJLbG5JRa2OJkVJ+hTUddT1uqt0Z4833MymfDfrgN9OjpLU/BVkpD3WaXU6omIRGJ04EjFa4HWKpk0sRx/9Cy+3jezjQQH1nHkg2yV9wE65NDW/F+WbLz9zZ6KOupzdR4eFzqZnJweHU+OJt/fHL+Iz36In78YTSaTP0UklqVi2T6pGIjvDTKo7Xu9B2tzNgR2JzWDzw6F8dqUFAqpc1hwMBfO6DwCqwg9QXArwBylBoWB3H8YVXLOuMej83WW1QOvpVZS011fQ3dnk8nd8SYIZ4/UkjYBMlPp9Nu6ekj/4w6d3Z1uHHq+79CVnqOSaUNCN+ae9Lf1Z6g+tOr3q1W2oOa72HF2eN466SmpnAyrhumWR2jlUfs9vp0yXXClmC1LNuwYChGLcc9p4/WAGWvBV7p5z52VUyIWRQjWx+OxR53OzHJkLGkvc61w5keJKcdo5Xh+LOrooQRa+xVoHzCXOj96VGq6dfqaE9PGfsf1TQbQyle0ElEf2SGqmwEFYUquyYLUmWmEu3i/taSvZa6bbM2P9ybFe1KJKYmHQigIevg/f/3dSPRhbYrpCbytHFizIJdVClCnkClaypmiAwPRE5aKvFcrkDpQ7pAHqMxlQAUcFW7+BC3OpJJcfgwz7aQcVLAfwfuCQkGOP33nCBBSmpPiqgVlzD3fEwxgFUyJwyG9MO4+Y5MiQJhVXmryHjxRL0K6QJ0Q9LmIwDhADaQDOeukJ0BZMjgzDijLZCL5Yu41h0mAEjXmxMoiYLs5CradvR6cmVU+gDeqahxhjSVRaF3URKkfwYWcU+t4syFQQKkohbziKyJITErQtR67oVOYkQ9gWb1MqLnUB3QBFM3JNbXXZJInJVjDnCBR8QIwzC1fFBxqz1O720661GzCZ53hkdvoSHE1gg/6g2behsoTF4CS+t7HH/QR3G7K7D3NvAw0fdr3w2Kx2OuDZ7syL2Uoqhk4smYrlzeHTdcMxTcvz0QkArnSv82uyc1lQl0TfkbnuAGPO6bEpGFKKlGqtsd+fijArKVkQtrTgNfOX757DXM4HU1ENOj8LzB4/Prq18s315d8L3NT23/Ho8lowkfW+FCiHqjqds6L7VK407rrLeX/TytqR0CBlmFsFcqGyBuf1x0D34rByhoPt9NpJArjA0PW6xl6+sOpuubjTxU5pvppJOboJM6Yp27XIpWen9PNqvlZb5/+3m2tz+CLF92DvvQMq5le56gqfhORuKfVg2W7ntZRT7NsbIs4TxKyYSC7N3l3xtfF5evLm0sRCaw4eEOGv28YvntgBQdN26X+1gb+5Sl0UOBHLoJXtPppA2+/fFagc7FHc5imdV3/C4jaltA=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Update Document",permalink:"/docs/API-docs/update-document"},next:{title:"Get Document list from status",permalink:"/docs/API-docs/getdocumentlist"}},f={},g=[{value:"Request",id:"request",level:2}];function y(e){const s={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Delete Document"})}),"\n",(0,l.jsx)(d(),{method:"delete",path:"/document/{document_id}"}),"\n",(0,l.jsx)(s.p,{children:"The Delete document API allows you to remove specific document from your documents."}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(o.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"Provide objectId of document to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Document deleted successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bxh2aspHp3"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"deletedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "objectId": "Bxh2aspHp3",\n "deletedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Document not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Document not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,t.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/5a2de241.cdeb663e.js b/assets/js/5a2de241.4d9dbd85.js similarity index 54% rename from assets/js/5a2de241.cdeb663e.js rename to assets/js/5a2de241.4d9dbd85.js index 0917d0493..b3d908f23 100644 --- a/assets/js/5a2de241.cdeb663e.js +++ b/assets/js/5a2de241.4d9dbd85.js @@ -1 +1 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8163],{85763:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>j,default:()=>v,frontMatter:()=>h,metadata:()=>x,toc:()=>y});var l=s(85893),i=s(11151),t=s(58219),n=(s(62316),s(51039)),r=s.n(n),d=(s(82723),s(9487)),o=s(41429),m=s(5397),p=s(4667),c=s(9472),u=s(85162);const h={id:"update-template",title:"Update Template",description:"The Update Template API enables you to modify and update the details of a specific template.",sidebar_label:"Update Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzFWG1vI7cR/isTfukFWEuyz0lQoSjqJofcIS8Wzjoc0LNhjJYjLWMuyZBcyYKgb/0l/Wn9JcWQu9LK0jl3bdp+MWTuzPCZF8485EZEXAQx/iCmVDuNkYK4K4SkUHrlorJGjMW0InjnJEaCTgquJm+ADM40BVjbBqKF2ko1XwMaCU2WjhWBpIhKB7BzQAiOSjVXJcTWzkAUwjryyFu9kWIssmq3jyiEQ481RfIMcyMM1iTGojNwr6QohGKYDmMlnmJ/8x3vzEA6DYgVRjBEMjDqGbVo2Y6nXxvlSYpx9A0VIsS15t2Cqp1mMPTotJUkxnPUgQXKimoU442Ia5cko1dmIQoxt77GuF/Zbu+yfQrxr1auWecQ6sTbpZIEM9J2BTu3GWQXzy5H8AIjaMIQwRrqyXYOfCkKUVoTyUTeCJ3TqkxBHv4SeLfNMXQ7+4XKyBH3nJKoKPDXHPDfdpCDgylMYxHSjx1esS2EsfGzzUzYRQJPS0WrVFhBLQzESgWQtmxqdm/7JOWft8WuKvo2tqyjJXmuyGN7e22WzKfgejrpic6s1YTmqBq5quAsO2DTIqyU1u1JguvpBJbk+YSkXA3gXSAfsoynktSSAA9EoLSSYKkQqEalC1hVqqy44NdQNyECmbaG2tDRLnIDSEUMZ3AMSKpwElEBqLVdKbOAJkE7ZRik8lRGvYaVipVtIqCUitVRQ4jkwqAfxYRiF8ipbfx/HkmERaMkSYi28TC3PqEkHwpw6ZixB8qE6JuSlQPIhrOb/GBR/u28LSmEfZy6qLBQz34BZEJWR5hjiOQLaIziyPvGRZI7k/ToyCsyJZ0MQQrufWqkbcDDp8diQr5WMXSecmpQSiBNnJQAoSkrwPwdY+MpFKCMigp1KCBErF0owHqI9Mh9BaJ13DzpUYXI4FdKLigGUB+ro7fEZ6TsYZh7W6fsc2zMul8IO1zRPjE35aSq0I6POTY6whJ1cypm20JEFQ+O8n1vNtzPuNVutyznKThrQu5qF6PRcQfeTbd2InDIuALmjdbrL36/lpqXf6u5YJAXr8Pk8rXjNtNCuorPK12MLl6enY/ORt9Mz78eX/5x/NXXg9Fo9DdRiMda7/u5kG1f7qKX/+8tKKOVofsuavcXo9H9yzaUl6ei13Zr146xJWolYa5IS+A9w+8YQPLe+n9zmjyD7zn32eXO+ctnSsfYCHPbGPn/dvcUoucdvLz/ZufiV8cuvjE5ZEz9pvaBzP/Cw70//e1j3p6hHla1ykLpuzhwtr+enQxUNl7FdaKVj2fo1Fn+Pv5wx2StplhZpqSuSYCZXo7FsOsuw02vz2wF2/PLjqUeRu5mhYsF+dfNLKG/aqKFn2z5kF1svBZjUcXowng4XCofs6VByGpVMxuUth5OPHIj+hmXD+iH1pEZng9Gg5HYFpsnRgIaObOPAxbiVqxxFpINdGq4PD+hgc59hnSIuFBmcfas1t0+xDdcBjnTB4He5Rud+oHWoujy2Jdq6X1FKMmnnHN1vd1T6VddjezK4Cn/7OjnpzHKo/l6iiP2KaIQBzSwvRv0+Uy7dHK+d8NfmblNIWlr9tqRuWF0XDPL8yNY70mXtqZufnbi//z7P5JG507a5gu4bjw4uyI/b3RyfK7pUTGbYeEEbHeTC4S1phD0GpjELHxyXi1UZALXUpkSHc6UVnyEWcyytodeFwgDeF9RrMjzpz94pmWSlqT55IO29iExLgvYRFunPToGubL+Yc6QCkCYNUEZCgECUadCpkJTEnQVlogLmkx3nVeBAFXNwkz+aD5XpWLD3K88lhFqNLhIDKQAxs1RaEdDAG9nzJ2D1U1mh3y9JYrZxXR3HMB3zMaT47yY77kkMzEMRSbmbftiN4yEGYUIjrdXJWXuHNHzTW5JPp2olEk+5eAs91WFmilYP7dsKHo0gZt/BtSlZhe+lrmmPSSuB3Brbs0NF0sTiAtAK/MQxrfmDD7syuw9zYKKdPeiO+Wr1erodH95qPO9ilUzA0/O7vUWaTH1gr767h++nEbydbie35BfqpLa1vKRPYdJeNhOGyzTtEnXndw5/vJUgTu/ViWZ0G8KV99PfoQlvByMDpruJwAe/vjm21c/37xiu9zi8/nrmq9wNsQaTW+rJ68lT4/uZj82/9uPK21/ZUo/dBpVmorJ+U070T6IXpsc999V7gpR2RBZZLOZYaB3Xm+3vPxrQ57n5l0hlugVI81jL1+Q5K7hfdTtF2+7lwr4vCeakw51U8TwCElXhdyUH2j95K1oe7ctulHCiLPEtxnX2ZTt7C0cMRqehFnjqizJxWdl+xRi8m4qCjFr333q9IQkPK74zQlXYixuxa1Ib2G7S19a3wiNZtHgguWzWR6A2HDm+tPzIU3P9gc7djIkh2M1e8J/2a+TCn/iUvyB1n/eiecvH1VoQ9tJc3ruttvtvwDZLSov",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,x={id:"API-docs/update-template",title:"Update Template",description:"The Update Template API enables you to modify and update the details of a specific template.",source:"@site/docs/API-docs/update-template.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/update-template",permalink:"/docs/API-docs/update-template",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"update-template",title:"Update Template",description:"The Update Template API enables you to modify and update the details of a specific template.",sidebar_label:"Update Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzFWG1vI7cR/isTfukFWEuyz0lQoSjqJofcIS8Wzjoc0LNhjJYjLWMuyZBcyYKgb/0l/Wn9JcWQu9LK0jl3bdp+MWTuzPCZF8485EZEXAQx/iCmVDuNkYK4K4SkUHrlorJGjMW0InjnJEaCTgquJm+ADM40BVjbBqKF2ko1XwMaCU2WjhWBpIhKB7BzQAiOSjVXJcTWzkAUwjryyFu9kWIssmq3jyiEQ481RfIMcyMM1iTGojNwr6QohGKYDmMlnmJ/8x3vzEA6DYgVRjBEMjDqGbVo2Y6nXxvlSYpx9A0VIsS15t2Cqp1mMPTotJUkxnPUgQXKimoU442Ia5cko1dmIQoxt77GuF/Zbu+yfQrxr1auWecQ6sTbpZIEM9J2BTu3GWQXzy5H8AIjaMIQwRrqyXYOfCkKUVoTyUTeCJ3TqkxBHv4SeLfNMXQ7+4XKyBH3nJKoKPDXHPDfdpCDgylMYxHSjx1esS2EsfGzzUzYRQJPS0WrVFhBLQzESgWQtmxqdm/7JOWft8WuKvo2tqyjJXmuyGN7e22WzKfgejrpic6s1YTmqBq5quAsO2DTIqyU1u1JguvpBJbk+YSkXA3gXSAfsoynktSSAA9EoLSSYKkQqEalC1hVqqy44NdQNyECmbaG2tDRLnIDSEUMZ3AMSKpwElEBqLVdKbOAJkE7ZRik8lRGvYaVipVtIqCUitVRQ4jkwqAfxYRiF8ipbfx/HkmERaMkSYi28TC3PqEkHwpw6ZixB8qE6JuSlQPIhrOb/GBR/u28LSmEfZy6qLBQz34BZEJWR5hjiOQLaIziyPvGRZI7k/ToyCsyJZ0MQQrufWqkbcDDp8diQr5WMXSecmpQSiBNnJQAoSkrwPwdY+MpFKCMigp1KCBErF0owHqI9Mh9BaJ13DzpUYXI4FdKLigGUB+ro7fEZ6TsYZh7W6fsc2zMul8IO1zRPjE35aSq0I6POTY6whJ1cypm20JEFQ+O8n1vNtzPuNVutyznKThrQu5qF6PRcQfeTbd2InDIuALmjdbrL36/lpqXf6u5YJAXr8Pk8rXjNtNCuorPK12MLl6enY/ORt9Mz78eX/5x/NXXg9Fo9DdRiMda7/u5kG1f7qKX/+8tKKOVofsuavcXo9H9yzaUl6ei13Zr146xJWolYa5IS+A9w+8YQPLe+n9zmjyD7zn32eXO+ctnSsfYCHPbGPn/dvcUoucdvLz/ZufiV8cuvjE5ZEz9pvaBzP/Cw70//e1j3p6hHla1ykLpuzhwtr+enQxUNl7FdaKVj2fo1Fn+Pv5wx2StplhZpqSuSYCZXo7FsOsuw02vz2wF2/PLjqUeRu5mhYsF+dfNLKG/aqKFn2z5kF1svBZjUcXowng4XCofs6VByGpVMxuUth5OPHIj+hmXD+iH1pEZng9Gg5HYFpsnRgIaObOPAxbiVqxxFpINdGq4PD+hgc59hnSIuFBmcfas1t0+xDdcBjnTB4He5Rud+oHWoujy2Jdq6X1FKMmnnHN1vd1T6VddjezK4Cn/7OjnpzHKo/l6iiP2KaIQBzSwvRv0+Uy7dHK+d8NfmblNIWlr9tqRuWF0XDPL8yNY70mXtqZufnbi//z7P5JG507a5gu4bjw4uyI/b3RyfK7pUTGbYeEEbHeTC4S1phD0GpjELHxyXi1UZALXUpkSHc6UVnyEWcyytodeFwgDeF9RrMjzpz94pmWSlqT55IO29iExLgvYRFunPToGubL+Yc6QCkCYNUEZCgECUadCpkJTEnQVlogLmkx3nVeBAFXNwkz+aD5XpWLD3K88lhFqNLhIDKQAxs1RaEdDAG9nzJ2D1U1mh3y9JYrZxXR3HMB3zMaT47yY77kkMzEMRSbmbftiN4yEGYUIjrdXJWXuHNHzTW5JPp2olEk+5eAs91WFmilYP7dsKHo0gZt/BtSlZhe+lrmmPSSuB3Brbs0NF0sTiAtAK/MQxrfmDD7syuw9zYKKdPeiO+Wr1erodH95qPO9ilUzA0/O7vUWaTH1gr767h++nEbydbie35BfqpLa1vKRPYdJeNhOGyzTtEnXndw5/vJUgTu/ViWZ0G8KV99PfoQlvByMDpruJwAe/vjm21c/37xiu9zi8/nrmq9wNsQaTW+rJ68lT4/uZj82/9uPK21/ZUo/dBpVmorJ+U070T6IXpsc999V7gpR2RBZZLOZYaB3Xm+3vPxrQ57n5l0hlugVI81jL1+Q5K7hfdTtF2+7lwr4vCeakw51U8TwCElXhdyUH2j95K1oe7ctulHCiLPEtxnX2ZTt7C0cMRqehFnjqizJxWdl+xRi8m4qCjFr333q9IQkPK74zQlXYixuxa1Ib2G7S19a3wiNZtHgguWzWR6A2HDm+tPzIU3P9gc7djIkh2M1e8J/2a+TCn/iUvyB1n/eiecvH1VoQ9tJc3ruttvtvwDZLSov",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Template",permalink:"/docs/API-docs/get-template"},next:{title:"Delete Template",permalink:"/docs/API-docs/delete-template"}},f={},y=[{value:"Request",id:"request",level:2}];function g(e){const a={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Update Template"})}),"\n",(0,l.jsx)(r(),{method:"put",path:"/template/{template_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Update Template API enables you to modify and update the details of a specific template."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(o.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of the template that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}})})})]}),"\n",(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(a.p,{children:"Body"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(a.p,{children:"Provide below parameter to update templates (at least one parameter required)"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(p.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"template description"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(u.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template updated successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"asd2HsP4Hp"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "objectId": "asd2HsP4Hp",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Please provide valid field names!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please provide valid field names!"}})})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Please provide valid field names!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Template not found!"}})})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8163],{85763:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>j,contentTitle:()=>u,default:()=>v,frontMatter:()=>x,metadata:()=>f,toc:()=>g});var l=s(85893),i=s(11151),t=s(58219),n=(s(62316),s(51039)),d=s.n(n),r=(s(82723),s(9487)),m=s(41429),o=s(5397),p=s(4667),c=s(9472),h=s(85162);const x={id:"update-template",title:"Update Template",description:"The Update Template API enables you to modify and update the details of a specific template.",sidebar_label:"Update Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzFWG1vIzcO/iusvtwWGL8km7Y441DcXrtogxaNsfFigdsEgTzieNRoJFXU2DEMf+sv6U+7X3KgZsYev2y62+vdfQkcDUmRDynykTYiygWJyXsxw8obGZHEfSYUUh60j9pZMRGzEuGtVzIidFLwanoNaOXcIMHa1RAdVE7pYg3SKqgb6VgiKIxSGwJXgATymOtC5xBbO0ORCecxSN7qWomJaFS7fUQmvAyywoiB3dwIKysUE9EZeNBKZEKzm17GUhz7fv0t78yOdBoQSxnBIipir+fYest2Av5S64BKTGKoMRMU14Z3I115w87gkzdOoZgU0hAL5CVWUkw2Iq59koxB24XIROFCJeN+Zbu9b+wjxX84tWadQ1enwS21QpijcSvYhc1Odnh2OYIXMoJBSRGcxZ5sF8DnIhO5sxFt5I2k90bnCeTRz8S7bU5dd/OfMY+MeOCURI3EXxvAfz9ABkcmmCaC0o+dv2KbCeviJ5uZcogIAZcaV6mwSC8sxFITKJfXFYe3PUr5p22xq4q+jS3rGIWBK/LU3l6bJZtTcDOb9kTnzhmU9qQauapg0ATg0iKstDHtSYKb2RSWGPiEpFwN4S1hoEYmYI56iSAPRCB3CmGpJWAltclgVeq85IJfQ1VTBLRtDbXQ4Q65IaQihgGcOqQ0nfUoA2mMW2m7gDq5ds4wKB0wj2YNKx1LV0eQSmlWlwYooqdhH8XkxQ7ImavDf46khEWtFSqIrg5QuJC8xEAZ+HTMOAJtKYY6Z2UCVXN2Uxwsyr99cDkS7XHqUGGhnv0M0FKjLqGQFDFkUFvNyIfaR1Q7k/jkMWi0OZ6FIIH7kBppCzh9PBZTDJWO1EXKqZFKARrkpBBQnZcgm+8y1gEpA2111NJQBhRl5SkDFyDiE/cViM5z88QnTZGdX2m1wEigP1RHb5DPSN7zoQiuStlnbOy6Xwg7v6I7MjfjpGpqx0chaxNhKU19DrNtJqKOB0f5oTcbHubcardblgtI3llqutrleHzagXfTrZ0IDBlXQFEbs/7sz2upzfLvNRdJ6vJ7ml5977nNtC69is8rXY4vXw4uxoPxV7OLLydXf5188eVwPB7/U2TiqTL7fi5U25c79Jr/ewvaGm3xoUPt4XI8fnjZQnl1Dr22W/t2jC2l0QoKjUYB70l/IoAYggt/cJo8499z4XPIXfBXz5SOdREKV1v1/w73nEfPB3j18NUuxC9OQ7y2DWRM/WbuEe3/IsJ9PP3tY7M9u3pY1boRSt/FQbD99SZIwrwOOq4TrXwaSK8HzffJ+3smaxXG0jEl9XVymOnlRIy67jLa9PrMVrC9sOxYah2MmIgyRk+T0YikVXP3NHQeLXdGI+c0zF01kl6Plhdimx1rSO8/QZqiXGi7GDyrdb+P+Jaz0gB/EPcOfun1D7gWWQdrX6pl2yVKhSGlgJP9Zs9sX3cp22XlmA52bPDjCN7JuDtH2fqMTYgDVtZS9T69aJfOjttuFmtbuARJW0I3Hu0te8cFuLw4cesdmtxV2I2zTvxfv/6WNLpw0jafwU0dwLsVhqI2KfDC4JNmcsHCybHdxYpQVgaJzBqYUyxCCl4vdGQ+1TKLXHo510bziWIxx9oBeoeShvCuxFhi4E9/CcySFC7R8EEE49xjIkAOZB1dlfboCN3KhceCXcpAwrwmbZEICLFTQVtKmyN0FZZ4hLQN+/RBE4LUFQszF8Oi0Llmw9w+gswjVNLKRSIEGbDfjELbqQmCmzOVJWfqhqzxbRMxNiGmq9wQvmVynALnxebaiarhaZQ1PLntJhyGVTBHiuB5e51jQ2WjDHyxWmJIJyplkqc/eMdtTkvDjKifWzYUg7TEvbhxqEvNDr6WSKY9lFwP4c7e2VsulpqQC8Bo+0iTOzuA97sye4dz0hHvX3SnfLVanZzuzw91vtOxrOcQ0Lu93iItpl7QV9/9w3fFiKGim+IWw1Ln2LaWD+w5SsKjtvnLPDX/dPtoOsffjxW4ERudo6V+U3j13fRHWMLL4VhkvX72EQ6Pfrz+5vVPt6/ZLnfc5vxdDMfDMS95R7GStrfV0ePF8dHd7KfYf/uto+2vzLBH3kidhlQKftMOmPei1yYn/WeO+0yUjiKLbDZzSfg2mO2Wl3+pMfAYu8/EUgbNnqYp1N5X1K7hfTDsF2+6hwP4tBeTswF1U8TyCEnMvWnKj7g+errZ3m+zbpSwx43EN41fgxnb2Vs4IRg8CRuNV3mOPj4r25/o07czkYl5+wxTpRcdEeSKn4DkSkzEnbgT6WlqdwdL6xthpF3UcsHyjVkegLLmzPWn52Oanu0PDuwsJIdjtYmE/3JcZxX+xqX4A66/3ok3Xz6o0ELbSXN67rfb7b8BnPMChA==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,f={id:"API-docs/update-template",title:"Update Template",description:"The Update Template API enables you to modify and update the details of a specific template.",source:"@site/docs/API-docs/update-template.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/update-template",permalink:"/docs/API-docs/update-template",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"update-template",title:"Update Template",description:"The Update Template API enables you to modify and update the details of a specific template.",sidebar_label:"Update Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzFWG1vIzcO/iusvtwWGL8km7Y441DcXrtogxaNsfFigdsEgTzieNRoJFXU2DEMf+sv6U+7X3KgZsYev2y62+vdfQkcDUmRDynykTYiygWJyXsxw8obGZHEfSYUUh60j9pZMRGzEuGtVzIidFLwanoNaOXcIMHa1RAdVE7pYg3SKqgb6VgiKIxSGwJXgATymOtC5xBbO0ORCecxSN7qWomJaFS7fUQmvAyywoiB3dwIKysUE9EZeNBKZEKzm17GUhz7fv0t78yOdBoQSxnBIipir+fYest2Av5S64BKTGKoMRMU14Z3I115w87gkzdOoZgU0hAL5CVWUkw2Iq59koxB24XIROFCJeN+Zbu9b+wjxX84tWadQ1enwS21QpijcSvYhc1Odnh2OYIXMoJBSRGcxZ5sF8DnIhO5sxFt5I2k90bnCeTRz8S7bU5dd/OfMY+MeOCURI3EXxvAfz9ABkcmmCaC0o+dv2KbCeviJ5uZcogIAZcaV6mwSC8sxFITKJfXFYe3PUr5p22xq4q+jS3rGIWBK/LU3l6bJZtTcDOb9kTnzhmU9qQauapg0ATg0iKstDHtSYKb2RSWGPiEpFwN4S1hoEYmYI56iSAPRCB3CmGpJWAltclgVeq85IJfQ1VTBLRtDbXQ4Q65IaQihgGcOqQ0nfUoA2mMW2m7gDq5ds4wKB0wj2YNKx1LV0eQSmlWlwYooqdhH8XkxQ7ImavDf46khEWtFSqIrg5QuJC8xEAZ+HTMOAJtKYY6Z2UCVXN2Uxwsyr99cDkS7XHqUGGhnv0M0FKjLqGQFDFkUFvNyIfaR1Q7k/jkMWi0OZ6FIIH7kBppCzh9PBZTDJWO1EXKqZFKARrkpBBQnZcgm+8y1gEpA2111NJQBhRl5SkDFyDiE/cViM5z88QnTZGdX2m1wEigP1RHb5DPSN7zoQiuStlnbOy6Xwg7v6I7MjfjpGpqx0chaxNhKU19DrNtJqKOB0f5oTcbHubcardblgtI3llqutrleHzagXfTrZ0IDBlXQFEbs/7sz2upzfLvNRdJ6vJ7ml5977nNtC69is8rXY4vXw4uxoPxV7OLLydXf5188eVwPB7/U2TiqTL7fi5U25c79Jr/ewvaGm3xoUPt4XI8fnjZQnl1Dr22W/t2jC2l0QoKjUYB70l/IoAYggt/cJo8499z4XPIXfBXz5SOdREKV1v1/w73nEfPB3j18NUuxC9OQ7y2DWRM/WbuEe3/IsJ9PP3tY7M9u3pY1boRSt/FQbD99SZIwrwOOq4TrXwaSK8HzffJ+3smaxXG0jEl9XVymOnlRIy67jLa9PrMVrC9sOxYah2MmIgyRk+T0YikVXP3NHQeLXdGI+c0zF01kl6Plhdimx1rSO8/QZqiXGi7GDyrdb+P+Jaz0gB/EPcOfun1D7gWWQdrX6pl2yVKhSGlgJP9Zs9sX3cp22XlmA52bPDjCN7JuDtH2fqMTYgDVtZS9T69aJfOjttuFmtbuARJW0I3Hu0te8cFuLw4cesdmtxV2I2zTvxfv/6WNLpw0jafwU0dwLsVhqI2KfDC4JNmcsHCybHdxYpQVgaJzBqYUyxCCl4vdGQ+1TKLXHo510bziWIxx9oBeoeShvCuxFhi4E9/CcySFC7R8EEE49xjIkAOZB1dlfboCN3KhceCXcpAwrwmbZEICLFTQVtKmyN0FZZ4hLQN+/RBE4LUFQszF8Oi0Llmw9w+gswjVNLKRSIEGbDfjELbqQmCmzOVJWfqhqzxbRMxNiGmq9wQvmVynALnxebaiarhaZQ1PLntJhyGVTBHiuB5e51jQ2WjDHyxWmJIJyplkqc/eMdtTkvDjKifWzYUg7TEvbhxqEvNDr6WSKY9lFwP4c7e2VsulpqQC8Bo+0iTOzuA97sye4dz0hHvX3SnfLVanZzuzw91vtOxrOcQ0Lu93iItpl7QV9/9w3fFiKGim+IWw1Ln2LaWD+w5SsKjtvnLPDX/dPtoOsffjxW4ERudo6V+U3j13fRHWMLL4VhkvX72EQ6Pfrz+5vVPt6/ZLnfc5vxdDMfDMS95R7GStrfV0ePF8dHd7KfYf/uto+2vzLBH3kidhlQKftMOmPei1yYn/WeO+0yUjiKLbDZzSfg2mO2Wl3+pMfAYu8/EUgbNnqYp1N5X1K7hfTDsF2+6hwP4tBeTswF1U8TyCEnMvWnKj7g+errZ3m+zbpSwx43EN41fgxnb2Vs4IRg8CRuNV3mOPj4r25/o07czkYl5+wxTpRcdEeSKn4DkSkzEnbgT6WlqdwdL6xthpF3UcsHyjVkegLLmzPWn52Oanu0PDuwsJIdjtYmE/3JcZxX+xqX4A66/3ok3Xz6o0ELbSXN67rfb7b8BnPMChA==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Template",permalink:"/docs/API-docs/get-template"},next:{title:"Delete Template",permalink:"/docs/API-docs/delete-template"}},j={},g=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Update Template"})}),"\n",(0,l.jsx)(d(),{method:"put",path:"/template/{template_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Update Template API enables you to modify and update the details of a specific template."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(m.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of the template that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}})})})]}),"\n",(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(a.p,{children:"Body"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(a.p,{children:"Provide below parameter to update templates (at least one parameter required)"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(p.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"template description"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template updated successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"asd2HsP4Hp"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "objectId": "asd2HsP4Hp",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Please provide valid field names!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please provide valid field names!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Please provide valid field names!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Template not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/5c04ee3b.5ef75d8a.js b/assets/js/5c04ee3b.5ef75d8a.js new file mode 100644 index 000000000..461279d8a --- /dev/null +++ b/assets/js/5c04ee3b.5ef75d8a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9588],{44545:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>u,contentTitle:()=>x,default:()=>g,frontMatter:()=>p,metadata:()=>j,toc:()=>f});var l=a(85893),o=a(11151),i=a(58219),t=(a(62316),a(51039)),n=a.n(t),r=(a(82723),a(9487)),c=(a(41429),a(5397)),d=a(4667),h=a(9472),m=a(85162);const p={id:"get-webhook",title:"Get Webhook",description:"The Get Webhook API allow you to get webhook url",sidebar_label:"Get Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v2zYQ/itXftkKKLbTtRhgDEOLLQiCFmsBp8gHxwhO0kliTZEcSfkFhr7tl+yn7ZcMR0mO7KzBNgz7YjvHe+7uOd49zEEELL2YL8UdpZUxa7FKRE4+c9IGabSYi9uK4JoC9A7w7tMNoFJmC3vTQDBQUoBtf9g4JRJhLDlk+E0u5qKkMARPhCNvjfbkxfwgXs1m/HWab9FkGXlfNAqOcUQiMqMD6cD+aK2SWTyYfvEMOgifVVQj/wp7S2IuTPqFsiASYR2HCbJL2Rc6cvTBSV2KRNAOa6vYVIVg/Xw63ZvGXfSIi8apt73LJDO1aNtEBBkiQGolNT0M5B5ezWYP34u2ZZ/Xs9dPSX725ECbAIVpdP7iv+NHzhn3PLvz3M8R4eIHGm+e0rjRG1QyjzNxa9ak/18m4/ShS8+l7mrFOI11Ryk6xXNxQnVs70h6yhonw17Mlwexu0ArL7rz+XLVrhJRU6hMP9NcMIZKzMV0exxvT25Dzkc878LjLHnUeWp2E2NJe1lqhannOZqildPNpWiTcwRa+w+8fcBS6vLiWdTqkeKCr6Hr9AnRY7/Ryve0F8nQx7FXIiRff0WYk4s9l7owEdx396MlvZCljnezuRTnqnJHKjM1sX6EimBw/+O33yMiN1lTkw5xdF7Ax8aBNVtyrAqocygU7WSq6FGN/CBHnrBW5L3ag9SBSoeBIJelDKiAuyJ1CRlaTKWSPGzsZhjtYDSvfgJ3FYWKHB994wgQctqQ4hkFZcya4wQD2ARTxxx9zbA1bl1wSQkgpI2XmrwHTzRASFeoM4LhLhIwDlAD6UDOOukJUNbsXBgHVBQykxyYN8thFqBGjSVxsgS4bu6CdWYjc/LgTNr4AN6oJhLhjDVR6ChqotxP4Ge5oY44G3MKKBXlUDYcIoHM5AT9ojENnUNKPoDl9DKjGNQHdAEUbcjF2Ys3WTRKgTWsABIVmOLkbjlQcKh9YVzdFTRczbF91hl+AGKOHPcTuNf3esHD0njiAVBSr/38Xl/A8jhmd5R6GWj17bAP2+32yR68PMVcy1A1KTiy5hFXRmPcmjH8+MdLkYhArvYfiwW5jcyGB+MrOafRedrrImZRF6lGqbode3sOYI1SMiPtaaRi764/fYANfDeZiWS0+X+j4OmHm5+ufllccVzWpm7/LiezyYxN1vhQox6lGj3252t7eBT3f/N/Qa8sgXZhahXKqMeRzKHX0uXxgV4lojI+sOlwSNHTZ6fals2/NuRYoVeJ2KCTmLLgLFdtMugRi++a9ty1LCPLSr1B1XSidvYgnaj69dWtSAQ2XMlYB9dRB/sfHH040vtR7FOB7ArgT9bqvwT8wC17T/sfj+7dyVcBPb/Bm/u3atv2T/B/a9U=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/get-webhook",title:"Get Webhook",description:"The Get Webhook API allow you to get webhook url",source:"@site/docs/API-docs/get-webhook.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/get-webhook",permalink:"/docs/API-docs/get-webhook",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"get-webhook",title:"Get Webhook",description:"The Get Webhook API allow you to get webhook url",sidebar_label:"Get Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v2zYQ/itXftkKKLbTtRhgDEOLLQiCFmsBp8gHxwhO0kliTZEcSfkFhr7tl+yn7ZcMR0mO7KzBNgz7YjvHe+7uOd49zEEELL2YL8UdpZUxa7FKRE4+c9IGabSYi9uK4JoC9A7w7tMNoFJmC3vTQDBQUoBtf9g4JRJhLDlk+E0u5qKkMARPhCNvjfbkxfwgXs1m/HWab9FkGXlfNAqOcUQiMqMD6cD+aK2SWTyYfvEMOgifVVQj/wp7S2IuTPqFsiASYR2HCbJL2Rc6cvTBSV2KRNAOa6vYVIVg/Xw63ZvGXfSIi8apt73LJDO1aNtEBBkiQGolNT0M5B5ezWYP34u2ZZ/Xs9dPSX725ECbAIVpdP7iv+NHzhn3PLvz3M8R4eIHGm+e0rjRG1QyjzNxa9ak/18m4/ShS8+l7mrFOI11Ryk6xXNxQnVs70h6yhonw17Mlwexu0ArL7rz+XLVrhJRU6hMP9NcMIZKzMV0exxvT25Dzkc878LjLHnUeWp2E2NJe1lqhannOZqildPNpWiTcwRa+w+8fcBS6vLiWdTqkeKCr6Hr9AnRY7/Ryve0F8nQx7FXIiRff0WYk4s9l7owEdx396MlvZCljnezuRTnqnJHKjM1sX6EimBw/+O33yMiN1lTkw5xdF7Ax8aBNVtyrAqocygU7WSq6FGN/CBHnrBW5L3ag9SBSoeBIJelDKiAuyJ1CRlaTKWSPGzsZhjtYDSvfgJ3FYWKHB994wgQctqQ4hkFZcya4wQD2ARTxxx9zbA1bl1wSQkgpI2XmrwHTzRASFeoM4LhLhIwDlAD6UDOOukJUNbsXBgHVBQykxyYN8thFqBGjSVxsgS4bu6CdWYjc/LgTNr4AN6oJhLhjDVR6ChqotxP4Ge5oY44G3MKKBXlUDYcIoHM5AT9ojENnUNKPoDl9DKjGNQHdAEUbcjF2Ys3WTRKgTWsABIVmOLkbjlQcKh9YVzdFTRczbF91hl+AGKOHPcTuNf3esHD0njiAVBSr/38Xl/A8jhmd5R6GWj17bAP2+32yR68PMVcy1A1KTiy5hFXRmPcmjH8+MdLkYhArvYfiwW5jcyGB+MrOafRedrrImZRF6lGqbode3sOYI1SMiPtaaRi764/fYANfDeZiWS0+X+j4OmHm5+ufllccVzWpm7/LiezyYxN1vhQox6lGj3252t7eBT3f/N/Qa8sgXZhahXKqMeRzKHX0uXxgV4lojI+sOlwSNHTZ6fals2/NuRYoVeJ2KCTmLLgLFdtMugRi++a9ty1LCPLSr1B1XSidvYgnaj69dWtSAQ2XMlYB9dRB/sfHH040vtR7FOB7ArgT9bqvwT8wC17T/sfj+7dyVcBPb/Bm/u3atv2T/B/a9U=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Template list",permalink:"/docs/API-docs/gettemplatelist"},next:{title:"Save or Update Webhook",permalink:"/docs/API-docs/save-update-webhook"}},u={},f=[{value:"Request",id:"request",level:2}];function b(e){const s={h2:"h2",p:"p",...(0,o.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Get Webhook"})}),"\n",(0,l.jsx)(n(),{method:"get",path:"/webhook"}),"\n",(0,l.jsx)(s.p,{children:"The Get Webhook API allow you to get webhook url"}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(m.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"webhook",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://your-webhook-url@example.com"}})})]})}),(0,l.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "webhook": "https://your-webhook-url@example.com"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(m.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"User not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"User not found!"}})})]})}),(0,l.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "User not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(m.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function g(e={}){const{wrapper:s}={...(0,o.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/5c04ee3b.88bc73b1.js b/assets/js/5c04ee3b.88bc73b1.js deleted file mode 100644 index 70d374224..000000000 --- a/assets/js/5c04ee3b.88bc73b1.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9588],{44545:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>x,contentTitle:()=>u,default:()=>k,frontMatter:()=>m,metadata:()=>j,toc:()=>b});var l=a(85893),o=a(11151),n=a(58219),i=(a(62316),a(51039)),t=a.n(i),r=(a(82723),a(9487)),d=(a(41429),a(5397)),c=a(4667),h=a(9472),p=a(85162);const m={id:"get-webhook",title:"Get Webhook",description:"The Get Webhook API allow you to get webhook url",sidebar_label:"Get Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJy9VttuGzcQ/ZUJX9oAq4vTBAWEoojRBq6RNDZgB36QBWN2d7TLiEuyJHclQdi3fkk/rV9SDHdXluTEaIuiL7ZEzpmZM5dD7UTAwovZXNxRWhqzEotE5OQzJ22QRouZuC0JLihAbwDn15eASpk1bE0NwUBBAdb9Ze2USISx5JDhl7mYiYLC4DwRjrw12pMXs514NZ3yv+N4N3WWkffLWsHej0hEZnQgHdgerVUyixeTz55BO+GzkirkT2FrScyEST9TFkQirGM3QXYh+0QPDH1wUhciEbTByio+KkOwfjaZbE3tRj1iVDv1tjcZZ6YSbZuIIEMESK2kpoeB3MOr6fThe9G2bPN6+vopyU+eHGgTYGlqnb/47/iRc8Y9z+409nNEOPmBxpunNC51g0rmcSZuzYr0/8vkMHzownOqm0oxTmPVUYpG8V4cUT0870h6ymonw1bM5juxGaGVo+5+Nl+0i0RUFErTzzQnjKEUMzFZ78fbk2vI+Yg/Ges1FgW5X+o0pnteBwO/mmzVceK9eZy7RrrQeRr7DlbWKQ/d5NrhslbqIzYrdBNjSU/OxtPxVLTJ7sSJR52nZjNmIy8LrTD10QdaOWnOvoBAa/+BtQ9YSF2MnkUtHmt6w33vWntU2X2D0cr3tBXJ0LhDq0RILmJJmJOLTZZ6aSK4b+eVJX0jCx2r25yJUxm7I5WZiliwQkkwmP/5+x8RkZusrkiHOKsv4Kp2YM2aHMsQ6hyWijYyVfQof37QP09YKfJebUHqQIXDQJDLQgZUwFWRuoAMLaZSSZ5uNjOMdnCwIH4MdyWFkhxffeMIEHJqSPFSgDKGR4XjYR1MFWP0OcPauNWSU0oAIa291OQ9eKIBQrpEnREMvUjAOEANpAM566QnQFmx8dI4oOVSZpId8yo7zAJUqLEgDpYA581VsM40MicPzqS1D+CNqiMRjlgRhY6iJsr9GH6WDXXE+TCngFJRDkXNLhLITE7QbzbT0Dmk5ANYDi8zik59QBdAUUMuzl7sJO8DWMOSI1GBWR71lh0Fh9ovjau6hIbW7MtnneEXJ8bIcTuGe32vb3hYak88AErqlZ/d6xHM92N2R6mXgRbfDvuwXq+f7MHLY8yFDGWdgiNrHnFFPIxbcwjff3kpEhHIVf5qeUOukdnwQn0l5iQaT3ohxiwKMVUoVbdjb08BLIpKZqQ9Hcjm+cX1B2jgu/H0SJ7+RsKTD5c/vft48479shh2+zfIlLDGhwr1QaiDXxena7t7fE3+zQ+RXlkCbcLEKpTxAYhkdr14z/e/CBaJKI0PfLTbpejpk1Nty8e/1eT4SVgkokEnMWXBmS/aZNAjVvsVbblqWUaWn4YGVd2J2skLePSMXLy7FYnAmjM51MFV1MH+A3sfrvT2wPexQHYJ8F/W6i8CfuCSvaftj3vz7uargJ7fYM31W7Rt+xfdp5OA",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/get-webhook",title:"Get Webhook",description:"The Get Webhook API allow you to get webhook url",source:"@site/docs/API-docs/get-webhook.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/get-webhook",permalink:"/docs/API-docs/get-webhook",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"get-webhook",title:"Get Webhook",description:"The Get Webhook API allow you to get webhook url",sidebar_label:"Get Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJy9VttuGzcQ/ZUJX9oAq4vTBAWEoojRBq6RNDZgB36QBWN2d7TLiEuyJHclQdi3fkk/rV9SDHdXluTEaIuiL7ZEzpmZM5dD7UTAwovZXNxRWhqzEotE5OQzJ22QRouZuC0JLihAbwDn15eASpk1bE0NwUBBAdb9Ze2USISx5JDhl7mYiYLC4DwRjrw12pMXs514NZ3yv+N4N3WWkffLWsHej0hEZnQgHdgerVUyixeTz55BO+GzkirkT2FrScyEST9TFkQirGM3QXYh+0QPDH1wUhciEbTByio+KkOwfjaZbE3tRj1iVDv1tjcZZ6YSbZuIIEMESK2kpoeB3MOr6fThe9G2bPN6+vopyU+eHGgTYGlqnb/47/iRc8Y9z+409nNEOPmBxpunNC51g0rmcSZuzYr0/8vkMHzownOqm0oxTmPVUYpG8V4cUT0870h6ymonw1bM5juxGaGVo+5+Nl+0i0RUFErTzzQnjKEUMzFZ78fbk2vI+Yg/Ges1FgW5X+o0pnteBwO/mmzVceK9eZy7RrrQeRr7DlbWKQ/d5NrhslbqIzYrdBNjSU/OxtPxVLTJ7sSJR52nZjNmIy8LrTD10QdaOWnOvoBAa/+BtQ9YSF2MnkUtHmt6w33vWntU2X2D0cr3tBXJ0LhDq0RILmJJmJOLTZZ6aSK4b+eVJX0jCx2r25yJUxm7I5WZiliwQkkwmP/5+x8RkZusrkiHOKsv4Kp2YM2aHMsQ6hyWijYyVfQof37QP09YKfJebUHqQIXDQJDLQgZUwFWRuoAMLaZSSZ5uNjOMdnCwIH4MdyWFkhxffeMIEHJqSPFSgDKGR4XjYR1MFWP0OcPauNWSU0oAIa291OQ9eKIBQrpEnREMvUjAOEANpAM566QnQFmx8dI4oOVSZpId8yo7zAJUqLEgDpYA581VsM40MicPzqS1D+CNqiMRjlgRhY6iJsr9GH6WDXXE+TCngFJRDkXNLhLITE7QbzbT0Dmk5ANYDi8zik59QBdAUUMuzl7sJO8DWMOSI1GBWR71lh0Fh9ovjau6hIbW7MtnneEXJ8bIcTuGe32vb3hYak88AErqlZ/d6xHM92N2R6mXgRbfDvuwXq+f7MHLY8yFDGWdgiNrHnFFPIxbcwjff3kpEhHIVf5qeUOukdnwQn0l5iQaT3ohxiwKMVUoVbdjb08BLIpKZqQ9Hcjm+cX1B2jgu/H0SJ7+RsKTD5c/vft48479shh2+zfIlLDGhwr1QaiDXxena7t7fE3+zQ+RXlkCbcLEKpTxAYhkdr14z/e/CBaJKI0PfLTbpejpk1Nty8e/1eT4SVgkokEnMWXBmS/aZNAjVvsVbblqWUaWn4YGVd2J2skLePSMXLy7FYnAmjM51MFV1MH+A3sfrvT2wPexQHYJ8F/W6i8CfuCSvaftj3vz7uargJ7fYM31W7Rt+xfdp5OA",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Template list",permalink:"/docs/API-docs/gettemplatelist"},next:{title:"Save or Update Webhook",permalink:"/docs/API-docs/save-update-webhook"}},x={},b=[{value:"Request",id:"request",level:2}];function f(e){const s={h2:"h2",p:"p",...(0,o.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Get Webhook"})}),"\n",(0,l.jsx)(t(),{method:"get",path:"/webhook"}),"\n",(0,l.jsx)(s.p,{children:"The Get Webhook API allow you to get webhook url"}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(p.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"webhook",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://your-webhook-url@example.com"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "webhook": "https://your-webhook-url@example.com"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"User not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"User not found!"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "User not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function k(e={}){const{wrapper:s}={...(0,o.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/5ce9853b.efeea564.js b/assets/js/5ce9853b.28eaefb4.js similarity index 59% rename from assets/js/5ce9853b.efeea564.js rename to assets/js/5ce9853b.28eaefb4.js index 40fc8004a..76390dfe0 100644 --- a/assets/js/5ce9853b.efeea564.js +++ b/assets/js/5ce9853b.28eaefb4.js @@ -1 +1 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2542],{158:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>j,contentTitle:()=>h,default:()=>g,frontMatter:()=>u,metadata:()=>x,toc:()=>f});var l=a(85893),n=a(11151),i=a(58219),r=(a(62316),a(51039)),t=a.n(r),d=(a(82723),a(9487)),o=(a(41429),a(5397)),m=a(4667),c=a(9472),p=a(85162);const u={id:"resendrequestmail",title:"Resend request mail",description:"Resend request mail to user for signing document.",sidebar_label:"Resend request mail",hide_title:!0,hide_table_of_contents:!0,api:"eJzlV0tvGzcQ/isML22AtSSn7kUoirhOkBpJYyN2kYMtCLO7oxUjLsnwoQeEvfWX9Kf1lxTDfWhlKU7Sou2hF2FFzvvxzXDLPRSOj+/4C52FEpV3fJLwHF1mhfFCKz7m79ChypnFjwGdZyUIybxmwaFlM22ZE4USqmB5I2Jwr3jCtUELJOEy72Q0IkgCT3jz7yedb/h4yzOtPCpPn2CMFFnkHn5wZMSWu2yOJdAX8QmLOZnd6pyKnCcco+RJwv3GIB9znX7AzPOEG0vmeIGOBPSZxtuW2HkrVEFS1lAaSUfG6qXIsfOMiZxXrZojnPtxa7ljoGLUZlaXMVxoHYXQ4slBaOvo7Wwg7ufN30Gmy86AqQu1e5815CI43ygGHyx2+qIc1shhQjGPaz+c+1JSYkvwA3YBigmVyZAjm2kp9YpSvQQrIJXoGNtuu3B64SVWFdtuySu0UwUlVlWyOyB9ewdmrlVDYjFDsdzj6o5wx9id9VhxbYTdTHPwzUGmSwNq0zegLtJpsLKqBnsR3kU0bUrxb4WThPyPY1klPNrOx9zGpt9FtqLLXfd6GzAeOKOVq1vz2WgUO3Qv4Dz5cnB4vPMtuiCPdkydo+MwUHcJ9b8LWYbOzYKUm8Ger0JJoXDaOjN9NhpNT0fkcpXws3/WK7RW26916kaX6OdUgCvybGW1Kh536Ww0mj7rPDo79OhkB5RKezbTQeVMzPrwyYSLd5m2FjMaFSc1Pu4xNMiZ11d1WzWMJhZVBKsaSJkUzjO90xLx87+M7JEgaPvAy89F+mx62kX6+8NIX6olSJGz8+tLdqsXqJ78Cz7vPOyr97V6MnVdxqlIQBGdikTxnu852z+vnXSYBSv8ho/vtnx9Akac1Pfju0k1STiVqqY9wmgXLQY/52M+3CEMJyF2idZFGfvhullBUaD9OaTR5PPgNftFZ4var2AlH/O598aNh8OlsL6WNHA12zykNHiH1xao8d/CcgF2qA2q4elgNBjxKtk+EOJA5aleD4iIylRC6qIMMGK4PD3CAcZ8BbXzUAhVnDzKNdnF9YZyX6d3L7pdksGI17jhSZu8PlXCBQVxjpCjjYmmknq3295etoXxYLU6uj9169PhZnOw2HC+P5njqBZqpqPlTT1dGVQ3olAxtcvTg3H9HmWmS6R9y8+RteR//PZ75Ghti83yhF0Fy4xeoZ0FyUDlbCZxLVKJkRhoaDu20YHEOYRSonOS5r3HwoJHlotCeJDdVpyBgVRIQe1FZJq4Let1qBuw93P0c7R09Y1FBizHJUrqSia1pjolfRC8LqOONp4rbRczMilhwNLghELnmENsWVDNQWXI2kJICIpAMVQerbHCIQNREjFt8jibiUyQYMISCxmtpAoKJGUJI7spCk1aHbM6Dc4zp2WIjpDGEtHXLirE3A3YC7HE2nE6zNGDkJizIpCIhGU6R9ZUAbmhcpbSMmVIvcgwCnUerGcSl2hj4cdMUjMyownzBEgaAf3ckiBvQTmC6tqgNjVd+IzVNM6jjhw2A3av7hUNRkJrKgAp1MKNaUjddWX2HlMnPE6+bZtxtVodNOHTfZ5Xws9DyiwaveMr4mFs2T579+cpT7hHW7qr2Q3apciwQYBP6BxG4mEzCaB+GbTNBkY8f8hA3SRFhsphD7fPX12/YUv23WC0h41fYPDwzeXFy7c3L0kuIXHdfy1GRuwuQfVUHXlZPmzf3rvwLz5EG4SL67iRIOIwin5tmzly19tU6fU4pyEzvuPbbQoOf6Utl44/BrQ0oSYJb3f2OJ+SFhpp8CyQcOqitvnklnQTuQw1yj4Yy4TsNcd5lqHxj9L25+D11c0tT3j7YCl1HhduWNG7GlZ8zO/5PY/P8NiZcfml8y2XoIoABdHXcgnRIVAg+uNgEcdB80GetVdq07Nyf07UrtAvOXaU4QcCkNe4+bEjr28+ydDEtqWm9E2qqvoTwR70OA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},h=void 0,x={id:"API-docs/resendrequestmail",title:"Resend request mail",description:"Resend request mail to user for signing document.",source:"@site/docs/API-docs/resendrequestmail.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/resendrequestmail",permalink:"/docs/API-docs/resendrequestmail",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"resendrequestmail",title:"Resend request mail",description:"Resend request mail to user for signing document.",sidebar_label:"Resend request mail",hide_title:!0,hide_table_of_contents:!0,api:"eJzlV0tvGzcQ/isML22AtSSn7kUoirhOkBpJYyN2kYMtCLO7oxUjLsnwoQeEvfWX9Kf1lxTDfWhlKU7Sou2hF2FFzvvxzXDLPRSOj+/4C52FEpV3fJLwHF1mhfFCKz7m79ChypnFjwGdZyUIybxmwaFlM22ZE4USqmB5I2Jwr3jCtUELJOEy72Q0IkgCT3jz7yedb/h4yzOtPCpPn2CMFFnkHn5wZMSWu2yOJdAX8QmLOZnd6pyKnCcco+RJwv3GIB9znX7AzPOEG0vmeIGOBPSZxtuW2HkrVEFS1lAaSUfG6qXIsfOMiZxXrZojnPtxa7ljoGLUZlaXMVxoHYXQ4slBaOvo7Wwg7ufN30Gmy86AqQu1e5815CI43ygGHyx2+qIc1shhQjGPaz+c+1JSYkvwA3YBigmVyZAjm2kp9YpSvQQrIJXoGNtuu3B64SVWFdtuySu0UwUlVlWyOyB9ewdmrlVDYjFDsdzj6o5wx9id9VhxbYTdTHPwzUGmSwNq0zegLtJpsLKqBnsR3kU0bUrxb4WThPyPY1klPNrOx9zGpt9FtqLLXfd6GzAeOKOVq1vz2WgUO3Qv4Dz5cnB4vPMtuiCPdkydo+MwUHcJ9b8LWYbOzYKUm8Ger0JJoXDaOjN9NhpNT0fkcpXws3/WK7RW26916kaX6OdUgCvybGW1Kh536Ww0mj7rPDo79OhkB5RKezbTQeVMzPrwyYSLd5m2FjMaFSc1Pu4xNMiZ11d1WzWMJhZVBKsaSJkUzjO90xLx87+M7JEgaPvAy89F+mx62kX6+8NIX6olSJGz8+tLdqsXqJ78Cz7vPOyr97V6MnVdxqlIQBGdikTxnu852z+vnXSYBSv8ho/vtnx9Akac1Pfju0k1STiVqqY9wmgXLQY/52M+3CEMJyF2idZFGfvhullBUaD9OaTR5PPgNftFZ4var2AlH/O598aNh8OlsL6WNHA12zykNHiH1xao8d/CcgF2qA2q4elgNBjxKtk+EOJA5aleD4iIylRC6qIMMGK4PD3CAcZ8BbXzUAhVnDzKNdnF9YZyX6d3L7pdksGI17jhSZu8PlXCBQVxjpCjjYmmknq3295etoXxYLU6uj9169PhZnOw2HC+P5njqBZqpqPlTT1dGVQ3olAxtcvTg3H9HmWmS6R9y8+RteR//PZ75Ghti83yhF0Fy4xeoZ0FyUDlbCZxLVKJkRhoaDu20YHEOYRSonOS5r3HwoJHlotCeJDdVpyBgVRIQe1FZJq4Let1qBuw93P0c7R09Y1FBizHJUrqSia1pjolfRC8LqOONp4rbRczMilhwNLghELnmENsWVDNQWXI2kJICIpAMVQerbHCIQNREjFt8jibiUyQYMISCxmtpAoKJGUJI7spCk1aHbM6Dc4zp2WIjpDGEtHXLirE3A3YC7HE2nE6zNGDkJizIpCIhGU6R9ZUAbmhcpbSMmVIvcgwCnUerGcSl2hj4cdMUjMyownzBEgaAf3ckiBvQTmC6tqgNjVd+IzVNM6jjhw2A3av7hUNRkJrKgAp1MKNaUjddWX2HlMnPE6+bZtxtVodNOHTfZ5Xws9DyiwaveMr4mFs2T579+cpT7hHW7qr2Q3apciwQYBP6BxG4mEzCaB+GbTNBkY8f8hA3SRFhsphD7fPX12/YUv23WC0h41fYPDwzeXFy7c3L0kuIXHdfy1GRuwuQfVUHXlZPmzf3rvwLz5EG4SL67iRIOIwin5tmzly19tU6fU4pyEzvuPbbQoOf6Utl44/BrQ0oSYJb3f2OJ+SFhpp8CyQcOqitvnklnQTuQw1yj4Yy4TsNcd5lqHxj9L25+D11c0tT3j7YCl1HhduWNG7GlZ8zO/5PY/P8NiZcfml8y2XoIoABdHXcgnRIVAg+uNgEcdB80GetVdq07Nyf07UrtAvOXaU4QcCkNe4+bEjr28+ydDEtqWm9E2qqvoTwR70OA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Document list from status",permalink:"/docs/API-docs/getdocumentlist"},next:{title:"Draft Template",permalink:"/docs/API-docs/drafttemplate"}},j={},f=[{value:"Request",id:"request",level:2}];function y(e){const s={h2:"h2",li:"li",p:"p",ul:"ul",...(0,n.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Resend request mail"})}),"\n",(0,l.jsx)(t(),{method:"post",path:"/resendmail"}),"\n",(0,l.jsx)(s.p,{children:"Resend request mail to user for signing document."}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(s.p,{children:"Body"})}),(0,l.jsx)("strong",{className:"openapi-schema__required",children:(0,l.jsx)(s.p,{children:"required"})})]}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"document_id",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"provide document id"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"email",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"provide user mail from signers to re-send request mail.\n",example:"user@example.com"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email subject in text/html format. Can include following variables {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body in text/html format. Can include following variables {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(p.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"result",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"mail sent successfully."}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "result": "mail sent successfully."\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Something went wrong."}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong."\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:"document not found if document id is not correct."}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:"user not found if provided user email is not present in signer list of document"}),"\n"]}),"\n"]})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"document not found or user not found."}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "document not found or user not found."\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function g(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2542],{158:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>j,contentTitle:()=>u,default:()=>b,frontMatter:()=>h,metadata:()=>x,toc:()=>g});var l=a(85893),i=a(11151),n=a(58219),r=(a(62316),a(51039)),t=a.n(r),d=(a(82723),a(9487)),o=(a(41429),a(5397)),c=a(4667),m=a(9472),p=a(85162);const h={id:"resendrequestmail",title:"Resend request mail",description:"Resend request mail to user for signing document.",sidebar_label:"Resend request mail",hide_title:!0,hide_table_of_contents:!0,api:"eJzlV9tuGzcQ/ZUJX9oAq4tT52VRFEmdIDAS1EGcIg+2IFC7oxVjLsnwogsW+9Yv6af1S4rhXrSyFCdp0fahL4ZMzu0MZ87MVszzwrH0hr3QWShRecdmCcvRZVYYL7RiKXuHDlUOFj8FdB5KLiR4DcGhhaW24EShhCogb02MbxVLmDZoOVm4zHsbrQmywBLW/vezzncsrVimlUfl6Sc3Roosak8+OgqiYi5bYcnpF+kJizmF3fmci5wlDKPlWcL8ziBLmV58xMyzhBlL4XiBjgwMldKqE3beClWQlS0vjaQjY/Va5NgjA5GzunNzQvMwb512TFTM2tLqMqYLraMUWhwdpbbJ3j4G0n7W/jvOdNkHMHehgffFQC6C861j7oPF3l+0A60dEAo8bv1k5UtJD1tyP4YLrkCoTIYcYaml1Bt66jW3gi8kOoCq6tPphZdY11BVhArtXPES6zrZH5C/gwOz0qoVsZihWB9o9Ue4V+zPBqq4NcLu5jn37UGmS8PVbhhAU6TzYGVdjw8yvM/ooi3Fv5VOMvI/zmWdsBg7S5mNTb/PbE2X++71NmA8cEYr17Tmk+k0duhBwlny9eTwcOdbdEGe7JjmjU7TQNMl1P8uZBk6twxS7sYHWIWSQuG8AzN/Mp3Oz6YEuU7Y+T+LCq3V9ltBXesS/YoKcEPINlar4mFI59Pp/EmP6PwY0WhPlEp7WOqgchDLIX2CcPEu09ZiRqNi1PDjgULLnHlz1bRVq2hiUUWyaogUpHAe9N5L5M//MrMnkqDtPZRfyvT5/KzP9NPjTF+qNZcih+dvL+G9vkP16F/AvEc4dO8b9xTqtoxTkYgigopC8Z4dgB2eNyAdZsEKv2PpTcW2I27EqLlPb2b1LGFUqpr2CKNdjJj7FUvZZM8wjIzYNVoXbQQrWcpW3huXTiaOq3yht2NtUFHVSL5wNEsn3IjJ+ozVyX0Nbsw3SDvPC6GK0YNasz3Ma3qKJtsHYPuccyNe444lXS6HUgkTVAIr5DnamHd64Xf7Zepl9073Np2T60y/zRwvGkd7BmOHgzJOTqGWOkbePu+VQXUtChWLY312ND0/oMx0ibT++BVCJ/7Hb79HjS62WLuP4CpYMHqDdhkkcJXDUuJWLCRGYU4z1MFOBzLnkJcSnZM0fj0WlnuEXBTCc9kvqRk3fCGkoGonMU3aFgYN48bwYYV+hZauvrMIHHJco6QmAan1HdnxGnjwuow+unxutL1bUkgJcFgEJxQ6Bw6xU0G14ipD6AohIWbgClB5tMYKh8BFScK0WONyKTJBhqm1Lc9oQ1S8QHKWAMVNWWif1YHVi+A8OC1DBEIeS0TfQFSIuRvDC7HGBjgd5ui5kJhDEchEApnOEdoqIBgqhwXtNobciwyjUee59SBxjTYWfnxJGopgNFGQ4JIYefi2ZMhbrhwxZxNQ9zR9+ozVNF2jj5zvxnCrbhXNKSJPKgAp1J1LaWbc9GX2ARdOeJx93zXjZrM5asLHhzqvhF+FBVg0eq9XxMPYskP1/p/HLGEebemultdo1yLDlgE+43MShSctMfNmUe+ajRvx7L4CdZMUGSqHAxp9/urtG1jDD+MpSwa08xUBT95cXrz85fol2SVibPrvbDwdT+mIqLTkauDqxIfe/fYdfKb9xe/CluHidmwkF3E2RFxVS+s3g8WRPuZWxPnpDauqBXf4Ky2ddPwpoKWBMUtYt0LHcZF01Ehz4A6Jpy6amEfvyTeJy9Cw7L0pSczeaDzPMjT+QdnhWHp7df2eJaz7fih1HvdfvqHPXL5hKbtltyx+FcfOjLsonVdMclUEXpB8Y5cYnQdKxHAc3MVx0P4gZN2V2g2iPJwTDRT6S8BOKvxIBPIadz/14s3NZxXa3HbS9Hyzuq7/BNpxzI0=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/resendrequestmail",title:"Resend request mail",description:"Resend request mail to user for signing document.",source:"@site/docs/API-docs/resendrequestmail.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/resendrequestmail",permalink:"/docs/API-docs/resendrequestmail",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"resendrequestmail",title:"Resend request mail",description:"Resend request mail to user for signing document.",sidebar_label:"Resend request mail",hide_title:!0,hide_table_of_contents:!0,api:"eJzlV9tuGzcQ/ZUJX9oAq4tT52VRFEmdIDAS1EGcIg+2IFC7oxVjLsnwogsW+9Yv6af1S4rhXrSyFCdp0fahL4ZMzu0MZ87MVszzwrH0hr3QWShRecdmCcvRZVYYL7RiKXuHDlUOFj8FdB5KLiR4DcGhhaW24EShhCogb02MbxVLmDZoOVm4zHsbrQmywBLW/vezzncsrVimlUfl6Sc3Roosak8+OgqiYi5bYcnpF+kJizmF3fmci5wlDKPlWcL8ziBLmV58xMyzhBlL4XiBjgwMldKqE3beClWQlS0vjaQjY/Va5NgjA5GzunNzQvMwb512TFTM2tLqMqYLraMUWhwdpbbJ3j4G0n7W/jvOdNkHMHehgffFQC6C861j7oPF3l+0A60dEAo8bv1k5UtJD1tyP4YLrkCoTIYcYaml1Bt66jW3gi8kOoCq6tPphZdY11BVhArtXPES6zrZH5C/gwOz0qoVsZihWB9o9Ue4V+zPBqq4NcLu5jn37UGmS8PVbhhAU6TzYGVdjw8yvM/ooi3Fv5VOMvI/zmWdsBg7S5mNTb/PbE2X++71NmA8cEYr17Tmk+k0duhBwlny9eTwcOdbdEGe7JjmjU7TQNMl1P8uZBk6twxS7sYHWIWSQuG8AzN/Mp3Oz6YEuU7Y+T+LCq3V9ltBXesS/YoKcEPINlar4mFI59Pp/EmP6PwY0WhPlEp7WOqgchDLIX2CcPEu09ZiRqNi1PDjgULLnHlz1bRVq2hiUUWyaogUpHAe9N5L5M//MrMnkqDtPZRfyvT5/KzP9NPjTF+qNZcih+dvL+G9vkP16F/AvEc4dO8b9xTqtoxTkYgigopC8Z4dgB2eNyAdZsEKv2PpTcW2I27EqLlPb2b1LGFUqpr2CKNdjJj7FUvZZM8wjIzYNVoXbQQrWcpW3huXTiaOq3yht2NtUFHVSL5wNEsn3IjJ+ozVyX0Nbsw3SDvPC6GK0YNasz3Ma3qKJtsHYPuccyNe444lXS6HUgkTVAIr5DnamHd64Xf7Zepl9073Np2T60y/zRwvGkd7BmOHgzJOTqGWOkbePu+VQXUtChWLY312ND0/oMx0ibT++BVCJ/7Hb79HjS62WLuP4CpYMHqDdhkkcJXDUuJWLCRGYU4z1MFOBzLnkJcSnZM0fj0WlnuEXBTCc9kvqRk3fCGkoGonMU3aFgYN48bwYYV+hZauvrMIHHJco6QmAan1HdnxGnjwuow+unxutL1bUkgJcFgEJxQ6Bw6xU0G14ipD6AohIWbgClB5tMYKh8BFScK0WONyKTJBhqm1Lc9oQ1S8QHKWAMVNWWif1YHVi+A8OC1DBEIeS0TfQFSIuRvDC7HGBjgd5ui5kJhDEchEApnOEdoqIBgqhwXtNobciwyjUee59SBxjTYWfnxJGopgNFGQ4JIYefi2ZMhbrhwxZxNQ9zR9+ozVNF2jj5zvxnCrbhXNKSJPKgAp1J1LaWbc9GX2ARdOeJx93zXjZrM5asLHhzqvhF+FBVg0eq9XxMPYskP1/p/HLGEebemultdo1yLDlgE+43MShSctMfNmUe+ajRvx7L4CdZMUGSqHAxp9/urtG1jDD+MpSwa08xUBT95cXrz85fol2SVibPrvbDwdT+mIqLTkauDqxIfe/fYdfKb9xe/CluHidmwkF3E2RFxVS+s3g8WRPuZWxPnpDauqBXf4Ky2ddPwpoKWBMUtYt0LHcZF01Ehz4A6Jpy6amEfvyTeJy9Cw7L0pSczeaDzPMjT+QdnhWHp7df2eJaz7fih1HvdfvqHPXL5hKbtltyx+FcfOjLsonVdMclUEXpB8Y5cYnQdKxHAc3MVx0P4gZN2V2g2iPJwTDRT6S8BOKvxIBPIadz/14s3NZxXa3HbS9Hyzuq7/BNpxzI0=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Document list from status",permalink:"/docs/API-docs/getdocumentlist"},next:{title:"Draft Template",permalink:"/docs/API-docs/drafttemplate"}},j={},g=[{value:"Request",id:"request",level:2}];function f(e){const s={h2:"h2",li:"li",p:"p",ul:"ul",...(0,i.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Resend request mail"})}),"\n",(0,l.jsx)(t(),{method:"post",path:"/resendmail"}),"\n",(0,l.jsx)(s.p,{children:"Resend request mail to user for signing document."}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(s.p,{children:"Body"})}),(0,l.jsx)("strong",{className:"openapi-schema__required",children:(0,l.jsx)(s.p,{children:"required"})})]}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"document_id",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"provide document id"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"email",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"provide user mail from signers to re-send request mail.\n",example:"user@example.com"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email subject in text/html format. Can include following variables {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body in text/html format. Can include following variables {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(p.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"result",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"mail sent successfully."}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "result": "mail sent successfully."\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Something went wrong."}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong."\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:"document not found if document id is not correct."}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:"user not found if provided user email is not present in signer list of document"}),"\n"]}),"\n"]})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"document not found or user not found."}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "document not found or user not found."\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/70853c19.77dd1140.js b/assets/js/70853c19.77dd1140.js deleted file mode 100644 index 0d9b36658..000000000 --- a/assets/js/70853c19.77dd1140.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8766],{6809:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>x,contentTitle:()=>u,default:()=>g,frontMatter:()=>p,metadata:()=>j,toc:()=>v});var l=s(85893),a=s(11151),i=s(58219),r=(s(62316),s(51039)),t=s.n(r),d=(s(82723),s(9487)),o=(s(41429),s(5397)),c=s(4667),h=s(9472),m=s(85162);const p={id:"save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allow you to save webhook url which is used to trigger events",sidebar_label:"Save or Update Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJztWe9uGzcSf5UJA7TXYC3ZqQschENR1dGlQuM/iGT4gyU41O5Iy5pLbkmuZEHQt3uSe7R7ksOQu9JKdhUHMVK3UT7E9vI3w5nhj0NyZsEcn1jWumZXOEq1vmXDiCVoYyNyJ7RiLdZPESyfImgDRZ5wh1BioX3RBS6lnsFcF+B0wM3K0cJImKUiTkFYKCwmhHBGTCZoAKeonB2oly9flr+3Bmqgjhrw6tVU4AyT1qtXAwUAcABXKSqwYqLQQBiERMdFhsqBS4UNGmAmpKwmaATZDx8+hF8W4Qf9GzAPH7AWDFhQN2BRfVyPfsPYdZMBaw3Ym/OTy9POWf+m+2bA6qixkBiUrCCX799tqVI82wadtU872yjtStSFRG4RDJJhwFXi/Q5eVj5vCdeWK+jYGg+BszR2vf6+EZJtW3vdt2ed9/ctLcOXcSE3gJ3TdvfdA8g81WpT5cUv52edehwBlus/hhuGh7X5ef6RqSpgu1zSfve00+u3Ty+2ULFB7h6EVajlQL0mApbIbQauOCcslJDPpV+pZs+/58i/RxGGkGonQYwuJikkho8dOMxySSmUUueeO39J7txDFqamsXv2NoTySSkGA/U9ZSYfj52JKSBgNK8OzM9kWdD3FZDMD9VX9tnkpy2xmtGffeYtiVnH/szTWS7xI6femlxcypJg9iMMe0Qiq6b+Clj2vFLZ43IUGifGIuZVcE467/vdf3dP2v3OA6FereaT3Mc8VP1ADE0wluIj2a/CPF3+qzTuufkcuVmtziMeCRX0SWjJIqZzNJwi2k1Yi9HL95vwPK5e0hEz+HuB1v2skzlrLbbe1RdGT0WC/pnsdHlfhLVwrJVD5UiQ57mk/Se0av5mSXrBbJxixuk3mkUYTOgVf2kkveDdPEfWKknKIpYbstYJtCRQGEk/SpB1RqgJi9hYm4y7+he847SXWYulzuW21WzOdWEOygf+QWHkTyWkEeuMLZcRc8J5gRJzMyLfl0saMmhzrWyw4fXh4f2Q9Io4RmvHhYRVdD8lErvdNmgL6R7yfO1nVdkIK5mAXVkk5y82HBSK2HRTOXXz+vDw5p+lp8cPOqczdKlQE5j5XGS0mkSQh83szBz4hAsF9DowL57OazRGm91Of5plu4JwfHh4c7QKwtH9IFzVakNcGuTJHPBOWGe/rMu77Njt4NHNbOXg8X0HLy0aUNrBWBcq+bJObc+925HjlRs/3Hejq6ZcisQ/U/v6FtWX9aQ+vQvTk6l3mU9cdAh5lzzIj7MNV+vfg5MW48IIN2et6wW7O+C5OAjjrevhchgx2gCa8niurbeYu5S1WHO2SscWzRSN9Qq2NvaM04Xil2Lk7W0XTsOpjm+DUz7ZrvLnVBgXNDVsEEuLESXP5oXhlGXO+PSWm6bOUTWPGoeNQ7aMFltKLFfJSN81CEQnt+Qj63XwXDSnRw9I8Dz/BLR1fCLU5GCn1HAd1B4tfFjbjdCuVpjn4lecs6hauToqYoKCmCJP0PhVJj69X5+cnYoV22buPotI71h7I0penOeoenRTolWaHrHtQvcVylhn6KvUKUIF/99//uslqquVJ/0LOC8M5HqGhk4ruoSNJd6JkcR1VdyuyuLIM4nWyjkI5XBi6KRPxEQ4Hl5RlHtjnvORkIK2CcE0SRuo7TTboAuvS9HQ0LcGgUOCU5S0u0BqTZSj+XjhdObnqK7GM21ux2RSBBxGhRUKrQWLWImgSrmKEao1jajczxWgcmhyIywCFxmBx9oAjsciFqSYcoLhsYOMKz5BmiwCspuikIcrjgWjR4V1YLUsvCM0Y4bogosKMbENeCOmGBynjwk6LiQmMClIRQSxThDKJSY3VAIjtA5yml7E6JVax40DiVM0nsN+JWlfQa4pdwkuQY831pYUOcOVpftPMKhamlX4cqPpGuDnSPi8AdSroGOT+hpEACnULXUwDuB6RbMrHFnhcPiPirCz2ezefvpuU+atcGkxAoO5XstN/Ee/++riqz++YxFzaDJ7Pu6hmYq4urH9wZxND26WGZ3HPqP7G3vYqz9tC9BukiJGZbGWf9tvL97BFL5vHG6kuUcY3HzXPemc9Tqkl5Jq2H9VuvM5OOOqNlWv7D9dbvSftnfwYn1C7btW+yfpvmu171p9hfzbd6323Nl3rfZdqz+BY/uu1d+UZc8rle27Vvuu1V+am39i16qsyDm8c81ccuErp2VDKBQ9r6veDTWSUiqHtq7ZYjHiFi+NXC7p8+8FGqqlDiM25UbwERXYrofLqKrjUZX0FuesxU7Ck/ygTxMTXBahJLhVQKYyZJBoxzHmbie2XrG9OO/1WcRGZZMt0wnJGD6jBhyfsRYj4viGna89+VYQfV8wydWk4BPCB71UfuQFRaFeu7z1tcvyF/KsGlLzmpWbRc3gCv1Pjj0o8C+6Tf+K8x9X8DDyhwJlbCs0rd1wuVz+H9qBG6E=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allow you to save webhook url which is used to trigger events",source:"@site/docs/API-docs/save-update-webhook.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/save-update-webhook",permalink:"/docs/API-docs/save-update-webhook",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allow you to save webhook url which is used to trigger events",sidebar_label:"Save or Update Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJztWe9uGzcSf5UJA7TXYC3ZqQschENR1dGlQuM/iGT4gyU41O5Iy5pLbkmuZEHQt3uSe7R7ksOQu9JKdhUHMVK3UT7E9vI3w5nhj0NyZsEcn1jWumZXOEq1vmXDiCVoYyNyJ7RiLdZPESyfImgDRZ5wh1BioX3RBS6lnsFcF+B0wM3K0cJImKUiTkFYKCwmhHBGTCZoAKeonB2oly9flr+3Bmqgjhrw6tVU4AyT1qtXAwUAcABXKSqwYqLQQBiERMdFhsqBS4UNGmAmpKwmaATZDx8+hF8W4Qf9GzAPH7AWDFhQN2BRfVyPfsPYdZMBaw3Ym/OTy9POWf+m+2bA6qixkBiUrCCX799tqVI82wadtU872yjtStSFRG4RDJJhwFXi/Q5eVj5vCdeWK+jYGg+BszR2vf6+EZJtW3vdt2ed9/ctLcOXcSE3gJ3TdvfdA8g81WpT5cUv52edehwBlus/hhuGh7X5ef6RqSpgu1zSfve00+u3Ty+2ULFB7h6EVajlQL0mApbIbQauOCcslJDPpV+pZs+/58i/RxGGkGonQYwuJikkho8dOMxySSmUUueeO39J7txDFqamsXv2NoTySSkGA/U9ZSYfj52JKSBgNK8OzM9kWdD3FZDMD9VX9tnkpy2xmtGffeYtiVnH/szTWS7xI6femlxcypJg9iMMe0Qiq6b+Clj2vFLZ43IUGifGIuZVcE467/vdf3dP2v3OA6FereaT3Mc8VP1ADE0wluIj2a/CPF3+qzTuufkcuVmtziMeCRX0SWjJIqZzNJwi2k1Yi9HL95vwPK5e0hEz+HuB1v2skzlrLbbe1RdGT0WC/pnsdHlfhLVwrJVD5UiQ57mk/Se0av5mSXrBbJxixuk3mkUYTOgVf2kkveDdPEfWKknKIpYbstYJtCRQGEk/SpB1RqgJi9hYm4y7+he847SXWYulzuW21WzOdWEOygf+QWHkTyWkEeuMLZcRc8J5gRJzMyLfl0saMmhzrWyw4fXh4f2Q9Io4RmvHhYRVdD8lErvdNmgL6R7yfO1nVdkIK5mAXVkk5y82HBSK2HRTOXXz+vDw5p+lp8cPOqczdKlQE5j5XGS0mkSQh83szBz4hAsF9DowL57OazRGm91Of5plu4JwfHh4c7QKwtH9IFzVakNcGuTJHPBOWGe/rMu77Njt4NHNbOXg8X0HLy0aUNrBWBcq+bJObc+925HjlRs/3Hejq6ZcisQ/U/v6FtWX9aQ+vQvTk6l3mU9cdAh5lzzIj7MNV+vfg5MW48IIN2et6wW7O+C5OAjjrevhchgx2gCa8niurbeYu5S1WHO2SscWzRSN9Qq2NvaM04Xil2Lk7W0XTsOpjm+DUz7ZrvLnVBgXNDVsEEuLESXP5oXhlGXO+PSWm6bOUTWPGoeNQ7aMFltKLFfJSN81CEQnt+Qj63XwXDSnRw9I8Dz/BLR1fCLU5GCn1HAd1B4tfFjbjdCuVpjn4lecs6hauToqYoKCmCJP0PhVJj69X5+cnYoV22buPotI71h7I0penOeoenRTolWaHrHtQvcVylhn6KvUKUIF/99//uslqquVJ/0LOC8M5HqGhk4ruoSNJd6JkcR1VdyuyuLIM4nWyjkI5XBi6KRPxEQ4Hl5RlHtjnvORkIK2CcE0SRuo7TTboAuvS9HQ0LcGgUOCU5S0u0BqTZSj+XjhdObnqK7GM21ux2RSBBxGhRUKrQWLWImgSrmKEao1jajczxWgcmhyIywCFxmBx9oAjsciFqSYcoLhsYOMKz5BmiwCspuikIcrjgWjR4V1YLUsvCM0Y4bogosKMbENeCOmGBynjwk6LiQmMClIRQSxThDKJSY3VAIjtA5yml7E6JVax40DiVM0nsN+JWlfQa4pdwkuQY831pYUOcOVpftPMKhamlX4cqPpGuDnSPi8AdSroGOT+hpEACnULXUwDuB6RbMrHFnhcPiPirCz2ezefvpuU+atcGkxAoO5XstN/Ee/++riqz++YxFzaDJ7Pu6hmYq4urH9wZxND26WGZ3HPqP7G3vYqz9tC9BukiJGZbGWf9tvL97BFL5vHG6kuUcY3HzXPemc9Tqkl5Jq2H9VuvM5OOOqNlWv7D9dbvSftnfwYn1C7btW+yfpvmu171p9hfzbd6323Nl3rfZdqz+BY/uu1d+UZc8rle27Vvuu1V+am39i16qsyDm8c81ccuErp2VDKBQ9r6veDTWSUiqHtq7ZYjHiFi+NXC7p8+8FGqqlDiM25UbwERXYrofLqKrjUZX0FuesxU7Ck/ygTxMTXBahJLhVQKYyZJBoxzHmbie2XrG9OO/1WcRGZZMt0wnJGD6jBhyfsRYj4viGna89+VYQfV8wydWk4BPCB71UfuQFRaFeu7z1tcvyF/KsGlLzmpWbRc3gCv1Pjj0o8C+6Tf+K8x9X8DDyhwJlbCs0rd1wuVz+H9qBG6E=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Webhook",permalink:"/docs/API-docs/get-webhook"},next:{title:"Delete Webhook",permalink:"/docs/API-docs/delete-webhook"}},x={},v=[{value:"events:",id:"events",level:3},{value:"Request",id:"request",level:2}];function f(e){const n={code:"code",h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(n.p,{children:"Save or Update Webhook"})}),"\n",(0,l.jsx)(t(),{method:"post",path:"/webhook"}),"\n",(0,l.jsx)(n.p,{children:"The save or update Webhook API allow you to save webhook url which is used to trigger events"}),"\n",(0,l.jsx)(n.h3,{id:"events",children:"events:"}),"\n",(0,l.jsxs)(n.ol,{children:["\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.strong,{children:"viewed:"}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsx)(n.li,{children:"When signer viewed document this event will trigger."}),"\n"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{children:'{\n "event": "viewed",\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 }\n ],\n "viewedBy": "SIGNER_EMAIL",\n "viewedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n }\n'})}),"\n"]}),"\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.strong,{children:"created:"}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsx)(n.li,{children:"When document is created this event will trigger."}),"\n"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{children:'{\n "event": "created",\n "objectId":"DOCUMENT_ID"\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "createdAt": "TIMESTAMP"\n }\n\n'})}),"\n"]}),"\n"]}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsxs)(n.li,{children:["When document is created through draft template API this event will trigger.","\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{children:'{\n "event": "created",\n "objectId":"DOCUMENT_ID"\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE",\n "url": "SIGNING_URL"\n }\n ],\n "createdAt": "TIMESTAMP"\n }\n\n'})}),"\n"]}),"\n"]}),"\n",(0,l.jsxs)(n.ol,{start:"3",children:["\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.strong,{children:"signed:"}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsx)(n.li,{children:"When document is signed by signer this event will trigger."}),"\n"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{children:'{\n "event": "signed",\n "objectId":"DOCUMENT_ID"\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signer": \n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n },\n "signedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n} \n'})}),"\n"]}),"\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.strong,{children:"completed:"}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsx)(n.li,{children:"When document is signed by all signers this event will trigger."}),"\n"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{children:'{\n "event": "completed",\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 }\n ],\n "certificate": "CERTIFICATE_URL",\n "completedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n }\n\n'})}),"\n"]}),"\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.strong,{children:"declined:"}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsx)(n.li,{children:"When document is declined by signer this event will trigger."}),"\n"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{children:'{\n "event": "declined",\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 }\n ],\n "declinedBy": "SIGNER_EMAIL",\n "declinedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n }\n\n'})}),"\n"]}),"\n"]}),"\n",(0,l.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(m.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(n.p,{children:"Body"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(n.p,{children:"Provide url to create Webhook"})})}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://your-webhook-url@example.com"}})})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(m.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(n.p,{children:"Successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(n.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"result",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Webhook updated successfully!"}})})]})}),(0,l.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "result": "Webhook updated successfully!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(m.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(n.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,l.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(m.default,{label:"401",value:"401",children:[(0,l.jsx)("div",{children:(0,l.jsx)(n.p,{children:"Webhook url already exists!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(n.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Webhook url already exists!"}})})]})}),(0,l.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Webhook url already exists!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(m.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(n.p,{children:"User not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(n.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"User not found!"}})})]})}),(0,l.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "User not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(m.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(n.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(n.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function g(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,l.jsx)(n,{...e,children:(0,l.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/70853c19.9bc6455d.js b/assets/js/70853c19.9bc6455d.js new file mode 100644 index 000000000..473cd2535 --- /dev/null +++ b/assets/js/70853c19.9bc6455d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8766],{6809:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>x,contentTitle:()=>u,default:()=>E,frontMatter:()=>p,metadata:()=>j,toc:()=>g});var a=n(85893),l=n(11151),i=n(58219),r=(n(62316),n(51039)),t=n.n(r),o=(n(82723),n(9487)),d=(n(41429),n(5397)),c=n(4667),h=n(9472),m=n(85162);const p={id:"save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allow you to save webhook url which is used to trigger events",sidebar_label:"Save or Update Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJztWe9uGzcSf5UJA7TXYC3JqQschENR19GlQuM/iGT4gyU41O5oxZpLbkmuZEHQt3uSe7R7ksOQu9JKdhUHMVK3UT7E9vI3w5nhj0NyZsEcTy1rX7MrHE20vmXDiCVoYyNyJ7RibdafIFg+RdAGijzhDqHEwvFFF7iUegZzXYDTATcrRwsjYTYR8QSEhcJiQghnRJqiAZyicnagXr58Wf7eHqiBOmzAq1dTgTNM2q9eDRQAwAFcTVCBFalCA2EQEh0XGSoHbiJs0AAzIWU1QSPIfvjwIfyyCD/o34B5+IC1YcCCugGL6uN69BvGrpsMWHvA3pyfXJ52zvo33TcDVkeNhcSgZAW5fP9uS5Xi2Tbo7Pi0s43SrkRdSOQWwSAZBlwl3u/gZeXzlnBtuYKOrfEQOEtj1+vvGyHZtrXXfXvWeX/f0jJ8GRdyA9g5Pe6+ewCZT7TaVHnxy/lZpx5HgOX6j+GG4WFtfp5/ZKoKeFwuab972un1j08vtlCxQe4ehFWo5UC9JgKWyG0GrjgnLJSQz6VfqWbPv+fIv0cRhpBqJ0GMLtIJJIaPHTjMckkplFLnnjt/Se7cQxamprF79jaE8kkpBgP1PWUmH4+diSkgYDSvDszPZFnQ9xWQzA/VV/bZ5KctsZrRn33mLYlZR/7M01ku8SOn3ppcXMqSYPYjDHtEIqum/gpY9rxS2eNyFBonxiLmVXBOOu/73X93T477nQdCvVrNJ7mPeaj6gRiaYCzFR7JfhXm6/Fdp3HPzOXKzWp1HPBIq6JPQkkVM52g4RbSbsDajl+834XlcvaQjZvD3Aq37WSdz1l5svasvjJ6KBP0z2enyvghr4Vgrh8qRIM9zSftPaNX8zZL0gtl4ghmn32gWYTChV/ylkfSCd/McWbskKYtYbshaJ9CSQGEk/ShB1hmhUhaxsTYZd/UveMdpL7M2mziX23azOdeFOSgf+AeFkT+VkEasM7ZcRswJ5wVKzM2IfF8uacigzbWywYbXrdb9kPSKOEZrx4WEVXQ/JRK73TZoC+ke8nztZ1XZCCuZgF1ZJOcvNhwUith0Uzl187rVuvln6enRg87pDN1EqBRmPhcZrdII8rCZnZkDT7lQQK8D8+LpvEZjtNnt9KdZtisIR63WzeEqCIf3g3BVqw1xaZAnc8A7YZ39si7vsmO3g4c3s5WDR/cdvLRoQGkHY12o5Ms6tT33bkeOVm78cN+NrppyKRL/TO3rW1Rf1pP69C5MT6beZT5x0SHkXfIgP842XK1/D05ajAsj3Jy1rxfs7oDn4iCMt6+Hy2HEaANoyuO5tt5i7iaszZqzVTq2aKZorFfgE+gqJ1qukpG+a+gcFR2kko8s5cMmz0VzesiW0bYEz/NPQFvHU6HSg51Sw7WPPVqHEOoNT1cB57n4FecsqgJZR0VM0PpPkCdofNBped+vD7JOtUjbZu4+GkjvWHsjymU6z1H16OJCizw9ZNt15yuUsc7QF40nCBX8f//5r5eobjqegy/gvDCQ6xkaOjzoTjSWeCdGEtdFaruqUiPPJFor5yCUw9TQwZuIVDgeHjWUCmOe85GQglhLME3SBmrEtw26f7oJGhr61iBwSHCKksgOUutb0uM08MLpzM9R3VRn2tyOyaQIOIwKKxRaCxaxEkE14SpGqNY0ouo7V4DKocmNsAhcZAQeawM4HotYkGLaoobHDjKueIo0WQRkN0UhDzcOC0aPCuvAall4R2jGDNEFFxViYhvwRkwxOE4fE3RcSEwgLUhFBLFOEMolJjdUAiO0DnKaXsTolVrHjQOJUzSew34l6TCFXFMqEVyCHm+sLSlyhitL15FgULU0q/DlRtOp7OdI+LwB1DqgU4zaDEQAKdQtNRQO4HpFsyscWeFw+I+KsLPZ7N5++m5T5q1wk2IEBnO9lkv9R7/76uKrP75jEXNoMns+7qGZiri6QP3BnE0PbpYJlsc+wfoLdNirP20L0G6SIkZlsZYOj99evIMpfN9osai2NR9hcPNd96Rz1uuQXspxYf8dNlqNFn2ilJhxVZuqV7aDLjfaQds7eLE+MPZNpP0Lcd9E2jeRvkL+7ZtIe+7sm0j7JtKfwLF9E+lvyrLnlcr2TaR9E+kvzc0/sYlUVuQc3rlmLrnwhcyyPxNqkNdVK4X6OhOqTrav2WIx4hYvjVwu6fPvBRoqbQ4jNuVG8BEV2K6Hy6iq41HR8hbnrM1OwpP8oE8TE1wWoSS4Vc+lMmSQOI5jzN1ObL2AenHe67OIjcqeV6YTkjF8Rv0wPmNtRsTx/TNfe/KdGfq+YJKrtOAp4YNeKj/ygqJQr13e+tpl+Qt5Vg2pec3KzaJmcIX+J8ceFPgX3aZ/xfmPK3gY+UOBMrYVmtZuuFwu/w8wgvPn",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allow you to save webhook url which is used to trigger events",source:"@site/docs/API-docs/save-update-webhook.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/save-update-webhook",permalink:"/docs/API-docs/save-update-webhook",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allow you to save webhook url which is used to trigger events",sidebar_label:"Save or Update Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJztWe9uGzcSf5UJA7TXYC3JqQschENR19GlQuM/iGT4gyU41O5oxZpLbkmuZEHQt3uSe7R7ksOQu9JKdhUHMVK3UT7E9vI3w5nhj0NyZsEcTy1rX7MrHE20vmXDiCVoYyNyJ7RibdafIFg+RdAGijzhDqHEwvFFF7iUegZzXYDTATcrRwsjYTYR8QSEhcJiQghnRJqiAZyicnagXr58Wf7eHqiBOmzAq1dTgTNM2q9eDRQAwAFcTVCBFalCA2EQEh0XGSoHbiJs0AAzIWU1QSPIfvjwIfyyCD/o34B5+IC1YcCCugGL6uN69BvGrpsMWHvA3pyfXJ52zvo33TcDVkeNhcSgZAW5fP9uS5Xi2Tbo7Pi0s43SrkRdSOQWwSAZBlwl3u/gZeXzlnBtuYKOrfEQOEtj1+vvGyHZtrXXfXvWeX/f0jJ8GRdyA9g5Pe6+ewCZT7TaVHnxy/lZpx5HgOX6j+GG4WFtfp5/ZKoKeFwuab972un1j08vtlCxQe4ehFWo5UC9JgKWyG0GrjgnLJSQz6VfqWbPv+fIv0cRhpBqJ0GMLtIJJIaPHTjMckkplFLnnjt/Se7cQxamprF79jaE8kkpBgP1PWUmH4+diSkgYDSvDszPZFnQ9xWQzA/VV/bZ5KctsZrRn33mLYlZR/7M01ku8SOn3ppcXMqSYPYjDHtEIqum/gpY9rxS2eNyFBonxiLmVXBOOu/73X93T477nQdCvVrNJ7mPeaj6gRiaYCzFR7JfhXm6/Fdp3HPzOXKzWp1HPBIq6JPQkkVM52g4RbSbsDajl+834XlcvaQjZvD3Aq37WSdz1l5svasvjJ6KBP0z2enyvghr4Vgrh8qRIM9zSftPaNX8zZL0gtl4ghmn32gWYTChV/ylkfSCd/McWbskKYtYbshaJ9CSQGEk/ShB1hmhUhaxsTYZd/UveMdpL7M2mziX23azOdeFOSgf+AeFkT+VkEasM7ZcRswJ5wVKzM2IfF8uacigzbWywYbXrdb9kPSKOEZrx4WEVXQ/JRK73TZoC+ke8nztZ1XZCCuZgF1ZJOcvNhwUith0Uzl187rVuvln6enRg87pDN1EqBRmPhcZrdII8rCZnZkDT7lQQK8D8+LpvEZjtNnt9KdZtisIR63WzeEqCIf3g3BVqw1xaZAnc8A7YZ39si7vsmO3g4c3s5WDR/cdvLRoQGkHY12o5Ms6tT33bkeOVm78cN+NrppyKRL/TO3rW1Rf1pP69C5MT6beZT5x0SHkXfIgP842XK1/D05ajAsj3Jy1rxfs7oDn4iCMt6+Hy2HEaANoyuO5tt5i7iaszZqzVTq2aKZorFfgE+gqJ1qukpG+a+gcFR2kko8s5cMmz0VzesiW0bYEz/NPQFvHU6HSg51Sw7WPPVqHEOoNT1cB57n4FecsqgJZR0VM0PpPkCdofNBped+vD7JOtUjbZu4+GkjvWHsjymU6z1H16OJCizw9ZNt15yuUsc7QF40nCBX8f//5r5eobjqegy/gvDCQ6xkaOjzoTjSWeCdGEtdFaruqUiPPJFor5yCUw9TQwZuIVDgeHjWUCmOe85GQglhLME3SBmrEtw26f7oJGhr61iBwSHCKksgOUutb0uM08MLpzM9R3VRn2tyOyaQIOIwKKxRaCxaxEkE14SpGqNY0ouo7V4DKocmNsAhcZAQeawM4HotYkGLaoobHDjKueIo0WQRkN0UhDzcOC0aPCuvAall4R2jGDNEFFxViYhvwRkwxOE4fE3RcSEwgLUhFBLFOEMolJjdUAiO0DnKaXsTolVrHjQOJUzSew34l6TCFXFMqEVyCHm+sLSlyhitL15FgULU0q/DlRtOp7OdI+LwB1DqgU4zaDEQAKdQtNRQO4HpFsyscWeFw+I+KsLPZ7N5++m5T5q1wk2IEBnO9lkv9R7/76uKrP75jEXNoMns+7qGZiri6QP3BnE0PbpYJlsc+wfoLdNirP20L0G6SIkZlsZYOj99evIMpfN9osai2NR9hcPNd96Rz1uuQXspxYf8dNlqNFn2ilJhxVZuqV7aDLjfaQds7eLE+MPZNpP0Lcd9E2jeRvkL+7ZtIe+7sm0j7JtKfwLF9E+lvyrLnlcr2TaR9E+kvzc0/sYlUVuQc3rlmLrnwhcyyPxNqkNdVK4X6OhOqTrav2WIx4hYvjVwu6fPvBRoqbQ4jNuVG8BEV2K6Hy6iq41HR8hbnrM1OwpP8oE8TE1wWoSS4Vc+lMmSQOI5jzN1ObL2AenHe67OIjcqeV6YTkjF8Rv0wPmNtRsTx/TNfe/KdGfq+YJKrtOAp4YNeKj/ygqJQr13e+tpl+Qt5Vg2pec3KzaJmcIX+J8ceFPgX3aZ/xfmPK3gY+UOBMrYVmtZuuFwu/w8wgvPn",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Webhook",permalink:"/docs/API-docs/get-webhook"},next:{title:"Delete Webhook",permalink:"/docs/API-docs/delete-webhook"}},x={},g=[{value:"events:",id:"events",level:3},{value:"Request",id:"request",level:2}];function v(e){const s={code:"code",h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,l.a)(),...e.components},{Details:n}=s;return n||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)("h1",{className:"openapi__heading",children:(0,a.jsx)(s.p,{children:"Save or Update Webhook"})}),"\n",(0,a.jsx)(t(),{method:"post",path:"/webhook"}),"\n",(0,a.jsx)(s.p,{children:"The save or update Webhook API allow you to save webhook url which is used to trigger events"}),"\n",(0,a.jsx)(s.h3,{id:"events",children:"events:"}),"\n",(0,a.jsxs)(s.ol,{children:["\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"viewed:"}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsx)(s.li,{children:"When signer viewed document this event will trigger."}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "event": "viewed",\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 }\n ],\n "viewedBy": "SIGNER_EMAIL",\n "viewedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n }\n'})}),"\n"]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"created:"}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsx)(s.li,{children:"When document is created this event will trigger."}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "event": "created",\n "objectId":"DOCUMENT_ID"\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "createdAt": "TIMESTAMP"\n }\n\n'})}),"\n"]}),"\n"]}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsxs)(s.li,{children:["When document is created through draft template API this event will trigger.","\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "event": "created",\n "objectId":"DOCUMENT_ID"\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE",\n "url": "SIGNING_URL"\n }\n ],\n "createdAt": "TIMESTAMP"\n }\n\n'})}),"\n"]}),"\n"]}),"\n",(0,a.jsxs)(s.ol,{start:"3",children:["\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"signed:"}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsx)(s.li,{children:"When document is signed by signer this event will trigger."}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "event": "signed",\n "objectId":"DOCUMENT_ID"\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signer": \n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n },\n "signedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n} \n'})}),"\n"]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"completed:"}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsx)(s.li,{children:"When document is signed by all signers this event will trigger."}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "event": "completed",\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 }\n ],\n "certificate": "CERTIFICATE_URL",\n "completedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n }\n\n'})}),"\n"]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"declined:"}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsx)(s.li,{children:"When document is declined by signer this event will trigger."}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "event": "declined",\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 }\n ],\n "declinedBy": "SIGNER_EMAIL",\n "declinedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n }\n\n'})}),"\n"]}),"\n"]}),"\n",(0,a.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,a.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,a.jsx)(m.default,{label:"application/json",value:"application/json-schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,a.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,a.jsx)(s.p,{children:"Body"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,a.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,a.jsx)(s.p,{children:"Provide url to create Webhook"})})}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://your-webhook-url@example.com"}})})]})})}),"\n",(0,a.jsx)("div",{children:(0,a.jsx)("div",{children:(0,a.jsxs)(i.Z,{children:[(0,a.jsxs)(m.default,{label:"200",value:"200",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Successful operation"})}),(0,a.jsx)("div",{children:(0,a.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"result",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Webhook updated successfully!"}})})]})}),(0,a.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "result": "Webhook updated successfully!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(m.default,{label:"400",value:"400",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Something went wrong, please try again later!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,a.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(m.default,{label:"401",value:"401",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Webhook url already exists!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Webhook url already exists!"}})})]})}),(0,a.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "error": "Webhook url already exists!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(m.default,{label:"404",value:"404",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"User not found!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"User not found!"}})})]})}),(0,a.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "error": "User not found!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(m.default,{label:"405",value:"405",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Invalid API Token!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,a.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function E(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,a.jsx)(s,{...e,children:(0,a.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/770b40a9.523b2d80.js b/assets/js/770b40a9.523b2d80.js new file mode 100644 index 000000000..bdf8e89b8 --- /dev/null +++ b/assets/js/770b40a9.523b2d80.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1520],{9104:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>u,default:()=>v,frontMatter:()=>x,metadata:()=>j,toc:()=>f});var i=s(85893),l=s(11151),t=s(58219),n=(s(62316),s(51039)),r=s.n(n),m=(s(82723),s(9487)),o=s(41429),c=s(5397),p=s(4667),d=s(9472),h=s(85162);const x={id:"gettemplatelist",title:"Get Template list",description:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.",sidebar_label:"Get Template list",hide_title:!0,hide_table_of_contents:!0,api:"eJzdV1tv2zYU/iunfNkKKLacWztjGBpsRRa0WAokQ4GlRkBJxxYbimRJyhcYetsv2U/bLxkOdbEcN3GzFX3YS2KR5zv3G9fM85lj4xt2jYWR3KNjk4hl6FIrjBdasTG7zhHO0UNLAm+F83D27gK4lHrhYKVL8BoseitwjsBBEoWeAp9zIXkiEXzLfwDXuXAwLVVK/LkUfgXG6rnI0AFXoOdo5wIXAS/lBhkBKp5IoWZQOrSOZKa51g5hanUBuBTO022HgEWOClKLPJxnOi0LVN4NWMS0QctJg4uMjdkMfYsi3VnEDLe8QI+W3LNmihfIxkyKQtCtIMd8KtGuWMQsfiqFxYyNp1w6jJjzK0nUU20LFjFcGqkzZGNvS7pNcyw4G69ZwZeiKAs2PonjiPmVIZAqiwQtqwjHC0OMRnEVdSq4O2G+mgYPy4yrCfF1RiuHjmgP45j+bSeHK9MUnZuWEjqPsoilWnlUnui5MVKk4WL40RFovauATj5iGtxuiY0XtUiLrpS+R8et5WSw8Fi4/fj6mCLcUTpvhZqxKLiG+/5JZztbjn5NVOEO383IJ154Ot1lsQG48KPLPEIp7feAWmoIpBWpJDO038qsOp8eU7DWBwJhtXFEp/htozCpLva5KPfeuPFw2IKphgepLgitF2rL7secFcpZt1pFzImZClX6b5PE6n2qp6i/zGEfNUKCQS0suJB7qRPEV81B6wuTa7VHzPHJ6eHo6OWLEdEvRDZD/x/sr2935W0X+hn1esxgzmWJDg6A/M59aTEC53lhBnuSr6MnpZe7zaeH7k469OHxcRWx1RNRL0bknyeCjl5WEcufCDo+pcjxGT4RN/psWV3VKX3bhrZ6jCpUpkOVXahLu90+Eq0lctUXSAOgilgoIszO/OOJdhgfHh2M4oP4xfXodHz8w/jkdBDH8R8sYssiZHczlLKm6bVKtt+lyb6JnLAZ4LUuv8x8i5mwmPrb0n62Rh/LYxIXFp/bQmdi2ow297jcMJYpUNvm9OfF/fhuR10oKRTetgP59jCOb0+JpIrYcXyyO5gv1JxLkYU97VrfoXr29cYyWqv3tOu+eF+L3zVf1EThnm0Z2z+vjXSYllb4VdjGlgfciIP6fnwzoVWlQJ/rZpUL65vP2ZgN7211Du28XelC7Lux5LjKEr0caIOKWpXkiaOWPORGDOfUae8juDFPoHaez4SaHTyKmmzsvKJY1O7esnbT5Y14g9TmG2f2qZr1MEcexnNF31MdwI2LLw0qaiAhQPPRTrt/jzLVBdKO7XOElvzvP/8KiHaVDvnzDC5LC0Yv0NIeyFUGU4lLQXv/7jPBIS8kOidXIJTHmaWhnomZ8FyGoUKresoNT4QUlHFEpgltoZe0bgDvc/Q5Wrr6ztKzI8M5SkpUkFrfhaeABl56XQQZjc6w0PZuSipFwCEpnVDoHDjEFoIq5ypFaGMRgbb0NEHl0RorHAIXBRFPtQWcTkUqiDGVl+Wph4IrPkMSFgHpTV7o3jhWJ6Xz4LQsgyEksUD0tYkKMXMD+EXMsTacDjP0XEjMYFYSiwhSnSE01UZmqAwSdB4MiRcpBqbOc+tB4hxtyL0QyWkpJRhNbUBwSY+sfmyJkbdcOeqAtUJtaDr3Gatp5Q8yMr4awAf1QV1RspQOKQGkUHdu/EEdwE2XZu8xccLj5Pu2HhaLxU4dPN/GnAuflwlYNHqDm4XDUDV9ePfxnEXMoy3c5fSKHpJpu3s+IHMYiIdNc+RpaI7N8kY19uo+gBqVFCkqh71Wdnb+7i3M4WgQs6hX+V+g8PDtxc+vf7t6TXypN9X1NxrEgzisg9r5gqueqK23eNPXtop3venz/9PHe9MCPS790EguwvRoZnnd+W/YVuefRCzXztP5ep1wh79bWVV0XD+haR5kwpG1m0f0Ha56T/6w+Nbz/0Ha5m2+IZ3QhxVEGwZV1PZkElhjztIUTV/AzmTeGm/nr69ZxHjp8+1ZcBdmQfODuLdXatXjvT0kagXoL9n0WcCPlCpvcPVTR17fPAho7GupKTSTqqr+AS2+XFw=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/gettemplatelist",title:"Get Template list",description:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.",source:"@site/docs/API-docs/gettemplatelist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/gettemplatelist",permalink:"/docs/API-docs/gettemplatelist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"gettemplatelist",title:"Get Template list",description:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.",sidebar_label:"Get Template list",hide_title:!0,hide_table_of_contents:!0,api:"eJzdV1tv2zYU/iunfNkKKLacWztjGBpsRRa0WAokQ4GlRkBJxxYbimRJyhcYetsv2U/bLxkOdbEcN3GzFX3YS2KR5zv3G9fM85lj4xt2jYWR3KNjk4hl6FIrjBdasTG7zhHO0UNLAm+F83D27gK4lHrhYKVL8BoseitwjsBBEoWeAp9zIXkiEXzLfwDXuXAwLVVK/LkUfgXG6rnI0AFXoOdo5wIXAS/lBhkBKp5IoWZQOrSOZKa51g5hanUBuBTO022HgEWOClKLPJxnOi0LVN4NWMS0QctJg4uMjdkMfYsi3VnEDLe8QI+W3LNmihfIxkyKQtCtIMd8KtGuWMQsfiqFxYyNp1w6jJjzK0nUU20LFjFcGqkzZGNvS7pNcyw4G69ZwZeiKAs2PonjiPmVIZAqiwQtqwjHC0OMRnEVdSq4O2G+mgYPy4yrCfF1RiuHjmgP45j+bSeHK9MUnZuWEjqPsoilWnlUnui5MVKk4WL40RFovauATj5iGtxuiY0XtUiLrpS+R8et5WSw8Fi4/fj6mCLcUTpvhZqxKLiG+/5JZztbjn5NVOEO383IJ154Ot1lsQG48KPLPEIp7feAWmoIpBWpJDO038qsOp8eU7DWBwJhtXFEp/htozCpLva5KPfeuPFw2IKphgepLgitF2rL7secFcpZt1pFzImZClX6b5PE6n2qp6i/zGEfNUKCQS0suJB7qRPEV81B6wuTa7VHzPHJ6eHo6OWLEdEvRDZD/x/sr2935W0X+hn1esxgzmWJDg6A/M59aTEC53lhBnuSr6MnpZe7zaeH7k469OHxcRWx1RNRL0bknyeCjl5WEcufCDo+pcjxGT4RN/psWV3VKX3bhrZ6jCpUpkOVXahLu90+Eq0lctUXSAOgilgoIszO/OOJdhgfHh2M4oP4xfXodHz8w/jkdBDH8R8sYssiZHczlLKm6bVKtt+lyb6JnLAZ4LUuv8x8i5mwmPrb0n62Rh/LYxIXFp/bQmdi2ow297jcMJYpUNvm9OfF/fhuR10oKRTetgP59jCOb0+JpIrYcXyyO5gv1JxLkYU97VrfoXr29cYyWqv3tOu+eF+L3zVf1EThnm0Z2z+vjXSYllb4VdjGlgfciIP6fnwzoVWlQJ/rZpUL65vP2ZgN7211Du28XelC7Lux5LjKEr0caIOKWpXkiaOWPORGDOfUae8juDFPoHaez4SaHTyKmmzsvKJY1O7esnbT5Y14g9TmG2f2qZr1MEcexnNF31MdwI2LLw0qaiAhQPPRTrt/jzLVBdKO7XOElvzvP/8KiHaVDvnzDC5LC0Yv0NIeyFUGU4lLQXv/7jPBIS8kOidXIJTHmaWhnomZ8FyGoUKresoNT4QUlHFEpgltoZe0bgDvc/Q5Wrr6ztKzI8M5SkpUkFrfhaeABl56XQQZjc6w0PZuSipFwCEpnVDoHDjEFoIq5ypFaGMRgbb0NEHl0RorHAIXBRFPtQWcTkUqiDGVl+Wph4IrPkMSFgHpTV7o3jhWJ6Xz4LQsgyEksUD0tYkKMXMD+EXMsTacDjP0XEjMYFYSiwhSnSE01UZmqAwSdB4MiRcpBqbOc+tB4hxtyL0QyWkpJRhNbUBwSY+sfmyJkbdcOeqAtUJtaDr3Gatp5Q8yMr4awAf1QV1RspQOKQGkUHdu/EEdwE2XZu8xccLj5Pu2HhaLxU4dPN/GnAuflwlYNHqDm4XDUDV9ePfxnEXMoy3c5fSKHpJpu3s+IHMYiIdNc+RpaI7N8kY19uo+gBqVFCkqh71Wdnb+7i3M4WgQs6hX+V+g8PDtxc+vf7t6TXypN9X1NxrEgzisg9r5gqueqK23eNPXtop3venz/9PHe9MCPS790EguwvRoZnnd+W/YVuefRCzXztP5ep1wh79bWVV0XD+haR5kwpG1m0f0Ha56T/6w+Nbz/0Ha5m2+IZ3QhxVEGwZV1PZkElhjztIUTV/AzmTeGm/nr69ZxHjp8+1ZcBdmQfODuLdXatXjvT0kagXoL9n0WcCPlCpvcPVTR17fPAho7GupKTSTqqr+AS2+XFw=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete Template",permalink:"/docs/API-docs/delete-template"},next:{title:"Get Webhook",permalink:"/docs/API-docs/get-webhook"}},g={},f=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(a.p,{children:"Get Template list"})}),"\n",(0,i.jsx)(r(),{method:"get",path:"/templatelist"}),"\n",(0,i.jsx)(a.p,{children:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents."}),"\n",(0,i.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,i.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(a.p,{children:"Query Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsxs)("ul",{children:[(0,i.jsx)(o.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,i.jsx)(o.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(t.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"successful operation"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(p.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(a.p,{children:"result"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(a.p,{children:"template[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(a.p,{children:"Array ["})})}),(0,i.jsx)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,i.jsx)(p.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"sample template"}}),(0,i.jsx)(p.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template note"}}),(0,i.jsx)(p.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(a.p,{children:"folder"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(a.p,{children:"object"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,i.jsx)(p.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder name"}})]})]})}),(0,i.jsx)(p.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,i.jsx)(p.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}}),(0,i.jsx)(p.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(a.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(a.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(a.p,{children:"Array ["})})}),(0,i.jsx)(p.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(0,i.jsx)(p.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,i.jsx)(p.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,i.jsx)(p.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,i.jsx)(p.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(a.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(a.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(a.p,{children:"Array ["})})}),(0,i.jsx)(p.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(p.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,i.jsx)(p.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,i.jsx)(p.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,i.jsx)(p.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,i.jsx)(p.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(a.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(a.p,{children:"]"})})})]})]})}),(0,i.jsx)(p.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!0}}),(0,i.jsx)(p.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,i.jsx)(p.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,i.jsx)(p.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!0}}),(0,i.jsx)(p.Z,{collapsible:!1,name:"redirect_url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(p.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(a.p,{children:"]"})})})]})]})})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "result": [\n {\n "objectId": "x1Hbnms2Pg",\n "title": "sample template",\n "note": "template note",\n "folder": {\n "objectId": "x1Hbnms2Pg",\n "name": "folder name"\n },\n "file": "https://templateuser.com",\n "owner": "template creator name",\n "signers": [\n {\n "role": "ceo",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871",\n "widgets": [\n {\n "type": "signature",\n "x": 244,\n "y": 71,\n "w": 38,\n "h": 46,\n "page": 1\n }\n ]\n }\n ],\n "sendInOrder": true,\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z",\n "enableTour": true,\n "redirect_url": "",\n "allow_modifications": false\n }\n ]\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,i.jsx)(a,{...e,children:(0,i.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/770b40a9.f67103b7.js b/assets/js/770b40a9.f67103b7.js deleted file mode 100644 index e4a54c600..000000000 --- a/assets/js/770b40a9.f67103b7.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1520],{9104:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>u,default:()=>f,frontMatter:()=>x,metadata:()=>j,toc:()=>v});var i=a(85893),l=a(11151),r=a(58219),t=(a(62316),a(51039)),n=a.n(t),m=(a(82723),a(9487)),o=a(41429),c=a(5397),d=a(4667),p=a(9472),h=a(85162);const x={id:"gettemplatelist",title:"Get Template list",description:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.",sidebar_label:"Get Template list",hide_title:!0,hide_table_of_contents:!0,api:"eJzdWFtv2zYU/iunfNkKKLacWztjGBpsRRq0awIkQ4GlQUBJxxJriuRIyhcEetsv2U/bLxkOJdlWncTNVvRhL4lNnu/cb/Qd8zx3bHzNrrA0knt07CZiGbrUCuOFVmzMrgqEU/TQkcA74TycXJwBl1LPHSx1BV6DRW8FzhA4SKLQE+AzLiRPJILv+A/gqhAOJpVKiT+Xwi/BWD0TGTrgCvQM7UzgPOClXCMjQMUTKVQOlUPrSGZaaO0QJlaXgAvhPN2uEDAvUEFqkYfzTKdVicq7AYuYNmg5aXCWsTHL0Xco0p1FzHDLS/RoyT13TPES2ZhJUQq6FeSYPyq0SxYxi39UwmLGxhMuHUbM+aUk6om2JYsYLozUGbKxtxXdpgWWnI3vWMkXoqxKNj6K44j5pSGQqsoELasJx0tDjEZxHa1UcFNhvpoGD8uM6xvi64xWDh3R7scx/esnh6vSFJ2bVBJWHmURS7XyqDzRc2OkSMPF8JMj0N22Ajr5hGlwuyU2XjQiLbpK+g06bi0ng4XH0u3GN8cU4RWl81aonEXBNdxvnqxsZ4vRm0SVbv8iJ5944el0m8Ua4MKHVeYRSmm/A9RRQyCtSSWZof1WZjX59JiCjT4QCOu1I1aK37YKk+pil4sK740bD4cdmGp4kOqS0HquenY/5qxQzrrTKmJO5CpU6b9NEqt3qZ6i/jKHfdIICQa1sORC7qROEF+1B50vTKHVDjGHR8f7o4OXL0ZEPxdZjv4/2N/cbsvrF/oJ9XrMYMZlhQ72gPzOfWUxAud5aQY7km9FT0ovtpvPBnp1skLvHx7WEVs+EfViRP55IujgZR2x4omgw2OKHM/xibjRvWV12aT0bRfa+jGqUJkOVXamzm2/fSRaS+RqUyANgDpioYgwO/GPJ9p+vH+wN4r34hdXo+Px4Q/jo+NBHMe/s4gtypDd7VDK2qbXKdl9r0z2TeSEzQCvdPVl5lvMhMXU31b23hp9LI9JXFh8bkudiUk72tzjcsNYpkD1zdmcF5/Htx91oaRQeNsN5Nv9OL49JpI6Yofx0fZgPlMzLkUW9rQrPUX17OuNZbRW72jXm+J9I37bfNEQhXvWM3bzvDHSYVpZ4ZdhG1vscSP2mvvx9Q2tKiX6QrerXFjffMHGbPjZVufQzrqVru+vyznPc7RvqiTofFJ5Db/qdNoYFvJkNcJmwvqG08A1sKJKqH8PLyyfVFK+57Mpt0NtUA1Hg3gQM1rg+kwcV1miFwMiot4oeeICD27EcDa6B8GNeQK18zwXKt97FHWzduwlBb+Jb8+967FixFukudJGb5Oq3UcL5GEfqOn7RAdwG9Nzg4o6VvDubLQ1Xz6gTHWJtNT7AqEj//vPvwKi291Dwj6D88qC0XO0tHhylcFE4kLQQ2P7XeKQlxKdk0sQymNuaYvIRC48l2GK0dsg5YYnQgpKcSLThLawUSVuAB8K9AVauvrO0jsnwxlKqgyQWk/D20MDr7wug4xWZ5hrO52QShFwSConFDoHDrGDoCq4ShG6WESgLb2FUHm0xgqHwEVJxBNtAScTkQpiTPVseeqh5IrnSMIiIL3JC6tHldVJ5Tw4LatgCEksEX1jokLM3AB+ETNsDKfDDD0XEjPIK2IRQaozhLa8yQyVQYLOgyHxIsXA1HluPUicoQ25FyJJ9QBGU98RXNKrbjO2xMhbrhy13EahLjQr9xmr6Y0RZGR8OYCP6qO6pGSpHFICSKGmbvxR7cH1Ks0+YOKEx5vvu3qYz+dbdfC8jzkVvqgSsGj0GpeHw1A1m/DVl+csYh5t6c4nl/RyTbtl9wGZw0A8bLsxT0M3brdFqrFXnwOoM0qRonK40TtPTi/ewQwOBnGvPX2BwsN3Zz+/fn/5mvhSM2zqr2tTzGjnS642RPUe/20j7RXv3Xqw/E9/LWhboMeFHxrJRRhX7fLQjJpr1hs1NxErtPN0fneXcIe/WVnXdNy82cMAEo6sXb/ap7jc+I0hbNrNwvEgbftjwJr0hr5YQbRhMkZdTyaBDeYkTdFsCthaBXrz9PT1FYsYr3zRnwXTMAvaD8S9u1LLDd79IdEoQH/JpnsBP1KqvMXlTyvy5uZBQGtfR02huanr+h8xCIQH",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/gettemplatelist",title:"Get Template list",description:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.",source:"@site/docs/API-docs/gettemplatelist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/gettemplatelist",permalink:"/docs/API-docs/gettemplatelist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"gettemplatelist",title:"Get Template list",description:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.",sidebar_label:"Get Template list",hide_title:!0,hide_table_of_contents:!0,api:"eJzdWFtv2zYU/iunfNkKKLacWztjGBpsRRq0awIkQ4GlQUBJxxJriuRIyhcEetsv2U/bLxkOJdlWncTNVvRhL4lNnu/cb/Qd8zx3bHzNrrA0knt07CZiGbrUCuOFVmzMrgqEU/TQkcA74TycXJwBl1LPHSx1BV6DRW8FzhA4SKLQE+AzLiRPJILv+A/gqhAOJpVKiT+Xwi/BWD0TGTrgCvQM7UzgPOClXCMjQMUTKVQOlUPrSGZaaO0QJlaXgAvhPN2uEDAvUEFqkYfzTKdVicq7AYuYNmg5aXCWsTHL0Xco0p1FzHDLS/RoyT13TPES2ZhJUQq6FeSYPyq0SxYxi39UwmLGxhMuHUbM+aUk6om2JYsYLozUGbKxtxXdpgWWnI3vWMkXoqxKNj6K44j5pSGQqsoELasJx0tDjEZxHa1UcFNhvpoGD8uM6xvi64xWDh3R7scx/esnh6vSFJ2bVBJWHmURS7XyqDzRc2OkSMPF8JMj0N22Ajr5hGlwuyU2XjQiLbpK+g06bi0ng4XH0u3GN8cU4RWl81aonEXBNdxvnqxsZ4vRm0SVbv8iJ5944el0m8Ua4MKHVeYRSmm/A9RRQyCtSSWZof1WZjX59JiCjT4QCOu1I1aK37YKk+pil4sK740bD4cdmGp4kOqS0HquenY/5qxQzrrTKmJO5CpU6b9NEqt3qZ6i/jKHfdIICQa1sORC7qROEF+1B50vTKHVDjGHR8f7o4OXL0ZEPxdZjv4/2N/cbsvrF/oJ9XrMYMZlhQ72gPzOfWUxAud5aQY7km9FT0ovtpvPBnp1skLvHx7WEVs+EfViRP55IujgZR2x4omgw2OKHM/xibjRvWV12aT0bRfa+jGqUJkOVXamzm2/fSRaS+RqUyANgDpioYgwO/GPJ9p+vH+wN4r34hdXo+Px4Q/jo+NBHMe/s4gtypDd7VDK2qbXKdl9r0z2TeSEzQCvdPVl5lvMhMXU31b23hp9LI9JXFh8bkudiUk72tzjcsNYpkD1zdmcF5/Htx91oaRQeNsN5Nv9OL49JpI6Yofx0fZgPlMzLkUW9rQrPUX17OuNZbRW72jXm+J9I37bfNEQhXvWM3bzvDHSYVpZ4ZdhG1vscSP2mvvx9Q2tKiX6QrerXFjffMHGbPjZVufQzrqVru+vyznPc7RvqiTofFJ5Db/qdNoYFvJkNcJmwvqG08A1sKJKqH8PLyyfVFK+57Mpt0NtUA1Hg3gQM1rg+kwcV1miFwMiot4oeeICD27EcDa6B8GNeQK18zwXKt97FHWzduwlBb+Jb8+967FixFukudJGb5Oq3UcL5GEfqOn7RAdwG9Nzg4o6VvDubLQ1Xz6gTHWJtNT7AqEj//vPvwKi291Dwj6D88qC0XO0tHhylcFE4kLQQ2P7XeKQlxKdk0sQymNuaYvIRC48l2GK0dsg5YYnQgpKcSLThLawUSVuAB8K9AVauvrO0jsnwxlKqgyQWk/D20MDr7wug4xWZ5hrO52QShFwSConFDoHDrGDoCq4ShG6WESgLb2FUHm0xgqHwEVJxBNtAScTkQpiTPVseeqh5IrnSMIiIL3JC6tHldVJ5Tw4LatgCEksEX1jokLM3AB+ETNsDKfDDD0XEjPIK2IRQaozhLa8yQyVQYLOgyHxIsXA1HluPUicoQ25FyJJ9QBGU98RXNKrbjO2xMhbrhy13EahLjQr9xmr6Y0RZGR8OYCP6qO6pGSpHFICSKGmbvxR7cH1Ks0+YOKEx5vvu3qYz+dbdfC8jzkVvqgSsGj0GpeHw1A1m/DVl+csYh5t6c4nl/RyTbtl9wGZw0A8bLsxT0M3brdFqrFXnwOoM0qRonK40TtPTi/ewQwOBnGvPX2BwsN3Zz+/fn/5mvhSM2zqr2tTzGjnS642RPUe/20j7RXv3Xqw/E9/LWhboMeFHxrJRRhX7fLQjJpr1hs1NxErtPN0fneXcIe/WVnXdNy82cMAEo6sXb/ap7jc+I0hbNrNwvEgbftjwJr0hr5YQbRhMkZdTyaBDeYkTdFsCthaBXrz9PT1FYsYr3zRnwXTMAvaD8S9u1LLDd79IdEoQH/JpnsBP1KqvMXlTyvy5uZBQGtfR02huanr+h8xCIQH",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete Template",permalink:"/docs/API-docs/delete-template"},next:{title:"Get Webhook",permalink:"/docs/API-docs/get-webhook"}},g={},v=[{value:"Request",id:"request",level:2}];function b(e){const s={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(s.p,{children:"Get Template list"})}),"\n",(0,i.jsx)(n(),{method:"get",path:"/templatelist"}),"\n",(0,i.jsx)(s.p,{children:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents."}),"\n",(0,i.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,i.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(s.p,{children:"Query Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsxs)("ul",{children:[(0,i.jsx)(o.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,i.jsx)(o.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(r.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"successful operation"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"result"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"template[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"sample template"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template note"}}),(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"folder"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"object"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder name"}})]})]})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}}),(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!0}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!0}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"redirect_url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "result": [\n {\n "objectId": "x1Hbnms2Pg",\n "title": "sample template",\n "note": "template note",\n "folder": {\n "objectId": "x1Hbnms2Pg",\n "name": "folder name"\n },\n "file": "https://templateuser.com",\n "owner": "template creator name",\n "signers": [\n {\n "role": "ceo",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871",\n "widgets": [\n {\n "type": "signature",\n "x": 244,\n "y": 71,\n "w": 38,\n "h": 46,\n "page": 1\n }\n ]\n }\n ],\n "sendInOrder": true,\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z",\n "enableTour": true,\n "redirect_url": "",\n "allow_modifications": false\n }\n ]\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function f(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/78b2b753.6a17860a.js b/assets/js/78b2b753.f380f604.js similarity index 57% rename from assets/js/78b2b753.6a17860a.js rename to assets/js/78b2b753.f380f604.js index 62727e2f2..5c91674b7 100644 --- a/assets/js/78b2b753.6a17860a.js +++ b/assets/js/78b2b753.f380f604.js @@ -1 +1 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2207],{97201:(e,l,s)=>{s.r(l),s.d(l,{assets:()=>f,contentTitle:()=>x,default:()=>b,frontMatter:()=>j,metadata:()=>u,toc:()=>g});var a=s(85893),n=s(11151),i=s(58219),r=(s(62316),s(51039)),t=s.n(r),d=(s(82723),s(9487)),o=s(41429),c=s(5397),m=s(4667),p=s(9472),h=s(85162);const j={id:"deletefolder",title:"Delete Folder",description:"The delete Folder API allows you to delete folder.",sidebar_label:"Delete Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vttu20YQ/ZXJvjQBKIl2nLQliqJG46Zu0jioUwSoLRhDckhutNzd7C4lCwLf+iX9tH5JMaSoiy0HTVv0xRZ37rczsxIBSy+SK/GDUTk5MY1ETj5z0gZptEjEu4ogJ0WBoGeB07fngEqZhYelaSCYgV509LGIhLHkkBWc5yIRPbmnikhYdFhTIMd2V0JjTSIRPflG5iISkg1bDJW4641JP1AWznMwBWwUOvrYSEe5SIJrKBI+LBWr9LK2ikQk6NYqk5NIClSeGbKKahTJSoSl7TiDk7oUkSiMqzHsvtAtdloSkb46yor8uLKpaNspm/XWaE+eFR3HMf/b99Y3WUbeF42CTUZEJDKjA+nA/GitkllHmHzwLLS6710fNGfOsZoge5NDLj43jh9n/vgnS4tzK9poXZz8NBxSsxU6jo+fjo7iUfzlu6PnycnXybPn4ziOfxORuK0Vy67rmGMg1htkUNvvnQepldR0M2Tv5jiOb46ORdsy08mhNI7WpQbpQZsAVNuwjIDTiFJ7yE3W1KQDGDf04LUewaWpKVRSl7Bg4sIZXUZgFaEnCG4JWKLUoDCQe3T9rwpjNF0U3M1ttOLWeCjWkzi+eboJ9eR+qOtAOcrCNDof/3ftQs4Z97m9ct+fT5XyJD65+WoT3rP74Z3rOSqZdxASzIz0o/8hvm00B8yzq/sNLHumji72gt1974P0lDVOhmUHZLcjtHLU05OrKfcBN6DZQmAHfqESiZj0iZ2sNrDXClbn5gMs7ifucoFlSe7HJu2cP22CgZ9NNusjbJwSiahCsD6ZTObShV7T2PdiVZOOM1NP3josGqXe4HyGbmIs6cnROB7Hoo1Wd5R41HlqbsfM5GWpFaa+04FWTuZHByTQ2s/g9gFLqcvRJ6Wm2wxfchf0hd7L86bcaOUrWopoKOMu13qjVIS8MLhwUhemE14X98KSvpSl7rI7P7q3d96TykxNvOxCRTCw//n7H53EgEBd5z6Ci8aBNQtyjPyocygU3cpU0YHd6QlrRd6rJUgdqHQYCHJZyoAKOCsMYBlaTKWS3OvMZljawc64+DG8ryhU5Jj0hSNAyGlOikcElDHcKmwPm2DqzsaAmgvjZgW7FAFC2nipyXvwRIMI6Qp1RjDUImKgRQ2kAznrpCdAWTNzYRxQUchMsmIebIdZgBo1lsTGImC/OQvWmbnMyYMzaeMDeKOaLhC2WBOFPkRNlPsxvJBz6gPnx5wCSkU5lA2r4FWQE6znnMPQOaTkA1g2LzPqlPqALoCiObmu97pK8jyANQxAEhWfFbu1ZUXBofaMkb1DQ2k26bPO8JLvbOS4HMO1vta8e6DxxA2gpJ75hDfS1abN3lPqZaDp42EeFovFvTl4si/zUoaqScGRNVu5snvspmZXfPPxREQikKv9RXFJbi4zWg/hAzYnHfNkDcuYdbBMNUrVz9h3dwUYIpXMSHvaAdHTl29fwxyejuM9ePobDk9en39/9ubyjPUyGPbzN8CUsMaHGvWOqRe7x+ndwV1tt8s/u2TX6BLoNkysQtmthC6g1RrLr8TmEE22R+w0EpXxgcmrVYqefnWqbfn5Y0OOF8Y0EnN0ElMGIAZ86fl3vrlSHwzk8S/rg/cJHLyHD/o8wKRmjJyjavhLRGJGy73ru5220YCU7FZPP80ysmFH8t6m3lt3L85en707E5HAhlO0C9KzDqTXP9jAQcf20bv3gf/yIjko8A3X8hUtv92w95QHBdYhDtycpGnbtn8BVP+Jcw==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,u={id:"API-docs/deletefolder",title:"Delete Folder",description:"The delete Folder API allows you to delete folder.",source:"@site/docs/API-docs/deletefolder.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/deletefolder",permalink:"/docs/API-docs/deletefolder",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"deletefolder",title:"Delete Folder",description:"The delete Folder API allows you to delete folder.",sidebar_label:"Delete Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vttu20YQ/ZXJvjQBKIl2nLQliqJG46Zu0jioUwSoLRhDckhutNzd7C4lCwLf+iX9tH5JMaSoiy0HTVv0xRZ37rczsxIBSy+SK/GDUTk5MY1ETj5z0gZptEjEu4ogJ0WBoGeB07fngEqZhYelaSCYgV509LGIhLHkkBWc5yIRPbmnikhYdFhTIMd2V0JjTSIRPflG5iISkg1bDJW4641JP1AWznMwBWwUOvrYSEe5SIJrKBI+LBWr9LK2ikQk6NYqk5NIClSeGbKKahTJSoSl7TiDk7oUkSiMqzHsvtAtdloSkb46yor8uLKpaNspm/XWaE+eFR3HMf/b99Y3WUbeF42CTUZEJDKjA+nA/GitkllHmHzwLLS6710fNGfOsZoge5NDLj43jh9n/vgnS4tzK9poXZz8NBxSsxU6jo+fjo7iUfzlu6PnycnXybPn4ziOfxORuK0Vy67rmGMg1htkUNvvnQepldR0M2Tv5jiOb46ORdsy08mhNI7WpQbpQZsAVNuwjIDTiFJ7yE3W1KQDGDf04LUewaWpKVRSl7Bg4sIZXUZgFaEnCG4JWKLUoDCQe3T9rwpjNF0U3M1ttOLWeCjWkzi+eboJ9eR+qOtAOcrCNDof/3ftQs4Z97m9ct+fT5XyJD65+WoT3rP74Z3rOSqZdxASzIz0o/8hvm00B8yzq/sNLHumji72gt1974P0lDVOhmUHZLcjtHLU05OrKfcBN6DZQmAHfqESiZj0iZ2sNrDXClbn5gMs7ifucoFlSe7HJu2cP22CgZ9NNusjbJwSiahCsD6ZTObShV7T2PdiVZOOM1NP3josGqXe4HyGbmIs6cnROB7Hoo1Wd5R41HlqbsfM5GWpFaa+04FWTuZHByTQ2s/g9gFLqcvRJ6Wm2wxfchf0hd7L86bcaOUrWopoKOMu13qjVIS8MLhwUhemE14X98KSvpSl7rI7P7q3d96TykxNvOxCRTCw//n7H53EgEBd5z6Ci8aBNQtyjPyocygU3cpU0YHd6QlrRd6rJUgdqHQYCHJZyoAKOCsMYBlaTKWS3OvMZljawc64+DG8ryhU5Jj0hSNAyGlOikcElDHcKmwPm2DqzsaAmgvjZgW7FAFC2nipyXvwRIMI6Qp1RjDUImKgRQ2kAznrpCdAWTNzYRxQUchMsmIebIdZgBo1lsTGImC/OQvWmbnMyYMzaeMDeKOaLhC2WBOFPkRNlPsxvJBz6gPnx5wCSkU5lA2r4FWQE6znnMPQOaTkA1g2LzPqlPqALoCiObmu97pK8jyANQxAEhWfFbu1ZUXBofaMkb1DQ2k26bPO8JLvbOS4HMO1vta8e6DxxA2gpJ75hDfS1abN3lPqZaDp42EeFovFvTl4si/zUoaqScGRNVu5snvspmZXfPPxREQikKv9RXFJbi4zWg/hAzYnHfNkDcuYdbBMNUrVz9h3dwUYIpXMSHvaAdHTl29fwxyejuM9ePobDk9en39/9ubyjPUyGPbzN8CUsMaHGvWOqRe7x+ndwV1tt8s/u2TX6BLoNkysQtmthC6g1RrLr8TmEE22R+w0EpXxgcmrVYqefnWqbfn5Y0OOF8Y0EnN0ElMGIAZ86fl3vrlSHwzk8S/rg/cJHLyHD/o8wKRmjJyjavhLRGJGy73ru5220YCU7FZPP80ysmFH8t6m3lt3L85en707E5HAhlO0C9KzDqTXP9jAQcf20bv3gf/yIjko8A3X8hUtv92w95QHBdYhDtycpGnbtn8BVP+Jcw==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Update Folder",permalink:"/docs/API-docs/updatefolder"},next:{title:"Get folder list",permalink:"/docs/API-docs/folderlist"}},f={},g=[{value:"Request",id:"request",level:2}];function y(e){const l={h2:"h2",li:"li",p:"p",ul:"ul",...(0,n.a)(),...e.components},{Details:s}=l;return s||function(e,l){throw new Error("Expected "+(l?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)("h1",{className:"openapi__heading",children:(0,a.jsx)(l.p,{children:"Delete Folder"})}),"\n",(0,a.jsx)(t(),{method:"delete",path:"/folder/{folder_id}"}),"\n",(0,a.jsx)(l.p,{children:"The delete Folder API allows you to delete folder."}),"\n",(0,a.jsx)(l.h2,{id:"request",children:"Request"}),"\n",(0,a.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},children:(0,a.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,a.jsx)(l.p,{children:"Path Parameters"})})}),(0,a.jsx)("div",{children:(0,a.jsx)("ul",{children:(0,a.jsx)(o.Z,{className:"paramsItem",param:{name:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"bK1cfd2hpb"}}})})})]}),"\n",(0,a.jsx)("div",{children:(0,a.jsx)("div",{children:(0,a.jsxs)(i.Z,{children:[(0,a.jsxs)(h.default,{label:"200",value:"200",children:[(0,a.jsx)("div",{children:(0,a.jsx)(l.p,{children:"successful operation"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(l.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,a.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Hks2JpewIp"}}),(0,a.jsx)(m.Z,{collapsible:!1,name:"deletedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(c.Z,{responseExample:'{\n "objectId": "Hks2JpewIp",\n "deletedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"400",value:"400",children:[(0,a.jsx)("div",{children:(0,a.jsxs)(l.ul,{children:["\n",(0,a.jsxs)(l.li,{children:["\n",(0,a.jsx)(l.p,{children:"folder is not empty, contains document or folder."}),"\n"]}),"\n",(0,a.jsxs)(l.li,{children:["\n",(0,a.jsx)(l.p,{children:"Something went wrong, please try again later!"}),"\n"]}),"\n"]})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsx)(p.default,{className:"openapi-tabs__schema",children:(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(l.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsxs)("div",{children:[(0,a.jsx)("span",{className:"badge badge--info",children:(0,a.jsx)(l.p,{children:"oneOf"})}),(0,a.jsxs)(p.default,{children:[(0,a.jsx)(h.default,{label:"MOD1",value:"0-item-properties",children:(0,a.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder is not empty, contains document or folder."}})}),(0,a.jsx)(h.default,{label:"MOD2",value:"1-item-properties",children:(0,a.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})]})})]})})})})})})]}),(0,a.jsxs)(h.default,{label:"404",value:"404",children:[(0,a.jsx)("div",{children:(0,a.jsx)(l.p,{children:"folder not found."})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(l.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder not found."}})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(c.Z,{responseExample:'{\n "error": "folder not found."\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"405",value:"405",children:[(0,a.jsx)("div",{children:(0,a.jsx)(l.p,{children:"Invalid API token!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(l.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:l}={...(0,n.a)(),...e.components};return l?(0,a.jsx)(l,{...e,children:(0,a.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2207],{97201:(e,l,s)=>{s.r(l),s.d(l,{assets:()=>f,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>j,toc:()=>y});var a=s(85893),i=s(11151),t=s(58219),r=(s(62316),s(51039)),n=s.n(r),d=(s(82723),s(9487)),o=s(41429),c=s(5397),p=s(4667),m=s(9472),h=s(85162);const u={id:"deletefolder",title:"Delete Folder",description:"The delete Folder API allows you to delete folder.",sidebar_label:"Delete Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vutu2zYUfpVT/lkLyLbspt0mDMOCNeuyFEuxdCiwxAiOpSOLNUWyJOULDP3bk+zR9iTDkSxfYqdYt2F/Eovn+p3LR65FwKkXya34waiMnBhHIiOfOmmDNFok4l1BkJGiQNCqwPnbS0ClzMLDylQQTCfPG3lfRMJYcsgOLjORiFbcSkUkLDosKZDjuGuhsSSRiFZ8LzMRCcmBLYZCPMzGTD5QGi4zMDlsHTr6WElHmUiCqygSPqwUu/SytIpEJGhplclIJDkqzwppQSWKZC3CyjaawUk9FZHIjSsx7J/QEhsviZhcDdM8GxV2Iup6zGG9NdqTZ0ejOOZ/h9n6Kk3J+7xSsK2IiERqdCAdWB+tVTJtBIMPno3Wx9m1oLlyjt0E2YbsavG5OH6c+dFPlhaXVtTRpjnZeTjlZmc0ikfPe8O4F3/5bvgyOfs6efGyH8fxbyISy1Kx7aaPGQZiv0EGtfveO5BaSU33XfXuR3F8PxyJumals1Nl7G1aDdKDNgGotGEVAZcRpfaQmbQqSQcwrpvBO92DG1NSKKSewoKFC2f0NAKrCD1BcCvAKUoNCgO5J3f/qjFG03XO01xHax6Nx7CexfH98y3Us2OoG6CMMjeVzvr/3biQc8Z97qwc5/OpVp7FZ/dfbeG9OIZ3qeeoZNZQSDAz0k/+B3w7NCfCc6qHAyxbpUYuDsDun7cgPaWVk2HVENmyh1b2WnlyO+Y54AE0OwpsyC8UIhGDtrCD9Zb2asHu3LyjxcopkYgiBOuTwcCjziZm2TeWtJdTrXDi+6kpB2jlYD4UdfTQAq39DG0fcCr1tPdJq/EO8A03pa37Aext9dHKK1qJqKvqvtaG4AtC5m+uo9S5aYw3tb62pG/kVDedmg+ProH3pFJTEt89oSDo1P/8/Y/GoiOEZpCewHXlwJoFOSZi1BnkipZyoujEVeYJS0XeqxVIHWjqMBBkcioDKuCqMJ+kaHEileTRYzXD1g72ptf34X1BoSDHoi8cAUJGc1I8saCMmbGfYACrYMomRkdiC+NmOacUAcKk8lKT9+CJOhPSBeqUoOtFxLyHGkgHctZJT4CyZOXcOKA8l6lkx7xnDtMAJWqcEgeLgPPmKlhn5jIjD85MKh/AG1U1QDhiSRRaiJoo8314JefUAufDjAJKRRlMK3bBzJwRbNaOYegMJuQDWA4vU2qc+oAugKI5uWb2mk7mlVJgDfOBRMW3/H5v2VFwqD1TVptQ15pt+awzfOc2MTJc9eFO32m+CqDyxAOgpJ75hC+I2+2YvaeJl4HGT7t9WCwWR3vw7NDmtQxFNQFH1uzsps1hszX75tuPZyISgVzpr/MbcnOZ0mYJH4k5aJQHG5bEtGFJKlGqdse+e2jAjKVkStrTHqedv377BubwvB+LaG/z/0bCgzeX31/8fHPBfpmb2v0b9uN+zEfW+FCi3gv1av+t+HBx1zuy/2cPyw27BFqGgVUoG4ZuAK031Hortu/CZPemHEeiMD6weL2eoKdfnaprPv5YkWP+Hkdijk7ihAnodi0y6fl3tn00Pgrk6S+b9+czOPk8PZlzR5OaOXKOquIvEYkZrQ4ew/W4jjqm5LRa+Xmakg17lkcX58Ht8+rizcW7CxEJrLhE+yQ9a0h684MDnEzskL3bHPgvXyQnDb7hXl7R6tuteit51GADsdPmIo3ruv4L549hyA==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/deletefolder",title:"Delete Folder",description:"The delete Folder API allows you to delete folder.",source:"@site/docs/API-docs/deletefolder.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/deletefolder",permalink:"/docs/API-docs/deletefolder",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"deletefolder",title:"Delete Folder",description:"The delete Folder API allows you to delete folder.",sidebar_label:"Delete Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vutu2zYUfpVT/lkLyLbspt0mDMOCNeuyFEuxdCiwxAiOpSOLNUWyJOULDP3bk+zR9iTDkSxfYqdYt2F/Eovn+p3LR65FwKkXya34waiMnBhHIiOfOmmDNFok4l1BkJGiQNCqwPnbS0ClzMLDylQQTCfPG3lfRMJYcsgOLjORiFbcSkUkLDosKZDjuGuhsSSRiFZ8LzMRCcmBLYZCPMzGTD5QGi4zMDlsHTr6WElHmUiCqygSPqwUu/SytIpEJGhplclIJDkqzwppQSWKZC3CyjaawUk9FZHIjSsx7J/QEhsviZhcDdM8GxV2Iup6zGG9NdqTZ0ejOOZ/h9n6Kk3J+7xSsK2IiERqdCAdWB+tVTJtBIMPno3Wx9m1oLlyjt0E2YbsavG5OH6c+dFPlhaXVtTRpjnZeTjlZmc0ikfPe8O4F3/5bvgyOfs6efGyH8fxbyISy1Kx7aaPGQZiv0EGtfveO5BaSU33XfXuR3F8PxyJumals1Nl7G1aDdKDNgGotGEVAZcRpfaQmbQqSQcwrpvBO92DG1NSKKSewoKFC2f0NAKrCD1BcCvAKUoNCgO5J3f/qjFG03XO01xHax6Nx7CexfH98y3Us2OoG6CMMjeVzvr/3biQc8Z97qwc5/OpVp7FZ/dfbeG9OIZ3qeeoZNZQSDAz0k/+B3w7NCfCc6qHAyxbpUYuDsDun7cgPaWVk2HVENmyh1b2WnlyO+Y54AE0OwpsyC8UIhGDtrCD9Zb2asHu3LyjxcopkYgiBOuTwcCjziZm2TeWtJdTrXDi+6kpB2jlYD4UdfTQAq39DG0fcCr1tPdJq/EO8A03pa37Aext9dHKK1qJqKvqvtaG4AtC5m+uo9S5aYw3tb62pG/kVDedmg+ProH3pFJTEt89oSDo1P/8/Y/GoiOEZpCewHXlwJoFOSZi1BnkipZyoujEVeYJS0XeqxVIHWjqMBBkcioDKuCqMJ+kaHEileTRYzXD1g72ptf34X1BoSDHoi8cAUJGc1I8saCMmbGfYACrYMomRkdiC+NmOacUAcKk8lKT9+CJOhPSBeqUoOtFxLyHGkgHctZJT4CyZOXcOKA8l6lkx7xnDtMAJWqcEgeLgPPmKlhn5jIjD85MKh/AG1U1QDhiSRRaiJoo8314JefUAufDjAJKRRlMK3bBzJwRbNaOYegMJuQDWA4vU2qc+oAugKI5uWb2mk7mlVJgDfOBRMW3/H5v2VFwqD1TVptQ15pt+awzfOc2MTJc9eFO32m+CqDyxAOgpJ75hC+I2+2YvaeJl4HGT7t9WCwWR3vw7NDmtQxFNQFH1uzsps1hszX75tuPZyISgVzpr/MbcnOZ0mYJH4k5aJQHG5bEtGFJKlGqdse+e2jAjKVkStrTHqedv377BubwvB+LaG/z/0bCgzeX31/8fHPBfpmb2v0b9uN+zEfW+FCi3gv1av+t+HBx1zuy/2cPyw27BFqGgVUoG4ZuAK031Hortu/CZPemHEeiMD6weL2eoKdfnaprPv5YkWP+Hkdijk7ihAnodi0y6fl3tn00Pgrk6S+b9+czOPk8PZlzR5OaOXKOquIvEYkZrQ4ew/W4jjqm5LRa+Xmakg17lkcX58Ht8+rizcW7CxEJrLhE+yQ9a0h684MDnEzskL3bHPgvXyQnDb7hXl7R6tuteit51GADsdPmIo3ruv4L549hyA==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Update Folder",permalink:"/docs/API-docs/updatefolder"},next:{title:"Get folder list",permalink:"/docs/API-docs/folderlist"}},f={},y=[{value:"Request",id:"request",level:2}];function g(e){const l={h2:"h2",li:"li",p:"p",ul:"ul",...(0,i.a)(),...e.components},{Details:s}=l;return s||function(e,l){throw new Error("Expected "+(l?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)("h1",{className:"openapi__heading",children:(0,a.jsx)(l.p,{children:"Delete Folder"})}),"\n",(0,a.jsx)(n(),{method:"delete",path:"/folder/{folder_id}"}),"\n",(0,a.jsx)(l.p,{children:"The delete Folder API allows you to delete folder."}),"\n",(0,a.jsx)(l.h2,{id:"request",children:"Request"}),"\n",(0,a.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},children:(0,a.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,a.jsx)(l.p,{children:"Path Parameters"})})}),(0,a.jsx)("div",{children:(0,a.jsx)("ul",{children:(0,a.jsx)(o.Z,{className:"paramsItem",param:{name:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"bK1cfd2hpb"}}})})})]}),"\n",(0,a.jsx)("div",{children:(0,a.jsx)("div",{children:(0,a.jsxs)(t.Z,{children:[(0,a.jsxs)(h.default,{label:"200",value:"200",children:[(0,a.jsx)("div",{children:(0,a.jsx)(l.p,{children:"successful operation"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(l.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,a.jsx)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Hks2JpewIp"}}),(0,a.jsx)(p.Z,{collapsible:!1,name:"deletedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(c.Z,{responseExample:'{\n "objectId": "Hks2JpewIp",\n "deletedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"400",value:"400",children:[(0,a.jsx)("div",{children:(0,a.jsxs)(l.ul,{children:["\n",(0,a.jsxs)(l.li,{children:["\n",(0,a.jsx)(l.p,{children:"folder is not empty, contains document or folder."}),"\n"]}),"\n",(0,a.jsxs)(l.li,{children:["\n",(0,a.jsx)(l.p,{children:"Something went wrong, please try again later!"}),"\n"]}),"\n"]})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsx)(m.default,{className:"openapi-tabs__schema",children:(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(l.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsxs)("div",{children:[(0,a.jsx)("span",{className:"badge badge--info",children:(0,a.jsx)(l.p,{children:"oneOf"})}),(0,a.jsxs)(m.default,{children:[(0,a.jsx)(h.default,{label:"MOD1",value:"0-item-properties",children:(0,a.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder is not empty, contains document or folder."}})}),(0,a.jsx)(h.default,{label:"MOD2",value:"1-item-properties",children:(0,a.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})]})})]})})})})})})]}),(0,a.jsxs)(h.default,{label:"404",value:"404",children:[(0,a.jsx)("div",{children:(0,a.jsx)(l.p,{children:"folder not found."})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(l.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder not found."}})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(c.Z,{responseExample:'{\n "error": "folder not found."\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"405",value:"405",children:[(0,a.jsx)("div",{children:(0,a.jsx)(l.p,{children:"Invalid API token!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(l.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:l}={...(0,i.a)(),...e.components};return l?(0,a.jsx)(l,{...e,children:(0,a.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/7b076186.35a41943.js b/assets/js/7b076186.35a41943.js new file mode 100644 index 000000000..ed73bdbdc --- /dev/null +++ b/assets/js/7b076186.35a41943.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8489],{91945:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>x,default:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>g});var t=s(85893),l=s(11151),n=s(58219),i=(s(62316),s(51039)),o=s.n(i),r=(s(82723),s(9487)),c=s(41429),d=s(5397),m=s(4667),p=s(9472),h=s(85162);const u={id:"deletecontact",title:"Delete Contact",description:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record.",sidebar_label:"Delete Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVVm1v2zYQ/itXfmkLKLaTph0mDMOyNuiCFm2xZCiw1AjO4lliTZEsSfkFhr7tl+yn7ZcMJ8m2nDhBCwwF9iWxyHt97u45rkXEPIj0Wry0JmIWgxgnQlLIvHJRWSNScVUQvCJNkaATgrMPF4Ba20WAla0gWvBU2jkBQtaJTL0t+dJvTibWzgZwMW00jAVtTU4eDJEEBIc+qqzSuJV/HECZqfUlchwJxEKFxnGJMwqgIhCGFfuWbXCxIOXBU2a9HIhEWEe+0b2QIhWtUGdbJMKhx5Iiec5+LQyWJFLR3d8oKRKhOHuHsRC3Ifng7VxJAjv5TFm8kGCn28S3AYlEePpSKU9SpNFXlIgQV5rdBFU6zQK0dNpKEukUdWCBrKASRboWceUayeiVyUUiWiT6J7TExkoqXHEyKU4wSFHXY/YanDWBAts5GY343378mzq2gUoIVZZRCNNK69UjkTQwkImsiM5plTU4Dj8H1l7fjbLFgVH1jHpUre8NPIfy2UX/65Jjd7+5Z6JOujrJs/iw0sno5NnR8eho9MPV8Yv09Mf0+YvBaDT6UyRiWWrW7SoqMRLbjSrq3Xd9R6wtWV+wO6lZ+PQQipe2pFgok8OCTISFtyZPwGnCQBD9CjBHZUBjJP8fokreW/8wOt8WWd3LWhmtDN1sWujmdDS6Od6CcHp/KxkbYWorI79vpgfcP5zO6c3JNp3nd9O5MHPUSjZEc2VnZL5vOn33sXV/t1dVK9Tci71k++dtkoGyyqu4akhueYROHbX36fWYuYL7xO74sSHGWIhUDDs+G653nFgLNujnG9KsvBapKGJ0IR0OAxo5scuBdWSCyo3GSRhkthyiU8P5saiT2xro3DdIh4i5MvnRg1rjXcqXXJYW+b3Et/ijU29oJZINrn2pjv0LQkm+qQEvo0a5Q/u9I3OpctPUan58Z0d8JJ3ZkngfxIJgI/7PX383GtJmVUkmNq30CN5XHpxdkJ9WGtBImGpaqommA7s2EJaaQtArUCZS7jESSJWriBoYFR78DB1OlFbcfCxm22Xc698wgI8FxYI8Xz32vL0lzUlzz4K2dsZ2ogWsoi0bH13MsLB+NuWQEkCYVEEZCgEC0UaFTIEmI9jUIgHrAQ2QieSdV4EAVcnCU+uBplOVKTbMveZ5nks0mBM7S4DjZhRcu3UDeDupQoRgddUkwh5LotimyC+KMIBXak5t4nwoKaLSJCGv2EQCmZUE3eBxGkbChEIEx+5VRo3RENFH0DQn3/ReU0nekuAsM4JCzau/X1s2FD2awAu7DWhTmi18zltet40PiasBfDKfDHM2VIG4AbQys5B+MkdwvW2zjzQJKtL4yWYeFovFnTl4uq/zWsWimoAnZ3d6eXPYTE1fffvxVCQiki/D++kl+bnKqBvCe3wOG+Fhx5P8umKuK1HpdsZ+ua3AnKVVRiZQj9XOXn94C3N4NhiJpDf5XxHw8O3Fy/N3l+dsl7mpnb/jwWgw4iNnQyzR9Fztv2ZvT+56x/f/27dvx3CRlnHoNKpmTzSgrjuCvxa7t3Dae/aOE1HYEFlgvZ5goD+8rms+/lKR5z0yTsQcvcIJ0+D1WkgV+LfcPmLvRfPJ7917+Cl87Qv6YCIb/jZM3nPUFX+JRMxotf+Gr8d1suFwDrUVOMsycrGnemep723GV+dvz6/ORSKwYuD662PWrI/uBzs4GNn+Xmlj4L+84g4q/MSlfkOrn7fi7c29Cl2KG2lGaVzX9b+IN9VT",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/deletecontact",title:"Delete Contact",description:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record.",source:"@site/docs/API-docs/deletecontact.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/deletecontact",permalink:"/docs/API-docs/deletecontact",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"deletecontact",title:"Delete Contact",description:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record.",sidebar_label:"Delete Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVVm1v2zYQ/itXfmkLKLaTph0mDMOyNuiCFm2xZCiw1AjO4lliTZEsSfkFhr7tl+yn7ZcMJ8m2nDhBCwwF9iWxyHt97u45rkXEPIj0Wry0JmIWgxgnQlLIvHJRWSNScVUQvCJNkaATgrMPF4Ba20WAla0gWvBU2jkBQtaJTL0t+dJvTibWzgZwMW00jAVtTU4eDJEEBIc+qqzSuJV/HECZqfUlchwJxEKFxnGJMwqgIhCGFfuWbXCxIOXBU2a9HIhEWEe+0b2QIhWtUGdbJMKhx5Iiec5+LQyWJFLR3d8oKRKhOHuHsRC3Ifng7VxJAjv5TFm8kGCn28S3AYlEePpSKU9SpNFXlIgQV5rdBFU6zQK0dNpKEukUdWCBrKASRboWceUayeiVyUUiWiT6J7TExkoqXHEyKU4wSFHXY/YanDWBAts5GY343378mzq2gUoIVZZRCNNK69UjkTQwkImsiM5plTU4Dj8H1l7fjbLFgVH1jHpUre8NPIfy2UX/65Jjd7+5Z6JOujrJs/iw0sno5NnR8eho9MPV8Yv09Mf0+YvBaDT6UyRiWWrW7SoqMRLbjSrq3Xd9R6wtWV+wO6lZ+PQQipe2pFgok8OCTISFtyZPwGnCQBD9CjBHZUBjJP8fokreW/8wOt8WWd3LWhmtDN1sWujmdDS6Od6CcHp/KxkbYWorI79vpgfcP5zO6c3JNp3nd9O5MHPUSjZEc2VnZL5vOn33sXV/t1dVK9Tci71k++dtkoGyyqu4akhueYROHbX36fWYuYL7xO74sSHGWIhUDDs+G653nFgLNujnG9KsvBapKGJ0IR0OAxo5scuBdWSCyo3GSRhkthyiU8P5saiT2xro3DdIh4i5MvnRg1rjXcqXXJYW+b3Et/ijU29oJZINrn2pjv0LQkm+qQEvo0a5Q/u9I3OpctPUan58Z0d8JJ3ZkngfxIJgI/7PX383GtJmVUkmNq30CN5XHpxdkJ9WGtBImGpaqommA7s2EJaaQtArUCZS7jESSJWriBoYFR78DB1OlFbcfCxm22Xc698wgI8FxYI8Xz32vL0lzUlzz4K2dsZ2ogWsoi0bH13MsLB+NuWQEkCYVEEZCgEC0UaFTIEmI9jUIgHrAQ2QieSdV4EAVcnCU+uBplOVKTbMveZ5nks0mBM7S4DjZhRcu3UDeDupQoRgddUkwh5LotimyC+KMIBXak5t4nwoKaLSJCGv2EQCmZUE3eBxGkbChEIEx+5VRo3RENFH0DQn3/ReU0nekuAsM4JCzau/X1s2FD2awAu7DWhTmi18zltet40PiasBfDKfDHM2VIG4AbQys5B+MkdwvW2zjzQJKtL4yWYeFovFnTl4uq/zWsWimoAnZ3d6eXPYTE1fffvxVCQiki/D++kl+bnKqBvCe3wOG+Fhx5P8umKuK1HpdsZ+ua3AnKVVRiZQj9XOXn94C3N4NhiJpDf5XxHw8O3Fy/N3l+dsl7mpnb/jwWgw4iNnQyzR9Fztv2ZvT+56x/f/27dvx3CRlnHoNKpmTzSgrjuCvxa7t3Dae/aOE1HYEFlgvZ5goD+8rms+/lKR5z0yTsQcvcIJ0+D1WkgV+LfcPmLvRfPJ7917+Cl87Qv6YCIb/jZM3nPUFX+JRMxotf+Gr8d1suFwDrUVOMsycrGnemep723GV+dvz6/ORSKwYuD662PWrI/uBzs4GNn+Xmlj4L+84g4q/MSlfkOrn7fi7c29Cl2KG2lGaVzX9b+IN9VT",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Contact",permalink:"/docs/API-docs/getcontact"},next:{title:"Get Contact list",permalink:"/docs/API-docs/contactlist"}},f={},g=[{value:"Request",id:"request",level:2}];function v(e){const a={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Delete Contact"})}),"\n",(0,t.jsx)(o(),{method:"delete",path:"/contact/{contact_id}"}),"\n",(0,t.jsx)(a.p,{children:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record."}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(a.p,{children:"Path Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(c.Z,{className:"paramsItem",param:{name:"contact_id",in:"path",description:"Provide objectId of contact to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}})})})]}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(n.Z,{children:[(0,t.jsxs)(h.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Contact deleted successfully!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bxh2aspHp3"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"deletedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "objectId": "Bxh2aspHp3",\n "deletedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"400",value:"400",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Contact not found!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Contact not found!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Contact not found!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/7b076186.cd43640b.js b/assets/js/7b076186.cd43640b.js deleted file mode 100644 index af2b6e872..000000000 --- a/assets/js/7b076186.cd43640b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8489],{91945:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>j,default:()=>y,frontMatter:()=>u,metadata:()=>x,toc:()=>b});var l=s(85893),t=s(11151),n=s(58219),i=(s(62316),s(51039)),o=s.n(i),r=(s(82723),s(9487)),c=s(41429),d=s(5397),m=s(4667),p=s(9472),h=s(85162);const u={id:"deletecontact",title:"Delete Contact",description:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record.",sidebar_label:"Delete Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVV21v2zYQ/itXfmkLKLaTph0mDMOyNmiDdm2wZCiw1AhO0lliTZEsSck2DH3bL9lP2y8ZTpLfYidogaHAviQ2+dw777nzUgTMvYhvxEujA6bBi3EkMvKpkzZIo0UsrguCV6QoEPQgOLu8AFTKzDwsTAXBgKPS1AQIaQ+ZOFPypVudJMZMB3AxaSW0AWV0Tg40UQYIFl2QaaVwjX/sQeqJcSWyHxGEQvrWcIlT8iADEPoF284650JB0oGj1LhsICJhLLlW9iITsehAvW4RCYsOSwrkOPql0FiSiEV/fyszEQnJ0VsMhbibkktnapkRmOQzpeEiAzNZB752SETC0ZdKOspEHFxFkfBhodiMl6VVDKC5VSYjEU9QeQakBZUo4qUIC9sig5M6F5HoMrF9QnNstcTCFidJcYI+E00zZqveGu3Js56T0Yj/7fq/qmPnaAa+SlPyflIptXgkojYNpAMLorVKpm0eh589Sy/3vezywFl1nPUgO9ur9ByKZ+P9r3P23b6xz0QT9XXKzsLDQiejk2dHx6Oj0Q/Xxy/i0x/j5y8Go9HoTxGJealYtq9ohoFYb5BBbb43e7CuZNvA/qRh8OmhLF6ZkkIhdQ4z0gFmzug8AqsIPUFwC8AcpQaFgdx/mFVyzriHs/NtnjVbUUutpKbb1RO6PR2Nbo/XSTi9/ylpE2BiKp1930gPmH84nNPbk3U4z/fDudA1Kpm1RHNtpqS/bzjb5kNnfv+tyg7U3oudYLfPuyA9pZWTYdGS3PwIrTzq7uObMXMFvxOz4ceWGEMhYjHs+Wy43HBiI1ihq1ekeacdZpjn5N5USev+WRUM/GbSaRdj5ZSIRRGC9fFwWEsXOk0D34kVVTJITTm8dMg09B7rKbqhsaSHx4PRYCSaaHlHiUedJWY+YJCXuVaY+FYHWjmsjw9IoLXfgPYBc6nzowelxpscX/E76Eq9k+l1wdHKt7QQ0aqQ26h+3BSEGbm26Dz9WuG+vB8s6SuZ6za79fHeUPpIKjUl8QAKBcEK/s9ff7cSmUmrknRo3+4j+FA5sGZGblIpQJ3BRNFcJooODHdPWCryXi1A6kC5w0CQyVwGVMBZYaZJ0WIileTXzjDTTf+thvED+FhQKMjx1WPH60JGNSluElDG8FNhe1gFU7Y2ep9hZtx0wi5FgJBUXmryHjzRSoR0gTolWNUiAuMANZAO5KyTngBlyeCJcUCTiUwlK+bH7ZhAStSYExuLgP3mLNhuzHtwJql8AG9U1QbCFkui0IXIK4wfwCtZUxc4H2YUUCrKIK9YRQSpyQj6TucwdAYJ+QCWzcuUWqU+oAugqCbXvr22ktwPYA1TkETFu8Z2bVlRcKg9bwidQ6vSrNNnneH53trIcDGAT/qT5iEBlSd+AErqqY8/6SO4WT+zj5R4GWj8ZNUPs9lsrw+e7sq8lqGoEnBkzUYubw/brtkWX395KiIRyJX+w+SKXC1T6pvwHpvDFjzsiZnXOSbXEqXqeuyXuwJMkkqmpD1t0ejZ68t3UMOzwWiHnr7C4eG7i5fn76/OWS+TYdd/K5oS1vhQot4ytbs+3+3c5WbA/G+X7Z7hAs3D0CqU7WBqk7rsJ8qN2Czf8daePY5EYXxgwHKZoKc/nGoaPv5SkePBNY5EjU5iwjTIY0d6/pytt+Z7s/nk934Bfwpfu7IfDGTF35rJu0ZV8TcRiSktdn80NOMmWnE4u9oBztKUbNgS3dsidkbxq/N359fnIhJYceK2x8e0HR/9BzZw0LPdudL5wH95xB0U+IlL/ZYWP6/h3c29An2IKzRnadw0zb8OzPz+",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,x={id:"API-docs/deletecontact",title:"Delete Contact",description:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record.",source:"@site/docs/API-docs/deletecontact.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/deletecontact",permalink:"/docs/API-docs/deletecontact",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"deletecontact",title:"Delete Contact",description:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record.",sidebar_label:"Delete Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVV21v2zYQ/itXfmkLKLaTph0mDMOyNmiDdm2wZCiw1AhO0lliTZEsSck2DH3bL9lP2y8ZTpLfYidogaHAviQ2+dw777nzUgTMvYhvxEujA6bBi3EkMvKpkzZIo0UsrguCV6QoEPQgOLu8AFTKzDwsTAXBgKPS1AQIaQ+ZOFPypVudJMZMB3AxaSW0AWV0Tg40UQYIFl2QaaVwjX/sQeqJcSWyHxGEQvrWcIlT8iADEPoF284650JB0oGj1LhsICJhLLlW9iITsehAvW4RCYsOSwrkOPql0FiSiEV/fyszEQnJ0VsMhbibkktnapkRmOQzpeEiAzNZB752SETC0ZdKOspEHFxFkfBhodiMl6VVDKC5VSYjEU9QeQakBZUo4qUIC9sig5M6F5HoMrF9QnNstcTCFidJcYI+E00zZqveGu3Js56T0Yj/7fq/qmPnaAa+SlPyflIptXgkojYNpAMLorVKpm0eh589Sy/3vezywFl1nPUgO9ur9ByKZ+P9r3P23b6xz0QT9XXKzsLDQiejk2dHx6Oj0Q/Xxy/i0x/j5y8Go9HoTxGJealYtq9ohoFYb5BBbb43e7CuZNvA/qRh8OmhLF6ZkkIhdQ4z0gFmzug8AqsIPUFwC8AcpQaFgdx/mFVyzriHs/NtnjVbUUutpKbb1RO6PR2Nbo/XSTi9/ylpE2BiKp1930gPmH84nNPbk3U4z/fDudA1Kpm1RHNtpqS/bzjb5kNnfv+tyg7U3oudYLfPuyA9pZWTYdGS3PwIrTzq7uObMXMFvxOz4ceWGEMhYjHs+Wy43HBiI1ihq1ekeacdZpjn5N5USev+WRUM/GbSaRdj5ZSIRRGC9fFwWEsXOk0D34kVVTJITTm8dMg09B7rKbqhsaSHx4PRYCSaaHlHiUedJWY+YJCXuVaY+FYHWjmsjw9IoLXfgPYBc6nzowelxpscX/E76Eq9k+l1wdHKt7QQ0aqQ26h+3BSEGbm26Dz9WuG+vB8s6SuZ6za79fHeUPpIKjUl8QAKBcEK/s9ff7cSmUmrknRo3+4j+FA5sGZGblIpQJ3BRNFcJooODHdPWCryXi1A6kC5w0CQyVwGVMBZYaZJ0WIileTXzjDTTf+thvED+FhQKMjx1WPH60JGNSluElDG8FNhe1gFU7Y2ep9hZtx0wi5FgJBUXmryHjzRSoR0gTolWNUiAuMANZAO5KyTngBlyeCJcUCTiUwlK+bH7ZhAStSYExuLgP3mLNhuzHtwJql8AG9U1QbCFkui0IXIK4wfwCtZUxc4H2YUUCrKIK9YRQSpyQj6TucwdAYJ+QCWzcuUWqU+oAugqCbXvr22ktwPYA1TkETFu8Z2bVlRcKg9bwidQ6vSrNNnneH53trIcDGAT/qT5iEBlSd+AErqqY8/6SO4WT+zj5R4GWj8ZNUPs9lsrw+e7sq8lqGoEnBkzUYubw/brtkWX395KiIRyJX+w+SKXC1T6pvwHpvDFjzsiZnXOSbXEqXqeuyXuwJMkkqmpD1t0ejZ68t3UMOzwWiHnr7C4eG7i5fn76/OWS+TYdd/K5oS1vhQot4ytbs+3+3c5WbA/G+X7Z7hAs3D0CqU7WBqk7rsJ8qN2Czf8daePY5EYXxgwHKZoKc/nGoaPv5SkePBNY5EjU5iwjTIY0d6/pytt+Z7s/nk934Bfwpfu7IfDGTF35rJu0ZV8TcRiSktdn80NOMmWnE4u9oBztKUbNgS3dsidkbxq/N359fnIhJYceK2x8e0HR/9BzZw0LPdudL5wH95xB0U+IlL/ZYWP6/h3c29An2IKzRnadw0zb8OzPz+",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Contact",permalink:"/docs/API-docs/getcontact"},next:{title:"Get Contact list",permalink:"/docs/API-docs/contactlist"}},f={},b=[{value:"Request",id:"request",level:2}];function g(e){const a={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Delete Contact"})}),"\n",(0,l.jsx)(o(),{method:"delete",path:"/contact/{contact_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"contact_id",in:"path",description:"Provide objectId of contact to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Contact deleted successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bxh2aspHp3"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"deletedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "objectId": "Bxh2aspHp3",\n "deletedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Contact not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Contact not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "Contact not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/8a725248.6792c484.js b/assets/js/8a725248.6792c484.js new file mode 100644 index 000000000..b2077e617 --- /dev/null +++ b/assets/js/8a725248.6792c484.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7971],{80288:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>j,contentTitle:()=>u,default:()=>y,frontMatter:()=>h,metadata:()=>x,toc:()=>g});var t=s(85893),l=s(11151),n=s(58219),r=(s(62316),s(51039)),i=s.n(r),c=(s(82723),s(9487)),o=(s(41429),s(5397)),m=s(4667),d=s(9472),p=s(85162);const h={id:"createcontact",title:"Create Contact",description:"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.",sidebar_label:"Create Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVV+lqHEcQfpVy/0kMo71kO2QIwYpjjLCJRKRgiLSImpna2ZZ6utvdPXuw7L88SR4tTxKqZ2YvHUQQHAJCzHbXfXxVvRIBSy/SK/HO6IB58GKciIJ87qQN0miRisspwTtHGAhaIjg5PwVUysw9LE0NwQBNJsYFRd6rJeQNtaY55K1YCFMMkKMG5kcPXpaanIeJcSzDgayscQF1gMLkdUU6+J5IhLHkkC05LUQqGsmtUJEIR19q8uEnUyxFujow/NyZmSwIMlJmDhYdVhTIsbmthVtB/EU6sBC0Vsk86uzfepa0Ej6fUoX8xRqlo4JjRhVKJRKhsSKRCDs1mjh+YWlJpMJktxSFW8deBEmeJUTqdNVR+eCkLkUiJsZVGHZPaIGVVUx0a9gNEuukVfp8/ozobXvQy03FohqDnylqODoeDY+Hx6OhWK8TEWSIx3uZuck4IWu+38YruJrigbdG+yYWo8Hgft66KmtEFuDrPCfvJ7VSyxfPydXTeWiOuayeFwA7HWbTxejWcgj/58l8NTwejuIfi2gDfhIeErNlGg1Gx0fDwdHgu8vhm/TV9+nrN73BYPC7SMSiUtsSFwWG6GVXI93v2hZfQc/6kKwtzoICSuV3GTocWMeSffVQUV6YisJU6hLmpAPMndFlAlYReoLgloAlSg0KA7l/sUjJOeOeDtPzLNvtWamV1HTTdeTNq8HgZrgJwvDxzkTlCIsl0EL64L+uu4/Z8LRjwx3HXt937FTPUMkiDrZLc0f66/q0qz406u+Xr2yI4r3Yc3b3vHHSU147GZYivVqJxRFaedTcp1fj9TgRXDGGB6o1PlqMYSpS0T+cr57cjJyPYmqnRCqmIVif9vsedZGZRc9Y0jzLFWaeoaiPVvZnDCeHHGjtM6h9wFLq8uhJrvHW0wvORhPwPX83YUcrP9Kym9bpHlUiJFfBlLAgF0PPSf51u1y871K1yUYH4hsMfwiWN6i8NzVZ28RE09oUnlnSF7LUsQBmQ3G4gn0mlZuKeHMJU4KO/K8//owc3cIU6/MFnNUOrJmTm9QKUBcwUbSQmaIH9jZPWLVbm9SBSsdrUSFLGVDFHY1xJUeLmVSSK5rJTLOx7TSF78HnKYUpxWXuG0eAUNCMFDcCKGPuWE4wgHUwVdTR2gxz4+4mbFICCFntpSbvwRN1LKSnqHOCLtMJGAeogXQgZ530BCgrJuZdkiYTmUsWzFXsGCkq1FgSK0uA7eYo2GY39OBMVvsA3qg6OsIaK6LQuKiJCt+Dn+WMGsf5sBkgVEBZs4gEclMQtHlnN3QBGfkAltXLnKJQH9AFUDQjFys7ZpJ3GrCGYUaiAjPZyy0LCg615xHeGNSlZhM+6wwvR1FHgcseXOtrzSMBak9cAErqO59e6yO42pTZZ8q8DDT+tuu2+Xx+r8te7vN8kGFaZ+DImi1fGQ9jT+6yb368FIkI5Cp/NrkgN5M5tS3+iM5+JO634MsYxADaNhha+faQgbtJyZy0323Okw/nn2AGx72BSHZw5R8Y3P90+u79LxfvWS4jX9N/w96gN4hLlvGhQr2jav9ldNi5q+0Q+Y/fUS0KBlqEvlUo4wiJoVm16H918LoaJ2LK0yG9EqtVhp5+c2q95uMvNTkeLeNEzNBJzBjErsbrpENQHhd3tGynNelwdMnqmVzVDRgfzFMeAA3HSZ6TDU/S7g6w87OLS5GIrH0BVqZgHodzfh3iXKTiWlyL+JCM/R3fcHy+Egp1WWMZ0TzKZeDHmmOxOzXu4tRoP9iz7kovd6zcHyeNK/yfHXuQ4QdO/kda/rghb24eZWhj21FzBsfr9fpvroJzNA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/createcontact",title:"Create Contact",description:"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.",source:"@site/docs/API-docs/createcontact.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createcontact",permalink:"/docs/API-docs/createcontact",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createcontact",title:"Create Contact",description:"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.",sidebar_label:"Create Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVV+lqHEcQfpVy/0kMo71kO2QIwYpjjLCJRKRgiLSImpna2ZZ6utvdPXuw7L88SR4tTxKqZ2YvHUQQHAJCzHbXfXxVvRIBSy/SK/HO6IB58GKciIJ87qQN0miRisspwTtHGAhaIjg5PwVUysw9LE0NwQBNJsYFRd6rJeQNtaY55K1YCFMMkKMG5kcPXpaanIeJcSzDgayscQF1gMLkdUU6+J5IhLHkkC05LUQqGsmtUJEIR19q8uEnUyxFujow/NyZmSwIMlJmDhYdVhTIsbmthVtB/EU6sBC0Vsk86uzfepa0Ej6fUoX8xRqlo4JjRhVKJRKhsSKRCDs1mjh+YWlJpMJktxSFW8deBEmeJUTqdNVR+eCkLkUiJsZVGHZPaIGVVUx0a9gNEuukVfp8/ozobXvQy03FohqDnylqODoeDY+Hx6OhWK8TEWSIx3uZuck4IWu+38YruJrigbdG+yYWo8Hgft66KmtEFuDrPCfvJ7VSyxfPydXTeWiOuayeFwA7HWbTxejWcgj/58l8NTwejuIfi2gDfhIeErNlGg1Gx0fDwdHgu8vhm/TV9+nrN73BYPC7SMSiUtsSFwWG6GVXI93v2hZfQc/6kKwtzoICSuV3GTocWMeSffVQUV6YisJU6hLmpAPMndFlAlYReoLgloAlSg0KA7l/sUjJOeOeDtPzLNvtWamV1HTTdeTNq8HgZrgJwvDxzkTlCIsl0EL64L+uu4/Z8LRjwx3HXt937FTPUMkiDrZLc0f66/q0qz406u+Xr2yI4r3Yc3b3vHHSU147GZYivVqJxRFaedTcp1fj9TgRXDGGB6o1PlqMYSpS0T+cr57cjJyPYmqnRCqmIVif9vsedZGZRc9Y0jzLFWaeoaiPVvZnDCeHHGjtM6h9wFLq8uhJrvHW0wvORhPwPX83YUcrP9Kym9bpHlUiJFfBlLAgF0PPSf51u1y871K1yUYH4hsMfwiWN6i8NzVZ28RE09oUnlnSF7LUsQBmQ3G4gn0mlZuKeHMJU4KO/K8//owc3cIU6/MFnNUOrJmTm9QKUBcwUbSQmaIH9jZPWLVbm9SBSsdrUSFLGVDFHY1xJUeLmVSSK5rJTLOx7TSF78HnKYUpxWXuG0eAUNCMFDcCKGPuWE4wgHUwVdTR2gxz4+4mbFICCFntpSbvwRN1LKSnqHOCLtMJGAeogXQgZ530BCgrJuZdkiYTmUsWzFXsGCkq1FgSK0uA7eYo2GY39OBMVvsA3qg6OsIaK6LQuKiJCt+Dn+WMGsf5sBkgVEBZs4gEclMQtHlnN3QBGfkAltXLnKJQH9AFUDQjFys7ZpJ3GrCGYUaiAjPZyy0LCg615xHeGNSlZhM+6wwvR1FHgcseXOtrzSMBak9cAErqO59e6yO42pTZZ8q8DDT+tuu2+Xx+r8te7vN8kGFaZ+DImi1fGQ9jT+6yb368FIkI5Cp/NrkgN5M5tS3+iM5+JO634MsYxADaNhha+faQgbtJyZy0323Okw/nn2AGx72BSHZw5R8Y3P90+u79LxfvWS4jX9N/w96gN4hLlvGhQr2jav9ldNi5q+0Q+Y/fUS0KBlqEvlUo4wiJoVm16H918LoaJ2LK0yG9EqtVhp5+c2q95uMvNTkeLeNEzNBJzBjErsbrpENQHhd3tGynNelwdMnqmVzVDRgfzFMeAA3HSZ6TDU/S7g6w87OLS5GIrH0BVqZgHodzfh3iXKTiWlyL+JCM/R3fcHy+Egp1WWMZ0TzKZeDHmmOxOzXu4tRoP9iz7kovd6zcHyeNK/yfHXuQ4QdO/kda/rghb24eZWhj21FzBsfr9fpvroJzNA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get your account details",permalink:"/docs/API-docs/get-user"},next:{title:"Get Contact",permalink:"/docs/API-docs/getcontact"}},j={},g=[{value:"Request",id:"request",level:2}];function f(e){const a={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Create Contact"})}),"\n",(0,t.jsx)(i(),{method:"post",path:"/createcontact"}),"\n",(0,t.jsx)(a.p,{children:"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents."}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,t.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,t.jsx)(a.p,{children:"Body"})}),(0,t.jsx)("strong",{className:"openapi-schema__required",children:(0,t.jsx)(a.p,{children:"required"})})]}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,t.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,t.jsx)(a.p,{children:"Provide below parameter to create contact"})})}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(m.Z,{collapsible:!1,name:"name",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"email",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"phone",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"1232131321"}})]})]})})}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(n.Z,{children:[(0,t.jsxs)(p.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Contact created successfully!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(o.Z,{responseExample:'{\n "objectId": "ph1bhx2jp",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "4131231231",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(p.default,{label:"400",value:"400",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(p.default,{label:"401",value:"401",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Contact already exists!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Contact already exists!"}})})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(o.Z,{responseExample:'{\n "error": "Contact already exists!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(p.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/8a725248.a9980afb.js b/assets/js/8a725248.a9980afb.js deleted file mode 100644 index 99180bd97..000000000 --- a/assets/js/8a725248.a9980afb.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7971],{80288:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>u,contentTitle:()=>h,default:()=>b,frontMatter:()=>x,metadata:()=>j,toc:()=>f});var l=s(85893),n=s(11151),t=s(58219),i=(s(62316),s(51039)),r=s.n(i),c=(s(82723),s(9487)),o=(s(41429),s(5397)),m=s(4667),d=s(9472),p=s(85162);const x={id:"createcontact",title:"Create Contact",description:"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.",sidebar_label:"Create Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVV+tu2zYUfpVT/tkKKL4kaYcJw9CsK7agXRMsGQosMYIj6VhiQpEsSdkxDP/bk+zR9iTDoSTHdi5YgKHDgCCQyXO+c79wKQKWXqQX4q3RAfPgxSQRBfncSRuk0SIV5xXBW0cYCDoiODo9BlTKzD0sTAPBAE2nxgVF3qsF5C21pjnkHSyECgPkqIH50YOXpSbnYWocYziQtTUuoA5QmLypSQc/EIkwlhyyJseFSEWL3IGKRDj63JAPP5hiIdLljuKnzsxkQZCRMnOw6LCmQI7V7TS8A+Iv0oFB0Fol8yhzeO0ZaSl8XlGN/MUSpaOCfUY1SiUSobEmkQhbGU3sv7CwJFJhsmuK4NaxFUGSZ4RInS57Kh+c1KVIxNS4GsPmCd1ibRUTXRs2g8Qq6YQ+nz8jetMdDHJTM1Sr8DOhxvsH++OD8cH+WKxWiQgyxOOtyFxlHJAV39/5K7iG4oG3RvvWF/uj0f249VnWQhbgmzwn76eNUosXz4nV03FojzmtnucAW42z6nb/2rIL/+fBPBwfjPfjH0N0Dj8KD8HcMe2P9g/2xqO90Tfn49fp4bfpq9eD0Wj0u0jEba3uUlwUGKKVfY70vxtbfAE5q12yLjkLCiiV32To+8AqpuzhQ0l5ZmoKldQlzEkHmDujywSsIvQEwS0AS5QaFAZy/2KSknPGPe2m52m2WbNSK6npqq/Iq8PR6Gq8dsL48cpE5QiLBdCt9MF/WXMf0+Fpw8Ybhr26b9ixnqGSRRxs5+aG9Je1aVN8aMXfT1/ZEsV7sWXs5nlrpKe8cTIsRHqxFLd7aOVee59eTFaTRHDGGB6o1vioMYZKpGK4O189uRk5H2F26mGOZUnu5yaLWh81wcAvJr9pTWucEqmoQrA+HQ5n0oUWaeBbtqrJuG8NTx1yW/+Isxt0Q2NJD8eD0WAkVslyB8SjLjJzO2AiXh4UZj5ioJXD2fgBDrT2GdQ+YCl1ufck1+TOtWcc/jbCWw5exxmtfE+Lfj1It6gSIdmJFWFBLsaas+rXu23mXZ8b6/D3U2M9NB6aA+sxsDWmWdrURNW6nDmxpM9kqWPsZmOxu/N9IpWbmnhVChVBT/7XH39Gjn5DiwXxAk4aB9bMyU0bBagLmCq6lZmiBxZFT1h3a6LUgUrHe1ghSxlQxaWQG1mOFjOpJJcQk5l2RdyoQj+ATxWFiuL2+JUjQChoRoorD5QxnIgsD5tg6iij0xnmxt1MWaUEELLGS03egyfqWUhXqHOCPtIJGAeogXQgZ530BChrJubllaZTmUsG5rJx3Jpq1FgSC0uA9WYv2HYZ9eBM1vgA3qgmGsISa6LQmqiJCj+AH+WMWsP5sJ1YVEDZMEQCuSkIurizGbqAjHwAy+JlThHUB3QBFM3IxcyOkeRqA2u4r0lUYKZbsWWg4FB73hlahfrQrN1nneFtLMoocDGAS32peQZB44kTQEl949NLvQcX6zT7RJmXgSZf99U2n8/vVdnLbZ6fZKiaDBxZc8dXxsNYk5vs6x8vRSICudqfTM/IzWROXYk/InMYiYddt+emxx27KzC08s0uA1eTkjlpv1mcRz+dfoAZHAxGW83vHyg8/HD89t3Hs3eMy622rb++Ccb+XKPeELX9FNut3OXd1PqPH25dFwx0G4ZWoYwzK7pm2Y2bi53n3CQRFY+j9EIslxl6+s2p1YqPPzfkeJZNEjFDJzHjJnYxWSV9B+X5dEOLbj0gHfbOWTyTq6ZtxjsDnAdAy3GU52TDk7SbE/P05OxcJCLrnpy1KZjH4ZyfozgXqbgUlyK+XGN9x0cjny+FQl02WMZuHnG58WPDvticGjdxanQfbFl/pRcbWm6Pk9YU/s+GPcjwHQf/PS2+X5O3N48ydL7tqTmCk9Vq9TfX9Jrf",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},h=void 0,j={id:"API-docs/createcontact",title:"Create Contact",description:"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.",source:"@site/docs/API-docs/createcontact.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createcontact",permalink:"/docs/API-docs/createcontact",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createcontact",title:"Create Contact",description:"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.",sidebar_label:"Create Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVV+tu2zYUfpVT/tkKKL4kaYcJw9CsK7agXRMsGQosMYIj6VhiQpEsSdkxDP/bk+zR9iTDoSTHdi5YgKHDgCCQyXO+c79wKQKWXqQX4q3RAfPgxSQRBfncSRuk0SIV5xXBW0cYCDoiODo9BlTKzD0sTAPBAE2nxgVF3qsF5C21pjnkHSyECgPkqIH50YOXpSbnYWocYziQtTUuoA5QmLypSQc/EIkwlhyyJseFSEWL3IGKRDj63JAPP5hiIdLljuKnzsxkQZCRMnOw6LCmQI7V7TS8A+Iv0oFB0Fol8yhzeO0ZaSl8XlGN/MUSpaOCfUY1SiUSobEmkQhbGU3sv7CwJFJhsmuK4NaxFUGSZ4RInS57Kh+c1KVIxNS4GsPmCd1ibRUTXRs2g8Qq6YQ+nz8jetMdDHJTM1Sr8DOhxvsH++OD8cH+WKxWiQgyxOOtyFxlHJAV39/5K7iG4oG3RvvWF/uj0f249VnWQhbgmzwn76eNUosXz4nV03FojzmtnucAW42z6nb/2rIL/+fBPBwfjPfjH0N0Dj8KD8HcMe2P9g/2xqO90Tfn49fp4bfpq9eD0Wj0u0jEba3uUlwUGKKVfY70vxtbfAE5q12yLjkLCiiV32To+8AqpuzhQ0l5ZmoKldQlzEkHmDujywSsIvQEwS0AS5QaFAZy/2KSknPGPe2m52m2WbNSK6npqq/Iq8PR6Gq8dsL48cpE5QiLBdCt9MF/WXMf0+Fpw8Ybhr26b9ixnqGSRRxs5+aG9Je1aVN8aMXfT1/ZEsV7sWXs5nlrpKe8cTIsRHqxFLd7aOVee59eTFaTRHDGGB6o1vioMYZKpGK4O189uRk5H2F26mGOZUnu5yaLWh81wcAvJr9pTWucEqmoQrA+HQ5n0oUWaeBbtqrJuG8NTx1yW/+Isxt0Q2NJD8eD0WAkVslyB8SjLjJzO2AiXh4UZj5ioJXD2fgBDrT2GdQ+YCl1ufck1+TOtWcc/jbCWw5exxmtfE+Lfj1It6gSIdmJFWFBLsaas+rXu23mXZ8b6/D3U2M9NB6aA+sxsDWmWdrURNW6nDmxpM9kqWPsZmOxu/N9IpWbmnhVChVBT/7XH39Gjn5DiwXxAk4aB9bMyU0bBagLmCq6lZmiBxZFT1h3a6LUgUrHe1ghSxlQxaWQG1mOFjOpJJcQk5l2RdyoQj+ATxWFiuL2+JUjQChoRoorD5QxnIgsD5tg6iij0xnmxt1MWaUEELLGS03egyfqWUhXqHOCPtIJGAeogXQgZ530BChrJubllaZTmUsG5rJx3Jpq1FgSC0uA9WYv2HYZ9eBM1vgA3qgmGsISa6LQmqiJCj+AH+WMWsP5sJ1YVEDZMEQCuSkIurizGbqAjHwAy+JlThHUB3QBFM3IxcyOkeRqA2u4r0lUYKZbsWWg4FB73hlahfrQrN1nneFtLMoocDGAS32peQZB44kTQEl949NLvQcX6zT7RJmXgSZf99U2n8/vVdnLbZ6fZKiaDBxZc8dXxsNYk5vs6x8vRSICudqfTM/IzWROXYk/InMYiYddt+emxx27KzC08s0uA1eTkjlpv1mcRz+dfoAZHAxGW83vHyg8/HD89t3Hs3eMy622rb++Ccb+XKPeELX9FNut3OXd1PqPH25dFwx0G4ZWoYwzK7pm2Y2bi53n3CQRFY+j9EIslxl6+s2p1YqPPzfkeJZNEjFDJzHjJnYxWSV9B+X5dEOLbj0gHfbOWTyTq6ZtxjsDnAdAy3GU52TDk7SbE/P05OxcJCLrnpy1KZjH4ZyfozgXqbgUlyK+XGN9x0cjny+FQl02WMZuHnG58WPDvticGjdxanQfbFl/pRcbWm6Pk9YU/s+GPcjwHQf/PS2+X5O3N48ydL7tqTmCk9Vq9TfX9Jrf",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get your account details",permalink:"/docs/API-docs/get-user"},next:{title:"Get Contact",permalink:"/docs/API-docs/getcontact"}},u={},f=[{value:"Request",id:"request",level:2}];function g(e){const a={h2:"h2",p:"p",...(0,n.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Create Contact"})}),"\n",(0,l.jsx)(r(),{method:"post",path:"/createcontact"}),"\n",(0,l.jsx)(a.p,{children:"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(a.p,{children:"Body"})}),(0,l.jsx)("strong",{className:"openapi-schema__required",children:(0,l.jsx)(a.p,{children:"required"})})]}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(a.p,{children:"Provide below parameter to create contact"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"name",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"email",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"phone",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"1232131321"}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(p.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Contact created successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "objectId": "ph1bhx2jp",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "4131231231",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"401",value:"401",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Contact already exists!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Contact already exists!"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Contact already exists!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,n.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/8a855f99.4657d57d.js b/assets/js/8a855f99.4657d57d.js new file mode 100644 index 000000000..3c4d99fce --- /dev/null +++ b/assets/js/8a855f99.4657d57d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3495],{50437:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>j,default:()=>w,frontMatter:()=>x,metadata:()=>u,toc:()=>g});var l=s(85893),n=s(11151),i=s(58219),d=(s(62316),s(51039)),r=s.n(d),t=(s(82723),s(9487)),o=s(41429),p=s(5397),m=s(4667),c=s(9472),h=s(85162);const x={id:"updatefolder",title:"Update Folder",description:"The Update Folder API allows you to uodate folder name as well as parentFolderId.",sidebar_label:"Update Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V+9uGzcMfxWWX9YCF9tJ0247DMOyruuyFm3QpCiwxAh0d/RZjU5SJZ0dw7hve5I92p5koM5nn2M3WIB1X/xHIinyR/JHaYlBlB7TS/zVqIIcjhMsyOdO2iCNxhQvpgQfbCECQSsCJ2enIJQycw8LU0MwUJu4P2n3tagIhIc5KcXfVjjSoVU+LQaYoLHkBNs/LTDFOlpvlTFBK5yoKJBjt5bI1jDFdvtaFpigZL+sCFO866zJPlEeTgswE1gbdPS5lo4KTIOrKUEfFopNellZRZgg3VplCsJ0IpRngXxKlcB0iWFho2RwUpeY4MS4SoT+Ct2KaCXF7PVhPimOpjbDphm3x5IPP5tiwaa2HT1zZiYLgoyUmcM6ZAYzd7QBExPMjQ6kA9sQ1iqZR+SGnzwbWvac3cR5uYIrYjdOujBadBhixxkIkjzrtbJvI84PC1nTvPOziYnr5fmhtrBpEgwyqF62M8auaXjHkbdG+9bjo9FoF1Jf5zl5P6kVrOvrIfDdD1JXWQ8N67cbf/S7pfmpZYjaUi9Owj4zG6Wj0dHTg8PRwejbi8Pn6fH36bPng9Fo9AcmeFsp1l11BVvDHm7t/96C1Epquu7Quz4aja4PD1eYHu+D8dxUFKZSlzAnHWDujC4TsIqEJwhuAaIUUoMSgdyj/w5fcs64+1F5mGf3oXDMKKxBON4FoWMyE2Biah1J62sHel8V7fpzf3jH19+tw3u2G96pngkli8jkwdyQ/n8Tued4dnW7tGUrFPdxK9j+ehukp7x2MiziwLg9EFYetPvp5ZipmOvG8KixdXSYR0eKwxbV4XI9WxpkW27WzZ7aKUxxGoL16XDohS4yczswlrSXpVYi84PcVENh5XB2iE1yV0NY+wBpH0QpdXlwr9Z4E+05Z6QFfSvmNfTCyte0wKSDtC+1mqJTEpG9mwQ50e83M+tll67tAdHn/F3KR86U1BMTvVhl7J0lfS5LHfM9O9wZ2h9J5aYinn1hStCJ//3nX1GjMHldkQ6xHB/Bu9qBNXNyTPRCFzBRdCszRXvuJZ5Epch7tQCpA5WOB2shSxmEAoaXySQXVmRSSS5gFjOs7aDXA34AH6cUpuR46xtHIKCgGSmue1DG3LCdYEDUwVTxjJXPMDfuZsIuJSAgq73U5D14ok6F9FTonKBLagLGgdBAOpCzTnoCISsWnhgHNJnIXLJh7lYn8gCV0KIkPiwB9ptRsO3twoMzWe0DeKPqGAifWBGFNkRNVPgB/CJn1AbOiwUFIRUVUNZsIoHcFASr5uUwdAEZ+QCWj5c5RaM+CBdA0YxcLOKYyUmtFFjDrCKF4jtZP7dsKDihPRNf61CXmjV81hme6fGMQiwGcKWvNM8BqD1xASipb3x6pQ/gcl1mHynzMtD4cddY8/l8p6GebOu8kmFaZ+DImo1eGRdj+/XV13+eYIKBXOXfTc7JzWROq27+wpnDKDxcca3II9dSJaRqm/WnuwrcTUrmpD31mPHk1dkbmMHTwQiTHoX8C4eHb05fvHx7/pLtMsm1/Xc4GA1G8QJnfKiE7h21dfG/27jLzcj4Kq+EFYsFug1Dq4SMYyDGu1xReHfPxQTTzQNhnODU+MDby2UmPH1wqml4+XNNjofEOMGZcFJkzE+XSyyk59/F+gXwxTgfv19dsp/A3rfGXp87OtbMxTOh6njfTfCGFlsvm2bcJB0js1vt/ov28IMLtrLR35nRPFBajZM8Jxvule0PxbMPF5hgtnqnVPElhE7M+ekk5pjiFV5hfLVFDolPDV5fohK6rEXJ8q1ZniOi5tT0h9BNHEKrHxzYXkC2p1MbCX9yXHsVfuASe02LH9fi7c4XFVbQdtKcnHHTNP8AmqE32Q==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,u={id:"API-docs/updatefolder",title:"Update Folder",description:"The Update Folder API allows you to uodate folder name as well as parentFolderId.",source:"@site/docs/API-docs/updatefolder.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/updatefolder",permalink:"/docs/API-docs/updatefolder",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"updatefolder",title:"Update Folder",description:"The Update Folder API allows you to uodate folder name as well as parentFolderId.",sidebar_label:"Update Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V+9uGzcMfxWWX9YCF9tJ0247DMOyruuyFm3QpCiwxAh0d/RZjU5SJZ0dw7hve5I92p5koM5nn2M3WIB1X/xHIinyR/JHaYlBlB7TS/zVqIIcjhMsyOdO2iCNxhQvpgQfbCECQSsCJ2enIJQycw8LU0MwUJu4P2n3tagIhIc5KcXfVjjSoVU+LQaYoLHkBNs/LTDFOlpvlTFBK5yoKJBjt5bI1jDFdvtaFpigZL+sCFO866zJPlEeTgswE1gbdPS5lo4KTIOrKUEfFopNellZRZgg3VplCsJ0IpRngXxKlcB0iWFho2RwUpeY4MS4SoT+Ct2KaCXF7PVhPimOpjbDphm3x5IPP5tiwaa2HT1zZiYLgoyUmcM6ZAYzd7QBExPMjQ6kA9sQ1iqZR+SGnzwbWvac3cR5uYIrYjdOujBadBhixxkIkjzrtbJvI84PC1nTvPOziYnr5fmhtrBpEgwyqF62M8auaXjHkbdG+9bjo9FoF1Jf5zl5P6kVrOvrIfDdD1JXWQ8N67cbf/S7pfmpZYjaUi9Owj4zG6Wj0dHTg8PRwejbi8Pn6fH36bPng9Fo9AcmeFsp1l11BVvDHm7t/96C1Epquu7Quz4aja4PD1eYHu+D8dxUFKZSlzAnHWDujC4TsIqEJwhuAaIUUoMSgdyj/w5fcs64+1F5mGf3oXDMKKxBON4FoWMyE2Biah1J62sHel8V7fpzf3jH19+tw3u2G96pngkli8jkwdyQ/n8Tued4dnW7tGUrFPdxK9j+ehukp7x2MiziwLg9EFYetPvp5ZipmOvG8KixdXSYR0eKwxbV4XI9WxpkW27WzZ7aKUxxGoL16XDohS4yczswlrSXpVYi84PcVENh5XB2iE1yV0NY+wBpH0QpdXlwr9Z4E+05Z6QFfSvmNfTCyte0wKSDtC+1mqJTEpG9mwQ50e83M+tll67tAdHn/F3KR86U1BMTvVhl7J0lfS5LHfM9O9wZ2h9J5aYinn1hStCJ//3nX1GjMHldkQ6xHB/Bu9qBNXNyTPRCFzBRdCszRXvuJZ5Epch7tQCpA5WOB2shSxmEAoaXySQXVmRSSS5gFjOs7aDXA34AH6cUpuR46xtHIKCgGSmue1DG3LCdYEDUwVTxjJXPMDfuZsIuJSAgq73U5D14ok6F9FTonKBLagLGgdBAOpCzTnoCISsWnhgHNJnIXLJh7lYn8gCV0KIkPiwB9ptRsO3twoMzWe0DeKPqGAifWBGFNkRNVPgB/CJn1AbOiwUFIRUVUNZsIoHcFASr5uUwdAEZ+QCWj5c5RaM+CBdA0YxcLOKYyUmtFFjDrCKF4jtZP7dsKDihPRNf61CXmjV81hme6fGMQiwGcKWvNM8BqD1xASipb3x6pQ/gcl1mHynzMtD4cddY8/l8p6GebOu8kmFaZ+DImo1eGRdj+/XV13+eYIKBXOXfTc7JzWROq27+wpnDKDxcca3II9dSJaRqm/WnuwrcTUrmpD31mPHk1dkbmMHTwQiTHoX8C4eHb05fvHx7/pLtMsm1/Xc4GA1G8QJnfKiE7h21dfG/27jLzcj4Kq+EFYsFug1Dq4SMYyDGu1xReHfPxQTTzQNhnODU+MDby2UmPH1wqml4+XNNjofEOMGZcFJkzE+XSyyk59/F+gXwxTgfv19dsp/A3rfGXp87OtbMxTOh6njfTfCGFlsvm2bcJB0js1vt/ov28IMLtrLR35nRPFBajZM8Jxvule0PxbMPF5hgtnqnVPElhE7M+ekk5pjiFV5hfLVFDolPDV5fohK6rEXJ8q1ZniOi5tT0h9BNHEKrHxzYXkC2p1MbCX9yXHsVfuASe02LH9fi7c4XFVbQdtKcnHHTNP8AmqE32Q==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Folder",permalink:"/docs/API-docs/getfolder"},next:{title:"Delete Folder",permalink:"/docs/API-docs/deletefolder"}},f={},g=[{value:"Request",id:"request",level:2}];function y(e){const a={h2:"h2",p:"p",...(0,n.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Update Folder"})}),"\n",(0,l.jsx)(r(),{method:"put",path:"/folder/{folder_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Update Folder API allows you to uodate folder name as well as parentFolderId."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(o.Z,{className:"paramsItem",param:{name:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"bK1cfd2hpb"}}})})})]}),"\n",(0,l.jsx)(t.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(a.p,{children:"Body"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(a.p,{children:"Provide below parameter to create folder"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"folderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new folder"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"parentFolderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Hks2JpewIp"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "objectId": "Hks2JpewIp",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"folder not found."})}),(0,l.jsx)("div",{children:(0,l.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder not found."}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "folder not found."\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function w(e={}){const{wrapper:a}={...(0,n.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/8a855f99.64ee91b4.js b/assets/js/8a855f99.64ee91b4.js deleted file mode 100644 index 9300d67bc..000000000 --- a/assets/js/8a855f99.64ee91b4.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3495],{50437:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>j,default:()=>b,frontMatter:()=>u,metadata:()=>x,toc:()=>y});var l=s(85893),r=s(11151),n=s(58219),d=(s(62316),s(51039)),i=s.n(d),t=(s(82723),s(9487)),o=s(41429),m=s(5397),c=s(4667),p=s(9472),h=s(85162);const u={id:"updatefolder",title:"Update Folder",description:"The Update Folder API allows you to uodate folder name as well as parentFolderId.",sidebar_label:"Update Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V9tuGzcQ/RWGL02AtS6Ok7aLoqibpombNDFiBwEaC8bs7mjFiEsyJFdrQdi3fkk/rV9SDKmVVpZi1EDTF13ImeHMmcshV9xD6Xj6kf+qZYGWTxJeoMutMF5oxVN+OUP23hTgkUURdnp+xkBK3Ti21DXzmtU67E/jvoIKGTjWoJT0bcCi8lH5rBjwhGuDFsj+WcFTXgfrUZkn3ICFCj1acmvFyRpPedy+FgVPuCC/DPgZv+2szj5h7s8KpqdsY9Di51pYLHjqbY0Jd34pyaQTlZHIE443RuoCeToF6Uggn2EFPF1xvzRB0luhSp7wqbYV+P4K3kCwkvLs1TifFsczk/G2ncRj0fmfdbEkU7uOnlu9EAWyDKVu2CZkAjO3uAWTJzzXyqPyZAOMkSIPyA0/OTK06jm7jfPjGq6A3STpwojoEMSWMuAFOtKLsm8CzvcLWWHT+dmGxPXyfF9bvG0T7oWXvWxnhF3b0o5FZ7Ry0ePj0WgfUlfnOTo3rSXb1Nd94LsbpK6y7hvWy7k7/s1gc2YIoljqxak/ZGardDw6fnw0Hh2Nvr0cP01Pvk+fPB2MRqM/eMJvKkm6664ga7yHW/zfWxBKCoXXHXrXx6PR9Xi8xvTkEIwXukI/E6pkDSrPGqtVmTAjERwyb5cMShCKSfBoH/x3+KK12t6Nyv08uwuFE0JhA8LJPgjdJNOeTXWtwtD62oHeVUX7/twd3sn1d5vwnuyHd6YWIEURJrnXc1T/byIPHE+u7pa2iEJhn+8E21+PQTrMayv8MhDGzREYcRT3048TGsVUN5qoxtTBYaKOlA8jqsPVhltaTrbsouOeW53RQFmifVlnwfPT2mv2u87nMbzaSp7ymffGpcPhQlgfLQ1cVJvV2SDX1fDcwrSW8g0s5mCH2qAajgejwYi3yeqWEQeqyPTNgIScKJWEzAUbYMRwMT6gAcbcQ9p5KIUqj+7UmmzhvaASiFneAXmTazDiFS550uWwL7Wm7RlCoIs24VRZ77Yk+byrj11G6pPMPsdwKg2hpjp4sS6RtwbVhShVSNNivHdL+IAy1xUS2foZsk787z//ChqFzusKlQ/1/4C9rS0zukFLzAKqYFOJNyKTeOAi5BAqic7JJRPKY2mJyQtRCg+SEbw0vXIwkAkpqGNITJO2Zb2mcwP2YYZ+hpa2vrHIgBW4QEmNxqTWVHN0HtReV+GMtc+s0XY+JZcSBiyrnVDoHHOInQqqGagcWZfUhGnLQDFUHq2xwiEDUZHwVFuG06nIBRmm8WAh96wCBSXSYQkjvwkFE68zjlmd1c4zp2UdAqETK0QfQ1SIhRuwX8QCY+C0WKAHIbFgZU0mEpbrAtl6WlAYqmAZOs8MHS9yDEadB+uZxAXaUMQhk9RYzGgaYwIkXQL7uSVD3oJyNGmjQ11qNvAZq+kSEc4oYDlgV+pKEfGw2iEVgBRq7tIrdcQ+bsrsA2ZOeJw87BqraZq9hnq0q/NC+FmdMYtGb/XKsBjar6+++fOIJ9yjrdzb6QXahchx3c1fOHMYhIfr4Q55GO5YgZCxWX+6rUDdJEWOymFvFJ++OH/NFuzxYLQz5/6Fw8PXZ8+ev7l4TnZpqsb+6+YdN9r5ClTvqJ2Xxu3GXW056qs8S9ZTzOONHxoJIvBOiHe15ozuYs0Tnm5fJJOEz7TztL1aZeDwvZVtS8ufa7TESpOEL8AKyGg+EbEIR7+LzZPji3E+fLe+1T9iBx83B33uxrGiWbwAWYcLdsLnuNx5SrWTNukmMrkV95/Fw48uycpWf+9SQIQSNU7zHI2/U7bPwufvL3nCs/XDqApPL26hobcaNDzlV/yKh2dimCHhbUPrKy5BlTWUJB/NEo9ATanpk9A8kND6BwV2EJBddoqR0CfFdVDhByqxV7j8cSMed76osIa2k6bkTNq2/Qc29l+E",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,x={id:"API-docs/updatefolder",title:"Update Folder",description:"The Update Folder API allows you to uodate folder name as well as parentFolderId.",source:"@site/docs/API-docs/updatefolder.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/updatefolder",permalink:"/docs/API-docs/updatefolder",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"updatefolder",title:"Update Folder",description:"The Update Folder API allows you to uodate folder name as well as parentFolderId.",sidebar_label:"Update Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V9tuGzcQ/RWGL02AtS6Ok7aLoqibpombNDFiBwEaC8bs7mjFiEsyJFdrQdi3fkk/rV9SDKmVVpZi1EDTF13ImeHMmcshV9xD6Xj6kf+qZYGWTxJeoMutMF5oxVN+OUP23hTgkUURdnp+xkBK3Ti21DXzmtU67E/jvoIKGTjWoJT0bcCi8lH5rBjwhGuDFsj+WcFTXgfrUZkn3ICFCj1acmvFyRpPedy+FgVPuCC/DPgZv+2szj5h7s8KpqdsY9Di51pYLHjqbY0Jd34pyaQTlZHIE443RuoCeToF6Uggn2EFPF1xvzRB0luhSp7wqbYV+P4K3kCwkvLs1TifFsczk/G2ncRj0fmfdbEkU7uOnlu9EAWyDKVu2CZkAjO3uAWTJzzXyqPyZAOMkSIPyA0/OTK06jm7jfPjGq6A3STpwojoEMSWMuAFOtKLsm8CzvcLWWHT+dmGxPXyfF9bvG0T7oWXvWxnhF3b0o5FZ7Ry0ePj0WgfUlfnOTo3rSXb1Nd94LsbpK6y7hvWy7k7/s1gc2YIoljqxak/ZGardDw6fnw0Hh2Nvr0cP01Pvk+fPB2MRqM/eMJvKkm6664ga7yHW/zfWxBKCoXXHXrXx6PR9Xi8xvTkEIwXukI/E6pkDSrPGqtVmTAjERwyb5cMShCKSfBoH/x3+KK12t6Nyv08uwuFE0JhA8LJPgjdJNOeTXWtwtD62oHeVUX7/twd3sn1d5vwnuyHd6YWIEURJrnXc1T/byIPHE+u7pa2iEJhn+8E21+PQTrMayv8MhDGzREYcRT3048TGsVUN5qoxtTBYaKOlA8jqsPVhltaTrbsouOeW53RQFmifVlnwfPT2mv2u87nMbzaSp7ymffGpcPhQlgfLQ1cVJvV2SDX1fDcwrSW8g0s5mCH2qAajgejwYi3yeqWEQeqyPTNgIScKJWEzAUbYMRwMT6gAcbcQ9p5KIUqj+7UmmzhvaASiFneAXmTazDiFS550uWwL7Wm7RlCoIs24VRZ77Yk+byrj11G6pPMPsdwKg2hpjp4sS6RtwbVhShVSNNivHdL+IAy1xUS2foZsk787z//ChqFzusKlQ/1/4C9rS0zukFLzAKqYFOJNyKTeOAi5BAqic7JJRPKY2mJyQtRCg+SEbw0vXIwkAkpqGNITJO2Zb2mcwP2YYZ+hpa2vrHIgBW4QEmNxqTWVHN0HtReV+GMtc+s0XY+JZcSBiyrnVDoHHOInQqqGagcWZfUhGnLQDFUHq2xwiEDUZHwVFuG06nIBRmm8WAh96wCBSXSYQkjvwkFE68zjlmd1c4zp2UdAqETK0QfQ1SIhRuwX8QCY+C0WKAHIbFgZU0mEpbrAtl6WlAYqmAZOs8MHS9yDEadB+uZxAXaUMQhk9RYzGgaYwIkXQL7uSVD3oJyNGmjQ11qNvAZq+kSEc4oYDlgV+pKEfGw2iEVgBRq7tIrdcQ+bsrsA2ZOeJw87BqraZq9hnq0q/NC+FmdMYtGb/XKsBjar6+++fOIJ9yjrdzb6QXahchx3c1fOHMYhIfr4Q55GO5YgZCxWX+6rUDdJEWOymFvFJ++OH/NFuzxYLQz5/6Fw8PXZ8+ev7l4TnZpqsb+6+YdN9r5ClTvqJ2Xxu3GXW056qs8S9ZTzOONHxoJIvBOiHe15ozuYs0Tnm5fJJOEz7TztL1aZeDwvZVtS8ufa7TESpOEL8AKyGg+EbEIR7+LzZPji3E+fLe+1T9iBx83B33uxrGiWbwAWYcLdsLnuNx5SrWTNukmMrkV95/Fw48uycpWf+9SQIQSNU7zHI2/U7bPwufvL3nCs/XDqApPL26hobcaNDzlV/yKh2dimCHhbUPrKy5BlTWUJB/NEo9ATanpk9A8kND6BwV2EJBddoqR0CfFdVDhByqxV7j8cSMed76osIa2k6bkTNq2/Qc29l+E",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Folder",permalink:"/docs/API-docs/getfolder"},next:{title:"Delete Folder",permalink:"/docs/API-docs/deletefolder"}},f={},y=[{value:"Request",id:"request",level:2}];function g(e){const a={h2:"h2",p:"p",...(0,r.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Update Folder"})}),"\n",(0,l.jsx)(i(),{method:"put",path:"/folder/{folder_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Update Folder API allows you to uodate folder name as well as parentFolderId."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(o.Z,{className:"paramsItem",param:{name:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"bK1cfd2hpb"}}})})})]}),"\n",(0,l.jsx)(t.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(a.p,{children:"Body"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(a.p,{children:"Provide below parameter to create folder"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"folderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new folder"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"parentFolderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Hks2JpewIp"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "objectId": "Hks2JpewIp",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"folder not found."})}),(0,l.jsx)("div",{children:(0,l.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder not found."}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "folder not found."\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,r.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/a2bc1463.7b31efc4.js b/assets/js/a2bc1463.7b31efc4.js deleted file mode 100644 index 665995d0f..000000000 --- a/assets/js/a2bc1463.7b31efc4.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2245],{87435:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>u,default:()=>y,frontMatter:()=>x,metadata:()=>j,toc:()=>g});var i=s(85893),l=s(11151),t=s(58219),n=(s(62316),s(51039)),r=s.n(n),c=(s(82723),s(9487)),o=s(41429),d=s(5397),m=s(4667),p=s(9472),h=s(85162);const x={id:"contactlist",title:"Get Contact list",description:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.",sidebar_label:"Get Contact list",hide_title:!0,hide_table_of_contents:!0,api:"eJzNV+tu2zYUfpVT/tkKKLacph1mDEODrsiCdW2BZCiw1CiOpGOJMUWyJCXbMPxvT7JH25MMh5IdOWm6ZSiKAUESkd+5X7kRAUsvplfihdEB8+DFLBEF+dxJG6TRYiouK4L+Fl5JH+D07TlQbc2SnIe1aSAYcBScpJYAQTHGzCHvOSZgnWllIXUJCLmpraOKtJctQStpyVhUCrBFqTBTtKcEqZm/2x1kxixGIhHGkkPW7rwQU9FfsliRCIsOawrk2KqN0FiTmAola8m3kg362JBbi0Q4+thIR4WYzlF5SoQPa8XouXG1SAStrDIFiWlwDd/mFdUophtR40rWTS2mT9M0EWFtmUg3dUZObJkOa8uMJuk22avgF9J+MQ3ul5luZ8zXW6M9ecYepyn/OQyqb/KcvJ83CvbeFEn0JenAeLRWyTxejK89E23uKmCya8qj2x2zCbIT6cg3Kgxw6ByywTJQ7f+Zvjvm6O6RPjipS5FE12AYnuxtF7aaZNXq+NqySzq/P4zBtSHIiKJHa5TqP9BnRM/7g1FuamZlK6MfrMrJ5MnkOP4wi9wRBipOw6fY3BAdp8dPjibpUfrd5eTZ9OT76dNnozRNfxeJWNXRmj4bCwzRyiCDGn43tvgKcra3YX0NFxRQKj8k6G/Edjs4lFpJTR92af6BU3wbESefSvYLU1OouP8sSQdYOqPLBKwi9ATBrQFLlBoUBnKPvlwVkHPGfd6PD9Pscy44SdMPk70Tnt51wrluUckidu9LsyD9dS0dig+d+LtpIDtQvBcHxg7POyM95Y2TYR3b/OoIrTzq7qdXM+6B7FjD86Gkbi6ESkzF+HBaeHLtblTcypklliW5n5ssqnzaBAO/mnzR2dU4JaaiCsH66XjcShc6TiPfkVVNxsU/futw3ij1GtsFurGxpMeTUTpKBQ+GQyYedZGZ1YhBXpZaYeYjD7Ry3E4+QYHWPgDtA5ZSl0efpZrd+PWCY9+F98C7Nz3dyl+Im3ofvCGqn3MVYcHzacvfcxOJ+5C+saQvZKmjd9uJuL11vCOVm5p4twgVwQ7+1x9/RorC5E1NOsR8fQRvGgdxIeGBhrqAuaKV5F2CwaiUWe5XFU9YK/JerUHqQKXDQFDIUgZUwF7hcszRYiaV5AxnmOkWkUGR+BG8qyhU5PjqG8erT0EtKS4MUMZwqrA8bIKpo4xeZ1gat5izSgkgZI2XmrwHT7QjIV2hzgl2sUjAOEANpAM566QnQFkzeG4c0Hwuc8mMObkd72k1aiyJhSXAerMXui2MPDiTNT6AN6qJhrDEmih0Jmqiwo/gJ17PouF82DVmKqBsmEUCuSkI+upmM3QBGfkAlsXLnCJTH9AFUNSSi7kXI8n1ANZw25GoePkbxpYZBYfa82jsFNqFZu8+6wzvLlFGgesRvNfvNXdSaDxxAiipF376Xh/B1T7N3lHmZaDZt7t6WC6Xd+rg8SHNmQxVk4Eja27oyngYq2ZIvv94LBIRyNX+zfyCXCtz6ovwHpnjCB73zZhHHTfUbvngGnt+m4Abo5I5aU+D1nl69vYVtPBklB60p3+h8PjV+YuXry9eMl9uhl397dqUsMaHGvVA1BmF/YOg76MHtbu5GSv/w8dD370CrcLYKpRx0ESHbfohcXXwpJglojI+8PFmk6Gn35zabvm42+Lj6JCeZd/s8QtaD14dLaqGZcaufA+2fx7cQGf84SRj40hLdt2UBXY0p3lOdijgzgw/GIRnLy9FIrBhG4ddfBG7eP8Pc99d6fWA92F77xTg32zTJwl+4FD/Qusf9/Du5l6C3r4dmiMz2263fwMPsQ/i",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/contactlist",title:"Get Contact list",description:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.",source:"@site/docs/API-docs/contactlist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/contactlist",permalink:"/docs/API-docs/contactlist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"contactlist",title:"Get Contact list",description:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.",sidebar_label:"Get Contact list",hide_title:!0,hide_table_of_contents:!0,api:"eJzNV+tu2zYUfpVT/tkKKLacph1mDEODrsiCdW2BZCiw1CiOpGOJMUWyJCXbMPxvT7JH25MMh5IdOWm6ZSiKAUESkd+5X7kRAUsvplfihdEB8+DFLBEF+dxJG6TRYiouK4L+Fl5JH+D07TlQbc2SnIe1aSAYcBScpJYAQTHGzCHvOSZgnWllIXUJCLmpraOKtJctQStpyVhUCrBFqTBTtKcEqZm/2x1kxixGIhHGkkPW7rwQU9FfsliRCIsOawrk2KqN0FiTmAola8m3kg362JBbi0Q4+thIR4WYzlF5SoQPa8XouXG1SAStrDIFiWlwDd/mFdUophtR40rWTS2mT9M0EWFtmUg3dUZObJkOa8uMJuk22avgF9J+MQ3ul5luZ8zXW6M9ecYepyn/OQyqb/KcvJ83CvbeFEn0JenAeLRWyTxejK89E23uKmCya8qj2x2zCbIT6cg3Kgxw6ByywTJQ7f+Zvjvm6O6RPjipS5FE12AYnuxtF7aaZNXq+NqySzq/P4zBtSHIiKJHa5TqP9BnRM/7g1FuamZlK6MfrMrJ5MnkOP4wi9wRBipOw6fY3BAdp8dPjibpUfrd5eTZ9OT76dNnozRNfxeJWNXRmj4bCwzRyiCDGn43tvgKcra3YX0NFxRQKj8k6G/Edjs4lFpJTR92af6BU3wbESefSvYLU1OouP8sSQdYOqPLBKwi9ATBrQFLlBoUBnKPvlwVkHPGfd6PD9Pscy44SdMPk70Tnt51wrluUckidu9LsyD9dS0dig+d+LtpIDtQvBcHxg7POyM95Y2TYR3b/OoIrTzq7qdXM+6B7FjD86Gkbi6ESkzF+HBaeHLtblTcypklliW5n5ssqnzaBAO/mnzR2dU4JaaiCsH66XjcShc6TiPfkVVNxsU/futw3ij1GtsFurGxpMeTUTpKBQ+GQyYedZGZ1YhBXpZaYeYjD7Ry3E4+QYHWPgDtA5ZSl0efpZrd+PWCY9+F98C7Nz3dyl+Im3ofvCGqn3MVYcHzacvfcxOJ+5C+saQvZKmjd9uJuL11vCOVm5p4twgVwQ7+1x9/RorC5E1NOsR8fQRvGgdxIeGBhrqAuaKV5F2CwaiUWe5XFU9YK/JerUHqQKXDQFDIUgZUwF7hcszRYiaV5AxnmOkWkUGR+BG8qyhU5PjqG8erT0EtKS4MUMZwqrA8bIKpo4xeZ1gat5izSgkgZI2XmrwHT7QjIV2hzgl2sUjAOEANpAM566QnQFkzeG4c0Hwuc8mMObkd72k1aiyJhSXAerMXui2MPDiTNT6AN6qJhrDEmih0Jmqiwo/gJ17PouF82DVmKqBsmEUCuSkI+upmM3QBGfkAlsXLnCJTH9AFUNSSi7kXI8n1ANZw25GoePkbxpYZBYfa82jsFNqFZu8+6wzvLlFGgesRvNfvNXdSaDxxAiipF376Xh/B1T7N3lHmZaDZt7t6WC6Xd+rg8SHNmQxVk4Eja27oyngYq2ZIvv94LBIRyNX+zfyCXCtz6ovwHpnjCB73zZhHHTfUbvngGnt+m4Abo5I5aU+D1nl69vYVtPBklB60p3+h8PjV+YuXry9eMl9uhl397dqUsMaHGvVA1BmF/YOg76MHtbu5GSv/w8dD370CrcLYKpRx0ESHbfohcXXwpJglojI+8PFmk6Gn35zabvm42+Lj6JCeZd/s8QtaD14dLaqGZcaufA+2fx7cQGf84SRj40hLdt2UBXY0p3lOdijgzgw/GIRnLy9FIrBhG4ddfBG7eP8Pc99d6fWA92F77xTg32zTJwl+4FD/Qusf9/Du5l6C3r4dmiMz2263fwMPsQ/i",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete Contact",permalink:"/docs/API-docs/deletecontact"},next:{title:"Self Sign",permalink:"/docs/API-docs/selfsign"}},f={},g=[{value:"Request",id:"request",level:2}];function v(e){const a={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(a.p,{children:"Get Contact list"})}),"\n",(0,i.jsx)(r(),{method:"get",path:"/contactlist"}),"\n",(0,i.jsx)(a.p,{children:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook."}),"\n",(0,i.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,i.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(a.p,{children:"Query Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsxs)("ul",{children:[(0,i.jsx)(o.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,i.jsx)(o.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(t.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"successful operation"})}),(0,i.jsx)("div",{children:(0,i.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(m.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(a.p,{children:"result"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(a.p,{children:"contactdetails[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(a.p,{children:"Array ["})})}),(0,i.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(a.p,{children:"]"})})})]})]})})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "result": [\n {\n "objectId": "ph1bhx2jp",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "4131231231",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,i.jsx)(a,{...e,children:(0,i.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/a2bc1463.a7b94822.js b/assets/js/a2bc1463.a7b94822.js new file mode 100644 index 000000000..609899526 --- /dev/null +++ b/assets/js/a2bc1463.a7b94822.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2245],{87435:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>u,default:()=>b,frontMatter:()=>x,metadata:()=>j,toc:()=>g});var t=a(85893),l=a(11151),n=a(58219),i=(a(62316),a(51039)),o=a.n(i),r=(a(82723),a(9487)),c=a(41429),d=a(5397),m=a(4667),p=a(9472),h=a(85162);const x={id:"contactlist",title:"Get Contact list",description:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.",sidebar_label:"Get Contact list",hide_title:!0,hide_table_of_contents:!0,api:"eJzNV21r3EYQ/iuT/dIG5DudY6dUlBKTBmMSmoBdAnWOMJLmpPWtdje7q3vhuG/9Jf1p/SVlVrqzzo7TuoRQMLG1+8zrzjwz2YiAlRfZtXhpdMAieDFNREm+cNIGabTIxFVN0N/CG+kDnL27AGqsWZLzsDYtBAOOgpO0IEBQjDEzKHqNCVhnFrKUugKEwjTWUU3aywXBQtKSsagU4AKlwlzRXhKkZv1ud5AbMx+JRBhLDtm7i1Jkor9ksyIRFh02FMhxVBuhsSGRCSUbybeSA/rUkluLRDj61EpHpchmqDwlwoe1YvTMuEYkglZWmZJEFlzLt0VNDYpsIxpcyaZtRHaapokIa8tCum1ycmLLcthYVjRJt8neBT+X9qt58LDNdDtlvd4a7ckz9jhN+dfho/q2KMj7Watgn02RxFySDoxHa5Us4sX4xrPQ5r4DJr+hIqbdsZogO5OOfKvCAIfOIQcsAzX+n+W7Y37dPdIHJ3UlkpgaDMOTfezC1pO8Xh3fWE5Jl/fHKbgxBDlRzGiDUv0H+ZzoRX8wKkzDqmxt9KNdOZk8mxzHH1ZROMJA5Vn4nJpboeP0+NnRJD1Kf7iaPM9OfsxOn4/SNP1dJGLVxGj6aiwxxCiDDGr43dryG9jZ3oX1PVxSQKn8UKC/Edvt4FBqJTV93JX5Ry7xbUScfK7YL01DoWb+WZIOsHRGVwlYRegJglsDVig1KAzknny9LiDnjPtyHh/n2ZdScJKmHyf7JJzeT8KFXqCSZWTvKzMn/W0jHZoPnfn7ZSA7ULwXB8EOz7sgPRWtk2EdaX51hFYedffZ9ZQ5kBNreD5U1M2FUItMjA+nhSe32I2K1imRiToE67Px2KMuc7MaGcujqtIKc8/9PEYrxwvuybsSaO0j0D5gJXV19EWp6W2Yl/wUXbYPgr2lWCtfE3Nsn8shqh87NWHJ42LL3zMThfsMv7WkL2Wl4/ssJuLuEvCeVGEa4lEfaoId/K8//owSpSnahnSI5fME3rYO4n7A8wV1CTNFK8mjncGolFnuNwdP2CjyXq1B6kCVw0BQykoGVMBZ4e4o0GIuleSCY5jp9oJBzfoRvK8p1OT46jvHm0hJC1Jcp6CMmbOeYADbYJpoo/cZlsbNZ+xSAgh566Um78ET7URI16gLgt1bJGAcoAbSgZx10hOgbBg8Mw5oNpOFZMVca47XpgY1VsTGEmC/OQvdUkQenMlbH8Ab1cZA2GJDFLoQNVHpR/ALb0sxcD7seJJKqFpWkUBhSoK+2TgMXUJOPoBl87KgqNQHdAEULcjF2osvOWuVAmuYBSQq3sWGb8uKgkPteVJ1Du2eZp8+6wyvEtFGiesRfNAfNBMbtJ64AJTUc5990EdwvS+z95R7GWj6/a4flsvlvT54eihzLkPd5uDImlu5Kh7GrhmK7z+eikQEco1/O7skt5AF9U34gM1xBI97buTJw/zW7QLcYy/uCjBPKVmQ9jRgsrPzd29gAc9GqUgGnf8vHB6/uXj56tfLV6yXuanrv8koHaVxlzA+NKgHps4p7PfzntYOendzy/L/w12+Z69AqzC2CmXk/ZiwTc/Z1wcb/jQRtfGBjzebHD395tR2y8fdUs1MXkrPtm/X6jmtB/8JWKBq2WZk5Qew/bZ+C53yh5OMjRMm2bEpG+xkzoqC7NDAvZF6MJfOX12JRGDLMQ5ZfB5ZvP+Dte+u9Hqg+5DeOwf4X47pswI/8VO/pvXPe3h386BAH98OzS8z3W63fwN4mego",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/contactlist",title:"Get Contact list",description:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.",source:"@site/docs/API-docs/contactlist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/contactlist",permalink:"/docs/API-docs/contactlist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"contactlist",title:"Get Contact list",description:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.",sidebar_label:"Get Contact list",hide_title:!0,hide_table_of_contents:!0,api:"eJzNV21r3EYQ/iuT/dIG5DudY6dUlBKTBmMSmoBdAnWOMJLmpPWtdje7q3vhuG/9Jf1p/SVlVrqzzo7TuoRQMLG1+8zrzjwz2YiAlRfZtXhpdMAieDFNREm+cNIGabTIxFVN0N/CG+kDnL27AGqsWZLzsDYtBAOOgpO0IEBQjDEzKHqNCVhnFrKUugKEwjTWUU3aywXBQtKSsagU4AKlwlzRXhKkZv1ud5AbMx+JRBhLDtm7i1Jkor9ksyIRFh02FMhxVBuhsSGRCSUbybeSA/rUkluLRDj61EpHpchmqDwlwoe1YvTMuEYkglZWmZJEFlzLt0VNDYpsIxpcyaZtRHaapokIa8tCum1ycmLLcthYVjRJt8neBT+X9qt58LDNdDtlvd4a7ckz9jhN+dfho/q2KMj7Watgn02RxFySDoxHa5Us4sX4xrPQ5r4DJr+hIqbdsZogO5OOfKvCAIfOIQcsAzX+n+W7Y37dPdIHJ3UlkpgaDMOTfezC1pO8Xh3fWE5Jl/fHKbgxBDlRzGiDUv0H+ZzoRX8wKkzDqmxt9KNdOZk8mxzHH1ZROMJA5Vn4nJpboeP0+NnRJD1Kf7iaPM9OfsxOn4/SNP1dJGLVxGj6aiwxxCiDDGr43dryG9jZ3oX1PVxSQKn8UKC/Edvt4FBqJTV93JX5Ry7xbUScfK7YL01DoWb+WZIOsHRGVwlYRegJglsDVig1KAzknny9LiDnjPtyHh/n2ZdScJKmHyf7JJzeT8KFXqCSZWTvKzMn/W0jHZoPnfn7ZSA7ULwXB8EOz7sgPRWtk2EdaX51hFYedffZ9ZQ5kBNreD5U1M2FUItMjA+nhSe32I2K1imRiToE67Px2KMuc7MaGcujqtIKc8/9PEYrxwvuybsSaO0j0D5gJXV19EWp6W2Yl/wUXbYPgr2lWCtfE3Nsn8shqh87NWHJ42LL3zMThfsMv7WkL2Wl4/ssJuLuEvCeVGEa4lEfaoId/K8//owSpSnahnSI5fME3rYO4n7A8wV1CTNFK8mjncGolFnuNwdP2CjyXq1B6kCVw0BQykoGVMBZ4e4o0GIuleSCY5jp9oJBzfoRvK8p1OT46jvHm0hJC1Jcp6CMmbOeYADbYJpoo/cZlsbNZ+xSAgh566Um78ET7URI16gLgt1bJGAcoAbSgZx10hOgbBg8Mw5oNpOFZMVca47XpgY1VsTGEmC/OQvdUkQenMlbH8Ab1cZA2GJDFLoQNVHpR/ALb0sxcD7seJJKqFpWkUBhSoK+2TgMXUJOPoBl87KgqNQHdAEULcjF2osvOWuVAmuYBSQq3sWGb8uKgkPteVJ1Du2eZp8+6wyvEtFGiesRfNAfNBMbtJ64AJTUc5990EdwvS+z95R7GWj6/a4flsvlvT54eihzLkPd5uDImlu5Kh7GrhmK7z+eikQEco1/O7skt5AF9U34gM1xBI97buTJw/zW7QLcYy/uCjBPKVmQ9jRgsrPzd29gAc9GqUgGnf8vHB6/uXj56tfLV6yXuanrv8koHaVxlzA+NKgHps4p7PfzntYOendzy/L/w12+Z69AqzC2CmXk/ZiwTc/Z1wcb/jQRtfGBjzebHD395tR2y8fdUs1MXkrPtm/X6jmtB/8JWKBq2WZk5Qew/bZ+C53yh5OMjRMm2bEpG+xkzoqC7NDAvZF6MJfOX12JRGDLMQ5ZfB5ZvP+Dte+u9Hqg+5DeOwf4X47pswI/8VO/pvXPe3h386BAH98OzS8z3W63fwN4mego",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete Contact",permalink:"/docs/API-docs/deletecontact"},next:{title:"Self Sign",permalink:"/docs/API-docs/selfsign"}},f={},g=[{value:"Request",id:"request",level:2}];function v(e){const s={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(s.p,{children:"Get Contact list"})}),"\n",(0,t.jsx)(o(),{method:"get",path:"/contactlist"}),"\n",(0,t.jsx)(s.p,{children:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook."}),"\n",(0,t.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(s.p,{children:"Query Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsxs)("ul",{children:[(0,t.jsx)(c.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,t.jsx)(c.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(n.Z,{children:[(0,t.jsxs)(h.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"successful operation"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(s.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!0,className:"schemaItem",children:(0,t.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsxs)("span",{className:"openapi-schema__container",children:[(0,t.jsx)("strong",{className:"openapi-schema__property",children:(0,t.jsx)(s.p,{children:"result"})}),(0,t.jsx)("span",{className:"openapi-schema__name",children:(0,t.jsx)(s.p,{children:"contactdetails[]"})})]})}),(0,t.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,t.jsx)(s.p,{children:"Array ["})})}),(0,t.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,t.jsx)(s.p,{children:"]"})})})]})]})})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "result": [\n {\n "objectId": "ph1bhx2jp",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "4131231231",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"400",value:"400",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"Something went wrong, please try again later!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(s.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(s.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/a88a3db3.cfc4bd5c.js b/assets/js/a88a3db3.e09eee0c.js similarity index 61% rename from assets/js/a88a3db3.cfc4bd5c.js rename to assets/js/a88a3db3.e09eee0c.js index b1cebcc44..925dd9ca4 100644 --- a/assets/js/a88a3db3.cfc4bd5c.js +++ b/assets/js/a88a3db3.e09eee0c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7894],{79523:(e,a,l)=>{l.r(a),l.d(a,{assets:()=>f,contentTitle:()=>u,default:()=>v,frontMatter:()=>x,metadata:()=>j,toc:()=>g});var s=l(85893),t=l(11151),n=l(58219),i=(l(62316),l(51039)),d=l.n(i),r=(l(82723),l(9487)),m=l(41429),p=l(5397),o=l(4667),c=l(9472),h=l(85162);const x={id:"delete-template",title:"Delete Template",description:"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed",sidebar_label:"Delete Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzNV21v2zYQ/itXflkLKLaTph0mDMOyNeiCdm2xZCiw1Aho6SSxoUiWPMk2DH3bL9lP2y8ZjrIcv6TBCgzFvtgWde/He57zSpAsg0ivxRXWTkvCIKaJyDFkXjlS1ohUXFUIL1AjIQxScPbuApy3rcoxwNI2MFdUAVUIcqa0oiWQBY+1bREkBIeZKlQGNOgX3tZRfDgJI7goQN5JqADGgramRA8GMcdcJMI69JLjushFKvIY1RCUSISTXtZI6DmnlTCyRpGKweaNYhOKc3KSKrGf6MULsMVOVECVpOg9cEIzhN4l2/H4qVEec5GSbzARgZaavQVVO83B4MJpm6NIC6kDC2QV1lKkK0FLFyXJK1OKRBTW15LuTrpuyvaDsyZgYI2TyYS/9hozRLkOCkKTZRhC0Wi9fCQSkVlDaIg1pXNaZbF044+B1VeHAdnZR8yI6+i50KR65/0xV/wwdFzImG4qflpUJzK4X9xT0SXr1uRn9LDSyeTk6dHx5Gjy7dXx8/T0u/TZ89FkMvlDJGJRa9Zd9zDnBneJIEX67rk7EItudwTXJx0Ln95XxktbI1XKlDBHQzD31pQJOI0yIJBfgiylMsCV9v9hVdF76x+uzpdF1m1lrYxWBm+GO3RzOpncHG+KcPrAXTKWoLCNyb9uqvf5fzih05vnm4SeHSZ0YVqpVR6R6sreovm6+Wy7p9794W1VvVB8L3aS3T7vkwyYNV7RMgLb4kg6ddS/T6+nDBd8U+wdKEYwpEqkYjyA2Xi1BYSdYJO+HaBybyTmsizR/9LMYgJnDVn41Wa3fZaN1yIVFZEL6XjcKk+9pVHo1apmNspsPX7nJUPRG9neSj+2Ds34eDQZTUSXrPaMBGnymV2MWCio0mg5C9GGdGrcHt+jIZ37AulAslSmPHpQa3pX5Uu+CX2zd2q9abl06hUuRTK0cltqzTEVyhx9bLsyhY3K6wa/dWguVWliddvjAyZ6jzqzNTLnMB0N4n//+VfUyG3W1Ggo3t5H8Lbx4OwcfdFokCaHQuNCzXRP01JrO+9JmiwElLXGEPQSlCEsfeQPVSqSGrgqjDaZdD2NKwwsZlnbw9bIhBG8r5Aq9PzqG88sn2OLmscEtLV8VdifbMjW0cc6Zphbf1twSAlImDVBGQwBAuKggqaSJkMYepGA9SANoCH0zquAIFXNwoX1gEWhMsWGebi9zAhqaWSJ7CwBjntnWfF21gSCYHUTE2GPNSL1KUaqH8EL1WKfOB/mSFJpzKFs2EQCmc0R1rPOaZgcZhgIHLtXGUajgaQn0Niij3cvdpLnAZxlEFJS87qx3Vs2RF6awAtBH9DQmk35nLfM8dFHLpcj+GA+GCYKaALyBdDK3Ib0gzmC6801e4+zoAinj4d5mM/nB3PwZFfnpaKqmYFHZ+/0yngYp2ZbffPwRCSC0NfhbXGJvlUZrofwMz7HUXi8hmaZRWjGWirdz9iP+woMk1plaAJuAenZy3evoYWno8kOPP2LgMevL34+f3N5znYZDPv5G2BKOBuolmbL1d4mvD+6qzuO+V8tzmvYIlzQ2GmpIt/ESq3WRHG92ZNFItLtnXmaiMoGYpHVaiYD/u511/HxpwY9M9I0Ea30Ss4Y3ZhNVODf+Wb3/WyNHv+2XqOfwJet3/cmNICzYWRupW74SSTiFpd7/wO6aZcMCM0R9xJnWYaOtnQPtoQdqn1x/vr86lwkQjZcwW1yuI3ksP7BDu4NbZc1+hj4kwnsXoXv+f68wuUPG/H+zWcV1ikO0lymadd1/wAGb98U",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/delete-template",title:"Delete Template",description:"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed",source:"@site/docs/API-docs/delete-template.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/delete-template",permalink:"/docs/API-docs/delete-template",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"delete-template",title:"Delete Template",description:"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed",sidebar_label:"Delete Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzNV21v2zYQ/itXflkLKLaTph0mDMOyNeiCdm2xZCiw1Aho6SSxoUiWPMk2DH3bL9lP2y8ZjrIcv6TBCgzFvtgWde/He57zSpAsg0ivxRXWTkvCIKaJyDFkXjlS1ohUXFUIL1AjIQxScPbuApy3rcoxwNI2MFdUAVUIcqa0oiWQBY+1bREkBIeZKlQGNOgX3tZRfDgJI7goQN5JqADGgramRA8GMcdcJMI69JLjushFKvIY1RCUSISTXtZI6DmnlTCyRpGKweaNYhOKc3KSKrGf6MULsMVOVECVpOg9cEIzhN4l2/H4qVEec5GSbzARgZaavQVVO83B4MJpm6NIC6kDC2QV1lKkK0FLFyXJK1OKRBTW15LuTrpuyvaDsyZgYI2TyYS/9hozRLkOCkKTZRhC0Wi9fCQSkVlDaIg1pXNaZbF044+B1VeHAdnZR8yI6+i50KR65/0xV/wwdFzImG4qflpUJzK4X9xT0SXr1uRn9LDSyeTk6dHx5Gjy7dXx8/T0u/TZ89FkMvlDJGJRa9Zd9zDnBneJIEX67rk7EItudwTXJx0Ln95XxktbI1XKlDBHQzD31pQJOI0yIJBfgiylMsCV9v9hVdF76x+uzpdF1m1lrYxWBm+GO3RzOpncHG+KcPrAXTKWoLCNyb9uqvf5fzih05vnm4SeHSZ0YVqpVR6R6sreovm6+Wy7p9794W1VvVB8L3aS3T7vkwyYNV7RMgLb4kg6ddS/T6+nDBd8U+wdKEYwpEqkYjyA2Xi1BYSdYJO+HaBybyTmsizR/9LMYgJnDVn41Wa3fZaN1yIVFZEL6XjcKk+9pVHo1apmNspsPX7nJUPRG9neSj+2Ds34eDQZTUSXrPaMBGnymV2MWCio0mg5C9GGdGrcHt+jIZ37AulAslSmPHpQa3pX5Uu+CX2zd2q9abl06hUuRTK0cltqzTEVyhx9bLsyhY3K6wa/dWguVWliddvjAyZ6jzqzNTLnMB0N4n//+VfUyG3W1Ggo3t5H8Lbx4OwcfdFokCaHQuNCzXRP01JrO+9JmiwElLXGEPQSlCEsfeQPVSqSGrgqjDaZdD2NKwwsZlnbw9bIhBG8r5Aq9PzqG88sn2OLmscEtLV8VdifbMjW0cc6Zphbf1twSAlImDVBGQwBAuKggqaSJkMYepGA9SANoCH0zquAIFXNwoX1gEWhMsWGebi9zAhqaWSJ7CwBjntnWfF21gSCYHUTE2GPNSL1KUaqH8EL1WKfOB/mSFJpzKFs2EQCmc0R1rPOaZgcZhgIHLtXGUajgaQn0Niij3cvdpLnAZxlEFJS87qx3Vs2RF6awAtBH9DQmk35nLfM8dFHLpcj+GA+GCYKaALyBdDK3Ib0gzmC6801e4+zoAinj4d5mM/nB3PwZFfnpaKqmYFHZ+/0yngYp2ZbffPwRCSC0NfhbXGJvlUZrofwMz7HUXi8hmaZRWjGWirdz9iP+woMk1plaAJuAenZy3evoYWno8kOPP2LgMevL34+f3N5znYZDPv5G2BKOBuolmbL1d4mvD+6qzuO+V8tzmvYIlzQ2GmpIt/ESq3WRHG92ZNFItLtnXmaiMoGYpHVaiYD/u511/HxpwY9M9I0Ea30Ss4Y3ZhNVODf+Wb3/WyNHv+2XqOfwJet3/cmNICzYWRupW74SSTiFpd7/wO6aZcMCM0R9xJnWYaOtnQPtoQdqn1x/vr86lwkQjZcwW1yuI3ksP7BDu4NbZc1+hj4kwnsXoXv+f68wuUPG/H+zWcV1ikO0lymadd1/wAGb98U",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Update Template",permalink:"/docs/API-docs/update-template"},next:{title:"Get Template list",permalink:"/docs/API-docs/gettemplatelist"}},f={},g=[{value:"Request",id:"request",level:2}];function y(e){const a={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:l}=a;return l||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)("h1",{className:"openapi__heading",children:(0,s.jsx)(a.p,{children:"Delete Template"})}),"\n",(0,s.jsx)(d(),{method:"delete",path:"/template/{template_id}"}),"\n",(0,s.jsx)(a.p,{children:"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed"}),"\n",(0,s.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,s.jsxs)(l,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},children:(0,s.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,s.jsx)(a.p,{children:"Path Parameters"})})}),(0,s.jsx)("div",{children:(0,s.jsx)("ul",{children:(0,s.jsx)(m.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of the template that needs to be deleted",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}})})})]}),"\n",(0,s.jsx)("div",{children:(0,s.jsx)("div",{children:(0,s.jsxs)(n.Z,{children:[(0,s.jsxs)(h.default,{label:"200",value:"200",children:[(0,s.jsx)("div",{children:(0,s.jsx)(a.p,{children:"Template deleted successfully!"})}),(0,s.jsx)("div",{children:(0,s.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,s.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,s.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,s.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,s.jsxs)(l,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,s.jsx)("strong",{children:(0,s.jsx)(a.p,{children:"Schema"})})}),(0,s.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,s.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,s.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bxh2aspHp3"}}),(0,s.jsx)(o.Z,{collapsible:!1,name:"deletedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,s.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,s.jsx)(p.Z,{responseExample:'{\n "objectId": "Bxh2aspHp3",\n "deletedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,s.jsxs)(h.default,{label:"400",value:"400",children:[(0,s.jsx)("div",{children:(0,s.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,s.jsx)("div",{children:(0,s.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,s.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,s.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,s.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,s.jsxs)(l,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,s.jsx)("strong",{children:(0,s.jsx)(a.p,{children:"Schema"})})}),(0,s.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,s.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,s.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,s.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,s.jsx)(p.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,s.jsxs)(h.default,{label:"404",value:"404",children:[(0,s.jsx)("div",{children:(0,s.jsx)(a.p,{children:"Template not found!"})}),(0,s.jsx)("div",{children:(0,s.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,s.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,s.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,s.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,s.jsxs)(l,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,s.jsx)("strong",{children:(0,s.jsx)(a.p,{children:"Schema"})})}),(0,s.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,s.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,s.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template not found!"}})})]})}),(0,s.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,s.jsx)(p.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,s.jsxs)(h.default,{label:"405",value:"405",children:[(0,s.jsx)("div",{children:(0,s.jsx)(a.p,{children:"Invalid API Token!"})}),(0,s.jsx)("div",{children:(0,s.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,s.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,s.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,s.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,s.jsxs)(l,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,s.jsx)("strong",{children:(0,s.jsx)(a.p,{children:"Schema"})})}),(0,s.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,s.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,s.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,s.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,s.jsx)(p.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,s.jsx)(a,{...e,children:(0,s.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7894],{79523:(e,a,l)=>{l.r(a),l.d(a,{assets:()=>f,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>j,toc:()=>g});var s=l(85893),t=l(11151),i=l(58219),n=(l(62316),l(51039)),r=l.n(n),d=(l(82723),l(9487)),m=l(41429),p=l(5397),o=l(4667),c=l(9472),h=l(85162);const u={id:"delete-template",title:"Delete Template",description:"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed",sidebar_label:"Delete Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzNVttu3DYQ/ZUJX5oA8u7acVJUKIq6tZEaCZqgdhGgzsLgSiOJMUUy5GgvWOitX9JP65cUQ0l78TpGAxRBX3Ylam5nLme4FiTLINIbcY2105IwiGkicgyZV46UNSIV1xXCOWokhEEKzt5dgvN2rnIMsLINLBRVQBWCnCmtaAVkwWNt5wgSgsNMFSoDGvQLb+soPpyEEVwWILcSKoCxoK0p0YNBzDEXibAOveS4LnORijxGNQQlEuGklzUSesa0FkbWKFIx2LxVbEIxJiepEveBXp6DLfaiAqokRe+BAc0QOpdsx+OnRnnMRUq+wUQEWmn2FlTtNAeDS6dtjiItpA4skFVYS5GuBa1clCSvTCkSUVhfS9qetO2U7QdnTcDAGieTCf/dK8wQZR8UhCbLMISi0Xr1RCQis4bQEGtK57TKYurGHwOrrw8DsrOPmBHn0XOiSXXOu2PO+GHouJQRbip+WlYnMrhf3HPRJn1p8jN6XOlkcvL86HhyNPn2+vhlevpd+uLlaDKZ/CESsaw16/Y1zLnAbSJIkd6+twdi0e2eYH/SsvDpQ2m8sjVSpUwJCzQEC29NmYDTKAMC+RXIUioDnGn/H2YVvbf+8ex8WWTtDmpltDJ4O/TQ7elkcnu8ScLpI71kLEFhG5N/XagP+X8c0Ontyw2gF4eALs1capVHprq2d2i+Lp5d99S5P+xW1QnF72IP7O55BzJg1nhFq0hsyyPp1FH3Pb2ZMl1wp9gtKUYypEqkYjyQ2Xi9Q4StYJN+PlBl47VIRUXkQjoeB2nymV2OrEMTVGm0nIVRZuuxdGo8PxZtcl9DOvcF0oFkqUx59KjWdAv6igvT5X4P+qYC0qnXuBLJkNldqZ7yK5Q5+lgFZQoblft8v3VorlRpYrXmxweL4T3qzNbIK4C3wyD+959/RY3cZk2NhmIzPYG3jQdnF+iLRoM0ORQal2qmu60ptbaLbmeShYCy1hiCXoEyhKWPdK5KRVIDZ4WHP5Ou26oKA4tZ1vaw08FhBO8rpAo9f/rG89LNcY6auxa0tXdshyzIhmwdffQxw8L6u4JDSkDCrAnKYAgQEAcVNJU0GcJQiwSsB2kADaF3XgUEqWoWLqwHLAqVKTbMs+ZlRlBLI0tkZwlw3Ht3B29nTSAIVjcRCHusEamDGDfvCM7VHDvgfJgjSaUxh7JhEwlkNkfoR49hmBxmGAgcu1cZRqOBpCfQOEcfey9WkjclOMucoKTm7b9bWzZEXprA+7kLaCjNJn3OW1650UcuVyP4YD4Y5m1oAnIDaGXuQvrBHMHNps3e4ywowunTYR4Wi8XBHDzb13mlqGpm4NHZrV4ZD+PU7KpvXp6JRBD6OrwtrtDPVYb9EH7G5zgKj3umlFlkSqyl0t2M/XhfgVlLqwxNwB1eO3v17g3M4floIpKdyf8XAY/fXP588evVBdtlburm73g0GU34yNlAtTQ7ru5dTO+P7npL+f+re2xPW4RLGjstVaT/mKl1z9s3m2urSES6e4WdJqKygVhkvZ7JgL973bZ8/KlBzwtimoi59ErOmN1u1iJXgZ/zzVX0szl6+lt/q30GX3YbfhDQQM6GmXkudcNvIhF3uLp3LW+nbTIwNEfcSZxlGTra0T1Y2nub7/zizcX1hUiEbDiDu8vhLi6H/oEdPBja/tboYuBfXmAPKnzP/fMaVz9sxLsvn1XoIQ7SnKZp27b/AJOSt2k=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/delete-template",title:"Delete Template",description:"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed",source:"@site/docs/API-docs/delete-template.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/delete-template",permalink:"/docs/API-docs/delete-template",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"delete-template",title:"Delete Template",description:"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed",sidebar_label:"Delete Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzNVttu3DYQ/ZUJX5oA8u7acVJUKIq6tZEaCZqgdhGgzsLgSiOJMUUy5GgvWOitX9JP65cUQ0l78TpGAxRBX3Ylam5nLme4FiTLINIbcY2105IwiGkicgyZV46UNSIV1xXCOWokhEEKzt5dgvN2rnIMsLINLBRVQBWCnCmtaAVkwWNt5wgSgsNMFSoDGvQLb+soPpyEEVwWILcSKoCxoK0p0YNBzDEXibAOveS4LnORijxGNQQlEuGklzUSesa0FkbWKFIx2LxVbEIxJiepEveBXp6DLfaiAqokRe+BAc0QOpdsx+OnRnnMRUq+wUQEWmn2FlTtNAeDS6dtjiItpA4skFVYS5GuBa1clCSvTCkSUVhfS9qetO2U7QdnTcDAGieTCf/dK8wQZR8UhCbLMISi0Xr1RCQis4bQEGtK57TKYurGHwOrrw8DsrOPmBHn0XOiSXXOu2PO+GHouJQRbip+WlYnMrhf3HPRJn1p8jN6XOlkcvL86HhyNPn2+vhlevpd+uLlaDKZ/CESsaw16/Y1zLnAbSJIkd6+twdi0e2eYH/SsvDpQ2m8sjVSpUwJCzQEC29NmYDTKAMC+RXIUioDnGn/H2YVvbf+8ex8WWTtDmpltDJ4O/TQ7elkcnu8ScLpI71kLEFhG5N/XagP+X8c0Ontyw2gF4eALs1capVHprq2d2i+Lp5d99S5P+xW1QnF72IP7O55BzJg1nhFq0hsyyPp1FH3Pb2ZMl1wp9gtKUYypEqkYjyQ2Xi9Q4StYJN+PlBl47VIRUXkQjoeB2nymV2OrEMTVGm0nIVRZuuxdGo8PxZtcl9DOvcF0oFkqUx59KjWdAv6igvT5X4P+qYC0qnXuBLJkNldqZ7yK5Q5+lgFZQoblft8v3VorlRpYrXmxweL4T3qzNbIK4C3wyD+959/RY3cZk2NhmIzPYG3jQdnF+iLRoM0ORQal2qmu60ptbaLbmeShYCy1hiCXoEyhKWPdK5KRVIDZ4WHP5Ou26oKA4tZ1vaw08FhBO8rpAo9f/rG89LNcY6auxa0tXdshyzIhmwdffQxw8L6u4JDSkDCrAnKYAgQEAcVNJU0GcJQiwSsB2kADaF3XgUEqWoWLqwHLAqVKTbMs+ZlRlBLI0tkZwlw3Ht3B29nTSAIVjcRCHusEamDGDfvCM7VHDvgfJgjSaUxh7JhEwlkNkfoR49hmBxmGAgcu1cZRqOBpCfQOEcfey9WkjclOMucoKTm7b9bWzZEXprA+7kLaCjNJn3OW1650UcuVyP4YD4Y5m1oAnIDaGXuQvrBHMHNps3e4ywowunTYR4Wi8XBHDzb13mlqGpm4NHZrV4ZD+PU7KpvXp6JRBD6OrwtrtDPVYb9EH7G5zgKj3umlFlkSqyl0t2M/XhfgVlLqwxNwB1eO3v17g3M4floIpKdyf8XAY/fXP588evVBdtlburm73g0GU34yNlAtTQ7ru5dTO+P7npL+f+re2xPW4RLGjstVaT/mKl1z9s3m2urSES6e4WdJqKygVhkvZ7JgL973bZ8/KlBzwtimoi59ErOmN1u1iJXgZ/zzVX0szl6+lt/q30GX3YbfhDQQM6GmXkudcNvIhF3uLp3LW+nbTIwNEfcSZxlGTra0T1Y2nub7/zizcX1hUiEbDiDu8vhLi6H/oEdPBja/tboYuBfXmAPKnzP/fMaVz9sxLsvn1XoIQ7SnKZp27b/AJOSt2k=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Update Template",permalink:"/docs/API-docs/update-template"},next:{title:"Get Template list",permalink:"/docs/API-docs/gettemplatelist"}},f={},g=[{value:"Request",id:"request",level:2}];function v(e){const a={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:l}=a;return l||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)("h1",{className:"openapi__heading",children:(0,s.jsx)(a.p,{children:"Delete Template"})}),"\n",(0,s.jsx)(r(),{method:"delete",path:"/template/{template_id}"}),"\n",(0,s.jsx)(a.p,{children:"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed"}),"\n",(0,s.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,s.jsxs)(l,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},children:(0,s.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,s.jsx)(a.p,{children:"Path Parameters"})})}),(0,s.jsx)("div",{children:(0,s.jsx)("ul",{children:(0,s.jsx)(m.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of the template that needs to be deleted",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}})})})]}),"\n",(0,s.jsx)("div",{children:(0,s.jsx)("div",{children:(0,s.jsxs)(i.Z,{children:[(0,s.jsxs)(h.default,{label:"200",value:"200",children:[(0,s.jsx)("div",{children:(0,s.jsx)(a.p,{children:"Template deleted successfully!"})}),(0,s.jsx)("div",{children:(0,s.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,s.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,s.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,s.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,s.jsxs)(l,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,s.jsx)("strong",{children:(0,s.jsx)(a.p,{children:"Schema"})})}),(0,s.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,s.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,s.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bxh2aspHp3"}}),(0,s.jsx)(o.Z,{collapsible:!1,name:"deletedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,s.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,s.jsx)(p.Z,{responseExample:'{\n "objectId": "Bxh2aspHp3",\n "deletedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,s.jsxs)(h.default,{label:"400",value:"400",children:[(0,s.jsx)("div",{children:(0,s.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,s.jsx)("div",{children:(0,s.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,s.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,s.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,s.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,s.jsxs)(l,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,s.jsx)("strong",{children:(0,s.jsx)(a.p,{children:"Schema"})})}),(0,s.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,s.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,s.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,s.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,s.jsx)(p.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,s.jsxs)(h.default,{label:"404",value:"404",children:[(0,s.jsx)("div",{children:(0,s.jsx)(a.p,{children:"Template not found!"})}),(0,s.jsx)("div",{children:(0,s.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,s.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,s.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,s.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,s.jsxs)(l,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,s.jsx)("strong",{children:(0,s.jsx)(a.p,{children:"Schema"})})}),(0,s.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,s.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,s.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template not found!"}})})]})}),(0,s.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,s.jsx)(p.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,s.jsxs)(h.default,{label:"405",value:"405",children:[(0,s.jsx)("div",{children:(0,s.jsx)(a.p,{children:"Invalid API Token!"})}),(0,s.jsx)("div",{children:(0,s.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,s.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,s.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,s.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,s.jsxs)(l,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,s.jsx)("strong",{children:(0,s.jsx)(a.p,{children:"Schema"})})}),(0,s.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,s.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,s.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,s.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,s.jsx)(p.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,s.jsx)(a,{...e,children:(0,s.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/a9f09360.553c32a0.js b/assets/js/a9f09360.553c32a0.js new file mode 100644 index 000000000..7cbf67696 --- /dev/null +++ b/assets/js/a9f09360.553c32a0.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8888],{63135:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>g,contentTitle:()=>u,default:()=>y,frontMatter:()=>p,metadata:()=>x,toc:()=>j});var i=s(85893),a=s(11151),t=s(58219),l=(s(62316),s(51039)),r=s.n(l),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),m=s(9472),h=s(85162);const p={id:"draftdocument",title:"Draft Document",description:"The Draft Document API allows users to generate new documents by providing data with base64 encoded file.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztO39zGzeuXwW3/6TxrGVLcdKc582bS5O+O79ra0/jTOfG9rjULiQx3iW3JNey6tF/90nuo90neQOQ3B+yZDtJp+fOU/6ItSRIgiAAAiBwmzgxtcnhWfJOZ3WJytnkIk1ytJmRlZNaJYfJ6QzhnRETBxEI3pwcgSgKPbdQWzQWnIYpKjTCISicQx6ng/ECKqOvZS7VFHLhBMylm8FYWHx1AKgynWMOE1ng4Fydq1NZHcKHqtAih4WuDZy8+59mNlqG2s52dt7huJ7Ch6OdnYuvZs5V9nBvT1TVQFeorJyqQoztINPlXk6AVT55nsJ8hgZpVsiEAhRWFgsQeQ5zmU/R2RTcDBVkulpAprXJpRIObQqVmCKouhyjsSkIlUOpDYJUIMCgyBe7Tu/WFuF/3x//ABNtSuEGcFLUNm2Wy6XBzBULP72bYbOrZzZSwzoj1TSFUlwRtaSDX2qZXdG2Laqc/tLANydHTKudnfd1VWnjMIef/BYOd3ao5xss9ByEQYbPdFlqBZUwokTHxzUTjrsN/lJLg7k/FFEUkRaH52oXdnbcosLDnR04UrnMiBg8IbWCngTYgQclIhHo+wozOZEBtEM60ArmM5nNmCZz4c+zKkTm0TRoK8ycvMb+xDcpLGjid6h0xGCmjfxVKycKPo5rNE5mougeGyFIoNYJ44iclZbKxdawAvwjHA+dHh9K4CtCLSdilVJxj0W4FkWNNmA1T2FGWP2IlUHLrB7mJUKqHGYop7ON64n8Y21db2KoLaHZxSKsFU+JyYtMtokoLIKc9GhZiivsrAaaRVgUA/hmATlORF24FCRxnDM1DuAH7UBUVSEzMS6QOBdIeISrDe7yKQd2CIgoUfIZn7BEowUBuZxM0JBwUidPEcZE7IjPWhXAkuNmQoFWKwed6UIbmn6Fh7i9T0jItHKo3ADeXAtZMPZ+txakyoo6RxgXIrtKYVzUmILB3EvuAklvpUELEQgIG4jOBAKLBbGhVrQBpcPy0oINWOUDOJ1J2woUdUZa8yLSdskaxHaiaWWiQZQxwFLIImXKpfBRj8FJV2BKElsJtUhJYWIKDm/cWN+kkM0wu+JfRuRSw7h2Tiu/sdzoKtdzFYg50cpZ+esakYw9n07RUQoHKbxK4XUKw/0UhqMUhgcpDF+lMHydwmg/hdEohdFBCqNXHq3R60Br0RC4i8Bw5Kns/jjUJcX7nbQs2qQxbaOE5z0lfK6GA9jZaQSKm3/++edzdXuuAM4TErDz5PA8aUDOkxR8H+nN8+RwmEJouDlPDuHF6OsIsKDvV0Rd/z2n7yGdhv+e0fdoeK6WYdERI+NEWd2DCHX/9kjEz8BP1MgrU1vUbdRISsnDUg+dG7U2aFHHst3QC9qQVNJJUdjNe4oQT29bLWYrOzugnTH3bt4Wdz+9PUW0Yg8rT9/FyrbTFdUAIzJaIcHLQXvdbKCAX/SpESBg9aX7f0X7b3TWZiI0IE+PEl3UvpQcXw/YPmC9vZkYAeDpkaJF7EsJ8ZoIQffWZipQ79MjQcAqdgRbwPftH+wOX+6O9kcHPTKQG+UBynI3z3cXi8UXkhCYYGQehfXZ2gzWrDcCyYOdGF2ucVXYk2ihgvnEv6N5/z0Z9eNo72JOPiI7IdG4abzDrkXudC4Wz6yfKg5t7DiCb624RQdN7iI82FPOZlpmAXmCidbbmJzBARFhlwif733//V6HlL5xtywjfSG20vcuk77bWpaDPB+swvZOqNNaQp6nsKZ9fUeeQ1mWm9p9B12X5+rPJAjBdNssCwHg9xGHNVzfrr9RVtoOkWtV8Prs3a2XlZX7ZSZV6Ah8AysABqd1IQzekJtqpVZMl99AE61IURSi1sxnr5YdQo4ZeErAV8fBlH8eGJx20J+AWh4ed2dj3UkMTvGG58hq63RJyMhc0Awp2DqbkdMnosdAZG/jO/yViUpSdKFA57gVXTZYh4Q/tI5nToe66phbdL3NCAtx5BrfnE+fHY3hPt97wS+55+ILEE9P7Xcwi50+2kHdZ+dJKYLpkkyw/a3dDM15ctGM8T455p2xsG4wXNwjT9AKTY6FGGNxV9YeLQ3d7QTO6hCHOkqpmlACo7wfMeBecbPSGzqXa+TMb7vL4FG5RzGJdIZC2hhP6ROtOzoEnDgMqBA5sjhGiAMoaBul+EtZvkHsETwfFUI4nQdWIDhgwCbWFxe7R6hohd7JdOlCc5RSybIum6DlpJk1UqwMl3yXXDSSQuFxhe7p3llB3DywAkUINy9wroYcWYgxCdYLsN4WDCBPTzF0MHv4BvwcldG7NT/3vvt0QYz76grimmuSQP0F2Qih3SyFAzimS4kipn4QhcCyDCtH4bIvFdEG5cddS0OOJHVDZJsvpi7U782Dm5jpMdy5gvdvxocB7stsL6La45ixu40/EEP20H60reTjgaV/htoUDCyZ9Z6aMgxordz8SZroit5UpVZHeXKY5PQKG58Nk5SnRuu+0fkiObxNQgSffob4OI3c+2jpGfc2sdkMS0G/Ikr08Esvr0macKCG3n6JVMlhoscfMaM1KkM4OImWRjL04W2E8g+WSRqc9eQw8S+ZSZrgjSgrAk5WnnqrfJIs44L3TdW0tFNZ/tG8nNI8vbfqz5rtXWeGZZrQI+NnzvQDDeW9lXiq32pqdPhOLGxnQn/rJ6uv7DSGZCALoyAXC0tiVVtvn2WiyOqC/H68qaRZNEEIdv47XNEg2qzUIDp8uUz5tQFNFyVhjFgkaSIdlt32DUxg9KefXIaaKMPh4U8d+1HjGPEvoYFe9fmcRPnJWHzUCGPkM6pmWn3y+OHoxXA0fDEc0Qzhtefz6eh772LQZ4w35KViHm323faFNgV+GBk8xJwRnrctpvgwM55uernvvBfama6LnF7iUJgBP6B/dm5Gn7+bq2jwADcv0+Tm4c3cQKZ3Y1oAfFXgxEFdVWgg00ahed6N9z2ZzY0ODpZpsnh4e4s/5Pa+psObP7y7nzifos01+U/g+uL1Mk1mD+P6tybj4z+I7MGrZXu7JplB4TBeDpdjnS8uo95aPgQYLwqCm+giR0NWyF191aoa0jCUqXS5qufHWhco1BpF03vpDzllZBOSORgC3vMZklHdmoo8e2udBuPRY0vZA7gSg5SWbEBT43kygKNJx9bluMFqskGE5Yd/peEZr3dpa1bjz/bCN9HoWTerihJd2kB/RIGBwWFZFZyWNJdFQXjTvT6A5h+bew0lCYF4XcaFH74q3vpYJy8YBvVzeiBYjAN4K1ST1tFPn4Db24YNmDuWS7i9pVNFc0mX7nKZtg20Vq+B71XfYjBDed0b1TRhO7Bp6wz1Js4lmTi+IbygdRGQUyXV9LI2xXI5uMOG7Rk9mm53yBTOjib5f0AxQudIHZsczSMk92ji3TUNz4hZn4W4OVNGGuuCPHp2Dwj7p7ANVA7ZEOTlfdvIt63HlqBUnK+VH2fkdIqUuxggeHBINkKRzbxmYKzEhESb8xENXktd24jeTNjG5M4JQnpxkWra9zY71OFcsO7eB+tEV1F20vHpySNoyb7wrtdE3oX0u/RzwPHpCWU4yknw6AbwwTaUiKQVPRAgXwuupYhJUI35tvDhS1RMEa82e+mog5BbuAt3EcqlXYtR2r6lNPnAdyZuU2DpiHTtKPdWhrwu67CyPToyFg0hT3X9GK58gJICpjU/yzq6laNq5PedNkNRKutM7UO3kNcmJmUGtiDIDK1t6RSpQkCd+VNAZf1wARNhHZoUaiWJ8qamSEkzJd5UaCSqDNeSwKAnHUnuw9qsn+334cfvQuJz3EMUyjFJoJ8Yc6gr5hqWhCYNNZ7c6tY3aNuOynsYTU4X1SZIfwjgV2isVtSszVQo+avnZu05aYwzUUzYwGoe5/nSRZVHnGm2Pn7Rwvr3P/9FqDKnXpY6b7jXPp6xTigh2NlGGTnNCeRYoM92j0+LjZKzaVRsNrhr9MJo+CWQt6Ur2g/eSOs6yYsxb+CuUP6IRM+sgwOb9yRKxGhq0ZWqBq+QJNlOx4aX7Ce+NublCgN2zMReBMrfrmxGthGloP4omVsr6x3d0f4+/elTtCkmCKYn0Y6Ya1IXxeJPSfr4cNb9XnaDrVxrvN7nOc8+ytGvN9n16IQYZ4Pw3TtBMPRrU1CJAPHpbnMGHMfo0FaqQiq8ZBJf5jq7NGgvR/v7l0Oi8TJNDtaR8b0u0c2YdYiYc6OpgqAqUFBGu1mAmAqpgGxP8xtSFY3R5n5n4NMwW0OJyEOXBz0ivLxLhCPFr7Bcl3Kqr1D9vjvtLu/88oTqTckM49VhIj0Q9ye9zXbb/SYtZrWRbpEcnt0mN7uikru+//DsYnmRJkRYTRHhSlvGWLhZcpjsrQaILZprDvWd3Xr2bTjSCpXTQ+kd91NUcu96mCzT1RFrndWN0NaJqVTT3XtHXbQ7fU+n4Qne228bW6vk35GCa4GcXag0kcQFMxRkuxIB6ZB/bKPj38ajihHsdUHp9khWw8yrl8GawHGMG/dCwesjwcOXnRjsWQyncoS0CZCui3k2W49RzCaI2YlLdsKSZy3LNhHAGAAccuRsdHDAIaavhxyLefGawxwHr5bMZK3LnyR9t56fMVad0yTpO11xUONShFGtXeyf5XoGXmjqGzztzD0Do3exb7jXowUl1UQzM4UTPq5QvScDlUT2eng37IRFpsumuCCC//uf/+IRkTN4mT/BcW2g0nM0k9pXKEwKvJFkEnYK5WJQA0VZoLXFAsgSnHLJXC6nnG0U7axMVGIsC0k6iMC0D/J31JgdwE9tWOSZ8YlX11iQ6oJCa64gI/OkdrrkNeJ9O9fmakIopSBgTEVHaMmhwTgE1UyojMwqL5tssFDFHFmulZEWQciSgMmCxslEZpIvcq2cEZmDUigxZcsj5fAXUaGKJUNGj8kBsbqovYlNhUuIzm+R3x0H8I5cGt44P26gE7LA3FvXNvXeTZCNUJE3Jk+youVlhrZN1yzwGg3rIu+b1kUBlXbeXyTTq3u2NJEzQlm61MPDSjiahnzBBuY1crEYAD0+0l1Hrg8xQCHVla+fO2vY7CccW+mwDf3N5/M7evF5f8xfpZvVYzBY6XbclBtZi3aHNx/PSemgKe3x5D2aa5lFM2TDmnsMvBeuS+GjTFEJiUr+ZXUAXV2FzFBZ7Fxub/568h1cw4vBfpJ2boJHILz33dHbb394/y3NS3eVl7/hYH+wz+8V2rpSqM5S/VLUVcntvIJuC1e3havbwtVt4eq2cPUPU1q5LVzdFq5uC1e3havbwtVt4eq2cPUJkGJbuLotXN0Wrm4LV7eFq9vC1W3h6rZwdVu4ui1c3RaubgtXn0ad4LZwdVu4+qQYclu4GgtXQ+YJ2Y17VSGk6mTQ+Wyls5Vy1os0mVE20+FZcntL74ofKE2dmn+p0VAq1EWaXAsjKXjOiVBpzPihVJcrpJyTt/4tYPeUlk892/ND9kr+FyUs+RFv+PDvhe0mXJ0cvz9N0iTWFZQ6pzFGzKkcV8yTw4R0NlfuNqml3H6bFEJNa86+Sfy8lKgkajfrZzldcZZT+NFJ4hFq0cGyn/7kt0L/08bWDvgvevr+Oy7+uwH3PRsHBNpGaDrBi+Vy+X9W+805",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/draftdocument",title:"Draft Document",description:"The Draft Document API allows users to generate new documents by providing data with base64 encoded file.",source:"@site/docs/API-docs/draftdocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/draftdocument",permalink:"/docs/API-docs/draftdocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"draftdocument",title:"Draft Document",description:"The Draft Document API allows users to generate new documents by providing data with base64 encoded file.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztO39zGzeuXwW3/6TxrGVLcdKc582bS5O+O79ra0/jTOfG9rjULiQx3iW3JNey6tF/90nuo90neQOQ3B+yZDtJp+fOU/6ItSRIgiAAAiBwmzgxtcnhWfJOZ3WJytnkIk1ytJmRlZNaJYfJ6QzhnRETBxEI3pwcgSgKPbdQWzQWnIYpKjTCISicQx6ng/ECKqOvZS7VFHLhBMylm8FYWHx1AKgynWMOE1ng4Fydq1NZHcKHqtAih4WuDZy8+59mNlqG2s52dt7huJ7Ch6OdnYuvZs5V9nBvT1TVQFeorJyqQoztINPlXk6AVT55nsJ8hgZpVsiEAhRWFgsQeQ5zmU/R2RTcDBVkulpAprXJpRIObQqVmCKouhyjsSkIlUOpDYJUIMCgyBe7Tu/WFuF/3x//ABNtSuEGcFLUNm2Wy6XBzBULP72bYbOrZzZSwzoj1TSFUlwRtaSDX2qZXdG2Laqc/tLANydHTKudnfd1VWnjMIef/BYOd3ao5xss9ByEQYbPdFlqBZUwokTHxzUTjrsN/lJLg7k/FFEUkRaH52oXdnbcosLDnR04UrnMiBg8IbWCngTYgQclIhHo+wozOZEBtEM60ArmM5nNmCZz4c+zKkTm0TRoK8ycvMb+xDcpLGjid6h0xGCmjfxVKycKPo5rNE5mougeGyFIoNYJ44iclZbKxdawAvwjHA+dHh9K4CtCLSdilVJxj0W4FkWNNmA1T2FGWP2IlUHLrB7mJUKqHGYop7ON64n8Y21db2KoLaHZxSKsFU+JyYtMtokoLIKc9GhZiivsrAaaRVgUA/hmATlORF24FCRxnDM1DuAH7UBUVSEzMS6QOBdIeISrDe7yKQd2CIgoUfIZn7BEowUBuZxM0JBwUidPEcZE7IjPWhXAkuNmQoFWKwed6UIbmn6Fh7i9T0jItHKo3ADeXAtZMPZ+txakyoo6RxgXIrtKYVzUmILB3EvuAklvpUELEQgIG4jOBAKLBbGhVrQBpcPy0oINWOUDOJ1J2woUdUZa8yLSdskaxHaiaWWiQZQxwFLIImXKpfBRj8FJV2BKElsJtUhJYWIKDm/cWN+kkM0wu+JfRuRSw7h2Tiu/sdzoKtdzFYg50cpZ+esakYw9n07RUQoHKbxK4XUKw/0UhqMUhgcpDF+lMHydwmg/hdEohdFBCqNXHq3R60Br0RC4i8Bw5Kns/jjUJcX7nbQs2qQxbaOE5z0lfK6GA9jZaQSKm3/++edzdXuuAM4TErDz5PA8aUDOkxR8H+nN8+RwmEJouDlPDuHF6OsIsKDvV0Rd/z2n7yGdhv+e0fdoeK6WYdERI+NEWd2DCHX/9kjEz8BP1MgrU1vUbdRISsnDUg+dG7U2aFHHst3QC9qQVNJJUdjNe4oQT29bLWYrOzugnTH3bt4Wdz+9PUW0Yg8rT9/FyrbTFdUAIzJaIcHLQXvdbKCAX/SpESBg9aX7f0X7b3TWZiI0IE+PEl3UvpQcXw/YPmC9vZkYAeDpkaJF7EsJ8ZoIQffWZipQ79MjQcAqdgRbwPftH+wOX+6O9kcHPTKQG+UBynI3z3cXi8UXkhCYYGQehfXZ2gzWrDcCyYOdGF2ucVXYk2ihgvnEv6N5/z0Z9eNo72JOPiI7IdG4abzDrkXudC4Wz6yfKg5t7DiCb624RQdN7iI82FPOZlpmAXmCidbbmJzBARFhlwif733//V6HlL5xtywjfSG20vcuk77bWpaDPB+swvZOqNNaQp6nsKZ9fUeeQ1mWm9p9B12X5+rPJAjBdNssCwHg9xGHNVzfrr9RVtoOkWtV8Prs3a2XlZX7ZSZV6Ah8AysABqd1IQzekJtqpVZMl99AE61IURSi1sxnr5YdQo4ZeErAV8fBlH8eGJx20J+AWh4ed2dj3UkMTvGG58hq63RJyMhc0Awp2DqbkdMnosdAZG/jO/yViUpSdKFA57gVXTZYh4Q/tI5nToe66phbdL3NCAtx5BrfnE+fHY3hPt97wS+55+ILEE9P7Xcwi50+2kHdZ+dJKYLpkkyw/a3dDM15ctGM8T455p2xsG4wXNwjT9AKTY6FGGNxV9YeLQ3d7QTO6hCHOkqpmlACo7wfMeBecbPSGzqXa+TMb7vL4FG5RzGJdIZC2hhP6ROtOzoEnDgMqBA5sjhGiAMoaBul+EtZvkHsETwfFUI4nQdWIDhgwCbWFxe7R6hohd7JdOlCc5RSybIum6DlpJk1UqwMl3yXXDSSQuFxhe7p3llB3DywAkUINy9wroYcWYgxCdYLsN4WDCBPTzF0MHv4BvwcldG7NT/3vvt0QYz76grimmuSQP0F2Qih3SyFAzimS4kipn4QhcCyDCtH4bIvFdEG5cddS0OOJHVDZJsvpi7U782Dm5jpMdy5gvdvxocB7stsL6La45ixu40/EEP20H60reTjgaV/htoUDCyZ9Z6aMgxordz8SZroit5UpVZHeXKY5PQKG58Nk5SnRuu+0fkiObxNQgSffob4OI3c+2jpGfc2sdkMS0G/Ikr08Esvr0macKCG3n6JVMlhoscfMaM1KkM4OImWRjL04W2E8g+WSRqc9eQw8S+ZSZrgjSgrAk5WnnqrfJIs44L3TdW0tFNZ/tG8nNI8vbfqz5rtXWeGZZrQI+NnzvQDDeW9lXiq32pqdPhOLGxnQn/rJ6uv7DSGZCALoyAXC0tiVVtvn2WiyOqC/H68qaRZNEEIdv47XNEg2qzUIDp8uUz5tQFNFyVhjFgkaSIdlt32DUxg9KefXIaaKMPh4U8d+1HjGPEvoYFe9fmcRPnJWHzUCGPkM6pmWn3y+OHoxXA0fDEc0Qzhtefz6eh772LQZ4w35KViHm323faFNgV+GBk8xJwRnrctpvgwM55uernvvBfama6LnF7iUJgBP6B/dm5Gn7+bq2jwADcv0+Tm4c3cQKZ3Y1oAfFXgxEFdVWgg00ahed6N9z2ZzY0ODpZpsnh4e4s/5Pa+psObP7y7nzifos01+U/g+uL1Mk1mD+P6tybj4z+I7MGrZXu7JplB4TBeDpdjnS8uo95aPgQYLwqCm+giR0NWyF191aoa0jCUqXS5qufHWhco1BpF03vpDzllZBOSORgC3vMZklHdmoo8e2udBuPRY0vZA7gSg5SWbEBT43kygKNJx9bluMFqskGE5Yd/peEZr3dpa1bjz/bCN9HoWTerihJd2kB/RIGBwWFZFZyWNJdFQXjTvT6A5h+bew0lCYF4XcaFH74q3vpYJy8YBvVzeiBYjAN4K1ST1tFPn4Db24YNmDuWS7i9pVNFc0mX7nKZtg20Vq+B71XfYjBDed0b1TRhO7Bp6wz1Js4lmTi+IbygdRGQUyXV9LI2xXI5uMOG7Rk9mm53yBTOjib5f0AxQudIHZsczSMk92ji3TUNz4hZn4W4OVNGGuuCPHp2Dwj7p7ANVA7ZEOTlfdvIt63HlqBUnK+VH2fkdIqUuxggeHBINkKRzbxmYKzEhESb8xENXktd24jeTNjG5M4JQnpxkWra9zY71OFcsO7eB+tEV1F20vHpySNoyb7wrtdE3oX0u/RzwPHpCWU4yknw6AbwwTaUiKQVPRAgXwuupYhJUI35tvDhS1RMEa82e+mog5BbuAt3EcqlXYtR2r6lNPnAdyZuU2DpiHTtKPdWhrwu67CyPToyFg0hT3X9GK58gJICpjU/yzq6laNq5PedNkNRKutM7UO3kNcmJmUGtiDIDK1t6RSpQkCd+VNAZf1wARNhHZoUaiWJ8qamSEkzJd5UaCSqDNeSwKAnHUnuw9qsn+334cfvQuJz3EMUyjFJoJ8Yc6gr5hqWhCYNNZ7c6tY3aNuOynsYTU4X1SZIfwjgV2isVtSszVQo+avnZu05aYwzUUzYwGoe5/nSRZVHnGm2Pn7Rwvr3P/9FqDKnXpY6b7jXPp6xTigh2NlGGTnNCeRYoM92j0+LjZKzaVRsNrhr9MJo+CWQt6Ur2g/eSOs6yYsxb+CuUP6IRM+sgwOb9yRKxGhq0ZWqBq+QJNlOx4aX7Ce+NublCgN2zMReBMrfrmxGthGloP4omVsr6x3d0f4+/elTtCkmCKYn0Y6Ya1IXxeJPSfr4cNb9XnaDrVxrvN7nOc8+ytGvN9n16IQYZ4Pw3TtBMPRrU1CJAPHpbnMGHMfo0FaqQiq8ZBJf5jq7NGgvR/v7l0Oi8TJNDtaR8b0u0c2YdYiYc6OpgqAqUFBGu1mAmAqpgGxP8xtSFY3R5n5n4NMwW0OJyEOXBz0ivLxLhCPFr7Bcl3Kqr1D9vjvtLu/88oTqTckM49VhIj0Q9ye9zXbb/SYtZrWRbpEcnt0mN7uikru+//DsYnmRJkRYTRHhSlvGWLhZcpjsrQaILZprDvWd3Xr2bTjSCpXTQ+kd91NUcu96mCzT1RFrndWN0NaJqVTT3XtHXbQ7fU+n4Qne228bW6vk35GCa4GcXag0kcQFMxRkuxIB6ZB/bKPj38ajihHsdUHp9khWw8yrl8GawHGMG/dCwesjwcOXnRjsWQyncoS0CZCui3k2W49RzCaI2YlLdsKSZy3LNhHAGAAccuRsdHDAIaavhxyLefGawxwHr5bMZK3LnyR9t56fMVad0yTpO11xUONShFGtXeyf5XoGXmjqGzztzD0Do3exb7jXowUl1UQzM4UTPq5QvScDlUT2eng37IRFpsumuCCC//uf/+IRkTN4mT/BcW2g0nM0k9pXKEwKvJFkEnYK5WJQA0VZoLXFAsgSnHLJXC6nnG0U7axMVGIsC0k6iMC0D/J31JgdwE9tWOSZ8YlX11iQ6oJCa64gI/OkdrrkNeJ9O9fmakIopSBgTEVHaMmhwTgE1UyojMwqL5tssFDFHFmulZEWQciSgMmCxslEZpIvcq2cEZmDUigxZcsj5fAXUaGKJUNGj8kBsbqovYlNhUuIzm+R3x0H8I5cGt44P26gE7LA3FvXNvXeTZCNUJE3Jk+youVlhrZN1yzwGg3rIu+b1kUBlXbeXyTTq3u2NJEzQlm61MPDSjiahnzBBuY1crEYAD0+0l1Hrg8xQCHVla+fO2vY7CccW+mwDf3N5/M7evF5f8xfpZvVYzBY6XbclBtZi3aHNx/PSemgKe3x5D2aa5lFM2TDmnsMvBeuS+GjTFEJiUr+ZXUAXV2FzFBZ7Fxub/568h1cw4vBfpJ2boJHILz33dHbb394/y3NS3eVl7/hYH+wz+8V2rpSqM5S/VLUVcntvIJuC1e3havbwtVt4eq2cPUPU1q5LVzdFq5uC1e3havbwtVt4eq2cPUJkGJbuLotXN0Wrm4LV7eFq9vC1W3h6rZwdVu4ui1c3RaubgtXn0ad4LZwdVu4+qQYclu4GgtXQ+YJ2Y17VSGk6mTQ+Wyls5Vy1os0mVE20+FZcntL74ofKE2dmn+p0VAq1EWaXAsjKXjOiVBpzPihVJcrpJyTt/4tYPeUlk892/ND9kr+FyUs+RFv+PDvhe0mXJ0cvz9N0iTWFZQ6pzFGzKkcV8yTw4R0NlfuNqml3H6bFEJNa86+Sfy8lKgkajfrZzldcZZT+NFJ4hFq0cGyn/7kt0L/08bWDvgvevr+Oy7+uwH3PRsHBNpGaDrBi+Vy+X9W+805",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Self Sign",permalink:"/docs/API-docs/selfsign"},next:{title:"Create Document",permalink:"/docs/API-docs/createdocument"}},g={},j=[{value:"Request",id:"request",level:2}];function f(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(n.p,{children:"Draft Document"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/draftdocument"}),"\n",(0,i.jsx)(n.p,{children:"The Draft Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"name", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job title:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"job title", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"company", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"date", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": { \n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression":"",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0, \n "maxselections": 0 \n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"dropdown", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"radio button", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "readonly": false,\n "required": true, \n "name": "radio button",\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(n.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded pdf"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Description"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Note"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"timeToCompleteDays",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"send_email",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"redirect_url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_sender_name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"name or email of the person or organization on the behalf of which you are sending the mail.",example:"opensign\u2122"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(t.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Document created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"document_id",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://url-to-send-document.com"}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "document_id": "hji2zxcv2P",\n "url": "https://url-to-send-document.com"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/a9f09360.7b2c4570.js b/assets/js/a9f09360.7b2c4570.js deleted file mode 100644 index 2597bb05e..000000000 --- a/assets/js/a9f09360.7b2c4570.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8888],{63135:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>g,contentTitle:()=>u,default:()=>b,frontMatter:()=>h,metadata:()=>x,toc:()=>j});var i=s(85893),l=s(11151),a=s(58219),t=(s(62316),s(51039)),r=s.n(t),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),m=s(9472),p=s(85162);const h={id:"draftdocument",title:"Draft Document",description:"The Draft Document API allows users to generate new documents by providing data with base64 encoded file.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztO39zGzeuXwW3/6TxrGVLcdKc582bS5u+O79rY0/jTOfG9rjULiQx3iW3JNey6tF/90nuo90neQOQ3B+yZDtJp+fOU/6ItSRIgiAAAiBwmzgxtcnhWfJWZ3WJytnkIk1ytJmRlZNaJYfJ6QzhrRETBxEI3pwcgSgKPbdQWzQWnIYpKjTCISicQx6ng/ECKqOvZS7VFHLhBMylm8FYWHx1AKgynWMOE1ng4Fydq1NZHcKHqtAih4WuDZy8/Z9mNlqG2s52dt7iuJ7Ch6OdnYuvZs5V9nBvT1TVQFeorJyqQoztINPlXk6AVT55nsJ8hgZpVsiEAhRWFgsQeQ5zmU/R2RTcDBVkulpAprXJpRIObQqVmCKouhyjsSkIlUOpDYJUIMCgyBe7Tu/WFuF/3x+/g4k2pXADOClqmzbL5dJg5oqFn97NsNnVMxupYZ2RappCKa6IWtLBL7XMrmjbFlVOf2ngm5MjptXOzvu6qrRxmMNPfguHOzvU8w0Weg7CIMNnuiy1gkoYUaLj45oJx90Gf6mlwdwfiiiKSIvDc7ULOztuUeHhzg4cqVxmRAyekFpBTwLswIMSkQj0fYWZnMgA2iEdaAXzmcxmTJO58OdZFSLzaBq0FWZOXmN/4psUFjTxW1Q6YjDTRv6qlRMFH8c1GiczUXSPjRAkUOuEcUTOSkvlYmtYAf4RjodOjw8l8BWhlhOxSqm4xyJci6JGG7CapzAjrH7EyqBlVg/zEiFVDjOU09nG9UT+sbauNzHUltDsYhHWiqfE5EUm20QUFkFOerQsxRV2VgPNIiyKAXyzgBwnoi5cCpI4zpkaB/BOOxBVVchMjAskzgUSHuFqg7t8yoEdAiJKlHzGJyzRaEFALicTNCSc1MlThDERO+KzVgWw5LiZUKDVykFnutCGpl/hIW7vExIyrRwqN4A310IWjL3frQWpsqLOEcaFyK5SGBc1pmAw95K7QNJbadBCBALCBqIzgcBiQWyoFW1A6bC8tGADVvkATmfStgJFnZHWvIi0XbIGsZ1oWploEGUMsBSySJlyKXzUY3DSFZiSxFZCLVJSmJiCwxs31jcpZDPMrviXEbnUMK6d08pvLDe6yvVcBWJOtHJW/rpGJGPPp1N0lMJBCq9SeJ3CcD+F4SiF4UEKw1cpDF+nMNpPYTRKYXSQwuiVR2v0OtBaNATuIjAceSq7Pw51SfF+Ly2LNmlM2yjheU8Jn6vhAHZ2GoHi5p9//vlc3Z4rgPOEBOw8OTxPGpDzJAXfR3rzPDkcphAabs6TQ3gx+joCLOj7FVHXf8/pe0in4b9n9D0anqtlWHTEyDhRVvcgQt2/PRLxM/ATNfLK1BZ1GzWSUvKw1EPnRq0NWtSxbDf0gjYklXRSFHbzniLE09tWi9nKzg5oZ8y9m7fF3U9vTxGt2MPK03exsu10RTXAiIxWSPBy0F43GyjgF31qBAhYfen+X9H+G521mQgNyNOjRBe1LyXH1wO2D1hvbyZGAHh6pGgR+1JCvCZC0L21mQrU+/RIELCKHcEW8H37B7vDl7uj/dFBjwzkRnmAstzN893FYvGFJAQmGJlHYX22NoM1641A8mAnRpdrXBX2JFqoYD7x72je/0BG/Tjau5iTj8hOSDRuGu+wa5E7nYvFM+unikMbO47gWytu0UGTuwgP9pSzmZZZQJ5govU2JmdwQETYJcLnez/8sNchpW/cLctIX4it9L3LpO+2luUgzwersL0T6rSWkOcprGlf35HnUJblpnbfQdflufozCUIw3TbLQgD4fcRhDde362+UlbZD5FoVvD57d+tlZeV+mUkVOgLfwAqAwWldCIM35KZaqRXT5TfQRCtSFIWoNfPZq2WHkGMGnhLw1XEw5Z8HBqcd9CeglofH3dlYdxKDU7zhObLaOl0SMjIXNEMKts5m5PSJ6DEQ2dv4Dn9lopIUXSjQOW5Flw3WIeEPreOZ06GuOuYWXW8zwkIcucY359NnR2O4z/de8EvuufgCxNNT+x3MYqePdlD32XlSimC6JBNsf2s3Q3OeXDRjvE+OeWcsrBsMF/fIE7RCk2MhxljclbVHS0N3O4GzOsShjlKqJpTAKO9HDLhX3Kz0hs7lGjnz2+4yeFTuUUwinaGQNsZT+kTrjg4BJw4DKkSOLI4R4gAK2kYp/lKWbxB7BM9HhRBO54EVCA4YsIn1xcXuESpaoXcyXbrQHKVUsqzLJmg5aWaNFCvDJd8lF42kUHhcoXu6d1YQNw+sQBHCzQucqyFHFmJMgvUCrLcFA8jTUwwdzB6+AT9HZfRuzc+97z5dEOO+uoK45pokUH9BNkJoN0vhAI7pUqKIqR9EIbAsw8pRuOxLRbRB+XHX0pAjSd0Q2eaLqQv1e/PgJmZ6DHeu4P2b8WGA+zLbi6j2OGbsbuMPxJA9tB9tK/l4YOmfoTYFA0tmvaemDANaKzd/kia6ojdVqdVRnhwmOb3CxmfDJOWp0bpvdL5IDm+TEMGnnyE+TiP3Plp6xr1NbDbDUtCviBI9/NLLa5ImHKiht18iVXKY6PFHzGiNyhAOTqKlkQx9eBuh/INlkgZnPTlM/EtmkiZ4I8qKgJOVp94qnyTLuOB9UzUt7VSWfzQvpzRP7636s2Z725lhmSb0yPiZM72joby3Ek/1t5oaHb4VC9uZ0N/6yeorO40hGcjCKMjFwpJY1dbbZ5kosrogvx9vKmkWTRCCnf8OVzSINis1iA5fLlN+bUDTRUkYIxZJmkiHZbd9AxMY/eknl6EmynB4+FPHftQ4RvxLaKBXfT4nUX4yFh81whj5jKqZVp88fjh6MRwNXwxHNEN47fl8Ovreuxj0GeMNeamYR5t9t32hTYEfRgYPMWeE522LKT7MjKebXu4774V2pusip5c4FGbAD+ifnZvR5+/mKho8wM3LNLl5eDM3kOndmBYAXxU4cVBXFRrItFFonnfjfU9mc6ODg2WaLB7e3uIPub2v6fDmD+/uJ86naHNN/hO4vni9TJPZw7j+rcn4+A8ie/Bq2d6uSWZQOIyXw+VY54vLqLeWDwHGi4LgJrrI0ZAVcldftaqGNAxlKl2u6vmx1gUKtUbR9F76Q04Z2YRkDoaA93yGZFS3piLP3lqnwXj02FL2AK7EIKUlG9DUeJ4M4GjSsXU5brCabBBh+eFfaXjG613amtX4s73wTTR61s2qokSXNtAfUWBgcFhWBaclzWVREN50rw+g+cfmXkNJQiBel3Hhh6+Kb32skxcMg/o5PRAsxgF8K1ST1tFPn4Db24YNmDuWS7i9pVNFc0mX7nKZtg20Vq+B71XfYjBDed0b1TRhO7Bp6wz1Js4lmTi+IbygdRGQUyXV9LI2xXI5uMOG7Rk9mm53yBTOjib5f0AxQudIHZsczSMk92ji3TUNz4hZn4W4OVNGGuuCPHp2Dwj7p7ANVA7ZEOTlfdfIt63HlqBUnK+VH2fkdIqUuxggeHBINkKRzbxmYKzEhESb8xENXktd24jeTNjG5M4JQnpxkWra9zY71OFcsO7eB+tEV1F20vHpySNoyb7wrtdE3oX0u/RzwPHpCWU4yknw6AbwwTaUiKQVPRAgXwuupYhJUI35tvDhS1RMEa82e+mog5BbuAt3EcqlXYtR2r6lNPnAdyZuU2DpiHTtKPdWhrwu67CyPToyFg0hT3X9GK58gJICpjU/yzq6laNq5PedNkNRKutM7UO3kNcmJmUGtiDIDK1t6RSpQkCd+VNAZf1wARNhHZoUaiWJ8qamSEkzJd5UaCSqDNeSwKAnHUnuw9qsn+334cfvQ+Jz3EMUyjFJoJ8Yc6gr5hqWhCYNNZ7c6tY3aNuOynsYTU4X1SZIfwjgV2isVtSszVQo+avnZu05aYwzUUzYwGoe5/nSRZVHnGm2Pn7Rwvr3P/9FqDKnXpY6b7jXPp6xTigh2NlGGTnNCeRYoM92j0+LjZKzaVRsNrhr9MJo+CWQt6Ur2g/eSOs6yYsxb+CuUP6IRM+sgwOb9yRKxGhq0ZWqBq+QJNlOx4aX7Ce+NublCgN2zMReBMrfrmxGthGloP4omVsr6x3d0f4+/elTtCkmCKYn0Y6Ya1IXxeJPSfr4cNb9XnaDrVxrvN7nOc8+ytGvN9n16IQYZ4Pw3TtBMPRrU1CJAPHpbnMGHMfo0FaqQiq8ZBJf5jq7NGgvR/v7l0Oi8TJNDtaR8b0u0c2YdYiYc6OpgqAqUFBGu1mAmAqpgGxP8xtSFY3R5n5n4NMwW0OJyEOXBz0ivLxLhCPFr7Bcl3Kqr1D9vjvtLu/88oTqTckM49VhIj0Q9ye9zXbb/SYtZrWRbpEcnt0mN7uikru+//DsYnmRJkRYTRHhSlvGWLhZcpjsrQaILZprDvWd3WGbuSDr6W/1mLF+UzsNP+jsym+NWb3h3mtpnJ9pYP2wWT1mX/XECBLXd+L6Spg9UrR7w8H+YD9Zprcrk1ihcnqZvePvikruXQ/XjFjrHW+Etk5MpZru3jvqoiXtezp+f8I9ArfBvEr+HSmaF86vC5Umkog4Q0HGMp0YcdWPbTj+u8gbMWS+Lgre8sBqXHv19lkTqY6B6l7seX3oefiyE/Q9i/FbDsk2Edl1QdZm6zFs2kRNO4HQThz0rJWRJuQYI45DDtWNDg44pvX1kIM/L15zXOXg1ZK5uo0xJEk/jsDvJqvecJL0vbw4qPFhwqjWEPfvgD2LMjT1Lax25p5F07MkNhgS0WSTaqKZmcIJH1eo3pNFTNJ2Pbwb58Ii02VTzRDB//3Pf/GIyBm8zJ/guDZQ6TmaSe1LIiYF3kiyQTuVeTGKgqIs0NpiAWR6TrlGL5dTTm+Khl0mKjGWhSSlR2Davyp09KYdwE9tHOaZ8Zle11iQroRCay5ZI3uodrrkNeIFP9fmakIopSBgTFVOaMmDwjgE1UyojOw4L5tsIVGJHpnKlZEWQciSgMlkx8lEZpItB62cEZmDUigxZVMn5XgbUaGKNUpGj8njsbqovU1PlVKIzm+RHzoH8JZ8KN44v6agE7LA3JvzNvXuVJCNUAI4Jte1ouVlhrbNDy3wGg3rIu8M10UBlXbeQSVbr3u2NJEzQlmyIsJLTjiahnzB6OY1crEYAL120uVKvhYxQCHVlS/YO2vY7CccW+mwjTXO5/M7evF5f8xfpZvVYzBY6XbclBtZi3aHNx/PSemgKe3x5D2aa5lFu2fDmnsMvBfuZ+HDWlEJiUr+ZXUA3ZWFzFBZ7Nymb/568j1cw4vBfu+6egTCe98fffvdu/ff0bx0OXr5i9cW36ilUJ2l+rWvq5LbeXbdVspuK2W3lbLbStltpewfppZzWym7rZTdVspuK2W3lbLbStltpewTIMW2UnZbKbutlN1Wym4rZbeVsttK2W2l7LZSdlspu62U3VbKPo3CxG2l7LZS9kkx5LZSNlbKhswTshv3qkJI1UnZ8+lRZyv1sxdpMqP0qcOz5PaW3hU/UF48Nf9So6Hcq4s0uRZGUvCcM6/SmPFDqS5XSDkn3/q3gN1TWj71bM8P2SsJZ5Sw5Ee84cO/F7ab4XVy/P40SZNYyFDqnMYYMaf6XzFPDhPS2Vwq3OSycvttUgg1rTn7JvHzUqKSqN2sn+V0xVlO4UcniUeoRQfLfvqT3wr9TxtbO+C/6On777j47wbc92wcEGgboekEL5bL5f8BRtn05A==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/draftdocument",title:"Draft Document",description:"The Draft Document API allows users to generate new documents by providing data with base64 encoded file.",source:"@site/docs/API-docs/draftdocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/draftdocument",permalink:"/docs/API-docs/draftdocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"draftdocument",title:"Draft Document",description:"The Draft Document API allows users to generate new documents by providing data with base64 encoded file.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztO39zGzeuXwW3/6TxrGVLcdKc582bS5u+O79rY0/jTOfG9rjULiQx3iW3JNey6tF/90nuo90neQOQ3B+yZDtJp+fOU/6ItSRIgiAAAiBwmzgxtcnhWfJWZ3WJytnkIk1ytJmRlZNaJYfJ6QzhrRETBxEI3pwcgSgKPbdQWzQWnIYpKjTCISicQx6ng/ECKqOvZS7VFHLhBMylm8FYWHx1AKgynWMOE1ng4Fydq1NZHcKHqtAih4WuDZy8/Z9mNlqG2s52dt7iuJ7Ch6OdnYuvZs5V9nBvT1TVQFeorJyqQoztINPlXk6AVT55nsJ8hgZpVsiEAhRWFgsQeQ5zmU/R2RTcDBVkulpAprXJpRIObQqVmCKouhyjsSkIlUOpDYJUIMCgyBe7Tu/WFuF/3x+/g4k2pXADOClqmzbL5dJg5oqFn97NsNnVMxupYZ2RappCKa6IWtLBL7XMrmjbFlVOf2ngm5MjptXOzvu6qrRxmMNPfguHOzvU8w0Weg7CIMNnuiy1gkoYUaLj45oJx90Gf6mlwdwfiiiKSIvDc7ULOztuUeHhzg4cqVxmRAyekFpBTwLswIMSkQj0fYWZnMgA2iEdaAXzmcxmTJO58OdZFSLzaBq0FWZOXmN/4psUFjTxW1Q6YjDTRv6qlRMFH8c1GiczUXSPjRAkUOuEcUTOSkvlYmtYAf4RjodOjw8l8BWhlhOxSqm4xyJci6JGG7CapzAjrH7EyqBlVg/zEiFVDjOU09nG9UT+sbauNzHUltDsYhHWiqfE5EUm20QUFkFOerQsxRV2VgPNIiyKAXyzgBwnoi5cCpI4zpkaB/BOOxBVVchMjAskzgUSHuFqg7t8yoEdAiJKlHzGJyzRaEFALicTNCSc1MlThDERO+KzVgWw5LiZUKDVykFnutCGpl/hIW7vExIyrRwqN4A310IWjL3frQWpsqLOEcaFyK5SGBc1pmAw95K7QNJbadBCBALCBqIzgcBiQWyoFW1A6bC8tGADVvkATmfStgJFnZHWvIi0XbIGsZ1oWploEGUMsBSySJlyKXzUY3DSFZiSxFZCLVJSmJiCwxs31jcpZDPMrviXEbnUMK6d08pvLDe6yvVcBWJOtHJW/rpGJGPPp1N0lMJBCq9SeJ3CcD+F4SiF4UEKw1cpDF+nMNpPYTRKYXSQwuiVR2v0OtBaNATuIjAceSq7Pw51SfF+Ly2LNmlM2yjheU8Jn6vhAHZ2GoHi5p9//vlc3Z4rgPOEBOw8OTxPGpDzJAXfR3rzPDkcphAabs6TQ3gx+joCLOj7FVHXf8/pe0in4b9n9D0anqtlWHTEyDhRVvcgQt2/PRLxM/ATNfLK1BZ1GzWSUvKw1EPnRq0NWtSxbDf0gjYklXRSFHbzniLE09tWi9nKzg5oZ8y9m7fF3U9vTxGt2MPK03exsu10RTXAiIxWSPBy0F43GyjgF31qBAhYfen+X9H+G521mQgNyNOjRBe1LyXH1wO2D1hvbyZGAHh6pGgR+1JCvCZC0L21mQrU+/RIELCKHcEW8H37B7vDl7uj/dFBjwzkRnmAstzN893FYvGFJAQmGJlHYX22NoM1641A8mAnRpdrXBX2JFqoYD7x72je/0BG/Tjau5iTj8hOSDRuGu+wa5E7nYvFM+unikMbO47gWytu0UGTuwgP9pSzmZZZQJ5govU2JmdwQETYJcLnez/8sNchpW/cLctIX4it9L3LpO+2luUgzwersL0T6rSWkOcprGlf35HnUJblpnbfQdflufozCUIw3TbLQgD4fcRhDde362+UlbZD5FoVvD57d+tlZeV+mUkVOgLfwAqAwWldCIM35KZaqRXT5TfQRCtSFIWoNfPZq2WHkGMGnhLw1XEw5Z8HBqcd9CeglofH3dlYdxKDU7zhObLaOl0SMjIXNEMKts5m5PSJ6DEQ2dv4Dn9lopIUXSjQOW5Flw3WIeEPreOZ06GuOuYWXW8zwkIcucY359NnR2O4z/de8EvuufgCxNNT+x3MYqePdlD32XlSimC6JBNsf2s3Q3OeXDRjvE+OeWcsrBsMF/fIE7RCk2MhxljclbVHS0N3O4GzOsShjlKqJpTAKO9HDLhX3Kz0hs7lGjnz2+4yeFTuUUwinaGQNsZT+kTrjg4BJw4DKkSOLI4R4gAK2kYp/lKWbxB7BM9HhRBO54EVCA4YsIn1xcXuESpaoXcyXbrQHKVUsqzLJmg5aWaNFCvDJd8lF42kUHhcoXu6d1YQNw+sQBHCzQucqyFHFmJMgvUCrLcFA8jTUwwdzB6+AT9HZfRuzc+97z5dEOO+uoK45pokUH9BNkJoN0vhAI7pUqKIqR9EIbAsw8pRuOxLRbRB+XHX0pAjSd0Q2eaLqQv1e/PgJmZ6DHeu4P2b8WGA+zLbi6j2OGbsbuMPxJA9tB9tK/l4YOmfoTYFA0tmvaemDANaKzd/kia6ojdVqdVRnhwmOb3CxmfDJOWp0bpvdL5IDm+TEMGnnyE+TiP3Plp6xr1NbDbDUtCviBI9/NLLa5ImHKiht18iVXKY6PFHzGiNyhAOTqKlkQx9eBuh/INlkgZnPTlM/EtmkiZ4I8qKgJOVp94qnyTLuOB9UzUt7VSWfzQvpzRP7636s2Z725lhmSb0yPiZM72joby3Ek/1t5oaHb4VC9uZ0N/6yeorO40hGcjCKMjFwpJY1dbbZ5kosrogvx9vKmkWTRCCnf8OVzSINis1iA5fLlN+bUDTRUkYIxZJmkiHZbd9AxMY/eknl6EmynB4+FPHftQ4RvxLaKBXfT4nUX4yFh81whj5jKqZVp88fjh6MRwNXwxHNEN47fl8Ovreuxj0GeMNeamYR5t9t32hTYEfRgYPMWeE522LKT7MjKebXu4774V2pusip5c4FGbAD+ifnZvR5+/mKho8wM3LNLl5eDM3kOndmBYAXxU4cVBXFRrItFFonnfjfU9mc6ODg2WaLB7e3uIPub2v6fDmD+/uJ86naHNN/hO4vni9TJPZw7j+rcn4+A8ie/Bq2d6uSWZQOIyXw+VY54vLqLeWDwHGi4LgJrrI0ZAVcldftaqGNAxlKl2u6vmx1gUKtUbR9F76Q04Z2YRkDoaA93yGZFS3piLP3lqnwXj02FL2AK7EIKUlG9DUeJ4M4GjSsXU5brCabBBh+eFfaXjG613amtX4s73wTTR61s2qokSXNtAfUWBgcFhWBaclzWVREN50rw+g+cfmXkNJQiBel3Hhh6+Kb32skxcMg/o5PRAsxgF8K1ST1tFPn4Db24YNmDuWS7i9pVNFc0mX7nKZtg20Vq+B71XfYjBDed0b1TRhO7Bp6wz1Js4lmTi+IbygdRGQUyXV9LI2xXI5uMOG7Rk9mm53yBTOjib5f0AxQudIHZsczSMk92ji3TUNz4hZn4W4OVNGGuuCPHp2Dwj7p7ANVA7ZEOTlfdfIt63HlqBUnK+VH2fkdIqUuxggeHBINkKRzbxmYKzEhESb8xENXktd24jeTNjG5M4JQnpxkWra9zY71OFcsO7eB+tEV1F20vHpySNoyb7wrtdE3oX0u/RzwPHpCWU4yknw6AbwwTaUiKQVPRAgXwuupYhJUI35tvDhS1RMEa82e+mog5BbuAt3EcqlXYtR2r6lNPnAdyZuU2DpiHTtKPdWhrwu67CyPToyFg0hT3X9GK58gJICpjU/yzq6laNq5PedNkNRKutM7UO3kNcmJmUGtiDIDK1t6RSpQkCd+VNAZf1wARNhHZoUaiWJ8qamSEkzJd5UaCSqDNeSwKAnHUnuw9qsn+334cfvQ+Jz3EMUyjFJoJ8Yc6gr5hqWhCYNNZ7c6tY3aNuOynsYTU4X1SZIfwjgV2isVtSszVQo+avnZu05aYwzUUzYwGoe5/nSRZVHnGm2Pn7Rwvr3P/9FqDKnXpY6b7jXPp6xTigh2NlGGTnNCeRYoM92j0+LjZKzaVRsNrhr9MJo+CWQt6Ur2g/eSOs6yYsxb+CuUP6IRM+sgwOb9yRKxGhq0ZWqBq+QJNlOx4aX7Ce+NublCgN2zMReBMrfrmxGthGloP4omVsr6x3d0f4+/elTtCkmCKYn0Y6Ya1IXxeJPSfr4cNb9XnaDrVxrvN7nOc8+ytGvN9n16IQYZ4Pw3TtBMPRrU1CJAPHpbnMGHMfo0FaqQiq8ZBJf5jq7NGgvR/v7l0Oi8TJNDtaR8b0u0c2YdYiYc6OpgqAqUFBGu1mAmAqpgGxP8xtSFY3R5n5n4NMwW0OJyEOXBz0ivLxLhCPFr7Bcl3Kqr1D9vjvtLu/88oTqTckM49VhIj0Q9ye9zXbb/SYtZrWRbpEcnt0mN7uikru+//DsYnmRJkRYTRHhSlvGWLhZcpjsrQaILZprDvWd3WGbuSDr6W/1mLF+UzsNP+jsym+NWb3h3mtpnJ9pYP2wWT1mX/XECBLXd+L6Spg9UrR7w8H+YD9Zprcrk1ihcnqZvePvikruXQ/XjFjrHW+Etk5MpZru3jvqoiXtezp+f8I9ArfBvEr+HSmaF86vC5Umkog4Q0HGMp0YcdWPbTj+u8gbMWS+Lgre8sBqXHv19lkTqY6B6l7seX3oefiyE/Q9i/FbDsk2Edl1QdZm6zFs2kRNO4HQThz0rJWRJuQYI45DDtWNDg44pvX1kIM/L15zXOXg1ZK5uo0xJEk/jsDvJqvecJL0vbw4qPFhwqjWEPfvgD2LMjT1Lax25p5F07MkNhgS0WSTaqKZmcIJH1eo3pNFTNJ2Pbwb58Ii02VTzRDB//3Pf/GIyBm8zJ/guDZQ6TmaSe1LIiYF3kiyQTuVeTGKgqIs0NpiAWR6TrlGL5dTTm+Khl0mKjGWhSSlR2Davyp09KYdwE9tHOaZ8Zle11iQroRCay5ZI3uodrrkNeIFP9fmakIopSBgTFVOaMmDwjgE1UyojOw4L5tsIVGJHpnKlZEWQciSgMlkx8lEZpItB62cEZmDUigxZVMn5XgbUaGKNUpGj8njsbqovU1PlVKIzm+RHzoH8JZ8KN44v6agE7LA3JvzNvXuVJCNUAI4Jte1ouVlhrbNDy3wGg3rIu8M10UBlXbeQSVbr3u2NJEzQlmyIsJLTjiahnzB6OY1crEYAL120uVKvhYxQCHVlS/YO2vY7CccW+mwjTXO5/M7evF5f8xfpZvVYzBY6XbclBtZi3aHNx/PSemgKe3x5D2aa5lFu2fDmnsMvBfuZ+HDWlEJiUr+ZXUA3ZWFzFBZ7Nymb/568j1cw4vBfu+6egTCe98fffvdu/ff0bx0OXr5i9cW36ilUJ2l+rWvq5LbeXbdVspuK2W3lbLbStltpewfppZzWym7rZTdVspuK2W3lbLbStltpewTIMW2UnZbKbutlN1Wym4rZbeVsttK2W2l7LZSdlspu62U3VbKPo3CxG2l7LZS9kkx5LZSNlbKhswTshv3qkJI1UnZ8+lRZyv1sxdpMqP0qcOz5PaW3hU/UF48Nf9So6Hcq4s0uRZGUvCcM6/SmPFDqS5XSDkn3/q3gN1TWj71bM8P2SsJZ5Sw5Ee84cO/F7ab4XVy/P40SZNYyFDqnMYYMaf6XzFPDhPS2Vwq3OSycvttUgg1rTn7JvHzUqKSqN2sn+V0xVlO4UcniUeoRQfLfvqT3wr9TxtbO+C/6On777j47wbc92wcEGgboekEL5bL5f8BRtn05A==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Self Sign",permalink:"/docs/API-docs/selfsign"},next:{title:"Create Document",permalink:"/docs/API-docs/createdocument"}},g={},j=[{value:"Request",id:"request",level:2}];function f(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,l.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(n.p,{children:"Draft Document"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/draftdocument"}),"\n",(0,i.jsx)(n.p,{children:"The Draft Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"name", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job title:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"job title", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"company", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"date", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": { \n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression":"",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0, \n "maxselections": 0 \n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"dropdown", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"radio button", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "readonly": false,\n "required": true, \n "name": "radio button",\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(n.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded pdf"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Description"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Note"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"timeToCompleteDays",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"send_email",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"redirect_url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_sender_name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"name or email of the person or organization on the behalf of which you are sending the mail.",example:"opensign\u2122"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(a.Z,{children:[(0,i.jsxs)(p.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Document created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"document_id",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://url-to-send-document.com"}})]})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "document_id": "hji2zxcv2P",\n "url": "https://url-to-send-document.com"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(p.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(p.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:n}={...(0,l.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/ada7accb.4c376fed.js b/assets/js/ada7accb.40681dfc.js similarity index 57% rename from assets/js/ada7accb.4c376fed.js rename to assets/js/ada7accb.40681dfc.js index a2b665386..fcbbe1a7c 100644 --- a/assets/js/ada7accb.4c376fed.js +++ b/assets/js/ada7accb.40681dfc.js @@ -1 +1 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4641],{1272:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>j,contentTitle:()=>f,default:()=>y,frontMatter:()=>u,metadata:()=>x,toc:()=>g});var l=s(85893),r=s(11151),i=s(58219),t=(s(62316),s(51039)),n=s.n(t),d=(s(82723),s(9487)),o=s(41429),c=s(5397),m=s(4667),p=s(9472),h=s(85162);const u={id:"getfolder",title:"Get Folder",description:"The Get Folder API allows you to retrieve details about a specific folder.",sidebar_label:"Get Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V+tu2zYUfpVT/lkLKL6kabcJw7Bg67qsXRssGQosNYIj6VhiTZEsSck2DP3bk+zR9iTDoWzHTtxgGYr+SSye++075EoELL1Ir8TPRhXkxCQRBfncSRuk0SIVlxXBSwrQ0+H0/AxQKTP3sDQNBAOOgpPUEhQUUCoPmJkmAIK3lMupzGEaRQciEcaSQ1Z8VohUlBR6kkiERYc1BXLszEporEmkoidfy0IkQrI3FkMlbrtosg+Uh7MCzBS2Ch19bKSjQqTBNZQIH5aKVXpZW0UiEbSwyhQk0ikqzwx5RTWKdCXC0kbO4KQuRSKmxtUYdk9ogVFLKuwv46zKjyubia6bsFlvjfbkWdHxaMT/9r31TZ6T99NGwTYdIhG50YF0YH60Vsk8EoYfPAut7nrXB82Zc6wmyN7kJhcPjqMaZ9Xi+IMVXbJO+5tYg4ep0TTflKCLRSUd+s55uEu/Hmv0z2bynG7r+r+e+Sbb8S53hIGK03BI1Y3g8ej46dF4dDT6+nL8PD35Nn32fDAajf4UiVjUimXXzVpgiJ4GGdTud2OLL2Bn52A9NY686DomnBzqwwtTU6ikLmFOOsDcGV0mYBWhJwhuCVii1KAwkHv0+RqUnDPu/kw8zLPdyKVWUtP1ZgivT0aj6/E2CSd3k9CnCrQJMDWNLgZfIND7uvSuP/eHd3L9zTa8Z3fDO9MtKllE1L40M9JftpC75kNvnl3db2fZM0W62At297wP0lPeOBmWcUcsjtDKo56eXk0YfblvzHq1xKUSKpGKYZ/V4Wq7TjrBuly7WTe3JmOOZUnulyaLnp82wcBvJp/14TVOiVRUIVifDoetdKHXNPC9WNVkg9zUw3OH00apN9jO0A2NJT0cD0aDkeiS1S0lHnWRmcWAmbwstcLMRx1o5bAdH5BAax/A7QOWUpdH90pNbtJ7wS3QV3kvydtao5WvaCmSTQ13udabuiKMONvx99RE4XVl31rSF7LUMbvt+M4+f0cqNzXx5SJUBBv2f/76O0oUJm9q0iG27SN42ziwZk6ONyrqAqaKFjJTdOCu4glrRd6rJUgdqHQYCApZyoAKOCsMOjlazKSS3OjMZljawc6s+AG8qyhU5Jj0lSNAKKglxfMByhhuFbaHTTB1tLH2GebGzabsUgIIWeOlJu/BE21ESFeoc4JNLRIwDlAD6UDOOukJUNbMPDUOaDqVuWTFPNUO8wA1aiyJjSXAfnMWrDOtLMiDM1njA3ijmhgIW6yJQh+iJir8AH6SLfWB82F/raMCyoZVJJCbgmA95ByGLiAjH8CyeZlTVOoDugCKWnKx92IleR7AGkYfiYqva7u1ZUXBofYMkL1Dm9Js02ed4ctTtFHgcgDv9XvN+wIaT9wASuqZT9/rI7jattk7yrwMNHm8mYf5fH5nDp7sy7yUoWoycGTNjVwZD+PU7IpvP56IRARytX87vSDXypzWQ/gJm8PIPFxjMuYRk6lGqfoZ++G2AOOjkjlpTzsIevry/DW08HQw2oOn/+Dw8PXZjy/eXLxgvQyG/fxtYEpY40ONesfUzUvg9tSubvbK530zrCEn0CIMrUIZl0SMcrUG+CuxvfWnNy+GSSIq4wOTV6sMPf3hVNfx8ceGHK+QSSJadBIzRiXeAtLz72L7JPhkgI9/X78unsDBx8dBnzfYqRk4W1QNf4lEzGi599TpJl2ygU92q6ef5jnZsCN5Z3fvLcCXLy5FIrDh/OzC9izC9voHaz/o1T6e9w7wX14tBwW+4xq/ouX3W/ae8kmBdXwbbs7QpOu6fwEhqgkl",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},f=void 0,x={id:"API-docs/getfolder",title:"Get Folder",description:"The Get Folder API allows you to retrieve details about a specific folder.",source:"@site/docs/API-docs/getfolder.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getfolder",permalink:"/docs/API-docs/getfolder",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getfolder",title:"Get Folder",description:"The Get Folder API allows you to retrieve details about a specific folder.",sidebar_label:"Get Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V+tu2zYUfpVT/lkLKL6kabcJw7Bg67qsXRssGQosNYIj6VhiTZEsSck2DP3bk+zR9iTDoWzHTtxgGYr+SSye++075EoELL1Ir8TPRhXkxCQRBfncSRuk0SIVlxXBSwrQ0+H0/AxQKTP3sDQNBAOOgpPUEhQUUCoPmJkmAIK3lMupzGEaRQciEcaSQ1Z8VohUlBR6kkiERYc1BXLszEporEmkoidfy0IkQrI3FkMlbrtosg+Uh7MCzBS2Ch19bKSjQqTBNZQIH5aKVXpZW0UiEbSwyhQk0ikqzwx5RTWKdCXC0kbO4KQuRSKmxtUYdk9ogVFLKuwv46zKjyubia6bsFlvjfbkWdHxaMT/9r31TZ6T99NGwTYdIhG50YF0YH60Vsk8EoYfPAut7nrXB82Zc6wmyN7kJhcPjqMaZ9Xi+IMVXbJO+5tYg4ep0TTflKCLRSUd+s55uEu/Hmv0z2bynG7r+r+e+Sbb8S53hIGK03BI1Y3g8ej46dF4dDT6+nL8PD35Nn32fDAajf4UiVjUimXXzVpgiJ4GGdTud2OLL2Bn52A9NY686DomnBzqwwtTU6ikLmFOOsDcGV0mYBWhJwhuCVii1KAwkHv0+RqUnDPu/kw8zLPdyKVWUtP1ZgivT0aj6/E2CSd3k9CnCrQJMDWNLgZfIND7uvSuP/eHd3L9zTa8Z3fDO9MtKllE1L40M9JftpC75kNvnl3db2fZM0W62At297wP0lPeOBmWcUcsjtDKo56eXk0YfblvzHq1xKUSKpGKYZ/V4Wq7TjrBuly7WTe3JmOOZUnulyaLnp82wcBvJp/14TVOiVRUIVifDoetdKHXNPC9WNVkg9zUw3OH00apN9jO0A2NJT0cD0aDkeiS1S0lHnWRmcWAmbwstcLMRx1o5bAdH5BAax/A7QOWUpdH90pNbtJ7wS3QV3kvydtao5WvaCmSTQ13udabuiKMONvx99RE4XVl31rSF7LUMbvt+M4+f0cqNzXx5SJUBBv2f/76O0oUJm9q0iG27SN42ziwZk6ONyrqAqaKFjJTdOCu4glrRd6rJUgdqHQYCApZyoAKOCsMOjlazKSS3OjMZljawc6s+AG8qyhU5Jj0lSNAKKglxfMByhhuFbaHTTB1tLH2GebGzabsUgIIWeOlJu/BE21ESFeoc4JNLRIwDlAD6UDOOukJUNbMPDUOaDqVuWTFPNUO8wA1aiyJjSXAfnMWrDOtLMiDM1njA3ijmhgIW6yJQh+iJir8AH6SLfWB82F/raMCyoZVJJCbgmA95ByGLiAjH8CyeZlTVOoDugCKWnKx92IleR7AGkYfiYqva7u1ZUXBofYMkL1Dm9Js02ed4ctTtFHgcgDv9XvN+wIaT9wASuqZT9/rI7jattk7yrwMNHm8mYf5fH5nDp7sy7yUoWoycGTNjVwZD+PU7IpvP56IRARytX87vSDXypzWQ/gJm8PIPFxjMuYRk6lGqfoZ++G2AOOjkjlpTzsIevry/DW08HQw2oOn/+Dw8PXZjy/eXLxgvQyG/fxtYEpY40ONesfUzUvg9tSubvbK530zrCEn0CIMrUIZl0SMcrUG+CuxvfWnNy+GSSIq4wOTV6sMPf3hVNfx8ceGHK+QSSJadBIzRiXeAtLz72L7JPhkgI9/X78unsDBx8dBnzfYqRk4W1QNf4lEzGi599TpJl2ygU92q6ef5jnZsCN5Z3fvLcCXLy5FIrDh/OzC9izC9voHaz/o1T6e9w7wX14tBwW+4xq/ouX3W/ae8kmBdXwbbs7QpOu6fwEhqgkl",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Folder",permalink:"/docs/API-docs/createfolder"},next:{title:"Update Folder",permalink:"/docs/API-docs/updatefolder"}},j={},g=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,r.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Get Folder"})}),"\n",(0,l.jsx)(n(),{method:"get",path:"/folder/{folder_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Get Folder API allows you to retrieve details about a specific folder."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(o.Z,{className:"paramsItem",param:{name:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"folderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new folder"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"parentFolderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"J2nas5kiPe"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"parentFolderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new sub folder"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "objectId": "ph1bhx2jp",\n "folderName": "new folder",\n "parentFolderId": "J2nas5kiPe",\n "parentFolderName": "new sub folder",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"folder not found."})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder not found."}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "folder not found."\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,r.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4641],{1272:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>u,default:()=>v,frontMatter:()=>j,metadata:()=>x,toc:()=>y});var l=s(85893),r=s(11151),n=s(58219),i=(s(62316),s(51039)),t=s.n(i),d=(s(82723),s(9487)),o=s(41429),m=s(5397),c=s(4667),p=s(9472),h=s(85162);const j={id:"getfolder",title:"Get Folder",description:"The Get Folder API allows you to retrieve details about a specific folder.",sidebar_label:"Get Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V9tu20YQ/ZXJvjQBaF0cJ22JoqjRpq6TIAlqFwHqCMaSHJIbL3c3u0NdIPCtX9JP65cUs5RkynaMugjyIomc++3MaC1IVkGkF+JXqwv0YpaIAkPulSNljUjFeY1wggQ9HY7fnYLU2i4CrGwLZMEjeYVzhAJJKh1AZrYlkBAc5qpUOZRRdCQSYR16yYpPC5GKCqkniUQ46WWDhJ6dWQsjGxSp6MmXqhCJUOyNk1SLmy7a7CPmdFqALWGn0OOnVnksREq+xUQEWmlWGVTjNIpE4NJpW6BIS6kDM+Q1NlKka0ErFznJK1OJRJTWN5KGb3Apo5ZUuN+mWZ0f1i4TXTdjs8FZEzCwosPJhL/2vQ1tnmMIZathlw6RiNwaQkPML53TKo+E8cfAQuvb3vVBc+Y8qyHVm9zm4sFx1NOsXh5+dKJLNml/E2vwMDUGF9sSdLGoaKjvnIe79PLQyPDsSr3Dm7r+r2ehzQbe5R4lYXFMd6m6FjycHD49mE4OJt+eT5+nR9+nz56PJpPJnyIRy0az7KZZC0nRU1Kkh8+tK76CncGLzdR4DKLrmHB0Vx+e2QapVqaCBRqChbemSsBplAGB/ApkJZUBLQn9oy/XoOi99fdn4mGeDSNXRiuDl9shvDyaTC6nuyQc3U5CnyowlqC0rSlGXyHQ+7r0tj/3h3d0+d0uvGe3wzs1c6lVEVH73F6h+bqFHJqn3jy7ut/OqmeKdLEX7PB9H2TAvPWKVnFHLA+kUwc9Pb2YMfpy39jNaolLhWqRinGf1fF6t046wbr8fLtuWq9FKmoiF9LxOEhTZHY5sg5NUJXRMguj3DZj6dR4PhVdclNCOvcA7kCyUqY6uFdqdh3tGVekT/pezLvUS6de4Uok25QOuTaLs0YZYa/j59JG4U2i3zo0Z6oysUzz6a31+h51bhvkXU81wpb9n7/+jhKFzdsGDcUuegRvWw/OLtDzgpOmgFLjUmUa7zgdAspGYwh6BcoQVl4SQqEqRVIDZ4UxIJdOZkor7jtmsyztYdC6YQTva6QaPZO+8QgSCpyj5nYFbe0V6yELsiXbRBsbn2Fh/VXJLiUgIWuDMhgCBMStCJpamhxhW4sErAdpAA2hd14FBKkaZi6tByxLlStWzEPmZU7QSCMrZGMJsN+cBeftXBUYwNusDQTB6jYGwhYbROpDNIhFGMEvao594Pyyv7KwgKplFQnktkDYzByHYQrIMBA4Nq9yjEoDSU+gcY4+9l6sZNlqDc4yGCip+Xoa1pYVkZcmMF71Dm1Ls0uf85ZvmWijkKsRfDAfDMM3tAG5AbQyVyH9YA7gYtdm7zELinD2eDsPi8Xi1hw82Zc5UVS3GXh09lquii/j1AzFdw9PRCIIfRPelmfo5yrHzRB+xuY4Mo83ECnzCJHYSKX7GfvppgDDlVY5moADQDs+efca5vB0NBHJYPL/g8Pj16c/v3hz9oL1Mjb18zcdTUaTeALZQI00A1PXh/nNqV1fw/yXPeE3kEO4pLHTUkXMjlGuN3h7IXZHeHp9wM8SUdtATF6vMxnwD6+7jl9/atEzos8SMZdeyYxR6WItChX4d7G70D8b4OPfN8f+E7jzv8CdPm+x0zBwzqVu+Ukk4gpXe/88ulmXbOGT3erpx3mOjgaSt1bp3j46eXEuEiFbzs8Qtq8ibG9+sPY7vdrH894B/uTVcqfAD1zjV7j6ccfeUz4rsIlvy80ZmnVd9y+Lm+Fr",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/getfolder",title:"Get Folder",description:"The Get Folder API allows you to retrieve details about a specific folder.",source:"@site/docs/API-docs/getfolder.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getfolder",permalink:"/docs/API-docs/getfolder",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getfolder",title:"Get Folder",description:"The Get Folder API allows you to retrieve details about a specific folder.",sidebar_label:"Get Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V9tu20YQ/ZXJvjQBaF0cJ22JoqjRpq6TIAlqFwHqCMaSHJIbL3c3u0NdIPCtX9JP65cUs5RkynaMugjyIomc++3MaC1IVkGkF+JXqwv0YpaIAkPulSNljUjFeY1wggQ9HY7fnYLU2i4CrGwLZMEjeYVzhAJJKh1AZrYlkBAc5qpUOZRRdCQSYR16yYpPC5GKCqkniUQ46WWDhJ6dWQsjGxSp6MmXqhCJUOyNk1SLmy7a7CPmdFqALWGn0OOnVnksREq+xUQEWmlWGVTjNIpE4NJpW6BIS6kDM+Q1NlKka0ErFznJK1OJRJTWN5KGb3Apo5ZUuN+mWZ0f1i4TXTdjs8FZEzCwosPJhL/2vQ1tnmMIZathlw6RiNwaQkPML53TKo+E8cfAQuvb3vVBc+Y8qyHVm9zm4sFx1NOsXh5+dKJLNml/E2vwMDUGF9sSdLGoaKjvnIe79PLQyPDsSr3Dm7r+r2ehzQbe5R4lYXFMd6m6FjycHD49mE4OJt+eT5+nR9+nz56PJpPJnyIRy0az7KZZC0nRU1Kkh8+tK76CncGLzdR4DKLrmHB0Vx+e2QapVqaCBRqChbemSsBplAGB/ApkJZUBLQn9oy/XoOi99fdn4mGeDSNXRiuDl9shvDyaTC6nuyQc3U5CnyowlqC0rSlGXyHQ+7r0tj/3h3d0+d0uvGe3wzs1c6lVEVH73F6h+bqFHJqn3jy7ut/OqmeKdLEX7PB9H2TAvPWKVnFHLA+kUwc9Pb2YMfpy39jNaolLhWqRinGf1fF6t046wbr8fLtuWq9FKmoiF9LxOEhTZHY5sg5NUJXRMguj3DZj6dR4PhVdclNCOvcA7kCyUqY6uFdqdh3tGVekT/pezLvUS6de4Uok25QOuTaLs0YZYa/j59JG4U2i3zo0Z6oysUzz6a31+h51bhvkXU81wpb9n7/+jhKFzdsGDcUuegRvWw/OLtDzgpOmgFLjUmUa7zgdAspGYwh6BcoQVl4SQqEqRVIDZ4UxIJdOZkor7jtmsyztYdC6YQTva6QaPZO+8QgSCpyj5nYFbe0V6yELsiXbRBsbn2Fh/VXJLiUgIWuDMhgCBMStCJpamhxhW4sErAdpAA2hd14FBKkaZi6tByxLlStWzEPmZU7QSCMrZGMJsN+cBeftXBUYwNusDQTB6jYGwhYbROpDNIhFGMEvao594Pyyv7KwgKplFQnktkDYzByHYQrIMBA4Nq9yjEoDSU+gcY4+9l6sZNlqDc4yGCip+Xoa1pYVkZcmMF71Dm1Ls0uf85ZvmWijkKsRfDAfDMM3tAG5AbQyVyH9YA7gYtdm7zELinD2eDsPi8Xi1hw82Zc5UVS3GXh09lquii/j1AzFdw9PRCIIfRPelmfo5yrHzRB+xuY4Mo83ECnzCJHYSKX7GfvppgDDlVY5moADQDs+efca5vB0NBHJYPL/g8Pj16c/v3hz9oL1Mjb18zcdTUaTeALZQI00A1PXh/nNqV1fw/yXPeE3kEO4pLHTUkXMjlGuN3h7IXZHeHp9wM8SUdtATF6vMxnwD6+7jl9/atEzos8SMZdeyYxR6WItChX4d7G70D8b4OPfN8f+E7jzv8CdPm+x0zBwzqVu+Ukk4gpXe/88ulmXbOGT3erpx3mOjgaSt1bp3j46eXEuEiFbzs8Qtq8ibG9+sPY7vdrH894B/uTVcqfAD1zjV7j6ccfeUz4rsIlvy80ZmnVd9y+Lm+Fr",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Folder",permalink:"/docs/API-docs/createfolder"},next:{title:"Update Folder",permalink:"/docs/API-docs/updatefolder"}},f={},y=[{value:"Request",id:"request",level:2}];function g(e){const a={h2:"h2",p:"p",...(0,r.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Get Folder"})}),"\n",(0,l.jsx)(t(),{method:"get",path:"/folder/{folder_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Get Folder API allows you to retrieve details about a specific folder."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(o.Z,{className:"paramsItem",param:{name:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"folderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new folder"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"parentFolderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"J2nas5kiPe"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"parentFolderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new sub folder"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "objectId": "ph1bhx2jp",\n "folderName": "new folder",\n "parentFolderId": "J2nas5kiPe",\n "parentFolderName": "new sub folder",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"folder not found."})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder not found."}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "folder not found."\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:a}={...(0,r.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/ae010e44.9a975364.js b/assets/js/ae010e44.9a975364.js deleted file mode 100644 index 335510a30..000000000 --- a/assets/js/ae010e44.9a975364.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4930],{80204:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>g,contentTitle:()=>u,default:()=>y,frontMatter:()=>p,metadata:()=>x,toc:()=>j});var i=s(85893),a=s(11151),l=s(58219),t=(s(62316),s(51039)),r=s.n(t),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),m=s(9472),h=s(85162);const p={id:"selfsign",title:"Self Sign",description:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.",sidebar_label:"Self Sign",hide_title:!0,hide_table_of_contents:!0,api:"eJztO9tyGzeyv9KLF8eqISXSsuNlbW2tY+fs+mxiqyKlUluSSgFnmhxYGGACYEQxKlbtw/mM3ZfzafmSU43LzJCiJDtO7Wrr0A8yB2gA3Y1Go2+4YY7PLZucsjc6bypUzrLzjBVocyNqJ7RiE3ZSIliUMyvmCl4dvYU5KjTcoQUO33/3DbiSO0DFpxItzAyidUuJQPBCzUHPgEMR5x/C33QDOVfApdUgVC6bAkH7xbiE2uCgwJlQWMBCFHN0NoNFKfISXBnmROPHYyEcaAN4XXNVQFNrBdyCQiywGMJJKSzURl+JwiOasMHrGo1AldNklZDcgNN+7l/+/o9jIvFvujFE7y9//yfMpF6AUL7/fY3KA/C6Hp6pM3Ui6gl8X0vNC1jqxsDRm/9qCaVZqe10b+8NTps5fP92b+/8i9K52k7292kOXaMitCSf2mGuq/2CAOti9pRIRoM0a6CVWyGXwIseU1yJCnJdLyHX2hRC0Y5kUPM5gmqqKRqbAXGm0gaJBg4GebEcOD1oLMJ/H79/BzNtKu6GcCQbm7XLFcJg7uQyTE+0J6qeWJhyiy8OwToj1DyDil8SW4WDnxqRXxLZFlWRmPrq6K3n1d7ecVPX2jgs4IdAwmRvj3q+QuIxN+jhc11VWkHNDa/QobFBuqjb4E+NMF4uXAlcysSLyZkawN6eW9Y42duDt6oQuRdPmpBaSQQD7DCAEpMI9LjGXMxEBO2xDrSKUkc8WfCwn7XkeUDToK0xd+IK1ye+zmBJE79BpRMGpTbiZ60cl347rtA4kXPZ3zZC0Iu348YRO2stlEutcYX25NDu+U2JckWoFcSsSijfYxGuuGzQRqwWGZSE1XdYG7R0ytO8xEhVQIliXt65Hi8+NNatTQyNJTT7WMS10i559qJn24xLiyBma7ys+CX2Vms1wBC+WkKBM95Il4EgiXOmwSG8045OnhQ5KRqSXH+muWsMDvwuR3GIiChe+T0+6nRAIWYzNHQ4qdNPEcck7EjOgtIg8vzJcSVXoNXGRudaakPTb8iQb19nJORaOa/6Xl1xIT32gVrb6r+p5PllBlPZYAYGi3BylyilXmRB4D0IabjAdM8g0sskhloRAUrH5YUFG7FqNWE6UNTZaltaRNg+W+OxnWlamXiQzhhgxYXMPOcy+KCn4ISTmNGJrblaZlBwhxk4vHZTfZ1BXmJ+OdXXkWEzrZwVP285dqnn07k2zuAwgxcZvMxgdJDBaJzB6DCD0YsMRi8zGB9kMB5nMD7MYPwi8HT8MvKTt0zsIzAaB066x8VBUqDfCOuPKGk+2yrTxZoyPVOjIezttQfDN//4449n6uZMAZwxOihnbHLGWpAzlkHoI/13xiajDGLD9RmbwLPxlwlgSd8viIPhe0HfI+J4+C7pezw6U6u46Ngj43hV34MIdf/2SKTPKDPU6FemtqSjqJGUS4ClHtobam3Roo5VR9AzIkgo4QSX9m6aEsTjI6vDbIOyQ6LMS+jdZPnux0dTQiv1eCUYurzS7HWlo+4RGW+w4Pmwuzbu4EBY9LExIGL1ufS/IPpbvXQ3E1qQx8eJPmqfy44vh/6e97r5bmZEgMfHig6xz2XES2IE3U13c4F6Hx8LIlapI973oe/gcDB6PhgfjA/X2EDuUACoqkFRDJbL5WeyEDzDyASK63urMVqlwZjjDmFmdLXF5fAeQQcVTST/O5np35JxPk12KxbJX20NmNbL61vWThd8+cSGqdLQ1lYj+M5SW/bQ9F2Eh/d481KLPCJPMMlCm5JTNyQmDIjxxf633+73WBkaB1WV+Auplb4HnvX91qoaFsVwE3Zth3qtFRRFBlvat3cUBVRVdVd76KDr8kz9ng5CNM/uPgsR4F97HDqh75Z/+KhQQEAr6df3Xtr2s7Jxv5RCxY4oN7ABYHDeSG7wmtxNK7TyfPkNNNHGKUqHqDPlvXfqHTvv+wdWwBfvo7n+NAo4UbA+AbU8PO4WYf1JDM7x2s+RN9bpipARBacZMrBNXpLzxpNXQGzv4jT+K+e1oCiBROd8K7p8uA2JsGk9D5t2ddPBtujWiOEW0sgtPrbffe9ojA78vRd9j3suvgjx+NR+D7PUGaIW1H16xioeTRc2w+63diWaM3bejgm+NRa9sbBtMJxnd58n6A5NgZJPUd4+a59zGgJyfTFMKjgJc+IGSGFT9GKdtP7oGN7xQTcKpZIkTRHSAJi2gvPZgtki9nGSGc5tZOIDSxAceMA2tNY60/fKvveeRRXCg3c5d5WX88cm9RGtDRlhGdM1ReuFVm8LNmEpks8yPyta95Uulmxyw2LAhX7GcAYN2v9gKQtww2xeYsXpV8KG8gYzIZFlLMTlLcuYt74piUD8YhOmpx8wdyyju6Km0CdamsOPm9wkqBBNZlm0wNiEhTAzyxhe86om4NgEqHJNZk5dzNgqLXjfVG1LN5X1P9qwNs2zlvT4VbO96c2wyhhFgH/lTO9oqKetwhP9WlOjwzd8aXsThsuDbaZraAydgTyOgoIvLcWoGhuOc85l3kgy5vC6FmbZWpbeomtZ0kO0XalFdPR8lTa9h9Ede230p29QjpoY4F37Tx37QeMU8U+xgTIrfjt49clYfNAIU/RbUZdaffL40fjZaDx6NhrTDDFS15uDG8OXLGPCYWUf5mPovY3B+v6/IgsDi6TJB12UPAMf1Bo+JIMJ3pPN5/iwzJ3clT3pxXNtqRtZUKQUuRn6JMavzo+tizEt4qkdPiC0q4xdP0zMNeR6kFIz8IXEmYOmrintqI1C87Tvqz0a4saHh6uMLR8mb/kfSd6XtHmLh6n7wee0unzfvwPXZy9XGSsfxvUvbdbt34js4YtVd4my3CB3mO6Ai6kulhdJb636gMmMWAeNN8KKVpQFGrI4buurTtUQJGWLLzb1/FRriVxtUTRrmRjvTVlv+pFhGYMVixLJlu8sQj+7bU3ZaIYGk4WyO7jhPwpL9p5p8IwN4e2s42UwJjeTQQnWJ4OUhid+vQvbeDX+ZD9+E4ee9DPblGzsgjQJBQ8MDqta+tTwQkhJeNP1PYT2nzftWk4SAum6TAs/fFW8Dn6qXzAOWs+rQjQRh/Caqzbttp7egpubVgi8dKxWcHNDu4rmgi7d1SrrGmittQZ/r4YWgzmKq7VRbRN2A9u23tBgyVyQJRMaYvSzj0AoALlojFythrfEsNujj+bbLTbFvaNJ/j9wzFf8nOjGfMTB9V7aIBye4OEEwQ6TAId542OXjtRfkkEfBOnS8UJZZ5o8uLdFY1IFQirtqY3O0dphLDgYQCFsSMmW2J8/A1Q2DOcw49ahyaBRQjk0pqnJzb1dLbRGv19gRR5UKJUhFj0sNutpb6qcClU+vcKmdNjTxBgLm6Ix39ZcpCKjTdI3NukhhR10eufPRTVC1S1a2WB1jg8O6L91UlK5GMQLg+JbhMCskXL5O5Z9vDN5v8kbmrdfI/fZsOUHMf75Or8aH5Gk3rE7904Qr9zGSCqYIs4N2ho271H0eCuUFAovEtsuxgcHFyPi7Spjh9vYd6wrdKUvDiAmLoymUqpaIqfSHrMEPudCAV0A5jfkJhqjzf038qdhdh8TDteY8Pw2E94qHyD1JYUn+hLVv5bS/vIuLE+oXldeVoK3yEQA8v1sjdh+eyDSYt4Y4ZZscnrDrge8FoPQPzk9X51njBirKQRTa+sx5q5kE7bfi8hYNFcURqEZNiRmwedzNH9pph7hV43T8K3OLwNVXsBbmb0SxoWZhjYMK5uptxWPDKcT+o5fXXKzT6bk/mh4MDxgq+xmYxLLVUHhslv2Jq/F/tVoy4it1umd0NbxuVDzwb2jzjuuHtPOh81d423nTNfir0jedNy6PlTGBDGxRF6QebrKGAnUd1386+skFikytS3Y1FOmG+GjTU2/JSCU4kFrIZ7tEZ7R835sJURPfECkjYdsC3G0hKegRRuz6IUhelGI0+5wtA5/8vdH3lEeHx56j/LLkXe9nr30Xs3hi9X5moHP2LoR7wOUm6YoY+smlv/uGRAhIr5xoXozQ6iZ9tsced+W4dI5uBrd9gBR5rpq67AS+C//879+RNozr1d+B+8bA7VeoJk1oZhrJvFakNFAwBv+BfJKorVyCWQrzKkGGgox90mbdBPnvOZTIQVpIgLTIazWU2Z2CD90HsoTE/JXVyhJgYHU2hfUOg28cbrya6TbdqHNJZUkU2UvTKkGE60Fi5iGoCq5L22OpyajCmkqICbbpjbCInBRETDZWDibiVz4a1wrZ3juoOKKz5EWy7wnSlxoq6iNnlKu2WrZBCOM6jgRXSCR0gV2CG+oKNYT7sOJ6LiQWAT7y1KxW0GBRy+3sUB5SqZzTcuLHG2X9ZZ4hcZriWBAN1JCrel6EFySK9bfW5rIGa4s3eoxlBm3pmVftJL8GgVfDoFi/nTjkXNFAiCFugzlxKetmP2AUyscdl74YrG4pbGero/5s3BlMwWDte7GzX2j12/94e3HU1IHaCr7fnaM5krkyQ65Y819D7wfL00eHL6kIHgt/rQ5gE6TFDkqi70r7tWfj76BK3g2PFi7SD4C4f1v3r7++t3x1zQvXVvh/KULxV9zFVe9pY5RzuA4XHUb4fb23t89N9g9N9g9N9g9N9g9N9g9N9g9N9g9N9g9N9g9N3hcNO2eG+yeG+yeG+yeG+yeG+yeG+yeG+yeG+yeG+yeG+yeG+yeG+yeG/iatJhUJD2wX0suVK8CI6S8T7tHCOcZKykbPjllNzcU6v2eao2o+acGDaXSzzN2xY2gWIdPpGcpi0sJzEukVOLrELoZnNDKWTh8PgWyUT9ASegw4lWeY+3uhe0n7I/eH5+wjKXisEoXNMbwBT2i4As2YXTd+KcWnpk+bct9tarkat74nCoL81LymTeuXM9cX/rMdfzRS81ytexhuZ7SDqTQXyJs64A/UP7kr7j8Ywseeu4cEHmboGnzzler1f8BZUCCMA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/selfsign",title:"Self Sign",description:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.",source:"@site/docs/API-docs/selfsign.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/selfsign",permalink:"/docs/API-docs/selfsign",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"selfsign",title:"Self Sign",description:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.",sidebar_label:"Self Sign",hide_title:!0,hide_table_of_contents:!0,api:"eJztO9tyGzeyv9KLF8eqISXSsuNlbW2tY+fs+mxiqyKlUluSSgFnmhxYGGACYEQxKlbtw/mM3ZfzafmSU43LzJCiJDtO7Wrr0A8yB2gA3Y1Go2+4YY7PLZucsjc6bypUzrLzjBVocyNqJ7RiE3ZSIliUMyvmCl4dvYU5KjTcoQUO33/3DbiSO0DFpxItzAyidUuJQPBCzUHPgEMR5x/C33QDOVfApdUgVC6bAkH7xbiE2uCgwJlQWMBCFHN0NoNFKfISXBnmROPHYyEcaAN4XXNVQFNrBdyCQiywGMJJKSzURl+JwiOasMHrGo1AldNklZDcgNN+7l/+/o9jIvFvujFE7y9//yfMpF6AUL7/fY3KA/C6Hp6pM3Ui6gl8X0vNC1jqxsDRm/9qCaVZqe10b+8NTps5fP92b+/8i9K52k7292kOXaMitCSf2mGuq/2CAOti9pRIRoM0a6CVWyGXwIseU1yJCnJdLyHX2hRC0Y5kUPM5gmqqKRqbAXGm0gaJBg4GebEcOD1oLMJ/H79/BzNtKu6GcCQbm7XLFcJg7uQyTE+0J6qeWJhyiy8OwToj1DyDil8SW4WDnxqRXxLZFlWRmPrq6K3n1d7ecVPX2jgs4IdAwmRvj3q+QuIxN+jhc11VWkHNDa/QobFBuqjb4E+NMF4uXAlcysSLyZkawN6eW9Y42duDt6oQuRdPmpBaSQQD7DCAEpMI9LjGXMxEBO2xDrSKUkc8WfCwn7XkeUDToK0xd+IK1ye+zmBJE79BpRMGpTbiZ60cl347rtA4kXPZ3zZC0Iu348YRO2stlEutcYX25NDu+U2JckWoFcSsSijfYxGuuGzQRqwWGZSE1XdYG7R0ytO8xEhVQIliXt65Hi8+NNatTQyNJTT7WMS10i559qJn24xLiyBma7ys+CX2Vms1wBC+WkKBM95Il4EgiXOmwSG8045OnhQ5KRqSXH+muWsMDvwuR3GIiChe+T0+6nRAIWYzNHQ4qdNPEcck7EjOgtIg8vzJcSVXoNXGRudaakPTb8iQb19nJORaOa/6Xl1xIT32gVrb6r+p5PllBlPZYAYGi3BylyilXmRB4D0IabjAdM8g0sskhloRAUrH5YUFG7FqNWE6UNTZaltaRNg+W+OxnWlamXiQzhhgxYXMPOcy+KCn4ISTmNGJrblaZlBwhxk4vHZTfZ1BXmJ+OdXXkWEzrZwVP285dqnn07k2zuAwgxcZvMxgdJDBaJzB6DCD0YsMRi8zGB9kMB5nMD7MYPwi8HT8MvKTt0zsIzAaB066x8VBUqDfCOuPKGk+2yrTxZoyPVOjIezttQfDN//4449n6uZMAZwxOihnbHLGWpAzlkHoI/13xiajDGLD9RmbwLPxlwlgSd8viIPhe0HfI+J4+C7pezw6U6u46Ngj43hV34MIdf/2SKTPKDPU6FemtqSjqJGUS4ClHtobam3Roo5VR9AzIkgo4QSX9m6aEsTjI6vDbIOyQ6LMS+jdZPnux0dTQiv1eCUYurzS7HWlo+4RGW+w4Pmwuzbu4EBY9LExIGL1ufS/IPpbvXQ3E1qQx8eJPmqfy44vh/6e97r5bmZEgMfHig6xz2XES2IE3U13c4F6Hx8LIlapI973oe/gcDB6PhgfjA/X2EDuUACoqkFRDJbL5WeyEDzDyASK63urMVqlwZjjDmFmdLXF5fAeQQcVTST/O5np35JxPk12KxbJX20NmNbL61vWThd8+cSGqdLQ1lYj+M5SW/bQ9F2Eh/d481KLPCJPMMlCm5JTNyQmDIjxxf633+73WBkaB1WV+Auplb4HnvX91qoaFsVwE3Zth3qtFRRFBlvat3cUBVRVdVd76KDr8kz9ng5CNM/uPgsR4F97HDqh75Z/+KhQQEAr6df3Xtr2s7Jxv5RCxY4oN7ABYHDeSG7wmtxNK7TyfPkNNNHGKUqHqDPlvXfqHTvv+wdWwBfvo7n+NAo4UbA+AbU8PO4WYf1JDM7x2s+RN9bpipARBacZMrBNXpLzxpNXQGzv4jT+K+e1oCiBROd8K7p8uA2JsGk9D5t2ddPBtujWiOEW0sgtPrbffe9ojA78vRd9j3suvgjx+NR+D7PUGaIW1H16xioeTRc2w+63diWaM3bejgm+NRa9sbBtMJxnd58n6A5NgZJPUd4+a59zGgJyfTFMKjgJc+IGSGFT9GKdtP7oGN7xQTcKpZIkTRHSAJi2gvPZgtki9nGSGc5tZOIDSxAceMA2tNY60/fKvveeRRXCg3c5d5WX88cm9RGtDRlhGdM1ReuFVm8LNmEpks8yPyta95Uulmxyw2LAhX7GcAYN2v9gKQtww2xeYsXpV8KG8gYzIZFlLMTlLcuYt74piUD8YhOmpx8wdyyju6Km0CdamsOPm9wkqBBNZlm0wNiEhTAzyxhe86om4NgEqHJNZk5dzNgqLXjfVG1LN5X1P9qwNs2zlvT4VbO96c2wyhhFgH/lTO9oqKetwhP9WlOjwzd8aXsThsuDbaZraAydgTyOgoIvLcWoGhuOc85l3kgy5vC6FmbZWpbeomtZ0kO0XalFdPR8lTa9h9Ede230p29QjpoY4F37Tx37QeMU8U+xgTIrfjt49clYfNAIU/RbUZdaffL40fjZaDx6NhrTDDFS15uDG8OXLGPCYWUf5mPovY3B+v6/IgsDi6TJB12UPAMf1Bo+JIMJ3pPN5/iwzJ3clT3pxXNtqRtZUKQUuRn6JMavzo+tizEt4qkdPiC0q4xdP0zMNeR6kFIz8IXEmYOmrintqI1C87Tvqz0a4saHh6uMLR8mb/kfSd6XtHmLh6n7wee0unzfvwPXZy9XGSsfxvUvbdbt34js4YtVd4my3CB3mO6Ai6kulhdJb636gMmMWAeNN8KKVpQFGrI4buurTtUQJGWLLzb1/FRriVxtUTRrmRjvTVlv+pFhGYMVixLJlu8sQj+7bU3ZaIYGk4WyO7jhPwpL9p5p8IwN4e2s42UwJjeTQQnWJ4OUhid+vQvbeDX+ZD9+E4ee9DPblGzsgjQJBQ8MDqta+tTwQkhJeNP1PYT2nzftWk4SAum6TAs/fFW8Dn6qXzAOWs+rQjQRh/Caqzbttp7egpubVgi8dKxWcHNDu4rmgi7d1SrrGmittQZ/r4YWgzmKq7VRbRN2A9u23tBgyVyQJRMaYvSzj0AoALlojFythrfEsNujj+bbLTbFvaNJ/j9wzFf8nOjGfMTB9V7aIBye4OEEwQ6TAId542OXjtRfkkEfBOnS8UJZZ5o8uLdFY1IFQirtqY3O0dphLDgYQCFsSMmW2J8/A1Q2DOcw49ahyaBRQjk0pqnJzb1dLbRGv19gRR5UKJUhFj0sNutpb6qcClU+vcKmdNjTxBgLm6Ix39ZcpCKjTdI3NukhhR10eufPRTVC1S1a2WB1jg8O6L91UlK5GMQLg+JbhMCskXL5O5Z9vDN5v8kbmrdfI/fZsOUHMf75Or8aH5Gk3rE7904Qr9zGSCqYIs4N2ho271H0eCuUFAovEtsuxgcHFyPi7Spjh9vYd6wrdKUvDiAmLoymUqpaIqfSHrMEPudCAV0A5jfkJhqjzf038qdhdh8TDteY8Pw2E94qHyD1JYUn+hLVv5bS/vIuLE+oXldeVoK3yEQA8v1sjdh+eyDSYt4Y4ZZscnrDrge8FoPQPzk9X51njBirKQRTa+sx5q5kE7bfi8hYNFcURqEZNiRmwedzNH9pph7hV43T8K3OLwNVXsBbmb0SxoWZhjYMK5uptxWPDKcT+o5fXXKzT6bk/mh4MDxgq+xmYxLLVUHhslv2Jq/F/tVoy4it1umd0NbxuVDzwb2jzjuuHtPOh81d423nTNfir0jedNy6PlTGBDGxRF6QebrKGAnUd1386+skFikytS3Y1FOmG+GjTU2/JSCU4kFrIZ7tEZ7R835sJURPfECkjYdsC3G0hKegRRuz6IUhelGI0+5wtA5/8vdH3lEeHx56j/LLkXe9nr30Xs3hi9X5moHP2LoR7wOUm6YoY+smlv/uGRAhIr5xoXozQ6iZ9tsced+W4dI5uBrd9gBR5rpq67AS+C//879+RNozr1d+B+8bA7VeoJk1oZhrJvFakNFAwBv+BfJKorVyCWQrzKkGGgox90mbdBPnvOZTIQVpIgLTIazWU2Z2CD90HsoTE/JXVyhJgYHU2hfUOg28cbrya6TbdqHNJZUkU2UvTKkGE60Fi5iGoCq5L22OpyajCmkqICbbpjbCInBRETDZWDibiVz4a1wrZ3juoOKKz5EWy7wnSlxoq6iNnlKu2WrZBCOM6jgRXSCR0gV2CG+oKNYT7sOJ6LiQWAT7y1KxW0GBRy+3sUB5SqZzTcuLHG2X9ZZ4hcZriWBAN1JCrel6EFySK9bfW5rIGa4s3eoxlBm3pmVftJL8GgVfDoFi/nTjkXNFAiCFugzlxKetmP2AUyscdl74YrG4pbGero/5s3BlMwWDte7GzX2j12/94e3HU1IHaCr7fnaM5krkyQ65Y819D7wfL00eHL6kIHgt/rQ5gE6TFDkqi70r7tWfj76BK3g2PFi7SD4C4f1v3r7++t3x1zQvXVvh/KULxV9zFVe9pY5RzuA4XHUb4fb23t89N9g9N9g9N9g9N9g9N9g9N9g9N9g9N9g9N9g9N3hcNO2eG+yeG+yeG+yeG+yeG+yeG+yeG+yeG+yeG+yeG+yeG+yeG+yeG/iatJhUJD2wX0suVK8CI6S8T7tHCOcZKykbPjllNzcU6v2eao2o+acGDaXSzzN2xY2gWIdPpGcpi0sJzEukVOLrELoZnNDKWTh8PgWyUT9ASegw4lWeY+3uhe0n7I/eH5+wjKXisEoXNMbwBT2i4As2YXTd+KcWnpk+bct9tarkat74nCoL81LymTeuXM9cX/rMdfzRS81ytexhuZ7SDqTQXyJs64A/UP7kr7j8Ywseeu4cEHmboGnzzler1f8BZUCCMA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Contact list",permalink:"/docs/API-docs/contactlist"},next:{title:"Draft Document",permalink:"/docs/API-docs/draftdocument"}},g={},j=[{value:"Request",id:"request",level:2}];function f(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(n.p,{children:"Self Sign"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/selfsign"}),"\n",(0,i.jsx)(n.p,{children:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app."}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"name", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job title:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"job title", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"company", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"date", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "name": "textbox",\n "required": true, \n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression":"",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(n.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded pdf"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Description"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Note"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"timeToCompleteDays",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"signer"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})})]})]})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"send_email",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"redirect_url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(l.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Document created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://url-to-sign-document.com"}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://url-to-sign-document.com"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/ae010e44.a965d111.js b/assets/js/ae010e44.a965d111.js new file mode 100644 index 000000000..86b432e42 --- /dev/null +++ b/assets/js/ae010e44.a965d111.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4930],{80204:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>g,contentTitle:()=>u,default:()=>y,frontMatter:()=>p,metadata:()=>x,toc:()=>j});var i=s(85893),a=s(11151),l=s(58219),t=(s(62316),s(51039)),r=s.n(t),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),h=s(9472),m=s(85162);const p={id:"selfsign",title:"Self Sign",description:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.",sidebar_label:"Self Sign",hide_title:!0,hide_table_of_contents:!0,api:"eJztO11zGzeSf6UXL45VQ0qkZcfHurpax87t+jaJXZFSqS1RpYAzTRIWBpgAGJGMilX7cD9j9+V+Wn7JVeNjZkiRkh2ndnV1zIPDARqN7kaj0V+6ZY7PLBtdsDc6r0tUzrLLjBVocyMqJ7RiI3Y+R7Aop1bMFLx6/xZmqNBwhxY4/PD9N+Dm3AEqPpFoYWoQrVtJBIIXagZ6ChyKiL8Pf9U15FwBl1aDULmsCwTtN+MSKoO9AqdCYQELUczQ2QwWc5HPwc0DTjR+PRbCgTaAy4qrAupKK+AWFGKBRR/O58JCZfSNKDyhiRpcVmgEqpyQlUJyA0573L/+7e9nxOJfdW2I31//9g+YSr0Aofz8uwqVB+BV1R+rsToX1Qh+qKTmBax0beD9m/9sGCWsNHZxdPQGJ/UMfnh7dHT5xdy5yo6OjwmHrlARWZJPbD/X5XFBgFUxfUoso0HCGnjlVsgV8KIjFDdHBbmuVpBrbQqh6EQyqPgMQdXlBI3NgCRTaoPEAweDvFj1nO7VFuG/zt59B1NtSu768F7WNmu2K4TB3MlVQE+8J66eWJhwiy9OwToj1CyDkl+TWIWDn2uRXxPbFlWRhPrq/Vsvq6Ojs7qqtHFYwI+BhdHREc18hSRjbtDD57ostYKKG16iQ2ODdtG0wZ9rYbxeuDlwKZMsRmPVg6Mjt6pwdHQEb1Uhcq+ehJBGSQUDbD+AkpAI9KzCXExFBO2IDrSKWkcyWfBwnpXkeSDToK0wd+IGNxEvM1gR4jeodKJgro34RSvHpT+OGzRO5Fx2j40I9OrtuHEkzkoL5dJo3KG5OXR6/lCiXhFpBQmrFMrPWIQbLmu0kapFBnOi6nusDFq65QkvCVIVMEcxm+/djxcfaus2EENticwuFXGvdEpevOjFNuXSIojphixLfo2d3RoL0IevVlDglNfSZSBI45ypsQ/faUc3T4qcDA1prr/T3NUGe/6UozpEQhQv/Rm/b21AIaZTNHQ5adKjiGsSdaRnwWgQe/7muDlXoNXWQedaakPot3TIj28KEnKtnDd9r264kJ76wK1t7N9E8vw6g4msMQODRbi5K5RSL7Kg8B6ELFwQuhcQ2WVSQ62IAaXj9sKCjVQ1ljBdKJpsrC1tImxXrPHaTjXtTDJIdwyw5EJmXnIZfNATcMJJzOjGVlytMii4wwwcLt1ELzPI55hfT/QyCmyqlbPilx3XLs18utSGGZxm8CKDlxkMTjIYDDMYnGYweJHB4GUGw5MMhsMMhqcZDF8EmQ5fRnnyRohdAgbDIEn3uCRIBvQbYf0VJctnG2O62DCmYzXow9FRczH88E8//TRWt2MFMGZ0UcZsNGYNyJhlEObI/o3ZaJBBHFiO2QieDb9MACv6fkESDN8L+h6QxMP3nL6Hg7Fax02HnhjHy+oeQmj69ycifUadoUG/M40lG0WDZFwCLM3Q2dBoQxZNrFuGnhFDQgknuLT7eUoQj4+tlrItzk6JM6+h+9ny04+Pp0RWmvFGMEx5o9mZSlfdEzLcEsHzfvts7JFA2PSxCSBS9bn8vyD+G7u0XwgNyOOTRJe0zxXHl33/znvbvF8YEeDxiaIl7HMF8ZIEQW/TfinQ7OMTQaQqTcT3PsydnPYGz3vDk+HphhgoHAoAZdkrit5qtfpMEYIXGLlAcX/vNUavNDhz3CFMjS53hBw+Imihoovkfyc3/VtyzifJb8UixauNA9NEeV3P2umCr57YgCotbXw1gm89tVWHTD9FdPiIN59rkUfiCSZ5aBMK6vokhB4Jvjj+9tvjjijDYK8sk3whjdJ3z4u+O1qW/aLob8NunFBntISiyGDH+O6JooCyLPeNhwl6Lsfq3+giRPds/12IAP/c69Aqfbv9w1eFEgJaSb+/j9J235Wt92UuVJyIegNbAAZnteQGlxRuWqGVl8vvYIm2blG6RK0r76NTH9j52D+IAr54F931p1HBiYNNBDTy8Lo7jHWRGJzh0uPIa+t0ScSIghOGDGydzyl44ykqILG3eRr/lfNKUJZAonN+FF3e30VEOLROhE2nuh1gW3QbzHALaeWOGNufvg80Bif+3Yuxxz0PX4R4fGa/Q1maDFkLmr4Ys5JH14VNsf2t3RzNmF02a0JsjUVnLexaDJfZ/vsE7aUpUPIJyrt37XNuQyCuq4bJBCdlTtIAKWzKXmyy1l0d0zs+6UapVNKkCUJaAJNGcT5bMRvCPk4zw72NQnxgC4IDD9ik1ppg+l7d99GzKEN6cF9wV3o9f2xaH8na0hGWMV1Rtl5o9bZgI5Yy+SzzWNG6r3SxYqNbFhMu9DOmM2jR8QdLVYBbZvM5lpx+JWqobjAVElnGQl7esox575uKCCQvNmJ68gFzxzJ6KypKfaIlHH7d6DZBhWwyy6IHxkYspJlZxnDJy4qA4xCgyjW5OVUxZeu04X2ompEWlfU/mrQ24dkoevwmbG86GNYZowzwb8T0HS31vJV4rl9rGnT4hq9sB2F4PNh2uYbW0B3I4yoo+MpSjqq24TrnXOa1JGcOl5Uwq8az9B5dI5IOoc1ODaGD5+t06B2K9py10Z9+QDlqEoAP7T917QeNE8Q/xgGqrPjj4OUnU/FBI0zQH0U11+qT1w+GzwbDwbPBkDDETF0HBzeGr1jGhMPSPizHMHuXgs3zf0UeBhbJkvfaLHkGPqnVf0gHE7xnm8/wYZ0731c96eRz7VzXsqBMKXLT90WM31wf21Rj2sRz239AadcZWz7MzBJy3UulGfhC4tRBXVVUdtRGoXnajdUeDXPD09N1xlYPs7f6P8nel3R4i4e5+9HXtNp637+C1mcv1xmbP0zrn5uq27+Q2NMX6/YRZblB7jC9AVcTXayukt1adwGTG7EJGl+ENe0oCzTkcdy1V62pIUiqFl9t2/mJ1hK52mFoNioxPpqy3vUjxzImKxZzJF++9Qg9dtu4stENDS4LVXdwK34Ulvw9U+OY9eHttJVlcCa3i0EJ1heDlIYnfr8rW3sz/uQ4fpOEnnQr21RsbJM0iQQPDA7LSvrS8EJISXTT892H5j/v2jWSJALSc5k2fvipeB3iVL9hXLRZV4XoIvbhNVdN2W2zvAW3t40SeO1Yr+H2lk4VzRU9uut11g7QXhsD/l0NIwZzFDcbq5ohbBc2Y52lwZO5Ik8mDMTsZ5eA0AByVRu5XvfvqGF7Rh8ttztiimdHSP4/SMx3/Jzr2nzExfVRWi9cnhDhBMUOSIDDrPa5S0fmL+mgT4K05XihrDN1HsLbojapAyG19lRG52htPzYc9KAQNpRk59jFnwEqG5ZzmHLr0GRQK6EcGlNXFObe7Rba4N9vsKYIKrTKkIgeVpvNsjd1ToUun05jU7rsCTHGxqbozDc9F6nJaJv1rUN6yGAHm97Gc9GMUHeLVjZ4ncOTE/rfJiupXQzig0H5LSJgWku5+gPLPj6YvN/lDcO7n5H7fNj5BzH8ZZnfDN+Tpu45nXsRxCe3NpIapkhyvaaHzUcUHdkKJYXCqyS2q+HJydWAZLvO2Oku8Z3pEt3cNweQEBdGUytVJZFTa49ZAZ9xoYAeAPM7ShON0eb+F/nTKLtPCKcbQnh+VwhvlU+Q+pbCc32N6p/LaXd7F7YnUpel15UQLTIRgPw822C2Ox6YtJjXRrgVG13csmWPV6IX5kcXl+vLjJFgNaVgKm09xdzN2YgddzIyFs0NpVEIg1faRg8tVwVlr+64f7wSxzcDts62V+x0FvdCW8dnQs169666bJk8o4MIst5gtY1tK/EXpOA2SrILlTFBCjBHXpC3uM4Yne/3bTrq63RKKVG0K/fTsW1b2Zxtw7sjP5PSMxsZl90Jl8HzbqojJDN8fqJJT+zKODSMpxxCk0LoZAU6SYGLVleb+DuF3wMftw5PT32A9+XAR0LPXvog4/TF+nLD32Zs06f2+cJtz5CxTY/Hf3fe85Cg3nrf/Ksv1FT7Y46yb7pi6R7dDO4GZChzXTZtUQn81//+H78inZm/5n+Ad7WBSi/QTOvQWzWVuBT0hhPwlruPvJRorVwBPd0zakmGQsx8DSU9jDmv+ERIQYaBwHTIcnVsi+3Dj23A8MSEctINSrInILX2/a1OA6+dLv0e6fFbaHNNHcLUaAsTaolEa8EipiWo5tx3Gsdbk1HDMvXzkqtRGWERuCgJmFwenE5FLvyrqpUzPHdQcsVnSJtlPjAkKTRNzUZPqPRrtayDT0RtlYgusEjZe9uHN9Sj6hn32T10XEgsgjtkqfesoDyg19vYLzwhT7ai7UWOti1CS7xB461E8GdrKaHSZK0FlxQZdc+WEDnDlaVHNmYW49E04otOi9+j4Ks+UAqeHiCKdUgBpFDXobv3olGzH3FihcM2KF4sFncs1tPNNX8Sbl5PwGCl23UzP+jtW3d58/GUzAGa0r6bnqG5EXlyC/bseeyBj+MbxkP8lQwEr8QftxfQbZIiR2Wx8+K8+tP7b+AGnvVPWNax0R9B8PE3b19//d3Z14SXXpFw/wb9k/6Jz+Rp60quOludoZzCWXh5trLfzTN86P4/dP8fuv8P3f+H7v9D9/+h+//Q/X/o/j90/z8ung7d/4fu/0P3/6H7/9D9f+j+P3T/H7r/D93/h+7/Q/f/ofv/0P3vW8RiUZHswHEluVCdhohQgb5o/ybgMmNzKk6PLtjtLaV6f6DWHxr+uUZDle3LjN1wIyjX4evaWariUgHzGqmU+DqkbnrntHMWLp8vgWyV86kIHVa8ynOs3L2w3fr5+3dn5yxjqVer1AWtMXxBf9PAF2zE6Lnxf/nghenLttw3j0quZrWvqbKAl4rPvHbzzcr1ta9cxx+d0ixXqw6VmyXtwAr9S4ztXPDvVD/5C67+owEPM3sXRNkmaDq8y/V6/b9fCVqF",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/selfsign",title:"Self Sign",description:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.",source:"@site/docs/API-docs/selfsign.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/selfsign",permalink:"/docs/API-docs/selfsign",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"selfsign",title:"Self Sign",description:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.",sidebar_label:"Self Sign",hide_title:!0,hide_table_of_contents:!0,api:"eJztO11zGzeSf6UXL45VQ0qkZcfHurpax87t+jaJXZFSqS1RpYAzTRIWBpgAGJGMilX7cD9j9+V+Wn7JVeNjZkiRkh2ndnV1zIPDARqN7kaj0V+6ZY7PLBtdsDc6r0tUzrLLjBVocyMqJ7RiI3Y+R7Aop1bMFLx6/xZmqNBwhxY4/PD9N+Dm3AEqPpFoYWoQrVtJBIIXagZ6ChyKiL8Pf9U15FwBl1aDULmsCwTtN+MSKoO9AqdCYQELUczQ2QwWc5HPwc0DTjR+PRbCgTaAy4qrAupKK+AWFGKBRR/O58JCZfSNKDyhiRpcVmgEqpyQlUJyA0573L/+7e9nxOJfdW2I31//9g+YSr0Aofz8uwqVB+BV1R+rsToX1Qh+qKTmBax0beD9m/9sGCWsNHZxdPQGJ/UMfnh7dHT5xdy5yo6OjwmHrlARWZJPbD/X5XFBgFUxfUoso0HCGnjlVsgV8KIjFDdHBbmuVpBrbQqh6EQyqPgMQdXlBI3NgCRTaoPEAweDvFj1nO7VFuG/zt59B1NtSu768F7WNmu2K4TB3MlVQE+8J66eWJhwiy9OwToj1CyDkl+TWIWDn2uRXxPbFlWRhPrq/Vsvq6Ojs7qqtHFYwI+BhdHREc18hSRjbtDD57ostYKKG16iQ2ODdtG0wZ9rYbxeuDlwKZMsRmPVg6Mjt6pwdHQEb1Uhcq+ehJBGSQUDbD+AkpAI9KzCXExFBO2IDrSKWkcyWfBwnpXkeSDToK0wd+IGNxEvM1gR4jeodKJgro34RSvHpT+OGzRO5Fx2j40I9OrtuHEkzkoL5dJo3KG5OXR6/lCiXhFpBQmrFMrPWIQbLmu0kapFBnOi6nusDFq65QkvCVIVMEcxm+/djxcfaus2EENticwuFXGvdEpevOjFNuXSIojphixLfo2d3RoL0IevVlDglNfSZSBI45ypsQ/faUc3T4qcDA1prr/T3NUGe/6UozpEQhQv/Rm/b21AIaZTNHQ5adKjiGsSdaRnwWgQe/7muDlXoNXWQedaakPot3TIj28KEnKtnDd9r264kJ76wK1t7N9E8vw6g4msMQODRbi5K5RSL7Kg8B6ELFwQuhcQ2WVSQ62IAaXj9sKCjVQ1ljBdKJpsrC1tImxXrPHaTjXtTDJIdwyw5EJmXnIZfNATcMJJzOjGVlytMii4wwwcLt1ELzPI55hfT/QyCmyqlbPilx3XLs18utSGGZxm8CKDlxkMTjIYDDMYnGYweJHB4GUGw5MMhsMMhqcZDF8EmQ5fRnnyRohdAgbDIEn3uCRIBvQbYf0VJctnG2O62DCmYzXow9FRczH88E8//TRWt2MFMGZ0UcZsNGYNyJhlEObI/o3ZaJBBHFiO2QieDb9MACv6fkESDN8L+h6QxMP3nL6Hg7Fax02HnhjHy+oeQmj69ycifUadoUG/M40lG0WDZFwCLM3Q2dBoQxZNrFuGnhFDQgknuLT7eUoQj4+tlrItzk6JM6+h+9ny04+Pp0RWmvFGMEx5o9mZSlfdEzLcEsHzfvts7JFA2PSxCSBS9bn8vyD+G7u0XwgNyOOTRJe0zxXHl33/znvbvF8YEeDxiaIl7HMF8ZIEQW/TfinQ7OMTQaQqTcT3PsydnPYGz3vDk+HphhgoHAoAZdkrit5qtfpMEYIXGLlAcX/vNUavNDhz3CFMjS53hBw+Imihoovkfyc3/VtyzifJb8UixauNA9NEeV3P2umCr57YgCotbXw1gm89tVWHTD9FdPiIN59rkUfiCSZ5aBMK6vokhB4Jvjj+9tvjjijDYK8sk3whjdJ3z4u+O1qW/aLob8NunFBntISiyGDH+O6JooCyLPeNhwl6Lsfq3+giRPds/12IAP/c69Aqfbv9w1eFEgJaSb+/j9J235Wt92UuVJyIegNbAAZnteQGlxRuWqGVl8vvYIm2blG6RK0r76NTH9j52D+IAr54F931p1HBiYNNBDTy8Lo7jHWRGJzh0uPIa+t0ScSIghOGDGydzyl44ykqILG3eRr/lfNKUJZAonN+FF3e30VEOLROhE2nuh1gW3QbzHALaeWOGNufvg80Bif+3Yuxxz0PX4R4fGa/Q1maDFkLmr4Ys5JH14VNsf2t3RzNmF02a0JsjUVnLexaDJfZ/vsE7aUpUPIJyrt37XNuQyCuq4bJBCdlTtIAKWzKXmyy1l0d0zs+6UapVNKkCUJaAJNGcT5bMRvCPk4zw72NQnxgC4IDD9ik1ppg+l7d99GzKEN6cF9wV3o9f2xaH8na0hGWMV1Rtl5o9bZgI5Yy+SzzWNG6r3SxYqNbFhMu9DOmM2jR8QdLVYBbZvM5lpx+JWqobjAVElnGQl7esox575uKCCQvNmJ68gFzxzJ6KypKfaIlHH7d6DZBhWwyy6IHxkYspJlZxnDJy4qA4xCgyjW5OVUxZeu04X2ompEWlfU/mrQ24dkoevwmbG86GNYZowzwb8T0HS31vJV4rl9rGnT4hq9sB2F4PNh2uYbW0B3I4yoo+MpSjqq24TrnXOa1JGcOl5Uwq8az9B5dI5IOoc1ODaGD5+t06B2K9py10Z9+QDlqEoAP7T917QeNE8Q/xgGqrPjj4OUnU/FBI0zQH0U11+qT1w+GzwbDwbPBkDDETF0HBzeGr1jGhMPSPizHMHuXgs3zf0UeBhbJkvfaLHkGPqnVf0gHE7xnm8/wYZ0731c96eRz7VzXsqBMKXLT90WM31wf21Rj2sRz239AadcZWz7MzBJy3UulGfhC4tRBXVVUdtRGoXnajdUeDXPD09N1xlYPs7f6P8nel3R4i4e5+9HXtNp637+C1mcv1xmbP0zrn5uq27+Q2NMX6/YRZblB7jC9AVcTXayukt1adwGTG7EJGl+ENe0oCzTkcdy1V62pIUiqFl9t2/mJ1hK52mFoNioxPpqy3vUjxzImKxZzJF++9Qg9dtu4stENDS4LVXdwK34Ulvw9U+OY9eHttJVlcCa3i0EJ1heDlIYnfr8rW3sz/uQ4fpOEnnQr21RsbJM0iQQPDA7LSvrS8EJISXTT892H5j/v2jWSJALSc5k2fvipeB3iVL9hXLRZV4XoIvbhNVdN2W2zvAW3t40SeO1Yr+H2lk4VzRU9uut11g7QXhsD/l0NIwZzFDcbq5ohbBc2Y52lwZO5Ik8mDMTsZ5eA0AByVRu5XvfvqGF7Rh8ttztiimdHSP4/SMx3/Jzr2nzExfVRWi9cnhDhBMUOSIDDrPa5S0fmL+mgT4K05XihrDN1HsLbojapAyG19lRG52htPzYc9KAQNpRk59jFnwEqG5ZzmHLr0GRQK6EcGlNXFObe7Rba4N9vsKYIKrTKkIgeVpvNsjd1ToUun05jU7rsCTHGxqbozDc9F6nJaJv1rUN6yGAHm97Gc9GMUHeLVjZ4ncOTE/rfJiupXQzig0H5LSJgWku5+gPLPj6YvN/lDcO7n5H7fNj5BzH8ZZnfDN+Tpu45nXsRxCe3NpIapkhyvaaHzUcUHdkKJYXCqyS2q+HJydWAZLvO2Oku8Z3pEt3cNweQEBdGUytVJZFTa49ZAZ9xoYAeAPM7ShON0eb+F/nTKLtPCKcbQnh+VwhvlU+Q+pbCc32N6p/LaXd7F7YnUpel15UQLTIRgPw822C2Ox6YtJjXRrgVG13csmWPV6IX5kcXl+vLjJFgNaVgKm09xdzN2YgddzIyFs0NpVEIg1faRg8tVwVlr+64f7wSxzcDts62V+x0FvdCW8dnQs169666bJk8o4MIst5gtY1tK/EXpOA2SrILlTFBCjBHXpC3uM4Yne/3bTrq63RKKVG0K/fTsW1b2Zxtw7sjP5PSMxsZl90Jl8HzbqojJDN8fqJJT+zKODSMpxxCk0LoZAU6SYGLVleb+DuF3wMftw5PT32A9+XAR0LPXvog4/TF+nLD32Zs06f2+cJtz5CxTY/Hf3fe85Cg3nrf/Ksv1FT7Y46yb7pi6R7dDO4GZChzXTZtUQn81//+H78inZm/5n+Ad7WBSi/QTOvQWzWVuBT0hhPwlruPvJRorVwBPd0zakmGQsx8DSU9jDmv+ERIQYaBwHTIcnVsi+3Dj23A8MSEctINSrInILX2/a1OA6+dLv0e6fFbaHNNHcLUaAsTaolEa8EipiWo5tx3Gsdbk1HDMvXzkqtRGWERuCgJmFwenE5FLvyrqpUzPHdQcsVnSJtlPjAkKTRNzUZPqPRrtayDT0RtlYgusEjZe9uHN9Sj6hn32T10XEgsgjtkqfesoDyg19vYLzwhT7ai7UWOti1CS7xB461E8GdrKaHSZK0FlxQZdc+WEDnDlaVHNmYW49E04otOi9+j4Ks+UAqeHiCKdUgBpFDXobv3olGzH3FihcM2KF4sFncs1tPNNX8Sbl5PwGCl23UzP+jtW3d58/GUzAGa0r6bnqG5EXlyC/bseeyBj+MbxkP8lQwEr8QftxfQbZIiR2Wx8+K8+tP7b+AGnvVPWNax0R9B8PE3b19//d3Z14SXXpFw/wb9k/6Jz+Rp60quOludoZzCWXh5trLfzTN86P4/dP8fuv8P3f+H7v9D9/+h+//Q/X/o/j90/z8ung7d/4fu/0P3/6H7/9D9f+j+P3T/H7r/D93/h+7/Q/f/ofv/0P3vW8RiUZHswHEluVCdhohQgb5o/ybgMmNzKk6PLtjtLaV6f6DWHxr+uUZDle3LjN1wIyjX4evaWariUgHzGqmU+DqkbnrntHMWLp8vgWyV86kIHVa8ynOs3L2w3fr5+3dn5yxjqVer1AWtMXxBf9PAF2zE6Lnxf/nghenLttw3j0quZrWvqbKAl4rPvHbzzcr1ta9cxx+d0ixXqw6VmyXtwAr9S4ztXPDvVD/5C67+owEPM3sXRNkmaDq8y/V6/b9fCVqF",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Contact list",permalink:"/docs/API-docs/contactlist"},next:{title:"Draft Document",permalink:"/docs/API-docs/draftdocument"}},g={},j=[{value:"Request",id:"request",level:2}];function f(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(n.p,{children:"Self Sign"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/selfsign"}),"\n",(0,i.jsx)(n.p,{children:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app."}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"name", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job title:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"job title", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"company", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"date", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "name": "textbox",\n "required": true, \n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression":"",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(m.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(n.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded pdf"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Description"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Note"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"timeToCompleteDays",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"signer"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})})]})]})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"send_email",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"redirect_url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(l.Z,{children:[(0,i.jsxs)(m.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Document created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://url-to-sign-document.com"}})]})]})}),(0,i.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://url-to-sign-document.com"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(m.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(m.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/bbdfc22d.3855f22e.js b/assets/js/bbdfc22d.3855f22e.js new file mode 100644 index 000000000..1057f9dff --- /dev/null +++ b/assets/js/bbdfc22d.3855f22e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1531],{60877:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>j,contentTitle:()=>u,default:()=>b,frontMatter:()=>h,metadata:()=>x,toc:()=>g});var t=s(85893),i=s(11151),a=s(58219),l=(s(62316),s(51039)),r=s.n(l),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),m=s(9472),p=s(85162);const h={id:"createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",sidebar_label:"Create Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztW91yI7exfpXO3KxXNaRErrzew0qdOuufJJvY1pZXW66UpJLBmSYH1gwwBjCiaBXv8iR5tDzJqW4AM0OKlLS7Lkep8Ebi4Lf7Q6PR3WjcJk7MbTI5S06xqkvh0CYXaZKjzYysndQqmSSnBUKshq8MCiqH12/fgChLvbDQWDQWnIaMKhGyxjpdyV/FtERwceAUFoXMCrBorhGEhWnZYG2kchZm2sAcFRrhpJpDrrOmQqpYSFdAbTDHmVSYg3WmyVxj0A7hfa0V2CbL0NpZU7YzeTKkVim4AplQg64xyoKARslfGoSDg9j6UuYHB+AK4SATCqZI7OTETSAIe+RMBdVpxQPbGjM5k9Q4jDU8V+fqVNYTeF+XWuSw1I2Bt1//qR2CxqWys4ODr3HazOH9m4ODi88K52o7OTwUdT3UNSor56oUUzvMdHWYU8M6nz0nBNEgjcq0orCyXILIc1jIfI7OMscKMl0vIdPa5FJ56GsxR1BNNUVjUxAqh0obBKlAgEGRLwdODxqL8Nd3J9/TclTCDeFt2di0nS6XBjNXLv3whEDk6plH5uUxrY9U8xQqcUULKR380sjsiti2qBjWsCaM1cHBu6autXGYw4+ehcnBAdV8iaVegDDI7TNdVVpBLYyo0LG00YJRtcFfGmkw96IiyjJiMaFhBrTSyxonBwfwRuUyIzh4SCoFPQuth74pwURN34Wl9U174NHaezEmVBbCr2hdiswTapCkwslrXB/4JoUlDfw1Kh0pKLSRv2rlRMkLco3GyUyU/YUjAlnUnDC8M2otlYulYQb4e1ggWj9eliBZRFpOcFVScY1FuBZlgzZQtUihIKp+wNqgZQkP4xKUKocC5bzYOZ/If26sWxsYGktk9qkIc8V1YniRYZuJ0iLI2RqWlbjC3mygWQ2JcghfLiHHmWhKl4IkmXOmwSF8rx2Iui5lxvqGVAltH0FaYsCrHAQiEKJExWv81uhrmSMphVzOZmhoe1IlDxH6ROpI0mruQOzx3nGFUKDVxkJnutSGht+QIS5fBxIyrRwqN4TX10KWTL3n1oJUWdnkCNNSZFcpq8oUDOZ+7y6RFG/qRZ6bkD71oDNAYLEkMdSKGFA6TC9tp7SGp4W03Y6iugg1zyFtH9Wwb2eaJiYI4iYDrIQsUwYuhZ/1FJx0Jaa0ZWuhlinkwmEKDm/cVN+kkBWYXfEvI3KpYdo4R6qa5syNrnO9UAHLmVbOyl+37MhY8+GAjlM4TuFlCq9SGB2lMBqnMDpOYfQyhdGrFMZHKYzHKYyPUxi/9GSNXwWoRYtvn4DR2IPseuDC00aXNO+30vLOJpVpWy28WNPC52o0hIODdj9x8U8//XSubs8VwHlC++s8mZwnbZPzJAVfR2rzPJmMUggFN+fJBF6Mv4gNlvT9ktD13wv6HtFq+O+Cvsejc7UKk46ZGCeq+h5CqPq3JyJ+BnmiQp6ZyqJqo0LSSb4t1dC6UWlLFlWsOoZeEENSSSdFaXfzFFs8PbY6yjY4OybOWHp3s8XVT4+nSFasYd3pq1jX9qqiGmBCxhsQfD7sTpsdCPhJnxoAgapP5f8l8d/qrN0gtE2eHhJ90j4Vji+GbB6w3t4NRmjw9KDoCPtUIF4REHRu7UaBap8eBIGqWBFsAV93dDwYfT4YH42P12AgP8o3qKpBng+Wy+UnQggMGJlHYX42NoMx621A8llnRldbPBV2JLpWwXzi39G6/45s+mk0dzEnJ3Hd3Y3uYd8gdzoXy2fWDxW7tnYcte+suGWPTK4iOthVzgots0A8tYnW25S8wSGBMCDg88PvvjvsQekLB1UV8YVYSt8Dhr5fWlXDPB9utl1boV5pBXmewpby7RV5DlVV7Sr3FXRcnqv/GXIcgk233XshNPh9tsMWqe/m37lXugqRa1Xy/Ozcbd8rG+dLIVWoCHIDGw0MzptSGLwhL9VKrRiX30ATbeyiuIk6M5+dWvYHOWTgkYDPToIp/zwIOHGwPgCVPNzvDmP9QQzO8YbH8PE0IkbmIbBlm6wgn09Ej4Fg7wI8/JWJWlJwoUTnuBRdNtxGhF+0nmNOi7rpl1t0a8wIC7HnFtecV58djdERn3vBL7nn4Astnp7a71EWK32wg6rPzpNKBNMlmWH3W7sCzXly0fbxLjnmvb6wrTNc3LOfoNs0OZZiiuXdvfbo3dBnJ0hWDxyqqKRqIwlM8lGkgGvFzUZtqFxt2Wee7b6AR+Uet0nEGUppYzhlHbR+7xBv4jigQh+xnSLEDjBtRfKTRb4l7HEy7zVCWJ4HpqB2wA3bWF+c7YEZ1pamDwyNUUklq6Zqg5azdtQIWRVO+T5e1JNi+XGG/vLemUHcPDBDiKbvmOBcjTi0EIMSrBhguzEYmjw9zdCj7OEj8GN0xtqx+bEH3ofvxMhXfyduOSepqT8h211od2/DIZzQqUQRU9+JYmBZhrWjeNmn7tGW5Mft0RGHkvoxst0nU7/V7y2Du4TpMdK5QfdvJoeh3acZX4Ta44Sxz8Z/kECukf1oY8kHBCt/DbUrGlix6D01ZRjI2jj6kzTRNd/ravUmTyaJvyOON6ZJymOjdV/qfJlMbpMQw6efIUJOXQ9/tnQXfZvYrMBK0K9IE91ez2RJQ1EQGo1N0oSDNnSVTaglk0RPf8bMJSm5GDVdtKGlMbjf5Da28reXSRoc92SS+GvNJE3wRlQ1NQ5FgCrT5B3zEKs4431jtSXdWJZ/tPfHNA7dD37kMNx1tXF9/1Ej9UdYdbh2gwljxDLZzBSIF4PRj/P92puPchk3i3S0JdrLKm6WpIl0WPVn2bFqRn840hlq4oRjux/al5dFVB88J/WrC60+qmO4iNmC+SNR8rV3J15fstfkQGIezelBd3eaAt9ZDB+SmNieuRXz/pzeOLwz5+muO/XeVZ4tdFPmdEmGwgz5avuj8yY4NUWUWcPZIe0hscZZS2rL2WiVJjcPM3MDmR7EC3v4rMSZg6au0UCmjULzvB+KezLMjY+PV2myfJi95X8ke1/Q4i0e5u5HznToskD+HbS+eLVKk+JhWv/S5mL8G4k9frnqzrqNs/xyqvPlZdRbq4caxkOF2lFu0Bt1YnI0PSCmWpco1B0k3sy8laXhGRkjz0K8i6/QpbHxQIGFLEswmCGl43AIO+oqCEaHv1+HcItJxtk3VMBGo22mllqpOJ71A04RnJHzOVLSUWjBnUOSAApOcqM0HaJKzOj+n9OIDF5L3dhIXiEs3+OXSHapK1D6zBWp5utGYg8dTuHo8z7srw6V0CGnKKvg5PTtI7BkE3YArmgzFDyXfgw4OX1LiUlyFuywIby3LRIRWrHWBMgugmspYvJCq9uXPuqAihHRzOxaHtkwpAQN4C5BubRbKUq7GGibh3hn4C53jZZIN46S5mTIx7AOa7uGI1PRAnmqm8dI5QNICpg3fJ3iaMvGLCWOy3aJRVL5BEd2gPLGxFyqIBbUkrIdO5wiKtSoN34KqKzvLmAmrEOTUuojIW8acnDaIfGmRiNRZbgVAoMeusvGbLWb1jFYz9J5/8O3IWMx8hA35ZR2oB8Yc2hqlhreCW32WFy5TdbvGEosZZe0R9Bc7jLT1snkLC9twu4PcbcajdWKirWZCyV/9dIckj2nWIhyxtq3vVSjpDCaN9JMo63TF9Xvv/7xTyKVJfWy0nkrvfbxgvWW8vicbZWR05z5iSX63NR4JdAqOZtGxWaDLUc3A4Yj+MyWrokfvJHW9ZKO4n3f3U35AxKeWY8GPvtpK5GgqWV/V7V0heSmbjhOjZLr+Wrt2bMhgPefIf6Q6RzBoP8oCVMr683g8dER/duwQNdShWk3tGnE5fIPSfp4L/R+G9wXk997VyQ7KfmyGP/F1qrKChKSCq1dN6O3dHmAgT5uUpVS4WUE5XJ8dHT5OSG3SpPjbeC80xW6giWCNuDCaMrorUsUlF9qliDmQiqg6c1viBUao839XH8YZfeBcHx0dDlqQfj8LghvFF+KcPb4qb5C9fty2p/e+emJ1JuKlbDXcon0jbg+WWO2X+6ZtJg1RrplMjm7TW4GopYDXz85u1hdkNS5QlN8ptaWKRauSCbJ4Z1wDafvUyzg7DbhMyGJ9qYVKqd7izs2p6jl4fUoWaWbPbZaqDtbWyfmUs0H9/a66Fh9R8vhEV9juHOoa/k3JI864NlvlSaSxKBAQTYpIUir/EMXq/omrlWMIm0NDHWLshnqiZGeteDNpurfEo7pRWPOYiiEoxttcCPpOEraAAT9bEMKZ53otd57dN5H7PWOj4/ZPfxixH7Ui1fsohy/XF14hHvmOscD+zanj1SvGU+haN2YSJKth/faobnjzIzWiVQzzQsaQD6pUb0j44/2zfXorr+HZaarNuE2Nv/XP/7JPeIZxdP8AU4aA7VeoKHXJZRBOyvxRpK51Xv8QoYAh31FVaK1FONSDuf+4Yic8w18tGEyUYupLCUpAmqmfdZLT5fYIfxYIIXfqeqZ8ckI11iS/oBSa35WQUd/43TVf5wCC22uZkRSCgKmlIePlpwFjF1QFUJlZLL4/cHGAD0jIauwNtIiCFlRY7JOcTaTmaSBSesZkTmohBJzPtVT9jsJhTpm0Rs9JePe6rLx5ivl8iM6zyKH4ofwNbkLzDgV5uiELDH3lqtNvecQlGB4pjIlL62m6WWGtkthKvEaDesD7/c1ZQm1dt4XI7Omv7Y0kDNCWfJsPUFxaVr4gn3Jc+RiOQSKx9OBQ24FCUAp1RU9KhnAWStmP+LUSoedz71YLO7opufrff4sXdFMwWCtu35zLmRN1u/efjwnTYKmsiezd2iuZYZBMe6Y85AbH4YzS2R8ZkX9IGr5f5sd6PwoZYbKYu+Eef3nt9/CNbwYHiVpTxs/guDDb9989c33776hcem88PtvNDwaHnGgUFtXCdWb6iv/duy0048bYez28N0/SNs/SNs/SNs/SNs/SNs/SNs/SNs/SNs/SNs/SNs/SNs/SHuQ//2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP+OB2kh94UMx8O6FJKTp0J+q897Ott8pnaRJgUlRk3Okttbulp8b8rViop/adBQVtVFmlwLIyl8zjlVacwdomybK1zSFbe/DRic0vypl3u+jt9IJaPUJ9/jNa/+vW37uVtvT96dJmkyDU/pKp1THyMW9MxOLJJJQkqbn+S1yadcfpuUQs0bTgBK/LiU8iQaV6znS11xvlT40csjEmrZo3I9kcqzQn+Jsa0d/kh34n/D5f+2zX3Nzg4B29ialvBitVr9PwFbmLw=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",source:"@site/docs/API-docs/createtemplate.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createtemplate",permalink:"/docs/API-docs/createtemplate",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",sidebar_label:"Create Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztW91yI7exfpXO3KxXNaRErrzew0qdOuufJJvY1pZXW66UpJLBmSYH1gwwBjCiaBXv8iR5tDzJqW4AM0OKlLS7Lkep8Ebi4Lf7Q6PR3WjcJk7MbTI5S06xqkvh0CYXaZKjzYysndQqmSSnBUKshq8MCiqH12/fgChLvbDQWDQWnIaMKhGyxjpdyV/FtERwceAUFoXMCrBorhGEhWnZYG2kchZm2sAcFRrhpJpDrrOmQqpYSFdAbTDHmVSYg3WmyVxj0A7hfa0V2CbL0NpZU7YzeTKkVim4AplQg64xyoKARslfGoSDg9j6UuYHB+AK4SATCqZI7OTETSAIe+RMBdVpxQPbGjM5k9Q4jDU8V+fqVNYTeF+XWuSw1I2Bt1//qR2CxqWys4ODr3HazOH9m4ODi88K52o7OTwUdT3UNSor56oUUzvMdHWYU8M6nz0nBNEgjcq0orCyXILIc1jIfI7OMscKMl0vIdPa5FJ56GsxR1BNNUVjUxAqh0obBKlAgEGRLwdODxqL8Nd3J9/TclTCDeFt2di0nS6XBjNXLv3whEDk6plH5uUxrY9U8xQqcUULKR380sjsiti2qBjWsCaM1cHBu6autXGYw4+ehcnBAdV8iaVegDDI7TNdVVpBLYyo0LG00YJRtcFfGmkw96IiyjJiMaFhBrTSyxonBwfwRuUyIzh4SCoFPQuth74pwURN34Wl9U174NHaezEmVBbCr2hdiswTapCkwslrXB/4JoUlDfw1Kh0pKLSRv2rlRMkLco3GyUyU/YUjAlnUnDC8M2otlYulYQb4e1ggWj9eliBZRFpOcFVScY1FuBZlgzZQtUihIKp+wNqgZQkP4xKUKocC5bzYOZ/If26sWxsYGktk9qkIc8V1YniRYZuJ0iLI2RqWlbjC3mygWQ2JcghfLiHHmWhKl4IkmXOmwSF8rx2Iui5lxvqGVAltH0FaYsCrHAQiEKJExWv81uhrmSMphVzOZmhoe1IlDxH6ROpI0mruQOzx3nGFUKDVxkJnutSGht+QIS5fBxIyrRwqN4TX10KWTL3n1oJUWdnkCNNSZFcpq8oUDOZ+7y6RFG/qRZ6bkD71oDNAYLEkMdSKGFA6TC9tp7SGp4W03Y6iugg1zyFtH9Wwb2eaJiYI4iYDrIQsUwYuhZ/1FJx0Jaa0ZWuhlinkwmEKDm/cVN+kkBWYXfEvI3KpYdo4R6qa5syNrnO9UAHLmVbOyl+37MhY8+GAjlM4TuFlCq9SGB2lMBqnMDpOYfQyhdGrFMZHKYzHKYyPUxi/9GSNXwWoRYtvn4DR2IPseuDC00aXNO+30vLOJpVpWy28WNPC52o0hIODdj9x8U8//XSubs8VwHlC++s8mZwnbZPzJAVfR2rzPJmMUggFN+fJBF6Mv4gNlvT9ktD13wv6HtFq+O+Cvsejc7UKk46ZGCeq+h5CqPq3JyJ+BnmiQp6ZyqJqo0LSSb4t1dC6UWlLFlWsOoZeEENSSSdFaXfzFFs8PbY6yjY4OybOWHp3s8XVT4+nSFasYd3pq1jX9qqiGmBCxhsQfD7sTpsdCPhJnxoAgapP5f8l8d/qrN0gtE2eHhJ90j4Vji+GbB6w3t4NRmjw9KDoCPtUIF4REHRu7UaBap8eBIGqWBFsAV93dDwYfT4YH42P12AgP8o3qKpBng+Wy+UnQggMGJlHYX42NoMx621A8llnRldbPBV2JLpWwXzi39G6/45s+mk0dzEnJ3Hd3Y3uYd8gdzoXy2fWDxW7tnYcte+suGWPTK4iOthVzgots0A8tYnW25S8wSGBMCDg88PvvjvsQekLB1UV8YVYSt8Dhr5fWlXDPB9utl1boV5pBXmewpby7RV5DlVV7Sr3FXRcnqv/GXIcgk233XshNPh9tsMWqe/m37lXugqRa1Xy/Ozcbd8rG+dLIVWoCHIDGw0MzptSGLwhL9VKrRiX30ATbeyiuIk6M5+dWvYHOWTgkYDPToIp/zwIOHGwPgCVPNzvDmP9QQzO8YbH8PE0IkbmIbBlm6wgn09Ej4Fg7wI8/JWJWlJwoUTnuBRdNtxGhF+0nmNOi7rpl1t0a8wIC7HnFtecV58djdERn3vBL7nn4Astnp7a71EWK32wg6rPzpNKBNMlmWH3W7sCzXly0fbxLjnmvb6wrTNc3LOfoNs0OZZiiuXdvfbo3dBnJ0hWDxyqqKRqIwlM8lGkgGvFzUZtqFxt2Wee7b6AR+Uet0nEGUppYzhlHbR+7xBv4jigQh+xnSLEDjBtRfKTRb4l7HEy7zVCWJ4HpqB2wA3bWF+c7YEZ1pamDwyNUUklq6Zqg5azdtQIWRVO+T5e1JNi+XGG/vLemUHcPDBDiKbvmOBcjTi0EIMSrBhguzEYmjw9zdCj7OEj8GN0xtqx+bEH3ofvxMhXfyduOSepqT8h211od2/DIZzQqUQRU9+JYmBZhrWjeNmn7tGW5Mft0RGHkvoxst0nU7/V7y2Du4TpMdK5QfdvJoeh3acZX4Ta44Sxz8Z/kECukf1oY8kHBCt/DbUrGlix6D01ZRjI2jj6kzTRNd/ravUmTyaJvyOON6ZJymOjdV/qfJlMbpMQw6efIUJOXQ9/tnQXfZvYrMBK0K9IE91ez2RJQ1EQGo1N0oSDNnSVTaglk0RPf8bMJSm5GDVdtKGlMbjf5Da28reXSRoc92SS+GvNJE3wRlQ1NQ5FgCrT5B3zEKs4431jtSXdWJZ/tPfHNA7dD37kMNx1tXF9/1Ej9UdYdbh2gwljxDLZzBSIF4PRj/P92puPchk3i3S0JdrLKm6WpIl0WPVn2bFqRn840hlq4oRjux/al5dFVB88J/WrC60+qmO4iNmC+SNR8rV3J15fstfkQGIezelBd3eaAt9ZDB+SmNieuRXz/pzeOLwz5+muO/XeVZ4tdFPmdEmGwgz5avuj8yY4NUWUWcPZIe0hscZZS2rL2WiVJjcPM3MDmR7EC3v4rMSZg6au0UCmjULzvB+KezLMjY+PV2myfJi95X8ke1/Q4i0e5u5HznToskD+HbS+eLVKk+JhWv/S5mL8G4k9frnqzrqNs/xyqvPlZdRbq4caxkOF2lFu0Bt1YnI0PSCmWpco1B0k3sy8laXhGRkjz0K8i6/QpbHxQIGFLEswmCGl43AIO+oqCEaHv1+HcItJxtk3VMBGo22mllqpOJ71A04RnJHzOVLSUWjBnUOSAApOcqM0HaJKzOj+n9OIDF5L3dhIXiEs3+OXSHapK1D6zBWp5utGYg8dTuHo8z7srw6V0CGnKKvg5PTtI7BkE3YArmgzFDyXfgw4OX1LiUlyFuywIby3LRIRWrHWBMgugmspYvJCq9uXPuqAihHRzOxaHtkwpAQN4C5BubRbKUq7GGibh3hn4C53jZZIN46S5mTIx7AOa7uGI1PRAnmqm8dI5QNICpg3fJ3iaMvGLCWOy3aJRVL5BEd2gPLGxFyqIBbUkrIdO5wiKtSoN34KqKzvLmAmrEOTUuojIW8acnDaIfGmRiNRZbgVAoMeusvGbLWb1jFYz9J5/8O3IWMx8hA35ZR2oB8Yc2hqlhreCW32WFy5TdbvGEosZZe0R9Bc7jLT1snkLC9twu4PcbcajdWKirWZCyV/9dIckj2nWIhyxtq3vVSjpDCaN9JMo63TF9Xvv/7xTyKVJfWy0nkrvfbxgvWW8vicbZWR05z5iSX63NR4JdAqOZtGxWaDLUc3A4Yj+MyWrokfvJHW9ZKO4n3f3U35AxKeWY8GPvtpK5GgqWV/V7V0heSmbjhOjZLr+Wrt2bMhgPefIf6Q6RzBoP8oCVMr683g8dER/duwQNdShWk3tGnE5fIPSfp4L/R+G9wXk997VyQ7KfmyGP/F1qrKChKSCq1dN6O3dHmAgT5uUpVS4WUE5XJ8dHT5OSG3SpPjbeC80xW6giWCNuDCaMrorUsUlF9qliDmQiqg6c1viBUao839XH8YZfeBcHx0dDlqQfj8LghvFF+KcPb4qb5C9fty2p/e+emJ1JuKlbDXcon0jbg+WWO2X+6ZtJg1RrplMjm7TW4GopYDXz85u1hdkNS5QlN8ptaWKRauSCbJ4Z1wDafvUyzg7DbhMyGJ9qYVKqd7izs2p6jl4fUoWaWbPbZaqDtbWyfmUs0H9/a66Fh9R8vhEV9juHOoa/k3JI864NlvlSaSxKBAQTYpIUir/EMXq/omrlWMIm0NDHWLshnqiZGeteDNpurfEo7pRWPOYiiEoxttcCPpOEraAAT9bEMKZ53otd57dN5H7PWOj4/ZPfxixH7Ui1fsohy/XF14hHvmOscD+zanj1SvGU+haN2YSJKth/faobnjzIzWiVQzzQsaQD6pUb0j44/2zfXorr+HZaarNuE2Nv/XP/7JPeIZxdP8AU4aA7VeoKHXJZRBOyvxRpK51Xv8QoYAh31FVaK1FONSDuf+4Yic8w18tGEyUYupLCUpAmqmfdZLT5fYIfxYIIXfqeqZ8ckI11iS/oBSa35WQUd/43TVf5wCC22uZkRSCgKmlIePlpwFjF1QFUJlZLL4/cHGAD0jIauwNtIiCFlRY7JOcTaTmaSBSesZkTmohBJzPtVT9jsJhTpm0Rs9JePe6rLx5ivl8iM6zyKH4ofwNbkLzDgV5uiELDH3lqtNvecQlGB4pjIlL62m6WWGtkthKvEaDesD7/c1ZQm1dt4XI7Omv7Y0kDNCWfJsPUFxaVr4gn3Jc+RiOQSKx9OBQ24FCUAp1RU9KhnAWStmP+LUSoedz71YLO7opufrff4sXdFMwWCtu35zLmRN1u/efjwnTYKmsiezd2iuZYZBMe6Y85AbH4YzS2R8ZkX9IGr5f5sd6PwoZYbKYu+Eef3nt9/CNbwYHiVpTxs/guDDb9989c33776hcem88PtvNDwaHnGgUFtXCdWb6iv/duy0048bYez28N0/SNs/SNs/SNs/SNs/SNs/SNs/SNs/SNs/SNs/SNs/SNs/SHuQ//2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP+OB2kh94UMx8O6FJKTp0J+q897Ott8pnaRJgUlRk3Okttbulp8b8rViop/adBQVtVFmlwLIyl8zjlVacwdomybK1zSFbe/DRic0vypl3u+jt9IJaPUJ9/jNa/+vW37uVtvT96dJmkyDU/pKp1THyMW9MxOLJJJQkqbn+S1yadcfpuUQs0bTgBK/LiU8iQaV6znS11xvlT40csjEmrZo3I9kcqzQn+Jsa0d/kh34n/D5f+2zX3Nzg4B29ialvBitVr9PwFbmLw=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Draft Template",permalink:"/docs/API-docs/drafttemplate"},next:{title:"Get Template",permalink:"/docs/API-docs/get-template"}},j={},g=[{value:"Request",id:"request",level:2}];function f(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,i.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(n.p,{children:"Create Template"})}),"\n",(0,t.jsx)(r(),{method:"post",path:"/createtemplate"}),"\n",(0,t.jsxs)(n.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,t.jsx)(n.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,t.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,t.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,t.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,t.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified.This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,t.jsxs)(n.ol,{start:"2",children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,t.jsxs)(n.ol,{start:"3",children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,t.jsxs)(n.ol,{start:"4",children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,t.jsxs)(n.ol,{start:"5",children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.strong,{children:"name:"})}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:'{\n "type":"name", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,t.jsxs)(n.ol,{start:"6",children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.strong,{children:"job title:"})}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:'{\n "type":"job title", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,t.jsxs)(n.ol,{start:"7",children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.strong,{children:"company:"})}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:'{\n "type":"company", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,t.jsxs)(n.ol,{start:"8",children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.strong,{children:"date:"})}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:'{\n "type":"date", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,t.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,t.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,t.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,t.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,t.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,t.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,t.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,t.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,t.jsxs)(n.ol,{start:"9",children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": { \n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression":"",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,t.jsxs)(n.ol,{start:"10",children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0, \n "maxselections": 0 \n }\n }\n}\n'})}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,t.jsxs)(n.ol,{start:"11",children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:'{\n "type":"dropdown", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,t.jsxs)(n.ol,{start:"12",children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:'{\n "type":"radio button", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "readonly": false,\n "required": true, \n "name": "radio button",\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,t.jsxs)(n.ol,{start:"13",children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n}\n'})}),"\n",(0,t.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,t.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,t.jsx)(n.p,{children:"Body"})}),(0,t.jsx)("strong",{className:"openapi-schema__required",children:(0,t.jsx)(n.p,{children:"required"})})]}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded file"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample note"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample description"}}),(0,t.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsxs)("span",{className:"openapi-schema__container",children:[(0,t.jsx)("strong",{className:"openapi-schema__property",children:(0,t.jsx)(n.p,{children:"signers"})}),(0,t.jsx)("span",{className:"openapi-schema__name",children:(0,t.jsx)(n.p,{children:"object[]"})}),(0,t.jsx)("span",{className:"openapi-schema__divider"}),(0,t.jsx)("span",{className:"openapi-schema__required",children:(0,t.jsx)(n.p,{children:"required"})})]})}),(0,t.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,t.jsx)("div",{style:{marginTop:".5rem",marginBottom:".5rem"},children:(0,t.jsx)(n.p,{children:"You can provide signer optionally if you it as default signer"})}),(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,t.jsx)(n.p,{children:"Array ["})})}),(0,t.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,t.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsxs)("span",{className:"openapi-schema__container",children:[(0,t.jsx)("strong",{className:"openapi-schema__property",children:(0,t.jsx)(n.p,{children:"widgets"})}),(0,t.jsx)("span",{className:"openapi-schema__name",children:(0,t.jsx)(n.p,{children:"object[]"})})]})}),(0,t.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,t.jsx)(n.p,{children:"Array ["})})}),(0,t.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,t.jsx)(n.p,{children:"]"})})})]})]})}),(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,t.jsx)(n.p,{children:"]"})})})]})]})}),(0,t.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"redirect_url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"email_sender_name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"name or email of the person or organization on the behalf of which you are sending the mail.",example:"opensign\u2122"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}})]})]})})}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(a.Z,{children:[(0,t.jsxs)(p.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(n.p,{children:"Template created successfully!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(n.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bh2Hspnmch"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template created successfully!"}})]})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "objectId": "Bh2Hspnmch",\n "message": "Template created successfully!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(p.default,{label:"400",value:"400",children:[(0,t.jsx)("div",{children:(0,t.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(n.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(p.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(n.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(n.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/bbdfc22d.c296f0c4.js b/assets/js/bbdfc22d.c296f0c4.js deleted file mode 100644 index c8d78f79e..000000000 --- a/assets/js/bbdfc22d.c296f0c4.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1531],{60877:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>j,contentTitle:()=>u,default:()=>f,frontMatter:()=>h,metadata:()=>x,toc:()=>g});var i=s(85893),a=s(11151),t=s(58219),l=(s(62316),s(51039)),r=s.n(l),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),m=s(9472),p=s(85162);const h={id:"createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",sidebar_label:"Create Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztW91yGzeyfpXeuXGsGlIirThe1qlTx/k5G+8mkSqWK3VKUingTJODaAaYABhRjIp3+yT7aPskW90AZoYUacl2KqutwxuJg9/uD41Gd6Nxlzgxt8nkPDnDqi6FQ5tcpkmONjOydlKrZJKcFQixGr4yKKgcXp++AVGWemGhsWgsOA0ZVSJkjXW6kr+JaYng4sApLAqZFWDR3CAIC9OywdpI5SzMtIE5KjTCSTWHXGdNhVSxkK6A2mCOM6kwB+tMk7nGoB3Cu1orsE2WobWzpmxn8mRIrVJwBTKhBl1jlAUBjZK/NggHB7H1lcwPDsAVwkEmFEyR2MmJm0AQ9siZCqrTige2NWZyJqlxGGt4oS7Umawn8K4utchhqRsDp1//bzsEjUtl5wcHX+O0mcO7NwcHl58VztV2cngo6nqoa1RWzlUppnaY6eowp4Z1PntOCKJBGpVpRWFluQSR57CQ+RydZY4VZLpeQqa1yaXy0NdijqCaaorGpiBUDpU2CFKBAIMiXw6cHjQW4a9vT36g5aiEG8Jp2di0nS6XBjNXLv3whEDk6plH5uUxrY9U8xQqcU0LKR382sjsmti2qBjWsCaM1cHB26autXGYw0+ehcnBAdV8iaVegDDI7TNdVVpBLYyo0LG00YJRtcFfG2kw96IiyjJiMaFhBrTSyxonBwfwRuUyIzh4SCoFPQuth74pwURN34al9U174NHaezEmVBbCr2hdiswTapCkwskbXB/4NoUlDfw1Kh0pKLSRv2nlRMkLcoPGyUyU/YUjAlnUnDC8M2otlYulYQb4v7BAtH68LEGyiLSc4Kqk4hqLcCPKBm2gapFCQVT9iLVByxIexiUoVQ4Fynmxcz6R/9JYtzYwNJbI7FMR5orrxPAiwzYTpUWQszUsK3GNvdlAsxoS5RC+XEKOM9GULgVJMudMg0P4QTsQdV3KjPUNqRLaPoK0xIBXOQhEIESJitf41OgbmSMphVzOZmhoe1IlDxH6ROpI0mruQOzx3nGFUKDVxkJnutSGht+QIS5fBxIyrRwqN4TXN0KWTL3n1oJUWdnkCNNSZNcpq8oUDOZ+7y6RFG/qRZ6bkD71oDNAYLEkMdSKGFA6TC9tp7SGZ4W03Y6iugg1zyFtH9Wwb2eaJiYI4iYDrIQsUwYuhV/0FJx0Jaa0ZWuhlinkwmEKDm/dVN+mkBWYXfMvI3KpYdo4R6qa5syNrnO9UAHLmVbOyt+27MhY8+GAjlM4TuFlCq9SGB2lMBqnMDpOYfQyhdGrFMZHKYzHKYyPUxi/9GSNXwWoRYtvn4DR2IPseuDC00aXNO930vLOJpVpWy28WNPCF2o0hIODdj9x8c8//3yh7i4UwEVC++simVwkbZOLJAVfR2rzIpmMUggFtxfJBF6Mv4gNlvT9ktD13wv6HtFq+O+CvsejC7UKk46ZGCeq+j2EUPXvT0T8DPJEhTwzlUXVRoWkk3xbqqF1o9KWLKpYdQy9IIakkk6K0u7mKbZ4emx1lG1wdkycsfTuZournx5PkaxYw7rTV7Gu7VVFNcCEjDcg+HzYnTY7EPCTPjUAAlWfyv9L4r/VWbtBaJs8PST6pH0qHF8M2Txgvb0bjNDg6UHREfapQLwiIOjc2o0C1T49CAJVsSLYAr7u6Hgw+nwwPhofr8FAfpRvUFWDPB8sl8tPhBAYMDKPwvxsbAZj1tuA5LPOjK62eCrsSHStgvnEv6N1/z3Z9NNo7mJOTuK6uxvdw75B7nQuls+sHyp2be04at9ZccsemVxFdLCrnBVaZoF4ahOttyl5g0MCYUDA54fff3/Yg9IXDqoq4guxlL4HDH2/tKqGeT7cbLu2Qr3SCvI8hS3l2yvyHKqq2lXuK+i4vFB/HnIcgk233XshNPhjtsMWqe/m37lXugqRa1Xy/Ozcbd8rG+dLIVWoCHIDGw0MzptSGLwlL9VKrRiX30ETbeyiuIk6M5+dWvYHOWTgkYDPToIp/zwIOHGwPgCVPNzvHmP9QQzO8ZbH8PE0IkbmIbBlm6wgn09Ej4Fg7wI8/JWJWlJwoUTnuBRdNtxGhF+0nmNOi7rpl1t0a8wIC7HnFtecV58djdERn3vBL3nPwRdaPD2136MsVvpgB1WfXySVCKZLMsPut3YFmovksu3jXXLMe31hW2e4fM9+gm7T5FiKKZb399qjd0OfnSBZPXCoopKqjSQwyUeRAq4Vtxu1oXK1ZZ95tvsCHpV73CYRZyiljeGUddD6vUO8ieOACn3EdooQO8C0FclPFvmWsMfJvNcIYXkemILaATdsY31xtgdmWFuaPjA0RiWVrJqqDVrO2lEjZFU45ft4UU+K5ccZ+st7bwZx+8AMIZq+Y4ILNeLQQgxKsGKA7cZgaPL0NEOPsoePwI/RGWvH5sceeB++EyNf/Z245Zykpv6EbHeh3b0Nh3BCpxJFTH0nioFlGdaO4mWfukdbkh+3R0ccSurHyHafTP1Wf7QM7hKmx0jnBt2/mxyGdp9mfBFqjxPGPhv/QQK5RvajjSUfEKz8NdSuaGDFovfUlGEga+PoT9JE13yvq9WbPJkk/o443pgmKY+N1n2p82UyuUtCDJ9+hgg5dT38xdJd9F1iswIrQb8iTXR7PZMlDUVBaDQ2SRMO2tBVNqGWTBI9/QUzl6TkYtR00YaWxuB+k7vYyt9eJmlw3JNJ4q81kzTBW1HV1DgUAapMk3fMQ6zijO8bqy3pxrL8o70/pnHofvAjh+Guq43r+48aqT/CqsO1G0wYI5bJZqZAvBiMfpzv1958lMu4WaSjLdFeVnGzJE2kw6o/y45VM/rDkc5QEycc2/3QvrwsovrgOalfXWj1UR3DRcwWzB+Jkq+9P/H6kr0mBxLzaE4PurvTFPjOYviQxMT2zK2Y9+f0xuG9Oc923an3rvJsoZsyp0syFGbIV9sfnTfBqSmizBrODmkPiTXOWlJbzkarNLl9mJlbyPQgXtjDZyXOHDR1jQYybRSa5/1Q3JNhbnx8vEqT5cPsLf8j2fuCFm/xMHc/caZDlwXy76D1xatVmhQP0/ptm4vxbyT2+OWqO+s2zvKrqc6XV1FvrR5qGA8Vake5QW/UicnR9ICYal2iUPeQeDPzVpaGZ2SMPAvxLr5Cl8bGAwUWsizBYIaUjsMh7KirIBgd/n4dwi0mGWffUAEbjbaZWmql4njWDzhFcEbO50hJR6EFdw5JAig4yY3SdIgqMaP7f04jMngjdWMjeYWwfI9fItmlrkDpM1ekmq8biT10OIWjz/uwvzpUQoecoqyCk7PTR2DJJuwAXNFmKHgu/RhwcnZKiUlyFuywIbyzLRIRWrHWBMgughspYvJCq9uXPuqAihHRzOxaHtkwpAQN4D5BubRbKUq7GGibh3hv4C53jZZIN46S5mTIx7AOa7uGI1PRAnmmm8dI5QNICpg3fJ3iaMvGLCWOy3aJRVL5BEd2gPLGxFyqIBbUkrIdO5wiKtSoN34KqKzvLmAmrEOTUuojIW8acnDaIfG2RiNRZbgVAoMeuqvGbLWb1jFYz9J59+N3IWMx8hA35ZR2oB8Yc2hqlhreCW32WFy5TdbvGUosZVe0R9Bc7TLT1snkLC9twu4PcbcajdWKirWZCyV/89Ickj2nWIhyxtq3vVSjpDCaN9JMo63TF9XvP//+DyKVJfWq0nkrvfbxgnVKeXzOtsrIac78xBJ9bmq8EmiVnE2jYrPBlqObAcMRfGZL18QP3krreklH8b7v/qb8EQnPrEcDn/20lUjQ1LK/q1q6QnJTNxynRsn1fLX27NkQwPefIf6Q6RzBoP8oCVMr683g8dER/duwQNdShWk3tGnE5fJPSfp4L/T9NrgvJr/3vkh2UvJlMf7W1qrKChKSCq1dN6O3dHmAgT5uUpVS4VUE5Wp8dHT1OSG3SpPjbeC81RW6giWCNuDCaMrorUsUlF9qliDmQiqg6c3viBUao837uf4wyt4HwvHR0dWoBeHz+yC8UXwpwtnjZ/oa1R/LaX9656cnUm8rVsJeyyXSN+L6ZI3Zfrln0mLWGOmWyeT8LrkdiFoOfP3k/HJ1SVLnCk3xmVpbpli4Ipkkh/fCNZy+T7GA83tysxBkFX3bTJns143T8L3Orj1vfH4k0Ta9kcb5kYbWdyuaKRuop0aQEP8gbq6FOSQFejgaHg2PklV6tzGIFSqni5J7Rq6o5eHNaEuPrSbxztbWiblU88F7e1122L6l9fdLvIZw58HX8m9ILnxYwH6rNJEEYoGCjGBaMhKrH7vg2DdROGLYamskqpOCzdhSDC2tRYs2z5ot8Z9e+Oc8xl44nNJGU5KOo6SNeNDPNoZx3sl6Gy6I0YIRu9nj42P2R78YseP24hX7RMcvV5ce4Z5/wAHIvpHrQ+Nr1looWrdekmSrtbB2Su84pKM5JNVM84IGkE9qVG/J2iSJvxnddzCxzHTVZvjG5v/8+z+4RzwUeZo/wUljoNYLNPSchVJ2ZyXeSrLveq9tyPLgOLOoSrSWgmrK4dy/VJFzvvKPRlMmajGVpSTNQ820T7PpKS87hJ8KpHg/VT0zPvvhBktSWFBqze84yNZonK76r2Fgoc31jEhKQcCUEv/RkneCsQuqQqiMbCS/P9j6oHcrZIbWRloEIStqTOYwzmYykzQwqVkjMgeVUGLOZkTKji6hUMe0faOn5E1YXTbeXqbHA4jOs8ix/yF8Tf4JM06FOTohS8y9qWxT76oErRvexUzJLaxpepmh7XKmSrxBw/rAO5pNWUKtnXf+yI7qry0N5IxQllxpT1Bcmha+YNDyHLlYDoEuAOiEIz+GBKCU6ppesQzgvBWzn3BqpcPOyV8sFvd00/P1Pn+RrmimYLDWXb85F7Im63dvP56TJkFT2ZPZWzQ3MsOgGHfMeciND8MhKTI+JKN+ELX8n80OdGCVMkNlsXekvf7L6XdwAy+GR2tHxiMIPvzuzVff/PD2GxqXDii//+LRwcdaJVRvqq/8Y7WzTj9uxM3b037/Am7/Am7/Am7/Am7/Am7/Am7/Am7/Am7/Am7/Am7/Am7/Au5B/vcv4PYv4PYv4PYv4PYv4PYv4PYv4PYv4PYv4PYv4PYv4PYv4PYv4PYv4PYv4PYv4PYv4P5/vIALuS9kOB7WpZCcrRUSan2i1fnmu7jLNCkoE2tyntzd0dXiO1OuVlT8a4OG0rgu0+RGGEnhc07iSmPuEGXbXOOSrrj9bcDgjOZPvdzzdfxG7hqlPvker3n139u2nyx2evL2LEmTaXi7V+mc+hixoHd9YpFMElLa/AawzXbl8rukFGrecAJQ4sellCfRuGI9X+qa86XCj14ekVDLHpXriVSeFfpLjG3t8F90J/43XP5329zX7OwQsI2taQkvV6vVvwCGQsBn",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",source:"@site/docs/API-docs/createtemplate.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createtemplate",permalink:"/docs/API-docs/createtemplate",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",sidebar_label:"Create Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztW91yGzeyfpXeuXGsGlIirThe1qlTx/k5G+8mkSqWK3VKUingTJODaAaYABhRjIp3+yT7aPskW90AZoYUacl2KqutwxuJg9/uD41Gd6Nxlzgxt8nkPDnDqi6FQ5tcpkmONjOydlKrZJKcFQixGr4yKKgcXp++AVGWemGhsWgsOA0ZVSJkjXW6kr+JaYng4sApLAqZFWDR3CAIC9OywdpI5SzMtIE5KjTCSTWHXGdNhVSxkK6A2mCOM6kwB+tMk7nGoB3Cu1orsE2WobWzpmxn8mRIrVJwBTKhBl1jlAUBjZK/NggHB7H1lcwPDsAVwkEmFEyR2MmJm0AQ9siZCqrTige2NWZyJqlxGGt4oS7Umawn8K4utchhqRsDp1//bzsEjUtl5wcHX+O0mcO7NwcHl58VztV2cngo6nqoa1RWzlUppnaY6eowp4Z1PntOCKJBGpVpRWFluQSR57CQ+RydZY4VZLpeQqa1yaXy0NdijqCaaorGpiBUDpU2CFKBAIMiXw6cHjQW4a9vT36g5aiEG8Jp2di0nS6XBjNXLv3whEDk6plH5uUxrY9U8xQqcU0LKR382sjsmti2qBjWsCaM1cHB26autXGYw0+ehcnBAdV8iaVegDDI7TNdVVpBLYyo0LG00YJRtcFfG2kw96IiyjJiMaFhBrTSyxonBwfwRuUyIzh4SCoFPQuth74pwURN34al9U174NHaezEmVBbCr2hdiswTapCkwskbXB/4NoUlDfw1Kh0pKLSRv2nlRMkLcoPGyUyU/YUjAlnUnDC8M2otlYulYQb4v7BAtH68LEGyiLSc4Kqk4hqLcCPKBm2gapFCQVT9iLVByxIexiUoVQ4Fynmxcz6R/9JYtzYwNJbI7FMR5orrxPAiwzYTpUWQszUsK3GNvdlAsxoS5RC+XEKOM9GULgVJMudMg0P4QTsQdV3KjPUNqRLaPoK0xIBXOQhEIESJitf41OgbmSMphVzOZmhoe1IlDxH6ROpI0mruQOzx3nGFUKDVxkJnutSGht+QIS5fBxIyrRwqN4TXN0KWTL3n1oJUWdnkCNNSZNcpq8oUDOZ+7y6RFG/qRZ6bkD71oDNAYLEkMdSKGFA6TC9tp7SGZ4W03Y6iugg1zyFtH9Wwb2eaJiYI4iYDrIQsUwYuhV/0FJx0Jaa0ZWuhlinkwmEKDm/dVN+mkBWYXfMvI3KpYdo4R6qa5syNrnO9UAHLmVbOyt+27MhY8+GAjlM4TuFlCq9SGB2lMBqnMDpOYfQyhdGrFMZHKYzHKYyPUxi/9GSNXwWoRYtvn4DR2IPseuDC00aXNO930vLOJpVpWy28WNPCF2o0hIODdj9x8c8//3yh7i4UwEVC++simVwkbZOLJAVfR2rzIpmMUggFtxfJBF6Mv4gNlvT9ktD13wv6HtFq+O+CvsejC7UKk46ZGCeq+j2EUPXvT0T8DPJEhTwzlUXVRoWkk3xbqqF1o9KWLKpYdQy9IIakkk6K0u7mKbZ4emx1lG1wdkycsfTuZournx5PkaxYw7rTV7Gu7VVFNcCEjDcg+HzYnTY7EPCTPjUAAlWfyv9L4r/VWbtBaJs8PST6pH0qHF8M2Txgvb0bjNDg6UHREfapQLwiIOjc2o0C1T49CAJVsSLYAr7u6Hgw+nwwPhofr8FAfpRvUFWDPB8sl8tPhBAYMDKPwvxsbAZj1tuA5LPOjK62eCrsSHStgvnEv6N1/z3Z9NNo7mJOTuK6uxvdw75B7nQuls+sHyp2be04at9ZccsemVxFdLCrnBVaZoF4ahOttyl5g0MCYUDA54fff3/Yg9IXDqoq4guxlL4HDH2/tKqGeT7cbLu2Qr3SCvI8hS3l2yvyHKqq2lXuK+i4vFB/HnIcgk233XshNPhjtsMWqe/m37lXugqRa1Xy/Ozcbd8rG+dLIVWoCHIDGw0MzptSGLwlL9VKrRiX30ETbeyiuIk6M5+dWvYHOWTgkYDPToIp/zwIOHGwPgCVPNzvHmP9QQzO8ZbH8PE0IkbmIbBlm6wgn09Ej4Fg7wI8/JWJWlJwoUTnuBRdNtxGhF+0nmNOi7rpl1t0a8wIC7HnFtecV58djdERn3vBL3nPwRdaPD2136MsVvpgB1WfXySVCKZLMsPut3YFmovksu3jXXLMe31hW2e4fM9+gm7T5FiKKZb399qjd0OfnSBZPXCoopKqjSQwyUeRAq4Vtxu1oXK1ZZ95tvsCHpV73CYRZyiljeGUddD6vUO8ieOACn3EdooQO8C0FclPFvmWsMfJvNcIYXkemILaATdsY31xtgdmWFuaPjA0RiWVrJqqDVrO2lEjZFU45ft4UU+K5ccZ+st7bwZx+8AMIZq+Y4ILNeLQQgxKsGKA7cZgaPL0NEOPsoePwI/RGWvH5sceeB++EyNf/Z245Zykpv6EbHeh3b0Nh3BCpxJFTH0nioFlGdaO4mWfukdbkh+3R0ccSurHyHafTP1Wf7QM7hKmx0jnBt2/mxyGdp9mfBFqjxPGPhv/QQK5RvajjSUfEKz8NdSuaGDFovfUlGEga+PoT9JE13yvq9WbPJkk/o443pgmKY+N1n2p82UyuUtCDJ9+hgg5dT38xdJd9F1iswIrQb8iTXR7PZMlDUVBaDQ2SRMO2tBVNqGWTBI9/QUzl6TkYtR00YaWxuB+k7vYyt9eJmlw3JNJ4q81kzTBW1HV1DgUAapMk3fMQ6zijO8bqy3pxrL8o70/pnHofvAjh+Guq43r+48aqT/CqsO1G0wYI5bJZqZAvBiMfpzv1958lMu4WaSjLdFeVnGzJE2kw6o/y45VM/rDkc5QEycc2/3QvrwsovrgOalfXWj1UR3DRcwWzB+Jkq+9P/H6kr0mBxLzaE4PurvTFPjOYviQxMT2zK2Y9+f0xuG9Oc923an3rvJsoZsyp0syFGbIV9sfnTfBqSmizBrODmkPiTXOWlJbzkarNLl9mJlbyPQgXtjDZyXOHDR1jQYybRSa5/1Q3JNhbnx8vEqT5cPsLf8j2fuCFm/xMHc/caZDlwXy76D1xatVmhQP0/ptm4vxbyT2+OWqO+s2zvKrqc6XV1FvrR5qGA8Vake5QW/UicnR9ICYal2iUPeQeDPzVpaGZ2SMPAvxLr5Cl8bGAwUWsizBYIaUjsMh7KirIBgd/n4dwi0mGWffUAEbjbaZWmql4njWDzhFcEbO50hJR6EFdw5JAig4yY3SdIgqMaP7f04jMngjdWMjeYWwfI9fItmlrkDpM1ekmq8biT10OIWjz/uwvzpUQoecoqyCk7PTR2DJJuwAXNFmKHgu/RhwcnZKiUlyFuywIbyzLRIRWrHWBMgughspYvJCq9uXPuqAihHRzOxaHtkwpAQN4D5BubRbKUq7GGibh3hv4C53jZZIN46S5mTIx7AOa7uGI1PRAnmmm8dI5QNICpg3fJ3iaMvGLCWOy3aJRVL5BEd2gPLGxFyqIBbUkrIdO5wiKtSoN34KqKzvLmAmrEOTUuojIW8acnDaIfG2RiNRZbgVAoMeuqvGbLWb1jFYz9J59+N3IWMx8hA35ZR2oB8Yc2hqlhreCW32WFy5TdbvGUosZVe0R9Bc7TLT1snkLC9twu4PcbcajdWKirWZCyV/89Ickj2nWIhyxtq3vVSjpDCaN9JMo63TF9XvP//+DyKVJfWq0nkrvfbxgnVKeXzOtsrIac78xBJ9bmq8EmiVnE2jYrPBlqObAcMRfGZL18QP3krreklH8b7v/qb8EQnPrEcDn/20lUjQ1LK/q1q6QnJTNxynRsn1fLX27NkQwPefIf6Q6RzBoP8oCVMr683g8dER/duwQNdShWk3tGnE5fJPSfp4L/T9NrgvJr/3vkh2UvJlMf7W1qrKChKSCq1dN6O3dHmAgT5uUpVS4VUE5Wp8dHT1OSG3SpPjbeC81RW6giWCNuDCaMrorUsUlF9qliDmQiqg6c3viBUao837uf4wyt4HwvHR0dWoBeHz+yC8UXwpwtnjZ/oa1R/LaX9656cnUm8rVsJeyyXSN+L6ZI3Zfrln0mLWGOmWyeT8LrkdiFoOfP3k/HJ1SVLnCk3xmVpbpli4Ipkkh/fCNZy+T7GA83tysxBkFX3bTJns143T8L3Orj1vfH4k0Ta9kcb5kYbWdyuaKRuop0aQEP8gbq6FOSQFejgaHg2PklV6tzGIFSqni5J7Rq6o5eHNaEuPrSbxztbWiblU88F7e1122L6l9fdLvIZw58HX8m9ILnxYwH6rNJEEYoGCjGBaMhKrH7vg2DdROGLYamskqpOCzdhSDC2tRYs2z5ot8Z9e+Oc8xl44nNJGU5KOo6SNeNDPNoZx3sl6Gy6I0YIRu9nj42P2R78YseP24hX7RMcvV5ce4Z5/wAHIvpHrQ+Nr1looWrdekmSrtbB2Su84pKM5JNVM84IGkE9qVG/J2iSJvxnddzCxzHTVZvjG5v/8+z+4RzwUeZo/wUljoNYLNPSchVJ2ZyXeSrLveq9tyPLgOLOoSrSWgmrK4dy/VJFzvvKPRlMmajGVpSTNQ820T7PpKS87hJ8KpHg/VT0zPvvhBktSWFBqze84yNZonK76r2Fgoc31jEhKQcCUEv/RkneCsQuqQqiMbCS/P9j6oHcrZIbWRloEIStqTOYwzmYykzQwqVkjMgeVUGLOZkTKji6hUMe0faOn5E1YXTbeXqbHA4jOs8ix/yF8Tf4JM06FOTohS8y9qWxT76oErRvexUzJLaxpepmh7XKmSrxBw/rAO5pNWUKtnXf+yI7qry0N5IxQllxpT1Bcmha+YNDyHLlYDoEuAOiEIz+GBKCU6ppesQzgvBWzn3BqpcPOyV8sFvd00/P1Pn+RrmimYLDWXb85F7Im63dvP56TJkFT2ZPZWzQ3MsOgGHfMeciND8MhKTI+JKN+ELX8n80OdGCVMkNlsXekvf7L6XdwAy+GR2tHxiMIPvzuzVff/PD2GxqXDii//+LRwcdaJVRvqq/8Y7WzTj9uxM3b037/Am7/Am7/Am7/Am7/Am7/Am7/Am7/Am7/Am7/Am7/Am7/Au5B/vcv4PYv4PYv4PYv4PYv4PYv4PYv4PYv4PYv4PYv4PYv4PYv4PYv4PYv4PYv4PYv4PYv4P5/vIALuS9kOB7WpZCcrRUSan2i1fnmu7jLNCkoE2tyntzd0dXiO1OuVlT8a4OG0rgu0+RGGEnhc07iSmPuEGXbXOOSrrj9bcDgjOZPvdzzdfxG7hqlPvker3n139u2nyx2evL2LEmTaXi7V+mc+hixoHd9YpFMElLa/AawzXbl8rukFGrecAJQ4sellCfRuGI9X+qa86XCj14ekVDLHpXriVSeFfpLjG3t8F90J/43XP5329zX7OwQsI2taQkvV6vVvwCGQsBn",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Draft Template",permalink:"/docs/API-docs/drafttemplate"},next:{title:"Get Template",permalink:"/docs/API-docs/get-template"}},j={},g=[{value:"Request",id:"request",level:2}];function y(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(n.p,{children:"Create Template"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/createtemplate"}),"\n",(0,i.jsxs)(n.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,i.jsx)(n.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified.This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"name", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job title:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"job title", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"company", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"date", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": { \n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression":"",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0, \n "maxselections": 0 \n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"dropdown", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"radio button", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "readonly": false,\n "required": true, \n "name": "radio button",\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(n.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded file"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample note"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample description"}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})}),(0,i.jsx)("span",{className:"openapi-schema__divider"}),(0,i.jsx)("span",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("div",{style:{marginTop:".5rem",marginBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"You can provide signer optionally if you it as default signer"})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"redirect_url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_sender_name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"name or email of the person or organization on the behalf of which you are sending the mail.",example:"opensign\u2122"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(t.Z,{children:[(0,i.jsxs)(p.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Template created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bh2Hspnmch"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template created successfully!"}})]})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "objectId": "Bh2Hspnmch",\n "message": "Template created successfully!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(p.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(p.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function f(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/bfe4b778.6b36ff91.js b/assets/js/bfe4b778.6b36ff91.js new file mode 100644 index 000000000..0057e092e --- /dev/null +++ b/assets/js/bfe4b778.6b36ff91.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2087],{67554:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>j,contentTitle:()=>x,default:()=>y,frontMatter:()=>h,metadata:()=>f,toc:()=>g});var n=s(85893),t=s(11151),i=s(58219),l=(s(62316),s(51039)),o=s.n(l),r=(s(82723),s(9487)),d=s(41429),c=s(5397),m=s(4667),p=s(9472),u=s(85162);const h={id:"update-document",title:"Update Document",description:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.",sidebar_label:"Update Document",hide_title:!0,hide_table_of_contents:!0,api:"eJzdWOFuI7cRfpUJ/+QCrCXZ56TIoih6zR2SQ4LYOPtwQG3DGC1ntYy5JENyJQuC/uVJ+mh9kmLIXWlt+Zy7NmiB/jFk7nA483H4zUduRMRFEOWVeG2rriUTg7gphKRQeeWiskaU4rIheO8kRoLBCl6dvwXU2q4CdIF8gGihtVLVa0AjocvmsSGQFFHpALYGhOCoUrWqQPaOJvCzTYYYITYqJMfW6PXgPdrBGUJNK3DosaVIPhSwth1UaIyNUDVoFnnBWmkCayoCFXMEQ9AqQOUJI8mJKIR15JFTfCtFKfIiQ36iEPuFRHm1EQZbEqUYfN0qKQqhGB6HsRGPMXv7mhN+sHrK0RDJlNSc+rzYj6dfO+VJijL6jgoR4lrzakG1TpMoBN07bSWJskYd2KBqqEVRbkRcu2QZvTILUYja+hbjfmS7vcn+KcS/WbnmOQ9DPfd2qSTBnLQd4TtCPlLrNEYK8AIjaMIQwRoa2Q4JfCUKUVkTGcJyI9A5raoE8vSXwKttDkO381+oSoh73pKoKPDXDPjvJ8jgYIKpFCH92EEutoUwNn62m3NOkcDTUtEq1XNQC5Prc+y7tlqS5/I59L/3xpZkcK7p7PJ8ZDq3VhOag9LhEoCjvJpNg7BSWkP2AWeX57Akz6coATuB9+kAJhtPFakln5WxCVRWEiwVArWodAGrRlUNV+ca2i5EINNveJ8njc5nqjg4gsOApApPRlTks6vMYs8NB45BKk9V1GtYqdjYLgJKqXg6agiRXJiMUUxR7IC8tJ3/z5FEWHRKkoRoOw+19SnKxCwunQnOQJkQfVfx5ACy491NebAp/3beVhTCHqcBFTYa+S+ATMjTEWoMkXwBnVGMvO9cJLlzSfeOvCJT0ZMQJHBvE9n2gIdPx+KcfKtiGDLlrUEpgTQl8ofQVQ1g/o6x8xQKUEZFhToUECK2LhRgPUS6ZxKAaB0zHd2rEDn4lZILigHUx+roHfEZqUYx1N62afcZG7MeF8IurmgfubvkTVWhbzE1djrCEnX3FGbbQkQV9QP+HhH57Zx5cbtlO0/BWRMyBZ3MZod0uWuBPX0zZFwBdaf1+os/jv/y8O+RCwZ58kM4P/3BMc30Ib2Kz086mZ28PDqeHc3+dHn8TXn6bfn1N5PZbPZ3UYj7Vu/JV7A3MUYv/T8aUEYrQ7cDarcns9ntyx7K06fQ66nV9T1niVpJqBVpCbxm+AMBJO+t/zep/5n4nkufUx6SP32mdFix1LYz8n+d7lMRPZ/g6e3pLsWvD1N8azJkLOMu7R2Z/0aG+3zGy8e8PIf6sKpVNkrfxYNkx+M5yUBV51VcJw14f4ROHeXv5dUNK6uWYmNZP7oui8bYiFJMB3aZbkY8sxXszy8HSdl5LUrRxOhCOZ0GNHJu7yfWkWFm1DgPk8q2U3RqujwW2+LxDHTuM6xDxIUyi6NnZ93sM77gXcnAP8h7Bz869SOtRTHAOrbqpXFDKMmnLeDNfreXoW+GLdvtymPtNki3T1NjYzEmxAPB1UvmsXLoh57spEObVaa2Kdu+Os4cmQtemGtreXzQYD+QrmxLQ6cazP/52z/SjCHStMwXcNZ5cHZFvu50yqnWdK9YN4xuVny/Ye1E2GoKQa+B5cLCsyaXaqEiS6VeNFTocK604sPCZpZnexidtzCBDw3Fhjx/+tKzAJK0JM1nDLS1d0nbWMAu2jatMbDDyvq7mkMqAGHeBWUoBAhEwxQyDfKNayieJBHQZGHpvAoEqFo2ZplFda0qxY6ZGTxWEVo0uEi9vgCOm1HoSTiAt3NWqcHqLuswvmwSxZxiulJN4DXr3pQ4D+ZbJ8kswUKRJXBPFJyGkTCnEMHx8qqirFIjer7gLMmnw5Lvk53W4CwzmELNYme8t+woejSBaTYHNGzNDr5eI6Y1JK4ncG2uzQUXSxeIC0ArcxfKa3MEV7sy+0DzoCLdvBgO8Gq1Oji4Xz2c872KTTcHT87u5y3SYDrm4+m7f/jOFsm34ay+IL9UFfWs8ZE1p8l42vM6VonX08Uik8JfH09gjtWqIhPG5/3V9+c/wRJeTmaiGFHVJwQ8/entd29+vnjDfplM8/k7nswmMx5yNsQWzWipR48Xj4/uZt+g/l/fOnrKZtE+dRpV6nsJ9E3fs67EiEvL8TPHTSEaGyKbbDZzDPTe6+2Wh3/tyHNnvCnEEr1ifk2Nrb8CyR3RfhTuF++GhwP4vBeTJxMaGpPhrpQuA7kZ3NH60dPN9mZbDN2JI84W3+W4ji7Zz97DgWbh5ppnvKoqcvFZ27FIOH9/KQox759h2vSiIzyu+AkIV6IU1+JapKep3bUujW+ERrPocMH22S33VOx458YN+S415P4HJ/YkJA87dc6E/3JeT074M1fqj7T+y848f/nohB7awZq352a73f4LVGAtxA==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,f={id:"API-docs/update-document",title:"Update Document",description:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.",source:"@site/docs/API-docs/update-document.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/update-document",permalink:"/docs/API-docs/update-document",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"update-document",title:"Update Document",description:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.",sidebar_label:"Update Document",hide_title:!0,hide_table_of_contents:!0,api:"eJzdWOFuI7cRfpUJ/+QCrCXZ56TIoih6zR2SQ4LYOPtwQG3DGC1ntYy5JENyJQuC/uVJ+mh9kmLIXWlt+Zy7NmiB/jFk7nA483H4zUduRMRFEOWVeG2rriUTg7gphKRQeeWiskaU4rIheO8kRoLBCl6dvwXU2q4CdIF8gGihtVLVa0AjocvmsSGQFFHpALYGhOCoUrWqQPaOJvCzTYYYITYqJMfW6PXgPdrBGUJNK3DosaVIPhSwth1UaIyNUDVoFnnBWmkCayoCFXMEQ9AqQOUJI8mJKIR15JFTfCtFKfIiQ36iEPuFRHm1EQZbEqUYfN0qKQqhGB6HsRGPMXv7mhN+sHrK0RDJlNSc+rzYj6dfO+VJijL6jgoR4lrzakG1TpMoBN07bSWJskYd2KBqqEVRbkRcu2QZvTILUYja+hbjfmS7vcn+KcS/WbnmOQ9DPfd2qSTBnLQd4TtCPlLrNEYK8AIjaMIQwRoa2Q4JfCUKUVkTGcJyI9A5raoE8vSXwKttDkO381+oSoh73pKoKPDXDPjvJ8jgYIKpFCH92EEutoUwNn62m3NOkcDTUtEq1XNQC5Prc+y7tlqS5/I59L/3xpZkcK7p7PJ8ZDq3VhOag9LhEoCjvJpNg7BSWkP2AWeX57Akz6coATuB9+kAJhtPFakln5WxCVRWEiwVArWodAGrRlUNV+ca2i5EINNveJ8njc5nqjg4gsOApApPRlTks6vMYs8NB45BKk9V1GtYqdjYLgJKqXg6agiRXJiMUUxR7IC8tJ3/z5FEWHRKkoRoOw+19SnKxCwunQnOQJkQfVfx5ACy491NebAp/3beVhTCHqcBFTYa+S+ATMjTEWoMkXwBnVGMvO9cJLlzSfeOvCJT0ZMQJHBvE9n2gIdPx+KcfKtiGDLlrUEpgTQl8ofQVQ1g/o6x8xQKUEZFhToUECK2LhRgPUS6ZxKAaB0zHd2rEDn4lZILigHUx+roHfEZqUYx1N62afcZG7MeF8IurmgfubvkTVWhbzE1djrCEnX3FGbbQkQV9QP+HhH57Zx5cbtlO0/BWRMyBZ3MZod0uWuBPX0zZFwBdaf1+os/jv/y8O+RCwZ58kM4P/3BMc30Ib2Kz086mZ28PDqeHc3+dHn8TXn6bfn1N5PZbPZ3UYj7Vu/JV7A3MUYv/T8aUEYrQ7cDarcns9ntyx7K06fQ66nV9T1niVpJqBVpCbxm+AMBJO+t/zep/5n4nkufUx6SP32mdFix1LYz8n+d7lMRPZ/g6e3pLsWvD1N8azJkLOMu7R2Z/0aG+3zGy8e8PIf6sKpVNkrfxYNkx+M5yUBV51VcJw14f4ROHeXv5dUNK6uWYmNZP7oui8bYiFJMB3aZbkY8sxXszy8HSdl5LUrRxOhCOZ0GNHJu7yfWkWFm1DgPk8q2U3RqujwW2+LxDHTuM6xDxIUyi6NnZ93sM77gXcnAP8h7Bz869SOtRTHAOrbqpXFDKMmnLeDNfreXoW+GLdvtymPtNki3T1NjYzEmxAPB1UvmsXLoh57spEObVaa2Kdu+Os4cmQtemGtreXzQYD+QrmxLQ6cazP/52z/SjCHStMwXcNZ5cHZFvu50yqnWdK9YN4xuVny/Ye1E2GoKQa+B5cLCsyaXaqEiS6VeNFTocK604sPCZpZnexidtzCBDw3Fhjx/+tKzAJK0JM1nDLS1d0nbWMAu2jatMbDDyvq7mkMqAGHeBWUoBAhEwxQyDfKNayieJBHQZGHpvAoEqFo2ZplFda0qxY6ZGTxWEVo0uEi9vgCOm1HoSTiAt3NWqcHqLuswvmwSxZxiulJN4DXr3pQ4D+ZbJ8kswUKRJXBPFJyGkTCnEMHx8qqirFIjer7gLMmnw5Lvk53W4CwzmELNYme8t+woejSBaTYHNGzNDr5eI6Y1JK4ncG2uzQUXSxeIC0ArcxfKa3MEV7sy+0DzoCLdvBgO8Gq1Oji4Xz2c872KTTcHT87u5y3SYDrm4+m7f/jOFsm34ay+IL9UFfWs8ZE1p8l42vM6VonX08Uik8JfH09gjtWqIhPG5/3V9+c/wRJeTmaiGFHVJwQ8/entd29+vnjDfplM8/k7nswmMx5yNsQWzWipR48Xj4/uZt+g/l/fOnrKZtE+dRpV6nsJ9E3fs67EiEvL8TPHTSEaGyKbbDZzDPTe6+2Wh3/tyHNnvCnEEr1ifk2Nrb8CyR3RfhTuF++GhwP4vBeTJxMaGpPhrpQuA7kZ3NH60dPN9mZbDN2JI84W3+W4ji7Zz97DgWbh5ppnvKoqcvFZ27FIOH9/KQox759h2vSiIzyu+AkIV6IU1+JapKep3bUujW+ERrPocMH22S33VOx458YN+S415P4HJ/YkJA87dc6E/3JeT074M1fqj7T+y848f/nohB7awZq352a73f4LVGAtxA==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Document",permalink:"/docs/API-docs/getdocument"},next:{title:"Delete Document",permalink:"/docs/API-docs/deletedocument"}},j={},g=[{value:"Request",id:"request",level:2}];function v(e){const a={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("h1",{className:"openapi__heading",children:(0,n.jsx)(a.p,{children:"Update Document"})}),"\n",(0,n.jsx)(o(),{method:"put",path:"/document/{document_id}"}),"\n",(0,n.jsx)(a.p,{children:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created."}),"\n",(0,n.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,n.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,n.jsx)(a.p,{children:"Path Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsx)("ul",{children:(0,n.jsx)(d.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"ID of the document that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}})})})]}),"\n",(0,n.jsx)(r.Z,{className:"openapi-tabs__mime",children:(0,n.jsx)(u.default,{label:"application/json",value:"application/json-schema",children:(0,n.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,n.jsx)(a.p,{children:"Body"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,n.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,n.jsx)(a.p,{children:"Provide below parameter to update templates (at least one parameter required)"})})}),(0,n.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(m.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,n.jsx)(m.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,n.jsx)(m.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,n.jsx)(m.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1}}),(0,n.jsx)(m.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1}}),(0,n.jsx)(m.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}})]})]})})}),"\n",(0,n.jsx)("div",{children:(0,n.jsx)("div",{children:(0,n.jsxs)(i.Z,{children:[(0,n.jsxs)(u.default,{label:"200",value:"200",children:[(0,n.jsx)("div",{children:(0,n.jsx)(a.p,{children:"Document updated successfully!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(a.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"asd2HsP4Hp"}}),(0,n.jsx)(m.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,n.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(c.Z,{responseExample:'{\n "objectId": "asd2HsP4Hp",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(u.default,{label:"400",value:"400",children:[(0,n.jsx)("div",{children:(0,n.jsx)(a.p,{children:"Please provide valid field names!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(a.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please provide valid field names!"}})})]})}),(0,n.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(c.Z,{responseExample:'{\n "error": "Please provide valid field names!"\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(u.default,{label:"404",value:"404",children:[(0,n.jsx)("div",{children:(0,n.jsx)(a.p,{children:"Document not found!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(a.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Document not found!"}})})]})}),(0,n.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(c.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(u.default,{label:"405",value:"405",children:[(0,n.jsx)("div",{children:(0,n.jsx)(a.p,{children:"Invalid API Token!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(a.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,n.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,n.jsx)(a,{...e,children:(0,n.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/bfe4b778.953e8551.js b/assets/js/bfe4b778.953e8551.js deleted file mode 100644 index 56ddd8d43..000000000 --- a/assets/js/bfe4b778.953e8551.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2087],{67554:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>j,default:()=>b,frontMatter:()=>h,metadata:()=>x,toc:()=>y});var l=s(85893),i=s(11151),n=s(58219),t=(s(62316),s(51039)),o=s.n(t),d=(s(82723),s(9487)),r=s(41429),c=s(5397),m=s(4667),p=s(9472),u=s(85162);const h={id:"update-document",title:"Update Document",description:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.",sidebar_label:"Update Document",hide_title:!0,hide_table_of_contents:!0,api:"eJzdWOFuI7cRfpUJ//QCrCXZ5yTooijq5g65Q9KzcPbhgNqGMdqd1TLmkgzJlSwI+tcnyaP1SYohd6WVpXPu2qAF+seQucPhzMfhNx+5FgHnXuQ34pUp2oZ08OIuEyX5wkkbpNEiF9c1wQdbYiDoreBi+hZQKbP00HpyHoKBxpSyWgHqEtpkHmqCkgJK5cFUgOAtFbKSBZSdoxG8M9EQA4Ra+ujYaLXqvQfTO0OoaAkWHTYUyPkMVqaFArU2AYoa9TwtWElFYHRBIEOKoA9aeigcYaByJDJhLDnkFN+WIhdpkT4/kYndQiK/WQuNDYlc9L7uZSkyIRkei6EWTzF7+4oT3ls95qiJypjUjLq82I+jX1rpqBR5cC1lwoeV4tW8bKwikQl6tMqUJPIKlWeDoqYGRb4WYWWjZXBSz0UmKuMaDLuRzeYu+Scf/mrKFc/ZD3XqzEKWBDNSZoDvAPlAjVUYyMMLDKAIfQCjaWDbJ/C1yERhdGAI87VAa5UsIsjjnz2vtj4M3cx+piIi7nhLgiTPXxPgv50gg4MRplz4+GMLudhkQpvwxW6mnCKBo4WkZaxnL+c61efQd2VUSY7L59D/zhtbksaZosvr6cB0Zowi1AelwyUAJ2k1EwdhKZWC5AMur6ewIMenKAI7gg/xAEYbRwXJBZ+VoQkUpiRYSARqUKoMlrUsaq7OFTStD0C62/AuTxqcz1hxcAKHAZXSH40oS2dX6vmOGw4cQykdFUGtYClDbdoAWJaSp6MCH8j60RDFGMUWyGvTuv8cSYR5K0sqIZjWQWVcjDIyi41ngjOQ2gfXFjzZQ9ny7sY82JR/W2cK8n6HU48KGw38Z0Dap+kIFfpALoNWS0betTZQuXVJj5acJF3QUQgiuPeRbDvA/edjMSXXyOD7THlrsCyBFEXyB98WNWD6jqF15DOQWgaJymfgAzbWZ2AcBHpkEoBgLDMdPUofOPilLOcUPMhP1dF74jNSDGKonGni7jM2ejUshG1cwTxxd82bKn3XYipsVYAFqvYYZptMBBnUHn8PiPx+xry42bCdI2+N9omCziaTQ7rctsCOvhkyroCqVWr11e/Hf2n4t8gFfXn2xk/P31immS6ki/D8pLPJ2cuT08nJ5Lvr02/z8z/m33w7mkwmfxeZeGzUjnwFexND9OL/gwGpldR036N2fzaZ3L/soDw/hl5HrbbrOQtUsoRKkiqB1/S/I4DknHH/JvU/E99z6XPKffLnz5QOK5bKtLr8X6d7LKLnEzy/P9+m+M1him91goxl3LV5IP3fyHCXz3D5kJbnUPerWiaj+F3sJTscT0l6KlonwypqwMcTtPIkfc9v7lhZNRRqw/rRtkk0hlrkYtyzy3g94JmNYH9u0UvKfeSuljifk3vTzmL0F20w8DdTPKQUW6dELuoQrM/H44V0IXka+TStbmejwjTjqUMmone4eEA3Npb0+HQ0GU3EJls/ceJRlzPzOGIjpmKFMx99oJXjxemRGWjtF1j7gHOp5yfPzrrbQXzFZZB2eg/o7X6jlT/SSmT9Pg6tOi1eE5bk4p5zdb3f6d7XfY1sy+CpWOy14ufJv6H6E2JP4XUafShVuqGjrbvv61JXJmbbleOlJX3FC3M5LE4POvpHUoVpqG+Nvfk///FrnNFHGpf5Ci5bB9YsyVWtijlVih4lC5XBVY4vVCzWCBtF3qsVsD6ZO74ElHIuA2uzTqUUaHEmleTTyWaGZzsYHHA/go81hZocf/qDY8VV0oIUH2pQxjxEMWUA22CauEZPR0vjHioOKQOEWeulJu/BE/VTSNfIV7y+eKImQZ2UrHXSE6Bs2Jh1HVWVLCQ7ZipyWARoUOM8iosMOG5GoWN9D87MWBZ7o9ok/Ph2SxRSivEON4JXLLRj4jyYrrlUJs3ns6S5O2biNHQJM/IBLC8vC0qyOKDjG9WCXDws6QLbKgXWMGVKVKyuhnvLjoJD7ZnXU0D91mzh60RpXKPE1Qhu9a2+4mJpPXEBKKkffH6rT+BmW2YfaeZloLsX/QFeLpcHB/fr/Tk/yFC3M3BkzW7ePA7GYz6cvv2HL4mBXOMvqytyC1lQxxqfWHMcjcddI8EiNpJ4k0mk8JenE5jUlSxI++F5v/hh+hMs4OVossennxHw+Ke3379+d/Wa/TJ7p/PX86qwxocG9WCpJ68lT4/uetcR/18fVzrK5lvC2CqUsdFG0Nddk7wRAy7Nh+8qd5mojQ9ssl7P0NMHpzYbHv6lJcet+C4TC3SS+TV10nTnKrdE+0m4X7zvXyrgy55ojibUNybNXSnePlIzeKDVk7eizd0m67sTR5wsvk9xnVyzn52HA5HEzTXNuCgKsuFZ26EqmX64FpmYde8+TXxCEg6X/OaES5GLW3Er4lvY9h4Zx9dCoZ63OGf75JZ7Kra8c8OG/BAbcveDEzsKyX6nTpnwX87r6IQ/caX+SKs/b83Tl09O6KDtrXl77jabzb8AhTRVbw==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,x={id:"API-docs/update-document",title:"Update Document",description:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.",source:"@site/docs/API-docs/update-document.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/update-document",permalink:"/docs/API-docs/update-document",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"update-document",title:"Update Document",description:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.",sidebar_label:"Update Document",hide_title:!0,hide_table_of_contents:!0,api:"eJzdWOFuI7cRfpUJ//QCrCXZ5yTooijq5g65Q9KzcPbhgNqGMdqd1TLmkgzJlSwI+tcnyaP1SYohd6WVpXPu2qAF+seQucPhzMfhNx+5FgHnXuQ34pUp2oZ08OIuEyX5wkkbpNEiF9c1wQdbYiDoreBi+hZQKbP00HpyHoKBxpSyWgHqEtpkHmqCkgJK5cFUgOAtFbKSBZSdoxG8M9EQA4Ra+ujYaLXqvQfTO0OoaAkWHTYUyPkMVqaFArU2AYoa9TwtWElFYHRBIEOKoA9aeigcYaByJDJhLDnkFN+WIhdpkT4/kYndQiK/WQuNDYlc9L7uZSkyIRkei6EWTzF7+4oT3ls95qiJypjUjLq82I+jX1rpqBR5cC1lwoeV4tW8bKwikQl6tMqUJPIKlWeDoqYGRb4WYWWjZXBSz0UmKuMaDLuRzeYu+Scf/mrKFc/ZD3XqzEKWBDNSZoDvAPlAjVUYyMMLDKAIfQCjaWDbJ/C1yERhdGAI87VAa5UsIsjjnz2vtj4M3cx+piIi7nhLgiTPXxPgv50gg4MRplz4+GMLudhkQpvwxW6mnCKBo4WkZaxnL+c61efQd2VUSY7L59D/zhtbksaZosvr6cB0Zowi1AelwyUAJ2k1EwdhKZWC5AMur6ewIMenKAI7gg/xAEYbRwXJBZ+VoQkUpiRYSARqUKoMlrUsaq7OFTStD0C62/AuTxqcz1hxcAKHAZXSH40oS2dX6vmOGw4cQykdFUGtYClDbdoAWJaSp6MCH8j60RDFGMUWyGvTuv8cSYR5K0sqIZjWQWVcjDIyi41ngjOQ2gfXFjzZQ9ny7sY82JR/W2cK8n6HU48KGw38Z0Dap+kIFfpALoNWS0betTZQuXVJj5acJF3QUQgiuPeRbDvA/edjMSXXyOD7THlrsCyBFEXyB98WNWD6jqF15DOQWgaJymfgAzbWZ2AcBHpkEoBgLDMdPUofOPilLOcUPMhP1dF74jNSDGKonGni7jM2ejUshG1cwTxxd82bKn3XYipsVYAFqvYYZptMBBnUHn8PiPx+xry42bCdI2+N9omCziaTQ7rctsCOvhkyroCqVWr11e/Hf2n4t8gFfXn2xk/P31immS6ki/D8pLPJ2cuT08nJ5Lvr02/z8z/m33w7mkwmfxeZeGzUjnwFexND9OL/gwGpldR036N2fzaZ3L/soDw/hl5HrbbrOQtUsoRKkiqB1/S/I4DknHH/JvU/E99z6XPKffLnz5QOK5bKtLr8X6d7LKLnEzy/P9+m+M1him91goxl3LV5IP3fyHCXz3D5kJbnUPerWiaj+F3sJTscT0l6KlonwypqwMcTtPIkfc9v7lhZNRRqw/rRtkk0hlrkYtyzy3g94JmNYH9u0UvKfeSuljifk3vTzmL0F20w8DdTPKQUW6dELuoQrM/H44V0IXka+TStbmejwjTjqUMmone4eEA3Npb0+HQ0GU3EJls/ceJRlzPzOGIjpmKFMx99oJXjxemRGWjtF1j7gHOp5yfPzrrbQXzFZZB2eg/o7X6jlT/SSmT9Pg6tOi1eE5bk4p5zdb3f6d7XfY1sy+CpWOy14ufJv6H6E2JP4XUafShVuqGjrbvv61JXJmbbleOlJX3FC3M5LE4POvpHUoVpqG+Nvfk///FrnNFHGpf5Ci5bB9YsyVWtijlVih4lC5XBVY4vVCzWCBtF3qsVsD6ZO74ElHIuA2uzTqUUaHEmleTTyWaGZzsYHHA/go81hZocf/qDY8VV0oIUH2pQxjxEMWUA22CauEZPR0vjHioOKQOEWeulJu/BE/VTSNfIV7y+eKImQZ2UrHXSE6Bs2Jh1HVWVLCQ7ZipyWARoUOM8iosMOG5GoWN9D87MWBZ7o9ok/Ph2SxRSivEON4JXLLRj4jyYrrlUJs3ns6S5O2biNHQJM/IBLC8vC0qyOKDjG9WCXDws6QLbKgXWMGVKVKyuhnvLjoJD7ZnXU0D91mzh60RpXKPE1Qhu9a2+4mJpPXEBKKkffH6rT+BmW2YfaeZloLsX/QFeLpcHB/fr/Tk/yFC3M3BkzW7ePA7GYz6cvv2HL4mBXOMvqytyC1lQxxqfWHMcjcddI8EiNpJ4k0mk8JenE5jUlSxI++F5v/hh+hMs4OVossennxHw+Ke3379+d/Wa/TJ7p/PX86qwxocG9WCpJ68lT4/uetcR/18fVzrK5lvC2CqUsdFG0Nddk7wRAy7Nh+8qd5mojQ9ssl7P0NMHpzYbHv6lJcet+C4TC3SS+TV10nTnKrdE+0m4X7zvXyrgy55ojibUNybNXSnePlIzeKDVk7eizd0m67sTR5wsvk9xnVyzn52HA5HEzTXNuCgKsuFZ26EqmX64FpmYde8+TXxCEg6X/OaES5GLW3Er4lvY9h4Zx9dCoZ63OGf75JZ7Kra8c8OG/BAbcveDEzsKyX6nTpnwX87r6IQ/caX+SKs/b83Tl09O6KDtrXl77jabzb8AhTRVbw==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Document",permalink:"/docs/API-docs/getdocument"},next:{title:"Delete Document",permalink:"/docs/API-docs/deletedocument"}},f={},y=[{value:"Request",id:"request",level:2}];function g(e){const a={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Update Document"})}),"\n",(0,l.jsx)(o(),{method:"put",path:"/document/{document_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(r.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"ID of the document that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}})})})]}),"\n",(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(a.p,{children:"Body"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(a.p,{children:"Provide below parameter to update templates (at least one parameter required)"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(u.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Document updated successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"asd2HsP4Hp"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "objectId": "asd2HsP4Hp",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Please provide valid field names!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please provide valid field names!"}})})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "Please provide valid field names!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Document not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Document not found!"}})})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/f0ff4a36.28386b54.js b/assets/js/f0ff4a36.28386b54.js new file mode 100644 index 000000000..98d526eeb --- /dev/null +++ b/assets/js/f0ff4a36.28386b54.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1332],{94348:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>x,default:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>g});var i=s(85893),l=s(11151),n=s(58219),r=(s(62316),s(51039)),t=s.n(r),m=(s(82723),s(9487)),o=s(41429),c=s(5397),d=s(4667),p=s(9472),h=s(85162);const u={id:"getdocument",title:"Get Document",description:"The Get Document API enables you to retrieve details about a specific document.",sidebar_label:"Get Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9WO9uIzUQf5XBX+Ckbf60uTuIEKKCoxQQh2jRSdxFkXd3kvXVaxt7NmkU7TeehEfjSdB4d9NNm+tdBNyXNmvPf8/8ZuytILkMYvpafGuzqkRDQcwSkWPIvHKkrBFTcV0gXCBBRwLnv1wCGplqDLCxFZAFj+QVrhByJKl0AJnaikBCcJiphcogb7kHIhHWoZcs/TIXU7FE6jZFIpz0skRCz2ZthZEliqnoCOYqF4lQbJaTVIj7ttr0LWZ0mYNd7OwVifD4R6U85mJKvsJEBNpoFhtU6TSKROCt0zZHMV1IHZggK7CUYroVtHGRkrwyS5GIhfWlpP4K3sooZSrc9+O0yE4Ll4q6nrHa4KwJGFjQ6WjE//btDVWWYQiLSsMuKCIRmTXElk+3QjqnVRY3hm8DM20fWte4zdHzLIZUo7KLxrF+fHehbk7P0uK3H0SdiIXixeMkFEQuTIfDdqXyepDZkqWRouPFhfiDc4hFGEtHS3AaZUAIaml2qRidszpH/7FC2WTzcRIaCyGy1ncBvCuJ1oU6EXZt9nz5IPlvLUKKyPwcnVh4OwnSe7nhiiMsw/uj5O3hs73TlqF9LBAHzcJSKv1e6hTx63ahyzVXWPMeNZOnz07HZ58/HzP9WuVLpH/hf7P7UN9+0Z9rbdeYw0rqCgOcxKyUVHlMIJAs3eB95dDRs9G3PYWmKlP0fe7dyo77dDKpE7E5kuv5mONzJNPZ53UiiiOZJs/45OQSj+Qb94uDsHRaEs6vmpSed0dbP0YV6yugyS/NS78PC6m1GqXpK+RWUici8ygJ83N6PNFOR6dnJ+PRyej59fjZdPLF9OmzwWg0+l0k4raM2d21Okko+nXeflcu/yh6ms5+basPc99jrjxmNK/8wRp9LI9ZneRimJc25ykhtrnwuN7Yofmg7rnTA/X7EMmnXidicqgDX9kSqVBmCWuebdbemmUCbbsgvwG5lMoAp4n/5L9rzei9PQjVd9E5zrJ+XiujlcF5N37MJ6PRfLwLwuRhEHajnbEEC1uZ/OO6ekj/4w5N5mc7h54+dOjSrKRWeRxVr+0Nmo/rT189NeofZqxqiOK+2HO2v944GTCrvKJNnIlvT6RTJ83+9PWMJ03OFNsO03GIpkJMxbArgOG2N0DXguX5VTdix8LdTWxBmjy1twPr0HCf0TIN3E+H0qnhitvkfQ7p3BHUgeRSmeXJo1yzO4+v+FSawO/5fdeinfoRuUe3Ye1TtVeFAmWckGr+XtjI3Ab7pUPD6B+PajV+0Ktfoc5siXzHoQKhI//7z78iRxfWmEmfwMvKg7Nr9DzQS5PDQuOtSjVG4gh1uytTQFlqDEFvQBnCpZeEkKulIqnjRMCVn0knU6UV5x6TWeb20EvfMIBXBVKBnrc+9QgSclyh5pQFbe0NyyELsiJbRh1dsa2tv1mwSQlISKugDIYAAbFjQVNIkyF0Z5GA9SANoCH0zquAIFXJxAvrARcLlSkWzIXmZUZQSiOXyMoSYLs5Cs7blcoxgLdpFQiC1VV0hDWWiNS4aBDzMIBv1Qobx3mxuV1iDsuKRSSQ2RyhrTt2w+SQYiBwrF5lGIUGkp5A4wp9zL14kotKa3CWAUFJzffF/tmyIPLSBG5fjUHd0ezC57zlu1vUkcvNAN6YN4ZBG6qAnABamZswfWNO4PUuzV5hGhTh7LOuHtbr9YM6eLLPc6GoqFLw6Owd3zIuxqrps+8+nohEEPoyvFxcoV+prLuWvUPnMBIPW5iUWYTJdvLmGvv6PgNDllYZmoA9UDu/+OUnWMHZYCSSXuV/gMHDny6/efHz1QuWy9jU1N94MBqM4ixvA5XS9FT13yTu1+32Duz/h/eLFnkIb2notFQRvtv5p4He16L3pDHtv17MElHYQEyy3aYy4G9e1zUv/1GhZ4CfJWIlvWL7Ij7nKvDvfPc48U5PP/u1fed4Au94CDloeQekhlE0Xkp4NkvEDW7uPb3UMx7oGzRl0xqK8yxDRz3eB911r0VdvLgWiZAVFfsofhNRvP3B0g/atQ/vjQH8lzvNQYYv+bh/xM1XO/Jm550MrX8dNcdoVtf1P3KYmXQ=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/getdocument",title:"Get Document",description:"The Get Document API enables you to retrieve details about a specific document.",source:"@site/docs/API-docs/getdocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getdocument",permalink:"/docs/API-docs/getdocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getdocument",title:"Get Document",description:"The Get Document API enables you to retrieve details about a specific document.",sidebar_label:"Get Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9WO9uIzUQf5XBX+Ckbf60uTuIEKKCoxQQh2jRSdxFkXd3kvXVaxt7NmkU7TeehEfjSdB4d9NNm+tdBNyXNmvPf8/8ZuytILkMYvpafGuzqkRDQcwSkWPIvHKkrBFTcV0gXCBBRwLnv1wCGplqDLCxFZAFj+QVrhByJKl0AJnaikBCcJiphcogb7kHIhHWoZcs/TIXU7FE6jZFIpz0skRCz2ZthZEliqnoCOYqF4lQbJaTVIj7ttr0LWZ0mYNd7OwVifD4R6U85mJKvsJEBNpoFhtU6TSKROCt0zZHMV1IHZggK7CUYroVtHGRkrwyS5GIhfWlpP4K3sooZSrc9+O0yE4Ll4q6nrHa4KwJGFjQ6WjE//btDVWWYQiLSsMuKCIRmTXElk+3QjqnVRY3hm8DM20fWte4zdHzLIZUo7KLxrF+fHehbk7P0uK3H0SdiIXixeMkFEQuTIfDdqXyepDZkqWRouPFhfiDc4hFGEtHS3AaZUAIaml2qRidszpH/7FC2WTzcRIaCyGy1ncBvCuJ1oU6EXZt9nz5IPlvLUKKyPwcnVh4OwnSe7nhiiMsw/uj5O3hs73TlqF9LBAHzcJSKv1e6hTx63ahyzVXWPMeNZOnz07HZ58/HzP9WuVLpH/hf7P7UN9+0Z9rbdeYw0rqCgOcxKyUVHlMIJAs3eB95dDRs9G3PYWmKlP0fe7dyo77dDKpE7E5kuv5mONzJNPZ53UiiiOZJs/45OQSj+Qb94uDsHRaEs6vmpSed0dbP0YV6yugyS/NS78PC6m1GqXpK+RWUici8ygJ83N6PNFOR6dnJ+PRyej59fjZdPLF9OmzwWg0+l0k4raM2d21Okko+nXeflcu/yh6ms5+basPc99jrjxmNK/8wRp9LI9ZneRimJc25ykhtrnwuN7Yofmg7rnTA/X7EMmnXidicqgDX9kSqVBmCWuebdbemmUCbbsgvwG5lMoAp4n/5L9rzei9PQjVd9E5zrJ+XiujlcF5N37MJ6PRfLwLwuRhEHajnbEEC1uZ/OO6ekj/4w5N5mc7h54+dOjSrKRWeRxVr+0Nmo/rT189NeofZqxqiOK+2HO2v944GTCrvKJNnIlvT6RTJ83+9PWMJ03OFNsO03GIpkJMxbArgOG2N0DXguX5VTdix8LdTWxBmjy1twPr0HCf0TIN3E+H0qnhitvkfQ7p3BHUgeRSmeXJo1yzO4+v+FSawO/5fdeinfoRuUe3Ye1TtVeFAmWckGr+XtjI3Ab7pUPD6B+PajV+0Ktfoc5siXzHoQKhI//7z78iRxfWmEmfwMvKg7Nr9DzQS5PDQuOtSjVG4gh1uytTQFlqDEFvQBnCpZeEkKulIqnjRMCVn0knU6UV5x6TWeb20EvfMIBXBVKBnrc+9QgSclyh5pQFbe0NyyELsiJbRh1dsa2tv1mwSQlISKugDIYAAbFjQVNIkyF0Z5GA9SANoCH0zquAIFXJxAvrARcLlSkWzIXmZUZQSiOXyMoSYLs5Cs7blcoxgLdpFQiC1VV0hDWWiNS4aBDzMIBv1Qobx3mxuV1iDsuKRSSQ2RyhrTt2w+SQYiBwrF5lGIUGkp5A4wp9zL14kotKa3CWAUFJzffF/tmyIPLSBG5fjUHd0ezC57zlu1vUkcvNAN6YN4ZBG6qAnABamZswfWNO4PUuzV5hGhTh7LOuHtbr9YM6eLLPc6GoqFLw6Owd3zIuxqrps+8+nohEEPoyvFxcoV+prLuWvUPnMBIPW5iUWYTJdvLmGvv6PgNDllYZmoA9UDu/+OUnWMHZYCSSXuV/gMHDny6/efHz1QuWy9jU1N94MBqM4ixvA5XS9FT13yTu1+32Duz/h/eLFnkIb2notFQRvtv5p4He16L3pDHtv17MElHYQEyy3aYy4G9e1zUv/1GhZ4CfJWIlvWL7Ij7nKvDvfPc48U5PP/u1fed4Au94CDloeQekhlE0Xkp4NkvEDW7uPb3UMx7oGzRl0xqK8yxDRz3eB911r0VdvLgWiZAVFfsofhNRvP3B0g/atQ/vjQH8lzvNQYYv+bh/xM1XO/Jm550MrX8dNcdoVtf1P3KYmXQ=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Document from Template",permalink:"/docs/API-docs/createdocumentwithtemplateid"},next:{title:"Update Document",permalink:"/docs/API-docs/update-document"}},f={},g=[{value:"Request",id:"request",level:2}];function v(e){const a={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(a.p,{children:"Get Document"})}),"\n",(0,i.jsx)(t(),{method:"get",path:"/document/{document_id}"}),"\n",(0,i.jsx)(a.p,{children:"The Get Document API enables you to retrieve details about a specific document."}),"\n",(0,i.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,i.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(a.p,{children:"Path Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsx)("ul",{children:(0,i.jsx)(o.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"objectId of Document",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(n.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"successful operation"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(a.p,{children:"folder"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(a.p,{children:"object"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder name"}})]})]})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(a.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(a.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(a.p,{children:"Array ["})})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(a.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(a.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(a.p,{children:"Array ["})})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(a.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(a.p,{children:"]"})})})]})]})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!0}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!0}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"redirect_url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "objectId": "FGik23bhUJ",\n "file": "https://exampleurl.com",\n "title": "sample doc",\n "note": "please sign document",\n "folder": {\n "objectId": "FGik23bhUJ",\n "name": "folder name"\n },\n "owner": "joe bee",\n "signers": [\n {\n "role": "ceo",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871",\n "widgets": [\n {\n "type": "signature",\n "x": 244,\n "y": 71,\n "w": 38,\n "h": 46,\n "page": 1\n }\n ]\n }\n ],\n "sendInOrder": true,\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z",\n "enableTour": true,\n "redirect_url": "",\n "allow_modifications": false\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"404",value:"404",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Document not found!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Document not found!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,i.jsx)(a,{...e,children:(0,i.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/f0ff4a36.d1136268.js b/assets/js/f0ff4a36.d1136268.js deleted file mode 100644 index 9a332907e..000000000 --- a/assets/js/f0ff4a36.d1136268.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1332],{94348:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>x,default:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>g});var n=a(85893),l=a(11151),i=a(58219),r=(a(62316),a(51039)),t=a.n(r),m=(a(82723),a(9487)),c=a(41429),o=a(5397),d=a(4667),p=a(9472),h=a(85162);const u={id:"getdocument",title:"Get Document",description:"The Get Document API enables you to retrieve details about a specific document.",sidebar_label:"Get Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9WO9uGzcSfxWWX64B1vpjO0krHIoa15zrttcEtYsAlwjC7O5olzGXZMlZyYKw3+5J7tHuSQ7D3ZVXtuJE6F2+2Fpy/nN+M0NuJUER5Oyd/MFmdYWGgpwnMseQeeVIWSNn8qZEcYkkehJx8eZKoIFUYxAbWwuywiN5hSsUORIoHQSktiYBIjjM1FJlIu+4RzKR1qEHln6Vy5kskPpNmUgHHiok9GzWVhqoUM5kT7BQuUykYrMcUCkf2mrTD5jRVS7scmevTKTHP2rlMZcz8jUmMtBGs9igKqdRJhLvnLY5ytkSdGCCrMQK5GwraeMiJXllCpnIpfUV0HAF7yBKmUn34zQts9PSpbJp5qw2OGsCBhZ0Opnwv317Q51lGMKy1mIXFJnIzBpiy2dbCc5plcWN8YfATNvH1rVuc/Q8iyHVquyjcawff79Ut6dnafn7T7JJ5FLx4nESSiIXZuNxt1J7PcpsxdJI0fHiQvzBOcQijKWjJTiNEFAEVZhdKkbnrM7Rf6lQttl8nITWQhFZm/sA3kOic6FJpF2bPV8+S/4HiyJFZH6OTgTeTgJ4DxtGHGEVPh0lbw+f7b22DO1TgThoFlag9CepU8Tvu4U+11xpzSfUnD9/cTo9++bllOnXKi+Q/oT/7e5jffugv9DarjEXK9A1BnESsxKo9piIQFC50afg0NOz0XcDhaauUvRD7t3Kjvv0/LxJ5OZIrpdTjs+RTGffNIksj2Q6f8EnBwUeyTcdgoOwchoIF9dtSi/6o22eoor4CmjyK/Pa75eF1FqNYIYKuZU0icw8AmF+QU8n2unk9OxkOjmZvLyZvpidfzt7/mI0mUz+KRN5V8Xs7lsdEMohzrvv2uVfRE/b2W9s/Xnue8yVx4wWtT+I0afymNUBg2FR2ZynhNjmwtN6Y4fmg3rgzqCoPyyRfOpNIs8PdeBrWyGVyhRizbPN2ltTJKJrF+Q3AgpQRnCa+K/+d60ZvbcHS/V9dI6zbJjXymhlcNGPH4vzyWQx3QXh/HEQdqOdsSSWtjb5l3X1kP6nHTpfnO0cev7YoSuzAq3yOKre2Fs0X9afoXpq1T/OWNUSxX255+xwvXUyYFZ7RZs4E9+dgFMn7f7s3ZwnTc4U2w3TcYimUs7kuAfAeDsYoBvJ8vyqH7Ef4GENRYH+xzqN1l/UZMU/bHbbuhhBvpvuVspTK2kUWrayTrn5jt94WNZa/wqrW/Bj69CMp6PJaCKbZPtASACTp/ZuxETc2DSkIcoAp8ar6QEOcO4I6kBQKFOcPMk1vw/xNadBe9J7gb6fCZz6GXko6M5xSNXdTUqEOJI1/L20kbk73dcODbebGN3V9NFw8BZ1ZivkSxWVKHry//zr35GjP8eYul+J17UXzq7R8w0CTC6WGu9UqjESx9q6u6MFhEpjCHojlCEsPBCKXBWKQMcRhEtNBg5SpRUnO5NZ5vZigJcwEm9LpBI9b/3FowCR4wo1Y0RoazlVWB/UZKuoo0f32vrbJZuUCBBpHZTBEERA7FnQlGAyFP1ZJMJ6AUagIfTOq4ACVMXES+sFLpcqUyyYke0hI1GBgQJZWSLYbo6C83alcgzC27QOJILVdXSENVaI1LpoEPMwEj+oFbaO82J7ncVcFDWLSERmcxQd0NkNk4sUAwnH6lWGUWgg8CQ0rtDH3IsnyXgQznIFUqD5gjo8WxZEHkzgftka1B/NLnzOW74sRh05bEbivXlvuEuIOiAngFbmNszemxPxbpdmbzENinD+dY+H9Xr9CAfP9nkuFZV1Kjw6e89XxMWImiH77uOZTCShr8Lr5TX6lcr6e+BHdI4j8biry5DFutyN+oyx7x8ycI3UKkMTcFBFLy7f/CJW4mw02StPn2Hw+Jerv7369foVy+Vi2OKvL1PS2UAVmIGq4SPIQ9xu77vL/+HBpKs8hHc0dhpU7BfdwNXW+ndy8IYyGz6XzBNZ2kBMst2mEPB3r5uGl/+o0XNHmSdyBV6xfW1DUIF/57vXkI96+vVv3cPKM/GRl5eDlveF1HAVjbcgHgYTeYubB289zZxvEG01ZdNaiossQ0cD3kftfK8nXr66kYmEmsr9Kn4bq3j3g6UftGu/vLcG8F/uNAcZ/srH/TNuvtuRtzsfZej866k5RvOmaf4LxqnBHw==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/getdocument",title:"Get Document",description:"The Get Document API enables you to retrieve details about a specific document.",source:"@site/docs/API-docs/getdocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getdocument",permalink:"/docs/API-docs/getdocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getdocument",title:"Get Document",description:"The Get Document API enables you to retrieve details about a specific document.",sidebar_label:"Get Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9WO9uGzcSfxWWX64B1vpjO0krHIoa15zrttcEtYsAlwjC7O5olzGXZMlZyYKw3+5J7tHuSQ7D3ZVXtuJE6F2+2Fpy/nN+M0NuJUER5Oyd/MFmdYWGgpwnMseQeeVIWSNn8qZEcYkkehJx8eZKoIFUYxAbWwuywiN5hSsUORIoHQSktiYBIjjM1FJlIu+4RzKR1qEHln6Vy5kskPpNmUgHHiok9GzWVhqoUM5kT7BQuUykYrMcUCkf2mrTD5jRVS7scmevTKTHP2rlMZcz8jUmMtBGs9igKqdRJhLvnLY5ytkSdGCCrMQK5GwraeMiJXllCpnIpfUV0HAF7yBKmUn34zQts9PSpbJp5qw2OGsCBhZ0Opnwv317Q51lGMKy1mIXFJnIzBpiy2dbCc5plcWN8YfATNvH1rVuc/Q8iyHVquyjcawff79Ut6dnafn7T7JJ5FLx4nESSiIXZuNxt1J7PcpsxdJI0fHiQvzBOcQijKWjJTiNEFAEVZhdKkbnrM7Rf6lQttl8nITWQhFZm/sA3kOic6FJpF2bPV8+S/4HiyJFZH6OTgTeTgJ4DxtGHGEVPh0lbw+f7b22DO1TgThoFlag9CepU8Tvu4U+11xpzSfUnD9/cTo9++bllOnXKi+Q/oT/7e5jffugv9DarjEXK9A1BnESsxKo9piIQFC50afg0NOz0XcDhaauUvRD7t3Kjvv0/LxJ5OZIrpdTjs+RTGffNIksj2Q6f8EnBwUeyTcdgoOwchoIF9dtSi/6o22eoor4CmjyK/Pa75eF1FqNYIYKuZU0icw8AmF+QU8n2unk9OxkOjmZvLyZvpidfzt7/mI0mUz+KRN5V8Xs7lsdEMohzrvv2uVfRE/b2W9s/Xnue8yVx4wWtT+I0afymNUBg2FR2ZynhNjmwtN6Y4fmg3rgzqCoPyyRfOpNIs8PdeBrWyGVyhRizbPN2ltTJKJrF+Q3AgpQRnCa+K/+d60ZvbcHS/V9dI6zbJjXymhlcNGPH4vzyWQx3QXh/HEQdqOdsSSWtjb5l3X1kP6nHTpfnO0cev7YoSuzAq3yOKre2Fs0X9afoXpq1T/OWNUSxX255+xwvXUyYFZ7RZs4E9+dgFMn7f7s3ZwnTc4U2w3TcYimUs7kuAfAeDsYoBvJ8vyqH7Ef4GENRYH+xzqN1l/UZMU/bHbbuhhBvpvuVspTK2kUWrayTrn5jt94WNZa/wqrW/Bj69CMp6PJaCKbZPtASACTp/ZuxETc2DSkIcoAp8ar6QEOcO4I6kBQKFOcPMk1vw/xNadBe9J7gb6fCZz6GXko6M5xSNXdTUqEOJI1/L20kbk73dcODbebGN3V9NFw8BZ1ZivkSxWVKHry//zr35GjP8eYul+J17UXzq7R8w0CTC6WGu9UqjESx9q6u6MFhEpjCHojlCEsPBCKXBWKQMcRhEtNBg5SpRUnO5NZ5vZigJcwEm9LpBI9b/3FowCR4wo1Y0RoazlVWB/UZKuoo0f32vrbJZuUCBBpHZTBEERA7FnQlGAyFP1ZJMJ6AUagIfTOq4ACVMXES+sFLpcqUyyYke0hI1GBgQJZWSLYbo6C83alcgzC27QOJILVdXSENVaI1LpoEPMwEj+oFbaO82J7ncVcFDWLSERmcxQd0NkNk4sUAwnH6lWGUWgg8CQ0rtDH3IsnyXgQznIFUqD5gjo8WxZEHkzgftka1B/NLnzOW74sRh05bEbivXlvuEuIOiAngFbmNszemxPxbpdmbzENinD+dY+H9Xr9CAfP9nkuFZV1Kjw6e89XxMWImiH77uOZTCShr8Lr5TX6lcr6e+BHdI4j8biry5DFutyN+oyx7x8ycI3UKkMTcFBFLy7f/CJW4mw02StPn2Hw+Jerv7369foVy+Vi2OKvL1PS2UAVmIGq4SPIQ9xu77vL/+HBpKs8hHc0dhpU7BfdwNXW+ndy8IYyGz6XzBNZ2kBMst2mEPB3r5uGl/+o0XNHmSdyBV6xfW1DUIF/57vXkI96+vVv3cPKM/GRl5eDlveF1HAVjbcgHgYTeYubB289zZxvEG01ZdNaiossQ0cD3kftfK8nXr66kYmEmsr9Kn4bq3j3g6UftGu/vLcG8F/uNAcZ/srH/TNuvtuRtzsfZej866k5RvOmaf4LxqnBHw==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Document from Template",permalink:"/docs/API-docs/createdocumentwithtemplateid"},next:{title:"Update Document",permalink:"/docs/API-docs/update-document"}},f={},g=[{value:"Request",id:"request",level:2}];function b(e){const s={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("h1",{className:"openapi__heading",children:(0,n.jsx)(s.p,{children:"Get Document"})}),"\n",(0,n.jsx)(t(),{method:"get",path:"/document/{document_id}"}),"\n",(0,n.jsx)(s.p,{children:"The Get Document API enables you to retrieve details about a specific document."}),"\n",(0,n.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,n.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,n.jsx)(s.p,{children:"Path Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsx)("ul",{children:(0,n.jsx)(c.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"objectId of Document",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,n.jsx)("div",{children:(0,n.jsx)("div",{children:(0,n.jsxs)(i.Z,{children:[(0,n.jsxs)(h.default,{label:"200",value:"200",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"successful operation"})}),(0,n.jsx)("div",{children:(0,n.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,n.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"folder"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"object"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder name"}})]})]})}),(0,n.jsx)(d.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,n.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"signers"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"object[]"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,n.jsx)(s.p,{children:"Array ["})})}),(0,n.jsx)(d.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,n.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"widgets"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"object[]"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,n.jsx)(s.p,{children:"Array ["})})}),(0,n.jsx)(d.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,n.jsx)(s.p,{children:"]"})})})]})]})}),(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,n.jsx)(s.p,{children:"]"})})})]})]})}),(0,n.jsx)(d.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!0}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!0}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"redirect_url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}})]})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(o.Z,{responseExample:'{\n "objectId": "FGik23bhUJ",\n "file": "https://exampleurl.com",\n "title": "sample doc",\n "note": "please sign document",\n "folder": {\n "objectId": "FGik23bhUJ",\n "name": "folder name"\n },\n "owner": "joe bee",\n "signers": [\n {\n "role": "ceo",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871",\n "widgets": [\n {\n "type": "signature",\n "x": 244,\n "y": 71,\n "w": 38,\n "h": 46,\n "page": 1\n }\n ]\n }\n ],\n "sendInOrder": true,\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z",\n "enableTour": true,\n "redirect_url": "",\n "allow_modifications": false\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(h.default,{label:"400",value:"400",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Something went wrong, please try again later!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(h.default,{label:"404",value:"404",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Document not found!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Document not found!"}})})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(o.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(h.default,{label:"405",value:"405",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Invalid API Token!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/fa40969b.e283f01a.js b/assets/js/fa40969b.e283f01a.js new file mode 100644 index 000000000..e1da6436a --- /dev/null +++ b/assets/js/fa40969b.e283f01a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[273],{61247:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>u,default:()=>b,frontMatter:()=>x,metadata:()=>j,toc:()=>y});var i=a(85893),n=a(11151),l=a(58219),r=(a(62316),a(51039)),t=a.n(r),m=(a(82723),a(9487)),c=a(41429),o=a(5397),d=a(4667),p=a(9472),h=a(85162);const x={id:"getdocumentlist",title:"Get Document list from status",description:"### Document Types:",sidebar_label:"Get Document list from status",hide_title:!0,hide_table_of_contents:!0,api:"eJztWN1uGzcWfpVT5qJNMJJGtpy0QrGo0WQNt8UmiF0E2FgQODNHGsYckiU5+oExd/skfbQ+yeJwZqSRJTtWW+SqN7aGPP/8zg95xzyfOzb+yF7rtCxQeccmEcvQpVYYL7RiY/bs2TNot+F6bdCNb9R79FbgAoGDFM6DnkHWioCEO8xAK/BrgzfqRg378OLFa8tnfiPJjV+8uFEAAL3tGvice+AWIS2tReXlGoSCLHA6z33p+iTvhORdqt47q+cWnftTUk3DHCSeksQfdWEkesyeIi/nC4QEUYEr0xSdm5VSriHdyFgKnwOXEiz+VgqLGTgxV9yXFmudI9L5ZmXC3lM1YkPPVRZcUhqkVnO0wIMVIpEYpJ+FmGMqhTrWoazlStbgc4TSoe3fKBYxbdBywsVlxsZsjr49dAIBi5jhlhfo0RKo7pjiBbIxy3RKSGAREwQow33O7qPsOscAl10keQ22QRqLWBtINva2xIg5v5Yk3wmKOYsYrozUGbLxjEtHBGmOBWfjOxb0j5nzVqg5UaqyINwHaAXDWjiwiG3OsBYZVJK9dVTYpKqijW9SFMK3nv1Wol3vGNoa0lg607bo2tn4sTGz4CtRkGVncRy1RquySNCyivh48HQ8jDsmuFth/jYLHtYZVxOS64xWDh3RnsQx/ds9yG02wAYtIabKo/JEz42RIg0bg0+OmO72DdDJJ0wDpCyJ8aJWadGV0nfouLWcHBYeC/d5/nqZ0LuPCQoN9zsoaX1n/74QtyenSf7rTxSTmaDF4yTk3hs3HgyaldLKfqoLkuaFP16cCz8oVUiE0v5oCUYidxiK0ibjgnNaZmi/VChrDB8nobYQAmu1DSBrvZg2LlQR00u148uT5H/SoRASP0UnVLM/CzirD5/tVluK+rFAHDQLCy7kZ6kTxB+ahRZrJtfqM2pGZy9PhqffvhoS/VJkc/R/wf96d1/fbtE4l1IvMYMFlyU66G1bZUR9vzD9z6VDS09Gr/YLWYd7s7LhPhmNqoitj+R6NaT4HMl0+m0VsfxIptFLOjk+xyP5ht3k8FgYyT1Or2pIT9ujrR6jCvnlUGWX6q3dLQuJ1hK56iqkZlJFLLXIPWbn/nGgncQnp71h3ItfXQ9fjkffjc9e9uM4/i+L2KoI6G7nB+6RdfO8+S5N9kX0oOKJxGtdPs19i5mwmPppaQ/m6GM4JnWckmFa6EzMmjbpHtcbWjwd1D13OkX9foncPXWhaLKZts19ehLH0xGRVBEbxaP9Jv8ejbYelPbAF1xIis9Xf1+XR2v1waq9DdRhCx5zahSPpmcbp872nbpUCy5FBufvLuFa36L6sh511fta/f6Zipoo7LMdZ7vrtZMO09IKvw6j+KrHjejV++OPE5rlCvS5bub4MLv7nI3ZoDvSD+6a2b1iJM8u2sk+QHsz0ziuskSv+tqgokoseeKo4wy4EYMFNZL7HNyYI6id53Oh5r1HuSZbj6/oVOrA7/i9bWJG/IzUxZqwdqmaSTpHHmaIir5nOjA3wX5rUFF9DEe1GO51sw8oU10g3V7o+tSS//G/3wNHG+CApK/gbWnB6CVaGpnpWjeTuKJrXCAOxcDBWpckziEvJDoXbrAe55Z7hEzMhecy9Eyh5pBywxMhBWGPyDRxW+jA1/XhQ44+R0tbX1u6xme4QEmQBan1LcnxGnjpdRF0tA8AS21vZ2RSBByS0glF92+H2LKgyrlKEdqziEBb4ApQebTGCofARUHEM20BZzORChJMiWZ56qHgis+RlEVAdlMUjNULkaEDq5PSeXBalsER0lgg+tpFhZi5PrwWC6wdp8UMPRcSM5iXJCKCVGd0jw55R26oDBJ0HgypFykGoc5z60HiAm3AXjhJuuKD0VQQBJd0Ve2eLQnylitHBb42qD2aTfiM1XQ7Cjoyvu4DXdWvCCylQwKAFOqWHlh68HEDsw+YOOFx8k2bD8vlci8Pnu/yXAiflwlYNHrLNw+LIWu67JuP5yxiHm3h3s6u0C5E2l5cHtA5CMSDpkzyNJTJZjalHPvhPgOVLClSVA47Re384t0vsIDTfsyiTuY/weDBL5c/vvnP1RuSS7Wpzr9hP+7HYdrVzhdcdVRd4PYJqn65mlldNG9L9xP5blv9/3kF++cVbPMK1jQRjys/MJKL0ImbYa/uoh/ZvYexcfsGNolYrp0nkrs7gsivVlYVLddPN9RcM+FonNk+3tziuvPUFC5J9az4IG3zJrQlndCHFUR7WMeDyP/mfXNyz+Epj3QHg9O2XbXuGtUa28ammtDlqO67ZGO9e56maLp+781hO8PMxZtrFjFe+ny339+Gft/8IOkHbdodBGoD6C+F+iDD99Sefsb1vzbk9c6DDI1/LTXFZ1JV1f8BGbwW1w==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/getdocumentlist",title:"Get Document list from status",description:"### Document Types:",source:"@site/docs/API-docs/getdocumentlist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getdocumentlist",permalink:"/docs/API-docs/getdocumentlist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getdocumentlist",title:"Get Document list from status",description:"### Document Types:",sidebar_label:"Get Document list from status",hide_title:!0,hide_table_of_contents:!0,api:"eJztWN1uGzcWfpVT5qJNMJJGtpy0QrGo0WQNt8UmiF0E2FgQODNHGsYckiU5+oExd/skfbQ+yeJwZqSRJTtWW+SqN7aGPP/8zg95xzyfOzb+yF7rtCxQeccmEcvQpVYYL7RiY/bs2TNot+F6bdCNb9R79FbgAoGDFM6DnkHWioCEO8xAK/BrgzfqRg378OLFa8tnfiPJjV+8uFEAAL3tGvice+AWIS2tReXlGoSCLHA6z33p+iTvhORdqt47q+cWnftTUk3DHCSeksQfdWEkesyeIi/nC4QEUYEr0xSdm5VSriHdyFgKnwOXEiz+VgqLGTgxV9yXFmudI9L5ZmXC3lM1YkPPVRZcUhqkVnO0wIMVIpEYpJ+FmGMqhTrWoazlStbgc4TSoe3fKBYxbdBywsVlxsZsjr49dAIBi5jhlhfo0RKo7pjiBbIxy3RKSGAREwQow33O7qPsOscAl10keQ22QRqLWBtINva2xIg5v5Yk3wmKOYsYrozUGbLxjEtHBGmOBWfjOxb0j5nzVqg5UaqyINwHaAXDWjiwiG3OsBYZVJK9dVTYpKqijW9SFMK3nv1Wol3vGNoa0lg607bo2tn4sTGz4CtRkGVncRy1RquySNCyivh48HQ8jDsmuFth/jYLHtYZVxOS64xWDh3RnsQx/ds9yG02wAYtIabKo/JEz42RIg0bg0+OmO72DdDJJ0wDpCyJ8aJWadGV0nfouLWcHBYeC/d5/nqZ0LuPCQoN9zsoaX1n/74QtyenSf7rTxSTmaDF4yTk3hs3HgyaldLKfqoLkuaFP16cCz8oVUiE0v5oCUYidxiK0ibjgnNaZmi/VChrDB8nobYQAmu1DSBrvZg2LlQR00u148uT5H/SoRASP0UnVLM/CzirD5/tVluK+rFAHDQLCy7kZ6kTxB+ahRZrJtfqM2pGZy9PhqffvhoS/VJkc/R/wf96d1/fbtE4l1IvMYMFlyU66G1bZUR9vzD9z6VDS09Gr/YLWYd7s7LhPhmNqoitj+R6NaT4HMl0+m0VsfxIptFLOjk+xyP5ht3k8FgYyT1Or2pIT9ujrR6jCvnlUGWX6q3dLQuJ1hK56iqkZlJFLLXIPWbn/nGgncQnp71h3ItfXQ9fjkffjc9e9uM4/i+L2KoI6G7nB+6RdfO8+S5N9kX0oOKJxGtdPs19i5mwmPppaQ/m6GM4JnWckmFa6EzMmjbpHtcbWjwd1D13OkX9foncPXWhaLKZts19ehLH0xGRVBEbxaP9Jv8ejbYelPbAF1xIis9Xf1+XR2v1waq9DdRhCx5zahSPpmcbp872nbpUCy5FBufvLuFa36L6sh511fta/f6Zipoo7LMdZ7vrtZMO09IKvw6j+KrHjejV++OPE5rlCvS5bub4MLv7nI3ZoDvSD+6a2b1iJM8u2sk+QHsz0ziuskSv+tqgokoseeKo4wy4EYMFNZL7HNyYI6id53Oh5r1HuSZbj6/oVOrA7/i9bWJG/IzUxZqwdqmaSTpHHmaIir5nOjA3wX5rUFF9DEe1GO51sw8oU10g3V7o+tSS//G/3wNHG+CApK/gbWnB6CVaGpnpWjeTuKJrXCAOxcDBWpckziEvJDoXbrAe55Z7hEzMhecy9Eyh5pBywxMhBWGPyDRxW+jA1/XhQ44+R0tbX1u6xme4QEmQBan1LcnxGnjpdRF0tA8AS21vZ2RSBByS0glF92+H2LKgyrlKEdqziEBb4ApQebTGCofARUHEM20BZzORChJMiWZ56qHgis+RlEVAdlMUjNULkaEDq5PSeXBalsER0lgg+tpFhZi5PrwWC6wdp8UMPRcSM5iXJCKCVGd0jw55R26oDBJ0HgypFykGoc5z60HiAm3AXjhJuuKD0VQQBJd0Ve2eLQnylitHBb42qD2aTfiM1XQ7Cjoyvu4DXdWvCCylQwKAFOqWHlh68HEDsw+YOOFx8k2bD8vlci8Pnu/yXAiflwlYNHrLNw+LIWu67JuP5yxiHm3h3s6u0C5E2l5cHtA5CMSDpkzyNJTJZjalHPvhPgOVLClSVA47Re384t0vsIDTfsyiTuY/weDBL5c/vvnP1RuSS7Wpzr9hP+7HYdrVzhdcdVRd4PYJqn65mlldNG9L9xP5blv9/3kF++cVbPMK1jQRjys/MJKL0ImbYa/uoh/ZvYexcfsGNolYrp0nkrs7gsivVlYVLddPN9RcM+FonNk+3tziuvPUFC5J9az4IG3zJrQlndCHFUR7WMeDyP/mfXNyz+Epj3QHg9O2XbXuGtUa28ammtDlqO67ZGO9e56maLp+781hO8PMxZtrFjFe+ny339+Gft/8IOkHbdodBGoD6C+F+iDD99Sefsb1vzbk9c6DDI1/LTXFZ1JV1f8BGbwW1w==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete Document",permalink:"/docs/API-docs/deletedocument"},next:{title:"Resend request mail",permalink:"/docs/API-docs/resendrequestmail"}},f={},y=[{value:"Document Types:",id:"document-types",level:3},{value:"Request",id:"request",level:2}];function g(e){const s={h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,n.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(s.p,{children:"Get Document list from status"})}),"\n",(0,i.jsx)(t(),{method:"get",path:"/documentlist/{doctype}"}),"\n",(0,i.jsx)(s.h3,{id:"document-types",children:"Document Types:"}),"\n",(0,i.jsx)(s.p,{children:"Retrieve a list of documents based on type"}),"\n",(0,i.jsxs)(s.ol,{children:["\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.strong,{children:"Draft Documents:"})}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Documents that are currently in draft status."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.strong,{children:"In-Progress Documents:"})}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Documents that are currently in progress."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.strong,{children:"Completed Documents:"})}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Documents that have been successfully completed with all required signatures."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.strong,{children:"Expired Documents:"})}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Documents that have expired and are no longer accessible."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.strong,{children:"Declined Documents:"})}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Documents that have been declined by the user."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,i.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(s.p,{children:"Path Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsx)("ul",{children:(0,i.jsx)(c.Z,{className:"paramsItem",param:{name:"doctype",in:"path",description:"The type of documents to retrieve",required:!0,style:"simple",explode:!1,schema:{type:"string",enum:["draft","inprogress","completed","expired","declined"]}}})})})]}),"\n",(0,i.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(s.p,{children:"Query Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsxs)("ul",{children:[(0,i.jsx)(c.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,i.jsx)(c.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(l.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"successful operation"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"result"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"document[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"folder"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"object"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder name"}})]})]})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!0}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!0}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"redirect_url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "result": [\n {\n "objectId": "FGik23bhUJ",\n "file": "https://exampleurl.com",\n "title": "sample doc",\n "note": "please sign document",\n "folder": {\n "objectId": "FGik23bhUJ",\n "name": "folder name"\n },\n "owner": "joe bee",\n "signers": [\n {\n "role": "ceo",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871",\n "widgets": [\n {\n "type": "signature",\n "x": 244,\n "y": 71,\n "w": 38,\n "h": 46,\n "page": 1\n }\n ]\n }\n ],\n "sendInOrder": true,\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z",\n "enableTour": true,\n "redirect_url": "",\n "allow_modifications": false\n }\n ]\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"404",value:"404",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Report not available!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Report not available!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "error": "Report not available!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/fa40969b.e9a4c1eb.js b/assets/js/fa40969b.e9a4c1eb.js deleted file mode 100644 index 0e89aa69b..000000000 --- a/assets/js/fa40969b.e9a4c1eb.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[273],{61247:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>j,toc:()=>y});var i=a(85893),l=a(11151),n=a(58219),r=(a(62316),a(51039)),t=a.n(r),c=(a(82723),a(9487)),m=a(41429),o=a(5397),d=a(4667),p=a(9472),h=a(85162);const u={id:"getdocumentlist",title:"Get Document list from status",description:"### Document Types:",sidebar_label:"Get Document list from status",hide_title:!0,hide_table_of_contents:!0,api:"eJztGNtu20b2V6aThzYBJVG2nHSFYlGjyXq97TZB7CJAY0EYkkfixMOZ6cyhLjD4tl+yn7ZfsjhDUqIs2bHaIk99scWZc7/PueMo5p6PP/LXJi0L0Oj5JOIZ+NRJi9JoPubPnj1j7TW7Xlvw4xv9HtBJWAATTEmPzMxY1pJgifCQMaMZri3c6Bs97LMXL147McMNJT9+8eJGM8ZYb3vGMBfIhAOWls6BRrVmUrMsYHoUWPo+0Tshepe6986ZuQPvfxdV2yAHiqdE8QdTWAUI2VPo5WIBLAHQzJdpCt7PSqXWLN3QWErMmVCKOfitlA4y5uVcCywd1DxHxPPNyoa7p3KEBl7oLKikDVNGz8ExEaSQiYJA/SzYHFIl9bEKZS1WsmaYAys9uP6N5hE3FpyguLjM+JjPAVunUxDwiFvhRAEIjoLqjmtRAB/zzKQUCTzikgLKCsz5/Si7ziGEy24koWGuiTQe8daQfIyuhIh7XCui7yXZnEccVlaZDPh4JpQngDSHQvDxHQ/8x9yjk3pOkLosKO5DaAXB2nDgEd/4sCYZWJK8tVX4pKqijW5KFhJbzX4rwa13BG0FaSSdGVd05Wz02IhZiJUsSLKzOI5aoXVZJOB4RXgiaDoexh0R/K20f5oED/OMqwnR9dZoD55gT+KY/u06cpsNbBMtwaYaQSPBC2uVTMPF4JMnpLt9AUzyCdIQUo7IoKxZOvClwg6ccE6QwhKh8J/Hr48pevdjgkwjcCdKWt35Py7k7clpkv/yL7LJTNLhcRRyROvHg0FzUjrVT01B1FDi8eR8+EGpQiS0waMpWAXCQyhKm4wLyhmVgftSpqxj+DgKtYQsoFZbA/JWi2mjQhVxs9Q7ujyJ/icTCiHhk3VCNfu9AefMYd9uuaVgHjPEQbGgEFJ9FjoB+L45aGPN5kZ/hs3o7OXJ8PTbV0OCX8psDvgH9K9v9/ntFo1zpcwSMrYQqgTPettWGVHfL2z/c+nQwpPQq/1C1sHenGywT0ajKuLrI7FeDck+RyKdfltFPD8SafSSPCfmcCTesJscCIVVAmF6VYf0tHVt9RhUyC8POrvUb91uWUiMUSB0lyE1kyriqQOBkJ3j44F2Ep+c9oZxL351PXw5Hv1tfPayH8fxrzziqyJEdzs/CATezfPmu7TZF+EDWiQKrk35NPUdZNJBitPSHczRx+KY2AlKhmlhMjlr2qR/nG9o8eSoe+p0ivr9Ernrdalpspm2zX16EsfTEYFUER/Fo/0m/x6scci0QSYWQiqyz1d/XpcH58zBqr011GEJHlNqFI+mZxulzvaVutQLoWTGzt9dsmtzC/rLatRljzX7fZ/KGijc8x1lu+e1kh7S0klch1F81RNW9ur78ccJzXIFYG6aOT7M7pjzMR90R/rBXTO7V5zouUU72e9a7mop5nNw/yyTIP15iYb926S3tYohDTbzz0I6rCn1fY2Wlwm1p8E7J+gN9bNY3Ao3MBb0YNiP+zGnWXeXiBc6S8yqT0BU+pVIfKAhrBwshgcwhLVHQHsUc6nnvUexJlsTX1EY1J7eMfS2a1r5I1DbbPzYhWpG9xxEGFoq+p6ZgNx4960FTQU5WHcx3GufH0ClpgB6LtF7rQX/33/+GzBaj4bQ/Yq9LR2zZgmOZnR6R84UrOjdGIBD9fFsbUoi50EUCrwPT2aEuRMILJNziUKFJi31nKXCikQqScFOYIawHevki++zDzlgDo6uvna0N8hgAYpyhCljKFSInyjRFIFHu3FYGnc7I5EiJlhSeqnpwe8BWhTQudApsNYXETOOCc1AIzjrpAcmZEHAM+MYzGYylUSYMtuJFFkhtJgDMYsYyU1WsM4sZAaeOZOUHpk3qgyKEMcCAGsVNUDm++y1XECtOB1mgEIqyNi8JBIRS01GD/eQ6KSGzlgCHpkl9jKFQNSjcMgULMCF2AuepHxg1lAFkkLR27jrWyKETmhPHaUWqHXNxnzWGXqOBR6ZWPcZ7QauKFhKDxQASupb2uj02MdNmH2AxEuEyTdtPiyXy708eL6LcyExLxPmwJot3jwchqzpom8+nvOII7jCv51dgVvItH0pPcBzEIAHTV0WaajLzTBMOfb9fQSqkUqmoD10quj5xbuf2IKd9uOd8vQEgQc/Xf7w5uerN0SXimGdf22Z4tZ4LITusLqA7c6rXpXNnCmaZdb9RL7btpu/1m5/rd02a7emiSCscGCVkKH1N9Nl3bY/8nubuHG7dJtEPDceCeTujkLkF6eqio7rXVHo5tLT/LTdFt3CurPbCq+yejh9ELZZQm1BJ/ThJMEe5vFg5H/zvvHcc/aUreBB47RtV6+7QrXCtrapJvQaq/suyVjfnqcp2K7ee4PfzvR08eaaR1yUmO/2+9vQ75sfRP2gTLuDQC0A/SVTH0T4jtrTj7D++wa8vnkQodGvhSb7TKqq+j+w6j6C",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/getdocumentlist",title:"Get Document list from status",description:"### Document Types:",source:"@site/docs/API-docs/getdocumentlist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getdocumentlist",permalink:"/docs/API-docs/getdocumentlist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getdocumentlist",title:"Get Document list from status",description:"### Document Types:",sidebar_label:"Get Document list from status",hide_title:!0,hide_table_of_contents:!0,api:"eJztGNtu20b2V6aThzYBJVG2nHSFYlGjyXq97TZB7CJAY0EYkkfixMOZ6cyhLjD4tl+yn7ZfsjhDUqIs2bHaIk99scWZc7/PueMo5p6PP/LXJi0L0Oj5JOIZ+NRJi9JoPubPnj1j7TW7Xlvw4xv9HtBJWAATTEmPzMxY1pJgifCQMaMZri3c6Bs97LMXL147McMNJT9+8eJGM8ZYb3vGMBfIhAOWls6BRrVmUrMsYHoUWPo+0Tshepe6986ZuQPvfxdV2yAHiqdE8QdTWAUI2VPo5WIBLAHQzJdpCt7PSqXWLN3QWErMmVCKOfitlA4y5uVcCywd1DxHxPPNyoa7p3KEBl7oLKikDVNGz8ExEaSQiYJA/SzYHFIl9bEKZS1WsmaYAys9uP6N5hE3FpyguLjM+JjPAVunUxDwiFvhRAEIjoLqjmtRAB/zzKQUCTzikgLKCsz5/Si7ziGEy24koWGuiTQe8daQfIyuhIh7XCui7yXZnEccVlaZDPh4JpQngDSHQvDxHQ/8x9yjk3pOkLosKO5DaAXB2nDgEd/4sCYZWJK8tVX4pKqijW5KFhJbzX4rwa13BG0FaSSdGVd05Wz02IhZiJUsSLKzOI5aoXVZJOB4RXgiaDoexh0R/K20f5oED/OMqwnR9dZoD55gT+KY/u06cpsNbBMtwaYaQSPBC2uVTMPF4JMnpLt9AUzyCdIQUo7IoKxZOvClwg6ccE6QwhKh8J/Hr48pevdjgkwjcCdKWt35Py7k7clpkv/yL7LJTNLhcRRyROvHg0FzUjrVT01B1FDi8eR8+EGpQiS0waMpWAXCQyhKm4wLyhmVgftSpqxj+DgKtYQsoFZbA/JWi2mjQhVxs9Q7ujyJ/icTCiHhk3VCNfu9AefMYd9uuaVgHjPEQbGgEFJ9FjoB+L45aGPN5kZ/hs3o7OXJ8PTbV0OCX8psDvgH9K9v9/ntFo1zpcwSMrYQqgTPettWGVHfL2z/c+nQwpPQq/1C1sHenGywT0ajKuLrI7FeDck+RyKdfltFPD8SafSSPCfmcCTesJscCIVVAmF6VYf0tHVt9RhUyC8POrvUb91uWUiMUSB0lyE1kyriqQOBkJ3j44F2Ep+c9oZxL351PXw5Hv1tfPayH8fxrzziqyJEdzs/CATezfPmu7TZF+EDWiQKrk35NPUdZNJBitPSHczRx+KY2AlKhmlhMjlr2qR/nG9o8eSoe+p0ivr9Ernrdalpspm2zX16EsfTEYFUER/Fo/0m/x6scci0QSYWQiqyz1d/XpcH58zBqr011GEJHlNqFI+mZxulzvaVutQLoWTGzt9dsmtzC/rLatRljzX7fZ/KGijc8x1lu+e1kh7S0klch1F81RNW9ur78ccJzXIFYG6aOT7M7pjzMR90R/rBXTO7V5zouUU72e9a7mop5nNw/yyTIP15iYb926S3tYohDTbzz0I6rCn1fY2Wlwm1p8E7J+gN9bNY3Ao3MBb0YNiP+zGnWXeXiBc6S8yqT0BU+pVIfKAhrBwshgcwhLVHQHsUc6nnvUexJlsTX1EY1J7eMfS2a1r5I1DbbPzYhWpG9xxEGFoq+p6ZgNx4960FTQU5WHcx3GufH0ClpgB6LtF7rQX/33/+GzBaj4bQ/Yq9LR2zZgmOZnR6R84UrOjdGIBD9fFsbUoi50EUCrwPT2aEuRMILJNziUKFJi31nKXCikQqScFOYIawHevki++zDzlgDo6uvna0N8hgAYpyhCljKFSInyjRFIFHu3FYGnc7I5EiJlhSeqnpwe8BWhTQudApsNYXETOOCc1AIzjrpAcmZEHAM+MYzGYylUSYMtuJFFkhtJgDMYsYyU1WsM4sZAaeOZOUHpk3qgyKEMcCAGsVNUDm++y1XECtOB1mgEIqyNi8JBIRS01GD/eQ6KSGzlgCHpkl9jKFQNSjcMgULMCF2AuepHxg1lAFkkLR27jrWyKETmhPHaUWqHXNxnzWGXqOBR6ZWPcZ7QauKFhKDxQASupb2uj02MdNmH2AxEuEyTdtPiyXy708eL6LcyExLxPmwJot3jwchqzpom8+nvOII7jCv51dgVvItH0pPcBzEIAHTV0WaajLzTBMOfb9fQSqkUqmoD10quj5xbuf2IKd9uOd8vQEgQc/Xf7w5uerN0SXimGdf22Z4tZ4LITusLqA7c6rXpXNnCmaZdb9RL7btpu/1m5/rd02a7emiSCscGCVkKH1N9Nl3bY/8nubuHG7dJtEPDceCeTujkLkF6eqio7rXVHo5tLT/LTdFt3CurPbCq+yejh9ELZZQm1BJ/ThJMEe5vFg5H/zvvHcc/aUreBB47RtV6+7QrXCtrapJvQaq/suyVjfnqcp2K7ee4PfzvR08eaaR1yUmO/2+9vQ75sfRP2gTLuDQC0A/SVTH0T4jtrTj7D++wa8vnkQodGvhSb7TKqq+j+w6j6C",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete Document",permalink:"/docs/API-docs/deletedocument"},next:{title:"Resend request mail",permalink:"/docs/API-docs/resendrequestmail"}},g={},y=[{value:"Document Types:",id:"document-types",level:3},{value:"Request",id:"request",level:2}];function f(e){const s={h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,l.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(s.p,{children:"Get Document list from status"})}),"\n",(0,i.jsx)(t(),{method:"get",path:"/documentlist/{doctype}"}),"\n",(0,i.jsx)(s.h3,{id:"document-types",children:"Document Types:"}),"\n",(0,i.jsx)(s.p,{children:"Retrieve a list of documents based on type"}),"\n",(0,i.jsxs)(s.ol,{children:["\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.strong,{children:"Draft Documents:"})}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Documents that are currently in draft status."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.strong,{children:"In-Progress Documents:"})}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Documents that are currently in progress."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.strong,{children:"Completed Documents:"})}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Documents that have been successfully completed with all required signatures."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.strong,{children:"Expired Documents:"})}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Documents that have expired and are no longer accessible."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.strong,{children:"Declined Documents:"})}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Documents that have been declined by the user."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,i.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(s.p,{children:"Path Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsx)("ul",{children:(0,i.jsx)(m.Z,{className:"paramsItem",param:{name:"doctype",in:"path",description:"The type of documents to retrieve",required:!0,style:"simple",explode:!1,schema:{type:"string",enum:["draft","inprogress","completed","expired","declined"]}}})})})]}),"\n",(0,i.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(s.p,{children:"Query Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsxs)("ul",{children:[(0,i.jsx)(m.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,i.jsx)(m.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(n.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"successful operation"})}),(0,i.jsx)("div",{children:(0,i.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"result"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"document[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"folder"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"object"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder name"}})]})]})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!0}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!0}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"redirect_url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "result": [\n {\n "objectId": "FGik23bhUJ",\n "file": "https://exampleurl.com",\n "title": "sample doc",\n "note": "please sign document",\n "folder": {\n "objectId": "FGik23bhUJ",\n "name": "folder name"\n },\n "owner": "joe bee",\n "signers": [\n {\n "role": "ceo",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871",\n "widgets": [\n {\n "type": "signature",\n "x": 244,\n "y": 71,\n "w": 38,\n "h": 46,\n "page": 1\n }\n ]\n }\n ],\n "sendInOrder": true,\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z",\n "enableTour": true,\n "redirect_url": "",\n "allow_modifications": false\n }\n ]\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"404",value:"404",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Report not available!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Report not available!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "error": "Report not available!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.0f6d8860.js b/assets/js/runtime~main.a74dc2c1.js similarity index 67% rename from assets/js/runtime~main.0f6d8860.js rename to assets/js/runtime~main.a74dc2c1.js index de54f91f7..145f18c1b 100644 --- a/assets/js/runtime~main.0f6d8860.js +++ b/assets/js/runtime~main.a74dc2c1.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,c,f,b,d={},r={};function t(e){var a=r[e];if(void 0!==a)return a.exports;var c=r[e]={id:e,loaded:!1,exports:{}};return d[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=d,t.c=r,e=[],t.O=(a,c,f,b)=>{if(!c){var d=1/0;for(n=0;n=b)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(r=!1,b0&&e[n-1][2]>b;n--)e[n]=e[n-1];e[n]=[c,f,b]},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 b=Object.create(null);t.r(b);var d={};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=>d[a]=()=>e[a]));return d.default=()=>e,t.d(b,d),b},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce(((a,c)=>(t.f[c](e,a),a)),[])),t.u=e=>"assets/js/"+({53:"935f2afb",110:"66406991",230:"d91ad230",261:"reactPlayerKaltura",273:"fa40969b",339:"4f7a2d40",420:"e2c87691",453:"30a24c52",470:"299c7a47",533:"b2b675dd",762:"d8b805fb",792:"50ea61d6",823:"c7b98810",835:"ab2a161b",841:"c5e4dae0",853:"277a78f5",869:"b18842e4",948:"8717b14a",1001:"8001f939",1332:"f0ff4a36",1477:"b2f554cd",1512:"e9e778b7",1520:"770b40a9",1531:"bbdfc22d",1633:"031793e1",1653:"42f80fc5",1713:"a7023ddc",1773:"ef5d5d5d",1893:"4c5e977b",1914:"d9f32620",2087:"bfe4b778",2121:"reactPlayerFacebook",2125:"f214d5ff",2207:"78b2b753",2213:"1c822755",2241:"2ace9d1d",2245:"a2bc1463",2267:"59362658",2362:"e273c56f",2535:"814f3328",2542:"5ce9853b",2546:"reactPlayerStreamable",2617:"56b5f4f8",2832:"1f73ca32",2865:"3e02da86",3e3:"1ee58ee1",3085:"1f391b9e",3089:"a6aa9e1f",3101:"64ee8796",3156:"11b7b3d8",3205:"a80da1cf",3495:"8a855f99",3514:"73664a40",3554:"5e1bb91e",3608:"9e4087bc",3743:"reactPlayerVimeo",3965:"reactPlayerVidyard",4013:"01a85c17",4195:"c4f5d8e4",4277:"14716de7",4368:"a94703ab",4439:"reactPlayerYouTube",4478:"d1393a72",4641:"ada7accb",4651:"05632a52",4667:"reactPlayerMixcloud",4772:"b0378e01",4918:"1f7895dc",4930:"ae010e44",4955:"e226bb09",4985:"b839bf37",5377:"ce589067",5507:"8320e026",5858:"046910c8",5900:"38e3d9c8",6011:"reactPlayerFilePlayer",6033:"28b19cd2",6103:"ccc49370",6113:"13fdae3b",6125:"reactPlayerSoundCloud",6177:"611db08b",6216:"reactPlayerTwitch",6238:"e76c28ee",6344:"984cf7cf",6543:"17e5210b",6759:"c9fa5aa5",6938:"608ae6a4",7100:"2c416566",7178:"096bfee4",7286:"451a5132",7414:"393be207",7475:"500027af",7596:"reactPlayerDailyMotion",7664:"reactPlayerPreview",7816:"06577f20",7894:"a88a3db3",7917:"0028a090",7964:"2304e9ae",7971:"8a725248",8055:"reactPlayerWistia",8087:"e4f5c862",8106:"377084eb",8141:"98da7451",8163:"5a2de241",8215:"e5a49157",8468:"52d5c0f9",8474:"9640838e",8489:"7b076186",8518:"a7bd4aaa",8610:"6875c492",8636:"f4f34a3a",8766:"70853c19",8781:"489b8a4d",8784:"83cab870",8866:"eb56c656",8878:"cf03142d",8888:"a9f09360",8892:"38ec836e",9003:"925b3f96",9010:"06b6ef6a",9035:"4c9e35b1",9588:"5c04ee3b",9642:"7661071f",9661:"5e95c892",9671:"0e384e19",9697:"2c586be5",9700:"e16015ca",9817:"14eb3368",9914:"0c0943c7"}[e]||e)+"."+{53:"56191834",110:"ab20026d",230:"3cc5e6e9",261:"4b30f79b",273:"e9a4c1eb",339:"d942a670",420:"3b683e17",453:"61f3e45f",470:"2cdb00ea",533:"2d5f5b1d",762:"74ae2291",792:"eda05c15",823:"64f8e5be",835:"ced0e4f6",841:"b9d70538",853:"6965f6a9",869:"52040461",948:"b2da1fd1",1001:"50ee673e",1332:"d1136268",1477:"b31b2642",1512:"9637e502",1520:"f67103b7",1531:"c296f0c4",1633:"d8366831",1653:"24ec49aa",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2087:"953e8551",2121:"c8df990c",2125:"9a2b70d2",2207:"6a17860a",2213:"d47dd20f",2241:"5104cb4f",2245:"7b31efc4",2267:"a4846e2b",2362:"ebdb1814",2529:"2079a565",2535:"f3b6b0ab",2542:"efeea564",2546:"665b04f4",2617:"56321ade",2832:"03dc5da3",2865:"eca1c9d2",3e3:"8c874417",3085:"e5c5d651",3089:"84b5c675",3101:"47959e32",3156:"41df5616",3205:"af75d475",3495:"64ee91b4",3514:"b2437ac4",3554:"e5046f78",3608:"0e768bf1",3743:"2ede10ee",3965:"f3db8112",4013:"e5e25f55",4148:"483fa267",4195:"08242eba",4277:"69395083",4311:"86f3bfc6",4368:"7d12b1da",4439:"6a6454f7",4478:"a41784da",4641:"4c376fed",4651:"3fd7ce82",4667:"c24bbf43",4682:"18721add",4772:"07189a34",4918:"7f3b7e65",4930:"9a975364",4955:"8f728b1e",4985:"dad32c3b",5377:"ccefc9dc",5507:"36c41078",5858:"bbab5814",5900:"e113e88d",6011:"6de743c9",6033:"339692dc",6103:"ebc8482f",6113:"f0293d27",6125:"9555c68b",6177:"443de2fe",6216:"0d890761",6238:"a8542bf5",6344:"962bbb02",6543:"7f67a86f",6759:"c81d0e01",6938:"d44251bf",7100:"dfa7c53a",7178:"9a58922d",7286:"96a74160",7414:"8d31e6a7",7475:"6502681d",7596:"95bca972",7664:"7fd4bae6",7816:"38bd8c71",7894:"cfc4bd5c",7917:"a380af4b",7964:"0fd4454c",7971:"a9980afb",8055:"27482879",8087:"b9e4a7cc",8106:"9fbdad2a",8140:"901b2f91",8141:"81bec72f",8163:"cdeb663e",8215:"c6b04c16",8468:"bfb8a30b",8474:"8043eb00",8475:"d27b3009",8489:"cd43640b",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8766:"77dd1140",8781:"f4c6405c",8784:"fb16cf6f",8866:"381cdff2",8878:"0d381461",8888:"7b2c4570",8892:"7315f43d",9003:"1e8e0783",9010:"09a7d359",9035:"37598b09",9588:"88bc73b1",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"27d9bbd6",9700:"ad032cc8",9817:"424c677a",9914:"8bf8d5ee"}[e]+".js",t.miniCssF=e=>{},t.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),f={},b="OpenSign-Docs:",t.l=(e,a,c,d)=>{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 b=f[e];if(delete f[e],r.parentNode&&r.parentNode.removeChild(r),b&&b.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:r}),12e4);r.onerror=u.bind(null,r.onerror),r.onload=u.bind(null,r.onload),o&&document.head.appendChild(r)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),t.p="/",t.gca=function(e){return e={59362658:"2267",66406991:"110","935f2afb":"53",d91ad230:"230",reactPlayerKaltura:"261",fa40969b:"273","4f7a2d40":"339",e2c87691:"420","30a24c52":"453","299c7a47":"470",b2b675dd:"533",d8b805fb:"762","50ea61d6":"792",c7b98810:"823",ab2a161b:"835",c5e4dae0:"841","277a78f5":"853",b18842e4:"869","8717b14a":"948","8001f939":"1001",f0ff4a36:"1332",b2f554cd:"1477",e9e778b7:"1512","770b40a9":"1520",bbdfc22d:"1531","031793e1":"1633","42f80fc5":"1653",a7023ddc:"1713",ef5d5d5d:"1773","4c5e977b":"1893",d9f32620:"1914",bfe4b778:"2087",reactPlayerFacebook:"2121",f214d5ff:"2125","78b2b753":"2207","1c822755":"2213","2ace9d1d":"2241",a2bc1463:"2245",e273c56f:"2362","814f3328":"2535","5ce9853b":"2542",reactPlayerStreamable:"2546","56b5f4f8":"2617","1f73ca32":"2832","3e02da86":"2865","1ee58ee1":"3000","1f391b9e":"3085",a6aa9e1f:"3089","64ee8796":"3101","11b7b3d8":"3156",a80da1cf:"3205","8a855f99":"3495","73664a40":"3514","5e1bb91e":"3554","9e4087bc":"3608",reactPlayerVimeo:"3743",reactPlayerVidyard:"3965","01a85c17":"4013",c4f5d8e4:"4195","14716de7":"4277",a94703ab:"4368",reactPlayerYouTube:"4439",d1393a72:"4478",ada7accb:"4641","05632a52":"4651",reactPlayerMixcloud:"4667",b0378e01:"4772","1f7895dc":"4918",ae010e44:"4930",e226bb09:"4955",b839bf37:"4985",ce589067:"5377","8320e026":"5507","046910c8":"5858","38e3d9c8":"5900",reactPlayerFilePlayer:"6011","28b19cd2":"6033",ccc49370:"6103","13fdae3b":"6113",reactPlayerSoundCloud:"6125","611db08b":"6177",reactPlayerTwitch:"6216",e76c28ee:"6238","984cf7cf":"6344","17e5210b":"6543",c9fa5aa5:"6759","608ae6a4":"6938","2c416566":"7100","096bfee4":"7178","451a5132":"7286","393be207":"7414","500027af":"7475",reactPlayerDailyMotion:"7596",reactPlayerPreview:"7664","06577f20":"7816",a88a3db3:"7894","0028a090":"7917","2304e9ae":"7964","8a725248":"7971",reactPlayerWistia:"8055",e4f5c862:"8087","377084eb":"8106","98da7451":"8141","5a2de241":"8163",e5a49157:"8215","52d5c0f9":"8468","9640838e":"8474","7b076186":"8489",a7bd4aaa:"8518","6875c492":"8610",f4f34a3a:"8636","70853c19":"8766","489b8a4d":"8781","83cab870":"8784",eb56c656:"8866",cf03142d:"8878",a9f09360:"8888","38ec836e":"8892","925b3f96":"9003","06b6ef6a":"9010","4c9e35b1":"9035","5c04ee3b":"9588","7661071f":"9642","5e95c892":"9661","0e384e19":"9671","2c586be5":"9697",e16015ca:"9700","14eb3368":"9817","0c0943c7":"9914"}[e]||e,t.p+t.u(e)},(()=>{var e={1303:0,532:0};t.f.j=(a,c)=>{var f=t.o(e,a)?e[a]:void 0;if(0!==f)if(f)c.push(f[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var b=new Promise(((c,b)=>f=e[a]=[c,b]));c.push(f[2]=b);var d=t.p+t.u(a),r=new Error;t.l(d,(c=>{if(t.o(e,a)&&(0!==(f=e[a])&&(e[a]=void 0),f)){var b=c&&("load"===c.type?"missing":c.type),d=c&&c.target&&c.target.src;r.message="Loading chunk "+a+" failed.\n("+b+": "+d+")",r.name="ChunkLoadError",r.type=b,r.request=d,f[1](r)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var f,b,d=c[0],r=c[1],o=c[2],l=0;if(d.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,b,d,f={},r={};function t(e){var a=r[e];if(void 0!==a)return a.exports;var c=r[e]={id:e,loaded:!1,exports:{}};return f[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=f,t.c=r,e=[],t.O=(a,c,b,d)=>{if(!c){var f=1/0;for(n=0;n=d)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(r=!1,d0&&e[n-1][2]>d;n--)e[n]=e[n-1];e[n]=[c,b,d]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,b){if(1&b&&(e=this(e)),8&b)return e;if("object"==typeof e&&e){if(4&b&&e.__esModule)return e;if(16&b&&"function"==typeof e.then)return e}var d=Object.create(null);t.r(d);var f={};a=a||[null,c({}),c([]),c(c)];for(var r=2&b&&e;"object"==typeof r&&!~a.indexOf(r);r=c(r))Object.getOwnPropertyNames(r).forEach((a=>f[a]=()=>e[a]));return f.default=()=>e,t.d(d,f),d},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce(((a,c)=>(t.f[c](e,a),a)),[])),t.u=e=>"assets/js/"+({53:"935f2afb",110:"66406991",230:"d91ad230",261:"reactPlayerKaltura",273:"fa40969b",339:"4f7a2d40",420:"e2c87691",453:"30a24c52",470:"299c7a47",533:"b2b675dd",762:"d8b805fb",792:"50ea61d6",823:"c7b98810",835:"ab2a161b",841:"c5e4dae0",853:"277a78f5",869:"b18842e4",948:"8717b14a",1001:"8001f939",1332:"f0ff4a36",1477:"b2f554cd",1512:"e9e778b7",1520:"770b40a9",1531:"bbdfc22d",1633:"031793e1",1653:"42f80fc5",1713:"a7023ddc",1773:"ef5d5d5d",1893:"4c5e977b",1914:"d9f32620",2087:"bfe4b778",2121:"reactPlayerFacebook",2125:"f214d5ff",2207:"78b2b753",2213:"1c822755",2241:"2ace9d1d",2245:"a2bc1463",2267:"59362658",2362:"e273c56f",2535:"814f3328",2542:"5ce9853b",2546:"reactPlayerStreamable",2617:"56b5f4f8",2832:"1f73ca32",2865:"3e02da86",3e3:"1ee58ee1",3085:"1f391b9e",3089:"a6aa9e1f",3101:"64ee8796",3156:"11b7b3d8",3205:"a80da1cf",3495:"8a855f99",3514:"73664a40",3554:"5e1bb91e",3608:"9e4087bc",3743:"reactPlayerVimeo",3965:"reactPlayerVidyard",4013:"01a85c17",4195:"c4f5d8e4",4277:"14716de7",4368:"a94703ab",4439:"reactPlayerYouTube",4478:"d1393a72",4641:"ada7accb",4651:"05632a52",4667:"reactPlayerMixcloud",4772:"b0378e01",4918:"1f7895dc",4930:"ae010e44",4955:"e226bb09",4985:"b839bf37",5377:"ce589067",5507:"8320e026",5858:"046910c8",5900:"38e3d9c8",6011:"reactPlayerFilePlayer",6033:"28b19cd2",6103:"ccc49370",6113:"13fdae3b",6125:"reactPlayerSoundCloud",6177:"611db08b",6216:"reactPlayerTwitch",6238:"e76c28ee",6344:"984cf7cf",6543:"17e5210b",6759:"c9fa5aa5",6938:"608ae6a4",7100:"2c416566",7178:"096bfee4",7286:"451a5132",7414:"393be207",7475:"500027af",7596:"reactPlayerDailyMotion",7664:"reactPlayerPreview",7816:"06577f20",7894:"a88a3db3",7917:"0028a090",7964:"2304e9ae",7971:"8a725248",8055:"reactPlayerWistia",8087:"e4f5c862",8106:"377084eb",8141:"98da7451",8163:"5a2de241",8215:"e5a49157",8468:"52d5c0f9",8474:"9640838e",8489:"7b076186",8518:"a7bd4aaa",8610:"6875c492",8636:"f4f34a3a",8766:"70853c19",8781:"489b8a4d",8784:"83cab870",8866:"eb56c656",8878:"cf03142d",8888:"a9f09360",8892:"38ec836e",9003:"925b3f96",9010:"06b6ef6a",9035:"4c9e35b1",9588:"5c04ee3b",9642:"7661071f",9661:"5e95c892",9671:"0e384e19",9697:"2c586be5",9700:"e16015ca",9817:"14eb3368",9914:"0c0943c7"}[e]||e)+"."+{53:"56191834",110:"ab20026d",230:"3cc5e6e9",261:"4b30f79b",273:"e283f01a",339:"d942a670",420:"3b683e17",453:"61f3e45f",470:"2cdb00ea",533:"2d5f5b1d",762:"74ae2291",792:"eda05c15",823:"64f8e5be",835:"ced0e4f6",841:"b9d70538",853:"6965f6a9",869:"52040461",948:"b2da1fd1",1001:"50ee673e",1332:"28386b54",1477:"b31b2642",1512:"9637e502",1520:"523b2d80",1531:"3855f22e",1633:"d8366831",1653:"24ec49aa",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2087:"6b36ff91",2121:"c8df990c",2125:"9a2b70d2",2207:"f380f604",2213:"d47dd20f",2241:"5104cb4f",2245:"a7b94822",2267:"a4846e2b",2362:"ebdb1814",2529:"2079a565",2535:"f3b6b0ab",2542:"28eaefb4",2546:"665b04f4",2617:"56321ade",2832:"e34356e0",2865:"eca1c9d2",3e3:"8c874417",3085:"e5c5d651",3089:"84b5c675",3101:"47959e32",3156:"41df5616",3205:"af75d475",3495:"4657d57d",3514:"b2437ac4",3554:"e5046f78",3608:"0e768bf1",3743:"2ede10ee",3965:"f3db8112",4013:"e5e25f55",4148:"483fa267",4195:"08242eba",4277:"69395083",4311:"86f3bfc6",4368:"7d12b1da",4439:"6a6454f7",4478:"a41784da",4641:"40681dfc",4651:"8538abf4",4667:"c24bbf43",4682:"18721add",4772:"07189a34",4918:"7f3b7e65",4930:"a965d111",4955:"8f728b1e",4985:"dad32c3b",5377:"ccefc9dc",5507:"36c41078",5858:"bbab5814",5900:"e113e88d",6011:"6de743c9",6033:"5f8c6828",6103:"ebc8482f",6113:"53df0513",6125:"9555c68b",6177:"443de2fe",6216:"0d890761",6238:"a8542bf5",6344:"962bbb02",6543:"7f67a86f",6759:"c81d0e01",6938:"d44251bf",7100:"dfa7c53a",7178:"9a58922d",7286:"0072a94c",7414:"8d31e6a7",7475:"6502681d",7596:"95bca972",7664:"7fd4bae6",7816:"38bd8c71",7894:"e09eee0c",7917:"a94482e8",7964:"4e6965bb",7971:"6792c484",8055:"27482879",8087:"b9e4a7cc",8106:"8bd89dab",8140:"901b2f91",8141:"81bec72f",8163:"4d9dbd85",8215:"c6b04c16",8468:"7cfe3494",8474:"8043eb00",8475:"d27b3009",8489:"35a41943",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8766:"9bc6455d",8781:"f4c6405c",8784:"fb16cf6f",8866:"381cdff2",8878:"0d381461",8888:"553c32a0",8892:"7315f43d",9003:"1e8e0783",9010:"09a7d359",9035:"37598b09",9588:"5ef75d8a",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"b14fac44",9700:"ad032cc8",9817:"424c677a",9914:"8bf8d5ee"}[e]+".js",t.miniCssF=e=>{},t.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),b={},d="OpenSign-Docs:",t.l=(e,a,c,f)=>{if(b[e])b[e].push(a);else{var r,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n{r.onerror=r.onload=null,clearTimeout(s);var d=b[e];if(delete b[e],r.parentNode&&r.parentNode.removeChild(r),d&&d.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:r}),12e4);r.onerror=u.bind(null,r.onerror),r.onload=u.bind(null,r.onload),o&&document.head.appendChild(r)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),t.p="/",t.gca=function(e){return e={59362658:"2267",66406991:"110","935f2afb":"53",d91ad230:"230",reactPlayerKaltura:"261",fa40969b:"273","4f7a2d40":"339",e2c87691:"420","30a24c52":"453","299c7a47":"470",b2b675dd:"533",d8b805fb:"762","50ea61d6":"792",c7b98810:"823",ab2a161b:"835",c5e4dae0:"841","277a78f5":"853",b18842e4:"869","8717b14a":"948","8001f939":"1001",f0ff4a36:"1332",b2f554cd:"1477",e9e778b7:"1512","770b40a9":"1520",bbdfc22d:"1531","031793e1":"1633","42f80fc5":"1653",a7023ddc:"1713",ef5d5d5d:"1773","4c5e977b":"1893",d9f32620:"1914",bfe4b778:"2087",reactPlayerFacebook:"2121",f214d5ff:"2125","78b2b753":"2207","1c822755":"2213","2ace9d1d":"2241",a2bc1463:"2245",e273c56f:"2362","814f3328":"2535","5ce9853b":"2542",reactPlayerStreamable:"2546","56b5f4f8":"2617","1f73ca32":"2832","3e02da86":"2865","1ee58ee1":"3000","1f391b9e":"3085",a6aa9e1f:"3089","64ee8796":"3101","11b7b3d8":"3156",a80da1cf:"3205","8a855f99":"3495","73664a40":"3514","5e1bb91e":"3554","9e4087bc":"3608",reactPlayerVimeo:"3743",reactPlayerVidyard:"3965","01a85c17":"4013",c4f5d8e4:"4195","14716de7":"4277",a94703ab:"4368",reactPlayerYouTube:"4439",d1393a72:"4478",ada7accb:"4641","05632a52":"4651",reactPlayerMixcloud:"4667",b0378e01:"4772","1f7895dc":"4918",ae010e44:"4930",e226bb09:"4955",b839bf37:"4985",ce589067:"5377","8320e026":"5507","046910c8":"5858","38e3d9c8":"5900",reactPlayerFilePlayer:"6011","28b19cd2":"6033",ccc49370:"6103","13fdae3b":"6113",reactPlayerSoundCloud:"6125","611db08b":"6177",reactPlayerTwitch:"6216",e76c28ee:"6238","984cf7cf":"6344","17e5210b":"6543",c9fa5aa5:"6759","608ae6a4":"6938","2c416566":"7100","096bfee4":"7178","451a5132":"7286","393be207":"7414","500027af":"7475",reactPlayerDailyMotion:"7596",reactPlayerPreview:"7664","06577f20":"7816",a88a3db3:"7894","0028a090":"7917","2304e9ae":"7964","8a725248":"7971",reactPlayerWistia:"8055",e4f5c862:"8087","377084eb":"8106","98da7451":"8141","5a2de241":"8163",e5a49157:"8215","52d5c0f9":"8468","9640838e":"8474","7b076186":"8489",a7bd4aaa:"8518","6875c492":"8610",f4f34a3a:"8636","70853c19":"8766","489b8a4d":"8781","83cab870":"8784",eb56c656:"8866",cf03142d:"8878",a9f09360:"8888","38ec836e":"8892","925b3f96":"9003","06b6ef6a":"9010","4c9e35b1":"9035","5c04ee3b":"9588","7661071f":"9642","5e95c892":"9661","0e384e19":"9671","2c586be5":"9697",e16015ca:"9700","14eb3368":"9817","0c0943c7":"9914"}[e]||e,t.p+t.u(e)},(()=>{var e={1303:0,532:0};t.f.j=(a,c)=>{var b=t.o(e,a)?e[a]:void 0;if(0!==b)if(b)c.push(b[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var d=new Promise(((c,d)=>b=e[a]=[c,d]));c.push(b[2]=d);var f=t.p+t.u(a),r=new Error;t.l(f,(c=>{if(t.o(e,a)&&(0!==(b=e[a])&&(e[a]=void 0),b)){var d=c&&("load"===c.type?"missing":c.type),f=c&&c.target&&c.target.src;r.message="Loading chunk "+a+" failed.\n("+d+": "+f+")",r.name="ChunkLoadError",r.type=d,r.request=f,b[1](r)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var b,d,f=c[0],r=c[1],o=c[2],l=0;if(f.some((a=>0!==e[a]))){for(b in r)t.o(r,b)&&(t.m[b]=r[b]);if(o)var n=o(t)}for(a&&a(c);l Archive | OpenSign™ - + diff --git a/blog/first-blog-post/index.html b/blog/first-blog-post/index.html index bd1ca08fc..aa81fcfda 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 5d6e32260..3013f1b5a 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 4fbafc439..29326f6ae 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 a537ad34b..0d708c09e 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 2be56dd4a..da274e0d1 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 093cc019e..ca7644de1 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 7fbcf49d1..6ddc35983 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 dfa893cc9..eed92a2de 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 11f5f354e..6606ab2f1 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 37e84d915..9eabe17e7 100644 --- a/blog/welcome/index.html +++ b/blog/welcome/index.html @@ -5,7 +5,7 @@ Welcome | OpenSign™ - + diff --git a/docs/API-docs/contactlist/index.html b/docs/API-docs/contactlist/index.html index 0bb2a444e..8b0e16209 100644 --- a/docs/API-docs/contactlist/index.html +++ b/docs/API-docs/contactlist/index.html @@ -5,7 +5,7 @@ Get Contact list | OpenSign™ - + diff --git a/docs/API-docs/createcontact/index.html b/docs/API-docs/createcontact/index.html index 5530c018c..6cef8bb3f 100644 --- a/docs/API-docs/createcontact/index.html +++ b/docs/API-docs/createcontact/index.html @@ -5,7 +5,7 @@ Create Contact | OpenSign™ - + diff --git a/docs/API-docs/createdocument/index.html b/docs/API-docs/createdocument/index.html index 799b37d75..6234a40ef 100644 --- a/docs/API-docs/createdocument/index.html +++ b/docs/API-docs/createdocument/index.html @@ -5,7 +5,7 @@ Create Document | OpenSign™ - + diff --git a/docs/API-docs/createdocumentwithtemplateid/index.html b/docs/API-docs/createdocumentwithtemplateid/index.html index 750c9fc24..2af953758 100644 --- a/docs/API-docs/createdocumentwithtemplateid/index.html +++ b/docs/API-docs/createdocumentwithtemplateid/index.html @@ -5,7 +5,7 @@ Create Document from Template | OpenSign™ - + diff --git a/docs/API-docs/createfolder/index.html b/docs/API-docs/createfolder/index.html index 50fd7cb7d..103a456bc 100644 --- a/docs/API-docs/createfolder/index.html +++ b/docs/API-docs/createfolder/index.html @@ -5,7 +5,7 @@ Create Folder | OpenSign™ - + diff --git a/docs/API-docs/createtemplate/index.html b/docs/API-docs/createtemplate/index.html index 207f24fe6..d77e76278 100644 --- a/docs/API-docs/createtemplate/index.html +++ b/docs/API-docs/createtemplate/index.html @@ -5,7 +5,7 @@ Create Template | OpenSign™ - + diff --git a/docs/API-docs/delete-template/index.html b/docs/API-docs/delete-template/index.html index bb7fafa8d..9cc3162eb 100644 --- a/docs/API-docs/delete-template/index.html +++ b/docs/API-docs/delete-template/index.html @@ -5,7 +5,7 @@ Delete Template | OpenSign™ - + diff --git a/docs/API-docs/delete-webhook/index.html b/docs/API-docs/delete-webhook/index.html index 0eeea61ec..636168ac2 100644 --- a/docs/API-docs/delete-webhook/index.html +++ b/docs/API-docs/delete-webhook/index.html @@ -5,7 +5,7 @@ Delete Webhook | OpenSign™ - + diff --git a/docs/API-docs/deletecontact/index.html b/docs/API-docs/deletecontact/index.html index 46a4ed880..87d302d7e 100644 --- a/docs/API-docs/deletecontact/index.html +++ b/docs/API-docs/deletecontact/index.html @@ -5,7 +5,7 @@ Delete Contact | OpenSign™ - + diff --git a/docs/API-docs/deletedocument/index.html b/docs/API-docs/deletedocument/index.html index 948504b21..8ea4559d2 100644 --- a/docs/API-docs/deletedocument/index.html +++ b/docs/API-docs/deletedocument/index.html @@ -5,7 +5,7 @@ Delete Document | OpenSign™ - + diff --git a/docs/API-docs/deletefolder/index.html b/docs/API-docs/deletefolder/index.html index 12b664fbe..a7bff91eb 100644 --- a/docs/API-docs/deletefolder/index.html +++ b/docs/API-docs/deletefolder/index.html @@ -5,7 +5,7 @@ Delete Folder | OpenSign™ - + diff --git a/docs/API-docs/draftdocument/index.html b/docs/API-docs/draftdocument/index.html index a581ef97e..190b782fe 100644 --- a/docs/API-docs/draftdocument/index.html +++ b/docs/API-docs/draftdocument/index.html @@ -5,7 +5,7 @@ Draft Document | OpenSign™ - + diff --git a/docs/API-docs/drafttemplate/index.html b/docs/API-docs/drafttemplate/index.html index 8699fc0f7..cfd593c29 100644 --- a/docs/API-docs/drafttemplate/index.html +++ b/docs/API-docs/drafttemplate/index.html @@ -5,7 +5,7 @@ Draft Template | OpenSign™ - + diff --git a/docs/API-docs/folderlist/index.html b/docs/API-docs/folderlist/index.html index b3f79f58b..75e4e750b 100644 --- a/docs/API-docs/folderlist/index.html +++ b/docs/API-docs/folderlist/index.html @@ -5,7 +5,7 @@ Get folder list | OpenSign™ - + diff --git a/docs/API-docs/get-template/index.html b/docs/API-docs/get-template/index.html index 4edf0da58..b5f8fb73c 100644 --- a/docs/API-docs/get-template/index.html +++ b/docs/API-docs/get-template/index.html @@ -5,7 +5,7 @@ Get Template | OpenSign™ - + diff --git a/docs/API-docs/get-user/index.html b/docs/API-docs/get-user/index.html index e1aee8e10..700ba05b5 100644 --- a/docs/API-docs/get-user/index.html +++ b/docs/API-docs/get-user/index.html @@ -5,7 +5,7 @@ Get your account details | OpenSign™ - + diff --git a/docs/API-docs/get-webhook/index.html b/docs/API-docs/get-webhook/index.html index d61d75a9e..cbd3453bb 100644 --- a/docs/API-docs/get-webhook/index.html +++ b/docs/API-docs/get-webhook/index.html @@ -5,7 +5,7 @@ Get Webhook | OpenSign™ - + diff --git a/docs/API-docs/getcontact/index.html b/docs/API-docs/getcontact/index.html index ee5a7fdac..694cfd97b 100644 --- a/docs/API-docs/getcontact/index.html +++ b/docs/API-docs/getcontact/index.html @@ -5,7 +5,7 @@ Get Contact | OpenSign™ - + diff --git a/docs/API-docs/getdocument/index.html b/docs/API-docs/getdocument/index.html index 8c5bca7a3..24a5a82f1 100644 --- a/docs/API-docs/getdocument/index.html +++ b/docs/API-docs/getdocument/index.html @@ -5,7 +5,7 @@ Get Document | OpenSign™ - + diff --git a/docs/API-docs/getdocumentlist/index.html b/docs/API-docs/getdocumentlist/index.html index 95d32dd38..a6249e187 100644 --- a/docs/API-docs/getdocumentlist/index.html +++ b/docs/API-docs/getdocumentlist/index.html @@ -5,7 +5,7 @@ Get Document list from status | OpenSign™ - + diff --git a/docs/API-docs/getfolder/index.html b/docs/API-docs/getfolder/index.html index 691dd7976..c715c6f6c 100644 --- a/docs/API-docs/getfolder/index.html +++ b/docs/API-docs/getfolder/index.html @@ -5,7 +5,7 @@ Get Folder | OpenSign™ - + diff --git a/docs/API-docs/gettemplatelist/index.html b/docs/API-docs/gettemplatelist/index.html index e80b9d1f1..350666102 100644 --- a/docs/API-docs/gettemplatelist/index.html +++ b/docs/API-docs/gettemplatelist/index.html @@ -5,7 +5,7 @@ Get Template list | OpenSign™ - + diff --git a/docs/API-docs/intro/index.html b/docs/API-docs/intro/index.html index 5e9a632b4..732a43fc5 100644 --- a/docs/API-docs/intro/index.html +++ b/docs/API-docs/intro/index.html @@ -5,7 +5,7 @@ Overview | OpenSign™ - + diff --git a/docs/API-docs/opensign-api-v-1/index.html b/docs/API-docs/opensign-api-v-1/index.html index 444311ce3..6f0042dec 100644 --- a/docs/API-docs/opensign-api-v-1/index.html +++ b/docs/API-docs/opensign-api-v-1/index.html @@ -5,7 +5,7 @@ OpenSign API v1 | OpenSign™ - + diff --git a/docs/API-docs/resendrequestmail/index.html b/docs/API-docs/resendrequestmail/index.html index 28e897297..b3646280d 100644 --- a/docs/API-docs/resendrequestmail/index.html +++ b/docs/API-docs/resendrequestmail/index.html @@ -5,7 +5,7 @@ Resend request mail | OpenSign™ - + diff --git a/docs/API-docs/save-update-webhook/index.html b/docs/API-docs/save-update-webhook/index.html index 6d2f478ad..c67247fab 100644 --- a/docs/API-docs/save-update-webhook/index.html +++ b/docs/API-docs/save-update-webhook/index.html @@ -5,7 +5,7 @@ Save or Update Webhook | OpenSign™ - + diff --git a/docs/API-docs/selfsign/index.html b/docs/API-docs/selfsign/index.html index 77187c184..d5ee6f917 100644 --- a/docs/API-docs/selfsign/index.html +++ b/docs/API-docs/selfsign/index.html @@ -5,7 +5,7 @@ Self Sign | OpenSign™ - + diff --git a/docs/API-docs/update-document/index.html b/docs/API-docs/update-document/index.html index e8f8a3a01..318b6e85d 100644 --- a/docs/API-docs/update-document/index.html +++ b/docs/API-docs/update-document/index.html @@ -5,7 +5,7 @@ Update Document | OpenSign™ - + diff --git a/docs/API-docs/update-template/index.html b/docs/API-docs/update-template/index.html index 48fb1400c..191eb9ad7 100644 --- a/docs/API-docs/update-template/index.html +++ b/docs/API-docs/update-template/index.html @@ -5,7 +5,7 @@ Update Template | OpenSign™ - + diff --git a/docs/API-docs/updatefolder/index.html b/docs/API-docs/updatefolder/index.html index a55a5dcd6..3d0dcdb3c 100644 --- a/docs/API-docs/updatefolder/index.html +++ b/docs/API-docs/updatefolder/index.html @@ -5,7 +5,7 @@ Update Folder | OpenSign™ - + diff --git a/docs/category/cloud-storage/index.html b/docs/category/cloud-storage/index.html index 15b041dd4..368b32f9f 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 d225efd90..88fa7f8a9 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 5df7a90db..a8977f573 100644 --- a/docs/category/docker/index.html +++ b/docs/category/docker/index.html @@ -5,7 +5,7 @@ Docker | OpenSign™ - + diff --git a/docs/category/faqs/index.html b/docs/category/faqs/index.html index bb57767ac..210f585aa 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 5dcc86c97..917530d9c 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 08d63132d..f7e367261 100644 --- a/docs/category/manage-docs-using-opensign-drive/index.html +++ b/docs/category/manage-docs-using-opensign-drive/index.html @@ -5,7 +5,7 @@ Manage Docs using OpenSign™ Drive | OpenSign™ - + diff --git a/docs/category/reports/index.html b/docs/category/reports/index.html index af1410a9e..d24061615 100644 --- a/docs/category/reports/index.html +++ b/docs/category/reports/index.html @@ -5,7 +5,7 @@ Reports | OpenSign™ - + diff --git a/docs/category/settings/index.html b/docs/category/settings/index.html index 8c6134c8a..164a66c12 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 19273d33a..01802a2b9 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 9c269d530..ba9a9138c 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 d2ad9d3c3..07a63802d 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 9c771f2a8..015d6274e 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 e095dbf9b..5daf96e5e 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 a14c8e03e..2f9d9cd5e 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 03d21cb9f..a8bdcff97 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 3d4180cc5..2857ba1ab 100644 --- a/docs/help/FAQs/index.html +++ b/docs/help/FAQs/index.html @@ -5,7 +5,7 @@ Why is there no dropdown list when I sign a document myself? | OpenSign™ - + diff --git a/docs/help/New-Document/enforce-email-verification/index.html b/docs/help/New-Document/enforce-email-verification/index.html index 1e7c7bc5c..4fb1f4725 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 f78cccf63..92d2ec2ea 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 7aaa9eff9..7c7c0153d 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 64f6ea639..d9e5581ad 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 92e6213e0..5ca31a18f 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 0ac711e2d..09919ca82 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 46201f57f..e191836d8 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 5f7aea867..a3336bd7d 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 94d269d47..744852873 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 0fa7337f9..556f10ac9 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 40124bf7b..2e80f879a 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 7c8fcf028..3cd31d1fb 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 d79c0a0f0..6e67fa6f6 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 34fc7a768..d4abe78bd 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 6519fd3c7..7c32733e3 100644 --- a/docs/help/Reports/need-your-sign/index.html +++ b/docs/help/Reports/need-your-sign/index.html @@ -5,7 +5,7 @@ Need your sign | OpenSign™ - + diff --git a/docs/help/Settings/disabledocumentid/index.html b/docs/help/Settings/disabledocumentid/index.html index ebb5e0646..0ebc70ee8 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 540894713..f40314540 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 1002e2386..3bb57ea40 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 8f73ba516..21b541bd8 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 003b59a5d..31d8e1569 100644 --- a/docs/help/Templates/embed-template/index.html +++ b/docs/help/Templates/embed-template/index.html @@ -5,7 +5,7 @@ Embedding OpenSign templates | OpenSign™ - + diff --git a/docs/help/Templates/publicTemplate/index.html b/docs/help/Templates/publicTemplate/index.html index 9b9706b9b..73342c71d 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 af7780eeb..96a43788b 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 b38c5afcf..a4fd2593d 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 26edf3ac3..149d513f6 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 f2e133584..74ca940ae 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 16d2ca846..9c58d8bff 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 ecabc9d2b..6f0960e36 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 1b4eee648..29f7bc463 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 d2382d265..649e95789 100644 --- a/docs/self-host/docker/upgrade-deployment/index.html +++ b/docs/self-host/docker/upgrade-deployment/index.html @@ -5,7 +5,7 @@ OpenSign™ Self-Hosted 'Upgrade Deployment' Guide Using Docker on Linux, macOS, or Windows | OpenSign™ - + diff --git a/docs/self-host/guides/env-variables/index.html b/docs/self-host/guides/env-variables/index.html index 6e149099d..4b3341135 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 4d7e92457..45a384bde 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 9e38c49c0..a8c49df76 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 569eab3a2..755ecca89 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 5076ad4a3..a050d7998 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 7785dbf79..1d951598d 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -5,7 +5,7 @@ Markdown page example | OpenSign™ - +