diff --git a/404.html b/404.html index 92f5fa4e7..1c7bfd0b4 100644 --- a/404.html +++ b/404.html @@ -5,8 +5,8 @@ Page Not Found | OpenSign™ - - + + diff --git a/assets/js/0058b4c6.1af3cb2a.js b/assets/js/0058b4c6.1af3cb2a.js new file mode 100644 index 000000000..f6d673c5e --- /dev/null +++ b/assets/js/0058b4c6.1af3cb2a.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[849],{86164(e){e.exports=JSON.parse('{"version":{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"link","href":"/docs/help/intro","label":"Intro","docId":"help/intro","unlisted":false},{"type":"category","label":"Create New OpenSign Document","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/docs/help/New-Document/sign-yourself","label":"Sign your-self","docId":"help/New-Document/sign-yourself","unlisted":false},{"type":"link","href":"/docs/help/New-Document/request-signatures","label":"Request signatures","docId":"help/New-Document/request-signatures","unlisted":false},{"type":"link","href":"/docs/help/New-Document/widgets","label":"Widgets in OpenSign","docId":"help/New-Document/widgets","unlisted":false},{"type":"link","href":"/docs/help/New-Document/edit-document-before-sending","label":"Editing Your Document Before Sending","docId":"help/New-Document/edit-document-before-sending","unlisted":false},{"type":"link","href":"/docs/help/New-Document/enforce-email-verification","label":"Enforce email OTP verification","docId":"help/New-Document/enforce-email-verification","unlisted":false}],"href":"/docs/category/create-new-opensign-document"},{"type":"category","label":"Manage Docs using OpenSign\u2122 Drive","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/docs/help/OpenSign\u2122 Drive/create-document","label":"Create Docs & Folders","docId":"help/OpenSign\u2122 Drive/create-document","unlisted":false},{"type":"link","href":"/docs/help/OpenSign\u2122 Drive/list-grid-view","label":"Grid vs List view","docId":"help/OpenSign\u2122 Drive/list-grid-view","unlisted":false},{"type":"link","href":"/docs/help/OpenSign\u2122 Drive/organize-documents","label":"OpenSign\u2122 Drive Interface Documentation","docId":"help/OpenSign\u2122 Drive/organize-documents","unlisted":false},{"type":"link","href":"/docs/help/OpenSign\u2122 Drive/rename-document","label":"Rename documents from OpenSign\u2122 Drive","docId":"help/OpenSign\u2122 Drive/rename-document","unlisted":false}],"href":"/docs/category/manage-docs-using-opensign-drive"},{"type":"category","label":"Documents","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/docs/help/Reports/need-your-sign","label":"Need your sign","docId":"help/Reports/need-your-sign","unlisted":false},{"type":"link","href":"/docs/help/Reports/in-progress","label":"In Progress","docId":"help/Reports/in-progress","unlisted":false},{"type":"link","href":"/docs/help/Reports/completed","label":"Completed","docId":"help/Reports/completed","unlisted":false},{"type":"link","href":"/docs/help/Reports/drafts","label":"Drafts","docId":"help/Reports/drafts","unlisted":false},{"type":"link","href":"/docs/help/Reports/declined","label":"Declined","docId":"help/Reports/declined","unlisted":false},{"type":"link","href":"/docs/help/Reports/expired","label":"Expired","docId":"help/Reports/expired","unlisted":false},{"type":"link","href":"/docs/help/Reports/contactbook","label":"Contactbook","docId":"help/Reports/contactbook","unlisted":false}],"href":"/docs/category/documents"},{"type":"category","label":"Templates","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/docs/help/Templates/create-template","label":"Create Templates","docId":"help/Templates/create-template","unlisted":false},{"type":"link","href":"/docs/help/Templates/manage-templates","label":"Manage Templates","docId":"help/Templates/manage-templates","unlisted":false},{"type":"link","href":"/docs/help/Templates/use-template","label":"Use template to create documents","docId":"help/Templates/use-template","unlisted":false},{"type":"link","href":"/docs/help/Templates/quick-send","label":"Bulk Document Send for Signature Using Template","docId":"help/Templates/quick-send","unlisted":false},{"type":"link","href":"/docs/help/Templates/publicTemplate","label":"Setting up an OpenSign template for public signing","docId":"help/Templates/publicTemplate","unlisted":false},{"type":"link","href":"/docs/help/Templates/embed-template","label":"Embedding OpenSign templates","docId":"help/Templates/embed-template","unlisted":false}],"href":"/docs/category/templates"},{"type":"category","label":"Settings","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/docs/help/Settings/my-signature","label":"My Signature","docId":"help/Settings/my-signature","unlisted":false},{"type":"link","href":"/docs/help/Settings/APIToken","label":"API Token","docId":"help/Settings/APIToken","unlisted":false},{"type":"link","href":"/docs/help/Settings/Webhook","label":"Webhook","docId":"help/Settings/Webhook","unlisted":false},{"type":"link","href":"/docs/help/Settings/Preferences","label":"Preferences","docId":"help/Settings/Preferences","unlisted":false},{"type":"link","href":"/docs/help/Settings/Teams","label":"Manage Teams","docId":"help/Settings/Teams","unlisted":false},{"type":"link","href":"/docs/help/Settings/manage-users","label":"Manage users","docId":"help/Settings/manage-users","unlisted":false},{"type":"link","href":"/docs/help/Settings/disabledocumentid","label":"Disable DocumentId","docId":"help/Settings/disabledocumentid","unlisted":false},{"type":"link","href":"/docs/help/Settings/Custom-email-templates","label":"Custom email templates","docId":"help/Settings/Custom-email-templates","unlisted":false},{"type":"link","href":"/docs/help/Settings/SecurityManagement","label":"Security","docId":"help/Settings/SecurityManagement","unlisted":false}],"href":"/docs/category/settings"},{"type":"category","label":"User Menu","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/docs/help/User Menu/Profile","label":"Profile","docId":"help/User Menu/Profile","unlisted":false},{"type":"category","label":"Console","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/docs/help/User Menu/Console/analystics","label":"Analytics","docId":"help/User Menu/Console/analystics","unlisted":false},{"type":"link","href":"/docs/help/User Menu/Console/general","label":"General","docId":"help/User Menu/Console/general","unlisted":false},{"type":"link","href":"/docs/help/User Menu/Console/branding","label":"Branding","docId":"help/User Menu/Console/branding","unlisted":false},{"type":"link","href":"/docs/help/User Menu/Console/globalSMTP","label":"Global SMTP","docId":"help/User Menu/Console/globalSMTP","unlisted":false},{"type":"link","href":"/docs/help/User Menu/Console/emails","label":"Mail","docId":"help/User Menu/Console/emails","unlisted":false},{"type":"link","href":"/docs/help/User Menu/Console/custom_filestorage","label":"Custom File Storage","docId":"help/User Menu/Console/custom_filestorage","unlisted":false},{"type":"link","href":"/docs/help/User Menu/Console/signing_certificate","label":"Custom Signing Certificate","docId":"help/User Menu/Console/signing_certificate","unlisted":false},{"type":"link","href":"/docs/help/User Menu/Console/organizations","label":"Organizations","docId":"help/User Menu/Console/organizations","unlisted":false},{"type":"link","href":"/docs/help/User Menu/Console/orgadmin","label":"Org Admins","docId":"help/User Menu/Console/orgadmin","unlisted":false}],"href":"/docs/category/console"}],"href":"/docs/category/user-menu"},{"type":"category","label":"FAQs","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/docs/help/FAQs/","label":"Why is there no dropdown list when I sign a document myself?","docId":"help/FAQs/FAQs","unlisted":false},{"type":"link","href":"/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements","label":"Why am I getting \'Ensure this field is accurately filled and meets all requirements\'?","docId":"help/FAQs/Ensure this field is accurately filled and meets all requirements","unlisted":false},{"type":"link","href":"/docs/help/FAQs/Credit-Deductions","label":"Credit-Deductions","docId":"help/FAQs/Credit-Deductions","unlisted":false},{"type":"link","href":"/docs/help/FAQs/Max File Upload Size","label":"Max File Upload Size","docId":"help/FAQs/Max File Upload Size","unlisted":false},{"type":"link","href":"/docs/help/FAQs/User Deletion","label":"User Deletion","docId":"help/FAQs/User Deletion","unlisted":false}],"href":"/docs/category/faqs"}],"selfhostSidebar":[{"type":"link","href":"/docs/self-host/intro","label":"Self-Hosting OpenSign","docId":"self-host/intro","unlisted":false},{"type":"category","label":"Docker","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/docs/self-host/docker/run-locally","label":"Self-host OpenSign\u2122 with Docker on Linux/MacOS/Windows","docId":"self-host/docker/run-locally","unlisted":false},{"type":"link","href":"/docs/self-host/docker/upgrade-deployment","label":"OpenSign\u2122 Self-Hosted \'Upgrade Deployment\' Guide Using Docker on Linux, macOS, or Windows","docId":"self-host/docker/upgrade-deployment","unlisted":false}],"href":"/docs/category/docker"},{"type":"category","label":"Cloud Storage","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/docs/self-host/cloud-storage/s3","label":"AWS S3","docId":"self-host/cloud-storage/s3","unlisted":false}],"href":"/docs/category/cloud-storage"},{"type":"category","label":"Guides","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/docs/self-host/guides/azure-vm-setup","label":"OpenSign Deployment Guide on Azure VM via command-line","docId":"self-host/guides/azure-vm-setup","unlisted":false},{"type":"link","href":"/docs/self-host/guides/env-variables","label":"ENV variables which are used to setup OpenSign\u2122 with Docker on Localhost","docId":"self-host/guides/env-variables","unlisted":false},{"type":"link","href":"/docs/self-host/guides/how-to-generate-self-signed-document-signing-certificate","label":"How to generate self-signed document signing certificate?","docId":"self-host/guides/how-to-generate-self-signed-document-signing-certificate","unlisted":false},{"type":"link","href":"/docs/self-host/guides/upgrade-to-v2.1.0","label":"How to upgrade self-hosted OpenSign to v2.1.0?","docId":"self-host/guides/upgrade-to-v2.1.0","unlisted":false}],"href":"/docs/category/guides"},{"type":"category","label":"One-click-Install","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/docs/self-host/One-click-Install/DigitalOcean","label":"Digital Ocean","docId":"self-host/One-click-Install/DigitalOcean","unlisted":false}]}],"contributeSidebar":[{"type":"link","href":"/docs/contribute/CODE_OF_CONDUCT","label":"Code of conduct","docId":"contribute/CODE_OF_CONDUCT","unlisted":false},{"type":"link","href":"/docs/contribute/intro","label":"Contributing to OpenSign","docId":"contribute/intro","unlisted":false},{"type":"link","href":"/docs/contribute/INSTALLATION","label":"Installation instructions","docId":"contribute/INSTALLATION","unlisted":false},{"type":"link","href":"/docs/contribute/COMMUNITY","label":"Community at OpenSign\u2122","docId":"contribute/COMMUNITY","unlisted":false},{"type":"link","href":"/docs/contribute/REPORTING_GUIDELINES","label":"OpenSign\u2122 Reporting Guidelines","docId":"contribute/REPORTING_GUIDELINES","unlisted":false}],"apiSidebar":[{"type":"category","label":"v1.2","collapsed":false,"items":[{"type":"link","href":"/docs/API-docs/v1.2/opensign-api-v-1-2","label":"Introduction","docId":"API-docs/v1.2/opensign-api-v-1-2","unlisted":false},{"type":"category","label":"User","items":[{"type":"link","href":"/docs/API-docs/v1.2/get-user","label":"Get your account details","className":"get api-method","docId":"API-docs/v1.2/get-user","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/getcredits","label":"Get your API credits","className":"get api-method","docId":"API-docs/v1.2/getcredits","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Contacts","items":[{"type":"link","href":"/docs/API-docs/v1.2/createcontact","label":"Create Contact","className":"post api-method","docId":"API-docs/v1.2/createcontact","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/getcontact","label":"Get Contact","className":"get api-method","docId":"API-docs/v1.2/getcontact","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/update-contact","label":"Update Contact","className":"put api-method","docId":"API-docs/v1.2/update-contact","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/deletecontact","label":"Delete Contact","className":"delete api-method","docId":"API-docs/v1.2/deletecontact","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/contactlist","label":"Get Contact list","className":"get api-method","docId":"API-docs/v1.2/contactlist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Documents","items":[{"type":"link","href":"/docs/API-docs/v1.2/selfsign","label":"Self Sign","className":"post api-method","docId":"API-docs/v1.2/selfsign","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/draftdocument","label":"Draft Document","className":"post api-method","docId":"API-docs/v1.2/draftdocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/createdocument","label":"Create Document","className":"post api-method","docId":"API-docs/v1.2/createdocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/createdocumentwithtemplateid","label":"Create Document from Template","className":"post api-method","docId":"API-docs/v1.2/createdocumentwithtemplateid","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/getdocument","label":"Get Document","className":"get api-method","docId":"API-docs/v1.2/getdocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/update-document","label":"Update Document","className":"put api-method","docId":"API-docs/v1.2/update-document","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/revokedocument","label":"Revoke Document","className":"post api-method","docId":"API-docs/v1.2/revokedocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/deletedocument","label":"Delete Document","className":"delete api-method","docId":"API-docs/v1.2/deletedocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/getdocumentlist","label":"Get Document list from status","className":"get api-method","docId":"API-docs/v1.2/getdocumentlist","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/resendrequestmail","label":"Resend request mail","className":"post api-method","docId":"API-docs/v1.2/resendrequestmail","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/getsignerips","label":"Get Signer IPs","className":"get api-method","docId":"API-docs/v1.2/getsignerips","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/getformdata","label":"Get Formdata","className":"get api-method","docId":"API-docs/v1.2/getformdata","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/getsigninglinks","label":"Get Signing Links","className":"get api-method","docId":"API-docs/v1.2/getsigninglinks","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Templates","items":[{"type":"link","href":"/docs/API-docs/v1.2/drafttemplate","label":"Draft Template","className":"post api-method","docId":"API-docs/v1.2/drafttemplate","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/createtemplate","label":"Create Template","className":"post api-method","docId":"API-docs/v1.2/createtemplate","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/publictemplate","label":"Public Template","className":"post api-method","docId":"API-docs/v1.2/publictemplate","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/get-template","label":"Get Template","className":"get api-method","docId":"API-docs/v1.2/get-template","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/update-template","label":"Update Template","className":"put api-method","docId":"API-docs/v1.2/update-template","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/delete-template","label":"Delete Template","className":"delete api-method","docId":"API-docs/v1.2/delete-template","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/gettemplatelist","label":"Get Template list","className":"get api-method","docId":"API-docs/v1.2/gettemplatelist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Webhook","items":[{"type":"link","href":"/docs/API-docs/v1.2/get-webhook","label":"Get Webhook","className":"get api-method","docId":"API-docs/v1.2/get-webhook","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/save-update-webhook","label":"Save or Update Webhook","className":"post api-method","docId":"API-docs/v1.2/save-update-webhook","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/delete-webhook","label":"Delete Webhook","className":"delete api-method","docId":"API-docs/v1.2/delete-webhook","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Folder","items":[{"type":"link","href":"/docs/API-docs/v1.2/createfolder","label":"Create Folder","className":"post api-method","docId":"API-docs/v1.2/createfolder","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/getfolder","label":"Get Folder","className":"get api-method","docId":"API-docs/v1.2/getfolder","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/updatefolder","label":"Update Folder","className":"put api-method","docId":"API-docs/v1.2/updatefolder","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/deletefolder","label":"Delete Folder","className":"delete api-method","docId":"API-docs/v1.2/deletefolder","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/folderlist","label":"Get folder list","className":"get api-method","docId":"API-docs/v1.2/folderlist","unlisted":false}],"collapsed":true,"collapsible":true}],"collapsible":true,"href":"/docs/API-docs/v1.2"},{"type":"category","label":"v1.1","collapsed":false,"items":[{"type":"link","href":"/docs/API-docs/v1.1/opensign-api-v-1-2","label":"Introduction","docId":"API-docs/v1.1/opensign-api-v-1-2","unlisted":false},{"type":"category","label":"User","items":[{"type":"link","href":"/docs/API-docs/v1.1/get-user","label":"Get your account details","className":"get api-method","docId":"API-docs/v1.1/get-user","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/getcredits","label":"Get your API credits","className":"get api-method","docId":"API-docs/v1.1/getcredits","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Contacts","items":[{"type":"link","href":"/docs/API-docs/v1.1/createcontact","label":"Create Contact","className":"post api-method","docId":"API-docs/v1.1/createcontact","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/getcontact","label":"Get Contact","className":"get api-method","docId":"API-docs/v1.1/getcontact","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/update-contact","label":"Update Contact","className":"put api-method","docId":"API-docs/v1.1/update-contact","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/deletecontact","label":"Delete Contact","className":"delete api-method","docId":"API-docs/v1.1/deletecontact","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/contactlist","label":"Get Contact list","className":"get api-method","docId":"API-docs/v1.1/contactlist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Documents","items":[{"type":"link","href":"/docs/API-docs/v1.1/selfsign","label":"Self Sign","className":"post api-method","docId":"API-docs/v1.1/selfsign","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/draftdocument","label":"Draft Document","className":"post api-method","docId":"API-docs/v1.1/draftdocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/createdocument","label":"Create Document","className":"post api-method","docId":"API-docs/v1.1/createdocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/createdocumentwithtemplateid","label":"Create Document from Template","className":"post api-method","docId":"API-docs/v1.1/createdocumentwithtemplateid","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/getdocument","label":"Get Document","className":"get api-method","docId":"API-docs/v1.1/getdocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/update-document","label":"Update Document","className":"put api-method","docId":"API-docs/v1.1/update-document","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/revokedocument","label":"Revoke Document","className":"post api-method","docId":"API-docs/v1.1/revokedocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/deletedocument","label":"Delete Document","className":"delete api-method","docId":"API-docs/v1.1/deletedocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/getdocumentlist","label":"Get Document list from status","className":"get api-method","docId":"API-docs/v1.1/getdocumentlist","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/resendrequestmail","label":"Resend request mail","className":"post api-method","docId":"API-docs/v1.1/resendrequestmail","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/getsignerips","label":"Get Signer IPs","className":"get api-method","docId":"API-docs/v1.1/getsignerips","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/getformdata","label":"Get Formdata","className":"get api-method","docId":"API-docs/v1.1/getformdata","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/getsigninglinks","label":"Get Signing Links","className":"get api-method","docId":"API-docs/v1.1/getsigninglinks","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Templates","items":[{"type":"link","href":"/docs/API-docs/v1.1/drafttemplate","label":"Draft Template","className":"post api-method","docId":"API-docs/v1.1/drafttemplate","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/createtemplate","label":"Create Template","className":"post api-method","docId":"API-docs/v1.1/createtemplate","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/publictemplate","label":"Public Template","className":"post api-method","docId":"API-docs/v1.1/publictemplate","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/get-template","label":"Get Template","className":"get api-method","docId":"API-docs/v1.1/get-template","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/update-template","label":"Update Template","className":"put api-method","docId":"API-docs/v1.1/update-template","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/delete-template","label":"Delete Template","className":"delete api-method","docId":"API-docs/v1.1/delete-template","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/gettemplatelist","label":"Get Template list","className":"get api-method","docId":"API-docs/v1.1/gettemplatelist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Webhook","items":[{"type":"link","href":"/docs/API-docs/v1.1/get-webhook","label":"Get Webhook","className":"get api-method","docId":"API-docs/v1.1/get-webhook","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/save-update-webhook","label":"Save or Update Webhook","className":"post api-method","docId":"API-docs/v1.1/save-update-webhook","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/delete-webhook","label":"Delete Webhook","className":"delete api-method","docId":"API-docs/v1.1/delete-webhook","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Folder","items":[{"type":"link","href":"/docs/API-docs/v1.1/createfolder","label":"Create Folder","className":"post api-method","docId":"API-docs/v1.1/createfolder","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/getfolder","label":"Get Folder","className":"get api-method","docId":"API-docs/v1.1/getfolder","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/updatefolder","label":"Update Folder","className":"put api-method","docId":"API-docs/v1.1/updatefolder","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/deletefolder","label":"Delete Folder","className":"delete api-method","docId":"API-docs/v1.1/deletefolder","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/folderlist","label":"Get folder list","className":"get api-method","docId":"API-docs/v1.1/folderlist","unlisted":false}],"collapsed":true,"collapsible":true}],"collapsible":true,"href":"/docs/API-docs/v1.1"},{"type":"category","label":"v1","collapsed":true,"items":[{"type":"link","href":"/docs/API-docs/v1/opensign-api-v-1","label":"Introduction","docId":"API-docs/v1/opensign-api-v-1","unlisted":false},{"type":"category","label":"User","items":[{"type":"link","href":"/docs/API-docs/v1/get-user","label":"Get your account details","className":"get api-method","docId":"API-docs/v1/get-user","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Contacts","items":[{"type":"link","href":"/docs/API-docs/v1/createcontact","label":"Create Contact","className":"post api-method","docId":"API-docs/v1/createcontact","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/getcontact","label":"Get Contact","className":"get api-method","docId":"API-docs/v1/getcontact","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/deletecontact","label":"Delete Contact","className":"delete api-method","docId":"API-docs/v1/deletecontact","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/contactlist","label":"Get Contact list","className":"get api-method","docId":"API-docs/v1/contactlist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Documents","items":[{"type":"link","href":"/docs/API-docs/v1/selfsign","label":"Self Sign","className":"post api-method","docId":"API-docs/v1/selfsign","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/draftdocument","label":"Draft Document","className":"post api-method","docId":"API-docs/v1/draftdocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/createdocument","label":"Create Document","className":"post api-method","docId":"API-docs/v1/createdocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/createdocumentwithtemplateid","label":"Create Document from Template","className":"post api-method","docId":"API-docs/v1/createdocumentwithtemplateid","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/getdocument","label":"Get Document","className":"get api-method","docId":"API-docs/v1/getdocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/update-document","label":"Update Document","className":"put api-method","docId":"API-docs/v1/update-document","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/revokedocument","label":"Revoke Document","className":"post api-method","docId":"API-docs/v1/revokedocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/deletedocument","label":"Delete Document","className":"delete api-method","docId":"API-docs/v1/deletedocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/getdocumentlist","label":"Get Document list from status","className":"get api-method","docId":"API-docs/v1/getdocumentlist","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/resendrequestmail","label":"Resend request mail","className":"post api-method","docId":"API-docs/v1/resendrequestmail","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Templates","items":[{"type":"link","href":"/docs/API-docs/v1/drafttemplate","label":"Draft Template","className":"post api-method","docId":"API-docs/v1/drafttemplate","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/createtemplate","label":"Create Template","className":"post api-method","docId":"API-docs/v1/createtemplate","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/get-template","label":"Get Template","className":"get api-method","docId":"API-docs/v1/get-template","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/update-template","label":"Update Template","className":"put api-method","docId":"API-docs/v1/update-template","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/delete-template","label":"Delete Template","className":"delete api-method","docId":"API-docs/v1/delete-template","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/gettemplatelist","label":"Get Template list","className":"get api-method","docId":"API-docs/v1/gettemplatelist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Webhook","items":[{"type":"link","href":"/docs/API-docs/v1/get-webhook","label":"Get Webhook","className":"get api-method","docId":"API-docs/v1/get-webhook","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/save-update-webhook","label":"Save or Update Webhook","className":"post api-method","docId":"API-docs/v1/save-update-webhook","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/delete-webhook","label":"Delete Webhook","className":"delete api-method","docId":"API-docs/v1/delete-webhook","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Folder","items":[{"type":"link","href":"/docs/API-docs/v1/createfolder","label":"Create Folder","className":"post api-method","docId":"API-docs/v1/createfolder","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/getfolder","label":"Get Folder","className":"get api-method","docId":"API-docs/v1/getfolder","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/updatefolder","label":"Update Folder","className":"put api-method","docId":"API-docs/v1/updatefolder","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/deletefolder","label":"Delete Folder","className":"delete api-method","docId":"API-docs/v1/deletefolder","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/folderlist","label":"Get folder list","className":"get api-method","docId":"API-docs/v1/folderlist","unlisted":false}],"collapsed":true,"collapsible":true}],"collapsible":true,"href":"/docs/API-docs/v1"}]},"docs":{"API-docs/api-intro":{"id":"API-docs/api-intro","title":"OpenSign APIs","description":"Welcome to the OpenSign API. Choose a version from the sidebar:"},"API-docs/v1.1/contactlist":{"id":"API-docs/v1.1/contactlist","title":"Get Contact list","description":"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.","sidebar":"apiSidebar"},"API-docs/v1.1/createcontact":{"id":"API-docs/v1.1/createcontact","title":"Create Contact","description":"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.","sidebar":"apiSidebar"},"API-docs/v1.1/createdocument":{"id":"API-docs/v1.1/createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file.","sidebar":"apiSidebar"},"API-docs/v1.1/createdocumentwithtemplateid":{"id":"API-docs/v1.1/createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","sidebar":"apiSidebar"},"API-docs/v1.1/createfolder":{"id":"API-docs/v1.1/createfolder","title":"Create Folder","description":"The Create Folder API allows you to create folder.","sidebar":"apiSidebar"},"API-docs/v1.1/createtemplate":{"id":"API-docs/v1.1/createtemplate","title":"Create Template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.","sidebar":"apiSidebar"},"API-docs/v1.1/delete-template":{"id":"API-docs/v1.1/delete-template","title":"Delete Template","description":"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed","sidebar":"apiSidebar"},"API-docs/v1.1/delete-webhook":{"id":"API-docs/v1.1/delete-webhook","title":"Delete Webhook","description":"The Delete Webhook API allow you to delete webhook url","sidebar":"apiSidebar"},"API-docs/v1.1/deletecontact":{"id":"API-docs/v1.1/deletecontact","title":"Delete Contact","description":"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact\'s information, this API makes it easy to delete their record.","sidebar":"apiSidebar"},"API-docs/v1.1/deletedocument":{"id":"API-docs/v1.1/deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","sidebar":"apiSidebar"},"API-docs/v1.1/deletefolder":{"id":"API-docs/v1.1/deletefolder","title":"Delete Folder","description":"The delete Folder API allows you to delete folder.","sidebar":"apiSidebar"},"API-docs/v1.1/draftdocument":{"id":"API-docs/v1.1/draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","sidebar":"apiSidebar"},"API-docs/v1.1/drafttemplate":{"id":"API-docs/v1.1/drafttemplate","title":"Draft Template","description":"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.","sidebar":"apiSidebar"},"API-docs/v1.1/folderlist":{"id":"API-docs/v1.1/folderlist","title":"Get folder list","description":"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId","sidebar":"apiSidebar"},"API-docs/v1.1/get-template":{"id":"API-docs/v1.1/get-template","title":"Get Template","description":"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.","sidebar":"apiSidebar"},"API-docs/v1.1/get-user":{"id":"API-docs/v1.1/get-user","title":"Get your account details","description":"The Get User API enables you to get your own account details.","sidebar":"apiSidebar"},"API-docs/v1.1/get-webhook":{"id":"API-docs/v1.1/get-webhook","title":"Get Webhook","description":"The Get Webhook API allow you to get webhook url","sidebar":"apiSidebar"},"API-docs/v1.1/getcontact":{"id":"API-docs/v1.1/getcontact","title":"Get Contact","description":"The Get Contact API allows you to retrieve details about a specific contact.","sidebar":"apiSidebar"},"API-docs/v1.1/getcredits":{"id":"API-docs/v1.1/getcredits","title":"Get your API credits","description":"The Get Credits API returns details about the credits available to your account:","sidebar":"apiSidebar"},"API-docs/v1.1/getdocument":{"id":"API-docs/v1.1/getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","sidebar":"apiSidebar"},"API-docs/v1.1/getdocumentlist":{"id":"API-docs/v1.1/getdocumentlist","title":"Get Document list from status","description":"### Document Types:","sidebar":"apiSidebar"},"API-docs/v1.1/getfolder":{"id":"API-docs/v1.1/getfolder","title":"Get Folder","description":"The Get Folder API allows you to retrieve details about a specific folder.","sidebar":"apiSidebar"},"API-docs/v1.1/getformdata":{"id":"API-docs/v1.1/getformdata","title":"Get Formdata","description":"The Get Formdata API enables you to retrieve widget data filled by signers who signed the document.","sidebar":"apiSidebar"},"API-docs/v1.1/getsignerips":{"id":"API-docs/v1.1/getsignerips","title":"Get Signer IPs","description":"The Get Signer IPs API enables you to retrieve IPs of signers who signed the document.","sidebar":"apiSidebar"},"API-docs/v1.1/getsigninglinks":{"id":"API-docs/v1.1/getsigninglinks","title":"Get Signing Links","description":"The Get Signing Links API enables you to retrieve signing urls of signers for the document.","sidebar":"apiSidebar"},"API-docs/v1.1/gettemplatelist":{"id":"API-docs/v1.1/gettemplatelist","title":"Get Template list","description":"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.","sidebar":"apiSidebar"},"API-docs/v1.1/intro":{"id":"API-docs/v1.1/intro","title":"Overview","description":"OpenSign\u2122 API offers a robust suite of functionalities for digital document management and electronic signatures. Designed to cater to a wide array of business needs, the API facilitates the creation, signing, and management of digital documents. It ensures secure and efficient processes, complying with international legal standards for electronic signatures."},"API-docs/v1.1/opensign-api-v-1-2":{"id":"API-docs/v1.1/opensign-api-v-1-2","title":"OpenSign API v1.2","description":"# OpenSign\u2122 API v1.2","sidebar":"apiSidebar"},"API-docs/v1.1/publictemplate":{"id":"API-docs/v1.1/publictemplate","title":"Public Template","description":"The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique **template_id** and a **public_url**. The **public_url** is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing.","sidebar":"apiSidebar"},"API-docs/v1.1/resendrequestmail":{"id":"API-docs/v1.1/resendrequestmail","title":"Resend request mail","description":"Resend request mail to user for signing document.","sidebar":"apiSidebar"},"API-docs/v1.1/revokedocument":{"id":"API-docs/v1.1/revokedocument","title":"Revoke Document","description":"The Revoke document API allows you to revoke specific document from your documents.","sidebar":"apiSidebar"},"API-docs/v1.1/save-update-webhook":{"id":"API-docs/v1.1/save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.","sidebar":"apiSidebar"},"API-docs/v1.1/selfsign":{"id":"API-docs/v1.1/selfsign","title":"Self Sign","description":"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.","sidebar":"apiSidebar"},"API-docs/v1.1/update-contact":{"id":"API-docs/v1.1/update-contact","title":"Update Contact","description":"The Update Contact API enables you to modify and update the details of a specific Contact.","sidebar":"apiSidebar"},"API-docs/v1.1/update-document":{"id":"API-docs/v1.1/update-document","title":"Update Document","description":"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.","sidebar":"apiSidebar"},"API-docs/v1.1/update-template":{"id":"API-docs/v1.1/update-template","title":"Update Template","description":"The Update Template API enables you to modify and update the details of a specific template.","sidebar":"apiSidebar"},"API-docs/v1.1/updatefolder":{"id":"API-docs/v1.1/updatefolder","title":"Update Folder","description":"The Update Folder API allows you to uodate folder name as well as parentFolderId.","sidebar":"apiSidebar"},"API-docs/v1.2/contactlist":{"id":"API-docs/v1.2/contactlist","title":"Get Contact list","description":"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.","sidebar":"apiSidebar"},"API-docs/v1.2/createcontact":{"id":"API-docs/v1.2/createcontact","title":"Create Contact","description":"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.","sidebar":"apiSidebar"},"API-docs/v1.2/createdocument":{"id":"API-docs/v1.2/createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file.","sidebar":"apiSidebar"},"API-docs/v1.2/createdocumentwithtemplateid":{"id":"API-docs/v1.2/createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","sidebar":"apiSidebar"},"API-docs/v1.2/createfolder":{"id":"API-docs/v1.2/createfolder","title":"Create Folder","description":"The Create Folder API allows you to create folder.","sidebar":"apiSidebar"},"API-docs/v1.2/createtemplate":{"id":"API-docs/v1.2/createtemplate","title":"Create Template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.","sidebar":"apiSidebar"},"API-docs/v1.2/delete-template":{"id":"API-docs/v1.2/delete-template","title":"Delete Template","description":"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed","sidebar":"apiSidebar"},"API-docs/v1.2/delete-webhook":{"id":"API-docs/v1.2/delete-webhook","title":"Delete Webhook","description":"The Delete Webhook API allow you to delete webhook url","sidebar":"apiSidebar"},"API-docs/v1.2/deletecontact":{"id":"API-docs/v1.2/deletecontact","title":"Delete Contact","description":"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact\'s information, this API makes it easy to delete their record.","sidebar":"apiSidebar"},"API-docs/v1.2/deletedocument":{"id":"API-docs/v1.2/deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","sidebar":"apiSidebar"},"API-docs/v1.2/deletefolder":{"id":"API-docs/v1.2/deletefolder","title":"Delete Folder","description":"The delete Folder API allows you to delete folder.","sidebar":"apiSidebar"},"API-docs/v1.2/draftdocument":{"id":"API-docs/v1.2/draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","sidebar":"apiSidebar"},"API-docs/v1.2/drafttemplate":{"id":"API-docs/v1.2/drafttemplate","title":"Draft Template","description":"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.","sidebar":"apiSidebar"},"API-docs/v1.2/folderlist":{"id":"API-docs/v1.2/folderlist","title":"Get folder list","description":"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId","sidebar":"apiSidebar"},"API-docs/v1.2/get-template":{"id":"API-docs/v1.2/get-template","title":"Get Template","description":"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.","sidebar":"apiSidebar"},"API-docs/v1.2/get-user":{"id":"API-docs/v1.2/get-user","title":"Get your account details","description":"The Get User API enables you to get your own account details.","sidebar":"apiSidebar"},"API-docs/v1.2/get-webhook":{"id":"API-docs/v1.2/get-webhook","title":"Get Webhook","description":"The Get Webhook API allow you to get webhook url","sidebar":"apiSidebar"},"API-docs/v1.2/getcontact":{"id":"API-docs/v1.2/getcontact","title":"Get Contact","description":"The Get Contact API allows you to retrieve details about a specific contact.","sidebar":"apiSidebar"},"API-docs/v1.2/getcredits":{"id":"API-docs/v1.2/getcredits","title":"Get your API credits","description":"The Get Credits API returns details about the credits available to your account:","sidebar":"apiSidebar"},"API-docs/v1.2/getdocument":{"id":"API-docs/v1.2/getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","sidebar":"apiSidebar"},"API-docs/v1.2/getdocumentlist":{"id":"API-docs/v1.2/getdocumentlist","title":"Get Document list from status","description":"### Document Types:","sidebar":"apiSidebar"},"API-docs/v1.2/getfolder":{"id":"API-docs/v1.2/getfolder","title":"Get Folder","description":"The Get Folder API allows you to retrieve details about a specific folder.","sidebar":"apiSidebar"},"API-docs/v1.2/getformdata":{"id":"API-docs/v1.2/getformdata","title":"Get Formdata","description":"The Get Formdata API enables you to retrieve widget data filled by signers who signed the document.","sidebar":"apiSidebar"},"API-docs/v1.2/getsignerips":{"id":"API-docs/v1.2/getsignerips","title":"Get Signer IPs","description":"The Get Signer IPs API enables you to retrieve IPs of signers who signed the document.","sidebar":"apiSidebar"},"API-docs/v1.2/getsigninglinks":{"id":"API-docs/v1.2/getsigninglinks","title":"Get Signing Links","description":"The Get Signing Links API enables you to retrieve signing urls of signers for the document.","sidebar":"apiSidebar"},"API-docs/v1.2/gettemplatelist":{"id":"API-docs/v1.2/gettemplatelist","title":"Get Template list","description":"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.","sidebar":"apiSidebar"},"API-docs/v1.2/intro":{"id":"API-docs/v1.2/intro","title":"Overview","description":"OpenSign\u2122 API v1.2 \u2014 the open-source DocuSign alternative, built for developers and trusted by enterprises."},"API-docs/v1.2/opensign-api-v-1-2":{"id":"API-docs/v1.2/opensign-api-v-1-2","title":"OpenSign API v1.2","description":"# OpenSign\u2122 API v1.2","sidebar":"apiSidebar"},"API-docs/v1.2/publictemplate":{"id":"API-docs/v1.2/publictemplate","title":"Public Template","description":"The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique **template_id** and a **public_url**. The **public_url** is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing.","sidebar":"apiSidebar"},"API-docs/v1.2/resendrequestmail":{"id":"API-docs/v1.2/resendrequestmail","title":"Resend request mail","description":"Resend request mail to user for signing document.","sidebar":"apiSidebar"},"API-docs/v1.2/revokedocument":{"id":"API-docs/v1.2/revokedocument","title":"Revoke Document","description":"The Revoke document API allows you to revoke specific document from your documents.","sidebar":"apiSidebar"},"API-docs/v1.2/save-update-webhook":{"id":"API-docs/v1.2/save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.","sidebar":"apiSidebar"},"API-docs/v1.2/selfsign":{"id":"API-docs/v1.2/selfsign","title":"Self Sign","description":"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.","sidebar":"apiSidebar"},"API-docs/v1.2/update-contact":{"id":"API-docs/v1.2/update-contact","title":"Update Contact","description":"The Update Contact API enables you to modify and update the details of a specific Contact.","sidebar":"apiSidebar"},"API-docs/v1.2/update-document":{"id":"API-docs/v1.2/update-document","title":"Update Document","description":"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.","sidebar":"apiSidebar"},"API-docs/v1.2/update-template":{"id":"API-docs/v1.2/update-template","title":"Update Template","description":"The Update Template API enables you to modify and update the details of a specific template.","sidebar":"apiSidebar"},"API-docs/v1.2/updatefolder":{"id":"API-docs/v1.2/updatefolder","title":"Update Folder","description":"The Update Folder API allows you to uodate folder name as well as parentFolderId.","sidebar":"apiSidebar"},"API-docs/v1/contactlist":{"id":"API-docs/v1/contactlist","title":"Get Contact list","description":"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.","sidebar":"apiSidebar"},"API-docs/v1/createcontact":{"id":"API-docs/v1/createcontact","title":"Create Contact","description":"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.","sidebar":"apiSidebar"},"API-docs/v1/createdocument":{"id":"API-docs/v1/createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file.","sidebar":"apiSidebar"},"API-docs/v1/createdocumentwithtemplateid":{"id":"API-docs/v1/createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","sidebar":"apiSidebar"},"API-docs/v1/createfolder":{"id":"API-docs/v1/createfolder","title":"Create Folder","description":"The Create Folder API allows you to create folder.","sidebar":"apiSidebar"},"API-docs/v1/createtemplate":{"id":"API-docs/v1/createtemplate","title":"Create Template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.","sidebar":"apiSidebar"},"API-docs/v1/delete-template":{"id":"API-docs/v1/delete-template","title":"Delete Template","description":"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed","sidebar":"apiSidebar"},"API-docs/v1/delete-webhook":{"id":"API-docs/v1/delete-webhook","title":"Delete Webhook","description":"The Delete Webhook API allow you to delete webhook url","sidebar":"apiSidebar"},"API-docs/v1/deletecontact":{"id":"API-docs/v1/deletecontact","title":"Delete Contact","description":"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact\'s information, this API makes it easy to delete their record.","sidebar":"apiSidebar"},"API-docs/v1/deletedocument":{"id":"API-docs/v1/deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","sidebar":"apiSidebar"},"API-docs/v1/deletefolder":{"id":"API-docs/v1/deletefolder","title":"Delete Folder","description":"The delete Folder API allows you to delete folder.","sidebar":"apiSidebar"},"API-docs/v1/draftdocument":{"id":"API-docs/v1/draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","sidebar":"apiSidebar"},"API-docs/v1/drafttemplate":{"id":"API-docs/v1/drafttemplate","title":"Draft Template","description":"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.","sidebar":"apiSidebar"},"API-docs/v1/folderlist":{"id":"API-docs/v1/folderlist","title":"Get folder list","description":"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId","sidebar":"apiSidebar"},"API-docs/v1/get-template":{"id":"API-docs/v1/get-template","title":"Get Template","description":"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.","sidebar":"apiSidebar"},"API-docs/v1/get-user":{"id":"API-docs/v1/get-user","title":"Get your account details","description":"The Get User API enables you to get your own account details.","sidebar":"apiSidebar"},"API-docs/v1/get-webhook":{"id":"API-docs/v1/get-webhook","title":"Get Webhook","description":"The Get Webhook API allow you to get webhook url","sidebar":"apiSidebar"},"API-docs/v1/getcontact":{"id":"API-docs/v1/getcontact","title":"Get Contact","description":"The Get Contact API allows you to retrieve details about a specific contact.","sidebar":"apiSidebar"},"API-docs/v1/getdocument":{"id":"API-docs/v1/getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","sidebar":"apiSidebar"},"API-docs/v1/getdocumentlist":{"id":"API-docs/v1/getdocumentlist","title":"Get Document list from status","description":"### Document Types:","sidebar":"apiSidebar"},"API-docs/v1/getfolder":{"id":"API-docs/v1/getfolder","title":"Get Folder","description":"The Get Folder API allows you to retrieve details about a specific folder.","sidebar":"apiSidebar"},"API-docs/v1/gettemplatelist":{"id":"API-docs/v1/gettemplatelist","title":"Get Template list","description":"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.","sidebar":"apiSidebar"},"API-docs/v1/intro":{"id":"API-docs/v1/intro","title":"Overview","description":"OpenSign\u2122 API offers a robust suite of functionalities for digital document management and electronic signatures. Designed to cater to a wide array of business needs, the API facilitates the creation, signing, and management of digital documents. It ensures secure and efficient processes, complying with international legal standards for electronic signatures."},"API-docs/v1/opensign-api-v-1":{"id":"API-docs/v1/opensign-api-v-1","title":"OpenSign API v1","description":"Welcome to the OpenSign\u2122 API documentation!","sidebar":"apiSidebar"},"API-docs/v1/resendrequestmail":{"id":"API-docs/v1/resendrequestmail","title":"Resend request mail","description":"Resend request mail to user for signing document.","sidebar":"apiSidebar"},"API-docs/v1/revokedocument":{"id":"API-docs/v1/revokedocument","title":"Revoke Document","description":"The Revoke document API allows you to revoke specific document from your documents.","sidebar":"apiSidebar"},"API-docs/v1/save-update-webhook":{"id":"API-docs/v1/save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.","sidebar":"apiSidebar"},"API-docs/v1/selfsign":{"id":"API-docs/v1/selfsign","title":"Self Sign","description":"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.","sidebar":"apiSidebar"},"API-docs/v1/update-document":{"id":"API-docs/v1/update-document","title":"Update Document","description":"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.","sidebar":"apiSidebar"},"API-docs/v1/update-template":{"id":"API-docs/v1/update-template","title":"Update Template","description":"The Update Template API enables you to modify and update the details of a specific template.","sidebar":"apiSidebar"},"API-docs/v1/updatefolder":{"id":"API-docs/v1/updatefolder","title":"Update Folder","description":"The Update Folder API allows you to uodate folder name as well as parentFolderId.","sidebar":"apiSidebar"},"contribute/CODE_OF_CONDUCT":{"id":"contribute/CODE_OF_CONDUCT","title":"Code of conduct","description":"1. Introduction","sidebar":"contributeSidebar"},"contribute/COMMUNITY":{"id":"contribute/COMMUNITY","title":"Community at OpenSign\u2122","description":"Welcome to the OpenSign\u2122 Community page! OpenSign\u2122 is dedicated to fostering a vibrant and engaging community where members can connect, share ideas and collaborate on the OpenSign\u2122 project. This page provides links to our active social media platforms and community channels, offering various ways for you to join and participate in the OpenSign\u2122 community. Whether you\'re looking for support, eager to contribute or just want to stay updated, you\'ll find a platform that suits your preference. Connect with us on Discord for real-time discussions, follow us on Twitter for the latest updates, engage with our professional network on LinkedIn or join our Facebook group for a broader community experience. Join us in our mission to develop OpenSign\u2122 as the premier open-source alternative to DocuSign.","sidebar":"contributeSidebar"},"contribute/INSTALLATION":{"id":"contribute/INSTALLATION","title":"Installation instructions","description":"You can use our app as a cloud version from OpenSignLabs","sidebar":"contributeSidebar"},"contribute/intro":{"id":"contribute/intro","title":"Contributing to OpenSign","description":"Hello there! Thank you for considering contributing to OpenSign, the open-source alternative to DocuSign. OpenSign is not just a project, but a community endeavor that aims to create a robust, user-friendly, and secure electronic signature solution. Your contributions, irrespective of their size, are valuable in making this vision a reality.","sidebar":"contributeSidebar"},"contribute/REPORTING_GUIDELINES":{"id":"contribute/REPORTING_GUIDELINES","title":"OpenSign\u2122 Reporting Guidelines","description":"This document provides guidelines for reporting issues, suggesting enhancements, and submitting pull requests to the OpenSign\u2122 GitHub repository. Adhering to these guidelines helps maintain the project\'s quality and efficiency.","sidebar":"contributeSidebar"},"help/FAQs/Credit-Deductions":{"id":"help/FAQs/Credit-Deductions","title":"Credit-Deductions","description":"1. When are Premium Credits deducted? Which actions use Premium Credits?","sidebar":"tutorialSidebar"},"help/FAQs/Ensure this field is accurately filled and meets all requirements":{"id":"help/FAQs/Ensure this field is accurately filled and meets all requirements","title":"Why am I getting \'Ensure this field is accurately filled and meets all requirements\'?","description":"This happens when you leave a field blank or when you don\u2019t enter correct values in the field, for example not entering email address in correct format.","sidebar":"tutorialSidebar"},"help/FAQs/FAQs":{"id":"help/FAQs/FAQs","title":"Why is there no dropdown list when I sign a document myself?","description":"The dropdown list field is available only when you request a signature from others or when you create a template. This is because dropdown lists function as temporary widgets, allowing the user to select one of multiple values. Once a signer selects a value from the dropdown, it is embedded into the document as text. When you sign a document yourself, OpenSign digitally signs it immediately upon clicking the finish button. Therefore, you can use the text widget to add the necessary text to the document.","sidebar":"tutorialSidebar"},"help/FAQs/Max File Upload Size":{"id":"help/FAQs/Max File Upload Size","title":"Max File Upload Size","description":"\u2753 What is the default maximum file size that can be uploaded to OpenSign?","sidebar":"tutorialSidebar"},"help/FAQs/User Deletion":{"id":"help/FAQs/User Deletion","title":"User Deletion","description":"\u2753 Who can delete users?","sidebar":"tutorialSidebar"},"help/intro":{"id":"help/intro","title":"Intro","description":"\ud83c\udf1fGet ready for an electrifying journey at OpenSign\u2122, the most incredibly documented open source document signing solution! \ud83d\ude80 This is your go-to spot for diving deep into everything OpenSign\u2122 has to offer. Whether you\u2019re just starting out or you\u2019re a seasoned pro eager to uncover even more cool features, we\u2019ve got you covered with the most awesome, top-notch guides and resources around. Get ready to make the most out of OpenSign\u2122 \ud83c\udf89\ud83d\udcda\ud83d\udd0d Your adventure in excellence starts here! \ud83c\udf08\u2728\ud83c\udf1f","sidebar":"tutorialSidebar"},"help/New-Document/edit-document-before-sending":{"id":"help/New-Document/edit-document-before-sending","title":"Editing Your Document Before Sending","description":"OpenSign\u2122 lets you polish your PDF before you send it out\u2014whether you\u2019re signing it yourself, requesting signatures, or saving it as a template. You get four core editing controls right in the preview:","sidebar":"tutorialSidebar"},"help/New-Document/enforce-email-verification":{"id":"help/New-Document/enforce-email-verification","title":"Enforce email OTP verification","description":"The \\"Enable OTP Verification\\" feature in OpenSign is designed to add an extra layer of security to the document-signing process by verifying the signer\u2019s email address. Here\u2019s an in-depth look at how it works, when to use it, and its impact on the signing process.","sidebar":"tutorialSidebar"},"help/New-Document/request-signatures":{"id":"help/New-Document/request-signatures","title":"Request signatures","description":"Interface Overview","sidebar":"tutorialSidebar"},"help/New-Document/sign-yourself":{"id":"help/New-Document/sign-yourself","title":"Sign your-self","description":"Interface Overview","sidebar":"tutorialSidebar"},"help/New-Document/widgets":{"id":"help/New-Document/widgets","title":"Widgets in OpenSign","description":"Widgets in OpenSign are interactive fields that you can place on your documents to collect information, signatures, or confirmations from recipients during the signing process.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/create-document":{"id":"help/OpenSign\u2122 Drive/create-document","title":"Create Docs & Folders","description":"OpenSign Drive offers a streamlined way to manage, sign, and request signatures on your important documents. Whether you\'re drafting an offer letter or storing signed agreements, organizing your documents effectively is crucial. Here\u2019s a step-by-step guide on how to create documents and folders in OpenSign Drive.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/list-grid-view":{"id":"help/OpenSign\u2122 Drive/list-grid-view","title":"Grid vs List view","description":"- Navigate to OpenSign drive using the main menu or clicking this link.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/organize-documents":{"id":"help/OpenSign\u2122 Drive/organize-documents","title":"OpenSign\u2122 Drive Interface Documentation","description":"Overview","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/rename-document":{"id":"help/OpenSign\u2122 Drive/rename-document","title":"Rename documents from OpenSign\u2122 Drive","description":"The OpenSign\u2122 Drive interface allows users to rename their documents efficiently.","sidebar":"tutorialSidebar"},"help/Reports/completed":{"id":"help/Reports/completed","title":"Completed","description":"---","sidebar":"tutorialSidebar"},"help/Reports/contactbook":{"id":"help/Reports/contactbook","title":"Contactbook","description":"The Contactbook report in OpenSign enables you to add and manage contacts.","sidebar":"tutorialSidebar"},"help/Reports/declined":{"id":"help/Reports/declined","title":"Declined","description":"The \\"Declined documents\\" report within OpenSign serves as a vital tool for managing and reviewing all declined documents that have been processed through the platform. This guide will walk you through the key features and functionalities of the \\"Declined documents\\" report, enabling you to efficiently navigate and manage your signed documents.","sidebar":"tutorialSidebar"},"help/Reports/drafts":{"id":"help/Reports/drafts","title":"Drafts","description":"The Draft documents section in OpenSign helps you manage all your in-progress documents easily. This feature allows you to save, review, and edit documents before sending them for signature. Here\'s a detailed overview of how to navigate and use the Draft Documents report effectively.","sidebar":"tutorialSidebar"},"help/Reports/expired":{"id":"help/Reports/expired","title":"Expired","description":"The Expired documents report in OpenSign allows you to manage and review documents that have reached their expiration date without being signed. This feature is essential for maintaining an organized record of inactive documents that may require follow-up or archival.","sidebar":"tutorialSidebar"},"help/Reports/in-progress":{"id":"help/Reports/in-progress","title":"In Progress","description":"The In-Progress documents report in OpenSign helps you monitor and manage documents that are currently in the signing process. This report enables you to monitor the status of your documents, manually share the document URL, track document progress, resend reminders, revoke access, or delete documents that are no longer required. Here\u2019s a detailed guide on how to use the In-Progress documents report effectively.","sidebar":"tutorialSidebar"},"help/Reports/need-your-sign":{"id":"help/Reports/need-your-sign","title":"Need your sign","description":"The \\"Need your sign\\" feature in OpenSign is designed to simplify the process of managing documents that require your signature. This guide will walk you through the various elements of the \\"Need your sign\\" report, helping you to efficiently navigate and complete your pending signing tasks.","sidebar":"tutorialSidebar"},"help/Settings/APIToken":{"id":"help/Settings/APIToken","title":"API Token","description":"To authenticate and use OpenSign API endpoints, you\u2019ll need a valid API token (x-api-token).","sidebar":"tutorialSidebar"},"help/Settings/Custom-email-templates":{"id":"help/Settings/Custom-email-templates","title":"Custom email templates","description":"\ud83d\ude80 Steps to Set Up Custom Email Templates","sidebar":"tutorialSidebar"},"help/Settings/disabledocumentid":{"id":"help/Settings/disabledocumentid","title":"Disable DocumentId","description":"Whenever a document is signed by all parties, OpenSign\u2122 adds a DocumentId at the top left corner of the digitally signed document.","sidebar":"tutorialSidebar"},"help/Settings/manage-users":{"id":"help/Settings/manage-users","title":"Manage users","description":"The User Management feature in OpenSign allows administrators to add, edit, and manage users within the platform. This functionality is available on Self-Hosted, Teams, and Enterprise plans.","sidebar":"tutorialSidebar"},"help/Settings/my-signature":{"id":"help/Settings/my-signature","title":"My Signature","description":"This guide provides instructions on how to save your signature and initials using the OpenSign application. Once saved, you can use them with one click when signing documents. To create your signature, start by clicking the \\"My Signature\\" link under \\"settings\\" menu.","sidebar":"tutorialSidebar"},"help/Settings/Preferences":{"id":"help/Settings/Preferences","title":"Preferences","description":"The Preferences page in OpenSign\u2122 allows users and administrators to tailor the signing experience to suit individual, team, or organizational needs. Below is a breakdown of all configurable options and what they control.","sidebar":"tutorialSidebar"},"help/Settings/SecurityManagement":{"id":"help/Settings/SecurityManagement","title":"Security","description":"\u2705 Two-Factor Authentication (2FA)","sidebar":"tutorialSidebar"},"help/Settings/Teams":{"id":"help/Settings/Teams","title":"Manage Teams","description":"The Teams feature in OpenSign allows you to organize your users into structured groups for easier management, permissions control, and streamlined workflow configuration.","sidebar":"tutorialSidebar"},"help/Settings/Webhook":{"id":"help/Settings/Webhook","title":"Webhook","description":"\ud83d\udd14 What is a Webhook?","sidebar":"tutorialSidebar"},"help/Templates/create-template":{"id":"help/Templates/create-template","title":"Create Templates","description":"Getting Started","sidebar":"tutorialSidebar"},"help/Templates/embed-template":{"id":"help/Templates/embed-template","title":"Embedding OpenSign templates","description":"OpenSign Template Embedding allows users to seamlessly integrate public document templates into their websites or applications. By embedding templates, you can provide a direct and interactive signing experience for your users without requiring them to leave your platform. This feature supports various technologies like React, Next.js, HTML, JavaScript, and Angular, making it easy to add signing capabilities to different web projects.","sidebar":"tutorialSidebar"},"help/Templates/manage-templates":{"id":"help/Templates/manage-templates","title":"Manage Templates","description":"Viewing and Managing Templates","sidebar":"tutorialSidebar"},"help/Templates/publicTemplate":{"id":"help/Templates/publicTemplate","title":"Setting up an OpenSign template for public signing","description":"The OpenSign Public profile feature offers the ultimate public document signing solution without any need for integrations. With this feature, users can share document templates publicly, allowing anyone to access and sign the documents directly through the shared templates. This streamlines the signing process by providing a seamless, accessible way for public signers to complete documents without additional steps or integrations.","sidebar":"tutorialSidebar"},"help/Templates/quick-send":{"id":"help/Templates/quick-send","title":"Bulk Document Send for Signature Using Template","description":"Overview","sidebar":"tutorialSidebar"},"help/Templates/use-template":{"id":"help/Templates/use-template","title":"Use template to create documents","description":"Step 1: Begin New Template Creation","sidebar":"tutorialSidebar"},"help/User Menu/Console/analystics":{"id":"help/User Menu/Console/analystics","title":"Analytics","description":"Documents Signed","sidebar":"tutorialSidebar"},"help/User Menu/Console/branding":{"id":"help/User Menu/Console/branding","title":"Branding","description":"Custom Subdomain","sidebar":"tutorialSidebar"},"help/User Menu/Console/custom_filestorage":{"id":"help/User Menu/Console/custom_filestorage","title":"Custom File Storage","description":"\ud83c\udf29\ufe0f Introduction to BYOC (Bring Your Own Cloud)","sidebar":"tutorialSidebar"},"help/User Menu/Console/emails":{"id":"help/User Menu/Console/emails","title":"Mail","description":"This page allows the admin user to configure and manage customized email templates at the organization level.","sidebar":"tutorialSidebar"},"help/User Menu/Console/general":{"id":"help/User Menu/Console/general","title":"General","description":"The General Settings section in OpenSign provides key administrative settings to help you manage and control the overall configuration of your OpenSign platform.","sidebar":"tutorialSidebar"},"help/User Menu/Console/globalSMTP":{"id":"help/User Menu/Console/globalSMTP","title":"Global SMTP","description":"\ud83c\udfe2 SMTP at the Organization Level","sidebar":"tutorialSidebar"},"help/User Menu/Console/orgadmin":{"id":"help/User Menu/Console/orgadmin","title":"Org Admins","description":"The Org Admins section allows administrators to manage organization-level admin users within OpenSign.","sidebar":"tutorialSidebar"},"help/User Menu/Console/organizations":{"id":"help/User Menu/Console/organizations","title":"Organizations","description":"The Organizations section in OpenSign allows administrators to create and manage separate groups within a Team or Enterprise account.","sidebar":"tutorialSidebar"},"help/User Menu/Console/signing_certificate":{"id":"help/User Menu/Console/signing_certificate","title":"Custom Signing Certificate","description":"The Custom Signing Certificate page allows you to upload and manage your own digital signing certificate (PFX format) for secure and verified document signing in OpenSign.","sidebar":"tutorialSidebar"},"help/User Menu/Profile":{"id":"help/User Menu/Profile","title":"Profile","description":"The Profile in OpenSign allows users to manage their personal and account-related details. You can update your information, verify your email, and set up a public profile.","sidebar":"tutorialSidebar"},"intro":{"id":"intro","title":"Tutorial Intro","description":"Let\'s discover Docusaurus in less than 5 minutes."},"self-host/cloud-storage/s3":{"id":"self-host/cloud-storage/s3","title":"AWS S3","description":"You can create an AWS S3 bucket to store your uploaded documents using OpenSign\u2122","sidebar":"selfhostSidebar"},"self-host/docker/run-locally":{"id":"self-host/docker/run-locally","title":"Self-host OpenSign\u2122 with Docker on Linux/MacOS/Windows","description":"Steps to run OpenSign\u2122 with docker on Linux/MacOS/Windows:","sidebar":"selfhostSidebar"},"self-host/docker/upgrade-deployment":{"id":"self-host/docker/upgrade-deployment","title":"OpenSign\u2122 Self-Hosted \'Upgrade Deployment\' Guide Using Docker on Linux, macOS, or Windows","description":"This guide provides step-by-step instructions to upgrade the deployment of OpenSign using Docker.","sidebar":"selfhostSidebar"},"self-host/guides/azure-vm-setup":{"id":"self-host/guides/azure-vm-setup","title":"OpenSign Deployment Guide on Azure VM via command-line","description":"\ud83e\uddf1 Prerequisites","sidebar":"selfhostSidebar"},"self-host/guides/env-variables":{"id":"self-host/guides/env-variables","title":"ENV variables which are used to setup OpenSign\u2122 with Docker on Localhost","description":"Information About ENV variables which are used to setup OpenSign\u2122 with Docker on Localhost","sidebar":"selfhostSidebar"},"self-host/guides/how-to-generate-self-signed-document-signing-certificate":{"id":"self-host/guides/how-to-generate-self-signed-document-signing-certificate","title":"How to generate self-signed document signing certificate?","description":"","sidebar":"selfhostSidebar"},"self-host/guides/upgrade-to-v2.1.0":{"id":"self-host/guides/upgrade-to-v2.1.0","title":"How to upgrade self-hosted OpenSign to v2.1.0?","description":"For self-hosted deployments, version 2.1.0 introduces changes to the signup process:","sidebar":"selfhostSidebar"},"self-host/intro":{"id":"self-host/intro","title":"Self-Hosting OpenSign","description":"This section of the OpenSign\u2122 documentation is dedicated to guiding you through the process of self-hosting the OpenSign platform. Self-hosting OpenSign allows for greater control and customization, ensuring that it aligns perfectly with your specific needs and infrastructure requirements. We cover everything from initial setup, configuration options, to maintenance best practices. Whether you are an individual enthusiast or a professional looking to deploy OpenSign in a corporate environment, this guide will provide you with the necessary steps and tips to successfully self-host OpenSign\u2122 - the best open source document signing infrastructure.","sidebar":"selfhostSidebar"},"self-host/One-click-Install/DigitalOcean":{"id":"self-host/One-click-Install/DigitalOcean","title":"Digital Ocean","description":"OpenSign application consists of 3 components -","sidebar":"selfhostSidebar"}}}}')}}]); \ No newline at end of file diff --git a/assets/js/0058b4c6.f930bace.js b/assets/js/0058b4c6.f930bace.js deleted file mode 100644 index e7d878973..000000000 --- a/assets/js/0058b4c6.f930bace.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[849],{86164(e){e.exports=JSON.parse('{"version":{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"link","href":"/docs/help/intro","label":"Intro","docId":"help/intro","unlisted":false},{"type":"category","label":"Create New OpenSign Document","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/docs/help/New-Document/sign-yourself","label":"Sign your-self","docId":"help/New-Document/sign-yourself","unlisted":false},{"type":"link","href":"/docs/help/New-Document/request-signatures","label":"Request signatures","docId":"help/New-Document/request-signatures","unlisted":false},{"type":"link","href":"/docs/help/New-Document/widgets","label":"Widgets in OpenSign","docId":"help/New-Document/widgets","unlisted":false},{"type":"link","href":"/docs/help/New-Document/edit-document-before-sending","label":"Editing Your Document Before Sending","docId":"help/New-Document/edit-document-before-sending","unlisted":false},{"type":"link","href":"/docs/help/New-Document/enforce-email-verification","label":"Enforce email OTP verification","docId":"help/New-Document/enforce-email-verification","unlisted":false}],"href":"/docs/category/create-new-opensign-document"},{"type":"category","label":"Manage Docs using OpenSign\u2122 Drive","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/docs/help/OpenSign\u2122 Drive/create-document","label":"Create Docs & Folders","docId":"help/OpenSign\u2122 Drive/create-document","unlisted":false},{"type":"link","href":"/docs/help/OpenSign\u2122 Drive/list-grid-view","label":"Grid vs List view","docId":"help/OpenSign\u2122 Drive/list-grid-view","unlisted":false},{"type":"link","href":"/docs/help/OpenSign\u2122 Drive/organize-documents","label":"OpenSign\u2122 Drive Interface Documentation","docId":"help/OpenSign\u2122 Drive/organize-documents","unlisted":false},{"type":"link","href":"/docs/help/OpenSign\u2122 Drive/rename-document","label":"Rename documents from OpenSign\u2122 Drive","docId":"help/OpenSign\u2122 Drive/rename-document","unlisted":false}],"href":"/docs/category/manage-docs-using-opensign-drive"},{"type":"category","label":"Documents","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/docs/help/Reports/need-your-sign","label":"Need your sign","docId":"help/Reports/need-your-sign","unlisted":false},{"type":"link","href":"/docs/help/Reports/in-progress","label":"In Progress","docId":"help/Reports/in-progress","unlisted":false},{"type":"link","href":"/docs/help/Reports/completed","label":"Completed","docId":"help/Reports/completed","unlisted":false},{"type":"link","href":"/docs/help/Reports/drafts","label":"Drafts","docId":"help/Reports/drafts","unlisted":false},{"type":"link","href":"/docs/help/Reports/declined","label":"Declined","docId":"help/Reports/declined","unlisted":false},{"type":"link","href":"/docs/help/Reports/expired","label":"Expired","docId":"help/Reports/expired","unlisted":false},{"type":"link","href":"/docs/help/Reports/contactbook","label":"Contactbook","docId":"help/Reports/contactbook","unlisted":false}],"href":"/docs/category/documents"},{"type":"category","label":"Templates","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/docs/help/Templates/create-template","label":"Create Templates","docId":"help/Templates/create-template","unlisted":false},{"type":"link","href":"/docs/help/Templates/manage-templates","label":"Manage Templates","docId":"help/Templates/manage-templates","unlisted":false},{"type":"link","href":"/docs/help/Templates/use-template","label":"Use template to create documents","docId":"help/Templates/use-template","unlisted":false},{"type":"link","href":"/docs/help/Templates/quick-send","label":"Bulk Document Send for Signature Using Template","docId":"help/Templates/quick-send","unlisted":false},{"type":"link","href":"/docs/help/Templates/publicTemplate","label":"Setting up an OpenSign template for public signing","docId":"help/Templates/publicTemplate","unlisted":false},{"type":"link","href":"/docs/help/Templates/embed-template","label":"Embedding OpenSign templates","docId":"help/Templates/embed-template","unlisted":false}],"href":"/docs/category/templates"},{"type":"category","label":"Settings","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/docs/help/Settings/my-signature","label":"My Signature","docId":"help/Settings/my-signature","unlisted":false},{"type":"link","href":"/docs/help/Settings/APIToken","label":"API Token","docId":"help/Settings/APIToken","unlisted":false},{"type":"link","href":"/docs/help/Settings/Webhook","label":"Webhook","docId":"help/Settings/Webhook","unlisted":false},{"type":"link","href":"/docs/help/Settings/Preferences","label":"Preferences","docId":"help/Settings/Preferences","unlisted":false},{"type":"link","href":"/docs/help/Settings/Teams","label":"Manage Teams","docId":"help/Settings/Teams","unlisted":false},{"type":"link","href":"/docs/help/Settings/manage-users","label":"Manage users","docId":"help/Settings/manage-users","unlisted":false},{"type":"link","href":"/docs/help/Settings/disabledocumentid","label":"Disable DocumentId","docId":"help/Settings/disabledocumentid","unlisted":false},{"type":"link","href":"/docs/help/Settings/Custom-email-templates","label":"Custom email templates","docId":"help/Settings/Custom-email-templates","unlisted":false},{"type":"link","href":"/docs/help/Settings/SecurityManagement","label":"Security","docId":"help/Settings/SecurityManagement","unlisted":false}],"href":"/docs/category/settings"},{"type":"category","label":"User Menu","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/docs/help/User Menu/Profile","label":"Profile","docId":"help/User Menu/Profile","unlisted":false},{"type":"category","label":"Console","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/docs/help/User Menu/Console/analystics","label":"Analytics","docId":"help/User Menu/Console/analystics","unlisted":false},{"type":"link","href":"/docs/help/User Menu/Console/general","label":"General","docId":"help/User Menu/Console/general","unlisted":false},{"type":"link","href":"/docs/help/User Menu/Console/branding","label":"Branding","docId":"help/User Menu/Console/branding","unlisted":false},{"type":"link","href":"/docs/help/User Menu/Console/globalSMTP","label":"Global SMTP","docId":"help/User Menu/Console/globalSMTP","unlisted":false},{"type":"link","href":"/docs/help/User Menu/Console/emails","label":"Mail","docId":"help/User Menu/Console/emails","unlisted":false},{"type":"link","href":"/docs/help/User Menu/Console/custom_filestorage","label":"Custom File Storage","docId":"help/User Menu/Console/custom_filestorage","unlisted":false},{"type":"link","href":"/docs/help/User Menu/Console/signing_certificate","label":"Custom Signing Certificate","docId":"help/User Menu/Console/signing_certificate","unlisted":false},{"type":"link","href":"/docs/help/User Menu/Console/organizations","label":"Organizations","docId":"help/User Menu/Console/organizations","unlisted":false},{"type":"link","href":"/docs/help/User Menu/Console/orgadmin","label":"Org Admins","docId":"help/User Menu/Console/orgadmin","unlisted":false}],"href":"/docs/category/console"}],"href":"/docs/category/user-menu"},{"type":"category","label":"FAQs","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/docs/help/FAQs/","label":"Why is there no dropdown list when I sign a document myself?","docId":"help/FAQs/FAQs","unlisted":false},{"type":"link","href":"/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements","label":"Why am I getting \'Ensure this field is accurately filled and meets all requirements\'?","docId":"help/FAQs/Ensure this field is accurately filled and meets all requirements","unlisted":false},{"type":"link","href":"/docs/help/FAQs/Credit-Deductions","label":"Credit-Deductions","docId":"help/FAQs/Credit-Deductions","unlisted":false},{"type":"link","href":"/docs/help/FAQs/Max File Upload Size","label":"Max File Upload Size","docId":"help/FAQs/Max File Upload Size","unlisted":false},{"type":"link","href":"/docs/help/FAQs/User Deletion","label":"User Deletion","docId":"help/FAQs/User Deletion","unlisted":false}],"href":"/docs/category/faqs"}],"selfhostSidebar":[{"type":"link","href":"/docs/self-host/intro","label":"Self-Hosting OpenSign","docId":"self-host/intro","unlisted":false},{"type":"category","label":"Docker","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/docs/self-host/docker/run-locally","label":"Self-host OpenSign\u2122 with Docker on Linux/MacOS/Windows","docId":"self-host/docker/run-locally","unlisted":false},{"type":"link","href":"/docs/self-host/docker/upgrade-deployment","label":"OpenSign\u2122 Self-Hosted \'Upgrade Deployment\' Guide Using Docker on Linux, macOS, or Windows","docId":"self-host/docker/upgrade-deployment","unlisted":false}],"href":"/docs/category/docker"},{"type":"category","label":"Cloud Storage","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/docs/self-host/cloud-storage/s3","label":"AWS S3","docId":"self-host/cloud-storage/s3","unlisted":false}],"href":"/docs/category/cloud-storage"},{"type":"category","label":"Guides","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/docs/self-host/guides/azure-vm-setup","label":"OpenSign Deployment Guide on Azure VM via command-line","docId":"self-host/guides/azure-vm-setup","unlisted":false},{"type":"link","href":"/docs/self-host/guides/env-variables","label":"ENV variables which are used to setup OpenSign\u2122 with Docker on Localhost","docId":"self-host/guides/env-variables","unlisted":false},{"type":"link","href":"/docs/self-host/guides/how-to-generate-self-signed-document-signing-certificate","label":"How to generate self-signed document signing certificate?","docId":"self-host/guides/how-to-generate-self-signed-document-signing-certificate","unlisted":false},{"type":"link","href":"/docs/self-host/guides/upgrade-to-v2.1.0","label":"How to upgrade self-hosted OpenSign to v2.1.0?","docId":"self-host/guides/upgrade-to-v2.1.0","unlisted":false}],"href":"/docs/category/guides"},{"type":"category","label":"One-click-Install","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/docs/self-host/One-click-Install/DigitalOcean","label":"Digital Ocean","docId":"self-host/One-click-Install/DigitalOcean","unlisted":false}]}],"contributeSidebar":[{"type":"link","href":"/docs/contribute/CODE_OF_CONDUCT","label":"Code of conduct","docId":"contribute/CODE_OF_CONDUCT","unlisted":false},{"type":"link","href":"/docs/contribute/intro","label":"Contributing to OpenSign","docId":"contribute/intro","unlisted":false},{"type":"link","href":"/docs/contribute/INSTALLATION","label":"Installation instructions","docId":"contribute/INSTALLATION","unlisted":false},{"type":"link","href":"/docs/contribute/COMMUNITY","label":"Community at OpenSign\u2122","docId":"contribute/COMMUNITY","unlisted":false},{"type":"link","href":"/docs/contribute/REPORTING_GUIDELINES","label":"OpenSign\u2122 Reporting Guidelines","docId":"contribute/REPORTING_GUIDELINES","unlisted":false}],"apiSidebar":[{"type":"category","label":"v1.2","collapsed":false,"items":[{"type":"link","href":"/docs/API-docs/v1.2/opensign-api-v-1-2","label":"Introduction","docId":"API-docs/v1.2/opensign-api-v-1-2","unlisted":false},{"type":"category","label":"User","items":[{"type":"link","href":"/docs/API-docs/v1.2/get-user","label":"Get your account details","className":"get api-method","docId":"API-docs/v1.2/get-user","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/getcredits","label":"Get your API credits","className":"get api-method","docId":"API-docs/v1.2/getcredits","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Contacts","items":[{"type":"link","href":"/docs/API-docs/v1.2/createcontact","label":"Create Contact","className":"post api-method","docId":"API-docs/v1.2/createcontact","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/getcontact","label":"Get Contact","className":"get api-method","docId":"API-docs/v1.2/getcontact","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/update-contact","label":"Update Contact","className":"put api-method","docId":"API-docs/v1.2/update-contact","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/deletecontact","label":"Delete Contact","className":"delete api-method","docId":"API-docs/v1.2/deletecontact","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/contactlist","label":"Get Contact list","className":"get api-method","docId":"API-docs/v1.2/contactlist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Documents","items":[{"type":"link","href":"/docs/API-docs/v1.2/selfsign","label":"Self Sign","className":"post api-method","docId":"API-docs/v1.2/selfsign","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/draftdocument","label":"Draft Document","className":"post api-method","docId":"API-docs/v1.2/draftdocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/createdocument","label":"Create Document","className":"post api-method","docId":"API-docs/v1.2/createdocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/createdocumentwithtemplateid","label":"Create Document from Template","className":"post api-method","docId":"API-docs/v1.2/createdocumentwithtemplateid","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/getdocument","label":"Get Document","className":"get api-method","docId":"API-docs/v1.2/getdocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/update-document","label":"Update Document","className":"put api-method","docId":"API-docs/v1.2/update-document","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/revokedocument","label":"Revoke Document","className":"post api-method","docId":"API-docs/v1.2/revokedocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/deletedocument","label":"Delete Document","className":"delete api-method","docId":"API-docs/v1.2/deletedocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/getdocumentlist","label":"Get Document list from status","className":"get api-method","docId":"API-docs/v1.2/getdocumentlist","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/resendrequestmail","label":"Resend request mail","className":"post api-method","docId":"API-docs/v1.2/resendrequestmail","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/getsignerips","label":"Get Signer IPs","className":"get api-method","docId":"API-docs/v1.2/getsignerips","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/getformdata","label":"Get Formdata","className":"get api-method","docId":"API-docs/v1.2/getformdata","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/getsigninglinks","label":"Get Signing Links","className":"get api-method","docId":"API-docs/v1.2/getsigninglinks","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Templates","items":[{"type":"link","href":"/docs/API-docs/v1.2/drafttemplate","label":"Draft Template","className":"post api-method","docId":"API-docs/v1.2/drafttemplate","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/createtemplate","label":"Create Template","className":"post api-method","docId":"API-docs/v1.2/createtemplate","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/publictemplate","label":"Public Template","className":"post api-method","docId":"API-docs/v1.2/publictemplate","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/get-template","label":"Get Template","className":"get api-method","docId":"API-docs/v1.2/get-template","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/update-template","label":"Update Template","className":"put api-method","docId":"API-docs/v1.2/update-template","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/delete-template","label":"Delete Template","className":"delete api-method","docId":"API-docs/v1.2/delete-template","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/gettemplatelist","label":"Get Template list","className":"get api-method","docId":"API-docs/v1.2/gettemplatelist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Webhook","items":[{"type":"link","href":"/docs/API-docs/v1.2/get-webhook","label":"Get Webhook","className":"get api-method","docId":"API-docs/v1.2/get-webhook","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/save-update-webhook","label":"Save or Update Webhook","className":"post api-method","docId":"API-docs/v1.2/save-update-webhook","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/delete-webhook","label":"Delete Webhook","className":"delete api-method","docId":"API-docs/v1.2/delete-webhook","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Folder","items":[{"type":"link","href":"/docs/API-docs/v1.2/createfolder","label":"Create Folder","className":"post api-method","docId":"API-docs/v1.2/createfolder","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/getfolder","label":"Get Folder","className":"get api-method","docId":"API-docs/v1.2/getfolder","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/updatefolder","label":"Update Folder","className":"put api-method","docId":"API-docs/v1.2/updatefolder","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/deletefolder","label":"Delete Folder","className":"delete api-method","docId":"API-docs/v1.2/deletefolder","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/folderlist","label":"Get folder list","className":"get api-method","docId":"API-docs/v1.2/folderlist","unlisted":false}],"collapsed":true,"collapsible":true}],"collapsible":true,"href":"/docs/API-docs/v1.2"},{"type":"category","label":"v1.1","collapsed":false,"items":[{"type":"link","href":"/docs/API-docs/v1.1/opensign-api-v-1-1","label":"Introduction","docId":"API-docs/v1.1/opensign-api-v-1-1","unlisted":false},{"type":"category","label":"User","items":[{"type":"link","href":"/docs/API-docs/v1.1/get-user","label":"Get your account details","className":"get api-method","docId":"API-docs/v1.1/get-user","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/getcredits","label":"Get your API credits","className":"get api-method","docId":"API-docs/v1.1/getcredits","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Contacts","items":[{"type":"link","href":"/docs/API-docs/v1.1/createcontact","label":"Create Contact","className":"post api-method","docId":"API-docs/v1.1/createcontact","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/getcontact","label":"Get Contact","className":"get api-method","docId":"API-docs/v1.1/getcontact","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/update-contact","label":"Update Contact","className":"put api-method","docId":"API-docs/v1.1/update-contact","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/deletecontact","label":"Delete Contact","className":"delete api-method","docId":"API-docs/v1.1/deletecontact","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/contactlist","label":"Get Contact list","className":"get api-method","docId":"API-docs/v1.1/contactlist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Documents","items":[{"type":"link","href":"/docs/API-docs/v1.1/selfsign","label":"Self Sign","className":"post api-method","docId":"API-docs/v1.1/selfsign","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/draftdocument","label":"Draft Document","className":"post api-method","docId":"API-docs/v1.1/draftdocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/createdocument","label":"Create Document","className":"post api-method","docId":"API-docs/v1.1/createdocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/createdocumentwithtemplateid","label":"Create Document from Template","className":"post api-method","docId":"API-docs/v1.1/createdocumentwithtemplateid","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/getdocument","label":"Get Document","className":"get api-method","docId":"API-docs/v1.1/getdocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/update-document","label":"Update Document","className":"put api-method","docId":"API-docs/v1.1/update-document","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/revokedocument","label":"Revoke Document","className":"post api-method","docId":"API-docs/v1.1/revokedocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/deletedocument","label":"Delete Document","className":"delete api-method","docId":"API-docs/v1.1/deletedocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/getdocumentlist","label":"Get Document list from status","className":"get api-method","docId":"API-docs/v1.1/getdocumentlist","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/resendrequestmail","label":"Resend request mail","className":"post api-method","docId":"API-docs/v1.1/resendrequestmail","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/getsignerips","label":"Get Signer IPs","className":"get api-method","docId":"API-docs/v1.1/getsignerips","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/getformdata","label":"Get Formdata","className":"get api-method","docId":"API-docs/v1.1/getformdata","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/getsigninglinks","label":"Get Signing Links","className":"get api-method","docId":"API-docs/v1.1/getsigninglinks","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Templates","items":[{"type":"link","href":"/docs/API-docs/v1.1/drafttemplate","label":"Draft Template","className":"post api-method","docId":"API-docs/v1.1/drafttemplate","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/createtemplate","label":"Create Template","className":"post api-method","docId":"API-docs/v1.1/createtemplate","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/publictemplate","label":"Public Template","className":"post api-method","docId":"API-docs/v1.1/publictemplate","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/get-template","label":"Get Template","className":"get api-method","docId":"API-docs/v1.1/get-template","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/update-template","label":"Update Template","className":"put api-method","docId":"API-docs/v1.1/update-template","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/delete-template","label":"Delete Template","className":"delete api-method","docId":"API-docs/v1.1/delete-template","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/gettemplatelist","label":"Get Template list","className":"get api-method","docId":"API-docs/v1.1/gettemplatelist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Webhook","items":[{"type":"link","href":"/docs/API-docs/v1.1/get-webhook","label":"Get Webhook","className":"get api-method","docId":"API-docs/v1.1/get-webhook","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/save-update-webhook","label":"Save or Update Webhook","className":"post api-method","docId":"API-docs/v1.1/save-update-webhook","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/delete-webhook","label":"Delete Webhook","className":"delete api-method","docId":"API-docs/v1.1/delete-webhook","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Folder","items":[{"type":"link","href":"/docs/API-docs/v1.1/createfolder","label":"Create Folder","className":"post api-method","docId":"API-docs/v1.1/createfolder","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/getfolder","label":"Get Folder","className":"get api-method","docId":"API-docs/v1.1/getfolder","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/updatefolder","label":"Update Folder","className":"put api-method","docId":"API-docs/v1.1/updatefolder","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/deletefolder","label":"Delete Folder","className":"delete api-method","docId":"API-docs/v1.1/deletefolder","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/folderlist","label":"Get folder list","className":"get api-method","docId":"API-docs/v1.1/folderlist","unlisted":false}],"collapsed":true,"collapsible":true}],"collapsible":true,"href":"/docs/API-docs/v1.1"},{"type":"category","label":"v1","collapsed":true,"items":[{"type":"link","href":"/docs/API-docs/v1/opensign-api-v-1","label":"Introduction","docId":"API-docs/v1/opensign-api-v-1","unlisted":false},{"type":"category","label":"User","items":[{"type":"link","href":"/docs/API-docs/v1/get-user","label":"Get your account details","className":"get api-method","docId":"API-docs/v1/get-user","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Contacts","items":[{"type":"link","href":"/docs/API-docs/v1/createcontact","label":"Create Contact","className":"post api-method","docId":"API-docs/v1/createcontact","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/getcontact","label":"Get Contact","className":"get api-method","docId":"API-docs/v1/getcontact","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/deletecontact","label":"Delete Contact","className":"delete api-method","docId":"API-docs/v1/deletecontact","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/contactlist","label":"Get Contact list","className":"get api-method","docId":"API-docs/v1/contactlist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Documents","items":[{"type":"link","href":"/docs/API-docs/v1/selfsign","label":"Self Sign","className":"post api-method","docId":"API-docs/v1/selfsign","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/draftdocument","label":"Draft Document","className":"post api-method","docId":"API-docs/v1/draftdocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/createdocument","label":"Create Document","className":"post api-method","docId":"API-docs/v1/createdocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/createdocumentwithtemplateid","label":"Create Document from Template","className":"post api-method","docId":"API-docs/v1/createdocumentwithtemplateid","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/getdocument","label":"Get Document","className":"get api-method","docId":"API-docs/v1/getdocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/update-document","label":"Update Document","className":"put api-method","docId":"API-docs/v1/update-document","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/revokedocument","label":"Revoke Document","className":"post api-method","docId":"API-docs/v1/revokedocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/deletedocument","label":"Delete Document","className":"delete api-method","docId":"API-docs/v1/deletedocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/getdocumentlist","label":"Get Document list from status","className":"get api-method","docId":"API-docs/v1/getdocumentlist","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/resendrequestmail","label":"Resend request mail","className":"post api-method","docId":"API-docs/v1/resendrequestmail","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Templates","items":[{"type":"link","href":"/docs/API-docs/v1/drafttemplate","label":"Draft Template","className":"post api-method","docId":"API-docs/v1/drafttemplate","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/createtemplate","label":"Create Template","className":"post api-method","docId":"API-docs/v1/createtemplate","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/get-template","label":"Get Template","className":"get api-method","docId":"API-docs/v1/get-template","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/update-template","label":"Update Template","className":"put api-method","docId":"API-docs/v1/update-template","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/delete-template","label":"Delete Template","className":"delete api-method","docId":"API-docs/v1/delete-template","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/gettemplatelist","label":"Get Template list","className":"get api-method","docId":"API-docs/v1/gettemplatelist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Webhook","items":[{"type":"link","href":"/docs/API-docs/v1/get-webhook","label":"Get Webhook","className":"get api-method","docId":"API-docs/v1/get-webhook","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/save-update-webhook","label":"Save or Update Webhook","className":"post api-method","docId":"API-docs/v1/save-update-webhook","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/delete-webhook","label":"Delete Webhook","className":"delete api-method","docId":"API-docs/v1/delete-webhook","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Folder","items":[{"type":"link","href":"/docs/API-docs/v1/createfolder","label":"Create Folder","className":"post api-method","docId":"API-docs/v1/createfolder","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/getfolder","label":"Get Folder","className":"get api-method","docId":"API-docs/v1/getfolder","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/updatefolder","label":"Update Folder","className":"put api-method","docId":"API-docs/v1/updatefolder","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/deletefolder","label":"Delete Folder","className":"delete api-method","docId":"API-docs/v1/deletefolder","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/folderlist","label":"Get folder list","className":"get api-method","docId":"API-docs/v1/folderlist","unlisted":false}],"collapsed":true,"collapsible":true}],"collapsible":true,"href":"/docs/API-docs/v1"}]},"docs":{"API-docs/api-intro":{"id":"API-docs/api-intro","title":"OpenSign APIs","description":"Welcome to the OpenSign API. Choose a version from the sidebar:"},"API-docs/v1.1/contactlist":{"id":"API-docs/v1.1/contactlist","title":"Get Contact list","description":"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.","sidebar":"apiSidebar"},"API-docs/v1.1/createcontact":{"id":"API-docs/v1.1/createcontact","title":"Create Contact","description":"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.","sidebar":"apiSidebar"},"API-docs/v1.1/createdocument":{"id":"API-docs/v1.1/createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file.","sidebar":"apiSidebar"},"API-docs/v1.1/createdocumentwithtemplateid":{"id":"API-docs/v1.1/createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","sidebar":"apiSidebar"},"API-docs/v1.1/createfolder":{"id":"API-docs/v1.1/createfolder","title":"Create Folder","description":"The Create Folder API allows you to create folder.","sidebar":"apiSidebar"},"API-docs/v1.1/createtemplate":{"id":"API-docs/v1.1/createtemplate","title":"Create Template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.","sidebar":"apiSidebar"},"API-docs/v1.1/delete-template":{"id":"API-docs/v1.1/delete-template","title":"Delete Template","description":"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed","sidebar":"apiSidebar"},"API-docs/v1.1/delete-webhook":{"id":"API-docs/v1.1/delete-webhook","title":"Delete Webhook","description":"The Delete Webhook API allow you to delete webhook url","sidebar":"apiSidebar"},"API-docs/v1.1/deletecontact":{"id":"API-docs/v1.1/deletecontact","title":"Delete Contact","description":"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact\'s information, this API makes it easy to delete their record.","sidebar":"apiSidebar"},"API-docs/v1.1/deletedocument":{"id":"API-docs/v1.1/deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","sidebar":"apiSidebar"},"API-docs/v1.1/deletefolder":{"id":"API-docs/v1.1/deletefolder","title":"Delete Folder","description":"The delete Folder API allows you to delete folder.","sidebar":"apiSidebar"},"API-docs/v1.1/draftdocument":{"id":"API-docs/v1.1/draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","sidebar":"apiSidebar"},"API-docs/v1.1/drafttemplate":{"id":"API-docs/v1.1/drafttemplate","title":"Draft Template","description":"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.","sidebar":"apiSidebar"},"API-docs/v1.1/folderlist":{"id":"API-docs/v1.1/folderlist","title":"Get folder list","description":"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId","sidebar":"apiSidebar"},"API-docs/v1.1/get-template":{"id":"API-docs/v1.1/get-template","title":"Get Template","description":"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.","sidebar":"apiSidebar"},"API-docs/v1.1/get-user":{"id":"API-docs/v1.1/get-user","title":"Get your account details","description":"The Get User API enables you to get your own account details.","sidebar":"apiSidebar"},"API-docs/v1.1/get-webhook":{"id":"API-docs/v1.1/get-webhook","title":"Get Webhook","description":"The Get Webhook API allow you to get webhook url","sidebar":"apiSidebar"},"API-docs/v1.1/getcontact":{"id":"API-docs/v1.1/getcontact","title":"Get Contact","description":"The Get Contact API allows you to retrieve details about a specific contact.","sidebar":"apiSidebar"},"API-docs/v1.1/getcredits":{"id":"API-docs/v1.1/getcredits","title":"Get your API credits","description":"The Get Credits API returns details about the credits available to your account:","sidebar":"apiSidebar"},"API-docs/v1.1/getdocument":{"id":"API-docs/v1.1/getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","sidebar":"apiSidebar"},"API-docs/v1.1/getdocumentlist":{"id":"API-docs/v1.1/getdocumentlist","title":"Get Document list from status","description":"### Document Types:","sidebar":"apiSidebar"},"API-docs/v1.1/getfolder":{"id":"API-docs/v1.1/getfolder","title":"Get Folder","description":"The Get Folder API allows you to retrieve details about a specific folder.","sidebar":"apiSidebar"},"API-docs/v1.1/getformdata":{"id":"API-docs/v1.1/getformdata","title":"Get Formdata","description":"The Get Formdata API enables you to retrieve widget data filled by signers who signed the document.","sidebar":"apiSidebar"},"API-docs/v1.1/getsignerips":{"id":"API-docs/v1.1/getsignerips","title":"Get Signer IPs","description":"The Get Signer IPs API enables you to retrieve IPs of signers who signed the document.","sidebar":"apiSidebar"},"API-docs/v1.1/getsigninglinks":{"id":"API-docs/v1.1/getsigninglinks","title":"Get Signing Links","description":"The Get Signing Links API enables you to retrieve signing urls of signers for the document.","sidebar":"apiSidebar"},"API-docs/v1.1/gettemplatelist":{"id":"API-docs/v1.1/gettemplatelist","title":"Get Template list","description":"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.","sidebar":"apiSidebar"},"API-docs/v1.1/intro":{"id":"API-docs/v1.1/intro","title":"Overview","description":"OpenSign\u2122 API offers a robust suite of functionalities for digital document management and electronic signatures. Designed to cater to a wide array of business needs, the API facilitates the creation, signing, and management of digital documents. It ensures secure and efficient processes, complying with international legal standards for electronic signatures."},"API-docs/v1.1/opensign-api-v-1-1":{"id":"API-docs/v1.1/opensign-api-v-1-1","title":"OpenSign API v1.1","description":"Welcome to the **OpenSign\u2122 API v1.1** documentation.","sidebar":"apiSidebar"},"API-docs/v1.1/publictemplate":{"id":"API-docs/v1.1/publictemplate","title":"Public Template","description":"The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique **template_id** and a **public_url**. The **public_url** is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing.","sidebar":"apiSidebar"},"API-docs/v1.1/resendrequestmail":{"id":"API-docs/v1.1/resendrequestmail","title":"Resend request mail","description":"Resend request mail to user for signing document.","sidebar":"apiSidebar"},"API-docs/v1.1/revokedocument":{"id":"API-docs/v1.1/revokedocument","title":"Revoke Document","description":"The Revoke document API allows you to revoke specific document from your documents.","sidebar":"apiSidebar"},"API-docs/v1.1/save-update-webhook":{"id":"API-docs/v1.1/save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.","sidebar":"apiSidebar"},"API-docs/v1.1/selfsign":{"id":"API-docs/v1.1/selfsign","title":"Self Sign","description":"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.","sidebar":"apiSidebar"},"API-docs/v1.1/update-contact":{"id":"API-docs/v1.1/update-contact","title":"Update Contact","description":"The Update Contact API enables you to modify and update the details of a specific Contact.","sidebar":"apiSidebar"},"API-docs/v1.1/update-document":{"id":"API-docs/v1.1/update-document","title":"Update Document","description":"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.","sidebar":"apiSidebar"},"API-docs/v1.1/update-template":{"id":"API-docs/v1.1/update-template","title":"Update Template","description":"The Update Template API enables you to modify and update the details of a specific template.","sidebar":"apiSidebar"},"API-docs/v1.1/updatefolder":{"id":"API-docs/v1.1/updatefolder","title":"Update Folder","description":"The Update Folder API allows you to uodate folder name as well as parentFolderId.","sidebar":"apiSidebar"},"API-docs/v1.2/contactlist":{"id":"API-docs/v1.2/contactlist","title":"Get Contact list","description":"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.","sidebar":"apiSidebar"},"API-docs/v1.2/createcontact":{"id":"API-docs/v1.2/createcontact","title":"Create Contact","description":"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.","sidebar":"apiSidebar"},"API-docs/v1.2/createdocument":{"id":"API-docs/v1.2/createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file.","sidebar":"apiSidebar"},"API-docs/v1.2/createdocumentwithtemplateid":{"id":"API-docs/v1.2/createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","sidebar":"apiSidebar"},"API-docs/v1.2/createfolder":{"id":"API-docs/v1.2/createfolder","title":"Create Folder","description":"The Create Folder API allows you to create folder.","sidebar":"apiSidebar"},"API-docs/v1.2/createtemplate":{"id":"API-docs/v1.2/createtemplate","title":"Create Template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.","sidebar":"apiSidebar"},"API-docs/v1.2/delete-template":{"id":"API-docs/v1.2/delete-template","title":"Delete Template","description":"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed","sidebar":"apiSidebar"},"API-docs/v1.2/delete-webhook":{"id":"API-docs/v1.2/delete-webhook","title":"Delete Webhook","description":"The Delete Webhook API allow you to delete webhook url","sidebar":"apiSidebar"},"API-docs/v1.2/deletecontact":{"id":"API-docs/v1.2/deletecontact","title":"Delete Contact","description":"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact\'s information, this API makes it easy to delete their record.","sidebar":"apiSidebar"},"API-docs/v1.2/deletedocument":{"id":"API-docs/v1.2/deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","sidebar":"apiSidebar"},"API-docs/v1.2/deletefolder":{"id":"API-docs/v1.2/deletefolder","title":"Delete Folder","description":"The delete Folder API allows you to delete folder.","sidebar":"apiSidebar"},"API-docs/v1.2/draftdocument":{"id":"API-docs/v1.2/draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","sidebar":"apiSidebar"},"API-docs/v1.2/drafttemplate":{"id":"API-docs/v1.2/drafttemplate","title":"Draft Template","description":"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.","sidebar":"apiSidebar"},"API-docs/v1.2/folderlist":{"id":"API-docs/v1.2/folderlist","title":"Get folder list","description":"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId","sidebar":"apiSidebar"},"API-docs/v1.2/get-template":{"id":"API-docs/v1.2/get-template","title":"Get Template","description":"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.","sidebar":"apiSidebar"},"API-docs/v1.2/get-user":{"id":"API-docs/v1.2/get-user","title":"Get your account details","description":"The Get User API enables you to get your own account details.","sidebar":"apiSidebar"},"API-docs/v1.2/get-webhook":{"id":"API-docs/v1.2/get-webhook","title":"Get Webhook","description":"The Get Webhook API allow you to get webhook url","sidebar":"apiSidebar"},"API-docs/v1.2/getcontact":{"id":"API-docs/v1.2/getcontact","title":"Get Contact","description":"The Get Contact API allows you to retrieve details about a specific contact.","sidebar":"apiSidebar"},"API-docs/v1.2/getcredits":{"id":"API-docs/v1.2/getcredits","title":"Get your API credits","description":"The Get Credits API returns details about the credits available to your account:","sidebar":"apiSidebar"},"API-docs/v1.2/getdocument":{"id":"API-docs/v1.2/getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","sidebar":"apiSidebar"},"API-docs/v1.2/getdocumentlist":{"id":"API-docs/v1.2/getdocumentlist","title":"Get Document list from status","description":"### Document Types:","sidebar":"apiSidebar"},"API-docs/v1.2/getfolder":{"id":"API-docs/v1.2/getfolder","title":"Get Folder","description":"The Get Folder API allows you to retrieve details about a specific folder.","sidebar":"apiSidebar"},"API-docs/v1.2/getformdata":{"id":"API-docs/v1.2/getformdata","title":"Get Formdata","description":"The Get Formdata API enables you to retrieve widget data filled by signers who signed the document.","sidebar":"apiSidebar"},"API-docs/v1.2/getsignerips":{"id":"API-docs/v1.2/getsignerips","title":"Get Signer IPs","description":"The Get Signer IPs API enables you to retrieve IPs of signers who signed the document.","sidebar":"apiSidebar"},"API-docs/v1.2/getsigninglinks":{"id":"API-docs/v1.2/getsigninglinks","title":"Get Signing Links","description":"The Get Signing Links API enables you to retrieve signing urls of signers for the document.","sidebar":"apiSidebar"},"API-docs/v1.2/gettemplatelist":{"id":"API-docs/v1.2/gettemplatelist","title":"Get Template list","description":"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.","sidebar":"apiSidebar"},"API-docs/v1.2/intro":{"id":"API-docs/v1.2/intro","title":"Overview","description":"OpenSign\u2122 API v1.2 \u2014 the open-source DocuSign alternative, built for developers and trusted by enterprises."},"API-docs/v1.2/opensign-api-v-1-2":{"id":"API-docs/v1.2/opensign-api-v-1-2","title":"OpenSign API v1.2","description":"# OpenSign\u2122 API v1.2","sidebar":"apiSidebar"},"API-docs/v1.2/publictemplate":{"id":"API-docs/v1.2/publictemplate","title":"Public Template","description":"The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique **template_id** and a **public_url**. The **public_url** is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing.","sidebar":"apiSidebar"},"API-docs/v1.2/resendrequestmail":{"id":"API-docs/v1.2/resendrequestmail","title":"Resend request mail","description":"Resend request mail to user for signing document.","sidebar":"apiSidebar"},"API-docs/v1.2/revokedocument":{"id":"API-docs/v1.2/revokedocument","title":"Revoke Document","description":"The Revoke document API allows you to revoke specific document from your documents.","sidebar":"apiSidebar"},"API-docs/v1.2/save-update-webhook":{"id":"API-docs/v1.2/save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.","sidebar":"apiSidebar"},"API-docs/v1.2/selfsign":{"id":"API-docs/v1.2/selfsign","title":"Self Sign","description":"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.","sidebar":"apiSidebar"},"API-docs/v1.2/update-contact":{"id":"API-docs/v1.2/update-contact","title":"Update Contact","description":"The Update Contact API enables you to modify and update the details of a specific Contact.","sidebar":"apiSidebar"},"API-docs/v1.2/update-document":{"id":"API-docs/v1.2/update-document","title":"Update Document","description":"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.","sidebar":"apiSidebar"},"API-docs/v1.2/update-template":{"id":"API-docs/v1.2/update-template","title":"Update Template","description":"The Update Template API enables you to modify and update the details of a specific template.","sidebar":"apiSidebar"},"API-docs/v1.2/updatefolder":{"id":"API-docs/v1.2/updatefolder","title":"Update Folder","description":"The Update Folder API allows you to uodate folder name as well as parentFolderId.","sidebar":"apiSidebar"},"API-docs/v1/contactlist":{"id":"API-docs/v1/contactlist","title":"Get Contact list","description":"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.","sidebar":"apiSidebar"},"API-docs/v1/createcontact":{"id":"API-docs/v1/createcontact","title":"Create Contact","description":"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.","sidebar":"apiSidebar"},"API-docs/v1/createdocument":{"id":"API-docs/v1/createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file.","sidebar":"apiSidebar"},"API-docs/v1/createdocumentwithtemplateid":{"id":"API-docs/v1/createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","sidebar":"apiSidebar"},"API-docs/v1/createfolder":{"id":"API-docs/v1/createfolder","title":"Create Folder","description":"The Create Folder API allows you to create folder.","sidebar":"apiSidebar"},"API-docs/v1/createtemplate":{"id":"API-docs/v1/createtemplate","title":"Create Template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.","sidebar":"apiSidebar"},"API-docs/v1/delete-template":{"id":"API-docs/v1/delete-template","title":"Delete Template","description":"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed","sidebar":"apiSidebar"},"API-docs/v1/delete-webhook":{"id":"API-docs/v1/delete-webhook","title":"Delete Webhook","description":"The Delete Webhook API allow you to delete webhook url","sidebar":"apiSidebar"},"API-docs/v1/deletecontact":{"id":"API-docs/v1/deletecontact","title":"Delete Contact","description":"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact\'s information, this API makes it easy to delete their record.","sidebar":"apiSidebar"},"API-docs/v1/deletedocument":{"id":"API-docs/v1/deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","sidebar":"apiSidebar"},"API-docs/v1/deletefolder":{"id":"API-docs/v1/deletefolder","title":"Delete Folder","description":"The delete Folder API allows you to delete folder.","sidebar":"apiSidebar"},"API-docs/v1/draftdocument":{"id":"API-docs/v1/draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","sidebar":"apiSidebar"},"API-docs/v1/drafttemplate":{"id":"API-docs/v1/drafttemplate","title":"Draft Template","description":"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.","sidebar":"apiSidebar"},"API-docs/v1/folderlist":{"id":"API-docs/v1/folderlist","title":"Get folder list","description":"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId","sidebar":"apiSidebar"},"API-docs/v1/get-template":{"id":"API-docs/v1/get-template","title":"Get Template","description":"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.","sidebar":"apiSidebar"},"API-docs/v1/get-user":{"id":"API-docs/v1/get-user","title":"Get your account details","description":"The Get User API enables you to get your own account details.","sidebar":"apiSidebar"},"API-docs/v1/get-webhook":{"id":"API-docs/v1/get-webhook","title":"Get Webhook","description":"The Get Webhook API allow you to get webhook url","sidebar":"apiSidebar"},"API-docs/v1/getcontact":{"id":"API-docs/v1/getcontact","title":"Get Contact","description":"The Get Contact API allows you to retrieve details about a specific contact.","sidebar":"apiSidebar"},"API-docs/v1/getdocument":{"id":"API-docs/v1/getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","sidebar":"apiSidebar"},"API-docs/v1/getdocumentlist":{"id":"API-docs/v1/getdocumentlist","title":"Get Document list from status","description":"### Document Types:","sidebar":"apiSidebar"},"API-docs/v1/getfolder":{"id":"API-docs/v1/getfolder","title":"Get Folder","description":"The Get Folder API allows you to retrieve details about a specific folder.","sidebar":"apiSidebar"},"API-docs/v1/gettemplatelist":{"id":"API-docs/v1/gettemplatelist","title":"Get Template list","description":"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.","sidebar":"apiSidebar"},"API-docs/v1/intro":{"id":"API-docs/v1/intro","title":"Overview","description":"OpenSign\u2122 API offers a robust suite of functionalities for digital document management and electronic signatures. Designed to cater to a wide array of business needs, the API facilitates the creation, signing, and management of digital documents. It ensures secure and efficient processes, complying with international legal standards for electronic signatures."},"API-docs/v1/opensign-api-v-1":{"id":"API-docs/v1/opensign-api-v-1","title":"OpenSign API v1","description":"Welcome to the OpenSign\u2122 API documentation!","sidebar":"apiSidebar"},"API-docs/v1/resendrequestmail":{"id":"API-docs/v1/resendrequestmail","title":"Resend request mail","description":"Resend request mail to user for signing document.","sidebar":"apiSidebar"},"API-docs/v1/revokedocument":{"id":"API-docs/v1/revokedocument","title":"Revoke Document","description":"The Revoke document API allows you to revoke specific document from your documents.","sidebar":"apiSidebar"},"API-docs/v1/save-update-webhook":{"id":"API-docs/v1/save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.","sidebar":"apiSidebar"},"API-docs/v1/selfsign":{"id":"API-docs/v1/selfsign","title":"Self Sign","description":"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.","sidebar":"apiSidebar"},"API-docs/v1/update-document":{"id":"API-docs/v1/update-document","title":"Update Document","description":"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.","sidebar":"apiSidebar"},"API-docs/v1/update-template":{"id":"API-docs/v1/update-template","title":"Update Template","description":"The Update Template API enables you to modify and update the details of a specific template.","sidebar":"apiSidebar"},"API-docs/v1/updatefolder":{"id":"API-docs/v1/updatefolder","title":"Update Folder","description":"The Update Folder API allows you to uodate folder name as well as parentFolderId.","sidebar":"apiSidebar"},"contribute/CODE_OF_CONDUCT":{"id":"contribute/CODE_OF_CONDUCT","title":"Code of conduct","description":"1. Introduction","sidebar":"contributeSidebar"},"contribute/COMMUNITY":{"id":"contribute/COMMUNITY","title":"Community at OpenSign\u2122","description":"Welcome to the OpenSign\u2122 Community page! OpenSign\u2122 is dedicated to fostering a vibrant and engaging community where members can connect, share ideas and collaborate on the OpenSign\u2122 project. This page provides links to our active social media platforms and community channels, offering various ways for you to join and participate in the OpenSign\u2122 community. Whether you\'re looking for support, eager to contribute or just want to stay updated, you\'ll find a platform that suits your preference. Connect with us on Discord for real-time discussions, follow us on Twitter for the latest updates, engage with our professional network on LinkedIn or join our Facebook group for a broader community experience. Join us in our mission to develop OpenSign\u2122 as the premier open-source alternative to DocuSign.","sidebar":"contributeSidebar"},"contribute/INSTALLATION":{"id":"contribute/INSTALLATION","title":"Installation instructions","description":"You can use our app as a cloud version from OpenSignLabs","sidebar":"contributeSidebar"},"contribute/intro":{"id":"contribute/intro","title":"Contributing to OpenSign","description":"Hello there! Thank you for considering contributing to OpenSign, the open-source alternative to DocuSign. OpenSign is not just a project, but a community endeavor that aims to create a robust, user-friendly, and secure electronic signature solution. Your contributions, irrespective of their size, are valuable in making this vision a reality.","sidebar":"contributeSidebar"},"contribute/REPORTING_GUIDELINES":{"id":"contribute/REPORTING_GUIDELINES","title":"OpenSign\u2122 Reporting Guidelines","description":"This document provides guidelines for reporting issues, suggesting enhancements, and submitting pull requests to the OpenSign\u2122 GitHub repository. Adhering to these guidelines helps maintain the project\'s quality and efficiency.","sidebar":"contributeSidebar"},"help/FAQs/Credit-Deductions":{"id":"help/FAQs/Credit-Deductions","title":"Credit-Deductions","description":"1. When are Premium Credits deducted? Which actions use Premium Credits?","sidebar":"tutorialSidebar"},"help/FAQs/Ensure this field is accurately filled and meets all requirements":{"id":"help/FAQs/Ensure this field is accurately filled and meets all requirements","title":"Why am I getting \'Ensure this field is accurately filled and meets all requirements\'?","description":"This happens when you leave a field blank or when you don\u2019t enter correct values in the field, for example not entering email address in correct format.","sidebar":"tutorialSidebar"},"help/FAQs/FAQs":{"id":"help/FAQs/FAQs","title":"Why is there no dropdown list when I sign a document myself?","description":"The dropdown list field is available only when you request a signature from others or when you create a template. This is because dropdown lists function as temporary widgets, allowing the user to select one of multiple values. Once a signer selects a value from the dropdown, it is embedded into the document as text. When you sign a document yourself, OpenSign digitally signs it immediately upon clicking the finish button. Therefore, you can use the text widget to add the necessary text to the document.","sidebar":"tutorialSidebar"},"help/FAQs/Max File Upload Size":{"id":"help/FAQs/Max File Upload Size","title":"Max File Upload Size","description":"\u2753 What is the default maximum file size that can be uploaded to OpenSign?","sidebar":"tutorialSidebar"},"help/FAQs/User Deletion":{"id":"help/FAQs/User Deletion","title":"User Deletion","description":"\u2753 Who can delete users?","sidebar":"tutorialSidebar"},"help/intro":{"id":"help/intro","title":"Intro","description":"\ud83c\udf1fGet ready for an electrifying journey at OpenSign\u2122, the most incredibly documented open source document signing solution! \ud83d\ude80 This is your go-to spot for diving deep into everything OpenSign\u2122 has to offer. Whether you\u2019re just starting out or you\u2019re a seasoned pro eager to uncover even more cool features, we\u2019ve got you covered with the most awesome, top-notch guides and resources around. Get ready to make the most out of OpenSign\u2122 \ud83c\udf89\ud83d\udcda\ud83d\udd0d Your adventure in excellence starts here! \ud83c\udf08\u2728\ud83c\udf1f","sidebar":"tutorialSidebar"},"help/New-Document/edit-document-before-sending":{"id":"help/New-Document/edit-document-before-sending","title":"Editing Your Document Before Sending","description":"OpenSign\u2122 lets you polish your PDF before you send it out\u2014whether you\u2019re signing it yourself, requesting signatures, or saving it as a template. You get four core editing controls right in the preview:","sidebar":"tutorialSidebar"},"help/New-Document/enforce-email-verification":{"id":"help/New-Document/enforce-email-verification","title":"Enforce email OTP verification","description":"The \\"Enable OTP Verification\\" feature in OpenSign is designed to add an extra layer of security to the document-signing process by verifying the signer\u2019s email address. Here\u2019s an in-depth look at how it works, when to use it, and its impact on the signing process.","sidebar":"tutorialSidebar"},"help/New-Document/request-signatures":{"id":"help/New-Document/request-signatures","title":"Request signatures","description":"Interface Overview","sidebar":"tutorialSidebar"},"help/New-Document/sign-yourself":{"id":"help/New-Document/sign-yourself","title":"Sign your-self","description":"Interface Overview","sidebar":"tutorialSidebar"},"help/New-Document/widgets":{"id":"help/New-Document/widgets","title":"Widgets in OpenSign","description":"Widgets in OpenSign are interactive fields that you can place on your documents to collect information, signatures, or confirmations from recipients during the signing process.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/create-document":{"id":"help/OpenSign\u2122 Drive/create-document","title":"Create Docs & Folders","description":"OpenSign Drive offers a streamlined way to manage, sign, and request signatures on your important documents. Whether you\'re drafting an offer letter or storing signed agreements, organizing your documents effectively is crucial. Here\u2019s a step-by-step guide on how to create documents and folders in OpenSign Drive.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/list-grid-view":{"id":"help/OpenSign\u2122 Drive/list-grid-view","title":"Grid vs List view","description":"- Navigate to OpenSign drive using the main menu or clicking this link.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/organize-documents":{"id":"help/OpenSign\u2122 Drive/organize-documents","title":"OpenSign\u2122 Drive Interface Documentation","description":"Overview","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/rename-document":{"id":"help/OpenSign\u2122 Drive/rename-document","title":"Rename documents from OpenSign\u2122 Drive","description":"The OpenSign\u2122 Drive interface allows users to rename their documents efficiently.","sidebar":"tutorialSidebar"},"help/Reports/completed":{"id":"help/Reports/completed","title":"Completed","description":"---","sidebar":"tutorialSidebar"},"help/Reports/contactbook":{"id":"help/Reports/contactbook","title":"Contactbook","description":"The Contactbook report in OpenSign enables you to add and manage contacts.","sidebar":"tutorialSidebar"},"help/Reports/declined":{"id":"help/Reports/declined","title":"Declined","description":"The \\"Declined documents\\" report within OpenSign serves as a vital tool for managing and reviewing all declined documents that have been processed through the platform. This guide will walk you through the key features and functionalities of the \\"Declined documents\\" report, enabling you to efficiently navigate and manage your signed documents.","sidebar":"tutorialSidebar"},"help/Reports/drafts":{"id":"help/Reports/drafts","title":"Drafts","description":"The Draft documents section in OpenSign helps you manage all your in-progress documents easily. This feature allows you to save, review, and edit documents before sending them for signature. Here\'s a detailed overview of how to navigate and use the Draft Documents report effectively.","sidebar":"tutorialSidebar"},"help/Reports/expired":{"id":"help/Reports/expired","title":"Expired","description":"The Expired documents report in OpenSign allows you to manage and review documents that have reached their expiration date without being signed. This feature is essential for maintaining an organized record of inactive documents that may require follow-up or archival.","sidebar":"tutorialSidebar"},"help/Reports/in-progress":{"id":"help/Reports/in-progress","title":"In Progress","description":"The In-Progress documents report in OpenSign helps you monitor and manage documents that are currently in the signing process. This report enables you to monitor the status of your documents, manually share the document URL, track document progress, resend reminders, revoke access, or delete documents that are no longer required. Here\u2019s a detailed guide on how to use the In-Progress documents report effectively.","sidebar":"tutorialSidebar"},"help/Reports/need-your-sign":{"id":"help/Reports/need-your-sign","title":"Need your sign","description":"The \\"Need your sign\\" feature in OpenSign is designed to simplify the process of managing documents that require your signature. This guide will walk you through the various elements of the \\"Need your sign\\" report, helping you to efficiently navigate and complete your pending signing tasks.","sidebar":"tutorialSidebar"},"help/Settings/APIToken":{"id":"help/Settings/APIToken","title":"API Token","description":"To authenticate and use OpenSign API endpoints, you\u2019ll need a valid API token (x-api-token).","sidebar":"tutorialSidebar"},"help/Settings/Custom-email-templates":{"id":"help/Settings/Custom-email-templates","title":"Custom email templates","description":"\ud83d\ude80 Steps to Set Up Custom Email Templates","sidebar":"tutorialSidebar"},"help/Settings/disabledocumentid":{"id":"help/Settings/disabledocumentid","title":"Disable DocumentId","description":"Whenever a document is signed by all parties, OpenSign\u2122 adds a DocumentId at the top left corner of the digitally signed document.","sidebar":"tutorialSidebar"},"help/Settings/manage-users":{"id":"help/Settings/manage-users","title":"Manage users","description":"The User Management feature in OpenSign allows administrators to add, edit, and manage users within the platform. This functionality is available on Self-Hosted, Teams, and Enterprise plans.","sidebar":"tutorialSidebar"},"help/Settings/my-signature":{"id":"help/Settings/my-signature","title":"My Signature","description":"This guide provides instructions on how to save your signature and initials using the OpenSign application. Once saved, you can use them with one click when signing documents. To create your signature, start by clicking the \\"My Signature\\" link under \\"settings\\" menu.","sidebar":"tutorialSidebar"},"help/Settings/Preferences":{"id":"help/Settings/Preferences","title":"Preferences","description":"The Preferences page in OpenSign\u2122 allows users and administrators to tailor the signing experience to suit individual, team, or organizational needs. Below is a breakdown of all configurable options and what they control.","sidebar":"tutorialSidebar"},"help/Settings/SecurityManagement":{"id":"help/Settings/SecurityManagement","title":"Security","description":"\u2705 Two-Factor Authentication (2FA)","sidebar":"tutorialSidebar"},"help/Settings/Teams":{"id":"help/Settings/Teams","title":"Manage Teams","description":"The Teams feature in OpenSign allows you to organize your users into structured groups for easier management, permissions control, and streamlined workflow configuration.","sidebar":"tutorialSidebar"},"help/Settings/Webhook":{"id":"help/Settings/Webhook","title":"Webhook","description":"\ud83d\udd14 What is a Webhook?","sidebar":"tutorialSidebar"},"help/Templates/create-template":{"id":"help/Templates/create-template","title":"Create Templates","description":"Getting Started","sidebar":"tutorialSidebar"},"help/Templates/embed-template":{"id":"help/Templates/embed-template","title":"Embedding OpenSign templates","description":"OpenSign Template Embedding allows users to seamlessly integrate public document templates into their websites or applications. By embedding templates, you can provide a direct and interactive signing experience for your users without requiring them to leave your platform. This feature supports various technologies like React, Next.js, HTML, JavaScript, and Angular, making it easy to add signing capabilities to different web projects.","sidebar":"tutorialSidebar"},"help/Templates/manage-templates":{"id":"help/Templates/manage-templates","title":"Manage Templates","description":"Viewing and Managing Templates","sidebar":"tutorialSidebar"},"help/Templates/publicTemplate":{"id":"help/Templates/publicTemplate","title":"Setting up an OpenSign template for public signing","description":"The OpenSign Public profile feature offers the ultimate public document signing solution without any need for integrations. With this feature, users can share document templates publicly, allowing anyone to access and sign the documents directly through the shared templates. This streamlines the signing process by providing a seamless, accessible way for public signers to complete documents without additional steps or integrations.","sidebar":"tutorialSidebar"},"help/Templates/quick-send":{"id":"help/Templates/quick-send","title":"Bulk Document Send for Signature Using Template","description":"Overview","sidebar":"tutorialSidebar"},"help/Templates/use-template":{"id":"help/Templates/use-template","title":"Use template to create documents","description":"Step 1: Begin New Template Creation","sidebar":"tutorialSidebar"},"help/User Menu/Console/analystics":{"id":"help/User Menu/Console/analystics","title":"Analytics","description":"Documents Signed","sidebar":"tutorialSidebar"},"help/User Menu/Console/branding":{"id":"help/User Menu/Console/branding","title":"Branding","description":"Custom Subdomain","sidebar":"tutorialSidebar"},"help/User Menu/Console/custom_filestorage":{"id":"help/User Menu/Console/custom_filestorage","title":"Custom File Storage","description":"\ud83c\udf29\ufe0f Introduction to BYOC (Bring Your Own Cloud)","sidebar":"tutorialSidebar"},"help/User Menu/Console/emails":{"id":"help/User Menu/Console/emails","title":"Mail","description":"This page allows the admin user to configure and manage customized email templates at the organization level.","sidebar":"tutorialSidebar"},"help/User Menu/Console/general":{"id":"help/User Menu/Console/general","title":"General","description":"The General Settings section in OpenSign provides key administrative settings to help you manage and control the overall configuration of your OpenSign platform.","sidebar":"tutorialSidebar"},"help/User Menu/Console/globalSMTP":{"id":"help/User Menu/Console/globalSMTP","title":"Global SMTP","description":"\ud83c\udfe2 SMTP at the Organization Level","sidebar":"tutorialSidebar"},"help/User Menu/Console/orgadmin":{"id":"help/User Menu/Console/orgadmin","title":"Org Admins","description":"The Org Admins section allows administrators to manage organization-level admin users within OpenSign.","sidebar":"tutorialSidebar"},"help/User Menu/Console/organizations":{"id":"help/User Menu/Console/organizations","title":"Organizations","description":"The Organizations section in OpenSign allows administrators to create and manage separate groups within a Team or Enterprise account.","sidebar":"tutorialSidebar"},"help/User Menu/Console/signing_certificate":{"id":"help/User Menu/Console/signing_certificate","title":"Custom Signing Certificate","description":"The Custom Signing Certificate page allows you to upload and manage your own digital signing certificate (PFX format) for secure and verified document signing in OpenSign.","sidebar":"tutorialSidebar"},"help/User Menu/Profile":{"id":"help/User Menu/Profile","title":"Profile","description":"The Profile in OpenSign allows users to manage their personal and account-related details. You can update your information, verify your email, and set up a public profile.","sidebar":"tutorialSidebar"},"intro":{"id":"intro","title":"Tutorial Intro","description":"Let\'s discover Docusaurus in less than 5 minutes."},"self-host/cloud-storage/s3":{"id":"self-host/cloud-storage/s3","title":"AWS S3","description":"You can create an AWS S3 bucket to store your uploaded documents using OpenSign\u2122","sidebar":"selfhostSidebar"},"self-host/docker/run-locally":{"id":"self-host/docker/run-locally","title":"Self-host OpenSign\u2122 with Docker on Linux/MacOS/Windows","description":"Steps to run OpenSign\u2122 with docker on Linux/MacOS/Windows:","sidebar":"selfhostSidebar"},"self-host/docker/upgrade-deployment":{"id":"self-host/docker/upgrade-deployment","title":"OpenSign\u2122 Self-Hosted \'Upgrade Deployment\' Guide Using Docker on Linux, macOS, or Windows","description":"This guide provides step-by-step instructions to upgrade the deployment of OpenSign using Docker.","sidebar":"selfhostSidebar"},"self-host/guides/azure-vm-setup":{"id":"self-host/guides/azure-vm-setup","title":"OpenSign Deployment Guide on Azure VM via command-line","description":"\ud83e\uddf1 Prerequisites","sidebar":"selfhostSidebar"},"self-host/guides/env-variables":{"id":"self-host/guides/env-variables","title":"ENV variables which are used to setup OpenSign\u2122 with Docker on Localhost","description":"Information About ENV variables which are used to setup OpenSign\u2122 with Docker on Localhost","sidebar":"selfhostSidebar"},"self-host/guides/how-to-generate-self-signed-document-signing-certificate":{"id":"self-host/guides/how-to-generate-self-signed-document-signing-certificate","title":"How to generate self-signed document signing certificate?","description":"","sidebar":"selfhostSidebar"},"self-host/guides/upgrade-to-v2.1.0":{"id":"self-host/guides/upgrade-to-v2.1.0","title":"How to upgrade self-hosted OpenSign to v2.1.0?","description":"For self-hosted deployments, version 2.1.0 introduces changes to the signup process:","sidebar":"selfhostSidebar"},"self-host/intro":{"id":"self-host/intro","title":"Self-Hosting OpenSign","description":"This section of the OpenSign\u2122 documentation is dedicated to guiding you through the process of self-hosting the OpenSign platform. Self-hosting OpenSign allows for greater control and customization, ensuring that it aligns perfectly with your specific needs and infrastructure requirements. We cover everything from initial setup, configuration options, to maintenance best practices. Whether you are an individual enthusiast or a professional looking to deploy OpenSign in a corporate environment, this guide will provide you with the necessary steps and tips to successfully self-host OpenSign\u2122 - the best open source document signing infrastructure.","sidebar":"selfhostSidebar"},"self-host/One-click-Install/DigitalOcean":{"id":"self-host/One-click-Install/DigitalOcean","title":"Digital Ocean","description":"OpenSign application consists of 3 components -","sidebar":"selfhostSidebar"}}}}')}}]); \ No newline at end of file diff --git a/assets/js/02e5f5c4.4a1b75f8.js b/assets/js/02e5f5c4.4a1b75f8.js new file mode 100644 index 000000000..0de24af58 --- /dev/null +++ b/assets/js/02e5f5c4.4a1b75f8.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[5373],{42232(e,t,a){a.r(t),a.d(t,{assets:()=>m,contentTitle:()=>P,default:()=>v,frontMatter:()=>f,metadata:()=>r,toc:()=>w});const r=JSON.parse('{"id":"API-docs/v1.1/createfolder","title":"Create Folder","description":"The Create Folder API allows you to create folder.","source":"@site/docs/API-docs/v1.1/createfolder.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/createfolder","permalink":"/docs/API-docs/v1.1/createfolder","draft":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJzNGdtuG7n1V04ZoIiFkWRnL0W1xbZex5vNNk0My26AWoaHmjnScMUhZ0nOyIItYB+KfkDRl772J/reT8mXFIccji5Ok3W3WPQhjk0envt97pjjc8tGV+xrLXM07DphOdrMiMoJrdiIXRQIJwa5QwggcHz2EriUemlhpWtwGrJwP/P3A5YwXaHhhOBlzkYsXIdbljCD39do3Vc6X7HR3R65M6MbkSNMUeolVNzwEh2aB1RYwjKtHCpHOHhVSZF5isPvLCG6YzYrsOT0GxEUBnMSM7xWvEQS1a0qZCOmp99h5ljCKkOcO4GW3gXY1wQ7uouw1hmh5ixhM21K7rZP8JaXlSQghcvI5zphFTeoXNAeKeRxuNh6nTAnnP8jIL2Zku7WdLGRzZka/YGttLJBgmeHhw9VHHC06szB1lmG1s5qKVe/eIxaP6y8cPx4caviaFrcPvuuIs39f1jg22eK288W4gwJV6u3Y/c+NJtHzw6ffdI/Ouwf/uri6PPRp78effb54PDw8E8sYbelpLfeCUcs587jjSaOf9dV/jPQWe+DBaXl6LiQlj1wPfK6dcI+fZ9jjXWJrhBqDktUDpZGq3kClURuEZxZAZ9zoUByh+Z/6GlojDYfVtLjONsOOKGkUHgTo+rm08PDm6NOCZ89VMJL1XApcp8lL/QC1c8r6TZ5F8g/tLEIQP6e7Qi7fR6EtJjVRrgVG13dsds+r0Q/3I+urtfXCSPFasrylbaeY+4KNmLDvaRv0TRorMdSG8lGrHCusqPh0HKVT/XtQFeorJgryad2kOlyyCsxbI4Gz9g62X/Dq+pR8Fj3H/vEOj4Xav6xd9cbDY3JisFQO3rqzMUr8XtcsSSaYRsqYYK8p0Aegixh5Bznm1J5Gk28W5e2E93DPMfIukLNtOeitfKbCtVYzJX3ES/Ffs1/AhHm3Z//0YFN1ER9Cb0edQSkkb7VtckQnuus9vi4dFRanWgQ3v3wN5jWQjqYaQM5NijJk20CztSW6s50BagcmsoIi3bQ6xH+bbpz0WBoMThkmoR3mEBldF5nxGjfIM9XgH0yDXe1Qagkd5TJwRVG1/MCOFih5hITOD8dX8xqSdIMYIwqh1xndYnKWc9ihySBkis+R3BYEj70PPNs4UEoh1jHXW1BKDDIJThRYgJc5cBrp0vqUVa6NiSdMNiRASlmmK0yGZTDpYSlcIWuHTSocm1A6mzRF2pAiuj3+/TfkyfwAp0jqmPHjcOcTk8bNCto+ygoa+sg48asAt0u9IlDVyCkW46WQnAxTyRN04nauhzBbwjD5uDLFmaier13f/krXH2jl9SKzVFRg4d7BK+fxujJdWYfhg2dDguU1XAchLLD47OXPkseBPu/1g4sWXJZoEEiNcW5UL+FS0rUBUKv1+YLQNUIoxWptteDp+mPzifpAeGtjHaaArOzAp/NMPOqluTBOXd8zxQn2iCc8IpPhRSUlOn8Hk64w7k2K7iHtwV33mUzriDXcD9R9/1+3/8j0F7vefS6Xg/u2846AYsqTyCU/AQMNnrR+lSO5Pcb9+xHs2/ct8V8Ef3VY/6qFjIHg7XlU7nlzF5cqAz2K8kzzGEp8jk6+4XngTSjFYI2FAUrTxZNR2KMctan+PQkXkQvsHTsQbejqtNriwWEaoTzlQ9m1N23SM/qqRQZ7LI/LrhB4FCFyxh6UqiFDx+lI1YprIPYBkeczw2fOXirzYIoBYy8wS3utNnSCbeQ0wvrVT4TiksRHK4MTUHEe6KV41lrvD+EPOFjoGUmC/cw1XpBLjY3vCy5ExmXchWRhPwccLwxc66I1oYzoSxNQF2afm7IHUOO7yzxFqeF1ouA5BwzJBhKR31KR4ANZRylnZi1zYaF4JkG9FIBqrzSQrmI7tJGhs7RGYENAs8yXSvnNZIZzIUDqiTUJpMF73dDgxz/3Q9/t/Aal5R3YsGgyydw7BzPCp8F33p3g3FdVdq4iaJqkvLu3qatQ4KwoPQSbADEHLQKRupUlcSRcHMQAKJhO4DNAUnT+lQ8pPxlB5HVb0j342DNcet1r4Ra2Ikao4N0wgqR402w903rlzfSQ7ARVTeEe5hxaTElltOzN+MLGHrGIp8phRmhiW6z7d42pu1dYSG2oIONWk8kcnoeQycaj8uJSl+cXsAwyjgciTz1wu+eU/CkUFBoTBEVWGeQl9Ty5j7MDOa1yrlym1HcAkWmwVI3mHuUvV5lcCak9DkzGs6gqw3hsUhvHcoVzIwuo8wbhL0e1dwFKaCbXgG5Fe3cr5WtS+wsdMatXWqT98+MdpiRa5w9/3rjUXRPdpoJiTdVCzxhadRrTKA0RFOdUbDUxlP3qRFVZlZVi9UOIl7vgKOJau0ZHCuqMYV//RPSs8sHGvfHWw+iNYejCHezC7bnJ3sXe/T8BSVfUmka9fNmNiMDdt5LOcto2fmv393c6ADlPfhDjrsvqPeh90jqNOAtjTbCSersfNWh1k+EAtTS61ydei7kWdGFYWffNvjOtaQC6/NDW4ZSCIOR9y+eZVhRxiaZ2nA0WiJZeiZQ5sAzo631nZaXgtKW0bVDO4CLwiACwQd/7tLMKNR0ok5VFAveCMqa+5W85SmF3tMcZ7yW7sDXBN+Mtd0qpVyaMZ2vqZs2tc1wAU8jcEl4ujRuQ/THuCdFGSQo0EquYvVry3bYxMXCl/KqMroJ6E64CpFNhTyC4y1pra3JgZu2dnpi911q4WaqFZzoagVPT04OiDlRCcrQE3UMNHWkE5ZlG20/yNdcajX3pYzkwVthfXOVTth0+x2l9S5/bxJ1yH7kbV130VlxGBqlzpinJRcSeJ4btJQ7KKthTvHe8WjaEsmpU55q1c9Isu0CCeixaJXhrgGE7QyaD+CVWOBGhoTY3+EGnto6K6ijCFGyiXiRpwfUEzQib/UQWCN7GZG3du+qUsNljYmv5CFLkWalIMVSmwJYVm4F3Bi+gqfp1XV68AXoUjiPJajWaRCqQNMe7qLe622PGy6kj9TTTWPdNrhbJxQTtDS5PH/1nuZ2HHpv30g8oiHvOsFuttvF8MEZvHt9egnnOH/w+GOzf7rfyvwRjRXaJ6lfwlc8Wyy5yS2c6LLiTvjWf0Wg9Jicw29OYRoB+1kLKMNoAc2Rd+PmaHDUTX6x/7KhJLpCW4QmEA4JiXf20FS2hIVp1LvHqjRMDYaqmRVczSkQqPnaKtSCEn9eZyEWPL+EWvs5n0uolURrQbsCzZKaUKXJx3fVcWmR5ua2B5qoPlx1relbnFrhcDP3LZfLB5o+8G++rqWEOPz4gPvItBievRDum3oK51hpK5w2q82ruXBFPfW23H7b/dEiiENKt5D7KVOqR3mBprSgZzBG04jsI+IPHYEPDya05NlbDO2uXQzO0FDesTszNq9EO89fRT6A2PspcvhFdphV/GKRUl/YUP1uH49fEJIIb2atvO2W7MPysoRJkaGyuLV4PH5x9gqaTwaHLNlat/0IWw5fvTw5fT0+JWbaMGEjdjQ4HBz6/b62ruRqi9LOJ6v9BdfdZiH7333fahd6Dm/dsJJc+C2qF+iuXYBe7X71uk5YQfvR0RW7u6NAvjRyvabj72s0tFy9TljDjaCI96vVJO4CaWO6wBXJFJjuXxB1Apd1WCvubZRpmRleHPse6YOw2ytc6vhYwqbtl7lS5/TG8CV9teNL2ifStz0/TvoPa3R2xyRX85rPCTbgpPUlr0kN27vPhd99tr+QVPFKrbY43F2KBjHoJwn13gd3d2Gvul538OHqP75oFRuhyXrX6/X637U5Qlw=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Webhook","permalink":"/docs/API-docs/v1.1/delete-webhook"},"next":{"title":"Get Folder","permalink":"/docs/API-docs/v1.1/getfolder"}}');var o=a(74848),l=a(28453),i=a(57742),s=a.n(i),d=a(78178),c=a.n(d),n=a(19624),p=a.n(n),h=a(96226),j=a.n(h),R=(a(77675),a(19365),a(51107)),u=a(21312);const f={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:"eJzNGdtuG7n1V04ZoIiFkWRnL0W1xbZex5vNNk0My26AWoaHmjnScMUhZ0nOyIItYB+KfkDRl772J/reT8mXFIccji5Ok3W3WPQhjk0envt97pjjc8tGV+xrLXM07DphOdrMiMoJrdiIXRQIJwa5QwggcHz2EriUemlhpWtwGrJwP/P3A5YwXaHhhOBlzkYsXIdbljCD39do3Vc6X7HR3R65M6MbkSNMUeolVNzwEh2aB1RYwjKtHCpHOHhVSZF5isPvLCG6YzYrsOT0GxEUBnMSM7xWvEQS1a0qZCOmp99h5ljCKkOcO4GW3gXY1wQ7uouw1hmh5ixhM21K7rZP8JaXlSQghcvI5zphFTeoXNAeKeRxuNh6nTAnnP8jIL2Zku7WdLGRzZka/YGttLJBgmeHhw9VHHC06szB1lmG1s5qKVe/eIxaP6y8cPx4caviaFrcPvuuIs39f1jg22eK288W4gwJV6u3Y/c+NJtHzw6ffdI/Ouwf/uri6PPRp78effb54PDw8E8sYbelpLfeCUcs587jjSaOf9dV/jPQWe+DBaXl6LiQlj1wPfK6dcI+fZ9jjXWJrhBqDktUDpZGq3kClURuEZxZAZ9zoUByh+Z/6GlojDYfVtLjONsOOKGkUHgTo+rm08PDm6NOCZ89VMJL1XApcp8lL/QC1c8r6TZ5F8g/tLEIQP6e7Qi7fR6EtJjVRrgVG13dsds+r0Q/3I+urtfXCSPFasrylbaeY+4KNmLDvaRv0TRorMdSG8lGrHCusqPh0HKVT/XtQFeorJgryad2kOlyyCsxbI4Gz9g62X/Dq+pR8Fj3H/vEOj4Xav6xd9cbDY3JisFQO3rqzMUr8XtcsSSaYRsqYYK8p0Aegixh5Bznm1J5Gk28W5e2E93DPMfIukLNtOeitfKbCtVYzJX3ES/Ffs1/AhHm3Z//0YFN1ER9Cb0edQSkkb7VtckQnuus9vi4dFRanWgQ3v3wN5jWQjqYaQM5NijJk20CztSW6s50BagcmsoIi3bQ6xH+bbpz0WBoMThkmoR3mEBldF5nxGjfIM9XgH0yDXe1Qagkd5TJwRVG1/MCOFih5hITOD8dX8xqSdIMYIwqh1xndYnKWc9ihySBkis+R3BYEj70PPNs4UEoh1jHXW1BKDDIJThRYgJc5cBrp0vqUVa6NiSdMNiRASlmmK0yGZTDpYSlcIWuHTSocm1A6mzRF2pAiuj3+/TfkyfwAp0jqmPHjcOcTk8bNCto+ygoa+sg48asAt0u9IlDVyCkW46WQnAxTyRN04nauhzBbwjD5uDLFmaier13f/krXH2jl9SKzVFRg4d7BK+fxujJdWYfhg2dDguU1XAchLLD47OXPkseBPu/1g4sWXJZoEEiNcW5UL+FS0rUBUKv1+YLQNUIoxWptteDp+mPzifpAeGtjHaaArOzAp/NMPOqluTBOXd8zxQn2iCc8IpPhRSUlOn8Hk64w7k2K7iHtwV33mUzriDXcD9R9/1+3/8j0F7vefS6Xg/u2846AYsqTyCU/AQMNnrR+lSO5Pcb9+xHs2/ct8V8Ef3VY/6qFjIHg7XlU7nlzF5cqAz2K8kzzGEp8jk6+4XngTSjFYI2FAUrTxZNR2KMctan+PQkXkQvsHTsQbejqtNriwWEaoTzlQ9m1N23SM/qqRQZ7LI/LrhB4FCFyxh6UqiFDx+lI1YprIPYBkeczw2fOXirzYIoBYy8wS3utNnSCbeQ0wvrVT4TiksRHK4MTUHEe6KV41lrvD+EPOFjoGUmC/cw1XpBLjY3vCy5ExmXchWRhPwccLwxc66I1oYzoSxNQF2afm7IHUOO7yzxFqeF1ouA5BwzJBhKR31KR4ANZRylnZi1zYaF4JkG9FIBqrzSQrmI7tJGhs7RGYENAs8yXSvnNZIZzIUDqiTUJpMF73dDgxz/3Q9/t/Aal5R3YsGgyydw7BzPCp8F33p3g3FdVdq4iaJqkvLu3qatQ4KwoPQSbADEHLQKRupUlcSRcHMQAKJhO4DNAUnT+lQ8pPxlB5HVb0j342DNcet1r4Ra2Ikao4N0wgqR402w903rlzfSQ7ARVTeEe5hxaTElltOzN+MLGHrGIp8phRmhiW6z7d42pu1dYSG2oIONWk8kcnoeQycaj8uJSl+cXsAwyjgciTz1wu+eU/CkUFBoTBEVWGeQl9Ty5j7MDOa1yrlym1HcAkWmwVI3mHuUvV5lcCak9DkzGs6gqw3hsUhvHcoVzIwuo8wbhL0e1dwFKaCbXgG5Fe3cr5WtS+wsdMatXWqT98+MdpiRa5w9/3rjUXRPdpoJiTdVCzxhadRrTKA0RFOdUbDUxlP3qRFVZlZVi9UOIl7vgKOJau0ZHCuqMYV//RPSs8sHGvfHWw+iNYejCHezC7bnJ3sXe/T8BSVfUmka9fNmNiMDdt5LOcto2fmv393c6ADlPfhDjrsvqPeh90jqNOAtjTbCSersfNWh1k+EAtTS61ydei7kWdGFYWffNvjOtaQC6/NDW4ZSCIOR9y+eZVhRxiaZ2nA0WiJZeiZQ5sAzo631nZaXgtKW0bVDO4CLwiACwQd/7tLMKNR0ok5VFAveCMqa+5W85SmF3tMcZ7yW7sDXBN+Mtd0qpVyaMZ2vqZs2tc1wAU8jcEl4ujRuQ/THuCdFGSQo0EquYvVry3bYxMXCl/KqMroJ6E64CpFNhTyC4y1pra3JgZu2dnpi911q4WaqFZzoagVPT04OiDlRCcrQE3UMNHWkE5ZlG20/yNdcajX3pYzkwVthfXOVTth0+x2l9S5/bxJ1yH7kbV130VlxGBqlzpinJRcSeJ4btJQ7KKthTvHe8WjaEsmpU55q1c9Isu0CCeixaJXhrgGE7QyaD+CVWOBGhoTY3+EGnto6K6ijCFGyiXiRpwfUEzQib/UQWCN7GZG3du+qUsNljYmv5CFLkWalIMVSmwJYVm4F3Bi+gqfp1XV68AXoUjiPJajWaRCqQNMe7qLe622PGy6kj9TTTWPdNrhbJxQTtDS5PH/1nuZ2HHpv30g8oiHvOsFuttvF8MEZvHt9egnnOH/w+GOzf7rfyvwRjRXaJ6lfwlc8Wyy5yS2c6LLiTvjWf0Wg9Jicw29OYRoB+1kLKMNoAc2Rd+PmaHDUTX6x/7KhJLpCW4QmEA4JiXf20FS2hIVp1LvHqjRMDYaqmRVczSkQqPnaKtSCEn9eZyEWPL+EWvs5n0uolURrQbsCzZKaUKXJx3fVcWmR5ua2B5qoPlx1relbnFrhcDP3LZfLB5o+8G++rqWEOPz4gPvItBievRDum3oK51hpK5w2q82ruXBFPfW23H7b/dEiiENKt5D7KVOqR3mBprSgZzBG04jsI+IPHYEPDya05NlbDO2uXQzO0FDesTszNq9EO89fRT6A2PspcvhFdphV/GKRUl/YUP1uH49fEJIIb2atvO2W7MPysoRJkaGyuLV4PH5x9gqaTwaHLNlat/0IWw5fvTw5fT0+JWbaMGEjdjQ4HBz6/b62ruRqi9LOJ6v9BdfdZiH7333fahd6Dm/dsJJc+C2qF+iuXYBe7X71uk5YQfvR0RW7u6NAvjRyvabj72s0tFy9TljDjaCI96vVJO4CaWO6wBXJFJjuXxB1Apd1WCvubZRpmRleHPse6YOw2ytc6vhYwqbtl7lS5/TG8CV9teNL2ifStz0/TvoPa3R2xyRX85rPCTbgpPUlr0kN27vPhd99tr+QVPFKrbY43F2KBjHoJwn13gd3d2Gvul538OHqP75oFRuhyXrX6/X637U5Qlw=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-2",custom_edit_url:null},P=void 0,m={},w=[];function F(e){const t={p:"p",...(0,l.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(R.default,{as:"h1",className:"openapi__heading",children:"Create Folder"}),"\n",(0,o.jsx)(s(),{method:"post",path:"/createfolder",context:"endpoint"}),"\n",(0,o.jsx)(t.p,{children:"The Create Folder API allows you to create folder."}),"\n",(0,o.jsx)(R.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,o.jsx)(u.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,o.jsx)(c(),{parameters:void 0}),"\n",(0,o.jsx)(p(),{...a(56888)}),"\n",(0,o.jsx)(j(),{...a(87634)})]})}function v(e={}){const{wrapper:t}={...(0,l.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(F,{...e})}):F(e)}},56888(e){e.exports=JSON.parse('{"title":"Body","body":{"description":"Provide below parameter to create folder","content":{"application/json":{"schema":{"required":["foldername"],"type":"object","properties":{"folderName":{"type":"string","format":"string","example":"new folder"},"parentFolderId":{"type":"string","format":"string","example":""}},"title":"folder_body"}}},"required":true}}')},87634(e){e.exports=JSON.parse('{"responses":{"200":{"description":"folder created successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"ph1bhx2jp"},"folderName":{"type":"string","format":"string","example":"new folder"},"parentFolderId":{"type":"string","format":"string","example":"J2nas5kiPe"},"createdAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"xml":{"name":"folderdetails"},"title":"folder"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/02e5f5c4.9d8345bc.js b/assets/js/02e5f5c4.9d8345bc.js deleted file mode 100644 index ae6e60209..000000000 --- a/assets/js/02e5f5c4.9d8345bc.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[5373],{42232(e,t,r){r.r(t),r.d(t,{assets:()=>g,contentTitle:()=>S,default:()=>k,frontMatter:()=>j,metadata:()=>a,toc:()=>y});const a=JSON.parse('{"id":"API-docs/v1.1/createfolder","title":"Create Folder","description":"The Create Folder API allows you to create folder.","source":"@site/docs/API-docs/v1.1/createfolder.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/createfolder","permalink":"/docs/API-docs/v1.1/createfolder","draft":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJzNV1FvGzcS/itzfOlVWEuym7S4fapbpKnbIDFqFwbqCMHs7miXMZdkSa5kQRCQh/sH99TX/rT8ksOQWmklp7lzWxR9MazhzHDmmxnOt2sRsPYivxXfGFWRE7NMVORLJ22QRotcXDcEXzvCQJBU4PzyAlAps/SwMh0EA2U6n8fzsciEseSQHVxUIhfpOJ2KTDj6uSMfvjLVSuTro+sunVnIiqAgZZZg0WFLgdyDW0QmSqMD6cA+0Foly3jj5K1nR2vhy4Za5P/4Qumo4jSTtcaWONWwsiRyYYq3VAaRCes48iDJs13Sfcm6+brX9cFJXYtMzI1rMQwldI+tVaykadnHucmERUc6JPQYkMf5EptNJoIM8Udy+qZg7DZ8sM8tuI6iwFujfcrgbDp9CHHysYWzAt+VJXk/75Ra/eMxsH4cvCR+fLq2OS2a+7O3lpH7e1TguzON/umdvCT2tcXtPHzIzd7obHr22cnp9GT6xfXp5/mTf+VPPx9Pp9OfRCbuW8W2sQlzUWGIfvsS9787W/0F92yO1RJoFQWUyosHrcddt8nEkw811pVpKTRS17AkHWDpjK4zsIrQEwS3AqxRalAYyP2JnUbOGfdxkB4X2XDgpFZS05t+qt48mU7fnO5AePoQhAu9QCWr+EpemzvSf22mw+tDuv5hjWVSiufiINmhPCXpqeycDCuR367F/QlaeZLO89vZZpYJBtbwK2+NjxFjaEQuJkePvie3IOejl84pkYsmBOvzycSjrgpzPzaWtJe1Vlj4cWnaCVo5WZyOT8UmO7ZBax+lT93JY018wFrq+n/ZzfYIXXEVU6EOcNqVC638nlYi68sw1MqE5O5pCNOQZYKb44f9qnzWl/hwLw0fuofvnODqSj03MYptlV9Z0ley1rFHYhbHO/+GVGla4qUbGoLRqDd5/+9fd1ajEVSm7FrSIXbz+LV+rV91DqxZkpt3ClBXMFd0LwtF0YzaeLbjDZ6wVeS9WoHUgWrH+72StQyogAHniS3RYiGV5CFgNcPWDgZz5Mdw01BoyPHRJ44AoaIFKZ4dwC6YFgO76uOFpXF3c2YwGSAUnZeavAfSDeqSFfuSZmAcoAbSgZx10hP44DhqmWIzOjgsA7SosSb2ncEQrIqU5L4HZ4rOB/BGdTFk4PfVOKqgT0gTVT6C+Oze8hGwtDStddRw/y0I6k5W5DMoTUXgY0NwCrqCgnwAy7HIkjw77bQy5V0sIO92sIafIIkKzPwgRjYPDrXnHZhi6WuwA8w6wySBUoCj0Y+euMIvpL7z+Wj0Wp/A7a6vbqjwMtDsn/0sLZfLBzP06aHNcxm+7Qr4gazxMhi32lvXMjRdEedu6GT3I3l6Tppi/wymau+jMqV/OMYsnTSk7OSKAneIn5xfXsRX+1N4/+4/8ILQaWjMMnVr2TlSK6j7qxi5VPkE2+7RhbmJjdcw4mVqvi3t7RG8aTC8f/eLh5e0BKm3I8WpjEaXXaFkCdfUWl5JfjTKew4eehmEBgOUqKEg8A1yKy0kAoJN1krquzGc6xV0nhwsZWhiM7A82h2kwbjsyu2hQE8VGB0t+jvH+4hY3npSC/LsS5vAYVAlmVGGxpmuTrcNg9km52gulYIbWdUUYm7nVQV2K14mMQM+CIfmPBChoRWgI/Ckwxguj0ziSWetcRyFTMHPDX+qcAFIV9ZIHXwOlcN52PvP9o0e15Y0+gOiBCHu4Mi2bnYlSZO4zXgnHb/m1/1oIxy+t47m5PjCmPa+LlZu2+m2b0vgbv0jbR0ZrNEBy8hGqEWp0mr68thPZAbkWv9qfkVuIUvarsffmOhJVJ6ITChZkvY0YBznzy9fwOKz8VRkgz37fwz35MXF189eXj3jYPghTYCdjqfjaST2xocW9eCmg2/V48223jOx3/dhu93kge7DxCqUkT7FhNZb5nN7+Lk7y0TDxCi/Fes1T9WPTm02LP65I8esapaJBTqJBS/n29km60kAU6U7WnFOKeiTa76d1VWX+MQRlWQWkyzOy5Js+KjukLtdvrq6Fpkotp/kranYxuGSP9dxyUSCP+rj5opf1CxbC4W67rBm3eSTeQs/e4ek5y6Snu0/nFV/pFeDCA/ZUEqD/3JSHzRYrxOh2mx2+unoNy22wPbaXL3ZZrP5L6iA87Q=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Webhook","permalink":"/docs/API-docs/v1.1/delete-webhook"},"next":{"title":"Get Folder","permalink":"/docs/API-docs/v1.1/getfolder"}}');var o=r(74848),n=r(28453),s=r(57742),l=r.n(s),i=r(78178),d=r.n(i),p=r(19624),c=r.n(p),m=r(96226),f=r.n(m),u=(r(77675),r(19365),r(51107)),h=r(21312);const j={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:"eJzNV1FvGzcS/itzfOlVWEuym7S4fapbpKnbIDFqFwbqCMHs7miXMZdkSa5kQRCQh/sH99TX/rT8ksOQWmklp7lzWxR9MazhzHDmmxnOt2sRsPYivxXfGFWRE7NMVORLJ22QRotcXDcEXzvCQJBU4PzyAlAps/SwMh0EA2U6n8fzsciEseSQHVxUIhfpOJ2KTDj6uSMfvjLVSuTro+sunVnIiqAgZZZg0WFLgdyDW0QmSqMD6cA+0Foly3jj5K1nR2vhy4Za5P/4Qumo4jSTtcaWONWwsiRyYYq3VAaRCes48iDJs13Sfcm6+brX9cFJXYtMzI1rMQwldI+tVaykadnHucmERUc6JPQYkMf5EptNJoIM8Udy+qZg7DZ8sM8tuI6iwFujfcrgbDp9CHHysYWzAt+VJXk/75Ra/eMxsH4cvCR+fLq2OS2a+7O3lpH7e1TguzON/umdvCT2tcXtPHzIzd7obHr22cnp9GT6xfXp5/mTf+VPPx9Pp9OfRCbuW8W2sQlzUWGIfvsS9787W/0F92yO1RJoFQWUyosHrcddt8nEkw811pVpKTRS17AkHWDpjK4zsIrQEwS3AqxRalAYyP2JnUbOGfdxkB4X2XDgpFZS05t+qt48mU7fnO5AePoQhAu9QCWr+EpemzvSf22mw+tDuv5hjWVSiufiINmhPCXpqeycDCuR367F/QlaeZLO89vZZpYJBtbwK2+NjxFjaEQuJkePvie3IOejl84pkYsmBOvzycSjrgpzPzaWtJe1Vlj4cWnaCVo5WZyOT8UmO7ZBax+lT93JY018wFrq+n/ZzfYIXXEVU6EOcNqVC638nlYi68sw1MqE5O5pCNOQZYKb44f9qnzWl/hwLw0fuofvnODqSj03MYptlV9Z0ley1rFHYhbHO/+GVGla4qUbGoLRqDd5/+9fd1ajEVSm7FrSIXbz+LV+rV91DqxZkpt3ClBXMFd0LwtF0YzaeLbjDZ6wVeS9WoHUgWrH+72StQyogAHniS3RYiGV5CFgNcPWDgZz5Mdw01BoyPHRJ44AoaIFKZ4dwC6YFgO76uOFpXF3c2YwGSAUnZeavAfSDeqSFfuSZmAcoAbSgZx10hP44DhqmWIzOjgsA7SosSb2ncEQrIqU5L4HZ4rOB/BGdTFk4PfVOKqgT0gTVT6C+Oze8hGwtDStddRw/y0I6k5W5DMoTUXgY0NwCrqCgnwAy7HIkjw77bQy5V0sIO92sIafIIkKzPwgRjYPDrXnHZhi6WuwA8w6wySBUoCj0Y+euMIvpL7z+Wj0Wp/A7a6vbqjwMtDsn/0sLZfLBzP06aHNcxm+7Qr4gazxMhi32lvXMjRdEedu6GT3I3l6Tppi/wymau+jMqV/OMYsnTSk7OSKAneIn5xfXsRX+1N4/+4/8ILQaWjMMnVr2TlSK6j7qxi5VPkE2+7RhbmJjdcw4mVqvi3t7RG8aTC8f/eLh5e0BKm3I8WpjEaXXaFkCdfUWl5JfjTKew4eehmEBgOUqKEg8A1yKy0kAoJN1krquzGc6xV0nhwsZWhiM7A82h2kwbjsyu2hQE8VGB0t+jvH+4hY3npSC/LsS5vAYVAlmVGGxpmuTrcNg9km52gulYIbWdUUYm7nVQV2K14mMQM+CIfmPBChoRWgI/Ckwxguj0ziSWetcRyFTMHPDX+qcAFIV9ZIHXwOlcN52PvP9o0e15Y0+gOiBCHu4Mi2bnYlSZO4zXgnHb/m1/1oIxy+t47m5PjCmPa+LlZu2+m2b0vgbv0jbR0ZrNEBy8hGqEWp0mr68thPZAbkWv9qfkVuIUvarsffmOhJVJ6ITChZkvY0YBznzy9fwOKz8VRkgz37fwz35MXF189eXj3jYPghTYCdjqfjaST2xocW9eCmg2/V48223jOx3/dhu93kge7DxCqUkT7FhNZb5nN7+Lk7y0TDxCi/Fes1T9WPTm02LP65I8esapaJBTqJBS/n29km60kAU6U7WnFOKeiTa76d1VWX+MQRlWQWkyzOy5Js+KjukLtdvrq6Fpkotp/kranYxuGSP9dxyUSCP+rj5opf1CxbC4W67rBm3eSTeQs/e4ek5y6Snu0/nFV/pFeDCA/ZUEqD/3JSHzRYrxOh2mx2+unoNy22wPbaXL3ZZrP5L6iA87Q=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},S=void 0,g={},y=[];function I(e){const t={p:"p",...(0,n.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Create Folder"}),"\n",(0,o.jsx)(l(),{method:"post",path:"/createfolder",context:"endpoint"}),"\n",(0,o.jsx)(t.p,{children:"The Create Folder API allows you to create folder."}),"\n",(0,o.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,o.jsx)(h.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,o.jsx)(d(),{parameters:void 0}),"\n",(0,o.jsx)(c(),{...r(56888)}),"\n",(0,o.jsx)(f(),{...r(87634)})]})}function k(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(I,{...e})}):I(e)}},56888(e){e.exports=JSON.parse('{"title":"Body","body":{"description":"Provide below parameter to create folder","content":{"application/json":{"schema":{"required":["foldername"],"type":"object","properties":{"folderName":{"type":"string","format":"string","example":"new folder"},"parentFolderId":{"type":"string","format":"string","example":""}},"title":"folder_body"}}},"required":true}}')},87634(e){e.exports=JSON.parse('{"responses":{"200":{"description":"folder created successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"ph1bhx2jp"},"folderName":{"type":"string","format":"string","example":"new folder"},"parentFolderId":{"type":"string","format":"string","example":"J2nas5kiPe"},"createdAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"xml":{"name":"folderdetails"},"title":"folder"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/03e06346.287ef655.js b/assets/js/03e06346.287ef655.js deleted file mode 100644 index d02352ebc..000000000 --- a/assets/js/03e06346.287ef655.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[3404],{74671(e,n,t){t.r(n),t.d(n,{assets:()=>b,contentTitle:()=>g,default:()=>w,frontMatter:()=>y,metadata:()=>s,toc:()=>j});const s=JSON.parse('{"id":"API-docs/v1.1/publictemplate","title":"Public Template","description":"The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique **template_id** and a **public_url**. The **public_url** is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing.","source":"@site/docs/API-docs/v1.1/publictemplate.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/publictemplate","permalink":"/docs/API-docs/v1.1/publictemplate","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"publictemplate","title":"Public Template","description":"The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique **template_id** and a **public_url**. The **public_url** is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing.","sidebar_label":"Public Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztPWtz3DaSfwXHuirbsxxqZizZjrb2bpXYl/WtY7ts+VI5SavFkJghLBJgAFCjWdVU7Yf9B/fpvu5Pyy+56gbAx7z0jCNfMR9iDfFqdDcaje5G4zIwdKqD/aPgkOVFRg3TwUkYJEzHiheGSxHsB4cpI+/LccZj4muRg/evCc0yOdOk1ExpYiSJFYMi43siJqWGaKbOGaGajLOSFYoLo8lEKjJlgilquJiSRMZlzqBgxk1KCsUSNuGCJUQbVcamVExH5MeUCUKr7gnXRJdxzLSelFk2d8MnITGphU8xUyqhCSWl4D+XjPR6vvEpT3o9QkVCKOn1CpzcaamyXi8iMN32NxjK/s7mhOKQfJwxbJ/TORkzolOqWGLhp2KOSAkJE3ScwQxNynJAkZu0bar5VDTmPqaaJUQKhN8DGpE/yRk7h86anwk3mmUTElMhpAEAcpnwCWcJMamS5TQlJuWafPrw5veEG6hHpMgQ1BKGAQr4oS3muBQVVFxMo2NxLA55sU8+FZmkCZnLUpH3L/+jbmYkgW9Hvd5LNi6n5NPrXu/kcWpMofd3dmhRRLJgAvrL6FhHscx3EqhYJJMnIZmlTDHoFYFjVHNAbgI4TKbMaJywILEs5iSWUiVcAFOFpKBTRkSZj5nSoaWBVIxwYA7FaDLvG9kvNSP/+fHdW5hoTk1E3melDqvhEq5YbIBpoHvArJ/VI0uIZ7vAe1xMQ5LTMyAhN+TnksdnMG3NRAL/Ok5DXPV6H8uikMqwhPxop7Df60HJtyyTM0IVw/qxzHMpSEEVzZnBpQPLBIoV+7nkNRtlmcfF/rHok15P0Jzt93rkk2VnnjBhgOgKyYkEtw0iW9/MC6z/WiQ8diuSEfhK5KRdFZAKVT8WLIYubdUGqoExZymPU8ThjFr6FxmN7bQU0wWLDT9n7Y4vQjKHjl8yIT0EqVT8b1IYmiH5zpkyPKZZk8wAIFTVhiqUEYXkwvivbgTykyMnUBuJ6PgQQEsAuTkXWKIZOadZybSDahaSFKD6wArFNC4/1y+u34SkjE/TjePR5HOpTatjUmq30Cso3Fieqohehmib0EwzwictXOb0jDVGIxLlL80i8u2cJGxCy8yEhAOHGlWyiLyVhtCiyHhMQRoBD8BioyAv+0hlxz5Rm33eK3nOEwaCMeGTCVOwmKEQu3BtPHTAlwU2gOnhSjMpSpMlQscyk2qVhfBzG48klsIwYSJycE55hsDbyWrCRZyVCSPjjMZnIe4ZIVEg1YEqcwZbTmjXB1aBjcXiHPFDNMuAC6UA+IV0w8NW4aBKQMCDPPfrDwo9qnEQrptYdat8ImFkQIFfkoTllGchIi4kn+WYGG4yFsICL6iYhyShhoXEsAszlhchiVMWn+FfiiZcknFpjBR2YomSRSJnwuFyIoXR/G9rVqQvuTlGRyHZDcmzkLwIyXAQkuEoJMPdkAyfhWT4IiSjQUhGo5CMdkMyembBGr1wuKYVgpsADEcWy+brwm7KE3YKDU9hbqdUG6a4PgNxbZUM3La9JgEV/a4My4sl9Q7INUl5kjBBJkrmRLGYFxyliZUGVdchwEMUTEpoYvWVc261CIeDqlM5E4A3HJEr8q5g4iNoCjSOZQk0RgxbpCI6a5LDDi8FOWQ01zjzV8IwVSiuGYhqoSsMCFPzlt0A4VtTAFyHkqItgTZTcxN1GpSBHfQN1yhzYevT1W46a+2mw4j0epWcg29//etfj8XlsSDkOACxdxzsk+OgqnIchLYMdjMoG7rfF/Dj6ei5+zmHn89GL9zPGVYd7rqfKfwc+aZuccE3HBhrcGHs0E7AkgYIUGlxLBYO2mMxwmkYmhdbpgDFXwp8v03BR9hfQl8AS3AVng0ztjVWZvsUZssFN5xmevOEfY0HNOclkNZPu660MvNdmDkKs83TxuIHNOcmPFCCm6gtwk23UeS3A4RitAVFy31uEsLQCtWjFUzuRU6H2YxIO4UHg8cGOPeFxqUub47FZ4BF2E8PYT/djMpqy31A+FyG6b6Quq7fm2P2eYRaMKonm/HqKjwgrLYhui+crvZ6c4y+AIyCnrcZnVD6gHDZAAcKnNJsywa7/eFefzQY7bbwCeYJWyHP+0nSn8/nd6NFzsWphQMaNern9GJ9AVhNQHesKFGVOGNQ1axdukp1W2+JkKBxOkyA0unPn1brBWMWKs+rxgU8+9e13IkH//YH8h/gGD72J1SWOLW5Po9U9p/mGdrIhM4faduVb1odvaD+snJswcQigANtYXEqeeyAhzr+wDUGc08EOOgjUXeSZKdBVPiYJP087y99hJ995IHGxzyPkiRaqrnCKPZjTpIkJKuf135PEpLn+YbP9nvr806er84iynMHm8Oe570VOudc8LyEIxKY1ewJPUH75qFHb+5oyQXp9X766aef+j/80H/5stfzNHRDOC5uWDLsCPTinkZoMn2vt09eT0jzE1oTrB0HpUB1MkRTtq+QypnwByI8NiqSlGBQrAysaE0C8zF0xrhJmWqPAyZaz7JwfERLrzRpRD7h6RL+9qew6rSEJ6lvIrR149F4s+x0Fb6U+KylZHvgraJ1s2hqydYVtcgLpmK93qTYtMyoYhdg/tNcihWZeJs98Gb725JY9Lxcm1rQsOhMu8xbOsjjd+4Q/qSyLy7NBXo7IHGpDdokpuyCFNQYpgR2dk4znlh7fx8/sAuaF2Bb2fnL8XHyu3/dQcsuGE+NNSkkfMrBIL/zl6OD/n+frKlRFgVTMdWMZAxG0iFhJo7IUcqyovYJzGazaPZUx6mUmXUIfNaKTez/T+X48ymCW0RUF0/WzdQyQ8OSCsyybEjFxdnAGNXEt1xjS0XS4KoZDlCDc6aKLSqcq/GA9I4lkKDQmqWh+Ai2flRugXlZ/bcEmXMcnNTbPVpPWXJF25NrLE9YDRkds2y16OZLK6NzWboV7b0F7ak6jm7gzalClUEYpzMIG4X0YqnQli3WrFOLkOYy9bu9X56eAiTjutpIWuhstnY+A/T8CMbQmQReRNeAjCsuvfMqqAC73jLwBlKk3RVDQD2CFSt/jR/tihFahFnZyZ2u4B1Pk6pXjzK/kTfxBS3B61qrCVtGcLrC5hHAy7N5gGMxRDOkN19uOZ+4Gg9IViyBtH0Z30aKtHbm22ypt1qAflrNBbhme4WqdmOtFp/evPoi8s7a1H0jsLfHMStA07rz0qxAvvYOhVbjpgl9M+c1az0g7lsD1q/Mga7efe8+t2LS5uy/IkZtgX1tZrVG/5xOt9hvsPgBsaeDZ8UUNUQ7vt0vttifsXz7dIaD1nT22tN5NrjFeao17N2PU4Pq4xr78/JQcHIuM7oi7BMW85xmGCCCcI/usAJvc7RygAGHfyfzojTNJYVGGxQbXgfwYQ/Wcfu7kPRD0gvJTkgeh+RJRD4wDJSIq6AKpxJwZUMnOIRyleAFjUsFgVYKJh4SFk0jcnn5c0mF4Wa+WJAeubyEGLDFIoI1dibkzMZVHIFH2BCIi6qPTImM9Zo4KhnrHThb7bxls/5L5zrecaA9IY/l0oLfetB0KPiy5y0LVYNJYJS3lUJmz5wYyMN1kdE5oRPwQttgD2xmY4IiQPE+GZE//BsZjqLBICQD+zd57Cc4eoJrGD1IMcu2uSCx+KoVPGiu4PrnOoG0N7jWEm4Oe8sVDF2cYogAjnulOlYv7gdoGKkns2yKbejsgDMXZJrKMktgb7RBn6wKz6s09l7vvWITnmWN6DziP/k1DdFOLGO5iwhzcXlwWMFIBC6MhHXjQzV6vTGbSIhCgPBANPs1wkDt2HZjbkV4YLylVCSl2lpRENMAMcQ/QqzoUjyEB6+OieDCww6sPLw/e9/omzZzP9trMfdee3/ayNybOHiLGRCa6EIKXXn7WF3U4Drs039fPTgsc5LvFMiN4TB1VA8KMWScjJ+xpqzhQnsdzEG5HOX2XSqlrmu4QDMnd/V+O4BNKohhexJVgR93dWoNnz9tKREvvqBTq02lwe7OcG9nq1dryQFy86MgIdchKdrMr0VSrFnTtHP53MXlc/cV8fQ+za7D56PWaeHpts35gZhdmyvqCoPrfZhVb3VyXWffbK7Da1o2v5iF8e5suftr2FqWBPfz4W9ga7kri66YVO6NKcl92VPWceY1DCpbrSh35twmsL869+7dj/Fl6azzTUsb/GbU5Na9vbtxaxOaJZY7Dvh/ffvuw2zw5++n8uDg4ODtx0/pq0/Tg4ODHH5HUbTWILeODXAY0J/dNR+3xaO6sGGUKIrQGU8N3cfmO4WY/t62Dze3iVy03a/kJdj70l6Cu8uNquqX2bPWuQR+Pclw1zUbhIEs8EqkFK+TYD+wVw79lb8gRLIxbb6VyTzYvwzcpQ/40wXhQ9OdzxpubV4GOk5ZTuEvT2645znhGXRlQ1J0EAYY+AiXPoEdg/1Ajj+z2AQhhE4UYO1mGvrAdvuXvpa9HBeETtUP9gO7HIIwcOEE1SfCRCwhNqtIJsHCD7itq+pL3ZXGP6r7j9AP3Ce7ZTfYdLF0z/VWPTV7WNRorTujStF5sHyl1l8kKxo3BcCo4Qxw2dxvJ9yAOa263YTVgjDghuXNUTYQTcmbYzpmEmaC8do3bYtkofmNx4R2RSrFrRq6SNPbNP0sx6e3Ykdo7Iwya2h9TerY0tWB26xyAJdpWOIV6359qyS01y2iqzjV10cs02lzTGtMWxnzcNPdz8aVM2dyo0XBqIrwCuatbwPj7XGaxSXeba7EcWtmFajVzIaLMLi4ejIXJJZ9f7GUPM7YxNh4JRJLJZh60ow/fTCTG+3uLsJgfvX05l/l9J4D8WZXz+5HvJFb31b+LWB9+mIRBunVsP6pujP8GwK7+2xR77GBzYlQZT0Yy2R+6uXW4qqKfjODenDj/bV4pxKmGogYS5kxKlYwARGz9mj0CNTLR6GNEsTLgVxpv5GRGdjeFYsZXBv3kbIoq4jTdey9IX/BChxKr+ADqme6HGuoJXx/2nY4ZsQoPp0yMMW7GtjYXWZlNE7hCr+LXaz9SoVi51yW2oMH9nnYXTJmMLECOPuq6N3m+a2BnUZ0sJ171KQOfIHNFS+Yvjt8fw1c4uGyb2/3u0ufOEvbB3l3+B4u0POJU/8gOLjChEctbVUhoI6Rc079JdtKts9tZBWzNlVpM1Q0XReRu7reJ6sAJVyvhSi0iULArVqlClnpuM7IACSSpQFXCHe3TbVhhW7hEaGoEHkoy+tw5RWYpGRa4h0CA0vW36bHWNb6AjwXNiUJnjNcQHcz/rtQEtKD1HjyWIFKjf4hN4i2zSmZoEsshDQlgHlVwqmi6pJdFExxcD2vRYFiFnWQquRqbaJ9m/zThzcuD0cjTN2vId8xS0hZINfgSqiyHHjKLU99RVGC1cHU6SbFcFX1QIe6M5oUTGkp4Jgk1ZQK/jfLwqiRwClrzFKa2apOVIA5HuPsgV9bwHhZ+8s//tmAa6OmuwqYHYEmCThHr4AQj5KW4UHTV6wACSjbEEF/TP1xeRMA6HDRnNq0LnYh6evz+HuMzdaVXHSuxcq1qcs4hYNFJW91WF1idWqlxrNpdftdFjBfdsG1adzs9vdtVuXDB3cNo4YB1RBY1cDzYt5c4LXLVS51h3fQeTvHQ7UNrqwFWhp5qljOxfX2qab9zshKEJRG5tTwmPiudNTO3GHdSn5d53WgAXDjOZfqyVrwDM/ZofzO7Sgv6VxfrVRAG9QEXCuS0DliBNP4tFQEdlFwNa8uS6HHymPyCk16DwUJTPZUipidcnEKSYeuoX42IjYAsDEzM8ZEE3OehHazrbMFzDCfU5NiSzdrWjgECHOmpuw0hhMUrgl2DRL3etBVr0f6FhAn8XWpnLXH5eRB0QZSru4dwHHZM6qLZbU60EyF1MjSVGQMrkGAhcH2D/gkCLlLKNEcoc7fpBlkWoCOK+8iJIuoh7ARAchKOJvX1kAQW2MT9AI5ZGCccNucvHSvbsxRyAPjR/cZLmByYPEhNJO42k26LgEGAvUaU4CkuDsi/cCebcfxeXkwpcUvf/9fDSqWi6PSEUxhYykGXtBMS3u9qdmrX2x+OVrb2cpqE9LwyfxUitNayq1lmHbLrQy0JoijrWgJt0fg4F7fAk4H7gBE2z0W/tFtUbdM382DAULuacC30rB98oFNqUqyak+zZDSY/Yo2GckOtYkbMCvIBrajxtA4ZZg1JGEF5M+SgjyCLdhuwI/qTCNATzBVMHGKptPrmFjcpr1oUPMoAAsrmk2TILT25eBkEQbjOL5tj7Cf/9H9xo06xE+j1reVBHrjOCaPIRFcQmKqxtJmNXuy71R1msA6RDVsSWtvEdUiH8VJS//ijUNKRKr/HBJtkNA6Y9R2i6Tf4O3ZAFO05WMIOcaAJzzxoCYoa6Nk27r1q5nHttm6XLBOZ+n6ikxBw8Hg/7Ol6+ng67F07Q6+IkvXCwDWOdWuliabTp9rZYd3Em5v8Fky63/IpNpeE3agRVi5NNchuF4Oo4X9rzbOeSF+hcHOWvRqZ58zNvnJIBpGgwH8syQEfVZRl0K1lVf1X4Lw+p7GKyR6nX11O74Ozl+8zwuRxylK8ioV6/ZWTWZr7Mc7tj2w3r97CHjyh/YYOdO6vWGsGcAlwTXb0dWkEhcZF+zUk+B0yaVryby7jiYfZc6sUj2DTX6mJGhj7nRh1JzQKRwPoBt1jyRiSl3FzDeDbBs2dgeD02GFhL1VJLwWeLUXs/keyjMmvuxMm8MbOzyAepFntUQJuK2E5UFrss3vdpKaxaXiZh7sH10GF31a8L4t3z86WZwAF5pUoutfaoSYmjTYD3ZWIgEwqTIoxkeXAa6Livk1FQlEx61IW1rwnfNhNAwW4XKbtdJ5S31W9m/aRBs65WJ6VbuTGkcfgY6WVC1M1epkwf/MQJ90hGjWCgMO/JMyCoYgQD2wx4c6fuKVJ7KPbFgXrFATczn8wEcftAIKlnfJNSECjQiBI++eR4975XAP6gkFlVM8CBpubvjRcFzDz0rXPqrZufL6elV4iDrkaHcXla3nQ9RKnr7ADX/32eLEIr/h5sHIoKavwp2Pm0Z396lthA6CJaNvy/K6bHjdaATdYAN1Qy7Z+tzXdSa24d4m49beWpuS62q9/cAVNg+n6w+a7px5/TNj46i2hp5eO2lTE8LzgJpPB0jN3QFS88WgpRg5GtQ91OoN6jCVCuMmUKspoIucwOrhYiJx6Tmeq5KSgmjEpbuizrIslnmVE7TX801++cc/q1a9XnWMtc4rsEm8KxUp5IypSWkTjU4ydoGZUqEZy7FMo/ELL5/RHCwXEDIjDJuiFQsvj4HjyLkmYlrQMc84yH57iQeNo43tw+aXxwuBc1k+UvZ63DnLYMuoLMKNXPVkJtXZBBLgg41kDNcGwX7CREpFbN0PVo6hGR2Oz3UqVm0UQM0tbFIYRWNDciroFO3gIWkiK2EZB2FPlByDd07LrLT+J0N5JpU1A+OEMHINkfjqooAi1MlBciiWwuo6d04oHVonoBVRLo36GPytBcDCwQBnJClFJiHjOfhtywwu3BnrSwXVvwkjNDeKCg36urM8OxpUCHP+IaadqeuTZkDhN1yc2dyufXJU8dWPbKy5Ye3UMcsS4km7zffc/KkcQ05vqbmRal63nnKTlmPcbJqdVD9sT9/77PyNreT6NzE/WpOZ3jl4/xqVlSfkl7//D3nDqBIklTPLrXGpWDZvPwRgKW/RVuka6IGkJSTBN8ikYuqd4h6DP6bUoN30LZuBgdouKRuNuPRgg4ZEVt+tfaDBp7qwV9fALUzdawck4+IsIgfuPYPa8Affsd0t3jM4bIzOcs2yc6YbdnCWcNN6xYC1gHGTa9/kg7kdJAkplm7zgZumBscartDLTa0FC54FWHMBsHXLrp3QmIkEL53qfZIoOjF1/+HqcwprPvmbgR4doeumIoldiUX7oKGthXtJDWrLW7Scw4C6/c5EwR07HXm2JO2cTDdna3voFYbGqIT7bZwWfK0jE9Lw63eTj0yd89if0zas6B2svBOEQcZj5k7gbv86+P79G3L+NBrABlopl9dY3DtvXn/36u3HVwAMCFKLsGE0iAZ4vJTa5FQ0RlpaO8t7WyPytnsbpXsbpXsbpXsbpXsbpXsbpXsbpXsbpXsbpXsbpXsbpXsbpXsbpXsbpXsbpXsb5cvhs3sbpXsb5cZppLq3UaqC7m2U7m2U4+5tlO5tlOPubZSHkQK0exulexvlXnS47m2U7m2U7m2U7m2U7m2Ur+jJie5tlC/Bgd3bKN3bKDdN0LliiureRuneRuneRuneRjnu3kbp3kbp3kbp3kbp3kY57t5G6Vw+3dso3dso3dso3dso3dso3dso3dso3dso3dsod3kbpZEHYafIKMdkKy4nkM2TcrT8YspJGKSQSGX/KLi8BJb8pLLFAj7/XGL+h6OTMDinikOEPuZgCX3KEMi8cMYg28Z39vpI/xDGDy2h8bbrUuoZyHliWxzg3LfWbeZ6ef/u4yGkjXCvuuQywZRRdAaZGujMptNopHPAb5dBRsW0xFQQge1zYRPgpu0UKWeYIsX90cgnAalEagjbuVPsNOD/MKm1DS4vbfqVxaKqb4s2tnCI9bWBfieLxeL/ACu5J6E=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Template","permalink":"/docs/API-docs/v1.1/createtemplate"},"next":{"title":"Get Template","permalink":"/docs/API-docs/v1.1/get-template"}}');var i=t(74848),r=t(28453),l=t(57742),o=t.n(l),a=t(78178),d=t.n(a),c=t(19624),h=t.n(c),p=t(96226),u=t.n(p),m=(t(77675),t(19365),t(51107)),x=t(21312);const y={id:"publictemplate",title:"Public Template",description:"The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique **template_id** and a **public_url**. The **public_url** is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing.",sidebar_label:"Public Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztPWtz3DaSfwXHuirbsxxqZizZjrb2bpXYl/WtY7ts+VI5SavFkJghLBJgAFCjWdVU7Yf9B/fpvu5Pyy+56gbAx7z0jCNfMR9iDfFqdDcaje5G4zIwdKqD/aPgkOVFRg3TwUkYJEzHiheGSxHsB4cpI+/LccZj4muRg/evCc0yOdOk1ExpYiSJFYMi43siJqWGaKbOGaGajLOSFYoLo8lEKjJlgilquJiSRMZlzqBgxk1KCsUSNuGCJUQbVcamVExH5MeUCUKr7gnXRJdxzLSelFk2d8MnITGphU8xUyqhCSWl4D+XjPR6vvEpT3o9QkVCKOn1CpzcaamyXi8iMN32NxjK/s7mhOKQfJwxbJ/TORkzolOqWGLhp2KOSAkJE3ScwQxNynJAkZu0bar5VDTmPqaaJUQKhN8DGpE/yRk7h86anwk3mmUTElMhpAEAcpnwCWcJMamS5TQlJuWafPrw5veEG6hHpMgQ1BKGAQr4oS3muBQVVFxMo2NxLA55sU8+FZmkCZnLUpH3L/+jbmYkgW9Hvd5LNi6n5NPrXu/kcWpMofd3dmhRRLJgAvrL6FhHscx3EqhYJJMnIZmlTDHoFYFjVHNAbgI4TKbMaJywILEs5iSWUiVcAFOFpKBTRkSZj5nSoaWBVIxwYA7FaDLvG9kvNSP/+fHdW5hoTk1E3melDqvhEq5YbIBpoHvArJ/VI0uIZ7vAe1xMQ5LTMyAhN+TnksdnMG3NRAL/Ok5DXPV6H8uikMqwhPxop7Df60HJtyyTM0IVw/qxzHMpSEEVzZnBpQPLBIoV+7nkNRtlmcfF/rHok15P0Jzt93rkk2VnnjBhgOgKyYkEtw0iW9/MC6z/WiQ8diuSEfhK5KRdFZAKVT8WLIYubdUGqoExZymPU8ThjFr6FxmN7bQU0wWLDT9n7Y4vQjKHjl8yIT0EqVT8b1IYmiH5zpkyPKZZk8wAIFTVhiqUEYXkwvivbgTykyMnUBuJ6PgQQEsAuTkXWKIZOadZybSDahaSFKD6wArFNC4/1y+u34SkjE/TjePR5HOpTatjUmq30Cso3Fieqohehmib0EwzwictXOb0jDVGIxLlL80i8u2cJGxCy8yEhAOHGlWyiLyVhtCiyHhMQRoBD8BioyAv+0hlxz5Rm33eK3nOEwaCMeGTCVOwmKEQu3BtPHTAlwU2gOnhSjMpSpMlQscyk2qVhfBzG48klsIwYSJycE55hsDbyWrCRZyVCSPjjMZnIe4ZIVEg1YEqcwZbTmjXB1aBjcXiHPFDNMuAC6UA+IV0w8NW4aBKQMCDPPfrDwo9qnEQrptYdat8ImFkQIFfkoTllGchIi4kn+WYGG4yFsICL6iYhyShhoXEsAszlhchiVMWn+FfiiZcknFpjBR2YomSRSJnwuFyIoXR/G9rVqQvuTlGRyHZDcmzkLwIyXAQkuEoJMPdkAyfhWT4IiSjQUhGo5CMdkMyembBGr1wuKYVgpsADEcWy+brwm7KE3YKDU9hbqdUG6a4PgNxbZUM3La9JgEV/a4My4sl9Q7INUl5kjBBJkrmRLGYFxyliZUGVdchwEMUTEpoYvWVc261CIeDqlM5E4A3HJEr8q5g4iNoCjSOZQk0RgxbpCI6a5LDDi8FOWQ01zjzV8IwVSiuGYhqoSsMCFPzlt0A4VtTAFyHkqItgTZTcxN1GpSBHfQN1yhzYevT1W46a+2mw4j0epWcg29//etfj8XlsSDkOACxdxzsk+OgqnIchLYMdjMoG7rfF/Dj6ei5+zmHn89GL9zPGVYd7rqfKfwc+aZuccE3HBhrcGHs0E7AkgYIUGlxLBYO2mMxwmkYmhdbpgDFXwp8v03BR9hfQl8AS3AVng0ztjVWZvsUZssFN5xmevOEfY0HNOclkNZPu660MvNdmDkKs83TxuIHNOcmPFCCm6gtwk23UeS3A4RitAVFy31uEsLQCtWjFUzuRU6H2YxIO4UHg8cGOPeFxqUub47FZ4BF2E8PYT/djMpqy31A+FyG6b6Quq7fm2P2eYRaMKonm/HqKjwgrLYhui+crvZ6c4y+AIyCnrcZnVD6gHDZAAcKnNJsywa7/eFefzQY7bbwCeYJWyHP+0nSn8/nd6NFzsWphQMaNern9GJ9AVhNQHesKFGVOGNQ1axdukp1W2+JkKBxOkyA0unPn1brBWMWKs+rxgU8+9e13IkH//YH8h/gGD72J1SWOLW5Po9U9p/mGdrIhM4faduVb1odvaD+snJswcQigANtYXEqeeyAhzr+wDUGc08EOOgjUXeSZKdBVPiYJP087y99hJ995IHGxzyPkiRaqrnCKPZjTpIkJKuf135PEpLn+YbP9nvr806er84iynMHm8Oe570VOudc8LyEIxKY1ewJPUH75qFHb+5oyQXp9X766aef+j/80H/5stfzNHRDOC5uWDLsCPTinkZoMn2vt09eT0jzE1oTrB0HpUB1MkRTtq+QypnwByI8NiqSlGBQrAysaE0C8zF0xrhJmWqPAyZaz7JwfERLrzRpRD7h6RL+9qew6rSEJ6lvIrR149F4s+x0Fb6U+KylZHvgraJ1s2hqydYVtcgLpmK93qTYtMyoYhdg/tNcihWZeJs98Gb725JY9Lxcm1rQsOhMu8xbOsjjd+4Q/qSyLy7NBXo7IHGpDdokpuyCFNQYpgR2dk4znlh7fx8/sAuaF2Bb2fnL8XHyu3/dQcsuGE+NNSkkfMrBIL/zl6OD/n+frKlRFgVTMdWMZAxG0iFhJo7IUcqyovYJzGazaPZUx6mUmXUIfNaKTez/T+X48ymCW0RUF0/WzdQyQ8OSCsyybEjFxdnAGNXEt1xjS0XS4KoZDlCDc6aKLSqcq/GA9I4lkKDQmqWh+Ai2flRugXlZ/bcEmXMcnNTbPVpPWXJF25NrLE9YDRkds2y16OZLK6NzWboV7b0F7ak6jm7gzalClUEYpzMIG4X0YqnQli3WrFOLkOYy9bu9X56eAiTjutpIWuhstnY+A/T8CMbQmQReRNeAjCsuvfMqqAC73jLwBlKk3RVDQD2CFSt/jR/tihFahFnZyZ2u4B1Pk6pXjzK/kTfxBS3B61qrCVtGcLrC5hHAy7N5gGMxRDOkN19uOZ+4Gg9IViyBtH0Z30aKtHbm22ypt1qAflrNBbhme4WqdmOtFp/evPoi8s7a1H0jsLfHMStA07rz0qxAvvYOhVbjpgl9M+c1az0g7lsD1q/Mga7efe8+t2LS5uy/IkZtgX1tZrVG/5xOt9hvsPgBsaeDZ8UUNUQ7vt0vttifsXz7dIaD1nT22tN5NrjFeao17N2PU4Pq4xr78/JQcHIuM7oi7BMW85xmGCCCcI/usAJvc7RygAGHfyfzojTNJYVGGxQbXgfwYQ/Wcfu7kPRD0gvJTkgeh+RJRD4wDJSIq6AKpxJwZUMnOIRyleAFjUsFgVYKJh4SFk0jcnn5c0mF4Wa+WJAeubyEGLDFIoI1dibkzMZVHIFH2BCIi6qPTImM9Zo4KhnrHThb7bxls/5L5zrecaA9IY/l0oLfetB0KPiy5y0LVYNJYJS3lUJmz5wYyMN1kdE5oRPwQttgD2xmY4IiQPE+GZE//BsZjqLBICQD+zd57Cc4eoJrGD1IMcu2uSCx+KoVPGiu4PrnOoG0N7jWEm4Oe8sVDF2cYogAjnulOlYv7gdoGKkns2yKbejsgDMXZJrKMktgb7RBn6wKz6s09l7vvWITnmWN6DziP/k1DdFOLGO5iwhzcXlwWMFIBC6MhHXjQzV6vTGbSIhCgPBANPs1wkDt2HZjbkV4YLylVCSl2lpRENMAMcQ/QqzoUjyEB6+OieDCww6sPLw/e9/omzZzP9trMfdee3/ayNybOHiLGRCa6EIKXXn7WF3U4Drs039fPTgsc5LvFMiN4TB1VA8KMWScjJ+xpqzhQnsdzEG5HOX2XSqlrmu4QDMnd/V+O4BNKohhexJVgR93dWoNnz9tKREvvqBTq02lwe7OcG9nq1dryQFy86MgIdchKdrMr0VSrFnTtHP53MXlc/cV8fQ+za7D56PWaeHpts35gZhdmyvqCoPrfZhVb3VyXWffbK7Da1o2v5iF8e5suftr2FqWBPfz4W9ga7kri66YVO6NKcl92VPWceY1DCpbrSh35twmsL869+7dj/Fl6azzTUsb/GbU5Na9vbtxaxOaJZY7Dvh/ffvuw2zw5++n8uDg4ODtx0/pq0/Tg4ODHH5HUbTWILeODXAY0J/dNR+3xaO6sGGUKIrQGU8N3cfmO4WY/t62Dze3iVy03a/kJdj70l6Cu8uNquqX2bPWuQR+Pclw1zUbhIEs8EqkFK+TYD+wVw79lb8gRLIxbb6VyTzYvwzcpQ/40wXhQ9OdzxpubV4GOk5ZTuEvT2645znhGXRlQ1J0EAYY+AiXPoEdg/1Ajj+z2AQhhE4UYO1mGvrAdvuXvpa9HBeETtUP9gO7HIIwcOEE1SfCRCwhNqtIJsHCD7itq+pL3ZXGP6r7j9AP3Ce7ZTfYdLF0z/VWPTV7WNRorTujStF5sHyl1l8kKxo3BcCo4Qxw2dxvJ9yAOa263YTVgjDghuXNUTYQTcmbYzpmEmaC8do3bYtkofmNx4R2RSrFrRq6SNPbNP0sx6e3Ykdo7Iwya2h9TerY0tWB26xyAJdpWOIV6359qyS01y2iqzjV10cs02lzTGtMWxnzcNPdz8aVM2dyo0XBqIrwCuatbwPj7XGaxSXeba7EcWtmFajVzIaLMLi4ejIXJJZ9f7GUPM7YxNh4JRJLJZh60ow/fTCTG+3uLsJgfvX05l/l9J4D8WZXz+5HvJFb31b+LWB9+mIRBunVsP6pujP8GwK7+2xR77GBzYlQZT0Yy2R+6uXW4qqKfjODenDj/bV4pxKmGogYS5kxKlYwARGz9mj0CNTLR6GNEsTLgVxpv5GRGdjeFYsZXBv3kbIoq4jTdey9IX/BChxKr+ADqme6HGuoJXx/2nY4ZsQoPp0yMMW7GtjYXWZlNE7hCr+LXaz9SoVi51yW2oMH9nnYXTJmMLECOPuq6N3m+a2BnUZ0sJ171KQOfIHNFS+Yvjt8fw1c4uGyb2/3u0ufOEvbB3l3+B4u0POJU/8gOLjChEctbVUhoI6Rc079JdtKts9tZBWzNlVpM1Q0XReRu7reJ6sAJVyvhSi0iULArVqlClnpuM7IACSSpQFXCHe3TbVhhW7hEaGoEHkoy+tw5RWYpGRa4h0CA0vW36bHWNb6AjwXNiUJnjNcQHcz/rtQEtKD1HjyWIFKjf4hN4i2zSmZoEsshDQlgHlVwqmi6pJdFExxcD2vRYFiFnWQquRqbaJ9m/zThzcuD0cjTN2vId8xS0hZINfgSqiyHHjKLU99RVGC1cHU6SbFcFX1QIe6M5oUTGkp4Jgk1ZQK/jfLwqiRwClrzFKa2apOVIA5HuPsgV9bwHhZ+8s//tmAa6OmuwqYHYEmCThHr4AQj5KW4UHTV6wACSjbEEF/TP1xeRMA6HDRnNq0LnYh6evz+HuMzdaVXHSuxcq1qcs4hYNFJW91WF1idWqlxrNpdftdFjBfdsG1adzs9vdtVuXDB3cNo4YB1RBY1cDzYt5c4LXLVS51h3fQeTvHQ7UNrqwFWhp5qljOxfX2qab9zshKEJRG5tTwmPiudNTO3GHdSn5d53WgAXDjOZfqyVrwDM/ZofzO7Sgv6VxfrVRAG9QEXCuS0DliBNP4tFQEdlFwNa8uS6HHymPyCk16DwUJTPZUipidcnEKSYeuoX42IjYAsDEzM8ZEE3OehHazrbMFzDCfU5NiSzdrWjgECHOmpuw0hhMUrgl2DRL3etBVr0f6FhAn8XWpnLXH5eRB0QZSru4dwHHZM6qLZbU60EyF1MjSVGQMrkGAhcH2D/gkCLlLKNEcoc7fpBlkWoCOK+8iJIuoh7ARAchKOJvX1kAQW2MT9AI5ZGCccNucvHSvbsxRyAPjR/cZLmByYPEhNJO42k26LgEGAvUaU4CkuDsi/cCebcfxeXkwpcUvf/9fDSqWi6PSEUxhYykGXtBMS3u9qdmrX2x+OVrb2cpqE9LwyfxUitNayq1lmHbLrQy0JoijrWgJt0fg4F7fAk4H7gBE2z0W/tFtUbdM382DAULuacC30rB98oFNqUqyak+zZDSY/Yo2GckOtYkbMCvIBrajxtA4ZZg1JGEF5M+SgjyCLdhuwI/qTCNATzBVMHGKptPrmFjcpr1oUPMoAAsrmk2TILT25eBkEQbjOL5tj7Cf/9H9xo06xE+j1reVBHrjOCaPIRFcQmKqxtJmNXuy71R1msA6RDVsSWtvEdUiH8VJS//ijUNKRKr/HBJtkNA6Y9R2i6Tf4O3ZAFO05WMIOcaAJzzxoCYoa6Nk27r1q5nHttm6XLBOZ+n6ikxBw8Hg/7Ol6+ng67F07Q6+IkvXCwDWOdWuliabTp9rZYd3Em5v8Fky63/IpNpeE3agRVi5NNchuF4Oo4X9rzbOeSF+hcHOWvRqZ58zNvnJIBpGgwH8syQEfVZRl0K1lVf1X4Lw+p7GKyR6nX11O74Ozl+8zwuRxylK8ioV6/ZWTWZr7Mc7tj2w3r97CHjyh/YYOdO6vWGsGcAlwTXb0dWkEhcZF+zUk+B0yaVryby7jiYfZc6sUj2DTX6mJGhj7nRh1JzQKRwPoBt1jyRiSl3FzDeDbBs2dgeD02GFhL1VJLwWeLUXs/keyjMmvuxMm8MbOzyAepFntUQJuK2E5UFrss3vdpKaxaXiZh7sH10GF31a8L4t3z86WZwAF5pUoutfaoSYmjTYD3ZWIgEwqTIoxkeXAa6Livk1FQlEx61IW1rwnfNhNAwW4XKbtdJ5S31W9m/aRBs65WJ6VbuTGkcfgY6WVC1M1epkwf/MQJ90hGjWCgMO/JMyCoYgQD2wx4c6fuKVJ7KPbFgXrFATczn8wEcftAIKlnfJNSECjQiBI++eR4975XAP6gkFlVM8CBpubvjRcFzDz0rXPqrZufL6elV4iDrkaHcXla3nQ9RKnr7ADX/32eLEIr/h5sHIoKavwp2Pm0Z396lthA6CJaNvy/K6bHjdaATdYAN1Qy7Z+tzXdSa24d4m49beWpuS62q9/cAVNg+n6w+a7px5/TNj46i2hp5eO2lTE8LzgJpPB0jN3QFS88WgpRg5GtQ91OoN6jCVCuMmUKspoIucwOrhYiJx6Tmeq5KSgmjEpbuizrIslnmVE7TX801++cc/q1a9XnWMtc4rsEm8KxUp5IypSWkTjU4ydoGZUqEZy7FMo/ELL5/RHCwXEDIjDJuiFQsvj4HjyLkmYlrQMc84yH57iQeNo43tw+aXxwuBc1k+UvZ63DnLYMuoLMKNXPVkJtXZBBLgg41kDNcGwX7CREpFbN0PVo6hGR2Oz3UqVm0UQM0tbFIYRWNDciroFO3gIWkiK2EZB2FPlByDd07LrLT+J0N5JpU1A+OEMHINkfjqooAi1MlBciiWwuo6d04oHVonoBVRLo36GPytBcDCwQBnJClFJiHjOfhtywwu3BnrSwXVvwkjNDeKCg36urM8OxpUCHP+IaadqeuTZkDhN1yc2dyufXJU8dWPbKy5Ye3UMcsS4km7zffc/KkcQ05vqbmRal63nnKTlmPcbJqdVD9sT9/77PyNreT6NzE/WpOZ3jl4/xqVlSfkl7//D3nDqBIklTPLrXGpWDZvPwRgKW/RVuka6IGkJSTBN8ikYuqd4h6DP6bUoN30LZuBgdouKRuNuPRgg4ZEVt+tfaDBp7qwV9fALUzdawck4+IsIgfuPYPa8Affsd0t3jM4bIzOcs2yc6YbdnCWcNN6xYC1gHGTa9/kg7kdJAkplm7zgZumBscartDLTa0FC54FWHMBsHXLrp3QmIkEL53qfZIoOjF1/+HqcwprPvmbgR4doeumIoldiUX7oKGthXtJDWrLW7Scw4C6/c5EwR07HXm2JO2cTDdna3voFYbGqIT7bZwWfK0jE9Lw63eTj0yd89if0zas6B2svBOEQcZj5k7gbv86+P79G3L+NBrABlopl9dY3DtvXn/36u3HVwAMCFKLsGE0iAZ4vJTa5FQ0RlpaO8t7WyPytnsbpXsbpXsbpXsbpXsbpXsbpXsbpXsbpXsbpXsbpXsbpXsbpXsbpXsbpXsbpXsb5cvhs3sbpXsb5cZppLq3UaqC7m2U7m2U4+5tlO5tlOPubZSHkQK0exulexvlXnS47m2U7m2U7m2U7m2U7m2Ur+jJie5tlC/Bgd3bKN3bKDdN0LliiureRuneRuneRuneRjnu3kbp3kbp3kbp3kbp3kY57t5G6Vw+3dso3dso3dso3dso3dso3dso3dso3dso3dsod3kbpZEHYafIKMdkKy4nkM2TcrT8YspJGKSQSGX/KLi8BJb8pLLFAj7/XGL+h6OTMDinikOEPuZgCX3KEMi8cMYg28Z39vpI/xDGDy2h8bbrUuoZyHliWxzg3LfWbeZ6ef/u4yGkjXCvuuQywZRRdAaZGujMptNopHPAb5dBRsW0xFQQge1zYRPgpu0UKWeYIsX90cgnAalEagjbuVPsNOD/MKm1DS4vbfqVxaKqb4s2tnCI9bWBfieLxeL/ACu5J6E=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},g=void 0,b={},j=[];function f(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Public Template"}),"\n",(0,i.jsx)(o(),{method:"post",path:"/publictemplate",context:"endpoint"}),"\n",(0,i.jsxs)(n.p,{children:["The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique ",(0,i.jsx)(n.strong,{children:"template_id"})," and a ",(0,i.jsx)(n.strong,{children:"public_url"}),". The ",(0,i.jsx)(n.strong,{children:"public_url"})," is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing."]}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Unique identifier for this widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Specify the hint for widgets. This parameter is optional and is not applicable to the following widgets: checkbox, radio button, dropdown."]}),"\n"]}),"\n",(0,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 "options": {\n "hint": "Provide signature"\n }\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 "hint": "Provide 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 "hint": "Provide 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 "hint": "Provide email",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide name",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide job title",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide company",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12,\n "min_date": "",\n "max_date": "",\n "readonly": false,\n "signing_date": false,\n "hint": "Provide date"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"min_date:"})," Provide the minimum restriction date. The date must be in ",(0,i.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"max_date:"})," Provide the maximum restriction date. The date must be in ",(0,i.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"signing_date"}),": If signing_date is set to true, the signing date is shown to the signer during signing. You may set either signing_date or default, but not both. Using both is not supported."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,i.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"14",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Provide number",\n "formula": "",\n "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,i.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"decimalplaces:"})," Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"15",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"cells"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "cells",\n "page": 1,\n "x": 100,\n "y": 100,\n "w": 114,\n "h": 50,\n "options": {\n "name": "cells",\n "required": true,\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"cell_count:"})," Specify the number of cells that should be returned to the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,i.jsx)(n.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "required": true,\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "response": "04/15/2024",\n "format": "mm/dd/yyyy",\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "required": true,\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 528,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "values": ["male", "female", "other"],\n "response": "female",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,i.jsx)(x.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,i.jsx)(d(),{parameters:void 0}),"\n",(0,i.jsx)(h(),{...t(71591)}),"\n",(0,i.jsx)(u(),{...t(94633)})]})}function w(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}},71591(e){e.exports=JSON.parse('{"title":"Body","body":{"content":{"application/json":{"schema":{"required":["file","signers","title"],"type":"object","properties":{"file":{"type":"string","format":"base64","example":"base64 encoded pdf"},"title":{"type":"string","format":"string","example":"sample template"},"note":{"type":"string","format":"string","example":"sample note"},"description":{"type":"string","format":"string","example":"sample description"},"signers":{"type":"array","description":"You can provide signer optionally if you it as default signer","items":{"type":"object","properties":{"role":{"type":"string","format":"string","example":"ceo"},"email":{"type":"string","format":"string","example":""},"name":{"type":"string","format":"string","example":""},"phone":{"type":"string","format":"string","example":""},"company":{"type":"string","format":"string","example":""},"job_title":{"type":"string","format":"string","example":""},"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Allowed values - signature, stamp.","format":"string","example":"signature"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":244},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":71},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":38},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":46}},"title":"createtemplate_body_widgets"}}},"title":"createtemplate_body_signers"}},"sendInOrder":{"type":"boolean","description":"If set to \'true\', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to \'true\'.","example":true},"enableOTP":{"type":"boolean","description":"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.","example":false},"enableTour":{"type":"boolean","description":"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.","example":false},"redirect_url":{"type":"string","description":"Specifies the URL where the signer will be redirected upon completing the document signing process.","example":""},"sender_name":{"type":"string","description":"The name of the person or organization on whose behalf the email is being sent.","example":"opensign\u2122"},"sender_email":{"type":"string","description":"The email address of the person or organization that users can reply to.","example":"mailer@opensignlabs.com"},"allow_modifications":{"type":"boolean","description":"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.","example":false},"auto_reminder":{"type":"boolean","description":"Set to true to enable automatic reminders. Set to false to disable them (default behavior).","example":false},"timeToCompleteDays":{"type":"number","description":"time to complete days is used to calculate expiry date of your document","format":"number","example":15},"remind_once_in_every":{"type":"number","description":"Number of days between reminders. This is only applicable when auto_reminder is set to true.","example":5},"merge_certificate":{"type":"boolean","description":"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\\n\\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\\n\\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\\n","example":false},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed. \\n"},"prefill":{"type":"object","description":"You can provide widgets which can embed before sending to signer","properties":{"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","format":"string","example":"textbox"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":100},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":30},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":40},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":80},"options":{"type":"object","properties":{"name":{"type":"string","example":"textbox"},"response":{"type":"string","example":"joe"},"color":{"type":"string","example":"red"},"fontsize":{"type":"number","example":12}}}}}}},"title":"prefill"}},"title":"createtemplate_body"}}},"required":true}}')},94633(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Template created successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"template_id":{"type":"string","example":"Av8Pmpnmch"},"public_url":{"type":"string","example":"https://app.example.com/publicsign?templateid=Av8Pmpnmch"},"message":{"type":"string","example":"Public template created successfully!"}},"title":"inline_response_publictemplate"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/03e06346.92758027.js b/assets/js/03e06346.92758027.js new file mode 100644 index 000000000..74a16c591 --- /dev/null +++ b/assets/js/03e06346.92758027.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[3404],{74671(e,n,t){t.r(n),t.d(n,{assets:()=>b,contentTitle:()=>j,default:()=>w,frontMatter:()=>x,metadata:()=>s,toc:()=>f});const s=JSON.parse('{"id":"API-docs/v1.1/publictemplate","title":"Public Template","description":"The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique **template_id** and a **public_url**. The **public_url** is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing.","source":"@site/docs/API-docs/v1.1/publictemplate.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/publictemplate","permalink":"/docs/API-docs/v1.1/publictemplate","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"publictemplate","title":"Public Template","description":"The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique **template_id** and a **public_url**. The **public_url** is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing.","sidebar_label":"Public Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztPe1yHLeRr4IbX53FzezyQ5Ss0JdcaEmxdbEllkhF5SMVEjuD3YU4A4wBDJcbmVX5kboHuLo/9zcvcf/vUfwkV934GMzsBylSVuTUuioRd/DVaDQaje5G97vE0LFO9o6TI1ZWBTVMJ2/SJGc6U7wyXIpkLzmaMHJQDwueEV+L7B88I7Qo5FSTWjOliZEkUwyKjO+JmAk1RDN1wQjVZFjUrFJcGE1GUpExE0xRw8WY5DKrSwYFU24mpFIsZyMuWE60UXVmasX0gLyeMEFo6J5wTXSdZUzrUV0UMzd8nhIzsfApZmolNKGkFvyHmpFezzc+5XmvR6jICSW9XoWTO61V0esNCEy3/Q2Gsr+LGaE4JB8WDNuXdEaGjOgJVSy38FMxQ6SkhAk6LGCGZsJKQJGbtG2q+VhEcx9SzXIiBcLvAR2Qb+SUXUBn8WfCjWbFiGRUCGkAgFLmfMRZTsxEyXo8IWbCNXn18tsvCTdQj0hRIKg1DAMr4Ie2mONSBKi4GA9OxIk44tUeeVUVkuZkJmtFDp78vmlmJIFvx73eEzasx+TVs17vzb2JMZXe29ykVTWQFRPQX0GHepDJcjOHilU+2kjJdMIUg14ROEY1B+TmgMN8zIzGCQuSyWpGMilVzgUQVUoqOmZE1OWQKZ3aNZCKEQ7EoRjNZ30j+7Vm5N8PXzyHiZbUDMhBUes0DJdzxTIDRAPdA2b9rD63C/FwF2iPi3FKSnoOS8gN+aHm2TlMWzORw7+O0hBXvd5hXVVSGZaT13YKe70elHzFCjklVDGsn8mylIJUVNGSGdw6sE2gWLEfat6QUVF4XOydiD7p9QQt2V6vR15ZcuY5EwYWXeFy4oLbBgNb38wqrP9M5DxzO5IR+ErkqF0VkApVDyuWQZe2aoRqIMzphGcTxOGU2vWvCprZaSmmK5YZfsHaHV+mZAYdP2FCeggmUvE/S2Fogct3wZThGS3iZQYAoao2VCGPqCQXxn91I5Dv3XLCauMiOjoE0HJAbskFlmhGLmhRM+2gmqZkAlC9ZJViGref6xf3b04mjI8nS8ej+dtam1bHpNZuowco3Fh+VRG9DNE2ooVmhI9auCzpOYtGIxL5Ly0G5KsZydmI1oVJCQcKNapmA/JcGkKrquAZBW4ENACbjQK/7OMqO/IZtMnnQMkLnjNgjDkfjZiCzQyF2IVr46EDuqywAUwPd5qZIDfpLHQmC6nmSQg/t/FIMikME2ZA9i8oLxB4O1lNuMiKOmdkWNDsPMUzIyUKuDqsyozBkZPa/YFV4GCxOEf8EM0KoEIpAH4h3fBwVDiocmDwwM/9/oNCj2ochOsYq26XjySMDCjwW5KwkvIiRcSl5K0cEsNNwVLY4BUVs5Tk1LCUGHZphvIyJdmEZef4l6I5l2RYGyOFnViuZJXLqXC4HElhNP/zgh3pS94fozsp2U3Jw5Q8Ssn2Vkq2d1KyvZuS7Ycp2X6Ukp2tlOzspGRnNyU7Dy1YO48crmlAcAzA9o7FsvllYXfCc3YKDU9hbqdUG6a4Pgd2bYUMPLa9JAEV/akM24vlzQnINZnwPGeCjJQsiWIZrzhyE8sNQtcpwEMUTEpoYuWVC26lCIeD0KmcCsAbjsgVeVExcQiSAs0yWcMaI4YtUhGdzZLDCS8FOWK01Djzp8IwVSmuGbBqoQMGhGloyx6A8C1mADdZSdHmQMtXc9nqRCsDJ+i3XCPPhaNPh9N02jpNtwek1wt8Dr6dnZ2diHcngpCTBNjeSbJHTpJQ5SRJbRmcZlC27X5fwo/7O1+4nzP4+XDnkfs5xarbu+7nBH7u+KZuc8E3HBhrcGHs0I7BkggEqHR1Iq4ctCdiB6dhaFmtmAIUfyzw/TEFH+F8SX0BbMF5eJbM2NaYm+19mC0X3HBa6OUT9jU+oTl3QFo87abS3Mx3YebIzJZPG4s/oTnH8EAJHqK2CA/dqMgfBwjFzgoUdftcxoShFYpHc5h8MHAyzHJE2il8MniMwPlQaOx0+f5YfAhYhPP0CM7T5agMR+4nhM8uTB8KqYv6fX/MfjFAKRjFk+V4dRU+Iay2IfpQOJ3v9f0x+ggwCnLecnRC6SeEywgcKHBCsy3b2u1vP+jvbO3stvAJ6glboSz7ed6fzWZ3W4uSi1MLBzSK6pf0cnEBaE1AdgwrEUqcMig0a5fOr7qt11lIkDgdJkDo9PdPK/WCMguF53nlAt79m1ruxoN/+wv5d3ANH/obKsud2NzcR4L+J75DG5nT2efaduWbhqsX1O8KxxZMLAI4UBeWTSTPHPBQx1+4hqDuGQAO+riom3m+GS0qfMzzfln2Ox/hZx9pIPpYloM8H3RqzhGK/ViSPE/J/OeF3/OclGW55LP93vq8WZbzsxiUpYPNYc/T3tw6l1zwsoYrEqjV7A09R/3mkUdv6daSC9Lrff/999/3v/uu/+RJr+fX0A3hqDjSZNgR6OUHGiEm+l5vjzwbkfgTahOsHge5QLgZoirbV5jIqfAXIrw2KpLXoFAMClbUJoH6GDpj3EyYao8DKlpPsnB9RE2vNJMBeYW3S/jb38LCbQlvUr8eoK4br8bLeaer8LHYZ8Ml2wOvZK3LWVOLt86JRZ4xVYvlJsXGdUEVuwT1n+ZSzPHE25yB73e+ddiip+VG1YKKRafaZV7TQe69cJfwjaBf7MwFetsnWa0N6iTG7JJU1BimBHZ2QQueW31/Hz+wS1pWoFvZ/NPJSf6rf95EzS4oT41VKeR8zEEhv/mn4/3+f7xZUKOuKqYyqhkpGIykU8JMNiDHE1ZUjU1gOp0Opvd1NpGysAaBt1qxkf3/Uzl8e4rgVgOqq41FM7XEEGlSgVi6ilTcnBHGqCa+5QJdKi4N7prtLZTgnKpihQjnanxCckcHJCi0amkoPoajH4VbIF7W/C2B55wkb5rjHrWnLL+m7ZsbbE/YDQUdsmK+6P23VkFnsnY72lsL2lN1FB3hzYlCQSGM09lKo0J62Sm0ZVcL9qlFSLxN/Wnvt6dfAVJwHQ6SFjrj1s5mgJYfwRgak8CK6BqQYaDSO++CANjNtoFXkOLaXTME1CNYMdhr/GjXjNBamLmT3MkK3vA0Cr16lPmDPMYXtASrayMmrBjByQrLRwArz/IBTsQ2qiG9+nLF/cTV+IR4RQek1dv4NlykdTLf5ki91Qb004o34ILjFaragzVsPr189w3IC6tT941A355lrAJJ685bM4B84xMKtcaxCn055cW1PiHqWwDWz0yBrt6HPn1uRaTx7H9BhNoC+8bEapX+JR2v0N9g8SdEng6eOVXUNurx7XmxQv+M5auns73Vms6D9nQebt3iPtUa9u7Xqa3wcYH+uTsU3Jzrgs4x+5xlvKQFOogg3Dt32IG3uVo5wIDCH8uyqk28pVBpg2zDywDe7cEabn+Vkn5KeinZTMm9lGwMyEuGjhJZcKpwIgFX1nWCgytXDVbQrFbgaKVg4ilhg/GAvHv3Q02F4WZ2dUV65N078AG7uhrAHjsXcmr9Ko7BImwI+EU1V6ZcZnqBH5XM9CbcrTafs2n/iTMdbzrQNsg92dnwKy+aDgUf975loYqIBEZ5HgQye+dERx6uq4LOCB2BFdo6e2Az6xM0ABTvkR3ym9+S7Z3B1lZKtuzf5J6f4M4G7mG0IGWsWGWCxOLrdvBWvIObn4sY0oOtG23heNhb7mDo4hRdBHDca8WxZnN/goqRZjJdVWwkswPOnJPpRNZFDmejdfpkwT2vkdjR8kWNodkEHS6X00BU6RM6mhqoHAtaaZIe8YItskf3egeKjXhRRE6KxH/yrA2cvljBSucY59wT4c6GDhlcGAnsw3us9HpDNpLgjAFekqj9jLxh7RJY+aTl6IJup1KRCdVWmYQEBwsHbqDgMttxC/HgNa4hXHjYYTW3P5zac+fX7T3+8EFrZR+0j+mle3zZwq7QhkITXUmhg9GTNUXR5sM+/ff5+1N3Q/lOYbnRK6hxbkJejvun4OcsZrlcaC+KOii7zn6PJ1Lqpobzt3PHj95r+/FJBa58G4Pg/3JX2972F/dbstSjj2jba6/S1u7m9oPNlca9jh3o/W/EhNxkSdF0cKMlxZrNmq4tX3exfN19R9z/kNrn7S92WifT/VUyyieifY531DV65w+hXb7VBX6RmjfehzdU8H40RevdyXL351A5dRj3F9t/B5XTXUl0TrP0wYiSfCi10iLKvIFeaaUy6c6UGwP7s1Pvgw+jg+pc+X7dkgZ/vRNT64MHd6PWGJoOyZ0k/I9fvXg53frD12O5v7+///zw1eTpq/H+/n4JvweDwUK95CIywGFAfnavndwRj+LCklEGgwH6JFBD97D5ZiXGX9r26fI2A+d0+DMZSx58bGPJ3flGqPpxzqxFlpGfjzPcdc8maSIrfBkqxbM82Uvsy0v/8jFJcdmYNl/JfJbsvUvc2xf4071FgKabbzU8Xn2X6GzCSgp/+eWG565wPU7SxHrm6CRN0P8T3r4COSZ7iRy+ZZlJUvAgqUDpzzT0ge323vla9o1gkjpRP9lL7HZI0sR5VYRPhIlMgotalY+SqxR7Oq2o1lOp8pVdhi9Nl9CBhfg9G2r8I7wjhX7gXd4tu8GmV533wrfqKe7hqlmXpjOqFJ0l3afJ/kGed/NxnlZe+1nM/HnEDaglwysxrJakCTesjEdZsupKvj+mMyZhJuj3fpvlBR50m3bVRIpbNXQeu7dp+lYOT29Fjs1an94cx20SaL+Pg16CoOGfYwWvUOekVykJb7gHZB8eKrHcSet7jfsfGHmC+nhjz/qZTig8ZDekYBT0USJ64NN+CnnB2RR62CMvWcb4hYMtfjgNVdB16kvrzIB9C9l5sUkrIGzfFbSxz7rc93a3X0L7LkThTbHlrEzUJbC/sAEsqEma+KGABUa709a7ShP77P0UWNhtVmkK7+o0A+dbeFUm6pIpnrnH9AR6haMkPID2R5fbz6AStDXDu/l45oMWTW3v3N998BBgdshcwEVuuO9t6fxs23NrU1F4cBmWIrXPotLwTCi9w+tGf5h3X9KhQJY67XhqdeMpiTTZg+sYsQcXmQgdxxO3vc5N/GjZE/HoZarTzNOqYlQN8KX2rYMGYJAJWmQ1hkAI4kprZgHUMLPtqzS5vH4ylySTff/+nNwr2MhYt0aSSSWY2ojd1D+Zye3s7l6lyez66c1+kdP7AhZvev3sXuPD/Saowd8D1vuPrtJkcj2s34TQAn9HYHcfXjUiZGJDp4TgKEOZz04987y6rqKX1aAeBMZ4Jl6onKkIEUMpC0bFHCbAsd6qDj6H69fnqXUmxjfEXGkvp5Ep2KaUPUrDsWBPOXcXsAzVM1iwOz+FD3h90fVQQy3h+9O2wyEjRvHxmMGB42pgY/fmndFsApE+nItzY36uFLvgstYePLBfAeMumMH4K+ATEJz8Y/1GhJ3oEYGde+sMgy8Om6dcnEpocWqfNdwAra/dWRsj1k7GwsshFo/MzuGchT3vItr46BVeSqmF4QU+xa4A97l/uwAIRHGlO2eKzpYD8lSMpMqYJhbiCLcNWvAaidc1pgkKB59H2Pkc75WFDsghTywOcUE/RxVRG2P4CcQUOItP5WhUcMGQNG9Fh36ecLfQ9RD83KmNFQOuCSFkjws55C0hXDcBelyoABcHQBB2CQ74tCBGygLlG/vOX6FYd/MJ2tgEL44ObjAvVMj1LWAuXgBSvu2DvDg6gNgrfOSuzPCuJOwOv91oq4qV1C449RJMOO9nVo5l1g4lFwhpLupJn8wDlHO9EKLUxpgCFIYoU3MdN8F8YNvK2oD5mLtABdqwSq9A5JGsb8KprsEkJeMan58ZYOM+EAs+g2hip3Bho1mhbsa9BVp4K/F48liBSlH/EFZK2+aUjNCbIoUIV4B5VYMmJnTJLiumOHgtLUSBYhZ1EOXqejG3fdF69fJbF8IpktM9X/UdwwaokGqQU8yxmO7U5++GTADrW3YXnhdH0RfL3f8qprQUoFqSakwF/7MlYZRSQTM1ZBNa2Kru+AATJrK5uUuFP39/+uvfIriWXu7nAbMj0DwHv5prIET1myV4YECKVXAqyjZE0B9Tv+sKBklggjYimN1I+uY0foDPenRggc4dI7iD6DqbgC4lnME6vtjgTUejPi8ETpEVzJddcm2ioCD+Uj7PH166F3wNDPaYynPLS2fxBm/cVGSnOwxfwtvhgYJoNH9w1EaeKlZycTPZJbZ5GBkYQW1kSQ3PiO9KD9pBn6wp3u/rsvFRA2q84FJtLATP8JIdycfuxH1CZ/p6QRPaoHToWpGczhAjGAGuJTayy4qrWXhni1Z+j8lrblcPkJHAZE+lyBjIKxCv7gZXksjZDwAbMjNlTMSY80sog7RgA82gwNBasc6jzBYOAcKSqTE7zeBqj3uC3WCJez3oqtcjfQuI4/i6Vk5D7sK5IWsDLtf0DuA4PUB4k9yIS3EUvSjAXwWKJatUtf0DPglC7mIRxSM0of80gyA9kRwCD1x4E1rQeVEhKeFsnlmdaGYV9NALhB+DcdJVc/LcPTy2phBCzI/uJR6YHOi2CS0k7nYzWRQ7CYF6htGjJng6aqse4saO40O6oZT001/+R4MU6lxw9QCmsLQUndVQesSXsXGvfrP57ei0Yt3dJqTho9mpFKcNl1tIMO2WKwlogeNbW9AS7ozAwb28BZQO1AGItmcs/NNW/M2t7/LBACEfaMDn0jDQSo6pyotwptllNBg4kcaEZIdaRg2o11tCdlaHxTDgVM4qCL0o3XXBHsCfN0GqYD1BfcXEKZqbbqL7c4f2VbSaxwlYpdDUlCeptcklb67SZJhlt+0RzvPfud94UKf4aaf1bS726jDLyD2IIZqTjKqhtAExN/acqE5z2IcohnWk9taiWuQjO2nJXzy6uA5I+M8i8WNPFWb6c8/RkYd1GV2k/11tXvKii731YNzScgjvcND9Fe/3KOPKxsLUVij/bBrpVZpdp0Ve63V/QYrP7a2tf2S97v2tX45ed3frF6TXfQTAOheL67nJsnv1Qt7hXUZWN3grmTUmF1KtrglnK/hBOAeXRQhutsPOlf2vUUV7Jn6NetrqrxvXD6da9ZNBNOxsbcE/HSboNXleyRcHG/+nJL2538k1HL0JSb4aX/sXjw7KSpTZBDl5iE++ulVMbNHxu2nbA+n9m4eA579pj1EyrdsHxoIBXGR4sxpd8SpxgcpZvwSnHQcfu8y7i9bkUJbMXhem+AxGSZAz3b3JqBmhY7j4QDfqAy4RU+o6Yn4/yFZhY3dr63Q7IOHBPBKeCYx3gSHuj+Q5Ex93pvHwxg4PoF6WRcNREm4rYXnSmmz83U5Ss6xW3MySveN3yWWfVrxvy/eO31y9ASo0E4mOYFIjxNRMkr1kc84vDDMNgMh//C7BfRGIX1ORg6/0HLelFd+82B7sJFdpt81C7ryiPqv779tEGzrmYnxduzcNjg5hHe1StTDViJMV/wMDedItRFwrTTjQz4RRUHEB6oE8XjbedE/9Ins/t0Wua3Oea0nSrG/Xvcx7l7UcxroH5wIXsMgD7Ni7X6FHVXCoSpo5JsHpKUkiNyb4ETkmJUnH1ahxgmn5tnj/kch95LjZD8FJwsvS2yiE7uzuorT2xTaKNfcfocSw+/DqjV29yCqKjqZLTHtOi7DIiOWKIvNP64u1Y7hPbb0+TjzWo7eU2V1d9lK98hK1sge5rT51XxdpLbcfLNMXPliopnNdLVbJuML4vr/47u6u7je/m75f7ehGuYBqvBDVphnwKQeaub+FNLO7hTTzaKslv7kVa3popDAUtYKk5abbSFMgMr2BTc7FSCKHcPsgBBQHDo4cprshPwtBx3/6699CNVD6/Jb0ekf44ouJvpa1yhiB1+c2QHmBJk7MAfHTX/6bDGte2JDiObtgBZwzkNVD1drFrmAhOrke2ODe8bhjdJzDHAThBo/2tNwa0fqY7IOwfuMNAEwHhOOQBAWUWGIMnlUvnx4ejeoC03WQQ1AiNWbcVuYESPgh4PIb8tgAzJBqwFurtKGmRvuFYmDQ5eDEhW55VvvPrP4cTN4qUkQUfMSyWVZY5NjsHtZeecFELhUBm3yf21jo/X4f/vnsM/K1VaeRQ4iGyXL4+hT2S3B9QLtrRpWa2XHDwewVz2fRIXBGLPvHQdCHPCrcI/8KPTQffhs9G/7pP/+LHH8jp600Nu0Bbx614NBOSm/uHzxDGWbDrv9zDGWomDctgvP5mIt/A1UQzqXXc2c5YeKCKykAteCreXbjs/4Mr1aVkka6JBnOajwaQbgoMSYFUDA8c+gsxWNQ8jymFR3ygoPIBN9/JI+pYWOpZuRH8hrU9iHJjCQ/nogf+/0+/g+q9no+VoPu9ciP5DEKy9YzJCV1Zd3+FLuQ546mcoammyaxh1/2hnxdzyGDE/b8Vc2LnChWO1tTSMrkUyz1MepCiK7/ZUhqA46tUsEumAUDnBvikBWjPuxPHOJrTwWQiqjf0ejqBq/B70RccGOVdSPIiOM67aSWsuAfTlCJ79Iuha1XcHGO20d4FRs+amgcRz2WFR0Z8lqqcxjJ9gguKw10aKD0OAHXcGhh/UtHXNCCa2egQ5Hd9/sYstZkbvG+s3wC94ADJrPlZCjlOZDYWNES7YHoi+46+b0swLyFfbxAu6+OIXMvdAObfqKAHEe2ke/jNRtOpDy3nTgvY2RHfbT6sQvM6RLpRzWxlIl+J4SJ3CbUcd2hptX1ZRRnoF616SasZh4kCnCjtpoHWMEf21sDCB/tMM/ZFPiOPzCg8DOy34QusFEHiMuVdCLgNDmL3FTPvJIKA5tOo7f+EM8Vl9WjKvUZx5oPtoJf2LSbksxuqapzY90/eKYHHtRvAPeHdjUPHdV9y8W5PhFgxz1z4SycJOnjtRZYwz0jIj9a49IZgHx28OLwiGwiYB7Os/AyLjKxePJuDOOtyRJ/8A8atD4GKxRTTVY2t3i0OBFnXz89Ipt+jpt7PD/Dybe/w+Y5s95cQ7C9aqMYLQvMvQbbTLG8Fjm85YvyVdlUVaW8ABOgyCF7lIsfATzTL1wIxOENhMXMqiLdnJsOe72QZCuoZTAhmPUkyqTQdcnCCh24m0f/QEljnUzA5hgoCsphnVrXlJPkzOPVM1DQDllL8lSqc+5tlUxkala5XsF6HxHg3olw69nWNJ2R//tfcnbwag7j+Dlq4Fdzcy9S+8TVOnTSKeiMhwXAfAGlZx4/L+y9IVAv8Cwli0C/87eLVYTbnSjS0IKZgg/EJSgeOHhiOXcIEP2cs4MbL5A6Bp4Fp8SQ6c7D7zbfSwkBTCx/cMfQGbFqC6Qv++wMLNBnJ/HFDlZ6xBnotzMl4clAUTQZ7pSsDUPPAsXsaxFLz4HN7NkzHUaHU9Q6ZdRq7iR3MJ2RXngmgmcCCmPe4WLlYxHLe8/sC4yzho13HouMpHcStG4Q7vQLoVrc4wPbmX/FAd09psI9WRGzUJ1dAtbcmdy40HKFXjSWqyNrsYa4x+DyeO/x4w0AzuU2OhH7RLApoD3LGmzP8Wu0/4dgE8H95+wErmJNOyki/t0wasv98LmHly7CKm5aQSks5tPYt4ppFAms30WAsTEaWhNjH505b2Ek/RYeyIY5gMcyaUFD7nkHKbtLmh3P87ONyB0wgAbrpTAfm4kzPKK2P8WT3HIpwGzBndsFgFuZGUHzIbl3dvzmbONLIsFR1bpPA2qNJFxMmOJmQdcd2bZJHPa0EaydgBt9gT0BKk1w/5sXbg+t7I2CxHsI5EESDHe7dg8r9WOh9dNX4I0w1/g6vdxZV5T5I1MQhwjW6F/IVzQ7n1KVawwiRw1H0X8GVaExEIfN5jX0FfuZq1jYqwW52LZZDrcH2+Hm5+Uv7V12wBHnwg7s/FeirF7Wr2Lo8Y69CkmGitlTM5tQMYaNAMJXdFBzYPx5ndm9gPBC1yGLVy2s4wa8Vp5y53qUdwjjlWZwb3YyELxLOw6i6Ws21NywdoDvLqY3sM3v66Ig/vKDG+6a26Jt9jU339RDyNMoNTdSzZpWY24m9RDXMm4bfrgO/CUlqMvvckvFLo+YKtHd5ZCpC55dM/1NSEOpNzfQ06ijtG2rXdCDCfiObqeKrbi7zx97OEg7rPr7z8Oa6PCugmp/p/ujFV/oUIpTeDFy83Ua7NXzTdKk4Blz9kKnxtr/+uBbcnF/sAV6tKAKv8Fabn777PHT54dPARi3TUBTO9gabKExTGpTUhGN1LlUdlVc0avxdXrjdXrjdXrjdXrjdXrjdXrjdXrjdXrjdXrjdXrjdXrj+WBZ6/TG6/TG6/TGy1C0Tm+8Tm+8Tm+8Tm+8Tm+8Tm+8Tm/8jxrkfZ3eeJ3eeBn7XKc3Xqc3Xqc3/qQTTKzTG6/TG6/TG6/TG6/TG6/TG6/TG68+fW5FpOv0xu+fWmad3nid3nid3nid3nid3nj1Dl6nN16nN16nN16nN16nN16nN16nN16nN26dTOv0xuv0xuv0xuv0xuv0xuv0xuv0xncylqzTG//c6Y2jqHCbVUE5Rsh0gVxtcMvjbtLjN2kygeiXe8fJu3dAkq9UcXUFn3+oMXbe8Zs0uaCKw0MFDJyZ+jiPEIfunEE8xMf2FU3/CMZP7ULjo99OvFAIVGlb7OPcV9aNA3RCxBAIuecSM5c2nqKiU4hbR6c2FGEU3A6/vUsKKsY1BsZLbJ9XNh/LpB3X8hzjWro/ouh6EOyxgbAd8NJOA/4fJrWwwbt3Nmbm1VWob4uWtnCI9bVh/d5cXV39P5wcdDI=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Template","permalink":"/docs/API-docs/v1.1/createtemplate"},"next":{"title":"Get Template","permalink":"/docs/API-docs/v1.1/get-template"}}');var i=t(74848),r=t(28453),l=t(57742),o=t.n(l),a=t(78178),d=t.n(a),c=t(19624),h=t.n(c),p=t(96226),m=t.n(p),u=(t(77675),t(19365),t(51107)),g=t(21312);const x={id:"publictemplate",title:"Public Template",description:"The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique **template_id** and a **public_url**. The **public_url** is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing.",sidebar_label:"Public Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztPe1yHLeRr4IbX53FzezyQ5Ss0JdcaEmxdbEllkhF5SMVEjuD3YU4A4wBDJcbmVX5kboHuLo/9zcvcf/vUfwkV934GMzsBylSVuTUuioRd/DVaDQaje5G97vE0LFO9o6TI1ZWBTVMJ2/SJGc6U7wyXIpkLzmaMHJQDwueEV+L7B88I7Qo5FSTWjOliZEkUwyKjO+JmAk1RDN1wQjVZFjUrFJcGE1GUpExE0xRw8WY5DKrSwYFU24mpFIsZyMuWE60UXVmasX0gLyeMEFo6J5wTXSdZUzrUV0UMzd8nhIzsfApZmolNKGkFvyHmpFezzc+5XmvR6jICSW9XoWTO61V0esNCEy3/Q2Gsr+LGaE4JB8WDNuXdEaGjOgJVSy38FMxQ6SkhAk6LGCGZsJKQJGbtG2q+VhEcx9SzXIiBcLvAR2Qb+SUXUBn8WfCjWbFiGRUCGkAgFLmfMRZTsxEyXo8IWbCNXn18tsvCTdQj0hRIKg1DAMr4Ie2mONSBKi4GA9OxIk44tUeeVUVkuZkJmtFDp78vmlmJIFvx73eEzasx+TVs17vzb2JMZXe29ykVTWQFRPQX0GHepDJcjOHilU+2kjJdMIUg14ROEY1B+TmgMN8zIzGCQuSyWpGMilVzgUQVUoqOmZE1OWQKZ3aNZCKEQ7EoRjNZ30j+7Vm5N8PXzyHiZbUDMhBUes0DJdzxTIDRAPdA2b9rD63C/FwF2iPi3FKSnoOS8gN+aHm2TlMWzORw7+O0hBXvd5hXVVSGZaT13YKe70elHzFCjklVDGsn8mylIJUVNGSGdw6sE2gWLEfat6QUVF4XOydiD7p9QQt2V6vR15ZcuY5EwYWXeFy4oLbBgNb38wqrP9M5DxzO5IR+ErkqF0VkApVDyuWQZe2aoRqIMzphGcTxOGU2vWvCprZaSmmK5YZfsHaHV+mZAYdP2FCeggmUvE/S2Fogct3wZThGS3iZQYAoao2VCGPqCQXxn91I5Dv3XLCauMiOjoE0HJAbskFlmhGLmhRM+2gmqZkAlC9ZJViGref6xf3b04mjI8nS8ej+dtam1bHpNZuowco3Fh+VRG9DNE2ooVmhI9auCzpOYtGIxL5Ly0G5KsZydmI1oVJCQcKNapmA/JcGkKrquAZBW4ENACbjQK/7OMqO/IZtMnnQMkLnjNgjDkfjZiCzQyF2IVr46EDuqywAUwPd5qZIDfpLHQmC6nmSQg/t/FIMikME2ZA9i8oLxB4O1lNuMiKOmdkWNDsPMUzIyUKuDqsyozBkZPa/YFV4GCxOEf8EM0KoEIpAH4h3fBwVDiocmDwwM/9/oNCj2ochOsYq26XjySMDCjwW5KwkvIiRcSl5K0cEsNNwVLY4BUVs5Tk1LCUGHZphvIyJdmEZef4l6I5l2RYGyOFnViuZJXLqXC4HElhNP/zgh3pS94fozsp2U3Jw5Q8Ssn2Vkq2d1KyvZuS7Ycp2X6Ukp2tlOzspGRnNyU7Dy1YO48crmlAcAzA9o7FsvllYXfCc3YKDU9hbqdUG6a4Pgd2bYUMPLa9JAEV/akM24vlzQnINZnwPGeCjJQsiWIZrzhyE8sNQtcpwEMUTEpoYuWVC26lCIeD0KmcCsAbjsgVeVExcQiSAs0yWcMaI4YtUhGdzZLDCS8FOWK01Djzp8IwVSmuGbBqoQMGhGloyx6A8C1mADdZSdHmQMtXc9nqRCsDJ+i3XCPPhaNPh9N02jpNtwek1wt8Dr6dnZ2diHcngpCTBNjeSbJHTpJQ5SRJbRmcZlC27X5fwo/7O1+4nzP4+XDnkfs5xarbu+7nBH7u+KZuc8E3HBhrcGHs0I7BkggEqHR1Iq4ctCdiB6dhaFmtmAIUfyzw/TEFH+F8SX0BbMF5eJbM2NaYm+19mC0X3HBa6OUT9jU+oTl3QFo87abS3Mx3YebIzJZPG4s/oTnH8EAJHqK2CA/dqMgfBwjFzgoUdftcxoShFYpHc5h8MHAyzHJE2il8MniMwPlQaOx0+f5YfAhYhPP0CM7T5agMR+4nhM8uTB8KqYv6fX/MfjFAKRjFk+V4dRU+Iay2IfpQOJ3v9f0x+ggwCnLecnRC6SeEywgcKHBCsy3b2u1vP+jvbO3stvAJ6glboSz7ed6fzWZ3W4uSi1MLBzSK6pf0cnEBaE1AdgwrEUqcMig0a5fOr7qt11lIkDgdJkDo9PdPK/WCMguF53nlAt79m1ruxoN/+wv5d3ANH/obKsud2NzcR4L+J75DG5nT2efaduWbhqsX1O8KxxZMLAI4UBeWTSTPHPBQx1+4hqDuGQAO+riom3m+GS0qfMzzfln2Ox/hZx9pIPpYloM8H3RqzhGK/ViSPE/J/OeF3/OclGW55LP93vq8WZbzsxiUpYPNYc/T3tw6l1zwsoYrEqjV7A09R/3mkUdv6daSC9Lrff/999/3v/uu/+RJr+fX0A3hqDjSZNgR6OUHGiEm+l5vjzwbkfgTahOsHge5QLgZoirbV5jIqfAXIrw2KpLXoFAMClbUJoH6GDpj3EyYao8DKlpPsnB9RE2vNJMBeYW3S/jb38LCbQlvUr8eoK4br8bLeaer8LHYZ8Ml2wOvZK3LWVOLt86JRZ4xVYvlJsXGdUEVuwT1n+ZSzPHE25yB73e+ddiip+VG1YKKRafaZV7TQe69cJfwjaBf7MwFetsnWa0N6iTG7JJU1BimBHZ2QQueW31/Hz+wS1pWoFvZ/NPJSf6rf95EzS4oT41VKeR8zEEhv/mn4/3+f7xZUKOuKqYyqhkpGIykU8JMNiDHE1ZUjU1gOp0Opvd1NpGysAaBt1qxkf3/Uzl8e4rgVgOqq41FM7XEEGlSgVi6ilTcnBHGqCa+5QJdKi4N7prtLZTgnKpihQjnanxCckcHJCi0amkoPoajH4VbIF7W/C2B55wkb5rjHrWnLL+m7ZsbbE/YDQUdsmK+6P23VkFnsnY72lsL2lN1FB3hzYlCQSGM09lKo0J62Sm0ZVcL9qlFSLxN/Wnvt6dfAVJwHQ6SFjrj1s5mgJYfwRgak8CK6BqQYaDSO++CANjNtoFXkOLaXTME1CNYMdhr/GjXjNBamLmT3MkK3vA0Cr16lPmDPMYXtASrayMmrBjByQrLRwArz/IBTsQ2qiG9+nLF/cTV+IR4RQek1dv4NlykdTLf5ki91Qb004o34ILjFaragzVsPr189w3IC6tT941A355lrAJJ685bM4B84xMKtcaxCn055cW1PiHqWwDWz0yBrt6HPn1uRaTx7H9BhNoC+8bEapX+JR2v0N9g8SdEng6eOVXUNurx7XmxQv+M5auns73Vms6D9nQebt3iPtUa9u7Xqa3wcYH+uTsU3Jzrgs4x+5xlvKQFOogg3Dt32IG3uVo5wIDCH8uyqk28pVBpg2zDywDe7cEabn+Vkn5KeinZTMm9lGwMyEuGjhJZcKpwIgFX1nWCgytXDVbQrFbgaKVg4ilhg/GAvHv3Q02F4WZ2dUV65N078AG7uhrAHjsXcmr9Ko7BImwI+EU1V6ZcZnqBH5XM9CbcrTafs2n/iTMdbzrQNsg92dnwKy+aDgUf975loYqIBEZ5HgQye+dERx6uq4LOCB2BFdo6e2Az6xM0ABTvkR3ym9+S7Z3B1lZKtuzf5J6f4M4G7mG0IGWsWGWCxOLrdvBWvIObn4sY0oOtG23heNhb7mDo4hRdBHDca8WxZnN/goqRZjJdVWwkswPOnJPpRNZFDmejdfpkwT2vkdjR8kWNodkEHS6X00BU6RM6mhqoHAtaaZIe8YItskf3egeKjXhRRE6KxH/yrA2cvljBSucY59wT4c6GDhlcGAnsw3us9HpDNpLgjAFekqj9jLxh7RJY+aTl6IJup1KRCdVWmYQEBwsHbqDgMttxC/HgNa4hXHjYYTW3P5zac+fX7T3+8EFrZR+0j+mle3zZwq7QhkITXUmhg9GTNUXR5sM+/ff5+1N3Q/lOYbnRK6hxbkJejvun4OcsZrlcaC+KOii7zn6PJ1Lqpobzt3PHj95r+/FJBa58G4Pg/3JX2972F/dbstSjj2jba6/S1u7m9oPNlca9jh3o/W/EhNxkSdF0cKMlxZrNmq4tX3exfN19R9z/kNrn7S92WifT/VUyyieifY531DV65w+hXb7VBX6RmjfehzdU8H40RevdyXL351A5dRj3F9t/B5XTXUl0TrP0wYiSfCi10iLKvIFeaaUy6c6UGwP7s1Pvgw+jg+pc+X7dkgZ/vRNT64MHd6PWGJoOyZ0k/I9fvXg53frD12O5v7+///zw1eTpq/H+/n4JvweDwUK95CIywGFAfnavndwRj+LCklEGgwH6JFBD97D5ZiXGX9r26fI2A+d0+DMZSx58bGPJ3flGqPpxzqxFlpGfjzPcdc8maSIrfBkqxbM82Uvsy0v/8jFJcdmYNl/JfJbsvUvc2xf4071FgKabbzU8Xn2X6GzCSgp/+eWG565wPU7SxHrm6CRN0P8T3r4COSZ7iRy+ZZlJUvAgqUDpzzT0ge323vla9o1gkjpRP9lL7HZI0sR5VYRPhIlMgotalY+SqxR7Oq2o1lOp8pVdhi9Nl9CBhfg9G2r8I7wjhX7gXd4tu8GmV533wrfqKe7hqlmXpjOqFJ0l3afJ/kGed/NxnlZe+1nM/HnEDaglwysxrJakCTesjEdZsupKvj+mMyZhJuj3fpvlBR50m3bVRIpbNXQeu7dp+lYOT29Fjs1an94cx20SaL+Pg16CoOGfYwWvUOekVykJb7gHZB8eKrHcSet7jfsfGHmC+nhjz/qZTig8ZDekYBT0USJ64NN+CnnB2RR62CMvWcb4hYMtfjgNVdB16kvrzIB9C9l5sUkrIGzfFbSxz7rc93a3X0L7LkThTbHlrEzUJbC/sAEsqEma+KGABUa709a7ShP77P0UWNhtVmkK7+o0A+dbeFUm6pIpnrnH9AR6haMkPID2R5fbz6AStDXDu/l45oMWTW3v3N998BBgdshcwEVuuO9t6fxs23NrU1F4cBmWIrXPotLwTCi9w+tGf5h3X9KhQJY67XhqdeMpiTTZg+sYsQcXmQgdxxO3vc5N/GjZE/HoZarTzNOqYlQN8KX2rYMGYJAJWmQ1hkAI4kprZgHUMLPtqzS5vH4ylySTff/+nNwr2MhYt0aSSSWY2ojd1D+Zye3s7l6lyez66c1+kdP7AhZvev3sXuPD/Saowd8D1vuPrtJkcj2s34TQAn9HYHcfXjUiZGJDp4TgKEOZz04987y6rqKX1aAeBMZ4Jl6onKkIEUMpC0bFHCbAsd6qDj6H69fnqXUmxjfEXGkvp5Ep2KaUPUrDsWBPOXcXsAzVM1iwOz+FD3h90fVQQy3h+9O2wyEjRvHxmMGB42pgY/fmndFsApE+nItzY36uFLvgstYePLBfAeMumMH4K+ATEJz8Y/1GhJ3oEYGde+sMgy8Om6dcnEpocWqfNdwAra/dWRsj1k7GwsshFo/MzuGchT3vItr46BVeSqmF4QU+xa4A97l/uwAIRHGlO2eKzpYD8lSMpMqYJhbiCLcNWvAaidc1pgkKB59H2Pkc75WFDsghTywOcUE/RxVRG2P4CcQUOItP5WhUcMGQNG9Fh36ecLfQ9RD83KmNFQOuCSFkjws55C0hXDcBelyoABcHQBB2CQ74tCBGygLlG/vOX6FYd/MJ2tgEL44ObjAvVMj1LWAuXgBSvu2DvDg6gNgrfOSuzPCuJOwOv91oq4qV1C449RJMOO9nVo5l1g4lFwhpLupJn8wDlHO9EKLUxpgCFIYoU3MdN8F8YNvK2oD5mLtABdqwSq9A5JGsb8KprsEkJeMan58ZYOM+EAs+g2hip3Bho1mhbsa9BVp4K/F48liBSlH/EFZK2+aUjNCbIoUIV4B5VYMmJnTJLiumOHgtLUSBYhZ1EOXqejG3fdF69fJbF8IpktM9X/UdwwaokGqQU8yxmO7U5++GTADrW3YXnhdH0RfL3f8qprQUoFqSakwF/7MlYZRSQTM1ZBNa2Kru+AATJrK5uUuFP39/+uvfIriWXu7nAbMj0DwHv5prIET1myV4YECKVXAqyjZE0B9Tv+sKBklggjYimN1I+uY0foDPenRggc4dI7iD6DqbgC4lnME6vtjgTUejPi8ETpEVzJddcm2ioCD+Uj7PH166F3wNDPaYynPLS2fxBm/cVGSnOwxfwtvhgYJoNH9w1EaeKlZycTPZJbZ5GBkYQW1kSQ3PiO9KD9pBn6wp3u/rsvFRA2q84FJtLATP8JIdycfuxH1CZ/p6QRPaoHToWpGczhAjGAGuJTayy4qrWXhni1Z+j8lrblcPkJHAZE+lyBjIKxCv7gZXksjZDwAbMjNlTMSY80sog7RgA82gwNBasc6jzBYOAcKSqTE7zeBqj3uC3WCJez3oqtcjfQuI4/i6Vk5D7sK5IWsDLtf0DuA4PUB4k9yIS3EUvSjAXwWKJatUtf0DPglC7mIRxSM0of80gyA9kRwCD1x4E1rQeVEhKeFsnlmdaGYV9NALhB+DcdJVc/LcPTy2phBCzI/uJR6YHOi2CS0k7nYzWRQ7CYF6htGjJng6aqse4saO40O6oZT001/+R4MU6lxw9QCmsLQUndVQesSXsXGvfrP57ei0Yt3dJqTho9mpFKcNl1tIMO2WKwlogeNbW9AS7ozAwb28BZQO1AGItmcs/NNW/M2t7/LBACEfaMDn0jDQSo6pyotwptllNBg4kcaEZIdaRg2o11tCdlaHxTDgVM4qCL0o3XXBHsCfN0GqYD1BfcXEKZqbbqL7c4f2VbSaxwlYpdDUlCeptcklb67SZJhlt+0RzvPfud94UKf4aaf1bS726jDLyD2IIZqTjKqhtAExN/acqE5z2IcohnWk9taiWuQjO2nJXzy6uA5I+M8i8WNPFWb6c8/RkYd1GV2k/11tXvKii731YNzScgjvcND9Fe/3KOPKxsLUVij/bBrpVZpdp0Ve63V/QYrP7a2tf2S97v2tX45ed3frF6TXfQTAOheL67nJsnv1Qt7hXUZWN3grmTUmF1KtrglnK/hBOAeXRQhutsPOlf2vUUV7Jn6NetrqrxvXD6da9ZNBNOxsbcE/HSboNXleyRcHG/+nJL2538k1HL0JSb4aX/sXjw7KSpTZBDl5iE++ulVMbNHxu2nbA+n9m4eA579pj1EyrdsHxoIBXGR4sxpd8SpxgcpZvwSnHQcfu8y7i9bkUJbMXhem+AxGSZAz3b3JqBmhY7j4QDfqAy4RU+o6Yn4/yFZhY3dr63Q7IOHBPBKeCYx3gSHuj+Q5Ex93pvHwxg4PoF6WRcNREm4rYXnSmmz83U5Ss6xW3MySveN3yWWfVrxvy/eO31y9ASo0E4mOYFIjxNRMkr1kc84vDDMNgMh//C7BfRGIX1ORg6/0HLelFd+82B7sJFdpt81C7ryiPqv779tEGzrmYnxduzcNjg5hHe1StTDViJMV/wMDedItRFwrTTjQz4RRUHEB6oE8XjbedE/9Ins/t0Wua3Oea0nSrG/Xvcx7l7UcxroH5wIXsMgD7Ni7X6FHVXCoSpo5JsHpKUkiNyb4ETkmJUnH1ahxgmn5tnj/kch95LjZD8FJwsvS2yiE7uzuorT2xTaKNfcfocSw+/DqjV29yCqKjqZLTHtOi7DIiOWKIvNP64u1Y7hPbb0+TjzWo7eU2V1d9lK98hK1sge5rT51XxdpLbcfLNMXPliopnNdLVbJuML4vr/47u6u7je/m75f7ehGuYBqvBDVphnwKQeaub+FNLO7hTTzaKslv7kVa3popDAUtYKk5abbSFMgMr2BTc7FSCKHcPsgBBQHDo4cprshPwtBx3/6699CNVD6/Jb0ekf44ouJvpa1yhiB1+c2QHmBJk7MAfHTX/6bDGte2JDiObtgBZwzkNVD1drFrmAhOrke2ODe8bhjdJzDHAThBo/2tNwa0fqY7IOwfuMNAEwHhOOQBAWUWGIMnlUvnx4ejeoC03WQQ1AiNWbcVuYESPgh4PIb8tgAzJBqwFurtKGmRvuFYmDQ5eDEhW55VvvPrP4cTN4qUkQUfMSyWVZY5NjsHtZeecFELhUBm3yf21jo/X4f/vnsM/K1VaeRQ4iGyXL4+hT2S3B9QLtrRpWa2XHDwewVz2fRIXBGLPvHQdCHPCrcI/8KPTQffhs9G/7pP/+LHH8jp600Nu0Bbx614NBOSm/uHzxDGWbDrv9zDGWomDctgvP5mIt/A1UQzqXXc2c5YeKCKykAteCreXbjs/4Mr1aVkka6JBnOajwaQbgoMSYFUDA8c+gsxWNQ8jymFR3ygoPIBN9/JI+pYWOpZuRH8hrU9iHJjCQ/nogf+/0+/g+q9no+VoPu9ciP5DEKy9YzJCV1Zd3+FLuQ546mcoammyaxh1/2hnxdzyGDE/b8Vc2LnChWO1tTSMrkUyz1MepCiK7/ZUhqA46tUsEumAUDnBvikBWjPuxPHOJrTwWQiqjf0ejqBq/B70RccGOVdSPIiOM67aSWsuAfTlCJ79Iuha1XcHGO20d4FRs+amgcRz2WFR0Z8lqqcxjJ9gguKw10aKD0OAHXcGhh/UtHXNCCa2egQ5Hd9/sYstZkbvG+s3wC94ADJrPlZCjlOZDYWNES7YHoi+46+b0swLyFfbxAu6+OIXMvdAObfqKAHEe2ke/jNRtOpDy3nTgvY2RHfbT6sQvM6RLpRzWxlIl+J4SJ3CbUcd2hptX1ZRRnoF616SasZh4kCnCjtpoHWMEf21sDCB/tMM/ZFPiOPzCg8DOy34QusFEHiMuVdCLgNDmL3FTPvJIKA5tOo7f+EM8Vl9WjKvUZx5oPtoJf2LSbksxuqapzY90/eKYHHtRvAPeHdjUPHdV9y8W5PhFgxz1z4SycJOnjtRZYwz0jIj9a49IZgHx28OLwiGwiYB7Os/AyLjKxePJuDOOtyRJ/8A8atD4GKxRTTVY2t3i0OBFnXz89Ipt+jpt7PD/Dybe/w+Y5s95cQ7C9aqMYLQvMvQbbTLG8Fjm85YvyVdlUVaW8ABOgyCF7lIsfATzTL1wIxOENhMXMqiLdnJsOe72QZCuoZTAhmPUkyqTQdcnCCh24m0f/QEljnUzA5hgoCsphnVrXlJPkzOPVM1DQDllL8lSqc+5tlUxkala5XsF6HxHg3olw69nWNJ2R//tfcnbwag7j+Dlq4Fdzcy9S+8TVOnTSKeiMhwXAfAGlZx4/L+y9IVAv8Cwli0C/87eLVYTbnSjS0IKZgg/EJSgeOHhiOXcIEP2cs4MbL5A6Bp4Fp8SQ6c7D7zbfSwkBTCx/cMfQGbFqC6Qv++wMLNBnJ/HFDlZ6xBnotzMl4clAUTQZ7pSsDUPPAsXsaxFLz4HN7NkzHUaHU9Q6ZdRq7iR3MJ2RXngmgmcCCmPe4WLlYxHLe8/sC4yzho13HouMpHcStG4Q7vQLoVrc4wPbmX/FAd09psI9WRGzUJ1dAtbcmdy40HKFXjSWqyNrsYa4x+DyeO/x4w0AzuU2OhH7RLApoD3LGmzP8Wu0/4dgE8H95+wErmJNOyki/t0wasv98LmHly7CKm5aQSks5tPYt4ppFAms30WAsTEaWhNjH505b2Ek/RYeyIY5gMcyaUFD7nkHKbtLmh3P87ONyB0wgAbrpTAfm4kzPKK2P8WT3HIpwGzBndsFgFuZGUHzIbl3dvzmbONLIsFR1bpPA2qNJFxMmOJmQdcd2bZJHPa0EaydgBt9gT0BKk1w/5sXbg+t7I2CxHsI5EESDHe7dg8r9WOh9dNX4I0w1/g6vdxZV5T5I1MQhwjW6F/IVzQ7n1KVawwiRw1H0X8GVaExEIfN5jX0FfuZq1jYqwW52LZZDrcH2+Hm5+Uv7V12wBHnwg7s/FeirF7Wr2Lo8Y69CkmGitlTM5tQMYaNAMJXdFBzYPx5ndm9gPBC1yGLVy2s4wa8Vp5y53qUdwjjlWZwb3YyELxLOw6i6Ws21NywdoDvLqY3sM3v66Ig/vKDG+6a26Jt9jU339RDyNMoNTdSzZpWY24m9RDXMm4bfrgO/CUlqMvvckvFLo+YKtHd5ZCpC55dM/1NSEOpNzfQ06ijtG2rXdCDCfiObqeKrbi7zx97OEg7rPr7z8Oa6PCugmp/p/ujFV/oUIpTeDFy83Ua7NXzTdKk4Blz9kKnxtr/+uBbcnF/sAV6tKAKv8Fabn777PHT54dPARi3TUBTO9gabKExTGpTUhGN1LlUdlVc0avxdXrjdXrjdXrjdXrjdXrjdXrjdXrjdXrjdXrjdXrjdXrj+WBZ6/TG6/TG6/TGy1C0Tm+8Tm+8Tm+8Tm+8Tm+8Tm+8Tm/8jxrkfZ3eeJ3eeBn7XKc3Xqc3Xqc3/qQTTKzTG6/TG6/TG6/TG6/TG6/TG6/TG68+fW5FpOv0xu+fWmad3nid3nid3nid3nid3nj1Dl6nN16nN16nN16nN16nN16nN16nN16nN26dTOv0xuv0xuv0xuv0xuv0xuv0xuv0xncylqzTG//c6Y2jqHCbVUE5Rsh0gVxtcMvjbtLjN2kygeiXe8fJu3dAkq9UcXUFn3+oMXbe8Zs0uaCKw0MFDJyZ+jiPEIfunEE8xMf2FU3/CMZP7ULjo99OvFAIVGlb7OPcV9aNA3RCxBAIuecSM5c2nqKiU4hbR6c2FGEU3A6/vUsKKsY1BsZLbJ9XNh/LpB3X8hzjWro/ouh6EOyxgbAd8NJOA/4fJrWwwbt3Nmbm1VWob4uWtnCI9bVh/d5cXV39P5wcdDI=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-2",custom_edit_url:null},j=void 0,b={},f=[];function y(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Public Template"}),"\n",(0,i.jsx)(o(),{method:"post",path:"/publictemplate",context:"endpoint"}),"\n",(0,i.jsxs)(n.p,{children:["The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique ",(0,i.jsx)(n.strong,{children:"template_id"})," and a ",(0,i.jsx)(n.strong,{children:"public_url"}),". The ",(0,i.jsx)(n.strong,{children:"public_url"})," is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing."]}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Unique identifier for this widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Specify the hint for widgets. This parameter is optional and is not applicable to the following widgets: checkbox, radio button, dropdown."]}),"\n"]}),"\n",(0,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 "options": {\n "hint": "Provide signature"\n }\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 "hint": "Provide 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 "hint": "Provide 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 "hint": "Provide email",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide name",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide job title",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide company",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12,\n "min_date": "",\n "max_date": "",\n "readonly": false,\n "signing_date": false,\n "hint": "Provide date"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"min_date:"})," Provide the minimum restriction date. The date must be in ",(0,i.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"max_date:"})," Provide the maximum restriction date. The date must be in ",(0,i.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"signing_date"}),": If signing_date is set to true, the signing date is shown to the signer during signing. You may set either signing_date or default, but not both. Using both is not supported."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,i.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"14",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Provide number",\n "formula": "",\n "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,i.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"decimalplaces:"})," Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"15",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"cells"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "cells",\n "page": 1,\n "x": 100,\n "y": 100,\n "w": 114,\n "h": 50,\n "options": {\n "name": "cells",\n "required": true,\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"cell_count:"})," Specify the number of cells that should be returned to the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"16",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"attachments"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "attachments",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "attachment widget",\n "hint": "Provide files"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,i.jsx)(n.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "required": true,\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "response": "04/15/2024",\n "format": "mm/dd/yyyy",\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "required": true,\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 528,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "values": ["male", "female", "other"],\n "response": "female",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,i.jsx)(g.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,i.jsx)(d(),{parameters:void 0}),"\n",(0,i.jsx)(h(),{...t(71591)}),"\n",(0,i.jsx)(m(),{...t(94633)})]})}function w(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(y,{...e})}):y(e)}},71591(e){e.exports=JSON.parse('{"title":"Body","body":{"content":{"application/json":{"schema":{"required":["file","signers","title"],"type":"object","properties":{"file":{"type":"string","format":"base64","example":"base64 encoded pdf"},"file_password":{"type":"string","format":"string","example":""},"title":{"type":"string","format":"string","example":"sample template"},"note":{"type":"string","format":"string","example":"sample note"},"description":{"type":"string","format":"string","example":"sample description"},"signers":{"type":"array","description":"You can provide signer optionally if you it as default signer","items":{"type":"object","properties":{"role":{"type":"string","format":"string","example":"ceo"},"email":{"type":"string","format":"string","example":""},"name":{"type":"string","format":"string","example":""},"phone":{"type":"string","format":"string","example":""},"company":{"type":"string","format":"string","example":""},"job_title":{"type":"string","format":"string","example":""},"signer_role":{"type":"string","format":"string","description":"Specifies the role of the recipient in the signing process. Allowed values:\\n- **signer** (default): Must have at least one signature widget.\\n- **viewer**: Receives the document to view only; must have no widgets.\\n- **approver**: Reviews and approves the document; no signature widget required.\\n","enum":["signer","viewer","approver"],"example":"signer"},"access_code":{"type":"string","format":"string","description":"when set, this numeric access code is required for the signer to access and sign the document.","example":"123456"},"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Allowed values include signature, stamp, initials, email, name, job title, company, date, textbox, checkbox, dropdown, radio button, image, number, cells, attachments.","format":"string","example":"signature"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":244},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":71},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":38},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":46}},"title":"createtemplate_body_widgets"}}},"title":"createtemplate_body_signers"}},"sendInOrder":{"type":"boolean","description":"If set to \'true\', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to \'true\'.","example":true},"send_in_order_strict":{"type":"boolean","description":"When set to \'true\', each signer is blocked from accessing the document until all preceding signers have completed their action. Enforces strict sequential signing. Only applies when \'sendInOrder\' is also \'true\'. Defaults to \'false\'.","example":false},"allow_offline_sign":{"type":"boolean","description":"If set to \'true\', signers can submit a copy of documents created from this template signed using an external tool for owner review. Defaults to \'false\'.","example":false},"enableOTP":{"type":"boolean","description":"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.","example":false},"enableTour":{"type":"boolean","description":"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.","example":false},"redirect_url":{"type":"string","description":"Specifies the URL where the signer will be redirected upon completing the document signing process.","example":""},"sender_name":{"type":"string","description":"The name of the person or organization on whose behalf the email is being sent.","example":"opensign\u2122"},"sender_email":{"type":"string","description":"The email address of the person or organization that users can reply to.","example":"mailer@opensignlabs.com"},"allow_modifications":{"type":"boolean","description":"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.","example":false},"auto_reminder":{"type":"boolean","description":"Set to true to enable automatic reminders. Set to false to disable them (default behavior).","example":false},"timeToCompleteDays":{"type":"number","description":"time to complete days is used to calculate expiry date of your document","format":"number","example":15},"remind_once_in_every":{"type":"number","description":"Number of days between reminders. This is only applicable when auto_reminder is set to true.","example":5},"merge_certificate":{"type":"boolean","description":"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\\n\\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\\n\\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\\n","example":false},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed. \\n"},"cc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"cc (carbon copy): Users added here will receive a notification email once the document is completed.\\n"},"prefill":{"type":"object","description":"You can provide widgets which can embed before sending to signer","properties":{"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","format":"string","example":"textbox"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":100},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":30},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":40},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":80},"options":{"type":"object","properties":{"name":{"type":"string","example":"textbox"},"response":{"type":"string","example":"joe"},"color":{"type":"string","example":"red"},"fontsize":{"type":"number","example":12}}}}}}},"title":"prefill"}},"title":"createtemplate_body"}}},"required":true}}')},94633(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Template created successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"template_id":{"type":"string","example":"Av8Pmpnmch"},"public_url":{"type":"string","example":"https://app.example.com/publicsign?templateid=Av8Pmpnmch"},"message":{"type":"string","example":"Public template created successfully!"}},"title":"inline_response_publictemplate"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/138cee78.09d89b2c.js b/assets/js/138cee78.09d89b2c.js deleted file mode 100644 index 60471a3dc..000000000 --- a/assets/js/138cee78.09d89b2c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[1679],{14988(e,t,a){a.r(t),a.d(t,{assets:()=>b,contentTitle:()=>y,default:()=>J,frontMatter:()=>g,metadata:()=>n,toc:()=>P});const n=JSON.parse('{"id":"API-docs/v1.1/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/v1.1/createcontact.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/createcontact","permalink":"/docs/API-docs/v1.1/createcontact","draft":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJzVWM1u5MYRfpVKXxIPqPmR1g7Ck5XFYiNk4RUsGQKiFYQiWUO21OxudzfnB4MBfPAb5JRrHm2fJKgmOcMZadcWbGwSYLEYVVdV1399zY0IWHqR3orXRgfMgxd3iSjI507aII0WqbiuCF47wkDQMcH55QWgUmbpYW0aCAZoPjcuKPJerSFvuTUtIe/UQqgwQI4aWB49eFlqch7mxrEOB7K2xgXUAQqTNzXp4MciEcaSQ7bkohCpaDV3SkUiHP3YkA9/NcVapJsjwy+dWciCICNllmDRYU2BHJvbWbhXxL9IB1aC1iqZxzsnD541bYTPK6qRf/GN0lHBMaMapRKJ0FgTxy2sLYlUmOyBolLr2PogybNk5Eo3PZcPTupSJGJuXI1hSKEV1lYx04Nh80lsk+6yl8tnRN92hHFualZlK6NfbMrs9Ox0djY7O52xitzUFvX6pUqMJc2ZZxUPJrsPMqgXW1LQQmy3ieiED4viPuNa2PL5PlXBNRQJ3hrt23ScTqdPS6Yv8FZlAb7Jc/J+3ii1/sNLyuTzpdCSuaJf5rmtZlm1On2wHL//83p6NTubncZ//xP1lHRlVJyH5+T33KfT07OT2fRk+ufr2Tfpq7+kX38znk6n/xCJWNVq3+iiwBAD3Zdp/3djiy9wz/aYreuPggJK5YcC/RTcxq559VxfXJmaQiV1CUvSAZbO6DIBqwg9QXBrwBKlBoWB3O/YJ+SccZ8P08ssG44NqZXUdN8PhftX0+n9bBeE2aeHAypHWKyBVtIH/2Xd/ZQNn3dsNnDs66eOXegFKlnEtX5tHkl/WZ+G14f2+qflK1umeC4OnB3SWyc95Y2TYS3S241YnaCVJ+15enu3vUsEV4xhOGGNjxZjqEQqJsfowpNbkPNRTeOUSEUVgvXpZOJRF5lZjfv5ozDzPA0naOVkMRvzTDuWQWtfxE/NyUtFfMBS6vKX5O72IbriNLaZOgjULl9o5d9p3YOc9IArEZLLpyIsyMWccXV8v8dkb/oc79LYL6Dd/nlupew2yhB0DHbEfuwfTP1+kEs9N9GDjvzekr6SpY4FFiNwDHFvSOWmJkaGoSIYjXqRjz//eyc1Gu2QaWyF8Qf9Qb9vHFizJDdvFKAuYK5oJTNFUYzqeLZDyZ6w7jCy1IFKxyC0kKUMqCIi5jmWo8VMKskdxGymxceDJvRjuKkoVBSh8x8dAUJBC1LceIBNMDUGVtXbC0vjHueM1xNAyBovNXkPpCvUOTP25ZCAcYAaSAdy1klP4INjq2Vrm9HB8fypUWNJrDuBYbAKUpJ7BpzJGh/AG9VEk4HXjnFUQO+QJip8DOKbleUjYCon2VHF+V0QlI0syCeQm4LAxwphF3QBGfkAlm2ROXlW2mhl8seYQMZrYA3PL4kKzPzARhYPDrVnUNDa0udgFzDrDAM/ag0cjX7wxBl+J/WjT0ejD/oEbnd1dUOZl4Hu/tT34XK5fNJ/Xx3KvJXhb00G35M1Xgbj1nvpUoaqyWLPDpXs/mg1vSVNsX4GHbnXUZjcPx0BTJ1UpOzkigJXiJ+cX17Ekf8VfPzpn/CO0GmozLKt1rxxpNZQ9ldx5NrMt2HbTez4jMMmVBzxvC2+7m3WR/CmwvDxp395+I6WIHXXUuzKaHTZZErmcE215UXtR6O0f3KGnrZ/QWYEvkIupYVEQLCttJL6cQzneg2NJwdLGapYDEyPcgducFz2L03I0FMBRkeJ/s7x3iKm157Ugjzr0iawGVRIfiWEypmmbG8bGtM552gulYIbWZQUom/nRQG2Iy9bMgd8YA7NuSFCRWtAR+BJhzFcHonEk8byu5kKjmmsfcMPc04A6cIaqYNPoXA4Hzysk32hx50njX6G1IYQd+FIOjW7lLSd2Hm8o44/8Fw+2iaH89bRnBxfGN3e58XKrpxu+7IErtbfUtbt46Ld6AxHuq2DVn57rCfCCnK1fz+/IreQOXWr9RMdPYnME5EIJXPSfrjnzt9evoPF2XgqksGO/hXNPXl38frNd1dv2BgepG3AZuPpeBqfWsaHGvXgpsNPM8erbbPHcf/lDzkdngi0ChOrUEYUF0Oz6QDY7dHnnbtEVAzQ0lux2XCD/uDUdsvkHxtyjO7uErFAJzHjPX97t016LMKI7ZHWHWAmHU6u+XpmV00La44gLYOpVuI8z8mGz/IOMeTl+6trkYis+wRVm4JlHC758xQuRSriV6y4BOMHJKZthEJdNlhGTBR1MnziCXqIvR4j9up+sFf9kV4PLDwEZa0b/D879azAZtPiuu12x98efVKiC2zPzem72263/wHx/A75","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get your API credits","permalink":"/docs/API-docs/v1.1/getcredits"},"next":{"title":"Get Contact","permalink":"/docs/API-docs/v1.1/getcontact"}}');var r=a(74848),o=a(28453),s=a(57742),i=a.n(s),c=a(78178),p=a.n(c),l=a(19624),d=a.n(l),m=a(96226),u=a.n(m),x=(a(77675),a(19365),a(51107)),f=a(21312);const g={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:"eJzVWM1u5MYRfpVKXxIPqPmR1g7Ck5XFYiNk4RUsGQKiFYQiWUO21OxudzfnB4MBfPAb5JRrHm2fJKgmOcMZadcWbGwSYLEYVVdV1399zY0IWHqR3orXRgfMgxd3iSjI507aII0WqbiuCF47wkDQMcH55QWgUmbpYW0aCAZoPjcuKPJerSFvuTUtIe/UQqgwQI4aWB49eFlqch7mxrEOB7K2xgXUAQqTNzXp4MciEcaSQ7bkohCpaDV3SkUiHP3YkA9/NcVapJsjwy+dWciCICNllmDRYU2BHJvbWbhXxL9IB1aC1iqZxzsnD541bYTPK6qRf/GN0lHBMaMapRKJ0FgTxy2sLYlUmOyBolLr2PogybNk5Eo3PZcPTupSJGJuXI1hSKEV1lYx04Nh80lsk+6yl8tnRN92hHFualZlK6NfbMrs9Ox0djY7O52xitzUFvX6pUqMJc2ZZxUPJrsPMqgXW1LQQmy3ieiED4viPuNa2PL5PlXBNRQJ3hrt23ScTqdPS6Yv8FZlAb7Jc/J+3ii1/sNLyuTzpdCSuaJf5rmtZlm1On2wHL//83p6NTubncZ//xP1lHRlVJyH5+T33KfT07OT2fRk+ufr2Tfpq7+kX38znk6n/xCJWNVq3+iiwBAD3Zdp/3djiy9wz/aYreuPggJK5YcC/RTcxq559VxfXJmaQiV1CUvSAZbO6DIBqwg9QXBrwBKlBoWB3O/YJ+SccZ8P08ssG44NqZXUdN8PhftX0+n9bBeE2aeHAypHWKyBVtIH/2Xd/ZQNn3dsNnDs66eOXegFKlnEtX5tHkl/WZ+G14f2+qflK1umeC4OnB3SWyc95Y2TYS3S241YnaCVJ+15enu3vUsEV4xhOGGNjxZjqEQqJsfowpNbkPNRTeOUSEUVgvXpZOJRF5lZjfv5ozDzPA0naOVkMRvzTDuWQWtfxE/NyUtFfMBS6vKX5O72IbriNLaZOgjULl9o5d9p3YOc9IArEZLLpyIsyMWccXV8v8dkb/oc79LYL6Dd/nlupew2yhB0DHbEfuwfTP1+kEs9N9GDjvzekr6SpY4FFiNwDHFvSOWmJkaGoSIYjXqRjz//eyc1Gu2QaWyF8Qf9Qb9vHFizJDdvFKAuYK5oJTNFUYzqeLZDyZ6w7jCy1IFKxyC0kKUMqCIi5jmWo8VMKskdxGymxceDJvRjuKkoVBSh8x8dAUJBC1LceIBNMDUGVtXbC0vjHueM1xNAyBovNXkPpCvUOTP25ZCAcYAaSAdy1klP4INjq2Vrm9HB8fypUWNJrDuBYbAKUpJ7BpzJGh/AG9VEk4HXjnFUQO+QJip8DOKbleUjYCon2VHF+V0QlI0syCeQm4LAxwphF3QBGfkAlm2ROXlW2mhl8seYQMZrYA3PL4kKzPzARhYPDrVnUNDa0udgFzDrDAM/ag0cjX7wxBl+J/WjT0ejD/oEbnd1dUOZl4Hu/tT34XK5fNJ/Xx3KvJXhb00G35M1Xgbj1nvpUoaqyWLPDpXs/mg1vSVNsX4GHbnXUZjcPx0BTJ1UpOzkigJXiJ+cX17Ekf8VfPzpn/CO0GmozLKt1rxxpNZQ9ldx5NrMt2HbTez4jMMmVBzxvC2+7m3WR/CmwvDxp395+I6WIHXXUuzKaHTZZErmcE215UXtR6O0f3KGnrZ/QWYEvkIupYVEQLCttJL6cQzneg2NJwdLGapYDEyPcgducFz2L03I0FMBRkeJ/s7x3iKm157Ugjzr0iawGVRIfiWEypmmbG8bGtM552gulYIbWZQUom/nRQG2Iy9bMgd8YA7NuSFCRWtAR+BJhzFcHonEk8byu5kKjmmsfcMPc04A6cIaqYNPoXA4Hzysk32hx50njX6G1IYQd+FIOjW7lLSd2Hm8o44/8Fw+2iaH89bRnBxfGN3e58XKrpxu+7IErtbfUtbt46Ld6AxHuq2DVn57rCfCCnK1fz+/IreQOXWr9RMdPYnME5EIJXPSfrjnzt9evoPF2XgqksGO/hXNPXl38frNd1dv2BgepG3AZuPpeBqfWsaHGvXgpsNPM8erbbPHcf/lDzkdngi0ChOrUEYUF0Oz6QDY7dHnnbtEVAzQ0lux2XCD/uDUdsvkHxtyjO7uErFAJzHjPX97t016LMKI7ZHWHWAmHU6u+XpmV00La44gLYOpVuI8z8mGz/IOMeTl+6trkYis+wRVm4JlHC758xQuRSriV6y4BOMHJKZthEJdNlhGTBR1MnziCXqIvR4j9up+sFf9kV4PLDwEZa0b/D879azAZtPiuu12x98efVKiC2zPzem72263/wHx/A75",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},y=void 0,b={},P=[];function X(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(x.default,{as:"h1",className:"openapi__heading",children:"Create Contact"}),"\n",(0,r.jsx)(i(),{method:"post",path:"/createcontact",context:"endpoint"}),"\n",(0,r.jsx)(t.p,{children:"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents."}),"\n",(0,r.jsx)(x.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,r.jsx)(f.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,r.jsx)(p(),{parameters:void 0}),"\n",(0,r.jsx)(d(),{...a(62464)}),"\n",(0,r.jsx)(u(),{...a(36906)})]})}function J(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(X,{...e})}):X(e)}},62464(e){e.exports=JSON.parse('{"title":"Body","body":{"description":"Provide below parameter to create contact","content":{"application/json":{"schema":{"required":["email","name"],"type":"object","properties":{"name":{"type":"string","format":"string","example":"joe bee"},"email":{"type":"string","format":"string","example":"joebee@example.com"},"phone":{"type":"string","format":"string","example":"1232131321"},"company":{"type":"string","format":"string","example":"opensign"},"job_title":{"type":"string","format":"string","example":"dev"}},"title":"createcontact_body"}}},"required":true}}')},36906(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Contact created successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"ph1bhx2jp"},"name":{"type":"string","format":"string","example":"joe bee"},"email":{"type":"string","format":"string","example":"joebee@example.com"},"phone":{"type":"string","format":"string","example":"4131231231"},"company":{"type":"string","format":"string","example":"opensign"},"job_title":{"type":"string","format":"string","example":"dev"},"createdAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"xml":{"name":"contactdetails"},"title":"contact"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"401":{"description":"Contact already exists!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Contact already exists!"}},"title":"inline_response_401_1"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/138cee78.310f4c3f.js b/assets/js/138cee78.310f4c3f.js new file mode 100644 index 000000000..c7696709e --- /dev/null +++ b/assets/js/138cee78.310f4c3f.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[1679],{14988(t,e,n){n.r(e),n.d(e,{assets:()=>S,contentTitle:()=>y,default:()=>C,frontMatter:()=>h,metadata:()=>a,toc:()=>V});const a=JSON.parse('{"id":"API-docs/v1.1/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/v1.1/createcontact.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/createcontact","permalink":"/docs/API-docs/v1.1/createcontact","draft":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJzVGdtuG8f1V07XQGERS1KUnRRlirSKrDhG3VgQpRqoKGiHu4fcMYczm5nZpQiJQB6KfkDRl772J/reT/GXFGcuy4scO0KKtAV8kWbOOXPut71LLJuZZHiVnChpWW5Ncp0mBZpc88pyJZNhclEinGhkFiEAwfHZK2BCqKWBlarBKsDpVGkr0BixgtxDS1xCHsiCLZmFnEkgfGbA8JlEbWCqNNHQwBeV0pZJC4XK6wVKa3pJmqgKNSNOXhXJMPGUA9EkTTR+V6OxX6lilQzv9hg/06rhBcIEhVpCxTRboEVN7AYON4ToJ5SWiLCqEjx3b/bfGaJ0l5i8xAWjn+hFrrEgneGCcZGkiWQLJL3ZVYXJMFGTd+iIVpq4txwNYTqo4V2EMlZzOUvSZKr0gtntE7xli0oQ0DtF7GOyTsNjj8efIP4uHPRytSBSVanko1kZHD07GjwbPDsaEIlcLSomV48loiqUZHki8U5Nbiy34tGcFNgk63WaBORdp7iZkC+s6X5jKqtrdAemUtJ4cxwdHj50mejgnmQBps5zNGZaC7H6xWPc5OOu4I/Jox8neVUOJuXt0buK9Pd/7k/PB88GR+7P/4Q/pcGNimP7IfwN9NHh0bPu4LB7+KuLwefD578efvZ57/Dw8E9JmtwuxCbQk4JZp+jopvH3uip+hnfW+2AhPgq0jAuzjRCz4NpFzfMPxcVILdCWXM5gidLCUis5S6ESyAyC1StgM8YlCGZR/wfjBLVW+uNqehxn22mDS8El3sSkcPP88PBm0Cph8MPJgQmNrFgB3nJjzc8r7g/x8HHBBluCffZQsFeyYYIXrqxfqDnKn1em7eetf/6h+3IP5O6THWG3z72QBvNac7tKhld3yW2XVbzr74dX1+vrNCGPUdROVMo4jpktk2HS3+8uDOoGtXFkai2SYVJaW5lhv2+YLCbqthfzj2ATQ9mwzyrebwa9o2Sd7uOwqnoUPNbdx6IYy2Zczj6Fd71R0YjM6C21o6jWXqziv8dVbHKGO1Bpwsl9SmQFamcz8o7zTU92Gm3cmjEWoLb+fKiktBVlu+nYqhGbtL+T9WMi53KqnATh+E2FcsRn0jmY08B+i/sEIsz7P/+jBRvLsfwSOh1qgOnFrlG1zhFeqLx29JiwqCWzvEF4//3fYFJzYV1HW2CDgsLApGB1baiXmKwApUVdaW7Q9Dodor/97ow36BtqBiSrQIspVFoVdU6MdkPId0l0ZmuNUAlmqbSBLbWqZyUwMFzOBKZwfjq6mNaCpOnBCGWx6asdiy2RFBZMshmCxQXRQ8czy+cOhDKrsczWBrgEjUyA5QtMgckCWG3Vghpp18GjtFxj+wwIPsV8lQuvHCYELLktVW2hQVkoDULl8y6XPVJEt9ul/548gZdoLb06skxbLOj0tEG9gtDsw6I2NEpovfLvtnmDOLQlQrblpBl493SPZFk2lluXQ/gNUdgcfBlgxrLTef+Xv8LVN2pJ88IMJY0huPfg9dMYeYXKzcOQo9N+iaLqj7xQpn989sql2ANv/2+VBUOWXJaokZ6a4IzL38Illa8SodMJuQZQNlwrSartdOBp9qNzUXZAdCutrKKgbq3AplPMnaoFeXDBLNszxYnSCCesYhMuOGV0Or+HE2ZxpvQK7uEtjXXksjTaFQrux/K+2+26vwTa6byIXtfpwH0YJFMwKIsUfCuUgsZGzYNPFUh+v3HPbjT7xn0D5Yvor47yVzUXBWisDZuILWd24kKlsVsJlmMBS17M0JovHA+kGSURlKYoWLVjaXhihGLapfh0T7yMXmDo2IFuR1Wr10AFuGy4dWUTpjSCBqJn9UTwHHbZH5VMIzCo/GUMPcHl3IWPVJGq4MZCnG0izReaTS28VXpOL3mKrMEt7pTe0gkzUBCGcSqfcskE9w638K1SpBvXAo7iH3yecDEQmAnFEiZKzcnFZpotFszynAmxikS+VqJA7Wm80TMm6a0NZ1waGtPbNP1CkztOPVKk8RYnpVJzT+QccyQYSkddSkeADWUcqSyfhk7FgPdMDWopAWVRKS5tJHdpIkPnaDXHBoHluaqldRrJNRbcAlUSmhvIgve7oUGO//77vxv4FpeUd2LBoMsncGwty0uXBd86d4NRXdF+YyypmmSsvTdZcEjgBqRagvGAWICS3kitqtK4t9gceIBo2BZgc0DSBJ+Kh5S/TC+y+g3pfuStOQpe95rLuRnLEVrIxknJC7zx9r4JfnkjHEQypOqGcA9TJgxmxHJ29mZ0AX3HWOQzozAjMtFttt3bxLS9KyzE/rW3UeuJQEboMXSi8ZgYy+zl6QX0o4z9IS8yJ/zuOQVPBiWFxgRRgrEa2YL65cKFmcailgVtodp9kQGKTI0L1WDhSHY6lcYpF8LlzGg4jbbWRMcg4VoUK5hqtYgybwh2OlRz56SAdiUByAwPyyklTb3A1kJnzJil0kX3TCuLObnG2YuvNx5F92SnKRd4UwXgcZJFvcYESpsRqjMSlkq7111qRJnrVRWoml6k6xxwOJbBnt6xohoz+Nc/ITu7fKBxd7yFEK3ZH0a4m12wPT/Zu9h7z11Q8iWVZlE/b6ZTMmDrvZSztBKt/7pN5Y3yUM6DP+a4+4I6H/qApLT0vKW5iFtBnZ2rOtT6cV+Awnutq1PPhSwv2zBs7RuC71wJKrAuP4QylIGfqpx/sTzHijI2yRTCUSuBZOkpR1EAy7UyxnVaTgpKW1rVFk0PLkqNCATv/blNM0Nf0+l1qqJYsoZT1tyv5IGnDDpPC5yyWtgDVxNcMxa6VUq5NHlbV1M3bWrIcJ5Ow3FJdNo0bnz0x7gnRWkkKFBSrGL1C2Xb751j4ctYVWnVeHInTPrIpkIewfGWtBZqsucm1E732H2bWpieKAknqlrB05OTA2KOV5wy9Fgeu112Nk7yfKPtB/maCSVnrpSRPG4yJ8Nn42SyjUdpvc3fm0Ttsx95W9tdtFbs+0apNeYpzU7AikKjodxBWQ0LiveWRx1KJKNOeaJkNyfJtgskuAkMlMxx1wDctAYtevCaz3EjQ0rs73ADT02dl9RR+CjZRDwvsgPqCRpeBD141shemhfB7m1VapioMXWV3Gcp0qzgpFhqUwAXlV0B05qt4Gl2dZ0dfAFqwa2j4lVrFXBZog6Hu6T3etvjhnHhIvV001iHBnfrhGKCVkmX568/0NyOfO/tGolHNORtJ9jOdrsUPjq/t9inl3COswfIn9obZPutzB9RG65ckvolfMXy+ZLpwsAJjduWu9Z/RaCETM7htuEwiYDdPAAKP1pAM3Bu3Ax6g3byi/2X8SXRlsogNP5hn5BYaw9FZYsbmES9O6pSwUSjr5p5yeSMAoGar61CzSnxF3XuY8HxS6SVm/OZgFrSFypQtkS9pCZUKvLxXXVcGqS5OfRAY9mFq7Y1fYsTwy1u5r7lcvlA0wcO5+taCIjDjwu4T0yLHu0lt9/UEzjHShlulV5tsGbclvXE2XIbt/0lEIhDSrvN+ylTqiN5gXphQE1hhLrh+SfE71sC7x+MaT2zt1TaXbtonKKmvGN2ZmxW8TDPX0U+gNj7KXL4bwx+sUdbybB8YhX/3T4dt10kEd5Mg7xhw/ZxeZM0ETxHabbXXccvz15D86x3mKRbq7ofYcv+61cnp9+OTomZECa0Dusd9g7dFxdl7ILJrZd2v9Dub7juNuvc//L33LBWtHhr+5Vg3C1znWruwh72au8r73WalLSnHV4ld3eUEy61WK/p+LsaNS15r9OkYZpT8nAr3jSuJGlxO8dV2JujtN0Lep7ARe23m3ubbdqpeoxj1259FHZ7lUzNY5Imk/AleqEKwtFsSV+p2TIZJu5jtptM3XdkOrtLBJOzms3catTRpC0qq0kP2yvYuVvBhh9IqnglV1sc7u5mvRj0Lwn1QYS7O7/eXa9beH/1gxhBsRGazHe9Xq//DVCDXZI=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get your API credits","permalink":"/docs/API-docs/v1.1/getcredits"},"next":{"title":"Get Contact","permalink":"/docs/API-docs/v1.1/getcontact"}}');var o=n(74848),s=n(28453),r=n(57742),p=n.n(r),c=n(78178),l=n.n(c),i=n(19624),d=n.n(i),m=n(96226),u=n.n(m),g=(n(77675),n(19365),n(51107)),x=n(21312);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:"eJzVGdtuG8f1V07XQGERS1KUnRRlirSKrDhG3VgQpRqoKGiHu4fcMYczm5nZpQiJQB6KfkDRl772J/reT/GXFGcuy4scO0KKtAV8kWbOOXPut71LLJuZZHiVnChpWW5Ncp0mBZpc88pyJZNhclEinGhkFiEAwfHZK2BCqKWBlarBKsDpVGkr0BixgtxDS1xCHsiCLZmFnEkgfGbA8JlEbWCqNNHQwBeV0pZJC4XK6wVKa3pJmqgKNSNOXhXJMPGUA9EkTTR+V6OxX6lilQzv9hg/06rhBcIEhVpCxTRboEVN7AYON4ToJ5SWiLCqEjx3b/bfGaJ0l5i8xAWjn+hFrrEgneGCcZGkiWQLJL3ZVYXJMFGTd+iIVpq4txwNYTqo4V2EMlZzOUvSZKr0gtntE7xli0oQ0DtF7GOyTsNjj8efIP4uHPRytSBSVanko1kZHD07GjwbPDsaEIlcLSomV48loiqUZHki8U5Nbiy34tGcFNgk63WaBORdp7iZkC+s6X5jKqtrdAemUtJ4cxwdHj50mejgnmQBps5zNGZaC7H6xWPc5OOu4I/Jox8neVUOJuXt0buK9Pd/7k/PB88GR+7P/4Q/pcGNimP7IfwN9NHh0bPu4LB7+KuLwefD578efvZ57/Dw8E9JmtwuxCbQk4JZp+jopvH3uip+hnfW+2AhPgq0jAuzjRCz4NpFzfMPxcVILdCWXM5gidLCUis5S6ESyAyC1StgM8YlCGZR/wfjBLVW+uNqehxn22mDS8El3sSkcPP88PBm0Cph8MPJgQmNrFgB3nJjzc8r7g/x8HHBBluCffZQsFeyYYIXrqxfqDnKn1em7eetf/6h+3IP5O6THWG3z72QBvNac7tKhld3yW2XVbzr74dX1+vrNCGPUdROVMo4jpktk2HS3+8uDOoGtXFkai2SYVJaW5lhv2+YLCbqthfzj2ATQ9mwzyrebwa9o2Sd7uOwqnoUPNbdx6IYy2Zczj6Fd71R0YjM6C21o6jWXqziv8dVbHKGO1Bpwsl9SmQFamcz8o7zTU92Gm3cmjEWoLb+fKiktBVlu+nYqhGbtL+T9WMi53KqnATh+E2FcsRn0jmY08B+i/sEIsz7P/+jBRvLsfwSOh1qgOnFrlG1zhFeqLx29JiwqCWzvEF4//3fYFJzYV1HW2CDgsLApGB1baiXmKwApUVdaW7Q9Dodor/97ow36BtqBiSrQIspVFoVdU6MdkPId0l0ZmuNUAlmqbSBLbWqZyUwMFzOBKZwfjq6mNaCpOnBCGWx6asdiy2RFBZMshmCxQXRQ8czy+cOhDKrsczWBrgEjUyA5QtMgckCWG3Vghpp18GjtFxj+wwIPsV8lQuvHCYELLktVW2hQVkoDULl8y6XPVJEt9ul/548gZdoLb06skxbLOj0tEG9gtDsw6I2NEpovfLvtnmDOLQlQrblpBl493SPZFk2lluXQ/gNUdgcfBlgxrLTef+Xv8LVN2pJ88IMJY0huPfg9dMYeYXKzcOQo9N+iaLqj7xQpn989sql2ANv/2+VBUOWXJaokZ6a4IzL38Illa8SodMJuQZQNlwrSartdOBp9qNzUXZAdCutrKKgbq3AplPMnaoFeXDBLNszxYnSCCesYhMuOGV0Or+HE2ZxpvQK7uEtjXXksjTaFQrux/K+2+26vwTa6byIXtfpwH0YJFMwKIsUfCuUgsZGzYNPFUh+v3HPbjT7xn0D5Yvor47yVzUXBWisDZuILWd24kKlsVsJlmMBS17M0JovHA+kGSURlKYoWLVjaXhihGLapfh0T7yMXmDo2IFuR1Wr10AFuGy4dWUTpjSCBqJn9UTwHHbZH5VMIzCo/GUMPcHl3IWPVJGq4MZCnG0izReaTS28VXpOL3mKrMEt7pTe0gkzUBCGcSqfcskE9w638K1SpBvXAo7iH3yecDEQmAnFEiZKzcnFZpotFszynAmxikS+VqJA7Wm80TMm6a0NZ1waGtPbNP1CkztOPVKk8RYnpVJzT+QccyQYSkddSkeADWUcqSyfhk7FgPdMDWopAWVRKS5tJHdpIkPnaDXHBoHluaqldRrJNRbcAlUSmhvIgve7oUGO//77vxv4FpeUd2LBoMsncGwty0uXBd86d4NRXdF+YyypmmSsvTdZcEjgBqRagvGAWICS3kitqtK4t9gceIBo2BZgc0DSBJ+Kh5S/TC+y+g3pfuStOQpe95rLuRnLEVrIxknJC7zx9r4JfnkjHEQypOqGcA9TJgxmxHJ29mZ0AX3HWOQzozAjMtFttt3bxLS9KyzE/rW3UeuJQEboMXSi8ZgYy+zl6QX0o4z9IS8yJ/zuOQVPBiWFxgRRgrEa2YL65cKFmcailgVtodp9kQGKTI0L1WDhSHY6lcYpF8LlzGg4jbbWRMcg4VoUK5hqtYgybwh2OlRz56SAdiUByAwPyyklTb3A1kJnzJil0kX3TCuLObnG2YuvNx5F92SnKRd4UwXgcZJFvcYESpsRqjMSlkq7111qRJnrVRWoml6k6xxwOJbBnt6xohoz+Nc/ITu7fKBxd7yFEK3ZH0a4m12wPT/Zu9h7z11Q8iWVZlE/b6ZTMmDrvZSztBKt/7pN5Y3yUM6DP+a4+4I6H/qApLT0vKW5iFtBnZ2rOtT6cV+Awnutq1PPhSwv2zBs7RuC71wJKrAuP4QylIGfqpx/sTzHijI2yRTCUSuBZOkpR1EAy7UyxnVaTgpKW1rVFk0PLkqNCATv/blNM0Nf0+l1qqJYsoZT1tyv5IGnDDpPC5yyWtgDVxNcMxa6VUq5NHlbV1M3bWrIcJ5Ow3FJdNo0bnz0x7gnRWkkKFBSrGL1C2Xb751j4ctYVWnVeHInTPrIpkIewfGWtBZqsucm1E732H2bWpieKAknqlrB05OTA2KOV5wy9Fgeu112Nk7yfKPtB/maCSVnrpSRPG4yJ8Nn42SyjUdpvc3fm0Ttsx95W9tdtFbs+0apNeYpzU7AikKjodxBWQ0LiveWRx1KJKNOeaJkNyfJtgskuAkMlMxx1wDctAYtevCaz3EjQ0rs73ADT02dl9RR+CjZRDwvsgPqCRpeBD141shemhfB7m1VapioMXWV3Gcp0qzgpFhqUwAXlV0B05qt4Gl2dZ0dfAFqwa2j4lVrFXBZog6Hu6T3etvjhnHhIvV001iHBnfrhGKCVkmX568/0NyOfO/tGolHNORtJ9jOdrsUPjq/t9inl3COswfIn9obZPutzB9RG65ckvolfMXy+ZLpwsAJjduWu9Z/RaCETM7htuEwiYDdPAAKP1pAM3Bu3Ax6g3byi/2X8SXRlsogNP5hn5BYaw9FZYsbmES9O6pSwUSjr5p5yeSMAoGar61CzSnxF3XuY8HxS6SVm/OZgFrSFypQtkS9pCZUKvLxXXVcGqS5OfRAY9mFq7Y1fYsTwy1u5r7lcvlA0wcO5+taCIjDjwu4T0yLHu0lt9/UEzjHShlulV5tsGbclvXE2XIbt/0lEIhDSrvN+ylTqiN5gXphQE1hhLrh+SfE71sC7x+MaT2zt1TaXbtonKKmvGN2ZmxW8TDPX0U+gNj7KXL4bwx+sUdbybB8YhX/3T4dt10kEd5Mg7xhw/ZxeZM0ETxHabbXXccvz15D86x3mKRbq7ofYcv+61cnp9+OTomZECa0Dusd9g7dFxdl7ILJrZd2v9Dub7juNuvc//L33LBWtHhr+5Vg3C1znWruwh72au8r73WalLSnHV4ld3eUEy61WK/p+LsaNS15r9OkYZpT8nAr3jSuJGlxO8dV2JujtN0Lep7ARe23m3ubbdqpeoxj1259FHZ7lUzNY5Imk/AleqEKwtFsSV+p2TIZJu5jtptM3XdkOrtLBJOzms3catTRpC0qq0kP2yvYuVvBhh9IqnglV1sc7u5mvRj0Lwn1QYS7O7/eXa9beH/1gxhBsRGazHe9Xq//DVCDXZI=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-2",custom_edit_url:null},y=void 0,S={},V=[];function b(t){const e={p:"p",...(0,s.R)(),...t.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(g.default,{as:"h1",className:"openapi__heading",children:"Create Contact"}),"\n",(0,o.jsx)(p(),{method:"post",path:"/createcontact",context:"endpoint"}),"\n",(0,o.jsx)(e.p,{children:"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents."}),"\n",(0,o.jsx)(g.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,o.jsx)(x.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,o.jsx)(l(),{parameters:void 0}),"\n",(0,o.jsx)(d(),{...n(62464)}),"\n",(0,o.jsx)(u(),{...n(36906)})]})}function C(t={}){const{wrapper:e}={...(0,s.R)(),...t.components};return e?(0,o.jsx)(e,{...t,children:(0,o.jsx)(b,{...t})}):b(t)}},62464(t){t.exports=JSON.parse('{"title":"Body","body":{"description":"Provide below parameter to create contact","content":{"application/json":{"schema":{"required":["email","name"],"type":"object","properties":{"name":{"type":"string","format":"string","example":"joe bee"},"email":{"type":"string","format":"string","example":"joebee@example.com"},"phone":{"type":"string","format":"string","example":"1232131321"},"company":{"type":"string","format":"string","example":"opensign"},"job_title":{"type":"string","format":"string","example":"dev"}},"title":"createcontact_body"}}},"required":true}}')},36906(t){t.exports=JSON.parse('{"responses":{"200":{"description":"Contact created successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"ph1bhx2jp"},"name":{"type":"string","format":"string","example":"joe bee"},"email":{"type":"string","format":"string","example":"joebee@example.com"},"phone":{"type":"string","format":"string","example":"4131231231"},"company":{"type":"string","format":"string","example":"opensign"},"job_title":{"type":"string","format":"string","example":"dev"},"createdAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"xml":{"name":"contactdetails"},"title":"contact"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"401":{"description":"Contact already exists!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Contact already exists!"}},"title":"inline_response_401_1"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/18b84479.7a9128dc.js b/assets/js/18b84479.7a9128dc.js deleted file mode 100644 index dd4119354..000000000 --- a/assets/js/18b84479.7a9128dc.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[1706],{23342(e,t,n){n.r(t),n.d(t,{assets:()=>x,contentTitle:()=>f,default:()=>k,frontMatter:()=>P,metadata:()=>s,toc:()=>M});const s=JSON.parse('{"id":"API-docs/v1.1/deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","source":"@site/docs/API-docs/v1.1/deletedocument.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/deletedocument","permalink":"/docs/API-docs/v1.1/deletedocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","sidebar_label":"Delete Document","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V81u5DYSfpVaXjbTkLvbHieL1SnejDEx1sgYsQMD62kYlFiSGFMkQ1LdbjQE5JA3yCnXfbR5kkVRP622PZMMdjcXu1Ws36+KVcUdC7z0LL1jb0ze1KiDZ6uECfS5kzZIo1nKbiqEN6gwIIieC86uLoArZTYetqaBYMBhbdYI3mIuC5nvWQtnamJyI8nPWcKMRcfJwoVgKRNR/8DAEma54zUGdOTdjmleI7H1DPdSsIRJ8s7yULGnLl85s5YCwWQ/Yh4uBJhi71Aw0JljCXP4UyMdCpYG12DCfNgqMuRlbRUx4KNVRiBLC648MeQV1pylOxa2NnIGJ3XJElYYV/MwpeAjj1pSZquTrDrhXrC2XZFVb4326EnPyXJJ/w4DGNLReyrAN3mO3heNUtu/sITlRgdCKt0xbq2SecRy8aMn8d1zNzskCFhHyAfZGR8Aeimgvfv/eCTn7bf2NWuTIVdn4dNCJ8uT10fHy6Pl326Ov0pP/55++dV8uVz+iyXssVYkOySVByS9QQa1/26fsXU5mzL2lJaYT1+C8drUGCqpS9gQmBtndJmAVcg9QnBb4CWXGhQP6P6HqKJzxn0anc/zrJ1ELbWSGu+HGro/XS7vj0cQTj9RS9oEKEyjxZ8b6kv2Px3Q6f3rMaAvnwd0oddcSRGb0I15QP3nxjM1Hzrzz6tVdkzxnB0EO6V3QXrMGyfDNna6xyNu5VF3nt6tqF1QpZh9l4zdMVQsZYuhpy12k87YMlLp1kPvbJxiKatCsD5dLDzXIjOPc2NRe1lqxTM/z0294FYu1sfzY9YmT2W4tZ/Fj83R54r4wEupy9+TW+3RuqaMdkk7wGxMHbfyn7hlyZCSKVc/PCrkAl1Mn9SFicJ9ot5Z1Ney1DHN0fjTIXOLKjc10jwJFcJsNoh8+OXfo9RsNg6eWJDz9/q9ftc4sGaDrmgUcC2gUPgoM4VRDOt4Nk5Wj7xW6L3agtQBS8dpEstSBq6AcKIuknPLM6kk1TGxmW7kTq6Cn8NthaFCR0d/dQgcBK5RUfkDb4KpeSBV46DcGPdQ0IxPgEPWeKnRe0BdcZ0T45CJBIwDrgF1QGed9Ag+OPJadr4ZHRzPA9Rc8xJJdwJTsAQqSeUKzmSND+CNaqLLELhUxqGAISCNKHwE8Zwms0Mgam5q67CislkjlI0U6BPIjUDw8dpSCFpAhj6AJV9kjp6UNlqZ/CEmkGYrWENdRHJFK8PURxIPjmtPc77fZ/ocjIBZZ2hIY+fgbPaDR8rwpdQPPp3N3usjuBvr6hYzLwOuvhiuwGazeVb6rw5l3srwbZPB92iNl8G47V66lKFqsnhdpkrGj07TW9QY62dyGfY6hMn989tH1EWFyi6uMVCF+MXZ1UVsvK/gw8+/wiVyp6Eym65a88ah2kI5mCLkusx3sI19EwoTC68ixPOu+GghQx8GBG8rHj78/JuH73ADUvdXikKZza6aTMkcbrC2NCb9bJbCNw7JZBhoECoeIOcaMgRfcSqlteTAwXbSSuqHOZzpLTQeHWxkqGIxED3KHYRBuOzXWMi4RwFGR4nB5nzvEdFrj2qNnnTR/MsQUEja6ELlTFN21qbO9ME5LKRScCtFiSHGdiYE2J686chxl927gwVdiFDhFrhD8KjDHK6eiMSTxlrjyAvZOV8YWuYpAaiFNVIHn4JwvAh7/cm+0HOCWRr9AqmDkI9wJL2aMSXdTewjHqnz99SUnzTyw37rsMD4iIhh7/NiZV9Od0NZAlXrf1PWNLGpa/E8LhRYc6m6ifL1Uz1xuKOr/bviGt1a5thPtY/c6EVkXrCEKZmj9jhZGs7eXl3C+vV8yZLJePwDl3txefHN+XfX5+QMNdIOsOP5cr4kkjU+1FxPLPXvuTf7B9cB1rv9OvV/ev71MzrgY1hYxWVckmLMu367uWOT52A6ffmtElYZH4hlt6M7+INTbUvknxp0tEatErbmTvKMRvndjgnp6bcYn3EfjfaL7/sX4Sv4w4/IF2MZlhBNG8iaq4a+WMIecPvkIduu2mTYRMjZjuMsz9GGieyzrfZgNXxzfnl+c84SRv30cAl6iEtQ/4MMvOja4XbU+UB/aVV7UWC36xasth35u6OPSvQxDtyE06pt2/8AT6PPnQ==","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Revoke Document","permalink":"/docs/API-docs/v1.1/revokedocument"},"next":{"title":"Get Document list from status","permalink":"/docs/API-docs/v1.1/getdocumentlist"}}');var d=n(74848),o=n(28453),i=n(57742),c=n.n(i),a=n(78178),r=n.n(a),l=n(19624),u=n.n(l),p=n(96226),m=n.n(p),h=(n(77675),n(19365),n(51107)),j=n(21312);const P={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:"eJy9V81u5DYSfpVaXjbTkLvbHieL1SnejDEx1sgYsQMD62kYlFiSGFMkQ1LdbjQE5JA3yCnXfbR5kkVRP622PZMMdjcXu1Ws36+KVcUdC7z0LL1jb0ze1KiDZ6uECfS5kzZIo1nKbiqEN6gwIIieC86uLoArZTYetqaBYMBhbdYI3mIuC5nvWQtnamJyI8nPWcKMRcfJwoVgKRNR/8DAEma54zUGdOTdjmleI7H1DPdSsIRJ8s7yULGnLl85s5YCwWQ/Yh4uBJhi71Aw0JljCXP4UyMdCpYG12DCfNgqMuRlbRUx4KNVRiBLC648MeQV1pylOxa2NnIGJ3XJElYYV/MwpeAjj1pSZquTrDrhXrC2XZFVb4326EnPyXJJ/w4DGNLReyrAN3mO3heNUtu/sITlRgdCKt0xbq2SecRy8aMn8d1zNzskCFhHyAfZGR8Aeimgvfv/eCTn7bf2NWuTIVdn4dNCJ8uT10fHy6Pl326Ov0pP/55++dV8uVz+iyXssVYkOySVByS9QQa1/26fsXU5mzL2lJaYT1+C8drUGCqpS9gQmBtndJmAVcg9QnBb4CWXGhQP6P6HqKJzxn0anc/zrJ1ELbWSGu+HGro/XS7vj0cQTj9RS9oEKEyjxZ8b6kv2Px3Q6f3rMaAvnwd0oddcSRGb0I15QP3nxjM1Hzrzz6tVdkzxnB0EO6V3QXrMGyfDNna6xyNu5VF3nt6tqF1QpZh9l4zdMVQsZYuhpy12k87YMlLp1kPvbJxiKatCsD5dLDzXIjOPc2NRe1lqxTM/z0294FYu1sfzY9YmT2W4tZ/Fj83R54r4wEupy9+TW+3RuqaMdkk7wGxMHbfyn7hlyZCSKVc/PCrkAl1Mn9SFicJ9ot5Z1Ney1DHN0fjTIXOLKjc10jwJFcJsNoh8+OXfo9RsNg6eWJDz9/q9ftc4sGaDrmgUcC2gUPgoM4VRDOt4Nk5Wj7xW6L3agtQBS8dpEstSBq6AcKIuknPLM6kk1TGxmW7kTq6Cn8NthaFCR0d/dQgcBK5RUfkDb4KpeSBV46DcGPdQ0IxPgEPWeKnRe0BdcZ0T45CJBIwDrgF1QGed9Ag+OPJadr4ZHRzPA9Rc8xJJdwJTsAQqSeUKzmSND+CNaqLLELhUxqGAISCNKHwE8Zwms0Mgam5q67CislkjlI0U6BPIjUDw8dpSCFpAhj6AJV9kjp6UNlqZ/CEmkGYrWENdRHJFK8PURxIPjmtPc77fZ/ocjIBZZ2hIY+fgbPaDR8rwpdQPPp3N3usjuBvr6hYzLwOuvhiuwGazeVb6rw5l3srwbZPB92iNl8G47V66lKFqsnhdpkrGj07TW9QY62dyGfY6hMn989tH1EWFyi6uMVCF+MXZ1UVsvK/gw8+/wiVyp6Eym65a88ah2kI5mCLkusx3sI19EwoTC68ixPOu+GghQx8GBG8rHj78/JuH73ADUvdXikKZza6aTMkcbrC2NCb9bJbCNw7JZBhoECoeIOcaMgRfcSqlteTAwXbSSuqHOZzpLTQeHWxkqGIxED3KHYRBuOzXWMi4RwFGR4nB5nzvEdFrj2qNnnTR/MsQUEja6ELlTFN21qbO9ME5LKRScCtFiSHGdiYE2J686chxl927gwVdiFDhFrhD8KjDHK6eiMSTxlrjyAvZOV8YWuYpAaiFNVIHn4JwvAh7/cm+0HOCWRr9AqmDkI9wJL2aMSXdTewjHqnz99SUnzTyw37rsMD4iIhh7/NiZV9Od0NZAlXrf1PWNLGpa/E8LhRYc6m6ifL1Uz1xuKOr/bviGt1a5thPtY/c6EVkXrCEKZmj9jhZGs7eXl3C+vV8yZLJePwDl3txefHN+XfX5+QMNdIOsOP5cr4kkjU+1FxPLPXvuTf7B9cB1rv9OvV/ev71MzrgY1hYxWVckmLMu367uWOT52A6ffmtElYZH4hlt6M7+INTbUvknxp0tEatErbmTvKMRvndjgnp6bcYn3EfjfaL7/sX4Sv4w4/IF2MZlhBNG8iaq4a+WMIecPvkIduu2mTYRMjZjuMsz9GGieyzrfZgNXxzfnl+c84SRv30cAl6iEtQ/4MMvOja4XbU+UB/aVV7UWC36xasth35u6OPSvQxDtyE06pt2/8AT6PPnQ==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},f=void 0,x={},M=[];function I(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,d.jsxs)(d.Fragment,{children:[(0,d.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Delete Document"}),"\n",(0,d.jsx)(c(),{method:"delete",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,d.jsx)(t.p,{children:"The Delete document API allows you to remove specific document from your documents."}),"\n",(0,d.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,d.jsx)(j.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,d.jsx)(r(),{...n(58788)}),"\n",(0,d.jsx)(u(),{...n(77902)}),"\n",(0,d.jsx)(m(),{...n(61668)})]})}function k(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,d.jsx)(t,{...e,children:(0,d.jsx)(I,{...e})}):I(e)}},58788(e){e.exports=JSON.parse('{"parameters":[{"name":"document_id","in":"path","description":"Provide objectId of document to delete","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"ph2bh2asd"}}]}')},77902(e){e.exports={title:"Body"}},61668(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Document deleted successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","example":"Bxh2aspHp3"},"deletedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"xml":{"name":"delete"},"title":"delete"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"Document not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Document not found!"}},"title":"inline_response_404_3"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/18b84479.d06fc684.js b/assets/js/18b84479.d06fc684.js new file mode 100644 index 000000000..ad3f256e6 --- /dev/null +++ b/assets/js/18b84479.d06fc684.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[1706],{23342(e,t,o){o.r(t),o.d(t,{assets:()=>x,contentTitle:()=>H,default:()=>X,frontMatter:()=>h,metadata:()=>n,toc:()=>b});const n=JSON.parse('{"id":"API-docs/v1.1/deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","source":"@site/docs/API-docs/v1.1/deletedocument.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/deletedocument","permalink":"/docs/API-docs/v1.1/deletedocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","sidebar_label":"Delete Document","hide_title":true,"hide_table_of_contents":true,"api":"eJy9Gdtu47j1V045QJEYsp3MzG5Rb7FtNslc0OlOECcdoHEQ0dKxxTVFaklKjpEY2IeiH1D0pa/9ib73U+ZLikNKsuxkMzvYdh9mkpCH537XHXN8btnoip3opMxROcuuI5aiTYwonNCKjdhFhnCCEh1CWkPB0dlb4FLqpYWVLsFpMJjrCsEWmIiZSDagM6NzAjLtkR2wiOkCDScKb1M2YqnH3wCwiBXc8BwdGuLujimeI4HVADciZRETxF3BXcZ2WT4zuhIpgp5+h4l7m4KebRhyGgI5FjGD35fCYMpGzpQYMetWkghZkReSAPC2kDpFNppxaQkgyTDnbHTH3KrwkM4INWcRm2mTc9c9wVvusYxYkT2fZs+5Tdl6fU1UbaGVRUt4nh8c0I9tARpz1JymYMskQWtnpZSrX7GIJVo50tTojvGikCLxuhx+Z+n53UM2gyZIsYY070Qg3ijoMYE27H9zS8wXb4oXbB01tjpyTz96fvD8Rf/woH/wm4vDL0cvfzv64svBwcHBX1jEbnNJbxujcoeE1wknN3+vH4AFm3UB65M1Ab98TI1jnaPLhJrDkpS5NFrNIygkcovgzAr4nAsFkjs0/0OtojHaPK2dz+Ns3ZFaKCkU3jQ+dPPy4ODmsFXCyyd8SWkHM12q9JcV9TH6Twv08uZFK9AXDwV6qyouReqT0IVeoPpl5emSd4H8Q28VAcjfsy1hu+dBSItJaYRb+Ux32+eF6If70dU1pQvyFL3Jkj47uoyN2LDJacO7TmZcM0JpqiZ3lkayEcucK+xoOLRcpVN9O9AFKivmSvKpHSQ6H/JCDKvDwXO2jnbf8KL4LHgs+5/7xDo+F2r+qXfXG22NyaLBaFs6a03HC/FHXLGoMUkXqi4eGfIUjTefUDPtH9eGel+gGou58mb2xHeLzDNoYD7+9V8t2ERN1NfQ61HVJEH6VpcmQaAo8Pi4dGgUd6JC+PjDP2BaCklxYSDFCiU5o43AmdJS3p+uAJVDUxhh0Q56PcLfpTsXFYYizCHR5KIOIyiMTsuEGO0b5OkKsE8a5a40CIXkjqoVuMzocp4BByvUXGIE56fji1kpSZoBjFGlm6LtWWyRRJBzxecIDnPCh55nniw8COU167grLQgFBrkEJ3KMgKsUeOl0zh2GpgCVE6bTWUgxw2SVyKAcLiUshct06aBClWoDUieLvlADUkS/36cfz57Ba3SOqI4dNw5TOj2t0KyAKjxaB3lpHSTcmFWg20YvcegyhLjjHzEEz/BE4jieqM7lCH5HGDYHX9cwE9Xrffzb3+HqjV5SlzFHRT0O7hC83mucPtWJfejtdDrMUBbDcRDKDo/O3vpEtx/s/612YMmSywwNEqkpzoX6PVxS8cgQer06zAFVJYxWpNpeD/bin5wG4n3CWxjtNMVTawU+m2HiVS3Jg1Pu+I4pjrVBOOYFnwopKK/S+T0cc4dzbVZwDx8y7rzLJlxBquF+ou77/b7/R6C9XtuO9npwD8cGOXm1RZVGUBap/8tgpRe1T4XMuHHPfmP2jfvWmC8af/WYvymFTMFgaflUdpzZiwuFwX4heYIpLEU6R2e/8jyQZrRC0IaiYOXJomlJjFHO+hSfnsTrxgssHXvQblS1eq2xgFCVcL54wUzqZYP0rJxKkcA2++OMGwQORbhsQk8KtfDho3SDVQrroOl2G5wnhs8cfNBmQZQCRl5hhzttOjrhFlJ6Yb3KZ0JxKYLD5aFRafAea+V4UhvvTyFP+BiomUnCPUy1XpCLzQ3Pc+5EwqVcNUheaZmiCTjemzlXRGvDmVCWOvw2TZ8YcsdZeNTg+IDTTOtFQHKOCRIMpaM+pSPAqm5LaGLxKrcQPNOAXipAlRZaKNegu7QNQ+fojMAKgSeJLpXzGkkMpsIBVRIaBciC99uhQY7/8Yd/WvgWl5R3moJBl8/gyDmeZD4LfvDuBuOyKLRxE0XVJObtvY1rhwRhQekl2ACIKWgVjNSqKiK+eGd4i2qAxrAtwOaApKl9qjmk/GUHDatvSPfjYM1x7XXvhFrYiRqjg3jCMpHiTbD3Te2XN9JDsBFVN4R78DNVTCzHZ+/HFzD0jDV8xhRmhKZxm6572yZtbwsLTRc52Kj1WCKn503oNMbjcqLi16cXMGxkHI5EGnvht88peGLIKDSmiAqsM8hz6lpTH2YG01KlXDnYjK1AkRmG4tSj7PUKgzMhpc+ZjeEMutIQHov01qFchYm5lnmDsNejmrsgBbTzIyC3Ag0pKtHKljm2Fjrj1i61SftnRjtMyDXOTl5tPIruyU4zIfGmqIEnLG702iTQqU5XVGcULLXx1H1qRJWYVVFjtYMGr3fA0UTV9gyO1agxhv/8G+Kzywca98edB21bO2rgbrbBdvxk52KHnr+g5EsqjRv9vJ/NyICt91LOMlq2/uu3Gzc6QHkPfspxdwX1PvSIpE4DbRREIpykzs5XHWr9RChANb3W1annQp5kbRi29q2D71xLKrA+P9RlKK7XHt6/eJJgQRmbZKrD0WiJZOmZQJkCT4y21ndaXgpKW0aXDu0ALjKDCAQf/LlNM6NQ04k6VVHMeCUoa+5W8pqnGHp7Kc54Kd2+rwm+Gau7VUq5NPc6X1M3bWqd4QKeSuCS8LRp3Ibob7dM2lBDIHAJWslVU/3qsh12VU3hi3lRGF0FdMdchcimQt6A4y1pra7JgZu6dnpi921q4WaqFRzrYgV7x8f7xJwoBGXoiToChUtSe5JstP0gX3Op1dyXMpIHb4X1zVU8YdPuO0rrbf7eJOqQ/cjb2u6iteIwNEqtMU9zLiTwNDVoKXdQVsOU4r3l0dQlklOnPNWqn5Bk3QIJ6LFoleC2AYRtDZoO4J1Y4EaGiNjf4gb2bJlk1FGEKNlEvEjjfeoJKpHWegiskb2MSGu7t1Wp4rLEyFfykKVIs1KQYqlNAcwLtwJuDF/BXnx1He9/BToXzmMJqnUahMrQ1IfbqHd626OKC+kj9XTTWNcNbueEYoIWOZfn7x5pbseh9/aNxGc05G0n2M522xieHJ3b16eXcI7zB48/NbLHu63Mn9FYoX2S+jV8w5PFkpvUwrHOC+6Eb/1XBEqPyTn85hKmDWA/qQFlGC2gOvRuXB0ODtvJr+m/bCiJLtMWoQqEQ0LirT00lS1hYdro3WNVGqYGQ9VMMq7mFAjUfHUKtaDEn5ZJiAXPL6HWfs7nEkol0VrQLkOzpCZUafLxbXVcWqS5ue6BJqoPV21r+gGnVjjczH3L5fKBpvf9m1ellNAMPz7gPjEthmevhXtTTuEcC22F02a1eTUXLiun3pbdt+0fNYJmSGl3aj9nSvUoL9DklhbvYzSVSD4h/tAR+HB/QruZnX3O9trF4Az9twS7NWPzQtTz/FXDBxB7P0cOWtzVs4rfDVLqC4ulP+zi8Ts+EuH9rJa3Xm49LS+LmBQJKoud3eHR67N3UL0YHLCosyX7CbYcvnt7fPrt+JSYqcOEjdjh4GBwQEeFti7nqkOp/qxzsvnusqXru81W9f/0Fahe1Tm8dcNCcuF3pV7mu3rJecU6X4VG3Q9A1xHLtHUEcndHYX9p5HpNx9+XaGibeh2xihtB+cFvQusuK22/5vyotHvn9ai8Dz/5W9KjsjS7SEWLSF9R2IixiC1wtfM9a329jpqFJDEbII58/9Z5+2C5vbUhPjl9d3pxyiLGS1Jedxe68LvQ+hci8Chr20vSwAP9TxvbRx/c3YU963rdwoerH31Ry9hAk56u1+v1fwFxDx5F","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Revoke Document","permalink":"/docs/API-docs/v1.1/revokedocument"},"next":{"title":"Get Document list from status","permalink":"/docs/API-docs/v1.1/getdocumentlist"}}');var c=o(74848),i=o(28453),p=o(57742),s=o.n(p),l=o(78178),a=o.n(l),r=o(19624),d=o.n(r),m=o(96226),u=o.n(m),j=(o(77675),o(19365),o(51107)),D=o(21312);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:"eJy9Gdtu47j1V045QJEYsp3MzG5Rb7FtNslc0OlOECcdoHEQ0dKxxTVFaklKjpEY2IeiH1D0pa/9ib73U+ZLikNKsuxkMzvYdh9mkpCH537XHXN8btnoip3opMxROcuuI5aiTYwonNCKjdhFhnCCEh1CWkPB0dlb4FLqpYWVLsFpMJjrCsEWmIiZSDagM6NzAjLtkR2wiOkCDScKb1M2YqnH3wCwiBXc8BwdGuLujimeI4HVADciZRETxF3BXcZ2WT4zuhIpgp5+h4l7m4KebRhyGgI5FjGD35fCYMpGzpQYMetWkghZkReSAPC2kDpFNppxaQkgyTDnbHTH3KrwkM4INWcRm2mTc9c9wVvusYxYkT2fZs+5Tdl6fU1UbaGVRUt4nh8c0I9tARpz1JymYMskQWtnpZSrX7GIJVo50tTojvGikCLxuhx+Z+n53UM2gyZIsYY070Qg3ijoMYE27H9zS8wXb4oXbB01tjpyTz96fvD8Rf/woH/wm4vDL0cvfzv64svBwcHBX1jEbnNJbxujcoeE1wknN3+vH4AFm3UB65M1Ab98TI1jnaPLhJrDkpS5NFrNIygkcovgzAr4nAsFkjs0/0OtojHaPK2dz+Ns3ZFaKCkU3jQ+dPPy4ODmsFXCyyd8SWkHM12q9JcV9TH6Twv08uZFK9AXDwV6qyouReqT0IVeoPpl5emSd4H8Q28VAcjfsy1hu+dBSItJaYRb+Ux32+eF6If70dU1pQvyFL3Jkj47uoyN2LDJacO7TmZcM0JpqiZ3lkayEcucK+xoOLRcpVN9O9AFKivmSvKpHSQ6H/JCDKvDwXO2jnbf8KL4LHgs+5/7xDo+F2r+qXfXG22NyaLBaFs6a03HC/FHXLGoMUkXqi4eGfIUjTefUDPtH9eGel+gGou58mb2xHeLzDNoYD7+9V8t2ERN1NfQ61HVJEH6VpcmQaAo8Pi4dGgUd6JC+PjDP2BaCklxYSDFCiU5o43AmdJS3p+uAJVDUxhh0Q56PcLfpTsXFYYizCHR5KIOIyiMTsuEGO0b5OkKsE8a5a40CIXkjqoVuMzocp4BByvUXGIE56fji1kpSZoBjFGlm6LtWWyRRJBzxecIDnPCh55nniw8COU167grLQgFBrkEJ3KMgKsUeOl0zh2GpgCVE6bTWUgxw2SVyKAcLiUshct06aBClWoDUieLvlADUkS/36cfz57Ba3SOqI4dNw5TOj2t0KyAKjxaB3lpHSTcmFWg20YvcegyhLjjHzEEz/BE4jieqM7lCH5HGDYHX9cwE9Xrffzb3+HqjV5SlzFHRT0O7hC83mucPtWJfejtdDrMUBbDcRDKDo/O3vpEtx/s/612YMmSywwNEqkpzoX6PVxS8cgQer06zAFVJYxWpNpeD/bin5wG4n3CWxjtNMVTawU+m2HiVS3Jg1Pu+I4pjrVBOOYFnwopKK/S+T0cc4dzbVZwDx8y7rzLJlxBquF+ou77/b7/R6C9XtuO9npwD8cGOXm1RZVGUBap/8tgpRe1T4XMuHHPfmP2jfvWmC8af/WYvymFTMFgaflUdpzZiwuFwX4heYIpLEU6R2e/8jyQZrRC0IaiYOXJomlJjFHO+hSfnsTrxgssHXvQblS1eq2xgFCVcL54wUzqZYP0rJxKkcA2++OMGwQORbhsQk8KtfDho3SDVQrroOl2G5wnhs8cfNBmQZQCRl5hhzttOjrhFlJ6Yb3KZ0JxKYLD5aFRafAea+V4UhvvTyFP+BiomUnCPUy1XpCLzQ3Pc+5EwqVcNUheaZmiCTjemzlXRGvDmVCWOvw2TZ8YcsdZeNTg+IDTTOtFQHKOCRIMpaM+pSPAqm5LaGLxKrcQPNOAXipAlRZaKNegu7QNQ+fojMAKgSeJLpXzGkkMpsIBVRIaBciC99uhQY7/8Yd/WvgWl5R3moJBl8/gyDmeZD4LfvDuBuOyKLRxE0XVJObtvY1rhwRhQekl2ACIKWgVjNSqKiK+eGd4i2qAxrAtwOaApKl9qjmk/GUHDatvSPfjYM1x7XXvhFrYiRqjg3jCMpHiTbD3Te2XN9JDsBFVN4R78DNVTCzHZ+/HFzD0jDV8xhRmhKZxm6572yZtbwsLTRc52Kj1WCKn503oNMbjcqLi16cXMGxkHI5EGnvht88peGLIKDSmiAqsM8hz6lpTH2YG01KlXDnYjK1AkRmG4tSj7PUKgzMhpc+ZjeEMutIQHov01qFchYm5lnmDsNejmrsgBbTzIyC3Ag0pKtHKljm2Fjrj1i61SftnRjtMyDXOTl5tPIruyU4zIfGmqIEnLG702iTQqU5XVGcULLXx1H1qRJWYVVFjtYMGr3fA0UTV9gyO1agxhv/8G+Kzywca98edB21bO2rgbrbBdvxk52KHnr+g5EsqjRv9vJ/NyICt91LOMlq2/uu3Gzc6QHkPfspxdwX1PvSIpE4DbRREIpykzs5XHWr9RChANb3W1annQp5kbRi29q2D71xLKrA+P9RlKK7XHt6/eJJgQRmbZKrD0WiJZOmZQJkCT4y21ndaXgpKW0aXDu0ALjKDCAQf/LlNM6NQ04k6VVHMeCUoa+5W8pqnGHp7Kc54Kd2+rwm+Gau7VUq5NPc6X1M3bWqd4QKeSuCS8LRp3Ibob7dM2lBDIHAJWslVU/3qsh12VU3hi3lRGF0FdMdchcimQt6A4y1pra7JgZu6dnpi921q4WaqFRzrYgV7x8f7xJwoBGXoiToChUtSe5JstP0gX3Op1dyXMpIHb4X1zVU8YdPuO0rrbf7eJOqQ/cjb2u6iteIwNEqtMU9zLiTwNDVoKXdQVsOU4r3l0dQlklOnPNWqn5Bk3QIJ6LFoleC2AYRtDZoO4J1Y4EaGiNjf4gb2bJlk1FGEKNlEvEjjfeoJKpHWegiskb2MSGu7t1Wp4rLEyFfykKVIs1KQYqlNAcwLtwJuDF/BXnx1He9/BToXzmMJqnUahMrQ1IfbqHd626OKC+kj9XTTWNcNbueEYoIWOZfn7x5pbseh9/aNxGc05G0n2M522xieHJ3b16eXcI7zB48/NbLHu63Mn9FYoX2S+jV8w5PFkpvUwrHOC+6Eb/1XBEqPyTn85hKmDWA/qQFlGC2gOvRuXB0ODtvJr+m/bCiJLtMWoQqEQ0LirT00lS1hYdro3WNVGqYGQ9VMMq7mFAjUfHUKtaDEn5ZJiAXPL6HWfs7nEkol0VrQLkOzpCZUafLxbXVcWqS5ue6BJqoPV21r+gGnVjjczH3L5fKBpvf9m1ellNAMPz7gPjEthmevhXtTTuEcC22F02a1eTUXLiun3pbdt+0fNYJmSGl3aj9nSvUoL9DklhbvYzSVSD4h/tAR+HB/QruZnX3O9trF4Az9twS7NWPzQtTz/FXDBxB7P0cOWtzVs4rfDVLqC4ulP+zi8Ts+EuH9rJa3Xm49LS+LmBQJKoud3eHR67N3UL0YHLCosyX7CbYcvnt7fPrt+JSYqcOEjdjh4GBwQEeFti7nqkOp/qxzsvnusqXru81W9f/0Fahe1Tm8dcNCcuF3pV7mu3rJecU6X4VG3Q9A1xHLtHUEcndHYX9p5HpNx9+XaGibeh2xihtB+cFvQusuK22/5vyotHvn9ai8Dz/5W9KjsjS7SEWLSF9R2IixiC1wtfM9a329jpqFJDEbII58/9Z5+2C5vbUhPjl9d3pxyiLGS1Jedxe68LvQ+hci8Chr20vSwAP9TxvbRx/c3YU963rdwoerH31Ry9hAk56u1+v1fwFxDx5F",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-2",custom_edit_url:null},H=void 0,x={},b=[];function K(e){const t={p:"p",...(0,i.R)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(j.default,{as:"h1",className:"openapi__heading",children:"Delete Document"}),"\n",(0,c.jsx)(s(),{method:"delete",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,c.jsx)(t.p,{children:"The Delete document API allows you to remove specific document from your documents."}),"\n",(0,c.jsx)(j.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,c.jsx)(D.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,c.jsx)(a(),{...o(58788)}),"\n",(0,c.jsx)(d(),{...o(77902)}),"\n",(0,c.jsx)(u(),{...o(61668)})]})}function X(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,c.jsx)(t,{...e,children:(0,c.jsx)(K,{...e})}):K(e)}},58788(e){e.exports=JSON.parse('{"parameters":[{"name":"document_id","in":"path","description":"Provide objectId of document to delete","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"ph2bh2asd"}}]}')},77902(e){e.exports={title:"Body"}},61668(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Document deleted successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","example":"Bxh2aspHp3"},"deletedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"xml":{"name":"delete"},"title":"delete"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"Document not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Document not found!"}},"title":"inline_response_404_3"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/193ad4d3.6ae8adb0.js b/assets/js/193ad4d3.6ae8adb0.js new file mode 100644 index 000000000..b33ea12ad --- /dev/null +++ b/assets/js/193ad4d3.6ae8adb0.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[8626],{48744(t,e,o){o.r(e),o.d(e,{assets:()=>f,contentTitle:()=>N,default:()=>v,frontMatter:()=>V,metadata:()=>n,toc:()=>b});const n=JSON.parse('{"id":"API-docs/v1.1/update-contact","title":"Update Contact","description":"The Update Contact API enables you to modify and update the details of a specific Contact.","source":"@site/docs/API-docs/v1.1/update-contact.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/update-contact","permalink":"/docs/API-docs/v1.1/update-contact","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"update-contact","title":"Update Contact","description":"The Update Contact API enables you to modify and update the details of a specific Contact.","sidebar_label":"Update Contact","hide_title":true,"hide_table_of_contents":true,"api":"eJzFGdtuG7n1V04ZoIgFXeJsigLaYruO402Cpolh2c1DZFjUzJGGMYecJTlSBraAfSj6AUVf+tqf6Hs/JV9SHF5mJNmbbLrbFoiTmHN47nfeMMeXlo3fsWOtHM+cZZd9lqPNjKic0IqN2XmBcFHl3CFEIDg6fQmo+FyihUbX4DSUOheLBrjKoQ7ArkDI0XEhLegFcLAVZmIhsoRmyPpMV2g4EXqZszELN+Nn1mcVN7xEh4ZYvGGKl8jGLAvfr0TO+kwQixV3BdvnW8/fY+Ze5kQ8a1Ea/L4WBnM2dqbGPrOukYTUirKSyPoMP1RS58jGCy4tAWQFlpyNb5hrKg/pjFBL1mcLbUruupPN5jLgR+ue6ryhO7ssnRq9EnlQzUKgzIP61sIWpMMg/hCOVJM+61I4hzksjC79tYgf1kJKMFhyoaBWWcHVEnPSKImKyhFxXlVSZF69o/eWOLi5K05QEynbkDGcQEtfg64/LzQpjHvVjdl7jTBHZJs+I8bkf3B/jvhtPBhmuiRUVaHVF7Py5PCrw8f+D6HIdFlx1XwpEl2hsmKpCMV7Pb9ywskv5iTHFdts+uxDKTu9Jh+O8UEEIvIYA8nH5+RHmw0hMGgrrWwwz+NHj+66VwrPgCIHW2cZWruopWx+9cu5Rgqs+zTRyf20ePzCVqrMCpKuRGv58l7ldVc+xb/XYdKRUFIovEoauXr86NHV4ZOopyf3qeZUIrcIVQzAFZciDzEGZBH7C6oHjdHmS73k8/x9Sn4SOQn/5Mf9QmkHC12r/P8t7TmWlaQascXRp+V7cvXbVsLf3JXwpQoao8J0rq9R/S8k7OTZJu8C+bshLwKQ/852hN0+D0JazGojXOPL3ocBr8QgfB+/u6QqU6IrNFXMqg510hVszEYxa4xuuhK5YYTNrFINrY1kY1Y4V9nxaGS5yuf6wzBlOsnnlvLuiFditDocPmab/v4dXlVfBI/14EuvWMeXQi0/d++yU9SEjBnstaOu1mq8En/AhvWTNbahYhdRIM/ReMuRj5x1lfwkWbo1Zip1baW7r3i1tWu7HG1Vo67A7NSXUDKIqYX2EsTjNxWqiVgq72ZeA/stzwNIMB///I8WbKqm6hvo9aiRI4oDq2uTITzTWe3xcenQKO7ECuHjD3+DeS0kxaWBHFcoKRhsH5ypLWXleQOoHJrKCIt22OsR/m26S7GKfSEHklWiwz6ltrzOiNGBQZ43gAMSnbvaIFA2oIQBrjC6XhbULQq1lNiHs5PJ+aKWJM0QJqhyyHVWl6ic9Sy2SPpQcsWXCC5mF88zz649iFBLsI672oJQYJBLcKLEvu9Yee10Sfmo0bUh6YTBlgxIscCsyWRQDpcS1sIVunawQpVrA1Jn1wOhhqSIwWBA/zx4AM/ROaI6cdw4zOn0ZIWmaVu4srYOMm5ME+i22YM4pF5vtuWkMwju6YnMZrOp2vo4ht8Rhu7gmwgzVb3ex7/8Fd690GvqMJeoqN/GPYKXD1Pk5Tqzd0OOTkcFymo0CULZ0dHpS59oD4L9X2sHliy5LtAgkZrjUqjfw4UN7W6vF3MNoFoJoxWptteDh7OfnItmB4S3MtppCurWCnyxwMyrWpIH59zxPVMca4NwzCs+F1JQXqfzWzjmDpfaNHALbwvuvMtmXEGu4XaqbgeDgf8h0F7vWfK6Xg9u4dggJ6+2qPJ+bFj6YHClr6NP5Uh+37nnIJm9c9+IOVXDgPlpLWQOBmtL81XnzF5cqAwOKskzzGEt8iU6+7XngTSjFYI2FAWNJ4umJTFBuRhQfHoSz5MXWDr2oNtR1eo1YgGhVsL54gkLqdcJ6Wk9lyKDXfYnBTcIHKrwMYWeFOrah4/SCasU1kEaxxLOZ4YvHLzV5pooBYx8hVvcabOlE24hpxvWq3whFJciOFwJBGES3jTeeox/DHnCx0BkJhZMmGt9TS62NLwsuRMZl7JJSL7TMkcTcLwxS66IVseZUJZ6tzZNPzPkjotwKeF4i/NC6+uA5AwzJBhKRwNKR4AryjhKOxqUvcotBM80oNcKUOWVFsoldBc2MXSGzghcIfAs07VyXiOZwVw4oEpC3RhZ8HY3NMjxP/7wdwuvcU15JxUM+vgAjpzjWeGz4FvvbjCpq0obN1VUTWa8/W5n0SFBWFB6DTYAYg5aBSO1quoTX+R/3UEASIZtAboDkib6VDqk/GWHidUXpPtJsOYket0roa7tVE3QwWzKCpHjVbD3VfTLK+kh2JiqG8It+KF/RizPTt9MzmHkGUt8zijMCE1ym233tilt7woLqYsddmo9lsjpetsHR+NxOVWz5yfnMEoyjsYin3nhd88peGZQUGjMERVYZ5CX1DXnPswM5rXKuXLQ7VCAItNgqVeYe5S9XmVwQYsEypnJcAZdbQiPRbrrUDZh/RBl7hD2elRzr0kB7XAKyK1AQ4rKtLJ1ia2FTrm1a23ywanRDjNyjdNn33UeRd/JTgsh8aqKwFM2S3pNCZRmYqozCtbaeOo+NaLKTFNFrHaY8HoHHE9VtGdwrKTGGfzrnzA7vbijcX+8dSFZczROcFe7YHt+svdhj57/QMmXVDpL+nmzWJABW++lnGW0bP2XS6nXVzpAeQ/+lOPuC+p96B5JnQZaeYlMONnErR4l2VyEAhTpta5OPRfyrGjDsLVvDL4zLanA+vwQy9AMwmzl/YtnGVaUsUmmGI5GSyRLh4mXZ0Zb6zstLwWlLaNrh3YI54VBBIIP/tymmXGo6USdqigWfCUoa+5X8sjTDHoPc1zwWroDXxN8Mxa7VUq5NJA7X1O7NjVmuIBnJXBNeNo0bkP0p7gnRRkkKNBKNqn6xbIN3pqp8M14RaN/QHfMVYhsKuQJHD+Q1mJNDtzE2umJ3baphZu5VnCsqwYeHh8fEHOiEpShp+oIFK5J7VnWaftOvuZSq6VNe0r8IKxvrmZTNt++R2m9zd9dog7Zj7yt7S5aK47iajgZ84RmJ+B5btBS7qCshjnFe8ujiSWSU6c812qQkWTbBRL8BAZaZbhrAGFbg+ZDeCWusZOhT+zvcAMPbZ0V1FGEKOkiXuSzg7iZiXoIrJG9jMij3duqtOKyxr6v5CFLkWalIMVSmwJYVq4Bbgxv4OHs3eXs4Gu/5u22whSTQhVo4uEu6r3e9mjFhfSRetI11rHB3TqhmKAN08XZq3ua20novX0j8QUNedsJtrPdLoZPzu/t7ZMLOMPlncuf2xvM9luZP6GxQvsk9Wt4yrPrNTe5hWMat53wrX9DoHSZnMPvFWGeAAdZBJRhtIDVoXfj1eHwsJ38Uv9l00ZeW4RVIBwSEm/toalsCQvzpHePVWmYGwxVM6zt7dA3X1uFWlDiz+ssxILnl1BrP+dzCbWSaC1oV6BZUxOqNPn4rjouLNLcHHugqRrAu7Y1fYtzKxx2c996vb6j6QN/57taSkjDjw+4z0yL4dpz4V7UczjDSlvhtGm6W0vhinrubbl9t/0lIkhDSrvT+zlTqkd5jqb0b1ETNCuRfUb8kSPw0cGU1jN7S6XdtYvBBRrKO3ZnxuaViPP8u8QHEHs/R47wmhEes2g3GZdPvBLf7uPxO0YS4c0iyhs3bJ+Wl/WZFBkqu73uOnp++gpWXw0fsf7Wqu4n2HL06uXxyevJCTETw4SN2eHw0fCRf9vR1pVcbVHafWnc33DddEvd/+67ZNwaOvzgRpXkwm9sveQ3cdv6jnWPiuOtJ8nLPiu0dQRwc0Ohf2HkZkPH39doaKN72WcrbgSx6VeysdPK2yfHHxX54Vkclw/g/tfNe9lOG1BF609fQtiYsT67xmb3NXVzuemnLSgxFgCOA/nBOaHpENxZqdMaN9w48h3eJ2G3d9inF+esz+bxxbT0j6/M8DW91vJ14DWkPr/f9Wc3THK1rP2TEgsoaW/LazLN9tL32i99439IqHu1sbsNDlLQ3yTTvRdubsJCebNp4cOnH70R9ZqgyTSXm83m32H0Ivo=","sidebar_class_name":"put api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Contact","permalink":"/docs/API-docs/v1.1/getcontact"},"next":{"title":"Delete Contact","permalink":"/docs/API-docs/v1.1/deletecontact"}}');var a=o(74848),s=o(28453),i=o(57742),c=o.n(i),r=o(78178),p=o.n(r),d=o(19624),l=o.n(d),u=o(96226),h=o.n(u),m=(o(77675),o(19365),o(51107)),W=o(21312);const V={id:"update-contact",title:"Update Contact",description:"The Update Contact API enables you to modify and update the details of a specific Contact.",sidebar_label:"Update Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzFGdtuG7n1V04ZoIgFXeJsigLaYruO402Cpolh2c1DZFjUzJGGMYecJTlSBraAfSj6AUVf+tqf6Hs/JV9SHF5mJNmbbLrbFoiTmHN47nfeMMeXlo3fsWOtHM+cZZd9lqPNjKic0IqN2XmBcFHl3CFEIDg6fQmo+FyihUbX4DSUOheLBrjKoQ7ArkDI0XEhLegFcLAVZmIhsoRmyPpMV2g4EXqZszELN+Nn1mcVN7xEh4ZYvGGKl8jGLAvfr0TO+kwQixV3BdvnW8/fY+Ze5kQ8a1Ea/L4WBnM2dqbGPrOukYTUirKSyPoMP1RS58jGCy4tAWQFlpyNb5hrKg/pjFBL1mcLbUruupPN5jLgR+ue6ryhO7ssnRq9EnlQzUKgzIP61sIWpMMg/hCOVJM+61I4hzksjC79tYgf1kJKMFhyoaBWWcHVEnPSKImKyhFxXlVSZF69o/eWOLi5K05QEynbkDGcQEtfg64/LzQpjHvVjdl7jTBHZJs+I8bkf3B/jvhtPBhmuiRUVaHVF7Py5PCrw8f+D6HIdFlx1XwpEl2hsmKpCMV7Pb9ywskv5iTHFdts+uxDKTu9Jh+O8UEEIvIYA8nH5+RHmw0hMGgrrWwwz+NHj+66VwrPgCIHW2cZWruopWx+9cu5Rgqs+zTRyf20ePzCVqrMCpKuRGv58l7ldVc+xb/XYdKRUFIovEoauXr86NHV4ZOopyf3qeZUIrcIVQzAFZciDzEGZBH7C6oHjdHmS73k8/x9Sn4SOQn/5Mf9QmkHC12r/P8t7TmWlaQascXRp+V7cvXbVsLf3JXwpQoao8J0rq9R/S8k7OTZJu8C+bshLwKQ/852hN0+D0JazGojXOPL3ocBr8QgfB+/u6QqU6IrNFXMqg510hVszEYxa4xuuhK5YYTNrFINrY1kY1Y4V9nxaGS5yuf6wzBlOsnnlvLuiFditDocPmab/v4dXlVfBI/14EuvWMeXQi0/d++yU9SEjBnstaOu1mq8En/AhvWTNbahYhdRIM/ReMuRj5x1lfwkWbo1Zip1baW7r3i1tWu7HG1Vo67A7NSXUDKIqYX2EsTjNxWqiVgq72ZeA/stzwNIMB///I8WbKqm6hvo9aiRI4oDq2uTITzTWe3xcenQKO7ECuHjD3+DeS0kxaWBHFcoKRhsH5ypLWXleQOoHJrKCIt22OsR/m26S7GKfSEHklWiwz6ltrzOiNGBQZ43gAMSnbvaIFA2oIQBrjC6XhbULQq1lNiHs5PJ+aKWJM0QJqhyyHVWl6ic9Sy2SPpQcsWXCC5mF88zz649iFBLsI672oJQYJBLcKLEvu9Yee10Sfmo0bUh6YTBlgxIscCsyWRQDpcS1sIVunawQpVrA1Jn1wOhhqSIwWBA/zx4AM/ROaI6cdw4zOn0ZIWmaVu4srYOMm5ME+i22YM4pF5vtuWkMwju6YnMZrOp2vo4ht8Rhu7gmwgzVb3ex7/8Fd690GvqMJeoqN/GPYKXD1Pk5Tqzd0OOTkcFymo0CULZ0dHpS59oD4L9X2sHliy5LtAgkZrjUqjfw4UN7W6vF3MNoFoJoxWptteDh7OfnItmB4S3MtppCurWCnyxwMyrWpIH59zxPVMca4NwzCs+F1JQXqfzWzjmDpfaNHALbwvuvMtmXEGu4XaqbgeDgf8h0F7vWfK6Xg9u4dggJ6+2qPJ+bFj6YHClr6NP5Uh+37nnIJm9c9+IOVXDgPlpLWQOBmtL81XnzF5cqAwOKskzzGEt8iU6+7XngTSjFYI2FAWNJ4umJTFBuRhQfHoSz5MXWDr2oNtR1eo1YgGhVsL54gkLqdcJ6Wk9lyKDXfYnBTcIHKrwMYWeFOrah4/SCasU1kEaxxLOZ4YvHLzV5pooBYx8hVvcabOlE24hpxvWq3whFJciOFwJBGES3jTeeox/DHnCx0BkJhZMmGt9TS62NLwsuRMZl7JJSL7TMkcTcLwxS66IVseZUJZ6tzZNPzPkjotwKeF4i/NC6+uA5AwzJBhKRwNKR4AryjhKOxqUvcotBM80oNcKUOWVFsoldBc2MXSGzghcIfAs07VyXiOZwVw4oEpC3RhZ8HY3NMjxP/7wdwuvcU15JxUM+vgAjpzjWeGz4FvvbjCpq0obN1VUTWa8/W5n0SFBWFB6DTYAYg5aBSO1quoTX+R/3UEASIZtAboDkib6VDqk/GWHidUXpPtJsOYket0roa7tVE3QwWzKCpHjVbD3VfTLK+kh2JiqG8It+KF/RizPTt9MzmHkGUt8zijMCE1ym233tilt7woLqYsddmo9lsjpetsHR+NxOVWz5yfnMEoyjsYin3nhd88peGZQUGjMERVYZ5CX1DXnPswM5rXKuXLQ7VCAItNgqVeYe5S9XmVwQYsEypnJcAZdbQiPRbrrUDZh/RBl7hD2elRzr0kB7XAKyK1AQ4rKtLJ1ia2FTrm1a23ywanRDjNyjdNn33UeRd/JTgsh8aqKwFM2S3pNCZRmYqozCtbaeOo+NaLKTFNFrHaY8HoHHE9VtGdwrKTGGfzrnzA7vbijcX+8dSFZczROcFe7YHt+svdhj57/QMmXVDpL+nmzWJABW++lnGW0bP2XS6nXVzpAeQ/+lOPuC+p96B5JnQZaeYlMONnErR4l2VyEAhTpta5OPRfyrGjDsLVvDL4zLanA+vwQy9AMwmzl/YtnGVaUsUmmGI5GSyRLh4mXZ0Zb6zstLwWlLaNrh3YI54VBBIIP/tymmXGo6USdqigWfCUoa+5X8sjTDHoPc1zwWroDXxN8Mxa7VUq5NJA7X1O7NjVmuIBnJXBNeNo0bkP0p7gnRRkkKNBKNqn6xbIN3pqp8M14RaN/QHfMVYhsKuQJHD+Q1mJNDtzE2umJ3baphZu5VnCsqwYeHh8fEHOiEpShp+oIFK5J7VnWaftOvuZSq6VNe0r8IKxvrmZTNt++R2m9zd9dog7Zj7yt7S5aK47iajgZ84RmJ+B5btBS7qCshjnFe8ujiSWSU6c812qQkWTbBRL8BAZaZbhrAGFbg+ZDeCWusZOhT+zvcAMPbZ0V1FGEKOkiXuSzg7iZiXoIrJG9jMij3duqtOKyxr6v5CFLkWalIMVSmwJYVq4Bbgxv4OHs3eXs4Gu/5u22whSTQhVo4uEu6r3e9mjFhfSRetI11rHB3TqhmKAN08XZq3ua20novX0j8QUNedsJtrPdLoZPzu/t7ZMLOMPlncuf2xvM9luZP6GxQvsk9Wt4yrPrNTe5hWMat53wrX9DoHSZnMPvFWGeAAdZBJRhtIDVoXfj1eHwsJ38Uv9l00ZeW4RVIBwSEm/toalsCQvzpHePVWmYGwxVM6zt7dA3X1uFWlDiz+ssxILnl1BrP+dzCbWSaC1oV6BZUxOqNPn4rjouLNLcHHugqRrAu7Y1fYtzKxx2c996vb6j6QN/57taSkjDjw+4z0yL4dpz4V7UczjDSlvhtGm6W0vhinrubbl9t/0lIkhDSrvT+zlTqkd5jqb0b1ETNCuRfUb8kSPw0cGU1jN7S6XdtYvBBRrKO3ZnxuaViPP8u8QHEHs/R47wmhEes2g3GZdPvBLf7uPxO0YS4c0iyhs3bJ+Wl/WZFBkqu73uOnp++gpWXw0fsf7Wqu4n2HL06uXxyevJCTETw4SN2eHw0fCRf9vR1pVcbVHafWnc33DddEvd/+67ZNwaOvzgRpXkwm9sveQ3cdv6jnWPiuOtJ8nLPiu0dQRwc0Ohf2HkZkPH39doaKN72WcrbgSx6VeysdPK2yfHHxX54Vkclw/g/tfNe9lOG1BF609fQtiYsT67xmb3NXVzuemnLSgxFgCOA/nBOaHpENxZqdMaN9w48h3eJ2G3d9inF+esz+bxxbT0j6/M8DW91vJ14DWkPr/f9Wc3THK1rP2TEgsoaW/LazLN9tL32i99439IqHu1sbsNDlLQ3yTTvRdubsJCebNp4cOnH70R9ZqgyTSXm83m32H0Ivo=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-2",custom_edit_url:null},N=void 0,f={},b=[];function j(t){const e={p:"p",...(0,s.R)(),...t.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Update Contact"}),"\n",(0,a.jsx)(c(),{method:"put",path:"/contact/{contact_id}",context:"endpoint"}),"\n",(0,a.jsx)(e.p,{children:"The Update Contact API enables you to modify and update the details of a specific Contact."}),"\n",(0,a.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,a.jsx)(W.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,a.jsx)(p(),{...o(16386)}),"\n",(0,a.jsx)(l(),{...o(71400)}),"\n",(0,a.jsx)(h(),{...o(70338)})]})}function v(t={}){const{wrapper:e}={...(0,s.R)(),...t.components};return e?(0,a.jsx)(e,{...t,children:(0,a.jsx)(j,{...t})}):j(t)}},16386(t){t.exports=JSON.parse('{"parameters":[{"name":"contact_id","in":"path","description":"objectId of contact","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string"}}]}')},71400(t){t.exports=JSON.parse('{"title":"Body","body":{"description":"Provide the fields you wish to update. Any fields omitted from the request will remain unchanged.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","format":"string","example":"joe bee"},"email":{"type":"string","format":"string","example":"joebee@example.com"},"phone":{"type":"string","format":"string","example":"4131231231"},"company":{"type":"string","format":"string","example":"opensign"},"job_title":{"type":"string","format":"string","example":"dev"}},"xml":{"name":"contactdetails"},"title":"updatecontact_body"}}}}}')},70338(t){t.exports=JSON.parse('{"responses":{"200":{"description":"Contact updated successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","example":"Bh2Hspnmch"},"message":{"type":"string","example":"Contact updated successfully"}},"title":"inline_response_200_14"}}}},"400":{"description":"Please provide valid field names!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","format":"string","example":"Please provide valid field names!"}},"title":"inline_response_400"}}}},"404":{"description":"Contact not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","format":"string","example":"Template not found!"}},"title":"inline_response_404_7"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/193ad4d3.ba443a2d.js b/assets/js/193ad4d3.ba443a2d.js deleted file mode 100644 index 11d7b7086..000000000 --- a/assets/js/193ad4d3.ba443a2d.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[8626],{48744(e,t,a){a.r(t),a.d(t,{assets:()=>v,contentTitle:()=>y,default:()=>x,frontMatter:()=>h,metadata:()=>s,toc:()=>b});const s=JSON.parse('{"id":"API-docs/v1.1/update-contact","title":"Update Contact","description":"The Update Contact API enables you to modify and update the details of a specific Contact.","source":"@site/docs/API-docs/v1.1/update-contact.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/update-contact","permalink":"/docs/API-docs/v1.1/update-contact","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"update-contact","title":"Update Contact","description":"The Update Contact API enables you to modify and update the details of a specific Contact.","sidebar_label":"Update Contact","hide_title":true,"hide_table_of_contents":true,"api":"eJzFWM1uHLkRfpUKL1kPWjOSV0GAOa3WMLxCjLVgydBBHgjsZnU3LTbJJdkzGgwG2EPeIKdc99H8JIsi+28k2Y6STQIIglRkFau+qmJ9zR0LvPJsecNeGR14ETxbZUygL5y0QRrNluyqRvhgBQ8I3SY4uzgH1DxX6GFrWggGGiNkuQWuBbRpc6gRBAYulQdTAgdvsZClLHozc5YxY9FxOuhcsCVLmt0yy5jljjcY0JGLO6Z5g2zJirR+KwXLmCQXLQ81e+i3yT9hEc4FHV4MJh3+0kqHgi2DazFjPmwVGfWysQpZxvDeKiOQLUuuPG0oamw4W+5Y2Nq4MzipK5ax0riGh1Gy36+SffThRyO2pHPo0oUzaykSNKVEJRJ8G+lrwjCFP4czve2XTSNDQAGlM01U6+zDRioFDhsuNbS6qLmuUBCiFCrqQIdza5UsIryLT5482D0OJ8FEYDtKRpDoaTVh/e2gCTAeoVuyTwYhR2T7jJFj6t/QzxF/6ATzwjRkytZGP9uV05PvT17GHzJRmMZyvX2uEWNRe1lpMvHJ5LdBBvVsTwSu2X6fsftGjbj2Ndz1Bx3QGR+q26Fn+z1pOvTWaJ/y8vL4+HFd9X2ZCkiAb4sCvS9bpbZ/+uNqou+opyAYA/6xfvmTt7opagqrQe959SRqo8rX/I/g9eBIraTG2x6R25fHx7cnpx1Op09Bc6GQewTbdd6aKylScwGlwv+B8KBzxj23PL7t39fip5D74E+/XBfaBChNq8X/O9orbKyi4TDx6Ovxnd7+dYjwL48jPNcJMZpIV+YO9f8iwjGe6fEhHf+412XaFNfZQbBTeQrSY9E6GbZx3t0fcSuP0vryZkXjpcFQGxqVtk0DMtRsyRbdpbHYjbNxz8iaW/fDs3WKLVkdgvXLxcJzLXJzP++vOMVzTxfuglu5WJ/M6dp8qMOtfdZ+bI+eq+IDr6SuvqW3GoG6pGSmfB3ANWSNW/k33LKsz8Z0V0cfauQCXcwc1cj7cYS/7jM9JLOfccOIe2pqDUNrOocmY2icLAeDJc0Kcqo0MYJO/M6ivpSVjmUWEXjIda5RFaZBIhFEEmazXuXz338btGYzEKZoG9QhNsT8o/6o37UOrNmgK1sV2Vup8F7mChPJa+LawPI88kah92oLUgesHPWykJUMXAEFJHUFBbc8l0pSH9E2Q9oOJq3o53BdY6jR0dKfHQIHgWtU1H7A22AaHshU7y9sjLsrldn4DDjkrZcavQfUNdcFbezLIQPjgGtAHdBZJz2CD468lsk3o4OjK7HhmldItjOYgiVQSeoZcCZvfQBvVBtdBprUxqGAPiCNKHwE8TVxRodAUkqyw5ryu0aoWinQZ1AYgeBjhVAIWkBOLM6SL7JAH+mfVqa4S+SwVQqsoVtMckUMduojqQfHtaerNvnS52AAzDpDIxSTg7PZB4+U4bdS3/nlbPZRH8HNUFfXmHsZcPVd34ebzeZR/7041Hkjw09tDu/RGi+DcdtRu5KhbvPYs1Mjwz/J0hvUGOtn0pGjDWEK//gKIOmiRmUXlxioQvzi7OI8Xvwv4POv/4C3yJ2G2mxStRatQ7WFqj+KkEuZT7AN9zaUJhZeTYgXqfg6qt0jeF3z8PnXf3r4GTcgdddSFMpsdtHmShbQjzc/my3hlcP4GdTLINQ8QME15Ai+5lRKa8mBg03aSuq7RP5bjw42MtSxGEge9Q7CIFyGdHvIuUcBRkeN/sz56BHJG49qjZ5s0fzNEVBI4luhdqat0mlTZ7rgHJb0tXEtRYUhxnYmBNhOvEliAnziDpbUEKHGLXCH4FGHOVw8UIkrrbXGkRcyOV8apcyGEoBaWCN18EsQjpdhtJ+NhV4QzNLoJ0QJQj7AkXVmhpSkTuwiHqTzj3QvP5gmh/etwxIdHRjDHvNiZVdON31ZAlXrf1LW6fslfb4SKemmDrfyh4d2IrlA1/h35SW6tSywG61f6OhF3LxgGVOyQO2nc+7szcVbWH8/P2bZZEb/C829eHv+6vXPl6/JGbpIE2An8+P5cfyaMz40XE9OOnxbeDjadiOb++++RHR0IeB9WFjFZaRqMfJdR7Nu2PiMsJw8QqwyVhsfaMNuR334wan9nsS/tOiIyq0ytuZOkpuRiwnp6W8xPDJ8MeTv3nfvFS/g6feMJ93uqY8m3rPmqqX/WMbucHv4frJf7bOe/pBjacOrdPzRFZkZDTzi0sTfksZZUaANX907Ja8XH65YxvLujaSJzy3M8Q29z/BN8tVENCKxi7IdU1xXbfyWZMkkETa6sw/Z3l1ke90fFNSTaBzSwBQF/aaYnlTY7RKT3O+H/Wnpixodrv1uSs1qv9//DlAr0Ws=","sidebar_class_name":"put api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Contact","permalink":"/docs/API-docs/v1.1/getcontact"},"next":{"title":"Delete Contact","permalink":"/docs/API-docs/v1.1/deletecontact"}}');var i=a(74848),o=a(28453),n=a(57742),c=a.n(n),d=a(78178),p=a.n(d),r=a(19624),l=a.n(r),u=a(96226),f=a.n(u),m=(a(77675),a(19365),a(51107)),j=a(21312);const h={id:"update-contact",title:"Update Contact",description:"The Update Contact API enables you to modify and update the details of a specific Contact.",sidebar_label:"Update Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzFWM1uHLkRfpUKL1kPWjOSV0GAOa3WMLxCjLVgydBBHgjsZnU3LTbJJdkzGgwG2EPeIKdc99H8JIsi+28k2Y6STQIIglRkFau+qmJ9zR0LvPJsecNeGR14ETxbZUygL5y0QRrNluyqRvhgBQ8I3SY4uzgH1DxX6GFrWggGGiNkuQWuBbRpc6gRBAYulQdTAgdvsZClLHozc5YxY9FxOuhcsCVLmt0yy5jljjcY0JGLO6Z5g2zJirR+KwXLmCQXLQ81e+i3yT9hEc4FHV4MJh3+0kqHgi2DazFjPmwVGfWysQpZxvDeKiOQLUuuPG0oamw4W+5Y2Nq4MzipK5ax0riGh1Gy36+SffThRyO2pHPo0oUzaykSNKVEJRJ8G+lrwjCFP4czve2XTSNDQAGlM01U6+zDRioFDhsuNbS6qLmuUBCiFCrqQIdza5UsIryLT5482D0OJ8FEYDtKRpDoaTVh/e2gCTAeoVuyTwYhR2T7jJFj6t/QzxF/6ATzwjRkytZGP9uV05PvT17GHzJRmMZyvX2uEWNRe1lpMvHJ5LdBBvVsTwSu2X6fsftGjbj2Ndz1Bx3QGR+q26Fn+z1pOvTWaJ/y8vL4+HFd9X2ZCkiAb4sCvS9bpbZ/+uNqou+opyAYA/6xfvmTt7opagqrQe959SRqo8rX/I/g9eBIraTG2x6R25fHx7cnpx1Op09Bc6GQewTbdd6aKylScwGlwv+B8KBzxj23PL7t39fip5D74E+/XBfaBChNq8X/O9orbKyi4TDx6Ovxnd7+dYjwL48jPNcJMZpIV+YO9f8iwjGe6fEhHf+412XaFNfZQbBTeQrSY9E6GbZx3t0fcSuP0vryZkXjpcFQGxqVtk0DMtRsyRbdpbHYjbNxz8iaW/fDs3WKLVkdgvXLxcJzLXJzP++vOMVzTxfuglu5WJ/M6dp8qMOtfdZ+bI+eq+IDr6SuvqW3GoG6pGSmfB3ANWSNW/k33LKsz8Z0V0cfauQCXcwc1cj7cYS/7jM9JLOfccOIe2pqDUNrOocmY2icLAeDJc0Kcqo0MYJO/M6ivpSVjmUWEXjIda5RFaZBIhFEEmazXuXz338btGYzEKZoG9QhNsT8o/6o37UOrNmgK1sV2Vup8F7mChPJa+LawPI88kah92oLUgesHPWykJUMXAEFJHUFBbc8l0pSH9E2Q9oOJq3o53BdY6jR0dKfHQIHgWtU1H7A22AaHshU7y9sjLsrldn4DDjkrZcavQfUNdcFbezLIQPjgGtAHdBZJz2CD468lsk3o4OjK7HhmldItjOYgiVQSeoZcCZvfQBvVBtdBprUxqGAPiCNKHwE8TVxRodAUkqyw5ryu0aoWinQZ1AYgeBjhVAIWkBOLM6SL7JAH+mfVqa4S+SwVQqsoVtMckUMduojqQfHtaerNvnS52AAzDpDIxSTg7PZB4+U4bdS3/nlbPZRH8HNUFfXmHsZcPVd34ebzeZR/7041Hkjw09tDu/RGi+DcdtRu5KhbvPYs1Mjwz/J0hvUGOtn0pGjDWEK//gKIOmiRmUXlxioQvzi7OI8Xvwv4POv/4C3yJ2G2mxStRatQ7WFqj+KkEuZT7AN9zaUJhZeTYgXqfg6qt0jeF3z8PnXf3r4GTcgdddSFMpsdtHmShbQjzc/my3hlcP4GdTLINQ8QME15Ai+5lRKa8mBg03aSuq7RP5bjw42MtSxGEge9Q7CIFyGdHvIuUcBRkeN/sz56BHJG49qjZ5s0fzNEVBI4luhdqat0mlTZ7rgHJb0tXEtRYUhxnYmBNhOvEliAnziDpbUEKHGLXCH4FGHOVw8UIkrrbXGkRcyOV8apcyGEoBaWCN18EsQjpdhtJ+NhV4QzNLoJ0QJQj7AkXVmhpSkTuwiHqTzj3QvP5gmh/etwxIdHRjDHvNiZVdON31ZAlXrf1LW6fslfb4SKemmDrfyh4d2IrlA1/h35SW6tSywG61f6OhF3LxgGVOyQO2nc+7szcVbWH8/P2bZZEb/C829eHv+6vXPl6/JGbpIE2An8+P5cfyaMz40XE9OOnxbeDjadiOb++++RHR0IeB9WFjFZaRqMfJdR7Nu2PiMsJw8QqwyVhsfaMNuR334wan9nsS/tOiIyq0ytuZOkpuRiwnp6W8xPDJ8MeTv3nfvFS/g6feMJ93uqY8m3rPmqqX/WMbucHv4frJf7bOe/pBjacOrdPzRFZkZDTzi0sTfksZZUaANX907Ja8XH65YxvLujaSJzy3M8Q29z/BN8tVENCKxi7IdU1xXbfyWZMkkETa6sw/Z3l1ke90fFNSTaBzSwBQF/aaYnlTY7RKT3O+H/Wnpixodrv1uSs1qv9//DlAr0Ws=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},y=void 0,v={},b=[];function g(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Update Contact"}),"\n",(0,i.jsx)(c(),{method:"put",path:"/contact/{contact_id}",context:"endpoint"}),"\n",(0,i.jsx)(t.p,{children:"The Update Contact API enables you to modify and update the details of a specific Contact."}),"\n",(0,i.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,i.jsx)(j.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,i.jsx)(p(),{...a(16386)}),"\n",(0,i.jsx)(l(),{...a(71400)}),"\n",(0,i.jsx)(f(),{...a(70338)})]})}function x(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(g,{...e})}):g(e)}},16386(e){e.exports=JSON.parse('{"parameters":[{"name":"contact_id","in":"path","description":"objectId of contact","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string"}}]}')},71400(e){e.exports=JSON.parse('{"title":"Body","body":{"description":"Provide the fields you wish to update. Any fields omitted from the request will remain unchanged.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","format":"string","example":"joe bee"},"email":{"type":"string","format":"string","example":"joebee@example.com"},"phone":{"type":"string","format":"string","example":"4131231231"},"company":{"type":"string","format":"string","example":"opensign"},"job_title":{"type":"string","format":"string","example":"dev"}},"xml":{"name":"contactdetails"},"title":"contact_res"}}}}}')},70338(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Contact updated successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","example":"Bh2Hspnmch"},"message":{"type":"string","example":"Contact updated successfully"}},"title":"inline_response_200_14"}}}},"400":{"description":"Please provide valid field names!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","format":"string","example":"Please provide valid field names!"}},"title":"inline_response_400"}}}},"404":{"description":"Contact not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","format":"string","example":"Template not found!"}},"title":"inline_response_404_7"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/19e5ad2a.456209b0.js b/assets/js/19e5ad2a.456209b0.js deleted file mode 100644 index be1593820..000000000 --- a/assets/js/19e5ad2a.456209b0.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[1651],{72908(e,t,o){o.r(t),o.d(t,{assets:()=>V,contentTitle:()=>x,default:()=>j,frontMatter:()=>g,metadata:()=>i,toc:()=>T});const i=JSON.parse('{"id":"API-docs/v1.1/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/v1.1/contactlist.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/contactlist","permalink":"/docs/API-docs/v1.1/contactlist","draft":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJzNV9tu5LgR/ZUKX5JtyH3xzGwQPa0xGDhGjB0j9sJAPMaAkqoluimSS5a63Wg0sA/5gzzlNZ82XxIUdWm17dmNk8UigGFbxbpfWIc7QbIMIr0T760hmVMQ94koMOReOVLWiFTcVAjdKVyqQHB2dQFYO7tBH2BrGyALHskrXCNI0Mxjl5B3GhNw3q5VoUwJEnJbO48VmqDWCGuFG+aVWoNcS6VlpnGQBGVYv+8JmbWrqUiEdegle3dRiFR0h2xWJMJJL2sk9BzVThhZo0iFVrXiU8UB/dig34pEePyxUR4LkS6lDpiIQFvN3Evra5EIfHTaFihS8g2f5hXWUqQ7UctHVTe1SN/N54mgrWMh09QZerFnOVk7VrSY75PBhbBS7lfz4Os25/t71hucNQED857O5/znuKihyXMMYdloGLIpkphLNMT80jmt8ngwewgstHvugM0eMI9p96yGVGvSY2g0jfik95IDVoR1+GX5lszVHTgDeWVKkcTUSBpThtiFqxZZ9Xj64Dglbd5fp+DBImSIMaO1VPq/kM8Qv+sI09zWrMpV1rzalbeLN4vT+MMqeGyk2b5WiXU8aKVhFQ82+0yK9Ks9KXAdXfAoCYszekn+wH06P31zspifzP94s/g2ffun9N230/l8/jeRiMc6JrQbiEJSTHTn0/DduOI3sLN/ytZdIwWSVDqMBboTsd+PiMpoZfBzP2mfecr2kePtS/N2bWukiq/ADRqCjbemTMBplAGB/BZkKZUBLQn97369QUTvrf/5PL7Os59Lwdv5/PNiSMK750m4MGupVREXyI1dofltIx2bp9b88zZQLVM8F0fBjultkAHzxivaxk3zeCKdOmnP07t7voY5sZZXVIntaqJKpGJ2vLAC+nW/rRqvRSoqIhfS2SxIU2T2cdoPsZZZ4CtlJp2arRdTvhieykjnXsWPzclrRQLJUpnyl+TuD/m55hq2ZTrK0mE9OPUX5P3QFWHM1a3MCmXBq27P30sbhbvSfHRorlVpYmGj8acQ5hZ1bmtkoEIVwmTSi3z5+78GqckECps3NRqKLTj9ZD6Zj42HiHR4U0pTwFLjo2KQ8hIKCihrjSHoLShDWHpJCIUqFUkNnCces1w6mSmtuHOZzbYYZ9T8YQq3FVKFno9+7xlVFbhGzQ0PsiFbS2JVvb+wsX611HYTEpCQNUEZDAHQVNLkzNhXIgHrQRpAQ+idVwEhkGevVeubNeQZ6NXSyBJZdwLjZBWoFbcreJs1gSBY3USXga9N67GAPiCDWISYxA8MYzxCC+XG+K9sVIEhgdwWCCEOKodgCsgwEDj2ReUYWGljtM1XsYDLRmtwlu8NJTUDyLGPLE5emsBLrfWlr8GQMOct4x9sHZxMfgjIFb5UZhXSyeSTOYG7oa9uMQuK8P4P/QhsNptnrf/Nscy5oj83GfwVnQ2KrN8epEtFVZPFcRkrGT5aTedoMPbPaBgOOgqbh+fTx9RZhdrNrpG4Q8Ls7OoiXrXfwJef/gGXKL2Bym7abs0bj3oLZW+KM9dWvk3bcFPC0sbGqzjjedt8DF4xUJ/B20rSl5/+GeB73DBwb0eKQ5lMrppMqxxusHa8R8JkksL7CCeAehpQJQlyaSBDCJXkVlorCRJcK62VWU3hzGyhCehho6iKzcD0KHcUBudlKHeATAYswJoo0ducHjxieh1QrzGwLmOJ3cBCEXd05W1TttbGznTBeVwqreFWFSVSjO2sKMB15E1L5oSP3MElDwRVuAXpEQIamsLVE5F40jhnPXuhWueXVmu74QKgKZxVhkIKhZdLOuhPDo0eUZuy5gVSm0I5pCPp1AwlaSexi3igTj/xpfzkIj++bz0u0bPBGPahLk517XTXtyVwt/4vbd2C4xagMQxoUTtvlO+e6onrHH0dPi6v0a9Vjt1W+8pEzyLzTCRCqxxNwBFMODu/uoT1m+lcJKP1+B8M9+zy4v2H768/sDN8kbYJW0zn03l8KthAtTQjS+dIw/O7gwxHyd4dENT/4VO9W/CEjzRzWqqIqWLCdh0eujt6wN8norKBmLzb8dD+4PV+z+T2zcwoqVCBbR9ezSvcjt74a6kbthmhy1d4u8f4gfWeP7xi3ojekh5wsMFW5izP0Y0NPIOrR5jv/MONSATfmcdAZxWBTvcPa++PzHak+xgBtQ7wb47pRYHdrgVR+/3A3x59VaILsOfm0tzv9/t/A7ATTaM=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Contact","permalink":"/docs/API-docs/v1.1/deletecontact"},"next":{"title":"Self Sign","permalink":"/docs/API-docs/v1.1/selfsign"}}');var s=o(74848),a=o(28453),n=o(57742),r=o.n(n),l=o(78178),p=o.n(l),c=o(19624),d=o.n(c),m=o(96226),h=o.n(m),b=(o(77675),o(19365),o(51107)),u=o(21312);const g={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:"eJzNV9tu5LgR/ZUKX5JtyH3xzGwQPa0xGDhGjB0j9sJAPMaAkqoluimSS5a63Wg0sA/5gzzlNZ82XxIUdWm17dmNk8UigGFbxbpfWIc7QbIMIr0T760hmVMQ94koMOReOVLWiFTcVAjdKVyqQHB2dQFYO7tBH2BrGyALHskrXCNI0Mxjl5B3GhNw3q5VoUwJEnJbO48VmqDWCGuFG+aVWoNcS6VlpnGQBGVYv+8JmbWrqUiEdegle3dRiFR0h2xWJMJJL2sk9BzVThhZo0iFVrXiU8UB/dig34pEePyxUR4LkS6lDpiIQFvN3Evra5EIfHTaFihS8g2f5hXWUqQ7UctHVTe1SN/N54mgrWMh09QZerFnOVk7VrSY75PBhbBS7lfz4Os25/t71hucNQED857O5/znuKihyXMMYdloGLIpkphLNMT80jmt8ngwewgstHvugM0eMI9p96yGVGvSY2g0jfik95IDVoR1+GX5lszVHTgDeWVKkcTUSBpThtiFqxZZ9Xj64Dglbd5fp+DBImSIMaO1VPq/kM8Qv+sI09zWrMpV1rzalbeLN4vT+MMqeGyk2b5WiXU8aKVhFQ82+0yK9Ks9KXAdXfAoCYszekn+wH06P31zspifzP94s/g2ffun9N230/l8/jeRiMc6JrQbiEJSTHTn0/DduOI3sLN/ytZdIwWSVDqMBboTsd+PiMpoZfBzP2mfecr2kePtS/N2bWukiq/ADRqCjbemTMBplAGB/BZkKZUBLQn97369QUTvrf/5PL7Os59Lwdv5/PNiSMK750m4MGupVREXyI1dofltIx2bp9b88zZQLVM8F0fBjultkAHzxivaxk3zeCKdOmnP07t7voY5sZZXVIntaqJKpGJ2vLAC+nW/rRqvRSoqIhfS2SxIU2T2cdoPsZZZ4CtlJp2arRdTvhieykjnXsWPzclrRQLJUpnyl+TuD/m55hq2ZTrK0mE9OPUX5P3QFWHM1a3MCmXBq27P30sbhbvSfHRorlVpYmGj8acQ5hZ1bmtkoEIVwmTSi3z5+78GqckECps3NRqKLTj9ZD6Zj42HiHR4U0pTwFLjo2KQ8hIKCihrjSHoLShDWHpJCIUqFUkNnCces1w6mSmtuHOZzbYYZ9T8YQq3FVKFno9+7xlVFbhGzQ0PsiFbS2JVvb+wsX611HYTEpCQNUEZDAHQVNLkzNhXIgHrQRpAQ+idVwEhkGevVeubNeQZ6NXSyBJZdwLjZBWoFbcreJs1gSBY3USXga9N67GAPiCDWISYxA8MYzxCC+XG+K9sVIEhgdwWCCEOKodgCsgwEDj2ReUYWGljtM1XsYDLRmtwlu8NJTUDyLGPLE5emsBLrfWlr8GQMOct4x9sHZxMfgjIFb5UZhXSyeSTOYG7oa9uMQuK8P4P/QhsNptnrf/Nscy5oj83GfwVnQ2KrN8epEtFVZPFcRkrGT5aTedoMPbPaBgOOgqbh+fTx9RZhdrNrpG4Q8Ls7OoiXrXfwJef/gGXKL2Bym7abs0bj3oLZW+KM9dWvk3bcFPC0sbGqzjjedt8DF4xUJ/B20rSl5/+GeB73DBwb0eKQ5lMrppMqxxusHa8R8JkksL7CCeAehpQJQlyaSBDCJXkVlorCRJcK62VWU3hzGyhCehho6iKzcD0KHcUBudlKHeATAYswJoo0ducHjxieh1QrzGwLmOJ3cBCEXd05W1TttbGznTBeVwqreFWFSVSjO2sKMB15E1L5oSP3MElDwRVuAXpEQIamsLVE5F40jhnPXuhWueXVmu74QKgKZxVhkIKhZdLOuhPDo0eUZuy5gVSm0I5pCPp1AwlaSexi3igTj/xpfzkIj++bz0u0bPBGPahLk517XTXtyVwt/4vbd2C4xagMQxoUTtvlO+e6onrHH0dPi6v0a9Vjt1W+8pEzyLzTCRCqxxNwBFMODu/uoT1m+lcJKP1+B8M9+zy4v2H768/sDN8kbYJW0zn03l8KthAtTQjS+dIw/O7gwxHyd4dENT/4VO9W/CEjzRzWqqIqWLCdh0eujt6wN8norKBmLzb8dD+4PV+z+T2zcwoqVCBbR9ezSvcjt74a6kbthmhy1d4u8f4gfWeP7xi3ojekh5wsMFW5izP0Y0NPIOrR5jv/MONSATfmcdAZxWBTvcPa++PzHak+xgBtQ7wb47pRYHdrgVR+/3A3x59VaILsOfm0tzv9/t/A7ATTaM=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},x=void 0,V={},T=[];function P(e){const t={p:"p",...(0,a.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(b.default,{as:"h1",className:"openapi__heading",children:"Get Contact list"}),"\n",(0,s.jsx)(r(),{method:"get",path:"/contactlist",context:"endpoint"}),"\n",(0,s.jsx)(t.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,s.jsx)(b.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(u.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(p(),{...o(85366)}),"\n",(0,s.jsx)(d(),{...o(72212)}),"\n",(0,s.jsx)(h(),{...o(22638)})]})}function j(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(P,{...e})}):P(e)}},85366(e){e.exports=JSON.parse('{"parameters":[{"name":"limit","in":"query","required":false,"style":"form","explode":true,"schema":{"maximum":500,"type":"number"},"example":10},{"name":"skip","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"number"},"example":0}]}')},72212(e){e.exports={title:"Body"}},22638(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"ph1bhx2jp"},"name":{"type":"string","format":"string","example":"joe bee"},"email":{"type":"string","format":"string","example":"joebee@example.com"},"phone":{"type":"string","format":"string","example":"4131231231"},"company":{"type":"string","format":"string","example":"opensign"},"job_title":{"type":"string","format":"string","example":"dev"},"createdAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"xml":{"name":"contactdetails"},"title":"contact"}}},"title":"inline_response_200"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/19e5ad2a.f1d6aca2.js b/assets/js/19e5ad2a.f1d6aca2.js new file mode 100644 index 000000000..9cebc8e02 --- /dev/null +++ b/assets/js/19e5ad2a.f1d6aca2.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[1651],{72908(e,t,o){o.r(t),o.d(t,{assets:()=>v,contentTitle:()=>h,default:()=>g,frontMatter:()=>Z,metadata:()=>a,toc:()=>y});const a=JSON.parse('{"id":"API-docs/v1.1/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/v1.1/contactlist.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/contactlist","permalink":"/docs/API-docs/v1.1/contactlist","draft":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJzNGdtuG8f1V07XQGERy4scJ0WZIo0iK4oRNxZEqQYqCtrZ3UPumLMzm5lZUoREIA9FP6DoS1/7E33vp/hLijMzu1xSjh01QVDAtqyZc7/P2bvIsrmJxlfRsZKWZdZE13GUo8k0ryxXMhpHFwVCuIVX3Fg4OnsJWFZqhdrAWtVgFWi0muMSgYEgGDWDLFCModJqyXMu58AgU2WlsUBp+BJhyXFFsEwIYEvGBUsFtpjAJdHXzUGq1GIQxZGqUDOS7mUejaNwSWyjOKqYZiVa1KTVXSRZidE4ErzkdMtJoe9r1OsojjR+X3ONeTSeMWEwjoxdC4KeKV1GcYS3lVA5RmOra7rNCixZNL6LSnbLy7qMxp+ORnFk1xUhybpMUUcbwmNlRYQOR5u4FcEsePWLSfDjPEeba6JrKiUNGoJ9NhrRj12nmjrL0JhZLaC1ZhQ7W6K0BM+qSvDMXQzfGkK6eyiASt9i5syuiYzlnqVGUwvbgWNaM1KYWyzNx/H9MXm3hTRWczmPYmcaZrsnre5RVRymxe2ztxWZxNv9cQTeKoQU0Vm0ZFz8D/gp4pfhYJCpkkhVhZKPFuX54SeHz9wfIkFpw+T6sURURYk2l0TirUpvLLfi0ZLkuHQiaGQW8yP7Pvwt9LPRs0/6h6P+6HcXh5+Nn/9+/Olng9Fo9Jcojm5LZ9CQEDmzztBBpvb3usp/BT6bfbBQRnK0jAvTRQg30WbTOeRScIk3TabdUJZtHMTz9+XbRJVoCyqBK5QWVlrJeQyVQGYQrF4DmzMuQTCL+je/XCKi1kp/2I6Pk+xDJng+Gt0ctkb49KERXsolEzx3DeRCLVD+upp22VvP/mEYcA/k7qMdZbvnXkmDWa25XbtOc9tnFe/7+/HVNZVhMqyiFjVH35psEY2j4W7DMqiXTbeqtYjGUWFtZcbDoWEyT9XtoEliwVJDJWXIKj5cHg6eRdRednFYVT0KHuv+Y1GMZXMu5x/Du97aZ0I+9G7asdK2PVT8W6T+EJzQhQots0CWU6vb0O8z5ZCDa15XKCd8Lp1jHfP9EeYJNDDv/vqvFmwqp/IL6PVowCFF+kbVOkN4obLa0WPCopbM0qTy7od/QFpzYWGmNOS4REHhZ2KwujYWc0jXgNKirjQ3aAa9HtHv8p3zJfqByY9BAi264SivMxK0r5Hla8A+WZTZWiNUglkqzWALrep5AQwMl3OBMZyfTC6ofR+dvRzABGUOucrqEqU1TsSWSAwlk2yOYLEkeuhkZtnCgVDiG8ts7aYtjUyA5SXGwGQOrLaqZBb9FIbSco0tGxB8htk6E944NMKtuC1UbWGJMlcahMoWfS4HZIh+v08/njyBU7SWuE4s0xZzOj1Zol4DTUNoLJS1sZAxrdeeb5uvJKEtEJJOfCTgI8MxSZJkKjuXY/gDUdgefBFgprLXe/e3v8PVN2pF4+scJQ1BuMfw+mkT9LnKzMNop9NhgaIaTrxSZnh09tKVtgPv/++UBUOeXBWokVilOOfyj3BJ1bVA6PVCmgPKJddKkml7PXia/OQykBwQ3UorqyifWi+w2QwzZ2pBEZwzy/Zccaw0wjGrWMoFp0pK5/dwzCzOlV7DPbwpmHUhmzEJuYL7qbzv9/vuL4H2ei+aqOv14B6O3ZAQg0GZx+BbeQwal2oRYipHivttePYbt2/DN1C+aOLVUf6q5iIHjbVxb4Q2mJ26UGnsV4JlmMOK53O05nMnA1lGSQSlKQvWji09WwKLCYpZn/LTsThtosDQsQPtZlVr10AFuFxy69oVzIRaNUTP6lTwDHbFnxRM0+uo8pdN6gkuFy59pGqouvdT8zJoaL7QbGbhjdIL4uQpsiV2pFO6YxNmICcM40w+45IJ7gOu9J28ods8+xzFP/k64XIgCBN6FdDTi0JsrllZMsszJsS6IfK1EjlqT+O1njNJvLaScWl4jm0JhheawnHmkRoabzAtlFp4IueYIcFQOepTOQJcUsWRyvJZmBAM+MjUoFYSUOaV4tI25C5NI9B5+zLNMlVL6yySacy5BeokNPeSB+93U4MC/90P/zTwHa6o7jQNgy6fwJG1LCtcFXzjwg0mdVUpbaeSuknC2nuThIAEbkCqFRgPiDko6Z3UmioGP2N3DjxA49gWYHtA2oSYag6pfplBI+o3ZPuJ9+YkRN0rLhdmKidoIZlGBc/xxvv7JsTljXAQ0Zi6G8I9uPdpQiInZ68nFzB0gjVyJpRmRKYJm254m6Zs7yoLzdw42Jr1WCAj9CZ1GucxMZXJ6ckFDBsdh2OeJ0753XNKngQKSo0UUYKxGllJc2ru0kxjXsucSQvbRQFQZmos1RJzR7LXqzTOuBCuZjaO02hrTXQMEq5FsYaZVmWj85Zgr0c9d0EGaF/igMxw1GSoTElTl9h66IwZs1I6759pZTGj0Dh78fU2ouie/DTjAm+qADyNksauTQFNVb6mPiNhpbTj7kojykyvq0DVDBq6LgDHUxn86QOrMWMC//k3JGeXDyzujjsIjTeH4wbuZhdsL072Lvb4uQsqvmTSpLHP69mMHNhGL9UsrUQbv0wItbpRHspF8IcCd19RF0Pv0dQqoPULz7gVNNm5rkOjH/cNKPBrQ51mLmRZ0aZh69+QfOdKUIN19SG0oQT8a8bFF8syrKhik04hHbUSSJ6ecRQ5sEwrY9yk5bSgsqVVbdEM4KLQiEDwPp7bMjP2PZ24UxfFgi05Vc39Th5kSqD3NMcZq4U9cD3BDWNhWqWSSw9D63rqdkwNFc7ToZ0e0WnLuPHZ3+Q9GUqj3/xJsW66X2jb4LzZNL6EVbQ89OSOmfSZTY28AcdbslroyV6a0Dsds/u2tDCdKgnHqlrD0+PjAxKOV5wq9FQegcQVmT3LttZ+UK+ZUHLuWhnpg7fcuOEqmUZpF4/Kelu/t4XaVz+Ktna6aL049INS68wT2j0By3ONhmoHVTXMKd9bGXVokYwm5VTJfkaadRskuA0WKJnhrgO4aR2aD+AVX+BWh5jE35EGnpo6K2ii8FmyzXieJwed3W4rGvlL8zz4ve1KSyZqjF0n91WKLCs4GZbGFFop2zW4TSE8Ta6uk4PPQZXcOiretFYBlwXqcLhLem+2PWrXySfbwToMuJ0TygnadFyev3rPcDvxs7cbJB4xkLeTYPu226Xwwadzi31yCec4f4D8sSd7sj/K/Bm14coVqd/CVyxbrJjODRzTStFyN/qvCZSQKThmNc12aQPYzwKg8E8LWB66MF4eDg7bl18zfxnfEm2hDMLSM/YFabveV9S2uIG0sbujKhWkGn3XzAom55QINHx1GjWnwp/Xmc8FJy+RVu6dzwTUUqAxoGyBekVDqFQU47vmuDRI7+YwA01lH67a0fQNpoZb3L77VqvVA0sfOJyvayGgefy4hPvIa9GjnXL7TZ3COVbKcKv0eos157aoU+fLLm77SyDQPFLaLdrPeaU6kheoS0OfYSaolzz7iPpDS+DDgyntZvb2ObtrF40z1FR3zM4bm1U8vOevGjmAxPs5evgdud/T0jbQL+9psfTlPh231SMVXs+CvmG59WF9ozgSPENpsLMtPDo9ewXLTwajKO5syX6CL4evXh6ffDc5IWFCmkTj6HAwGozcFwNlbMlkh9Mp2vYrXNgc7hj7brtI/T/8Yhf2fBZv7bASjLvVqjPYXViLXu18x7uOo0IZS8d3d1QnLrXYbOjYfzqjZWkYxLYfzxa47nzqcz0hGkdug/kjsOGb3Bb0mn7RnGDdEjdu9o7E0OMcuTGtg/Vga72z+j09uYjiiNWkY3ffuXD7zvAfot5cyXWH9u4i1AtA/5JO70W4u/O71M2mhfdXP4oRFGygyTXXm83mv+3znDw=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Contact","permalink":"/docs/API-docs/v1.1/deletecontact"},"next":{"title":"Self Sign","permalink":"/docs/API-docs/v1.1/selfsign"}}');var s=o(74848),i=o(28453),n=o(57742),c=o.n(n),r=o(78178),p=o.n(r),l=o(19624),m=o.n(l),d=o(96226),u=o.n(d),b=(o(77675),o(19365),o(51107)),j=o(21312);const Z={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:"eJzNGdtuG8f1V07XQGERy4scJ0WZIo0iK4oRNxZEqQYqCtrZ3UPumLMzm5lZUoREIA9FP6DoS1/7E33vp/hLijMzu1xSjh01QVDAtqyZc7/P2bvIsrmJxlfRsZKWZdZE13GUo8k0ryxXMhpHFwVCuIVX3Fg4OnsJWFZqhdrAWtVgFWi0muMSgYEgGDWDLFCModJqyXMu58AgU2WlsUBp+BJhyXFFsEwIYEvGBUsFtpjAJdHXzUGq1GIQxZGqUDOS7mUejaNwSWyjOKqYZiVa1KTVXSRZidE4ErzkdMtJoe9r1OsojjR+X3ONeTSeMWEwjoxdC4KeKV1GcYS3lVA5RmOra7rNCixZNL6LSnbLy7qMxp+ORnFk1xUhybpMUUcbwmNlRYQOR5u4FcEsePWLSfDjPEeba6JrKiUNGoJ9NhrRj12nmjrL0JhZLaC1ZhQ7W6K0BM+qSvDMXQzfGkK6eyiASt9i5syuiYzlnqVGUwvbgWNaM1KYWyzNx/H9MXm3hTRWczmPYmcaZrsnre5RVRymxe2ztxWZxNv9cQTeKoQU0Vm0ZFz8D/gp4pfhYJCpkkhVhZKPFuX54SeHz9wfIkFpw+T6sURURYk2l0TirUpvLLfi0ZLkuHQiaGQW8yP7Pvwt9LPRs0/6h6P+6HcXh5+Nn/9+/Olng9Fo9Jcojm5LZ9CQEDmzztBBpvb3usp/BT6bfbBQRnK0jAvTRQg30WbTOeRScIk3TabdUJZtHMTz9+XbRJVoCyqBK5QWVlrJeQyVQGYQrF4DmzMuQTCL+je/XCKi1kp/2I6Pk+xDJng+Gt0ctkb49KERXsolEzx3DeRCLVD+upp22VvP/mEYcA/k7qMdZbvnXkmDWa25XbtOc9tnFe/7+/HVNZVhMqyiFjVH35psEY2j4W7DMqiXTbeqtYjGUWFtZcbDoWEyT9XtoEliwVJDJWXIKj5cHg6eRdRednFYVT0KHuv+Y1GMZXMu5x/Du97aZ0I+9G7asdK2PVT8W6T+EJzQhQots0CWU6vb0O8z5ZCDa15XKCd8Lp1jHfP9EeYJNDDv/vqvFmwqp/IL6PVowCFF+kbVOkN4obLa0WPCopbM0qTy7od/QFpzYWGmNOS4REHhZ2KwujYWc0jXgNKirjQ3aAa9HtHv8p3zJfqByY9BAi264SivMxK0r5Hla8A+WZTZWiNUglkqzWALrep5AQwMl3OBMZyfTC6ofR+dvRzABGUOucrqEqU1TsSWSAwlk2yOYLEkeuhkZtnCgVDiG8ts7aYtjUyA5SXGwGQOrLaqZBb9FIbSco0tGxB8htk6E944NMKtuC1UbWGJMlcahMoWfS4HZIh+v08/njyBU7SWuE4s0xZzOj1Zol4DTUNoLJS1sZAxrdeeb5uvJKEtEJJOfCTgI8MxSZJkKjuXY/gDUdgefBFgprLXe/e3v8PVN2pF4+scJQ1BuMfw+mkT9LnKzMNop9NhgaIaTrxSZnh09tKVtgPv/++UBUOeXBWokVilOOfyj3BJ1bVA6PVCmgPKJddKkml7PXia/OQykBwQ3UorqyifWi+w2QwzZ2pBEZwzy/Zccaw0wjGrWMoFp0pK5/dwzCzOlV7DPbwpmHUhmzEJuYL7qbzv9/vuL4H2ei+aqOv14B6O3ZAQg0GZx+BbeQwal2oRYipHivttePYbt2/DN1C+aOLVUf6q5iIHjbVxb4Q2mJ26UGnsV4JlmMOK53O05nMnA1lGSQSlKQvWji09WwKLCYpZn/LTsThtosDQsQPtZlVr10AFuFxy69oVzIRaNUTP6lTwDHbFnxRM0+uo8pdN6gkuFy59pGqouvdT8zJoaL7QbGbhjdIL4uQpsiV2pFO6YxNmICcM40w+45IJ7gOu9J28ods8+xzFP/k64XIgCBN6FdDTi0JsrllZMsszJsS6IfK1EjlqT+O1njNJvLaScWl4jm0JhheawnHmkRoabzAtlFp4IueYIcFQOepTOQJcUsWRyvJZmBAM+MjUoFYSUOaV4tI25C5NI9B5+zLNMlVL6yySacy5BeokNPeSB+93U4MC/90P/zTwHa6o7jQNgy6fwJG1LCtcFXzjwg0mdVUpbaeSuknC2nuThIAEbkCqFRgPiDko6Z3UmioGP2N3DjxA49gWYHtA2oSYag6pfplBI+o3ZPuJ9+YkRN0rLhdmKidoIZlGBc/xxvv7JsTljXAQ0Zi6G8I9uPdpQiInZ68nFzB0gjVyJpRmRKYJm254m6Zs7yoLzdw42Jr1WCAj9CZ1GucxMZXJ6ckFDBsdh2OeJ0753XNKngQKSo0UUYKxGllJc2ru0kxjXsucSQvbRQFQZmos1RJzR7LXqzTOuBCuZjaO02hrTXQMEq5FsYaZVmWj85Zgr0c9d0EGaF/igMxw1GSoTElTl9h66IwZs1I6759pZTGj0Dh78fU2ouie/DTjAm+qADyNksauTQFNVb6mPiNhpbTj7kojykyvq0DVDBq6LgDHUxn86QOrMWMC//k3JGeXDyzujjsIjTeH4wbuZhdsL072Lvb4uQsqvmTSpLHP69mMHNhGL9UsrUQbv0wItbpRHspF8IcCd19RF0Pv0dQqoPULz7gVNNm5rkOjH/cNKPBrQ51mLmRZ0aZh69+QfOdKUIN19SG0oQT8a8bFF8syrKhik04hHbUSSJ6ecRQ5sEwrY9yk5bSgsqVVbdEM4KLQiEDwPp7bMjP2PZ24UxfFgi05Vc39Th5kSqD3NMcZq4U9cD3BDWNhWqWSSw9D63rqdkwNFc7ToZ0e0WnLuPHZ3+Q9GUqj3/xJsW66X2jb4LzZNL6EVbQ89OSOmfSZTY28AcdbslroyV6a0Dsds/u2tDCdKgnHqlrD0+PjAxKOV5wq9FQegcQVmT3LttZ+UK+ZUHLuWhnpg7fcuOEqmUZpF4/Kelu/t4XaVz+Ktna6aL049INS68wT2j0By3ONhmoHVTXMKd9bGXVokYwm5VTJfkaadRskuA0WKJnhrgO4aR2aD+AVX+BWh5jE35EGnpo6K2ii8FmyzXieJwed3W4rGvlL8zz4ve1KSyZqjF0n91WKLCs4GZbGFFop2zW4TSE8Ta6uk4PPQZXcOiretFYBlwXqcLhLem+2PWrXySfbwToMuJ0TygnadFyev3rPcDvxs7cbJB4xkLeTYPu226Xwwadzi31yCec4f4D8sSd7sj/K/Bm14coVqd/CVyxbrJjODRzTStFyN/qvCZSQKThmNc12aQPYzwKg8E8LWB66MF4eDg7bl18zfxnfEm2hDMLSM/YFabveV9S2uIG0sbujKhWkGn3XzAom55QINHx1GjWnwp/Xmc8FJy+RVu6dzwTUUqAxoGyBekVDqFQU47vmuDRI7+YwA01lH67a0fQNpoZb3L77VqvVA0sfOJyvayGgefy4hPvIa9GjnXL7TZ3COVbKcKv0eos157aoU+fLLm77SyDQPFLaLdrPeaU6kheoS0OfYSaolzz7iPpDS+DDgyntZvb2ObtrF40z1FR3zM4bm1U8vOevGjmAxPs5evgdud/T0jbQL+9psfTlPh231SMVXs+CvmG59WF9ozgSPENpsLMtPDo9ewXLTwajKO5syX6CL4evXh6ffDc5IWFCmkTj6HAwGozcFwNlbMlkh9Mp2vYrXNgc7hj7brtI/T/8Yhf2fBZv7bASjLvVqjPYXViLXu18x7uOo0IZS8d3d1QnLrXYbOjYfzqjZWkYxLYfzxa47nzqcz0hGkdug/kjsOGb3Bb0mn7RnGDdEjdu9o7E0OMcuTGtg/Vga72z+j09uYjiiNWkY3ffuXD7zvAfot5cyXWH9u4i1AtA/5JO70W4u/O71M2mhfdXP4oRFGygyTXXm83mv+3znDw=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-2",custom_edit_url:null},h=void 0,v={},y=[];function L(e){const t={p:"p",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(b.default,{as:"h1",className:"openapi__heading",children:"Get Contact list"}),"\n",(0,s.jsx)(c(),{method:"get",path:"/contactlist",context:"endpoint"}),"\n",(0,s.jsx)(t.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,s.jsx)(b.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(j.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(p(),{...o(85366)}),"\n",(0,s.jsx)(m(),{...o(72212)}),"\n",(0,s.jsx)(u(),{...o(22638)})]})}function g(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(L,{...e})}):L(e)}},85366(e){e.exports=JSON.parse('{"parameters":[{"name":"limit","in":"query","required":false,"style":"form","explode":true,"schema":{"maximum":500,"type":"number"},"example":10},{"name":"skip","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"number"},"example":0}]}')},72212(e){e.exports={title:"Body"}},22638(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"ph1bhx2jp"},"name":{"type":"string","format":"string","example":"joe bee"},"email":{"type":"string","format":"string","example":"joebee@example.com"},"phone":{"type":"string","format":"string","example":"4131231231"},"company":{"type":"string","format":"string","example":"opensign"},"job_title":{"type":"string","format":"string","example":"dev"},"createdAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"xml":{"name":"contactdetails"},"title":"contact"}}},"title":"inline_response_200"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/1c57a399.7e9acdf0.js b/assets/js/1c57a399.7e9acdf0.js deleted file mode 100644 index 22f07c03c..000000000 --- a/assets/js/1c57a399.7e9acdf0.js +++ /dev/null @@ -1 +0,0 @@ -(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[8901],{10417(e,t,n){"use strict";n.r(t),n.d(t,{assets:()=>u,contentTitle:()=>p,default:()=>f,frontMatter:()=>d,metadata:()=>o,toc:()=>h});const o=JSON.parse('{"id":"API-docs/v1.1/opensign-api-v-1-1","title":"OpenSign API v1.1","description":"Welcome to the **OpenSign\u2122 API v1.1** documentation.","source":"@site/docs/API-docs/v1.1/opensign-api-v-1-1.info.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/opensign-api-v-1-1","permalink":"/docs/API-docs/v1.1/opensign-api-v-1-1","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","sidebarPosition":0,"frontMatter":{"id":"opensign-api-v-1-1","title":"OpenSign API v1.1","description":"Welcome to the **OpenSign\u2122 API v1.1** documentation.","sidebar_label":"Introduction","sidebar_position":0,"hide_title":true,"custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"v1.1","permalink":"/docs/API-docs/v1.1"},"next":{"title":"Get your account details","permalink":"/docs/API-docs/v1.1/get-user"}}');var i=n(74848),s=n(28453),a=(n(43905),n(51107)),r=n(23397),l=n.n(r),c=n(19365);n(69016);const d={id:"opensign-api-v-1-1",title:"OpenSign API v1.1",description:"Welcome to the **OpenSign\u2122 API v1.1** documentation.",sidebar_label:"Introduction",sidebar_position:0,hide_title:!0,custom_edit_url:null},p=void 0,u={},h=[];function m(e){const t={a:"a",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("span",{className:"theme-doc-version-badge badge badge--secondary",children:"Version: 1.0.0"}),"\n",(0,i.jsx)(a.default,{as:"h1",className:"openapi__heading",children:"OpenSign API v1.1"}),"\n",(0,i.jsxs)(t.p,{children:["Welcome to the ",(0,i.jsx)(t.strong,{children:"OpenSign\u2122 API v1.1"})," documentation."]}),"\n",(0,i.jsx)(t.p,{children:"Our powerful and flexible API empowers you to seamlessly integrate digital signing capabilities into your applications. Whether you're a developer automating document workflows, a business enhancing security, or an enterprise streamlining contract management, OpenSign\u2122 delivers robust solutions tailored to your needs."}),"\n",(0,i.jsx)(t.p,{children:"Explore our comprehensive guides, code samples, and best practices to unlock the full potential of OpenSign\u2122 and transform your digital document processes."}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"Useful Links:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.a,{href:"https://www.opensignlabs.com",children:"OpenSign Website"})}),"\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.a,{href:"https://github.com/opensignlabs/opensign",children:"OpenSign GitHub Repository"})}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.a,{href:"https://docs.opensignlabs.com/docs/help/Settings/APIToken",children:"Generate x-api-token"})," \u2013 Learn how to securely generate and manage your API token for authenticating requests."]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"What\u2019s New in v1.1"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Public Templates"}),": Create templates that can be shared via a public link. Any user with the link can generate and sign documents based on the template. Templates themselves cannot be edited through the public link."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Prefill Widgets"}),": Add prefill widgets to documents before they are sent. Prefill widgets are supported in the following endpoints: draft documents, document creation, document creation with a template, draft templates, and public templates."]}),"\n"]}),"\n",(0,i.jsxs)("div",{style:{marginBottom:"2rem"},children:[(0,i.jsx)(a.default,{id:"authentication",as:"h2",className:"openapi-tabs__heading",children:"Authentication"}),(0,i.jsx)(l(),{className:"openapi-tabs__security-schemes",children:(0,i.jsx)(c.default,{label:"API Key: x-api-token",value:"x-api-token",children:(0,i.jsx)("div",{children:(0,i.jsx)("table",{children:(0,i.jsxs)("tbody",{children:[(0,i.jsxs)("tr",{children:[(0,i.jsx)("th",{children:(0,i.jsx)(t.p,{children:"Security Scheme Type:"})}),(0,i.jsx)("td",{children:(0,i.jsx)(t.p,{children:"apiKey"})})]}),(0,i.jsxs)("tr",{children:[(0,i.jsx)("th",{children:(0,i.jsx)(t.p,{children:"Header parameter name:"})}),(0,i.jsx)("td",{children:(0,i.jsx)(t.p,{children:"x-api-token"})})]})]})})})})})]}),"\n",(0,i.jsxs)("div",{style:{display:"flex",flexDirection:"column",marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,i.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,i.jsx)(t.p,{children:"Contact"})}),(0,i.jsx)("span",{children:(0,i.jsx)(t.p,{children:(0,i.jsx)(t.a,{href:"mailto:api@opensignlabs.com",children:"api@opensignlabs.com"})})})]}),"\n",(0,i.jsxs)("div",{style:{marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,i.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,i.jsx)(t.p,{children:"Terms of Service"})}),(0,i.jsx)("a",{href:"http://www.opensignlabs.com/terms/",children:"http://www.opensignlabs.com/terms/"})]}),"\n",(0,i.jsxs)("div",{style:{marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,i.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,i.jsx)(t.p,{children:"License"})}),(0,i.jsx)("a",{href:"http://github.com/opensignlabs/opensign/LICENSE",children:(0,i.jsx)(t.p,{children:"AGPL v3.0"})})]})]})}function f(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(m,{...e})}):m(e)}},69016(e,t,n){"use strict";var o=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});const i=o(n(96540)),s=o(n(4213));t.default=function({url:e,proxy:t}){return i.default.createElement("div",{style:{float:"right"},className:"dropdown dropdown--hoverable dropdown--right"},i.default.createElement("button",{className:"export-button button button--sm button--secondary"},"Export"),i.default.createElement("ul",{className:"export-dropdown dropdown__menu"},i.default.createElement("li",null,i.default.createElement("a",{onClick:t=>{t.preventDefault(),(e=>{let t;(e.endsWith("json")||e.endsWith("yaml")||e.endsWith("yml"))&&(t=e.substring(e.lastIndexOf("/")+1)),s.default.saveAs(e,t||"openapi.txt")})(`${e}`)},className:"dropdown__link",href:`${e}`},"OpenAPI Spec"))))}},43905(e,t,n){"use strict";var o=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0}),t.default=function(e){const{colorMode:t}=(0,s.useColorMode)(),{logo:n,darkLogo:o}=e,l=()=>"dark"===t?o?.altText??n?.altText:n?.altText,c=(0,a.default)(n?.url),d=(0,a.default)(o?.url);if(n&&o)return i.default.createElement(r.default,{alt:l(),sources:{light:c,dark:d},className:"openapi__logo"});if(n||o)return i.default.createElement(r.default,{alt:l(),sources:{light:c??d,dark:c??d},className:"openapi__logo"});return};const i=o(n(96540)),s=n(83262),a=o(n(86025)),r=o(n(15626))},4213(e,t){var n,o,i;o=[],void 0===(i="function"==typeof(n=function(){"use strict";function t(e,t){return void 0===t?t={autoBom:!1}:"object"!=typeof t&&(console.warn("Deprecated: Expected third argument to be a object"),t={autoBom:!t}),t.autoBom&&/^\s*(?:text\/\S*|application\/xml|\S*\/\S*\+xml)\s*;.*charset\s*=\s*utf-8/i.test(e.type)?new Blob(["\ufeff",e],{type:e.type}):e}function n(e,t,n){var o=new XMLHttpRequest;o.open("GET",e),o.responseType="blob",o.onload=function(){r(o.response,t,n)},o.onerror=function(){console.error("could not download file")},o.send()}function o(e){var t=new XMLHttpRequest;t.open("HEAD",e,!1);try{t.send()}catch(e){}return 200<=t.status&&299>=t.status}function i(e){try{e.dispatchEvent(new MouseEvent("click"))}catch(n){var t=document.createEvent("MouseEvents");t.initMouseEvent("click",!0,!0,window,0,0,0,80,20,!1,!1,!1,!1,0,null),e.dispatchEvent(t)}}var s="object"==typeof window&&window.window===window?window:"object"==typeof self&&self.self===self?self:"object"==typeof globalThis&&globalThis.global===globalThis?globalThis:void 0,a=s.navigator&&/Macintosh/.test(navigator.userAgent)&&/AppleWebKit/.test(navigator.userAgent)&&!/Safari/.test(navigator.userAgent),r=s.saveAs||("object"!=typeof window||window!==s?function(){}:"download"in HTMLAnchorElement.prototype&&!a?function(e,t,a){var r=s.URL||s.webkitURL,l=document.createElement("a");t=t||e.name||"download",l.download=t,l.rel="noopener","string"==typeof e?(l.href=e,l.origin===location.origin?i(l):o(l.href)?n(e,t,a):i(l,l.target="_blank")):(l.href=r.createObjectURL(e),setTimeout(function(){r.revokeObjectURL(l.href)},4e4),setTimeout(function(){i(l)},0))}:"msSaveOrOpenBlob"in navigator?function(e,s,a){if(s=s||e.name||"download","string"!=typeof e)navigator.msSaveOrOpenBlob(t(e,a),s);else if(o(e))n(e,s,a);else{var r=document.createElement("a");r.href=e,r.target="_blank",setTimeout(function(){i(r)})}}:function(e,t,o,i){if((i=i||open("","_blank"))&&(i.document.title=i.document.body.innerText="downloading..."),"string"==typeof e)return n(e,t,o);var r="application/octet-stream"===e.type,l=/constructor/i.test(s.HTMLElement)||s.safari,c=/CriOS\/[\d]+/.test(navigator.userAgent);if((c||r&&l||a)&&"undefined"!=typeof FileReader){var d=new FileReader;d.onloadend=function(){var e=d.result;e=c?e:e.replace(/^data:[^;]*;/,"data:attachment/file;"),i?i.location.href=e:location=e,i=null},d.readAsDataURL(e)}else{var p=s.URL||s.webkitURL,u=p.createObjectURL(e);i?i.location=u:location.href=u,i=null,setTimeout(function(){p.revokeObjectURL(u)},4e4)}});s.saveAs=r.saveAs=r,e.exports=r})?n.apply(t,o):n)||(e.exports=i)}}]); \ No newline at end of file diff --git a/assets/js/23f866da.323d81b9.js b/assets/js/23f866da.323d81b9.js deleted file mode 100644 index 6ab7d9839..000000000 --- a/assets/js/23f866da.323d81b9.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[285],{97831(e,n,t){t.r(n),t.d(n,{assets:()=>y,contentTitle:()=>f,default:()=>w,frontMatter:()=>g,metadata:()=>i,toc:()=>j});const i=JSON.parse('{"id":"API-docs/v1.1/selfsign","title":"Self Sign","description":"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.","source":"@site/docs/API-docs/v1.1/selfsign.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/selfsign","permalink":"/docs/API-docs/v1.1/selfsign","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"selfsign","title":"Self Sign","description":"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.","sidebar_label":"Self Sign","hide_title":true,"hide_table_of_contents":true,"api":"eJztXF9zGzeS/yp9U1dlmzukRFp2fCqva71xduO7xHHFcqVyklcLzjRJWDPABMCI4qpYlYf9Bvd0VXcv+9HySa66AQxn+EeynGTXd8c8OOLgX6PRaHT/uoHrxImpTY5Pkxc6q0tUzibv0iRHmxlZOalVcpyczBAsFhMrpwqev34JU1RohEMLAt5++xW4mXCASowLtDAxiNYtCgSqL9UU9AQE5KH/AXyva8iEAlFYDVJlRZ0jaB5MFFAZ7Oc4kQpzmMt8is6mMJ/JbAZu5vtEw+0xlw60AbyqhMqhrrQCYUEh5pgP4GQmLVRGX8qcCY3U4FWFRqLKqLNSFsKA09z3Tz/+1xua4ve6NjTfn378b5gUeg5Scfk3FSquIKpqcKbO1ImsjuFtVWiRw0LXBl6/+EMzUeqVvp32ei9wXE/h7cte7939mXOVPT44oD50hYrIKsTYDjJdHuRUsconD2jKaJB69XMVVhYLEHmLKW6GCjJdLSDT2uRS0YqkUIkpgqrLMRqbAnGm1AZpDgIMinzRd7pfW4R/ffPNK5hoUwo3gNdFbdNmuFwazFyx8N3T3OOs7lkYC4uPj8A6I9U0hVJcEFulgx9qmV3QtC2qPDL1+euXzKte701dVdo4zOE7P4XjXo9Kfo/EY2GQ62e6LLWCShhRokNjvXRRscEfamlYLtwMRFFEXhyfqT70ekqUeNzrwVslf6gRZI7KyYlEQ7MER/LgGwx8fbeouP5LlcuMxZkIoK8ksp2qxFSq+qbCjLr0VVusBq2ClBIP58Kvf1WIzE/LoK0wc/ISux1fpbCgjl+g0pGCmTbyL1o5UfDyXaJxMhNFe5mJQN4OThhH7K+0VC5+DSM0O41WmxcxyCGRlhNzS6m4xCJciqJGG6iapzAjqr7FyqAlrRD7JcarHGYop7Od44n8fW1dp2OoLZHZpiKMFVeV2YvMtokoLIKcdHhZigtsjdZojAH8fgE5TkRduBQkSagzNQ7glXa0UwuZkWJiGaDNJlxtsM+rHMRn0BWf1yudkcvJBA1tZirkLkKbSB3JpVcyND3eaW4mFGi1ttCZLrTZFCH+3OUjZFo51pTPL4UsmHg/Wduoy3EhsosUxkWNKRjM/UZfYFHoeer3B1chheh5zvwhNU5SqBXRr3QYXlqwgapGccb9R4WNcqZBpG1zNezyiaaRiQVxSwKWQhYpMy6F93oMTroCU9rglVCLFHLhMAWHV26sr1LIZphdjPVV4NdEK2flX7bsulhyd66NUjhK4XEKT1IYHqYwHKUwPEph+DiF4ZMURocpjEYpjI5SGD32PB09CfwUDRPbBAxHnpPu0+PgTOZ4ToXnRP+5sA6NtBekduE7Ojv8iZ2nXu3hlSMl1hyy+eokkxZmMs9RwcToEgxmspKsFfyubrpOYVw7MES4sjCpi2IBl9LK1jybTvWcDnJ/tErTOlyzTNe0jsxFzzhm2WpZVbEgUk9QlJY5+oVyaCojLZLKVbbhgHIr+fEHGX1rb+QPWS3V1SS7VyyuQApG5FITN5xWKeRGV7meq3ASfiUt6046wmxzKs47p+JwAL1eo6/o25///OczdX2mAM4SUl9nyTGcJU2VsyT1ZXQqUdkw/L6iHw9Hn4WfC/r5ePQk/Jxz1eFR+Dmjn6PYNGygs+SYx+UKUjk/ctCT0KKAKi3P1DIQe6ZGPAsnyuqGGVDxr0s9NOTH04Y+0jGRxgLaZZv07Jixr7Ex24c0W6mkk6Kwuycca3xCc14jafu0V5U2Zn5EM2d9tXvaXPwJzblND5XwWeiL+OxsFUWNz1SMbmDRep+7dDC1Yitng5OPBsEU2c1IP4VPho8tcn4pNq51eXcuPiYu0pF5QkfmblY2p+onxM91mn4ppm7r9+6c/WzAxixbILv5Gip8QlztUvRL8XSz17tz9AlxlEy53eyk0k+Ily1yqCDYxb7s8Kg/fNQfHY6OOvwklMFXKMt+nvcXi8XPW4tSqnNPBzVq1S/F1faCAAA1hbwaN6ytr7e2XGRWhvmSZRmdRW/aCofeQt5EAthRX9UKrgv/Hb3nr8lnHkd3EvMIOzWORQPWtB1ep3OxuGd9V7Fp40NR/XUL2JPJRUQHA1fZTMssEE91ouc0JmxmQDzo89Id5PlBa+noY573y7K/9pF+9nmlWx/LcpDng7WaG+LgP5aQ5ylsft76Pc+hLMsdn/33zueDstycxaAsA22Be1HCNta5lEqWNflBhIF5d5oqkisR2FuGtZQKer3vv//++/7XX/dfvOj14hqGIYKstmAHP4K4+oVGaAt9r3cMLyfQ/sSuvwddeK837h+5NU2FmZ6r6PUEADavCf2LVT30U4oFd4bSzdB0x9FmJbLkI5JLNdZuNoC37ELS39HValwidpf+hdRj8HF3a8hQ4e+lJFe6sDvwjQqU0FfyXTeVT0eDbhg/UTFV260jg9O6EAavCKuzUqsNzfcxJ93dTrE1tRhleYWZMAoYcFiMkAXc/yZ42g8aMHBtLtTbc8hq6xh4mOIVVMI5NIo7uxSFzAXvjz5/wCtRVgSSHPzp7Cz/zT8fMAxLSKfzuEEup5LQ84M/nT7v//u7LTXqqkKTCYtQII1kU0CXDeB0hkW1AvDn8/lg/tBmM60Lj96/twYn/t9zPX5/zuRWA2GrB9tm6oWhBXuSsKyjnrw5WxwTFmLLLcAnLw3vmuEh22kBj7jBUAs1PiHrYo0kKvQYMhWf0gHPJiwJL67+1qRzzpJ3q+OeoU7Mb2n77gO2J+2GQoyx2Cy6+9YqxELXYUdHaL871SDRLb4Fg6dBb3k6h2mrUFytFfqy5ZZ96hnS3qbxtI/bM64AFNI2B0mHne3WAeDnMA0F30hsxwixAYwbKf3Zu6Ah7MO2QURBee1uGYLqAVdsgisNnnrzCJ2F2TjJg60Qo0STptfIsniQt/lFLWuLZmUm3DBCsBV2j0Ahmd0DnKkhY42yFNMbXBAu/oS0RJueHXCVr7Hhbw0ZlPTsugFk4fKbJzw87Ez4UXfCjw8/wpzoDHsjK1o2w2FL55iyLsSGBZBjJktRcDyShx79DA22Ba9Zp/pj7IdAO8n357qsauflO1gO5Jmwjo+CHgNxPgTxmxT6KfRSOEjhfgoPBvAtcugua8J8Qe6l8cE8qSDXNeH5WW2KBYwN8SYFHEwHcH39Qy2Uk26xXEIPrq8p3WG5HJCmuFB67iN9pxTbcECR+pVdkOvMbons68wekAFx8Arn/ZhscRBIewD39ZpmvNGaCizYUKedZaamrxql4O0ejvxKWxViAWJC4Q4fHeRmPog8IA4cwwh++wyGo8HhYQqH/m+4H8cfPeCNxHh3hsVNYDcX37aNDtvbaPVzm954dPhB+6g97Eca5dTFOceieNztxvpWDfQJGueryazDAa1zg3jmjww703WR06lh0NVGYZPPEU6NJE10RUlAUquXeXKcxAShJGVeo3W/1/kiOb5OQmCW/gxBNGp08N5SctF1YrMZloL+imtE6UgTWWCSJt7btEmaMHJJuUkkWslxosfvMXNJSl5RRWYUWuqD2x1fx1o+SSVJAwKVHCc+eyVJk+ApNJ8AVaYJdqnySbKMA97UVfNl1ZXlP5ogJ/VDeR0f2c0rarpcS8f6qJ5etHrguZV4oknLFujwhVjYVr9eIJL1LDBqQ0KQhVaQi4Ull722XjoyUWR1Qc4+XlXSLBqkixGmhiUtepuRGnqHj5Zx0VsU7Vhro+++QBlqYgDHae7a9r3GMeLvwgdS67y+orwzFe81whh5bauZVnduPxw9HI6GD4cj6iFg0HftIx5R1MV7PT7/KHnP8ZLah2Os1VoYIxZJmkiHpb19KX3p5thdEXxOAXfMo8fRX4WeUx+THdy2G2J95ryY4u1if7Irz6uVehK0pagqFGbA6VYfnfnX3UmNATS4Zd8s0+Tq9slcQab7MYkM7hc4cR7ugEwbheZBG77+ZCY3Ojpapsni9ukt/ldO7zNavPnts/uOs+9WmYn/CFofPlmmyex2Wr9s8gP/gcQePV6uzvEkMygcOiwr6uR8rPPFedRby3bFaMnEE8tXDYfSkkYscjRk9Gzqq5WqoZqUB3u+ftSMtS5QqC2KppOGJEjXWYYoCAAJBtt8huwDNcgF924byCXAJd5qCtGCDgIrLVnnpsazZEDBgJWHxaDHeiZUrMuZUErDPR7v3Nasxu8dhN/EoXvtnF1Ki1zFrSIJXBniElA2blEQ3WRBDKD5j63LhpNEQDyx48C3HxWfe8SYBwyNuhmgEKzUAXwuVJMh2M3rguvrRghYOpZLuL6mVUVzTuf+cpmuPtBYnQ98tPsvBjOUl51WzSdcNWy+tZp6Y4qjKP5DOO/bBIRIS21CP2RzLpeDjkCuEQ4zxtCYB5g3ckYZeJuzbkwmXukP5v4Gs4MEUCf/b/j+tHr2pdxCytOD6tnT6tl3lO9dod97nj0TqXK/8+dYFAN4ap3RavpsjQVPD8L37Utp8FLinDcur+qql3XeNh0NAk10AaK1eNJCZupMioJDJUZnGJPw2YGkzFHrsLIEy0rnA3+crsuWv5gaRE75JFpE7Ti/nZ3AOOBTATODk9/eW+PpvWecEkoAy9MD8SzUfumR25m4RBBqATxxBrC18Qj0pDasJrNCGDkJHmcKVYEU1iGHVGQeUfYcjXSczIS6sOnTsXlGyaVNUupPf/0b1eBtwEmzJ7o2H6DTGWju+7UNmays83wnIGBac6TfEZ+ieuKI0yqnXCrrTO2x3xh2bUdpeT2sHYSs+T7hOz5NdYbt/lNAZX1zARMGDVKolaTUWVNXJDmbV2Q6oswDLMm/9/dDaI1u1wXd5G26LuSvtrSCyfEciB1juM0TXM3m4kBMHV6f+taDN+yT2wmkQ5IRwQD7V2isViRL2kyFCqLqDX9tyXGbicJX9ftVUp4ER8Mp/3yrk/XTX//Womun97lJmB9B5DnBR7dQyMgN4TOWIX+DVbEAp7sUUX9ofrduaxF1JZopnmfklfGewQ+Q8F6PZLzXg77Pow7ibWt/EcLFOz28jrSkq96Jb0H/N7kuEVzIO1epBvClnuMlCWzYwqRoff+aEF6mPCSyt0fIhOJEA9rnZJ1Qx02OCyWpr4bwmdks4jyboGQovOvH4zsoNE5605yiKDdJPILvnoXRY2Y9TY6QKhCF5vxx17rdlneJesnXC2asCjhZg0JQfpx4r4dT6X/68T/pvltEvW1j3m0tZQuNb+BxxkW712itxYs4g649FrWA0k5OFudanTcnhd0qMN2WNwpQa4+zua6DbghnJ9BNON4QPHjQ66RPFElHuOQXUk9sR2dsrO/uwYghv9CABOAdw7c4FSYvmg3sl9Hx7TnRFiQ/1C5p4ONzh9gJ50Q2Q76tkGNF9++0gnsrB6RlndN6EvyB6pyx5w+BbYKGWrZW8zSh20cM9+ZJ6rHr5N0yTcZZ9rE9kvLq4Gspfxp1vm3cTx1nGdwfF5LYI8xY+1uRD47hLetCkdM+5DOnK0zdRfXMZ3XSOWzI+olaiVl3m6vovckVmB0cGLoBqJX1m2R0eEj/687jRUcc6TyuMzrf+B7NPyXphyPpN4Nt/vN2B/Ym9Gz2Xo7+cpVdjl7Tsu04/G/sIDj7tSnoEipxrt/sFz6EWryVqpAKzyPbzkeHh+dD4u0yTY62se+NLtHryTkxcU4mbXNgOLMAMSWNT66n+QW5icZoczMWcDfKbmLCUYcJjzaZ8FJxAglf0z7RF6j+vjNtD+/88ETqVcmy4u2xRPpKXJ50Jtv+7idpMauNdIvk+PQ6ueqLSvZ9+fHpu+U7slncTFP8qdKWKRZulhwnB61wlEVzSTEk6oGFtpFDK1RO+R0bwJOo5MHlcDBMlul6m61A1Q31se7ftYl1YirV9LZ271bceUMr6Bepw6OVFq7kvyGp4bAE7VppIklyZihyArgoHGC1+nYVxPsiLm8Mr22LmLWU4loMLIbAOlGtdR2+JU61PUw1fNQOEPkQEEd1mqDOtjhNM/EYeWkCL61YSiuUsoqOdIIjHO9ohTtOV3uhiSzEwMKQEfnR0RFD158NGeN9+ITh06PHy3cdJDFJumghh6jXMa+fB+F0EZw9LPF/CJboohLBzO566VHAGq+445que6Y7vcStTmIYcLtDEArb1uZ2yzEYjh9qBC5JbU0067iwOZsrxHT6sI7cCKFgkemyucHb67U42bTq9Rrd5aWBLPlvagOVnqOZ1P5a8KTAK77XTM2w5LIVXI+iJHu/WADhK1P2/TgDRxQNepGJSoxlIel4pWo6yOXqhLYDuqgdAf97xqcAXWJBpzKJrC4FoyONsTrX5oKeLKGXP2BMqVHkdaCaCZV5hMIfGCnJJDk3q4vT1hmiWnratHKGhLEUSkx5m6RtsYMcC9IaFoweUwKj1UXthd0JWWjjUwJ4QiT6lpn4xVVFRRwHIlVrcEbydRlwKktX2+l6LS9zeLxkTLBxRbRIcludhloVmt4ZIci4LihriYwbUgN60qGRmjsjlCWbNGQhhDVoGBYgJLTBQXxrkVb4K6ku/E3sPpw2cvUdjq102M0BX98jD7pt/ijdl/WYXtLQVjptFqvWU+lm9ZhP9XYnzQ/f0x/DYzvQOrM/PNvsjXc07cHz1y/ZHnwAP/34H/AVCqNgpudeWrPaYLFo3vXxr8bwynu2NeYcg5SkK4njmRe+oOIjB7+bCcdowyvkl3P8lvJZSK/rcSEzOIkRILqR8jk7O62oUCdndSZIlC6lAAGVb11IdTGA52rBWNdK4dN3bteZBh8ycbn94zV5fOcgjjlYUUTfS4vFJdoWekRPDZFEz4yup360NjFhcgYn5F+G121obs/znEEXuXqrhjPwVuTgxD8ZggsfM2O06/VaEy5p3gkIUNkqXIIq58w9ewy5ERO36j9dgzj4uNn4FN+3iOxIQzfNkvidGGbcfPW40Jq92dW3jDfRgDzt1bpUMojTaRRL6F6uuLtY+0wYPkHZVwkHmajkVqyTHr+x30zeoLmUWfRNd+zoA658kKRJITNUFlu+zPM/vv4KLh8ODpO0ZcV/wOY++Orl51+8evMFEUOK1DNsODgcHDI6o60rhWqN9AaLCbzxJulaQljj3+2f6to/1bV/qmv/VNf+qa79U137p7r2T3Xtn+raP9W1f6pr/1TX/qmu/VNd+6e69k917Z/q2j/VtX+qa/9U1/6prv1TXfunuvZPde2f6to/1bV/qmv/VNf+qa79U12/npbYP9W1f6pr/1TX/qmuHfto/1TXr/5UV0hSJ0IOqkJI1brA429MnK4e8HqXJjO6THF8mlxfUwbJW8p5ps8/1GjoJsa7NLkURlKEje9hpPHyACXEXyCll3/uQ7z9Exo59VYhp2OtXT+h2w++xfMsw8rdWLd93+P1N29OKHk4vEdQ6pzaGDGnvGIx9xnPQfD4poDgJ1YKoaY15+cnvk+670AJjd3LEhd8WSL80Urzp8sBKwq7tyj8NOhfmtTWBtfX/iIGp+P7+r5oZ4vA2FibVu7dcrn8H0i5NDk=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Contact list","permalink":"/docs/API-docs/v1.1/contactlist"},"next":{"title":"Draft Document","permalink":"/docs/API-docs/v1.1/draftdocument"}}');var s=t(74848),r=t(28453),o=t(57742),l=t.n(o),a=t(78178),d=t.n(a),c=t(19624),p=t.n(c),h=t(96226),u=t.n(h),m=(t(77675),t(19365),t(51107)),x=t(21312);const g={id:"selfsign",title:"Self Sign",description:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.",sidebar_label:"Self Sign",hide_title:!0,hide_table_of_contents:!0,api:"eJztXF9zGzeS/yp9U1dlmzukRFp2fCqva71xduO7xHHFcqVyklcLzjRJWDPABMCI4qpYlYf9Bvd0VXcv+9HySa66AQxn+EeynGTXd8c8OOLgX6PRaHT/uoHrxImpTY5Pkxc6q0tUzibv0iRHmxlZOalVcpyczBAsFhMrpwqev34JU1RohEMLAt5++xW4mXCASowLtDAxiNYtCgSqL9UU9AQE5KH/AXyva8iEAlFYDVJlRZ0jaB5MFFAZ7Oc4kQpzmMt8is6mMJ/JbAZu5vtEw+0xlw60AbyqhMqhrrQCYUEh5pgP4GQmLVRGX8qcCY3U4FWFRqLKqLNSFsKA09z3Tz/+1xua4ve6NjTfn378b5gUeg5Scfk3FSquIKpqcKbO1ImsjuFtVWiRw0LXBl6/+EMzUeqVvp32ei9wXE/h7cte7939mXOVPT44oD50hYrIKsTYDjJdHuRUsconD2jKaJB69XMVVhYLEHmLKW6GCjJdLSDT2uRS0YqkUIkpgqrLMRqbAnGm1AZpDgIMinzRd7pfW4R/ffPNK5hoUwo3gNdFbdNmuFwazFyx8N3T3OOs7lkYC4uPj8A6I9U0hVJcEFulgx9qmV3QtC2qPDL1+euXzKte701dVdo4zOE7P4XjXo9Kfo/EY2GQ62e6LLWCShhRokNjvXRRscEfamlYLtwMRFFEXhyfqT70ekqUeNzrwVslf6gRZI7KyYlEQ7MER/LgGwx8fbeouP5LlcuMxZkIoK8ksp2qxFSq+qbCjLr0VVusBq2ClBIP58Kvf1WIzE/LoK0wc/ISux1fpbCgjl+g0pGCmTbyL1o5UfDyXaJxMhNFe5mJQN4OThhH7K+0VC5+DSM0O41WmxcxyCGRlhNzS6m4xCJciqJGG6iapzAjqr7FyqAlrRD7JcarHGYop7Od44n8fW1dp2OoLZHZpiKMFVeV2YvMtokoLIKcdHhZigtsjdZojAH8fgE5TkRduBQkSagzNQ7glXa0UwuZkWJiGaDNJlxtsM+rHMRn0BWf1yudkcvJBA1tZirkLkKbSB3JpVcyND3eaW4mFGi1ttCZLrTZFCH+3OUjZFo51pTPL4UsmHg/Wduoy3EhsosUxkWNKRjM/UZfYFHoeer3B1chheh5zvwhNU5SqBXRr3QYXlqwgapGccb9R4WNcqZBpG1zNezyiaaRiQVxSwKWQhYpMy6F93oMTroCU9rglVCLFHLhMAWHV26sr1LIZphdjPVV4NdEK2flX7bsulhyd66NUjhK4XEKT1IYHqYwHKUwPEph+DiF4ZMURocpjEYpjI5SGD32PB09CfwUDRPbBAxHnpPu0+PgTOZ4ToXnRP+5sA6NtBekduE7Ojv8iZ2nXu3hlSMl1hyy+eokkxZmMs9RwcToEgxmspKsFfyubrpOYVw7MES4sjCpi2IBl9LK1jybTvWcDnJ/tErTOlyzTNe0jsxFzzhm2WpZVbEgUk9QlJY5+oVyaCojLZLKVbbhgHIr+fEHGX1rb+QPWS3V1SS7VyyuQApG5FITN5xWKeRGV7meq3ASfiUt6046wmxzKs47p+JwAL1eo6/o25///OczdX2mAM4SUl9nyTGcJU2VsyT1ZXQqUdkw/L6iHw9Hn4WfC/r5ePQk/Jxz1eFR+Dmjn6PYNGygs+SYx+UKUjk/ctCT0KKAKi3P1DIQe6ZGPAsnyuqGGVDxr0s9NOTH04Y+0jGRxgLaZZv07Jixr7Ex24c0W6mkk6Kwuycca3xCc14jafu0V5U2Zn5EM2d9tXvaXPwJzblND5XwWeiL+OxsFUWNz1SMbmDRep+7dDC1Yitng5OPBsEU2c1IP4VPho8tcn4pNq51eXcuPiYu0pF5QkfmblY2p+onxM91mn4ppm7r9+6c/WzAxixbILv5Gip8QlztUvRL8XSz17tz9AlxlEy53eyk0k+Ily1yqCDYxb7s8Kg/fNQfHY6OOvwklMFXKMt+nvcXi8XPW4tSqnNPBzVq1S/F1faCAAA1hbwaN6ytr7e2XGRWhvmSZRmdRW/aCofeQt5EAthRX9UKrgv/Hb3nr8lnHkd3EvMIOzWORQPWtB1ep3OxuGd9V7Fp40NR/XUL2JPJRUQHA1fZTMssEE91ouc0JmxmQDzo89Id5PlBa+noY573y7K/9pF+9nmlWx/LcpDng7WaG+LgP5aQ5ylsft76Pc+hLMsdn/33zueDstycxaAsA22Be1HCNta5lEqWNflBhIF5d5oqkisR2FuGtZQKer3vv//++/7XX/dfvOj14hqGIYKstmAHP4K4+oVGaAt9r3cMLyfQ/sSuvwddeK837h+5NU2FmZ6r6PUEADavCf2LVT30U4oFd4bSzdB0x9FmJbLkI5JLNdZuNoC37ELS39HValwidpf+hdRj8HF3a8hQ4e+lJFe6sDvwjQqU0FfyXTeVT0eDbhg/UTFV260jg9O6EAavCKuzUqsNzfcxJ93dTrE1tRhleYWZMAoYcFiMkAXc/yZ42g8aMHBtLtTbc8hq6xh4mOIVVMI5NIo7uxSFzAXvjz5/wCtRVgSSHPzp7Cz/zT8fMAxLSKfzuEEup5LQ84M/nT7v//u7LTXqqkKTCYtQII1kU0CXDeB0hkW1AvDn8/lg/tBmM60Lj96/twYn/t9zPX5/zuRWA2GrB9tm6oWhBXuSsKyjnrw5WxwTFmLLLcAnLw3vmuEh22kBj7jBUAs1PiHrYo0kKvQYMhWf0gHPJiwJL67+1qRzzpJ3q+OeoU7Mb2n77gO2J+2GQoyx2Cy6+9YqxELXYUdHaL871SDRLb4Fg6dBb3k6h2mrUFytFfqy5ZZ96hnS3qbxtI/bM64AFNI2B0mHne3WAeDnMA0F30hsxwixAYwbKf3Zu6Ah7MO2QURBee1uGYLqAVdsgisNnnrzCJ2F2TjJg60Qo0STptfIsniQt/lFLWuLZmUm3DBCsBV2j0Ahmd0DnKkhY42yFNMbXBAu/oS0RJueHXCVr7Hhbw0ZlPTsugFk4fKbJzw87Ez4UXfCjw8/wpzoDHsjK1o2w2FL55iyLsSGBZBjJktRcDyShx79DA22Ba9Zp/pj7IdAO8n357qsauflO1gO5Jmwjo+CHgNxPgTxmxT6KfRSOEjhfgoPBvAtcugua8J8Qe6l8cE8qSDXNeH5WW2KBYwN8SYFHEwHcH39Qy2Uk26xXEIPrq8p3WG5HJCmuFB67iN9pxTbcECR+pVdkOvMbons68wekAFx8Arn/ZhscRBIewD39ZpmvNGaCizYUKedZaamrxql4O0ejvxKWxViAWJC4Q4fHeRmPog8IA4cwwh++wyGo8HhYQqH/m+4H8cfPeCNxHh3hsVNYDcX37aNDtvbaPVzm954dPhB+6g97Eca5dTFOceieNztxvpWDfQJGueryazDAa1zg3jmjww703WR06lh0NVGYZPPEU6NJE10RUlAUquXeXKcxAShJGVeo3W/1/kiOb5OQmCW/gxBNGp08N5SctF1YrMZloL+imtE6UgTWWCSJt7btEmaMHJJuUkkWslxosfvMXNJSl5RRWYUWuqD2x1fx1o+SSVJAwKVHCc+eyVJk+ApNJ8AVaYJdqnySbKMA97UVfNl1ZXlP5ogJ/VDeR0f2c0rarpcS8f6qJ5etHrguZV4oknLFujwhVjYVr9eIJL1LDBqQ0KQhVaQi4Ull722XjoyUWR1Qc4+XlXSLBqkixGmhiUtepuRGnqHj5Zx0VsU7Vhro+++QBlqYgDHae7a9r3GMeLvwgdS67y+orwzFe81whh5bauZVnduPxw9HI6GD4cj6iFg0HftIx5R1MV7PT7/KHnP8ZLah2Os1VoYIxZJmkiHpb19KX3p5thdEXxOAXfMo8fRX4WeUx+THdy2G2J95ryY4u1if7Irz6uVehK0pagqFGbA6VYfnfnX3UmNATS4Zd8s0+Tq9slcQab7MYkM7hc4cR7ugEwbheZBG77+ZCY3Ojpapsni9ukt/ldO7zNavPnts/uOs+9WmYn/CFofPlmmyex2Wr9s8gP/gcQePV6uzvEkMygcOiwr6uR8rPPFedRby3bFaMnEE8tXDYfSkkYscjRk9Gzqq5WqoZqUB3u+ftSMtS5QqC2KppOGJEjXWYYoCAAJBtt8huwDNcgF924byCXAJd5qCtGCDgIrLVnnpsazZEDBgJWHxaDHeiZUrMuZUErDPR7v3Nasxu8dhN/EoXvtnF1Ki1zFrSIJXBniElA2blEQ3WRBDKD5j63LhpNEQDyx48C3HxWfe8SYBwyNuhmgEKzUAXwuVJMh2M3rguvrRghYOpZLuL6mVUVzTuf+cpmuPtBYnQ98tPsvBjOUl51WzSdcNWy+tZp6Y4qjKP5DOO/bBIRIS21CP2RzLpeDjkCuEQ4zxtCYB5g3ckYZeJuzbkwmXukP5v4Gs4MEUCf/b/j+tHr2pdxCytOD6tnT6tl3lO9dod97nj0TqXK/8+dYFAN4ap3RavpsjQVPD8L37Utp8FLinDcur+qql3XeNh0NAk10AaK1eNJCZupMioJDJUZnGJPw2YGkzFHrsLIEy0rnA3+crsuWv5gaRE75JFpE7Ti/nZ3AOOBTATODk9/eW+PpvWecEkoAy9MD8SzUfumR25m4RBBqATxxBrC18Qj0pDasJrNCGDkJHmcKVYEU1iGHVGQeUfYcjXSczIS6sOnTsXlGyaVNUupPf/0b1eBtwEmzJ7o2H6DTGWju+7UNmays83wnIGBac6TfEZ+ieuKI0yqnXCrrTO2x3xh2bUdpeT2sHYSs+T7hOz5NdYbt/lNAZX1zARMGDVKolaTUWVNXJDmbV2Q6oswDLMm/9/dDaI1u1wXd5G26LuSvtrSCyfEciB1juM0TXM3m4kBMHV6f+taDN+yT2wmkQ5IRwQD7V2isViRL2kyFCqLqDX9tyXGbicJX9ftVUp4ER8Mp/3yrk/XTX//Womun97lJmB9B5DnBR7dQyMgN4TOWIX+DVbEAp7sUUX9ofrduaxF1JZopnmfklfGewQ+Q8F6PZLzXg77Pow7ibWt/EcLFOz28jrSkq96Jb0H/N7kuEVzIO1epBvClnuMlCWzYwqRoff+aEF6mPCSyt0fIhOJEA9rnZJ1Qx02OCyWpr4bwmdks4jyboGQovOvH4zsoNE5605yiKDdJPILvnoXRY2Y9TY6QKhCF5vxx17rdlneJesnXC2asCjhZg0JQfpx4r4dT6X/68T/pvltEvW1j3m0tZQuNb+BxxkW712itxYs4g649FrWA0k5OFudanTcnhd0qMN2WNwpQa4+zua6DbghnJ9BNON4QPHjQ66RPFElHuOQXUk9sR2dsrO/uwYghv9CABOAdw7c4FSYvmg3sl9Hx7TnRFiQ/1C5p4ONzh9gJ50Q2Q76tkGNF9++0gnsrB6RlndN6EvyB6pyx5w+BbYKGWrZW8zSh20cM9+ZJ6rHr5N0yTcZZ9rE9kvLq4Gspfxp1vm3cTx1nGdwfF5LYI8xY+1uRD47hLetCkdM+5DOnK0zdRfXMZ3XSOWzI+olaiVl3m6vovckVmB0cGLoBqJX1m2R0eEj/687jRUcc6TyuMzrf+B7NPyXphyPpN4Nt/vN2B/Ym9Gz2Xo7+cpVdjl7Tsu04/G/sIDj7tSnoEipxrt/sFz6EWryVqpAKzyPbzkeHh+dD4u0yTY62se+NLtHryTkxcU4mbXNgOLMAMSWNT66n+QW5icZoczMWcDfKbmLCUYcJjzaZ8FJxAglf0z7RF6j+vjNtD+/88ETqVcmy4u2xRPpKXJ50Jtv+7idpMauNdIvk+PQ6ueqLSvZ9+fHpu+U7slncTFP8qdKWKRZulhwnB61wlEVzSTEk6oGFtpFDK1RO+R0bwJOo5MHlcDBMlul6m61A1Q31se7ftYl1YirV9LZ271bceUMr6Bepw6OVFq7kvyGp4bAE7VppIklyZihyArgoHGC1+nYVxPsiLm8Mr22LmLWU4loMLIbAOlGtdR2+JU61PUw1fNQOEPkQEEd1mqDOtjhNM/EYeWkCL61YSiuUsoqOdIIjHO9ohTtOV3uhiSzEwMKQEfnR0RFD158NGeN9+ITh06PHy3cdJDFJumghh6jXMa+fB+F0EZw9LPF/CJboohLBzO566VHAGq+445que6Y7vcStTmIYcLtDEArb1uZ2yzEYjh9qBC5JbU0067iwOZsrxHT6sI7cCKFgkemyucHb67U42bTq9Rrd5aWBLPlvagOVnqOZ1P5a8KTAK77XTM2w5LIVXI+iJHu/WADhK1P2/TgDRxQNepGJSoxlIel4pWo6yOXqhLYDuqgdAf97xqcAXWJBpzKJrC4FoyONsTrX5oKeLKGXP2BMqVHkdaCaCZV5hMIfGCnJJDk3q4vT1hmiWnratHKGhLEUSkx5m6RtsYMcC9IaFoweUwKj1UXthd0JWWjjUwJ4QiT6lpn4xVVFRRwHIlVrcEbydRlwKktX2+l6LS9zeLxkTLBxRbRIcludhloVmt4ZIci4LihriYwbUgN60qGRmjsjlCWbNGQhhDVoGBYgJLTBQXxrkVb4K6ku/E3sPpw2cvUdjq102M0BX98jD7pt/ijdl/WYXtLQVjptFqvWU+lm9ZhP9XYnzQ/f0x/DYzvQOrM/PNvsjXc07cHz1y/ZHnwAP/34H/AVCqNgpudeWrPaYLFo3vXxr8bwynu2NeYcg5SkK4njmRe+oOIjB7+bCcdowyvkl3P8lvJZSK/rcSEzOIkRILqR8jk7O62oUCdndSZIlC6lAAGVb11IdTGA52rBWNdK4dN3bteZBh8ycbn94zV5fOcgjjlYUUTfS4vFJdoWekRPDZFEz4yup360NjFhcgYn5F+G121obs/znEEXuXqrhjPwVuTgxD8ZggsfM2O06/VaEy5p3gkIUNkqXIIq58w9ewy5ERO36j9dgzj4uNn4FN+3iOxIQzfNkvidGGbcfPW40Jq92dW3jDfRgDzt1bpUMojTaRRL6F6uuLtY+0wYPkHZVwkHmajkVqyTHr+x30zeoLmUWfRNd+zoA658kKRJITNUFlu+zPM/vv4KLh8ODpO0ZcV/wOY++Orl51+8evMFEUOK1DNsODgcHDI6o60rhWqN9AaLCbzxJulaQljj3+2f6to/1bV/qmv/VNf+qa79U137p7r2T3Xtn+raP9W1f6pr/1TX/qmu/VNd+6e69k917Z/q2j/VtX+qa/9U1/6prv1TXfunuvZPde2f6to/1bV/qmv/VNf+qa79U12/npbYP9W1f6pr/1TX/qmuHfto/1TXr/5UV0hSJ0IOqkJI1brA429MnK4e8HqXJjO6THF8mlxfUwbJW8p5ps8/1GjoJsa7NLkURlKEje9hpPHyACXEXyCll3/uQ7z9Exo59VYhp2OtXT+h2w++xfMsw8rdWLd93+P1N29OKHk4vEdQ6pzaGDGnvGIx9xnPQfD4poDgJ1YKoaY15+cnvk+670AJjd3LEhd8WSL80Urzp8sBKwq7tyj8NOhfmtTWBtfX/iIGp+P7+r5oZ4vA2FibVu7dcrn8H0i5NDk=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},f=void 0,y={},j=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Self Sign"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/selfsign",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Unique identifier for this widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Specify the hint for widgets. This parameter is optional and is not applicable to the following widgets: checkbox, radio button, dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options":{\n "hint": "Provide signature"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp",\n "hint": "Provide stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials",\n "hint": "Provide initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide email",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide name",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide job title",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide company",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12,\n "min_date": "",\n "max_date": "",\n "signing_date": false,\n "hint": "Provide date"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"min_date:"})," Provide the minimum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"max_date:"})," Provide the maximum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"signing_date"}),": If signing_date is set to true, the signing date is shown to the signer during signing. You may set either signing_date or default, but not both. Using both is not supported."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image",\n "hint": "Provide image"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "default": 0,\n "formula": "",\n "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hint": "Provide number",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,s.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"decimalplaces:"})," Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"cells"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "cells",\n "page": 1,\n "x": 100,\n "y": 100,\n "w": 114,\n "h": 50,\n "options": {\n "name": "cells",\n "required": true,\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"cell_count:"})," Specify the number of cells that should be returned to the user."]}),"\n"]}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(x.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{...t(27471)}),"\n",(0,s.jsx)(u(),{...t(16737)})]})}function w(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}},27471(e){e.exports=JSON.parse('{"title":"Body","body":{"content":{"application/json":{"schema":{"required":["file","signers","title"],"type":"object","properties":{"file":{"type":"string","format":"base64","example":"base64 encoded pdf"},"title":{"type":"string","format":"string","example":"sample document"},"note":{"type":"string","format":"string","example":"sample Note"},"description":{"type":"string","format":"string","example":"sample Description"},"timeToCompleteDays":{"type":"number","description":"time to complete days is used to calculate expiry date of your document","format":"number","example":15},"signer":{"type":"object","properties":{"role":{"type":"string","format":"string","example":"ceo"},"email":{"type":"string","format":"string","example":"joebee@example.com"},"name":{"type":"string","format":"string","example":"joe bee"},"phone":{"type":"string","format":"string","example":"123121312"},"company":{"type":"string","format":"string","example":"opensign"},"job_title":{"type":"string","format":"string","example":"dev"},"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Allowed values - signature, stamp.","format":"string","example":"signature"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":244},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":71},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":38},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":46}},"title":"createtemplate_body_widgets"}}},"title":"selfsigndocument_body_signer"},"folderId":{"type":"string","example":""},"send_email":{"type":"boolean","description":"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \\"true\\". If the value of this parameter is \\"true\\" and no \'email_subject\'/\'email_body\' parameters are specified default email templates will be used. \\n","example":true},"email_subject":{"type":"string","description":"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.","example":"{{sender_name}} has requested you to sign {{document_title}}"},"email_body":{"type":"string","description":"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.","example":"

Hi {{receiver_name}},

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

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

Sign here

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

Thanks,
Team OpenSign\u2122

"},"enableTour":{"type":"boolean","description":"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.","example":false},"redirect_url":{"type":"string","description":"Specifies the URL where the signer will be redirected upon completing the document signing process.","example":""},"sender_name":{"type":"string","description":"The name of the person or organization on whose behalf the email is being sent.","example":"opensign\u2122"},"sender_email":{"type":"string","description":"The email address of the person or organization that users can reply to.","example":"mailer@opensignlabs.com"},"merge_certificate":{"type":"boolean","description":"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\\n\\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\\n\\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\\n","example":false},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed.\\n"}},"title":"selfsigndocument_body"}}},"required":true}}')},16737(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Document created successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"hji2zxcv2P"},"url":{"type":"string","format":"string","example":"https://url-to-sign-document.com"}},"title":"inline_response_200_1"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/23f866da.76453913.js b/assets/js/23f866da.76453913.js new file mode 100644 index 000000000..3e6e0ae68 --- /dev/null +++ b/assets/js/23f866da.76453913.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[285],{97831(e,n,t){t.r(n),t.d(n,{assets:()=>x,contentTitle:()=>f,default:()=>j,frontMatter:()=>y,metadata:()=>i,toc:()=>w});const i=JSON.parse('{"id":"API-docs/v1.1/selfsign","title":"Self Sign","description":"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.","source":"@site/docs/API-docs/v1.1/selfsign.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/selfsign","permalink":"/docs/API-docs/v1.1/selfsign","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"selfsign","title":"Self Sign","description":"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.","sidebar_label":"Self Sign","hide_title":true,"hide_table_of_contents":true,"api":"eJztPO1yG0dyr9JZpyIRtwBIiJYdnk45WdLZSmxZJVJROaSOHOwOgBF3Z9YzswBxFKr84yoPkMqfVCV/7iXyP4/iJ0l1zwd2AZAUZZ9Pl8BVtomdr56enp7+vkwsG5vk4Dh5orK65NKa5E2a5NxkWlRWKJkcJEcTDoYXIyPGEh69eAZjLrlmlhtg8Orl12AnzAKXbFhwAyPNubHzggP2F3IMagQMcj9/D75TNWRMAiuMAiGzos45KFqMFVBp3s35SEiew0zkY25NCrOJyCZgJ25Ormk8z4UFpYFfVEzmUFdKAjMgOc953oOjiTBQaTUVOQEaoOEXFdeCywwnK0XBNFhFc//4w38e4ha/U7XG/f74w3/BqFAzEJLav624pA6sqnon8kQeieoAXlWFYjnMVa3hxZPfxY3irPjtuNN5wof1GF4963Te3J1YW5mDfh/nUBWXCFbBhqaXqbKfY8cqH+3glrnmOKvbKzOimAPLG0ixEy4hU9UcMqV0LiSeSAoVG3OQdTnk2qSAmCmV5rgHBpqzfN61qlsbDv94+O1zGCldMtuDF0Vt0rhcLjTPbDF30+Pew67uGBgyw+/vg7FayHEKJTtHtAoL39ciO8dtGy7zgNRHL54Rrjqdw7qqlLY8h9duCwedDrZ8wRHHTHPqn6myVBIqplnJLdfGURc2a/59LTTRhZ0AK4qAi4MT2YVOR7KSH3Q68EqK72sOIufSipHgGncJFunBDei5/nZeUf9nMhcZkTMCgF+RZFtdEanY9bDiGU7pujZQDUp6KkUczpg7/6pgmduW5qbimRVT3p74IoU5TvyESxUgmCgt/qCkZQUd35RrKzJWNI8ZAaTrYJm2iP5KCWnDV79CvGl42nSIng4RtByRWwpJLYbDlBU1Nx6qWQoThOolrzQ3yBXCvIh4mcOEi/HkyvVY/rY2tjUx1AbBbELh1wqnSujlhLYRKwwHMWrhsmTnvLFa5Bg9+GIOOR+xurApCKRQq2veg+fK4k0tRIaMiWgALxuzteZdOmVPPr02+bxY8oxcjEZc42XGRprCjwnQIV06JoPbo5tmJ0yCkisHnalC6XUSos9tPEKmpCVO+WjKREHAu82ayC6HBcvOUxgWNU9B89xd9DkvCjVL3f2gLsgQHc4JP8jGkQqVRPil8ssLA8ZDFRlnuH/YGJkzLiJME6v+lo8UrowoCFcSeMlEkRLiUnirhmCFLXiKF7xicp5CzixPwfILO1QXKWQTnp0P1YXH10hJa8QfNty60HJ7rA1S2E/hfgqfp7C3m8LeIIW9/RT27qew93kKg90UBoMUBvspDO47nA4+9/hkEYlNAPYGDpP248PgROT8FBtPEf5TZizXwpwj24XX+Ha4FztPHdvjFxaZWHxk8+VLJgxMRJ5zCSOtStA8E5UgruBudZw6hWFtQSPg0sCoLoo5TIURjX3GSdUMH3L3tArdeFyzTNV4joRFhzhC2fJYZTFHUI84Kw1h9Km0XFdaGI4sV5qIAWmX9OMeMvzWvMjvc1qyzUmuPrFwAilolguF2LBKppBrVeVqJv1L+LUwxDvxCTPxVZy1XsW9HnQ6kV/ht7OzsxN5eSIBThJkXyfJAZwksctJkro2fJWwbc//vsAf9waf+Z9z/Hl/8Ln/OaOue/v+5wR/DsJQf4FOkgNalzoIad3Knk9CAwLstDiRCw/siRzQLiwrq2t2gM1/Xughgh9eG/yIz0QaGvCWrcNzxY5dj7Xd3sPdCimsYIW5esOhx0e05xWQNm972Wlt5/u4c+JXV2+bmj+iPTfhwRZ6C10TvZ2NpsDxCYrBNShanfMqHoyjSMpZw+SnPS+KXI1It4WPBo8NcH4uNK5MeXss3kcs4pN5hE/m1aiMr+pHhM9VmH4upG6a9/aY/axHwixJIFfj1Xf4iLDahujnwun6rLfH6OeIURTlrkYntn5EuGyAgw1eLnZtu/vdvU+7g93BfgufaGVwHcqym+fd+Xz+086iFPLUwYGDGv1LdrG5wRuAYiOdxjVn6/qtHBeKlX6/KFkGZdGJtsxyJyGvWwJIUV/28qoL/R20529QZx4GdZLnwewUFYtorGkqvFblbH7HuKnC0KhDYf9VCdiBSU0IBxmusokSmQce+wTNaYi2mR7ioEtH18/zfuPo8GOed8uyu/IRf3bppBsfy7KX572Vnmvk4D6WkOcprH/e+D3PoSzLKz67763P/bJc30WvLD1sHnuBwtbOuRRSlDXqQWgDc+o0dkRVwqO39GcpJHQ633333Xfdb77pPnnS6YQz9Et4Wm2YHdwK7OJnWqFJ9J3OATwbQfMTqf7O6EJ3Pap/qNbEDhM1k0Hr8QbYvEbrX+jqTD8lm9NkXNgJ1+11lF6SLOqIqFINlZ304BWpkPh3ULWiSkTq0t8je/Q67tUc0nf4pZjkkhe2F76WgaL1FXXXdebT4qBrwk9gTNVm6UjzcV0wzS/QVmeEkmuc70Neutu9YitsMdDy0mZCVkBvh+XBZAF3v/Wa9k40Bq7sBWd7BFltLBkexvwCKmYt15Imm7JC5IzuR5c+8AtWVmgk6f/+5CT/1d/2yQyLlk7r7Aa5GAu0nvd/f/yo+y9vNvSoq4rrjBkOBceVTArcZj04nvCiWhrwZ7NZb3bPZBOlCme9f2s0H7n/nqrh21MCt+oxU+1s2qkjhobZE4ll1epJl7OBMWYgjNxg+KSjoVuzt0tymrdHXCOo+R4fkXSxAhI2OhsyNh/jA08iLBIvX/6tkOecJG+Wzz2ZOnl+w9g373E98TYUbMiL9abbX62CzVXtb3Qw7be36im6gTcv8ETrLW1nN200souVRte22HBPHUKa1zS89uF6hhOAQpj4kLTQ2RztDfzkpkHnG5LtkEMYAMNIpT/5FkTA3u8aBCsond0NS2A/oI7RuRLtqdev0DqYtZfcywrBSzSKswaUhYe8iS8cWRuul2LCNSt4WeHqFdAlc/UCJ3KPbI2iZONrVBBq/oi4RBOeK8xVrseavrVHRkmHrmuMLNR+/Yb3dlsb/rS94fu7HyBOtJa9FhUNmWG3wXN0WRdsTQLIeSZKVpA/kpYe/AQOtsFeswr1h8gPHnak78eqrGrr6NtLDqiZEI8PhB4ccc4F8asUuil0UuincDeFnR685OS6y6Kbz9O90M6ZJyTkqkZ7flbrYg5DjbhJgffGPbi8/L5m0go7XyygA5eXGO6wWPSQU5xLNXOevmP0bVhAT/1SLshVZjZ49lVm+ihA9J/zWTcEW/Q9aDtwV61wxmulKY+CNXbaOmYc+jwyBSf3kOdXmKpgc2AjdHc47yANc07kHmLgAAbwm4ewN+jt7qaw6/6Gu2H9wQ5dJLJ3Z7y4zthNzTddo93mNVr+3MQ3Pt19r3vUXPYDhXKc4pR8UbTuZmF9Iwf6CIXz5WZWzQGNdwNx5p4MM1F1keOrobmtteQxnsO/GkmaqAqDgISSz/LkIAkBQklKuObGfqHyeXJwmXjHLP7pnWg4qP/WYHDRZWKyCS8Z/hXOCMORRqLgSZo4bdMkaUKWS4xNQtJKDhI1fMszm6SoFVUoRnGDc9C4g8vQywWpJKm3QCUHiYteSdLEawrxE3CZKTS7VPkoWaQ002nFjJkpnV87ZfyynBIncBDfcqChP6KXFOfBwJAPnOY5Dl2sxHN90ExPGjPQ3kp+pJBNF9zyJ2xuGvM6ikpWw8hwDFJR5kdBzuYGdf7aOPLKWJHVBVoL+EUl9DyayshEFVHSgDeuFOHd+3QRqKYB0RXEotXtDyjjChFAjp7bjn2r+JDz3/oP+C7Q+bLy1lC8VRyGnM62mih56/F7g3t7g717ewOcwRuxbztHeONwirdqePpB9J7zKY7372BjNNOazZM0EZaX5uajdK3ra7dJ8BF67HkeVJYQFxI92Klz7abR1Zl+cBDG0um/GgxAcmnq+W7quG4KzFqWTSgCs3fTlQzg0vGzMb/57h1dFa3WCKDxPJ9VFWe6R0FjHxy/2L7OUYzr3XB5F2lycfNmLiBT3RAKB3cLPrLOaAOZ0pLrnaYR/qPZ3GB/f5Em85u3N/+r3N5neHizm3f3mmIIl/GVfwlY732+SJPJzbB+FaMc/4LA7t9fLIWJJNOcWW55WeEkp0OVz08D81w0OwZ5LDybrqt/GVG8UUXO9bONkk1bjsFo3tPV926oVMGZ3MBoWsFUDBmuIUMLmnG82DmbcNLkov2FZjfRcOSNPk728z6Plh1ZGNQxdM1Pkh66NJZ6IpluVuO5Ql+K55IK7tB6p6amt+RO3/9GDN1pRh5jcOfS+xZAoM4QjgBjiosC4UYxpgfxH5KRIyYRgCA2hIVvfq8eO7s3LegHteNYwcvaPXjMZHzP2tFpcHkZiYCoY7GAy0s8Va5P8V1bLNLlB1yr9YHkC/dF84yLaWtU/MSXA+O3xlAn0ZEvyH3w72cTAO8vqrWfBwXfxaLXIsgVwGFClkDCAc8jnWEc4fquo9xGJ/3e2F9DtqcAnOT/Dd4fVA+/EhtAedCvHj6oHr7GqPWKu7vn0DMSMnc3f8aLogcPjNVKjh+uoOBB33/ffJSaTwWf0cWlU13OsorbOFHPw4RpHI3DEwYyXWeCFeTw0SrjIZWA1GCMfzWWVwaNy8I69yUFHZP6wcaacwpcRVhYbSlKn1TZsOADBhPNR7+5s4LTOw8psBXNRA/67KHv/czZnydsyoHJOdDGyQyvtLOjj2pNbDIrmBYjrzenUBUcnVOoVrPM2cUdRgMcRxMmz036YKgfYohsDK398Y9/wh50DSj090jV+j14OpnLu+5sfTwu8Tw3CTAY1xSvYBFPgT2R32wZGS+ksbp2FuzgPG76muk8jOn52P8uWqlcsO2EN+dPgUvjhjMYkekjhVoKDADWdYWUs57o0yJlWmCBVgqX5YJndDMvaIegY9KTS9BpuMTDOxAm5j4nyeu7Mf0hBECvbn3jw+vvyc0A4iNJdk3vvKi4NkoiLSk9ZtKTqhP8lUHtccIK19XdV4HRHuTTxyj6jZrej3/8UwOuK1XgdcDcCizP0Qh2A4Rkf0IrkyHHheZVMQer2hDhfFz/dlXWQuhKrsf8NEPVkO4Mfw8K73SQxjsd6LpocE/epnbpHDZkJtE54pEuZ0e8ef4fI3aChSNvJYT14Cs141MkWH+FkdG6+RXaqQlyH47fXCFjksIl8J6jdIITx0gdDLVfLuHiy4nEaTeeyaCT2q1HmTS4TnrdngIpx1AkRhl0fvWQH4CbQysZsEJRFLxt5OjlbaCeUZLEhFgBhZygI82tE7KTKCHgxx/+A7P2gu3eRPFuYytJaJRHSHEjzVmDtBbSiXpteSxwAamsGM1PlTyNL4XZSDDtkdcSUOOOk7iuPG/wbydgPh9dCFrc83XkJxKpw6cq+gAa0+IZa+d79WKIkJ9pQbQiHsBLPmY6L+IFdsdoKQeQNQnJLXUVNdDzeQXZORsIp5yLnFeYRagk3FkqIA3pHM8TzR9cnpIF/X1sR55DLRqneZxgDhUZrfMkdRb45M0iTYZZ9qEzIvNqGflS+jRofVvLsh1mGdwdFgLRw/RQudzOnQN4RbyQ5XgP6c1pE1P7UB3yiZ20HhuUfgJX8qj7pTeI+/sldnaTEuz05KWzwatmmKGppHHXf7C7i/9rb+BJ66KhpFFn+HJTntPfJOn7ezqut2W6z5tV8+vsgpO3YvCHi2w6eIHndYVYc+0E3oxR6wKThBFz3cgJ6Hlt4FbIQkh+GtB2OtjdPd1D3C7SZH8T+g5Vyd0LMEMkzlBYj0+h1XNgY3zLUKnWPyM2udZKX2/luB1k1yFhv4WET9eR8ExSgA+l0R+pcy5/2Z02l7dueQT1oiRacZJmIlwnak9am21+d5s0PKu1sPPk4PgyueiySnRd+8Hxm8UblMbsRKF/sFKGIGZ2khwk/Ya70HA9RR8fzkBEG+nQMJlj/M2aSY1Voj/d66H3YnXMRhPcNf153b3tEGPZWMjxTePeLLFziCfoDqmFoyX7rcQ/ceS//giavdJEIOVMOMvRdIfeFqPky6WT9Wk43uD+3OTRXHNoJkmDT654HYPTseVHXOXnGzyDmx2De582XXLO6UZ+tOhG2+QZi7gIvq7o6mp4rxrOq6U/quWOIg9Tw8F0vLwe0Y0SvCh75H4Y7O+Tnf6zPTJo3/ucbMX79xdvWmbTJGmbRimqYNXA99PsVW1z1dYG83/IBtM2wXidom2SCAQWTQAtPXxVDb9SJd6oEfsFN2s/vrEpWm8Wk72U/P4C4W16L5DvjRQxSX+VY444Pl/EZFd50idNRMduqMQ8hE7niDJbuOwaVeuMAwp0Lue8wIhyRuU5fvzh32FYi8JZ2nM+5QU+slhwRdfGx0/ymHBuei5fu7nuWEwdyS4VI07GsNxZwLpUhwV4d3kz0JeAohnYiVb1eEJKmRyjp/nl08OjUV1QJRU4RKUoXDvTdgZgLRaJTt7om0CYsQpEMDUZy2yN9gqMni0AmXUa7pIqUQWje4Z1U3RDxC7EiGfzrHDIcYVX7ETVFqZc5kpDobLzrnDp7d1uF//3ySfwpVMP4RBzn3iOX59OuZ5HOzqFvmZM67lbN0olwZBy1ngHz8C9gLQIxTU1Gg/gAc6w/PAwhnt2Oj/+67/B8VdqhjwnlC5aWfD9w/cO3aZM/9GLZyTA7bjzf06JK6jDOLsgurLGQv4DKjm0l07HizPA5VRoJRG1nQ7cPXtvcedsx7NNq3z9EncKbDTC4GA5hgIpOGeWrRzFYwxXfMwqNhSFQHkRv7+Dx8zysdJzeAev0QwV6/8oeHci33W7XfoXu3Y6sUJUpwPv4DHpQCmxvRTqyoVBaD5V556mck5RPsuaK+HYl+TrZz4K9Eozf1GLIgfNa28Abjja7ITqQ1F8YyyY8OtYbwiLriiNt2AebNBhiUNejLp4P2mJLwMVoBjaXbFQmCVeg2FEyKmwTg2lglB+0hf1sBAZtME/nJBRCirXGK5eIeQ5XR8ZPJsUXb8sahSwrNnIwmulz3ElNyM+T0voMEg/4oQZyHGEq4MxEpIVwhFc6fSVMO9j91Q5GL9xfGIeXmeKLXBP2VCpcySxsWZlySg7oZiHSX5H0o+b41sy2pomZEIajFONbPqJRnJ0IlM8idd8OFHq3E3y0uv6yI66FCDGp1Rup6H5G3CUqdEGCFzmrtaRn45sCH4uqwXHl9xVEHGWJk1lwvAlQb0XT/Bd+2og4ZNd8TmnSl/hwcDGT+BRDMvxVavAl7E6kfianDXCds5CMAalsc0alT0we4+ONaAq9SaExgfXIRxs7LD8gLvxNBU+Iv8yvQDqV4j7Q3eah57qvhby3JxIzHs484Gj7rxPg3RUUA8fFQvvnLH0DEE+e/Ht4RH0CbAA51lMlWiYDAN5m8C225uFoB33lmh9jFZVruPVCYfHihN59uXTI+iHPfYPRH5Gm29/x8tz5iS3IecSy5FxVhZUNw6vmeZ5LXMMLlhx6GteqimatGWOhb00H5G5mFkWDi6GvAaDdzF39na/5+WEnU6sfxbNR1SrjWsX6ShNXfJ4Qi+88tV9oZV1HiK0oUeKwnY8p5amdpKcBbwGBor6AJlvYab0uQi2dy4zPa/8rKYHhw0CPDiR/jzbESRn8D//DWcvXq1hnD43BoTT7B/E4JN2txU6WWlYWY8agg3gLODn29EIDzBSL/IsrYpIvxRNcqpcL6Lg6wh3daNEQxt2ahW6CguRCax4552aKPp5D6RfL5I6pRkyjJ3z08Tz9ZfvpSrwgSX+4J+hM3A2G6IvlmW8Qo6Ne/LXEbViPOmR4BjHlWllDElatAtkW1rVllM0jOYcsL8PUAmnfODedFwdX1E+YVOBXHP1JfcwnUEnxPPv0JtAwliIzWUWUMWx9KYuxVTP4dw8qBXiPJGNt30HhCivO1JipX/9QjoG88GYbjJWobPJTYcxFVEnC935BWLNv8nLeAyhnUb4LrIWZ2J+jJUL7z5+vIPA+XJVJ/IRSD5DtGfZEttr/Jr8WSYkWPELYUi4OjtBfWc5TskG/14yasf9SFsO0kU8xb4TlOJhPm06RrkhkcD5ESOMS3O4M553qSbj7U3j8LU458s9pAh+Cxq4a+psghKFuyXLGy/ys52GLz+ChuelqVSeS1H1vJwisVJ6yR2XQswWwrsREdzKzoE8DnD37PjN2c6vQWH6LcXPEGotVgadcC3shqlXZNtlvbenS8HaC7iNL3gnUGdH3/26cHvoZG8SJG4hkEdJMOp27RmuNRHG0U9foXdtbfBNpsmzVVHmn7nGFBM8o7+DL1h2PmM6N5RNxawg0X+OXXEwEocr0DYMHbuZ71g41QKme64A5V5vL2p+Qf4ywQWNjuWpW9j7YxuF2pwxahjwTrNKBUPN3auZTZgc40VA4avxUAtk/HmdubtA8OLUsTBbLZ0jEm0zM+Fd6fkKYbwyHPVmLwNhHsxxFE1f86ERlrfTuVcxvUNjflcXBQTlhy7cDdqiG/alsF/VQyyhqYywSs+Xo8bCTuohnWVzbPzhJwhKSvQV/BQtlaY84rok9+0h11OR3bD9PlYINf0d8pyv2K3bZhfyyCPfMS0dm1XC6/PHAQ5oJ9Hffh8uYYF0FfJ5eOsXq8TGaBDawrcjv19vxL9+v0maFCLj0vCGT+TRly++hum93m6SNrwB73GW/a+fPX76/PApAuOvCVqwe7u9XfJfK2NLJhsroaZKksSqcauRSbUtybwtybwtybwtybwtybwtybwtybwtybwtybwtybwtybwtybwtybwtybwtybwtybwtybwtybwtybwtybwtybwtybwtybwtybwtybwtybwtybwtybwtybwtyfzn4xLbkszbkszbkszbksxX3KNtSeY/e0lmn9mKgPSrggnZKATgMq+Pl4Wa36TJBJOyD46Ty0uMIHmFiZL4+fuaa8zofpMmU6YFetgonzsNSciYRXvOMSf1sXPxdo9w5dRJhRSOtZLGjlnUbsQjin6+tm8zbxxjuTHj0FdsK1WOYzSbYTIim7k0SU94lF7MqAhlweS4pqTexM2JedOYMdpOuj6npGv/RyM3GDOKlxC2s7HdNvC/uKmNAy4vXUI35fC6/q7pyhEesaE3ntybxWLxv234Kx8=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Contact list","permalink":"/docs/API-docs/v1.1/contactlist"},"next":{"title":"Draft Document","permalink":"/docs/API-docs/v1.1/draftdocument"}}');var s=t(74848),r=t(28453),o=t(57742),a=t.n(o),l=t(78178),d=t.n(l),c=t(19624),h=t.n(c),p=t(96226),m=t.n(p),u=(t(77675),t(19365),t(51107)),g=t(21312);const y={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:"eJztPO1yG0dyr9JZpyIRtwBIiJYdnk45WdLZSmxZJVJROaSOHOwOgBF3Z9YzswBxFKr84yoPkMqfVCV/7iXyP4/iJ0l1zwd2AZAUZZ9Pl8BVtomdr56enp7+vkwsG5vk4Dh5orK65NKa5E2a5NxkWlRWKJkcJEcTDoYXIyPGEh69eAZjLrlmlhtg8Orl12AnzAKXbFhwAyPNubHzggP2F3IMagQMcj9/D75TNWRMAiuMAiGzos45KFqMFVBp3s35SEiew0zkY25NCrOJyCZgJ25Ormk8z4UFpYFfVEzmUFdKAjMgOc953oOjiTBQaTUVOQEaoOEXFdeCywwnK0XBNFhFc//4w38e4ha/U7XG/f74w3/BqFAzEJLav624pA6sqnon8kQeieoAXlWFYjnMVa3hxZPfxY3irPjtuNN5wof1GF4963Te3J1YW5mDfh/nUBWXCFbBhqaXqbKfY8cqH+3glrnmOKvbKzOimAPLG0ixEy4hU9UcMqV0LiSeSAoVG3OQdTnk2qSAmCmV5rgHBpqzfN61qlsbDv94+O1zGCldMtuDF0Vt0rhcLjTPbDF30+Pew67uGBgyw+/vg7FayHEKJTtHtAoL39ciO8dtGy7zgNRHL54Rrjqdw7qqlLY8h9duCwedDrZ8wRHHTHPqn6myVBIqplnJLdfGURc2a/59LTTRhZ0AK4qAi4MT2YVOR7KSH3Q68EqK72sOIufSipHgGncJFunBDei5/nZeUf9nMhcZkTMCgF+RZFtdEanY9bDiGU7pujZQDUp6KkUczpg7/6pgmduW5qbimRVT3p74IoU5TvyESxUgmCgt/qCkZQUd35RrKzJWNI8ZAaTrYJm2iP5KCWnDV79CvGl42nSIng4RtByRWwpJLYbDlBU1Nx6qWQoThOolrzQ3yBXCvIh4mcOEi/HkyvVY/rY2tjUx1AbBbELh1wqnSujlhLYRKwwHMWrhsmTnvLFa5Bg9+GIOOR+xurApCKRQq2veg+fK4k0tRIaMiWgALxuzteZdOmVPPr02+bxY8oxcjEZc42XGRprCjwnQIV06JoPbo5tmJ0yCkisHnalC6XUSos9tPEKmpCVO+WjKREHAu82ayC6HBcvOUxgWNU9B89xd9DkvCjVL3f2gLsgQHc4JP8jGkQqVRPil8ssLA8ZDFRlnuH/YGJkzLiJME6v+lo8UrowoCFcSeMlEkRLiUnirhmCFLXiKF7xicp5CzixPwfILO1QXKWQTnp0P1YXH10hJa8QfNty60HJ7rA1S2E/hfgqfp7C3m8LeIIW9/RT27qew93kKg90UBoMUBvspDO47nA4+9/hkEYlNAPYGDpP248PgROT8FBtPEf5TZizXwpwj24XX+Ha4FztPHdvjFxaZWHxk8+VLJgxMRJ5zCSOtStA8E5UgruBudZw6hWFtQSPg0sCoLoo5TIURjX3GSdUMH3L3tArdeFyzTNV4joRFhzhC2fJYZTFHUI84Kw1h9Km0XFdaGI4sV5qIAWmX9OMeMvzWvMjvc1qyzUmuPrFwAilolguF2LBKppBrVeVqJv1L+LUwxDvxCTPxVZy1XsW9HnQ6kV/ht7OzsxN5eSIBThJkXyfJAZwksctJkro2fJWwbc//vsAf9waf+Z9z/Hl/8Ln/OaOue/v+5wR/DsJQf4FOkgNalzoIad3Knk9CAwLstDiRCw/siRzQLiwrq2t2gM1/Xughgh9eG/yIz0QaGvCWrcNzxY5dj7Xd3sPdCimsYIW5esOhx0e05xWQNm972Wlt5/u4c+JXV2+bmj+iPTfhwRZ6C10TvZ2NpsDxCYrBNShanfMqHoyjSMpZw+SnPS+KXI1It4WPBo8NcH4uNK5MeXss3kcs4pN5hE/m1aiMr+pHhM9VmH4upG6a9/aY/axHwixJIFfj1Xf4iLDahujnwun6rLfH6OeIURTlrkYntn5EuGyAgw1eLnZtu/vdvU+7g93BfgufaGVwHcqym+fd+Xz+086iFPLUwYGDGv1LdrG5wRuAYiOdxjVn6/qtHBeKlX6/KFkGZdGJtsxyJyGvWwJIUV/28qoL/R20529QZx4GdZLnwewUFYtorGkqvFblbH7HuKnC0KhDYf9VCdiBSU0IBxmusokSmQce+wTNaYi2mR7ioEtH18/zfuPo8GOed8uyu/IRf3bppBsfy7KX572Vnmvk4D6WkOcprH/e+D3PoSzLKz67763P/bJc30WvLD1sHnuBwtbOuRRSlDXqQWgDc+o0dkRVwqO39GcpJHQ633333Xfdb77pPnnS6YQz9Et4Wm2YHdwK7OJnWqFJ9J3OATwbQfMTqf7O6EJ3Pap/qNbEDhM1k0Hr8QbYvEbrX+jqTD8lm9NkXNgJ1+11lF6SLOqIqFINlZ304BWpkPh3ULWiSkTq0t8je/Q67tUc0nf4pZjkkhe2F76WgaL1FXXXdebT4qBrwk9gTNVm6UjzcV0wzS/QVmeEkmuc70Neutu9YitsMdDy0mZCVkBvh+XBZAF3v/Wa9k40Bq7sBWd7BFltLBkexvwCKmYt15Imm7JC5IzuR5c+8AtWVmgk6f/+5CT/1d/2yQyLlk7r7Aa5GAu0nvd/f/yo+y9vNvSoq4rrjBkOBceVTArcZj04nvCiWhrwZ7NZb3bPZBOlCme9f2s0H7n/nqrh21MCt+oxU+1s2qkjhobZE4ll1epJl7OBMWYgjNxg+KSjoVuzt0tymrdHXCOo+R4fkXSxAhI2OhsyNh/jA08iLBIvX/6tkOecJG+Wzz2ZOnl+w9g373E98TYUbMiL9abbX62CzVXtb3Qw7be36im6gTcv8ETrLW1nN200souVRte22HBPHUKa1zS89uF6hhOAQpj4kLTQ2RztDfzkpkHnG5LtkEMYAMNIpT/5FkTA3u8aBCsond0NS2A/oI7RuRLtqdev0DqYtZfcywrBSzSKswaUhYe8iS8cWRuul2LCNSt4WeHqFdAlc/UCJ3KPbI2iZONrVBBq/oi4RBOeK8xVrseavrVHRkmHrmuMLNR+/Yb3dlsb/rS94fu7HyBOtJa9FhUNmWG3wXN0WRdsTQLIeSZKVpA/kpYe/AQOtsFeswr1h8gPHnak78eqrGrr6NtLDqiZEI8PhB4ccc4F8asUuil0UuincDeFnR685OS6y6Kbz9O90M6ZJyTkqkZ7flbrYg5DjbhJgffGPbi8/L5m0go7XyygA5eXGO6wWPSQU5xLNXOevmP0bVhAT/1SLshVZjZ49lVm+ihA9J/zWTcEW/Q9aDtwV61wxmulKY+CNXbaOmYc+jwyBSf3kOdXmKpgc2AjdHc47yANc07kHmLgAAbwm4ewN+jt7qaw6/6Gu2H9wQ5dJLJ3Z7y4zthNzTddo93mNVr+3MQ3Pt19r3vUXPYDhXKc4pR8UbTuZmF9Iwf6CIXz5WZWzQGNdwNx5p4MM1F1keOrobmtteQxnsO/GkmaqAqDgISSz/LkIAkBQklKuObGfqHyeXJwmXjHLP7pnWg4qP/WYHDRZWKyCS8Z/hXOCMORRqLgSZo4bdMkaUKWS4xNQtJKDhI1fMszm6SoFVUoRnGDc9C4g8vQywWpJKm3QCUHiYteSdLEawrxE3CZKTS7VPkoWaQ002nFjJkpnV87ZfyynBIncBDfcqChP6KXFOfBwJAPnOY5Dl2sxHN90ExPGjPQ3kp+pJBNF9zyJ2xuGvM6ikpWw8hwDFJR5kdBzuYGdf7aOPLKWJHVBVoL+EUl9DyayshEFVHSgDeuFOHd+3QRqKYB0RXEotXtDyjjChFAjp7bjn2r+JDz3/oP+C7Q+bLy1lC8VRyGnM62mih56/F7g3t7g717ewOcwRuxbztHeONwirdqePpB9J7zKY7372BjNNOazZM0EZaX5uajdK3ra7dJ8BF67HkeVJYQFxI92Klz7abR1Zl+cBDG0um/GgxAcmnq+W7quG4KzFqWTSgCs3fTlQzg0vGzMb/57h1dFa3WCKDxPJ9VFWe6R0FjHxy/2L7OUYzr3XB5F2lycfNmLiBT3RAKB3cLPrLOaAOZ0pLrnaYR/qPZ3GB/f5Em85u3N/+r3N5neHizm3f3mmIIl/GVfwlY732+SJPJzbB+FaMc/4LA7t9fLIWJJNOcWW55WeEkp0OVz08D81w0OwZ5LDybrqt/GVG8UUXO9bONkk1bjsFo3tPV926oVMGZ3MBoWsFUDBmuIUMLmnG82DmbcNLkov2FZjfRcOSNPk728z6Plh1ZGNQxdM1Pkh66NJZ6IpluVuO5Ql+K55IK7tB6p6amt+RO3/9GDN1pRh5jcOfS+xZAoM4QjgBjiosC4UYxpgfxH5KRIyYRgCA2hIVvfq8eO7s3LegHteNYwcvaPXjMZHzP2tFpcHkZiYCoY7GAy0s8Va5P8V1bLNLlB1yr9YHkC/dF84yLaWtU/MSXA+O3xlAn0ZEvyH3w72cTAO8vqrWfBwXfxaLXIsgVwGFClkDCAc8jnWEc4fquo9xGJ/3e2F9DtqcAnOT/Dd4fVA+/EhtAedCvHj6oHr7GqPWKu7vn0DMSMnc3f8aLogcPjNVKjh+uoOBB33/ffJSaTwWf0cWlU13OsorbOFHPw4RpHI3DEwYyXWeCFeTw0SrjIZWA1GCMfzWWVwaNy8I69yUFHZP6wcaacwpcRVhYbSlKn1TZsOADBhPNR7+5s4LTOw8psBXNRA/67KHv/czZnydsyoHJOdDGyQyvtLOjj2pNbDIrmBYjrzenUBUcnVOoVrPM2cUdRgMcRxMmz036YKgfYohsDK398Y9/wh50DSj090jV+j14OpnLu+5sfTwu8Tw3CTAY1xSvYBFPgT2R32wZGS+ksbp2FuzgPG76muk8jOn52P8uWqlcsO2EN+dPgUvjhjMYkekjhVoKDADWdYWUs57o0yJlWmCBVgqX5YJndDMvaIegY9KTS9BpuMTDOxAm5j4nyeu7Mf0hBECvbn3jw+vvyc0A4iNJdk3vvKi4NkoiLSk9ZtKTqhP8lUHtccIK19XdV4HRHuTTxyj6jZrej3/8UwOuK1XgdcDcCizP0Qh2A4Rkf0IrkyHHheZVMQer2hDhfFz/dlXWQuhKrsf8NEPVkO4Mfw8K73SQxjsd6LpocE/epnbpHDZkJtE54pEuZ0e8ef4fI3aChSNvJYT14Cs141MkWH+FkdG6+RXaqQlyH47fXCFjksIl8J6jdIITx0gdDLVfLuHiy4nEaTeeyaCT2q1HmTS4TnrdngIpx1AkRhl0fvWQH4CbQysZsEJRFLxt5OjlbaCeUZLEhFgBhZygI82tE7KTKCHgxx/+A7P2gu3eRPFuYytJaJRHSHEjzVmDtBbSiXpteSxwAamsGM1PlTyNL4XZSDDtkdcSUOOOk7iuPG/wbydgPh9dCFrc83XkJxKpw6cq+gAa0+IZa+d79WKIkJ9pQbQiHsBLPmY6L+IFdsdoKQeQNQnJLXUVNdDzeQXZORsIp5yLnFeYRagk3FkqIA3pHM8TzR9cnpIF/X1sR55DLRqneZxgDhUZrfMkdRb45M0iTYZZ9qEzIvNqGflS+jRofVvLsh1mGdwdFgLRw/RQudzOnQN4RbyQ5XgP6c1pE1P7UB3yiZ20HhuUfgJX8qj7pTeI+/sldnaTEuz05KWzwatmmKGppHHXf7C7i/9rb+BJ66KhpFFn+HJTntPfJOn7ezqut2W6z5tV8+vsgpO3YvCHi2w6eIHndYVYc+0E3oxR6wKThBFz3cgJ6Hlt4FbIQkh+GtB2OtjdPd1D3C7SZH8T+g5Vyd0LMEMkzlBYj0+h1XNgY3zLUKnWPyM2udZKX2/luB1k1yFhv4WET9eR8ExSgA+l0R+pcy5/2Z02l7dueQT1oiRacZJmIlwnak9am21+d5s0PKu1sPPk4PgyueiySnRd+8Hxm8UblMbsRKF/sFKGIGZ2khwk/Ya70HA9RR8fzkBEG+nQMJlj/M2aSY1Voj/d66H3YnXMRhPcNf153b3tEGPZWMjxTePeLLFziCfoDqmFoyX7rcQ/ceS//giavdJEIOVMOMvRdIfeFqPky6WT9Wk43uD+3OTRXHNoJkmDT654HYPTseVHXOXnGzyDmx2De582XXLO6UZ+tOhG2+QZi7gIvq7o6mp4rxrOq6U/quWOIg9Tw8F0vLwe0Y0SvCh75H4Y7O+Tnf6zPTJo3/ucbMX79xdvWmbTJGmbRimqYNXA99PsVW1z1dYG83/IBtM2wXidom2SCAQWTQAtPXxVDb9SJd6oEfsFN2s/vrEpWm8Wk72U/P4C4W16L5DvjRQxSX+VY444Pl/EZFd50idNRMduqMQ8hE7niDJbuOwaVeuMAwp0Lue8wIhyRuU5fvzh32FYi8JZ2nM+5QU+slhwRdfGx0/ymHBuei5fu7nuWEwdyS4VI07GsNxZwLpUhwV4d3kz0JeAohnYiVb1eEJKmRyjp/nl08OjUV1QJRU4RKUoXDvTdgZgLRaJTt7om0CYsQpEMDUZy2yN9gqMni0AmXUa7pIqUQWje4Z1U3RDxC7EiGfzrHDIcYVX7ETVFqZc5kpDobLzrnDp7d1uF//3ySfwpVMP4RBzn3iOX59OuZ5HOzqFvmZM67lbN0olwZBy1ngHz8C9gLQIxTU1Gg/gAc6w/PAwhnt2Oj/+67/B8VdqhjwnlC5aWfD9w/cO3aZM/9GLZyTA7bjzf06JK6jDOLsgurLGQv4DKjm0l07HizPA5VRoJRG1nQ7cPXtvcedsx7NNq3z9EncKbDTC4GA5hgIpOGeWrRzFYwxXfMwqNhSFQHkRv7+Dx8zysdJzeAev0QwV6/8oeHci33W7XfoXu3Y6sUJUpwPv4DHpQCmxvRTqyoVBaD5V556mck5RPsuaK+HYl+TrZz4K9Eozf1GLIgfNa28Abjja7ITqQ1F8YyyY8OtYbwiLriiNt2AebNBhiUNejLp4P2mJLwMVoBjaXbFQmCVeg2FEyKmwTg2lglB+0hf1sBAZtME/nJBRCirXGK5eIeQ5XR8ZPJsUXb8sahSwrNnIwmulz3ElNyM+T0voMEg/4oQZyHGEq4MxEpIVwhFc6fSVMO9j91Q5GL9xfGIeXmeKLXBP2VCpcySxsWZlySg7oZiHSX5H0o+b41sy2pomZEIajFONbPqJRnJ0IlM8idd8OFHq3E3y0uv6yI66FCDGp1Rup6H5G3CUqdEGCFzmrtaRn45sCH4uqwXHl9xVEHGWJk1lwvAlQb0XT/Bd+2og4ZNd8TmnSl/hwcDGT+BRDMvxVavAl7E6kfianDXCds5CMAalsc0alT0we4+ONaAq9SaExgfXIRxs7LD8gLvxNBU+Iv8yvQDqV4j7Q3eah57qvhby3JxIzHs484Gj7rxPg3RUUA8fFQvvnLH0DEE+e/Ht4RH0CbAA51lMlWiYDAN5m8C225uFoB33lmh9jFZVruPVCYfHihN59uXTI+iHPfYPRH5Gm29/x8tz5iS3IecSy5FxVhZUNw6vmeZ5LXMMLlhx6GteqimatGWOhb00H5G5mFkWDi6GvAaDdzF39na/5+WEnU6sfxbNR1SrjWsX6ShNXfJ4Qi+88tV9oZV1HiK0oUeKwnY8p5amdpKcBbwGBor6AJlvYab0uQi2dy4zPa/8rKYHhw0CPDiR/jzbESRn8D//DWcvXq1hnD43BoTT7B/E4JN2txU6WWlYWY8agg3gLODn29EIDzBSL/IsrYpIvxRNcqpcL6Lg6wh3daNEQxt2ahW6CguRCax4552aKPp5D6RfL5I6pRkyjJ3z08Tz9ZfvpSrwgSX+4J+hM3A2G6IvlmW8Qo6Ne/LXEbViPOmR4BjHlWllDElatAtkW1rVllM0jOYcsL8PUAmnfODedFwdX1E+YVOBXHP1JfcwnUEnxPPv0JtAwliIzWUWUMWx9KYuxVTP4dw8qBXiPJGNt30HhCivO1JipX/9QjoG88GYbjJWobPJTYcxFVEnC935BWLNv8nLeAyhnUb4LrIWZ2J+jJUL7z5+vIPA+XJVJ/IRSD5DtGfZEttr/Jr8WSYkWPELYUi4OjtBfWc5TskG/14yasf9SFsO0kU8xb4TlOJhPm06RrkhkcD5ESOMS3O4M553qSbj7U3j8LU458s9pAh+Cxq4a+psghKFuyXLGy/ys52GLz+ChuelqVSeS1H1vJwisVJ6yR2XQswWwrsREdzKzoE8DnD37PjN2c6vQWH6LcXPEGotVgadcC3shqlXZNtlvbenS8HaC7iNL3gnUGdH3/26cHvoZG8SJG4hkEdJMOp27RmuNRHG0U9foXdtbfBNpsmzVVHmn7nGFBM8o7+DL1h2PmM6N5RNxawg0X+OXXEwEocr0DYMHbuZ71g41QKme64A5V5vL2p+Qf4ywQWNjuWpW9j7YxuF2pwxahjwTrNKBUPN3auZTZgc40VA4avxUAtk/HmdubtA8OLUsTBbLZ0jEm0zM+Fd6fkKYbwyHPVmLwNhHsxxFE1f86ERlrfTuVcxvUNjflcXBQTlhy7cDdqiG/alsF/VQyyhqYywSs+Xo8bCTuohnWVzbPzhJwhKSvQV/BQtlaY84rok9+0h11OR3bD9PlYINf0d8pyv2K3bZhfyyCPfMS0dm1XC6/PHAQ5oJ9Hffh8uYYF0FfJ5eOsXq8TGaBDawrcjv19vxL9+v0maFCLj0vCGT+TRly++hum93m6SNrwB73GW/a+fPX76/PApAuOvCVqwe7u9XfJfK2NLJhsroaZKksSqcauRSbUtybwtybwtybwtybwtybwtybwtybwtybwtybwtybwtybwtybwtybwtybwtybwtybwtybwtybwtybwtybwtybwtybwtybwtybwtybwtybwtybwtybwtybwtyfzn4xLbkszbkszbkszbksxX3KNtSeY/e0lmn9mKgPSrggnZKATgMq+Pl4Wa36TJBJOyD46Ty0uMIHmFiZL4+fuaa8zofpMmU6YFetgonzsNSciYRXvOMSf1sXPxdo9w5dRJhRSOtZLGjlnUbsQjin6+tm8zbxxjuTHj0FdsK1WOYzSbYTIim7k0SU94lF7MqAhlweS4pqTexM2JedOYMdpOuj6npGv/RyM3GDOKlxC2s7HdNvC/uKmNAy4vXUI35fC6/q7pyhEesaE3ntybxWLxv234Kx8=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-2",custom_edit_url:null},f=void 0,x={},w=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Self Sign"}),"\n",(0,s.jsx)(a(),{method:"post",path:"/selfsign",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Unique identifier for this widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Specify the hint for widgets. This parameter is optional and is not applicable to the following widgets: checkbox, radio button, dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options":{\n "hint": "Provide signature"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp",\n "hint": "Provide stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials",\n "hint": "Provide initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide email",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide name",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide job title",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide company",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12,\n "min_date": "",\n "max_date": "",\n "signing_date": false,\n "hint": "Provide date"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"min_date:"})," Provide the minimum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"max_date:"})," Provide the maximum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"signing_date"}),": If signing_date is set to true, the signing date is shown to the signer during signing. You may set either signing_date or default, but not both. Using both is not supported."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image",\n "hint": "Provide image"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "default": 0,\n "formula": "",\n "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hint": "Provide number",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,s.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"decimalplaces:"})," Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"cells"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "cells",\n "page": 1,\n "x": 100,\n "y": 100,\n "w": 114,\n "h": 50,\n "options": {\n "name": "cells",\n "required": true,\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"cell_count:"})," Specify the number of cells that should be returned to the user."]}),"\n"]}),"\n",(0,s.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(g.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(h(),{...t(27471)}),"\n",(0,s.jsx)(m(),{...t(16737)})]})}function j(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}},27471(e){e.exports=JSON.parse('{"title":"Body","body":{"content":{"application/json":{"schema":{"required":["file","signers","title"],"type":"object","properties":{"file":{"type":"string","format":"base64","example":"base64 encoded pdf"},"file_password":{"type":"string","format":"string","example":""},"title":{"type":"string","format":"string","example":"sample document"},"note":{"type":"string","format":"string","example":"sample Note"},"description":{"type":"string","format":"string","example":"sample Description"},"timeToCompleteDays":{"type":"number","description":"time to complete days is used to calculate expiry date of your document","format":"number","example":15},"signer":{"type":"object","properties":{"role":{"type":"string","format":"string","example":"ceo"},"email":{"type":"string","format":"string","example":"joebee@example.com"},"name":{"type":"string","format":"string","example":"joe bee"},"phone":{"type":"string","format":"string","example":"123121312"},"company":{"type":"string","format":"string","example":"opensign"},"job_title":{"type":"string","format":"string","example":"dev"},"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Allowed values include signature, stamp, initials, email, name, job title, company, date, textbox, checkbox, dropdown, radio button, image, number, cells, attachments.","format":"string","example":"signature"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":244},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":71},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":38},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":46}},"title":"createtemplate_body_widgets"}}},"title":"selfsigndocument_body_signer"},"folderId":{"type":"string","example":""},"send_email":{"type":"boolean","description":"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \\"true\\". If the value of this parameter is \\"true\\" and no \'email_subject\'/\'email_body\' parameters are specified default email templates will be used. \\n","example":true},"email_subject":{"type":"string","description":"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.","example":"{{sender_name}} has requested you to sign {{document_title}}"},"email_body":{"type":"string","description":"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.","example":"

Hi {{receiver_name}},

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

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

Sign here

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

Thanks,
Team OpenSign\u2122

"},"enableTour":{"type":"boolean","description":"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.","example":false},"redirect_url":{"type":"string","description":"Specifies the URL where the signer will be redirected upon completing the document signing process.","example":""},"sender_name":{"type":"string","description":"The name of the person or organization on whose behalf the email is being sent.","example":"opensign\u2122"},"sender_email":{"type":"string","description":"The email address of the person or organization that users can reply to.","example":"mailer@opensignlabs.com"},"merge_certificate":{"type":"boolean","description":"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\\n\\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\\n\\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\\n","example":false},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed.\\n"},"cc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"cc (carbon copy): Users added here will receive a notification email once the document is completed.\\n"}},"title":"selfsigndocument_body"}}},"required":true}}')},16737(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Document created successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"hji2zxcv2P"},"url":{"type":"string","format":"string","example":"https://url-to-sign-document.com"}},"title":"inline_response_200_1"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/34593b53.3d2565a7.js b/assets/js/34593b53.3d2565a7.js new file mode 100644 index 000000000..8645f2972 --- /dev/null +++ b/assets/js/34593b53.3d2565a7.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[9099],{28598(e,n,t){t.r(n),t.d(n,{assets:()=>j,contentTitle:()=>y,default:()=>w,frontMatter:()=>g,metadata:()=>i,toc:()=>f});const i=JSON.parse('{"id":"API-docs/v1.1/createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file.","source":"@site/docs/API-docs/v1.1/createdocument.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/createdocument","permalink":"/docs/API-docs/v1.1/createdocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file.","sidebar_label":"Create Document","hide_title":true,"hide_table_of_contents":true,"api":"eJztPdtyHLl1v4K0U5E47pnhjCitzFUUcyV5V/FaYolUVBtSITHdmBmI3UAv0M3hmMsqP7jyAam85NU/kfd8yn5J6hxcGt1z4UXatdaerbLFQeNycHBwcG44uIxKOtHR7lH0XCZVzkSpo/dxlDKdKF6UXIpoNzqcMvJMMVoy4mqRvf2XhGaZnGlSaaY0KSWZMMEU1BJsRlLXHxnNSaHkOU+5mJCUlpTMeDklI6rZox3CRCJTlpIxz1jvWByLQ17skrdFJmlK5rJSZP/573xvMAyUHXU6z9mompC3Lzud9/enZVno3X6fFkVPFkxoPhEZHeleIvN+ChWLdLwVk9mUKQa9koQKwqjm2ZzQNCUznk5YqWNSTpkgiSzmJJFSpVzQkumYFHTCiKjyEVM6JlSkJJeKES4IJYrRdN4tZbfSjPzrwetXZCxVTsse2c8qHfvhUq5YUmZz0305ZX5W97TDhi4VF5OY5PQMsMVL8n3FkzOYtmYihX+h4d7+S8RVp3NQFYVUJUvJOzOF3U4HvnzFMjkjVDGsn8g8l4IUVNGclbhcU1riZ8W+r7hiqVkUmmUOF7vHoks6HUFzttvpkLeCf18xwlMmSj7mTMEsSTnl2jbomfrlvMD6L0XKE0AeAgClRI6bVQGpUPWgYAl0aaoGqCZSkNmUJ1PE4Yya9S8ymphpKaYLlpT8nDU7vojJHDp+zoR0EEyl4n+UoqQZLt85UyVPaBYuMwAIVXVJVQnoLyQXpSu1I5Dv7HLCauMiWjoE0FJAbs4FftGMnNOsYtpCNYvJFKB6wwrFNG4N2y8gXqRkyvhkunI8mn6odNnomFQawAyhsGO5VUX0MkTbmGaaET5u4DKnZywYjUjc8zTrka/mJGVjWmVlTDhQaKkq1iOvZEloUWQ8oaOMIQ3AZqNlpVgXV9mST69JPvvIAZgmlKR8PGYKNjN8xC5sGwcd0GXNMnCnlVMqiBSthU5kJtUiCWFxE48kkaJkouyRvXPKMwTeTFYTLpKsShkZZTQ5i8koq1hMFEvNRp8zYHOxZVpQhVBtcY74IZplQIVSAPxC2uG5JtpClfbIIWwUv//go0M1DsJ1iFW7y8cSRgYUuC1JWE55FiPiYvJBjkjJy4zFsMELKuYx8FcWk5JdlCN5EZNkypIz/EvRlEsyqspSCjOxVMkilTNhcTmWotT8j0t2pPtye4wOY7ITk0cxeRyTwXZMBsOYDHZiMngUk8HjmAy3YzIcxmS4E5PhIwPW8LHFNfUIDgEYDA2Wy18Wdqc8ZSfQ8ATmdkJ1yRTXZ8CuyTs4c5gA4NLYsEt2UQLzQ27EJ4Kl9QnINZnyNGWCjJXMiWIJLzhyE8MNfNcxwEMUTEpoMq6ybE7OueYBDnynciYAbzgiV+R1wcQBnwhCk0RWsMaIYYNURGe95CKbA6iHjOYaZ/5ClEwVimsGrFpojwFR1rRlDkAoCxnATVZSNDnQ6tVctTrBysAJ+i3XyHPh6NP+NJ01TtNBj3Q6ns9B2enp6bG4PBaEHEfA9o6jXXIc+SrHUWy+wWkG3wb29wX8eDD8wv6cw89Hw8f25wyrDnbszyn8HLqmdnMdR7s4LlbgojQjW/5KAgig0tWxuLLAHoshzqKkebFmBvD5p4WeePDdKQWFcLzE7gPswEV4VszY1FiY7QOYLRe85DTTqyfsanxGc26BtHzadaWFme/AzJGXrZ42fv6M5hzCA1/wDDWf8MwNPrnTAKEYrkFRu89VPBhaoXS0gMmHPSvCrEakmcJng8cAnE+FxlaXt8fiI8AiHKeHcJyuRqU/cT8jfLZh+lRIXdbv7TH7RQ+FYJROVuPVVviMsNqE6FPhdLHX22P0MWAUxLzV6ISvnxEuA3Dgg5WZzbftne7gYXe4Pdxp4BOsE6ZCnnfTtDufzz9uLXIuTgwc0Cion9OL5R/AaAKio18J/wUkGC4mvlnz6+Kqm3qthQSB02ICZE6nfhqhF0xUKDsv2hZQ9a9rWYUH/3b6+B9ACx85BZWlVmqu1RFv/glV6FKmdH5Pm65cU695Qf22bGzAxE8AB5rCkqnkiQUe6jh9awTWnh7goIuL2k/TfrCoUJim3TzvtgrhZxdpICjM816a9lo1FwjFFOYkTWOyWLy0PE1Jnucrik15o7if54uz6OW5hc1iz9HewjrnXPC8Ag0JrGpGQYeKoGRY9OZ2Lbkgnc533333XfcPf+g+f97puDW0Q1gqDgwZZgR68YlGCIm+09klL8ckLEJjgjHjIBfwiqE1qZoKUzkTTh9CrVGRtAJ7oqtqjEk5nWNnjJdTpprjSFWTLGiPoGyNZDntkbeoXMLfTgnzyhIqUr8Bxmk149W801b4udhnzSWbA69lratZU4O3LohFjjEVy+UmxSZVRhW7AOuf5lIs8MS7nIG3O99abNHRcm1pQbuitewyZ+gg919bHXzLmxdbc4He9khS6RJNEhN2QQpalkwJ7OycZjyluD+6WMAuaF6AaaX/H8fH6a//sY+GXbCdlsaikPIJB3t8/z+O9rr//n5JjaoomEqoZiRjMJKOCSuTHjmasqyoXQKz2aw3e6CTqZSZ8Qd80IqNzf+fyNGHEwS36FFdbC2bqSGGwJAKxNK2o+LmDDBGNXEtl5hScWlw1wy2UYKzloo1Ipyt8RnJHS2Q4KOxSsPnIzj6UbgF4mX13xJ4znH0vj7u0XjK0mvavr/B9oTdkNERyxY/3X5rZXQuK7ujnbOgOVVL0QHerCjk7cE4ne04+EgvWh/Nt6sl+9QgJNym7rR329OtAMm49gdJA51ha+syQMePYAx9SSNGXANw0zku8LG7wAN2s23g7KO4dtcMAfUIVvTuGjfaNSM0FmbhJLeygvM7jX2vDmXuIA/xBS3B+1mLCWtGsLLC6hHAybN6gGMxQCuks16u0U9sjc+IV7RAWr+N78JFGifzXY7UO21AN61wAy45XqGqOVj95tOrd1+PvDYmddcIzO1JwgqQtD56a3qQb3xCodU4tKCvpryw1mdEfUvA+okp0Nb71KfPnYg0nP0viFAbYN+YWI3RP6eTNfYb/PwZkWcIz3ITh62xYKwaoKXfnChrLNT4ff2EB9uNCT9sTvjR9h00rsawH69wba/Bz8JQoFtXGV04DlKW8JxmGEGCcA8/Yo/eRfmygMEeeCbzoirDTYdmHWQsTkpwcRHGs/vrmHRj0olJPyb3Y7LVI28YRlIkPurCCg1cmdgKLkgqK3CTJpXK5mSkYOIxYb1Jj1xefl9RUfJyfnVFOuTyEmK3rq56sAvPhJyZwIsjcBmXBAKnaqUqlYleEmglE90H7av/is26LlSsb0HbIvdliyWsVUUtCn5ejcxAFRAJjPLKi2xGK8VIH66LjM4JHYOb2kSDYDMTNNQDFO+SIfnnp2Qw7G1vx2Tb/E3uuwkOt3APo48pYdk6JyV+vm4Hb4c7uP65jGU93L7RFg6HveMOhi5OMIYAx71WYKs392doOqkn0zbWBlI94Mycn3oqqyyF01OxslKC+fi9WqZH3xgtS5pMMVpyNQ0ElT6jw6uGyrKgtQcZBHku81h3OvuKjXmWBVGMxBU51gZRYSxjuY2cs/GLoNVhxAYXpQT24UJaOp0RG0uI1oAwSrSP0jrO0SyBkWAakTAJBLpKRaZUG3MTEhwsHMSJllOWt+JGHHh17AgXDnZYzcGnM4wOf9Pc448eNlb2YfOYXrnHVy3sGnspNNGFFNq7RVn9Kdh82KcrX9Sw2hvKdQrLjWFDdfQT8nLcPxk/YyHL5UI7YdVC2Y4GfDaVUtc1bECePX70bjPQTyqI9dvq+QiZj/X+Db540JClHv+M3r/mKm3v9AcP+2vdfy1P0e11ZkJusqToXLjRkmLNek03vrGP8Y19/I548Cnt04Mvho2T6cE6GeUzsU+HO+oay/SnsD/fScVfZggO9+ENTcA/myn248ly56cwSrUY9xeDv4JR6mNJdMH29MmIknwqw9MyyryB5WmtuemjKTcE9ien3oefxkrVUvl+05AGfzMMqfXhw4+j1raNKiC544j/21ev38y2f//1RO7t7e29Ong7ffF2sre3l8PvXq+31HK5jAxwGJCf7XUoe8SjuLBilF6vh1ELtKS72LxfiMmXpn28uk3vWERxJAu4sMaleJlGuxGK/sxpAlGMiGG6/Eqm82j3MrIXHuBPG4AOTfsfNNySu4x0MmU5hb8cQuFeHag8URyZeAwdxRFG/cElO1jraDeSow8sgdEKBeCUnGnoA9vtXrpa5mJYFFvxLdqNzBSjOLK+dF/kr9QV6Ti6irGnk4JqPZMqXdulL6m7hA4MxLdsqPEPr1dBP3AZ647dvIKmV62LiXfq6XnQA84tZ4cSbHEZK9lzOtdBv0arj9r3IaENsJHEtiIpnWtgR5U2Z2pCs6TKQEZlFwVXcx9MhoJqQGAeXj+Sh3fw8KqmmhokqhSdR3HES5aH5SuoSMnbr1zCJGAGo6dv2/aDZCPGfmsLwCqIC0/zW0PxQTIyYrjoxVSKW7cfDB8MhoMHgyH0YCNDb9uHs3BCFx/k6OROGyFl55FfypObL0iT5po3sqAXf3K5C0A+ENHGhRVKJkzrHtmDqzEsteLfbh1xBl4Db4/c2jWhjVN6zggwXUbBwCGCOyXNy3fnnM2gh13yhiWMn1vYwqu6UAWjdb40/nPsW8jWHUFaQMiU6wramItEtrzZ7ZfQvg2Rv8Vq2DoTVQ6818wxiiMDahRHbijgvwFrMPWu4ggECq1PgH/eZZVmcJNLM4j3hHtMosqZ4gkxvRLoFdiEv3LrJCUbrAc2JlMTZg+FjZn32vS98/ARwGyReXcmYb4uzrY5tyYV+St+filicxMn9jdT4o+4T+fc1O27W3jCx9bcGhtja0wC02jvulPAgYuMhU7Y9ez+cNWl5OAupDX10qJgVPXwbvCdr6k3TxAvGfeuOS+u4uji+slckER23Y1ncj9j49JE0pFEKsHUVhgZ/dlMbrizcxVH8+unN/9FTu8LWLzZ9bN7h1fF62v0fw1YHzy+iqPp9bB+4y+z/xWB3Xl0VcuvLfn+ZCTT+YljnlfXVXSiGNQbyyxl6uVSYbopOkPShpO2JDWSMmNULGE0jbuvNr0GKK7gz7Tmz9mUoYfY67PYe60sW++ngdYGojeCe7kGPVNV7DjqQZx5rXqjQNG+fuvq4pkkJLmH453oCs+Se337G3B0L0wwAb6Z+kqEAwErk5LlRYYZF2bg4BmhQyztEf+fOcUdJgEAJ5C6ga8/r56ZYGQc0DZqpisgVr3rkWdU+POseZmYXF56MkDquLoil5ewqkydwLl2dRXXBTBWowAlV1OijIwUtvJFrG7oy4KmRonAAH1TYM/PEAAbxF8p2w/oWldXTZGhBTi6uCwOWOrpDMSOxVl7jQBX+sbYX0C2pQDo5O8G70+Kp9/wJaA86RdPnxRP30FykoKZvWfQM+YiNTt/xrKsR57oUkkxedpCwZO+LV++lApl6VqYrHtp49Z31LMwfQeMul48rkmiqoTTDKPwQbFwnlT0foP1S5es0BBmwUujgqC2ghovnSiGflsj1lclJmNB64kb8AklU8XG/3yvhdN7TzEPAYSfPOnTp7b2S2PPM6qKmBOcOBofpTKW7XGlkE0mGVV8bE01MSlAq2GYuoImJkDEYNTBcTil4kzHT0bqKWQ08JkQfvzzX6CG4+kvxWuVMnUDpg43eYwl8h7wsXuxub2A5M6VLp3wj5zQUohXCpZtHSteQxjLC8/6dTXSUEu4/mrWWio+mTBQN2wNbGxzbDCaTM2hgVDV0SwFEI+stAMPCMzZO1IbYuRvFYXm0gA7wa0lM/feEq6OJyQXJxJanJh7VDdA6zuraYWINZMx8HJNRplMzoAUQOIzipXPluN01EqUPMPUDwXgPnWXpQCBSF3tOVOM7u6RF2IsVcI0MRAHuK3RgvZqtBTCSQcA3wuwcw8N2Jn2yCHPDQ5xQe+hxbmJMSwCJRW45IkcjzMuGAomd6JDN0+IO9fVCC7WUJObygkCHk02B4lNMCIIu4CrPcgNZIanqkkgYjjOzWdikp68Pty/wQTQkN81gNlEJEjipg/y+nAfkjr5vQ431vw2cPuKNqoYhfycU6eoerVubswVzPiv5RJd3KZT6pJFgFKul0IUG4kOUOhTpi10XGcJg/0pqxLCTrjNgIIsdg0iD2V1E5Z0DSYpmVR4sbUE3u1EJrxgVSdl4kKXqjJXHdwtw6XGJ4cnhxWoFPQfEya0aU7JGKOwYlIJDphXFfh2fJfsomCKQ7TjUhQoZlAH58b18knTnvb2zbc2N1xgjnEM1HUMG6BAqkGWsMBL2lNfqgzYs/t6AEFwxxhOa+YrmNJSwPkm1YQKe3waYwR4oUZsSjNT1Z4TEPqA/GzBduTUrB///JcArpUG30XAzAg0TSEe7xoI0aFnCB44jWIFHH+yCRH0x9Rv2/pf5LldLlO/kfTNaXwfLwxqz+tsGJcPI9NVMgWZxR+2OrRfoUFLo+/OZ2SSBcyXXXBdBtmGnO11kT+8sXeDaxjMeZSmhpfOww1eh7fJVneoG/Jm3jGvAS+eEFUpTxTLubiZkBL6SkvpGUFVypyWPCGuK91rZpMzITxuX+d1bCtQ4zmXamvFVoXuTqRIGBz97JypG9h2gjBc8LeMWDljTISwOSRJf/CaHFF49jZw0rpQ3YASHC85UxN2koCNFKmO3QCJnQ501emQrgHE8lRdKevVtpkYkXkAH6l7B3CsIuTzCdSSR5gAs0e+kTNAmJdlQeMw/QM+CUJu04iFIyRU4GVuEHhBTS+dZGQup2GkuB3CxDfiYuFsrLSdGHc39AKZA2GceN2cHP/0iRIoZP9zozuZAiYHHkpCM4n7yeoUrbRnCNRLTPw2xfNHGzs7L804LhsjyiE//ul/NAh0NjheezvH0q9oqkBBDG+1h706cnYE32saJhw9C1ny8fxEipOajywlmGbLtQS0JCS1KcoIy4VxcCfRAKUDdQCizSkG/zQ9KAvru3owQMgnGhA8uODemVCVZv7UMMtYYs5TGhKSGWoVNaAeuYLsjDOAYa64lBWQNVVaydsccYGZCtYT/ABMnGDwxk2cKPZYvApW8yiCGA8MGEij2ATTRO+v4miUJHftEU7Mhh81xqJho2whVe8oScj9UcYBPVSNpMllu7VrhWGawj5EQaclFzcW1SAf2UlDwuGBDthDKx34Vn/mKcIMf+q5WbIwQdzLHGhNkFyKVpf5wQkFRp/AVMP5CO7OYUA6qsgoPTo77YJH7idz6a1zjVk33MYx9gvyHA22t/+WHWMPtn85jrGd7V+QY+wxAGtjAa/nJqs01qW8w8X1rW/wQTITmJNJtb4mnKnoczMRqcsQXG+H4ZX5r/blOSZ+jX/POADrwD1rnXSTQTQMt7fhn+ZyPm8ITmCuqNDUiPl2/yGKbx41uH4NTPFyn+M6rj79wId/vEjOh/suCqlpH7nlwXKnqDBo044JW2GlWTsVuyEqlUG6fZhL18uY2G2wxlygddQt4EkqkxM3+yvU8LRunnI3gsEvNxrNm2t9zfCRIcydZVR0IHNmFJsZXqUDZ4zX8Eo1J3QCKhrscfUJiYopdd32ux1k61Cws719MvBIeLiIhJcCs+rg2xKH8oyJn3em4fClGR5AvcizmgdG3FTC71FjsmG5maRmSaV4OY92jy6jiy4teNd83z16f/UeSLCcSgg8LqRGiGk5jXaj/kIcsmbqHMNAjy7NvvFbQVORwn2LhfOBFrx/PuhB9GO7zdLzZE19VnVv20SXdMLF5Lp272scHcA6mqVqYKrmUwX/PQNGZRcirBVHHOhnyiiYuwD1QB5v6ujtF26RXVz1slDphUjpKKrXtx3O7KKZGwHK7aN+Scjx8ojjwcMg1vfIhe1iJK4PxF0WW+ux4aJlfbBsEP8ahL/WEa2NgFaMUW2FqNbBk42YSBd3GIQdHtWbygfXORVigLL3cGcHhdQvBijNPXiMgtLOoyvcBnU0TRQ1I2bwMkI77uPjwhiaUQwb1/zfkGu+5Zk3xLPcvWzNb8scqfZT4JlslBgXmy1qupwc9XoXT8PP0nazrHR5rPB4OJCbln0PyDKD+sOldmzbZLnN0n4MDWLLjVvWtnVzI87tagemlyV8xmkbTS4D16GAyzzYRi6zs41c5vF2Q9GxK1P3UKsrqJN4lcROt1Y7QLd4D2cLF2OJB5Nlnv6xDBAc8GBrnwO/CmnVVwOr6FPS6RziZWUmulpWKjFvbJnHNzL0suP7Rj/+6b/JqOKZiWFL2TnLQLyBF6tUpW1iJuZf3tA983BFOO4EQ/TxfR1v6kKXbmr8uF18yIqwbs1cIEoPpGFSTpWsJlO08ooJxHC/eXFwOK4yfIqKHICVtX7xqxFmB49ZCbAS+ag/gBme0XEOU13SskIXmmLAxjiEi1t2BA4oZlgVhFeowGKX8TFL5klmkGNerjIu83MmUqkIxH90uXnno9vtwj+/+hX52tibyQGkemYplL6A/eLDbND1n1Cl5mZcLw86z8xpIHucEiN14CB4ty34uEueQA91wdMg48WP//lf5OgbOWu8nNYc8OYJdw7MpHR/b/8lis5bZv1fYZ5exZx3G4JEJ1z8C9hMcS6djhUhCRPnXEkBqIVbIac3FjFPt+zJU0r7AJQNXBiPIReimJAMKBhu6LWW4hlYQ5/Rgo54xkFSh/IfyDNasolUc/IDeQd+Lf+AmiQ/HIsfut0u/g+qdjr+3bpOh/xgn6kzUUgxqQpzwUCxc3lmaSpleGWrfrTKLXtNvrbnQ0ev2PNXFc9Solhl3Z1BCGs5BXdSFxMG+ZdjvvQPtsEVGqlgF8y9D9gOccCycRf2Jw7xtaMCDcUtl4eu8epjnMQ5L41VewyvvdlO96tRxhPSBP9gil4uUpiPbutlXJzh9hHOFo03desrKg7Lio5L8k6qMxjJ9AgnfA0d+sgdTqgmKbQwN1nGXNCMa+sjRk3R9fvMnPYGxj8YPjF3Ag4aJ400MJLyDEhsomiOLmmIYXOd/A4FSNPHaww90CFkNrmEZ9PPFZCjkTr9Srxjo6mUZ6YTe58J2VEXb/uxc3yvLHAkaGIoE0OfCBOpeSzOdocuCdtXqTgDYcg8pWRcVyA5wIUtY2qAFfyhuTWA8NFR+YrNgO+4AwM+/ors1Vl3TMIcYt8BPBZwmpwGF2JOnTUXs3bPgjQ1kKwcl9WhKrY2rKDAVHAL6yvUBTAbS1OuEPiX7jlQvwHcH5jVPLBU9y0XZ/pYQCjBqc3EZHUPJ2BmWMPeRyY/GO/rKYB8uv/64JD0ETAH56m/1B34IB1517EZjckSd/D3arQ+AzctU37ruMWj2bE4/frFIem7OfZ3eXqKk2+Ww+Y5NcLvCIITdKkYzUG8THGbKZZWIoWw/VaovGK5PAcfuUjhZUSb+ghfy7QL53NIOQ96Njc2ezvnusNOxz8g6e2X+NilCWZLpNBVzvwK7VuFt7uvZGninMAp7ykKvsM6NbTj4+jU4dUxUFCpTKjFTKoz7pz5TCRqXtheIYAkIMDdY2HX0xCWQ+Mp+b//Jaf7bxcwjsVBA7ea/V1X76RZrUUnrQ+t8fADMF9A6anDz2ujH3jqBZ6lZObpd1GLWEe47YkiDS2ZKYThXIC9i0MwoI3IAdHPxtvY8TypY1Z1CIB13fj1tZvvjYTcW4Y/2GPolBhrGdKXyaUAIRqnx6EpAFZ6zBk4ghIl4XJilhk+AGxLyapkGHqjmLmXaq9+uFXeNWc6jA6nqIkLqtTCSW5hOiUdfyEVzwQUxtxF67XXUg3vPTV3PU9rNt66ljqWLk7VxAnZ089nGbPXHE1n7r4odAe3Fbxa66qzC8CaPZPrcG2ujFL9g2ctxmP9DMJr7z97tgXA2Xf7jsUevph7ehwlSY3tBX6NATI+T5KPQDs9BlWsbidFwL9rRm24HxocnHThV7FvBCW/mC/C8D6mUSQwgUkextq7bnzxXQwcvkMUwbeQ28HPAaLjSQMact/F6JldUu94np5uBRGpHjRYL4VvjZrMHJaXo1ssxpPccCnAbMZtXBKAW5Rzgu4Qcv/06P3p1pdEQlC0CdUH1JaScDFlipdLum7JtvWjmC9qwdoKuEEJ7Akwe0AE6qJwe2BkbxQkbiGQe0nQ63bNHtaaZX3rF28hXGeh8XXm4NO2KPNvTEEKPVijfyJf0eRsRlWqMf8pLTmK/nOoCo2BOMxLlSNXsZvYiplRLcj5wLzgO+gNvObn5C/tYtogUu3cDGwDvIIXK409b+Twjr0KSUaKmVMzmVIxgY0AwldwUHNg/GmVmL2A8ELX/oXKSpjIJjBvzbiNzUtbhPFWM9CbrQwEN+CPvGj6jo00L1nz9Yo2prewze+qLPPPceOGu0ZbNM2+5uU31QjeIJaal1LN61YTXk6rEa5l2Nb/sB04JcV7aT5GS8UuD5nKMR7sgKlznlwz/T48saz7WxiK1/IVNM0uGOIHfKf5OjktuNXnjxwcpPlmyO3nYXzZqKsEXlJwWiyNacYpvB7b+VrHyfr5RnGU8YRZx7o1Y+19vf8tOX/Q247iwANzg7Xsf/vy2YtXBy8AGLtNwLbf2+5tY/yP1GVORTBS6/33tokrSI6zeS5+81z85rn4zXPxm+fiN8/F3xKjm+fiN8/Fb56L/+QJ3TfPxW+ei988F7/w/sPmufjNc/Gb5+I3z8VvnovfPBe/eS7+7+VJjM1z8Zvn4lexz81z8Zvn4jfPxX/Wz/FsnovfPBe/eS5+81z85rn4zXPxm+fi158+dyLSzXPxt3+Ia/Nc/Oa5+M1z8Zvn4jfPxW+ei988F795Ln7zXPzmufjNc/Gb5+J/ab6xzXPxm+fiN8/Fb56L3zwXv3ku/pPaqP5GnosP0k/1i4xyESQyNckbj9qPyL+Poylkd9w9ii4vYZi3kDoNir+vMEnX0fs4OqeKQ3Q6JoaMXR5DSHh1xiBL3TNzdaJ7COPHZtPj7cJWPkxIxGha7CGlr60bJqCE1ASQ28s+7ZebVH+KziBBFp2Z3GZBFi0su4wyKiYVZuCKTJ9X5u2RaTNv4xnmbbR/BGm8ICVhDWEzoaOZBvw/TGppg8tLkxMSs/qZ+ubTyhYWsa42rN/7q6ur/wdFu03J","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Draft Document","permalink":"/docs/API-docs/v1.1/draftdocument"},"next":{"title":"Create Document from Template","permalink":"/docs/API-docs/v1.1/createdocumentwithtemplateid"}}');var s=t(74848),r=t(28453),o=t(57742),l=t.n(o),a=t(78178),d=t.n(a),c=t(19624),h=t.n(c),p=t(96226),m=t.n(p),u=(t(77675),t(19365),t(51107)),x=t(21312);const g={id:"createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file.",sidebar_label:"Create Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztPdtyHLl1v4K0U5E47pnhjCitzFUUcyV5V/FaYolUVBtSITHdmBmI3UAv0M3hmMsqP7jyAam85NU/kfd8yn5J6hxcGt1z4UXatdaerbLFQeNycHBwcG44uIxKOtHR7lH0XCZVzkSpo/dxlDKdKF6UXIpoNzqcMvJMMVoy4mqRvf2XhGaZnGlSaaY0KSWZMMEU1BJsRlLXHxnNSaHkOU+5mJCUlpTMeDklI6rZox3CRCJTlpIxz1jvWByLQ17skrdFJmlK5rJSZP/573xvMAyUHXU6z9mompC3Lzud9/enZVno3X6fFkVPFkxoPhEZHeleIvN+ChWLdLwVk9mUKQa9koQKwqjm2ZzQNCUznk5YqWNSTpkgiSzmJJFSpVzQkumYFHTCiKjyEVM6JlSkJJeKES4IJYrRdN4tZbfSjPzrwetXZCxVTsse2c8qHfvhUq5YUmZz0305ZX5W97TDhi4VF5OY5PQMsMVL8n3FkzOYtmYihX+h4d7+S8RVp3NQFYVUJUvJOzOF3U4HvnzFMjkjVDGsn8g8l4IUVNGclbhcU1riZ8W+r7hiqVkUmmUOF7vHoks6HUFzttvpkLeCf18xwlMmSj7mTMEsSTnl2jbomfrlvMD6L0XKE0AeAgClRI6bVQGpUPWgYAl0aaoGqCZSkNmUJ1PE4Yya9S8ymphpKaYLlpT8nDU7vojJHDp+zoR0EEyl4n+UoqQZLt85UyVPaBYuMwAIVXVJVQnoLyQXpSu1I5Dv7HLCauMiWjoE0FJAbs4FftGMnNOsYtpCNYvJFKB6wwrFNG4N2y8gXqRkyvhkunI8mn6odNnomFQawAyhsGO5VUX0MkTbmGaaET5u4DKnZywYjUjc8zTrka/mJGVjWmVlTDhQaKkq1iOvZEloUWQ8oaOMIQ3AZqNlpVgXV9mST69JPvvIAZgmlKR8PGYKNjN8xC5sGwcd0GXNMnCnlVMqiBSthU5kJtUiCWFxE48kkaJkouyRvXPKMwTeTFYTLpKsShkZZTQ5i8koq1hMFEvNRp8zYHOxZVpQhVBtcY74IZplQIVSAPxC2uG5JtpClfbIIWwUv//go0M1DsJ1iFW7y8cSRgYUuC1JWE55FiPiYvJBjkjJy4zFsMELKuYx8FcWk5JdlCN5EZNkypIz/EvRlEsyqspSCjOxVMkilTNhcTmWotT8j0t2pPtye4wOY7ITk0cxeRyTwXZMBsOYDHZiMngUk8HjmAy3YzIcxmS4E5PhIwPW8LHFNfUIDgEYDA2Wy18Wdqc8ZSfQ8ATmdkJ1yRTXZ8CuyTs4c5gA4NLYsEt2UQLzQ27EJ4Kl9QnINZnyNGWCjJXMiWIJLzhyE8MNfNcxwEMUTEpoMq6ybE7OueYBDnynciYAbzgiV+R1wcQBnwhCk0RWsMaIYYNURGe95CKbA6iHjOYaZ/5ClEwVimsGrFpojwFR1rRlDkAoCxnATVZSNDnQ6tVctTrBysAJ+i3XyHPh6NP+NJ01TtNBj3Q6ns9B2enp6bG4PBaEHEfA9o6jXXIc+SrHUWy+wWkG3wb29wX8eDD8wv6cw89Hw8f25wyrDnbszyn8HLqmdnMdR7s4LlbgojQjW/5KAgig0tWxuLLAHoshzqKkebFmBvD5p4WeePDdKQWFcLzE7gPswEV4VszY1FiY7QOYLRe85DTTqyfsanxGc26BtHzadaWFme/AzJGXrZ42fv6M5hzCA1/wDDWf8MwNPrnTAKEYrkFRu89VPBhaoXS0gMmHPSvCrEakmcJng8cAnE+FxlaXt8fiI8AiHKeHcJyuRqU/cT8jfLZh+lRIXdbv7TH7RQ+FYJROVuPVVviMsNqE6FPhdLHX22P0MWAUxLzV6ISvnxEuA3Dgg5WZzbftne7gYXe4Pdxp4BOsE6ZCnnfTtDufzz9uLXIuTgwc0Cion9OL5R/AaAKio18J/wUkGC4mvlnz6+Kqm3qthQSB02ICZE6nfhqhF0xUKDsv2hZQ9a9rWYUH/3b6+B9ACx85BZWlVmqu1RFv/glV6FKmdH5Pm65cU695Qf22bGzAxE8AB5rCkqnkiQUe6jh9awTWnh7goIuL2k/TfrCoUJim3TzvtgrhZxdpICjM816a9lo1FwjFFOYkTWOyWLy0PE1Jnucrik15o7if54uz6OW5hc1iz9HewjrnXPC8Ag0JrGpGQYeKoGRY9OZ2Lbkgnc533333XfcPf+g+f97puDW0Q1gqDgwZZgR68YlGCIm+09klL8ckLEJjgjHjIBfwiqE1qZoKUzkTTh9CrVGRtAJ7oqtqjEk5nWNnjJdTpprjSFWTLGiPoGyNZDntkbeoXMLfTgnzyhIqUr8Bxmk149W801b4udhnzSWbA69lratZU4O3LohFjjEVy+UmxSZVRhW7AOuf5lIs8MS7nIG3O99abNHRcm1pQbuitewyZ+gg919bHXzLmxdbc4He9khS6RJNEhN2QQpalkwJ7OycZjyluD+6WMAuaF6AaaX/H8fH6a//sY+GXbCdlsaikPIJB3t8/z+O9rr//n5JjaoomEqoZiRjMJKOCSuTHjmasqyoXQKz2aw3e6CTqZSZ8Qd80IqNzf+fyNGHEwS36FFdbC2bqSGGwJAKxNK2o+LmDDBGNXEtl5hScWlw1wy2UYKzloo1Ipyt8RnJHS2Q4KOxSsPnIzj6UbgF4mX13xJ4znH0vj7u0XjK0mvavr/B9oTdkNERyxY/3X5rZXQuK7ujnbOgOVVL0QHerCjk7cE4ne04+EgvWh/Nt6sl+9QgJNym7rR329OtAMm49gdJA51ha+syQMePYAx9SSNGXANw0zku8LG7wAN2s23g7KO4dtcMAfUIVvTuGjfaNSM0FmbhJLeygvM7jX2vDmXuIA/xBS3B+1mLCWtGsLLC6hHAybN6gGMxQCuks16u0U9sjc+IV7RAWr+N78JFGifzXY7UO21AN61wAy45XqGqOVj95tOrd1+PvDYmddcIzO1JwgqQtD56a3qQb3xCodU4tKCvpryw1mdEfUvA+okp0Nb71KfPnYg0nP0viFAbYN+YWI3RP6eTNfYb/PwZkWcIz3ITh62xYKwaoKXfnChrLNT4ff2EB9uNCT9sTvjR9h00rsawH69wba/Bz8JQoFtXGV04DlKW8JxmGEGCcA8/Yo/eRfmygMEeeCbzoirDTYdmHWQsTkpwcRHGs/vrmHRj0olJPyb3Y7LVI28YRlIkPurCCg1cmdgKLkgqK3CTJpXK5mSkYOIxYb1Jj1xefl9RUfJyfnVFOuTyEmK3rq56sAvPhJyZwIsjcBmXBAKnaqUqlYleEmglE90H7av/is26LlSsb0HbIvdliyWsVUUtCn5ejcxAFRAJjPLKi2xGK8VIH66LjM4JHYOb2kSDYDMTNNQDFO+SIfnnp2Qw7G1vx2Tb/E3uuwkOt3APo48pYdk6JyV+vm4Hb4c7uP65jGU93L7RFg6HveMOhi5OMIYAx71WYKs392doOqkn0zbWBlI94Mycn3oqqyyF01OxslKC+fi9WqZH3xgtS5pMMVpyNQ0ElT6jw6uGyrKgtQcZBHku81h3OvuKjXmWBVGMxBU51gZRYSxjuY2cs/GLoNVhxAYXpQT24UJaOp0RG0uI1oAwSrSP0jrO0SyBkWAakTAJBLpKRaZUG3MTEhwsHMSJllOWt+JGHHh17AgXDnZYzcGnM4wOf9Pc448eNlb2YfOYXrnHVy3sGnspNNGFFNq7RVn9Kdh82KcrX9Sw2hvKdQrLjWFDdfQT8nLcPxk/YyHL5UI7YdVC2Y4GfDaVUtc1bECePX70bjPQTyqI9dvq+QiZj/X+Db540JClHv+M3r/mKm3v9AcP+2vdfy1P0e11ZkJusqToXLjRkmLNek03vrGP8Y19/I548Cnt04Mvho2T6cE6GeUzsU+HO+oay/SnsD/fScVfZggO9+ENTcA/myn248ly56cwSrUY9xeDv4JR6mNJdMH29MmIknwqw9MyyryB5WmtuemjKTcE9ien3oefxkrVUvl+05AGfzMMqfXhw4+j1raNKiC544j/21ev38y2f//1RO7t7e29Ong7ffF2sre3l8PvXq+31HK5jAxwGJCf7XUoe8SjuLBilF6vh1ELtKS72LxfiMmXpn28uk3vWERxJAu4sMaleJlGuxGK/sxpAlGMiGG6/Eqm82j3MrIXHuBPG4AOTfsfNNySu4x0MmU5hb8cQuFeHag8URyZeAwdxRFG/cElO1jraDeSow8sgdEKBeCUnGnoA9vtXrpa5mJYFFvxLdqNzBSjOLK+dF/kr9QV6Ti6irGnk4JqPZMqXdulL6m7hA4MxLdsqPEPr1dBP3AZ647dvIKmV62LiXfq6XnQA84tZ4cSbHEZK9lzOtdBv0arj9r3IaENsJHEtiIpnWtgR5U2Z2pCs6TKQEZlFwVXcx9MhoJqQGAeXj+Sh3fw8KqmmhokqhSdR3HES5aH5SuoSMnbr1zCJGAGo6dv2/aDZCPGfmsLwCqIC0/zW0PxQTIyYrjoxVSKW7cfDB8MhoMHgyH0YCNDb9uHs3BCFx/k6OROGyFl55FfypObL0iT5po3sqAXf3K5C0A+ENHGhRVKJkzrHtmDqzEsteLfbh1xBl4Db4/c2jWhjVN6zggwXUbBwCGCOyXNy3fnnM2gh13yhiWMn1vYwqu6UAWjdb40/nPsW8jWHUFaQMiU6wramItEtrzZ7ZfQvg2Rv8Vq2DoTVQ6818wxiiMDahRHbijgvwFrMPWu4ggECq1PgH/eZZVmcJNLM4j3hHtMosqZ4gkxvRLoFdiEv3LrJCUbrAc2JlMTZg+FjZn32vS98/ARwGyReXcmYb4uzrY5tyYV+St+filicxMn9jdT4o+4T+fc1O27W3jCx9bcGhtja0wC02jvulPAgYuMhU7Y9ez+cNWl5OAupDX10qJgVPXwbvCdr6k3TxAvGfeuOS+u4uji+slckER23Y1ncj9j49JE0pFEKsHUVhgZ/dlMbrizcxVH8+unN/9FTu8LWLzZ9bN7h1fF62v0fw1YHzy+iqPp9bB+4y+z/xWB3Xl0VcuvLfn+ZCTT+YljnlfXVXSiGNQbyyxl6uVSYbopOkPShpO2JDWSMmNULGE0jbuvNr0GKK7gz7Tmz9mUoYfY67PYe60sW++ngdYGojeCe7kGPVNV7DjqQZx5rXqjQNG+fuvq4pkkJLmH453oCs+Se337G3B0L0wwAb6Z+kqEAwErk5LlRYYZF2bg4BmhQyztEf+fOcUdJgEAJ5C6ga8/r56ZYGQc0DZqpisgVr3rkWdU+POseZmYXF56MkDquLoil5ewqkydwLl2dRXXBTBWowAlV1OijIwUtvJFrG7oy4KmRonAAH1TYM/PEAAbxF8p2w/oWldXTZGhBTi6uCwOWOrpDMSOxVl7jQBX+sbYX0C2pQDo5O8G70+Kp9/wJaA86RdPnxRP30FykoKZvWfQM+YiNTt/xrKsR57oUkkxedpCwZO+LV++lApl6VqYrHtp49Z31LMwfQeMul48rkmiqoTTDKPwQbFwnlT0foP1S5es0BBmwUujgqC2ghovnSiGflsj1lclJmNB64kb8AklU8XG/3yvhdN7TzEPAYSfPOnTp7b2S2PPM6qKmBOcOBofpTKW7XGlkE0mGVV8bE01MSlAq2GYuoImJkDEYNTBcTil4kzHT0bqKWQ08JkQfvzzX6CG4+kvxWuVMnUDpg43eYwl8h7wsXuxub2A5M6VLp3wj5zQUohXCpZtHSteQxjLC8/6dTXSUEu4/mrWWio+mTBQN2wNbGxzbDCaTM2hgVDV0SwFEI+stAMPCMzZO1IbYuRvFYXm0gA7wa0lM/feEq6OJyQXJxJanJh7VDdA6zuraYWINZMx8HJNRplMzoAUQOIzipXPluN01EqUPMPUDwXgPnWXpQCBSF3tOVOM7u6RF2IsVcI0MRAHuK3RgvZqtBTCSQcA3wuwcw8N2Jn2yCHPDQ5xQe+hxbmJMSwCJRW45IkcjzMuGAomd6JDN0+IO9fVCC7WUJObygkCHk02B4lNMCIIu4CrPcgNZIanqkkgYjjOzWdikp68Pty/wQTQkN81gNlEJEjipg/y+nAfkjr5vQ431vw2cPuKNqoYhfycU6eoerVubswVzPiv5RJd3KZT6pJFgFKul0IUG4kOUOhTpi10XGcJg/0pqxLCTrjNgIIsdg0iD2V1E5Z0DSYpmVR4sbUE3u1EJrxgVSdl4kKXqjJXHdwtw6XGJ4cnhxWoFPQfEya0aU7JGKOwYlIJDphXFfh2fJfsomCKQ7TjUhQoZlAH58b18knTnvb2zbc2N1xgjnEM1HUMG6BAqkGWsMBL2lNfqgzYs/t6AEFwxxhOa+YrmNJSwPkm1YQKe3waYwR4oUZsSjNT1Z4TEPqA/GzBduTUrB///JcArpUG30XAzAg0TSEe7xoI0aFnCB44jWIFHH+yCRH0x9Rv2/pf5LldLlO/kfTNaXwfLwxqz+tsGJcPI9NVMgWZxR+2OrRfoUFLo+/OZ2SSBcyXXXBdBtmGnO11kT+8sXeDaxjMeZSmhpfOww1eh7fJVneoG/Jm3jGvAS+eEFUpTxTLubiZkBL6SkvpGUFVypyWPCGuK91rZpMzITxuX+d1bCtQ4zmXamvFVoXuTqRIGBz97JypG9h2gjBc8LeMWDljTISwOSRJf/CaHFF49jZw0rpQ3YASHC85UxN2koCNFKmO3QCJnQ501emQrgHE8lRdKevVtpkYkXkAH6l7B3CsIuTzCdSSR5gAs0e+kTNAmJdlQeMw/QM+CUJu04iFIyRU4GVuEHhBTS+dZGQup2GkuB3CxDfiYuFsrLSdGHc39AKZA2GceN2cHP/0iRIoZP9zozuZAiYHHkpCM4n7yeoUrbRnCNRLTPw2xfNHGzs7L804LhsjyiE//ul/NAh0NjheezvH0q9oqkBBDG+1h706cnYE32saJhw9C1ny8fxEipOajywlmGbLtQS0JCS1KcoIy4VxcCfRAKUDdQCizSkG/zQ9KAvru3owQMgnGhA8uODemVCVZv7UMMtYYs5TGhKSGWoVNaAeuYLsjDOAYa64lBWQNVVaydsccYGZCtYT/ABMnGDwxk2cKPZYvApW8yiCGA8MGEij2ATTRO+v4miUJHftEU7Mhh81xqJho2whVe8oScj9UcYBPVSNpMllu7VrhWGawj5EQaclFzcW1SAf2UlDwuGBDthDKx34Vn/mKcIMf+q5WbIwQdzLHGhNkFyKVpf5wQkFRp/AVMP5CO7OYUA6qsgoPTo77YJH7idz6a1zjVk33MYx9gvyHA22t/+WHWMPtn85jrGd7V+QY+wxAGtjAa/nJqs01qW8w8X1rW/wQTITmJNJtb4mnKnoczMRqcsQXG+H4ZX5r/blOSZ+jX/POADrwD1rnXSTQTQMt7fhn+ZyPm8ITmCuqNDUiPl2/yGKbx41uH4NTPFyn+M6rj79wId/vEjOh/suCqlpH7nlwXKnqDBo044JW2GlWTsVuyEqlUG6fZhL18uY2G2wxlygddQt4EkqkxM3+yvU8LRunnI3gsEvNxrNm2t9zfCRIcydZVR0IHNmFJsZXqUDZ4zX8Eo1J3QCKhrscfUJiYopdd32ux1k61Cws719MvBIeLiIhJcCs+rg2xKH8oyJn3em4fClGR5AvcizmgdG3FTC71FjsmG5maRmSaV4OY92jy6jiy4teNd83z16f/UeSLCcSgg8LqRGiGk5jXaj/kIcsmbqHMNAjy7NvvFbQVORwn2LhfOBFrx/PuhB9GO7zdLzZE19VnVv20SXdMLF5Lp272scHcA6mqVqYKrmUwX/PQNGZRcirBVHHOhnyiiYuwD1QB5v6ujtF26RXVz1slDphUjpKKrXtx3O7KKZGwHK7aN+Scjx8ojjwcMg1vfIhe1iJK4PxF0WW+ux4aJlfbBsEP8ahL/WEa2NgFaMUW2FqNbBk42YSBd3GIQdHtWbygfXORVigLL3cGcHhdQvBijNPXiMgtLOoyvcBnU0TRQ1I2bwMkI77uPjwhiaUQwb1/zfkGu+5Zk3xLPcvWzNb8scqfZT4JlslBgXmy1qupwc9XoXT8PP0nazrHR5rPB4OJCbln0PyDKD+sOldmzbZLnN0n4MDWLLjVvWtnVzI87tagemlyV8xmkbTS4D16GAyzzYRi6zs41c5vF2Q9GxK1P3UKsrqJN4lcROt1Y7QLd4D2cLF2OJB5Nlnv6xDBAc8GBrnwO/CmnVVwOr6FPS6RziZWUmulpWKjFvbJnHNzL0suP7Rj/+6b/JqOKZiWFL2TnLQLyBF6tUpW1iJuZf3tA983BFOO4EQ/TxfR1v6kKXbmr8uF18yIqwbs1cIEoPpGFSTpWsJlO08ooJxHC/eXFwOK4yfIqKHICVtX7xqxFmB49ZCbAS+ag/gBme0XEOU13SskIXmmLAxjiEi1t2BA4oZlgVhFeowGKX8TFL5klmkGNerjIu83MmUqkIxH90uXnno9vtwj+/+hX52tibyQGkemYplL6A/eLDbND1n1Cl5mZcLw86z8xpIHucEiN14CB4ty34uEueQA91wdMg48WP//lf5OgbOWu8nNYc8OYJdw7MpHR/b/8lis5bZv1fYZ5exZx3G4JEJ1z8C9hMcS6djhUhCRPnXEkBqIVbIac3FjFPt+zJU0r7AJQNXBiPIReimJAMKBhu6LWW4hlYQ5/Rgo54xkFSh/IfyDNasolUc/IDeQd+Lf+AmiQ/HIsfut0u/g+qdjr+3bpOh/xgn6kzUUgxqQpzwUCxc3lmaSpleGWrfrTKLXtNvrbnQ0ev2PNXFc9Solhl3Z1BCGs5BXdSFxMG+ZdjvvQPtsEVGqlgF8y9D9gOccCycRf2Jw7xtaMCDcUtl4eu8epjnMQ5L41VewyvvdlO96tRxhPSBP9gil4uUpiPbutlXJzh9hHOFo03desrKg7Lio5L8k6qMxjJ9AgnfA0d+sgdTqgmKbQwN1nGXNCMa+sjRk3R9fvMnPYGxj8YPjF3Ag4aJ400MJLyDEhsomiOLmmIYXOd/A4FSNPHaww90CFkNrmEZ9PPFZCjkTr9Srxjo6mUZ6YTe58J2VEXb/uxc3yvLHAkaGIoE0OfCBOpeSzOdocuCdtXqTgDYcg8pWRcVyA5wIUtY2qAFfyhuTWA8NFR+YrNgO+4AwM+/ors1Vl3TMIcYt8BPBZwmpwGF2JOnTUXs3bPgjQ1kKwcl9WhKrY2rKDAVHAL6yvUBTAbS1OuEPiX7jlQvwHcH5jVPLBU9y0XZ/pYQCjBqc3EZHUPJ2BmWMPeRyY/GO/rKYB8uv/64JD0ETAH56m/1B34IB1517EZjckSd/D3arQ+AzctU37ruMWj2bE4/frFIem7OfZ3eXqKk2+Ww+Y5NcLvCIITdKkYzUG8THGbKZZWIoWw/VaovGK5PAcfuUjhZUSb+ghfy7QL53NIOQ96Njc2ezvnusNOxz8g6e2X+NilCWZLpNBVzvwK7VuFt7uvZGninMAp7ykKvsM6NbTj4+jU4dUxUFCpTKjFTKoz7pz5TCRqXtheIYAkIMDdY2HX0xCWQ+Mp+b//Jaf7bxcwjsVBA7ea/V1X76RZrUUnrQ+t8fADMF9A6anDz2ujH3jqBZ6lZObpd1GLWEe47YkiDS2ZKYThXIC9i0MwoI3IAdHPxtvY8TypY1Z1CIB13fj1tZvvjYTcW4Y/2GPolBhrGdKXyaUAIRqnx6EpAFZ6zBk4ghIl4XJilhk+AGxLyapkGHqjmLmXaq9+uFXeNWc6jA6nqIkLqtTCSW5hOiUdfyEVzwQUxtxF67XXUg3vPTV3PU9rNt66ljqWLk7VxAnZ089nGbPXHE1n7r4odAe3Fbxa66qzC8CaPZPrcG2ujFL9g2ctxmP9DMJr7z97tgXA2Xf7jsUevph7ehwlSY3tBX6NATI+T5KPQDs9BlWsbidFwL9rRm24HxocnHThV7FvBCW/mC/C8D6mUSQwgUkextq7bnzxXQwcvkMUwbeQ28HPAaLjSQMact/F6JldUu94np5uBRGpHjRYL4VvjZrMHJaXo1ssxpPccCnAbMZtXBKAW5Rzgu4Qcv/06P3p1pdEQlC0CdUH1JaScDFlipdLum7JtvWjmC9qwdoKuEEJ7Akwe0AE6qJwe2BkbxQkbiGQe0nQ63bNHtaaZX3rF28hXGeh8XXm4NO2KPNvTEEKPVijfyJf0eRsRlWqMf8pLTmK/nOoCo2BOMxLlSNXsZvYiplRLcj5wLzgO+gNvObn5C/tYtogUu3cDGwDvIIXK409b+Twjr0KSUaKmVMzmVIxgY0AwldwUHNg/GmVmL2A8ELX/oXKSpjIJjBvzbiNzUtbhPFWM9CbrQwEN+CPvGj6jo00L1nz9Yo2prewze+qLPPPceOGu0ZbNM2+5uU31QjeIJaal1LN61YTXk6rEa5l2Nb/sB04JcV7aT5GS8UuD5nKMR7sgKlznlwz/T48saz7WxiK1/IVNM0uGOIHfKf5OjktuNXnjxwcpPlmyO3nYXzZqKsEXlJwWiyNacYpvB7b+VrHyfr5RnGU8YRZx7o1Y+19vf8tOX/Q247iwANzg7Xsf/vy2YtXBy8AGLtNwLbf2+5tY/yP1GVORTBS6/33tokrSI6zeS5+81z85rn4zXPxm+fiN8/F3xKjm+fiN8/Fb56L/+QJ3TfPxW+ei988F7/w/sPmufjNc/Gb5+I3z8VvnovfPBe/eS7+7+VJjM1z8Zvn4lexz81z8Zvn4jfPxX/Wz/FsnovfPBe/eS5+81z85rn4zXPxm+fi158+dyLSzXPxt3+Ia/Nc/Oa5+M1z8Zvn4jfPxW+ei988F795Ln7zXPzmufjNc/Gb5+J/ab6xzXPxm+fiN8/Fb56L3zwXv3ku/pPaqP5GnosP0k/1i4xyESQyNckbj9qPyL+Poylkd9w9ii4vYZi3kDoNir+vMEnX0fs4OqeKQ3Q6JoaMXR5DSHh1xiBL3TNzdaJ7COPHZtPj7cJWPkxIxGha7CGlr60bJqCE1ASQ28s+7ZebVH+KziBBFp2Z3GZBFi0su4wyKiYVZuCKTJ9X5u2RaTNv4xnmbbR/BGm8ICVhDWEzoaOZBvw/TGppg8tLkxMSs/qZ+ubTyhYWsa42rN/7q6ur/wdFu03J",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-2",custom_edit_url:null},y=void 0,j={},f=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Create Document"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/createdocument",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The Create Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Unique identifier for this widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Specify the hint for widgets. This parameter is optional and is not applicable to the following widgets: checkbox, radio button, dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options":{\n "hint": "Provide signature"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp",\n "hint": "Provide stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials",\n "hint": "Provide initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide email",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide name",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide job title",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide company",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12,\n "min_date": "",\n "max_date": "",\n "readonly": false,\n "signing_date": false,\n "hint": "Provide date"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"min_date:"})," Provide the minimum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"max_date:"})," Provide the maximum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"signing_date"}),": If signing_date is set to true, the signing date is shown to the signer during signing. You may set either signing_date or default, but not both. Using both is not supported."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image",\n "hint": "Provide image"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"14",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Provide number",\n "formula": "",\n "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,s.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"decimalplaces:"})," Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"15",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"cells"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "cells",\n "page": 1,\n "x": 100,\n "y": 100,\n "w": 114,\n "h": 50,\n "options": {\n "name": "cells",\n "required": true,\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"cell_count:"})," Specify the number of cells that should be returned to the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"16",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"attachments"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "attachments",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "attachment widget",\n "hint": "Provide files"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,s.jsx)(n.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "required": true,\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "response": "04/15/2024",\n "format": "mm/dd/yyyy",\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "required": true,\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,s.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(x.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(h(),{...t(52821)}),"\n",(0,s.jsx)(m(),{...t(64795)})]})}function w(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}},52821(e){e.exports=JSON.parse('{"title":"Body","body":{"content":{"application/json":{"schema":{"required":["file","signers","title"],"type":"object","properties":{"file":{"type":"string","format":"base64","example":"base64 encoded pdf"},"file_password":{"type":"string","format":"string","example":""},"title":{"type":"string","format":"string","example":"sample document"},"note":{"type":"string","format":"string","example":"sample Note"},"description":{"type":"string","format":"string","example":"sample Description"},"timeToCompleteDays":{"type":"number","description":"time to complete days is used to calculate expiry date of your document","format":"number","example":15},"signers":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","format":"string","example":"ceo"},"email":{"type":"string","format":"string","example":"joebee@example.com"},"name":{"type":"string","format":"string","example":"joe bee"},"phone":{"type":"string","format":"string","example":"123121312"},"company":{"type":"string","format":"string","example":"opensign"},"job_title":{"type":"string","format":"string","example":"dev"},"signer_role":{"type":"string","format":"string","description":"Specifies the role of the recipient in the signing process. Allowed values:\\n- **signer** (default): Must have at least one signature widget.\\n- **viewer**: Receives the document to view only; must have no widgets.\\n- **approver**: Reviews and approves the document; no signature widget required.\\n","enum":["signer","viewer","approver"],"example":"signer"},"access_code":{"type":"string","format":"string","description":"when set, this numeric access code is required for the signer to access and sign the document.","example":"123456"},"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Allowed values include signature, stamp, initials, email, name, job title, company, date, textbox, checkbox, dropdown, radio button, image, number, cells, attachments.","format":"string","example":"signature"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":244},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":71},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":38},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":46}},"title":"createdocument_body_widgets"}}},"title":"createdocument_body_signers"}},"folderId":{"type":"string","example":""},"send_email":{"type":"boolean","description":"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \\"true\\". If the value of this parameter is \\"true\\" and no \'email_subject\'/\'email_body\' parameters are specified default email templates will be used. \\n","example":true},"email_subject":{"type":"string","description":"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.","example":"{{sender_name}} has requested you to sign {{document_title}}"},"email_body":{"type":"string","description":"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.","example":"

Hi {{receiver_name}},

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

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

Sign here

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

Thanks,
Team OpenSign\u2122

"},"sendInOrder":{"type":"boolean","description":"If set to \'true\', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to \'true\'.","example":true},"send_in_order_strict":{"type":"boolean","description":"When set to \'true\', each signer is blocked from accessing the document until all preceding signers have completed their action. Enforces strict sequential signing. Only applies when \'sendInOrder\' is also \'true\'. Defaults to \'false\'.","example":false},"allow_offline_sign":{"type":"boolean","description":"If set to \'true\', signers can submit a copy of this document signed using an external tool for owner review. Defaults to \'false\'.","example":false},"enableOTP":{"type":"boolean","description":"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.","example":false},"enableTour":{"type":"boolean","description":"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.","example":false},"redirect_url":{"type":"string","description":"Specifies the URL where the signer will be redirected upon completing the document signing process.","example":""},"sender_name":{"type":"string","description":"The name of the person or organization on whose behalf the email is being sent.","example":"opensign\u2122"},"sender_email":{"type":"string","description":"The email address of the person or organization that users can reply to.","example":"mailer@opensignlabs.com"},"allow_modifications":{"type":"boolean","description":"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.","example":false},"auto_reminder":{"type":"boolean","description":"Set to true to enable automatic reminders. Set to false to disable them (default behavior).","example":false},"remind_once_in_every":{"type":"number","description":"Number of days between reminders. This is only applicable when auto_reminder is set to true.","example":5},"merge_certificate":{"type":"boolean","description":"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\\n\\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\\n\\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\\n","example":false},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed. \\n"},"cc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"cc (carbon copy): Users added here will receive a notification email once the document is completed.\\n"},"prefill":{"type":"object","description":"You can provide widgets which can embed before sending to signer","properties":{"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","format":"string","example":"textbox"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":100},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":30},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":40},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":80},"options":{"type":"object","properties":{"name":{"type":"string","example":"textbox"},"response":{"type":"string","example":"joe"},"color":{"type":"string","example":"red"},"fontsize":{"type":"number","example":12}}}}}}},"title":"prefill"}},"title":"createdocument_body"}}},"required":true}}')},64795(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Document created successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"hji2zxcv2P"},"signurl":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","format":"string","example":"mail@example.com"},"url":{"type":"string","format":"string","example":"https://url-to-sign-document.com"}},"title":"inline_response_doc_signurl"}},"message":{"type":"string","format":"string","example":"Document sent successfully!"}},"title":"inline_response_doc"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/34593b53.e208adbc.js b/assets/js/34593b53.e208adbc.js deleted file mode 100644 index 0203266d6..000000000 --- a/assets/js/34593b53.e208adbc.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[9099],{28598(e,n,t){t.r(n),t.d(n,{assets:()=>y,contentTitle:()=>j,default:()=>w,frontMatter:()=>g,metadata:()=>i,toc:()=>f});const i=JSON.parse('{"id":"API-docs/v1.1/createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file.","source":"@site/docs/API-docs/v1.1/createdocument.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/createdocument","permalink":"/docs/API-docs/v1.1/createdocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file.","sidebar_label":"Create Document","hide_title":true,"hide_table_of_contents":true,"api":"eJztPdlyHDeSv4Kt2AhJPdXVB0lJ5moUQ0taWzu2xJCodXhJDQddhe6GWAWUARSbbUZHzMP8wT7t63yav2QjE0BdffAQbVMz7QeLjcKRSGQmEnkAl4GhEx3sHwcvZVxkTBgdfAyDhOlY8dxwKYL94GjKyAvFqGHE1yIHh68JTVM506TQTGliJJkwwRTUEmxGEt8fGc1JruQ5T7iYkIQaSmbcTMmIavZ4lzARy4QlZMxTFp2IE3HE833yIU8lTchcFoocvvzPsjcYBsqOO52XbFRMyIfXnc7Hh1Njcr3f69E8j2TOhOYTkdKRjmKZ9RKomCfjRyGZTZli0CuJqSCMap7OCU0SMuPJhBkdEjNlgsQyn5NYSpVwQQ3TIcnphBFRZCOmdEioSEgmFSNcEEoUo8m8a2S30Iz81/u3b8hYqoyaiBymhQ7L4RKuWGzSue3eTFk5qwfaY0MbxcUkJBk9A2xxQ34qeHwG09ZMJPAvNDw4fI246nTeF3kulWEJ+cFOYb/TgS9fs1TOCFUM68cyy6QgOVU0YwaXa0oNflbsp4IrlthFoWnqcbF/Irqk0xE0Y/udDvkg+E8FIzxhwvAxZwpmScyUa9cgsvXNPMf6r0XCY0AeAgClRI6bVQGpUPV9zmLo0latoZpIQWZTHk8RhzNq1z9PaWynpZjOWWz4OWt2fBGSOXT8kgnpIZhKxX+WwtAUl++cKcNjmtaXGQCEqtpQZQD9ueTC+FI3AvnRLSesNi6io0MALQHkZlzgF83IOU0Lph1Us5BMAap3LFdMI2u4fgHxIiFTxifTtePR5FOhTaNjUmgAsw6FG8uvKqKXIdrGNNWM8HEDlxk9Y7XRiESep2lEvp6ThI1pkZqQcKBQowoWkTfSEJrnKY/pKGVIA8Bs1BSKdXGVHflETfI5RAnANKEk4eMxU8DM8BG7cG08dECXlchATjNTKogUrYWOZSrVMglhcROPJJbCMGEicnBOeYrA28lqwkWcFgkjo5TGZyEZpQULiWKJZfQ5AzEXOqEFVQjVDueIH6JZClQoBcAvpBuea6IdVElEjoBRSv6Djx7VOAjXdaw6Lh9LGBlQ4FmSsIzyNETEheSTHBHDTcpCYPCcinkI8pWFxLALM5IXIYmnLD7DvxRNuCSjwhgp7MQSJfNEzoTD5VgKo/nPKzjSf7k5Roch2Q3J45A8DcmgH5LBMCSD3ZAMHodk8DQkw35IhsOQDHdDMnxswRo+dbimJYLrAAyGFsvmy8LulCfsFBqewtxOqTZMcX0G4pr8AHsOEwBcElpxyS4MCD+URnwiWFLtgFyTKU8SJshYyYwoFvOcozSx0qDsOgR4iIJJCU3GRZrOyTnXvIaDslM5E4A3HJEr8jZn4j2fCELjWBawxohhi1REZ7XkIp0DqEeMZhpn/koYpnLFNQNRLXSJAWEq2rIbIJTVBcB1VlI0JdD61Vy3OrWVgR30O65R5sLWp8vddNbYTQcR6XRKOQdlf/3rX0/E5Ykg5CQAsXcS7JOToKxyEoT2G+xm8G3gfl/Aj53hE/dzDj8fD5+6nzOsOth1P6fwc+ibOuY6CfZxXKzAhbEjO/lKahBApcWJWDhgT8QQZ2Folm+YAXz+daEnJfh+l4JC2F5C/wE4cBmeNTO2NZZmuwOz5YIbTlO9fsK+xj2acwuk1dOuKi3NfBdmjrJs/bTx8z2acx0e+IJ7qP2Ee27tk98NEIrhBhS1+1wng6EVakdLmNyLnAqzHpF2CvcGjzVw7gqNrS5vjsXHgEXYTo9gO12PynLHvUf4bMN0V0hd1e/NMfskQiUYtZP1eHUV7hFWmxDdFU6Xe705Rp8CRkHNW49O+HqPcFkDBz44ndl+6+92B3vdYX+428AnWCdshSzrJkl3Pp9/3lpkXJxaOKBRrX5GL1Z/AKMJqI7lSpRfQIPhYlI2a35dXnVbr7WQoHA6TIDO6Y+fVukFExXqzsu2BTz6V7XcgQf/9ufx7+EUPvIHVJY4rbk6jpTmn/oR2siEzh9o25VvWp68oH5bN7Zg4ieAA01h8VTy2AEPdfx5awTWnghw0MVF7SVJr7aoUJgk3SzrtgrhZxdpoFaYZVGSRK2aS4RiCzOSJCFZLl5ZniQky7I1xba8UdzLsuVZRFnmYHPY87S3tM4ZFzwr4IQEVjV7QIeKcMhw6M3cWnJBOp0ff/zxx+7333dfvux0/Bq6IRwV1wwZdgR6cUcj1Im+09knr8ekXoTGBGvGQSlQHgydSdVWmMqZ8OchPDUqkhRgT/RVrTEpo3PsjHEzZao5jlQVycLpEQ5bI2mmEfmAh0v42x/CysMSHqS+AsHpTsbrZaer8FuJz0pKNgfeKFrXi6aGbF1Si7xgylfrTYpNipQqdgHWP82lWJKJt9kDb7a/tcSip+XK0oJ2RWfZZd7QQR6+dWfwR6V5sTUX6O2AxIU2aJKYsAuSU2OYEtjZOU15QpE/uljALmiWg2ml95eTk+QP/95Dwy7YTo21KCR8wsEe3/vL8UH3fz6uqFHkOVMx1YykDEbSIWEmjsjxlKV55RKYzWbRbEfHUylT6w/4pBUb2/+fytGnUwQ3j6jOH62aqSWGmiEViKVtR0XmrGGMauJbrjCl4tIg1wz6qME5S8UGFc7VuEd6Rwsk+Git0vD5GLZ+VG6BeFn1twSZcxJ8rLZ7NJ6y5Iq2H6/BnsANKR2xdPnTzVkrpXNZOI72zoLmVB1F1/DmVKHSHozT6Ye1j/Si9dF+W6zgU4uQOpv63d6zp18BknJdbiQNdNZbO5cBOn4EY+hLGjHiG4CbzkuBz+WCErDrsYG3j+LaXTEE1CNYsXTX+NGuGKGxMEs7udMVvN9pXPbqUeY38jq+oCV4Pys1YcMITldYPwI4edYPcCIGaIX01ssN5xNX4x7JihZIm9n4NlKksTPfZku9FQP6adUZcMX2ClXtxloyn17PfRF5a03qvhGY2+OY5aBpfTZrliBfe4dCq3Hdgr6e8uq17hH1rQDrV6ZAV++ud59bEWl99l8QoTbAvjaxWqN/Ricb7Df4+R6RZx2e1SYOV2PJWDVAS7/dUTZYqPH75gkP+o0J7zUn/Lh/ixNXY9jPP3D1N+BnaSg4WxcpXdoOEhbzjKYYQYJwDz+DR29z+HKAAQ+8kFlemDrToVkHBYvXEnxchPXs/iEk3ZB0QtILycOQPIrIO4aRFHEZdeGUBq5sbAUXJJEFuEnjQqVzMlIw8ZCwaBKRy8ufCioMN/PFgnTI5SXEbi0WEXDhmZAzG3hxDC5jQyBwqjpUJTLWKwKtZKx7cPrqvWGzrg8V6znQHpGHsiUSNh5FHQp+2xOZhapGJDDKm1Jls6dSjPThOk/pnNAxuKltNAg2s0FDEaB4nwzJH5+TwTDq90PSt3+Th36Cw0fIw+hjilm6yUmJn6/i4H6dg6ufq0TWXv9aLFwf9pYcDF2cYgwBjnulwlYx9z00nVSTaRtra1o94Mzun3oqizSB3VMxUyjByvi9UqfvdA4VG/M0rYXvEV/keRrCoVjKMhcy5gL34DiDoQpcGAl842M5Op0RG0sIU4D4QTQM0irAz45tt+5GCEgMEZ5SkSnV1s6CmAaIIUDSTFnWCpjw4FVBE1x42IGUB3dnERx+1STux3sN4t5r7k9riXsdBW8wFEITnUuhS38gqz7VqA779OXLR4s2JflOYbkxXqYK+0EhhoST8jNWlzVcaK+lOSjbYXAvplLqqoaLRHNyV+83I9ykgiC3R1EZGvK5bq/Bk52GEvH0N3R7NVepv9sb7PU2+r1aLpKbHxYJuc6SolX9WkuKNas13TqFPscp9PkcsXOXhtnBk2HjPLGzaXO+J4bZOkddYZK9C8Prrc62qyygdT68pu3zN7NBfj5Z7v4a1piW4H4y+B2sMZ9LoktGlzsjSnJXFpdVlHkNk8tGO8tnU24d2F+devfuxjzTOut81dAGvxrWqXVv7/OotW2cqZHcScD/++u372b9P38zkQcHBwdv3n+YvvowOTg4yOB3FEUrTXaryACHAf3Z5QG5LR7VhTWjRFGE7npq6D427+Vi8h+2fbi+TXQigjCQOWRqcSleJ8F+gKo/8yeBIETEMG2+lsk82L8MXKQ//Okir6Fp75OG9LDLQMdTllH4yyMUEsogoSsIAxuIoIMwwHA3yC6DtQ72Azn6xGIYLVcAjuFMQx/Ybv/S17IZUUHo1LdgP7BTDMLAOZHLojKXLE/GwcIPuKmrsqTqSuMf5bEI+oEkolt28waaLloJdbfq6WWtB5xbxo4k2JBSZthLOte1fu1pNGjn8UEbkAKxa0USOtcgTQptt8SYpnGRgorJLnKu5mUQFOqZNfoo4S1HKuEd7C2qRa9AokrReRAG3LCsXr6GCJS8+crFTAJmMOr3pm0/STZi7E+uAKxZuPA0uzEUnyQjI4aLnk+luHH7wXBnMBzsDIbQg4tovGkf3jIHXXySo9NbMULCzqG9O+Xffint1+Wxm7R5AOkbLPGaWrdKZAhthH90FZv4+oh5OmFX88PRumzDWpKTs+HQPGdURZj0d+v80yaLlTt/dAVDLcLg4urJXJBYdn0qI3mYsrGxITIklkow9age8nhvJjfc3V2Ewfzq6c2/yOk9gcWbXT27HzAHtMqP/T1g3Xm6CIPp1bB+W2ap/o7A7j5eVBt8S385Hclkfurl1uKqin6vgnpjmSZMgU60LK8qUQMSBrKxT9tbzUjKlFGxQtA0ktpc3jwo5uCocOad2ZSh66fU17H36jDg3BoWWhdh2oja4xr0aFWwkyCCANLqaIGqfjuvztfFvDohyQMc71QXKMYf9NxvwNGDeuY42J6rWGcPAlYmhmV5iqnUMzBgj9DSnUSk/A+VzxKTAIDfsf3AV28VL2yUIQ7oGjXzkIlTXyPygooyF7WZJUguL0syQOpYLMjlJawqU6ew7y8WYVUAYzUKcGu3JYrFjJ83WpVFrGpYltWaWi0LI29tgdvv6wC46NxCuX5AGV0sogZBtgBHE77DAUtKOoN8zuVZlyoTrvS1sb+EbEcB0Mm/DN6f5c+/5StAedbLnz/Ln/8Atw7kzPKeRc+Yi8Ry/oylaUSeaaOkmDxvoeBZz5WvXkrFzjmbIePiqla9tHFbdhQ5mH4EQV0tHtckVkXMaYrhtUrGzHuK0K0Fp3ttWK7Bf8qNDRbHxHA8EtCJYuiXQlhoYfCWBTwd+gGfUTJVbPzHBy2cPniOCcbgV37Wo89d7dfWXjGl54xQMSc4cTSuSGUtd+NCoZiMU6r42B1FQ5KnDEKB4aRKY+v5tRj1cBxNqTjT4bOReg6pymWK8y9//wfU8DL9tXirEqauIdQhRN9aWh6AHHsQ2rBkJHeutPEh+CgJHYWUofmrWMdldIJ/+lUp+nUx0lBL+P4q0WoUn0wYePZcDWzskucZjad200CoKjd1DsQjC+3BAwLzB8LExQ6U6QJ1c1ANO7V0BDv3aJVUx4T2t0eH18Al2qq6llFckjnO0vZB3h4dwoUd5XJDNkKJCY9a2qhCwBJAzjn1Sf2lZj+3oZzMumicXKx7QiN3VUaXLAOUcL0SotBu6iDhyutwljquboCBJZKFAc8qd9ntyGUNPCIUJSKPZHEdqrwCk5RMCkxaMsC+ftfE4Pnqwg0utFGFDWP1GST1hBMUE1pXePJYgUq1/kPChLbNKRmjhz0kheCAeVWA+bLskl3kTHGIZFmJAsUs6kB0XL1FNW+v+PDuO3fvTy0vxvOQ75glpMiRapATyltV/Mq1p75SH3Ti+2oAQXfD+Bxng82Z0lKAiJNqQoWToPY8CobWEZvS1FZ1ogK8e5jYA/S68uz/y9//UYNrrVFkGTA7Ak0SiLW4AkK0WVuCh+hlxXKQgLIJEfTH1J/aRwCADpnmNJNJyUj6+jR+iMkgupSLLlKhjJTQRTyFbauUtzoss+adUUGjebq8bUPmMF92wbWp3SThE/yW5cM7l/dVwYCHUOBqoHkxrzN4FcEhW93h8YA375QpD0FLvEALI08Vy7i43j5VdwcYWQqCwsiMGh4T35WOmjcFWS+15+usilsCajznUj1aw6rQ3akUMTvl4pSdM3WN430txApskiNmZoyJOmweSXY7q+7/mMHlKQ2ctJLlGlCCcTJjasJOY7BQIdWxayCx04GuOh3StYA4maoL5Rw37pYtFB4gR6reARynC5e5otWGW7/cLCLfyhkgrFRnQOm0/QM+CULuroipjxBTgYl6oPPASQ06LsMB4PqXaggbwoOLhbNxCldsPTrQC9wKBeOEm+bk5WeZBEvhZic/ur+zBiYH5nxCU4n85NTK1pU2CNRrvNRnivsPrh84oOw4/qYtvKTml7/9nwYlxgU+6vKou/IrnlZpqqXNWKz36snZE3zUPJt6ehbS8PH8VIrTSo6sJJhmy40EtCLqqqnKCCeFcXCv0QClA3UAou0uBv/opjBpr+/6wQAhdzQgeDn2yTs2oSpJy13DLqPB++xonZDsUOuoAY8Sa8iOGkPjKcN7gBKWw414UpAHlTGmZqmA9QRTMBOn6J+8jgnbbYuL2moeB+DGRJ9YEoTWXxx8XITBKI5v2yPsmA1fQ4hFw0bZ0jWMozgmD0cpB/RQNZL2nsJH+04ZpgnwISo6Lb24sagW+ShOGhoOrx0DIjTUAPJsNN8qI38TNn9Jnc999Vun1brxssVsBNkDGJmIZwnUsbxBa8lr8Ku5HTb5EFxU3daD8AWZ2Af9/j+zB2Gn/+V4EHb7X5AH4SkA64JCrpYm6851K2WHD/DY3OCTZNbFm0q1uSbsPOicsKFJqxBcscNwYf+rnB5eiF/hCLGekiqCw5lx/GQQDcN+H/5pLufLhnoBh/oihkMy3jj4b0F4/fCRzWtgi1c7ZzZJ9eknPvz5Ij4fHgYuNKFpRbjhxnKr+AJo044uWGPL2DgVxxCFSuHCYZhLt9TEsNvaGnORcsFO/QKeJjI+9bNf4DlI6+Yudy0YyuVG62Jzra8YPrCEubuKit7LjFn1fwb9zsBqXZ6DjJoTOoGDDPC4ukOiYkpdxX43g2wTCnb7/dNBiYS9ZSS8FnivAN6ufSTPmPhtZ1of3tjhAdSLLK1kYMBtJfweNCZbL7eT1CwuFDfzYP/4Mrjo0px37ff944+Lj0CCZiohAi2XGiGmZhrsB72lgDTN1DkGFB1fWr4pWUFTkUDg7dL+QHPeOx9Eg2ARttus3E821GdF96ZNtKETLiZXtftY4eg9rKNdqgamKjmV8z8zEFRuIeq1woAD/UwZBaMQoB7I410VxvfKL7IPsFsVM1ctZjsKzgfBNeLa2vv6iki11YFqg71aiNixj/bCAK4yfmtVSFY5dR9kVcZY1cKmalFTVSBUIw4KQ5tqkU3HFU+UQUT+BDBA1Xm4u4s65pMBKmM7T1HP2X28QCquogaCoBkZgEGlbf/257lrm97arQvyn8gF2fJAOuKp3GjOsFT3B7mipn/EU2Hpj2g4Bdo+gbX2+TXmeTdkywxdArLK+ru30ujqmqw2sLmPdevNakuMM8Rc36hSs2mskABejW/yPwScA//v9JH/d/vI/0/7jROEw3XVQ3UOQGW/1PXdBCp9HpT2jyC0uRhLlPhOUJX3cMOOjDvG0rmPpbHMymuwO50aUZWtOp1SklvGAKPd20KRXM6YGhf2bu1xyi7wcnBoxjL8VkUpMZqBaS+FnDXDJmjmxXRo8F0671hMczriKQeVw6alWhattBYdwW3nPs7pgbIJ3+csBU2ldErApXZey5xJdTaGeCkwIo4gER4MjExMqYitB8xun+jJATtTdfu4Ngqg5hY2KYwCvsyooBOUGGGdA0nCUhCgmig5Agexlmlh+d5QnkplQ6RxQpilgUh8dZHDJzy8wraj2BS46Nz5QXVo/dB2Z3Qvh4zA5Z8DLBws1EaSQqQSHvmA0IEihRRyY935cEauwwjNjaJCg4LuorLdGpQIcy5Kpp0t+INmsMLfcXFmrzPvkuOSrn5gI80Na16X1pYEj5ptvuHm22IEz1hIzY1U86r1hJtpMUIdp95J+cP29I1/J6amwVz/boH31qaseweHr1FHfkR++dv/ku8YVYJM5cxSa1wols6rJ2nwyRZceYu2UsVFJzhsG4Dx2BKf2+08Bn+YUoOOhTdsBh4cy1I2meOwGKU8Jkc+8A0ub3Rv5VTBcI3rnWwyNkQmUJLb1ikXZxE5EHP0pVZ7H5Rju8Y0cL+tPa9DIXrfPRbgx4wqiNB7p1l6znTNUcQSbuM9lCwmdrQ6MG5yzdx0mNtBkpC8lZ8OnsIKHGvhxUALak298BLOipT2Rt54M0qMiQSvUdD7JFF0bKr+w5Y3A3fepSKf6+7REbpuyiWxnOhmXJZaF1BL+27KW3QtwYDNF49ozh05HXuyJM17CG9O1tY6hMpEze4Ax4CVvnR4eUa/Hb9n6pzH3liwhqN7WLkXhEHKY+ZMVW7/Ovjm8DtyvhP1g7B2prkGc/e+e/3i1Zv3rwAYEKQWYYOoH/XRoi61yaiojdR6U6q9t9XyjrZPUG2foNo+QbV9gmr7BNX2CaobYnT7BNX2CartE1R3fsPh9gmq7RNU2yeolu6U2z5BtX2CavsE1fYJqu0TVNsnqLZPUP2r3Da4fYJq+wTVOvG5fYJq+wTV9gmqe33T6fYJqu0TVNsnqLZPUG2foNo+QbV9gmrz7nMrIt0+QXXzO463T1Btn6DaPkG1fYJq+wTV9gmq7RNU2yeotk9QbZ+g2j5B9QU5hbZPUG2foNo+QbV9gmr7BNX2Cao7Nc78kzxBVUu47uUp5aJ2J469B+S4/TDVxzCYwkUh+8fB5SUM8wHS+KH4pwITzY8/hsE5VRzCsvGOkdBfiQEp3mcMbkx4YXMGukcwfmiZHtPqWlerwJ0etsUBUvrGuvW7TA7fvj+C/HR3nX4mE7zEic4gJZzObH5+LW8cyy6DlIpJgTnnge1zYS97nTavADnDK0DcH7XEdbjwooKweTeInQb8Hya1ssHlpb1eBG+YsPXtp7UtHGJ9bVi/j4vF4v8B8ngJ8w==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Draft Document","permalink":"/docs/API-docs/v1.1/draftdocument"},"next":{"title":"Create Document from Template","permalink":"/docs/API-docs/v1.1/createdocumentwithtemplateid"}}');var s=t(74848),o=t(28453),r=t(57742),l=t.n(r),a=t(78178),d=t.n(a),c=t(19624),h=t.n(c),p=t(96226),u=t.n(p),m=(t(77675),t(19365),t(51107)),x=t(21312);const g={id:"createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file.",sidebar_label:"Create Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztPdlyHDeSv4Kt2AhJPdXVB0lJ5moUQ0taWzu2xJCodXhJDQddhe6GWAWUARSbbUZHzMP8wT7t63yav2QjE0BdffAQbVMz7QeLjcKRSGQmEnkAl4GhEx3sHwcvZVxkTBgdfAyDhOlY8dxwKYL94GjKyAvFqGHE1yIHh68JTVM506TQTGliJJkwwRTUEmxGEt8fGc1JruQ5T7iYkIQaSmbcTMmIavZ4lzARy4QlZMxTFp2IE3HE833yIU8lTchcFoocvvzPsjcYBsqOO52XbFRMyIfXnc7Hh1Njcr3f69E8j2TOhOYTkdKRjmKZ9RKomCfjRyGZTZli0CuJqSCMap7OCU0SMuPJhBkdEjNlgsQyn5NYSpVwQQ3TIcnphBFRZCOmdEioSEgmFSNcEEoUo8m8a2S30Iz81/u3b8hYqoyaiBymhQ7L4RKuWGzSue3eTFk5qwfaY0MbxcUkJBk9A2xxQ34qeHwG09ZMJPAvNDw4fI246nTeF3kulWEJ+cFOYb/TgS9fs1TOCFUM68cyy6QgOVU0YwaXa0oNflbsp4IrlthFoWnqcbF/Irqk0xE0Y/udDvkg+E8FIzxhwvAxZwpmScyUa9cgsvXNPMf6r0XCY0AeAgClRI6bVQGpUPV9zmLo0latoZpIQWZTHk8RhzNq1z9PaWynpZjOWWz4OWt2fBGSOXT8kgnpIZhKxX+WwtAUl++cKcNjmtaXGQCEqtpQZQD9ueTC+FI3AvnRLSesNi6io0MALQHkZlzgF83IOU0Lph1Us5BMAap3LFdMI2u4fgHxIiFTxifTtePR5FOhTaNjUmgAsw6FG8uvKqKXIdrGNNWM8HEDlxk9Y7XRiESep2lEvp6ThI1pkZqQcKBQowoWkTfSEJrnKY/pKGVIA8Bs1BSKdXGVHflETfI5RAnANKEk4eMxU8DM8BG7cG08dECXlchATjNTKogUrYWOZSrVMglhcROPJJbCMGEicnBOeYrA28lqwkWcFgkjo5TGZyEZpQULiWKJZfQ5AzEXOqEFVQjVDueIH6JZClQoBcAvpBuea6IdVElEjoBRSv6Djx7VOAjXdaw6Lh9LGBlQ4FmSsIzyNETEheSTHBHDTcpCYPCcinkI8pWFxLALM5IXIYmnLD7DvxRNuCSjwhgp7MQSJfNEzoTD5VgKo/nPKzjSf7k5Roch2Q3J45A8DcmgH5LBMCSD3ZAMHodk8DQkw35IhsOQDHdDMnxswRo+dbimJYLrAAyGFsvmy8LulCfsFBqewtxOqTZMcX0G4pr8AHsOEwBcElpxyS4MCD+URnwiWFLtgFyTKU8SJshYyYwoFvOcozSx0qDsOgR4iIJJCU3GRZrOyTnXvIaDslM5E4A3HJEr8jZn4j2fCELjWBawxohhi1REZ7XkIp0DqEeMZhpn/koYpnLFNQNRLXSJAWEq2rIbIJTVBcB1VlI0JdD61Vy3OrWVgR30O65R5sLWp8vddNbYTQcR6XRKOQdlf/3rX0/E5Ykg5CQAsXcS7JOToKxyEoT2G+xm8G3gfl/Aj53hE/dzDj8fD5+6nzOsOth1P6fwc+ibOuY6CfZxXKzAhbEjO/lKahBApcWJWDhgT8QQZ2Folm+YAXz+daEnJfh+l4JC2F5C/wE4cBmeNTO2NZZmuwOz5YIbTlO9fsK+xj2acwuk1dOuKi3NfBdmjrJs/bTx8z2acx0e+IJ7qP2Ee27tk98NEIrhBhS1+1wng6EVakdLmNyLnAqzHpF2CvcGjzVw7gqNrS5vjsXHgEXYTo9gO12PynLHvUf4bMN0V0hd1e/NMfskQiUYtZP1eHUV7hFWmxDdFU6Xe705Rp8CRkHNW49O+HqPcFkDBz44ndl+6+92B3vdYX+428AnWCdshSzrJkl3Pp9/3lpkXJxaOKBRrX5GL1Z/AKMJqI7lSpRfQIPhYlI2a35dXnVbr7WQoHA6TIDO6Y+fVukFExXqzsu2BTz6V7XcgQf/9ufx7+EUPvIHVJY4rbk6jpTmn/oR2siEzh9o25VvWp68oH5bN7Zg4ieAA01h8VTy2AEPdfx5awTWnghw0MVF7SVJr7aoUJgk3SzrtgrhZxdpoFaYZVGSRK2aS4RiCzOSJCFZLl5ZniQky7I1xba8UdzLsuVZRFnmYHPY87S3tM4ZFzwr4IQEVjV7QIeKcMhw6M3cWnJBOp0ff/zxx+7333dfvux0/Bq6IRwV1wwZdgR6cUcj1Im+09knr8ekXoTGBGvGQSlQHgydSdVWmMqZ8OchPDUqkhRgT/RVrTEpo3PsjHEzZao5jlQVycLpEQ5bI2mmEfmAh0v42x/CysMSHqS+AsHpTsbrZaer8FuJz0pKNgfeKFrXi6aGbF1Si7xgylfrTYpNipQqdgHWP82lWJKJt9kDb7a/tcSip+XK0oJ2RWfZZd7QQR6+dWfwR6V5sTUX6O2AxIU2aJKYsAuSU2OYEtjZOU15QpE/uljALmiWg2ml95eTk+QP/95Dwy7YTo21KCR8wsEe3/vL8UH3fz6uqFHkOVMx1YykDEbSIWEmjsjxlKV55RKYzWbRbEfHUylT6w/4pBUb2/+fytGnUwQ3j6jOH62aqSWGmiEViKVtR0XmrGGMauJbrjCl4tIg1wz6qME5S8UGFc7VuEd6Rwsk+Git0vD5GLZ+VG6BeFn1twSZcxJ8rLZ7NJ6y5Iq2H6/BnsANKR2xdPnTzVkrpXNZOI72zoLmVB1F1/DmVKHSHozT6Ye1j/Si9dF+W6zgU4uQOpv63d6zp18BknJdbiQNdNZbO5cBOn4EY+hLGjHiG4CbzkuBz+WCErDrsYG3j+LaXTEE1CNYsXTX+NGuGKGxMEs7udMVvN9pXPbqUeY38jq+oCV4Pys1YcMITldYPwI4edYPcCIGaIX01ssN5xNX4x7JihZIm9n4NlKksTPfZku9FQP6adUZcMX2ClXtxloyn17PfRF5a03qvhGY2+OY5aBpfTZrliBfe4dCq3Hdgr6e8uq17hH1rQDrV6ZAV++ud59bEWl99l8QoTbAvjaxWqN/Ricb7Df4+R6RZx2e1SYOV2PJWDVAS7/dUTZYqPH75gkP+o0J7zUn/Lh/ixNXY9jPP3D1N+BnaSg4WxcpXdoOEhbzjKYYQYJwDz+DR29z+HKAAQ+8kFlemDrToVkHBYvXEnxchPXs/iEk3ZB0QtILycOQPIrIO4aRFHEZdeGUBq5sbAUXJJEFuEnjQqVzMlIw8ZCwaBKRy8ufCioMN/PFgnTI5SXEbi0WEXDhmZAzG3hxDC5jQyBwqjpUJTLWKwKtZKx7cPrqvWGzrg8V6znQHpGHsiUSNh5FHQp+2xOZhapGJDDKm1Jls6dSjPThOk/pnNAxuKltNAg2s0FDEaB4nwzJH5+TwTDq90PSt3+Th36Cw0fIw+hjilm6yUmJn6/i4H6dg6ufq0TWXv9aLFwf9pYcDF2cYgwBjnulwlYx9z00nVSTaRtra1o94Mzun3oqizSB3VMxUyjByvi9UqfvdA4VG/M0rYXvEV/keRrCoVjKMhcy5gL34DiDoQpcGAl842M5Op0RG0sIU4D4QTQM0irAz45tt+5GCEgMEZ5SkSnV1s6CmAaIIUDSTFnWCpjw4FVBE1x42IGUB3dnERx+1STux3sN4t5r7k9riXsdBW8wFEITnUuhS38gqz7VqA779OXLR4s2JflOYbkxXqYK+0EhhoST8jNWlzVcaK+lOSjbYXAvplLqqoaLRHNyV+83I9ykgiC3R1EZGvK5bq/Bk52GEvH0N3R7NVepv9sb7PU2+r1aLpKbHxYJuc6SolX9WkuKNas13TqFPscp9PkcsXOXhtnBk2HjPLGzaXO+J4bZOkddYZK9C8Prrc62qyygdT68pu3zN7NBfj5Z7v4a1piW4H4y+B2sMZ9LoktGlzsjSnJXFpdVlHkNk8tGO8tnU24d2F+devfuxjzTOut81dAGvxrWqXVv7/OotW2cqZHcScD/++u372b9P38zkQcHBwdv3n+YvvowOTg4yOB3FEUrTXaryACHAf3Z5QG5LR7VhTWjRFGE7npq6D427+Vi8h+2fbi+TXQigjCQOWRqcSleJ8F+gKo/8yeBIETEMG2+lsk82L8MXKQ//Okir6Fp75OG9LDLQMdTllH4yyMUEsogoSsIAxuIoIMwwHA3yC6DtQ72Azn6xGIYLVcAjuFMQx/Ybv/S17IZUUHo1LdgP7BTDMLAOZHLojKXLE/GwcIPuKmrsqTqSuMf5bEI+oEkolt28waaLloJdbfq6WWtB5xbxo4k2JBSZthLOte1fu1pNGjn8UEbkAKxa0USOtcgTQptt8SYpnGRgorJLnKu5mUQFOqZNfoo4S1HKuEd7C2qRa9AokrReRAG3LCsXr6GCJS8+crFTAJmMOr3pm0/STZi7E+uAKxZuPA0uzEUnyQjI4aLnk+luHH7wXBnMBzsDIbQg4tovGkf3jIHXXySo9NbMULCzqG9O+Xffint1+Wxm7R5AOkbLPGaWrdKZAhthH90FZv4+oh5OmFX88PRumzDWpKTs+HQPGdURZj0d+v80yaLlTt/dAVDLcLg4urJXJBYdn0qI3mYsrGxITIklkow9age8nhvJjfc3V2Ewfzq6c2/yOk9gcWbXT27HzAHtMqP/T1g3Xm6CIPp1bB+W2ap/o7A7j5eVBt8S385Hclkfurl1uKqin6vgnpjmSZMgU60LK8qUQMSBrKxT9tbzUjKlFGxQtA0ktpc3jwo5uCocOad2ZSh66fU17H36jDg3BoWWhdh2oja4xr0aFWwkyCCANLqaIGqfjuvztfFvDohyQMc71QXKMYf9NxvwNGDeuY42J6rWGcPAlYmhmV5iqnUMzBgj9DSnUSk/A+VzxKTAIDfsf3AV28VL2yUIQ7oGjXzkIlTXyPygooyF7WZJUguL0syQOpYLMjlJawqU6ew7y8WYVUAYzUKcGu3JYrFjJ83WpVFrGpYltWaWi0LI29tgdvv6wC46NxCuX5AGV0sogZBtgBHE77DAUtKOoN8zuVZlyoTrvS1sb+EbEcB0Mm/DN6f5c+/5StAedbLnz/Ln/8Atw7kzPKeRc+Yi8Ry/oylaUSeaaOkmDxvoeBZz5WvXkrFzjmbIePiqla9tHFbdhQ5mH4EQV0tHtckVkXMaYrhtUrGzHuK0K0Fp3ttWK7Bf8qNDRbHxHA8EtCJYuiXQlhoYfCWBTwd+gGfUTJVbPzHBy2cPniOCcbgV37Wo89d7dfWXjGl54xQMSc4cTSuSGUtd+NCoZiMU6r42B1FQ5KnDEKB4aRKY+v5tRj1cBxNqTjT4bOReg6pymWK8y9//wfU8DL9tXirEqauIdQhRN9aWh6AHHsQ2rBkJHeutPEh+CgJHYWUofmrWMdldIJ/+lUp+nUx0lBL+P4q0WoUn0wYePZcDWzskucZjad200CoKjd1DsQjC+3BAwLzB8LExQ6U6QJ1c1ANO7V0BDv3aJVUx4T2t0eH18Al2qq6llFckjnO0vZB3h4dwoUd5XJDNkKJCY9a2qhCwBJAzjn1Sf2lZj+3oZzMumicXKx7QiN3VUaXLAOUcL0SotBu6iDhyutwljquboCBJZKFAc8qd9ntyGUNPCIUJSKPZHEdqrwCk5RMCkxaMsC+ftfE4Pnqwg0utFGFDWP1GST1hBMUE1pXePJYgUq1/kPChLbNKRmjhz0kheCAeVWA+bLskl3kTHGIZFmJAsUs6kB0XL1FNW+v+PDuO3fvTy0vxvOQ75glpMiRapATyltV/Mq1p75SH3Ti+2oAQXfD+Bxng82Z0lKAiJNqQoWToPY8CobWEZvS1FZ1ogK8e5jYA/S68uz/y9//UYNrrVFkGTA7Ak0SiLW4AkK0WVuCh+hlxXKQgLIJEfTH1J/aRwCADpnmNJNJyUj6+jR+iMkgupSLLlKhjJTQRTyFbauUtzoss+adUUGjebq8bUPmMF92wbWp3SThE/yW5cM7l/dVwYCHUOBqoHkxrzN4FcEhW93h8YA375QpD0FLvEALI08Vy7i43j5VdwcYWQqCwsiMGh4T35WOmjcFWS+15+usilsCajznUj1aw6rQ3akUMTvl4pSdM3WN430txApskiNmZoyJOmweSXY7q+7/mMHlKQ2ctJLlGlCCcTJjasJOY7BQIdWxayCx04GuOh3StYA4maoL5Rw37pYtFB4gR6reARynC5e5otWGW7/cLCLfyhkgrFRnQOm0/QM+CULuroipjxBTgYl6oPPASQ06LsMB4PqXaggbwoOLhbNxCldsPTrQC9wKBeOEm+bk5WeZBEvhZic/ur+zBiYH5nxCU4n85NTK1pU2CNRrvNRnivsPrh84oOw4/qYtvKTml7/9nwYlxgU+6vKou/IrnlZpqqXNWKz36snZE3zUPJt6ehbS8PH8VIrTSo6sJJhmy40EtCLqqqnKCCeFcXCv0QClA3UAou0uBv/opjBpr+/6wQAhdzQgeDn2yTs2oSpJy13DLqPB++xonZDsUOuoAY8Sa8iOGkPjKcN7gBKWw414UpAHlTGmZqmA9QRTMBOn6J+8jgnbbYuL2moeB+DGRJ9YEoTWXxx8XITBKI5v2yPsmA1fQ4hFw0bZ0jWMozgmD0cpB/RQNZL2nsJH+04ZpgnwISo6Lb24sagW+ShOGhoOrx0DIjTUAPJsNN8qI38TNn9Jnc999Vun1brxssVsBNkDGJmIZwnUsbxBa8lr8Ku5HTb5EFxU3daD8AWZ2Af9/j+zB2Gn/+V4EHb7X5AH4SkA64JCrpYm6851K2WHD/DY3OCTZNbFm0q1uSbsPOicsKFJqxBcscNwYf+rnB5eiF/hCLGekiqCw5lx/GQQDcN+H/5pLufLhnoBh/oihkMy3jj4b0F4/fCRzWtgi1c7ZzZJ9eknPvz5Ij4fHgYuNKFpRbjhxnKr+AJo044uWGPL2DgVxxCFSuHCYZhLt9TEsNvaGnORcsFO/QKeJjI+9bNf4DlI6+Yudy0YyuVG62Jzra8YPrCEubuKit7LjFn1fwb9zsBqXZ6DjJoTOoGDDPC4ukOiYkpdxX43g2wTCnb7/dNBiYS9ZSS8FnivAN6ufSTPmPhtZ1of3tjhAdSLLK1kYMBtJfweNCZbL7eT1CwuFDfzYP/4Mrjo0px37ff944+Lj0CCZiohAi2XGiGmZhrsB72lgDTN1DkGFB1fWr4pWUFTkUDg7dL+QHPeOx9Eg2ARttus3E821GdF96ZNtKETLiZXtftY4eg9rKNdqgamKjmV8z8zEFRuIeq1woAD/UwZBaMQoB7I410VxvfKL7IPsFsVM1ctZjsKzgfBNeLa2vv6iki11YFqg71aiNixj/bCAK4yfmtVSFY5dR9kVcZY1cKmalFTVSBUIw4KQ5tqkU3HFU+UQUT+BDBA1Xm4u4s65pMBKmM7T1HP2X28QCquogaCoBkZgEGlbf/257lrm97arQvyn8gF2fJAOuKp3GjOsFT3B7mipn/EU2Hpj2g4Bdo+gbX2+TXmeTdkywxdArLK+ru30ujqmqw2sLmPdevNakuMM8Rc36hSs2mskABejW/yPwScA//v9JH/d/vI/0/7jROEw3XVQ3UOQGW/1PXdBCp9HpT2jyC0uRhLlPhOUJX3cMOOjDvG0rmPpbHMymuwO50aUZWtOp1SklvGAKPd20KRXM6YGhf2bu1xyi7wcnBoxjL8VkUpMZqBaS+FnDXDJmjmxXRo8F0671hMczriKQeVw6alWhattBYdwW3nPs7pgbIJ3+csBU2ldErApXZey5xJdTaGeCkwIo4gER4MjExMqYitB8xun+jJATtTdfu4Ngqg5hY2KYwCvsyooBOUGGGdA0nCUhCgmig5Agexlmlh+d5QnkplQ6RxQpilgUh8dZHDJzy8wraj2BS46Nz5QXVo/dB2Z3Qvh4zA5Z8DLBws1EaSQqQSHvmA0IEihRRyY935cEauwwjNjaJCg4LuorLdGpQIcy5Kpp0t+INmsMLfcXFmrzPvkuOSrn5gI80Na16X1pYEj5ptvuHm22IEz1hIzY1U86r1hJtpMUIdp95J+cP29I1/J6amwVz/boH31qaseweHr1FHfkR++dv/ku8YVYJM5cxSa1wols6rJ2nwyRZceYu2UsVFJzhsG4Dx2BKf2+08Bn+YUoOOhTdsBh4cy1I2meOwGKU8Jkc+8A0ub3Rv5VTBcI3rnWwyNkQmUJLb1ikXZxE5EHP0pVZ7H5Rju8Y0cL+tPa9DIXrfPRbgx4wqiNB7p1l6znTNUcQSbuM9lCwmdrQ6MG5yzdx0mNtBkpC8lZ8OnsIKHGvhxUALak298BLOipT2Rt54M0qMiQSvUdD7JFF0bKr+w5Y3A3fepSKf6+7REbpuyiWxnOhmXJZaF1BL+27KW3QtwYDNF49ozh05HXuyJM17CG9O1tY6hMpEze4Ax4CVvnR4eUa/Hb9n6pzH3liwhqN7WLkXhEHKY+ZMVW7/Ovjm8DtyvhP1g7B2prkGc/e+e/3i1Zv3rwAYEKQWYYOoH/XRoi61yaiojdR6U6q9t9XyjrZPUG2foNo+QbV9gmr7BNX2CaobYnT7BNX2CartE1R3fsPh9gmq7RNU2yeolu6U2z5BtX2CavsE1fYJqu0TVNsnqLZPUP2r3Da4fYJq+wTVOvG5fYJq+wTV9gmqe33T6fYJqu0TVNsnqLZPUG2foNo+QbV9gmrz7nMrIt0+QXXzO463T1Btn6DaPkG1fYJq+wTV9gmq7RNU2yeotk9QbZ+g2j5B9QU5hbZPUG2foNo+QbV9gmr7BNX2Cao7Nc78kzxBVUu47uUp5aJ2J469B+S4/TDVxzCYwkUh+8fB5SUM8wHS+KH4pwITzY8/hsE5VRzCsvGOkdBfiQEp3mcMbkx4YXMGukcwfmiZHtPqWlerwJ0etsUBUvrGuvW7TA7fvj+C/HR3nX4mE7zEic4gJZzObH5+LW8cyy6DlIpJgTnnge1zYS97nTavADnDK0DcH7XEdbjwooKweTeInQb8Hya1ssHlpb1eBG+YsPXtp7UtHGJ9bVi/j4vF4v8B8ngJ8w==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},j=void 0,y={},f=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Create Document"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/createdocument",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The Create Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Unique identifier for this widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Specify the hint for widgets. This parameter is optional and is not applicable to the following widgets: checkbox, radio button, dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options":{\n "hint": "Provide signature"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp",\n "hint": "Provide stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials",\n "hint": "Provide initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide email",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide name",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide job title",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide company",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12,\n "min_date": "",\n "max_date": "",\n "readonly": false,\n "signing_date": false,\n "hint": "Provide date"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"min_date:"})," Provide the minimum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"max_date:"})," Provide the maximum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"signing_date"}),": If signing_date is set to true, the signing date is shown to the signer during signing. You may set either signing_date or default, but not both. Using both is not supported."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image",\n "hint": "Provide image"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"14",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Provide number",\n "formula": "",\n "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,s.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"decimalplaces:"})," Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"15",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"cells"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "cells",\n "page": 1,\n "x": 100,\n "y": 100,\n "w": 114,\n "h": 50,\n "options": {\n "name": "cells",\n "required": true,\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"cell_count:"})," Specify the number of cells that should be returned to the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,s.jsx)(n.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "required": true,\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "response": "04/15/2024",\n "format": "mm/dd/yyyy",\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "required": true,\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(x.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(h(),{...t(52821)}),"\n",(0,s.jsx)(u(),{...t(64795)})]})}function w(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}},52821(e){e.exports=JSON.parse('{"title":"Body","body":{"content":{"application/json":{"schema":{"required":["file","signers","title"],"type":"object","properties":{"file":{"type":"string","format":"base64","example":"base64 encoded pdf"},"title":{"type":"string","format":"string","example":"sample document"},"note":{"type":"string","format":"string","example":"sample Note"},"description":{"type":"string","format":"string","example":"sample Description"},"timeToCompleteDays":{"type":"number","description":"time to complete days is used to calculate expiry date of your document","format":"number","example":15},"signers":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","format":"string","example":"ceo"},"email":{"type":"string","format":"string","example":"joebee@example.com"},"name":{"type":"string","format":"string","example":"joe bee"},"phone":{"type":"string","format":"string","example":"123121312"},"company":{"type":"string","format":"string","example":"opensign"},"job_title":{"type":"string","format":"string","example":"dev"},"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Allowed values - signature, stamp.","format":"string","example":"signature"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":244},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":71},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":38},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":46}},"title":"createdocument_body_widgets"}}},"title":"createdocument_body_signers"}},"folderId":{"type":"string","example":""},"send_email":{"type":"boolean","description":"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \\"true\\". If the value of this parameter is \\"true\\" and no \'email_subject\'/\'email_body\' parameters are specified default email templates will be used. \\n","example":true},"email_subject":{"type":"string","description":"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.","example":"{{sender_name}} has requested you to sign {{document_title}}"},"email_body":{"type":"string","description":"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.","example":"

Hi {{receiver_name}},

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

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

Sign here

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

Thanks,
Team OpenSign\u2122

"},"sendInOrder":{"type":"boolean","description":"If set to \'true\', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to \'true\'.","example":true},"enableOTP":{"type":"boolean","description":"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.","example":false},"enableTour":{"type":"boolean","description":"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.","example":false},"redirect_url":{"type":"string","description":"Specifies the URL where the signer will be redirected upon completing the document signing process.","example":""},"sender_name":{"type":"string","description":"The name of the person or organization on whose behalf the email is being sent.","example":"opensign\u2122"},"sender_email":{"type":"string","description":"The email address of the person or organization that users can reply to.","example":"mailer@opensignlabs.com"},"allow_modifications":{"type":"boolean","description":"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.","example":false},"auto_reminder":{"type":"boolean","description":"Set to true to enable automatic reminders. Set to false to disable them (default behavior).","example":false},"remind_once_in_every":{"type":"number","description":"Number of days between reminders. This is only applicable when auto_reminder is set to true.","example":5},"merge_certificate":{"type":"boolean","description":"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\\n\\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\\n\\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\\n","example":false},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed. \\n"},"prefill":{"type":"object","description":"You can provide widgets which can embed before sending to signer","properties":{"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","format":"string","example":"textbox"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":100},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":30},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":40},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":80},"options":{"type":"object","properties":{"name":{"type":"string","example":"textbox"},"response":{"type":"string","example":"joe"},"color":{"type":"string","example":"red"},"fontsize":{"type":"number","example":12}}}}}}},"title":"prefill"}},"title":"createdocument_body"}}},"required":true}}')},64795(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Document created successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"hji2zxcv2P"},"signurl":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","format":"string","example":"mail@example.com"},"url":{"type":"string","format":"string","example":"https://url-to-sign-document.com"}},"title":"inline_response_doc_signurl"}},"message":{"type":"string","format":"string","example":"Document sent successfully!"}},"title":"inline_response_doc"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/4227e71a.ce746959.js b/assets/js/4227e71a.ce746959.js new file mode 100644 index 000000000..5264be682 --- /dev/null +++ b/assets/js/4227e71a.ce746959.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[5342],{64875(e,n,t){t.r(n),t.d(n,{assets:()=>f,contentTitle:()=>b,default:()=>k,frontMatter:()=>y,metadata:()=>r,toc:()=>g});const r=JSON.parse('{"id":"API-docs/v1.1/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/v1.1/get-template.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/get-template","permalink":"/docs/API-docs/v1.1/get-template","draft":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJztPO1uG0lyr1KZBQKbIClSlmyvLricVtbaxvnWgiWfkYgC2Zwpctqa6Z7r7iHFkwncjyAPEORP/uYl8j+Psk8SVHfPcIakqA/7vArABbw2p6u666urq6o/rgPDxjo4OA/OMM0SZlAHF80gQh0qnhkuRXAQnMUIr9FAAQKHJ2+BJYmcapjJHIwEhUZxnCBEaBhPNLChzA0w0BmGfMRDMB65XXajQaOaIDANwyTHTHFhNIykglAhM1yMIZJhniJ9nnITQ6YwwhEXGIE2Kg9NrlC3e6InGo0PqDMpNGqQIzjlY4EKPvFojEYfNBoE021Do6H5WDDCo2+DwaAnrnsCoBeYWYa94AB6QQnSC5quLWNj29b1v6/ox7PdF/7njH4+333pf04taHfP/4zp5263J+Z+wJ7YtZQYlmYbqKDmb0qB/yWtWjV9s4PSN4V/ybnCiD4alWOzaBAsrdNDDfMqL8+IFy644SzRN7NTQDwijhYkrTC1R0xhynhyM0e2+RGxU6WHWkKZSOWahgkLLytNIymM5n91BO+Wn2MeYd/glenTbOszbVBxfWkpGbFE44qc9klORMLNYnIEPhopVcj5XkJ6TkL6LIdwxk2yQVIEYgjkEYlrmabvJbMXJLNQphkTs5sl5gEekbzqFH0vab0kaUXMbDAuan1EcqqQQw0RjlieGNfW2Wt191u7nd29mqxUyjxAmraiqDWbzb5OzikXfUcHIVXgU3a1vkEhi6RIZqUmyhaKGbgYl2jr9fQj6Yk0O5RXN6vKA3wvbS2UUh94oyZvlkRNlUveNubCN2RKTniEsASgcJwnTOFVplBrLsWKCr7HdOp2rPeJMbzcqKgC4hHNqyWSqHHCkhxtR+dk2taVk7Rw8W9pYlS94GJhzphgaDC6BffiDvZA4k/YEJPVpvvrMmEzmXsTmqAyPGRJnVUeMePtxsvNT3XHUiHTTrPSyK6WGl3bfNUwbAoRKZlFcio2OFsP8YgMY4mkzTp7iMnU5v1DJuyqtG2apFjEJQxzY+QGiVehHpHU15D1d5a8h/vWU2xVOS7vS9l4Q9Bhmx+ROjw9q8zYfE/k6RDVhkzGtm9mp9upsbNfZ+d55wGrcm3Yr1+UO+XHxWp8LAwqWBmIYq48YStTOsKQpyzJEhY6W939Cnt7wPJss84Qk031Btt8m646VV0tfq4zvf3OnZRVHfaBuqIu+qHMnXL2b3WwCzU+ukBqqSp3onDEkwSmrixHyut+u4h498e6Op/v19S5X597N6rzJp1tCJQJxbHZ80kzLpoqcrZ9Ft9XF7+67Ha/RU7XffGs5o5efsecri6Tzt5Od39nY1K3E0U7D03qrOkBrBQmv1UQ332xW1umnm3yFY8kiK8q4Jbw/VsE6Suzf+/vEb4tWfSL7m8Qvn2tMlaitG8mflgpzn59hLa0TP5Yc6s/7lblvb//dfKuUrMktF7A//zT+w/Tzh9fj+Xh4eHhL6cf4+OP48PDw5R+t9vtlcAuaAYyQ2UTwrdRcBCM0RSbT0EzyJhiKRpUtP91bckIDoJin6rPo6AZcNr/ypiJg+VNsbevaEkroMHEzIBAjDRthw0RRmjCGKmPgvHgwLIdaDNLaCTN0ywhQvAqS2SEwYFTfaDDGFMWHFxbRRGkUVyMg6Z3mO6LGAfz+UWzFJImhN1Oh/6qk6rzMEStR3kCpTyCZhBKYVAYgmdZlvDQNux81oR0vUqFHH7G0JDgFHVjuBvSfSb5bqbXfcErZrk+CK66b4Yi1bsn42DeDGyReV0XCwRt/1GKnLCENLcglQqyoPMlLd4Js4oxbwYZir6dlbqCz5RiM7IXg6le7Xde6fg8oN1OaxdkHXZWBxfzZqBRRKj6zg43USYzFFRwDBZIdvNnMxZBoPpDgZywoW6HMvVi5KNZX4p+ufdZZWIoZYJMVHuzljpvBimqMfZDsoYRGRDeDW3Eb1N2bEymD3Z2Ci3kGlVBrpwKVHdUnt1KlsoWGq287M7wXVR3g7kreRvpIUor1Fv1+FkiDNGSdQf9fZY4RPyD/1DIIouluGWYvf3nu91nL190Cd7H3g/n37Xeb6r7eNnSy8ZVdJdzVtHLLyV6d94Mru6Js7u3N28Gs3tivaChpvdEevZy3gzieyLtPSc7dqvk7TK/yZTuKHPrre6L7/wSzVUpzCn/6721tktiuSFlXOslys5udBzz+WKlWCzU7rCH7nvT7vsjKMFm6AWUc6JvxXsV1dzKGjJoAffwfS76kjD6JLzQ3M3x2VMzfTkaJVyg9bZr8err96cYKZwE77sgZAJ0Pkw5HbAJZTazkUjM9SIcsaAR5JpO0TABeGVQCZaAkTKxZ2ysEwWFE47TNrxyxQUbvFha2+uot84Uo0Oz2eHsdnaftbqdVufFWff5wd6PB/vP251O51+DZnCVJguDthljZfEvf+dZ9F3GQcGGCZ7J/G5qVxhxhaHp52qtr940nYJS+amM3Fq5NPc3WU1uZF9hysWtFlqgGJ7imTyS9NXgKzbT6+Zv3c4Ihwwg9FgQsZkGriHXGNkGloS5tS+8yriaAQmSjG8mc1Ue1rrFL+xbSRIvfSlCpHmEE1RrfXWJ1Zk3g2EYPjTiouihtnI27afd2jeKwb7DEJmrgq3z+nV1/IvM7VQv9kq9f4NpzMPYtmA6xAiGOJIKgZwSzXYjvaNYWUYe69q/etqQIH09GqTwHJu4kAHoWOZJBCzLkKk22SeQBZ43Gq9wmI/h49tG4+JJEUOyLGsvh707EQFm0ehp3bBpEJvftx8YlNSZuYJQtqSKuKDOnyQ4MpBnGSoIpRKonsJIydQz+HiY63Ruip7q7M3+X7L3rHNTmLe07vLIxOTeHOW/Ca17nZuiyzqtb5CPY/MbE/uy8y2i2rW+o6hy3JojbQx4F5CUfPvgVt8Q3FZDWfffIoIonDh9q8caZaBZBphrgtBKiDpvBnvrijanMkUTk0OfojAwVVKMm5AlyDSCUTNgY8YFUHfqH75dNQeVuk1096OsKjUubNhb6LK/1+n0u6UQ9laFcFap3sBI5iL6vqyuG38zQ3v95yVD+6sMvRX2jIo9QX8mL1F8X36qwxs3/KoFcwdk24Mas9XvjkmNYa64mdkK6lWLZbzl2g/OL6g4SZYifenVllxNHBwEZVVn57pSbp0H1J+aFAVZG2WXhSDNRDSUV6s+i2V8Z9Jt7wbz5jLOWh+3AR7z1n1RtGFjLsa34V0sRHVK6nQaqwlsEZRl/I9IUZnXRxXKV6RjZJQJkAa4GEmL7LX0PkNBOa7VsR18ean4AQqYX//tv0sw2jH4PTQaFH4RIy0tcxUivJJhbvtjiU0hDZ8g/Pq3/4RhzhNjU8kIJ5iQJeomVfa1oaB0BkinCjLFNeq2u4FRHXfMJ+iuj7Ay4WhSrBvl9iRWi3bIZ4CtsiQJZCi0+oCJlczHMV0v4WKcYBM+HJ+eUX378ORtG05RRJWrI0Ri2UkTUiYouiwMz9LMwkvwRzhBG2ZyDVyAQkqYeYpNYCICysJScgY220FhuMJyGEj4CMNZmDjhMLvNbWK6BDNBEUkFiQwvW1zY6yqtVov++uEHuldjb7qcGqYMRvT1mLIhoF0D1AbSXBsImVIzN245dYlCWpgHFfsYgLMMO4jdA6k0HsA/UQ+LD7+vbNT/+u//Aedv5JQW/jEK2iXApQEXsUMkQ70meJCh3okxyXZOHVN65/DkrfVyT53+f5EGNGlyGqNCt1Ey5uKf4aN2QUaj4ac5oJhwJQWJttGAJ4M7u4GBjV0yJY2k+VRqgY1GdMRPjCEhC46YYUuqOKIs6ohlbMgTTk6Vvn+BI2ZwLNUMvsAn2uSZ+bQskvClJ760Wi37h0AbjVeF1TUa8AWObL2kaVOzJriqRpNqLvLS21SENtEuzbNVqH1hvr7n8taU7fmnnCcRKMw1VTAWxlzek2rZ0zlRkTT+ztJAkpECQSqaBbOyoOSHOMVk1KL5aYd4XViBps++oFS/kOWveLnLVlxMuLErF4wSOS06PcmHCQ+hTv5pzBQCg8w1FlMv4eLSTh9R5LCQcG2g2EEr+nyl2MjAJ6kuaSTXI5tghTqpKjJhGiLC0FbkIy5Ywp3BpS5KKfo9ksKw0CvvT85P2DngiQldOwylvCQTGyuWpswekUtmRSc/yyRC5fp4r8ZM0FgLyrjQlMyXbvqVInMcOaSij084jKW8dJ18wBAJhtxRy9ZocEIex+7aFIUkcJZp63qAIsokF6bo7qMuCPpQ3NNjoT1iZCUSUmHLAK0kFNqTBr/UpwYZ/q9/+y8Nv+CU/E6xYFDjD3BoDAtj6wXdjTs4zbNMKtMTtJoMWNmuB0UWyDUIOQXtADGiNN8qqRRV0+3dYOWDAygUWwIsPhA33qZM5bKiuyNIpL4h2fvbgafe6t5xcal74hQNDPwpJ6fvfnGqP7EQft8avrgK6YBIHpy8Pz2DHUtYQeeAphl1U5hN1bx14bbrzEIRQrYXYj2i2h6qxbVLrzyW9MTg9fEZLMKoAx4NLPP17zR5BhDT1BgiCro0iSxN7AVKmmYKo1xETBhY7IUDzUyFqZxgZLtsNHyyY31moTiFJlf2IiYSrsFk5nJ9z/Oiw0aD1txLEkC5VQ3INEflio1C5ymWGjphWk+lilonShp7CB1OXv28sChqJz3RFmI/88C9YFDItXCgQxnNaJ0RMJXKjm5dI4pQzTLfq24X/VoDPOgJr09nWIUYB/C//wODk48rErefKwiFNncOKmFtFWzJTpYalsazDeR8SaSDQj7v3d5Bab3ks5RMSvtd3WHYZLjLjFobWsOpkVTyTXjITUKRnV11KPTjbgHy45WmTjEXMiraFdd+C/r95PsgE1pgrX/wy9AAXGJj7YuFIWbksYknPx1p65U0PeJIBaRQSa1tpOXuC0sBSuYGdRvOYoUIBO/suXQzB25Np9FpFcWYTTh5zeWV3NM0gMYTf+7yqV0TbDBWlMeZAUp6jV1TF2Gq93CuH9peoX5KN67d7C/mPQnKbcIAHQctVr+i1mu1WSx8A5ZRLdh1d8SEm9m0kBfgeEVS82uyo8avnXawL6VrYWooBRzR3tGTo6OnRBzPOHnonjgEgVMSexgupL3ir1kixdguZcQPXnFtg6tBj+r0Czxy66X/Xjhq5/3I2srootTijguUSmUe0944sCiio6yobUiAEc33kkbll0hGkfJQipbdFasukGB32IF2HOoK4LpUaNSGd/wSFzw0ifwaNfBE52FMEYWbJYsZz6PBU1+q93JwpJG+FI+83stVyZbTmnYld16KJJtwEqy2G3ZpZmZg6/PwZHB+MXj6O5C040e9ONEaCVzEqPzHetdLse3hhPHEztTjRWDtA9zKF5oTVMX5+OHdmuD21MXeNpC4R0BeRoJlblfvYWPqXGIff4QPOF5Bvi1lHyyHMn9GReehSUf/CD+x8HLKVKSBdsqY4Tb0nxEoIZNxjHKK7YYFYCv0gIlLLWDStWY86ba7ZeZXxF/aLYkmlhph4gZ2DomV+pDCbd0OC7nbXoWEoUK3aoYxE2OaCBR8VRZqTo4/ykM3Fyy91LWrv7IEcpGg1mCPIk4pCKUjUNGSYXzUSHmzj4F6ogXnZWj6CYeaG1zkfdPpdEXSTy3Oz3mSQJH82Al3S7bo0F5z8yYfwgfMpOZGqtkCa8xNnA+tLqu45Q/fQZGklAW1r8lSbZdnqFL3iASqCQ9vYX/HEPjOU3vacKmeUy+7KByh3STVtRybZdzn8+cFHUDkfQ0frgZucxVbGHSHi6iwtPb4l2Xh/cjz64tbm/kNmkHCQ/QFeV+oOnx98g4mz9od2vssq2R30OXOu7dHx7+cHhMxfpoEB0G33Wl37L6h1CZlojJS9TWS5frW9aKeun25ZPtyyfblku3LJduXSx4mpO3LJduXS7Yvl2y85bZ9uWT7cgk8mgu325dLti+XbF8u2b5csn25ZPtyyfblku3LJb3tyyUP09T25ZLtyyXbl0u2L5dsXy7Zvlzy27xc4g+Dk8PeyRLG7VF8f/HUHaM/L++TBM2geuKIXvCPpTYEcn1NG8sfVTKf0+e/5Pam5flFM5gwxWkH2p619+d4ovINkhu31J588NJ4Cnd/AmUtM8Vxd0Fn3a1l0j3ZZnCJs6V3WOZ0b9KfeSdqHcShPSJUwV25PFG7gfD6+CywV2nj+ln7S3vW3v+Del9LV/0QviOA/k83AtYiXF+7c/zzeQnvmm7E8AwW0CSki/l8/n/wZp07","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Public Template","permalink":"/docs/API-docs/v1.1/publictemplate"},"next":{"title":"Update Template","permalink":"/docs/API-docs/v1.1/update-template"}}');var s=t(74848),a=t(28453),i=t(57742),l=t.n(i),o=t(78178),p=t.n(o),d=t(19624),c=t.n(d),m=t(96226),h=t.n(m),u=(t(77675),t(19365),t(51107)),x=t(21312);const y={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:"eJztPO1uG0lyr1KZBQKbIClSlmyvLricVtbaxvnWgiWfkYgC2Zwpctqa6Z7r7iHFkwncjyAPEORP/uYl8j+Psk8SVHfPcIakqA/7vArABbw2p6u666urq6o/rgPDxjo4OA/OMM0SZlAHF80gQh0qnhkuRXAQnMUIr9FAAQKHJ2+BJYmcapjJHIwEhUZxnCBEaBhPNLChzA0w0BmGfMRDMB65XXajQaOaIDANwyTHTHFhNIykglAhM1yMIZJhniJ9nnITQ6YwwhEXGIE2Kg9NrlC3e6InGo0PqDMpNGqQIzjlY4EKPvFojEYfNBoE021Do6H5WDDCo2+DwaAnrnsCoBeYWYa94AB6QQnSC5quLWNj29b1v6/ox7PdF/7njH4+333pf04taHfP/4zp5263J+Z+wJ7YtZQYlmYbqKDmb0qB/yWtWjV9s4PSN4V/ybnCiD4alWOzaBAsrdNDDfMqL8+IFy644SzRN7NTQDwijhYkrTC1R0xhynhyM0e2+RGxU6WHWkKZSOWahgkLLytNIymM5n91BO+Wn2MeYd/glenTbOszbVBxfWkpGbFE44qc9klORMLNYnIEPhopVcj5XkJ6TkL6LIdwxk2yQVIEYgjkEYlrmabvJbMXJLNQphkTs5sl5gEekbzqFH0vab0kaUXMbDAuan1EcqqQQw0RjlieGNfW2Wt191u7nd29mqxUyjxAmraiqDWbzb5OzikXfUcHIVXgU3a1vkEhi6RIZqUmyhaKGbgYl2jr9fQj6Yk0O5RXN6vKA3wvbS2UUh94oyZvlkRNlUveNubCN2RKTniEsASgcJwnTOFVplBrLsWKCr7HdOp2rPeJMbzcqKgC4hHNqyWSqHHCkhxtR+dk2taVk7Rw8W9pYlS94GJhzphgaDC6BffiDvZA4k/YEJPVpvvrMmEzmXsTmqAyPGRJnVUeMePtxsvNT3XHUiHTTrPSyK6WGl3bfNUwbAoRKZlFcio2OFsP8YgMY4mkzTp7iMnU5v1DJuyqtG2apFjEJQxzY+QGiVehHpHU15D1d5a8h/vWU2xVOS7vS9l4Q9Bhmx+ROjw9q8zYfE/k6RDVhkzGtm9mp9upsbNfZ+d55wGrcm3Yr1+UO+XHxWp8LAwqWBmIYq48YStTOsKQpyzJEhY6W939Cnt7wPJss84Qk031Btt8m646VV0tfq4zvf3OnZRVHfaBuqIu+qHMnXL2b3WwCzU+ukBqqSp3onDEkwSmrixHyut+u4h498e6Op/v19S5X597N6rzJp1tCJQJxbHZ80kzLpoqcrZ9Ft9XF7+67Ha/RU7XffGs5o5efsecri6Tzt5Od39nY1K3E0U7D03qrOkBrBQmv1UQ332xW1umnm3yFY8kiK8q4Jbw/VsE6Suzf+/vEb4tWfSL7m8Qvn2tMlaitG8mflgpzn59hLa0TP5Yc6s/7lblvb//dfKuUrMktF7A//zT+w/Tzh9fj+Xh4eHhL6cf4+OP48PDw5R+t9vtlcAuaAYyQ2UTwrdRcBCM0RSbT0EzyJhiKRpUtP91bckIDoJin6rPo6AZcNr/ypiJg+VNsbevaEkroMHEzIBAjDRthw0RRmjCGKmPgvHgwLIdaDNLaCTN0ywhQvAqS2SEwYFTfaDDGFMWHFxbRRGkUVyMg6Z3mO6LGAfz+UWzFJImhN1Oh/6qk6rzMEStR3kCpTyCZhBKYVAYgmdZlvDQNux81oR0vUqFHH7G0JDgFHVjuBvSfSb5bqbXfcErZrk+CK66b4Yi1bsn42DeDGyReV0XCwRt/1GKnLCENLcglQqyoPMlLd4Js4oxbwYZir6dlbqCz5RiM7IXg6le7Xde6fg8oN1OaxdkHXZWBxfzZqBRRKj6zg43USYzFFRwDBZIdvNnMxZBoPpDgZywoW6HMvVi5KNZX4p+ufdZZWIoZYJMVHuzljpvBimqMfZDsoYRGRDeDW3Eb1N2bEymD3Z2Ci3kGlVBrpwKVHdUnt1KlsoWGq287M7wXVR3g7kreRvpIUor1Fv1+FkiDNGSdQf9fZY4RPyD/1DIIouluGWYvf3nu91nL190Cd7H3g/n37Xeb6r7eNnSy8ZVdJdzVtHLLyV6d94Mru6Js7u3N28Gs3tivaChpvdEevZy3gzieyLtPSc7dqvk7TK/yZTuKHPrre6L7/wSzVUpzCn/6721tktiuSFlXOslys5udBzz+WKlWCzU7rCH7nvT7vsjKMFm6AWUc6JvxXsV1dzKGjJoAffwfS76kjD6JLzQ3M3x2VMzfTkaJVyg9bZr8err96cYKZwE77sgZAJ0Pkw5HbAJZTazkUjM9SIcsaAR5JpO0TABeGVQCZaAkTKxZ2ysEwWFE47TNrxyxQUbvFha2+uot84Uo0Oz2eHsdnaftbqdVufFWff5wd6PB/vP251O51+DZnCVJguDthljZfEvf+dZ9F3GQcGGCZ7J/G5qVxhxhaHp52qtr940nYJS+amM3Fq5NPc3WU1uZF9hysWtFlqgGJ7imTyS9NXgKzbT6+Zv3c4Ihwwg9FgQsZkGriHXGNkGloS5tS+8yriaAQmSjG8mc1Ue1rrFL+xbSRIvfSlCpHmEE1RrfXWJ1Zk3g2EYPjTiouihtnI27afd2jeKwb7DEJmrgq3z+nV1/IvM7VQv9kq9f4NpzMPYtmA6xAiGOJIKgZwSzXYjvaNYWUYe69q/etqQIH09GqTwHJu4kAHoWOZJBCzLkKk22SeQBZ43Gq9wmI/h49tG4+JJEUOyLGsvh707EQFm0ehp3bBpEJvftx8YlNSZuYJQtqSKuKDOnyQ4MpBnGSoIpRKonsJIydQz+HiY63Ruip7q7M3+X7L3rHNTmLe07vLIxOTeHOW/Ca17nZuiyzqtb5CPY/MbE/uy8y2i2rW+o6hy3JojbQx4F5CUfPvgVt8Q3FZDWfffIoIonDh9q8caZaBZBphrgtBKiDpvBnvrijanMkUTk0OfojAwVVKMm5AlyDSCUTNgY8YFUHfqH75dNQeVuk1096OsKjUubNhb6LK/1+n0u6UQ9laFcFap3sBI5iL6vqyuG38zQ3v95yVD+6sMvRX2jIo9QX8mL1F8X36qwxs3/KoFcwdk24Mas9XvjkmNYa64mdkK6lWLZbzl2g/OL6g4SZYifenVllxNHBwEZVVn57pSbp0H1J+aFAVZG2WXhSDNRDSUV6s+i2V8Z9Jt7wbz5jLOWh+3AR7z1n1RtGFjLsa34V0sRHVK6nQaqwlsEZRl/I9IUZnXRxXKV6RjZJQJkAa4GEmL7LX0PkNBOa7VsR18ean4AQqYX//tv0sw2jH4PTQaFH4RIy0tcxUivJJhbvtjiU0hDZ8g/Pq3/4RhzhNjU8kIJ5iQJeomVfa1oaB0BkinCjLFNeq2u4FRHXfMJ+iuj7Ay4WhSrBvl9iRWi3bIZ4CtsiQJZCi0+oCJlczHMV0v4WKcYBM+HJ+eUX378ORtG05RRJWrI0Ri2UkTUiYouiwMz9LMwkvwRzhBG2ZyDVyAQkqYeYpNYCICysJScgY220FhuMJyGEj4CMNZmDjhMLvNbWK6BDNBEUkFiQwvW1zY6yqtVov++uEHuldjb7qcGqYMRvT1mLIhoF0D1AbSXBsImVIzN245dYlCWpgHFfsYgLMMO4jdA6k0HsA/UQ+LD7+vbNT/+u//Aedv5JQW/jEK2iXApQEXsUMkQ70meJCh3okxyXZOHVN65/DkrfVyT53+f5EGNGlyGqNCt1Ey5uKf4aN2QUaj4ac5oJhwJQWJttGAJ4M7u4GBjV0yJY2k+VRqgY1GdMRPjCEhC46YYUuqOKIs6ohlbMgTTk6Vvn+BI2ZwLNUMvsAn2uSZ+bQskvClJ760Wi37h0AbjVeF1TUa8AWObL2kaVOzJriqRpNqLvLS21SENtEuzbNVqH1hvr7n8taU7fmnnCcRKMw1VTAWxlzek2rZ0zlRkTT+ztJAkpECQSqaBbOyoOSHOMVk1KL5aYd4XViBps++oFS/kOWveLnLVlxMuLErF4wSOS06PcmHCQ+hTv5pzBQCg8w1FlMv4eLSTh9R5LCQcG2g2EEr+nyl2MjAJ6kuaSTXI5tghTqpKjJhGiLC0FbkIy5Ywp3BpS5KKfo9ksKw0CvvT85P2DngiQldOwylvCQTGyuWpswekUtmRSc/yyRC5fp4r8ZM0FgLyrjQlMyXbvqVInMcOaSij084jKW8dJ18wBAJhtxRy9ZocEIex+7aFIUkcJZp63qAIsokF6bo7qMuCPpQ3NNjoT1iZCUSUmHLAK0kFNqTBr/UpwYZ/q9/+y8Nv+CU/E6xYFDjD3BoDAtj6wXdjTs4zbNMKtMTtJoMWNmuB0UWyDUIOQXtADGiNN8qqRRV0+3dYOWDAygUWwIsPhA33qZM5bKiuyNIpL4h2fvbgafe6t5xcal74hQNDPwpJ6fvfnGqP7EQft8avrgK6YBIHpy8Pz2DHUtYQeeAphl1U5hN1bx14bbrzEIRQrYXYj2i2h6qxbVLrzyW9MTg9fEZLMKoAx4NLPP17zR5BhDT1BgiCro0iSxN7AVKmmYKo1xETBhY7IUDzUyFqZxgZLtsNHyyY31moTiFJlf2IiYSrsFk5nJ9z/Oiw0aD1txLEkC5VQ3INEflio1C5ymWGjphWk+lilonShp7CB1OXv28sChqJz3RFmI/88C9YFDItXCgQxnNaJ0RMJXKjm5dI4pQzTLfq24X/VoDPOgJr09nWIUYB/C//wODk48rErefKwiFNncOKmFtFWzJTpYalsazDeR8SaSDQj7v3d5Bab3ks5RMSvtd3WHYZLjLjFobWsOpkVTyTXjITUKRnV11KPTjbgHy45WmTjEXMiraFdd+C/r95PsgE1pgrX/wy9AAXGJj7YuFIWbksYknPx1p65U0PeJIBaRQSa1tpOXuC0sBSuYGdRvOYoUIBO/suXQzB25Np9FpFcWYTTh5zeWV3NM0gMYTf+7yqV0TbDBWlMeZAUp6jV1TF2Gq93CuH9peoX5KN67d7C/mPQnKbcIAHQctVr+i1mu1WSx8A5ZRLdh1d8SEm9m0kBfgeEVS82uyo8avnXawL6VrYWooBRzR3tGTo6OnRBzPOHnonjgEgVMSexgupL3ir1kixdguZcQPXnFtg6tBj+r0Czxy66X/Xjhq5/3I2srootTijguUSmUe0944sCiio6yobUiAEc33kkbll0hGkfJQipbdFasukGB32IF2HOoK4LpUaNSGd/wSFzw0ifwaNfBE52FMEYWbJYsZz6PBU1+q93JwpJG+FI+83stVyZbTmnYld16KJJtwEqy2G3ZpZmZg6/PwZHB+MXj6O5C040e9ONEaCVzEqPzHetdLse3hhPHEztTjRWDtA9zKF5oTVMX5+OHdmuD21MXeNpC4R0BeRoJlblfvYWPqXGIff4QPOF5Bvi1lHyyHMn9GReehSUf/CD+x8HLKVKSBdsqY4Tb0nxEoIZNxjHKK7YYFYCv0gIlLLWDStWY86ba7ZeZXxF/aLYkmlhph4gZ2DomV+pDCbd0OC7nbXoWEoUK3aoYxE2OaCBR8VRZqTo4/ykM3Fyy91LWrv7IEcpGg1mCPIk4pCKUjUNGSYXzUSHmzj4F6ogXnZWj6CYeaG1zkfdPpdEXSTy3Oz3mSQJH82Al3S7bo0F5z8yYfwgfMpOZGqtkCa8xNnA+tLqu45Q/fQZGklAW1r8lSbZdnqFL3iASqCQ9vYX/HEPjOU3vacKmeUy+7KByh3STVtRybZdzn8+cFHUDkfQ0frgZucxVbGHSHi6iwtPb4l2Xh/cjz64tbm/kNmkHCQ/QFeV+oOnx98g4mz9od2vssq2R30OXOu7dHx7+cHhMxfpoEB0G33Wl37L6h1CZlojJS9TWS5frW9aKeun25ZPtyyfblku3LJduXSx4mpO3LJduXS7Yvl2y85bZ9uWT7cgk8mgu325dLti+XbF8u2b5csn25ZPtyyfblku3LJb3tyyUP09T25ZLtyyXbl0u2L5dsXy7Zvlzy27xc4g+Dk8PeyRLG7VF8f/HUHaM/L++TBM2geuKIXvCPpTYEcn1NG8sfVTKf0+e/5Pam5flFM5gwxWkH2p619+d4ovINkhu31J588NJ4Cnd/AmUtM8Vxd0Fn3a1l0j3ZZnCJs6V3WOZ0b9KfeSdqHcShPSJUwV25PFG7gfD6+CywV2nj+ln7S3vW3v+Del9LV/0QviOA/k83AtYiXF+7c/zzeQnvmm7E8AwW0CSki/l8/n/wZp07",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-2",custom_edit_url:null},b=void 0,f={},g=[];function j(e){const n={code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",...(0,a.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Get Template"}),"\n",(0,s.jsx)(l(),{method:"get",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,s.jsx)(n.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,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Responses of Signer Widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12,\n "min_date": "",\n "max_date": "",\n "readonly": false,\n "signing_date": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"14",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Enter number",\n "formula": "",\n "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"15",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"cells"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "cells",\n "page": 1,\n "x": 100,\n "y": 100,\n "w": 114,\n "h": 50,\n "options": {\n "name": "cells",\n "required": true,\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Responses of Prefill widgets"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "required": true,\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "response": "04/15/2024",\n "format": "mm/dd/yyyy",\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "required": true,\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,s.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(x.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(p(),{...t(86803)}),"\n",(0,s.jsx)(c(),{...t(34673)}),"\n",(0,s.jsx)(h(),{...t(54903)})]})}function k(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(j,{...e})}):j(e)}},86803(e){e.exports=JSON.parse('{"parameters":[{"name":"template_id","in":"path","description":"ID of template that needs to be fetched","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"strng"}}]}')},34673(e){e.exports={title:"Body"}},54903(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"x1Hbnms2Pg"},"title":{"type":"string","example":"sample template"},"note":{"type":"string","example":"template note"},"description":{"type":"string","example":"template description"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"sender_name":{"type":"string","example":"opensign"},"sender_email":{"type":"string","example":"mailer@opensignlabs.com"},"notify_on_signatures":{"type":"boolean","example":false},"merge_certificate":{"type":"boolean","example":false},"file":{"type":"string","example":"https://templateuser.com"},"owner":{"type":"string","example":"template creator name"},"signers":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","example":"ceo"},"name":{"type":"string","example":"joe bee"},"email":{"type":"string","example":"joebee@example.com"},"phone":{"type":"string","example":"456213871"},"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","format":"string","example":"textbox"},"page":{"type":"number","format":"number","example":1},"x":{"type":"number","format":"number","example":244},"y":{"type":"number","format":"number","example":71},"w":{"type":"number","format":"number","example":38},"h":{"type":"number","format":"number","example":46},"options":{"type":"object","properties":{"name":{"type":"string","format":"string","example":"textbox"},"color":{"type":"string","format":"string","example":"black"},"fontSize":{"type":"number","format":"number","example":12},"hide_text_with_asterisks":{"type":"boolean","format":"boolean","example":false}}}},"title":"template_Signers_widgets_details"}}},"title":"template_Signers_details"}},"sendInOrder":{"type":"boolean","example":true},"send_in_order_strict":{"type":"boolean","example":false},"allow_offline_sign":{"type":"boolean","description":"Whether signers can submit a copy of this template signed using an external tool for owner review. Defaults to false.","example":false},"createdAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"enableTour":{"type":"boolean","example":true},"redirect_url":{"type":"string","format":"string","example":""},"allow_modifications":{"type":"boolean","example":false},"auto_reminder":{"type":"boolean","example":false},"timeToCompleteDays":{"type":"number","description":"time to complete days is used to calculate expiry date of your document","format":"number","example":15},"remind_once_in_every":{"type":"number","example":0},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"]},"cc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"]},"prefill":{"type":"object","description":"You can provide widgets which can embed before sending to signer","properties":{"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","format":"string","example":"textbox"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":100},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":30},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":40},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":80},"options":{"type":"object","properties":{"name":{"type":"string","example":"textbox"},"response":{"type":"string","example":"joe"},"color":{"type":"string","example":"red"},"fontsize":{"type":"number","example":12}}}}}}},"title":"prefill"}},"xml":{"name":"template_details"},"title":"template_details"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"Template not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Template not found!"}},"title":"inline_response_404_6"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/4227e71a.e04ea00d.js b/assets/js/4227e71a.e04ea00d.js deleted file mode 100644 index e73da6b70..000000000 --- a/assets/js/4227e71a.e04ea00d.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[5342],{64875(e,n,t){t.r(n),t.d(n,{assets:()=>b,contentTitle:()=>j,default:()=>k,frontMatter:()=>g,metadata:()=>r,toc:()=>y});const r=JSON.parse('{"id":"API-docs/v1.1/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/v1.1/get-template.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/get-template","permalink":"/docs/API-docs/v1.1/get-template","draft":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJztG8ty3DbyV7C4bDxFzUsjyZ5TtInLccUVuyx5XbuSagKSPUNYIMAAoEYT1VTlsH+wp73up+VLthogOeS89LCiaKvGB3kIdAP9QqPRQN9QyyaGDs/oKaSZYBYMvQhoDCbSPLNcSTqkpwmQN2BJCUKOP7wlTAg1NWSmcmIV0WA1hysgMVjGhSEsVLkljJgMIj7mEbEFcrsaxhAD+goIMyQUOWSaS2vIWGkSaWCWywmJVZSngM1TbhOSaYhhzCXExFidRzbXYNrn8ly2Wh/BZEoaMESNyQmfSNDkM48nYM2w1UKYXpu0WoZPJEM8bPv555/P5c25JOSc2lkG53RIzmkFck4D35exievrFd/X+LHfPyo+Z/h52H9ZfE4daG9QfCb42e+dy3kx4bnsO0osS7MtVGD3o1JQfCmnVoNtblJs0/BLzjXE2Gh1DkHZIVnapAc75nVe9pEXLrnlTJjN7JQQz4ijBUkrTA2QKUgZF5s5ct3PiJ06PdgTKaG07woFiy5rXWMlreG/eoL7VXPCYxhZuLYjXG0jZixobi4dJWMmDKzI6QDlhCRsFpMn8NlIqUbOUwnpEIX0RYXklFuxRVIIYhHkGYlrmaanktkRyixSacbkbLPECoBnJK8mRU8lrZcorZjZLcaFvc9ITjVysCOGMcuF9X3dwV7vYK/f7Q8astIpKwDSdC+O92az2dfJOeVy5OlApBp8yq7Xd2hgsZJiVmmi6sGYgctJhbZeT69QT6jZUF1vVlUB8FTaWiilOfFWTW6WREOVS9424bLoyLS64jGQJQANk1wwDdeZBmO4kisqeIrl1Os675NAdLlVUSXEM1pXSyRh5xUTObiBztC0nStHacHit7IJ6HN6sTBnEBBZiG/BvbiDPaD4BQtBrHbdX5eCzVRemNAVaMsjJpqs8pjZwm4KuRVL3bNUyrQb1DrZ9VKn75uvGoY7QsRaZbGayi3OtoB4RoaxRNJ2nT3EZBrr/iELdlXa7pikWcwVCXNr1RaJ16GekdTXkPUHS76Ae+wltqocf+5L2WRL0OG6n5E6CnpWmXHnPZmnIegtJxnXv52dXrfBzkGTncPuA3blxrRfvyl3q8bFbvxaWtBkZSKMuXLBVpZ0DBFPmcgEi7yt9r/C3h6wPbtTZwRiW77Bdd+mq25dV4vPdaZ30L2TsurTPlBXOMQoUrlXzsGtDnahxmcXSC1l5T5oGHMhyNSn5VB5vceLiPuvmuo8PGio86C59jaqc5POtgTKiOLZPC8OzbDoqsnZjVm2r25+Tdn1H+NM1zvab7ijl094pmvKpDvo9A46Ww91nTjuPPRQ50yPkJXE5GMF8b2jfmOb2t/mK55JEF9XwC3h+2ME6Surf/BHhG9LFn3U+xPCt69VxkqU9mjiJyvJ2a+P0Ja2yVcNt/qqX5f3wcHXybtOzZLQzin/+9/ef5x2f3wzUcfHx8c/nXxKXn+aHB8fp/jdbrdXAjsaUJWBdgfCtzEd0gnY8vKJBjRjmqVgQeP9140jgw5peU814jENKMf7r4zZhC5fir39Hre0EprYhFkiAWKD12EhkDHYKAEco2ScDh3b1NiZwJkMTzOBhMB1JlQMdOhVT02UQMro8MYpCiGt5nJCg8Jh+hY5ofP5RVAJySBCv9vF/5qkmjyKwJhxLkglDxrQSEkL0iI8yzLBI9fR+WIQ6WaVChV+gcii4DQOY7mf0jejfLfT61vgmjmuh/S690MoU9P/MKHzgLok87ohFgjG/ahEjlhS2VuQKgU50PmSFu+EWceYBzQDOXKr0tTwmdZshvZiITWr485rA59RvO10doHW4VY1vZgH1ICMQY+8HW6jTGUgMeFIF0ju8mc7FkKA/rZEFiw07UilhRj5eDZSclTdfdaZCJUSwGR9NGep84CmoCcwitAaxmhAcDe0sRIx6Keyrdsl6ulx2Ug6X1jjwhkUBCPp/DY7TazNzLDTKZFzA7qUtJrKBt/b7M7dgquSqsDlmOFOVrdBmlrdRnoE6m4C+6KAhODIuoPpfVEQAnxbNJSyyBIlb5lmcHDY7+2/POohfHFseDj/vvd+llSE+o5eNqmj++NyHb1qqdB784Be3xOnPxjMAzq7J9YRTjW9J9L+y3lAk3siDQ7Rjv0Gf7vMN5nSHWXuHO198b1LdW5G2hP+67211kexbDjtrnVw1WAbfd58rVvx71TMqDDtUfF6hm6HXkB5//9WvtdNd7qGDIw9UKDoVCA+ttsXXr/b39/rdfe6R6e9w+Hg1fDgsN3tdv9JA3qdioVi3aGvtn9X33kWP8k8IFko4FTld2NfQ8w1RHaU67U+a5tZ4XTu1dMoVbHf7pbWwJYdj+VWjTSkXN6qqRLF8hRO1XcKWy18z2ZmnR03Qz3EwQA0KrBIzGaGcENyA7HrYCLK3fYC1xnXM4KCxEh2pnJdvbe6ZX0cOEkiLyMlIxhxOYIr0Gt9VoXVnQc0jKKHBk24izZ2kMA19RttGEZlPsu0zjU1ZfUPlZOISVLeRRaLkEwTHiWuB9IQYhLCWGkguNLwTZpVxO/EK77uuW5Qq6/5ELLI9xIlC45tUsqAmETlIiYsy4DpNhoPQfM4a7W+hzCfkE9vW62Lb8pAh2VZezms7MQImMXjF02rw0nc+bn9wJ2zycw1idSe0jGXOPg3AsaW5FkGmkRKS9AvyFirtGDw+TDX7W7a4pvszf4v2dvvbopFmtx95rFN0Pd4yv8UWgfdTSFQk9YfgE8S+ycT+7L7GKHXWt9RZhFuDeS3RmULSDzcFhGY2RCB1eMt/2+xvZdOHNuagUAVDVVR0JpIqRZHzQM6WJcUOVEp2AQd+hSkJVOt5CQgmQBmgFg9I2zCuCQ4nP7L42VLQOvbRHc/yupS41JwCaNSl6NBtzvqVUIYrArhtJYdIWOVy/hpWV03/3aGBqPDiqGDVYbeSvcGxL1QP1WXIJ+Wn/r01k+/asHcA7l+2mC23u6ZNBDlmtuZy1Be77GM7/n+4dkFJv/QUlSR2nQpTZvQIa1SD52bWjpzTnE8fVUmPF0IXGUrDJNxqK5XfRbLeOeq18Yj+DLOWh+3BR7yvfuiGMsmXE5uw7tYiOoE1ek11hDYIijL+I+AUVmhjzpUkfFNgLl0zxy/x8ohF1p6n4HEg5jTsZt8ZVsDESkfhqNjb7VKlN//9d8Kq9Wqgm1nja6K4X2uSaamoDFVy2RMxgKueSh8xQWkrq+quTDAUgHGiBnh0sJEu2Qln3DLBCkeJJKIZSzkgqMRI5jygX5tHZg2+ZwA3ldg1181EEZiuAKBtk/w3JI2izHIVOnLMVZ/BISRMDdcgjEEZMJkhIClJgKiNMEwGp8XZJobwLINpJp72pS0mkWWpEyyCeDYAakLKwbB0VyJVmFuLDFK5I5kgu5daX+kcQy51LsT4mvMpmu/N+MxSEOCZnMFZJLzGExAIhUD8dlkZEFiiG8syZAWHoHL4OdSqOjSKXCcC0EyhS6EM4EhQJ1GRLeaSYP7dnGKKnRQCSzTChPwVa3KJwOo4XdcXvrilD1yVtnVZwgNt7CIJKbT6Yrpv2jivOH2hzwkHyFThlulZwvsCbdJHrrlUh+k+vAjvQEJzn5qi2ExRqwisyaYUZHpJCCyzglYtBDTOf7w1nndF+T33/5N3gHTkiRq6q01yjWIGZmUU6HkvOa92Cqn6WqAWG4TlHjkjQ8vUcDYUoKfE2Z//+0/hvwEU8JlsaSQlVbrQx4KHi3KjFqtIfnOpT2quwPj72vwjBcCMQlDU7rijDCSeWzB5WWbHMsZxnnalx+hMWC7w2uwgXKpFSuFDE/bSjqMdYVPNoHUgLgCg2Ph5hcCgZhbtOhEq3ziZ6sTUzBXvKH4XL6hGJLjOCZZ82kFCrxGjj/A2gRmhPmTrG0vv8bwPXmWKY1UcE/8WGHCAxUAMs4UVmgNSazZ2C7GDxaG7gu3lFzT5EXIKnEExTCVSvxKLDiuWtvuGm/JkTf9rYYxuNSFY3uhl4wX5nRWmiVBa/0as/bBr7QsctFEkfrGHWXtvYoFnZr34xPQVzwqrwY2rOiOA+7QgAoeQRGJFzvU8ZsP78jVfruLSY9qe7zD4u68e/vd659OXiMx6Ei9wHrtbrvrEgbK2JTJ2kz1Mr/lje1mEUjtSgJ3JYG7ksBdSeCuJPBhQtqVBO5KAnclgVufj+5KAnclgeTZvGTflQTuSgJ3JYG7ksBdSeCuJHBXErgrCTzflQQ+TFO7ksBdSeCuJHBXErgrCdyVBP45JYHFKxB02J1MMO7e4BTPwf37mbPqIRkN6LBeEHgR0EQZiyA3N3jL+0mL+Rybf8nd++ezi4BeMc3xUbp7ZBNzg7/jqrhv45XaNx8Labwgd68tXMtM+c5F4iMXZ5n4ej2glzBbKnCc44Pp4rELUushjqMIMlvDXXk11Xh69Ob1KXUP3JPmI5tL98im+IGjr6Wr+frGE4B/8SnQWoSbG/+AZz6v4H3XRoyCwRIahXQxn8//B3BEEwg=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Public Template","permalink":"/docs/API-docs/v1.1/publictemplate"},"next":{"title":"Update Template","permalink":"/docs/API-docs/v1.1/update-template"}}');var i=t(74848),s=t(28453),l=t(57742),a=t.n(l),o=t(78178),p=t.n(o),d=t(19624),c=t.n(d),m=t(96226),h=t.n(m),x=(t(77675),t(19365),t(51107)),u=t(21312);const g={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:"eJztG8ty3DbyV7C4bDxFzUsjyZ5TtInLccUVuyx5XbuSagKSPUNYIMAAoEYT1VTlsH+wp73up+VLthogOeS89LCiaKvGB3kIdAP9QqPRQN9QyyaGDs/oKaSZYBYMvQhoDCbSPLNcSTqkpwmQN2BJCUKOP7wlTAg1NWSmcmIV0WA1hysgMVjGhSEsVLkljJgMIj7mEbEFcrsaxhAD+goIMyQUOWSaS2vIWGkSaWCWywmJVZSngM1TbhOSaYhhzCXExFidRzbXYNrn8ly2Wh/BZEoaMESNyQmfSNDkM48nYM2w1UKYXpu0WoZPJEM8bPv555/P5c25JOSc2lkG53RIzmkFck4D35exievrFd/X+LHfPyo+Z/h52H9ZfE4daG9QfCb42e+dy3kx4bnsO0osS7MtVGD3o1JQfCmnVoNtblJs0/BLzjXE2Gh1DkHZIVnapAc75nVe9pEXLrnlTJjN7JQQz4ijBUkrTA2QKUgZF5s5ct3PiJ06PdgTKaG07woFiy5rXWMlreG/eoL7VXPCYxhZuLYjXG0jZixobi4dJWMmDKzI6QDlhCRsFpMn8NlIqUbOUwnpEIX0RYXklFuxRVIIYhHkGYlrmaanktkRyixSacbkbLPECoBnJK8mRU8lrZcorZjZLcaFvc9ITjVysCOGMcuF9X3dwV7vYK/f7Q8astIpKwDSdC+O92az2dfJOeVy5OlApBp8yq7Xd2hgsZJiVmmi6sGYgctJhbZeT69QT6jZUF1vVlUB8FTaWiilOfFWTW6WREOVS9424bLoyLS64jGQJQANk1wwDdeZBmO4kisqeIrl1Os675NAdLlVUSXEM1pXSyRh5xUTObiBztC0nStHacHit7IJ6HN6sTBnEBBZiG/BvbiDPaD4BQtBrHbdX5eCzVRemNAVaMsjJpqs8pjZwm4KuRVL3bNUyrQb1DrZ9VKn75uvGoY7QsRaZbGayi3OtoB4RoaxRNJ2nT3EZBrr/iELdlXa7pikWcwVCXNr1RaJ16GekdTXkPUHS76Ae+wltqocf+5L2WRL0OG6n5E6CnpWmXHnPZmnIegtJxnXv52dXrfBzkGTncPuA3blxrRfvyl3q8bFbvxaWtBkZSKMuXLBVpZ0DBFPmcgEi7yt9r/C3h6wPbtTZwRiW77Bdd+mq25dV4vPdaZ30L2TsurTPlBXOMQoUrlXzsGtDnahxmcXSC1l5T5oGHMhyNSn5VB5vceLiPuvmuo8PGio86C59jaqc5POtgTKiOLZPC8OzbDoqsnZjVm2r25+Tdn1H+NM1zvab7ijl094pmvKpDvo9A46Ww91nTjuPPRQ50yPkJXE5GMF8b2jfmOb2t/mK55JEF9XwC3h+2ME6Surf/BHhG9LFn3U+xPCt69VxkqU9mjiJyvJ2a+P0Ja2yVcNt/qqX5f3wcHXybtOzZLQzin/+9/ef5x2f3wzUcfHx8c/nXxKXn+aHB8fp/jdbrdXAjsaUJWBdgfCtzEd0gnY8vKJBjRjmqVgQeP9140jgw5peU814jENKMf7r4zZhC5fir39Hre0EprYhFkiAWKD12EhkDHYKAEco2ScDh3b1NiZwJkMTzOBhMB1JlQMdOhVT02UQMro8MYpCiGt5nJCg8Jh+hY5ofP5RVAJySBCv9vF/5qkmjyKwJhxLkglDxrQSEkL0iI8yzLBI9fR+WIQ6WaVChV+gcii4DQOY7mf0jejfLfT61vgmjmuh/S690MoU9P/MKHzgLok87ohFgjG/ahEjlhS2VuQKgU50PmSFu+EWceYBzQDOXKr0tTwmdZshvZiITWr485rA59RvO10doHW4VY1vZgH1ICMQY+8HW6jTGUgMeFIF0ju8mc7FkKA/rZEFiw07UilhRj5eDZSclTdfdaZCJUSwGR9NGep84CmoCcwitAaxmhAcDe0sRIx6Keyrdsl6ulx2Ug6X1jjwhkUBCPp/DY7TazNzLDTKZFzA7qUtJrKBt/b7M7dgquSqsDlmOFOVrdBmlrdRnoE6m4C+6KAhODIuoPpfVEQAnxbNJSyyBIlb5lmcHDY7+2/POohfHFseDj/vvd+llSE+o5eNqmj++NyHb1qqdB784Be3xOnPxjMAzq7J9YRTjW9J9L+y3lAk3siDQ7Rjv0Gf7vMN5nSHWXuHO198b1LdW5G2hP+67211kexbDjtrnVw1WAbfd58rVvx71TMqDDtUfF6hm6HXkB5//9WvtdNd7qGDIw9UKDoVCA+ttsXXr/b39/rdfe6R6e9w+Hg1fDgsN3tdv9JA3qdioVi3aGvtn9X33kWP8k8IFko4FTld2NfQ8w1RHaU67U+a5tZ4XTu1dMoVbHf7pbWwJYdj+VWjTSkXN6qqRLF8hRO1XcKWy18z2ZmnR03Qz3EwQA0KrBIzGaGcENyA7HrYCLK3fYC1xnXM4KCxEh2pnJdvbe6ZX0cOEkiLyMlIxhxOYIr0Gt9VoXVnQc0jKKHBk24izZ2kMA19RttGEZlPsu0zjU1ZfUPlZOISVLeRRaLkEwTHiWuB9IQYhLCWGkguNLwTZpVxO/EK77uuW5Qq6/5ELLI9xIlC45tUsqAmETlIiYsy4DpNhoPQfM4a7W+hzCfkE9vW62Lb8pAh2VZezms7MQImMXjF02rw0nc+bn9wJ2zycw1idSe0jGXOPg3AsaW5FkGmkRKS9AvyFirtGDw+TDX7W7a4pvszf4v2dvvbopFmtx95rFN0Pd4yv8UWgfdTSFQk9YfgE8S+ycT+7L7GKHXWt9RZhFuDeS3RmULSDzcFhGY2RCB1eMt/2+xvZdOHNuagUAVDVVR0JpIqRZHzQM6WJcUOVEp2AQd+hSkJVOt5CQgmQBmgFg9I2zCuCQ4nP7L42VLQOvbRHc/yupS41JwCaNSl6NBtzvqVUIYrArhtJYdIWOVy/hpWV03/3aGBqPDiqGDVYbeSvcGxL1QP1WXIJ+Wn/r01k+/asHcA7l+2mC23u6ZNBDlmtuZy1Be77GM7/n+4dkFJv/QUlSR2nQpTZvQIa1SD52bWjpzTnE8fVUmPF0IXGUrDJNxqK5XfRbLeOeq18Yj+DLOWh+3BR7yvfuiGMsmXE5uw7tYiOoE1ek11hDYIijL+I+AUVmhjzpUkfFNgLl0zxy/x8ohF1p6n4HEg5jTsZt8ZVsDESkfhqNjb7VKlN//9d8Kq9Wqgm1nja6K4X2uSaamoDFVy2RMxgKueSh8xQWkrq+quTDAUgHGiBnh0sJEu2Qln3DLBCkeJJKIZSzkgqMRI5jygX5tHZg2+ZwA3ldg1181EEZiuAKBtk/w3JI2izHIVOnLMVZ/BISRMDdcgjEEZMJkhIClJgKiNMEwGp8XZJobwLINpJp72pS0mkWWpEyyCeDYAakLKwbB0VyJVmFuLDFK5I5kgu5daX+kcQy51LsT4mvMpmu/N+MxSEOCZnMFZJLzGExAIhUD8dlkZEFiiG8syZAWHoHL4OdSqOjSKXCcC0EyhS6EM4EhQJ1GRLeaSYP7dnGKKnRQCSzTChPwVa3KJwOo4XdcXvrilD1yVtnVZwgNt7CIJKbT6Yrpv2jivOH2hzwkHyFThlulZwvsCbdJHrrlUh+k+vAjvQEJzn5qi2ExRqwisyaYUZHpJCCyzglYtBDTOf7w1nndF+T33/5N3gHTkiRq6q01yjWIGZmUU6HkvOa92Cqn6WqAWG4TlHjkjQ8vUcDYUoKfE2Z//+0/hvwEU8JlsaSQlVbrQx4KHi3KjFqtIfnOpT2quwPj72vwjBcCMQlDU7rijDCSeWzB5WWbHMsZxnnalx+hMWC7w2uwgXKpFSuFDE/bSjqMdYVPNoHUgLgCg2Ph5hcCgZhbtOhEq3ziZ6sTUzBXvKH4XL6hGJLjOCZZ82kFCrxGjj/A2gRmhPmTrG0vv8bwPXmWKY1UcE/8WGHCAxUAMs4UVmgNSazZ2C7GDxaG7gu3lFzT5EXIKnEExTCVSvxKLDiuWtvuGm/JkTf9rYYxuNSFY3uhl4wX5nRWmiVBa/0as/bBr7QsctFEkfrGHWXtvYoFnZr34xPQVzwqrwY2rOiOA+7QgAoeQRGJFzvU8ZsP78jVfruLSY9qe7zD4u68e/vd659OXiMx6Ei9wHrtbrvrEgbK2JTJ2kz1Mr/lje1mEUjtSgJ3JYG7ksBdSeCuJPBhQtqVBO5KAnclgVufj+5KAnclgeTZvGTflQTuSgJ3JYG7ksBdSeCuJHBXErgrCTzflQQ+TFO7ksBdSeCuJHBXErgrCdyVBP45JYHFKxB02J1MMO7e4BTPwf37mbPqIRkN6LBeEHgR0EQZiyA3N3jL+0mL+Rybf8nd++ezi4BeMc3xUbp7ZBNzg7/jqrhv45XaNx8Labwgd68tXMtM+c5F4iMXZ5n4ej2glzBbKnCc44Pp4rELUushjqMIMlvDXXk11Xh69Ob1KXUP3JPmI5tL98im+IGjr6Wr+frGE4B/8SnQWoSbG/+AZz6v4H3XRoyCwRIahXQxn8//B3BEEwg=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},j=void 0,b={},y=[];function f(e){const n={code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(x.default,{as:"h1",className:"openapi__heading",children:"Get Template"}),"\n",(0,i.jsx)(a(),{method:"get",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,i.jsx)(n.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,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Responses of Signer Widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12,\n "min_date": "",\n "max_date": "",\n "readonly": false,\n "signing_date": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.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.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"14",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Enter number",\n "formula": "",\n "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"15",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"cells"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "cells",\n "page": 1,\n "x": 100,\n "y": 100,\n "w": 114,\n "h": 50,\n "options": {\n "name": "cells",\n "required": true,\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Responses of Prefill widgets"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "required": true,\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "response": "04/15/2024",\n "format": "mm/dd/yyyy",\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "required": true,\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,i.jsx)(x.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,i.jsx)(u.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,i.jsx)(p(),{...t(86803)}),"\n",(0,i.jsx)(c(),{...t(34673)}),"\n",(0,i.jsx)(h(),{...t(54903)})]})}function k(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}},86803(e){e.exports=JSON.parse('{"parameters":[{"name":"template_id","in":"path","description":"ID of template that needs to be fetched","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"strng"}}]}')},34673(e){e.exports={title:"Body"}},54903(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"x1Hbnms2Pg"},"title":{"type":"string","example":"sample template"},"note":{"type":"string","example":"template note"},"description":{"type":"string","example":"template description"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"sender_name":{"type":"string","example":"opensign"},"sender_email":{"type":"string","example":"mailer@opensignlabs.com"},"notify_on_signatures":{"type":"boolean","example":false},"merge_certificate":{"type":"boolean","example":false},"folder":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"x1Hbnms2Pg"},"name":{"type":"string","example":"folder name"}},"title":"template_folder"},"file":{"type":"string","example":"https://templateuser.com"},"owner":{"type":"string","example":"template creator name"},"signers":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","example":"ceo"},"name":{"type":"string","example":"joe bee"},"email":{"type":"string","example":"joebee@example.com"},"phone":{"type":"string","example":"456213871"},"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","format":"string","example":"textbox"},"page":{"type":"number","format":"number","example":1},"x":{"type":"number","format":"number","example":244},"y":{"type":"number","format":"number","example":71},"w":{"type":"number","format":"number","example":38},"h":{"type":"number","format":"number","example":46},"options":{"type":"object","properties":{"name":{"type":"string","format":"string","example":"textbox"},"color":{"type":"string","format":"string","example":"black"},"fontSize":{"type":"number","format":"number","example":12},"hide_text_with_asterisks":{"type":"boolean","format":"boolean","example":false}}}},"title":"template_Signers_widgets_details"}}},"title":"template_Signers_details"}},"sendInOrder":{"type":"boolean","example":true},"createdAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"enableTour":{"type":"boolean","example":true},"redirect_url":{"type":"string","format":"string","example":""},"allow_modifications":{"type":"boolean","example":false},"auto_reminder":{"type":"boolean","example":false},"timeToCompleteDays":{"type":"number","description":"time to complete days is used to calculate expiry date of your document","format":"number","example":15},"remind_once_in_every":{"type":"number","example":0},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"]},"prefill":{"type":"object","description":"You can provide widgets which can embed before sending to signer","properties":{"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","format":"string","example":"textbox"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":100},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":30},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":40},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":80},"options":{"type":"object","properties":{"name":{"type":"string","example":"textbox"},"response":{"type":"string","example":"joe"},"color":{"type":"string","example":"red"},"fontsize":{"type":"number","example":12}}}}}}},"title":"prefill"}},"xml":{"name":"template_details"},"title":"template_details"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"Template not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Template not found!"}},"title":"inline_response_404_6"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/4d139b56.cdb488f7.js b/assets/js/4d139b56.cdb488f7.js deleted file mode 100644 index bbac61b7b..000000000 --- a/assets/js/4d139b56.cdb488f7.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[7075],{71236(e,t,r){r.r(t),r.d(t,{assets:()=>C,contentTitle:()=>S,default:()=>f,frontMatter:()=>g,metadata:()=>n,toc:()=>T});const n=JSON.parse('{"id":"API-docs/v1.1/getcredits","title":"Get your API credits","description":"The Get Credits API returns details about the credits available to your account:","source":"@site/docs/API-docs/v1.1/getcredits.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/getcredits","permalink":"/docs/API-docs/v1.1/getcredits","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getcredits","title":"Get your API credits","description":"The Get Credits API returns details about the credits available to your account:","sidebar_label":"Get your API credits","hide_title":true,"hide_table_of_contents":true,"api":"eJztV91uI7cVfpUT3rQRxpK8SVp0ruoGhmtkkTVqLwzUNgwO52iGMYdk+CNZEATkougDtFe97aPtkxSHnBmNvA62QYrcNIAhS+T5+c4PeT7uWOCNZ+Ude+/RsYeC1eiFkzZIo1nJblqECwzwtcNaBg9nV5fgMESnPdQYuFQeeGVigNAiiF6Kr7lUvFIIwcDWRAdcCBN1KO/1vZ7NrOL6sRcuZ7PRutRCxRpr2MjQZkUfqxEPkN4cblr0CA49BuDZsQ/cBTArQC5a0LiBSioldQNiKxTO7zXA+TPvrMISLlfZNFkD68xa1ujhdLkc8Vt00BkdWuC6JmFAXZONFCRZzAi/WoLDjkstdVNkoxVXXIsenqf4yXCGSRZGpGRK43OYIKTU8Lo2r+bGRida7rEGj5Y7HlBtYeVMB9cYgtSNhw9//0cq0I15Qp1+/Slu4cphJ2M3GJrDWV2fGD0GWxvQJgA+W+kwBcwdgtFqC5HcGQqHK5XzNZbYIQijfeywnueqBhO4mkKn5vGxo2iPaz6bJT8vop3NqLbSg0NL6dOUv5Z6KHA1OhbROdRBbSddtjKOsPY4HGrccPVY84ADjOtpG/UCQAL3mhXMWHScti5rVrIGQ++MFcyht0Z79KzcsTfLJf07PiLXUQj0fhUVjHZYwYTRAXUgeW6tkiJtLL7zpLRjXrTYcfoWthZZyUz1HYrACmYdmQkyu5ymbSKtY1ehYwXD3NWsXO4LdpTOT0of1euT0tOsToR9cFI3rGAr4zoeWMmSwESZvVm++d3J8g8np7+/WS7L9DdfLpd/ZXsCIUMS6mE8OvRsv6edL19P9qSO1LYrE3X9v0s3Omfca+EdwnkdwmcJdcb95ce46XadCv+SgF/6nqZdaiU1Pg5d/kjghzC++jiMS73mStaHW+aXjWTqPmT3BPW5U6SneZdDSkJpnx2FOl3PQXoU0cmwZeXdjj2fcCtP8n5597B/KFiHoTX9nUCAeWhZyRZHN4RHt0bnk4noFCtZG4L15WLhua4r8zw3FrWXjVa88nNhugW3crE+nZ+yffFSh1v7k+QxnvxUFR94I3XzKb2HQ3quqYS5SkdJGmvFrfwGt6wYajCVKpik1mmR1+hSvaRemaTcV+adRX0tG53qmpy/pCG3qITpEp2giTCbDSof/vbvUWs2g9qI2KEOqQPTOHhHg95s0NH9TENnpfBZ0tAgNezSnk8zPhjwyDuF3qstSB2woTELtWwkTSDKU6IU3PJKKkmNS2IDxTn0vp/DbYuhRUdbv6GxCjWuUVG/A4/BdJxG9ogXNsY9rZTZ+AI4VNFLjd4D6pZrQYJDJQowDrgG1AGdddIT93GEWmZsRgfHRYCOa94g2S5gmqwalaR2BWeq6AN4o2KCDETmjMN65GwasfYpiefPlraAVoXprMOW2maN0EQiTwUIUyP4dE4pBF1DhT6AJSxSYCJCUSsjnlIBV5H4hKFrQ3JFBGGKkdSD49rTTMlYhhqMCbPO0NRF3w/99x6pwm+lfiLuca9P4G7sq1usvAz48NvhCGw2m49a//NjnQsZ/hwr+Ata42UwbnvQbmRoY5WOy9TI+CNbukCNqX8mh+FgozbCf3z6aHXRorKLgdQtzq4u0037OXz44Z/wFrnT0JpN7lYRHdHAZnBFmcuVz2kbL8pEkXgMLWVc5OZz+H1EH4YM3rY8fPjhXx6+xQ1I3R8pCmU2u4qVkgJusLOKB/SzWUl8klyGYQ1CywMIrqFC8C2nVlpLDhxs1lZSP83hTCde6TKDpmag9aR3FAblZSy3h4pnLpoZYe9zfkBE651HtUZPtmjcVQh0R1NHt87EJnubgumDc7iSSsGtrBsMKbazugbbL2/yMiV8AgdXdCBCi9tEhYmtzuHqhUraidYaRyhkBr8ySpkNFQB1bY3UwZdQO74KB/vFodEFpVka/cpSTiEf01H0ZsaS5JPYRzyuzhPnfXGRH9+3DlfoyGEK+1AXK/t2uhvaEqhbf05b04imW4uLxCDoOaXyRPnjSztpmqPr/LvVNbq1FNhPtR850YskvGAFU1Kg9jhhCWcXV29h/cV8yYrJePwvDvfi7eXX599enxMYukhzwk7ny/mSlqzxoeN64omez+NhPNCGo4TvDiTq1yf3r0/u/4Mnd08cAz6HhVVcJqqeDuKup9l304f4Q8Fa4wOt7nY0C947td/T8vcRHfH3h4KtuZMELrH3YmCcxMufcEtnXgi0xOPXXMVMW188V444/8X5DSsYDc1jpvuUmG7/hawPW3o7sX1MgTMA+iQ+/qrCbpdZ9H4/yuetH9XoAxykKYcP+/3+P2OzBN4=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get your account details","permalink":"/docs/API-docs/v1.1/get-user"},"next":{"title":"Create Contact","permalink":"/docs/API-docs/v1.1/createcontact"}}');var s=r(74848),i=r(28453),d=r(57742),o=r.n(d),c=r(78178),a=r.n(c),p=r(19624),u=r.n(p),l=r(96226),h=r.n(l),m=(r(77675),r(19365),r(51107));r(21312);const g={id:"getcredits",title:"Get your API credits",description:"The Get Credits API returns details about the credits available to your account:",sidebar_label:"Get your API credits",hide_title:!0,hide_table_of_contents:!0,api:"eJztV91uI7cVfpUT3rQRxpK8SVp0ruoGhmtkkTVqLwzUNgwO52iGMYdk+CNZEATkougDtFe97aPtkxSHnBmNvA62QYrcNIAhS+T5+c4PeT7uWOCNZ+Ude+/RsYeC1eiFkzZIo1nJblqECwzwtcNaBg9nV5fgMESnPdQYuFQeeGVigNAiiF6Kr7lUvFIIwcDWRAdcCBN1KO/1vZ7NrOL6sRcuZ7PRutRCxRpr2MjQZkUfqxEPkN4cblr0CA49BuDZsQ/cBTArQC5a0LiBSioldQNiKxTO7zXA+TPvrMISLlfZNFkD68xa1ujhdLkc8Vt00BkdWuC6JmFAXZONFCRZzAi/WoLDjkstdVNkoxVXXIsenqf4yXCGSRZGpGRK43OYIKTU8Lo2r+bGRida7rEGj5Y7HlBtYeVMB9cYgtSNhw9//0cq0I15Qp1+/Slu4cphJ2M3GJrDWV2fGD0GWxvQJgA+W+kwBcwdgtFqC5HcGQqHK5XzNZbYIQijfeywnueqBhO4mkKn5vGxo2iPaz6bJT8vop3NqLbSg0NL6dOUv5Z6KHA1OhbROdRBbSddtjKOsPY4HGrccPVY84ADjOtpG/UCQAL3mhXMWHScti5rVrIGQ++MFcyht0Z79KzcsTfLJf07PiLXUQj0fhUVjHZYwYTRAXUgeW6tkiJtLL7zpLRjXrTYcfoWthZZyUz1HYrACmYdmQkyu5ymbSKtY1ehYwXD3NWsXO4LdpTOT0of1euT0tOsToR9cFI3rGAr4zoeWMmSwESZvVm++d3J8g8np7+/WS7L9DdfLpd/ZXsCIUMS6mE8OvRsv6edL19P9qSO1LYrE3X9v0s3Omfca+EdwnkdwmcJdcb95ce46XadCv+SgF/6nqZdaiU1Pg5d/kjghzC++jiMS73mStaHW+aXjWTqPmT3BPW5U6SneZdDSkJpnx2FOl3PQXoU0cmwZeXdjj2fcCtP8n5597B/KFiHoTX9nUCAeWhZyRZHN4RHt0bnk4noFCtZG4L15WLhua4r8zw3FrWXjVa88nNhugW3crE+nZ+yffFSh1v7k+QxnvxUFR94I3XzKb2HQ3quqYS5SkdJGmvFrfwGt6wYajCVKpik1mmR1+hSvaRemaTcV+adRX0tG53qmpy/pCG3qITpEp2giTCbDSof/vbvUWs2g9qI2KEOqQPTOHhHg95s0NH9TENnpfBZ0tAgNezSnk8zPhjwyDuF3qstSB2woTELtWwkTSDKU6IU3PJKKkmNS2IDxTn0vp/DbYuhRUdbv6GxCjWuUVG/A4/BdJxG9ogXNsY9rZTZ+AI4VNFLjd4D6pZrQYJDJQowDrgG1AGdddIT93GEWmZsRgfHRYCOa94g2S5gmqwalaR2BWeq6AN4o2KCDETmjMN65GwasfYpiefPlraAVoXprMOW2maN0EQiTwUIUyP4dE4pBF1DhT6AJSxSYCJCUSsjnlIBV5H4hKFrQ3JFBGGKkdSD49rTTMlYhhqMCbPO0NRF3w/99x6pwm+lfiLuca9P4G7sq1usvAz48NvhCGw2m49a//NjnQsZ/hwr+Ata42UwbnvQbmRoY5WOy9TI+CNbukCNqX8mh+FgozbCf3z6aHXRorKLgdQtzq4u0037OXz44Z/wFrnT0JpN7lYRHdHAZnBFmcuVz2kbL8pEkXgMLWVc5OZz+H1EH4YM3rY8fPjhXx6+xQ1I3R8pCmU2u4qVkgJusLOKB/SzWUl8klyGYQ1CywMIrqFC8C2nVlpLDhxs1lZSP83hTCde6TKDpmag9aR3FAblZSy3h4pnLpoZYe9zfkBE651HtUZPtmjcVQh0R1NHt87EJnubgumDc7iSSsGtrBsMKbazugbbL2/yMiV8AgdXdCBCi9tEhYmtzuHqhUraidYaRyhkBr8ySpkNFQB1bY3UwZdQO74KB/vFodEFpVka/cpSTiEf01H0ZsaS5JPYRzyuzhPnfXGRH9+3DlfoyGEK+1AXK/t2uhvaEqhbf05b04imW4uLxCDoOaXyRPnjSztpmqPr/LvVNbq1FNhPtR850YskvGAFU1Kg9jhhCWcXV29h/cV8yYrJePwvDvfi7eXX599enxMYukhzwk7ny/mSlqzxoeN64omez+NhPNCGo4TvDiTq1yf3r0/u/4Mnd08cAz6HhVVcJqqeDuKup9l304f4Q8Fa4wOt7nY0C947td/T8vcRHfH3h4KtuZMELrH3YmCcxMufcEtnXgi0xOPXXMVMW188V444/8X5DSsYDc1jpvuUmG7/hawPW3o7sX1MgTMA+iQ+/qrCbpdZ9H4/yuetH9XoAxykKYcP+/3+P2OzBN4=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},S=void 0,C={},T=[];function b(e){const t={p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Get your API credits"}),"\n",(0,s.jsx)(o(),{method:"get",path:"/getcredits",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Get Credits API returns details about the credits available to your account:"}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"plan_credits:"})," Credits included with your subscription plan. These reset at the start of each new billing cycle.\nExample: If your plan provides 100 credits per month and you end\nthe cycle with 50 remaining, your balance resets to 100 at the\nstart of the next cycle."]}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"addon_credits:"})," Credits purchased separately from Settings \u2192 API Token \u2192 Buy Premium Credits. Add-on credits do not expire and are only used once all plan credits are consumed."]}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"total_credits:"})," The sum of ",(0,s.jsx)(t.strong,{children:"plan_credits"})," and ",(0,s.jsx)(t.strong,{children:"addon_credits"}),". This represents the total credits currently available for use."]}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"renewal_date:"})," The Subscription renewal date"]}),"\n",(0,s.jsx)(a(),{parameters:void 0}),"\n",(0,s.jsx)(u(),{...r(35398)}),"\n",(0,s.jsx)(h(),{...r(40588)})]})}function f(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}},35398(e){e.exports={title:"Body"}},40588(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"plan_credits":{"type":"number","example":0},"addon_credits":{"type":"number","example":0},"total_credits":{"type":"number","example":0},"renewal_date":{"type":"string","format":"date","example":"2026-09-17T00:00:00.000Z"}},"title":"credits_res"}}}},"400":{"description":"Subscription not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Subscription not found!"}}}}}},"404":{"description":"User not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"User not found!"}},"title":"inline_response_404"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/4d139b56.f56ca12e.js b/assets/js/4d139b56.f56ca12e.js new file mode 100644 index 000000000..39b1f8dc5 --- /dev/null +++ b/assets/js/4d139b56.f56ca12e.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[7075],{71236(e,t,r){r.r(t),r.d(t,{assets:()=>x,contentTitle:()=>m,default:()=>j,frontMatter:()=>h,metadata:()=>s,toc:()=>X});const s=JSON.parse('{"id":"API-docs/v1.1/getcredits","title":"Get your API credits","description":"The Get Credits API returns details about the credits available to your account:","source":"@site/docs/API-docs/v1.1/getcredits.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/getcredits","permalink":"/docs/API-docs/v1.1/getcredits","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getcredits","title":"Get your API credits","description":"The Get Credits API returns details about the credits available to your account:","sidebar_label":"Get your API credits","hide_title":true,"hide_table_of_contents":true,"api":"eJztWd1uI7cVfpVTLlCsBf15k7SoUqR1vM7G6DZrrOwuUMvwUMMjDWMOOSE5kgXbQC6KPkDRm972JXrfR9knKQ45HI1kN5sgRW4aYL22yMPD838+Ht0xz5eOTS7ZhUPLrvpMoMutrLw0mk3YeYHwCj0cWxTSOzg6OwWLvrbagUDPpXLA56b24AuEvKHiKy4VnysEb2Bjags8z02t/WSmZ7rXqxTX1w3xpNdruUudq1qggLX0RTzo6nkrD9C5IZwX6BAsOvTA48XOc+vBLAB5XoDGNcylUlIvId/kCoczDXByy8tK4QROF5E1cYPKmpUU6OBwPG7lr9BCabQvgGtBxIBaEI+gJHGMEn4yBosll1rqZT8ynXPFdd6I50h/YhzFJA6tpMRK463vSEim4UKYJ21T1TYvuEMBDituuUe1gYU1JUzRe6mXDt7/9W/BQefmBnX49Hm9gTOLpazLxGgIR0IMjG6VFQa08YC3lbQYFOYWwWi1gZquM6QOVyraq3WxRciNdnWJYhi96o3nqis6BY+rS9J21+e9XrhnT9tej3wrHVisyHya7FdQDHmu2ovz2lrUXm06UbYwlmRt5LCocc3VteAekxjTbhg1BEAEM836zFRoOW2dCjZhS/TNZazPLLrKaIeOTe7Yi/GYfu2myLTOc3RuUSto+bA+y432qD3R86pSMg8bo68dHbpjLi+w5PSX31TIJszMv8bcsz6rLLHxMl7ZNVuHWtflHC3rM4xRzSbjhz7bMecHqXf89UHqrlU7xM5bqZeszxbGltyzCQsEncPsxfjFrwbj3wwOf30+Hk/Cv+F4PP4zeyAhpA9EjRjXFh17eKCdj582dsePFLYLU2vxvzM3WmvsU+pt1XlahF8EqaPcHz+Wm6prl/inFHj/7q7ZpVZS43WK8msSPqnxyWM1TvWKKym2Vean1aR7vY/Xk6i3paJzmpdRpUAU9tmOqt31qKTDvLbSb9jk8o7dDnglB3F/cnn1cNVnJfrCNDWBBOa+YBM22qkQDu0KrQssaqvYhBXeV24yGjmuxdzcDk2F2smlVnzuhrkpR7ySo9Xh8AV76O+f4VX1g+ixHvzQI87zpdTLD5272ppnSi6MXtoxUusrXsk/4Ib1kw+6VH0mKXQK5AJt8JfUCxMON555U6GeyqUOfg2X78OQZ5Bo3v/lny0ZlfvPoNejAk+KDJypbY7w0uR14MeVR6u5lyuE99/+Hea1VD50C4ErVBR9rg/e1s6jgPkGUHu0lZUO3bDXI/7de5dyhS7AAQ65oZj02CcEIeqcBB1Y5GIDOCCLcl9bpJ7pqTKCL6yplwVwcFIvFfbh7cn0nJrG0dnpEKaoBQiT12VoeyRiy6QPJdd8ieCxJH4YZOb5TSAhkOM89zXBJ7DIFXhZYj928tqbknuM2AS1pxafrgElFxjRDBmHWjyhGgJzK9TCWFAmvxlIHfrqYDCgX8+eER4kvAFTgjIoaPVkhXYDFr+p0Xkoa+ch59Zu4r1tupKE1NGzTnxkECMjXJJl2Ux3NifwW+KwXfisoaE+TwDn8kuzJpC1RE2tF/cuvHqegl6Y3D2OdlodFaiqUQJRo6Oz01DZDqL/vzIeHHlyXaANeHaOS6l/BxcOgy69XpPmgHolrdFk2l4PnmffuwxkB8S3ssYbyqfWC3yxwDyYWlEEC+75niuOjUU45hWfSyWpkNL6PRxzj0tjN3AP7wruQ8jmXBPUu5/p+8FgEH6ItNd7maKu14N7QomcotqhFn2oKxE+WVyZmyamBFLcb8NzkNy+Dd+G83mK18D581oqARZrF18GaTNC6crioFI8D+BfLNG7T4MMZBmjEYylLNiEa9G2V0xRLQaUn+GKVykKHC0H0m5WtXZtuIDUK+lDt4KFMuvE9KyeK5nDrvjTgiAvhypuptRTUt+E9NEmcVXS+ZAL0qJIPF9avvDwztgbuily5CvsSGdsxybcgaATLph8ITVXMgZcCURhE99joz3PG+f9MdaJ+HCKwuRxH+bG3FCILS0vS+5lzpXaJCZfGCXQRh5v7JJrumsrmdROCmxLMLy0FI6LeCjxeIfzwpibyOQt5kg0VI4GVI4AV1RxtPFy0QAEBzEyLZi1pgdWZaT2iR2BlsTLW4krTG/IYJHYfoE6CcFO8uD9bmpQ4L//9h8OvsI11Z3UMGjzGRx5z/MiVMF3IdxgWleVsX6mqZtkvN13WROQIB1oswYXCcPLKDqpNVWf5KL42y5EguTYlmC7QNo0MZUWqX65YRL1S7L9NHpz2kTda6lv3ExP0UM2Y4UUeB39fd3E5bUKFGxC3Q3hHhZcOcxI5OzszfQcRkGwJGdGaUZsUth0w9ulsr2rLCTQONya9Vghp+MpdZLzuJrp7NXJOYySjqOJFFlQfnedkieDglJjjqjBeYu8JJAqQppZFLUWXHugR3CJnkKQMtNiaVYomodlZXEhVXji8eS4OLd44gHd6Lxl2OtRz70hA7TvP0DuJFoyVPPubT10xp1bGysGZ9Z4zCk0zl5+sY0o2ic/LaTC66ohnrEs2TUV0LkRG+ozGtbGhttDaUSd203VcHXDxDcE4GSmG3/GwEpmzODf/4Ls7OKRxcNy50Dy5miS6K53yfbiZG9j776wQcWXTJol+7xZLMiBbfRSzbJGtfHLlTLraxOpQgR/V+DuKxpi6AlNvaGZhpK5pGEB6tB1CPrJ2ICa+9pQJ8wVxkeJTevfJvneGkUNNtSHpg1lEB8zIb54nmNFFZt0atLRGoXk6YVEJYDn1jgXkFbQIgwjTO3R0eTDIgLRx3huy8wk9nS6nbooFnwlqWrud/JGpgx6zwUueK38QegJAYw1aJVKrkLufOipW5jaVLjIZyVxTXzaMh7HMG3ek6EsElWcEjXdr2nbELyZGl/GK5qwRXbHXMfMpkaeyPGWrNb05ChN0zvDZfdtaeF2bjQcm2oDz4+PD0g4WUmq0DN9FGZ+2Yzl+dbaj+o1V0YvQysjffBWugCushmbd89RWW/r97ZQx+pH0daii9aLowiUWmeelFwq4EJYdFQ7qKqhoHxvZbRNi+SElOdGD3LSrNsgAQOXMH/bcYB0rUPFEF7LG9zq0Cfxd6SB567OC0IUMUu2GS9FdtAMQBs7RNHIXzYMRcP4LdXyFVc19kMnj1WKLKskGZZgCmBZ+Q1wa/kGnmeXV9nBp2BKGSe00bTegNQF2mZxl/Uetj1qx3snW2DdANzOCuUEdwgXb18/AW6nEXsHIPEDAHmLBNu33S6H73w6t6dPLuAtLh8d/tCTPduHMn9C66QJReqX8DnPb9bcCgfHpqy4lwH6b4iUDlNwLGrCdvNEOMgbwjS2Xh2GMF4dDg/bl1/CXy62RF8Yh7CKF8eCtB23Gmpb0sE82T1w1QbmFmPXzAuul5QIBL46jVpS4Rd1HnMhyBuGzeGdzxXUWqFzYHyBdk0gVBvfzJe35rhwSO/mBgPN9AAuW2j6DudOety++9br9SNLH4QzX9RKQXr8hIT7wGsxHnsl/Zf1HN5iZZz0xm62p5bSF/U8+LJ7tv3QMEiPlHaI9mNeqYHlOdrS0Zh9inYl8w+oP/JEPjoIo++9ec7u2MXiAi3VHbfzxuaVbN7zl0kOIPF+jB40qWveKmEYSKUvDpZ+v88nDPVIhTeLRt9muPXd+rI+UzJH7bAzLDx6dfYaVh8Nx6zfmZJ9D1+OXp8en3w1PSFhmjRhE3Y4HA/HtFQZ50uuOzfRt2jtcGI7Pdwx+N12lvrzN28/f/P2f/DNWzM/9njrR5XiMkzsQyLeNdP2y+73cVd9VhjnafXujtrPhVUPD7T8TY2WxvhXfbbiVpJwYYjfT4NnGs/f4IZyPuB0RoSqjtPrvW8tdkb/r07OWZ/xmoTpDrxvwsC7+YO4py296fDenYRHAeh/Gss/eeDuLg7THx5a+rj1X080CiZqsuHVw8PDfwDLJFN3","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get your account details","permalink":"/docs/API-docs/v1.1/get-user"},"next":{"title":"Create Contact","permalink":"/docs/API-docs/v1.1/createcontact"}}');var n=r(74848),i=r(28453),d=r(57742),o=r.n(d),a=r(78178),l=r.n(a),c=r(19624),p=r.n(c),u=r(96226),y=r.n(u),b=(r(77675),r(19365),r(51107));r(21312);const h={id:"getcredits",title:"Get your API credits",description:"The Get Credits API returns details about the credits available to your account:",sidebar_label:"Get your API credits",hide_title:!0,hide_table_of_contents:!0,api:"eJztWd1uI7cVfpVTLlCsBf15k7SoUqR1vM7G6DZrrOwuUMvwUMMjDWMOOSE5kgXbQC6KPkDRm972JXrfR9knKQ45HI1kN5sgRW4aYL22yMPD838+Ht0xz5eOTS7ZhUPLrvpMoMutrLw0mk3YeYHwCj0cWxTSOzg6OwWLvrbagUDPpXLA56b24AuEvKHiKy4VnysEb2Bjags8z02t/WSmZ7rXqxTX1w3xpNdruUudq1qggLX0RTzo6nkrD9C5IZwX6BAsOvTA48XOc+vBLAB5XoDGNcylUlIvId/kCoczDXByy8tK4QROF5E1cYPKmpUU6OBwPG7lr9BCabQvgGtBxIBaEI+gJHGMEn4yBosll1rqZT8ynXPFdd6I50h/YhzFJA6tpMRK463vSEim4UKYJ21T1TYvuEMBDituuUe1gYU1JUzRe6mXDt7/9W/BQefmBnX49Hm9gTOLpazLxGgIR0IMjG6VFQa08YC3lbQYFOYWwWi1gZquM6QOVyraq3WxRciNdnWJYhi96o3nqis6BY+rS9J21+e9XrhnT9tej3wrHVisyHya7FdQDHmu2ovz2lrUXm06UbYwlmRt5LCocc3VteAekxjTbhg1BEAEM836zFRoOW2dCjZhS/TNZazPLLrKaIeOTe7Yi/GYfu2myLTOc3RuUSto+bA+y432qD3R86pSMg8bo68dHbpjLi+w5PSX31TIJszMv8bcsz6rLLHxMl7ZNVuHWtflHC3rM4xRzSbjhz7bMecHqXf89UHqrlU7xM5bqZeszxbGltyzCQsEncPsxfjFrwbj3wwOf30+Hk/Cv+F4PP4zeyAhpA9EjRjXFh17eKCdj582dsePFLYLU2vxvzM3WmvsU+pt1XlahF8EqaPcHz+Wm6prl/inFHj/7q7ZpVZS43WK8msSPqnxyWM1TvWKKym2Vean1aR7vY/Xk6i3paJzmpdRpUAU9tmOqt31qKTDvLbSb9jk8o7dDnglB3F/cnn1cNVnJfrCNDWBBOa+YBM22qkQDu0KrQssaqvYhBXeV24yGjmuxdzcDk2F2smlVnzuhrkpR7ySo9Xh8AV76O+f4VX1g+ixHvzQI87zpdTLD5272ppnSi6MXtoxUusrXsk/4Ib1kw+6VH0mKXQK5AJt8JfUCxMON555U6GeyqUOfg2X78OQZ5Bo3v/lny0ZlfvPoNejAk+KDJypbY7w0uR14MeVR6u5lyuE99/+Hea1VD50C4ErVBR9rg/e1s6jgPkGUHu0lZUO3bDXI/7de5dyhS7AAQ65oZj02CcEIeqcBB1Y5GIDOCCLcl9bpJ7pqTKCL6yplwVwcFIvFfbh7cn0nJrG0dnpEKaoBQiT12VoeyRiy6QPJdd8ieCxJH4YZOb5TSAhkOM89zXBJ7DIFXhZYj928tqbknuM2AS1pxafrgElFxjRDBmHWjyhGgJzK9TCWFAmvxlIHfrqYDCgX8+eER4kvAFTgjIoaPVkhXYDFr+p0Xkoa+ch59Zu4r1tupKE1NGzTnxkECMjXJJl2Ux3NifwW+KwXfisoaE+TwDn8kuzJpC1RE2tF/cuvHqegl6Y3D2OdlodFaiqUQJRo6Oz01DZDqL/vzIeHHlyXaANeHaOS6l/BxcOgy69XpPmgHolrdFk2l4PnmffuwxkB8S3ssYbyqfWC3yxwDyYWlEEC+75niuOjUU45hWfSyWpkNL6PRxzj0tjN3AP7wruQ8jmXBPUu5/p+8FgEH6ItNd7maKu14N7QomcotqhFn2oKxE+WVyZmyamBFLcb8NzkNy+Dd+G83mK18D581oqARZrF18GaTNC6crioFI8D+BfLNG7T4MMZBmjEYylLNiEa9G2V0xRLQaUn+GKVykKHC0H0m5WtXZtuIDUK+lDt4KFMuvE9KyeK5nDrvjTgiAvhypuptRTUt+E9NEmcVXS+ZAL0qJIPF9avvDwztgbuily5CvsSGdsxybcgaATLph8ITVXMgZcCURhE99joz3PG+f9MdaJ+HCKwuRxH+bG3FCILS0vS+5lzpXaJCZfGCXQRh5v7JJrumsrmdROCmxLMLy0FI6LeCjxeIfzwpibyOQt5kg0VI4GVI4AV1RxtPFy0QAEBzEyLZi1pgdWZaT2iR2BlsTLW4krTG/IYJHYfoE6CcFO8uD9bmpQ4L//9h8OvsI11Z3UMGjzGRx5z/MiVMF3IdxgWleVsX6mqZtkvN13WROQIB1oswYXCcPLKDqpNVWf5KL42y5EguTYlmC7QNo0MZUWqX65YRL1S7L9NHpz2kTda6lv3ExP0UM2Y4UUeB39fd3E5bUKFGxC3Q3hHhZcOcxI5OzszfQcRkGwJGdGaUZsUth0w9ulsr2rLCTQONya9Vghp+MpdZLzuJrp7NXJOYySjqOJFFlQfnedkieDglJjjqjBeYu8JJAqQppZFLUWXHugR3CJnkKQMtNiaVYomodlZXEhVXji8eS4OLd44gHd6Lxl2OtRz70hA7TvP0DuJFoyVPPubT10xp1bGysGZ9Z4zCk0zl5+sY0o2ic/LaTC66ohnrEs2TUV0LkRG+ozGtbGhttDaUSd203VcHXDxDcE4GSmG3/GwEpmzODf/4Ls7OKRxcNy50Dy5miS6K53yfbiZG9j776wQcWXTJol+7xZLMiBbfRSzbJGtfHLlTLraxOpQgR/V+DuKxpi6AlNvaGZhpK5pGEB6tB1CPrJ2ICa+9pQJ8wVxkeJTevfJvneGkUNNtSHpg1lEB8zIb54nmNFFZt0atLRGoXk6YVEJYDn1jgXkFbQIgwjTO3R0eTDIgLRx3huy8wk9nS6nbooFnwlqWrud/JGpgx6zwUueK38QegJAYw1aJVKrkLufOipW5jaVLjIZyVxTXzaMh7HMG3ek6EsElWcEjXdr2nbELyZGl/GK5qwRXbHXMfMpkaeyPGWrNb05ChN0zvDZfdtaeF2bjQcm2oDz4+PD0g4WUmq0DN9FGZ+2Yzl+dbaj+o1V0YvQysjffBWugCushmbd89RWW/r97ZQx+pH0daii9aLowiUWmeelFwq4EJYdFQ7qKqhoHxvZbRNi+SElOdGD3LSrNsgAQOXMH/bcYB0rUPFEF7LG9zq0Cfxd6SB567OC0IUMUu2GS9FdtAMQBs7RNHIXzYMRcP4LdXyFVc19kMnj1WKLKskGZZgCmBZ+Q1wa/kGnmeXV9nBp2BKGSe00bTegNQF2mZxl/Uetj1qx3snW2DdANzOCuUEdwgXb18/AW6nEXsHIPEDAHmLBNu33S6H73w6t6dPLuAtLh8d/tCTPduHMn9C66QJReqX8DnPb9bcCgfHpqy4lwH6b4iUDlNwLGrCdvNEOMgbwjS2Xh2GMF4dDg/bl1/CXy62RF8Yh7CKF8eCtB23Gmpb0sE82T1w1QbmFmPXzAuul5QIBL46jVpS4Rd1HnMhyBuGzeGdzxXUWqFzYHyBdk0gVBvfzJe35rhwSO/mBgPN9AAuW2j6DudOety++9br9SNLH4QzX9RKQXr8hIT7wGsxHnsl/Zf1HN5iZZz0xm62p5bSF/U8+LJ7tv3QMEiPlHaI9mNeqYHlOdrS0Zh9inYl8w+oP/JEPjoIo++9ec7u2MXiAi3VHbfzxuaVbN7zl0kOIPF+jB40qWveKmEYSKUvDpZ+v88nDPVIhTeLRt9muPXd+rI+UzJH7bAzLDx6dfYaVh8Nx6zfmZJ9D1+OXp8en3w1PSFhmjRhE3Y4HA/HtFQZ50uuOzfRt2jtcGI7Pdwx+N12lvrzN28/f/P2f/DNWzM/9njrR5XiMkzsQyLeNdP2y+73cVd9VhjnafXujtrPhVUPD7T8TY2WxvhXfbbiVpJwYYjfT4NnGs/f4IZyPuB0RoSqjtPrvW8tdkb/r07OWZ/xmoTpDrxvwsC7+YO4py296fDenYRHAeh/Gss/eeDuLg7THx5a+rj1X080CiZqsuHVw8PDfwDLJFN3",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-2",custom_edit_url:null},m=void 0,x={},X=[];function g(e){const t={p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(b.default,{as:"h1",className:"openapi__heading",children:"Get your API credits"}),"\n",(0,n.jsx)(o(),{method:"get",path:"/getcredits",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"The Get Credits API returns details about the credits available to your account:"}),"\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.strong,{children:"plan_credits:"})," Credits included with your subscription plan. These reset at the start of each new billing cycle.\nExample: If your plan provides 100 credits per month and you end\nthe cycle with 50 remaining, your balance resets to 100 at the\nstart of the next cycle."]}),"\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.strong,{children:"addon_credits:"})," Credits purchased separately from Settings \u2192 API Token \u2192 Buy Premium Credits. Add-on credits do not expire and are only used once all plan credits are consumed."]}),"\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.strong,{children:"total_credits:"})," The sum of ",(0,n.jsx)(t.strong,{children:"plan_credits"})," and ",(0,n.jsx)(t.strong,{children:"addon_credits"}),". This represents the total credits currently available for use."]}),"\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.strong,{children:"renewal_date:"})," The Subscription renewal date"]}),"\n",(0,n.jsx)(l(),{parameters:void 0}),"\n",(0,n.jsx)(p(),{...r(35398)}),"\n",(0,n.jsx)(y(),{...r(40588)})]})}function j(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(g,{...e})}):g(e)}},35398(e){e.exports={title:"Body"}},40588(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"plan_credits":{"type":"number","example":0},"addon_credits":{"type":"number","example":0},"total_credits":{"type":"number","example":0},"renewal_date":{"type":"string","format":"date","example":"2026-09-17T00:00:00.000Z"}},"title":"credits_res"}}}},"400":{"description":"Subscription not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Subscription not found!"}}}}}},"404":{"description":"User not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"User not found!"}},"title":"inline_response_404"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/5144c8d4.48a68cda.js b/assets/js/5144c8d4.48a68cda.js deleted file mode 100644 index 24b97388c..000000000 --- a/assets/js/5144c8d4.48a68cda.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[7904],{41145(e,t,s){s.r(t),s.d(t,{assets:()=>S,contentTitle:()=>x,default:()=>D,frontMatter:()=>g,metadata:()=>n,toc:()=>v});const n=JSON.parse('{"id":"API-docs/v1.1/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/v1.1/get-user.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/get-user","permalink":"/docs/API-docs/v1.1/get-user","draft":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJy9V81uGzcQfpUpL22EtST/JGl1ihu4rtMgMWoHBmobAXd3tMuYSzLkrGRBEJBD36CnXvtoeZJiSK0syUlbI0Uu0u5wZjg/3/zsXJCsghhdijcBvbjORImh8MqRskaMxHmNcIwEfAqHpyeARuYaA8xsC2ShQuJHD3ZqQBaFbQ1BiSSVDn2RCevQS9Z1UoqRqJDiNZnwGJw1AYMYzcXecMh/mzeftUWBIYxbDSslIhOFNYSGmF86p1URDwbvAgvNRShqbCQ/0cyhGAmbv8OCRCacZzWk0pWJzEatOAN5ZSqRibH1jaR1Ct7Kxmlm+ulY3ezt5/WbF2KRCSMbfKiGFxbhR0QWx0Yq/VD5dxZzxGdLQr+wDatytTUPNuXg8ZOn3+/v7e7ts4p3Nj9XpB+spcQJixe2cdLMHiptHZqgKhNVeJSE5SF9SsmdyN5wb39nd7gzfHq++2R08MPo8ZP+cDj8TWTitonxTHkRpaQYZ0purd5bV36FexbbbC1Df40tvS+Y8WB4cL8CYs0ZSzC2rSm/+f/Aj95b/8++b9+9WLNbGa0Mvu1K+C0b37nx+L4bJ2YitSpj9zi3N2i+rifr11O6/n5qVGKK52LD1XV6cjJg0XpFMzG6nIvbHenUTjofXV4vrjPRINV22e3YYEm1GIlBhdSm3hfQT9CHKN96LUaiJnJhNBgEacrc3va7otAyD1zhA+nUYLLb3xWLbFtGOvcgfmx3HioSSFbKVP8md30XmzPOX0rRRoRWiZJO/YIz0bXQDa5MKMZNjbKMBcLvYxuFl2l57dCcqcrEpMbLt+fWBerCNsgjimqEXq8T+fj7XyupXg9KW7QNGorw61+ZK/O69eDsFD1PHmlKGGu8VbnGNP6aeLaafwFlozEEPQNlCCsvCaFUlSKpgeOkTAWFdDJXWjFqmc2mkbkG/NCHixqpRs9H33oECSVOUDPYQbZkG0msqrMXptbfjLWdhgwk5G1QBkMANLU0BTN2mcjAepAG0BB651VACOTZapVss4a8LAgaaWSFrDuD9WCVqBXDFbzN20AQrG6jycBD3nosoXPIIJYhBvHo1vERMJUHg8eaYTNBqFpVYsigsCVCiEXKLpgScgwEjm1RBQZW2hpti5uYwHGrNTjLPUNJDXa8YSOLk5cm8KRJtnQ5WAXMecv7BCYDe703ATnDL5W5CaNe78rswOUKVxeYB0V4/V1XAtPp9B70H23KHCv6uc3hV3Q2KLJ+diddKarbPJbLupLVS9J0jAYjftaK4U5HaYtwv/qYOqhRu8EZEiMkDA5PT2KbfQQfP/wBL1F6A7WdJrQWrUc9g6q7iiOXMp/CtuqSMLYReDVHvEjg8/i+xUBdBC9qSR8//BngFU5BmWVJsSu93mmba1XAOTZOS8LQ643geRzvQB0NqJYEhTSQI4RaMpQmSoIEl6S1Mjd9ODQz4M4JU0V1BAPTo9yGGxyXVboD5DJgCdZEie7O/p1FTG8C6gkG1sWzLkfAUhEjuva2rdJt68YsnfM4VlrDhSorpOjbYVmCW5KnicwBXzMHx1wQVOMMpEcIaKgPp1si8aR1znq2QiXjx1ZrO+UEoCmdVYbCCEovx3SnP7sDetyilDWfIKUQylU4sqWaVUpSJS49XlH7V9yUtxr5Zr/1OEbPF4b0VdDlxaklnC47WAKj9UtgnZZNQ7KI68NyieaJ8mxbTxzl6JvwenyGfqIKXE61z1T0IDIPRCa0KtAEXFsRDo9PX8Jkvz8U2dp4/A/FPXh58vzo1dkRG8ONNAVstz/sD+PmbgM10qzddNx9U219T20PufndFvXF32nLsUx4SwOnpYpbUHRzvtxgLkW3wVxnoraBmDSfc5m98XqxYPL7Fj3vRdeZmEiv2IK4FWXdMOeV5wZnHM6iQMf70UTqNm0EW2vgxi51fHQuMsH9aHOJuIlLxPKBtXdHZrame3O7SAbwL686nxSYz9OCslis+NPRZyWWDnbcHMDrxWLxN7mpWlQ=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Introduction","permalink":"/docs/API-docs/v1.1/opensign-api-v-1-1"},"next":{"title":"Get your API credits","permalink":"/docs/API-docs/v1.1/getcredits"}}');var i=s(74848),a=s(28453),o=s(57742),r=s.n(o),p=s(78178),c=s.n(p),d=s(19624),l=s.n(d),m=s(96226),b=s.n(m),u=(s(77675),s(19365),s(51107));s(21312);const g={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:"eJy9V81uGzcQfpUpL22EtST/JGl1ihu4rtMgMWoHBmobAXd3tMuYSzLkrGRBEJBD36CnXvtoeZJiSK0syUlbI0Uu0u5wZjg/3/zsXJCsghhdijcBvbjORImh8MqRskaMxHmNcIwEfAqHpyeARuYaA8xsC2ShQuJHD3ZqQBaFbQ1BiSSVDn2RCevQS9Z1UoqRqJDiNZnwGJw1AYMYzcXecMh/mzeftUWBIYxbDSslIhOFNYSGmF86p1URDwbvAgvNRShqbCQ/0cyhGAmbv8OCRCacZzWk0pWJzEatOAN5ZSqRibH1jaR1Ct7Kxmlm+ulY3ezt5/WbF2KRCSMbfKiGFxbhR0QWx0Yq/VD5dxZzxGdLQr+wDatytTUPNuXg8ZOn3+/v7e7ts4p3Nj9XpB+spcQJixe2cdLMHiptHZqgKhNVeJSE5SF9SsmdyN5wb39nd7gzfHq++2R08MPo8ZP+cDj8TWTitonxTHkRpaQYZ0purd5bV36FexbbbC1Df40tvS+Y8WB4cL8CYs0ZSzC2rSm/+f/Aj95b/8++b9+9WLNbGa0Mvu1K+C0b37nx+L4bJ2YitSpj9zi3N2i+rifr11O6/n5qVGKK52LD1XV6cjJg0XpFMzG6nIvbHenUTjofXV4vrjPRINV22e3YYEm1GIlBhdSm3hfQT9CHKN96LUaiJnJhNBgEacrc3va7otAyD1zhA+nUYLLb3xWLbFtGOvcgfmx3HioSSFbKVP8md30XmzPOX0rRRoRWiZJO/YIz0bXQDa5MKMZNjbKMBcLvYxuFl2l57dCcqcrEpMbLt+fWBerCNsgjimqEXq8T+fj7XyupXg9KW7QNGorw61+ZK/O69eDsFD1PHmlKGGu8VbnGNP6aeLaafwFlozEEPQNlCCsvCaFUlSKpgeOkTAWFdDJXWjFqmc2mkbkG/NCHixqpRs9H33oECSVOUDPYQbZkG0msqrMXptbfjLWdhgwk5G1QBkMANLU0BTN2mcjAepAG0BB651VACOTZapVss4a8LAgaaWSFrDuD9WCVqBXDFbzN20AQrG6jycBD3nosoXPIIJYhBvHo1vERMJUHg8eaYTNBqFpVYsigsCVCiEXKLpgScgwEjm1RBQZW2hpti5uYwHGrNTjLPUNJDXa8YSOLk5cm8KRJtnQ5WAXMecv7BCYDe703ATnDL5W5CaNe78rswOUKVxeYB0V4/V1XAtPp9B70H23KHCv6uc3hV3Q2KLJ+diddKarbPJbLupLVS9J0jAYjftaK4U5HaYtwv/qYOqhRu8EZEiMkDA5PT2KbfQQfP/wBL1F6A7WdJrQWrUc9g6q7iiOXMp/CtuqSMLYReDVHvEjg8/i+xUBdBC9qSR8//BngFU5BmWVJsSu93mmba1XAOTZOS8LQ643geRzvQB0NqJYEhTSQI4RaMpQmSoIEl6S1Mjd9ODQz4M4JU0V1BAPTo9yGGxyXVboD5DJgCdZEie7O/p1FTG8C6gkG1sWzLkfAUhEjuva2rdJt68YsnfM4VlrDhSorpOjbYVmCW5KnicwBXzMHx1wQVOMMpEcIaKgPp1si8aR1znq2QiXjx1ZrO+UEoCmdVYbCCEovx3SnP7sDetyilDWfIKUQylU4sqWaVUpSJS49XlH7V9yUtxr5Zr/1OEbPF4b0VdDlxaklnC47WAKj9UtgnZZNQ7KI68NyieaJ8mxbTxzl6JvwenyGfqIKXE61z1T0IDIPRCa0KtAEXFsRDo9PX8Jkvz8U2dp4/A/FPXh58vzo1dkRG8ONNAVstz/sD+PmbgM10qzddNx9U219T20PufndFvXF32nLsUx4SwOnpYpbUHRzvtxgLkW3wVxnoraBmDSfc5m98XqxYPL7Fj3vRdeZmEiv2IK4FWXdMOeV5wZnHM6iQMf70UTqNm0EW2vgxi51fHQuMsH9aHOJuIlLxPKBtXdHZrame3O7SAbwL686nxSYz9OCslis+NPRZyWWDnbcHMDrxWLxN7mpWlQ=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},x=void 0,S={},v=[];function A(e){const t={p:"p",...(0,a.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Get your account details"}),"\n",(0,i.jsx)(r(),{method:"get",path:"/getuser",context:"endpoint"}),"\n",(0,i.jsx)(t.p,{children:"The Get User API enables you to get your own account details."}),"\n",(0,i.jsx)(c(),{parameters:void 0}),"\n",(0,i.jsx)(l(),{...s(776)}),"\n",(0,i.jsx)(b(),{...s(46709)})]})}function D(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(A,{...e})}):A(e)}},776(e){e.exports={title:"Body"}},46709(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"FGik23bhUJ"},"name":{"type":"string","format":"string","example":"Joe Bee"},"email":{"type":"string","format":"string","example":"joebee@example.com"},"phone":{"type":"string","format":"string","example":"4567832123"},"jobTitle":{"type":"string","format":"string","example":"dev"},"company":{"type":"string","format":"string","example":"opensign"},"createdAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"xml":{"name":"user"},"title":"user"}}}},"404":{"description":"User not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"User not found!"}},"title":"inline_response_404"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/5144c8d4.7221d6f5.js b/assets/js/5144c8d4.7221d6f5.js new file mode 100644 index 000000000..6f800834d --- /dev/null +++ b/assets/js/5144c8d4.7221d6f5.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[7904],{41145(e,t,o){o.r(t),o.d(t,{assets:()=>b,contentTitle:()=>I,default:()=>J,frontMatter:()=>y,metadata:()=>n,toc:()=>k});const n=JSON.parse('{"id":"API-docs/v1.1/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/v1.1/get-user.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/get-user","permalink":"/docs/API-docs/v1.1/get-user","draft":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJy9GdtuG8f1V07XQGERS1KynaRlijSKLCtO3FgwpRqoKGiHO4fcMWdnNjOzSxGSgDwU/YCiL33tT/S9n+IvKc7MzvIi146QIg+2yJlzv8/hTeLY3Caji+Tcokku04SjzY2onNAqGSVnBcIJOqBbODx9CajYVKKFla7BaZijo48G9FIBy3NdKwccHRPSDpI00RUaRrRe8mSUzNF5Nmli0FZaWbTJ6CZ5sr9Pf7Y5j+s8R2tntYSOSJImuVYOlSN4VlVS5P5i+M4S0k1i8wJLRp/cqsJklOjpO8xdkiaVITJOBJbhmITqIK0zQs2TNJlpUzK3eYLXrKwkAb04EYsnT6fF+XfJXZooVuJDKXynEb5BJHQsmZAPxX+ncYr4dXswyHVJpKpCqweL8uyzz7/43dMnB0+eEol3enomnHwwFY4Noee6rJhaPRRbV6ismCtPwiBzyA/dh4isUZ7sP3naP9jv739xdvD56NnvR599Ptjf3/9LkibXpbdn8EvCmfN2dkGt7ntd8V+Bz90uWE2hvwEWvt8R4LP9Z/czwOec0g5mulb8N/+/4EdjtPm47ru87zbkFkoKhVcxha9I+KjGZ/fVeKkaJgX31eNML1D9uppssneB/X3XiADk75MtVTfPg5IW89oIt0pGFzfJdZ9Voh/uRxeXd5dpUqIrdFvtSGDmimSUDOfo6lD7LJoGjfX4tZHJKCmcq+xoOLRM8am+HsSkkGxqKcOHrBLD5mDwJLlLd3FYVT0IHuv+Q1GsY3Oh5p/Cu1zbZkz+Cy7aslDnKFaJ73GVxBK6BZUmguKmQMZ9gtD3mfbIrVteV6jGYq68Uz3z3b71CCLM+7/+qwObqIn6Cno96mqkSN/q2uQIz3Vee3pMOjSKOdEgvP/pHzCthaQcMMCxQUmhZ1NwprYOOUxXgMqhqYywaAe9HtHf5DsXTdsqGVB9lOgwhcpoXuckaN8g4yvAPlmUudogVJI5qpfgCqPreQEMrFBziSm8OR6fUTs8PH05gDEqDlzndYnKWS9iRySFkik2R3BYEj30MrN84UGEmoN1zNUWhAKDTIITJabAFAdWO10yh6Gpo3LCYMcGpJhhvsplMA6TEpbCFbp20KDi2oDU+aIv1IAM0e/36c+jRzRAOOI6dsw45HR63KBZgcEfa7QOyto6yJkxq8C3y1WS0BUI2UZ8ZBAiwzPJsmyiNi5H8AeisD74qoWZqF7v/d/+Dhff6mUYXBQNFbjD8PJxDHquc3s/2ul0WKCshuOglB0enr70ZW0v+P8H7cCSJ5cFGiRWU5wL9UcaobwuvV6b5oCqEUYrMm2vB4+zn10Gsj2iWxntNOVT5wU2m2HuTS0pgjlzbMcVR9ogHLGKTYUUVEXp/BaOmMO5Niu4hbcF8yMd5EwB13A7Ubf9ft//I9Be73mMul4PbuHIN+0ULCqeQmitKRhs9KKNKY4U9+vw7Ee3r8O3pXwW49VT/qYWkoPB2tLIuQ5mry5UBvuVZDlyWAo+R2e/9DKQZbRC0IayYOXZoulYjFHO+pSfnsVJjAJLxx50M6s6u7ZUQKhGON+qYCb1MhI9radS5LAt/rhgBoFBFS5j6kmhFj59lI5UpbDO54IwyCPN54bNHLzVZkGcAkXW4IZ02mzYhFnghGG9yWdCMSlCwJVAECbSPdLKsbx13p9CnfA50AqTh3uYar2gEJsbVpbMiZxJuYpEXmjJ0QQar82cKeK1lkwoKzh2JRieGwrHWUCKNN7itNB6EYi8wRwJhspRn8oRYEMVR2knZu10YIFtPDZQ8UoL5SI5mlgiLWcENti9R8giuUEuHFAnoWGUPHi7nRoU+O9/+qeFH3BJdSc2DLp8BIfOsbzwVfCtDzcY11WljZso6iYZ6+5t1gYkCAtKL8EGQOSgVXBSZ6oUwsy7cRAAomM7gPUBadPGVDyk+mUHUdRvyfbj4M1xG3WvhFrYiRqjg2ySFILjVfD3VRuXV9JDJCPqbgi3MGPSYkYiZ6evx2cw9IJFOTNKMyITw2YzvG0s29vKQpwYB2uzHklkhB5TJzqPyYnKTo7PYBh1HI4Ez7zy2+eUPBkUlBpTRAXWGWQlTajcp5lBXivOlIOKGVaioxCkzDRY6ga5J9nrVQZnQkpfM6PjDLraEB2LhOtQrmBmdBl1XhPs9ajnLsgA3csWkFmBhgyVa2XrEjsPnTJrl9rw/qnRDnMKjdPnL9YRRffkp5mQeFW1wJMki3aNBXSq+Yr6jIKlNp67L42ocrOqWqp2EOn6ABxNVOvPEFjRjBn859+QnZ7fs7g/3kCI3hyOItzVNthOnOxc7PDzF1R8yaRZtM/r2Ywc2EUv1SyjZRe/TEq9vNIBykfwxwJ3V1EfQx/Q1GnAa3qLCCdX7aKDiiwXoQG1/LpQp5kLWV50adj5t02+N1pSg/X1oW1DGYSXjI8vludYUcUmndp0NFoieXomUHJgudHW+knLa0Fly+jaoR3AWWEQgeBDPHdlZhR6OnGnLooFawRVzd1O3sqUQe8xxxmrpdvzPcEPY+20SiVXIrPO99T1mNpWuECnEbgkOl0ZtyH7Y96ToQwSFGglV7H7tW0bvDdj48tYVRndBHJHTIXMpkYewfGarNb25CBN2zs9s9uutDAz1QqOdLWCx0dHeyScqARV6Ik6BIVLMnuer619r14zqdXctzLSB6+F9cNVNkmmm3hU1rv6vS7UofpRtHXTRefFYRiUOmce0yoIGOcGLdUOqmrIKd87GU3bIhlNylOt+jlpttkgwS+UQKsctx0gbOdQPoBXYoFrHVISf0saeGzrvKCJImTJOuMFz/ZoJmgEb+0QRCN/GcFbv3ddqWGyxtR38lClyLJSkGFpTAEsK7cCZgxbwePs4jLb+xJ0KZynEkzrNAhVoGkPt0nvzLaHDRPSZ+rxerBuB9yNE8oJZhHO37z6wHA7DrO3HyQeMJB3k2D3ttum8NGnc4d9fA5vcH4P+VNP9mx3lPkzGiu0L1K/hW9Yvlgywy0c0YrOCT/6rwiUkCk4ZjXNdtMI2M9bQBmeFtAc+DBuDgYH3csvzl82tERXaIvQBMahILHOH5ralrAwjXb3VJWGqcHQNfOCqTklAg1fG41aUOHndR5ywctLpLV/5zMJtZJoLWhXoFnSEKo0xfi2Oc4t0ru5nYEmqg8X3Wj6FqdWOFy/+5bL5T1L73mcF7WUEB8/PuE+8VoMaCfCfVtP4Q1W2gqnzWqNNReuqKfel5u43ZeWQHykdBu0X/JK9STP0JQW9AzGaBqRf0L9oSPw4d6EdjM7+5zttYvBGRqqO3brjc0q0b7nL6IcQOL9Ej3Cztm/VfwmMOzSabH09S4dv9EjFV7PWn3b5dbH9U3SRIoclcWNTeHhyekraJ4O9pN0Y0v2M3w5fPXy6PiH8TEJ06ZJMkoOBvuDfb/A19aVTG1wOok/rez8rLK767pZL1N/8c817XbO4bUbVpIJvwz1at60i8yLJC4yL9Ok0NbR0c0NZfa5kXd3dPxjjYbWo5dp0jAjSAK/HE3jTo82nwtckTn9CJQQoKzDYnBnG7y1Uj05PkvShNUkyeYuceF3ie0Hoh6v1GqD9vaSMQhA/9PG84MINzdhT3l318GHq/+J0SoYocmAl3d3d/8Fyp2o7Q==","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Introduction","permalink":"/docs/API-docs/v1.1/opensign-api-v-1-2"},"next":{"title":"Get your API credits","permalink":"/docs/API-docs/v1.1/getcredits"}}');var s=o(74848),a=o(28453),i=o(57742),r=o.n(i),c=o(78178),d=o.n(c),p=o(19624),l=o.n(p),u=o(96226),m=o.n(u),O=(o(77675),o(19365),o(51107));o(21312);const y={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:"eJy9GdtuG8f1V07XQGERS1KynaRlijSKLCtO3FgwpRqoKGiHO4fcMWdnNjOzSxGSgDwU/YCiL33tT/S9n+IvKc7MzvIi146QIg+2yJlzv8/hTeLY3Caji+Tcokku04SjzY2onNAqGSVnBcIJOqBbODx9CajYVKKFla7BaZijo48G9FIBy3NdKwccHRPSDpI00RUaRrRe8mSUzNF5Nmli0FZaWbTJ6CZ5sr9Pf7Y5j+s8R2tntYSOSJImuVYOlSN4VlVS5P5i+M4S0k1i8wJLRp/cqsJklOjpO8xdkiaVITJOBJbhmITqIK0zQs2TNJlpUzK3eYLXrKwkAb04EYsnT6fF+XfJXZooVuJDKXynEb5BJHQsmZAPxX+ncYr4dXswyHVJpKpCqweL8uyzz7/43dMnB0+eEol3enomnHwwFY4Noee6rJhaPRRbV6ismCtPwiBzyA/dh4isUZ7sP3naP9jv739xdvD56NnvR599Ptjf3/9LkibXpbdn8EvCmfN2dkGt7ntd8V+Bz90uWE2hvwEWvt8R4LP9Z/czwOec0g5mulb8N/+/4EdjtPm47ru87zbkFkoKhVcxha9I+KjGZ/fVeKkaJgX31eNML1D9uppssneB/X3XiADk75MtVTfPg5IW89oIt0pGFzfJdZ9Voh/uRxeXd5dpUqIrdFvtSGDmimSUDOfo6lD7LJoGjfX4tZHJKCmcq+xoOLRM8am+HsSkkGxqKcOHrBLD5mDwJLlLd3FYVT0IHuv+Q1GsY3Oh5p/Cu1zbZkz+Cy7aslDnKFaJ73GVxBK6BZUmguKmQMZ9gtD3mfbIrVteV6jGYq68Uz3z3b71CCLM+7/+qwObqIn6Cno96mqkSN/q2uQIz3Vee3pMOjSKOdEgvP/pHzCthaQcMMCxQUmhZ1NwprYOOUxXgMqhqYywaAe9HtHf5DsXTdsqGVB9lOgwhcpoXuckaN8g4yvAPlmUudogVJI5qpfgCqPreQEMrFBziSm8OR6fUTs8PH05gDEqDlzndYnKWS9iRySFkik2R3BYEj30MrN84UGEmoN1zNUWhAKDTIITJabAFAdWO10yh6Gpo3LCYMcGpJhhvsplMA6TEpbCFbp20KDi2oDU+aIv1IAM0e/36c+jRzRAOOI6dsw45HR63KBZgcEfa7QOyto6yJkxq8C3y1WS0BUI2UZ8ZBAiwzPJsmyiNi5H8AeisD74qoWZqF7v/d/+Dhff6mUYXBQNFbjD8PJxDHquc3s/2ul0WKCshuOglB0enr70ZW0v+P8H7cCSJ5cFGiRWU5wL9UcaobwuvV6b5oCqEUYrMm2vB4+zn10Gsj2iWxntNOVT5wU2m2HuTS0pgjlzbMcVR9ogHLGKTYUUVEXp/BaOmMO5Niu4hbcF8yMd5EwB13A7Ubf9ft//I9Be73mMul4PbuHIN+0ULCqeQmitKRhs9KKNKY4U9+vw7Ee3r8O3pXwW49VT/qYWkoPB2tLIuQ5mry5UBvuVZDlyWAo+R2e/9DKQZbRC0IayYOXZoulYjFHO+pSfnsVJjAJLxx50M6s6u7ZUQKhGON+qYCb1MhI9radS5LAt/rhgBoFBFS5j6kmhFj59lI5UpbDO54IwyCPN54bNHLzVZkGcAkXW4IZ02mzYhFnghGG9yWdCMSlCwJVAECbSPdLKsbx13p9CnfA50AqTh3uYar2gEJsbVpbMiZxJuYpEXmjJ0QQar82cKeK1lkwoKzh2JRieGwrHWUCKNN7itNB6EYi8wRwJhspRn8oRYEMVR2knZu10YIFtPDZQ8UoL5SI5mlgiLWcENti9R8giuUEuHFAnoWGUPHi7nRoU+O9/+qeFH3BJdSc2DLp8BIfOsbzwVfCtDzcY11WljZso6iYZ6+5t1gYkCAtKL8EGQOSgVXBSZ6oUwsy7cRAAomM7gPUBadPGVDyk+mUHUdRvyfbj4M1xG3WvhFrYiRqjg2ySFILjVfD3VRuXV9JDJCPqbgi3MGPSYkYiZ6evx2cw9IJFOTNKMyITw2YzvG0s29vKQpwYB2uzHklkhB5TJzqPyYnKTo7PYBh1HI4Ez7zy2+eUPBkUlBpTRAXWGWQlTajcp5lBXivOlIOKGVaioxCkzDRY6ga5J9nrVQZnQkpfM6PjDLraEB2LhOtQrmBmdBl1XhPs9ajnLsgA3csWkFmBhgyVa2XrEjsPnTJrl9rw/qnRDnMKjdPnL9YRRffkp5mQeFW1wJMki3aNBXSq+Yr6jIKlNp67L42ocrOqWqp2EOn6ABxNVOvPEFjRjBn859+QnZ7fs7g/3kCI3hyOItzVNthOnOxc7PDzF1R8yaRZtM/r2Ywc2EUv1SyjZRe/TEq9vNIBykfwxwJ3V1EfQx/Q1GnAa3qLCCdX7aKDiiwXoQG1/LpQp5kLWV50adj5t02+N1pSg/X1oW1DGYSXjI8vludYUcUmndp0NFoieXomUHJgudHW+knLa0Fly+jaoR3AWWEQgeBDPHdlZhR6OnGnLooFawRVzd1O3sqUQe8xxxmrpdvzPcEPY+20SiVXIrPO99T1mNpWuECnEbgkOl0ZtyH7Y96ToQwSFGglV7H7tW0bvDdj48tYVRndBHJHTIXMpkYewfGarNb25CBN2zs9s9uutDAz1QqOdLWCx0dHeyScqARV6Ik6BIVLMnuer619r14zqdXctzLSB6+F9cNVNkmmm3hU1rv6vS7UofpRtHXTRefFYRiUOmce0yoIGOcGLdUOqmrIKd87GU3bIhlNylOt+jlpttkgwS+UQKsctx0gbOdQPoBXYoFrHVISf0saeGzrvKCJImTJOuMFz/ZoJmgEb+0QRCN/GcFbv3ddqWGyxtR38lClyLJSkGFpTAEsK7cCZgxbwePs4jLb+xJ0KZynEkzrNAhVoGkPt0nvzLaHDRPSZ+rxerBuB9yNE8oJZhHO37z6wHA7DrO3HyQeMJB3k2D3ttum8NGnc4d9fA5vcH4P+VNP9mx3lPkzGiu0L1K/hW9Yvlgywy0c0YrOCT/6rwiUkCk4ZjXNdtMI2M9bQBmeFtAc+DBuDgYH3csvzl82tERXaIvQBMahILHOH5ralrAwjXb3VJWGqcHQNfOCqTklAg1fG41aUOHndR5ywctLpLV/5zMJtZJoLWhXoFnSEKo0xfi2Oc4t0ru5nYEmqg8X3Wj6FqdWOFy/+5bL5T1L73mcF7WUEB8/PuE+8VoMaCfCfVtP4Q1W2gqnzWqNNReuqKfel5u43ZeWQHykdBu0X/JK9STP0JQW9AzGaBqRf0L9oSPw4d6EdjM7+5zttYvBGRqqO3brjc0q0b7nL6IcQOL9Ej3Cztm/VfwmMOzSabH09S4dv9EjFV7PWn3b5dbH9U3SRIoclcWNTeHhyekraJ4O9pN0Y0v2M3w5fPXy6PiH8TEJ06ZJMkoOBvuDfb/A19aVTG1wOok/rez8rLK767pZL1N/8c817XbO4bUbVpIJvwz1at60i8yLJC4yL9Ok0NbR0c0NZfa5kXd3dPxjjYbWo5dp0jAjSAK/HE3jTo82nwtckTn9CJQQoKzDYnBnG7y1Uj05PkvShNUkyeYuceF3ie0Hoh6v1GqD9vaSMQhA/9PG84MINzdhT3l318GHq/+J0SoYocmAl3d3d/8Fyp2o7Q==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-2",custom_edit_url:null},I=void 0,b={},k=[];function g(e){const t={p:"p",...(0,a.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(O.default,{as:"h1",className:"openapi__heading",children:"Get your account details"}),"\n",(0,s.jsx)(r(),{method:"get",path:"/getuser",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Get User API enables you to get your own account details."}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(l(),{...o(776)}),"\n",(0,s.jsx)(m(),{...o(46709)})]})}function J(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(g,{...e})}):g(e)}},776(e){e.exports={title:"Body"}},46709(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"FGik23bhUJ"},"name":{"type":"string","format":"string","example":"Joe Bee"},"email":{"type":"string","format":"string","example":"joebee@example.com"},"phone":{"type":"string","format":"string","example":"4567832123"},"jobTitle":{"type":"string","format":"string","example":"dev"},"company":{"type":"string","format":"string","example":"opensign"},"createdAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"xml":{"name":"user"},"title":"user"}}}},"404":{"description":"User not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"User not found!"}},"title":"inline_response_404"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/58abd73c.21027484.js b/assets/js/58abd73c.21027484.js new file mode 100644 index 000000000..1eb1a4061 --- /dev/null +++ b/assets/js/58abd73c.21027484.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[8564],{64502(e,t,o){o.r(t),o.d(t,{assets:()=>f,contentTitle:()=>j,default:()=>w,frontMatter:()=>y,metadata:()=>i,toc:()=>V});const i=JSON.parse('{"id":"API-docs/v1.1/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/v1.1/folderlist.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/folderlist","permalink":"/docs/API-docs/v1.1/folderlist","draft":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJy9GdtuI7f1V05ngWItjC52simqFGkdr+M43e4alt0FahkeauZIwxWHnJAcyYItIA9FP6DoS1/7E33vp+yXFIccjkays7tu0jwkXpHnfueZu8iymYmGV9E3SmSoo+s4ytCkmpeWKxkNo4scwd/BK24sHJ6dAhalWqI2sFIVWAUarea4QGAgCEZNYepRltzmoPxfVVkomUZpPb3TLIojVaJmxOo0i4aRxyIaURyVTLMCLWqS7y6SrMBoGD2gwEnK7yvUq2hXdjV5h6k9zTYCRXGk8fuKa8yi4ZQJg3Fk7EqgY66LKI7wthQqw811mmPBouFdZFclwRmruZxFsUNgtn2Ct6woHbFovY4bmQUvuN0V9ZPlsLraEqNgt7yoimj4YjCIg1CyKiaoo3VLhv1BSwQz5+XPJsGP8xysr4muKZU0aAj2YDCgP9uOMVWaojHTSkATAFEcpUpalJbgWVkKnrqL/jtDSHcPBfD+pVDRRMZyz1KjqYRtwTGtGSnMLRbm4/ghbJ7q8zLfn+S3B+9KMomPt9fO+k8jI3EZonUd78b7E2l9dyCZeTHnZ7hL63+VzFSTlnSpRmYxO7SPkdogHgwOPuvuD7qD31zsfzH8/LfDF1/0BoPBX6I4ui0E4dZhmjHrJLXcivbvqsx+AT6tA6/ijUYTrdvnXAou8SaE+M3BYHCz/xnBrOPo88difaQKtDmXM1iitLDUSs5iKAUyg2D1CtiMcQmCWdS/+vmSALVW+sPWeppkH7LC52SFxggvHhrhVC6Y4JnrHhdqjvKX1bTN3nr2JOp2THAP5O6jLWXb515Jg2mluV25znTbZSXv+vvh1TWVQDKsoo42Q9/KbB4No/5WfzOoF6G5VVpEwyi3tjTDft8wmU3UbU+VKA2fScEmppeqos9K3l/s9w4iquzbOKwsnwSPVfepKMayGZezj+Fdb8wzIhd6L20ZaVOZS/5HpNJc+6ANVXerHJkrNmv6PVUOufbMmxLliM+k86tjvjsBPIMA8/6v/2rAxnIsv4JOh2YbUqRrVKVThJcqrRw9JixqySxfILz/4R8wqbiwMFUaMlygoOgzMVhdGYsZTFaA0qIuNTdoep0O0W/znfEF+mGJQaooJi3GUGqVVSkJ2tXIshVglyzKbKURSsEslWKwuVbVLAcGhsuZwBjOj0cX1DkPz057MEKZQabSqkBpjROxIRJDwSSbIVgsiB46mVk6dyCU98YyWxngEjQyAZYXGAOTGbDKqoJZJKE1acc1NmxA8Cmmq1R44zAhmvlugTJTGoRK510ue2SIbrdLf549gxO0lriOLNMWMzo9XqBeAQ0iaCwUlbGQMq1Xnm+TriShzRGSVnwk4CPDMUmSZCxbl0P4HVHYHHxVw4xlp/P+b3+Hq2/VkkbXGUqaP3CH4fXzEPSZSs3DaKfTfo6i7I+8UqZ/eHbqKtue9/9rZcGQJ5c5aiRWE5xx+Xu4pOKaI3Q6dZoDygXXSpJpOx14nnxyGUj2iG6plVWUT40X2HSKqTO1oAjOmGU7rjhSGuGIlWzCBadCSuf3cMQszpRewT28zZl1IZsyCZmC+7G873a77j8C7XRehqjrdOAejtwkEINBmcXg+3UMGhdqXsdUhhT3m/DsBrdvwremfBHi1VH+uuIiA42VYRPRCmb/uCg1dkvBUsxgybMZWvOlk4EsoyTS46NgcuXY0pOlZjFCMe1SfjoWJyEKDB070HZWNXatqQCXC25dt4KpUMtA9KyaCJ7CtvijnGl6GZX+MqSe4HLu0keqQNW9ncJQHmi+1Gxq4a3Sc+LkKbIFtqRTumUTZiAjDONMPuWSCe4DrvCNPNA9UtKytHben3ydcDlQC5P6e5goNacQm2lWFMzylAmxCkT8KOlpvNEzJonXRjIuDc+wKcHwUlM4+ibYeOItTnKl5p7IOaZIMFSOulSOABdUcaSyfFoPCAZ8ZGpQSwkos1JxaQO5SxMEOm9epWmqKmmdRVKNGbdAnYTmXPLg/XZqUOC//+GfBl7jkupOaBh0+QwOrWVp7qrgWxduMKrKUmk7ltRNEtbcm6QOSOAGpKLJ2QFiBkp6JzWmisEP0q0DDxAc2wBsDkibOqbCIdUv0wuifku2H3lvjuqoe8Xl3IzlCC0k4yjnGd54f9/UcXkjHEQ0pO6GcA/uaZiQyMnZm9EF9J1gQc6E0ozIhLBph7cJZXtbWQhjY29j1iOBjNBD6gTnMTGWycnxBfSDjv0hzxKn/PY5JU8COaXGBFGCsRpZQWNq5tJMY1bJjEm3g6j3CkCZqbFQC8wcyU6n1DjlQriaGRyn0Vaa6BgkXItiBVOtiqDzhmCnQz13TgZoHsGAzHDUZKhUSVMV2HjojBmzVDrrnmllMaXQOHv5zSai6J78NOUCb8oaeBwlwa6hgE5UtqI+I2GptOPuSiPKVK/KmqrpBbouAIdjWfvTB1YwYwL/+TckZ5cPLO6OWwjBm/1hgLvZBtuJk52LHX7ugoovmTQJ9nkznZIDm+ilmqWVaOKXCaGWN8pDuQj+UODuKupi6BFNrQLafPCUW0GTnes6NPpx34Bqfk2o08yFLM2bNGz8WyffuRLUYF19qNtQAv4x4+KLpSmWVLFJpzodtRJInp5yFBmwVCtj3KTltKCypVVl0fTgIteIQPA+npsyM/Q9nbhTF8WcLThVzd1OXsuUQOd5hlNWCbvneoIbxupplUouvQut66mbMbWucJ7OguOS6DRl3PjsD3lPhtJIUKCkWIXuV7dtcN4MjS9hZanVwpM7YtJnNjXyAI63ZLW6J3tp6t7pmN03pYXpiZJwpMoVPD862iPheMmpQo/lIdBOIxlHabqx9oN6zYSSM9fKSB+85cYNV8k4mrTxqKw39XtTqH31o2hrpovGi30/KDXOPC4YF8CyTKOh2kFVDTPK90ZGXbdIRpPyRMluSpq1GySgo6JkitsO4KZxaNaDV3yOGx1iEn9LGnhuqjSnicJnySbjeZbs0Uyw4FltBy8a+UvzrPZ705UWTFQYu07uqxRZVnAyLI0ptE62K3BLOnieXF0ne1+CKrh1VLxprQIuc9T14Tbpndn2cMG4cJl6vBms6wG3dUI5QYuOy/NXjwy3Iz97u0HiCQN5Mwk2b7ttCh98OjfYx5dwjrMHyB97sie7o8yfURuuXJH6NXzN0vmS6czAkSpKZrkb/VcESsgUHNOKZrtJAOymNaDwTwtY7LswXuz39puXX5i/jG+JNlcGYeEZ+4LEGn8oalvcwCTY3VGVCiYafddMcyZnlAg0fLUaNafCn1WpzwUnL5FW7p3PBFRSoDGgbI56SUOoVBTj2+a4NEjv5noGGssuXDWj6VucGG5x8+5bLpcPLL3ncL6phIDw+HEJ95HXokc74fbbagLnWCrDrdKrDdaM27yaOF+2cZsfNYHwSGmWaD/llepIXqAuDH0dGaFe8PQj6vctgff3xrSb2dnnbK9dNE5RU90xW29sVvL6PX8V5AAS76fo4bbQ/q3iloFU+vxi6Q+7dNxSj1R4M631rZdbH9Y3iiPBU5QGW8vCw5OzV7D4rDeI4taW7BN82X91enT8enRMwtRpEg2j/d6gN3AremVswWSL0wna8DWtXhxu2fpus0b9f3+rq3d2Fm9tvxSMuy2pU/6u3nBetb/gXcdRroyl07s7SvlLLdZrOvYfoGjvWc9Um09QP6rbo9/yHpVojqvHvhO6VuG+zMWP8PVI4UPdp8DWX9Q2oNf0Q3OCdWvgOKwuSVGPc+gmvRbWg7331vL45PgiiiNWkWnbK9O5W5nW/yDq4UquWrS3d6leAPo/6fQowt2dX8eu1w28v/pRjFrBAE32v16v1/8FpUSviQ==","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Folder","permalink":"/docs/API-docs/v1.1/deletefolder"},"next":{"title":"v1","permalink":"/docs/API-docs/v1"}}');var n=o(74848),r=o(28453),a=o(57742),s=o.n(a),l=o(78178),p=o.n(l),d=o(19624),m=o.n(d),u=o(96226),c=o.n(u),b=(o(77675),o(19365),o(51107)),S=o(21312);const y={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:"eJy9GdtuI7f1V05ngWItjC52simqFGkdr+M43e4alt0FahkeauZIwxWHnJAcyYItIA9FP6DoS1/7E33vp+yXFIccjkays7tu0jwkXpHnfueZu8iymYmGV9E3SmSoo+s4ytCkmpeWKxkNo4scwd/BK24sHJ6dAhalWqI2sFIVWAUarea4QGAgCEZNYepRltzmoPxfVVkomUZpPb3TLIojVaJmxOo0i4aRxyIaURyVTLMCLWqS7y6SrMBoGD2gwEnK7yvUq2hXdjV5h6k9zTYCRXGk8fuKa8yi4ZQJg3Fk7EqgY66LKI7wthQqw811mmPBouFdZFclwRmruZxFsUNgtn2Ct6woHbFovY4bmQUvuN0V9ZPlsLraEqNgt7yoimj4YjCIg1CyKiaoo3VLhv1BSwQz5+XPJsGP8xysr4muKZU0aAj2YDCgP9uOMVWaojHTSkATAFEcpUpalJbgWVkKnrqL/jtDSHcPBfD+pVDRRMZyz1KjqYRtwTGtGSnMLRbm4/ghbJ7q8zLfn+S3B+9KMomPt9fO+k8jI3EZonUd78b7E2l9dyCZeTHnZ7hL63+VzFSTlnSpRmYxO7SPkdogHgwOPuvuD7qD31zsfzH8/LfDF1/0BoPBX6I4ui0E4dZhmjHrJLXcivbvqsx+AT6tA6/ijUYTrdvnXAou8SaE+M3BYHCz/xnBrOPo88difaQKtDmXM1iitLDUSs5iKAUyg2D1CtiMcQmCWdS/+vmSALVW+sPWeppkH7LC52SFxggvHhrhVC6Y4JnrHhdqjvKX1bTN3nr2JOp2THAP5O6jLWXb515Jg2mluV25znTbZSXv+vvh1TWVQDKsoo42Q9/KbB4No/5WfzOoF6G5VVpEwyi3tjTDft8wmU3UbU+VKA2fScEmppeqos9K3l/s9w4iquzbOKwsnwSPVfepKMayGZezj+Fdb8wzIhd6L20ZaVOZS/5HpNJc+6ANVXerHJkrNmv6PVUOufbMmxLliM+k86tjvjsBPIMA8/6v/2rAxnIsv4JOh2YbUqRrVKVThJcqrRw9JixqySxfILz/4R8wqbiwMFUaMlygoOgzMVhdGYsZTFaA0qIuNTdoep0O0W/znfEF+mGJQaooJi3GUGqVVSkJ2tXIshVglyzKbKURSsEslWKwuVbVLAcGhsuZwBjOj0cX1DkPz057MEKZQabSqkBpjROxIRJDwSSbIVgsiB46mVk6dyCU98YyWxngEjQyAZYXGAOTGbDKqoJZJKE1acc1NmxA8Cmmq1R44zAhmvlugTJTGoRK510ue2SIbrdLf549gxO0lriOLNMWMzo9XqBeAQ0iaCwUlbGQMq1Xnm+TriShzRGSVnwk4CPDMUmSZCxbl0P4HVHYHHxVw4xlp/P+b3+Hq2/VkkbXGUqaP3CH4fXzEPSZSs3DaKfTfo6i7I+8UqZ/eHbqKtue9/9rZcGQJ5c5aiRWE5xx+Xu4pOKaI3Q6dZoDygXXSpJpOx14nnxyGUj2iG6plVWUT40X2HSKqTO1oAjOmGU7rjhSGuGIlWzCBadCSuf3cMQszpRewT28zZl1IZsyCZmC+7G873a77j8C7XRehqjrdOAejtwkEINBmcXg+3UMGhdqXsdUhhT3m/DsBrdvwremfBHi1VH+uuIiA42VYRPRCmb/uCg1dkvBUsxgybMZWvOlk4EsoyTS46NgcuXY0pOlZjFCMe1SfjoWJyEKDB070HZWNXatqQCXC25dt4KpUMtA9KyaCJ7CtvijnGl6GZX+MqSe4HLu0keqQNW9ncJQHmi+1Gxq4a3Sc+LkKbIFtqRTumUTZiAjDONMPuWSCe4DrvCNPNA9UtKytHben3ydcDlQC5P6e5goNacQm2lWFMzylAmxCkT8KOlpvNEzJonXRjIuDc+wKcHwUlM4+ibYeOItTnKl5p7IOaZIMFSOulSOABdUcaSyfFoPCAZ8ZGpQSwkos1JxaQO5SxMEOm9epWmqKmmdRVKNGbdAnYTmXPLg/XZqUOC//+GfBl7jkupOaBh0+QwOrWVp7qrgWxduMKrKUmk7ltRNEtbcm6QOSOAGpKLJ2QFiBkp6JzWmisEP0q0DDxAc2wBsDkibOqbCIdUv0wuifku2H3lvjuqoe8Xl3IzlCC0k4yjnGd54f9/UcXkjHEQ0pO6GcA/uaZiQyMnZm9EF9J1gQc6E0ozIhLBph7cJZXtbWQhjY29j1iOBjNBD6gTnMTGWycnxBfSDjv0hzxKn/PY5JU8COaXGBFGCsRpZQWNq5tJMY1bJjEm3g6j3CkCZqbFQC8wcyU6n1DjlQriaGRyn0Vaa6BgkXItiBVOtiqDzhmCnQz13TgZoHsGAzHDUZKhUSVMV2HjojBmzVDrrnmllMaXQOHv5zSai6J78NOUCb8oaeBwlwa6hgE5UtqI+I2GptOPuSiPKVK/KmqrpBbouAIdjWfvTB1YwYwL/+TckZ5cPLO6OWwjBm/1hgLvZBtuJk52LHX7ugoovmTQJ9nkznZIDm+ilmqWVaOKXCaGWN8pDuQj+UODuKupi6BFNrQLafPCUW0GTnes6NPpx34Bqfk2o08yFLM2bNGz8WyffuRLUYF19qNtQAv4x4+KLpSmWVLFJpzodtRJInp5yFBmwVCtj3KTltKCypVVl0fTgIteIQPA+npsyM/Q9nbhTF8WcLThVzd1OXsuUQOd5hlNWCbvneoIbxupplUouvQut66mbMbWucJ7OguOS6DRl3PjsD3lPhtJIUKCkWIXuV7dtcN4MjS9hZanVwpM7YtJnNjXyAI63ZLW6J3tp6t7pmN03pYXpiZJwpMoVPD862iPheMmpQo/lIdBOIxlHabqx9oN6zYSSM9fKSB+85cYNV8k4mrTxqKw39XtTqH31o2hrpovGi30/KDXOPC4YF8CyTKOh2kFVDTPK90ZGXbdIRpPyRMluSpq1GySgo6JkitsO4KZxaNaDV3yOGx1iEn9LGnhuqjSnicJnySbjeZbs0Uyw4FltBy8a+UvzrPZ705UWTFQYu07uqxRZVnAyLI0ptE62K3BLOnieXF0ne1+CKrh1VLxprQIuc9T14Tbpndn2cMG4cJl6vBms6wG3dUI5QYuOy/NXjwy3Iz97u0HiCQN5Mwk2b7ttCh98OjfYx5dwjrMHyB97sie7o8yfURuuXJH6NXzN0vmS6czAkSpKZrkb/VcESsgUHNOKZrtJAOymNaDwTwtY7LswXuz39puXX5i/jG+JNlcGYeEZ+4LEGn8oalvcwCTY3VGVCiYafddMcyZnlAg0fLUaNafCn1WpzwUnL5FW7p3PBFRSoDGgbI56SUOoVBTj2+a4NEjv5noGGssuXDWj6VucGG5x8+5bLpcPLL3ncL6phIDw+HEJ95HXokc74fbbagLnWCrDrdKrDdaM27yaOF+2cZsfNYHwSGmWaD/llepIXqAuDH0dGaFe8PQj6vctgff3xrSb2dnnbK9dNE5RU90xW29sVvL6PX8V5AAS76fo4bbQ/q3iloFU+vxi6Q+7dNxSj1R4M631rZdbH9Y3iiPBU5QGW8vCw5OzV7D4rDeI4taW7BN82X91enT8enRMwtRpEg2j/d6gN3AremVswWSL0wna8DWtXhxu2fpus0b9f3+rq3d2Fm9tvxSMuy2pU/6u3nBetb/gXcdRroyl07s7SvlLLdZrOvYfoGjvWc9Um09QP6rbo9/yHpVojqvHvhO6VuG+zMWP8PVI4UPdp8DWX9Q2oNf0Q3OCdWvgOKwuSVGPc+gmvRbWg7331vL45PgiiiNWkWnbK9O5W5nW/yDq4UquWrS3d6leAPo/6fQowt2dX8eu1w28v/pRjFrBAE32v16v1/8FpUSviQ==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-2",custom_edit_url:null},j=void 0,f={},V=[];function O(e){const t={p:"p",...(0,r.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(b.default,{as:"h1",className:"openapi__heading",children:"Get folder list"}),"\n",(0,n.jsx)(s(),{method:"get",path:"/folderlist",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId"}),"\n",(0,n.jsx)(b.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,n.jsx)(S.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,n.jsx)(p(),{...o(961)}),"\n",(0,n.jsx)(m(),{...o(34780)}),"\n",(0,n.jsx)(c(),{...o(87590)})]})}function w(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(O,{...e})}):O(e)}},961(e){e.exports=JSON.parse('{"parameters":[{"name":"parentFolderId","in":"query","description":"objectId of folder","required":false,"style":"form","explode":false,"schema":{"type":"string","format":"string","example":""}},{"name":"limit","in":"query","required":false,"style":"form","explode":true,"schema":{"maximum":500,"type":"number"},"example":10},{"name":"skip","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"number"},"example":0}]}')},34780(e){e.exports={title:"Body"}},87590(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"ph1bhx2jp"},"folderName":{"type":"string","format":"string","example":"new folder"},"parentFolderId":{"type":"string","format":"string","example":"J2nas5kiPe"},"parentFolderName":{"type":"string","format":"string","example":"new sub folder"},"createdAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"title":"folder_res"}}},"title":"inline_response_200_13"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/58abd73c.338d50e6.js b/assets/js/58abd73c.338d50e6.js deleted file mode 100644 index 2be4202b6..000000000 --- a/assets/js/58abd73c.338d50e6.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[8564],{64502(e,t,r){r.r(t),r.d(t,{assets:()=>x,contentTitle:()=>I,default:()=>P,frontMatter:()=>w,metadata:()=>s,toc:()=>j});const s=JSON.parse('{"id":"API-docs/v1.1/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/v1.1/folderlist.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/folderlist","permalink":"/docs/API-docs/v1.1/folderlist","draft":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJy9WM1uIzcSfpVaXrIR2pLsmUmwOq0RzHqdGDNG7MDAeowBu7vUzRGbZMhq/UAQkEPeIKdc99HmSRZFqqWWrUnGu9lcbHexqvhV1UdW0WtBsgpici/+YXWJXjxkosRQeOVIWSMm4rZGSGtwpQLB+fUlYOPsAn2AlW2BLHgkr3COIEGzjp3CNJksFNVg02/bEjjp0VDyd1mKTFiHXvJWl6WYiGTFPkQmnPSyQULP+NbCyAbFRDzxoBjljy36lXiM3eYfsKDLcg9IZMLjj63yWIrJVOqAmQi00hg3943IBC6dtiXul4saGykma0Erx3qBvDKVyKKBpL4El7Jx0ZnYbLIdZq0aRY+hfjYO8u0BjEYuVdM2YvJqPM46UKZtcvRi08NwOu5BCDPl/jAEn95zvHlgv8FZEzCw7tl4zL8OCxPaosAQpq2GHQFEJgprCA2xvnROqyIujD4ENlo/BZDqy1Tx7IZU2tJjaDX19KT3kgNWhE34ffuONs+tuatP83p59sFxShLf3sTsP8+NwUXH1k32mO/P9PXtmZHh1Uxd42Nf/y2y0OY9dIVHSVie0zFXe8Oz8dmLk9Pxyfjr29OvJi//Nnn11XA8Hv9LZGLZaLbd0rSUFJGSIt3/bl35J+zTE6QQ33sMYtOXK6OVwfcdxd+fjcfvT1+wziYTL49x/cY2SLUyFSzQECy8NVUGTqMMCORXICupDGhJ6P/yxx0C9N76387W85D9VhZechZ2SXj1NAmXZi61KmP3uLUzNH9upP3tKW3PUA85oZJSXBcHwfblKciAResVrWJnWp5Ip07S+uT+ga9ATqzljlZhamVUi4kYHfS3gH7eNbfWazERNZELk9EoSFPmdjm0Dk1QldEyD8PCNiPp1Gh+OjwVfLMf2kjnnqWP7clzTQLJSpnq9+we9um54RKmKh0kaX8zO/Ud8tW8rUFfa9utapTxstnw99RG421l3jo0N6oysa5x88cTwB3qwjbIQwrVCINBZ/Lx53/vrAYDKG3RNmgoMnD4zrwzb1sPccrhJiVNCVONS5VrPDoBBZSNxhD0CpQhrLwkhFJViqQGzhOfskI6mSutmLisZtnaQ4/7YQh3NVKNnpe+8DxRlThHzXwH2ZJtJLGrDi8srJ9NtV2EDCTkbVAGQwA0tTQFK3aVyHgKkwbQEHrnVUAI5Bm1StisIS8LgkYaWSH7zqCfrBK1YrqCt3kbCILVbYQMJJW2HkvoAjKIZYhJfM0ThEdgaWEb57Fm2swRqlaVGDIobIkQ4jnlEEwJOQYCx1hUgYGdtkbbYhYLOG21Bmf52lBS81zXx8jm5KUJ3MQSlq4Gu4Q5b3n0wARwMPghIFf4SplZmAwG78wJ3O94dYd5UIQPf+2OwGKxeEL9Lw9tLhT9s83he3Q2KLJ+tbeuFNVtHo9L38nuI3m6QIORP73DsPdR2iI8PX0sHdWo3egGiRkSRufXl/Gm/RI+/vQLXKH0Bmq7SGwtWo96BVW3FWcuVT6lbXdRwtRG4tWc8SKRj+dGDNRl8K6W9PGnXwO8wQUosz1SHMpgcN3mWhVwi43jNhIGgwl8E2cGoE4GVEuCQhrIEUItmUpzJUGCS9ZamdkQzs0K2tC9KZgMLI92B2FwXnblDpDLgCVYEy26PYd7RCxvAuo5BvZlLDEMLBUxo2tv2yrt1gezDc7jVGkNd6qskGJs52UJbiteJDEnvAcHp3wgqMYVSI8Q0NAQrh+ZxJXWOesZhUrgp1Zru+ACoCmdVYbCBEovp7T3n+2JHkczZc0RUUqh3KUj27rZlSSdxG3EO+nwHV/Kjy7yw/vW4xQ9bxjD3tfFqS2d7jtaArP1f6F1HD+tIVnECQIbqXTqKH9/7Cd2c/RNeDu9QT9XBW672idO9Cgqj0QmtCrQBOxNCecX11cwfzEci6zXHj/jcI+uLr95/ebmNYPhizQl7HQ4Ho7jbG4DNdL0drpA6p7R24nhINfr/fz0/36kb5s14ZJGTksVx6MY/Ho72tz3n+4PmahtIJau13z+fvB6s2FxennywFOqIHPde3t+Mrajj/ijiGa4OvYPgrnUbXqSZ0f2TUbdC/1zdLdP6b3qA394xbpx/su6mYUDTTbnRYGuv8GTgfdgarx4fSsywdfu4aw0i7PS9g/23i2ZVc/34RCVAPBPjumowXqd5rDNZqeflj5psQ2w0+b8P2w2m/8AiJlg8A==","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Folder","permalink":"/docs/API-docs/v1.1/deletefolder"},"next":{"title":"v1","permalink":"/docs/API-docs/v1"}}');var i=r(74848),o=r(28453),l=r(57742),n=r.n(l),d=r(78178),a=r.n(d),p=r(19624),m=r.n(p),c=r(96226),f=r.n(c),h=(r(77675),r(19365),r(51107)),u=r(21312);const w={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:"eJy9WM1uIzcSfpVaXrIR2pLsmUmwOq0RzHqdGDNG7MDAeowBu7vUzRGbZMhq/UAQkEPeIKdc99HmSRZFqqWWrUnGu9lcbHexqvhV1UdW0WtBsgpici/+YXWJXjxkosRQeOVIWSMm4rZGSGtwpQLB+fUlYOPsAn2AlW2BLHgkr3COIEGzjp3CNJksFNVg02/bEjjp0VDyd1mKTFiHXvJWl6WYiGTFPkQmnPSyQULP+NbCyAbFRDzxoBjljy36lXiM3eYfsKDLcg9IZMLjj63yWIrJVOqAmQi00hg3943IBC6dtiXul4saGykma0Erx3qBvDKVyKKBpL4El7Jx0ZnYbLIdZq0aRY+hfjYO8u0BjEYuVdM2YvJqPM46UKZtcvRi08NwOu5BCDPl/jAEn95zvHlgv8FZEzCw7tl4zL8OCxPaosAQpq2GHQFEJgprCA2xvnROqyIujD4ENlo/BZDqy1Tx7IZU2tJjaDX19KT3kgNWhE34ffuONs+tuatP83p59sFxShLf3sTsP8+NwUXH1k32mO/P9PXtmZHh1Uxd42Nf/y2y0OY9dIVHSVie0zFXe8Oz8dmLk9Pxyfjr29OvJi//Nnn11XA8Hv9LZGLZaLbd0rSUFJGSIt3/bl35J+zTE6QQ33sMYtOXK6OVwfcdxd+fjcfvT1+wziYTL49x/cY2SLUyFSzQECy8NVUGTqMMCORXICupDGhJ6P/yxx0C9N76387W85D9VhZechZ2SXj1NAmXZi61KmP3uLUzNH9upP3tKW3PUA85oZJSXBcHwfblKciAResVrWJnWp5Ip07S+uT+ga9ATqzljlZhamVUi4kYHfS3gH7eNbfWazERNZELk9EoSFPmdjm0Dk1QldEyD8PCNiPp1Gh+OjwVfLMf2kjnnqWP7clzTQLJSpnq9+we9um54RKmKh0kaX8zO/Ud8tW8rUFfa9utapTxstnw99RG421l3jo0N6oysa5x88cTwB3qwjbIQwrVCINBZ/Lx53/vrAYDKG3RNmgoMnD4zrwzb1sPccrhJiVNCVONS5VrPDoBBZSNxhD0CpQhrLwkhFJViqQGzhOfskI6mSutmLisZtnaQ4/7YQh3NVKNnpe+8DxRlThHzXwH2ZJtJLGrDi8srJ9NtV2EDCTkbVAGQwA0tTQFK3aVyHgKkwbQEHrnVUAI5Bm1StisIS8LgkYaWSH7zqCfrBK1YrqCt3kbCILVbYQMJJW2HkvoAjKIZYhJfM0ThEdgaWEb57Fm2swRqlaVGDIobIkQ4jnlEEwJOQYCx1hUgYGdtkbbYhYLOG21Bmf52lBS81zXx8jm5KUJ3MQSlq4Gu4Q5b3n0wARwMPghIFf4SplZmAwG78wJ3O94dYd5UIQPf+2OwGKxeEL9Lw9tLhT9s83he3Q2KLJ+tbeuFNVtHo9L38nuI3m6QIORP73DsPdR2iI8PX0sHdWo3egGiRkSRufXl/Gm/RI+/vQLXKH0Bmq7SGwtWo96BVW3FWcuVT6lbXdRwtRG4tWc8SKRj+dGDNRl8K6W9PGnXwO8wQUosz1SHMpgcN3mWhVwi43jNhIGgwl8E2cGoE4GVEuCQhrIEUItmUpzJUGCS9ZamdkQzs0K2tC9KZgMLI92B2FwXnblDpDLgCVYEy26PYd7RCxvAuo5BvZlLDEMLBUxo2tv2yrt1gezDc7jVGkNd6qskGJs52UJbiteJDEnvAcHp3wgqMYVSI8Q0NAQrh+ZxJXWOesZhUrgp1Zru+ACoCmdVYbCBEovp7T3n+2JHkczZc0RUUqh3KUj27rZlSSdxG3EO+nwHV/Kjy7yw/vW4xQ9bxjD3tfFqS2d7jtaArP1f6F1HD+tIVnECQIbqXTqKH9/7Cd2c/RNeDu9QT9XBW672idO9Cgqj0QmtCrQBOxNCecX11cwfzEci6zXHj/jcI+uLr95/ebmNYPhizQl7HQ4Ho7jbG4DNdL0drpA6p7R24nhINfr/fz0/36kb5s14ZJGTksVx6MY/Ho72tz3n+4PmahtIJau13z+fvB6s2FxennywFOqIHPde3t+Mrajj/ijiGa4OvYPgrnUbXqSZ0f2TUbdC/1zdLdP6b3qA394xbpx/su6mYUDTTbnRYGuv8GTgfdgarx4fSsywdfu4aw0i7PS9g/23i2ZVc/34RCVAPBPjumowXqd5rDNZqeflj5psQ2w0+b8P2w2m/8AiJlg8A==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},I=void 0,x={},j=[];function b(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Get folder list"}),"\n",(0,i.jsx)(n(),{method:"get",path:"/folderlist",context:"endpoint"}),"\n",(0,i.jsx)(t.p,{children:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId"}),"\n",(0,i.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,i.jsx)(u.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,i.jsx)(a(),{...r(961)}),"\n",(0,i.jsx)(m(),{...r(34780)}),"\n",(0,i.jsx)(f(),{...r(87590)})]})}function P(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(b,{...e})}):b(e)}},961(e){e.exports=JSON.parse('{"parameters":[{"name":"parentFolderId","in":"query","description":"objectId of folder","required":false,"style":"form","explode":false,"schema":{"type":"string","format":"string","example":""}},{"name":"limit","in":"query","required":false,"style":"form","explode":true,"schema":{"maximum":500,"type":"number"},"example":10},{"name":"skip","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"number"},"example":0}]}')},34780(e){e.exports={title:"Body"}},87590(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"ph1bhx2jp"},"folderName":{"type":"string","format":"string","example":"new folder"},"parentFolderId":{"type":"string","format":"string","example":"J2nas5kiPe"},"parentFolderName":{"type":"string","format":"string","example":"new sub folder"},"createdAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"title":"folder_res"}}},"title":"inline_response_200_13"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/5a144266.31c1c944.js b/assets/js/5a144266.31c1c944.js deleted file mode 100644 index 1b51378c6..000000000 --- a/assets/js/5a144266.31c1c944.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[4232],{98162(e,t,a){a.r(t),a.d(t,{assets:()=>w,contentTitle:()=>x,default:()=>v,frontMatter:()=>f,metadata:()=>i,toc:()=>b});const i=JSON.parse('{"id":"API-docs/v1.1/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/v1.1/gettemplatelist.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/gettemplatelist","permalink":"/docs/API-docs/v1.1/gettemplatelist","draft":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJzdWEtvIzcS/iu1vGQjtKW2x+PJ6hQjGDjGGhlj7cBAPIbA7i6pOWaTDMnWA0IDOew/2NNe96fNL1kU+ym/ZG+CHPZiq8n6WA9WkV9xyzxfODa9ZddYGMk9OnYXsQxdaoXxQis2Zdc5whl6aEXgQjgPp5fnwKXUKwcbXYLXYNFbgUsEDpIk9Bz4kgvJE4ng2/XHcJ0LB/NSpbQ+l8JvwFi9FBk64Ar0Eu1S4CrgpeyREaDiiRRqAaVD60hnmmvtEOZWF4Br4TzNdghY5aggtcjDeKbTskDl3ZhFTBu0nCw4z9iULdC3KLKdRcxwywv0aCk8W6Z4gWzKpCgEzQoKzK8l2g2LmMVfS2ExY9M5lw4j5vxGkvRc24JFDNdG6gzZ1NuSZtMcC86mW1bwtSjKgk3fx3HE/MYQSJVFgpZVhOOFoYUO4yrqTHD3wvxhFjyvM67uaF1ntHLoSPYojunfbnK4Mk3RuXkpoYsoi1iqlUflSZ4bI0UaJiZfHIG2jw3QyRdMQ9gtLeNFrdKiK6UfyHFrOTksPBZuP74eph3uJJ23Qi1YFELD/XCk852tD39MVOGOLhcUEy88jT5eoge48KPLPEIp7feAWmkIohWZJDO0f5ZbdT69ZGBtDwTBqg9EZ/isMZhMF/tClHtv3HQyacFUw+NUF4TWK7Xj90vBCuWsW6si5sRChSr9X5PE6n2mp6hfF7AvGiHBYBYWXMi90gni981AGwuTa7VHzfH7k6PDd999OCT5lcgW6H+H//Xs2zLJ49oneh3s5Qt8fJQM4N1If55VEVu/EXN0fFxFbPNG1AdStXoj6N13VcTyN4KOTyiPw7H4ipg/l0qvinn1ZC1e1XUwa/PhRalQzg5Vdq4+2d0zJ9FaIldD1XRrVBELlYfZqX85O4/io3cHh/FB/OH68GR6/Lfp+5NxHMe/sIitC9l7z7LmpGyNbL9Lk/0pegKdwGtdvs59i5mwmPpZaZ8s7Jf2jtQFtjQrdCbmzX3oXtYb7nICll7PLBZC7d2pFlJLz7RKcSbUDJfEE55I6MF1Xz0M2/Aye5hHu9kllBQKZy1bmB3F8eykydPj+P1j1nCullyKLJDIa32P6i9/HGdAa/Weu2So3tfqH7svaqEwz3acHY7XTjpMSyv8JlDF9QE34qCen97eEY8q0Oe64ZmBW/qcTdnkAeV0aJct3ww51t2Zjqss0euxNqjovpM8cXRfTLgRk+XhmC6ChxhuzJvksTx4K8R5vhBqsQ931wfoijax3qedMPV3lxF/R7q8ml0YSjWkN0ceSEdF33MdwM3efDKo6IQLOxuUP2xmblCmukDqHXyOMBq1kK///E+HGo26XiHk4Piz+qw+lRaMXqElrstVBnOJa0G9DcGwCHNdM+SQFxKdkxsQyuPCEnXJxEJ4LoHiRA1Jyg1PhBSUuiSmCW1hkP1uDDc5+hwtTX1jqbnKcImSMh7oYCh2extYaXs/p7YsAg5J6YRC5wBVzlVKgu1ORKAttVuoPFpjhUNw3pLVorZNK2956qHgii+Q1o5gGKwMpaB0BauT0nlwWpbBZPBcSG0xg9YhhZi5EMSP1IhYBBpNdWEs5pQ2S4RFSQ1gBKnOEGo6TS6oDBJ0HgzZIlIMXV+ppE7vwwbOSynBaDo4BJfUMw5tJLi3XDk6m2tb2j3oAmaspg4GawNHo58d0g5fCHXvpqPRZ3UAt11e3WDihMe7v7YlsFqtHqX+t7uYM+F/LBP4BxrthNd206MXwudlEspluEj3Ua90hgpD/gyKoV8j06l7XH00OslRmskVesoQNzm9PA9n7bfw9bd/wQVyqyDXqzpb09Ki3MCiVUWRq3e+Dlt3VMJch8TLKeJpnXzUfqLzbQRvcu6//vZvBz/hCoRqSopcGY0uy0SKtHtLcKPRFH4IvGLQtvuce0i5ggTB5ZxSaSk4cDA1Wgp1P4ZTtQkPAbASPg/JQOMBt+MGxaXv/SHhDjPQKiBanePeIhovHMolOlpLaU9mYCY8ZXRudbmotQ2NaZyzOBdSwk1Nwci30ywD0ww3zIwCPjAH51QQPscNcIvgUPkxXD6AhJnSGG3JClEbP9fEKGgDUGVGC+XdFDLL575fP+oTvX4H0eqJoTqEvAtH1CwzeHuhSDYe9285n+lQfnCQ7563FudoSWFwu98XI5p0um3TEihbf09a0yVNpxZPA4doGjC6Ub5/uE64z9EW7tP8il6b0rZBfaaiJ0F4wiImRYrK4YAnnJ5dXsDy3Thm0eB6fEVxTy7Of/j409VHMoYO0jpgh+N4HIe+SjtfcDXQtPMI13CGnWhvew71f/pq17AEaoUmRnIRmFnDx2tWdct2WNVdxHLtPI1vt1T6P1tZVTRcv50R18qEI2/717N73Aze+pZclg2Hf1a2eZTrRe/owwqSDSQwamkLKawxp2mKZqjgEevdoY5nH69Z6AXyXbp0H+hS84NWb6fUZrD2Lo+qDaC/5NOTgO22pmJV1cnXU88iGgdbadqbu6qq/gvXu8wK","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Template","permalink":"/docs/API-docs/v1.1/delete-template"},"next":{"title":"Get Webhook","permalink":"/docs/API-docs/v1.1/get-webhook"}}');var l=a(74848),s=a(28453),o=a(57742),p=a.n(o),n=a(78178),m=a.n(n),r=a(19624),d=a.n(r),c=a(96226),g=a.n(c),u=(a(77675),a(19365),a(51107)),h=a(21312);const f={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:"eJzdWEtvIzcS/iu1vGQjtKW2x+PJ6hQjGDjGGhlj7cBAPIbA7i6pOWaTDMnWA0IDOew/2NNe96fNL1kU+ym/ZG+CHPZiq8n6WA9WkV9xyzxfODa9ZddYGMk9OnYXsQxdaoXxQis2Zdc5whl6aEXgQjgPp5fnwKXUKwcbXYLXYNFbgUsEDpIk9Bz4kgvJE4ng2/XHcJ0LB/NSpbQ+l8JvwFi9FBk64Ar0Eu1S4CrgpeyREaDiiRRqAaVD60hnmmvtEOZWF4Br4TzNdghY5aggtcjDeKbTskDl3ZhFTBu0nCw4z9iULdC3KLKdRcxwywv0aCk8W6Z4gWzKpCgEzQoKzK8l2g2LmMVfS2ExY9M5lw4j5vxGkvRc24JFDNdG6gzZ1NuSZtMcC86mW1bwtSjKgk3fx3HE/MYQSJVFgpZVhOOFoYUO4yrqTHD3wvxhFjyvM67uaF1ntHLoSPYojunfbnK4Mk3RuXkpoYsoi1iqlUflSZ4bI0UaJiZfHIG2jw3QyRdMQ9gtLeNFrdKiK6UfyHFrOTksPBZuP74eph3uJJ23Qi1YFELD/XCk852tD39MVOGOLhcUEy88jT5eoge48KPLPEIp7feAWmkIohWZJDO0f5ZbdT69ZGBtDwTBqg9EZ/isMZhMF/tClHtv3HQyacFUw+NUF4TWK7Xj90vBCuWsW6si5sRChSr9X5PE6n2mp6hfF7AvGiHBYBYWXMi90gni981AGwuTa7VHzfH7k6PDd999OCT5lcgW6H+H//Xs2zLJ49oneh3s5Qt8fJQM4N1If55VEVu/EXN0fFxFbPNG1AdStXoj6N13VcTyN4KOTyiPw7H4ipg/l0qvinn1ZC1e1XUwa/PhRalQzg5Vdq4+2d0zJ9FaIldD1XRrVBELlYfZqX85O4/io3cHh/FB/OH68GR6/Lfp+5NxHMe/sIitC9l7z7LmpGyNbL9Lk/0pegKdwGtdvs59i5mwmPpZaZ8s7Jf2jtQFtjQrdCbmzX3oXtYb7nICll7PLBZC7d2pFlJLz7RKcSbUDJfEE55I6MF1Xz0M2/Aye5hHu9kllBQKZy1bmB3F8eykydPj+P1j1nCullyKLJDIa32P6i9/HGdAa/Weu2So3tfqH7svaqEwz3acHY7XTjpMSyv8JlDF9QE34qCen97eEY8q0Oe64ZmBW/qcTdnkAeV0aJct3ww51t2Zjqss0euxNqjovpM8cXRfTLgRk+XhmC6ChxhuzJvksTx4K8R5vhBqsQ931wfoijax3qedMPV3lxF/R7q8ml0YSjWkN0ceSEdF33MdwM3efDKo6IQLOxuUP2xmblCmukDqHXyOMBq1kK///E+HGo26XiHk4Piz+qw+lRaMXqElrstVBnOJa0G9DcGwCHNdM+SQFxKdkxsQyuPCEnXJxEJ4LoHiRA1Jyg1PhBSUuiSmCW1hkP1uDDc5+hwtTX1jqbnKcImSMh7oYCh2extYaXs/p7YsAg5J6YRC5wBVzlVKgu1ORKAttVuoPFpjhUNw3pLVorZNK2956qHgii+Q1o5gGKwMpaB0BauT0nlwWpbBZPBcSG0xg9YhhZi5EMSP1IhYBBpNdWEs5pQ2S4RFSQ1gBKnOEGo6TS6oDBJ0HgzZIlIMXV+ppE7vwwbOSynBaDo4BJfUMw5tJLi3XDk6m2tb2j3oAmaspg4GawNHo58d0g5fCHXvpqPRZ3UAt11e3WDihMe7v7YlsFqtHqX+t7uYM+F/LBP4BxrthNd206MXwudlEspluEj3Ua90hgpD/gyKoV8j06l7XH00OslRmskVesoQNzm9PA9n7bfw9bd/wQVyqyDXqzpb09Ki3MCiVUWRq3e+Dlt3VMJch8TLKeJpnXzUfqLzbQRvcu6//vZvBz/hCoRqSopcGY0uy0SKtHtLcKPRFH4IvGLQtvuce0i5ggTB5ZxSaSk4cDA1Wgp1P4ZTtQkPAbASPg/JQOMBt+MGxaXv/SHhDjPQKiBanePeIhovHMolOlpLaU9mYCY8ZXRudbmotQ2NaZyzOBdSwk1Nwci30ywD0ww3zIwCPjAH51QQPscNcIvgUPkxXD6AhJnSGG3JClEbP9fEKGgDUGVGC+XdFDLL575fP+oTvX4H0eqJoTqEvAtH1CwzeHuhSDYe9285n+lQfnCQ7563FudoSWFwu98XI5p0um3TEihbf09a0yVNpxZPA4doGjC6Ub5/uE64z9EW7tP8il6b0rZBfaaiJ0F4wiImRYrK4YAnnJ5dXsDy3Thm0eB6fEVxTy7Of/j409VHMoYO0jpgh+N4HIe+SjtfcDXQtPMI13CGnWhvew71f/pq17AEaoUmRnIRmFnDx2tWdct2WNVdxHLtPI1vt1T6P1tZVTRcv50R18qEI2/717N73Aze+pZclg2Hf1a2eZTrRe/owwqSDSQwamkLKawxp2mKZqjgEevdoY5nH69Z6AXyXbp0H+hS84NWb6fUZrD2Lo+qDaC/5NOTgO22pmJV1cnXU88iGgdbadqbu6qq/gvXu8wK",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},x=void 0,w={},b=[];function y(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Get Template list"}),"\n",(0,l.jsx)(p(),{method:"get",path:"/templatelist",context:"endpoint"}),"\n",(0,l.jsx)(t.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,l.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,l.jsx)(h.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,l.jsx)(m(),{...a(68824)}),"\n",(0,l.jsx)(d(),{...a(98874)}),"\n",(0,l.jsx)(g(),{...a(16976)})]})}function v(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,l.jsx)(t,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}},68824(e){e.exports=JSON.parse('{"parameters":[{"name":"limit","in":"query","required":false,"style":"form","explode":true,"schema":{"maximum":500,"type":"number"},"example":10},{"name":"skip","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"number"},"example":0}]}')},98874(e){e.exports={title:"Body"}},16976(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"x1Hbnms2Pg"},"title":{"type":"string","example":"sample template"},"note":{"type":"string","example":"template note"},"folder":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"x1Hbnms2Pg"},"name":{"type":"string","example":"folder name"}},"title":"template_folder"},"file":{"type":"string","example":"https://templateuser.com"},"owner":{"type":"string","example":"template creator name"},"signers":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","example":"ceo"},"name":{"type":"string","example":"joe bee"},"email":{"type":"string","example":"joebee@example.com"},"phone":{"type":"string","example":"456213871"},"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","format":"string","example":"textbox"},"page":{"type":"number","format":"number","example":1},"x":{"type":"number","format":"number","example":244},"y":{"type":"number","format":"number","example":71},"w":{"type":"number","format":"number","example":38},"h":{"type":"number","format":"number","example":46},"options":{"type":"object","properties":{"name":{"type":"string","format":"string","example":"textbox"}}}},"title":"template_Signers_widgets"}}},"title":"template_Signers"}},"sendInOrder":{"type":"boolean","example":true},"createdAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"enableTour":{"type":"boolean","example":true},"redirect_url":{"type":"string","format":"string","example":""},"allow_modifications":{"type":"boolean","example":false},"auto_reminder":{"type":"boolean","example":false},"remind_once_in_every":{"type":"number","example":0}},"xml":{"name":"template"},"title":"template"}}},"title":"inline_response_200_6"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/5a144266.dba89d23.js b/assets/js/5a144266.dba89d23.js new file mode 100644 index 000000000..ed7d7a537 --- /dev/null +++ b/assets/js/5a144266.dba89d23.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[4232],{98162(e,t,a){a.r(t),a.d(t,{assets:()=>D,contentTitle:()=>y,default:()=>x,frontMatter:()=>h,metadata:()=>o,toc:()=>j});const o=JSON.parse('{"id":"API-docs/v1.1/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/v1.1/gettemplatelist.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/gettemplatelist","permalink":"/docs/API-docs/v1.1/gettemplatelist","draft":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJzdGu1uG7nxVaYboIiF1Yedj7vqiuv5HF9iNL0Ykd2gtQ2LuzvS8sQl90iuZNUWcD+KPkDRP/3bl+j/PkqepBiSuyvZjpX7QK9tgMQxOTMczvcM9zqybGqi4Vl0gkUpmEUTXcRRhibVvLRcyWgYneQIL9FCDQKvubGwf3wETAi1MLBUFVgFGq3mOEdgIAhCTYDNGRcsEQi2pt+Dk5wbmFQyJfpMcLuEUqs5z9AAk6DmqOccFw5fiBYzBpQsEVxOoTKoDZ2Z5koZhIlWBeAVN5Z2GwxY5Cgh1cjceqbSqkBpTS+KI1WiZsTBURYNoynaGot4j+KoZJoVaFGTeK4jyQqMhpHgBaddToL5tkK9jOJI47cV15hFwwkTBuPI2KUg6InSRRRHeFUKlWE0tLqi3TTHgkXD66hgV7yoimj4bDCII7ssCUlWRYI6WhEeK0oitDtYxQ0LZsbLn4yDD585WF0QXVMqadAQ7N5gQD82jcNUaYrGTCoBjUSjOEqVtCgtwbOyFDx1G/1vDCFd32VAJd9g6sSuiYzl/kiNphJ2DY5pzejC3GJhtuP7ZdJwA2ms5nIaxU40zK6vNHePrnZfJbIwe8dTkonlllbvkmgRjPtPY3mEJZXdglRDgwNdxdGEbzsnt7Y0w36/RiVH6KWqIGy1kKg/8kTnE0qDs6lVHBk+lc7Uf6iktdrGeorKicVZ8UOA3yiEBB1bWDAutkIniF+EhVoWZa7klmOePnu+t/vk0092o9VqRSJAmR3JNzrbEGKilEAm1zHJhwL8JZeXijAu6YDUPozofHMVRy5sXqrJRHCJlyT6e/E2He1djjZHDUFTkDIJpkoKboFBqsolxUtLobVRsgPNoDIU/JgEvLKoJRNglRIwURqcyYBGirc9eIETVgnrAqvjtXcf9850MNu3D4t3b7D3pLs76A4+Odl9Pnz6q+Gz573BYPDHKI6uCqfTEM+y4C/By5rfqzL7j5zjkgqeqOrj1K4x4xpTe1npey3zobASNcovVMYnISqaj7SayqpLjQWXWy20RvHQl0qmSJaKc8oWd6L+RtAnv8YJF+I+l9+0yD+oyllhSN6w4NkULSVdnuZuB4sEM0hwojQC+YvLzirY8J0YEgj88CDkd7+fTixe2URduaDBpnifeO6WQwQJfh+UDDe2eS0DMLmqRAasLJHpHpUroCoNZ53OC0yqKZwedToXj+tgzsqyp0qUJBbBEkNBrJ8RYJlNdlyZw0RaOZ+mQ+ZMVM43m3vd1eTuKo6utl/mClLVVTrjkog/FjixUJUlakiVlqh3fGnlL/jfc7kBGeq9prx5veX/5PWe0O0W22/3jmc2p7DvOf9ZeH1KvObbeX2FfJrbn5nZT4lZVd4Ouh+IJtsrlbXYUVfKW4sVAk6VUFsqNSrmqSJU0hr+p3vDUusOeyv/p01udRCntc00uF6i1tDt2joNLl19Ut/scm8wuHweiqWng2d3e4EjOWeCZ641PFEzlL/46ToB1HqbyNaPt/74u9fnHsjtRxuXXV+vK8K00twuXQN41WUl7/r94dkFdUcF2lyF7tF1jDaPhlH/ViNpUM/rLtLVDE0Rb5jMEnV118xZyfvz3d5eRG3fJs69bvEAPFbd74tiLJtyOd2Gd9EKaERK9HraEFObx0v+W6REHrSwDhVa2RwZ1TUkdy4nyiEH3bwpUY74VDrNusNvR5dHUMO8//M/GrBzeS4/h06HMjZdpGtUpVOEFyqtHD0mXEFs+Rzh/Xd/g6TiwrrCOMM5CrI/E4PVlbFUxywBpUVdam7Q9Dodor9+7pTP0U9DqCInq7QYU3mUVW7W0dXIsiVglyTKbKURyFAoYIHNtaqmOTCgal1gDG8PRyfUVu8fH/VghDJr5xeOxYZIDAWTVJCsTUqsZunMgVDJZSyzlQEuQSOV/7zAGJjMgGrKgiLokiIxSss1NseA4BNMl6nwwqFZzILbXFUW5igzpUGodNblskeC6Ha79OPRI5oVuXHLyDJtMaPVQ6o8gaYUaCwUlbGQMq2X/tzGYYlDiuXjNfsYg7cMd8h4PD6Xa5tD+DVRaBc+DzDnstN5/5e/wtkrtaBcMUVJwwm8dWCbbjKVmnvyjUpNP0dR9kf+Uqa/f3zkYtuO1//XyoIhTS5y1EhHJTjl8jdwanxe6nSCmwPKOddKkmg7HXg8/ugwMHbprtTKKvKnRgtsMsHUiVqQBWfMsluqOKDC+4CVLOGCUyil9Rs4YBanSi/hBt7lzDqTpXo9U3BzLm+63a77S6Cdzova6joduIED1/3FrpqPwfdoMXWQahZsKkOy+9Y8u7XaW/MNlJuZo6P8ZcVFBhorszkwdNeFUmO3FCzFrO4zPnM8kGSURFCavGDZtMfhiBGKSZf80x3xsrYCQ8uhPW7ZauQaqACXc25dvoKJUIua6HGVCJ7CJvujnGkafZZ+s3Y9weXMuY+s2x4/HK0ndjXNF5pNLLxTekYneYpsjmvcKb0mE2YgIwzjRD7hNEf1BlcAQeia7oGSlqVBeb/zccL5QGAm9fuQKDUjE5tqVhTM8pQJsayJfKVEhtrTeKOnTNJZLWdcGur/mjD9QpM5TjxSTeMdJrlSM0/kLaZIMBSOuhSOAOcUcaSybVsM3jLdlAJQZqXi0tbkTk3N0Ntm7JymqpLWSSSlNt0CZRKqBkmDN5uuQYb//ru/G/gaFxR36oRBm49g31qW5i4KvvNtwagqS6XtuaRsMmbNvhnXjQM3INUCjAfEjDpDp6RGVLGfu+HaggeoFdsAtAt0m2BTzWBn//jI9GpWX5HsR16bo2B1r7mcmXM5Qgvj8yjnmR8z0ZzKQ1wKBxENKbsh3Ph5z5hYHh+/GZ1A3zFW8zkmNyMytdmsm7epw/bmZaEuHHutWA9oUoG6fUoIymPiXI5fHp5AUzz1hzwbu8tvrpPzjCEn10gQJRirkRVUqGbOzTRmlcyYtNAO8IE8U2Oh5pg5kp1OqI9dzKwVp9FWmugYJFyLYunbw3DnlmCnQzl3RgJoJuSAzHDUrjFR0lQFNho6ZsYslM66x1pZTMk0jl981VoU7ZOeaPx7WQbg82hcy7UOoInKlv5JY6G0O92FRpSpXpaBqunVdJ0BDs9l0Kc3rFqMY/jXP2F8fHpH4m55DaHWZn9Yw11ugt2yk1sbt85zGxR8SaTjWj5v/CS0sV6KWVqJxn7vzksfMtzbF3U2dM9NrQJ6FuEpt2Lpn5ZcGsm4T0DhvMbUqeZCRnOeQKbRb3C+t0pQgnXxIaShMfh2xtkXS1MsKWLTnYI70ticND3hSDOHVCtjXKXlH62UBK2q8GqmEYHgvT03YWboczqdTlkUczbnFDVvZ/LA0xg6jzM/6N1xOcEVY6FapZArkNHjnVxL4XWE83RoWEx0mjBuvPfXfk+C8iNlUFIs6+xXjwedNuvEN2YljQ89uQMmvWdTIq/B8YqkFnKy5ybkTnfYTRNamE6UhAOahD8+ONgh5njJKUKfy32QuCCxp2kr7Tvxmgklpy6V0X2a58TxeZSs41FYb+J3G6h99CNra6qLRot9Xyg1yjykdw1gWabRUOygqIYZ+XvDow4pklGlnCjZdTP+9QQJ7nUEaLq7qQBuGoVmPXjNZ9jeISb2N7iBx6ZKc6oovJe0Hs+z8U6Y7gY5eNZIX9o919KxTVZyE5jYZXIfpUiygpNg3cMuFqVdghvpwuPx2cV45zNQ9H5BVLxorQIuc9RhcZP0rdp2v3lbPmwL61Dgrq2QTzCDcPr29T3F7cjX3q6Q+B4FeVMJNr3dJoUHW+cG+/AU3uL0DvK2ln18u5T5PWrDlQtSv4QvWTpbMJ0ZOFBFySx3pf+SQAkZ3Ns71XZJDdhNA6DwrQXMd50Zz3d7u03nV9dfxqdEm9Oz+9wf7ANS+9avpH+ISmq5O6pSQaLRZ800Z3JKjkDF11qi5hT4syr1vuD4JdJ+ZMcEVFKgMaDoJWxBRSi9nGa3DOPUIPXNoQY6l104a0rTd5gYbrHt+xaLxR1J7zicryohoG5+nMNt6RY92ktuX1UJvMVSGW6VXrZYU27zKnG6XMdtfgkE6ialGaP9mC7VkTxBXRiavY7o04p0y/X7lsD7O+c0m7k1z9kcu2icoKa4YzZ6bFby0M+f1XwAsfdj7uHHpq5XceNA/zBMg6UvbtNxYz26wptJuG8Ybj183yiOBE8xzHDDoGr/5fFrmD/pDaJ4bUr2Ebrsvz46OPx6dEjMBDeJhtFub9AbuKcmZWzB5NpJG1/YhNHhhrSv21Hq/+knOWFYSFP1fikYdwPa8Mzqh6tn0cZw9SKOcmUsrV9fU7Q51WK1omX/YQyNXEM5134aM8Pl2oc8LrP4p9kPwoYvblrQC/pFc4J1s+C4nl7SgR5n3xV7a1h3ht8bE+SXhyeRe+LNN6emMzc1Df8h6vWWXK7R3hynegboX7rTvQjX134iu1o18H7rgxjhgjU06eZitVr9G4cDdiY=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Template","permalink":"/docs/API-docs/v1.1/delete-template"},"next":{"title":"Get Webhook","permalink":"/docs/API-docs/v1.1/get-webhook"}}');var l=a(74848),s=a(28453),p=a(57742),i=a.n(p),n=a(78178),r=a.n(n),m=a(19624),d=a.n(m),u=a(96226),c=a.n(u),g=(a(77675),a(19365),a(51107)),b=a(21312);const h={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:"eJzdGu1uG7nxVaYboIiF1Yedj7vqiuv5HF9iNL0Ykd2gtQ2LuzvS8sQl90iuZNUWcD+KPkDRP/3bl+j/PkqepBiSuyvZjpX7QK9tgMQxOTMczvcM9zqybGqi4Vl0gkUpmEUTXcRRhibVvLRcyWgYneQIL9FCDQKvubGwf3wETAi1MLBUFVgFGq3mOEdgIAhCTYDNGRcsEQi2pt+Dk5wbmFQyJfpMcLuEUqs5z9AAk6DmqOccFw5fiBYzBpQsEVxOoTKoDZ2Z5koZhIlWBeAVN5Z2GwxY5Cgh1cjceqbSqkBpTS+KI1WiZsTBURYNoynaGot4j+KoZJoVaFGTeK4jyQqMhpHgBaddToL5tkK9jOJI47cV15hFwwkTBuPI2KUg6InSRRRHeFUKlWE0tLqi3TTHgkXD66hgV7yoimj4bDCII7ssCUlWRYI6WhEeK0oitDtYxQ0LZsbLn4yDD585WF0QXVMqadAQ7N5gQD82jcNUaYrGTCoBjUSjOEqVtCgtwbOyFDx1G/1vDCFd32VAJd9g6sSuiYzl/kiNphJ2DY5pzejC3GJhtuP7ZdJwA2ms5nIaxU40zK6vNHePrnZfJbIwe8dTkonlllbvkmgRjPtPY3mEJZXdglRDgwNdxdGEbzsnt7Y0w36/RiVH6KWqIGy1kKg/8kTnE0qDs6lVHBk+lc7Uf6iktdrGeorKicVZ8UOA3yiEBB1bWDAutkIniF+EhVoWZa7klmOePnu+t/vk0092o9VqRSJAmR3JNzrbEGKilEAm1zHJhwL8JZeXijAu6YDUPozofHMVRy5sXqrJRHCJlyT6e/E2He1djjZHDUFTkDIJpkoKboFBqsolxUtLobVRsgPNoDIU/JgEvLKoJRNglRIwURqcyYBGirc9eIETVgnrAqvjtXcf9850MNu3D4t3b7D3pLs76A4+Odl9Pnz6q+Gz573BYPDHKI6uCqfTEM+y4C/By5rfqzL7j5zjkgqeqOrj1K4x4xpTe1npey3zobASNcovVMYnISqaj7SayqpLjQWXWy20RvHQl0qmSJaKc8oWd6L+RtAnv8YJF+I+l9+0yD+oyllhSN6w4NkULSVdnuZuB4sEM0hwojQC+YvLzirY8J0YEgj88CDkd7+fTixe2URduaDBpnifeO6WQwQJfh+UDDe2eS0DMLmqRAasLJHpHpUroCoNZ53OC0yqKZwedToXj+tgzsqyp0qUJBbBEkNBrJ8RYJlNdlyZw0RaOZ+mQ+ZMVM43m3vd1eTuKo6utl/mClLVVTrjkog/FjixUJUlakiVlqh3fGnlL/jfc7kBGeq9prx5veX/5PWe0O0W22/3jmc2p7DvOf9ZeH1KvObbeX2FfJrbn5nZT4lZVd4Ouh+IJtsrlbXYUVfKW4sVAk6VUFsqNSrmqSJU0hr+p3vDUusOeyv/p01udRCntc00uF6i1tDt2joNLl19Ut/scm8wuHweiqWng2d3e4EjOWeCZ641PFEzlL/46ToB1HqbyNaPt/74u9fnHsjtRxuXXV+vK8K00twuXQN41WUl7/r94dkFdUcF2lyF7tF1jDaPhlH/ViNpUM/rLtLVDE0Rb5jMEnV118xZyfvz3d5eRG3fJs69bvEAPFbd74tiLJtyOd2Gd9EKaERK9HraEFObx0v+W6REHrSwDhVa2RwZ1TUkdy4nyiEH3bwpUY74VDrNusNvR5dHUMO8//M/GrBzeS4/h06HMjZdpGtUpVOEFyqtHD0mXEFs+Rzh/Xd/g6TiwrrCOMM5CrI/E4PVlbFUxywBpUVdam7Q9Dodor9+7pTP0U9DqCInq7QYU3mUVW7W0dXIsiVglyTKbKURyFAoYIHNtaqmOTCgal1gDG8PRyfUVu8fH/VghDJr5xeOxYZIDAWTVJCsTUqsZunMgVDJZSyzlQEuQSOV/7zAGJjMgGrKgiLokiIxSss1NseA4BNMl6nwwqFZzILbXFUW5igzpUGodNblskeC6Ha79OPRI5oVuXHLyDJtMaPVQ6o8gaYUaCwUlbGQMq2X/tzGYYlDiuXjNfsYg7cMd8h4PD6Xa5tD+DVRaBc+DzDnstN5/5e/wtkrtaBcMUVJwwm8dWCbbjKVmnvyjUpNP0dR9kf+Uqa/f3zkYtuO1//XyoIhTS5y1EhHJTjl8jdwanxe6nSCmwPKOddKkmg7HXg8/ugwMHbprtTKKvKnRgtsMsHUiVqQBWfMsluqOKDC+4CVLOGCUyil9Rs4YBanSi/hBt7lzDqTpXo9U3BzLm+63a77S6Cdzova6joduIED1/3FrpqPwfdoMXWQahZsKkOy+9Y8u7XaW/MNlJuZo6P8ZcVFBhorszkwdNeFUmO3FCzFrO4zPnM8kGSURFCavGDZtMfhiBGKSZf80x3xsrYCQ8uhPW7ZauQaqACXc25dvoKJUIua6HGVCJ7CJvujnGkafZZ+s3Y9weXMuY+s2x4/HK0ndjXNF5pNLLxTekYneYpsjmvcKb0mE2YgIwzjRD7hNEf1BlcAQeia7oGSlqVBeb/zccL5QGAm9fuQKDUjE5tqVhTM8pQJsayJfKVEhtrTeKOnTNJZLWdcGur/mjD9QpM5TjxSTeMdJrlSM0/kLaZIMBSOuhSOAOcUcaSybVsM3jLdlAJQZqXi0tbkTk3N0Ntm7JymqpLWSSSlNt0CZRKqBkmDN5uuQYb//ru/G/gaFxR36oRBm49g31qW5i4KvvNtwagqS6XtuaRsMmbNvhnXjQM3INUCjAfEjDpDp6RGVLGfu+HaggeoFdsAtAt0m2BTzWBn//jI9GpWX5HsR16bo2B1r7mcmXM5Qgvj8yjnmR8z0ZzKQ1wKBxENKbsh3Ph5z5hYHh+/GZ1A3zFW8zkmNyMytdmsm7epw/bmZaEuHHutWA9oUoG6fUoIymPiXI5fHp5AUzz1hzwbu8tvrpPzjCEn10gQJRirkRVUqGbOzTRmlcyYtNAO8IE8U2Oh5pg5kp1OqI9dzKwVp9FWmugYJFyLYunbw3DnlmCnQzl3RgJoJuSAzHDUrjFR0lQFNho6ZsYslM66x1pZTMk0jl981VoU7ZOeaPx7WQbg82hcy7UOoInKlv5JY6G0O92FRpSpXpaBqunVdJ0BDs9l0Kc3rFqMY/jXP2F8fHpH4m55DaHWZn9Yw11ugt2yk1sbt85zGxR8SaTjWj5v/CS0sV6KWVqJxn7vzksfMtzbF3U2dM9NrQJ6FuEpt2Lpn5ZcGsm4T0DhvMbUqeZCRnOeQKbRb3C+t0pQgnXxIaShMfh2xtkXS1MsKWLTnYI70ticND3hSDOHVCtjXKXlH62UBK2q8GqmEYHgvT03YWboczqdTlkUczbnFDVvZ/LA0xg6jzM/6N1xOcEVY6FapZArkNHjnVxL4XWE83RoWEx0mjBuvPfXfk+C8iNlUFIs6+xXjwedNuvEN2YljQ89uQMmvWdTIq/B8YqkFnKy5ybkTnfYTRNamE6UhAOahD8+ONgh5njJKUKfy32QuCCxp2kr7Tvxmgklpy6V0X2a58TxeZSs41FYb+J3G6h99CNra6qLRot9Xyg1yjykdw1gWabRUOygqIYZ+XvDow4pklGlnCjZdTP+9QQJ7nUEaLq7qQBuGoVmPXjNZ9jeISb2N7iBx6ZKc6oovJe0Hs+z8U6Y7gY5eNZIX9o919KxTVZyE5jYZXIfpUiygpNg3cMuFqVdghvpwuPx2cV45zNQ9H5BVLxorQIuc9RhcZP0rdp2v3lbPmwL61Dgrq2QTzCDcPr29T3F7cjX3q6Q+B4FeVMJNr3dJoUHW+cG+/AU3uL0DvK2ln18u5T5PWrDlQtSv4QvWTpbMJ0ZOFBFySx3pf+SQAkZ3Ns71XZJDdhNA6DwrQXMd50Zz3d7u03nV9dfxqdEm9Oz+9wf7ANS+9avpH+ISmq5O6pSQaLRZ800Z3JKjkDF11qi5hT4syr1vuD4JdJ+ZMcEVFKgMaDoJWxBRSi9nGa3DOPUIPXNoQY6l104a0rTd5gYbrHt+xaLxR1J7zicryohoG5+nMNt6RY92ktuX1UJvMVSGW6VXrZYU27zKnG6XMdtfgkE6ialGaP9mC7VkTxBXRiavY7o04p0y/X7lsD7O+c0m7k1z9kcu2icoKa4YzZ6bFby0M+f1XwAsfdj7uHHpq5XceNA/zBMg6UvbtNxYz26wptJuG8Ybj183yiOBE8xzHDDoGr/5fFrmD/pDaJ4bUr2Ebrsvz46OPx6dEjMBDeJhtFub9AbuKcmZWzB5NpJG1/YhNHhhrSv21Hq/+knOWFYSFP1fikYdwPa8Mzqh6tn0cZw9SKOcmUsrV9fU7Q51WK1omX/YQyNXEM5134aM8Pl2oc8LrP4p9kPwoYvblrQC/pFc4J1s+C4nl7SgR5n3xV7a1h3ht8bE+SXhyeRe+LNN6emMzc1Df8h6vWWXK7R3hynegboX7rTvQjX134iu1o18H7rgxjhgjU06eZitVr9G4cDdiY=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-2",custom_edit_url:null},y=void 0,D={},j=[];function U(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(g.default,{as:"h1",className:"openapi__heading",children:"Get Template list"}),"\n",(0,l.jsx)(i(),{method:"get",path:"/templatelist",context:"endpoint"}),"\n",(0,l.jsx)(t.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,l.jsx)(g.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,l.jsx)(b.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,l.jsx)(r(),{...a(68824)}),"\n",(0,l.jsx)(d(),{...a(98874)}),"\n",(0,l.jsx)(c(),{...a(16976)})]})}function x(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,l.jsx)(t,{...e,children:(0,l.jsx)(U,{...e})}):U(e)}},68824(e){e.exports=JSON.parse('{"parameters":[{"name":"limit","in":"query","required":false,"style":"form","explode":true,"schema":{"maximum":500,"type":"number"},"example":10},{"name":"skip","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"number"},"example":0}]}')},98874(e){e.exports={title:"Body"}},16976(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"x1Hbnms2Pg"},"title":{"type":"string","example":"sample template"},"note":{"type":"string","example":"template note"},"file":{"type":"string","example":"https://templateuser.com"},"owner":{"type":"string","example":"template creator name"},"signers":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","example":"ceo"},"name":{"type":"string","example":"joe bee"},"email":{"type":"string","example":"joebee@example.com"},"phone":{"type":"string","example":"456213871"}}}},"sendInOrder":{"type":"boolean","example":true},"send_in_order_strict":{"type":"boolean","example":false},"allow_offline_sign":{"type":"boolean","description":"Whether signers can submit a copy of this template signed using an external tool for owner review. Defaults to false.","example":false},"createdAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"enableTour":{"type":"boolean","example":true},"redirect_url":{"type":"string","format":"string","example":""},"allow_modifications":{"type":"boolean","example":false},"auto_reminder":{"type":"boolean","example":false},"remind_once_in_every":{"type":"number","example":0},"prefill":{"type":"object","description":"You can provide widgets which can embed before sending to signer","properties":{"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","format":"string","example":"textbox"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":100},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":30},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":40},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":80},"options":{"type":"object","properties":{"name":{"type":"string","example":"textbox"},"response":{"type":"string","example":"joe"},"color":{"type":"string","example":"red"},"fontsize":{"type":"number","example":12}}}}}}},"title":"prefill"}},"xml":{"name":"template"},"title":"template"}}},"title":"inline_response_200_6"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/5ce6d213.2c09e8ba.js b/assets/js/5ce6d213.2c09e8ba.js deleted file mode 100644 index 218287406..000000000 --- a/assets/js/5ce6d213.2c09e8ba.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[3460],{32779(e,t,i){i.r(t),i.d(t,{assets:()=>y,contentTitle:()=>b,default:()=>x,frontMatter:()=>f,metadata:()=>a,toc:()=>T});const a=JSON.parse('{"id":"API-docs/v1.1/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/v1.1/update-template.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/update-template","permalink":"/docs/API-docs/v1.1/update-template","draft":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJzFWc2OG7kRfpUKL7aFHkn+XUSnnXgd21jDFjwzMJLxQGA3S2rusEkuyZZGGAjYQ94gp1zzaH6SoMjuVuvHY3vXSS67HnZVsf75VemWBb7wbHLJzrGyigf07CpjAn3hpA3SaDZh5yXChRU8ILRUcDp9Dah5rtDD2tQQDFRGyPkauBZQJ+pQIggMXCoPZg4cvMVCzmUBoZEzZBkzFh2nq14LNmGJtb2HZcxyxysM6EjNW6Z5hWzCWgEzKVjGJKlpeSjZvu6vf6KbSZGWA0LJA2hE4UnrHBttSY7DX2vpULBJcDVmzIe1otu8rKwiZfDGKiOQTeZceSIoSqw4m9yysLaRMjipFyxjc+MqHrYnm81Vko8+/MWINfHsqjp1ZikFQo7KrKAzm5Rs/dnGCO7zAAq5D2A09mhbAx6wjBVGB9SBLuLWKllEJ49+8XTb7aHqJv8Fi0AedxSSINHT1+TwLxtIzuHRTRPm4z86fdkmY9qEbxYzJRMRHC4lrmJiebnQEErpQZiirsi8zV7Iv+2KLiv6MjbEowQ6yshDeVtuokxV8O582iPNjVHI9UE2UlbBSTLAxENYSaWaSoJ351NYoqMKibEawoVH5xONwwLlEoHvkEBhBMJScsCKS5XBqpRFSQm/hqr2AVA3OdS4DjvPDSEmMZzAoUJC+qMaZcCVMiupF1BH1Y4JBiEdFkGtYSVDaeoAXAhJ7FyBD2j9sO/FqEXnyHNTuz/uSQ6LWgoUEEztYG5c1BKdz8DGMiMLpPbB1QUxexA1RTfaQaT0b+tMgd5v/dR6hYh68jNA7RM7hzn3AV0GtZbkeVfbgKITiTcWnURd4FEXROfOYiNtHO6/3hdTdJUMvrWUQsOFAFRIQfHg66IEnr7zUDv0GUgtg+TKZ+ADr6zPwDgIeEN9BYKx1DzxRvpAyq+kWGDwID+XR++RaqTo6TB3porRJ9/odT8ROr2C2RN3TkGVvnk+5rxWAZZc1cd9NpfqaGPZ9dHfTA0VXzfRTyHMucdnTwA11ZCA6U9/BRJGCjm0iheJrLPfaOx3k8R+0A8cpvSf1U59Wa+z9CJisvbi/RtYleiwy0N0Ka9zaoNJMNL7Giufbg1t1nbVt5++BxryOpiZw0pqgV9Ta2cYYpAozYLpSqwOpuJBFtCK8kNoSFNCBNOvmArut8HMseRLadyDowFN4mZGFziTeoZLdOuelrqucnQHSr6Nx5Svgq895BhWiLqvW5tWRqs1NC8i6bYqUcOOT4jKb43e0fJpesvkfD0zeratpaN+3LVtX+XBgKQPBnAC5/0AFg55MG6v7evU4SFe3nZ/0p0cRNgqZQv9z+8W1Ef9UQ8GUYUvXKZN+F4XvjUBJ/AeF9wJhd4nGJYcSzmbAe8y2LRX0XuxTX2x1ZLe/h51QfAk6oTAQ+BFiYKCJtCiFtS77nnUYhal3tvio+HH+Lhb1LPCKOP6UePO8TVhyYCVPyzcTS+alyxXNUa8SKgxV7y4ZlebjOVF8Xsl0nP6Y/P3sDAVy+LRo52zA2ieFwXcz5Uk93CXx65g1w8mDXDgghpbbCh7GGInqMn5VHC7nUT61ukoous2GQsy7ACnWQ+Jz3ICtpvNJlaxt0b7VBiPxuNDvNvNEg3+pgeKGta8Vmr9p+8HYNPxl6Ac9+LRKz998spSYBqVTsPdTI/Gjx6fPByfjH84f/hs8uTPk6fPhuPx+O8sYzeV2qJnJhoU3Hov/d07kFpJjbPWa7NH4/HscePKJ8e812Dj9j1bciUFzCUqAXSn/44OROeM+53Y/Q797jKfTG6Nf3JH6lDDmptai/+3ucc0utvAJ7MfOhOfHpr4WieX0aB9bq5R/y8s3NrTvz6k60nV3ayWiSh+ZzvG9s+TkR6L2smwjkP8zQm38iR9n1xe0WhcYSgNLQBsHRWmYX7CRm13Gd32+syGkTy3bHcCEWmxMgTrJ6OR51rk5mZoLGp6RxTPPXXPEbdytHw4fMg22T4Pt/ab6LE++VYWH/hC6sWX+K62rjqjcKaI7Ths+8BY+TPSC9PEo0/VLEVK5ATyKAKUJe+3C4gXbay7cO5P7e3Q/nVz+MFUcmyy7g/WjO0Mzw1E6k+BzdHRqaj5ltA/Y/u4m072cG7DcRxePv0cqmu4+pDh+PPfvP5f+5JvKEBzE6PZlM07i/qMHEtFF7Nh36cfUBWmwnZkGgxalk//+HfHNRh0QUlbBIJj72oH1qzQzWsVIzhXeCMJ/sZNXhW/das8j7wi0KbWQFPswsU4yoUMNME380XBLc+lktRViMwQt4NeY/JD+FBiKNHRp3uOgIfAJSpqRt0AoRdbxLEy7nquzMoTPMxrLzVBR9Ql1wURtqUR51RCqDRjWyc9gg+OtJZJN6OD40WAimu+iINmBn1nCVSS+gc4k9OaxBtVp0UArSuNi6N9MiiuCqMTX9D2zyHQKQEjhyXV8bLZBvgsbWNSHZEJWkCOPoAlXWSBcdittTLFdQwgQR2whnq65Iogcl9HYg+Oa08PT9KljUHnsGbIQ9+g/AuPFOE3Ul/7yWDwUZ/AZZdXHzD3MuDV/bYnrVarg170YJfnpQyv6hzeozVeBuPWW+6FDGWdx/7VF9L9kSS9RI0xf3rdaStDmMIftkM6HZWo7OgsTQt+dDp9HZ/BB/Dpt3/CG+ROQ2lWKVuL2qFaw6K9ijyXIp/c1r1icRXE61CSx4uUfM1StvXgh5KHT7/9y8NbXNGqI5UUmTIYTOtcyaLbgvvBYALPaYDq72bjfrngmmZ2X3JKJdrPcbCJW0l9PYRTvY4rtO3MQ+eRb8eM2GnbcPu4s4gDTn+lPdxqFCdtj2qJnmQRGskRUEgC2KF0pl6k2/rKNMY5nNOQ8CGteci2UyHANsft9oem+q06ODdpW7EG7hB8XOBM91jil9pa40iLZn00N+0mEbWwRurgJyAcn4et/GxvTo0byIOj5ELeuSNrxHQhSZXYWNyd0kST7b+su/3W4RwdXRjN3sbFyiadLtu0BMrWP5LWhJ+oa/Eiwrs4kqUn/sd9ORFqoav8u/kZuqUssIEZn6noUSQesYwpWaD2/Tf/9OX0DSwfD8f0SnV45SuKe/Tm9fMXb89ekDLUSJPDHg7Hw3EcsY0PFde9m/Z+Qdp/22634Pa//YNTg55ozTmyisuIXZttXcKdl6wHgib935quMlYaH4jk9paK8cKpzYaOf60jkLi8ytiSO0maRnDarMDE8SVQ3+z779tfb+DbfrY6alCLETUBxLg+TajoGtd7v59tCIw0QJE0ThTPk14n5yRnK+Fg7iCkmzhOiwJtuJO2D/SnF+eEnprfwqr4sxpzfEXAiq+Ssmm1HyFwPLtliutFzRdEm0Ru0kaz3MXF1xEXN/8go466YxcwJyvov2TTUYbb24S5N5uOPn36LEfj15aaYnO12Wz+A0uOZ+M=","sidebar_class_name":"put api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Template","permalink":"/docs/API-docs/v1.1/get-template"},"next":{"title":"Delete Template","permalink":"/docs/API-docs/v1.1/delete-template"}}');var n=i(74848),s=i(28453),o=i(57742),p=i.n(o),r=i(78178),d=i.n(r),l=i(19624),c=i.n(l),m=i(96226),u=i.n(m),h=(i(77675),i(19365),i(51107)),g=i(21312);const f={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:"eJzFWc2OG7kRfpUKL7aFHkn+XUSnnXgd21jDFjwzMJLxQGA3S2rusEkuyZZGGAjYQ94gp1zzaH6SoMjuVuvHY3vXSS67HnZVsf75VemWBb7wbHLJzrGyigf07CpjAn3hpA3SaDZh5yXChRU8ILRUcDp9Dah5rtDD2tQQDFRGyPkauBZQJ+pQIggMXCoPZg4cvMVCzmUBoZEzZBkzFh2nq14LNmGJtb2HZcxyxysM6EjNW6Z5hWzCWgEzKVjGJKlpeSjZvu6vf6KbSZGWA0LJA2hE4UnrHBttSY7DX2vpULBJcDVmzIe1otu8rKwiZfDGKiOQTeZceSIoSqw4m9yysLaRMjipFyxjc+MqHrYnm81Vko8+/MWINfHsqjp1ZikFQo7KrKAzm5Rs/dnGCO7zAAq5D2A09mhbAx6wjBVGB9SBLuLWKllEJ49+8XTb7aHqJv8Fi0AedxSSINHT1+TwLxtIzuHRTRPm4z86fdkmY9qEbxYzJRMRHC4lrmJiebnQEErpQZiirsi8zV7Iv+2KLiv6MjbEowQ6yshDeVtuokxV8O582iPNjVHI9UE2UlbBSTLAxENYSaWaSoJ351NYoqMKibEawoVH5xONwwLlEoHvkEBhBMJScsCKS5XBqpRFSQm/hqr2AVA3OdS4DjvPDSEmMZzAoUJC+qMaZcCVMiupF1BH1Y4JBiEdFkGtYSVDaeoAXAhJ7FyBD2j9sO/FqEXnyHNTuz/uSQ6LWgoUEEztYG5c1BKdz8DGMiMLpPbB1QUxexA1RTfaQaT0b+tMgd5v/dR6hYh68jNA7RM7hzn3AV0GtZbkeVfbgKITiTcWnURd4FEXROfOYiNtHO6/3hdTdJUMvrWUQsOFAFRIQfHg66IEnr7zUDv0GUgtg+TKZ+ADr6zPwDgIeEN9BYKx1DzxRvpAyq+kWGDwID+XR++RaqTo6TB3porRJ9/odT8ROr2C2RN3TkGVvnk+5rxWAZZc1cd9NpfqaGPZ9dHfTA0VXzfRTyHMucdnTwA11ZCA6U9/BRJGCjm0iheJrLPfaOx3k8R+0A8cpvSf1U59Wa+z9CJisvbi/RtYleiwy0N0Ka9zaoNJMNL7Giufbg1t1nbVt5++BxryOpiZw0pqgV9Ta2cYYpAozYLpSqwOpuJBFtCK8kNoSFNCBNOvmArut8HMseRLadyDowFN4mZGFziTeoZLdOuelrqucnQHSr6Nx5Svgq895BhWiLqvW5tWRqs1NC8i6bYqUcOOT4jKb43e0fJpesvkfD0zeratpaN+3LVtX+XBgKQPBnAC5/0AFg55MG6v7evU4SFe3nZ/0p0cRNgqZQv9z+8W1Ef9UQ8GUYUvXKZN+F4XvjUBJ/AeF9wJhd4nGJYcSzmbAe8y2LRX0XuxTX2x1ZLe/h51QfAk6oTAQ+BFiYKCJtCiFtS77nnUYhal3tvio+HH+Lhb1LPCKOP6UePO8TVhyYCVPyzcTS+alyxXNUa8SKgxV7y4ZlebjOVF8Xsl0nP6Y/P3sDAVy+LRo52zA2ieFwXcz5Uk93CXx65g1w8mDXDgghpbbCh7GGInqMn5VHC7nUT61ukoous2GQsy7ACnWQ+Jz3ICtpvNJlaxt0b7VBiPxuNDvNvNEg3+pgeKGta8Vmr9p+8HYNPxl6Ac9+LRKz998spSYBqVTsPdTI/Gjx6fPByfjH84f/hs8uTPk6fPhuPx+O8sYzeV2qJnJhoU3Hov/d07kFpJjbPWa7NH4/HscePKJ8e812Dj9j1bciUFzCUqAXSn/44OROeM+53Y/Q797jKfTG6Nf3JH6lDDmptai/+3ucc0utvAJ7MfOhOfHpr4WieX0aB9bq5R/y8s3NrTvz6k60nV3ayWiSh+ZzvG9s+TkR6L2smwjkP8zQm38iR9n1xe0WhcYSgNLQBsHRWmYX7CRm13Gd32+syGkTy3bHcCEWmxMgTrJ6OR51rk5mZoLGp6RxTPPXXPEbdytHw4fMg22T4Pt/ab6LE++VYWH/hC6sWX+K62rjqjcKaI7Ths+8BY+TPSC9PEo0/VLEVK5ATyKAKUJe+3C4gXbay7cO5P7e3Q/nVz+MFUcmyy7g/WjO0Mzw1E6k+BzdHRqaj5ltA/Y/u4m072cG7DcRxePv0cqmu4+pDh+PPfvP5f+5JvKEBzE6PZlM07i/qMHEtFF7Nh36cfUBWmwnZkGgxalk//+HfHNRh0QUlbBIJj72oH1qzQzWsVIzhXeCMJ/sZNXhW/das8j7wi0KbWQFPswsU4yoUMNME380XBLc+lktRViMwQt4NeY/JD+FBiKNHRp3uOgIfAJSpqRt0AoRdbxLEy7nquzMoTPMxrLzVBR9Ql1wURtqUR51RCqDRjWyc9gg+OtJZJN6OD40WAimu+iINmBn1nCVSS+gc4k9OaxBtVp0UArSuNi6N9MiiuCqMTX9D2zyHQKQEjhyXV8bLZBvgsbWNSHZEJWkCOPoAlXWSBcdittTLFdQwgQR2whnq65Iogcl9HYg+Oa08PT9KljUHnsGbIQ9+g/AuPFOE3Ul/7yWDwUZ/AZZdXHzD3MuDV/bYnrVarg170YJfnpQyv6hzeozVeBuPWW+6FDGWdx/7VF9L9kSS9RI0xf3rdaStDmMIftkM6HZWo7OgsTQt+dDp9HZ/BB/Dpt3/CG+ROQ2lWKVuL2qFaw6K9ijyXIp/c1r1icRXE61CSx4uUfM1StvXgh5KHT7/9y8NbXNGqI5UUmTIYTOtcyaLbgvvBYALPaYDq72bjfrngmmZ2X3JKJdrPcbCJW0l9PYRTvY4rtO3MQ+eRb8eM2GnbcPu4s4gDTn+lPdxqFCdtj2qJnmQRGskRUEgC2KF0pl6k2/rKNMY5nNOQ8CGteci2UyHANsft9oem+q06ODdpW7EG7hB8XOBM91jil9pa40iLZn00N+0mEbWwRurgJyAcn4et/GxvTo0byIOj5ELeuSNrxHQhSZXYWNyd0kST7b+su/3W4RwdXRjN3sbFyiadLtu0BMrWP5LWhJ+oa/Eiwrs4kqUn/sd9ORFqoav8u/kZuqUssIEZn6noUSQesYwpWaD2/Tf/9OX0DSwfD8f0SnV45SuKe/Tm9fMXb89ekDLUSJPDHg7Hw3EcsY0PFde9m/Z+Qdp/22634Pa//YNTg55ozTmyisuIXZttXcKdl6wHgib935quMlYaH4jk9paK8cKpzYaOf60jkLi8ytiSO0maRnDarMDE8SVQ3+z779tfb+DbfrY6alCLETUBxLg+TajoGtd7v59tCIw0QJE0ThTPk14n5yRnK+Fg7iCkmzhOiwJtuJO2D/SnF+eEnprfwqr4sxpzfEXAiq+Ssmm1HyFwPLtliutFzRdEm0Ru0kaz3MXF1xEXN/8go466YxcwJyvov2TTUYbb24S5N5uOPn36LEfj15aaYnO12Wz+A0uOZ+M=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},b=void 0,y={},T=[];function R(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Update Template"}),"\n",(0,n.jsx)(p(),{method:"put",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"The Update Template API enables you to modify and update the details of a specific template."}),"\n",(0,n.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,n.jsx)(g.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,n.jsx)(d(),{...i(49772)}),"\n",(0,n.jsx)(c(),{...i(7110)}),"\n",(0,n.jsx)(u(),{...i(78316)})]})}function x(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(R,{...e})}):R(e)}},49772(e){e.exports=JSON.parse('{"parameters":[{"name":"template_id","in":"path","description":"ID of the template that needs to be updated","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string"}}]}')},7110(e){e.exports=JSON.parse('{"title":"Body","body":{"description":"Provide below parameter to update templates (at least one parameter required)","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","format":"string","example":"sample template"},"note":{"type":"string","format":"string","example":"Please review and sign this document"},"description":{"type":"string","format":"string","example":"template description"},"folderId":{"type":"string","example":""},"enableOTP":{"type":"boolean","description":"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.","example":false},"enableTour":{"type":"boolean","description":"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.","example":false},"allow_modifications":{"type":"boolean","description":"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.","example":false},"file":{"type":"string","description":"You may provide the base64 encoded PDF file to replace the existing one","format":"base64","example":""},"redirect_url":{"type":"string","description":"Specifies the URL where the signer will be redirected upon completing the document signing process.","example":""},"auto_reminder":{"type":"boolean","description":"Set to true to enable automatic reminders. Set to false to disable them (default behavior).","example":false},"remind_once_in_every":{"type":"number","description":"Number of days between reminders. This is only applicable when auto_reminder is set to true.","example":5},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed.\\n"}},"title":"template_template_id_body"}}}}}')},78316(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Template updated successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","example":"asd2HsP4Hp"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"title":"inline_response_200_3"}}}},"400":{"description":"Please provide valid field names!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","format":"string","example":"Please provide valid field names!"}},"title":"inline_response_400"}}}},"404":{"description":"Template not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","format":"string","example":"Template not found!"}},"title":"inline_response_404_7"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/5ce6d213.8dd21577.js b/assets/js/5ce6d213.8dd21577.js new file mode 100644 index 000000000..5adf84e28 --- /dev/null +++ b/assets/js/5ce6d213.8dd21577.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[3460],{32779(e,t,i){i.r(t),i.d(t,{assets:()=>g,contentTitle:()=>b,default:()=>x,frontMatter:()=>y,metadata:()=>a,toc:()=>T});const a=JSON.parse('{"id":"API-docs/v1.1/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/v1.1/update-template.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/update-template","permalink":"/docs/API-docs/v1.1/update-template","draft":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJzFWt1uG8mVfpWzPUAsEU1S9ngmWGaRjUfW2EYcS5DkNRJJIItdh2SNilWdqmpShEwgF0EeIMhNbvclcp9HmScJTv10N39GsjOzsxe2pO5Tp85/nfNV32eOTW02uMoucV5K5tBmN3nG0RZGlE5olQ2yyxnC+5Izh5Co4MXZG0DFxhItrHQFTsNcczFZAVMcqkDtZggcHRPSgp4AA1tiISaiABf59LI80yUaRlu94dkgC0vTPlmelcywOTo0JOZ9ptgcs0GWGAwFz/JMkJglc7NsW/Y3L2lnEiStADdjDhQityT1GKO0xMfgHythkGcDZyrMM+tWknazYl5KEgbvSqk5ZoMJk5YIihnOWTa4z9yq9JTOCDXN8myizZy55sl6fRP4o3XfaL6iNZuinhm9EBxhjFIvoVabhEz2TD6CA+ZAIrMOtMIWbVLgMMuzQiuHytFGrCylKLyR+99Z2u1+V3Q9/g4LRxY35BIn0NLbYPDHFSTjMG+mQWb9L7W82TrPlHafzeaMVEQwuBC49IFlxVSBmwkLXBfVnNRbb7n887aoo6LNY01rJEdDEbnLr1lNlCELTi/PWqRjrSUytRONFFXQDQpo/xCWQsqYSXB6eQYLNJQh3lc9eG/R2EBjsECxQGAbJFBojrAQDHDOhMxhORPFjAJ+BfPKOkAVYyiaDmvL9cAHMXRhVyAu7F6JcmBS6qVQU6i8aPsYAxcGCydXsBRupisHjHNBy5kE67C0vbYVvRS1IS91ZX68JRlMK8GRg9OVgYk2Xko0NofSpxlpIJR1piposQVekXe9HkRKv5dGF2htY6dkFSJq8c8BlQ3LGUyYdWhyqJQgy5uqdMhrlnhXohGoCtxrAm/coS+k0eD2021xhmYunE2akmsY54ASySkWbFXMgIX3zFUGbQ5CCSeYtDlYx+alzUEbcHhHdQWcLql44p2wjoRfCj5FZ0H8UBydI+VI0ZJhYvTce59so1btQKjlcnqL3SU5Vdh4fExYJR0smKz228yi4kOhhtpwNMMgwCcY7cMMFVh0tP0TsuCTHJAVsyg67T+WurhFHpUoKBZSiNShXiknJCUFlJSgXtGk/IwtEApN4lIMuBkKA6wImX2iJtoUaCFIDJaOBkXOSMHSg1MlV+BrN1pYksBPSNs36pR0fUIyMmmT/D14GYzlTfrE2+fJXpNNhNxbizct9HtdwZytYsKEqB8zi18/B1RUdjicvfwWiBltaLCUrAhkdchohe0CHJbvlFBiMSyZtUtt9lbchyo4MTAYSs6wMvJxxS5CF4Ihwt6fvyXbGqxzH02oJWM6egJjpJ7GV1vvzZ0w2C4ZOxKyyumhwblQHD+lvl2EyPSp7XRd1iqn58yJAhIr24NIGpLQ6XaVmsNBSqAxzthCaHO4NyICu6FWBVIu4QLNqiWlquZjNDtCvvOPqUZwtrIwRrdEVG3ZUirrOpILL5sP5g2bEJVtlN6Q8qvQP4jJaqjVsKlfe+24qdu2yJ0Oce90oAuXbQcWBpnTZuuoVeFUBb95OnFJdjIQ9bMhWuiH3Sxi1+padTpehEc2U9r9VBu+0w4HcI5TZrhEa0PrGwxLMZsDqyNYp63ojG5CnzdSUr/Voi6oJfQyITDnWDFDTk7jWKLidF744jT0XJ80PWnv2jdUJaphoaU2ba8xY9iK+neHc7ubuOuWN6+ysazQ9+jUqY8lK26zm3WejYvi3+VILcxv4t+9Qs+z3D96tvFsZxwaFwUcjKUg8zAz9lWhXB0OYrPGOFVGX1C2+rYNpwbjU8JtVhJhmyMjmu7nVpD0+zk0W+eZE26jDR+25rrhmMak9Xrt65MttbIh5Z8dHe1OT/VkGqc5aneoFE8qKVf/8dONQ+HxY4MBs/zZa3v2/HVJHokivXAPL3p29OzL7tOj7tEvL59+PXj+n4Ovvu4dHR39Icuzu7lsZrGMx5kqWS/83XoglBQKh8lqw2dHR8Mvoymf77NenLTSUb9gUnCYCJQcaE/7ExoQjdHmcw/5x+V7SH1SOSn//IHQoVI80ZXi/9/q7pPoYQWfD39Zq/jVropvVDAZwTaX+hbVz6Fho097exe2J1E3o1oEIv8+21C2/TwoabGojHArDwnddVkpuuH94OqGgJY5upkmOKmsvMAEDQ2yfqou/ftWnVlnxM8sEsLke8hs5lxpB/2+ZYqP9V1Pl6johJRsbKls9lkp+ounvWfZOt9ew8rys+ix6n7uEuvYVKjpY+tuGlNdkDuDxzYM1pwspfgt0tES/dGmihDbDBm1r+QBipLzBs46Sb6u3bmNASUI6NNQnZ0Zdx9O04ZpsmwDionNXxtTiI/2ztgJzts7S8aXYWqifbbmlSzbnkDoyVbHH5nsb7S/+qH+Nq5qN0/7G6HYB336kf851Gty/0T7WIlJeVqiuiC3UUr7WNv22BeQaL7/8//WZNSm/ho6HeqHKW67VlemQHipi8rzY9KhUcxRY/H9n/4G40pI5xEcjguUVHhsTiOCpUN+vAoAV2mERdvrdIh/e9+pWESEum590WNAPAA/XYOMrwC7tdWB4oyKM7iZ0dV05ttuNZWYw/nJxeWkkqQNzV2q6ZZtDTJ5JjnMmWLTFmRLMrPitp4UrWOu8liKQSbBiTnmPhnijIcktCHthGk1UVJMsFgVMhiHcIeEsS1QcW2AMIuuUH4e6Ha79OOLL+BVGADgwjHjkNPTEwo9iIh0wAoLZswq7FtX6oT2jFrlYAShEPhNRqPRtWq9HMB/EYfmwa8jDQ1E3//lr3D1Wi9pzJuiIuAftza8OUg1juvC7hY3etqfoSz7F0Ep239x9sYfaofB/++0A0uejGM9gfxTof6b2livS6cTqzqgWgijFZm204GD0SdX/dEh8S2NdprKZ4N0TiZYeFNLimDOHNtyxbE2CMesZGMhBZ2h9PwjHDOHU21W8BE+0AUFhWzBFHANH6/Vx2636/8RaafzMkVdpwMf4ZjGScyBqlce+9+c6qu+jTHFkeK+Cc9ucnsTvpFzfQ3kOX9TCcnBYBURhfr+wQ+NpcGux3x4ggZ/5WUgy9C1hDaUBasaD4tbXKCcdCk//RavUhRYerw1g9rGrjUupxbChUFjQvckkelZNZaigE3xL2bM0HhShpcp9aRQtz59lE5cpbCuvjxJPF8aNnHwQZtb2ilwJEivkc6DpckmzAKnFdabfCIUk8JGGIYoTOJ7rJVjRXTe70Kd8DkQhSnCexhrfUshNjVs7lEfJuUqMfnWn3yBx6mZMkV7NZIJZalRrsv0S0PhGI7L2hMfcDzT+jYwOY/THJWjLpUjwAVVnPZsZyFEpgG9VICKl1ool9j5KTHyckYgjYZFoauEJdAZ6YBOEup8yYMfN1ODAv/7P/3dwjtcUt1JBwa9/AJeeNDBV8EPPtzgoipLbdy1otNkxOr3dhQDkmZOpZdgAyF6mMI7qTZVHtAYbD0IBMmxNUHzgLSJMeVaF6K2l0R9Tba/CN68iFH3Vqhbe60IrRtdZzPBcRj8PYxxOZSeIhsE1O9jQPRGJPLo7PTiEvpesCTniNKM2LRBoRTeDUi/oSykiaHXmPWYcDM0zdVudB6T12r06uQSmq55IPjIK7/5nJJnFNDuMeF/1hlkc5pQuE8zg7xSnCnXgEIWKDMNzvUCuWfZ6ZQGJ/7uiTmWHGfQVYb4WKS1DuUqwPFR54Zhp0Nn7i0ZoAYLAJkV4far0MpWc6w9dBa7t+6Z0S4AvARm1xFF78lPG63edTZKdk0FlDCKgGYutbkNtyRuRgC5WZWRK2G0rQAcXKvozxBYyYwj+Oc/YHT2fsfi/nFrQfJmf9CaYtpkW3Gy9WJrP/+Cii+ZdJTsczqZkAPr6KWaZbSs4zd00TpQ+Qh+KHC3FfUxtEdTQrrvaBIVdHsYQW9q/SKkHferQ516Ln9pU39PkOSPyXeuJR2wvj7EY2gEYY718UW3OiVVbNIppqPREsnTAV5ghdHW+k7La0Fly+jKoUe3DSIQfYjnuswMwplOu9MpGqD3yuyc5FGmEXQSTn/ozwTfjMVuFTau+ps2NVa4wIdGKeJTl/FNdNgbKg5cHoqPp1+60fPeTAffiJWEswR2x0yFzKaDPJHjHVktnslBmnh2+s0+1qUlgIjHulzBwfHxIQknSkEV+lq9AIVLMntRNNbeqddMajW16fqpvlcaXdO806yjsl7X76ZQh+rnR8zUXdRe7MePKpIzTzxsyTg3aKl2UFUjhFs1MjaAZ4BHuwSP/hvgJ7wVt9jokJP4G9LAQbqsDVnSZLzgo8PWFXYtGvnLCB79Xp9K/to09yd5qFJkWSnIsDbcNpRuBR5ThoPR1c3o8Feg58J5LsG0ToNQMzTx4Sbrrd72xYIJ6TP1pGmsY4PbekI5QRAAXb3tNrcXoff2jcRnNOR1J1jPdpscHkRK6tUn7+n+ZGfxYwjNaLuV+R80VmhfpH4B37DidskMt3Cs5yVzwrf+KyKlxRQcHqaGcSLsFpFQhtECFk99GC+e9p7Wk1/qv+I1u5tpi/S1hg2dGrW+tT90BFjGye6eq9IwNhhOzWLG1JQSgZqv1kEtqPDzqgi54OUl1uGjCyahUuGqyc3QLKkJJZiHbwXGe4s0N8ce6Fp14apuTT/g2AqHzdy3XC53LH3o13xbSQlp+PEJ98i0GJa9Eu51NYZzLLUVTptVs2oq3Kwae1+219Z/RAZpSKnx0x8zpXqWl2jm/oLuAs1CFI+o33dE3j+8JtBrC77bhF0MTtBQ3bEbMzYrRZznr5IcQOL9GD383VSYVTwOTKUv4Ii/2ebj8VxS4XQS9Y1Y5sP6ZnkmRYHKtoHFF6/O3sLiy94RgVU1KPoJvuy/fXN88u7ihISJaZINsqe9o96Rv6HU1s2Zau209dHjNsR13yDo/9ffSEaIlr7M6ZeSCQ+Qx48dArh9lbWQ1nZjSGDfTFtHJPf3lP/vjVyv6fEfK48+Xt3k2YIZQZJ6BDy2W3z/HXpb7YPz9MEhfN6XlnsVSkC0IhTany8BSr3F1dYnn2vCJCMaTRIHiuMgV/eS+DQcdi43CE4PK174/u9B2vZtwtn7S4Jc4+ebc/8laGbYktBYtgzChsLocXb/7D6TTE0rNiXawHIdPgiZbYLvtx58j7+QUnvNsYnKBy3of9Jp74L7+wDsr9c1fXj1gyuiXRM1+eZmvV7/CyYQqDw=","sidebar_class_name":"put api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Template","permalink":"/docs/API-docs/v1.1/get-template"},"next":{"title":"Delete Template","permalink":"/docs/API-docs/v1.1/delete-template"}}');var s=i(74848),n=i(28453),o=i(57742),p=i.n(o),l=i(78178),r=i.n(l),d=i(19624),c=i.n(d),u=i(96226),h=i.n(u),m=(i(77675),i(19365),i(51107)),f=i(21312);const y={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:"eJzFWt1uG8mVfpWzPUAsEU1S9ngmWGaRjUfW2EYcS5DkNRJJIItdh2SNilWdqmpShEwgF0EeIMhNbvclcp9HmScJTv10N39GsjOzsxe2pO5Tp85/nfNV32eOTW02uMoucV5K5tBmN3nG0RZGlE5olQ2yyxnC+5Izh5Co4MXZG0DFxhItrHQFTsNcczFZAVMcqkDtZggcHRPSgp4AA1tiISaiABf59LI80yUaRlu94dkgC0vTPlmelcywOTo0JOZ9ptgcs0GWGAwFz/JMkJglc7NsW/Y3L2lnEiStADdjDhQityT1GKO0xMfgHythkGcDZyrMM+tWknazYl5KEgbvSqk5ZoMJk5YIihnOWTa4z9yq9JTOCDXN8myizZy55sl6fRP4o3XfaL6iNZuinhm9EBxhjFIvoVabhEz2TD6CA+ZAIrMOtMIWbVLgMMuzQiuHytFGrCylKLyR+99Z2u1+V3Q9/g4LRxY35BIn0NLbYPDHFSTjMG+mQWb9L7W82TrPlHafzeaMVEQwuBC49IFlxVSBmwkLXBfVnNRbb7n887aoo6LNY01rJEdDEbnLr1lNlCELTi/PWqRjrSUytRONFFXQDQpo/xCWQsqYSXB6eQYLNJQh3lc9eG/R2EBjsECxQGAbJFBojrAQDHDOhMxhORPFjAJ+BfPKOkAVYyiaDmvL9cAHMXRhVyAu7F6JcmBS6qVQU6i8aPsYAxcGCydXsBRupisHjHNBy5kE67C0vbYVvRS1IS91ZX68JRlMK8GRg9OVgYk2Xko0NofSpxlpIJR1piposQVekXe9HkRKv5dGF2htY6dkFSJq8c8BlQ3LGUyYdWhyqJQgy5uqdMhrlnhXohGoCtxrAm/coS+k0eD2021xhmYunE2akmsY54ASySkWbFXMgIX3zFUGbQ5CCSeYtDlYx+alzUEbcHhHdQWcLql44p2wjoRfCj5FZ0H8UBydI+VI0ZJhYvTce59so1btQKjlcnqL3SU5Vdh4fExYJR0smKz228yi4kOhhtpwNMMgwCcY7cMMFVh0tP0TsuCTHJAVsyg67T+WurhFHpUoKBZSiNShXiknJCUFlJSgXtGk/IwtEApN4lIMuBkKA6wImX2iJtoUaCFIDJaOBkXOSMHSg1MlV+BrN1pYksBPSNs36pR0fUIyMmmT/D14GYzlTfrE2+fJXpNNhNxbizct9HtdwZytYsKEqB8zi18/B1RUdjicvfwWiBltaLCUrAhkdchohe0CHJbvlFBiMSyZtUtt9lbchyo4MTAYSs6wMvJxxS5CF4Ihwt6fvyXbGqxzH02oJWM6egJjpJ7GV1vvzZ0w2C4ZOxKyyumhwblQHD+lvl2EyPSp7XRd1iqn58yJAhIr24NIGpLQ6XaVmsNBSqAxzthCaHO4NyICu6FWBVIu4QLNqiWlquZjNDtCvvOPqUZwtrIwRrdEVG3ZUirrOpILL5sP5g2bEJVtlN6Q8qvQP4jJaqjVsKlfe+24qdu2yJ0Oce90oAuXbQcWBpnTZuuoVeFUBb95OnFJdjIQ9bMhWuiH3Sxi1+padTpehEc2U9r9VBu+0w4HcI5TZrhEa0PrGwxLMZsDqyNYp63ojG5CnzdSUr/Voi6oJfQyITDnWDFDTk7jWKLidF744jT0XJ80PWnv2jdUJaphoaU2ba8xY9iK+neHc7ubuOuWN6+ysazQ9+jUqY8lK26zm3WejYvi3+VILcxv4t+9Qs+z3D96tvFsZxwaFwUcjKUg8zAz9lWhXB0OYrPGOFVGX1C2+rYNpwbjU8JtVhJhmyMjmu7nVpD0+zk0W+eZE26jDR+25rrhmMak9Xrt65MttbIh5Z8dHe1OT/VkGqc5aneoFE8qKVf/8dONQ+HxY4MBs/zZa3v2/HVJHokivXAPL3p29OzL7tOj7tEvL59+PXj+n4Ovvu4dHR39Icuzu7lsZrGMx5kqWS/83XoglBQKh8lqw2dHR8Mvoymf77NenLTSUb9gUnCYCJQcaE/7ExoQjdHmcw/5x+V7SH1SOSn//IHQoVI80ZXi/9/q7pPoYQWfD39Zq/jVropvVDAZwTaX+hbVz6Fho097exe2J1E3o1oEIv8+21C2/TwoabGojHArDwnddVkpuuH94OqGgJY5upkmOKmsvMAEDQ2yfqou/ftWnVlnxM8sEsLke8hs5lxpB/2+ZYqP9V1Pl6johJRsbKls9lkp+ounvWfZOt9ew8rys+ix6n7uEuvYVKjpY+tuGlNdkDuDxzYM1pwspfgt0tES/dGmihDbDBm1r+QBipLzBs46Sb6u3bmNASUI6NNQnZ0Zdx9O04ZpsmwDionNXxtTiI/2ztgJzts7S8aXYWqifbbmlSzbnkDoyVbHH5nsb7S/+qH+Nq5qN0/7G6HYB336kf851Gty/0T7WIlJeVqiuiC3UUr7WNv22BeQaL7/8//WZNSm/ho6HeqHKW67VlemQHipi8rzY9KhUcxRY/H9n/4G40pI5xEcjguUVHhsTiOCpUN+vAoAV2mERdvrdIh/e9+pWESEum590WNAPAA/XYOMrwC7tdWB4oyKM7iZ0dV05ttuNZWYw/nJxeWkkqQNzV2q6ZZtDTJ5JjnMmWLTFmRLMrPitp4UrWOu8liKQSbBiTnmPhnijIcktCHthGk1UVJMsFgVMhiHcIeEsS1QcW2AMIuuUH4e6Ha79OOLL+BVGADgwjHjkNPTEwo9iIh0wAoLZswq7FtX6oT2jFrlYAShEPhNRqPRtWq9HMB/EYfmwa8jDQ1E3//lr3D1Wi9pzJuiIuAftza8OUg1juvC7hY3etqfoSz7F0Ep239x9sYfaofB/++0A0uejGM9gfxTof6b2livS6cTqzqgWgijFZm204GD0SdX/dEh8S2NdprKZ4N0TiZYeFNLimDOHNtyxbE2CMesZGMhBZ2h9PwjHDOHU21W8BE+0AUFhWzBFHANH6/Vx2636/8RaafzMkVdpwMf4ZjGScyBqlce+9+c6qu+jTHFkeK+Cc9ucnsTvpFzfQ3kOX9TCcnBYBURhfr+wQ+NpcGux3x4ggZ/5WUgy9C1hDaUBasaD4tbXKCcdCk//RavUhRYerw1g9rGrjUupxbChUFjQvckkelZNZaigE3xL2bM0HhShpcp9aRQtz59lE5cpbCuvjxJPF8aNnHwQZtb2ilwJEivkc6DpckmzAKnFdabfCIUk8JGGIYoTOJ7rJVjRXTe70Kd8DkQhSnCexhrfUshNjVs7lEfJuUqMfnWn3yBx6mZMkV7NZIJZalRrsv0S0PhGI7L2hMfcDzT+jYwOY/THJWjLpUjwAVVnPZsZyFEpgG9VICKl1ool9j5KTHyckYgjYZFoauEJdAZ6YBOEup8yYMfN1ODAv/7P/3dwjtcUt1JBwa9/AJeeNDBV8EPPtzgoipLbdy1otNkxOr3dhQDkmZOpZdgAyF6mMI7qTZVHtAYbD0IBMmxNUHzgLSJMeVaF6K2l0R9Tba/CN68iFH3Vqhbe60IrRtdZzPBcRj8PYxxOZSeIhsE1O9jQPRGJPLo7PTiEvpesCTniNKM2LRBoRTeDUi/oSykiaHXmPWYcDM0zdVudB6T12r06uQSmq55IPjIK7/5nJJnFNDuMeF/1hlkc5pQuE8zg7xSnCnXgEIWKDMNzvUCuWfZ6ZQGJ/7uiTmWHGfQVYb4WKS1DuUqwPFR54Zhp0Nn7i0ZoAYLAJkV4far0MpWc6w9dBa7t+6Z0S4AvARm1xFF78lPG63edTZKdk0FlDCKgGYutbkNtyRuRgC5WZWRK2G0rQAcXKvozxBYyYwj+Oc/YHT2fsfi/nFrQfJmf9CaYtpkW3Gy9WJrP/+Cii+ZdJTsczqZkAPr6KWaZbSs4zd00TpQ+Qh+KHC3FfUxtEdTQrrvaBIVdHsYQW9q/SKkHferQ516Ln9pU39PkOSPyXeuJR2wvj7EY2gEYY718UW3OiVVbNIppqPREsnTAV5ghdHW+k7La0Fly+jKoUe3DSIQfYjnuswMwplOu9MpGqD3yuyc5FGmEXQSTn/ozwTfjMVuFTau+ps2NVa4wIdGKeJTl/FNdNgbKg5cHoqPp1+60fPeTAffiJWEswR2x0yFzKaDPJHjHVktnslBmnh2+s0+1qUlgIjHulzBwfHxIQknSkEV+lq9AIVLMntRNNbeqddMajW16fqpvlcaXdO806yjsl7X76ZQh+rnR8zUXdRe7MePKpIzTzxsyTg3aKl2UFUjhFs1MjaAZ4BHuwSP/hvgJ7wVt9jokJP4G9LAQbqsDVnSZLzgo8PWFXYtGvnLCB79Xp9K/to09yd5qFJkWSnIsDbcNpRuBR5ThoPR1c3o8Feg58J5LsG0ToNQMzTx4Sbrrd72xYIJ6TP1pGmsY4PbekI5QRAAXb3tNrcXoff2jcRnNOR1J1jPdpscHkRK6tUn7+n+ZGfxYwjNaLuV+R80VmhfpH4B37DidskMt3Cs5yVzwrf+KyKlxRQcHqaGcSLsFpFQhtECFk99GC+e9p7Wk1/qv+I1u5tpi/S1hg2dGrW+tT90BFjGye6eq9IwNhhOzWLG1JQSgZqv1kEtqPDzqgi54OUl1uGjCyahUuGqyc3QLKkJJZiHbwXGe4s0N8ce6Fp14apuTT/g2AqHzdy3XC53LH3o13xbSQlp+PEJ98i0GJa9Eu51NYZzLLUVTptVs2oq3Kwae1+219Z/RAZpSKnx0x8zpXqWl2jm/oLuAs1CFI+o33dE3j+8JtBrC77bhF0MTtBQ3bEbMzYrRZznr5IcQOL9GD383VSYVTwOTKUv4Ii/2ebj8VxS4XQS9Y1Y5sP6ZnkmRYHKtoHFF6/O3sLiy94RgVU1KPoJvuy/fXN88u7ihISJaZINsqe9o96Rv6HU1s2Zau209dHjNsR13yDo/9ffSEaIlr7M6ZeSCQ+Qx48dArh9lbWQ1nZjSGDfTFtHJPf3lP/vjVyv6fEfK48+Xt3k2YIZQZJ6BDy2W3z/HXpb7YPz9MEhfN6XlnsVSkC0IhTany8BSr3F1dYnn2vCJCMaTRIHiuMgV/eS+DQcdi43CE4PK174/u9B2vZtwtn7S4Jc4+ebc/8laGbYktBYtgzChsLocXb/7D6TTE0rNiXawHIdPgiZbYLvtx58j7+QUnvNsYnKBy3of9Jp74L7+wDsr9c1fXj1gyuiXRM1+eZmvV7/CyYQqDw=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-2",custom_edit_url:null},b=void 0,g={},T=[];function j(e){const t={p:"p",...(0,n.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Update Template"}),"\n",(0,s.jsx)(p(),{method:"put",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Update Template API enables you to modify and update the details of a specific template."}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(f.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(r(),{...i(49772)}),"\n",(0,s.jsx)(c(),{...i(7110)}),"\n",(0,s.jsx)(h(),{...i(78316)})]})}function x(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(j,{...e})}):j(e)}},49772(e){e.exports=JSON.parse('{"parameters":[{"name":"template_id","in":"path","description":"ID of the template that needs to be updated","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string"}}]}')},7110(e){e.exports=JSON.parse('{"title":"Body","body":{"description":"Provide below parameter to update templates (at least one parameter required)","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","format":"string","example":"sample template"},"note":{"type":"string","format":"string","example":"Please review and sign this document"},"description":{"type":"string","format":"string","example":"template description"},"folderId":{"type":"string","example":""},"enableOTP":{"type":"boolean","description":"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.","example":false},"enableTour":{"type":"boolean","description":"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.","example":false},"allow_modifications":{"type":"boolean","description":"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.","example":false},"send_in_order_strict":{"type":"boolean","description":"When set to \'true\', each signer is blocked from accessing the document until all preceding signers have completed their action. Enforces strict sequential signing. Only applies when \'sendInOrder\' is also \'true\'. Defaults to \'false\'.","example":false},"file":{"type":"string","description":"You may provide the base64 encoded PDF file to replace the existing one","format":"base64","example":""},"file_password":{"type":"string","format":"string","example":""},"redirect_url":{"type":"string","description":"Specifies the URL where the signer will be redirected upon completing the document signing process.","example":""},"auto_reminder":{"type":"boolean","description":"Set to true to enable automatic reminders. Set to false to disable them (default behavior).","example":false},"remind_once_in_every":{"type":"number","description":"Number of days between reminders. This is only applicable when auto_reminder is set to true.","example":5},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed.\\n"},"cc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"cc (carbon copy): Users added here will receive a notification email once the document is completed.\\n"}},"title":"template_template_id_body"}}}}}')},78316(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Template updated successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","example":"asd2HsP4Hp"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"title":"inline_response_200_3"}}}},"400":{"description":"Please provide valid field names!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","format":"string","example":"Please provide valid field names!"}},"title":"inline_response_400"}}}},"404":{"description":"Template not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","format":"string","example":"Template not found!"}},"title":"inline_response_404_7"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/62b755e6.51187a34.js b/assets/js/62b755e6.51187a34.js deleted file mode 100644 index 02ba2204f..000000000 --- a/assets/js/62b755e6.51187a34.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[9350],{19899(e,t,n){n.r(t),n.d(t,{assets:()=>j,contentTitle:()=>y,default:()=>D,frontMatter:()=>b,metadata:()=>s,toc:()=>g});const s=JSON.parse('{"id":"API-docs/v1.1/getdocumentlist","title":"Get Document list from status","description":"### Document Types:","source":"@site/docs/API-docs/v1.1/getdocumentlist.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/getdocumentlist","permalink":"/docs/API-docs/v1.1/getdocumentlist","draft":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJztWc1uGzkSfpVa5rCJ0JZkW05mdRojk/V6NkiM2EGATQyB3V1SM2aTPSRbsmA0MId9gznNdR8tT7Iosv9ky46VGeQ0l8Qi658fi1XVN8zxhWXTj+wnnZQ5KmfZZcRStIkRhRNasSl78uQJNNtwsS7QTj+pd+iMwCUCBymsAz2HtBEBMbeYglbg1gV+Up/U/hAGg58Mn7tWkp0OBp8UAMBetwYu4w64QUhKY1A5uQahIPWc1nFX2iHJOyB5p2rvzOiFQWu/SWpRM3uJhyTxpc4LiQ7Tx8jL+BIhRlRgyyRBa+ellGtIWhkr4TLgUoLBX0phMAUrFoq70mDQOSGdr64Lv/dYjVjTc5V6l5QGqdUCDXBvhYgleulHPuaYSKF2dShtuOI1uAyhtGiGnxSLmC7QcMLFacqmbIGuOXQCAYtYwQ3P0aEhUN0wxXNkU5bqhJDAIiYIUAV3GbuNsosMPVw2keQ0mBppLGJNINnUmRIjZt1aknwrKOYsYnhdSJ0im865tESQZJhzNr1hXv+UWWeEWhClKnPCvYeWN6yBA4tYe4ZBpFdJ9oaosMuqilrfpMiFazz7pUSz3jC0MaS2dK5N3rez9qM1M+fXIifLjsbjqDFalXmMhlXEx72n0/1xzwR7JYo/zYL7dY6rS5JrC60sWqI9GI/pv82D7G4DtGjxMVUOlSN6XhRSJH5j9NkS081dA3T8GRMPKUNinAgqDdpSuh4dN4aTw8Jhbr/OH5YJvXcxQaHhbgMlje/snyfi6uAwzt7/TDGZC1rcTULmXGGno1G9Uho5THRO0pxwu4uz/g+6KiRCabezhEIit+iTUnvjvHNapmi+VygDhneTECwEz1p1AWSNF7PahSpieqU2fHmU/M/aJ0Lip+j4bPatgDN6+9l22hLUDwViq1mYcyG/Sh0j/lgvNFgrMq2+omZy9Pxg//CHF/tEvxLpAt0f8D/s7hZ/h9cu1tfeXr7Au2mpx96udLmxitj1jjwHk0kVsfWOXC9I1WpHpsMfqohlOzJNnhOWfYp9RMy/5U61Ma/6N8phXkjucHYe7sGswcODVP5SWlTpqXprNnNJrLVErvqq6QWqIpYY5A7TY/cwOg/GB4d7++O98YuL/efTyT+mR8+H4/H4Pyxi17nsvGcpd8j6yaH+XRbpd9GDiscSL3T5OPcNpsJg4mal2XqxHzo7Usel1KtZrlMxr99W+7BeXxeQ3c3hia2ZvI+QlhCEBa3kGviSC0l+wipD5YvFJgkTTX2mMDc6Bw6NhKE3uHR6ZjAX6j6EbNYV5+ioHKRw0f8hvEBScu5EAo0oO4Sa1HtIf6TCemKXYQ5PU5zzUjqIMeNLoc2z4bawBHEzrRKcCTXDJdVVWy7tppFv/LKvYfnaQoxuRQV1z7aLTNgufKESauO3EROisp3TG1aO6YbdwmHvCb/9IG5eV6Gojp01pdzsYDyeTeqLPxlP7pZ077DQxoHSrjvwv/15NR0ao7e+0R32tlvwkFOT8WR21Dp1dNepU7XkUqRwfHYKF/oK1ff1qK/eBfV3z1QEIr/PNpztrwcnLSalEW7tG6/rPV6IvbA//XhJlXuOLtN11+Y7NZexKRv1G7jRTd2pVYzkmWXTx/mc1Fawlqs01tdDXaCi+kjy2FJ9MeKFGC33h1Q43ObhRbETPZZ7u7JYxxdCLb7Gd9mF6pyOM5zYRsC6WqcQ/0Yqdurz6FPVDVeG3JeaFf2ea89cn9LbAhW9iP6MvfLb6eIDykTnPkdR6hwMGpYv//1fyzUYtDnVo9F3929LA4VeoaE+i2YBc4nX1Pt7Nsz9noW1Lkm4RZ5LtNYPPhwuDHcIqVgIx6VvAIRaQMILHgspCMREponbQO8e2CF8yNBlaGjr74amPykuURL221SsFt0bsNLmai71ykbAIS6tUDStQZVxlRBhcxIRaANcASqHpjCC+hJnyGoRbNPKGZ44yLniCyTZEfSDlaIUBFcwOi6tA6tl6U0Gx4XUNDFpHFKIaRjAvKIm2CDQKvX8BjOCzRJhUYoUbQSJThFCq0UuqBRitA4KskUk6AcUpZI6ufIHSCMgKDSlEMElPQN9G4ndGa4sveXBluYM2oAVRlP3XE+IBoP3FumEXwt1FUY3e/CxxdUHjK1wePm0uQKr1eoO9J9t8pwI968yBkqoVjht1h33QrisjP116QtpfwRJJ6jQ46d3GToZqU7s3dtHq6MMZTE6R0cIsaPjs1OfdZ/Bl19/g9fIjYJMrwJak9KgXMOiUUWRCycfwtYmTZhrD7yMIp4E8NHoA61rIvgh4+7Lr79beIMrGvuFK0WuDAZnZSxFAhd1XWIHgym89DVLW6vUw7GEK4gRbMYJSkvBgUMRuKVQV0M4Vms/JwtjPwIDrXu+DTc22u3+qDTrdA47i3zNYlEu0ZIsegBjBEwFlVUuM7pcBG19Y2rnDM6FlPAhlOzk23GaQlEv15W8r486c3BOF8JluPbTRYvKDeHsFovfKQt6kjGlmHrsa6pA6QBQpYUWNGusJ7et/KgDui8NhVZblurJaRuOqBbTHkm4ibXH7WqYUN5K5Jv51uAcDSn0bnfnUogaTh8bWAKh9Y/Amp5rylo88dVE3bDTi/LjbTn+ZUeT27fzczRLkTTjontu9MgTj1jEpEhQWexVDMcnZ69heTgcs6j3PD7ico9en7589eb8FRlDiTQEbH84Ho59H66ty7nqaTrBbpgfvgH4Kj9M6W+/dDddZfXX94S/vie03xPqOouGD6NCcuGr3LoDDhXqR3brE8O0+ZpwGbFMW0ckNzcEkfdGVhUthyE4Fa5159eNwa9w3RvaL7ks6wb6Xtp6ut6RXtIPI4h2u457kf/0XX1yz+Axnzu2BqepTNW6b1RjbBOb6pKGTKE0JRvD7nGSYNH3+06Ps9EonLy6YL5PzzZL4itfEtd/kPStNm3WysEA+pdCvZXh5iaU21XV0oetezlqBxtqCtBlVVX/B91O/0o=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Document","permalink":"/docs/API-docs/v1.1/deletedocument"},"next":{"title":"Resend request mail","permalink":"/docs/API-docs/v1.1/resendrequestmail"}}');var i=n(74848),r=n(28453),a=n(57742),l=n.n(a),o=n(78178),p=n.n(o),c=n(19624),m=n.n(c),d=n(96226),u=n.n(d),h=(n(77675),n(19365),n(51107)),x=n(21312);const b={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:"eJztWc1uGzkSfpVa5rCJ0JZkW05mdRojk/V6NkiM2EGATQyB3V1SM2aTPSRbsmA0MId9gznNdR8tT7Iosv9ky46VGeQ0l8Qi658fi1XVN8zxhWXTj+wnnZQ5KmfZZcRStIkRhRNasSl78uQJNNtwsS7QTj+pd+iMwCUCBymsAz2HtBEBMbeYglbg1gV+Up/U/hAGg58Mn7tWkp0OBp8UAMBetwYu4w64QUhKY1A5uQahIPWc1nFX2iHJOyB5p2rvzOiFQWu/SWpRM3uJhyTxpc4LiQ7Tx8jL+BIhRlRgyyRBa+ellGtIWhkr4TLgUoLBX0phMAUrFoq70mDQOSGdr64Lv/dYjVjTc5V6l5QGqdUCDXBvhYgleulHPuaYSKF2dShtuOI1uAyhtGiGnxSLmC7QcMLFacqmbIGuOXQCAYtYwQ3P0aEhUN0wxXNkU5bqhJDAIiYIUAV3GbuNsosMPVw2keQ0mBppLGJNINnUmRIjZt1aknwrKOYsYnhdSJ0im865tESQZJhzNr1hXv+UWWeEWhClKnPCvYeWN6yBA4tYe4ZBpFdJ9oaosMuqilrfpMiFazz7pUSz3jC0MaS2dK5N3rez9qM1M+fXIifLjsbjqDFalXmMhlXEx72n0/1xzwR7JYo/zYL7dY6rS5JrC60sWqI9GI/pv82D7G4DtGjxMVUOlSN6XhRSJH5j9NkS081dA3T8GRMPKUNinAgqDdpSuh4dN4aTw8Jhbr/OH5YJvXcxQaHhbgMlje/snyfi6uAwzt7/TDGZC1rcTULmXGGno1G9Uho5THRO0pxwu4uz/g+6KiRCabezhEIit+iTUnvjvHNapmi+VygDhneTECwEz1p1AWSNF7PahSpieqU2fHmU/M/aJ0Lip+j4bPatgDN6+9l22hLUDwViq1mYcyG/Sh0j/lgvNFgrMq2+omZy9Pxg//CHF/tEvxLpAt0f8D/s7hZ/h9cu1tfeXr7Au2mpx96udLmxitj1jjwHk0kVsfWOXC9I1WpHpsMfqohlOzJNnhOWfYp9RMy/5U61Ma/6N8phXkjucHYe7sGswcODVP5SWlTpqXprNnNJrLVErvqq6QWqIpYY5A7TY/cwOg/GB4d7++O98YuL/efTyT+mR8+H4/H4Pyxi17nsvGcpd8j6yaH+XRbpd9GDiscSL3T5OPcNpsJg4mal2XqxHzo7Usel1KtZrlMxr99W+7BeXxeQ3c3hia2ZvI+QlhCEBa3kGviSC0l+wipD5YvFJgkTTX2mMDc6Bw6NhKE3uHR6ZjAX6j6EbNYV5+ioHKRw0f8hvEBScu5EAo0oO4Sa1HtIf6TCemKXYQ5PU5zzUjqIMeNLoc2z4bawBHEzrRKcCTXDJdVVWy7tppFv/LKvYfnaQoxuRQV1z7aLTNgufKESauO3EROisp3TG1aO6YbdwmHvCb/9IG5eV6Gojp01pdzsYDyeTeqLPxlP7pZ077DQxoHSrjvwv/15NR0ao7e+0R32tlvwkFOT8WR21Dp1dNepU7XkUqRwfHYKF/oK1ff1qK/eBfV3z1QEIr/PNpztrwcnLSalEW7tG6/rPV6IvbA//XhJlXuOLtN11+Y7NZexKRv1G7jRTd2pVYzkmWXTx/mc1Fawlqs01tdDXaCi+kjy2FJ9MeKFGC33h1Q43ObhRbETPZZ7u7JYxxdCLb7Gd9mF6pyOM5zYRsC6WqcQ/0Yqdurz6FPVDVeG3JeaFf2ea89cn9LbAhW9iP6MvfLb6eIDykTnPkdR6hwMGpYv//1fyzUYtDnVo9F3929LA4VeoaE+i2YBc4nX1Pt7Nsz9noW1Lkm4RZ5LtNYPPhwuDHcIqVgIx6VvAIRaQMILHgspCMREponbQO8e2CF8yNBlaGjr74amPykuURL221SsFt0bsNLmai71ykbAIS6tUDStQZVxlRBhcxIRaANcASqHpjCC+hJnyGoRbNPKGZ44yLniCyTZEfSDlaIUBFcwOi6tA6tl6U0Gx4XUNDFpHFKIaRjAvKIm2CDQKvX8BjOCzRJhUYoUbQSJThFCq0UuqBRitA4KskUk6AcUpZI6ufIHSCMgKDSlEMElPQN9G4ndGa4sveXBluYM2oAVRlP3XE+IBoP3FumEXwt1FUY3e/CxxdUHjK1wePm0uQKr1eoO9J9t8pwI968yBkqoVjht1h33QrisjP116QtpfwRJJ6jQ46d3GToZqU7s3dtHq6MMZTE6R0cIsaPjs1OfdZ/Bl19/g9fIjYJMrwJak9KgXMOiUUWRCycfwtYmTZhrD7yMIp4E8NHoA61rIvgh4+7Lr79beIMrGvuFK0WuDAZnZSxFAhd1XWIHgym89DVLW6vUw7GEK4gRbMYJSkvBgUMRuKVQV0M4Vms/JwtjPwIDrXu+DTc22u3+qDTrdA47i3zNYlEu0ZIsegBjBEwFlVUuM7pcBG19Y2rnDM6FlPAhlOzk23GaQlEv15W8r486c3BOF8JluPbTRYvKDeHsFovfKQt6kjGlmHrsa6pA6QBQpYUWNGusJ7et/KgDui8NhVZblurJaRuOqBbTHkm4ibXH7WqYUN5K5Jv51uAcDSn0bnfnUogaTh8bWAKh9Y/Amp5rylo88dVE3bDTi/LjbTn+ZUeT27fzczRLkTTjontu9MgTj1jEpEhQWexVDMcnZ69heTgcs6j3PD7ico9en7589eb8FRlDiTQEbH84Ho59H66ty7nqaTrBbpgfvgH4Kj9M6W+/dDddZfXX94S/vie03xPqOouGD6NCcuGr3LoDDhXqR3brE8O0+ZpwGbFMW0ckNzcEkfdGVhUthyE4Fa5159eNwa9w3RvaL7ks6wb6Xtp6ut6RXtIPI4h2u457kf/0XX1yz+Axnzu2BqepTNW6b1RjbBOb6pKGTKE0JRvD7nGSYNH3+06Ps9EonLy6YL5PzzZL4itfEtd/kPStNm3WysEA+pdCvZXh5iaU21XV0oetezlqBxtqCtBlVVX/B91O/0o=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},y=void 0,j={},g=[{value:"Document Types:",id:"document-types",level:3}];function f(e){const t={h3:"h3",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Get Document list from status"}),"\n",(0,i.jsx)(l(),{method:"get",path:"/documentlist/{doctype}",context:"endpoint"}),"\n",(0,i.jsx)(t.h3,{id:"document-types",children:"Document Types:"}),"\n",(0,i.jsx)(t.p,{children:"Retrieve a list of documents based on type"}),"\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"Draft Documents:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Documents that are currently in draft status."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"In-Progress Documents:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Documents that are currently in progress."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"Completed Documents:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Documents that have been successfully completed with all required signatures."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"Expired Documents:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Documents that have expired and are no longer accessible."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"Declined Documents:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Documents that have been declined by the user."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,i.jsx)(x.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,i.jsx)(p(),{...n(17331)}),"\n",(0,i.jsx)(m(),{...n(81553)}),"\n",(0,i.jsx)(u(),{...n(72791)})]})}function D(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}},17331(e){e.exports=JSON.parse('{"parameters":[{"name":"doctype","in":"path","description":"The type of documents to retrieve","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["draft","inprogress","completed","expired","declined"]}},{"name":"limit","in":"query","required":false,"style":"form","explode":true,"schema":{"maximum":500,"type":"number"},"example":10},{"name":"skip","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"number"},"example":0}]}')},81553(e){e.exports={title:"Body"}},72791(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"FGik23bhUJ"},"file":{"type":"string","format":"string","example":"https://exampleurl.com"},"title":{"type":"string","format":"string","example":"sample doc"},"note":{"type":"string","format":"string","example":"please sign document"},"folder":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"FGik23bhUJ"},"name":{"type":"string","format":"string","example":"folder name"}},"title":"document_folder"},"owner":{"type":"string","format":"string","example":"joe bee"},"signers":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","example":"ceo"},"name":{"type":"string","example":"joe bee"},"email":{"type":"string","example":"joebee@example.com"},"phone":{"type":"string","example":"456213871"},"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","format":"string","example":"textbox"},"page":{"type":"number","format":"number","example":1},"x":{"type":"number","format":"number","example":244},"y":{"type":"number","format":"number","example":71},"w":{"type":"number","format":"number","example":38},"h":{"type":"number","format":"number","example":46},"options":{"type":"object","properties":{"name":{"type":"string","format":"string","example":"textbox"}}}},"title":"template_Signers_widgets"}}},"title":"template_Signers"}},"sendInOrder":{"type":"boolean","example":true},"createdAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"enableTour":{"type":"boolean","example":true},"redirect_url":{"type":"string","format":"string","example":""},"allow_modifications":{"type":"boolean","example":false},"template_id":{"type":"string","example":"template_id is only available when the document is created from a template."},"auto_reminder":{"type":"boolean","description":"Set to true to enable automatic reminders. Set to false to disable them (default behavior).","example":false},"remind_once_in_every":{"type":"number","description":"Number of days between reminders. This is only applicable when auto_reminder is set to true.","example":0}},"xml":{"name":"document"},"title":"document"}}},"title":"inline_response_200_4"}}}},"404":{"description":"Report not available!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Report not available!"}},"title":"inline_response_404_5"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/62b755e6.f63fd557.js b/assets/js/62b755e6.f63fd557.js new file mode 100644 index 000000000..ce18b0eac --- /dev/null +++ b/assets/js/62b755e6.f63fd557.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[9350],{19899(e,t,n){n.r(t),n.d(t,{assets:()=>y,contentTitle:()=>j,default:()=>b,frontMatter:()=>h,metadata:()=>s,toc:()=>U});const s=JSON.parse('{"id":"API-docs/v1.1/getdocumentlist","title":"Get Document list from status","description":"### Document Types:","source":"@site/docs/API-docs/v1.1/getdocumentlist.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/getdocumentlist","permalink":"/docs/API-docs/v1.1/getdocumentlist","draft":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJztWltzG7cV/iun65mOxeFNspy0TCeNKsuKWtfW6FLP1NSI4O4hFyEW2ABYUhyJM3no9Ad0+tLX/om+96fkl7QHwF5IyrKUZPKUB1vS7sHBueFcPuxtZNnURIMP0SsVFxlKa6KrdpSgiTXPLVcyGkTPnj2D8jVcLHM0g6E8Q6s5zhEYCG4sqAkkJQsYM4MJKAl2meNQDuVuF1qtV5pNbMXJDFqtoQQA6NTPwKbMAtMIcaE1SiuWwCUkbqWxzBamS/z2iN+J7JxqNdVozA/imofFjuML4nioslygxeQx/FI2RxgjSjBFHKMxk0KIJcQVjwW3KTAhQOO3BdeYgOFTyWyh0e+5T3se3eTu3WN3xEDPZOJUkgqEklPUwJwUfCzQcX/pbI6x4PKpCiXlqvESbIpQGNTdoYzakcpRM4qLkyQaRFO0pdMpCKJ2lDPNMrSoKahuI8kyjAZRomKKhKgdcQqonNk02oyyixRduKxHklWgQ6RF7ag0ZDSwusB2ZOxSEH/DyeZRO8KbXKgEo8GECUMEcYoZiwa3kdt/EBmruZwSpSwyinsXWk6wMhyidlT50LN0W5K83irR1WrVrnQTPOO21OzbAvVyTdBSkCDpROmsKWfQoxIzYzc8I8le9vvtUmhZZGPU0YrWMafpYLffEMHMeP6TSfDxPfurK+JrciUNGqLd6/fpx7oj69MAVbQ4m0qL0hI9y3PBY/ei942hRbfbAqjxNxi7kNLExnK/pUZTCNugY1ozUphbzMyn1/vHFL3bMUGmYXYtSkrdo9fHfLb3Ypxe/pFsMuH08GkcUmtzM+j1wpNCi26sMuJmuX06O+N+oaNCLKSyT+aQC2QGXVKqTpxTTokE9c9lSh/DT+PgJQS3dFUbMCq1uA4qrNqRWsg1XR7F/xvlEiGtJ+u4bPZDA06r+31b7xajesgQ94qFGePik9RjxK/CgzLW8lTJT2yz//Kzvd0Xv/l8N1qtyLoGZXIi3+n1oBgrJZDJ5kpKJYH+mstrRSuuaYPYPrzQpahVO2JCqMW1mkwoz16T6e9dt55v3qdoU9QQPAUxo4o8zrgFBrHKl1RRbMpNFeSeNIHCcDkFJgFvLGrJBFilBEyUBhc2oHHOcdGFVzhhhfDlyMnavU/6WCOzmBzYh82719970dntd/qfX+x+Ntj/7eDlZ91+v//XqB3dZM6nZdVkFqNmdIe/izz5WfZBycYCL1TxOLdrTLjG2F4X+t7IfOjARZXzM5XwSSgO5nFRYzHLBbN4ze9NRfUuDULgBpQUS2BzxgXpCYsUpet2qjDhBoJPYaJVBgxKDl0ncGHVtcaMy4+djPVAPUdLAUTmop/evEBcMmZ5DCUr04VA6jSkXxJuHLFNMYPniQ9HGGPK5lzpnXvD0bO7VjJGOo04p8Zgq8BvCvnWPXZNGFsaGKNdUEfYkO2CjlJlPl/KK/ut2YSoTK30mpR9yiwbcdioQZsZPVo18zyXLkGUvcj1Xr9/vR+y1X5/f7snOcNcaQtS2drhv/rpmhLUWt1bZOrYu1+Ch5Ta7+9fv6yUermt1ImcM8ETODg9gQs1Q/nzatTc3vrtt33KPZF7H60p23xe1pm40Nwu3eRw02E57/j3gw9X1HpmaFMVxg43atg0GkS95gTSuw2jxioifnpeDiIuJ1UtmGEyGaubrspRUi0QbGyoQPZYznvz3e5eRN31+hqW50+ix6Lz1CXGsimX00+tu6pNdU7u9B5bM1jdrOT8T0jdSvBHkypMDCky1yut6O+JcouDl97lKM+pPSQfu823sAEoab7/278rMho/v4RWi2Y6UqRjVKFjdAOn48eEK7iW/3/i/P67f8K44MK6wpvgHAVFomlT0jDWT6EoLepcc4OmSwPsUDb3nfI5GliqwlV8P7u1ab5PipgE7WhkyRKwUw3gQGmcKhLYVKtimgID6gYEtuHs6PyCppeD0xPKxDJpzKMkYsWkDRmTbIpVWXAys3jmSKi38JAFgQ0aqb3gGbb95O6zPpLQmrTjulF4BJ9gvIyFNw5BCIQlqMLCHGWiNAgVzzpcujm/0+nQj2fP4BitpV3PLdMWE3p6RFnfARBoLGSFsRAzrZd+3+rokoRU+kaN+BiBjwy3yWg0GsrGywH8jjjUD74MNEPZan3/93/Ah6/VghL/FCXNgLix4dXzMugTFZvtaKenvRRF3jv3SpnewemJy3I73v9vlQVDnlykqF2RHOOUy9/DpXF1ElqtcMwB5ZxrJcm0rRY8Hz06DYx2iG+ulVUOmii9wCYTjJ2pBUVwwizbcMWh0giHLGdjLjglVXp+B4fM4lTpJdzBe4JcKGSpX00U3A3lXafTcf+ItNWq4JlWC+7g0HUibaDuug2+B2xTh6pmIaYSpLivw7NTur0O38D5ooxXx/kPBRcJaCxCj1G+9ABWrrGTCxY7QCuZojVfOBnIMkoiKE2nYFm132GLcxSTDp1Pt8VxGQWGHof2uxarsmvgAlzOuXWVCyZCLUqmp8VY8BjWxT9PCQZjkPuX5dETXM7c8ZGq5OqAygqMK63ssMX3Ss9oJ8+RgLBaOqUbNmHGo5HGmXzCJRPchMaMKHTJ91BJy+LgvD/7POHOQBAm9u9hrNTMQ5Esc30gIxQxMHnt5ljP452eMkl71ZJxaXiCVQqGV5rC0Q+/lSfe4zhVauaZnGGMREPpqEPpCHBOGUcqW7fd4CPTTUGAMskVl7Zkd2lKgWoIOI5VIa2zSExjgAWqJNTukwfv1o8GBf733/3LwFtcUN4pCwa9fAYH1rI4dVnwvQs3OC9yap2GkqrJiFXvzSgEJLWZUi3AeEKPPHvIuDRVOzTyjQeeoHRsRVA/IG1CTJUPKX956JZE/Zpsf+69eR6i7g2XMzOU1L+PhlHKEz/G0hzsKa6Fo4gGfg648z3+iEQenb47v4CeE6yUc0THjNiUYdMMb1Om7XVloWwhu7VZD2kiQV0dndJ5TAzl6PjoAnqljr0BT0ZO+fXndHhGTdDbamSZh4npmGlMCpkwaaHGgB1ArTFT8wBYt1q5xgkXwuXM0nEabaGJj0Faa1Es/cAVdK4ZtlpUc2dkgAqIBGSGoyZDxUqaIsPKQ6fMmIXSCd0TWIwpNE5fva4jit6TnwjOu84D8TAalXYtE+hYJUs/3yyUdru71Igy1ss8cKWprRGAg6EM/vSBVZpxBP/9D4xOL7cs7h43FpTe7A0aY2uTbCNONl5s7OdeUPIlk45K+7zzSEsVvZSztBJV/G7jMQ8F7qaiLobu0ZRm3xsaTThdxIQxmFq/MOSG/apQp54LWZzW03cpfzh8Z0pQgXX5IZShEfjBxsUXXYzklLFJp3AcCZYjT084igRYrJUxrtNyWlDa0qqw6OZdjQhE7+O5SjMDX9Npd6qifhgv9FYlDzKNoFVO7juuJrhmLHSrlHIJjrWuptZtashwng+BUcSnSuNmHa8gQ3nIyg/nofqFsg3Om2XhG7E812ru2R0y6U82FfKSHG/IaqEme2lC7XSb3VWphemxknBISNvzw8MdEo7nnDL0UB6AxAWZPY5ra2/la0Y3WK6UkT54w41rrkbDaNxcp2Qjf9eJ2mc/iraqu6i82PONUuXMI8JNgSUJ3fSgcS0BJnTeKxl1KJGMOuWxkh2HITYLJDj0FQhZ2QaMyqujLrzhM6x1aJP4a9LAc1PEKXUU/pTUJ54nox3qCeY8CXbwopG/NE+C36uqNGeiwLar5D5LkWUFJ8MaB29muV2Cw63h+ejD1WjnC1CEjxIXb1qrgMsUdXi4znqjtz2oILOjurEODW7jCZ0Jul+4PHtzT3N77ntv10g8oSGvOsFqtlvn8ODoXK0+uoQznG4t/tTIPtpsZf6C2nDlktSv4Q8sni2YTgzQNTKz3LX+SyKlxRQc/oZ4XBJ24kAo/GgB810XxvPd7m41+ZX9l/El0abKIMz9xj4h1RAm3bgTOjcu7e64SgVjjb5qximTUzoI1Hw1CjWnxJ8UsT8LTl5irdyczwQUUtA1uyKkfUFNKF04JRuBcWmQ5ubQAw1lBz5Urel7HBtusZ77FovFlqV33JrXhRDV3bQ7cJ+YFv2yY26/LsZAQJvhVullvWrKbVqMnS+ba6s/AoNySKkAtR8zpTqWF6gzQ2DqOeo5jz+hfs8SeW/H3bRv4DnrsIvGCWrKO2ZtxmY5D/P8h1IOIPF+jB6E2oVZxQGD/uKJgKWvNvk4gI9UeDcJ+gZw62F9o3YkeIzSYAM4PDg+fQPzF91+1G6gZI/wZe/NyeHR2/MjEiYck2gQ7Xb73b67/1LGZkw2djrG+qMUPyL63tNBN5uA120NsP7yXcwv38VU38UEuNXije3lgnEHdoeLMA9Uf4g2PpUZlF/FXLWjVBlLJLe3FCKXWqxW9Nh/zEH4deiN6885ZrhsfHziyrS/R/sobfhKpCa9oj80J9r79/ho5D8/C57bgcd8tnOvcUqAWi6bQpXClrZZXa3aJUJNMvq3B66hb6zbuupYuy84PrqI3HVduo6MzxwyHn4h7vfKtA6ZewHofzL1vQtubz3qvlpV9P7VR1cEBUtqMtDVarX6H3Ob6Do=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Document","permalink":"/docs/API-docs/v1.1/deletedocument"},"next":{"title":"Resend request mail","permalink":"/docs/API-docs/v1.1/resendrequestmail"}}');var i=n(74848),o=n(28453),r=n(57742),l=n.n(r),a=n(78178),p=n.n(a),c=n(19624),d=n.n(c),u=n(96226),m=n.n(u),x=(n(77675),n(19365),n(51107)),g=n(21312);const h={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:"eJztWltzG7cV/iun65mOxeFNspy0TCeNKsuKWtfW6FLP1NSI4O4hFyEW2ABYUhyJM3no9Ad0+tLX/om+96fkl7QHwF5IyrKUZPKUB1vS7sHBueFcPuxtZNnURIMP0SsVFxlKa6KrdpSgiTXPLVcyGkTPnj2D8jVcLHM0g6E8Q6s5zhEYCG4sqAkkJQsYM4MJKAl2meNQDuVuF1qtV5pNbMXJDFqtoQQA6NTPwKbMAtMIcaE1SiuWwCUkbqWxzBamS/z2iN+J7JxqNdVozA/imofFjuML4nioslygxeQx/FI2RxgjSjBFHKMxk0KIJcQVjwW3KTAhQOO3BdeYgOFTyWyh0e+5T3se3eTu3WN3xEDPZOJUkgqEklPUwJwUfCzQcX/pbI6x4PKpCiXlqvESbIpQGNTdoYzakcpRM4qLkyQaRFO0pdMpCKJ2lDPNMrSoKahuI8kyjAZRomKKhKgdcQqonNk02oyyixRduKxHklWgQ6RF7ag0ZDSwusB2ZOxSEH/DyeZRO8KbXKgEo8GECUMEcYoZiwa3kdt/EBmruZwSpSwyinsXWk6wMhyidlT50LN0W5K83irR1WrVrnQTPOO21OzbAvVyTdBSkCDpROmsKWfQoxIzYzc8I8le9vvtUmhZZGPU0YrWMafpYLffEMHMeP6TSfDxPfurK+JrciUNGqLd6/fpx7oj69MAVbQ4m0qL0hI9y3PBY/ei942hRbfbAqjxNxi7kNLExnK/pUZTCNugY1ozUphbzMyn1/vHFL3bMUGmYXYtSkrdo9fHfLb3Ypxe/pFsMuH08GkcUmtzM+j1wpNCi26sMuJmuX06O+N+oaNCLKSyT+aQC2QGXVKqTpxTTokE9c9lSh/DT+PgJQS3dFUbMCq1uA4qrNqRWsg1XR7F/xvlEiGtJ+u4bPZDA06r+31b7xajesgQ94qFGePik9RjxK/CgzLW8lTJT2yz//Kzvd0Xv/l8N1qtyLoGZXIi3+n1oBgrJZDJ5kpKJYH+mstrRSuuaYPYPrzQpahVO2JCqMW1mkwoz16T6e9dt55v3qdoU9QQPAUxo4o8zrgFBrHKl1RRbMpNFeSeNIHCcDkFJgFvLGrJBFilBEyUBhc2oHHOcdGFVzhhhfDlyMnavU/6WCOzmBzYh82719970dntd/qfX+x+Ntj/7eDlZ91+v//XqB3dZM6nZdVkFqNmdIe/izz5WfZBycYCL1TxOLdrTLjG2F4X+t7IfOjARZXzM5XwSSgO5nFRYzHLBbN4ze9NRfUuDULgBpQUS2BzxgXpCYsUpet2qjDhBoJPYaJVBgxKDl0ncGHVtcaMy4+djPVAPUdLAUTmop/evEBcMmZ5DCUr04VA6jSkXxJuHLFNMYPniQ9HGGPK5lzpnXvD0bO7VjJGOo04p8Zgq8BvCvnWPXZNGFsaGKNdUEfYkO2CjlJlPl/KK/ut2YSoTK30mpR9yiwbcdioQZsZPVo18zyXLkGUvcj1Xr9/vR+y1X5/f7snOcNcaQtS2drhv/rpmhLUWt1bZOrYu1+Ch5Ta7+9fv6yUermt1ImcM8ETODg9gQs1Q/nzatTc3vrtt33KPZF7H60p23xe1pm40Nwu3eRw02E57/j3gw9X1HpmaFMVxg43atg0GkS95gTSuw2jxioifnpeDiIuJ1UtmGEyGaubrspRUi0QbGyoQPZYznvz3e5eRN31+hqW50+ix6Lz1CXGsimX00+tu6pNdU7u9B5bM1jdrOT8T0jdSvBHkypMDCky1yut6O+JcouDl97lKM+pPSQfu823sAEoab7/278rMho/v4RWi2Y6UqRjVKFjdAOn48eEK7iW/3/i/P67f8K44MK6wpvgHAVFomlT0jDWT6EoLepcc4OmSwPsUDb3nfI5GliqwlV8P7u1ab5PipgE7WhkyRKwUw3gQGmcKhLYVKtimgID6gYEtuHs6PyCppeD0xPKxDJpzKMkYsWkDRmTbIpVWXAys3jmSKi38JAFgQ0aqb3gGbb95O6zPpLQmrTjulF4BJ9gvIyFNw5BCIQlqMLCHGWiNAgVzzpcujm/0+nQj2fP4BitpV3PLdMWE3p6RFnfARBoLGSFsRAzrZd+3+rokoRU+kaN+BiBjwy3yWg0GsrGywH8jjjUD74MNEPZan3/93/Ah6/VghL/FCXNgLix4dXzMugTFZvtaKenvRRF3jv3SpnewemJy3I73v9vlQVDnlykqF2RHOOUy9/DpXF1ElqtcMwB5ZxrJcm0rRY8Hz06DYx2iG+ulVUOmii9wCYTjJ2pBUVwwizbcMWh0giHLGdjLjglVXp+B4fM4lTpJdzBe4JcKGSpX00U3A3lXafTcf+ItNWq4JlWC+7g0HUibaDuug2+B2xTh6pmIaYSpLivw7NTur0O38D5ooxXx/kPBRcJaCxCj1G+9ABWrrGTCxY7QCuZojVfOBnIMkoiKE2nYFm132GLcxSTDp1Pt8VxGQWGHof2uxarsmvgAlzOuXWVCyZCLUqmp8VY8BjWxT9PCQZjkPuX5dETXM7c8ZGq5OqAygqMK63ssMX3Ss9oJ8+RgLBaOqUbNmHGo5HGmXzCJRPchMaMKHTJ91BJy+LgvD/7POHOQBAm9u9hrNTMQ5Esc30gIxQxMHnt5ljP452eMkl71ZJxaXiCVQqGV5rC0Q+/lSfe4zhVauaZnGGMREPpqEPpCHBOGUcqW7fd4CPTTUGAMskVl7Zkd2lKgWoIOI5VIa2zSExjgAWqJNTukwfv1o8GBf733/3LwFtcUN4pCwa9fAYH1rI4dVnwvQs3OC9yap2GkqrJiFXvzSgEJLWZUi3AeEKPPHvIuDRVOzTyjQeeoHRsRVA/IG1CTJUPKX956JZE/Zpsf+69eR6i7g2XMzOU1L+PhlHKEz/G0hzsKa6Fo4gGfg648z3+iEQenb47v4CeE6yUc0THjNiUYdMMb1Om7XVloWwhu7VZD2kiQV0dndJ5TAzl6PjoAnqljr0BT0ZO+fXndHhGTdDbamSZh4npmGlMCpkwaaHGgB1ArTFT8wBYt1q5xgkXwuXM0nEabaGJj0Faa1Es/cAVdK4ZtlpUc2dkgAqIBGSGoyZDxUqaIsPKQ6fMmIXSCd0TWIwpNE5fva4jit6TnwjOu84D8TAalXYtE+hYJUs/3yyUdru71Igy1ss8cKWprRGAg6EM/vSBVZpxBP/9D4xOL7cs7h43FpTe7A0aY2uTbCNONl5s7OdeUPIlk45K+7zzSEsVvZSztBJV/G7jMQ8F7qaiLobu0ZRm3xsaTThdxIQxmFq/MOSG/apQp54LWZzW03cpfzh8Z0pQgXX5IZShEfjBxsUXXYzklLFJp3AcCZYjT084igRYrJUxrtNyWlDa0qqw6OZdjQhE7+O5SjMDX9Npd6qifhgv9FYlDzKNoFVO7juuJrhmLHSrlHIJjrWuptZtashwng+BUcSnSuNmHa8gQ3nIyg/nofqFsg3Om2XhG7E812ru2R0y6U82FfKSHG/IaqEme2lC7XSb3VWphemxknBISNvzw8MdEo7nnDL0UB6AxAWZPY5ra2/la0Y3WK6UkT54w41rrkbDaNxcp2Qjf9eJ2mc/iraqu6i82PONUuXMI8JNgSUJ3fSgcS0BJnTeKxl1KJGMOuWxkh2HITYLJDj0FQhZ2QaMyqujLrzhM6x1aJP4a9LAc1PEKXUU/pTUJ54nox3qCeY8CXbwopG/NE+C36uqNGeiwLar5D5LkWUFJ8MaB29muV2Cw63h+ejD1WjnC1CEjxIXb1qrgMsUdXi4znqjtz2oILOjurEODW7jCZ0Jul+4PHtzT3N77ntv10g8oSGvOsFqtlvn8ODoXK0+uoQznG4t/tTIPtpsZf6C2nDlktSv4Q8sni2YTgzQNTKz3LX+SyKlxRQc/oZ4XBJ24kAo/GgB810XxvPd7m41+ZX9l/El0abKIMz9xj4h1RAm3bgTOjcu7e64SgVjjb5qximTUzoI1Hw1CjWnxJ8UsT8LTl5irdyczwQUUtA1uyKkfUFNKF04JRuBcWmQ5ubQAw1lBz5Urel7HBtusZ77FovFlqV33JrXhRDV3bQ7cJ+YFv2yY26/LsZAQJvhVullvWrKbVqMnS+ba6s/AoNySKkAtR8zpTqWF6gzQ2DqOeo5jz+hfs8SeW/H3bRv4DnrsIvGCWrKO2ZtxmY5D/P8h1IOIPF+jB6E2oVZxQGD/uKJgKWvNvk4gI9UeDcJ+gZw62F9o3YkeIzSYAM4PDg+fQPzF91+1G6gZI/wZe/NyeHR2/MjEiYck2gQ7Xb73b67/1LGZkw2djrG+qMUPyL63tNBN5uA120NsP7yXcwv38VU38UEuNXije3lgnEHdoeLMA9Uf4g2PpUZlF/FXLWjVBlLJLe3FCKXWqxW9Nh/zEH4deiN6885ZrhsfHziyrS/R/sobfhKpCa9oj80J9r79/ho5D8/C57bgcd8tnOvcUqAWi6bQpXClrZZXa3aJUJNMvq3B66hb6zbuupYuy84PrqI3HVduo6MzxwyHn4h7vfKtA6ZewHofzL1vQtubz3qvlpV9P7VR1cEBUtqMtDVarX6H3Ob6Do=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-2",custom_edit_url:null},j=void 0,y={},U=[{value:"Document Types:",id:"document-types",level:3}];function f(e){const t={h3:"h3",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(x.default,{as:"h1",className:"openapi__heading",children:"Get Document list from status"}),"\n",(0,i.jsx)(l(),{method:"get",path:"/documentlist/{doctype}",context:"endpoint"}),"\n",(0,i.jsx)(t.h3,{id:"document-types",children:"Document Types:"}),"\n",(0,i.jsx)(t.p,{children:"Retrieve a list of documents based on type"}),"\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"Draft Documents:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Documents that are currently in draft status."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"In-Progress Documents:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Documents that are currently in progress."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"Completed Documents:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Documents that have been successfully completed with all required signatures."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"Expired Documents:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Documents that have expired and are no longer accessible."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"Declined Documents:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Documents that have been declined by the user."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(x.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,i.jsx)(g.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,i.jsx)(p(),{...n(17331)}),"\n",(0,i.jsx)(d(),{...n(81553)}),"\n",(0,i.jsx)(m(),{...n(72791)})]})}function b(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}},17331(e){e.exports=JSON.parse('{"parameters":[{"name":"doctype","in":"path","description":"The type of documents to retrieve","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["draft","inprogress","completed","expired","declined"]}},{"name":"limit","in":"query","required":false,"style":"form","explode":true,"schema":{"maximum":500,"type":"number"},"example":10},{"name":"skip","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"number"},"example":0}]}')},81553(e){e.exports={title:"Body"}},72791(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"FGik23bhUJ"},"file":{"type":"string","format":"string","example":"https://exampleurl.com"},"title":{"type":"string","format":"string","example":"sample doc"},"note":{"type":"string","format":"string","example":"please sign document"},"folder":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"FGik23bhUJ"},"name":{"type":"string","format":"string","example":"folder name"}},"title":"document_folder"},"owner":{"type":"string","format":"string","example":"joe bee"},"signers":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","example":"ceo"},"name":{"type":"string","example":"joe bee"},"email":{"type":"string","example":"joebee@example.com"},"phone":{"type":"string","example":"456213871"}}}},"sendInOrder":{"type":"boolean","example":true},"send_in_order_strict":{"type":"boolean","example":false},"allow_offline_sign":{"type":"boolean","description":"Whether signers can submit a copy of this document signed using an external tool for owner review. Defaults to false.","example":false},"createdAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"enableTour":{"type":"boolean","example":true},"redirect_url":{"type":"string","format":"string","example":""},"allow_modifications":{"type":"boolean","example":false},"template_id":{"type":"string","example":"template_id is only available when the document is created from a template."},"auto_reminder":{"type":"boolean","description":"Set to true to enable automatic reminders. Set to false to disable them (default behavior).","example":false},"remind_once_in_every":{"type":"number","description":"Number of days between reminders. This is only applicable when auto_reminder is set to true.","example":0}},"xml":{"name":"document"},"title":"document"}}},"title":"inline_response_200_4"}}}},"404":{"description":"Report not available!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Report not available!"}},"title":"inline_response_404_5"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/63ead021.b9ad96e9.js b/assets/js/63ead021.b9ad96e9.js new file mode 100644 index 000000000..c0f09c3ae --- /dev/null +++ b/assets/js/63ead021.b9ad96e9.js @@ -0,0 +1 @@ +(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[8763],{57e3(e,n,t){"use strict";t.r(n),t.d(n,{assets:()=>p,contentTitle:()=>h,default:()=>j,frontMatter:()=>c,metadata:()=>i,toc:()=>u});const i=JSON.parse('{"id":"API-docs/v1.1/opensign-api-v-1-2","title":"OpenSign API v1.2","description":"# OpenSign\u2122 API v1.2","source":"@site/docs/API-docs/v1.1/opensign-api-v-1-2.info.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/opensign-api-v-1-2","permalink":"/docs/API-docs/v1.1/opensign-api-v-1-2","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","sidebarPosition":0,"frontMatter":{"id":"opensign-api-v-1-2","title":"OpenSign API v1.2","description":"# OpenSign\u2122 API v1.2","sidebar_label":"Introduction","sidebar_position":0,"hide_title":true,"custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"v1.1","permalink":"/docs/API-docs/v1.1"},"next":{"title":"Get your account details","permalink":"/docs/API-docs/v1.1/get-user"}}');var s=t(74848),r=t(28453),o=(t(43905),t(51107)),l=t(23397),d=t.n(l),a=t(19365);t(69016);const c={id:"opensign-api-v-1-2",title:"OpenSign API v1.2",description:"# OpenSign\u2122 API v1.2",sidebar_label:"Introduction",sidebar_position:0,hide_title:!0,custom_edit_url:null},h="OpenSign\u2122 API v1.2",p={},u=[{value:"Getting Started",id:"getting-started",level:2},{value:"Core Capabilities",id:"core-capabilities",level:2},{value:"What\u2019s New in v1.2",id:"whats-new-in-v12",level:2},{value:"Attachment Widget Support",id:"attachment-widget-support",level:3},{value:"Hide Signer Signing Links",id:"hide-signer-signing-links",level:3},{value:"Cleaner Template Retrieval",id:"cleaner-template-retrieval",level:3},{value:"Password-Protected PDF Support",id:"password-protected-pdf-support",level:3},{value:"Offline Signing Control",id:"offline-signing-control",level:3},{value:"Signer Roles",id:"signer-roles",level:3},{value:"Carbon Copy (CC) Recipients",id:"carbon-copy-cc-recipients",level:3},{value:"Available Environments",id:"available-environments",level:2},{value:"Versioning & Backwards Compatibility",id:"versioning--backwards-compatibility",level:2},{value:"Useful Links",id:"useful-links",level:2}];function x(e){const n={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",li:"li",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)("span",{className:"theme-doc-version-badge badge badge--secondary",children:"Version: 1.0.0"}),"\n",(0,s.jsx)(o.default,{as:"h1",className:"openapi__heading",children:"OpenSign API v1.2"}),"\n",(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"opensign-api-v12",children:"OpenSign\u2122 API v1.2"})}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"The open-source DocuSign alternative \u2014 built for developers, trusted by enterprises."})}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"OpenSign\u2122 gives you a complete, production-ready e-signature platform through a single, RESTful API. Send documents for signature, manage templates, track signing status in real time, and automate your entire document lifecycle \u2014 all without vendor lock-in."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h2,{id:"getting-started",children:"Getting Started"}),"\n",(0,s.jsxs)(n.p,{children:["Every request must carry your API token in the ",(0,s.jsx)(n.code,{children:"x-api-token"})," header."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:"x-api-token: \n"})}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsxs)(n.strong,{children:["\u2192 ",(0,s.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/Settings/APIToken",children:"How to generate your API token"})]})}),"\n",(0,s.jsxs)(n.p,{children:["Not sure where to begin? Use the ",(0,s.jsx)(n.strong,{children:"sandbox environment"})," (",(0,s.jsx)(n.code,{children:"https://sandbox.opensignlabs.com/api/v1.2"}),") to prototype without affecting live data."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h2,{id:"core-capabilities",children:"Core Capabilities"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Category"}),(0,s.jsx)(n.th,{children:"What you can do"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.strong,{children:"Documents"})}),(0,s.jsx)(n.td,{children:"Create, send, update, revoke, and delete signature-request documents"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.strong,{children:"Templates"})}),(0,s.jsx)(n.td,{children:"Build reusable templates with pre-placed widgets; send to one or many signers"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.strong,{children:"Self-Sign"})}),(0,s.jsx)(n.td,{children:"Generate self-signed documents without a signer invitation flow"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.strong,{children:"Public Templates"})}),(0,s.jsx)(n.td,{children:"Share a public signing link \u2014 no signer list required"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.strong,{children:"Draft Workflow"})}),(0,s.jsx)(n.td,{children:"Save documents or templates as drafts and finalise them later"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.strong,{children:"Contacts"})}),(0,s.jsx)(n.td,{children:"Manage your signer contact book programmatically"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.strong,{children:"Folders"})}),(0,s.jsx)(n.td,{children:"Organise documents inside OpenSign Drive folders"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.strong,{children:"Webhooks"})}),(0,s.jsx)(n.td,{children:"Receive real-time event notifications at your own endpoint"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.strong,{children:"Users"})}),(0,s.jsx)(n.td,{children:"Retrieve account and credit information"})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h2,{id:"whats-new-in-v12",children:"What\u2019s New in v1.2"}),"\n",(0,s.jsx)(n.h3,{id:"attachment-widget-support",children:"Attachment Widget Support"}),"\n",(0,s.jsxs)(n.p,{children:["The ",(0,s.jsx)(n.code,{children:"attachments"})," widget is now supported on draft document, create document, draft template, create template, and public template APIs."]}),"\n",(0,s.jsx)(n.h3,{id:"hide-signer-signing-links",children:"Hide Signer Signing Links"}),"\n",(0,s.jsxs)(n.p,{children:["Set ",(0,s.jsx)(n.code,{children:'"hide_signer_signing_links": true | false'})," on ",(0,s.jsx)(n.code,{children:"POST /draftdocument"})," to hide signer signing links in the draft document response."]}),"\n",(0,s.jsx)(n.h3,{id:"cleaner-template-retrieval",children:"Cleaner Template Retrieval"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"GET /template/:id"})," and ",(0,s.jsx)(n.code,{children:"GET /templatelist"})," have been streamlined \u2014 redundant parameters are removed and ",(0,s.jsx)(n.strong,{children:"prefill data is now returned separately from signer parameters"}),", making responses easier to consume."]}),"\n",(0,s.jsx)(n.h3,{id:"password-protected-pdf-support",children:"Password-Protected PDF Support"}),"\n",(0,s.jsxs)(n.p,{children:["Pass ",(0,s.jsx)(n.code,{children:'"file_password"'})," in the request body when working with encrypted PDFs. Supported on:\n",(0,s.jsx)(n.code,{children:"POST /createtemplate"})," \xb7 ",(0,s.jsx)(n.code,{children:"PUT /template/:id"})," \xb7 ",(0,s.jsx)(n.code,{children:"POST /createdocument/:template_id"})," \xb7 ",(0,s.jsx)(n.code,{children:"POST /draftdocument"})," \xb7 ",(0,s.jsx)(n.code,{children:"POST /drafttemplate"})," \xb7 ",(0,s.jsx)(n.code,{children:"POST /selfsign"})]}),"\n",(0,s.jsx)(n.h3,{id:"offline-signing-control",children:"Offline Signing Control"}),"\n",(0,s.jsxs)(n.p,{children:["Set ",(0,s.jsx)(n.code,{children:'"allow_offline_sign": true | false'})," on ",(0,s.jsx)(n.code,{children:"POST /createtemplate"})," and ",(0,s.jsx)(n.code,{children:"PUT /template/:id"})," to explicitly enable or disable offline signing for each template."]}),"\n",(0,s.jsx)(n.h3,{id:"signer-roles",children:"Signer Roles"}),"\n",(0,s.jsxs)(n.p,{children:["The ",(0,s.jsx)(n.code,{children:"signers"})," object now accepts a ",(0,s.jsx)(n.code,{children:'"signer_role"'})," field across all creation routes. Three roles are supported:"]}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Role"}),(0,s.jsx)(n.th,{children:"Behaviour"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.code,{children:"signer"})," ",(0,s.jsx)(n.em,{children:"(default)"})]}),(0,s.jsx)(n.td,{children:"Must complete at least one signature widget"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"viewer"})}),(0,s.jsx)(n.td,{children:"Receives the document for review only \u2014 no widgets allowed"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"approver"})}),(0,s.jsx)(n.td,{children:"Can have any widgets except a signature requirement"})]})]})]}),"\n",(0,s.jsx)(n.h3,{id:"carbon-copy-cc-recipients",children:"Carbon Copy (CC) Recipients"}),"\n",(0,s.jsxs)(n.p,{children:["A new ",(0,s.jsx)(n.code,{children:'"cc"'})," field is now supported alongside the existing ",(0,s.jsx)(n.code,{children:'"bcc"'})," field on document, template, draft and self-sign creation/update routes. Email addresses listed in ",(0,s.jsx)(n.code,{children:'"cc"'})," receive a carbon-copy notification email once the document is completed. Like ",(0,s.jsx)(n.code,{children:'"bcc"'}),", on update routes (such as ",(0,s.jsx)(n.code,{children:"PUT /document/:id"}),") providing ",(0,s.jsx)(n.code,{children:'"cc"'})," overrides the template value, even when supplied as an empty array (",(0,s.jsx)(n.code,{children:"[]"}),"); omit the field to inherit the template value."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h2,{id:"available-environments",children:"Available Environments"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Environment"}),(0,s.jsx)(n.th,{children:"Base URL"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.strong,{children:"Sandbox"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"https://sandbox.opensignlabs.com/api/v1.2"})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.strong,{children:"Production"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"https://app.opensignlabs.com/api/v1.2"})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.strong,{children:"EU Region"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"https://eu-app.opensignlabs.com/api/v1.2"})})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h2,{id:"versioning--backwards-compatibility",children:"Versioning & Backwards Compatibility"}),"\n",(0,s.jsx)(n.p,{children:"v1.2 is fully backwards-compatible with v1 and v1.1 \u2014 all endpoints from those versions are available on this base URL with no breaking changes. New parameters introduced in v1.2 are optional unless otherwise noted."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h2,{id:"useful-links",children:"Useful Links"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"https://www.opensignlabs.com",children:"OpenSign Website"})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"https://docs.opensignlabs.com",children:"Full Documentation"})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"https://github.com/opensignlabs/opensign",children:"GitHub Repository"})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/Settings/APIToken",children:"Generate API Token"})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"https://www.opensignlabs.com/terms/",children:"Terms of Service"})}),"\n"]}),"\n",(0,s.jsxs)("div",{style:{marginBottom:"2rem"},children:[(0,s.jsx)(o.default,{id:"authentication",as:"h2",className:"openapi-tabs__heading",children:"Authentication"}),(0,s.jsx)(d(),{className:"openapi-tabs__security-schemes",children:(0,s.jsx)(a.default,{label:"API Key: x-api-token",value:"x-api-token",children:(0,s.jsx)("div",{children:(0,s.jsx)("table",{children:(0,s.jsxs)("tbody",{children:[(0,s.jsxs)("tr",{children:[(0,s.jsx)("th",{children:(0,s.jsx)(n.p,{children:"Security Scheme Type:"})}),(0,s.jsx)("td",{children:(0,s.jsx)(n.p,{children:"apiKey"})})]}),(0,s.jsxs)("tr",{children:[(0,s.jsx)("th",{children:(0,s.jsx)(n.p,{children:"Header parameter name:"})}),(0,s.jsx)("td",{children:(0,s.jsx)(n.p,{children:"x-api-token"})})]})]})})})})})]}),"\n",(0,s.jsxs)("div",{style:{display:"flex",flexDirection:"column",marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,s.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,s.jsx)(n.p,{children:"Contact"})}),(0,s.jsx)("span",{children:(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"mailto:api@opensignlabs.com",children:"api@opensignlabs.com"})})})]}),"\n",(0,s.jsxs)("div",{style:{marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,s.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,s.jsx)(n.p,{children:"Terms of Service"})}),(0,s.jsx)("a",{href:"http://www.opensignlabs.com/terms/",children:"http://www.opensignlabs.com/terms/"})]}),"\n",(0,s.jsxs)("div",{style:{marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,s.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,s.jsx)(n.p,{children:"License"})}),(0,s.jsx)("a",{href:"http://github.com/opensignlabs/opensign/LICENSE",children:(0,s.jsx)(n.p,{children:"AGPL v3.0"})})]})]})}function j(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(x,{...e})}):x(e)}},69016(e,n,t){"use strict";var i=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(n,"__esModule",{value:!0});const s=i(t(96540)),r=i(t(4213));n.default=function({url:e,proxy:n}){return s.default.createElement("div",{style:{float:"right"},className:"dropdown dropdown--hoverable dropdown--right"},s.default.createElement("button",{className:"export-button button button--sm button--secondary"},"Export"),s.default.createElement("ul",{className:"export-dropdown dropdown__menu"},s.default.createElement("li",null,s.default.createElement("a",{onClick:n=>{n.preventDefault(),(e=>{let n;(e.endsWith("json")||e.endsWith("yaml")||e.endsWith("yml"))&&(n=e.substring(e.lastIndexOf("/")+1)),r.default.saveAs(e,n||"openapi.txt")})(`${e}`)},className:"dropdown__link",href:`${e}`},"OpenAPI Spec"))))}},43905(e,n,t){"use strict";var i=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(n,"__esModule",{value:!0}),n.default=function(e){const{colorMode:n}=(0,r.useColorMode)(),{logo:t,darkLogo:i}=e,d=()=>"dark"===n?i?.altText??t?.altText:t?.altText,a=(0,o.default)(t?.url),c=(0,o.default)(i?.url);if(t&&i)return s.default.createElement(l.default,{alt:d(),sources:{light:a,dark:c},className:"openapi__logo"});if(t||i)return s.default.createElement(l.default,{alt:d(),sources:{light:a??c,dark:a??c},className:"openapi__logo"});return};const s=i(t(96540)),r=t(83262),o=i(t(86025)),l=i(t(15626))},4213(e,n){var t,i,s;i=[],void 0===(s="function"==typeof(t=function(){"use strict";function n(e,n){return void 0===n?n={autoBom:!1}:"object"!=typeof n&&(console.warn("Deprecated: Expected third argument to be a object"),n={autoBom:!n}),n.autoBom&&/^\s*(?:text\/\S*|application\/xml|\S*\/\S*\+xml)\s*;.*charset\s*=\s*utf-8/i.test(e.type)?new Blob(["\ufeff",e],{type:e.type}):e}function t(e,n,t){var i=new XMLHttpRequest;i.open("GET",e),i.responseType="blob",i.onload=function(){l(i.response,n,t)},i.onerror=function(){console.error("could not download file")},i.send()}function i(e){var n=new XMLHttpRequest;n.open("HEAD",e,!1);try{n.send()}catch(e){}return 200<=n.status&&299>=n.status}function s(e){try{e.dispatchEvent(new MouseEvent("click"))}catch(t){var n=document.createEvent("MouseEvents");n.initMouseEvent("click",!0,!0,window,0,0,0,80,20,!1,!1,!1,!1,0,null),e.dispatchEvent(n)}}var r="object"==typeof window&&window.window===window?window:"object"==typeof self&&self.self===self?self:"object"==typeof globalThis&&globalThis.global===globalThis?globalThis:void 0,o=r.navigator&&/Macintosh/.test(navigator.userAgent)&&/AppleWebKit/.test(navigator.userAgent)&&!/Safari/.test(navigator.userAgent),l=r.saveAs||("object"!=typeof window||window!==r?function(){}:"download"in HTMLAnchorElement.prototype&&!o?function(e,n,o){var l=r.URL||r.webkitURL,d=document.createElement("a");n=n||e.name||"download",d.download=n,d.rel="noopener","string"==typeof e?(d.href=e,d.origin===location.origin?s(d):i(d.href)?t(e,n,o):s(d,d.target="_blank")):(d.href=l.createObjectURL(e),setTimeout(function(){l.revokeObjectURL(d.href)},4e4),setTimeout(function(){s(d)},0))}:"msSaveOrOpenBlob"in navigator?function(e,r,o){if(r=r||e.name||"download","string"!=typeof e)navigator.msSaveOrOpenBlob(n(e,o),r);else if(i(e))t(e,r,o);else{var l=document.createElement("a");l.href=e,l.target="_blank",setTimeout(function(){s(l)})}}:function(e,n,i,s){if((s=s||open("","_blank"))&&(s.document.title=s.document.body.innerText="downloading..."),"string"==typeof e)return t(e,n,i);var l="application/octet-stream"===e.type,d=/constructor/i.test(r.HTMLElement)||r.safari,a=/CriOS\/[\d]+/.test(navigator.userAgent);if((a||l&&d||o)&&"undefined"!=typeof FileReader){var c=new FileReader;c.onloadend=function(){var e=c.result;e=a?e:e.replace(/^data:[^;]*;/,"data:attachment/file;"),s?s.location.href=e:location=e,s=null},c.readAsDataURL(e)}else{var h=r.URL||r.webkitURL,p=h.createObjectURL(e);s?s.location=p:location.href=p,s=null,setTimeout(function(){h.revokeObjectURL(p)},4e4)}});r.saveAs=l.saveAs=l,e.exports=l})?t.apply(n,i):t)||(e.exports=s)}}]); \ No newline at end of file diff --git a/assets/js/64218a31.2dc08ef1.js b/assets/js/64218a31.2dc08ef1.js deleted file mode 100644 index bf80092a1..000000000 --- a/assets/js/64218a31.2dc08ef1.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[3979],{90207(e,t,a){a.r(t),a.d(t,{assets:()=>I,contentTitle:()=>j,default:()=>y,frontMatter:()=>u,metadata:()=>n,toc:()=>b});const n=JSON.parse('{"id":"API-docs/v1.1/getformdata","title":"Get Formdata","description":"The Get Formdata API enables you to retrieve widget data filled by signers who signed the document.","source":"@site/docs/API-docs/v1.1/getformdata.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/getformdata","permalink":"/docs/API-docs/v1.1/getformdata","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getformdata","title":"Get Formdata","description":"The Get Formdata API enables you to retrieve widget data filled by signers who signed the document.","sidebar_label":"Get Formdata","hide_title":true,"hide_table_of_contents":true,"api":"eJzVWM1u3MgRfpVKX3Y9oGck2XvhabUbraLEsAVLhg7yQGiSNWRbze7e7uKMBgMCe9g3yCnXPJqfJKgmOcMZyXaEJAtEB4mqrv+fro/cCJJlEOmt+LPNmxoNBTFPRIEh98qRskak4rpCOEeCX6yvC0kSTi8vAI3MNAZY2wbIgkfyCpcIK1WUSBD5FkprLCBbQ1ClQR9gVdnuuQCqEIre6PSj+WjeWsIUrisVogEVwBq9BrmUSrMtWFgP1yjrANIUcGYIvfMqIDgtTZh+NCIR1qGX7PdFIVJRIi16p0UinPSyRkLPAW+EkTWKVAw+3KlCJEJxwE5SJQ6zYLNPmNNFAXYBQ7JEIjz+2iiPhUjJN5iIQGvNaoOqnUaRCHxw2hYo0oXUgRnyCmsp0o2gtYuc5JUpRSLYVUljCj7IqCUV8qeTPD+pXFaJtp2z2eCsCRhY0cnREf/Z9zc0eY4hLBoN26SIROTWEHueboR0Tqs8Hsw+BRbaPPauC5uz51kNqc7kkI3nxvHLubo/eZVVH/4q2kSQIqY+T0WID9w7rCJw6QpJz1ZzfDw7Pp6dHJ38ENWQpCY8V0du+YGwYBXMeBdbbadFei/X3FaEdfh2VruWfOzDzuInm0GGyPawlkp/kztD/LEjTHNbs1w3oeF/7WVX23bXql8XydGKln8S8VDrnZlRWncNMyY+LcFn7wfDB4L7Z1HB66cm6MrWSJUyJazQEKy8NWUCTqMMCOTXIEupDGhJ6P/03xst9N76ryfreZ61o/iV0crg3VCTu9dHR3fH2yS8fpyE4aoDYwkWtjHFHxvqU/a/HtDru1fbgH54HNCFWUqtirhjru09mj82nrF56sw/7mDVMcVzsRfsmN4FGTBvvKJ13GkPL6VTL7vz9HbOm4I7xfbLMC5BqkQqZsMgzDajBdgK1ueXw4psvBapqIhcSGezIE2R2YepdWh4iWuZBb5UZtKp2fJ4eiza5FBGOvcsfmxePlckkCyVKb8lN9+l6orL2VVsL2G7C9GpvyHfiH09xlw9RqhQFuhj7ZRZ2CjcV+mdQ3OlShNrHI0fYokb1LmtkYETw6DJZBD5/Ps/t1KTyRYfxW6MIOld48HZFXre6wyDFhofFKOjCMrqeLZFZQFlrTEEvQZlCEsvCaFQpSKpIw7jKySXTmZKK25iZrMs7WE0B2EKNxVShZ6PvvMIEgpcoubeB9mQrSWxqsFfWFl/v9B2FRKQkDVBGQwB0FTS5Mw4VCIB60EawB2YC+TZa9X5Zg15mRPU0sgSWXcC42QVqBW3K3ibNYEgWN1El4Gk0tYz0OwDMohFiEk8Y0jmEZjKK9xjxW2zRCgbVWBIILcFQgc0OARTQIaBwLEvKsfAShujbX4fC7hotAZn+QpRUjNCHPvI4uSlCTxznS9DDbYJc94yWsPOwcnkQ0Cu8Btl7kM6mXw0L+F221c3mAVFOP9+GIHVavWo9V/sy5wr+kuTwXt0Niiyfr2TLhVVTRbHZaxk+0+n6RwNxv4ZDcNOR2Hz8Hj6mDqrULvZFRJ3SJidXl7EW/cFfP7t7/AGpTdQ2VXXrXnjUa+hHExx5rrKd2nbXprxXUA2VHHG8675GIljoCGDN5Wkz7/9I8BbXIEy/UhxKJPJZZNplcM11o53ZJhMUvjZI5ukgQZUSYJcGsgQQiW5lZZKggTXSWtl7qdwatbQBPSwUlTFZmB6lNsLg/OyLXeATAYswJooMdic7jxieh1QLzGwLl5+GQIWiuKrk7dN2VkbO9MH55FfvOCmw3kc22lRgOvJPfzjhI/cwQUPBFW4BukRGFVP4fJAJJ40zlnPXqjO+YXV2q64AGgKZ5WhkELh5YJ2+pNdo+ecZmXNE6QuhXKbjqRXsy1JN4l9xFtq9+J3cJHv37ceF+jZYAx7Vxen+na6HdoSuFv/k7bmdc23lswjmuhBOm+UHw/1xM2Ovg7vFlfolyrHfqt9YaJnkXkmEqFVjj2i7jfU6fnlG1i+mh6JZLQe/43hnr25+Pns7dUZO8MXaZew4+nR9IhJzgaqpRlZGn8JOFxsmx2Q+r/6atCvfcIHmjktVQRdMY2bHjDditGHhHT8zWCeiMoGYpbNhsf6g9dty+RfG/QMy+aJWEqv2JuIqgoV+LnYfhL4Yg6/f99/XXgBX/j88KTnA4oxDGGWUjf8n0jEPa4PPni08zYZoAy71nGc5jk6Gsk+wsR7wPL87Fokgm/jfQh1HyFU/8Dan/RrH1t1DvBvBnpPCmw2HTxr2y1/d/RFiT7AgZuTNG/b9l+41KqK","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Signer IPs","permalink":"/docs/API-docs/v1.1/getsignerips"},"next":{"title":"Get Signing Links","permalink":"/docs/API-docs/v1.1/getsigninglinks"}}');var s=a(74848),o=a(28453),r=a(57742),i=a.n(r),l=a(78178),p=a.n(l),d=a(19624),c=a.n(d),m=a(96226),g=a.n(m),h=(a(77675),a(19365),a(51107)),f=a(21312);const u={id:"getformdata",title:"Get Formdata",description:"The Get Formdata API enables you to retrieve widget data filled by signers who signed the document.",sidebar_label:"Get Formdata",hide_title:!0,hide_table_of_contents:!0,api:"eJzVWM1u3MgRfpVKX3Y9oGck2XvhabUbraLEsAVLhg7yQGiSNWRbze7e7uKMBgMCe9g3yCnXPJqfJKgmOcMZyXaEJAtEB4mqrv+fro/cCJJlEOmt+LPNmxoNBTFPRIEh98qRskak4rpCOEeCX6yvC0kSTi8vAI3MNAZY2wbIgkfyCpcIK1WUSBD5FkprLCBbQ1ClQR9gVdnuuQCqEIre6PSj+WjeWsIUrisVogEVwBq9BrmUSrMtWFgP1yjrANIUcGYIvfMqIDgtTZh+NCIR1qGX7PdFIVJRIi16p0UinPSyRkLPAW+EkTWKVAw+3KlCJEJxwE5SJQ6zYLNPmNNFAXYBQ7JEIjz+2iiPhUjJN5iIQGvNaoOqnUaRCHxw2hYo0oXUgRnyCmsp0o2gtYuc5JUpRSLYVUljCj7IqCUV8qeTPD+pXFaJtp2z2eCsCRhY0cnREf/Z9zc0eY4hLBoN26SIROTWEHueboR0Tqs8Hsw+BRbaPPauC5uz51kNqc7kkI3nxvHLubo/eZVVH/4q2kSQIqY+T0WID9w7rCJw6QpJz1ZzfDw7Pp6dHJ38ENWQpCY8V0du+YGwYBXMeBdbbadFei/X3FaEdfh2VruWfOzDzuInm0GGyPawlkp/kztD/LEjTHNbs1w3oeF/7WVX23bXql8XydGKln8S8VDrnZlRWncNMyY+LcFn7wfDB4L7Z1HB66cm6MrWSJUyJazQEKy8NWUCTqMMCOTXIEupDGhJ6P/03xst9N76ryfreZ61o/iV0crg3VCTu9dHR3fH2yS8fpyE4aoDYwkWtjHFHxvqU/a/HtDru1fbgH54HNCFWUqtirhjru09mj82nrF56sw/7mDVMcVzsRfsmN4FGTBvvKJ13GkPL6VTL7vz9HbOm4I7xfbLMC5BqkQqZsMgzDajBdgK1ueXw4psvBapqIhcSGezIE2R2YepdWh4iWuZBb5UZtKp2fJ4eiza5FBGOvcsfmxePlckkCyVKb8lN9+l6orL2VVsL2G7C9GpvyHfiH09xlw9RqhQFuhj7ZRZ2CjcV+mdQ3OlShNrHI0fYokb1LmtkYETw6DJZBD5/Ps/t1KTyRYfxW6MIOld48HZFXre6wyDFhofFKOjCMrqeLZFZQFlrTEEvQZlCEsvCaFQpSKpIw7jKySXTmZKK25iZrMs7WE0B2EKNxVShZ6PvvMIEgpcoubeB9mQrSWxqsFfWFl/v9B2FRKQkDVBGQwB0FTS5Mw4VCIB60EawB2YC+TZa9X5Zg15mRPU0sgSWXcC42QVqBW3K3ibNYEgWN1El4Gk0tYz0OwDMohFiEk8Y0jmEZjKK9xjxW2zRCgbVWBIILcFQgc0OARTQIaBwLEvKsfAShujbX4fC7hotAZn+QpRUjNCHPvI4uSlCTxznS9DDbYJc94yWsPOwcnkQ0Cu8Btl7kM6mXw0L+F221c3mAVFOP9+GIHVavWo9V/sy5wr+kuTwXt0Niiyfr2TLhVVTRbHZaxk+0+n6RwNxv4ZDcNOR2Hz8Hj6mDqrULvZFRJ3SJidXl7EW/cFfP7t7/AGpTdQ2VXXrXnjUa+hHExx5rrKd2nbXprxXUA2VHHG8675GIljoCGDN5Wkz7/9I8BbXIEy/UhxKJPJZZNplcM11o53ZJhMUvjZI5ukgQZUSYJcGsgQQiW5lZZKggTXSWtl7qdwatbQBPSwUlTFZmB6lNsLg/OyLXeATAYswJooMdic7jxieh1QLzGwLl5+GQIWiuKrk7dN2VkbO9MH55FfvOCmw3kc22lRgOvJPfzjhI/cwQUPBFW4BukRGFVP4fJAJJ40zlnPXqjO+YXV2q64AGgKZ5WhkELh5YJ2+pNdo+ecZmXNE6QuhXKbjqRXsy1JN4l9xFtq9+J3cJHv37ceF+jZYAx7Vxen+na6HdoSuFv/k7bmdc23lswjmuhBOm+UHw/1xM2Ovg7vFlfolyrHfqt9YaJnkXkmEqFVjj2i7jfU6fnlG1i+mh6JZLQe/43hnr25+Pns7dUZO8MXaZew4+nR9IhJzgaqpRlZGn8JOFxsmx2Q+r/6atCvfcIHmjktVQRdMY2bHjDditGHhHT8zWCeiMoGYpbNhsf6g9dty+RfG/QMy+aJWEqv2JuIqgoV+LnYfhL4Yg6/f99/XXgBX/j88KTnA4oxDGGWUjf8n0jEPa4PPni08zYZoAy71nGc5jk6Gsk+wsR7wPL87Fokgm/jfQh1HyFU/8Dan/RrH1t1DvBvBnpPCmw2HTxr2y1/d/RFiT7AgZuTNG/b9l+41KqK",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},j=void 0,I={},b=[];function F(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Get Formdata"}),"\n",(0,s.jsx)(i(),{method:"get",path:"/formdata/{document_id}",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Get Formdata API enables you to retrieve widget data filled by signers who signed the document."}),"\n",(0,s.jsx)(t.p,{children:"Note: This API is only available for Teams and Enterprise plans."}),"\n",(0,s.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(f.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(p(),{...a(48632)}),"\n",(0,s.jsx)(c(),{...a(21690)}),"\n",(0,s.jsx)(g(),{...a(68816)})]})}function y(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(F,{...e})}):F(e)}},48632(e){e.exports=JSON.parse('{"parameters":[{"name":"document_id","in":"path","description":"objectId of Document","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"aB2cc2hpbh"}}]}')},21690(e){e.exports={title:"Body"}},68816(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"FGik23bhUJ"},"title":{"type":"string","format":"string","example":"sample doc"},"sent_date":{"type":"string","format":"string","example":"11/11/2025"},"status":{"type":"string","format":"string","example":"completed"},"form_data":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"job bee"},"email":{"type":"string","example":"jobbee@exampl.com"},"widgets":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"job title"},"response":{"type":"string","example":"ceo"}}}}},"xml":{"name":"form_data"},"title":"form_data"}}},"xml":{"name":"formdataResponse"},"title":"formdataResponse"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"Document not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Document not found!"}},"title":"inline_response_404_3"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/64218a31.e515ff47.js b/assets/js/64218a31.e515ff47.js new file mode 100644 index 000000000..fcfc5b1d8 --- /dev/null +++ b/assets/js/64218a31.e515ff47.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[3979],{90207(e,t,s){s.r(t),s.d(t,{assets:()=>y,contentTitle:()=>v,default:()=>x,frontMatter:()=>b,metadata:()=>n,toc:()=>P});const n=JSON.parse('{"id":"API-docs/v1.1/getformdata","title":"Get Formdata","description":"The Get Formdata API enables you to retrieve widget data filled by signers who signed the document.","source":"@site/docs/API-docs/v1.1/getformdata.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/getformdata","permalink":"/docs/API-docs/v1.1/getformdata","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getformdata","title":"Get Formdata","description":"The Get Formdata API enables you to retrieve widget data filled by signers who signed the document.","sidebar_label":"Get Formdata","hide_title":true,"hide_table_of_contents":true,"api":"eJzVGdtuG7n1V04ZoIgFXexs9kVbbNfrONm0aWJYdvMQGRY1PNJwxSFnSY5kwRawD0U/oOhLX/sTfe+n5EuKQ3JmJNmbrLHtAg2Q2CEPz/0+t8zzuWPDD+yFyaoCtXfsqssEuszK0kuj2ZBd5Aiv0MNLYwvBPYfjs9eAmk8VOlibCrwBi95KXCKspJijhwA3k0qhgOkanJxrtA5WuYm/C/A5gkhE+2M91m+NxyFc5NIFAtKB0WoNfMmlIlowMxYukBcOuBZwqj3a0kqHUCquXX+sWZeZEi0nvl8LNmRz9LPENOuyklteoEdLAt8yzQtkQ1bzcC0F6zJJApfc52xfC2b6PWb+tQAzg1pZrMss/lBJi4INva2wy5xfK0LrZFEqZF2GN6UyAtlwxpUjgCzHgrPhLfPrMkB6K/WcdRmxyv32Cd7wgGXI+LfPsuxZXk5zttlcEVlXGu3QEaJnh4f0Y5dfV2UZOjerFDRKYV2WGe2J8+Et42WpZBYuBt87enR7n7soNmnPEhovI8laG4+V4+UruXj2xTS//APbdJmXnk4fh8KFX8h3CIUj0wnuH43m6GhwdDR4dvjsy4DGc1+5x+LIDP3iURAKArwOrtZi4dbyNbmVx8J9XqvRJe/z0FL83kxhikj0sOBSfRZ6ivhNPOhnpqB3MULd/5rLaNtN66qffpKhYRv602U3hWrJbKm1dZjtw4df0N15TXjv4e5dQPD8oQgamQJ9LvUcVqg9rKzR8y6UCrlD8HYNfM6lBsU92t/890ILrTX208p6HGebLfmlVlLjdW2T6+eHh9dHjRKe31dCnepAGw8zU2nx64r6EP1PC/T8+otGoC/vC/RaL7mSItSYC7NA/evKs03eR/L3PVhGoHDPdoTdPo9COswqK/061LSbHi9lL94PP1xRpSBPMakYhiLoczZkgzoQBrdbBXDDCJ9d1iWysooNWe596YaDgeNaTM1N35SoqYgrPnWUVAa8lIPlUf8Z23T33/CyfBQ8Vr3HPnGez6Wef+7dVauqEZkzWmxHYW1CLOUfkTJissc2VOoRcuQCbbCd1DMTHicrvStRj+RcBxsH4vu9xBOoYT7+5Z8NGDVBX0OnQ/0WCdJzprIZhm4j4OPKo9XcyyXCxx//DtNKKh/aIoFLVOSJrgveVs7HtgubHsn1Ox3Cv013LpepgeNQV7IulNaIKiNGexa5WAP2SKPcVzZ0WqGjAp9bU81z4OCknivswvnp6IKajeOz130YoRZNd+cCiw2SLhRc8zmCx4LwYeCZZ4sAQkktFmOQGixyBV4W2A09H6+8KbhHYtqSdNK2TSQoOcNsnamoHK4UrKTPTeVhiVoYC8pki57Uodvs9Xr048kTam09UR15bj0KOj1dol0DtXboPBSV85Bxa9eRbhO6xCG1sZMt/5hA9IxAZDKZjPXW5RB+Rxjag68TzFh3Oh//+jf48J1ZUTs9R00tG+4RvHpaO70wmbvv7XQ6yFGVg1EUyg2Oz16HLHcQ7f/WeHBkyVWOFonUFOdS/x4uqXLkCJ1OCnNAvZTWaFJtpwNPJz87DUwOCG9pjTcUT40V+GyGWVC1Ig+m7LNnihNjEU54yadSSUqqdH4HJ9zj3Ng13MH7nPvgshnXIAzcjfVdr9cLfwm002kGmU4H7uDEIievdqhFF6pShP9ZXJpF8imB5Pete/Zqs7fumzBf1P4aMH9bSSXAYuXCcNI4cxAXSou9UvEMRZqI3FeBB9KM0QjGUhS0g1EiMUI161F8BhKvai9wdJzmppatRq8JC0i9lD5ULpgps6qRnlVTJTPYZX+Uc4vAoYyXdegpqRchfLSpsSrpPNRjTo3zheUzD++NXRCliJEvcYs7Y7d0wh0IehFHt5nUXMnocEXsUmq8J0Z7niXj/SnmiRADiZks3sPUmAW52NzyouBeZlypdY3kpVECbcTxzs65JlotZ1I7KbBJwfDCkjvO4qMax3uc5sYsIpJzzJBgKB31KB0BLlNPImepWXAQPdOCWWlALUojta/RXbqaofN6UuZZZirtg0Yyi0J6oEpC0wZZ8G43NMjxP/74DwdvcUV5py4YdPkEjr3nWR6y4Ps4gI+qsjTWjzVVkwlv7t2kHtGlA21W4CIgCjA6GqlRVZf4Iv9rDyJAbdgGoD0gaZJP1YeUv1y/ZvU70v0oWnOUvO6N1As31iP0MBmzXAq8jva+Tn55rQIEG1J1Q7iDMExPiOXJ2bvRBQwCYzWfEwozQlO7zbZ7uzpt7woLdQvZb9V6opDT8zp0auNxNdaTV6cXMKhlHAylmAThd88peCaQU2hMETU4b5EX1LKKEGYWRaUF1x7a7QRQZFoszBJFQNnplBZpmRLXKslwFn1lCY9DeutRrWFmTVHL3CLsdKjmLkgBzd4AkDuJlhSVGe2qAhsLnXHnVsaK3pk1HjNyjbMXL1uPonuy00wqvC4T8JhNar3WCXRqxJrqjIaVsYF6SI2oM7suE1bXr/EGBxyOdbJndKxajRP4979gcnZ5T+PheOtBbc3BsIa73gXb85O9iz164YKSL6l0Uuvn3WxGBmy8l3KWNarxX66UWV2bCBU8+FOOuy9o8KEHJPUGaJUkM+nVOq3fKMkKGQtQote4OvVcyLO8CcPGvin4zo2iAhvyQypDE4iDTfAvnmVYUsYmmVI4WqOQLD2TqATwzBrnQqcVpKC0ZU3l0fXhIreIQPDRn5s0M4w1nahTFcWcLyVlzf1KnniaQOepwBmvlD8INSE0Y6lbpZRLQ68PNbVtU1OGi3iWEleEp0njbmf3GBRlkaDiwjFVv1S2IVizLnwTXpbWLCO6E65jZFMhr8HxhrSWanLkJtXOQOyuSS3cTo2GE1Ou4enJyQExJ0tJGXqsj0HjitSeZa227+Vrroyeh1JG8uCNdKG5mozZdPsdpfUmf7eJOmY/8ramu2isOIiNUmPMU1o1ARfCoqPcQVkNBcV7w6NNJZJTpzw1upeRZNsFEsLCCozOcNcA0jUGFX14IxfYytAl9ne4gaeuynLqKGKUtBEvxeSAeoKlFEkPkTWyl5Ui2b2pSkuuKuyGSh6zFGlWSVIstSmARenXEHZj8HTy4Wpy8BWYQvqAJarWG5A6R5sOd1Hv9bbHzR77tG2sU4O7dUIxQVucy/M3DzS3o9h7h0biEQ150wk2s90uhk+Ozs3r00s4x/m9x58b2Sf7rcyf0TppQpL6LXzLs8WKW+HgxBQl9zK0/msCpcfkHLOKertpDdjLEqCKowUsj4IbL4/6R83kV/dfLpZEnxuHsIyEY0JqvysYKlvSwbTWe8CqDUwtxqqZ5VzPKRCo+doq1JISv6iyGAuBX0JtwpzPFVRaoXNgfI52RU2oNuTju+q4dEhzc+qBxroHH5rW9D1OnfTYzn2r1eqepg/Cm5eVUs2HiRBwn5kW47NX0n9XTeEcS+OkN3bdvppLn1fTYMvtt81/EoJ6SGkWar9kSg0oL9AWjr6zjNAuZfYZ8QeewAcH4fvP3j5nd+1icYaW8o7bmbF5KdM8/6HmA4i9XyIHbe3SrBIWg3FXT4ulb/bxhAUfifBuluRNy61Py8u6TMkM02I9LaqOX529geUX/UPW3dqS/QxbDt68Pjl9OzolZlKY0DeS/mH/kI5K43zB9Ral7Q+C+/ut23af+n/18TBt/zze+EGpuAy716DG27Q3/cC2vicOtz8dXnVZbpwnkNtbyiSXVm02dPxDhZa2s1ddtuRWEjdhuZoaN9F8GfxJHT49T9P3AfzEV8gHOa+XmZo2maEksSFjXbbA9d53z83VpltvNIm1CHEcGsCtt/dW4zv75VenF6zLeEV62t6kLsImNf1C2B/ka3fFGhmgf2nf++CD29u4pd1sGvh49ZMvkoA1NCnparPZ/AerUvkj","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Signer IPs","permalink":"/docs/API-docs/v1.1/getsignerips"},"next":{"title":"Get Signing Links","permalink":"/docs/API-docs/v1.1/getsigninglinks"}}');var a=s(74848),o=s(28453),i=s(57742),r=s.n(i),d=s(78178),p=s.n(d),l=s(19624),m=s.n(l),c=s(96226),u=s.n(c),h=(s(77675),s(19365),s(51107)),f=s(21312);const b={id:"getformdata",title:"Get Formdata",description:"The Get Formdata API enables you to retrieve widget data filled by signers who signed the document.",sidebar_label:"Get Formdata",hide_title:!0,hide_table_of_contents:!0,api:"eJzVGdtuG7n1V04ZoIgFXexs9kVbbNfrONm0aWJYdvMQGRY1PNJwxSFnSY5kwRawD0U/oOhLX/sTfe+n5EuKQ3JmJNmbrLHtAg2Q2CEPz/0+t8zzuWPDD+yFyaoCtXfsqssEuszK0kuj2ZBd5Aiv0MNLYwvBPYfjs9eAmk8VOlibCrwBi95KXCKspJijhwA3k0qhgOkanJxrtA5WuYm/C/A5gkhE+2M91m+NxyFc5NIFAtKB0WoNfMmlIlowMxYukBcOuBZwqj3a0kqHUCquXX+sWZeZEi0nvl8LNmRz9LPENOuyklteoEdLAt8yzQtkQ1bzcC0F6zJJApfc52xfC2b6PWb+tQAzg1pZrMss/lBJi4INva2wy5xfK0LrZFEqZF2GN6UyAtlwxpUjgCzHgrPhLfPrMkB6K/WcdRmxyv32Cd7wgGXI+LfPsuxZXk5zttlcEVlXGu3QEaJnh4f0Y5dfV2UZOjerFDRKYV2WGe2J8+Et42WpZBYuBt87enR7n7soNmnPEhovI8laG4+V4+UruXj2xTS//APbdJmXnk4fh8KFX8h3CIUj0wnuH43m6GhwdDR4dvjsy4DGc1+5x+LIDP3iURAKArwOrtZi4dbyNbmVx8J9XqvRJe/z0FL83kxhikj0sOBSfRZ6ivhNPOhnpqB3MULd/5rLaNtN66qffpKhYRv602U3hWrJbKm1dZjtw4df0N15TXjv4e5dQPD8oQgamQJ9LvUcVqg9rKzR8y6UCrlD8HYNfM6lBsU92t/890ILrTX208p6HGebLfmlVlLjdW2T6+eHh9dHjRKe31dCnepAGw8zU2nx64r6EP1PC/T8+otGoC/vC/RaL7mSItSYC7NA/evKs03eR/L3PVhGoHDPdoTdPo9COswqK/061LSbHi9lL94PP1xRpSBPMakYhiLoczZkgzoQBrdbBXDDCJ9d1iWysooNWe596YaDgeNaTM1N35SoqYgrPnWUVAa8lIPlUf8Z23T33/CyfBQ8Vr3HPnGez6Wef+7dVauqEZkzWmxHYW1CLOUfkTJissc2VOoRcuQCbbCd1DMTHicrvStRj+RcBxsH4vu9xBOoYT7+5Z8NGDVBX0OnQ/0WCdJzprIZhm4j4OPKo9XcyyXCxx//DtNKKh/aIoFLVOSJrgveVs7HtgubHsn1Ox3Cv013LpepgeNQV7IulNaIKiNGexa5WAP2SKPcVzZ0WqGjAp9bU81z4OCknivswvnp6IKajeOz130YoRZNd+cCiw2SLhRc8zmCx4LwYeCZZ4sAQkktFmOQGixyBV4W2A09H6+8KbhHYtqSdNK2TSQoOcNsnamoHK4UrKTPTeVhiVoYC8pki57Uodvs9Xr048kTam09UR15bj0KOj1dol0DtXboPBSV85Bxa9eRbhO6xCG1sZMt/5hA9IxAZDKZjPXW5RB+Rxjag68TzFh3Oh//+jf48J1ZUTs9R00tG+4RvHpaO70wmbvv7XQ6yFGVg1EUyg2Oz16HLHcQ7f/WeHBkyVWOFonUFOdS/x4uqXLkCJ1OCnNAvZTWaFJtpwNPJz87DUwOCG9pjTcUT40V+GyGWVC1Ig+m7LNnihNjEU54yadSSUqqdH4HJ9zj3Ng13MH7nPvgshnXIAzcjfVdr9cLfwm002kGmU4H7uDEIievdqhFF6pShP9ZXJpF8imB5Pete/Zqs7fumzBf1P4aMH9bSSXAYuXCcNI4cxAXSou9UvEMRZqI3FeBB9KM0QjGUhS0g1EiMUI161F8BhKvai9wdJzmppatRq8JC0i9lD5ULpgps6qRnlVTJTPYZX+Uc4vAoYyXdegpqRchfLSpsSrpPNRjTo3zheUzD++NXRCliJEvcYs7Y7d0wh0IehFHt5nUXMnocEXsUmq8J0Z7niXj/SnmiRADiZks3sPUmAW52NzyouBeZlypdY3kpVECbcTxzs65JlotZ1I7KbBJwfDCkjvO4qMax3uc5sYsIpJzzJBgKB31KB0BLlNPImepWXAQPdOCWWlALUojta/RXbqaofN6UuZZZirtg0Yyi0J6oEpC0wZZ8G43NMjxP/74DwdvcUV5py4YdPkEjr3nWR6y4Ps4gI+qsjTWjzVVkwlv7t2kHtGlA21W4CIgCjA6GqlRVZf4Iv9rDyJAbdgGoD0gaZJP1YeUv1y/ZvU70v0oWnOUvO6N1As31iP0MBmzXAq8jva+Tn55rQIEG1J1Q7iDMExPiOXJ2bvRBQwCYzWfEwozQlO7zbZ7uzpt7woLdQvZb9V6opDT8zp0auNxNdaTV6cXMKhlHAylmAThd88peCaQU2hMETU4b5EX1LKKEGYWRaUF1x7a7QRQZFoszBJFQNnplBZpmRLXKslwFn1lCY9DeutRrWFmTVHL3CLsdKjmLkgBzd4AkDuJlhSVGe2qAhsLnXHnVsaK3pk1HjNyjbMXL1uPonuy00wqvC4T8JhNar3WCXRqxJrqjIaVsYF6SI2oM7suE1bXr/EGBxyOdbJndKxajRP4979gcnZ5T+PheOtBbc3BsIa73gXb85O9iz164YKSL6l0Uuvn3WxGBmy8l3KWNarxX66UWV2bCBU8+FOOuy9o8KEHJPUGaJUkM+nVOq3fKMkKGQtQote4OvVcyLO8CcPGvin4zo2iAhvyQypDE4iDTfAvnmVYUsYmmVI4WqOQLD2TqATwzBrnQqcVpKC0ZU3l0fXhIreIQPDRn5s0M4w1nahTFcWcLyVlzf1KnniaQOepwBmvlD8INSE0Y6lbpZRLQ68PNbVtU1OGi3iWEleEp0njbmf3GBRlkaDiwjFVv1S2IVizLnwTXpbWLCO6E65jZFMhr8HxhrSWanLkJtXOQOyuSS3cTo2GE1Ou4enJyQExJ0tJGXqsj0HjitSeZa227+Vrroyeh1JG8uCNdKG5mozZdPsdpfUmf7eJOmY/8ramu2isOIiNUmPMU1o1ARfCoqPcQVkNBcV7w6NNJZJTpzw1upeRZNsFEsLCCozOcNcA0jUGFX14IxfYytAl9ne4gaeuynLqKGKUtBEvxeSAeoKlFEkPkTWyl5Ui2b2pSkuuKuyGSh6zFGlWSVIstSmARenXEHZj8HTy4Wpy8BWYQvqAJarWG5A6R5sOd1Hv9bbHzR77tG2sU4O7dUIxQVucy/M3DzS3o9h7h0biEQ150wk2s90uhk+Ozs3r00s4x/m9x58b2Sf7rcyf0TppQpL6LXzLs8WKW+HgxBQl9zK0/msCpcfkHLOKertpDdjLEqCKowUsj4IbL4/6R83kV/dfLpZEnxuHsIyEY0JqvysYKlvSwbTWe8CqDUwtxqqZ5VzPKRCo+doq1JISv6iyGAuBX0JtwpzPFVRaoXNgfI52RU2oNuTju+q4dEhzc+qBxroHH5rW9D1OnfTYzn2r1eqepg/Cm5eVUs2HiRBwn5kW47NX0n9XTeEcS+OkN3bdvppLn1fTYMvtt81/EoJ6SGkWar9kSg0oL9AWjr6zjNAuZfYZ8QeewAcH4fvP3j5nd+1icYaW8o7bmbF5KdM8/6HmA4i9XyIHbe3SrBIWg3FXT4ulb/bxhAUfifBuluRNy61Py8u6TMkM02I9LaqOX529geUX/UPW3dqS/QxbDt68Pjl9OzolZlKY0DeS/mH/kI5K43zB9Ral7Q+C+/ut23af+n/18TBt/zze+EGpuAy716DG27Q3/cC2vicOtz8dXnVZbpwnkNtbyiSXVm02dPxDhZa2s1ddtuRWEjdhuZoaN9F8GfxJHT49T9P3AfzEV8gHOa+XmZo2maEksSFjXbbA9d53z83VpltvNIm1CHEcGsCtt/dW4zv75VenF6zLeEV62t6kLsImNf1C2B/ka3fFGhmgf2nf++CD29u4pd1sGvh49ZMvkoA1NCnparPZ/AerUvkj",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-2",custom_edit_url:null},v=void 0,y={},P=[];function g(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Get Formdata"}),"\n",(0,a.jsx)(r(),{method:"get",path:"/formdata/{document_id}",context:"endpoint"}),"\n",(0,a.jsx)(t.p,{children:"The Get Formdata API enables you to retrieve widget data filled by signers who signed the document."}),"\n",(0,a.jsx)(t.p,{children:"Note: This API is only available for Teams and Enterprise plans."}),"\n",(0,a.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,a.jsx)(f.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,a.jsx)(p(),{...s(48632)}),"\n",(0,a.jsx)(m(),{...s(21690)}),"\n",(0,a.jsx)(u(),{...s(68816)})]})}function x(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(g,{...e})}):g(e)}},48632(e){e.exports=JSON.parse('{"parameters":[{"name":"document_id","in":"path","description":"objectId of Document","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"aB2cc2hpbh"}}]}')},21690(e){e.exports={title:"Body"}},68816(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"FGik23bhUJ"},"title":{"type":"string","format":"string","example":"sample doc"},"sent_date":{"type":"string","format":"string","example":"11/11/2025"},"status":{"type":"string","format":"string","example":"completed"},"form_data":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"job bee"},"email":{"type":"string","example":"jobbee@exampl.com"},"widgets":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"job title"},"response":{"type":"string","example":"ceo"}}}}},"xml":{"name":"form_data"},"title":"form_data"}}},"xml":{"name":"formdataResponse"},"title":"formdataResponse"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"Document not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Document not found!"}},"title":"inline_response_404_3"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/6d2e526e.94f58990.js b/assets/js/6d2e526e.94f58990.js new file mode 100644 index 000000000..cb766ba14 --- /dev/null +++ b/assets/js/6d2e526e.94f58990.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[5752],{16027(e,o,t){t.r(o),t.d(o,{assets:()=>N,contentTitle:()=>x,default:()=>j,frontMatter:()=>k,metadata:()=>n,toc:()=>b});const n=JSON.parse('{"id":"API-docs/v1.1/revokedocument","title":"Revoke Document","description":"The Revoke document API allows you to revoke specific document from your documents.","source":"@site/docs/API-docs/v1.1/revokedocument.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/revokedocument","permalink":"/docs/API-docs/v1.1/revokedocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"revokedocument","title":"Revoke Document","description":"The Revoke document API allows you to revoke specific document from your documents.","sidebar_label":"Revoke Document","hide_title":true,"hide_table_of_contents":true,"api":"eJy9Wd1uG7kVfpVTBihiYSTZSXaLaottHcebBE03hmU3QC3DooZHGq455CzJGVmwBexF0QcoetPbvkTv+yh5kuKQM6OR7HU22G0v8iPO4eH5+c4PD2+Z5wvHRhfslUnLHLV37DJhAl1qZeGl0WzEzjKEU6zMNYKoqeDw5C1wpczSwcqU4A3YSOEKTOVcphvSuTU5Edl2yQ1YwkyBltMJbwUbsbi7IWAJK7jlOXq0JN0t0zxHNmINwZUULGGSpCu4z9iuyCfWVFIgmNl3mPq3Asx8I1ArLEuYxe9LaVGwkbclJsz5laKDnMwLRQR4UygjkI3mXDkiSDPMORvdMr8qAqW3Ui9YwubG5tx3V/CGBy4jVmTPZtkz7gRbry/jqej8SyNWxCk12pPWo1vGi0LJNNhl+J0jXW7vHxm1IiNZsqKX6OirRV7v2BVtIwhbrxPmpQ8/doy+XtNHi64w2kWWz/b36Z9t4zZQqa0owJVpis7NS6VWv2LJL6VP47zHNXp5Q4Yt3hTPWZA+iHToH9/0bP/Z8/7Bfn//N2cHX45e/Hb0xZeD/f39v7CE3eSK9jaA4x5Zx2Tx93qXrMbTPdvWNn3xkBnHJkefSb2AJRlzaY1eJFAo5A7B2xXwBZcaFPdof0GrorXGPm6dz5OsiyipldR41WDo6sX+/tVBa4QXj2BJGw9zU2rx/1X1ofMfV+jF1fNWoS/uK/RWV1xJERLkmblG/f/Vp3u8j8ffR6uMROE721K2ux6VdJiWVvpVyMI3fV7Ifvw+urikVEZIMZTBC+Ni3vYZG7Fhk1WGt52cvWbE0FZNVi+tYiOWeV+40XDouBYzczMwBWonF1rxmRukJh/yQg6rg8Eztk529/Ci+Cx6LPufu8V5vpB68al9lxtbjcmf0WVbFmsdxwv5R1yxpHFIl6ouaxlygTY4j2ByuqkYx42zNxmfkRelnptwRu3N9wXqsVzogIUg426VfAINzce//qslm+iJ/hp6PSr7pG/fmdKmCBQqgR9XHq3mXlYIH3/4B8xKqSh4LAisUBFiXQLels6jgNkKUHu0hZUO3aDXI/7dcxeywthFcEgNqeYxgcIaUaYkaN8iFyvAPhme+9IiFIp7KrfgM2vKRQYcnNQLhQmcHo/P5qUibQYwRi02XUcQsWWSQM41XyB4zIkfBpl5eh1IKPk5z33pQGqwyBV4mWMCXAvgpTc59xi7GtRe2k5rpOQc01WqonG4UrCUPjOlhwq1MBaUSa/7Ug/IEP1+n/558gReo/d06thz61HQ6nGFdgV1swB56Tyk3NpVPLcNcZLQZwjTDoymEAEUDplOpxPd+TiC3xGHzcLXNc1E93of//Z3uHhjltQmLVBTk4Y7B14+bWJDmNTdDwpaHWaoiuE4KuWGhydvQzbci/7/1nhw5MllhhbpqBkupP49nFOFyRB6vTobAOpKWqPJtL0ePJ3+5Gwx3SO+hTXeUNi1XuDzOabB1IoQLLjnO644MhbhiBd8JpWk5Evrd3DEPS6MXcEdfMi4D5BNuQZh4G6i7/r9fvhDpL1e20/3enAHRxY5odqhFgmUhQi/Yo8QMSWQcL+BZ79x+wa+NeezBq+B88tSKgEWS8dnqgPmoC4UFvuF4ikKWEqxQO++CjKQZYxGMJaiYBWORdseMUY171N8hiNeNyhwtBxIu1HV2rXmAlJX0ocKB3Nllg3Tk3KmZArb4o8zbhE4FPFjE3pK6usQPto0XJV0Hpp2veH5yvK5hw/GXtNJkSOvsCOdsR2bcAeCdrhg8rnUXMkIuDx2Mw3fI6M9T2vn/SnmiRADtTBp/A4zY64JYgvL85x7mXKlVg2Tb4wSaCOP93bBNZ21kUxqR1eUNk2/sgTHedzU8PiAs8yY68jkFFMkGkpHfUpHgFXdu9CVK5jcQUSmBbPUgFoURmrfsDt3jUCn6K3ECoGnqSm1DxZJLQrpgSoJ3WXIg3fboUHA//jDPx18i0vKO03BoI9P4NB7nmYhC34IcINxWRTG+ommajLl7Xc3rQEJ0oE2S3CREAUYHZ3UmiohuQh/m4VI0Di2JdgskDY1pppFyl9u0Ij6hmw/jt4c16h7J/W1m+gxephOWCYFXkV/X9W4vFKBgo2ouiHcQbgUTknk6cn78RkMg2CNnFMKM2LTwKYLb9ek7W1loWk1BxuzHinktL0JncZ5XE309PXxGQwbHYcjKaZB+e11Cp4pZBQaM0QNzlvkObW2IoSZRVFqwbWHzb0bKDIt5qZCEVj2eoXFuVQq5MzGcRZ9aYmPQ9rrUa3ilb/WecOw16Oae00GaC+ZgNxJtGSo1GhX5th66IQ7tzRW9E+s8ZgSNE5efbNBFH0nP82lwquiJp6waWPXJoHOjFhRndGwNDacHlIj6tSuipqrGzR8AwBHE137MwKrMeMU/vNvmJ6c37N4WO5saLvfUUN3tU22g5OdDzvnhQ+UfMmk08Y+7+dzcmCLXspZ1qgWv2E8c2UiVUDwY8DdVTRg6AFNvQEaichUekWdXag61PrJWIDq81qoU8+FPM3aMGz9WwffqVFUYEN+qMvQtJ7bBHzxNMWCMjbpVIejNQrJ03OJSgBPrXEudFpBC0pb1pQe3QDOMosIRB/x3KaZUazpdDpVUcx4JSlr7lbyWqYp9J4KnPNS+b1QE0IzVnerlHLpcuxDTd20qXWGi3wqiUvi06ZxF6O/HZMZSw2BxCUYrVZN9avLdhy2NYVvyovCmiqyO+I6RjYV8oYcb8hqdU2O0tS1Mxx216YWbmdGw5EpVvD06GiPhJOFpAw90YegcUlmT9ONte/la66MXoRSRvrgjXShuZpO2Ky7j9J6m783iTpmP0Jb2120XhzGRql15nHOpQIuhEVHuYOyGgqK91ZGW5dITp3yzOh+Spp1CyRg4GJ0itsOkK51qBjAO3mNGx0SEn9LGnjqyjSjjiJGySbipZjuUU9QSVHbIYpG/rJS1H5vq1LFVYlJqOQxS5FllSTDUpsCmBd+BdxavoKn04vL6d5XYHLpA5doWm9A6gxtvbjNeqe3Pay4VCFSjzeNdd3gdlYoJmjac3767oHmdhx779BIfEZD3naC7d1um8OjN+x29/E5nOLi3uZP3eynu63Mn9E6aUKS+jW85On1klvh4MjkBfcytP4rIqXNBI4w3oRZQ9hPa0IVrxZQHQQYVweDg/bm1/RfLpZEnxmHUMWDY0LirT8MlS3pYNbYPXDVBmYWY9VMM64XFAjUfHUKtaTEL8o0xkKQl1ibcM/nCkqt0DkwPkO7pCZUG8L4tjnOHdK9ue6BJroPF21r+gFnTnrc3PuWy+U9S++FPd+USkFz+QkB94nbYtz2Wvo35QxOsTBOemNXm10L6bNyFnzZ3dv+qBk0l5R28PZzbqmB5Rna3NHLwRhtJdNPqD/0RD7cm9AIZ2fssz12sTjH8Bjitu7YvJD1ff6ikQNIvJ+jB82F6rtKGCBS6ovzpz/s8gmDQFLh/bzWt56BPa4vS5iSKWqHnQHj4euTd1A9H+yzpDNM+wm+HL57e3T87fiYhKnDhI3YwWB/sE9LNGPMue6cVL9Lvdo8HG3ZuvO28j96xqoneh5v/LBQXIaBatD5tp6FXrDOs9ao+4J1mbCMpqajC3Z7S2F/btV6Tcvfl2hp5HqZsIpbSfkhDEzrLku0z1E/qu3T0/qqvAc/+THsQV2akaWmeWWoKDRvTNg1rnYe5NaX66SZW5KwkeIoitQ/Iz4bDvfm4DR4jTsOQ8f3KG138Ez9K0vYrH5My8NrHbN8Sc97fBmljbkwPpPR2i1TXC9KviDayJNGrbwkj3XntNdhTlv/h7R60B7bA9yoBv1NSj244fY2zoDX65Y+fvrRHbVhG2pyzuV6vf4vkeKLLg==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Update Document","permalink":"/docs/API-docs/v1.1/update-document"},"next":{"title":"Delete Document","permalink":"/docs/API-docs/v1.1/deletedocument"}}');var i=t(74848),p=t(28453),c=t(57742),a=t.n(c),r=t(78178),s=t.n(r),d=t(19624),m=t.n(d),l=t(96226),u=t.n(l),v=(t(77675),t(19365),t(51107)),h=t(21312);const k={id:"revokedocument",title:"Revoke Document",description:"The Revoke document API allows you to revoke specific document from your documents.",sidebar_label:"Revoke Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Wd1uG7kVfpVTBihiYSTZSXaLaottHcebBE03hmU3QC3DooZHGq455CzJGVmwBexF0QcoetPbvkTv+yh5kuKQM6OR7HU22G0v8iPO4eH5+c4PD2+Z5wvHRhfslUnLHLV37DJhAl1qZeGl0WzEzjKEU6zMNYKoqeDw5C1wpczSwcqU4A3YSOEKTOVcphvSuTU5Edl2yQ1YwkyBltMJbwUbsbi7IWAJK7jlOXq0JN0t0zxHNmINwZUULGGSpCu4z9iuyCfWVFIgmNl3mPq3Asx8I1ArLEuYxe9LaVGwkbclJsz5laKDnMwLRQR4UygjkI3mXDkiSDPMORvdMr8qAqW3Ui9YwubG5tx3V/CGBy4jVmTPZtkz7gRbry/jqej8SyNWxCk12pPWo1vGi0LJNNhl+J0jXW7vHxm1IiNZsqKX6OirRV7v2BVtIwhbrxPmpQ8/doy+XtNHi64w2kWWz/b36Z9t4zZQqa0owJVpis7NS6VWv2LJL6VP47zHNXp5Q4Yt3hTPWZA+iHToH9/0bP/Z8/7Bfn//N2cHX45e/Hb0xZeD/f39v7CE3eSK9jaA4x5Zx2Tx93qXrMbTPdvWNn3xkBnHJkefSb2AJRlzaY1eJFAo5A7B2xXwBZcaFPdof0GrorXGPm6dz5OsiyipldR41WDo6sX+/tVBa4QXj2BJGw9zU2rx/1X1ofMfV+jF1fNWoS/uK/RWV1xJERLkmblG/f/Vp3u8j8ffR6uMROE721K2ux6VdJiWVvpVyMI3fV7Ifvw+urikVEZIMZTBC+Ni3vYZG7Fhk1WGt52cvWbE0FZNVi+tYiOWeV+40XDouBYzczMwBWonF1rxmRukJh/yQg6rg8Eztk529/Ci+Cx6LPufu8V5vpB68al9lxtbjcmf0WVbFmsdxwv5R1yxpHFIl6ouaxlygTY4j2ByuqkYx42zNxmfkRelnptwRu3N9wXqsVzogIUg426VfAINzce//qslm+iJ/hp6PSr7pG/fmdKmCBQqgR9XHq3mXlYIH3/4B8xKqSh4LAisUBFiXQLels6jgNkKUHu0hZUO3aDXI/7dcxeywthFcEgNqeYxgcIaUaYkaN8iFyvAPhme+9IiFIp7KrfgM2vKRQYcnNQLhQmcHo/P5qUibQYwRi02XUcQsWWSQM41XyB4zIkfBpl5eh1IKPk5z33pQGqwyBV4mWMCXAvgpTc59xi7GtRe2k5rpOQc01WqonG4UrCUPjOlhwq1MBaUSa/7Ug/IEP1+n/558gReo/d06thz61HQ6nGFdgV1swB56Tyk3NpVPLcNcZLQZwjTDoymEAEUDplOpxPd+TiC3xGHzcLXNc1E93of//Z3uHhjltQmLVBTk4Y7B14+bWJDmNTdDwpaHWaoiuE4KuWGhydvQzbci/7/1nhw5MllhhbpqBkupP49nFOFyRB6vTobAOpKWqPJtL0ePJ3+5Gwx3SO+hTXeUNi1XuDzOabB1IoQLLjnO644MhbhiBd8JpWk5Evrd3DEPS6MXcEdfMi4D5BNuQZh4G6i7/r9fvhDpL1e20/3enAHRxY5odqhFgmUhQi/Yo8QMSWQcL+BZ79x+wa+NeezBq+B88tSKgEWS8dnqgPmoC4UFvuF4ikKWEqxQO++CjKQZYxGMJaiYBWORdseMUY171N8hiNeNyhwtBxIu1HV2rXmAlJX0ocKB3Nllg3Tk3KmZArb4o8zbhE4FPFjE3pK6usQPto0XJV0Hpp2veH5yvK5hw/GXtNJkSOvsCOdsR2bcAeCdrhg8rnUXMkIuDx2Mw3fI6M9T2vn/SnmiRADtTBp/A4zY64JYgvL85x7mXKlVg2Tb4wSaCOP93bBNZ21kUxqR1eUNk2/sgTHedzU8PiAs8yY68jkFFMkGkpHfUpHgFXdu9CVK5jcQUSmBbPUgFoURmrfsDt3jUCn6K3ECoGnqSm1DxZJLQrpgSoJ3WXIg3fboUHA//jDPx18i0vKO03BoI9P4NB7nmYhC34IcINxWRTG+ommajLl7Xc3rQEJ0oE2S3CREAUYHZ3UmiohuQh/m4VI0Di2JdgskDY1pppFyl9u0Ij6hmw/jt4c16h7J/W1m+gxephOWCYFXkV/X9W4vFKBgo2ouiHcQbgUTknk6cn78RkMg2CNnFMKM2LTwKYLb9ek7W1loWk1BxuzHinktL0JncZ5XE309PXxGQwbHYcjKaZB+e11Cp4pZBQaM0QNzlvkObW2IoSZRVFqwbWHzb0bKDIt5qZCEVj2eoXFuVQq5MzGcRZ9aYmPQ9rrUa3ilb/WecOw16Oae00GaC+ZgNxJtGSo1GhX5th66IQ7tzRW9E+s8ZgSNE5efbNBFH0nP82lwquiJp6waWPXJoHOjFhRndGwNDacHlIj6tSuipqrGzR8AwBHE137MwKrMeMU/vNvmJ6c37N4WO5saLvfUUN3tU22g5OdDzvnhQ+UfMmk08Y+7+dzcmCLXspZ1qgWv2E8c2UiVUDwY8DdVTRg6AFNvQEaichUekWdXag61PrJWIDq81qoU8+FPM3aMGz9WwffqVFUYEN+qMvQtJ7bBHzxNMWCMjbpVIejNQrJ03OJSgBPrXEudFpBC0pb1pQe3QDOMosIRB/x3KaZUazpdDpVUcx4JSlr7lbyWqYp9J4KnPNS+b1QE0IzVnerlHLpcuxDTd20qXWGi3wqiUvi06ZxF6O/HZMZSw2BxCUYrVZN9avLdhy2NYVvyovCmiqyO+I6RjYV8oYcb8hqdU2O0tS1Mxx216YWbmdGw5EpVvD06GiPhJOFpAw90YegcUlmT9ONte/la66MXoRSRvrgjXShuZpO2Ky7j9J6m783iTpmP0Jb2120XhzGRql15nHOpQIuhEVHuYOyGgqK91ZGW5dITp3yzOh+Spp1CyRg4GJ0itsOkK51qBjAO3mNGx0SEn9LGnjqyjSjjiJGySbipZjuUU9QSVHbIYpG/rJS1H5vq1LFVYlJqOQxS5FllSTDUpsCmBd+BdxavoKn04vL6d5XYHLpA5doWm9A6gxtvbjNeqe3Pay4VCFSjzeNdd3gdlYoJmjac3767oHmdhx779BIfEZD3naC7d1um8OjN+x29/E5nOLi3uZP3eynu63Mn9E6aUKS+jW85On1klvh4MjkBfcytP4rIqXNBI4w3oRZQ9hPa0IVrxZQHQQYVweDg/bm1/RfLpZEnxmHUMWDY0LirT8MlS3pYNbYPXDVBmYWY9VMM64XFAjUfHUKtaTEL8o0xkKQl1ibcM/nCkqt0DkwPkO7pCZUG8L4tjnOHdK9ue6BJroPF21r+gFnTnrc3PuWy+U9S++FPd+USkFz+QkB94nbYtz2Wvo35QxOsTBOemNXm10L6bNyFnzZ3dv+qBk0l5R28PZzbqmB5Rna3NHLwRhtJdNPqD/0RD7cm9AIZ2fssz12sTjH8Bjitu7YvJD1ff6ikQNIvJ+jB82F6rtKGCBS6ovzpz/s8gmDQFLh/bzWt56BPa4vS5iSKWqHnQHj4euTd1A9H+yzpDNM+wm+HL57e3T87fiYhKnDhI3YwWB/sE9LNGPMue6cVL9Lvdo8HG3ZuvO28j96xqoneh5v/LBQXIaBatD5tp6FXrDOs9ao+4J1mbCMpqajC3Z7S2F/btV6Tcvfl2hp5HqZsIpbSfkhDEzrLku0z1E/qu3T0/qqvAc/+THsQV2akaWmeWWoKDRvTNg1rnYe5NaX66SZW5KwkeIoitQ/Iz4bDvfm4DR4jTsOQ8f3KG138Ez9K0vYrH5My8NrHbN8Sc97fBmljbkwPpPR2i1TXC9KviDayJNGrbwkj3XntNdhTlv/h7R60B7bA9yoBv1NSj244fY2zoDX65Y+fvrRHbVhG2pyzuV6vf4vkeKLLg==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-2",custom_edit_url:null},x=void 0,N={},b=[];function B(e){const o={p:"p",...(0,p.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(v.default,{as:"h1",className:"openapi__heading",children:"Revoke Document"}),"\n",(0,i.jsx)(a(),{method:"post",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,i.jsx)(o.p,{children:"The Revoke document API allows you to revoke specific document from your documents."}),"\n",(0,i.jsx)(v.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,i.jsx)(h.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,i.jsx)(s(),{...t(87513)}),"\n",(0,i.jsx)(m(),{...t(9379)}),"\n",(0,i.jsx)(u(),{...t(19461)})]})}function j(e={}){const{wrapper:o}={...(0,p.R)(),...e.components};return o?(0,i.jsx)(o,{...e,children:(0,i.jsx)(B,{...e})}):B(e)}},87513(e){e.exports=JSON.parse('{"parameters":[{"name":"document_id","in":"path","description":"Provide objectId of document to revoke","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"ph2bh2asd"}}]}')},9379(e){e.exports=JSON.parse('{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string","example":""}},"title":"revokedocument"}}}}}')},19461(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Document revoked successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","example":"Bxh2aspHp3"},"revokedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"xml":{"name":"revoke"},"title":"revoke"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"Document not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Document not found!"}},"title":"inline_response_404_3"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/6d2e526e.f7d7ed8f.js b/assets/js/6d2e526e.f7d7ed8f.js deleted file mode 100644 index 04e236939..000000000 --- a/assets/js/6d2e526e.f7d7ed8f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[5752],{16027(e,t,o){o.r(t),o.d(t,{assets:()=>g,contentTitle:()=>k,default:()=>w,frontMatter:()=>y,metadata:()=>n,toc:()=>f});const n=JSON.parse('{"id":"API-docs/v1.1/revokedocument","title":"Revoke Document","description":"The Revoke document API allows you to revoke specific document from your documents.","source":"@site/docs/API-docs/v1.1/revokedocument.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/revokedocument","permalink":"/docs/API-docs/v1.1/revokedocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"revokedocument","title":"Revoke Document","description":"The Revoke document API allows you to revoke specific document from your documents.","sidebar_label":"Revoke Document","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V81u5DYSfpVaXjbTkLvbHieL1SnOZDAxdpAxxg4MrMcwKKkkMaZIhqS63WgIyCFvkFOu+2jzJIsiJbW67XEy2GwudqtYVaz6qlg/W+Z55Vh6w77Vedug8o7dJqxAl1thvNCKpeyqRniPK32PUPRccHZxDlxKvXaw0S14DTZyOIO5KEW+Yy2tbojJjiQ3ZwnTBi2nG84LlrIoPTCwhBlueYMeLVm3ZYo3yFI2MNyJgiVMkHWG+5odmnxh9UoUCDr7EXN/XoAudwaNxrKEWfypFRYLlnrbYsKc30i6yInGSGLAByN1gSwtuXTEkNfYcJZumd+YwOmtUBVLWKltw/2Ugg88aEmZqU+y+oS7gnXdbbwVnf9GFxvSlGvlyet0y7gxUuQBl8WPjnzZPr4yekUgWULRC3R0apH3Eoem7QxhXZcwL3z4OAC96+jQojNauajyZLmkf/vgDqnSo1iAa/McnStbKTd/Y8mf5c8QvOc9+uaBgDXfmZcsWB9MOvPPC50sT14eHS+Plv+4Ov4qPf1n+uVX8+Vy+W+WsIdGkuyQcNwjm0AWv7tDtj6fHmHbY3r6FIyXukFfC1XBmsBcW62qBIxE7hC83QCvuFAguUf7J6KK1mr7PDqfZ9k0o4SSQuHdkEN3p8vl3fEIwukzuaS0h1K3qvhrXX3q/ucdOr17OTr05WOHztWKS1GEAnml71H9tf5Mr/fx+sfZKiJTOGd7zk7p0UmHeWuF34Qq/HDEjTiK5+nNLZUyyhRNFdxoF+u2r1nKFkNVWWwnNbtjpNCuhqreWslSVntvXLpYOK6KTD/MtUHlRKUkz9w8182CG7FYHc+PWZccynBjPosf26PPFXGeV0JVvyd3u8PqkuIZQ7aH2Bg4bsS/cMOSISBTrr6t1cgLtCF4lCbvdx3j9RDsXcVnFEWhSh3u6KP5zqC6FJUKuRBsPOyS1yhz3SA1RF8jzGaDyMdf/jNKzWZj5wxZO/+gPqh3rQWj12jLVgJXBZQSH0QmMYhhE87G0cAhbyQ6JzcglMfKco9QiEp4LoHgpFKTc8MzIQUlO7HpODNM3oubw3WNvkZLR3+3CBwKXKGkNwK89brhnlSNnX6t7X1JQ0oCHLLWCYXOAaqaq5wYh4AloC1wBag8WmOFQ3DektUi2qaVtzz30HDFKyTdCUzBKlAKymqwOmudB6dlG0wGz4XUFgsYHFKIhQsgvqbRwiIQNdeNsVhTdq0QqlYU6BLIdYHgQrjJBVVAhs6DIVtEjo6Utkrq/D4EkBowGE2lRnBJM8/URhL3litHg0o/kPUxGAEzVlMnx2jgbPaDQ4rwW6HuXTqbfVBHcDPm1TVmTni8/WJ4Kev1+tELebEv80b479oM3qPRTnhtNzvpSvi6zcKrmioZP6KmN6gw5M/kzex0FDp3jx8pURc1SrO4RE8Z4hZnF+ehOr+Ajz//Cm+RWwW1XsdszVuLcgPVcBUhFyMfYRuLK5Q6JF5NiOcx+frZbkDwuub+48+/Ofge1yBU/6TIldnsos2kyOEKG0O91M1mKbyySFf6gQa+5h5yriBDcDWnVFoJDhxMlJZC3c/hTG2gdWhhLXwdkoHoQW7PDcJlN4dDxh0WoFWQGO6c7ywieuNQrtCRLmqSGQIWwlNG11a3VbxtakzvnMVSSAnXoqjQB9/OigJMT15HMgE+MQdLehC+xg1wi+BQ+TlcHIiEk9YYbckKEY0vNW0jFABUhdFCeZdCYXnpd/qTXaLnBLPQ6glShJCPcCS9mjEk8SX2Ho/U+Qeq3Qf1fr/eWiwxbEHB7V1cjOjT6WZIS6Bs/V/SmhoCVS2eh6kDGy5kbDxfH+oJEwDaxr0rL9GuRI598/vEi14E5gVLmBQ5KoeTyeLszcVbWL2cL1ky6aJ/4HEv3p6/ev395WsyhgppBOx4vpwviUTDRcPV5KZ+If12tzHuYT1Zqv5P+2vfyj0++IWRXIRJKvi87YegGzbZZ9Pp6nqbsJrGpfSGbbf0Bn+wsuuI/FOLlmat24StuBU8o1Z+s2WFcPS7GPfQT3r7xft+pX0Bf3gLftKXYVZRNKisuGzD/piwe9wcbOLdbZcMAwsZGzleRZOOrkjPTsOjAZgmrihxludo/LO804nz4t3lFUtY1m/RTVjTmeVr2uv5OlqrA0RxPybalkmuqpZXxBt10oxFRXx/QLsPA1r/g7x6Eo/9yS26QX/JqScFtts4/HXdyB+PPinRAztwU3Buu677LzAfPJU=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Update Document","permalink":"/docs/API-docs/v1.1/update-document"},"next":{"title":"Delete Document","permalink":"/docs/API-docs/v1.1/deletedocument"}}');var c=o(74848),s=o(28453),i=o(57742),r=o.n(i),d=o(78178),a=o.n(d),l=o(19624),u=o.n(l),p=o(96226),m=o.n(p),h=(o(77675),o(19365),o(51107)),v=o(21312);const y={id:"revokedocument",title:"Revoke Document",description:"The Revoke document API allows you to revoke specific document from your documents.",sidebar_label:"Revoke Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V81u5DYSfpVaXjbTkLvbHieL1SnOZDAxdpAxxg4MrMcwKKkkMaZIhqS63WgIyCFvkFOu+2jzJIsiJbW67XEy2GwudqtYVaz6qlg/W+Z55Vh6w77Vedug8o7dJqxAl1thvNCKpeyqRniPK32PUPRccHZxDlxKvXaw0S14DTZyOIO5KEW+Yy2tbojJjiQ3ZwnTBi2nG84LlrIoPTCwhBlueYMeLVm3ZYo3yFI2MNyJgiVMkHWG+5odmnxh9UoUCDr7EXN/XoAudwaNxrKEWfypFRYLlnrbYsKc30i6yInGSGLAByN1gSwtuXTEkNfYcJZumd+YwOmtUBVLWKltw/2Ugg88aEmZqU+y+oS7gnXdbbwVnf9GFxvSlGvlyet0y7gxUuQBl8WPjnzZPr4yekUgWULRC3R0apH3Eoem7QxhXZcwL3z4OAC96+jQojNauajyZLmkf/vgDqnSo1iAa/McnStbKTd/Y8mf5c8QvOc9+uaBgDXfmZcsWB9MOvPPC50sT14eHS+Plv+4Ov4qPf1n+uVX8+Vy+W+WsIdGkuyQcNwjm0AWv7tDtj6fHmHbY3r6FIyXukFfC1XBmsBcW62qBIxE7hC83QCvuFAguUf7J6KK1mr7PDqfZ9k0o4SSQuHdkEN3p8vl3fEIwukzuaS0h1K3qvhrXX3q/ucdOr17OTr05WOHztWKS1GEAnml71H9tf5Mr/fx+sfZKiJTOGd7zk7p0UmHeWuF34Qq/HDEjTiK5+nNLZUyyhRNFdxoF+u2r1nKFkNVWWwnNbtjpNCuhqreWslSVntvXLpYOK6KTD/MtUHlRKUkz9w8182CG7FYHc+PWZccynBjPosf26PPFXGeV0JVvyd3u8PqkuIZQ7aH2Bg4bsS/cMOSISBTrr6t1cgLtCF4lCbvdx3j9RDsXcVnFEWhSh3u6KP5zqC6FJUKuRBsPOyS1yhz3SA1RF8jzGaDyMdf/jNKzWZj5wxZO/+gPqh3rQWj12jLVgJXBZQSH0QmMYhhE87G0cAhbyQ6JzcglMfKco9QiEp4LoHgpFKTc8MzIQUlO7HpODNM3oubw3WNvkZLR3+3CBwKXKGkNwK89brhnlSNnX6t7X1JQ0oCHLLWCYXOAaqaq5wYh4AloC1wBag8WmOFQ3DektUi2qaVtzz30HDFKyTdCUzBKlAKymqwOmudB6dlG0wGz4XUFgsYHFKIhQsgvqbRwiIQNdeNsVhTdq0QqlYU6BLIdYHgQrjJBVVAhs6DIVtEjo6Utkrq/D4EkBowGE2lRnBJM8/URhL3litHg0o/kPUxGAEzVlMnx2jgbPaDQ4rwW6HuXTqbfVBHcDPm1TVmTni8/WJ4Kev1+tELebEv80b479oM3qPRTnhtNzvpSvi6zcKrmioZP6KmN6gw5M/kzex0FDp3jx8pURc1SrO4RE8Z4hZnF+ehOr+Ajz//Cm+RWwW1XsdszVuLcgPVcBUhFyMfYRuLK5Q6JF5NiOcx+frZbkDwuub+48+/Ofge1yBU/6TIldnsos2kyOEKG0O91M1mKbyySFf6gQa+5h5yriBDcDWnVFoJDhxMlJZC3c/hTG2gdWhhLXwdkoHoQW7PDcJlN4dDxh0WoFWQGO6c7ywieuNQrtCRLmqSGQIWwlNG11a3VbxtakzvnMVSSAnXoqjQB9/OigJMT15HMgE+MQdLehC+xg1wi+BQ+TlcHIiEk9YYbckKEY0vNW0jFABUhdFCeZdCYXnpd/qTXaLnBLPQ6glShJCPcCS9mjEk8SX2Ho/U+Qeq3Qf1fr/eWiwxbEHB7V1cjOjT6WZIS6Bs/V/SmhoCVS2eh6kDGy5kbDxfH+oJEwDaxr0rL9GuRI598/vEi14E5gVLmBQ5KoeTyeLszcVbWL2cL1ky6aJ/4HEv3p6/ev395WsyhgppBOx4vpwviUTDRcPV5KZ+If12tzHuYT1Zqv5P+2vfyj0++IWRXIRJKvi87YegGzbZZ9Pp6nqbsJrGpfSGbbf0Bn+wsuuI/FOLlmat24StuBU8o1Z+s2WFcPS7GPfQT3r7xft+pX0Bf3gLftKXYVZRNKisuGzD/piwe9wcbOLdbZcMAwsZGzleRZOOrkjPTsOjAZgmrihxludo/LO804nz4t3lFUtY1m/RTVjTmeVr2uv5OlqrA0RxPybalkmuqpZXxBt10oxFRXx/QLsPA1r/g7x6Eo/9yS26QX/JqScFtts4/HXdyB+PPinRAztwU3Buu677LzAfPJU=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},k=void 0,g={},f=[];function x(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Revoke Document"}),"\n",(0,c.jsx)(r(),{method:"post",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,c.jsx)(t.p,{children:"The Revoke document API allows you to revoke specific document from your documents."}),"\n",(0,c.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,c.jsx)(v.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,c.jsx)(a(),{...o(87513)}),"\n",(0,c.jsx)(u(),{...o(9379)}),"\n",(0,c.jsx)(m(),{...o(19461)})]})}function w(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,c.jsx)(t,{...e,children:(0,c.jsx)(x,{...e})}):x(e)}},87513(e){e.exports=JSON.parse('{"parameters":[{"name":"document_id","in":"path","description":"Provide objectId of document to revoke","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"ph2bh2asd"}}]}')},9379(e){e.exports=JSON.parse('{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string","example":""}},"title":"revokedocument"}}}}}')},19461(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Document revoked successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","example":"Bxh2aspHp3"},"revokedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"xml":{"name":"revoke"},"title":"revoke"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"Document not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Document not found!"}},"title":"inline_response_404_3"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/7357a3c5.1ede26e4.js b/assets/js/7357a3c5.1ede26e4.js deleted file mode 100644 index dbbc9b86b..000000000 --- a/assets/js/7357a3c5.1ede26e4.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[1665],{98268(e,t,n){n.r(t),n.d(t,{assets:()=>x,contentTitle:()=>j,default:()=>C,frontMatter:()=>g,metadata:()=>o,toc:()=>y});const o=JSON.parse('{"id":"API-docs/v1.1/getfolder","title":"Get Folder","description":"The Get Folder API allows you to retrieve details about a specific folder.","source":"@site/docs/API-docs/v1.1/getfolder.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/getfolder","permalink":"/docs/API-docs/v1.1/getfolder","draft":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJy9V81uI7kRfpUKL9kR2pLs9WwSnWIsJl5nBzPG2gsD8QgGu7u6m2M2ySWrJQuCgD3kDXLKNY82TxIU+0ct2zOJk8VcbDXJKn5V9dUPt4JkGcTiVvzF6hy9WCYix5B55UhZIxbiukI4R4J2H84uL0BqbdcBNrYBsuCRvMIVQo4klQ4gU9sQSAgOM1WoDIooOhWJsA69ZMUXuViIEqndEolw0ssaCT2D2QojaxQL0W7fqVwkQjEaJ6kSjyHa9CNmdJGDLWBQ6PGXRnnMxYJ8g4kItNGsMqjaaRSJwAenbY5iUUgd+EBWYS3FYito4+JJ8sqUIhGF9bWk8Qo+yKhlIdwPx2mVnVQuFbvdkq8NzpqAgRWdzOf87xBtaLIMQygaDYM7RCIyawgN8XnpnFZZ3Jh9DCy0fYquNZo951kNqfbK3hcvtqM6TquHk49O7JLO7e9iDF6mxuC6D8EuBhUNtcx5OaS/nhgZXt+rS3ys639FFpp0hC7zKAnzM3pO1V7wZH7y7dHx/Gj+h+vj7xanf1q8/m46n8//JhLxUGuW7ciaS4pISZEefzcu/wr3jBa6rPEYxG7HG6fP8fDK1kiVMiWs0RCsvTVlAk6jDAjkNyBLqQxoSeh/99sRFL23/sueeBmyseXKaGXwrk/Cu9P5/O54cMLpUye0rgJjCQrbmHz6FQz9Ekuf4vmyead3fxzMe/3UvAuzklrlsWpf23s0XzeQ4+upvZ6hHtJZtYfivjgwdrzeGhkwa7yiTewRD0fSqaN2f3G75OrLvLFda4lNhSqxELPWq7Pt0E52gnX5Vd9uGq/FQlRELixmsyBNntqHqXVogiqNlmmYZraeSadmq+Ppsdglj2Wkcy86j83RS0UCyVKZ8j/JLfduuuJQttE6cNYQM+nUj7gRSR+L8amu41YoY73c8Xdho3AXofcOzZUqTYxvvPxxZ75BndkaeUygCmEy6UU+/f1fg9RkArnNmhoNRSZOP5gP5n3jwdk1eu6T0uRQaHxQqcYohnXcG2aQgLLWGILegDKEpZeEkKtSkdTAfuJikkknU6UVE5iPWZb2MMqBMIWbCqlCz1u/9wgSclyhZt6DbMjWklhVjxfW1t8XPA0lICFtgjIYAqCppMn4YB+JBKwHaQANoXdeBYRAnlGrFps15GVGUEsjS2TdCYydlaNWTFfwNm0CQbC6iZCBhy7rMYfeIIOYh+jENzzieARezWztPFZMmxVC2agcQwKZzRFCzFc2weSQYiBwjEVlGFhpY7TN7mMAi0ZrcJbLh5Ka560xRhYnL03gCtdi6WMwOMx5y9MPtgAnk58DcoTfKnMfFpPJB3MEtwOvbjANinD5TZ8C6/X6CfVfHcqcK/qhSeEndDYosn6zly4VVU0a02WsZPhoNZ2jwcifUTLsdeQ2C0+zj1dnFWo3u0JihoTZ2eVFrLiv4NOv/4C3KL2Byq5btmaNR72Bsr+KPddGvnXbUDChsJF4FXs8a8nHky0G6j14U0n69Os/A7zDNSjTpRSbMplcNqlWGVxj7bhbhslkAd/HsQeoXwOqJEEmDaQIoZJMpZWSIMG10lqZ+ymcmQ00AT2sFVWRDLwe5Q7MYL8M4Q6QyoA5WBMl+june0S8XgfUKwysixtfioC5ImZ05W1TtreNwXTGeSyU1nCj8hIp2naW5+C65XW7zA4fwcGCE4Iq3ID0CAENTeHykUjcaZyznlGoFnxh+dnDAUCTO6sMhQXkXha015/siR6nS2XNM0utC+XgjqRTM4SkzcTO4mF1+oGL8qNCflhvPRbo+cJo9j4uTnV0uu1pCczW/4fWcYK2hmQWJwmspdJtR/nzYz2xq6Ovw/viCv1KZdh1tc9k9CwenolEaJWhCTiaFs7OL9/C6tvpXCSj9vhfJPfs7cX3b95dvWEwXEhbhx1P59N5fF7YQLU0o5v2j97HbW27H6F+2+dx15UJH2jmtFRxHopWbrtZ5lYMD9zF/nG8TERlA/H2dssZ97PXux0v/9Kg52lpmYiV9Eqm3LhvtyJXgX/nw+v3swZ+81P3kH4Fz76zn8XcjxeGZ4uV1A1/iUTc4+bgVb9b7pJ+wmBY7f5ZlqGjkeSTMfVg1jt/cy0SwUXycLK5j5NN94O1P4vqcORpAfBfnr+eFdhu26lptxvOt1uflegM7E+zi5a73e7f5nsaRw==","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Folder","permalink":"/docs/API-docs/v1.1/createfolder"},"next":{"title":"Update Folder","permalink":"/docs/API-docs/v1.1/updatefolder"}}');var s=n(74848),a=n(28453),i=n(57742),r=n.n(i),l=n(78178),d=n.n(l),p=n(19624),c=n.n(p),f=n(96226),h=n.n(f),u=(n(77675),n(19365),n(51107)),m=n(21312);const g={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:"eJy9V81uI7kRfpUKL9kR2pLs9WwSnWIsJl5nBzPG2gsD8QgGu7u6m2M2ySWrJQuCgD3kDXLKNY82TxIU+0ct2zOJk8VcbDXJKn5V9dUPt4JkGcTiVvzF6hy9WCYix5B55UhZIxbiukI4R4J2H84uL0BqbdcBNrYBsuCRvMIVQo4klQ4gU9sQSAgOM1WoDIooOhWJsA69ZMUXuViIEqndEolw0ssaCT2D2QojaxQL0W7fqVwkQjEaJ6kSjyHa9CNmdJGDLWBQ6PGXRnnMxYJ8g4kItNGsMqjaaRSJwAenbY5iUUgd+EBWYS3FYito4+JJ8sqUIhGF9bWk8Qo+yKhlIdwPx2mVnVQuFbvdkq8NzpqAgRWdzOf87xBtaLIMQygaDYM7RCIyawgN8XnpnFZZ3Jh9DCy0fYquNZo951kNqfbK3hcvtqM6TquHk49O7JLO7e9iDF6mxuC6D8EuBhUNtcx5OaS/nhgZXt+rS3ys639FFpp0hC7zKAnzM3pO1V7wZH7y7dHx/Gj+h+vj7xanf1q8/m46n8//JhLxUGuW7ciaS4pISZEefzcu/wr3jBa6rPEYxG7HG6fP8fDK1kiVMiWs0RCsvTVlAk6jDAjkNyBLqQxoSeh/99sRFL23/sueeBmyseXKaGXwrk/Cu9P5/O54cMLpUye0rgJjCQrbmHz6FQz9Ekuf4vmyead3fxzMe/3UvAuzklrlsWpf23s0XzeQ4+upvZ6hHtJZtYfivjgwdrzeGhkwa7yiTewRD0fSqaN2f3G75OrLvLFda4lNhSqxELPWq7Pt0E52gnX5Vd9uGq/FQlRELixmsyBNntqHqXVogiqNlmmYZraeSadmq+Ppsdglj2Wkcy86j83RS0UCyVKZ8j/JLfduuuJQttE6cNYQM+nUj7gRSR+L8amu41YoY73c8Xdho3AXofcOzZUqTYxvvPxxZ75BndkaeUygCmEy6UU+/f1fg9RkArnNmhoNRSZOP5gP5n3jwdk1eu6T0uRQaHxQqcYohnXcG2aQgLLWGILegDKEpZeEkKtSkdTAfuJikkknU6UVE5iPWZb2MMqBMIWbCqlCz1u/9wgSclyhZt6DbMjWklhVjxfW1t8XPA0lICFtgjIYAqCppMn4YB+JBKwHaQANoXdeBYRAnlGrFps15GVGUEsjS2TdCYydlaNWTFfwNm0CQbC6iZCBhy7rMYfeIIOYh+jENzzieARezWztPFZMmxVC2agcQwKZzRFCzFc2weSQYiBwjEVlGFhpY7TN7mMAi0ZrcJbLh5Ka560xRhYnL03gCtdi6WMwOMx5y9MPtgAnk58DcoTfKnMfFpPJB3MEtwOvbjANinD5TZ8C6/X6CfVfHcqcK/qhSeEndDYosn6zly4VVU0a02WsZPhoNZ2jwcifUTLsdeQ2C0+zj1dnFWo3u0JihoTZ2eVFrLiv4NOv/4C3KL2Byq5btmaNR72Bsr+KPddGvnXbUDChsJF4FXs8a8nHky0G6j14U0n69Os/A7zDNSjTpRSbMplcNqlWGVxj7bhbhslkAd/HsQeoXwOqJEEmDaQIoZJMpZWSIMG10lqZ+ymcmQ00AT2sFVWRDLwe5Q7MYL8M4Q6QyoA5WBMl+june0S8XgfUKwysixtfioC5ImZ05W1TtreNwXTGeSyU1nCj8hIp2naW5+C65XW7zA4fwcGCE4Iq3ID0CAENTeHykUjcaZyznlGoFnxh+dnDAUCTO6sMhQXkXha015/siR6nS2XNM0utC+XgjqRTM4SkzcTO4mF1+oGL8qNCflhvPRbo+cJo9j4uTnV0uu1pCczW/4fWcYK2hmQWJwmspdJtR/nzYz2xq6Ovw/viCv1KZdh1tc9k9CwenolEaJWhCTiaFs7OL9/C6tvpXCSj9vhfJPfs7cX3b95dvWEwXEhbhx1P59N5fF7YQLU0o5v2j97HbW27H6F+2+dx15UJH2jmtFRxHopWbrtZ5lYMD9zF/nG8TERlA/H2dssZ97PXux0v/9Kg52lpmYiV9Eqm3LhvtyJXgX/nw+v3swZ+81P3kH4Fz76zn8XcjxeGZ4uV1A1/iUTc4+bgVb9b7pJ+wmBY7f5ZlqGjkeSTMfVg1jt/cy0SwUXycLK5j5NN94O1P4vqcORpAfBfnr+eFdhu26lptxvOt1uflegM7E+zi5a73e7f5nsaRw==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},j=void 0,x={},y=[];function k(e){const t={p:"p",...(0,a.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Get Folder"}),"\n",(0,s.jsx)(r(),{method:"get",path:"/folder/{folder_id}",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Get Folder API allows you to retrieve details about a specific folder."}),"\n",(0,s.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(m.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(d(),{...n(12898)}),"\n",(0,s.jsx)(c(),{...n(48680)}),"\n",(0,s.jsx)(h(),{...n(7938)})]})}function C(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(k,{...e})}):k(e)}},12898(e){e.exports=JSON.parse('{"parameters":[{"name":"folder_id","in":"path","description":"objectId of folder","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"pH1bhc2hpb"}}]}')},48680(e){e.exports={title:"Body"}},7938(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"ph1bhx2jp"},"folderName":{"type":"string","format":"string","example":"new folder"},"parentFolderId":{"type":"string","format":"string","example":"J2nas5kiPe"},"parentFolderName":{"type":"string","format":"string","example":"new sub folder"},"createdAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"title":"folder_res"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"folder not found.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","format":"string","example":"folder not found."}},"title":"inline_response_404_8"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/7357a3c5.77ae01b7.js b/assets/js/7357a3c5.77ae01b7.js new file mode 100644 index 000000000..3d2204ac9 --- /dev/null +++ b/assets/js/7357a3c5.77ae01b7.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[1665],{98268(e,t,o){o.r(t),o.d(t,{assets:()=>b,contentTitle:()=>x,default:()=>F,frontMatter:()=>P,metadata:()=>r,toc:()=>u});const r=JSON.parse('{"id":"API-docs/v1.1/getfolder","title":"Get Folder","description":"The Get Folder API allows you to retrieve details about a specific folder.","source":"@site/docs/API-docs/v1.1/getfolder.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/getfolder","permalink":"/docs/API-docs/v1.1/getfolder","draft":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJy9Wd1uG7kVfpVTBihsYSTZ2ey21Rbbuo43cZsmhmU3QC3DQw2PNFxR5CzJkSzYAvai6AMUveltX6L3fZQ8SXHImdFI9ibr7mIvEtvk4eH5+c4Pz9wxz6eODa7Y10YJtOw6YQJdZmXhpdFswC5yhFfoIe7D0dkpcKXM0sHKlOANWPRW4gJBoOdSOeBjU3rg4ArM5ERmMAlHeyxhpkDLifGpYAM2RR+3WMIKbvkcPVoS5o5pPkc2YHH7RgqWMEnSFNznbFdEM/4GM38qwEygYWjx21JaFGzgbYkJc36liKWT80IhSxjeFsoIZIMJV44IshznnA3umF8VgdJbqacsYRNj59y3V/CWBy4DVrw+HOfZ87wYs/X6mq51hdEOHTF6fnBAP7aldWWWoXOTUkFjDpawzGiP2hM9Lwols7DR/8bRobuH0kWlyXKW2HgZr6xt8WQ98sNxfvv8m4Ktk8rsb4MPnsZG47J2wTo4FbWPyHm6SH98rrn7fCbPcJfX/yuZK8ct6TKL3KM48o+x2hx8fvD8s+7hQffgVxeHXwxe/Gbw+Re9g4ODv7KE3c4Vna3AKrgPknrpVfvvshA/wz2thSpqLDq2XtPGi8dwODRz9LnUU1ii9rC0Rk8TKBRyh+DtCviUSw2Ke7S/+OkAitYa+3FLPE2ytuZSK6nxpg7CmxcHBzeHjRFePDRCNBVo42FiSi16P4OiH0PpQ3k+rt6Lm1836n3+UL1TveBKipC1L8wM9c/ryPb1Pl5Pom7DWUaisM+2lG2vRyUdZqWVfhVqxG2XF7Ib9wdX15R9CTemKi2hqPicDVg/WrV/15STNSNedlGXm9IqNmC594Ub9PuOazE2tz1ToHZyqhUfu15m5n1eyP7isPecrZPdM7wonkSPZfepR5znU6mnnzp3vTHTkFwZvbVlrMZnvJB/whVLal+0qaqKmyMP+XJNf09MOFx56F2BeiinOvg3XL5bmZ9BTfPhb/9uyEZ6pL+CTodaC1Kk60xpM4SXJisDP648Ws29XCB8+O6fMC6looCwIHCBilDoEvC2dB4FjFeA2qMtrHToep0O8W/fO5ULjO0Kh8wQNj0mUFgjyowE7VrkYgXYJYtyX1qEQnFPcQo+t6ac5tTOSD1VmMD5yfCCivfR2WkPhqgFCJOVc9TeBREbJgnMueZTBI9z4odBZp7NAgmlN+e5Lx1IDRa5Ai/nmADXAnjpzZx7JKEtaSctNteAkhPMVpmKxuFKwVL6nJquBWphLCiTzbpS98gQ3W6Xfjx7Rl2cp1uHnluPglZPFmhXQK0SOg/z0nnIuLWreG8TtiShzxHSFj5SiMgIl6RpOtKtzQH8ljhsFr6qaEa60/nw93/A1WuzpOZxippaINy58HqvBr0wmXuIdlrt56iK/jAq5fpHZ6chw+1H/781Hhx5cpmjRbpqjFOpfweXVENyhE6nCnNAvZDWaDJtpwN76Q9OA+k+8S2s8YbiqfECn0wwC6ZWhGDBPd9xxbGxCMe84GOpJCVUWr+HY+5xauwK7uF9zn2AbMY1CAP3I33f7XbDPyLtdF7WqOt04B6OQzOTgEMtEogtRwIWF2ZWYUog4X4Dz27t9g18K84XNV4D5z+UUgmwWDo+Vi0wB3WhsNgtFM9QwFKKKXr3ZZCBLGM0grEUBatwLdrmiiGqSZfiM1zxqkaBo+VA2o6qxq4VF5B6IX2oWjBRZlkzPSvHSmawLf4w5xaBQxE369BTUs9C+GhTc1XSeaifDTXPl5ZPPLw3dkY3RY58gS3pjG3ZhDsQdMIFk0+k5kpGwM1jv1LzPTba86xy3p9jnggxUAmTxX0YGzMjiE0tn8+5lxlXalUzid1w5PHOTrmmuzaSSe2kwCYFw0tLcIxFsPHEexznxswik3PMkGgoHXUpHQEuKONo4+klF0zuICLTgllqQC0KI7Wv2V26WqDz+l3Is8yU2geLZBaF9ECVhJog8uD9dmgQ8D989y8Hb3FJeacuGLT5DI6851kesuD7ADcYlkVhrB9pqiYpb/ZdWgESpANtqPkPhCjA6OikxlQJxLdAayES1I5tCDYLpE2FqXqR8pfr1aK+JtsPozeHFereSD1zIz1ED+mI5VLgTfT3TYXLGxUo2ICqG8I9hMdpSiKnZ++GF9APgtVyphRmxKaGTRverk7b28pC3T72NmY9VsjpeB06tfO4Gun01ckF9Gsd+wMp0qD89joFTwo5hcYYUYPzFvmc2lURwsyiKLXg2sPmpQ8UmRbnZoEisOx0CosTqVTImbXjLPrSEh+HdNajWsHEmnmt84Zhp0M1d0YGaN7hgNxJtGSozGhXzrHx0Bl3bmms6J5Z4zEjaJy9/HqDKNonP02kwpuiIh6xtLZrnUDHRqyozmhYGhtuD6kRdWZXRcXV9Wq+AYCDka78GYFVmzGF//4H0rPLBxYPy60DtTf7g5ruZptsByc7Gzv3hQ1KvmTStLbPu8mEHNigl3KWNarBb5gD3ZhIFRD8MeDuKhow9Iim3gCNZmQmvaLOLlQdav1kLEDVfQ3UqedCnuVNGDb+rYLv3CgqsCE/VGUohfioCfjiWYYFZWzSqQpHaxSSpycSlQCeWeNc6LSCFpS2rCk9uh5c5BYRiD7iuUkzg1jT6XaqopjzhaSsuVvJK5lS6OwJnPBS+f1QE0IzVnWrlHLp+etDTd20qVWGi3wWEpfEp0njLkZ/HfdkKItEBUarVV39qrIdp3p14Ut5UViziOyOuY6RTYW8JsdbslpVk6M0Ve0Ml903qYXbsdFwbIoV7B0f75NwspCUoUf6CGgsk45Ylm2s/SBfc2X0NJQy0gdvpQvNVTpi4/Y5SutN/t4k6pj9CG1Nd9F4sR8bpcaZJ3MuFXAhLDrKHZTVUFC8NzLaqkRy6pTHRncz0qxdIAEDF6Mz3HaAdI1DRQ/eyBludEhI/C1pYM+VWU4dRYySTcRLke5TT7CQorJDFI38ZaWo/N5UpQVXJSahkscsRZZVkgxLbQrgvPAr4NbyFeylV9fp/pdg5tIHLtG03oDUOdpqcZv1Tm97tOBShUg92TTWVYPbWqGYoHnO5fmbR5rbYey9QyPxhIa86QSbt902h48+nZvTJ5dwjtMHhz/1ZE93W5m/oHXShCT1S/gDz2ZLboWDYzMvuJeh9V8RKR0mcExK6u3GNWE3qwhVfFrA4jDAeHHYO2xefnX/5WJJ9LlxCIt4cUxIvPGHobIlHYxruweu2sDYYqyaWc71lAKBmq9WoZaU+EWZxVgI8hJrE975XEGpFToHxudol9SEakMY3zbHpUN6N1c90Eh34appTd/j2EmPm3ffcrl8YOn9cObrUimoHz8h4D7xWozHXkn/uhzDORbGSW/sanNqKn1ejoMv22ebPyoG9SOlGab9mFdqYHmBdu7oq8UQ7UJmn1C/74m8vz+i2czOPGd77GJxgpbyjtt6Y/NCVu/5q1oOIPF+jB5hkB7fKmEoSKkvDpZ+v8snDPdIhXeTSt9quPVxfVnClMxQO2wNDY9enb2BxWe9A5a0pmQ/wJf9N6fHJ2+HJyRMFSZswA57B72D8JXBOD/nunXT5tvX7nTrbjNJ/Wm/klXDOY+3vl8oLsNYNGh5V400r1jznWuw+UZ2nbDcOE/bd3cU5JdWrde0/G2Jloam1wlbcCspG4S5Z9VTieYj2PcquHdePYz34dHPbY/KXE8ZNY0YQ61gA8YSNsPV1se99fU6qQeNJFbcPwp9Wevkg2n11sj31ckFSxgvyT7tAecsDDirX4j7o1JtTz6jAPQ/jWEfPXB3F4en63VDH7e+90SlYE1NJrper9f/A3r1aOA=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Folder","permalink":"/docs/API-docs/v1.1/createfolder"},"next":{"title":"Update Folder","permalink":"/docs/API-docs/v1.1/updatefolder"}}');var n=o(74848),p=o(28453),i=o(57742),s=o.n(i),a=o(78178),l=o.n(a),d=o(19624),c=o.n(d),m=o(96226),h=o.n(m),f=(o(77675),o(19365),o(51107)),g=o(21312);const P={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:"eJy9Wd1uG7kVfpVTBihsYSTZ2ey21Rbbuo43cZsmhmU3QC3DQw2PNFxR5CzJkSzYAvai6AMUveltX6L3fZQ8SXHImdFI9ibr7mIvEtvk4eH5+c4Pz9wxz6eODa7Y10YJtOw6YQJdZmXhpdFswC5yhFfoIe7D0dkpcKXM0sHKlOANWPRW4gJBoOdSOeBjU3rg4ArM5ERmMAlHeyxhpkDLifGpYAM2RR+3WMIKbvkcPVoS5o5pPkc2YHH7RgqWMEnSFNznbFdEM/4GM38qwEygYWjx21JaFGzgbYkJc36liKWT80IhSxjeFsoIZIMJV44IshznnA3umF8VgdJbqacsYRNj59y3V/CWBy4DVrw+HOfZ87wYs/X6mq51hdEOHTF6fnBAP7aldWWWoXOTUkFjDpawzGiP2hM9Lwols7DR/8bRobuH0kWlyXKW2HgZr6xt8WQ98sNxfvv8m4Ktk8rsb4MPnsZG47J2wTo4FbWPyHm6SH98rrn7fCbPcJfX/yuZK8ct6TKL3KM48o+x2hx8fvD8s+7hQffgVxeHXwxe/Gbw+Re9g4ODv7KE3c4Vna3AKrgPknrpVfvvshA/wz2thSpqLDq2XtPGi8dwODRz9LnUU1ii9rC0Rk8TKBRyh+DtCviUSw2Ke7S/+OkAitYa+3FLPE2ytuZSK6nxpg7CmxcHBzeHjRFePDRCNBVo42FiSi16P4OiH0PpQ3k+rt6Lm1836n3+UL1TveBKipC1L8wM9c/ryPb1Pl5Pom7DWUaisM+2lG2vRyUdZqWVfhVqxG2XF7Ib9wdX15R9CTemKi2hqPicDVg/WrV/15STNSNedlGXm9IqNmC594Ub9PuOazE2tz1ToHZyqhUfu15m5n1eyP7isPecrZPdM7wonkSPZfepR5znU6mnnzp3vTHTkFwZvbVlrMZnvJB/whVLal+0qaqKmyMP+XJNf09MOFx56F2BeiinOvg3XL5bmZ9BTfPhb/9uyEZ6pL+CTodaC1Kk60xpM4SXJisDP648Ws29XCB8+O6fMC6looCwIHCBilDoEvC2dB4FjFeA2qMtrHToep0O8W/fO5ULjO0Kh8wQNj0mUFgjyowE7VrkYgXYJYtyX1qEQnFPcQo+t6ac5tTOSD1VmMD5yfCCivfR2WkPhqgFCJOVc9TeBREbJgnMueZTBI9z4odBZp7NAgmlN+e5Lx1IDRa5Ai/nmADXAnjpzZx7JKEtaSctNteAkhPMVpmKxuFKwVL6nJquBWphLCiTzbpS98gQ3W6Xfjx7Rl2cp1uHnluPglZPFmhXQK0SOg/z0nnIuLWreG8TtiShzxHSFj5SiMgIl6RpOtKtzQH8ljhsFr6qaEa60/nw93/A1WuzpOZxippaINy58HqvBr0wmXuIdlrt56iK/jAq5fpHZ6chw+1H/781Hhx5cpmjRbpqjFOpfweXVENyhE6nCnNAvZDWaDJtpwN76Q9OA+k+8S2s8YbiqfECn0wwC6ZWhGDBPd9xxbGxCMe84GOpJCVUWr+HY+5xauwK7uF9zn2AbMY1CAP3I33f7XbDPyLtdF7WqOt04B6OQzOTgEMtEogtRwIWF2ZWYUog4X4Dz27t9g18K84XNV4D5z+UUgmwWDo+Vi0wB3WhsNgtFM9QwFKKKXr3ZZCBLGM0grEUBatwLdrmiiGqSZfiM1zxqkaBo+VA2o6qxq4VF5B6IX2oWjBRZlkzPSvHSmawLf4w5xaBQxE369BTUs9C+GhTc1XSeaifDTXPl5ZPPLw3dkY3RY58gS3pjG3ZhDsQdMIFk0+k5kpGwM1jv1LzPTba86xy3p9jnggxUAmTxX0YGzMjiE0tn8+5lxlXalUzid1w5PHOTrmmuzaSSe2kwCYFw0tLcIxFsPHEexznxswik3PMkGgoHXUpHQEuKONo4+klF0zuICLTgllqQC0KI7Wv2V26WqDz+l3Is8yU2geLZBaF9ECVhJog8uD9dmgQ8D989y8Hb3FJeacuGLT5DI6851kesuD7ADcYlkVhrB9pqiYpb/ZdWgESpANtqPkPhCjA6OikxlQJxLdAayES1I5tCDYLpE2FqXqR8pfr1aK+JtsPozeHFereSD1zIz1ED+mI5VLgTfT3TYXLGxUo2ICqG8I9hMdpSiKnZ++GF9APgtVyphRmxKaGTRverk7b28pC3T72NmY9VsjpeB06tfO4Gun01ckF9Gsd+wMp0qD89joFTwo5hcYYUYPzFvmc2lURwsyiKLXg2sPmpQ8UmRbnZoEisOx0CosTqVTImbXjLPrSEh+HdNajWsHEmnmt84Zhp0M1d0YGaN7hgNxJtGSozGhXzrHx0Bl3bmms6J5Z4zEjaJy9/HqDKNonP02kwpuiIh6xtLZrnUDHRqyozmhYGhtuD6kRdWZXRcXV9Wq+AYCDka78GYFVmzGF//4H0rPLBxYPy60DtTf7g5ruZptsByc7Gzv3hQ1KvmTStLbPu8mEHNigl3KWNarBb5gD3ZhIFRD8MeDuKhow9Iim3gCNZmQmvaLOLlQdav1kLEDVfQ3UqedCnuVNGDb+rYLv3CgqsCE/VGUohfioCfjiWYYFZWzSqQpHaxSSpycSlQCeWeNc6LSCFpS2rCk9uh5c5BYRiD7iuUkzg1jT6XaqopjzhaSsuVvJK5lS6OwJnPBS+f1QE0IzVnWrlHLp+etDTd20qVWGi3wWEpfEp0njLkZ/HfdkKItEBUarVV39qrIdp3p14Ut5UViziOyOuY6RTYW8JsdbslpVk6M0Ve0Ml903qYXbsdFwbIoV7B0f75NwspCUoUf6CGgsk45Ylm2s/SBfc2X0NJQy0gdvpQvNVTpi4/Y5SutN/t4k6pj9CG1Nd9F4sR8bpcaZJ3MuFXAhLDrKHZTVUFC8NzLaqkRy6pTHRncz0qxdIAEDF6Mz3HaAdI1DRQ/eyBludEhI/C1pYM+VWU4dRYySTcRLke5TT7CQorJDFI38ZaWo/N5UpQVXJSahkscsRZZVkgxLbQrgvPAr4NbyFeylV9fp/pdg5tIHLtG03oDUOdpqcZv1Tm97tOBShUg92TTWVYPbWqGYoHnO5fmbR5rbYey9QyPxhIa86QSbt902h48+nZvTJ5dwjtMHhz/1ZE93W5m/oHXShCT1S/gDz2ZLboWDYzMvuJeh9V8RKR0mcExK6u3GNWE3qwhVfFrA4jDAeHHYO2xefnX/5WJJ9LlxCIt4cUxIvPGHobIlHYxruweu2sDYYqyaWc71lAKBmq9WoZaU+EWZxVgI8hJrE975XEGpFToHxudol9SEakMY3zbHpUN6N1c90Eh34appTd/j2EmPm3ffcrl8YOn9cObrUimoHz8h4D7xWozHXkn/uhzDORbGSW/sanNqKn1ejoMv22ebPyoG9SOlGab9mFdqYHmBdu7oq8UQ7UJmn1C/74m8vz+i2czOPGd77GJxgpbyjtt6Y/NCVu/5q1oOIPF+jB5hkB7fKmEoSKkvDpZ+v8snDPdIhXeTSt9quPVxfVnClMxQO2wNDY9enb2BxWe9A5a0pmQ/wJf9N6fHJ2+HJyRMFSZswA57B72D8JXBOD/nunXT5tvX7nTrbjNJ/Wm/klXDOY+3vl8oLsNYNGh5V400r1jznWuw+UZ2nbDcOE/bd3cU5JdWrde0/G2Jloam1wlbcCspG4S5Z9VTieYj2PcquHdePYz34dHPbY/KXE8ZNY0YQ61gA8YSNsPV1se99fU6qQeNJFbcPwp9Wevkg2n11sj31ckFSxgvyT7tAecsDDirX4j7o1JtTz6jAPQ/jWEfPXB3F4en63VDH7e+90SlYE1NJrper9f/A3r1aOA=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-2",custom_edit_url:null},x=void 0,b={},u=[];function D(e){const t={p:"p",...(0,p.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(f.default,{as:"h1",className:"openapi__heading",children:"Get Folder"}),"\n",(0,n.jsx)(s(),{method:"get",path:"/folder/{folder_id}",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"The Get Folder API allows you to retrieve details about a specific folder."}),"\n",(0,n.jsx)(f.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,n.jsx)(g.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,n.jsx)(l(),{...o(12898)}),"\n",(0,n.jsx)(c(),{...o(48680)}),"\n",(0,n.jsx)(h(),{...o(7938)})]})}function F(e={}){const{wrapper:t}={...(0,p.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(D,{...e})}):D(e)}},12898(e){e.exports=JSON.parse('{"parameters":[{"name":"folder_id","in":"path","description":"objectId of folder","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"pH1bhc2hpb"}}]}')},48680(e){e.exports={title:"Body"}},7938(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"ph1bhx2jp"},"folderName":{"type":"string","format":"string","example":"new folder"},"parentFolderId":{"type":"string","format":"string","example":"J2nas5kiPe"},"parentFolderName":{"type":"string","format":"string","example":"new sub folder"},"createdAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"title":"folder_res"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"folder not found.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","format":"string","example":"folder not found."}},"title":"inline_response_404_8"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/767ebc75.49dae1ab.js b/assets/js/767ebc75.49dae1ab.js new file mode 100644 index 000000000..9112276e6 --- /dev/null +++ b/assets/js/767ebc75.49dae1ab.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[7797],{5049(e,t,s){s.r(t),s.d(t,{assets:()=>x,contentTitle:()=>f,default:()=>S,frontMatter:()=>u,metadata:()=>n,toc:()=>b});const n=JSON.parse('{"id":"API-docs/v1.1/getsignerips","title":"Get Signer IPs","description":"The Get Signer IPs API enables you to retrieve IPs of signers who signed the document.","source":"@site/docs/API-docs/v1.1/getsignerips.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/getsignerips","permalink":"/docs/API-docs/v1.1/getsignerips","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getsignerips","title":"Get Signer IPs","description":"The Get Signer IPs API enables you to retrieve IPs of signers who signed the document.","sidebar_label":"Get Signer IPs","hide_title":true,"hide_table_of_contents":true,"api":"eJzNWV9vG7kR/ypTBihiYSXZSdpedcX1fI7jc5smhmU3D5ZhUbsjLSMuuUdyJQu2gHso+gGKvvS1X6Lv/Sj5JMWQ3F1J9iWXXnHoQ2KbHA7n//w4e8ccn1k2uGIvdVoVqJxl1wnL0KZGlE5oxQbsIkc4QQdDMVNo4PTMwuHZKaDiE4kWVroCp8GgMwIX6Pf1FKyntrDMdfg9A5cjZPGe3kiN1BvtcAAXuQgchQWt5Ar4ggtJzGGqDVwgLyxwlcGxcmhKIyxCKbmyvZFiCdMlGk6inmZswGbows2itCxhJTe8QIeGlLxjihfIBqwW4kZkLGGClCy5y9mu5nryHlN3mpE+tYFYwgx+VwmDGRs4U2HCrFtJYmtFUUpkCcPbUuoM2WDKpSWCNMeCs8Edc6vSUzoj1IwlbKpNwd3mCt5yz2XA+DfP0vRZXk5ytl5f07W21MqiJUbP9vfpx7a8tkpTtHZaSWiswhKWauVI8sEd42UpReo3+u8tHbp7KF1Qm6xniI0T4craGp+rx6sTMX/2fJJf/oGtExa8c0PuaflwY/iKXOGwsJ+WBAsu5GNitJe+1zhB/Dou9FJd0OWivOFZZtDaj58++O3z3sEXv+696B188Ru2XifstvAXxgAKSpyW9jz6hJg74WS76TVc/1dHtzY9ixePeXuoC3S5UDNYonKwNFrNEiglcovgzAr4jAsFkjs0v/jfhQEao83Hzfd5kq03DCCUFApv6lC/ebG/f3PQGOHFQyPUaQlKO5jqSmU/r6qP3f9xhV7cPG8U+tVDhU7VgkuR+YJ4oeeofl59Nq934fqHMSwCkd9nW8purgclLaaVEW7l6+9tl5eiG/YHV9dU1ShSdKzcvmC7nA1Yvyni/buNar1mxNAs6npeGckGLHeutIN+33KVTfRtT5eo6LzkE0uZ3+el6C8Oes/YOtk9w8vys+ix6n7uEev4TKjZp85dt7Yakj+Dy7Ys1tbLUvwRqWBGh2xSxYaWI8/QeOcJNdX+cHTT2xIVNXPvZH/5buN7AjXNh7/8syGjlv0VdDoECEiRrtWVSdG3Rs+PS4dGcScWCB++/ztMKiGdb+IZLlBSKNoEnKmswwwmK8Cmo9tep0P8N++diUXEFxxSTQHqMIHS6KxKSdCuQZ6tALtkUe4q43GBo14ELje6muXAwQo1k5jA+fHwgjrj4dlpD4aosgaLWC9iwySBgis+Q3BYED/0MvN07kmoqlnHXWVBKDDIJThRYOIRCq+cLrhDEtqQdsK0kAekmGK6SmUwDpcSlsLlunKwQJVpA1Kn865QHht1u1368eQJYS9Htw4dNw4zWj1eoFkB4RC0DorKOki5Matwb5O7JCGBrvFGfIwhRIa/ZDwej9TG5gB+Rxzaha8izUh1Oh/++je4+lYvCe3NUBG+wJ0Lr5/WQZ/p1D6Mdlrt5yjL/jAoZfuHZ6e+zO0F/7/RDix5cpmjQbpqgjOhfg+X1DpyhE4npjmgWgijFZm204Gn4x9dBsZ7xLc02mnKp8YLfDrF1JtaUgRn3PEdVxxpg3DESz4RUlBVpfV7OOIOZ9qs4B7e5dz5kE25gkzD/Ujdd7td/49IO50GaXc6cA9HBjlFtUWVJVCVmf/L4ELPY0xlSHHfhme3dnsbvpHzRR2vnvM3lZAZGKysh9JNMHt1oTTYLSVPMYOlyAg1f+llIMtohaANZcGqgfHxiiHKaZfy019xUkeBpeWI8luxGrtGLiDUQjjfumAq9bJmelZNpEhhW/xhzg0ChzJs1qknhZr79FG65iqFdVBj8prnS8OnDt5pM6ebAke+wA3ptNmwCbeQ0Ynw0JgKxaUIAVcEmFLzPdLK8TQ670+hTvgciMKkYR8mWs8pxGaGFwV3IuVSrmomr7TM0AQeb82MK7qrlUwoKzJsSjC8NBSO03Co5vEOJ7nW88DkHFMkGipHXSpHgIsISsQ0ogULITIN6KUCVFmphXI1u0tbC3ReP+R4mupKOW+R1GAmHFAnIaBPHrzfTg0K/A/f/8PCG1xS3akbBm0+gUPneJr7KvjOhxsMq7LUxo0UdZMxb/btOAYkPQeVXoINhJiBVsFJjakSkovir10IBLVjG4J2gbSJMVUvUv2yvVrUb8n28a07jFH3Wqi5HakhOhiPWC4yvIkoP8bljfQUbEDdDeEe/MtvTCKPz94OL6DvBavlHFOaEZs6bDbD29Zle1tZqDFkrzXrkUROx+vUqZ3H5UiNT44voF/r2B+IbOyV316n5BlDTqkxQVRgnUFeEGbNfJoZzCqVceWgfUoDZabBQi8w8yw7ndLgVEjpa2btOIOuMsTHIp11KFcwNbqodW4ZdjrUc+dkgOaRC8itQEOGSrWyVYGNh864tUttsu6Z0Q5TCo2zl6/aiKJ98tNUSLwpI/GIjWu71gV0orMV9RkFS2387b40okrNqoxcba/m6wNwMFLRnyGwajOO4d//gvHZ5QOL++WNA7U3+4Oa7mabbCdOdjZ27vMbVHzJpOPaPm+nU3JgE71Us4yWTfxyKfXyRgcqH8EfC9xdRX0MPaKp00BzD5EKJ1dxOkRFNhOhAcX7mlAnzIU8zZs0bPwbk+9cS2qwvj7ENjSG8LLx8cXTFEuq2KRTTEejJZKnpwJlBjw12lqPtLwWVLaMrhzaHlzkBhGIPsRzU2YGoafT7dRFMecLQVVzt5NHmcbQeZrhlFfS7fme4MFYRKtUcunV63xPbWFqrHCBz0Lgkvg0ZdxuTcq8oQwSVRiPxe4X2zZ4b9aNb8zL0uhFYHfEVchsauQ1Od6S1WJPDtLE3ukvu29KCzcTreBIlyt4enS0R8KJUlCFHqlDULgks6dpa+0H9ZpLrWa+lZE+eCusB1fjEZtsnqOy3tTvtlCH6kfR1qCLxov9AJQaZx7TQAjiaAethwSYUb43MprYIjkh5YlW3ZQ022yQ4MdKoFWK2w4QtnFo1oPXYo6tDgmJvyUNPLVVmhOiCFnSZrzIxnuECRYii3YIopG/jMii35uutOCywsR38lClyLJSkGEJpgAWpVuBH53B0/HV9XjvS9CFcJ5LMK3TIFSOJi5us97BtofN1PW4BdYR4G6sUE7QGOfy/PUj4HYYsLcHEp8ByBsk2Lzttjl89OncnD6+hHOcPTj8qSf7eBfK/BmNFdoXqV/CNzydL7nJLBzpouROeOi/IlI6TMExrQjbTWrCbhoJZXhawOLAh/HioHfQvPxq/GVDS3S5tgiLcHEoSO0UXFPbEhYmtd09V6VhYjB0zTTnakaJQOBro1ELKvxZlYZc8PISa+3f+VxCpSRaC9rlaJYEQpWmGN82x6VFejdHDDRSXbhqoOk7nFjhsH33LZfLB5be82deVVI2U3SfcJ94LYZjJ8J9W03gHEtthdNm1Z6aCZdXE+/LzbPNH5FB/UhpJmo/5ZXqWV6gKfxHjiGahUg/oX7fEXl/z3+t2JnnbI9dDE7RUN2xW29sXor4nr+q5QAS76foQWO7+FbZmKjTYOnrXT5+wkcqvJ1GfeNw6+P6soRJkSINsdvJ4eHJ2WtYPO/ts2RjSvYjfNl/fXp0/GZ4TMLENKE5fW+/t09Lpbau4Grjpu0vVrsTrrt2pPr//n0rjvwc3rp+KbnwE1dvu7s4Lb1im5+8Bptft64TlmvriObujurHpZHrNS1/V6Ghoex1whbcCBLHj1QjXMuaj1c/aLen5/HNvQc/8KHsUdHrEaai+aVvRGzAWMLmuNr5NLe+Xif1HJNECxSHHvZtnH0wEd8aK58cX7CE8YoMtTk/nfv5afyFuD8q1/ZgNQhA/9OU99EDd3dhNrteN/Rh6wdPRAVrajLS9Xq9/g8moX3h","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Resend request mail","permalink":"/docs/API-docs/v1.1/resendrequestmail"},"next":{"title":"Get Formdata","permalink":"/docs/API-docs/v1.1/getformdata"}}');var i=s(74848),o=s(28453),r=s(57742),a=s.n(r),p=s(78178),d=s.n(p),l=s(19624),c=s.n(l),h=s(96226),g=s.n(h),m=(s(77675),s(19365),s(51107)),j=s(21312);const u={id:"getsignerips",title:"Get Signer IPs",description:"The Get Signer IPs API enables you to retrieve IPs of signers who signed the document.",sidebar_label:"Get Signer IPs",hide_title:!0,hide_table_of_contents:!0,api:"eJzNWV9vG7kR/ypTBihiYSXZSdpedcX1fI7jc5smhmU3D5ZhUbsjLSMuuUdyJQu2gHso+gGKvvS1X6Lv/Sj5JMWQ3F1J9iWXXnHoQ2KbHA7n//w4e8ccn1k2uGIvdVoVqJxl1wnL0KZGlE5oxQbsIkc4QQdDMVNo4PTMwuHZKaDiE4kWVroCp8GgMwIX6Pf1FKyntrDMdfg9A5cjZPGe3kiN1BvtcAAXuQgchQWt5Ar4ggtJzGGqDVwgLyxwlcGxcmhKIyxCKbmyvZFiCdMlGk6inmZswGbows2itCxhJTe8QIeGlLxjihfIBqwW4kZkLGGClCy5y9mu5nryHlN3mpE+tYFYwgx+VwmDGRs4U2HCrFtJYmtFUUpkCcPbUuoM2WDKpSWCNMeCs8Edc6vSUzoj1IwlbKpNwd3mCt5yz2XA+DfP0vRZXk5ytl5f07W21MqiJUbP9vfpx7a8tkpTtHZaSWiswhKWauVI8sEd42UpReo3+u8tHbp7KF1Qm6xniI0T4craGp+rx6sTMX/2fJJf/oGtExa8c0PuaflwY/iKXOGwsJ+WBAsu5GNitJe+1zhB/Dou9FJd0OWivOFZZtDaj58++O3z3sEXv+696B188Ru2XifstvAXxgAKSpyW9jz6hJg74WS76TVc/1dHtzY9ixePeXuoC3S5UDNYonKwNFrNEiglcovgzAr4jAsFkjs0v/jfhQEao83Hzfd5kq03DCCUFApv6lC/ebG/f3PQGOHFQyPUaQlKO5jqSmU/r6qP3f9xhV7cPG8U+tVDhU7VgkuR+YJ4oeeofl59Nq934fqHMSwCkd9nW8purgclLaaVEW7l6+9tl5eiG/YHV9dU1ShSdKzcvmC7nA1Yvyni/buNar1mxNAs6npeGckGLHeutIN+33KVTfRtT5eo6LzkE0uZ3+el6C8Oes/YOtk9w8vys+ix6n7uEev4TKjZp85dt7Yakj+Dy7Ys1tbLUvwRqWBGh2xSxYaWI8/QeOcJNdX+cHTT2xIVNXPvZH/5buN7AjXNh7/8syGjlv0VdDoECEiRrtWVSdG3Rs+PS4dGcScWCB++/ztMKiGdb+IZLlBSKNoEnKmswwwmK8Cmo9tep0P8N++diUXEFxxSTQHqMIHS6KxKSdCuQZ6tALtkUe4q43GBo14ELje6muXAwQo1k5jA+fHwgjrj4dlpD4aosgaLWC9iwySBgis+Q3BYED/0MvN07kmoqlnHXWVBKDDIJThRYOIRCq+cLrhDEtqQdsK0kAekmGK6SmUwDpcSlsLlunKwQJVpA1Kn865QHht1u1368eQJYS9Htw4dNw4zWj1eoFkB4RC0DorKOki5Matwb5O7JCGBrvFGfIwhRIa/ZDwej9TG5gB+Rxzaha8izUh1Oh/++je4+lYvCe3NUBG+wJ0Lr5/WQZ/p1D6Mdlrt5yjL/jAoZfuHZ6e+zO0F/7/RDix5cpmjQbpqgjOhfg+X1DpyhE4npjmgWgijFZm204Gn4x9dBsZ7xLc02mnKp8YLfDrF1JtaUgRn3PEdVxxpg3DESz4RUlBVpfV7OOIOZ9qs4B7e5dz5kE25gkzD/Ujdd7td/49IO50GaXc6cA9HBjlFtUWVJVCVmf/L4ELPY0xlSHHfhme3dnsbvpHzRR2vnvM3lZAZGKysh9JNMHt1oTTYLSVPMYOlyAg1f+llIMtohaANZcGqgfHxiiHKaZfy019xUkeBpeWI8luxGrtGLiDUQjjfumAq9bJmelZNpEhhW/xhzg0ChzJs1qknhZr79FG65iqFdVBj8prnS8OnDt5pM6ebAke+wA3ptNmwCbeQ0Ynw0JgKxaUIAVcEmFLzPdLK8TQ670+hTvgciMKkYR8mWs8pxGaGFwV3IuVSrmomr7TM0AQeb82MK7qrlUwoKzJsSjC8NBSO03Co5vEOJ7nW88DkHFMkGipHXSpHgIsISsQ0ogULITIN6KUCVFmphXI1u0tbC3ReP+R4mupKOW+R1GAmHFAnIaBPHrzfTg0K/A/f/8PCG1xS3akbBm0+gUPneJr7KvjOhxsMq7LUxo0UdZMxb/btOAYkPQeVXoINhJiBVsFJjakSkovir10IBLVjG4J2gbSJMVUvUv2yvVrUb8n28a07jFH3Wqi5HakhOhiPWC4yvIkoP8bljfQUbEDdDeEe/MtvTCKPz94OL6DvBavlHFOaEZs6bDbD29Zle1tZqDFkrzXrkUROx+vUqZ3H5UiNT44voF/r2B+IbOyV316n5BlDTqkxQVRgnUFeEGbNfJoZzCqVceWgfUoDZabBQi8w8yw7ndLgVEjpa2btOIOuMsTHIp11KFcwNbqodW4ZdjrUc+dkgOaRC8itQEOGSrWyVYGNh864tUttsu6Z0Q5TCo2zl6/aiKJ98tNUSLwpI/GIjWu71gV0orMV9RkFS2387b40okrNqoxcba/m6wNwMFLRnyGwajOO4d//gvHZ5QOL++WNA7U3+4Oa7mabbCdOdjZ27vMbVHzJpOPaPm+nU3JgE71Us4yWTfxyKfXyRgcqH8EfC9xdRX0MPaKp00BzD5EKJ1dxOkRFNhOhAcX7mlAnzIU8zZs0bPwbk+9cS2qwvj7ENjSG8LLx8cXTFEuq2KRTTEejJZKnpwJlBjw12lqPtLwWVLaMrhzaHlzkBhGIPsRzU2YGoafT7dRFMecLQVVzt5NHmcbQeZrhlFfS7fme4MFYRKtUcunV63xPbWFqrHCBz0Lgkvg0ZdxuTcq8oQwSVRiPxe4X2zZ4b9aNb8zL0uhFYHfEVchsauQ1Od6S1WJPDtLE3ukvu29KCzcTreBIlyt4enS0R8KJUlCFHqlDULgks6dpa+0H9ZpLrWa+lZE+eCusB1fjEZtsnqOy3tTvtlCH6kfR1qCLxov9AJQaZx7TQAjiaAethwSYUb43MprYIjkh5YlW3ZQ022yQ4MdKoFWK2w4QtnFo1oPXYo6tDgmJvyUNPLVVmhOiCFnSZrzIxnuECRYii3YIopG/jMii35uutOCywsR38lClyLJSkGEJpgAWpVuBH53B0/HV9XjvS9CFcJ5LMK3TIFSOJi5us97BtofN1PW4BdYR4G6sUE7QGOfy/PUj4HYYsLcHEp8ByBsk2Lzttjl89OncnD6+hHOcPTj8qSf7eBfK/BmNFdoXqV/CNzydL7nJLBzpouROeOi/IlI6TMExrQjbTWrCbhoJZXhawOLAh/HioHfQvPxq/GVDS3S5tgiLcHEoSO0UXFPbEhYmtd09V6VhYjB0zTTnakaJQOBro1ELKvxZlYZc8PISa+3f+VxCpSRaC9rlaJYEQpWmGN82x6VFejdHDDRSXbhqoOk7nFjhsH33LZfLB5be82deVVI2U3SfcJ94LYZjJ8J9W03gHEtthdNm1Z6aCZdXE+/LzbPNH5FB/UhpJmo/5ZXqWV6gKfxHjiGahUg/oX7fEXl/z3+t2JnnbI9dDE7RUN2xW29sXor4nr+q5QAS76foQWO7+FbZmKjTYOnrXT5+wkcqvJ1GfeNw6+P6soRJkSINsdvJ4eHJ2WtYPO/ts2RjSvYjfNl/fXp0/GZ4TMLENKE5fW+/t09Lpbau4Grjpu0vVrsTrrt2pPr//n0rjvwc3rp+KbnwE1dvu7s4Lb1im5+8Bptft64TlmvriObujurHpZHrNS1/V6Ghoex1whbcCBLHj1QjXMuaj1c/aLen5/HNvQc/8KHsUdHrEaai+aVvRGzAWMLmuNr5NLe+Xif1HJNECxSHHvZtnH0wEd8aK58cX7CE8YoMtTk/nfv5afyFuD8q1/ZgNQhA/9OU99EDd3dhNrteN/Rh6wdPRAVrajLS9Xq9/g8moX3h",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-2",custom_edit_url:null},f=void 0,x={},b=[];function v(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Get Signer IPs"}),"\n",(0,i.jsx)(a(),{method:"get",path:"/signerips/{document_id}",context:"endpoint"}),"\n",(0,i.jsx)(t.p,{children:"The Get Signer IPs API enables you to retrieve IPs of signers who signed the document."}),"\n",(0,i.jsx)(t.p,{children:"Note: This API is only available for Teams and Enterprise plans."}),"\n",(0,i.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,i.jsx)(j.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,i.jsx)(d(),{...s(54558)}),"\n",(0,i.jsx)(c(),{...s(70540)}),"\n",(0,i.jsx)(g(),{...s(52086)})]})}function S(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(v,{...e})}):v(e)}},54558(e){e.exports=JSON.parse('{"parameters":[{"name":"document_id","in":"path","description":"objectId of Document","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"aB2cc2hpbh"}}]}')},70540(e){e.exports={title:"Body"}},52086(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"FGik23bhUJ"},"signer_ips":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"joebee@example.com"},"ip_address":{"type":"string","example":"193.186.4.187"}},"xml":{"name":"signerIpsResponse"},"title":"signer_ips"}}},"xml":{"name":"signerIpsResponse"},"title":"signerIpsResponse"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"Document not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Document not found!"}},"title":"inline_response_404_3"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/767ebc75.c1c27f9c.js b/assets/js/767ebc75.c1c27f9c.js deleted file mode 100644 index eeeb9ec2f..000000000 --- a/assets/js/767ebc75.c1c27f9c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[7797],{5049(e,t,s){s.r(t),s.d(t,{assets:()=>b,contentTitle:()=>u,default:()=>S,frontMatter:()=>P,metadata:()=>n,toc:()=>f});const n=JSON.parse('{"id":"API-docs/v1.1/getsignerips","title":"Get Signer IPs","description":"The Get Signer IPs API enables you to retrieve IPs of signers who signed the document.","source":"@site/docs/API-docs/v1.1/getsignerips.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/getsignerips","permalink":"/docs/API-docs/v1.1/getsignerips","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getsignerips","title":"Get Signer IPs","description":"The Get Signer IPs API enables you to retrieve IPs of signers who signed the document.","sidebar_label":"Get Signer IPs","hide_title":true,"hide_table_of_contents":true,"api":"eJzNV0tvHDcS/iu1vCQetGckW3lsn6LNKooSwxYsGTrIA4HdXTNNi00yLPaMBoMGcsg/yGmv+9P8SxbFfkyPJDvrJAhykXqKrPfr41YEuSSRXot/27yu0AQS80QUSLlXLihrRCouS4RTDHChlgY9nJ0THJ+fARqZaSTY2BqCBY/BK1xhPLcLoHibYF3a9ruAUCIUnZ7pW/PWvLQBU7gsVStREVijNyBXUmkWDgvr4RJlRSBNAScmoHdeEYLT0tD0rRGJsA69ZFPPCpGKJYZWs3IkEuGklxUG9OzkVhhZoUhFb8SNKkQiFDvpZCjFfc9t9g7zcFawP32ARCI8/lQrj4VIg68xERQ2msWSqpxGkQi8c9oWKNKF1MQX8hIrKdKtCBsXbwavzFIkYmF9JcOYgncySkmF/NezPH9WuqwUTTNnteSsISQW9OzggP/t20t1niPRotYwREUkIrcmsOXpVkjntMrjwewdMdP2oXWt2xw9z2KCalX20fhUP747VbfPnmflmx9Ek4g2Ozecnp0c6b3ccCoCVvTblmAllX7MjJ3SdxYzxG86wjS3FStX7kYWhUeij3Mf/vP59PDrL6dH08OvvxJNk4i7KirsCqh14szR6y4nLDyooHeH0cPmd7HuHUYRR49l+8JWGEpllrBGE2DtrVkm4DRKQgh+A3IplQEtA/p//HllgN5b//HwfZplzSgAymhl8KYv9Zujg4ObwyEIRw+D0LclGBtgYWtT/LWuPqb/4w4d3TwfHPrioUNnZiW1KuJAvLS3aP5af8bqQ6v+YQ2r9lI8F3vOjumtk4R57VXYxPl791Q69bQ9T6/nPNW4Umw3uePADqVIxWwY4rPtaFo3ggX6VT/Pa69FKsoQHKWzGUlTZPZuah0a5tcyI+78mXRqtjqcHoomuc8jnfuk+1g//VQWCnKpzPK3+Oa7WF1wPtuU7UVsNy+d+hF5YHYJGd/qFlqJskAfk6fMwkbmLk2vHBpe5jHJUfn9xXeFOrcV8l7npT2Z9Czvf/nvwDWZDNs8lmNc6a9qD86u0fMS4qW90HineJdHzFDFswE0EMpKI5HegDIBl14GhEItVZA6ogaeIbl0MlNacRXzNcvcHkaNQFO4KjGU6PnoM48gocAVai5+kHWwlQwsqrcX1tbfLrRdUwISspqUQSJAU0qT88U+EwlYD9IA7qAHBc9Wq9Y2a4KXeYBKGrlElp3AOFgFasXlCt5mNQUgq+toMgSptPUMizqHDGJBMYgnjB88AlNzWzmPJZfNCmFZqwIpgdwWCBSbll0wBWRIARzbonIkFlobbfPbmMBFrTU4yzNESc1wZmwjswcvDfEWb23pczAEzHnL0AJbAyeTN4Sc4RfK3FI6mbw1T+F6qKsrzEgFnH/et8B6vX5Q+k/2eU5V+L7O4DU6SypYv9lxL1Uo6yy2y1jI8KOVdIoGY/2MmmEno7A5Pew+ps5K1G52gYErhGbH52dx7D6B9z//Ci9QegOlXbfVmtce9QaWvSqOXJv5NmzD1IzIVdah5IjnbfExbEQKfQSvShne//wfgpe4BmW6lmJXJpPzOtMqh0usHC9JmkxS+NYjqww9DUIpA+TSQIZApeRSWikJElzLrZW5ncKx2UBN6GGtQhmLgemRb88NjsuQboJMEhZgTeTodU53FjG9ItQrJJbF2y9DwEKFCPS9rZettrExnXMeF0pruFIFo3X27bgowHXkdUvmgI/MwQU3RChxA9IjED8h4PweSzypnbOerVCt8QurtV1zAtAUzioTKIXCy0XYyU92hZ5zmJU1j5DaEMohHEknZkhJ24mdxwO1fabcG+T789bjAj0rjG7v8uJUV07XfVkCV+sfKWve1zy1ZB5GUJo3yjf35cTVjr6iV4sL9CuVY7fVPtDRs3h5JhKhVY6MXneQ4fj0/AWsnk8PRDJaj/9Hc89enH178vLihI3hQdoG7HB6MD1gkrMUKmlGmvafqvdX23aHpf7uD9tu1we8CzOnpYpQK8Zu28GkazF+66bjZ+08EaWlwHe2W27mN143DZN/qtEzGpsnYiW9YnMilioU8XcxvFo/GLfPX3cP4CfwgRfyo6b32MUwcFlJXfMvkYhb3Nx7kzfzJukBDJvW3jjOc3RhxPsACu/hydOTS5EInsH7wOk2Aqfug6U/atc+omoN4L8M7x5l2G5bUNY0w/326IMcnYP9bQ7SvGma/wFpmS9I","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Resend request mail","permalink":"/docs/API-docs/v1.1/resendrequestmail"},"next":{"title":"Get Formdata","permalink":"/docs/API-docs/v1.1/getformdata"}}');var i=s(74848),o=s(28453),r=s(57742),a=s.n(r),l=s(78178),p=s.n(l),c=s(19624),m=s.n(c),d=s(96226),g=s.n(d),h=(s(77675),s(19365),s(51107)),I=s(21312);const P={id:"getsignerips",title:"Get Signer IPs",description:"The Get Signer IPs API enables you to retrieve IPs of signers who signed the document.",sidebar_label:"Get Signer IPs",hide_title:!0,hide_table_of_contents:!0,api:"eJzNV0tvHDcS/iu1vCQetGckW3lsn6LNKooSwxYsGTrIA4HdXTNNi00yLPaMBoMGcsg/yGmv+9P8SxbFfkyPJDvrJAhykXqKrPfr41YEuSSRXot/27yu0AQS80QUSLlXLihrRCouS4RTDHChlgY9nJ0THJ+fARqZaSTY2BqCBY/BK1xhPLcLoHibYF3a9ruAUCIUnZ7pW/PWvLQBU7gsVStREVijNyBXUmkWDgvr4RJlRSBNAScmoHdeEYLT0tD0rRGJsA69ZFPPCpGKJYZWs3IkEuGklxUG9OzkVhhZoUhFb8SNKkQiFDvpZCjFfc9t9g7zcFawP32ARCI8/lQrj4VIg68xERQ2msWSqpxGkQi8c9oWKNKF1MQX8hIrKdKtCBsXbwavzFIkYmF9JcOYgncySkmF/NezPH9WuqwUTTNnteSsISQW9OzggP/t20t1niPRotYwREUkIrcmsOXpVkjntMrjwewdMdP2oXWt2xw9z2KCalX20fhUP747VbfPnmflmx9Ek4g2Ozecnp0c6b3ccCoCVvTblmAllX7MjJ3SdxYzxG86wjS3FStX7kYWhUeij3Mf/vP59PDrL6dH08OvvxJNk4i7KirsCqh14szR6y4nLDyooHeH0cPmd7HuHUYRR49l+8JWGEpllrBGE2DtrVkm4DRKQgh+A3IplQEtA/p//HllgN5b//HwfZplzSgAymhl8KYv9Zujg4ObwyEIRw+D0LclGBtgYWtT/LWuPqb/4w4d3TwfHPrioUNnZiW1KuJAvLS3aP5af8bqQ6v+YQ2r9lI8F3vOjumtk4R57VXYxPl791Q69bQ9T6/nPNW4Umw3uePADqVIxWwY4rPtaFo3ggX6VT/Pa69FKsoQHKWzGUlTZPZuah0a5tcyI+78mXRqtjqcHoomuc8jnfuk+1g//VQWCnKpzPK3+Oa7WF1wPtuU7UVsNy+d+hF5YHYJGd/qFlqJskAfk6fMwkbmLk2vHBpe5jHJUfn9xXeFOrcV8l7npT2Z9Czvf/nvwDWZDNs8lmNc6a9qD86u0fMS4qW90HineJdHzFDFswE0EMpKI5HegDIBl14GhEItVZA6ogaeIbl0MlNacRXzNcvcHkaNQFO4KjGU6PnoM48gocAVai5+kHWwlQwsqrcX1tbfLrRdUwISspqUQSJAU0qT88U+EwlYD9IA7qAHBc9Wq9Y2a4KXeYBKGrlElp3AOFgFasXlCt5mNQUgq+toMgSptPUMizqHDGJBMYgnjB88AlNzWzmPJZfNCmFZqwIpgdwWCBSbll0wBWRIARzbonIkFlobbfPbmMBFrTU4yzNESc1wZmwjswcvDfEWb23pczAEzHnL0AJbAyeTN4Sc4RfK3FI6mbw1T+F6qKsrzEgFnH/et8B6vX5Q+k/2eU5V+L7O4DU6SypYv9lxL1Uo6yy2y1jI8KOVdIoGY/2MmmEno7A5Pew+ps5K1G52gYErhGbH52dx7D6B9z//Ci9QegOlXbfVmtce9QaWvSqOXJv5NmzD1IzIVdah5IjnbfExbEQKfQSvShne//wfgpe4BmW6lmJXJpPzOtMqh0usHC9JmkxS+NYjqww9DUIpA+TSQIZApeRSWikJElzLrZW5ncKx2UBN6GGtQhmLgemRb88NjsuQboJMEhZgTeTodU53FjG9ItQrJJbF2y9DwEKFCPS9rZettrExnXMeF0pruFIFo3X27bgowHXkdUvmgI/MwQU3RChxA9IjED8h4PweSzypnbOerVCt8QurtV1zAtAUzioTKIXCy0XYyU92hZ5zmJU1j5DaEMohHEknZkhJ24mdxwO1fabcG+T789bjAj0rjG7v8uJUV07XfVkCV+sfKWve1zy1ZB5GUJo3yjf35cTVjr6iV4sL9CuVY7fVPtDRs3h5JhKhVY6MXneQ4fj0/AWsnk8PRDJaj/9Hc89enH178vLihI3hQdoG7HB6MD1gkrMUKmlGmvafqvdX23aHpf7uD9tu1we8CzOnpYpQK8Zu28GkazF+66bjZ+08EaWlwHe2W27mN143DZN/qtEzGpsnYiW9YnMilioU8XcxvFo/GLfPX3cP4CfwgRfyo6b32MUwcFlJXfMvkYhb3Nx7kzfzJukBDJvW3jjOc3RhxPsACu/hydOTS5EInsH7wOk2Aqfug6U/atc+omoN4L8M7x5l2G5bUNY0w/326IMcnYP9bQ7SvGma/wFpmS9I",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},u=void 0,b={},f=[];function w(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Get Signer IPs"}),"\n",(0,i.jsx)(a(),{method:"get",path:"/signerips/{document_id}",context:"endpoint"}),"\n",(0,i.jsx)(t.p,{children:"The Get Signer IPs API enables you to retrieve IPs of signers who signed the document."}),"\n",(0,i.jsx)(t.p,{children:"Note: This API is only available for Teams and Enterprise plans."}),"\n",(0,i.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,i.jsx)(I.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,i.jsx)(p(),{...s(54558)}),"\n",(0,i.jsx)(m(),{...s(70540)}),"\n",(0,i.jsx)(g(),{...s(52086)})]})}function S(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(w,{...e})}):w(e)}},54558(e){e.exports=JSON.parse('{"parameters":[{"name":"document_id","in":"path","description":"objectId of Document","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"aB2cc2hpbh"}}]}')},70540(e){e.exports={title:"Body"}},52086(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"FGik23bhUJ"},"signer_ips":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"joebee@example.com"},"ip_address":{"type":"string","example":"193.186.4.187"}},"xml":{"name":"signerIpsResponse"},"title":"signer_ips"}}},"xml":{"name":"signerIpsResponse"},"title":"signerIpsResponse"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"Document not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Document not found!"}},"title":"inline_response_404_3"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/7ad5624c.9547760f.js b/assets/js/7ad5624c.9547760f.js deleted file mode 100644 index 41b61287d..000000000 --- a/assets/js/7ad5624c.9547760f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[33],{14397(t,e,n){n.r(e),n.d(e,{assets:()=>C,contentTitle:()=>g,default:()=>j,frontMatter:()=>x,metadata:()=>o,toc:()=>v});const o=JSON.parse('{"id":"API-docs/v1.1/getcontact","title":"Get Contact","description":"The Get Contact API allows you to retrieve details about a specific contact.","source":"@site/docs/API-docs/v1.1/getcontact.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/getcontact","permalink":"/docs/API-docs/v1.1/getcontact","draft":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJy9WF9v4zYS/ypzfGnXUPwnm7aonhosFmnQRTfYpAjQrBFQ0lhiQpEsObJjGAb60G9wT/d6H20/yWEoyZaTbO9yLRYIEns4M/zN/2E2gmQZRHoj3lhDMqcg5okoMOReOVLWiFRcVQhnSNBxwOnFOUit7SrA2jZAFjySV7hEKJCk0gFkZhsCCcFhrhYqh7yVHYtEWIdesurzQqSiROrORCKc9LJGQs+INsLIGkUquvNbVYhEKEbkJFXiMUyb3WFO5wXYBexVevytUR4LkZJvMBGB1pqVBlU7jSIR+OC0LVCkC6kDM+QV1lKkG0FrFznJK1OKRCysryUNKfggo5ZUuB9nWZUfVy4T2+2crw3OmoCBFR1Pp/znEG5o8hxDWDQadh4RSTQWDTG/dE6rPB5M7gILbZ6ia61m33lWQ6q9snfGi+2oZln1cHznxDbp/P8yBXcWIUNkcayl0v+HfIb4Q0cY57ZmVa6y5sVQTmavZ8fxh1XktnbSrF+qxDo0QZWGVdzZ7JYU6RcjKXAZIXiUhMUpPSe/5z6eHr8+mk2Ppt9dzb5NT75Pv/l2PJ1OfxWJeKijQ7vCKCRFR3eYdt8bV3yBe7aP2bqi63rAUKAvx+2WpU6eK4dLWyNVypSwQkOw8taUCTiNMiCQX4MspTKgJaH/x99XJ+i99X/uppch2w7MVkYrg7d9L7g9mU5vZzsnnDx1Qt9hjSVY2MYUX9bSZ67/c3NObo935nzz1Jxzs5RaFXFgXNl7NF/WnOH11F7/NGlVyxTPxYGxQ3prZMC88YrWcTg9HEmnjtrz9GbOTZ/zxHZDLU4zqkQqJl32Tzb7QbYVrM0v+0nXeC1SURG5kE4mQZoisw/jvvdomQXuhBPp1GQ5G3M/eywjnXsRPzZHLxUJJEtlyv8mN9876pKD2cbrwF27qEmnfsK16EfNAVc36yuUBfoYOWUWNgp3MXrv0Fyq0sQIx8sf7wTXqHNbI+8oVCGMRr3Ipz/+vZMajaCweVOjoZiL44/mo3nfeHB2hZ4HtDQFLDQ+qExjFMM6nu0WoICy1hiCXoMyhKWXhFCoUpHUwH7i9pFLJzOlFacws1mW9jCogjCG6wqpQs9HX3kECQUuUXPmg2zI1pJYVY8XVtbfL3gVS0BC1gRlMARAU0mTM2MfiQSsB2kADaF3XgWEQJ5RqxabNeS59mtpZImsO4GhswrUitMVvM2aQBCsbiJk4G5vPRbQG2QQixCd+JZ3K4/AVJ6/HitOmyVC2agCQwK5LRBCrFg2wRSQYSBwjEXlGFhpY7TN72MAF43W4Cw3ECU1b3pDjCxOXprAs7jF0sdg5zDnLa9d2AIcjX4JyBF+p8x9SEejj+YIbnZ5dY1ZUITzr/sSWK1WT1L/1aHMmaIfmww+oLNBkfXrvXSpqGqyWC5DJbsvraYzNBjzZ1AMex2FzcPT6mPqpELtJpdInCFhcnpxHnvuK/j0+z/hHUpvoLKrNlvzxqNeQ9lfxZ5rI9+6bdcyYWFj4lXs8bxNPl6pMVDvwetK0qff/xXgZ1yBMl1JsSmj0UWTaZXDFdaO52MYjVJ4E7cgoJ4GVEmCXBrIEEIlOZWWSoIE10prZe7HcGrW0AT0sFJUxWRgepQ7MIP9sgt3gEwGLMCaKNHfOd4jYnodUC8xsC4efRkCFoo4oytvm7K9bQimM87jQmkN16ookaJtp0UBriOvWjI7fAAHF1wQVOEapEcIaGgMF49E4knjnPWMQrXgF5bfXBwANIWzylBIofByQXv9yT7R47KprHmG1LpQ7tyRdGp2IWkrsbN4Rx1/5Kb8qJEf9luPC/R8YTR7HxenunS66dMSOFv/Slq3O327V/I+0D42eKL88FhPnOvo6/B+cYl+qXLsptpnKnoSmSciEVrlaAIO9oXTs4t3sHw9nopkMB7/h+KevDt/8/bny7cMhhtp67DZeDqexheODVRLM7hp8OR+PNc2+y3q736dd4OZ8IEmTksVl6Jo6KZbaG7E/nWdDt7m80RUNhAzbDZcdr94vd0y+bcGPS9N80QspVcy4+l9sxGFCvy52L29P2vk1x+6Z/wreP6Z/yzsfskwvGEspW74m0jEPa4P/62wnW+TftFgYC3DaZ6jo4Hok331YOk7e3slEsG98nDBuY8LTveBtT8L63DzaQHwb17DnhXYbNrlabvd8bdHn5XoDOy52Ufz7Xb7H90WRuY=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Contact","permalink":"/docs/API-docs/v1.1/createcontact"},"next":{"title":"Update Contact","permalink":"/docs/API-docs/v1.1/update-contact"}}');var a=n(74848),s=n(28453),p=n(57742),i=n.n(p),r=n(78178),c=n.n(r),l=n(19624),d=n.n(l),m=n(96226),b=n.n(m),h=(n(77675),n(19365),n(51107)),y=n(21312);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:"eJy9WF9v4zYS/ypzfGnXUPwnm7aonhosFmnQRTfYpAjQrBFQ0lhiQpEsObJjGAb60G9wT/d6H20/yWEoyZaTbO9yLRYIEns4M/zN/2E2gmQZRHoj3lhDMqcg5okoMOReOVLWiFRcVQhnSNBxwOnFOUit7SrA2jZAFjySV7hEKJCk0gFkZhsCCcFhrhYqh7yVHYtEWIdesurzQqSiROrORCKc9LJGQs+INsLIGkUquvNbVYhEKEbkJFXiMUyb3WFO5wXYBexVevytUR4LkZJvMBGB1pqVBlU7jSIR+OC0LVCkC6kDM+QV1lKkG0FrFznJK1OKRCysryUNKfggo5ZUuB9nWZUfVy4T2+2crw3OmoCBFR1Pp/znEG5o8hxDWDQadh4RSTQWDTG/dE6rPB5M7gILbZ6ia61m33lWQ6q9snfGi+2oZln1cHznxDbp/P8yBXcWIUNkcayl0v+HfIb4Q0cY57ZmVa6y5sVQTmavZ8fxh1XktnbSrF+qxDo0QZWGVdzZ7JYU6RcjKXAZIXiUhMUpPSe/5z6eHr8+mk2Ppt9dzb5NT75Pv/l2PJ1OfxWJeKijQ7vCKCRFR3eYdt8bV3yBe7aP2bqi63rAUKAvx+2WpU6eK4dLWyNVypSwQkOw8taUCTiNMiCQX4MspTKgJaH/x99XJ+i99X/uppch2w7MVkYrg7d9L7g9mU5vZzsnnDx1Qt9hjSVY2MYUX9bSZ67/c3NObo935nzz1Jxzs5RaFXFgXNl7NF/WnOH11F7/NGlVyxTPxYGxQ3prZMC88YrWcTg9HEmnjtrz9GbOTZ/zxHZDLU4zqkQqJl32Tzb7QbYVrM0v+0nXeC1SURG5kE4mQZoisw/jvvdomQXuhBPp1GQ5G3M/eywjnXsRPzZHLxUJJEtlyv8mN9876pKD2cbrwF27qEmnfsK16EfNAVc36yuUBfoYOWUWNgp3MXrv0Fyq0sQIx8sf7wTXqHNbI+8oVCGMRr3Ipz/+vZMajaCweVOjoZiL44/mo3nfeHB2hZ4HtDQFLDQ+qExjFMM6nu0WoICy1hiCXoMyhKWXhFCoUpHUwH7i9pFLJzOlFacws1mW9jCogjCG6wqpQs9HX3kECQUuUXPmg2zI1pJYVY8XVtbfL3gVS0BC1gRlMARAU0mTM2MfiQSsB2kADaF3XgWEQJ5RqxabNeS59mtpZImsO4GhswrUitMVvM2aQBCsbiJk4G5vPRbQG2QQixCd+JZ3K4/AVJ6/HitOmyVC2agCQwK5LRBCrFg2wRSQYSBwjEXlGFhpY7TN72MAF43W4Cw3ECU1b3pDjCxOXprAs7jF0sdg5zDnLa9d2AIcjX4JyBF+p8x9SEejj+YIbnZ5dY1ZUITzr/sSWK1WT1L/1aHMmaIfmww+oLNBkfXrvXSpqGqyWC5DJbsvraYzNBjzZ1AMex2FzcPT6mPqpELtJpdInCFhcnpxHnvuK/j0+z/hHUpvoLKrNlvzxqNeQ9lfxZ5rI9+6bdcyYWFj4lXs8bxNPl6pMVDvwetK0qff/xXgZ1yBMl1JsSmj0UWTaZXDFdaO52MYjVJ4E7cgoJ4GVEmCXBrIEEIlOZWWSoIE10prZe7HcGrW0AT0sFJUxWRgepQ7MIP9sgt3gEwGLMCaKNHfOd4jYnodUC8xsC4efRkCFoo4oytvm7K9bQimM87jQmkN16ookaJtp0UBriOvWjI7fAAHF1wQVOEapEcIaGgMF49E4knjnPWMQrXgF5bfXBwANIWzylBIofByQXv9yT7R47KprHmG1LpQ7tyRdGp2IWkrsbN4Rx1/5Kb8qJEf9luPC/R8YTR7HxenunS66dMSOFv/Slq3O327V/I+0D42eKL88FhPnOvo6/B+cYl+qXLsptpnKnoSmSciEVrlaAIO9oXTs4t3sHw9nopkMB7/h+KevDt/8/bny7cMhhtp67DZeDqexheODVRLM7hp8OR+PNc2+y3q736dd4OZ8IEmTksVl6Jo6KZbaG7E/nWdDt7m80RUNhAzbDZcdr94vd0y+bcGPS9N80QspVcy4+l9sxGFCvy52L29P2vk1x+6Z/wreP6Z/yzsfskwvGEspW74m0jEPa4P/62wnW+TftFgYC3DaZ6jo4Hok331YOk7e3slEsG98nDBuY8LTveBtT8L63DzaQHwb17DnhXYbNrlabvd8bdHn5XoDOy52Ufz7Xb7H90WRuY=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},g=void 0,C={},v=[];function Q(t){const e={p:"p",...(0,s.R)(),...t.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Get Contact"}),"\n",(0,a.jsx)(i(),{method:"get",path:"/contact/{contact_id}",context:"endpoint"}),"\n",(0,a.jsx)(e.p,{children:"The Get Contact API allows you to retrieve details about a specific contact."}),"\n",(0,a.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,a.jsx)(y.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,a.jsx)(c(),{...n(31290)}),"\n",(0,a.jsx)(d(),{...n(34704)}),"\n",(0,a.jsx)(b(),{...n(52026)})]})}function j(t={}){const{wrapper:e}={...(0,s.R)(),...t.components};return e?(0,a.jsx)(e,{...t,children:(0,a.jsx)(Q,{...t})}):Q(t)}},31290(t){t.exports=JSON.parse('{"parameters":[{"name":"contact_id","in":"path","description":"objectId of contact","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"pH1bhc2hpb"}}]}')},34704(t){t.exports={title:"Body"}},52026(t){t.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"ph1bhx2jp"},"name":{"type":"string","format":"string","example":"joe bee"},"email":{"type":"string","format":"string","example":"joebee@example.com"},"phone":{"type":"string","format":"string","example":"4131231231"},"company":{"type":"string","format":"string","example":"opensign"},"job_title":{"type":"string","format":"string","example":"dev"},"createdAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"xml":{"name":"contactdetails"},"title":"contact"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"Contact not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Contact not found!"}},"title":"inline_response_404_2"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/7ad5624c.efd7c9d6.js b/assets/js/7ad5624c.efd7c9d6.js new file mode 100644 index 000000000..a5677a793 --- /dev/null +++ b/assets/js/7ad5624c.efd7c9d6.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[33],{14397(t,e,o){o.r(e),o.d(e,{assets:()=>y,contentTitle:()=>k,default:()=>b,frontMatter:()=>B,metadata:()=>n,toc:()=>g});const n=JSON.parse('{"id":"API-docs/v1.1/getcontact","title":"Get Contact","description":"The Get Contact API allows you to retrieve details about a specific contact.","source":"@site/docs/API-docs/v1.1/getcontact.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/getcontact","permalink":"/docs/API-docs/v1.1/getcontact","draft":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJy9GdtuG8f1V07HQGERS1JSnBRlijSKrNhC3VgQ5RqoKYizO4fcsYYzm5lZUoREIA9FP6DoS1/7E33vp/hLijOzs7xIsaMmCGBb1sy53+fsLfN86tjgHTs22vPCO3aZMYGusLLy0mg2YBclwgv00EDA0dkpcKXMwsHS1OANWPRW4hxBoOdSOeC5qT1wcBUWciILKCJuj2XMVGg5kT4VbMCm6Js7lrGKWz5Dj5YkumWaz5ANWHN/JQXLmCSJKu5Ltiumyd9j4U8FmAmsSVr8vpYWBRt4W2PGnF8qIurkrFLIMoY3lTIC2WDClSOAosQZZ4Nb5pdVgPRW6inL2MTYGfebJ3jDA5UBq14e5GVxWFY5W60uia2rjHboiNDh/j792BbX1UWBzk1qBa1FWBaURe0JnleVkkW46L93hHR7X7qoNdnOEhkvI8tkjEfrUR7k5c3h+4qtssb+jyPw3iDkiISOMy7V/4GfI37dHPQKMyNSVWn0o0V5dvDZwWH4QyQKM6u4Xj6WiKlQOznVROK9ya+89OrRkgicBxEsco/iyD+Ev4Y+3D/8rHuw393/3cXBF4Nnvx98/kVvf3//ryxjN7Ng0CYxBPfB0I1M7e91JX4FPqtdsCbpmhqwiZDScbUirGcPpcPQzNCXUk9hgdrDwho9zaBSyB2Ct0vgUy41KO7R/uaXyxO01tiPm+lxkq021JZaSY1XqRZcPdvfvzpojfDsvhFShdXGw8TUWvy6mj7A/uPqPLs6bNX5/L46p3rOlRShYVyYa9S/rjqb7H1kfz9oZQQK92xL2c3zqKTDorbSL0NzuunySnbj/eDdJRV9ihPTNLXQzXzJBqzfRH//dt3IVoyo2XnqdLVVbMBK7ys36Pcd1yI3N71UexTPHVXCPq9kf37QO2SrbBeHV9Wj4LHuPhbFeT6VevopvMu1oYbkzOivLXO1XuOV/BMuWWo1W1BNry+RC7TBc1JPTEBufPS6Qj2UUx08HJjvzgRPIMF8+Nu/W7CRHumvoNOhwYYU6TpT2wLhuSnqQI8rj1ZzL+cIH374J+S1VJQSFgTOUVEcugy8rZ1HAfkSUHu0lZUOXa/TIfqbfKdyjnFW4kBtSKHHDCprRF2QoF2LXCwBu2RR7muLUCnuqaOAL62ppyXNUlJPFWZwfjK8oKnh6Oy0B0PUAoQp6hlq74KILZEMZlzzKYLHGdHDIDMvrgMIFTTnua8dSA0WuQIvZ5gB1wJ47c2MeyShLWknLbZsQMkJFstCReNwpWAhfUkT3xy1MBaUKa67UvfIEN1ul348eUIzpCeuQ8+tR0GnJ3O0S6AZDZ2HWe08FNzaZeTbJi5J6EuE8UZ8jCFGRmAyHo9HeuNyAH8gCuuDrxqYke50Pvz9H/DupVnQ5DpFTbMX7jC8fJqCXpjC3Y92Ou2XqKr+MCrl+kdnp6HG7UX/f2c8OPLkokSLxCrHqdR/hDfUNUqETqdJc0A9l9ZoMm2nA0/HP7kMjPeIbmWNN5RPrRf4ZIJFMLWiCBbc8x1XHBuLcMwrnkslqaTS+R0cc49TY5dwB29L7kPIFlyDMHA30nfdbjf8JdBO53mKuk4H7uA4zDYZONQigziBZGBxbq6bmBJIcb8Oz25y+zp8G8oXKV4D5W9qqQRYrB3P1UYwB3WhstitFC9QwEKKKXr3ZZCBLGM0grGUBcvAFm3LYohq0qX8DCxepChwdBxAN7OqtWtDBaSeSx/6FkyUWSSiZ3WuZAHb4g9LbhE4VPEypZ6S+jqkjzaJqpLOQ3qvJJrPLZ94eGvsNXGKFPkcN6QzdsMm3IEgDBdMPpGaKxkDbhYnlEQ3PfcCxT/HOhFyoBGm6VWQG3NNITa1fDbjXhZcqWUi8q1RAm2k8dpOuSZea8mkdlJgW4LhuaVwnESkROMt5qUx15HIORZIMFSOulSOAOdUcbTx9IwMJncQI9OCWWhALSojtU/k3rgk0Hl6lPKiMLX2wSKFRSE9UCehcZ08eLedGhT4H374l4PvcEF1JzUMunwCR97zogxV8G0INxjWVWWsH2nqJmPe3rtxE5AgHWizABcBUYDR0UmtqTKIT4ONgwiQHNsCrA9Imyam0iHVL9dLor4k2w+jN4dN1L2S+tqN9BA9jEeslAKvor+vmri8UgGCDai7IdxBeBWPSeTx2evhBfSDYEnOMaUZkUlhsxneLpXtbWUhDZC9tVmPFXJCT6mTnMfVSI9fnFxAP+nYH0gxDspvn1PyjKGk1MgRNThvkc9oYBUhzSyKWguuPayXDECZaXFm5igCyU6nsjiRSoWamRxn0deW6DgkXI9qCRNrZknnNcFOh3ruNRmgXQAAcifRkqEKo109w9ZDZ9y5hbGie2aNx4JC4+z5t+uIonvy00QqvKoa4BEbJ7umApobsaQ+o2FhbOAeSiPqwi6rhqrrJbohAAcj3fgzBlYy4xj++x8Yn725Z/FwvIGQvNkfJLirbbCdONm52OEXLqj4kknHyT6vJxNyYBu9VLOsUW38hiXUlYlQIYI/Fri7ioYYekBTb4B2QrKQXtFkF7oOjX4yNqCGXxvqNHMhL8o2DVv/Nsl3bhQ12FAfmjY0hvisCfHFiwIrqtikU5OO1igkT08kKgG8sMa5MGkFLahsWVN7dD24KC0iEHyM57bMDGJPJ+7URbHkc0lVc7eTNzKNofNU4ITXyu+FnhCGsWZapZJLD14feup6TG0qXKQzl7ggOm0ZdzH7U96ToSwSFBitlqn7NW07rhRT4xvzqrJmHskdcx0zmxp5AscbslrTk6M0Te8MzO7a0sJtbjQcm2oJT4+P90g4WUmq0CN9BBoXZPaiWFv7Xr3myuhpaGWkD95IF4ar8Yjlm3hU1tv6vS7UsfpRtLXTRevFfhyUWmee0MoMuBAWHdUOqmooKN9bGW3TIjlNyrnR3YI022yQEBZvYHSB2w6QrnWo6MEreY1rHTISf0saeOrqoqSJImbJOuOlGO/RTDCXorFDFI38ZaVo/N52pTlXNWahk8cqRZZVkgxLYwrgrPJL4NbyJTwdv7sc730JZiZ9oBJN6w1IXaJtDrdJ78y2R3MuVcjUk/Vg3Qy4GyeUE7TBeXP+6oHhdhhn7zBIPGIgbyfB9m23TeGjT+cW++QNnOP0HvKnnuzj3VHmL2idNKFI/Ra+4cX1glvh4Jg2oV6G0X9JoIRMwTGpabbLE2C3aABVfFrA/CCE8fygd9C+/NL85WJL9KVxCPPIOBYk3vrDUNuSDvJk90BVG8gtxq5ZlFxPKRFo+Npo1JIKv6iLmAtBXiJtwjufK6i1QufA+BLtgoZQbSjGt83xxiG9m5sZaKS78K4dTd9i7qTH9btvsVjcs/RewPm2VgrS4yck3CdeixHthfQv6xzOsTJOemOXa6yp9GWdB19u4ra/NATSI6Vdp/2cV2ogeYF25uh7yRDtXBafUL/vCby/N6LdzM4+Z3vtYnGCluqO23pj80o27/l3SQ4g8X6OHnG1H9fLtBaM3xxosfT1Lp2w3iMVXk8afZvl1sf1ZRlTskDtcGNtePTi7BXMP+vts2xjS/YTfNl/dXp88t3whIRp0oQN2EFvv7cfPnQY52dcb3Da+PK2u966XS9Tf+mPdM1+zuON71eKy7AbDYreNnvNd2z9kW2w8YnuMmOlcZ4Abm8p099YtVrR8fc1WtqdXmZszq2kkhCWn81gJdpPcD+q5NPz5nW8Bw9/7XtQ7LRr1LRoDB2DDRjL2DUut78uri5XWdo3kmAR4CiMZxuo99bWW7vfFycXLGO8Jhtt7jmvw56z+Q9Rf1Cs7QVoFID+pW3sgwi3t3GHulq18PHqRzEaBRM02ehytVr9D4wSlX8=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Contact","permalink":"/docs/API-docs/v1.1/createcontact"},"next":{"title":"Update Contact","permalink":"/docs/API-docs/v1.1/update-contact"}}');var a=o(74848),i=o(28453),r=o(57742),s=o.n(r),c=o(78178),p=o.n(c),d=o(19624),l=o.n(d),u=o(96226),m=o.n(u),h=(o(77675),o(19365),o(51107)),N=o(21312);const B={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:"eJy9GdtuG8f1V07HQGERS1JSnBRlijSKrNhC3VgQ5RqoKYizO4fcsYYzm5lZUoREIA9FP6DoS1/7E33vp/hLijOzs7xIsaMmCGBb1sy53+fsLfN86tjgHTs22vPCO3aZMYGusLLy0mg2YBclwgv00EDA0dkpcKXMwsHS1OANWPRW4hxBoOdSOeC5qT1wcBUWciILKCJuj2XMVGg5kT4VbMCm6Js7lrGKWz5Dj5YkumWaz5ANWHN/JQXLmCSJKu5Ltiumyd9j4U8FmAmsSVr8vpYWBRt4W2PGnF8qIurkrFLIMoY3lTIC2WDClSOAosQZZ4Nb5pdVgPRW6inL2MTYGfebJ3jDA5UBq14e5GVxWFY5W60uia2rjHboiNDh/j792BbX1UWBzk1qBa1FWBaURe0JnleVkkW46L93hHR7X7qoNdnOEhkvI8tkjEfrUR7k5c3h+4qtssb+jyPw3iDkiISOMy7V/4GfI37dHPQKMyNSVWn0o0V5dvDZwWH4QyQKM6u4Xj6WiKlQOznVROK9ya+89OrRkgicBxEsco/iyD+Ev4Y+3D/8rHuw393/3cXBF4Nnvx98/kVvf3//ryxjN7Ng0CYxBPfB0I1M7e91JX4FPqtdsCbpmhqwiZDScbUirGcPpcPQzNCXUk9hgdrDwho9zaBSyB2Ct0vgUy41KO7R/uaXyxO01tiPm+lxkq021JZaSY1XqRZcPdvfvzpojfDsvhFShdXGw8TUWvy6mj7A/uPqPLs6bNX5/L46p3rOlRShYVyYa9S/rjqb7H1kfz9oZQQK92xL2c3zqKTDorbSL0NzuunySnbj/eDdJRV9ihPTNLXQzXzJBqzfRH//dt3IVoyo2XnqdLVVbMBK7ys36Pcd1yI3N71UexTPHVXCPq9kf37QO2SrbBeHV9Wj4LHuPhbFeT6VevopvMu1oYbkzOivLXO1XuOV/BMuWWo1W1BNry+RC7TBc1JPTEBufPS6Qj2UUx08HJjvzgRPIMF8+Nu/W7CRHumvoNOhwYYU6TpT2wLhuSnqQI8rj1ZzL+cIH374J+S1VJQSFgTOUVEcugy8rZ1HAfkSUHu0lZUOXa/TIfqbfKdyjnFW4kBtSKHHDCprRF2QoF2LXCwBu2RR7muLUCnuqaOAL62ppyXNUlJPFWZwfjK8oKnh6Oy0B0PUAoQp6hlq74KILZEMZlzzKYLHGdHDIDMvrgMIFTTnua8dSA0WuQIvZ5gB1wJ47c2MeyShLWknLbZsQMkJFstCReNwpWAhfUkT3xy1MBaUKa67UvfIEN1ul348eUIzpCeuQ8+tR0GnJ3O0S6AZDZ2HWe08FNzaZeTbJi5J6EuE8UZ8jCFGRmAyHo9HeuNyAH8gCuuDrxqYke50Pvz9H/DupVnQ5DpFTbMX7jC8fJqCXpjC3Y92Ou2XqKr+MCrl+kdnp6HG7UX/f2c8OPLkokSLxCrHqdR/hDfUNUqETqdJc0A9l9ZoMm2nA0/HP7kMjPeIbmWNN5RPrRf4ZIJFMLWiCBbc8x1XHBuLcMwrnkslqaTS+R0cc49TY5dwB29L7kPIFlyDMHA30nfdbjf8JdBO53mKuk4H7uA4zDYZONQigziBZGBxbq6bmBJIcb8Oz25y+zp8G8oXKV4D5W9qqQRYrB3P1UYwB3WhstitFC9QwEKKKXr3ZZCBLGM0grGUBcvAFm3LYohq0qX8DCxepChwdBxAN7OqtWtDBaSeSx/6FkyUWSSiZ3WuZAHb4g9LbhE4VPEypZ6S+jqkjzaJqpLOQ3qvJJrPLZ94eGvsNXGKFPkcN6QzdsMm3IEgDBdMPpGaKxkDbhYnlEQ3PfcCxT/HOhFyoBGm6VWQG3NNITa1fDbjXhZcqWUi8q1RAm2k8dpOuSZea8mkdlJgW4LhuaVwnESkROMt5qUx15HIORZIMFSOulSOAOdUcbTx9IwMJncQI9OCWWhALSojtU/k3rgk0Hl6lPKiMLX2wSKFRSE9UCehcZ08eLedGhT4H374l4PvcEF1JzUMunwCR97zogxV8G0INxjWVWWsH2nqJmPe3rtxE5AgHWizABcBUYDR0UmtqTKIT4ONgwiQHNsCrA9Imyam0iHVL9dLor4k2w+jN4dN1L2S+tqN9BA9jEeslAKvor+vmri8UgGCDai7IdxBeBWPSeTx2evhBfSDYEnOMaUZkUlhsxneLpXtbWUhDZC9tVmPFXJCT6mTnMfVSI9fnFxAP+nYH0gxDspvn1PyjKGk1MgRNThvkc9oYBUhzSyKWguuPayXDECZaXFm5igCyU6nsjiRSoWamRxn0deW6DgkXI9qCRNrZknnNcFOh3ruNRmgXQAAcifRkqEKo109w9ZDZ9y5hbGie2aNx4JC4+z5t+uIonvy00QqvKoa4BEbJ7umApobsaQ+o2FhbOAeSiPqwi6rhqrrJbohAAcj3fgzBlYy4xj++x8Yn725Z/FwvIGQvNkfJLirbbCdONm52OEXLqj4kknHyT6vJxNyYBu9VLOsUW38hiXUlYlQIYI/Fri7ioYYekBTb4B2QrKQXtFkF7oOjX4yNqCGXxvqNHMhL8o2DVv/Nsl3bhQ12FAfmjY0hvisCfHFiwIrqtikU5OO1igkT08kKgG8sMa5MGkFLahsWVN7dD24KC0iEHyM57bMDGJPJ+7URbHkc0lVc7eTNzKNofNU4ITXyu+FnhCGsWZapZJLD14feup6TG0qXKQzl7ggOm0ZdzH7U96ToSwSFBitlqn7NW07rhRT4xvzqrJmHskdcx0zmxp5AscbslrTk6M0Te8MzO7a0sJtbjQcm2oJT4+P90g4WUmq0CN9BBoXZPaiWFv7Xr3myuhpaGWkD95IF4ar8Yjlm3hU1tv6vS7UsfpRtLXTRevFfhyUWmee0MoMuBAWHdUOqmooKN9bGW3TIjlNyrnR3YI022yQEBZvYHSB2w6QrnWo6MEreY1rHTISf0saeOrqoqSJImbJOuOlGO/RTDCXorFDFI38ZaVo/N52pTlXNWahk8cqRZZVkgxLYwrgrPJL4NbyJTwdv7sc730JZiZ9oBJN6w1IXaJtDrdJ78y2R3MuVcjUk/Vg3Qy4GyeUE7TBeXP+6oHhdhhn7zBIPGIgbyfB9m23TeGjT+cW++QNnOP0HvKnnuzj3VHmL2idNKFI/Ra+4cX1glvh4Jg2oV6G0X9JoIRMwTGpabbLE2C3aABVfFrA/CCE8fygd9C+/NL85WJL9KVxCPPIOBYk3vrDUNuSDvJk90BVG8gtxq5ZlFxPKRFo+Npo1JIKv6iLmAtBXiJtwjufK6i1QufA+BLtgoZQbSjGt83xxiG9m5sZaKS78K4dTd9i7qTH9btvsVjcs/RewPm2VgrS4yck3CdeixHthfQv6xzOsTJOemOXa6yp9GWdB19u4ra/NATSI6Vdp/2cV2ogeYF25uh7yRDtXBafUL/vCby/N6LdzM4+Z3vtYnGCluqO23pj80o27/l3SQ4g8X6OHnG1H9fLtBaM3xxosfT1Lp2w3iMVXk8afZvl1sf1ZRlTskDtcGNtePTi7BXMP+vts2xjS/YTfNl/dXp88t3whIRp0oQN2EFvv7cfPnQY52dcb3Da+PK2u966XS9Tf+mPdM1+zuON71eKy7AbDYreNnvNd2z9kW2w8YnuMmOlcZ4Abm8p099YtVrR8fc1WtqdXmZszq2kkhCWn81gJdpPcD+q5NPz5nW8Bw9/7XtQ7LRr1LRoDB2DDRjL2DUut78uri5XWdo3kmAR4CiMZxuo99bWW7vfFycXLGO8Jhtt7jmvw56z+Q9Rf1Cs7QVoFID+pW3sgwi3t3GHulq18PHqRzEaBRM02ehytVr9D4wSlX8=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-2",custom_edit_url:null},k=void 0,y={},g=[];function v(t){const e={p:"p",...(0,i.R)(),...t.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Get Contact"}),"\n",(0,a.jsx)(s(),{method:"get",path:"/contact/{contact_id}",context:"endpoint"}),"\n",(0,a.jsx)(e.p,{children:"The Get Contact API allows you to retrieve details about a specific contact."}),"\n",(0,a.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,a.jsx)(N.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,a.jsx)(p(),{...o(31290)}),"\n",(0,a.jsx)(l(),{...o(34704)}),"\n",(0,a.jsx)(m(),{...o(52026)})]})}function b(t={}){const{wrapper:e}={...(0,i.R)(),...t.components};return e?(0,a.jsx)(e,{...t,children:(0,a.jsx)(v,{...t})}):v(t)}},31290(t){t.exports=JSON.parse('{"parameters":[{"name":"contact_id","in":"path","description":"objectId of contact","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"pH1bhc2hpb"}}]}')},34704(t){t.exports={title:"Body"}},52026(t){t.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"ph1bhx2jp"},"name":{"type":"string","format":"string","example":"joe bee"},"email":{"type":"string","format":"string","example":"joebee@example.com"},"phone":{"type":"string","format":"string","example":"4131231231"},"company":{"type":"string","format":"string","example":"opensign"},"job_title":{"type":"string","format":"string","example":"dev"},"createdAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"xml":{"name":"contactdetails"},"title":"contact"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"Contact not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Contact not found!"}},"title":"inline_response_404_2"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/7ef59f7a.39dda8d8.js b/assets/js/7ef59f7a.39dda8d8.js new file mode 100644 index 000000000..f5067df1b --- /dev/null +++ b/assets/js/7ef59f7a.39dda8d8.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[4865],{62634(e,t,a){a.r(t),a.d(t,{assets:()=>T,contentTitle:()=>f,default:()=>W,frontMatter:()=>y,metadata:()=>n,toc:()=>h});const n=JSON.parse('{"id":"API-docs/v1.1/getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","source":"@site/docs/API-docs/v1.1/getdocument.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/getdocument","permalink":"/docs/API-docs/v1.1/getdocument","draft":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJy9Wt1uG7kVfpVTBihiYSTZjje71RbbdR3np003hn8aoLYhcWaONFxT5CzJkSw4Avai6AMUveltX6L3fZQ8SXFIzmgke+14/y52k3AOD885PL8fdcMcn1g2OGcvdFZNUTnLLhOWo82MKJ3Qig3YaYHwCh3UJLB/9AZQ8VSihYWuwGkw6IzAGUKOjgtpgae6csDBlpiJscggj7t7LGG6RMOJ+5ucDdgEXf2RJazkhk/RoSGxbpjiU2QDVhMMRc4SJkiskruCbcqq028xc29y0ONGXpYwg99VwmDOBs5UmDDrFpLYWjEtJbKE4XUpdY5sMObSEkFW4JSzwQ1zi9JTOiPUhCVsrM2Uu/YKXnPPZcDK1ztpke0WZcqWy0s61pZaWbTEaHd7m/5Yl9dWWYbWjisJjVFYwjKtHEk+uGG8LKXI/If+t5Y23dyWLqhN1jPExolwpHXcVfaxWgjVLY2eGLSWLZPGpI9l8/KVuNp9lhZnfyIuY0GLj+NQOFfaQb8fVyoje5meEreMdByTWX400xaLFmMn3OPltP4v5OHEQunHC1VK5BbBiolqAsVbTcsczcMX/fPcUYi1x3EIEoLfulwZcBWwUQVypLla0+WT+H+rEVJE2k/W8Wmh4cCN4QvKBw6n9mErGX333a5Oy1DfZ4g7xcIpF/JB6hTx67hQ+1pZaPXAMXufPd/defbF5ztEPxf5BN1P0D98fZz9HV67VF97efmkvV1V0xRNe3uz0mzfWSbs+pF7dvf2lglbPHLX53TU/JGbnn2xTFjxyE17z8mXfQL/BJv/mJhqbL5sR5TDaSm5w+FJiINh7Q/3UvmgtKjyN+qdWc8lqdYSuWofTdUx0g+FGmraMSQJM3f/Rl82lwnjUur5UI/HUigcUsTeuW+9CL4v0BVoIAY4ZFyBrdKpoAYi0+WCqrkrhG1yYyDNobJCTYArwGuHRnEJTmsJY23AZxswOBM478ELHPNKOku9ipe1d5f0mUHuMN9390fl7vbus+7Odnf789Od54O93w0+e97b3t7+G0vY9VSubp3lVJ/aSTH+uyrzX+Wc0KSd6urTrt1gLgxmbliZOxPafT7Lmsuf6jzU1Y0Auc9rqly4oTPrifSR2e1H52HyELyzdP6MVxEc9hc95I7qOxeuCE3gsG1jT1onCvGAVC1CEBa0kgvgMy4k+RbMC1TgClyFprAQ4wjGRk+BQ82h552kcnpocCrUg9modo9APdQqQ8pKOENzZ3loNm5TtUI1zLTUn9QwRLWXLR7nLJUV+tmBRo5U8uyKXS4TlmbZj+VYWTRr3pf4pd21NTrjFz9ieculbnkMu9efYnHau2uoOdFTdAVl5jk5xNxoNUkg9rjOLIBPuFBALmF+8/NNO2iMvrO/XPny4yRrR5RQvqLVE91wb3t7uNMYYe+2EZppWWkHY12p/NdV9a7z71dob/isUeiz2wq9UTMuRe6n/1N9herX1ad9vAvH3/ZiEYj8d7ambHs9KGkxq4xwCw8zXHd5Kbrh++D8koZ38hQd8QmPS7iCDVi/DoX+TQuTWDLiZ2Y1auELaDNqWq7yVF/3dImK6oDkqaU47PNS9Gc7vV22TDb38LJ8FD1W3cdusY5PhJo8tO9yZaoTus5wY2sGW6WqUvwZKVfF+2hTRdimQO7nwSX9e6z95nhL70pU1Lb6O/aHb3aKT6Cm+fj3/zRkF+pCfQWdDgFVpEjX6spk6AEgz49L3x06MUP4+P2/IK2EdL5LzHGGkjzRJuBMZalqpQtA5dCURli0vU6H+LfPnYhZRL6oPSX/dJhAaXReZSRo1yDPF4Bdsih3lUGg+kftE7jC6GpSEDIm1ERiAseHJ6eE/+wfvenBCaq8KaXWi9gwSWDKFZ9gU0+9zDy78iSU1EJqBqHAIPXCYooJcJUDFd0pd0hCG9JOmFbFlmKM2SKTwThcSqA8T/jdDFWuDUidXXWF6pEhut0u/fHkCWGCjk49cdw4zGn1kEozENqG1sG0sg4ybswinNuELklIPcOo5R8jCJ7hDxmNRheq9XEAvycOq4WvIs2F6nQ+/uOfcP5az6m3n6AiFA03Drx8Wjt9rjN729tptV+gLPsnQSnb3z9647PcVrj/b7QDSzc5L9AgHZXiRKg/wBlVjgKh04lhDqhmwmhFpu104Onok9PAaIv4lkY7TfHU3AIfjzHzppbkwTl3fOMqDrRBOOAlT4UUlFRp/QMccIcTbRbwAd4X3HmXpeEq1/DhQn3odrv+PyLtdBoEuNOBD3DgW7gEaBRMIAwsCY1T+ir6VI7k9yv37NbXvnLfyPm09lfP+Y+VkDkYrKxvIBtn9upCabBbSp5hDnG+/dLLQJbRCkEbioJFMyvGI05QjrsUn/6IV7UXWFqOs+JKrMaukQsINRPOVy4YSz2vmR5VqRQZrIt/UnCDwKEMH+vQk0Jd+fBRuuYqhXVQI881zxeGjx281+aKTgoc+Qxb0mnTsgm3kNMO600+FopLERxuGrqUmu+BVo5n8fL+EvKEj4EoTBa+Q6r1FXh4l0+n3ImMS7mombz0WF3g8c5MuKKzVpIJZUWOTQqGF4bcMQB8zU28x7TQ+iowOcYMiYbSUZfSEeAs9iSrGRGCZ/qRHVDlpRbK1ezObC3Qcf3EwLNMV8p5i2Q0szqgSkKzKd3gh/XQIMf/+P2/LXyDc8o7dcGgj09g3zmeFT4LvvfuBidVWWrjLhRVkxFvvttRdEgacJSegw2EmINW4ZIaUyVxAmotBIL6YhuC1QJpE32qXqT8ZXu1qK/J9gHV8X+Q170V6speqBN0MLpghcgD5kKgTaAYSk/BBlTdED4E8GNEIo+O3p2cQt8LVss5ojAjNrXbtN3b1ml7XVmoW8jeyqwHNMqhaUKnvjwuL9To1eEp9Gsd+wORj7zy6+sUPCMoKDRSRAXWGeRTallzH2YG80rlXDlYPRgBRabBqZ5h7ll2OqXBsZDS58z64gy6yhAfi7TXoVyESTXqvGLY6VDNvSIDNE85gNwKNGSoTCtbTbG5oSNu7VybvHtktMOMXOPoxcuVR9F3uid6CxmWkfiCjWq71gk01fkiDNZzbfzpPjWiysyijFxtr+brHXBwoeJ9BseqzTiC//0XRkdntyzul1sbmrZ20Jr322QbfrLxYeM8/4GSL5l0VNvnXYAFG++lnGW0bPz3Nnh4n+NuKup96A5NnQZ63ROZcHIR3y0pyeYiFKB4XuPq1HMhz4oVbFHLH4PvWEsqsD4/xDI0gjDYeP/iWYYlZWzSKYYjPT3QTY8Fyhx4ZrS1vtPyWlDaMrpyaHtwWhhEIPrgz02aGYSaTqdTFcWCzwRlzc1KHmUaQedpHlDPLV8TfDMWu1VKuTT0Ol9TV21qzHCBj8fFzGiVxu060EOGCvhqAIVi9YtlG/xt1oVvxMvS6Flgd8BViGwq5DU5XpPVYk0O0sTa6Q/70KQWblKt4IBg4acHB1sknCgFZegLtQ8K52T2LFtZ+1a+5lKriS9lpA9eC+ubq9EFYTurfVq18vcqUYfsR97WdBfNLfZDo9Rc5iFhksDznB5T0fqWAHOK90ZGE0skp0451arrAe92gQSPbALBX7eRtniheQ/eiitc6ZCQ+GvSwFNbZQV1FCFKVhEv8tEW9QQzkUc7BNHovozI4703VWnGZYWJr+QhS5FlpSDDWo/FT0u3AI9awdPR+eVo60vQBOYTl2Bap0GoAk1cXGe90dvuN1jj4aqxjg1ua4ViglCcs+O3dzS3J6H39o3EIxryphNsZrt1DveOzs3uwzM4xsmtzQ+N7KPNVuavaKzQPkn9Fv7Is6s5N7mFAz0tuRO+9V8QKW0m5xhX1NulNWE3i4QyjBYw2/FuPNvp7TSTX91/2VASXaEtwiwcHBLSCvvVKrzKpLXdPVelITUYqmZWcDWhQKDmq1WoBSX+vMpCLHh5iXV4VeMSKiXRWtD0LDSnJpQe1fMNxzizSHNz7IEuVBfOm9b0PaZWOFzNffP5/Jalt/yel5WUzW9FfMA9MC2Gba+Ee12lcIyltsJps1jtmghXVKm/y/be5h+RQT2kNIDaT5lSPctTNFNLj2UnaGYie0D9viPy/tYFYTMbeM467GJwjIbyjl2bsXkp4jx/XssBJN5P0cP/uiPMKq1HHQKWvt7k4wE+UuHdOOobwa379WUJkyJDZbEFHO6/OnoLs2e9bcLLG5TsE+6y//bNweE3J4f+ISmECRuwnd52b9u/mWvrply1Tmr/kmoT37pZ4am/wK+uIkZHr8v9UnLhEdL41BfQzXPW+iHWoP2bq8uEFdo6Irm5oXg/M3K5pOXvKv8ac36ZsBk3guTzEGhsr/LmJ1U/qOnT4zgjb8EP/HzrTslryFER3ugLBz1DJuwKFxs/GFvSk0rEHUm0QLHv27TW3lsA9hoK/OrwlPnXq2Id77zyeGf8C3G/U651IDQIQP8nVPbODTc3AUtdLhv68OkHd0QFa2oy0uVyufw/bnP2GQ==","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Document from Template","permalink":"/docs/API-docs/v1.1/createdocumentwithtemplateid"},"next":{"title":"Update Document","permalink":"/docs/API-docs/v1.1/update-document"}}');var o=a(74848),i=a(28453),s=a(57742),r=a.n(s),p=a(78178),l=a.n(p),m=a(19624),c=a.n(m),u=a(96226),d=a.n(u),b=(a(77675),a(19365),a(51107)),g=a(21312);const y={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:"eJy9Wt1uG7kVfpVTBihiYSTZjje71RbbdR3np003hn8aoLYhcWaONFxT5CzJkSw4Avai6AMUveltX6L3fZQ8SXFIzmgke+14/y52k3AOD885PL8fdcMcn1g2OGcvdFZNUTnLLhOWo82MKJ3Qig3YaYHwCh3UJLB/9AZQ8VSihYWuwGkw6IzAGUKOjgtpgae6csDBlpiJscggj7t7LGG6RMOJ+5ucDdgEXf2RJazkhk/RoSGxbpjiU2QDVhMMRc4SJkiskruCbcqq028xc29y0ONGXpYwg99VwmDOBs5UmDDrFpLYWjEtJbKE4XUpdY5sMObSEkFW4JSzwQ1zi9JTOiPUhCVsrM2Uu/YKXnPPZcDK1ztpke0WZcqWy0s61pZaWbTEaHd7m/5Yl9dWWYbWjisJjVFYwjKtHEk+uGG8LKXI/If+t5Y23dyWLqhN1jPExolwpHXcVfaxWgjVLY2eGLSWLZPGpI9l8/KVuNp9lhZnfyIuY0GLj+NQOFfaQb8fVyoje5meEreMdByTWX400xaLFmMn3OPltP4v5OHEQunHC1VK5BbBiolqAsVbTcsczcMX/fPcUYi1x3EIEoLfulwZcBWwUQVypLla0+WT+H+rEVJE2k/W8Wmh4cCN4QvKBw6n9mErGX333a5Oy1DfZ4g7xcIpF/JB6hTx67hQ+1pZaPXAMXufPd/defbF5ztEPxf5BN1P0D98fZz9HV67VF97efmkvV1V0xRNe3uz0mzfWSbs+pF7dvf2lglbPHLX53TU/JGbnn2xTFjxyE17z8mXfQL/BJv/mJhqbL5sR5TDaSm5w+FJiINh7Q/3UvmgtKjyN+qdWc8lqdYSuWofTdUx0g+FGmraMSQJM3f/Rl82lwnjUur5UI/HUigcUsTeuW+9CL4v0BVoIAY4ZFyBrdKpoAYi0+WCqrkrhG1yYyDNobJCTYArwGuHRnEJTmsJY23AZxswOBM478ELHPNKOku9ipe1d5f0mUHuMN9390fl7vbus+7Odnf789Od54O93w0+e97b3t7+G0vY9VSubp3lVJ/aSTH+uyrzX+Wc0KSd6urTrt1gLgxmbliZOxPafT7Lmsuf6jzU1Y0Auc9rqly4oTPrifSR2e1H52HyELyzdP6MVxEc9hc95I7qOxeuCE3gsG1jT1onCvGAVC1CEBa0kgvgMy4k+RbMC1TgClyFprAQ4wjGRk+BQ82h552kcnpocCrUg9modo9APdQqQ8pKOENzZ3loNm5TtUI1zLTUn9QwRLWXLR7nLJUV+tmBRo5U8uyKXS4TlmbZj+VYWTRr3pf4pd21NTrjFz9ieculbnkMu9efYnHau2uoOdFTdAVl5jk5xNxoNUkg9rjOLIBPuFBALmF+8/NNO2iMvrO/XPny4yRrR5RQvqLVE91wb3t7uNMYYe+2EZppWWkHY12p/NdV9a7z71dob/isUeiz2wq9UTMuRe6n/1N9herX1ad9vAvH3/ZiEYj8d7ambHs9KGkxq4xwCw8zXHd5Kbrh++D8koZ38hQd8QmPS7iCDVi/DoX+TQuTWDLiZ2Y1auELaDNqWq7yVF/3dImK6oDkqaU47PNS9Gc7vV22TDb38LJ8FD1W3cdusY5PhJo8tO9yZaoTus5wY2sGW6WqUvwZKVfF+2hTRdimQO7nwSX9e6z95nhL70pU1Lb6O/aHb3aKT6Cm+fj3/zRkF+pCfQWdDgFVpEjX6spk6AEgz49L3x06MUP4+P2/IK2EdL5LzHGGkjzRJuBMZalqpQtA5dCURli0vU6H+LfPnYhZRL6oPSX/dJhAaXReZSRo1yDPF4Bdsih3lUGg+kftE7jC6GpSEDIm1ERiAseHJ6eE/+wfvenBCaq8KaXWi9gwSWDKFZ9gU0+9zDy78iSU1EJqBqHAIPXCYooJcJUDFd0pd0hCG9JOmFbFlmKM2SKTwThcSqA8T/jdDFWuDUidXXWF6pEhut0u/fHkCWGCjk49cdw4zGn1kEozENqG1sG0sg4ybswinNuELklIPcOo5R8jCJ7hDxmNRheq9XEAvycOq4WvIs2F6nQ+/uOfcP5az6m3n6AiFA03Drx8Wjt9rjN729tptV+gLPsnQSnb3z9647PcVrj/b7QDSzc5L9AgHZXiRKg/wBlVjgKh04lhDqhmwmhFpu104Onok9PAaIv4lkY7TfHU3AIfjzHzppbkwTl3fOMqDrRBOOAlT4UUlFRp/QMccIcTbRbwAd4X3HmXpeEq1/DhQn3odrv+PyLtdBoEuNOBD3DgW7gEaBRMIAwsCY1T+ir6VI7k9yv37NbXvnLfyPm09lfP+Y+VkDkYrKxvIBtn9upCabBbSp5hDnG+/dLLQJbRCkEbioJFMyvGI05QjrsUn/6IV7UXWFqOs+JKrMaukQsINRPOVy4YSz2vmR5VqRQZrIt/UnCDwKEMH+vQk0Jd+fBRuuYqhXVQI881zxeGjx281+aKTgoc+Qxb0mnTsgm3kNMO600+FopLERxuGrqUmu+BVo5n8fL+EvKEj4EoTBa+Q6r1FXh4l0+n3ImMS7mombz0WF3g8c5MuKKzVpIJZUWOTQqGF4bcMQB8zU28x7TQ+iowOcYMiYbSUZfSEeAs9iSrGRGCZ/qRHVDlpRbK1ezObC3Qcf3EwLNMV8p5i2Q0szqgSkKzKd3gh/XQIMf/+P2/LXyDc8o7dcGgj09g3zmeFT4LvvfuBidVWWrjLhRVkxFvvttRdEgacJSegw2EmINW4ZIaUyVxAmotBIL6YhuC1QJpE32qXqT8ZXu1qK/J9gHV8X+Q170V6speqBN0MLpghcgD5kKgTaAYSk/BBlTdED4E8GNEIo+O3p2cQt8LVss5ojAjNrXbtN3b1ml7XVmoW8jeyqwHNMqhaUKnvjwuL9To1eEp9Gsd+wORj7zy6+sUPCMoKDRSRAXWGeRTallzH2YG80rlXDlYPRgBRabBqZ5h7ll2OqXBsZDS58z64gy6yhAfi7TXoVyESTXqvGLY6VDNvSIDNE85gNwKNGSoTCtbTbG5oSNu7VybvHtktMOMXOPoxcuVR9F3uid6CxmWkfiCjWq71gk01fkiDNZzbfzpPjWiysyijFxtr+brHXBwoeJ9BseqzTiC//0XRkdntyzul1sbmrZ20Jr322QbfrLxYeM8/4GSL5l0VNvnXYAFG++lnGW0bPz3Nnh4n+NuKup96A5NnQZ63ROZcHIR3y0pyeYiFKB4XuPq1HMhz4oVbFHLH4PvWEsqsD4/xDI0gjDYeP/iWYYlZWzSKYYjPT3QTY8Fyhx4ZrS1vtPyWlDaMrpyaHtwWhhEIPrgz02aGYSaTqdTFcWCzwRlzc1KHmUaQedpHlDPLV8TfDMWu1VKuTT0Ol9TV21qzHCBj8fFzGiVxu060EOGCvhqAIVi9YtlG/xt1oVvxMvS6Flgd8BViGwq5DU5XpPVYk0O0sTa6Q/70KQWblKt4IBg4acHB1sknCgFZegLtQ8K52T2LFtZ+1a+5lKriS9lpA9eC+ubq9EFYTurfVq18vcqUYfsR97WdBfNLfZDo9Rc5iFhksDznB5T0fqWAHOK90ZGE0skp0451arrAe92gQSPbALBX7eRtniheQ/eiitc6ZCQ+GvSwFNbZQV1FCFKVhEv8tEW9QQzkUc7BNHovozI4703VWnGZYWJr+QhS5FlpSDDWo/FT0u3AI9awdPR+eVo60vQBOYTl2Bap0GoAk1cXGe90dvuN1jj4aqxjg1ua4ViglCcs+O3dzS3J6H39o3EIxryphNsZrt1DveOzs3uwzM4xsmtzQ+N7KPNVuavaKzQPkn9Fv7Is6s5N7mFAz0tuRO+9V8QKW0m5xhX1NulNWE3i4QyjBYw2/FuPNvp7TSTX91/2VASXaEtwiwcHBLSCvvVKrzKpLXdPVelITUYqmZWcDWhQKDmq1WoBSX+vMpCLHh5iXV4VeMSKiXRWtD0LDSnJpQe1fMNxzizSHNz7IEuVBfOm9b0PaZWOFzNffP5/Jalt/yel5WUzW9FfMA9MC2Gba+Ee12lcIyltsJps1jtmghXVKm/y/be5h+RQT2kNIDaT5lSPctTNFNLj2UnaGYie0D9viPy/tYFYTMbeM467GJwjIbyjl2bsXkp4jx/XssBJN5P0cP/uiPMKq1HHQKWvt7k4wE+UuHdOOobwa379WUJkyJDZbEFHO6/OnoLs2e9bcLLG5TsE+6y//bNweE3J4f+ISmECRuwnd52b9u/mWvrply1Tmr/kmoT37pZ4am/wK+uIkZHr8v9UnLhEdL41BfQzXPW+iHWoP2bq8uEFdo6Irm5oXg/M3K5pOXvKv8ac36ZsBk3guTzEGhsr/LmJ1U/qOnT4zgjb8EP/HzrTslryFER3ugLBz1DJuwKFxs/GFvSk0rEHUm0QLHv27TW3lsA9hoK/OrwlPnXq2Id77zyeGf8C3G/U651IDQIQP8nVPbODTc3AUtdLhv68OkHd0QFa2oy0uVyufw/bnP2GQ==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-2",custom_edit_url:null},f=void 0,T={},h=[];function x(e){const t={p:"p",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(b.default,{as:"h1",className:"openapi__heading",children:"Get Document"}),"\n",(0,o.jsx)(r(),{method:"get",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,o.jsx)(t.p,{children:"The Get Document API enables you to retrieve details about a specific document."}),"\n",(0,o.jsx)(b.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,o.jsx)(g.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,o.jsx)(l(),{...a(42959)}),"\n",(0,o.jsx)(c(),{...a(58309)}),"\n",(0,o.jsx)(d(),{...a(85547)})]})}function W(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(x,{...e})}):x(e)}},42959(e){e.exports=JSON.parse('{"parameters":[{"name":"document_id","in":"path","description":"objectId of Document","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"pH1bhc2hpb"}}]}')},58309(e){e.exports={title:"Body"}},85547(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","format":"string","example":"in-progress"},"objectId":{"type":"string","format":"string","example":"FGik23bhUJ"},"file":{"type":"string","format":"string","example":"https://exampleurl.com"},"certificate":{"type":"string","format":"string","example":"https://certificateurl.com"},"title":{"type":"string","format":"string","example":"sample doc"},"note":{"type":"string","format":"string","example":"please sign document"},"folder":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"FGik23bhUJ"},"name":{"type":"string","format":"string","example":"folder name"}},"title":"document_folder"},"owner":{"type":"string","format":"string","example":"joe bee"},"signers":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","example":"ceo"},"name":{"type":"string","example":"joe bee"},"email":{"type":"string","example":"joebee@example.com"},"phone":{"type":"string","example":"456213871"},"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","format":"string","example":"textbox"},"page":{"type":"number","format":"number","example":1},"x":{"type":"number","format":"number","example":244},"y":{"type":"number","format":"number","example":71},"w":{"type":"number","format":"number","example":38},"h":{"type":"number","format":"number","example":46},"options":{"type":"object","properties":{"name":{"type":"string","format":"string","example":"textbox"}}}},"title":"template_Signers_widgets"}}},"title":"template_Signers"}},"sendInOrder":{"type":"boolean","example":true},"send_in_order_strict":{"type":"boolean","example":false},"allow_offline_sign":{"type":"boolean","description":"Whether signers can submit a copy of this document signed using an external tool for owner review. Defaults to false.","example":false},"createdAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"enableTour":{"type":"boolean","example":true},"redirect_url":{"type":"string","format":"string","example":""},"allow_modifications":{"type":"boolean","example":false},"audit_trail":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"joebee@example.com"},"viewed":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"signed":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"title":"documentwithstatus_audit_trail"}},"template_id":{"type":"string","example":"template_id is only available when the document is created from a template."},"auto_reminder":{"type":"boolean","example":false},"remind_once_in_every":{"type":"number","example":0},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"]},"cc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"]}},"xml":{"name":"documentwithstatus"},"title":"documentwithstatus"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"Document not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Document not found!"}},"title":"inline_response_404_3"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/7ef59f7a.d44ee1ec.js b/assets/js/7ef59f7a.d44ee1ec.js deleted file mode 100644 index 1a5047b86..000000000 --- a/assets/js/7ef59f7a.d44ee1ec.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[4865],{62634(e,t,n){n.r(t),n.d(t,{assets:()=>y,contentTitle:()=>b,default:()=>L,frontMatter:()=>x,metadata:()=>i,toc:()=>T});const i=JSON.parse('{"id":"API-docs/v1.1/getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","source":"@site/docs/API-docs/v1.1/getdocument.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/getdocument","permalink":"/docs/API-docs/v1.1/getdocument","draft":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJy9Wc1uGzkSfpVaXnYitCX5J8msTmPMZj2eDSbG2IGBdQSB3V2tZswmOSRbsiA0MId9gz3tdR8tT7Io9o9atmJbmUwuiUVWFeufX7HXzPO5Y5Mb9nedlAUq79g0Yim6xArjhVZswq5yhDP00JLA6cU5oOKxRAcrXYLXYNFbgQuEFD0X0gGPdemBgzOYiEwkkDbcQxYxbdBykn6esgmbo283WcQMt7xAj5bUWjPFC2QT1hLMRMoiJkgtw33O7uuq44+Y+PMUdNbpyyJm8bdSWEzZxNsSI+b8SpJYJwojkUUM74zUKbJJxqUjgiTHgrPJmvmVCZTeCjVnEcu0Lbjvr+AdD1ImzPx0GOfJUW5iVlVTOtYZrRw6EnQ0HtN/2/q6MknQuayU0DmFRSzRypPmkzXjxkiRhI3RR0dM64fa1WaT9yyJ8aI+0nnuS7evFUIdGKvnFp1jVdS5dF8x/zgTt0fHcf7+Z5KSCVrcT0LuvXGT0ahZKa0cJrogaQnZmJFbvlhoT0RPsBd+fz1d+IMynEQovb9SRiJ3CE7MVVcowWtapmifDvTXiVFda/tJqDWEwFptHLgp2MYESqSl2rLlWfI/aoQYkfjJO6EtdBK4tXxF/cBj4Z72ktW7Y7s5LUH9mCN2qoUFF/JJ6hjxh2ahzTWTa/XEMScvXx0dHn//+pDolyKdo/8D9te7+/nf452P9V3Ql8/77KosYrR99m6lYz+sIna3J8/RyUkVsdWeXK/pqOWeTMffVxHL92Q6eUW5HBr4M3z+JTXV+bzqV5THwkjucXZZ18GszYdHqUJROlTpuXpnt3tJrLVErvpH0+1I7dUi95ie+sez82h8dHxwOD4Yv746fDU5+dvk5avheDz+F4vYXSE31rOU+nS/OTS/S5N+k3NqsHKly+eZbzEVFhM/K+3Own4sdnQcl1IvZ4VO6/vlXqLsODeADmIsU+Fn3m43lD2r/Iv70ULgEndeIV8xFKGJ/7mH7LiFlsLnNRia9X0cSNuCEU9o1SME4UAruQK+4EJSbsEyRwU+x+76JpqmjiCzugAOrYRhSJLS65nFQqgnq7JNj5p6plWCM6FmuEC7s012jGPq2qhmiZb6WRdnY3bVk3HDYlliwNAEvWPJk1s2rSIWJ8mXSiwd2q3si8LS0dbalKJzL94PwskeDXbTQU92Ie9LXaDPhZrDkqK1tFrNI2iAmLcr4HMuFFC87F++HiRHa/VOELRJtP0066e7UFIonLVjx+xkPJ4ddk44eeiEbqRT2kOmS5V+W1N3nf+4QSez486glw8NOlcLLkUaRtQrfYvq29rTP97Xxz/MYlEThX22ZWx/vTbSYVJa4VdhFr474EYc1PuTmylNmJQpuhmiw/DsczZho7YURuve4FwxkmcX7WgdbrduHnJcpbG+G2qDipq05LGjOhxxI0aLwyFB0Ps83Ji96LE82JfFeT4Xav4U33TjqksKZx2xLYdtWpUR/0TqVU08+lTN20KOPAwtFf3OdGBuovTOoCJsFWIcDr//BnGNMtEF0rMIXQiDQcvy6d//67gGg+6mCNk4/KA+qHelBaOXaOk9gKsUMol3gq6X8ORShL3uzcUhLyQ6J1cglMe55R4hFXPhuQyjJLWQhBseCykoiYlME7eFXh24IVzn6HO0tPVXi8AhxQVKyn2ga6rgnkR1N9tS29tM6qWLgENcOqHQOUCVc5UQYRuJCLQFrgCVR2usoAnXW9Ja1Lpp5S1PPBRc8TmS7Aj6zkpRCkpXsDounQenZRlUBnpk0hZTaA1SiKkLTnxDTzkWgVYTXRiLOaXNAmFeihRdBIlOEeqhnUxQKcToPBjSRSToSGippE5uQwCzUkowmlqI4JJelvo6Eru3XDlChbUubQw6hxmr6ZUHawUHg/cOKcJvhbp1k8HggzqAmy6vrjF2wuP0u7YElsvlg9R/sc1zJvxPZQy/otFOeG1XG+658HkZh3LpC+l+1JLOUGHIn14xbGSkOnEPq49WRzlKM7pETxniRqcX56HrvoBPv/8H3iK3CnK9rLM1KS3KFczbo8hzdeRrt3VNEzIdEi8njyd18tELHjrfevA65/7T7/918AsuQaimpMiUweCijKVI4KpBW24wmMCPAYl1CMyBz7mHhCuIEVzOKZUWggMHU3NLoW6HcKpWQMgECFOEZKD1wLdlxtbDjYOYO0xB14CwQ30bjWi9cCgX6EgWXX4xAqaCwKLPrS7n9Wl9ZRrjLGZCSriuhz+y7TRNwTTLzUxIDu+pgxkVhM9xBdwiOHqGhYt7LGGnNEZb0kLUymeaZhkKAKrUaKG8m0BqeeY38qNNogfAK7TasVS7cAOCo0ZMF5K6EhuLu9XhB2rK9xr5dr+1mKGlA4PZm7gY0aTTTZuWQNn6R9I6vD1q5Xnie6MW3Sg/3JcTbna0hXuXXaJdiKR9fPxMRY8C8YhFTIoElcMeYjg9u3gLi+PhmIBydz0+o7hHb89/fPPL5Zsw3qF1tcMOh+PhOLzoaOcLrnon9d/5719s6w2Q+hO+CTSXM719jIzkIkCjZgCvYc0N630mmPS/CEwjlmvniWS9puJ7b2VV0fJvZZiRbqYRW3ArSL+AfVLh6O+0e/D/rKXf/dp8O3gBn/m4sFPzFmsoAhoLTiPUhLGI3eLq3ueMioapBnCQajXFaZKg8T3eB8h1C/6dvbliYabMt4HObQA6zR8kfade2wioVoD+JTi2k2G9rkFUVXX09dZnORoDW2py0rSqqv8DffIr+A==","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Document from Template","permalink":"/docs/API-docs/v1.1/createdocumentwithtemplateid"},"next":{"title":"Update Document","permalink":"/docs/API-docs/v1.1/update-document"}}');var a=n(74848),r=n(28453),o=n(57742),s=n.n(o),p=n(78178),m=n.n(p),l=n(19624),d=n.n(l),c=n(96226),u=n.n(c),g=(n(77675),n(19365),n(51107)),h=n(21312);const x={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:"eJy9Wc1uGzkSfpVaXnYitCX5J8msTmPMZj2eDSbG2IGBdQSB3V2tZswmOSRbsiA0MId9gz3tdR8tT7Io9o9atmJbmUwuiUVWFeufX7HXzPO5Y5Mb9nedlAUq79g0Yim6xArjhVZswq5yhDP00JLA6cU5oOKxRAcrXYLXYNFbgQuEFD0X0gGPdemBgzOYiEwkkDbcQxYxbdBykn6esgmbo283WcQMt7xAj5bUWjPFC2QT1hLMRMoiJkgtw33O7uuq44+Y+PMUdNbpyyJm8bdSWEzZxNsSI+b8SpJYJwojkUUM74zUKbJJxqUjgiTHgrPJmvmVCZTeCjVnEcu0Lbjvr+AdD1ImzPx0GOfJUW5iVlVTOtYZrRw6EnQ0HtN/2/q6MknQuayU0DmFRSzRypPmkzXjxkiRhI3RR0dM64fa1WaT9yyJ8aI+0nnuS7evFUIdGKvnFp1jVdS5dF8x/zgTt0fHcf7+Z5KSCVrcT0LuvXGT0ahZKa0cJrogaQnZmJFbvlhoT0RPsBd+fz1d+IMynEQovb9SRiJ3CE7MVVcowWtapmifDvTXiVFda/tJqDWEwFptHLgp2MYESqSl2rLlWfI/aoQYkfjJO6EtdBK4tXxF/cBj4Z72ktW7Y7s5LUH9mCN2qoUFF/JJ6hjxh2ahzTWTa/XEMScvXx0dHn//+pDolyKdo/8D9te7+/nf452P9V3Ql8/77KosYrR99m6lYz+sIna3J8/RyUkVsdWeXK/pqOWeTMffVxHL92Q6eUW5HBr4M3z+JTXV+bzqV5THwkjucXZZ18GszYdHqUJROlTpuXpnt3tJrLVErvpH0+1I7dUi95ie+sez82h8dHxwOD4Yv746fDU5+dvk5avheDz+F4vYXSE31rOU+nS/OTS/S5N+k3NqsHKly+eZbzEVFhM/K+3Own4sdnQcl1IvZ4VO6/vlXqLsODeADmIsU+Fn3m43lD2r/Iv70ULgEndeIV8xFKGJ/7mH7LiFlsLnNRia9X0cSNuCEU9o1SME4UAruQK+4EJSbsEyRwU+x+76JpqmjiCzugAOrYRhSJLS65nFQqgnq7JNj5p6plWCM6FmuEC7s012jGPq2qhmiZb6WRdnY3bVk3HDYlliwNAEvWPJk1s2rSIWJ8mXSiwd2q3si8LS0dbalKJzL94PwskeDXbTQU92Ie9LXaDPhZrDkqK1tFrNI2iAmLcr4HMuFFC87F++HiRHa/VOELRJtP0066e7UFIonLVjx+xkPJ4ddk44eeiEbqRT2kOmS5V+W1N3nf+4QSez486glw8NOlcLLkUaRtQrfYvq29rTP97Xxz/MYlEThX22ZWx/vTbSYVJa4VdhFr474EYc1PuTmylNmJQpuhmiw/DsczZho7YURuve4FwxkmcX7WgdbrduHnJcpbG+G2qDipq05LGjOhxxI0aLwyFB0Ps83Ji96LE82JfFeT4Xav4U33TjqksKZx2xLYdtWpUR/0TqVU08+lTN20KOPAwtFf3OdGBuovTOoCJsFWIcDr//BnGNMtEF0rMIXQiDQcvy6d//67gGg+6mCNk4/KA+qHelBaOXaOk9gKsUMol3gq6X8ORShL3uzcUhLyQ6J1cglMe55R4hFXPhuQyjJLWQhBseCykoiYlME7eFXh24IVzn6HO0tPVXi8AhxQVKyn2ga6rgnkR1N9tS29tM6qWLgENcOqHQOUCVc5UQYRuJCLQFrgCVR2usoAnXW9Ja1Lpp5S1PPBRc8TmS7Aj6zkpRCkpXsDounQenZRlUBnpk0hZTaA1SiKkLTnxDTzkWgVYTXRiLOaXNAmFeihRdBIlOEeqhnUxQKcToPBjSRSToSGippE5uQwCzUkowmlqI4JJelvo6Eru3XDlChbUubQw6hxmr6ZUHawUHg/cOKcJvhbp1k8HggzqAmy6vrjF2wuP0u7YElsvlg9R/sc1zJvxPZQy/otFOeG1XG+658HkZh3LpC+l+1JLOUGHIn14xbGSkOnEPq49WRzlKM7pETxniRqcX56HrvoBPv/8H3iK3CnK9rLM1KS3KFczbo8hzdeRrt3VNEzIdEi8njyd18tELHjrfevA65/7T7/918AsuQaimpMiUweCijKVI4KpBW24wmMCPAYl1CMyBz7mHhCuIEVzOKZUWggMHU3NLoW6HcKpWQMgECFOEZKD1wLdlxtbDjYOYO0xB14CwQ30bjWi9cCgX6EgWXX4xAqaCwKLPrS7n9Wl9ZRrjLGZCSriuhz+y7TRNwTTLzUxIDu+pgxkVhM9xBdwiOHqGhYt7LGGnNEZb0kLUymeaZhkKAKrUaKG8m0BqeeY38qNNogfAK7TasVS7cAOCo0ZMF5K6EhuLu9XhB2rK9xr5dr+1mKGlA4PZm7gY0aTTTZuWQNn6R9I6vD1q5Xnie6MW3Sg/3JcTbna0hXuXXaJdiKR9fPxMRY8C8YhFTIoElcMeYjg9u3gLi+PhmIBydz0+o7hHb89/fPPL5Zsw3qF1tcMOh+PhOLzoaOcLrnon9d/5719s6w2Q+hO+CTSXM719jIzkIkCjZgCvYc0N630mmPS/CEwjlmvniWS9puJ7b2VV0fJvZZiRbqYRW3ArSL+AfVLh6O+0e/D/rKXf/dp8O3gBn/m4sFPzFmsoAhoLTiPUhLGI3eLq3ueMioapBnCQajXFaZKg8T3eB8h1C/6dvbliYabMt4HObQA6zR8kfade2wioVoD+JTi2k2G9rkFUVXX09dZnORoDW2py0rSqqv8DffIr+A==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},b=void 0,y={},T=[];function J(e){const t={p:"p",...(0,r.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(g.default,{as:"h1",className:"openapi__heading",children:"Get Document"}),"\n",(0,a.jsx)(s(),{method:"get",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,a.jsx)(t.p,{children:"The Get Document API enables you to retrieve details about a specific document."}),"\n",(0,a.jsx)(g.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,a.jsx)(h.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,a.jsx)(m(),{...n(42959)}),"\n",(0,a.jsx)(d(),{...n(58309)}),"\n",(0,a.jsx)(u(),{...n(85547)})]})}function L(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(J,{...e})}):J(e)}},42959(e){e.exports=JSON.parse('{"parameters":[{"name":"document_id","in":"path","description":"objectId of Document","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"pH1bhc2hpb"}}]}')},58309(e){e.exports={title:"Body"}},85547(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","format":"string","example":"in-progress"},"objectId":{"type":"string","format":"string","example":"FGik23bhUJ"},"file":{"type":"string","format":"string","example":"https://exampleurl.com"},"certificate":{"type":"string","format":"string","example":"https://certificateurl.com"},"title":{"type":"string","format":"string","example":"sample doc"},"note":{"type":"string","format":"string","example":"please sign document"},"folder":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"FGik23bhUJ"},"name":{"type":"string","format":"string","example":"folder name"}},"title":"document_folder"},"owner":{"type":"string","format":"string","example":"joe bee"},"signers":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","example":"ceo"},"name":{"type":"string","example":"joe bee"},"email":{"type":"string","example":"joebee@example.com"},"phone":{"type":"string","example":"456213871"},"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","format":"string","example":"textbox"},"page":{"type":"number","format":"number","example":1},"x":{"type":"number","format":"number","example":244},"y":{"type":"number","format":"number","example":71},"w":{"type":"number","format":"number","example":38},"h":{"type":"number","format":"number","example":46},"options":{"type":"object","properties":{"name":{"type":"string","format":"string","example":"textbox"}}}},"title":"template_Signers_widgets"}}},"title":"template_Signers"}},"sendInOrder":{"type":"boolean","example":true},"createdAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"enableTour":{"type":"boolean","example":true},"redirect_url":{"type":"string","format":"string","example":""},"allow_modifications":{"type":"boolean","example":false},"audit_trail":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"joebee@example.com"},"viewed":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"signed":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"title":"documentwithstatus_audit_trail"}},"template_id":{"type":"string","example":"template_id is only available when the document is created from a template."},"auto_reminder":{"type":"boolean","example":false},"remind_once_in_every":{"type":"number","example":0},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"]}},"xml":{"name":"documentwithstatus"},"title":"documentwithstatus"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"Document not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Document not found!"}},"title":"inline_response_404_3"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/851f8f65.6d123887.js b/assets/js/851f8f65.6d123887.js new file mode 100644 index 000000000..ae51c88d0 --- /dev/null +++ b/assets/js/851f8f65.6d123887.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[9070],{11184(e,n,t){t.r(n),t.d(n,{assets:()=>f,contentTitle:()=>y,default:()=>w,frontMatter:()=>g,metadata:()=>i,toc:()=>j});const i=JSON.parse('{"id":"API-docs/v1.1/draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","source":"@site/docs/API-docs/v1.1/draftdocument.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/draftdocument","permalink":"/docs/API-docs/v1.1/draftdocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","sidebar_label":"Draft Document","hide_title":true,"hide_table_of_contents":true,"api":"eJztPdtyHDd2v4K0U5E42zPkjChZprXK0pLWVtaWWCK1KofUkphuzAzEbqANdHM4S7FqH7byAam85HV/Iu/5FH9J6hxcGt1z4UVareyMq2xz0LgcHBwcnBsOLqKSjnW0cxg9lUmVM1Hq6G0cpUwnihcllyLaiQ4mjDxVdFQSV4ns7j0nNMvkVJNKM6VJKcmYCaZoyYhgU5K67shwRgolz3jKxZiktKRkyssJoWRINXuwTZhIZMpSMuIZ6x2JI3HAix3yusgkTclMVorsPf297w8GgrLDTucpG1Zj8vp5p/P27qQsC72zuUmLoicLJjQfi4wOdS+R+WYKFYt0tBGT6YQpBr2ShArCqObZjNA0JVOejlmpY1JOmCCJLGYkkVKlXNCS6ZgUdMyIqPIhUzomVKQkl4oRLgglitF01i1lt9KM/Nv+yxdkJFVOyx7Zyyod++FSrlhSZjPTfTlhflZ3tMOGLhUX45jk9BTwxUvyU8WTU5i2ZiKF/0PD3b3niKtOZ78qCqlKlpI3Zgo7nQ58+YZlckqoYlg/kXkuBSmoojkrccEmtMTPiv1UccVSuyxZ5nCxcyS6pNMRNGc7nQ55LfhPFSM8ZaLkI84UzJKUE65tg56pX84KrP9cpDwB5CEAUErkqFkVkApV9wuWQJemaoBqIgWZTngyQRxOqVn/IqOJmZZiumBJyc9Ys+PzmMyg46dMSAfBRCr+ZylKmuHynTFV8oRm4TIDgFBVl1SVgP5CclG6UjsC+dEuJ6w2LqKlQwAtBeTmXOAXzcgZzSqmLVTTmEwAqlesUEzj5rD9AuJFSiaMjydLx6Ppu0qXjY5JpQHMEAo7lltVRC9DtI1ophnhowYuc3rKgtGIxE1Psx75ZkZSNqJVVsaEA4WWqmI98kKWhBZFxhM6zBjSAGw2WlaKdXGVLfn0muSzhzyAaUJJykcjpmAzw0fswrZx0AFd1kwDd1o5oYJI0VroRGZSzZMQFjfxSBIpSibKHtk9ozxD4M1kNeEiyaqUkWFGk9OYDLOKxUSx1Gz0GQNGF5v9gVUI1RbniB+iWQZUKAXAL6QdnmuiLVRpjxzARvH7Dz46VOMgXIdYtbt8JGFkQIHbkoTllGcxIi4m7+SQlLzMWAwbvKBiFgOHZTEp2Xk5lOcxSSYsOcW/FE25JMOqLKUwE0uVLFI5FRaXIylKzf+8YEe6LzfH6CAm2zF5EJOHMelvxaQ/iEl/Oyb9BzHpP4zJYCsmg0FMBtsxGTwwYA0exu6IcAgOAegPDJbLXxZ2Jzxlx9DwGOZ2THXJFNenwK7JGzhzmADg0tiwS3ZeAvNDbsTHgqX1Ccg1mfA0ZYKMlMyJYgkvOHITww181zHAQxRMSmgyqrJsRs645gEOfKdyKgBvOCJX5GXBxD4fC0KTRFawxohhg1REZ73kIpsBqAeM5hpn/kyUTBWKawasWmiPAVHWtGUOQCgLGcB1VlI0OdDy1Vy2OsHKwAn6PdfIc+Ho0/40nTZO036PdDqez0HZycnJkbg4EoQcRcD2jqIdchT5KkdRbL7BaQbf+vb3Ofy4N/jS/pzBzweDh/bnFKv2t+3PCfwcuKZ2cx1FOzguVuCiNCNb/koCCKDS5ZG4tMAeiQHOoqR5sWIG8PnvCz3x4LtTCgrheIndB9iB8/AsmbGpMTfbezBbLnjJaaaXT9jV+Izm3AJp8bTrSnMz34aZIy9bPm38/BnNOYQHvuAZaj7hmRt8cqcBQjFYgaJ2n8t4MLRC6WgOk/d7VoRZjkgzhc8GjwE4HwuNrS5vjsUHgEU4Tg/gOF2OSn/ifkb4bMP0sZC6qN+bY/bLHgrBKJ0sx6ut8BlhtQnRx8LpfK83x+hDwCiIecvRCV8/I1wG4MAHKzObb1vb3f797mBrsN3AJ1gnTIU876Zpdzabfdha5FwcGzigUVA/p+eLP4DRBERHvxL+C0gwXIx9s+bX+VU39VoLCQKnxQTInE79NEIvGKlQdp63LaDqX9eyCg/+7fTxH0ALHzoFlaVWaq7VEW/+CVXoUqZ0dkebrlxTr3lB/bZsbMDETwAHmsKSieSJBR7qOH1rCNaeHuCgi4u6maabwaJCYZp287zbKoSfXaSBoDDPe2naa9WcIxRTmJM0jcl88cLyNCV5ni8pNuWN4s08n59FL88tbBZ7jvbm1jnngucVaEhgVTMKOlQEJcOiN7dryQXpdH788ccfuz/80H36tNNxa2iHsFQcGDLMCPT8I40QEn2ns0Oej0hYhMYEY8ZBLuAVQ2tUNRUmciqcPoRaoyJpBfZEV9UYk3I6w84YLydMNceRqiZZ0B5B2RrKctIjr1G5hL+dEuaVJVSkvgLGaTXj5bzTVvhU7LPmks2BV7LW5aypwVvnxCLHmIrFcpNi4yqjip2D9U9zKeZ44m3OwJudby226Gi5trSgXdFadpkzdJC7L60OvuHNi625QG+7JKl0iSaJMTsnBS1LpgR2dkYznlLcH10sYOc0L8C0svmno6P0N/+8iYZdsJ2WxqKQ8jEHe/zmnw53u//+dkGNqiiYSqhmJGMwko4JK5MeOZywrKhdAtPptDe9p5OJlJnxB7zTio3Mf4/l8N0xglv0qC42Fs3UEENgSAViadtRcXMGGKOauJYLTKm4NLhr+lsowVlLxQoRztb4jOSOFkjw0Vil4fMhHP0o3ALxsvpvCTznKHpbH/doPGXpFW3fXmN7wm7I6JBl859uvrUyOpOV3dHOWdCcqqXoAG9WFPL2YJzOVhx8pOetj+bb5YJ9ahASblN32rvt6VaAZFz7g6SBzrC1dRmg40cwhr6kISOuATjqHBf40F3gAbveNnD2UVy7K4aAegQreneNG+2KERoLM3eSW1nB+Z1GvleHMneQh/iCluD/rMWEFSNYWWH5CODkWT7AkeijFdJZL1foJ7bGZ8QrWiCt3sa34SKNk/k2R+qtNqCbVrgBFxyvUNUcrH7z6eW7r0deGpO6awTm9iRhBUhaH7w1PcjXPqHQamws6N+gBX055YV29s+I+haA9XemQFvvY58+tyLScPa/IEJtgH1tYjVG/5yOV9hv8PNnRJ4hPItNHLbGnLGqj5Z+c6KssFDj99UT7m81Jny/OeEHW7fQuBrDfrjCtbUCP3NDgW5dZXTuOEhZwnOaYQQJwj34gD16G+XLAgZ74InMi6oMNx2adZCxOCnBxUUYz+5vYtKNSScmmzG5G5ONHnnFMJIi8VEXVmjgysRWcEFSWYGbNKlUNiNDBROPCeuNe+Ti4qeKipKXs8tL0iEXFxC9dXnZg114KuTUBF4cgsu4JBA4VStVqUz0gkArmehN0L42X7Bp1wWLbVrQNshd2WIJK1VRi4JPq5EZqAIigVFeeJHNaKUY6cN1kdEZoSNwU5toEGxmgoZ6gOIdMiC/fUz6g97WVky2zN/krpvgYAP3MPqYEpatclLi56t28Fa4g+ufi1jW/a1rbeFw2FvuYOjiGGMIcNwrBbZ6c3+GppN6Mm1jbSDVA87M+aknsspSOD0VKyslmI/fq2V69I3RsqTJBOMll9NAUOkzOrxqqCwLWnmQQZDnIo91p7On2IhnWRDFSFyRY20QFcYyltvIORu/CFodRmxwUUpgHy6kpdMZspGEaA0Io0T7KK3jHM0SGAmmEQmTKEZLqciEamNuQoKDhYM40XLC8lbciAOvjh3hwsEOq9n/eIbRwVfNPf7gfmNl7zeP6aV7fNnCrrCXQhNdSKG9W5TVn4LNh3268nkNq72hXKew3Bg2VEc/IS/H/ZPxUxayXC60E1YtlO1owCcTKXVdwwbk2eNH7zQD/aSCWL+Nno+Q+VDvX//Lew1Z6uEn9P41V2lre7N/f3Ol+6/lKbq5zkzIdZYUnQvXWlKsWa/p2jf2Ib6xD98R9z6mfbr/5aBxMt1bJaN8JvbpcEddYZn+GPbnW6n4iwzB4T68pgn4k5liP5wst2uj1PCjGaVajPvL/j/AKPWhJDpne/poREk+luFpEWVew/K00tz0wZQbAvt3p977H8dK1VL5vmpIg18NQmq9f//DqLVtowpI7ijif/zm5avp1h++Hcvd3d3dF/uvJ89ej3d3d3P43ev1FlouF5EBDgPys70OZY94FBeWjNLr9TBqgZZ0B5tvFmL8tWkfL2/TOxJRHMkCrqxxKZ6n0U6UwiU3pwhEMeKF6fIbmc6inYvI3neAP238ObTcfKfhltxFpJMJyyn85fAJ9+pA44niCEP94GodLHC0E8nhO5bAGIUCGErONLTE2jsXrpa5DRbFVmaLdiIzryiOrAPdF/l7dEU6ii5j7Om4oFpPpUpXdulL6i6hAwPxDRtq/MMrU9AP3MC6ZTcvoOll6zrirXp6GvSAc8vZgQQDXMZK9pTOdNCvUeWj9i1IaAO8I7GtSEpnGnhQpc1BmtAsqTIQTNl5wdXMR5ChdBqQlYfXj+Th7d+/jCMTuhOCRJWisyiOeMnysHwJFSl585VLmATMYMj0Tdu+k2zI2O9sAZgCceFpfmMo3klGhgwXvZhIceP2/cG9/qB/rz+AHmw46E37cGZN6OKdHB7faiOk7CzyS3l8/QVp0lzzGhb04o8rd+vHRx/aYLBCyYRp3SO7cB+GpVbm26nDzMBV4I2QGzsmnnFCzxgBTssoWDVEcJGkeePujLMp9LBDXrGE8TMLW3g/F6pgiM7XxmmOfQvZuhhIC4iTcl1BG3N7yJY3u/0a2rch8ldXDS9nosqB45o5RnFkQI3iyA0F/DdgDabeZRyBFKH1MfDP26zSFK5vaQZBnnB5SVQ5UzwhplcCvQKb8PdsnXhkI/TAsGRqwuyhsDHzXpu+t+8/AJgtMm/PJMzX+dk259akIn+vzy9FbK7fxP46SvwBl+icb7p9YQuP9djaWGNjYY1JYA/tXXUKOHCRsdAxu5rdHyy7iRxcgLT2XVoUjKoeXgi+9d305gnixeHeFefFZRydXz2Zc5LIrrvmTO5mbFSa8DmSSCWY2gjDoT+byQ22ty/jaHb19Ga/yOl9CYs3vXp2b/B+eH13/h8B672Hl3E0uRrW7/wN9n8gsNsPLmv5NUJ7PnPs9Hgo09mxY56XV1V0ohjUG8ksZer5QmG6KTpDpobjtiQ1lDJjVCxgNI0LrzarBmir4MS0Ns/phKFb2Cux2HutIVuXp4HWRp83Inq5BuVSVewo6kFwea1vo0DRvnPr6uKZJCS5g+Md6wrPkjub9jfg6E6YVQIcMvU9CAcCViYly4sM0yxMwaszRC9Y2iP+H3OKO0wCAE4gdQNffV49MRHIOKBt1MxRQKxS1yNPqPDnWfMGMbm48GSA1HF5SS4uYFWZOoZz7fIyrgtgrEYBSq6mRBkZKWzli1jd0JcFTY0SgVH5psCenyEANnK/UrYf0LUuL5siQwtw9GtZHLDU0xmIHfOz9hoBrvS1sT+HbEsB0Mn/G7w/Kh5/xxeA8mizePyoePwGMpIUzOw9g54RF6nZ+VOWZT3ySJdKivHjFgoebdryxUupUJauhcm6lzZufUc9C9OPwKjrxeOaJKpKOM0w9B4UC+c+RZc3mLx0yQoNsRW8NCoIaiuo8dKxYuisNWJ9VWIGFrSZuAEfUTJRbPTbOy2c3nmMyQcg5uTRJn1saz83RjyjqogZwYmjxVEqY84eVQrZZJJRxUfWQBOTArQahvkqaGKiQgxGHRwHEypOdfxoqB5DGgOf/uDnv/4Najie/ly8VClT12DqcH3HmB/vAB+7E5srC0juXOnSCf/ICS2FeKVg0dax4jXErjzzrF9XQw21hOuvZq2l4uMxA3XD1sDGNrEGo8nEHBoIVR3CUgDxyEo78IDAnL0jtXFF/ipRaCMNsBNcVTJz7y3g6nhCcnEsocWxuTx1DbS+sZpWiFgzGQMv12SYyeQUSAEkPqNY+RQ5TketRMkzzPdQAO5Td0MKEIjU1Z4zxZDuHnkmRlIlTBMDcYDbGi1opEb7IJx0APCdADt30GqdaY8c8tTgEBf0DpqZmxjDIlBSgUsey9Eo44KhYHIrOnTzhGBzXQ3hNg01CamcIODRZBOP2KwigrBzuM+D3EBmeKqarCGG41x/Jhh5Yy0jbttnXJzqD5iQt39gRyiH2CQp1j6Ctt16bs74fH2oTX6Wlwd714ASfQ5dg06bMwU3pumDvDzYg/xTnkPB5Tq/eR03oI0qxoxwxqlTr70yOjNGFmZc7XKBBcFmfuqSeYBSrhdCFBs5FBDq87vNdVwnNAOuIqsSImS4TdaCB8MKRB7I6jqM9ApMUjKu8A5uCSeOE/TwLlidP4oLXarK3MpwFyIXmswcnhxWoFLQf0yY0KY5JSMMGItJJThgXlXghvJdsvOCKQ6BmQtRoJhBHZx2V0tVTSvg61ff2zR2gRHJsX3XMWzbAqkGGdkcB2xPfaEKYyWOqwEEdQPDTa1xsmBKSwGnslRjKuyhb0wo4DAbsgnNTFV7ukGUBnLhOYuXUw5//uvfAriWmqnnATMj0DSF0MErIETfoyF44I+KFXBoyyZE0B9Tv2trrZHn0blM/Ua6Dk+zNL6Hdxu159A24sxHvOkqmYCk5UUEHVrd0Ayn0c3ok0fJAubLzrkug8RIniPO8YdX9hpzDYM5RdPUnACzcIPXkXiy1R1qtLyZIs3r7fPnWlXKY8VyLq4nWoVu3VJ6RlCVMqclT4jrSveaie9MtJHb13kdhgvUeMal2liyVaG7YykSBgILO2PqGhapIGIYvERDVk4ZEyFsDknSiwsmnRVKDA2ctO5+N6AEd1HO1JgdJ2DZRapj10BipwNddTqkawCxPFVXyjrgbdJIZB7AR+reARyrvvnUB7W8FObq7JHv5BQQ5iVw0JNM/4BPgpDbjGfhCAkVeO8cxHQwLpROnjP36DCo3Q5hQjFxsXA2VkdIjGceeoEkhzBOvGpOjn/6nA4UEhW60Z0kBJMDvyqhmcT9ZDWhVoY2BOo55qib4PmjjXeAl2YclzgSpaef//LfGsRQG8evvXVm4VcUbFB8xAv4Ya+OnB3B95rmFEfPQpZ8NDuW4rjmIwsJptlyJQEtiJ5tijLCcmEc3Ek0QOlAHYDoWoZr+n3m1nf5YICQjzQg+J3BKTWmKs38qWGWscT0rDQkJDPUMmpA7XcJ2RkXBsO0dikrIMGrtPqCOeIC4xqsJ3gvmDjGOJPruH7ssXgZrOZhBOEoGNyQRrGJ+4neXsbRMElu2yOcmA3vb4xFg0bZXFrhYZKQu8OMA3qoGkqTdndjxwrDNIV9iIJOSy5uLKpBPrKThoTDA83Vou5TTxDm92lmVpho80VOvyZILpesS1HhRAKjTWBO5HwIl/wwch7VepQdnW15zov4d3NDrnLnWdfh2pn3C/J29be2fs3OvHtbvxxn3vbWL8iZ9xCAtUGLV3OTZfrqQt7hbECrG7yTzAQTZVKtrgknKvoJTejsIgTX22Fwaf6p/Y+OiYdljYhE44TBNnWEoTWourkgFgZbW/C/5mo+bUhNYKuo0DqKeYH/KYqvH964egk8tPzGYYeTd3zw5/PkbLAHeFxiG1nZgSXESmWQjx+Or66X7FBHD3DLBVpSEcXHqUyOFdPHg62t435kFmZ7ERr3Zc6MWD/FO2/gQPH6TalmhI5BQQEaVx8Rq0ypq8jvZpAtwISjoePtBhLuzyPhucD0N/gMxIE8ZeLTzjQcvjTDA6jneVbzgIibSvg9akw2LDeT1CypFC9n0c7hRXTepQXvmu87h28v34KKXU4kRAgXUiPEtJxEO9FmO2BYM3WGkZuHF4Z8PUVqKlK4FzHHHmnBN8/6PQhYbLdZyE5X1GdV96ZNdEnHXIyvave2RtE+LKNZqQaiavmv4H9gIADadQhrxREH8pkwCrYewDxQx6s6zPqZW2MXCr0ounkuuDmK6uVtRyC7AORGTHH7pFsQJbw4SLh/PwjPPXSRthg862NnF4XDemy4AFcf3xqErAYRq3UQaiMGFcNKW1GldbxjI4zRhQoGkYKH9Z7y8XBOgu6j6DnY3kYZ7cs+CjP3HqKcsP3gEndBHQATRc0gF7w00A7V+LDIg2bgwdqb/ivyprec6YZ4FnuEre1pke/TflrhTLQ1Asddo8R4oGxR0yPj6Nt7QBpuiLYXYqlHYIlDwE2qafj2gCyyN99faOa1TRab9OzH0F602PZjTT/Xt3LcrHZgm1jAiZw43uRDcLEJ+NC9LeRD21vIhx5uNTQBuzJ1D7U8j0K7l9ntdGu5HITvt3D6cDGSeHRZ9uqfvQDJAo++9knxRUjNvhoYDR+TTucArx0z0dWyUgnD97LMMxoZus7xpaKf//JfZFjxzASmpeyMZSD/wNtTqtI2xRLzb2jonnmCIhx3jHH3+FKOtwWhxzM1bs4uPklFWLdmPxB6B6IzKSdKVuMJGkHFGAKzXz3bPxhVGT4qRfbBCFm/3tWInYNnqQSYUXwoH8AMD+I4f6IuaVmhh0kxYHQcYsAtwwL/DDPMDGImVGDSyviIJbMkM8gxb1AZj/IZE6lUBII6uty82NHtduF/X3xBvjXmWLIPSZtZCqXPYL/42Bn0jCdUqZkZ1wuMznFxEkgnJ8TIJTgI3lILPu6QR9BDXfA4yF3x83/8Jzn8Tk4br6A1B7x+6px9Mym9ubv3HGXrDbP+LzDjrmLO+QuRn2Mu/hWMijiXTscKmYSJM66kANTCVY+TawuhJxv2bCqlfcrJ+vVHI8hqiOEVZ3j7nraW4gmYC5/Qgg55xkGUh/L35Akt2ViqGXlP3oDbxz+FJsn7I/G+2+3iv1C10/FP0HU65D15gmqqCS2KSVWYWwOKnclTS1Mpw3tY9fNTbtlr8rU9Hzh6xZ6/qXiWEsUq6w0M4lLLCXhbupj6x78B87V/eg3uxUgFu2DmXaR2iH2WjbqwP3GIbx0VaChueQR0jVcfuCTOeGnMviN4t812ulcNM56QJvj7E3QCkcJ8DANfcPsIZ6zFO7f1vROHZQyEeSPVKYxkegQZoIYOXcgOJ1Sb0BlzPWXEBc24ti5UVCVdv0+MPGBg/MHwiZkTgdB6Z+SFoZSnQGJjRXP02EJgmuvk9yhimj5eomdeh5DZNBGeTT9VQI5GLvUr8YYNJ1Kemk7sJSVkR128wsfO8OWxwNKuiaFMjGciTKTm2TfbHdrsbV+l4gzEJfMokvHsgOQAt7CMXQJW8H1zawDhox/vBZsC33EHBnz8guzW+XNM6htiX/Q7EnCanAS3XE6cuRPzb0+DhDOQdrwR3xRbK09QYCq4hfUV6gKYjaUpVwj8S/ccqN8B7vfNau5bqvseRK0jAZ72k6Plwpi7WUzeG+fkCYB8svdy/4A0legTfz17YVzXFcFcNVqfgBeTKb913OLR7EicfPvsgGy6OW7u8PQEJ98sh81zYsTjIfjudakYzUEATXGbKZZWIoVY/Fb8u2K5PAMXskjhjUObxAhfvrQL57NBOQdzNjNGbTvnusNOxz8F6S18+GylifVKpNBVzvwK7VmVuLunZGnCgMBn7SkKvsM6NfTno+jE4dUxUFC6TCTCVKpT7nzdTCRqVtheIb4iIMCdI2HX0xCWQ+MJ+d//ISd7r+cwjsVBA7eamzuu3nGzWotOWh9a4+EHYL6A0hOHn5dGg/DUCzxLyczT77yesYpw2xNFGlowU4hSOQeDGIdYORuwAqKfDUex43lSx/zoENXquvHrazffKwlZtAx/sMfQCTHmNKQvkxUBIhhOjkJjAaz0iDPwlCRKwo3DLDN8ANiWklXJMDJFMXPZ1N7ncKu8Y850GB1OURM2U6m5k9zCdEI6/pYpngkojLnb0yvvmhree2IucJ7UbLx113QkXfCpCaOxp5/PF2bvLprO3CVQ6A6uIHjF11Vn54A1eybXMdhcGbX7vWctxqX7BGJm7z55sgHA2Rf4jsQuvn57chQlSY3tOX6N8SM+45EP0Do5AlWsbidFwL9rRm24H5oknHThV3HTCEp+MZ+F0W9Mo0hg4nY8jLX72TiruxgNfHNXNPkesjT4OUDIO2lAQ+66EDazS+odz9OTjSBg04MG66Xw1VCTY8PycvQbxXiSGy4FmM24DdsBcItyRtARTe6eHL492fiaSIh0NvH3gNpSEi4mTPFyQdct2bZ+3vJZLVhbATcogT0BhhEI0JwXbveN7I2CxA0Eci8Jet2u2cNKw61v/ew1RLPMNb7KYHzSFmX+yBQkw4M1+hfyDU1Op1SlGjOZ0pKj6D+DqtAYiMO8OTl0FbuJrZgZ1YKc9c1bvP1e32t+Tv7SLuQLArnOzMA2/il4e9JY/IYO79irkGSomDk1kwkVY9gIIHwFBzUHxp9WidkLCC907d+arIQJ/AED2JTb0LW0RRivNQO92cpAcK390Iumb9hQ85I136FoY3oD2/y+yjL/tDZuuCu0RdPsW15+Vw3hNWGpeSnVrG415uWkGuJahm39D9uBU1K8G+dDtFTs8oCpHMOl9pk648kV09+Ex5L15gZGqrW8CU2zC0bAAd9pvjROC271+UMHB2m+/nHzeRhnL+oq6I6yNj5a8IUhvziFlyM7X+taWT3fKI4ynjDrebZmrN1v974nZ/d6W1Ec+GiusZab3z9/8uzF/jMAxm4TsP73tnpbGCAjdZlTEYzUfMq9beEK0tysH35fP/y+fvh9/fD7+uH39cPv64ff1w+/rx9+Xz/8/ukSy68ffl/2GMz64ff1w+/zeFw//L5++H0uK/v64ff1w+/rh9/XD7//Kh+3WD/8vn74fRn7XD/8vn74ff3w+2f9sM764ff1w+/rh9/XD7+vH35fP/y+fvh99elzKyJdP/x+8ye11g+/rx9+Xz/8vn74ff3w+/rh9/XD7+uH39cPv68ffl8//L5++P2X5htbP/y+fvh9/fD7+uH39cPv64ffP6qN6lfy8HuQfmqzyCgXQcZRk93xsPUc/Ns4mkD2x53D6OICRnkNudWg+KcKc3Qdvo2jM6o4BKdj4sjYJTqEfFenDNLYPTE3J7oHMHxs9jxeLmzly4RMjabFLhL6yrphgkrITACpvexzfbnJBajoFPJj0alJbRYk0cKyiyijYlxhAq7I9HlpXuaYNBM7nmJiR/tHkMULchbWEDYzPpppwH9hUgsbXFyYpJGY9s/UN5+WtrCIdbVh+d5eXl7+H2FYO+w=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Self Sign","permalink":"/docs/API-docs/v1.1/selfsign"},"next":{"title":"Create Document","permalink":"/docs/API-docs/v1.1/createdocument"}}');var s=t(74848),r=t(28453),o=t(57742),l=t.n(o),a=t(78178),d=t.n(a),c=t(19624),h=t.n(c),p=t(96226),u=t.n(p),m=(t(77675),t(19365),t(51107)),x=t(21312);const g={id:"draftdocument",title:"Draft Document",description:"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztPdtyHDd2v4K0U5E42zPkjChZprXK0pLWVtaWWCK1KofUkphuzAzEbqANdHM4S7FqH7byAam85HV/Iu/5FH9J6hxcGt1z4UVareyMq2xz0LgcHBwcnBsOLqKSjnW0cxg9lUmVM1Hq6G0cpUwnihcllyLaiQ4mjDxVdFQSV4ns7j0nNMvkVJNKM6VJKcmYCaZoyYhgU5K67shwRgolz3jKxZiktKRkyssJoWRINXuwTZhIZMpSMuIZ6x2JI3HAix3yusgkTclMVorsPf297w8GgrLDTucpG1Zj8vp5p/P27qQsC72zuUmLoicLJjQfi4wOdS+R+WYKFYt0tBGT6YQpBr2ShArCqObZjNA0JVOejlmpY1JOmCCJLGYkkVKlXNCS6ZgUdMyIqPIhUzomVKQkl4oRLgglitF01i1lt9KM/Nv+yxdkJFVOyx7Zyyod++FSrlhSZjPTfTlhflZ3tMOGLhUX45jk9BTwxUvyU8WTU5i2ZiKF/0PD3b3niKtOZ78qCqlKlpI3Zgo7nQ58+YZlckqoYlg/kXkuBSmoojkrccEmtMTPiv1UccVSuyxZ5nCxcyS6pNMRNGc7nQ55LfhPFSM8ZaLkI84UzJKUE65tg56pX84KrP9cpDwB5CEAUErkqFkVkApV9wuWQJemaoBqIgWZTngyQRxOqVn/IqOJmZZiumBJyc9Ys+PzmMyg46dMSAfBRCr+ZylKmuHynTFV8oRm4TIDgFBVl1SVgP5CclG6UjsC+dEuJ6w2LqKlQwAtBeTmXOAXzcgZzSqmLVTTmEwAqlesUEzj5rD9AuJFSiaMjydLx6Ppu0qXjY5JpQHMEAo7lltVRC9DtI1ophnhowYuc3rKgtGIxE1Psx75ZkZSNqJVVsaEA4WWqmI98kKWhBZFxhM6zBjSAGw2WlaKdXGVLfn0muSzhzyAaUJJykcjpmAzw0fswrZx0AFd1kwDd1o5oYJI0VroRGZSzZMQFjfxSBIpSibKHtk9ozxD4M1kNeEiyaqUkWFGk9OYDLOKxUSx1Gz0GQNGF5v9gVUI1RbniB+iWQZUKAXAL6QdnmuiLVRpjxzARvH7Dz46VOMgXIdYtbt8JGFkQIHbkoTllGcxIi4m7+SQlLzMWAwbvKBiFgOHZTEp2Xk5lOcxSSYsOcW/FE25JMOqLKUwE0uVLFI5FRaXIylKzf+8YEe6LzfH6CAm2zF5EJOHMelvxaQ/iEl/Oyb9BzHpP4zJYCsmg0FMBtsxGTwwYA0exu6IcAgOAegPDJbLXxZ2Jzxlx9DwGOZ2THXJFNenwK7JGzhzmADg0tiwS3ZeAvNDbsTHgqX1Ccg1mfA0ZYKMlMyJYgkvOHITww181zHAQxRMSmgyqrJsRs645gEOfKdyKgBvOCJX5GXBxD4fC0KTRFawxohhg1REZ73kIpsBqAeM5hpn/kyUTBWKawasWmiPAVHWtGUOQCgLGcB1VlI0OdDy1Vy2OsHKwAn6PdfIc+Ho0/40nTZO036PdDqez0HZycnJkbg4EoQcRcD2jqIdchT5KkdRbL7BaQbf+vb3Ofy4N/jS/pzBzweDh/bnFKv2t+3PCfwcuKZ2cx1FOzguVuCiNCNb/koCCKDS5ZG4tMAeiQHOoqR5sWIG8PnvCz3x4LtTCgrheIndB9iB8/AsmbGpMTfbezBbLnjJaaaXT9jV+Izm3AJp8bTrSnMz34aZIy9bPm38/BnNOYQHvuAZaj7hmRt8cqcBQjFYgaJ2n8t4MLRC6WgOk/d7VoRZjkgzhc8GjwE4HwuNrS5vjsUHgEU4Tg/gOF2OSn/ifkb4bMP0sZC6qN+bY/bLHgrBKJ0sx6ut8BlhtQnRx8LpfK83x+hDwCiIecvRCV8/I1wG4MAHKzObb1vb3f797mBrsN3AJ1gnTIU876Zpdzabfdha5FwcGzigUVA/p+eLP4DRBERHvxL+C0gwXIx9s+bX+VU39VoLCQKnxQTInE79NEIvGKlQdp63LaDqX9eyCg/+7fTxH0ALHzoFlaVWaq7VEW/+CVXoUqZ0dkebrlxTr3lB/bZsbMDETwAHmsKSieSJBR7qOH1rCNaeHuCgi4u6maabwaJCYZp287zbKoSfXaSBoDDPe2naa9WcIxRTmJM0jcl88cLyNCV5ni8pNuWN4s08n59FL88tbBZ7jvbm1jnngucVaEhgVTMKOlQEJcOiN7dryQXpdH788ccfuz/80H36tNNxa2iHsFQcGDLMCPT8I40QEn2ns0Oej0hYhMYEY8ZBLuAVQ2tUNRUmciqcPoRaoyJpBfZEV9UYk3I6w84YLydMNceRqiZZ0B5B2RrKctIjr1G5hL+dEuaVJVSkvgLGaTXj5bzTVvhU7LPmks2BV7LW5aypwVvnxCLHmIrFcpNi4yqjip2D9U9zKeZ44m3OwJudby226Gi5trSgXdFadpkzdJC7L60OvuHNi625QG+7JKl0iSaJMTsnBS1LpgR2dkYznlLcH10sYOc0L8C0svmno6P0N/+8iYZdsJ2WxqKQ8jEHe/zmnw53u//+dkGNqiiYSqhmJGMwko4JK5MeOZywrKhdAtPptDe9p5OJlJnxB7zTio3Mf4/l8N0xglv0qC42Fs3UEENgSAViadtRcXMGGKOauJYLTKm4NLhr+lsowVlLxQoRztb4jOSOFkjw0Vil4fMhHP0o3ALxsvpvCTznKHpbH/doPGXpFW3fXmN7wm7I6JBl859uvrUyOpOV3dHOWdCcqqXoAG9WFPL2YJzOVhx8pOetj+bb5YJ9ahASblN32rvt6VaAZFz7g6SBzrC1dRmg40cwhr6kISOuATjqHBf40F3gAbveNnD2UVy7K4aAegQreneNG+2KERoLM3eSW1nB+Z1GvleHMneQh/iCluD/rMWEFSNYWWH5CODkWT7AkeijFdJZL1foJ7bGZ8QrWiCt3sa34SKNk/k2R+qtNqCbVrgBFxyvUNUcrH7z6eW7r0deGpO6awTm9iRhBUhaH7w1PcjXPqHQamws6N+gBX055YV29s+I+haA9XemQFvvY58+tyLScPa/IEJtgH1tYjVG/5yOV9hv8PNnRJ4hPItNHLbGnLGqj5Z+c6KssFDj99UT7m81Jny/OeEHW7fQuBrDfrjCtbUCP3NDgW5dZXTuOEhZwnOaYQQJwj34gD16G+XLAgZ74InMi6oMNx2adZCxOCnBxUUYz+5vYtKNSScmmzG5G5ONHnnFMJIi8VEXVmjgysRWcEFSWYGbNKlUNiNDBROPCeuNe+Ti4qeKipKXs8tL0iEXFxC9dXnZg114KuTUBF4cgsu4JBA4VStVqUz0gkArmehN0L42X7Bp1wWLbVrQNshd2WIJK1VRi4JPq5EZqAIigVFeeJHNaKUY6cN1kdEZoSNwU5toEGxmgoZ6gOIdMiC/fUz6g97WVky2zN/krpvgYAP3MPqYEpatclLi56t28Fa4g+ufi1jW/a1rbeFw2FvuYOjiGGMIcNwrBbZ6c3+GppN6Mm1jbSDVA87M+aknsspSOD0VKyslmI/fq2V69I3RsqTJBOMll9NAUOkzOrxqqCwLWnmQQZDnIo91p7On2IhnWRDFSFyRY20QFcYyltvIORu/CFodRmxwUUpgHy6kpdMZspGEaA0Io0T7KK3jHM0SGAmmEQmTKEZLqciEamNuQoKDhYM40XLC8lbciAOvjh3hwsEOq9n/eIbRwVfNPf7gfmNl7zeP6aV7fNnCrrCXQhNdSKG9W5TVn4LNh3268nkNq72hXKew3Bg2VEc/IS/H/ZPxUxayXC60E1YtlO1owCcTKXVdwwbk2eNH7zQD/aSCWL+Nno+Q+VDvX//Lew1Z6uEn9P41V2lre7N/f3Ol+6/lKbq5zkzIdZYUnQvXWlKsWa/p2jf2Ib6xD98R9z6mfbr/5aBxMt1bJaN8JvbpcEddYZn+GPbnW6n4iwzB4T68pgn4k5liP5wst2uj1PCjGaVajPvL/j/AKPWhJDpne/poREk+luFpEWVew/K00tz0wZQbAvt3p977H8dK1VL5vmpIg18NQmq9f//DqLVtowpI7ijif/zm5avp1h++Hcvd3d3dF/uvJ89ej3d3d3P43ev1FlouF5EBDgPys70OZY94FBeWjNLr9TBqgZZ0B5tvFmL8tWkfL2/TOxJRHMkCrqxxKZ6n0U6UwiU3pwhEMeKF6fIbmc6inYvI3neAP238ObTcfKfhltxFpJMJyyn85fAJ9+pA44niCEP94GodLHC0E8nhO5bAGIUCGErONLTE2jsXrpa5DRbFVmaLdiIzryiOrAPdF/l7dEU6ii5j7Om4oFpPpUpXdulL6i6hAwPxDRtq/MMrU9AP3MC6ZTcvoOll6zrirXp6GvSAc8vZgQQDXMZK9pTOdNCvUeWj9i1IaAO8I7GtSEpnGnhQpc1BmtAsqTIQTNl5wdXMR5ChdBqQlYfXj+Th7d+/jCMTuhOCRJWisyiOeMnysHwJFSl585VLmATMYMj0Tdu+k2zI2O9sAZgCceFpfmMo3klGhgwXvZhIceP2/cG9/qB/rz+AHmw46E37cGZN6OKdHB7faiOk7CzyS3l8/QVp0lzzGhb04o8rd+vHRx/aYLBCyYRp3SO7cB+GpVbm26nDzMBV4I2QGzsmnnFCzxgBTssoWDVEcJGkeePujLMp9LBDXrGE8TMLW3g/F6pgiM7XxmmOfQvZuhhIC4iTcl1BG3N7yJY3u/0a2rch8ldXDS9nosqB45o5RnFkQI3iyA0F/DdgDabeZRyBFKH1MfDP26zSFK5vaQZBnnB5SVQ5UzwhplcCvQKb8PdsnXhkI/TAsGRqwuyhsDHzXpu+t+8/AJgtMm/PJMzX+dk259akIn+vzy9FbK7fxP46SvwBl+icb7p9YQuP9djaWGNjYY1JYA/tXXUKOHCRsdAxu5rdHyy7iRxcgLT2XVoUjKoeXgi+9d305gnixeHeFefFZRydXz2Zc5LIrrvmTO5mbFSa8DmSSCWY2gjDoT+byQ22ty/jaHb19Ga/yOl9CYs3vXp2b/B+eH13/h8B672Hl3E0uRrW7/wN9n8gsNsPLmv5NUJ7PnPs9Hgo09mxY56XV1V0ohjUG8ksZer5QmG6KTpDpobjtiQ1lDJjVCxgNI0LrzarBmir4MS0Ns/phKFb2Cux2HutIVuXp4HWRp83Inq5BuVSVewo6kFwea1vo0DRvnPr6uKZJCS5g+Md6wrPkjub9jfg6E6YVQIcMvU9CAcCViYly4sM0yxMwaszRC9Y2iP+H3OKO0wCAE4gdQNffV49MRHIOKBt1MxRQKxS1yNPqPDnWfMGMbm48GSA1HF5SS4uYFWZOoZz7fIyrgtgrEYBSq6mRBkZKWzli1jd0JcFTY0SgVH5psCenyEANnK/UrYf0LUuL5siQwtw9GtZHLDU0xmIHfOz9hoBrvS1sT+HbEsB0Mn/G7w/Kh5/xxeA8mizePyoePwGMpIUzOw9g54RF6nZ+VOWZT3ySJdKivHjFgoebdryxUupUJauhcm6lzZufUc9C9OPwKjrxeOaJKpKOM0w9B4UC+c+RZc3mLx0yQoNsRW8NCoIaiuo8dKxYuisNWJ9VWIGFrSZuAEfUTJRbPTbOy2c3nmMyQcg5uTRJn1saz83RjyjqogZwYmjxVEqY84eVQrZZJJRxUfWQBOTArQahvkqaGKiQgxGHRwHEypOdfxoqB5DGgOf/uDnv/4Najie/ly8VClT12DqcH3HmB/vAB+7E5srC0juXOnSCf/ICS2FeKVg0dax4jXErjzzrF9XQw21hOuvZq2l4uMxA3XD1sDGNrEGo8nEHBoIVR3CUgDxyEo78IDAnL0jtXFF/ipRaCMNsBNcVTJz7y3g6nhCcnEsocWxuTx1DbS+sZpWiFgzGQMv12SYyeQUSAEkPqNY+RQ5TketRMkzzPdQAO5Td0MKEIjU1Z4zxZDuHnkmRlIlTBMDcYDbGi1opEb7IJx0APCdADt30GqdaY8c8tTgEBf0DpqZmxjDIlBSgUsey9Eo44KhYHIrOnTzhGBzXQ3hNg01CamcIODRZBOP2KwigrBzuM+D3EBmeKqarCGG41x/Jhh5Yy0jbttnXJzqD5iQt39gRyiH2CQp1j6Ctt16bs74fH2oTX6Wlwd714ASfQ5dg06bMwU3pumDvDzYg/xTnkPB5Tq/eR03oI0qxoxwxqlTr70yOjNGFmZc7XKBBcFmfuqSeYBSrhdCFBs5FBDq87vNdVwnNAOuIqsSImS4TdaCB8MKRB7I6jqM9ApMUjKu8A5uCSeOE/TwLlidP4oLXarK3MpwFyIXmswcnhxWoFLQf0yY0KY5JSMMGItJJThgXlXghvJdsvOCKQ6BmQtRoJhBHZx2V0tVTSvg61ff2zR2gRHJsX3XMWzbAqkGGdkcB2xPfaEKYyWOqwEEdQPDTa1xsmBKSwGnslRjKuyhb0wo4DAbsgnNTFV7ukGUBnLhOYuXUw5//uvfAriWmqnnATMj0DSF0MErIETfoyF44I+KFXBoyyZE0B9Tv2trrZHn0blM/Ua6Dk+zNL6Hdxu159A24sxHvOkqmYCk5UUEHVrd0Ayn0c3ok0fJAubLzrkug8RIniPO8YdX9hpzDYM5RdPUnACzcIPXkXiy1R1qtLyZIs3r7fPnWlXKY8VyLq4nWoVu3VJ6RlCVMqclT4jrSveaie9MtJHb13kdhgvUeMal2liyVaG7YykSBgILO2PqGhapIGIYvERDVk4ZEyFsDknSiwsmnRVKDA2ctO5+N6AEd1HO1JgdJ2DZRapj10BipwNddTqkawCxPFVXyjrgbdJIZB7AR+reARyrvvnUB7W8FObq7JHv5BQQ5iVw0JNM/4BPgpDbjGfhCAkVeO8cxHQwLpROnjP36DCo3Q5hQjFxsXA2VkdIjGceeoEkhzBOvGpOjn/6nA4UEhW60Z0kBJMDvyqhmcT9ZDWhVoY2BOo55qib4PmjjXeAl2YclzgSpaef//LfGsRQG8evvXVm4VcUbFB8xAv4Ya+OnB3B95rmFEfPQpZ8NDuW4rjmIwsJptlyJQEtiJ5tijLCcmEc3Ek0QOlAHYDoWoZr+n3m1nf5YICQjzQg+J3BKTWmKs38qWGWscT0rDQkJDPUMmpA7XcJ2RkXBsO0dikrIMGrtPqCOeIC4xqsJ3gvmDjGOJPruH7ssXgZrOZhBOEoGNyQRrGJ+4neXsbRMElu2yOcmA3vb4xFg0bZXFrhYZKQu8OMA3qoGkqTdndjxwrDNIV9iIJOSy5uLKpBPrKThoTDA83Vou5TTxDm92lmVpho80VOvyZILpesS1HhRAKjTWBO5HwIl/wwch7VepQdnW15zov4d3NDrnLnWdfh2pn3C/J29be2fs3OvHtbvxxn3vbWL8iZ9xCAtUGLV3OTZfrqQt7hbECrG7yTzAQTZVKtrgknKvoJTejsIgTX22Fwaf6p/Y+OiYdljYhE44TBNnWEoTWourkgFgZbW/C/5mo+bUhNYKuo0DqKeYH/KYqvH964egk8tPzGYYeTd3zw5/PkbLAHeFxiG1nZgSXESmWQjx+Or66X7FBHD3DLBVpSEcXHqUyOFdPHg62t435kFmZ7ERr3Zc6MWD/FO2/gQPH6TalmhI5BQQEaVx8Rq0ypq8jvZpAtwISjoePtBhLuzyPhucD0N/gMxIE8ZeLTzjQcvjTDA6jneVbzgIibSvg9akw2LDeT1CypFC9n0c7hRXTepQXvmu87h28v34KKXU4kRAgXUiPEtJxEO9FmO2BYM3WGkZuHF4Z8PUVqKlK4FzHHHmnBN8/6PQhYbLdZyE5X1GdV96ZNdEnHXIyvave2RtE+LKNZqQaiavmv4H9gIADadQhrxREH8pkwCrYewDxQx6s6zPqZW2MXCr0ounkuuDmK6uVtRyC7AORGTHH7pFsQJbw4SLh/PwjPPXSRthg862NnF4XDemy4AFcf3xqErAYRq3UQaiMGFcNKW1GldbxjI4zRhQoGkYKH9Z7y8XBOgu6j6DnY3kYZ7cs+CjP3HqKcsP3gEndBHQATRc0gF7w00A7V+LDIg2bgwdqb/ivyprec6YZ4FnuEre1pke/TflrhTLQ1Asddo8R4oGxR0yPj6Nt7QBpuiLYXYqlHYIlDwE2qafj2gCyyN99faOa1TRab9OzH0F602PZjTT/Xt3LcrHZgm1jAiZw43uRDcLEJ+NC9LeRD21vIhx5uNTQBuzJ1D7U8j0K7l9ntdGu5HITvt3D6cDGSeHRZ9uqfvQDJAo++9knxRUjNvhoYDR+TTucArx0z0dWyUgnD97LMMxoZus7xpaKf//JfZFjxzASmpeyMZSD/wNtTqtI2xRLzb2jonnmCIhx3jHH3+FKOtwWhxzM1bs4uPklFWLdmPxB6B6IzKSdKVuMJGkHFGAKzXz3bPxhVGT4qRfbBCFm/3tWInYNnqQSYUXwoH8AMD+I4f6IuaVmhh0kxYHQcYsAtwwL/DDPMDGImVGDSyviIJbMkM8gxb1AZj/IZE6lUBII6uty82NHtduF/X3xBvjXmWLIPSZtZCqXPYL/42Bn0jCdUqZkZ1wuMznFxEkgnJ8TIJTgI3lILPu6QR9BDXfA4yF3x83/8Jzn8Tk4br6A1B7x+6px9Mym9ubv3HGXrDbP+LzDjrmLO+QuRn2Mu/hWMijiXTscKmYSJM66kANTCVY+TawuhJxv2bCqlfcrJ+vVHI8hqiOEVZ3j7nraW4gmYC5/Qgg55xkGUh/L35Akt2ViqGXlP3oDbxz+FJsn7I/G+2+3iv1C10/FP0HU65D15gmqqCS2KSVWYWwOKnclTS1Mpw3tY9fNTbtlr8rU9Hzh6xZ6/qXiWEsUq6w0M4lLLCXhbupj6x78B87V/eg3uxUgFu2DmXaR2iH2WjbqwP3GIbx0VaChueQR0jVcfuCTOeGnMviN4t812ulcNM56QJvj7E3QCkcJ8DANfcPsIZ6zFO7f1vROHZQyEeSPVKYxkegQZoIYOXcgOJ1Sb0BlzPWXEBc24ti5UVCVdv0+MPGBg/MHwiZkTgdB6Z+SFoZSnQGJjRXP02EJgmuvk9yhimj5eomdeh5DZNBGeTT9VQI5GLvUr8YYNJ1Kemk7sJSVkR128wsfO8OWxwNKuiaFMjGciTKTm2TfbHdrsbV+l4gzEJfMokvHsgOQAt7CMXQJW8H1zawDhox/vBZsC33EHBnz8guzW+XNM6htiX/Q7EnCanAS3XE6cuRPzb0+DhDOQdrwR3xRbK09QYCq4hfUV6gKYjaUpVwj8S/ccqN8B7vfNau5bqvseRK0jAZ72k6Plwpi7WUzeG+fkCYB8svdy/4A0legTfz17YVzXFcFcNVqfgBeTKb913OLR7EicfPvsgGy6OW7u8PQEJ98sh81zYsTjIfjudakYzUEATXGbKZZWIoVY/Fb8u2K5PAMXskjhjUObxAhfvrQL57NBOQdzNjNGbTvnusNOxz8F6S18+GylifVKpNBVzvwK7VmVuLunZGnCgMBn7SkKvsM6NfTno+jE4dUxUFC6TCTCVKpT7nzdTCRqVtheIb4iIMCdI2HX0xCWQ+MJ+d//ISd7r+cwjsVBA7eamzuu3nGzWotOWh9a4+EHYL6A0hOHn5dGg/DUCzxLyczT77yesYpw2xNFGlowU4hSOQeDGIdYORuwAqKfDUex43lSx/zoENXquvHrazffKwlZtAx/sMfQCTHmNKQvkxUBIhhOjkJjAaz0iDPwlCRKwo3DLDN8ANiWklXJMDJFMXPZ1N7ncKu8Y850GB1OURM2U6m5k9zCdEI6/pYpngkojLnb0yvvmhree2IucJ7UbLx113QkXfCpCaOxp5/PF2bvLprO3CVQ6A6uIHjF11Vn54A1eybXMdhcGbX7vWctxqX7BGJm7z55sgHA2Rf4jsQuvn57chQlSY3tOX6N8SM+45EP0Do5AlWsbidFwL9rRm24H5oknHThV3HTCEp+MZ+F0W9Mo0hg4nY8jLX72TiruxgNfHNXNPkesjT4OUDIO2lAQ+66EDazS+odz9OTjSBg04MG66Xw1VCTY8PycvQbxXiSGy4FmM24DdsBcItyRtARTe6eHL492fiaSIh0NvH3gNpSEi4mTPFyQdct2bZ+3vJZLVhbATcogT0BhhEI0JwXbveN7I2CxA0Eci8Jet2u2cNKw61v/ew1RLPMNb7KYHzSFmX+yBQkw4M1+hfyDU1Op1SlGjOZ0pKj6D+DqtAYiMO8OTl0FbuJrZgZ1YKc9c1bvP1e32t+Tv7SLuQLArnOzMA2/il4e9JY/IYO79irkGSomDk1kwkVY9gIIHwFBzUHxp9WidkLCC907d+arIQJ/AED2JTb0LW0RRivNQO92cpAcK390Iumb9hQ85I136FoY3oD2/y+yjL/tDZuuCu0RdPsW15+Vw3hNWGpeSnVrG415uWkGuJahm39D9uBU1K8G+dDtFTs8oCpHMOl9pk648kV09+Ex5L15gZGqrW8CU2zC0bAAd9pvjROC271+UMHB2m+/nHzeRhnL+oq6I6yNj5a8IUhvziFlyM7X+taWT3fKI4ynjDrebZmrN1v974nZ/d6W1Ec+GiusZab3z9/8uzF/jMAxm4TsP73tnpbGCAjdZlTEYzUfMq9beEK0tysH35fP/y+fvh9/fD7+uH39cPv64ff1w+/rx9+Xz/8/ukSy68ffl/2GMz64ff1w+/zeFw//L5++H0uK/v64ff1w+/rh9/XD7//Kh+3WD/8vn74fRn7XD/8vn74ff3w+2f9sM764ff1w+/rh9/XD7+vH35fP/y+fvh99elzKyJdP/x+8ye11g+/rx9+Xz/8vn74ff3w+/rh9/XD7+uH39cPv68ffl8//L5++P2X5htbP/y+fvh9/fD7+uH39cPv64ffP6qN6lfy8HuQfmqzyCgXQcZRk93xsPUc/Ns4mkD2x53D6OICRnkNudWg+KcKc3Qdvo2jM6o4BKdj4sjYJTqEfFenDNLYPTE3J7oHMHxs9jxeLmzly4RMjabFLhL6yrphgkrITACpvexzfbnJBajoFPJj0alJbRYk0cKyiyijYlxhAq7I9HlpXuaYNBM7nmJiR/tHkMULchbWEDYzPpppwH9hUgsbXFyYpJGY9s/UN5+WtrCIdbVh+d5eXl7+H2FYO+w=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-2",custom_edit_url:null},y=void 0,f={},j=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Draft Document"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/draftdocument",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Unique identifier for this widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Specify the hint for widgets. This parameter is optional and is not applicable to the following widgets: checkbox, radio button, dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options":{\n "hint": "Provide signature"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp",\n "hint": "Provide stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials",\n "hint": "Provide initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide email",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide name",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide job title",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide company",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12,\n "min_date": "",\n "max_date": "",\n "readonly": false,\n "signing_date": false,\n "hint": "Provide date"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"min_date:"})," Provide the minimum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"max_date:"})," Provide the maximum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"signing_date"}),": If signing_date is set to true, the signing date is shown to the signer during signing. You may set either signing_date or default, but not both. Using both is not supported."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio Button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image",\n "hint": "Provide image"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"14",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Provide number",\n "formula": "",\n "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,s.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"decimalplaces:"})," Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"15",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"cells"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "cells",\n "page": 1,\n "x": 100,\n "y": 100,\n "w": 114,\n "h": 50,\n "options": {\n "name": "cells",\n "required": true,\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"cell_count:"})," Specify the number of cells that should be returned to the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"16",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"attachments"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "attachments",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "attachment widget",\n "hint": "Provide files"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,s.jsx)(n.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "required": true,\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "response": "04/15/2024",\n "format": "mm/dd/yyyy",\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "required": true,\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(x.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(h(),{...t(57958)}),"\n",(0,s.jsx)(u(),{...t(17964)})]})}function w(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}},57958(e){e.exports=JSON.parse('{"title":"Body","body":{"content":{"application/json":{"schema":{"required":["file","title"],"type":"object","properties":{"file":{"type":"string","format":"base64","example":"base64 encoded pdf"},"file_password":{"type":"string","format":"string","example":""},"title":{"type":"string","format":"string","example":"sample document"},"note":{"type":"string","format":"string","example":"sample Note"},"description":{"type":"string","format":"string","example":"sample Description"},"timeToCompleteDays":{"type":"number","description":"time to complete days is used to calculate expiry date of your document","format":"number","example":15},"signers":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","format":"string","example":"ceo"},"email":{"type":"string","format":"string","example":"joebee@example.com"},"name":{"type":"string","format":"string","example":"joe bee"},"phone":{"type":"string","format":"string","example":"123121312"},"company":{"type":"string","format":"string","example":"opensign"},"job_title":{"type":"string","format":"string","example":"dev"},"signer_role":{"type":"string","format":"string","description":"Specifies the role of the recipient in the signing process. Allowed values:\\n- **signer** (default): Must have at least one signature widget.\\n- **viewer**: Receives the document to view only; must have no widgets.\\n- **approver**: Reviews and approves the document; no signature widget required.\\n","enum":["signer","viewer","approver"],"example":"signer"},"access_code":{"type":"string","format":"string","description":"when set, this numeric access code is required for the signer to access and sign the document.","example":"123456"},"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Allowed values include signature, stamp, initials, email, name, job title, company, date, textbox, checkbox, dropdown, radio button, image, number, cells, attachments.","format":"string","example":"signature"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":244},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":71},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":38},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":46}},"title":"createdocument_body_widgets"}}},"title":"createdocument_body_signers"}},"folderId":{"type":"string","example":""},"send_email":{"type":"boolean","description":"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \\"true\\". If the value of this parameter is \\"true\\" and no \'email_subject\'/\'email_body\' parameters are specified default email templates will be used. \\n","example":true},"email_subject":{"type":"string","description":"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.","example":"{{sender_name}} has requested you to sign {{document_title}}"},"email_body":{"type":"string","description":"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.","example":"

Hi {{receiver_name}},

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

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

Sign here

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

Thanks,
Team OpenSign\u2122

"},"sendInOrder":{"type":"boolean","description":"If set to \'true\', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to \'true\'.","example":true},"send_in_order_strict":{"type":"boolean","description":"When set to \'true\', each signer is blocked from accessing the document until all preceding signers have completed their action. Enforces strict sequential signing. Only applies when \'sendInOrder\' is also \'true\'. Defaults to \'false\'.","example":false},"allow_offline_sign":{"type":"boolean","description":"If set to \'true\', signers can submit a copy of this document signed using an external tool for owner review. Defaults to \'false\'.","example":false},"hide_signer_signing_links":{"type":"boolean","description":"If set to \'true\', signer signing links are hidden in the draft document response. Defaults to \'false\'.","example":false},"enableOTP":{"type":"boolean","description":"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.","example":false},"enableTour":{"type":"boolean","description":"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.","example":false},"redirect_url":{"type":"string","description":"Specifies the URL where the signer will be redirected upon completing the document signing process.","example":""},"sender_name":{"type":"string","description":"The name of the person or organization on whose behalf the email is being sent.","example":"opensign\u2122"},"sender_email":{"type":"string","description":"The email address of the person or organization that users can reply to.","example":"mailer@opensignlabs.com"},"allow_modifications":{"type":"boolean","description":"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.","example":false},"auto_reminder":{"type":"boolean","description":"Set to true to enable automatic reminders. Set to false to disable them (default behavior).","example":false},"remind_once_in_every":{"type":"number","description":"Number of days between reminders. This is only applicable when auto_reminder is set to true.","example":5},"merge_certificate":{"type":"boolean","description":"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\\n\\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\\n\\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\\n","example":false},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed.\\n"},"cc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"cc (carbon copy): Users added here will receive a notification email once the document is completed.\\n"},"prefill":{"type":"object","description":"You can provide widgets which can embed before sending to signer","properties":{"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","format":"string","example":"textbox"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":100},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":30},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":40},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":80},"options":{"type":"object","properties":{"name":{"type":"string","example":"textbox"},"response":{"type":"string","example":"joe"},"color":{"type":"string","example":"red"},"fontsize":{"type":"number","example":12}}}}}}},"title":"prefill"}},"title":"draftdocument_body"}}},"required":true}}')},17964(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Document created successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"document_id":{"type":"string","format":"string","example":"hji2zxcv2P"},"url":{"type":"string","format":"string","example":"https://url-to-send-document.com"}},"title":"inline_draft_doc_res_200_1"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/851f8f65.e97dbd53.js b/assets/js/851f8f65.e97dbd53.js deleted file mode 100644 index a565b13e4..000000000 --- a/assets/js/851f8f65.e97dbd53.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[9070],{11184(e,n,t){t.r(n),t.d(n,{assets:()=>f,contentTitle:()=>y,default:()=>w,frontMatter:()=>g,metadata:()=>i,toc:()=>j});const i=JSON.parse('{"id":"API-docs/v1.1/draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","source":"@site/docs/API-docs/v1.1/draftdocument.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/draftdocument","permalink":"/docs/API-docs/v1.1/draftdocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","sidebar_label":"Draft Document","hide_title":true,"hide_table_of_contents":true,"api":"eJztPdlyHDeSv4Kt2AhJPdXVh0hJ5moUQ0saWzseiSFR6/CSmh50FbobYhVQBlBs9jA6Yh7mD/ZpX+fT/CUbmQDq6oOHaA/tbT9YbBSORCIzkcgDuAwMnerg4CR4JeMiY8Lo4FMYJEzHiueGSxEcBMczRl4pOjHEVyKHR28ITVM516TQTGliJJkywRQ1jAg2J4nvjowXJFfynCdcTElCDSVzbmaEkjHV7MkeYSKWCUvIhKcsOhWn4pjnB+RjnkqakIUsFDl69ceyPxgIyk46nVdsXEzJxzedzqeHM2NyfdDr0TyPZM6E5lOR0rGOYpn1EqiYJ5NHIZnPmGLQK4mpIIxqni4ITRIy58mUGR0SM2OCxDJfkFhKlXBBDdMhyemUEVFkY6Z0SKhISCYVI1wQShSjyaJrZLfQjPznh3dvyUSqjJqIHKWFDsvhEq5YbNKF7d7MWDmrB9pjQxvFxTQkGT0DfHFDfix4fAbT1kwk8C80PDx6g7jqdD4UeS6VYQn53k7hoNOBL1+zVM4JVQzrxzLLpCA5VTRjBhdsRg1+VuzHgiuWuGVJU4+Lg1PRJZ2OoBk76HTIR8F/LBjhCROGTzhTMEtiZly7BpGtbxY51n8jEh4D8hAAKCVy0qwKSIWqH3IWQ5e2ag3VRAoyn/F4hjicU7v+eUpjOy3FdM5iw89Zs+OLkCyg41dMSA/BTCr+NykMTXH5zpkyPKZpfZkBQKiqDVUG0J9LLowvdSOQH9xywmrjIjo6BNASQG7GBX7RjJzTtGDaQTUPyQyges9yxTQyh+sXEC8SMmN8Ots4Hk0+F9o0OiaFBjDrULix/KoiehmibUJTzQifNHCZ0TNWG41IZHqaRuTrBUnYhBapCQkHCjWqYBF5Kw2heZ7ymI5ThjQAzEZNoVgXV9mRT9QknyOUAUwTShI+mTAFzAwfsQvXxkMHdFkJDeQ0M6OCSNFa6FimUq2SEBY38UhiKQwTJiKH55SnCLydrCZcxGmRMDJOaXwWknFasJAollhGXzAQdKHlD6xCqHY4R/wQzVKgQikAfiHd8FwT7aBKInIMjFLyH3z0qMZBuK5j1XH5RMLIgALPkoRllKchIi4kn+WYGG5SFgKD51QsQpCwLCSGXZixvAhJPGPxGf6laMIlGRfGSGEnliiZJ3IuHC4nUhjN/7aGI/2Xm2N0GJK9kDwJybOQDPohGQxDMtgLyeBJSAbPQjLsh2Q4DMlwLyTDJxas4bPQbxEewXUABkOLZfPrwu6MJ2wEDUcwtxHVhimuz0Bck+9hz2ECgEtCKy7ZhQHhh9KITwVLqh2QazLjScIEmSiZEcVinnOUJlYalF2HAA9RMCmhyaRI0wU555rXcFB2KucC8IYjckXe5Ux84FNBaBzLAtYYMWyRiuisllykCwD1mNFM48xfC8NUrrhmIKqFLjEgTEVbdgOEsroAuM5KiqYE2ryam1antjKwg37HNcpc2Pp0uZvOG7vpICKdTinnoOyvf/3rqbg8FYScBiD2ToMDchqUVU6D0H6D3Qy+DdzvC/jxePjU/VzAzyfDZ+7nHKsO9tzPGfwc+qaOuU6DAxwXK3Bh7MhOvpIaBFBpeSqWDthTMcRZGJrlW2YAn39e6EkJvt+loBC2l9B/AA5chWfDjG2Nldk+htlywQ2nqd48YV/jHs25BdL6aVeVVma+BzNHWbZ52vj5Hs25Dg98wT3UfsI9t/bJ7wYIxXALitp9bpLB0Aq1oxVM7kdOhdmMSDuFe4PHGjh3hcZWlzfH4hPAImynx7CdbkZluePeI3y2YborpK7r9+aYfRqhEozayWa8ugr3CKtNiO4Kp6u93hyjzwCjoOZtRid8vUe4rIEDH5zObL/197qD/e6wP9xr4BOsE7ZClnWTpLtYLL5sLTIuRhYOaFSrn9GL9R/AaAKqY7kS5RfQYLiYls2aX1dX3dZrLSQonA4ToHP646dVesFIhbrzqm0Bj/5VLXfgwb/9efzPcAof+wMqS5zWXB1HSvNP/QhtZEIXD7TtyjctT15Qv60bWzDxE8CBprB4JnnsgIc6/rw1BmtPBDjo4qL2kqRXW1QoTJJulnVbhfCzizRQK8yyKEmiVs0VQrGFGUmSkKwWry1PEpJl2YZiW94o7mXZ6iyiLHOwOex52ltZ54wLnhVwQgKrmj2gQ0U4ZDj0Zm4tuSCdzg8//PBD989/7r561en4NXRDOCquGTLsCPTijkaoE32nc0DeTEi9CI0J1oyDUqA8GDqjqq0wk3Phz0N4alQkKcCe6KtaY1JGF9gZ42bGVHMcqSqShdMjHLbG0swi8hEPl/C3P4SVhyU8SH0FgtOdjDfLTlfhlxKflZRsDrxVtG4WTQ3ZuqIWecGUr9ebFJsWKVXsAqx/mkuxIhNvswfebH9riUVPy5WlBe2KzrLLvKGDPHznzuCPSvNiay7Q2yGJC23QJDFlFySnxjAlsLNzmvKEIn90sYBd0CwH00rvL6enye/+vYeGXbCdGmtRSPiUgz2+95eTw+5/f1pTo8hzpmKqGUkZjKRDwkwckZMZS/PKJTCfz6P5Yx3PpEytP+CzVmxi/z+S488jBDePqM4frZupJYaaIRWIpW1HReasYYxq4luuMaXi0iDXDPqowTlLxRYVztW4R3pHCyT4aK3S8PkEtn5UboF4WfW3BJlzGnyqtns0nrLkirafrsGewA0pHbN09dPNWSulC1k4jvbOguZUHUXX8OZUodIejNPph7WP9KL10X5bruFTi5A6m/rd3rOnXwGScl1uJA101ls7lwE6fgRj6EsaM+IbgKPOS4Ev5YISsOuxgbeP4tpdMQTUI1ixdNf40a4YobEwKzu50xW832lS9upR5jfyOr6gJfg/KzVhywhOV9g8Ajh5Ng9wKgZohfTWyy3nE1fjHsmKFkjb2fg2UqSxM99mS70VA/pp1RlwzfYKVe3GWjKf3sx9EXlnTeq+EZjb45jloGl9MWuWIF97h0KrsbWgf40W9M2UV7ez3yPqWwPWz0yBrt5d7z63ItL67H9FhNoA+9rEao3+GZ1usd/g53tEnnV41ps4XI0VY9UALf12R9liocbv2yc86DcmvN+c8JP+LU5cjWG//MDV34KflaHgbF2kdGU7SFjMM5piBAnCPfwCHr3N4csBBjzwUmZ5YepMh2YdFCxeS/BxEdaz+7uQdEPSCUkvJA9D8igi7xlGUsRl1IVTGriysRVckEQW4CaNC5UuyFjBxEPComlELi9/LKgw3CyWS9Ihl5cQvbVcRsCFZ0LObeDFCbiMDYHAqepQlchYrwm0krHuwemr95bNuz5YrOdAe0QeypZI2HoUdSj4ZU9kFqoakcAob0uVzZ5KMdKH6zylC0In4Ka20SDYzAYNRYDiAzIkv39BBsOo3w9J3/5NHvoJDh8hD6OPKWbpNiclfr6Kg/t1Dq5+rhNZ+/1rsXB92FtyMHQxwhgCHPdKha1i7ntoOqkm0zbW1rR6wJndP/VMFmkCu6diplCClfF7pU7f6RwpNuFpWgvfI77I8zSEQ7GUZS5kzAXuwXEGQxW4MBL4xsdydDpjNpEQpgDxg2gYpFWAnx3bbt2NEJBYMWqkIjOqrZ0FMQ0QQ4CkmbGsFTDhwauCJrjwsAMpD+7OIjj8qkncT/YbxL3f3J82EvcmCt5iKIQmOpdCl/5AVn2qUR326ctXjxZtSvKdwnJjvEwV9oNCDAkn5WesLmu40F5Lc1C2w+BezqTUVQ0Xiebkrj5oRrhJBUFuj6IyNORL3V6Dp48bSsSzX9Dt1Vyl/l5vsN/b6vdquUhuflgk5DpLilb1ay0p1qzWdOcU+hKn0JdzxOO7NMwOng4b54nH2zbne2KYrXPUFSbZuzC83upsu84CWufDa9o+fzEb5JeT5V5ljRnfmTWmJbifDv4F1pgvJdEVo8udESW5K4vLOsq8hsllq53liym3DuzPTr37d2OeaZ11vmpog18N69S6v/9l1No2ztRI7jTg//X1u/fz/p++mcrDw8PDtx8+zl5/nB4eHmbwO4qitSa7dWSAw4D+7PKA3BaP6sKGUaIoQnc9NfQAm/dyMf0P2z7c3CY6FUEYyBxytbgUb5LgIEggu8sfBIIQ8cK0+Vomi+DgMnCB/vCnC7yGlr3PGtLDLgMdz1hG4S+PT0gog3yuIAwwxg1yymCBg4NAjj+zGMbIFcBgONPQEmsfXPpaNg0qCJ3OFhwEdl5BGDjPcVlUJpDlySRY+gG3dVWWVF1p/KM8C0E/kDl0y27eQtNlK43uVj29qvWAc8vYsQTDUcoMe0UXutavPYIG7ew9aAOsH7tWJKELDSKk0HYfjGkaFynolewi52pRRj6hclmjihLecqQS3sH+MgxsyEkdJKoUXQRhwA3L6uUbiEDJm69czCRgBkN9b9r2s2Rjxv7gCsCEhQtPsxtD8VkyMma46PlMihu3HwwfD4aDx4Mh9ODCGG/ahzfHQRef5Xh0K0ZI2Dm0d0f72y+l/bo6dpM2DyFngyVePetW2QuhDeuPrmITXx8xT6fsan443pRiWMtscoYbmueMqggz/W6ddNpksXK7j65gqGUYXFw9mQsSy67PXyQPUzYxNi6GxFIJph7V4xzvzeSGe3vLMFhcPb3Fr3J6T2Hx5lfP7ntM/KySYv8VsD5+tgyD2dWwflumpv4Lgd17sqw2+ADtlczvT6OxTBYjL7eWV1X0exXUm8g0YQoUoVV5VYkakDCQgj1qbzVjKVNGxRpB08hkc+nyoI2Dd8LZdOYzhv6eUknH3qsTgPNlWGhdWGkjVI9rUJ5VwU6DCKJGq/ME6vftZDpfF5PphCQPcLyRLlCMP+i534CjB/V0cTA4VwHOHgSsTAzL8hTzp+dgtR6jeTuJSPkfapwlJgEAv2P7ga/eKl7a0EIc0DVqJh8Tp7RG5CUVZQJqMzWQXF6WZIDUsVySy0tYVaZGsO8vl2FVAGM1CnBrtyWKxYyfN1qVRaxqWJbVmlotC8NtbYHb7+sAuJDcQrl+QBldLqMGQbYAR7u9wwFLSjqDJM7VWZcqE670tbG/gmxHAdDJ/xu8P89ffMvXgPK8l794nr/4Hq4ayJnlPYueCReJ5fw5S9OIPNdGSTF90ULB854rX7+Uip1zNkfGxVWtemnjtuwocjD9AIK6WjyuSayKmNMUY2qVjJl3D6EvC4702rBcg9OUGxshjtngeCSgU8XQGYWw0MLg1Qp4JvQDPqdkptjk9w9aOH3wArOKwZn8vEdfuNpvrJFiRs8ZoWJBcOJoUZHKmusmhUIxGadU8Yk7gIYkTxnE/8L5lMbW3Wsx6uE4nlFxpsPnY/UC8pPLvOaf/vFPqOFl+hvxTiVMXUOoQ1y+Na88ADn2ILSxyEjuXGnj4+5REjoKKePx17GOS+MEp/TrUvTrYqyhlvD9VaLVKD6dMnDnuRrY2GXMMxrP7KaBUFW+6RyIRxbagwcE5g+EiQsYKHME6jagGnZqOQh27tE6qY5Z7O+Oj66BSzRQdS2juMxynKXtg7w7PoJbOsrlhhSEEhMetbRRhYAlgJxz6jP5S81+YeM3mfXLOLlYd39G7n6MLlkFKOF6LUSh3dRBwpW34Kx0XF37AkskCwPuVO5S2pHLGnhEKEpEHsviOlR5BSYpmRaYqWSAff2uiRHz1S0bXGijChu76tNG6lkmKCa0rvDksQKVav2HhAltm1MyQbd6SArBAfOqAJtl2SW7yJniEL6yFgWKWdSB6Lh6i2peWfHx/Xfusp9aMoznId8xS0iRI9UgJ5RXqfiVa099rT7oxPfVAILuhkE5zvCaM6WlABEn1ZQKJ0HteRSsq2M2o6mt6kQFuPQwmwfode3Z/6d//LMG10ajyCpgdgSaJBBgcQWEaKi2BA8hy4rlIAFlEyLoj6k/tI8AAB0yzSiTSclI+vo0foQZILqUiy48oQyP0EU8g22rlLc6LFPlnVFBo026vGJD5jBfdsG1qV0f4bP6VuXDe5fsVcGAh1DgaqB5sagzeBW2IVvd4fGANy+SKQ9BK7xACyNHimVcXG+fqvsAjCwFQWFkRg2Pie9KR83rgaxr2vN1VgUrATWec6kebWBV6G4kRcxGXIzYOVPXON7X4qrAJjlmZs6YqMPmkWS3s+rSjzncmNLASStDrgElGCczpqZsFIOFCqmOXQOJnQ501emQrgXEyVRdKOetcVdrofAAOVL1DuA4XbhMEK023PqNZhH5Vs4BYaU6A0qn7R/wSRBydy9MfYSYCszOA50HTmrQcRkDAHe+VEPYuB1cLJyNU7hi68aBXuAqKBgn3DYnLz/LzFcK1zn50f1FNTA5MOcTmkrkJ6dWtu6xQaDe4E0+M9x/cP3A62TH8ddr4c00P/39fzUoMS7aUZdH3bVf8bRKUy1tmmK9V0/OnuCj5tnU07OQhk8WIylGlRxZSzDNllsJaE2oVVOVEU4K4+BeowFKB+oARNtdDP7RTWHSXt/NgwFC7mhA8HIckPdsSlWSlruGXUaDl9jROiHZoTZRAx4lNpAdNYbGM4aX/yQsh2vwpCAPKmNMzVIB6wmmYCZG6JS8jgnbbYvL2mqeBOC7RE9YEoTWSRx8WobBOI5v2yPsmA1fQ4hFw0bZyuWL4zgmD8cpB/RQNZb2csJHB04ZpgnwISo6Lb24sagW+ShOGhoOrx0DPOpsAN86E38TMn8vnU939Run1bnxfsVsDAkDGIyIJwnUsLw5a8Vn8LM5HbZ5EFwg3c5/8CsysA/6/d+y/+Bx/9fjP9jr/4r8B88AWBcHcrU02XSqWys7fEzH9gafJbMO3lSq7TVh30HXhI1GWofgih2GS/tf5fLwQrxe1gjysHZfbFMFbTgbjp8LYmHY78M/zdV81dAt4ERfxHBCxjsG/y0Irx8xsn0JSmj5WufMNrk++8yHf7uIz4dHgMcNFoStHThCLFQKd/vC9tUt9R88ydZwy0XKBRshikeJjEeK6dGw3x8NArswe+vQ+EFmzCq/c0DmHGy25SnAqAWhU1DjgcbVHWKVKXUV+d0MsjWY8DQ02msgYX8VCW8EptLjldLH8oyJX3am9eGNHR5AvcjSSgYE3FbC70FjsvVyO0nN4kJxswgOTi6Diy7Nedd+Pzj5tPwEB1EzkxB0lUuNEFMzCw6CXjsGSzN1jtE0J5eWfEuK1FQkEGq6Ih5pznvng2gQLMN2m7XidEt9VnRv2kQbOuVielW7TxWKPsAy2pVqIKrS/3L+JwYKoFuHeq0w4EA+M0bBIgKYB+p4X0WuvfZr7KPL1gWMVWvZDgHzEWCNoK72trYmTGt9lNZgvxYfdeJDnTB6qQxeWhePVE7dRxiVAUa1mKFayFAVBdQIAsK4nlpYz0nFEmUEjVeAB6g5Dvf2UMV6OkBd5PEz3Ob3niyRiCuXeRA03eIYRtl27n6Zr7Lpqtz5335D/reW+80RT+VDclaVujPEFTWdA54KS2N8wyLeNohvNE5vsE27IVs22BKQdabP/bUWR9dkvXXJfaybLtabIZwV4voWhdqRfo0E8Fpsk/8hxBr4/3Ef+X+vj/z/rN9QoB2uqx4qNRh13VLVdROo1FnQWT+B0OZiIlHiO0FV3jwNGzLuGCvHHpbGMisvfu50akRVtup0SkluGQMsVu8KRXI5Z2pS2NukJym7wOuwoRnL8FsVosNoBnatFLK0DJuijRMTgMFx51xDMc3pmKccNA6biGlZtFJadAT3e/sgnwfKpjifsxQUldIiD9e4eaV6LtXZBIKFwII2htRvsK4xMaMitu4fu32iGwPMLNV929oogJpb2KQwCvgyo4JOUWKEdQ4kCUtBgGqi5Bi8o1qmheV7Q3kqlY0PxglhXgIi8fVFDp/w7AbbjmIz4KJz5wTUoXXC2p3RvZUxBn93DrBwMM8aSQqRSnjWAvzmRQpJ08b6suGIWIcRmhtFhQZd3YUkuzUoEeb8c0w7Q+hHzWCFv+PizF7g3SUnJV19z8aaG9a8IKwtCR4123zDzbfFGB5ukJobqRZV6yk3s2KMOk69k/KH7ekb/zZKTYO5fjb9B2tQ1b3DozeoIj8iP/39f8h3jCpBZnJuqTUuFEsX1TMs+EgJrrxFW6nhogcYtg3AeGyJz+12HoPfz6hBq/pbNgf3hWUpm75wVIxTHpNjH/UF1xW+xHNgLRKscaGRTT8GtzwluW2dcnEWkUOxQEditfdBObZrTAP329qTMhRC1931+H7MqIIIXVeapedM17wkLOE22EHJYmpHqwPjJtfMxoa5HSYJyVsZ2eAmq8CxBk6MMqDW0glvv6xJ4m5kSjdDpJhI8OIAfUDwJFD1H7ZM+bjzrhT57G6PjtB1Uy6J5UQ347LU+j9a2ndT3qJfBQZsvvJDc+7I6cSTJWnevHdzsrbGEVQm8Pjmtmua87WOZHhrRb+bfGDqnMf+zL6Bo3tYuReEQcpj5iw1bv86/OboO3L+OOoHYe1Mcw3m7n335uXrtx9eAzAgSC3CBlE/6qNBWWqTUVEbqfmMUntrq2Xa7B5d2j26tHt0affo0u7Rpd2jS7tHl3aPLu0eXdo9uvTL3Ui4e3Rp00WMu0eXdo8ureJx9+jS7tGllYuhdo8u7R5d2j26tHt06Td5v97u0aXdo0ubxOfu0aXdo0u7R5fu9d2eu0eXdo8u7R5d2j26tHt0affo0u7Rpe27z62IdPfo0s1v9d09urR7dGn36NLu0aXdo0u7R5d2jy7tHl3aPbq0e3Rp9+jSr8gptHt0affo0u7Rpd2jS7tHl3aPLt2pceY38uhSLeG6l6eUi9rVNPYakJPWU0yfwmAG14QcnASXlzDKR8jih+IfC8wzP/kUBudUcYjKxhtGQn8jBmR4nzG4MOGlTRnoHsPwoeV5zKprXawCV3rYFodI6Fvr1m8yOXr34RjS091V8plM8AojOoeMcDq36fm1tHEsuwxSKqYFppwHts+lveh01rwB5AxvAHF/1PLW4b6LCsLm1SB2GvB/mNTaBpeX9nYRvGDC1refNrZwiPW1Yfk+LZfL/wO+Lapg","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Self Sign","permalink":"/docs/API-docs/v1.1/selfsign"},"next":{"title":"Create Document","permalink":"/docs/API-docs/v1.1/createdocument"}}');var s=t(74848),r=t(28453),o=t(57742),l=t.n(o),a=t(78178),d=t.n(a),c=t(19624),h=t.n(c),p=t(96226),u=t.n(p),m=(t(77675),t(19365),t(51107)),x=t(21312);const g={id:"draftdocument",title:"Draft Document",description:"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztPdlyHDeSv4Kt2AhJPdXVh0hJ5moUQ0saWzseiSFR6/CSmh50FbobYhVQBlBs9jA6Yh7mD/ZpX+fT/CUbmQDq6oOHaA/tbT9YbBSORCIzkcgDuAwMnerg4CR4JeMiY8Lo4FMYJEzHiueGSxEcBMczRl4pOjHEVyKHR28ITVM516TQTGliJJkywRQ1jAg2J4nvjowXJFfynCdcTElCDSVzbmaEkjHV7MkeYSKWCUvIhKcsOhWn4pjnB+RjnkqakIUsFDl69ceyPxgIyk46nVdsXEzJxzedzqeHM2NyfdDr0TyPZM6E5lOR0rGOYpn1EqiYJ5NHIZnPmGLQK4mpIIxqni4ITRIy58mUGR0SM2OCxDJfkFhKlXBBDdMhyemUEVFkY6Z0SKhISCYVI1wQShSjyaJrZLfQjPznh3dvyUSqjJqIHKWFDsvhEq5YbNKF7d7MWDmrB9pjQxvFxTQkGT0DfHFDfix4fAbT1kwk8C80PDx6g7jqdD4UeS6VYQn53k7hoNOBL1+zVM4JVQzrxzLLpCA5VTRjBhdsRg1+VuzHgiuWuGVJU4+Lg1PRJZ2OoBk76HTIR8F/LBjhCROGTzhTMEtiZly7BpGtbxY51n8jEh4D8hAAKCVy0qwKSIWqH3IWQ5e2ag3VRAoyn/F4hjicU7v+eUpjOy3FdM5iw89Zs+OLkCyg41dMSA/BTCr+NykMTXH5zpkyPKZpfZkBQKiqDVUG0J9LLowvdSOQH9xywmrjIjo6BNASQG7GBX7RjJzTtGDaQTUPyQyges9yxTQyh+sXEC8SMmN8Ots4Hk0+F9o0OiaFBjDrULix/KoiehmibUJTzQifNHCZ0TNWG41IZHqaRuTrBUnYhBapCQkHCjWqYBF5Kw2heZ7ymI5ThjQAzEZNoVgXV9mRT9QknyOUAUwTShI+mTAFzAwfsQvXxkMHdFkJDeQ0M6OCSNFa6FimUq2SEBY38UhiKQwTJiKH55SnCLydrCZcxGmRMDJOaXwWknFasJAollhGXzAQdKHlD6xCqHY4R/wQzVKgQikAfiHd8FwT7aBKInIMjFLyH3z0qMZBuK5j1XH5RMLIgALPkoRllKchIi4kn+WYGG5SFgKD51QsQpCwLCSGXZixvAhJPGPxGf6laMIlGRfGSGEnliiZJ3IuHC4nUhjN/7aGI/2Xm2N0GJK9kDwJybOQDPohGQxDMtgLyeBJSAbPQjLsh2Q4DMlwLyTDJxas4bPQbxEewXUABkOLZfPrwu6MJ2wEDUcwtxHVhimuz0Bck+9hz2ECgEtCKy7ZhQHhh9KITwVLqh2QazLjScIEmSiZEcVinnOUJlYalF2HAA9RMCmhyaRI0wU555rXcFB2KucC8IYjckXe5Ux84FNBaBzLAtYYMWyRiuisllykCwD1mNFM48xfC8NUrrhmIKqFLjEgTEVbdgOEsroAuM5KiqYE2ryam1antjKwg37HNcpc2Pp0uZvOG7vpICKdTinnoOyvf/3rqbg8FYScBiD2ToMDchqUVU6D0H6D3Qy+DdzvC/jxePjU/VzAzyfDZ+7nHKsO9tzPGfwc+qaOuU6DAxwXK3Bh7MhOvpIaBFBpeSqWDthTMcRZGJrlW2YAn39e6EkJvt+loBC2l9B/AA5chWfDjG2Nldk+htlywQ2nqd48YV/jHs25BdL6aVeVVma+BzNHWbZ52vj5Hs25Dg98wT3UfsI9t/bJ7wYIxXALitp9bpLB0Aq1oxVM7kdOhdmMSDuFe4PHGjh3hcZWlzfH4hPAImynx7CdbkZluePeI3y2YborpK7r9+aYfRqhEozayWa8ugr3CKtNiO4Kp6u93hyjzwCjoOZtRid8vUe4rIEDH5zObL/197qD/e6wP9xr4BOsE7ZClnWTpLtYLL5sLTIuRhYOaFSrn9GL9R/AaAKqY7kS5RfQYLiYls2aX1dX3dZrLSQonA4ToHP646dVesFIhbrzqm0Bj/5VLXfgwb/9efzPcAof+wMqS5zWXB1HSvNP/QhtZEIXD7TtyjctT15Qv60bWzDxE8CBprB4JnnsgIc6/rw1BmtPBDjo4qL2kqRXW1QoTJJulnVbhfCzizRQK8yyKEmiVs0VQrGFGUmSkKwWry1PEpJl2YZiW94o7mXZ6iyiLHOwOex52ltZ54wLnhVwQgKrmj2gQ0U4ZDj0Zm4tuSCdzg8//PBD989/7r561en4NXRDOCquGTLsCPTijkaoE32nc0DeTEi9CI0J1oyDUqA8GDqjqq0wk3Phz0N4alQkKcCe6KtaY1JGF9gZ42bGVHMcqSqShdMjHLbG0swi8hEPl/C3P4SVhyU8SH0FgtOdjDfLTlfhlxKflZRsDrxVtG4WTQ3ZuqIWecGUr9ebFJsWKVXsAqx/mkuxIhNvswfebH9riUVPy5WlBe2KzrLLvKGDPHznzuCPSvNiay7Q2yGJC23QJDFlFySnxjAlsLNzmvKEIn90sYBd0CwH00rvL6enye/+vYeGXbCdGmtRSPiUgz2+95eTw+5/f1pTo8hzpmKqGUkZjKRDwkwckZMZS/PKJTCfz6P5Yx3PpEytP+CzVmxi/z+S488jBDePqM4frZupJYaaIRWIpW1HReasYYxq4luuMaXi0iDXDPqowTlLxRYVztW4R3pHCyT4aK3S8PkEtn5UboF4WfW3BJlzGnyqtns0nrLkirafrsGewA0pHbN09dPNWSulC1k4jvbOguZUHUXX8OZUodIejNPph7WP9KL10X5bruFTi5A6m/rd3rOnXwGScl1uJA101ls7lwE6fgRj6EsaM+IbgKPOS4Ev5YISsOuxgbeP4tpdMQTUI1ixdNf40a4YobEwKzu50xW832lS9upR5jfyOr6gJfg/KzVhywhOV9g8Ajh5Ng9wKgZohfTWyy3nE1fjHsmKFkjb2fg2UqSxM99mS70VA/pp1RlwzfYKVe3GWjKf3sx9EXlnTeq+EZjb45jloGl9MWuWIF97h0KrsbWgf40W9M2UV7ez3yPqWwPWz0yBrt5d7z63ItL67H9FhNoA+9rEao3+GZ1usd/g53tEnnV41ps4XI0VY9UALf12R9liocbv2yc86DcmvN+c8JP+LU5cjWG//MDV34KflaHgbF2kdGU7SFjMM5piBAnCPfwCHr3N4csBBjzwUmZ5YepMh2YdFCxeS/BxEdaz+7uQdEPSCUkvJA9D8igi7xlGUsRl1IVTGriysRVckEQW4CaNC5UuyFjBxEPComlELi9/LKgw3CyWS9Ihl5cQvbVcRsCFZ0LObeDFCbiMDYHAqepQlchYrwm0krHuwemr95bNuz5YrOdAe0QeypZI2HoUdSj4ZU9kFqoakcAob0uVzZ5KMdKH6zylC0In4Ka20SDYzAYNRYDiAzIkv39BBsOo3w9J3/5NHvoJDh8hD6OPKWbpNiclfr6Kg/t1Dq5+rhNZ+/1rsXB92FtyMHQxwhgCHPdKha1i7ntoOqkm0zbW1rR6wJndP/VMFmkCu6diplCClfF7pU7f6RwpNuFpWgvfI77I8zSEQ7GUZS5kzAXuwXEGQxW4MBL4xsdydDpjNpEQpgDxg2gYpFWAnx3bbt2NEJBYMWqkIjOqrZ0FMQ0QQ4CkmbGsFTDhwauCJrjwsAMpD+7OIjj8qkncT/YbxL3f3J82EvcmCt5iKIQmOpdCl/5AVn2qUR326ctXjxZtSvKdwnJjvEwV9oNCDAkn5WesLmu40F5Lc1C2w+BezqTUVQ0Xiebkrj5oRrhJBUFuj6IyNORL3V6Dp48bSsSzX9Dt1Vyl/l5vsN/b6vdquUhuflgk5DpLilb1ay0p1qzWdOcU+hKn0JdzxOO7NMwOng4b54nH2zbne2KYrXPUFSbZuzC83upsu84CWufDa9o+fzEb5JeT5V5ljRnfmTWmJbifDv4F1pgvJdEVo8udESW5K4vLOsq8hsllq53liym3DuzPTr37d2OeaZ11vmpog18N69S6v/9l1No2ztRI7jTg//X1u/fz/p++mcrDw8PDtx8+zl5/nB4eHmbwO4qitSa7dWSAw4D+7PKA3BaP6sKGUaIoQnc9NfQAm/dyMf0P2z7c3CY6FUEYyBxytbgUb5LgIEggu8sfBIIQ8cK0+Vomi+DgMnCB/vCnC7yGlr3PGtLDLgMdz1hG4S+PT0gog3yuIAwwxg1yymCBg4NAjj+zGMbIFcBgONPQEmsfXPpaNg0qCJ3OFhwEdl5BGDjPcVlUJpDlySRY+gG3dVWWVF1p/KM8C0E/kDl0y27eQtNlK43uVj29qvWAc8vYsQTDUcoMe0UXutavPYIG7ew9aAOsH7tWJKELDSKk0HYfjGkaFynolewi52pRRj6hclmjihLecqQS3sH+MgxsyEkdJKoUXQRhwA3L6uUbiEDJm69czCRgBkN9b9r2s2Rjxv7gCsCEhQtPsxtD8VkyMma46PlMihu3HwwfD4aDx4Mh9ODCGG/ahzfHQRef5Xh0K0ZI2Dm0d0f72y+l/bo6dpM2DyFngyVePetW2QuhDeuPrmITXx8xT6fsan443pRiWMtscoYbmueMqggz/W6ddNpksXK7j65gqGUYXFw9mQsSy67PXyQPUzYxNi6GxFIJph7V4xzvzeSGe3vLMFhcPb3Fr3J6T2Hx5lfP7ntM/KySYv8VsD5+tgyD2dWwflumpv4Lgd17sqw2+ADtlczvT6OxTBYjL7eWV1X0exXUm8g0YQoUoVV5VYkakDCQgj1qbzVjKVNGxRpB08hkc+nyoI2Dd8LZdOYzhv6eUknH3qsTgPNlWGhdWGkjVI9rUJ5VwU6DCKJGq/ME6vftZDpfF5PphCQPcLyRLlCMP+i534CjB/V0cTA4VwHOHgSsTAzL8hTzp+dgtR6jeTuJSPkfapwlJgEAv2P7ga/eKl7a0EIc0DVqJh8Tp7RG5CUVZQJqMzWQXF6WZIDUsVySy0tYVaZGsO8vl2FVAGM1CnBrtyWKxYyfN1qVRaxqWJbVmlotC8NtbYHb7+sAuJDcQrl+QBldLqMGQbYAR7u9wwFLSjqDJM7VWZcqE670tbG/gmxHAdDJ/xu8P89ffMvXgPK8l794nr/4Hq4ayJnlPYueCReJ5fw5S9OIPNdGSTF90ULB854rX7+Uip1zNkfGxVWtemnjtuwocjD9AIK6WjyuSayKmNMUY2qVjJl3D6EvC4702rBcg9OUGxshjtngeCSgU8XQGYWw0MLg1Qp4JvQDPqdkptjk9w9aOH3wArOKwZn8vEdfuNpvrJFiRs8ZoWJBcOJoUZHKmusmhUIxGadU8Yk7gIYkTxnE/8L5lMbW3Wsx6uE4nlFxpsPnY/UC8pPLvOaf/vFPqOFl+hvxTiVMXUOoQ1y+Na88ADn2ILSxyEjuXGnj4+5REjoKKePx17GOS+MEp/TrUvTrYqyhlvD9VaLVKD6dMnDnuRrY2GXMMxrP7KaBUFW+6RyIRxbagwcE5g+EiQsYKHME6jagGnZqOQh27tE6qY5Z7O+Oj66BSzRQdS2juMxynKXtg7w7PoJbOsrlhhSEEhMetbRRhYAlgJxz6jP5S81+YeM3mfXLOLlYd39G7n6MLlkFKOF6LUSh3dRBwpW34Kx0XF37AkskCwPuVO5S2pHLGnhEKEpEHsviOlR5BSYpmRaYqWSAff2uiRHz1S0bXGijChu76tNG6lkmKCa0rvDksQKVav2HhAltm1MyQbd6SArBAfOqAJtl2SW7yJniEL6yFgWKWdSB6Lh6i2peWfHx/Xfusp9aMoznId8xS0iRI9UgJ5RXqfiVa099rT7oxPfVAILuhkE5zvCaM6WlABEn1ZQKJ0HteRSsq2M2o6mt6kQFuPQwmwfode3Z/6d//LMG10ajyCpgdgSaJBBgcQWEaKi2BA8hy4rlIAFlEyLoj6k/tI8AAB0yzSiTSclI+vo0foQZILqUiy48oQyP0EU8g22rlLc6LFPlnVFBo026vGJD5jBfdsG1qV0f4bP6VuXDe5fsVcGAh1DgaqB5sagzeBW2IVvd4fGANy+SKQ9BK7xACyNHimVcXG+fqvsAjCwFQWFkRg2Pie9KR83rgaxr2vN1VgUrATWec6kebWBV6G4kRcxGXIzYOVPXON7X4qrAJjlmZs6YqMPmkWS3s+rSjzncmNLASStDrgElGCczpqZsFIOFCqmOXQOJnQ501emQrgXEyVRdKOetcVdrofAAOVL1DuA4XbhMEK023PqNZhH5Vs4BYaU6A0qn7R/wSRBydy9MfYSYCszOA50HTmrQcRkDAHe+VEPYuB1cLJyNU7hi68aBXuAqKBgn3DYnLz/LzFcK1zn50f1FNTA5MOcTmkrkJ6dWtu6xQaDe4E0+M9x/cP3A62TH8ddr4c00P/39fzUoMS7aUZdH3bVf8bRKUy1tmmK9V0/OnuCj5tnU07OQhk8WIylGlRxZSzDNllsJaE2oVVOVEU4K4+BeowFKB+oARNtdDP7RTWHSXt/NgwFC7mhA8HIckPdsSlWSlruGXUaDl9jROiHZoTZRAx4lNpAdNYbGM4aX/yQsh2vwpCAPKmNMzVIB6wmmYCZG6JS8jgnbbYvL2mqeBOC7RE9YEoTWSRx8WobBOI5v2yPsmA1fQ4hFw0bZyuWL4zgmD8cpB/RQNZb2csJHB04ZpgnwISo6Lb24sagW+ShOGhoOrx0DPOpsAN86E38TMn8vnU939Run1bnxfsVsDAkDGIyIJwnUsLw5a8Vn8LM5HbZ5EFwg3c5/8CsysA/6/d+y/+Bx/9fjP9jr/4r8B88AWBcHcrU02XSqWys7fEzH9gafJbMO3lSq7TVh30HXhI1GWofgih2GS/tf5fLwQrxe1gjysHZfbFMFbTgbjp8LYmHY78M/zdV81dAt4ERfxHBCxjsG/y0Irx8xsn0JSmj5WufMNrk++8yHf7uIz4dHgMcNFoStHThCLFQKd/vC9tUt9R88ydZwy0XKBRshikeJjEeK6dGw3x8NArswe+vQ+EFmzCq/c0DmHGy25SnAqAWhU1DjgcbVHWKVKXUV+d0MsjWY8DQ02msgYX8VCW8EptLjldLH8oyJX3am9eGNHR5AvcjSSgYE3FbC70FjsvVyO0nN4kJxswgOTi6Diy7Nedd+Pzj5tPwEB1EzkxB0lUuNEFMzCw6CXjsGSzN1jtE0J5eWfEuK1FQkEGq6Ih5pznvng2gQLMN2m7XidEt9VnRv2kQbOuVielW7TxWKPsAy2pVqIKrS/3L+JwYKoFuHeq0w4EA+M0bBIgKYB+p4X0WuvfZr7KPL1gWMVWvZDgHzEWCNoK72trYmTGt9lNZgvxYfdeJDnTB6qQxeWhePVE7dRxiVAUa1mKFayFAVBdQIAsK4nlpYz0nFEmUEjVeAB6g5Dvf2UMV6OkBd5PEz3Ob3niyRiCuXeRA03eIYRtl27n6Zr7Lpqtz5335D/reW+80RT+VDclaVujPEFTWdA54KS2N8wyLeNohvNE5vsE27IVs22BKQdabP/bUWR9dkvXXJfaybLtabIZwV4voWhdqRfo0E8Fpsk/8hxBr4/3Ef+X+vj/z/rN9QoB2uqx4qNRh13VLVdROo1FnQWT+B0OZiIlHiO0FV3jwNGzLuGCvHHpbGMisvfu50akRVtup0SkluGQMsVu8KRXI5Z2pS2NukJym7wOuwoRnL8FsVosNoBnatFLK0DJuijRMTgMFx51xDMc3pmKccNA6biGlZtFJadAT3e/sgnwfKpjifsxQUldIiD9e4eaV6LtXZBIKFwII2htRvsK4xMaMitu4fu32iGwPMLNV929oogJpb2KQwCvgyo4JOUWKEdQ4kCUtBgGqi5Bi8o1qmheV7Q3kqlY0PxglhXgIi8fVFDp/w7AbbjmIz4KJz5wTUoXXC2p3RvZUxBn93DrBwMM8aSQqRSnjWAvzmRQpJ08b6suGIWIcRmhtFhQZd3YUkuzUoEeb8c0w7Q+hHzWCFv+PizF7g3SUnJV19z8aaG9a8IKwtCR4123zDzbfFGB5ukJobqRZV6yk3s2KMOk69k/KH7ekb/zZKTYO5fjb9B2tQ1b3DozeoIj8iP/39f8h3jCpBZnJuqTUuFEsX1TMs+EgJrrxFW6nhogcYtg3AeGyJz+12HoPfz6hBq/pbNgf3hWUpm75wVIxTHpNjH/UF1xW+xHNgLRKscaGRTT8GtzwluW2dcnEWkUOxQEditfdBObZrTAP329qTMhRC1931+H7MqIIIXVeapedM17wkLOE22EHJYmpHqwPjJtfMxoa5HSYJyVsZ2eAmq8CxBk6MMqDW0glvv6xJ4m5kSjdDpJhI8OIAfUDwJFD1H7ZM+bjzrhT57G6PjtB1Uy6J5UQ347LU+j9a2ndT3qJfBQZsvvJDc+7I6cSTJWnevHdzsrbGEVQm8Pjmtmua87WOZHhrRb+bfGDqnMf+zL6Bo3tYuReEQcpj5iw1bv86/OboO3L+OOoHYe1Mcw3m7n335uXrtx9eAzAgSC3CBlE/6qNBWWqTUVEbqfmMUntrq2Xa7B5d2j26tHt0affo0u7Rpd2jS7tHl3aPLu0eXdo9uvTL3Ui4e3Rp00WMu0eXdo8ureJx9+jS7tGllYuhdo8u7R5d2j26tHt06Td5v97u0aXdo0ubxOfu0aXdo0u7R5fu9d2eu0eXdo8u7R5d2j26tHt0affo0u7Rpe27z62IdPfo0s1v9d09urR7dGn36NLu0aXdo0u7R5d2jy7tHl3aPbq0e3Rp9+jSr8gptHt0affo0u7Rpd2jS7tHl3aPLt2pceY38uhSLeG6l6eUi9rVNPYakJPWU0yfwmAG14QcnASXlzDKR8jih+IfC8wzP/kUBudUcYjKxhtGQn8jBmR4nzG4MOGlTRnoHsPwoeV5zKprXawCV3rYFodI6Fvr1m8yOXr34RjS091V8plM8AojOoeMcDq36fm1tHEsuwxSKqYFppwHts+lveh01rwB5AxvAHF/1PLW4b6LCsLm1SB2GvB/mNTaBpeX9nYRvGDC1refNrZwiPW1Yfk+LZfL/wO+Lapg",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},y=void 0,f={},j=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Draft Document"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/draftdocument",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Unique identifier for this widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Specify the hint for widgets. This parameter is optional and is not applicable to the following widgets: checkbox, radio button, dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options":{\n "hint": "Provide signature"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp",\n "hint": "Provide stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials",\n "hint": "Provide initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide email",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide name",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide job title",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide company",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12,\n "min_date": "",\n "max_date": "",\n "readonly": false,\n "signing_date": false,\n "hint": "Provide date"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"min_date:"})," Provide the minimum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"max_date:"})," Provide the maximum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"signing_date"}),": If signing_date is set to true, the signing date is shown to the signer during signing. You may set either signing_date or default, but not both. Using both is not supported."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio Button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image",\n "hint": "Provide image"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"14",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Provide number",\n "formula": "",\n "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,s.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"decimalplaces:"})," Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"15",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"cells"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "cells",\n "page": 1,\n "x": 100,\n "y": 100,\n "w": 114,\n "h": 50,\n "options": {\n "name": "cells",\n "required": true,\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"cell_count:"})," Specify the number of cells that should be returned to the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,s.jsx)(n.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "required": true,\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "response": "04/15/2024",\n "format": "mm/dd/yyyy",\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "required": true,\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(x.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(h(),{...t(57958)}),"\n",(0,s.jsx)(u(),{...t(17964)})]})}function w(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}},57958(e){e.exports=JSON.parse('{"title":"Body","body":{"content":{"application/json":{"schema":{"required":["file","title"],"type":"object","properties":{"file":{"type":"string","format":"base64","example":"base64 encoded pdf"},"title":{"type":"string","format":"string","example":"sample document"},"note":{"type":"string","format":"string","example":"sample Note"},"description":{"type":"string","format":"string","example":"sample Description"},"timeToCompleteDays":{"type":"number","description":"time to complete days is used to calculate expiry date of your document","format":"number","example":15},"signers":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","format":"string","example":"ceo"},"email":{"type":"string","format":"string","example":"joebee@example.com"},"name":{"type":"string","format":"string","example":"joe bee"},"phone":{"type":"string","format":"string","example":"123121312"},"company":{"type":"string","format":"string","example":"opensign"},"job_title":{"type":"string","format":"string","example":"dev"},"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Allowed values - signature, stamp.","format":"string","example":"signature"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":244},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":71},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":38},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":46}},"title":"createdocument_body_widgets"}}},"title":"createdocument_body_signers"}},"folderId":{"type":"string","example":""},"send_email":{"type":"boolean","description":"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \\"true\\". If the value of this parameter is \\"true\\" and no \'email_subject\'/\'email_body\' parameters are specified default email templates will be used. \\n","example":true},"email_subject":{"type":"string","description":"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.","example":"{{sender_name}} has requested you to sign {{document_title}}"},"email_body":{"type":"string","description":"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.","example":"

Hi {{receiver_name}},

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

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

Sign here

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

Thanks,
Team OpenSign\u2122

"},"sendInOrder":{"type":"boolean","description":"If set to \'true\', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to \'true\'.","example":true},"enableOTP":{"type":"boolean","description":"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.","example":false},"enableTour":{"type":"boolean","description":"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.","example":false},"redirect_url":{"type":"string","description":"Specifies the URL where the signer will be redirected upon completing the document signing process.","example":""},"sender_name":{"type":"string","description":"The name of the person or organization on whose behalf the email is being sent.","example":"opensign\u2122"},"sender_email":{"type":"string","description":"The email address of the person or organization that users can reply to.","example":"mailer@opensignlabs.com"},"allow_modifications":{"type":"boolean","description":"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.","example":false},"auto_reminder":{"type":"boolean","description":"Set to true to enable automatic reminders. Set to false to disable them (default behavior).","example":false},"remind_once_in_every":{"type":"number","description":"Number of days between reminders. This is only applicable when auto_reminder is set to true.","example":5},"merge_certificate":{"type":"boolean","description":"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\\n\\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\\n\\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\\n","example":false},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed.\\n"},"prefill":{"type":"object","description":"You can provide widgets which can embed before sending to signer","properties":{"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","format":"string","example":"textbox"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":100},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":30},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":40},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":80},"options":{"type":"object","properties":{"name":{"type":"string","example":"textbox"},"response":{"type":"string","example":"joe"},"color":{"type":"string","example":"red"},"fontsize":{"type":"number","example":12}}}}}}},"title":"prefill"}},"title":"draftdocument_body"}}},"required":true}}')},17964(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Document created successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"document_id":{"type":"string","format":"string","example":"hji2zxcv2P"},"url":{"type":"string","format":"string","example":"https://url-to-send-document.com"}},"title":"inline_draft_doc_res_200_1"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/980c6622.99e2214d.js b/assets/js/980c6622.99e2214d.js new file mode 100644 index 000000000..5a2618eb4 --- /dev/null +++ b/assets/js/980c6622.99e2214d.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[5919],{49757(e,t,n){n.r(t),n.d(t,{assets:()=>K,contentTitle:()=>h,default:()=>k,frontMatter:()=>v,metadata:()=>s,toc:()=>P});const s=JSON.parse('{"id":"API-docs/v1.1/getsigninglinks","title":"Get Signing Links","description":"The Get Signing Links API enables you to retrieve signing urls of signers for the document.","source":"@site/docs/API-docs/v1.1/getsigninglinks.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/getsigninglinks","permalink":"/docs/API-docs/v1.1/getsigninglinks","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getsigninglinks","title":"Get Signing Links","description":"The Get Signing Links API enables you to retrieve signing urls of signers for the document.","sidebar_label":"Get Signing Links","hide_title":true,"hide_table_of_contents":true,"api":"eJy9Wc1yG7kRfpUOXJWyWEPS9joXbmqzWllrq+KsVaIUH0SVBhw0OVhhgFkAMxQjsWoPqTxAKpdc8xK551H8JKkGZoZDSmuva5M9+IdAo9G/Xzd67pjnS8cml+yVyaoCtXfsKmECXWZl6aXRbMLOc4TX6GEql1rqJbyV+sbB4ekJoOZzhQ7WpgJvwKK3EmsE11BWVjkwi/AbrYOFseBzBNFcNpppljBTouV014lgE7ZE3xxXdA9LWMktL9CjJUHvmOYFsglreVxLwRImSdCS+5ztS2/m32PmTwTJ0SrJEmbxh0paFGzibYUJc36tiK2TRamQJQxvS2UEssmCK0cEWY4FZ5M75tdloPRW6iVL2MLYgvv+Ct7ywGXC+DcvsuxFXs5zttlc0bWuNNqhI0Yvnj2jf3bldVWWoXOLSkFnGJawzGhPkk/uGC9LJbOwMf7e0aG7h9JFtcl6lth4Ga9srfG5euTfyxd/uc3qF6dskzByUGVVjwm3lq/JDx4L92kxsOBSfa4MdObr5ucoMwVJsivFz1PF+9JNxuPKqqE3Q9Jl2AVkYLtJmJc+EEutpMbr1m3XwmTXrfabPuF+2G7C7svHPDw1Bfqc8mOF2sPKGr1MoFTIHYK3a+BLLjUo7tH+5n/nerTW2MeMtTXN50n2MTu9fPbs+nlnhJcPjdCmImjjYWEqLX5dVR+7/+MKvbz+olPodw8VOtE1V1IEXDw3N6h/XX361/t4PYl6W4T8aDBTRqKwz3aU7a9HJR1mlZV+HTD3dshLOYz7k8srQjKKFNMAdgBpn7MJG/eTYHzXA+kNI562bmE8ZG6XjI5rMTe3I1OiJhaKzx0l45iXclw/H71gm2T/DC/Lz6LHavi5R5znS6mXnzp3tTXXlFwavbZjtC1SlvKPSFDZ+KRP1dSxHLlAG/wn9cKEw42n3pWoqQ4HP4fL9+vdE2hpPvz1Xx3ZTM/0VzAYUC0nRYbOVDbDUBEDP648Ws29rBE+/PgPmFdS+VCwBdaoKBpdAt5WzqOA+RpQe7SllQ7daDAg/v17l7Ju+gIOmaEY9ZhAaY2oMhJ0aJGLNWCAX+4ri1Aq7gm3wefWVMscODiKJEzg7Hh6TgXx8PRkBFPUousgYk/RMUmg4JovETwWxA+DzDy76VoS57mvHEgNFrkCLwtMgGsBvPKm4B5JaEvaSbttVEDJBWbrTEXjcKVgJX1uKg81amEsKJPdDKUekSGGwyH98+QJtU2ebp16bj0KWj2u0a6B2g90HorKeci4tet4b5e+JCG1SmkvPlKIkREuSdN0pnubE/g9cdgufNXQzPRg8OFvf4fLN2ZFXdoSNbUVuHfh1dM26IXJ3MNop9VxjqocT6NSbnx4ehKQ7iD6/zvjwZEnVzlapKvmuJT6D3BB1SNHGAyaNAfUtbRGk2kHA3ia/mwYSA+Ib2mNN5RPnRf4YoFZMLWiCBbc8z1XHBmLcMRLPpdKErDS+j0ccY9LY9dwD+9z7kPIZlyDMHA/0/fD4TD8IdLBoGuSBwO4hyOLnKLaoRYJVKUIvyzW5qaJKYEU99vwHLZu34Zvw/m8jdfA+ZtKKgEWK0f99TaYg7pQWhyWimcoYCUFNR5fBhnIMkYjGEtZsO667uaKKarFkPIzXPG6jQJHy4G0n1WdXRsuIHUtfahesFBm1TI9reZKZrAr/jTnFoFDGTfb1KOaENJHm5arks5D24q3PF9ZvvDw3tgbuily5DX2pKNnRGcT7kDQCRdMvpCaKxkDroidSsv3yGjPs8Z5f4o4EXKgESaL+zA35oZCbGl5UXAvM67UumXyrVECbeTxzi65pru2kkntpMAOguGVpXBcxEMtj/c4z425iUzOMEOiITgaEhwB1k1fIhdNw+AgRqYFs9KAWpRGat+yu3CtQGftA4xnmam0DxbJLArpgSoJNcXkwfvd1KDA//DjPx18hyvCnbZg0OYTOPSeZ3lAwfch3GBalaWxfqapmqS823dpE5AgHWizAhcJUYDR0UmdqRKSi+JvuxAJWsd2BNsF0qaJqXaR8MuNWlHfkO2n0Zs7r9WZnqKHdMZyKfA6+vu6icvr0KvM2ISqG8I9hAdfSiKnp++m5zAOgrVyppRmxKYNm354uxa2d5WFto0cbc16pJDT8TZ1WudxNdPp6+NzGLc6jidSpEH53XVKnhRySo05ogbnLfKC2lYR0syiqLTg2sP2BQ2UmRYLU6MILAeD0uJCKhUws3WcRV9Z4uOQznpUa1hYU7Q6bxkOBlRzb8gA3dsWkDuJlgyVGe2qAjsPnXLnVsaK4ak1HjMKjdNX324jivbJTwup8LpsiGcsbe3aAujciDXVGQ0rY8PtARpRZ3ZdNlzdqOUbAnAy040/Y2C1ZkzhP/+G9PTigcXDcu9A683xpKW73iXbi5O9jb37wgaBL5k0be3zbrEgB3bRS5hljerilytlVtcmUoUI/ljg7isaYugRTb0BGnfITHq1bqY6BLJCxgLU3NeFOvVcyLO8S8POv03ynRlFBTbgQ1OGUoiPmxBfPMuwJMQmnZp0tEYheXohUQngmTXOhU4raEGwZU3l0Y3gPLeIQPQxnjuYmcSaTrdTFcWc15JQc7+SNzKlMHgqcMEr5Q9CTQjNWNOtEuTSw9eHmrptUxuEi3xqiSvi08G425lvBUNZJCowWq3b6teUbQjebAtfysvSmjqyO+I6ZjYV8pYcb8lqTU2O0jS1M1x230ELt3Oj4ciUa3h6dHRAwslSEkLP9CFoXJHZs2xr7Qd4zZXRy1DKSB+8lS40V+mMzfvnCNY7/N4CdUQ/irauu+i8OI6NUufMYxrrABfCoiPsIFRDQfneyWibEsmpU54bPcxIs36BhDBQAqMz3HWAdJ1DxQjeyhvc6pCQ+DvSwFNXZTl1FDFLthkvRXpAPUEtRWOHKBr5y0rR+L2rSjVXFSahkkeUIssqSYalNgWwKP0awtAMnqaXV+nBl2AK6QOXaFpvQOocbbO4y3qvtz2suVQhU4+3jXXT4PZWKCdoknNx9vaR5nYae+/QSHxGQ951gt3bbpfDR5/O3enjCzjD5YPDn3qyp/utzJ/ROmkCSP0WvuHZzYpb4eDIFCX3MrT+ayKlwxQci4p6u3lLOMwaQhWfFlA/D2FcPx89715+bf/lYkn0uXEIdbw4AhLv/GGobEkH89bugas2MLcYq2aWc72kRKDmq1eoJQG/qLKYC0FeYm3CO58rqLRC58D4HO2KmlBtKMZ3zXHhkN7NTQ8000O47FrT9zh30uP23bdarR5Y+iCc+bZSqhueh4T7xGsxHnst/ZtqDmdYGie9sevtqaX0eTUPvuyf7X40DNpHSjdU+yWv1MDyHG0RvklM0dYy+4T6Y0/k44PwnWJvnrM7drG4QEu443be2LyUzXv+spUDSLxfogdN7pq3Sm+WToOlr/f5hCEfqfBu0ejbDLc+ri9LmJIZaoe94eHh69O3UH8xesaS3pTsZ/hy/Pbk6Pi76TEJ06QJm7Dno2ejZ7RUGucLrns3PfjYtD/kutsOVv/vX6easZ3HWz8uFZe699khDj0v2d4Hq0n/29RVwnLjPJHd3REMXFi12dDyDxVaGq9eJazmVpKwYTLadF2i+/T0k7o/PWuezgfwE5+5HpW+nURqGkOGesImjCXsBtd7H9Y2V5ukHUeSaJHiMHRvvbMPZts7A+LXx+csYbwiW/XHoDdhDNr8h7g/KtfufDQKQH/TsPbRA3d3ccS62XT0cesnTzQKttRkpKvNZvNfeuVWiw==","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Formdata","permalink":"/docs/API-docs/v1.1/getformdata"},"next":{"title":"Draft Template","permalink":"/docs/API-docs/v1.1/drafttemplate"}}');var i=n(74848),a=n(28453),o=n(57742),r=n.n(o),l=n(78178),c=n.n(l),d=n(19624),p=n.n(d),g=n(96226),m=n.n(g),u=(n(77675),n(19365),n(51107)),b=n(21312);const v={id:"getsigninglinks",title:"Get Signing Links",description:"The Get Signing Links API enables you to retrieve signing urls of signers for the document.",sidebar_label:"Get Signing Links",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Wc1yG7kRfpUOXJWyWEPS9joXbmqzWllrq+KsVaIUH0SVBhw0OVhhgFkAMxQjsWoPqTxAKpdc8xK551H8JKkGZoZDSmuva5M9+IdAo9G/Xzd67pjnS8cml+yVyaoCtXfsKmECXWZl6aXRbMLOc4TX6GEql1rqJbyV+sbB4ekJoOZzhQ7WpgJvwKK3EmsE11BWVjkwi/AbrYOFseBzBNFcNpppljBTouV014lgE7ZE3xxXdA9LWMktL9CjJUHvmOYFsglreVxLwRImSdCS+5ztS2/m32PmTwTJ0SrJEmbxh0paFGzibYUJc36tiK2TRamQJQxvS2UEssmCK0cEWY4FZ5M75tdloPRW6iVL2MLYgvv+Ct7ywGXC+DcvsuxFXs5zttlc0bWuNNqhI0Yvnj2jf3bldVWWoXOLSkFnGJawzGhPkk/uGC9LJbOwMf7e0aG7h9JFtcl6lth4Ga9srfG5euTfyxd/uc3qF6dskzByUGVVjwm3lq/JDx4L92kxsOBSfa4MdObr5ucoMwVJsivFz1PF+9JNxuPKqqE3Q9Jl2AVkYLtJmJc+EEutpMbr1m3XwmTXrfabPuF+2G7C7svHPDw1Bfqc8mOF2sPKGr1MoFTIHYK3a+BLLjUo7tH+5n/nerTW2MeMtTXN50n2MTu9fPbs+nlnhJcPjdCmImjjYWEqLX5dVR+7/+MKvbz+olPodw8VOtE1V1IEXDw3N6h/XX361/t4PYl6W4T8aDBTRqKwz3aU7a9HJR1mlZV+HTD3dshLOYz7k8srQjKKFNMAdgBpn7MJG/eTYHzXA+kNI562bmE8ZG6XjI5rMTe3I1OiJhaKzx0l45iXclw/H71gm2T/DC/Lz6LHavi5R5znS6mXnzp3tTXXlFwavbZjtC1SlvKPSFDZ+KRP1dSxHLlAG/wn9cKEw42n3pWoqQ4HP4fL9+vdE2hpPvz1Xx3ZTM/0VzAYUC0nRYbOVDbDUBEDP648Ws29rBE+/PgPmFdS+VCwBdaoKBpdAt5WzqOA+RpQe7SllQ7daDAg/v17l7Ju+gIOmaEY9ZhAaY2oMhJ0aJGLNWCAX+4ri1Aq7gm3wefWVMscODiKJEzg7Hh6TgXx8PRkBFPUousgYk/RMUmg4JovETwWxA+DzDy76VoS57mvHEgNFrkCLwtMgGsBvPKm4B5JaEvaSbttVEDJBWbrTEXjcKVgJX1uKg81amEsKJPdDKUekSGGwyH98+QJtU2ebp16bj0KWj2u0a6B2g90HorKeci4tet4b5e+JCG1SmkvPlKIkREuSdN0pnubE/g9cdgufNXQzPRg8OFvf4fLN2ZFXdoSNbUVuHfh1dM26IXJ3MNop9VxjqocT6NSbnx4ehKQ7iD6/zvjwZEnVzlapKvmuJT6D3BB1SNHGAyaNAfUtbRGk2kHA3ia/mwYSA+Ib2mNN5RPnRf4YoFZMLWiCBbc8z1XHBmLcMRLPpdKErDS+j0ccY9LY9dwD+9z7kPIZlyDMHA/0/fD4TD8IdLBoGuSBwO4hyOLnKLaoRYJVKUIvyzW5qaJKYEU99vwHLZu34Zvw/m8jdfA+ZtKKgEWK0f99TaYg7pQWhyWimcoYCUFNR5fBhnIMkYjGEtZsO667uaKKarFkPIzXPG6jQJHy4G0n1WdXRsuIHUtfahesFBm1TI9reZKZrAr/jTnFoFDGTfb1KOaENJHm5arks5D24q3PF9ZvvDw3tgbuily5DX2pKNnRGcT7kDQCRdMvpCaKxkDroidSsv3yGjPs8Z5f4o4EXKgESaL+zA35oZCbGl5UXAvM67UumXyrVECbeTxzi65pru2kkntpMAOguGVpXBcxEMtj/c4z425iUzOMEOiITgaEhwB1k1fIhdNw+AgRqYFs9KAWpRGat+yu3CtQGftA4xnmam0DxbJLArpgSoJNcXkwfvd1KDA//DjPx18hyvCnbZg0OYTOPSeZ3lAwfch3GBalaWxfqapmqS823dpE5AgHWizAhcJUYDR0UmdqRKSi+JvuxAJWsd2BNsF0qaJqXaR8MuNWlHfkO2n0Zs7r9WZnqKHdMZyKfA6+vu6icvr0KvM2ISqG8I9hAdfSiKnp++m5zAOgrVyppRmxKYNm354uxa2d5WFto0cbc16pJDT8TZ1WudxNdPp6+NzGLc6jidSpEH53XVKnhRySo05ogbnLfKC2lYR0syiqLTg2sP2BQ2UmRYLU6MILAeD0uJCKhUws3WcRV9Z4uOQznpUa1hYU7Q6bxkOBlRzb8gA3dsWkDuJlgyVGe2qAjsPnXLnVsaK4ak1HjMKjdNX324jivbJTwup8LpsiGcsbe3aAujciDXVGQ0rY8PtARpRZ3ZdNlzdqOUbAnAy040/Y2C1ZkzhP/+G9PTigcXDcu9A683xpKW73iXbi5O9jb37wgaBL5k0be3zbrEgB3bRS5hljerilytlVtcmUoUI/ljg7isaYugRTb0BGnfITHq1bqY6BLJCxgLU3NeFOvVcyLO8S8POv03ynRlFBTbgQ1OGUoiPmxBfPMuwJMQmnZp0tEYheXohUQngmTXOhU4raEGwZU3l0Y3gPLeIQPQxnjuYmcSaTrdTFcWc15JQc7+SNzKlMHgqcMEr5Q9CTQjNWNOtEuTSw9eHmrptUxuEi3xqiSvi08G425lvBUNZJCowWq3b6teUbQjebAtfysvSmjqyO+I6ZjYV8pYcb8lqTU2O0jS1M1x230ELt3Oj4ciUa3h6dHRAwslSEkLP9CFoXJHZs2xr7Qd4zZXRy1DKSB+8lS40V+mMzfvnCNY7/N4CdUQ/irauu+i8OI6NUufMYxrrABfCoiPsIFRDQfneyWibEsmpU54bPcxIs36BhDBQAqMz3HWAdJ1DxQjeyhvc6pCQ+DvSwFNXZTl1FDFLthkvRXpAPUEtRWOHKBr5y0rR+L2rSjVXFSahkkeUIssqSYalNgWwKP0awtAMnqaXV+nBl2AK6QOXaFpvQOocbbO4y3qvtz2suVQhU4+3jXXT4PZWKCdoknNx9vaR5nYae+/QSHxGQ951gt3bbpfDR5/O3enjCzjD5YPDn3qyp/utzJ/ROmkCSP0WvuHZzYpb4eDIFCX3MrT+ayKlwxQci4p6u3lLOMwaQhWfFlA/D2FcPx89715+bf/lYkn0uXEIdbw4AhLv/GGobEkH89bugas2MLcYq2aWc72kRKDmq1eoJQG/qLKYC0FeYm3CO58rqLRC58D4HO2KmlBtKMZ3zXHhkN7NTQ8000O47FrT9zh30uP23bdarR5Y+iCc+bZSqhueh4T7xGsxHnst/ZtqDmdYGie9sevtqaX0eTUPvuyf7X40DNpHSjdU+yWv1MDyHG0RvklM0dYy+4T6Y0/k44PwnWJvnrM7drG4QEu443be2LyUzXv+spUDSLxfogdN7pq3Sm+WToOlr/f5hCEfqfBu0ejbDLc+ri9LmJIZaoe94eHh69O3UH8xesaS3pTsZ/hy/Pbk6Pi76TEJ06QJm7Dno2ejZ7RUGucLrns3PfjYtD/kutsOVv/vX6easZ3HWz8uFZe699khDj0v2d4Hq0n/29RVwnLjPJHd3REMXFi12dDyDxVaGq9eJazmVpKwYTLadF2i+/T0k7o/PWuezgfwE5+5HpW+nURqGkOGesImjCXsBtd7H9Y2V5ukHUeSaJHiMHRvvbMPZts7A+LXx+csYbwiW/XHoDdhDNr8h7g/KtfufDQKQH/TsPbRA3d3ccS62XT0cesnTzQKttRkpKvNZvNfeuVWiw==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-2",custom_edit_url:null},h=void 0,K={},P=[];function f(e){const t={p:"p",...(0,a.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Get Signing Links"}),"\n",(0,i.jsx)(r(),{method:"get",path:"/signinglinks/{document_id}",context:"endpoint"}),"\n",(0,i.jsx)(t.p,{children:"The Get Signing Links API enables you to retrieve signing urls of signers for the document."}),"\n",(0,i.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,i.jsx)(b.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,i.jsx)(c(),{...n(87174)}),"\n",(0,i.jsx)(p(),{...n(19140)}),"\n",(0,i.jsx)(m(),{...n(70974)})]})}function k(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}},87174(e){e.exports=JSON.parse('{"parameters":[{"name":"document_id","in":"path","description":"objectId of Document","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"aB2cc2hpbh"}}]}')},19140(e){e.exports={title:"Body"}},70974(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"hji2zxcv2P"},"signurl":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","format":"string","example":"mail@example.com"},"url":{"type":"string","format":"string","example":"https://url-to-sign-document.com"}},"title":"inline_response_doc_signurl"}}},"title":"getsigninglinks"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"Document not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Document not found!"}},"title":"inline_response_404_3"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/980c6622.f03d02d3.js b/assets/js/980c6622.f03d02d3.js deleted file mode 100644 index c3252ae28..000000000 --- a/assets/js/980c6622.f03d02d3.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[5919],{49757(e,t,n){n.r(t),n.d(t,{assets:()=>v,contentTitle:()=>h,default:()=>f,frontMatter:()=>b,metadata:()=>i,toc:()=>I});const i=JSON.parse('{"id":"API-docs/v1.1/getsigninglinks","title":"Get Signing Links","description":"The Get Signing Links API enables you to retrieve signing urls of signers for the document.","source":"@site/docs/API-docs/v1.1/getsigninglinks.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/getsigninglinks","permalink":"/docs/API-docs/v1.1/getsigninglinks","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getsigninglinks","title":"Get Signing Links","description":"The Get Signing Links API enables you to retrieve signing urls of signers for the document.","sidebar_label":"Get Signing Links","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V81uIzcSfpVaXjYjtCWPM7noFCc7cIwMMsZ4Ah88gsFml9Qcs0mGrJasFRrIYd8gp1zzaPMki2L/qCV7khjZzcVWk/Xz1X9xJ0iuopjfin85VVdoKYpFJgqMKmhP2lkxF+9LhAskuNYrq+0K3mh7H+H86hLQytxghK2rgRwEpKBxjRA7yjqYCG6ZvjFEWLoAVCIUnbLpBysy4TwGybouCzEXK6SO3bAekQkvg6yQMDDQnbCyQjEXvYw7XYhMaAbqJZXiGL3LP6Kiy4Jx9EaKTAT8qdYBCzGnUGMmIm0Ni4268gZFJvDBG1egmC+liUygSqykmO8EbX2ipKDtSmRi6UIlaXyCDzJJmQv5zZlSZ6XPS9E0C1YbvbMRIws6Oz3lf4d4Y60UxrisDQyOEZlQzhIjn++E9N5olS5mHyMz7R6ja81m7wUWQ7pV2XvjuXaUH/XZvx/U+uxKNJngANXBjITIEOSW40BYxT+GgZXU5rkYmOfr7nOqXMVIDlH8OVOIfJzPZnUwJ+RO2JaTISGT2CYTpCkRa2u0xbs+bHeFU3e99c2Y8Dhtm3T76qkIX7sKqeT62KAl2ARnVxl4gzIiUNiCXEltwUjC8I//XegxBBeectbeNc9D9nt+enV6evdycMKrx07oSxGsI1i62hZ/r6lP6f99g17dfTkY9NVjgy7tWhpdpL743t2j/XvtGaunVj1DfahSfXQ9U7dE6V4cGDs+b42MqOqgaZt67sOJ9PqkvZ/fLriTcaa4rmGnJk2lmIvZuAhmu1GTbgTLDOu+jafKHYoxSlvk7mHqPFoWYWQeuRhn0uvZ+uX0pWiyYx7p/bPosT55LkskudJ29Ud8i727rjmkbdQOnLbvlF5/j9wqu5iMqbo5VqIsMKT4abt0ibmL1FuPludwinNSfjzvbtAoVyHPYx61k0nP8uk/vw1ck8kwg1NGTj/YD/ZtHcC7DQaePdIWsDT4oHOD7ayv0t0w7CPKymCMZgvaEq6CJIRCrzRJMywASnqZa6M5kZnMMXeAUS3EKdyUSCUGvvpnQJBQ4BoN5z/ImlwliUX1eGHjwv3SuE3MQEJeR20xRkBbSquYsI9EBi6AtICWMPigI0KkwKh1i81ZClIRVNLKFbLsDMbOKtBoTlcILq8jQXSmTpCBpDYuYAG9QRaxiMmJr3ltCAh8qlzlA5acNmuEVa0LjBkoVyDEVLdsgi0gx0jgGYtWGFlobY1T9ymAy9oY8I7biJaGt5gxRmanIG3kiddi6WMwOMwHxxsFtgAnkx8jcoTTGjefTD7YE7gd8uoG86gJF1/0JbDZbB6l/otDngtN39U5vEPvoiYXtnvulaayzlO5jIUMH62kC7SY8mdUDHsZhVPxcfXx6axE42fXSJwhcXZ+dZk67wv49PMv8AZlsFC6TZutqg5otrDqVbHn2si3bhsaZ9pSZU0le1y1ycfbIkbqPXhTSvr0868RfsANaNuVFJsymVzVudEK3mPleU7GyWQO3wZkldSfAZWSQEkLOUIsJafSWkuQ4Ftubp9TOLdbqCMG2GgqUzLweeI7MIP9MoQ7Qi4jFuBs4uh1TveI+LyKaNYYWRYPwBwBC02c0WVw9arVNgbTGRdwqY2BG13wwsO2nRcF+O540x6zw0dwcMkFQSVuQQaEyHsWXB2xpJvaexcYhW7BL50xbsMBQFt4py3FORRBLmkvP9snumI3a2efOGpdKAd3ZJ2YISRtJXYWD6ftA+WokR/224BLDKwwmb2Pi9ddOt32aQmcrX8lrXlkc9eSikZLNE+Ur4/lpOmOoYpvl9cY1lr1m+9nKnqWiGciE0YrtBFHW8P5xdUbWH85PRXZaDz+ieKevbn89vUP168ZDDfS1mEvp6fTUz7yLlIl7UjTo1fm8XTb7Teq//uztJvXhA8080ZqO3pvtNvOrTh6qc7Hj9JFJkoXicl2O67JH4NpGj7+qcbAe9UiE2sZNINNK1GhI/8uhjfnZ23/4l33fH0Bn3nfPom+X0Es7x9raWr+Epm4x+3Ri7pZNFm/hzC0luJcKfQ04n201B5shhev34tMcCs93H/u0/7T/WDpT+I6XIxaAPyXt7QnGXa7drdqmoG+vfosR2dgT81OWjRN81+q3Qfy","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Formdata","permalink":"/docs/API-docs/v1.1/getformdata"},"next":{"title":"Draft Template","permalink":"/docs/API-docs/v1.1/drafttemplate"}}');var s=n(74848),o=n(28453),a=n(57742),l=n.n(a),r=n(78178),p=n.n(r),c=n(19624),g=n.n(c),d=n(96226),m=n.n(d),u=(n(77675),n(19365),n(51107)),k=n(21312);const b={id:"getsigninglinks",title:"Get Signing Links",description:"The Get Signing Links API enables you to retrieve signing urls of signers for the document.",sidebar_label:"Get Signing Links",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V81uIzcSfpVaXjYjtCWPM7noFCc7cIwMMsZ4Ah88gsFml9Qcs0mGrJasFRrIYd8gp1zzaPMki2L/qCV7khjZzcVWk/Xz1X9xJ0iuopjfin85VVdoKYpFJgqMKmhP2lkxF+9LhAskuNYrq+0K3mh7H+H86hLQytxghK2rgRwEpKBxjRA7yjqYCG6ZvjFEWLoAVCIUnbLpBysy4TwGybouCzEXK6SO3bAekQkvg6yQMDDQnbCyQjEXvYw7XYhMaAbqJZXiGL3LP6Kiy4Jx9EaKTAT8qdYBCzGnUGMmIm0Ni4268gZFJvDBG1egmC+liUygSqykmO8EbX2ipKDtSmRi6UIlaXyCDzJJmQv5zZlSZ6XPS9E0C1YbvbMRIws6Oz3lf4d4Y60UxrisDQyOEZlQzhIjn++E9N5olS5mHyMz7R6ja81m7wUWQ7pV2XvjuXaUH/XZvx/U+uxKNJngANXBjITIEOSW40BYxT+GgZXU5rkYmOfr7nOqXMVIDlH8OVOIfJzPZnUwJ+RO2JaTISGT2CYTpCkRa2u0xbs+bHeFU3e99c2Y8Dhtm3T76qkIX7sKqeT62KAl2ARnVxl4gzIiUNiCXEltwUjC8I//XegxBBeectbeNc9D9nt+enV6evdycMKrx07oSxGsI1i62hZ/r6lP6f99g17dfTkY9NVjgy7tWhpdpL743t2j/XvtGaunVj1DfahSfXQ9U7dE6V4cGDs+b42MqOqgaZt67sOJ9PqkvZ/fLriTcaa4rmGnJk2lmIvZuAhmu1GTbgTLDOu+jafKHYoxSlvk7mHqPFoWYWQeuRhn0uvZ+uX0pWiyYx7p/bPosT55LkskudJ29Ud8i727rjmkbdQOnLbvlF5/j9wqu5iMqbo5VqIsMKT4abt0ibmL1FuPludwinNSfjzvbtAoVyHPYx61k0nP8uk/vw1ck8kwg1NGTj/YD/ZtHcC7DQaePdIWsDT4oHOD7ayv0t0w7CPKymCMZgvaEq6CJIRCrzRJMywASnqZa6M5kZnMMXeAUS3EKdyUSCUGvvpnQJBQ4BoN5z/ImlwliUX1eGHjwv3SuE3MQEJeR20xRkBbSquYsI9EBi6AtICWMPigI0KkwKh1i81ZClIRVNLKFbLsDMbOKtBoTlcILq8jQXSmTpCBpDYuYAG9QRaxiMmJr3ltCAh8qlzlA5acNmuEVa0LjBkoVyDEVLdsgi0gx0jgGYtWGFlobY1T9ymAy9oY8I7biJaGt5gxRmanIG3kiddi6WMwOMwHxxsFtgAnkx8jcoTTGjefTD7YE7gd8uoG86gJF1/0JbDZbB6l/otDngtN39U5vEPvoiYXtnvulaayzlO5jIUMH62kC7SY8mdUDHsZhVPxcfXx6axE42fXSJwhcXZ+dZk67wv49PMv8AZlsFC6TZutqg5otrDqVbHn2si3bhsaZ9pSZU0le1y1ycfbIkbqPXhTSvr0868RfsANaNuVFJsymVzVudEK3mPleU7GyWQO3wZkldSfAZWSQEkLOUIsJafSWkuQ4Ftubp9TOLdbqCMG2GgqUzLweeI7MIP9MoQ7Qi4jFuBs4uh1TveI+LyKaNYYWRYPwBwBC02c0WVw9arVNgbTGRdwqY2BG13wwsO2nRcF+O540x6zw0dwcMkFQSVuQQaEyHsWXB2xpJvaexcYhW7BL50xbsMBQFt4py3FORRBLmkvP9snumI3a2efOGpdKAd3ZJ2YISRtJXYWD6ftA+WokR/224BLDKwwmb2Pi9ddOt32aQmcrX8lrXlkc9eSikZLNE+Ur4/lpOmOoYpvl9cY1lr1m+9nKnqWiGciE0YrtBFHW8P5xdUbWH85PRXZaDz+ieKevbn89vUP168ZDDfS1mEvp6fTUz7yLlIl7UjTo1fm8XTb7Teq//uztJvXhA8080ZqO3pvtNvOrTh6qc7Hj9JFJkoXicl2O67JH4NpGj7+qcbAe9UiE2sZNINNK1GhI/8uhjfnZ23/4l33fH0Bn3nfPom+X0Es7x9raWr+Epm4x+3Ri7pZNFm/hzC0luJcKfQ04n201B5shhev34tMcCs93H/u0/7T/WDpT+I6XIxaAPyXt7QnGXa7drdqmoG+vfosR2dgT81OWjRN81+q3Qfy",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},h=void 0,v={},I=[];function x(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Get Signing Links"}),"\n",(0,s.jsx)(l(),{method:"get",path:"/signinglinks/{document_id}",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Get Signing Links API enables you to retrieve signing urls of signers for the document."}),"\n",(0,s.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(k.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(p(),{...n(87174)}),"\n",(0,s.jsx)(g(),{...n(19140)}),"\n",(0,s.jsx)(m(),{...n(70974)})]})}function f(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(x,{...e})}):x(e)}},87174(e){e.exports=JSON.parse('{"parameters":[{"name":"document_id","in":"path","description":"objectId of Document","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"aB2cc2hpbh"}}]}')},19140(e){e.exports={title:"Body"}},70974(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"hji2zxcv2P"},"signurl":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","format":"string","example":"mail@example.com"},"url":{"type":"string","format":"string","example":"https://url-to-sign-document.com"}},"title":"inline_response_doc_signurl"}}},"title":"getsigninglinks"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"Document not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Document not found!"}},"title":"inline_response_404_3"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/98334e25.743df768.js b/assets/js/98334e25.743df768.js new file mode 100644 index 000000000..c5d9ca7b2 --- /dev/null +++ b/assets/js/98334e25.743df768.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[7024],{92846(e,t,o){o.r(t),o.d(t,{assets:()=>m,contentTitle:()=>h,default:()=>U,frontMatter:()=>b,metadata:()=>i,toc:()=>C});const i=JSON.parse('{"id":"API-docs/v1.1/get-webhook","title":"Get Webhook","description":"The Get Webhook API allow you to get webhook url","source":"@site/docs/API-docs/v1.1/get-webhook.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/get-webhook","permalink":"/docs/API-docs/v1.1/get-webhook","draft":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJy9WM1uHMcRfpXKCAjExewuZTsIsA4c0xQtC1EsQktGBy7B6Z2p3Wmzp3tc3TPLBbmAD0EeIMgl17xE7nkUPUlQ3T2zP1QkKw5ykEj2VFXXz1c/XfeJE0ubTK6StzgvjblNrtOkQJuTrJ00OpkkFyXCC3QQCeDk/CUIpcwK1qYBZ2CJDlbxY0MqSRNTIwlmf1kkk2SJrhOeJoS2NtqiTSb3yWfHx/xj/75pk+do7aJR0MtJ0iQ32qF2TC/qWsncfxj/YJnpPrF5iZXg39y6xmSSmPkPmLskTWpiMU6GK6OiO4TWkdTLJE3wTlS14qPSudpOxuO1aWgYOYYNqa8jySg3VbLZpImTzjNIraTGm864m8+Oj29+m2w2TPPF8RePjby0SKCNg4VpdPGr/519SGTow9Yd3v0hQ1j5zozfPDbjpW6FkoXHxIW5Rf3/tWT3eheuZ1XvKsV8WlTBJE/kvyd7pu6eByMt5g1Jt04mV/fJ3VDUchi+T66uN9dpUqErTcQ0KyxcmUyS8aqHt0Vqkazn51zYYskKXczN3cjUqK1caiXmlnE0FrUct89GnyWb9JBH1PUn0WMz/FQW68RS6uXH+K63vply/EKI9jzUB0rU8g+4TtIuALtUaSIZNyWKAskHS+qF8cwxLK9r1FO51D6o/vLDgvQEOpp3f/5HTzbTM/0VDAZcrtiQoTUN5QjPTd54eUI5JC2cbBHe/fQ3mDdScQ4QFNiiYujZFBw11mEB8zWgdkg1SYt2NBiw/N17l7JF60uggNwwIB2mUJMpmpwVHRKKYg04ZI8K1xBCrYRbGKrAlWSaZQkCrNRLhSm8OZtecMU7OX85ginqAgqTNxVqZ72KvZAUKqHFEsFhxfLQ6yzyW08i9RKsE66xIDUQCgVOVpiC0AWIxplKOGSlia2ThP01oOQC83WugnOEUrCSrjSNgxZ1YQiUyW+HUo/YEcPhkH88ecKdwfGtUyfIYcGnZy3SGgh/bNA6qBrrIBdE63Bvn6usoSsRsh18ZBCQ4S/Jsmymdz5O4He+IPcHX0WamR4M3v3lr3D1nVmFhqS5b+DBhddPO9AXJreP0c6n4xJVPZ4Go+z45PylL2tHIf7fGweWI7kqkZCvmuNS6t/DpUVvy2AQ0xxQt5KMZtcOBvA0+9llIDtiuTUZZzif+iiIxQJz72rFCC6EEwehODWEcCpqMZdKchXl8wc4FQ6XhtbwAG9L4Txkc6GhMPAw0w/D4dD/Y9LB4HmHusEAHuCUUDCqLeoihaYu/F+ErbmNmCqQcb+F57AL+xa+UfJFh1cv+ZtGqgIIGyvmagfM3lyoCYe1EjkWsJLFEp390uvAnjEawRBnwdpfi9RfMUW1GHJ++itedCiwfOxJd7Oq92uUAlK30vlWBQuebqLQ82auZA776k9LQQgC6vCxSz0l9a1PH206qUpa53NBEhadzOckFg7eGrrlm4JE0eKOdoZ2fCIsFMxhvcsXUgslA+AqYArq5J4a7UQeg/fHUCd8DkRl8vAd5jyq1WSWJKpKOJkLpdadkG+NKpCCjNe0FJrv2momtZUF9iUYnhPDcRGYOhlx3gtC3mCOTMPlaMjlCLDliqONk4s4HVgIyCQwKw2oi9pI7TpxPLF0shxJbBFEnptGO++RnLCQDriTUBUi+LCfGgz8dz/93cL3uOK60zUM/vgETpwTeemr4FsPN5g2dW3IzTR3k0z0320WAQnSgjYrsIEQCzA6BKl3Vcp6Mf62B4GgC2xPsD1gayKmukOuX3bUqfod+34aojmNqHsl9a2d6Sk6yGZJKQu8CfG+ibi8UZ4imXB3Q3iAhVAWM1Y5O389vYCxV6zTM+M0YzEdbHbhbbuyvW8sdBPjaOvWU4WC2bvU6YIn1ExnL84uYNzZOJ7IIvPG759z8mRQcmrMETVYRygqnlALn2aERaMLoR3UgkSFjiHImUlYmRYLL3IwqAkXUilfM7vAEbqGWI5F5nWo1rAgU3U2bwUOBtxzb9kB/eMFUFiJxI7KjbZNhX2EzoW1K0PF8JyMw5yhcf782y2i+DvHaSEV3tSReJZknV+7Ajo3xZr7jIaVIX+7L42oc1rXUaoddXI9ACczHeMZgNW5MYN//ROy88tHHvfHOwxdNMeTju5mn+wAJwcfDu7zH7j4skuzzj+vFwsOYI9erllkVI9f/7S8MYHKI/hDwD001GPoPZY6A3jHbxHpFE92vuvw6CdDA4r39VDnmQtFXvZp2Mc3Jt8bo7jB+voQ21AG4SXj8SXyHGuu2GxTTEcyCjnSC4mqAJGTsdZPWt4KLltkGod2BBclIQLTBzz3ZWYSejrfzl0US9FKrpqHnTzqlMHgaYEL0Sh35HuCH8bitMolV6GwzvfU7ZgaK1yQ00pcsZy+jNuQ/V3es6MImQqMVuuu+8W2HRYFXePLRF2TaYO4U6FDZnMj78jxjr0We3LQJvZOf9lDX1oEzY2GU1Ov4enp6RErJ2vJFXqmT0Djit2e51tvP6rXQhm99K2M7cE7af1wlc2S+S4fl/W+fm8Ldah+jLZ+uuijOA6DUh/Ms0pIBaIoCC3XDq5qWHC+9zpSbJGCJ+W50cOcLdttkIBeitE57gdA2j6gxQheyVvc2pCy+nvawFPb5CVPFCFLthkvi+yIZ4JWFtEPQTWOF8kixr3vSq1QDaa+k4cqxZ5Vkh3LYwpgVbs1CCKxhqfZ1XV29CWYSjovJbjWGZC6RIqH+6IPZtuTVkjlM/VsO1jHAXfnhHNCWITLN6/eM9xOw+ztB4lPGMj7SbB/2+1L+ODTuec+u4Q3uHzE/LEne3Y4yvwJyUrji9Sv4RuR364EFRZOTVULJ/3ov2ZSZmZwLBqe7eYd4TCPhCo8LaB95mHcPhs9619+3fxlQ0t0pbEIbbg4FCTRx8Nw25IW5p3fvVRtYE4YumZeCr3kRODha6dRSy78RZOHXPD6smjj3/lCQaMVWgvGlUgrHkK1YYzvu+PSIr+b4ww000O46kfTtzi30uH23bdarR55+sjzfNsoBd3jxyfcR16Lge2FdN81c3iDtbHSGVpvuZbSlc3cx3KXt/8jCugeKf0G7Ze8Ur3IC6TKglnAFKmV+UfMHzsmHx/NeDdzsM/ZX7sQLpC47ti9N7aoZXzPX3V6AKv3S+zgNV18q/hNIJe+sFj6+lCO3+ixCa8X0d643PqwvUmaKJmjtrizKTx5cf4K2s9Hx0m6syX7GbEcv3p5evb99IyViWmSTJJno+PRMR/VxrpK6J2bdvbph+ut++3+9L9ZvccdnMM7N66VkH7l6Y25j+vKq34Hfp0mpbGOj+7vOX8vSW02fPxjg8RL0Os0aQVJTnS/Ak27zR3vN29xzU7zg07ChKoJ67+Dne/e4vTF2UWSJqJhTXY3hrd+Yxh/YendJ73ekb2/SgwK8P+813wvw/192EZuNj19+PQfOaKBHTU78Hqz2fwb1kTzOw==","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Template list","permalink":"/docs/API-docs/v1.1/gettemplatelist"},"next":{"title":"Save or Update Webhook","permalink":"/docs/API-docs/v1.1/save-update-webhook"}}');var s=o(74848),n=o(28453),c=o(57742),l=o.n(c),a=o(78178),r=o.n(a),p=o(19624),d=o.n(p),u=o(96226),v=o.n(u),k=(o(77675),o(19365),o(51107));o(21312);const b={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:"eJy9WM1uHMcRfpXKCAjExewuZTsIsA4c0xQtC1EsQktGBy7B6Z2p3Wmzp3tc3TPLBbmAD0EeIMgl17xE7nkUPUlQ3T2zP1QkKw5ykEj2VFXXz1c/XfeJE0ubTK6StzgvjblNrtOkQJuTrJ00OpkkFyXCC3QQCeDk/CUIpcwK1qYBZ2CJDlbxY0MqSRNTIwlmf1kkk2SJrhOeJoS2NtqiTSb3yWfHx/xj/75pk+do7aJR0MtJ0iQ32qF2TC/qWsncfxj/YJnpPrF5iZXg39y6xmSSmPkPmLskTWpiMU6GK6OiO4TWkdTLJE3wTlS14qPSudpOxuO1aWgYOYYNqa8jySg3VbLZpImTzjNIraTGm864m8+Oj29+m2w2TPPF8RePjby0SKCNg4VpdPGr/519SGTow9Yd3v0hQ1j5zozfPDbjpW6FkoXHxIW5Rf3/tWT3eheuZ1XvKsV8WlTBJE/kvyd7pu6eByMt5g1Jt04mV/fJ3VDUchi+T66uN9dpUqErTcQ0KyxcmUyS8aqHt0Vqkazn51zYYskKXczN3cjUqK1caiXmlnE0FrUct89GnyWb9JBH1PUn0WMz/FQW68RS6uXH+K63vply/EKI9jzUB0rU8g+4TtIuALtUaSIZNyWKAskHS+qF8cwxLK9r1FO51D6o/vLDgvQEOpp3f/5HTzbTM/0VDAZcrtiQoTUN5QjPTd54eUI5JC2cbBHe/fQ3mDdScQ4QFNiiYujZFBw11mEB8zWgdkg1SYt2NBiw/N17l7JF60uggNwwIB2mUJMpmpwVHRKKYg04ZI8K1xBCrYRbGKrAlWSaZQkCrNRLhSm8OZtecMU7OX85ginqAgqTNxVqZ72KvZAUKqHFEsFhxfLQ6yzyW08i9RKsE66xIDUQCgVOVpiC0AWIxplKOGSlia2ThP01oOQC83WugnOEUrCSrjSNgxZ1YQiUyW+HUo/YEcPhkH88ecKdwfGtUyfIYcGnZy3SGgh/bNA6qBrrIBdE63Bvn6usoSsRsh18ZBCQ4S/Jsmymdz5O4He+IPcHX0WamR4M3v3lr3D1nVmFhqS5b+DBhddPO9AXJreP0c6n4xJVPZ4Go+z45PylL2tHIf7fGweWI7kqkZCvmuNS6t/DpUVvy2AQ0xxQt5KMZtcOBvA0+9llIDtiuTUZZzif+iiIxQJz72rFCC6EEwehODWEcCpqMZdKchXl8wc4FQ6XhtbwAG9L4Txkc6GhMPAw0w/D4dD/Y9LB4HmHusEAHuCUUDCqLeoihaYu/F+ErbmNmCqQcb+F57AL+xa+UfJFh1cv+ZtGqgIIGyvmagfM3lyoCYe1EjkWsJLFEp390uvAnjEawRBnwdpfi9RfMUW1GHJ++itedCiwfOxJd7Oq92uUAlK30vlWBQuebqLQ82auZA776k9LQQgC6vCxSz0l9a1PH206qUpa53NBEhadzOckFg7eGrrlm4JE0eKOdoZ2fCIsFMxhvcsXUgslA+AqYArq5J4a7UQeg/fHUCd8DkRl8vAd5jyq1WSWJKpKOJkLpdadkG+NKpCCjNe0FJrv2momtZUF9iUYnhPDcRGYOhlx3gtC3mCOTMPlaMjlCLDliqONk4s4HVgIyCQwKw2oi9pI7TpxPLF0shxJbBFEnptGO++RnLCQDriTUBUi+LCfGgz8dz/93cL3uOK60zUM/vgETpwTeemr4FsPN5g2dW3IzTR3k0z0320WAQnSgjYrsIEQCzA6BKl3Vcp6Mf62B4GgC2xPsD1gayKmukOuX3bUqfod+34aojmNqHsl9a2d6Sk6yGZJKQu8CfG+ibi8UZ4imXB3Q3iAhVAWM1Y5O389vYCxV6zTM+M0YzEdbHbhbbuyvW8sdBPjaOvWU4WC2bvU6YIn1ExnL84uYNzZOJ7IIvPG759z8mRQcmrMETVYRygqnlALn2aERaMLoR3UgkSFjiHImUlYmRYLL3IwqAkXUilfM7vAEbqGWI5F5nWo1rAgU3U2bwUOBtxzb9kB/eMFUFiJxI7KjbZNhX2EzoW1K0PF8JyMw5yhcf782y2i+DvHaSEV3tSReJZknV+7Ajo3xZr7jIaVIX+7L42oc1rXUaoddXI9ACczHeMZgNW5MYN//ROy88tHHvfHOwxdNMeTju5mn+wAJwcfDu7zH7j4skuzzj+vFwsOYI9erllkVI9f/7S8MYHKI/hDwD001GPoPZY6A3jHbxHpFE92vuvw6CdDA4r39VDnmQtFXvZp2Mc3Jt8bo7jB+voQ21AG4SXj8SXyHGuu2GxTTEcyCjnSC4mqAJGTsdZPWt4KLltkGod2BBclIQLTBzz3ZWYSejrfzl0US9FKrpqHnTzqlMHgaYEL0Sh35HuCH8bitMolV6GwzvfU7ZgaK1yQ00pcsZy+jNuQ/V3es6MImQqMVuuu+8W2HRYFXePLRF2TaYO4U6FDZnMj78jxjr0We3LQJvZOf9lDX1oEzY2GU1Ov4enp6RErJ2vJFXqmT0Djit2e51tvP6rXQhm99K2M7cE7af1wlc2S+S4fl/W+fm8Ldah+jLZ+uuijOA6DUh/Ms0pIBaIoCC3XDq5qWHC+9zpSbJGCJ+W50cOcLdttkIBeitE57gdA2j6gxQheyVvc2pCy+nvawFPb5CVPFCFLthkvi+yIZ4JWFtEPQTWOF8kixr3vSq1QDaa+k4cqxZ5Vkh3LYwpgVbs1CCKxhqfZ1XV29CWYSjovJbjWGZC6RIqH+6IPZtuTVkjlM/VsO1jHAXfnhHNCWITLN6/eM9xOw+ztB4lPGMj7SbB/2+1L+ODTuec+u4Q3uHzE/LEne3Y4yvwJyUrji9Sv4RuR364EFRZOTVULJ/3ov2ZSZmZwLBqe7eYd4TCPhCo8LaB95mHcPhs9619+3fxlQ0t0pbEIbbg4FCTRx8Nw25IW5p3fvVRtYE4YumZeCr3kRODha6dRSy78RZOHXPD6smjj3/lCQaMVWgvGlUgrHkK1YYzvu+PSIr+b4ww000O46kfTtzi30uH23bdarR55+sjzfNsoBd3jxyfcR16Lge2FdN81c3iDtbHSGVpvuZbSlc3cx3KXt/8jCugeKf0G7Ze8Ur3IC6TKglnAFKmV+UfMHzsmHx/NeDdzsM/ZX7sQLpC47ti9N7aoZXzPX3V6AKv3S+zgNV18q/hNIJe+sFj6+lCO3+ixCa8X0d643PqwvUmaKJmjtrizKTx5cf4K2s9Hx0m6syX7GbEcv3p5evb99IyViWmSTJJno+PRMR/VxrpK6J2bdvbph+ut++3+9L9ZvccdnMM7N66VkH7l6Y25j+vKq34Hfp0mpbGOj+7vOX8vSW02fPxjg8RL0Os0aQVJTnS/Ak27zR3vN29xzU7zg07ChKoJ67+Dne/e4vTF2UWSJqJhTXY3hrd+Yxh/YendJ73ekb2/SgwK8P+813wvw/192EZuNj19+PQfOaKBHTU78Hqz2fwb1kTzOw==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-2",custom_edit_url:null},h=void 0,m={},C=[];function j(e){const t={p:"p",...(0,n.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(k.default,{as:"h1",className:"openapi__heading",children:"Get Webhook"}),"\n",(0,s.jsx)(l(),{method:"get",path:"/webhook",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Get Webhook API allow you to get webhook url"}),"\n",(0,s.jsx)(r(),{parameters:void 0}),"\n",(0,s.jsx)(d(),{...o(48132)}),"\n",(0,s.jsx)(v(),{...o(67390)})]})}function U(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(j,{...e})}):j(e)}},48132(e){e.exports={title:"Body"}},67390(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"webhook":{"type":"string","example":"https://your-webhook-url@example.com"}},"title":"inline_response_200_7"}}}},"404":{"description":"User not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"User not found!"}},"title":"inline_response_404"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/98334e25.cbe389b6.js b/assets/js/98334e25.cbe389b6.js deleted file mode 100644 index a581c98a5..000000000 --- a/assets/js/98334e25.cbe389b6.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[7024],{92846(e,o,t){t.r(o),t.d(o,{assets:()=>g,contentTitle:()=>u,default:()=>f,frontMatter:()=>k,metadata:()=>s,toc:()=>I});const s=JSON.parse('{"id":"API-docs/v1.1/get-webhook","title":"Get Webhook","description":"The Get Webhook API allow you to get webhook url","source":"@site/docs/API-docs/v1.1/get-webhook.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/get-webhook","permalink":"/docs/API-docs/v1.1/get-webhook","draft":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJy9Vs1u20YQfpXpXtoItKSkKQroFCMwXKNGYtQOfLCFYEkOyY2Wu5vdoWRBEJBD36CnXvtoeZJilqREyUnatEUv+pmd//nmZyNIlkHM7sQtppW1CzFPRI4h88qRskbMxE2FcI4EHQOcXl2A1NquYG0bIAslEqy6x8ZrkQjr0EsWv8jFTJRIvfJEeAzOmoBBzDbi2XTKX4f2rpsswxCKRsNOj0hEZg2hIeaXzmmVxYfJu8BCGxGyCmvJv2jtUMyETd9hRiIRzrMaUq3JztEBYyCvTCkSgQ+ydppJFZELs8lkbRt/0kmcNF6/6FjGma3FdpsIUhQFlNHK4Ns+uLfPptO3P4rtlnmeT58/DvJNQA/GEhS2Mfk3/1186L31X47u2PaXAmHn+zB+eBzGhVlKrfKIiRu7QPP/RjI0T615dvWh1ixnZN2GFJniuzgIdUhvgwyYNV7RWszuNuLhRDp10r7P7ubbeSJqpMp2mGaHJVViJiarHbwD+iX6EOW5F/ZYCtLkqX0YW4cmqNJomQbG0UQ6NVk+HT8V2+RYRjr3VfzYnHytSCBZKlP+ldx8n5trrl9booMM7QolnfoZ1yLpCzDkSoRi3FQoc/SxWMoUNgp3ZXnt0Fyr0sSiRuPHA+kWdWZr5NFDFcJo1It8/PWPndRoBLnNmhoNRfiN7829ed14cHaFnoeLNDkUGh9UqjGKYR3fQj/XAspaYwh6DcoQll4SQq5KRVID50mZEjLpZKq0YtQym2VpDwPghzHcVkgVen761iNIyHGJmsEOsiFbS2JVvb+wsn5RaLsKCUhIm6AMhgBoKmkyZuwrkYD1IA2gIfTOq4AQyLPXqvXNGvIyI6ilkSWy7gSGycpRK4YreJs2gSBY3USXgaTS1mMOfUAGMQ8xiWcPjp+AqZmtnceKYbNEKBuVY0ggszlCiE3KIZgcUgwEjn1RGQZW2hhts0UsYNFoDc7yzFBSgy0OfGRx8tKEwvq69aWvwS5hzlteGdg6OBq9CcgVvlRmEWaj0b05gbsdrm4xDYpw/l3fAqvV6hH0nxzKnCv6qUnhF3Q2KLJ+vZcuFVVNGttlqGT3p9V0jgYjfgbNsNeR2yw87j6mTirUbnKNxAgJk9Orizhmn8DHD7/BJUpvoLKrFq1Z41GvoexNcebayrdp201JKGwEXsUZz1rweXzfYKA+g7eVpI8ffg/wClegTNdSHMpodNWkWmVwg7XTkjCMRjN46ZFNUk8DqiRBJg2kCKGSDKWlkiDBtdJamcUYTs0aGl5HK0VVBAPTo9xBGJyXXbkDpDJgDtZEid7meO8R0+uAeomBdfGuSxEwV8SIrrxtytba0JkuOI+F0hpuVV4ixdhO8xxcR161ZE74wB0suCGowjVIjxDQ0BiujkTiS+Oc9eyFap0vLF9SXAA0ubPKUJhB7mVBe/3JHugZp1lZ8wlSm0K5S0fSqdmVpO3ELuIddXzPQ/lokB/OW48FejYY2muvr4tTHZzuelgCo/XfwJr3M08tmcXzAWupdLtRXhzriascfR1eF9folyrrD7fPdPQkMk9EIrTK0AQcnAin51eXsPx+PBXJYD3+jeaeXF68PHt1fcbO8CBtE/Z0PB1PmeRsoFqagaXBIX281zb7w+mf3Nzd8iV8oInTUsVbJwaz6e6Uu93xO09EZQMxabPhZnrj9XbL5PcNer5+5olYSq9kyjv5br5N+pXNh80C15y0LEPHV9BS6qbd+0fH3sHFdH52IxLBU+fwVFjEU6H7wdr7J7Me6D68IVoH+JMPmk8KbDbtGbLd7vjbp89KdAH23JzA+Xa7/RPRNKSi","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Template list","permalink":"/docs/API-docs/v1.1/gettemplatelist"},"next":{"title":"Save or Update Webhook","permalink":"/docs/API-docs/v1.1/save-update-webhook"}}');var n=t(74848),i=t(28453),r=t(57742),p=t.n(r),l=t(78178),a=t.n(l),d=t(19624),c=t.n(d),h=t(96226),b=t.n(h),m=(t(77675),t(19365),t(51107));t(21312);const k={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:"eJy9Vs1u20YQfpXpXtoItKSkKQroFCMwXKNGYtQOfLCFYEkOyY2Wu5vdoWRBEJBD36CnXvtoeZJilqREyUnatEUv+pmd//nmZyNIlkHM7sQtppW1CzFPRI4h88qRskbMxE2FcI4EHQOcXl2A1NquYG0bIAslEqy6x8ZrkQjr0EsWv8jFTJRIvfJEeAzOmoBBzDbi2XTKX4f2rpsswxCKRsNOj0hEZg2hIeaXzmmVxYfJu8BCGxGyCmvJv2jtUMyETd9hRiIRzrMaUq3JztEBYyCvTCkSgQ+ydppJFZELs8lkbRt/0kmcNF6/6FjGma3FdpsIUhQFlNHK4Ns+uLfPptO3P4rtlnmeT58/DvJNQA/GEhS2Mfk3/1186L31X47u2PaXAmHn+zB+eBzGhVlKrfKIiRu7QPP/RjI0T615dvWh1ixnZN2GFJniuzgIdUhvgwyYNV7RWszuNuLhRDp10r7P7ubbeSJqpMp2mGaHJVViJiarHbwD+iX6EOW5F/ZYCtLkqX0YW4cmqNJomQbG0UQ6NVk+HT8V2+RYRjr3VfzYnHytSCBZKlP+ldx8n5trrl9booMM7QolnfoZ1yLpCzDkSoRi3FQoc/SxWMoUNgp3ZXnt0Fyr0sSiRuPHA+kWdWZr5NFDFcJo1It8/PWPndRoBLnNmhoNRfiN7829ed14cHaFnoeLNDkUGh9UqjGKYR3fQj/XAspaYwh6DcoQll4SQq5KRVID50mZEjLpZKq0YtQym2VpDwPghzHcVkgVen761iNIyHGJmsEOsiFbS2JVvb+wsn5RaLsKCUhIm6AMhgBoKmkyZuwrkYD1IA2gIfTOq4AQyLPXqvXNGvIyI6ilkSWy7gSGycpRK4YreJs2gSBY3USXgaTS1mMOfUAGMQ8xiWcPjp+AqZmtnceKYbNEKBuVY0ggszlCiE3KIZgcUgwEjn1RGQZW2hhts0UsYNFoDc7yzFBSgy0OfGRx8tKEwvq69aWvwS5hzlteGdg6OBq9CcgVvlRmEWaj0b05gbsdrm4xDYpw/l3fAqvV6hH0nxzKnCv6qUnhF3Q2KLJ+vZcuFVVNGttlqGT3p9V0jgYjfgbNsNeR2yw87j6mTirUbnKNxAgJk9Orizhmn8DHD7/BJUpvoLKrFq1Z41GvoexNcebayrdp201JKGwEXsUZz1rweXzfYKA+g7eVpI8ffg/wClegTNdSHMpodNWkWmVwg7XTkjCMRjN46ZFNUk8DqiRBJg2kCKGSDKWlkiDBtdJamcUYTs0aGl5HK0VVBAPTo9xBGJyXXbkDpDJgDtZEid7meO8R0+uAeomBdfGuSxEwV8SIrrxtytba0JkuOI+F0hpuVV4ixdhO8xxcR161ZE74wB0suCGowjVIjxDQ0BiujkTiS+Oc9eyFap0vLF9SXAA0ubPKUJhB7mVBe/3JHugZp1lZ8wlSm0K5S0fSqdmVpO3ELuIddXzPQ/lokB/OW48FejYY2muvr4tTHZzuelgCo/XfwJr3M08tmcXzAWupdLtRXhzriascfR1eF9folyrrD7fPdPQkMk9EIrTK0AQcnAin51eXsPx+PBXJYD3+jeaeXF68PHt1fcbO8CBtE/Z0PB1PmeRsoFqagaXBIX281zb7w+mf3Nzd8iV8oInTUsVbJwaz6e6Uu93xO09EZQMxabPhZnrj9XbL5PcNer5+5olYSq9kyjv5br5N+pXNh80C15y0LEPHV9BS6qbd+0fH3sHFdH52IxLBU+fwVFjEU6H7wdr7J7Me6D68IVoH+JMPmk8KbDbtGbLd7vjbp89KdAH23JzA+Xa7/RPRNKSi",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},u=void 0,g={},I=[];function N(e){const o={p:"p",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Get Webhook"}),"\n",(0,n.jsx)(p(),{method:"get",path:"/webhook",context:"endpoint"}),"\n",(0,n.jsx)(o.p,{children:"The Get Webhook API allow you to get webhook url"}),"\n",(0,n.jsx)(a(),{parameters:void 0}),"\n",(0,n.jsx)(c(),{...t(48132)}),"\n",(0,n.jsx)(b(),{...t(67390)})]})}function f(e={}){const{wrapper:o}={...(0,i.R)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(N,{...e})}):N(e)}},48132(e){e.exports={title:"Body"}},67390(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"webhook":{"type":"string","example":"https://your-webhook-url@example.com"}},"title":"inline_response_200_7"}}}},"404":{"description":"User not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"User not found!"}},"title":"inline_response_404"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/9c9cb35e.3ccdac05.js b/assets/js/9c9cb35e.3ccdac05.js new file mode 100644 index 000000000..c18535948 --- /dev/null +++ b/assets/js/9c9cb35e.3ccdac05.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[4240],{41875(e,n,t){t.r(n),t.d(n,{assets:()=>j,contentTitle:()=>y,default:()=>w,frontMatter:()=>g,metadata:()=>i,toc:()=>f});const i=JSON.parse('{"id":"API-docs/v1.1/createtemplate","title":"Create Template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.","source":"@site/docs/API-docs/v1.1/createtemplate.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/createtemplate","permalink":"/docs/API-docs/v1.1/createtemplate","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createtemplate","title":"Create Template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.","sidebar_label":"Create Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztPe1yHDdyr4KMU5G4N7vcXZGyTCeXoyidrZwtsUTqVA6pkNgZ7C7EGWAMzHC5pll1P67yAKn8yd97ifzPo/hJUt34GMx+kSIlmU7WVba5g69Go9FodDe6L6OSjnS0cxQdsrzIaMl09C6OUqYTxYuSSxHtRIdjRlwx2VOMwneyu/+C0CyTE00qzZQmpSQJFDKSVLqUOf+JDjJGStdxTCZjnoyJZuqcEarJIKtYobgoNRlKRUZMMEVLLkYklUmVMyiY8HJMCsVSNuSCpUSXqkrKSjHdIW8KKYiukoRpPawyP5IBg0sRk3LMEFDFykoJTSipBP+xYqTVcrVPeNpqkXJMS5JQQQYMppPCbCxALABnQKFMCuxYFyzhQw6VbV+dY3EsDnmxQ94UmaQpmcpKkf1nf/RdQL/w7ajVesYG1Yi8edFqvXs4LstC72xu0qLoyIIJzUciowPdSWS+mULFIh1uAAaZYtArwsqo5tmU0DQlE56OWKlxxoIkspiSREqVcmFQX9ARI6LKB0zpmFCRklwqRrgglChG02m7lO1KM/IvB69ewnLktOyQ/azSsR8u5YolZTY13QMG3KweGMw83oL14WIUk5yewULykvxY8eQMpq2ZQLTaNUFctVoHVVFIVbKUvDVT2Gm1oOQpy+SEUMWwfiLzXApSUEVzViK1wYJBsWI/Vlyx1JAKzTKHi51j0SatlqA522m1yBuz8DxlooRVU0h05Zhr26Bj6pfTAuu/EClPAHkIAHwlctisCkiFqgeWEEzVANVAKYboAYcTata/yGhipqUY0FDJz1mz44uYTKHjZ0xIB8FYKv6TFCXNcPnOmSp5QrNwmQFAJMySKtxHheSidF/tCOQHu5yw2riIlg4BtBSQm3OBJZqRc5pVTFuoJjEZA1SvWaGYxv1g+wXEi5SMGR+Nl45H0/eVLhsdk0oDmCEUdiy3qohehmgb0kwzwocNXOb0jAWjEYlMi2Yd8nRKUjakVVbGhAOFlqpiHfJSloQWRcYT5E5AA7DZKPCUNq6yJZ9Ok3z2lTznKQMWkvLhkCnYzFCIXdg2DjqgywIbwPRwp5VjKogUMwudyEyqeRLCz008kkSKkomyQ3bPKc8QeDNZTbhIsiplZJDR5CxGvhoTxVKz0acMuHRs9gdWAeZrcI74IZplQIVSAPxC2uG5rjlchxzCRvH7DwodqnEQrkOs2l0+lDAyoMBtScJyyrMYEReT93JASl5mLIYNXlAxjUlKSxaTkl2UA3kRk2TMkjP8S9GUSzKoyhIYO4yZKlmkciIsLodSlJr/tGBHupIPx2g/JlsxeRyTJzHpdWPS68ektxWT3uOY9J7EpN+NSb8fk/5WTPqPDVj9JxbX1CM4BKDXN1guf1vYHfOUnUDDE5jbCdUlU1yfAbsmb+HMYQKAS82ZCxX9MclHcHL7E5BrMuZpygQZKpkTxRJecOQmhhv4rmOAhyiYlNBkWGXZlJxzzQMc+E7lRADecESuyKuCiQM+EoQmiaxgjRHDBqmIznrJRTYFUA8ZzTXO/LkomSoU1wxYtdAeA6KsacscgPAtZAA3WUnR5EDLV3PZ6gQrAyfod1wjz4WjT/vTdNI4TXsd0mp5PgffTk9Pj8XlsSDkOAK2dxztkOPIVzmOYlMGpxmU9ezvC/jxqP+l/TmFn4/7T+zPCVbtbdmfY/jZd03t5oJvODDW4KI0Q1sGSwIQoNLVsbiy0B6LPk6jpHmxYgpQ/LnAd8cUfITzJXYFsAXn4VkyY1NjbraPYLZc8JLTTC+fsKtxj+Y8A9LiadeV5ma+BTNHZrZ82lh8j+YcwgMleIiaIjx0gyJ3HCAU/RUomu1zGROGVigezWFyu2NlmOWINFO4N3gMwPlYaJzp8sOx+BiwCOfpIZyny1Hpj9x7hM9ZmD4WUhf1++GY/bKDUjCKJ8vxaivcI6w2IfpYOJ3v9cMx+gQwCnLecnRC6T3CZQAOFFih2ZR1t9q97Xa/299q4BPUE6ZCnrfTtD2dTu+2FjkXJwYOaBTUz+nF4gLQmoDs6FfCl4AEw8XIN2uWzq+6qTezkCBxWkyA0Onun0bqBaUUCs/zygW8+9e17I0H/3YX8u/hGj5wN1SWWrE50Gc5/U94hy5lSqcPtOnKNfVXL6g/KxwbMLEI4EBdWDKWPLHAQx134RqAuqcDOGjjom6m6WawqPAxTdt53p75CD/bSAPBxzzvpGlnpuYcoZiPOUnTmMx/Xvg9TUme50s+m++Nz5t5Pj+LTp5b2Cz2HO3NrXPOBc8ruCKBWs3c0KEi3DIsenO7llyQVuuHH374of399+1nz1ott4Z2CEvFgSbDjEAvPtIIIdG3WjvkxZCEn1CbYPQ4yAX8zRDVva7CWE6EuxDhtVGRtAKFoqtqtEk5nWJnjJdjpprjSFWTLFwf4bY1kOW4Q97g7RL+drcwf1vCm9RXHdQK49V4Oe+0FT4X+6y5ZHPglax1OWtq8NY5scgxpmKx3KTYqMqoYheg/tNcijmeeJsz8MPOtxm26Gi5VrWgYtGqdpnTdJCHr+wlfMPrF2fmAr3tWssFUWzELkhBy5IpgZ2d04ynxvDRxg/sguYF6FY2/+34OP3d32+iZheUp6VRKaR8xEEhv/lvR7vtf323oEZVFEwlVDOSMRhJx4SVSYccjVlW1DaByWTSmTzSyVjKzBgE3mvFhua/J3Lw/gTBLTpUFxuLZmqIIdCkArHMKlJxcwYYo5q4lgt0qbg0uGt6XZTgrKpihQhna9wjuWMGJCg0amkoPoKjH4VbIF5W/y2B5xxH7+rjHrWnLL2m7bsbbE/YDRkdsGy+6MO3VkansrI72lkLmlO1FB3gzYpCXiGM0+nGQSG9mCk0ZVcL9qlBSLhN3WnvtqdbAZJx7Q+SBjrD1tZmgJYfwYyNbsCIa0AGnkrvvAs8YDfbBk5Bimt3zRBQj2BFb69xo10zQmNh5k5yKys4w9PQ9+pQ5g7yEF/QEqy3tZiwYgQrKywfwdpPlwxwLHqohnTqyxX3E1vjHvGKGZBWb+PbcJHGyXybI/VWG9BNK9yAC45XqGoOVr/59PLd1yGvjE7dNQJ9e5KwAiStO29ND/KNTyjUGocq9OWUF9a6R9S3AKxPTIG23sc+fW5FpOHsf0OE2gD7xsRqlP45Ha3Q32DxPSLPEJ7FKg5bY05Z1UNNvzlRVmiosXz1hHvdxoS3mxN+3L3Fjasx7N0vXN0V+JkbCu7WVUbnjoOUJTynGbqQINz9O+zR21y+LGCwB/ZkXlRluOlQrYOMxUkJzjHCmHZ/F5N2TFox2YzJw5hsdMhrhq4UiXe7sEIDV8a5gguSygrspEmlsikZKJh4TFhn1CGXlz9WVJS8nF5dkRa5vARvraurDuzCMyEnxvPiCGzGJQHPqfpSlcpEL/C0konehNvX5ks2aT+zxuVNC9oGeShnWMLKq6hFwee9kRmoAiKBUV56kc3cStHVh+sio1NCh2CnNu4g2Mx4DXUAxTukT/7p96TX73S7Memav8lDN8H+Bu5htDElLFtlpMTi63ZwN9zB9c9FLGu7e6MtHA57yx0MXZygEwGOe63AVm/ue6g6qSczq6wNpHrAmTk/9VhWWQqnp3GgZN6Br5bp0TZGy5ImY/SRXE4DQaV7dHjVUFkWtPIgG/KMLbJYgyPGvmJDnmWBIyNxnxxzA8cwlrHcOs9ZF0a416HTBhelBAbivFparQEbSnDYAE9K1JDS2tXRLIKRYRrOMOj/KhUZU20UTkhysHTgKlqOWT7jOuLAq91HuHCww3r2Pp5qtP9Vc5c/3m6s7XbzoF66y5ct7QqNKTTRhRTaG0ZZXRRsP+zTfZ+/Y81uKdcpLDd6DtUOUMjNcQdl/IyFTJcL7cRVC+WsQ+DeWEpd17A+efYA0jtNXz+pwN1vo+N9ZO5q/+t9+aghTT35jPa/5ip1tzZ725srDYAztqIPvzUTcpMlRfPCjZYUa9ZruraO3cU6dvcd8ehjaqh7X/YbZ9OjVVLKPdFQhzvqGt30x9BA3+qSv0gVHO7DGyqBP5sy9u5kufUp1FIzjPvL3q+glroric5pnz4aUZKPpXpaRJk30D2tVDjdmXJDYD859W5/HD3VzKXvq4Y0+FU/pNbt7btR66yWKiC544j/+emr15Pun74Zyd3d3d2XB2/Gz9+Mdnd3c/jd6XQW6i4XkQEOA/KzfRFlj3gUF5aM0ul00G+BlnQHm28WYvS1aR8vb9OxjomfyKCy/bkNKnfnG77q5zmzFllPPh1nuNueJfafYxHFkSzwpaUUL9JoJzKvNt0bxijG5WO6fCrTabRzGdl3MvCnfbcATTffa3gdehnpZMxyCn+5ZYf3pHBRjuLIePHoKI7QVxQelwJZRjuRHLxnSRnF4G1SgIGAaegD2+1culrmPWEUW5E/2onMtojiyHpg+E+EiUSCO1uRDqOrGHs6KajWE6nSlV36L3WX0IGB+AMbavzDvwiFfuAN3y27waZXMw9yb9VT2MNVvS51Z1QpOo1m3/66x3vOJch6ZTk9aDZ15xIvQUHpX5RhtSiOeMnycJQlq67kh2M6YRJmgj7yt1le4EW3aVeMpbhVQ+vde5um7+Xg5FbkWK/1yc1x3CSB5ls66MULHO7plvcgtQ59hZLwKLtDduFRE0ut1L5TuwqCuccrkjd2jE/qmMLD8JJkjIJeSgSPgZrPJs85m0APO+Q1Sxg/t7CFj6yhCrpZfW0cH7BvIWded9ICCNt1BW3MEzD7vdnt19B+FiL//riDnJWJKgf25zeAATWKIzcUsMBgd5p6V3FE8R37CbCw26zSBN7gaQaOuvACTVQ5UzwhplcCvcKR4h9LuyPM7mdQDZqaMHv42Jh5p0FTvf6jre3HALNF5gIucsN9b0rnZ9ucW5OK/ONMvxSxeUIV+ydF8R1eQrpDffbVHQpmsdWTx0ZLHpNAp925jhE7cJGJ0FE4cdPr3MQPlz0nD16xWh09LQpGVQdfdd86wADGcKBZUmEYBS+2NGbmQfUz613F0cX1k7kgiWy7t+rkYcaGpXGBJIlUgqmN0KX93kyuv7V1FUfT66c3/U1O70tYvMn1s3uLj/zrAAi/BqyPnlzF0fh6WL/1YQh+RWC3Hl/VIuSMiH0ykOn0xDHPq+sqOlkN6kEQjRfilUqZChAxkDJjVMxhApzwjQrhAVzDHsTG8RjfG3OlnZxGJmCjUuYo9ceCOeXsXcAwVMdgwQL9HD7gNUZXAw21hOtPmw4HjJSKj0YMDhxbAxvb9/GMYjQYYd2ha0N0odg5l5V24IEdCxh3xsA0ZbwD/IOAUM8RYCd4cGDm3jjD4IvF5gkXJxJanJgnEDdA61t71oaINZMx8HKIbSOTMzhnYc+bo9VHunBSSiVKnuGz7QJwn7p3DoBAFFdm50zRMbNDnouhVAnTxEAc4LZGC14n8brGNEHh4EGAnQd4v8y0Rw55ZnCIC/oAVUVNjOEnEFPgLD6Rw2HGBUPSvBUdunnC3UJXA/CJpyauDDgp+Hg7ZjukziLCdR3kx4YVsDEDBGEX4KxPM1JKmaF8Y2ICKBTrbj5BE8fg1eH+DeaFirm2AczGFkDKN32QV4f7EKeFD+2VGd6g+N3hthttVDGS2jmnToLx5/3UyLHM2KPkAiHNRkhpk3mAUq4XQhSbEE6AQh/Eaa7jOvAPbFtZlWBG5jaogS5ZoVcg8lBWN+FU12CSklGFT9VKYOMuaAs+majjrHBhokOhjsa+G1p4K3F4cliBSkH/MWFCm+aUDNGvIoa4UYB5VYFGxnfJLgqmOPgvLUSBYgZ1J5VaeEVdddF68/o7G+4pkNMdX3UdwwYokGqQU8yxmNmpz98NmQDWt+wuPC+OoleWvf8VTGkpQMUk1YgK/pMhYZRSQUM1YGOamar2+ABTJrK5uUuFO39/+evfAriWXu7nATMj0DQFD5trIEQ1nCF4YECKFXAqyiZE0B9Tf5gVDCLPBHOZ+o2kb07j+/gESHsWaN0yvFuIrpIx6FL8GazDiw3edDTq9XyQFVnAfNkF12UQQMRdyuf5w2v72q+GwRxTaWp46TTc4LW7ipzpDkOd8GYoIS8azR8cVSlPFMu5uJnsEto+SukZQVXKnJY8Ia4r3WkGiDImebev89pbDajxnEu1sRC8kufsUO7ZE/cZnerrBU1og9KhbUVSOkWMuAhytdjILgqupv5NLlr7HSavuV1tIyOByZ5IkTCQV9g5Uze4kgRufwDYgJUTxkSIObeE0ksLJigNCgyNFZt5wNnAIUCYMzViJwlc7XFPsBsscasFXbVapG0AsRxfV8pqym3oN2RtwOXq3gEcqwfw75drcSmMuNch38oJICwmBSiWjFLV9A/4JAi5jVsUjpBQgY9HQUkPAX0COQQew6Bnqh3CeFMhKeFsXhidaGIU9dALhCqDceJVc3Lc3T/MphBuzI3uJB6YHOi2Cc0k7vZyvCjOEgL1AiNNjfF01EY9xEszjgv/hlLSL3/5Lw1SqHXG1R2YwtJSdFpD6RFf0Ya9us3mtqPVis3uNiFLPpyeSHFSc7mFBNNsuZKAFjjANQUtYc8IHNzJW0DpQB2AaHPGwv+air+59V0+GCDkIw34UpYMtJIjqtLMn2lmGUsMskhDQjJDLaMG1OstITujw2IYnCplBYRplPa6YA7gB3VAK1hPUF8xcYJmp5vo/uyhfRWs5lEE1ik0NaVRbGxz0burOBokyW17hPP8D/Y3HtQxfuo3vs0FNx0kCXk4yDigh6qBNMEzN3asqE5T2Icohs1I7Y1FNchHdtKQv3hwcfUmODTCgT3gM08VZvqp52jJw7iOLtL/rjYvOdHF3Howxmk+gDc76AaL93uUcWVtYWoqlD+ZRnqVZtdqkdd63d+Q4rPX7f5f1us+6v529Lpb3d+QXvcJAGtdLa7nJsvu1Qt5h3MdWd3gvWTGmJxJtbomnK3gB2EdXRYhuN4O/SvzT62Kdkz8GvW00V/Xrh9Wteomg2jod7vwvxkm2AjXDUoVH8o7m/5dFN/c72T1GpjPLxa6gNTIejruf6sLkSfjCG8zWjc5+YIm10wgxBsXqC51SDnpd7sn25HB99Yi5BzInBm5fYIvU5QEgc9eYEo1JXQENxAYXn1EXDGlrqOqD4NsFRK2ut2TnkfC9jwSXggMUoER3A/lGROfd6bh8KUZHkC9yLN6a0fcVMLyqDHZ8LuZpGZJpXg5jXaOLqOLNi1425TvHL27egdUV44leGQVUiPEtBxHO9HmnIMWhtAH2fvoMkLVYuRYnqYiBeflObZHC7553uv0o6t4ts1CNrmiPqvaH9pEl3TExei6du9qHB3AOpqlamCqlusK/icGgp1diLBWHHGgnzGjoGsC1AN5vK7d2p67RXYOZ4t8yOZcyKKoXt9ZPy/n5tXw3Jo9wRb4YgWuWEfODwpdm7xnU1TPMfLeR1EU+BPBj8BDKIpmfH5qb5SGk4lz5Aj8OI7q/eC9FZxQ20NpsL+1hWLTlz2ULx49waN76/HVO7N6gXkSPT+X2NjsdX6RNckWBXaYxhdjULCfmgp2nHio0G5olWeVyksVvEv0uw7kph7Tfl2kPuxtL1PcbS/Ul9muFutGbGF48V58ibZ36JtfEj+sdnC1W0A1Tppp0gw4eQPNPOoizWx1kWaedBuClF2xuodaHEKZx4s8drq1WAOyyzvY5FwMJXIIuw98FHDg4MhhZjfkFz5S+C9//ZuvBtqX35NW6xCfYDHR1rJSCSPwINxEFc/Q1oiJG375y3+SQcUzEwc8Zecsg3MGUnGoStuAE8yHFNcdE5E7HHeEHmyYOMBfpdGwlRprVhszdBDWrs3ywHRASiXlWMlqNEZtkhiBi9Pr5weHkA4FcmyQA9Dm1PbURroDyNIh4BYapGgpFeQHcGYjXdKyQkOCYmBZ5eBNhf5xRg3PjCIbbM8q0AhkfMiSaZIZ5JiUHMZweM5EKhUB43ibmwDm7XYb/vfFF+Qbo9ciBxDCkqXw9TnsF++DgAbQhCo1NeP6g9lpgE+DQ+CUGPaPg6BTd1C4Q/4Reqg//N6/5G21fvn3/yBH38pJIwdMc8CbBxI4MJPSm7v7L1CG2TDr/xLjDyrmbHzgDT7i4p9BJ4NzabXsWU6YOOdKCkAtOE2e3visP8U7TqFkKW1mC2u+HQ4hxpMYkQwoGN4dzCzFHmhb9mhBBzzjIDLB95/JHi3ZSKop+Zm8Bf25zwwjyc/H4ud2u43/QtVWy4VP0K0W+dnkDWLGRSMmVWH87xQ7l2eWplKGNpQ6G4db9pp8bc8+VxH2/LTiWUoUq3Qz35DPHdTGQAg+JP7XPhMNeJhKBbtg6i1hdogDlg3bsD9xiG8cFWj4PKNa1TVevQOIOOel0ZoNIY2N7XS/GmQ8IU3wD8aoTSeFKXRbL+PiDLePcLoufGVQe3A6LCs6LMlbqc5gJNMj+I7U0KGl0OEEfLShhXH0HHJBM66tpQxFdtfvHqSaSezifW/4BO4BC0xiyslAyjMgsZGiORrm0CncdvJHmYGdCft4hQZYHUJmn8x6Nv1MATkOTSPXx1s2GEt5Zjqx7r7IjtpofmPnmIglUFRqYigTHUAIE6nJgmO7Q5Wn7atUnIGe0+SIMCpykCjAn9moAGAFf25uDSB8NIi8ZBPgO+7AgMIvyG4dTcCEASA2wdGxgNPkNPAXPXXaIoxGOgke30MQVlxWh6rYZdaqP5gKbmF9hfoDzMbSlPeZ2d1/oTsO1G8B9wdmNQ8s1X3HxZk+FmBQPbURJqwk6YKsZljDvushPxsrzymAfLr/6uCQbCJgDs5T/1QtsHU48q4t1I3JEnfwd2q07oE5iKk6DZldPJodi9Nvnh+STTfHzR2enuLkm99h85wat6oBGEF1qRjNM0wqBttMsbQSKTyuC5JMmfxSuTwHW5xIIeWTDegAPNMtnI+N4Sx12dToBO2c6w5bLZ8Zy+tHMIuXcelJpNBVzvwK7dubR3tfydJ4e4Dxz1MUlMM6Na4px9Gpw6tjoKCmMSbdiVRn3BkNmUjUtLC9ghk9IMCdY2HXs3n5PCX/89/kdP/NHMbxc9DArebmTpBoLaw2QyczBTPjYQEwX0DpqcPPK3Nv8NQLPEvJzNPv/O1iFeHOThRpaMFMwRnhAhQPHFyirF8CiH7W68CO50kdo8WCd2AjSxzAbzffawkxRQx/sMfQKTFqC6Qv8w4MTMGnx+HFDlZ6yBkomhMlwXc/y3zuO6JkVTI08Stmnm0YevZsZsec6TA6nKLGO6JScye5hemUtPx7DTwTUBhzng8rX20Y3ntqnkKc1mx85tXGUDpvPeOPYE8/HzvFvgIwnbnnFNDdHhX27YiY+ursArBmz+Tal5UrdGcxXB1Zi7GI7YHv4cO9vQ0AziYkOha7RLAJoD1JamzP8Ws0xPvoD94P5/QYrmJ1OykC/l0zasP98N2Fky78Km4aQckv5vPQyYlpFAmMA4SHsbbeGVtfG70qb2Gt/A5erPo5gOswaUBDHjpPJbNL6h3P09ONwC/PgwbrpTCJmnm7aHk5qt1jPMkNlwLMZtz6PwC4RTklaMcjD0+P3p1ufE0keIwaP2ZAbSkJF2OmeLmg6xnZts729bwWrK2AG3yBPQEqTfDDmxduD4zsjYLEBwjkXhL0d7tmDyv1Y7718zfgFjDX+Dq93OmsKPNnpiAwEKzRP5CnNDmbUJVqjOtGS46i/xSqQmMgDpOCa+AqthNbMTNXC3LeM6kJe52ev/k5+Us73xnwiDk3A1tHkiAVl3FwGDi8Y69CkoFi5tRMxlSMYCOA8BUc1BwYf1olZi8gvNC1T71VCeNBAc+HJ9z6AKUzhPFGM7g3WxkIHogdedH0LRtoXrJmVO5ZTG9gmz9WWUbc5Qc33DW3RdPsG15+Ww0guaLUvJRqWrca8XJcDXAtw7b+h+3AXVK8uvwut1Ts8pCpHP1ODpg658k109+E3JF6cwNdfmaUtk21C7oSAd/RjTs2Lbi9zx85OEgzFvqHz8PYyvCugmp/q/ujBV/o2YlTeDW087Ua7NXzjeIo4wmzhjurxtr9Zv87cv6o0wU9mleF32AtN797sff85cFzAMZuE9DUdrqdLvoXSF3mVAQjmYu1l4xnVVzB8+11It91It91It91It91It91It/7nGp2nch3nch3nch3nch3ncj3V5/zOpHvOpHvOpHv/cDnOpHvOpHvBwfyXify9QXrRL7rRL7H60S+60S+x+tEvvcjG806ke86ke9HkeHWiXzXiXzXiXzXiXzXiXx/Q/lR14l8PwcFrhP5rhP53jpFyjqR76JNtU7ku07ku07ke+OcTutEvp9g964T+c6RyDqR7zqR7zqR7zqR7zqR7/20jq0T+a4T+a4T+a4T+a4T+a4T+X5ULdU6ke86ke//00S+Qdi1zSKjHENQ2mQzJnrk0Wx633dxNIbwkjtH0eUlkOYblV1dwecfKwxOd/Qujs6p4vCoASNTxi6QIgR6O2MQcHDPvLhpH8L4sVlwfFU7E5ATIkGaFruIg5V1wwiYEJIDYtrZFMS5CVio6AQCw9GJifUXRI/Db5dRRsWowshzkenzymQeGTcDR55h4Ej7RxC+DqIp1hA2I0qaacB/YVILG1xemqCUV1e+vila2sIi1tWG9Xt3dXX1v6v20Xc=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Draft Template","permalink":"/docs/API-docs/v1.1/drafttemplate"},"next":{"title":"Public Template","permalink":"/docs/API-docs/v1.1/publictemplate"}}');var s=t(74848),r=t(28453),o=t(57742),l=t.n(o),a=t(78178),d=t.n(a),c=t(19624),p=t.n(c),h=t(96226),m=t.n(h),u=(t(77675),t(19365),t(51107)),x=t(21312);const g={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:"eJztPe1yHDdyr4KMU5G4N7vcXZGyTCeXoyidrZwtsUTqVA6pkNgZ7C7EGWAMzHC5pll1P67yAKn8yd97ifzPo/hJUt34GMx+kSIlmU7WVba5g69Go9FodDe6L6OSjnS0cxQdsrzIaMl09C6OUqYTxYuSSxHtRIdjRlwx2VOMwneyu/+C0CyTE00qzZQmpSQJFDKSVLqUOf+JDjJGStdxTCZjnoyJZuqcEarJIKtYobgoNRlKRUZMMEVLLkYklUmVMyiY8HJMCsVSNuSCpUSXqkrKSjHdIW8KKYiukoRpPawyP5IBg0sRk3LMEFDFykoJTSipBP+xYqTVcrVPeNpqkXJMS5JQQQYMppPCbCxALABnQKFMCuxYFyzhQw6VbV+dY3EsDnmxQ94UmaQpmcpKkf1nf/RdQL/w7ajVesYG1Yi8edFqvXs4LstC72xu0qLoyIIJzUciowPdSWS+mULFIh1uAAaZYtArwsqo5tmU0DQlE56OWKlxxoIkspiSREqVcmFQX9ARI6LKB0zpmFCRklwqRrgglChG02m7lO1KM/IvB69ewnLktOyQ/azSsR8u5YolZTY13QMG3KweGMw83oL14WIUk5yewULykvxY8eQMpq2ZQLTaNUFctVoHVVFIVbKUvDVT2Gm1oOQpy+SEUMWwfiLzXApSUEVzViK1wYJBsWI/Vlyx1JAKzTKHi51j0SatlqA522m1yBuz8DxlooRVU0h05Zhr26Bj6pfTAuu/EClPAHkIAHwlctisCkiFqgeWEEzVANVAKYboAYcTata/yGhipqUY0FDJz1mz44uYTKHjZ0xIB8FYKv6TFCXNcPnOmSp5QrNwmQFAJMySKtxHheSidF/tCOQHu5yw2riIlg4BtBSQm3OBJZqRc5pVTFuoJjEZA1SvWaGYxv1g+wXEi5SMGR+Nl45H0/eVLhsdk0oDmCEUdiy3qohehmgb0kwzwocNXOb0jAWjEYlMi2Yd8nRKUjakVVbGhAOFlqpiHfJSloQWRcYT5E5AA7DZKPCUNq6yJZ9Ok3z2lTznKQMWkvLhkCnYzFCIXdg2DjqgywIbwPRwp5VjKogUMwudyEyqeRLCz008kkSKkomyQ3bPKc8QeDNZTbhIsiplZJDR5CxGvhoTxVKz0acMuHRs9gdWAeZrcI74IZplQIVSAPxC2uG5rjlchxzCRvH7DwodqnEQrkOs2l0+lDAyoMBtScJyyrMYEReT93JASl5mLIYNXlAxjUlKSxaTkl2UA3kRk2TMkjP8S9GUSzKoyhIYO4yZKlmkciIsLodSlJr/tGBHupIPx2g/JlsxeRyTJzHpdWPS68ektxWT3uOY9J7EpN+NSb8fk/5WTPqPDVj9JxbX1CM4BKDXN1guf1vYHfOUnUDDE5jbCdUlU1yfAbsmb+HMYQKAS82ZCxX9MclHcHL7E5BrMuZpygQZKpkTxRJecOQmhhv4rmOAhyiYlNBkWGXZlJxzzQMc+E7lRADecESuyKuCiQM+EoQmiaxgjRHDBqmIznrJRTYFUA8ZzTXO/LkomSoU1wxYtdAeA6KsacscgPAtZAA3WUnR5EDLV3PZ6gQrAyfod1wjz4WjT/vTdNI4TXsd0mp5PgffTk9Pj8XlsSDkOAK2dxztkOPIVzmOYlMGpxmU9ezvC/jxqP+l/TmFn4/7T+zPCVbtbdmfY/jZd03t5oJvODDW4KI0Q1sGSwIQoNLVsbiy0B6LPk6jpHmxYgpQ/LnAd8cUfITzJXYFsAXn4VkyY1NjbraPYLZc8JLTTC+fsKtxj+Y8A9LiadeV5ma+BTNHZrZ82lh8j+YcwgMleIiaIjx0gyJ3HCAU/RUomu1zGROGVigezWFyu2NlmOWINFO4N3gMwPlYaJzp8sOx+BiwCOfpIZyny1Hpj9x7hM9ZmD4WUhf1++GY/bKDUjCKJ8vxaivcI6w2IfpYOJ3v9cMx+gQwCnLecnRC6T3CZQAOFFih2ZR1t9q97Xa/299q4BPUE6ZCnrfTtD2dTu+2FjkXJwYOaBTUz+nF4gLQmoDs6FfCl4AEw8XIN2uWzq+6qTezkCBxWkyA0Onun0bqBaUUCs/zygW8+9e17I0H/3YX8u/hGj5wN1SWWrE50Gc5/U94hy5lSqcPtOnKNfVXL6g/KxwbMLEI4EBdWDKWPLHAQx134RqAuqcDOGjjom6m6WawqPAxTdt53p75CD/bSAPBxzzvpGlnpuYcoZiPOUnTmMx/Xvg9TUme50s+m++Nz5t5Pj+LTp5b2Cz2HO3NrXPOBc8ruCKBWs3c0KEi3DIsenO7llyQVuuHH374of399+1nz1ott4Z2CEvFgSbDjEAvPtIIIdG3WjvkxZCEn1CbYPQ4yAX8zRDVva7CWE6EuxDhtVGRtAKFoqtqtEk5nWJnjJdjpprjSFWTLFwf4bY1kOW4Q97g7RL+drcwf1vCm9RXHdQK49V4Oe+0FT4X+6y5ZHPglax1OWtq8NY5scgxpmKx3KTYqMqoYheg/tNcijmeeJsz8MPOtxm26Gi5VrWgYtGqdpnTdJCHr+wlfMPrF2fmAr3tWssFUWzELkhBy5IpgZ2d04ynxvDRxg/sguYF6FY2/+34OP3d32+iZheUp6VRKaR8xEEhv/lvR7vtf323oEZVFEwlVDOSMRhJx4SVSYccjVlW1DaByWTSmTzSyVjKzBgE3mvFhua/J3Lw/gTBLTpUFxuLZmqIIdCkArHMKlJxcwYYo5q4lgt0qbg0uGt6XZTgrKpihQhna9wjuWMGJCg0amkoPoKjH4VbIF5W/y2B5xxH7+rjHrWnLL2m7bsbbE/YDRkdsGy+6MO3VkansrI72lkLmlO1FB3gzYpCXiGM0+nGQSG9mCk0ZVcL9qlBSLhN3WnvtqdbAZJx7Q+SBjrD1tZmgJYfwYyNbsCIa0AGnkrvvAs8YDfbBk5Bimt3zRBQj2BFb69xo10zQmNh5k5yKys4w9PQ9+pQ5g7yEF/QEqy3tZiwYgQrKywfwdpPlwxwLHqohnTqyxX3E1vjHvGKGZBWb+PbcJHGyXybI/VWG9BNK9yAC45XqGoOVr/59PLd1yGvjE7dNQJ9e5KwAiStO29ND/KNTyjUGocq9OWUF9a6R9S3AKxPTIG23sc+fW5FpOHsf0OE2gD7xsRqlP45Ha3Q32DxPSLPEJ7FKg5bY05Z1UNNvzlRVmiosXz1hHvdxoS3mxN+3L3Fjasx7N0vXN0V+JkbCu7WVUbnjoOUJTynGbqQINz9O+zR21y+LGCwB/ZkXlRluOlQrYOMxUkJzjHCmHZ/F5N2TFox2YzJw5hsdMhrhq4UiXe7sEIDV8a5gguSygrspEmlsikZKJh4TFhn1CGXlz9WVJS8nF5dkRa5vARvraurDuzCMyEnxvPiCGzGJQHPqfpSlcpEL/C0konehNvX5ks2aT+zxuVNC9oGeShnWMLKq6hFwee9kRmoAiKBUV56kc3cStHVh+sio1NCh2CnNu4g2Mx4DXUAxTukT/7p96TX73S7Memav8lDN8H+Bu5htDElLFtlpMTi63ZwN9zB9c9FLGu7e6MtHA57yx0MXZygEwGOe63AVm/ue6g6qSczq6wNpHrAmTk/9VhWWQqnp3GgZN6Br5bp0TZGy5ImY/SRXE4DQaV7dHjVUFkWtPIgG/KMLbJYgyPGvmJDnmWBIyNxnxxzA8cwlrHcOs9ZF0a416HTBhelBAbivFparQEbSnDYAE9K1JDS2tXRLIKRYRrOMOj/KhUZU20UTkhysHTgKlqOWT7jOuLAq91HuHCww3r2Pp5qtP9Vc5c/3m6s7XbzoF66y5ct7QqNKTTRhRTaG0ZZXRRsP+zTfZ+/Y81uKdcpLDd6DtUOUMjNcQdl/IyFTJcL7cRVC+WsQ+DeWEpd17A+efYA0jtNXz+pwN1vo+N9ZO5q/+t9+aghTT35jPa/5ip1tzZ725srDYAztqIPvzUTcpMlRfPCjZYUa9ZruraO3cU6dvcd8ehjaqh7X/YbZ9OjVVLKPdFQhzvqGt30x9BA3+qSv0gVHO7DGyqBP5sy9u5kufUp1FIzjPvL3q+glroric5pnz4aUZKPpXpaRJk30D2tVDjdmXJDYD859W5/HD3VzKXvq4Y0+FU/pNbt7btR66yWKiC544j/+emr15Pun74Zyd3d3d2XB2/Gz9+Mdnd3c/jd6XQW6i4XkQEOA/KzfRFlj3gUF5aM0ul00G+BlnQHm28WYvS1aR8vb9OxjomfyKCy/bkNKnfnG77q5zmzFllPPh1nuNueJfafYxHFkSzwpaUUL9JoJzKvNt0bxijG5WO6fCrTabRzGdl3MvCnfbcATTffa3gdehnpZMxyCn+5ZYf3pHBRjuLIePHoKI7QVxQelwJZRjuRHLxnSRnF4G1SgIGAaegD2+1culrmPWEUW5E/2onMtojiyHpg+E+EiUSCO1uRDqOrGHs6KajWE6nSlV36L3WX0IGB+AMbavzDvwiFfuAN3y27waZXMw9yb9VT2MNVvS51Z1QpOo1m3/66x3vOJch6ZTk9aDZ15xIvQUHpX5RhtSiOeMnycJQlq67kh2M6YRJmgj7yt1le4EW3aVeMpbhVQ+vde5um7+Xg5FbkWK/1yc1x3CSB5ls66MULHO7plvcgtQ59hZLwKLtDduFRE0ut1L5TuwqCuccrkjd2jE/qmMLD8JJkjIJeSgSPgZrPJs85m0APO+Q1Sxg/t7CFj6yhCrpZfW0cH7BvIWded9ICCNt1BW3MEzD7vdnt19B+FiL//riDnJWJKgf25zeAATWKIzcUsMBgd5p6V3FE8R37CbCw26zSBN7gaQaOuvACTVQ5UzwhplcCvcKR4h9LuyPM7mdQDZqaMHv42Jh5p0FTvf6jre3HALNF5gIucsN9b0rnZ9ucW5OK/ONMvxSxeUIV+ydF8R1eQrpDffbVHQpmsdWTx0ZLHpNAp925jhE7cJGJ0FE4cdPr3MQPlz0nD16xWh09LQpGVQdfdd86wADGcKBZUmEYBS+2NGbmQfUz613F0cX1k7kgiWy7t+rkYcaGpXGBJIlUgqmN0KX93kyuv7V1FUfT66c3/U1O70tYvMn1s3uLj/zrAAi/BqyPnlzF0fh6WL/1YQh+RWC3Hl/VIuSMiH0ykOn0xDHPq+sqOlkN6kEQjRfilUqZChAxkDJjVMxhApzwjQrhAVzDHsTG8RjfG3OlnZxGJmCjUuYo9ceCOeXsXcAwVMdgwQL9HD7gNUZXAw21hOtPmw4HjJSKj0YMDhxbAxvb9/GMYjQYYd2ha0N0odg5l5V24IEdCxh3xsA0ZbwD/IOAUM8RYCd4cGDm3jjD4IvF5gkXJxJanJgnEDdA61t71oaINZMx8HKIbSOTMzhnYc+bo9VHunBSSiVKnuGz7QJwn7p3DoBAFFdm50zRMbNDnouhVAnTxEAc4LZGC14n8brGNEHh4EGAnQd4v8y0Rw55ZnCIC/oAVUVNjOEnEFPgLD6Rw2HGBUPSvBUdunnC3UJXA/CJpyauDDgp+Hg7ZjukziLCdR3kx4YVsDEDBGEX4KxPM1JKmaF8Y2ICKBTrbj5BE8fg1eH+DeaFirm2AczGFkDKN32QV4f7EKeFD+2VGd6g+N3hthttVDGS2jmnToLx5/3UyLHM2KPkAiHNRkhpk3mAUq4XQhSbEE6AQh/Eaa7jOvAPbFtZlWBG5jaogS5ZoVcg8lBWN+FU12CSklGFT9VKYOMuaAs+majjrHBhokOhjsa+G1p4K3F4cliBSkH/MWFCm+aUDNGvIoa4UYB5VYFGxnfJLgqmOPgvLUSBYgZ1J5VaeEVdddF68/o7G+4pkNMdX3UdwwYokGqQU8yxmNmpz98NmQDWt+wuPC+OoleWvf8VTGkpQMUk1YgK/pMhYZRSQUM1YGOamar2+ABTJrK5uUuFO39/+evfAriWXu7nATMj0DQFD5trIEQ1nCF4YECKFXAqyiZE0B9Tf5gVDCLPBHOZ+o2kb07j+/gESHsWaN0yvFuIrpIx6FL8GazDiw3edDTq9XyQFVnAfNkF12UQQMRdyuf5w2v72q+GwRxTaWp46TTc4LW7ipzpDkOd8GYoIS8azR8cVSlPFMu5uJnsEto+SukZQVXKnJY8Ia4r3WkGiDImebev89pbDajxnEu1sRC8kufsUO7ZE/cZnerrBU1og9KhbUVSOkWMuAhytdjILgqupv5NLlr7HSavuV1tIyOByZ5IkTCQV9g5Uze4kgRufwDYgJUTxkSIObeE0ksLJigNCgyNFZt5wNnAIUCYMzViJwlc7XFPsBsscasFXbVapG0AsRxfV8pqym3oN2RtwOXq3gEcqwfw75drcSmMuNch38oJICwmBSiWjFLV9A/4JAi5jVsUjpBQgY9HQUkPAX0COQQew6Bnqh3CeFMhKeFsXhidaGIU9dALhCqDceJVc3Lc3T/MphBuzI3uJB6YHOi2Cc0k7vZyvCjOEgL1AiNNjfF01EY9xEszjgv/hlLSL3/5Lw1SqHXG1R2YwtJSdFpD6RFf0Ya9us3mtqPVis3uNiFLPpyeSHFSc7mFBNNsuZKAFjjANQUtYc8IHNzJW0DpQB2AaHPGwv+air+59V0+GCDkIw34UpYMtJIjqtLMn2lmGUsMskhDQjJDLaMG1OstITujw2IYnCplBYRplPa6YA7gB3VAK1hPUF8xcYJmp5vo/uyhfRWs5lEE1ik0NaVRbGxz0burOBokyW17hPP8D/Y3HtQxfuo3vs0FNx0kCXk4yDigh6qBNMEzN3asqE5T2Icohs1I7Y1FNchHdtKQv3hwcfUmODTCgT3gM08VZvqp52jJw7iOLtL/rjYvOdHF3Howxmk+gDc76AaL93uUcWVtYWoqlD+ZRnqVZtdqkdd63d+Q4rPX7f5f1us+6v529Lpb3d+QXvcJAGtdLa7nJsvu1Qt5h3MdWd3gvWTGmJxJtbomnK3gB2EdXRYhuN4O/SvzT62Kdkz8GvW00V/Xrh9Wteomg2jod7vwvxkm2AjXDUoVH8o7m/5dFN/c72T1GpjPLxa6gNTIejruf6sLkSfjCG8zWjc5+YIm10wgxBsXqC51SDnpd7sn25HB99Yi5BzInBm5fYIvU5QEgc9eYEo1JXQENxAYXn1EXDGlrqOqD4NsFRK2ut2TnkfC9jwSXggMUoER3A/lGROfd6bh8KUZHkC9yLN6a0fcVMLyqDHZ8LuZpGZJpXg5jXaOLqOLNi1425TvHL27egdUV44leGQVUiPEtBxHO9HmnIMWhtAH2fvoMkLVYuRYnqYiBeflObZHC7553uv0o6t4ts1CNrmiPqvaH9pEl3TExei6du9qHB3AOpqlamCqlusK/icGgp1diLBWHHGgnzGjoGsC1AN5vK7d2p67RXYOZ4t8yOZcyKKoXt9ZPy/n5tXw3Jo9wRb4YgWuWEfODwpdm7xnU1TPMfLeR1EU+BPBj8BDKIpmfH5qb5SGk4lz5Aj8OI7q/eC9FZxQ20NpsL+1hWLTlz2ULx49waN76/HVO7N6gXkSPT+X2NjsdX6RNckWBXaYxhdjULCfmgp2nHio0G5olWeVyksVvEv0uw7kph7Tfl2kPuxtL1PcbS/Ul9muFutGbGF48V58ibZ36JtfEj+sdnC1W0A1Tppp0gw4eQPNPOoizWx1kWaedBuClF2xuodaHEKZx4s8drq1WAOyyzvY5FwMJXIIuw98FHDg4MhhZjfkFz5S+C9//ZuvBtqX35NW6xCfYDHR1rJSCSPwINxEFc/Q1oiJG375y3+SQcUzEwc8Zecsg3MGUnGoStuAE8yHFNcdE5E7HHeEHmyYOMBfpdGwlRprVhszdBDWrs3ywHRASiXlWMlqNEZtkhiBi9Pr5weHkA4FcmyQA9Dm1PbURroDyNIh4BYapGgpFeQHcGYjXdKyQkOCYmBZ5eBNhf5xRg3PjCIbbM8q0AhkfMiSaZIZ5JiUHMZweM5EKhUB43ibmwDm7XYb/vfFF+Qbo9ciBxDCkqXw9TnsF++DgAbQhCo1NeP6g9lpgE+DQ+CUGPaPg6BTd1C4Q/4Reqg//N6/5G21fvn3/yBH38pJIwdMc8CbBxI4MJPSm7v7L1CG2TDr/xLjDyrmbHzgDT7i4p9BJ4NzabXsWU6YOOdKCkAtOE2e3visP8U7TqFkKW1mC2u+HQ4hxpMYkQwoGN4dzCzFHmhb9mhBBzzjIDLB95/JHi3ZSKop+Zm8Bf25zwwjyc/H4ud2u43/QtVWy4VP0K0W+dnkDWLGRSMmVWH87xQ7l2eWplKGNpQ6G4db9pp8bc8+VxH2/LTiWUoUq3Qz35DPHdTGQAg+JP7XPhMNeJhKBbtg6i1hdogDlg3bsD9xiG8cFWj4PKNa1TVevQOIOOel0ZoNIY2N7XS/GmQ8IU3wD8aoTSeFKXRbL+PiDLePcLoufGVQe3A6LCs6LMlbqc5gJNMj+I7U0KGl0OEEfLShhXH0HHJBM66tpQxFdtfvHqSaSezifW/4BO4BC0xiyslAyjMgsZGiORrm0CncdvJHmYGdCft4hQZYHUJmn8x6Nv1MATkOTSPXx1s2GEt5Zjqx7r7IjtpofmPnmIglUFRqYigTHUAIE6nJgmO7Q5Wn7atUnIGe0+SIMCpykCjAn9moAGAFf25uDSB8NIi8ZBPgO+7AgMIvyG4dTcCEASA2wdGxgNPkNPAXPXXaIoxGOgke30MQVlxWh6rYZdaqP5gKbmF9hfoDzMbSlPeZ2d1/oTsO1G8B9wdmNQ8s1X3HxZk+FmBQPbURJqwk6YKsZljDvushPxsrzymAfLr/6uCQbCJgDs5T/1QtsHU48q4t1I3JEnfwd2q07oE5iKk6DZldPJodi9Nvnh+STTfHzR2enuLkm99h85wat6oBGEF1qRjNM0wqBttMsbQSKTyuC5JMmfxSuTwHW5xIIeWTDegAPNMtnI+N4Sx12dToBO2c6w5bLZ8Zy+tHMIuXcelJpNBVzvwK7dubR3tfydJ4e4Dxz1MUlMM6Na4px9Gpw6tjoKCmMSbdiVRn3BkNmUjUtLC9ghk9IMCdY2HXs3n5PCX/89/kdP/NHMbxc9DArebmTpBoLaw2QyczBTPjYQEwX0DpqcPPK3Nv8NQLPEvJzNPv/O1iFeHOThRpaMFMwRnhAhQPHFyirF8CiH7W68CO50kdo8WCd2AjSxzAbzffawkxRQx/sMfQKTFqC6Qv8w4MTMGnx+HFDlZ6yBkomhMlwXc/y3zuO6JkVTI08Stmnm0YevZsZsec6TA6nKLGO6JScye5hemUtPx7DTwTUBhzng8rX20Y3ntqnkKc1mx85tXGUDpvPeOPYE8/HzvFvgIwnbnnFNDdHhX27YiY+ursArBmz+Tal5UrdGcxXB1Zi7GI7YHv4cO9vQ0AziYkOha7RLAJoD1JamzP8Ws0xPvoD94P5/QYrmJ1OykC/l0zasP98N2Fky78Km4aQckv5vPQyYlpFAmMA4SHsbbeGVtfG70qb2Gt/A5erPo5gOswaUBDHjpPJbNL6h3P09ONwC/PgwbrpTCJmnm7aHk5qt1jPMkNlwLMZtz6PwC4RTklaMcjD0+P3p1ufE0keIwaP2ZAbSkJF2OmeLmg6xnZts729bwWrK2AG3yBPQEqTfDDmxduD4zsjYLEBwjkXhL0d7tmDyv1Y7718zfgFjDX+Dq93OmsKPNnpiAwEKzRP5CnNDmbUJVqjOtGS46i/xSqQmMgDpOCa+AqthNbMTNXC3LeM6kJe52ev/k5+Us73xnwiDk3A1tHkiAVl3FwGDi8Y69CkoFi5tRMxlSMYCOA8BUc1BwYf1olZi8gvNC1T71VCeNBAc+HJ9z6AKUzhPFGM7g3WxkIHogdedH0LRtoXrJmVO5ZTG9gmz9WWUbc5Qc33DW3RdPsG15+Ww0guaLUvJRqWrca8XJcDXAtw7b+h+3AXVK8uvwut1Ts8pCpHP1ODpg658k109+E3JF6cwNdfmaUtk21C7oSAd/RjTs2Lbi9zx85OEgzFvqHz8PYyvCugmp/q/ujBV/o2YlTeDW087Ua7NXzjeIo4wmzhjurxtr9Zv87cv6o0wU9mleF32AtN797sff85cFzAMZuE9DUdrqdLvoXSF3mVAQjmYu1l4xnVVzB8+11It91It91It91It91It91It/7nGp2nch3nch3nch3nch3ncj3V5/zOpHvOpHvOpHv/cDnOpHvOpHvBwfyXify9QXrRL7rRL7H60S+60S+x+tEvvcjG806ke86ke9HkeHWiXzXiXzXiXzXiXzXiXx/Q/lR14l8PwcFrhP5rhP53jpFyjqR76JNtU7ku07ku07ke+OcTutEvp9g964T+c6RyDqR7zqR7zqR7zqR7zqR7/20jq0T+a4T+a4T+a4T+a4T+a4T+X5ULdU6ke86ke//00S+Qdi1zSKjHENQ2mQzJnrk0Wx633dxNIbwkjtH0eUlkOYblV1dwecfKwxOd/Qujs6p4vCoASNTxi6QIgR6O2MQcHDPvLhpH8L4sVlwfFU7E5ATIkGaFruIg5V1wwiYEJIDYtrZFMS5CVio6AQCw9GJifUXRI/Db5dRRsWowshzkenzymQeGTcDR55h4Ej7RxC+DqIp1hA2I0qaacB/YVILG1xemqCUV1e+vila2sIi1tWG9Xt3dXX1v6v20Xc=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-2",custom_edit_url:null},y=void 0,j={},f=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Create Template"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/createtemplate",context:"endpoint"}),"\n",(0,s.jsxs)(n.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,s.jsx)(n.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Unique identifier for this widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Specify the hint for widgets. This parameter is optional and is not applicable to the following widgets: checkbox, radio button, dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "hint": "Provide signature"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp",\n "hint": "Provide stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials",\n "hint": "Provide initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide email",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide name",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide job title",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide company",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12,\n "min_date": "",\n "max_date": "",\n "readonly": false,\n "signing_date": false,\n "hint": "Provide date"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"min_date:"})," Provide the minimum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"max_date:"})," Provide the maximum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"signing_date"}),": If signing_date is set to true, the signing date is shown to the signer during signing. You may set either signing_date or default, but not both. Using both is not supported."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image",\n "hint": "Provide image"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"14",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Provide number",\n "formula": "",\n "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,s.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"decimalplaces:"})," Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"15",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"cells"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "cells",\n "page": 1,\n "x": 100,\n "y": 100,\n "w": 114,\n "h": 50,\n "options": {\n "name": "cells",\n "required": true,\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"cell_count:"})," Specify the number of cells that should be returned to the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"16",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"attachments"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "attachments",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "attachment widget",\n "hint": "Provide files"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,s.jsx)(n.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "required": true,\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "response": "04/15/2024",\n "format": "mm/dd/yyyy",\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "required": true,\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 528,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "values": ["male", "female", "other"],\n "response": "female",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(x.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{...t(16078)}),"\n",(0,s.jsx)(m(),{...t(79076)})]})}function w(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}},16078(e){e.exports=JSON.parse('{"title":"Body","body":{"content":{"application/json":{"schema":{"required":["file","signers","title"],"type":"object","properties":{"file":{"type":"string","format":"base64","example":"base64 encoded pdf"},"file_password":{"type":"string","format":"string","example":""},"title":{"type":"string","format":"string","example":"sample template"},"note":{"type":"string","format":"string","example":"sample note"},"description":{"type":"string","format":"string","example":"sample description"},"signers":{"type":"array","description":"You can provide signer optionally if you it as default signer","items":{"type":"object","properties":{"role":{"type":"string","format":"string","example":"ceo"},"email":{"type":"string","format":"string","example":""},"name":{"type":"string","format":"string","example":""},"phone":{"type":"string","format":"string","example":""},"company":{"type":"string","format":"string","example":""},"job_title":{"type":"string","format":"string","example":""},"signer_role":{"type":"string","format":"string","description":"Specifies the role of the recipient in the signing process. Allowed values:\\n- **signer** (default): Must have at least one signature widget.\\n- **viewer**: Receives the document to view only; must have no widgets.\\n- **approver**: Reviews and approves the document; no signature widget required.\\n","enum":["signer","viewer","approver"],"example":"signer"},"access_code":{"type":"string","format":"string","description":"when set, this numeric access code is required for the signer to access and sign the document.","example":"123456"},"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Allowed values include signature, stamp, initials, email, name, job title, company, date, textbox, checkbox, dropdown, radio button, image, number, cells, attachments.","format":"string","example":"signature"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":244},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":71},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":38},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":46}},"title":"createtemplate_body_widgets"}}},"title":"createtemplate_body_signers"}},"sendInOrder":{"type":"boolean","description":"If set to \'true\', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to \'true\'.","example":true},"send_in_order_strict":{"type":"boolean","description":"When set to \'true\', each signer is blocked from accessing the document until all preceding signers have completed their action. Enforces strict sequential signing. Only applies when \'sendInOrder\' is also \'true\'. Defaults to \'false\'.","example":false},"allow_offline_sign":{"type":"boolean","description":"If set to \'true\', signers can submit a copy of documents created from this template signed using an external tool for owner review. Defaults to \'false\'.","example":false},"enableOTP":{"type":"boolean","description":"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.","example":false},"enableTour":{"type":"boolean","description":"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.","example":false},"redirect_url":{"type":"string","description":"Specifies the URL where the signer will be redirected upon completing the document signing process.","example":""},"sender_name":{"type":"string","description":"The name of the person or organization on whose behalf the email is being sent.","example":"opensign\u2122"},"sender_email":{"type":"string","description":"The email address of the person or organization that users can reply to.","example":"mailer@opensignlabs.com"},"allow_modifications":{"type":"boolean","description":"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.","example":false},"auto_reminder":{"type":"boolean","description":"Set to true to enable automatic reminders. Set to false to disable them (default behavior).","example":false},"timeToCompleteDays":{"type":"number","description":"time to complete days is used to calculate expiry date of your document","format":"number","example":15},"remind_once_in_every":{"type":"number","description":"Number of days between reminders. This is only applicable when auto_reminder is set to true.","example":5},"merge_certificate":{"type":"boolean","description":"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\\n\\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\\n\\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\\n","example":false},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed. \\n"},"cc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"cc (carbon copy): Users added here will receive a notification email once the document is completed.\\n"},"prefill":{"type":"object","description":"You can provide widgets which can embed before sending to signer","properties":{"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","format":"string","example":"textbox"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":100},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":30},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":40},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":80},"options":{"type":"object","properties":{"name":{"type":"string","example":"textbox"},"response":{"type":"string","example":"joe"},"color":{"type":"string","example":"red"},"fontsize":{"type":"number","example":12}}}}}}},"title":"prefill"}},"title":"createtemplate_body"}}},"required":true}}')},79076(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Template created successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","example":"Bh2Hspnmch"},"message":{"type":"string","example":"Template created successfully!"}},"title":"inline_response_200_5"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/9c9cb35e.e9f5b614.js b/assets/js/9c9cb35e.e9f5b614.js deleted file mode 100644 index 7a509caae..000000000 --- a/assets/js/9c9cb35e.e9f5b614.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[4240],{41875(e,n,t){t.r(n),t.d(n,{assets:()=>f,contentTitle:()=>y,default:()=>w,frontMatter:()=>g,metadata:()=>s,toc:()=>j});const s=JSON.parse('{"id":"API-docs/v1.1/createtemplate","title":"Create Template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.","source":"@site/docs/API-docs/v1.1/createtemplate.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/createtemplate","permalink":"/docs/API-docs/v1.1/createtemplate","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createtemplate","title":"Create Template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.","sidebar_label":"Create Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztPdtyG7eSv4Kd2irbPMMRSUu2o63dOortTbwnsVW2vKmspMOAMyAJawaYABhRjIpV5+H8wT7t6/m0fMlWN4C58KarHXl38uCIg1uj0d1odDcal4GhEx3sHwdHLMtTapgOTsMgYTpWPDdcimA/OJoy4ovJS8UofCcHh28ITVM506TQTGliJImhkJG40EZm/Dc6ShkxvuOQzKY8nhLN1DkjVJNRWrBccWE0GUtFJkwwRQ0XE5LIuMgYFMy4mZJcsYSNuWAJ0UYVsSkU0xH5mEtBdBHHTOtxkZYjWTC4FCExU4aAKmYKJTShpBD814KRTsfXHvKk0yFmSg2JqSAjBtNJYDYOIFYDZ0ShTArsWOcs5mMOlV1f0Yk4EUc83ycf81TShMxlocjhq38vu4B+4dtxp/OKjYoJ+fim0zl9PDUm1/s7OzTPI5kzoflEpHSko1hmOwlUzJPxE8AgUwx6RVgZ1TydE5okZMaTCTMaZyxILPM5iaVUCRcW9TmdMCKKbMSUDgkVCcmkYoQLQoliNJl3jewWmpH/+PDuLSxHRk1EDtNCh+VwCVcsNuncdg8Y8LN6ZDHzbBfWh4tJSDJ6BgvJDfm14PEZTFszgWh1a4K46nQ+FHkulWEJ+clOYb/TgZJvWSpnhCqG9WOZZVKQnCqaMYPUBgsGxYr9WnDFEksqNE09LvZPRJd0OoJmbL/TIR/twvOECQOrppDozJRr1yCy9c08x/pvRMJjQB4CAF+JHDerAlKh6gdHCLZqDdVAKZboAYczatc/T2lsp6UY0JDh56zZ8UVI5tDxKyakh2AqFf9NCkNTXL5zpgyPaVpfZgAQCdNQhXyUSy6M/+pGID+75YTVxkV0dAigJYDcjAss0Yyc07Rg2kE1C8kUoHrPcsU08oPrFxAvEjJlfDLdOB5NPhXaNDomhQYw61C4sfyqInoZom1MU80IHzdwmdEzVhuNSBRaNI3It3OSsDEtUhMSDhRqVMEi8lYaQvM85TFKJ6ABYDYKMqWLq+zIJ2qSz6GS5zxhIEISPh4zBcwMhdiFa+OhA7rMsQFMDznNTKkgUiwtdCxTqVZJCD838UhiKQwTJiIH55SnCLydrCZcxGmRMDJKaXwWolwNiWKJZfQ5AykdWv7AKiB8Lc4RP0SzFKhQCoBfSDc815WEi8gRMErJf1DoUY2DcF3HquPysYSRAQWeJQnLKE9DRFxIPskRMdykLAQGz6mYhyShhoXEsAszkhchiacsPsO/FE24JKPCGBDsMGaiZJ7ImXC4HEthNP9tDUf6kptjdBCS3ZA8C8mLkPR7IekPQtLfDUn/WUj6L0Iy6IVkMAjJYDckg2cWrMELh2taIrgOQH9gsWy+LuxOecKG0HAIcxtSbZji+gzENfkJ9hwmALjE7rlQsdwm+QR27nIH5JpMeZIwQcZKZkSxmOccpYmVBmXXIcBDFExKaDIu0nROzrnmNRyUncqZALzhiFyRdzkTH/hEEBrHsoA1RgxbpCI6qyUX6RxAPWI00zjz18IwlSuuGYhqoUsMCFPRlt0A4VtdAFxnJUVTAm1ezU2rU1sZ2EF/4BplLmx9utxNZ43dtB+RTqeUc/Dtl19+ORGXJ4KQkwDE3kmwT06CsspJENoy2M2grO9+X8CPp4Pn7uccfj4bvHA/Z1i1v+t+TuHnwDd1zAXfcGCswYWxQzsBS2ogQKXFiVg4aE/EAKdhaJZvmQIUfynw/TYFH2F/CX0BsOAqPBtmbGuszPYpzJYLbjhN9eYJ+xoPaM5LIK2fdlVpZea7MHMUZpunjcUPaM51eKAEN1FbhJturchvBwjFYAuKlvvcJIShFapHK5jci5wOsxmRdgoPBo81cO4LjUtd3hyLzwCLsJ8ewX66GZXllvuA8LkM030hdV2/N8fs8wi1YFRPNuPVVXhAWG1CdF84Xe315hh9ARgFPW8zOqH0AeGyBg4UOKXZlvV2u/297qA32G3gE8wTtkKWdZOkO5/P77YWGRdDCwc0qtXP6MX6ArCagO5YrkRZAhoMF5OyWbN0ddVtvaWFBI3TYQKUTn/+tFovGKVQeV41LuDZv6rlTjz4tz+Q/wjH8JE/obLEqc01e5a3/9TP0EYmdP5I26580/LoBfWXlWMLJhYBHGgLi6eSxw54qOMPXCMw90SAgy4u6k6S7NQWFT4mSTfLuksf4WcXaaD2McuiJImWaq4Qiv2YkSQJyerntd+ThGRZtuGz/d74vJNlq7OIsszB5rDnaW9lnTMueFbAEQnMavaEDhXhlOHQm7m15IJ0Oj///PPP3R9/7L561en4NXRDOCquWTLsCPTinkaoE32ns0/ejEn9E1oTrB0HpUB5MkRzr68wlTPhD0R4bFQkKcCg6Ktaa1JG59gZ42bKVHMcqSqSheMjnLZG0kwj8hFPl/C3P4WVpyU8SX0ToVUYj8abZaer8KXEZyUlmwNvFa2bRVNDtq6oRV4w5ev1JsUmRUoVuwDzn+ZSrMjE2+yBN9vflsSip+XK1IKGRWfaZd7SQR6/c4fwJ6V9cWku0NuB81wQxSbsguTUGKYEdnZOU55Yx0cXP7ALmuVgW9n568lJ8qd/3kHLLhhPjTUpJHzCwSC/89fjg+5/na6pUeQ5UzHVjKQMRtIhYSaOyPGUpXnlE5jNZtHsqY6nUqbWIfBJKza2/w7l6NMQwc0jqvMn62ZqiaFmSQViWTakInPWMEY18S3X2FJxaZBr+j3U4JypYosK52o8IL1jCSQotGZpKD6GrR+VWyBeVv0tQeacBKfVdo/WU5Zc0fb0GuwJ3JDSEUtXi27OWimdy8JxtPcWNKfqKLqGN6cKlQZhnE4vrBXSi6VCW7ZYw6cWIXU29bu9Z0+/AiTlutxIGuist3Y+A/T8CGZ9dCNGfAMyKqn0zlxQAnY9NvAGUly7K4aAegQrlv4aP9oVIzQWZmUnd7qCdzyNy149yvxGXscXtATvbaUmbBnB6QqbR3D+0w0DnIg+miG9+XLL+cTVeECyYgmk7Wx8GynS2Jlvs6XeigH9tOoMuGZ7hap2Yy2ZT2/mvoi8szZ13wjs7XHMctC07syaJcjX3qHQalw3oW+mvHqtB0R9a8D6zBTo6t337nMrIq3P/isi1AbY1yZWa/TP6GSL/QaLHxB51uFZb+JwNVaMVX209NsdZYuFGsu3T7jfa0x4rznhZ71bnLgaw979wNXbgp+VoeBsXaR0ZTtIWMwzmmIICcI9uAOP3ubw5QADHngps7wwdaZDsw4KFq8l+MAI69r9U0i6IemEZCckj0PyJCLvGYZSxGXYhVMauLLBFVyQRBbgJ40Llc7JSMHEQ8KiSUQuL38tqDDczBcL0iGXlxCttVhEwIVnQs5s5MUx+IwNgcip6lCVyFivibSSsd6B09fOWzbrvnLO5R0H2hPyWC6JhK1HUYeCL3sis1DViARGeVuqbPZUiqE+XOcpnRM6Bj+1DQfBZjZqKAIU75MB+dd/I/1B1OuFpGf/Jo/9BAdPkIfRxxSzdJuTEouv4uBenYOrn+tE1l7vWixcH/aWHAxdDDGIAMe9UmGrmPsBmk6qySwba2taPeDM7p96Kos0gd3TBlCyMoCv1OkhAuFQsTFP01oEH/GfPFdDRBRLWeaixlzsHhxoMFqBCyOBc3w4R6czYmMJkQoQQoimQVrF+NnR7ebdiALBwE+pyJRqa2lBXAPMECNppixbipnw4FVxE1x42IGY+/dnExx80yTvZ3sN8t5r7lAbyXsTDW8xFUITnUuhS48gq4pqdId9+u+rh4tlWvKdwnJjyEwV+YNiDEkn5WesLm240F5Pc1AuR8K9nEqpqxouGM1JXr3fDHKTCuLcnkRlcMhdHV/9508basSLL+j4aq5Sb3env7ez1fO15CS5+XGRkOssKdrVr7WkWLNa09YtdBe30N054ul9mmb7zweNE8XTbdvzAzHN1jnqCqPsfZheb3W6XWcDrfPhNa2fX8wKeXey3P0c9pglwf28/wfYY+5Koitml3sjSnJfNpd1lHkNo8tWS8udKbcO7Gen3r37MdAsnXa+aWiD3wzq1Lq3dzdqXTbP1EjuJOD/+e2797PeX76byIODg4O3Hz5OX3+cHBwcZPA7iqK1Rrt1ZIDDgP7srgK5LR7VhQ2jRFGEDntq6D4238nF5F9s+3Bzm8hF5H0mT8Lel/Yk3F1ulFW/zJ61zm3w+STD3XiWuP9ORBAGMscrhlK8SYL9wF5X9Jf3ghCXj2nzrUzmwf5l4C6IwJ8uYB+a7nzScC3yMtDxlGUU/vLLDhcpxzyFrmz4ig7CAIMk4VYlkGWwH8jRJxabIIQwixws40xDH9hu/9LXshfpgtCp/MF+YNkiCAMXelB+IkzEEuK48mQcLPyA27oqv1RdafyjvMkI/cDds1t2g00XSxdJb9VTvYdFhdaqM6oUnQfLd1b9pTMfyuKiibz9Lp37bYUbMKyVN6GwWhAG3LCsPsqGRVPy5piOmYSZYGz3TdvistDsxmNCu3wqxa0auqjU2zT9JEfDW5EjNHbGmTVrfc3VsaWrAzdJ5QAu3rDEK9jd6gZKaK9mRFdRqq+PWKaT+pjWrLYy5tGme6K162nO+EbznFEV4XXNW98cxsvZNI0LvB9diuXGzEpQy5n1F2FwcfVkLkgsu/4SKnmcsrGxsU0klkow9aQeq/pgJjfY3V2Ewfzq6c2/yuk9h8WbXT27n/D2bnWz+Y+A9emLRRhMr4b1+/J+8R8I7O6zRbXHLqkQw5FM5kMvtxZXVfSbGdSD2/FvxDuVMFVDxEjKlFGxggmIrrVHpEegZj4KbUQhXiTkSvuNjMzABq9YzOCKuY+qRVlFnK5j7xj5y1jgWnoNH1BN08VIQy3h+9O2wxEjRvHJhIFJ3tXAxu7iK6OY5kG4OMfKw5Qrds5loT14YKeH3SVlYHq3br8y0rd+jqthpxZJbOce1VcHvsDmipdR3x0dXgOXeMjs2kwA7oIoztL2Qd4dHcJlez526h8EEpeY8KiljSoE1DFyzqm/kFvK9rmNwmLWtipxsg0XRuSuuXfJKkAJ12shCm0eDnCwlpk4VjqusjfAEsnCgEuEu5up2rBcN/CIUJSIPJLFdajyCkxSMinwvoEBlvU37zHutbosz4VN8YHnDRf8XY8Vz5WEfB8VnjxWoFKt/5AwoW1zSsboHAsh+QdgXhVwuii7ZBc5Uxyc0GtRoJhF3bBQa/W1Jg6aN88/vv/B5eyohbR7HvIds4QUOVINckKZEcGv3PLUVxQl4A6mhpsUw1XVA13rzniSM6WlgOOSVBMq+G+WhFEjgdPWiE1paqs6UQFmeYzJB3ptAONl7e9//0cNro2a7ipgdgSaJOAmvQJCPFJaggdNX7EcJKBsQgT9MfXn5U0AoEOmGWYyKRlJX5/GDzGOW5dy0bkYSxenLuIpHCxKeavD8sKrUys1nlHLm/Iyh/myC65N7Ra4v5uzKh/euysbFQyohgBXA82LeZ3BK9erXOoO76vzZj6Ichtc4QVaGDlULOPievtU3Y5nZCkICiMzanhMfFc6amb5sO4lz9dZFXIA1HjOpXqyFjzDM3YkX7od5RWd66uVCmiDmoBrRRI6R4z4NECVisAucq7m5cUq9Fx5TF6hSe+hIIHJDqWI2ZCLITtn6hrqZy12AwAbMTNjTNQx55fQbrZVZoEZpGVorNjSLZwGDgHCjKkJG8ZwgkKeYNdY4k4Huup0SNcC4iS+LpSz+rj8PSjaQMpVvQM4LtNGeQmtUgfqaZMi8r2cAcJCkqcMrkyAhcH2D/gkCLlLPlEfIaYCbwCBwQmyMkDHpZcREktUQ9jIACQlnM0bayCIrdEJeoF8MzBOuG1OXrqXt+so5Izxo/tsGDA5sPgQmkrkdjNdlywDgXqD6UKmuDvi+oFd247jc/hg+ovf//Y/GlQsF1GlI5jCxlIMwKCplvYqVL1Xz2yeHSO0na1wm5CGj+dDKYaVlFtLMM2WWwloTTBHU9ESbo/Awb2+BZQO1AGItnss/E83Rd3y+m4eDBByTwO+lYbtk/dsQlWSlnuaXUaDmbJonZDsUJuoATOIbCA7agyNpwwzjCQsh1xbUpBHsAXbDfhRlZUE1hNMFUwM0YR6HROL27QXtdU8DsDSimbTJAitnTk4XYTBKI5v2yPs5392v3GjDvHToPFtJUPdKI7J41HKAT1UjaTNgPZk36nqNAE+RDVsSWtvLKpFPoqThv7Fa4eU0pyMBmVAog0WWmeM2m6R9Bu8PRtgOrdsBOHJGPiEJx7UBGVllGxatz6beWybrcsF7bSWrq/IFNTv9f4vW7qe9r4eS9du7yuydL0AYJ1z7Wppsun0uVZ2eGfh9gafJLP+h1Sq7TVhB1qEpWtzHYIrdhgs7H+Vcc4L8SsMdtaiVzn7nLHJTwbRMOj14H9LQrCRmRRMD2XW0nT+T0F4fU/j9jWwn8G3uQ1Z304H3+tcZPE0QJ1f66YkX9PkignU8cZFygUbeqQMB73ecC+w+N5dh5wPMmNWu53BbjtTEtQip+YbNSd0Ano6DK/uEVdMqauo6maQbUPCbq837JdI2FtFwhuB93ExWe2RPGPiy860PryxwwOoF1lasXbAbSUsDxqTrX+3k9QsLhQ382D/+DK46NKcd235/vHp4hSozkwl+OBzqRFiaqbBfrCz4pLHbMGgoR5fBmiAC7zI01QkEK62IvZoznfO+1E/WITLbdaKyS31WdG9aRNt6ISLyVXtTiscfYB1tEvVwFSl1+X8LwwUO7cQ9VphwIF+poyCRQZQD+TxvgpkeO0X2YcYrIsaqBZzOQ7AhwE0PPvL29UaX33NVX/s/eTo+i4930E1oaD0TgdBzd8MP2oeZPhZKr3HFTmX7levk/ZRmRvs7qLW87yP6sHTF7jz7j5bnFrk1/wtGKpTdxq4g2rd+u0+Na3BQbBkfW2YQJctoButkRuMkW7IJaOb+7rO1tXf22Rl2ltr3HFdrT/Iu8L6KXH9ic8d+K5/eKudmdasp1cTmqsJ8XKwmk97uJq7PVzNF72GhuLWoOqh0jNQmSh1CTeBSl8ApeAUuIeLsUTWczRXZhIF0Yisu6JXsjSWWZnIs9PxTX7/+z/KVp1OeZ60XiQwDrwrFMnljCnIXg5n+3HKLjC9KTRjGZZptELhfTCagQkBYleEYRObmhzuc4EHx/kIYprTEU85yH57qwatlLXtQ0eQrxXv6M1l8UjZG2vnLIUtozTN1pKwk5lUZ2NI9A7GihHc5ANDBhNTKmLrB7ByDO3ZcI6t8qdqowBqbmGTwigaG5JRQSdokA5JHVkJSzkIe6LkCNxkWqaFdQQZylOprD0WJ4ShZIjE1xc5FKFyDJJDsSlw17nzBunQeuOsiHK5z0fg+MwBFg6WMCNJIVIJacrBgVqkcAfOWKcm6OB1GKG5UVRoUJydCditQYkw56hh2tmcPmoGK/wDF2c2IWuXHJd09RMbaW5YM9/LsoR40mzzHTffFyNIxC01N1LNq9YTbqbFCDebeiflD9vTdz61fW0ruf7lyA/WdqV3Dg7foLLyhPz+t/8mPzCqBJnKmaXWuFAsnVdZ9DHpPK68RVupa6ArkBaQud4gkYqJ9057DP40pQYNmG/ZDCzFlqVseOBhMUp5XL5QoCH71Ev7EEH59kAzP4W9Swb+WUpy2zrl4iwiB2KOHqXKAgffsV1jGuhd3fAqQPkWQAUR+jA0S8+ZrhmkWcKt11vJYmJHqwPjJte8WgdzO0gSki9drwN/SQWOtSChu5laUxLk8l9zI69x7a2ZhZiJBO+B6n2SKDo2Vf/hktUUPdArn/xVPY+O0HVTew4CMOlmXH61puYlNagpb9GEDQPqxiMNNOeOnI49WZJmIqWbk7U9fQpDY1TC/TZOc77Wowi58/W78QemznnMnE64gaN3sPJOEAYpj5k7Crv96+C7wx/I+dOoBxtoqVxeg7l3fnjz8vXbD68BGBCkFmH9qBf10GIntcmoqI3k+OSo0vaWIjbLI0j7Ckj7Ckj7Ckj7Ckj7Ckj7CshDfqeifQWkfQWkfQWkfQWkfQXkD59z+wpI+wpI+wrIw8Bn+wpI+wrIjZMhta+AlAXtKyDtKyAn7Ssg7SsgJ+0rIA8jlWX7Ckj7Csi96HDtKyDtKyDtKyDtKyDtKyBf0eMK7SsgX4IC21dA2ldAbp1msn0FZB1Tta+AtK+AtK+AXDsvbvsKyGfg3vYVkPYVkPYVkG1CqH0FpH0F5GG4hdpXQNpXQNpXQNpXQNpXQNpXQO7VPNO+AtK+AvL/9BWQWqKBnTylHLOZuOy+NhHJ8fLbIKdhMIVMJfvHweUlkOZHlS4W8PnXAhMsHJ+GwTlVHKL5MclJ6HNyQGqDMwbpLF7aqybdIxg/tAuO10mXcrtAUhHb4gBxsLVuPZnK4bsPR5CXwb1fkskEkyPRGaRCoDObr6KWLwG/XQYpFZMCcy0Ets+FTfU6beYgOcMcJO6PWsIGyNVRQdhMTmKnAf/CpNY2uLy0+U0Wi7K+LdrYwiHW14b1O10sFv8LWnKE5g==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Draft Template","permalink":"/docs/API-docs/v1.1/drafttemplate"},"next":{"title":"Public Template","permalink":"/docs/API-docs/v1.1/publictemplate"}}');var i=t(74848),r=t(28453),o=t(57742),l=t.n(o),a=t(78178),d=t.n(a),c=t(19624),h=t.n(c),p=t(96226),u=t.n(p),m=(t(77675),t(19365),t(51107)),x=t(21312);const g={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:"eJztPdtyG7eSv4Kd2irbPMMRSUu2o63dOortTbwnsVW2vKmspMOAMyAJawaYABhRjIpV5+H8wT7t6/m0fMlWN4C58KarHXl38uCIg1uj0d1odDcal4GhEx3sHwdHLMtTapgOTsMgYTpWPDdcimA/OJoy4ovJS8UofCcHh28ITVM506TQTGliJImhkJG40EZm/Dc6ShkxvuOQzKY8nhLN1DkjVJNRWrBccWE0GUtFJkwwRQ0XE5LIuMgYFMy4mZJcsYSNuWAJ0UYVsSkU0xH5mEtBdBHHTOtxkZYjWTC4FCExU4aAKmYKJTShpBD814KRTsfXHvKk0yFmSg2JqSAjBtNJYDYOIFYDZ0ShTArsWOcs5mMOlV1f0Yk4EUc83ycf81TShMxlocjhq38vu4B+4dtxp/OKjYoJ+fim0zl9PDUm1/s7OzTPI5kzoflEpHSko1hmOwlUzJPxE8AgUwx6RVgZ1TydE5okZMaTCTMaZyxILPM5iaVUCRcW9TmdMCKKbMSUDgkVCcmkYoQLQoliNJl3jewWmpH/+PDuLSxHRk1EDtNCh+VwCVcsNuncdg8Y8LN6ZDHzbBfWh4tJSDJ6BgvJDfm14PEZTFszgWh1a4K46nQ+FHkulWEJ+clOYb/TgZJvWSpnhCqG9WOZZVKQnCqaMYPUBgsGxYr9WnDFEksqNE09LvZPRJd0OoJmbL/TIR/twvOECQOrppDozJRr1yCy9c08x/pvRMJjQB4CAF+JHDerAlKh6gdHCLZqDdVAKZboAYczatc/T2lsp6UY0JDh56zZ8UVI5tDxKyakh2AqFf9NCkNTXL5zpgyPaVpfZgAQCdNQhXyUSy6M/+pGID+75YTVxkV0dAigJYDcjAss0Yyc07Rg2kE1C8kUoHrPcsU08oPrFxAvEjJlfDLdOB5NPhXaNDomhQYw61C4sfyqInoZom1MU80IHzdwmdEzVhuNSBRaNI3It3OSsDEtUhMSDhRqVMEi8lYaQvM85TFKJ6ABYDYKMqWLq+zIJ2qSz6GS5zxhIEISPh4zBcwMhdiFa+OhA7rMsQFMDznNTKkgUiwtdCxTqVZJCD838UhiKQwTJiIH55SnCLydrCZcxGmRMDJKaXwWolwNiWKJZfQ5AykdWv7AKiB8Lc4RP0SzFKhQCoBfSDc815WEi8gRMErJf1DoUY2DcF3HquPysYSRAQWeJQnLKE9DRFxIPskRMdykLAQGz6mYhyShhoXEsAszkhchiacsPsO/FE24JKPCGBDsMGaiZJ7ImXC4HEthNP9tDUf6kptjdBCS3ZA8C8mLkPR7IekPQtLfDUn/WUj6L0Iy6IVkMAjJYDckg2cWrMELh2taIrgOQH9gsWy+LuxOecKG0HAIcxtSbZji+gzENfkJ9hwmALjE7rlQsdwm+QR27nIH5JpMeZIwQcZKZkSxmOccpYmVBmXXIcBDFExKaDIu0nROzrnmNRyUncqZALzhiFyRdzkTH/hEEBrHsoA1RgxbpCI6qyUX6RxAPWI00zjz18IwlSuuGYhqoUsMCFPRlt0A4VtdAFxnJUVTAm1ezU2rU1sZ2EF/4BplLmx9utxNZ43dtB+RTqeUc/Dtl19+ORGXJ4KQkwDE3kmwT06CsspJENoy2M2grO9+X8CPp4Pn7uccfj4bvHA/Z1i1v+t+TuHnwDd1zAXfcGCswYWxQzsBS2ogQKXFiVg4aE/EAKdhaJZvmQIUfynw/TYFH2F/CX0BsOAqPBtmbGuszPYpzJYLbjhN9eYJ+xoPaM5LIK2fdlVpZea7MHMUZpunjcUPaM51eKAEN1FbhJturchvBwjFYAuKlvvcJIShFapHK5jci5wOsxmRdgoPBo81cO4LjUtd3hyLzwCLsJ8ewX66GZXllvuA8LkM030hdV2/N8fs8wi1YFRPNuPVVXhAWG1CdF84Xe315hh9ARgFPW8zOqH0AeGyBg4UOKXZlvV2u/297qA32G3gE8wTtkKWdZOkO5/P77YWGRdDCwc0qtXP6MX6ArCagO5YrkRZAhoMF5OyWbN0ddVtvaWFBI3TYQKUTn/+tFovGKVQeV41LuDZv6rlTjz4tz+Q/wjH8JE/obLEqc01e5a3/9TP0EYmdP5I26580/LoBfWXlWMLJhYBHGgLi6eSxw54qOMPXCMw90SAgy4u6k6S7NQWFT4mSTfLuksf4WcXaaD2McuiJImWaq4Qiv2YkSQJyerntd+ThGRZtuGz/d74vJNlq7OIsszB5rDnaW9lnTMueFbAEQnMavaEDhXhlOHQm7m15IJ0Oj///PPP3R9/7L561en4NXRDOCquWTLsCPTinkaoE32ns0/ejEn9E1oTrB0HpUB5MkRzr68wlTPhD0R4bFQkKcCg6Ktaa1JG59gZ42bKVHMcqSqSheMjnLZG0kwj8hFPl/C3P4WVpyU8SX0ToVUYj8abZaer8KXEZyUlmwNvFa2bRVNDtq6oRV4w5ev1JsUmRUoVuwDzn+ZSrMjE2+yBN9vflsSip+XK1IKGRWfaZd7SQR6/c4fwJ6V9cWku0NuB81wQxSbsguTUGKYEdnZOU55Yx0cXP7ALmuVgW9n568lJ8qd/3kHLLhhPjTUpJHzCwSC/89fjg+5/na6pUeQ5UzHVjKQMRtIhYSaOyPGUpXnlE5jNZtHsqY6nUqbWIfBJKza2/w7l6NMQwc0jqvMn62ZqiaFmSQViWTakInPWMEY18S3X2FJxaZBr+j3U4JypYosK52o8IL1jCSQotGZpKD6GrR+VWyBeVv0tQeacBKfVdo/WU5Zc0fb0GuwJ3JDSEUtXi27OWimdy8JxtPcWNKfqKLqGN6cKlQZhnE4vrBXSi6VCW7ZYw6cWIXU29bu9Z0+/AiTlutxIGuist3Y+A/T8CGZ9dCNGfAMyKqn0zlxQAnY9NvAGUly7K4aAegQrlv4aP9oVIzQWZmUnd7qCdzyNy149yvxGXscXtATvbaUmbBnB6QqbR3D+0w0DnIg+miG9+XLL+cTVeECyYgmk7Wx8GynS2Jlvs6XeigH9tOoMuGZ7hap2Yy2ZT2/mvoi8szZ13wjs7XHMctC07syaJcjX3qHQalw3oW+mvHqtB0R9a8D6zBTo6t337nMrIq3P/isi1AbY1yZWa/TP6GSL/QaLHxB51uFZb+JwNVaMVX209NsdZYuFGsu3T7jfa0x4rznhZ71bnLgaw979wNXbgp+VoeBsXaR0ZTtIWMwzmmIICcI9uAOP3ubw5QADHngps7wwdaZDsw4KFq8l+MAI69r9U0i6IemEZCckj0PyJCLvGYZSxGXYhVMauLLBFVyQRBbgJ40Llc7JSMHEQ8KiSUQuL38tqDDczBcL0iGXlxCttVhEwIVnQs5s5MUx+IwNgcip6lCVyFivibSSsd6B09fOWzbrvnLO5R0H2hPyWC6JhK1HUYeCL3sis1DViARGeVuqbPZUiqE+XOcpnRM6Bj+1DQfBZjZqKAIU75MB+dd/I/1B1OuFpGf/Jo/9BAdPkIfRxxSzdJuTEouv4uBenYOrn+tE1l7vWixcH/aWHAxdDDGIAMe9UmGrmPsBmk6qySwba2taPeDM7p96Kos0gd3TBlCyMoCv1OkhAuFQsTFP01oEH/GfPFdDRBRLWeaixlzsHhxoMFqBCyOBc3w4R6czYmMJkQoQQoimQVrF+NnR7ebdiALBwE+pyJRqa2lBXAPMECNppixbipnw4FVxE1x42IGY+/dnExx80yTvZ3sN8t5r7lAbyXsTDW8xFUITnUuhS48gq4pqdId9+u+rh4tlWvKdwnJjyEwV+YNiDEkn5WesLm240F5Pc1AuR8K9nEqpqxouGM1JXr3fDHKTCuLcnkRlcMhdHV/9508basSLL+j4aq5Sb3env7ez1fO15CS5+XGRkOssKdrVr7WkWLNa09YtdBe30N054ul9mmb7zweNE8XTbdvzAzHN1jnqCqPsfZheb3W6XWcDrfPhNa2fX8wKeXey3P0c9pglwf28/wfYY+5Koitml3sjSnJfNpd1lHkNo8tWS8udKbcO7Gen3r37MdAsnXa+aWiD3wzq1Lq3dzdqXTbP1EjuJOD/+e2797PeX76byIODg4O3Hz5OX3+cHBwcZPA7iqK1Rrt1ZIDDgP7srgK5LR7VhQ2jRFGEDntq6D4238nF5F9s+3Bzm8hF5H0mT8Lel/Yk3F1ulFW/zJ61zm3w+STD3XiWuP9ORBAGMscrhlK8SYL9wF5X9Jf3ghCXj2nzrUzmwf5l4C6IwJ8uYB+a7nzScC3yMtDxlGUU/vLLDhcpxzyFrmz4ig7CAIMk4VYlkGWwH8jRJxabIIQwixws40xDH9hu/9LXshfpgtCp/MF+YNkiCAMXelB+IkzEEuK48mQcLPyA27oqv1RdafyjvMkI/cDds1t2g00XSxdJb9VTvYdFhdaqM6oUnQfLd1b9pTMfyuKiibz9Lp37bYUbMKyVN6GwWhAG3LCsPsqGRVPy5piOmYSZYGz3TdvistDsxmNCu3wqxa0auqjU2zT9JEfDW5EjNHbGmTVrfc3VsaWrAzdJ5QAu3rDEK9jd6gZKaK9mRFdRqq+PWKaT+pjWrLYy5tGme6K162nO+EbznFEV4XXNW98cxsvZNI0LvB9diuXGzEpQy5n1F2FwcfVkLkgsu/4SKnmcsrGxsU0klkow9aQeq/pgJjfY3V2Ewfzq6c2/yuk9h8WbXT27n/D2bnWz+Y+A9emLRRhMr4b1+/J+8R8I7O6zRbXHLqkQw5FM5kMvtxZXVfSbGdSD2/FvxDuVMFVDxEjKlFGxggmIrrVHpEegZj4KbUQhXiTkSvuNjMzABq9YzOCKuY+qRVlFnK5j7xj5y1jgWnoNH1BN08VIQy3h+9O2wxEjRvHJhIFJ3tXAxu7iK6OY5kG4OMfKw5Qrds5loT14YKeH3SVlYHq3br8y0rd+jqthpxZJbOce1VcHvsDmipdR3x0dXgOXeMjs2kwA7oIoztL2Qd4dHcJlez526h8EEpeY8KiljSoE1DFyzqm/kFvK9rmNwmLWtipxsg0XRuSuuXfJKkAJ12shCm0eDnCwlpk4VjqusjfAEsnCgEuEu5up2rBcN/CIUJSIPJLFdajyCkxSMinwvoEBlvU37zHutbosz4VN8YHnDRf8XY8Vz5WEfB8VnjxWoFKt/5AwoW1zSsboHAsh+QdgXhVwuii7ZBc5Uxyc0GtRoJhF3bBQa/W1Jg6aN88/vv/B5eyohbR7HvIds4QUOVINckKZEcGv3PLUVxQl4A6mhpsUw1XVA13rzniSM6WlgOOSVBMq+G+WhFEjgdPWiE1paqs6UQFmeYzJB3ptAONl7e9//0cNro2a7ipgdgSaJOAmvQJCPFJaggdNX7EcJKBsQgT9MfXn5U0AoEOmGWYyKRlJX5/GDzGOW5dy0bkYSxenLuIpHCxKeavD8sKrUys1nlHLm/Iyh/myC65N7Ra4v5uzKh/euysbFQyohgBXA82LeZ3BK9erXOoO76vzZj6Ichtc4QVaGDlULOPievtU3Y5nZCkICiMzanhMfFc6amb5sO4lz9dZFXIA1HjOpXqyFjzDM3YkX7od5RWd66uVCmiDmoBrRRI6R4z4NECVisAucq7m5cUq9Fx5TF6hSe+hIIHJDqWI2ZCLITtn6hrqZy12AwAbMTNjTNQx55fQbrZVZoEZpGVorNjSLZwGDgHCjKkJG8ZwgkKeYNdY4k4Huup0SNcC4iS+LpSz+rj8PSjaQMpVvQM4LtNGeQmtUgfqaZMi8r2cAcJCkqcMrkyAhcH2D/gkCLlLPlEfIaYCbwCBwQmyMkDHpZcREktUQ9jIACQlnM0bayCIrdEJeoF8MzBOuG1OXrqXt+so5Izxo/tsGDA5sPgQmkrkdjNdlywDgXqD6UKmuDvi+oFd247jc/hg+ovf//Y/GlQsF1GlI5jCxlIMwKCplvYqVL1Xz2yeHSO0na1wm5CGj+dDKYaVlFtLMM2WWwloTTBHU9ESbo/Awb2+BZQO1AGItnss/E83Rd3y+m4eDBByTwO+lYbtk/dsQlWSlnuaXUaDmbJonZDsUJuoATOIbCA7agyNpwwzjCQsh1xbUpBHsAXbDfhRlZUE1hNMFUwM0YR6HROL27QXtdU8DsDSimbTJAitnTk4XYTBKI5v2yPs5392v3GjDvHToPFtJUPdKI7J41HKAT1UjaTNgPZk36nqNAE+RDVsSWtvLKpFPoqThv7Fa4eU0pyMBmVAog0WWmeM2m6R9Bu8PRtgOrdsBOHJGPiEJx7UBGVllGxatz6beWybrcsF7bSWrq/IFNTv9f4vW7qe9r4eS9du7yuydL0AYJ1z7Wppsun0uVZ2eGfh9gafJLP+h1Sq7TVhB1qEpWtzHYIrdhgs7H+Vcc4L8SsMdtaiVzn7nLHJTwbRMOj14H9LQrCRmRRMD2XW0nT+T0F4fU/j9jWwn8G3uQ1Z304H3+tcZPE0QJ1f66YkX9PkignU8cZFygUbeqQMB73ecC+w+N5dh5wPMmNWu53BbjtTEtQip+YbNSd0Ano6DK/uEVdMqauo6maQbUPCbq837JdI2FtFwhuB93ExWe2RPGPiy860PryxwwOoF1lasXbAbSUsDxqTrX+3k9QsLhQ382D/+DK46NKcd235/vHp4hSozkwl+OBzqRFiaqbBfrCz4pLHbMGgoR5fBmiAC7zI01QkEK62IvZoznfO+1E/WITLbdaKyS31WdG9aRNt6ISLyVXtTiscfYB1tEvVwFSl1+X8LwwUO7cQ9VphwIF+poyCRQZQD+TxvgpkeO0X2YcYrIsaqBZzOQ7AhwE0PPvL29UaX33NVX/s/eTo+i4930E1oaD0TgdBzd8MP2oeZPhZKr3HFTmX7levk/ZRmRvs7qLW87yP6sHTF7jz7j5bnFrk1/wtGKpTdxq4g2rd+u0+Na3BQbBkfW2YQJctoButkRuMkW7IJaOb+7rO1tXf22Rl2ltr3HFdrT/Iu8L6KXH9ic8d+K5/eKudmdasp1cTmqsJ8XKwmk97uJq7PVzNF72GhuLWoOqh0jNQmSh1CTeBSl8ApeAUuIeLsUTWczRXZhIF0Yisu6JXsjSWWZnIs9PxTX7/+z/KVp1OeZ60XiQwDrwrFMnljCnIXg5n+3HKLjC9KTRjGZZptELhfTCagQkBYleEYRObmhzuc4EHx/kIYprTEU85yH57qwatlLXtQ0eQrxXv6M1l8UjZG2vnLIUtozTN1pKwk5lUZ2NI9A7GihHc5ANDBhNTKmLrB7ByDO3ZcI6t8qdqowBqbmGTwigaG5JRQSdokA5JHVkJSzkIe6LkCNxkWqaFdQQZylOprD0WJ4ShZIjE1xc5FKFyDJJDsSlw17nzBunQeuOsiHK5z0fg+MwBFg6WMCNJIVIJacrBgVqkcAfOWKcm6OB1GKG5UVRoUJydCditQYkw56hh2tmcPmoGK/wDF2c2IWuXHJd09RMbaW5YM9/LsoR40mzzHTffFyNIxC01N1LNq9YTbqbFCDebeiflD9vTdz61fW0ruf7lyA/WdqV3Dg7foLLyhPz+t/8mPzCqBJnKmaXWuFAsnVdZ9DHpPK68RVupa6ArkBaQud4gkYqJ9057DP40pQYNmG/ZDCzFlqVseOBhMUp5XL5QoCH71Ev7EEH59kAzP4W9Swb+WUpy2zrl4iwiB2KOHqXKAgffsV1jGuhd3fAqQPkWQAUR+jA0S8+ZrhmkWcKt11vJYmJHqwPjJte8WgdzO0gSki9drwN/SQWOtSChu5laUxLk8l9zI69x7a2ZhZiJBO+B6n2SKDo2Vf/hktUUPdArn/xVPY+O0HVTew4CMOlmXH61puYlNagpb9GEDQPqxiMNNOeOnI49WZJmIqWbk7U9fQpDY1TC/TZOc77Wowi58/W78QemznnMnE64gaN3sPJOEAYpj5k7Crv96+C7wx/I+dOoBxtoqVxeg7l3fnjz8vXbD68BGBCkFmH9qBf10GIntcmoqI3k+OSo0vaWIjbLI0j7Ckj7Ckj7Ckj7Ckj7Ckj7CshDfqeifQWkfQWkfQWkfQWkfQXkD59z+wpI+wpI+wrIw8Bn+wpI+wrIjZMhta+AlAXtKyDtKyAn7Ssg7SsgJ+0rIA8jlWX7Ckj7Csi96HDtKyDtKyDtKyDtKyDtKyBf0eMK7SsgX4IC21dA2ldAbp1msn0FZB1Tta+AtK+AtK+AXDsvbvsKyGfg3vYVkPYVkPYVkG1CqH0FpH0F5GG4hdpXQNpXQNpXQNpXQNpXQNpXQO7VPNO+AtK+AvL/9BWQWqKBnTylHLOZuOy+NhHJ8fLbIKdhMIVMJfvHweUlkOZHlS4W8PnXAhMsHJ+GwTlVHKL5MclJ6HNyQGqDMwbpLF7aqybdIxg/tAuO10mXcrtAUhHb4gBxsLVuPZnK4bsPR5CXwb1fkskEkyPRGaRCoDObr6KWLwG/XQYpFZMCcy0Ets+FTfU6beYgOcMcJO6PWsIGyNVRQdhMTmKnAf/CpNY2uLy0+U0Wi7K+LdrYwiHW14b1O10sFv8LWnKE5g==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},y=void 0,f={},j=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Create Template"}),"\n",(0,i.jsx)(l(),{method:"post",path:"/createtemplate",context:"endpoint"}),"\n",(0,i.jsxs)(n.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,i.jsx)(n.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Unique identifier for this widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Specify the hint for widgets. This parameter is optional and is not applicable to the following widgets: checkbox, radio button, dropdown."]}),"\n"]}),"\n",(0,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 "options": {\n "hint": "Provide signature"\n }\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 "hint": "Provide 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 "hint": "Provide 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 "hint": "Provide email",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide name",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide job title",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide company",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12,\n "min_date": "",\n "max_date": "",\n "readonly": false,\n "signing_date": false,\n "hint": "Provide date"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"min_date:"})," Provide the minimum restriction date. The date must be in ",(0,i.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"max_date:"})," Provide the maximum restriction date. The date must be in ",(0,i.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"signing_date"}),": If signing_date is set to true, the signing date is shown to the signer during signing. You may set either signing_date or default, but not both. Using both is not supported."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,i.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image",\n "hint": "Provide image"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"14",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Provide number",\n "formula": "",\n "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,i.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"decimalplaces:"})," Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"15",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"cells"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "cells",\n "page": 1,\n "x": 100,\n "y": 100,\n "w": 114,\n "h": 50,\n "options": {\n "name": "cells",\n "required": true,\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"cell_count:"})," Specify the number of cells that should be returned to the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,i.jsx)(n.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "required": true,\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "response": "04/15/2024",\n "format": "mm/dd/yyyy",\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "required": true,\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 528,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "values": ["male", "female", "other"],\n "response": "female",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,i.jsx)(x.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,i.jsx)(d(),{parameters:void 0}),"\n",(0,i.jsx)(h(),{...t(16078)}),"\n",(0,i.jsx)(u(),{...t(79076)})]})}function w(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(b,{...e})}):b(e)}},16078(e){e.exports=JSON.parse('{"title":"Body","body":{"content":{"application/json":{"schema":{"required":["file","signers","title"],"type":"object","properties":{"file":{"type":"string","format":"base64","example":"base64 encoded pdf"},"title":{"type":"string","format":"string","example":"sample template"},"note":{"type":"string","format":"string","example":"sample note"},"description":{"type":"string","format":"string","example":"sample description"},"signers":{"type":"array","description":"You can provide signer optionally if you it as default signer","items":{"type":"object","properties":{"role":{"type":"string","format":"string","example":"ceo"},"email":{"type":"string","format":"string","example":""},"name":{"type":"string","format":"string","example":""},"phone":{"type":"string","format":"string","example":""},"company":{"type":"string","format":"string","example":""},"job_title":{"type":"string","format":"string","example":""},"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Allowed values - signature, stamp.","format":"string","example":"signature"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":244},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":71},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":38},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":46}},"title":"createtemplate_body_widgets"}}},"title":"createtemplate_body_signers"}},"sendInOrder":{"type":"boolean","description":"If set to \'true\', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to \'true\'.","example":true},"enableOTP":{"type":"boolean","description":"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.","example":false},"enableTour":{"type":"boolean","description":"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.","example":false},"redirect_url":{"type":"string","description":"Specifies the URL where the signer will be redirected upon completing the document signing process.","example":""},"sender_name":{"type":"string","description":"The name of the person or organization on whose behalf the email is being sent.","example":"opensign\u2122"},"sender_email":{"type":"string","description":"The email address of the person or organization that users can reply to.","example":"mailer@opensignlabs.com"},"allow_modifications":{"type":"boolean","description":"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.","example":false},"auto_reminder":{"type":"boolean","description":"Set to true to enable automatic reminders. Set to false to disable them (default behavior).","example":false},"timeToCompleteDays":{"type":"number","description":"time to complete days is used to calculate expiry date of your document","format":"number","example":15},"remind_once_in_every":{"type":"number","description":"Number of days between reminders. This is only applicable when auto_reminder is set to true.","example":5},"merge_certificate":{"type":"boolean","description":"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\\n\\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\\n\\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\\n","example":false},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed. \\n"},"prefill":{"type":"object","description":"You can provide widgets which can embed before sending to signer","properties":{"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","format":"string","example":"textbox"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":100},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":30},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":40},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":80},"options":{"type":"object","properties":{"name":{"type":"string","example":"textbox"},"response":{"type":"string","example":"joe"},"color":{"type":"string","example":"red"},"fontsize":{"type":"number","example":12}}}}}}},"title":"prefill"}},"title":"createtemplate_body"}}},"required":true}}')},79076(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Template created successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","example":"Bh2Hspnmch"},"message":{"type":"string","example":"Template created successfully!"}},"title":"inline_response_200_5"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/9cd612ce.0726dea6.js b/assets/js/9cd612ce.0726dea6.js new file mode 100644 index 000000000..aa3ff32d1 --- /dev/null +++ b/assets/js/9cd612ce.0726dea6.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[4372],{15795(e,t,o){o.r(t),o.d(t,{assets:()=>j,contentTitle:()=>v,default:()=>y,frontMatter:()=>U,metadata:()=>n,toc:()=>b});const n=JSON.parse('{"id":"API-docs/v1.1/deletefolder","title":"Delete Folder","description":"The delete Folder API allows you to delete folder.","source":"@site/docs/API-docs/v1.1/deletefolder.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/deletefolder","permalink":"/docs/API-docs/v1.1/deletefolder","draft":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJy9Wd1uHLcVfpUTGiikxeyPZCdtN0VaRVJsNW4saKUaqFbQcodnd5jlkBOSs6uFtEAuij5A0Zve9iV630fxkxSHnJn9kWzHSdELWxJ5eHh+vvPDM/fM86lj/Wv2jVECLbtJmECXWll4aTTrs8sMQaBCjxBJ4Oj8DLhSZuFgaUrwpt6fhP0OS5gp0HJicCZYn8XtuMsSVnDLc/Ro6d57pnmOrM/i9q0ULGGSLi64z9iuNGb8Pab+TICZQMPQ4g+ltChY39sSE+b8UhFLJ/NCIUsY3hXKCGT9CVeOCNIMc87698wvi0DprdRTlrCJsTn3myt4xwOXPht/e5BOxGFWjNlqdUPXusJoh44YHfZ69GNbWlemKTo3KRU0FmEJS432qD3R86JQMg0b3e8dHbp/LF1UmixniY2X8craFp+qx6uZO/xjgYuzgq2SyjniyD/FZn3osHf4vH3Qa/d+fXnwRf/Fb/uff9Hp9Xp/YQm7yxWdrfwouEfi66VX6783FqRWUuNtbb3bw17v9uCQrVZE9OIpM7YrV4N0oI0HzAu/TIDMyKV2IExa5qg9GFtjcKjbMDA5+kzqKSxoc2GNniZQKOQOwdsl8CmXGhT3aD8b/iLHGI1vJgHN2y5Ca439sGE/WTWyVPIzLvokc9AlN+/32Yte7/Z547IXj11WaUUqTUypRed/B/v3qvohzD+W50OQfNF7cfubRr3PH6t3pudcSRFSoTcz1J/9H/Rba/PE9STqdiDKSBT22Zaym+tRSYdpaaVfBgjftXkh23G/f31DOCDkmHUqD0ncZ6zPutGw3fsmfa8YsbPzOr2XVrE+y7wvXL/bdVyLsbnrmAK1k1Ot+Nh1UpN3eSG784POISNsb5/hRfFJ9Fi2P/WI83wq9fRj527WlhqQN6PDtuzVuI0X8ltcsqR2xyZVVeEy5FTAyAFST0w4XDnpTYF6IKc6uDhcvlsJn0FN8+6v/2rIhnqov4JWi6o2KdJ2prQpwolJy8CPK49Wcy/nCO9+/AeMS6koJiwInKMiILoEvC2dRwHjJaD2aAsrHbpOq0X8N++dyjnGNoBDagieHhMorBFlSoK2LXKxBGyTRbkvLUKhuKdQBZ9ZU04z4OCknipM4OJ0cEnF8uj8rAMD1KLJfy6I2DBJIOeaTxE85sQPg8w8nQUSynHOc186kBoscgVe5pgA1wJ46U3OPZLQlrSTFtdpVskJpstUReNwpWAhfWZKD3PUwlhQJp21pe6QIdrtNv149gxeovd068Bz61HQ6ukc7RKoNUHnIS+dh5Rbu4z3NpFLEvoMYbSBjxFEZIRLRqPRUG9s9uF3xGG98FVFM9St1ru//R2uX5kFNWVT1NRy4M6FN3s16IVJ3WO002o3Q1V0B1Ep1z06P7uko/vR/98ZD448ucjQIl01xqnUv4crKiQZQqtVhTmgnktrNJm21YK90U9OA6N94ltY4w3FU+MFPplgGkytCMGCe77jimNjEY55wcdSScqptP4Ax9zj1NglPMDbjPsA2ZRrEAYehvqh3W6Hf0Taap3UqGu14AGOLXJCtUMtEigLEf6yODezClNV/9vAs127fQ3fivNljdfA+etSKgEWS8fHagPMQV0oLLYLxVMUsJBiit59GWQgyxiN1BLkXC/DtWibKwaoJm2Kz3DFyxoFjpYD6WZUNXatuIDUc+lD4YKJMoua6Xk5VjKFbfEHGbcIHIq4WYeeknoWwkebmquSzkPdptc8TyyfeHhr7Ixuihz5HDekM3bDJtyBoBMumHwiNVcyAi6PTUvN95iap7Ry3p9inggxUAmTxn0YGzMjiE0tz3PuZcqVWtZM4lsn8nhjp1zTXWvJpHZSYJOC4cQSHGMRbDzxFseZMbPI5AJTJBpKR21KR4BzyjjaeDmpegUHEZkWzEIDalEYqX3N7srVAl2gtxLnCDxNTal9sEhqUUgPVEmoDyIPPmyHBgH/3Y//dPAdLijv1AWDNp/Bkfc8zUIWfBvgBoOyKIz1Q03VZMSbfTeqABm71gW4SIgCjI5OakyVkFyEv/VCJKgd2xCsF0ibClP1IuUv16lFfUW2H0RvDirUvZZ65oZ6gB5GQ5ZJgbfR37cVLm9VoGB9qm4IDxAegyMSeXT+ZnAJ3SBYLeeIwozY1LDZhLer0/a2slB3kJ21WY8Vcjpeh07tPK6GevTy9BK6tY7dvhSjoPz2OgXPCDIKjTGiBuct8pw6VhHCzKIoteDaw/plDRSZFnMzRxFYtlqFxYlUKuTM2nEWfWmJj0M661EtYWJNXuu8ZthqUc2dkQGady8gdxItGSo12pU5Nh46584tjBXtc2s8pgSN85Nv1oiiffLTRCq8LSriIRvVdq0T6NiIJdUZDQtjw+0hNaJO7bKouLpOzTcAsD/UlT8jsGozjuA//4bR+dUji4fljQO1N7v9mu52m2wHJzsbO/eFDUq+ZNJRbZ83kwk5sEEv5SxrVIPfMF+5NZEqIPhDwN1VNGDoCU29ARqFyFR6RZ1dqDrU+slYgKr7GqhTz4U8zZowbPxbBd+FUVRgQ36oytAI4rsm4IunKRaUsUmnKhytUUienkhUAnhqjXOh0wpaUNqypvToOnCZWUQg+ojnJs30Y02n26mKYsbnkrLmbiWvZBpBa0/ghJfK74eaEJqxqlullEtvYB9q6rpNrTJc5DOXuCA+TRp3MfrruCdDWSQqMFot6+pXle04LasL34gXhTXzyO6Y6xjZVMhrcrwjq1U1OUpT1c5w2UOTWrgdGw3HpljC3vHxPgknC0kZeqiPQOOCzJ6ma2s/ytdcGT0NpYz0wTvpQnM1GrLx5jlK603+XifqmP0IbU130XixGxulxpmnOZcKuBAWHeUOymooKN4bGW1VIjl1ymOj2ylptlkgAQMXo1PcdoB0jUNFB17LGa51SEj8LWlgz5VpRh1FjJJ1xEsx2qeeYC5FZYcoGvnLSlH5valKc65KTEIlj1mKLKskGZbalDjOAW4tX8Le6PpmtP8lmFz6wCWa1huQOkNbLW6z3ultj+ZcqhCpp+vGumpwN1YoJmioc3Xx+onmdhB779BIfEJD3nSCzdtum8MHn87N6dMruMDpo8Mfe7KPdluZP6N10oQk9Sv4mqezBbfCwbHJC+5laP2XREqHCRyTknq7cU3YTitCFZ8WMD8IMJ4fdA6al1/df7lYEn1mHMI8XhwTEm/8YahsSQfj2u6BqzYwthirZppxPaVAoOZro1BLSvyiTGMsBHmJtQnvfK6g1AqdA+MztAtqQrUhjG+b48ohvZurHoiGn9dNa/oWx056XL/7FovFI0vvhzPflEpB/fgJAfeR12I89lL6V+UYLrAwTnpjl+tTU+mzchx8uXm2+aNiUD9S6JV6+UtfqYHlJdrc0VeCAdq5TD+iftcTeXc/TIF35jnbYxeLE7SUd9zWG5sXsnrPX9dyAIn3S/SgoV31VglzQUp9cbD0h10+Yb5HKryZVPpWw60P68sSpmSK2uHG3PDo5flrmD/v9FiyMSX7Cb7svj47Pv1ucErCVGHC+uyg0+v0aKkwzudcb9x0svlZaXfAdb+ep/68b1DVHM7jne8WisswBA0K3VfTy2vWfELqrz8/3SQsM87T9v09xfOVVasVLf9QoqUR6U3C5txKCvww4qzaJ9F8X3qvInsX1Rt4H578kvWkzPVAUdM0MZQF1mcsYTNcbn03W92sknqmSGLF/aPQgm2cfDSb3hrwnpy+Pr08ZQnjJZloc5w5C+PM6he64EnBtuecUQb6n4auTx64v4+j0tWqoY9b7z1R6VhTk5VuVqvVfwFr9zCx","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Update Folder","permalink":"/docs/API-docs/v1.1/updatefolder"},"next":{"title":"Get folder list","permalink":"/docs/API-docs/v1.1/folderlist"}}');var l=o(74848),s=o(28453),r=o(57742),i=o.n(r),d=o(78178),p=o.n(d),a=o(19624),c=o.n(a),f=o(96226),u=o.n(f),h=(o(77675),o(19365),o(51107)),m=o(21312);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:"eJy9Wd1uHLcVfpUTGiikxeyPZCdtN0VaRVJsNW4saKUaqFbQcodnd5jlkBOSs6uFtEAuij5A0Zve9iV630fxkxSHnJn9kWzHSdELWxJ5eHh+vvPDM/fM86lj/Wv2jVECLbtJmECXWll4aTTrs8sMQaBCjxBJ4Oj8DLhSZuFgaUrwpt6fhP0OS5gp0HJicCZYn8XtuMsSVnDLc/Ro6d57pnmOrM/i9q0ULGGSLi64z9iuNGb8Pab+TICZQMPQ4g+ltChY39sSE+b8UhFLJ/NCIUsY3hXKCGT9CVeOCNIMc87698wvi0DprdRTlrCJsTn3myt4xwOXPht/e5BOxGFWjNlqdUPXusJoh44YHfZ69GNbWlemKTo3KRU0FmEJS432qD3R86JQMg0b3e8dHbp/LF1UmixniY2X8craFp+qx6uZO/xjgYuzgq2SyjniyD/FZn3osHf4vH3Qa/d+fXnwRf/Fb/uff9Hp9Xp/YQm7yxWdrfwouEfi66VX6783FqRWUuNtbb3bw17v9uCQrVZE9OIpM7YrV4N0oI0HzAu/TIDMyKV2IExa5qg9GFtjcKjbMDA5+kzqKSxoc2GNniZQKOQOwdsl8CmXGhT3aD8b/iLHGI1vJgHN2y5Ca439sGE/WTWyVPIzLvokc9AlN+/32Yte7/Z547IXj11WaUUqTUypRed/B/v3qvohzD+W50OQfNF7cfubRr3PH6t3pudcSRFSoTcz1J/9H/Rba/PE9STqdiDKSBT22Zaym+tRSYdpaaVfBgjftXkh23G/f31DOCDkmHUqD0ncZ6zPutGw3fsmfa8YsbPzOr2XVrE+y7wvXL/bdVyLsbnrmAK1k1Ot+Nh1UpN3eSG784POISNsb5/hRfFJ9Fi2P/WI83wq9fRj527WlhqQN6PDtuzVuI0X8ltcsqR2xyZVVeEy5FTAyAFST0w4XDnpTYF6IKc6uDhcvlsJn0FN8+6v/2rIhnqov4JWi6o2KdJ2prQpwolJy8CPK49Wcy/nCO9+/AeMS6koJiwInKMiILoEvC2dRwHjJaD2aAsrHbpOq0X8N++dyjnGNoBDagieHhMorBFlSoK2LXKxBGyTRbkvLUKhuKdQBZ9ZU04z4OCknipM4OJ0cEnF8uj8rAMD1KLJfy6I2DBJIOeaTxE85sQPg8w8nQUSynHOc186kBoscgVe5pgA1wJ46U3OPZLQlrSTFtdpVskJpstUReNwpWAhfWZKD3PUwlhQJp21pe6QIdrtNv149gxeovd068Bz61HQ6ukc7RKoNUHnIS+dh5Rbu4z3NpFLEvoMYbSBjxFEZIRLRqPRUG9s9uF3xGG98FVFM9St1ru//R2uX5kFNWVT1NRy4M6FN3s16IVJ3WO002o3Q1V0B1Ep1z06P7uko/vR/98ZD448ucjQIl01xqnUv4crKiQZQqtVhTmgnktrNJm21YK90U9OA6N94ltY4w3FU+MFPplgGkytCMGCe77jimNjEY55wcdSScqptP4Ax9zj1NglPMDbjPsA2ZRrEAYehvqh3W6Hf0Taap3UqGu14AGOLXJCtUMtEigLEf6yODezClNV/9vAs127fQ3fivNljdfA+etSKgEWS8fHagPMQV0oLLYLxVMUsJBiit59GWQgyxiN1BLkXC/DtWibKwaoJm2Kz3DFyxoFjpYD6WZUNXatuIDUc+lD4YKJMoua6Xk5VjKFbfEHGbcIHIq4WYeeknoWwkebmquSzkPdptc8TyyfeHhr7Ixuihz5HDekM3bDJtyBoBMumHwiNVcyAi6PTUvN95iap7Ry3p9inggxUAmTxn0YGzMjiE0tz3PuZcqVWtZM4lsn8nhjp1zTXWvJpHZSYJOC4cQSHGMRbDzxFseZMbPI5AJTJBpKR21KR4BzyjjaeDmpegUHEZkWzEIDalEYqX3N7srVAl2gtxLnCDxNTal9sEhqUUgPVEmoDyIPPmyHBgH/3Y//dPAdLijv1AWDNp/Bkfc8zUIWfBvgBoOyKIz1Q03VZMSbfTeqABm71gW4SIgCjI5OakyVkFyEv/VCJKgd2xCsF0ibClP1IuUv16lFfUW2H0RvDirUvZZ65oZ6gB5GQ5ZJgbfR37cVLm9VoGB9qm4IDxAegyMSeXT+ZnAJ3SBYLeeIwozY1LDZhLer0/a2slB3kJ21WY8Vcjpeh07tPK6GevTy9BK6tY7dvhSjoPz2OgXPCDIKjTGiBuct8pw6VhHCzKIoteDaw/plDRSZFnMzRxFYtlqFxYlUKuTM2nEWfWmJj0M661EtYWJNXuu8ZthqUc2dkQGady8gdxItGSo12pU5Nh46584tjBXtc2s8pgSN85Nv1oiiffLTRCq8LSriIRvVdq0T6NiIJdUZDQtjw+0hNaJO7bKouLpOzTcAsD/UlT8jsGozjuA//4bR+dUji4fljQO1N7v9mu52m2wHJzsbO/eFDUq+ZNJRbZ83kwk5sEEv5SxrVIPfMF+5NZEqIPhDwN1VNGDoCU29ARqFyFR6RZ1dqDrU+slYgKr7GqhTz4U8zZowbPxbBd+FUVRgQ36oytAI4rsm4IunKRaUsUmnKhytUUienkhUAnhqjXOh0wpaUNqypvToOnCZWUQg+ojnJs30Y02n26mKYsbnkrLmbiWvZBpBa0/ghJfK74eaEJqxqlullEtvYB9q6rpNrTJc5DOXuCA+TRp3MfrruCdDWSQqMFot6+pXle04LasL34gXhTXzyO6Y6xjZVMhrcrwjq1U1OUpT1c5w2UOTWrgdGw3HpljC3vHxPgknC0kZeqiPQOOCzJ6ma2s/ytdcGT0NpYz0wTvpQnM1GrLx5jlK603+XifqmP0IbU130XixGxulxpmnOZcKuBAWHeUOymooKN4bGW1VIjl1ymOj2ylptlkgAQMXo1PcdoB0jUNFB17LGa51SEj8LWlgz5VpRh1FjJJ1xEsx2qeeYC5FZYcoGvnLSlH5valKc65KTEIlj1mKLKskGZbalDjOAW4tX8Le6PpmtP8lmFz6wCWa1huQOkNbLW6z3ultj+ZcqhCpp+vGumpwN1YoJmioc3Xx+onmdhB779BIfEJD3nSCzdtum8MHn87N6dMruMDpo8Mfe7KPdluZP6N10oQk9Sv4mqezBbfCwbHJC+5laP2XREqHCRyTknq7cU3YTitCFZ8WMD8IMJ4fdA6al1/df7lYEn1mHMI8XhwTEm/8YahsSQfj2u6BqzYwthirZppxPaVAoOZro1BLSvyiTGMsBHmJtQnvfK6g1AqdA+MztAtqQrUhjG+b48ohvZurHoiGn9dNa/oWx056XL/7FovFI0vvhzPflEpB/fgJAfeR12I89lL6V+UYLrAwTnpjl+tTU+mzchx8uXm2+aNiUD9S6JV6+UtfqYHlJdrc0VeCAdq5TD+iftcTeXc/TIF35jnbYxeLE7SUd9zWG5sXsnrPX9dyAIn3S/SgoV31VglzQUp9cbD0h10+Yb5HKryZVPpWw60P68sSpmSK2uHG3PDo5flrmD/v9FiyMSX7Cb7svj47Pv1ucErCVGHC+uyg0+v0aKkwzudcb9x0svlZaXfAdb+ep/68b1DVHM7jne8WisswBA0K3VfTy2vWfELqrz8/3SQsM87T9v09xfOVVasVLf9QoqUR6U3C5txKCvww4qzaJ9F8X3qvInsX1Rt4H578kvWkzPVAUdM0MZQF1mcsYTNcbn03W92sknqmSGLF/aPQgm2cfDSb3hrwnpy+Pr08ZQnjJZloc5w5C+PM6he64EnBtuecUQb6n4auTx64v4+j0tWqoY9b7z1R6VhTk5VuVqvVfwFr9zCx",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-2",custom_edit_url:null},v=void 0,j={},b=[];function x(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Delete Folder"}),"\n",(0,l.jsx)(i(),{method:"delete",path:"/folder/{folder_id}",context:"endpoint"}),"\n",(0,l.jsx)(t.p,{children:"The delete Folder API allows you to delete folder."}),"\n",(0,l.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,l.jsx)(m.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,l.jsx)(p(),{...o(181)}),"\n",(0,l.jsx)(c(),{...o(4311)}),"\n",(0,l.jsx)(u(),{...o(36153)})]})}function y(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,l.jsx)(t,{...e,children:(0,l.jsx)(x,{...e})}):x(e)}},181(e){e.exports=JSON.parse('{"parameters":[{"name":"folder_id","in":"path","description":"objectId of folder","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"bK1cfd2hpb"}}]}')},4311(e){e.exports={title:"Body"}},36153(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"Hks2JpewIp"},"deletedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"title":"inline_response_200_12"}}}},"400":{"description":"- folder is not empty, contains document or folder.\\n- Something went wrong, please try again later!\\n","content":{"application/json":{"schema":{"type":"object","oneOf":[{"properties":{"error":{"type":"string","example":"folder is not empty, contains document or folder."}}},{"properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}}}],"title":"inline_response_400_3"}}}},"404":{"description":"folder not found.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","format":"string","example":"folder not found."}},"title":"inline_response_404_8"}}}},"405":{"description":"Invalid API token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/9cd612ce.073baa5b.js b/assets/js/9cd612ce.073baa5b.js deleted file mode 100644 index 5a873efed..000000000 --- a/assets/js/9cd612ce.073baa5b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[4372],{15795(e,t,o){o.r(t),o.d(t,{assets:()=>b,contentTitle:()=>S,default:()=>y,frontMatter:()=>x,metadata:()=>n,toc:()=>h});const n=JSON.parse('{"id":"API-docs/v1.1/deletefolder","title":"Delete Folder","description":"The delete Folder API allows you to delete folder.","source":"@site/docs/API-docs/v1.1/deletefolder.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/deletefolder","permalink":"/docs/API-docs/v1.1/deletefolder","draft":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJy9V81uIzcSfpUKL5sR2pLscbKbPq2ROBMnRsaIHRiIRzDY3dVqxmySQ1ZLFgQBOewb7CnXPNo8yaLYP5L8MxsnQS62uor1/7GquBYk50GkN+Jrqwv0YpaIAkPulSNljUjFVYVQoEZCaI/AycUZSK3tMsDKNkC255eRPxaJsA69ZAVnhUhFy265IhFOelkjoWe7a2FkjSIVLftWFSIRig07SZV46I3NfsaczgqwJQwKPb5vlMdCpOQbTESglWaVQdVOo0gE3jttCxRpKXXgA3mFtRTpWtDKxZPklZmLRJTW15J2KXgvo5ZUZN8d5mVxVLlMbDYzNhucNQEDKzqaTvnfvrehyXMMoWw0DBkRicitITTE56VzWuWRMfk5sND6sXdt0Jw5z2pItSb7XLw0jm/uwtG3DpdnTmySrjjFCT2lZit0ND16fXA4PZj+8+rw8/T4i/Szz8fT6fQnkYj7WrNsV8dCErJeUqS33zsEZbQyeNtn7/ZoOr09PBKbDR86fiqNB12pQQUwlgBrR6sEOI1SmQCFzZsaDYH1PQbfmQO4tDVSpcwclsxcemvmCTiNMiCQX4GcS2VAS0L/ybs/VRhr8G0Z0bxfIvTe+o8n9sWhcaaSP2DoRelgI7Pna3Y8nd6+Hkp2/LhkXVQcUmkbU4z/Otg/G+rHMP/Yn49B8nh6fPuvIbzPHod3ZhZSqyK2QrJ3aD75G+LbRvOEeXZ1/yKq9lDki71gd+ltkAHzxitaRQjfH0inDlp+ejNjHDBy7LaVxyZOlUjFpE3sZD20741gdX7Rt/fGa5GKisiFdDIJ0hSZvR9bhyaoudEyC+Pc1hPp1GRxOD4UjO19Genci85jc/BSkUByrsz8/8nNtpm65Gq2BdvL11A26dR3uBJJX47dU92Eq1DyAOMCKFPaKNwV6a1Dc6nmJpY4Gn84Ca9R57ZGHr9UIYxGvciH//w2SI1GQweJYBy/M+/M28aDs0v0PJekKaDUeK8yjVEM68gbZntAWWsMQa9AGcK5l4RQqLkiqYHzxB0ll05mSivGMB+zLO1h5xqEMVxXSBV6Zv3DI0gocIGaoQ+yIVtLYlVDx1taf1fylpGAhKwJymAIgKaSJueDfSUS7o3SABpC77wKCIE8e61a36whL3OCWho5R9adwG6yCtSK4QreZk0gCFY30WUgqbT1WEAfkEEsQkziKa8UHoGpua2dx4phs0CYN6rAwD28QAjxynIIpoAMA4FjX1SOgZU2Rtv8LhawbLQGZ7mDKKl5v9n1kcXJSxO4ybW+9DUYEua85W0DWwdHox8DcoXPlbkL6WjEI/FmwNU1ZkERzj7tr8ByuXwE/Vf7Mm8UfdNk8AM6GxRZv9pKzxVVTRavy66S4aPV9AYNRvzsXIatjsLm4fHtY+qkQu0ml0iMkDA5uTi7YtFX8OGX/8I5Sm+gsssWrXnjUa9g3pvizLWVb9M29EwobQRexRnPW/DxJomB+gxeV5I+/PJrgO9xCcp0V4pDGY0umkyrHK6wdjwyw2iUwpce2ST1NKBKEuTSQIYQKslQWigJElwrrZW5G8OJWUET0MNSURXBwPQotxcG52Uod4BMBizAmijR2xxvPWJ6HVAvMLAunn0ZAhaKGNGVt828tbbrTBecx1JpDdeqmCPF2E6KAlxHXrbkuPpv3cGSLwRVuALpEQIaGsPFA5HIaZyznr1QrfOl5ecEFwBN4awyFFIovCxpqz/ZAj3nNCtrniC1KZRDOpJOzVCS9iZ2EQ/UcVz/HjTy/X7rsUTPBmPY27o41cHppoclMFr/DKx5WscNMI/LBNZS6Xai/PuhnjjY0dfhbXmJfqFy7KbaMzd6Eg9PRCK0ytEE3FkYTt5cnMPi9Xgqkp3x+Dsu9+T87MvT7y9P2RlupG3CDsfT8ZRJzgaqpdmx9NXue/LhZFtvF6k/9vjsBjDhPU2clipuPzGgdbe23Ijh7Zhu352zRFQ2ELPXa75cP3q92TD5fYOed6NZIhbSK5nxjL5Zi0IF/l0MD8tnA/n0h+6N+gqefMI+6XO/SRheIxZSN/wlEnGHq70H82a2Sfplgt1q+Sd5jo52JB8tpXub3Ven56dXpyIR3BL395i7uMd0P9jAk47tLzitD/yXt60nBdbrdkfabIbzLetZiS7G/jRnabbZbP4H92LiCQ==","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Update Folder","permalink":"/docs/API-docs/v1.1/updatefolder"},"next":{"title":"Get folder list","permalink":"/docs/API-docs/v1.1/folderlist"}}');var l=o(74848),s=o(28453),a=o(57742),i=o.n(a),r=o(78178),d=o.n(r),p=o(19624),c=o.n(p),f=o(96226),m=o.n(f),I=(o(77675),o(19365),o(51107)),u=o(21312);const x={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:"eJy9V81uIzcSfpUKL5sR2pLscbKbPq2ROBMnRsaIHRiIRzDY3dVqxmySQ1ZLFgQBOewb7CnXPNo8yaLYP5L8MxsnQS62uor1/7GquBYk50GkN+Jrqwv0YpaIAkPulSNljUjFVYVQoEZCaI/AycUZSK3tMsDKNkC255eRPxaJsA69ZAVnhUhFy265IhFOelkjoWe7a2FkjSIVLftWFSIRig07SZV46I3NfsaczgqwJQwKPb5vlMdCpOQbTESglWaVQdVOo0gE3jttCxRpKXXgA3mFtRTpWtDKxZPklZmLRJTW15J2KXgvo5ZUZN8d5mVxVLlMbDYzNhucNQEDKzqaTvnfvrehyXMMoWw0DBkRicitITTE56VzWuWRMfk5sND6sXdt0Jw5z2pItSb7XLw0jm/uwtG3DpdnTmySrjjFCT2lZit0ND16fXA4PZj+8+rw8/T4i/Szz8fT6fQnkYj7WrNsV8dCErJeUqS33zsEZbQyeNtn7/ZoOr09PBKbDR86fiqNB12pQQUwlgBrR6sEOI1SmQCFzZsaDYH1PQbfmQO4tDVSpcwclsxcemvmCTiNMiCQX4GcS2VAS0L/ybs/VRhr8G0Z0bxfIvTe+o8n9sWhcaaSP2DoRelgI7Pna3Y8nd6+Hkp2/LhkXVQcUmkbU4z/Otg/G+rHMP/Yn49B8nh6fPuvIbzPHod3ZhZSqyK2QrJ3aD75G+LbRvOEeXZ1/yKq9lDki71gd+ltkAHzxitaRQjfH0inDlp+ejNjHDBy7LaVxyZOlUjFpE3sZD20741gdX7Rt/fGa5GKisiFdDIJ0hSZvR9bhyaoudEyC+Pc1hPp1GRxOD4UjO19Genci85jc/BSkUByrsz8/8nNtpm65Gq2BdvL11A26dR3uBJJX47dU92Eq1DyAOMCKFPaKNwV6a1Dc6nmJpY4Gn84Ca9R57ZGHr9UIYxGvciH//w2SI1GQweJYBy/M+/M28aDs0v0PJekKaDUeK8yjVEM68gbZntAWWsMQa9AGcK5l4RQqLkiqYHzxB0ll05mSivGMB+zLO1h5xqEMVxXSBV6Zv3DI0gocIGaoQ+yIVtLYlVDx1taf1fylpGAhKwJymAIgKaSJueDfSUS7o3SABpC77wKCIE8e61a36whL3OCWho5R9adwG6yCtSK4QreZk0gCFY30WUgqbT1WEAfkEEsQkziKa8UHoGpua2dx4phs0CYN6rAwD28QAjxynIIpoAMA4FjX1SOgZU2Rtv8LhawbLQGZ7mDKKl5v9n1kcXJSxO4ybW+9DUYEua85W0DWwdHox8DcoXPlbkL6WjEI/FmwNU1ZkERzj7tr8ByuXwE/Vf7Mm8UfdNk8AM6GxRZv9pKzxVVTRavy66S4aPV9AYNRvzsXIatjsLm4fHtY+qkQu0ml0iMkDA5uTi7YtFX8OGX/8I5Sm+gsssWrXnjUa9g3pvizLWVb9M29EwobQRexRnPW/DxJomB+gxeV5I+/PJrgO9xCcp0V4pDGY0umkyrHK6wdjwyw2iUwpce2ST1NKBKEuTSQIYQKslQWigJElwrrZW5G8OJWUET0MNSURXBwPQotxcG52Uod4BMBizAmijR2xxvPWJ6HVAvMLAunn0ZAhaKGNGVt828tbbrTBecx1JpDdeqmCPF2E6KAlxHXrbkuPpv3cGSLwRVuALpEQIaGsPFA5HIaZyznr1QrfOl5ecEFwBN4awyFFIovCxpqz/ZAj3nNCtrniC1KZRDOpJOzVCS9iZ2EQ/UcVz/HjTy/X7rsUTPBmPY27o41cHppoclMFr/DKx5WscNMI/LBNZS6Xai/PuhnjjY0dfhbXmJfqFy7KbaMzd6Eg9PRCK0ytEE3FkYTt5cnMPi9Xgqkp3x+Dsu9+T87MvT7y9P2RlupG3CDsfT8ZRJzgaqpdmx9NXue/LhZFtvF6k/9vjsBjDhPU2clipuPzGgdbe23Ijh7Zhu352zRFQ2ELPXa75cP3q92TD5fYOed6NZIhbSK5nxjL5Zi0IF/l0MD8tnA/n0h+6N+gqefMI+6XO/SRheIxZSN/wlEnGHq70H82a2Sfplgt1q+Sd5jo52JB8tpXub3Ven56dXpyIR3BL395i7uMd0P9jAk47tLzitD/yXt60nBdbrdkfabIbzLetZiS7G/jRnabbZbP4H92LiCQ==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},S=void 0,b={},h=[];function D(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(I.default,{as:"h1",className:"openapi__heading",children:"Delete Folder"}),"\n",(0,l.jsx)(i(),{method:"delete",path:"/folder/{folder_id}",context:"endpoint"}),"\n",(0,l.jsx)(t.p,{children:"The delete Folder API allows you to delete folder."}),"\n",(0,l.jsx)(I.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,l.jsx)(u.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,l.jsx)(d(),{...o(181)}),"\n",(0,l.jsx)(c(),{...o(4311)}),"\n",(0,l.jsx)(m(),{...o(36153)})]})}function y(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,l.jsx)(t,{...e,children:(0,l.jsx)(D,{...e})}):D(e)}},181(e){e.exports=JSON.parse('{"parameters":[{"name":"folder_id","in":"path","description":"objectId of folder","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"bK1cfd2hpb"}}]}')},4311(e){e.exports={title:"Body"}},36153(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"Hks2JpewIp"},"deletedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"title":"inline_response_200_12"}}}},"400":{"description":"- folder is not empty, contains document or folder.\\n- Something went wrong, please try again later!\\n","content":{"application/json":{"schema":{"type":"object","oneOf":[{"properties":{"error":{"type":"string","example":"folder is not empty, contains document or folder."}}},{"properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}}}],"title":"inline_response_400_3"}}}},"404":{"description":"folder not found.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","format":"string","example":"folder not found."}},"title":"inline_response_404_8"}}}},"405":{"description":"Invalid API token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/ac7da374.a547ee47.js b/assets/js/ac7da374.a547ee47.js deleted file mode 100644 index 498771b61..000000000 --- a/assets/js/ac7da374.a547ee47.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[2043],{40327(e,t,a){a.r(t),a.d(t,{assets:()=>y,contentTitle:()=>h,default:()=>x,frontMatter:()=>g,metadata:()=>i,toc:()=>S});const i=JSON.parse('{"id":"API-docs/v1.1/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/v1.1/delete-template.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/delete-template","permalink":"/docs/API-docs/v1.1/delete-template","draft":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJzNV19v47gR/ypTvvTWUGxnN7dF9dT0NtgLGtwGlxwCNGsEtDSSeKFIHjmyYxgC7qHfoE997UfbT1IMJdmyk9120eLQl8Qazv8Zzvy4FSTLINJ7cYu105IwiEUicgyZV46UNSIVtxXCO9RICAMXnF9fgvN2pXIMsLENrBVVQBWCXCqtaANkwWNtVwgSgsNMFSoDGuQLb+vIPlDCFC4LkHsOFcBY0NaU6MEg5piLRFiHXrJfl7lIRR69GpwSiXDSyxoJPce0FUbWKFIx6HxQrEJxTE5SJY4DvXwHtjjwCqiSFK0HDmiJ0JlkPR5/aZTHXKTkG0xEoI1ma0HVTrMz+OS0zVGkhdSBGbIKaynSraCNi5zklSlFIgrra0l7StsuWH9w1gQMLPF6Pud/R4UZvOydgtBkGYZQNFpvficSkVlDaIglpXNaZTF1s58Di2+fO2SXP2NGnEfPiSbVGe/InPHnruOTjOGm4s9P1WsZ3PfujWiTvjT5OX1Z6PX89ZuT0/nJ/A+3p2/Tsz+m376dzufzv4pEPNWaZfsa5lzgNhGkSO+/22ds0ewBY09pmfnspTTe2BqpUqaENRqCtbemTMBplAGB/AZkKZUBzrT/H2YVvbf+y9n5Os/aUdTKaGXwYeihh7P5/OF0l4SzL/SSsQSFbUz+24b6kv0vB3T28HYX0LfPA7o0K6lVHifVrX1E89vGMzZPnfnn3ao6pnguDoId07sgA2aNV7SJg+3pRDp10p2n9wseF9wpdj8U4zCkSqRiNgyz2XY0CFvBKv1qGJWN1yIVFZEL6WwWpMmX9mlqHZqgSqPlMkwzW8+kU7PV6fRUtMmxjHTuq/ixOflakUCyVKb8d3KLfbZuuKJd0Q5ytiuddOovuBHJUJIxV78rKpQ5+lg+ZQobhftCfXBoblRpYpmj8eOdcoc6szXy9uDFMpkMIp/+9s+d1GQCuc2aGg3Fhpx+NB/Nh8aDs2v0RaNBmhwKjU9qqbvli3U865YvWQgoa40h6A0oQ1j6uBdUqUhq4DzxFMmk69azwsBslqU9jK5CmMJdhVSh56Pfe97eOa5Qc/uDbMjWkljV4C+srX8stF2HBCQsm6AMhgBoKmkyZhwqkYD1IA2gIfTOq4AQyLPXqvPNGvIyI6ilkSWy7gTGycpRK25X8HbZBIJgdRNdBpJKW485DAHFhR2TeME72CMwNbO181hx26wQyoaxSwKZzRFCvLYcgslhiYHAsS8qw7j3G6Nt9hgLyLsVnOUpoqRmvDD2kcXJSxN4o3e+DDXYJcx5y0saOwcnk58CcoWvlHkM6WTy0ZzA/a6v7nAZFOHim+EKrNfrZ63/6lDmvaLvmyX8iM4GRdZv9tKloqpZxusyVrL76DS9R4Oxf0aXYa8jt1l4fvuYOqtQu9kNEndImJ1fX8bB+wo+/fp3uELpDVR23XVr1njUGygHU5y5rvJd2nZzEwobG6/ijGdd8zH0wkBDBu8qSZ9+/UeAH3ANyvRXikOZTK6bpVbZDriGySSF7zxGbDfQOpSXScMAL1SSW2mlJEhwnbRW5nEK52YDTUC/x7pMj3IHYXBeduUOsJQBc7DmAFhO9x4xvQ6oVxhYF++/JQLmihEdVd42ZWdt7EwfnMdCaQ13Ki+RYmzneQ6uJ687Mid85A4WfCGowg1IjxDQ0BSuj0TiSeOc9eyF6pwvrNZ2zQVAkzurDIUUci8L2utP9o2ecZqVNS+QuhTu0X7Sq9mVpLuJfcT7N8JHHspHg/xw3nos0LPBGPa+Lk717XQ/tCVwt/43bc0bm6eWzCKgwFoq3W2UPx3ricsdfR0+FDfoVyrDfqt95kbPIvNMJEKrDE3AEWg4f399Bas307lIRuvxP7jcs6vL7y5+uLlgZ3iQdgk7nc6ncyY5G6iWZmTp6NF3vNu2ezj1f/VG7Dc74RPNnJYqQquYqW2Pie53T0KRiHT8PFwkorKBmGW75Zv7k9dty+RfGvQMvhaJWEmv5JIBwP1W5Crw73z3zPtsjr75sX8xvoKve2m+GNCAXwyDl5XUDX+JRDzi5ujJ2y7aZAAx7HHHcZ5l6Ggk+wwQH6DKdxdXF7cXIhE8ig/x02PET/0PNvCia4fAqvOB/zLKe1Fgu+2wWdvu+Lujz0r0MQ7cnKdF27b/AsJK8DY=","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Update Template","permalink":"/docs/API-docs/v1.1/update-template"},"next":{"title":"Get Template list","permalink":"/docs/API-docs/v1.1/gettemplatelist"}}');var l=a(74848),s=a(28453),p=a(57742),n=a.n(p),o=a(78178),d=a.n(o),r=a(19624),m=a.n(r),c=a(96226),v=a.n(c),u=(a(77675),a(19365),a(51107)),f=a(21312);const g={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:"eJzNV19v47gR/ypTvvTWUGxnN7dF9dT0NtgLGtwGlxwCNGsEtDSSeKFIHjmyYxgC7qHfoE997UfbT1IMJdmyk9120eLQl8Qazv8Zzvy4FSTLINJ7cYu105IwiEUicgyZV46UNSIVtxXCO9RICAMXnF9fgvN2pXIMsLENrBVVQBWCXCqtaANkwWNtVwgSgsNMFSoDGuQLb+vIPlDCFC4LkHsOFcBY0NaU6MEg5piLRFiHXrJfl7lIRR69GpwSiXDSyxoJPce0FUbWKFIx6HxQrEJxTE5SJY4DvXwHtjjwCqiSFK0HDmiJ0JlkPR5/aZTHXKTkG0xEoI1ma0HVTrMz+OS0zVGkhdSBGbIKaynSraCNi5zklSlFIgrra0l7StsuWH9w1gQMLPF6Pud/R4UZvOydgtBkGYZQNFpvficSkVlDaIglpXNaZTF1s58Di2+fO2SXP2NGnEfPiSbVGe/InPHnruOTjOGm4s9P1WsZ3PfujWiTvjT5OX1Z6PX89ZuT0/nJ/A+3p2/Tsz+m376dzufzv4pEPNWaZfsa5lzgNhGkSO+/22ds0ewBY09pmfnspTTe2BqpUqaENRqCtbemTMBplAGB/AZkKZUBzrT/H2YVvbf+y9n5Os/aUdTKaGXwYeihh7P5/OF0l4SzL/SSsQSFbUz+24b6kv0vB3T28HYX0LfPA7o0K6lVHifVrX1E89vGMzZPnfnn3ao6pnguDoId07sgA2aNV7SJg+3pRDp10p2n9wseF9wpdj8U4zCkSqRiNgyz2XY0CFvBKv1qGJWN1yIVFZEL6WwWpMmX9mlqHZqgSqPlMkwzW8+kU7PV6fRUtMmxjHTuq/ixOflakUCyVKb8d3KLfbZuuKJd0Q5ytiuddOovuBHJUJIxV78rKpQ5+lg+ZQobhftCfXBoblRpYpmj8eOdcoc6szXy9uDFMpkMIp/+9s+d1GQCuc2aGg3Fhpx+NB/Nh8aDs2v0RaNBmhwKjU9qqbvli3U865YvWQgoa40h6A0oQ1j6uBdUqUhq4DzxFMmk69azwsBslqU9jK5CmMJdhVSh56Pfe97eOa5Qc/uDbMjWkljV4C+srX8stF2HBCQsm6AMhgBoKmkyZhwqkYD1IA2gIfTOq4AQyLPXqvPNGvIyI6ilkSWy7gTGycpRK25X8HbZBIJgdRNdBpJKW485DAHFhR2TeME72CMwNbO181hx26wQyoaxSwKZzRFCvLYcgslhiYHAsS8qw7j3G6Nt9hgLyLsVnOUpoqRmvDD2kcXJSxN4o3e+DDXYJcx5y0saOwcnk58CcoWvlHkM6WTy0ZzA/a6v7nAZFOHim+EKrNfrZ63/6lDmvaLvmyX8iM4GRdZv9tKloqpZxusyVrL76DS9R4Oxf0aXYa8jt1l4fvuYOqtQu9kNEndImJ1fX8bB+wo+/fp3uELpDVR23XVr1njUGygHU5y5rvJd2nZzEwobG6/ijGdd8zH0wkBDBu8qSZ9+/UeAH3ANyvRXikOZTK6bpVbZDriGySSF7zxGbDfQOpSXScMAL1SSW2mlJEhwnbRW5nEK52YDTUC/x7pMj3IHYXBeduUOsJQBc7DmAFhO9x4xvQ6oVxhYF++/JQLmihEdVd42ZWdt7EwfnMdCaQ13Ki+RYmzneQ6uJ687Mid85A4WfCGowg1IjxDQ0BSuj0TiSeOc9eyF6pwvrNZ2zQVAkzurDIUUci8L2utP9o2ecZqVNS+QuhTu0X7Sq9mVpLuJfcT7N8JHHspHg/xw3nos0LPBGPa+Lk717XQ/tCVwt/43bc0bm6eWzCKgwFoq3W2UPx3ricsdfR0+FDfoVyrDfqt95kbPIvNMJEKrDE3AEWg4f399Bas307lIRuvxP7jcs6vL7y5+uLlgZ3iQdgk7nc6ncyY5G6iWZmTp6NF3vNu2ezj1f/VG7Dc74RPNnJYqQquYqW2Pie53T0KRiHT8PFwkorKBmGW75Zv7k9dty+RfGvQMvhaJWEmv5JIBwP1W5Crw73z3zPtsjr75sX8xvoKve2m+GNCAXwyDl5XUDX+JRDzi5ujJ2y7aZAAx7HHHcZ5l6Ggk+wwQH6DKdxdXF7cXIhE8ig/x02PET/0PNvCia4fAqvOB/zLKe1Fgu+2wWdvu+Lujz0r0MQ7cnKdF27b/AsJK8DY=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},h=void 0,y={},S=[];function T(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Delete Template"}),"\n",(0,l.jsx)(n(),{method:"delete",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,l.jsx)(t.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,l.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,l.jsx)(f.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,l.jsx)(d(),{...a(67822)}),"\n",(0,l.jsx)(m(),{...a(37212)}),"\n",(0,l.jsx)(v(),{...a(5350)})]})}function x(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,l.jsx)(t,{...e,children:(0,l.jsx)(T,{...e})}):T(e)}},67822(e){e.exports=JSON.parse('{"parameters":[{"name":"template_id","in":"path","description":"ID of the template that needs to be deleted","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string"}}]}')},37212(e){e.exports={title:"Body"}},5350(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Template deleted successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","example":"Bxh2aspHp3"},"deletedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"xml":{"name":"delete"},"title":"delete"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"Template not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Template not found!"}},"title":"inline_response_404_6"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/ac7da374.dcb9a5f9.js b/assets/js/ac7da374.dcb9a5f9.js new file mode 100644 index 000000000..c8ce7d7c8 --- /dev/null +++ b/assets/js/ac7da374.dcb9a5f9.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[2043],{40327(e,t,a){a.r(t),a.d(t,{assets:()=>P,contentTitle:()=>u,default:()=>v,frontMatter:()=>j,metadata:()=>i,toc:()=>f});const i=JSON.parse('{"id":"API-docs/v1.1/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/v1.1/delete-template.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/delete-template","permalink":"/docs/API-docs/v1.1/delete-template","draft":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJzNGdtuI7f1V065QGELI8nebFJUKdI6trNrdJs1LLsL1DI81PBIw4giJyRHsmALyEPRDyj60tf+RN/7KfslxSFnRiPZ8WaRIujDrm3y8Nzvc888nzo2uGaXOC8U9+jYTcIEuszKwkuj2YBd5ggnqNAj1FBwdH4GhTULKdDBypSwlD4HnyPwsVTSr8AbsDg3CwQOrsBMTmQGvn4/sWYewOsT14OzCfANhHSgDSijp2hBIwoULGGmQMuJrzPBBkwErmqmWMIKbvkcPVqS6Z5pPkc2YDXOW0koJMlUcJ+zXUHPTsBMtrgCn3MfqDsSaIwQSRIei9+X0qJgA29LTJjzK0XUnJwXipjBu0IZgWww4coRQJbjnLPBPfOrIkB6K/WUJWxi7Jz7zcl6fUP4XWG0Q0cvXh4c0I8dw9RcVkyBK7MMnZuUSq1+xRKWGe1Re3rJi0LJLKiu/52j5/ePGTLj7zDzpEdLivYyEo/HpPHHrOMdD+IO2Nd3+UvuijfFZ2ydVKYRR/75Ry8PXn7WPTzoHvzm8vCLwavfDj7/ondwcPAXlrC7uaK3lQ0FGXidMC+92vy9fgQWyG4BVidrAn71lBqHZo4+l3oKS9QeltboaQKFQu4QvF0Bn3KpgTRt/4daRWuNfV47n8bZuiW11EpqvK196PbVwcHtYaOEV8/4kjYeJqbU4pcV9Sn6zwv06vaLRqDPHwt0phdcSREy1aWZof5l5WmT95H8Y2+VESjcsy1h2+dRSIdZaaVfhcR21+WF7Mb7wfUNpQvyFLNJiiEZ+pwNWL9OZv37ViJcM0JpF3WqLK1iA5Z7X7hBv++4FmNz1zMFaienWvGx62Vm3ueF7C8Oey/ZOtl9w4vik+Cx7H7qE+f5VOrpx97dbLQ1JItGo23prDEdL+QfccWS2iRtqKpW5MgF2mA+qScmPK4M9a5APZRTHcwciO/WlBdQw3z4678asJEe6a+g06HSSoJ0nSlthnBisjLg48qj1dzLBcKHH/4B41IqigsLAheoyBldAt6WjvL+eAWoPdrCSoeu1+kQ/jbdqVxUdZpDZshFPSZUwEWZEaNdi1ysALukUe5Li0COQnUJfG5NOc2pjEs9VZjAxenwclIqkqYHQ9QChMnKOWrvAosNkgTmXPNpq8oTzzybBRDKa85zXzqQGixyBV7OMQGuBfDSmznlg5UpLUknLTZkQMkJZqtMReVwpUL/YUoPC9TCWFAmm3Wl7pEiut0u/XjxAl6j90R16Ln1KOj0dIF2BVTL0XmYl85Dxq1dRbpN9BKH1BikLf9IIXpGIJKm6Ui3LgfwO8KwOfiqghnpTufD3/4O12/MknqKKWpqaXCH4M1e7fTCZO6xt9NpP0dV9IdRKNc/Oj8LiW4/2v9b48GRJZc5Wozty1Tq38MVFY8codOpwhxQL6Q1mlTb6cBe+pPTQLpPeAtrvKF4aqzAJxPMgqoVebDgnu+Y4thYhGNexHZRoqPzBzjmHqfGruAB3lPrRS6bcQ3CwMNIP3S73fCPQDudk9rrOh14gGOLnLzaoRYJlIUIf1lcmFnlUzEzbtyzW5t9474V5qYbDpi/LqUSYLF0fKxazhyb3sJit1A8QwFLKabo3ZeBB9KM0QjGUhSsAlm0DYkhqkmX4jOQeF17gaPjANqOqkavFRaQeiF9KF4wUWZZIz0vx0pmsM3+MOeWuvAiXtahp6SehfDRpsaqpPNQ97U1zhPLJx7eGzsjShEjX2CLO2NbOuEOBL1wQeUTqbmS0eHmsVGp8R4b7XlWGe9PMU+EGKiYyeI9jI2ZkYtNLZ/PuZcZV2pVI/nGKIE24nhnp1wTrQ1nUjspsEnBcGLJHSfxUY3jPY5zY2YRyQVmSDCUjrqUjgAXlHG08TTBBJU7iJ5pwSw1oBaFkdrX6K5czdAFeiuRJqAsM6X2QSOZRSE9UCWhpp8s+LAdGuT4H374p4NvcUl5py4YdPkCjrznWR6y4PvgbjAsi8JYP9JUTVLe3Lu0csg4Sy3BRUAUYHQ0UqOqhPgKo0RzEAFqwzYAmwOSpvIp35oLXa9m9Q3pfhitOay87q3UMzfSQ/SQjlguBd5Ge99WfnmrAgQbUHVDeIAwPaXEcnr+bngJ/cBYzWdKYUZoardpu7er0/a2sFB3kb2NWo8Vcnre9KGV8bga6fT16SVs2qiBFGkQfvucgieFnEJjjKjBeYt8Tl2rCGFmUZRacO1hM6UCRWYck0VA2ekUFidSqZAza8NZ9KUlPA7prUe1ihN0JfMGYadDNXdGCmjmR0DuJFpSVGa0K+fYWOicO7c0VnTPrfGYkWucn3yz8Si6JztNpMLbogIesbTWa51Ax0asqM5oWBobqIfUiDqzq6LC6no13uCAg5Gu7Bkdq1ZjCv/5N6TnV480Ho5bD2pr9gettrYNtuMnOxc79MIFJV9SaVrr591kQgZsvJdyljWq8V+ulFnemggVPPg5x90VNPjQE5J6A7Q7kJn0ijq7UHWo9ZOxAFX0Glenngt5ljdh2Ni3Cr4Lo6jAhvxQlaEU4mwT/ItnGRaUsUmmKhytUUiWnkhUAnhmjXOh0wpSUNqypgx7m8vcIgLBR39u0swg1nSiTlUUc76QlDV3K3nFUwqdPYETXiq/H2pCaMaqbpVSLs29PtTUTZtaZbiIZyFxSXiaNO5i9NdxT4qySFBgtFrV1a8q2xCsWRe+lBe04IrojrmOkU2FvAbHO9JaVZMjN1XtDMQemtTC7dhoODbFCvaOj/eJOVlIytAjfQQal6T2LNto+1G+5rQHC6WM5ME76UJzlY7YuP2O0nqTvzeJOmY/8ramu2is2I+NUmPM0zmXCrgQFh3lDspqKCjeGx5tVSI5dcpjo7sZSdYukIABi9EZbhtAusagogdv5Qw3MiTE/hY3sOfKLKeOIkbJJuKlSPer/WOlh8ga2cuGneTWFm/BVYlJqOQxS5FmlSTFUpsCOC/8Cri1fAV76fVNuv8lmLn0AUtUrTcgdY62OtxGvdPbHi24VCFSTzeNddXgtk4oJmiRc3Xx9onmdhh779BIfEJD3nSCzWy3jeHZ0bl5fXoFFzh99PhjI3u628r8Ga2TJiSpX8PXPJstuRUOjs284F7GTTGB0mNyjrC5hHEN2M0qQBVHC1gcBjdeHPYOm8mv7r9cvVQ2DmERCceExBt7GCpb0sG41nvAqg2MLcaqmeVcTykQqPlqFWpJiV+UWYyFwC+hNmHO5wpKrdA5MD5Hu6QmVBvy8W11XDmkubnqgUa6C9dNa/oex0563Mx9y+Xykab3w5tvSqWgHn5CwH1kWozPXkv/phzDBRbGSW/savNqKn1ejoMt22+bPyoE9ZDS7NR+zpQaUF6inTvaug/RLmT2EfH7nsD7+yPazezsc7bXLhYnaCnvuK0Zmxeymuevaz6A2Ps5ctDirppVwm6QUl9cLP1hF0/Y8ZEI7yaVvNVy63l5WcKUzFA7bO0Oj16fv4XFZ70DlrS2ZD/Blv23Z8en3w5PiZkqTNiAHfYOegd0VBjn51y3KO18+9ldcd1vtqr/V5+KqgWfxzvfLxSXYcMaNHVfrUavmy9DLGHtLpK+geXGeQK5v6dkcWXVek3H35doaQd7k7AFt5KyStifVr2ZaL72/KiO9i6qAXsfPu2D05MC1WtMTTvMUIzYgLGEzXC18+VrfbNO6l0mcRwhjkLr13r7aC++tVw+OX17ennKEsZL0mB7jToLa9TqFyLwJGvb+9XIA/1Py94nH9zfxxXtet3Ax6sffVHJWEOTnm7W6/V/AXOyPt4=","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Update Template","permalink":"/docs/API-docs/v1.1/update-template"},"next":{"title":"Get Template list","permalink":"/docs/API-docs/v1.1/gettemplatelist"}}');var n=a(74848),p=a(28453),l=a(57742),s=a.n(l),d=a(78178),o=a.n(d),r=a(19624),m=a.n(r),c=a(96226),h=a.n(c),q=(a(77675),a(19365),a(51107)),U=a(21312);const j={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:"eJzNGdtuI7f1V065QGELI8nebFJUKdI6trNrdJs1LLsL1DI81PBIw4giJyRHsmALyEPRDyj60tf+RN/7KfslxSFnRiPZ8WaRIujDrm3y8Nzvc888nzo2uGaXOC8U9+jYTcIEuszKwkuj2YBd5ggnqNAj1FBwdH4GhTULKdDBypSwlD4HnyPwsVTSr8AbsDg3CwQOrsBMTmQGvn4/sWYewOsT14OzCfANhHSgDSijp2hBIwoULGGmQMuJrzPBBkwErmqmWMIKbvkcPVqS6Z5pPkc2YDXOW0koJMlUcJ+zXUHPTsBMtrgCn3MfqDsSaIwQSRIei9+X0qJgA29LTJjzK0XUnJwXipjBu0IZgWww4coRQJbjnLPBPfOrIkB6K/WUJWxi7Jz7zcl6fUP4XWG0Q0cvXh4c0I8dw9RcVkyBK7MMnZuUSq1+xRKWGe1Re3rJi0LJLKiu/52j5/ePGTLj7zDzpEdLivYyEo/HpPHHrOMdD+IO2Nd3+UvuijfFZ2ydVKYRR/75Ry8PXn7WPTzoHvzm8vCLwavfDj7/ondwcPAXlrC7uaK3lQ0FGXidMC+92vy9fgQWyG4BVidrAn71lBqHZo4+l3oKS9QeltboaQKFQu4QvF0Bn3KpgTRt/4daRWuNfV47n8bZuiW11EpqvK196PbVwcHtYaOEV8/4kjYeJqbU4pcV9Sn6zwv06vaLRqDPHwt0phdcSREy1aWZof5l5WmT95H8Y2+VESjcsy1h2+dRSIdZaaVfhcR21+WF7Mb7wfUNpQvyFLNJiiEZ+pwNWL9OZv37ViJcM0JpF3WqLK1iA5Z7X7hBv++4FmNz1zMFaienWvGx62Vm3ueF7C8Oey/ZOtl9w4vik+Cx7H7qE+f5VOrpx97dbLQ1JItGo23prDEdL+QfccWS2iRtqKpW5MgF2mA+qScmPK4M9a5APZRTHcwciO/WlBdQw3z4678asJEe6a+g06HSSoJ0nSlthnBisjLg48qj1dzLBcKHH/4B41IqigsLAheoyBldAt6WjvL+eAWoPdrCSoeu1+kQ/jbdqVxUdZpDZshFPSZUwEWZEaNdi1ysALukUe5Li0COQnUJfG5NOc2pjEs9VZjAxenwclIqkqYHQ9QChMnKOWrvAosNkgTmXPNpq8oTzzybBRDKa85zXzqQGixyBV7OMQGuBfDSmznlg5UpLUknLTZkQMkJZqtMReVwpUL/YUoPC9TCWFAmm3Wl7pEiut0u/XjxAl6j90R16Ln1KOj0dIF2BVTL0XmYl85Dxq1dRbpN9BKH1BikLf9IIXpGIJKm6Ui3LgfwO8KwOfiqghnpTufD3/4O12/MknqKKWpqaXCH4M1e7fTCZO6xt9NpP0dV9IdRKNc/Oj8LiW4/2v9b48GRJZc5Wozty1Tq38MVFY8codOpwhxQL6Q1mlTb6cBe+pPTQLpPeAtrvKF4aqzAJxPMgqoVebDgnu+Y4thYhGNexHZRoqPzBzjmHqfGruAB3lPrRS6bcQ3CwMNIP3S73fCPQDudk9rrOh14gGOLnLzaoRYJlIUIf1lcmFnlUzEzbtyzW5t9474V5qYbDpi/LqUSYLF0fKxazhyb3sJit1A8QwFLKabo3ZeBB9KM0QjGUhSsAlm0DYkhqkmX4jOQeF17gaPjANqOqkavFRaQeiF9KF4wUWZZIz0vx0pmsM3+MOeWuvAiXtahp6SehfDRpsaqpPNQ97U1zhPLJx7eGzsjShEjX2CLO2NbOuEOBL1wQeUTqbmS0eHmsVGp8R4b7XlWGe9PMU+EGKiYyeI9jI2ZkYtNLZ/PuZcZV2pVI/nGKIE24nhnp1wTrQ1nUjspsEnBcGLJHSfxUY3jPY5zY2YRyQVmSDCUjrqUjgAXlHG08TTBBJU7iJ5pwSw1oBaFkdrX6K5czdAFeiuRJqAsM6X2QSOZRSE9UCWhpp8s+LAdGuT4H374p4NvcUl5py4YdPkCjrznWR6y4PvgbjAsi8JYP9JUTVLe3Lu0csg4Sy3BRUAUYHQ0UqOqhPgKo0RzEAFqwzYAmwOSpvIp35oLXa9m9Q3pfhitOay87q3UMzfSQ/SQjlguBd5Ge99WfnmrAgQbUHVDeIAwPaXEcnr+bngJ/cBYzWdKYUZoardpu7er0/a2sFB3kb2NWo8Vcnre9KGV8bga6fT16SVs2qiBFGkQfvucgieFnEJjjKjBeYt8Tl2rCGFmUZRacO1hM6UCRWYck0VA2ekUFidSqZAza8NZ9KUlPA7prUe1ihN0JfMGYadDNXdGCmjmR0DuJFpSVGa0K+fYWOicO7c0VnTPrfGYkWucn3yz8Si6JztNpMLbogIesbTWa51Ax0asqM5oWBobqIfUiDqzq6LC6no13uCAg5Gu7Bkdq1ZjCv/5N6TnV480Ho5bD2pr9gettrYNtuMnOxc79MIFJV9SaVrr591kQgZsvJdyljWq8V+ulFnemggVPPg5x90VNPjQE5J6A7Q7kJn0ijq7UHWo9ZOxAFX0Glenngt5ljdh2Ni3Cr4Lo6jAhvxQlaEU4mwT/ItnGRaUsUmmKhytUUiWnkhUAnhmjXOh0wpSUNqypgx7m8vcIgLBR39u0swg1nSiTlUUc76QlDV3K3nFUwqdPYETXiq/H2pCaMaqbpVSLs29PtTUTZtaZbiIZyFxSXiaNO5i9NdxT4qySFBgtFrV1a8q2xCsWRe+lBe04IrojrmOkU2FvAbHO9JaVZMjN1XtDMQemtTC7dhoODbFCvaOj/eJOVlIytAjfQQal6T2LNto+1G+5rQHC6WM5ME76UJzlY7YuP2O0nqTvzeJOmY/8ramu2is2I+NUmPM0zmXCrgQFh3lDspqKCjeGx5tVSI5dcpjo7sZSdYukIABi9EZbhtAusagogdv5Qw3MiTE/hY3sOfKLKeOIkbJJuKlSPer/WOlh8ga2cuGneTWFm/BVYlJqOQxS5FmlSTFUpsCOC/8Cri1fAV76fVNuv8lmLn0AUtUrTcgdY62OtxGvdPbHi24VCFSTzeNddXgtk4oJmiRc3Xx9onmdhh779BIfEJD3nSCzWy3jeHZ0bl5fXoFFzh99PhjI3u628r8Ga2TJiSpX8PXPJstuRUOjs284F7GTTGB0mNyjrC5hHEN2M0qQBVHC1gcBjdeHPYOm8mv7r9cvVQ2DmERCceExBt7GCpb0sG41nvAqg2MLcaqmeVcTykQqPlqFWpJiV+UWYyFwC+hNmHO5wpKrdA5MD5Hu6QmVBvy8W11XDmkubnqgUa6C9dNa/oex0563Mx9y+Xykab3w5tvSqWgHn5CwH1kWozPXkv/phzDBRbGSW/savNqKn1ejoMt22+bPyoE9ZDS7NR+zpQaUF6inTvaug/RLmT2EfH7nsD7+yPazezsc7bXLhYnaCnvuK0Zmxeymuevaz6A2Ps5ctDirppVwm6QUl9cLP1hF0/Y8ZEI7yaVvNVy63l5WcKUzFA7bO0Oj16fv4XFZ70DlrS2ZD/Blv23Z8en3w5PiZkqTNiAHfYOegd0VBjn51y3KO18+9ldcd1vtqr/V5+KqgWfxzvfLxSXYcMaNHVfrUavmy9DLGHtLpK+geXGeQK5v6dkcWXVek3H35doaQd7k7AFt5KyStifVr2ZaL72/KiO9i6qAXsfPu2D05MC1WtMTTvMUIzYgLGEzXC18+VrfbNO6l0mcRwhjkLr13r7aC++tVw+OX17ennKEsZL0mB7jToLa9TqFyLwJGvb+9XIA/1Py94nH9zfxxXtet3Ax6sffVHJWEOTnm7W6/V/AXOyPt4=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-2",custom_edit_url:null},u=void 0,P={},f=[];function g(e){const t={p:"p",...(0,p.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(q.default,{as:"h1",className:"openapi__heading",children:"Delete Template"}),"\n",(0,n.jsx)(s(),{method:"delete",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,n.jsx)(t.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,n.jsx)(q.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,n.jsx)(U.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,n.jsx)(o(),{...a(67822)}),"\n",(0,n.jsx)(m(),{...a(37212)}),"\n",(0,n.jsx)(h(),{...a(5350)})]})}function v(e={}){const{wrapper:t}={...(0,p.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(g,{...e})}):g(e)}},67822(e){e.exports=JSON.parse('{"parameters":[{"name":"template_id","in":"path","description":"ID of the template that needs to be deleted","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string"}}]}')},37212(e){e.exports={title:"Body"}},5350(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Template deleted successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","example":"Bxh2aspHp3"},"deletedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"xml":{"name":"delete"},"title":"delete"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"Template not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Template not found!"}},"title":"inline_response_404_6"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/b2e6bd40.26dcf7b4.js b/assets/js/b2e6bd40.26dcf7b4.js deleted file mode 100644 index b9f57c4b2..000000000 --- a/assets/js/b2e6bd40.26dcf7b4.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[7960],{99088(e,t,s){s.r(t),s.d(t,{assets:()=>j,contentTitle:()=>h,default:()=>I,frontMatter:()=>v,metadata:()=>n,toc:()=>f});const n=JSON.parse('{"id":"API-docs/v1.1/resendrequestmail","title":"Resend request mail","description":"Resend request mail to user for signing document.","source":"@site/docs/API-docs/v1.1/resendrequestmail.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/resendrequestmail","permalink":"/docs/API-docs/v1.1/resendrequestmail","draft":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJztWN1uW7kRfpUpb9IVjiUlTW8E11jXDbJGg40Re2EUjiFQ58zR4ZqH5PJHsioI2Iu+Qa/2dh8tT1IMef4ka5NNg7ZAsTeGPOQMZ74ZznyHW+b50rHZHfuLzkONyjt2n7ECXW6F8UIrNmPv0KEqwOIPAZ2HmgsJXkNwaKHUFpxYKqGWUDQmxu8Vy5g2aDlZuCw6G40JssAy1vz3Z11s2GzLcq08Kk8/uTFS5FF78r0jJ7bM5RXWnH6RnrBYkNvtmXNRsIxhtHyfMb8xyGZML77H3LOMGUvueIGODAyVZtt2s/NWqCVZeeS1kSQyVq9EgV1kIAq2a485ormPW6sdgYqolVbXES60jiC0ePIE2oRe7wNpf938O8513TkwdyGF90lHLoLzzcHcB4vdedEONHZAKPD46CeVryUltuZ+DBdcgVC5DAVCqaXUa0r1ilvBFxIdwHbbwemFl7jbwXZLUaGdK17jbpf1AjpvT2AqrZotFnMUqz2tToS9YicbqOKjEXYzL7hvBLmuDVeboQOpSOfBNnaUps3jPawPHIeKuxYrLGCjAyWNLB2Jus/LoinoL0oKGfktI+zUnH0jjrhyOjFnp+bsFqHSBsFXwjXAlUIVLuZqjVKO4dR5q9Xy7ACC00kjP55kiyuBa+CqSPnurRxi2xkaNz79TQc7SKtwkNuQCx6bprE6RyxgLXwFvkJQ+OjBeTQOuAPhUzctBcYYLPClRYy9h3zhwVfair/H1tgeeMqhslj+6dkBps/Orsn1Ci2eTvhZs/uyjDFWfIXA1QZi4EIrB9qCIt/KYH2FFnLJrSibPpyBkcgdArVpnvvofEK09eOm4urBZacLe3aDvIa3BhV58OEfP9MOtttlLILGZszGedBflx0t9o3d24BR4IxWLnXtF9NpbN57t4hlv35ufHwoWHRBHm2m6eIdnxCpgVJ6XMhzdK4MUm7Ge7EKJYXCeRvM/MV0On8+pZB3GXv5n40KrdX2c4O61jX6irrKmiJbU3l/PKSX0+n8RRfRy6cRnfQzVGkPpQ6qAFEOJyvdFFrLtbWYE4s4SaNzT6EZqkVaSle+UTSxqOIcSzMWpHAedH9KHK3/S2SPgKDtQZSfQvrl/HmH9B+fIn2pVlyKAs6vLuFGP6D63X8h5j7C4fE+HU+uPtaRMFHvjUHFTXGd7QU7lKcgHebBCr9hs7stezzhRpyk9dnd/e4+Y1Sqmiim0S56zH3FZmzSdxhGRuwKrYs2gpVsxirvjZtNJo6rYqEfx9qgoqqRfOGIZk24EZPV8/FztssOdbgxn7Ufw8nnqjjPl0ItP6V33+NzTTlMadpDqUsWN+KvuGFZm4ThrowJqp0KeYE2JoxK411P0F+1CT5gz0cpcseQn5LXJ9z1yzjXPuX6jS38P7EFqslSxwJu2kO7JTaXeAEOSfUtylzXSNjRiaPRwGqnNRp11ZqQea/eq7fBgtFrtGWQEbxS4qNYSIxqWMc119Uj8lqic5I4usel5R6hEEvhuey+h3Nu+EJIQd2TtukmR30DdmO4rTDCt9HhmUXgUOAKJTVdSp+uuR9+WsNa24dS6rXLgMMiOKHQOUBVcZXTxrYbZJQfrgCVR2uscAjOW/JaJN+08pYSU3PFl7FksmEKoEBJN8iB1YvgPDgtQ0q850JqiwW0AVEZuAjiq0dDS0BSIvwWK2pdK4RlEAW6DHJdILjYDygEVcCCvnkM+SJyjF/FQUmdP8QEEpsCo2l20ZXQ5Z6PpO4tV45GbvKlzUEHWLxCzmFycDT6ziFl+I1QD242GhHJuOvq6hYXTni8/33bhtfr9ZP2+9W+zmvhvwkLeIdGO+G13fTaS+GrsIgte2ik+ydZeo0KY/0MGnJvo9C5ezoBSDqpUJrJNXqqEDc5v7qM4/4r+PDjP+ENcqug0utUrXmwKDewbI8i5FLmE2zdtI4POtQ3CPE8FV/T7loEbyvuP/z4k4NvcU1cK10pCmU0ugoLKXK4wdpI7tGNRjO4sEhH+lYGvuIecq5ggeAqTqW0Ehw4mKQthXoYw7naJGLUNT+SR729MGLDbdPtYMEdFqBV1GjPHPcekbx2KFfoyBaxrgUCFoLaua+sDst02tCZJjiLpZASbkWxRB9jOy8Kop1RvE5iAnzgDpZ0IXyFG+A29kA/hqsDlbgSjNGWvBDJ+f7bHlVhtFDezaCwvPS9/awv9Jxgjq33iShByDs4ssZMl5J0E5uIO2l6iTogE/v91mKJlg6MYfd5MaIpp7u2LIGq9UvKmgZCM00iFW0YBjfi60M7kVKird3b8hrtSuTYMKtfuNGTuHnCMiZFjsrhgKqev756A6s/jKcsG1C0X3G5J28uL159e/2KnKFGmgB7Pp6OpyQitlpzNTjpyDPr4XwbPJL+m6+yDReMr0pGchHpd4xr2zDnu8G3OT2lVkSrZ3dsu6Wr9R1RBRL/ENASJ7/PWPv0FBl51pJIotoPSKzsIvl8ckNn03YZEh89+BAhFpw0zvMcjf/o3iHzv3p7fcMy1r671bqITwx8TY/MfJ0+qHXEMH3qk2zLJFfLwJe0N9kk3ku9b580P0TS3PygqNoltRl4uM+mUxj0l4I6qrDdJkIeWWzan5Z+UaMBtt1Nubvf7Xb/AtkJjmI=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Document list from status","permalink":"/docs/API-docs/v1.1/getdocumentlist"},"next":{"title":"Get Signer IPs","permalink":"/docs/API-docs/v1.1/getsignerips"}}');var i=s(74848),r=s(28453),o=s(57742),a=s.n(o),d=s(78178),p=s.n(d),l=s(19624),u=s.n(l),c=s(96226),m=s.n(c),q=(s(77675),s(19365),s(51107)),g=s(21312);const v={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:"eJztWN1uW7kRfpUpb9IVjiUlTW8E11jXDbJGg40Re2EUjiFQ58zR4ZqH5PJHsioI2Iu+Qa/2dh8tT1IMef4ka5NNg7ZAsTeGPOQMZ74ZznyHW+b50rHZHfuLzkONyjt2n7ECXW6F8UIrNmPv0KEqwOIPAZ2HmgsJXkNwaKHUFpxYKqGWUDQmxu8Vy5g2aDlZuCw6G40JssAy1vz3Z11s2GzLcq08Kk8/uTFS5FF78r0jJ7bM5RXWnH6RnrBYkNvtmXNRsIxhtHyfMb8xyGZML77H3LOMGUvueIGODAyVZtt2s/NWqCVZeeS1kSQyVq9EgV1kIAq2a485ormPW6sdgYqolVbXES60jiC0ePIE2oRe7wNpf938O8513TkwdyGF90lHLoLzzcHcB4vdedEONHZAKPD46CeVryUltuZ+DBdcgVC5DAVCqaXUa0r1ilvBFxIdwHbbwemFl7jbwXZLUaGdK17jbpf1AjpvT2AqrZotFnMUqz2tToS9YicbqOKjEXYzL7hvBLmuDVeboQOpSOfBNnaUps3jPawPHIeKuxYrLGCjAyWNLB2Jus/LoinoL0oKGfktI+zUnH0jjrhyOjFnp+bsFqHSBsFXwjXAlUIVLuZqjVKO4dR5q9Xy7ACC00kjP55kiyuBa+CqSPnurRxi2xkaNz79TQc7SKtwkNuQCx6bprE6RyxgLXwFvkJQ+OjBeTQOuAPhUzctBcYYLPClRYy9h3zhwVfair/H1tgeeMqhslj+6dkBps/Orsn1Ci2eTvhZs/uyjDFWfIXA1QZi4EIrB9qCIt/KYH2FFnLJrSibPpyBkcgdArVpnvvofEK09eOm4urBZacLe3aDvIa3BhV58OEfP9MOtttlLILGZszGedBflx0t9o3d24BR4IxWLnXtF9NpbN57t4hlv35ufHwoWHRBHm2m6eIdnxCpgVJ6XMhzdK4MUm7Ge7EKJYXCeRvM/MV0On8+pZB3GXv5n40KrdX2c4O61jX6irrKmiJbU3l/PKSX0+n8RRfRy6cRnfQzVGkPpQ6qAFEOJyvdFFrLtbWYE4s4SaNzT6EZqkVaSle+UTSxqOIcSzMWpHAedH9KHK3/S2SPgKDtQZSfQvrl/HmH9B+fIn2pVlyKAs6vLuFGP6D63X8h5j7C4fE+HU+uPtaRMFHvjUHFTXGd7QU7lKcgHebBCr9hs7stezzhRpyk9dnd/e4+Y1Sqmiim0S56zH3FZmzSdxhGRuwKrYs2gpVsxirvjZtNJo6rYqEfx9qgoqqRfOGIZk24EZPV8/FztssOdbgxn7Ufw8nnqjjPl0ItP6V33+NzTTlMadpDqUsWN+KvuGFZm4ThrowJqp0KeYE2JoxK411P0F+1CT5gz0cpcseQn5LXJ9z1yzjXPuX6jS38P7EFqslSxwJu2kO7JTaXeAEOSfUtylzXSNjRiaPRwGqnNRp11ZqQea/eq7fBgtFrtGWQEbxS4qNYSIxqWMc119Uj8lqic5I4usel5R6hEEvhuey+h3Nu+EJIQd2TtukmR30DdmO4rTDCt9HhmUXgUOAKJTVdSp+uuR9+WsNa24dS6rXLgMMiOKHQOUBVcZXTxrYbZJQfrgCVR2uscAjOW/JaJN+08pYSU3PFl7FksmEKoEBJN8iB1YvgPDgtQ0q850JqiwW0AVEZuAjiq0dDS0BSIvwWK2pdK4RlEAW6DHJdILjYDygEVcCCvnkM+SJyjF/FQUmdP8QEEpsCo2l20ZXQ5Z6PpO4tV45GbvKlzUEHWLxCzmFycDT6ziFl+I1QD242GhHJuOvq6hYXTni8/33bhtfr9ZP2+9W+zmvhvwkLeIdGO+G13fTaS+GrsIgte2ik+ydZeo0KY/0MGnJvo9C5ezoBSDqpUJrJNXqqEDc5v7qM4/4r+PDjP+ENcqug0utUrXmwKDewbI8i5FLmE2zdtI4POtQ3CPE8FV/T7loEbyvuP/z4k4NvcU1cK10pCmU0ugoLKXK4wdpI7tGNRjO4sEhH+lYGvuIecq5ggeAqTqW0Ehw4mKQthXoYw7naJGLUNT+SR729MGLDbdPtYMEdFqBV1GjPHPcekbx2KFfoyBaxrgUCFoLaua+sDst02tCZJjiLpZASbkWxRB9jOy8Kop1RvE5iAnzgDpZ0IXyFG+A29kA/hqsDlbgSjNGWvBDJ+f7bHlVhtFDezaCwvPS9/awv9Jxgjq33iShByDs4ssZMl5J0E5uIO2l6iTogE/v91mKJlg6MYfd5MaIpp7u2LIGq9UvKmgZCM00iFW0YBjfi60M7kVKird3b8hrtSuTYMKtfuNGTuHnCMiZFjsrhgKqev756A6s/jKcsG1C0X3G5J28uL159e/2KnKFGmgB7Pp6OpyQitlpzNTjpyDPr4XwbPJL+m6+yDReMr0pGchHpd4xr2zDnu8G3OT2lVkSrZ3dsu6Wr9R1RBRL/ENASJ7/PWPv0FBl51pJIotoPSKzsIvl8ckNn03YZEh89+BAhFpw0zvMcjf/o3iHzv3p7fcMy1r671bqITwx8TY/MfJ0+qHXEMH3qk2zLJFfLwJe0N9kk3ku9b580P0TS3PygqNoltRl4uM+mUxj0l4I6qrDdJkIeWWzan5Z+UaMBtt1Nubvf7Xb/AtkJjmI=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},h=void 0,j={},f=[];function P(e){const t={p:"p",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(q.default,{as:"h1",className:"openapi__heading",children:"Resend request mail"}),"\n",(0,i.jsx)(a(),{method:"post",path:"/resendmail",context:"endpoint"}),"\n",(0,i.jsx)(t.p,{children:"Resend request mail to user for signing document."}),"\n",(0,i.jsx)(q.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,i.jsx)(g.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,i.jsx)(p(),{parameters:void 0}),"\n",(0,i.jsx)(u(),{...s(36467)}),"\n",(0,i.jsx)(m(),{...s(62229)})]})}function I(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(P,{...e})}):P(e)}},36467(e){e.exports=JSON.parse('{"title":"Body","body":{"content":{"application/json":{"schema":{"required":["document_id","email"],"type":"object","properties":{"document_id":{"type":"string","example":"provide document id"},"email":{"type":"string","description":"provide user mail from signers to re-send request mail.\\n","example":"user@example.com"},"email_subject":{"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}}, {{note}}.","example":"{{sender_name}} has requested you to sign {{document_title}}"},"email_body":{"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}}, {{note}}.","example":"

Hi {{receiver_name}},

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

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

Sign here

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

Thanks,
Team OpenSign\u2122

"}},"title":"resendmail_body"}}},"required":true}}')},62229(e){e.exports=JSON.parse('{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","format":"string","example":"mail sent successfully."}},"title":"inline_response_200_10"}}}},"400":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","format":"string","example":"Something went wrong."}},"title":"inline_response_400_2"}}}},"404":{"description":"- document not found if document id is not correct.\\n- user not found if provided user email is not present in signer list of document\\n","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","format":"string","example":"document not found or user not found."}},"title":"inline_response_404_1"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/b2e6bd40.85e11238.js b/assets/js/b2e6bd40.85e11238.js new file mode 100644 index 000000000..44fd3dd1a --- /dev/null +++ b/assets/js/b2e6bd40.85e11238.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[7960],{99088(e,n,t){t.r(n),t.d(n,{assets:()=>b,contentTitle:()=>N,default:()=>V,frontMatter:()=>q,metadata:()=>s,toc:()=>f});const s=JSON.parse('{"id":"API-docs/v1.1/resendrequestmail","title":"Resend request mail","description":"Resend request mail to user for signing document.","source":"@site/docs/API-docs/v1.1/resendrequestmail.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/resendrequestmail","permalink":"/docs/API-docs/v1.1/resendrequestmail","draft":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJztWt1uG7kVfpXTCdCNBf04aXqjdd31Ot4kaLoxLKdBYRsWNXNGwxWHnCU5klXZwF4UfYCiN73tS/S+j5InKQ5/Zkaym2watAWKvYgjccjD8/udn9EmsWxukvFF8lyldYnSmuSqn2RoUs0ry5VMxskZGpQZaPy+RmOhZFyAVVAb1JArDYbPJZdzyAKJ4aVM+omqUDOi8CpraAQSRCHpJ+Hb1ypbJ+NNkippUVr6yKpK8NSdHn1niIlNYtICS0af6BzXmBHb8c5rniX9BB3lq35i1xUm40TNvsPUJv2k0sSO5WiIQPfQeBM3G6u5nBOVG1ZWgpYqrZY8w0Yy4FlyF6954OS23uJppyintVyr0qkLtSEVahzcU63XXssDnf4qfB2mqmwYuDa1F++jjBzXxoaLma01Nvc5OhDoAJdg8caOClsKMmzJ7BCOmQQuU1FnCLkSQq3I1EumOZsJNACbTaNOy63AuzvYbEgq1NeSlXh3128X6L6thapQMmzRmCJfbp1qlrA92Kx1juJNxfX6OmM2LKSqrJhcdxnwTnpd60BHKto83NL1DuNQMBN1hRmsVU1GI0oPSN3aZRYc+rOMQkR+skhyUB2+5A+wcjCqDg+qw3cIhaoQbMFNUFzOZWacrVYoxBAOjNVKzg93VHAwCusPG1njkuMKmMy8vVsqu7ptCA0DT79Xte6YlRtIdZ1y5kCz0ipFzGDFbQG2QJB4Y8FYrAwwA9x6NM05Ohk0sLlGdNhDvLDaFkrzPzhojBceMCg05r/6YkenXxxOiPUCNR6M2GHY/Sp3MhZsicDkGpzgXEkDSoMk3vJa2wI1pIJpngcc7kMlkBkEgmmWWse812jk47xgcmH6BzN9eI6shDcVSuLg/R//RjuSu7t+4pSWjBPt8kEbLnf0sAV2q2t0C6ZS0njUfrq/78B7K4qS/o/PGx9OChpNLR4EUx94D2cID6BkHlOnKRqT10Ksh1uycim4xOsozPXT/f3rJ/sk8l0/efaflQq1VvpThZqoEm1BqLIiyVbk3h8W6dn+/vXTRqJn9yUatDlUKgu5qmUGPO9mVooUepYqrTGlKmLgU+fWgZBUM//Ih3w4WDmncnnM51gQ3FhQ7S0utf4vNfuAEpTekfJjmn52/aTR9C/va/qVXDLBMzg6fQXnaoHyZ/8FmVsJu9dbfz2xelO6gomw1wnlNrnnyZaw3XUvpMG01tyuk/HFJrkZsIoP/PPxxdXdVT8hV1VUYlbKOI6ZLZJxMmoRJiEieonaOBq1Fsk4KaytzHg0MkxmM3UzVBVK8hrBZobKrBGr+Gj5ZPg0uevvnmFV9Un7sR586hFj2ZzL+cfOXbX6mZANvZm2tNQYi1X8N7hO+tEI3V39hJPvFMgy1M5g5BpnbYF+Eg28Uz0/WCI3FfL94vVe7fp5Ndd2yfVTtfD/VC2QT+bKOXCAh7jFgYsLgN2i+lGXTLPtUl7KQ+j1zgsECqaBUbVOEajndfSYsKgls3yJ8P6Hv8Cs5sK63jbDJQqCQNMHq2tn9NkaUFrUleYGzbDXI/rde+d86Q0CDKjuFWixT8bM6pQYHWhk2Rpw0Nq9EsxS4gBbaFXPC2BguJwL7MPZyeQ8rwVJM4QJtYvRqUzTfjsifSiZZHMEiyXRQ8czSxdNh24ss7WhBKmRPIyX2I+eokpm0XsRSst1J6QFzzFdp8IrhwnhHFLVFpYoM6VBqHQx4HJIihgMBvTfo0fwAq2lWyeWaYsZrZ4sUa/bdrc2FlKm9drf2+QM1/gUCNMORk3Bo5O7ZDqdXsrOwzEcEIV24TDsuZS93vs//RkuXqoVRdQcJY0lcOfCq8cReDOVmvuIS6ujAkU1mnihzOjo9JVLr3ve/t8qKgE1wooiiK6a4ZzLX8Nbg06WXi+kGkC55FpJUm2vB4+nPzoVTfcCKFhFmN5YgeU5pk7Vgjw4Y5btmOJYaYRjVrEZF5yyOa3fwjGzOFd6DbfwrmDWuWzKJGQKbi/l7WAwcP9oa6/XTIh6PbiFY42MvJqCug91lblvGpdqEXwqQ/L71j0H0eyt+wbK59FfHeWvay5oJFIb6mdbZ/YoWGkcVIKlDhWzOVrzpeOBNKMkEiyVBFRxyhKumKDIBxSf7ooX0QsMLbut3ahq9BrrSC6X3Dpgg1yoVSR6Ws8ET2Gb/UnBNAKDyj+MoSe4XLjwkWqrOo09T6T5XLPcwjulF3STp0jg23KndEcnzEBGJ4xTec4lE9w7XAm0Q0e6xx6IPY+/9TixjrmH4DsA9UypBbnYXLOyZJanTIh1JPKNEhlqT+ONnjNJd7WccWmoFGhg+rkmd8z9oUjjHc4KpRaeyJlP1A6OBgRHgMtQHje5xID3TA1qJQFlVikubST31kSGztBqjpSn0lTVIQWmGjNOLYGvysmCt9uhQY7//oe/GvgWV4Q7MWHQw0dwZC1LC4eC75y7waSuKqXtpaRsMmXNczMNDunbkRUYvxEzUNIbqVFVn/gi/2sX/IZo2GZDu0DSBJ+Ki4RfZhhZfUm6n3hrToLXveZyYS7lBC1ML5OCZ3jt7X0dc79wO5IxZTeEW8iZMDgllqenbybnMHKMRT6nFGZEJrpN171NhO1tYSH2LsNWrccCGR2PoRONx8SlnL44OYdRlHE05tnUCb+9TsEz9XXJDFGCsRpZSb1S5sJMY1bLjEkLFdOsREsuyNyYrVRLzBzJXq/SmHMhHGZGw2m0tSY6BumsRbHuTm47BHs9yrkLUkAzqgBkhqMmRaVKmrrExkKnzJiV0tngVCuLKbnG6fNvWo+i52SnnAu8rsLmy2Qa9RoB1M0GVwVKWCntbnfQiDLV6ypQNcNI1zng+FIGe3rHimqcwj/+DtPTt/c07pY7B6I1R+O473p7246f7DzYuc89IPAllU6jft7kORmw8V7CLK1E47+Mhp3Xyu9yHvwhx90V1PnQA5JaBXhDPTG3gio7l3Wo9OM+AYX7GlenmgtZWjRh2Ng3BN+ZEpRgHT6ENDQF31E7/2JpihUhNskUwlErgWTpnKPIgKVaGeMqLScFwZZWtUUzhPNCIwLt9/7cwMzY53S6nbIoFmzJCTV3M3ngaQq9xxnmrBZ2z+UEV4yFapUglwp463JqW6YGhPN0qOchOg2MGx/9Me5JUaEzUlKsY/YLaRucNWPim7KKOklPjibcTccRt+MNaS3k5HZizrXvd24baGF6piQcq2oNj4+P94g5XnFC6Et5BBJXpPY0bbV9D6+ZUHLuUhnJgzfcuOJqepnMuucI1hv8boHao5/rBWN10Vhx5AulxpgnrgllWabREHYQqmFG8d7wGHpZaiWcZIOUJOsmyNDKKpnitgGomQwGzYbwmi+wlaFP7G9xA49NnRZUUfgoaSOeZ9O9MHgLevCskb00z4Ldm6y0ZKLGvsvkHqVIs4KTYqlMASwruwamNVvD4+nF1XTvS1Al902iV61VwGWBOixuk96pbY+WjAsXqSdtYR0K3M4KxQR1pG/PXj9Q3E587e0KiU8oyJtKsOnttil8cHzTnD55C2c4v3f4Y2Oj6W4p8zvUhisHUj+Hr1m6WDGdGTimVy+Wu9J/TVvpMDmHm1XDLG4cpGGj8K0FLJ84N14+GT5pOr9YfxmfEm2hDMLSX+wBiTX2UNKPWmZR746qVDDT6LNmWjA5p0Cg4quTqDkBf1anPhYcv0RauT6fCailQGNA0eRhRUUovTvKdhzjrUHqm0MNROPki6Y0fYczwy22fd9qtbqn6T135ptaCIjNjwu4j3SL/tgLbl/WMzjDShlulV63p+bcFvXM2bJ7tvkSCMQmpZnkfk6X6kieoy4NDcQnqJc8/Yj4I0vbR3tuar4zU9weu2jMURPumK0em1U89PMXkQ8g9j5HDpoLhV7FTaTDoJFV/KtdOm6yTCK8yYO8YcD6YXmTfiJ4itJgZ2J99OL0NSx/MdxP+p1J7Y+w5ej1q+OTbycnxEwIk2ScPBnuD/dpiYbWJZOdmx74tcXumKvzW4l/88cZYSTsXi5XgnE3hXdybcIA/aLzio5+UVHQdH18kWw2FM1vaWJIy9/XqGk0f9VP4htoN5jvx1kyTdwXSMPZY8/z4Jzupu2i9mPpnfcRNAz3J45cofTBvd0XAFT2Jf0kvn4vVebeNLIV/daErfx7NQ8h/o0frW0SweS8ZnPa62nS+JtGp9uz84WbnYcPJFV8JNcdDreH6l4M+ktCPXhgs/FzeTfM9vv9o395Iig27ibbXd3d3f0TIobc+w==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Document list from status","permalink":"/docs/API-docs/v1.1/getdocumentlist"},"next":{"title":"Get Signer IPs","permalink":"/docs/API-docs/v1.1/getsignerips"}}');var i=t(74848),r=t(28453),o=t(57742),a=t.n(o),m=t(78178),p=t.n(m),c=t(19624),l=t.n(c),d=t(96226),u=t.n(d),g=(t(77675),t(19365),t(51107)),h=t(21312);const q={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:"eJztWt1uG7kVfpXTCdCNBf04aXqjdd31Ot4kaLoxLKdBYRsWNXNGwxWHnCU5klXZwF4UfYCiN73tS/S+j5InKQ5/Zkaym2watAWKvYgjccjD8/udn9EmsWxukvFF8lyldYnSmuSqn2RoUs0ry5VMxskZGpQZaPy+RmOhZFyAVVAb1JArDYbPJZdzyAKJ4aVM+omqUDOi8CpraAQSRCHpJ+Hb1ypbJ+NNkippUVr6yKpK8NSdHn1niIlNYtICS0af6BzXmBHb8c5rniX9BB3lq35i1xUm40TNvsPUJv2k0sSO5WiIQPfQeBM3G6u5nBOVG1ZWgpYqrZY8w0Yy4FlyF6954OS23uJppyintVyr0qkLtSEVahzcU63XXssDnf4qfB2mqmwYuDa1F++jjBzXxoaLma01Nvc5OhDoAJdg8caOClsKMmzJ7BCOmQQuU1FnCLkSQq3I1EumOZsJNACbTaNOy63AuzvYbEgq1NeSlXh3128X6L6thapQMmzRmCJfbp1qlrA92Kx1juJNxfX6OmM2LKSqrJhcdxnwTnpd60BHKto83NL1DuNQMBN1hRmsVU1GI0oPSN3aZRYc+rOMQkR+skhyUB2+5A+wcjCqDg+qw3cIhaoQbMFNUFzOZWacrVYoxBAOjNVKzg93VHAwCusPG1njkuMKmMy8vVsqu7ptCA0DT79Xte6YlRtIdZ1y5kCz0ipFzGDFbQG2QJB4Y8FYrAwwA9x6NM05Ohk0sLlGdNhDvLDaFkrzPzhojBceMCg05r/6YkenXxxOiPUCNR6M2GHY/Sp3MhZsicDkGpzgXEkDSoMk3vJa2wI1pIJpngcc7kMlkBkEgmmWWse812jk47xgcmH6BzN9eI6shDcVSuLg/R//RjuSu7t+4pSWjBPt8kEbLnf0sAV2q2t0C6ZS0njUfrq/78B7K4qS/o/PGx9OChpNLR4EUx94D2cID6BkHlOnKRqT10Ksh1uycim4xOsozPXT/f3rJ/sk8l0/efaflQq1VvpThZqoEm1BqLIiyVbk3h8W6dn+/vXTRqJn9yUatDlUKgu5qmUGPO9mVooUepYqrTGlKmLgU+fWgZBUM//Ih3w4WDmncnnM51gQ3FhQ7S0utf4vNfuAEpTekfJjmn52/aTR9C/va/qVXDLBMzg6fQXnaoHyZ/8FmVsJu9dbfz2xelO6gomw1wnlNrnnyZaw3XUvpMG01tyuk/HFJrkZsIoP/PPxxdXdVT8hV1VUYlbKOI6ZLZJxMmoRJiEieonaOBq1Fsk4KaytzHg0MkxmM3UzVBVK8hrBZobKrBGr+Gj5ZPg0uevvnmFV9Un7sR586hFj2ZzL+cfOXbX6mZANvZm2tNQYi1X8N7hO+tEI3V39hJPvFMgy1M5g5BpnbYF+Eg28Uz0/WCI3FfL94vVe7fp5Ndd2yfVTtfD/VC2QT+bKOXCAh7jFgYsLgN2i+lGXTLPtUl7KQ+j1zgsECqaBUbVOEajndfSYsKgls3yJ8P6Hv8Cs5sK63jbDJQqCQNMHq2tn9NkaUFrUleYGzbDXI/rde+d86Q0CDKjuFWixT8bM6pQYHWhk2Rpw0Nq9EsxS4gBbaFXPC2BguJwL7MPZyeQ8rwVJM4QJtYvRqUzTfjsifSiZZHMEiyXRQ8czSxdNh24ss7WhBKmRPIyX2I+eokpm0XsRSst1J6QFzzFdp8IrhwnhHFLVFpYoM6VBqHQx4HJIihgMBvTfo0fwAq2lWyeWaYsZrZ4sUa/bdrc2FlKm9drf2+QM1/gUCNMORk3Bo5O7ZDqdXsrOwzEcEIV24TDsuZS93vs//RkuXqoVRdQcJY0lcOfCq8cReDOVmvuIS6ujAkU1mnihzOjo9JVLr3ve/t8qKgE1wooiiK6a4ZzLX8Nbg06WXi+kGkC55FpJUm2vB4+nPzoVTfcCKFhFmN5YgeU5pk7Vgjw4Y5btmOJYaYRjVrEZF5yyOa3fwjGzOFd6DbfwrmDWuWzKJGQKbi/l7WAwcP9oa6/XTIh6PbiFY42MvJqCug91lblvGpdqEXwqQ/L71j0H0eyt+wbK59FfHeWvay5oJFIb6mdbZ/YoWGkcVIKlDhWzOVrzpeOBNKMkEiyVBFRxyhKumKDIBxSf7ooX0QsMLbut3ahq9BrrSC6X3Dpgg1yoVSR6Ws8ET2Gb/UnBNAKDyj+MoSe4XLjwkWqrOo09T6T5XLPcwjulF3STp0jg23KndEcnzEBGJ4xTec4lE9w7XAm0Q0e6xx6IPY+/9TixjrmH4DsA9UypBbnYXLOyZJanTIh1JPKNEhlqT+ONnjNJd7WccWmoFGhg+rkmd8z9oUjjHc4KpRaeyJlP1A6OBgRHgMtQHje5xID3TA1qJQFlVikubST31kSGztBqjpSn0lTVIQWmGjNOLYGvysmCt9uhQY7//oe/GvgWV4Q7MWHQw0dwZC1LC4eC75y7waSuKqXtpaRsMmXNczMNDunbkRUYvxEzUNIbqVFVn/gi/2sX/IZo2GZDu0DSBJ+Ki4RfZhhZfUm6n3hrToLXveZyYS7lBC1ML5OCZ3jt7X0dc79wO5IxZTeEW8iZMDgllqenbybnMHKMRT6nFGZEJrpN171NhO1tYSH2LsNWrccCGR2PoRONx8SlnL44OYdRlHE05tnUCb+9TsEz9XXJDFGCsRpZSb1S5sJMY1bLjEkLFdOsREsuyNyYrVRLzBzJXq/SmHMhHGZGw2m0tSY6BumsRbHuTm47BHs9yrkLUkAzqgBkhqMmRaVKmrrExkKnzJiV0tngVCuLKbnG6fNvWo+i52SnnAu8rsLmy2Qa9RoB1M0GVwVKWCntbnfQiDLV6ypQNcNI1zng+FIGe3rHimqcwj/+DtPTt/c07pY7B6I1R+O473p7246f7DzYuc89IPAllU6jft7kORmw8V7CLK1E47+Mhp3Xyu9yHvwhx90V1PnQA5JaBXhDPTG3gio7l3Wo9OM+AYX7GlenmgtZWjRh2Ng3BN+ZEpRgHT6ENDQF31E7/2JpihUhNskUwlErgWTpnKPIgKVaGeMqLScFwZZWtUUzhPNCIwLt9/7cwMzY53S6nbIoFmzJCTV3M3ngaQq9xxnmrBZ2z+UEV4yFapUglwp463JqW6YGhPN0qOchOg2MGx/9Me5JUaEzUlKsY/YLaRucNWPim7KKOklPjibcTccRt+MNaS3k5HZizrXvd24baGF6piQcq2oNj4+P94g5XnFC6Et5BBJXpPY0bbV9D6+ZUHLuUhnJgzfcuOJqepnMuucI1hv8boHao5/rBWN10Vhx5AulxpgnrgllWabREHYQqmFG8d7wGHpZaiWcZIOUJOsmyNDKKpnitgGomQwGzYbwmi+wlaFP7G9xA49NnRZUUfgoaSOeZ9O9MHgLevCskb00z4Ldm6y0ZKLGvsvkHqVIs4KTYqlMASwruwamNVvD4+nF1XTvS1Al902iV61VwGWBOixuk96pbY+WjAsXqSdtYR0K3M4KxQR1pG/PXj9Q3E587e0KiU8oyJtKsOnttil8cHzTnD55C2c4v3f4Y2Oj6W4p8zvUhisHUj+Hr1m6WDGdGTimVy+Wu9J/TVvpMDmHm1XDLG4cpGGj8K0FLJ84N14+GT5pOr9YfxmfEm2hDMLSX+wBiTX2UNKPWmZR746qVDDT6LNmWjA5p0Cg4quTqDkBf1anPhYcv0RauT6fCailQGNA0eRhRUUovTvKdhzjrUHqm0MNROPki6Y0fYczwy22fd9qtbqn6T135ptaCIjNjwu4j3SL/tgLbl/WMzjDShlulV63p+bcFvXM2bJ7tvkSCMQmpZnkfk6X6kieoy4NDcQnqJc8/Yj4I0vbR3tuar4zU9weu2jMURPumK0em1U89PMXkQ8g9j5HDpoLhV7FTaTDoJFV/KtdOm6yTCK8yYO8YcD6YXmTfiJ4itJgZ2J99OL0NSx/MdxP+p1J7Y+w5ej1q+OTbycnxEwIk2ScPBnuD/dpiYbWJZOdmx74tcXumKvzW4l/88cZYSTsXi5XgnE3hXdybcIA/aLzio5+UVHQdH18kWw2FM1vaWJIy9/XqGk0f9VP4htoN5jvx1kyTdwXSMPZY8/z4Jzupu2i9mPpnfcRNAz3J45cofTBvd0XAFT2Jf0kvn4vVebeNLIV/daErfx7NQ8h/o0frW0SweS8ZnPa62nS+JtGp9uz84WbnYcPJFV8JNcdDreH6l4M+ktCPXhgs/FzeTfM9vv9o395Iig27ibbXd3d3f0TIobc+w==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-2",custom_edit_url:null},N=void 0,b={},f=[];function k(e){const n={p:"p",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(g.default,{as:"h1",className:"openapi__heading",children:"Resend request mail"}),"\n",(0,i.jsx)(a(),{method:"post",path:"/resendmail",context:"endpoint"}),"\n",(0,i.jsx)(n.p,{children:"Resend request mail to user for signing document."}),"\n",(0,i.jsx)(g.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,i.jsx)(h.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,i.jsx)(p(),{parameters:void 0}),"\n",(0,i.jsx)(l(),{...t(36467)}),"\n",(0,i.jsx)(u(),{...t(62229)})]})}function V(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(k,{...e})}):k(e)}},36467(e){e.exports=JSON.parse('{"title":"Body","body":{"content":{"application/json":{"schema":{"required":["document_id","email"],"type":"object","properties":{"document_id":{"type":"string","example":"provide document id"},"email":{"type":"string","description":"provide user mail from signers to re-send request mail.\\n","example":"user@example.com"},"email_subject":{"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}}, {{note}}.","example":"{{sender_name}} has requested you to sign {{document_title}}"},"email_body":{"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}}, {{note}}.","example":"

Hi {{receiver_name}},

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

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

Sign here

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

Thanks,
Team OpenSign\u2122

"}},"title":"resendmail_body"}}},"required":true}}')},62229(e){e.exports=JSON.parse('{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","format":"string","example":"mail sent successfully."}},"title":"inline_response_200_10"}}}},"400":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","format":"string","example":"Something went wrong."}},"title":"inline_response_400_2"}}}},"404":{"description":"- document not found if document id is not correct.\\n- user not found if provided user email is not present in signer list of document\\n","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","format":"string","example":"document not found or user not found."}},"title":"inline_response_404_1"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/b93339ed.acc67002.js b/assets/js/b93339ed.acc67002.js deleted file mode 100644 index c9f776a81..000000000 --- a/assets/js/b93339ed.acc67002.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[8749],{33727(e,t,o){o.r(t),o.d(t,{assets:()=>w,contentTitle:()=>j,default:()=>b,frontMatter:()=>h,metadata:()=>a,toc:()=>P});const a=JSON.parse('{"id":"API-docs/v1.1/updatefolder","title":"Update Folder","description":"The Update Folder API allows you to uodate folder name as well as parentFolderId.","source":"@site/docs/API-docs/v1.1/updatefolder.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/updatefolder","permalink":"/docs/API-docs/v1.1/updatefolder","draft":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJy9WN1u47gVfpVT3nTHUGwnm922umo6mM6mO5gJJhkEaMYIKOlI4oYiuSRlxzAE7EXfoFe97aPNkxSHlGQ5yaQN2u1NYpM8h9/5zi+9Y55XjqU37M9aFmjZKmEFutwK44VWLGVXNcInU3CPEI/A2cU5cCn1xsFWt+A1tDrsl3Ff8QaBO9iglPTfcIvKR+HzYs4Spg1aTvrPC5ayNmiPwixhhlveoEdLsHaMtLGUxe1bUbCECcJluK/ZQ7A6+wlzf16ALmFUaPHnVlgsWOptiwlzfitJpRONkcgShvdG6gJZWnLp6EBeY8NZumN+a8JJb4WqWMJKbRvupyt4z4OWlGU/HudlcVKbjHXdKl6Lzv9JF1tSdQj0wuq1KBAylHoDo8lEZm5xTyZLWK6VR+VJBzdGijwwt/jJkaLdBOzezpuersDdKhnMiOwQxZY84AU6kotn3weeX2ayws2AswuOm/j5pbpY1yXMCy8n3s6Iu66jHYvOaOUi4pPl8jGlrs1zdK5sJYzx9RL6nidpiKyXmvXDnTv5i8HNuSGKYqgXZ/4pNXuhk+XJt0fHy6Pl766Ov09P/5B+9/18uVz+lSXsvpEk22cFaWMT3uL3yYJQUii8Hdi7PVkub4+Pe05Pn6LxUjfoa6Eq2KDysLFaVQkYidwheLsFXnGhQHKP9jf/O37RWm2fZ+VlyJ5j4ZRYGEk4fUzCUMm0h1K3KhStX9vQ56LoMZ7nzTu9/f1o3nePzTtXay5FESq513eo/r+OfOJ6gnoY2iIeCvvswNjpejTSYd5a4behYdwfcSOO4n56s6JSTHGjqdWYNgCm1pGyRWR1sRt7S8dIl10Pvae1kqWs9t64dLFwXBWZvp9rg8qJSkmeuXmumwU3YrE+nh+zLnkow4150Xlsj14q4jyvhKr+ndxqT9MluTJ664Cs0WfciB9xy5LBF9NTffutkYey3yWMIuTjvtm9Gfx82FmmzeJxr2DkYqFKHVD0rv5gUF2KSoVACVY87PfXKHPdILVNXyPMZoPIl7/9c5SazaDQedug8iGk55/VZ/WhtWD0Bi31C64KKCXei0xiEMMm7I0DjkPeSHRObkEoj5WlDl2ISngugQinqpRzwzMhBWUCHdMkbWGSTG4O1zX6Gi1t/dYicChwjZISCHjrdcM9qRrwwkbbu5JGrQQ4ZK0TCp0DVDVXOR0cXJqAtsAVoPJojRUOwXlLqEXEppW3PPfQcMUrJN0JTMkqUAqKe7A6a50Hp2UbIIPnQmqLBQwGKcTCBRLf0OBkEWg1142xWFP8rRGqVhToEsh1geBCQJAJqoAMnQdDWESOLkyPSur8LjiwbKUEo6kOCS5piptiJHFvuXJUKiOWwQcjYcZqmgIwApzNPjkkD78T6s6ls9lndQQ3Y1xdY+aEx9U3Qy5tNptHOfTqUOat8D+0GXxEo53w2m730pXwdZuFvJsqGb9ETW9RYYifSVbtdRQ6d4/TmFYXNUqzuERPEeIWZxfnVyT6Cr788nd4h9wqqPUmRmveWpRbqIariLno+UjbWHmh1CHwamI8j8HXD64Dg9c1919++YeD97gBofqUIlNms4s2kyKHK2wMtV03m6XwOs6vflgDX3MPOVeQIbiaUyitBQcOJkpLoe7mcKa20Dq0sBG+DsFA60HuwAziZXS3g4w7LECrIDHcOd8jovXGoVyjI13UQTMELISniK6tbqt42xRMb5zFUkgJ16Ko0AfbzooCTL+8ictE+AQOlpQQvsYtcIvgUPk5XDwQCTutMdoSChHBl5reVOQAVIXRQnmXQmF56ff6k32gh2eC0OqJpUghH+lIejWjS2Im9haPq/PPVN0fdITDemuxREsXBrP3fjGiD6ebISyBovW/CWtqCFS1eB5GEmy4kLE1/fGhnjAeoG3ch/IS7Vrk2LfHr2T0IhxesIRJkaNyOBk7zt5evIP1t/MlSyZ99j9I7sW789dv3l++ITBUSCNhx/PlfBkeR9r5hqvJTQeP6oedbbcfx36VF3jf6D3e+4WRXIQRK9i768ej4Q3JEpbuH9+rhNXaedre7Sj3PlnZdbT8c4uWBrBVwtbcCp5RC7/ZsUI4+lyMr+uv2vnNx/4B+wqefMc/iXmYWBSNK2su2/CWTNgdbg9+NehWXTIMLQQr7r+Olx9dkZa9/KP5l6auKHGW52j8s2enA+fFpyuWsKz/DaAJvzIwyzf0swTfRKg6cBHGsbC2Y5KrquUVnY0qacyiKn04o92FGa3/QEY9Scbh8BatoL9k05MCu12c/7puPB+3virR8zqcJs+suq77F6OBb6o=","sidebar_class_name":"put api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Folder","permalink":"/docs/API-docs/v1.1/getfolder"},"next":{"title":"Delete Folder","permalink":"/docs/API-docs/v1.1/deletefolder"}}');var s=o(74848),n=o(28453),d=o(57742),i=o.n(d),l=o(78178),r=o.n(l),p=o(19624),c=o.n(p),u=o(96226),m=o.n(u),f=(o(77675),o(19365),o(51107)),I=o(21312);const h={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:"eJy9WN1u47gVfpVT3nTHUGwnm922umo6mM6mO5gJJhkEaMYIKOlI4oYiuSRlxzAE7EXfoFe97aPNkxSHlGQ5yaQN2u1NYpM8h9/5zi+9Y55XjqU37M9aFmjZKmEFutwK44VWLGVXNcInU3CPEI/A2cU5cCn1xsFWt+A1tDrsl3Ff8QaBO9iglPTfcIvKR+HzYs4Spg1aTvrPC5ayNmiPwixhhlveoEdLsHaMtLGUxe1bUbCECcJluK/ZQ7A6+wlzf16ALmFUaPHnVlgsWOptiwlzfitJpRONkcgShvdG6gJZWnLp6EBeY8NZumN+a8JJb4WqWMJKbRvupyt4z4OWlGU/HudlcVKbjHXdKl6Lzv9JF1tSdQj0wuq1KBAylHoDo8lEZm5xTyZLWK6VR+VJBzdGijwwt/jJkaLdBOzezpuersDdKhnMiOwQxZY84AU6kotn3weeX2ayws2AswuOm/j5pbpY1yXMCy8n3s6Iu66jHYvOaOUi4pPl8jGlrs1zdK5sJYzx9RL6nidpiKyXmvXDnTv5i8HNuSGKYqgXZ/4pNXuhk+XJt0fHy6Pl766Ov09P/5B+9/18uVz+lSXsvpEk22cFaWMT3uL3yYJQUii8Hdi7PVkub4+Pe05Pn6LxUjfoa6Eq2KDysLFaVQkYidwheLsFXnGhQHKP9jf/O37RWm2fZ+VlyJ5j4ZRYGEk4fUzCUMm0h1K3KhStX9vQ56LoMZ7nzTu9/f1o3nePzTtXay5FESq513eo/r+OfOJ6gnoY2iIeCvvswNjpejTSYd5a4behYdwfcSOO4n56s6JSTHGjqdWYNgCm1pGyRWR1sRt7S8dIl10Pvae1kqWs9t64dLFwXBWZvp9rg8qJSkmeuXmumwU3YrE+nh+zLnkow4150Xlsj14q4jyvhKr+ndxqT9MluTJ664Cs0WfciB9xy5LBF9NTffutkYey3yWMIuTjvtm9Gfx82FmmzeJxr2DkYqFKHVD0rv5gUF2KSoVACVY87PfXKHPdILVNXyPMZoPIl7/9c5SazaDQedug8iGk55/VZ/WhtWD0Bi31C64KKCXei0xiEMMm7I0DjkPeSHRObkEoj5WlDl2ISngugQinqpRzwzMhBWUCHdMkbWGSTG4O1zX6Gi1t/dYicChwjZISCHjrdcM9qRrwwkbbu5JGrQQ4ZK0TCp0DVDVXOR0cXJqAtsAVoPJojRUOwXlLqEXEppW3PPfQcMUrJN0JTMkqUAqKe7A6a50Hp2UbIIPnQmqLBQwGKcTCBRLf0OBkEWg1142xWFP8rRGqVhToEsh1geBCQJAJqoAMnQdDWESOLkyPSur8LjiwbKUEo6kOCS5piptiJHFvuXJUKiOWwQcjYcZqmgIwApzNPjkkD78T6s6ls9lndQQ3Y1xdY+aEx9U3Qy5tNptHOfTqUOat8D+0GXxEo53w2m730pXwdZuFvJsqGb9ETW9RYYifSVbtdRQ6d4/TmFYXNUqzuERPEeIWZxfnVyT6Cr788nd4h9wqqPUmRmveWpRbqIariLno+UjbWHmh1CHwamI8j8HXD64Dg9c1919++YeD97gBofqUIlNms4s2kyKHK2wMtV03m6XwOs6vflgDX3MPOVeQIbiaUyitBQcOJkpLoe7mcKa20Dq0sBG+DsFA60HuwAziZXS3g4w7LECrIDHcOd8jovXGoVyjI13UQTMELISniK6tbqt42xRMb5zFUkgJ16Ko0AfbzooCTL+8ictE+AQOlpQQvsYtcIvgUPk5XDwQCTutMdoSChHBl5reVOQAVIXRQnmXQmF56ff6k32gh2eC0OqJpUghH+lIejWjS2Im9haPq/PPVN0fdITDemuxREsXBrP3fjGiD6ebISyBovW/CWtqCFS1eB5GEmy4kLE1/fGhnjAeoG3ch/IS7Vrk2LfHr2T0IhxesIRJkaNyOBk7zt5evIP1t/MlSyZ99j9I7sW789dv3l++ITBUSCNhx/PlfBkeR9r5hqvJTQeP6oedbbcfx36VF3jf6D3e+4WRXIQRK9i768ej4Q3JEpbuH9+rhNXaedre7Sj3PlnZdbT8c4uWBrBVwtbcCp5RC7/ZsUI4+lyMr+uv2vnNx/4B+wqefMc/iXmYWBSNK2su2/CWTNgdbg9+NehWXTIMLQQr7r+Olx9dkZa9/KP5l6auKHGW52j8s2enA+fFpyuWsKz/DaAJvzIwyzf0swTfRKg6cBHGsbC2Y5KrquUVnY0qacyiKn04o92FGa3/QEY9Scbh8BatoL9k05MCu12c/7puPB+3virR8zqcJs+suq77F6OBb6o=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},j=void 0,w={},P=[];function y(e){const t={p:"p",...(0,n.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(f.default,{as:"h1",className:"openapi__heading",children:"Update Folder"}),"\n",(0,s.jsx)(i(),{method:"put",path:"/folder/{folder_id}",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Update Folder API allows you to uodate folder name as well as parentFolderId."}),"\n",(0,s.jsx)(f.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(I.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(r(),{...o(38459)}),"\n",(0,s.jsx)(c(),{...o(38697)}),"\n",(0,s.jsx)(m(),{...o(77151)})]})}function b(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(y,{...e})}):y(e)}},38459(e){e.exports=JSON.parse('{"parameters":[{"name":"folder_id","in":"path","description":"objectId of folder","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"bK1cfd2hpb"}}]}')},38697(e){e.exports=JSON.parse('{"title":"Body","body":{"description":"Provide below parameter to create folder","content":{"application/json":{"schema":{"required":["foldername"],"type":"object","properties":{"folderName":{"type":"string","format":"string","example":"new folder"},"parentFolderId":{"type":"string","format":"string","example":""}},"title":"folder_body"}}}}}')},77151(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"Hks2JpewIp"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"title":"inline_response_200_11"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"folder not found.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","format":"string","example":"folder not found."}},"title":"inline_response_404_8"}}}},"405":{"description":"Invalid API token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/b93339ed.d288927f.js b/assets/js/b93339ed.d288927f.js new file mode 100644 index 000000000..6ec8afced --- /dev/null +++ b/assets/js/b93339ed.d288927f.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[8749],{33727(e,t,o){o.r(t),o.d(t,{assets:()=>k,contentTitle:()=>m,default:()=>w,frontMatter:()=>f,metadata:()=>r,toc:()=>R});const r=JSON.parse('{"id":"API-docs/v1.1/updatefolder","title":"Update Folder","description":"The Update Folder API allows you to uodate folder name as well as parentFolderId.","source":"@site/docs/API-docs/v1.1/updatefolder.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/updatefolder","permalink":"/docs/API-docs/v1.1/updatefolder","draft":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJy9WV9vG7kR/ypTBihiYSXZudy11RXX+hxf4l6aGJbdALUML7U70vLEJfdIrmTBFnAPRT9A0Ze+9kv0vR8ln6QYcrn6Y59zxrV9SGyTw+HMb/5y9pY5PrVscMm+0TJHw64SlqPNjKic0IoN2HmBcFHl3CEEEjg8PQEupV5YWOoanIZa+/1J2Fe8ROAWFigl/ay4QeXC4ZO8xxKmKzSc+J/kbMBqzz0cZgmruOElOjQk1i0jbmzAwva1yFnCBMlVcVewXWH1+DvM3EkOegItQ4Pf18JgzgbO1Jgw65aSWFpRVhJZwvCmkjpHNphwaYkgK7DkbHDL3LLylM4INWUJm2hTcre5gjfccxmw8bcH2SR/UVRjtlpdhWvRuq91viRW24KeGj0XOcIYpV5AqzKBmRlcg8kSlmnlUDniwatKiswj1//OEqPbDWHXel42cHnsrpKoRkCHIDZkASfQ0rlA+87j/DSVFS6inCtvuA07P5UXW60S5oSTG9YeE3arFe0YtJVWNkj8Yn//PqS2zjK0dlJLaP3rKfA9DlL0rKeq9WZmX/yhwsVJRRAFV88P3UNs1ode7L/4rHuw393/1fnBF4OXvxl8/kVvf3//zyxhN6Wks01UEDe2gVv4e2NBKCkUXkf0rl/s718fHDSYvnwIxqEu0RVCTWGBysHCaDVNoJLILYIzS+BTLhRI7tD84r+HLxqjzeOoPE2yx1B4SSi0ILy8D0LMZNrBRNfKJ63/taKPedF9eR5X7+X1r1v1Pr+v3omacylyn8mdnqH6/xrygetJ1G3XFoHI77MtZTfXg5IWs9oIt/QF46bLK9EN+4PLK0rF5DeaSk1Ve4GpdAxYP6Dav21ry4oRLzOPtac2kg1Y4VxlB/2+5Sof65uerlBZMVWSj20v02WfV6I/P+i9YKtk9wyvqifRY9196hHr+FSo6afOXa1hGpIpg7W2wGptxivxLS5ZEm2xSdWU3wK5T/urhJGHnK2L3XG083Zl2SwW92sFIxMLNdFeisbU7ytUQzFV3lG8Frv1/hlEmo9/+WdLNlIj9RV0OtS6ECJdq2uTIbzSWe35cemoODoxR/j4w99hXAtJkWUgxzlKcmebgDO1dZjDeAmoHJrKCIu21+kQ/817p2KOoRfikGlS3mECldF5nZGgXYM8XwJ2yTTc1QahktxRwIMrjK6nBXCwQk0lJnB2PDynInZ4etKDIaoccp3VJSpnvYgtkwRKrvgUwWFJ/NDLzLOZJ6E8aR13tQWhwCCX4ESJCXCVA6+dLqnLWOrakHbCYHsNSDHBbJnJAA6XEhbCFbp2MEeVawNSZ7OuUD0Cotvt0o9nz+A1Oke3Dh03DnNaPZ6jWULTCUFZWwcZN2YZ7m3jnyR0BUK64WgpBBfzl6RpOlIbmwP4LXFYL3zV0IxUp/Pxr3+Dyzd6Qc3UFBW1Arhz4dXzGD25zuz9sKHVfoGy6g+DUrZ/eHpyTkf3gv3faQeWLLko0CBdNcapUL+DCypGBUKn0+QLQDUXRiuCttOB5+lPzifpHvGtjHaaArO1Ap9MMPNQS/LgnDu+Y4ojbRCOeMXHQgrKzLR+B0fc4VSbJdzBh4I777IZV5BruBupu2636/8RaafzKnpdpwN3cOS70gQsqjyB0MckYHCuZ41P5Uh+v3bPbjT72n0bzufRXz3nr2shczBYWz6WG87s1YXKYLeSPMMcFiKforNfehkIGa0QtKEoWPpr0bRXDFFOuhSf/orX0QssLXvSzahqcW24gFBz4Xz5gwn15w3T03osRQbb4g8LbhA4VGEzhp4UaubDR+nIVQrrIDbpkecrwycOPmgzo5sCRz7HDem02cCEW8jphPWQT4TiUgSHK0PjE/keaeV41hjvjyFP+BhohMnCPoy1npGLTQ0vS+5ExqVcRiYhPwce782UK7prLZlQlt4wbZp+ZcgdQ45vLfEBx4XWs8DkDDMkGkpHXUpHgHPKOEo7MWk6DgvBMw3ohQJUeaWFcpHdhY0CnaEzAucIPMt0rZxHJDOYCwdUSaibIgvebYcGOf7HH/5h4R0uKO/EgkGbz+DQOZ4VPgt+8O4Gw7qqtHEjRdUk5e2+TRuHBGFB6QXYQIg5aBWM1EKVxEfdeiEQRMO2BOsF0qbxqbhI+cv2oqhvCPthsOaw8bq3Qs3sSA3RQTpihcjxOtj7uvHLa+kp2ICqG8Id+CdvSiKnp++H59D3gkU5UwozYhPdZtO9bUzb28pC7EN7a1iPJHI6HkMnGo/LkUpfH59DP+rYH4g89cpvr1PwpFBQaIwRFVhnkJfU9+Y+zAzmtcq5cuvHtAWKTIOlnmPuWXY6lcGJkNLnzGg4g642xMcinXUolzAxuow6rxl2OlRzZwRA+x4F5FY0L3etbF1ia6FTbu1Cm7x7arTDjFzj9NU3a4+ifbLTREi8rhriEUsjrjGB0jOY6oyChTb+dp8aUWVmWTVcbS/y9Q44GKnGnsGxIowp/PtfkJ5e3EPcL28ciNbsDyLd9TbZjp/sbOzc5zco+RKkacTn/WRCBmy9l3KW0bL1Xz9kutaBynvwY467q6j3oQc0dRpo4CMy4SR1dr7qUOsnQgFq7mtdnXou5FnRhmFr3yb4zrSkAuvzQ1OGUgivI+9fPMuwooxNOjXhaLREsvREoMyBZ0Zb6zstrwWlLaNrh7YH54VBBKIP/tymmUGo6XQ7VVEs+FxQ1tyt5I1MKXSe5zjhtXR7vib4ZqzpVinl0jva+Zq6blObDBf4zAUuiE+bxm2I/hj3BJRBogKt5DJWv6Zsh5FhLHwpryqj54HdEVchsqmQR3K8IdSamhykaWqnv+yuTS3cjLWCI10t4fnR0R4JJypBGXqkDoFeHemIZdka7Xv5mkutpr6UkT54I6xvrtIRG2+eo7Te5u91og7Zj7yt7S5aK/ZDo9Qa87jkQgLPc4OWcgdlNcwp3lsZTVMiOXXKY626GWm2WSABPRetMtw2gLCtQfMevBUzXOuQkPhb0sBzW2cFdRQhStYRL/J0j3qCucgbHIJoZC8j8sbubVWac1lj4it5yFKErBQELLUpgGXllsCN4Ut4nl5epXtfgi6F81wCtE6DUAWaZnGb9U5vezjnQvpIPV431k2Du7FCMUGDoYuztw80t8PQe/tG4gkNedsJtm+7bQ6PvsHb08cXcIbTe4c/9fZPd1uZP6GxQvsk9Uv4mmezBTe5hSNdVtwJ3/oviZQOk3NMaurtxpGwmzWEMjwtYH7g3Xh+0DtoX36x/7KhJLpCW4R5uDgkJN7aQ1PZEhbGEXfPVWkYGwxVMyu4mlIgUPO1UagFJf68zkIseHmJtfbvfC6hVhKtBe0KNAtqQpUmH9+G48IivZubHmikunDZtqYfcGyFw/W7b7FY3EN6z5/5ppYS4uPHB9wnXovh2Gvh3tRjOMNKW+G0Wa5PTYUr6rG35ebZ9o+GQXyk0Cv1/Oe+Uj3LczSlpW8hQzRzkX1C/b4j8v7eiIY8O4Oh7bGLwQkayjt2643NK9G85y+jHEDi/Rw9aC7UvFX8dJFSX5hQ/X6Xj58SkgrvJ42+zZTscX1ZwqTIUFncmD4evj59C/PPevss2Ri3/QRb9t+eHB2/Gx6TME2YsAE76O339v03Em1dydXGTVvf1nYHXLfrqez/5ENcM+9zeOP6leTCT1q9vrfNlDR+SmIJG6y/wV0lrNDW0fbtLYX7hZGrFS1/X6OhOexVwubcCMoLfpTadFd5+5HtR/V8ftY8kffgwc95D8ocB5eKppa+atBMMWEzXG59PFxdrZI4uySxwv5RuLx7TlzW5++NwWn4Gk4c+p7uUdrNufPpxTlL2Lj5FFj6j43M8AV9neSLIGpIdn4q69dumeRqWvMp0QaWNG3lNZllc1Q786Pa5hdS6kEwtme4QQv6n3R68MDtbRgDr1Ytfdj60RMNrpGaLHO1Wq3+AzjxvkM=","sidebar_class_name":"put api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Folder","permalink":"/docs/API-docs/v1.1/getfolder"},"next":{"title":"Delete Folder","permalink":"/docs/API-docs/v1.1/deletefolder"}}');var a=o(74848),n=o(28453),p=o(57742),l=o.n(p),d=o(78178),s=o.n(d),c=o(19624),i=o.n(c),h=o(96226),b=o.n(h),u=(o(77675),o(19365),o(51107)),v=o(21312);const f={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:"eJy9WV9vG7kR/ypTBihiYSXZudy11RXX+hxf4l6aGJbdALUML7U70vLEJfdIrmTBFnAPRT9A0Ze+9kv0vR8ln6QYcrn6Y59zxrV9SGyTw+HMb/5y9pY5PrVscMm+0TJHw64SlqPNjKic0IoN2HmBcFHl3CEEEjg8PQEupV5YWOoanIZa+/1J2Fe8ROAWFigl/ay4QeXC4ZO8xxKmKzSc+J/kbMBqzz0cZgmruOElOjQk1i0jbmzAwva1yFnCBMlVcVewXWH1+DvM3EkOegItQ4Pf18JgzgbO1Jgw65aSWFpRVhJZwvCmkjpHNphwaYkgK7DkbHDL3LLylM4INWUJm2hTcre5gjfccxmw8bcH2SR/UVRjtlpdhWvRuq91viRW24KeGj0XOcIYpV5AqzKBmRlcg8kSlmnlUDniwatKiswj1//OEqPbDWHXel42cHnsrpKoRkCHIDZkASfQ0rlA+87j/DSVFS6inCtvuA07P5UXW60S5oSTG9YeE3arFe0YtJVWNkj8Yn//PqS2zjK0dlJLaP3rKfA9DlL0rKeq9WZmX/yhwsVJRRAFV88P3UNs1ode7L/4rHuw393/1fnBF4OXvxl8/kVvf3//zyxhN6Wks01UEDe2gVv4e2NBKCkUXkf0rl/s718fHDSYvnwIxqEu0RVCTWGBysHCaDVNoJLILYIzS+BTLhRI7tD84r+HLxqjzeOoPE2yx1B4SSi0ILy8D0LMZNrBRNfKJ63/taKPedF9eR5X7+X1r1v1Pr+v3omacylyn8mdnqH6/xrygetJ1G3XFoHI77MtZTfXg5IWs9oIt/QF46bLK9EN+4PLK0rF5DeaSk1Ve4GpdAxYP6Dav21ry4oRLzOPtac2kg1Y4VxlB/2+5Sof65uerlBZMVWSj20v02WfV6I/P+i9YKtk9wyvqifRY9196hHr+FSo6afOXa1hGpIpg7W2wGptxivxLS5ZEm2xSdWU3wK5T/urhJGHnK2L3XG083Zl2SwW92sFIxMLNdFeisbU7ytUQzFV3lG8Frv1/hlEmo9/+WdLNlIj9RV0OtS6ECJdq2uTIbzSWe35cemoODoxR/j4w99hXAtJkWUgxzlKcmebgDO1dZjDeAmoHJrKCIu21+kQ/817p2KOoRfikGlS3mECldF5nZGgXYM8XwJ2yTTc1QahktxRwIMrjK6nBXCwQk0lJnB2PDynInZ4etKDIaoccp3VJSpnvYgtkwRKrvgUwWFJ/NDLzLOZJ6E8aR13tQWhwCCX4ESJCXCVA6+dLqnLWOrakHbCYHsNSDHBbJnJAA6XEhbCFbp2MEeVawNSZ7OuUD0Cotvt0o9nz+A1Oke3Dh03DnNaPZ6jWULTCUFZWwcZN2YZ7m3jnyR0BUK64WgpBBfzl6RpOlIbmwP4LXFYL3zV0IxUp/Pxr3+Dyzd6Qc3UFBW1Arhz4dXzGD25zuz9sKHVfoGy6g+DUrZ/eHpyTkf3gv3faQeWLLko0CBdNcapUL+DCypGBUKn0+QLQDUXRiuCttOB5+lPzifpHvGtjHaaArO1Ap9MMPNQS/LgnDu+Y4ojbRCOeMXHQgrKzLR+B0fc4VSbJdzBh4I777IZV5BruBupu2636/8RaafzKnpdpwN3cOS70gQsqjyB0MckYHCuZ41P5Uh+v3bPbjT72n0bzufRXz3nr2shczBYWz6WG87s1YXKYLeSPMMcFiKforNfehkIGa0QtKEoWPpr0bRXDFFOuhSf/orX0QssLXvSzahqcW24gFBz4Xz5gwn15w3T03osRQbb4g8LbhA4VGEzhp4UaubDR+nIVQrrIDbpkecrwycOPmgzo5sCRz7HDem02cCEW8jphPWQT4TiUgSHK0PjE/keaeV41hjvjyFP+BhohMnCPoy1npGLTQ0vS+5ExqVcRiYhPwce782UK7prLZlQlt4wbZp+ZcgdQ45vLfEBx4XWs8DkDDMkGkpHXUpHgHPKOEo7MWk6DgvBMw3ohQJUeaWFcpHdhY0CnaEzAucIPMt0rZxHJDOYCwdUSaibIgvebYcGOf7HH/5h4R0uKO/EgkGbz+DQOZ4VPgt+8O4Gw7qqtHEjRdUk5e2+TRuHBGFB6QXYQIg5aBWM1EKVxEfdeiEQRMO2BOsF0qbxqbhI+cv2oqhvCPthsOaw8bq3Qs3sSA3RQTpihcjxOtj7uvHLa+kp2ICqG8Id+CdvSiKnp++H59D3gkU5UwozYhPdZtO9bUzb28pC7EN7a1iPJHI6HkMnGo/LkUpfH59DP+rYH4g89cpvr1PwpFBQaIwRFVhnkJfU9+Y+zAzmtcq5cuvHtAWKTIOlnmPuWXY6lcGJkNLnzGg4g642xMcinXUolzAxuow6rxl2OlRzZwRA+x4F5FY0L3etbF1ia6FTbu1Cm7x7arTDjFzj9NU3a4+ifbLTREi8rhriEUsjrjGB0jOY6oyChTb+dp8aUWVmWTVcbS/y9Q44GKnGnsGxIowp/PtfkJ5e3EPcL28ciNbsDyLd9TbZjp/sbOzc5zco+RKkacTn/WRCBmy9l3KW0bL1Xz9kutaBynvwY467q6j3oQc0dRpo4CMy4SR1dr7qUOsnQgFq7mtdnXou5FnRhmFr3yb4zrSkAuvzQ1OGUgivI+9fPMuwooxNOjXhaLREsvREoMyBZ0Zb6zstrwWlLaNrh7YH54VBBKIP/tymmUGo6XQ7VVEs+FxQ1tyt5I1MKXSe5zjhtXR7vib4ZqzpVinl0jva+Zq6blObDBf4zAUuiE+bxm2I/hj3BJRBogKt5DJWv6Zsh5FhLHwpryqj54HdEVchsqmQR3K8IdSamhykaWqnv+yuTS3cjLWCI10t4fnR0R4JJypBGXqkDoFeHemIZdka7Xv5mkutpr6UkT54I6xvrtIRG2+eo7Te5u91og7Zj7yt7S5aK/ZDo9Qa87jkQgLPc4OWcgdlNcwp3lsZTVMiOXXKY626GWm2WSABPRetMtw2gLCtQfMevBUzXOuQkPhb0sBzW2cFdRQhStYRL/J0j3qCucgbHIJoZC8j8sbubVWac1lj4it5yFKErBQELLUpgGXllsCN4Ut4nl5epXtfgi6F81wCtE6DUAWaZnGb9U5vezjnQvpIPV431k2Du7FCMUGDoYuztw80t8PQe/tG4gkNedsJtm+7bQ6PvsHb08cXcIbTe4c/9fZPd1uZP6GxQvsk9Uv4mmezBTe5hSNdVtwJ3/oviZQOk3NMaurtxpGwmzWEMjwtYH7g3Xh+0DtoX36x/7KhJLpCW4R5uDgkJN7aQ1PZEhbGEXfPVWkYGwxVMyu4mlIgUPO1UagFJf68zkIseHmJtfbvfC6hVhKtBe0KNAtqQpUmH9+G48IivZubHmikunDZtqYfcGyFw/W7b7FY3EN6z5/5ppYS4uPHB9wnXovh2Gvh3tRjOMNKW+G0Wa5PTYUr6rG35ebZ9o+GQXyk0Cv1/Oe+Uj3LczSlpW8hQzRzkX1C/b4j8v7eiIY8O4Oh7bGLwQkayjt2643NK9G85y+jHEDi/Rw9aC7UvFX8dJFSX5hQ/X6Xj58SkgrvJ42+zZTscX1ZwqTIUFncmD4evj59C/PPevss2Ri3/QRb9t+eHB2/Gx6TME2YsAE76O339v03Em1dydXGTVvf1nYHXLfrqez/5ENcM+9zeOP6leTCT1q9vrfNlDR+SmIJG6y/wV0lrNDW0fbtLYX7hZGrFS1/X6OhOexVwubcCMoLfpTadFd5+5HtR/V8ftY8kffgwc95D8ocB5eKppa+atBMMWEzXG59PFxdrZI4uySxwv5RuLx7TlzW5++NwWn4Gk4c+p7uUdrNufPpxTlL2Lj5FFj6j43M8AV9neSLIGpIdn4q69dumeRqWvMp0QaWNG3lNZllc1Q786Pa5hdS6kEwtme4QQv6n3R68MDtbRgDr1Ytfdj60RMNrpGaLHO1Wq3+AzjxvkM=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-2",custom_edit_url:null},m=void 0,k={},R=[];function g(e){const t={p:"p",...(0,n.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Update Folder"}),"\n",(0,a.jsx)(l(),{method:"put",path:"/folder/{folder_id}",context:"endpoint"}),"\n",(0,a.jsx)(t.p,{children:"The Update Folder API allows you to uodate folder name as well as parentFolderId."}),"\n",(0,a.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,a.jsx)(v.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,a.jsx)(s(),{...o(38459)}),"\n",(0,a.jsx)(i(),{...o(38697)}),"\n",(0,a.jsx)(b(),{...o(77151)})]})}function w(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(g,{...e})}):g(e)}},38459(e){e.exports=JSON.parse('{"parameters":[{"name":"folder_id","in":"path","description":"objectId of folder","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"bK1cfd2hpb"}}]}')},38697(e){e.exports=JSON.parse('{"title":"Body","body":{"description":"Provide below parameter to create folder","content":{"application/json":{"schema":{"required":["foldername"],"type":"object","properties":{"folderName":{"type":"string","format":"string","example":"new folder"},"parentFolderId":{"type":"string","format":"string","example":""}},"title":"folder_body"}}}}}')},77151(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"Hks2JpewIp"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"title":"inline_response_200_11"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"folder not found.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","format":"string","example":"folder not found."}},"title":"inline_response_404_8"}}}},"405":{"description":"Invalid API token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/c195e1f1.21ec805c.js b/assets/js/c195e1f1.21ec805c.js new file mode 100644 index 000000000..59395b974 --- /dev/null +++ b/assets/js/c195e1f1.21ec805c.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[6192],{35342(e,t,n){n.r(t),n.d(t,{assets:()=>y,contentTitle:()=>x,default:()=>j,frontMatter:()=>g,metadata:()=>i,toc:()=>v});const i=JSON.parse('{"id":"API-docs/v1.1/createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","source":"@site/docs/API-docs/v1.1/createdocumentwithtemplateid.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/createdocumentwithtemplateid","permalink":"/docs/API-docs/v1.1/createdocumentwithtemplateid","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","sidebar_label":"Create Document from Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztXOtyGzeWfhVsp2ptsUjqEjuzq3i9o8iexDVJrLLkcaVEFwl2H5KwmkAPgCbFkVU1P6b2Abb2z/6dl9j/+yh5kq1zcOmLSMrMZCazu0olkdSNBg4ODs71A24Sy6cmOb5MXqi0nIO0JnnfTTIwqRaFFUomx8nFDNipBm6BhVZsotWcWZgXOT4+OXvFeJ6rpWErVTKr2BQkaHwlYcmy0Dcbr9iH0lhWaLUQmZDT2MdQZExIY4FnTE1YWeSKUwNOXUxEDo+FZHYGbKL0HNuMuYEvnjCl2VhIrld7DBagV8yKORAdEiBDYlJHPI+E9NmFH9Zgb0xDgS2yfMVKAxmNZljKJRuD/zpzUy4NaCakBT3hKTBu2WWn8wLG5ZS9fdXpvH88s7Ywx/v7vCj6qgBpxFTmfGz6qZrvZ9iwyCZ7SHRpaP4Vcy9q7OwP5ED+oEoiwnELWAYTXuaWLXheEhuQ6WwpsikgbzmSrohHQjPJ59B4b8qiUNoyuE6hsAwJ47bU0GXG8nnRZUIKK3huukzM+RSIhE5nJjIYWri2w6WwsyE3FrQwV+a402HvZiAZSD7OIevSVLChp4FGgCwynQnDZiLLQDpWakhFIUgsHCti1102Li3TMOdCGjYp83zFFsKIcQ64nNh37FQtJa2In/XrAuS5mErG01SVtNIzYZgiWUYK+IKLHAlmSuYrJPUC+NwwLjP2Ete10MIAK3IuTeSAtDjb8wJSMVnR+PiMVsBz149TcM3nYJGiMCjPqW9hmFSW8aLIRcprM5ko3Dg4f9/VMUtnkF6N1XWXaZ4JhdywSnZZplWRqaUkug77rNNBFuWdzkCORqOBvBlIxgYJrvwgOWaDhF4Pkq57roFnOGl8N+G5Af/ci1Xtk1/DNZ8XOaDQxs9xyq7NmZfHZvebBCUON5C3ntCBPELqkdDNxLvfdqH9g4It1Db624nYz5HYD2rMLoTNt1CMTSw22Y3sFNQWsu92uhPtT5D2VM0LLlebKfcNdhQVJySsWFiW22zLHNrd7zSDpziDjNstjMe3u9F+eNg7eNo7Ojh6Gr+bCzl0HWGD6jG/XvcYlZuQ0/iqPtJdBrhW1ax6rNMJ46FqYaEhaoS5kGJeooI0VouUNBc2RB3jumJzNKJjQL3X6fzwww8/9L77rvfiRadDxpHbvh/C045DNEbg1z/TCHU2dDrH7NWE1R+h2jNgSdfpErrRLqC+iw1maimDOiSjoVlWamzim/YZmsI5X1FnIOwMdHMcpYN1dMYDde1Y2VmfvSXbgr8HHewNIWSkR79A8UJZHKvrzRLmG+wmZPMV2cMtG6P1eodd8Sva195QbNnYvsUuhF8OEme6ekeD5H1TaH0zFKjgncz4Ao0prcFcaZQwLumB81PsjFtyxQyu8RiYgRxS9KjGq7BotBL/RBvd27gtm9232G0t3IwO65twIP8ZR6zb2M2jUqufYcjDA7J85XwMeovto/e7DHfgH+HuLHPe0lYZpGLO8yLnKZA8HW02k82hdxBK5v8ZyENyTlLIc7NFNPH1vVPEVkNy5fDN03V8XrO/Pp181pTvari2x+f4gnEHEe7E2sxUmWco1BpsqaWLN7A5Bgref9RgCiXNHS1c2x6+Hw20QvQWroWxqLrC5763Mw0TkefsnfcWqVP3KHj6XAODHFzIRf3jEyENoNbD8EXVgiHW6YxhojR0OkxYp5C5howhxxh3M2Gv0VtueN4UFynNZtywAvRcGIN2BPvOMmw69xR/K4xFvrUCEaIk0I5icni/Jl6niB136CWXmYYlG0PD2B7t7EDELtkgOXiyf/h0/+jg6Em9z89/svqt+r5E54L8Oty34H5v6du67HznTXI6UyYEUQ1JIYEyJKJ+XNSvQjpOu/DMhZj96BruoP18qw18cuT/LNTXR9s4g0rbkINIIevmCdDr9UIjfvfV6zfLg99+PVUnJycn35+/nb18Oz05OZnj3/1+38/Kd/3FT7ZSdW6F5f5Z+BXG2syrgUy6iSowJSOUfJUlx4lPa/jdjHs9NBdZ0k1iJIvZoRuaWHKc1LI1STcRmB0quJ0l7ZSRGn+A1L6iVE5IayTdRMPvS6EhS47JG0yMXeXYrREYSCTdBK6LXGWQHDsTkJh0BnOeHN8kdlVQS4t+YdJNnBdaf+LDESTpm8PxLD2aFePk9va9GxaM/UplK+wqVdKCtPirD8eR6v0PBkm/qY1ZkXuZOL+UsmOeFDdHZJVGzloBhgjFWG1Xir+vZclctHeHpSeySihUaQbjLFTIJNGnlJcgkwXLfBXzV1Xy69WEqbmwtkrauBX68Y//aXwXS7QnY3DpsIafltx2IzOqWXKt+QpFwsK8/nwDk7Raz6OKIyeYv7GSS4sDUqZhK1OpQb2DDwrqaQzsxQnxtlE/KEDrgY2LmZL3tD48+hz//fwQ2/sYd9eVDzlC7OKDGg9/kvhksKiWZbiJuXd7aEqY83YEGBIK7AW3L/0eUnVBs4QQrtAqBWP67ASTWJB5pXRcBYfo5bLHXnz2jp1ao5CBW5YDR9dAQpWN9F6CDy8XApbYwzF7AymIhaet2iqKYRPK5X3pYlbqW6qYmHMd8QKTqKEr/Mal/PzzZrdf4vdtiljQBn1SpiDLeaUXkm7iSE26SRgKVUW1RL7dbTfhKbJsmJKe232VlphzNWBx62JAW85Bi5S5Xhn2ii5cIDbqAh9Xo3fmWuLs8WFj5v22fD95+gXS7Jn50zf8/VvPO3ZD2kwhGqh9MlYqBy7r35CRuO2GaGB7/z4YH6vr5Pa2G9R0ywzW7Nvw3Cm5YZj77U6f0SATlWeg0dxuo4y2Lshs2NZy1ZTbBZlGqrlZefEWgS1nQGkSfLzk0rpsbRWDu93jNblP/DTqC8Jg3kOXMEjIZFQhC2mFdrY7tCXBkoo9ovGGpiSBeLTv/x6rbPWo+tIFK8ZrniySQI2jYTINe0TOqydoIiCn5Lo3aJiE8OWSjHGUcgbzwq72hVzwXHgF1TR71Xx97/XVwUkFAxQms245myt0Whqr5owm4T+inVgpFe+T9Nkpl0zINC99VFjVA9jNTRAwZxZub9nNDUoK6CFuqNvbbvUAx2o8IAPmnminPOtfxUdQfRif1T6F60LoFSXZ3ANv5+oE+ERcqX0/UmHjpi5pEU5Ro+cBZFF2UR/dnXX0AEh6Ppn7d5jtpQo7+X/D92fF82/EGlKe7RfPnxXP3wGbqQLcfnbsmQiZOW2yhDzvs2fGaiWnz1sseLbvn69fSk1GtrIyVS9t3saO+p6mH1RZ3ynCsFSXqeA59kseR0hOOCf32jJjoTC434UrbDo3ZoUd8akGSoU4e1/amdLiD+TyhwGfcTbTMPmXRy2ePnpOpcQZaHi2z5/71q8mNEfnw8gVo4kLJQ3qHio5T0pNqjfNuRYTH190WYHuDhZDpOWpdVaZOBrouJhxeWW6z8b6ORYlYzHzxz/9GVsEO/FKvtYZ6E8wFJ0Oqq9Oh/Wq/M1EaGODO6DrXtWm/eLrwvmqz17ydIYKzWADGbtxiXWnwQV6J/g2ha6rsfIJmggcoUCpUKUJ36HkoFzngJLjKrgx5U9WTnjPzJuFMcz4QqiQWSMHgKZ3kufBloVJbZ2TEfMyt1yCKk2++iUsCll8IYcK13Lo6jC7LalbjLgC41ylVwGn4Jy8EBZGf7mUVuSECiiQS1mosSDbSKDbq8GpONRnL+VE6RQMc4T6JUaxqBaMRIwiajTYzk2N0kq199y4OtCd5fNOE9UTvH/aoFvDlOssx+eYSPSuTUuc2lP4m65q8EXJGRuqySQXEoYU2e20qHVOmHI8F5ZxlqpiFb2uyBSPr/DgCcng2oKWpCZVTu6GA0c4VbyR5xQ1BabFyA71q5BRBf0ivEQgz4U69aS94Kt6oOHy8XdYSeAfxPyECWV8ZcI49ILnaUkkOBPrypBq4qxFI0lC7I6zLTSYWggc9Al6E120OxjzaZF5ZdqcaBehSTJsCvK8DzbnYVrMqQeFcdaRWYdP0TsiDM7ri7PdhM3WsDHkYbt+2OuLM7aAynZhFRVFhdoE9cobTVzkuRDcKdguW85EShZ65SQMpHXx592gk7VF8y5hmTBrKeu66AcltiQS1w3AMqEhtfmKpFqVFisUwufSyHX4RcTbMftClTua8k2rxtm0JCItSnIIN0Cbbg1vhxg7XabOYfFV9rUZnfaahBXAxrVxugykcd1wNqH6WpeVkiByuiyQf6FruC5AC3QMfhF217zX+0MIDIcJQeczYAVooyTSpvSUS+9AInxsifl5ckxy19Q7TYaNgczr30SbBC4xNx/2GGuge5+sYvx6SIVKf+pRG0QHCVhp3LqTPaEscaFhAhrX0sTkwNq3FN+T4SfoRb3X4NRZRRXb1rLFzOiPf/pzUi3fxkzw3fVzC8GzTHu/YctCUpXUaRC0vFiIXTGrHhbuJywcsh30r9vo1yR6R3OVRQVudtN9Z1hotpXH56vNsdptynSGWiP6/aaOayWgq+ni6kegqipQNGJVLRSpxX026o3HTlW0OMc7c6hluaobmaoar1rdrotyaIl/ER2JwOf7N1cAYxU1MIMHY4NEPyBjZy9+QyhqlwpYg2rA4krNr3Gf30mLYhfDghuzVHptFnVbVYQErrRqqGEu5KdFzOcVWA1/BstaWjXnVqQsdGX6zDd1KBKr6gZyHiseMWLdi7vtr7CY65bSUTpUMgUMMwkaf7/7/H1EuZDfPAa7BJD1aQeBVTHac3BmUmoNdrfAf3329+VTR46hAz0HPYVhigUL0kywm1oipnhfzJTao3pwfB+HkIdc9Y50+ORjrNZXoTdunkpDfKOWuHgxf4RZPtc/ri0jyv1k6yOkXBIIEpNMmG6PRxgcAFTIaoi2avMZrnSmlBsPeUvjdLfNKeToG8IcRw/hatQMPFc+zlx3WuAXt2zEjg1qkpJdq6GSw8rOfEKpaqsArUFWNcMt6R0al2nzURdKP0oHMtplgvBHM3tyZ303D4YM+ZkG/F5ZwFprPXFDm9+ARQvQpbxGFCQ31CZpoNztBrHj1vJ0BqRPMihA0iGYR1VFrVZu8vgFDS4ixDTv/eauWRd/++ZbZIKu8ougo+iHjjEtU1BQ7Ehu5+HuRFt/527mHbtagBymKlefBALxfL2tdXKZjPPSQYIQSTTOeXqVvL/tJuM0/ak9ovvegHx06dFR49md023jNGWPx7lAAeN6TItWrPaOfcqDZ6jJaL1b2Y/GtnDiSwq5sdDCNPKRf7VlXudAMOIee3z5fs8Nvc7hWCMV97iNiHX5G68RLtHD4nzi4hQOUXs/JuOvBurY5pRHDEY3IiJ37aJC+SIm43YLLmNYB2ZQ7ZgaN2GINUpoVkcHB/ijKYEvGuYSk1ollSnocOI/JN1PBxVuZ2kATu7Kk9kHcfSH63RxdBaAYE3TtuPK3o+3W4ewaZ0cREo2GNitU/EnaEud96zq4Vx60bOgbmvrLSTVWcICDjOVDsPsb8mvN4ZPdxaxuNy0/5trfc/wiRPIJ+ukqFY6lo8oC11h9n2hHNUa6puww7GmrGwMtUOTpvMsNMH16EsS859NHkFrpXfl3pkLVAzYsqhm4jq+j4NPDg6GacXEp2uY6MNiPHR+oa5A/ozbb+N0q8nVh7dueCT1ep5XKjHxoTu9TxqzrT93kzSQllrYFeGsr3u8ED33/vjyPaKX52BnChHbhTJEMQKuj5P9pqrbv6nputsEu9WLgN6mXRg3luEyG6vru8fTeSH2F4f9o+S22/5m7XH2Le2h7O36ibF8KuT0vu/eVxw7x1V1C9fgW6X1CvFbwN3gl6XeysPXZ8AxM4QLgcLypoKKvwxLHjHd62HaEQx9GXDNdfByxC7fASRHqgLoOGKOa8DiGq64ggo3kMIE/m1hfytUagNsGgCdNTxnHdof8Jd1+GWMWz3CsgGjJPGsMI5J0sQxOox/Czn3lwHBmjiwB3DT/yFwUwvb5A+IrAXJeKFcB7Xwr9YhBw6fNurkvmW9CBsOndQLhY0yVLsKtbHUsaHS4QdwWXbcLq38Nj5qZaz9J+uzuU/XJi79J+uTVLG/egYEx61H9Oujcx+cf3oQt1vrWtyyWT0l9bChEQm8RxUu5ETVFXa8DgStNdmPdmj5WV0QYzNMYD1nnQ5mynBxe0aVOnX337jrRXLC2liMNn/843+wcSlyB/HNYAE5+hSmi2lv4w86Q7xbxPTx1NhA1sedEggPd15MigFV7TNXqu+hRl4x6FWaA2093YRjZ1qV0xkl5OQ0hy578/L8YlLmdI8MO8eEWHUDTwOF3GVzLvm0CiiJZp5exQSVsdyW5FdqQB0l5tANugZLIuD0EELBdC2yzsUE0lWaO+a4W2gc8mIBMlOaIVatJxysqNfr4Y/PPmNfu9QgO7ccz4fi05d0pU8IvR1WiWu9cuNGJyzE6KOaiR8xZ9z78exe7eUxe4Y9VA+exyPanc6P//bv7PIbtWzcZNQcsLrpJ1OpWXPVj0rN/gzyYv/cTcrsn5y9In91z63/93QVgYaQTURc/lTIf8XcBs2l0/GeGgO5EFpJZC2ephl9sic32vNmxSp0iSr8y2QCKbE6RwnOuOWtpTjFk/ynvOBjkQt0j/H5R3bKLUyVXrGP7B2WIFb+EoBMsY8D+bHX69F/2LTTiXdKdTrso7/lqEtmocvKIqO/NCzUlZepDCIEjcSzF5a9El/fc7y+iXr+qhR0eLr0BbjaqQE7wyxOjwqQMdj6kmhAzoRrC9DUhdDKD3EO+aSH+5OG+DpIgcHHrey0qfga8ZhyIazLPk1ytQydnpXjXKSsSf75jAoSrHAvw9bLhbyi7SPDMQ2W40nqeLQncFnziWXvlL7CkVyPaL4r6qjcHXjCDcvwCxdyToTkuTC+aoktdOj31JlyR+N3Tk+sgveCDoA39WOlrlDEpprPqUiKUOHQyW/IO3R9vCbAhalTJqTBqDaq6RcaxdG5lHEl3sF4ptSV68SfAyN11COwH+bZbCPhZ5iTTAJAMpBZofC6Jt8dpQ59X1YLQE/HXRblqgxoGjHn5yJcXMGPza2Bgk81JQwHhIwGA19+xk6oHEFa0B3RZ+fuvPtAojUZ8fjejMLRMsJPL2sH4/HcMy1rYFU3XGJWPXANwsLGBtUDnI2XqfpNbQ7shqR+g7x3MFD6gVL3rZBXZiCxuD3y1yf40CJ4jzm1SI5dkfyjK5SNkOTR2evzC7ZPhAU6R7jNZlXqoiHeFcyiMdnmlQeO1lOsqIGuLknzi8fzgRx9/fKC7Yc57h+LbESTbz7HzTNynu0Ya9rGauDznA5M4zbTkJUyw5NSrdNJGuZqgdlbmbFOx7sppDPDwsXLH0KxM1+5Wqufc9Vhp4M296p+r4NhwI1w2MhUSVPOIa7QmXcNe2daWVdXwvpplCh8j+vU8CMHyWhdytrlopdKXwV8L6I19KrwvSKkoSaAxwPp19MJVmDjiP33f7HR2ds7HKfHtQ9iZuK4lpmoN2vJSetFazx6gcoXWToK/HntnP8ovaiztMqj/N4NEbYJbnuiJENrZorAkGtMMgnElHqMCLp+HgHix4uijj4XIFi/cf0C0u833xtM3nn94M3QiLkUFckXRvEFamycUy3Sx5V21QqeaoWHOvPc6QFUW1qVFgixoQF8gpBO24VVPnY2HUdHK+qQKqW+Y8k9TSPWiQd5ySY0gONbj/M63TtyZ2RHlRpvwfzdXYzxRG+wfjFH6g8Zu87COVvs7jTcQ4SGPDT3Fx3y1iEQoV3E/DGqFldZOkWQ/ePT0z0kzt9MOJAndP3kaJCkacXtO/qa0rEmYKEiyGk0wJCp+k7Jmv6uFLXTfpRNCN5FXMV95yjFxXxZBzWCIZfAYUgijVUVzNXMenR8YPeKGPtWXEE1BzzNwxrUsMcBbud2SbXjRTbaq4GOI2mfXLUu6RjJ2orZ6PL9aO9LqpfV8FRWMSFnoP3DZtct3/Yk3gH5snKsvYNbe4J7AnMaWPG/69yeO9+bHIkdHPLoCcbYrtnD1uxn/PrlW0RW3Pn4vqzrqO3K/A40XtqDa/SP7CueXi25zgzDxAm3glz/FTbFj1E43F2c49Cwl/qGuQst2OKQxHhx2D+MkV/wv0yAHyGoaOEG9lic2p2cLlk3DnynXqViYw3OaqYzLqe4EdD5qhlqgYo/K1O3F4he7DpemVFKB0LB3NVSeBhV1hKMtwYwbvY+EN4ccBld03cwNsJCFfctl8s7nN6jb35T5nm8Kpc23D3Rovvsa2G/KcfsDRTKCKv0qvpqKuysHNNa1r+Nf/gOQpASSyN/SZRKXV6AnhN05xz0QqT3TH/fYvP9PUJNtVLyzbQLobFQ75hGjM0L4eP5y0AHQ/L+knm4yzkoVqmVNrE2sBaiTFN4PfHz9fWJ7fNNukkuUvClbJ+wOvn67Fu2+Lx/kHRrhY5PWMv9b1+dvvz+/CUS47cJpu77B/0DKu8rY+dc1kZaezdz7dadBudr1988XOz8cLHzw8XODxc7P1zs/HCx88PFzg8XOz9c7PxwsfPDxc4PFzs/XOz8cLHzw8XODxc7P1zs/L/kYmePdsUdtF/kXMga8t6hhS9bByOSblKvyiH8aobo4uPL5OYG8w1vESKIj39fEtLs8n03WXAtMMAlWJavdWXrjzbWs0yP33jAwh7bcC30WvoDhFcifpdY4nBqV7BqXUR9i+fGPI4XSXMtTh0BvQvsp+rhDjocgcjuixOqsm1tW4djY80QwXH+SsK5g9hqvkSMGl86ap2r4O48xmc3Sc7ltKQjCYnr89YdU581cctXhFv2v+Cs1vKjCWh208D/46TWfnBz4zDRhKV17d2rjV94xobWuDjvb29v/wdzss2m","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Document","permalink":"/docs/API-docs/v1.1/createdocument"},"next":{"title":"Get Document","permalink":"/docs/API-docs/v1.1/getdocument"}}');var s=n(74848),r=n(28453),a=n(57742),o=n.n(a),l=n(78178),d=n.n(l),c=n(19624),p=n.n(c),h=n(96226),m=n.n(h),u=(n(77675),n(19365),n(51107)),f=n(21312);const g={id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztXOtyGzeWfhVsp2ptsUjqEjuzq3i9o8iexDVJrLLkcaVEFwl2H5KwmkAPgCbFkVU1P6b2Abb2z/6dl9j/+yh5kq1zcOmLSMrMZCazu0olkdSNBg4ODs71A24Sy6cmOb5MXqi0nIO0JnnfTTIwqRaFFUomx8nFDNipBm6BhVZsotWcWZgXOT4+OXvFeJ6rpWErVTKr2BQkaHwlYcmy0Dcbr9iH0lhWaLUQmZDT2MdQZExIY4FnTE1YWeSKUwNOXUxEDo+FZHYGbKL0HNuMuYEvnjCl2VhIrld7DBagV8yKORAdEiBDYlJHPI+E9NmFH9Zgb0xDgS2yfMVKAxmNZljKJRuD/zpzUy4NaCakBT3hKTBu2WWn8wLG5ZS9fdXpvH88s7Ywx/v7vCj6qgBpxFTmfGz6qZrvZ9iwyCZ7SHRpaP4Vcy9q7OwP5ED+oEoiwnELWAYTXuaWLXheEhuQ6WwpsikgbzmSrohHQjPJ59B4b8qiUNoyuE6hsAwJ47bU0GXG8nnRZUIKK3huukzM+RSIhE5nJjIYWri2w6WwsyE3FrQwV+a402HvZiAZSD7OIevSVLChp4FGgCwynQnDZiLLQDpWakhFIUgsHCti1102Li3TMOdCGjYp83zFFsKIcQ64nNh37FQtJa2In/XrAuS5mErG01SVtNIzYZgiWUYK+IKLHAlmSuYrJPUC+NwwLjP2Ete10MIAK3IuTeSAtDjb8wJSMVnR+PiMVsBz149TcM3nYJGiMCjPqW9hmFSW8aLIRcprM5ko3Dg4f9/VMUtnkF6N1XWXaZ4JhdywSnZZplWRqaUkug77rNNBFuWdzkCORqOBvBlIxgYJrvwgOWaDhF4Pkq57roFnOGl8N+G5Af/ci1Xtk1/DNZ8XOaDQxs9xyq7NmZfHZvebBCUON5C3ntCBPELqkdDNxLvfdqH9g4It1Db624nYz5HYD2rMLoTNt1CMTSw22Y3sFNQWsu92uhPtT5D2VM0LLlebKfcNdhQVJySsWFiW22zLHNrd7zSDpziDjNstjMe3u9F+eNg7eNo7Ojh6Gr+bCzl0HWGD6jG/XvcYlZuQ0/iqPtJdBrhW1ax6rNMJ46FqYaEhaoS5kGJeooI0VouUNBc2RB3jumJzNKJjQL3X6fzwww8/9L77rvfiRadDxpHbvh/C045DNEbg1z/TCHU2dDrH7NWE1R+h2jNgSdfpErrRLqC+iw1maimDOiSjoVlWamzim/YZmsI5X1FnIOwMdHMcpYN1dMYDde1Y2VmfvSXbgr8HHewNIWSkR79A8UJZHKvrzRLmG+wmZPMV2cMtG6P1eodd8Sva195QbNnYvsUuhF8OEme6ekeD5H1TaH0zFKjgncz4Ao0prcFcaZQwLumB81PsjFtyxQyu8RiYgRxS9KjGq7BotBL/RBvd27gtm9232G0t3IwO65twIP8ZR6zb2M2jUqufYcjDA7J85XwMeovto/e7DHfgH+HuLHPe0lYZpGLO8yLnKZA8HW02k82hdxBK5v8ZyENyTlLIc7NFNPH1vVPEVkNy5fDN03V8XrO/Pp181pTvari2x+f4gnEHEe7E2sxUmWco1BpsqaWLN7A5Bgref9RgCiXNHS1c2x6+Hw20QvQWroWxqLrC5763Mw0TkefsnfcWqVP3KHj6XAODHFzIRf3jEyENoNbD8EXVgiHW6YxhojR0OkxYp5C5howhxxh3M2Gv0VtueN4UFynNZtywAvRcGIN2BPvOMmw69xR/K4xFvrUCEaIk0I5icni/Jl6niB136CWXmYYlG0PD2B7t7EDELtkgOXiyf/h0/+jg6Em9z89/svqt+r5E54L8Oty34H5v6du67HznTXI6UyYEUQ1JIYEyJKJ+XNSvQjpOu/DMhZj96BruoP18qw18cuT/LNTXR9s4g0rbkINIIevmCdDr9UIjfvfV6zfLg99+PVUnJycn35+/nb18Oz05OZnj3/1+38/Kd/3FT7ZSdW6F5f5Z+BXG2syrgUy6iSowJSOUfJUlx4lPa/jdjHs9NBdZ0k1iJIvZoRuaWHKc1LI1STcRmB0quJ0l7ZSRGn+A1L6iVE5IayTdRMPvS6EhS47JG0yMXeXYrREYSCTdBK6LXGWQHDsTkJh0BnOeHN8kdlVQS4t+YdJNnBdaf+LDESTpm8PxLD2aFePk9va9GxaM/UplK+wqVdKCtPirD8eR6v0PBkm/qY1ZkXuZOL+UsmOeFDdHZJVGzloBhgjFWG1Xir+vZclctHeHpSeySihUaQbjLFTIJNGnlJcgkwXLfBXzV1Xy69WEqbmwtkrauBX68Y//aXwXS7QnY3DpsIafltx2IzOqWXKt+QpFwsK8/nwDk7Raz6OKIyeYv7GSS4sDUqZhK1OpQb2DDwrqaQzsxQnxtlE/KEDrgY2LmZL3tD48+hz//fwQ2/sYd9eVDzlC7OKDGg9/kvhksKiWZbiJuXd7aEqY83YEGBIK7AW3L/0eUnVBs4QQrtAqBWP67ASTWJB5pXRcBYfo5bLHXnz2jp1ao5CBW5YDR9dAQpWN9F6CDy8XApbYwzF7AymIhaet2iqKYRPK5X3pYlbqW6qYmHMd8QKTqKEr/Mal/PzzZrdf4vdtiljQBn1SpiDLeaUXkm7iSE26SRgKVUW1RL7dbTfhKbJsmJKe232VlphzNWBx62JAW85Bi5S5Xhn2ii5cIDbqAh9Xo3fmWuLs8WFj5v22fD95+gXS7Jn50zf8/VvPO3ZD2kwhGqh9MlYqBy7r35CRuO2GaGB7/z4YH6vr5Pa2G9R0ywzW7Nvw3Cm5YZj77U6f0SATlWeg0dxuo4y2Lshs2NZy1ZTbBZlGqrlZefEWgS1nQGkSfLzk0rpsbRWDu93jNblP/DTqC8Jg3kOXMEjIZFQhC2mFdrY7tCXBkoo9ovGGpiSBeLTv/x6rbPWo+tIFK8ZrniySQI2jYTINe0TOqydoIiCn5Lo3aJiE8OWSjHGUcgbzwq72hVzwXHgF1TR71Xx97/XVwUkFAxQms245myt0Whqr5owm4T+inVgpFe+T9Nkpl0zINC99VFjVA9jNTRAwZxZub9nNDUoK6CFuqNvbbvUAx2o8IAPmnminPOtfxUdQfRif1T6F60LoFSXZ3ANv5+oE+ERcqX0/UmHjpi5pEU5Ro+cBZFF2UR/dnXX0AEh6Ppn7d5jtpQo7+X/D92fF82/EGlKe7RfPnxXP3wGbqQLcfnbsmQiZOW2yhDzvs2fGaiWnz1sseLbvn69fSk1GtrIyVS9t3saO+p6mH1RZ3ynCsFSXqeA59kseR0hOOCf32jJjoTC434UrbDo3ZoUd8akGSoU4e1/amdLiD+TyhwGfcTbTMPmXRy2ePnpOpcQZaHi2z5/71q8mNEfnw8gVo4kLJQ3qHio5T0pNqjfNuRYTH190WYHuDhZDpOWpdVaZOBrouJhxeWW6z8b6ORYlYzHzxz/9GVsEO/FKvtYZ6E8wFJ0Oqq9Oh/Wq/M1EaGODO6DrXtWm/eLrwvmqz17ydIYKzWADGbtxiXWnwQV6J/g2ha6rsfIJmggcoUCpUKUJ36HkoFzngJLjKrgx5U9WTnjPzJuFMcz4QqiQWSMHgKZ3kufBloVJbZ2TEfMyt1yCKk2++iUsCll8IYcK13Lo6jC7LalbjLgC41ylVwGn4Jy8EBZGf7mUVuSECiiQS1mosSDbSKDbq8GpONRnL+VE6RQMc4T6JUaxqBaMRIwiajTYzk2N0kq199y4OtCd5fNOE9UTvH/aoFvDlOssx+eYSPSuTUuc2lP4m65q8EXJGRuqySQXEoYU2e20qHVOmHI8F5ZxlqpiFb2uyBSPr/DgCcng2oKWpCZVTu6GA0c4VbyR5xQ1BabFyA71q5BRBf0ivEQgz4U69aS94Kt6oOHy8XdYSeAfxPyECWV8ZcI49ILnaUkkOBPrypBq4qxFI0lC7I6zLTSYWggc9Al6E120OxjzaZF5ZdqcaBehSTJsCvK8DzbnYVrMqQeFcdaRWYdP0TsiDM7ri7PdhM3WsDHkYbt+2OuLM7aAynZhFRVFhdoE9cobTVzkuRDcKdguW85EShZ65SQMpHXx592gk7VF8y5hmTBrKeu66AcltiQS1w3AMqEhtfmKpFqVFisUwufSyHX4RcTbMftClTua8k2rxtm0JCItSnIIN0Cbbg1vhxg7XabOYfFV9rUZnfaahBXAxrVxugykcd1wNqH6WpeVkiByuiyQf6FruC5AC3QMfhF217zX+0MIDIcJQeczYAVooyTSpvSUS+9AInxsifl5ckxy19Q7TYaNgczr30SbBC4xNx/2GGuge5+sYvx6SIVKf+pRG0QHCVhp3LqTPaEscaFhAhrX0sTkwNq3FN+T4SfoRb3X4NRZRRXb1rLFzOiPf/pzUi3fxkzw3fVzC8GzTHu/YctCUpXUaRC0vFiIXTGrHhbuJywcsh30r9vo1yR6R3OVRQVudtN9Z1hotpXH56vNsdptynSGWiP6/aaOayWgq+ni6kegqipQNGJVLRSpxX026o3HTlW0OMc7c6hluaobmaoar1rdrotyaIl/ER2JwOf7N1cAYxU1MIMHY4NEPyBjZy9+QyhqlwpYg2rA4krNr3Gf30mLYhfDghuzVHptFnVbVYQErrRqqGEu5KdFzOcVWA1/BstaWjXnVqQsdGX6zDd1KBKr6gZyHiseMWLdi7vtr7CY65bSUTpUMgUMMwkaf7/7/H1EuZDfPAa7BJD1aQeBVTHac3BmUmoNdrfAf3329+VTR46hAz0HPYVhigUL0kywm1oipnhfzJTao3pwfB+HkIdc9Y50+ORjrNZXoTdunkpDfKOWuHgxf4RZPtc/ri0jyv1k6yOkXBIIEpNMmG6PRxgcAFTIaoi2avMZrnSmlBsPeUvjdLfNKeToG8IcRw/hatQMPFc+zlx3WuAXt2zEjg1qkpJdq6GSw8rOfEKpaqsArUFWNcMt6R0al2nzURdKP0oHMtplgvBHM3tyZ303D4YM+ZkG/F5ZwFprPXFDm9+ARQvQpbxGFCQ31CZpoNztBrHj1vJ0BqRPMihA0iGYR1VFrVZu8vgFDS4ixDTv/eauWRd/++ZbZIKu8ougo+iHjjEtU1BQ7Ehu5+HuRFt/527mHbtagBymKlefBALxfL2tdXKZjPPSQYIQSTTOeXqVvL/tJuM0/ak9ovvegHx06dFR49md023jNGWPx7lAAeN6TItWrPaOfcqDZ6jJaL1b2Y/GtnDiSwq5sdDCNPKRf7VlXudAMOIee3z5fs8Nvc7hWCMV97iNiHX5G68RLtHD4nzi4hQOUXs/JuOvBurY5pRHDEY3IiJ37aJC+SIm43YLLmNYB2ZQ7ZgaN2GINUpoVkcHB/ijKYEvGuYSk1ollSnocOI/JN1PBxVuZ2kATu7Kk9kHcfSH63RxdBaAYE3TtuPK3o+3W4ewaZ0cREo2GNitU/EnaEud96zq4Vx60bOgbmvrLSTVWcICDjOVDsPsb8mvN4ZPdxaxuNy0/5trfc/wiRPIJ+ukqFY6lo8oC11h9n2hHNUa6puww7GmrGwMtUOTpvMsNMH16EsS859NHkFrpXfl3pkLVAzYsqhm4jq+j4NPDg6GacXEp2uY6MNiPHR+oa5A/ozbb+N0q8nVh7dueCT1ep5XKjHxoTu9TxqzrT93kzSQllrYFeGsr3u8ED33/vjyPaKX52BnChHbhTJEMQKuj5P9pqrbv6nputsEu9WLgN6mXRg3luEyG6vru8fTeSH2F4f9o+S22/5m7XH2Le2h7O36ibF8KuT0vu/eVxw7x1V1C9fgW6X1CvFbwN3gl6XeysPXZ8AxM4QLgcLypoKKvwxLHjHd62HaEQx9GXDNdfByxC7fASRHqgLoOGKOa8DiGq64ggo3kMIE/m1hfytUagNsGgCdNTxnHdof8Jd1+GWMWz3CsgGjJPGsMI5J0sQxOox/Czn3lwHBmjiwB3DT/yFwUwvb5A+IrAXJeKFcB7Xwr9YhBw6fNurkvmW9CBsOndQLhY0yVLsKtbHUsaHS4QdwWXbcLq38Nj5qZaz9J+uzuU/XJi79J+uTVLG/egYEx61H9Oujcx+cf3oQt1vrWtyyWT0l9bChEQm8RxUu5ETVFXa8DgStNdmPdmj5WV0QYzNMYD1nnQ5mynBxe0aVOnX337jrRXLC2liMNn/843+wcSlyB/HNYAE5+hSmi2lv4w86Q7xbxPTx1NhA1sedEggPd15MigFV7TNXqu+hRl4x6FWaA2093YRjZ1qV0xkl5OQ0hy578/L8YlLmdI8MO8eEWHUDTwOF3GVzLvm0CiiJZp5exQSVsdyW5FdqQB0l5tANugZLIuD0EELBdC2yzsUE0lWaO+a4W2gc8mIBMlOaIVatJxysqNfr4Y/PPmNfu9QgO7ccz4fi05d0pU8IvR1WiWu9cuNGJyzE6KOaiR8xZ9z78exe7eUxe4Y9VA+exyPanc6P//bv7PIbtWzcZNQcsLrpJ1OpWXPVj0rN/gzyYv/cTcrsn5y9In91z63/93QVgYaQTURc/lTIf8XcBs2l0/GeGgO5EFpJZC2ephl9sic32vNmxSp0iSr8y2QCKbE6RwnOuOWtpTjFk/ynvOBjkQt0j/H5R3bKLUyVXrGP7B2WIFb+EoBMsY8D+bHX69F/2LTTiXdKdTrso7/lqEtmocvKIqO/NCzUlZepDCIEjcSzF5a9El/fc7y+iXr+qhR0eLr0BbjaqQE7wyxOjwqQMdj6kmhAzoRrC9DUhdDKD3EO+aSH+5OG+DpIgcHHrey0qfga8ZhyIazLPk1ytQydnpXjXKSsSf75jAoSrHAvw9bLhbyi7SPDMQ2W40nqeLQncFnziWXvlL7CkVyPaL4r6qjcHXjCDcvwCxdyToTkuTC+aoktdOj31JlyR+N3Tk+sgveCDoA39WOlrlDEpprPqUiKUOHQyW/IO3R9vCbAhalTJqTBqDaq6RcaxdG5lHEl3sF4ptSV68SfAyN11COwH+bZbCPhZ5iTTAJAMpBZofC6Jt8dpQ59X1YLQE/HXRblqgxoGjHn5yJcXMGPza2Bgk81JQwHhIwGA19+xk6oHEFa0B3RZ+fuvPtAojUZ8fjejMLRMsJPL2sH4/HcMy1rYFU3XGJWPXANwsLGBtUDnI2XqfpNbQ7shqR+g7x3MFD6gVL3rZBXZiCxuD3y1yf40CJ4jzm1SI5dkfyjK5SNkOTR2evzC7ZPhAU6R7jNZlXqoiHeFcyiMdnmlQeO1lOsqIGuLknzi8fzgRx9/fKC7Yc57h+LbESTbz7HzTNynu0Ya9rGauDznA5M4zbTkJUyw5NSrdNJGuZqgdlbmbFOx7sppDPDwsXLH0KxM1+5Wqufc9Vhp4M296p+r4NhwI1w2MhUSVPOIa7QmXcNe2daWVdXwvpplCh8j+vU8CMHyWhdytrlopdKXwV8L6I19KrwvSKkoSaAxwPp19MJVmDjiP33f7HR2ds7HKfHtQ9iZuK4lpmoN2vJSetFazx6gcoXWToK/HntnP8ovaiztMqj/N4NEbYJbnuiJENrZorAkGtMMgnElHqMCLp+HgHix4uijj4XIFi/cf0C0u833xtM3nn94M3QiLkUFckXRvEFamycUy3Sx5V21QqeaoWHOvPc6QFUW1qVFgixoQF8gpBO24VVPnY2HUdHK+qQKqW+Y8k9TSPWiQd5ySY0gONbj/M63TtyZ2RHlRpvwfzdXYzxRG+wfjFH6g8Zu87COVvs7jTcQ4SGPDT3Fx3y1iEQoV3E/DGqFldZOkWQ/ePT0z0kzt9MOJAndP3kaJCkacXtO/qa0rEmYKEiyGk0wJCp+k7Jmv6uFLXTfpRNCN5FXMV95yjFxXxZBzWCIZfAYUgijVUVzNXMenR8YPeKGPtWXEE1BzzNwxrUsMcBbud2SbXjRTbaq4GOI2mfXLUu6RjJ2orZ6PL9aO9LqpfV8FRWMSFnoP3DZtct3/Yk3gH5snKsvYNbe4J7AnMaWPG/69yeO9+bHIkdHPLoCcbYrtnD1uxn/PrlW0RW3Pn4vqzrqO3K/A40XtqDa/SP7CueXi25zgzDxAm3glz/FTbFj1E43F2c49Cwl/qGuQst2OKQxHhx2D+MkV/wv0yAHyGoaOEG9lic2p2cLlk3DnynXqViYw3OaqYzLqe4EdD5qhlqgYo/K1O3F4he7DpemVFKB0LB3NVSeBhV1hKMtwYwbvY+EN4ccBld03cwNsJCFfctl8s7nN6jb35T5nm8Kpc23D3Rovvsa2G/KcfsDRTKCKv0qvpqKuysHNNa1r+Nf/gOQpASSyN/SZRKXV6AnhN05xz0QqT3TH/fYvP9PUJNtVLyzbQLobFQ75hGjM0L4eP5y0AHQ/L+knm4yzkoVqmVNrE2sBaiTFN4PfHz9fWJ7fNNukkuUvClbJ+wOvn67Fu2+Lx/kHRrhY5PWMv9b1+dvvz+/CUS47cJpu77B/0DKu8rY+dc1kZaezdz7dadBudr1988XOz8cLHzw8XODxc7P1zs/HCx88PFzg8XOz9c7PxwsfPDxc4PFzs/XOz8cLHzw8XODxc7P1zs/L/kYmePdsUdtF/kXMga8t6hhS9bByOSblKvyiH8aobo4uPL5OYG8w1vESKIj39fEtLs8n03WXAtMMAlWJavdWXrjzbWs0yP33jAwh7bcC30WvoDhFcifpdY4nBqV7BqXUR9i+fGPI4XSXMtTh0BvQvsp+rhDjocgcjuixOqsm1tW4djY80QwXH+SsK5g9hqvkSMGl86ap2r4O48xmc3Sc7ltKQjCYnr89YdU581cctXhFv2v+Cs1vKjCWh208D/46TWfnBz4zDRhKV17d2rjV94xobWuDjvb29v/wdzss2m",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-2",custom_edit_url:null},x=void 0,y={},v=[];function b(e){const t={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Create Document from Template"}),"\n",(0,s.jsx)(o(),{method:"post",path:"/createdocument/{template_id}",context:"endpoint"}),"\n",(0,s.jsxs)(t.p,{children:["The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at ",(0,s.jsx)(t.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(t.strong,{children:"Debug UI"})})," or using the Create Template API."]}),"\n",(0,s.jsx)(t.p,{children:"You can provide default value for all widgets based on their name all widgets support except signature, stamp, initials, image."}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"hint:"})," Specify the hint for widgets. This parameter is optional and is not applicable to the following widgets: checkbox, radio button, dropdown."]}),"\n",(0,s.jsxs)(t.ol,{children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "email",\n "readonly": false,\n "default": "email@example.com",\n "hint": "Provide email",\n "hide_text_with_asterisks": false\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"2",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "name",\n "readonly": false,\n "default": "joe",\n "hint": "Provide name",\n "hide_text_with_asterisks": false\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"3",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "job title",\n "readonly": false,\n "default": "ceo",\n "hint": "Provide job title",\n "hide_text_with_asterisks": false\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"4",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "company",\n "readonly": false,\n "default": "example pvt ltd",\n "hint": "Provide company",\n "hide_text_with_asterisks": false\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"5",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "date",\n "readonly": false,\n "default": "11-05-2025",\n "min_date": "",\n "max_date": "",\n "signing_date": false,\n "hint": "Provide date"\n}\n'})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"min_date:"})," Provide the minimum restriction date. The date must be in ",(0,s.jsx)(t.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"max_date:"})," Provide the maximum restriction date. The date must be in ",(0,s.jsx)(t.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"signing_date"}),": If signing_date is set to true, the signing date is shown to the signer during signing. You may set either signing_date or default, but not both. Using both is not supported."]}),"\n"]}),"\n",(0,s.jsxs)(t.ol,{start:"6",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "textbox",\n "readonly": false,\n "default": "my text",\n "hint": "Provide text",\n "hide_text_with_asterisks": false\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"7",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "checkbox",\n "readonly": false,\n "default": ["option-2"]\n}\n'})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"default:"})," You can have one or more than one value that needs to be selected by default."]}),"\n"]}),"\n",(0,s.jsxs)(t.ol,{start:"8",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "dropdown",\n "readonly": false,\n "default": "option1"\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"9",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "radio",\n "readonly": false,\n "default": "option1"\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"10",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"number"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "number",\n "readonly": false,\n "default": 0,\n "formula": "",\n "decimalplaces": 2,\n "hint": "Provide number",\n "hide_text_with_asterisks": false\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"11",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"cells"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "cells",\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "hide_text_with_asterisks": false \n}\n'})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"cell_count:"})," Specify the number of cells that should be returned to the user."]}),"\n"]}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"response:"})," Provide the value that should replace the existing response."]}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,s.jsx)(t.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,s.jsxs)(t.ol,{children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name":"textbox",\n "response":"andrew bee"\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"2",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "date",\n "response": "04/15/2024"\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"3",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "checkbox",\n "response": ["male", "female"]\n}\n'})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"response:"})," Must be chosen from the existing values of checkbox defined in the template."]}),"\n"]}),"\n",(0,s.jsxs)(t.ol,{start:"4",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "radio button",\n "response": "male"\n}\n'})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"response:"})," Must be chosen from the existing values of radio button defined in the template."]}),"\n"]}),"\n",(0,s.jsxs)(t.ol,{start:"5",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n}\n\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"6",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "dropdown",\n "response": "female"\n}\n'})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"response:"})," Must be chosen from the existing values of dropdown defined in the template."]}),"\n"]}),"\n",(0,s.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(f.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(d(),{...n(77488)}),"\n",(0,s.jsx)(p(),{...n(67810)}),"\n",(0,s.jsx)(m(),{...n(65288)})]})}function j(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}},77488(e){e.exports=JSON.parse('{"parameters":[{"name":"template_id","in":"path","description":"objectId of Template","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"pH1bhc2hpb"}}]}')},67810(e){e.exports=JSON.parse('{"title":"Body","body":{"content":{"application/json":{"schema":{"required":["signers"],"type":"object","properties":{"title":{"type":"string","format":"string","example":"New document title","description":"An optional parameter specifying the title for the newly created document. If omitted, the template\u2019s title will be used by default.\\n"},"signers":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","example":"Accoutnant"},"email":{"type":"string","format":"mail","example":"joe@example.com"},"name":{"type":"string","example":"joe bee"},"phone":{"type":"string","example":"123123131"},"company":{"type":"string","format":"string","example":"opensign"},"job_title":{"type":"string","format":"string","example":"dev"},"signer_role":{"type":"string","format":"string","description":"Specifies the role of the recipient in the signing process. Allowed values:\\n- **signer** (default): Must have at least one signature widget.\\n- **viewer**: Receives the document to view only; must have no widgets.\\n- **approver**: Reviews and approves the document; no signature widget required.\\n","enum":["signer","viewer","approver"],"example":"signer"},"access_code":{"type":"string","format":"string","description":"when set, this numeric access code is required for the signer to access and sign the document.","example":"123456"},"widgets":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"textbox_1"},"readonly":{"type":"boolean","example":false},"default":{"type":"string","example":"my textbox"}},"title":"createdocumenttemplate_id_Signers_widgets"}}},"title":"createdocumenttemplate_id_Signers"}},"folderId":{"type":"string","example":""},"send_email":{"type":"boolean","description":"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \\"true\\". If the value of this parameter is \\"true\\" and no \'email_subject\'/\'email_body\' parameters are specified default email templates will be used.\\n\\nIf the field is omitted or provided as an empty/invalid value, the template value is used.\\n","example":true},"email_subject":{"type":"string","description":"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.","example":"{{sender_name}} has requested you to sign {{document_title}}"},"email_body":{"type":"string","description":"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.","example":"

Hi {{receiver_name}},

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

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

Sign here

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

Thanks,
Team OpenSign\u2122

"},"sendInOrder":{"type":"boolean","description":"**true** - Only the first signer receives the signature request email initially. Each subsequent signer is notified in sequence, only after the previous signer has completed their signing. This is the default behavior.\\n\\n**false** - All signers receive the signature request email simultaneously.\\n\\nIf the field is omitted or provided as an empty/invalid value, the template value is used.\\n","example":true},"send_in_order_strict":{"type":"boolean","description":"**true** - Each signer is blocked from accessing the document until all preceding signers have completed their action. Enforces strict sequential signing. Only applies when sendInOrder is also true.\\n\\n**false** - Signers can access the document regardless of whether previous signers have completed.\\n\\nIf the field is omitted or provided as an empty/invalid value, the template value is used.\\n","example":false},"allow_offline_sign":{"type":"boolean","description":"**true** - Signers can submit a copy of this document signed using an external tool for owner review.\\n\\n**false** - Signers must complete signing within OpenSign.\\n\\nIf the field is omitted or provided as an empty/invalid value, the template value is used.\\n","example":false},"timeToCompleteDays":{"type":"number","description":"time to complete days is used to calculate expiry date of your document. If this field is present in the request body, it overrides the template value, even when set to 0. If omitted, the template value is used.","format":"number","example":15},"enableOTP":{"type":"boolean","description":"**true** - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. \\n\\n**false** - this option will disable OTP verification, allowing users to sign the document directly without additional steps.\\n\\nIf the field is omitted or provided as an empty/invalid value, the template value is used.\\n","example":false},"enableTour":{"type":"boolean","description":"**true** - this option will enable a guided tour for signers, providing instructions during the signing process. \\n\\n**false** - disable the guided tour, ensuring a faster, uninterrupted signing experience.\\n\\nIf the field is omitted or provided as an empty/invalid value, the template value is used.\\n","example":false},"sender_name":{"type":"string","description":"The name of the person or organization on whose behalf the email is being sent. If this field is present in the request body, it overrides the template value, even when set to an empty string (\\"\\"). If omitted, the template value is used.\\n\\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to \\"\\".\\n","example":"opensign\u2122"},"sender_email":{"type":"string","description":"The email address of the person or organization that users can reply to. If this field is present in the request body, it overrides the template value, even when set to an empty string (\\"\\"). If omitted, the template value is used.\\n\\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to \\"\\".\\n","example":"mailer@opensignlabs.com"},"allow_modifications":{"type":"boolean","description":"**true** - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. \\n\\n**false** - Restricts signers from adding any additional elements to the document. This is the default value.\\n\\nIf the field is omitted or provided as an empty/invalid value, the template value is used.\\n","example":false},"file":{"type":"string","description":"You may provide the base64 encoded PDF file to replace the existing one","format":"base64","example":""},"file_password":{"type":"string","format":"string","example":""},"auto_reminder":{"type":"boolean","description":"Set to true to enable automatic reminders. Set to false to disable them (default behavior). If the field is omitted or provided as an empty/invalid value, the template value is used.","example":false},"remind_once_in_every":{"type":"number","description":"Number of days between reminders. This is only applicable when auto_reminder is set to true. If this field is present in the request body, it overrides the template value, even when set to 0. If omitted, the template value is used.","example":5},"merge_certificate":{"type":"boolean","description":"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\\n\\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\\n\\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\\n","example":false},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"redirect_url":{"type":"string","description":"Specifies the URL where the signer will be redirected upon completing the document signing process. If this field is present in the request body, it overrides the template value, even when set to an empty string (\\"\\"). If omitted, the template value is used.","example":""},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed.\\nIf this field is present in the request body, it overrides the template value, even when provided as an empty array ([]).\\nIf omitted or provided empty string (\\"\\") the template value is used.\\n"},"cc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"cc (carbon copy): Users added here will receive a notification email once the document is completed.\\nIf this field is present in the request body, it overrides the template value, even when provided as an empty array ([]).\\nIf omitted or provided empty string (\\"\\") the template value is used.\\n"},"prefill":{"type":"object","properties":{"widgets":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","format":"string","example":"textbox"},"response":{"type":"string","format":"string","example":"andrew bee"}}}}}}},"title":"createdocument_template_id_body"}}},"required":true}}')},65288(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Document created successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"hji2zxcv2P"},"signurl":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","format":"string","example":"mail@example.com"},"url":{"type":"string","format":"string","example":"https://url-to-sign-document.com"}},"title":"inline_response_doc_signurl"}},"message":{"type":"string","format":"string","example":"Document sent successfully!"}},"title":"inline_response_doc"}}}},"400":{"description":"If you haven\'t add widgets and signers in template or not provide signers along with their roles in body","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","format":"string","example":"Please setup template properly!"}},"title":"inline_response_400_cc"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/c195e1f1.52cdc692.js b/assets/js/c195e1f1.52cdc692.js deleted file mode 100644 index f0dbe1107..000000000 --- a/assets/js/c195e1f1.52cdc692.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[6192],{35342(e,t,n){n.r(t),n.d(t,{assets:()=>j,contentTitle:()=>x,default:()=>v,frontMatter:()=>g,metadata:()=>s,toc:()=>b});const s=JSON.parse('{"id":"API-docs/v1.1/createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","source":"@site/docs/API-docs/v1.1/createdocumentwithtemplateid.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/createdocumentwithtemplateid","permalink":"/docs/API-docs/v1.1/createdocumentwithtemplateid","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","sidebar_label":"Create Document from Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztPNtu3DiWv8LVS5KCXL500rtrZIPxdDLdwaQ7RuJsENhGNSWdKjGhSA1JVbnGMDAP8wf7tK/zaf0li3NISVS5qpzKpKdnd90I2jbFy7nx8NzI68TxmU2Oz5PnOm8qUM4ml2lSgM2NqJ3QKjlOzkpg3xngDljbi02NrpiDqpbYfHL6knEp9cKypW6Y02wGCgx+UrBgRTs3y5bsY2Mdq42ei0KoWTfHRBRMKOuAF0xPWVNLzakDpymmQsJDoZgrgU21qbBPxi18+5hpwzKhuFk+YjAHs2ROVEBwKIACgck98LwDZMzOwrIWZ2MGauxRyCVrLBS0mmU5VyyDMLrwKDcWDBPKgZnyHBh37Hw0eg5ZM2PvXo5Glw9L52p7vL/P63qsa1BWzJTkmR3nutovsGNdTB8h0I0l/HvinkXkHF+oC/VBNwSEpxawAqa8kY7NuWyIDEh0thDFDJC2HEHXRCNhmOIVDL7bpq61cQyucqgdQ8C4awykzDpe1SkTSjjBpU2ZqPgMCITRqBQFTBxcuclCuHLCrQMj7Cd7PBqx9yUoBopnEoqUUMGOAQZaAYqO6ExYVoqiAOVJaSAXtSCx8KTopk5Z1jhmoOJCWTZtpFyyubAik4DsxLm7SfVCEUcC1q9rUG/FTDGe57ohTpfCMk2yjBDwORcSAWZaySWCega8soyrgr1AvtZGWGC15Mp2FFAOsX1bQy6mS1of24gDgbphnZobXoFDiNpFuaS5hWVKO8brWoqcR5hMNW4cxD9MdczyEvJPmb5KmeGF0EgNp1XKCqPrQi8UwXU4ZqMRkkiORhfq559/vlDXF4qxiwQ5f5Ecs4uEPl8kqW83wAtEGr9NubQQ2oNYRUN+B1e8qiWg0HbDEWXf5zTI43D6TYLSLXehbgKgF+oIoUdANwPvf9sF9o8atkA7mG8nYL9BYD/qjJ0JJ7dAjF0cdtkN7Bz0FrBvT7oT7I8R9lxXNVfLzZCHDjuKihcSVs8dk67YgsPq9Dth8AQxKLjbQnj8uhvsh4d7B0/2jg6OnnTjKqEmfiLs0Dfzq3XNqNyEmnWf4pVuE8D36rHaY6NRux6qFtZ2RI1QCSWqBhWkdUbkpLmwI+oYPxWr8BDNAPXeaPThw4cPez/+uPf8+WhEhyN347BEgB2XGKzAr77SCjEZRqNj9nLK4iZUexYc6TrTQNqdC6jvug6lXqhWHdKhYVjRGOwSuo4ZHoUVX9JkIFwJZriONu3p6A8P1LWZduWYvaOzBX9vdXA4CKEgPfotihfKYqavNktY6LCbkFVLOg+3bIyVzzvsin+lfR0Oii0bO/TYBfDzi8QfXXtHF8nlUGhDNxSo1jop+RwPU+JBpQ1KGFfU4O0UV3JHpphFHmfALEjI0aLKli3TiBP/Rhs9nHFbNnvosRsvPEaH8Sa8UP+OK8Zn7OZVqddXWPLwgE6+psrAbDn76Psuyx2EJtydjeQr2qqAXFRc1pLnQPJ0tPmYHC69g1Cy8N+FOiTjJAcp7RbRxM93ooi9JmTK4Zcn6+i8Zn99PvhsKN/9cqsWn6cL+h0EuBdrW+pGFijUBlxjlPc3sDs6CsF+NGBrrewtLRxtjzCPAeIQfYUrYR2qrnZ4mO3UwFRIyd4Ha5Em9U2tpc8NMJDgXS6aH1uEsoBaD90XHTlDbDTKYKoNjEZMOK+QuYGCIcUY95iw12gtDyxv8ou0YSW3rAZTCWvxHMG5iwK7VgHiV8I6pNuKI0KQtLCjmBzerYnXKWJPHfrIVWFgwTIYHLZHOxsQ3ZTsIjl4vH/4ZP/o4OhxPOc3X6x++7nP0bgguw73LfjfV/RtLDs/hiM5L7VtnaiBpJBAWRLRsC7qV6E8pb175l3McWca7qD9Qq8NdPLgfxXo49U2YtBrGzIQyWXdjAB9Xi804j9///rN4uCP38/0ycnJyU9v35Uv3s1OTk4q/Hs8HgeswtTffvEpFVOrZfdXoVe71mZaXagkTXSNIRmh1csiOU5CWCPsZtzrbXdRJGnSebIYHbomxJLjJIrWJGkiMDpUc1cmqyEjnX2E3L2kUE4b1kjSxMCfGmGgSI7JGkysW0qc1gp0JJI0gata6gKSY38EJDYvoeLJ8XXiljX1dGgXJmnirdC4JbgjCNIPh1mZH5V1ltzcXPplwbrf62KJU+VaOVAOfw3uOEK9/9Ei6NfRmj2454m3Syk6FkDxOCKpDFLWCbAEKPpqu0L8UxQl897eLZKeqD6g0IcZrD+h2kgSDaW4BB1ZsJDLLn7VB79eTpmuhHN90MZz6Je//LcNUyzwPMnAh8MGdlpyk3bE6LHkxvAlioSDKm7fQCSj19Oop8gJxm+c4srhghRp2EpU6hBP8FFDHMbAWbwQb1v1owY8PbBzXWp1R+/Do2/w3zeH2D/4uLtyvo0R4hQfdTb5IvEpYI7jwwH75Wy5m0Dh+J0Qyq3NFg3JtJbAVTyGtvJN2tps2+cPLlOmr5Kbm7TdTCvKKtJCk7deFCct7jc7DaNFploWYFApboOM5B5UMVmVxR7l1bD5ICA4jI+HfcsWJZAzi80LrpyPqfWekiLfOey34J4PosDCondqGrhIaGP3hqXGP1Zjkm1fikkqzR7QehPbkEA82A9/Z7pYPuhHepPSwyxQlQQQqHOnPuxAa5CJEQCaCpAUAg1qB13FENQuGMfgK4Oqdst9oeZcisJjMFROPb5h9pg7iFSrJlpk1rFzyKHvGut0xQiJMIh0ZxcaZ+HkGLPvuGJC5bIJtnsftWXX162A+c17c8Our1FSwExwQ93cpH0DrjVoIDXjWwzkIOaDUV0T9AO7tmgoXNXCLCkU4huCNooBCOGSxoR5lMbO44GQrwBOtn2gARSd7GJ8/TbWnZ4m6fls6t8idpAqnOT/Dd2f1s9+EGtAebpfP3taP3sPrNQ1+P3syTMVqvDaZAFSjtlT64xWs2crJHi6H9rXs9LAXMCClAFxtZ9llbbdROMA0wfdxDtFWJabJhdc4ry10Tm0LqQ3Ra4csw5qi/td+PQTKhPCwTA+M0AOK8HCG1dqI/5Mhlm74FPOSgPT/3iwQtMHzyjhU4KBp/v8Wej9cko4UnCKqyUjxIVWFnUPJQanjSHVm0tuxDRYgSmrJXCLIWvleO58TJIo2sJxVnL1yaZPM/MMU0ddyumXv/4Ne7TnxEv12hRgPuOgGI1QfY1GbK/3sqfCWNcGQ4NU2C5Aum6/hOydXI7ZC56XqNAsdlDdND786TW4UMx/zSH1mTA+xSMCV6hRKnRj23EoOSjXElByfJ6tC8zSKSc8aO2xkEHJ50K38Q8yAAi9Eynbs6xFaitOVlSNdFyBbqxc/hYnCuaSz/R3AfvnfBlbUT4kdIuflH/GtHMYxQq+tO0y9IHLvCEIvP7wkXA99VthYKfTju+QrQ2QSRD8u5ZYqCpT3FR6DsaIIkjKEM8Us+MKDQ7VhuQPNrsCK7SJ7c8O645Wh09Q9VMa+PXZ6W4S76L0LJkPfh72+uyUzaHfmBjIR7GhPq3s8EEXlusC2FxwLz0pW5QiJ/Wz9OkMUCTi4QSLg1noIQ9F9TZghbBrIUu9aYdnUkMgrluAFcJA7uSSVKJuHAbJRHDnSC/+Q6W7tck9sc90s6Oe2sQ1zmYNAelQkltbCoxNo5IPLPMwTe61cUj0xHkhOjysvc2TlgPYOVonZaCsn4azKYV4U9YoqtIwTY30a6eGqxqMQK33m5A7Oprvto/Q1qciDu2hrMFYrRA2bWZchdMRKxgWGCIirSt913AiWJYBZdH+IdqkpRLz+LCHGIZ/9NkqJvBDaVeSkFDikOAgAWus5zvVe1CgojYwBYO8tJ3ns/YrOS9cWu2zf/Gs7YnlNCUNVtjWOee//PVvSc++jcGI2/zzjOBFYcDaOxhJgXqvQTCthrmAJXP6nnFfwDgkO5jfrRZgIRNJWU8qXXQK3O6m+04x1+FsZ8iEhEeXcLFNXqLW6IwaG5dWUa2VTZH7Xa2UrlE0usBumycRd51Rb0L6voeFosR4sqAuVMv4kOkTQnpl2nUmHLH4N9GRWHt39+Zq6wHqKJ8W6gFBoR1QsNPnf6BCPu/nrEmsYXwvsmv88FsxH944PTFQCfV51vzbvtwBf7YHY+N0xZ3IWTuVHbPQ1echnY7Pt4o9XLWmH3Wb5VfgxTpOeEgnWuUwEWpCxZV3W78/dXlSMnszcAsAFaPdypt3O/qCONJJA3KvlI+M2T+XSdxRDO3fCswMJjkGU0mxwG5ahYgSTCnbmJAXxvWDG0EGbj87whECI12+p3fSUPb7Df6DXiDzOt8WIxB+fuQtI8gDsvEKOVdURoMOMIYCuyJYX0IkVL/EqmYK3ndeau3XQ9rSOuk2nNr44UCYu9XbgtJuY3OpSV2GGMNKvelvfjAROTZoOXLElxOtJv0x8Rlh9K0CtCY3P/SWVLBHfBQgOE0o/SgdSGjv7+MPOzwjVvm7eTEkyFda8Cft4Ji9gRk3hezsJ89GVOAp47Eg+aU2SQPFlTaIHXeO5yWQPimgBkVl1A/6aH8UCg8ZMAPeocMQ1N2n1dsQOfdIvnvzColg+tgHmE7024mhYE1NPq0HOfhIHTq3nKV/civx1rlag5rkWurPSiMGut5Ek5wnmWx8Uhlz0Znk+afk8iZNsjz/0hnR+h4kDVNqOhq03bofkeU5e5hJgQLGTUZMq5ePjkPEgheoyYjfK8GLwbbw4ksKecBoEQXfxsEc+zXYvM6AYEQ99vD88pFfep3BsUYq7rD6kPu+7OfulOSvltPclk/tUpBpV7ax6xR9KRKmJG+2pCUncV6SUifUeVgrEUFCWB0dHOCPoSA+H2hkDHs0OSoHukHxL0n6+ZUP20naVnfsSpPyozj681U+PzptiwiG2nNHzt5dFLAuwbxyvQEh2aDDt6ISrvk0Ru45vYe47HWHF00b8VsoKRRMWgZOCp1PWuxvyHS0ls92FrGO3bT/h7y+Y/nEC+TjdVIUZU7UA4pT9oWFIU+Eag31TbvDMaWiXeeMtV2G9pkwDMs+aCSJ+VeTRzBGm12pd+ptYQuuqXtM/MR3UfDxwcEk74n4ZA0Rg+eFN+PO9CdQX3H7bUS3Ry5e3vnlEdSrSvYqMQneIX1PBtjG7R5JC3ljhFtSMdjVHq/Fnv9+fH6JJVYVuFJjWVmtLUGMVWHHyf5Q1e1fR7ruJsFpzbwtMaNd2G0sy1WR6avbd+h4Lfbnh2MsQFkds/bO3Zb+0OztOsQ6PhNqdte4y55ib5GrnnEDuvVarxZ/BNwNgS1xr1BjVwLH4AMyAoXlTV/P9qJleVd4tr6WrKvYOm+Lr+IKq67A6lbVVAdVWxnVFUZF1U9R8VNfzzQoZ6IKpahAKa4obAuK4nqiztkJJUODuiASuL5oJ0mGhTm+tHClFOTvq2wYFjbcZ+v/D2XrV5L1XnjWZX0PnwxynEFC4wRaW7MaJ3kGKYTVDMLGMPWGKHVYwEdIUexXYpPh+/q43ZO1IaowZH04opsv9nVx3dh3W++HBTfs812qyCHYrCWS2B4fmNiXqBuFmupYE3aXgfEYJMW86rq9B5nrqruLOxpF4tGNGo06fepFHIMTrxvDar0AM238Bd+phCu6oYzDoKJvfbkf8ApDGHJJl8dnFM4qxEw4LjtXPuc1z4QUeM77Sxp+s/Wmgh3jleu2YPCBoTvtMAeJ5kEXY8arda3+X2jzaYqFhxgsyfCeNQZSQJVc5T416E8pSkig29dfgbbOINTCw6aVM7jDKq74jPZ+Gu8lVoBEVWiZ0Rnm2q2Wjd/Bjgupja98IIToLhgR8QWWextg2IpHiIESd8I8pHdt6lP6liQFUVB414beD+C5ExiJc5o1Sur8k4+MN1KyWqOVhbpNTwcw4nBnuLL0goAvtgg86AgW4inQXv5+ZwE5/EoouvKOdfrnnVy9h8wKB/2t/8ViccsseDQc871wPzQZewO1tsJps+xHz4Qrm4xMiXiS7g8/0/ft0wqRodDPUejcrnl4QOd2vwRZ77/1sTO7f3L6kgzTR+yXv/wXewXcKFbqhZfWvDEgl/0rDkg5z3lPts6u9K8QNK5Eiuc8XFgi9d1S8H3JHQVQ0TARKmwpf+HhtMmkyPvXGPAKaXgNoa8qpUh1eIwhXE3CIg/Oaj9aCvVpzE7U0r/O0J1i2E7jBmjQyRm9SBG9mhBdmDiLVofKgpz7ByFCQBwK4WuhjG5mfrUYmIDc8KYW4nZSFKxeua2FiZ8eHLqJ5WtWqOaWAvjrLngNblENSyNBFbUWCp8SKAyfun7+dCVqS2forab25ldLjjRM07HE78SAcdfqQ90rRu5Q31IIHRe0g0dCeC2COJ23YslQWv8esfY1+WQWRMECtLbXpoUdmMq+nr4FMxd56+Fv2NH71Hk/SRMpcgjBoXBSnXx/+orNvxkfJGnkOnzG5t5/9fK7Fz+9fYHAoCL1BDscH4wPKGCmrau4ilZa+yRLdNlmQPno1sv9ey7377ncv+dy/57L/Xsu9++53L/ncv+ey/17Lvfvudy/53L/nsv9ey7377ncv+dy/57L/Xsu/0vecwn5Y9xB+7XkQkW1LD7/fr5SapSkyXH8hMtlmpSYrz8+T66vMd7wDlN02PynhpJG55dpMudGoINL+ZhQol6sr0eNo0wP34QCpkdsw2swa+Fvk+IKM+JEEp9y+gTLlfdnbrDYL2TGETTf4zsPwN4ZztPPcKveAlP7fsRJjvGTrX3jAofT12/PMM8V7rhX9FxNYvgCk1N84aH1poJ/6gTbrhPJ1ayhIp/Ez3nj7xaUw0qAT1QJEH5BrNbSY1gi4NHA/yNSawdcX/sqA8pl+/7+08YRgbBtb2TO5c3Nzf8AzDuokQ==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Document","permalink":"/docs/API-docs/v1.1/createdocument"},"next":{"title":"Get Document","permalink":"/docs/API-docs/v1.1/getdocument"}}');var i=n(74848),r=n(28453),o=n(57742),a=n.n(o),l=n(78178),d=n.n(l),p=n(19624),c=n.n(p),h=n(96226),m=n.n(h),u=(n(77675),n(19365),n(51107)),f=n(21312);const g={id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztPNtu3DiWv8LVS5KCXL500rtrZIPxdDLdwaQ7RuJsENhGNSWdKjGhSA1JVbnGMDAP8wf7tK/zaf0li3NISVS5qpzKpKdnd90I2jbFy7nx8NzI68TxmU2Oz5PnOm8qUM4ml2lSgM2NqJ3QKjlOzkpg3xngDljbi02NrpiDqpbYfHL6knEp9cKypW6Y02wGCgx+UrBgRTs3y5bsY2Mdq42ei0KoWTfHRBRMKOuAF0xPWVNLzakDpymmQsJDoZgrgU21qbBPxi18+5hpwzKhuFk+YjAHs2ROVEBwKIACgck98LwDZMzOwrIWZ2MGauxRyCVrLBS0mmU5VyyDMLrwKDcWDBPKgZnyHBh37Hw0eg5ZM2PvXo5Glw9L52p7vL/P63qsa1BWzJTkmR3nutovsGNdTB8h0I0l/HvinkXkHF+oC/VBNwSEpxawAqa8kY7NuWyIDEh0thDFDJC2HEHXRCNhmOIVDL7bpq61cQyucqgdQ8C4awykzDpe1SkTSjjBpU2ZqPgMCITRqBQFTBxcuclCuHLCrQMj7Cd7PBqx9yUoBopnEoqUUMGOAQZaAYqO6ExYVoqiAOVJaSAXtSCx8KTopk5Z1jhmoOJCWTZtpFyyubAik4DsxLm7SfVCEUcC1q9rUG/FTDGe57ohTpfCMk2yjBDwORcSAWZaySWCega8soyrgr1AvtZGWGC15Mp2FFAOsX1bQy6mS1of24gDgbphnZobXoFDiNpFuaS5hWVKO8brWoqcR5hMNW4cxD9MdczyEvJPmb5KmeGF0EgNp1XKCqPrQi8UwXU4ZqMRkkiORhfq559/vlDXF4qxiwQ5f5Ecs4uEPl8kqW83wAtEGr9NubQQ2oNYRUN+B1e8qiWg0HbDEWXf5zTI43D6TYLSLXehbgKgF+oIoUdANwPvf9sF9o8atkA7mG8nYL9BYD/qjJ0JJ7dAjF0cdtkN7Bz0FrBvT7oT7I8R9lxXNVfLzZCHDjuKihcSVs8dk67YgsPq9Dth8AQxKLjbQnj8uhvsh4d7B0/2jg6OnnTjKqEmfiLs0Dfzq3XNqNyEmnWf4pVuE8D36rHaY6NRux6qFtZ2RI1QCSWqBhWkdUbkpLmwI+oYPxWr8BDNAPXeaPThw4cPez/+uPf8+WhEhyN347BEgB2XGKzAr77SCjEZRqNj9nLK4iZUexYc6TrTQNqdC6jvug6lXqhWHdKhYVjRGOwSuo4ZHoUVX9JkIFwJZriONu3p6A8P1LWZduWYvaOzBX9vdXA4CKEgPfotihfKYqavNktY6LCbkFVLOg+3bIyVzzvsin+lfR0Oii0bO/TYBfDzi8QfXXtHF8nlUGhDNxSo1jop+RwPU+JBpQ1KGFfU4O0UV3JHpphFHmfALEjI0aLKli3TiBP/Rhs9nHFbNnvosRsvPEaH8Sa8UP+OK8Zn7OZVqddXWPLwgE6+psrAbDn76Psuyx2EJtydjeQr2qqAXFRc1pLnQPJ0tPmYHC69g1Cy8N+FOiTjJAcp7RbRxM93ooi9JmTK4Zcn6+i8Zn99PvhsKN/9cqsWn6cL+h0EuBdrW+pGFijUBlxjlPc3sDs6CsF+NGBrrewtLRxtjzCPAeIQfYUrYR2qrnZ4mO3UwFRIyd4Ha5Em9U2tpc8NMJDgXS6aH1uEsoBaD90XHTlDbDTKYKoNjEZMOK+QuYGCIcUY95iw12gtDyxv8ou0YSW3rAZTCWvxHMG5iwK7VgHiV8I6pNuKI0KQtLCjmBzerYnXKWJPHfrIVWFgwTIYHLZHOxsQ3ZTsIjl4vH/4ZP/o4OhxPOc3X6x++7nP0bgguw73LfjfV/RtLDs/hiM5L7VtnaiBpJBAWRLRsC7qV6E8pb175l3McWca7qD9Qq8NdPLgfxXo49U2YtBrGzIQyWXdjAB9Xi804j9///rN4uCP38/0ycnJyU9v35Uv3s1OTk4q/Hs8HgeswtTffvEpFVOrZfdXoVe71mZaXagkTXSNIRmh1csiOU5CWCPsZtzrbXdRJGnSebIYHbomxJLjJIrWJGkiMDpUc1cmqyEjnX2E3L2kUE4b1kjSxMCfGmGgSI7JGkysW0qc1gp0JJI0gata6gKSY38EJDYvoeLJ8XXiljX1dGgXJmnirdC4JbgjCNIPh1mZH5V1ltzcXPplwbrf62KJU+VaOVAOfw3uOEK9/9Ei6NfRmj2454m3Syk6FkDxOCKpDFLWCbAEKPpqu0L8UxQl897eLZKeqD6g0IcZrD+h2kgSDaW4BB1ZsJDLLn7VB79eTpmuhHN90MZz6Je//LcNUyzwPMnAh8MGdlpyk3bE6LHkxvAlioSDKm7fQCSj19Oop8gJxm+c4srhghRp2EpU6hBP8FFDHMbAWbwQb1v1owY8PbBzXWp1R+/Do2/w3zeH2D/4uLtyvo0R4hQfdTb5IvEpYI7jwwH75Wy5m0Dh+J0Qyq3NFg3JtJbAVTyGtvJN2tps2+cPLlOmr5Kbm7TdTCvKKtJCk7deFCct7jc7DaNFploWYFApboOM5B5UMVmVxR7l1bD5ICA4jI+HfcsWJZAzi80LrpyPqfWekiLfOey34J4PosDCondqGrhIaGP3hqXGP1Zjkm1fikkqzR7QehPbkEA82A9/Z7pYPuhHepPSwyxQlQQQqHOnPuxAa5CJEQCaCpAUAg1qB13FENQuGMfgK4Oqdst9oeZcisJjMFROPb5h9pg7iFSrJlpk1rFzyKHvGut0xQiJMIh0ZxcaZ+HkGLPvuGJC5bIJtnsftWXX162A+c17c8Our1FSwExwQ93cpH0DrjVoIDXjWwzkIOaDUV0T9AO7tmgoXNXCLCkU4huCNooBCOGSxoR5lMbO44GQrwBOtn2gARSd7GJ8/TbWnZ4m6fls6t8idpAqnOT/Dd2f1s9+EGtAebpfP3taP3sPrNQ1+P3syTMVqvDaZAFSjtlT64xWs2crJHi6H9rXs9LAXMCClAFxtZ9llbbdROMA0wfdxDtFWJabJhdc4ry10Tm0LqQ3Ra4csw5qi/td+PQTKhPCwTA+M0AOK8HCG1dqI/5Mhlm74FPOSgPT/3iwQtMHzyjhU4KBp/v8Wej9cko4UnCKqyUjxIVWFnUPJQanjSHVm0tuxDRYgSmrJXCLIWvleO58TJIo2sJxVnL1yaZPM/MMU0ddyumXv/4Ne7TnxEv12hRgPuOgGI1QfY1GbK/3sqfCWNcGQ4NU2C5Aum6/hOydXI7ZC56XqNAsdlDdND786TW4UMx/zSH1mTA+xSMCV6hRKnRj23EoOSjXElByfJ6tC8zSKSc8aO2xkEHJ50K38Q8yAAi9Eynbs6xFaitOVlSNdFyBbqxc/hYnCuaSz/R3AfvnfBlbUT4kdIuflH/GtHMYxQq+tO0y9IHLvCEIvP7wkXA99VthYKfTju+QrQ2QSRD8u5ZYqCpT3FR6DsaIIkjKEM8Us+MKDQ7VhuQPNrsCK7SJ7c8O645Wh09Q9VMa+PXZ6W4S76L0LJkPfh72+uyUzaHfmBjIR7GhPq3s8EEXlusC2FxwLz0pW5QiJ/Wz9OkMUCTi4QSLg1noIQ9F9TZghbBrIUu9aYdnUkMgrluAFcJA7uSSVKJuHAbJRHDnSC/+Q6W7tck9sc90s6Oe2sQ1zmYNAelQkltbCoxNo5IPLPMwTe61cUj0xHkhOjysvc2TlgPYOVonZaCsn4azKYV4U9YoqtIwTY30a6eGqxqMQK33m5A7Oprvto/Q1qciDu2hrMFYrRA2bWZchdMRKxgWGCIirSt913AiWJYBZdH+IdqkpRLz+LCHGIZ/9NkqJvBDaVeSkFDikOAgAWus5zvVe1CgojYwBYO8tJ3ns/YrOS9cWu2zf/Gs7YnlNCUNVtjWOee//PVvSc++jcGI2/zzjOBFYcDaOxhJgXqvQTCthrmAJXP6nnFfwDgkO5jfrRZgIRNJWU8qXXQK3O6m+04x1+FsZ8iEhEeXcLFNXqLW6IwaG5dWUa2VTZH7Xa2UrlE0usBumycRd51Rb0L6voeFosR4sqAuVMv4kOkTQnpl2nUmHLH4N9GRWHt39+Zq6wHqKJ8W6gFBoR1QsNPnf6BCPu/nrEmsYXwvsmv88FsxH944PTFQCfV51vzbvtwBf7YHY+N0xZ3IWTuVHbPQ1echnY7Pt4o9XLWmH3Wb5VfgxTpOeEgnWuUwEWpCxZV3W78/dXlSMnszcAsAFaPdypt3O/qCONJJA3KvlI+M2T+XSdxRDO3fCswMJjkGU0mxwG5ahYgSTCnbmJAXxvWDG0EGbj87whECI12+p3fSUPb7Df6DXiDzOt8WIxB+fuQtI8gDsvEKOVdURoMOMIYCuyJYX0IkVL/EqmYK3ndeau3XQ9rSOuk2nNr44UCYu9XbgtJuY3OpSV2GGMNKvelvfjAROTZoOXLElxOtJv0x8Rlh9K0CtCY3P/SWVLBHfBQgOE0o/SgdSGjv7+MPOzwjVvm7eTEkyFda8Cft4Ji9gRk3hezsJ89GVOAp47Eg+aU2SQPFlTaIHXeO5yWQPimgBkVl1A/6aH8UCg8ZMAPeocMQ1N2n1dsQOfdIvnvzColg+tgHmE7024mhYE1NPq0HOfhIHTq3nKV/civx1rlag5rkWurPSiMGut5Ek5wnmWx8Uhlz0Znk+afk8iZNsjz/0hnR+h4kDVNqOhq03bofkeU5e5hJgQLGTUZMq5ePjkPEgheoyYjfK8GLwbbw4ksKecBoEQXfxsEc+zXYvM6AYEQ99vD88pFfep3BsUYq7rD6kPu+7OfulOSvltPclk/tUpBpV7ax6xR9KRKmJG+2pCUncV6SUifUeVgrEUFCWB0dHOCPoSA+H2hkDHs0OSoHukHxL0n6+ZUP20naVnfsSpPyozj681U+PzptiwiG2nNHzt5dFLAuwbxyvQEh2aDDt6ISrvk0Ru45vYe47HWHF00b8VsoKRRMWgZOCp1PWuxvyHS0ls92FrGO3bT/h7y+Y/nEC+TjdVIUZU7UA4pT9oWFIU+Eag31TbvDMaWiXeeMtV2G9pkwDMs+aCSJ+VeTRzBGm12pd+ptYQuuqXtM/MR3UfDxwcEk74n4ZA0Rg+eFN+PO9CdQX3H7bUS3Ry5e3vnlEdSrSvYqMQneIX1PBtjG7R5JC3ljhFtSMdjVHq/Fnv9+fH6JJVYVuFJjWVmtLUGMVWHHyf5Q1e1fR7ruJsFpzbwtMaNd2G0sy1WR6avbd+h4Lfbnh2MsQFkds/bO3Zb+0OztOsQ6PhNqdte4y55ib5GrnnEDuvVarxZ/BNwNgS1xr1BjVwLH4AMyAoXlTV/P9qJleVd4tr6WrKvYOm+Lr+IKq67A6lbVVAdVWxnVFUZF1U9R8VNfzzQoZ6IKpahAKa4obAuK4nqiztkJJUODuiASuL5oJ0mGhTm+tHClFOTvq2wYFjbcZ+v/D2XrV5L1XnjWZX0PnwxynEFC4wRaW7MaJ3kGKYTVDMLGMPWGKHVYwEdIUexXYpPh+/q43ZO1IaowZH04opsv9nVx3dh3W++HBTfs812qyCHYrCWS2B4fmNiXqBuFmupYE3aXgfEYJMW86rq9B5nrqruLOxpF4tGNGo06fepFHIMTrxvDar0AM238Bd+phCu6oYzDoKJvfbkf8ApDGHJJl8dnFM4qxEw4LjtXPuc1z4QUeM77Sxp+s/Wmgh3jleu2YPCBoTvtMAeJ5kEXY8arda3+X2jzaYqFhxgsyfCeNQZSQJVc5T416E8pSkig29dfgbbOINTCw6aVM7jDKq74jPZ+Gu8lVoBEVWiZ0Rnm2q2Wjd/Bjgupja98IIToLhgR8QWWextg2IpHiIESd8I8pHdt6lP6liQFUVB414beD+C5ExiJc5o1Sur8k4+MN1KyWqOVhbpNTwcw4nBnuLL0goAvtgg86AgW4inQXv5+ZwE5/EoouvKOdfrnnVy9h8wKB/2t/8ViccsseDQc871wPzQZewO1tsJps+xHz4Qrm4xMiXiS7g8/0/ft0wqRodDPUejcrnl4QOd2vwRZ77/1sTO7f3L6kgzTR+yXv/wXewXcKFbqhZfWvDEgl/0rDkg5z3lPts6u9K8QNK5Eiuc8XFgi9d1S8H3JHQVQ0TARKmwpf+HhtMmkyPvXGPAKaXgNoa8qpUh1eIwhXE3CIg/Oaj9aCvVpzE7U0r/O0J1i2E7jBmjQyRm9SBG9mhBdmDiLVofKgpz7ByFCQBwK4WuhjG5mfrUYmIDc8KYW4nZSFKxeua2FiZ8eHLqJ5WtWqOaWAvjrLngNblENSyNBFbUWCp8SKAyfun7+dCVqS2forab25ldLjjRM07HE78SAcdfqQ90rRu5Q31IIHRe0g0dCeC2COJ23YslQWv8esfY1+WQWRMECtLbXpoUdmMq+nr4FMxd56+Fv2NH71Hk/SRMpcgjBoXBSnXx/+orNvxkfJGnkOnzG5t5/9fK7Fz+9fYHAoCL1BDscH4wPKGCmrau4ilZa+yRLdNlmQPno1sv9ey7377ncv+dy/57L/Xsu9++53L/ncv+ey/17Lvfvudy/53L/nsv9ey7377ncv+dy/57L/Xsu/0vecwn5Y9xB+7XkQkW1LD7/fr5SapSkyXH8hMtlmpSYrz8+T66vMd7wDlN02PynhpJG55dpMudGoINL+ZhQol6sr0eNo0wP34QCpkdsw2swa+Fvk+IKM+JEEp9y+gTLlfdnbrDYL2TGETTf4zsPwN4ZztPPcKveAlP7fsRJjvGTrX3jAofT12/PMM8V7rhX9FxNYvgCk1N84aH1poJ/6gTbrhPJ1ayhIp/Ez3nj7xaUw0qAT1QJEH5BrNbSY1gi4NHA/yNSawdcX/sqA8pl+/7+08YRgbBtb2TO5c3Nzf8AzDuokQ==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},x=void 0,j={},b=[];function y(e){const t={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Create Document from Template"}),"\n",(0,i.jsx)(a(),{method:"post",path:"/createdocument/{template_id}",context:"endpoint"}),"\n",(0,i.jsxs)(t.p,{children:["The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at ",(0,i.jsx)(t.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(t.strong,{children:"Debug UI"})})," or using the Create Template API."]}),"\n",(0,i.jsx)(t.p,{children:"You can provide default value for all widgets based on their name all widgets support except signature, stamp, initials, image."}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"hint:"})," Specify the hint for widgets. This parameter is optional and is not applicable to the following widgets: checkbox, radio button, dropdown."]}),"\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"email"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "email",\n "readonly": false,\n "default": "email@example.com",\n "hint": "Provide email",\n "hide_text_with_asterisks": false\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"2",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"name"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "name",\n "readonly": false,\n "default": "joe",\n "hint": "Provide name",\n "hide_text_with_asterisks": false\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"3",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"job Title"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "job title",\n "readonly": false,\n "default": "ceo",\n "hint": "Provide job title",\n "hide_text_with_asterisks": false\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"4",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"company"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "company",\n "readonly": false,\n "default": "example pvt ltd",\n "hint": "Provide company",\n "hide_text_with_asterisks": false\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"5",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "date",\n "readonly": false,\n "default": "11-05-2025",\n "min_date": "",\n "max_date": "",\n "signing_date": false,\n "hint": "Provide date"\n}\n'})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"min_date:"})," Provide the minimum restriction date. The date must be in ",(0,i.jsx)(t.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"max_date:"})," Provide the maximum restriction date. The date must be in ",(0,i.jsx)(t.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"signing_date"}),": If signing_date is set to true, the signing date is shown to the signer during signing. You may set either signing_date or default, but not both. Using both is not supported."]}),"\n"]}),"\n",(0,i.jsxs)(t.ol,{start:"6",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "textbox",\n "readonly": false,\n "default": "my text",\n "hint": "Provide text",\n "hide_text_with_asterisks": false\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"7",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "checkbox",\n "readonly": false,\n "default": ["option-2"]\n}\n'})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"default:"})," You can have one or more than one value that needs to be selected by default."]}),"\n"]}),"\n",(0,i.jsxs)(t.ol,{start:"8",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "dropdown",\n "readonly": false,\n "default": "option1"\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"9",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "radio",\n "readonly": false,\n "default": "option1"\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"10",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"number"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "number",\n "readonly": false,\n "default": 0,\n "formula": "",\n "decimalplaces": 2,\n "hint": "Provide number",\n "hide_text_with_asterisks": false\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"11",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"cells"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "cells",\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "hide_text_with_asterisks": false \n}\n'})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"cell_count:"})," Specify the number of cells that should be returned to the user."]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"response:"})," Provide the value that should replace the existing response."]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,i.jsx)(t.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name":"textbox",\n "response":"andrew bee"\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"2",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "date",\n "response": "04/15/2024"\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"3",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "checkbox",\n "response": ["male", "female"]\n}\n'})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"response:"})," Must be chosen from the existing values of checkbox defined in the template."]}),"\n"]}),"\n",(0,i.jsxs)(t.ol,{start:"4",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "radio button",\n "response": "male"\n}\n'})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"response:"})," Must be chosen from the existing values of radio button defined in the template."]}),"\n"]}),"\n",(0,i.jsxs)(t.ol,{start:"5",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n}\n\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"6",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "dropdown",\n "response": "female"\n}\n'})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"response:"})," Must be chosen from the existing values of dropdown defined in the template."]}),"\n"]}),"\n",(0,i.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,i.jsx)(f.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,i.jsx)(d(),{...n(77488)}),"\n",(0,i.jsx)(c(),{...n(67810)}),"\n",(0,i.jsx)(m(),{...n(65288)})]})}function v(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(y,{...e})}):y(e)}},77488(e){e.exports=JSON.parse('{"parameters":[{"name":"template_id","in":"path","description":"objectId of Template","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"pH1bhc2hpb"}}]}')},67810(e){e.exports=JSON.parse('{"title":"Body","body":{"content":{"application/json":{"schema":{"required":["signers"],"type":"object","properties":{"title":{"type":"string","format":"string","example":"New document title","description":"An optional parameter specifying the title for the newly created document. If omitted, the template\u2019s title will be used by default.\\n"},"signers":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","example":"Accoutnant"},"email":{"type":"string","format":"mail","example":"joe@example.com"},"name":{"type":"string","example":"joe bee"},"phone":{"type":"string","example":"123123131"},"company":{"type":"string","format":"string","example":"opensign"},"job_title":{"type":"string","format":"string","example":"dev"},"widgets":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"textbox_1"},"readonly":{"type":"boolean","example":false},"default":{"type":"string","example":"my textbox"}},"title":"createdocumenttemplate_id_Signers_widgets"}}},"title":"createdocumenttemplate_id_Signers"}},"folderId":{"type":"string","example":""},"send_email":{"type":"boolean","description":"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \\"true\\". If the value of this parameter is \\"true\\" and no \'email_subject\'/\'email_body\' parameters are specified default email templates will be used.\\n\\nIf the field is omitted or provided as an empty/invalid value, the template value is used.\\n","example":true},"email_subject":{"type":"string","description":"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.","example":"{{sender_name}} has requested you to sign {{document_title}}"},"email_body":{"type":"string","description":"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.","example":"

Hi {{receiver_name}},

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

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

Sign here

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

Thanks,
Team OpenSign\u2122

"},"sendInOrder":{"type":"boolean","description":"**true** - Only the first signer receives the signature request email initially. Each subsequent signer is notified in sequence, only after the previous signer has completed their signing. This is the default behavior.\\n\\n**false** - All signers receive the signature request email simultaneously.\\n\\nIf the field is omitted or provided as an empty/invalid value, the template value is used.\\n","example":true},"timeToCompleteDays":{"type":"number","description":"time to complete days is used to calculate expiry date of your document. If this field is present in the request body, it overrides the template value, even when set to 0. If omitted, the template value is used.","format":"number","example":15},"enableOTP":{"type":"boolean","description":"**true** - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. \\n\\n**false** - this option will disable OTP verification, allowing users to sign the document directly without additional steps.\\n\\nIf the field is omitted or provided as an empty/invalid value, the template value is used.\\n","example":false},"enableTour":{"type":"boolean","description":"**true** - this option will enable a guided tour for signers, providing instructions during the signing process. \\n\\n**false** - disable the guided tour, ensuring a faster, uninterrupted signing experience.\\n\\nIf the field is omitted or provided as an empty/invalid value, the template value is used.\\n","example":false},"sender_name":{"type":"string","description":"The name of the person or organization on whose behalf the email is being sent. If this field is present in the request body, it overrides the template value, even when set to an empty string (\\"\\"). If omitted, the template value is used.\\n\\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to \\"\\".\\n","example":"opensign\u2122"},"sender_email":{"type":"string","description":"The email address of the person or organization that users can reply to. If this field is present in the request body, it overrides the template value, even when set to an empty string (\\"\\"). If omitted, the template value is used.\\n\\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to \\"\\".\\n","example":"mailer@opensignlabs.com"},"allow_modifications":{"type":"boolean","description":"**true** - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. \\n\\n**false** - Restricts signers from adding any additional elements to the document. This is the default value.\\n\\nIf the field is omitted or provided as an empty/invalid value, the template value is used.\\n","example":false},"file":{"type":"string","description":"You may provide the base64 encoded PDF file to replace the existing one","format":"base64","example":""},"auto_reminder":{"type":"boolean","description":"Set to true to enable automatic reminders. Set to false to disable them (default behavior). If the field is omitted or provided as an empty/invalid value, the template value is used.","example":false},"remind_once_in_every":{"type":"number","description":"Number of days between reminders. This is only applicable when auto_reminder is set to true. If this field is present in the request body, it overrides the template value, even when set to 0. If omitted, the template value is used.","example":5},"merge_certificate":{"type":"boolean","description":"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\\n\\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\\n\\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\\n","example":false},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"redirect_url":{"type":"string","description":"Specifies the URL where the signer will be redirected upon completing the document signing process. If this field is present in the request body, it overrides the template value, even when set to an empty string (\\"\\"). If omitted, the template value is used.","example":""},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed.\\nIf this field is present in the request body, it overrides the template value, even when provided as an empty array ([]).\\nIf omitted or provided empty string (\\"\\") the template value is used.\\n"},"prefill":{"type":"object","properties":{"widgets":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","format":"string","example":"textbox"},"response":{"type":"string","format":"string","example":"andrew bee"}}}}}}},"title":"createdocument_template_id_body"}}},"required":true}}')},65288(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Document created successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"hji2zxcv2P"},"signurl":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","format":"string","example":"mail@example.com"},"url":{"type":"string","format":"string","example":"https://url-to-sign-document.com"}},"title":"inline_response_doc_signurl"}},"message":{"type":"string","format":"string","example":"Document sent successfully!"}},"title":"inline_response_doc"}}}},"400":{"description":"If you haven\'t add widgets and signers in template or not provide signers along with their roles in body","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","format":"string","example":"Please setup template properly!"}},"title":"inline_response_400_cc"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/c4fbe420.83c3cb4c.js b/assets/js/c4fbe420.83c3cb4c.js deleted file mode 100644 index de46f4b7b..000000000 --- a/assets/js/c4fbe420.83c3cb4c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[3795],{74646(e,n,t){t.r(n),t.d(n,{assets:()=>b,contentTitle:()=>f,default:()=>w,frontMatter:()=>g,metadata:()=>i,toc:()=>y});const i=JSON.parse('{"id":"API-docs/v1.1/drafttemplate","title":"Draft Template","description":"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.","source":"@site/docs/API-docs/v1.1/drafttemplate.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/drafttemplate","permalink":"/docs/API-docs/v1.1/drafttemplate","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"drafttemplate","title":"Draft Template","description":"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.","sidebar_label":"Draft Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztPdlyGzmSv4Kt2AjbnCJF0pIPbezGqG21Wx7rWFtuty1pNWAVSMKqAsoAShStYMQ8zB/s077Op/WXbGQCqIOXDsse9S77oS0WrkQiM5HITCQuA0MHOtg8Cg5ZmiXUMB2chEHMdKR4ZrgUwWZwOGTEF5OXivYNFwOydbBDmKC9hGmSa6Y0MZJEikGlKNdGpvwrlBLjew6JZuoc2lJNeknOMsWF0aQvFRkwwRTFjmMZ5SmDghE3Q5IpFrM+Fywm2qg8MrliukXeZ1IQnUcR07qfJ3ZkLgWRfUKLMUNihgxBVczkSmhCSS74l5yRRkP2PrPI7MSNBnkYM80HghoWA3C++SmPH4VkNOTRkERUkB6DqcYwUwcwq4Dbo1AmBY6pMxbxPofKrrMW2YpjDjDSJBmHhJJGI1dJo0G4JpmS5zxmsR9N9vuAUoqoJVwYpvo0YogrBr2IAQ7jOydUxKRPI55wU0cjibk2ivdyGLl1LI7FIc82yfsskTQmY5krcvDy57K6kQS+HTUaL1kvH5D3O43GycOhMZneXFujWdaSGROArYT2dCuS6VoMFbO4j7hiikGviC9GNU/GhMYxGfF4wIzGBREkktmYRFKqmAtLGhkdMCLytMeUDnE2qVSMcEEoUYzG46aRzVwz8vrd/h6gIaWmRQ6SXIfFcDFXLDLJ2HYP6PGzemBX58k60BAXg5Ck9AywxA35kvPoDKatmcCldSSDuGo0PgC8BXa4djQeE2KGXJMR6w2lPCPsHIpHPEmIUXwwYKrROBZ//etfj8XlsSDkOMAax8EmOQ5cF8dBaIvMOGO25OX+i/e723uHp4cfD7aLck+pU3V2XhY1+jyZ7uH92zdFsaDpdPHe1m45gJDGlR8kjGpGFDvnbITrAEtt5+qxUDSryAnbuiiBRkxp+HoEXwi5tP/UoXm382pv+20VFluDpZQntSrbu1s7b2p1sqEU9W4Oftnfq/eTq0ovO3uvLFJs+QT+OXHwuhXZcgt0uLO7/e5wa/cAKk/cOgI1vMuzTCpY/g+WoDdhmY/FTyyRI0IVQ+qJZJpKQTKqaMoMysYhNVis2JecKxZb4UaTxHPG5rFokkYDcLPZaJD3VkrxmAkDckQh61uSwwYtWx9IB+rviJhHwEpWLIwzBpKwVhVYDKq+c6LJVq0wHsguK36Ao0bUSoMsAcEDVRUDqWb4Oat3fBGSMXT8kgEd2W6HUvGvUhiaIBGdM2V4RJMq0wOAKCoNVSiyMsmF8V/dCOSjY27gfWRpJ5UAtBiQm3KBJZqRc5rkTDuoRiEZAlRvWaaYRgnt+gXEi5gMGR8MF45H48+5NrWOSa693PVQuLH8qiJ6GaKtTxPNCO/XcJnSM1YZjcjM7gct8tOYxKxP88SEhIO8MipnLbInDaFZlvAI91KgAbtR5Yo1cZUd+bTq5HNg9xPYQWIOewlIJyjELlwbDx3Qpd2AYHood82QCiLF1EJHMpFqloTwcx2PJJLCMGFaZOuc8gSBt5PVhIsoyWNGegmNzkLUBEKiYO+DVRmzJJGj0PIHVsEdGXGO+CGaJUCFUgD8QrrhuS733BY5BEYp+A8KPapxEK6rWHUyvy9hZECBZ0mCcihExIXks+wRw03CQmDwjIpxSGKrZLAL05MXIYmGLDrDvxSNuSS93Bgp7MRiJbNYjoTDZV8Ko/nXORzpS26O0W5I1kPyJCTPQtJph6TTDUlnPSSdJyHpPAtJtx2Sbjck3fWQdJ9YsLrPHK5pgeAqAJ2uxbL5Y2F3yGN2Cg1PYW6nVBumuD4DcU1wR7eqaxw6LerCFIob7Fxxbccf8jhmgvSVTIliEc84ShMrDYquQ4CHKJiU0KSfJ8mYnHPNKzgoOpUjgWodfOWK7GdMvINtlkaRzGGNEcMWqYjOcslFMgZQDxlNNc58G5TDTHHNQFQLXWBAmJK2rDoE36oC4DorKeoSaPFqLlqdysrADvqGa5S5sPXpYjcd1XbTTos0GoWcm1akSm2pqFLoHbCbQVnH/b6AH4+7T93PMfx80n3mfo6wamfd/RzCz65v6pgLvjnd5TgABDo9yQpYUgEBKk0A/FJh6OJEDE2zJZOA4h81Ab9RwUfYYUJfUOpkVXgWzNnWcPMtZ/sYZssFN5wmevGEfY17NOcpkOZPu6w0M/N1mDmKs8XTdjrtvZlzFR5UgWEbtUW47VaK/IaAUHSXoGi6z0ViGFqhgjSDyY2W02IWI9JO4d7gsQLOXaFxqsubY/EJYBF21EPYURejsth07xE+p2G6K6TO6/fmmH3aQj0YFZTFeHUV7hFW6xDdFU5ne705Rp8BRkHTW4xOKL1HuKyAY60gqDbbsvZ6s7PR7La76zV8grnKVkjTZhw3x+Pxt61FysWphaNid8ECejG/AKxooD0WK1GUgA7DxaBoVi+dXXVbb2ohQed0mAC1059Ard4LFkpUn2fNC3j6L2u5Mw/+7Y/ku3AQ77HCSOoU54qN1dsDq6doI2M6fqBtV75pcfiC+tPqsQUTiwAOtI1GQ8kjBzzU8UeuHhh8WoCDJi7qWhyvVRYVPsZxM02bUx/hZxNpoPIxTVtx3JqqOUMo9mNK4jgks5/nfo9jkqbpgs/2e+3zWprOzqKVpg42hz1PezPrnHLB0xwOSWBmtWf0GE3fhx69qVtLLkij8fHjx4/N3d3my5eNhl9DN4Sj4ootw45AL+5ohCrRNxqbZKdPqp/QnmAtOSgFirMh2tZ9haEcCX8ksiZPEudgYPZVrT0ppWPsjHEzZKo+jlQlycIBEs5bPWmGLfIez5fwtz+HFeclPEs9B8HpDseLZaer8KPEZykl6wMvFa2LRVNNts6oRV4wZfP1JsUGeUIVuwADoJ42Ut92D7zZ/jYlFj0tl8YWNC064y7ztg7ycN8dwx8VFsapuUBvW87TRhQbsAuSUWOYEtjZOU14bD1iTes1uqBpBtaVtf86Po7/9K9raNsF86mxRoWYDzg4aNb+62ir+elkTo08y5iKwD2QMBhJh4SZqEWOhizJSh/RaDRqjR7raChlYh1En7Viffv/U9n7fIrgZi2qs0fzZmqJoWJLBWKZNqUic1YwRjXxLedYU3FpkGs6bdTgnLFiiQrnatwjvWMKJCi0huljdLMEKUXlFoiXlX9LkDnHwUm53aP9lMVXtD25BnsCNyS0x5LZopuzVkLHMncc7f0F9ak6iq7gzalChUkYp9OueIBSejFVeFx6f6b41CKkyqZ+t/fs6VeAJFwXG0kNndXWzmuAvh/BrN+4x4hvQHoFlX4zFxSAXY8NvIkU1+6KIaAewYqFx8aPdsUItYWZ2cmdruBdT/2iV48yv5FX8QUtwSVeqglLRnC6wuIRnE9/wQDHooOGSG/AXHI+cTXukayYAmk5G99GitR25ttsqbdiQD+tKgPO2V6hqt1YC+bTi7mvRfatVd03Aot7FLEMNK1vZs0C5GvvUGg1rhrRF1NetdY9or45YH1nCnT17nr3uRWRVmf/ByLUGtjXJlZr9E/pYIn9BovvEXlW4Zlv4nA1ZoxVHbT02x1liYUay5dPuNOuTXijPuEn7VucuGrDfvuBq70EPzNDwdk6T+jMdhCziKc0wSAShLv7DTx6m8OXAwx44IVMs9xUmQ7NOihYvJbgQyOsc/dPIWmGpBGStZA8DMmjFnnLMJgiKgIvnNLAlQ2v4BAsloOnNMpVMiY9BRMPCWsNWuTy8ktOheFmPJmQBrm8hAjCyaQFXHgm5MjGXhyB19gQiKQrD1WxjPScyDsZ6TU4fa3tsVHzpXMvrznQHpGHckokLD2KOhT82BOZhapCJDDKXqGy2VMpBvtwnSV0TGgfPNU2IASb2bihFqB4k3TJv/8H6XRb7XZI2vZviO60E+w+Qh5GH1PEkmVOSiy+ioPbVQ4uf84TWRvta7FwddhbcjB0cYphBDjulQpbydz30HRSTmbaWFvR6gFndv/UQ5knMeyeNt6XFQGdhU7faBwo1oc4zTKCj/hPnqchIoolLHVRYy52D44zGK3AhZHANz6co9Hosb6ESAUIKEXDIC1j/OzYduuuRYFg0KFUZEi1tbMgpgFiiJg1Q5ZOxUx48Mq4CS487EDKnbuzCHaf14n7yUaNuDfq+9NC4l5EwUsMhdBEZ1Lowh/IyqIK1akigHbu0WKaknynsNwYMlNG/qAQQ8JJ+BmryhoutNfSHJTTkXAvhlLqsoYLRnNyV2/Wg9ykgji3R60iNORb3V6dp49rSsSzH+j2qq9Se32ts7G21O815SK5+WGRkOssKVrVr7WkWLNc05VT6FucQt/OEY/v0jDbedqtnSceL9uc74lhtspRV5hk78Lwequz7TwLaJUPr2n7/GE2yG8ny/XvYY2ZEtxPO/8Ea8y3kuiM0eXOiJLclcVlHmVew+Sy1M7yzZRbBfa7U+/G3Zhnps46z2va4PNulVo3Nr6NWqeNMxWSOw74rz/tvx21//JqILe2trb23r0fbr8fbG1tpfC71WrNNdnNIwMcBvRndzHMbfGoLiwYpdVqobueGrqJzdcyMfg32z5c3Kbl4vG+kx9h40f7Eb5dbhRVf8yeNc9p8P0kw7fybBAGMsPLsFLsxMFmEMOVW3/RMwhx1Zg2P8l4HGxeBu5eCPzp4vSh5dpnDZd3LwMdDVlK4S+/2nDdF+4LBqG/pheEAUZGwt1foMZg0105DEKIrcjAHM409IHtNi99LXubMgidph9sBpYbgjBw8QbFJ8JEJCF4K4v7wcQPuKyr4kvZlcY/iluv0A9cObtlN9h0MnXd+VY9VXuYlGgtO6NK0XEwfbPa3zXz8SsuhMgb7ZKx3024AWtacQEKqwVhwA1Lq6MsWDQlb47piEmYCQZ037QtLgtNbzwmtMNbnbdp6EJRb9P0s+yd3oocobGzycxZ62uuji2dHbhOKltw34bFXq9ulhdPQnsfo3UVpfr6iGU6qI5pbWkzYx4uuh5auZXmLG40yxhVLbyleevr45hBgCZRjjfaC2lcm1kBajGzziQMLq6ezAWJZNPfPSUPE9Y3NqCJRFIJph5VA1TvzeS66+uTMBhfPb3xH3J6T2HxRlfP7gNe2i0vNP8zYH38bBIGw6th/aW4VvxPBHb9yaTcY93t9iKrRU/G41MvtyZXVfSbGdSDFAk7Yl/FTFUQ0ZMyYVTMYAJCau3J6AFolw9CG0aI9we50n4js1kTFIsY3Cz3obQoq4jTdezFIn8DC/xJ2/ABtTOd9zTUEr4/bTvsMZ+JAVKH2Brcpt5Auzyj0RByPrjgxtKtlEHyA5lrDx6Y52F3SRhY3K2vrwjvrR7fKtiphA/bubeqqwNfYHPFO6j7hwfXwCWeLZs2AYC7F4qztH2Q/cMDuGPP+079g+jhAhMetbRWhYA6Rs459fdwC9k+tqFXzJpUpc8AUXouWu52e5PMAhRzPReiEG582iujRbqYmY7LFB6wRDI34AlxOVOINizTNTwiFAUiD2V+Haq8ApOUDHK8ZGCAZf2Fewx2Le/Ic2Fz0eAxw0V8VwPEMyUhMU2JJ48VqFTpPyRMaNuckj56xEJIUAOYVzkcKoou2UXGFAfP81wUKGZRd5qrufpaHQf1C+fv375xiVsqceyeh3zHLCZ5hlSDnFAkQvArNz31GUUJuIOp00WK4azqgf50ZzPJmNKQ3EcRqQZU8K8u2Q9oJHDI6rEhTWxVJyrAGo+B+ECvNWC8rP397/+owLVQ050FzI5A4xh8o1dAiCdJS/Cg6SuWgQSUdYigP6b+PL0JAHTINKepjAtG0ten8QMM3taFXHSexcKzqfNoCAeLQt7qsLjl6tRKjUfT4oK8zGC+7IJrU7n87S/kzMqHt+6eRgkDqiHA1UDzYlxl8NLjKqe6w2vqvJ4GotgGZ3iB5kaeKpZycb19qmq+M7IQBLmRKTU8Ir4r3aon97BeJc/XaRlnANR4zqV6NBc8w1N2KF+4HeUlHeurlQpog5qAa0ViOkaM+HxUpYrALjKuxsVtKnRYeUxeoUlvoCCByZ5KEbFTLk7ZOVPXUD8rARsAWI+ZEWOiijm/hHazLRMKjCAbQ23Fpq7e1HAIEKZMDdhpBCco5Al2jSVuNKCrRoM0LSBO4utcOWOPS9uDog2kXNk7gOMSbBQ3z0p1oJo7q0V+kSNAWEgym0YJLAy2f8AnQchdzonqCBEVeO0H7EyQjAE6LpyLkE+iHMIGBCAp4Wx2rIEgsrYm6AXSzMA44bI5eeleXKmjkCrGj+6TYMDkwOJDaCKR281wXo4MBGoHs4QMcXfE9QNzth3Hp+7BrBe//+1/IN2ZD6PSLZjCwlKMu6CJlvb+U7VXz2yeHa3pbIbbhDS8Pz6V4rSUcnMJpt5yKQHNieGoK1rC7RE4uNe3gNKBOgDRdo+Ff3Rd1E2v7+LBACF3NOCeNGyTvGUDquKk2NPsMhpMl0arhGSHWkQNmDhkAdlRY2g0ZJhYJGYZJFyTgjyALdhuwA/KZCSwnmCqYOIULafXMbG4TXtSWc2jAAysaDaNg9Cal4OTSRj0oui2PcJ+/mf3GzfqED91a99m8ij2oog87CUc0ENVT9o0eI82napOY+BDVMOmtPbaolrkozip6V+8ckhpkeI/h0QbIzTPGLXcIuk3+DIHIkt7EJOM8U544kFNUJZGybp167uZx5bZulyszsrS9QcyBXXa7f/Llq7H7T+OpWu9/QeydD0DYJ1P7Wppsuj0OVd2eB/h8gafJbP+h0Sq5TVhB5qEhUdzHoJLduhO7H+lcc4L8SsMdtaiVzr7nLHJTwbR0G234Z8pIehzyfoMp2V63WT8L0F4fU/j8jXw2UyXI+unYfcXnYk0GgLOFlg1yurLSazqQV1j49fD3quI7/PXO++/7nT2+I7eEW83ohc7T3bOst9+ffH6eYuNX3ei7q/j37q/mo8fEr3zWfLol9fDT+JX3XuxkX/87ZP6+NuO+vjhraEfNrZ6Yih6r37m0Xjjc6/b5m9evG5/+tAZ9V793P706/PsE3b+c/vT2Vk7Svde9MQW1Mk+/vaffP/z9uPdr9tfdw+3L3a/Js9bdO/L5xcX0fPds+0nzU87qrm73/vL5y8me7sRP977jT95xnbZB3HYfhPVqIGLhAt26pf6FOd9CottKWl93rK/kymzevsIU9gqCQqfO8AYNSZ0ACcQQJ26QypgSl3FLzeDbBki1tvt006BhI1ZJOwIvF6MqaIP5RkTP3am1eGNHR5AvUiTUmgF3FbC8qA22ep3O0nNolxxMw42jy6DiybNeNOWbx6dTE7gDG2GEoILMqkRYmqGwWawNh1rABm70ZN9dGl5sGA0TUUM4XczzEYzvnbeaXWCSTjdZi5zLqnP8uZNm2hDB1wMrmp3UqLoHSyjXakaokqFNeN/YaCxunWo1goDDuQzZBRMTYB5oI63ZYTGtl9jHzsxLxyiXMvpAAcf31ALWZjeh+cEIVRiEI58AAD69AuXflBOKCjc7kFQcaTDj4prHH4W2vxRSc2FX9kr2x3UUrvr66jOPe2g3vP4GaoU608mJxb5FUcShh5VvSHuBF4167tPdTN3EEyZlWu23WnT7kIz6wIrqxtyyprovs4z4nU2FpnPNuZarVxX8y0UrrB6/J1/lHUn2eufSiuHwTnr6fWf+mpC/B+s5uM2ruZ6G1fzWbumerk1KHsoFSjUkgolyU2gVIRA2zkB7uGiL5H1HM0VmVFBMiLrzijMLIlkWiQmbTR8k9///o+iVaNRHJRpkQd/P1ckkyOm4P0AzJ+fsAtM14pvG6RYptG8hrfbaAq2EQjKEYYNbPJ/uJ0Grinn/IhoRnuQgx9cK3hLCM2vld1DtyD/LN44HMv8gbL3785ZAjtGYXOu5u8fSXXWT+QI0uKTHtxLBAsNE0MqIuvgsHIMDfVwQC/zwWqjAGpuYZPCKBoZklJBB2hpD0kVWTFLOAh7omQP/H9aJrn1cBnKE6msoRknhKFxiMTtiwyKUOsHyaHYELjr3Lm5dGjdjFZEucz+PfDoZgALBxOfkSQXiYQk/OAZzhO40WestxYOF1UYoblRVGg4ETjbtluDAmHOA8W0M6a91wxW+A0XZzbBbJMcFXT1gfU0N6yevWZaQjyqt3nFzS95DxKLS82NVOOy9YCbYd7DzabaSfHD9vTKPx5R2Uquf9XznTXK6bWtgx3UVR6R3//23+QNo0qQoRxZao1yxZJx+U4FPqmAK2/RVqga6OOkObzLYJBIxcC73XXxBgI1aJndYyMwgVuWsuGOB3kv4VHxQIiGXFov7DMgxcsf9Wwb9m4cOJ4pyWzrhIuzFtkSY/veRWFahO/YrjYNdBsveHejfG3jsDI6SzVLzpmuWNrhFQ105yuZD+xoVWDc5OpXBWFuW3FMsqnrguAIKsGxpjH0o1NrI4OXKubcMKxd46tnVWYixlutepOgSlb2H06Zg9G1PvPJXz0sH0Kx3VQeYwFMuhkXX60NfUoNqstbtM3DgLr2DArNuCOnI0+WpJ4W6uZkbY/VwtAIdXC/jdOMz3WVwlsAer//Dh6ZifyZcAFHr2HltSAMEh4xd8Z3+9fWq4M35Pxxqx2EFeXyGsy99mbnxfbeu20ABgSpRVin1W610RQptUmpqIyEj+kUhDq9tVVCe1dv8Kze4Fm9wbN6g2f1Bs/qDZ7VGzyrN3hWb/Cs3uC599hdvcGzeoNn0aXV1Rs8qzd4pu99r97gWb3Bs3qD517gc/UGz+oNnhsnI1u9wVMUrN7gWb3Bc7x6g2f1Bs/x6g2e+5FIdvUGz+oNnjvR4VZv8Kze4Fm9wbN6g2f1Bs8f6GmT1Rs8P4ICV2/wrN7guXWa19UbPPOYavUGz+oNntUbPNfOS716g+c7cO/qDZ7VGzyrN3gWi6DVGzyrN3juh1No9QbP6g2e1Rs8qzd4Vm/wrN7guVPjzOoNntUbPP/P3uCppMNYyxLKRSUNlc2WczT1Ms9JGAwhm87mUXB5CRT5XiWTCXz+kmMWkKOTMDinikMQPybiCX3iGMi/ccYg58oLe8OkeQjDh3ad8c7zVP4hyHxjW2zh1JfWrSb8Odh/dwjJQ9zrQamMMTUZHUG+DjqySVUqST3w22WQUDHIMSFIYPuc2ETLw3qinDNMlOP+qGQVgYQyJYT1DDp2GvB/mNTcBpeXNgnPZFLUt0ULWzjE+tqwfCeTyeR/AavMflI=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Signing Links","permalink":"/docs/API-docs/v1.1/getsigninglinks"},"next":{"title":"Create Template","permalink":"/docs/API-docs/v1.1/createtemplate"}}');var s=t(74848),r=t(28453),o=t(57742),l=t.n(o),a=t(78178),d=t.n(a),c=t(19624),h=t.n(c),p=t(96226),u=t.n(p),m=(t(77675),t(19365),t(51107)),x=t(21312);const g={id:"drafttemplate",title:"Draft Template",description:"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.",sidebar_label:"Draft Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztPdlyGzmSv4Kt2AjbnCJF0pIPbezGqG21Wx7rWFtuty1pNWAVSMKqAsoAShStYMQ8zB/s077Op/WXbGQCqIOXDsse9S77oS0WrkQiM5HITCQuA0MHOtg8Cg5ZmiXUMB2chEHMdKR4ZrgUwWZwOGTEF5OXivYNFwOydbBDmKC9hGmSa6Y0MZJEikGlKNdGpvwrlBLjew6JZuoc2lJNeknOMsWF0aQvFRkwwRTFjmMZ5SmDghE3Q5IpFrM+Fywm2qg8MrliukXeZ1IQnUcR07qfJ3ZkLgWRfUKLMUNihgxBVczkSmhCSS74l5yRRkP2PrPI7MSNBnkYM80HghoWA3C++SmPH4VkNOTRkERUkB6DqcYwUwcwq4Dbo1AmBY6pMxbxPofKrrMW2YpjDjDSJBmHhJJGI1dJo0G4JpmS5zxmsR9N9vuAUoqoJVwYpvo0YogrBr2IAQ7jOydUxKRPI55wU0cjibk2ivdyGLl1LI7FIc82yfsskTQmY5krcvDy57K6kQS+HTUaL1kvH5D3O43GycOhMZneXFujWdaSGROArYT2dCuS6VoMFbO4j7hiikGviC9GNU/GhMYxGfF4wIzGBREkktmYRFKqmAtLGhkdMCLytMeUDnE2qVSMcEEoUYzG46aRzVwz8vrd/h6gIaWmRQ6SXIfFcDFXLDLJ2HYP6PGzemBX58k60BAXg5Ck9AywxA35kvPoDKatmcCldSSDuGo0PgC8BXa4djQeE2KGXJMR6w2lPCPsHIpHPEmIUXwwYKrROBZ//etfj8XlsSDkOMAax8EmOQ5cF8dBaIvMOGO25OX+i/e723uHp4cfD7aLck+pU3V2XhY1+jyZ7uH92zdFsaDpdPHe1m45gJDGlR8kjGpGFDvnbITrAEtt5+qxUDSryAnbuiiBRkxp+HoEXwi5tP/UoXm382pv+20VFluDpZQntSrbu1s7b2p1sqEU9W4Oftnfq/eTq0ovO3uvLFJs+QT+OXHwuhXZcgt0uLO7/e5wa/cAKk/cOgI1vMuzTCpY/g+WoDdhmY/FTyyRI0IVQ+qJZJpKQTKqaMoMysYhNVis2JecKxZb4UaTxHPG5rFokkYDcLPZaJD3VkrxmAkDckQh61uSwwYtWx9IB+rviJhHwEpWLIwzBpKwVhVYDKq+c6LJVq0wHsguK36Ao0bUSoMsAcEDVRUDqWb4Oat3fBGSMXT8kgEd2W6HUvGvUhiaIBGdM2V4RJMq0wOAKCoNVSiyMsmF8V/dCOSjY27gfWRpJ5UAtBiQm3KBJZqRc5rkTDuoRiEZAlRvWaaYRgnt+gXEi5gMGR8MF45H48+5NrWOSa693PVQuLH8qiJ6GaKtTxPNCO/XcJnSM1YZjcjM7gct8tOYxKxP88SEhIO8MipnLbInDaFZlvAI91KgAbtR5Yo1cZUd+bTq5HNg9xPYQWIOewlIJyjELlwbDx3Qpd2AYHood82QCiLF1EJHMpFqloTwcx2PJJLCMGFaZOuc8gSBt5PVhIsoyWNGegmNzkLUBEKiYO+DVRmzJJGj0PIHVsEdGXGO+CGaJUCFUgD8QrrhuS733BY5BEYp+A8KPapxEK6rWHUyvy9hZECBZ0mCcihExIXks+wRw03CQmDwjIpxSGKrZLAL05MXIYmGLDrDvxSNuSS93Bgp7MRiJbNYjoTDZV8Ko/nXORzpS26O0W5I1kPyJCTPQtJph6TTDUlnPSSdJyHpPAtJtx2Sbjck3fWQdJ9YsLrPHK5pgeAqAJ2uxbL5Y2F3yGN2Cg1PYW6nVBumuD4DcU1wR7eqaxw6LerCFIob7Fxxbccf8jhmgvSVTIliEc84ShMrDYquQ4CHKJiU0KSfJ8mYnHPNKzgoOpUjgWodfOWK7GdMvINtlkaRzGGNEcMWqYjOcslFMgZQDxlNNc58G5TDTHHNQFQLXWBAmJK2rDoE36oC4DorKeoSaPFqLlqdysrADvqGa5S5sPXpYjcd1XbTTos0GoWcm1akSm2pqFLoHbCbQVnH/b6AH4+7T93PMfx80n3mfo6wamfd/RzCz65v6pgLvjnd5TgABDo9yQpYUgEBKk0A/FJh6OJEDE2zJZOA4h81Ab9RwUfYYUJfUOpkVXgWzNnWcPMtZ/sYZssFN5wmevGEfY17NOcpkOZPu6w0M/N1mDmKs8XTdjrtvZlzFR5UgWEbtUW47VaK/IaAUHSXoGi6z0ViGFqhgjSDyY2W02IWI9JO4d7gsQLOXaFxqsubY/EJYBF21EPYURejsth07xE+p2G6K6TO6/fmmH3aQj0YFZTFeHUV7hFW6xDdFU5ne705Rp8BRkHTW4xOKL1HuKyAY60gqDbbsvZ6s7PR7La76zV8grnKVkjTZhw3x+Pxt61FysWphaNid8ECejG/AKxooD0WK1GUgA7DxaBoVi+dXXVbb2ohQed0mAC1059Ard4LFkpUn2fNC3j6L2u5Mw/+7Y/ku3AQ77HCSOoU54qN1dsDq6doI2M6fqBtV75pcfiC+tPqsQUTiwAOtI1GQ8kjBzzU8UeuHhh8WoCDJi7qWhyvVRYVPsZxM02bUx/hZxNpoPIxTVtx3JqqOUMo9mNK4jgks5/nfo9jkqbpgs/2e+3zWprOzqKVpg42hz1PezPrnHLB0xwOSWBmtWf0GE3fhx69qVtLLkij8fHjx4/N3d3my5eNhl9DN4Sj4ootw45AL+5ohCrRNxqbZKdPqp/QnmAtOSgFirMh2tZ9haEcCX8ksiZPEudgYPZVrT0ppWPsjHEzZKo+jlQlycIBEs5bPWmGLfIez5fwtz+HFeclPEs9B8HpDseLZaer8KPEZykl6wMvFa2LRVNNts6oRV4wZfP1JsUGeUIVuwADoJ42Ut92D7zZ/jYlFj0tl8YWNC064y7ztg7ycN8dwx8VFsapuUBvW87TRhQbsAuSUWOYEtjZOU14bD1iTes1uqBpBtaVtf86Po7/9K9raNsF86mxRoWYDzg4aNb+62ir+elkTo08y5iKwD2QMBhJh4SZqEWOhizJSh/RaDRqjR7raChlYh1En7Viffv/U9n7fIrgZi2qs0fzZmqJoWJLBWKZNqUic1YwRjXxLedYU3FpkGs6bdTgnLFiiQrnatwjvWMKJCi0huljdLMEKUXlFoiXlX9LkDnHwUm53aP9lMVXtD25BnsCNyS0x5LZopuzVkLHMncc7f0F9ak6iq7gzalChUkYp9OueIBSejFVeFx6f6b41CKkyqZ+t/fs6VeAJFwXG0kNndXWzmuAvh/BrN+4x4hvQHoFlX4zFxSAXY8NvIkU1+6KIaAewYqFx8aPdsUItYWZ2cmdruBdT/2iV48yv5FX8QUtwSVeqglLRnC6wuIRnE9/wQDHooOGSG/AXHI+cTXukayYAmk5G99GitR25ttsqbdiQD+tKgPO2V6hqt1YC+bTi7mvRfatVd03Aot7FLEMNK1vZs0C5GvvUGg1rhrRF1NetdY9or45YH1nCnT17nr3uRWRVmf/ByLUGtjXJlZr9E/pYIn9BovvEXlW4Zlv4nA1ZoxVHbT02x1liYUay5dPuNOuTXijPuEn7VucuGrDfvuBq70EPzNDwdk6T+jMdhCziKc0wSAShLv7DTx6m8OXAwx44IVMs9xUmQ7NOihYvJbgQyOsc/dPIWmGpBGStZA8DMmjFnnLMJgiKgIvnNLAlQ2v4BAsloOnNMpVMiY9BRMPCWsNWuTy8ktOheFmPJmQBrm8hAjCyaQFXHgm5MjGXhyB19gQiKQrD1WxjPScyDsZ6TU4fa3tsVHzpXMvrznQHpGHckokLD2KOhT82BOZhapCJDDKXqGy2VMpBvtwnSV0TGgfPNU2IASb2bihFqB4k3TJv/8H6XRb7XZI2vZviO60E+w+Qh5GH1PEkmVOSiy+ioPbVQ4uf84TWRvta7FwddhbcjB0cYphBDjulQpbydz30HRSTmbaWFvR6gFndv/UQ5knMeyeNt6XFQGdhU7faBwo1oc4zTKCj/hPnqchIoolLHVRYy52D44zGK3AhZHANz6co9Hosb6ESAUIKEXDIC1j/OzYduuuRYFg0KFUZEi1tbMgpgFiiJg1Q5ZOxUx48Mq4CS487EDKnbuzCHaf14n7yUaNuDfq+9NC4l5EwUsMhdBEZ1Lowh/IyqIK1akigHbu0WKaknynsNwYMlNG/qAQQ8JJ+BmryhoutNfSHJTTkXAvhlLqsoYLRnNyV2/Wg9ykgji3R60iNORb3V6dp49rSsSzH+j2qq9Se32ts7G21O815SK5+WGRkOssKVrVr7WkWLNc05VT6FucQt/OEY/v0jDbedqtnSceL9uc74lhtspRV5hk78Lwequz7TwLaJUPr2n7/GE2yG8ny/XvYY2ZEtxPO/8Ea8y3kuiM0eXOiJLclcVlHmVew+Sy1M7yzZRbBfa7U+/G3Zhnps46z2va4PNulVo3Nr6NWqeNMxWSOw74rz/tvx21//JqILe2trb23r0fbr8fbG1tpfC71WrNNdnNIwMcBvRndzHMbfGoLiwYpdVqobueGrqJzdcyMfg32z5c3Kbl4vG+kx9h40f7Eb5dbhRVf8yeNc9p8P0kw7fybBAGMsPLsFLsxMFmEMOVW3/RMwhx1Zg2P8l4HGxeBu5eCPzp4vSh5dpnDZd3LwMdDVlK4S+/2nDdF+4LBqG/pheEAUZGwt1foMZg0105DEKIrcjAHM409IHtNi99LXubMgidph9sBpYbgjBw8QbFJ8JEJCF4K4v7wcQPuKyr4kvZlcY/iluv0A9cObtlN9h0MnXd+VY9VXuYlGgtO6NK0XEwfbPa3zXz8SsuhMgb7ZKx3024AWtacQEKqwVhwA1Lq6MsWDQlb47piEmYCQZ037QtLgtNbzwmtMNbnbdp6EJRb9P0s+yd3oocobGzycxZ62uuji2dHbhOKltw34bFXq9ulhdPQnsfo3UVpfr6iGU6qI5pbWkzYx4uuh5auZXmLG40yxhVLbyleevr45hBgCZRjjfaC2lcm1kBajGzziQMLq6ezAWJZNPfPSUPE9Y3NqCJRFIJph5VA1TvzeS66+uTMBhfPb3xH3J6T2HxRlfP7gNe2i0vNP8zYH38bBIGw6th/aW4VvxPBHb9yaTcY93t9iKrRU/G41MvtyZXVfSbGdSDFAk7Yl/FTFUQ0ZMyYVTMYAJCau3J6AFolw9CG0aI9we50n4js1kTFIsY3Cz3obQoq4jTdezFIn8DC/xJ2/ABtTOd9zTUEr4/bTvsMZ+JAVKH2Brcpt5Auzyj0RByPrjgxtKtlEHyA5lrDx6Y52F3SRhY3K2vrwjvrR7fKtiphA/bubeqqwNfYHPFO6j7hwfXwCWeLZs2AYC7F4qztH2Q/cMDuGPP+079g+jhAhMetbRWhYA6Rs459fdwC9k+tqFXzJpUpc8AUXouWu52e5PMAhRzPReiEG582iujRbqYmY7LFB6wRDI34AlxOVOINizTNTwiFAUiD2V+Haq8ApOUDHK8ZGCAZf2Fewx2Le/Ic2Fz0eAxw0V8VwPEMyUhMU2JJ48VqFTpPyRMaNuckj56xEJIUAOYVzkcKoou2UXGFAfP81wUKGZRd5qrufpaHQf1C+fv375xiVsqceyeh3zHLCZ5hlSDnFAkQvArNz31GUUJuIOp00WK4azqgf50ZzPJmNKQ3EcRqQZU8K8u2Q9oJHDI6rEhTWxVJyrAGo+B+ECvNWC8rP397/+owLVQ050FzI5A4xh8o1dAiCdJS/Cg6SuWgQSUdYigP6b+PL0JAHTINKepjAtG0ten8QMM3taFXHSexcKzqfNoCAeLQt7qsLjl6tRKjUfT4oK8zGC+7IJrU7n87S/kzMqHt+6eRgkDqiHA1UDzYlxl8NLjKqe6w2vqvJ4GotgGZ3iB5kaeKpZycb19qmq+M7IQBLmRKTU8Ir4r3aon97BeJc/XaRlnANR4zqV6NBc8w1N2KF+4HeUlHeurlQpog5qAa0ViOkaM+HxUpYrALjKuxsVtKnRYeUxeoUlvoCCByZ5KEbFTLk7ZOVPXUD8rARsAWI+ZEWOiijm/hHazLRMKjCAbQ23Fpq7e1HAIEKZMDdhpBCco5Al2jSVuNKCrRoM0LSBO4utcOWOPS9uDog2kXNk7gOMSbBQ3z0p1oJo7q0V+kSNAWEgym0YJLAy2f8AnQchdzonqCBEVeO0H7EyQjAE6LpyLkE+iHMIGBCAp4Wx2rIEgsrYm6AXSzMA44bI5eeleXKmjkCrGj+6TYMDkwOJDaCKR281wXo4MBGoHs4QMcXfE9QNzth3Hp+7BrBe//+1/IN2ZD6PSLZjCwlKMu6CJlvb+U7VXz2yeHa3pbIbbhDS8Pz6V4rSUcnMJpt5yKQHNieGoK1rC7RE4uNe3gNKBOgDRdo+Ff3Rd1E2v7+LBACF3NOCeNGyTvGUDquKk2NPsMhpMl0arhGSHWkQNmDhkAdlRY2g0ZJhYJGYZJFyTgjyALdhuwA/KZCSwnmCqYOIULafXMbG4TXtSWc2jAAysaDaNg9Cal4OTSRj0oui2PcJ+/mf3GzfqED91a99m8ij2oog87CUc0ENVT9o0eI82napOY+BDVMOmtPbaolrkozip6V+8ckhpkeI/h0QbIzTPGLXcIuk3+DIHIkt7EJOM8U544kFNUJZGybp167uZx5bZulyszsrS9QcyBXXa7f/Llq7H7T+OpWu9/QeydD0DYJ1P7Wppsuj0OVd2eB/h8gafJbP+h0Sq5TVhB5qEhUdzHoJLduhO7H+lcc4L8SsMdtaiVzr7nLHJTwbR0G234Z8pIehzyfoMp2V63WT8L0F4fU/j8jXw2UyXI+unYfcXnYk0GgLOFlg1yurLSazqQV1j49fD3quI7/PXO++/7nT2+I7eEW83ohc7T3bOst9+ffH6eYuNX3ei7q/j37q/mo8fEr3zWfLol9fDT+JX3XuxkX/87ZP6+NuO+vjhraEfNrZ6Yih6r37m0Xjjc6/b5m9evG5/+tAZ9V793P706/PsE3b+c/vT2Vk7Svde9MQW1Mk+/vaffP/z9uPdr9tfdw+3L3a/Js9bdO/L5xcX0fPds+0nzU87qrm73/vL5y8me7sRP977jT95xnbZB3HYfhPVqIGLhAt26pf6FOd9CottKWl93rK/kymzevsIU9gqCQqfO8AYNSZ0ACcQQJ26QypgSl3FLzeDbBki1tvt006BhI1ZJOwIvF6MqaIP5RkTP3am1eGNHR5AvUiTUmgF3FbC8qA22ep3O0nNolxxMw42jy6DiybNeNOWbx6dTE7gDG2GEoILMqkRYmqGwWawNh1rABm70ZN9dGl5sGA0TUUM4XczzEYzvnbeaXWCSTjdZi5zLqnP8uZNm2hDB1wMrmp3UqLoHSyjXakaokqFNeN/YaCxunWo1goDDuQzZBRMTYB5oI63ZYTGtl9jHzsxLxyiXMvpAAcf31ALWZjeh+cEIVRiEI58AAD69AuXflBOKCjc7kFQcaTDj4prHH4W2vxRSc2FX9kr2x3UUrvr66jOPe2g3vP4GaoU608mJxb5FUcShh5VvSHuBF4167tPdTN3EEyZlWu23WnT7kIz6wIrqxtyyprovs4z4nU2FpnPNuZarVxX8y0UrrB6/J1/lHUn2eufSiuHwTnr6fWf+mpC/B+s5uM2ruZ6G1fzWbumerk1KHsoFSjUkgolyU2gVIRA2zkB7uGiL5H1HM0VmVFBMiLrzijMLIlkWiQmbTR8k9///o+iVaNRHJRpkQd/P1ckkyOm4P0AzJ+fsAtM14pvG6RYptG8hrfbaAq2EQjKEYYNbPJ/uJ0Grinn/IhoRnuQgx9cK3hLCM2vld1DtyD/LN44HMv8gbL3785ZAjtGYXOu5u8fSXXWT+QI0uKTHtxLBAsNE0MqIuvgsHIMDfVwQC/zwWqjAGpuYZPCKBoZklJBB2hpD0kVWTFLOAh7omQP/H9aJrn1cBnKE6msoRknhKFxiMTtiwyKUOsHyaHYELjr3Lm5dGjdjFZEucz+PfDoZgALBxOfkSQXiYQk/OAZzhO40WestxYOF1UYoblRVGg4ETjbtluDAmHOA8W0M6a91wxW+A0XZzbBbJMcFXT1gfU0N6yevWZaQjyqt3nFzS95DxKLS82NVOOy9YCbYd7DzabaSfHD9vTKPx5R2Uquf9XznTXK6bWtgx3UVR6R3//23+QNo0qQoRxZao1yxZJx+U4FPqmAK2/RVqga6OOkObzLYJBIxcC73XXxBgI1aJndYyMwgVuWsuGOB3kv4VHxQIiGXFov7DMgxcsf9Wwb9m4cOJ4pyWzrhIuzFtkSY/veRWFahO/YrjYNdBsveHejfG3jsDI6SzVLzpmuWNrhFQ105yuZD+xoVWDc5OpXBWFuW3FMsqnrguAIKsGxpjH0o1NrI4OXKubcMKxd46tnVWYixlutepOgSlb2H06Zg9G1PvPJXz0sH0Kx3VQeYwFMuhkXX60NfUoNqstbtM3DgLr2DArNuCOnI0+WpJ4W6uZkbY/VwtAIdXC/jdOMz3WVwlsAer//Dh6ZifyZcAFHr2HltSAMEh4xd8Z3+9fWq4M35Pxxqx2EFeXyGsy99mbnxfbeu20ABgSpRVin1W610RQptUmpqIyEj+kUhDq9tVVCe1dv8Kze4Fm9wbN6g2f1Bs/qDZ7VGzyrN3hWb/Cs3uC599hdvcGzeoNn0aXV1Rs8qzd4pu99r97gWb3Bs3qD517gc/UGz+oNnhsnI1u9wVMUrN7gWb3Bc7x6g2f1Bs/x6g2e+5FIdvUGz+oNnjvR4VZv8Kze4Fm9wbN6g2f1Bs8f6GmT1Rs8P4ICV2/wrN7guXWa19UbPPOYavUGz+oNntUbPNfOS716g+c7cO/qDZ7VGzyrN3gWi6DVGzyrN3juh1No9QbP6g2e1Rs8qzd4Vm/wrN7guVPjzOoNntUbPP/P3uCppMNYyxLKRSUNlc2WczT1Ms9JGAwhm87mUXB5CRT5XiWTCXz+kmMWkKOTMDinikMQPybiCX3iGMi/ccYg58oLe8OkeQjDh3ad8c7zVP4hyHxjW2zh1JfWrSb8Odh/dwjJQ9zrQamMMTUZHUG+DjqySVUqST3w22WQUDHIMSFIYPuc2ETLw3qinDNMlOP+qGQVgYQyJYT1DDp2GvB/mNTcBpeXNgnPZFLUt0ULWzjE+tqwfCeTyeR/AavMflI=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},f=void 0,b={},y=[];function j(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Draft Template"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/drafttemplate",context:"endpoint"}),"\n",(0,s.jsxs)(n.p,{children:["The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique ",(0,s.jsx)(n.strong,{children:"objectId"})," (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a ",(0,s.jsx)(n.strong,{children:"url"})," is provided, which offers a user interface for editing the template and facilitating document distribution."]}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"When document is created this webhook event will trigger"})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE",\n "url": "SIGNING_URL"\n }\n ],\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Unique identifier for this widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Specify the hint for widgets. This parameter is optional and is not applicable to the following widgets: checkbox, radio button, dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "hint": "Provide signature"\n }\n\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp",\n "hint": "Provide stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials",\n "hint": "Provide initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide email",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide name",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide job title",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide company",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12,\n "min_date": "",\n "max_date": "",\n "readonly": false,\n "signing_date": false,\n "hint": "Provide date"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"min_date:"})," Provide the minimum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"max_date:"})," Provide the maximum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"signing_date"}),": If signing_date is set to true, the signing date is shown to the signer during signing. You may set either signing_date or default, but not both. Using both is not supported."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image",\n "hint": "Provide image"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"14",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Provide number",\n "formula": "",\n "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,s.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"decimalplaces:"})," Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"15",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"cells"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "cells",\n "page": 1,\n "x": 100,\n "y": 100,\n "w": 114,\n "h": 50,\n "options": {\n "name": "cells",\n "required": true,\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"cell_count:"})," Specify the number of cells that should be returned to the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,s.jsx)(n.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "required": true,\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "response": "04/15/2024",\n "format": "mm/dd/yyyy",\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "required": true,\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 528,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "values": ["male", "female", "other"],\n "response": "female",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(x.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(h(),{...t(82145)}),"\n",(0,s.jsx)(u(),{...t(66631)})]})}function w(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(j,{...e})}):j(e)}},82145(e){e.exports=JSON.parse('{"title":"Body","body":{"content":{"application/json":{"schema":{"required":["file","signers","title"],"type":"object","properties":{"file":{"type":"string","format":"base64","example":"base64 encoded pdf"},"title":{"type":"string","format":"string","example":"sample template"},"note":{"type":"string","format":"string","example":"sample note"},"description":{"type":"string","format":"string","example":"sample description"},"signers":{"type":"array","description":"You can provide signer optionally if you it as default signer","items":{"type":"object","properties":{"role":{"type":"string","format":"string","example":"ceo"},"email":{"type":"string","format":"string","example":""},"name":{"type":"string","format":"string","example":""},"phone":{"type":"string","format":"string","example":""},"company":{"type":"string","format":"string","example":""},"job_title":{"type":"string","format":"string","example":""},"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Allowed values - signature, stamp.","format":"string","example":"signature"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":244},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":71},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":38},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":46}},"title":"createtemplate_body_widgets"}}},"title":"createtemplate_body_signers"}},"sendInOrder":{"type":"boolean","description":"If set to \'true\', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to \'true\'.","example":true},"enableOTP":{"type":"boolean","description":"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.","example":false},"enableTour":{"type":"boolean","description":"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.","example":false},"redirect_url":{"type":"string","description":"Specifies the URL where the signer will be redirected upon completing the document signing process.","example":""},"sender_name":{"type":"string","description":"The name of the person or organization on whose behalf the email is being sent.","example":"opensign\u2122"},"sender_email":{"type":"string","description":"The email address of the person or organization that users can reply to.","example":"mailer@opensignlabs.com"},"allow_modifications":{"type":"boolean","description":"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.","example":false},"auto_reminder":{"type":"boolean","description":"Set to true to enable automatic reminders. Set to false to disable them (default behavior).","example":false},"timeToCompleteDays":{"type":"number","description":"time to complete days is used to calculate expiry date of your document","format":"number","example":15},"remind_once_in_every":{"type":"number","description":"Number of days between reminders. This is only applicable when auto_reminder is set to true.","example":5},"merge_certificate":{"type":"boolean","description":"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\\n\\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\\n\\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\\n","example":false},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed. \\n"},"prefill":{"type":"object","description":"You can provide widgets which can embed before sending to signer","properties":{"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","format":"string","example":"textbox"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":100},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":30},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":40},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":80},"options":{"type":"object","properties":{"name":{"type":"string","example":"textbox"},"response":{"type":"string","example":"joe"},"color":{"type":"string","example":"red"},"fontsize":{"type":"number","example":12}}}}}}},"title":"prefill"}},"title":"createtemplate_body"}}},"required":true}}')},66631(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Template created successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","example":"Bh2Hspnmch"},"url":{"type":"string","example":"https://app.opensignlabs.com/drafttemplate/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2VtYWlsIjoicHJhZnVsbC5uYXZrYXIrYWRtaW5AbnhnbGFicy5jb20iLCJ0ZW1wbGF0ZV9pZCI6IkF0Zkk0cmNCbnAiLCJpYXQiOjE3MzEzMTExMzl9.aNqjCxc9MkE6-ZIr-MObKjqtpR5d3NXi68eMeWnT0Lc"}},"title":"inline_response_draft_200"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/c4fbe420.b6bd7dcf.js b/assets/js/c4fbe420.b6bd7dcf.js new file mode 100644 index 000000000..4d57a8d24 --- /dev/null +++ b/assets/js/c4fbe420.b6bd7dcf.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[3795],{74646(e,n,t){t.r(n),t.d(n,{assets:()=>y,contentTitle:()=>g,default:()=>w,frontMatter:()=>f,metadata:()=>i,toc:()=>j});const i=JSON.parse('{"id":"API-docs/v1.1/drafttemplate","title":"Draft Template","description":"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.","source":"@site/docs/API-docs/v1.1/drafttemplate.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/drafttemplate","permalink":"/docs/API-docs/v1.1/drafttemplate","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"drafttemplate","title":"Draft Template","description":"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.","sidebar_label":"Draft Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztPdt2HDdyv4L05sTibM9wZkTKMp1slqZomV6JZETKskwqJKYbMwOxG2gD3RyOaZ6zD3vyATl5yev+RN7zKf6SnCpc+jIXUpSslTfjc3bFadwKhUKhUFWoug5yOtLB1klwzNIsoTnTwZswiJmOFM9yLkWwFRyPGXHF5Imiw5yLEdk+3CNM0EHCNCk0U5rkkkSKQaWo0LlM+U9QSnLXc0g0U5fQlmoySAqWKS5yTYZSkRETTFHsOJZRkTIomPB8TDLFYjbkgsVE56qI8kIx3SEvMymILqKIaT0sEjMyl4LIIaF+zJDkY4agKpYXSmhCSSH4jwUjrZYcvGVRvhe3WuRBzDQfCZqzGIBzzc94vBaSyZhHYxJRQQYMphrDTC3ArALugEKZFDimzljEhxwq2846ZDuOOcBIk2QaEkparUIlrRbhmmRKXvKYxW40ORwCSimilnCRMzWkEUNcMehFjHAY1zmhIiZDGvGE53U0kpjrXPFBASN3TsWpOObZFnmZJZLGZCoLRQ6ffF1WzyWBbyet1hM2KEbk5V6r9ebBOM8zvbW+TrOsIzMmAFsJHehOJNP1GCpm8RBxxRSDXhFfjGqeTAmNYzLh8YjlGhdEkEhmUxJJqWIuDGlkdMSIKNIBUzrE2aRSMcIFoUQxGk/buWwXmpFvjw72AQ0pzTvkMCl06IeLuWJRnkxN94AeN6vPzOo82gAa4mIUkpReAJZ4Tn4seHQB09ZM4NJakkFctVqvAF6PHa4tjceE5GOuyYQNxlJeEHYJxROeJCRXfDRiqtU6Fefn56fi+lQQchpgjdNgi5wGtovTIDRF+TRjpuTJwc7L57v7x2fHrw93fbmj1EadvSe+xpAnzR5evnjmiwVNm8X728/LAYTMbflhwqhmRLFLzia4DrDUZq4OC75ZhU+Y1r4EGjGl4esJfCHk2vxTh+Zo7+n+7osqLKYGSylPalV2n2/vPavVycZS1Ls5/OZgv95PoSq97O0/NUgx5TfwzxsLr12RbbtAx3vPd4+Ot58fQuUbu45ADUdFlkkFy//KEPQWLPOp+IolckKoYkg9kUxTKUhGFU1ZjrxxTHMsVuzHgisWG+ZGk8TtjK1T0SatFuBmq9UiLw2X4jETOfARhVvfkBw26Jj6QDpQf0/EPIKtZNjCNGPACWtVYYtB1SPLmkzVysYD3mXYD+yoCTXcIEuA8UBVxYCr5fyS1Tu+CskUOn7CgI5Mt2Op+E9S5DRBIrpkKucRTaqbHgBEVplThSwrk1zk7qsdgby2mxv2Pm5py5UAtBiQm3KBJZqRS5oUTFuoJiEZA1QvWKaYRg5t+wXEi5iMGR+NF45H47eFzmsdk0I7vuugsGO5VUX0MkTbkCaaET6s4TKlF6wyGpGZOQ865KspidmQFkkeEg78KlcF65B9mROaZQmP8CwFGjAHVaFYG1fZkk+nTj6H5jyBEyTmcJYAd4JC7MK2cdABXZoDCKaHfDcfU0GkaCx0JBOpZkkIP9fxSCIpcibyDtm+pDxB4M1kNeEiSoqYkUFCo4sQJYGQKDj7YFWmLEnkJDT7A6vgiYw4R/wQzRKgQikAfiHt8FyXZ26HHMNG8fsPCh2qcRCuq1i1PH8oYWRAgduSBPlQiIgLyVs5IDnPExbCBs+omIYkNkIGu8oH8iok0ZhFF/iXojGXZFDkuRRmYrGSWSwnwuJyKEWu+U9zdqQreXeM9kOyEZJHIXkckl43JL1+SHobIek9CknvcUj63ZD0+yHpb4Sk/8iA1X9scU09gqsA9PoGy/lvC7tjHrMzaHgGczujOmeK6wtg1wRPdCO6xqGVoq5yL7jByRXXTvwxj2MmyFDJlCgW8YwjNzHcwHcdAjxEwaSEJsMiSabkkmtewYHvVE4EinXwlStykDFxBMcsjSJZwBojhg1SEZ3lkotkCqAeM5pqnPkuCIeZ4poBqxbaY0DkJW0ZcQi+VRnAXVZS1DnQ4tVctDqVlYET9BnXyHPh6NP+NJ3UTtNeh7Rans81BalSWvJVvNwBpxmU9ezvK/jxsP+5/TmFn4/6j+3PCVbtbdifY/jZd03t5oJvVnY5DQCBVk4yDJZUQIBKNwB+KTD0cSI5TbMlk4DijzUBd1DBRzhhQldQymRVeBbM2dSw8y1n+xBmywXPOU304gm7Gp/QnBsgzZ92WWlm5hswc2Rni6dtZdpPZs5VeFAEhmPUFOGxWylyBwJC0V+Comafi9gwtEIBaQaTmx0rxSxGpJnCJ4PHCjgfCo2NLt8di48Ai3CiHsOJuhiV/tD9hPDZhOlDIXVev++O2c87KAejgLIYr7bCJ4TVOkQfCqezvb47Rh8DRkHSW4xOKP2EcFkBx2hBUGw2Zd2Ndm+z3e/2N2r4BHWVqZCm7ThuT6fT91uLlIszA0dF74IF9Gp+AWjRQHr0K+FLQIbhYuSb1UtnV93UaywkyJwWEyB2uhuokXtBQ4ni86x6AW//ZS1758G/3ZX8OVzEB8wrSa3gXNGxOn1g9Rady5hOP9OmK9fUX76gflM8NmBiEcCButFoLHlkgYc67so1AIVPB3DQxkVdj+P1yqLCxzhup2m78RF+tpEGKh/TtBPHnUbNGUIxH1MSxyGZ/Tz3exyTNE0XfDbfa5/X03R2Fp00tbBZ7Dnam1nnlAueFnBJAjWruaPHqPo+duhN7VpyQVqt169fv24/f95+8qTVcmtoh7BUXNFlmBHo1QcaoUr0rdYW2RuS6ifUJxhNDnIBfzdE3bqrMJYT4a5ERuVJ4gIUzK6q0SeldIqdMZ6PmaqPI1VJsnCBhPvWQObjDnmJ90v4293D/H0J71JfAOO0l+PFvNNW+Fjss+SS9YGXstbFrKnGW2fEIseYsvlyk2KjIqGKXYECUDeV1Pc9A9/tfGuwRUfLpbIFVYtWucucroM8OLDX8DWvYWzMBXrbtpY2otiIXZGM5jlTAju7pAmPjUWsbaxGVzTNQLuy/u+np/Hv/3EddbugPs2NUiHmIw4GmvV/P9lu//BmTo0iy5iKwDyQMBhJh4TlUYecjFmSlTaiyWTSmTzU0VjKxBiI3mrFhub/z+Tg7RmCm3WoztbmzdQQQ0WXCsTSVKXi5qxgjGriWs7RpuLS4K7pdVGCs8qKJSKcrfEJyR0NkKDQKKZP0cwSpBSFWyBeVv4tgeecBm/K4x71pyy+pe2bO2xP2A0JHbBktujdt1ZCp7KwO9rZC+pTtRRdwZsVhbxKGKfTrViAUnrVKDwtrT+NfWoQUt2m7rR329OtAEm49gdJDZ3V1tZqgLYfwYzdeMCIa0AGnkrfexd4wO62DZyKFNfuliGgHsGK3mLjRrtlhNrCzJzkVlZwpqeh79WhzB3kVXxBSzCJl2LCkhGsrLB4BGvTXzDAqeihItIpMJfcT2yNT4hXNEBavo3vw0VqJ/N9jtR7bUA3reoGnHO8QlVzsPrNpxfvvg45MFp11wg07lHEMpC03ntrepDvfEKh1riqRF9MedVanxD1zQHrV6ZAW+9Dnz73ItLq7H9DhFoD+87EapT+KR0t0d9g8SdEnlV45qs4bI0ZZVUPNf3mRFmiocby5RPudWsT3qxP+FH3Hjeu2rDvf+HqLsHPzFBwty4SOnMcxCziKU3QiQTh7r/HHr3P5csCBntgR6ZZkVc3Hap1kLE4KcG5Rhjj7u9D0g5JKyTrIXkQkrUOecHQmSLyjhdWaODKuFdwcBYrwFIaFSqZkoGCiYeEdUYdcn39Y0FFzvPpzQ1pketr8CC8uenALrwQcmJ8L07AapwT8KQrL1WxjPQczzsZ6XW4fa3vs0n7iTUvr1vQ1sgD2WAJS6+iFgUf90ZmoKoQCYyy70U2cytFZx+us4ROCR2Cpdo4hGAz4zfUARRvkT75lz+QXr/T7Yaka/4G704zwf4a7mG0MUUsWWakxOLbdnC3uoPLn/NY1mb3Tlu4Ouw9dzB0cYZuBDjurQJbubk/QdVJOZmmsrYi1QPOzPmpx7JIYjg9jb8v8w6dpUyPtjGa5zQao9/uYhqoVPqEDq8SKsuClh5k4Bg6z2Ldah0qNgR31dKRkbhPjrWBYxhLWGqd56wLI9zq0GmDi1wC+3BeLa3WgA0lOGyAXy3qR2np6miWwEgwNWcY9L2UioypNuomJDhYOHAczscsbbiOOPBK9xEuHOywmr0Ppxjtf1Hf4482ayu7WT+mF+7xRQu7RF8KTXQmhfZmUVYWVTaf8n7Ec29YzQ3lOoXlRs+h0gEKeTnun4RfsCrL5UI7YdVC2XQI3BlLqcsa1ifPHj96q+7rJxW4+611vIfM+1r/ep8/rMlSjz+i9a++St2N9d7m+lLzX8NS9O53ZkLusqRoXLjTkmLNck1XtrH3sY29/454+CH1073P+7WT6eEyGeUT0U9Xd9QtmukPoX++1xV/niK4ug/vqAL+aKrY9yfLjV9DKdVg3J/3/gZKqfcl0Rnd0wcjSvKhFE/zKPMOmqel6qb3ptwqsL869W5+GC1V48r3RU0a/KJfpdbNzfej1qaOqkJypwH/7quDF5Pun56O5Pb29vb+0cvx7svR9vZ2Cr87nc5czeU8MsBhQH627+PsEY/iwoJROp0Oei3QnG5h8/VMjL407cPFbTrWLfFXMqdsfmxzyvvzDV/145xZ82wnvx5neN89G4SBzPBNsBR7cbAVxPDy2L13DUJcNabzr2Q8DbauA/s8Bv60zxWg5fpbDW+YrwMdjVlK4S+32vDqGW7HQeheKwZhgA6i8AQaqDHYsi8vgxBcTDKwCjANfWC7rWtXyzwqDUIr6QdbgdkNQRhYtwv/iTARSfBhy+JhcBNiT2cZ1XoiVby0S/+l7BI6MBC/Y0ONf/jXw9APPN27ZzfY9KbxbPxePVV7uCnXpeyMKkWnQfOFunuz5/yArCuWU34mU3cc8Ry0kv4hGVYLwoDnLK2OsmDVlXx3TEdMwkzQMf4+ywss6D7t8HXsfRpal977NH0rB2f3Isdyrc/ujuM6CdSf0EEvXs5wL7a826j14suUhOgBHbINb5lYbIX1rdI/EGw8Xnu8tmUcUcf0khE4IhkFdZSovAGqv5aEF9TQwxZ5wSLGLy1s1Zf2+Mga1LhfGm8H7FvIxqNOmgFhu66gjXn5Zb/Xu/0S2jch8s+ODWNlokiB/fkNYEANwsANBSywsjtNvZswoBhw4QxY2H1WaQJP7zQD71x4eCaKlCkeEdMrgV7hJPFvpN3JZfczaARNzcq79HLmnRpN9foPNzYfAcwWmXO4yB33vSmdnW19bnUq8m8y/VKE5t1U6N8Rhe/xANKd5c3HdiiPhVY5HhrVeEgqiuzObYzYgYtMhI6qEze9zkz8eNEr8srjVauYp1nGqOrgY+57R5nAQCM0iQoMfOGlldrMPKh+Zr2bMLi6fTJXJJJt90SdPEjYMDd+jySSSjC1VvVj/2Qm19/YuAmD6e3Tm/4mp/c5LN7k9tm9wrf9ZdyDvwWsDx/fhMH4dli/8dEH/obAbjy6KUVIGwTDB78ZyHh65pjnzW0VnawG9SCSyp44UDFTFUQMpEwYFTOYAM97ozn4DG5fn4XG2xifGXOlnZxmgqsoc5T6Y8GccvYuYBiqY7Bgdt6FD3h70cVAQy3h+tOmwwFzAVsgwpCpwU2EHrRbMRqNITSM9YEurc8ZxEiRhXbggfkKGHfCwCJlXAL8K4CqeqOCncorAzP32hkGXyw2z7g4k9DizLx7uANaX9mztopYMxkDL4cgTDK6gHMW9rw5Wn2ACyelFCLnCb7WzgD3sXvcAAhEcaU5Z4remB2yK4ZSRUwTA3EFtyVa8BaJ1zWmCQoHn1Ww8xleKxPtkUOeGBzign6GGqI6xvATiClwFp/J4TDhgiFp3osO3TzhbqGLATjCUxNcCDwTfOAnFxHIGkJ4GUDKRROwoQIEYVfgoU8TkkuZoHxjQgGYeDt3n6AJX3BwfHiHeaE+rm0AsyEFkPJNH+Tg+BDCs/ChvTLDwxO/O9x2o7UqRlK75NRJMP68nxo5lhkzlJwjpNnAKG0yC1DM9VyIQkJdtAEfaWym4zL6E2xbWeRgPbbhtojOWaaXIPJYFnfhVLdgkpJRge/TcmDjLlYLvpMow6twYcKYoWrGPhaaeytxeHJYgUqV/kPChDbNKRmiM0UIsc0A86oARYzvkl1lTHFwWpqLAsUM6s4KNfeKuuyi9fLFMxvzqyKnO77qOoYNkCHVIKeYYTHNqc/eDZkA1rfoLjwrjqIrlr3/ZUxpiAuniFQjKvhPNk4cSKmgmBqwMU1MVXt8gAUT2dzMpcKdv7/85a8VuBZe7mcBMyPQOAa3mlsgRO2bIXhgQIplcCrKOkTQH1N/bAoGgWeCqYz9RtJ3p/FDfPejPQu03hjeG0QX0Rh0Kf4M1tWLDd50NKrzfGwVmcF82RXXeSVuiLuUz/KHF/aJXwmDOabi2PDSaXWDl14qstEdRjjh9QhCXjSaPTiKXJ4plnJxN9mlavLIpWcERS5TmvOIuK50px4Xylji3b5OSxc1oMZLLtXaXPBynrJjuWNP3Cd0qm8XNKENSoe2FYnpFDHiQhmWYiO7yria+oe4aOR3mLzldrWJjAQmeyZFxEBeYZdM3eFKUvH1A8AGLJ8wJqqYc0sovbRgYtGgwFBbscarzRoOAcKUqRE7i+Bqj3uC3WGJWy3oqtUibQOI5fi6UFZBbiO+IWsDLlf2DuBYPYB/tFyKS9Wwix3yjZwAwkKSmQh8oFQ1/QM+CUJuwxVVR4iowBejoJuHOD4VOQRewPAydqF1okJSwtnsGZ1oZPTz0AtEKINxwmVzctzdv8amEGXMje4kHpgc6LYJTSTu9nw8L7wSArWHAabGeDpqox7iNpaii/qGUtIvf/5viJTpPHB1B6awsBR91VB6xKez1V7dZnPb0WrFmrtNyJwPp2dSnJVcbi7B1FsuJaA5fm91QUvYMwIHd/IWUDpQByDanLHwT13xN7O+iwcDhHygAfdlzkArOaIqTvyZZpYxx0ibtEpIZqhF1IB6vQVkZ3RYDGNSxSyDWJ3SXhfMAfxZGccK1hPUV0ycobXpLro/e2jfVFbzJACjFJqa4iA0JrngzU0YDKLovj3Cef5H+xsP6hA/9WvfZkLwDqKIPBgkHNBD1UCaCKprW1ZUpzHsQxTDGlJ7bVEN8pGd1OQvXrm4doj/zyDxY08VZvprz9GSh/EYnaf/XW5ecqJLGRiYpQN4qIPer3i/RxlXlhamukL5V9NIL9PsWi3ySq/7G1J89rrdv2e97sPub0evu9H9Del1HwOw1sPidm6y6F49l3c4j5HlDd5KZozJiVTLa8LZCn4Q1r9lHoLL7dC/Mf+VqmjHxG9RTxv9den6YVWrbjKIhn63C/80mKDT5DklXxlzPpn+QxDe3e9k+Rq4EN/LkfXVuP+NzkQajQFnC/Q1ZfXlJFb1p1ln02/Hg6cRP+Df7r38aa+3z/f0nnixGe3sPdq7yL7/bufbLzps+m0v6n83/b7/Xf76VaL33koeffPt+AfxnR7sbBavv/9Bvf5+T71+9SKnrza3B2IsBk+/5tF08+2g3+XPdr7t/vCqNxk8/br7w3dfZD9g5193f7i46Ebp/s5AbEOd7PX3/8YP3u4+fP7T7k/Pj3evnv+UfNGh+z++3bmKvnh+sfuo/cOeaj8/GPzp7Y959mIzfrj/PX/0mD1nr8Rx91lUowYuUAnslvoM530Gi20oaWPesh/JlJkbyQQf2igJoqy9muVqSugI7laAOvUBqYApddt+eTfIliFio9s963kkbM4iYU9gzA3Mn3AsL5j4uDOtDp+b4QHUqzQpmVbATSUsD2qTrX43k9QsKhTPp8HWyXVw1aYZb5vyrZM3N29AO5CPJbiaZVIjxDQfB1vBetPzDNJYoFvSybXZg36jaSpicMae2Ww04+uXvU4/uAmbbeZuziX1WdF+1yY6pyMuRre1e1Oi6AiW0axUDVGlwJrxPzGQWO06VGuFAQfyGTMKSjTAPFDHi9Jfb9etsfOkm+ccN+MbFwTl8jYd2Jz/Ws0lrXk0z3Eyq/iYnTgHL/TZ8i5bQTnHwLtVBUHFUQp+VFyfgqDhzFS62dS8Z5yHSsVB5aTcDt4Nw0nrPRRz+xsbKA9+3kPB6eFjlEk2Ht28MatXsbuiJ+sC46HVU8wzk9miioGp9sVYSuynuuUAJ17V1NfU5U1t+ULN9QLFtQO5rqC1X+fpRXubizSSm3MVgbar+UofW1jVKMzXDljlwN1vv+9Wu3JnnUM1Tkyr0ww4rQPNPOwizWx0kWYed2sSol2xsodSzkNhzstydrqlvAZC2RvY5FwMJXIIuw98VHNg4Mhhmhvydz7y+S9/+auvBmqlP5BW6xiflDHR1rJQESPwvN1ESU/QiIqJKH7583+RQcETE9c8ZpcsgWMGEs2oQtvwGcyHSNcdE2G8Ou4IXfMwEYLXEaDFLjZmujbmnyGsXfobANMB8ZvkYyWL0RjVZGIEvlsvdo+OISERZJAhR6CmKg3FtfQNkINGwPW6kiApV5DvwNnDdE7zAi0kioHJmIObGDr+GfsCMxp6MKqriqoj4UMWTaPEIMekGDEW0UsmYqkIWP3b3ARkb7fb8M/vfkeeGoUdOYKAnCyGr7uwX7xzBVp2I6rU1Izrz2Wn2j6vHALnxLB/HASd1CuFW+SfoYfywx8q75J/+Y//JCffyEkty1J9wLuHRTgyk9Lr24d7KMKsmfXfx2iKijnjJXi3j7j4V1A24VxaLXuWEyYuuZICUAveoOd3PuvP8fKWKZlLm6nD2qWHQ4hYJUYkAQqGdxSNpdgBNdIOzegA8jlxpuH7z2SH5mwk1ZT8TF6BYcDnPZLk51Pxc7vdxv9B1VbLBYPQrRb5mezg7cX4noSkyIxjoWKX8sLSVMzQOFRmF3HLXpKv7dmnCsOevyp4EhPFCl3P9uWzd7UxrIMP8f+lz7MErrNSwS6YehOfHeKIJcM27E8c4qmjAg2fGzpjXeLVe7aIS8yCJQUZQloe2+lhMUh4ROrgH43RTEAyU+i2XsLFBW4f4ZR4+GqidE11WAbRkLyS6gJGMj2CU0wJHZpAHU7A+RxaGA/WIRc04dqaAFFid/3uQOqcyC7ec8MncA9YYCJTTgaQeypTcqRoihZH9Ha3nXwtEzCgYR8HaFnWVcjsE2DPpp8oIMehaeT6eGXyW5lOrB8zsqM22hVN2quqBlYTQ5no2UKYiE1WH9sd6nJtX7niDBS4JueF0f2DRAGO2ka3ASv4c31rAOGjpWefTYDvuAMDCn9HtsvYCCasAbEJm04FnCbnFUfYc6cGw9iqk0owAQgpi8vqUBW6vHblB1OhTDNnK5QfYDaWprwz0Pbhnu44UL8B3B+Z1TyyVPeMiwt9KsBSfG7jZVhJ0oWMTbCGfadEfjbmq3MA+fzw4OiYmLuKg/PcP72rGHEceZem99pkiTv4OyVad8DOxVSZBdAuHk1OxfnT3WOy7vUIWzw+x8nXv8PmOTf+YgOw7upcMZommNYPtplicSFieCxYSZpl8mWl8hKMjCKGFFY2QAXwTLdwPtKHM0EmU6PstHMuO2y1fN43r/jBHHXGVymSQhcp8yt0aG8e7UMlc+PGAlZNT1FQDutUu6acBucOr46Bgv7J2KonUl1wZw1lIlLTzPYK/gEVAtw6FXY967qsc/K//0POD1/OYBw/Vxq41VzfquQyrFZr0EmjoDEeFgDzBZSeO/wcmHuDp17gWUomnn5nbxfLCLc5UaShOTMFL4sr0Dtw8PWyDhcg+ll3CjueJ3WMfQtujz4Po4Pfbr4XEiKkGP5gj6FzYrQWSF/mXRvYuM9Pqxc7WOkhZ6BBj5SERwlJJQ2lkkXO0HdBMfMexdCzZzNb5kyH0eEUNW4fhZo5yS1M56TlH6LgmYDCmHPpWPocxfDec/PG47xk443nKEPp3BCNo4U9/XwsGPu8wXTm3olAdztU2EcxYuqrsyvAmj2TSyddrtBPx3B1ZC3G1LcDTpUPdnbWADibYOlUbBPBJoD2KCqxPcOv0cPAR7PwDkbnp3AVK9tJUeHfJaM23A8flDjpwq/iuhGU/GLuVr23mEaRwHh2eBhLs6QxYrbRXfQeZthn8ALXzwF8okkNGvLAuWCZXVLueB6fr1UcDj1osF4Kk8Ll1cyhaE8I8SQ3XAowm3Dr2AHgZvmUoIGSPDg/eXO+9iWR4AprHLQBtbkkXIyZ4vmcrhuybZm9bLcUrK2AW/kCewI0muBgOCvcHhnZGwWJdxDIvSTo73b1Hpbqx3zr3Zfg7zDT+Da93HlTlPmOKQh0BGv0T+QrGl1MqIo1RqmjOUfRfwpVoTEQh0kpNnAV25GtmJirBbnsmVSLvU7P3/yc/KWdUxC4+lyaga2HTCW1mPHcGDi8Y69CkoFi5tSMxlSMYCOA8FU5qDkw/riIzF5AeKFrn0qsEMY1BJ5DT7h1boobhPFSM7g3WxkIXr6deNH0FRtonrN6jPEmptewzddFkhB3+cENd8tt0TR7yvNvigEki5Sa51JNy1Yjno+LAa5lta3/YTtwlxSvLX+fWyp2ecxUig41R5A3Obpl+uuQC1Ovr6EvU0NpW1e7oI8U8B1du2PTjNv7/ImDg9Qju7/7PIwREO8qqPW3uj+a8bkuqziFg6Gdr9VgL59vEAYJj5i1SFo11vbTw2fk8mGnG4QVVfgd1nL92d7O7v7RLgBjtwloajvdThcdJ6TOUyoqI5kL4HGph248gvbmklUa7VUa7VUa7VUa7VUa7VUa7VUa7VUa7VUa7VUa7U8eu6s02qs02r9ClOtVGu1VGu1VGu3FKFql0V6l0V6l0V6l0V6l0V6l0V6l0f57TRWwSqO9SqO9iH2u0miv0miv0mh/0mlKVmm0V2m0V2m0V2m0V2m0V2m0V2m0l58+9yLSVRrtd09QtEqjvUqjvUqjvUqjvUqjvUqjvUqjvUqjvUqjvUqjvUqjvUqj/Vuzja3SaK/SaK/SaK/SaK/SaK/SaH9QHdUqjfYqjfb/szTaleCA61lCuajEDjYhTk8aybXfhMEYQqBunQTX10CRL1VycwOffywwguLJmzC4pIrDWwaMnhq6aJ8QjfCCQVTMHfPQpn0Mw4dmnfHpdyNoLIQrNS22cepL61ajtELcGAi8aBOApyaqpqITiF5IJyYgZSXEIX67DhIqRgWGRwxMnzcm78+4Ht30AqOb2j8qMRYh5GcJYT3sqZkG/D9Mam6D62sTOfXmxtc3RQtbWMS62rB8b25ubv4PpYzK4w==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Signing Links","permalink":"/docs/API-docs/v1.1/getsigninglinks"},"next":{"title":"Create Template","permalink":"/docs/API-docs/v1.1/createtemplate"}}');var s=t(74848),r=t(28453),o=t(57742),l=t.n(o),a=t(78178),d=t.n(a),c=t(19624),h=t.n(c),p=t(96226),m=t.n(p),u=(t(77675),t(19365),t(51107)),x=t(21312);const f={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:"eJztPdt2HDdyv4L05sTibM9wZkTKMp1slqZomV6JZETKskwqJKYbMwOxG2gD3RyOaZ6zD3vyATl5yev+RN7zKf6SnCpc+jIXUpSslTfjc3bFadwKhUKhUFWoug5yOtLB1klwzNIsoTnTwZswiJmOFM9yLkWwFRyPGXHF5Imiw5yLEdk+3CNM0EHCNCk0U5rkkkSKQaWo0LlM+U9QSnLXc0g0U5fQlmoySAqWKS5yTYZSkRETTFHsOJZRkTIomPB8TDLFYjbkgsVE56qI8kIx3SEvMymILqKIaT0sEjMyl4LIIaF+zJDkY4agKpYXSmhCSSH4jwUjrZYcvGVRvhe3WuRBzDQfCZqzGIBzzc94vBaSyZhHYxJRQQYMphrDTC3ArALugEKZFDimzljEhxwq2846ZDuOOcBIk2QaEkparUIlrRbhmmRKXvKYxW40ORwCSimilnCRMzWkEUNcMehFjHAY1zmhIiZDGvGE53U0kpjrXPFBASN3TsWpOObZFnmZJZLGZCoLRQ6ffF1WzyWBbyet1hM2KEbk5V6r9ebBOM8zvbW+TrOsIzMmAFsJHehOJNP1GCpm8RBxxRSDXhFfjGqeTAmNYzLh8YjlGhdEkEhmUxJJqWIuDGlkdMSIKNIBUzrE2aRSMcIFoUQxGk/buWwXmpFvjw72AQ0pzTvkMCl06IeLuWJRnkxN94AeN6vPzOo82gAa4mIUkpReAJZ4Tn4seHQB09ZM4NJakkFctVqvAF6PHa4tjceE5GOuyYQNxlJeEHYJxROeJCRXfDRiqtU6Fefn56fi+lQQchpgjdNgi5wGtovTIDRF+TRjpuTJwc7L57v7x2fHrw93fbmj1EadvSe+xpAnzR5evnjmiwVNm8X728/LAYTMbflhwqhmRLFLzia4DrDUZq4OC75ZhU+Y1r4EGjGl4esJfCHk2vxTh+Zo7+n+7osqLKYGSylPalV2n2/vPavVycZS1Ls5/OZgv95PoSq97O0/NUgx5TfwzxsLr12RbbtAx3vPd4+Ot58fQuUbu45ADUdFlkkFy//KEPQWLPOp+IolckKoYkg9kUxTKUhGFU1ZjrxxTHMsVuzHgisWG+ZGk8TtjK1T0SatFuBmq9UiLw2X4jETOfARhVvfkBw26Jj6QDpQf0/EPIKtZNjCNGPACWtVYYtB1SPLmkzVysYD3mXYD+yoCTXcIEuA8UBVxYCr5fyS1Tu+CskUOn7CgI5Mt2Op+E9S5DRBIrpkKucRTaqbHgBEVplThSwrk1zk7qsdgby2mxv2Pm5py5UAtBiQm3KBJZqRS5oUTFuoJiEZA1QvWKaYRg5t+wXEi5iMGR+NF45H47eFzmsdk0I7vuugsGO5VUX0MkTbkCaaET6s4TKlF6wyGpGZOQ865KspidmQFkkeEg78KlcF65B9mROaZQmP8CwFGjAHVaFYG1fZkk+nTj6H5jyBEyTmcJYAd4JC7MK2cdABXZoDCKaHfDcfU0GkaCx0JBOpZkkIP9fxSCIpcibyDtm+pDxB4M1kNeEiSoqYkUFCo4sQJYGQKDj7YFWmLEnkJDT7A6vgiYw4R/wQzRKgQikAfiHt8FyXZ26HHMNG8fsPCh2qcRCuq1i1PH8oYWRAgduSBPlQiIgLyVs5IDnPExbCBs+omIYkNkIGu8oH8iok0ZhFF/iXojGXZFDkuRRmYrGSWSwnwuJyKEWu+U9zdqQreXeM9kOyEZJHIXkckl43JL1+SHobIek9CknvcUj63ZD0+yHpb4Sk/8iA1X9scU09gqsA9PoGy/lvC7tjHrMzaHgGczujOmeK6wtg1wRPdCO6xqGVoq5yL7jByRXXTvwxj2MmyFDJlCgW8YwjNzHcwHcdAjxEwaSEJsMiSabkkmtewYHvVE4EinXwlStykDFxBMcsjSJZwBojhg1SEZ3lkotkCqAeM5pqnPkuCIeZ4poBqxbaY0DkJW0ZcQi+VRnAXVZS1DnQ4tVctDqVlYET9BnXyHPh6NP+NJ3UTtNeh7Rans81BalSWvJVvNwBpxmU9ezvK/jxsP+5/TmFn4/6j+3PCVbtbdifY/jZd03t5oJvVnY5DQCBVk4yDJZUQIBKNwB+KTD0cSI5TbMlk4DijzUBd1DBRzhhQldQymRVeBbM2dSw8y1n+xBmywXPOU304gm7Gp/QnBsgzZ92WWlm5hswc2Rni6dtZdpPZs5VeFAEhmPUFOGxWylyBwJC0V+Comafi9gwtEIBaQaTmx0rxSxGpJnCJ4PHCjgfCo2NLt8di48Ai3CiHsOJuhiV/tD9hPDZhOlDIXVev++O2c87KAejgLIYr7bCJ4TVOkQfCqezvb47Rh8DRkHSW4xOKP2EcFkBx2hBUGw2Zd2Ndm+z3e/2N2r4BHWVqZCm7ThuT6fT91uLlIszA0dF74IF9Gp+AWjRQHr0K+FLQIbhYuSb1UtnV93UaywkyJwWEyB2uhuokXtBQ4ni86x6AW//ZS1758G/3ZX8OVzEB8wrSa3gXNGxOn1g9Rady5hOP9OmK9fUX76gflM8NmBiEcCButFoLHlkgYc67so1AIVPB3DQxkVdj+P1yqLCxzhup2m78RF+tpEGKh/TtBPHnUbNGUIxH1MSxyGZ/Tz3exyTNE0XfDbfa5/X03R2Fp00tbBZ7Dnam1nnlAueFnBJAjWruaPHqPo+duhN7VpyQVqt169fv24/f95+8qTVcmtoh7BUXNFlmBHo1QcaoUr0rdYW2RuS6ifUJxhNDnIBfzdE3bqrMJYT4a5ERuVJ4gIUzK6q0SeldIqdMZ6PmaqPI1VJsnCBhPvWQObjDnmJ90v4293D/H0J71JfAOO0l+PFvNNW+Fjss+SS9YGXstbFrKnGW2fEIseYsvlyk2KjIqGKXYECUDeV1Pc9A9/tfGuwRUfLpbIFVYtWucucroM8OLDX8DWvYWzMBXrbtpY2otiIXZGM5jlTAju7pAmPjUWsbaxGVzTNQLuy/u+np/Hv/3EddbugPs2NUiHmIw4GmvV/P9lu//BmTo0iy5iKwDyQMBhJh4TlUYecjFmSlTaiyWTSmTzU0VjKxBiI3mrFhub/z+Tg7RmCm3WoztbmzdQQQ0WXCsTSVKXi5qxgjGriWs7RpuLS4K7pdVGCs8qKJSKcrfEJyR0NkKDQKKZP0cwSpBSFWyBeVv4tgeecBm/K4x71pyy+pe2bO2xP2A0JHbBktujdt1ZCp7KwO9rZC+pTtRRdwZsVhbxKGKfTrViAUnrVKDwtrT+NfWoQUt2m7rR329OtAEm49gdJDZ3V1tZqgLYfwYzdeMCIa0AGnkrfexd4wO62DZyKFNfuliGgHsGK3mLjRrtlhNrCzJzkVlZwpqeh79WhzB3kVXxBSzCJl2LCkhGsrLB4BGvTXzDAqeihItIpMJfcT2yNT4hXNEBavo3vw0VqJ/N9jtR7bUA3reoGnHO8QlVzsPrNpxfvvg45MFp11wg07lHEMpC03ntrepDvfEKh1riqRF9MedVanxD1zQHrV6ZAW+9Dnz73ItLq7H9DhFoD+87EapT+KR0t0d9g8SdEnlV45qs4bI0ZZVUPNf3mRFmiocby5RPudWsT3qxP+FH3Hjeu2rDvf+HqLsHPzFBwty4SOnMcxCziKU3QiQTh7r/HHr3P5csCBntgR6ZZkVc3Hap1kLE4KcG5Rhjj7u9D0g5JKyTrIXkQkrUOecHQmSLyjhdWaODKuFdwcBYrwFIaFSqZkoGCiYeEdUYdcn39Y0FFzvPpzQ1pketr8CC8uenALrwQcmJ8L07AapwT8KQrL1WxjPQczzsZ6XW4fa3vs0n7iTUvr1vQ1sgD2WAJS6+iFgUf90ZmoKoQCYyy70U2cytFZx+us4ROCR2Cpdo4hGAz4zfUARRvkT75lz+QXr/T7Yaka/4G704zwf4a7mG0MUUsWWakxOLbdnC3uoPLn/NY1mb3Tlu4Ouw9dzB0cYZuBDjurQJbubk/QdVJOZmmsrYi1QPOzPmpx7JIYjg9jb8v8w6dpUyPtjGa5zQao9/uYhqoVPqEDq8SKsuClh5k4Bg6z2Ldah0qNgR31dKRkbhPjrWBYxhLWGqd56wLI9zq0GmDi1wC+3BeLa3WgA0lOGyAXy3qR2np6miWwEgwNWcY9L2UioypNuomJDhYOHAczscsbbiOOPBK9xEuHOywmr0Ppxjtf1Hf4482ayu7WT+mF+7xRQu7RF8KTXQmhfZmUVYWVTaf8n7Ec29YzQ3lOoXlRs+h0gEKeTnun4RfsCrL5UI7YdVC2XQI3BlLqcsa1ifPHj96q+7rJxW4+611vIfM+1r/ep8/rMlSjz+i9a++St2N9d7m+lLzX8NS9O53ZkLusqRoXLjTkmLNck1XtrH3sY29/454+CH1073P+7WT6eEyGeUT0U9Xd9QtmukPoX++1xV/niK4ug/vqAL+aKrY9yfLjV9DKdVg3J/3/gZKqfcl0Rnd0wcjSvKhFE/zKPMOmqel6qb3ptwqsL869W5+GC1V48r3RU0a/KJfpdbNzfej1qaOqkJypwH/7quDF5Pun56O5Pb29vb+0cvx7svR9vZ2Cr87nc5czeU8MsBhQH627+PsEY/iwoJROp0Oei3QnG5h8/VMjL407cPFbTrWLfFXMqdsfmxzyvvzDV/145xZ82wnvx5neN89G4SBzPBNsBR7cbAVxPDy2L13DUJcNabzr2Q8DbauA/s8Bv60zxWg5fpbDW+YrwMdjVlK4S+32vDqGW7HQeheKwZhgA6i8AQaqDHYsi8vgxBcTDKwCjANfWC7rWtXyzwqDUIr6QdbgdkNQRhYtwv/iTARSfBhy+JhcBNiT2cZ1XoiVby0S/+l7BI6MBC/Y0ONf/jXw9APPN27ZzfY9KbxbPxePVV7uCnXpeyMKkWnQfOFunuz5/yArCuWU34mU3cc8Ry0kv4hGVYLwoDnLK2OsmDVlXx3TEdMwkzQMf4+ywss6D7t8HXsfRpal977NH0rB2f3Isdyrc/ujuM6CdSf0EEvXs5wL7a826j14suUhOgBHbINb5lYbIX1rdI/EGw8Xnu8tmUcUcf0khE4IhkFdZSovAGqv5aEF9TQwxZ5wSLGLy1s1Zf2+Mga1LhfGm8H7FvIxqNOmgFhu66gjXn5Zb/Xu/0S2jch8s+ODWNlokiB/fkNYEANwsANBSywsjtNvZswoBhw4QxY2H1WaQJP7zQD71x4eCaKlCkeEdMrgV7hJPFvpN3JZfczaARNzcq79HLmnRpN9foPNzYfAcwWmXO4yB33vSmdnW19bnUq8m8y/VKE5t1U6N8Rhe/xANKd5c3HdiiPhVY5HhrVeEgqiuzObYzYgYtMhI6qEze9zkz8eNEr8srjVauYp1nGqOrgY+57R5nAQCM0iQoMfOGlldrMPKh+Zr2bMLi6fTJXJJJt90SdPEjYMDd+jySSSjC1VvVj/2Qm19/YuAmD6e3Tm/4mp/c5LN7k9tm9wrf9ZdyDvwWsDx/fhMH4dli/8dEH/obAbjy6KUVIGwTDB78ZyHh65pjnzW0VnawG9SCSyp44UDFTFUQMpEwYFTOYAM97ozn4DG5fn4XG2xifGXOlnZxmgqsoc5T6Y8GccvYuYBiqY7Bgdt6FD3h70cVAQy3h+tOmwwFzAVsgwpCpwU2EHrRbMRqNITSM9YEurc8ZxEiRhXbggfkKGHfCwCJlXAL8K4CqeqOCncorAzP32hkGXyw2z7g4k9DizLx7uANaX9mztopYMxkDL4cgTDK6gHMW9rw5Wn2ACyelFCLnCb7WzgD3sXvcAAhEcaU5Z4remB2yK4ZSRUwTA3EFtyVa8BaJ1zWmCQoHn1Ww8xleKxPtkUOeGBzign6GGqI6xvATiClwFp/J4TDhgiFp3osO3TzhbqGLATjCUxNcCDwTfOAnFxHIGkJ4GUDKRROwoQIEYVfgoU8TkkuZoHxjQgGYeDt3n6AJX3BwfHiHeaE+rm0AsyEFkPJNH+Tg+BDCs/ChvTLDwxO/O9x2o7UqRlK75NRJMP68nxo5lhkzlJwjpNnAKG0yC1DM9VyIQkJdtAEfaWym4zL6E2xbWeRgPbbhtojOWaaXIPJYFnfhVLdgkpJRge/TcmDjLlYLvpMow6twYcKYoWrGPhaaeytxeHJYgUqV/kPChDbNKRmiM0UIsc0A86oARYzvkl1lTHFwWpqLAsUM6s4KNfeKuuyi9fLFMxvzqyKnO77qOoYNkCHVIKeYYTHNqc/eDZkA1rfoLjwrjqIrlr3/ZUxpiAuniFQjKvhPNk4cSKmgmBqwMU1MVXt8gAUT2dzMpcKdv7/85a8VuBZe7mcBMyPQOAa3mlsgRO2bIXhgQIplcCrKOkTQH1N/bAoGgWeCqYz9RtJ3p/FDfPejPQu03hjeG0QX0Rh0Kf4M1tWLDd50NKrzfGwVmcF82RXXeSVuiLuUz/KHF/aJXwmDOabi2PDSaXWDl14qstEdRjjh9QhCXjSaPTiKXJ4plnJxN9mlavLIpWcERS5TmvOIuK50px4Xylji3b5OSxc1oMZLLtXaXPBynrJjuWNP3Cd0qm8XNKENSoe2FYnpFDHiQhmWYiO7yria+oe4aOR3mLzldrWJjAQmeyZFxEBeYZdM3eFKUvH1A8AGLJ8wJqqYc0sovbRgYtGgwFBbscarzRoOAcKUqRE7i+Bqj3uC3WGJWy3oqtUibQOI5fi6UFZBbiO+IWsDLlf2DuBYPYB/tFyKS9Wwix3yjZwAwkKSmQh8oFQ1/QM+CUJuwxVVR4iowBejoJuHOD4VOQRewPAydqF1okJSwtnsGZ1oZPTz0AtEKINxwmVzctzdv8amEGXMje4kHpgc6LYJTSTu9nw8L7wSArWHAabGeDpqox7iNpaii/qGUtIvf/5viJTpPHB1B6awsBR91VB6xKez1V7dZnPb0WrFmrtNyJwPp2dSnJVcbi7B1FsuJaA5fm91QUvYMwIHd/IWUDpQByDanLHwT13xN7O+iwcDhHygAfdlzkArOaIqTvyZZpYxx0ibtEpIZqhF1IB6vQVkZ3RYDGNSxSyDWJ3SXhfMAfxZGccK1hPUV0ycobXpLro/e2jfVFbzJACjFJqa4iA0JrngzU0YDKLovj3Cef5H+xsP6hA/9WvfZkLwDqKIPBgkHNBD1UCaCKprW1ZUpzHsQxTDGlJ7bVEN8pGd1OQvXrm4doj/zyDxY08VZvprz9GSh/EYnaf/XW5ecqJLGRiYpQN4qIPer3i/RxlXlhamukL5V9NIL9PsWi3ySq/7G1J89rrdv2e97sPub0evu9H9Del1HwOw1sPidm6y6F49l3c4j5HlDd5KZozJiVTLa8LZCn4Q1r9lHoLL7dC/Mf+VqmjHxG9RTxv9den6YVWrbjKIhn63C/80mKDT5DklXxlzPpn+QxDe3e9k+Rq4EN/LkfXVuP+NzkQajQFnC/Q1ZfXlJFb1p1ln02/Hg6cRP+Df7r38aa+3z/f0nnixGe3sPdq7yL7/bufbLzps+m0v6n83/b7/Xf76VaL33koeffPt+AfxnR7sbBavv/9Bvf5+T71+9SKnrza3B2IsBk+/5tF08+2g3+XPdr7t/vCqNxk8/br7w3dfZD9g5193f7i46Ebp/s5AbEOd7PX3/8YP3u4+fP7T7k/Pj3evnv+UfNGh+z++3bmKvnh+sfuo/cOeaj8/GPzp7Y959mIzfrj/PX/0mD1nr8Rx91lUowYuUAnslvoM530Gi20oaWPesh/JlJkbyQQf2igJoqy9muVqSugI7laAOvUBqYApddt+eTfIliFio9s963kkbM4iYU9gzA3Mn3AsL5j4uDOtDp+b4QHUqzQpmVbATSUsD2qTrX43k9QsKhTPp8HWyXVw1aYZb5vyrZM3N29AO5CPJbiaZVIjxDQfB1vBetPzDNJYoFvSybXZg36jaSpicMae2Ww04+uXvU4/uAmbbeZuziX1WdF+1yY6pyMuRre1e1Oi6AiW0axUDVGlwJrxPzGQWO06VGuFAQfyGTMKSjTAPFDHi9Jfb9etsfOkm+ccN+MbFwTl8jYd2Jz/Ws0lrXk0z3Eyq/iYnTgHL/TZ8i5bQTnHwLtVBUHFUQp+VFyfgqDhzFS62dS8Z5yHSsVB5aTcDt4Nw0nrPRRz+xsbKA9+3kPB6eFjlEk2Ht28MatXsbuiJ+sC46HVU8wzk9miioGp9sVYSuynuuUAJ17V1NfU5U1t+ULN9QLFtQO5rqC1X+fpRXubizSSm3MVgbar+UofW1jVKMzXDljlwN1vv+9Wu3JnnUM1Tkyr0ww4rQPNPOwizWx0kWYed2sSol2xsodSzkNhzstydrqlvAZC2RvY5FwMJXIIuw98VHNg4Mhhmhvydz7y+S9/+auvBmqlP5BW6xiflDHR1rJQESPwvN1ESU/QiIqJKH7583+RQcETE9c8ZpcsgWMGEs2oQtvwGcyHSNcdE2G8Ou4IXfMwEYLXEaDFLjZmujbmnyGsXfobANMB8ZvkYyWL0RjVZGIEvlsvdo+OISERZJAhR6CmKg3FtfQNkINGwPW6kiApV5DvwNnDdE7zAi0kioHJmIObGDr+GfsCMxp6MKqriqoj4UMWTaPEIMekGDEW0UsmYqkIWP3b3ARkb7fb8M/vfkeeGoUdOYKAnCyGr7uwX7xzBVp2I6rU1Izrz2Wn2j6vHALnxLB/HASd1CuFW+SfoYfywx8q75J/+Y//JCffyEkty1J9wLuHRTgyk9Lr24d7KMKsmfXfx2iKijnjJXi3j7j4V1A24VxaLXuWEyYuuZICUAveoOd3PuvP8fKWKZlLm6nD2qWHQ4hYJUYkAQqGdxSNpdgBNdIOzegA8jlxpuH7z2SH5mwk1ZT8TF6BYcDnPZLk51Pxc7vdxv9B1VbLBYPQrRb5mezg7cX4noSkyIxjoWKX8sLSVMzQOFRmF3HLXpKv7dmnCsOevyp4EhPFCl3P9uWzd7UxrIMP8f+lz7MErrNSwS6YehOfHeKIJcM27E8c4qmjAg2fGzpjXeLVe7aIS8yCJQUZQloe2+lhMUh4ROrgH43RTEAyU+i2XsLFBW4f4ZR4+GqidE11WAbRkLyS6gJGMj2CU0wJHZpAHU7A+RxaGA/WIRc04dqaAFFid/3uQOqcyC7ec8MncA9YYCJTTgaQeypTcqRoihZH9Ha3nXwtEzCgYR8HaFnWVcjsE2DPpp8oIMehaeT6eGXyW5lOrB8zsqM22hVN2quqBlYTQ5no2UKYiE1WH9sd6nJtX7niDBS4JueF0f2DRAGO2ka3ASv4c31rAOGjpWefTYDvuAMDCn9HtsvYCCasAbEJm04FnCbnFUfYc6cGw9iqk0owAQgpi8vqUBW6vHblB1OhTDNnK5QfYDaWprwz0Pbhnu44UL8B3B+Z1TyyVPeMiwt9KsBSfG7jZVhJ0oWMTbCGfadEfjbmq3MA+fzw4OiYmLuKg/PcP72rGHEceZem99pkiTv4OyVad8DOxVSZBdAuHk1OxfnT3WOy7vUIWzw+x8nXv8PmOTf+YgOw7upcMZommNYPtplicSFieCxYSZpl8mWl8hKMjCKGFFY2QAXwTLdwPtKHM0EmU6PstHMuO2y1fN43r/jBHHXGVymSQhcp8yt0aG8e7UMlc+PGAlZNT1FQDutUu6acBucOr46Bgv7J2KonUl1wZw1lIlLTzPYK/gEVAtw6FXY967qsc/K//0POD1/OYBw/Vxq41VzfquQyrFZr0EmjoDEeFgDzBZSeO/wcmHuDp17gWUomnn5nbxfLCLc5UaShOTMFL4sr0Dtw8PWyDhcg+ll3CjueJ3WMfQtujz4Po4Pfbr4XEiKkGP5gj6FzYrQWSF/mXRvYuM9Pqxc7WOkhZ6BBj5SERwlJJQ2lkkXO0HdBMfMexdCzZzNb5kyH0eEUNW4fhZo5yS1M56TlH6LgmYDCmHPpWPocxfDec/PG47xk443nKEPp3BCNo4U9/XwsGPu8wXTm3olAdztU2EcxYuqrsyvAmj2TSyddrtBPx3B1ZC3G1LcDTpUPdnbWADibYOlUbBPBJoD2KCqxPcOv0cPAR7PwDkbnp3AVK9tJUeHfJaM23A8flDjpwq/iuhGU/GLuVr23mEaRwHh2eBhLs6QxYrbRXfQeZthn8ALXzwF8okkNGvLAuWCZXVLueB6fr1UcDj1osF4Kk8Ll1cyhaE8I8SQ3XAowm3Dr2AHgZvmUoIGSPDg/eXO+9iWR4AprHLQBtbkkXIyZ4vmcrhuybZm9bLcUrK2AW/kCewI0muBgOCvcHhnZGwWJdxDIvSTo73b1Hpbqx3zr3Zfg7zDT+Da93HlTlPmOKQh0BGv0T+QrGl1MqIo1RqmjOUfRfwpVoTEQh0kpNnAV25GtmJirBbnsmVSLvU7P3/yc/KWdUxC4+lyaga2HTCW1mPHcGDi8Y69CkoFi5tSMxlSMYCOA8FU5qDkw/riIzF5AeKFrn0qsEMY1BJ5DT7h1boobhPFSM7g3WxkIXr6deNH0FRtonrN6jPEmptewzddFkhB3+cENd8tt0TR7yvNvigEki5Sa51JNy1Yjno+LAa5lta3/YTtwlxSvLX+fWyp2ecxUig41R5A3Obpl+uuQC1Ovr6EvU0NpW1e7oI8U8B1du2PTjNv7/ImDg9Qju7/7PIwREO8qqPW3uj+a8bkuqziFg6Gdr9VgL59vEAYJj5i1SFo11vbTw2fk8mGnG4QVVfgd1nL92d7O7v7RLgBjtwloajvdThcdJ6TOUyoqI5kL4HGph248gvbmklUa7VUa7VUa7VUa7VUa7VUa7VUa7VUa7VUa7VUa7U8eu6s02qs02r9ClOtVGu1VGu1VGu3FKFql0V6l0V6l0V6l0V6l0V6l0V6l0f57TRWwSqO9SqO9iH2u0miv0miv0mh/0mlKVmm0V2m0V2m0V2m0V2m0V2m0V2m0l58+9yLSVRrtd09QtEqjvUqjvUqjvUqjvUqjvUqjvUqjvUqjvUqjvUqjvUqjvUqj/Vuzja3SaK/SaK/SaK/SaK/SaK/SaH9QHdUqjfYqjfb/szTaleCA61lCuajEDjYhTk8aybXfhMEYQqBunQTX10CRL1VycwOffywwguLJmzC4pIrDWwaMnhq6aJ8QjfCCQVTMHfPQpn0Mw4dmnfHpdyNoLIQrNS22cepL61ajtELcGAi8aBOApyaqpqITiF5IJyYgZSXEIX67DhIqRgWGRwxMnzcm78+4Ht30AqOb2j8qMRYh5GcJYT3sqZkG/D9Mam6D62sTOfXmxtc3RQtbWMS62rB8b25ubv4PpYzK4w==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-2",custom_edit_url:null},g=void 0,y={},j=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Draft Template"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/drafttemplate",context:"endpoint"}),"\n",(0,s.jsxs)(n.p,{children:["The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique ",(0,s.jsx)(n.strong,{children:"objectId"})," (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a ",(0,s.jsx)(n.strong,{children:"url"})," is provided, which offers a user interface for editing the template and facilitating document distribution."]}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"When document is created this webhook event will trigger"})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE",\n "url": "SIGNING_URL"\n }\n ],\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Unique identifier for this widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Specify the hint for widgets. This parameter is optional and is not applicable to the following widgets: checkbox, radio button, dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "hint": "Provide signature"\n }\n\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp",\n "hint": "Provide stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials",\n "hint": "Provide initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide email",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide name",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide job title",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide company",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12,\n "min_date": "",\n "max_date": "",\n "readonly": false,\n "signing_date": false,\n "hint": "Provide date"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"min_date:"})," Provide the minimum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"max_date:"})," Provide the maximum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"signing_date"}),": If signing_date is set to true, the signing date is shown to the signer during signing. You may set either signing_date or default, but not both. Using both is not supported."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image",\n "hint": "Provide image"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"14",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Provide number",\n "formula": "",\n "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,s.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"decimalplaces:"})," Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"15",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"cells"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "cells",\n "page": 1,\n "x": 100,\n "y": 100,\n "w": 114,\n "h": 50,\n "options": {\n "name": "cells",\n "required": true,\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"cell_count:"})," Specify the number of cells that should be returned to the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"16",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"attachments"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "attachments",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "attachment widget",\n "hint": "Provide files"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,s.jsx)(n.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "required": true,\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "response": "04/15/2024",\n "format": "mm/dd/yyyy",\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "required": true,\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 528,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "values": ["male", "female", "other"],\n "response": "female",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(x.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(h(),{...t(82145)}),"\n",(0,s.jsx)(m(),{...t(66631)})]})}function w(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}},82145(e){e.exports=JSON.parse('{"title":"Body","body":{"content":{"application/json":{"schema":{"required":["file","signers","title"],"type":"object","properties":{"file":{"type":"string","format":"base64","example":"base64 encoded pdf"},"file_password":{"type":"string","format":"string","example":""},"title":{"type":"string","format":"string","example":"sample template"},"note":{"type":"string","format":"string","example":"sample note"},"description":{"type":"string","format":"string","example":"sample description"},"signers":{"type":"array","description":"You can provide signer optionally if you it as default signer","items":{"type":"object","properties":{"role":{"type":"string","format":"string","example":"ceo"},"email":{"type":"string","format":"string","example":""},"name":{"type":"string","format":"string","example":""},"phone":{"type":"string","format":"string","example":""},"company":{"type":"string","format":"string","example":""},"job_title":{"type":"string","format":"string","example":""},"signer_role":{"type":"string","format":"string","description":"Specifies the role of the recipient in the signing process. Allowed values:\\n- **signer** (default): Must have at least one signature widget.\\n- **viewer**: Receives the document to view only; must have no widgets.\\n- **approver**: Reviews and approves the document; no signature widget required.\\n","enum":["signer","viewer","approver"],"example":"signer"},"access_code":{"type":"string","format":"string","description":"when set, this numeric access code is required for the signer to access and sign the document.","example":"123456"},"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Allowed values include signature, stamp, initials, email, name, job title, company, date, textbox, checkbox, dropdown, radio button, image, number, cells, attachments.","format":"string","example":"signature"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":244},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":71},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":38},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":46}},"title":"createtemplate_body_widgets"}}},"title":"createtemplate_body_signers"}},"sendInOrder":{"type":"boolean","description":"If set to \'true\', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to \'true\'.","example":true},"send_in_order_strict":{"type":"boolean","description":"When set to \'true\', each signer is blocked from accessing the document until all preceding signers have completed their action. Enforces strict sequential signing. Only applies when \'sendInOrder\' is also \'true\'. Defaults to \'false\'.","example":false},"allow_offline_sign":{"type":"boolean","description":"If set to \'true\', signers can submit a copy of documents created from this template signed using an external tool for owner review. Defaults to \'false\'.","example":false},"enableOTP":{"type":"boolean","description":"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.","example":false},"enableTour":{"type":"boolean","description":"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.","example":false},"redirect_url":{"type":"string","description":"Specifies the URL where the signer will be redirected upon completing the document signing process.","example":""},"sender_name":{"type":"string","description":"The name of the person or organization on whose behalf the email is being sent.","example":"opensign\u2122"},"sender_email":{"type":"string","description":"The email address of the person or organization that users can reply to.","example":"mailer@opensignlabs.com"},"allow_modifications":{"type":"boolean","description":"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.","example":false},"auto_reminder":{"type":"boolean","description":"Set to true to enable automatic reminders. Set to false to disable them (default behavior).","example":false},"timeToCompleteDays":{"type":"number","description":"time to complete days is used to calculate expiry date of your document","format":"number","example":15},"remind_once_in_every":{"type":"number","description":"Number of days between reminders. This is only applicable when auto_reminder is set to true.","example":5},"merge_certificate":{"type":"boolean","description":"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\\n\\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\\n\\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\\n","example":false},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed. \\n"},"cc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"cc (carbon copy): Users added here will receive a notification email once the document is completed.\\n"},"prefill":{"type":"object","description":"You can provide widgets which can embed before sending to signer","properties":{"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","format":"string","example":"textbox"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":100},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":30},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":40},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":80},"options":{"type":"object","properties":{"name":{"type":"string","example":"textbox"},"response":{"type":"string","example":"joe"},"color":{"type":"string","example":"red"},"fontsize":{"type":"number","example":12}}}}}}},"title":"prefill"}},"title":"createtemplate_body"}}},"required":true}}')},66631(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Template created successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","example":"Bh2Hspnmch"},"url":{"type":"string","example":"https://app.opensignlabs.com/drafttemplate/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2VtYWlsIjoicHJhZnVsbC5uYXZrYXIrYWRtaW5AbnhnbGFicy5jb20iLCJ0ZW1wbGF0ZV9pZCI6IkF0Zkk0cmNCbnAiLCJpYXQiOjE3MzEzMTExMzl9.aNqjCxc9MkE6-ZIr-MObKjqtpR5d3NXi68eMeWnT0Lc"}},"title":"inline_response_draft_200"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/c7e3ab5f.11858bb1.js b/assets/js/c7e3ab5f.11858bb1.js new file mode 100644 index 000000000..cf7ebf461 --- /dev/null +++ b/assets/js/c7e3ab5f.11858bb1.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[4833],{69222(e,t,o){o.r(t),o.d(t,{assets:()=>g,contentTitle:()=>G,default:()=>v,frontMatter:()=>y,metadata:()=>a,toc:()=>P});const a=JSON.parse('{"id":"API-docs/v1.1/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/v1.1/deletecontact.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/deletecontact","permalink":"/docs/API-docs/v1.1/deletecontact","draft":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJzVGdtuI7f1V065QGsLI8l2NimqFGkd29k1us0alt0FahkWNTzSMKLICcmRLNgC8lD0A4q+9LU/0fd+yn5Jccjh6GJnN4sUBfqwa5s89zvPPDDPJ471btiJ0Z7n3rHbjAl0uZWll0azHrsqEE5RoUeogeD44hy4UmbhYGkq8AYszswcgUNeg4ytmdGlTScjY6YdOB8HDG1AGT1BCxpRAIeSWy/zSvEG/lcOpB4bO+MkRwa+kC4wnvEpOpAekLsl8RZROF+gtGAxN1Z0WMZMiTbgngvWYxGops0yVnLLZ+jRkvYPTPMZsh6r7++kYBmTpH3JfcF2TXJhzVwKBDP6DnN/LsCMG8UbgVjGLH5fSYuC9bytMGPOLxWxcXJWKgLA+1IZgaw35soRQF7gjLPeA/PLMkB6K/WEZSxaYvME73mg0mNlcTQqjrgTbLW6Ja6uNNqhIzpHBwf0Y1v+5McoqABX5Tk6N66UWv6CZcEMqD0h8rJUMg927H7nCPvhqZTRDmRVS1b3MvJO5nlOn7X0X9+T7OXr8jO2ymo/iWP/YaSjg6PP2ocH7YNfXx1+0Xv5m97nX3QODg7+zDJ2P1OEW3tUcI9E10uv1n+vnoBFl20C1icrAn75nBX7Zoa+kHoCC9QeFtboSQalQu4QvF0Cn3CpQXGP9r9oVbTW2A9b59MkW21oLbWSGu9SCN29PDi4O2yM8PLHQ0kbD2NTafG/1fQZ9h9W5+XdUaPO50/VOddzrqQIhebKTFH/b9XZZO8j+6exKiNQuGdbym6eRyUd5pWVfhmK3H2bl7Id73s3t1QrKE7Muj6GwugL1mPdup51H9Y1ccWIoJ2nollZxXqs8L50vW7XcS1G5r5jStROTrTiI9fJzazLS9mdH3aO2CrbxeFl+UnwWLU/FcV5PpF68jG827Wt+uTP6LItizWO46X8Ay5ZlhyyCVW3jQK5QBucR10sINduelui7suJDk4OzHfbywtIMO//8s8GbKAH+itotagfkyJtZyqbI5yavAr0uPJoNfdyjvD+h7/DqJKKssKCwDkqCkWXgbeVo5o/WgJqj7a00qHrtFpEf5PvRM4x9nfq6hSgHjMorRFVToK2LXKxBGyTRbmvLEKpuKdGBb6wppoUwMFJPVGYweVZ/2pcKdKmA33UAoTJqxlq74KIDZEMZlzzCYLHGdHDIDPPpwGEaprz3Fc0HYBFrsDLGWbAtQBeeTPjHuPcgdpLiw0bUHKM+TJX0ThcKVhIX5jKwxy1MBaUyadtqTtkiHa7TT9evIBX6D1x7XtuPQo6PZujXQI1d3QeZpXzkHNrl5Fvk7skoS8QhhvxMYQYGYHJcDgc6I3LHvyWKKwPvqphBrrVev/Xv8HNa7OgAWOCmmYb3GF4u5eCXpjcPY12Ou0WqMpuPyrluscX56HM7Uf/f2s8OPLkokCLxGqEE6l/B9cuDFjQatVpDqjn0hpNpm21YG/4k8vAcJ/oltZ4Q/nUeIGPx5gHUyuKYME933HFibEIJ7zkI6kkVVU6f4QT7nFi7BIe4V3BfQjZnGsQBh4H+rHdbod/BNpqnaaoa7XgEU4scopqh1pkUJUi/GVxbqZ1TNXDZROe7eT2dfjWlK9SvAbKX1dSCbBYOT5SG8Ec1IXSYrtUPEcBCykm6N2XQQayjNEIxlIWLANbtA2LPqpxm/IzsHiVosDRcQDdzKrGrjUVkHoufWhdMFZmkYheVCMlc9gWv19wS+N8GS9T6imppyF9tElUlXQe0qCbaJ5aPvbwztgpcYoU+Rw3pDN2wybcgSAMF0w+lporGQNuFoeURDe9UgLFP8Y6EXKgFiYN4fTYoBCbWD6jB0TOlVomIt8YJdBGGm/thGvitZZMakezfVOmTy2F4zgiJRrvcFQYM41ELjFHgqFy1KZyBDiniqONl+N6WnAQI9OCWWhALUojtU/krl0S6BK9lUhPqTw3lfbBIrlFIf3me4gQN1ODAv/9D/9w8C0uqO6khkGXL+DYe54XoQq+C+EG/aosjfUDTd1kyJt7N6wDEqQDbRbgIiAKMDo6qTFVRnJR/K0PIkBybAOwPiBt6phKh1S/XCeJ+pps34/e7NdR90bqqRvoPnoYDlghBd5Ff9/VcXmnAgTrUXdDeITwnBqSyMOLt/0r6AbBkpxDSjMik8JmM7xdKtvbykKaITtrs54o5ISeUic5j6uBHr46u4Ju0rHbk2IYlN8+p+QZQkGpMULU4LxFPqOZVYQ0sygqLbj2sH6vAmVmfG+LQLLVKi2OpVKhZibHWfSVJToOCdejWsZHea3zmmCrRT13SgZono70uJZoyVC50a6aYeOhC+7cwljRvrDGY06hcXH6zTqi6J78NJYK78oaeMCGya6pgI6MWFKf0bAwNnAPpRF1bpdlTdV1Et0QgL2Brv0ZAyuZcQj//hcML66fWDwcbyAkb3Z7Ce5uG2wnTnYudviFCyq+ZNJhss/b8Zgc2EQv1SxrVBO/YXFyZyJUiOAPBe6uoiGGntHUG6BlgsylVzTZha5Do5+MDajm14Q6zVzI86JJw8a/dfJdGkUNNtSHug0N64VHiC+e51hSxSad6nS0RiF5eixRCeC5Nc6FSStoQWXLmsqj68BVYRGB4GM8N2WmF3s6cacuigWfS6qau528lmkIrT2BY14pvx96QhjG6mmVSi69eX3oqesxta5wkc5c4oLoNGXcxexPeU+GskhQYLRapu5Xt+24BkuNb8jL0pp5JHfCdcxsauQJHO/JanVPjtLUvTMwe2xKC7cjo+HElEvYOznZJ+FkKalCD/QxaFyQ2fN8be0n9ZrThi20MtIH76ULw9VwwEabeFTWm/q9LtSx+lG0NdNF48VuHJQaZ57NuFTAhbDoqHZQVUNB+d7IaOsWyWlSHhndzkmzzQYJGKgYneO2A6RrHCo68EZOca1DRuJvSQN7rsoLmihilqwzXorhPs0EcylqO0TRyF9WitrvTVeac1VhFjp5rFJkWSXJsDSmAM5KvwRuLV/C3vDmdrj/JZiZ9IFKNK03IHWBtj7cJr0z2x7PuVQhU8/Wg3U94G6cUE7QEuf68s0zw20/zt5hkPiEgbyZBJu33TaFDz6dG+yza7jEyRPkjz3Zh7ujzJ/QOmlCkfolfM3z6YJb4eDEzEruZRj9lwRKyBQcYWsJowTYzmtAFZ8WMD8MYTw/7Bw2L780f7nYEn1hHMI8Mo4FiTf+MDrunkfJ7oGqNjCyGLtmXnA9oUSg4WujUUsq/KLKYy4EeYm0Ce98rqDSCp0D4wu0CxpCtaEY3zbHtUN6N9cz0EC34aYZTd/hyEmP63ffYrF4Yun9gPNNpRSkx09IuI+8FiPaK+lfVyO4xNI46Y1drrEm0hfVKPhyE7f5oyaQHinNRu3nvFIDySu0M0cr9z7aucw/on7XE3h3f0C7mZ19zvbaxeIYLdUdt/XG5qWs3/M3SQ4g8X6OHrS2S98iaDNIpS8uln6/Syds+EiFt+Na33q59WF9WcaUzFE73NgcHr+6eAPzzzoHLNvYkv0EX3bfnJ+cfds/I2HqNGE9dtg56BzQUWmcn3G9wWn7g9HuhuthvVL9v/28VO8CPd77bqm4DKvYYNSHeod6w9afm3obX5ZuM1YY5wng4YGqyrVVqxUdf1+hpVXtbcbm3EoqP2HRWg9xovlO9KPW3LusX+L78FM/Uj2rSNp0alpzhn7FeoxlbIrL7c9kq9tVlradJGoEOA7D4Qbqk7351vL59OzN2dUZyxivyHCbi9ZpWLTWvxCDZyXb3sBGGeh/Wgc/i/DwEJe4q1UDH69+FKPWMUGTmW5Xq9V/AHBMXMg=","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Update Contact","permalink":"/docs/API-docs/v1.1/update-contact"},"next":{"title":"Get Contact list","permalink":"/docs/API-docs/v1.1/contactlist"}}');var n=o(74848),c=o(28453),r=o(57742),i=o.n(r),s=o(78178),l=o.n(s),d=o(19624),p=o.n(d),u=o(96226),m=o.n(u),h=(o(77675),o(19365),o(51107)),b=o(21312);const y={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:"eJzVGdtuI7f1V065QGsLI8l2NimqFGkd29k1us0alt0FahkWNTzSMKLICcmRLNgC8lD0A4q+9LU/0fd+yn5Jccjh6GJnN4sUBfqwa5s89zvPPDDPJ471btiJ0Z7n3rHbjAl0uZWll0azHrsqEE5RoUeogeD44hy4UmbhYGkq8AYszswcgUNeg4ytmdGlTScjY6YdOB8HDG1AGT1BCxpRAIeSWy/zSvEG/lcOpB4bO+MkRwa+kC4wnvEpOpAekLsl8RZROF+gtGAxN1Z0WMZMiTbgngvWYxGops0yVnLLZ+jRkvYPTPMZsh6r7++kYBmTpH3JfcF2TXJhzVwKBDP6DnN/LsCMG8UbgVjGLH5fSYuC9bytMGPOLxWxcXJWKgLA+1IZgaw35soRQF7gjLPeA/PLMkB6K/WEZSxaYvME73mg0mNlcTQqjrgTbLW6Ja6uNNqhIzpHBwf0Y1v+5McoqABX5Tk6N66UWv6CZcEMqD0h8rJUMg927H7nCPvhqZTRDmRVS1b3MvJO5nlOn7X0X9+T7OXr8jO2ymo/iWP/YaSjg6PP2ocH7YNfXx1+0Xv5m97nX3QODg7+zDJ2P1OEW3tUcI9E10uv1n+vnoBFl20C1icrAn75nBX7Zoa+kHoCC9QeFtboSQalQu4QvF0Cn3CpQXGP9r9oVbTW2A9b59MkW21oLbWSGu9SCN29PDi4O2yM8PLHQ0kbD2NTafG/1fQZ9h9W5+XdUaPO50/VOddzrqQIhebKTFH/b9XZZO8j+6exKiNQuGdbym6eRyUd5pWVfhmK3H2bl7Id73s3t1QrKE7Muj6GwugL1mPdup51H9Y1ccWIoJ2nollZxXqs8L50vW7XcS1G5r5jStROTrTiI9fJzazLS9mdH3aO2CrbxeFl+UnwWLU/FcV5PpF68jG827Wt+uTP6LItizWO46X8Ay5ZlhyyCVW3jQK5QBucR10sINduelui7suJDk4OzHfbywtIMO//8s8GbKAH+itotagfkyJtZyqbI5yavAr0uPJoNfdyjvD+h7/DqJKKssKCwDkqCkWXgbeVo5o/WgJqj7a00qHrtFpEf5PvRM4x9nfq6hSgHjMorRFVToK2LXKxBGyTRbmvLEKpuKdGBb6wppoUwMFJPVGYweVZ/2pcKdKmA33UAoTJqxlq74KIDZEMZlzzCYLHGdHDIDPPpwGEaprz3Fc0HYBFrsDLGWbAtQBeeTPjHuPcgdpLiw0bUHKM+TJX0ThcKVhIX5jKwxy1MBaUyadtqTtkiHa7TT9evIBX6D1x7XtuPQo6PZujXQI1d3QeZpXzkHNrl5Fvk7skoS8QhhvxMYQYGYHJcDgc6I3LHvyWKKwPvqphBrrVev/Xv8HNa7OgAWOCmmYb3GF4u5eCXpjcPY12Ou0WqMpuPyrluscX56HM7Uf/f2s8OPLkokCLxGqEE6l/B9cuDFjQatVpDqjn0hpNpm21YG/4k8vAcJ/oltZ4Q/nUeIGPx5gHUyuKYME933HFibEIJ7zkI6kkVVU6f4QT7nFi7BIe4V3BfQjZnGsQBh4H+rHdbod/BNpqnaaoa7XgEU4scopqh1pkUJUi/GVxbqZ1TNXDZROe7eT2dfjWlK9SvAbKX1dSCbBYOT5SG8Ec1IXSYrtUPEcBCykm6N2XQQayjNEIxlIWLANbtA2LPqpxm/IzsHiVosDRcQDdzKrGrjUVkHoufWhdMFZmkYheVCMlc9gWv19wS+N8GS9T6imppyF9tElUlXQe0qCbaJ5aPvbwztgpcYoU+Rw3pDN2wybcgSAMF0w+lporGQNuFoeURDe9UgLFP8Y6EXKgFiYN4fTYoBCbWD6jB0TOlVomIt8YJdBGGm/thGvitZZMakezfVOmTy2F4zgiJRrvcFQYM41ELjFHgqFy1KZyBDiniqONl+N6WnAQI9OCWWhALUojtU/krl0S6BK9lUhPqTw3lfbBIrlFIf3me4gQN1ODAv/9D/9w8C0uqO6khkGXL+DYe54XoQq+C+EG/aosjfUDTd1kyJt7N6wDEqQDbRbgIiAKMDo6qTFVRnJR/K0PIkBybAOwPiBt6phKh1S/XCeJ+pps34/e7NdR90bqqRvoPnoYDlghBd5Ff9/VcXmnAgTrUXdDeITwnBqSyMOLt/0r6AbBkpxDSjMik8JmM7xdKtvbykKaITtrs54o5ISeUic5j6uBHr46u4Ju0rHbk2IYlN8+p+QZQkGpMULU4LxFPqOZVYQ0sygqLbj2sH6vAmVmfG+LQLLVKi2OpVKhZibHWfSVJToOCdejWsZHea3zmmCrRT13SgZono70uJZoyVC50a6aYeOhC+7cwljRvrDGY06hcXH6zTqi6J78NJYK78oaeMCGya6pgI6MWFKf0bAwNnAPpRF1bpdlTdV1Et0QgL2Brv0ZAyuZcQj//hcML66fWDwcbyAkb3Z7Ce5uG2wnTnYudviFCyq+ZNJhss/b8Zgc2EQv1SxrVBO/YXFyZyJUiOAPBe6uoiGGntHUG6BlgsylVzTZha5Do5+MDajm14Q6zVzI86JJw8a/dfJdGkUNNtSHug0N64VHiC+e51hSxSad6nS0RiF5eixRCeC5Nc6FSStoQWXLmsqj68BVYRGB4GM8N2WmF3s6cacuigWfS6qau528lmkIrT2BY14pvx96QhjG6mmVSi69eX3oqesxta5wkc5c4oLoNGXcxexPeU+GskhQYLRapu5Xt+24BkuNb8jL0pp5JHfCdcxsauQJHO/JanVPjtLUvTMwe2xKC7cjo+HElEvYOznZJ+FkKalCD/QxaFyQ2fN8be0n9ZrThi20MtIH76ULw9VwwEabeFTWm/q9LtSx+lG0NdNF48VuHJQaZ57NuFTAhbDoqHZQVUNB+d7IaOsWyWlSHhndzkmzzQYJGKgYneO2A6RrHCo68EZOca1DRuJvSQN7rsoLmihilqwzXorhPs0EcylqO0TRyF9WitrvTVeac1VhFjp5rFJkWSXJsDSmAM5KvwRuLV/C3vDmdrj/JZiZ9IFKNK03IHWBtj7cJr0z2x7PuVQhU8/Wg3U94G6cUE7QEuf68s0zw20/zt5hkPiEgbyZBJu33TaFDz6dG+yza7jEyRPkjz3Zh7ujzJ/QOmlCkfolfM3z6YJb4eDEzEruZRj9lwRKyBQcYWsJowTYzmtAFZ8WMD8MYTw/7Bw2L780f7nYEn1hHMI8Mo4FiTf+MDrunkfJ7oGqNjCyGLtmXnA9oUSg4WujUUsq/KLKYy4EeYm0Ce98rqDSCp0D4wu0CxpCtaEY3zbHtUN6N9cz0EC34aYZTd/hyEmP63ffYrF4Yun9gPNNpRSkx09IuI+8FiPaK+lfVyO4xNI46Y1drrEm0hfVKPhyE7f5oyaQHinNRu3nvFIDySu0M0cr9z7aucw/on7XE3h3f0C7mZ19zvbaxeIYLdUdt/XG5qWs3/M3SQ4g8X6OHrS2S98iaDNIpS8uln6/Syds+EiFt+Na33q59WF9WcaUzFE73NgcHr+6eAPzzzoHLNvYkv0EX3bfnJ+cfds/I2HqNGE9dtg56BzQUWmcn3G9wWn7g9HuhuthvVL9v/28VO8CPd77bqm4DKvYYNSHeod6w9afm3obX5ZuM1YY5wng4YGqyrVVqxUdf1+hpVXtbcbm3EoqP2HRWg9xovlO9KPW3LusX+L78FM/Uj2rSNp0alpzhn7FeoxlbIrL7c9kq9tVlradJGoEOA7D4Qbqk7351vL59OzN2dUZyxivyHCbi9ZpWLTWvxCDZyXb3sBGGeh/Wgc/i/DwEJe4q1UDH69+FKPWMUGTmW5Xq9V/AHBMXMg=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-2",custom_edit_url:null},G=void 0,g={},P=[];function D(e){const t={p:"p",...(0,c.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Delete Contact"}),"\n",(0,n.jsx)(i(),{method:"delete",path:"/contact/{contact_id}",context:"endpoint"}),"\n",(0,n.jsx)(t.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,n.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,n.jsx)(b.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,n.jsx)(l(),{...o(39903)}),"\n",(0,n.jsx)(p(),{...o(56949)}),"\n",(0,n.jsx)(m(),{...o(21531)})]})}function v(e={}){const{wrapper:t}={...(0,c.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(D,{...e})}):D(e)}},39903(e){e.exports=JSON.parse('{"parameters":[{"name":"contact_id","in":"path","description":"Provide objectId of contact to delete","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"ph2bh2asd"}}]}')},56949(e){e.exports={title:"Body"}},21531(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Contact deleted successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","example":"Bxh2aspHp3"},"deletedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"xml":{"name":"delete"},"title":"delete"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"Contact not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Contact not found!"}},"title":"inline_response_404_2"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/c7e3ab5f.1a2a72a9.js b/assets/js/c7e3ab5f.1a2a72a9.js deleted file mode 100644 index deb1a28b9..000000000 --- a/assets/js/c7e3ab5f.1a2a72a9.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[4833],{69222(e,t,o){o.r(t),o.d(t,{assets:()=>f,contentTitle:()=>k,default:()=>I,frontMatter:()=>v,metadata:()=>a,toc:()=>b});const a=JSON.parse('{"id":"API-docs/v1.1/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/v1.1/deletecontact.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/deletecontact","permalink":"/docs/API-docs/v1.1/deletecontact","draft":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJzVV81uIzcSfpVaXpIR2pLscbJYneKdGBMjRsaIHRhYj2Gwm6VuRmySIaslC4KAHPYN9rTXfbR5kkWxfyTZnkkGuwiQi60u1u9XxariRpAso5jdiTfOkiwoivtMKIxF0J60s2ImbiqEb9EgIXRMcHZ1AdIYt4qwdg2Qg4C1WyJIKDqWeXA1H4aekju3GMPFPElYB8bZEgNYRAUSvAyki8bIgf+LCNrOXagl+5EBVTomw7VcYARNgDKu2bZqnaMKdYCAhQtqLDLhPIYke6HETLRMnW6RCS+DrJEwcPQbYWWNYia68wetRCY0R+8lVeIpJFfBLbVCcPnPWNCFAjcfAh8cEpkI+EujAyoxo9BgJiKtDZuJuvaGGfDRG6dQzObSRGYoKqylmG0ErX3ipKBtKTLRIrFPwUeZtMyEr07y6kRGJbbbe7YavbMRI+s5mU7536H/fR5bRxXEpigwxnljzPovIkswoCUWlN4bXSQcJz9Hlt4897LFgVENjDrp1nYPz0vx7Lz/+yP77r/zr8U26/KkzujTQifTk9dHx9Oj6V9vjr+enf5t9tXX4+l0+g+RicfasGyXUSUJWS9pMrvv7TO2NmX7jB1ly8ynL6F47WqkStsSVmgJVsHZMgNvUEYECmuQpdQWjCQM/0dUMQQXPo3O53m23YtaW6MtPvQl9HA6nT4cDyCcfryUrCOYu8aqPzbSF8x/OpzTh5MhnK+eh3Nhl9JolRrNjVug/WPD2TdPrfnntapbpnQuDoLdp7dBRiyaoGmdmtzjkfT6qD2f3d1zr+A6cbv+mBojVWImJl0/m2x2PXErWGFY9k2zCUbMREXk42wyidKq3D2OnUcbdWmNzOO4cPVEej1ZHo+PxTZ7KiO9/yx+bI4+VySSLLUtf0vufofVNeezTdkBYkPipNff41pkfUL2ubqxUaFUGFLyeIol4S5N7zzaa13alORk/Ol4uUVTuBp5lFCFMBr1Ih/++Z9BajQC5YqmRkupHMfv7Xv7rgng3QrDvDEgrYK5wUedG0xiWKezYWhHlLXBGM0atCUsgyQEpUtN0gDjxB2kkF7m2miuYmZz7VTfuwhxDLcVUoWBj74IvAYoXKLh4gfZkOMZbsvBX1i5sJjz+pCBhLyJ2mKMgLaStmDGPhMZuADSAlrC4IOOCJECe61b35ylwNe/llaWyLoz2AdLodFcrhBc3kSC6EyTXAaS2riACvqAeBGJCcRzHsoBoV1eah+w4rJZIpSNVhgzKJxCiOnScghWQY6RwLMvusDIShtrXLFICeS5Ct5xD9HS8LKw7yOLU5A28ohvfelzMADmg+MBja2Do9FPETnDl9ou4mw0em+P4G6oq1vMoya8/7K/AqvV6lnpvzqUeavpuyaHH9G7qMmF9U661FQ1ebou+0qGj1bTW7SY6mfvMux0KFfE57ePqZMKjZ9cI3GFxMnZ1UVqu6/gw6//gkuUwULlVm21Fk1As4ayN8XItZlvYRu6JsxdKryKES/a4uNdDCP1CN5Wkj78+u8IP+AKtO2uFIcyGl01udEF3GDteUTG0WgGbwKySeppQJUkKKSFHCFWkktpqSWvsq200XYxhjO7hiZigJWmKhUD05PcQRiMy5DuCLmMqMDZJNHbHO88Ynod0Swxsi6efjkCKs3bHFXBNWVrbd+ZLriAc20M3GpVIqXYzpQC35FXLTmtsTt3cM4XgipcgwwIES2N4eqJSDppvHeBvdCt83PH7wROAFrlnbYUZ6CCnNNOf7Yr9IJhTvv+M1ILoRzgyDo1Q0ram9hFPFDH77kpP2nkh/024BwDG0xh7/LidVdOd31ZAlfr/1LWPK/7RwivBLXUpp0o3zzVk0Y7hjq+m19jWOoCu6n2kRs9ScwTkQmjC7QR91aGs7dXl7B8PZ6KbG88/o7LPbm8eHP+w/U5O8ONtAXseDwdT5nkXaRa2j1Lhy/Fp6Nts9ul/rTvym4JIHykiTdSpx0sgbrplqc7sXtnzvaelPeZqFwkZths+Ir/FMx2y+RfGgy8o91nYimDljlvCncboXTk32p4IH4UzS9/7N6ar+D3vk5fDKRfcSzvN0tpGv4SmVjg+vB9vL3fZv2aw662DGdFgZ72RJ8tzAdb57fnl+c35yIT3KwPN6xF2rC6H2zgRc8OV6/WB/7Le+CLAptNu71ttwN/e/RRiS7Gnpthut9ut/8FkbgOLw==","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Update Contact","permalink":"/docs/API-docs/v1.1/update-contact"},"next":{"title":"Get Contact list","permalink":"/docs/API-docs/v1.1/contactlist"}}');var n=o(74848),i=o(28453),r=o(57742),c=o.n(r),s=o(78178),l=o.n(s),p=o(19624),d=o.n(p),u=o(96226),m=o.n(u),h=(o(77675),o(19365),o(51107)),y=o(21312);const v={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:"eJzVV81uIzcSfpVaXpIR2pLscbJYneKdGBMjRsaIHRhYj2Gwm6VuRmySIaslC4KAHPYN9rTXfbR5kkWxfyTZnkkGuwiQi60u1u9XxariRpAso5jdiTfOkiwoivtMKIxF0J60s2ImbiqEb9EgIXRMcHZ1AdIYt4qwdg2Qg4C1WyJIKDqWeXA1H4aekju3GMPFPElYB8bZEgNYRAUSvAyki8bIgf+LCNrOXagl+5EBVTomw7VcYARNgDKu2bZqnaMKdYCAhQtqLDLhPIYke6HETLRMnW6RCS+DrJEwcPQbYWWNYia68wetRCY0R+8lVeIpJFfBLbVCcPnPWNCFAjcfAh8cEpkI+EujAyoxo9BgJiKtDZuJuvaGGfDRG6dQzObSRGYoKqylmG0ErX3ipKBtKTLRIrFPwUeZtMyEr07y6kRGJbbbe7YavbMRI+s5mU7536H/fR5bRxXEpigwxnljzPovIkswoCUWlN4bXSQcJz9Hlt4897LFgVENjDrp1nYPz0vx7Lz/+yP77r/zr8U26/KkzujTQifTk9dHx9Oj6V9vjr+enf5t9tXX4+l0+g+RicfasGyXUSUJWS9pMrvv7TO2NmX7jB1ly8ynL6F47WqkStsSVmgJVsHZMgNvUEYECmuQpdQWjCQM/0dUMQQXPo3O53m23YtaW6MtPvQl9HA6nT4cDyCcfryUrCOYu8aqPzbSF8x/OpzTh5MhnK+eh3Nhl9JolRrNjVug/WPD2TdPrfnntapbpnQuDoLdp7dBRiyaoGmdmtzjkfT6qD2f3d1zr+A6cbv+mBojVWImJl0/m2x2PXErWGFY9k2zCUbMREXk42wyidKq3D2OnUcbdWmNzOO4cPVEej1ZHo+PxTZ7KiO9/yx+bI4+VySSLLUtf0vufofVNeezTdkBYkPipNff41pkfUL2ubqxUaFUGFLyeIol4S5N7zzaa13alORk/Ol4uUVTuBp5lFCFMBr1Ih/++Z9BajQC5YqmRkupHMfv7Xv7rgng3QrDvDEgrYK5wUedG0xiWKezYWhHlLXBGM0atCUsgyQEpUtN0gDjxB2kkF7m2miuYmZz7VTfuwhxDLcVUoWBj74IvAYoXKLh4gfZkOMZbsvBX1i5sJjz+pCBhLyJ2mKMgLaStmDGPhMZuADSAlrC4IOOCJECe61b35ylwNe/llaWyLoz2AdLodFcrhBc3kSC6EyTXAaS2riACvqAeBGJCcRzHsoBoV1eah+w4rJZIpSNVhgzKJxCiOnScghWQY6RwLMvusDIShtrXLFICeS5Ct5xD9HS8LKw7yOLU5A28ohvfelzMADmg+MBja2Do9FPETnDl9ou4mw0em+P4G6oq1vMoya8/7K/AqvV6lnpvzqUeavpuyaHH9G7qMmF9U661FQ1ebou+0qGj1bTW7SY6mfvMux0KFfE57ePqZMKjZ9cI3GFxMnZ1UVqu6/gw6//gkuUwULlVm21Fk1As4ayN8XItZlvYRu6JsxdKryKES/a4uNdDCP1CN5Wkj78+u8IP+AKtO2uFIcyGl01udEF3GDteUTG0WgGbwKySeppQJUkKKSFHCFWkktpqSWvsq200XYxhjO7hiZigJWmKhUD05PcQRiMy5DuCLmMqMDZJNHbHO88Ynod0Swxsi6efjkCKs3bHFXBNWVrbd+ZLriAc20M3GpVIqXYzpQC35FXLTmtsTt3cM4XgipcgwwIES2N4eqJSDppvHeBvdCt83PH7wROAFrlnbYUZ6CCnNNOf7Yr9IJhTvv+M1ILoRzgyDo1Q0ram9hFPFDH77kpP2nkh/024BwDG0xh7/LidVdOd31ZAlfr/1LWPK/7RwivBLXUpp0o3zzVk0Y7hjq+m19jWOoCu6n2kRs9ScwTkQmjC7QR91aGs7dXl7B8PZ6KbG88/o7LPbm8eHP+w/U5O8ONtAXseDwdT5nkXaRa2j1Lhy/Fp6Nts9ul/rTvym4JIHykiTdSpx0sgbrplqc7sXtnzvaelPeZqFwkZths+Ir/FMx2y+RfGgy8o91nYimDljlvCncboXTk32p4IH4UzS9/7N6ar+D3vk5fDKRfcSzvN0tpGv4SmVjg+vB9vL3fZv2aw662DGdFgZ72RJ8tzAdb57fnl+c35yIT3KwPN6xF2rC6H2zgRc8OV6/WB/7Le+CLAptNu71ttwN/e/RRiS7Gnpthut9ut/8FkbgOLw==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},k=void 0,f={},b=[];function g(e){const t={p:"p",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Delete Contact"}),"\n",(0,n.jsx)(c(),{method:"delete",path:"/contact/{contact_id}",context:"endpoint"}),"\n",(0,n.jsx)(t.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,n.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,n.jsx)(y.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,n.jsx)(l(),{...o(39903)}),"\n",(0,n.jsx)(d(),{...o(56949)}),"\n",(0,n.jsx)(m(),{...o(21531)})]})}function I(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(g,{...e})}):g(e)}},39903(e){e.exports=JSON.parse('{"parameters":[{"name":"contact_id","in":"path","description":"Provide objectId of contact to delete","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"ph2bh2asd"}}]}')},56949(e){e.exports={title:"Body"}},21531(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Contact deleted successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","example":"Bxh2aspHp3"},"deletedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"xml":{"name":"delete"},"title":"delete"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"Contact not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Contact not found!"}},"title":"inline_response_404_2"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/d0524430.92382723.js b/assets/js/d0524430.92382723.js deleted file mode 100644 index 29831a65c..000000000 --- a/assets/js/d0524430.92382723.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[6235],{40707(e,n,t){t.r(n),t.d(n,{assets:()=>I,contentTitle:()=>g,default:()=>x,frontMatter:()=>N,metadata:()=>o,toc:()=>v});const o=JSON.parse('{"id":"API-docs/v1.1/save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.","source":"@site/docs/API-docs/v1.1/save-update-webhook.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/save-update-webhook","permalink":"/docs/API-docs/v1.1/save-update-webhook","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.","sidebar_label":"Save or Update Webhook","hide_title":true,"hide_table_of_contents":true,"api":"eJztWc1uIzcSfpUKB9jdCG3JnjjAQqcojnYirH8EW4axsAwP1V1SM6bIDsmWLAgCctg32NNe82jzJEGR3a2W7NFkZgJjMNBFP2RVsX4+FsmqJXN8Yln7lt3gKNX6gd1FLEEbG5E5oRVrs0GKYPkMQRvIs4Q7hIIWOv0ecCn13MJC5+B0IOQwLwiuL09hnoo4BWEht5gQjTNiMkEDOEPlbHOohurVq1fQ9X/b9LfROGrCTOAck3ajMVQHcJOiAg5WTBQaP2WBQ6LjfIrKReBSYYNAmAspyzWaQ/X27duhWg4VwJB5giFrw5AF6UMWhRm3yDBM/HRxcn3WPR/cD/7T71bzevQLxq6XbNH0fqooxkJuS7i+PK2mFZ9uT593ztYLKO2K+b5EbhEMkorAVeKtDhaWBldstVAF7momuMrS6C2NACzD16Y2V703593Lui6BAqdcyA2S7lmnd7pBk6VabYrp/3xx3h2yQLKir7tCneDvHxfvFVmSdIoADXpn3atB56xfzccGuXuWYKhWRaAJO6+bUJBugqd0HmGxIPgE4BSce+S8FHL+TNh3xRhcanQ+ScGlCInhYwcOp5mkRNbp9/YQ+MIgUKPJTU1K7/xNcMonYoRSw3fNcITsyAxhHkaL6rj5BIQEIV89QGiwAMaHYPFhUHwgK6zqK/8Fp8RxE2I9zSTuPCdqaJCywIP9lJRRLvXVY+LLOTfQODEWMS/NPOleDnr/6p10Bt0NR1Wx+XxQfd+EBGMpdmaYkuIzc0wpZo+ol0JU6fGdt9iS6PPAxCKmMzScnNJLWJvRw+pv4flVvtQiZvDXHK37UScL1l5uvdv6Rs9EgpAbSa+usCqsmWOtHCpHjDzLJG0UoVXrF0vcS2bjFKecftEqwmBCr8RrI+mFSFBj7QJRLGKZIW2dQEsMuZH0VRBZZ4SasIiNtZlyVx/BR05bj7VZ6lxm263WQufmoHg9HuRG/lCQNGM9ZatVxJxwnqGguR+R7asVTRm0mVY26PD68PCpS67yOEZrx7mEyrsf44ndZhu0uXTPWb62s3w5h0gmYCuN5OKbDQOFIhjdl0bdvz48vP9nYenxs8bpKbpUqAnMfRIxWk0iyMJOdGYBfMKFArr3mm/+OqvRGG12G/1xmu1ywvHh4f1R5YSjp06o/GskcGmQJwvAR2GdfVmTd+mx28Cj+3ll4PFTA68tGlDawVjnKnlZo7bX3m3IcWXG90/N6KkZlyLxFaSBfkD1spbUl3dheVL1ceoTF50s3iRP5OfZhqn18WCkxTg3wi1Y+3bJHg94Jg7CfPv2bnUXMdoAmvJ4pq3XmLuUtVlrXqVji2aGxnoBPoFWOdFylYz0Y1NnqOhElHxkKR+2eCZas6PmEVtF2zw8yz6KHvODj2Wxjk+EmnyI727tnCsKYIjRhouqSPFM/BsXLCojUKeKmCDgpMgTND5ahIvL9QnYLaO7rejuM4XkjrVXoojvRYbqiq4rhA5vxHZJ9AZlrKfoi5kpQqNRsrz77+8VV6NRXXU8jn2h8yI3kOk5GjqD6F40lvgoRtKXIgCnfm5dTUU+lWitXIBQDieGTvBETITj4TFCOTXmGR8JKQj+RKaJ20BtB9kmXUNdioam/m6oQpvgDCXtGuC501PuSFR1S51r8zCmum4EHEa5FQqtBVQpVzERlhGNqCjMFaByaDIjLIJ1hrQWQTetnOGxgylXfIKhVlt3VoJSEOzB6FFuHVgtc68yOC6kNqFi7A1SiEmoFncfM5oCGqXLu8GU4DdDmOQiQRtBrBMqWlOUyQSVwAitg4x0ETFaEporqeMHH0A6fiHTlHwEl6DHGzoSuzNcWbrABF3KGFQOy4ymcxyDgo3GtUWK8KlQD7Z4CdxWuLrBkRUO7/5RInQ+nz/ZQt9u8rwR7ud8BJeYaSucNos190S4NB/5bVcXUv0Jkt6gQo+f2qZay0h0bJ/uYhptpSiz1hU6Qohtdfo9n6+/hXe//Q9OkRsFqZ4HtMa5QbmASbkUeS5EPritSrcw1h54KXk8DuArLrOlB29S7t799n8L5zgHoYotRaY0Gv18JEUMg6KMZxuNNpyE+21Z2rPgUu4g5gpGCDblBKWZ4MAhC9xSqIcmdNSCGhMG5sKFEiGNe74NM/z7pQy3hRGnZoZWnqNcs7nWiManFuUMLcmiQ3OEgInYLkjWlSmMMzimB+CNSCbovG2dJIGsGJ6HYXJ4TR0c04ZwKS6AGwSLyjWhv8XiZ/Is04a0EEH5saYGDgUAVZJpQT2YokxayY/WQPfPCKHVM0PBhbxyR7RVbS12YmFxNdr0r52tA2Ez3xoco6EFvdnruGSigNNtCUsgtH4OrOlAoKzFY38P8U/IcDL9sC3H3wnQTO3F+ArNTMTlQ+Y9O7rliVssYlLEqCzW7hqdN/1TmH3XPGRR7fT6E5u7ddo76Z5fdUkZSqTBYUfNw+YhDdF1Y8pVbaWropV3vdHK2z7iluvL2L4BuC+e7BuA++7PvgG4h8C+AbhvAO4bgPsG4JeXNPYNwD2ivrIGYFEUdfjoWpnkwhehi95aqB/flm0w6smlVFlu37LlkooT10auVjT8a46GytJ3EZtxI/iIapy3d6uoLKVSwfkBF6zNTsKT72BACxO5zENVdqsWT7XgwNGJY8zcTtp68bt/cTVgERsV/cqpTojH8Dn1MvmctZnve/oCoO+o0diSSa4mOZ8QbZBJ1V+qHm2Wjh986bj4QVaVU2pR03CzphzMoE8y6lmG5TKUpVerij5MvZejcGxJTYG7W61WfwAQ6xsX","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Webhook","permalink":"/docs/API-docs/v1.1/get-webhook"},"next":{"title":"Delete Webhook","permalink":"/docs/API-docs/v1.1/delete-webhook"}}');var i=t(74848),s=t(28453),r=t(57742),a=t.n(r),d=t(78178),l=t.n(d),c=t(19624),h=t.n(c),p=t(96226),m=t.n(p),E=(t(77675),t(19365),t(51107)),u=t(21312);const N={id:"save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.",sidebar_label:"Save or Update Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJztWc1uIzcSfpUKB9jdCG3JnjjAQqcojnYirH8EW4axsAwP1V1SM6bIDsmWLAgCctg32NNe82jzJEGR3a2W7NFkZgJjMNBFP2RVsX4+FsmqJXN8Yln7lt3gKNX6gd1FLEEbG5E5oRVrs0GKYPkMQRvIs4Q7hIIWOv0ecCn13MJC5+B0IOQwLwiuL09hnoo4BWEht5gQjTNiMkEDOEPlbHOohurVq1fQ9X/b9LfROGrCTOAck3ajMVQHcJOiAg5WTBQaP2WBQ6LjfIrKReBSYYNAmAspyzWaQ/X27duhWg4VwJB5giFrw5AF6UMWhRm3yDBM/HRxcn3WPR/cD/7T71bzevQLxq6XbNH0fqooxkJuS7i+PK2mFZ9uT593ztYLKO2K+b5EbhEMkorAVeKtDhaWBldstVAF7momuMrS6C2NACzD16Y2V703593Lui6BAqdcyA2S7lmnd7pBk6VabYrp/3xx3h2yQLKir7tCneDvHxfvFVmSdIoADXpn3atB56xfzccGuXuWYKhWRaAJO6+bUJBugqd0HmGxIPgE4BSce+S8FHL+TNh3xRhcanQ+ScGlCInhYwcOp5mkRNbp9/YQ+MIgUKPJTU1K7/xNcMonYoRSw3fNcITsyAxhHkaL6rj5BIQEIV89QGiwAMaHYPFhUHwgK6zqK/8Fp8RxE2I9zSTuPCdqaJCywIP9lJRRLvXVY+LLOTfQODEWMS/NPOleDnr/6p10Bt0NR1Wx+XxQfd+EBGMpdmaYkuIzc0wpZo+ol0JU6fGdt9iS6PPAxCKmMzScnNJLWJvRw+pv4flVvtQiZvDXHK37UScL1l5uvdv6Rs9EgpAbSa+usCqsmWOtHCpHjDzLJG0UoVXrF0vcS2bjFKecftEqwmBCr8RrI+mFSFBj7QJRLGKZIW2dQEsMuZH0VRBZZ4SasIiNtZlyVx/BR05bj7VZ6lxm263WQufmoHg9HuRG/lCQNGM9ZatVxJxwnqGguR+R7asVTRm0mVY26PD68PCpS67yOEZrx7mEyrsf44ndZhu0uXTPWb62s3w5h0gmYCuN5OKbDQOFIhjdl0bdvz48vP9nYenxs8bpKbpUqAnMfRIxWk0iyMJOdGYBfMKFArr3mm/+OqvRGG12G/1xmu1ywvHh4f1R5YSjp06o/GskcGmQJwvAR2GdfVmTd+mx28Cj+3ll4PFTA68tGlDawVjnKnlZo7bX3m3IcWXG90/N6KkZlyLxFaSBfkD1spbUl3dheVL1ceoTF50s3iRP5OfZhqn18WCkxTg3wi1Y+3bJHg94Jg7CfPv2bnUXMdoAmvJ4pq3XmLuUtVlrXqVji2aGxnoBPoFWOdFylYz0Y1NnqOhElHxkKR+2eCZas6PmEVtF2zw8yz6KHvODj2Wxjk+EmnyI727tnCsKYIjRhouqSPFM/BsXLCojUKeKmCDgpMgTND5ahIvL9QnYLaO7rejuM4XkjrVXoojvRYbqiq4rhA5vxHZJ9AZlrKfoi5kpQqNRsrz77+8VV6NRXXU8jn2h8yI3kOk5GjqD6F40lvgoRtKXIgCnfm5dTUU+lWitXIBQDieGTvBETITj4TFCOTXmGR8JKQj+RKaJ20BtB9kmXUNdioam/m6oQpvgDCXtGuC501PuSFR1S51r8zCmum4EHEa5FQqtBVQpVzERlhGNqCjMFaByaDIjLIJ1hrQWQTetnOGxgylXfIKhVlt3VoJSEOzB6FFuHVgtc68yOC6kNqFi7A1SiEmoFncfM5oCGqXLu8GU4DdDmOQiQRtBrBMqWlOUyQSVwAitg4x0ETFaEporqeMHH0A6fiHTlHwEl6DHGzoSuzNcWbrABF3KGFQOy4ymcxyDgo3GtUWK8KlQD7Z4CdxWuLrBkRUO7/5RInQ+nz/ZQt9u8rwR7ud8BJeYaSucNos190S4NB/5bVcXUv0Jkt6gQo+f2qZay0h0bJ/uYhptpSiz1hU6Qohtdfo9n6+/hXe//Q9OkRsFqZ4HtMa5QbmASbkUeS5EPritSrcw1h54KXk8DuArLrOlB29S7t799n8L5zgHoYotRaY0Gv18JEUMg6KMZxuNNpyE+21Z2rPgUu4g5gpGCDblBKWZ4MAhC9xSqIcmdNSCGhMG5sKFEiGNe74NM/z7pQy3hRGnZoZWnqNcs7nWiManFuUMLcmiQ3OEgInYLkjWlSmMMzimB+CNSCbovG2dJIGsGJ6HYXJ4TR0c04ZwKS6AGwSLyjWhv8XiZ/Is04a0EEH5saYGDgUAVZJpQT2YokxayY/WQPfPCKHVM0PBhbxyR7RVbS12YmFxNdr0r52tA2Ez3xoco6EFvdnruGSigNNtCUsgtH4OrOlAoKzFY38P8U/IcDL9sC3H3wnQTO3F+ArNTMTlQ+Y9O7rliVssYlLEqCzW7hqdN/1TmH3XPGRR7fT6E5u7ddo76Z5fdUkZSqTBYUfNw+YhDdF1Y8pVbaWropV3vdHK2z7iluvL2L4BuC+e7BuA++7PvgG4h8C+AbhvAO4bgPsG4JeXNPYNwD2ivrIGYFEUdfjoWpnkwhehi95aqB/flm0w6smlVFlu37LlkooT10auVjT8a46GytJ3EZtxI/iIapy3d6uoLKVSwfkBF6zNTsKT72BACxO5zENVdqsWT7XgwNGJY8zcTtp68bt/cTVgERsV/cqpTojH8Dn1MvmctZnve/oCoO+o0diSSa4mOZ8QbZBJ1V+qHm2Wjh986bj4QVaVU2pR03CzphzMoE8y6lmG5TKUpVerij5MvZejcGxJTYG7W61WfwAQ6xsX",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},g=void 0,I={},v=[{value:"Events:",id:"events",level:3}];function M(e){const n={code:"code",h3:"h3",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(E.default,{as:"h1",className:"openapi__heading",children:"Save or Update Webhook"}),"\n",(0,i.jsx)(a(),{method:"post",path:"/webhook",context:"endpoint"}),"\n",(0,i.jsx)(n.p,{children:"The save or update Webhook API allows you to save a webhook URL which is used to trigger events."}),"\n",(0,i.jsx)(n.h3,{id:"events",children:"Events:"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"1. viewed:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"When a signer views a document, this event will trigger."}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "event": "viewed",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "viewedBy": "SIGNER_EMAIL",\n "viewedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"2. created:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"When a document is created, this event will trigger."}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"When a document is created through the draft template API, this event will trigger."}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE",\n "url": "SIGNING_URL"\n }\n ],\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"3. signed:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"When a document is signed by a signer, this event will trigger."}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "event": "signed",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signer": {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n },\n "signedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"4. completed:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"When a document is signed by all signers, this event will trigger."}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "event": "completed",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "certificate": "CERTIFICATE_URL",\n "completedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"5. declined:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"When a document is declined by a signer, this event will trigger."}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "event": "declined",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "declinedBy": "SIGNER_EMAIL",\n "declinedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,i.jsx)(E.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,i.jsx)(u.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,i.jsx)(l(),{parameters:void 0}),"\n",(0,i.jsx)(h(),{...t(51637)}),"\n",(0,i.jsx)(m(),{...t(39067)})]})}function x(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(M,{...e})}):M(e)}},51637(e){e.exports=JSON.parse('{"title":"Body","body":{"description":"Provide url to create Webhook","content":{"application/json":{"schema":{"required":["Url"],"type":"object","properties":{"url":{"type":"string","format":"string","example":"https://your-webhook-url@example.com"}},"title":"webhook_body"}}}}}')},39067(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Webhook updated successfully!"}},"title":"inline_response_200_8"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"401":{"description":"Webhook url already exists!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Webhook url already exists!"}},"title":"inline_response_401_w"}}}},"404":{"description":"User not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"User not found!"}},"title":"inline_response_404"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/d0524430.cfa8565c.js b/assets/js/d0524430.cfa8565c.js new file mode 100644 index 000000000..7c353dced --- /dev/null +++ b/assets/js/d0524430.cfa8565c.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[6235],{40707(e,n,t){t.r(n),t.d(n,{assets:()=>u,contentTitle:()=>E,default:()=>b,frontMatter:()=>m,metadata:()=>i,toc:()=>D});const i=JSON.parse('{"id":"API-docs/v1.1/save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.","source":"@site/docs/API-docs/v1.1/save-update-webhook.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/save-update-webhook","permalink":"/docs/API-docs/v1.1/save-update-webhook","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.","sidebar_label":"Save or Update Webhook","hide_title":true,"hide_table_of_contents":true,"api":"eJztGttuG8f1V07WQGARvEiOAxRMkUamaVmoLROiVKMQBXG4e8idajizmZklRUgE8lD0A4q+9LU/0fd+ir+kOHNZXuTQsR0YQaAHW9LMmTPnNue25zaxbGKS9kXyFke5UtfJZT3J0KSaF5YrmbSTsxzBsBmC0lAWGbMIARYOe8fAhFBzAwtVglUekME8AJyfvoJ5ztMcuIHSYEYwVvPJBDXgDKU1zYEcyEePHkHX/dmmP2u1gybMOM4xa9dqA9mAtzlKYGD4RKJ2WwYYZCotpyhtHWzOjUcIcy5EvKM5kMPhcCBvBxJgkDiAQdKGQeKxD5K637GLAv3G8zed89fdk7Ors7/2utW+Gv0NU3ucbcEcP68gxlxsYzg/fVVtSzbd3j45fL26QCob9nsCmUHQSCQCk5nj2nMYGa6OranKn652vKgMrV7QCsCt/7FJTf/46KR7uk6Lh8Ap42IDpPv68PjVBkyRK7mJpvfyzUl3kHiQJf24DOR4eT9b/CzKCHIYFHR2/LrbPzt83av2U43MvhdgIJdB0WQ7T5oQQDeNJwqPbDEAfILhhJMPlvOlLOeXqH2XjsHmWpWTHGyOkGk2tmBxWghyZIe94wcT+I2ZwBpMqdewHJ8ceaF8oo2Qa/im6UPIDs/g92G0qMLNJ1iIR/K7NxBaDIbxIbP4sFF8wCss12/+FaLE0yakaloI3Bkn1qxBiGAP5lNcRrzqd28Tv524gdryMU9ZZLPTPT07fnHcOTzrbgiq0s3nG9W3TcgwFXynh4kQn+ljIpoHi/pSFhUlvjOLjUCfZ0xJPVEFakZCOc6SdkKF1de+/IqVWj3R+GOJxj5T2SJp327VbT2tZjxDKLWgqsvfCqvDqZIWpaWDrCgEPRSuZOtvhk7fJibNccroN7qFa8yoSjzXgipEMrWkHSwqqSeFJmotR0MHSi3oRwAyVnM5SerJWOkps+sreMPo6SXtJLe2MO1Wa6FK3QjVY6PU4ocA0kzVNFku64nl1h0IMFcj4n25pC2NplDSeBqe7O/fF0m/TFM0ZlwKqKT7MZLYzbZGUwr7Ps5XfMbK2WsyA1NRJBZfbTDIJZnRVWTq6sn+/tUfAqdP38ucmqLNuZzA3DkRreSkDoV/iVYvgE0Yl0B5r/7q1+MatVZ6N9MfR9kuITzd3786qIRwcF8IlXy1ACY0smwBeMONNV+W5V107Gbw4GpeMfj0PoPnBjVIZWGsSpl9Waa2797NyNOKjW/vs3EsZ0zwzHWQztQ1yi/Lyfr11l9PpN5MneOiyOJYckBuP9lgdX3dM2kwLTW3i6R9cZvcNFjBG36/fXG5vKwn9AAU+fFCGUcxs3nSTlrzyh0b1DPUxiFwDrTyiYbJbKRumqpASRFRsJEhf9hiBW/NDppPkmV9+wwrio+Cx7LxsUeMZRMuJx86d7kSTp8U6HW0IaJKU6zgf8ZFUo8aWIeqJ5wMJ0eWoXbaIrs4XUXAbtTuNqG7YwrhHStHRNDvmwJln9IVsg7HxHZL9BFEmHd//08FRing91CrUcOUBNIwqtQpwnOVlg4fExa1ZJbPEN799C8YlVzQY9KQ4QwF2TDVFro01meHKC3qQnODpknp5ECu3zvhM/SNV1aVMnUotMrKlAhtBLfTIM0wW2oE6npQGK56IpR/yonAOpx2+2cUGA97x03oo8yqRM04EiskdZgyySZYdVEczSy9diDk5Y1ltjTAJWhkAiyfYt0lgay0akpZCKmEuOMaV6mx4GNMF6nwwqF6a85trkoLM5SZ0iBUet3g0nWMG42GbxzDEVpLt/Yt01RgyYHszlAvIGRHMC2NhZRpvfD3Vo+eKKSm0HDNzobgLcxd4lKxtc02/NEZU7Xw/Vru/+4f/4SLl2pOydYEJaUXuHXh5eNok5lKzf1XQ6utHEXR6numTOuwd+z8457X/4myYEiT8xw10lUjnHD5JzinUJoj1GrBXQDKGddKkmhrNXg8/MXuZLhHeAutrKJ3WWmBjceYOlELsuCMWbalio7SCB1WsBEXnNwxrd9Bh1mcKL2AO3ibM+tMNmUSMgV3A3nXaDTcPwKt1Z5Hq6vV4A46Lmutg0GZ1UPWVKe6Ql0Hm8qQ7H5lno2o9pX5Bsxn0V4d5mclFxloLA0biTVjduxCobFRCJZiBnOeTdCa7xwNJBkl3beQKZOL2BGIV/RRjBv0Pt0VR9EKDC2HVsKKrEqu8bMGlzNuXcyDsVDziLRXjgRPYZP8fs40fWkp/GZ8eoLLa/d8pIpYBTcWYg4fcT53fdC3Sl/TTR4jfbpZUaf0mkyY8Z1T40Q+5pIJ7g1u6tO2iLejpGVpUN5r7yfcGwjEpH4fRpQcFVpNNJtOmeUpE2IRkbxQIkPtcbzREybprhVlXBqqayo3/VyTOY79oYgjJGAeySmmSDDkjhrkjkKhLVXoEHAlDXjL1KDmElBmheLSRnSU+kRcVnOkr1xpqkppnURSjRm3QJGEahzS4N3m0yDDf/fTvw2c4Jz8TgwY/tvXobUszZ0XfOvMDfplUShtB5KiyZBV+2YYDJI6CVLNwXhAzEDJ0N5efRYLRd9qYbP/XQGsFoibYFPrXfLVZ7qXJPu+12Y/WN0rLq/NQPbRwnCQ5DzDK6/vq2CXV8JBJG2Kbgh3MGbC4JBIHvbe9M+g5QiLdA7pmRGaaDbr5m2i295kFmLq2VyJtSOQ0fH4dKLymBjI4VH3DFqRx1abZ0PH/OY6PZ4h5PQ0RogSjNXIpr59Q89MY1bKjEkLBdNsipZMkF6mxqmaYeZQ1mqFxjE1dchnRsVptKUmPAbprEWxgLFW08jzCmGtRjH3mgRQ1biAzHDUrrJX0pRTrDTUY8bMlc4aPa0spmQavecvVhZF+6Qn6vZcFQF4kAyjXKMDpdKa4oyEudLuducaUaZ6UQSsphnxOgNsD2TQpzesKMYh/O+/MOyd35O4W147ELXZake4q02wLTvZ2ti6z22Q8yWRDqN83ozHpMDKeslnaSUq+3VftK+Uh3IWvMtwtxl1NvQeTq0CvKGihltBmZ2LOpT6cR+Awn2VqVPOhSzNq2dY6Tc8vlMlKMA6/xDC0BB8SeTsi6UpFuSxiafwHLWiBt8QxhxFBizVyhiXaTkuyG1pVVo0TTjLNSIQvLfnys20fUyn2ymKYs5mnLzmdiQPNA2h9jjDMSuF3XMxwSVjIVsll0tdAOti6ipNDR7O43GfhfVw5caNf/3x3ZOgQqNRSbGI0S+EbT+fEAPfkBWFVjOPrsOkf9kUyCM43pDUQkz21ITY6S67q1wL0yMloaOKBTzudPaIOF5w8tADeQgS5yT2NF1J+56/ZkLJiQtlxI/rDpDih4NktH6O3PpqzqFy1N77udZqzC4qLbbCnEZUZpcaocCyTKMh30FeDTN67xWNOoRIRpnySMlGSpytB0hw7VRQMsVNBdCn1thCb8Irfo0rHupE/gY18NiUaU4ZhX8lqxfPs+Ee5QQzngU5eNJIX5pnQe9VVJoxUWLdRXLvpUiygpNgKU0BnBZ2AUxrtoDHw4vL4d53oKbcOixetFYBlznqsLiJeiu3PZwxLtxL7a4S65Dgrq3Qm6C2Fk2+3E9u+z73donERyTkVSZY1XabGHaW4NXp7jmc4uTe4Q+V/sPtVOYvqA1Xzkl9Dc9Yej1nOjPQUdOCWe5S/wWB0mEyDtfchFEEbKQBUPjSAmYHzoxnB82DqvKL+ZfxIdHmyiDM/MXeIbFKHyp8WBhFuTusUsFIo4+aac7khB4CJV9rgZqT48/K1L8FRy+hVq7OZwJKKdAYUDZHPacklL5wZFuGcW6Q6uaQA9E3n4sqNX2LI8Mtruq++Xx+T9J77syLUgiIxY97cB+oFv2xI25fliM4xUIZbpVerE5NuM3LkdPl+tnqj4AgFilVK+5zqlSH8gz11IAaQx/1jKcfYL9lCby15z56bPWFNtsuGseoye+YjRqbFTzU8xeRDiDyPocP6guFWsW1FMn1+QbVD9t4XGuQWHgzDvyG3tNufpN6IniK0uBay/HwqPcKZt8095P6WhPrF+iy9eq40z3pd4mY8EySdnLQ3G/u0xJ1HadMrt3UDxN95xsTfdudrttVT/ZhDvDhG+rDHODDENjDHOCDCTzMAT7MAT7MAT7MAf72nMbDHOCDRf3O5gDDbITFG9sqBONuFiWM2Pkxkos4DUejeTkNmLQvkttb6oeca7Fc0vKPJWqaTrmsJzOmOTVO3GxKPU5U0NzJNS6SdtLxJV/jjC4mcFH64YytkRwaCfEnDl2reSfs+gwMNc6TejIKY4tTldEZzeY00sjmSTtx44/uq5wbrKO120QwOSnZhGA9ThoCYSVJYH2C5NpNkIRfiKu4JRdrFG6Olng26H9i6r0Hbm/9dMpyWcH7rZ89EQQboUlxl8vl8v+uOmmw","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Webhook","permalink":"/docs/API-docs/v1.1/get-webhook"},"next":{"title":"Delete Webhook","permalink":"/docs/API-docs/v1.1/delete-webhook"}}');var s=t(74848),o=t(28453),r=t(57742),a=t.n(r),l=t(78178),d=t.n(l),p=t(19624),c=t.n(p),h=t(96226),M=t.n(h),N=(t(77675),t(19365),t(51107)),T=t(21312);const m={id:"save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.",sidebar_label:"Save or Update Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJztGttuG8f1V07WQGARvEiOAxRMkUamaVmoLROiVKMQBXG4e8idajizmZklRUgE8lD0A4q+9LU/0fd+ir+kOHNZXuTQsR0YQaAHW9LMmTPnNue25zaxbGKS9kXyFke5UtfJZT3J0KSaF5YrmbSTsxzBsBmC0lAWGbMIARYOe8fAhFBzAwtVglUekME8AJyfvoJ5ztMcuIHSYEYwVvPJBDXgDKU1zYEcyEePHkHX/dmmP2u1gybMOM4xa9dqA9mAtzlKYGD4RKJ2WwYYZCotpyhtHWzOjUcIcy5EvKM5kMPhcCBvBxJgkDiAQdKGQeKxD5K637GLAv3G8zed89fdk7Ors7/2utW+Gv0NU3ucbcEcP68gxlxsYzg/fVVtSzbd3j45fL26QCob9nsCmUHQSCQCk5nj2nMYGa6OranKn652vKgMrV7QCsCt/7FJTf/46KR7uk6Lh8Ap42IDpPv68PjVBkyRK7mJpvfyzUl3kHiQJf24DOR4eT9b/CzKCHIYFHR2/LrbPzt83av2U43MvhdgIJdB0WQ7T5oQQDeNJwqPbDEAfILhhJMPlvOlLOeXqH2XjsHmWpWTHGyOkGk2tmBxWghyZIe94wcT+I2ZwBpMqdewHJ8ceaF8oo2Qa/im6UPIDs/g92G0qMLNJ1iIR/K7NxBaDIbxIbP4sFF8wCss12/+FaLE0yakaloI3Bkn1qxBiGAP5lNcRrzqd28Tv524gdryMU9ZZLPTPT07fnHcOTzrbgiq0s3nG9W3TcgwFXynh4kQn+ljIpoHi/pSFhUlvjOLjUCfZ0xJPVEFakZCOc6SdkKF1de+/IqVWj3R+GOJxj5T2SJp327VbT2tZjxDKLWgqsvfCqvDqZIWpaWDrCgEPRSuZOtvhk7fJibNccroN7qFa8yoSjzXgipEMrWkHSwqqSeFJmotR0MHSi3oRwAyVnM5SerJWOkps+sreMPo6SXtJLe2MO1Wa6FK3QjVY6PU4ocA0kzVNFku64nl1h0IMFcj4n25pC2NplDSeBqe7O/fF0m/TFM0ZlwKqKT7MZLYzbZGUwr7Ps5XfMbK2WsyA1NRJBZfbTDIJZnRVWTq6sn+/tUfAqdP38ucmqLNuZzA3DkRreSkDoV/iVYvgE0Yl0B5r/7q1+MatVZ6N9MfR9kuITzd3786qIRwcF8IlXy1ACY0smwBeMONNV+W5V107Gbw4GpeMfj0PoPnBjVIZWGsSpl9Waa2797NyNOKjW/vs3EsZ0zwzHWQztQ1yi/Lyfr11l9PpN5MneOiyOJYckBuP9lgdX3dM2kwLTW3i6R9cZvcNFjBG36/fXG5vKwn9AAU+fFCGUcxs3nSTlrzyh0b1DPUxiFwDrTyiYbJbKRumqpASRFRsJEhf9hiBW/NDppPkmV9+wwrio+Cx7LxsUeMZRMuJx86d7kSTp8U6HW0IaJKU6zgf8ZFUo8aWIeqJ5wMJ0eWoXbaIrs4XUXAbtTuNqG7YwrhHStHRNDvmwJln9IVsg7HxHZL9BFEmHd//08FRing91CrUcOUBNIwqtQpwnOVlg4fExa1ZJbPEN799C8YlVzQY9KQ4QwF2TDVFro01meHKC3qQnODpknp5ECu3zvhM/SNV1aVMnUotMrKlAhtBLfTIM0wW2oE6npQGK56IpR/yonAOpx2+2cUGA97x03oo8yqRM04EiskdZgyySZYdVEczSy9diDk5Y1ltjTAJWhkAiyfYt0lgay0akpZCKmEuOMaV6mx4GNMF6nwwqF6a85trkoLM5SZ0iBUet3g0nWMG42GbxzDEVpLt/Yt01RgyYHszlAvIGRHMC2NhZRpvfD3Vo+eKKSm0HDNzobgLcxd4lKxtc02/NEZU7Xw/Vru/+4f/4SLl2pOydYEJaUXuHXh5eNok5lKzf1XQ6utHEXR6numTOuwd+z8457X/4myYEiT8xw10lUjnHD5JzinUJoj1GrBXQDKGddKkmhrNXg8/MXuZLhHeAutrKJ3WWmBjceYOlELsuCMWbalio7SCB1WsBEXnNwxrd9Bh1mcKL2AO3ibM+tMNmUSMgV3A3nXaDTcPwKt1Z5Hq6vV4A46Lmutg0GZ1UPWVKe6Ql0Hm8qQ7H5lno2o9pX5Bsxn0V4d5mclFxloLA0biTVjduxCobFRCJZiBnOeTdCa7xwNJBkl3beQKZOL2BGIV/RRjBv0Pt0VR9EKDC2HVsKKrEqu8bMGlzNuXcyDsVDziLRXjgRPYZP8fs40fWkp/GZ8eoLLa/d8pIpYBTcWYg4fcT53fdC3Sl/TTR4jfbpZUaf0mkyY8Z1T40Q+5pIJ7g1u6tO2iLejpGVpUN5r7yfcGwjEpH4fRpQcFVpNNJtOmeUpE2IRkbxQIkPtcbzREybprhVlXBqqayo3/VyTOY79oYgjJGAeySmmSDDkjhrkjkKhLVXoEHAlDXjL1KDmElBmheLSRnSU+kRcVnOkr1xpqkppnURSjRm3QJGEahzS4N3m0yDDf/fTvw2c4Jz8TgwY/tvXobUszZ0XfOvMDfplUShtB5KiyZBV+2YYDJI6CVLNwXhAzEDJ0N5efRYLRd9qYbP/XQGsFoibYFPrXfLVZ7qXJPu+12Y/WN0rLq/NQPbRwnCQ5DzDK6/vq2CXV8JBJG2Kbgh3MGbC4JBIHvbe9M+g5QiLdA7pmRGaaDbr5m2i295kFmLq2VyJtSOQ0fH4dKLymBjI4VH3DFqRx1abZ0PH/OY6PZ4h5PQ0RogSjNXIpr59Q89MY1bKjEkLBdNsipZMkF6mxqmaYeZQ1mqFxjE1dchnRsVptKUmPAbprEWxgLFW08jzCmGtRjH3mgRQ1biAzHDUrrJX0pRTrDTUY8bMlc4aPa0spmQavecvVhZF+6Qn6vZcFQF4kAyjXKMDpdKa4oyEudLuducaUaZ6UQSsphnxOgNsD2TQpzesKMYh/O+/MOyd35O4W147ELXZake4q02wLTvZ2ti6z22Q8yWRDqN83ozHpMDKeslnaSUq+3VftK+Uh3IWvMtwtxl1NvQeTq0CvKGihltBmZ2LOpT6cR+Awn2VqVPOhSzNq2dY6Tc8vlMlKMA6/xDC0BB8SeTsi6UpFuSxiafwHLWiBt8QxhxFBizVyhiXaTkuyG1pVVo0TTjLNSIQvLfnys20fUyn2ymKYs5mnLzmdiQPNA2h9jjDMSuF3XMxwSVjIVsll0tdAOti6ipNDR7O43GfhfVw5caNf/3x3ZOgQqNRSbGI0S+EbT+fEAPfkBWFVjOPrsOkf9kUyCM43pDUQkz21ITY6S67q1wL0yMloaOKBTzudPaIOF5w8tADeQgS5yT2NF1J+56/ZkLJiQtlxI/rDpDih4NktH6O3PpqzqFy1N77udZqzC4qLbbCnEZUZpcaocCyTKMh30FeDTN67xWNOoRIRpnySMlGSpytB0hw7VRQMsVNBdCn1thCb8Irfo0rHupE/gY18NiUaU4ZhX8lqxfPs+Ee5QQzngU5eNJIX5pnQe9VVJoxUWLdRXLvpUiygpNgKU0BnBZ2AUxrtoDHw4vL4d53oKbcOixetFYBlznqsLiJeiu3PZwxLtxL7a4S65Dgrq3Qm6C2Fk2+3E9u+z73donERyTkVSZY1XabGHaW4NXp7jmc4uTe4Q+V/sPtVOYvqA1Xzkl9Dc9Yej1nOjPQUdOCWe5S/wWB0mEyDtfchFEEbKQBUPjSAmYHzoxnB82DqvKL+ZfxIdHmyiDM/MXeIbFKHyp8WBhFuTusUsFIo4+aac7khB4CJV9rgZqT48/K1L8FRy+hVq7OZwJKKdAYUDZHPacklL5wZFuGcW6Q6uaQA9E3n4sqNX2LI8Mtruq++Xx+T9J77syLUgiIxY97cB+oFv2xI25fliM4xUIZbpVerE5NuM3LkdPl+tnqj4AgFilVK+5zqlSH8gz11IAaQx/1jKcfYL9lCby15z56bPWFNtsuGseoye+YjRqbFTzU8xeRDiDyPocP6guFWsW1FMn1+QbVD9t4XGuQWHgzDvyG3tNufpN6IniK0uBay/HwqPcKZt8095P6WhPrF+iy9eq40z3pd4mY8EySdnLQ3G/u0xJ1HadMrt3UDxN95xsTfdudrttVT/ZhDvDhG+rDHODDENjDHOCDCTzMAT7MAT7MAT7MAf72nMbDHOCDRf3O5gDDbITFG9sqBONuFiWM2Pkxkos4DUejeTkNmLQvkttb6oeca7Fc0vKPJWqaTrmsJzOmOTVO3GxKPU5U0NzJNS6SdtLxJV/jjC4mcFH64YytkRwaCfEnDl2reSfs+gwMNc6TejIKY4tTldEZzeY00sjmSTtx44/uq5wbrKO120QwOSnZhGA9ThoCYSVJYH2C5NpNkIRfiKu4JRdrFG6Olng26H9i6r0Hbm/9dMpyWcH7rZ89EQQboUlxl8vl8v+uOmmw",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-2",custom_edit_url:null},E=void 0,u={},D=[{value:"Events:",id:"events",level:3}];function x(e){const n={code:"code",h3:"h3",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(N.default,{as:"h1",className:"openapi__heading",children:"Save or Update Webhook"}),"\n",(0,s.jsx)(a(),{method:"post",path:"/webhook",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The save or update Webhook API allows you to save a webhook URL which is used to trigger events."}),"\n",(0,s.jsx)(n.h3,{id:"events",children:"Events:"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"1. viewed:"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"When a signer views a document, this event will trigger."}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "event": "viewed",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "viewedBy": "SIGNER_EMAIL",\n "viewedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"2. created:"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"When a document is created, this event will trigger."}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"When a document is created through the draft template API, this event will trigger."}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE",\n "url": "SIGNING_URL"\n }\n ],\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"3. signed:"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"When a document is signed by a signer, this event will trigger."}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "event": "signed",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signer": {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n },\n "signedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"4. completed:"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"When a document is signed by all signers, this event will trigger."}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "event": "completed",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "certificate": "CERTIFICATE_URL",\n "completedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"5. declined:"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"When a document is declined by a signer, this event will trigger."}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "event": "declined",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "declinedBy": "SIGNER_EMAIL",\n "declinedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,s.jsx)(N.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(T.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(c(),{...t(51637)}),"\n",(0,s.jsx)(M(),{...t(39067)})]})}function b(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(x,{...e})}):x(e)}},51637(e){e.exports=JSON.parse('{"title":"Body","body":{"description":"Provide url to create Webhook","content":{"application/json":{"schema":{"required":["Url"],"type":"object","properties":{"url":{"type":"string","format":"string","example":"https://your-webhook-url@example.com"}},"title":"webhook_body"}}}}}')},39067(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Webhook updated successfully!"}},"title":"inline_response_200_8"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"401":{"description":"Webhook url already exists!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Webhook url already exists!"}},"title":"inline_response_401_w"}}}},"404":{"description":"User not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"User not found!"}},"title":"inline_response_404"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/d480dde9.2ba7de5a.js b/assets/js/d480dde9.2ba7de5a.js deleted file mode 100644 index dc3ee5595..000000000 --- a/assets/js/d480dde9.2ba7de5a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[3230],{29737(e,t,o){o.r(t),o.d(t,{assets:()=>m,contentTitle:()=>W,default:()=>I,frontMatter:()=>u,metadata:()=>l,toc:()=>E});const l=JSON.parse('{"id":"API-docs/v1.1/delete-webhook","title":"Delete Webhook","description":"The Delete Webhook API allow you to delete webhook url","source":"@site/docs/API-docs/v1.1/delete-webhook.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/delete-webhook","permalink":"/docs/API-docs/v1.1/delete-webhook","draft":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJy9VktvGzcQ/isTXtoIa0lJ00N1qpEYqVEjMWoHPthCwN0daRlxSYYzK1kQBOTQf9BTr/1p+SXFcLV6OUmbtuhFj+G855vHSrGekhrdqhvMK+9napypEqmIJrDxTo3UdYXwAi0ywoYHTi/PQVvrF7D0DbCHsn1fbN6baFWmfMCoRcl5qUaqZemsZCoiBe8ISY1W6ulwKF+Hhq+aokCiSWNhq0plqvCO0bHw6xCsKdLD4B2J0EpRUWGt5RcvA6qR8vk7LFhlKkRRw6Y1GZEay3t8xNG4qcoU3us6WCF18ba+l0Bbj+zykVqvM8WGE6dx1jh82wX19ulw+PYHtV4Lz7Phs4fBvSGM4DzDxDeufPTfxYUx+vjlsI5tfykQcb4L4/uHYZy7ubamTIi49jN0/28k++a5NS+u3tdW5Jyu25ASU3pXB6Hu09sgCYsmGl6q0e1K3Z/oYE7a99HteD3OVI1c+R2cxWfNlRqpwWKLbMI4x0hJhXTCSFXMgUaDAWlX5v6+7wM6MlNndU79wtcDHcxg/qT/RK2zYxkdwlfxY3PytSLEemrc9K/kxrv0XEkJ2yodJGlbKx3Mz7hUWVeDfa5MGYFOhbrEmOpl3MQn4U1lXgd0V2bqUl2T8eOhdIO28DXK7OEKodfrRD7++sdWqteD0hdNjY4TAvt37s69biIEv8Aoc0W7EiYW701uMYlhnd6oG2yEurZIZJdgHOM0akYozdSwtiB5Mm4KhQ46N9YIcIXNi3SEPexTH24q5AqjPH0TETSUOEcreAfdsK81i6rOX1j4OJtYv6AMNOQNGYdEgK7SrhDGrhIZ+AjaATrGGKIhBOIoXpvWN+846oKh1k5PUXRnsJ+sEq0RuEL0eUMM5G2TXAbWxvqIJXQBOcSSUhLP7oM8gVALX4eIlcBmjjBtTImUQeFLBEp9KiG4EnIkhiC+mAJJlDbO+mKWCigjFYKXsWG0BT858FHEOWpHEx/r1peuBtuEhehlNmPrYK/3hlAqfGHcjEa93p07gdstrm4wJ8M4/rZrgcVi8QD6jw9lXhr+qcnhFwyeDPu43ElPDVdNntplX8n2T6vpJTpM+Nlrhp2O0hf0sPuEOqjQhsEVsiCEBqeX52nSPoaPH36DC9TRQeUXLVqLJqJdwrQzJZlrK9+mbTsoYeIT8CrJeNGCL+L7Bom7DN5Umj9++J3gFS7AuE1LSSi93mWTW1PANdbBakbq9UbwPKKY5I4GXGmGQjvIEajSAqW50aAhtNLWuFkfTt0SGtlIC8NVAoPQk9xBGJKXbbkJck1YgndJorPZ33kk9JrQzpFEl6y7HAFLI4ucq+ibaWtt35lNcBEnxlq4MeUUOcV2WpYQNuRFS053z84dnEhDcIVL0BGB0HEfLo9E0ksTgo/ihWmdn3g5paQA6MrgjWMaQRn1hHf6sx3QC0mz8e4TpDaFepuObKNmW5K2EzcRb6n9OxnKR4P8cN5GnGAUgynsXV2C2cDptoMlCFr/DaxlRcvU0kW6ILDWxrYb5cdjPWmbY6zp9eQK49wUuNlqn+noQWIeqExZU6Aj3LsSTl9eXsD8u/5QZXvr8W809+Di/PnZq6szcUYGaZuwJ/1hfyik4Ilr7fYsHR7Tx6tttTuf/vnpvdnCjPc8CFabdPekqFabg+VWLXYHf+WJhbRaSVe9iXa9FvL7BqNcQuNMzXU0OpflfDteZ93ulgtnhkvJXlFgkBNurm3THgBHh9/B9fTi7OLs+kxlSibQ4dkwS2fD5ocY6J7cck/94T3R+iCfctx8UmC1ak+S9XrL3z59VmITY8ctORyv1+s/AXfSquk=","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Save or Update Webhook","permalink":"/docs/API-docs/v1.1/save-update-webhook"},"next":{"title":"Create Folder","permalink":"/docs/API-docs/v1.1/createfolder"}}');var s=o(74848),n=o(28453),r=o(57742),i=o.n(r),a=o(78178),c=o.n(a),d=o(19624),h=o.n(d),p=o(96226),b=o.n(p),k=(o(77675),o(19365),o(51107));o(21312);const u={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:"eJy9VktvGzcQ/isTXtoIa0lJ00N1qpEYqVEjMWoHPthCwN0daRlxSYYzK1kQBOTQf9BTr/1p+SXFcLV6OUmbtuhFj+G855vHSrGekhrdqhvMK+9napypEqmIJrDxTo3UdYXwAi0ywoYHTi/PQVvrF7D0DbCHsn1fbN6baFWmfMCoRcl5qUaqZemsZCoiBe8ISY1W6ulwKF+Hhq+aokCiSWNhq0plqvCO0bHw6xCsKdLD4B2J0EpRUWGt5RcvA6qR8vk7LFhlKkRRw6Y1GZEay3t8xNG4qcoU3us6WCF18ba+l0Bbj+zykVqvM8WGE6dx1jh82wX19ulw+PYHtV4Lz7Phs4fBvSGM4DzDxDeufPTfxYUx+vjlsI5tfykQcb4L4/uHYZy7ubamTIi49jN0/28k++a5NS+u3tdW5Jyu25ASU3pXB6Hu09sgCYsmGl6q0e1K3Z/oYE7a99HteD3OVI1c+R2cxWfNlRqpwWKLbMI4x0hJhXTCSFXMgUaDAWlX5v6+7wM6MlNndU79wtcDHcxg/qT/RK2zYxkdwlfxY3PytSLEemrc9K/kxrv0XEkJ2yodJGlbKx3Mz7hUWVeDfa5MGYFOhbrEmOpl3MQn4U1lXgd0V2bqUl2T8eOhdIO28DXK7OEKodfrRD7++sdWqteD0hdNjY4TAvt37s69biIEv8Aoc0W7EiYW701uMYlhnd6oG2yEurZIZJdgHOM0akYozdSwtiB5Mm4KhQ46N9YIcIXNi3SEPexTH24q5AqjPH0TETSUOEcreAfdsK81i6rOX1j4OJtYv6AMNOQNGYdEgK7SrhDGrhIZ+AjaATrGGKIhBOIoXpvWN+846oKh1k5PUXRnsJ+sEq0RuEL0eUMM5G2TXAbWxvqIJXQBOcSSUhLP7oM8gVALX4eIlcBmjjBtTImUQeFLBEp9KiG4EnIkhiC+mAJJlDbO+mKWCigjFYKXsWG0BT858FHEOWpHEx/r1peuBtuEhehlNmPrYK/3hlAqfGHcjEa93p07gdstrm4wJ8M4/rZrgcVi8QD6jw9lXhr+qcnhFwyeDPu43ElPDVdNntplX8n2T6vpJTpM+Nlrhp2O0hf0sPuEOqjQhsEVsiCEBqeX52nSPoaPH36DC9TRQeUXLVqLJqJdwrQzJZlrK9+mbTsoYeIT8CrJeNGCL+L7Bom7DN5Umj9++J3gFS7AuE1LSSi93mWTW1PANdbBakbq9UbwPKKY5I4GXGmGQjvIEajSAqW50aAhtNLWuFkfTt0SGtlIC8NVAoPQk9xBGJKXbbkJck1YgndJorPZ33kk9JrQzpFEl6y7HAFLI4ucq+ibaWtt35lNcBEnxlq4MeUUOcV2WpYQNuRFS053z84dnEhDcIVL0BGB0HEfLo9E0ksTgo/ihWmdn3g5paQA6MrgjWMaQRn1hHf6sx3QC0mz8e4TpDaFepuObKNmW5K2EzcRb6n9OxnKR4P8cN5GnGAUgynsXV2C2cDptoMlCFr/DaxlRcvU0kW6ILDWxrYb5cdjPWmbY6zp9eQK49wUuNlqn+noQWIeqExZU6Aj3LsSTl9eXsD8u/5QZXvr8W809+Di/PnZq6szcUYGaZuwJ/1hfyik4Ilr7fYsHR7Tx6tttTuf/vnpvdnCjPc8CFabdPekqFabg+VWLXYHf+WJhbRaSVe9iXa9FvL7BqNcQuNMzXU0OpflfDteZ93ulgtnhkvJXlFgkBNurm3THgBHh9/B9fTi7OLs+kxlSibQ4dkwS2fD5ocY6J7cck/94T3R+iCfctx8UmC1ak+S9XrL3z59VmITY8ctORyv1+s/AXfSquk=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},W=void 0,m={},E=[];function T(e){const t={p:"p",...(0,n.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(k.default,{as:"h1",className:"openapi__heading",children:"Delete Webhook"}),"\n",(0,s.jsx)(i(),{method:"delete",path:"/webhook",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Delete Webhook API allow you to delete webhook url"}),"\n",(0,s.jsx)(c(),{parameters:void 0}),"\n",(0,s.jsx)(h(),{...o(70875)}),"\n",(0,s.jsx)(b(),{...o(67117)})]})}function I(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(T,{...e})}):T(e)}},70875(e){e.exports={title:"Body"}},67117(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Webhook deleted successfully!"}},"title":"inline_response_200_9"}}}},"404":{"description":"User not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"User not found!"}},"title":"inline_response_404"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/d480dde9.aa63e32f.js b/assets/js/d480dde9.aa63e32f.js new file mode 100644 index 000000000..50e59c404 --- /dev/null +++ b/assets/js/d480dde9.aa63e32f.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[3230],{29737(e,t,n){n.r(t),n.d(t,{assets:()=>x,contentTitle:()=>P,default:()=>m,frontMatter:()=>S,metadata:()=>o,toc:()=>M});const o=JSON.parse('{"id":"API-docs/v1.1/delete-webhook","title":"Delete Webhook","description":"The Delete Webhook API allow you to delete webhook url","source":"@site/docs/API-docs/v1.1/delete-webhook.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/delete-webhook","permalink":"/docs/API-docs/v1.1/delete-webhook","draft":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJy9WM1uHMcRfpXyCAjExf5QtnPIOnBCk7QkRJEILRkduASnd6Z2p7093ePqnlkuyAV8CPIAQS655iVyz6PoSYLqnp79oSJZcZCDRLKnun6/+um6T5xY2GR8nbzDWWHMMrnpJznajGTlpNHJOLksEM5QoUNoaeDk4iUIpcwK1qYGZyAP31ft95pU0k9MhSSYycs8GSeBJErpJ4S2MtqiTcb3yZfHx/xjX/CkzjK0dl4r6Fgl/SQz2qF2TC+qSsnMfxj9YPnSfWKzAkvBv7l1hck4MbMfMHNJP6mI2TgZRBLaWrkdOutI6kXST/BOlJXio2hv0D0H22mk1l8km00/cdJ5SqmV1Hgbjbr98vj49jfJZsM0Xx9//di4K4sE2jiYm1rnX/zv7EIiQx8361D2xwxh5aMZv35sxkvdCCVzj4hLs0T9/7VkV7wL4lnVu1LxPS3KYJIn8t+TPVN3z4ORFrOapFsn4+v75G4gKjkI38fXN5ubflKiK8wWzqyzcEUyTkarDtkWqUGyngVnwjgpnKvseDSyQuczczc0FWorF1qJmR1mphyJSo6aZ8Mvk03/8I6oqs+ix3rwuVesEwupF5+6d7N1z4RDGKK056QuVqKSf8B10o8x2KXqJ5KhU6DIkXy8pJ4bf7mNzJsK9UQutI+rF35YlJ5ApHn/5390ZFM91d9Cr8cliw0ZWFNThnBmstrzE8ohaeFkg/D+p7/BrJaK04AgxwYVo8/2wVFtOd1na0DtkCqSFu2w12P+u3IXskHra6CAzDAmHfahIpPXGSs6IBT5GnDAHhWuJoRKCTc3VIIryNSLAgRYqRcK+/D2fHLJxe7k4uUQJqhzyE1Wl6id9Sp2TPpQCi0WCA5L5odeZ5EtPYnUC7BOuNqC1EAoFDhZYh+EzkHUzpTCIStNbJ0k7MSAknPM1pkKzhFKwUq6wtQOGtS5IVAmWw6kHrIjBoMB/3jyBJ6jcyx14gQ5zPn0vEFaA+GPNVoHZW0dZIJoHeR26coaugIh3cFHCgEZXkiaplO983EMv2UO24NvW5qp7vXe/+WvcP3CrLgjLVBzy8ADgTdPI+hzk9nHaOfTUYGqGk2CUXZ0cvHSV7ajEP/XxoHlSK4KJGRRM1xI/Tu4suht6fXaNAfUjSSj2bW9HjxNf3YZSI+Yb0XGGc6nLgpiPsfMu1oxgnPhxEEoTg0hnIpKzKSSXEj5/AFOhcOFoTU8wLtCOA/ZTGjIDTxM9cNgMPD/mLTXO4uo6/XgAU4JBaPaos77UFe5/4uwMcsWU23z7+A5iGHfwrflfBnx6jl/V0uVA2FtxUztgNmbCxXhoFIiwxxWMl+gs994HdgzRiMY4ixYe7FInYgJqvmA89OLeB5RYPnYk+5mVefXlgtI3UjnuxXMebxpmV7UMyUz2Fd/UghCEFCFjzH1lNRLnz7aRK5KWudzQRLmkecZibmDd4aWLClwFA3uaGdoxyfCQs43rHf5XGqhZABcCUxBke+p0U5kbfD+GOqEz4FWmSx8hxkPNhWZBYmyFE5mQql1ZPK9UTlS4PGGFkKzrK1mUluZY1eC4YwYjvNwKfJoh6fA5C1myDRcjgZcjgAbrjjaODlvBwQLAZkEZqUBdV4ZqV1kx0NL5OVIYoMgsszU2nmPZIS5dMCdhMoQwYf91GDgv//p7xZe44rrTmwY/PEJnDgnssJXwXcebjCpq8qQm2ruJqnovtu0BSRIC9qswAZCzMHoEKTOVX3Wi/G3PQgEMbAdwfaArWkxFQ+5ftlhVPUF+34SojlpUfdK6qWd6gk6SKdJIXO8DfG+bXF5qzxFMubuhvAAc6EspqxyevFmcgkjr1jUM+U0YzYRNrvwtrFs7xsLcWgcbt16qlDw9Zg6MXhCTXX6/PwSRtHG0VjmqTd+/5yTJ4WCU2OGqME6QlHykJr7NCPMa50L7aASJEp0DEHOTMLSNJh7lr1eRTiXSvmaGQNH6GpiPhb5rkO1hjmZMtq8Zdjrcc9dsgO6dwugsBKJHZUZbesSuwhdCGtXhvLBBRmHGUPj4uz7LaL4O8dpLhXeVi3xNEmjX2MBnZl8zX1Gw8qQl+5LI+qM1lXL1Q4jXw/A8VS38QzAim5M4V//hPTi6pHH/fHOhRjN0TjS3e6THeDk4MOBPP+Biy+7NI3+eTOfcwA79HLNIqM6/Pq35a0JVB7BHwPuoaEeQx+w1BnAO36OSKd4svNdh0c/GRpQK6+DOs9cKLKiS8Muvm3yvTWKG6yvD20bSiE8Zjy+RJZhxRWbbWrTkYxCjvRcospBZGSs9ZOWt4LLFpnaoR3CZUGIwPQBz12ZGYeeztK5i2IhGslV87CTtzql0Hua41zUyh35nuCHsXZa5ZKrUFjne+p2TG0rXODTSFwxn66M25D9Me/ZUYRMBUardex+bdsOm4LY+FJRVWSawO5U6JDZ3MgjOd6x19qeHLRpe6cX9tCVFkEzo+HUVGt4enp6xMrJSnKFnuoT0Lhit2fZ1tuP6rVQRi98K2N78E5aP1yl02S2e4/Lele/t4U6VD9GWzdddFEchUGpC+Z5KaQCkeeElmsHVzXMOd87HaltkYIn5ZnRg4wt222QgJ6L0RnuB0DaLqD5EF7JJW5t6LP6e9rAU1tnBU8UIUu2GS/z9IhngkbmrR+Cahwvknkb964rNULV2PedPFQp9qyS7FgeUwDLyq1BEIk1PE2vb9Kjb8CU0nkuwbXOgNQFUnu4z/pgtj1phFQ+U8+3g3U74O6ccE4Ii3D19tUHhttJmL39IPEZA3k3CXZvu30OH306d7fPr+AtLh5d/tSTPT0cZf6EZKXxRepX8J3IlitBuYVTU1bCST/6r5mULzM4/MIKZpFwkLWEKjwtoHnmYdw8Gz7rXn5x/rKhJbrCWIQmCA4FSXTxMNy2pIVZ9Lvnqg3MCEPXzAqhF5wIPHztNGrJhT+vs5ALXl9mbfw7XyiotUJrwbgCacVDqDaM8X13XFnkd3M7A031AK670fQdzqx0uH33rVarR54+8ne+r5WC+PjxCfeJ12K49ly6F/UM3mJlrHSG1ttbC+mKeuZjuXu3+6NlEB8p3RLtl7xSPctLpNKCmcMEqZHZJ8wfOSYfHU15N3Owz9lfuxDOkbju2L03tqhk+56/jnoAq/dL7OBNXftW8ctALn1hsfT7Qz5+qccmvJm39rbLrY/bm/QTJTPUFneWhSfPL15B89XwOOnvbMl+RixHr16enr+enLMybZok4+TZ8Hh4zEeVsa4UekfS/k79cMN1v92i/vcb+HYZ5/DOjSolpF9/eqvu273ldbLa7v0LYx0f3d9zIl+R2mz4+McaiReiN/2kESQ54/06tB9XeLzoXOKavecnnoQJVR32gAf7370l6tn5q/PL86SfiJqV2d0eLv32sP2FBcRPer3Dfn+tGHTg/3nH+cEL9/dhM7nZdPTh03+80doYqdmHN5vN5t9+kfmC","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Save or Update Webhook","permalink":"/docs/API-docs/v1.1/save-update-webhook"},"next":{"title":"Create Folder","permalink":"/docs/API-docs/v1.1/createfolder"}}');var l=n(74848),r=n(28453),s=n(57742),d=n.n(s),a=n(78178),c=n.n(a),i=n(19624),h=n.n(i),p=n(96226),k=n.n(p),u=(n(77675),n(19365),n(51107));n(21312);const S={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:"eJy9WM1uHMcRfpXyCAjExf5QtnPIOnBCk7QkRJEILRkduASnd6Z2p7093ePqnlkuyAV8CPIAQS655iVyz6PoSYLqnp79oSJZcZCDRLKnun6/+um6T5xY2GR8nbzDWWHMMrnpJznajGTlpNHJOLksEM5QoUNoaeDk4iUIpcwK1qYGZyAP31ft95pU0k9MhSSYycs8GSeBJErpJ4S2MtqiTcb3yZfHx/xjX/CkzjK0dl4r6Fgl/SQz2qF2TC+qSsnMfxj9YPnSfWKzAkvBv7l1hck4MbMfMHNJP6mI2TgZRBLaWrkdOutI6kXST/BOlJXio2hv0D0H22mk1l8km00/cdJ5SqmV1Hgbjbr98vj49jfJZsM0Xx9//di4K4sE2jiYm1rnX/zv7EIiQx8361D2xwxh5aMZv35sxkvdCCVzj4hLs0T9/7VkV7wL4lnVu1LxPS3KYJIn8t+TPVN3z4ORFrOapFsn4+v75G4gKjkI38fXN5ubflKiK8wWzqyzcEUyTkarDtkWqUGyngVnwjgpnKvseDSyQuczczc0FWorF1qJmR1mphyJSo6aZ8Mvk03/8I6oqs+ix3rwuVesEwupF5+6d7N1z4RDGKK056QuVqKSf8B10o8x2KXqJ5KhU6DIkXy8pJ4bf7mNzJsK9UQutI+rF35YlJ5ApHn/5390ZFM91d9Cr8cliw0ZWFNThnBmstrzE8ohaeFkg/D+p7/BrJaK04AgxwYVo8/2wVFtOd1na0DtkCqSFu2w12P+u3IXskHra6CAzDAmHfahIpPXGSs6IBT5GnDAHhWuJoRKCTc3VIIryNSLAgRYqRcK+/D2fHLJxe7k4uUQJqhzyE1Wl6id9Sp2TPpQCi0WCA5L5odeZ5EtPYnUC7BOuNqC1EAoFDhZYh+EzkHUzpTCIStNbJ0k7MSAknPM1pkKzhFKwUq6wtQOGtS5IVAmWw6kHrIjBoMB/3jyBJ6jcyx14gQ5zPn0vEFaA+GPNVoHZW0dZIJoHeR26coaugIh3cFHCgEZXkiaplO983EMv2UO24NvW5qp7vXe/+WvcP3CrLgjLVBzy8ADgTdPI+hzk9nHaOfTUYGqGk2CUXZ0cvHSV7ajEP/XxoHlSK4KJGRRM1xI/Tu4suht6fXaNAfUjSSj2bW9HjxNf3YZSI+Yb0XGGc6nLgpiPsfMu1oxgnPhxEEoTg0hnIpKzKSSXEj5/AFOhcOFoTU8wLtCOA/ZTGjIDTxM9cNgMPD/mLTXO4uo6/XgAU4JBaPaos77UFe5/4uwMcsWU23z7+A5iGHfwrflfBnx6jl/V0uVA2FtxUztgNmbCxXhoFIiwxxWMl+gs994HdgzRiMY4ixYe7FInYgJqvmA89OLeB5RYPnYk+5mVefXlgtI3UjnuxXMebxpmV7UMyUz2Fd/UghCEFCFjzH1lNRLnz7aRK5KWudzQRLmkecZibmDd4aWLClwFA3uaGdoxyfCQs43rHf5XGqhZABcCUxBke+p0U5kbfD+GOqEz4FWmSx8hxkPNhWZBYmyFE5mQql1ZPK9UTlS4PGGFkKzrK1mUluZY1eC4YwYjvNwKfJoh6fA5C1myDRcjgZcjgAbrjjaODlvBwQLAZkEZqUBdV4ZqV1kx0NL5OVIYoMgsszU2nmPZIS5dMCdhMoQwYf91GDgv//p7xZe44rrTmwY/PEJnDgnssJXwXcebjCpq8qQm2ruJqnovtu0BSRIC9qswAZCzMHoEKTOVX3Wi/G3PQgEMbAdwfaArWkxFQ+5ftlhVPUF+34SojlpUfdK6qWd6gk6SKdJIXO8DfG+bXF5qzxFMubuhvAAc6EspqxyevFmcgkjr1jUM+U0YzYRNrvwtrFs7xsLcWgcbt16qlDw9Zg6MXhCTXX6/PwSRtHG0VjmqTd+/5yTJ4WCU2OGqME6QlHykJr7NCPMa50L7aASJEp0DEHOTMLSNJh7lr1eRTiXSvmaGQNH6GpiPhb5rkO1hjmZMtq8Zdjrcc9dsgO6dwugsBKJHZUZbesSuwhdCGtXhvLBBRmHGUPj4uz7LaL4O8dpLhXeVi3xNEmjX2MBnZl8zX1Gw8qQl+5LI+qM1lXL1Q4jXw/A8VS38QzAim5M4V//hPTi6pHH/fHOhRjN0TjS3e6THeDk4MOBPP+Biy+7NI3+eTOfcwA79HLNIqM6/Pq35a0JVB7BHwPuoaEeQx+w1BnAO36OSKd4svNdh0c/GRpQK6+DOs9cKLKiS8Muvm3yvTWKG6yvD20bSiE8Zjy+RJZhxRWbbWrTkYxCjvRcospBZGSs9ZOWt4LLFpnaoR3CZUGIwPQBz12ZGYeeztK5i2IhGslV87CTtzql0Hua41zUyh35nuCHsXZa5ZKrUFjne+p2TG0rXODTSFwxn66M25D9Me/ZUYRMBUardex+bdsOm4LY+FJRVWSawO5U6JDZ3MgjOd6x19qeHLRpe6cX9tCVFkEzo+HUVGt4enp6xMrJSnKFnuoT0Lhit2fZ1tuP6rVQRi98K2N78E5aP1yl02S2e4/Lele/t4U6VD9GWzdddFEchUGpC+Z5KaQCkeeElmsHVzXMOd87HaltkYIn5ZnRg4wt222QgJ6L0RnuB0DaLqD5EF7JJW5t6LP6e9rAU1tnBU8UIUu2GS/z9IhngkbmrR+Cahwvknkb964rNULV2PedPFQp9qyS7FgeUwDLyq1BEIk1PE2vb9Kjb8CU0nkuwbXOgNQFUnu4z/pgtj1phFQ+U8+3g3U74O6ccE4Ii3D19tUHhttJmL39IPEZA3k3CXZvu30OH306d7fPr+AtLh5d/tSTPT0cZf6EZKXxRepX8J3IlitBuYVTU1bCST/6r5mULzM4/MIKZpFwkLWEKjwtoHnmYdw8Gz7rXn5x/rKhJbrCWIQmCA4FSXTxMNy2pIVZ9Lvnqg3MCEPXzAqhF5wIPHztNGrJhT+vs5ALXl9mbfw7XyiotUJrwbgCacVDqDaM8X13XFnkd3M7A031AK670fQdzqx0uH33rVarR54+8ne+r5WC+PjxCfeJ12K49ly6F/UM3mJlrHSG1ttbC+mKeuZjuXu3+6NlEB8p3RLtl7xSPctLpNKCmcMEqZHZJ8wfOSYfHU15N3Owz9lfuxDOkbju2L03tqhk+56/jnoAq/dL7OBNXftW8ctALn1hsfT7Qz5+qccmvJm39rbLrY/bm/QTJTPUFneWhSfPL15B89XwOOnvbMl+RixHr16enr+enLMybZok4+TZ8Hh4zEeVsa4UekfS/k79cMN1v92i/vcb+HYZ5/DOjSolpF9/eqvu273ldbLa7v0LYx0f3d9zIl+R2mz4+McaiReiN/2kESQ54/06tB9XeLzoXOKavecnnoQJVR32gAf7370l6tn5q/PL86SfiJqV2d0eLv32sP2FBcRPer3Dfn+tGHTg/3nH+cEL9/dhM7nZdPTh03+80doYqdmHN5vN5t9+kfmC",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-2",custom_edit_url:null},P=void 0,x={},M=[];function U(e){const t={p:"p",...(0,r.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Delete Webhook"}),"\n",(0,l.jsx)(d(),{method:"delete",path:"/webhook",context:"endpoint"}),"\n",(0,l.jsx)(t.p,{children:"The Delete Webhook API allow you to delete webhook url"}),"\n",(0,l.jsx)(c(),{parameters:void 0}),"\n",(0,l.jsx)(h(),{...n(70875)}),"\n",(0,l.jsx)(k(),{...n(67117)})]})}function m(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,l.jsx)(t,{...e,children:(0,l.jsx)(U,{...e})}):U(e)}},70875(e){e.exports={title:"Body"}},67117(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Webhook deleted successfully!"}},"title":"inline_response_200_9"}}}},"404":{"description":"User not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"User not found!"}},"title":"inline_response_404"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/d77fb6a8.7252287b.js b/assets/js/d77fb6a8.9e372237.js similarity index 96% rename from assets/js/d77fb6a8.7252287b.js rename to assets/js/d77fb6a8.9e372237.js index b1c026f0f..4fe29357c 100644 --- a/assets/js/d77fb6a8.7252287b.js +++ b/assets/js/d77fb6a8.9e372237.js @@ -1 +1 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[448],{43519(e){e.exports=JSON.parse('{"categoryGeneratedIndex":{"title":"OpenSign API v1.1","slug":"/API-docs/v1.1","permalink":"/docs/API-docs/v1.1","sidebar":"apiSidebar","navigation":{"previous":{"title":"Get folder list","permalink":"/docs/API-docs/v1.2/folderlist"},"next":{"title":"Introduction","permalink":"/docs/API-docs/v1.1/opensign-api-v-1-1"}}}}')}}]); \ No newline at end of file +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[448],{43519(e){e.exports=JSON.parse('{"categoryGeneratedIndex":{"title":"OpenSign API v1.1","slug":"/API-docs/v1.1","permalink":"/docs/API-docs/v1.1","sidebar":"apiSidebar","navigation":{"previous":{"title":"Get folder list","permalink":"/docs/API-docs/v1.2/folderlist"},"next":{"title":"Introduction","permalink":"/docs/API-docs/v1.1/opensign-api-v-1-2"}}}}')}}]); \ No newline at end of file diff --git a/assets/js/da66eb9c.3444bc9f.js b/assets/js/da66eb9c.3444bc9f.js deleted file mode 100644 index 5cc7347a9..000000000 --- a/assets/js/da66eb9c.3444bc9f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[2703],{37055(e,t,i){i.r(t),i.d(t,{assets:()=>x,contentTitle:()=>v,default:()=>P,frontMatter:()=>y,metadata:()=>o,toc:()=>g});const o=JSON.parse('{"id":"API-docs/v1.1/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/v1.1/update-document.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/update-document","permalink":"/docs/API-docs/v1.1/update-document","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"update-document","title":"Update Document","description":"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.","sidebar_label":"Update Document","hide_title":true,"hide_table_of_contents":true,"api":"eJzdWc2OHLcRfpUKL5YGvTMjWXKQOXkjC7YQQVpoVxCQ1WLAblZP08smaZI9s4PFAD7kDXLKNY/mJwmK7L/50Z8tJEAutpZNFqu+KlZ9VXPPAl95trhmP5iiqVEHz24yJtAXTtogjWYLdlUhvLWCB4RuF5xfvACulNl4aDw6D8FAbYQst8C1gCZtDxWCwMCl8mBK4OAtFrKUBYhW0BRembiRBwiV9FGw0WrbSQ+mE8ahxA1Y7niNAZ3PYGsaKLjWJkBRcb1KF5ZSIRhdIMiQNOiUlh4KhzygmLKMGYuOk4kvBFuwdElnH8vYcBFbXN8zzWtkC9bJWkrBMiYJHstDxQ4xe/EDGbx3e7RRI4poVI6tXSTH4S+NdCjYIrgGM+bDVtFtXtZWIcsY3lllBLJFyZWnDUWFNWeLexa2Nu4MTuoVy1hpXM3DsLLb3ST56MNfjdjSmX1VL5xZS4GQozIjfEfIB6yt4gE9POABFHIfwGgc7e0MeMgyVhgdCMLFPePWKllEkGc/e7rt/lh1k/+MRUTckUuCRE9fE+CfNpDA4RGmBfPxHz3kbJcxbcIXi7kgExEcriVuYjx7udIpPsey93D8siv6qBjL2NEZJdBRRB7LG07TTtQ8V/j66mK0NTdGIddH0UhRBWfJABMXYSOVgiQDXl9dwBodPczoqym8jW867nFYoFzT8xtvgcIIhLXkgDWXKoNNJYuKAn4LdeMDoG5jqIUOR08+BjGcwbFCQvqTGmUpHUi9GtLNkWAQ0mER1BY2MlSmCcCFkHScK/ABrZ+OUYxa9EBemcb9cSQ5rBopUEAwjYPSuKhlTFY2PjOyQGofXFPQYQ+iIe9GO2gr/ds6U6D3A04dKrRpJD8D1D4d51ByH9Bl0GhJyLvGBhS9SLyz6CTqAk9CEMFdxvzdAu4/H4sLdLUMvrOUXMOFAFQY6wn4pqiAp+88NA59BlLLILnyGfjAa+szMA4C3lFegWAsJU+8kz6Q8hspVhg8yA/F0RukN1KMdCidqaP3CRu9HQdCr1cwB+KuyKnSt1Wr5I0KsOaqOY2ZwxRuy8apU691H6vLVPgwSX/75iVsKnTY+x1diqOc0k4SjFRG40uji0MXJX20H4bLUYbgTTBLh7XUAj8nti8xRFDIrcH0Id0EU/MgC+hE+Sm0W5MDghlHaA0POvByrPhaGvfwAwCSuCVV6qXUS1yj24601E2doztS8lVcpvgQfOshx7BB1GPdOjcmFpEqEOm2qVDDHia0yw9G72n5NNUOWW6XRi+H2D2J475thypPJiR9MoEzuBo7MHIR4w7SrE4ZFeLlXbYl3QkgolApWuh/fj+A3+v3ejKJKnziMmJMX+lCom8LeIMr7oRC7xPtScBSzGbA+wg23VWUn4fQF4OWVGtHuwuiA1EnBB4CLyoU5DSBFrWgXPGNRy2WUeo3Ax+Zvo/F1KJeFkYZN/Yad45vibsFrP3xw92NvHnNctVg5GfE0nLFi1t2s8tYXhS/VyKVr+/bv6eFqVkWlx7vrR1R8Lwo4EGuJMHDXR6zgt0+XLSFmguqCTGhHNTsPacm8CM1PuLFCXQUUwACb5exIMMeVVmOuO8yJyq52+3iO/bWaJ+exuP5/Jhh9l1Dy3ipJFDKKhultn/6epQxLX+KPHEvHv/kL578ZMk1rUrn4eOHHs8ff3v2aH42//PVo+8WT/6yePrddD6f/51l7K5WA19lJI2N0Yt/jxakVlLjskNt+Xg+X37bQvnkFHotG7UtTV9zJQWUEpUAutN/RQDROeN+J1v+iH4fM59M7ox/8pHQoZRVmkaL/7W5pzT6uIFPlk96E58em/hCJ8io870yt6j/GxYO9oyvD+l6UnU/qmXaFL+zPWPH68lIj0XjZNjGtvnujFt5lr4vrm+oGa0xVIZabtukPjtUbMFmXXaZ3Y/yzI6RPLfuuvDItVgVgvWL2cxzLXJzNzUWNVUSxXNP+XPGrZytH00fsV12eIZb+0X7sTn70iM+8JXUq0+duxmguiR3Jo/tATaUGCv/hlRjWn+Md7VjiAo50TzyAEXJm6Hlf975unfnYZ/ctcmf1/keFqeTvey4lWVsr11tSdK472qXTvYh7bd9vk0iD/htv+8UrXz6ITbXnhpThdNlv636n1vBd+SW0kQfto/ltUV9SXDSU4sxcIjkO1SFqbFrTSaT7shv//h3f2oy6V2RunWiYa8bB9Zs0JWNin4rFd5Jor10DOv4zceJGbXOyGsia2oL1C2uHBEsIVcyUKfc9hUFtzyXSlIuoW2GTjsYpSM/hXcVhgodffrGEeEQuEZFKahvHPRqYBob425LmusRLcwbLzVRRtQV1wVt7B5E7AeJmVIva530CD440lom3YwOjhcBaq75KjZ0GYzBEqgkZQ1wJqdxhDeqSQ03TSONiy10MiiO5CKIz2nK5hBolQiRw4pe77rtun2Wph7p9ZAJWkCOPoAlXWSBaVyplSlu0yiyUQqsoUwuuSJqPNaRjgfHtadyk3TpfNAD1jZ36Ft2/9Yjefil1Ld+MZm812dw3cfVO8y9DHjzoMtEm83mKAM93D/zoww/NTm8QWu8DMZth9MrGaomj1lrLKT/I0n6ETXG+BnlpEGGMIU/ToK0OqtQ2dll6hL87PziRSx+D+G3X/8JL5E7DZXZpGgtGodqC6vuKkIueT7B1teuOHLhTagI8SIFXzv87BB8V/Hw26//8vAKNzRSSE+KTJlMLppcyQKuunnnZLKAZ3FiPJqBxjluwTX16r7iFEo0B+Ng02kl9e0UzvU2jqqGXofW47k9M2J+7dztIeceY2NDJ7o7p4NGscP2qNbou9F3joBCEq0OlTPNKt02VqY1zmFJzcG7NE4h286FANsud1MW6uYHdbA0aUqxBe4QfByUXBwciV8aa40jLdoxTWm6iR1qYY3UwS9AOF6GQX520J/GSd/RUoKQ93BkrZjeJeklthb3q9QEZof1dD/fOizR0YXR7MEvVrbhdN2FJVC0/pGwJtZEWYsXkdTFViwV9u8P5USCha72r8tLdGtZYEsuPvCiZ3HzjGVMyQK1H1f68x8vXsL62+mcqlTPUj7jcc9evnj2/NXlc1KGEmkC7NF0Pp3H1tr4UHM9uungF6LD2nY/UNr/1x+UWq5GY8yZVVxGptxOBxPLvWYjErUY/5Z0k7HK+EBb7u8pCbx1arej5V+aSGCubzK25k4SZ4pUuB25idNDpzHcD950v87Al/0sddKgjpFqoqNxPJrY2C1uD34f2xEJamkpaZx2PEt6nV2RnEHCUZdDvDqdOC8KtOGje8dtxcXbK2Jt7W9ddfzZjDm+IULHN0nZNLqPhDuu3TPF9arhK9qbRO7SBLXaZ+G3kYW3/yCjTsKxT8+TFfRfsunkgfv7xPB3u35/+vTBEy2u3W7yzc1ut/sPt1iLdQ==","sidebar_class_name":"put api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Document","permalink":"/docs/API-docs/v1.1/getdocument"},"next":{"title":"Revoke Document","permalink":"/docs/API-docs/v1.1/revokedocument"}}');var n=i(74848),a=i(28453),s=i(57742),d=i.n(s),l=i(78178),r=i.n(l),c=i(19624),u=i.n(c),p=i(96226),m=i.n(p),h=(i(77675),i(19365),i(51107)),f=i(21312);const y={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:"eJzdWc2OHLcRfpUKL5YGvTMjWXKQOXkjC7YQQVpoVxCQ1WLAblZP08smaZI9s4PFAD7kDXLKNY/mJwmK7L/50Z8tJEAutpZNFqu+KlZ9VXPPAl95trhmP5iiqVEHz24yJtAXTtogjWYLdlUhvLWCB4RuF5xfvACulNl4aDw6D8FAbYQst8C1gCZtDxWCwMCl8mBK4OAtFrKUBYhW0BRembiRBwiV9FGw0WrbSQ+mE8ahxA1Y7niNAZ3PYGsaKLjWJkBRcb1KF5ZSIRhdIMiQNOiUlh4KhzygmLKMGYuOk4kvBFuwdElnH8vYcBFbXN8zzWtkC9bJWkrBMiYJHstDxQ4xe/EDGbx3e7RRI4poVI6tXSTH4S+NdCjYIrgGM+bDVtFtXtZWIcsY3lllBLJFyZWnDUWFNWeLexa2Nu4MTuoVy1hpXM3DsLLb3ST56MNfjdjSmX1VL5xZS4GQozIjfEfIB6yt4gE9POABFHIfwGgc7e0MeMgyVhgdCMLFPePWKllEkGc/e7rt/lh1k/+MRUTckUuCRE9fE+CfNpDA4RGmBfPxHz3kbJcxbcIXi7kgExEcriVuYjx7udIpPsey93D8siv6qBjL2NEZJdBRRB7LG07TTtQ8V/j66mK0NTdGIddH0UhRBWfJABMXYSOVgiQDXl9dwBodPczoqym8jW867nFYoFzT8xtvgcIIhLXkgDWXKoNNJYuKAn4LdeMDoG5jqIUOR08+BjGcwbFCQvqTGmUpHUi9GtLNkWAQ0mER1BY2MlSmCcCFkHScK/ABrZ+OUYxa9EBemcb9cSQ5rBopUEAwjYPSuKhlTFY2PjOyQGofXFPQYQ+iIe9GO2gr/ds6U6D3A04dKrRpJD8D1D4d51ByH9Bl0GhJyLvGBhS9SLyz6CTqAk9CEMFdxvzdAu4/H4sLdLUMvrOUXMOFAFQY6wn4pqiAp+88NA59BlLLILnyGfjAa+szMA4C3lFegWAsJU+8kz6Q8hspVhg8yA/F0RukN1KMdCidqaP3CRu9HQdCr1cwB+KuyKnSt1Wr5I0KsOaqOY2ZwxRuy8apU691H6vLVPgwSX/75iVsKnTY+x1diqOc0k4SjFRG40uji0MXJX20H4bLUYbgTTBLh7XUAj8nti8xRFDIrcH0Id0EU/MgC+hE+Sm0W5MDghlHaA0POvByrPhaGvfwAwCSuCVV6qXUS1yj24601E2doztS8lVcpvgQfOshx7BB1GPdOjcmFpEqEOm2qVDDHia0yw9G72n5NNUOWW6XRi+H2D2J475thypPJiR9MoEzuBo7MHIR4w7SrE4ZFeLlXbYl3QkgolApWuh/fj+A3+v3ejKJKnziMmJMX+lCom8LeIMr7oRC7xPtScBSzGbA+wg23VWUn4fQF4OWVGtHuwuiA1EnBB4CLyoU5DSBFrWgXPGNRy2WUeo3Ax+Zvo/F1KJeFkYZN/Yad45vibsFrP3xw92NvHnNctVg5GfE0nLFi1t2s8tYXhS/VyKVr+/bv6eFqVkWlx7vrR1R8Lwo4EGuJMHDXR6zgt0+XLSFmguqCTGhHNTsPacm8CM1PuLFCXQUUwACb5exIMMeVVmOuO8yJyq52+3iO/bWaJ+exuP5/Jhh9l1Dy3ipJFDKKhultn/6epQxLX+KPHEvHv/kL578ZMk1rUrn4eOHHs8ff3v2aH42//PVo+8WT/6yePrddD6f/51l7K5WA19lJI2N0Yt/jxakVlLjskNt+Xg+X37bQvnkFHotG7UtTV9zJQWUEpUAutN/RQDROeN+J1v+iH4fM59M7ox/8pHQoZRVmkaL/7W5pzT6uIFPlk96E58em/hCJ8io870yt6j/GxYO9oyvD+l6UnU/qmXaFL+zPWPH68lIj0XjZNjGtvnujFt5lr4vrm+oGa0xVIZabtukPjtUbMFmXXaZ3Y/yzI6RPLfuuvDItVgVgvWL2cxzLXJzNzUWNVUSxXNP+XPGrZytH00fsV12eIZb+0X7sTn70iM+8JXUq0+duxmguiR3Jo/tATaUGCv/hlRjWn+Md7VjiAo50TzyAEXJm6Hlf975unfnYZ/ctcmf1/keFqeTvey4lWVsr11tSdK472qXTvYh7bd9vk0iD/htv+8UrXz6ITbXnhpThdNlv636n1vBd+SW0kQfto/ltUV9SXDSU4sxcIjkO1SFqbFrTSaT7shv//h3f2oy6V2RunWiYa8bB9Zs0JWNin4rFd5Jor10DOv4zceJGbXOyGsia2oL1C2uHBEsIVcyUKfc9hUFtzyXSlIuoW2GTjsYpSM/hXcVhgodffrGEeEQuEZFKahvHPRqYBob425LmusRLcwbLzVRRtQV1wVt7B5E7AeJmVIva530CD440lom3YwOjhcBaq75KjZ0GYzBEqgkZQ1wJqdxhDeqSQ03TSONiy10MiiO5CKIz2nK5hBolQiRw4pe77rtun2Wph7p9ZAJWkCOPoAlXWSBaVyplSlu0yiyUQqsoUwuuSJqPNaRjgfHtadyk3TpfNAD1jZ36Ft2/9Yjefil1Ld+MZm812dw3cfVO8y9DHjzoMtEm83mKAM93D/zoww/NTm8QWu8DMZth9MrGaomj1lrLKT/I0n6ETXG+BnlpEGGMIU/ToK0OqtQ2dll6hL87PziRSx+D+G3X/8JL5E7DZXZpGgtGodqC6vuKkIueT7B1teuOHLhTagI8SIFXzv87BB8V/Hw26//8vAKNzRSSE+KTJlMLppcyQKuunnnZLKAZ3FiPJqBxjluwTX16r7iFEo0B+Ng02kl9e0UzvU2jqqGXofW47k9M2J+7dztIeceY2NDJ7o7p4NGscP2qNbou9F3joBCEq0OlTPNKt02VqY1zmFJzcG7NE4h286FANsud1MW6uYHdbA0aUqxBe4QfByUXBwciV8aa40jLdoxTWm6iR1qYY3UwS9AOF6GQX520J/GSd/RUoKQ93BkrZjeJeklthb3q9QEZof1dD/fOizR0YXR7MEvVrbhdN2FJVC0/pGwJtZEWYsXkdTFViwV9u8P5USCha72r8tLdGtZYEsuPvCiZ3HzjGVMyQK1H1f68x8vXsL62+mcqlTPUj7jcc9evnj2/NXlc1KGEmkC7NF0Pp3H1tr4UHM9uungF6LD2nY/UNr/1x+UWq5GY8yZVVxGptxOBxPLvWYjErUY/5Z0k7HK+EBb7u8pCbx1arej5V+aSGCubzK25k4SZ4pUuB25idNDpzHcD950v87Al/0sddKgjpFqoqNxPJrY2C1uD34f2xEJamkpaZx2PEt6nV2RnEHCUZdDvDqdOC8KtOGje8dtxcXbK2Jt7W9ddfzZjDm+IULHN0nZNLqPhDuu3TPF9arhK9qbRO7SBLXaZ+G3kYW3/yCjTsKxT8+TFfRfsunkgfv7xPB3u35/+vTBEy2u3W7yzc1ut/sPt1iLdQ==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},v=void 0,x={},g=[];function j(e){const t={p:"p",...(0,a.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Update Document"}),"\n",(0,n.jsx)(d(),{method:"put",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created."}),"\n",(0,n.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,n.jsx)(f.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,n.jsx)(r(),{...i(38679)}),"\n",(0,n.jsx)(u(),{...i(96925)}),"\n",(0,n.jsx)(m(),{...i(24083)})]})}function P(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(j,{...e})}):j(e)}},38679(e){e.exports=JSON.parse('{"parameters":[{"name":"document_id","in":"path","description":"ID of the document that needs to be updated","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string"}}]}')},96925(e){e.exports=JSON.parse('{"title":"Body","body":{"description":"Provide below parameter to update templates (at least one parameter required)","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","format":"string","example":"sample document"},"note":{"type":"string","format":"string","example":"Please review and sign this document"},"description":{"type":"string","format":"string","example":"document description"},"folderId":{"type":"string","example":""},"enableOTP":{"type":"boolean","description":"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.","example":false},"enableTour":{"type":"boolean","description":"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.","example":false},"allow_modifications":{"type":"boolean","description":"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.","example":false},"redirect_url":{"type":"string","description":"Specifies the URL where the signer will be redirected upon completing the document signing process.","example":""},"auto_reminder":{"type":"boolean","description":"Set to true to enable automatic reminders. Set to false to disable them (default behavior).","example":false},"remind_once_in_every":{"type":"number","description":"Number of days between reminders. This is only applicable when auto_reminder is set to true.","example":5},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed. \\n"}},"title":"document_document_id_body"}}}}}')},24083(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Document updated successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","example":"asd2HsP4Hp"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"title":"inline_response_200_3"}}}},"400":{"description":"Please provide valid field names!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","format":"string","example":"Please provide valid field names!"}},"title":"inline_response_400"}}}},"404":{"description":"Document not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","format":"string","example":"Document not found!"}},"title":"inline_response_404_4"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/da66eb9c.bd581db8.js b/assets/js/da66eb9c.bd581db8.js new file mode 100644 index 000000000..5b7e362a3 --- /dev/null +++ b/assets/js/da66eb9c.bd581db8.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[2703],{37055(e,t,n){n.r(t),n.d(t,{assets:()=>w,contentTitle:()=>v,default:()=>y,frontMatter:()=>f,metadata:()=>i,toc:()=>b});const i=JSON.parse('{"id":"API-docs/v1.1/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/v1.1/update-document.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/update-document","permalink":"/docs/API-docs/v1.1/update-document","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"update-document","title":"Update Document","description":"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.","sidebar_label":"Update Document","hide_title":true,"hide_table_of_contents":true,"api":"eJzdWt1uG7kVfpXTWaCxhZHkZLNbVC3aZh1vEjSNDdtpgNqGRA2PJNYUOSU5kgVHwF4UfYCiN73tS/S+j7JPUhz+zIx+1kl2ty3Qi8T2zOHh+ec5H+c+c2xqs8FV9lwX1RyVs9lNnnG0hRGlE1plg+xyhvC25MwhJCp4dvYKmJR6aaGyaCw4DXPNxWQFTHGoArmbIXB0TEgLegIMbImFmIgCeGTUgzfaEzIHbiasZ6yVXCXuTidmDCa4hJIZNkeHxuaw0hUUTCntoJgxNQ0bToRE0KpAEC5IkIQWFgqDzCHvZXmmSzSMVHzFs0EWNkn6ZXnWbJQNru4zxeaYDbLEayh4lmeCzFMyN8u2bfbqOSm8sbvXUSFyr9QYo17Ex+CfKmGQZwNnKswz61aSdrNiXkrM8gzvSqk5ZoMJk5YIihnOWTa4z9yq9JTOCDXN8myizZy55sl6fRP4o3Vfab6iNZuinhm9EBxhjFK37NuyvMN5KZlDCwfMgURmHWiFLdqkwGGWZ4VWjkw4uM9YWUpReCP3/2hpt/td0fX4j1h4ixtyiRNo6W0w+IcVJOMwb6ZBZv0vtcmzdZ4p7T6ZzRmpiGBwIXDp49mKqQrx2ea9YcdP26KOijaPNa2RHA1F5C6/ZjVRomJjiaeXZy3SsdYSmdqJRooq6AYFtH8ISyElBB5wenkGCzSUmN5XPXjrc9rTGCxQLCj92iRQaI6wEAxwzoTMYTkTxYwCfgXzyjpAFWMomg5bKe+DGLqwKxAXdq9EeSgHQk2bcrPDGLgwWDi5gqVwM105YJwLWs4kWIel7bWt6KWoDXmpK/PDLclgWgmOHJyuDEy08VL6YlX6NCMNhLLOVAUttsAr8q7Xg0jp99LoAq1t7JSsQkQt/jmgsmE5gwmzDk0OlRJkeVOVDnnNEu9KNAJVgXtN4I079PU7Gtx+vC3O0MyFs0lTcg3jHFCiP0/AVsUMWHjPXGXQ5iCUcIJJm4N1bF7aHLQBh3dUV8Dpkoon3gnrSPil4FN0FsR3xdE5Uo4ULRkmRs+998k2atUOhFoup7fYXZJThY2n1oRV0sGCyWq/zSwqPhRqqA1HMwwCfITR3s1QgUVH2z8iCz7KAVkxi6LT/mOpi1vkUYmCYiGFSB3qlXJCUlJASQnqFU3Kz9gCodAkLsWAm6EwwIqQ2Sdqok2BFoLEYOloUOSMFCw9OPXnL9VutLAkgR+Rtq/UKen6iGRk0ib5e/A8GMub9JG3z6O9JjMYMnRYGbmvwG1a6iL0Chgc8vb8NYlisE4VNCH1xlSpA2OkzsMXJ6/8jtW2M2ynqLLK6aHBuVAcP6YcXARH+kxwuq4CldNz5kQBiZXtQSQNMet0O6nncJDibYwzthDaHH6HAYndkJobCj1coFm1pFTVfIxmR8g3/jGlFGcrC2N0S0TVli1Fvq4dX3jZvO83bEJUtlF6Q8ovwnErJquhVsMm3ffacVO3bZE7HeLe6UAXLtsO9O2bNlsnkwqHEPjN0wFFspOBqOsM0UI/7GbOX6tr1el4ET6wGTWZP9KG1PEO4BynzHCJ1oZOMRiWYjYHVkewTlvRkdaEPm+kpPakRV1QB+VlQmDOsWKGnJzGsUTFqbz6XB56ro+aFq537fuPEtWw0FKbtteYMWxF7a7Dud1N3HXLm1fZWFboW1pqbMeSFbfZzTrPxkXxfTnSif+b+Hev0PMs94+ebDzbmVrGRQEHYynIPMyMfVUoV4eD2NswTseoLyhbbc6GU4Px/TSxM0qkCtsDCMb7b6tIGv6ndSPN1nnmhNvoW4etQWg4prlivV77CmVLrWxI+idHR7vjRj1CxvGH+gMqxpNKytVPfrz5ITz+UCfNLH/y0p49fVmSR6JIz9zDi54cPfm8+/ioe/Szy8dfDp7+fPDFl72jo6M/ZHl2N5fN8JIRt6xtPf9364FQUigcJqsNnxwdDT+Ppny6z3pxNCnjzLZgUnCYCJQcaE/7IxoQjdHme45OD8j3kPqkclL+6QOhQ8V4oivF/9fq7pPoYQWfDp/WKn6xq+IrFUxGMMilvkX139Cw0ae9vQvbk6ibUS0CkX+fbSjbfh6UtFhURriVx1DuuqwU3fB+cHVDyMQc3UwT/lJWAXRxs2yQ9VN16d+36sw6I35mkSAZ30VmM+dKO+j3LVN8rO96ukRFZ6RkY0tls89K0V887j3J1vn2GlaWn0SPVfdTl1jHpkJNP7TupjHVBbkzeGzDYM3JUorfIh0t0R9tqohJzZBRA0seoCg5b/Cfk+Tr2p3boEnCTD4OBtk+k/YCG21cI8s2sIvY/rWH8Pho71Ca8K+9w1d8uTlm0H5bbX1Nt6+b/uK7mti4qt0h7e92YrPz8af6p1CvycMT7cMh5t1pieqCPENZ68Np2ymfQaL59s//qMmoF/0VdDrU9FJodq2uTBFAXs+PSYdGMUe9w7ff/A3GlZDOoxocFyipttic5gBL5/h4FUCf0giLttfpEP/2vlOxQOtB27q/RY+L8ACGdA0yvgLs1lYHgh2p/oKbGV1NZ763VlOJOZyfXFxOKkna0HClmpbY1sCLZ5LDnCk2bcGYJDMrbutx0DrmKo8vGGQSnJhj7uM9DnJIQhvSTphWnyTFBItVIYNxaBZPuNMCFdcGaI7vCuWb/m63Sz8++wxehC4fLhwzDjk9PaHQg4jSBvysYMaswr51MU4IyKiV8SMIue43GY1G16r1cgC/JA7Ng19FGpp6vv3LX+HqpV7SLDdFRWA4bm14c5DKGNeF3a1f9LQ/Q1n2L4JStv/s7JU/tw6D/99oB5Y8GWd3Ar6nQv2aOlWvS6cTCzegWgijFZm204GD0UcX9tEh8S2NdpoqZIP+TSZYeFNLimDOHNtyxbE2CMesZGMhBR2T9Pw9HDOHU21W8B7eEWgf7xmAa3h/rd53u13/j0g7nfripNOB93Ds7xdyoAKVxxY3pxKqb2NMcaS4b8Kzm9zehG/kfJni1XP+qhKSg8EqwgY1Ju8nw9Jgt5SsQJ7gsl94GcgyBNVrQ1mwqjGiuMUFykmX8tNv8SJFgaXHW4OmbexaY1VqIVyYJSZ0dxCZnlVjKQrYFP9ixgxNIGV4mVJPCnXr00fpxFUK6+oLhcTzuWETB++0uaWdAkeCuRrpPICYbMIscFphvcknQjEpbMRaiMIkvsdaOVZE5/0u1AmfA1GYIryHsda3FGJTw+Ye2mFSrhKTr/3hFnicmilTtFcjmVCWeuG6TD83FI7hRKw98Q7HM61vA5PzOLBROepSOQJcxC6zOQwhRKYBvVSAipdaKJfY+UEw8nJGIE1/RaGrBBjQGemAThJqbsmD7zdTgwL/22/+buENLqnupAODXn4Gzzyy4KvgOx9ucFGVpTbuWtFpMmL1ezuKAUljpdJLsIEQPRbhnVSbKo/Xc60HgSA5tiZoHpA2MabSQ6pftpdEfUm2vwjevIhR91qoW3utCJIbXWczwXEY/D2McTmUniIbBGjvfYDtRiTy6Oz04hL6XrAk54jSjNi0kZ8U3g1wvaEspKGg15j1mMAxNHXqJOcxea1GL04uoZ907A8EH3nlN59T8owCAjwmkM86g2xOQwj3aWaQV4oz5VoXqUCZaXCuF8g9y06nNDjx9zHMseQ4g64yxMcirXUoVwGijjo3DDsdOnNvyQA1HgDIrAg3QoVWtppj7aEzZu1SG949M9oFFPfs+ddNRNF78hNd7A7LSHydjZJdUwElGCJAlkttbsPNgZsBqsKsysiVgNhWAA6uVfRnCKxkxhH8658wOnu7Y3H/uLWgHlQGiW64SbYVJ1svtvbzL6j4kklHyT6nkwk5sI5eqllGyzp+Q6OsA5WP4IcCd1tRH0N7NCU4+46GTUE3ahHZptYv4tZxvzrUqefyFxmJTe3fmHznWtIB6+tDPIZGEEZVH19001FSxSadYjoaLZE8HRAEVhhtre+0vBZUtoyuHHoI2yAC0Yd4rsvMIJzptDudogFfr8zOSR5lGkEngfGH/kzwzVjsVmHj+rtpU2OFC3xoWiI+dRnfhIC9oeJM5fH2ePqlWy7vzXTwjVhJUEpgd8xUyGw6yBM53pHV4pkcpIlnp9/sfV1aAk54rMsVHBwfH5JwohRUoa/VM1C4JLMXRWPtnXrNpFZTf5SRPvX13Oia5p1mHZX1un43hTpUPz9Fpu6i9mI/fmiQnHnikUnGuUFLtYOqGsHYqpGxwTQDAtolBPT7YLevxS02OuQk/oY0cJAuMEOWNBkv+Oiwda1bi0b+MoJHv9enkr9KzP1JHqoUWVYKMqwNVwqlW4GHjeFgdHUzOvwF6Hn8hiWY1mkQaoYmPtxkvdXbPlswIX2mnjSNdWxwW08oJ2jKp/u13eb2IvTevpH4hIa87gTr2W6Tw4NgSL365C1dkuws/hAIM9puZX6Pxgrti9RP4StW3C6Z4RaO9bxkTvjWf0WktJiCwyPRME6E3SISyjBawOKxD+PF497jevJL/Ve8enYzbZG+YLChU6PWt/aHjhjKONndc1UaxgbDqRm+ZrI933y1DmpBhZ9XRcgFLy+xDh8iMAmVCvdJboZmSU0oITl8KzDeWqS5OfZA16oLV3Vr+g7HVjhs5r7lcrlj6UO/5utKyvp7MJ9wH5gWw7IXwr2sxnCOpbbCabNqVk2Fm1Vj78v22vqPyCANKTVE+kOmVM/yEs3c38JdoFmI4gPq9x2R9w+vCdfaQug2YReDEzRUd+zGjM1KEef5qyQHkHg/RA9//RRmFQ/1UukLUOFvtvl4yJZUOJ1EfSNc+bC+WZ5JUaCybezw2Yuz17D4vHdEYFWNe36EL/uvXx2fvLk4IWFimmSD7HHvqHfkryG1dXOmWjttfYC4DXHdNyD5/+v3ihH9pa9k+qVkwmPv8UuKgJtfZS1YdtD+VPEmz2baOiK5v6e689bI9Zoe/6nyqOfVTZ4tmBFUoDy4Hts8vv+Cvm3ug/P08R982lePexVKGLcigNufawHCvcXV1ueXa8JCI9BNEgeK4yBX95L4NBx27k0IqQ8rnvm+80Ha9kXF2dtLgnrjp5Rz/1VmZtiSUGC2DMKGguwhfP/sPpNMTSs2JdrAch2+Nplt4vq3HtePv5BSe82xCfgHLeh/0mnvgvv7cGewXtf04dV3roh2TdTkm5v1ev1vtqGvVw==","sidebar_class_name":"put api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Document","permalink":"/docs/API-docs/v1.1/getdocument"},"next":{"title":"Revoke Document","permalink":"/docs/API-docs/v1.1/revokedocument"}}');var o=n(74848),a=n(28453),s=n(57742),d=n.n(s),p=n(78178),r=n.n(p),m=n(19624),c=n.n(m),l=n(96226),u=n.n(l),h=(n(77675),n(19365),n(51107)),g=n(21312);const f={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:"eJzdWt1uG7kVfpXTWaCxhZHkZLNbVC3aZh1vEjSNDdtpgNqGRA2PJNYUOSU5kgVHwF4UfYCiN73tS/S+j7JPUhz+zIx+1kl2ty3Qi8T2zOHh+ec5H+c+c2xqs8FV9lwX1RyVs9lNnnG0hRGlE1plg+xyhvC25MwhJCp4dvYKmJR6aaGyaCw4DXPNxWQFTHGoArmbIXB0TEgLegIMbImFmIgCeGTUgzfaEzIHbiasZ6yVXCXuTidmDCa4hJIZNkeHxuaw0hUUTCntoJgxNQ0bToRE0KpAEC5IkIQWFgqDzCHvZXmmSzSMVHzFs0EWNkn6ZXnWbJQNru4zxeaYDbLEayh4lmeCzFMyN8u2bfbqOSm8sbvXUSFyr9QYo17Ex+CfKmGQZwNnKswz61aSdrNiXkrM8gzvSqk5ZoMJk5YIihnOWTa4z9yq9JTOCDXN8myizZy55sl6fRP4o3Vfab6iNZuinhm9EBxhjFK37NuyvMN5KZlDCwfMgURmHWiFLdqkwGGWZ4VWjkw4uM9YWUpReCP3/2hpt/td0fX4j1h4ixtyiRNo6W0w+IcVJOMwb6ZBZv0vtcmzdZ4p7T6ZzRmpiGBwIXDp49mKqQrx2ea9YcdP26KOijaPNa2RHA1F5C6/ZjVRomJjiaeXZy3SsdYSmdqJRooq6AYFtH8ISyElBB5wenkGCzSUmN5XPXjrc9rTGCxQLCj92iRQaI6wEAxwzoTMYTkTxYwCfgXzyjpAFWMomg5bKe+DGLqwKxAXdq9EeSgHQk2bcrPDGLgwWDi5gqVwM105YJwLWs4kWIel7bWt6KWoDXmpK/PDLclgWgmOHJyuDEy08VL6YlX6NCMNhLLOVAUttsAr8q7Xg0jp99LoAq1t7JSsQkQt/jmgsmE5gwmzDk0OlRJkeVOVDnnNEu9KNAJVgXtN4I079PU7Gtx+vC3O0MyFs0lTcg3jHFCiP0/AVsUMWHjPXGXQ5iCUcIJJm4N1bF7aHLQBh3dUV8Dpkoon3gnrSPil4FN0FsR3xdE5Uo4ULRkmRs+998k2atUOhFoup7fYXZJThY2n1oRV0sGCyWq/zSwqPhRqqA1HMwwCfITR3s1QgUVH2z8iCz7KAVkxi6LT/mOpi1vkUYmCYiGFSB3qlXJCUlJASQnqFU3Kz9gCodAkLsWAm6EwwIqQ2Sdqok2BFoLEYOloUOSMFCw9OPXnL9VutLAkgR+Rtq/UKen6iGRk0ib5e/A8GMub9JG3z6O9JjMYMnRYGbmvwG1a6iL0Chgc8vb8NYlisE4VNCH1xlSpA2OkzsMXJ6/8jtW2M2ynqLLK6aHBuVAcP6YcXARH+kxwuq4CldNz5kQBiZXtQSQNMet0O6nncJDibYwzthDaHH6HAYndkJobCj1coFm1pFTVfIxmR8g3/jGlFGcrC2N0S0TVli1Fvq4dX3jZvO83bEJUtlF6Q8ovwnErJquhVsMm3ffacVO3bZE7HeLe6UAXLtsO9O2bNlsnkwqHEPjN0wFFspOBqOsM0UI/7GbOX6tr1el4ET6wGTWZP9KG1PEO4BynzHCJ1oZOMRiWYjYHVkewTlvRkdaEPm+kpPakRV1QB+VlQmDOsWKGnJzGsUTFqbz6XB56ro+aFq537fuPEtWw0FKbtteYMWxF7a7Dud1N3HXLm1fZWFboW1pqbMeSFbfZzTrPxkXxfTnSif+b+Hev0PMs94+ebDzbmVrGRQEHYynIPMyMfVUoV4eD2NswTseoLyhbbc6GU4Px/TSxM0qkCtsDCMb7b6tIGv6ndSPN1nnmhNvoW4etQWg4prlivV77CmVLrWxI+idHR7vjRj1CxvGH+gMqxpNKytVPfrz5ITz+UCfNLH/y0p49fVmSR6JIz9zDi54cPfm8+/ioe/Szy8dfDp7+fPDFl72jo6M/ZHl2N5fN8JIRt6xtPf9364FQUigcJqsNnxwdDT+Ppny6z3pxNCnjzLZgUnCYCJQcaE/7IxoQjdHme45OD8j3kPqkclL+6QOhQ8V4oivF/9fq7pPoYQWfDp/WKn6xq+IrFUxGMMilvkX139Cw0ae9vQvbk6ibUS0CkX+fbSjbfh6UtFhURriVx1DuuqwU3fB+cHVDyMQc3UwT/lJWAXRxs2yQ9VN16d+36sw6I35mkSAZ30VmM+dKO+j3LVN8rO96ukRFZ6RkY0tls89K0V887j3J1vn2GlaWn0SPVfdTl1jHpkJNP7TupjHVBbkzeGzDYM3JUorfIh0t0R9tqohJzZBRA0seoCg5b/Cfk+Tr2p3boEnCTD4OBtk+k/YCG21cI8s2sIvY/rWH8Pho71Ca8K+9w1d8uTlm0H5bbX1Nt6+b/uK7mti4qt0h7e92YrPz8af6p1CvycMT7cMh5t1pieqCPENZ68Np2ymfQaL59s//qMmoF/0VdDrU9FJodq2uTBFAXs+PSYdGMUe9w7ff/A3GlZDOoxocFyipttic5gBL5/h4FUCf0giLttfpEP/2vlOxQOtB27q/RY+L8ACGdA0yvgLs1lYHgh2p/oKbGV1NZ763VlOJOZyfXFxOKkna0HClmpbY1sCLZ5LDnCk2bcGYJDMrbutx0DrmKo8vGGQSnJhj7uM9DnJIQhvSTphWnyTFBItVIYNxaBZPuNMCFdcGaI7vCuWb/m63Sz8++wxehC4fLhwzDjk9PaHQg4jSBvysYMaswr51MU4IyKiV8SMIue43GY1G16r1cgC/JA7Ng19FGpp6vv3LX+HqpV7SLDdFRWA4bm14c5DKGNeF3a1f9LQ/Q1n2L4JStv/s7JU/tw6D/99oB5Y8GWd3Ar6nQv2aOlWvS6cTCzegWgijFZm204GD0UcX9tEh8S2NdpoqZIP+TSZYeFNLimDOHNtyxbE2CMesZGMhBR2T9Pw9HDOHU21W8B7eEWgf7xmAa3h/rd53u13/j0g7nfripNOB93Ds7xdyoAKVxxY3pxKqb2NMcaS4b8Kzm9zehG/kfJni1XP+qhKSg8EqwgY1Ju8nw9Jgt5SsQJ7gsl94GcgyBNVrQ1mwqjGiuMUFykmX8tNv8SJFgaXHW4OmbexaY1VqIVyYJSZ0dxCZnlVjKQrYFP9ixgxNIGV4mVJPCnXr00fpxFUK6+oLhcTzuWETB++0uaWdAkeCuRrpPICYbMIscFphvcknQjEpbMRaiMIkvsdaOVZE5/0u1AmfA1GYIryHsda3FGJTw+Ye2mFSrhKTr/3hFnicmilTtFcjmVCWeuG6TD83FI7hRKw98Q7HM61vA5PzOLBROepSOQJcxC6zOQwhRKYBvVSAipdaKJfY+UEw8nJGIE1/RaGrBBjQGemAThJqbsmD7zdTgwL/22/+buENLqnupAODXn4Gzzyy4KvgOx9ucFGVpTbuWtFpMmL1ezuKAUljpdJLsIEQPRbhnVSbKo/Xc60HgSA5tiZoHpA2MabSQ6pftpdEfUm2vwjevIhR91qoW3utCJIbXWczwXEY/D2McTmUniIbBGjvfYDtRiTy6Oz04hL6XrAk54jSjNi0kZ8U3g1wvaEspKGg15j1mMAxNHXqJOcxea1GL04uoZ907A8EH3nlN59T8owCAjwmkM86g2xOQwj3aWaQV4oz5VoXqUCZaXCuF8g9y06nNDjx9zHMseQ4g64yxMcirXUoVwGijjo3DDsdOnNvyQA1HgDIrAg3QoVWtppj7aEzZu1SG949M9oFFPfs+ddNRNF78hNd7A7LSHydjZJdUwElGCJAlkttbsPNgZsBqsKsysiVgNhWAA6uVfRnCKxkxhH8658wOnu7Y3H/uLWgHlQGiW64SbYVJ1svtvbzL6j4kklHyT6nkwk5sI5eqllGyzp+Q6OsA5WP4IcCd1tRH0N7NCU4+46GTUE3ahHZptYv4tZxvzrUqefyFxmJTe3fmHznWtIB6+tDPIZGEEZVH19001FSxSadYjoaLZE8HRAEVhhtre+0vBZUtoyuHHoI2yAC0Yd4rsvMIJzptDudogFfr8zOSR5lGkEngfGH/kzwzVjsVmHj+rtpU2OFC3xoWiI+dRnfhIC9oeJM5fH2ePqlWy7vzXTwjVhJUEpgd8xUyGw6yBM53pHV4pkcpIlnp9/sfV1aAk54rMsVHBwfH5JwohRUoa/VM1C4JLMXRWPtnXrNpFZTf5SRPvX13Oia5p1mHZX1un43hTpUPz9Fpu6i9mI/fmiQnHnikUnGuUFLtYOqGsHYqpGxwTQDAtolBPT7YLevxS02OuQk/oY0cJAuMEOWNBkv+Oiwda1bi0b+MoJHv9enkr9KzP1JHqoUWVYKMqwNVwqlW4GHjeFgdHUzOvwF6Hn8hiWY1mkQaoYmPtxkvdXbPlswIX2mnjSNdWxwW08oJ2jKp/u13eb2IvTevpH4hIa87gTr2W6Tw4NgSL365C1dkuws/hAIM9puZX6Pxgrti9RP4StW3C6Z4RaO9bxkTvjWf0WktJiCwyPRME6E3SISyjBawOKxD+PF497jevJL/Ve8enYzbZG+YLChU6PWt/aHjhjKONndc1UaxgbDqRm+ZrI933y1DmpBhZ9XRcgFLy+xDh8iMAmVCvdJboZmSU0oITl8KzDeWqS5OfZA16oLV3Vr+g7HVjhs5r7lcrlj6UO/5utKyvp7MJ9wH5gWw7IXwr2sxnCOpbbCabNqVk2Fm1Vj78v22vqPyCANKTVE+kOmVM/yEs3c38JdoFmI4gPq9x2R9w+vCdfaQug2YReDEzRUd+zGjM1KEef5qyQHkHg/RA9//RRmFQ/1UukLUOFvtvl4yJZUOJ1EfSNc+bC+WZ5JUaCybezw2Yuz17D4vHdEYFWNe36EL/uvXx2fvLk4IWFimmSD7HHvqHfkryG1dXOmWjttfYC4DXHdNyD5/+v3ihH9pa9k+qVkwmPv8UuKgJtfZS1YdtD+VPEmz2baOiK5v6e689bI9Zoe/6nyqOfVTZ4tmBFUoDy4Hts8vv+Cvm3ug/P08R982lePexVKGLcigNufawHCvcXV1ueXa8JCI9BNEgeK4yBX95L4NBx27k0IqQ8rnvm+80Ha9kXF2dtLgnrjp5Rz/1VmZtiSUGC2DMKGguwhfP/sPpNMTSs2JdrAch2+Nplt4vq3HtePv5BSe82xCfgHLeh/0mnvgvv7cGewXtf04dV3roh2TdTkm5v1ev1vtqGvVw==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-2",custom_edit_url:null},v=void 0,w={},b=[];function x(e){const t={p:"p",...(0,a.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Update Document"}),"\n",(0,o.jsx)(d(),{method:"put",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,o.jsx)(t.p,{children:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created."}),"\n",(0,o.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,o.jsx)(g.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,o.jsx)(r(),{...n(38679)}),"\n",(0,o.jsx)(c(),{...n(96925)}),"\n",(0,o.jsx)(u(),{...n(24083)})]})}function y(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(x,{...e})}):x(e)}},38679(e){e.exports=JSON.parse('{"parameters":[{"name":"document_id","in":"path","description":"ID of the document that needs to be updated","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string"}}]}')},96925(e){e.exports=JSON.parse('{"title":"Body","body":{"description":"Provide below parameter to update templates (at least one parameter required)","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","format":"string","example":"sample document"},"note":{"type":"string","format":"string","example":"Please review and sign this document"},"description":{"type":"string","format":"string","example":"document description"},"folderId":{"type":"string","example":""},"enableOTP":{"type":"boolean","description":"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.","example":false},"enableTour":{"type":"boolean","description":"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.","example":false},"allow_modifications":{"type":"boolean","description":"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.","example":false},"send_in_order_strict":{"type":"boolean","description":"When set to \'true\', each signer is blocked from accessing the document until all preceding signers have completed their action. Enforces strict sequential signing. Only applies when \'sendInOrder\' is also \'true\'. Defaults to \'false\'.","example":false},"redirect_url":{"type":"string","description":"Specifies the URL where the signer will be redirected upon completing the document signing process.","example":""},"auto_reminder":{"type":"boolean","description":"Set to true to enable automatic reminders. Set to false to disable them (default behavior).","example":false},"remind_once_in_every":{"type":"number","description":"Number of days between reminders. This is only applicable when auto_reminder is set to true.","example":5},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed. \\n"},"cc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"cc (carbon copy): Users added here will receive a notification email once the document is completed.\\n"}},"title":"document_document_id_body"}}}}}')},24083(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Document updated successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","example":"asd2HsP4Hp"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"title":"inline_response_200_3"}}}},"400":{"description":"Please provide valid field names!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","format":"string","example":"Please provide valid field names!"}},"title":"inline_response_400"}}}},"404":{"description":"Document not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","format":"string","example":"Document not found!"}},"title":"inline_response_404_4"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/main.0fdb865b.js b/assets/js/main.0fdb865b.js new file mode 100644 index 000000000..7c9cb1055 --- /dev/null +++ b/assets/js/main.0fdb865b.js @@ -0,0 +1,2 @@ +/*! For license information please see main.0fdb865b.js.LICENSE.txt */ +(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[8792],{35947(e,t,n){"use strict";n.d(t,{A:()=>p});n(96540);var r=n(53259),o=n.n(r),a=n(84054);const i={"0058b4c6":[()=>n.e(849).then(n.t.bind(n,86164,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-175.json",86164],"01274ace":[()=>Promise.all([n.e(1869),n.e(2076),n.e(5506)]).then(n.bind(n,47757)),"@site/docs/API-docs/v1/drafttemplate.api.mdx",47757],"012b45bf":[()=>n.e(8503).then(n.t.bind(n,74259,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-category-docker-b13.json",74259],"01a85c17":[()=>Promise.all([n.e(1869),n.e(2076),n.e(8209)]).then(n.bind(n,92463)),"@theme/BlogTagsListPage",92463],"02d4f5c5":[()=>Promise.all([n.e(2076),n.e(5510)]).then(n.bind(n,85210)),"@site/docs/self-host/guides/azure-vm-setup.md",85210],"02e5f5c4":[()=>Promise.all([n.e(1869),n.e(2076),n.e(5373)]).then(n.bind(n,42232)),"@site/docs/API-docs/v1.1/createfolder.api.mdx",42232],"02fcf422":[()=>Promise.all([n.e(1869),n.e(2076),n.e(9490)]).then(n.bind(n,64238)),"@site/docs/API-docs/v1/getdocumentlist.api.mdx",64238],"03e06346":[()=>Promise.all([n.e(1869),n.e(2076),n.e(3404)]).then(n.bind(n,74671)),"@site/docs/API-docs/v1.1/publictemplate.api.mdx",74671],"044432a7":[()=>Promise.all([n.e(1869),n.e(2076),n.e(6800)]).then(n.bind(n,24159)),"@site/docs/API-docs/v1.2/publictemplate.api.mdx",24159],"046910c8":[()=>Promise.all([n.e(2076),n.e(962)]).then(n.bind(n,76026)),"@site/docs/help/Reports/declined.md",76026],"05729a5b":[()=>Promise.all([n.e(1869),n.e(2076),n.e(930)]).then(n.bind(n,99055)),"@site/docs/API-docs/v1/contactlist.api.mdx",99055],"06b6ef6a":[()=>Promise.all([n.e(2076),n.e(9611)]).then(n.bind(n,81551)),"@site/docs/help/Reports/expired.md",81551],"0a7196e9":[()=>Promise.all([n.e(2076),n.e(225)]).then(n.bind(n,40181)),"@site/docs/help/FAQs/User Deletion.md",40181],"0ba00a8d":[()=>Promise.all([n.e(1869),n.e(2076),n.e(2815)]).then(n.bind(n,80832)),"@site/docs/API-docs/v1.2/get-webhook.api.mdx",80832],"0c03cd54":[()=>Promise.all([n.e(1869),n.e(2076),n.e(1265)]).then(n.bind(n,27491)),"@site/docs/API-docs/v1.2/getsigninglinks.api.mdx",27491],"0c0943c7":[()=>Promise.all([n.e(2076),n.e(6648)]).then(n.bind(n,67682)),"@site/docs/help/Reports/need-your-sign.md",67682],"0c806540":[()=>Promise.all([n.e(1869),n.e(2076),n.e(9239)]).then(n.bind(n,31697)),"@site/docs/API-docs/v1/createfolder.api.mdx",31697],"0e384e19":[()=>Promise.all([n.e(2076),n.e(3976)]).then(n.bind(n,2053)),"@site/docs/intro.md",2053],"0edab2fb":[()=>Promise.all([n.e(2076),n.e(6827)]).then(n.bind(n,27047)),"@site/docs/help/User Menu/Console/emails.md",27047],"0f8cf55d":[()=>n.e(5970).then(n.t.bind(n,1809,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-category-create-new-opensign-document-b47.json",1809],"107ddcf4":[()=>Promise.all([n.e(2076),n.e(284)]).then(n.bind(n,98190)),"@site/docs/help/User Menu/Console/organizations.md",98190],"11b7b3d8":[()=>Promise.all([n.e(2076),n.e(9241)]).then(n.bind(n,65930)),"@site/docs/help/OpenSign\u2122 Drive/organize-documents.md",65930],"138cee78":[()=>Promise.all([n.e(1869),n.e(2076),n.e(1679)]).then(n.bind(n,14988)),"@site/docs/API-docs/v1.1/createcontact.api.mdx",14988],"14716de7":[()=>Promise.all([n.e(2076),n.e(5550)]).then(n.bind(n,82695)),"@site/docs/help/Settings/manage-users.md",82695],"14eb3368":[()=>Promise.all([n.e(1869),n.e(2076),n.e(6969)]).then(n.bind(n,60477)),"@theme/DocCategoryGeneratedIndexPage",60477],"17e5210b":[()=>Promise.all([n.e(2076),n.e(2264)]).then(n.bind(n,88637)),"@site/docs/contribute/COMMUNITY.md",88637],"18b84479":[()=>Promise.all([n.e(1869),n.e(2076),n.e(1706)]).then(n.bind(n,23342)),"@site/docs/API-docs/v1.1/deletedocument.api.mdx",23342],"193ad4d3":[()=>Promise.all([n.e(1869),n.e(2076),n.e(8626)]).then(n.bind(n,48744)),"@site/docs/API-docs/v1.1/update-contact.api.mdx",48744],"19e4dfff":[()=>Promise.all([n.e(1869),n.e(2076),n.e(956)]).then(n.bind(n,76394)),"@site/docs/API-docs/v1/selfsign.api.mdx",76394],"19e5ad2a":[()=>Promise.all([n.e(1869),n.e(2076),n.e(1651)]).then(n.bind(n,72908)),"@site/docs/API-docs/v1.1/contactlist.api.mdx",72908],"1b14d97a":[()=>Promise.all([n.e(1869),n.e(2076),n.e(108)]).then(n.bind(n,65159)),"@site/docs/API-docs/v1/deletefolder.api.mdx",65159],"1e1b513c":[()=>Promise.all([n.e(1869),n.e(2076),n.e(3148)]).then(n.bind(n,94348)),"@site/docs/API-docs/v1/update-document.api.mdx",94348],"1ee58ee1":[()=>Promise.all([n.e(2076),n.e(3554),n.e(7696)]).then(n.bind(n,86518)),"@site/docs/help/Templates/embed-template.md",86518],"1f391b9e":[()=>Promise.all([n.e(1869),n.e(2076),n.e(6061)]).then(n.bind(n,67973)),"@theme/MDXPage",67973],"1f7895dc":[()=>Promise.all([n.e(2076),n.e(9858)]).then(n.bind(n,80492)),"@site/docs/help/Templates/quick-send.md",80492],"20f41f87":[()=>Promise.all([n.e(2076),n.e(7381)]).then(n.bind(n,99358)),"@site/docs/help/User Menu/Console/globalSMTP.md",99358],"21f05a2f":[()=>Promise.all([n.e(2076),n.e(5524)]).then(n.bind(n,38353)),"@site/docs/help/Settings/Custom-email-templates.md",38353],"23f866da":[()=>Promise.all([n.e(1869),n.e(2076),n.e(285)]).then(n.bind(n,97831)),"@site/docs/API-docs/v1.1/selfsign.api.mdx",97831],"257dcba5":[()=>Promise.all([n.e(1869),n.e(2076),n.e(5824)]).then(n.bind(n,50172)),"@site/docs/API-docs/v1.2/drafttemplate.api.mdx",50172],"277a78f5":[()=>Promise.all([n.e(2076),n.e(1440)]).then(n.bind(n,78389)),"@site/docs/contribute/INSTALLATION.md",78389],"293ced56":[()=>Promise.all([n.e(1869),n.e(2076),n.e(3588)]).then(n.bind(n,97016)),"@site/docs/API-docs/v1.2/update-document.api.mdx",97016],"299c7a47":[()=>Promise.all([n.e(2076),n.e(2131)]).then(n.bind(n,96357)),"@site/docs/help/Templates/publicTemplate.md",96357],"2c416566":[()=>Promise.all([n.e(2076),n.e(3554),n.e(2908)]).then(n.bind(n,69526)),"@site/docs/help/intro.md",69526],"2ea02f7b":[()=>Promise.all([n.e(1869),n.e(2076),n.e(9316)]).then(n.bind(n,12704)),"@site/docs/API-docs/v1.2/deletefolder.api.mdx",12704],"2f6ff211":[()=>Promise.all([n.e(1869),n.e(2076),n.e(1477)]).then(n.bind(n,64316)),"@site/docs/API-docs/v1/get-user.api.mdx",64316],"2ffc1e57":[()=>n.e(3724).then(n.t.bind(n,32297,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-category-user-menu-278.json",32297],"3009d411":[()=>Promise.all([n.e(1869),n.e(2076),n.e(89)]).then(n.bind(n,68117)),"@site/docs/API-docs/v1/getcontact.api.mdx",68117],"3217192f":[()=>n.e(8462).then(n.t.bind(n,8174,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-tags-docusaurus-f20.json",8174],"34593b53":[()=>Promise.all([n.e(1869),n.e(2076),n.e(9099)]).then(n.bind(n,28598)),"@site/docs/API-docs/v1.1/createdocument.api.mdx",28598],"36994c47":[()=>n.e(7477).then(n.t.bind(n,45516,19)),"@generated/docusaurus-plugin-content-blog/default/__plugin.json",45516],"38ec836e":[()=>Promise.all([n.e(2076),n.e(9426)]).then(n.bind(n,11255)),"@site/docs/self-host/intro.md",11255],"393be207":[()=>Promise.all([n.e(2076),n.e(4134)]).then(n.bind(n,10591)),"@site/src/pages/markdown-page.md",10591],"3973fcf3":[()=>n.e(6157).then(n.t.bind(n,46074,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-category-templates-7d7.json",46074],"3a2a59a1":[()=>Promise.all([n.e(1869),n.e(2076),n.e(5864)]).then(n.bind(n,40830)),"@site/docs/API-docs/v1.2/opensign-api-v-1-2.info.mdx",40830],"3a2db09e":[()=>n.e(8121).then(n.t.bind(n,68070,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-tags-df9.json",68070],"3b49dc44":[()=>Promise.all([n.e(1869),n.e(2076),n.e(5794)]).then(n.bind(n,13897)),"@site/docs/API-docs/v1/opensign-api-v-1.info.mdx",13897],"3b95ab04":[()=>Promise.all([n.e(1869),n.e(2076),n.e(1543)]).then(n.bind(n,83669)),"@site/docs/API-docs/v1.2/get-template.api.mdx",83669],"3c9ed71a":[()=>Promise.all([n.e(1869),n.e(2076),n.e(5946)]).then(n.bind(n,49169)),"@site/docs/API-docs/v1.2/createdocument.api.mdx",49169],"4227e71a":[()=>Promise.all([n.e(1869),n.e(2076),n.e(5342)]).then(n.bind(n,64875)),"@site/docs/API-docs/v1.1/get-template.api.mdx",64875],"42f80fc5":[()=>Promise.all([n.e(2076),n.e(3381)]).then(n.bind(n,42718)),"@site/docs/help/New-Document/enforce-email-verification.md",42718],"444a2573":[()=>Promise.all([n.e(1869),n.e(2076),n.e(5855)]).then(n.bind(n,34574)),"@site/docs/API-docs/v1/update-template.api.mdx",34574],"44f24773":[()=>Promise.all([n.e(1869),n.e(2076),n.e(9038)]).then(n.bind(n,30383)),"@site/docs/API-docs/v1.2/createdocumentwithtemplateid.api.mdx",30383],"489197af":[()=>Promise.all([n.e(1869),n.e(2076),n.e(7968)]).then(n.bind(n,21078)),"@site/docs/API-docs/v1/getdocument.api.mdx",21078],"489b8a4d":[()=>Promise.all([n.e(2076),n.e(1179)]).then(n.bind(n,82244)),"@site/docs/self-host/docker/run-locally.md",82244],"4acb0154":[()=>Promise.all([n.e(2076),n.e(791)]).then(n.bind(n,48337)),"@site/docs/help/User Menu/Console/general.md",48337],"4c5e977b":[()=>Promise.all([n.e(1869),n.e(2076),n.e(5453),n.e(6473)]).then(n.t.bind(n,75453,23)),"@theme/ApiItem",75453],"4cff09f6":[()=>n.e(3021).then(n.t.bind(n,14918,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-category-guides-015.json",14918],"4d139b56":[()=>Promise.all([n.e(1869),n.e(2076),n.e(7075)]).then(n.bind(n,71236)),"@site/docs/API-docs/v1.1/getcredits.api.mdx",71236],"4f7a2d40":[()=>Promise.all([n.e(2076),n.e(291)]).then(n.bind(n,20833)),"@site/docs/self-host/cloud-storage/s3.md",20833],"500027af":[()=>Promise.all([n.e(2076),n.e(560)]).then(n.bind(n,96742)),"@site/docs/help/Reports/drafts.md",96742],"503125be":[()=>Promise.all([n.e(1869),n.e(2076),n.e(5372)]).then(n.bind(n,39546)),"@site/docs/API-docs/v1.2/deletedocument.api.mdx",39546],"5144c8d4":[()=>Promise.all([n.e(1869),n.e(2076),n.e(7904)]).then(n.bind(n,41145)),"@site/docs/API-docs/v1.1/get-user.api.mdx",41145],"51e6fce0":[()=>Promise.all([n.e(1869),n.e(2076),n.e(5174)]).then(n.bind(n,30761)),"@site/docs/API-docs/v1.2/createfolder.api.mdx",30761],"54a7b8f4":[()=>Promise.all([n.e(1869),n.e(2076),n.e(8e3)]).then(n.bind(n,5999)),"@site/docs/API-docs/v1/getfolder.api.mdx",5999],"56b0ffe9":[()=>Promise.all([n.e(1869),n.e(2076),n.e(4466)]).then(n.bind(n,77990)),"@site/docs/API-docs/v1/updatefolder.api.mdx",77990],"56b5f4f8":[()=>Promise.all([n.e(2076),n.e(3841)]).then(n.bind(n,31522)),"@site/docs/help/Settings/disabledocumentid.md",31522],"56f1c106":[()=>Promise.all([n.e(2076),n.e(6011)]).then(n.bind(n,99771)),"@site/docs/API-docs/v1.1/intro.md",99771],"57cd9455":[()=>Promise.all([n.e(1869),n.e(2076),n.e(5939)]).then(n.bind(n,80679)),"@site/docs/API-docs/v1.2/update-contact.api.mdx",80679],"58abd73c":[()=>Promise.all([n.e(1869),n.e(2076),n.e(8564)]).then(n.bind(n,64502)),"@site/docs/API-docs/v1.1/folderlist.api.mdx",64502],59362658:[()=>Promise.all([n.e(2076),n.e(9325)]).then(n.bind(n,81180)),"@site/blog/2021-08-01-mdx-blog-post.mdx",81180],"5a144266":[()=>Promise.all([n.e(1869),n.e(2076),n.e(4232)]).then(n.bind(n,98162)),"@site/docs/API-docs/v1.1/gettemplatelist.api.mdx",98162],"5a9dd378":[()=>Promise.all([n.e(2076),n.e(4504)]).then(n.bind(n,46620)),"@site/docs/help/User Menu/Console/orgadmin.md",46620],"5c485335":[()=>Promise.all([n.e(2076),n.e(2075)]).then(n.bind(n,31515)),"@site/docs/help/New-Document/widgets.md",31515],"5ce6d213":[()=>Promise.all([n.e(1869),n.e(2076),n.e(3460)]).then(n.bind(n,32779)),"@site/docs/API-docs/v1.1/update-template.api.mdx",32779],"5e1bb91e":[()=>Promise.all([n.e(2076),n.e(6353)]).then(n.bind(n,13625)),"@site/docs/help/Reports/contactbook.md",13625],"5e90a9b3":[()=>n.e(8025).then(n.t.bind(n,27134,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-tags-hola-73f.json",27134],"5e95c892":[()=>n.e(9647).then(n.bind(n,7121)),"@theme/DocsRoot",7121],"5e9f5e1a":[()=>Promise.resolve().then(n.bind(n,4784)),"@generated/docusaurus.config",4784],"611db08b":[()=>Promise.all([n.e(2076),n.e(6007)]).then(n.bind(n,54942)),"@site/docs/help/New-Document/sign-yourself.md",54942],61361021:[()=>Promise.all([n.e(1869),n.e(2076),n.e(1915)]).then(n.bind(n,54335)),"@site/docs/API-docs/v1.2/deletecontact.api.mdx",54335],"621db11d":[()=>Promise.all([n.e(1869),n.e(2076),n.e(4129),n.e(4212)]).then(n.bind(n,13250)),"@theme/Blog/Pages/BlogAuthorsListPage",13250],"62b755e6":[()=>Promise.all([n.e(1869),n.e(2076),n.e(9350)]).then(n.bind(n,19899)),"@site/docs/API-docs/v1.1/getdocumentlist.api.mdx",19899],"63d7f7ab":[()=>Promise.all([n.e(1869),n.e(2076),n.e(5881)]).then(n.bind(n,14147)),"@site/docs/API-docs/v1/createdocumentwithtemplateid.api.mdx",14147],"63ead021":[()=>Promise.all([n.e(1869),n.e(2076),n.e(8763)]).then(n.bind(n,57e3)),"@site/docs/API-docs/v1.1/opensign-api-v-1-2.info.mdx",57e3],"64218a31":[()=>Promise.all([n.e(1869),n.e(2076),n.e(3979)]).then(n.bind(n,90207)),"@site/docs/API-docs/v1.1/getformdata.api.mdx",90207],"652d83be":[()=>Promise.all([n.e(1869),n.e(2076),n.e(8474)]).then(n.bind(n,43522)),"@site/docs/API-docs/v1/resendrequestmail.api.mdx",43522],"656c0f50":[()=>Promise.all([n.e(1869),n.e(2076),n.e(4380)]).then(n.bind(n,93298)),"@site/docs/API-docs/v1.2/updatefolder.api.mdx",93298],"6621d3c0":[()=>Promise.all([n.e(2076),n.e(3554),n.e(8046)]).then(n.bind(n,49280)),"@site/docs/help/Settings/SecurityManagement.md",49280],"6875c492":[()=>Promise.all([n.e(1869),n.e(2076),n.e(4129),n.e(4528),n.e(4813)]).then(n.bind(n,33069)),"@theme/BlogTagsPostsPage",33069],"6bef026b":[()=>Promise.all([n.e(2076),n.e(4952)]).then(n.bind(n,14630)),"@site/docs/help/Settings/Preferences.md",14630],"6c0cc40d":[()=>Promise.all([n.e(2076),n.e(8168)]).then(n.bind(n,20543)),"@site/docs/API-docs/v1/intro.md",20543],"6cb65baf":[()=>n.e(9190).then(n.t.bind(n,95890,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-category-settings-09e.json",95890],"6d2e526e":[()=>Promise.all([n.e(1869),n.e(2076),n.e(5752)]).then(n.bind(n,16027)),"@site/docs/API-docs/v1.1/revokedocument.api.mdx",16027],70276854:[()=>Promise.all([n.e(1869),n.e(2076),n.e(7574)]).then(n.bind(n,73010)),"@site/docs/API-docs/v1/delete-webhook.api.mdx",73010],"703158d7":[()=>Promise.all([n.e(1869),n.e(2076),n.e(9330)]).then(n.bind(n,68762)),"@site/docs/API-docs/v1.2/get-user.api.mdx",68762],"7357a3c5":[()=>Promise.all([n.e(1869),n.e(2076),n.e(1665)]).then(n.bind(n,98268)),"@site/docs/API-docs/v1.1/getfolder.api.mdx",98268],"73664a40":[()=>Promise.all([n.e(2076),n.e(1972)]).then(n.bind(n,49581)),"@site/blog/2019-05-29-long-blog-post.md",49581],"74c638d3":[()=>Promise.all([n.e(1869),n.e(2076),n.e(1335)]).then(n.bind(n,51412)),"@site/docs/API-docs/v1.2/gettemplatelist.api.mdx",51412],"7661071f":[()=>Promise.all([n.e(2076),n.e(8737)]).then(n.bind(n,24137)),"@site/blog/2021-08-26-welcome/index.md?truncated=true",24137],"767ebc75":[()=>Promise.all([n.e(1869),n.e(2076),n.e(7797)]).then(n.bind(n,5049)),"@site/docs/API-docs/v1.1/getsignerips.api.mdx",5049],"7ad5624c":[()=>Promise.all([n.e(1869),n.e(2076),n.e(33)]).then(n.bind(n,14397)),"@site/docs/API-docs/v1.1/getcontact.api.mdx",14397],"7c0adceb":[()=>n.e(6854).then(n.t.bind(n,68552,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-api-docs-v-1-2-4ea.json",68552],"7ef59f7a":[()=>Promise.all([n.e(1869),n.e(2076),n.e(4865)]).then(n.bind(n,62634)),"@site/docs/API-docs/v1.1/getdocument.api.mdx",62634],"8001f939":[()=>Promise.all([n.e(2076),n.e(157)]).then(n.bind(n,93554)),"@site/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements.md",93554],"814f3328":[()=>n.e(7472).then(n.t.bind(n,55513,19)),"~blog/default/blog-post-list-prop-default.json",55513],"825a5e83":[()=>Promise.all([n.e(1869),n.e(2076),n.e(8110)]).then(n.bind(n,53208)),"@site/docs/API-docs/v1/delete-template.api.mdx",53208],"8320e026":[()=>Promise.all([n.e(2076),n.e(5277)]).then(n.bind(n,35397)),"@site/docs/API-docs/intro.md",35397],"833eda7d":[()=>n.e(300).then(n.t.bind(n,31878,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-api-docs-v-1-513.json",31878],"837d4f04":[()=>Promise.all([n.e(2076),n.e(8320)]).then(n.bind(n,23247)),"@site/docs/help/New-Document/edit-document-before-sending.md",23247],"851f8f65":[()=>Promise.all([n.e(1869),n.e(2076),n.e(9070)]).then(n.bind(n,11184)),"@site/docs/API-docs/v1.1/draftdocument.api.mdx",11184],"8717b14a":[()=>Promise.all([n.e(2076),n.e(3694)]).then(n.bind(n,61615)),"@site/blog/2019-05-29-long-blog-post.md?truncated=true",61615],"873e7b96":[()=>Promise.all([n.e(2076),n.e(6302)]).then(n.bind(n,3421)),"@site/docs/help/User Menu/Console/analystics.md",3421],"87a6df42":[()=>n.e(5305).then(n.t.bind(n,69202,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-category-documents-5d7.json",69202],"882238ec":[()=>Promise.all([n.e(1869),n.e(2076),n.e(4106)]).then(n.bind(n,94706)),"@site/docs/API-docs/v1/get-template.api.mdx",94706],"8871da57":[()=>Promise.all([n.e(1869),n.e(2076),n.e(6742)]).then(n.bind(n,13164)),"@site/docs/API-docs/v1.2/delete-template.api.mdx",13164],"88a819d0":[()=>Promise.all([n.e(2076),n.e(5314)]).then(n.bind(n,15851)),"@site/docs/help/Templates/manage-templates.md",15851],"8bd80e56":[()=>Promise.all([n.e(1869),n.e(2076),n.e(2661)]).then(n.bind(n,4471)),"@site/docs/API-docs/v1/deletecontact.api.mdx",4471],"8e4d0438":[()=>Promise.all([n.e(2076),n.e(3891)]).then(n.bind(n,29734)),"@site/docs/help/Settings/APIToken.md",29734],"925b3f96":[()=>Promise.all([n.e(2076),n.e(8609)]).then(n.bind(n,95026)),"@site/blog/2019-05-28-first-blog-post.md?truncated=true",95026],"94e1fa32":[()=>Promise.all([n.e(1869),n.e(2076),n.e(6582)]).then(n.bind(n,41501)),"@site/docs/API-docs/v1.2/getdocument.api.mdx",41501],"951b8254":[()=>Promise.all([n.e(1869),n.e(2076),n.e(6289)]).then(n.bind(n,36258)),"@site/docs/API-docs/v1.2/update-template.api.mdx",36258],"9640838e":[()=>Promise.all([n.e(2076),n.e(1688)]).then(n.bind(n,80766)),"@site/docs/help/Templates/create-template.md",80766],"96f83544":[()=>Promise.all([n.e(2076),n.e(3554),n.e(9260)]).then(n.bind(n,40902)),"@site/docs/help/User Menu/Profile.md",40902],"980c6622":[()=>Promise.all([n.e(1869),n.e(2076),n.e(5919)]).then(n.bind(n,49757)),"@site/docs/API-docs/v1.1/getsigninglinks.api.mdx",49757],"98334e25":[()=>Promise.all([n.e(1869),n.e(2076),n.e(7024)]).then(n.bind(n,92846)),"@site/docs/API-docs/v1.1/get-webhook.api.mdx",92846],"98732f61":[()=>Promise.all([n.e(1869),n.e(2076),n.e(1065)]).then(n.bind(n,73407)),"@site/docs/API-docs/v1.2/getcredits.api.mdx",73407],"9b0b43bf":[()=>Promise.all([n.e(2076),n.e(2823)]).then(n.bind(n,32146)),"@site/docs/API-docs/v1.2/intro.md",32146],"9c9cb35e":[()=>Promise.all([n.e(1869),n.e(2076),n.e(4240)]).then(n.bind(n,41875)),"@site/docs/API-docs/v1.1/createtemplate.api.mdx",41875],"9cd612ce":[()=>Promise.all([n.e(1869),n.e(2076),n.e(4372)]).then(n.bind(n,15795)),"@site/docs/API-docs/v1.1/deletefolder.api.mdx",15795],"9e4087bc":[()=>Promise.all([n.e(2076),n.e(2711)]).then(n.bind(n,89331)),"@theme/BlogArchivePage",89331],a000203c:[()=>Promise.all([n.e(1869),n.e(2076),n.e(6940)]).then(n.bind(n,12951)),"@site/docs/API-docs/v1/createdocument.api.mdx",12951],a3008c1e:[()=>Promise.all([n.e(1869),n.e(2076),n.e(9570)]).then(n.bind(n,59503)),"@site/docs/API-docs/v1/createtemplate.api.mdx",59503],a3b21423:[()=>Promise.all([n.e(1869),n.e(2076),n.e(7533)]).then(n.bind(n,35063)),"@site/docs/API-docs/v1.2/revokedocument.api.mdx",35063],a6aa9e1f:[()=>Promise.all([n.e(1869),n.e(2076),n.e(4129),n.e(4528),n.e(7643)]).then(n.bind(n,35124)),"@theme/BlogListPage",35124],a7456010:[()=>n.e(1235).then(n.t.bind(n,88552,19)),"@generated/docusaurus-plugin-content-pages/default/__plugin.json",88552],a7bd4aaa:[()=>n.e(7098).then(n.bind(n,74532)),"@theme/DocVersionRoot",74532],a94703ab:[()=>Promise.all([n.e(1869),n.e(2076),n.e(9048)]).then(n.bind(n,26203)),"@theme/DocRoot",26203],ab2a161b:[()=>Promise.all([n.e(2076),n.e(8097)]).then(n.bind(n,676)),"@site/docs/self-host/guides/how-to-generate-self-signed-document-signing-certificate.md",676],aba21aa0:[()=>n.e(5742).then(n.t.bind(n,27093,19)),"@generated/docusaurus-plugin-content-docs/default/__plugin.json",27093],ac7da374:[()=>Promise.all([n.e(1869),n.e(2076),n.e(2043)]).then(n.bind(n,40327)),"@site/docs/API-docs/v1.1/delete-template.api.mdx",40327],acecf23e:[()=>n.e(1903).then(n.t.bind(n,1912,19)),"~blog/default/blogMetadata-default.json",1912],b0378e01:[()=>Promise.all([n.e(2076),n.e(8927)]).then(n.bind(n,35569)),"@site/docs/help/OpenSign\u2122 Drive/list-grid-view.md",35569],b18842e4:[()=>Promise.all([n.e(2076),n.e(5597)]).then(n.bind(n,16363)),"@site/docs/self-host/guides/env-variables.md",16363],b2e6bd40:[()=>Promise.all([n.e(1869),n.e(2076),n.e(7960)]).then(n.bind(n,99088)),"@site/docs/API-docs/v1.1/resendrequestmail.api.mdx",99088],b3eb04bc:[()=>Promise.all([n.e(1869),n.e(2076),n.e(1210)]).then(n.bind(n,53630)),"@site/docs/API-docs/v1.2/folderlist.api.mdx",53630],b93339ed:[()=>Promise.all([n.e(1869),n.e(2076),n.e(8749)]).then(n.bind(n,33727)),"@site/docs/API-docs/v1.1/updatefolder.api.mdx",33727],b97a0b7b:[()=>Promise.all([n.e(1869),n.e(2076),n.e(3633)]).then(n.bind(n,39446)),"@site/docs/API-docs/v1/folderlist.api.mdx",39446],b9fdab4b:[()=>Promise.all([n.e(1869),n.e(2076),n.e(8089)]).then(n.bind(n,86761)),"@site/docs/API-docs/v1.2/getsignerips.api.mdx",86761],bb4fa758:[()=>n.e(6318).then(n.t.bind(n,77911,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-category-manage-docs-using-opensign-drive-2c0.json",77911],bd0e2f4c:[()=>Promise.all([n.e(1869),n.e(2076),n.e(2403)]).then(n.bind(n,17886)),"@site/docs/API-docs/v1.2/delete-webhook.api.mdx",17886],be3c2a14:[()=>Promise.all([n.e(1869),n.e(2076),n.e(862)]).then(n.bind(n,85149)),"@site/docs/API-docs/v1.2/getfolder.api.mdx",85149],c081699b:[()=>Promise.all([n.e(1869),n.e(2076),n.e(5741)]).then(n.bind(n,65629)),"@site/docs/API-docs/v1.2/resendrequestmail.api.mdx",65629],c15d9823:[()=>n.e(8146).then(n.t.bind(n,29328,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-bd9.json",29328],c195e1f1:[()=>Promise.all([n.e(1869),n.e(2076),n.e(6192)]).then(n.bind(n,35342)),"@site/docs/API-docs/v1.1/createdocumentwithtemplateid.api.mdx",35342],c1e4445e:[()=>Promise.all([n.e(2076),n.e(1170)]).then(n.bind(n,71723)),"@site/docs/help/User Menu/Console/custom_filestorage.md",71723],c4f5d8e4:[()=>Promise.all([n.e(1869),n.e(2634)]).then(n.bind(n,2083)),"@site/src/pages/index.js",2083],c4fbe420:[()=>Promise.all([n.e(1869),n.e(2076),n.e(3795)]).then(n.bind(n,74646)),"@site/docs/API-docs/v1.1/drafttemplate.api.mdx",74646],c674cfb4:[()=>Promise.all([n.e(1869),n.e(2076),n.e(3128)]).then(n.bind(n,13340)),"@site/docs/API-docs/v1/save-update-webhook.api.mdx",13340],c6b74119:[()=>n.e(850).then(n.t.bind(n,70954,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-category-cloud-storage-961.json",70954],c7b98810:[()=>Promise.all([n.e(2076),n.e(2089)]).then(n.bind(n,99094)),"@site/docs/help/OpenSign\u2122 Drive/create-document.md",99094],c7e3ab5f:[()=>Promise.all([n.e(1869),n.e(2076),n.e(4833)]).then(n.bind(n,69222)),"@site/docs/API-docs/v1.1/deletecontact.api.mdx",69222],c9fa5aa5:[()=>Promise.all([n.e(2076),n.e(1640)]).then(n.bind(n,8129)),"@site/docs/contribute/CODE_OF_CONDUCT.md",8129],ccc49370:[()=>Promise.all([n.e(1869),n.e(2076),n.e(4129),n.e(4528),n.e(3249)]).then(n.bind(n,73858)),"@theme/BlogPostPage",73858],cd2b86eb:[()=>Promise.all([n.e(2076),n.e(6505)]).then(n.bind(n,34248)),"@site/docs/help/Settings/Teams.md",34248],ce589067:[()=>Promise.all([n.e(2076),n.e(490)]).then(n.bind(n,87005)),"@site/docs/self-host/One-click-Install/DigitalOcean.md",87005],cf03142d:[()=>Promise.all([n.e(2076),n.e(746)]).then(n.bind(n,25166)),"@site/docs/help/Reports/in-progress.md",25166],cfb1e6eb:[()=>Promise.all([n.e(2076),n.e(539)]).then(n.bind(n,69436)),"@site/docs/help/Settings/Webhook.md",69436],d0524430:[()=>Promise.all([n.e(1869),n.e(2076),n.e(6235)]).then(n.bind(n,40707)),"@site/docs/API-docs/v1.1/save-update-webhook.api.mdx",40707],d1393a72:[()=>Promise.all([n.e(2076),n.e(841)]).then(n.bind(n,11856)),"@site/docs/help/New-Document/request-signatures.md",11856],d281bdbe:[()=>Promise.all([n.e(1869),n.e(2076),n.e(4001)]).then(n.bind(n,37684)),"@site/docs/API-docs/v1/deletedocument.api.mdx",37684],d387ddbc:[()=>Promise.all([n.e(1869),n.e(2076),n.e(206)]).then(n.bind(n,4746)),"@site/docs/API-docs/v1.2/getformdata.api.mdx",4746],d480dde9:[()=>Promise.all([n.e(1869),n.e(2076),n.e(3230)]).then(n.bind(n,29737)),"@site/docs/API-docs/v1.1/delete-webhook.api.mdx",29737],d48fee54:[()=>Promise.all([n.e(1869),n.e(2076),n.e(1332)]).then(n.bind(n,96455)),"@site/docs/API-docs/v1.2/selfsign.api.mdx",96455],d5380080:[()=>Promise.all([n.e(1869),n.e(2076),n.e(603)]).then(n.bind(n,62727)),"@site/docs/API-docs/v1.2/save-update-webhook.api.mdx",62727],d77fb6a8:[()=>n.e(448).then(n.t.bind(n,43519,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-api-docs-v-1-1-0dd.json",43519],d8b805fb:[()=>Promise.all([n.e(2076),n.e(1924)]).then(n.bind(n,22232)),"@site/docs/help/Settings/my-signature.md",22232],d91ad230:[()=>Promise.all([n.e(2076),n.e(6295)]).then(n.bind(n,94741)),"@site/docs/contribute/REPORTING_GUIDELINES.md",94741],d9f32620:[()=>Promise.all([n.e(2076),n.e(5557)]).then(n.bind(n,7447)),"@site/blog/2021-08-26-welcome/index.md",7447],da66eb9c:[()=>Promise.all([n.e(1869),n.e(2076),n.e(2703)]).then(n.bind(n,37055)),"@site/docs/API-docs/v1.1/update-document.api.mdx",37055],dc8c216b:[()=>Promise.all([n.e(2076),n.e(9144)]).then(n.bind(n,52731)),"@site/docs/help/User Menu/Console/branding.md",52731],e226bb09:[()=>Promise.all([n.e(2076),n.e(6743)]).then(n.bind(n,73963)),"@site/docs/contribute/intro.md",73963],e273c56f:[()=>Promise.all([n.e(2076),n.e(9328)]).then(n.bind(n,84014)),"@site/blog/2019-05-28-first-blog-post.md",84014],e48228d1:[()=>Promise.all([n.e(1869),n.e(2076),n.e(3333)]).then(n.bind(n,60580)),"@site/docs/API-docs/v1/createcontact.api.mdx",60580],e4f5c862:[()=>Promise.all([n.e(2076),n.e(7910)]).then(n.bind(n,83027)),"@site/docs/help/Reports/completed.md",83027],e5a49157:[()=>Promise.all([n.e(2076),n.e(9024)]).then(n.bind(n,10827)),"@site/docs/help/FAQs/FAQs.md",10827],e5aefb32:[()=>n.e(3276).then(n.t.bind(n,58539,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-tags-facebook-f47.json",58539],e5d81aec:[()=>Promise.all([n.e(1869),n.e(2076),n.e(419)]).then(n.bind(n,11868)),"@site/docs/API-docs/v1/gettemplatelist.api.mdx",11868],e76c28ee:[()=>Promise.all([n.e(2076),n.e(7318)]).then(n.bind(n,7754)),"@site/docs/self-host/docker/upgrade-deployment.md",7754],e785206d:[()=>n.e(3522).then(n.t.bind(n,48988,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-category-console-192.json",48988],e92d0461:[()=>n.e(7068).then(n.t.bind(n,33495,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-category-faqs-f03.json",33495],e9e778b7:[()=>Promise.all([n.e(2076),n.e(3073)]).then(n.bind(n,14680)),"@site/docs/help/Templates/use-template.md",14680],eaa24e23:[()=>Promise.all([n.e(1869),n.e(2076),n.e(636)]).then(n.bind(n,69710)),"@site/docs/API-docs/v1/get-webhook.api.mdx",69710],eb56c656:[()=>Promise.all([n.e(2076),n.e(7757)]).then(n.bind(n,56752)),"@site/docs/help/OpenSign\u2122 Drive/rename-document.md",56752],ec5e470a:[()=>Promise.all([n.e(1869),n.e(2076),n.e(2923)]).then(n.bind(n,56483)),"@site/docs/API-docs/v1.2/contactlist.api.mdx",56483],ed918ad6:[()=>Promise.all([n.e(1869),n.e(2076),n.e(8413)]).then(n.bind(n,85849)),"@site/docs/API-docs/v1.2/getdocumentlist.api.mdx",85849],eedafdee:[()=>Promise.all([n.e(1869),n.e(2076),n.e(6288)]).then(n.bind(n,91725)),"@site/docs/API-docs/v1/draftdocument.api.mdx",91725],ef8b811a:[()=>n.e(8947).then(n.t.bind(n,56600,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-authors-790.json",56600],f214d5ff:[()=>Promise.all([n.e(2076),n.e(6653)]).then(n.bind(n,84899)),"@site/docs/self-host/guides/upgrade-to-v2.1.0.md",84899],f22c5875:[()=>Promise.all([n.e(1869),n.e(2076),n.e(6841)]).then(n.bind(n,45429)),"@site/docs/API-docs/v1/revokedocument.api.mdx",45429],f4f34a3a:[()=>Promise.all([n.e(2076),n.e(3637)]).then(n.bind(n,95512)),"@site/blog/2021-08-01-mdx-blog-post.mdx?truncated=true",95512],f81c1134:[()=>n.e(8130).then(n.t.bind(n,77735,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-archive-f05.json",77735],f82cd581:[()=>n.e(4584).then(n.t.bind(n,44035,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-tags-hello-f96.json",44035],fa501e35:[()=>Promise.all([n.e(2076),n.e(9429)]).then(n.bind(n,92612)),"@site/docs/help/FAQs/Max File Upload Size.md",92612],fdae908b:[()=>Promise.all([n.e(1869),n.e(2076),n.e(5678)]).then(n.bind(n,78377)),"@site/docs/API-docs/v1.2/createcontact.api.mdx",78377],fdd9b680:[()=>Promise.all([n.e(2076),n.e(4360)]).then(n.bind(n,42342)),"@site/docs/help/FAQs/Credit-Deductions.md",42342],fdf3f392:[()=>Promise.all([n.e(1869),n.e(2076),n.e(5740)]).then(n.bind(n,70328)),"@site/docs/API-docs/v1.2/getcontact.api.mdx",70328],ff9450a5:[()=>Promise.all([n.e(1869),n.e(2076),n.e(7377)]).then(n.bind(n,15483)),"@site/docs/API-docs/v1.2/draftdocument.api.mdx",15483],ffa808c5:[()=>Promise.all([n.e(1869),n.e(2076),n.e(8744)]).then(n.bind(n,28248)),"@site/docs/API-docs/v1.2/createtemplate.api.mdx",28248],fff7b69d:[()=>Promise.all([n.e(2076),n.e(8045)]).then(n.bind(n,4906)),"@site/docs/help/User Menu/Console/signing_certificate.md",4906]};var s=n(74848);function l({error:e,retry:t,pastDelay:n}){return e?(0,s.jsxs)("div",{style:{textAlign:"center",color:"#fff",backgroundColor:"#fa383e",borderColor:"#fa383e",borderStyle:"solid",borderRadius:"0.25rem",borderWidth:"1px",boxSizing:"border-box",display:"block",padding:"1rem",flex:"0 0 50%",marginLeft:"25%",marginRight:"25%",marginTop:"5rem",maxWidth:"50%",width:"100%"},children:[(0,s.jsx)("p",{children:String(e)}),(0,s.jsx)("div",{children:(0,s.jsx)("button",{type:"button",onClick:t,children:"Retry"})})]}):n?(0,s.jsx)("div",{style:{display:"flex",justifyContent:"center",alignItems:"center",height:"100vh"},children:(0,s.jsx)("svg",{id:"loader",style:{width:128,height:110,position:"absolute",top:"calc(100vh - 64%)"},viewBox:"0 0 45 45",xmlns:"http://www.w3.org/2000/svg",stroke:"#61dafb",children:(0,s.jsxs)("g",{fill:"none",fillRule:"evenodd",transform:"translate(1 1)",strokeWidth:"2",children:[(0,s.jsxs)("circle",{cx:"22",cy:"22",r:"6",strokeOpacity:"0",children:[(0,s.jsx)("animate",{attributeName:"r",begin:"1.5s",dur:"3s",values:"6;22",calcMode:"linear",repeatCount:"indefinite"}),(0,s.jsx)("animate",{attributeName:"stroke-opacity",begin:"1.5s",dur:"3s",values:"1;0",calcMode:"linear",repeatCount:"indefinite"}),(0,s.jsx)("animate",{attributeName:"stroke-width",begin:"1.5s",dur:"3s",values:"2;0",calcMode:"linear",repeatCount:"indefinite"})]}),(0,s.jsxs)("circle",{cx:"22",cy:"22",r:"6",strokeOpacity:"0",children:[(0,s.jsx)("animate",{attributeName:"r",begin:"3s",dur:"3s",values:"6;22",calcMode:"linear",repeatCount:"indefinite"}),(0,s.jsx)("animate",{attributeName:"stroke-opacity",begin:"3s",dur:"3s",values:"1;0",calcMode:"linear",repeatCount:"indefinite"}),(0,s.jsx)("animate",{attributeName:"stroke-width",begin:"3s",dur:"3s",values:"2;0",calcMode:"linear",repeatCount:"indefinite"})]}),(0,s.jsx)("circle",{cx:"22",cy:"22",r:"8",children:(0,s.jsx)("animate",{attributeName:"r",begin:"0s",dur:"1.5s",values:"6;1;2;3;4;5;6",calcMode:"linear",repeatCount:"indefinite"})})]})})}):null}var c=n(86921),u=n(53102);function d(e,t){if("*"===e)return o()({loading:l,loader:()=>n.e(2237).then(n.bind(n,82237)),modules:["@theme/NotFound"],webpack:()=>[82237],render(e,t){const n=e.default;return(0,s.jsx)(u.W,{value:{plugin:{name:"native",id:"default"}},children:(0,s.jsx)(n,{...t})})}});const r=a[`${e}-${t}`],d={},p=[],f=[],m=(0,c.A)(r);return Object.entries(m).forEach(([e,t])=>{const n=i[t];n&&(d[e]=n[0],p.push(n[1]),f.push(n[2]))}),o().Map({loading:l,loader:d,modules:p,webpack:()=>f,render(t,n){const o=JSON.parse(JSON.stringify(r));Object.entries(t).forEach(([t,n])=>{const r=n.default;if(!r)throw new Error(`The page component at ${e} doesn't have a default export. This makes it impossible to render anything. Consider default-exporting a React component.`);"object"!=typeof r&&"function"!=typeof r||Object.keys(n).filter(e=>"default"!==e).forEach(e=>{r[e]=n[e]});let a=o;const i=t.split(".");i.slice(0,-1).forEach(e=>{a=a[e]}),a[i[i.length-1]]=r});const a=o.__comp;delete o.__comp;const i=o.__context;delete o.__context;const l=o.__props;return delete o.__props,(0,s.jsx)(u.W,{value:i,children:(0,s.jsx)(a,{...o,...l,...n})})}})}const p=[{path:"/blog",component:d("/blog","b2f"),exact:!0},{path:"/blog/archive",component:d("/blog/archive","182"),exact:!0},{path:"/blog/authors",component:d("/blog/authors","0b7"),exact:!0},{path:"/blog/first-blog-post",component:d("/blog/first-blog-post","89a"),exact:!0},{path:"/blog/long-blog-post",component:d("/blog/long-blog-post","9ad"),exact:!0},{path:"/blog/mdx-blog-post",component:d("/blog/mdx-blog-post","e9f"),exact:!0},{path:"/blog/tags",component:d("/blog/tags","287"),exact:!0},{path:"/blog/tags/docusaurus",component:d("/blog/tags/docusaurus","704"),exact:!0},{path:"/blog/tags/facebook",component:d("/blog/tags/facebook","858"),exact:!0},{path:"/blog/tags/hello",component:d("/blog/tags/hello","299"),exact:!0},{path:"/blog/tags/hola",component:d("/blog/tags/hola","00d"),exact:!0},{path:"/blog/welcome",component:d("/blog/welcome","d2b"),exact:!0},{path:"/markdown-page",component:d("/markdown-page","3d7"),exact:!0},{path:"/docs",component:d("/docs","c32"),routes:[{path:"/docs",component:d("/docs","955"),routes:[{path:"/docs",component:d("/docs","379"),routes:[{path:"/docs/API-docs/api-intro",component:d("/docs/API-docs/api-intro","bfa"),exact:!0},{path:"/docs/API-docs/v1",component:d("/docs/API-docs/v1","0fe"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.1",component:d("/docs/API-docs/v1.1","168"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.1/contactlist",component:d("/docs/API-docs/v1.1/contactlist","220"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.1/createcontact",component:d("/docs/API-docs/v1.1/createcontact","720"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.1/createdocument",component:d("/docs/API-docs/v1.1/createdocument","698"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.1/createdocumentwithtemplateid",component:d("/docs/API-docs/v1.1/createdocumentwithtemplateid","ae4"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.1/createfolder",component:d("/docs/API-docs/v1.1/createfolder","f24"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.1/createtemplate",component:d("/docs/API-docs/v1.1/createtemplate","50f"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.1/delete-template",component:d("/docs/API-docs/v1.1/delete-template","a02"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.1/delete-webhook",component:d("/docs/API-docs/v1.1/delete-webhook","aa8"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.1/deletecontact",component:d("/docs/API-docs/v1.1/deletecontact","436"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.1/deletedocument",component:d("/docs/API-docs/v1.1/deletedocument","bf5"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.1/deletefolder",component:d("/docs/API-docs/v1.1/deletefolder","db1"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.1/draftdocument",component:d("/docs/API-docs/v1.1/draftdocument","8c4"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.1/drafttemplate",component:d("/docs/API-docs/v1.1/drafttemplate","7ea"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.1/folderlist",component:d("/docs/API-docs/v1.1/folderlist","edd"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.1/get-template",component:d("/docs/API-docs/v1.1/get-template","a37"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.1/get-user",component:d("/docs/API-docs/v1.1/get-user","a83"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.1/get-webhook",component:d("/docs/API-docs/v1.1/get-webhook","d1d"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.1/getcontact",component:d("/docs/API-docs/v1.1/getcontact","867"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.1/getcredits",component:d("/docs/API-docs/v1.1/getcredits","267"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.1/getdocument",component:d("/docs/API-docs/v1.1/getdocument","b3c"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.1/getdocumentlist",component:d("/docs/API-docs/v1.1/getdocumentlist","1ff"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.1/getfolder",component:d("/docs/API-docs/v1.1/getfolder","0d1"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.1/getformdata",component:d("/docs/API-docs/v1.1/getformdata","872"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.1/getsignerips",component:d("/docs/API-docs/v1.1/getsignerips","467"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.1/getsigninglinks",component:d("/docs/API-docs/v1.1/getsigninglinks","cb4"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.1/gettemplatelist",component:d("/docs/API-docs/v1.1/gettemplatelist","cf2"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.1/intro",component:d("/docs/API-docs/v1.1/intro","10d"),exact:!0},{path:"/docs/API-docs/v1.1/opensign-api-v-1-2",component:d("/docs/API-docs/v1.1/opensign-api-v-1-2","544"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.1/publictemplate",component:d("/docs/API-docs/v1.1/publictemplate","5f6"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.1/resendrequestmail",component:d("/docs/API-docs/v1.1/resendrequestmail","c7f"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.1/revokedocument",component:d("/docs/API-docs/v1.1/revokedocument","c4f"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.1/save-update-webhook",component:d("/docs/API-docs/v1.1/save-update-webhook","8f7"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.1/selfsign",component:d("/docs/API-docs/v1.1/selfsign","9cf"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.1/update-contact",component:d("/docs/API-docs/v1.1/update-contact","9dd"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.1/update-document",component:d("/docs/API-docs/v1.1/update-document","ce5"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.1/update-template",component:d("/docs/API-docs/v1.1/update-template","6a1"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.1/updatefolder",component:d("/docs/API-docs/v1.1/updatefolder","ba9"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.2",component:d("/docs/API-docs/v1.2","77a"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.2/contactlist",component:d("/docs/API-docs/v1.2/contactlist","bba"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.2/createcontact",component:d("/docs/API-docs/v1.2/createcontact","9f2"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.2/createdocument",component:d("/docs/API-docs/v1.2/createdocument","413"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.2/createdocumentwithtemplateid",component:d("/docs/API-docs/v1.2/createdocumentwithtemplateid","5d1"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.2/createfolder",component:d("/docs/API-docs/v1.2/createfolder","0d4"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.2/createtemplate",component:d("/docs/API-docs/v1.2/createtemplate","730"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.2/delete-template",component:d("/docs/API-docs/v1.2/delete-template","6b8"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.2/delete-webhook",component:d("/docs/API-docs/v1.2/delete-webhook","0ab"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.2/deletecontact",component:d("/docs/API-docs/v1.2/deletecontact","700"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.2/deletedocument",component:d("/docs/API-docs/v1.2/deletedocument","add"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.2/deletefolder",component:d("/docs/API-docs/v1.2/deletefolder","3a0"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.2/draftdocument",component:d("/docs/API-docs/v1.2/draftdocument","bf3"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.2/drafttemplate",component:d("/docs/API-docs/v1.2/drafttemplate","0ea"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.2/folderlist",component:d("/docs/API-docs/v1.2/folderlist","d1d"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.2/get-template",component:d("/docs/API-docs/v1.2/get-template","621"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.2/get-user",component:d("/docs/API-docs/v1.2/get-user","823"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.2/get-webhook",component:d("/docs/API-docs/v1.2/get-webhook","8d5"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.2/getcontact",component:d("/docs/API-docs/v1.2/getcontact","f94"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.2/getcredits",component:d("/docs/API-docs/v1.2/getcredits","4ad"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.2/getdocument",component:d("/docs/API-docs/v1.2/getdocument","dc9"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.2/getdocumentlist",component:d("/docs/API-docs/v1.2/getdocumentlist","687"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.2/getfolder",component:d("/docs/API-docs/v1.2/getfolder","398"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.2/getformdata",component:d("/docs/API-docs/v1.2/getformdata","197"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.2/getsignerips",component:d("/docs/API-docs/v1.2/getsignerips","197"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.2/getsigninglinks",component:d("/docs/API-docs/v1.2/getsigninglinks","8af"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.2/gettemplatelist",component:d("/docs/API-docs/v1.2/gettemplatelist","bba"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.2/intro",component:d("/docs/API-docs/v1.2/intro","7ee"),exact:!0},{path:"/docs/API-docs/v1.2/opensign-api-v-1-2",component:d("/docs/API-docs/v1.2/opensign-api-v-1-2","964"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.2/publictemplate",component:d("/docs/API-docs/v1.2/publictemplate","407"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.2/resendrequestmail",component:d("/docs/API-docs/v1.2/resendrequestmail","196"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.2/revokedocument",component:d("/docs/API-docs/v1.2/revokedocument","ddc"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.2/save-update-webhook",component:d("/docs/API-docs/v1.2/save-update-webhook","814"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.2/selfsign",component:d("/docs/API-docs/v1.2/selfsign","0bd"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.2/update-contact",component:d("/docs/API-docs/v1.2/update-contact","a7e"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.2/update-document",component:d("/docs/API-docs/v1.2/update-document","515"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.2/update-template",component:d("/docs/API-docs/v1.2/update-template","d07"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1.2/updatefolder",component:d("/docs/API-docs/v1.2/updatefolder","6db"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1/contactlist",component:d("/docs/API-docs/v1/contactlist","ebd"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1/createcontact",component:d("/docs/API-docs/v1/createcontact","72d"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1/createdocument",component:d("/docs/API-docs/v1/createdocument","661"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1/createdocumentwithtemplateid",component:d("/docs/API-docs/v1/createdocumentwithtemplateid","585"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1/createfolder",component:d("/docs/API-docs/v1/createfolder","47e"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1/createtemplate",component:d("/docs/API-docs/v1/createtemplate","3f7"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1/delete-template",component:d("/docs/API-docs/v1/delete-template","bea"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1/delete-webhook",component:d("/docs/API-docs/v1/delete-webhook","223"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1/deletecontact",component:d("/docs/API-docs/v1/deletecontact","f4a"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1/deletedocument",component:d("/docs/API-docs/v1/deletedocument","259"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1/deletefolder",component:d("/docs/API-docs/v1/deletefolder","318"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1/draftdocument",component:d("/docs/API-docs/v1/draftdocument","a92"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1/drafttemplate",component:d("/docs/API-docs/v1/drafttemplate","2ae"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1/folderlist",component:d("/docs/API-docs/v1/folderlist","8ff"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1/get-template",component:d("/docs/API-docs/v1/get-template","daf"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1/get-user",component:d("/docs/API-docs/v1/get-user","4d1"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1/get-webhook",component:d("/docs/API-docs/v1/get-webhook","49d"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1/getcontact",component:d("/docs/API-docs/v1/getcontact","7ea"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1/getdocument",component:d("/docs/API-docs/v1/getdocument","3a6"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1/getdocumentlist",component:d("/docs/API-docs/v1/getdocumentlist","79d"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1/getfolder",component:d("/docs/API-docs/v1/getfolder","44e"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1/gettemplatelist",component:d("/docs/API-docs/v1/gettemplatelist","543"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1/intro",component:d("/docs/API-docs/v1/intro","680"),exact:!0},{path:"/docs/API-docs/v1/opensign-api-v-1",component:d("/docs/API-docs/v1/opensign-api-v-1","da9"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1/resendrequestmail",component:d("/docs/API-docs/v1/resendrequestmail","ae3"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1/revokedocument",component:d("/docs/API-docs/v1/revokedocument","b6b"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1/save-update-webhook",component:d("/docs/API-docs/v1/save-update-webhook","4a0"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1/selfsign",component:d("/docs/API-docs/v1/selfsign","6d3"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1/update-document",component:d("/docs/API-docs/v1/update-document","735"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1/update-template",component:d("/docs/API-docs/v1/update-template","cec"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/v1/updatefolder",component:d("/docs/API-docs/v1/updatefolder","bb3"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/category/cloud-storage",component:d("/docs/category/cloud-storage","d1e"),exact:!0,sidebar:"selfhostSidebar"},{path:"/docs/category/console",component:d("/docs/category/console","801"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/category/create-new-opensign-document",component:d("/docs/category/create-new-opensign-document","3aa"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/category/docker",component:d("/docs/category/docker","166"),exact:!0,sidebar:"selfhostSidebar"},{path:"/docs/category/documents",component:d("/docs/category/documents","f36"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/category/faqs",component:d("/docs/category/faqs","418"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/category/guides",component:d("/docs/category/guides","e05"),exact:!0,sidebar:"selfhostSidebar"},{path:"/docs/category/manage-docs-using-opensign-drive",component:d("/docs/category/manage-docs-using-opensign-drive","4d2"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/category/settings",component:d("/docs/category/settings","afc"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/category/templates",component:d("/docs/category/templates","fc2"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/category/user-menu",component:d("/docs/category/user-menu","a10"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/contribute/CODE_OF_CONDUCT",component:d("/docs/contribute/CODE_OF_CONDUCT","71c"),exact:!0,sidebar:"contributeSidebar"},{path:"/docs/contribute/COMMUNITY",component:d("/docs/contribute/COMMUNITY","ff3"),exact:!0,sidebar:"contributeSidebar"},{path:"/docs/contribute/INSTALLATION",component:d("/docs/contribute/INSTALLATION","d0c"),exact:!0,sidebar:"contributeSidebar"},{path:"/docs/contribute/intro",component:d("/docs/contribute/intro","631"),exact:!0,sidebar:"contributeSidebar"},{path:"/docs/contribute/REPORTING_GUIDELINES",component:d("/docs/contribute/REPORTING_GUIDELINES","c30"),exact:!0,sidebar:"contributeSidebar"},{path:"/docs/help/FAQs/",component:d("/docs/help/FAQs/","735"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/help/FAQs/Credit-Deductions",component:d("/docs/help/FAQs/Credit-Deductions","bd0"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements",component:d("/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements","ff4"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/help/FAQs/Max File Upload Size",component:d("/docs/help/FAQs/Max File Upload Size","b81"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/help/FAQs/User Deletion",component:d("/docs/help/FAQs/User Deletion","c3e"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/help/intro",component:d("/docs/help/intro","aef"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/help/New-Document/edit-document-before-sending",component:d("/docs/help/New-Document/edit-document-before-sending","59d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/help/New-Document/enforce-email-verification",component:d("/docs/help/New-Document/enforce-email-verification","f03"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/help/New-Document/request-signatures",component:d("/docs/help/New-Document/request-signatures","5a5"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/help/New-Document/sign-yourself",component:d("/docs/help/New-Document/sign-yourself","ba4"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/help/New-Document/widgets",component:d("/docs/help/New-Document/widgets","a5a"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/help/OpenSign\u2122 Drive/create-document",component:d("/docs/help/OpenSign\u2122 Drive/create-document","2dc"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/help/OpenSign\u2122 Drive/list-grid-view",component:d("/docs/help/OpenSign\u2122 Drive/list-grid-view","092"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/help/OpenSign\u2122 Drive/organize-documents",component:d("/docs/help/OpenSign\u2122 Drive/organize-documents","79d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/help/OpenSign\u2122 Drive/rename-document",component:d("/docs/help/OpenSign\u2122 Drive/rename-document","045"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/help/Reports/completed",component:d("/docs/help/Reports/completed","dc1"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/help/Reports/contactbook",component:d("/docs/help/Reports/contactbook","6bd"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/help/Reports/declined",component:d("/docs/help/Reports/declined","b29"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/help/Reports/drafts",component:d("/docs/help/Reports/drafts","24c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/help/Reports/expired",component:d("/docs/help/Reports/expired","71b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/help/Reports/in-progress",component:d("/docs/help/Reports/in-progress","2cf"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/help/Reports/need-your-sign",component:d("/docs/help/Reports/need-your-sign","38d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/help/Settings/APIToken",component:d("/docs/help/Settings/APIToken","9fd"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/help/Settings/Custom-email-templates",component:d("/docs/help/Settings/Custom-email-templates","03d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/help/Settings/disabledocumentid",component:d("/docs/help/Settings/disabledocumentid","716"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/help/Settings/manage-users",component:d("/docs/help/Settings/manage-users","e9e"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/help/Settings/my-signature",component:d("/docs/help/Settings/my-signature","498"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/help/Settings/Preferences",component:d("/docs/help/Settings/Preferences","a9e"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/help/Settings/SecurityManagement",component:d("/docs/help/Settings/SecurityManagement","026"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/help/Settings/Teams",component:d("/docs/help/Settings/Teams","102"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/help/Settings/Webhook",component:d("/docs/help/Settings/Webhook","b5a"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/help/Templates/create-template",component:d("/docs/help/Templates/create-template","4b4"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/help/Templates/embed-template",component:d("/docs/help/Templates/embed-template","fe9"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/help/Templates/manage-templates",component:d("/docs/help/Templates/manage-templates","466"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/help/Templates/publicTemplate",component:d("/docs/help/Templates/publicTemplate","57d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/help/Templates/quick-send",component:d("/docs/help/Templates/quick-send","e44"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/help/Templates/use-template",component:d("/docs/help/Templates/use-template","684"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/help/User Menu/Console/analystics",component:d("/docs/help/User Menu/Console/analystics","a1e"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/help/User Menu/Console/branding",component:d("/docs/help/User Menu/Console/branding","ad3"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/help/User Menu/Console/custom_filestorage",component:d("/docs/help/User Menu/Console/custom_filestorage","ca6"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/help/User Menu/Console/emails",component:d("/docs/help/User Menu/Console/emails","c0d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/help/User Menu/Console/general",component:d("/docs/help/User Menu/Console/general","f25"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/help/User Menu/Console/globalSMTP",component:d("/docs/help/User Menu/Console/globalSMTP","da3"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/help/User Menu/Console/orgadmin",component:d("/docs/help/User Menu/Console/orgadmin","155"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/help/User Menu/Console/organizations",component:d("/docs/help/User Menu/Console/organizations","356"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/help/User Menu/Console/signing_certificate",component:d("/docs/help/User Menu/Console/signing_certificate","759"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/help/User Menu/Profile",component:d("/docs/help/User Menu/Profile","b13"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/intro",component:d("/docs/intro","ee1"),exact:!0},{path:"/docs/self-host/cloud-storage/s3",component:d("/docs/self-host/cloud-storage/s3","a97"),exact:!0,sidebar:"selfhostSidebar"},{path:"/docs/self-host/docker/run-locally",component:d("/docs/self-host/docker/run-locally","d9c"),exact:!0,sidebar:"selfhostSidebar"},{path:"/docs/self-host/docker/upgrade-deployment",component:d("/docs/self-host/docker/upgrade-deployment","c37"),exact:!0,sidebar:"selfhostSidebar"},{path:"/docs/self-host/guides/azure-vm-setup",component:d("/docs/self-host/guides/azure-vm-setup","580"),exact:!0,sidebar:"selfhostSidebar"},{path:"/docs/self-host/guides/env-variables",component:d("/docs/self-host/guides/env-variables","662"),exact:!0,sidebar:"selfhostSidebar"},{path:"/docs/self-host/guides/how-to-generate-self-signed-document-signing-certificate",component:d("/docs/self-host/guides/how-to-generate-self-signed-document-signing-certificate","e9e"),exact:!0,sidebar:"selfhostSidebar"},{path:"/docs/self-host/guides/upgrade-to-v2.1.0",component:d("/docs/self-host/guides/upgrade-to-v2.1.0","8ed"),exact:!0,sidebar:"selfhostSidebar"},{path:"/docs/self-host/intro",component:d("/docs/self-host/intro","524"),exact:!0,sidebar:"selfhostSidebar"},{path:"/docs/self-host/One-click-Install/DigitalOcean",component:d("/docs/self-host/One-click-Install/DigitalOcean","c97"),exact:!0,sidebar:"selfhostSidebar"}]}]}]},{path:"/",component:d("/","2e1"),exact:!0},{path:"*",component:d("*")}]},6125(e,t,n){"use strict";n.d(t,{o:()=>a,x:()=>i});var r=n(96540),o=n(74848);const a=r.createContext(!1);function i({children:e}){const[t,n]=(0,r.useState)(!1);return(0,r.useEffect)(()=>{n(!0)},[]),(0,o.jsx)(a.Provider,{value:t,children:e})}},22067(e,t,n){"use strict";var r=n(96540),o=n(5338),a=n(80545),i=n(54625),s=n(4784),l=n(38193);const c=[n(10119),n(26134),n(76294),n(51043),n(3035)];var u=n(35947),d=n(56347),p=n(22831),f=n(74848);function m({children:e}){return(0,f.jsx)(f.Fragment,{children:e})}var h=n(14563);const g=e=>e.defaultFormatter(e);function b({children:e}){return(0,f.jsx)(h.AL,{formatter:g,children:e})}function v({children:e}){return(0,f.jsx)(b,{children:e})}var y=n(5260),w=n(44586),k=n(86025),x=n(6342),S=n(45500),P=n(32131),A=n(14090),_=n(2967),I=n(70440),E=n(41463);function C(){const{i18n:{currentLocale:e,defaultLocale:t,localeConfigs:n}}=(0,w.default)(),r=(0,P.o)(),o=n[e].htmlLang,a=e=>e.replace("-","_");return(0,f.jsxs)(y.A,{children:[Object.entries(n).map(([e,{htmlLang:t}])=>(0,f.jsx)("link",{rel:"alternate",href:r.createUrl({locale:e,fullyQualified:!0}),hrefLang:t},e)),(0,f.jsx)("link",{rel:"alternate",href:r.createUrl({locale:t,fullyQualified:!0}),hrefLang:"x-default"}),(0,f.jsx)("meta",{property:"og:locale",content:a(o)}),Object.values(n).filter(e=>o!==e.htmlLang).map(e=>(0,f.jsx)("meta",{property:"og:locale:alternate",content:a(e.htmlLang)},`meta-og-${e.htmlLang}`))]})}function T({permalink:e}){const{siteConfig:{url:t}}=(0,w.default)(),n=function(){const{siteConfig:{url:e,baseUrl:t,trailingSlash:n}}=(0,w.default)(),{pathname:r}=(0,d.zy)();return e+(0,I.Ks)((0,k.default)(r),{trailingSlash:n,baseUrl:t})}(),r=e?`${t}${e}`:n;return(0,f.jsxs)(y.A,{children:[(0,f.jsx)("meta",{property:"og:url",content:r}),(0,f.jsx)("link",{rel:"canonical",href:r})]})}function j(){const{i18n:{currentLocale:e}}=(0,w.default)(),{metadata:t,image:n}=(0,x.p)();return(0,f.jsxs)(f.Fragment,{children:[(0,f.jsxs)(y.A,{children:[(0,f.jsx)("meta",{name:"twitter:card",content:"summary_large_image"}),(0,f.jsx)("body",{className:A.w})]}),n&&(0,f.jsx)(S.be,{image:n}),(0,f.jsx)(T,{}),(0,f.jsx)(C,{}),(0,f.jsx)(E.A,{tag:_.C,locale:e}),(0,f.jsx)(y.A,{children:t.map((e,t)=>(0,f.jsx)("meta",{...e},t))})]})}const N=new Map;var O=n(6125),R=n(26988),D=n(205);function L(e,...t){const n=c.map(n=>{const r=n.default?.[e]??n[e];return r?.(...t)});return()=>n.forEach(e=>e?.())}const M=function({children:e,location:t,previousLocation:n}){return(0,D.A)(()=>{n!==t&&(!function({location:e,previousLocation:t}){if(!t)return;const n=e.pathname===t.pathname,r=e.hash===t.hash,o=e.search===t.search;if(n&&r&&!o)return;const{hash:a}=e;if(a){const e=decodeURIComponent(a.substring(1)),t=document.getElementById(e);t?.scrollIntoView()}else window.scrollTo(0,0)}({location:t,previousLocation:n}),L("onRouteDidUpdate",{previousLocation:n,location:t}))},[n,t]),e};function F(e){const t=Array.from(new Set([e,decodeURI(e)])).map(e=>(0,p.u)(u.A,e)).flat();return Promise.all(t.map(e=>e.route.component.preload?.()))}class z extends r.Component{previousLocation;routeUpdateCleanupCb;constructor(e){super(e),this.previousLocation=null,this.routeUpdateCleanupCb=l.default.canUseDOM?L("onRouteUpdate",{previousLocation:null,location:this.props.location}):()=>{},this.state={nextRouteHasLoaded:!0}}shouldComponentUpdate(e,t){if(e.location===this.props.location)return t.nextRouteHasLoaded;const n=e.location;return this.previousLocation=this.props.location,this.setState({nextRouteHasLoaded:!1}),this.routeUpdateCleanupCb=L("onRouteUpdate",{previousLocation:this.previousLocation,location:n}),F(n.pathname).then(()=>{this.routeUpdateCleanupCb(),this.setState({nextRouteHasLoaded:!0})}).catch(e=>{console.warn(e),window.location.reload()}),!1}render(){const{children:e,location:t}=this.props;return(0,f.jsx)(M,{previousLocation:this.previousLocation,location:t,children:(0,f.jsx)(d.qh,{location:t,render:()=>e})})}}const U=z,B="__docusaurus-base-url-issue-banner-suggestion-container";function $(e){return`\ndocument.addEventListener('DOMContentLoaded', function maybeInsertBanner() {\n var shouldInsert = typeof window['docusaurus'] === 'undefined';\n shouldInsert && insertBanner();\n});\n\nfunction insertBanner() {\n var bannerContainer = document.createElement('div');\n bannerContainer.id = '__docusaurus-base-url-issue-banner-container';\n var bannerHtml = ${JSON.stringify(function(e){return`\n
\n

Your Docusaurus site did not load properly.

\n

A very common reason is a wrong site baseUrl configuration.

\n

Current configured baseUrl = ${e} ${"/"===e?" (default value)":""}

\n

We suggest trying baseUrl =

\n
\n`}(e)).replace(/!0===e.exact))return N.set(e.pathname,e.pathname),e;const t=e.pathname.trim().replace(/(?:\/index)?\.html$/,"")||"/";return N.set(e.pathname,t),{...e,pathname:t}}((0,d.zy)());return(0,f.jsx)(U,{location:e,children:K})}function Z(){return(0,f.jsx)(H.A,{children:(0,f.jsx)(R.l,{children:(0,f.jsxs)(O.x,{children:[(0,f.jsx)(m,{children:(0,f.jsxs)(v,{children:[(0,f.jsx)(V,{}),(0,f.jsx)(j,{}),(0,f.jsx)(G,{}),(0,f.jsx)(Y,{})]})}),(0,f.jsx)(Q,{})]})})})}var X=n(84054);const J=function(e){try{return document.createElement("link").relList.supports(e)}catch{return!1}}("prefetch")?function(e){return new Promise((t,n)=>{if("undefined"==typeof document)return void n();const r=document.createElement("link");r.setAttribute("rel","prefetch"),r.setAttribute("href",e),r.onload=()=>t(),r.onerror=()=>n();const o=document.getElementsByTagName("head")[0]??document.getElementsByName("script")[0]?.parentNode;o?.appendChild(r)})}:function(e){return new Promise((t,n)=>{const r=new XMLHttpRequest;r.open("GET",e,!0),r.withCredentials=!0,r.onload=()=>{200===r.status?t():n()},r.send(null)})};var ee=n(86921);const te=new Set,ne=new Set,re=()=>navigator.connection?.effectiveType.includes("2g")||navigator.connection?.saveData,oe={prefetch:e=>{if(!(e=>!re()&&!ne.has(e)&&!te.has(e))(e))return!1;te.add(e);const t=(0,p.u)(u.A,e).flatMap(e=>{return t=e.route.path,Object.entries(X).filter(([e])=>e.replace(/-[^-]+$/,"")===t).flatMap(([,e])=>Object.values((0,ee.A)(e)));var t});return Promise.all(t.map(e=>{const t=n.gca(e);return t&&!t.includes("undefined")?J(t).catch(()=>{}):Promise.resolve()}))},preload:e=>!!(e=>!re()&&!ne.has(e))(e)&&(ne.add(e),F(e))},ae=Object.freeze(oe);function ie({children:e}){return"hash"===s.default.future.experimental_router?(0,f.jsx)(i.I9,{children:e}):(0,f.jsx)(i.Kd,{children:e})}const se=Boolean(!0);if(l.default.canUseDOM){window.docusaurus=ae;const e=document.getElementById("__docusaurus"),t=(0,f.jsx)(a.vd,{children:(0,f.jsx)(ie,{children:(0,f.jsx)(Z,{})})}),n=(e,t)=>{console.error("Docusaurus React Root onRecoverableError:",e,t)},i=()=>{if(window.docusaurusRoot)window.docusaurusRoot.render(t);else if(se)window.docusaurusRoot=o.hydrateRoot(e,t,{onRecoverableError:n});else{const r=o.createRoot(e,{onRecoverableError:n});r.render(t),window.docusaurusRoot=r}};F(window.location.pathname).then(()=>{(0,r.startTransition)(i)})}},26988(e,t,n){"use strict";n.d(t,{o:()=>d,l:()=>p});var r=n(96540),o=n(4784);const a=JSON.parse('{"docusaurus-plugin-content-docs":{"default":{"path":"/docs","versions":[{"name":"current","label":"Next","isLast":true,"path":"/docs","mainDocId":"help/intro","docs":[{"id":"API-docs/api-intro","path":"/docs/API-docs/api-intro"},{"id":"API-docs/v1.1/contactlist","path":"/docs/API-docs/v1.1/contactlist","sidebar":"apiSidebar"},{"id":"API-docs/v1.1/createcontact","path":"/docs/API-docs/v1.1/createcontact","sidebar":"apiSidebar"},{"id":"API-docs/v1.1/createdocument","path":"/docs/API-docs/v1.1/createdocument","sidebar":"apiSidebar"},{"id":"API-docs/v1.1/createdocumentwithtemplateid","path":"/docs/API-docs/v1.1/createdocumentwithtemplateid","sidebar":"apiSidebar"},{"id":"API-docs/v1.1/createfolder","path":"/docs/API-docs/v1.1/createfolder","sidebar":"apiSidebar"},{"id":"API-docs/v1.1/createtemplate","path":"/docs/API-docs/v1.1/createtemplate","sidebar":"apiSidebar"},{"id":"API-docs/v1.1/delete-template","path":"/docs/API-docs/v1.1/delete-template","sidebar":"apiSidebar"},{"id":"API-docs/v1.1/delete-webhook","path":"/docs/API-docs/v1.1/delete-webhook","sidebar":"apiSidebar"},{"id":"API-docs/v1.1/deletecontact","path":"/docs/API-docs/v1.1/deletecontact","sidebar":"apiSidebar"},{"id":"API-docs/v1.1/deletedocument","path":"/docs/API-docs/v1.1/deletedocument","sidebar":"apiSidebar"},{"id":"API-docs/v1.1/deletefolder","path":"/docs/API-docs/v1.1/deletefolder","sidebar":"apiSidebar"},{"id":"API-docs/v1.1/draftdocument","path":"/docs/API-docs/v1.1/draftdocument","sidebar":"apiSidebar"},{"id":"API-docs/v1.1/drafttemplate","path":"/docs/API-docs/v1.1/drafttemplate","sidebar":"apiSidebar"},{"id":"API-docs/v1.1/folderlist","path":"/docs/API-docs/v1.1/folderlist","sidebar":"apiSidebar"},{"id":"API-docs/v1.1/get-template","path":"/docs/API-docs/v1.1/get-template","sidebar":"apiSidebar"},{"id":"API-docs/v1.1/get-user","path":"/docs/API-docs/v1.1/get-user","sidebar":"apiSidebar"},{"id":"API-docs/v1.1/get-webhook","path":"/docs/API-docs/v1.1/get-webhook","sidebar":"apiSidebar"},{"id":"API-docs/v1.1/getcontact","path":"/docs/API-docs/v1.1/getcontact","sidebar":"apiSidebar"},{"id":"API-docs/v1.1/getcredits","path":"/docs/API-docs/v1.1/getcredits","sidebar":"apiSidebar"},{"id":"API-docs/v1.1/getdocument","path":"/docs/API-docs/v1.1/getdocument","sidebar":"apiSidebar"},{"id":"API-docs/v1.1/getdocumentlist","path":"/docs/API-docs/v1.1/getdocumentlist","sidebar":"apiSidebar"},{"id":"API-docs/v1.1/getfolder","path":"/docs/API-docs/v1.1/getfolder","sidebar":"apiSidebar"},{"id":"API-docs/v1.1/getformdata","path":"/docs/API-docs/v1.1/getformdata","sidebar":"apiSidebar"},{"id":"API-docs/v1.1/getsignerips","path":"/docs/API-docs/v1.1/getsignerips","sidebar":"apiSidebar"},{"id":"API-docs/v1.1/getsigninglinks","path":"/docs/API-docs/v1.1/getsigninglinks","sidebar":"apiSidebar"},{"id":"API-docs/v1.1/gettemplatelist","path":"/docs/API-docs/v1.1/gettemplatelist","sidebar":"apiSidebar"},{"id":"API-docs/v1.1/intro","path":"/docs/API-docs/v1.1/intro"},{"id":"API-docs/v1.1/opensign-api-v-1-2","path":"/docs/API-docs/v1.1/opensign-api-v-1-2","sidebar":"apiSidebar"},{"id":"API-docs/v1.1/publictemplate","path":"/docs/API-docs/v1.1/publictemplate","sidebar":"apiSidebar"},{"id":"API-docs/v1.1/resendrequestmail","path":"/docs/API-docs/v1.1/resendrequestmail","sidebar":"apiSidebar"},{"id":"API-docs/v1.1/revokedocument","path":"/docs/API-docs/v1.1/revokedocument","sidebar":"apiSidebar"},{"id":"API-docs/v1.1/save-update-webhook","path":"/docs/API-docs/v1.1/save-update-webhook","sidebar":"apiSidebar"},{"id":"API-docs/v1.1/selfsign","path":"/docs/API-docs/v1.1/selfsign","sidebar":"apiSidebar"},{"id":"API-docs/v1.1/update-contact","path":"/docs/API-docs/v1.1/update-contact","sidebar":"apiSidebar"},{"id":"API-docs/v1.1/update-document","path":"/docs/API-docs/v1.1/update-document","sidebar":"apiSidebar"},{"id":"API-docs/v1.1/update-template","path":"/docs/API-docs/v1.1/update-template","sidebar":"apiSidebar"},{"id":"API-docs/v1.1/updatefolder","path":"/docs/API-docs/v1.1/updatefolder","sidebar":"apiSidebar"},{"id":"API-docs/v1.2/contactlist","path":"/docs/API-docs/v1.2/contactlist","sidebar":"apiSidebar"},{"id":"API-docs/v1.2/createcontact","path":"/docs/API-docs/v1.2/createcontact","sidebar":"apiSidebar"},{"id":"API-docs/v1.2/createdocument","path":"/docs/API-docs/v1.2/createdocument","sidebar":"apiSidebar"},{"id":"API-docs/v1.2/createdocumentwithtemplateid","path":"/docs/API-docs/v1.2/createdocumentwithtemplateid","sidebar":"apiSidebar"},{"id":"API-docs/v1.2/createfolder","path":"/docs/API-docs/v1.2/createfolder","sidebar":"apiSidebar"},{"id":"API-docs/v1.2/createtemplate","path":"/docs/API-docs/v1.2/createtemplate","sidebar":"apiSidebar"},{"id":"API-docs/v1.2/delete-template","path":"/docs/API-docs/v1.2/delete-template","sidebar":"apiSidebar"},{"id":"API-docs/v1.2/delete-webhook","path":"/docs/API-docs/v1.2/delete-webhook","sidebar":"apiSidebar"},{"id":"API-docs/v1.2/deletecontact","path":"/docs/API-docs/v1.2/deletecontact","sidebar":"apiSidebar"},{"id":"API-docs/v1.2/deletedocument","path":"/docs/API-docs/v1.2/deletedocument","sidebar":"apiSidebar"},{"id":"API-docs/v1.2/deletefolder","path":"/docs/API-docs/v1.2/deletefolder","sidebar":"apiSidebar"},{"id":"API-docs/v1.2/draftdocument","path":"/docs/API-docs/v1.2/draftdocument","sidebar":"apiSidebar"},{"id":"API-docs/v1.2/drafttemplate","path":"/docs/API-docs/v1.2/drafttemplate","sidebar":"apiSidebar"},{"id":"API-docs/v1.2/folderlist","path":"/docs/API-docs/v1.2/folderlist","sidebar":"apiSidebar"},{"id":"API-docs/v1.2/get-template","path":"/docs/API-docs/v1.2/get-template","sidebar":"apiSidebar"},{"id":"API-docs/v1.2/get-user","path":"/docs/API-docs/v1.2/get-user","sidebar":"apiSidebar"},{"id":"API-docs/v1.2/get-webhook","path":"/docs/API-docs/v1.2/get-webhook","sidebar":"apiSidebar"},{"id":"API-docs/v1.2/getcontact","path":"/docs/API-docs/v1.2/getcontact","sidebar":"apiSidebar"},{"id":"API-docs/v1.2/getcredits","path":"/docs/API-docs/v1.2/getcredits","sidebar":"apiSidebar"},{"id":"API-docs/v1.2/getdocument","path":"/docs/API-docs/v1.2/getdocument","sidebar":"apiSidebar"},{"id":"API-docs/v1.2/getdocumentlist","path":"/docs/API-docs/v1.2/getdocumentlist","sidebar":"apiSidebar"},{"id":"API-docs/v1.2/getfolder","path":"/docs/API-docs/v1.2/getfolder","sidebar":"apiSidebar"},{"id":"API-docs/v1.2/getformdata","path":"/docs/API-docs/v1.2/getformdata","sidebar":"apiSidebar"},{"id":"API-docs/v1.2/getsignerips","path":"/docs/API-docs/v1.2/getsignerips","sidebar":"apiSidebar"},{"id":"API-docs/v1.2/getsigninglinks","path":"/docs/API-docs/v1.2/getsigninglinks","sidebar":"apiSidebar"},{"id":"API-docs/v1.2/gettemplatelist","path":"/docs/API-docs/v1.2/gettemplatelist","sidebar":"apiSidebar"},{"id":"API-docs/v1.2/intro","path":"/docs/API-docs/v1.2/intro"},{"id":"API-docs/v1.2/opensign-api-v-1-2","path":"/docs/API-docs/v1.2/opensign-api-v-1-2","sidebar":"apiSidebar"},{"id":"API-docs/v1.2/publictemplate","path":"/docs/API-docs/v1.2/publictemplate","sidebar":"apiSidebar"},{"id":"API-docs/v1.2/resendrequestmail","path":"/docs/API-docs/v1.2/resendrequestmail","sidebar":"apiSidebar"},{"id":"API-docs/v1.2/revokedocument","path":"/docs/API-docs/v1.2/revokedocument","sidebar":"apiSidebar"},{"id":"API-docs/v1.2/save-update-webhook","path":"/docs/API-docs/v1.2/save-update-webhook","sidebar":"apiSidebar"},{"id":"API-docs/v1.2/selfsign","path":"/docs/API-docs/v1.2/selfsign","sidebar":"apiSidebar"},{"id":"API-docs/v1.2/update-contact","path":"/docs/API-docs/v1.2/update-contact","sidebar":"apiSidebar"},{"id":"API-docs/v1.2/update-document","path":"/docs/API-docs/v1.2/update-document","sidebar":"apiSidebar"},{"id":"API-docs/v1.2/update-template","path":"/docs/API-docs/v1.2/update-template","sidebar":"apiSidebar"},{"id":"API-docs/v1.2/updatefolder","path":"/docs/API-docs/v1.2/updatefolder","sidebar":"apiSidebar"},{"id":"API-docs/v1/contactlist","path":"/docs/API-docs/v1/contactlist","sidebar":"apiSidebar"},{"id":"API-docs/v1/createcontact","path":"/docs/API-docs/v1/createcontact","sidebar":"apiSidebar"},{"id":"API-docs/v1/createdocument","path":"/docs/API-docs/v1/createdocument","sidebar":"apiSidebar"},{"id":"API-docs/v1/createdocumentwithtemplateid","path":"/docs/API-docs/v1/createdocumentwithtemplateid","sidebar":"apiSidebar"},{"id":"API-docs/v1/createfolder","path":"/docs/API-docs/v1/createfolder","sidebar":"apiSidebar"},{"id":"API-docs/v1/createtemplate","path":"/docs/API-docs/v1/createtemplate","sidebar":"apiSidebar"},{"id":"API-docs/v1/delete-template","path":"/docs/API-docs/v1/delete-template","sidebar":"apiSidebar"},{"id":"API-docs/v1/delete-webhook","path":"/docs/API-docs/v1/delete-webhook","sidebar":"apiSidebar"},{"id":"API-docs/v1/deletecontact","path":"/docs/API-docs/v1/deletecontact","sidebar":"apiSidebar"},{"id":"API-docs/v1/deletedocument","path":"/docs/API-docs/v1/deletedocument","sidebar":"apiSidebar"},{"id":"API-docs/v1/deletefolder","path":"/docs/API-docs/v1/deletefolder","sidebar":"apiSidebar"},{"id":"API-docs/v1/draftdocument","path":"/docs/API-docs/v1/draftdocument","sidebar":"apiSidebar"},{"id":"API-docs/v1/drafttemplate","path":"/docs/API-docs/v1/drafttemplate","sidebar":"apiSidebar"},{"id":"API-docs/v1/folderlist","path":"/docs/API-docs/v1/folderlist","sidebar":"apiSidebar"},{"id":"API-docs/v1/get-template","path":"/docs/API-docs/v1/get-template","sidebar":"apiSidebar"},{"id":"API-docs/v1/get-user","path":"/docs/API-docs/v1/get-user","sidebar":"apiSidebar"},{"id":"API-docs/v1/get-webhook","path":"/docs/API-docs/v1/get-webhook","sidebar":"apiSidebar"},{"id":"API-docs/v1/getcontact","path":"/docs/API-docs/v1/getcontact","sidebar":"apiSidebar"},{"id":"API-docs/v1/getdocument","path":"/docs/API-docs/v1/getdocument","sidebar":"apiSidebar"},{"id":"API-docs/v1/getdocumentlist","path":"/docs/API-docs/v1/getdocumentlist","sidebar":"apiSidebar"},{"id":"API-docs/v1/getfolder","path":"/docs/API-docs/v1/getfolder","sidebar":"apiSidebar"},{"id":"API-docs/v1/gettemplatelist","path":"/docs/API-docs/v1/gettemplatelist","sidebar":"apiSidebar"},{"id":"API-docs/v1/intro","path":"/docs/API-docs/v1/intro"},{"id":"API-docs/v1/opensign-api-v-1","path":"/docs/API-docs/v1/opensign-api-v-1","sidebar":"apiSidebar"},{"id":"API-docs/v1/resendrequestmail","path":"/docs/API-docs/v1/resendrequestmail","sidebar":"apiSidebar"},{"id":"API-docs/v1/revokedocument","path":"/docs/API-docs/v1/revokedocument","sidebar":"apiSidebar"},{"id":"API-docs/v1/save-update-webhook","path":"/docs/API-docs/v1/save-update-webhook","sidebar":"apiSidebar"},{"id":"API-docs/v1/selfsign","path":"/docs/API-docs/v1/selfsign","sidebar":"apiSidebar"},{"id":"API-docs/v1/update-document","path":"/docs/API-docs/v1/update-document","sidebar":"apiSidebar"},{"id":"API-docs/v1/update-template","path":"/docs/API-docs/v1/update-template","sidebar":"apiSidebar"},{"id":"API-docs/v1/updatefolder","path":"/docs/API-docs/v1/updatefolder","sidebar":"apiSidebar"},{"id":"contribute/CODE_OF_CONDUCT","path":"/docs/contribute/CODE_OF_CONDUCT","sidebar":"contributeSidebar"},{"id":"contribute/COMMUNITY","path":"/docs/contribute/COMMUNITY","sidebar":"contributeSidebar"},{"id":"contribute/INSTALLATION","path":"/docs/contribute/INSTALLATION","sidebar":"contributeSidebar"},{"id":"contribute/intro","path":"/docs/contribute/intro","sidebar":"contributeSidebar"},{"id":"contribute/REPORTING_GUIDELINES","path":"/docs/contribute/REPORTING_GUIDELINES","sidebar":"contributeSidebar"},{"id":"help/FAQs/Credit-Deductions","path":"/docs/help/FAQs/Credit-Deductions","sidebar":"tutorialSidebar"},{"id":"help/FAQs/Ensure this field is accurately filled and meets all requirements","path":"/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements","sidebar":"tutorialSidebar"},{"id":"help/FAQs/FAQs","path":"/docs/help/FAQs/","sidebar":"tutorialSidebar"},{"id":"help/FAQs/Max File Upload Size","path":"/docs/help/FAQs/Max File Upload Size","sidebar":"tutorialSidebar"},{"id":"help/FAQs/User Deletion","path":"/docs/help/FAQs/User Deletion","sidebar":"tutorialSidebar"},{"id":"help/intro","path":"/docs/help/intro","sidebar":"tutorialSidebar"},{"id":"help/New-Document/edit-document-before-sending","path":"/docs/help/New-Document/edit-document-before-sending","sidebar":"tutorialSidebar"},{"id":"help/New-Document/enforce-email-verification","path":"/docs/help/New-Document/enforce-email-verification","sidebar":"tutorialSidebar"},{"id":"help/New-Document/request-signatures","path":"/docs/help/New-Document/request-signatures","sidebar":"tutorialSidebar"},{"id":"help/New-Document/sign-yourself","path":"/docs/help/New-Document/sign-yourself","sidebar":"tutorialSidebar"},{"id":"help/New-Document/widgets","path":"/docs/help/New-Document/widgets","sidebar":"tutorialSidebar"},{"id":"help/OpenSign\u2122 Drive/create-document","path":"/docs/help/OpenSign\u2122 Drive/create-document","sidebar":"tutorialSidebar"},{"id":"help/OpenSign\u2122 Drive/list-grid-view","path":"/docs/help/OpenSign\u2122 Drive/list-grid-view","sidebar":"tutorialSidebar"},{"id":"help/OpenSign\u2122 Drive/organize-documents","path":"/docs/help/OpenSign\u2122 Drive/organize-documents","sidebar":"tutorialSidebar"},{"id":"help/OpenSign\u2122 Drive/rename-document","path":"/docs/help/OpenSign\u2122 Drive/rename-document","sidebar":"tutorialSidebar"},{"id":"help/Reports/completed","path":"/docs/help/Reports/completed","sidebar":"tutorialSidebar"},{"id":"help/Reports/contactbook","path":"/docs/help/Reports/contactbook","sidebar":"tutorialSidebar"},{"id":"help/Reports/declined","path":"/docs/help/Reports/declined","sidebar":"tutorialSidebar"},{"id":"help/Reports/drafts","path":"/docs/help/Reports/drafts","sidebar":"tutorialSidebar"},{"id":"help/Reports/expired","path":"/docs/help/Reports/expired","sidebar":"tutorialSidebar"},{"id":"help/Reports/in-progress","path":"/docs/help/Reports/in-progress","sidebar":"tutorialSidebar"},{"id":"help/Reports/need-your-sign","path":"/docs/help/Reports/need-your-sign","sidebar":"tutorialSidebar"},{"id":"help/Settings/APIToken","path":"/docs/help/Settings/APIToken","sidebar":"tutorialSidebar"},{"id":"help/Settings/Custom-email-templates","path":"/docs/help/Settings/Custom-email-templates","sidebar":"tutorialSidebar"},{"id":"help/Settings/disabledocumentid","path":"/docs/help/Settings/disabledocumentid","sidebar":"tutorialSidebar"},{"id":"help/Settings/manage-users","path":"/docs/help/Settings/manage-users","sidebar":"tutorialSidebar"},{"id":"help/Settings/my-signature","path":"/docs/help/Settings/my-signature","sidebar":"tutorialSidebar"},{"id":"help/Settings/Preferences","path":"/docs/help/Settings/Preferences","sidebar":"tutorialSidebar"},{"id":"help/Settings/SecurityManagement","path":"/docs/help/Settings/SecurityManagement","sidebar":"tutorialSidebar"},{"id":"help/Settings/Teams","path":"/docs/help/Settings/Teams","sidebar":"tutorialSidebar"},{"id":"help/Settings/Webhook","path":"/docs/help/Settings/Webhook","sidebar":"tutorialSidebar"},{"id":"help/Templates/create-template","path":"/docs/help/Templates/create-template","sidebar":"tutorialSidebar"},{"id":"help/Templates/embed-template","path":"/docs/help/Templates/embed-template","sidebar":"tutorialSidebar"},{"id":"help/Templates/manage-templates","path":"/docs/help/Templates/manage-templates","sidebar":"tutorialSidebar"},{"id":"help/Templates/publicTemplate","path":"/docs/help/Templates/publicTemplate","sidebar":"tutorialSidebar"},{"id":"help/Templates/quick-send","path":"/docs/help/Templates/quick-send","sidebar":"tutorialSidebar"},{"id":"help/Templates/use-template","path":"/docs/help/Templates/use-template","sidebar":"tutorialSidebar"},{"id":"help/User Menu/Console/analystics","path":"/docs/help/User Menu/Console/analystics","sidebar":"tutorialSidebar"},{"id":"help/User Menu/Console/branding","path":"/docs/help/User Menu/Console/branding","sidebar":"tutorialSidebar"},{"id":"help/User Menu/Console/custom_filestorage","path":"/docs/help/User Menu/Console/custom_filestorage","sidebar":"tutorialSidebar"},{"id":"help/User Menu/Console/emails","path":"/docs/help/User Menu/Console/emails","sidebar":"tutorialSidebar"},{"id":"help/User Menu/Console/general","path":"/docs/help/User Menu/Console/general","sidebar":"tutorialSidebar"},{"id":"help/User Menu/Console/globalSMTP","path":"/docs/help/User Menu/Console/globalSMTP","sidebar":"tutorialSidebar"},{"id":"help/User Menu/Console/orgadmin","path":"/docs/help/User Menu/Console/orgadmin","sidebar":"tutorialSidebar"},{"id":"help/User Menu/Console/organizations","path":"/docs/help/User Menu/Console/organizations","sidebar":"tutorialSidebar"},{"id":"help/User Menu/Console/signing_certificate","path":"/docs/help/User Menu/Console/signing_certificate","sidebar":"tutorialSidebar"},{"id":"help/User Menu/Profile","path":"/docs/help/User Menu/Profile","sidebar":"tutorialSidebar"},{"id":"intro","path":"/docs/intro"},{"id":"self-host/cloud-storage/s3","path":"/docs/self-host/cloud-storage/s3","sidebar":"selfhostSidebar"},{"id":"self-host/docker/run-locally","path":"/docs/self-host/docker/run-locally","sidebar":"selfhostSidebar"},{"id":"self-host/docker/upgrade-deployment","path":"/docs/self-host/docker/upgrade-deployment","sidebar":"selfhostSidebar"},{"id":"self-host/guides/azure-vm-setup","path":"/docs/self-host/guides/azure-vm-setup","sidebar":"selfhostSidebar"},{"id":"self-host/guides/env-variables","path":"/docs/self-host/guides/env-variables","sidebar":"selfhostSidebar"},{"id":"self-host/guides/how-to-generate-self-signed-document-signing-certificate","path":"/docs/self-host/guides/how-to-generate-self-signed-document-signing-certificate","sidebar":"selfhostSidebar"},{"id":"self-host/guides/upgrade-to-v2.1.0","path":"/docs/self-host/guides/upgrade-to-v2.1.0","sidebar":"selfhostSidebar"},{"id":"self-host/intro","path":"/docs/self-host/intro","sidebar":"selfhostSidebar"},{"id":"self-host/One-click-Install/DigitalOcean","path":"/docs/self-host/One-click-Install/DigitalOcean","sidebar":"selfhostSidebar"},{"id":"/category/create-new-opensign-document","path":"/docs/category/create-new-opensign-document","sidebar":"tutorialSidebar"},{"id":"/category/manage-docs-using-opensign-drive","path":"/docs/category/manage-docs-using-opensign-drive","sidebar":"tutorialSidebar"},{"id":"/category/documents","path":"/docs/category/documents","sidebar":"tutorialSidebar"},{"id":"/category/templates","path":"/docs/category/templates","sidebar":"tutorialSidebar"},{"id":"/category/settings","path":"/docs/category/settings","sidebar":"tutorialSidebar"},{"id":"/category/user-menu","path":"/docs/category/user-menu","sidebar":"tutorialSidebar"},{"id":"/category/console","path":"/docs/category/console","sidebar":"tutorialSidebar"},{"id":"/category/faqs","path":"/docs/category/faqs","sidebar":"tutorialSidebar"},{"id":"/category/docker","path":"/docs/category/docker","sidebar":"selfhostSidebar"},{"id":"/category/cloud-storage","path":"/docs/category/cloud-storage","sidebar":"selfhostSidebar"},{"id":"/category/guides","path":"/docs/category/guides","sidebar":"selfhostSidebar"},{"id":"/API-docs/v1.2","path":"/docs/API-docs/v1.2","sidebar":"apiSidebar"},{"id":"/API-docs/v1.1","path":"/docs/API-docs/v1.1","sidebar":"apiSidebar"},{"id":"/API-docs/v1","path":"/docs/API-docs/v1","sidebar":"apiSidebar"}],"draftIds":[],"sidebars":{"tutorialSidebar":{"link":{"path":"/docs/help/intro","label":"help/intro"}},"selfhostSidebar":{"link":{"path":"/docs/self-host/intro","label":"self-host/intro"}},"contributeSidebar":{"link":{"path":"/docs/contribute/CODE_OF_CONDUCT","label":"contribute/CODE_OF_CONDUCT"}},"apiSidebar":{"link":{"path":"/docs/API-docs/v1.2","label":"v1.2"}}}}],"breadcrumbs":true}}}'),i=JSON.parse('{"defaultLocale":"en","locales":["en"],"path":"i18n","currentLocale":"en","localeConfigs":{"en":{"label":"English","direction":"ltr","htmlLang":"en","calendar":"gregory","path":"en","translate":false,"url":"https://docs.opensignlabs.com","baseUrl":"/"}}}');var s=n(22654);const l=JSON.parse('{"docusaurusVersion":"3.9.2","siteVersion":"0.1.0","pluginVersions":{"docusaurus-plugin-content-docs":{"type":"package","name":"@docusaurus/plugin-content-docs","version":"3.9.2"},"docusaurus-plugin-content-blog":{"type":"package","name":"@docusaurus/plugin-content-blog","version":"3.9.2"},"docusaurus-plugin-content-pages":{"type":"package","name":"@docusaurus/plugin-content-pages","version":"3.9.2"},"docusaurus-plugin-sitemap":{"type":"package","name":"@docusaurus/plugin-sitemap","version":"3.9.2"},"docusaurus-plugin-svgr":{"type":"package","name":"@docusaurus/plugin-svgr","version":"3.9.2"},"docusaurus-theme-classic":{"type":"package","name":"@docusaurus/theme-classic","version":"3.9.2"},"docusaurus-plugin-openapi-docs":{"type":"package","name":"docusaurus-plugin-openapi-docs","version":"4.7.1"},"docusaurus-theme-openapi":{"type":"package","name":"docusaurus-theme-openapi-docs","version":"4.7.1"}}}');var c=n(74848);const u={siteConfig:o.default,siteMetadata:l,globalData:a,i18n:i,codeTranslations:s},d=r.createContext(u);function p({children:e}){return(0,c.jsx)(d.Provider,{value:u,children:e})}},67489(e,t,n){"use strict";n.d(t,{A:()=>h});var r=n(96540),o=n(38193),a=n(5260),i=n(70440),s=n(2828),l=n(53102),c=n(74848);function u({error:e,tryAgain:t}){return(0,c.jsxs)("div",{style:{display:"flex",flexDirection:"column",justifyContent:"center",alignItems:"flex-start",minHeight:"100vh",width:"100%",maxWidth:"80ch",fontSize:"20px",margin:"0 auto",padding:"1rem"},children:[(0,c.jsx)("h1",{style:{fontSize:"3rem"},children:"This page crashed"}),(0,c.jsx)("button",{type:"button",onClick:t,style:{margin:"1rem 0",fontSize:"2rem",cursor:"pointer",borderRadius:20,padding:"1rem"},children:"Try again"}),(0,c.jsx)(d,{error:e})]})}function d({error:e}){const t=(0,i.rA)(e).map(e=>e.message).join("\n\nCause:\n");return(0,c.jsx)("p",{style:{whiteSpace:"pre-wrap"},children:t})}function p({children:e}){return(0,c.jsx)(l.W,{value:{plugin:{name:"docusaurus-core-error-boundary",id:"default"}},children:e})}function f({error:e,tryAgain:t}){return(0,c.jsx)(p,{children:(0,c.jsxs)(h,{fallback:()=>(0,c.jsx)(u,{error:e,tryAgain:t}),children:[(0,c.jsx)(a.A,{children:(0,c.jsx)("title",{children:"Page Error"})}),(0,c.jsx)(s.A,{children:(0,c.jsx)(u,{error:e,tryAgain:t})})]})})}const m=e=>(0,c.jsx)(f,{...e});class h extends r.Component{constructor(e){super(e),this.state={error:null}}componentDidCatch(e){o.default.canUseDOM&&this.setState({error:e})}render(){const{children:e}=this.props,{error:t}=this.state;if(t){const e={error:t,tryAgain:()=>this.setState({error:null})};return(this.props.fallback??m)(e)}return e??null}}},38193(e,t,n){"use strict";n.r(t),n.d(t,{default:()=>o});const r="undefined"!=typeof window&&"document"in window&&"createElement"in window.document,o={canUseDOM:r,canUseEventListeners:r&&("addEventListener"in window||"attachEvent"in window),canUseIntersectionObserver:r&&"IntersectionObserver"in window,canUseViewport:r&&"screen"in window}},5260(e,t,n){"use strict";n.d(t,{A:()=>a});n(96540);var r=n(80545),o=n(74848);function a(e){return(0,o.jsx)(r.mg,{...e})}},28774(e,t,n){"use strict";n.r(t),n.d(t,{default:()=>f});var r=n(96540),o=n(54625),a=n(70440),i=n(44586),s=n(16654),l=n(38193),c=n(63427),u=n(86025),d=n(74848);function p({isNavLink:e,to:t,href:n,activeClassName:p,isActive:f,"data-noBrokenLinkCheck":m,autoAddBaseUrl:h=!0,...g},b){const{siteConfig:v}=(0,i.default)(),{trailingSlash:y,baseUrl:w}=v,k=v.future.experimental_router,{withBaseUrl:x}=(0,u.useBaseUrlUtils)(),S=(0,c.A)(),P=(0,r.useRef)(null);(0,r.useImperativeHandle)(b,()=>P.current);const A=t||n;const _=(0,s.A)(A),I=A?.replace("pathname://","");let E=void 0!==I?(C=I,h&&(e=>e.startsWith("/"))(C)?x(C):C):void 0;var C;"hash"===k&&E?.startsWith("./")&&(E=E?.slice(1)),E&&_&&(E=(0,a.Ks)(E,{trailingSlash:y,baseUrl:w}));const T=(0,r.useRef)(!1),j=e?o.k2:o.N_,N=l.default.canUseIntersectionObserver,O=(0,r.useRef)(),R=()=>{T.current||null==E||(window.docusaurus.preload(E),T.current=!0)};(0,r.useEffect)(()=>(!N&&_&&l.default.canUseDOM&&null!=E&&window.docusaurus.prefetch(E),()=>{N&&O.current&&O.current.disconnect()}),[O,E,N,_]);const D=E?.startsWith("#")??!1,L=!g.target||"_self"===g.target,M=!E||!_||!L||D&&"hash"!==k;m||!D&&M||S.collectLink(E),g.id&&S.collectAnchor(g.id);const F={};return M?(0,d.jsx)("a",{ref:P,href:E,...A&&!_&&{target:"_blank",rel:"noopener noreferrer"},...g,...F}):(0,d.jsx)(j,{...g,onMouseEnter:R,onTouchStart:R,innerRef:e=>{P.current=e,N&&e&&_&&(O.current=new window.IntersectionObserver(t=>{t.forEach(t=>{e===t.target&&(t.isIntersecting||t.intersectionRatio>0)&&(O.current.unobserve(e),O.current.disconnect(),null!=E&&window.docusaurus.prefetch(E))})}),O.current.observe(e))},to:E,...e&&{isActive:f,activeClassName:p},...F})}const f=r.forwardRef(p)},20418(e,t,n){"use strict";n.d(t,{A:()=>r});const r=()=>null},21312(e,t,n){"use strict";n.r(t),n.d(t,{default:()=>c,translate:()=>l});var r=n(96540),o=n(74848);function a(e,t){const n=e.split(/(\{\w+\})/).map((e,n)=>{if(n%2==1){const n=t?.[e.slice(1,-1)];if(void 0!==n)return n}return e});return n.some(e=>(0,r.isValidElement)(e))?n.map((e,t)=>(0,r.isValidElement)(e)?r.cloneElement(e,{key:t}):e).filter(e=>""!==e):n.join("")}var i=n(22654);function s({id:e,message:t}){if(void 0===e&&void 0===t)throw new Error("Docusaurus translation declarations must have at least a translation id or a default translation message");return i[e??t]??t??e}function l({message:e,id:t},n){return a(s({message:e,id:t}),n)}function c({children:e,id:t,values:n}){if(e&&"string"!=typeof e)throw console.warn("Illegal children",e),new Error("The Docusaurus component only accept simple string values");const r=s({message:e,id:t});return(0,o.jsx)(o.Fragment,{children:a(r,n)})}},17065(e,t,n){"use strict";n.d(t,{W:()=>r});const r="default"},16654(e,t,n){"use strict";function r(e){return/^(?:\w*:|\/\/)/.test(e)}function o(e){return void 0!==e&&!r(e)}n.d(t,{A:()=>o,z:()=>r})},86025(e,t,n){"use strict";n.r(t),n.d(t,{addBaseUrl:()=>i,default:()=>l,useBaseUrlUtils:()=>s});var r=n(96540),o=n(44586),a=n(16654);function i({siteUrl:e,baseUrl:t,url:n,options:{forcePrependBaseUrl:r=!1,absolute:o=!1}={},router:i}){if(!n||n.startsWith("#")||(0,a.z)(n))return n;if("hash"===i)return n.startsWith("/")?`.${n}`:`./${n}`;if(r)return t+n.replace(/^\//,"");if(n===t.replace(/\/$/,""))return t;const s=!n.startsWith(t)?t+n.replace(/^\//,""):n;return o?e+s:s}function s(){const{siteConfig:e}=(0,o.default)(),{baseUrl:t,url:n}=e,a=e.future.experimental_router;return{withBaseUrl:(0,r.useCallback)((e,r)=>i({siteUrl:n,baseUrl:t,url:e,options:r,router:a}),[n,t,a])}}function l(e,t={}){const{withBaseUrl:n}=s();return n(e,t)}},63427(e,t,n){"use strict";n.d(t,{A:()=>a});var r=n(96540);n(74848);const o=r.createContext({collectAnchor:()=>{},collectLink:()=>{}});function a(){return(0,r.useContext)(o)}},44586(e,t,n){"use strict";n.r(t),n.d(t,{default:()=>a});var r=n(96540),o=n(26988);function a(){return(0,r.useContext)(o.o)}},92303(e,t,n){"use strict";n.r(t),n.d(t,{default:()=>a});var r=n(96540),o=n(6125);function a(){return(0,r.useContext)(o.o)}},205(e,t,n){"use strict";n.d(t,{A:()=>o});var r=n(96540);const o=n(38193).default.canUseDOM?r.useLayoutEffect:r.useEffect},36803(e,t,n){"use strict";n.d(t,{A:()=>a});var r=n(96540),o=n(53102);function a(){const e=r.useContext(o.o);if(!e)throw new Error("Unexpected: no Docusaurus route context found");return e}},86921(e,t,n){"use strict";n.d(t,{A:()=>r});function r(e){const t={};return function e(n,r){Object.entries(n).forEach(([n,o])=>{const a=r?`${r}.${n}`:n;var i;"object"==typeof(i=o)&&i&&Object.keys(i).length>0?e(o,a):t[a]=o})}(e),t}},53102(e,t,n){"use strict";n.d(t,{W:()=>i,o:()=>a});var r=n(96540),o=n(74848);const a=r.createContext(null);function i({children:e,value:t}){const n=r.useContext(a),i=(0,r.useMemo)(()=>function({parent:e,value:t}){if(!e){if(!t)throw new Error("Unexpected: no Docusaurus route context found");if(!("plugin"in t))throw new Error("Unexpected: Docusaurus topmost route context has no `plugin` attribute");return t}const n={...e.data,...t?.data};return{plugin:e.plugin,data:n}}({parent:n,value:t}),[n,t]);return(0,o.jsx)(a.Provider,{value:i,children:e})}},60542(e,t,n){"use strict";n.d(t,{_:()=>s,u:()=>l});var r=n(96540),o=n(89532),a=n(74848);const i=r.createContext(null);function s({children:e,content:t}){const n=function(e){return(0,r.useMemo)(()=>({metadata:e.metadata,frontMatter:e.frontMatter,assets:e.assets,contentTitle:e.contentTitle,toc:e.toc}),[e])}(t);return(0,a.jsx)(i.Provider,{value:n,children:e})}function l(){const e=(0,r.useContext)(i);if(null===e)throw new o.dV("DocProvider");return e}},33082(e,t,n){"use strict";n.d(t,{A:()=>l,G:()=>c});var r=n(96540),o=n(89532),a=n(74848);const i=Symbol("EmptyContext"),s=r.createContext(i);function l({children:e}){const[t,n]=(0,r.useState)(null),o=(0,r.useMemo)(()=>({expandedItem:t,setExpandedItem:n}),[t]);return(0,a.jsx)(s.Provider,{value:o,children:e})}function c(){const e=(0,r.useContext)(s);if(e===i)throw new o.dV("DocSidebarItemsExpandedStateProvider");return e}},53886(e,t,n){"use strict";n.d(t,{VQ:()=>b,XK:()=>w,g1:()=>y});var r=n(96540),o=n(44070),a=n(17065),i=n(6342),s=n(70679),l=n(89532),c=n(74848);const u=e=>`docs-preferred-version-${e}`,d=(e,t,n)=>{(0,s.Wf)(u(e),{persistence:t}).set(n)},p=(e,t)=>(0,s.Wf)(u(e),{persistence:t}).get(),f=(e,t)=>{(0,s.Wf)(u(e),{persistence:t}).del()};const m=r.createContext(null);function h(){const e=(0,o.useAllDocsData)(),t=(0,i.p)().docs.versionPersistence,n=(0,r.useMemo)(()=>Object.keys(e),[e]),[a,s]=(0,r.useState)(()=>(e=>Object.fromEntries(e.map(e=>[e,{preferredVersionName:null}])))(n));(0,r.useEffect)(()=>{s(function({pluginIds:e,versionPersistence:t,allDocsData:n}){function r(e){const r=p(e,t);return n[e].versions.some(e=>e.name===r)?{preferredVersionName:r}:(f(e,t),{preferredVersionName:null})}return Object.fromEntries(e.map(e=>[e,r(e)]))}({allDocsData:e,versionPersistence:t,pluginIds:n}))},[e,t,n]);return[a,(0,r.useMemo)(()=>({savePreferredVersion:function(e,n){d(e,t,n),s(t=>({...t,[e]:{preferredVersionName:n}}))}}),[t])]}function g({children:e}){const t=h();return(0,c.jsx)(m.Provider,{value:t,children:e})}function b({children:e}){return(0,c.jsx)(g,{children:e})}function v(){const e=(0,r.useContext)(m);if(!e)throw new l.dV("DocsPreferredVersionContextProvider");return e}function y(e=a.W){const t=(0,o.useDocsData)(e),[n,i]=v(),{preferredVersionName:s}=n[e];return{preferredVersion:t.versions.find(e=>e.name===s)??null,savePreferredVersionName:(0,r.useCallback)(t=>{i.savePreferredVersion(e,t)},[i,e])}}function w(){const e=(0,o.useAllDocsData)(),[t]=v();function n(n){const r=e[n],{preferredVersionName:o}=t[n];return r.versions.find(e=>e.name===o)??null}const r=Object.keys(e);return Object.fromEntries(r.map(e=>[e,n(e)]))}},82565(e,t,n){"use strict";n.d(t,{k:()=>a,v:()=>i});var r=n(44070),o=n(53886);function a(e,t){return`docs-${e}-${t}`}function i(){const e=(0,r.useAllDocsData)(),t=(0,r.useActivePluginAndVersion)(),n=(0,o.XK)();return[...Object.keys(e).map(function(r){const o=t?.activePlugin.pluginId===r?t.activeVersion:void 0,i=n[r],s=e[r].versions.find(e=>e.isLast);return a(r,(o??i??s).name)})]}},60609(e,t,n){"use strict";n.d(t,{V:()=>l,t:()=>c});var r=n(96540),o=n(89532),a=n(74848);const i=Symbol("EmptyContext"),s=r.createContext(i);function l({children:e,name:t,items:n}){const o=(0,r.useMemo)(()=>t&&n?{name:t,items:n}:null,[t,n]);return(0,a.jsx)(s.Provider,{value:o,children:e})}function c(){const e=(0,r.useContext)(s);if(e===i)throw new o.dV("DocsSidebarProvider");return e}},26972(e,t,n){"use strict";n.d(t,{$S:()=>h,B5:()=>_,Nr:()=>m,OF:()=>x,QB:()=>A,Se:()=>y,Vd:()=>S,Y:()=>w,_j:()=>f,a4:()=>g,cC:()=>p,d1:()=>I,fW:()=>P,w8:()=>v});var r=n(96540),o=n(56347),a=n(22831),i=n(44070),s=n(99169),l=n(31682),c=n(53886),u=n(23025),d=n(60609);function p(e){const t=(0,u.r)();if(!e)return;const n=t.docs[e];if(!n)throw new Error(`no version doc found by id=${e}`);return n}function f(e,t){for(const n of e)if("category"===n.type){if(t(n))return n;const e=f(n.items,t);if(e)return e}}function m(e){return"link"!==e.type||e.unlisted?"category"===e.type?function(e){if(e.href&&!e.linkUnlisted)return e.href;for(const t of e.items){const e=m(t);if(e)return e}}(e):void 0:e.href}function h(){const{pathname:e}=(0,o.zy)(),t=(0,d.t)();if(!t)throw new Error("Unexpected: cant find current sidebar in context");const n=k({sidebarItems:t.items,pathname:e,onlyCategories:!0}).slice(-1)[0];if(!n)throw new Error(`${e} is not associated with a category. useCurrentSidebarCategory() should only be used on category index pages.`);return n}function g(){const{pathname:e}=(0,o.zy)(),t=(0,d.t)();if(!t)throw new Error("Unexpected: cant find current sidebar in context");const n=k({sidebarItems:t.items,pathname:e,onlyCategories:!0}).slice(-1)[0];return n?.items??t.items}const b=(e,t)=>void 0!==e&&(0,s.ys)(e,t);function v(e,t){return"link"===e.type?b(e.href,t):"category"===e.type&&(b(e.href,t)||((e,t)=>e.some(e=>v(e,t)))(e.items,t))}function y(e,t){switch(e.type){case"category":return v(e,t)||void 0!==e.href&&!e.linkUnlisted||e.items.some(e=>y(e,t));case"link":return!e.unlisted||v(e,t);default:return!0}}function w(e,t){return(0,r.useMemo)(()=>e.filter(e=>y(e,t)),[e,t])}function k({sidebarItems:e,pathname:t,onlyCategories:n=!1}){const r=[];return function e(o){for(const a of o)if("category"===a.type&&((0,s.ys)(a.href,t)||e(a.items))||"link"===a.type&&(0,s.ys)(a.href,t)){return n&&"category"!==a.type||r.unshift(a),!0}return!1}(e),r}function x(){const e=(0,d.t)(),{pathname:t}=(0,o.zy)(),n=(0,i.useActivePlugin)()?.pluginData.breadcrumbs;return!1!==n&&e?k({sidebarItems:e.items,pathname:t}):null}function S(e){const{activeVersion:t}=(0,i.useActiveDocContext)(e),{preferredVersion:n}=(0,c.g1)(e),o=(0,i.useLatestVersion)(e);return(0,r.useMemo)(()=>(0,l.sb)([t,n,o].filter(Boolean)),[t,n,o])}function P(e,t){const n=S(t);return(0,r.useMemo)(()=>{const t=n.flatMap(e=>e.sidebars?Object.entries(e.sidebars):[]),r=t.find(t=>t[0]===e);if(!r)throw new Error(`Can't find any sidebar with id "${e}" in version${n.length>1?"s":""} ${n.map(e=>e.name).join(", ")}".\nAvailable sidebar ids are:\n- ${t.map(e=>e[0]).join("\n- ")}`);return r[1]},[e,n])}function A(e,t){const n=S(t);return(0,r.useMemo)(()=>{const t=n.flatMap(e=>e.docs),r=t.find(t=>t.id===e);if(!r){if(n.flatMap(e=>e.draftIds).includes(e))return null;throw new Error(`Couldn't find any doc with id "${e}" in version${n.length>1?"s":""} "${n.map(e=>e.name).join(", ")}".\nAvailable doc ids are:\n- ${(0,l.sb)(t.map(e=>e.id)).join("\n- ")}`)}return r},[e,n])}function _({route:e}){const t=(0,o.zy)(),n=(0,u.r)(),r=e.routes,i=r.find(e=>(0,o.B6)(t.pathname,e));if(!i)return null;const s=i.sidebar,l=s?n.docsSidebars[s]:void 0;return{docElement:(0,a.v)(r),sidebarName:s,sidebarItems:l}}function I(e){return e.filter(e=>!("category"===e.type||"link"===e.type)||!!m(e))}},23025(e,t,n){"use strict";n.d(t,{n:()=>s,r:()=>l});var r=n(96540),o=n(89532),a=n(74848);const i=r.createContext(null);function s({children:e,version:t}){return(0,a.jsx)(i.Provider,{value:t,children:e})}function l(){const e=(0,r.useContext)(i);if(null===e)throw new o.dV("DocsVersionProvider");return e}},44070(e,t,n){"use strict";n.r(t),n.d(t,{DocProvider:()=>h._,DocSidebarItemsExpandedStateProvider:()=>p.A,DocsPreferredVersionContextProvider:()=>d.VQ,DocsSidebarProvider:()=>m.V,DocsVersionProvider:()=>f.n,filterDocCardListItems:()=>u.d1,findFirstSidebarItemLink:()=>u.Nr,findSidebarCategory:()=>u._j,getDocsVersionSearchTag:()=>g.k,isActiveSidebarItem:()=>u.w8,isVisibleSidebarItem:()=>u.Se,useActiveDocContext:()=>_,useActivePlugin:()=>k,useActivePluginAndVersion:()=>x,useActiveVersion:()=>A,useAllDocsData:()=>y,useBreadcrumbsStructuredData:()=>b.D,useCurrentSidebarCategory:()=>u.$S,useCurrentSidebarSiblings:()=>u.a4,useDoc:()=>h.u,useDocById:()=>u.cC,useDocRootMetadata:()=>u.B5,useDocSidebarItemsExpandedState:()=>p.G,useDocVersionSuggestions:()=>I,useDocsContextualSearchTags:()=>g.v,useDocsData:()=>w,useDocsPreferredVersion:()=>d.g1,useDocsPreferredVersionByPluginId:()=>d.XK,useDocsSidebar:()=>m.t,useDocsVersion:()=>f.r,useDocsVersionCandidates:()=>u.Vd,useLatestVersion:()=>P,useLayoutDoc:()=>u.QB,useLayoutDocsSidebar:()=>u.fW,useSidebarBreadcrumbs:()=>u.OF,useVersions:()=>S,useVisibleSidebarItems:()=>u.Y});var r=n(56347),o=n(44586),a=n(17065);function i(e,t={}){const n=function(){const{globalData:e}=(0,o.default)();return e}()[e];if(!n&&t.failfast)throw new Error(`Docusaurus plugin global data not found for "${e}" plugin.`);return n}const s=e=>e.versions.find(e=>e.isLast);function l(e,t){return[...e.versions].sort((e,t)=>e.path===t.path?0:e.path.includes(t.path)?-1:t.path.includes(e.path)?1:0).find(e=>!!(0,r.B6)(t,{path:e.path,exact:!1,strict:!1}))}function c(e,t){const n=l(e,t),o=n?.docs.find(e=>!!(0,r.B6)(t,{path:e.path,exact:!0,strict:!1}));const a=o?function(t){const n={};return e.versions.forEach(e=>{e.docs.forEach(r=>{r.id===t&&(n[e.name]=r)})}),n}(o.id):{};return{activeVersion:n,activeDoc:o,alternateDocVersions:a}}var u=n(26972),d=n(53886),p=n(33082),f=n(23025),m=n(60609),h=n(60542),g=n(82565),b=n(33336);const v={},y=()=>i("docusaurus-plugin-content-docs")??v,w=e=>{try{return function(e,t=a.W,n={}){const r=i(e),o=r?.[t];if(!o&&n.failfast)throw new Error(`Docusaurus plugin global data not found for "${e}" plugin with id "${t}".`);return o}("docusaurus-plugin-content-docs",e,{failfast:!0})}catch(t){throw new Error("You are using a feature of the Docusaurus docs plugin, but this plugin does not seem to be enabled"+("Default"===e?"":` (pluginId=${e}`),{cause:t})}};function k(e={}){const t=y(),{pathname:n}=(0,r.zy)();return function(e,t,n={}){const o=Object.entries(e).sort((e,t)=>t[1].path.localeCompare(e[1].path)).find(([,e])=>!!(0,r.B6)(t,{path:e.path,exact:!1,strict:!1})),a=o?{pluginId:o[0],pluginData:o[1]}:void 0;if(!a&&n.failfast)throw new Error(`Can't find active docs plugin for "${t}" pathname, while it was expected to be found. Maybe you tried to use a docs feature that can only be used on a docs-related page? Existing docs plugin paths are: ${Object.values(e).map(e=>e.path).join(", ")}`);return a}(t,n,e)}function x(e={}){const t=k(e),{pathname:n}=(0,r.zy)();if(!t)return;return{activePlugin:t,activeVersion:l(t.pluginData,n)}}function S(e){return w(e).versions}function P(e){const t=w(e);return s(t)}function A(e){const t=w(e),{pathname:n}=(0,r.zy)();return l(t,n)}function _(e){const t=w(e),{pathname:n}=(0,r.zy)();return c(t,n)}function I(e){const t=w(e),{pathname:n}=(0,r.zy)();return function(e,t){const n=s(e);return{latestDocSuggestion:c(e,t).alternateDocVersions[n.name],latestVersionSuggestion:n}}(t,n)}},33336(e,t,n){"use strict";n.d(t,{D:()=>o});var r=n(44586);function o({breadcrumbs:e}){const{siteConfig:t}=(0,r.default)();return{"@context":"https://schema.org","@type":"BreadcrumbList",itemListElement:e.filter(e=>e.href).map((e,n)=>({"@type":"ListItem",position:n+1,name:e.label,item:`${t.url}${e.href}`}))}}},76294(e,t,n){"use strict";n.r(t),n.d(t,{default:()=>a});var r=n(5947),o=n.n(r);o().configure({showSpinner:!1});const a={onRouteUpdate({location:e,previousLocation:t}){if(t&&e.pathname!==t.pathname){const e=window.setTimeout(()=>{o().start()},200);return()=>window.clearTimeout(e)}},onRouteDidUpdate(){o().done()}}},26134(e,t,n){"use strict";var r=n(78181),o=n(4784);!function(e){const{themeConfig:{prism:t}}=o.default,{additionalLanguages:r}=t,a=globalThis.Prism;globalThis.Prism=e,r.forEach(e=>{"php"===e&&n(19700),n(18692)(`./prism-${e}`)}),delete globalThis.Prism,void 0!==a&&(globalThis.Prism=e)}(r.Prism)},51107(e,t,n){"use strict";n.r(t),n.d(t,{default:()=>c});n(96540);var r=n(18215),o=n(21312),a=n(73535),i=n(28774),s=n(63427),l=n(74848);function c({as:e,id:t,...n}){const c=(0,s.A)(),u=(0,a.v)(t);if("h1"===e||!t)return(0,l.jsx)(e,{...n,id:void 0});c.collectAnchor(t);const d=(0,o.translate)({id:"theme.common.headingLinkTitle",message:"Direct link to {heading}",description:"Title for link to heading"},{heading:"string"==typeof n.children?n.children:t});return(0,l.jsxs)(e,{...n,className:(0,r.A)("anchor",u,n.className),id:t,children:[n.children,(0,l.jsx)(i.default,{className:"hash-link",to:`#${t}`,"aria-label":d,title:d,translate:"no",children:"\u200b"})]})}},43186(e,t,n){"use strict";n.d(t,{A:()=>i});n(96540);var r=n(21312);const o="iconExternalLink_nPIU";var a=n(74848);function i({width:e=13.5,height:t=13.5}){return(0,a.jsx)("svg",{width:e,height:t,"aria-label":(0,r.translate)({id:"theme.IconExternalLink.ariaLabel",message:"(opens in new tab)",description:"The ARIA label for the external link icon"}),className:o,children:(0,a.jsx)("use",{href:"#theme-svg-external-link"})})}},2828(e,t,n){"use strict";n.d(t,{A:()=>St});var r=n(96540),o=n(18215),a=n(67489),i=n(45500),s=n(75236),l=n(17559),c=n(14090);const u="skipToContent_fXgn";var d=n(74848);function p(){return(0,d.jsx)(s.K,{className:u})}var f=n(6342),m=n(65041),h=n(21312);function g({width:e=21,height:t=21,color:n="currentColor",strokeWidth:r=1.2,className:o,...a}){return(0,d.jsx)("svg",{viewBox:"0 0 15 15",width:e,height:t,...a,children:(0,d.jsx)("g",{stroke:n,strokeWidth:r,children:(0,d.jsx)("path",{d:"M.75.75l13.5 13.5M14.25.75L.75 14.25"})})})}const b="closeButton_CVFx";function v(e){return(0,d.jsx)("button",{type:"button","aria-label":(0,h.translate)({id:"theme.AnnouncementBar.closeButtonAriaLabel",message:"Close",description:"The ARIA label for close button of announcement bar"}),...e,className:(0,o.A)("clean-btn close",b,e.className),children:(0,d.jsx)(g,{width:14,height:14,strokeWidth:3.1})})}const y="content_knG7";function w(e){const{announcementBar:t}=(0,f.p)(),{content:n}=t;return(0,d.jsx)("div",{...e,className:(0,o.A)(y,e.className),dangerouslySetInnerHTML:{__html:n}})}const k="announcementBar_mb4j",x="announcementBarPlaceholder_vyr4",S="announcementBarClose_gvF7",P="announcementBarContent_xLdY";function A(){const{announcementBar:e}=(0,f.p)(),{isActive:t,close:n}=(0,m.M)();if(!t)return null;const{backgroundColor:r,textColor:a,isCloseable:i}=e;return(0,d.jsxs)("div",{className:(0,o.A)(l.G.announcementBar.container,k),style:{backgroundColor:r,color:a},role:"banner",children:[i&&(0,d.jsx)("div",{className:x}),(0,d.jsx)(w,{className:P}),i&&(0,d.jsx)(v,{onClick:n,className:S})]})}var _=n(22069),I=n(61182),E=n(43458),C=n(98695);function T(e){return parseInt(r.version.split(".")[0],10)<19?{inert:e?"":void 0}:{inert:e}}function j({children:e,inert:t}){return(0,d.jsx)("div",{className:(0,o.A)(l.G.layout.navbar.mobileSidebar.panel,"navbar-sidebar__item menu"),...T(t),children:e})}function N({header:e,primaryMenu:t,secondaryMenu:n}){const{shown:r}=(0,C.T)();return(0,d.jsxs)("div",{className:(0,o.A)(l.G.layout.navbar.mobileSidebar.container,"navbar-sidebar"),children:[e,(0,d.jsxs)("div",{className:(0,o.A)("navbar-sidebar__items",{"navbar-sidebar__items--show-secondary":r}),children:[(0,d.jsx)(j,{inert:r,children:t}),(0,d.jsx)(j,{inert:!r,children:n})]})]})}var O=n(95293),R=n(92303);function D(e){return(0,d.jsx)("svg",{viewBox:"0 0 24 24",width:24,height:24,...e,children:(0,d.jsx)("path",{fill:"currentColor",d:"M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"})})}function L(e){return(0,d.jsx)("svg",{viewBox:"0 0 24 24",width:24,height:24,...e,children:(0,d.jsx)("path",{fill:"currentColor",d:"M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"})})}function M(e){return(0,d.jsx)("svg",{viewBox:"0 0 24 24",width:24,height:24,...e,children:(0,d.jsx)("path",{fill:"currentColor",d:"m12 21c4.971 0 9-4.029 9-9s-4.029-9-9-9-9 4.029-9 9 4.029 9 9 9zm4.95-13.95c1.313 1.313 2.05 3.093 2.05 4.95s-0.738 3.637-2.05 4.95c-1.313 1.313-3.093 2.05-4.95 2.05v-14c1.857 0 3.637 0.737 4.95 2.05z"})})}const F="toggle_vylO",z="toggleButton_gllP",U="toggleIcon_g3eP",B="systemToggleIcon_QzmC",$="lightToggleIcon_pyhR",q="darkToggleIcon_wfgR",G="toggleButtonDisabled_aARS";function V(e){switch(e){case null:return(0,h.translate)({message:"system mode",id:"theme.colorToggle.ariaLabel.mode.system",description:"The name for the system color mode"});case"light":return(0,h.translate)({message:"light mode",id:"theme.colorToggle.ariaLabel.mode.light",description:"The name for the light color mode"});case"dark":return(0,h.translate)({message:"dark mode",id:"theme.colorToggle.ariaLabel.mode.dark",description:"The name for the dark color mode"});default:throw new Error(`unexpected color mode ${e}`)}}function H(e){return(0,h.translate)({message:"Switch between dark and light mode (currently {mode})",id:"theme.colorToggle.ariaLabel",description:"The ARIA label for the color mode toggle"},{mode:V(e)})}function W(){return(0,d.jsxs)(d.Fragment,{children:[(0,d.jsx)(D,{"aria-hidden":!0,className:(0,o.A)(U,$)}),(0,d.jsx)(L,{"aria-hidden":!0,className:(0,o.A)(U,q)}),(0,d.jsx)(M,{"aria-hidden":!0,className:(0,o.A)(U,B)})]})}function Q({className:e,buttonClassName:t,respectPrefersColorScheme:n,value:r,onChange:a}){const i=(0,R.default)();return(0,d.jsx)("div",{className:(0,o.A)(F,e),children:(0,d.jsx)("button",{className:(0,o.A)("clean-btn",z,!i&&G,t),type:"button",onClick:()=>a(function(e,t){if(!t)return"dark"===e?"light":"dark";switch(e){case null:return"light";case"light":return"dark";case"dark":return null;default:throw new Error(`unexpected color mode ${e}`)}}(r,n)),disabled:!i,title:V(r),"aria-label":H(r),children:(0,d.jsx)(W,{})})})}const K=r.memo(Q),Y="darkNavbarColorModeToggle_X3D1";function Z({className:e}){const t=(0,f.p)().navbar.style,{disableSwitch:n,respectPrefersColorScheme:r}=(0,f.p)().colorMode,{colorModeChoice:o,setColorMode:a}=(0,O.G)();return n?null:(0,d.jsx)(K,{className:e,buttonClassName:"dark"===t?Y:void 0,respectPrefersColorScheme:r,value:o,onChange:a})}var X=n(23465);function J(){return(0,d.jsx)(X.A,{className:"navbar__brand",imageClassName:"navbar__logo",titleClassName:"navbar__title text--truncate"})}function ee(){const e=(0,_.M)();return(0,d.jsx)("button",{type:"button","aria-label":(0,h.translate)({id:"theme.docs.sidebar.closeSidebarButtonAriaLabel",message:"Close navigation bar",description:"The ARIA label for close button of mobile sidebar"}),className:"clean-btn navbar-sidebar__close",onClick:()=>e.toggle(),children:(0,d.jsx)(g,{color:"var(--ifm-color-emphasis-600)"})})}function te(){return(0,d.jsxs)("div",{className:"navbar-sidebar__brand",children:[(0,d.jsx)(J,{}),(0,d.jsx)(Z,{className:"margin-right--md"}),(0,d.jsx)(ee,{})]})}var ne=n(28774),re=n(86025),oe=n(16654),ae=n(91252),ie=n(43186);function se({activeBasePath:e,activeBaseRegex:t,to:n,href:r,label:o,html:a,isDropdownLink:i,prependBaseUrlToHref:s,...l}){const c=(0,re.default)(n),u=(0,re.default)(e),p=(0,re.default)(r,{forcePrependBaseUrl:!0}),f=o&&r&&!(0,oe.A)(r),m=a?{dangerouslySetInnerHTML:{__html:a}}:{children:(0,d.jsxs)(d.Fragment,{children:[o,f&&(0,d.jsx)(ie.A,{...i&&{width:12,height:12}})]})};return r?(0,d.jsx)(ne.default,{href:s?p:r,...l,...m}):(0,d.jsx)(ne.default,{to:c,isNavLink:!0,...(e||t)&&{isActive:(e,n)=>t?(0,ae.G)(t,n.pathname):n.pathname.startsWith(u)},...l,...m})}function le({className:e,isDropdownItem:t,...n}){return(0,d.jsx)("li",{className:"menu__list-item",children:(0,d.jsx)(se,{className:(0,o.A)("menu__link",e),...n})})}function ce({className:e,isDropdownItem:t=!1,...n}){const r=(0,d.jsx)(se,{className:(0,o.A)(t?"dropdown__link":"navbar__item navbar__link",e),isDropdownLink:t,...n});return t?(0,d.jsx)("li",{children:r}):r}function ue({mobile:e=!1,position:t,...n}){const r=e?le:ce;return(0,d.jsx)(r,{...n,activeClassName:n.activeClassName??(e?"menu__link--active":"navbar__link--active")})}var de=n(41422),pe=n(99169),fe=n(9342);const me="dropdownNavbarItemMobile_J0Sd";function he(e,t){return e.some(e=>function(e,t){return!!(0,pe.ys)(e.to,t)||!!(0,ae.G)(e.activeBaseRegex,t)||!(!e.activeBasePath||!t.startsWith(e.activeBasePath))}(e,t))}function ge({collapsed:e,onClick:t}){return(0,d.jsx)("button",{"aria-label":e?(0,h.translate)({id:"theme.navbar.mobileDropdown.collapseButton.expandAriaLabel",message:"Expand the dropdown",description:"The ARIA label of the button to expand the mobile dropdown navbar item"}):(0,h.translate)({id:"theme.navbar.mobileDropdown.collapseButton.collapseAriaLabel",message:"Collapse the dropdown",description:"The ARIA label of the button to collapse the mobile dropdown navbar item"}),"aria-expanded":!e,type:"button",className:"clean-btn menu__caret",onClick:t})}function be({items:e,className:t,position:n,onClick:a,...i}){const s=(0,fe.B)(),l=(0,pe.ys)(i.to,s),c=he(e,s),{collapsed:u,toggleCollapsed:p}=function({active:e}){const{collapsed:t,toggleCollapsed:n,setCollapsed:o}=(0,de.u)({initialState:()=>!e});return(0,r.useEffect)(()=>{e&&o(!1)},[e,o]),{collapsed:t,toggleCollapsed:n}}({active:l||c}),f=i.to?void 0:"#";return(0,d.jsxs)("li",{className:(0,o.A)("menu__list-item",{"menu__list-item--collapsed":u}),children:[(0,d.jsxs)("div",{className:(0,o.A)("menu__list-item-collapsible",{"menu__list-item-collapsible--active":l}),children:[(0,d.jsx)(se,{role:"button",className:(0,o.A)(me,"menu__link menu__link--sublist",t),href:f,...i,onClick:e=>{"#"===f&&e.preventDefault(),p()},children:i.children??i.label}),(0,d.jsx)(ge,{collapsed:u,onClick:e=>{e.preventDefault(),p()}})]}),(0,d.jsx)(de.N,{lazy:!0,as:"ul",className:"menu__list",collapsed:u,children:e.map((e,t)=>(0,r.createElement)(De,{mobile:!0,isDropdownItem:!0,onClick:a,activeClassName:"menu__link--active",...e,key:t}))})]})}function ve({items:e,position:t,className:n,onClick:a,...i}){const s=(0,r.useRef)(null),[l,c]=(0,r.useState)(!1);return(0,r.useEffect)(()=>{const e=e=>{s.current&&!s.current.contains(e.target)&&c(!1)};return document.addEventListener("mousedown",e),document.addEventListener("touchstart",e),document.addEventListener("focusin",e),()=>{document.removeEventListener("mousedown",e),document.removeEventListener("touchstart",e),document.removeEventListener("focusin",e)}},[s]),(0,d.jsxs)("div",{ref:s,className:(0,o.A)("navbar__item","dropdown","dropdown--hoverable",{"dropdown--right":"right"===t,"dropdown--show":l}),children:[(0,d.jsx)(se,{"aria-haspopup":"true","aria-expanded":l,role:"button",href:i.to?void 0:"#",className:(0,o.A)("navbar__link",n),...i,onClick:i.to?void 0:e=>e.preventDefault(),onKeyDown:e=>{"Enter"===e.key&&(e.preventDefault(),c(!l))},children:i.children??i.label}),(0,d.jsx)("ul",{className:"dropdown__menu",children:e.map((e,t)=>(0,r.createElement)(De,{isDropdownItem:!0,activeClassName:"dropdown__link--active",...e,key:t}))})]})}function ye({mobile:e=!1,...t}){const n=e?be:ve;return(0,d.jsx)(n,{...t})}var we=n(44586),ke=n(32131),xe=n(57485);function Se({width:e=20,height:t=20,...n}){return(0,d.jsx)("svg",{viewBox:"0 0 24 24",width:e,height:t,"aria-hidden":!0,...n,children:(0,d.jsx)("path",{fill:"currentColor",d:"M12.87 15.07l-2.54-2.51.03-.03c1.74-1.94 2.98-4.17 3.71-6.53H17V4h-7V2H8v2H1v1.99h11.17C11.5 7.92 10.44 9.75 9 11.35 8.07 10.32 7.3 9.19 6.69 8h-2c.73 1.63 1.73 3.17 2.98 4.56l-5.09 5.02L4 19l5-5 3.11 3.11.76-2.04zM18.5 10h-2L12 22h2l1.12-3h4.75L21 22h2l-4.5-12zm-2.62 7l1.62-4.33L19.12 17h-3.24z"})})}const Pe="iconLanguage_nlXk";function Ae(){const{siteConfig:e,i18n:{localeConfigs:t}}=(0,we.default)(),n=(0,ke.o)(),r=(0,xe.Hl)(e=>e.location.search),o=(0,xe.Hl)(e=>e.location.hash),a=e=>{const n=t[e];if(!n)throw new Error(`Docusaurus bug, no locale config found for locale=${e}`);return n};return{getURL:(t,i)=>{const s=(0,xe.jy)([r,i.queryString],"append");return`${(t=>a(t).url===e.url?`pathname://${n.createUrl({locale:t,fullyQualified:!1})}`:n.createUrl({locale:t,fullyQualified:!0}))(t)}${s}${o}`},getLabel:e=>a(e).label,getLang:e=>a(e).htmlLang}}var _e=n(20418);const Ie="navbarSearchContainer_Bca1";function Ee({children:e,className:t}){return(0,d.jsx)("div",{className:(0,o.A)(t,Ie),children:e})}var Ce=n(44070),Te=n(26972);var je=n(53886);function Ne({docsPluginId:e,configs:t}){return function(e,t){if(t){const n=new Map(e.map(e=>[e.name,e])),r=(t,r)=>{const o=n.get(t);if(!o)throw new Error(`No docs version exist for name '${t}', please verify your 'docsVersionDropdown' navbar item versions config.\nAvailable version names:\n- ${e.map(e=>`${e.name}`).join("\n- ")}`);return{version:o,label:r?.label??o.label}};return Array.isArray(t)?t.map(e=>r(e,void 0)):Object.entries(t).map(([e,t])=>r(e,t))}return e.map(e=>({version:e,label:e.label}))}((0,Ce.useVersions)(e),t)}function Oe(e,t){return t.alternateDocVersions[e.name]??function(e){return e.docs.find(t=>t.id===e.mainDocId)}(e)}const Re={default:ue,localeDropdown:function({mobile:e,dropdownItemsBefore:t,dropdownItemsAfter:n,queryString:r,...o}){const a=Ae(),{i18n:{currentLocale:i,locales:s}}=(0,we.default)(),l=[...t,...s.map(t=>({label:a.getLabel(t),lang:a.getLang(t),to:a.getURL(t,{queryString:r}),target:"_self",autoAddBaseUrl:!1,className:t===i?e?"menu__link--active":"dropdown__link--active":""})),...n],c=e?(0,h.translate)({message:"Languages",id:"theme.navbar.mobileLanguageDropdown.label",description:"The label for the mobile language switcher dropdown"}):a.getLabel(i);return(0,d.jsx)(ye,{...o,mobile:e,label:(0,d.jsxs)(d.Fragment,{children:[(0,d.jsx)(Se,{className:Pe}),c]}),items:l})},search:function({mobile:e,className:t}){return e?null:(0,d.jsx)(Ee,{className:t,children:(0,d.jsx)(_e.A,{})})},dropdown:ye,html:function({value:e,className:t,mobile:n=!1,isDropdownItem:r=!1}){const a=r?"li":"div";return(0,d.jsx)(a,{className:(0,o.A)({navbar__item:!n&&!r,"menu__list-item":n},t),dangerouslySetInnerHTML:{__html:e}})},doc:function({docId:e,label:t,docsPluginId:n,...r}){const{activeDoc:o}=(0,Ce.useActiveDocContext)(n),a=(0,Te.QB)(e,n),i=o?.path===a?.path;return null===a||a.unlisted&&!i?null:(0,d.jsx)(ue,{exact:!0,...r,isActive:()=>i||!!o?.sidebar&&o.sidebar===a.sidebar,label:t??a.id,to:a.path})},docSidebar:function({sidebarId:e,label:t,docsPluginId:n,...r}){const{activeDoc:o}=(0,Ce.useActiveDocContext)(n),a=(0,Te.fW)(e,n).link;if(!a)throw new Error(`DocSidebarNavbarItem: Sidebar with ID "${e}" doesn't have anything to be linked to.`);return(0,d.jsx)(ue,{exact:!0,...r,isActive:()=>o?.sidebar===e,label:t??a.label,to:a.path})},docsVersion:function({label:e,to:t,docsPluginId:n,...r}){const o=(0,Te.Vd)(n)[0],a=e??o.label,i=t??(e=>e.docs.find(t=>t.id===e.mainDocId))(o).path;return(0,d.jsx)(ue,{...r,label:a,to:i})},docsVersionDropdown:function({mobile:e,docsPluginId:t,dropdownActiveClassDisabled:n,dropdownItemsBefore:r,dropdownItemsAfter:o,versions:a,...i}){const s=(0,xe.Hl)(e=>e.location.search),l=(0,xe.Hl)(e=>e.location.hash),c=(0,Ce.useActiveDocContext)(t),{savePreferredVersionName:u}=(0,je.g1)(t),p=Ne({docsPluginId:t,configs:a}),f=function({docsPluginId:e,versionItems:t}){return(0,Te.Vd)(e).map(e=>t.find(t=>t.version===e)).filter(e=>void 0!==e)[0]??t[0]}({docsPluginId:t,versionItems:p}),m=[...r,...p.map(function({version:e,label:t}){return{label:t,to:`${Oe(e,c).path}${s}${l}`,isActive:()=>e===c.activeVersion,onClick:()=>u(e.name)}}),...o],g=e&&m.length>1?(0,h.translate)({id:"theme.navbar.mobileVersionsDropdown.label",message:"Versions",description:"The label for the navbar versions dropdown on mobile view"}):f.label,b=e&&m.length>1?void 0:Oe(f.version,c).path;return m.length<=1?(0,d.jsx)(ue,{...i,mobile:e,label:g,to:b,isActive:n?()=>!1:void 0}):(0,d.jsx)(ye,{...i,mobile:e,label:g,to:b,items:m,isActive:n?()=>!1:void 0})}};function De({type:e,...t}){const n=function(e,t){return e&&"default"!==e?e:"items"in t?"dropdown":"default"}(e,t),r=Re[n];if(!r)throw new Error(`No NavbarItem component found for type "${e}".`);return(0,d.jsx)(r,{...t})}function Le(){const e=(0,_.M)(),t=(0,f.p)().navbar.items;return(0,d.jsx)("ul",{className:"menu__list",children:t.map((t,n)=>(0,r.createElement)(De,{mobile:!0,...t,onClick:()=>e.toggle(),key:n}))})}function Me(e){return(0,d.jsx)("button",{...e,type:"button",className:"clean-btn navbar-sidebar__back",children:(0,d.jsx)(h.default,{id:"theme.navbar.mobileSidebarSecondaryMenu.backButtonLabel",description:"The label of the back button to return to main menu, inside the mobile navbar sidebar secondary menu (notably used to display the docs sidebar)",children:"\u2190 Back to main menu"})})}function Fe(){const e=0===(0,f.p)().navbar.items.length,t=(0,C.T)();return(0,d.jsxs)(d.Fragment,{children:[!e&&(0,d.jsx)(Me,{onClick:()=>t.hide()}),t.content]})}function ze(){const e=(0,_.M)();return(0,E._)(e.shown),e.shouldRender?(0,d.jsx)(N,{header:(0,d.jsx)(te,{}),primaryMenu:(0,d.jsx)(Le,{}),secondaryMenu:(0,d.jsx)(Fe,{})}):null}const Ue="navbarHideable_m1mJ",Be="navbarHidden_jGov";function $e(e){return(0,d.jsx)("div",{role:"presentation",...e,className:(0,o.A)("navbar-sidebar__backdrop",e.className)})}function qe({children:e}){const{navbar:{hideOnScroll:t,style:n}}=(0,f.p)(),r=(0,_.M)(),{navbarRef:a,isNavbarVisible:i}=(0,I.S)(t);return(0,d.jsxs)("nav",{ref:a,"aria-label":(0,h.translate)({id:"theme.NavBar.navAriaLabel",message:"Main",description:"The ARIA label for the main navigation"}),className:(0,o.A)(l.G.layout.navbar.container,"navbar","navbar--fixed-top",t&&[Ue,!i&&Be],{"navbar--dark":"dark"===n,"navbar--primary":"primary"===n,"navbar-sidebar--show":r.shown}),children:[e,(0,d.jsx)($e,{onClick:r.toggle}),(0,d.jsx)(ze,{})]})}var Ge=n(12181),Ve=n(76305);function He({width:e=30,height:t=30,className:n,...r}){return(0,d.jsx)("svg",{className:n,width:e,height:t,viewBox:"0 0 30 30","aria-hidden":"true",...r,children:(0,d.jsx)("path",{stroke:"currentColor",strokeLinecap:"round",strokeMiterlimit:"10",strokeWidth:"2",d:"M4 7h22M4 15h22M4 23h22"})})}function We(){const{toggle:e,shown:t}=(0,_.M)();return(0,d.jsx)("button",{onClick:e,"aria-label":(0,h.translate)({id:"theme.docs.sidebar.toggleSidebarButtonAriaLabel",message:"Toggle navigation bar",description:"The ARIA label for hamburger menu button of mobile navigation"}),"aria-expanded":t,className:"navbar__toggle clean-btn",type:"button",children:(0,d.jsx)(He,{})})}const Qe="colorModeToggle_DEke";function Ke({items:e}){return(0,d.jsx)(d.Fragment,{children:e.map((e,t)=>(0,d.jsx)(Ge.k2,{onError:t=>new Error(`A theme navbar item failed to render.\nPlease double-check the following navbar item (themeConfig.navbar.items) of your Docusaurus config:\n${JSON.stringify(e,null,2)}`,{cause:t}),children:(0,d.jsx)(De,{...e})},t))})}function Ye({left:e,right:t}){return(0,d.jsxs)("div",{className:"navbar__inner",children:[(0,d.jsx)("div",{className:(0,o.A)(l.G.layout.navbar.containerLeft,"navbar__items"),children:e}),(0,d.jsx)("div",{className:(0,o.A)(l.G.layout.navbar.containerRight,"navbar__items navbar__items--right"),children:t})]})}function Ze(){const e=(0,_.M)(),t=(0,f.p)().navbar.items,[n,r]=(0,Ve.D)(t),o=t.find(e=>"search"===e.type);return(0,d.jsx)(Ye,{left:(0,d.jsxs)(d.Fragment,{children:[!e.disabled&&(0,d.jsx)(We,{}),(0,d.jsx)(J,{}),(0,d.jsx)(Ke,{items:n})]}),right:(0,d.jsxs)(d.Fragment,{children:[(0,d.jsx)(Ke,{items:r}),(0,d.jsx)(Z,{className:Qe}),!o&&(0,d.jsx)(Ee,{children:(0,d.jsx)(_e.A,{})})]})})}function Xe(){return(0,d.jsx)(qe,{children:(0,d.jsx)(Ze,{})})}var Je=n(53106);function et({item:e}){const{to:t,href:n,label:r,prependBaseUrlToHref:a,className:i,...s}=e,l=(0,re.default)(t),c=(0,re.default)(n,{forcePrependBaseUrl:!0});return(0,d.jsxs)(ne.default,{className:(0,o.A)("footer__link-item",i),...n?{href:a?c:n}:{to:l},...s,children:[r,n&&!(0,oe.A)(n)&&(0,d.jsx)(ie.A,{})]})}function tt({item:e}){return e.html?(0,d.jsx)("li",{className:(0,o.A)("footer__item",e.className),dangerouslySetInnerHTML:{__html:e.html}}):(0,d.jsx)("li",{className:"footer__item",children:(0,d.jsx)(et,{item:e})},e.href??e.to)}function nt({column:e}){return(0,d.jsxs)("div",{className:(0,o.A)(l.G.layout.footer.column,"col footer__col",e.className),children:[(0,d.jsx)("div",{className:"footer__title",children:e.title}),(0,d.jsx)("ul",{className:"footer__items clean-list",children:e.items.map((e,t)=>(0,d.jsx)(tt,{item:e},t))})]})}function rt({columns:e}){return(0,d.jsx)("div",{className:"row footer__links",children:e.map((e,t)=>(0,d.jsx)(nt,{column:e},t))})}function ot(){return(0,d.jsx)("span",{className:"footer__link-separator",children:"\xb7"})}function at({item:e}){return e.html?(0,d.jsx)("span",{className:(0,o.A)("footer__link-item",e.className),dangerouslySetInnerHTML:{__html:e.html}}):(0,d.jsx)(et,{item:e})}function it({links:e}){return(0,d.jsx)("div",{className:"footer__links text--center",children:(0,d.jsx)("div",{className:"footer__links",children:e.map((t,n)=>(0,d.jsxs)(r.Fragment,{children:[(0,d.jsx)(at,{item:t}),e.length!==n+1&&(0,d.jsx)(ot,{})]},n))})})}function st({links:e}){return(0,Je.C)(e)?(0,d.jsx)(rt,{columns:e}):(0,d.jsx)(it,{links:e})}var lt=n(15626);const ct="footerLogoLink_BH7S";function ut({logo:e}){const{withBaseUrl:t}=(0,re.useBaseUrlUtils)(),n={light:t(e.src),dark:t(e.srcDark??e.src)};return(0,d.jsx)(lt.default,{className:(0,o.A)("footer__logo",e.className),alt:e.alt,sources:n,width:e.width,height:e.height,style:e.style})}function dt({logo:e}){return e.href?(0,d.jsx)(ne.default,{href:e.href,className:ct,target:e.target,children:(0,d.jsx)(ut,{logo:e})}):(0,d.jsx)(ut,{logo:e})}function pt({copyright:e}){return(0,d.jsx)("div",{className:"footer__copyright",dangerouslySetInnerHTML:{__html:e}})}function ft({style:e,links:t,logo:n,copyright:r}){return(0,d.jsx)("footer",{className:(0,o.A)(l.G.layout.footer.container,"footer",{"footer--dark":"dark"===e}),children:(0,d.jsxs)("div",{className:"container container-fluid",children:[t,(n||r)&&(0,d.jsxs)("div",{className:"footer__bottom text--center",children:[n&&(0,d.jsx)("div",{className:"margin-bottom--sm",children:n}),r]})]})})}function mt(){const{footer:e}=(0,f.p)();if(!e)return null;const{copyright:t,links:n,logo:r,style:o}=e;return(0,d.jsx)(ft,{style:o,links:n&&n.length>0&&(0,d.jsx)(st,{links:n}),logo:r&&(0,d.jsx)(dt,{logo:r}),copyright:t&&(0,d.jsx)(pt,{copyright:t})})}const ht=r.memo(mt);var gt=n(89532),bt=n(23104);const vt=(0,gt.fM)([O.a,m.o,bt.Tv,je.VQ,i.Jx,Ve.G]);function yt({children:e}){return(0,d.jsx)(vt,{children:e})}var wt=n(51107);function kt({error:e,tryAgain:t}){return(0,d.jsx)("main",{className:"container margin-vert--xl",children:(0,d.jsx)("div",{className:"row",children:(0,d.jsxs)("div",{className:"col col--6 col--offset-3",children:[(0,d.jsx)(wt.default,{as:"h1",className:"hero__title",children:(0,d.jsx)(h.default,{id:"theme.ErrorPageContent.title",description:"The title of the fallback page when the page crashed",children:"This page crashed."})}),(0,d.jsx)("div",{className:"margin-vert--lg",children:(0,d.jsx)(Ge.a2,{onClick:t,className:"button button--primary shadow--lw"})}),(0,d.jsx)("hr",{}),(0,d.jsx)("div",{className:"margin-vert--md",children:(0,d.jsx)(Ge.bq,{error:e})})]})})})}const xt="mainWrapper_z2l0";function St(e){const{children:t,noFooter:n,wrapperClassName:r,title:u,description:f}=e;return(0,c.J)(),(0,d.jsxs)(yt,{children:[(0,d.jsx)(i.be,{title:u,description:f}),(0,d.jsx)(p,{}),(0,d.jsx)(A,{}),(0,d.jsx)(Xe,{}),(0,d.jsx)("div",{id:s.j,className:(0,o.A)(l.G.layout.main.container,l.G.wrapper.main,xt,r),children:(0,d.jsx)(a.A,{fallback:e=>(0,d.jsx)(kt,{...e}),children:t})}),!n&&(0,d.jsx)(ht,{})]})}},23465(e,t,n){"use strict";n.d(t,{A:()=>u});n(96540);var r=n(28774),o=n(86025),a=n(44586),i=n(6342),s=n(15626),l=n(74848);function c({logo:e,alt:t,imageClassName:n}){const r={light:(0,o.default)(e.src),dark:(0,o.default)(e.srcDark||e.src)},a=(0,l.jsx)(s.default,{className:e.className,sources:r,height:e.height,width:e.width,alt:t,style:e.style});return n?(0,l.jsx)("div",{className:n,children:a}):a}function u(e){const{siteConfig:{title:t}}=(0,a.default)(),{navbar:{title:n,logo:s}}=(0,i.p)(),{imageClassName:u,titleClassName:d,...p}=e,f=(0,o.default)(s?.href||"/"),m=n?"":t,h=s?.alt??m;return(0,l.jsxs)(r.default,{to:f,...p,...s?.target&&{target:s.target},children:[s&&(0,l.jsx)(c,{logo:s,alt:h,imageClassName:u}),null!=n&&(0,l.jsx)("b",{className:d,children:n})]})}},41463(e,t,n){"use strict";n.d(t,{A:()=>a});n(96540);var r=n(5260),o=n(74848);function a({locale:e,version:t,tag:n}){const a=e;return(0,o.jsxs)(r.A,{children:[e&&(0,o.jsx)("meta",{name:"docusaurus_locale",content:e}),t&&(0,o.jsx)("meta",{name:"docusaurus_version",content:t}),n&&(0,o.jsx)("meta",{name:"docusaurus_tag",content:n}),a&&(0,o.jsx)("meta",{name:"docsearch:language",content:a}),t&&(0,o.jsx)("meta",{name:"docsearch:version",content:t}),n&&(0,o.jsx)("meta",{name:"docsearch:docusaurus_tag",content:n})]})}},15626(e,t,n){"use strict";n.r(t),n.d(t,{default:()=>a});n(96540);var r=n(9967),o=n(74848);function a(e){const{sources:t,className:n,alt:a,...i}=e;return(0,o.jsx)(r.A,{className:n,children:({theme:e,className:n})=>(0,o.jsx)("img",{src:t[e],alt:a,className:n,...i})})}},41422(e,t,n){"use strict";n.d(t,{N:()=>m,u:()=>s});var r=n(96540),o=n(205),a=n(53109),i=n(74848);function s({initialState:e}){const[t,n]=(0,r.useState)(e??!1),o=(0,r.useCallback)(()=>{n(e=>!e)},[]);return{collapsed:t,setCollapsed:n,toggleCollapsed:o}}const l={display:"none",overflow:"hidden",height:"0px"},c={display:"block",overflow:"visible",height:"auto"};function u(e,t){const n=t?l:c;e.style.display=n.display,e.style.overflow=n.overflow,e.style.height=n.height}function d({collapsibleRef:e,collapsed:t,animation:n}){const o=(0,r.useRef)(!1);(0,r.useEffect)(()=>{const r=e.current;function i(){const e=r.scrollHeight,t=n?.duration??function(e){if((0,a.O)())return 1;const t=e/36;return Math.round(10*(4+15*t**.25+t/5))}(e);return{transition:`height ${t}ms ${n?.easing??"ease-in-out"}`,height:`${e}px`}}function s(){const e=i();r.style.transition=e.transition,r.style.height=e.height}if(!o.current)return u(r,t),void(o.current=!0);return r.style.willChange="height",function(){const e=requestAnimationFrame(()=>{t?(s(),requestAnimationFrame(()=>{r.style.height=l.height,r.style.overflow=l.overflow})):(r.style.display="block",requestAnimationFrame(()=>{s()}))});return()=>cancelAnimationFrame(e)}()},[e,t,n])}function p({as:e="div",collapsed:t,children:n,animation:o,onCollapseTransitionEnd:a,className:s}){const l=(0,r.useRef)(null);return d({collapsibleRef:l,collapsed:t,animation:o}),(0,i.jsx)(e,{ref:l,onTransitionEnd:e=>{"height"===e.propertyName&&(u(l.current,t),a?.(t))},className:s,children:n})}function f({collapsed:e,...t}){const[n,a]=(0,r.useState)(!e),[s,l]=(0,r.useState)(e);return(0,o.A)(()=>{e||a(!0)},[e]),(0,o.A)(()=>{n&&l(e)},[n,e]),n?(0,i.jsx)(p,{...t,collapsed:s}):null}function m({lazy:e,...t}){const n=e?f:p;return(0,i.jsx)(n,{...t})}},9967(e,t,n){"use strict";n.d(t,{A:()=>c});var r=n(96540),o=n(15066),a=n(92303),i=n(95293);const s={themedComponent:"themedComponent_mlkZ","themedComponent--light":"themedComponent--light_NVdE","themedComponent--dark":"themedComponent--dark_xIcU"};var l=n(74848);function c({className:e,children:t}){const n=(0,a.default)(),{colorMode:c}=(0,i.G)();return(0,l.jsx)(l.Fragment,{children:(n?"dark"===c?["dark"]:["light"]:["light","dark"]).map(n=>{const a=t({theme:n,className:(0,o.A)(e,s.themedComponent,s[`themedComponent--${n}`])});return(0,l.jsx)(r.Fragment,{children:a},n)})})}},65041(e,t,n){"use strict";n.d(t,{M:()=>h,o:()=>m});var r=n(96540),o=n(92303),a=n(70679),i=n(89532),s=n(6342),l=n(74848);const c=(0,a.Wf)("docusaurus.announcement.dismiss"),u=(0,a.Wf)("docusaurus.announcement.id"),d=()=>"true"===c.get(),p=e=>c.set(String(e)),f=r.createContext(null);function m({children:e}){const t=function(){const{announcementBar:e}=(0,s.p)(),t=(0,o.default)(),[n,a]=(0,r.useState)(()=>!!t&&d());(0,r.useEffect)(()=>{a(d())},[]);const i=(0,r.useCallback)(()=>{p(!0),a(!0)},[]);return(0,r.useEffect)(()=>{if(!e)return;const{id:t}=e;let n=u.get();"annoucement-bar"===n&&(n="announcement-bar");const r=t!==n;u.set(t),r&&p(!1),!r&&d()||a(!1)},[e]),(0,r.useMemo)(()=>({isActive:!!e&&!n,close:i}),[e,n,i])}();return(0,l.jsx)(f.Provider,{value:t,children:e})}function h(){const e=(0,r.useContext)(f);if(!e)throw new i.dV("AnnouncementBarProvider");return e}},95293(e,t,n){"use strict";n.d(t,{G:()=>x,a:()=>k});var r=n(96540),o=n(92303),a=n(89532),i=n(70679),s=n(6342),l=n(74848);function c(){return window.matchMedia("(prefers-color-scheme: dark)").matches?"dark":"light"}function u(e){return function(e,t){const n=window.matchMedia(e);return n.addEventListener("change",t),()=>n.removeEventListener("change",t)}("(prefers-color-scheme: dark)",()=>e(c()))}const d=r.createContext(void 0),p=(0,i.Wf)("theme"),f="system",m=e=>"dark"===e?"dark":"light",h=e=>null===e||e===f?null:m(e),g=()=>m(document.documentElement.getAttribute("data-theme")),b=e=>{document.documentElement.setAttribute("data-theme",m(e))},v=()=>h(document.documentElement.getAttribute("data-theme-choice")),y=e=>{document.documentElement.setAttribute("data-theme-choice",h(e)??f)};function w(){const{colorMode:{defaultMode:e,disableSwitch:t,respectPrefersColorScheme:n}}=(0,s.p)(),{colorMode:a,setColorModeState:i,colorModeChoice:l,setColorModeChoiceState:d}=function(){const{colorMode:{defaultMode:e}}=(0,s.p)(),t=(0,o.default)(),[n,a]=(0,r.useState)(t?g():e),[i,l]=(0,r.useState)(t?v():null);return(0,r.useEffect)(()=>{a(g()),l(v())},[]),{colorMode:n,setColorModeState:a,colorModeChoice:i,setColorModeChoiceState:l}}();(0,r.useEffect)(()=>{t&&p.del()},[t]);const f=(0,r.useCallback)((t,r={})=>{const{persist:o=!0}=r;if(null===t){const t=n?c():e;b(t),i(t),y(null),d(null)}else b(t),y(t),i(t),d(t);var a;o&&(null===(a=t)?p.del():p.set(m(a)))},[i,d,n,e]);return(0,r.useEffect)(()=>p.listen(e=>{f(h(e.newValue))}),[f]),(0,r.useEffect)(()=>{if(null===l&&n)return u(e=>{i(e),b(e)})},[n,l,i]),(0,r.useMemo)(()=>({colorMode:a,colorModeChoice:l,setColorMode:f,get isDarkTheme(){return"dark"===a},setLightTheme(){f("light")},setDarkTheme(){f("dark")}}),[a,l,f])}function k({children:e}){const t=w();return(0,l.jsx)(d.Provider,{value:t,children:e})}function x(){const e=(0,r.useContext)(d);if(null==e)throw new a.dV("ColorModeProvider","Please see https://docusaurus.io/docs/api/themes/configuration#use-color-mode.");return e}},22069(e,t,n){"use strict";n.d(t,{M:()=>m,e:()=>f});var r=n(96540),o=n(75600),a=n(24581),i=n(57485),s=n(6342),l=n(89532),c=n(74848);const u=r.createContext(void 0);function d(){const e=function(){const e=(0,o.YL)(),{items:t}=(0,s.p)().navbar;return 0===t.length&&!e.component}(),t=(0,a.l)(),n=!e&&"mobile"===t,[i,l]=(0,r.useState)(!1),c=(0,r.useCallback)(()=>{l(e=>!e)},[]);return(0,r.useEffect)(()=>{"desktop"===t&&l(!1)},[t]),(0,r.useMemo)(()=>({disabled:e,shouldRender:n,toggle:c,shown:i}),[e,n,c,i])}function p({handler:e}){return(0,i.$Z)(e),null}function f({children:e}){const t=d();return(0,c.jsxs)(c.Fragment,{children:[t.shown&&(0,c.jsx)(p,{handler:()=>(t.toggle(),!1)}),(0,c.jsx)(u.Provider,{value:t,children:e})]})}function m(){const e=r.useContext(u);if(void 0===e)throw new l.dV("NavbarMobileSidebarProvider");return e}},75600(e,t,n){"use strict";n.d(t,{GX:()=>c,YL:()=>l,y_:()=>s});var r=n(96540),o=n(89532),a=n(74848);const i=r.createContext(null);function s({children:e}){const t=(0,r.useState)({component:null,props:null});return(0,a.jsx)(i.Provider,{value:t,children:e})}function l(){const e=(0,r.useContext)(i);if(!e)throw new o.dV("NavbarSecondaryMenuContentProvider");return e[0]}function c({component:e,props:t}){const n=(0,r.useContext)(i);if(!n)throw new o.dV("NavbarSecondaryMenuContentProvider");const[,a]=n,s=(0,o.Be)(t);return(0,r.useEffect)(()=>{a({component:e,props:s})},[a,e,s]),(0,r.useEffect)(()=>()=>a({component:null,props:null}),[a]),null}},98695(e,t,n){"use strict";n.d(t,{N:()=>c,T:()=>d});var r=n(96540),o=n(89532),a=n(22069),i=n(75600),s=n(74848);const l=r.createContext(null);function c({children:e}){const t=function(){const e=(0,a.M)(),t=(0,i.YL)(),[n,s]=(0,r.useState)(!1),l=null!==t.component,c=(0,o.ZC)(l);return(0,r.useEffect)(()=>{l&&!c&&s(!0)},[l,c]),(0,r.useEffect)(()=>{l?e.shown||s(!0):s(!1)},[e.shown,l]),(0,r.useMemo)(()=>[n,s],[n])}();return(0,s.jsx)(l.Provider,{value:t,children:e})}function u(e){if(e.component){const t=e.component;return(0,s.jsx)(t,{...e.props})}}function d(){const e=(0,r.useContext)(l);if(!e)throw new o.dV("NavbarSecondaryMenuDisplayProvider");const[t,n]=e,a=(0,r.useCallback)(()=>n(!1),[n]),s=(0,i.YL)();return(0,r.useMemo)(()=>({shown:t,hide:a,content:u(s)}),[a,s,t])}},61182(e,t,n){"use strict";n.d(t,{S:()=>i});var r=n(96540),o=n(75062),a=n(23104);function i(e){const[t,n]=(0,r.useState)(e),i=(0,r.useRef)(!1),s=(0,r.useRef)(0),l=(0,r.useCallback)(e=>{null!==e&&(s.current=e.getBoundingClientRect().height)},[]);return(0,a.Mq)(({scrollY:t},r)=>{if(!e)return;if(t=o?n(!1):t+l{if(!e)return;const r=t.location.hash;if(r?document.getElementById(r.substring(1)):void 0)return i.current=!0,void n(!1);n(!0)}),{navbarRef:l,isNavbarVisible:t}}},14090(e,t,n){"use strict";n.d(t,{w:()=>o,J:()=>a});var r=n(96540);const o="navigation-with-keyboard";function a(){(0,r.useEffect)(()=>{function e(e){"keydown"===e.type&&"Tab"===e.key&&document.body.classList.add(o),"mousedown"===e.type&&document.body.classList.remove(o)}return document.addEventListener("keydown",e),document.addEventListener("mousedown",e),()=>{document.body.classList.remove(o),document.removeEventListener("keydown",e),document.removeEventListener("mousedown",e)}},[])}},43458(e,t,n){"use strict";n.d(t,{_:()=>o});var r=n(96540);function o(e=!0){(0,r.useEffect)(()=>(document.body.style.overflow=e?"hidden":"visible",()=>{document.body.style.overflow="visible"}),[e])}},24581(e,t,n){"use strict";n.d(t,{l:()=>s});var r=n(96540),o=n(38193);const a="desktop",i="mobile";function s({desktopBreakpoint:e=996}={}){const[t,n]=(0,r.useState)(()=>"ssr");return(0,r.useEffect)(()=>{function t(){n(function(e){if(!o.default.canUseDOM)throw new Error("getWindowSize() should only be called after React hydration");return window.innerWidth>e?a:i}(e))}return t(),window.addEventListener("resize",t),()=>{window.removeEventListener("resize",t)}},[e]),t}},17559(e,t,n){"use strict";n.d(t,{G:()=>r});const r={page:{blogListPage:"blog-list-page",blogPostPage:"blog-post-page",blogTagsListPage:"blog-tags-list-page",blogTagPostListPage:"blog-tags-post-list-page",blogAuthorsListPage:"blog-authors-list-page",blogAuthorsPostsPage:"blog-authors-posts-page",docsDocPage:"docs-doc-page",docsTagsListPage:"docs-tags-list-page",docsTagDocListPage:"docs-tags-doc-list-page",mdxPage:"mdx-page"},wrapper:{main:"main-wrapper",blogPages:"blog-wrapper",docsPages:"docs-wrapper",mdxPages:"mdx-wrapper"},common:{editThisPage:"theme-edit-this-page",lastUpdated:"theme-last-updated",backToTopButton:"theme-back-to-top-button",codeBlock:"theme-code-block",admonition:"theme-admonition",unlistedBanner:"theme-unlisted-banner",draftBanner:"theme-draft-banner",admonitionType:e=>`theme-admonition-${e}`},announcementBar:{container:"theme-announcement-bar"},tabs:{container:"theme-tabs-container"},layout:{navbar:{container:"theme-layout-navbar",containerLeft:"theme-layout-navbar-left",containerRight:"theme-layout-navbar-right",mobileSidebar:{container:"theme-layout-navbar-sidebar",panel:"theme-layout-navbar-sidebar-panel"}},main:{container:"theme-layout-main"},footer:{container:"theme-layout-footer",column:"theme-layout-footer-column"}},docs:{docVersionBanner:"theme-doc-version-banner",docVersionBadge:"theme-doc-version-badge",docBreadcrumbs:"theme-doc-breadcrumbs",docMarkdown:"theme-doc-markdown",docTocMobile:"theme-doc-toc-mobile",docTocDesktop:"theme-doc-toc-desktop",docFooter:"theme-doc-footer",docFooterTagsRow:"theme-doc-footer-tags-row",docFooterEditMetaRow:"theme-doc-footer-edit-meta-row",docSidebarContainer:"theme-doc-sidebar-container",docSidebarMenu:"theme-doc-sidebar-menu",docSidebarItemCategory:"theme-doc-sidebar-item-category",docSidebarItemLink:"theme-doc-sidebar-item-link",docSidebarItemCategoryLevel:e=>`theme-doc-sidebar-item-category-level-${e}`,docSidebarItemLinkLevel:e=>`theme-doc-sidebar-item-link-level-${e}`},blog:{blogFooterTagsRow:"theme-blog-footer-tags-row",blogFooterEditMetaRow:"theme-blog-footer-edit-meta-row"},pages:{pageFooterEditMetaRow:"theme-pages-footer-edit-meta-row"}}},53109(e,t,n){"use strict";function r(){return window.matchMedia("(prefers-reduced-motion: reduce)").matches}n.d(t,{O:()=>r})},73535(e,t,n){"use strict";n.d(t,{v:()=>i});var r=n(6342);const o="anchorTargetStickyNavbar_Vzrq",a="anchorTargetHideOnScrollNavbar_vjPI";function i(e){const{navbar:{hideOnScroll:t}}=(0,r.p)();if(void 0!==e)return t?a:o}},12181(e,t,n){"use strict";n.d(t,{bq:()=>d,MN:()=>u,a2:()=>c,k2:()=>p});var r=n(96540),o=n(21312),a=n(70440);const i="errorBoundaryError_a6uf",s="errorBoundaryFallback_VBag";var l=n(74848);function c(e){return(0,l.jsx)("button",{type:"button",...e,children:(0,l.jsx)(o.default,{id:"theme.ErrorPageContent.tryAgain",description:"The label of the button to try again rendering when the React error boundary captures an error",children:"Try again"})})}function u({error:e,tryAgain:t}){return(0,l.jsxs)("div",{className:s,children:[(0,l.jsx)("p",{children:e.message}),(0,l.jsx)(c,{onClick:t})]})}function d({error:e}){const t=(0,a.rA)(e).map(e=>e.message).join("\n\nCause:\n");return(0,l.jsx)("p",{className:i,children:t})}class p extends r.Component{componentDidCatch(e,t){throw this.props.onError(e,t)}render(){return this.props.children}}},53106(e,t,n){"use strict";function r(e){return"title"in e[0]}n.d(t,{C:()=>r})},57485(e,t,n){"use strict";n.d(t,{$Z:()=>i,Hl:()=>s,TJ:()=>p,W9:()=>d,aZ:()=>l,fV:()=>u,jy:()=>f,l:()=>c});var r=n(96540),o=n(56347),a=n(89532);function i(e){!function(e){const t=(0,o.W6)(),n=(0,a._q)(e);(0,r.useEffect)(()=>t.block((e,t)=>n(e,t)),[t,n])}((t,n)=>{if("POP"===n)return e(t,n)})}function s(e){const t=(0,o.W6)();return(0,r.useSyncExternalStore)(t.listen,()=>e(t),()=>e({...t,location:{...t.location,search:"",hash:"",state:void 0}}))}function l(e){return s(t=>null===e?null:new URLSearchParams(t.location.search).get(e))}function c(e){const t=l(e)??"",n=function(e){const t=(0,o.W6)();return(0,r.useCallback)((n,r)=>{const o=new URLSearchParams(t.location.search);n?o.set(e,n):o.delete(e),(r?.push?t.push:t.replace)({search:o.toString()})},[e,t])}(e);return[t,n]}function u(e){const t=function(e){const t=s(t=>{const n=new URLSearchParams(t.location.search).getAll(e);return JSON.stringify(n)});return(0,r.useMemo)(()=>JSON.parse(t),[t])}(e),n=function(e){const t=(0,o.W6)();return(0,r.useCallback)((n,r)=>{const o=new URLSearchParams(t.location.search),a=Array.isArray(n)?n:n(o.getAll(e));o.delete(e),a.forEach(t=>o.append(e,t)),(r?.push?t.push:t.replace)({search:o.toString()})},[t,e])}(e);return[t,n]}function d(){const e=(0,o.W6)();return(0,r.useCallback)(()=>{e.replace({search:void 0})},[e])}function p(e,t){const n=new URLSearchParams;for(const r of e)for(const[e,o]of r.entries())"append"===t?n.append(e,o):n.set(e,o);return n}function f(e,t){const n=p(e.map(e=>new URLSearchParams(e??"")),t).toString();return n?`?${n}`:n}},31682(e,t,n){"use strict";function r(e,t=(e,t)=>e===t){return e.filter((n,r)=>e.findIndex(e=>t(e,n))!==r)}function o(e){return Array.from(new Set(e))}function a(e,t){const n={};let r=0;for(const o of e){const e=t(o,r);n[e]??=[],n[e].push(o),r+=1}return n}n.d(t,{$z:()=>a,XI:()=>r,sb:()=>o})},45500(e,t,n){"use strict";n.d(t,{Jx:()=>b,be:()=>m,e3:()=>g});var r=n(96540),o=n(15066),a=n(5260),i=n(36803),s=n(86025),l=n(14563),c=n(74848);function u({title:e}){const t=(0,l.s$)().format(e);return(0,c.jsxs)(a.A,{children:[(0,c.jsx)("title",{children:t}),(0,c.jsx)("meta",{property:"og:title",content:t})]})}function d({description:e}){return(0,c.jsxs)(a.A,{children:[(0,c.jsx)("meta",{name:"description",content:e}),(0,c.jsx)("meta",{property:"og:description",content:e})]})}function p({image:e}){const{withBaseUrl:t}=(0,s.useBaseUrlUtils)(),n=t(e,{absolute:!0});return(0,c.jsxs)(a.A,{children:[(0,c.jsx)("meta",{property:"og:image",content:n}),(0,c.jsx)("meta",{name:"twitter:image",content:n})]})}function f({keywords:e}){return(0,c.jsx)(a.A,{children:(0,c.jsx)("meta",{name:"keywords",content:Array.isArray(e)?e.join(","):e})})}function m({title:e,description:t,keywords:n,image:r,children:o}){return(0,c.jsxs)(c.Fragment,{children:[e&&(0,c.jsx)(u,{title:e}),t&&(0,c.jsx)(d,{description:t}),n&&(0,c.jsx)(f,{keywords:n}),r&&(0,c.jsx)(p,{image:r}),o&&(0,c.jsx)(a.A,{children:o})]})}const h=r.createContext(void 0);function g({className:e,children:t}){const n=r.useContext(h),i=(0,o.A)(n,e);return(0,c.jsxs)(h.Provider,{value:i,children:[(0,c.jsx)(a.A,{children:(0,c.jsx)("html",{className:i})}),t]})}function b({children:e}){const t=(0,i.A)(),n=`plugin-${t.plugin.name.replace(/docusaurus-(?:plugin|theme)-(?:content-)?/gi,"")}`;const r=`plugin-id-${t.plugin.id}`;return(0,c.jsx)(g,{className:(0,o.A)(n,r),children:e})}},76305(e,t,n){"use strict";n.d(t,{D:()=>s,G:()=>l});n(96540);var r=n(22069),o=n(75600),a=n(98695),i=n(74848);function s(e){function t(e){return"left"===(e.position??"right")}return[e.filter(t),e.filter(e=>!t(e))]}function l({children:e}){return(0,i.jsx)(o.y_,{children:(0,i.jsx)(r.e,{children:(0,i.jsx)(a.N,{children:e})})})}},89532(e,t,n){"use strict";n.d(t,{Be:()=>c,ZC:()=>s,_q:()=>i,dV:()=>l,fM:()=>u});var r=n(96540),o=n(205),a=n(74848);function i(e){const t=(0,r.useRef)(e);return(0,o.A)(()=>{t.current=e},[e]),(0,r.useCallback)((...e)=>t.current(...e),[])}function s(e){const t=(0,r.useRef)();return(0,o.A)(()=>{t.current=e}),t.current}class l extends Error{constructor(e,t){super(),this.name="ReactContextError",this.message=`Hook ${this.stack?.split("\n")[1]?.match(/at (?:\w+\.)?(?\w+)/)?.groups.name??""} is called outside the <${e}>. ${t??""}`}}function c(e){const t=Object.entries(e);return t.sort((e,t)=>e[0].localeCompare(t[0])),(0,r.useMemo)(()=>e,t.flat())}function u(e){return({children:t})=>(0,a.jsx)(a.Fragment,{children:e.reduceRight((e,t)=>(0,a.jsx)(t,{children:e}),t)})}},91252(e,t,n){"use strict";function r(e,t){return void 0!==e&&void 0!==t&&new RegExp(e,"gi").test(t)}n.d(t,{G:()=>r})},99169(e,t,n){"use strict";n.d(t,{Dt:()=>s,ys:()=>i});var r=n(96540),o=n(35947),a=n(44586);function i(e,t){const n=e=>(!e||e.endsWith("/")?e:`${e}/`)?.toLowerCase();return n(e)===n(t)}function s(){const{baseUrl:e}=(0,a.default)().siteConfig;return(0,r.useMemo)(()=>function({baseUrl:e,routes:t}){function n(t){return t.path===e&&!0===t.exact}function r(t){return t.path===e&&!t.exact}return function e(t){if(0===t.length)return;return t.find(n)||e(t.filter(r).flatMap(e=>e.routes??[]))}(t)}({routes:o.A,baseUrl:e}),[e])}},23104(e,t,n){"use strict";n.d(t,{Mq:()=>f,Tv:()=>u,a_:()=>m,gk:()=>h,n1:()=>d});var r=n(96540),o=n(38193),a=n(92303),i=n(205),s=n(89532),l=n(74848);const c=r.createContext(void 0);function u({children:e}){const t=function(){const e=(0,r.useRef)(!0);return(0,r.useMemo)(()=>({scrollEventsEnabledRef:e,enableScrollEvents:()=>{e.current=!0},disableScrollEvents:()=>{e.current=!1}}),[])}();return(0,l.jsx)(c.Provider,{value:t,children:e})}function d(){const e=(0,r.useContext)(c);if(null==e)throw new s.dV("ScrollControllerProvider");return e}const p=()=>o.default.canUseDOM?{scrollX:window.pageXOffset,scrollY:window.pageYOffset}:null;function f(e,t=[]){const{scrollEventsEnabledRef:n}=d(),o=(0,r.useRef)(p()),a=(0,s._q)(e);(0,r.useEffect)(()=>{const e=()=>{if(!n.current)return;const e=p();a(e,o.current),o.current=e},t={passive:!0};return e(),window.addEventListener("scroll",e,t),()=>window.removeEventListener("scroll",e,t)},[a,n,...t])}function m(){const e=d(),t=function(){const e=(0,r.useRef)({elem:null,top:0}),t=(0,r.useCallback)(t=>{e.current={elem:t,top:t.getBoundingClientRect().top}},[]),n=(0,r.useCallback)(()=>{const{current:{elem:t,top:n}}=e;if(!t)return{restored:!1};const r=t.getBoundingClientRect().top-n;return r&&window.scrollBy({left:0,top:r}),e.current={elem:null,top:0},{restored:0!==r}},[]);return(0,r.useMemo)(()=>({save:t,restore:n}),[n,t])}(),n=(0,r.useRef)(void 0),o=(0,r.useCallback)(r=>{t.save(r),e.disableScrollEvents(),n.current=()=>{const{restored:r}=t.restore();if(n.current=void 0,r){const t=()=>{e.enableScrollEvents(),window.removeEventListener("scroll",t)};window.addEventListener("scroll",t)}else e.enableScrollEvents()}},[e,t]);return(0,i.A)(()=>{queueMicrotask(()=>n.current?.())}),{blockElementScrollPositionUntilNextRender:o}}function h(){const e=(0,r.useRef)(null),t=(0,a.default)()&&"smooth"===getComputedStyle(document.documentElement).scrollBehavior;return{startScroll:n=>{e.current=t?function(e){return window.scrollTo({top:e,behavior:"smooth"}),()=>{}}(n):function(e){let t=null;const n=document.documentElement.scrollTop>e;return function r(){const o=document.documentElement.scrollTop;(n&&o>e||!n&&ot&&cancelAnimationFrame(t)}(n)},cancelScroll:()=>e.current?.()}}},2967(e,t,n){"use strict";n.d(t,{C:()=>r});const r="default"},75236(e,t,n){"use strict";n.d(t,{K:()=>p,j:()=>l});var r=n(96540),o=n(56347),a=n(21312),i=n(75062),s=n(74848);const l="__docusaurus_skipToContent_fallback";function c(e){e.setAttribute("tabindex","-1"),e.focus(),e.removeAttribute("tabindex")}function u(){const e=(0,r.useRef)(null),{action:t}=(0,o.W6)(),n=(0,r.useCallback)(e=>{e.preventDefault();const t=document.querySelector("main:first-of-type")??document.getElementById(l);t&&c(t)},[]);return(0,i.$)(({location:n})=>{e.current&&!n.hash&&"PUSH"===t&&c(e.current)}),{containerRef:e,onClick:n}}const d=(0,a.translate)({id:"theme.common.skipToMainContent",description:"The skip to content label used for accessibility, allowing to rapidly navigate to main content with keyboard tab/enter navigation",message:"Skip to main content"});function p(e){const t=e.children??d,{containerRef:n,onClick:r}=u();return(0,s.jsx)("div",{ref:n,role:"region","aria-label":d,children:(0,s.jsx)("a",{...e,href:`#${l}`,onClick:r,children:t})})}},70679(e,t,n){"use strict";n.d(t,{Wf:()=>u,Eo:()=>p,Dv:()=>d});var r=n(96540);const o=JSON.parse('{"N":"localStorage","M":""}'),a=o.N;function i({key:e,oldValue:t,newValue:n,storage:r}){if(t===n)return;const o=document.createEvent("StorageEvent");o.initStorageEvent("storage",!1,!1,e,t,n,window.location.href,r),window.dispatchEvent(o)}function s(e=a){if("undefined"==typeof window)throw new Error("Browser storage is not available on Node.js/Docusaurus SSR process.");if("none"===e)return null;try{return window[e]}catch(n){return t=n,l||(console.warn("Docusaurus browser storage is not available.\nPossible reasons: running Docusaurus in an iframe, in an incognito browser session, or using too strict browser privacy settings.",t),l=!0),null}var t}let l=!1;const c={get:()=>null,set:()=>{},del:()=>{},listen:()=>()=>{}};function u(e,t){const n=`${e}${o.M}`;if("undefined"==typeof window)return function(e){function t(){throw new Error(`Illegal storage API usage for storage key "${e}".\nDocusaurus storage APIs are not supposed to be called on the server-rendering process.\nPlease only call storage APIs in effects and event handlers.`)}return{get:t,set:t,del:t,listen:t}}(n);const r=s(t?.persistence);return null===r?c:{get:()=>{try{return r.getItem(n)}catch(e){return console.error(`Docusaurus storage error, can't get key=${n}`,e),null}},set:e=>{try{const t=r.getItem(n);r.setItem(n,e),i({key:n,oldValue:t,newValue:e,storage:r})}catch(t){console.error(`Docusaurus storage error, can't set ${n}=${e}`,t)}},del:()=>{try{const e=r.getItem(n);r.removeItem(n),i({key:n,oldValue:e,newValue:null,storage:r})}catch(e){console.error(`Docusaurus storage error, can't delete key=${n}`,e)}},listen:e=>{try{const t=t=>{t.storageArea===r&&t.key===n&&e(t)};return window.addEventListener("storage",t),()=>window.removeEventListener("storage",t)}catch(t){return console.error(`Docusaurus storage error, can't listen for changes of key=${n}`,t),()=>{}}}}}function d(e,t){const[n]=(0,r.useState)(()=>null===e?c:u(e,t)),o=(0,r.useCallback)(e=>"undefined"==typeof window?()=>{}:n.listen(e),[n]);return[(0,r.useSyncExternalStore)(o,()=>n.get(),()=>null),n]}function p(e=a){const t=s(e);if(!t)return[];const n=[];for(let r=0;ru,s$:()=>d});var r=n(96540),o=n(44586),a=n(36803),i=n(89532),s=n(74848);const l=({title:e,siteTitle:t,titleDelimiter:n})=>{const r=e?.trim();return r&&r!==t?`${r} ${n} ${t}`:t},c=(0,r.createContext)(null);function u({formatter:e,children:t}){return(0,s.jsx)(c.Provider,{value:e,children:t})}function d(){const e=function(){const e=(0,r.useContext)(c);if(null===e)throw new i.dV("TitleFormatterProvider");return e}(),{siteConfig:t}=(0,o.default)(),{title:n,titleDelimiter:s}=t,{plugin:u}=(0,a.A)();return{format:t=>e({title:t,siteTitle:n,titleDelimiter:s,plugin:u,defaultFormatter:l})}}},32131(e,t,n){"use strict";n.d(t,{o:()=>i});var r=n(44586),o=n(56347),a=n(70440);function i(){const{siteConfig:{baseUrl:e,trailingSlash:t},i18n:{localeConfigs:n}}=(0,r.default)(),{pathname:i}=(0,o.zy)(),s=(0,a.Ks)(i,{trailingSlash:t,baseUrl:e}).replace(e,"");return{createUrl:function({locale:e,fullyQualified:t}){const r=function(e){const t=n[e];if(!t)throw new Error(`Unexpected Docusaurus bug, no locale config found for locale=${e}`);return t}(e);return`${`${t?r.url:""}`}${r.baseUrl}${s}`}}}},9342(e,t,n){"use strict";n.d(t,{B:()=>a});var r=n(56347),o=n(44586);function a(){const{siteConfig:{baseUrl:e}}=(0,o.default)(),{pathname:t}=(0,r.zy)();return t.replace(e,"/")}},75062(e,t,n){"use strict";n.d(t,{$:()=>i});var r=n(96540),o=n(56347),a=n(89532);function i(e){const t=(0,o.zy)(),n=(0,a.ZC)(t),i=(0,a._q)(e);(0,r.useEffect)(()=>{n&&t!==n&&i({location:t,previousLocation:n})},[i,t,n])}},6342(e,t,n){"use strict";n.d(t,{p:()=>o});var r=n(44586);function o(){return(0,r.default)().siteConfig.themeConfig}},12983(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.addTrailingSlash=o,t.default=function(e,t){const{trailingSlash:n,baseUrl:r}=t;if(e.startsWith("#"))return e;if(void 0===n)return e;const[i]=e.split(/[#?]/),s="/"===i||i===r?i:(l=i,c=n,c?o(l):a(l));var l,c;return e.replace(i,s)},t.addLeadingSlash=function(e){return(0,r.addPrefix)(e,"/")},t.removeTrailingSlash=a;const r=n(42566);function o(e){return e.endsWith("/")?e:`${e}/`}function a(e){return(0,r.removeSuffix)(e,"/")}},80253(e,t){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.getErrorCausalChain=function e(t){if(t.cause)return[t,...e(t.cause)];return[t]}},70440(e,t,n){"use strict";t.rA=t.Ks=t.LU=void 0;const r=n(31635);t.LU="__blog-post-container";var o=n(12983);Object.defineProperty(t,"Ks",{enumerable:!0,get:function(){return r.__importDefault(o).default}});var a=n(42566);var i=n(80253);Object.defineProperty(t,"rA",{enumerable:!0,get:function(){return i.getErrorCausalChain}})},42566(e,t){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.addPrefix=function(e,t){return e.startsWith(t)?e:`${t}${e}`},t.removeSuffix=function(e,t){if(""===t)return e;return e.endsWith(t)?e.slice(0,-t.length):e},t.addSuffix=function(e,t){return e.endsWith(t)?e:`${e}${t}`},t.removePrefix=function(e,t){return e.startsWith(t)?e.slice(t.length):e}},31513(e,t,n){"use strict";n.d(t,{zR:()=>w,TM:()=>_,yJ:()=>f,sC:()=>E,AO:()=>p});var r=n(58168);function o(e){return"/"===e.charAt(0)}function a(e,t){for(var n=t,r=n+1,o=e.length;r=0;p--){var f=i[p];"."===f?a(i,p):".."===f?(a(i,p),d++):d&&(a(i,p),d--)}if(!c)for(;d--;d)i.unshift("..");!c||""===i[0]||i[0]&&o(i[0])||i.unshift("");var m=i.join("/");return n&&"/"!==m.substr(-1)&&(m+="/"),m};var s=n(11561);function l(e){return"/"===e.charAt(0)?e:"/"+e}function c(e){return"/"===e.charAt(0)?e.substr(1):e}function u(e,t){return function(e,t){return 0===e.toLowerCase().indexOf(t.toLowerCase())&&-1!=="/?#".indexOf(e.charAt(t.length))}(e,t)?e.substr(t.length):e}function d(e){return"/"===e.charAt(e.length-1)?e.slice(0,-1):e}function p(e){var t=e.pathname,n=e.search,r=e.hash,o=t||"/";return n&&"?"!==n&&(o+="?"===n.charAt(0)?n:"?"+n),r&&"#"!==r&&(o+="#"===r.charAt(0)?r:"#"+r),o}function f(e,t,n,o){var a;"string"==typeof e?(a=function(e){var t=e||"/",n="",r="",o=t.indexOf("#");-1!==o&&(r=t.substr(o),t=t.substr(0,o));var a=t.indexOf("?");return-1!==a&&(n=t.substr(a),t=t.substr(0,a)),{pathname:t,search:"?"===n?"":n,hash:"#"===r?"":r}}(e),a.state=t):(void 0===(a=(0,r.A)({},e)).pathname&&(a.pathname=""),a.search?"?"!==a.search.charAt(0)&&(a.search="?"+a.search):a.search="",a.hash?"#"!==a.hash.charAt(0)&&(a.hash="#"+a.hash):a.hash="",void 0!==t&&void 0===a.state&&(a.state=t));try{a.pathname=decodeURI(a.pathname)}catch(s){throw s instanceof URIError?new URIError('Pathname "'+a.pathname+'" could not be decoded. This is likely caused by an invalid percent-encoding.'):s}return n&&(a.key=n),o?a.pathname?"/"!==a.pathname.charAt(0)&&(a.pathname=i(a.pathname,o.pathname)):a.pathname=o.pathname:a.pathname||(a.pathname="/"),a}function m(){var e=null;var t=[];return{setPrompt:function(t){return e=t,function(){e===t&&(e=null)}},confirmTransitionTo:function(t,n,r,o){if(null!=e){var a="function"==typeof e?e(t,n):e;"string"==typeof a?"function"==typeof r?r(a,o):o(!0):o(!1!==a)}else o(!0)},appendListener:function(e){var n=!0;function r(){n&&e.apply(void 0,arguments)}return t.push(r),function(){n=!1,t=t.filter(function(e){return e!==r})}},notifyListeners:function(){for(var e=arguments.length,n=new Array(e),r=0;rt?n.splice(t,n.length-t,o):n.push(o),d({action:r,location:o,index:t,entries:n})}})},replace:function(e,t){var r="REPLACE",o=f(e,t,h(),w.location);u.confirmTransitionTo(o,r,n,function(e){e&&(w.entries[w.index]=o,d({action:r,location:o}))})},go:y,goBack:function(){y(-1)},goForward:function(){y(1)},canGo:function(e){var t=w.index+e;return t>=0&&t
'};function o(e,t,n){return en?n:e}function a(e){return 100*(-1+e)}function i(e,t,n){var o;return(o="translate3d"===r.positionUsing?{transform:"translate3d("+a(e)+"%,0,0)"}:"translate"===r.positionUsing?{transform:"translate("+a(e)+"%,0)"}:{"margin-left":a(e)+"%"}).transition="all "+t+"ms "+n,o}n.configure=function(e){var t,n;for(t in e)void 0!==(n=e[t])&&e.hasOwnProperty(t)&&(r[t]=n);return this},n.status=null,n.set=function(e){var t=n.isStarted();e=o(e,r.minimum,1),n.status=1===e?null:e;var a=n.render(!t),c=a.querySelector(r.barSelector),u=r.speed,d=r.easing;return a.offsetWidth,s(function(t){""===r.positionUsing&&(r.positionUsing=n.getPositioningCSS()),l(c,i(e,u,d)),1===e?(l(a,{transition:"none",opacity:1}),a.offsetWidth,setTimeout(function(){l(a,{transition:"all "+u+"ms linear",opacity:0}),setTimeout(function(){n.remove(),t()},u)},u)):setTimeout(t,u)}),this},n.isStarted=function(){return"number"==typeof n.status},n.start=function(){n.status||n.set(0);var e=function(){setTimeout(function(){n.status&&(n.trickle(),e())},r.trickleSpeed)};return r.trickle&&e(),this},n.done=function(e){return e||n.status?n.inc(.3+.5*Math.random()).set(1):this},n.inc=function(e){var t=n.status;return t?("number"!=typeof e&&(e=(1-t)*o(Math.random()*t,.1,.95)),t=o(t+e,0,.994),n.set(t)):n.start()},n.trickle=function(){return n.inc(Math.random()*r.trickleRate)},e=0,t=0,n.promise=function(r){return r&&"resolved"!==r.state()?(0===t&&n.start(),e++,t++,r.always(function(){0===--t?(e=0,n.done()):n.set((e-t)/e)}),this):this},n.render=function(e){if(n.isRendered())return document.getElementById("nprogress");u(document.documentElement,"nprogress-busy");var t=document.createElement("div");t.id="nprogress",t.innerHTML=r.template;var o,i=t.querySelector(r.barSelector),s=e?"-100":a(n.status||0),c=document.querySelector(r.parent);return l(i,{transition:"all 0 linear",transform:"translate3d("+s+"%,0,0)"}),r.showSpinner||(o=t.querySelector(r.spinnerSelector))&&f(o),c!=document.body&&u(c,"nprogress-custom-parent"),c.appendChild(t),t},n.remove=function(){d(document.documentElement,"nprogress-busy"),d(document.querySelector(r.parent),"nprogress-custom-parent");var e=document.getElementById("nprogress");e&&f(e)},n.isRendered=function(){return!!document.getElementById("nprogress")},n.getPositioningCSS=function(){var e=document.body.style,t="WebkitTransform"in e?"Webkit":"MozTransform"in e?"Moz":"msTransform"in e?"ms":"OTransform"in e?"O":"";return t+"Perspective"in e?"translate3d":t+"Transform"in e?"translate":"margin"};var s=function(){var e=[];function t(){var n=e.shift();n&&n(t)}return function(n){e.push(n),1==e.length&&t()}}(),l=function(){var e=["Webkit","O","Moz","ms"],t={};function n(e){return e.replace(/^-ms-/,"ms-").replace(/-([\da-z])/gi,function(e,t){return t.toUpperCase()})}function r(t){var n=document.body.style;if(t in n)return t;for(var r,o=e.length,a=t.charAt(0).toUpperCase()+t.slice(1);o--;)if((r=e[o]+a)in n)return r;return t}function o(e){return e=n(e),t[e]||(t[e]=r(e))}function a(e,t,n){t=o(t),e.style[t]=n}return function(e,t){var n,r,o=arguments;if(2==o.length)for(n in t)void 0!==(r=t[n])&&t.hasOwnProperty(n)&&a(e,n,r);else a(e,o[1],o[2])}}();function c(e,t){return("string"==typeof e?e:p(e)).indexOf(" "+t+" ")>=0}function u(e,t){var n=p(e),r=n+t;c(n,t)||(e.className=r.substring(1))}function d(e,t){var n,r=p(e);c(e,t)&&(n=r.replace(" "+t+" "," "),e.className=n.substring(1,n.length-1))}function p(e){return(" "+(e.className||"")+" ").replace(/\s+/gi," ")}function f(e){e&&e.parentNode&&e.parentNode.removeChild(e)}return n},void 0===(o="function"==typeof r?r.call(t,n,t,e):r)||(e.exports=o)},35302(e,t,n){var r=n(64634);e.exports=h,e.exports.parse=a,e.exports.compile=function(e,t){return c(a(e,t),t)},e.exports.tokensToFunction=c,e.exports.tokensToRegExp=m;var o=new RegExp(["(\\\\.)","([\\/.])?(?:(?:\\:(\\w+)(?:\\(((?:\\\\.|[^\\\\()])+)\\))?|\\(((?:\\\\.|[^\\\\()])+)\\))([+*?])?|(\\*))"].join("|"),"g");function a(e,t){for(var n,r=[],a=0,s=0,l="",c=t&&t.delimiter||"/";null!=(n=o.exec(e));){var u=n[0],p=n[1],f=n.index;if(l+=e.slice(s,f),s=f+u.length,p)l+=p[1];else{var m=e[s],h=n[2],g=n[3],b=n[4],v=n[5],y=n[6],w=n[7];l&&(r.push(l),l="");var k=null!=h&&null!=m&&m!==h,x="+"===y||"*"===y,S="?"===y||"*"===y,P=h||c,A=b||v,_=h||("string"==typeof r[r.length-1]?r[r.length-1]:"");r.push({name:g||a++,prefix:h||"",delimiter:P,optional:S,repeat:x,partial:k,asterisk:!!w,pattern:A?d(A):w?".*":i(P,_)})}}return s-1?"[^"+u(e)+"]+?":u(t)+"|(?:(?!"+u(t)+")[^"+u(e)+"])+?"}function s(e){return encodeURI(e).replace(/[\/?#]/g,function(e){return"%"+e.charCodeAt(0).toString(16).toUpperCase()})}function l(e){return encodeURI(e).replace(/[?#]/g,function(e){return"%"+e.charCodeAt(0).toString(16).toUpperCase()})}function c(e,t){for(var n=new Array(e.length),o=0;o