diff --git a/404.html b/404.html index b6ff86220..7d1f47ced 100644 --- a/404.html +++ b/404.html @@ -5,7 +5,7 @@ Page Not Found | OpenSign™ - + diff --git a/assets/js/0058b4c6.ea176c57.js b/assets/js/0058b4c6.6a6bc5e1.js similarity index 50% rename from assets/js/0058b4c6.ea176c57.js rename to assets/js/0058b4c6.6a6bc5e1.js index 49a03fd7a..dd266ff1d 100644 --- a/assets/js/0058b4c6.ea176c57.js +++ b/assets/js/0058b4c6.6a6bc5e1.js @@ -1 +1 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.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","label":"Intro","href":"/docs/help/intro","docId":"help/intro","unlisted":false},{"type":"category","label":"Create New OpenSign Document","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Sign your-self","href":"/docs/help/New-Document/sign-yourself","docId":"help/New-Document/sign-yourself","unlisted":false},{"type":"link","label":"Request signatures","href":"/docs/help/New-Document/request-signatures","docId":"help/New-Document/request-signatures","unlisted":false},{"type":"link","label":"Navigate between pages of a document","href":"/docs/help/New-Document/navigate-between-pages","docId":"help/New-Document/navigate-between-pages","unlisted":false},{"type":"link","label":"Editing Your Document Before Sending","href":"/docs/help/New-Document/edit-document-before-sending","docId":"help/New-Document/edit-document-before-sending","unlisted":false},{"type":"link","label":"Enforce email OTP verification","href":"/docs/help/New-Document/enforce-email-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","label":"Create Docs & Folders","href":"/docs/help/OpenSign\u2122 Drive/create-document","docId":"help/OpenSign\u2122 Drive/create-document","unlisted":false},{"type":"link","label":"Grid vs List view","href":"/docs/help/OpenSign\u2122 Drive/list-grid-view","docId":"help/OpenSign\u2122 Drive/list-grid-view","unlisted":false},{"type":"link","label":"OpenSign\u2122 Drive Interface Documentation","href":"/docs/help/OpenSign\u2122 Drive/organize-documents","docId":"help/OpenSign\u2122 Drive/organize-documents","unlisted":false},{"type":"link","label":"Rename documents from OpenSign\u2122 Drive","href":"/docs/help/OpenSign\u2122 Drive/rename-document","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","label":"Need your sign","href":"/docs/help/Reports/need-your-sign","docId":"help/Reports/need-your-sign","unlisted":false},{"type":"link","label":"In Progress","href":"/docs/help/Reports/in-progress","docId":"help/Reports/in-progress","unlisted":false},{"type":"link","label":"Completed","href":"/docs/help/Reports/completed","docId":"help/Reports/completed","unlisted":false},{"type":"link","label":"Drafts","href":"/docs/help/Reports/drafts","docId":"help/Reports/drafts","unlisted":false},{"type":"link","label":"Declined","href":"/docs/help/Reports/declined","docId":"help/Reports/declined","unlisted":false},{"type":"link","label":"Expired","href":"/docs/help/Reports/expired","docId":"help/Reports/expired","unlisted":false},{"type":"link","label":"Contactbook","href":"/docs/help/Reports/contactbook","docId":"help/Reports/contactbook","unlisted":false}],"href":"/docs/category/documents"},{"type":"category","label":"Templates","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Create Templates","href":"/docs/help/Templates/create-template","docId":"help/Templates/create-template","unlisted":false},{"type":"link","label":"Manage Templates","href":"/docs/help/Templates/manage-templates","docId":"help/Templates/manage-templates","unlisted":false},{"type":"link","label":"Use template to create documents","href":"/docs/help/Templates/use-template","docId":"help/Templates/use-template","unlisted":false},{"type":"link","label":"Quickly Send the Document for Signature Using Template","href":"/docs/help/Templates/quick-send","docId":"help/Templates/quick-send","unlisted":false},{"type":"link","label":"Setting up an OpenSign template for public signing","href":"/docs/help/Templates/publicTemplate","docId":"help/Templates/publicTemplate","unlisted":false},{"type":"link","label":"Embedding OpenSign templates","href":"/docs/help/Templates/embed-template","docId":"help/Templates/embed-template","unlisted":false}],"href":"/docs/category/templates"},{"type":"category","label":"Settings","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"My Signature","href":"/docs/help/Settings/my-signature","docId":"help/Settings/my-signature","unlisted":false},{"type":"link","label":"API Token","href":"/docs/help/Settings/APIToken","docId":"help/Settings/APIToken","unlisted":false},{"type":"link","label":"Webhook","href":"/docs/help/Settings/Webhook","docId":"help/Settings/Webhook","unlisted":false},{"type":"link","label":"Preferences","href":"/docs/help/Settings/Preferences","docId":"help/Settings/Preferences","unlisted":false},{"type":"link","label":"Manage Teams","href":"/docs/help/Settings/Teams","docId":"help/Settings/Teams","unlisted":false},{"type":"link","label":"Manage users","href":"/docs/help/Settings/manage-users","docId":"help/Settings/manage-users","unlisted":false},{"type":"link","label":"Disable DocumentId","href":"/docs/help/Settings/disabledocumentid","docId":"help/Settings/disabledocumentid","unlisted":false},{"type":"link","label":"Custom email templates","href":"/docs/help/Settings/Custom-email-templates","docId":"help/Settings/Custom-email-templates","unlisted":false},{"type":"link","label":"Security","href":"/docs/help/Settings/SecurityManagement","docId":"help/Settings/SecurityManagement","unlisted":false}],"href":"/docs/category/settings"},{"type":"category","label":"FAQs","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Why is there no dropdown list when I sign a document myself?","href":"/docs/help/FAQs/","docId":"help/FAQs/FAQs","unlisted":false},{"type":"link","label":"Why am I getting \'Ensure this field is accurately filled and meets all requirements\'?","href":"/docs/help/FAQs/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}],"href":"/docs/category/faqs"}],"selfhostSidebar":[{"type":"link","label":"Self-Hosting OpenSign","href":"/docs/self-host/intro","docId":"self-host/intro","unlisted":false},{"type":"category","label":"Docker","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Self-host OpenSign\u2122 with Docker on Linux/MacOS/Windows","href":"/docs/self-host/docker/run-locally","docId":"self-host/docker/run-locally","unlisted":false},{"type":"link","label":"OpenSign\u2122 Self-Hosted \'Upgrade Deployment\' Guide Using Docker on Linux, macOS, or Windows","href":"/docs/self-host/docker/upgrade-deployment","docId":"self-host/docker/upgrade-deployment","unlisted":false}],"href":"/docs/category/docker"},{"type":"category","label":"Cloud Storage","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"AWS S3","href":"/docs/self-host/cloud-storage/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","label":"OpenSign Deployment Guide on Azure VM via command-line","href":"/docs/self-host/guides/azure-vm-setup","docId":"self-host/guides/azure-vm-setup","unlisted":false},{"type":"link","label":"ENV variables which are used to setup OpenSign\u2122 with Docker on Localhost","href":"/docs/self-host/guides/env-variables","docId":"self-host/guides/env-variables","unlisted":false},{"type":"link","label":"How to generate self-signed document signing certificate?","href":"/docs/self-host/guides/how-to-generate-self-signed-document-signing-certificate","docId":"self-host/guides/how-to-generate-self-signed-document-signing-certificate","unlisted":false},{"type":"link","label":"How to upgrade self-hosted OpenSign to v2.1.0?","href":"/docs/self-host/guides/upgrade-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","label":"Digital Ocean","href":"/docs/self-host/One-click-Install/DigitalOcean","docId":"self-host/One-click-Install/DigitalOcean","unlisted":false}]}],"contributeSidebar":[{"type":"link","label":"Code of conduct","href":"/docs/contribute/CODE_OF_CONDUCT","docId":"contribute/CODE_OF_CONDUCT","unlisted":false},{"type":"link","label":"Contributing to OpenSign","href":"/docs/contribute/intro","docId":"contribute/intro","unlisted":false},{"type":"link","label":"Installation instructions","href":"/docs/contribute/INSTALLATION","docId":"contribute/INSTALLATION","unlisted":false},{"type":"link","label":"Community at OpenSign\u2122","href":"/docs/contribute/COMMUNITY","docId":"contribute/COMMUNITY","unlisted":false},{"type":"link","label":"OpenSign\u2122 Reporting Guidelines","href":"/docs/contribute/REPORTING_GUIDELINES","docId":"contribute/REPORTING_GUIDELINES","unlisted":false}],"apiSidebar":[{"type":"category","label":"v1.1","collapsed":false,"items":[{"type":"link","label":"Introduction","href":"/docs/API-docs/v1.1/opensign-api-v-1-1","docId":"API-docs/v1.1/opensign-api-v-1-1","unlisted":false},{"type":"category","label":"User","items":[{"type":"link","label":"Get your account details","href":"/docs/API-docs/v1.1/get-user","className":"api-method get","docId":"API-docs/v1.1/get-user","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Contacts","items":[{"type":"link","label":"Create Contact","href":"/docs/API-docs/v1.1/createcontact","className":"api-method post","docId":"API-docs/v1.1/createcontact","unlisted":false},{"type":"link","label":"Get Contact","href":"/docs/API-docs/v1.1/getcontact","className":"api-method get","docId":"API-docs/v1.1/getcontact","unlisted":false},{"type":"link","label":"Delete Contact","href":"/docs/API-docs/v1.1/deletecontact","className":"api-method delete","docId":"API-docs/v1.1/deletecontact","unlisted":false},{"type":"link","label":"Get Contact list","href":"/docs/API-docs/v1.1/contactlist","className":"api-method get","docId":"API-docs/v1.1/contactlist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Documents","items":[{"type":"link","label":"Self Sign","href":"/docs/API-docs/v1.1/selfsign","className":"api-method post","docId":"API-docs/v1.1/selfsign","unlisted":false},{"type":"link","label":"Draft Document","href":"/docs/API-docs/v1.1/draftdocument","className":"api-method post","docId":"API-docs/v1.1/draftdocument","unlisted":false},{"type":"link","label":"Create Document","href":"/docs/API-docs/v1.1/createdocument","className":"api-method post","docId":"API-docs/v1.1/createdocument","unlisted":false},{"type":"link","label":"Create Document from Template","href":"/docs/API-docs/v1.1/createdocumentwithtemplateid","className":"api-method post","docId":"API-docs/v1.1/createdocumentwithtemplateid","unlisted":false},{"type":"link","label":"Get Document","href":"/docs/API-docs/v1.1/getdocument","className":"api-method get","docId":"API-docs/v1.1/getdocument","unlisted":false},{"type":"link","label":"Update Document","href":"/docs/API-docs/v1.1/update-document","className":"api-method put","docId":"API-docs/v1.1/update-document","unlisted":false},{"type":"link","label":"Revoke Document","href":"/docs/API-docs/v1.1/revokedocument","className":"api-method post","docId":"API-docs/v1.1/revokedocument","unlisted":false},{"type":"link","label":"Delete Document","href":"/docs/API-docs/v1.1/deletedocument","className":"api-method delete","docId":"API-docs/v1.1/deletedocument","unlisted":false},{"type":"link","label":"Get Document list from status","href":"/docs/API-docs/v1.1/getdocumentlist","className":"api-method get","docId":"API-docs/v1.1/getdocumentlist","unlisted":false},{"type":"link","label":"Resend request mail","href":"/docs/API-docs/v1.1/resendrequestmail","className":"api-method post","docId":"API-docs/v1.1/resendrequestmail","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Templates","items":[{"type":"link","label":"Draft Template","href":"/docs/API-docs/v1.1/drafttemplate","className":"api-method post","docId":"API-docs/v1.1/drafttemplate","unlisted":false},{"type":"link","label":"Create Template","href":"/docs/API-docs/v1.1/createtemplate","className":"api-method post","docId":"API-docs/v1.1/createtemplate","unlisted":false},{"type":"link","label":"Public Template","href":"/docs/API-docs/v1.1/publictemplate","className":"api-method post","docId":"API-docs/v1.1/publictemplate","unlisted":false},{"type":"link","label":"Get Template","href":"/docs/API-docs/v1.1/get-template","className":"api-method get","docId":"API-docs/v1.1/get-template","unlisted":false},{"type":"link","label":"Update Template","href":"/docs/API-docs/v1.1/update-template","className":"api-method put","docId":"API-docs/v1.1/update-template","unlisted":false},{"type":"link","label":"Delete Template","href":"/docs/API-docs/v1.1/delete-template","className":"api-method delete","docId":"API-docs/v1.1/delete-template","unlisted":false},{"type":"link","label":"Get Template list","href":"/docs/API-docs/v1.1/gettemplatelist","className":"api-method get","docId":"API-docs/v1.1/gettemplatelist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Webhook","items":[{"type":"link","label":"Get Webhook","href":"/docs/API-docs/v1.1/get-webhook","className":"api-method get","docId":"API-docs/v1.1/get-webhook","unlisted":false},{"type":"link","label":"Save or Update Webhook","href":"/docs/API-docs/v1.1/save-update-webhook","className":"api-method post","docId":"API-docs/v1.1/save-update-webhook","unlisted":false},{"type":"link","label":"Delete Webhook","href":"/docs/API-docs/v1.1/delete-webhook","className":"api-method delete","docId":"API-docs/v1.1/delete-webhook","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Folder","items":[{"type":"link","label":"Create Folder","href":"/docs/API-docs/v1.1/createfolder","className":"api-method post","docId":"API-docs/v1.1/createfolder","unlisted":false},{"type":"link","label":"Get Folder","href":"/docs/API-docs/v1.1/getfolder","className":"api-method get","docId":"API-docs/v1.1/getfolder","unlisted":false},{"type":"link","label":"Update Folder","href":"/docs/API-docs/v1.1/updatefolder","className":"api-method put","docId":"API-docs/v1.1/updatefolder","unlisted":false},{"type":"link","label":"Delete Folder","href":"/docs/API-docs/v1.1/deletefolder","className":"api-method delete","docId":"API-docs/v1.1/deletefolder","unlisted":false},{"type":"link","label":"Get folder list","href":"/docs/API-docs/v1.1/folderlist","className":"api-method get","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","label":"Introduction","href":"/docs/API-docs/v1/opensign-api-v-1","docId":"API-docs/v1/opensign-api-v-1","unlisted":false},{"type":"category","label":"User","items":[{"type":"link","label":"Get your account details","href":"/docs/API-docs/v1/get-user","className":"api-method get","docId":"API-docs/v1/get-user","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Contacts","items":[{"type":"link","label":"Create Contact","href":"/docs/API-docs/v1/createcontact","className":"api-method post","docId":"API-docs/v1/createcontact","unlisted":false},{"type":"link","label":"Get Contact","href":"/docs/API-docs/v1/getcontact","className":"api-method get","docId":"API-docs/v1/getcontact","unlisted":false},{"type":"link","label":"Delete Contact","href":"/docs/API-docs/v1/deletecontact","className":"api-method delete","docId":"API-docs/v1/deletecontact","unlisted":false},{"type":"link","label":"Get Contact list","href":"/docs/API-docs/v1/contactlist","className":"api-method get","docId":"API-docs/v1/contactlist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Documents","items":[{"type":"link","label":"Self Sign","href":"/docs/API-docs/v1/selfsign","className":"api-method post","docId":"API-docs/v1/selfsign","unlisted":false},{"type":"link","label":"Draft Document","href":"/docs/API-docs/v1/draftdocument","className":"api-method post","docId":"API-docs/v1/draftdocument","unlisted":false},{"type":"link","label":"Create Document","href":"/docs/API-docs/v1/createdocument","className":"api-method post","docId":"API-docs/v1/createdocument","unlisted":false},{"type":"link","label":"Create Document from Template","href":"/docs/API-docs/v1/createdocumentwithtemplateid","className":"api-method post","docId":"API-docs/v1/createdocumentwithtemplateid","unlisted":false},{"type":"link","label":"Get Document","href":"/docs/API-docs/v1/getdocument","className":"api-method get","docId":"API-docs/v1/getdocument","unlisted":false},{"type":"link","label":"Update Document","href":"/docs/API-docs/v1/update-document","className":"api-method put","docId":"API-docs/v1/update-document","unlisted":false},{"type":"link","label":"Revoke Document","href":"/docs/API-docs/v1/revokedocument","className":"api-method post","docId":"API-docs/v1/revokedocument","unlisted":false},{"type":"link","label":"Delete Document","href":"/docs/API-docs/v1/deletedocument","className":"api-method delete","docId":"API-docs/v1/deletedocument","unlisted":false},{"type":"link","label":"Get Document list from status","href":"/docs/API-docs/v1/getdocumentlist","className":"api-method get","docId":"API-docs/v1/getdocumentlist","unlisted":false},{"type":"link","label":"Resend request mail","href":"/docs/API-docs/v1/resendrequestmail","className":"api-method post","docId":"API-docs/v1/resendrequestmail","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Templates","items":[{"type":"link","label":"Draft Template","href":"/docs/API-docs/v1/drafttemplate","className":"api-method post","docId":"API-docs/v1/drafttemplate","unlisted":false},{"type":"link","label":"Create Template","href":"/docs/API-docs/v1/createtemplate","className":"api-method post","docId":"API-docs/v1/createtemplate","unlisted":false},{"type":"link","label":"Get Template","href":"/docs/API-docs/v1/get-template","className":"api-method get","docId":"API-docs/v1/get-template","unlisted":false},{"type":"link","label":"Update Template","href":"/docs/API-docs/v1/update-template","className":"api-method put","docId":"API-docs/v1/update-template","unlisted":false},{"type":"link","label":"Delete Template","href":"/docs/API-docs/v1/delete-template","className":"api-method delete","docId":"API-docs/v1/delete-template","unlisted":false},{"type":"link","label":"Get Template list","href":"/docs/API-docs/v1/gettemplatelist","className":"api-method get","docId":"API-docs/v1/gettemplatelist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Webhook","items":[{"type":"link","label":"Get Webhook","href":"/docs/API-docs/v1/get-webhook","className":"api-method get","docId":"API-docs/v1/get-webhook","unlisted":false},{"type":"link","label":"Save or Update Webhook","href":"/docs/API-docs/v1/save-update-webhook","className":"api-method post","docId":"API-docs/v1/save-update-webhook","unlisted":false},{"type":"link","label":"Delete Webhook","href":"/docs/API-docs/v1/delete-webhook","className":"api-method delete","docId":"API-docs/v1/delete-webhook","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Folder","items":[{"type":"link","label":"Create Folder","href":"/docs/API-docs/v1/createfolder","className":"api-method post","docId":"API-docs/v1/createfolder","unlisted":false},{"type":"link","label":"Get Folder","href":"/docs/API-docs/v1/getfolder","className":"api-method get","docId":"API-docs/v1/getfolder","unlisted":false},{"type":"link","label":"Update Folder","href":"/docs/API-docs/v1/updatefolder","className":"api-method put","docId":"API-docs/v1/updatefolder","unlisted":false},{"type":"link","label":"Delete Folder","href":"/docs/API-docs/v1/deletefolder","className":"api-method delete","docId":"API-docs/v1/deletefolder","unlisted":false},{"type":"link","label":"Get folder list","href":"/docs/API-docs/v1/folderlist","className":"api-method get","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/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/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 documentation v1.1!","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-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/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/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/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/navigate-between-pages":{"id":"help/New-Document/navigate-between-pages","title":"Navigate between pages of a document","description":"To navigate between pages of a document that you have uploaded either click on the previous page > buttons at the top or click on any of the page previews loaded on the left side -","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/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":"Quickly Send the Document for Signature Using Template","description":"Step 1: Begin New Template Creation","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"},"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 +"use strict";(self.webpackChunkOpenSign_Docs=self.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","label":"Intro","href":"/docs/help/intro","docId":"help/intro","unlisted":false},{"type":"category","label":"Create New OpenSign Document","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Sign your-self","href":"/docs/help/New-Document/sign-yourself","docId":"help/New-Document/sign-yourself","unlisted":false},{"type":"link","label":"Request signatures","href":"/docs/help/New-Document/request-signatures","docId":"help/New-Document/request-signatures","unlisted":false},{"type":"link","label":"Navigate between pages of a document","href":"/docs/help/New-Document/navigate-between-pages","docId":"help/New-Document/navigate-between-pages","unlisted":false},{"type":"link","label":"Editing Your Document Before Sending","href":"/docs/help/New-Document/edit-document-before-sending","docId":"help/New-Document/edit-document-before-sending","unlisted":false},{"type":"link","label":"Enforce email OTP verification","href":"/docs/help/New-Document/enforce-email-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","label":"Create Docs & Folders","href":"/docs/help/OpenSign\u2122 Drive/create-document","docId":"help/OpenSign\u2122 Drive/create-document","unlisted":false},{"type":"link","label":"Grid vs List view","href":"/docs/help/OpenSign\u2122 Drive/list-grid-view","docId":"help/OpenSign\u2122 Drive/list-grid-view","unlisted":false},{"type":"link","label":"OpenSign\u2122 Drive Interface Documentation","href":"/docs/help/OpenSign\u2122 Drive/organize-documents","docId":"help/OpenSign\u2122 Drive/organize-documents","unlisted":false},{"type":"link","label":"Rename documents from OpenSign\u2122 Drive","href":"/docs/help/OpenSign\u2122 Drive/rename-document","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","label":"Need your sign","href":"/docs/help/Reports/need-your-sign","docId":"help/Reports/need-your-sign","unlisted":false},{"type":"link","label":"In Progress","href":"/docs/help/Reports/in-progress","docId":"help/Reports/in-progress","unlisted":false},{"type":"link","label":"Completed","href":"/docs/help/Reports/completed","docId":"help/Reports/completed","unlisted":false},{"type":"link","label":"Drafts","href":"/docs/help/Reports/drafts","docId":"help/Reports/drafts","unlisted":false},{"type":"link","label":"Declined","href":"/docs/help/Reports/declined","docId":"help/Reports/declined","unlisted":false},{"type":"link","label":"Expired","href":"/docs/help/Reports/expired","docId":"help/Reports/expired","unlisted":false},{"type":"link","label":"Contactbook","href":"/docs/help/Reports/contactbook","docId":"help/Reports/contactbook","unlisted":false}],"href":"/docs/category/documents"},{"type":"category","label":"Templates","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Create Templates","href":"/docs/help/Templates/create-template","docId":"help/Templates/create-template","unlisted":false},{"type":"link","label":"Manage Templates","href":"/docs/help/Templates/manage-templates","docId":"help/Templates/manage-templates","unlisted":false},{"type":"link","label":"Use template to create documents","href":"/docs/help/Templates/use-template","docId":"help/Templates/use-template","unlisted":false},{"type":"link","label":"Quickly Send the Document for Signature Using Template","href":"/docs/help/Templates/quick-send","docId":"help/Templates/quick-send","unlisted":false},{"type":"link","label":"Setting up an OpenSign template for public signing","href":"/docs/help/Templates/publicTemplate","docId":"help/Templates/publicTemplate","unlisted":false},{"type":"link","label":"Embedding OpenSign templates","href":"/docs/help/Templates/embed-template","docId":"help/Templates/embed-template","unlisted":false}],"href":"/docs/category/templates"},{"type":"category","label":"Settings","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"My Signature","href":"/docs/help/Settings/my-signature","docId":"help/Settings/my-signature","unlisted":false},{"type":"link","label":"API Token","href":"/docs/help/Settings/APIToken","docId":"help/Settings/APIToken","unlisted":false},{"type":"link","label":"Webhook","href":"/docs/help/Settings/Webhook","docId":"help/Settings/Webhook","unlisted":false},{"type":"link","label":"Preferences","href":"/docs/help/Settings/Preferences","docId":"help/Settings/Preferences","unlisted":false},{"type":"link","label":"Manage Teams","href":"/docs/help/Settings/Teams","docId":"help/Settings/Teams","unlisted":false},{"type":"link","label":"Manage users","href":"/docs/help/Settings/manage-users","docId":"help/Settings/manage-users","unlisted":false},{"type":"link","label":"Disable DocumentId","href":"/docs/help/Settings/disabledocumentid","docId":"help/Settings/disabledocumentid","unlisted":false},{"type":"link","label":"Custom email templates","href":"/docs/help/Settings/Custom-email-templates","docId":"help/Settings/Custom-email-templates","unlisted":false},{"type":"link","label":"Security","href":"/docs/help/Settings/SecurityManagement","docId":"help/Settings/SecurityManagement","unlisted":false}],"href":"/docs/category/settings"},{"type":"category","label":"FAQs","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Why is there no dropdown list when I sign a document myself?","href":"/docs/help/FAQs/","docId":"help/FAQs/FAQs","unlisted":false},{"type":"link","label":"Why am I getting \'Ensure this field is accurately filled and meets all requirements\'?","href":"/docs/help/FAQs/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}],"href":"/docs/category/faqs"}],"selfhostSidebar":[{"type":"link","label":"Self-Hosting OpenSign","href":"/docs/self-host/intro","docId":"self-host/intro","unlisted":false},{"type":"category","label":"Docker","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Self-host OpenSign\u2122 with Docker on Linux/MacOS/Windows","href":"/docs/self-host/docker/run-locally","docId":"self-host/docker/run-locally","unlisted":false},{"type":"link","label":"OpenSign\u2122 Self-Hosted \'Upgrade Deployment\' Guide Using Docker on Linux, macOS, or Windows","href":"/docs/self-host/docker/upgrade-deployment","docId":"self-host/docker/upgrade-deployment","unlisted":false}],"href":"/docs/category/docker"},{"type":"category","label":"Cloud Storage","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"AWS S3","href":"/docs/self-host/cloud-storage/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","label":"OpenSign Deployment Guide on Azure VM via command-line","href":"/docs/self-host/guides/azure-vm-setup","docId":"self-host/guides/azure-vm-setup","unlisted":false},{"type":"link","label":"ENV variables which are used to setup OpenSign\u2122 with Docker on Localhost","href":"/docs/self-host/guides/env-variables","docId":"self-host/guides/env-variables","unlisted":false},{"type":"link","label":"How to generate self-signed document signing certificate?","href":"/docs/self-host/guides/how-to-generate-self-signed-document-signing-certificate","docId":"self-host/guides/how-to-generate-self-signed-document-signing-certificate","unlisted":false},{"type":"link","label":"How to upgrade self-hosted OpenSign to v2.1.0?","href":"/docs/self-host/guides/upgrade-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","label":"Digital Ocean","href":"/docs/self-host/One-click-Install/DigitalOcean","docId":"self-host/One-click-Install/DigitalOcean","unlisted":false}]}],"contributeSidebar":[{"type":"link","label":"Code of conduct","href":"/docs/contribute/CODE_OF_CONDUCT","docId":"contribute/CODE_OF_CONDUCT","unlisted":false},{"type":"link","label":"Contributing to OpenSign","href":"/docs/contribute/intro","docId":"contribute/intro","unlisted":false},{"type":"link","label":"Installation instructions","href":"/docs/contribute/INSTALLATION","docId":"contribute/INSTALLATION","unlisted":false},{"type":"link","label":"Community at OpenSign\u2122","href":"/docs/contribute/COMMUNITY","docId":"contribute/COMMUNITY","unlisted":false},{"type":"link","label":"OpenSign\u2122 Reporting Guidelines","href":"/docs/contribute/REPORTING_GUIDELINES","docId":"contribute/REPORTING_GUIDELINES","unlisted":false}],"apiSidebar":[{"type":"category","label":"v1.1","collapsed":false,"items":[{"type":"link","label":"Introduction","href":"/docs/API-docs/v1.1/opensign-api-v-1-1","docId":"API-docs/v1.1/opensign-api-v-1-1","unlisted":false},{"type":"category","label":"User","items":[{"type":"link","label":"Get your account details","href":"/docs/API-docs/v1.1/get-user","className":"api-method get","docId":"API-docs/v1.1/get-user","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Contacts","items":[{"type":"link","label":"Create Contact","href":"/docs/API-docs/v1.1/createcontact","className":"api-method post","docId":"API-docs/v1.1/createcontact","unlisted":false},{"type":"link","label":"Get Contact","href":"/docs/API-docs/v1.1/getcontact","className":"api-method get","docId":"API-docs/v1.1/getcontact","unlisted":false},{"type":"link","label":"Delete Contact","href":"/docs/API-docs/v1.1/deletecontact","className":"api-method delete","docId":"API-docs/v1.1/deletecontact","unlisted":false},{"type":"link","label":"Get Contact list","href":"/docs/API-docs/v1.1/contactlist","className":"api-method get","docId":"API-docs/v1.1/contactlist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Documents","items":[{"type":"link","label":"Self Sign","href":"/docs/API-docs/v1.1/selfsign","className":"api-method post","docId":"API-docs/v1.1/selfsign","unlisted":false},{"type":"link","label":"Draft Document","href":"/docs/API-docs/v1.1/draftdocument","className":"api-method post","docId":"API-docs/v1.1/draftdocument","unlisted":false},{"type":"link","label":"Create Document","href":"/docs/API-docs/v1.1/createdocument","className":"api-method post","docId":"API-docs/v1.1/createdocument","unlisted":false},{"type":"link","label":"Create Document from Template","href":"/docs/API-docs/v1.1/createdocumentwithtemplateid","className":"api-method post","docId":"API-docs/v1.1/createdocumentwithtemplateid","unlisted":false},{"type":"link","label":"Get Document","href":"/docs/API-docs/v1.1/getdocument","className":"api-method get","docId":"API-docs/v1.1/getdocument","unlisted":false},{"type":"link","label":"Update Document","href":"/docs/API-docs/v1.1/update-document","className":"api-method put","docId":"API-docs/v1.1/update-document","unlisted":false},{"type":"link","label":"Revoke Document","href":"/docs/API-docs/v1.1/revokedocument","className":"api-method post","docId":"API-docs/v1.1/revokedocument","unlisted":false},{"type":"link","label":"Delete Document","href":"/docs/API-docs/v1.1/deletedocument","className":"api-method delete","docId":"API-docs/v1.1/deletedocument","unlisted":false},{"type":"link","label":"Get Document list from status","href":"/docs/API-docs/v1.1/getdocumentlist","className":"api-method get","docId":"API-docs/v1.1/getdocumentlist","unlisted":false},{"type":"link","label":"Resend request mail","href":"/docs/API-docs/v1.1/resendrequestmail","className":"api-method post","docId":"API-docs/v1.1/resendrequestmail","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Templates","items":[{"type":"link","label":"Draft Template","href":"/docs/API-docs/v1.1/drafttemplate","className":"api-method post","docId":"API-docs/v1.1/drafttemplate","unlisted":false},{"type":"link","label":"Create Template","href":"/docs/API-docs/v1.1/createtemplate","className":"api-method post","docId":"API-docs/v1.1/createtemplate","unlisted":false},{"type":"link","label":"Public Template","href":"/docs/API-docs/v1.1/publictemplate","className":"api-method post","docId":"API-docs/v1.1/publictemplate","unlisted":false},{"type":"link","label":"Get Template","href":"/docs/API-docs/v1.1/get-template","className":"api-method get","docId":"API-docs/v1.1/get-template","unlisted":false},{"type":"link","label":"Update Template","href":"/docs/API-docs/v1.1/update-template","className":"api-method put","docId":"API-docs/v1.1/update-template","unlisted":false},{"type":"link","label":"Delete Template","href":"/docs/API-docs/v1.1/delete-template","className":"api-method delete","docId":"API-docs/v1.1/delete-template","unlisted":false},{"type":"link","label":"Get Template list","href":"/docs/API-docs/v1.1/gettemplatelist","className":"api-method get","docId":"API-docs/v1.1/gettemplatelist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Webhook","items":[{"type":"link","label":"Get Webhook","href":"/docs/API-docs/v1.1/get-webhook","className":"api-method get","docId":"API-docs/v1.1/get-webhook","unlisted":false},{"type":"link","label":"Save or Update Webhook","href":"/docs/API-docs/v1.1/save-update-webhook","className":"api-method post","docId":"API-docs/v1.1/save-update-webhook","unlisted":false},{"type":"link","label":"Delete Webhook","href":"/docs/API-docs/v1.1/delete-webhook","className":"api-method delete","docId":"API-docs/v1.1/delete-webhook","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Folder","items":[{"type":"link","label":"Create Folder","href":"/docs/API-docs/v1.1/createfolder","className":"api-method post","docId":"API-docs/v1.1/createfolder","unlisted":false},{"type":"link","label":"Get Folder","href":"/docs/API-docs/v1.1/getfolder","className":"api-method get","docId":"API-docs/v1.1/getfolder","unlisted":false},{"type":"link","label":"Update Folder","href":"/docs/API-docs/v1.1/updatefolder","className":"api-method put","docId":"API-docs/v1.1/updatefolder","unlisted":false},{"type":"link","label":"Delete Folder","href":"/docs/API-docs/v1.1/deletefolder","className":"api-method delete","docId":"API-docs/v1.1/deletefolder","unlisted":false},{"type":"link","label":"Get folder list","href":"/docs/API-docs/v1.1/folderlist","className":"api-method get","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","label":"Introduction","href":"/docs/API-docs/v1/opensign-api-v-1","docId":"API-docs/v1/opensign-api-v-1","unlisted":false},{"type":"category","label":"User","items":[{"type":"link","label":"Get your account details","href":"/docs/API-docs/v1/get-user","className":"api-method get","docId":"API-docs/v1/get-user","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Contacts","items":[{"type":"link","label":"Create Contact","href":"/docs/API-docs/v1/createcontact","className":"api-method post","docId":"API-docs/v1/createcontact","unlisted":false},{"type":"link","label":"Get Contact","href":"/docs/API-docs/v1/getcontact","className":"api-method get","docId":"API-docs/v1/getcontact","unlisted":false},{"type":"link","label":"Delete Contact","href":"/docs/API-docs/v1/deletecontact","className":"api-method delete","docId":"API-docs/v1/deletecontact","unlisted":false},{"type":"link","label":"Get Contact list","href":"/docs/API-docs/v1/contactlist","className":"api-method get","docId":"API-docs/v1/contactlist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Documents","items":[{"type":"link","label":"Self Sign","href":"/docs/API-docs/v1/selfsign","className":"api-method post","docId":"API-docs/v1/selfsign","unlisted":false},{"type":"link","label":"Draft Document","href":"/docs/API-docs/v1/draftdocument","className":"api-method post","docId":"API-docs/v1/draftdocument","unlisted":false},{"type":"link","label":"Create Document","href":"/docs/API-docs/v1/createdocument","className":"api-method post","docId":"API-docs/v1/createdocument","unlisted":false},{"type":"link","label":"Create Document from Template","href":"/docs/API-docs/v1/createdocumentwithtemplateid","className":"api-method post","docId":"API-docs/v1/createdocumentwithtemplateid","unlisted":false},{"type":"link","label":"Get Document","href":"/docs/API-docs/v1/getdocument","className":"api-method get","docId":"API-docs/v1/getdocument","unlisted":false},{"type":"link","label":"Update Document","href":"/docs/API-docs/v1/update-document","className":"api-method put","docId":"API-docs/v1/update-document","unlisted":false},{"type":"link","label":"Revoke Document","href":"/docs/API-docs/v1/revokedocument","className":"api-method post","docId":"API-docs/v1/revokedocument","unlisted":false},{"type":"link","label":"Delete Document","href":"/docs/API-docs/v1/deletedocument","className":"api-method delete","docId":"API-docs/v1/deletedocument","unlisted":false},{"type":"link","label":"Get Document list from status","href":"/docs/API-docs/v1/getdocumentlist","className":"api-method get","docId":"API-docs/v1/getdocumentlist","unlisted":false},{"type":"link","label":"Resend request mail","href":"/docs/API-docs/v1/resendrequestmail","className":"api-method post","docId":"API-docs/v1/resendrequestmail","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Templates","items":[{"type":"link","label":"Draft Template","href":"/docs/API-docs/v1/drafttemplate","className":"api-method post","docId":"API-docs/v1/drafttemplate","unlisted":false},{"type":"link","label":"Create Template","href":"/docs/API-docs/v1/createtemplate","className":"api-method post","docId":"API-docs/v1/createtemplate","unlisted":false},{"type":"link","label":"Get Template","href":"/docs/API-docs/v1/get-template","className":"api-method get","docId":"API-docs/v1/get-template","unlisted":false},{"type":"link","label":"Update Template","href":"/docs/API-docs/v1/update-template","className":"api-method put","docId":"API-docs/v1/update-template","unlisted":false},{"type":"link","label":"Delete Template","href":"/docs/API-docs/v1/delete-template","className":"api-method delete","docId":"API-docs/v1/delete-template","unlisted":false},{"type":"link","label":"Get Template list","href":"/docs/API-docs/v1/gettemplatelist","className":"api-method get","docId":"API-docs/v1/gettemplatelist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Webhook","items":[{"type":"link","label":"Get Webhook","href":"/docs/API-docs/v1/get-webhook","className":"api-method get","docId":"API-docs/v1/get-webhook","unlisted":false},{"type":"link","label":"Save or Update Webhook","href":"/docs/API-docs/v1/save-update-webhook","className":"api-method post","docId":"API-docs/v1/save-update-webhook","unlisted":false},{"type":"link","label":"Delete Webhook","href":"/docs/API-docs/v1/delete-webhook","className":"api-method delete","docId":"API-docs/v1/delete-webhook","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Folder","items":[{"type":"link","label":"Create Folder","href":"/docs/API-docs/v1/createfolder","className":"api-method post","docId":"API-docs/v1/createfolder","unlisted":false},{"type":"link","label":"Get Folder","href":"/docs/API-docs/v1/getfolder","className":"api-method get","docId":"API-docs/v1/getfolder","unlisted":false},{"type":"link","label":"Update Folder","href":"/docs/API-docs/v1/updatefolder","className":"api-method put","docId":"API-docs/v1/updatefolder","unlisted":false},{"type":"link","label":"Delete Folder","href":"/docs/API-docs/v1/deletefolder","className":"api-method delete","docId":"API-docs/v1/deletefolder","unlisted":false},{"type":"link","label":"Get folder list","href":"/docs/API-docs/v1/folderlist","className":"api-method get","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/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/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-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/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/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/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/navigate-between-pages":{"id":"help/New-Document/navigate-between-pages","title":"Navigate between pages of a document","description":"To navigate between pages of a document that you have uploaded either click on the previous page > buttons at the top or click on any of the page previews loaded on the left side -","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/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":"Quickly Send the Document for Signature Using Template","description":"Step 1: Begin New Template Creation","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"},"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.2b72627a.js b/assets/js/02e5f5c4.2b72627a.js deleted file mode 100644 index 72014c583..000000000 --- a/assets/js/02e5f5c4.2b72627a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[5373],{69772:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>f,contentTitle:()=>b,default:()=>x,frontMatter:()=>y,metadata:()=>a,toc:()=>q});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":"eJzNV19vJDUM/yomL3DVdHdb7kDME+V0HIXqrqJFleitqsyMdybXTBISz25Xq5XugW/AE698tPskyMnO/ms5KCDES9V1bMf+2Y5/sxAk6yDya/G11RV6Mc5EhaH0ypGyRuTiskF47lESQlKBk/NTkFrbWYC57YAslOl8Es8HIhPWoZfs4LQSuUjH6VRkwuNPHQb6ylZzkS/2rjv3dqoqhAK1nYGTXrZI6O/dIjJRWkNoiH1I57Qq443Dt4EdLUQoG2wl/8cXKo8Vp5msjWyRU6W5Q5ELW7zFkkQmnOfISWFgu6T7inXzRa8byCtTi0xMrG8lbUvwTrZOs5LBWR/nMhNOejSU0GNAHudLLJeZIEXxR3J6UzB2Sz7Y5Ea+wygIzpqQMjgeje5DnHys4KwgdGWJIUw6recfPQbWD4OXxI9P1zVHRXN3/NYxcv+PCnx7bGR4dqvOkX2tcDuhh9xsjI5Hx58eHo0OR59fHn2WP/0if/bZYDQa/Sgycddqto1NmItKUvTbl7j/3bnqP7hnua+WQKuQpNJB3Gs97rplJp4+1FgXtkVqlKlhhoZg5q2pM3AaZUAgPwdZS2VAS0L/L3Yaem/9h0F6XGTbA6eMVgZv+qm6eToa3RytQXh2H4RTM5VaVfGVvLS3aP7bTLevp3T9/RqrpBTPxU6y2/KUZMCy84rmIr9eiLtD6dRhOs+vx8txJhhYy6+8syFGLKkRuRjuPfoB/RR9iF46r0UuGiIX8uEwSFMV9m5gHZqgaqNlEQalbYfSqeH0aHAkltm+jXTuUfrYHT7WJJCslan/zG68QeiCq5gKtYPTulzSqe9wLrK+DNtamVDcPQ3KNGSZ4Ob4frMqX/Ql3t1L2w/d/XdOcHWVmdgYxarKrx2aC1Wb2CMxi/2df4W6tC3y0qUGoTd4//Nv0aayZdeiodjE0cNHb8wb87rz4OwM/aTTIE0FE413qtAYjbCNZ2vOEFC2GkPQc1CGsPa82ytVK5IaGGye1lI6WSiteABYzbK1h60ZCgO4apAa9Hz0sUeQUOEUNc8NyI5sK4ld9UHDzPrbCbOXDCQUXVAGQwA0jTQlK/blzMB6kAbQEHrnVUAI5DlqlWKzhrwsCVppZI3sO9uBqkKtuOfB26ILBMHqLoYM/LZajxX0CRnEKgwYxBd3jo+ApaVtnceGe2+KUHeqwpBBaSuEEJuBUzAVFBgIHMeiSgzstDPalrexeLzXwVl+fpTUYCc7MbI5eWkC778US1+DNWDOWyYImAI8OPghIFf4TJnbkB8cvDGHcL3uqSssgiIcf9LP0Ww2uzc/T3ZtXir6pivge3Q2KLJ+vrGuFTVdEWdu28n6R/L0Eg3G/tmaqI2Pypbh/gizdNigdsMLJO6QMDw5P40v9hN4/+4XOEPpDTR2lrq17DzqOdT9VYxcqnyCbf3gwsTGxmsY8TI134ry9gheNZLev/s1wCucgUojlIA8ODjvCq1KuMTW8ToKBwd5z7+plwE1kqCUBgqE0EhupamSIMEla63M7QBOzBy6gB5miprYDCyPdjtpMC7rcgcoZMAKrIkW/Z2DTUQsbwPqKQb2ZSxxGFgpZpPUeNvV6bbtYFbJeZworeFKVTVSzO2kqsCtxLMkZsC3wsEJDwQ1OAfpEQIaGsD5nkk86ZyznqNQKfiJ5c8ULgCaylllKORQeTmhjf9s0+hxZSlrHhAlCOUajmzlZl2SNImrjNfSwRt+2fe2we5b63GCni+MaW/q4tSqna77tgTu1n/S1pG9WkOyjEwEW6l0Wktf7vuJrAB9G15PLtBPVYmr1fgHEz2MykORCa1KNAG32MbJy/MzmH46GIlsa8f+heEenp0+f/Hq4gUHww9pAuxoMBqMIqm3gVpptm7a+U7d32qLDQv7ex+1qy1OeEdDp6WK1CkmtFixnuvdT91xJhomRfm1WCx4qn7werlk8U8demZU40xMpVey4MV8PV5mPQFgmnSLc84pBX14ybezuu4Sl9ijkcxgksVJWaKjD+pu87bz1xeXIhPF6nO8tRXbeDnjT3U5YxLBH/Rxc8WvaZYthJam7mTNuskncxZ+9nYJz20kPKt/OKv+yMy3ItxlQikN/stJPWiwWCQytVyu9dPRH1qsgO21uXrj5XL5O0f/8v8=","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 l=r(74848),s=r(28453),o=r(33617),n=r.n(o),d=r(17543),i=r.n(d),p=r(86013),c=r.n(p),m=r(63723),u=r.n(m),g=(r(18766),r(79329),r(9303));const y={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:"eJzNV19vJDUM/yomL3DVdHdb7kDME+V0HIXqrqJFleitqsyMdybXTBISz25Xq5XugW/AE698tPskyMnO/ms5KCDES9V1bMf+2Y5/sxAk6yDya/G11RV6Mc5EhaH0ypGyRuTiskF47lESQlKBk/NTkFrbWYC57YAslOl8Es8HIhPWoZfs4LQSuUjH6VRkwuNPHQb6ylZzkS/2rjv3dqoqhAK1nYGTXrZI6O/dIjJRWkNoiH1I57Qq443Dt4EdLUQoG2wl/8cXKo8Vp5msjWyRU6W5Q5ELW7zFkkQmnOfISWFgu6T7inXzRa8byCtTi0xMrG8lbUvwTrZOs5LBWR/nMhNOejSU0GNAHudLLJeZIEXxR3J6UzB2Sz7Y5Ea+wygIzpqQMjgeje5DnHys4KwgdGWJIUw6recfPQbWD4OXxI9P1zVHRXN3/NYxcv+PCnx7bGR4dqvOkX2tcDuhh9xsjI5Hx58eHo0OR59fHn2WP/0if/bZYDQa/Sgycddqto1NmItKUvTbl7j/3bnqP7hnua+WQKuQpNJB3Gs97rplJp4+1FgXtkVqlKlhhoZg5q2pM3AaZUAgPwdZS2VAS0L/L3Yaem/9h0F6XGTbA6eMVgZv+qm6eToa3RytQXh2H4RTM5VaVfGVvLS3aP7bTLevp3T9/RqrpBTPxU6y2/KUZMCy84rmIr9eiLtD6dRhOs+vx8txJhhYy6+8syFGLKkRuRjuPfoB/RR9iF46r0UuGiIX8uEwSFMV9m5gHZqgaqNlEQalbYfSqeH0aHAkltm+jXTuUfrYHT7WJJCslan/zG68QeiCq5gKtYPTulzSqe9wLrK+DNtamVDcPQ3KNGSZ4Ob4frMqX/Ql3t1L2w/d/XdOcHWVmdgYxarKrx2aC1Wb2CMxi/2df4W6tC3y0qUGoTd4//Nv0aayZdeiodjE0cNHb8wb87rz4OwM/aTTIE0FE413qtAYjbCNZ2vOEFC2GkPQc1CGsPa82ytVK5IaGGye1lI6WSiteABYzbK1h60ZCgO4apAa9Hz0sUeQUOEUNc8NyI5sK4ld9UHDzPrbCbOXDCQUXVAGQwA0jTQlK/blzMB6kAbQEHrnVUAI5DlqlWKzhrwsCVppZI3sO9uBqkKtuOfB26ILBMHqLoYM/LZajxX0CRnEKgwYxBd3jo+ApaVtnceGe2+KUHeqwpBBaSuEEJuBUzAVFBgIHMeiSgzstDPalrexeLzXwVl+fpTUYCc7MbI5eWkC778US1+DNWDOWyYImAI8OPghIFf4TJnbkB8cvDGHcL3uqSssgiIcf9LP0Ww2uzc/T3ZtXir6pivge3Q2KLJ+vrGuFTVdEWdu28n6R/L0Eg3G/tmaqI2Pypbh/gizdNigdsMLJO6QMDw5P40v9hN4/+4XOEPpDTR2lrq17DzqOdT9VYxcqnyCbf3gwsTGxmsY8TI134ry9gheNZLev/s1wCucgUojlIA8ODjvCq1KuMTW8ToKBwd5z7+plwE1kqCUBgqE0EhupamSIMEla63M7QBOzBy6gB5miprYDCyPdjtpMC7rcgcoZMAKrIkW/Z2DTUQsbwPqKQb2ZSxxGFgpZpPUeNvV6bbtYFbJeZworeFKVTVSzO2kqsCtxLMkZsC3wsEJDwQ1OAfpEQIaGsD5nkk86ZyznqNQKfiJ5c8ULgCaylllKORQeTmhjf9s0+hxZSlrHhAlCOUajmzlZl2SNImrjNfSwRt+2fe2we5b63GCni+MaW/q4tSqna77tgTu1n/S1pG9WkOyjEwEW6l0Wktf7vuJrAB9G15PLtBPVYmr1fgHEz2MykORCa1KNAG32MbJy/MzmH46GIlsa8f+heEenp0+f/Hq4gUHww9pAuxoMBqMIqm3gVpptm7a+U7d32qLDQv7ex+1qy1OeEdDp6WK1CkmtFixnuvdT91xJhomRfm1WCx4qn7werlk8U8demZU40xMpVey4MV8PV5mPQFgmnSLc84pBX14ybezuu4Sl9ijkcxgksVJWaKjD+pu87bz1xeXIhPF6nO8tRXbeDnjT3U5YxLBH/Rxc8WvaZYthJam7mTNuskncxZ+9nYJz20kPKt/OKv+yMy3ItxlQikN/stJPWiwWCQytVyu9dPRH1qsgO21uXrj5XL5O0f/8v8=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},b=void 0,f={},q=[];function I(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:"Create Folder"}),"\n",(0,l.jsx)(n(),{method:"post",path:"/createfolder",context:"endpoint"}),"\n",(0,l.jsx)(t.p,{children:"The Create Folder API allows you to create folder."}),"\n",(0,l.jsx)(g.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,l.jsx)(i(),{parameters:void 0}),"\n",(0,l.jsx)(c(),{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:!0}}),"\n",(0,l.jsx)(u(),{id:void 0,label:void 0,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"}}}}}})]})}function x(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,l.jsx)(t,{...e,children:(0,l.jsx)(I,{...e})}):I(e)}}}]); \ No newline at end of file diff --git a/assets/js/02e5f5c4.60be571e.js b/assets/js/02e5f5c4.60be571e.js new file mode 100644 index 000000000..f287d15a6 --- /dev/null +++ b/assets/js/02e5f5c4.60be571e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[5373],{69772:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>S,contentTitle:()=>h,default:()=>I,frontMatter:()=>j,metadata:()=>a,toc:()=>g});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(33617),l=r.n(s),i=r(17543),d=r.n(i),p=r(86013),c=r.n(p),m=r(63723),f=r.n(m),u=(r(18766),r(79329),r(9303));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},h=void 0,S={},g=[];function y(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:"Request"}),"\n",(0,o.jsx)(d(),{parameters:void 0}),"\n",(0,o.jsx)(c(),{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:!0}}),"\n",(0,o.jsx)(f(),{id:void 0,label:void 0,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"}}}}}})]})}function I(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/03e06346.0d5f551b.js b/assets/js/03e06346.0d5f551b.js deleted file mode 100644 index 29fc1e634..000000000 --- a/assets/js/03e06346.0d5f551b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3404],{48329:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>g,contentTitle:()=>b,default:()=>f,frontMatter:()=>x,metadata:()=>s,toc:()=>y});const s=JSON.parse('{"id":"API-docs/v1.1/publictemplate","title":"Public Template","description":"The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique **template_id** and a **public_url**. The **public_url** is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing.","source":"@site/docs/API-docs/v1.1/publictemplate.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/publictemplate","permalink":"/docs/API-docs/v1.1/publictemplate","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"publictemplate","title":"Public Template","description":"The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique **template_id** and a **public_url**. The **public_url** is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing.","sidebar_label":"Public Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztPF1zGzeSfwU7dVWJeUOKpCRb0dbVnZL4Et96bZUtX+pO0irgTJMDawaYABhRjIpV+7D/YJ/udX9afslVN4DhDD8k2VYS+Y55cMTBV3ejG+hudPdNZPnERIen0QkUZc4tmOg8jlIwiRalFUpGh9FJBuy4GuUiYaEXOzp+wXieq6lhlQFtmFUs0YBNNszEbMYtM6CvgHHDRnkFpRbSGjZWmk1AguZWyAlLVVIVgA1TYTNWakhhLCSkzFhdJbbSYHrshwwk4/X0TBhmqiQBY8ZVns/88mnMbObg02ArLQ3jrJLipwpYpxMGX4i002FcpoyzTqck5C4qnXc6PYbotr/hUu53PmOclhSjHGh8wWdsBMxkXEPq4OdyRkSJGUg+yhFDm0GBJPJIu6FGTGQD9xE3kDIlCf4AaI99r6ZwhZM1PzNhDeRjlnAplUUACpWKsYCU2UyrapIxmwnD3r15+UcmLPZjSuYEaoXL4A6EpR3lhJI1VEJOemfyTJ6I8pC9K3PFUzZTlWbH3/77YphVDL+ddjrfwqiasHcvOp3zLzNrS3O4s8PLsqdKkDhfzkeml6hiJ8WOZTp+ErNpBhpwVgIOuBFI3BRpmE7AGkJYskSVM5YopVMhkaliVvIJMFkVI9AmdnugNDCBzKGBp7OuVd3KAPuPt69fIaIFtz12nFcmrpdLhYbEItPg9EjZgNUXbiOe7iHvCTmJWcEvcQuFZT9VIrlEtA3IFP/vOY1o1em8rcpSaQsp+8GhcNjpYMvXkKsp4xqof6KKQklWcs0LsCQ6KCbYrOGnSizYKM8DLQ7PZBe5d1bCYafDXshUJF7CgOFXpsa+b891RSJh17clJMgXrmuDdMho00wkGdFkyt1+ljlPHJgaTAmJFVfQnvg6ZjOc+FuQKkCQKS1+VtLynLbjCrQVCc+b24YAYldjuSaZL5WQNnz1K7D/8tuDu0eb4vkKQUuRWIWQ1GKAXfG8AuOhmsYsQ6jeQKnBkDj5eUkeU5aBmGQb1+Pp+8rY1sSsMl5wayj8WmGXiLxAZBvz3AAT4xYtC34JjdWYovOU5z329YylMOZVbmMmkOOsrqDHXinLeFnmIuF4uqCIovBwPP+6tMueHTwgkhe0x8daXYkU8KBLxXgMGoUTG2kKPyZAh3xW0gBEjyTHZnQ6LG10onKlV1mIPrfpyBIlLUjbY0dXXOQEvEPWMCGTvEqBjXKeXMZ0B8RM4ymNuzIDvEJix+/UBS8KR3OiDzOQIxcqifBL5ZfHo99DleKBjedzkCdsDKSmRYRpUtVL7VjhykiCIGIMCi7ymAgXs/dqxKywOcQosCWXs5il3ELMLFzbkbqOWZJBckl/aZ4KxUaVtUo6xFKtylRNpaflWElrxM9rJDK0fDhFhzHbi9nTmB3EbNCP2WAYs8FezAZPYzY4iNmwH7PhMGbDvZgNnzqwhgee1rwmcBOAwdBR2X4+1MVz96UwJNl4YJr6DJ62zuBBj3U6tTThtx9//PFM3pxJxs4iFK6z6JCdRXWXsyh2bXhmYtvA/77GH7vDZ/7nDH8+HR74n1PqOtjzPzP8ORycyblf8EwOCRLLi/IWKLD5QSHwvzwT4TdaFL+F8ww/4kEUhwbcqxY82DBv4rKLuAgprOC52YxO6PGIMFqAtILUHiJF7LoZI2p+ROg04cEWOiZdEx2rjaYg8ATFcAX7/Z6/WTYj75Z9NLg3wPk01J8i6ng0neDRtBn/+vR6RERYhunTKPGsRwoAncyb6eA7PCIqtCH6NBocIA3wUtpMAGx9RNg3wMEGf8O7tv5ed7DfHfaHey0KoG3kOhRFN027s9nsIaiHOo9fHlWeoKE6zQ7N17FWxRrzg6yDRS+vE9HfQWX/Myrqo6DDQop2HxkWQWOpLb6mlm1VymdfGDdVGForZ9h/oZrNGmBSE8JB1m+SKZF44LFPUMlGaOD1kAZdouROmu40KIkf07RbFN2lj/izS4RvfCyKXpr2lnqu7I77WLA0jdnq57Xf05QVRbHhs/ve+rxTFKtY9IrCw0bK11c9cqqQzrZZTnyH30pUFhLRXvhWMULPAXpIsIHMufVytHTZZEL6Bs9UbKmDhkmVcw3XaJcaoaTr/fAyFkRsodmTHUsmoPMcESnYl6+99v7Esz+i0J4Av9w9bgUznOSIJZWxqmAaJnDNSm4taEmTXfFcpM7N1KUPcM2LEk2Anb+cnaX//E875IBAG986X1UqJgL9QDt/OT3q/vf5mh5VWYJOuAGWA65kYgY26bHTDPJy4YqaTqe96a5JMqVy54d6bzSM3b8XavT+gsAte9yUT9Zh6lijYfAj6yzb+wZsi2LcsDByjclPPEYyNOjTbevtnVuuW9/jEd04SyBho/OeYPPpWVRwUkiQlWHxt7IZ6LPovB7jjHxI7xh7fg9hzUQKOR9Bvtp0b0GrP+d8piov38Gp1UbVc3SDbthQCFn7LQidftxo5NdLja5tvka+HUGa0hmunCCeYQdYLkzw3LTJ2RztXVvkcJQA5MNE57UfwEY1l36yFNSA3U8M3Enk9+6OJbAfo461WzGsdscKrY1pEgbnKIQURVXU/tFxPWsgWeF1jya9cCQ6+8MKzd1dWYFf37ECOiM3L3AmB+THCP6PWzRT3+MRnRVLIN0uxh9zirTu6Qe6YO8WwIBWUwDXXMvY1V3ItfCZzdLXY6/xekOfrBuEXrYkgdKiR+5TRbMG+d43FPmsmn64zZzX7PWIuG8NWL8yB/p+D337fBSTNrH/jBi1Bfa9mdU5JQs+ucVyp+ZHxJ4enhUnRKdzrGEs8rzxpMjCp/Cyg086kEPhn738YyJedeQIF9IqNAvCs+0IxvReaukZpflu7e4Zt6XNN1H3QKw0y7hx+jcp/LhV+GCLj9tLrvgA2sIdL2SAG3dl8HB24/CrfnOfBk/3W/u032/tU3/TPt1iNuIOmlJJU/vaYNHUkGva4vB99WpZFtswKW7pc4lvK8F6cMKgqjxlubikV5VUmDLnM9zVIKUeyuXnum8ypcyih38x+9IjfNh+iVMaH+Oe9OqHifs4vJY2o7EXg2e7ja3YPzhoS0xLYO5jvy/WW92F/t7OYH/HebTWO7QWbpjNh/AtmgBj99kv8hPda7+o52LDtm6nj3U7PQy77z6k1T14NmxdFrv9j70sHty4bkrNHWb1QxjPD2bFNsXtnvbrb2ZHfjr37f0aGvXg2W6TC58NHsCFukFx/lROXNGPH4z32EMpx+sY8B7a8a0q8SczaBPYX51J9x9Gkx70WxraVy0F7athkyn39+/FlM1FlzjrLBL/+fXrN9P+n76bqKOjo6NXb99lz99Njo6OCvzd6/XWGlHrdpuWQc3VRwT6e5nu+A2r9Ho9JGHKLT+k4TulnPzRjY83j+n51+dfybOz/xCPKWscOJ9+CtRdfz9vza8n558qgVEcqZKCpJV8kUaHkQtCDkHAUUymJRj7tUpn0eFN5MPG8E8flIVDd94bjOO+iUySQcHxr2CSYuT3WOQ4FUY+gTZRHFEcAYaBI9dFh5EavYfERjG+cZXoiACDc9C4w5vQy4XLRrFXwqPDyHF9FEf+paf+xEAmCt9uy3QczcOCt01Vf1lMZeiPOiIa58GI1I+chobOlyLfP2qm5gzzBVkXk3Gt+SxaDrIPoajhHdGNq2Pt8lm4HIRFV0gdH0ndojgSFormKhs2TasPp3QCCjGhGKMPHUvbwosPXhPHlZmSHzXQex/W0PyeVHKtqwu3t+wIgxwhDVppdxGtGzOKmOvdxTGhP2HLJ8013RvByponm6K4G8GjJiNTlJclcN2jYOqPjtOnvA6eJxVlHdTHYguzGtQas8E8jq7vRuaaJaobQsTZlzmMrXvSZYnSEvSTZpzIo0FuuLc3j6PZ3ejNPkv0nuHmTe/G7geKrV/kHfwesO4ezOMouxvW7+vo/98R2L2n88VdF7lspTofaaTS2UU4t+Z3dQyXCvbDXJQX8rVOQTcIMVIqBy5XKPFi7Lzrin2BFscXsQukoKBtoU24UNgUHcwaEsAEEIqvCmcV8zqHi+hmPpAWnfLP8QOpSaYaGewlw3zGTTgCZrWYTAB9zr4HDfZh6cCTDJNrfHgHHwcvW6nhSqjKBPDQEY3BfjlYSnkCoevEpZZV1KAOububuPeau4Nf8JLDjC14fXJ8D1qSydZ1iVbunnZYujnY65NjTIURY6+G9dg7U1MikJa3ujBUi9iV4CFcvj7bZ+7xGZzfUbncsaaPvueTULpsFaBUmLUQxS6FD+P06yS+lYkXuVK4Raqy6PMXPgPAWChNi44ERU3IE1XdhyvvoCRnk4pi/SyKbMiLoXCfRSqLkC5ZkPT9tNIhe8ezBfbExL0FnQJVsFNjfszaM244Z2NuLObeVVIg5XWF2n09JVyXoAXIBNaSQIMjHSYR3q1NtPNC3r156TPkAg5BKEcogW5iSFlVEteQJNT5SmHnllFfUZRQOkBfbFLQVlUPyiryrogStFESzRWlJ1yKnx0Lk0aC1s4IMp67rv6oQJc1woMS3gYmnLW//O0fDbg2apyrgLkVeJpiMNodEJJJ5xgeNW4NJZ6Aqg0Rzgf635YvAYSOhObCJVw6QTL35/FjCl8z9bno39Dq9ztTJRkq+PV5a+JwxhqvVhqyEcmQpEe4EvGFa2FsI+MmxMWung9vAOmYNGAgNQSlGnlezpoCvnhXVEvTUV6QaGdr1dfgiizwyqoLDYWQ97unml4xq+qDoLKq4FYkLExleu0cPPf0EuS6YF8G0JAbr4TSTzaIKk53oWQCF0JeYMLtPRS8V3UcT8pnyNx2CiCbsAUiuetskSc1pVzmJk0atxNlAzah3EfzwD2errNdbjckAz+4q4RybYsRPuK7Z2AUNTo41MKWbBtDn4s15d9Dt7bUZ2RsDPr9/8u21G7/87Gl9vqfkS11gMB69+ndB9Am/Wbt2RHcwbcPeK/IaUOO3Nt7opd1HtfO63UEXojDcO7+W5h/4dy/wyR0NuPCrevNmYAMkWHY7+P/lg7BUFHCl89o1dT4QxTf36d8xyWwqLxxO72Org6Oi1IWSUYneV2G4/ZRTWbzX4nP3HhkvX8NEIj0X9prFGBM+8JYs4AvgGJvJ1dzl4TMhYSLsAUXS857t8176/bkrSrAZqTMoRo/1QrrUJQ5YKaD1TPGJ1xIhtPoB9wi0PouZv4wyG6jxl6/fzGoibC/SoQXkuLrqZLLiboE+dti2lzeuuUR1OsiX5wokXCdqD1qIdv87pA0kFRa2Fl0eHoTXXd5Kbqu/fD0fH6OXGgzRY88yhDE3GbRYbSz8uZDBXXwReH0JiK5qJnfcJli8MLKactLsXM16A2iebw8Zu3pfEt/qLofOsRYPhFycte48wWN3uI+uq1qUWqhgZbiT4AqqN+IZq84Esg/GXA0NZD0yB5vFi9lz8Mmhzesdc9Si81cfmgK70ytp6PlW3LNY1DjLeg0PMTQ20r9tBItEIrq5w/8s1bBTxcsW78dBHV3QHricG+PFKpnA9I8dg/oUt97Oj93BG44CykWtenxcmEXLdeN/9R2ZUTRkuugZb8vm+8bTekNlrRfcslirAFZZ6jtt+yjNdQK93ubVhiYgLTa7ROt9vpEq4N+S7XwGC5mWCgIpAXUSgDd9M2LHm/zc+Q/IceKmNdz1OsS5Fv0s+HhQsy/ohBCnqiirqcRBvzyt3/QmGCFO38GzvAHjNd4XWlWqinoceWKc4xzuKZKVTgICmoz9IpIUda8yMEYfFqUFiZUl4py7tCx511HCS/5SOQCT04XSUwhiY3D11Xmwld+bPpCuxTEK8jxwK0t9kaVLzZV+nKMpcNixtkI6+ygzwZkxmXi3EPuFCA3B9qr6HortTBYPkgj1MLBpqTVPLGs4JJPyE8Rt0iVQi7wqGRajdB7alReOf+g5SJX2gWQEUL0wk9BL8+vS2wijRYdaxoy5Nsr7yQ0sXPSOgH3BahG6A8vERaRAPlKKpkrrBWFfvUqz1mprPN1o+LchBGHW82lQW3XwRL2oCaY99+B8VHW7wzgDr8U8tLVN+my05qnfoCRERba2Y/LsvekPeY7Yb+vRlg9SRlhlZ4tRk+EzaoRHdXNSeofbqbvQl2zxkG8mCNViVljAqjE7GCi5s5bsMghZufo+AVd9U/YL3/9O3sJXEuWqanj1qTSkM/aJdTczjuy1Tc1eYh5heXDLDGpnIRHi0DBHzJuf/nr/xj2CqboKUMRcoTsdJZK3ZlO55B9s7a0XcjWcjH06Lbnvk4cy4W87LEjXwnOvW4gM+B3GvcRleBOGqtDYSC/AtOoAAepsK36b9ACxiPXTidA3I7SlJVLKQXoRluA4zxF9ArBncsIC6qtyUJohfu3CwGBTKnklzlkqeZju5g/Xi1Et+ZTSFEI5Ij9NPWWOEks22q6cVE0S0pE+6zVMAYqhmfaFfpK4dnpNLAla6cVfzhbO5NRWp6QChsuSF6KtY5mLHhmXo/fgr4SSbByNkj0DnXeieIoFwl4+9XfXUffHb9kV7u9fhQ3VLN7CPfOyxffPH/19jkCgwepI9ig1+/1yThTxhZcNlZakp3le60RobStKrmtKrmtKrmtKrmtKrmtKrmtKrmtKvmoqLutKrmtKrmtKrmtKrmtKrmtKrmtKrmtKrmtKrmtKrmtKrmtKrmtKrmtKrmtKrmtKrmtKvlYzoptVcnHUqxvW1Xyt+DAbVXJbVXJbVXJbVXJbVXJbVXJbVXJbVXJD3ZebatKbqtKbqtKbqtKbqtKbqtKbqtK/j+tKtnIitopcy4oedHn2Lq8w9PlWpPncZRhYuLhaXRzg5z3TufzOX7+qaIcrNPzOLriWmDEFuU0xiEFD/OwLmEWHUbfuAC07gmuH7uNpvj3pVROzCF0I44I91v7NnMnj1+/PYniaOTrYRYqpRRsPsW8LT51qWuN5C76dhPlXE4qSgyL3JxzV7Ika6ccXlLKof+jkV3G5awBYTsX0aGB/yJSawfc3Lh0xvm87u+aNo7whA29cf/O5/P5/wKDceTJ","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Template","permalink":"/docs/API-docs/v1.1/createtemplate"},"next":{"title":"Get Template","permalink":"/docs/API-docs/v1.1/get-template"}}');var i=t(74848),r=t(28453),l=t(33617),o=t.n(l),a=t(17543),d=t.n(a),c=t(86013),p=t.n(c),h=t(63723),u=t.n(h),m=(t(18766),t(79329),t(9303));const 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:"eJztPF1zGzeSfwU7dVWJeUOKpCRb0dbVnZL4Et96bZUtX+pO0irgTJMDawaYABhRjIpV+7D/YJ/udX9afslVN4DhDD8k2VYS+Y55cMTBV3ejG+hudPdNZPnERIen0QkUZc4tmOg8jlIwiRalFUpGh9FJBuy4GuUiYaEXOzp+wXieq6lhlQFtmFUs0YBNNszEbMYtM6CvgHHDRnkFpRbSGjZWmk1AguZWyAlLVVIVgA1TYTNWakhhLCSkzFhdJbbSYHrshwwk4/X0TBhmqiQBY8ZVns/88mnMbObg02ArLQ3jrJLipwpYpxMGX4i002FcpoyzTqck5C4qnXc6PYbotr/hUu53PmOclhSjHGh8wWdsBMxkXEPq4OdyRkSJGUg+yhFDm0GBJPJIu6FGTGQD9xE3kDIlCf4AaI99r6ZwhZM1PzNhDeRjlnAplUUACpWKsYCU2UyrapIxmwnD3r15+UcmLPZjSuYEaoXL4A6EpR3lhJI1VEJOemfyTJ6I8pC9K3PFUzZTlWbH3/77YphVDL+ddjrfwqiasHcvOp3zLzNrS3O4s8PLsqdKkDhfzkeml6hiJ8WOZTp+ErNpBhpwVgIOuBFI3BRpmE7AGkJYskSVM5YopVMhkaliVvIJMFkVI9AmdnugNDCBzKGBp7OuVd3KAPuPt69fIaIFtz12nFcmrpdLhYbEItPg9EjZgNUXbiOe7iHvCTmJWcEvcQuFZT9VIrlEtA3IFP/vOY1o1em8rcpSaQsp+8GhcNjpYMvXkKsp4xqof6KKQklWcs0LsCQ6KCbYrOGnSizYKM8DLQ7PZBe5d1bCYafDXshUJF7CgOFXpsa+b891RSJh17clJMgXrmuDdMho00wkGdFkyt1+ljlPHJgaTAmJFVfQnvg6ZjOc+FuQKkCQKS1+VtLynLbjCrQVCc+b24YAYldjuSaZL5WQNnz1K7D/8tuDu0eb4vkKQUuRWIWQ1GKAXfG8AuOhmsYsQ6jeQKnBkDj5eUkeU5aBmGQb1+Pp+8rY1sSsMl5wayj8WmGXiLxAZBvz3AAT4xYtC34JjdWYovOU5z329YylMOZVbmMmkOOsrqDHXinLeFnmIuF4uqCIovBwPP+6tMueHTwgkhe0x8daXYkU8KBLxXgMGoUTG2kKPyZAh3xW0gBEjyTHZnQ6LG10onKlV1mIPrfpyBIlLUjbY0dXXOQEvEPWMCGTvEqBjXKeXMZ0B8RM4ymNuzIDvEJix+/UBS8KR3OiDzOQIxcqifBL5ZfHo99DleKBjedzkCdsDKSmRYRpUtVL7VjhykiCIGIMCi7ymAgXs/dqxKywOcQosCWXs5il3ELMLFzbkbqOWZJBckl/aZ4KxUaVtUo6xFKtylRNpaflWElrxM9rJDK0fDhFhzHbi9nTmB3EbNCP2WAYs8FezAZPYzY4iNmwH7PhMGbDvZgNnzqwhgee1rwmcBOAwdBR2X4+1MVz96UwJNl4YJr6DJ62zuBBj3U6tTThtx9//PFM3pxJxs4iFK6z6JCdRXWXsyh2bXhmYtvA/77GH7vDZ/7nDH8+HR74n1PqOtjzPzP8ORycyblf8EwOCRLLi/IWKLD5QSHwvzwT4TdaFL+F8ww/4kEUhwbcqxY82DBv4rKLuAgprOC52YxO6PGIMFqAtILUHiJF7LoZI2p+ROg04cEWOiZdEx2rjaYg8ATFcAX7/Z6/WTYj75Z9NLg3wPk01J8i6ng0neDRtBn/+vR6RERYhunTKPGsRwoAncyb6eA7PCIqtCH6NBocIA3wUtpMAGx9RNg3wMEGf8O7tv5ed7DfHfaHey0KoG3kOhRFN027s9nsIaiHOo9fHlWeoKE6zQ7N17FWxRrzg6yDRS+vE9HfQWX/Myrqo6DDQop2HxkWQWOpLb6mlm1VymdfGDdVGForZ9h/oZrNGmBSE8JB1m+SKZF44LFPUMlGaOD1kAZdouROmu40KIkf07RbFN2lj/izS4RvfCyKXpr2lnqu7I77WLA0jdnq57Xf05QVRbHhs/ve+rxTFKtY9IrCw0bK11c9cqqQzrZZTnyH30pUFhLRXvhWMULPAXpIsIHMufVytHTZZEL6Bs9UbKmDhkmVcw3XaJcaoaTr/fAyFkRsodmTHUsmoPMcESnYl6+99v7Esz+i0J4Av9w9bgUznOSIJZWxqmAaJnDNSm4taEmTXfFcpM7N1KUPcM2LEk2Anb+cnaX//E875IBAG986X1UqJgL9QDt/OT3q/vf5mh5VWYJOuAGWA65kYgY26bHTDPJy4YqaTqe96a5JMqVy54d6bzSM3b8XavT+gsAte9yUT9Zh6lijYfAj6yzb+wZsi2LcsDByjclPPEYyNOjTbevtnVuuW9/jEd04SyBho/OeYPPpWVRwUkiQlWHxt7IZ6LPovB7jjHxI7xh7fg9hzUQKOR9Bvtp0b0GrP+d8piov38Gp1UbVc3SDbthQCFn7LQidftxo5NdLja5tvka+HUGa0hmunCCeYQdYLkzw3LTJ2RztXVvkcJQA5MNE57UfwEY1l36yFNSA3U8M3Enk9+6OJbAfo461WzGsdscKrY1pEgbnKIQURVXU/tFxPWsgWeF1jya9cCQ6+8MKzd1dWYFf37ECOiM3L3AmB+THCP6PWzRT3+MRnRVLIN0uxh9zirTu6Qe6YO8WwIBWUwDXXMvY1V3ItfCZzdLXY6/xekOfrBuEXrYkgdKiR+5TRbMG+d43FPmsmn64zZzX7PWIuG8NWL8yB/p+D337fBSTNrH/jBi1Bfa9mdU5JQs+ucVyp+ZHxJ4enhUnRKdzrGEs8rzxpMjCp/Cyg086kEPhn738YyJedeQIF9IqNAvCs+0IxvReaukZpflu7e4Zt6XNN1H3QKw0y7hx+jcp/LhV+GCLj9tLrvgA2sIdL2SAG3dl8HB24/CrfnOfBk/3W/u032/tU3/TPt1iNuIOmlJJU/vaYNHUkGva4vB99WpZFtswKW7pc4lvK8F6cMKgqjxlubikV5VUmDLnM9zVIKUeyuXnum8ypcyih38x+9IjfNh+iVMaH+Oe9OqHifs4vJY2o7EXg2e7ja3YPzhoS0xLYO5jvy/WW92F/t7OYH/HebTWO7QWbpjNh/AtmgBj99kv8hPda7+o52LDtm6nj3U7PQy77z6k1T14NmxdFrv9j70sHty4bkrNHWb1QxjPD2bFNsXtnvbrb2ZHfjr37f0aGvXg2W6TC58NHsCFukFx/lROXNGPH4z32EMpx+sY8B7a8a0q8SczaBPYX51J9x9Gkx70WxraVy0F7athkyn39+/FlM1FlzjrLBL/+fXrN9P+n76bqKOjo6NXb99lz99Njo6OCvzd6/XWGlHrdpuWQc3VRwT6e5nu+A2r9Ho9JGHKLT+k4TulnPzRjY83j+n51+dfybOz/xCPKWscOJ9+CtRdfz9vza8n558qgVEcqZKCpJV8kUaHkQtCDkHAUUymJRj7tUpn0eFN5MPG8E8flIVDd94bjOO+iUySQcHxr2CSYuT3WOQ4FUY+gTZRHFEcAYaBI9dFh5EavYfERjG+cZXoiACDc9C4w5vQy4XLRrFXwqPDyHF9FEf+paf+xEAmCt9uy3QczcOCt01Vf1lMZeiPOiIa58GI1I+chobOlyLfP2qm5gzzBVkXk3Gt+SxaDrIPoajhHdGNq2Pt8lm4HIRFV0gdH0ndojgSFormKhs2TasPp3QCCjGhGKMPHUvbwosPXhPHlZmSHzXQex/W0PyeVHKtqwu3t+wIgxwhDVppdxGtGzOKmOvdxTGhP2HLJ8013RvByponm6K4G8GjJiNTlJclcN2jYOqPjtOnvA6eJxVlHdTHYguzGtQas8E8jq7vRuaaJaobQsTZlzmMrXvSZYnSEvSTZpzIo0FuuLc3j6PZ3ejNPkv0nuHmTe/G7geKrV/kHfwesO4ezOMouxvW7+vo/98R2L2n88VdF7lspTofaaTS2UU4t+Z3dQyXCvbDXJQX8rVOQTcIMVIqBy5XKPFi7Lzrin2BFscXsQukoKBtoU24UNgUHcwaEsAEEIqvCmcV8zqHi+hmPpAWnfLP8QOpSaYaGewlw3zGTTgCZrWYTAB9zr4HDfZh6cCTDJNrfHgHHwcvW6nhSqjKBPDQEY3BfjlYSnkCoevEpZZV1KAOububuPeau4Nf8JLDjC14fXJ8D1qSydZ1iVbunnZYujnY65NjTIURY6+G9dg7U1MikJa3ujBUi9iV4CFcvj7bZ+7xGZzfUbncsaaPvueTULpsFaBUmLUQxS6FD+P06yS+lYkXuVK4Raqy6PMXPgPAWChNi44ERU3IE1XdhyvvoCRnk4pi/SyKbMiLoXCfRSqLkC5ZkPT9tNIhe8ezBfbExL0FnQJVsFNjfszaM244Z2NuLObeVVIg5XWF2n09JVyXoAXIBNaSQIMjHSYR3q1NtPNC3r156TPkAg5BKEcogW5iSFlVEteQJNT5SmHnllFfUZRQOkBfbFLQVlUPyiryrogStFESzRWlJ1yKnx0Lk0aC1s4IMp67rv6oQJc1woMS3gYmnLW//O0fDbg2apyrgLkVeJpiMNodEJJJ5xgeNW4NJZ6Aqg0Rzgf635YvAYSOhObCJVw6QTL35/FjCl8z9bno39Dq9ztTJRkq+PV5a+JwxhqvVhqyEcmQpEe4EvGFa2FsI+MmxMWung9vAOmYNGAgNQSlGnlezpoCvnhXVEvTUV6QaGdr1dfgiizwyqoLDYWQ97unml4xq+qDoLKq4FYkLExleu0cPPf0EuS6YF8G0JAbr4TSTzaIKk53oWQCF0JeYMLtPRS8V3UcT8pnyNx2CiCbsAUiuetskSc1pVzmJk0atxNlAzah3EfzwD2errNdbjckAz+4q4RybYsRPuK7Z2AUNTo41MKWbBtDn4s15d9Dt7bUZ2RsDPr9/8u21G7/87Gl9vqfkS11gMB69+ndB9Am/Wbt2RHcwbcPeK/IaUOO3Nt7opd1HtfO63UEXojDcO7+W5h/4dy/wyR0NuPCrevNmYAMkWHY7+P/lg7BUFHCl89o1dT4QxTf36d8xyWwqLxxO72Org6Oi1IWSUYneV2G4/ZRTWbzX4nP3HhkvX8NEIj0X9prFGBM+8JYs4AvgGJvJ1dzl4TMhYSLsAUXS857t8176/bkrSrAZqTMoRo/1QrrUJQ5YKaD1TPGJ1xIhtPoB9wi0PouZv4wyG6jxl6/fzGoibC/SoQXkuLrqZLLiboE+dti2lzeuuUR1OsiX5wokXCdqD1qIdv87pA0kFRa2Fl0eHoTXXd5Kbqu/fD0fH6OXGgzRY88yhDE3GbRYbSz8uZDBXXwReH0JiK5qJnfcJli8MLKactLsXM16A2iebw8Zu3pfEt/qLofOsRYPhFycte48wWN3uI+uq1qUWqhgZbiT4AqqN+IZq84Esg/GXA0NZD0yB5vFi9lz8Mmhzesdc9Si81cfmgK70ytp6PlW3LNY1DjLeg0PMTQ20r9tBItEIrq5w/8s1bBTxcsW78dBHV3QHricG+PFKpnA9I8dg/oUt97Oj93BG44CykWtenxcmEXLdeN/9R2ZUTRkuugZb8vm+8bTekNlrRfcslirAFZZ6jtt+yjNdQK93ubVhiYgLTa7ROt9vpEq4N+S7XwGC5mWCgIpAXUSgDd9M2LHm/zc+Q/IceKmNdz1OsS5Fv0s+HhQsy/ohBCnqiirqcRBvzyt3/QmGCFO38GzvAHjNd4XWlWqinoceWKc4xzuKZKVTgICmoz9IpIUda8yMEYfFqUFiZUl4py7tCx511HCS/5SOQCT04XSUwhiY3D11Xmwld+bPpCuxTEK8jxwK0t9kaVLzZV+nKMpcNixtkI6+ygzwZkxmXi3EPuFCA3B9qr6HortTBYPkgj1MLBpqTVPLGs4JJPyE8Rt0iVQi7wqGRajdB7alReOf+g5SJX2gWQEUL0wk9BL8+vS2wijRYdaxoy5Nsr7yQ0sXPSOgH3BahG6A8vERaRAPlKKpkrrBWFfvUqz1mprPN1o+LchBGHW82lQW3XwRL2oCaY99+B8VHW7wzgDr8U8tLVN+my05qnfoCRERba2Y/LsvekPeY7Yb+vRlg9SRlhlZ4tRk+EzaoRHdXNSeofbqbvQl2zxkG8mCNViVljAqjE7GCi5s5bsMghZufo+AVd9U/YL3/9O3sJXEuWqanj1qTSkM/aJdTczjuy1Tc1eYh5heXDLDGpnIRHi0DBHzJuf/nr/xj2CqboKUMRcoTsdJZK3ZlO55B9s7a0XcjWcjH06Lbnvk4cy4W87LEjXwnOvW4gM+B3GvcRleBOGqtDYSC/AtOoAAepsK36b9ACxiPXTidA3I7SlJVLKQXoRluA4zxF9ArBncsIC6qtyUJohfu3CwGBTKnklzlkqeZju5g/Xi1Et+ZTSFEI5Ij9NPWWOEks22q6cVE0S0pE+6zVMAYqhmfaFfpK4dnpNLAla6cVfzhbO5NRWp6QChsuSF6KtY5mLHhmXo/fgr4SSbByNkj0DnXeieIoFwl4+9XfXUffHb9kV7u9fhQ3VLN7CPfOyxffPH/19jkCgwepI9ig1+/1yThTxhZcNlZakp3le60RobStKrmtKrmtKrmtKrmtKrmtKrmtKrmtKvmoqLutKrmtKrmtKrmtKrmtKrmtKrmtKrmtKrmtKrmtKrmtKrmtKrmtKrmtKrmtKrmtKrmtKvlYzoptVcnHUqxvW1Xyt+DAbVXJbVXJbVXJbVXJbVXJbVXJbVXJbVXJD3ZebatKbqtKbqtKbqtKbqtKbqtKbqtK/j+tKtnIitopcy4oedHn2Lq8w9PlWpPncZRhYuLhaXRzg5z3TufzOX7+qaIcrNPzOLriWmDEFuU0xiEFD/OwLmEWHUbfuAC07gmuH7uNpvj3pVROzCF0I44I91v7NnMnj1+/PYniaOTrYRYqpRRsPsW8LT51qWuN5C76dhPlXE4qSgyL3JxzV7Ika6ccXlLKof+jkV3G5awBYTsX0aGB/yJSawfc3Lh0xvm87u+aNo7whA29cf/O5/P5/wKDceTJ",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},b=void 0,g={},y=[];function j(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Public Template"}),"\n",(0,i.jsx)(o(),{method:"post",path:"/publictemplate",context:"endpoint"}),"\n",(0,i.jsxs)(n.p,{children:["The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique ",(0,i.jsx)(n.strong,{children:"template_id"})," and a ",(0,i.jsx)(n.strong,{children:"public_url"}),". The ",(0,i.jsx)(n.strong,{children:"public_url"})," is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing."]}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,i.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document before it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date"\n "page": 1\n "x": 173\n "y": 588\n "w": 114\n "h": 21\n "options": {\n "name": "date"\n "response": "04/15/2024"\n "format": "mm/dd/yyyy"\n "color": "black"\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 528,\n "w": 114,\n "h": 21,\n "options": {\n "name": "dropdown",\n "values": ["male", "female", "other"],\n "response": "female",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(d(),{parameters:void 0}),"\n",(0,i.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"sample note"},description:{type:"string",format:"string",example:"sample description"},signers:{type:"array",description:"You can provide signer optionally if you it as default signer",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:""},name:{type:"string",format:"string",example:""},phone:{type:"string",format:"string",example:""},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"createtemplate_body_signers"}},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5},prefill:{type:"object",description:"You can provide widgets which can embed before sending to signer",properties:{widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"textbox"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:100},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},title:"createtemplate_body"}}},required:!0}}),"\n",(0,i.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Template created successfully!",content:{"application/json":{schema:{type:"object",properties:{template_id:{type:"string",example:"Av8Pmpnmch"},public_url:{type:"string",example:"https://app.example.com/publicsign?templateid=Av8Pmpnmch"},message:{type:"string",example:"Public template created successfully!"}},title:"inline_response_publictemplate"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function f(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/03e06346.273c75f9.js b/assets/js/03e06346.273c75f9.js new file mode 100644 index 000000000..11920ccdb --- /dev/null +++ b/assets/js/03e06346.273c75f9.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3404],{48329:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>g,contentTitle:()=>b,default:()=>f,frontMatter:()=>x,metadata:()=>i,toc:()=>j});const i=JSON.parse('{"id":"API-docs/v1.1/publictemplate","title":"Public Template","description":"The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique **template_id** and a **public_url**. The **public_url** is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing.","source":"@site/docs/API-docs/v1.1/publictemplate.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/publictemplate","permalink":"/docs/API-docs/v1.1/publictemplate","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"publictemplate","title":"Public Template","description":"The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique **template_id** and a **public_url**. The **public_url** is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing.","sidebar_label":"Public Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztPF1zGzeSfwU3tVWJeUOKpCRb0dbVnZJ4E996bZUtX+pO0irgTJMDawaYABhRjIpV+7D/4J7udX9afslVN4DhDD8k2VYS+Y55cMTBV3ejG+hudPdNZPnERIen0QkUZc4tmOg8jlIwiRalFUpGh9FJBuy4GuUiYaEXOzp+wXieq6lhlQFtmFUs0YBNNszEbMYtM6CvgHHDRnkFpRbSGjZWmk1AguZWyAlLVVIVgA1TYTNWakhhLCSkzFhdJbbSYHrshwwk4/X0TBhmqiQBY8ZVns/88mnMbObg02ArLQ3jrJLipwpYpxMGX4i002FcpoyzTqck5C4qnXc6PYbotr/hUu53PmOclhSjHGh8wWdsBMxkXEPq4OdyRkSJGUg+yhFDm0GBJPJIu6FGTGQD9xE3kDIlCf4AaI99r6ZwhZM1PzNhDeRjlnAplUUACpWKsYCU2UyrapIxmwnD3r15+UcmLPZjSuYEaoXL4A6EpR3lhJI1VEJOemfyTJ6I8pC9K3PFUzZTlWbH3/5pMcwqht9OO51vYVRN2LsXnc75l5m1pTnc2eFl2VMlSJwv5yPTS1Sxk2LHMh0/idk0Aw04KwEH3Agkboo0TCdgDSEsWaLKGUuU0qmQyFQxK/kEmKyKEWgTuz1QGphA5tDA01nXqm5lgP3729evENGC2x47zisT18ulQkNikWlweqRswOoLtxFP95D3hJzErOCXuIXCsp8qkVwi2gZkiv/3nEa06nTeVmWptIWU/eBQOOx0sOVryNWUcQ3UP1FFoSQrueYFWBIdFBNs1vBTJRZslOeBFodnsovcOyvhsNNhL2QqEi9hwPArU2Pft+e6IpGw69sSEuQL17VBOmS0aSaSjGgy5W4/y5wnDkwNpoTEiitoT3wdsxlO/C1IFSDIlBY/K2l5TttxBdqKhOfNbUMAsauxXJPMl0pIG776Fdh/+u3B3aNN8XyFoKVIrEJIajHArnhegfFQTWOWIVRvoNRgSJz8vCSPKctATLKN6/H0fWVsa2JWGS+4NRR+rbBLRF4gso15boCJcYuWBb+ExmpM0XnK8x77esZSGPMqtzETyHFWV9Bjr5RlvCxzkXA8XVBEUXg4nn9d2mXPDh4QyQva42OtrkQKeNClYjwGjcKJjTSFHxOgQz4raQCiR5JjMzodljY6UbnSqyxEn9t0ZImSFqTtsaMrLnIC3iFrmJBJXqXARjlPLmO6A2Km8ZTGXZkBXiGx43fqgheFoznRhxnIkQuVRPil8svj0e+hSvHAxvM5yBM2BlLTIsI0qeqldqxwZSRBEDEGBRd5TISL2Xs1YlbYHGIU2JLLWcxSbiFmFq7tSF3HLMkguaS/NE+FYqPKWiUdYqlWZaqm0tNyrKQ14uc1EhlaPpyiw5jtxexpzA5iNujHbDCM2WAvZoOnMRscxGzYj9lwGLPhXsyGTx1YwwNPa14TuAnAYOiobD8f6uK5+1IYkmw8ME19Bk9bZ/CgxzqdWprw248//ngmb84kY2cRCtdZdMjOorrLWRS7NjwzsW3gf1/jj93hM/9zhj+fDg/8zyl1Hez5nxn+HA7O5NwveCaHBInlRXkLFNj8oBD4X56J8Bstit/CeYYf8SCKQwPuVQsebJg3cdlFXIQUVvDcbEYn9HhEGC1AWkFqD5Eidt2METU/InSa8GALHZOuiY7VRlMQeIJiuIL9fs/fLJuRd8s+Gtwb4Hwa6k8RdTyaTvBo2ox/fXo9IiIsw/RplHjWIwWATubNdPAdHhEV2hB9Gg0OkAZ4KW0mALY+Iuwb4GCDv+FdW3+vO9jvDvvDvRYF0DZyHYqim6bd2Wz2ENRDnccvjypP0FCdZofm61irYo35QdbBopfXiejvoLL/BRX1UdBhIUW7jwyLoLHUFl9Ty7Yq5bMvjJsqDK2VM+y/UM1mDTCpCeEg6zfJlEg88NgnqGQjNPB6SIMuUXInTXcalMSPadotiu7SR/zZJcI3PhZFL017Sz1Xdsd9LFiaxmz189rvacqKotjw2X1vfd4pilUsekXhYSPl66seOVVIZ9ssJ77DbyUqC4loL3yrGKHnAD0k2EDm3Ho5WrpsMiF9g2cqttRBw6TKuYZrtEuNUNL1fngZCyK20OzJjiUT0HmOiBTsy9dee3/i2R9RaE+AX+4et4IZTnLEkspYVTANE7hmJbcWtKTJrnguUudm6tIHuOZFiSbAzl/PztJ//sMOOSDQxrfOV5WKiUA/0M5fT4+6/3W+pkdVlqATboDlgCuZmIFNeuw0g7xcuKKm02lvumuSTKnc+aHeGw1j9++FGr2/IHDLHjflk3WYOtZoGPzIOsv2vgHbohg3LIxcY/ITj5EMDfp023p755br1vd4RDfOEkjY6Lwn2Hx6FhWcFBJkZVj8rWwG+iw6r8c4Ix/SO8ae30NYM5FCzkeQrzbdW9DqzzmfqcrLd3BqtVH1HN2gGzYUQtZ+C0KnHzca+fVSo2ubr5FvR5CmdIYrJ4hn2AGWCxM8N21yNkd71xY5HCUA+TDRee0HsFHNpZ8sBTVg9xMDdxL5vbtjCezHqGPtVgyr3bFCa2OahME5CiFFURW1f3RczxpIVnjdo0kvHInO/rBCc3dXVuDXd6yAzsjNC5zJAfkxgv/jFs3U93hEZ8USSLeL8cecIq17+oEu2LsFMKDVFMA11zJ2dRdyLXxms/T12Gu83tAn6wahly1JoLTokftU0axBvvcNRT6rph9uM+c1ez0i7lsD1q/Mgb7fQ98+H8WkTew/I0ZtgX1vZnVOyYJPbrHcqfkRsaeHZ8UJ0ekcaxiLPG88KbLwKbzs4JMO5FD4Zy//mIhXHTnChbQKzYLwbDuCMb2XWnpGab5bu3vGbWnzTdQ9ECvNMm6c/k0KP24VPtji4/aSKz6AtnDHCxngxl0ZPJzdOPyq39ynwdP91j7t91v71N+0T7eYjbiDplTS1L42WDQ15Jq2OHxfvVqWxTZMilv6XOLbSrAenDCoKk9ZLi7pVSUVpsz5DHc1SKmHcvm57ptMKbPo4V/MvvQIH7Zf4pTGx7gnvfph4j4Or6XNaOzF4NluYyv2Dw7aEtMSmPvY74v1Vnehv7cz2N9xHq31Dq2FG2bzIXyLJsDYffaL/ET32i/qudiwrdvpY91OD8Puuw9pdQ+eDVuXxW7/Yy+LBzeum1Jzh1n9EMbzg1mxTXG7p/36m9mRn859e7+GRj14ttvkwmeDB3ChblCcP5UTV/TjB+M99lDK8ToGvId2fKtK/MkM2gT2V2fS/YfRpAf9lob2VUtB+2rYZMr9/XsxZXPRJc46i8R/fP36zbT/5+8m6ujo6OjV23fZ83eTo6OjAn/3er21RtS63aZlUHP1EYH+XqY7fsMqvV4PSZhyyw9p+E4pJ3904+PNY3r+9flX8uzsP8RjyhoHzqefAnXX389b8+vJ+adKYBRHqqQgaSVfpNFh5IKQQxBwFJNpCcZ+rdJZdHgT+bAx/NMHZeHQnfcG47hvIpNkUHD8K5ikGPk9FjlOhZFPoE0URxRHgGHgyHXRYaRG7yGxUYxvXCU6IsDgHDTu8Cb0cuGyUeyV8OgwclwfxZF/6ak/MZCJwrfbMh1H87DgbVPVXxZTGfqjjojGeTAi9SOnoaHzpcj3j5qpOcN8QdbFZFxrPouWg+xDKGp4R3Tj6li7fBYuB2HRFVLHR1K3KI6EhaK5yoZN0+rDKZ2AQkwoxuhDx9K28OKD18RxZabkRw303oc1NL8nlVzr6sLtLTvCIEdIg1baXUTrxowi5np3cUzoT9jySXNN90awsubJpijuRvCoycgU5WUJXPcomPqj4/Qpr4PnSUVZB/Wx2MKsBrXGbDCPo+u7kblmieqGEHH2ZQ5j6550WaK0BP2kGSfyaJAb7u3N42h2N3qzzxK9Z7h507ux+4Fi6xd5B78HrLsH8zjK7ob1+zr6/3cEdu/pfHHXRS5bqc5HGql0dhHOrfldHcOlgv0wF+WFfK1T0A1CjJTKgcsVSrwYO++6Yl+gxfFF7AIpKGhbaBMuFDZFB7OGBDABhOKrwlnFvM7hIrqZD6RFp/xz/EBqkqlGBnvJMJ9xE46AWS0mE0Cfs+9Bg31YOvAkw+QaH97Bx8HLVmq4EqoyATx0RGOwXw6WUp5A6DpxqWUVNahD7u4m7r3m7uAXvOQwYwtenxzfg5ZksnVdopW7px2Wbg72+uQYU2HE2KthPfbO1JQIpOWtLgzVInYleAiXr8/2mXt8Bud3VC53rOmj7/kklC5bBSgVZi1EsUvhwzj9OolvZeJFrhRukaos+vyFzwAwFkrToiNBURPyRFX34co7KMnZpKJYP4siG/JiKNxnkcoipEsWJH0/rXTI3vFsgT0xcW9Bp0AV7NSYH7P2jBvO2Zgbi7l3lRRIeV2hdl9PCdclaAEygbUk0OBIh0mEd2sT7byQd29e+gy5gEMQyhFKoJsYUlaVxDUkCXW+Uti5ZdRXFCWUDtAXmxS0VdWDsoq8K6IEbZREc0XpCZfiZ8fCpJGgtTOCjOeuqz8q0GWN8KCEt4EJZ+0vf/9HA66NGucqYG4FnqYYjHYHhGTSOYZHjVtDiSegakOE84H+t+VLAKEjoblwCZdOkMz9efyYwtdMfS76N7T6/c5USYYKfn3emjicscarlYZsRDIk6RGuRHzhWhjbyLgJcbGr58MbQDomDRhIDUGpRp6Xs6aAL94V1dJ0lBck2tla9TW4Igu8supCQyHk/e6pplfMqvogqKwquBUJC1OZXjsHzz29BLku2JcBNOTGK6H0kw2iitNdKJnAhZAXmHB7DwXvVR3Hk/IZMredAsgmbIFI7jpb5ElNKZe5SZPG7UTZgE0o99E8cI+n62yX2w3JwA/uKqFc22KEj/juGRhFjQ4OtbAl28bQ52JN+ffQrS31GRkbg37//7Ittdv/fGypvf5nZEsdILDefXr3AbRJv1l7dgR38O0D3ity2pAj9/ae6GWdx7Xzeh2BF+IwnLv/FuZfOPfvMAmdzbhw63pzJiBDZBj2+/i/pUMwVJTw5TNaNTX+KYrv71O+4xJYVN64nV5HVwfHRSmLJKOTvC7DcfuoJrP5r8Rnbjyy3r8GCET6L+01CjCmfWGsWcAXQLG3k6u5S0LmQsJF2IKLJee92+a9dXvyVhVgM1LmUI2faoV1KMocMNPB6hnjEy4kw2n0A24RaH0XM38YZLdRY6/fvxjURNhfJcILSfH1VMnlRF2C/G0xbS5v3fII6nWRL06USLhO1B61kG1+d0gaSCot7Cw6PL2Jrru8FF3Xfnh6Pj9HLrSZokceZQhibrPoMNpZefOhgjr4onB6E5Fc1MxvuEwxeGHltOWl2Lka9AbRPF4es/Z0vqU/VN0PHWIsnwg5uWvc+YJGb3Ef3Va1KLXQQEvxZ0AV1G9Es1ccCeSfDDiaGkh6ZI83i5ey52GTwxvWumepxWYuPzSFd6bW09HyLbnmMajxFnQaHmLobaV+WokWCEX18wf+WavgpwuWrd8Ogro7ID1xuLdHCtWzAWkeuwd0qe89nZ87AjechRSL2vR4ubCLluvGf2q7MqJoyXXQst+XzfeNpvQGS9ovuWQx1oCsM9T2W/bRGmqF+71NKwxMQFrt9olWe32i1UG/pVp4DBczLBQE0gJqJYBu+uZFj7f5OfKfkGNFzOs56nUJ8i362fBwIeZfUQghT1RR19PodMKQX/7+j3pUp1Ob487BiDEbryvNSjUFPa5cgY5xDtdUrQqHQUFthl4SKdKaFzkYg8+L0sKEalNR3h0697z7KOElH4lc4OnpookpLLFxALvqXPjSj01faJeGeAU5Hrq11d6o9MWmSl+OsXxYzDgbYa0d9NuAzLhMnIvInQTk6kCbFd1vpRYGSwhphFo42JS0mieWFVzyCfkqYtYkVgq5wOOSaTVCD6pReeV8hJaLXGkXREYI0Ss/EfH5dYlNpNWic01Dhrx75R2FJnaOWifkvgjVCH3iJcIiEiB/SSVzhfWi0Lde5TkrlXX+blSemzDicKu5NKjxOljCHtQE8z48MD7S+p0B3OGXQl66Gidddlrz1Q8wMsJCOwNyWf6etMd8J+z31QgrKCkjrNKzxeiJsFk1ouO6OUn9w830Xaht1jiMF3OkKjFrzACVmB1M1tx5CxY5xOwcHb+g6/4J++Vv/81eAteSZWrquDWpNOSzdhk1t/OObPVtTV5iXmEJMUtMKifh4SJQ8IeM21/+9j+GvYIpesucSLnIjaVyd6bTOWTfrC1vFzK2XBw9uu65rxXHciEve+zIV4NzLxzIDPidxn1ENbiTxupQGMivwDSqwEEqbKsGHLSA8ci1UwoQt6M0ZeVSWgG60hbgOG8RvURw5zbComprMhFaIf/tYkAgUyr7ZQ5ZqvnYLuaPV4vRrfkU0hQCOWI/Tb0lThLLtqpuXCTNkiLRPm81jIEK4pl2lb5SeHY6DWzJ2qnFH87WzmyUliekxoZLkpdirbMZi56Z1+O3oK9EEiydDRK9Q513ojjKRQLehvX319F3xy/Z1W6vH8UN9ewewr3z8sU3z1+9fY7A4EHqCDbo9Xt9MtCUsQWXjZWWZGf5bmtEKW0rS24rS24rS24rS24rS24rS24rS24rSz4q6m4rS24rS24rS24rS24rS24rS24rS24rS24rS24rS24rS24rS24rS24rS24rS24rS24rSz6Ws2JbWfKxFOzbVpb8LThwW1lyW1lyW1lyW1lyW1lyW1lyW1lyW1nyg51X28qS28qS28qS28qS28qS28qS28qS/08rSzYyo3bKnAtKYPR5ti738HS53uR5HGWYnHh4Gt3cIOe90/l8jp9/qigP6/Q8jq64FhixRXmNcUjDw1ysS5hFh9E3LgCte4Lrx26jKf59KZ0T8wjdiCPC/da+zfzJ49dvT6I4GvmamIVKKQ2bTzF3i09d+lojwYu+3UQ5l5OKksMiN+fclS3J2mmHl5R26P9oZJhxOWtA2M5HdGjgv4jU2gE3Ny6lcT6v+7umjSM8YUNv3L/z+Xz+v29n5X4=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Template","permalink":"/docs/API-docs/v1.1/createtemplate"},"next":{"title":"Get Template","permalink":"/docs/API-docs/v1.1/get-template"}}');var s=t(74848),r=t(28453),l=t(33617),o=t.n(l),a=t(17543),d=t.n(a),c=t(86013),p=t.n(c),h=t(63723),u=t.n(h),m=(t(18766),t(79329),t(9303));const x={id:"publictemplate",title:"Public Template",description:"The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique **template_id** and a **public_url**. The **public_url** is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing.",sidebar_label:"Public Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztPF1zGzeSfwU3tVWJeUOKpCRb0dbVnZJ4E996bZUtX+pO0irgTJMDawaYABhRjIpV+7D/4J7udX9afslVN4DhDD8k2VYS+Y55cMTBV3ejG+hudPdNZPnERIen0QkUZc4tmOg8jlIwiRalFUpGh9FJBuy4GuUiYaEXOzp+wXieq6lhlQFtmFUs0YBNNszEbMYtM6CvgHHDRnkFpRbSGjZWmk1AguZWyAlLVVIVgA1TYTNWakhhLCSkzFhdJbbSYHrshwwk4/X0TBhmqiQBY8ZVns/88mnMbObg02ArLQ3jrJLipwpYpxMGX4i002FcpoyzTqck5C4qnXc6PYbotr/hUu53PmOclhSjHGh8wWdsBMxkXEPq4OdyRkSJGUg+yhFDm0GBJPJIu6FGTGQD9xE3kDIlCf4AaI99r6ZwhZM1PzNhDeRjlnAplUUACpWKsYCU2UyrapIxmwnD3r15+UcmLPZjSuYEaoXL4A6EpR3lhJI1VEJOemfyTJ6I8pC9K3PFUzZTlWbH3/5pMcwqht9OO51vYVRN2LsXnc75l5m1pTnc2eFl2VMlSJwv5yPTS1Sxk2LHMh0/idk0Aw04KwEH3Agkboo0TCdgDSEsWaLKGUuU0qmQyFQxK/kEmKyKEWgTuz1QGphA5tDA01nXqm5lgP3729evENGC2x47zisT18ulQkNikWlweqRswOoLtxFP95D3hJzErOCXuIXCsp8qkVwi2gZkiv/3nEa06nTeVmWptIWU/eBQOOx0sOVryNWUcQ3UP1FFoSQrueYFWBIdFBNs1vBTJRZslOeBFodnsovcOyvhsNNhL2QqEi9hwPArU2Pft+e6IpGw69sSEuQL17VBOmS0aSaSjGgy5W4/y5wnDkwNpoTEiitoT3wdsxlO/C1IFSDIlBY/K2l5TttxBdqKhOfNbUMAsauxXJPMl0pIG776Fdh/+u3B3aNN8XyFoKVIrEJIajHArnhegfFQTWOWIVRvoNRgSJz8vCSPKctATLKN6/H0fWVsa2JWGS+4NRR+rbBLRF4gso15boCJcYuWBb+ExmpM0XnK8x77esZSGPMqtzETyHFWV9Bjr5RlvCxzkXA8XVBEUXg4nn9d2mXPDh4QyQva42OtrkQKeNClYjwGjcKJjTSFHxOgQz4raQCiR5JjMzodljY6UbnSqyxEn9t0ZImSFqTtsaMrLnIC3iFrmJBJXqXARjlPLmO6A2Km8ZTGXZkBXiGx43fqgheFoznRhxnIkQuVRPil8svj0e+hSvHAxvM5yBM2BlLTIsI0qeqldqxwZSRBEDEGBRd5TISL2Xs1YlbYHGIU2JLLWcxSbiFmFq7tSF3HLMkguaS/NE+FYqPKWiUdYqlWZaqm0tNyrKQ14uc1EhlaPpyiw5jtxexpzA5iNujHbDCM2WAvZoOnMRscxGzYj9lwGLPhXsyGTx1YwwNPa14TuAnAYOiobD8f6uK5+1IYkmw8ME19Bk9bZ/CgxzqdWprw248//ngmb84kY2cRCtdZdMjOorrLWRS7NjwzsW3gf1/jj93hM/9zhj+fDg/8zyl1Hez5nxn+HA7O5NwveCaHBInlRXkLFNj8oBD4X56J8Bstit/CeYYf8SCKQwPuVQsebJg3cdlFXIQUVvDcbEYn9HhEGC1AWkFqD5Eidt2METU/InSa8GALHZOuiY7VRlMQeIJiuIL9fs/fLJuRd8s+Gtwb4Hwa6k8RdTyaTvBo2ox/fXo9IiIsw/RplHjWIwWATubNdPAdHhEV2hB9Gg0OkAZ4KW0mALY+Iuwb4GCDv+FdW3+vO9jvDvvDvRYF0DZyHYqim6bd2Wz2ENRDnccvjypP0FCdZofm61irYo35QdbBopfXiejvoLL/BRX1UdBhIUW7jwyLoLHUFl9Ty7Yq5bMvjJsqDK2VM+y/UM1mDTCpCeEg6zfJlEg88NgnqGQjNPB6SIMuUXInTXcalMSPadotiu7SR/zZJcI3PhZFL017Sz1Xdsd9LFiaxmz189rvacqKotjw2X1vfd4pilUsekXhYSPl66seOVVIZ9ssJ77DbyUqC4loL3yrGKHnAD0k2EDm3Ho5WrpsMiF9g2cqttRBw6TKuYZrtEuNUNL1fngZCyK20OzJjiUT0HmOiBTsy9dee3/i2R9RaE+AX+4et4IZTnLEkspYVTANE7hmJbcWtKTJrnguUudm6tIHuOZFiSbAzl/PztJ//sMOOSDQxrfOV5WKiUA/0M5fT4+6/3W+pkdVlqATboDlgCuZmIFNeuw0g7xcuKKm02lvumuSTKnc+aHeGw1j9++FGr2/IHDLHjflk3WYOtZoGPzIOsv2vgHbohg3LIxcY/ITj5EMDfp023p755br1vd4RDfOEkjY6Lwn2Hx6FhWcFBJkZVj8rWwG+iw6r8c4Ix/SO8ae30NYM5FCzkeQrzbdW9DqzzmfqcrLd3BqtVH1HN2gGzYUQtZ+C0KnHzca+fVSo2ubr5FvR5CmdIYrJ4hn2AGWCxM8N21yNkd71xY5HCUA+TDRee0HsFHNpZ8sBTVg9xMDdxL5vbtjCezHqGPtVgyr3bFCa2OahME5CiFFURW1f3RczxpIVnjdo0kvHInO/rBCc3dXVuDXd6yAzsjNC5zJAfkxgv/jFs3U93hEZ8USSLeL8cecIq17+oEu2LsFMKDVFMA11zJ2dRdyLXxms/T12Gu83tAn6wahly1JoLTokftU0axBvvcNRT6rph9uM+c1ez0i7lsD1q/Mgb7fQ98+H8WkTew/I0ZtgX1vZnVOyYJPbrHcqfkRsaeHZ8UJ0ekcaxiLPG88KbLwKbzs4JMO5FD4Zy//mIhXHTnChbQKzYLwbDuCMb2XWnpGab5bu3vGbWnzTdQ9ECvNMm6c/k0KP24VPtji4/aSKz6AtnDHCxngxl0ZPJzdOPyq39ynwdP91j7t91v71N+0T7eYjbiDplTS1L42WDQ15Jq2OHxfvVqWxTZMilv6XOLbSrAenDCoKk9ZLi7pVSUVpsz5DHc1SKmHcvm57ptMKbPo4V/MvvQIH7Zf4pTGx7gnvfph4j4Or6XNaOzF4NluYyv2Dw7aEtMSmPvY74v1Vnehv7cz2N9xHq31Dq2FG2bzIXyLJsDYffaL/ET32i/qudiwrdvpY91OD8Puuw9pdQ+eDVuXxW7/Yy+LBzeum1Jzh1n9EMbzg1mxTXG7p/36m9mRn859e7+GRj14ttvkwmeDB3ChblCcP5UTV/TjB+M99lDK8ToGvId2fKtK/MkM2gT2V2fS/YfRpAf9lob2VUtB+2rYZMr9/XsxZXPRJc46i8R/fP36zbT/5+8m6ujo6OjV23fZ83eTo6OjAn/3er21RtS63aZlUHP1EYH+XqY7fsMqvV4PSZhyyw9p+E4pJ3904+PNY3r+9flX8uzsP8RjyhoHzqefAnXX389b8+vJ+adKYBRHqqQgaSVfpNFh5IKQQxBwFJNpCcZ+rdJZdHgT+bAx/NMHZeHQnfcG47hvIpNkUHD8K5ikGPk9FjlOhZFPoE0URxRHgGHgyHXRYaRG7yGxUYxvXCU6IsDgHDTu8Cb0cuGyUeyV8OgwclwfxZF/6ak/MZCJwrfbMh1H87DgbVPVXxZTGfqjjojGeTAi9SOnoaHzpcj3j5qpOcN8QdbFZFxrPouWg+xDKGp4R3Tj6li7fBYuB2HRFVLHR1K3KI6EhaK5yoZN0+rDKZ2AQkwoxuhDx9K28OKD18RxZabkRw303oc1NL8nlVzr6sLtLTvCIEdIg1baXUTrxowi5np3cUzoT9jySXNN90awsubJpijuRvCoycgU5WUJXPcomPqj4/Qpr4PnSUVZB/Wx2MKsBrXGbDCPo+u7kblmieqGEHH2ZQ5j6550WaK0BP2kGSfyaJAb7u3N42h2N3qzzxK9Z7h507ux+4Fi6xd5B78HrLsH8zjK7ob1+zr6/3cEdu/pfHHXRS5bqc5HGql0dhHOrfldHcOlgv0wF+WFfK1T0A1CjJTKgcsVSrwYO++6Yl+gxfFF7AIpKGhbaBMuFDZFB7OGBDABhOKrwlnFvM7hIrqZD6RFp/xz/EBqkqlGBnvJMJ9xE46AWS0mE0Cfs+9Bg31YOvAkw+QaH97Bx8HLVmq4EqoyATx0RGOwXw6WUp5A6DpxqWUVNahD7u4m7r3m7uAXvOQwYwtenxzfg5ZksnVdopW7px2Wbg72+uQYU2HE2KthPfbO1JQIpOWtLgzVInYleAiXr8/2mXt8Bud3VC53rOmj7/kklC5bBSgVZi1EsUvhwzj9OolvZeJFrhRukaos+vyFzwAwFkrToiNBURPyRFX34co7KMnZpKJYP4siG/JiKNxnkcoipEsWJH0/rXTI3vFsgT0xcW9Bp0AV7NSYH7P2jBvO2Zgbi7l3lRRIeV2hdl9PCdclaAEygbUk0OBIh0mEd2sT7byQd29e+gy5gEMQyhFKoJsYUlaVxDUkCXW+Uti5ZdRXFCWUDtAXmxS0VdWDsoq8K6IEbZREc0XpCZfiZ8fCpJGgtTOCjOeuqz8q0GWN8KCEt4EJZ+0vf/9HA66NGucqYG4FnqYYjHYHhGTSOYZHjVtDiSegakOE84H+t+VLAKEjoblwCZdOkMz9efyYwtdMfS76N7T6/c5USYYKfn3emjicscarlYZsRDIk6RGuRHzhWhjbyLgJcbGr58MbQDomDRhIDUGpRp6Xs6aAL94V1dJ0lBck2tla9TW4Igu8supCQyHk/e6pplfMqvogqKwquBUJC1OZXjsHzz29BLku2JcBNOTGK6H0kw2iitNdKJnAhZAXmHB7DwXvVR3Hk/IZMredAsgmbIFI7jpb5ElNKZe5SZPG7UTZgE0o99E8cI+n62yX2w3JwA/uKqFc22KEj/juGRhFjQ4OtbAl28bQ52JN+ffQrS31GRkbg37//7Ittdv/fGypvf5nZEsdILDefXr3AbRJv1l7dgR38O0D3ity2pAj9/ae6GWdx7Xzeh2BF+IwnLv/FuZfOPfvMAmdzbhw63pzJiBDZBj2+/i/pUMwVJTw5TNaNTX+KYrv71O+4xJYVN64nV5HVwfHRSmLJKOTvC7DcfuoJrP5r8Rnbjyy3r8GCET6L+01CjCmfWGsWcAXQLG3k6u5S0LmQsJF2IKLJee92+a9dXvyVhVgM1LmUI2faoV1KMocMNPB6hnjEy4kw2n0A24RaH0XM38YZLdRY6/fvxjURNhfJcILSfH1VMnlRF2C/G0xbS5v3fII6nWRL06USLhO1B61kG1+d0gaSCot7Cw6PL2Jrru8FF3Xfnh6Pj9HLrSZokceZQhibrPoMNpZefOhgjr4onB6E5Fc1MxvuEwxeGHltOWl2Lka9AbRPF4es/Z0vqU/VN0PHWIsnwg5uWvc+YJGb3Ef3Va1KLXQQEvxZ0AV1G9Es1ccCeSfDDiaGkh6ZI83i5ey52GTwxvWumepxWYuPzSFd6bW09HyLbnmMajxFnQaHmLobaV+WokWCEX18wf+WavgpwuWrd8Ogro7ID1xuLdHCtWzAWkeuwd0qe89nZ87AjechRSL2vR4ubCLluvGf2q7MqJoyXXQst+XzfeNpvQGS9ovuWQx1oCsM9T2W/bRGmqF+71NKwxMQFrt9olWe32i1UG/pVp4DBczLBQE0gJqJYBu+uZFj7f5OfKfkGNFzOs56nUJ8i362fBwIeZfUQghT1RR19PodMKQX/7+j3pUp1Ob487BiDEbryvNSjUFPa5cgY5xDtdUrQqHQUFthl4SKdKaFzkYg8+L0sKEalNR3h0697z7KOElH4lc4OnpookpLLFxALvqXPjSj01faJeGeAU5Hrq11d6o9MWmSl+OsXxYzDgbYa0d9NuAzLhMnIvInQTk6kCbFd1vpRYGSwhphFo42JS0mieWFVzyCfkqYtYkVgq5wOOSaTVCD6pReeV8hJaLXGkXREYI0Ss/EfH5dYlNpNWic01Dhrx75R2FJnaOWifkvgjVCH3iJcIiEiB/SSVzhfWi0Lde5TkrlXX+blSemzDicKu5NKjxOljCHtQE8z48MD7S+p0B3OGXQl66Gidddlrz1Q8wMsJCOwNyWf6etMd8J+z31QgrKCkjrNKzxeiJsFk1ouO6OUn9w830Xaht1jiMF3OkKjFrzACVmB1M1tx5CxY5xOwcHb+g6/4J++Vv/81eAteSZWrquDWpNOSzdhk1t/OObPVtTV5iXmEJMUtMKifh4SJQ8IeM21/+9j+GvYIpesucSLnIjaVyd6bTOWTfrC1vFzK2XBw9uu65rxXHciEve+zIV4NzLxzIDPidxn1ENbiTxupQGMivwDSqwEEqbKsGHLSA8ci1UwoQt6M0ZeVSWgG60hbgOG8RvURw5zbComprMhFaIf/tYkAgUyr7ZQ5ZqvnYLuaPV4vRrfkU0hQCOWI/Tb0lThLLtqpuXCTNkiLRPm81jIEK4pl2lb5SeHY6DWzJ2qnFH87WzmyUliekxoZLkpdirbMZi56Z1+O3oK9EEiydDRK9Q513ojjKRQLehvX319F3xy/Z1W6vH8UN9ewewr3z8sU3z1+9fY7A4EHqCDbo9Xt9MtCUsQWXjZWWZGf5bmtEKW0rS24rS24rS24rS24rS24rS24rS24rSz4q6m4rS24rS24rS24rS24rS24rS24rS24rS24rS24rS24rS24rS24rS24rS24rS24rS24rSz6Ws2JbWfKxFOzbVpb8LThwW1lyW1lyW1lyW1lyW1lyW1lyW1lyW1nyg51X28qS28qS28qS28qS28qS28qS28qS/08rSzYyo3bKnAtKYPR5ti738HS53uR5HGWYnHh4Gt3cIOe90/l8jp9/qigP6/Q8jq64FhixRXmNcUjDw1ysS5hFh9E3LgCte4Lrx26jKf59KZ0T8wjdiCPC/da+zfzJ49dvT6I4GvmamIVKKQ2bTzF3i09d+lojwYu+3UQ5l5OKksMiN+fclS3J2mmHl5R26P9oZJhxOWtA2M5HdGjgv4jU2gE3Ny6lcT6v+7umjSM8YUNv3L/z+Xz+v29n5X4=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},b=void 0,g={},j=[];function y(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Public Template"}),"\n",(0,s.jsx)(o(),{method:"post",path:"/publictemplate",context:"endpoint"}),"\n",(0,s.jsxs)(n.p,{children:["The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique ",(0,s.jsx)(n.strong,{children:"template_id"})," and a ",(0,s.jsx)(n.strong,{children:"public_url"}),". The ",(0,s.jsx)(n.strong,{children:"public_url"})," is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing."]}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document before it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date"\n "page": 1\n "x": 173\n "y": 588\n "w": 114\n "h": 21\n "options": {\n "name": "date"\n "response": "04/15/2024"\n "format": "mm/dd/yyyy"\n "color": "black"\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 528,\n "w": 114,\n "h": 21,\n "options": {\n "name": "dropdown",\n "values": ["male", "female", "other"],\n "response": "female",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"sample note"},description:{type:"string",format:"string",example:"sample description"},signers:{type:"array",description:"You can provide signer optionally if you it as default signer",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:""},name:{type:"string",format:"string",example:""},phone:{type:"string",format:"string",example:""},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"createtemplate_body_signers"}},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5},prefill:{type:"object",description:"You can provide widgets which can embed before sending to signer",properties:{widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"textbox"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:100},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},title:"createtemplate_body"}}},required:!0}}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Template created successfully!",content:{"application/json":{schema:{type:"object",properties:{template_id:{type:"string",example:"Av8Pmpnmch"},public_url:{type:"string",example:"https://app.example.com/publicsign?templateid=Av8Pmpnmch"},message:{type:"string",example:"Public template created successfully!"}},title:"inline_response_publictemplate"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function f(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/138cee78.45f63326.js b/assets/js/138cee78.45f63326.js new file mode 100644 index 000000000..e125e744a --- /dev/null +++ b/assets/js/138cee78.45f63326.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1679],{92338:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>x,contentTitle:()=>y,default:()=>P,frontMatter:()=>v,metadata:()=>n,toc:()=>u});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":"eJzVWF9v3MYR/yrTfUlzoO6P5CQon6IahivUiIVIgYDIB2NIzpFrLXc3u8v7g8MBeeg36FNe89H8SYJZkne8k+xWaOGigGGcZmdm5//8llsRsPQivRcvjQ6YBy/miSjI507aII0WqbitCF46wkDQMcHl9RWgUmblYWMaCAZosTAuKPJebSBvuTWtIO/UQqgwQI4aWB49eFlqch4WxrEOB7K2xgXUAQqTNzXp4MciEcaSQ7bkqhCpaDV3SkUiHP3SkA9/NcVGpNsTw6+dWcqCICNlVmDRYU2BHJvbWXhQxL9IB1aC1iqZxzsnHzxr2gqfV1Qj/+IbpaOCY0Y1SiUSobEmjlvYWBKpMNkHikqtY+uDJM+SkSvd9lw+OKlLkYiFcTWGIYXWWFvFTB8Mm09il3SXPV8+I/q+I4xzU7MqWxn9bFNm5xfns4vZxflM7HaJCDJE8lFG3meciB2fH+IUXEOR4K3Rvo3F+XT6OF99dbUqC/BNnpP3i0apzZ+ek6PP56Elczk9LwC2mmXV+vyD5RD+nyfzxexidh7/sYou4JfhKTUHofPp+cXZbHo2/e529m364i/pN9+Op9PpzyIR61odSlwUGKKXfY30fze2+AL37E7ZuuIsKKBUfijQ9/8uluyLp4ryxtQUKqlLWJEOsHJGlwlYRegJgtsAlig1KAzk/otFSs4Z9/kwPc+yYc9KraSm931Hvn8xnb6f7YMw+3RnonKExQZoLX3wX9bdT9nwecdmA8e+eezYlV6ikkVcaLfmgfSX9Wl4fWivf1y+smWK5+LI2SG9ddJT3jgZNiK934r1GVp51p6n9/PdPBFcMYYXqTU+WoyhEqmYnO5VT25Jzkc1jVMiFVUI1qeTiUddZGY9NpY073CFmedRNEErJ8vZmAfKqQxa+yx+as6eK+IDllKX/0pufgjRDaexzdRRoPb5Qiv/Tpt+vadHXImQXD4VYUEu5oyr48cDGnnV53ifxn7674f/U/N8P86P1i3ftjDRtC73by3pG1nqWDnRtVPUdkcqNzUx2AkVwWjUi3z8x+97qdFoD7ZijY/f6Xf6bePAmhW5RaMAdQELRWuZKYpiVMezPfDzhHUH+6QOVDrGVYUsZUAVQR4PqBwtZlJJbg1mMy3kG3SXH8NdRaGiiAa/cgQIBS1JcUcBNsHUGFhVby+sjHtYMARNACFrvNTkPZCuUOfM2Oc5AeMANZAO5KyTnsAHx1bL1jajg+PBUqPGklh3AsNgFaQkNwM4kzU+gDeqiSYD7xPjqIDeIU1U+BjEV2vLR8DU3NTWUcVFuSQoG1mQTyA3BYGPqWcXdAEZ+QCWbZE5eVbaaGXyh5hARkFgDQ8miQrM4shGFg8Oteel39rS52AfMOsMwylqDRyNfvLEGX4j9YNPR6N3+gzu93V1R5mXgeZ/7htstVo9aqyvj2Vey/C3JoMfyRovg3Gbg3QpQ9VksRmHSvZ/tJpek6ZYP4NWO+goTO4f9zZTJxUpO7mhwBXiJ5fXV3GWfw0ff/0nvCF0Giqzaqs1bxypDZT9VRy5NvNt2PajOL5MsAkVRzxvi697bvQRvKswfPz1Nw8/0Aqk7lqKXRmNrptMyRxuqba8gf1olPavqNDTDo+ijMBXyKW0lAgItpVWUj+M4VJvoPHkYCVDFYuB6VHuyA2Oy+HxBBl6KsDoKNHfOT5YxPTak1qSZ13aBDaDCsnYO1TONGV729CYzjlHC6kU3MmipBB9uywKsB151ZI54ANzaMENESraADoCTzqM4fpEJJ40lp+CVHBMY+0bfmtyAkgX1kgdfAqFw8XgrZgcCj0uM2n0E6Q2hLgPR9Kp2aek7cTO4z11/I5H/smaOJ63jhbk+MLo9iEvVnbldN+XJXC1/idlHSF7t6oZZ3TrBK38/lRPxAvkav92cUNuKXPqduYnOnoSmSciEUrmpP1wgV2+vn4Dy4vxVCSD5ftvNPfkzdXLVz/cvGJjeJC2AZuNp+NpfMAYH2rUg5uOvzacrrbtAaD9j79NdEAh0DpMrEIZ4VkMzbZDVvcnXyzmiagYeaX3YrvlBv3Jqd2Oyb805Bi2zROxRCcx4z1/P98lPchgKPZAmw4Jkw5nt3w9s6umxSsnWJVRUitxmedkw2d5h+Dw+u3NrUhE1n1VqU3BMg5X/MUFVyIV8cNMXILxmwjTtkKhLhssI9iJOhkX8QQ9BlUPEVR1P9ir/khvBhYeo63WDf6fnXpSYLttAdtut+dvjz4p0QW25+b0zXe73R+V2qh7","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 account details","permalink":"/docs/API-docs/v1.1/get-user"},"next":{"title":"Get Contact","permalink":"/docs/API-docs/v1.1/getcontact"}}');var o=a(74848),i=a(28453),s=a(33617),c=a.n(s),r=a(17543),l=a.n(r),p=a(86013),d=a.n(p),m=a(63723),f=a.n(m),g=(a(18766),a(79329),a(9303));const v={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:"eJzVWF9v3MYR/yrTfUlzoO6P5CQon6IahivUiIVIgYDIB2NIzpFrLXc3u8v7g8MBeeg36FNe89H8SYJZkne8k+xWaOGigGGcZmdm5//8llsRsPQivRcvjQ6YBy/miSjI507aII0WqbitCF46wkDQMcHl9RWgUmblYWMaCAZosTAuKPJebSBvuTWtIO/UQqgwQI4aWB49eFlqch4WxrEOB7K2xgXUAQqTNzXp4MciEcaSQ7bkqhCpaDV3SkUiHP3SkA9/NcVGpNsTw6+dWcqCICNlVmDRYU2BHJvbWXhQxL9IB1aC1iqZxzsnHzxr2gqfV1Qj/+IbpaOCY0Y1SiUSobEmjlvYWBKpMNkHikqtY+uDJM+SkSvd9lw+OKlLkYiFcTWGIYXWWFvFTB8Mm09il3SXPV8+I/q+I4xzU7MqWxn9bFNm5xfns4vZxflM7HaJCDJE8lFG3meciB2fH+IUXEOR4K3Rvo3F+XT6OF99dbUqC/BNnpP3i0apzZ+ek6PP56Elczk9LwC2mmXV+vyD5RD+nyfzxexidh7/sYou4JfhKTUHofPp+cXZbHo2/e529m364i/pN9+Op9PpzyIR61odSlwUGKKXfY30fze2+AL37E7ZuuIsKKBUfijQ9/8uluyLp4ryxtQUKqlLWJEOsHJGlwlYRegJgtsAlig1KAzk/otFSs4Z9/kwPc+yYc9KraSm931Hvn8xnb6f7YMw+3RnonKExQZoLX3wX9bdT9nwecdmA8e+eezYlV6ikkVcaLfmgfSX9Wl4fWivf1y+smWK5+LI2SG9ddJT3jgZNiK934r1GVp51p6n9/PdPBFcMYYXqTU+WoyhEqmYnO5VT25Jzkc1jVMiFVUI1qeTiUddZGY9NpY073CFmedRNEErJ8vZmAfKqQxa+yx+as6eK+IDllKX/0pufgjRDaexzdRRoPb5Qiv/Tpt+vadHXImQXD4VYUEu5oyr48cDGnnV53ifxn7674f/U/N8P86P1i3ftjDRtC73by3pG1nqWDnRtVPUdkcqNzUx2AkVwWjUi3z8x+97qdFoD7ZijY/f6Xf6bePAmhW5RaMAdQELRWuZKYpiVMezPfDzhHUH+6QOVDrGVYUsZUAVQR4PqBwtZlJJbg1mMy3kG3SXH8NdRaGiiAa/cgQIBS1JcUcBNsHUGFhVby+sjHtYMARNACFrvNTkPZCuUOfM2Oc5AeMANZAO5KyTnsAHx1bL1jajg+PBUqPGklh3AsNgFaQkNwM4kzU+gDeqiSYD7xPjqIDeIU1U+BjEV2vLR8DU3NTWUcVFuSQoG1mQTyA3BYGPqWcXdAEZ+QCWbZE5eVbaaGXyh5hARkFgDQ8miQrM4shGFg8Oteel39rS52AfMOsMwylqDRyNfvLEGX4j9YNPR6N3+gzu93V1R5mXgeZ/7htstVo9aqyvj2Vey/C3JoMfyRovg3Gbg3QpQ9VksRmHSvZ/tJpek6ZYP4NWO+goTO4f9zZTJxUpO7mhwBXiJ5fXV3GWfw0ff/0nvCF0Giqzaqs1bxypDZT9VRy5NvNt2PajOL5MsAkVRzxvi697bvQRvKswfPz1Nw8/0Aqk7lqKXRmNrptMyRxuqba8gf1olPavqNDTDo+ijMBXyKW0lAgItpVWUj+M4VJvoPHkYCVDFYuB6VHuyA2Oy+HxBBl6KsDoKNHfOT5YxPTak1qSZ13aBDaDCsnYO1TONGV729CYzjlHC6kU3MmipBB9uywKsB151ZI54ANzaMENESraADoCTzqM4fpEJJ40lp+CVHBMY+0bfmtyAkgX1kgdfAqFw8XgrZgcCj0uM2n0E6Q2hLgPR9Kp2aek7cTO4z11/I5H/smaOJ63jhbk+MLo9iEvVnbldN+XJXC1/idlHSF7t6oZZ3TrBK38/lRPxAvkav92cUNuKXPqduYnOnoSmSciEUrmpP1wgV2+vn4Dy4vxVCSD5ftvNPfkzdXLVz/cvGJjeJC2AZuNp+NpfMAYH2rUg5uOvzacrrbtAaD9j79NdEAh0DpMrEIZ4VkMzbZDVvcnXyzmiagYeaX3YrvlBv3Jqd2Oyb805Bi2zROxRCcx4z1/P98lPchgKPZAmw4Jkw5nt3w9s6umxSsnWJVRUitxmedkw2d5h+Dw+u3NrUhE1n1VqU3BMg5X/MUFVyIV8cNMXILxmwjTtkKhLhssI9iJOhkX8QQ9BlUPEVR1P9ir/khvBhYeo63WDf6fnXpSYLttAdtut+dvjz4p0QW25+b0zXe73R+V2qh7",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},y=void 0,x={},u=[];function V(e){const t={p:"p",...(0,i.R)(),...e.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)(c(),{method:"post",path:"/createcontact",context:"endpoint"}),"\n",(0,o.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,o.jsx)(g.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,o.jsx)(l(),{parameters:void 0}),"\n",(0,o.jsx)(d(),{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"}},title:"createcontact_body"}}},required:!0}}),"\n",(0,o.jsx)(f(),{id:void 0,label:void 0,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"},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"}}}}}})]})}function P(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(V,{...e})}):V(e)}}}]); \ No newline at end of file diff --git a/assets/js/138cee78.9f7fe758.js b/assets/js/138cee78.9f7fe758.js deleted file mode 100644 index dd2e94156..000000000 --- a/assets/js/138cee78.9f7fe758.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1679],{92338:(t,e,a)=>{a.r(e),a.d(e,{assets:()=>y,contentTitle:()=>x,default:()=>b,frontMatter:()=>T,metadata:()=>n,toc:()=>h});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":"eJzVWM1u3EYSfpVKX7IRqPmRnAThKVrD8Apr2EKkQEDkgVEka8i2mt2d7ub8YDBADnmDnHLdR/OTLKpJznBGshNhAwcLGMaouqq6/utrbkTA0ov0Tjw3OmAevJgloiCfO2mDNFqk4qYieO4IA0HHBBdXl4BKmaWHtWkgGKD53LigyHu1hrzl1rSEvFMLocIAOWpgefTgZanJeZgbxzocyNoaF1AHKEze1KSDH4lEGEsO2ZLLQqSi1dwpFYlw9HNDPvzTFGuRbo4Mv3JmIQuCjJRZgkWHNQVybG5n4V4R/yIdWAlaq2Qe7xy/96xpI3xeUY38i2+UjgqOGdUolUiExpo4bmFtSaTCZO8pKrWOrQ+SPEtGrnTTc/ngpC5FIubG1RiGFFphbRUzvTdsPolt0l32dPmM6PuOMMpNzapsZfSTTZmenZ9Nz6fnZ1Ox3SYiyBDJBxl5l3Eitny+j1NwDUWCt0b7NhZnk8nDfPXV1aoswDd5Tt7PG6XWXzwlR5/OQ0vmcnpaAGw1zarV2XvLIfw/T+az6fn0LP5jFV3AL8JjavZCZ5Oz89Pp5HTy7c30m/TZd+nX34wmk8lPIhGrWu1LXBQYopd9jfR/N7b4DPdsj9m64iwooFR+KND3/zaW7LPHivLa1BQqqUtYkg6wdEaXCVhF6AmCWwOWKDUoDOT+wiIl54z7dJieZtmwZ6VWUtO7viPfPZtM3k13QZh+vDNROcJiDbSSPvjP6+7HbPi0Y9OBY18/dOxSL1DJIi60G3NP+vP6NLw+tNc/LF/ZMsVzceDskN466SlvnAxrkd5txOoUrTxtz9O72XaWCK4Yw4vUGh8txlCJVIyP96ontyDno5rGKZGKKgTr0/HYoy4ysxoZS5p3uMLM8ygao5XjxXTEA+VYBq19Ej81p08V8QFLqcs/kpvtQ3TNaWwzdRCoXb7Qyn/Tul/v6QFXIiSXT0VYkIs54+r4YY9GXvQ53qWxn/674f/YPN+N84N1y7fNTTSty/0bS/paljpWTnTtGLXdkspNTQx2QkXQC3z49T9RpsdYsbSjhi/e6rf6TePAmiW5eaMAdQFzRSuZKYpCVMezHejzhHUH+aQOVDrGVIUsZUAVAR4PpxwtZlJJbgtmMy3cG3SWH8FtRaGiiAS/dAQIBS1IcTcBNsHUGFhVbzQsjbufM/xMACFrvNTkPZCuUOfM2Oc4AeMANZAO5KyTnsAHx1bL1jajg+OhUqPGklh3chCqgpTkRgBnssYH8EY10WTgXWIcFdA7pIkKP+IgvlhZPgKm5qa2jiouyAVB2ciCfAK5KQh8TDu7oAvIyAewbIvMybPSRiuT38fkMQICa3goSVRg5gc2snhwqD0v/NaWPge7gFlnGEpRa+DJyY+eOMOvpL736cnJW30Kd7uauqXMy0Czf/TNtVwuHzTVV4cyL2X4V5PBD2SNl8G49V66lKFqstiIQyW7P1pNL0lTrJ9Bm+11FCb3D/uaqeOKlB1fU+AK8eOLq8s4x7+CD7/8Bq8InYbKLNtqzRtHag1lfxVHrs18G7bdGI6vEmxCxRHP2+Lrnhp9BG8rDB9++d3Da1qCbFuoDeTJyVWTKZnDDdWWt68/OUn7F1ToafsHUUbgK+RSWkgEBNtKK6nvR3Ch19B4crCUoYrFwPQod+AGx2X/cIIMPRVgdJTo7xztLWJ67UktyLMubQKbQYVk3B0qZ5qyvW1oTOeco7lUCm5lUVKIvl0UBdiOvGzJHPCBOTTnhggVrQEdgScdRnB1JBJPGsvPQCo4prH2Db8zOQGkC2ukDj6FwuF88E5M9oUeF5k0+hFSG0LchSPp1OxS0nZi5/GOOnrL4/5oRRzOWkdzcnxhdHufFyu7crrryxK4Wv+Xso5wvVvTjDG6VYJWfn+sJ2IFcrV/M78mt5A5dfvyIx09jsxjkQglc9J+uLwuXl69gsX5aCKSweL9E809fnX5/MXr6xdsDA/SNmDT0WQ0iY8X40ONenDT4ZeG47W22YOzv/m7RAcSAq3C2CqUEZrF0Gw6VHV39LViloiKUVd6JzYbbtAfndpumfxzQ44h2ywRC3QSM97xd7Nt0gMMhmH3tO5QMOlwesPXM7tqWqxyhFMZIbUSF3lONnySdwgMr95c34hEZN0XldoULONwyV9bcClSET/KxCUYv4cwbSMU6rLBMgKdqJMxEU/QQ0B1HwFV94O96o/0emDhIdJq3eD/2alHBTabFqxttzv+9uijEl1ge25O32y73f4XoAGnxg==","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 account details","permalink":"/docs/API-docs/v1.1/get-user"},"next":{"title":"Get Contact","permalink":"/docs/API-docs/v1.1/getcontact"}}');var o=a(74848),s=a(28453),r=a(33617),c=a.n(r),i=a(17543),l=a.n(i),p=a(86013),d=a.n(p),m=a(63723),g=a.n(m),u=(a(18766),a(79329),a(9303));const T={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:"eJzVWM1u3EYSfpVKX7IRqPmRnAThKVrD8Apr2EKkQEDkgVEka8i2mt2d7ub8YDBADnmDnHLdR/OTLKpJznBGshNhAwcLGMaouqq6/utrbkTA0ov0Tjw3OmAevJgloiCfO2mDNFqk4qYieO4IA0HHBBdXl4BKmaWHtWkgGKD53LigyHu1hrzl1rSEvFMLocIAOWpgefTgZanJeZgbxzocyNoaF1AHKEze1KSDH4lEGEsO2ZLLQqSi1dwpFYlw9HNDPvzTFGuRbo4Mv3JmIQuCjJRZgkWHNQVybG5n4V4R/yIdWAlaq2Qe7xy/96xpI3xeUY38i2+UjgqOGdUolUiExpo4bmFtSaTCZO8pKrWOrQ+SPEtGrnTTc/ngpC5FIubG1RiGFFphbRUzvTdsPolt0l32dPmM6PuOMMpNzapsZfSTTZmenZ9Nz6fnZ1Ox3SYiyBDJBxl5l3Eitny+j1NwDUWCt0b7NhZnk8nDfPXV1aoswDd5Tt7PG6XWXzwlR5/OQ0vmcnpaAGw1zarV2XvLIfw/T+az6fn0LP5jFV3AL8JjavZCZ5Oz89Pp5HTy7c30m/TZd+nX34wmk8lPIhGrWu1LXBQYopd9jfR/N7b4DPdsj9m64iwooFR+KND3/zaW7LPHivLa1BQqqUtYkg6wdEaXCVhF6AmCWwOWKDUoDOT+wiIl54z7dJieZtmwZ6VWUtO7viPfPZtM3k13QZh+vDNROcJiDbSSPvjP6+7HbPi0Y9OBY18/dOxSL1DJIi60G3NP+vP6NLw+tNc/LF/ZMsVzceDskN466SlvnAxrkd5txOoUrTxtz9O72XaWCK4Yw4vUGh8txlCJVIyP96ontyDno5rGKZGKKgTr0/HYoy4ysxoZS5p3uMLM8ygao5XjxXTEA+VYBq19Ej81p08V8QFLqcs/kpvtQ3TNaWwzdRCoXb7Qyn/Tul/v6QFXIiSXT0VYkIs54+r4YY9GXvQ53qWxn/674f/YPN+N84N1y7fNTTSty/0bS/paljpWTnTtGLXdkspNTQx2QkXQC3z49T9RpsdYsbSjhi/e6rf6TePAmiW5eaMAdQFzRSuZKYpCVMezHejzhHUH+aQOVDrGVIUsZUAVAR4PpxwtZlJJbgtmMy3cG3SWH8FtRaGiiAS/dAQIBS1IcTcBNsHUGFhVbzQsjbufM/xMACFrvNTkPZCuUOfM2Oc4AeMANZAO5KyTnsAHx1bL1jajg+OhUqPGklh3chCqgpTkRgBnssYH8EY10WTgXWIcFdA7pIkKP+IgvlhZPgKm5qa2jiouyAVB2ciCfAK5KQh8TDu7oAvIyAewbIvMybPSRiuT38fkMQICa3goSVRg5gc2snhwqD0v/NaWPge7gFlnGEpRa+DJyY+eOMOvpL736cnJW30Kd7uauqXMy0Czf/TNtVwuHzTVV4cyL2X4V5PBD2SNl8G49V66lKFqstiIQyW7P1pNL0lTrJ9Bm+11FCb3D/uaqeOKlB1fU+AK8eOLq8s4x7+CD7/8Bq8InYbKLNtqzRtHag1lfxVHrs18G7bdGI6vEmxCxRHP2+Lrnhp9BG8rDB9++d3Da1qCbFuoDeTJyVWTKZnDDdWWt68/OUn7F1ToafsHUUbgK+RSWkgEBNtKK6nvR3Ch19B4crCUoYrFwPQod+AGx2X/cIIMPRVgdJTo7xztLWJ67UktyLMubQKbQYVk3B0qZ5qyvW1oTOeco7lUCm5lUVKIvl0UBdiOvGzJHPCBOTTnhggVrQEdgScdRnB1JBJPGsvPQCo4prH2Db8zOQGkC2ukDj6FwuF88E5M9oUeF5k0+hFSG0LchSPp1OxS0nZi5/GOOnrL4/5oRRzOWkdzcnxhdHufFyu7crrryxK4Wv+Xso5wvVvTjDG6VYJWfn+sJ2IFcrV/M78mt5A5dfvyIx09jsxjkQglc9J+uLwuXl69gsX5aCKSweL9E809fnX5/MXr6xdsDA/SNmDT0WQ0iY8X40ONenDT4ZeG47W22YOzv/m7RAcSAq3C2CqUEZrF0Gw6VHV39LViloiKUVd6JzYbbtAfndpumfxzQ44h2ywRC3QSM97xd7Nt0gMMhmH3tO5QMOlwesPXM7tqWqxyhFMZIbUSF3lONnySdwgMr95c34hEZN0XldoULONwyV9bcClSET/KxCUYv4cwbSMU6rLBMgKdqJMxEU/QQ0B1HwFV94O96o/0emDhIdJq3eD/2alHBTabFqxttzv+9uijEl1ge25O32y73f4XoAGnxg==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},x=void 0,y={},h=[];function v(t){const e={p:"p",...(0,s.R)(),...t.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Create Contact"}),"\n",(0,o.jsx)(c(),{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)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,o.jsx)(l(),{parameters:void 0}),"\n",(0,o.jsx)(d(),{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"}},title:"createcontact_body"}}},required:!0}}),"\n",(0,o.jsx)(g(),{id:void 0,label:void 0,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"},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"}}}}}})]})}function b(t={}){const{wrapper:e}={...(0,s.R)(),...t.components};return e?(0,o.jsx)(e,{...t,children:(0,o.jsx)(v,{...t})}):v(t)}}}]); \ No newline at end of file diff --git a/assets/js/18b84479.23ffef42.js b/assets/js/18b84479.23ffef42.js deleted file mode 100644 index 4ffb922f0..000000000 --- a/assets/js/18b84479.23ffef42.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1706],{18140:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>j,contentTitle:()=>h,default:()=>v,frontMatter:()=>f,metadata:()=>o,toc:()=>A});const o=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":"eJy9V81u3DYQfpUJL20MeXftuCmqU93GSIwajVE7MFBnYVDiSGJNkQxJ7XqxENBD36CnXvtoeZJiKGlXaztpg7a52Kvh/H4znBmuWeClZ+k1e2HypkYdPJsnTKDPnbRBGs1SdlkhvECFAUH0XHB8fgpcKbP0sDINBAMOa7NA8BZzWch8y1o4UxOT25D8hCXMWHScLJwKljIR9Q8MLGGWO15jQEferZnmNRJbz3AjBUuYJO8sDxW77/K5MwspEEz2C+bhVIAptg4FA505ljCH7xrpULA0uAYT5sNKkSEva6uIAe+sMgJZWnDliSGvsOYsXbOwspEzOKlLlrDCuJqHMQXveNSSMlsdZtUh94K17Zysemu0R096Dmcz+rcbwJCO3lMBvslz9L5olFo9YQnLjQ6EVLpm3Fol84jl9BdP4uuHbnZIELCOkA+yMz4A9FhAW/e/uyPn7Sv7jLXJkKvj8HGhw9nhs/2D2f7s68uD5+nRN+lXzyez2exnlrC7WpHskFQekPQGGdT2u33A1uVszNhTWmI+egzGC1NjqKQuYUlgLp3RZQJWIfcIwa2Al1xqUDyg+w9RReeM+zg6n+ZZO4paaiU13gw1dHM0m90cbEA4+kgtaROgMI0WnzfUx+x/PKCjm2ebgL56GNCpXnAlRWxCl+YW9eeNZ2w+dOYfVqvsmOI52wl2TO+C9Jg3ToZV7HR3+9zK/e48vZ5Tu6BKMdsuGbtjqFjKpkNPm65HnbFlpNItht7ZOMVSVoVgfTqdeq5FZu4mxqL2stSKZ36Sm3rKrZwuDiYHrE3uy3BrP4kfm/1PFfGBl1KXfyc336J1QRntkraD2SZ13MofcMWSISVjrn54VMgFupg+qQsThftEvbaoL2SpY5qj8ftD5gpVbmqkeRIqhEHg/W9/RpkhI7EOo4Ynb/Vb/bpxYM0SXdEo4FpAofBOZgqjENbxbDNVPfJaofdqBVIHLB2nKSxLGbgCwog6SM4tz6SSVMPEZrpxO7oGfgJXFYYKHR194RA4CFygotIH3gRT80CqNkNyadxtQfM9AQ5Z46VG7wF1xXVOjEMWEjAOuAbUAZ110iP44Mhr2flmdHA8D1BzzUsk3ckOVAKVpFIFZ7LGB/BGNdFlCFwq41DAEJBGFH5CIJ7QVHYIRM1NbR1WVDILhLKRAn0CuREIPl5ZCkELyNAHsOSLzNGT0kYrk9/G5NFcBWuog0iuaF0Y+0jiwXHtacb3u0yfgw1g1hka0Ng5uLf3xiNl+EzqW5/u7b3V+3C9qakrzLwMOP9yKP/lcvmg7J/uyryU4VWTwU9ojZfBuNVWupSharJ4VcZKNh+dppeoMdbP6CJsdQiT+4c3j6jTCpWdXmCgCvHT4/PT2HSfwvtff4cz5E5DZZZdteaNQ7WCcjBFyHWZ72Db9EwoTCy8ihDPu+KjZQx9GBC8qnh4/+sfHn7EJcjuCnVA7u2dN5mSOVxibWlE+r29FL53SCbDQINQ8QA515Ah+IpTKS0kBw62k1ZS307gWK+g8ehgKUMVi4HoUW4nDMJlu8JCxj0KMDpKDDYnW4+IXntUC/Ski2ZfhoBC0jYXKmeasrM2dqYPzmEhlYIrKUoMMbZjIcD25GVHjnvs1h0s6EKEClfAHYJHHSZwfk8knjTWGkdeyM75wtAiTwlALayROvgUhONF2OpPtoWeE8zS6EdIHYR8A0fSq9mkpLuJfcQb6uQtNeR7TXy31zosMD4gYtjbvFjZl9P1UJZA1fpvypqmNXUtnsdlAmsuVTdNvr2vJw52dLV/XVygW8gc+4n2gRs9jcxTljAlc9QeRwvD8cvzM1g8m8xYMhqN/+ByT89Ovz/58eKEnKFG2gF2MJlNZkSyxoea65Gl/i33YvvY2sF6vV2l/qenXz+fA96FqVVcxgUpxrzuN5trNnoKpuNX3zxhlfGBWNZruoNvnGpbIr9r0NEKNU/YgjvJMxrj12smpKffYvOE+2C0X/7Uvwafwj9+QD4ay7CAaNo+Flw19MUSdoure4/Ydt4mwxZCznYcx3mONoxkH2y0O2vhi5Ozk8sTljDqp7sL0G1cgPofZOBR13Y3o84H+ktr2qMC63W3XLXthr87+qBEH+PATTjN27b9C8Xtzug=","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 s=n(74848),l=n(28453),d=n(33617),c=n.n(d),i=n(17543),p=n.n(i),r=n(86013),u=n.n(r),a=n(63723),m=n.n(a),g=(n(18766),n(79329),n(9303));const f={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:"eJy9V81u3DYQfpUJL20MeXftuCmqU93GSIwajVE7MFBnYVDiSGJNkQxJ7XqxENBD36CnXvtoeZJiKGlXaztpg7a52Kvh/H4znBmuWeClZ+k1e2HypkYdPJsnTKDPnbRBGs1SdlkhvECFAUH0XHB8fgpcKbP0sDINBAMOa7NA8BZzWch8y1o4UxOT25D8hCXMWHScLJwKljIR9Q8MLGGWO15jQEferZnmNRJbz3AjBUuYJO8sDxW77/K5MwspEEz2C+bhVIAptg4FA505ljCH7xrpULA0uAYT5sNKkSEva6uIAe+sMgJZWnDliSGvsOYsXbOwspEzOKlLlrDCuJqHMQXveNSSMlsdZtUh94K17Zysemu0R096Dmcz+rcbwJCO3lMBvslz9L5olFo9YQnLjQ6EVLpm3Fol84jl9BdP4uuHbnZIELCOkA+yMz4A9FhAW/e/uyPn7Sv7jLXJkKvj8HGhw9nhs/2D2f7s68uD5+nRN+lXzyez2exnlrC7WpHskFQekPQGGdT2u33A1uVszNhTWmI+egzGC1NjqKQuYUlgLp3RZQJWIfcIwa2Al1xqUDyg+w9RReeM+zg6n+ZZO4paaiU13gw1dHM0m90cbEA4+kgtaROgMI0WnzfUx+x/PKCjm2ebgL56GNCpXnAlRWxCl+YW9eeNZ2w+dOYfVqvsmOI52wl2TO+C9Jg3ToZV7HR3+9zK/e48vZ5Tu6BKMdsuGbtjqFjKpkNPm65HnbFlpNItht7ZOMVSVoVgfTqdeq5FZu4mxqL2stSKZ36Sm3rKrZwuDiYHrE3uy3BrP4kfm/1PFfGBl1KXfyc336J1QRntkraD2SZ13MofcMWSISVjrn54VMgFupg+qQsThftEvbaoL2SpY5qj8ftD5gpVbmqkeRIqhEHg/W9/RpkhI7EOo4Ynb/Vb/bpxYM0SXdEo4FpAofBOZgqjENbxbDNVPfJaofdqBVIHLB2nKSxLGbgCwog6SM4tz6SSVMPEZrpxO7oGfgJXFYYKHR194RA4CFygotIH3gRT80CqNkNyadxtQfM9AQ5Z46VG7wF1xXVOjEMWEjAOuAbUAZ110iP44Mhr2flmdHA8D1BzzUsk3ckOVAKVpFIFZ7LGB/BGNdFlCFwq41DAEJBGFH5CIJ7QVHYIRM1NbR1WVDILhLKRAn0CuREIPl5ZCkELyNAHsOSLzNGT0kYrk9/G5NFcBWuog0iuaF0Y+0jiwXHtacb3u0yfgw1g1hka0Ng5uLf3xiNl+EzqW5/u7b3V+3C9qakrzLwMOP9yKP/lcvmg7J/uyryU4VWTwU9ojZfBuNVWupSharJ4VcZKNh+dppeoMdbP6CJsdQiT+4c3j6jTCpWdXmCgCvHT4/PT2HSfwvtff4cz5E5DZZZdteaNQ7WCcjBFyHWZ72Db9EwoTCy8ihDPu+KjZQx9GBC8qnh4/+sfHn7EJcjuCnVA7u2dN5mSOVxibWlE+r29FL53SCbDQINQ8QA515Ah+IpTKS0kBw62k1ZS307gWK+g8ehgKUMVi4HoUW4nDMJlu8JCxj0KMDpKDDYnW4+IXntUC/Ski2ZfhoBC0jYXKmeasrM2dqYPzmEhlYIrKUoMMbZjIcD25GVHjnvs1h0s6EKEClfAHYJHHSZwfk8knjTWGkdeyM75wtAiTwlALayROvgUhONF2OpPtoWeE8zS6EdIHYR8A0fSq9mkpLuJfcQb6uQtNeR7TXy31zosMD4gYtjbvFjZl9P1UJZA1fpvypqmNXUtnsdlAmsuVTdNvr2vJw52dLV/XVygW8gc+4n2gRs9jcxTljAlc9QeRwvD8cvzM1g8m8xYMhqN/+ByT89Ovz/58eKEnKFG2gF2MJlNZkSyxoea65Gl/i33YvvY2sF6vV2l/qenXz+fA96FqVVcxgUpxrzuN5trNnoKpuNX3zxhlfGBWNZruoNvnGpbIr9r0NEKNU/YgjvJMxrj12smpKffYvOE+2C0X/7Uvwafwj9+QD4ay7CAaNo+Flw19MUSdoure4/Ydt4mwxZCznYcx3mONoxkH2y0O2vhi5Ozk8sTljDqp7sL0G1cgPofZOBR13Y3o84H+ktr2qMC63W3XLXthr87+qBEH+PATTjN27b9C8Xtzug=",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,j={},A=[];function N(e){const t={p:"p",...(0,l.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(g.default,{as:"h1",className:"openapi__heading",children:"Delete Document"}),"\n",(0,s.jsx)(c(),{method:"delete",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Delete document API allows you to remove specific document from your documents."}),"\n",(0,s.jsx)(g.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(p(),{parameters:[{name:"document_id",in:"path",description:"Provide objectId of document to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}]}),"\n",(0,s.jsx)(u(),{title:"Body",body:void 0}),"\n",(0,s.jsx)(m(),{id:void 0,label:void 0,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"}}}}}})]})}function v(e={}){const{wrapper:t}={...(0,l.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(N,{...e})}):N(e)}}}]); \ No newline at end of file diff --git a/assets/js/18b84479.33c9f705.js b/assets/js/18b84479.33c9f705.js new file mode 100644 index 000000000..ff55be753 --- /dev/null +++ b/assets/js/18b84479.33c9f705.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1706],{18140:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>f,contentTitle:()=>P,default:()=>v,frontMatter:()=>j,metadata:()=>d,toc:()=>x});const d=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 s=n(74848),o=n(28453),i=n(33617),c=n.n(i),a=n(17543),l=n.n(a),r=n(86013),u=n.n(r),p=n(63723),m=n.n(p),h=(n(18766),n(79329),n(9303));const j={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},P=void 0,f={},x=[];function M(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:"Delete Document"}),"\n",(0,s.jsx)(c(),{method:"delete",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Delete document API allows you to remove specific document from your documents."}),"\n",(0,s.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(l(),{parameters:[{name:"document_id",in:"path",description:"Provide objectId of document to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}]}),"\n",(0,s.jsx)(u(),{title:"Body",body:void 0}),"\n",(0,s.jsx)(m(),{id:void 0,label:void 0,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"}}}}}})]})}function v(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(M,{...e})}):M(e)}}}]); \ No newline at end of file diff --git a/assets/js/19e5ad2a.d6aec8c4.js b/assets/js/19e5ad2a.d6aec8c4.js new file mode 100644 index 000000000..485b7533e --- /dev/null +++ b/assets/js/19e5ad2a.d6aec8c4.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1651],{82850:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>A,contentTitle:()=>T,default:()=>j,frontMatter:()=>b,metadata:()=>s,toc:()=>g});const s=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":"eJzNV91uI7cVfpVT3rQRxtLIu5uiuoqxWDhGjKxROzBQr7HgzBzNcMUhGfKMZEEQkIu+Qa9620fbJykO50cj25vUTRAEMGzP4fn/48edIFkGsbgTb60hmVMQ94koMOReOVLWiIW4qRC6U7hUgeDs6gKwdnaDPsDWNkAWPJJXuEaQoJnHLiHvNCbgvF2rQpkSJOS2dh4rNEGtEdYKN8wrtQa5lkrLTOMgCcqwft8TMmtXU5EI69BL9u6iEAvRHbJZkQgnvayR0HNUO2FkjWIhtKoVnyoO6McG/VYkwuOPjfJYiMVS6oCJCLTVzL20vhaJwAenbYFiQb7h07zCWorFTtTyQdVNLRZv0jQRtHUsZJo6Qy/2LCdrx4rm6T4ZXAgr5X4zD75sM93fs97grAkYmPc0TfnPcVFDk+cYwrLRMGRTJDGXaIj5pXNa5fFg9imw0O6pAzb7hHlMu2c1pFqTHkOjacQnvZccsCKswy/Lt2Su7sAZyCtTiiSmRtKYMsQuXDXPqofTT45T0ub9ZQo+WYQMMWa0lkr/H/IZ4jcdYZrbmlW5ypoXu/J6/mp+Gn9YRe5REhZn9Jyag9BpevrqZJ6epH+9mX+9eP23xZuvp2ma/kMk4qGO0XTdWEiKUZIiPf5uXPE72Nk/ZutmuECSSoexQHci9vsRURmtDH7s2/wjt/g+crx+rtmvbY1U8f7ZoCHYeGvKBJxGGRDIb0GWUhnQktD/6bebAvTe+p/P48s8+7kUvE7Tj/MhCW+eJuHCrKVWRdzeN3aF5veNdGyeWvNP20C1TPFcHAU7prdBBswbr2gb1/zDiXTqpD1f3N3zDuTEWr4fSmzvBarEQsyOb4uAft1fFY3XYiEqIhcWs1mQpsjsw9Q6vqpKo2UWeJ5n0qnZej7lqXwsI517ET82Jy8VCSRLZcpfkrs/5Oeaa9iW6ShLh93s1HfIy7krwpiru68qlAXfM3v+Xtoo3JXmvUNzrUoTCxuNP8YPt6hzWyOjBKoQJpNe5PM//zNITSZQ2Lyp0VBswekH88G8bzxEmMHXlDQFLDU+KEYIz0GQgLLWGILegjKEpZeEUKhSkdTAeeIxy6WTmdKKO5fZbAswRs0fpnBbIVXo+ejPniFNgWvU3PAgG7K1JFbV+wsb61dLbTchAQlZE5TBEABNJU3OjH0lErAepAE0hN55FRACefZatb5ZQ55RVi2NLJF1JzBOVoFacbuCt1kTCILVTXQZeG1ajwX0ARnEIsQkvmMM4RFaHDUGX2WjCgwJ5LZACHFQOQRTQIaBwLEvKsfAShujbb6KBVw2WoOzvDeU1Izexj6yOHlpAt9trS99DYaEOW8ZfGDr4GTyQ0Cu8KUyq7CYTD6YE7gb+uoWs6AI7//Sj8Bms3nS+l8dy5wr+rbJ4O/obFBk/fYgXSqqmiyOy1jJ8NFqOkeDsX9Gw3DQUdg8PJ0+ps4q1G52jcQdEmZnVxdx1X4Fn3/6F1yi9AYqu2m7NW886i2UvSnOXFv5Nm3DpoSljY1XccbztvkYOWKgPoO3laTPP/07wPe4YdTcjhSHMplcNZlWOdxg7fgeCZPJAt5GOAHU04AqSZBLAxlCqCS30lpJkOBaaa3MagpnZgtNQA8bRVVsBqZHuaMwOC9DuQNkMmAB1kSJ3ub04BHT64B6jYF1GUvsBhaKuKMrb5uytTZ2pgvO41JpDbeqKJFibGdFAa4jb1oyJ3zkDi55IKjCLUiPENDQFK4eicSTxjnr2QvVOr+0WtsNFwBN4awyFBZQeLmkg/7k0OgRtSlrniG1KZRDOpJOzVCSdhK7iAfq9AMv5UeL/HjfelyiZ4Mx7ENdnOra6a5vS+Bu/TVtHZFpB9AYBrSQmW+Ubx7ridc5+jq8X16jX6scu1vtCxM9i8wzkQitcjQBRzDh7PzqEtavpqlIRtfj/zDcs8uLt+++v37HzvAibRM2n6bTNOJ0G6iWZmTpHGl4+3aQ4SjZuwOC+gO+k7sLnvCBZk5LFTFVTNiuw0N3R6/n+0RUNhCTdzse2h+83u+Z3D5YGSUVKrDtw5N1hdvRA3stdcM2I3T5Am/3Ej6w3vOHV8wb0VvSAw422Mqc5Tm6sYEncPUI852/uxGJ4J15DHRWEeh0/7D2/shsR7qPEVDrAP/mmJ4V2O1aELXfD/zt0RclugB7bi7N/X6//y+jxiEE","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 a=i(74848),n=i(28453),o=i(33617),r=i.n(o),c=i(17543),p=i.n(c),l=i(86013),d=i.n(l),m=i(63723),u=i.n(m),v=(i(18766),i(79329),i(9303));const b={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:"eJzNV91uI7cVfpVT3rQRxtLIu5uiuoqxWDhGjKxROzBQr7HgzBzNcMUhGfKMZEEQkIu+Qa9620fbJykO50cj25vUTRAEMGzP4fn/48edIFkGsbgTb60hmVMQ94koMOReOVLWiIW4qRC6U7hUgeDs6gKwdnaDPsDWNkAWPJJXuEaQoJnHLiHvNCbgvF2rQpkSJOS2dh4rNEGtEdYKN8wrtQa5lkrLTOMgCcqwft8TMmtXU5EI69BL9u6iEAvRHbJZkQgnvayR0HNUO2FkjWIhtKoVnyoO6McG/VYkwuOPjfJYiMVS6oCJCLTVzL20vhaJwAenbYFiQb7h07zCWorFTtTyQdVNLRZv0jQRtHUsZJo6Qy/2LCdrx4rm6T4ZXAgr5X4zD75sM93fs97grAkYmPc0TfnPcVFDk+cYwrLRMGRTJDGXaIj5pXNa5fFg9imw0O6pAzb7hHlMu2c1pFqTHkOjacQnvZccsCKswy/Lt2Su7sAZyCtTiiSmRtKYMsQuXDXPqofTT45T0ub9ZQo+WYQMMWa0lkr/H/IZ4jcdYZrbmlW5ypoXu/J6/mp+Gn9YRe5REhZn9Jyag9BpevrqZJ6epH+9mX+9eP23xZuvp2ma/kMk4qGO0XTdWEiKUZIiPf5uXPE72Nk/ZutmuECSSoexQHci9vsRURmtDH7s2/wjt/g+crx+rtmvbY1U8f7ZoCHYeGvKBJxGGRDIb0GWUhnQktD/6bebAvTe+p/P48s8+7kUvE7Tj/MhCW+eJuHCrKVWRdzeN3aF5veNdGyeWvNP20C1TPFcHAU7prdBBswbr2gb1/zDiXTqpD1f3N3zDuTEWr4fSmzvBarEQsyOb4uAft1fFY3XYiEqIhcWs1mQpsjsw9Q6vqpKo2UWeJ5n0qnZej7lqXwsI517ET82Jy8VCSRLZcpfkrs/5Oeaa9iW6ShLh93s1HfIy7krwpiru68qlAXfM3v+Xtoo3JXmvUNzrUoTCxuNP8YPt6hzWyOjBKoQJpNe5PM//zNITSZQ2Lyp0VBswekH88G8bzxEmMHXlDQFLDU+KEYIz0GQgLLWGILegjKEpZeEUKhSkdTAeeIxy6WTmdKKO5fZbAswRs0fpnBbIVXo+ejPniFNgWvU3PAgG7K1JFbV+wsb61dLbTchAQlZE5TBEABNJU3OjH0lErAepAE0hN55FRACefZatb5ZQ55RVi2NLJF1JzBOVoFacbuCt1kTCILVTXQZeG1ajwX0ARnEIsQkvmMM4RFaHDUGX2WjCgwJ5LZACHFQOQRTQIaBwLEvKsfAShujbb6KBVw2WoOzvDeU1Izexj6yOHlpAt9trS99DYaEOW8ZfGDr4GTyQ0Cu8KUyq7CYTD6YE7gb+uoWs6AI7//Sj8Bms3nS+l8dy5wr+rbJ4O/obFBk/fYgXSqqmiyOy1jJ8NFqOkeDsX9Gw3DQUdg8PJ0+ps4q1G52jcQdEmZnVxdx1X4Fn3/6F1yi9AYqu2m7NW886i2UvSnOXFv5Nm3DpoSljY1XccbztvkYOWKgPoO3laTPP/07wPe4YdTcjhSHMplcNZlWOdxg7fgeCZPJAt5GOAHU04AqSZBLAxlCqCS30lpJkOBaaa3MagpnZgtNQA8bRVVsBqZHuaMwOC9DuQNkMmAB1kSJ3ub04BHT64B6jYF1GUvsBhaKuKMrb5uytTZ2pgvO41JpDbeqKJFibGdFAa4jb1oyJ3zkDi55IKjCLUiPENDQFK4eicSTxjnr2QvVOr+0WtsNFwBN4awyFBZQeLmkg/7k0OgRtSlrniG1KZRDOpJOzVCSdhK7iAfq9AMv5UeL/HjfelyiZ4Mx7ENdnOra6a5vS+Bu/TVtHZFpB9AYBrSQmW+Ubx7ridc5+jq8X16jX6scu1vtCxM9i8wzkQitcjQBRzDh7PzqEtavpqlIRtfj/zDcs8uLt+++v37HzvAibRM2n6bTNOJ0G6iWZmTpHGl4+3aQ4SjZuwOC+gO+k7sLnvCBZk5LFTFVTNiuw0N3R6/n+0RUNhCTdzse2h+83u+Z3D5YGSUVKrDtw5N1hdvRA3stdcM2I3T5Am/3Ej6w3vOHV8wb0VvSAw422Mqc5Tm6sYEncPUI852/uxGJ4J15DHRWEeh0/7D2/shsR7qPEVDrAP/mmJ4V2O1aELXfD/zt0RclugB7bi7N/X6//y+jxiEE",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},T=void 0,A={},g=[];function h(e){const t={p:"p",...(0,n.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(v.default,{as:"h1",className:"openapi__heading",children:"Get Contact list"}),"\n",(0,a.jsx)(r(),{method:"get",path:"/contactlist",context:"endpoint"}),"\n",(0,a.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,a.jsx)(v.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,a.jsx)(p(),{parameters:[{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10},{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}]}),"\n",(0,a.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,a.jsx)(u(),{id:void 0,label:void 0,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"},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"}}}}}})]})}function j(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(h,{...e})}):h(e)}}}]); \ No newline at end of file diff --git a/assets/js/19e5ad2a.f6c81f16.js b/assets/js/19e5ad2a.f6c81f16.js deleted file mode 100644 index b842f2f3b..000000000 --- a/assets/js/19e5ad2a.f6c81f16.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1651],{82850:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>v,contentTitle:()=>h,default:()=>P,frontMatter:()=>u,metadata:()=>o,toc:()=>y});const o=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":"eJzNV91u4zYWfpVT3nQbKLacmWmxumowGKRBg07QpAjQTDCgpGOJY4pkySM7hmFgLvYN9qq3fbR5kuJQki0nmXazWxQLBEl0eP7/+HEjSFZBZLfitTUkCwriLhElhsIrR8oakYnrGqE/hQsVCE4vzwEbZ1foA6xtC2TBI3mFSwQJmnnsHIpeYwLO26UqlalAQmEb57FGE9QSYalwxbxSa5BLqbTMNe4kQRnW7wdCbu1iIhJhHXrJ3p2XIhP9IZsViXDSywYJPUe1EUY2KDKhVaP4VHFAv7To1yIRHn9plcdSZHOpAyYi0Foz99z6RiQC7522JYqMfMunRY2NFNlGNPJeNW0jsldpmghaOxYybZOjF1uWk41jRbN0m+xcCAvl/jIPPm8z3d6x3uCsCRiY9yRN+c9hUUNbFBjCvNWwy6ZIYi7REPNL57Qq4sH0Q2ChzWMHbP4Bi5h2z2pIdSY9hlbTiE96LzlgRdiEP5fvyFzdHWcgr0wlkpgaSWPKLnbh6lle3598cJySLu/PU/DBIuSIMaONVPq/kM8Rv+0Jk8I2rMrV1jzblZezF7OT+MMqCo+SsDylp9TshU7SkxfHs/Q4/eZ69nX28p/Zq68naZr+LBJx38Ro+m4sJcUoSZEef7eu/BvsbB+y9TNcIkmlw1igPxHb7YiojFYG3w9t/p5bfBs5Xj7V7Fe2Qap5/6zQEKy8NVUCTqMMCOTXICupDGhJ6L/466YAvbf+j/P4PM/+KAUv0/T9bJeEV4+TcG6WUqsybu9ru0Dz90Y6Nk+d+cdtoDqmeC4Ogh3TuyADFq1XtI5r/v5YOnXcnWe3d7wDObGW74cKu3uBapGJ6eFtEdAvh6ui9VpkoiZyIZtOgzRlbu8n1vFVVRkt88DzPJVOTZezCU/lQxnp3LP4sT1+rkggWSlT/Znc3T4/V1zDrkwHWdrvZqe+R17OfRHGXP19VaMs+Z7Z8vfcRuG+NG8dmitVmVjYaPwhfrhBXdgGGSVQjTAIfPrXb1GmtEXboKHYeVHDF+/MO/O29RAhBl9R0pQw13ivGB08BT8CykZjCHoNyhBWXhJCqSpFUgPniEeskE7mSivuWmazHbgYNX6YwE2NVKPnoy89w5kSl6i52UG2ZBtJrGpwGlbWL+barkICEvI2KIMhAJpamoIZhyokYD1IA2gIvfMqIATy7LXqfLOGPCOsRhpZIetODlJVolbcquBt3gaCYHUbXQZemdZjCUNABrEME07iG8YPHqHDUGPgVbWqxJBAYUuEEIeUQzAl5BgIHPuiCgystDXaFotYvHmrNTjLO0NJzcht7COLk5cm8L3W+TLUYJcw5y0DD+wcPDr6KSBX+EKZRciOjt6ZY7jd9dQN5kER3v1jaP/VavWo7b86lDlT9F2bw4/obFBk/XovXSmq2zyOyljJ7qPTdIYGY/+MBmGvo7RFeDx5TJ3WqN30Cok7JExPL8/jmv0KPn38N1yg9AZqu+q6tWg96jVUgynOXFf5Lm27LQlzGxuv5owXXfMxasRAQwZvakmfPv4a4AdcMWLmEeoSeXR02eZaFXCNjeM7JBwdZfA6QgmggQZUS4JCGsgRQi25lZZKggTXSWtlFhM4NWtoA3pYKapjMzA9yh2EwXnZlTtALgOWYE2UGGxO9h4xvQmolxhYl7HEbmCpiDu69ratOmtjZ/rgPM6V1nCjygopxnZaluB68qojc8JH7uCcB4JqXIP0CAENTeDygUg8aZ2znr1QnfNzq7VdcQHQlM4qQyGD0ss57fUn+0aPiE1Z8wSpS6HcpSPp1exK0k1iH/GOOnnHC/nBEj/ctR7n6NlgDHtfF6f6drod2hK4W/+Xto6otAdnDAE6uMy3ybcP9cSrHH0T3s6v0C9Vgf2N9pmJnkbmqUiEVgWagCOIcHp2eQHLF5NUJKOr8T8Y7unF+es3P1y9YWd4kXYJm03SSRoxug3USDOydIa0e/f2cOEg2Zs9evo/fCP3lzvhPU2dliriqZiwTY+Fbg9ezneJqG0gJm82PLQ/eb3dMrl7rDJCKlVg2/vn6gLXo8f1UuqWbUbY8hne/hW8Z73jD6+YNyK3ZAAbbLCTOS0KdGMDj6DqAd47e3MtEsE78xDkLCLI6f9h7cORWY90H6KfzgH+zTE9KbDZdABqu93xd0eflegDHLi5NHfb7fZ3wWkgTw==","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 i=n(74848),a=n(28453),s=n(33617),l=n.n(s),c=n(17543),r=n.n(c),p=n(86013),d=n.n(p),m=n(63723),g=n.n(m),b=(n(18766),n(79329),n(9303));const u={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:"eJzNV91u4zYWfpVT3nQbKLacmWmxumowGKRBg07QpAjQTDCgpGOJY4pkySM7hmFgLvYN9qq3fbR5kuJQki0nmXazWxQLBEl0eP7/+HEjSFZBZLfitTUkCwriLhElhsIrR8oakYnrGqE/hQsVCE4vzwEbZ1foA6xtC2TBI3mFSwQJmnnsHIpeYwLO26UqlalAQmEb57FGE9QSYalwxbxSa5BLqbTMNe4kQRnW7wdCbu1iIhJhHXrJ3p2XIhP9IZsViXDSywYJPUe1EUY2KDKhVaP4VHFAv7To1yIRHn9plcdSZHOpAyYi0Foz99z6RiQC7522JYqMfMunRY2NFNlGNPJeNW0jsldpmghaOxYybZOjF1uWk41jRbN0m+xcCAvl/jIPPm8z3d6x3uCsCRiY9yRN+c9hUUNbFBjCvNWwy6ZIYi7REPNL57Qq4sH0Q2ChzWMHbP4Bi5h2z2pIdSY9hlbTiE96LzlgRdiEP5fvyFzdHWcgr0wlkpgaSWPKLnbh6lle3598cJySLu/PU/DBIuSIMaONVPq/kM8Rv+0Jk8I2rMrV1jzblZezF7OT+MMqCo+SsDylp9TshU7SkxfHs/Q4/eZ69nX28p/Zq68naZr+LBJx38Ro+m4sJcUoSZEef7eu/BvsbB+y9TNcIkmlw1igPxHb7YiojFYG3w9t/p5bfBs5Xj7V7Fe2Qap5/6zQEKy8NVUCTqMMCOTXICupDGhJ6L/466YAvbf+j/P4PM/+KAUv0/T9bJeEV4+TcG6WUqsybu9ru0Dz90Y6Nk+d+cdtoDqmeC4Ogh3TuyADFq1XtI5r/v5YOnXcnWe3d7wDObGW74cKu3uBapGJ6eFtEdAvh6ui9VpkoiZyIZtOgzRlbu8n1vFVVRkt88DzPJVOTZezCU/lQxnp3LP4sT1+rkggWSlT/Znc3T4/V1zDrkwHWdrvZqe+R17OfRHGXP19VaMs+Z7Z8vfcRuG+NG8dmitVmVjYaPwhfrhBXdgGGSVQjTAIfPrXb1GmtEXboKHYeVHDF+/MO/O29RAhBl9R0pQw13ivGB08BT8CykZjCHoNyhBWXhJCqSpFUgPniEeskE7mSivuWmazHbgYNX6YwE2NVKPnoy89w5kSl6i52UG2ZBtJrGpwGlbWL+barkICEvI2KIMhAJpamoIZhyokYD1IA2gIvfMqIATy7LXqfLOGPCOsRhpZIetODlJVolbcquBt3gaCYHUbXQZemdZjCUNABrEME07iG8YPHqHDUGPgVbWqxJBAYUuEEIeUQzAl5BgIHPuiCgystDXaFotYvHmrNTjLO0NJzcht7COLk5cm8L3W+TLUYJcw5y0DD+wcPDr6KSBX+EKZRciOjt6ZY7jd9dQN5kER3v1jaP/VavWo7b86lDlT9F2bw4/obFBk/XovXSmq2zyOyljJ7qPTdIYGY/+MBmGvo7RFeDx5TJ3WqN30Cok7JExPL8/jmv0KPn38N1yg9AZqu+q6tWg96jVUgynOXFf5Lm27LQlzGxuv5owXXfMxasRAQwZvakmfPv4a4AdcMWLmEeoSeXR02eZaFXCNjeM7JBwdZfA6QgmggQZUS4JCGsgRQi25lZZKggTXSWtlFhM4NWtoA3pYKapjMzA9yh2EwXnZlTtALgOWYE2UGGxO9h4xvQmolxhYl7HEbmCpiDu69ratOmtjZ/rgPM6V1nCjygopxnZaluB68qojc8JH7uCcB4JqXIP0CAENTeDygUg8aZ2znr1QnfNzq7VdcQHQlM4qQyGD0ss57fUn+0aPiE1Z8wSpS6HcpSPp1exK0k1iH/GOOnnHC/nBEj/ctR7n6NlgDHtfF6f6drod2hK4W/+Xto6otAdnDAE6uMy3ybcP9cSrHH0T3s6v0C9Vgf2N9pmJnkbmqUiEVgWagCOIcHp2eQHLF5NUJKOr8T8Y7unF+es3P1y9YWd4kXYJm03SSRoxug3USDOydIa0e/f2cOEg2Zs9evo/fCP3lzvhPU2dliriqZiwTY+Fbg9ezneJqG0gJm82PLQ/eb3dMrl7rDJCKlVg2/vn6gLXo8f1UuqWbUbY8hne/hW8Z73jD6+YNyK3ZAAbbLCTOS0KdGMDj6DqAd47e3MtEsE78xDkLCLI6f9h7cORWY90H6KfzgH+zTE9KbDZdABqu93xd0eflegDHLi5NHfb7fZ3wWkgTw==",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={},y=[];function f(e){const t={p:"p",...(0,a.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(b.default,{as:"h1",className:"openapi__heading",children:"Get Contact list"}),"\n",(0,i.jsx)(l(),{method:"get",path:"/contactlist",context:"endpoint"}),"\n",(0,i.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,i.jsx)(b.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(r(),{parameters:[{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10},{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}]}),"\n",(0,i.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,i.jsx)(g(),{id:void 0,label:void 0,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"},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"}}}}}})]})}function P(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/1c57a399.e05f6301.js b/assets/js/1c57a399.e05f6301.js new file mode 100644 index 000000000..7d756949d --- /dev/null +++ b/assets/js/1c57a399.e05f6301.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8901],{45740:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>h,contentTitle:()=>p,default:()=>g,frontMatter:()=>d,metadata:()=>s,toc:()=>m});const s=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 t=i(74848),r=i(28453),o=(i(64624),i(9303)),a=i(12990),l=i.n(a),c=i(79329);i(25383);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,h={},m=[];function u(e){const n={a:"a",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("span",{className:"theme-doc-version-badge badge badge--secondary",children:"Version: 1.0.0"}),"\n",(0,t.jsx)(o.default,{as:"h1",className:"openapi__heading",children:"OpenSign API v1.1"}),"\n",(0,t.jsxs)(n.p,{children:["Welcome to the ",(0,t.jsx)(n.strong,{children:"OpenSign\u2122 API v1.1"})," documentation."]}),"\n",(0,t.jsx)(n.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,t.jsx)(n.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,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:"Useful Links:"})}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"https://www.opensignlabs.com",children:"OpenSign Website"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"https://github.com/opensignlabs/opensign",children:"OpenSign GitHub Repository"})}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.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,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:"What\u2019s New in v1.1"})}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.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,t.jsxs)(n.li,{children:[(0,t.jsx)(n.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,t.jsxs)("div",{style:{marginBottom:"2rem"},children:[(0,t.jsx)(o.default,{id:"authentication",as:"h2",className:"openapi-tabs__heading",children:"Authentication"}),(0,t.jsx)(l(),{className:"openapi-tabs__security-schemes",children:(0,t.jsx)(c.default,{label:"API Key: x-api-token",value:"x-api-token",children:(0,t.jsx)("div",{children:(0,t.jsx)("table",{children:(0,t.jsxs)("tbody",{children:[(0,t.jsxs)("tr",{children:[(0,t.jsx)("th",{children:(0,t.jsx)(n.p,{children:"Security Scheme Type:"})}),(0,t.jsx)("td",{children:(0,t.jsx)(n.p,{children:"apiKey"})})]}),(0,t.jsxs)("tr",{children:[(0,t.jsx)("th",{children:(0,t.jsx)(n.p,{children:"Header parameter name:"})}),(0,t.jsx)("td",{children:(0,t.jsx)(n.p,{children:"x-api-token"})})]})]})})})})})]}),"\n",(0,t.jsxs)("div",{style:{display:"flex",flexDirection:"column",marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,t.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,t.jsx)(n.p,{children:"Contact"})}),(0,t.jsx)("span",{children:(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"mailto:api@opensignlabs.com",children:"api@opensignlabs.com"})})})]}),"\n",(0,t.jsxs)("div",{style:{marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,t.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,t.jsx)(n.p,{children:"Terms of Service"})}),(0,t.jsx)("a",{href:"http://www.opensignlabs.com/terms/",children:"http://www.opensignlabs.com/terms/"})]}),"\n",(0,t.jsxs)("div",{style:{marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,t.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,t.jsx)(n.p,{children:"License"})}),(0,t.jsx)("a",{href:"http://github.com/opensignlabs/opensign/LICENSE",children:(0,t.jsx)(n.p,{children:"AGPL v3.0"})})]})]})}function g(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(u,{...e})}):u(e)}}}]); \ No newline at end of file diff --git a/assets/js/1c57a399.ef3d0d2a.js b/assets/js/1c57a399.ef3d0d2a.js deleted file mode 100644 index 320670071..000000000 --- a/assets/js/1c57a399.ef3d0d2a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8901],{45740:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>h,contentTitle:()=>p,default:()=>g,frontMatter:()=>d,metadata:()=>t,toc:()=>m});const t=JSON.parse('{"id":"API-docs/v1.1/opensign-api-v-1-1","title":"OpenSign API v1.1","description":"Welcome to the OpenSign\u2122 API documentation v1.1!","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 documentation v1.1!","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=i(74848),r=i(28453),o=(i(64624),i(9303)),a=i(12990),l=i.n(a),c=i(79329);i(25383);const d={id:"opensign-api-v-1-1",title:"OpenSign API v1.1",description:"Welcome to the OpenSign\u2122 API documentation v1.1!",sidebar_label:"Introduction",sidebar_position:0,hide_title:!0,custom_edit_url:null},p=void 0,h={},m=[];function u(e){const n={a:"a",li:"li",p:"p",strong:"strong",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.1"}),"\n",(0,s.jsx)(n.p,{children:"Welcome to the OpenSign\u2122 API documentation v1.1!"}),"\n",(0,s.jsx)(n.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,s.jsx)(n.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,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{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://github.com/opensignlabs/opensign",children:"OpenSign GitHub Repository"})}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.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,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"What\u2019s New in v1.1"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.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,s.jsxs)(n.li,{children:[(0,s.jsx)(n.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,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)(l(),{className:"openapi-tabs__security-schemes",children:(0,s.jsx)(c.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 g(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(u,{...e})}):u(e)}}}]); \ No newline at end of file diff --git a/assets/js/23f866da.89427f12.js b/assets/js/23f866da.fc639d99.js similarity index 57% rename from assets/js/23f866da.89427f12.js rename to assets/js/23f866da.fc639d99.js index bc6ce6a3c..47e9382c9 100644 --- a/assets/js/23f866da.89427f12.js +++ b/assets/js/23f866da.fc639d99.js @@ -1 +1 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[285],{64658:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>y,contentTitle:()=>x,default:()=>b,frontMatter:()=>g,metadata:()=>i,toc:()=>f});const i=JSON.parse('{"id":"API-docs/v1.1/selfsign","title":"Self Sign","description":"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.","source":"@site/docs/API-docs/v1.1/selfsign.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/selfsign","permalink":"/docs/API-docs/v1.1/selfsign","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"selfsign","title":"Self Sign","description":"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.","sidebar_label":"Self Sign","hide_title":true,"hide_table_of_contents":true,"api":"eJztO11vG0lyf6VuEMBrZUiKtOx1BMc4rb23q8SxhZUM4yLptM2ZIqetme7Z7h6RXIHAPtw/yFOA5OV+mn9JUNU9wxmKkuz14tZJ6AeZ0x/VVdXV1VXVVdeRE1Mb7Z9GL3VSFaicjc7jKEWbGFk6qVW0H51kCBbziZVTBQdHhzBFhUY4tCDg7Q+vwGXCASoxztHCxCBat8gRaLxUU9ATEJAG+H34s64gEQpEbjVIleRViqB5MZFDabCX4kQqTGEm0yk6G8Msk0kGLvMw0fB8TKUDbQDnpVApVKVWICwoxBTTPpxk0kJp9JVMGdEaG5yXaCSqhIAVMhcGnGbYH375r2Mi8c+6MkTvh1/+Gya5noFU3P+mRMUDRFn2z9SZOpHlPrwtcy1SWOjKwNHLPzWEElRqO93ZeYnjagpvD3d2zr/KnCvt/mBAMHSJitDKxdj2E10MUhpYppOHRDIaJKieVmFlvgCRtpjiMlSQ6HIBidYmlYp2JIZSTBFUVYzR2BiIM4U2SDQIMCjSRc/pXmUR/uX4zWuYaFMI14ejvLJxs1wqDSYuX3jwRHtN1QMLY2HxyR5YZ6SaxlCIS2KrdPBTJZNLItuiSmumHhwdMq92do6rstTGYQrvPAn7OzvU8w0Sj4VBHp/ootAKSmFEgQ6N9dJF3QZ/qqRhuXAZiDyvebF/pnqws+MWJe7v7MChSmXC4kkAqZVE0I/t+6HEJBp6XGIiJzIMbbEOtApSRzyZCb+fZS4Sj6ZBW2Li5BV2Ac9jWBDgl6h0jUGmjfxZKydy3o4rNE4mIm9vGyHI4u2EccTOUkvl6tawQnNyaPd4U4JcEWopMauQinsswpXIK7QBq1kMGWH1A5YGLZ3yGi4xUqWQoZxmt64n0veVdR3AUFlCs41FWKveJWYvMtsmIrcIctLhZSEusbVaowH68M0CUpyIKncxSJI4Zyrsw2vt6OTlMiFFQ5LLZ1q4ymCPdzmIQ0BEiYL3+GilA1I5maChw0mdDCLMqbEjOfNKg8jjk+MyoUCrtY1OdK7NTRHi5i4fIdHKseY7uBIyZ+Q9sbZRf+NcJJcxjPMKYzCY+oO7wDzXs9jLOw8hBed5zvwhtUxSqBXhr3RYXlqwAatGEdbniTobZUuLSNvmaji1E00rEwvqIwZYCJnHzLgY3usxOOlyjOnAlkItYkiFwxgczt1Yz2NIMkwux3oe+DXRyln584ZTV/d8OtdGMezF8CSGpzEMd2MYjmIY7sUwfBLD8GkMo90YRqMYRnsxjJ54no6eBn6KholtBIYjz0n3ZXGQ9OcrafmEkuKzjS6ddXTpsA87O82poLYff/zxTF2fKYCziA7JWbQPZ1Ez5CyKfR/pPuobhu85fTwafR0+F/T5ZPQ0fM546HAvfGb0ORqeqWVY8EyNGBMnivIOLKj7N8UgfAVBoTZelNpqvUSNpFDiuoP2o4MPdSzbtDwiWqSSTorc3k5OPeILomiF0g2i9ogoFsnbKeLuL4icNj7Uw+rOd7F6bHXVh5qxGN2g/nE/3BC3E++X/WJob6HzeaQ/IdJJ/ZyQ+rmd/kZDfUFMWMfp8zjxdZ8vcta+t/MhDPiCuNDF6PN48JR4QBfP7Qyg3i+I+hY61BFucd+3u9cbPu6Ndkd7HQ6Qj+MHFEUvTXuLxeK34B7ZNWF5MmtqS9NbaMIhTIwuNrgRbOWvRgW7h3/Xpve/kcE9rm1RTGsftLFKGs+tbS07nYrFA+tB1VMbA4zGr8yvRQtN7iI82ItNMi2TgDyNqc2uMTlqfeJBjzk5SNNBi5PUmKa9ouitNdJnjxnfaiyKfpr210be2B3fWECaxnCzeWN7mkJRFLc0+/ZO86AoblLRL4qAG9N7pv6JjkmwzG4/KWHA3+uwrM5Ed+E7DxLFALTKeW12zDafpLXrJpMqdASxgrUBBqdVLgzOycO0Uis/+rc/ZfUhW9nv7JGyM8f+vmcFfPUm2OgPwwEgEroAqOX+eTcoIyAHkFTW6QIMTnEOpXAOjWJgVyKXqWCnrMcNOBdFSYb+4C9nZ+k//sOAQwnkrTugnYBUTiVFdAZ/OT3o/fv5hhFVWaJJhEXIkVayMaBL+nCaYV6ugkqz2aw/e2STTOvcR5TeW4MT//dCj99fMLplX9jy4SZKvWi0XHcSnXXP3aLrcExYqGducN5ZxtiFGe7yfRu8mjsu3DDiC7pz1lCiTh8Hoe7Ts6gQbJKQKOPqt3YZmrPovJnj3XVM75l7/hGHNZMp5mKM+c2ujz5oTXMuFroK57sOT3VJDRLd4ht1FFI1EQgmZzdudYr5WqfvW244354h7dNZXzr18ax3AHJp6xhMl53t2SFIxaFDCgiT2I4R6gkwbqT0s09Bg9jHHQOvicLe3bMEjQMe2AQIm5jA3St0NqbNGIJRSCWLqmginZMGas2yIlgfbX7RzMqiqVdo7+6NFcT8nhUorHj7AmdqyJEMWYjpHYYpd39BWiLgsybfURzpkt5LpFaHabQf1W8pUcxA0bpvdLqI9q+jEPOinyGiRJMG7y29w1xHNsmwEPSrRoZebiYyxyiO/MuIjeKIHSR6xiFORfuRHr/HxEUxXd0lnW60BIPn7V/Xo3w8P4qDuRztRz7QH8VRuMCaJkCVaDJKy3QSLesF7wLVtKxAWf7RPCwQHAqZ/0owr2nqcu3l6ldBetmCwLQVeKJfaOpz+FIsbAuul+9o/cGM5tD5TcIsSMXCUpiwsl4VJSJPqpxMb5yX0iwaP4Dt74YlLXyblRp8h4+X9aa3MLplr43+9A1KUBMDOObyqXPfaxwj/jE0kCXC+yuKT8bivUYYI+9tmWn1yfOHo0fD0fDRcEQQQrC0BUMYIxZRHEmHhb2fj773Jgbd/T+g0C+m9S3UW71TxMAxxv59oliPZ7LFFO+XuZPb3q9aIXWb6SpPKViNwvT5GelXv1B2xZgWYWr79wjtMo7m9xMzh0T36scx+CrHifMmMCTaKDQP2571F0PcaG9vGUeL+8lb/K8k72vavNn91L3jV8XVi+vvgeujp8s4yu7H9fvm3fN3RHbvyXJ1iUaJQeHQYVESkIuxThcXtd5atgfWZkR9Xfih4UZY0op5ioYsjpv6aqVqaCS911+s6/mx1jkKtUHRdB7DBOk6y2YrGcUhtDTLkHyflTXL0G1jhgcT2pss9MCGa968tGTpmQrPoj4cTla89Ibw+ntcPZbf45SGB7zeha1YjT8YhG/i0IN2bgE9965CajUKPBjqLbAwk3lOeNP13YfmH5t2DScJgfq6rBe+/6p44aMIvGCY1H3ZhmAi9uGFUM3LZ/eFEa6vGyFg6Vgu4fqadhXNBV26y2W8aqC1Og18r/oWgwnKq86spglXE5u21lRvyVyQJeMbQpS6jYBPwbmoTIBDBt9y2e8I5BrikLFfxTzAtJEzSsO5SXVjr/BOfzT3bzA7SAAB+X/D92fl8+/lBlSeDcrnz8rn7yiPpUR/9jx7JlKl/uTPMM/78Mw6o9X0+RoLng1C++atNHglccYHl3d1BWWdtw2gfsCJErVamyctJKZKpMg5fGZ0gnWyEO2bwrkD67C05KpL5zPCOA2BzW4xNYicuUW4iMpx3g57YPWCzwRkBif//GCNpw+ec14YpWw9G4jnYfSh9+YzcYUg1AKYcA5qaOOjEpPKsJpMcmHkJLh7MZQ5UqiPvEGR+CiD52iNx0km1KWNn43N8xMURZOZ9uGvf6MRfAw4He9EV+YjdDoHH3p+b73v63WeBwICphU/QjjiU62eOAq5ypWRyjpT+XgApJWp04PqvDveD2v7IRuoB6m0PmEiwzb8GFBZP13ARFiHJoZKSeXQmKokybmZytcRZV5gSc61z2OjPbpfF3STUiit0afgtbIO63ugBowh6zD4eU1CVJ0BuE76xos3nJP7EaRLktOWQiioRGO1IlnSZipUEFVv+GtLXlMmcj/Un1dJTziED92/XWRqk+bDX//WwutW1+8mYn4FkaYUI78HQw4AUaTHchjIYJkvwOkuRgQPzR/Xba3oXgvIG0mrAEm4lylhTyvr3bjR7i791yWjzoAFb4GlYKuEtm1S5fniD1H88dGZu31I37zZLrvLKczey9HP8+RqdERbdItM3wkg2LCVySkHlDjXa9Jy13krVS4VXtRsuxjt7l4MibfLONrbxL5jXaDLOOGJmDgjTd2oMmcWIKZCKiCLyvyG3ERjtLnbxP00zO5iwl6HCY9vMuFQcaycs6RP9CWqvy+l7eWdX55QnRcsK17NRNIP4v6oQ2y73RNpMamMdIto//Q6mvdEKXu+f//0fHkeR8RYTTHNUlvGWLgs2o8GrRCnRXNFcUmCwELbyKEVKqVQ9g1/SpRycDXsD6NlvD5no/91x3isep86xToxlWp637zzFXeOaQf9JnV4tIoylfJfkcJMYQvao+JIkuRkKFLy25ZxRILxwyow/G29vXXIdlMUtqUU1+KqdVi1EyldV+EbYp+bQ5/Dx+2gow8rcqSwCRRuiv01hNfRvCaY14rPtcJzpyshbyJhdSBsyBGk0d4eh1q+HnJM4tFTdvf3nizPO55vFHW9Ww7cr/ton+dydD2OrRn9f8iM7lrR/pF1zaqsBayx4jqm1LoldbtVQ1pgolllhHPcVJuQMmeVcyPQhnmiiybjuIU9z6n33RtdBOEP9LL2pjJQ6hmaSeXTlyc5ziUZ4jQJC+5bBXRQFDlamy+ALPAplf34fAWRN/ZtIkoxlrmkm4qG6SAJq8vO9uHdKiT0wPj0jSvM6YIjIdGFYPu5sZ1n2lxS8Q3VsMCYqg3IsESVCZV4G9br3pikgCpkyD8ojbRURGEIa+lx08oZ2v5CKDFlwYw7rEoxp3NqwegxPXtanVdevJyQuTb+xYYJImGz/Dz57bykLo4UkvVvMKMdvQqejKWk7hTBq9VQhjOmwEJJuMgEORRWqVxTxQwFFao8h1KTnUAHT086ONJ0Z4SyZN6FR6KwBw3DgpOBNqSLv7VIO/xKqkufHd6D00am3uHYSofdzJF1qXzYnfOddN9XY6oh0VY6bRar2VPpsmrMF2QbSPPhIX0Xysagdf2tYKQ6sRtCqzqxA0pyGRyjIwmxg4OjQzatHsKHX/4DXqEwCjI989KaVAbzRVOh5uufeOc92xrLiN1Y0k7E8cQLX1CqNQffZcJ9+OU/LbxGrgGjI+QZubNzVI1zmcBJHSPc2dmHF+w3tOKGnZfuTJAoXUkBAko/O5fqsg8HasHe0ErFUjvP65DBar3ebl+GlYJWIRXHr9lfYUTthcX8CtnNopKGMXLRHEl0ZnQ19au1kQnEGZyQqxvqtIi2gzSl0jxurktmqOpohQ5OfLEMLnxUlWs3jtamcE9TuxByGlcBNVQpFz7ZfUiNmLgV/Hgl6OyesYK/0VRXdtTsiAOYZkv8SQwUN619juSumW5dXWtwgvwyy2Sv9qWUQZxOa7GEbkrWp4s1XQbhzmKzP1wdopQb7w0q+7JvJsdormRSu3m3nOgBDx5EcZTLBJXFlltw8N3RK7h61N+N4pZB/BGHe/Dq8MW3r4+/JWRIkXqGDfu7/V1+vtTWFUK1VjrGfALH3jtYe69vXKVt0em26HRbdLotOt0WnW6LTrdFp9ui023R6bbodFt0ui063Rad/m4lMNui023R6bbodFt0ui063RadbotOt0Wn26LTbdHptuj0d9cStxadhgwaUpiDMhdStdIGfZ7W6aoU9TyOMkrh2j+Nrq8p2P6WEjKo+acKDeV/ncfRlTCSwk2c/RXXKUuUrXOJlPvywkfPeie0cuyVFb9crSW9Uc6Vn3GQJFi6O8e2s8yO3hyfRHFUJ/cXOqU5RsyolFbMfDpG4CPnJwmuV8qFmlacPBR5mJRlRW+/3RStS07RCj9aOUhCLVoYdnO3PBn0l4jaOOH62qd/ca6QH++7bp0RGFuPpp07Xy6X/wNHVMrb","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Contact list","permalink":"/docs/API-docs/v1.1/contactlist"},"next":{"title":"Draft Document","permalink":"/docs/API-docs/v1.1/draftdocument"}}');var s=t(74848),o=t(28453),r=t(33617),a=t.n(r),l=t(17543),d=t.n(l),c=t(86013),p=t.n(c),h=t(63723),m=t.n(h),u=(t(18766),t(79329),t(9303));const g={id:"selfsign",title:"Self Sign",description:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.",sidebar_label:"Self Sign",hide_title:!0,hide_table_of_contents:!0,api:"eJztO11vG0lyf6VuEMBrZUiKtOx1BMc4rb23q8SxhZUM4yLptM2ZIqetme7Z7h6RXIHAPtw/yFOA5OV+mn9JUNU9wxmKkuz14tZJ6AeZ0x/VVdXV1VXVVdeRE1Mb7Z9GL3VSFaicjc7jKEWbGFk6qVW0H51kCBbziZVTBQdHhzBFhUY4tCDg7Q+vwGXCASoxztHCxCBat8gRaLxUU9ATEJAG+H34s64gEQpEbjVIleRViqB5MZFDabCX4kQqTGEm0yk6G8Msk0kGLvMw0fB8TKUDbQDnpVApVKVWICwoxBTTPpxk0kJp9JVMGdEaG5yXaCSqhIAVMhcGnGbYH375r2Mi8c+6MkTvh1/+Gya5noFU3P+mRMUDRFn2z9SZOpHlPrwtcy1SWOjKwNHLPzWEElRqO93ZeYnjagpvD3d2zr/KnCvt/mBAMHSJitDKxdj2E10MUhpYppOHRDIaJKieVmFlvgCRtpjiMlSQ6HIBidYmlYp2JIZSTBFUVYzR2BiIM4U2SDQIMCjSRc/pXmUR/uX4zWuYaFMI14ejvLJxs1wqDSYuX3jwRHtN1QMLY2HxyR5YZ6SaxlCIS2KrdPBTJZNLItuiSmumHhwdMq92do6rstTGYQrvPAn7OzvU8w0Sj4VBHp/ootAKSmFEgQ6N9dJF3QZ/qqRhuXAZiDyvebF/pnqws+MWJe7v7MChSmXC4kkAqZVE0I/t+6HEJBp6XGIiJzIMbbEOtApSRzyZCb+fZS4Sj6ZBW2Li5BV2Ac9jWBDgl6h0jUGmjfxZKydy3o4rNE4mIm9vGyHI4u2EccTOUkvl6tawQnNyaPd4U4JcEWopMauQinsswpXIK7QBq1kMGWH1A5YGLZ3yGi4xUqWQoZxmt64n0veVdR3AUFlCs41FWKveJWYvMtsmIrcIctLhZSEusbVaowH68M0CUpyIKncxSJI4Zyrsw2vt6OTlMiFFQ5LLZ1q4ymCPdzmIQ0BEiYL3+GilA1I5maChw0mdDCLMqbEjOfNKg8jjk+MyoUCrtY1OdK7NTRHi5i4fIdHKseY7uBIyZ+Q9sbZRf+NcJJcxjPMKYzCY+oO7wDzXs9jLOw8hBed5zvwhtUxSqBXhr3RYXlqwAatGEdbniTobZUuLSNvmaji1E00rEwvqIwZYCJnHzLgY3usxOOlyjOnAlkItYkiFwxgczt1Yz2NIMkwux3oe+DXRyln584ZTV/d8OtdGMezF8CSGpzEMd2MYjmIY7sUwfBLD8GkMo90YRqMYRnsxjJ54no6eBn6KholtBIYjz0n3ZXGQ9OcrafmEkuKzjS6ddXTpsA87O82poLYff/zxTF2fKYCziA7JWbQPZ1Ez5CyKfR/pPuobhu85fTwafR0+F/T5ZPQ0fM546HAvfGb0ORqeqWVY8EyNGBMnivIOLKj7N8UgfAVBoTZelNpqvUSNpFDiuoP2o4MPdSzbtDwiWqSSTorc3k5OPeILomiF0g2i9ogoFsnbKeLuL4icNj7Uw+rOd7F6bHXVh5qxGN2g/nE/3BC3E++X/WJob6HzeaQ/IdJJ/ZyQ+rmd/kZDfUFMWMfp8zjxdZ8vcta+t/MhDPiCuNDF6PN48JR4QBfP7Qyg3i+I+hY61BFucd+3u9cbPu6Ndkd7HQ6Qj+MHFEUvTXuLxeK34B7ZNWF5MmtqS9NbaMIhTIwuNrgRbOWvRgW7h3/Xpve/kcE9rm1RTGsftLFKGs+tbS07nYrFA+tB1VMbA4zGr8yvRQtN7iI82ItNMi2TgDyNqc2uMTlqfeJBjzk5SNNBi5PUmKa9ouitNdJnjxnfaiyKfpr210be2B3fWECaxnCzeWN7mkJRFLc0+/ZO86AoblLRL4qAG9N7pv6JjkmwzG4/KWHA3+uwrM5Ed+E7DxLFALTKeW12zDafpLXrJpMqdASxgrUBBqdVLgzOycO0Uis/+rc/ZfUhW9nv7JGyM8f+vmcFfPUm2OgPwwEgEroAqOX+eTcoIyAHkFTW6QIMTnEOpXAOjWJgVyKXqWCnrMcNOBdFSYb+4C9nZ+k//sOAQwnkrTugnYBUTiVFdAZ/OT3o/fv5hhFVWaJJhEXIkVayMaBL+nCaYV6ugkqz2aw/e2STTOvcR5TeW4MT//dCj99fMLplX9jy4SZKvWi0XHcSnXXP3aLrcExYqGducN5ZxtiFGe7yfRu8mjsu3DDiC7pz1lCiTh8Hoe7Ts6gQbJKQKOPqt3YZmrPovJnj3XVM75l7/hGHNZMp5mKM+c2ujz5oTXMuFroK57sOT3VJDRLd4ht1FFI1EQgmZzdudYr5WqfvW244354h7dNZXzr18ax3AHJp6xhMl53t2SFIxaFDCgiT2I4R6gkwbqT0s09Bg9jHHQOvicLe3bMEjQMe2AQIm5jA3St0NqbNGIJRSCWLqmginZMGas2yIlgfbX7RzMqiqVdo7+6NFcT8nhUorHj7AmdqyJEMWYjpHYYpd39BWiLgsybfURzpkt5LpFaHabQf1W8pUcxA0bpvdLqI9q+jEPOinyGiRJMG7y29w1xHNsmwEPSrRoZebiYyxyiO/MuIjeKIHSR6xiFORfuRHr/HxEUxXd0lnW60BIPn7V/Xo3w8P4qDuRztRz7QH8VRuMCaJkCVaDJKy3QSLesF7wLVtKxAWf7RPCwQHAqZ/0owr2nqcu3l6ldBetmCwLQVeKJfaOpz+FIsbAuul+9o/cGM5tD5TcIsSMXCUpiwsl4VJSJPqpxMb5yX0iwaP4Dt74YlLXyblRp8h4+X9aa3MLplr43+9A1KUBMDOObyqXPfaxwj/jE0kCXC+yuKT8bivUYYI+9tmWn1yfOHo0fD0fDRcEQQQrC0BUMYIxZRHEmHhb2fj773Jgbd/T+g0C+m9S3UW71TxMAxxv59oliPZ7LFFO+XuZPb3q9aIXWb6SpPKViNwvT5GelXv1B2xZgWYWr79wjtMo7m9xMzh0T36scx+CrHifMmMCTaKDQP2571F0PcaG9vGUeL+8lb/K8k72vavNn91L3jV8XVi+vvgeujp8s4yu7H9fvm3fN3RHbvyXJ1iUaJQeHQYVESkIuxThcXtd5atgfWZkR9Xfih4UZY0op5ioYsjpv6aqVqaCS911+s6/mx1jkKtUHRdB7DBOk6y2YrGcUhtDTLkHyflTXL0G1jhgcT2pss9MCGa968tGTpmQrPoj4cTla89Ibw+ntcPZbf45SGB7zeha1YjT8YhG/i0IN2bgE9965CajUKPBjqLbAwk3lOeNP13YfmH5t2DScJgfq6rBe+/6p44aMIvGCY1H3ZhmAi9uGFUM3LZ/eFEa6vGyFg6Vgu4fqadhXNBV26y2W8aqC1Og18r/oWgwnKq86spglXE5u21lRvyVyQJeMbQpS6jYBPwbmoTIBDBt9y2e8I5BrikLFfxTzAtJEzSsO5SXVjr/BOfzT3bzA7SAAB+X/D92fl8+/lBlSeDcrnz8rn7yiPpUR/9jx7JlKl/uTPMM/78Mw6o9X0+RoLng1C++atNHglccYHl3d1BWWdtw2gfsCJErVamyctJKZKpMg5fGZ0gnWyEO2bwrkD67C05KpL5zPCOA2BzW4xNYicuUW4iMpx3g57YPWCzwRkBif//GCNpw+ec14YpWw9G4jnYfSh9+YzcYUg1AKYcA5qaOOjEpPKsJpMcmHkJLh7MZQ5UqiPvEGR+CiD52iNx0km1KWNn43N8xMURZOZ9uGvf6MRfAw4He9EV+YjdDoHH3p+b73v63WeBwICphU/QjjiU62eOAq5ypWRyjpT+XgApJWp04PqvDveD2v7IRuoB6m0PmEiwzb8GFBZP13ARFiHJoZKSeXQmKokybmZytcRZV5gSc61z2OjPbpfF3STUiit0afgtbIO63ugBowh6zD4eU1CVJ0BuE76xos3nJP7EaRLktOWQiioRGO1IlnSZipUEFVv+GtLXlMmcj/Un1dJTziED92/XWRqk+bDX//WwutW1+8mYn4FkaYUI78HQw4AUaTHchjIYJkvwOkuRgQPzR/Xba3oXgvIG0mrAEm4lylhTyvr3bjR7i791yWjzoAFb4GlYKuEtm1S5fniD1H88dGZu31I37zZLrvLKczey9HP8+RqdERbdItM3wkg2LCVySkHlDjXa9Jy13krVS4VXtRsuxjt7l4MibfLONrbxL5jXaDLOOGJmDgjTd2oMmcWIKZCKiCLyvyG3ERjtLnbxP00zO5iwl6HCY9vMuFQcaycs6RP9CWqvy+l7eWdX55QnRcsK17NRNIP4v6oQ2y73RNpMamMdIto//Q6mvdEKXu+f//0fHkeR8RYTTHNUlvGWLgs2o8GrRCnRXNFcUmCwELbyKEVKqVQ9g1/SpRycDXsD6NlvD5no/91x3isep86xToxlWp637zzFXeOaQf9JnV4tIoylfJfkcJMYQvao+JIkuRkKFLy25ZxRILxwyow/G29vXXIdlMUtqUU1+KqdVi1EyldV+EbYp+bQ5/Dx+2gow8rcqSwCRRuiv01hNfRvCaY14rPtcJzpyshbyJhdSBsyBGk0d4eh1q+HnJM4tFTdvf3nizPO55vFHW9Ww7cr/ton+dydD2OrRn9f8iM7lrR/pF1zaqsBayx4jqm1LoldbtVQ1pgolllhHPcVJuQMmeVcyPQhnmiiybjuIU9z6n33RtdBOEP9LL2pjJQ6hmaSeXTlyc5ziUZ4jQJC+5bBXRQFDlamy+ALPAplf34fAWRN/ZtIkoxlrmkm4qG6SAJq8vO9uHdKiT0wPj0jSvM6YIjIdGFYPu5sZ1n2lxS8Q3VsMCYqg3IsESVCZV4G9br3pikgCpkyD8ojbRURGEIa+lx08oZ2v5CKDFlwYw7rEoxp3NqwegxPXtanVdevJyQuTb+xYYJImGz/Dz57bykLo4UkvVvMKMdvQqejKWk7hTBq9VQhjOmwEJJuMgEORRWqVxTxQwFFao8h1KTnUAHT086ONJ0Z4SyZN6FR6KwBw3DgpOBNqSLv7VIO/xKqkufHd6D00am3uHYSofdzJF1qXzYnfOddN9XY6oh0VY6bRar2VPpsmrMF2QbSPPhIX0Xysagdf2tYKQ6sRtCqzqxA0pyGRyjIwmxg4OjQzatHsKHX/4DXqEwCjI989KaVAbzRVOh5uufeOc92xrLiN1Y0k7E8cQLX1CqNQffZcJ9+OU/LbxGrgGjI+QZubNzVI1zmcBJHSPc2dmHF+w3tOKGnZfuTJAoXUkBAko/O5fqsg8HasHe0ErFUjvP65DBar3ebl+GlYJWIRXHr9lfYUTthcX8CtnNopKGMXLRHEl0ZnQ19au1kQnEGZyQqxvqtIi2gzSl0jxurktmqOpohQ5OfLEMLnxUlWs3jtamcE9TuxByGlcBNVQpFz7ZfUiNmLgV/Hgl6OyesYK/0VRXdtTsiAOYZkv8SQwUN619juSumW5dXWtwgvwyy2Sv9qWUQZxOa7GEbkrWp4s1XQbhzmKzP1wdopQb7w0q+7JvJsdormRSu3m3nOgBDx5EcZTLBJXFlltw8N3RK7h61N+N4pZB/BGHe/Dq8MW3r4+/JWRIkXqGDfu7/V1+vtTWFUK1VjrGfALH3jtYe69vXKVt0em26HRbdLotOt0WnW6LTrdFp9ui023R6bbodFt0ui063Rad/m4lMNui023R6bbodFt0ui063RadbotOt0Wn26LTbdHptuj0d9cStxadhgwaUpiDMhdStdIGfZ7W6aoU9TyOMkrh2j+Nrq8p2P6WEjKo+acKDeV/ncfRlTCSwk2c/RXXKUuUrXOJlPvywkfPeie0cuyVFb9crSW9Uc6Vn3GQJFi6O8e2s8yO3hyfRHFUJ/cXOqU5RsyolFbMfDpG4CPnJwmuV8qFmlacPBR5mJRlRW+/3RStS07RCj9aOUhCLVoYdnO3PBn0l4jaOOH62qd/ca6QH++7bp0RGFuPpp07Xy6X/wNHVMrb",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},x=void 0,y={},f=[];function j(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(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:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signer:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"selfsigndocument_body_signer"},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"{{sender_name}} has requested you to sign {{document_title}}"},email_body:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"

Hi {{receiver_name}},

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

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

Sign here

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

Thanks,
Team OpenSign\u2122

"},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"}},title:"selfsigndocument_body"}}},required:!0}}),"\n",(0,s.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"hji2zxcv2P"},url:{type:"string",format:"string",example:"https://url-to-sign-document.com"}},title:"inline_response_200_1"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[285],{64658:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>f,contentTitle:()=>x,default:()=>j,frontMatter:()=>g,metadata:()=>i,toc:()=>y});const i=JSON.parse('{"id":"API-docs/v1.1/selfsign","title":"Self Sign","description":"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.","source":"@site/docs/API-docs/v1.1/selfsign.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/selfsign","permalink":"/docs/API-docs/v1.1/selfsign","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"selfsign","title":"Self Sign","description":"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.","sidebar_label":"Self Sign","hide_title":true,"hide_table_of_contents":true,"api":"eJztO11vG0lyf6UyCOC1MiRFWvY6gmOc1t7sKnFsYSXDuEg6bXOmyGlrpnu2u0ckVyCwD/cP7umA5OV+mn9JUNU9wxmKkuz14tZJ6AeZ05/11dVV1VXXkRNTG+2fRi91UhWonI3O4yhFmxhZOqlVtB+dZAgW84mVUwUHR4cwRYVGOLQg4O0Pr8BlwgEqMc7RwsQgWrfIEWi8VFPQExCQhvX78EddQSIUiNxqkCrJqxRB82Yih9JgL8WJVJjCTKZTdDaGWSaTDFzm10TD8zGVDrQBnJdCpVCVWoGwoBBTTPtwkkkLpdFXMmVAa2hwXqKRqBJarJC5MOA0r/3hl/86JhT/qCtD+H745b9hkusZSMX9b0pUPECUZf9MnakTWe7D2zLXIoWFrgwcvfzXBlFaldpOd3Ze4riawtvDnZ3zrzLnSrs/GNAaukRFYOVibPuJLgYpDSzTyUNCGQ3Sqh5XYWW+AJG2iOIyVJDocgGJ1iaVijgSQymmCKoqxmhsDESZQhskHAQYFOmi53Svsgj/dvzmNUy0KYTrw1Fe2bjZLpUGE5cv/PKEe43VAwtjYfHJHlhnpJrGUIhLIqt08FMlk0tC26JKa6IeHB0yrXZ2jquy1MZhCu88Cvs7O9TzDRKNhUEen+ii0ApKYUSBDo310kXdBn+qpGG5cBmIPK9psX+merCz4xYl7u/swKFKZcLiSQtSK4mgH9v3Q4lINPS4xEROZBjaIh1oFaSOaDITnp9lLhIPpkFbYuLkFXYXnsewoIVfotI1BJk28metnMiZHVdonExE3mYbAcji7YRxRM5SS+Xq1rBDc3KIe8yUIFcEWkrEKqTiHotwJfIKbYBqFkNGUP2ApUFLp7xelwipUshQTrNb9xPp+8q6zsJQWQKzDUXYq+YSkxeZbBORWwQ56dCyEJfY2q3RAH34ZgEpTkSVuxgkSZwzFfbhtXZ08nKZkKIhyeUzLVxlsMdcDuIQAFGiYB4frXRAKicTNHQ4qZOXCHNq6EjOvNIg9PjkuEwo0GqN0YnOtbkpQtzcpSMkWjnWfAdXQuYMvEfWNupvnIvkMoZxXmEMBlN/cBeY53oWe3nnIaTgPM2ZPqSWSQq1IviVDttLCzZA1SjC+jxRZ6NsaRNp21QNp3aiaWciQX3EAAsh85gJF8N7PQYnXY4xHdhSqEUMqXAYg8O5G+t5DEmGyeVYzwO9Jlo5K3/ecOrqnk+n2iiGvRiexPA0huFuDMNRDMO9GIZPYhg+jWG0G8NoFMNoL4bRE0/T0dNAT9EQsQ3AcOQp6b4sCpL+fCUtn1BSfLbRpbOOLh32YWenORXU9uOPP56p6zMFcBbRITmL9uEsaoacRbHvI91HfcPwPaePR6Ovw+eCPp+MnobPGQ8d7oXPjD5HwzO1DBueqRFD4kRR3gEFdf+mEISvICjUxptSW62XqJEUSlx3ED868FDHso3LI8JFKumkyO3t6NQjviCMViDdQGqPkGKRvB0j7v6C0GnDQz2s7nwXq8dWV32oGYrRDewf98MNcTvyftsvBvcWOJ+H+hNCndTPCamf2/FvNNQXRIR1mD6PEl/3+SJn7Xs7HcKAL4gKXYg+jwZPiQZ08dxOAOr9grBvgUMd4Rb3fbt7veHj3mh3tNehAPk4fkBR9NK0t1gsfgvqkV0TtiezprY0vYUmHMLE6GKDG8FW/mpUsHv4d216/wcZ3OPaFsW09kEbq6Tx3NrWstOpWDywfql6amOA0fiV+bVogcldBAd7sUmmZRKApzG12TUmR61PNOgxJQdpOmhRkhrTtFcUvbVG+uwx4VuNRdFP0/7ayBvc8Y0FpGkMN5s3tqcpFEVxS7Nv7zQPiuImFv2iCLAxvmfqn+mYBMvs9pMSBvy9DsvqTHQ3vvMgUQxAq5z3Zsds80lau24yqUJHECtYG2BwWuXC4Jw8TCu18qN/+1NWH7KV/c4eKTtz7O97UsBXb4KN/jAcAEKhuwC13D/vBma0yAEklXW6AINTnEMpnEOjeLErkctUsFPW4waci6IkQ3/wp7Oz9J/+ccChBPLWHRAnIJVTSRGdwZ9OD3r/eb5hRFWWaBJhEXKknWwM6JI+nGaYl6ug0mw2688e2STTOvcRpffW4MT/vdDj9xcMbtkXtny4CVMvGi3XnURn3XO36DoUExbqmRucd5YxdmGGu3zfBq/mjgs3jPiC7pw1kKjTx0Go+/QsKgSbJCTKuPqtXYbmLDpv5nh3HdN75p5/xGHNZIq5GGN+s+ujD1rTnIuFrsL5rsNTXVSDRLfoRh2FVE0EgtHZjVudYr7W6fuWG863J0j7dNaXTn08aw5ALm0dg+mSsz07BKk4dEgBYRLbMUI9AcaNlH72KWgA+7hj4DVR4N09W9A44IFNgLCJCdy9Q4cxbcLQGoVUsqiKJtI5aVatSVYE66NNL5pZWTT1Dm3u3thBzO/ZgcKKt29wpoYcyZCFmN5hmHL3F6QlAjxr8h3FkS7pvURqdZhG+1H9lhLFvCha941OF9H+dRRiXvQzRJRo0uC9pXeY68gmGRaCftXA0MvNROYYxZF/GbFRHLGDRM84RKloP9Lj95i4KKaru6TTjZbW4Hn71/UoH8+P4mAuR/uRD/RHcRQusKYJUCWajNIynUTLesO7lmpaVktZ/tE8LNA6FDL/lcu8pqnLtZerX7XSy9YKjFuBJ/qFpj6HL8XCttb18h2tP5jRHDq/SZgFqVhYChNW1quiRORJlZPpjfNSmkXjB7D93ZCkBW+zUwPv8PGyZnoLolt4bfSnMyhBTQTgmMunzn2vcYz4h9BAlgjzVxSfDMV7jTBG5m2ZafXJ84ejR8PR8NFwRCuEYGlrDWGMWERxJB0W9n46+t6bEHT5f0ChX0zrW6i3eqeIgWOM/ftEsR7PaIsp3i9zJ7e9X7VC6jbTVZ5SsBqF6fMz0q9+oeyKMW3C2PbvEdplHM3vR2YOie7Vj2PwVY4T501gSLRRaB62PesvBrnR3t4yjhb3o7f4X4ne18S82f3YveNXxdWL6+8B66OnyzjK7of1++bd83cEdu/JcnWJRolB4dBhUdIiF2OdLi5qvbVsD6zNiPq68EPDjbCkHfMUDVkcN/XVStXQSHqvv1jX82OtcxRqg6LpPIYJ0nWWzVYyikNoaZYh+T4ra5ZXt40ZHkxob7LQAxuuefPSkqVnKjyL+nA4WdHSG8Lr73H1WH6PUxoe8H4XtmI1/mAQvolCD9q5BfTcuwqp1SDwYKhZYGEm85zgpuu7D80/Nu0aShIA9XVZb3z/VfHCRxF4wzCp+7INwUTswwuhmpfP7gsjXF83QsDSsVzC9TVxFc0FXbrLZbxqoL06DXyv+haDCcqrzqymCVcTm7bWVG/JXJAl4xtClLoNgE/BuahMWIcMvuWy3xHINcAhY7+KaYBpI2eUhnMT68ZeYU5/NPVvEDtIAC3y/4buz8rn38sNoDwblM+flc/fUR5Lif7sefJMpEr9yZ9hnvfhmXVGq+nzNRI8G4T2zaw0eCVxxgeXubpaZZ22zUL9ABMlarWYJy0kpkqkyDl8ZnSCdbIQ8U3h3IF1WFpy1aXzGWGchsBmt5gaRM7cIlhE5Thvhz2wesNnAjKDk395sEbTB885L4xStp4NxPMw+tB785m4QhBqAYw4BzW08VGJSWVYTSa5MHIS3L0Yyhwp1EfeoEh8lMFTtIbjJBPq0sbPxub5CYqiyUz78Oe/0Qg+BpyOd6Ir8xE6nYMPPc9b7/t6necXAQHTih8hHNGpVk8chVzlykhlnal8PADSytTpQXXeHfPD2n7IBupBKq1PmMiwvX4MqKyfLmAirEMTQ6WkcmhMVZLk3Ezl64gyb7Ak59rnsRGP7tcF3aQUSmv0KXitrMP6HqgXxpB1GPy8JiGqzgBcR33jxRvOyf0A0iXJaUshFFSisVqRLGkzFSqIqjf8tSWvKRO5H+rPq6QnHIKH7t8uMLVJ8+HPf2vBdavrdxMwv4NIU4qR3wMhB4Ao0mM5DGSwzBfgdBciWg/NH9ZtreheC8gbSasASbiXKWFPK+vduNHuLv3XRaPOgAVvgaVgq4TYNqnyfPEPUfzx0Zm7fUjfvNkuu8spzN7L0c/z5Gp0RCy6RabvXCDYsJXJKQeUKNdr0nLXaStVLhVe1GS7GO3uXgyJtss42ttEvmNdoMs44YmIOCNN3agyZxYgpkIqIIvK/IbURGO0udvE/TTI7iLCXocIj28S4VBxrJyzpE/0Jaq/L6bt7Z3fnkCdFywrXs1E0g/i/qiDbLvdI2kxqYx0i2j/9Dqa90Qpe75///R8eR5HRFhNMc1SW4ZYuCzajwatEKdFc0VxSVqBhbaRQytUSqHsG/6UKOXgatgfRst4fc5G/+uO8Vj1PnWKdWIq1fS+eecr6hwTBz2TOjRaRZlK+e9IYabAgvaoOJIkORmKlPy2ZRyRYPywCgx/W7O3DtluisK2lOJaXLUOq3YipesqfEPsc3Poc/i4HXT0YUWOFDaBwk2xvwbxOprXBPNa8blWeO50JeRNJKwOhA05gjTa2+NQy9dDjkk8esru/t6T5XnH842irnfLgft1H+3zXI6ux7E1o/8PmdFdK9o/sq5ZlbWANVZcx5Rat6Rut2pIC0w0q4xwjptqE1LmrHJuBNowT3TRZBzv7LTgb2bt7DSqwPOAXtfeVAZKPUMzqXwK8yTHuSRjnKZhwX2roA6KIkdr8wWQFT6l0h+fsyDyxsZNRCnGMpd0W9EwHaRhdeHZPrxbhYUeGJ/CcYU5XXIkKLoQbEM39vNMm0sqwKE6FhhTxQEZl6gyoRJvx3r9G5MkUJUM+QilkZYKKQxBLT1sWjlDIlAIJaYsnHGb2ZBiTmfVgtFjevq0Oq+8iDkhc238qw0jRAJnmYjfzkvq4mgheQAGM+LqVfBmLCV2pwhetYZSnDEFF0qCRSbI4bBK5ZqqZiiwUOU5lJpsBTp8etKBkaY7I5QlEy88FAUeNAQLjgbakDL+1iJx+JVUlz5DvAenjVy9w7GVDrvZI+uS+bA75zvpvq/GVEeirXTaLFazp9Jl1ZgvyfYizYdf6btQOgatK3C1RqoTuyG8qhM7oESXwTE6khA7ODg6ZPPqIXz45S/wCoVRkOmZl9akMpgvmio1XwPFnPdka6wjdmVJQxHFEy98QbHWFHyXCffhl79aeI1cB+aPlH8CP6rGuUzgpI4T7uzswwv2HVqxw85rdyZIlK6kAAGln51LddmHA7Vgj2ilZqmd53XQYNVes9uXYqWgVUjH8Xv2VxBRe2Exv0J2taisYYxcOEcSnRldTf1ubWACcgYn5O6GWi3C7SBNqTyPm+uyGao8WoGDE18wgwsfWeX6jaO1KdzT1C+EvMZVUA1VysVPdh9SIyZutX68EnR20VjJ32iqqztqcsRhmYYl/iQGjJvWPkdz18y3rr41OEF+nWW0V3wpZRCn01osoZuW9eliTRdCuLfY9A/XhyjlxruDSr/sm8kxmiuZ1K7eLSd6wIMHURzlMkFlseUaHHx39AquHvV3o7hlFH/E4R68Onzx7evjbwkYUqSeYMP+bn+XnzC1dYVQrZ2OMZ/AsfcQ1t7sG3dpW3i6LTzdFp5uC0+3hafbwtNt4em28HRbeLotPN0Wnm4LT7eFp79bGcy28HRbeLotPN0Wnm4LT7eFp9vC023h6bbwdFt4ui08/d21xK2FpyGLhhTmoMyFVK3UQZ+rdboqRz2Po4zSuPZPo+trCra/paQMav6pQkM5YOdxdCWMpHATZ4DFddoSZexcIuW/vPDRs94J7Rx7ZcUvV2uJb5R35WccJAmW7s6x7UyzozfHJ1Ec1Qn+hU5pjhEzKqcVM5+SEejIOUqCa5ZyoaYVJxBFfk3KtKK3326a1iWnaYUfrTwkoRYtCLv5Wx4N+ktIbZxwfe1TwDhfyI/3XbfOCIStRxPnzpfL5f8Aat3LkA==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Contact list","permalink":"/docs/API-docs/v1.1/contactlist"},"next":{"title":"Draft Document","permalink":"/docs/API-docs/v1.1/draftdocument"}}');var s=t(74848),r=t(28453),o=t(33617),a=t.n(o),l=t(17543),d=t.n(l),c=t(86013),p=t.n(c),h=t(63723),u=t.n(h),m=(t(18766),t(79329),t(9303));const g={id:"selfsign",title:"Self Sign",description:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.",sidebar_label:"Self Sign",hide_title:!0,hide_table_of_contents:!0,api:"eJztO11vG0lyf6UyCOC1MiRFWvY6gmOc1t7sKnFsYSXDuEg6bXOmyGlrpnu2u0ckVyCwD/cP7umA5OV+mn9JUNU9wxmKkuz14tZJ6AeZ05/11dVV1VXXkRNTG+2fRi91UhWonI3O4yhFmxhZOqlVtB+dZAgW84mVUwUHR4cwRYVGOLQg4O0Pr8BlwgEqMc7RwsQgWrfIEWi8VFPQExCQhvX78EddQSIUiNxqkCrJqxRB82Yih9JgL8WJVJjCTKZTdDaGWSaTDFzm10TD8zGVDrQBnJdCpVCVWoGwoBBTTPtwkkkLpdFXMmVAa2hwXqKRqBJarJC5MOA0r/3hl/86JhT/qCtD+H745b9hkusZSMX9b0pUPECUZf9MnakTWe7D2zLXIoWFrgwcvfzXBlFaldpOd3Ze4riawtvDnZ3zrzLnSrs/GNAaukRFYOVibPuJLgYpDSzTyUNCGQ3Sqh5XYWW+AJG2iOIyVJDocgGJ1iaVijgSQymmCKoqxmhsDESZQhskHAQYFOmi53Svsgj/dvzmNUy0KYTrw1Fe2bjZLpUGE5cv/PKEe43VAwtjYfHJHlhnpJrGUIhLIqt08FMlk0tC26JKa6IeHB0yrXZ2jquy1MZhCu88Cvs7O9TzDRKNhUEen+ii0ApKYUSBDo310kXdBn+qpGG5cBmIPK9psX+merCz4xYl7u/swKFKZcLiSQtSK4mgH9v3Q4lINPS4xEROZBjaIh1oFaSOaDITnp9lLhIPpkFbYuLkFXYXnsewoIVfotI1BJk28metnMiZHVdonExE3mYbAcji7YRxRM5SS+Xq1rBDc3KIe8yUIFcEWkrEKqTiHotwJfIKbYBqFkNGUP2ApUFLp7xelwipUshQTrNb9xPp+8q6zsJQWQKzDUXYq+YSkxeZbBORWwQ56dCyEJfY2q3RAH34ZgEpTkSVuxgkSZwzFfbhtXZ08nKZkKIhyeUzLVxlsMdcDuIQAFGiYB4frXRAKicTNHQ4qZOXCHNq6EjOvNIg9PjkuEwo0GqN0YnOtbkpQtzcpSMkWjnWfAdXQuYMvEfWNupvnIvkMoZxXmEMBlN/cBeY53oWe3nnIaTgPM2ZPqSWSQq1IviVDttLCzZA1SjC+jxRZ6NsaRNp21QNp3aiaWciQX3EAAsh85gJF8N7PQYnXY4xHdhSqEUMqXAYg8O5G+t5DEmGyeVYzwO9Jlo5K3/ecOrqnk+n2iiGvRiexPA0huFuDMNRDMO9GIZPYhg+jWG0G8NoFMNoL4bRE0/T0dNAT9EQsQ3AcOQp6b4sCpL+fCUtn1BSfLbRpbOOLh32YWenORXU9uOPP56p6zMFcBbRITmL9uEsaoacRbHvI91HfcPwPaePR6Ovw+eCPp+MnobPGQ8d7oXPjD5HwzO1DBueqRFD4kRR3gEFdf+mEISvICjUxptSW62XqJEUSlx3ED868FDHso3LI8JFKumkyO3t6NQjviCMViDdQGqPkGKRvB0j7v6C0GnDQz2s7nwXq8dWV32oGYrRDewf98MNcTvyftsvBvcWOJ+H+hNCndTPCamf2/FvNNQXRIR1mD6PEl/3+SJn7Xs7HcKAL4gKXYg+jwZPiQZ08dxOAOr9grBvgUMd4Rb3fbt7veHj3mh3tNehAPk4fkBR9NK0t1gsfgvqkV0TtiezprY0vYUmHMLE6GKDG8FW/mpUsHv4d216/wcZ3OPaFsW09kEbq6Tx3NrWstOpWDywfql6amOA0fiV+bVogcldBAd7sUmmZRKApzG12TUmR61PNOgxJQdpOmhRkhrTtFcUvbVG+uwx4VuNRdFP0/7ayBvc8Y0FpGkMN5s3tqcpFEVxS7Nv7zQPiuImFv2iCLAxvmfqn+mYBMvs9pMSBvy9DsvqTHQ3vvMgUQxAq5z3Zsds80lau24yqUJHECtYG2BwWuXC4Jw8TCu18qN/+1NWH7KV/c4eKTtz7O97UsBXb4KN/jAcAEKhuwC13D/vBma0yAEklXW6AINTnEMpnEOjeLErkctUsFPW4waci6IkQ3/wp7Oz9J/+ccChBPLWHRAnIJVTSRGdwZ9OD3r/eb5hRFWWaBJhEXKknWwM6JI+nGaYl6ug0mw2688e2STTOvcRpffW4MT/vdDj9xcMbtkXtny4CVMvGi3XnURn3XO36DoUExbqmRucd5YxdmGGu3zfBq/mjgs3jPiC7pw1kKjTx0Go+/QsKgSbJCTKuPqtXYbmLDpv5nh3HdN75p5/xGHNZIq5GGN+s+ujD1rTnIuFrsL5rsNTXVSDRLfoRh2FVE0EgtHZjVudYr7W6fuWG863J0j7dNaXTn08aw5ALm0dg+mSsz07BKk4dEgBYRLbMUI9AcaNlH72KWgA+7hj4DVR4N09W9A44IFNgLCJCdy9Q4cxbcLQGoVUsqiKJtI5aVatSVYE66NNL5pZWTT1Dm3u3thBzO/ZgcKKt29wpoYcyZCFmN5hmHL3F6QlAjxr8h3FkS7pvURqdZhG+1H9lhLFvCha941OF9H+dRRiXvQzRJRo0uC9pXeY68gmGRaCftXA0MvNROYYxZF/GbFRHLGDRM84RKloP9Lj95i4KKaru6TTjZbW4Hn71/UoH8+P4mAuR/uRD/RHcRQusKYJUCWajNIynUTLesO7lmpaVktZ/tE8LNA6FDL/lcu8pqnLtZerX7XSy9YKjFuBJ/qFpj6HL8XCttb18h2tP5jRHDq/SZgFqVhYChNW1quiRORJlZPpjfNSmkXjB7D93ZCkBW+zUwPv8PGyZnoLolt4bfSnMyhBTQTgmMunzn2vcYz4h9BAlgjzVxSfDMV7jTBG5m2ZafXJ84ejR8PR8NFwRCuEYGlrDWGMWERxJB0W9n46+t6bEHT5f0ChX0zrW6i3eqeIgWOM/ftEsR7PaIsp3i9zJ7e9X7VC6jbTVZ5SsBqF6fMz0q9+oeyKMW3C2PbvEdplHM3vR2YOie7Vj2PwVY4T501gSLRRaB62PesvBrnR3t4yjhb3o7f4X4ne18S82f3YveNXxdWL6+8B66OnyzjK7of1++bd83cEdu/JcnWJRolB4dBhUdIiF2OdLi5qvbVsD6zNiPq68EPDjbCkHfMUDVkcN/XVStXQSHqvv1jX82OtcxRqg6LpPIYJ0nWWzVYyikNoaZYh+T4ra5ZXt40ZHkxob7LQAxuuefPSkqVnKjyL+nA4WdHSG8Lr73H1WH6PUxoe8H4XtmI1/mAQvolCD9q5BfTcuwqp1SDwYKhZYGEm85zgpuu7D80/Nu0aShIA9XVZb3z/VfHCRxF4wzCp+7INwUTswwuhmpfP7gsjXF83QsDSsVzC9TVxFc0FXbrLZbxqoL06DXyv+haDCcqrzqymCVcTm7bWVG/JXJAl4xtClLoNgE/BuahMWIcMvuWy3xHINcAhY7+KaYBpI2eUhnMT68ZeYU5/NPVvEDtIAC3y/4buz8rn38sNoDwblM+flc/fUR5Lif7sefJMpEr9yZ9hnvfhmXVGq+nzNRI8G4T2zaw0eCVxxgeXubpaZZ22zUL9ABMlarWYJy0kpkqkyDl8ZnSCdbIQ8U3h3IF1WFpy1aXzGWGchsBmt5gaRM7cIlhE5Thvhz2wesNnAjKDk395sEbTB885L4xStp4NxPMw+tB785m4QhBqAYw4BzW08VGJSWVYTSa5MHIS3L0Yyhwp1EfeoEh8lMFTtIbjJBPq0sbPxub5CYqiyUz78Oe/0Qg+BpyOd6Ir8xE6nYMPPc9b7/t6necXAQHTih8hHNGpVk8chVzlykhlnal8PADSytTpQXXeHfPD2n7IBupBKq1PmMiwvX4MqKyfLmAirEMTQ6WkcmhMVZLk3Ezl64gyb7Ak59rnsRGP7tcF3aQUSmv0KXitrMP6HqgXxpB1GPy8JiGqzgBcR33jxRvOyf0A0iXJaUshFFSisVqRLGkzFSqIqjf8tSWvKRO5H+rPq6QnHIKH7t8uMLVJ8+HPf2vBdavrdxMwv4NIU4qR3wMhB4Ao0mM5DGSwzBfgdBciWg/NH9ZtreheC8gbSasASbiXKWFPK+vduNHuLv3XRaPOgAVvgaVgq4TYNqnyfPEPUfzx0Zm7fUjfvNkuu8spzN7L0c/z5Gp0RCy6RabvXCDYsJXJKQeUKNdr0nLXaStVLhVe1GS7GO3uXgyJtss42ttEvmNdoMs44YmIOCNN3agyZxYgpkIqIIvK/IbURGO0udvE/TTI7iLCXocIj28S4VBxrJyzpE/0Jaq/L6bt7Z3fnkCdFywrXs1E0g/i/qiDbLvdI2kxqYx0i2j/9Dqa90Qpe75///R8eR5HRFhNMc1SW4ZYuCzajwatEKdFc0VxSVqBhbaRQytUSqHsG/6UKOXgatgfRst4fc5G/+uO8Vj1PnWKdWIq1fS+eecr6hwTBz2TOjRaRZlK+e9IYabAgvaoOJIkORmKlPy2ZRyRYPywCgx/W7O3DtluisK2lOJaXLUOq3YipesqfEPsc3Poc/i4HXT0YUWOFDaBwk2xvwbxOprXBPNa8blWeO50JeRNJKwOhA05gjTa2+NQy9dDjkk8esru/t6T5XnH842irnfLgft1H+3zXI6ux7E1o/8PmdFdK9o/sq5ZlbWANVZcx5Rat6Rut2pIC0w0q4xwjptqE1LmrHJuBNowT3TRZBzv7LTgb2bt7DSqwPOAXtfeVAZKPUMzqXwK8yTHuSRjnKZhwX2roA6KIkdr8wWQFT6l0h+fsyDyxsZNRCnGMpd0W9EwHaRhdeHZPrxbhYUeGJ/CcYU5XXIkKLoQbEM39vNMm0sqwKE6FhhTxQEZl6gyoRJvx3r9G5MkUJUM+QilkZYKKQxBLT1sWjlDIlAIJaYsnHGb2ZBiTmfVgtFjevq0Oq+8iDkhc238qw0jRAJnmYjfzkvq4mgheQAGM+LqVfBmLCV2pwhetYZSnDEFF0qCRSbI4bBK5ZqqZiiwUOU5lJpsBTp8etKBkaY7I5QlEy88FAUeNAQLjgbakDL+1iJx+JVUlz5DvAenjVy9w7GVDrvZI+uS+bA75zvpvq/GVEeirXTaLFazp9Jl1ZgvyfYizYdf6btQOgatK3C1RqoTuyG8qhM7oESXwTE6khA7ODg6ZPPqIXz45S/wCoVRkOmZl9akMpgvmio1XwPFnPdka6wjdmVJQxHFEy98QbHWFHyXCffhl79aeI1cB+aPlH8CP6rGuUzgpI4T7uzswwv2HVqxw85rdyZIlK6kAAGln51LddmHA7Vgj2ilZqmd53XQYNVes9uXYqWgVUjH8Xv2VxBRe2Exv0J2taisYYxcOEcSnRldTf1ubWACcgYn5O6GWi3C7SBNqTyPm+uyGao8WoGDE18wgwsfWeX6jaO1KdzT1C+EvMZVUA1VysVPdh9SIyZutX68EnR20VjJ32iqqztqcsRhmYYl/iQGjJvWPkdz18y3rr41OEF+nWW0V3wpZRCn01osoZuW9eliTRdCuLfY9A/XhyjlxruDSr/sm8kxmiuZ1K7eLSd6wIMHURzlMkFlseUaHHx39AquHvV3o7hlFH/E4R68Onzx7evjbwkYUqSeYMP+bn+XnzC1dYVQrZ2OMZ/AsfcQ1t7sG3dpW3i6LTzdFp5uC0+3hafbwtNt4em28HRbeLotPN0Wnm4LT7eFp79bGcy28HRbeLotPN0Wnm4LT7eFp9vC023h6bbwdFt4ui08/d21xK2FpyGLhhTmoMyFVK3UQZ+rdboqRz2Po4zSuPZPo+trCra/paQMav6pQkM5YOdxdCWMpHATZ4DFddoSZexcIuW/vPDRs94J7Rx7ZcUvV2uJb5R35WccJAmW7s6x7UyzozfHJ1Ec1Qn+hU5pjhEzKqcVM5+SEejIOUqCa5ZyoaYVJxBFfk3KtKK3326a1iWnaYUfrTwkoRYtCLv5Wx4N+ktIbZxwfe1TwDhfyI/3XbfOCIStRxPnzpfL5f8Aat3LkA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},x=void 0,f={},y=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"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:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},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"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"selfsigndocument_body_signer"},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"{{sender_name}} has requested you to sign {{document_title}}"},email_body:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"

Hi {{receiver_name}},

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

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

Sign here

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

Thanks,
Team OpenSign\u2122

"},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"}},title:"selfsigndocument_body"}}},required:!0}}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"hji2zxcv2P"},url:{type:"string",format:"string",example:"https://url-to-sign-document.com"}},title:"inline_response_200_1"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/34593b53.8d3db6df.js b/assets/js/34593b53.8d3db6df.js new file mode 100644 index 000000000..44951e3a4 --- /dev/null +++ b/assets/js/34593b53.8d3db6df.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9099],{85203:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>y,contentTitle:()=>g,default:()=>b,frontMatter:()=>x,metadata:()=>i,toc:()=>j});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":"eJztPGtzHDdyfwWZSpUsZrgvkpLMKKqjJcVWzpFYFhXXhdTR2JneHYgzwBjAcLlmseo+3D/Ip3y9n+ZfkuoGMI99kJRE+6jL+oPMxeDR6Bca3Y2+jCyfmmj/OHqhkqoAaU30Po5SMIkWpRVKRvvRUQbsuQZugYVe7ODwFeN5rmaGVQa0YVaxKUjQ2EvCjKVhPjaes1Krc5EKOWUpt5zNhM3YmBt4tMtAJiqFlE1EDr0TeSKPRLnP3pW54imbq0qzwxf/Xs+Gy2Db8dbWCxhXU/bu1dbW+68ya0uz3+/zsuypEqQRU5nzseklquin2LFMJw9jNstAA87KEi4ZcCPyOeNpymYinYI1MbMZSJaocs4SpXQqJLdgYlbyKTBZFWPQJmZcpqxQGpiQjDMNPJ1vW7VdGWD/8fbNazZRuuC2xw7zysT1cqnQkNh87qa3GdS7emACNozVQk5jVvAzxJaw7OdKJGe4bQMyxf/jwIPDV4Srra23VVkqbSFlP7ot7G9t4ZdvIFczxjVQ/0QVhZKs5JoXYIlcGbf0WcPPldCQOqLwPA+42D+R22xry85L2N/aYq9kKhJEBk2IrUxNfN+e64pIwq5vS0jERPiuLdQxJdksE0lGOJlxR88y54kDU4MpIbHiHLoTX8RsjhO/AKkCBJnS4hclLc+JHOegrUh43iYbAohdjeXaIjpLJaQNrX4F9idPHqQeEcXzFYKWIrIKIemLAXbO8wqMh2oWswyh+gFKDYZY3c+LiJQpy0BMs7Xr8fRDZWxnYlYZBLMNhV8rUInQC4S2Cc8NMDHp4LLgZ9BajSmSYZ732DdzlsKEV7mNmUCOs7qCHnutLONlmYuEj3NAzmUoPNxWGraJyp4dPCCSF0TjQ5JoMIyzVEwmoFE48SNN4ccE6JDPGhVAkmMzLpmSC4ROVK70MgtRcxePLFHSgrQ9dnDORU7Au80aJmSSVymwcc6Ts5iN8wpipiF1gjsHVFuxV0LYhXHjcU74YQZy5EIlEX6p/PLCMOOhSnvsKBOmkSf8GFBNiwjTxqqX2onClREFQcQYFFzkMSEuZh/UmFlhc4hRYEsu5zHqS4iZhQs7VhcxSzJIzugvzVOh2LiyVkm3sVSrMlUz6XE5UdIa8csKiQxfPh6jo5jtxuxRzJ7EbDiI2XAUs+FuzIaPYjZ8ErPRIGajUcxGuzEbPXJgjZ54XPMawW0AhiOHZfvlYBf17vfCkGSjwjS1Dp51dPCwx7a2amnCtp9++ulEXp5Ixk4iFK6TaJ+dRHWXkyh231Bn4reh/32BP3ZGj/3POf58NHrif86o63DX/8zw52h4Iq/8gidyRJBYXpTXQIGf7xQC/8szEbbRotgW9Bk2oiKKwwekVQce/HDV3ssO7kVIYQXPzfrthB73aEcNSEub2sVNEbuu3xF9vkfbacODX0hNuk+kVlufgsATFKOl3e/1/MmyfvNu2Xuz9xY4n7f1R7h1VE1HqJrW77/WXvcICYswfR4mHvfIACDNvB4PvsM9wkIXos/DwRPEAR5K6xGAX+/R7lvg4Ad/wrtvg93t4d72aDDa7WAA70auQ1Fsp+n2fD6/C+yhzeOXR5MnWKjOssNb6USrYsX1g24HTS9vE9HfwWT/TzTUx8GGhRTvfXSxCBZLfeNrW9lWpXz+wLipwtDaOMP+jWk2b4FJnxAOuv0mmRKJBx77BJNsjBe8HuJgmzDZT9N+C5PYmKbbRbG90Ig/twnxrcai6KVpb6HnEnVcY8HSNGbLzSvb05QVRbGm2bV3mvtFsbyLXlF42Mj4+hqFxNts6+XEd/i9RKWRiO7C14oReg6UzGltus6tlqOFwyYT0n/wTMUWOmiYVjnXcIH3UiOUdL3vXsaCiDWWPd1j6QpIXgKHCvbVG2+9P/Tsj1voToAtN49b2hlOcsCSylhVMA1TuGAltxa0pMnOeS5STle5bWqAC16UeAXo//nkJP2Xf+6TAwLv+JYhJVgqpgL9QP0/Hx9s//f7FT2qsgSdcAMsB1zJxAxs0mPHGeRl44qazWa92Y5JMqVy54f6YDRM3L+navzhlMAte9yUD1ft1LFG68KPrLN43zdgOxjjhoWRK678xGMkQ8MBnbb+vnPNcet73KMTZwEk/Oi8J/j5+CQqOBkkyMrQ/K1sBvokel+PcZd8SG8Y+/4WwpqJFHI+hnz5060FrW7O+VxVXr6DU6u7Vc/RLbzhh0LI2m9B2xnErY/8YuGj+3a1Qr4dQtrSGY6cIJ6BAiwXJnhuuuhsj/auLXI4SgDyYY6BhQHoHg7a43OloAbsdmLgNJGn3Q1LYD9GHWu3YljthhU6hGkjBucohBRFVdT+0Uk9a0BZ4W2PNr5wJHrdwwpt6i6twC9uWAGdkesXOJFD8mME/8c1lqnvcY90xQJI14vxp2iRzjl9RwfszQIYttUWwBXHMnZ1B3ItfGa99PXYGzze0CfrBqGXLUmgtOiR+1zRrEG+9QlFPqu2H24957V73SPuWwHWb8yBvt9dnz6fxKTt3X9BjNoB+9bM6pySBZ9ec3Onz/eIPT08S06Ira1DDROR562QIgtNIbKDIR3IofBhLx9MxKOOHOFCWoXXghC2HcOE4qWWwigZbwKO7pxxJG3HRFmCEWelWcaNs7/J4EdSYcDWZlAsuOIDaI07XsgAN1JleHf3xtHXgzadho/2OnTaG3ToNFhHp2uujUhBUyppal8bNJ9ack0kDu3LR8ui2IZJkaQvJcZWwu3BCYOq8pTl4oyiKqkwZc7nSNUgpR7KxXDd80wp0/TwEbOv/Ib3u5E4pTEY97BXByZu4/BaIEaLFsPHOy1S7D150pWYjsDc5v7erLdMhcFuf7jXdx6t1Q6txg2zXglfYwkwdht6kZ/oVvSing3BNm6nT3U73Q2779zlrXv4eNQ5LHYGn3pY3Pnlui01N1yr7+LyfGe32La43fL++rvdIz+f+3Z/C4t6+HinzYWPh3fgQl1jOH8uJy7Zx3fGe+yujONVDHgL6/hak/izGbQN7G/OpHt3Y0kPBx0L7euOgfb1qM2Ue3u3Ysr2ogucdRKJ//rmzQ+zwR+/naqDg4OD12/fZS/fTQ8ODgr83ev1Vl6iVlGblkHL1WcE+nOZzvg1q/R6PUQhplbu0/B+Kaf/6sbH68f0TmQUR6rEnE2h5Ks02o/I6IZgg0cx3SPA2G9UOo/2LyOfI4R/+gwcHNr/YDBR9DIySQYFx7/C/QNTSzG1M4opzQW0ieKIgsaYZ4okjfYjNf4ACa5WagTHCjA4B43bvwy9XG5kFHuLK9qP3BajOPJu/bqpziot00l0FRa8bqq6pZnK0B/1hQTnwfTDT5zmNQ69Wkit/aSZXrRmoL0VcKSeK/xm4QWfm9a8zusXLWb04hgU9sSPYimfG1QalXEHXMLzpMrRLoSLUuh5HRsl47DFHzW89Uo1vMO9q4boDUhcaz6P4khYKNrta5hAq4+nXAIKMUMJKh879oOCMcAffAMGbojwvPhoKD4oYGMgopeZkh89fjjaGY6GO8MRzuAvt5+OR/d1GYIuYxxgDh2kwejZbpJBY0YJWb2beDT0p23zKdzMjEfrkoRbuYkmo5sOL0vguke5up+cBt7l7/p07d3AzVdxdHHzZi5YorZDBjL7KoeJdRFDligtQT9spyHcm82Ndnev4mh+8/bmX+T2HiPxZjfv7kdK3W7S2v8esO48uYqj7GZYv6uTy/+OwO4+umpO1wXj4XSs0vlp0FtXN3UMBwX2m6g8BY0GybK+alQNahh8FHG6qOfHSuXA5QpF08kq9s9X0PhF/693iMwywDtEYxPT7I3B7b3FDlrMVIaF5Adh0FbVFZxEPfZq0jLfyZxeTGwOfSnJWCr2gNY7NRWp8Qd9/xtx9KD9gAPdrU3+UQCBOjMLRZnTC4gZ+mzHFMxLe6z+jyy/GpMIQDguw8I3HxXPXdIFLegHdZ8PMG879thzLusU8m6qNru8rNmAuOPqil1eIlVBn+Khe3UVNw24VqeBzlXXoiEBcd4ZVTdBM7Buaw11Js4pmjiuwaf0tQEQUynk9LTSfh60BK+ueh2GXACcPNceB5DWfCamcsWua3uFKH1r7C8h23MATvL/Bu9Py2ffiRWgPO2Xz56Wz37Ex0IlONlz6JkImTrJn0Ge99hTY7WS02cLKHja9+2rSanhXMCMBJeo2syyiNt6op6H6U+oqBviCcMSXSWC55RtpFUCIUCCdJN4gzYWSoMRKWFppHvPQfY4n2qgUAzBwitLj6PoahYWfMpZpmHybw8WcPrg2VsEHd/FPe3zZ773K+cTyPg5MC7njDZODgylnRNsUmlSk0nOtZj4e2DMyhwwMwqviTxxATWH0QDHUcblmYmfjvWzI+AFe1OCRAh+/evfsEfQ6a/kG52CvoVSfzVxoTvFHqAeexC7LC1id6GN9araaULPIQ6uNaLjs/Qx4veyVv2mGhvsJcN8jWq1WkyngAEt34MG+zcvwJPMHRoEFZ8EF36JzKMqE8BDBgu3MYpuCccfQk67LpcWdiiW1t57b5VWl/hI5s3R4S1wSf6gbScozhnidunmYG+ODvGdXU3uHntnakwE1PJOF4bXcHYueHiLU1v2c5fZAi6o4fViOwDY8y/cttkyQKkwKyGK3aGOGq5+lbo0cfMQE0mkKosBReGfF5GUdfBIUNSIPFLVbbjyBkxyNq0okdii+IZTk3IJm3dyQhqrK5fVw9JKh6eBni2cmjCmwVPACnZqzR8zkMYN52zCjQUds0oKxLyu0EVYTwkXJWgBMoGVKNDgUIeq4+Yjqvvo7N0P3/vnt2EPQSjHKIFuYkhZVRLXkCTUjyED5Ra3vtIe9Or7ZgDRdqMni97PWYI2SqKKU3rKpdeg7j6KzswxZDx3Xb2qwHgYwoMS3gUmWNq//vVvLbjWeiSWAXMr8DTFTNcbICS/sGN4TObSUKIGVF2IcD7Qf1i8AiB0JDSnhUprQTK35/FDyo01tV70Afo6OcBUSYbHVq1vTRx0rPFOBUMuYPITU4S/xP3ChTC29ZwvJN0v64cfAPGYtGCgSyhKNfK8nLcFvElaUAvT0fVAdJ+C1pegJVnglVWnGgohb3dOtV3uVtWKoLKq4FYkLExlet0Hvi6uG+S6YF8F0JAbz4XSD9eIKk53qmQCp0KewjnoW1zvX9dJguQQHIOdAcg2bAFJ7jhrHmHO8N18Byet04meGrehRM9g6TIzVnmuukCFB9Mh2z3wgztK6CF/McYMIZdjgqJGiiPc0pZcYV+KL80nW2w8aV+Qq2k4GPwje9J2Bl+OJ2138AV50p4gsD4AebMCWmffrNQdIcp4/YAPilz2FKe9vidG9chJ58LgqxDciMPoyv3XOP+C3r/BIeg8hk0Y0V9nwmYIDaPBAP/XJeeLTgIhGrdVgsbipMrz+T9F8e1jmNfTwDWvdlJep9WzD2L0y0VyPjqMfHysa01/5Fn0SUEuHLMY4lpj01+7FS8Qlc6x/g3uZbu2p2jaFo2FzIWE00DA01Qlp2H32K8AY7qn3K1gqMlNt+wurW9YPnKMubuKi96qAmxG5ifOO0PvTe3esHrO+JQLyVDG9R0yFWh9k/h9HGTXoWB3MDgd1kjYW0bCK0nPjajY05E6A/n77rS9vHXLI6gXRd7owEi4TvQ96my23e42aSCptLDzaP/4MrrY5qXYdt/3j99fvUcWtJnCNIhSGYKY2yzaj/pLWREG9DlFtY8vndzUomC4TDGXa+l84KXonw97w+gqXhyz8jy5pj9U2x87xFg+FXJ607j3DY7eIh0dqTqYavRUKf4IqKg8Idq94kgg/2TA8XKEqEf2+KHJJXkZiByyPFYlbjTEXEzFCJkYneSKxXN9RbrE6myJ4V4rT+E4pBxQFkGdRLAqL6Deeoj014H+Vuy+Fbo/bpi9jpIH035INvFod5eMx8dDsrJ2npABs/voitizCYtFUTf0RRn+iwGcz4tHdMMRGx/7P5CPfcHF7pmn8RO7TMiOw9M3dR2AgQtrh1vH67Xo9FrrgFrjf/JLLvhZakBWuTf2Ol6FFXIXrOKu1GGuIErdzoCkbndAUvdk0DHI/Q6bGRqzmmzn2nQm+7htHqMN/B51oJATRQrUa7VAFzrgSAEvXaMgT1RRl7ja2mqRsh61tVUrRseOmEb5ptKsVDPQk8rVzJrkcCHQU4PDoKBvTfAbeJGDMTk+HrAwpSqO9BQeXeLe6Zrwko9FLvAEdw98nGA0RoDpsR+b8PkD7SoDnEOOB3/t68IqkMFomyl9NsEwfMw4G2P5O/R2gsy4TJxj1Z1G5CBETw86rUstDFb10wi1cLApaTVKQ8Eln5Kcxm2+ZynkqLYM02qMcQej8spJm+UiV9qlvdGGKMGWkPjyosRPdBdEl7SGDHn33LvXTezCG+6g8XUhxxhJKhEWkQB5GSuZKyzhiBGpKs9ZqayLEuGVsw0jDreaS4P2rs+08zSoEeY932D846d3BpDC3wt55sqObbPjmq9+hLERFrpFCRbl72F3zLfCfleNsaihMsIqPW9GT4XNqjGZDO1J6h9upm9DFdCWQdDMkarErLg8q8T0sX5C/y1Y5BDTPzh8RSbnQ/brX/6HfQ9cS5apmePWpNKQz5uCo1SQkyjv0FZbjBRbQWWNGE8c8/kzJmDwx4zbX//yv4a9hhn6mJ1IuQTdw2qci4QdhXyKra39UAm1ybHoPKJ2T9sw4MVZ6UbnQp712IGck4u+OXGwncZ1tkGnXKt4KseMTCV9JrVbs9dARE5hA/k5kO8f6+iNgUEqXBhRq2rqVmsD4zfXfeWHeztIU1YuvPRDB3QDjvOxUvyOO2cr1jld8Tiw8wqvm3wAMqVKnGafpZpPbDN/vPD8j867pabwcjCgI/bT1CRxkuh3XLe6fOcFY7arbzVMgNJbu/VseSk8Ox0HtmTdah8fz9bO2UJHeOsaj1b1yhAN1iE1byZvQZ+LJNy910h0nzr3ozjKRQLe8+PPr4NvD79n5zu9QRS3rgi3EO7+96+ev3z99iUCg4rUIWzYG/QG5KBWxhZctlZaqBi8eLa1csk3BYY3BYY3BYY3BYY3BYa/mBK4mwLDmwLDmwLDmwLDmwLDmwLDvx0SNgWGNwWGNwWGNwWGNwWGNwWGNwWGNwWGNwWGNwWGNwWGNwWG74+u2BQYvi91WzcFhn8PDtwUGN4UGN4UGN4UGN4UGN4UGN4UGN4UGN4UGN4UGN4UGN4UGN4UGN4UGF5TYLj19KJf5lzI1mNT98DueLHs8Ps4yvAF3v5xdHmJy7zDZzTY/HNFDz2O38fROdcC03Po8V4c3prhY48zwBdLz1220fYRrh872aYE24U3i/hYzo04IIa+tm/7keDhm7dHURyFem2FSul1NJ/h4xA+c+9jWi9IqO0yyrmcVvT6JHJzXrlqIln3bd0Zva3zf7SesHA5b0HYfXTntoH/4qZWDri8dO/26IWX6+8+rR3hERt6I/3eX11d/R8Kzfr5","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),r=t(28453),o=t(33617),l=t.n(o),a=t(17543),d=t.n(a),c=t(86013),h=t.n(c),p=t(63723),u=t.n(p),m=(t(18766),t(79329),t(9303));const x={id:"createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file.",sidebar_label:"Create Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztPGtzHDdyfwWZSpUsZrgvkpLMKKqjJcVWzpFYFhXXhdTR2JneHYgzwBjAcLlmseo+3D/Ip3y9n+ZfkuoGMI99kJRE+6jL+oPMxeDR6Bca3Y2+jCyfmmj/OHqhkqoAaU30Po5SMIkWpRVKRvvRUQbsuQZugYVe7ODwFeN5rmaGVQa0YVaxKUjQ2EvCjKVhPjaes1Krc5EKOWUpt5zNhM3YmBt4tMtAJiqFlE1EDr0TeSKPRLnP3pW54imbq0qzwxf/Xs+Gy2Db8dbWCxhXU/bu1dbW+68ya0uz3+/zsuypEqQRU5nzseklquin2LFMJw9jNstAA87KEi4ZcCPyOeNpymYinYI1MbMZSJaocs4SpXQqJLdgYlbyKTBZFWPQJmZcpqxQGpiQjDMNPJ1vW7VdGWD/8fbNazZRuuC2xw7zysT1cqnQkNh87qa3GdS7emACNozVQk5jVvAzxJaw7OdKJGe4bQMyxf/jwIPDV4Srra23VVkqbSFlP7ot7G9t4ZdvIFczxjVQ/0QVhZKs5JoXYIlcGbf0WcPPldCQOqLwPA+42D+R22xry85L2N/aYq9kKhJEBk2IrUxNfN+e64pIwq5vS0jERPiuLdQxJdksE0lGOJlxR88y54kDU4MpIbHiHLoTX8RsjhO/AKkCBJnS4hclLc+JHOegrUh43iYbAohdjeXaIjpLJaQNrX4F9idPHqQeEcXzFYKWIrIKIemLAXbO8wqMh2oWswyh+gFKDYZY3c+LiJQpy0BMs7Xr8fRDZWxnYlYZBLMNhV8rUInQC4S2Cc8NMDHp4LLgZ9BajSmSYZ732DdzlsKEV7mNmUCOs7qCHnutLONlmYuEj3NAzmUoPNxWGraJyp4dPCCSF0TjQ5JoMIyzVEwmoFE48SNN4ccE6JDPGhVAkmMzLpmSC4ROVK70MgtRcxePLFHSgrQ9dnDORU7Au80aJmSSVymwcc6Ts5iN8wpipiF1gjsHVFuxV0LYhXHjcU74YQZy5EIlEX6p/PLCMOOhSnvsKBOmkSf8GFBNiwjTxqqX2onClREFQcQYFFzkMSEuZh/UmFlhc4hRYEsu5zHqS4iZhQs7VhcxSzJIzugvzVOh2LiyVkm3sVSrMlUz6XE5UdIa8csKiQxfPh6jo5jtxuxRzJ7EbDiI2XAUs+FuzIaPYjZ8ErPRIGajUcxGuzEbPXJgjZ54XPMawW0AhiOHZfvlYBf17vfCkGSjwjS1Dp51dPCwx7a2amnCtp9++ulEXp5Ixk4iFK6TaJ+dRHWXkyh231Bn4reh/32BP3ZGj/3POf58NHrif86o63DX/8zw52h4Iq/8gidyRJBYXpTXQIGf7xQC/8szEbbRotgW9Bk2oiKKwwekVQce/HDV3ssO7kVIYQXPzfrthB73aEcNSEub2sVNEbuu3xF9vkfbacODX0hNuk+kVlufgsATFKOl3e/1/MmyfvNu2Xuz9xY4n7f1R7h1VE1HqJrW77/WXvcICYswfR4mHvfIACDNvB4PvsM9wkIXos/DwRPEAR5K6xGAX+/R7lvg4Ad/wrtvg93t4d72aDDa7WAA70auQ1Fsp+n2fD6/C+yhzeOXR5MnWKjOssNb6USrYsX1g24HTS9vE9HfwWT/TzTUx8GGhRTvfXSxCBZLfeNrW9lWpXz+wLipwtDaOMP+jWk2b4FJnxAOuv0mmRKJBx77BJNsjBe8HuJgmzDZT9N+C5PYmKbbRbG90Ig/twnxrcai6KVpb6HnEnVcY8HSNGbLzSvb05QVRbGm2bV3mvtFsbyLXlF42Mj4+hqFxNts6+XEd/i9RKWRiO7C14oReg6UzGltus6tlqOFwyYT0n/wTMUWOmiYVjnXcIH3UiOUdL3vXsaCiDWWPd1j6QpIXgKHCvbVG2+9P/Tsj1voToAtN49b2hlOcsCSylhVMA1TuGAltxa0pMnOeS5STle5bWqAC16UeAXo//nkJP2Xf+6TAwLv+JYhJVgqpgL9QP0/Hx9s//f7FT2qsgSdcAMsB1zJxAxs0mPHGeRl44qazWa92Y5JMqVy54f6YDRM3L+navzhlMAte9yUD1ft1LFG68KPrLN43zdgOxjjhoWRK678xGMkQ8MBnbb+vnPNcet73KMTZwEk/Oi8J/j5+CQqOBkkyMrQ/K1sBvokel+PcZd8SG8Y+/4WwpqJFHI+hnz5060FrW7O+VxVXr6DU6u7Vc/RLbzhh0LI2m9B2xnErY/8YuGj+3a1Qr4dQtrSGY6cIJ6BAiwXJnhuuuhsj/auLXI4SgDyYY6BhQHoHg7a43OloAbsdmLgNJGn3Q1LYD9GHWu3YljthhU6hGkjBucohBRFVdT+0Uk9a0BZ4W2PNr5wJHrdwwpt6i6twC9uWAGdkesXOJFD8mME/8c1lqnvcY90xQJI14vxp2iRzjl9RwfszQIYttUWwBXHMnZ1B3ItfGa99PXYGzze0CfrBqGXLUmgtOiR+1zRrEG+9QlFPqu2H24957V73SPuWwHWb8yBvt9dnz6fxKTt3X9BjNoB+9bM6pySBZ9ec3Onz/eIPT08S06Ira1DDROR562QIgtNIbKDIR3IofBhLx9MxKOOHOFCWoXXghC2HcOE4qWWwigZbwKO7pxxJG3HRFmCEWelWcaNs7/J4EdSYcDWZlAsuOIDaI07XsgAN1JleHf3xtHXgzadho/2OnTaG3ToNFhHp2uujUhBUyppal8bNJ9ack0kDu3LR8ui2IZJkaQvJcZWwu3BCYOq8pTl4oyiKqkwZc7nSNUgpR7KxXDd80wp0/TwEbOv/Ib3u5E4pTEY97BXByZu4/BaIEaLFsPHOy1S7D150pWYjsDc5v7erLdMhcFuf7jXdx6t1Q6txg2zXglfYwkwdht6kZ/oVvSing3BNm6nT3U73Q2779zlrXv4eNQ5LHYGn3pY3Pnlui01N1yr7+LyfGe32La43fL++rvdIz+f+3Z/C4t6+HinzYWPh3fgQl1jOH8uJy7Zx3fGe+yujONVDHgL6/hak/izGbQN7G/OpHt3Y0kPBx0L7euOgfb1qM2Ue3u3Ysr2ogucdRKJ//rmzQ+zwR+/naqDg4OD12/fZS/fTQ8ODgr83ev1Vl6iVlGblkHL1WcE+nOZzvg1q/R6PUQhplbu0/B+Kaf/6sbH68f0TmQUR6rEnE2h5Ks02o/I6IZgg0cx3SPA2G9UOo/2LyOfI4R/+gwcHNr/YDBR9DIySQYFx7/C/QNTSzG1M4opzQW0ieKIgsaYZ4okjfYjNf4ACa5WagTHCjA4B43bvwy9XG5kFHuLK9qP3BajOPJu/bqpziot00l0FRa8bqq6pZnK0B/1hQTnwfTDT5zmNQ69Wkit/aSZXrRmoL0VcKSeK/xm4QWfm9a8zusXLWb04hgU9sSPYimfG1QalXEHXMLzpMrRLoSLUuh5HRsl47DFHzW89Uo1vMO9q4boDUhcaz6P4khYKNrta5hAq4+nXAIKMUMJKh879oOCMcAffAMGbojwvPhoKD4oYGMgopeZkh89fjjaGY6GO8MRzuAvt5+OR/d1GYIuYxxgDh2kwejZbpJBY0YJWb2beDT0p23zKdzMjEfrkoRbuYkmo5sOL0vguke5up+cBt7l7/p07d3AzVdxdHHzZi5YorZDBjL7KoeJdRFDligtQT9spyHcm82Ndnev4mh+8/bmX+T2HiPxZjfv7kdK3W7S2v8esO48uYqj7GZYv6uTy/+OwO4+umpO1wXj4XSs0vlp0FtXN3UMBwX2m6g8BY0GybK+alQNahh8FHG6qOfHSuXA5QpF08kq9s9X0PhF/693iMwywDtEYxPT7I3B7b3FDlrMVIaF5Adh0FbVFZxEPfZq0jLfyZxeTGwOfSnJWCr2gNY7NRWp8Qd9/xtx9KD9gAPdrU3+UQCBOjMLRZnTC4gZ+mzHFMxLe6z+jyy/GpMIQDguw8I3HxXPXdIFLegHdZ8PMG879thzLusU8m6qNru8rNmAuOPqil1eIlVBn+Khe3UVNw24VqeBzlXXoiEBcd4ZVTdBM7Buaw11Js4pmjiuwaf0tQEQUynk9LTSfh60BK+ueh2GXACcPNceB5DWfCamcsWua3uFKH1r7C8h23MATvL/Bu9Py2ffiRWgPO2Xz56Wz37Ex0IlONlz6JkImTrJn0Ge99hTY7WS02cLKHja9+2rSanhXMCMBJeo2syyiNt6op6H6U+oqBviCcMSXSWC55RtpFUCIUCCdJN4gzYWSoMRKWFppHvPQfY4n2qgUAzBwitLj6PoahYWfMpZpmHybw8WcPrg2VsEHd/FPe3zZ773K+cTyPg5MC7njDZODgylnRNsUmlSk0nOtZj4e2DMyhwwMwqviTxxATWH0QDHUcblmYmfjvWzI+AFe1OCRAh+/evfsEfQ6a/kG52CvoVSfzVxoTvFHqAeexC7LC1id6GN9araaULPIQ6uNaLjs/Qx4veyVv2mGhvsJcN8jWq1WkyngAEt34MG+zcvwJPMHRoEFZ8EF36JzKMqE8BDBgu3MYpuCccfQk67LpcWdiiW1t57b5VWl/hI5s3R4S1wSf6gbScozhnidunmYG+ODvGdXU3uHntnakwE1PJOF4bXcHYueHiLU1v2c5fZAi6o4fViOwDY8y/cttkyQKkwKyGK3aGOGq5+lbo0cfMQE0mkKosBReGfF5GUdfBIUNSIPFLVbbjyBkxyNq0okdii+IZTk3IJm3dyQhqrK5fVw9JKh6eBni2cmjCmwVPACnZqzR8zkMYN52zCjQUds0oKxLyu0EVYTwkXJWgBMoGVKNDgUIeq4+Yjqvvo7N0P3/vnt2EPQSjHKIFuYkhZVRLXkCTUjyED5Ra3vtIe9Or7ZgDRdqMni97PWYI2SqKKU3rKpdeg7j6KzswxZDx3Xb2qwHgYwoMS3gUmWNq//vVvLbjWeiSWAXMr8DTFTNcbICS/sGN4TObSUKIGVF2IcD7Qf1i8AiB0JDSnhUprQTK35/FDyo01tV70Afo6OcBUSYbHVq1vTRx0rPFOBUMuYPITU4S/xP3ChTC29ZwvJN0v64cfAPGYtGCgSyhKNfK8nLcFvElaUAvT0fVAdJ+C1pegJVnglVWnGgohb3dOtV3uVtWKoLKq4FYkLExlet0Hvi6uG+S6YF8F0JAbz4XSD9eIKk53qmQCp0KewjnoW1zvX9dJguQQHIOdAcg2bAFJ7jhrHmHO8N18Byet04meGrehRM9g6TIzVnmuukCFB9Mh2z3wgztK6CF/McYMIZdjgqJGiiPc0pZcYV+KL80nW2w8aV+Qq2k4GPwje9J2Bl+OJ2138AV50p4gsD4AebMCWmffrNQdIcp4/YAPilz2FKe9vidG9chJ58LgqxDciMPoyv3XOP+C3r/BIeg8hk0Y0V9nwmYIDaPBAP/XJeeLTgIhGrdVgsbipMrz+T9F8e1jmNfTwDWvdlJep9WzD2L0y0VyPjqMfHysa01/5Fn0SUEuHLMY4lpj01+7FS8Qlc6x/g3uZbu2p2jaFo2FzIWE00DA01Qlp2H32K8AY7qn3K1gqMlNt+wurW9YPnKMubuKi96qAmxG5ifOO0PvTe3esHrO+JQLyVDG9R0yFWh9k/h9HGTXoWB3MDgd1kjYW0bCK0nPjajY05E6A/n77rS9vHXLI6gXRd7owEi4TvQ96my23e42aSCptLDzaP/4MrrY5qXYdt/3j99fvUcWtJnCNIhSGYKY2yzaj/pLWREG9DlFtY8vndzUomC4TDGXa+l84KXonw97w+gqXhyz8jy5pj9U2x87xFg+FXJ607j3DY7eIh0dqTqYavRUKf4IqKg8Idq94kgg/2TA8XKEqEf2+KHJJXkZiByyPFYlbjTEXEzFCJkYneSKxXN9RbrE6myJ4V4rT+E4pBxQFkGdRLAqL6Deeoj014H+Vuy+Fbo/bpi9jpIH035INvFod5eMx8dDsrJ2npABs/voitizCYtFUTf0RRn+iwGcz4tHdMMRGx/7P5CPfcHF7pmn8RO7TMiOw9M3dR2AgQtrh1vH67Xo9FrrgFrjf/JLLvhZakBWuTf2Ol6FFXIXrOKu1GGuIErdzoCkbndAUvdk0DHI/Q6bGRqzmmzn2nQm+7htHqMN/B51oJATRQrUa7VAFzrgSAEvXaMgT1RRl7ja2mqRsh61tVUrRseOmEb5ptKsVDPQk8rVzJrkcCHQU4PDoKBvTfAbeJGDMTk+HrAwpSqO9BQeXeLe6Zrwko9FLvAEdw98nGA0RoDpsR+b8PkD7SoDnEOOB3/t68IqkMFomyl9NsEwfMw4G2P5O/R2gsy4TJxj1Z1G5CBETw86rUstDFb10wi1cLApaTVKQ8Eln5Kcxm2+ZynkqLYM02qMcQej8spJm+UiV9qlvdGGKMGWkPjyosRPdBdEl7SGDHn33LvXTezCG+6g8XUhxxhJKhEWkQB5GSuZKyzhiBGpKs9ZqayLEuGVsw0jDreaS4P2rs+08zSoEeY932D846d3BpDC3wt55sqObbPjmq9+hLERFrpFCRbl72F3zLfCfleNsaihMsIqPW9GT4XNqjGZDO1J6h9upm9DFdCWQdDMkarErLg8q8T0sX5C/y1Y5BDTPzh8RSbnQ/brX/6HfQ9cS5apmePWpNKQz5uCo1SQkyjv0FZbjBRbQWWNGE8c8/kzJmDwx4zbX//yv4a9hhn6mJ1IuQTdw2qci4QdhXyKra39UAm1ybHoPKJ2T9sw4MVZ6UbnQp712IGck4u+OXGwncZ1tkGnXKt4KseMTCV9JrVbs9dARE5hA/k5kO8f6+iNgUEqXBhRq2rqVmsD4zfXfeWHeztIU1YuvPRDB3QDjvOxUvyOO2cr1jld8Tiw8wqvm3wAMqVKnGafpZpPbDN/vPD8j867pabwcjCgI/bT1CRxkuh3XLe6fOcFY7arbzVMgNJbu/VseSk8Ox0HtmTdah8fz9bO2UJHeOsaj1b1yhAN1iE1byZvQZ+LJNy910h0nzr3ozjKRQLe8+PPr4NvD79n5zu9QRS3rgi3EO7+96+ev3z99iUCg4rUIWzYG/QG5KBWxhZctlZaqBi8eLa1csk3BYY3BYY3BYY3BYY3BYa/mBK4mwLDmwLDmwLDmwLDmwLDmwLDvx0SNgWGNwWGNwWGNwWGNwWGNwWGNwWGNwWGNwWGNwWGNwWGNwWG74+u2BQYvi91WzcFhn8PDtwUGN4UGN4UGN4UGN4UGN4UGN4UGN4UGN4UGN4UGN4UGN4UGN4UGN4UGF5TYLj19KJf5lzI1mNT98DueLHs8Ps4yvAF3v5xdHmJy7zDZzTY/HNFDz2O38fROdcC03Po8V4c3prhY48zwBdLz1220fYRrh872aYE24U3i/hYzo04IIa+tm/7keDhm7dHURyFem2FSul1NJ/h4xA+c+9jWi9IqO0yyrmcVvT6JHJzXrlqIln3bd0Zva3zf7SesHA5b0HYfXTntoH/4qZWDri8dO/26IWX6+8+rR3hERt6I/3eX11d/R8Kzfr5",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},g=void 0,y={},j=[];function f(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"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:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document before it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date"\n "page": 1\n "x": 173\n "y": 588\n "w": 114\n "h": 21\n "options": {\n "name": "date"\n "response": "04/15/2024"\n "format": "mm/dd/yyyy"\n "color": "black"\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(h(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample 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"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createdocument_body_widgets"}}},title:"createdocument_body_signers"}},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"{{sender_name}} has requested you to sign {{document_title}}"},email_body:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"

Hi {{receiver_name}},

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

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

Sign here

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

Thanks,
Team OpenSign\u2122

"},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5},prefill:{type:"object",description:"You can provide widgets which can embed before sending to signer",properties:{widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"textbox"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:100},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},title:"createdocument_body"}}},required:!0}}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"hji2zxcv2P"},signurl:{type:"array",items:{type:"object",properties:{email:{type:"string",format:"string",example:"mail@example.com"},url:{type:"string",format:"string",example:"https://url-to-sign-document.com"}},title:"inline_response_doc_signurl"}},message:{type:"string",format:"string",example:"Document sent successfully!"}},title:"inline_response_doc"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/34593b53.9a97a9b7.js b/assets/js/34593b53.9a97a9b7.js deleted file mode 100644 index 7c5df0e21..000000000 --- a/assets/js/34593b53.9a97a9b7.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9099],{85203:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>g,contentTitle:()=>y,default:()=>b,frontMatter:()=>x,metadata:()=>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":"eJztPNlyHDeSv4Kp2AhZ3GJfJCWZq1UMLWls7XglhkWtY5bUcNBV2V0Qq4AygGKzzWDEPMwf7NO+zqf5SzYyAdTRB0lJtIeabT/IbBSORF5IZCbyMrJ8aqL94+iFSqoCpDXR+zhKwSRalFYoGe1HRxmw5xq4BRZ6sYPDV4znuZoZVhnQhlnFpiBBYy8JM5aG+dh4zkqtzkUq5JSl3HI2EzZjY27g0S4DmagUUjYROfRO5Ik8EuU+e1fmiqdsrirNDl/8oZ4Nl8G2462tFzCupuzdq62t919l1pZmv9/nZdlTJUgjpjLnY9NLVNFPsWOZTh7GbJaBBpyVJVwy4Ebkc8bTlM1EOgVrYmYzkCxR5ZwlSulUSG7BxKzkU2CyKsagTcy4TFmhNDAhGWcaeDrftmq7MsD+4+2b12yidMFtjx3mlYnr5VKhIbH53E1vM6h39cAEbBirhZzGrOBniC1h2U+VSM5w2wZkiv/HgQeHrwhXW1tvq7JU2kLKfnRb2N/awi/fQK5mjGug/okqCiVZyTUvwBK5Mm7ps4afKqEhdUTheR5wsX8it9nWlp2XsL+1xV7JVCSIDJoQW5ma+L491xWRhF3flpCIifBdW6hjSrJZJpKMcDLjjp5lzhMHpgZTQmLFOXQnvojZHCd+AVIFCDKlxc9KWp4TOc5BW5HwvE02BBC7Gsu1RXSWSkgbWv0K7E+ePEg9IornKwQtRWQVQtIXA+yc5xUYD9UsZhlC9QOUGgyxup8XESlTloGYZmvX4+mHytjOxKwyCGYbCr9WoBKhFwhtE54bYGLSwWXBz6C1GlMkwzzvsW/mLIUJr3IbM4EcZ3UFPfZaWcbLMhcJH+eAnMtQeLitNGwTlT07eEAkL4jGhyTRYBhnqZhMQKNw4keawo8J0CGfNSqAJMdmXDIlFwidqFzpZRai5i4eWaKkBWl77OCci5yAd5s1TMgkr1Jg45wnZzEb5xXETEPqBHcOqLZir4SwC+PG45zwwwzkyIVKIvxS+eWFYcZDlfbYUSZMI0/4MaCaFhGmjVUvtROFKyMKgogxKLjIY0JczD6oMbPC5hCjwJZczmPUlxAzCxd2rC5ilmSQnNFfmqdCsXFlrZJuY6lWZapm0uNyoqQ14ucVEhm+fDxGRzHbjdmjmD2J2XAQs+EoZsPdmA0fxWz4JGajQcxGo5iNdmM2euTAGj3xuOY1gtsADEcOy/bLwS7q3e+FIclGhWlqHTzr6OBhj21t1dKEbX/5y19O5OWJZOwkQuE6ifbZSVR3OYli9w11Jn4b+t8X+GNn9Nj/nOPPR6Mn/ueMug53/c8Mf46GJ/LKL3giRwSJ5UV5DRT4+U4h8L88E2EbLYptQZ9hIyqiOHxAWnXgwQ9X7b3s4F6EFFbw3KzfTuhxj3bUgLS0qV3cFLHr+h3R53u0nTY8+IXUpPtEarX1KQg8QTFa2v1ez58s6zfvlr03e2+B83lbf4RbR9V0hKpp/f5r7XWPkLAI0+dh4nGPDADSzOvx4DvcIyx0Ifo8HDxBHOChtB4B+PUe7b4FDn7wJ7z7NtjdHu5tjwaj3Q4G8G7kOhTFdppuz+fzu8Ae2jx+eTR5goXqLDu8lU60KlZcP+h20PTyNhH9HUz2/0RDfRxsWEjx3kcXi2Cx1De+tpVtVcrnD4ybKgytjTPs35hm8xaY9AnhoNtvkimReOCxTzDJxnjB6yEOtgmT/TTttzCJjWm6XRTbC434c5sQ32osil6a9hZ6LlHHNRYsTWO23LyyPU1ZURRrml17p7lfFMu76BWFh42Mr69RSLzNtl5OfIffSlQaiegufK0YoedAyZzWpuvcajlaOGwyIf0Hz1RsoYOGaZVzDRd4LzVCSdf77mUsiFhj2dM9lq6A5CVwqGBfvfHW+0PP/riF7gTYcvO4pZ3hJAcsqYxVBdMwhQtWcmtBS5rsnOci5XSV26YGuOBFiVeA/p9PTtJ//Zc+OSDwjm8ZUoKlYirQD9T/8/HB9n+/X9GjKkvQCTfAcsCVTMzAJj12nEFeNq6o2WzWm+2YJFMqd36oD0bDxP17qsYfTgncssdN+XDVTh1rtC78yDqL930DtoMxblgYueLKTzxGMjQc0Gnr7zvXHLe+xz06cRZAwo/Oe4Kfj0+igpNBgqwMzd/KZqBPovf1GHfJh/SGse9vIayZSCHnY8iXP91a0OrmnM9V5eU7OLW6W/Uc3cIbfiiErP0WtJ1B3PrILxY+um9XK+TbIaQtneHICeIZKMByYYLnpovO9mjv2iKHowQgH+YYWBiA7uGgPT5XCmrAbicGThN52t2wBPZj1LF2K4bVblihQ5g2YnCOQkhRVEXtH53UswaUFd72aOMLR6LXPazQpu7SCvzihhXQGbl+gRM5JD9G8H9cY5n6HvdIVyyAdL0Yf4oW6ZzTd3TA3iyAYVttAVxxLGNXdyDXwmfWS1+PvcHjDX2ybhB62ZIESoseuc8VzRrkW59Q5LNq++HWc1671z3ivhVg/coc6Pvd9enzSUza3v0XxKgdsG/NrM4pWfDpNTd3+nyP2NPDs+SE2No61DARed4KKbLQFCI7GNKBHAof9vLBRDzqyBEupFV4LQhh2zFMKF5qKYyS8Sbg6M4ZR9J2TJQlGHFWmmXcOPubDH4kFQZsbQbFgis+gNa444UMcCNVhnd3bxx9PWjTafhor0OnvUGHToN1dLrm2ogUNKWSpva1QfOpJddE4tC+fLQsim2YFEn6UmJsJdwenDCoKk9ZLs4oqpIKU+Z8jlQNUuqhXAzXPc+UMk0PHzH7ym94vxuJUxqDcQ97dWDiNg6vBWK0aDF8vNMixd6TJ12J6QjMbe7vzXrLVBjs9od7fefRWu3Qatww65XwNZYAY7ehF/mJbkUv6tkQbON2+lS3092w+85d3rqHj0edw2Jn8KmHxZ1frttSc8O1+i4uz3d2i22L2y3vr7/ZPfLzuW/317Coh4932lz4eHgHLtQ1hvPncuKSfXxnvMfuyjhexYC3sI6vNYk/m0HbwP7qTLp3N5b0cNCx0L7uGGhfj9pMubd3K6ZsL7rAWSeR+K9v3vwwG/zx26k6ODg4eP32Xfby3fTg4KDA371eb+UlahW1aRm0XH1GoD+X6Yxfs0qv10MUYmrlPg3vl3L6b258vH5M70RGcaRKzNkUSr5Ko/2IjG4INngU0z0CjP1GpfNo/zLyOUL4p8/AwaH9DwYTRS8jk2RQcPwr3D8wtRRTO6OY0lxAmyiOKGiMeaZI0mg/UuMPkOBqpUZwrACDc9C4/cvQy+VGRrG3uKL9yG0xiiPv1q+b6qzSMp1EV2HB66aqW5qpDP1RX0hwHkw//MRpXuPQq4XU2k+a6UVrBtpbAUfqucJvFl7wuWnN67x+0WJGL45BYU/8KJbyuUGlURl3wCU8T6oc7UK4KIWe17FRMg5b/FHDW69Uwzvcu2qI3oDEtebzKI6EhaLdvoYJtPp4yiWgEDOUoPKxYz8oGAP83jdg4IYIz4uPhuKDAjYGInqZKfnR44ejneFouDMc4Qz+cvvpeHRflyHoMsYB5tBBGoye7SYZNGaUkNW7iUdDf9o2n8LNzHi0Lkm4lZtoMrrp8LIErnuUq/vJaeBd/q5P194N3HwVRxc3b+aCJWo7ZCCzr3KYWBcxZInSEvTDdhrCvdncaHf3Ko7mN29v/kVu7zESb3bz7n6k1O0mrf0fAevOk6s4ym6G9bs6ufwfCOzuo6vmdF0wHk7HKp2fBr11dVPHcFBgv4nKU9BokCzrq0bVoIbBRxGni3p+rFQOXK5QNJ2sYv98BY1f9P96h8gsA7xDNDYxzd4Y3N5b7KDFTGVYSH4QBm1VXcFJ1GOvJi3znczpxcTm0JeSjKViD2i9U1ORGn/Q978RRw/aDzjQ3drkHwUQqDOzUJQ5vYCYoc92TMG8tMfq/8jyqzGJAITjMix881Hx3CVd0IJ+UPf5APO2Y48957JOIe+marPLy5oNiDuurtjlJVIV9CkeuldXcdOAa3Ua6Fx1LRoSEOedUXUTNAPrttZQZ+KcoonjGnxKXxsAMZVCTk8r7edBS/DqqtdhyAXAyXPtcQBpzWdiKlfsurZXiNK3xv4Ssj0H4CT/b/D+tHz2nVgBytN++exp+exHfCxUgpM9h56JkKmT/BnkeY89NVYrOX22gIKnfd++mpQazgXMSHCJqs0si7itJ+p5mP6EirohnjAs0VUieE7ZRlolEAIkSDeJN2hjoTQYkRKWRrr3HGSP86kGCsUQLLyy9DiKrmZhwaecZRom//5gAacPnr1F0PFd3NM+f+Z7v3I+gYyfA+Nyzmjj5MBQ2jnBJpUmNZnkXIuJvwfGrMwBM6PwmsgTF1BzGA1wHGVcnpn46Vg/OwJesDclSITgl7/9HXsEnf5KvtEp6Fso9VcTF7pT7AHqsQexy9IidhfaWK+qnSb0HOLgWiM6PksfI34va9VvqrHBXjLM16hWq8V0ChjQ8j1osH/zAjzJ3KFBUPFJcOGXyDyqMgE8ZLBwG6PolnD8IeS063JpYYdiae2991ZpdYmPZN4cHd4Cl+QP2naC4pwhbpduDvbm6BDf2dXk7rF3psZEQC3vdGF4DWfngoe3OLVlP3eZLeCCGl4vtgOAPf/CbZstA5QKsxKi2B3qqOHqV6lLEzcPMZFEqrIYUBT+eRFJWQePBEWNyCNV3YYrb8AkZ9OKEoktim84NSmXsHknJ6SxunJZPSytdHga6NnCqQljGjwFrGCn1vwxA2nccM4m3FjQMaukQMzrCl2E9ZRwUYIWIBNYiQINDnWoOm4+orqPzt798L1/fhv2EIRyjBLoJoaUVSVxDUlC/RgyUG5x6yvtQa++bwYQbTd6suj9nCVooySqOKWnXHoN6u6j6MwcQ8Zz19WrCoyHITwo4V1ggqX9y9/+3oJrrUdiGTC3Ak9TzHS9AULyCzuGx2QuDSVqQNWFCOcD/fvFKwBCR0JzWqi0FiRzex4/pNxYU+tFH6CvkwNMlWR4bNX61sRBxxrvVDDkAiY/MUX4S9wvXAhjW8/5QtL9sn74ARCPSQsGuoSiVCPPy3lbwJukBbUwHV0PRPcpaH0JWpIFXll1qqEQ8nbnVNvlblWtCCqrCm5FwsJUptd94OviukGuC/ZVAA258Vwo/XCNqOJ0p0omcCrkKZyDvsX1/nWdJEgOwTHYGYBswxaQ5I6z5hHmDN/Nd3DSOp3oqXEbSvQMli4zY5XnqgtUeDAdst0DP7ijhB7yF2PMEHI5JihqpDjCLW3JFfal+NJ8ssXGk/YFuZqGg8E/sydtZ/DleNJ2B1+QJ+0JAusDkDcroHX2zUrdEaKM1w/4oMhlT3Ha63tiVI+cdC4MvgrBjTiMrtx/jfMv6P0bHILOY9iEEf11JmyG0DAaDPB/XXK+6CQQonFbJWgsTqo8n/8uim8fw7yeBq55tZPyOq2efRCjny+S89Fh5ONjXWv6I8+iTwpy4ZjFENcam/7arXiBqHSO9W9wL9u1PUXTtmgsZC4knAYCnqYqOQ27x34FGNM95W4FQ01uumV3aX3D8pFjzN1VXPRWFWAzMj9x3hl6b2r3htVzxqdcSIYyru+QqUDrm8Tv4yC7DgW7g8HpsEbC3jISXkl6bkTFno7UGcjfdqft5a1bHkG9KPJGB0bCdaLvUWez7Xa3SQNJpYWdR/vHl9HFNi/Ftvu+f/z+6j2yoM0UpkGUyhDE3GbRftRfyoowoM8pqn186eSmFgXDZYq5XEvnAy9F/3zYG0ZX8eKYlefJNf2h2v7YIcbyqZDTm8a9b3D0FunoSNXBVKOnSvFHQEXlCdHuFUcC+ScDjpcjRD2yxw9NLsnLQOSQ5bEqcaMh5mIqRsjE6CRXLJ7rK9IlVmdLDPdaeQrHIeWAsgjqJIJVeQH11kOkvw70t2L3rdD9ccPsdZQ8mPZDsolHu7tkPD4ekpW184QMmN1HV8SeTVgsirqhL8rwXwzgfF48ohuO2PjY/4l87Asuds88jZ/YZUJ2HJ6+qesADFxYO9w6Xq9Fp9daB9Qa/5NfcsHPUgOyyr2x1/EqrJC7YBV3pQ5zBVHqdgYkdbsDkrong45B7nfYzNCY1WQ716Yz2cdt8xht4PeoA4WcKFKgXqsFutABRwp46RoFeaKKusRVi5A0JoiA8wLiDL/DFMo3lWalmoGeVK5e1iSHC4FeGhwEBX1rAt/AixyMyfHhgIUpVXCkZ/DoDvcO14SXfCxygae3e9zjhKIxAEyP/diEzh9oVxXgHHI89Gs/F1aADAbbTOmzCYbgY8bZGEvfoacTZMZl4pyq7iQi5yB6edBhXWphsKKfRqiFg01Jq1ESCi75lGQ07qAqhRxVlmFajTHmYFReOUmzXORKu5Q32hAl11Ie6suLEj/RPRDd0Roy5Ntz71o3sQttuEPG14QcYxSpRFhEAuRhrGSusHwjRqOqPGelsi5ChNfNNow43GouDdq6PsvO06BGmPd6g/EPn94ZQAp/L+SZKzm2zY5rnvoRxkZY6BYkWJS9h90x3wr7XTXGgobKCKv0vBk9FTarxmQutCepf7iZvg0VQFvGQDNHqhKz4uKsEtPH2gn9t2CRQ0z/4PAVmZsP2S9//R/2PXAtWaZmjluTSkM+b4qNUjFOorxDW20tUlwFFTViPHHM58+XgMEfM25/+ev/GvYaZuhfRhFyiNzaOqzGuUjYUcil2NraD1VQm/yKzgNq96wNg12clW50LuRZjx3IObnnm9MG22lcZxt0wrUKp3LMxlTSZ1G7NXsNROQQNpCfA/n9sYbeGBikwoUQtaqmbrU2MH5z3Rd+uLeDNGXlwis/dD434Dj/KsXuuHO0Yo3TFQ8DOy/wuokHIFOqwmn2War5xDbzxwtP/+isW2oKrwYDOmI/TU0SJ4l+x3Wry3VeMGS7ulbDBCi1tVvLlpfCs9NxYEvWrfTx8WztHC10fLeu8GhRrwzPYA1S82byFvS5SMK9e41E96lzP4qjXCTgvT7+7Dr49vB7dr7TG0Rx63pwC+Huf//q+cvXb18iMKhIHcKGvUFvQM5pZWzBZWulhWrBi+daK498U1x4U1x4U1x4U1x4U1z4iyl/uykuvCkuvCkuvCkuvCkuvCku/OshYVNceFNceFNceFNceFNceFNceFNceFNceFNceFNceFNceFNc+P7oik1x4ftSs3VTXPi34MBNceFNceFNceFNceFNceFNceFNceFNceFNceFNceFNceFNceFNceFNceE1xYVbzy76Zc6FbD00dY/rjhdLDr+Powxf3+0fR5eXuMw7fEKDzT9V9Mjj+H0cnXMtMD2HHu7F4Z0ZPvQ4A3yt9NxlG20f4fqxk21KsF14r4gP5dyIA2Loa/u2Hwgevnl7FMVRqNVWqJReRvMZPgzhM/c2pvV6hNouo5zLaUUvTyI355WrJJJ139Wd0bs6/0fr+QqX8xaE3Qd3bhv4L25q5YDLS/dmj153uf7u09oRHrGhN9Lv/dXV1f8Beqn6RA==","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),r=t(28453),o=t(33617),l=t.n(o),a=t(17543),d=t.n(a),c=t(86013),h=t.n(c),p=t(63723),u=t.n(p),m=(t(18766),t(79329),t(9303));const x={id:"createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file.",sidebar_label:"Create Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztPNlyHDeSv4Kp2AhZ3GJfJCWZq1UMLWls7XglhkWtY5bUcNBV2V0Qq4AygGKzzWDEPMwf7NO+zqf5SzYyAdTRB0lJtIeabT/IbBSORF5IZCbyMrJ8aqL94+iFSqoCpDXR+zhKwSRalFYoGe1HRxmw5xq4BRZ6sYPDV4znuZoZVhnQhlnFpiBBYy8JM5aG+dh4zkqtzkUq5JSl3HI2EzZjY27g0S4DmagUUjYROfRO5Ik8EuU+e1fmiqdsrirNDl/8oZ4Nl8G2462tFzCupuzdq62t919l1pZmv9/nZdlTJUgjpjLnY9NLVNFPsWOZTh7GbJaBBpyVJVwy4Ebkc8bTlM1EOgVrYmYzkCxR5ZwlSulUSG7BxKzkU2CyKsagTcy4TFmhNDAhGWcaeDrftmq7MsD+4+2b12yidMFtjx3mlYnr5VKhIbH53E1vM6h39cAEbBirhZzGrOBniC1h2U+VSM5w2wZkiv/HgQeHrwhXW1tvq7JU2kLKfnRb2N/awi/fQK5mjGug/okqCiVZyTUvwBK5Mm7ps4afKqEhdUTheR5wsX8it9nWlp2XsL+1xV7JVCSIDJoQW5ma+L491xWRhF3flpCIifBdW6hjSrJZJpKMcDLjjp5lzhMHpgZTQmLFOXQnvojZHCd+AVIFCDKlxc9KWp4TOc5BW5HwvE02BBC7Gsu1RXSWSkgbWv0K7E+ePEg9IornKwQtRWQVQtIXA+yc5xUYD9UsZhlC9QOUGgyxup8XESlTloGYZmvX4+mHytjOxKwyCGYbCr9WoBKhFwhtE54bYGLSwWXBz6C1GlMkwzzvsW/mLIUJr3IbM4EcZ3UFPfZaWcbLMhcJH+eAnMtQeLitNGwTlT07eEAkL4jGhyTRYBhnqZhMQKNw4keawo8J0CGfNSqAJMdmXDIlFwidqFzpZRai5i4eWaKkBWl77OCci5yAd5s1TMgkr1Jg45wnZzEb5xXETEPqBHcOqLZir4SwC+PG45zwwwzkyIVKIvxS+eWFYcZDlfbYUSZMI0/4MaCaFhGmjVUvtROFKyMKgogxKLjIY0JczD6oMbPC5hCjwJZczmPUlxAzCxd2rC5ilmSQnNFfmqdCsXFlrZJuY6lWZapm0uNyoqQ14ucVEhm+fDxGRzHbjdmjmD2J2XAQs+EoZsPdmA0fxWz4JGajQcxGo5iNdmM2euTAGj3xuOY1gtsADEcOy/bLwS7q3e+FIclGhWlqHTzr6OBhj21t1dKEbX/5y19O5OWJZOwkQuE6ifbZSVR3OYli9w11Jn4b+t8X+GNn9Nj/nOPPR6Mn/ueMug53/c8Mf46GJ/LKL3giRwSJ5UV5DRT4+U4h8L88E2EbLYptQZ9hIyqiOHxAWnXgwQ9X7b3s4F6EFFbw3KzfTuhxj3bUgLS0qV3cFLHr+h3R53u0nTY8+IXUpPtEarX1KQg8QTFa2v1ez58s6zfvlr03e2+B83lbf4RbR9V0hKpp/f5r7XWPkLAI0+dh4nGPDADSzOvx4DvcIyx0Ifo8HDxBHOChtB4B+PUe7b4FDn7wJ7z7NtjdHu5tjwaj3Q4G8G7kOhTFdppuz+fzu8Ae2jx+eTR5goXqLDu8lU60KlZcP+h20PTyNhH9HUz2/0RDfRxsWEjx3kcXi2Cx1De+tpVtVcrnD4ybKgytjTPs35hm8xaY9AnhoNtvkimReOCxTzDJxnjB6yEOtgmT/TTttzCJjWm6XRTbC434c5sQ32osil6a9hZ6LlHHNRYsTWO23LyyPU1ZURRrml17p7lfFMu76BWFh42Mr69RSLzNtl5OfIffSlQaiegufK0YoedAyZzWpuvcajlaOGwyIf0Hz1RsoYOGaZVzDRd4LzVCSdf77mUsiFhj2dM9lq6A5CVwqGBfvfHW+0PP/riF7gTYcvO4pZ3hJAcsqYxVBdMwhQtWcmtBS5rsnOci5XSV26YGuOBFiVeA/p9PTtJ//Zc+OSDwjm8ZUoKlYirQD9T/8/HB9n+/X9GjKkvQCTfAcsCVTMzAJj12nEFeNq6o2WzWm+2YJFMqd36oD0bDxP17qsYfTgncssdN+XDVTh1rtC78yDqL930DtoMxblgYueLKTzxGMjQc0Gnr7zvXHLe+xz06cRZAwo/Oe4Kfj0+igpNBgqwMzd/KZqBPovf1GHfJh/SGse9vIayZSCHnY8iXP91a0OrmnM9V5eU7OLW6W/Uc3cIbfiiErP0WtJ1B3PrILxY+um9XK+TbIaQtneHICeIZKMByYYLnpovO9mjv2iKHowQgH+YYWBiA7uGgPT5XCmrAbicGThN52t2wBPZj1LF2K4bVblihQ5g2YnCOQkhRVEXtH53UswaUFd72aOMLR6LXPazQpu7SCvzihhXQGbl+gRM5JD9G8H9cY5n6HvdIVyyAdL0Yf4oW6ZzTd3TA3iyAYVttAVxxLGNXdyDXwmfWS1+PvcHjDX2ybhB62ZIESoseuc8VzRrkW59Q5LNq++HWc1671z3ivhVg/coc6Pvd9enzSUza3v0XxKgdsG/NrM4pWfDpNTd3+nyP2NPDs+SE2No61DARed4KKbLQFCI7GNKBHAof9vLBRDzqyBEupFV4LQhh2zFMKF5qKYyS8Sbg6M4ZR9J2TJQlGHFWmmXcOPubDH4kFQZsbQbFgis+gNa444UMcCNVhnd3bxx9PWjTafhor0OnvUGHToN1dLrm2ogUNKWSpva1QfOpJddE4tC+fLQsim2YFEn6UmJsJdwenDCoKk9ZLs4oqpIKU+Z8jlQNUuqhXAzXPc+UMk0PHzH7ym94vxuJUxqDcQ97dWDiNg6vBWK0aDF8vNMixd6TJ12J6QjMbe7vzXrLVBjs9od7fefRWu3Qatww65XwNZYAY7ehF/mJbkUv6tkQbON2+lS3092w+85d3rqHj0edw2Jn8KmHxZ1frttSc8O1+i4uz3d2i22L2y3vr7/ZPfLzuW/317Coh4932lz4eHgHLtQ1hvPncuKSfXxnvMfuyjhexYC3sI6vNYk/m0HbwP7qTLp3N5b0cNCx0L7uGGhfj9pMubd3K6ZsL7rAWSeR+K9v3vwwG/zx26k6ODg4eP32Xfby3fTg4KDA371eb+UlahW1aRm0XH1GoD+X6Yxfs0qv10MUYmrlPg3vl3L6b258vH5M70RGcaRKzNkUSr5Ko/2IjG4INngU0z0CjP1GpfNo/zLyOUL4p8/AwaH9DwYTRS8jk2RQcPwr3D8wtRRTO6OY0lxAmyiOKGiMeaZI0mg/UuMPkOBqpUZwrACDc9C4/cvQy+VGRrG3uKL9yG0xiiPv1q+b6qzSMp1EV2HB66aqW5qpDP1RX0hwHkw//MRpXuPQq4XU2k+a6UVrBtpbAUfqucJvFl7wuWnN67x+0WJGL45BYU/8KJbyuUGlURl3wCU8T6oc7UK4KIWe17FRMg5b/FHDW69Uwzvcu2qI3oDEtebzKI6EhaLdvoYJtPp4yiWgEDOUoPKxYz8oGAP83jdg4IYIz4uPhuKDAjYGInqZKfnR44ejneFouDMc4Qz+cvvpeHRflyHoMsYB5tBBGoye7SYZNGaUkNW7iUdDf9o2n8LNzHi0Lkm4lZtoMrrp8LIErnuUq/vJaeBd/q5P194N3HwVRxc3b+aCJWo7ZCCzr3KYWBcxZInSEvTDdhrCvdncaHf3Ko7mN29v/kVu7zESb3bz7n6k1O0mrf0fAevOk6s4ym6G9bs6ufwfCOzuo6vmdF0wHk7HKp2fBr11dVPHcFBgv4nKU9BokCzrq0bVoIbBRxGni3p+rFQOXK5QNJ2sYv98BY1f9P96h8gsA7xDNDYxzd4Y3N5b7KDFTGVYSH4QBm1VXcFJ1GOvJi3znczpxcTm0JeSjKViD2i9U1ORGn/Q978RRw/aDzjQ3drkHwUQqDOzUJQ5vYCYoc92TMG8tMfq/8jyqzGJAITjMix881Hx3CVd0IJ+UPf5APO2Y48957JOIe+marPLy5oNiDuurtjlJVIV9CkeuldXcdOAa3Ua6Fx1LRoSEOedUXUTNAPrttZQZ+KcoonjGnxKXxsAMZVCTk8r7edBS/DqqtdhyAXAyXPtcQBpzWdiKlfsurZXiNK3xv4Ssj0H4CT/b/D+tHz2nVgBytN++exp+exHfCxUgpM9h56JkKmT/BnkeY89NVYrOX22gIKnfd++mpQazgXMSHCJqs0si7itJ+p5mP6EirohnjAs0VUieE7ZRlolEAIkSDeJN2hjoTQYkRKWRrr3HGSP86kGCsUQLLyy9DiKrmZhwaecZRom//5gAacPnr1F0PFd3NM+f+Z7v3I+gYyfA+Nyzmjj5MBQ2jnBJpUmNZnkXIuJvwfGrMwBM6PwmsgTF1BzGA1wHGVcnpn46Vg/OwJesDclSITgl7/9HXsEnf5KvtEp6Fso9VcTF7pT7AHqsQexy9IidhfaWK+qnSb0HOLgWiM6PksfI34va9VvqrHBXjLM16hWq8V0ChjQ8j1osH/zAjzJ3KFBUPFJcOGXyDyqMgE8ZLBwG6PolnD8IeS063JpYYdiae2991ZpdYmPZN4cHd4Cl+QP2naC4pwhbpduDvbm6BDf2dXk7rF3psZEQC3vdGF4DWfngoe3OLVlP3eZLeCCGl4vtgOAPf/CbZstA5QKsxKi2B3qqOHqV6lLEzcPMZFEqrIYUBT+eRFJWQePBEWNyCNV3YYrb8AkZ9OKEoktim84NSmXsHknJ6SxunJZPSytdHga6NnCqQljGjwFrGCn1vwxA2nccM4m3FjQMaukQMzrCl2E9ZRwUYIWIBNYiQINDnWoOm4+orqPzt798L1/fhv2EIRyjBLoJoaUVSVxDUlC/RgyUG5x6yvtQa++bwYQbTd6suj9nCVooySqOKWnXHoN6u6j6MwcQ8Zz19WrCoyHITwo4V1ggqX9y9/+3oJrrUdiGTC3Ak9TzHS9AULyCzuGx2QuDSVqQNWFCOcD/fvFKwBCR0JzWqi0FiRzex4/pNxYU+tFH6CvkwNMlWR4bNX61sRBxxrvVDDkAiY/MUX4S9wvXAhjW8/5QtL9sn74ARCPSQsGuoSiVCPPy3lbwJukBbUwHV0PRPcpaH0JWpIFXll1qqEQ8nbnVNvlblWtCCqrCm5FwsJUptd94OviukGuC/ZVAA258Vwo/XCNqOJ0p0omcCrkKZyDvsX1/nWdJEgOwTHYGYBswxaQ5I6z5hHmDN/Nd3DSOp3oqXEbSvQMli4zY5XnqgtUeDAdst0DP7ijhB7yF2PMEHI5JihqpDjCLW3JFfal+NJ8ssXGk/YFuZqGg8E/sydtZ/DleNJ2B1+QJ+0JAusDkDcroHX2zUrdEaKM1w/4oMhlT3Ha63tiVI+cdC4MvgrBjTiMrtx/jfMv6P0bHILOY9iEEf11JmyG0DAaDPB/XXK+6CQQonFbJWgsTqo8n/8uim8fw7yeBq55tZPyOq2efRCjny+S89Fh5ONjXWv6I8+iTwpy4ZjFENcam/7arXiBqHSO9W9wL9u1PUXTtmgsZC4knAYCnqYqOQ27x34FGNM95W4FQ01uumV3aX3D8pFjzN1VXPRWFWAzMj9x3hl6b2r3htVzxqdcSIYyru+QqUDrm8Tv4yC7DgW7g8HpsEbC3jISXkl6bkTFno7UGcjfdqft5a1bHkG9KPJGB0bCdaLvUWez7Xa3SQNJpYWdR/vHl9HFNi/Ftvu+f/z+6j2yoM0UpkGUyhDE3GbRftRfyoowoM8pqn186eSmFgXDZYq5XEvnAy9F/3zYG0ZX8eKYlefJNf2h2v7YIcbyqZDTm8a9b3D0FunoSNXBVKOnSvFHQEXlCdHuFUcC+ScDjpcjRD2yxw9NLsnLQOSQ5bEqcaMh5mIqRsjE6CRXLJ7rK9IlVmdLDPdaeQrHIeWAsgjqJIJVeQH11kOkvw70t2L3rdD9ccPsdZQ8mPZDsolHu7tkPD4ekpW184QMmN1HV8SeTVgsirqhL8rwXwzgfF48ohuO2PjY/4l87Asuds88jZ/YZUJ2HJ6+qesADFxYO9w6Xq9Fp9daB9Qa/5NfcsHPUgOyyr2x1/EqrJC7YBV3pQ5zBVHqdgYkdbsDkrong45B7nfYzNCY1WQ716Yz2cdt8xht4PeoA4WcKFKgXqsFutABRwp46RoFeaKKusRVi5A0JoiA8wLiDL/DFMo3lWalmoGeVK5e1iSHC4FeGhwEBX1rAt/AixyMyfHhgIUpVXCkZ/DoDvcO14SXfCxygae3e9zjhKIxAEyP/diEzh9oVxXgHHI89Gs/F1aADAbbTOmzCYbgY8bZGEvfoacTZMZl4pyq7iQi5yB6edBhXWphsKKfRqiFg01Jq1ESCi75lGQ07qAqhRxVlmFajTHmYFReOUmzXORKu5Q32hAl11Ie6suLEj/RPRDd0Roy5Ntz71o3sQttuEPG14QcYxSpRFhEAuRhrGSusHwjRqOqPGelsi5ChNfNNow43GouDdq6PsvO06BGmPd6g/EPn94ZQAp/L+SZKzm2zY5rnvoRxkZY6BYkWJS9h90x3wr7XTXGgobKCKv0vBk9FTarxmQutCepf7iZvg0VQFvGQDNHqhKz4uKsEtPH2gn9t2CRQ0z/4PAVmZsP2S9//R/2PXAtWaZmjluTSkM+b4qNUjFOorxDW20tUlwFFTViPHHM58+XgMEfM25/+ev/GvYaZuhfRhFyiNzaOqzGuUjYUcil2NraD1VQm/yKzgNq96wNg12clW50LuRZjx3IObnnm9MG22lcZxt0wrUKp3LMxlTSZ1G7NXsNROQQNpCfA/n9sYbeGBikwoUQtaqmbrU2MH5z3Rd+uLeDNGXlwis/dD434Dj/KsXuuHO0Yo3TFQ8DOy/wuokHIFOqwmn2War5xDbzxwtP/+isW2oKrwYDOmI/TU0SJ4l+x3Wry3VeMGS7ulbDBCi1tVvLlpfCs9NxYEvWrfTx8WztHC10fLeu8GhRrwzPYA1S82byFvS5SMK9e41E96lzP4qjXCTgvT7+7Dr49vB7dr7TG0Rx63pwC+Huf//q+cvXb18iMKhIHcKGvUFvQM5pZWzBZWulhWrBi+daK498U1x4U1x4U1x4U1x4U1z4iyl/uykuvCkuvCkuvCkuvCkuvCku/OshYVNceFNceFNceFNceFNceFNceFNceFNceFNceFNceFNceFNc+P7oik1x4ftSs3VTXPi34MBNceFNceFNceFNceFNceFNceFNceFNceFNceFNceFNceFNceFNceFNceE1xYVbzy76Zc6FbD00dY/rjhdLDr+Powxf3+0fR5eXuMw7fEKDzT9V9Mjj+H0cnXMtMD2HHu7F4Z0ZPvQ4A3yt9NxlG20f4fqxk21KsF14r4gP5dyIA2Loa/u2Hwgevnl7FMVRqNVWqJReRvMZPgzhM/c2pvV6hNouo5zLaUUvTyI355WrJJJ139Wd0bs6/0fr+QqX8xaE3Qd3bhv4L25q5YDLS/dmj153uf7u09oRHrGhN9Lv/dXV1f8Beqn6RA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},y=void 0,g={},f=[];function j(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.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:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document before it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date"\n "page": 1\n "x": 173\n "y": 588\n "w": 114\n "h": 21\n "options": {\n "name": "date"\n "response": "04/15/2024"\n "format": "mm/dd/yyyy"\n "color": "black"\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(h(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample 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"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createdocument_body_widgets"}}},title:"createdocument_body_signers"}},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"{{sender_name}} has requested you to sign {{document_title}}"},email_body:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"

Hi {{receiver_name}},

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

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

Sign here

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

Thanks,
Team OpenSign\u2122

"},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5},prefill:{type:"object",description:"You can provide widgets which can embed before sending to signer",properties:{widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"textbox"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:100},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},title:"createdocument_body"}}},required:!0}}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"hji2zxcv2P"},signurl:{type:"array",items:{type:"object",properties:{email:{type:"string",format:"string",example:"mail@example.com"},url:{type:"string",format:"string",example:"https://url-to-sign-document.com"}},title:"inline_response_doc_signurl"}},message:{type:"string",format:"string",example:"Document sent successfully!"}},title:"inline_response_doc"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/4227e71a.34e886ef.js b/assets/js/4227e71a.34e886ef.js deleted file mode 100644 index 7a954af99..000000000 --- a/assets/js/4227e71a.34e886ef.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[5342],{30649:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>x,contentTitle:()=>h,default:()=>k,frontMatter:()=>f,metadata:()=>p,toc:()=>w});const p=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":"eJzVWM1u3DgSfpUaXnZiyN1tx3Fm+zTGbJAxNpgYYw8MrGM0KKlaYkyRHJLqHzQEzGHfYE973UfLkyyKlNRqu+MfzCLAXhI3VR9ZVaxifVUb5nnh2PSGXWFlJPfo2G3CcnSZFcYLrdiUXZUI79FDJwJnF+fApdRLB2tdg9dg0VuBC4QcPRfSAU917YGDM5iJucjAt+BRv40Dh3aBwB2kskZjhfIO5tpCZpF7oQrIdVZXSMtL4UswFnOcC4U5OG/rzNcW3YglTBu0nLQ9z9mUFei7M1jCDLe8Qo+WzNwwxStkU9apMxM5S5ggMw33Jbtv+/nfQM975cGX3INCzB1ZnSLM0Wcl0h4Wf6+FxZxNva0xYc6vJZ3kRGUkKYIrI3WObDrn0pFAVmLF2XTD/NoESW+FKljC5tpW3McVVbCmuaXtndHKoSPA8WRC/+2q6uosQ+fmtYTeHyxhmVYelSd5bowUWfgw/uwItHmohU4/Y+bJcZa28SIeGZfJv4/rG1dwxYPVU7Y6+jlVlTu+KFiTMC88rT7cYgtw4Y/e5YRS2j8B6i8oiDakkszRfiuzYlA9pmDUB4Jgs3XENg5bhUl18ZSLSu+Nm47HHbh2aEeZrgitl2rH7secFfJMd1olzIlChTzp0dxavqYE8Vi5p71p9VOqZ6if57DPGiHFoBZWXMgnpVPEH9uFzhem1OqJY07enB4fvf7h7RHJL0VeoP8T9sevL4skjyuf6lXQlxdDuKqrFO0Q3q/08KMmYasXYo5PTpqErV+IektHLV8Iev1Dk7DyhaCTU4rj8Kw9w+dfC6Vn+bzZm4uXMQ9mXTw8KhXS2aHKz9VHu/vmpFpL5Gp4NNWGJmEh8zA/849H5/Hk+PXh0eRw8vbq6HR68tfpm9PRZDL5B0vYqpJb61nevpSdkt3v2uTf5BxUPJV4pevnmW8xFxYzP6vt3sR+7O7ouEA+ZpXOiVrw+4Gy59xQcglYez2zWAn15E11kCg90yrDmVAzXKDdmzo9cEIBseu2YTG7H0dtEJ7sK+mXukJfEhNaovKwtFoVCRiJ3CF4uwZecKGAtrHf/e9qPVqrn6ghL9NsmD9CSaFw1vGZ2clkMjvqnXDy0AlXg9oOc12r/Nuauu/8xw06mZ32Br15aNC5WnAp8kCjr/Qdqm9rz/B4H49/GLEiCoXvbMfY4Xo00mFWW+HXgV+vDrkRh/H79OaWqCtFim6JeSDkvmRT1rOX8WZAxhtG+9lFR9fDA9ETHsdVnurVSBtURFYkTx0V+zE3Yrw4GlEVv4/hxrxIHuvDl0Kc54VQxVO4262rLuk6443tOGxLPIz4OxLzaO9jKNX2KyXywBgb+j3XAdze0keDispTuONw+P2+5hplpiukLsaXCB3gyz//EzBd4xWCMOzw3Sf1SX2sLRi9REtNBlc5zCWuRCpjS4hV+NY3hQ55JdE5uQahPBaWkigXhfBcAvmIno+MG54KKSiASUwT2sIgB9wIrkv0JVr69BeLwCHHBUqKe6AXvdrtFmGp7d2c2tMEOKS1EwqdA1QlVxkJdreQgLbAFaDyaI0VDqmvJK1F1E0rb3nmoeKKF0h7JzuuylEKClWwOq2dB6dlHVQG6oK1xRw6g0LTOCInvqM+0CLQaqYrY7GkkFkgFLXI0SWQ6Rwh9kFkgsohRefBkC4iw9B71krq7C5c3ryWEoym50NwSf3qUEeCe8uVo6IadenuoHeYsZpaR4wKHhz85pBu+INQd256cPBJHcJNH1PXmDrh8fb7LvyXy+WDsH+1i3kv/M91Cr+i0U54bddbdCF8WachVYab9D/iTu9RYYifQSJs98h15h5mHq2OS5RmfImeIsSNzy7Ow4v7Cr788S/4gNwqKPUyRmtWW5RrKLqjyHPx5qPb+gczDCl47UvyeBaDj9p/dL7z4HXJ/Zc//u3gF1yCiCkUHXlwcFGnUmTbOcjBwRR+CoSw73pdnDRkXNGQwZWcQmkhOHAwES2FuhvBmVoDdX9xPkLBQOsBt2MG+WUwTUm5wxy0Coh9kxlfYuVQLtDRXlT4UgTMhaeILq2ui3jaUJnWOItzISVcR+5Mtp3lOY1uwnJLqcnhA3VwTgnhS1wDtwgOlR/BxT1I+FIboy1pIaLyc01UkC4AVW40jZCmkFs+99v9k22gx8mSVnuWogt5746k3aa/kpiJrcX96ugTPcj3HvHdt9biHC0dGMze3osRbTjddGEJFK1/JqypVNOrxbPAJNrOmarJj/f3CVUdbeU+zi/RLkTWTRa+ktHjIDxmCZMiQ+VwwBbO3l98gMXr0YQlg9L4jOQefzj/6d0vl+9IGXpIo8OORpPRJDTE2vmKq8FJwznk/aK22ZKo/4OZZVvoqRUdG8lFoFltPxQp0s22R0jYdDixvE1YqZ0nkc2Gkvk3K5uGln+vQ3tyc5uwBbeCurLAo3Lh6O+8nz5+1XPf/9oOMl/B84efe43pqIwiHrPgsg7tW8LucH1vAtvc0pgg8hnSNkqcZRkaP8A+IMY77PL9uysWOrxyl0fdBR7V/kG779Vrl2BFBehfYnt7AZtN5GhN08vHT19FtAZ20uSk26Zp/guv8jML","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 r=a(74848),n=a(28453),i=a(33617),l=a.n(i),o=a(17543),s=a.n(o),m=a(86013),d=a.n(m),c=a(63723),u=a.n(c),g=(a(18766),a(79329),a(9303));const f={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:"eJzVWM1u3DgSfpUaXnZiyN1tx3Fm+zTGbJAxNpgYYw8MrGM0KKlaYkyRHJLqHzQEzGHfYE973UfLkyyKlNRqu+MfzCLAXhI3VR9ZVaxifVUb5nnh2PSGXWFlJPfo2G3CcnSZFcYLrdiUXZUI79FDJwJnF+fApdRLB2tdg9dg0VuBC4QcPRfSAU917YGDM5iJucjAt+BRv40Dh3aBwB2kskZjhfIO5tpCZpF7oQrIdVZXSMtL4UswFnOcC4U5OG/rzNcW3YglTBu0nLQ9z9mUFei7M1jCDLe8Qo+WzNwwxStkU9apMxM5S5ggMw33Jbtv+/nfQM975cGX3INCzB1ZnSLM0Wcl0h4Wf6+FxZxNva0xYc6vJZ3kRGUkKYIrI3WObDrn0pFAVmLF2XTD/NoESW+FKljC5tpW3McVVbCmuaXtndHKoSPA8WRC/+2q6uosQ+fmtYTeHyxhmVYelSd5bowUWfgw/uwItHmohU4/Y+bJcZa28SIeGZfJv4/rG1dwxYPVU7Y6+jlVlTu+KFiTMC88rT7cYgtw4Y/e5YRS2j8B6i8oiDakkszRfiuzYlA9pmDUB4Jgs3XENg5bhUl18ZSLSu+Nm47HHbh2aEeZrgitl2rH7secFfJMd1olzIlChTzp0dxavqYE8Vi5p71p9VOqZ6if57DPGiHFoBZWXMgnpVPEH9uFzhem1OqJY07enB4fvf7h7RHJL0VeoP8T9sevL4skjyuf6lXQlxdDuKqrFO0Q3q/08KMmYasXYo5PTpqErV+IektHLV8Iev1Dk7DyhaCTU4rj8Kw9w+dfC6Vn+bzZm4uXMQ9mXTw8KhXS2aHKz9VHu/vmpFpL5Gp4NNWGJmEh8zA/849H5/Hk+PXh0eRw8vbq6HR68tfpm9PRZDL5B0vYqpJb61nevpSdkt3v2uTf5BxUPJV4pevnmW8xFxYzP6vt3sR+7O7ouEA+ZpXOiVrw+4Gy59xQcglYez2zWAn15E11kCg90yrDmVAzXKDdmzo9cEIBseu2YTG7H0dtEJ7sK+mXukJfEhNaovKwtFoVCRiJ3CF4uwZecKGAtrHf/e9qPVqrn6ghL9NsmD9CSaFw1vGZ2clkMjvqnXDy0AlXg9oOc12r/Nuauu/8xw06mZ32Br15aNC5WnAp8kCjr/Qdqm9rz/B4H49/GLEiCoXvbMfY4Xo00mFWW+HXgV+vDrkRh/H79OaWqCtFim6JeSDkvmRT1rOX8WZAxhtG+9lFR9fDA9ETHsdVnurVSBtURFYkTx0V+zE3Yrw4GlEVv4/hxrxIHuvDl0Kc54VQxVO4262rLuk6443tOGxLPIz4OxLzaO9jKNX2KyXywBgb+j3XAdze0keDispTuONw+P2+5hplpiukLsaXCB3gyz//EzBd4xWCMOzw3Sf1SX2sLRi9REtNBlc5zCWuRCpjS4hV+NY3hQ55JdE5uQahPBaWkigXhfBcAvmIno+MG54KKSiASUwT2sIgB9wIrkv0JVr69BeLwCHHBUqKe6AXvdrtFmGp7d2c2tMEOKS1EwqdA1QlVxkJdreQgLbAFaDyaI0VDqmvJK1F1E0rb3nmoeKKF0h7JzuuylEKClWwOq2dB6dlHVQG6oK1xRw6g0LTOCInvqM+0CLQaqYrY7GkkFkgFLXI0SWQ6Rwh9kFkgsohRefBkC4iw9B71krq7C5c3ryWEoym50NwSf3qUEeCe8uVo6IadenuoHeYsZpaR4wKHhz85pBu+INQd256cPBJHcJNH1PXmDrh8fb7LvyXy+WDsH+1i3kv/M91Cr+i0U54bddbdCF8WachVYab9D/iTu9RYYifQSJs98h15h5mHq2OS5RmfImeIsSNzy7Ow4v7Cr788S/4gNwqKPUyRmtWW5RrKLqjyHPx5qPb+gczDCl47UvyeBaDj9p/dL7z4HXJ/Zc//u3gF1yCiCkUHXlwcFGnUmTbOcjBwRR+CoSw73pdnDRkXNGQwZWcQmkhOHAwES2FuhvBmVoDdX9xPkLBQOsBt2MG+WUwTUm5wxy0Coh9kxlfYuVQLtDRXlT4UgTMhaeILq2ui3jaUJnWOItzISVcR+5Mtp3lOY1uwnJLqcnhA3VwTgnhS1wDtwgOlR/BxT1I+FIboy1pIaLyc01UkC4AVW40jZCmkFs+99v9k22gx8mSVnuWogt5746k3aa/kpiJrcX96ugTPcj3HvHdt9biHC0dGMze3osRbTjddGEJFK1/JqypVNOrxbPAJNrOmarJj/f3CVUdbeU+zi/RLkTWTRa+ktHjIDxmCZMiQ+VwwBbO3l98gMXr0YQlg9L4jOQefzj/6d0vl+9IGXpIo8OORpPRJDTE2vmKq8FJwznk/aK22ZKo/4OZZVvoqRUdG8lFoFltPxQp0s22R0jYdDixvE1YqZ0nkc2Gkvk3K5uGln+vQ3tyc5uwBbeCurLAo3Lh6O+8nz5+1XPf/9oOMl/B84efe43pqIwiHrPgsg7tW8LucH1vAtvc0pgg8hnSNkqcZRkaP8A+IMY77PL9uysWOrxyl0fdBR7V/kG779Vrl2BFBehfYnt7AZtN5GhN08vHT19FtAZ20uSk26Zp/guv8jML",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,x={},w=[];function v(e){const t={p:"p",...(0,n.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(g.default,{as:"h1",className:"openapi__heading",children:"Get Template"}),"\n",(0,r.jsx)(l(),{method:"get",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,r.jsx)(t.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,r.jsx)(g.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,r.jsx)(s(),{parameters:[{name:"template_id",in:"path",description:"ID of template that needs to be fetched",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"strng"}}]}),"\n",(0,r.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,r.jsx)(u(),{id:void 0,label:void 0,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"},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:!0},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:!0},redirect_url:{type:"string",format:"string",example:""},allow_modifications:{type:"boolean",example:!1},auto_reminder:{type:"boolean",example:!1},remind_once_in_every:{type:"number",example:0}},xml:{name:"template"},title:"template"}}}},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"}}}}}})]})}function k(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/4227e71a.3f44a353.js b/assets/js/4227e71a.3f44a353.js new file mode 100644 index 000000000..9195b4979 --- /dev/null +++ b/assets/js/4227e71a.3f44a353.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[5342],{30649:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>f,contentTitle:()=>y,default:()=>P,frontMatter:()=>h,metadata:()=>n,toc:()=>x});const n=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":"eJzVWM1uGzkSfpVaXnYitCXZcZxZncaYDTLGBhNj7IGBdQyB3V1SM2aTHJKtHwgNzGHeYE973UfLkyyK7G61ZMU/mEWAvSQWuz6yqljF+qo2zPO5Y5Nbdo2lkdyjY3cJy9FlVhgvtGITdl0gvEcPrQicX14Al1IvHax1BV6DRW8FLhBy9FxIBzzVlQcOzmAmZiID34CH3TYOHNoFAneQygqNFco7mGkLmUXuhZpDrrOqRFpeCl+AsZjjTCjMwXlbZb6y6IYsYdqg5aTtRc4mbI6+PYMlzHDLS/RoycwNU7xENmGtOlORs4QJMtNwX7B92y/+DnrWKQ++4B4UYu7I6hRhhj4rkPaw+FslLOZs4m2FCXN+LekkJ0ojSRFcGalzZJMZl44EsgJLziYb5tcmSHor1JwlbKZtyX1cUXNW13e0vTNaOXQEOBmP6b9dVV2VZejcrJLQ+YMlLNPKo/Ikz42RIgsfRp8dgTYPtdDpZ8w8Oc7SNl7EI+My+fdxfeMKrniwesJWxz+lqnQnl3NWJ8wLT6sPt9gCXPijczmhlPZPgLoLCqI1qSRztN/KrBhUjykY9YEgWG8dsY3DRmFSXTzlosJ74yajUQuuHNphpktC66XasfsxZ4U8061WCXNirkKedGhuLV9Tgngs3dPetPop1TPUz3PYZ42QYlALSy7kk9Ip4g/NQusLU2j1xDGnb85Ojl9///aY5Jcin6P/E/bHry+LJI8rn+pV0JfP+3BVlSnaPrxb6eDHdcJWL8ScnJ7WCVu/EPWWjlq+EPT6+zphxQtBp2cUx+FZe4bPvxZKz/J5fTAXr2IeTNt4eFQqpLNDlV+oj3b3zUm1lshV/2iqDXXCQuZhfu4fj86T8cnro+Px0fjt9fHZ5PRvkzdnw/F4/E+WsFUpt9azvHkpWyXb35XJv8k5qHgq8VpXzzPfYi4sZn5a2YOJ/djd0XGBfExLnRO14PuBcuDcUHIJWHk9tVgK9eRNtZAoPdUqw6lQU1ygPZg6HXBMAbHrtn4x24+jJghPD5X0K12iL4gJLVF5WFqt5gkYidwheLsGPudCAW1j//K/q/VorX6ihrxMs37+CCWFwmnLZ6an4/H0uHPC6UMnXPdqO8x0pfJva+qh8x836HR61hn05qFBF2rBpcgDjb7W96i+rT394308/mHEiigUvrMdY/vr0UiHWWWFXwd+vTriRhzF75PbO6KuFCm6IeaBkPuCTVjHXkabHhmvGe1nFy1dDw9ER3gcV3mqV0NtUBFZkTx1VOxH3IjR4nhIVXwfw415kTxWRy+FOM/nQs2fwt1tXXVF1xlvbMdhW+JhxD+QmEdzH32ppl8pkAfGWNPvmQ7g5pY+GlRUnsIdh8P3+5oblJkukboYXyAMBi3kyx//6VCDQdeBhWgcflKf1MfKgtFLtNRocJXDTOJKpDK2hViGb11j6JCXEp2TaxDK49xSIuViLjyXQH6iJyTjhqdCCgpiEtOEttDLAzeEmwJ9gZY+/dUicMhxgZJiH+hVL3c7Rlhqez+jFjUBDmnlhELnAFXBVUaC7U0koC1wBag8WmOFQ+otSWsRddPKW555KLnic6S9E+g7K0cpKFzB6rRyHpyWVVAZqBPWFnNoDQqNY3DiO+oFLQKtZro0FgsKmwXCvBI5ugQynSPEXohMUDmk6DwY0kVkGPrPSkmd3YcLnFVSgtH0hAguqWft60hwb7lyVFijLu0ddA4zVlP7iFHBweBXh3TDH4S6d5PB4JM6gtsurm4wdcLj3XdtCiyXyweh/2oX8174n6oUfkGjnfDarrfoufBFlYZ06W/S/Yg7vUeFIX56ybDdI9eZe5h9tDoqUJrRFXqKEDc6v7wIr+4r+PL7v+ADcqug0MsYrVllUa5h3h5Fnos3H93WPZphUMErX5DHsxh8NAJA51sP3hTcf/n93w5+xiUI1aQUmTIYXFapFNl2FjIYTODHQAq7ztfFaUPGFQ0aXMEplBaCAwcT0VKo+yGcqzVQBxhnJBQMtB5wO2aQX3oTlZQ7zEGrgDg0nfEFlg7lAh3tRcUvRcBceIrowupqHk/rK9MYZ3EmpISbyJ/JtvM8p/FNWG5oNTm8pw7OKCF8gWvgFsGh8kO43IOEL5Ux2pIWIio/00QH6QJQ5UbTGGkCueUzv90/2QZ6nC5pdWApupB37kiabboriZnYWNytDj/Ro7z3kO++txZnaOnAYPb2Xoxowum2DUugaP0zYU3lml4tngU20XTPVFF+2N8nVHa0pfs4u0K7EFk7XfhKRo+C8IglTIoMlcMeYzh/f/kBFq+HY5b0yuMzknv04eLHdz9fvSNl6CGNDjsejofj0BRr50uueif1Z5H7hW2zJVL/B3PLpthTOzoykotAtZqeKNKk222fkLBJf2p5l7BCO08imw0l869W1jUt/1aFFuX2LmELbgV1ZoFL5cLR33k3gfyq5777pRlmvoLnD0APGtPSGUVcZsFlFVq4hN3jem8KW9/RqCByGtI2SpxnGRrfwz4gxzsM8/27axa6vGKXS90HLtX8Qbsf1GuXZEUF6F9ifAcBm03kaXXdycdPX0U0BrbS5KS7uq7/C5OaM8A=","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 p=a(74848),l=a(28453),r=a(33617),i=a.n(r),o=a(17543),s=a.n(o),m=a(86013),c=a.n(m),d=a(63723),g=a.n(d),u=(a(18766),a(79329),a(9303));const h={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:"eJzVWM1uGzkSfpVaXnYitCXZcZxZncaYDTLGBhNj7IGBdQyB3V1SM2aTHJKtHwgNzGHeYE973UfLkyyK7G61ZMU/mEWAvSQWuz6yqljF+qo2zPO5Y5Nbdo2lkdyjY3cJy9FlVhgvtGITdl0gvEcPrQicX14Al1IvHax1BV6DRW8FLhBy9FxIBzzVlQcOzmAmZiID34CH3TYOHNoFAneQygqNFco7mGkLmUXuhZpDrrOqRFpeCl+AsZjjTCjMwXlbZb6y6IYsYdqg5aTtRc4mbI6+PYMlzHDLS/RoycwNU7xENmGtOlORs4QJMtNwX7B92y/+DnrWKQ++4B4UYu7I6hRhhj4rkPaw+FslLOZs4m2FCXN+LekkJ0ojSRFcGalzZJMZl44EsgJLziYb5tcmSHor1JwlbKZtyX1cUXNW13e0vTNaOXQEOBmP6b9dVV2VZejcrJLQ+YMlLNPKo/Ikz42RIgsfRp8dgTYPtdDpZ8w8Oc7SNl7EI+My+fdxfeMKrniwesJWxz+lqnQnl3NWJ8wLT6sPt9gCXPijczmhlPZPgLoLCqI1qSRztN/KrBhUjykY9YEgWG8dsY3DRmFSXTzlosJ74yajUQuuHNphpktC66XasfsxZ4U8061WCXNirkKedGhuLV9Tgngs3dPetPop1TPUz3PYZ42QYlALSy7kk9Ip4g/NQusLU2j1xDGnb85Ojl9///aY5Jcin6P/E/bHry+LJI8rn+pV0JfP+3BVlSnaPrxb6eDHdcJWL8ScnJ7WCVu/EPWWjlq+EPT6+zphxQtBp2cUx+FZe4bPvxZKz/J5fTAXr2IeTNt4eFQqpLNDlV+oj3b3zUm1lshV/2iqDXXCQuZhfu4fj86T8cnro+Px0fjt9fHZ5PRvkzdnw/F4/E+WsFUpt9azvHkpWyXb35XJv8k5qHgq8VpXzzPfYi4sZn5a2YOJ/djd0XGBfExLnRO14PuBcuDcUHIJWHk9tVgK9eRNtZAoPdUqw6lQU1ygPZg6HXBMAbHrtn4x24+jJghPD5X0K12iL4gJLVF5WFqt5gkYidwheLsGPudCAW1j//K/q/VorX6ihrxMs37+CCWFwmnLZ6an4/H0uHPC6UMnXPdqO8x0pfJva+qh8x836HR61hn05qFBF2rBpcgDjb7W96i+rT394308/mHEiigUvrMdY/vr0UiHWWWFXwd+vTriRhzF75PbO6KuFCm6IeaBkPuCTVjHXkabHhmvGe1nFy1dDw9ER3gcV3mqV0NtUBFZkTx1VOxH3IjR4nhIVXwfw415kTxWRy+FOM/nQs2fwt1tXXVF1xlvbMdhW+JhxD+QmEdzH32ppl8pkAfGWNPvmQ7g5pY+GlRUnsIdh8P3+5oblJkukboYXyAMBi3kyx//6VCDQdeBhWgcflKf1MfKgtFLtNRocJXDTOJKpDK2hViGb11j6JCXEp2TaxDK49xSIuViLjyXQH6iJyTjhqdCCgpiEtOEttDLAzeEmwJ9gZY+/dUicMhxgZJiH+hVL3c7Rlhqez+jFjUBDmnlhELnAFXBVUaC7U0koC1wBag8WmOFQ+otSWsRddPKW555KLnic6S9E+g7K0cpKFzB6rRyHpyWVVAZqBPWFnNoDQqNY3DiO+oFLQKtZro0FgsKmwXCvBI5ugQynSPEXohMUDmk6DwY0kVkGPrPSkmd3YcLnFVSgtH0hAguqWft60hwb7lyVFijLu0ddA4zVlP7iFHBweBXh3TDH4S6d5PB4JM6gtsurm4wdcLj3XdtCiyXyweh/2oX8174n6oUfkGjnfDarrfoufBFlYZ06W/S/Yg7vUeFIX56ybDdI9eZe5h9tDoqUJrRFXqKEDc6v7wIr+4r+PL7v+ADcqug0MsYrVllUa5h3h5Fnos3H93WPZphUMErX5DHsxh8NAJA51sP3hTcf/n93w5+xiUI1aQUmTIYXFapFNl2FjIYTODHQAq7ztfFaUPGFQ0aXMEplBaCAwcT0VKo+yGcqzVQBxhnJBQMtB5wO2aQX3oTlZQ7zEGrgDg0nfEFlg7lAh3tRcUvRcBceIrowupqHk/rK9MYZ3EmpISbyJ/JtvM8p/FNWG5oNTm8pw7OKCF8gWvgFsGh8kO43IOEL5Ux2pIWIio/00QH6QJQ5UbTGGkCueUzv90/2QZ6nC5pdWApupB37kiabboriZnYWNytDj/Ro7z3kO++txZnaOnAYPb2Xoxowum2DUugaP0zYU3lml4tngU20XTPVFF+2N8nVHa0pfs4u0K7EFk7XfhKRo+C8IglTIoMlcMeYzh/f/kBFq+HY5b0yuMzknv04eLHdz9fvSNl6CGNDjsejofj0BRr50uueif1Z5H7hW2zJVL/B3PLpthTOzoykotAtZqeKNKk222fkLBJf2p5l7BCO08imw0l869W1jUt/1aFFuX2LmELbgV1ZoFL5cLR33k3gfyq5777pRlmvoLnD0APGtPSGUVcZsFlFVq4hN3jem8KW9/RqCByGtI2SpxnGRrfwz4gxzsM8/27axa6vGKXS90HLtX8Qbsf1GuXZEUF6F9ifAcBm03kaXXdycdPX0U0BrbS5KS7uq7/C5OaM8A=",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,f={},x=[];function F(e){const t={p:"p",...(0,l.R)(),...e.components};return(0,p.jsxs)(p.Fragment,{children:[(0,p.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Get Template"}),"\n",(0,p.jsx)(i(),{method:"get",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,p.jsx)(t.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,p.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,p.jsx)(s(),{parameters:[{name:"template_id",in:"path",description:"ID of template that needs to be fetched",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"strng"}}]}),"\n",(0,p.jsx)(c(),{title:"Body",body:void 0}),"\n",(0,p.jsx)(g(),{id:void 0,label:void 0,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"},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:!0},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:!0},redirect_url:{type:"string",format:"string",example:""},allow_modifications:{type:"boolean",example:!1},auto_reminder:{type:"boolean",example:!1},remind_once_in_every:{type:"number",example:0}},xml:{name:"template"},title:"template"}}}},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"}}}}}})]})}function P(e={}){const{wrapper:t}={...(0,l.R)(),...e.components};return t?(0,p.jsx)(t,{...e,children:(0,p.jsx)(F,{...e})}):F(e)}}}]); \ No newline at end of file diff --git a/assets/js/5144c8d4.3387244e.js b/assets/js/5144c8d4.3387244e.js deleted file mode 100644 index 790335b24..000000000 --- a/assets/js/5144c8d4.3387244e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7904],{8437:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>h,contentTitle:()=>I,default:()=>x,frontMatter:()=>g,metadata:()=>s,toc:()=>k});const s=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":"eJy9V81uGzcQfpUJL22MtST/JGl1ilu4rlMjMWobBmobAXd3tMuYSzLkrGRBEJBD36CnXvtoeZJiSK0syUlbI0Uu0u5wZjg/3/zsTJCsghheiYuAXtxkosRQeOVIWSOG4rxGOEICPoWD02NAI3ONAaa2BbJQIfGjBzsxIIvCtoagRJJKh57IhHXoJes6LsVQVEjxmkx4DM6agEEMZ2J3MOC/9ZvP2qLAEEathqUSkYnCGkJDzC+d06qIB/13gYVmIhQ1NpKfaOpQDIXN32FBIhPOsxpS6cpEZqOWnIG8MpXIxMj6RtIqBe9k4zQz/XSkbnf38vrilZhnwsgGH6vhlUX4AZHFsZFKP1b+ncUc8eWC0Ctsw6pcbc2jTdl/9vzFd3u7O7t7rOKdzc8V6UdrKXHM4oVtnDTTx0pbhyaoykQVHiVheUCfUnIvsjvY3dveGWwPXpzvPB/ufz989rw3GAx+E5m4a2I8U15EKSnGmZJby/fWlV/hnvkmW8vQX2FL73Nm3B/sP6yAWHPGEoxsa8on/x/40Xvr/9n3zbvnK3Yro5XBt10Jv2XjOzeePXTj2IylVmXsHuf2Fs3X9WT1ekrXP0yNSkzxXKy5ukpPTgYsWq9oKoZXM3G3LZ3aTufDq5v5TSYapNouuh0bLKkWQ9GvkNrU+wL6MfoQ5VuvxVDURC4M+/0gTZnbu15XFFrmgSu8L53qj3d6O2KebcpI5x7Fj+32Y0UCyUqZ6t/kbu5jc8b5Sylai9AyUdKpX3Aquha6xpUJxbipUZaxQPh9ZKPwIi1vHJozVZmY1Hj55ty6RF3YBnlEUY3QCXz8/a8oU9qibdBQRF3U8OTaXJs3rQdnJ+h56khTwkjjnco1ptHXxLPl7AsoG40h6CkoQ1h5SQilqhRJDRwjZSoopJO50ooRy2w2jcsV0IceXNZINXo++sYjSChxjJqBDrIl20hiVZ3RMLH+dqTtJGQgIW+DMhgCoKmlKZixy0IG1oM0gIbQO68CQiDPVqtkmzXkZUHQSCMrZN3ZWqhK1IqhCt7mbSAIVrfRZOABbz2W0DlkEMvQ4yAe3jk+AqbyUPBYM2TGCFWrSgwZFLZECLFA2QVTQo6BwLEtqsDASlujbXEbkzdqtQZnuV8oqcGO1mxkcfLSBJ4yyZYuB8uAOW95l8Bk4NbWRUDO8Ikyt2G4tXVttuFqialLzIMivPm2g/9kMnkA+6frMkeKfm5z+BWdDYqsn95LV4rqNo+lsqpk+ZI0HaHBiJ+VQrjXUdoiPKw8pvZr1K5/hsQICf2D0+PYYp/Cxw9/wAlKb6C2k4TWovWop1B1V3HkUuZT2JYdEkY2Aq/miBcJfB7ftxioi+BlLenjhz8DvMYJqFRCKZBbW6dtrlUB59g4LQnD1tYQfoyjHaijAdWSoJAGcoRQS4bSWEmQ4JK0Vua2BwdmCtw1YaKojmBgepRbc4Pjskx3gFwGLMGaKNHd2bu3iOlNQD3GwLp4zuUIWCpiRNfetlW6bdWYhXMeR0pruFRlhRR9OyhLcAvyJJE54Cvm4IgLgmqcgvQIAQ314HRDJJ60zlnPVqhk/MhqbSecADSls8pQGELp5Yju9Wf3QI8blLLmE6QUQrkMR7ZQs0xJqsSFx0tq75ob8kYTX++1Hkfo+cKQvgi6vDi1gNNVB0tgtH4JrNOiaUgWcXVYLNA8TV5u6oljHH0T3ozO0I9VgYuJ9pmK7kfmvsiEVgWagCvrwcHR6QmM93oDka2Mxv9Q3P2T4x8PX58dsjHcSFPAdnqD3iBu7TZQI83KTUfd99TGt9TmgJvdb1Bf/I22GMmEd9R3Wqq4AUU3Z4vt5Up028tNJmobiEmzGZfZhdfzOZPft+h5J7rJxFh6xRbEjSjrBjmvO7c45XAWBTrejcZSt2kb2FgB1/aoo8NzkQnuR+sLxG1cIBYPrL07MtMV3eubRTKAf3nN+aTAbJaWk/l8yZ+OPiuxcLDj5gDezOfzvwGAWVmf","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":"Create Contact","permalink":"/docs/API-docs/v1.1/createcontact"}}');var n=o(74848),i=o(28453),a=o(33617),r=o.n(a),l=o(17543),c=o.n(l),p=o(86013),d=o.n(p),u=o(63723),m=o.n(u),b=(o(18766),o(79329),o(9303));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:"eJy9V81uGzcQfpUJL22MtST/JGl1ilu4rlMjMWobBmobAXd3tMuYSzLkrGRBEJBD36CnXvtoeZJiSK0syUlbI0Uu0u5wZjg/3/zsTJCsghheiYuAXtxkosRQeOVIWSOG4rxGOEICPoWD02NAI3ONAaa2BbJQIfGjBzsxIIvCtoagRJJKh57IhHXoJes6LsVQVEjxmkx4DM6agEEMZ2J3MOC/9ZvP2qLAEEathqUSkYnCGkJDzC+d06qIB/13gYVmIhQ1NpKfaOpQDIXN32FBIhPOsxpS6cpEZqOWnIG8MpXIxMj6RtIqBe9k4zQz/XSkbnf38vrilZhnwsgGH6vhlUX4AZHFsZFKP1b+ncUc8eWC0Ctsw6pcbc2jTdl/9vzFd3u7O7t7rOKdzc8V6UdrKXHM4oVtnDTTx0pbhyaoykQVHiVheUCfUnIvsjvY3dveGWwPXpzvPB/ufz989rw3GAx+E5m4a2I8U15EKSnGmZJby/fWlV/hnvkmW8vQX2FL73Nm3B/sP6yAWHPGEoxsa8on/x/40Xvr/9n3zbvnK3Yro5XBt10Jv2XjOzeePXTj2IylVmXsHuf2Fs3X9WT1ekrXP0yNSkzxXKy5ukpPTgYsWq9oKoZXM3G3LZ3aTufDq5v5TSYapNouuh0bLKkWQ9GvkNrU+wL6MfoQ5VuvxVDURC4M+/0gTZnbu15XFFrmgSu8L53qj3d6O2KebcpI5x7Fj+32Y0UCyUqZ6t/kbu5jc8b5Sylai9AyUdKpX3Aquha6xpUJxbipUZaxQPh9ZKPwIi1vHJozVZmY1Hj55ty6RF3YBnlEUY3QCXz8/a8oU9qibdBQRF3U8OTaXJs3rQdnJ+h56khTwkjjnco1ptHXxLPl7AsoG40h6CkoQ1h5SQilqhRJDRwjZSoopJO50ooRy2w2jcsV0IceXNZINXo++sYjSChxjJqBDrIl20hiVZ3RMLH+dqTtJGQgIW+DMhgCoKmlKZixy0IG1oM0gIbQO68CQiDPVqtkmzXkZUHQSCMrZN3ZWqhK1IqhCt7mbSAIVrfRZOABbz2W0DlkEMvQ4yAe3jk+AqbyUPBYM2TGCFWrSgwZFLZECLFA2QVTQo6BwLEtqsDASlujbXEbkzdqtQZnuV8oqcGO1mxkcfLSBJ4yyZYuB8uAOW95l8Bk4NbWRUDO8Ikyt2G4tXVttuFqialLzIMivPm2g/9kMnkA+6frMkeKfm5z+BWdDYqsn95LV4rqNo+lsqpk+ZI0HaHBiJ+VQrjXUdoiPKw8pvZr1K5/hsQICf2D0+PYYp/Cxw9/wAlKb6C2k4TWovWop1B1V3HkUuZT2JYdEkY2Aq/miBcJfB7ftxioi+BlLenjhz8DvMYJqFRCKZBbW6dtrlUB59g4LQnD1tYQfoyjHaijAdWSoJAGcoRQS4bSWEmQ4JK0Vua2BwdmCtw1YaKojmBgepRbc4Pjskx3gFwGLMGaKNHd2bu3iOlNQD3GwLp4zuUIWCpiRNfetlW6bdWYhXMeR0pruFRlhRR9OyhLcAvyJJE54Cvm4IgLgmqcgvQIAQ314HRDJJ60zlnPVqhk/MhqbSecADSls8pQGELp5Yju9Wf3QI8blLLmE6QUQrkMR7ZQs0xJqsSFx0tq75ob8kYTX++1Hkfo+cKQvgi6vDi1gNNVB0tgtH4JrNOiaUgWcXVYLNA8TV5u6oljHH0T3ozO0I9VgYuJ9pmK7kfmvsiEVgWagCvrwcHR6QmM93oDka2Mxv9Q3P2T4x8PX58dsjHcSFPAdnqD3iBu7TZQI83KTUfd99TGt9TmgJvdb1Bf/I22GMmEd9R3Wqq4AUU3Z4vt5Up028tNJmobiEmzGZfZhdfzOZPft+h5J7rJxFh6xRbEjSjrBjmvO7c45XAWBTrejcZSt2kb2FgB1/aoo8NzkQnuR+sLxG1cIBYPrL07MtMV3eubRTKAf3nN+aTAbJaWk/l8yZ+OPiuxcLDj5gDezOfzvwGAWVmf",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,h={},k=[];function v(e){const t={p:"p",...(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 account details"}),"\n",(0,n.jsx)(r(),{method:"get",path:"/getuser",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"The Get User API enables you to get your own account details."}),"\n",(0,n.jsx)(c(),{parameters:void 0}),"\n",(0,n.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,n.jsx)(m(),{id:void 0,label:void 0,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"}}}}}})]})}function x(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/5144c8d4.d7ccdb73.js b/assets/js/5144c8d4.d7ccdb73.js new file mode 100644 index 000000000..f439dee5c --- /dev/null +++ b/assets/js/5144c8d4.d7ccdb73.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7904],{8437:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>S,contentTitle:()=>x,default:()=>A,frontMatter:()=>g,metadata:()=>s,toc:()=>v});const s=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":"Create Contact","permalink":"/docs/API-docs/v1.1/createcontact"}}');var a=n(74848),i=n(28453),o=n(33617),r=n.n(o),p=n(17543),c=n.n(p),d=n(86013),l=n.n(d),m=n(63723),b=n.n(m),u=(n(18766),n(79329),n(9303));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 C(e){const t={p:"p",...(0,i.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Get your account details"}),"\n",(0,a.jsx)(r(),{method:"get",path:"/getuser",context:"endpoint"}),"\n",(0,a.jsx)(t.p,{children:"The Get User API enables you to get your own account details."}),"\n",(0,a.jsx)(c(),{parameters:void 0}),"\n",(0,a.jsx)(l(),{title:"Body",body:void 0}),"\n",(0,a.jsx)(b(),{id:void 0,label:void 0,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"}}}}}})]})}function A(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(C,{...e})}):C(e)}}}]); \ No newline at end of file diff --git a/assets/js/58abd73c.7661f930.js b/assets/js/58abd73c.7661f930.js new file mode 100644 index 000000000..431bdaa7a --- /dev/null +++ b/assets/js/58abd73c.7661f930.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8564],{73135:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>I,contentTitle:()=>w,default:()=>b,frontMatter:()=>u,metadata:()=>i,toc:()=>j});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":"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 s=r(74848),o=r(28453),l=r(33617),n=r.n(l),d=r(17543),a=r.n(d),p=r(86013),m=r.n(p),c=r(63723),f=r.n(c),h=(r(18766),r(79329),r(9303));const u={id:"folderlist",title:"Get folder list",description:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId",sidebar_label:"Get folder list",hide_title:!0,hide_table_of_contents:!0,api:"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},w=void 0,I={},j=[];function x(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 folder list"}),"\n",(0,s.jsx)(n(),{method:"get",path:"/folderlist",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId"}),"\n",(0,s.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(a(),{parameters:[{name:"parentFolderId",in:"query",description:"objectId of folder",required:!1,style:"form",explode:!1,schema:{type:"string",format:"string",example:""}},{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10},{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}]}),"\n",(0,s.jsx)(m(),{title:"Body",body:void 0}),"\n",(0,s.jsx)(f(),{id:void 0,label:void 0,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"}}}}}})]})}function b(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(x,{...e})}):x(e)}}}]); \ No newline at end of file diff --git a/assets/js/58abd73c.fdfdf0e6.js b/assets/js/58abd73c.fdfdf0e6.js deleted file mode 100644 index 26f11ba89..000000000 --- a/assets/js/58abd73c.fdfdf0e6.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8564],{73135:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>x,contentTitle:()=>u,default:()=>Q,frontMatter:()=>g,metadata:()=>r,toc:()=>I});const r=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":"eJy9WM1uHDcSfpUyL5sIrZmRbCfYOa0QOIp2BVuIFAhYWTDY3TXd9LBJhqyeHwwGyGHfYE+55tH8JEGR0zM90ji28neR1MWq4ldVH1lFrQTJKojxnfjW6hK9uM9EiaHwypGyRozFTY2Q1uBSBYKzqwvAxtk5+gBL2wJZ8Ehe4QxBgmYdO4FJMpkrqsGm37YlcNKjoeTvohSZsA695K0uSjEWyYp9iEw46WWDhJ7xrYSRDYqxeORBMcofW/RL8RC7zd9jQRflDpDIhMcfW+WxFOOJ1AEzEWipMW7uG5EJXDhtS9wtFzU2UoxXgpaO9QJ5ZSqRRQNJfQkuZOOiM7FeZ1vMWjWKHkL9bBzk2z0YjVyopm3E+OVolHWgTNvk6MW6h+Fk1IMQpsr9aQg+vudofc9+g7MmYGDd09GIf+0XJrRFgSFMWg1bAohMFNYQGmJ96ZxWRVwYvg9stHoMINWXqeLZDam0pcfQaurpSe8lB6wIm/Bp+442T625q0/yenH63nFKEt9ex+w/zY3BecfWdfaQ70/09e9TI8PLqbrCh75+L7LQ5j10hUdJWJ7RIVc7w9PR6fPjk9Hx6Oubk6/GL/45fvnVYDQa/VdkYtFott3QtJQUkZIi3f9uXfk37NMTpBDfeQxi3Zcro5XBdx3F352ORu9OnrPOOhMvDnH92jZItTIVzNEQzL01VQZOowwI5JcgK6kMaEnon/15hwC9t/63s/U0ZL+VhRechW0SXj5OwoWZSa3K2D1u7BTN3xtpf3tK2zPUfU6opBTXxV6wfXkKMmDRekXL2JkWx9Kp47Q+vrvnK5ATa7mjVZhaGdViLIZ7/S2gn3XNrfVajEVN5MJ4OAzSlLldDKxDE1RltMzDoLDNUDo1nJ0MTgTf7Ps20rkn6WN7/FSTQLJSpvqU3f0uPddcwlSlvSTtbman/oN8NW9q0NfadKsaZbxs1vw9sdF4U5k3Ds21qkysa9z84QRwi7qwDfKQQjVCZ/Dhf79Em9IWbYOGIvGih2dvzVvzpvUQJxxuUNKUMNG4ULnGg9NPQNloDEEvQRnCyktCKFWlSGrgHPEJK6STudKKSctqlq099HgfBnBbI9XoeekfnqepEmeomesgW7KNJHbVgYa59dOJtvOQgYS8DcpgCICmlqZgxa4KGU9g0gAaQu+8CgiBPKNWCZs15GVB0EgjK2Tf2V6qStSKqQre5m0gCFa3ETKQVNp6LKELyCCWYcBJfMXTg0dgaWEb57FmyswQqlaVGDIobIkQ4hnlEEwJOQYCx1hUgYGdtkbbYhqLN2m1Bmf5ylBS80zXx8jm5KUJ3MASlq4G24Q5b3nswATw6OiHgFzhS2WmYXx09NYcw92WU7eYB0V4/0VH//l8/oj2X+7bnCv6rs3he3Q2KLJ+ubOuFNVtHo9K38n2I3k6R4ORP72DsPNR2iI8PnksHdao3fAaiRkShmdXF/GW/RI+/PR/uETpDdR2nthatB71EqpuK85cqnxK2/aShImNxKs540UiH8+MGKjL4G0t6cNPPwd4jXNQ6QilRB4dXbW5VgXcYOO4hYSjozF8E+cFoE4GVEuCQhrIEUItmUozJUGCS9ZamekAzswS2tC9J5gMLI92e2FwXrblDpDLgCVYEy26PQc7RCxvAuoZBvZlLDEMLBUxo2tv2yrt1gezCc7jRGkNt6qskGJsZ2UJbiOeJzEnvAcHJ3wgqMYlSI8Q0NAArh6YxJXWOesZhUrgJ1ZrO+cCoCmdVYbCGEovJ7Tzn+2IHscyZc0BUUqh3KYj27jZliSdxE3EW+ngLV/IDy7x/bvW4wQ9bxjD3tXFqQ2d7jpaArP1j9A6jp7WkCzi9ICNVDp1k3899BM7OfomvJlco5+pAjcd7SMnehiVhyITWhVoAvYmhLPzq0uYPR+MRNZrjZ9xuIeXF9+8en39isHwRZoSdjIYDUZxLreBGml6O50jdU/ozbSwl+vVbnb6qx/om0ZNuKCh01LF0SgGv9qMNXf9Z/t9JmobiKWrFZ+/H7xer1mcXp087JQqyFz33p0fje3gA/4goikuD/1zYCZ1m57j2YF9k1H3Ov8c3c0zeqd6zx9esW6c/bJuXuFAk81ZUaDrb/Bo2N2bGM9f3YhM8LW7PydN45y0+YO9d0tm2fO9P0AlAPyTYzposFqlGWy93uqnpY9abALstDn/9+v1+lfM3mA7","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=o(74848),s=o(28453),n=o(33617),l=o.n(n),d=o(17543),a=o.n(d),p=o(86013),c=o.n(p),m=o(63723),f=o.n(m),h=(o(18766),o(79329),o(9303));const g={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:"eJy9WM1uHDcSfpUyL5sIrZmRbCfYOa0QOIp2BVuIFAhYWTDY3TXd9LBJhqyeHwwGyGHfYE+55tH8JEGR0zM90ji28neR1MWq4ldVH1lFrQTJKojxnfjW6hK9uM9EiaHwypGyRozFTY2Q1uBSBYKzqwvAxtk5+gBL2wJZ8Ehe4QxBgmYdO4FJMpkrqsGm37YlcNKjoeTvohSZsA695K0uSjEWyYp9iEw46WWDhJ7xrYSRDYqxeORBMcofW/RL8RC7zd9jQRflDpDIhMcfW+WxFOOJ1AEzEWipMW7uG5EJXDhtS9wtFzU2UoxXgpaO9QJ5ZSqRRQNJfQkuZOOiM7FeZ1vMWjWKHkL9bBzk2z0YjVyopm3E+OVolHWgTNvk6MW6h+Fk1IMQpsr9aQg+vudofc9+g7MmYGDd09GIf+0XJrRFgSFMWg1bAohMFNYQGmJ96ZxWRVwYvg9stHoMINWXqeLZDam0pcfQaurpSe8lB6wIm/Bp+442T625q0/yenH63nFKEt9ex+w/zY3BecfWdfaQ70/09e9TI8PLqbrCh75+L7LQ5j10hUdJWJ7RIVc7w9PR6fPjk9Hx6Oubk6/GL/45fvnVYDQa/VdkYtFott3QtJQUkZIi3f9uXfk37NMTpBDfeQxi3Zcro5XBdx3F352ORu9OnrPOOhMvDnH92jZItTIVzNEQzL01VQZOowwI5JcgK6kMaEnon/15hwC9t/63s/U0ZL+VhRechW0SXj5OwoWZSa3K2D1u7BTN3xtpf3tK2zPUfU6opBTXxV6wfXkKMmDRekXL2JkWx9Kp47Q+vrvnK5ATa7mjVZhaGdViLIZ7/S2gn3XNrfVajEVN5MJ4OAzSlLldDKxDE1RltMzDoLDNUDo1nJ0MTgTf7Ps20rkn6WN7/FSTQLJSpvqU3f0uPddcwlSlvSTtbman/oN8NW9q0NfadKsaZbxs1vw9sdF4U5k3Ds21qkysa9z84QRwi7qwDfKQQjVCZ/Dhf79Em9IWbYOGIvGih2dvzVvzpvUQJxxuUNKUMNG4ULnGg9NPQNloDEEvQRnCyktCKFWlSGrgHPEJK6STudKKSctqlq099HgfBnBbI9XoeekfnqepEmeomesgW7KNJHbVgYa59dOJtvOQgYS8DcpgCICmlqZgxa4KGU9g0gAaQu+8CgiBPKNWCZs15GVB0EgjK2Tf2V6qStSKqQre5m0gCFa3ETKQVNp6LKELyCCWYcBJfMXTg0dgaWEb57FmyswQqlaVGDIobIkQ4hnlEEwJOQYCx1hUgYGdtkbbYhqLN2m1Bmf5ylBS80zXx8jm5KUJ3MASlq4G24Q5b3nswATw6OiHgFzhS2WmYXx09NYcw92WU7eYB0V4/0VH//l8/oj2X+7bnCv6rs3he3Q2KLJ+ubOuFNVtHo9K38n2I3k6R4ORP72DsPNR2iI8PnksHdao3fAaiRkShmdXF/GW/RI+/PR/uETpDdR2nthatB71EqpuK85cqnxK2/aShImNxKs540UiH8+MGKjL4G0t6cNPPwd4jXNQ6QilRB4dXbW5VgXcYOO4hYSjozF8E+cFoE4GVEuCQhrIEUItmUozJUGCS9ZamekAzswS2tC9J5gMLI92e2FwXrblDpDLgCVYEy26PQc7RCxvAuoZBvZlLDEMLBUxo2tv2yrt1gezCc7jRGkNt6qskGJsZ2UJbiOeJzEnvAcHJ3wgqMYlSI8Q0NAArh6YxJXWOesZhUrgJ1ZrO+cCoCmdVYbCGEovJ7Tzn+2IHscyZc0BUUqh3KYj27jZliSdxE3EW+ngLV/IDy7x/bvW4wQ9bxjD3tXFqQ2d7jpaArP1j9A6jp7WkCzi9ICNVDp1k3899BM7OfomvJlco5+pAjcd7SMnehiVhyITWhVoAvYmhLPzq0uYPR+MRNZrjZ9xuIeXF9+8en39isHwRZoSdjIYDUZxLreBGml6O50jdU/ozbSwl+vVbnb6qx/om0ZNuKCh01LF0SgGv9qMNXf9Z/t9JmobiKWrFZ+/H7xer1mcXp087JQqyFz33p0fje3gA/4goikuD/1zYCZ1m57j2YF9k1H3Ov8c3c0zeqd6zx9esW6c/bJuXuFAk81ZUaDrb/Bo2N2bGM9f3YhM8LW7PydN45y0+YO9d0tm2fO9P0AlAPyTYzposFqlGWy93uqnpY9abALstDn/9+v1+lfM3mA7",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,x={},I=[];function v(e){const t={p:"p",...(0,s.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)(l(),{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:"Request"}),"\n",(0,i.jsx)(a(),{parameters:[{name:"parentFolderId",in:"query",description:"objectId of folder",required:!1,style:"form",explode:!1,schema:{type:"string",format:"string",example:""}},{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10},{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}]}),"\n",(0,i.jsx)(c(),{title:"Body",body:void 0}),"\n",(0,i.jsx)(f(),{id:void 0,label:void 0,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"}}}}}})]})}function Q(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/5a144266.686c24b3.js b/assets/js/5a144266.686c24b3.js deleted file mode 100644 index 0b9c0488a..000000000 --- a/assets/js/5a144266.686c24b3.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4232],{38483:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>h,contentTitle:()=>f,default:()=>g,frontMatter:()=>b,metadata:()=>a,toc:()=>v});const a=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":"eJzdWM1u5DYSfpUKL7sx5G7Z4/Fk+xQjGDjGGhkjdmBgPUaDkqpbHFMkQ1L9g4aAHPYN9rTXfbR5kkWRUkvtf2+CHPZit8j66o9F8itumOdzxyY37AorI7lHx24TVqDLrTBeaMUm7KpEOEUPnQicC+fh5OIMuJR66WCta/AaLHorcIHAQZKEngFfcCF5JhF8p38EV6VwMKtVTvq5FH4NxuqFKNABV6AXaBcClwEvZY9MABXPpFBzqB1aRzbzUmuHMLO6AlwJ52l2i4BliQpyizyMFzqvK1TejVjCtEHLyYOzgk3YHH2HIt9Zwgy3vEKPltKzYYpXyCZMikrQrKDE/FqjXbOEWfy1FhYLNplx6TBhzq8lSc+0rVjCcGWkLpBNvK1pNi+x4myyYRVfiaqu2OR9mibMrw2BVF1laFlDOF4ZUnSQNsnWBXcnzB/mwdM20+aW9DqjlUNHsodpSv92i8PVeY7OzWoJ24yyhOVaeVSe5LkxUuRhYvzFEWjz0AGdfcE8pN2SGi+iSYuuln4gx63lFLDwWLmX8XGYVngr6bwVas6SkBruhyPb2Nnq4MdMVe7wYk458cLT6EMVPcCFH9vKI5TS/gVQJw1BtCGXZIH2zwor1tNzDkZ/IAg2fSK2jk9bh8l18VKKSu+Nm4zHHZj28CjXFaH1Uu3E/VyywnbWnVcJc2Kuwi79X4vE6pdcz1G/LmFfNEKGwS2suJAvSmeI37cDXS5MqdULZo7eHx8evPvuwwHJL0UxR/874o+zb6skjyuf6VXwl8/x4VEygG9H+vOsSdjqjZjDo6MmYes3oj6QqeUbQe++axJWvhF0dEx1HI7FV+T8qVJ6Vc6bR/fiZdwH064enpUK29mhKs7UJ7t75mRaS+RqaJpujSZhYedhceKfr87D9PDd/kG6n364OjieHP1t8v54lKbpP1jCVpXso2dFe1J2TnbftSn+FDuBTuCVrl8XvsVCWMz9tLaPbuzn1o7MBbY0rXQhZu196J63G+5yAtZeTy1WQr24Uh0kSk+1ynEq1BQXxBMeKejBdd/cT9vwMrtfR7vVJZQUCqcdW5gepun0uK3To/T9Q9ZwphZciiKQyCt9h+qbP44zoLX6hbtkaN5H8w/DF1EozLOdYIfjMUiHeW2FXwequNrnRuzH+cnNLfGoCn2pW54ZuKUv2YSN71FOh3bR8c1QY9s703FVZHo10gYV3XeSZ47uizE3Yrw4GNFFcB/DjXmTPNb7b4U4z+dCzV/C3fYJuqRFjOu0k6b+7jLi70iXV7sKQ6mW9JbIA+lo6HumA7hdm08GFZ1wYWWD8fvNzDXKXFdIvYMvETrA13/+J2C6FiGUXtDwzWf1WX2qLRi9REs8l6sCZhJXgvoaAmEV5raNkENeSXROrkEoj3NLtKUQc+G5BMoRNSM5NzwTUlDZkpgmtIVB5bsRXJfoS7Q09RdLjVWBC5RU7UCHQrXb18BS27sZtWQJcMhqJxQ6B6hKrnIS7FYhAW2p1ULl0RorHILzlrwW0TetvOW5h4orPkfSneykqkApqFTB6qx2HpyWdXAZPBdSWyygC0ghFm5ESfxITYhFoNFcV8ZiSSWzQJjX1PwlkOsCIVJpCkEVkKHzYMgXkWPo+GoldX4XFm9WSwlG06EhuKR+cegjwb3lytG5HH3p1mCbMGM1dS8YHdzb+8UhrfC5UHdusrf3We3DzbamrjFzwuPtX7vyXy6XD8r+213MqfA/1hn8jEY74bVd9+i58GWdha0yVLL9iJpOUWGon8FG6HUUOncPdx6NjkuUZnyJnirEjU8uzsI5+y18/e1fcI7cKij1MlZrXluUa5h3pihzceVj2rbHJMx0KLySMp7H4qPWE53vMnhdcv/1t387+AmXIOIWionc27uoMyny7TuC29ubwA+BUwxadl9yDzlXkCG4klMpLQQHDiaipVB3IzhR6/AIAEvhy1AMNB5wO2FQXvq+HzLusACtAqKzOeo9ovHKoVygI11Ke3IDC+Gpokur63m0NnSmDc7iTEgJ15F+UWwnRQGmHW5ZGSV84A7OaEP4EtfALYJD5UdwcQ8SZmpjtCUvRHR+polN0AKgKowWyrsJFJbPfK8/6Qs9voFo9chQTCHfpiNp1QzeXSiTbcT9O85nOpDvHeK7Z63FGVoyGMLu18WItpxuurIEqtbfU9Z0QdOpxfPAH9rmi26T7+/rCXc52sp9ml3SS1PeNadP7OhxEB6zhEmRo3I44AgnpxfnsHg3SlkyuBpfsbnH52c/fPzp8iM5QwdpTNjBKB2loafSzldcDSztPMC1fGEn25ueP/2fvti1DIHaoLGRXARW1nLxyKhu2A6juk1YqZ2n8c2Gtv4vVjYNDcd3M+JZhXAUbf9ydofrwTvfgsu65e9PyrYPcr3oLX1YQbKBACYdZSGDEXOS52iGBh4w3h3aePrxioU+oNylSneBKrU/SHs3pdYD3bscKjpAfymmRwGbTaRhTbOVj1NPItoAO2lam9umaf4LgbbLVQ==","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 o=i(74848),l=i(28453),n=i(33617),p=i.n(n),s=i(17543),r=i.n(s),m=i(86013),d=i.n(m),c=i(63723),u=i.n(c),y=(i(18766),i(79329),i(9303));const b={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:"eJzdWM1u5DYSfpUKL7sx5G7Z4/Fk+xQjGDjGGhkjdmBgPUaDkqpbHFMkQ1L9g4aAHPYN9rTXfbR5kkWRUkvtf2+CHPZit8j66o9F8itumOdzxyY37AorI7lHx24TVqDLrTBeaMUm7KpEOEUPnQicC+fh5OIMuJR66WCta/AaLHorcIHAQZKEngFfcCF5JhF8p38EV6VwMKtVTvq5FH4NxuqFKNABV6AXaBcClwEvZY9MABXPpFBzqB1aRzbzUmuHMLO6AlwJ52l2i4BliQpyizyMFzqvK1TejVjCtEHLyYOzgk3YHH2HIt9Zwgy3vEKPltKzYYpXyCZMikrQrKDE/FqjXbOEWfy1FhYLNplx6TBhzq8lSc+0rVjCcGWkLpBNvK1pNi+x4myyYRVfiaqu2OR9mibMrw2BVF1laFlDOF4ZUnSQNsnWBXcnzB/mwdM20+aW9DqjlUNHsodpSv92i8PVeY7OzWoJ24yyhOVaeVSe5LkxUuRhYvzFEWjz0AGdfcE8pN2SGi+iSYuuln4gx63lFLDwWLmX8XGYVngr6bwVas6SkBruhyPb2Nnq4MdMVe7wYk458cLT6EMVPcCFH9vKI5TS/gVQJw1BtCGXZIH2zwor1tNzDkZ/IAg2fSK2jk9bh8l18VKKSu+Nm4zHHZj28CjXFaH1Uu3E/VyywnbWnVcJc2Kuwi79X4vE6pdcz1G/LmFfNEKGwS2suJAvSmeI37cDXS5MqdULZo7eHx8evPvuwwHJL0UxR/874o+zb6skjyuf6VXwl8/x4VEygG9H+vOsSdjqjZjDo6MmYes3oj6QqeUbQe++axJWvhF0dEx1HI7FV+T8qVJ6Vc6bR/fiZdwH064enpUK29mhKs7UJ7t75mRaS+RqaJpujSZhYedhceKfr87D9PDd/kG6n364OjieHP1t8v54lKbpP1jCVpXso2dFe1J2TnbftSn+FDuBTuCVrl8XvsVCWMz9tLaPbuzn1o7MBbY0rXQhZu196J63G+5yAtZeTy1WQr24Uh0kSk+1ynEq1BQXxBMeKejBdd/cT9vwMrtfR7vVJZQUCqcdW5gepun0uK3To/T9Q9ZwphZciiKQyCt9h+qbP44zoLX6hbtkaN5H8w/DF1EozLOdYIfjMUiHeW2FXwequNrnRuzH+cnNLfGoCn2pW54ZuKUv2YSN71FOh3bR8c1QY9s703FVZHo10gYV3XeSZ47uizE3Yrw4GNFFcB/DjXmTPNb7b4U4z+dCzV/C3fYJuqRFjOu0k6b+7jLi70iXV7sKQ6mW9JbIA+lo6HumA7hdm08GFZ1wYWWD8fvNzDXKXFdIvYMvETrA13/+J2C6FiGUXtDwzWf1WX2qLRi9REs8l6sCZhJXgvoaAmEV5raNkENeSXROrkEoj3NLtKUQc+G5BMoRNSM5NzwTUlDZkpgmtIVB5bsRXJfoS7Q09RdLjVWBC5RU7UCHQrXb18BS27sZtWQJcMhqJxQ6B6hKrnIS7FYhAW2p1ULl0RorHILzlrwW0TetvOW5h4orPkfSneykqkApqFTB6qx2HpyWdXAZPBdSWyygC0ghFm5ESfxITYhFoNFcV8ZiSSWzQJjX1PwlkOsCIVJpCkEVkKHzYMgXkWPo+GoldX4XFm9WSwlG06EhuKR+cegjwb3lytG5HH3p1mCbMGM1dS8YHdzb+8UhrfC5UHdusrf3We3DzbamrjFzwuPtX7vyXy6XD8r+213MqfA/1hn8jEY74bVd9+i58GWdha0yVLL9iJpOUWGon8FG6HUUOncPdx6NjkuUZnyJnirEjU8uzsI5+y18/e1fcI7cKij1MlZrXluUa5h3pihzceVj2rbHJMx0KLySMp7H4qPWE53vMnhdcv/1t387+AmXIOIWionc27uoMyny7TuC29ubwA+BUwxadl9yDzlXkCG4klMpLQQHDiaipVB3IzhR6/AIAEvhy1AMNB5wO2FQXvq+HzLusACtAqKzOeo9ovHKoVygI11Ke3IDC+Gpokur63m0NnSmDc7iTEgJ15F+UWwnRQGmHW5ZGSV84A7OaEP4EtfALYJD5UdwcQ8SZmpjtCUvRHR+polN0AKgKowWyrsJFJbPfK8/6Qs9voFo9chQTCHfpiNp1QzeXSiTbcT9O85nOpDvHeK7Z63FGVoyGMLu18WItpxuurIEqtbfU9Z0QdOpxfPAH9rmi26T7+/rCXc52sp9ml3SS1PeNadP7OhxEB6zhEmRo3I44AgnpxfnsHg3SlkyuBpfsbnH52c/fPzp8iM5QwdpTNjBKB2loafSzldcDSztPMC1fGEn25ueP/2fvti1DIHaoLGRXARW1nLxyKhu2A6juk1YqZ2n8c2Gtv4vVjYNDcd3M+JZhXAUbf9ydofrwTvfgsu65e9PyrYPcr3oLX1YQbKBACYdZSGDEXOS52iGBh4w3h3aePrxioU+oNylSneBKrU/SHs3pdYD3bscKjpAfymmRwGbTaRhTbOVj1NPItoAO2lam9umaf4LgbbLVQ==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},f=void 0,h={},v=[];function x(e){const t={p:"p",...(0,l.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(y.default,{as:"h1",className:"openapi__heading",children:"Get Template list"}),"\n",(0,o.jsx)(p(),{method:"get",path:"/templatelist",context:"endpoint"}),"\n",(0,o.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,o.jsx)(y.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,o.jsx)(r(),{parameters:[{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10},{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}]}),"\n",(0,o.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,o.jsx)(u(),{id:void 0,label:void 0,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:!0},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:!0},redirect_url:{type:"string",format:"string",example:""},allow_modifications:{type:"boolean",example:!1},auto_reminder:{type:"boolean",example:!1},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"}}}}}})]})}function g(e={}){const{wrapper:t}={...(0,l.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(x,{...e})}):x(e)}}}]); \ No newline at end of file diff --git a/assets/js/5a144266.804e9e11.js b/assets/js/5a144266.804e9e11.js new file mode 100644 index 000000000..a84341170 --- /dev/null +++ b/assets/js/5a144266.804e9e11.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4232],{38483:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>w,contentTitle:()=>f,default:()=>y,frontMatter:()=>h,metadata:()=>i,toc:()=>x});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),o=a(28453),s=a(33617),n=a.n(s),p=a(17543),m=a.n(p),r=a(86013),d=a.n(r),c=a(63723),g=a.n(c),u=(a(18766),a(79329),a(9303));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:"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},f=void 0,w={},x=[];function b(e){const t={p:"p",...(0,o.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)(n(),{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:"Request"}),"\n",(0,l.jsx)(m(),{parameters:[{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10},{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}]}),"\n",(0,l.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,l.jsx)(g(),{id:void 0,label:void 0,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:!0},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:!0},redirect_url:{type:"string",format:"string",example:""},allow_modifications:{type:"boolean",example:!1},auto_reminder:{type:"boolean",example:!1},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"}}}}}})]})}function y(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,l.jsx)(t,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/5ce6d213.4901096f.js b/assets/js/5ce6d213.4901096f.js deleted file mode 100644 index 2a3fe32a3..000000000 --- a/assets/js/5ce6d213.4901096f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3460],{78912:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>g,contentTitle:()=>y,default:()=>w,frontMatter:()=>h,metadata:()=>n,toc:()=>b});const n=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":"eJzFWF9vG7kR/ypzfGlirCUl5+RQPdXNpYlxQSLENoLWMQTu7qyWZy7JI7mSBWGBe+g36FNf+9HySYohd1erP3GS3rV9MWTucDjzmyHnN7Nhni8cm96wK6yM5B4du01Yji6zwnihFZuyqxLh2uTcI3RScD67AFQ8lehgrWvwGiqdi2INXOVQR2lfIuTouZAOdAEcnMFMFCID3+oZsYRpg5bTURc5m7K4tTuHJcxwyyv0aMnMDVO8QjZlnYK5yFnCBJlpuC/Zvu0XP9LJZEi3A3zJPSjE3JHVKbbWkh6Lv9TCYs6m3taYMOfXkk5zojKSjMF7I3WObFpw6UggK7HibLphfm2CpLdCLVjCCm0r7rcrTXMb9aPzf9b5mvbsmjqzeilyhBSlXkHvNhnZ4dnFCB5xDxK586AVDmQ7Bx6zhGVaeVSeDuLGSJEFkMc/Ozptc2i6Tn/GzBPilkLiBTr6GgH/soMEDg8wTZkLP3p7WZMwpf03q5mRiwgWlwJXIbGcWCjwpXCQ66yuyL1mL+TfdkSfFUMdDe2ROVrKyEN9290kGW/Bu6vZQDTVWiJXB9lIWQWn0QEdFmElpGxvEry7msESLd2QEKsRXDu0LspYzFAsEfiOCGQ6R1gKDlhxIRNYlSIrKeHXUNXOA6o2h1rosEduBCGJ4RQODcqFO2pRAlxKvRJqAXUw7ZhiyIXFzMs1rIQvde2B57mg7VyC82jcaIhisKIH8krX9rcjyWFRixxz8Lq2UGgbrETrEjDhmpEHQjlv64w2O8hrim7wg0Tpt7E6Q+e2OHWokNBAfwKoXNzOoeDOo02gVoKQt7XxmPcq8d6gFagyPApBAHceHtIWcPf1WMzQVsK7zlMKDc9zQIkUFAeuzkrg8Tv3tUWXgFDCCy5dAs7zyrgEtAWP9/SugNeGHk+8F86T8SuRL9A7EJ/Lo/dIdyQb2FBYXYXoEzZqPUyE3i6v99RdUVCFa8tHwWvpYcllfRyzQsijD8suRn/VNVR83UY/hjDlDp+fASq6QznMfvwLkDIyyKKRPItivf9a4fA1idsP3gOLMf3ntZVftusyVkSM3l6/fwOrEi32eYg25nVKz2BUjFRfw82nU32Xtf3t20/fAwt57fXcYiVUjl9z1y7RhyBRmnndX7Ha64p7kUGnyo2gFY0J4fXwxlTwqAtmiiVfCm0fHw1oVDfXKsO5UHNcol0PrFR1laI9MPJtWKZ8zfnaQYp+haiGtnVppZVcQ1sRybZViQp2MCEpt3V6x8pnTZMwL/xO9ZgP6Mg8pereNE1wxRmtXCykTyeTw6LfE6qWhNAtpagVtZTr736/Kh6Xv1TPuMufvnazs9eG8qQ16dw/vOnp5On3p08mp5Mfrp48n579cfrs+WgymfyNJey+klsKwfKWCnToxf8HC0JJoXDeoTZ/OpnMv2+hPDuGXksQuku95FLkUAiUOdCZ7ncEEK3V9j8kMA/Y95D75HLn/NkDqaO0h0LXKv9/u3vMoocdPJv/0Lv47NDFCxUho27jSt+h+l94uPVneLyPx5Opu1ktolD4znacHa5HJx1mtRV+HTqZ+1NuxGn8Pr25pf6gQl9q6oJMHQymjmbKxt3rMt4M3pmGkT677BqjUG5Y6b1x0/HYcZWn+n6kDSoqCJKnbpTpasyNGC+fjJ6wJtnfw435JnmsT791i/N8IdTiS/tut1BdUjhjxHYA6+PGjfgJ1yzp4jGUajvDEjlVOooAZcn7bRf2sot1H8791qXrXL6uGTmgZsfai2F3wdhOB9G2lUMq3C4dpYbtt0iBGNsnH7SyV+zbHcdr7LOGACt0QLdN43cG1SU5SpcgRGffxw8oM11hx+O6DZ/+/q+wp8Mmtiuk4buP6qN6V1sweoW2qGVAs5B4L6geh9FCFb71swWHvJLonFwD0eqFDZiKhfDUUrSEJ+OGp0IKuuEkpmm3hcEj4UbwoURfoqVPf7DUKOS4REkPQ89o1GJLplba3hVSr1wCHNLaCYXOAaqSq4wEuzQNxJmr2G4ZKxyC85asFtE2rbzlmYeKK74IzDfZgSpHKegug9Up9W1Oyzp2JjQ/0Tb0GtGhMLsYEYgvaRxhEWiV6KDFku7Usm1PXBLbw5jT5ILKIUXnwZAtIsPAvmsldXYXgke0A4ym91VwSWxqaCNt95YrR0Ug2tLFoAesZZ0YDTw5uXZIEX4j1J2bnpx8VKdw0+fUB0yd8Hj7qHsfVqvVwbvweHfPK+Ff1ym8R6Od8Nqut7sXwpd1Gt6SoZL+n6jpFSoM+TN4KbY6cp25w6eJVsclSjO+RE8Z4sbns4tQkh7Dp1//AW+QWwWlXsVszWqLcg2L7ihCLkY+wtZXlNCb8tqXhHgWk6+dEnUIfii5//TrPx28xRX1XnSFIpAnJ7M6lSLrx3Lu5GQKLyzuDovCwCvjipoIV3JKJRoYcDBxtxTqbgTnah16+tC0h2Sg9bBvx43w6nXhdqGJykO3OJixjbYWBervUC7RkS5iBikC5oLIri+trhfxtKExrXMWC+p9PsS+k3w7z3Mw7XLXjlKbsTUHCx3bpzVwi+BCRznb2xK+1MZoS1a0/Wyhu9EGqtxoobybQm554bf6k22iZwRzGIkcLEUIeQ9H0qrpQxJvYutxvzr6SLVhr8rtvrUWC7R0YHB7Gxcj2nS66dISKFt/S1oTl6FXi2eBaoXxUiy3f9rXE2gP2sq9Ky7RLkWGbcn/zI0eB+ExS5gUGSo3rL/nr2ZvYPn9aMKSAXf4iss9fnPx4uXby5dkDD2kEbAno8loQktGO19xNThpb6S9X9c2W6L5356At0yG5i5jI7kIPLIdH0QOeMMGhGQ6HH7fJqzUzpPIZkOX8drKpqHlX+pQ1G9uE7bkVpClgSi2PXnek4HPuv3ofTdOhm+box91qONrishamOdEhnKH672BfnPbJB1pI4ujxIto1+kV6dlqOOgBiHXGHedZhsY/KDsk3bPrK5awtB3OV2HOzyxfEa/iq2hsnDUGOhrWNkxytaj5gmSjyiaOWMpdjnoXOGr7g5w6CscueY1e0F/y6eiGzSby36bp5eOnz+5oce2kKTa3TdP8G7SzMIs=","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 s=i(74848),p=i(28453),a=i(33617),o=i.n(a),r=i(17543),l=i.n(r),d=i(86013),m=i.n(d),c=i(63723),u=i.n(c),f=(i(18766),i(79329),i(9303));const h={id:"update-template",title:"Update Template",description:"The Update Template API enables you to modify and update the details of a specific template.",sidebar_label:"Update Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzFWF9vG7kR/ypzfGlirCUl5+RQPdXNpYlxQSLENoLWMQTu7qyWZy7JI7mSBWGBe+g36FNf+9HySYohd1erP3GS3rV9MWTucDjzmyHnN7Nhni8cm96wK6yM5B4du01Yji6zwnihFZuyqxLh2uTcI3RScD67AFQ8lehgrWvwGiqdi2INXOVQR2lfIuTouZAOdAEcnMFMFCID3+oZsYRpg5bTURc5m7K4tTuHJcxwyyv0aMnMDVO8QjZlnYK5yFnCBJlpuC/Zvu0XP9LJZEi3A3zJPSjE3JHVKbbWkh6Lv9TCYs6m3taYMOfXkk5zojKSjMF7I3WObFpw6UggK7HibLphfm2CpLdCLVjCCm0r7rcrTXMb9aPzf9b5mvbsmjqzeilyhBSlXkHvNhnZ4dnFCB5xDxK586AVDmQ7Bx6zhGVaeVSeDuLGSJEFkMc/Ozptc2i6Tn/GzBPilkLiBTr6GgH/soMEDg8wTZkLP3p7WZMwpf03q5mRiwgWlwJXIbGcWCjwpXCQ66yuyL1mL+TfdkSfFUMdDe2ROVrKyEN9290kGW/Bu6vZQDTVWiJXB9lIWQWn0QEdFmElpGxvEry7msESLd2QEKsRXDu0LspYzFAsEfiOCGQ6R1gKDlhxIRNYlSIrKeHXUNXOA6o2h1rosEduBCGJ4RQODcqFO2pRAlxKvRJqAXUw7ZhiyIXFzMs1rIQvde2B57mg7VyC82jcaIhisKIH8krX9rcjyWFRixxz8Lq2UGgbrETrEjDhmpEHQjlv64w2O8hrim7wg0Tpt7E6Q+e2OHWokNBAfwKoXNzOoeDOo02gVoKQt7XxmPcq8d6gFagyPApBAHceHtIWcPf1WMzQVsK7zlMKDc9zQIkUFAeuzkrg8Tv3tUWXgFDCCy5dAs7zyrgEtAWP9/SugNeGHk+8F86T8SuRL9A7EJ/Lo/dIdyQb2FBYXYXoEzZqPUyE3i6v99RdUVCFa8tHwWvpYcllfRyzQsijD8suRn/VNVR83UY/hjDlDp+fASq6QznMfvwLkDIyyKKRPItivf9a4fA1idsP3gOLMf3ntZVftusyVkSM3l6/fwOrEi32eYg25nVKz2BUjFRfw82nU32Xtf3t20/fAwt57fXcYiVUjl9z1y7RhyBRmnndX7Ha64p7kUGnyo2gFY0J4fXwxlTwqAtmiiVfCm0fHw1oVDfXKsO5UHNcol0PrFR1laI9MPJtWKZ8zfnaQYp+haiGtnVppZVcQ1sRybZViQp2MCEpt3V6x8pnTZMwL/xO9ZgP6Mg8pereNE1wxRmtXCykTyeTw6LfE6qWhNAtpagVtZTr736/Kh6Xv1TPuMufvnazs9eG8qQ16dw/vOnp5On3p08mp5Mfrp48n579cfrs+WgymfyNJey+klsKwfKWCnToxf8HC0JJoXDeoTZ/OpnMv2+hPDuGXksQuku95FLkUAiUOdCZ7ncEEK3V9j8kMA/Y95D75HLn/NkDqaO0h0LXKv9/u3vMoocdPJv/0Lv47NDFCxUho27jSt+h+l94uPVneLyPx5Opu1ktolD4znacHa5HJx1mtRV+HTqZ+1NuxGn8Pr25pf6gQl9q6oJMHQymjmbKxt3rMt4M3pmGkT677BqjUG5Y6b1x0/HYcZWn+n6kDSoqCJKnbpTpasyNGC+fjJ6wJtnfw435JnmsT791i/N8IdTiS/tut1BdUjhjxHYA6+PGjfgJ1yzp4jGUajvDEjlVOooAZcn7bRf2sot1H8791qXrXL6uGTmgZsfai2F3wdhOB9G2lUMq3C4dpYbtt0iBGNsnH7SyV+zbHcdr7LOGACt0QLdN43cG1SU5SpcgRGffxw8oM11hx+O6DZ/+/q+wp8Mmtiuk4buP6qN6V1sweoW2qGVAs5B4L6geh9FCFb71swWHvJLonFwD0eqFDZiKhfDUUrSEJ+OGp0IKuuEkpmm3hcEj4UbwoURfoqVPf7DUKOS4REkPQ89o1GJLplba3hVSr1wCHNLaCYXOAaqSq4wEuzQNxJmr2G4ZKxyC85asFtE2rbzlmYeKK74IzDfZgSpHKegug9Up9W1Oyzp2JjQ/0Tb0GtGhMLsYEYgvaRxhEWiV6KDFku7Usm1PXBLbw5jT5ILKIUXnwZAtIsPAvmsldXYXgke0A4ym91VwSWxqaCNt95YrR0Ug2tLFoAesZZ0YDTw5uXZIEX4j1J2bnpx8VKdw0+fUB0yd8Hj7qHsfVqvVwbvweHfPK+Ff1ym8R6Od8Nqut7sXwpd1Gt6SoZL+n6jpFSoM+TN4KbY6cp25w6eJVsclSjO+RE8Z4sbns4tQkh7Dp1//AW+QWwWlXsVszWqLcg2L7ihCLkY+wtZXlNCb8tqXhHgWk6+dEnUIfii5//TrPx28xRX1XnSFIpAnJ7M6lSLrx3Lu5GQKLyzuDovCwCvjipoIV3JKJRoYcDBxtxTqbgTnah16+tC0h2Sg9bBvx43w6nXhdqGJykO3OJixjbYWBervUC7RkS5iBikC5oLIri+trhfxtKExrXMWC+p9PsS+k3w7z3Mw7XLXjlKbsTUHCx3bpzVwi+BCRznb2xK+1MZoS1a0/Wyhu9EGqtxoobybQm554bf6k22iZwRzGIkcLEUIeQ9H0qrpQxJvYutxvzr6SLVhr8rtvrUWC7R0YHB7Gxcj2nS66dISKFt/S1oTl6FXi2eBaoXxUiy3f9rXE2gP2sq9Ky7RLkWGbcn/zI0eB+ExS5gUGSo3rL/nr2ZvYPn9aMKSAXf4iss9fnPx4uXby5dkDD2kEbAno8loQktGO19xNThpb6S9X9c2W6L5356At0yG5i5jI7kIPLIdH0QOeMMGhGQ6HH7fJqzUzpPIZkOX8drKpqHlX+pQ1G9uE7bkVpClgSi2PXnek4HPuv3ofTdOhm+box91qONrishamOdEhnKH672BfnPbJB1pI4ujxIto1+kV6dlqOOgBiHXGHedZhsY/KDsk3bPrK5awtB3OV2HOzyxfEa/iq2hsnDUGOhrWNkxytaj5gmSjyiaOWMpdjnoXOGr7g5w6CscueY1e0F/y6eiGzSby36bp5eOnz+5oce2kKTa3TdP8G7SzMIs=",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,g={},b=[];function x(e){const t={p:"p",...(0,p.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(f.default,{as:"h1",className:"openapi__heading",children:"Update Template"}),"\n",(0,s.jsx)(o(),{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)(f.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(l(),{parameters:[{name:"template_id",in:"path",description:"ID of the template that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}]}),"\n",(0,s.jsx)(m(),{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:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},file:{type:"string",description:"You may provide the base64 encoded PDF file to replace the existing one",format:"base64",example:""},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:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5}},title:"template_template_id_body"}}}}}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,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"}}}}}})]})}function w(e={}){const{wrapper:t}={...(0,p.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(x,{...e})}):x(e)}}}]); \ No newline at end of file diff --git a/assets/js/5ce6d213.827e01c6.js b/assets/js/5ce6d213.827e01c6.js new file mode 100644 index 000000000..3677e2d96 --- /dev/null +++ b/assets/js/5ce6d213.827e01c6.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3460],{78912:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>b,contentTitle:()=>x,default:()=>g,frontMatter:()=>f,metadata:()=>a,toc:()=>v});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":"eJzFWN1uG7sRfpUpb5oIa0lJnBxUV3Vz0sRokAixjaB1DIG7O6vlMZfkIbmSBWOBc9E36FVv+2h5kmLI3dXqJ07Sc9reGDJ3Zji/nG/mnnm+dGx2zS6xMpJ7dOwmYTm6zArjhVZsxi5LhCuTc4/QUcHZ/BxQ8VSig42uwWuodC6KDXCVQx2pfYmQo+dCOtAFcHAGM1GIDHwrZ8wSpg1aTled52zGImt3D0uY4ZZX6NGSmvdM8QrZjHUCFiJnCROkpuG+ZPu6n/9IN5MiHQf4kntQiLkjrVNstSU5Fn+uhcWczbytMWHObyTd5kRlJCmDd0bqHNms4NIRQVZixdnsnvmNCZTeCrVkCSu0rbjfnjTNTZSPzv9J5xvi2VV1bvVK5AgpSr2G3mxSsvNnFyN4xD1I5M6DVjig7Qx4zBKWaeVRebqIGyNFFpw8+cnRbfeHquv0J8w8edxSSLxAR1+jw79uIDmHBzfNmAs/en1ZkzCl/XeLmZOJCBZXAtchsZxYKvClcJDrrK7IvGYv5N93RZ8VQxkN8cgcLWXkobwtN1HGKnh/OR+QplpL5OogGymr4CQaoMMhrIWUbSXB+8s5rNBShYRYjeHKoXWRxmKGYoXAd0gg0znCSnDAiguZwLoUWUkJv4Gqdh5QtTnUug57z40hJDGcwKFCuXBHNUqAS6nXQi2hDqodEwy5sJh5uYG18KWuPfA8F8TOJTiPxo2HXgxa9I681LX99Z7ksKxFjjl4XVsotA1aonUJmFBmZIFQzts6I2YHeU3RDXYQKf02Vmfo3NZPnVeIaCA/AVQusnMouPNoE6iVIM/b2njMe5F4Z9AKVBkedUFw7iI8pK3D3bf7Yo62Et51llJoeJ4DSqSgOHB1VgKP37mvLboEhBJecOkScJ5XxiWgLXi8o3cFvDb0eOKdcJ6UX4t8id6B+FIefUCqkWygQ2F1FaJPvlGbYSL0enm9J+6Sgipc2z4KXksPKy7r4z4rhDz6sOz66K+6hopv2ujHEKbc4YtTQEU1lMP8xz8DCSOFLBrJs0jW268VDl+TyH7wHliM6b+orfy6XhexI2K09urDW1iXaLHPQ7Qxr1N6BqNgpP4aKp9u9V3W9tW3n74HGvLa64XFSqgcv6XWLtCHIFGaed2XWO11xb3IoBPlxtCSxoTwelgxFTzqgpliyVdC28dHAxrFLbTKcCHUAldoNwMtVV2laA+UfBeOKV9zvnGQol8jqqFuXVppJTfQdkTSbV2igh2fEJXbGr2j5fOmSZgXfqd7LAZwZJFSd2+aJpjijFYuNtKn0+lh0+8BVQtCqEopakUt5eZ3v10Xj8df62fc5U/fuPnpG0N50qp05h9mejp9+uzkyfRk+sPlkxez0z/Mnr8YT6fTv7GE3VVyCyFY3kKBznvx/8GBUFIoXHReWzydThfPWleeHvNeCxC6ol5xKXIoBMoc6E73GzoQrdX2PwQwD+j3kPlkcmf86QOpo7SHQtcq/3+be0yjhw08XfzQm/j80MRzFV1G08alvkX1v7Bwa8/weh+vJ1V3s1pEovCd7Rg7PI9GOsxqK/wmTDJ3J9yIk/h9dn1D80GFvtQ0BZk6KEwTzYxNutdlcj94ZxpG8uyqG4xCu2Gl98bNJhPHVZ7qu7E2qKghSJ66caarCTdisnoyfsKaZJ+HG/Nd9FiffC+L83wp1PJrfDdbV11QOGPEdhzWx40b8RfcsKSLx5CqnQxL5NTpKAKUJR+2U9irLtZ9OPdHl25y+bZh5ACaHRsvhtMFYzsTRDtWDqFwe3QUGrbfIgRibB980Mles285jvfY5w05rNDBu20avzeoLshQKoIQnX0bP6LMdIUdjhuNOpbPf/9XzzUa9U6Ko80n9Um9ry0YvUZb1DJ4tJB4J6gnh/VCFb71+wWHvJLonNwAQeulDX4VS+FprGhBT8YNT4UUVOVEponbwuChcGP4WKIv0dKn31saFnJcoaTHoUc1arkFVGttbwup1y4BDmnthELnAFXJVUaEXaoG8MxVHLmMFQ7BeUtai6ibVt7yzEPFFV8G9JvA0Fk5SkH1DFanNLs5Les4ndAORdswb0SDwv4iOPEVrSQsAp0SJLRYUl2t2hHFJXFEjHlNJqgcUnQeDOkiMgwIvFZSZ7chgAQ9wGh6YwWXhKiGOhK7t1w5agRRly4GvcNa5IlRwdHoyiFF+K1Qt242Gn1SJ3Dd59VHTJ3wePOoeyPW6/XB2/B4l+e18G/qFD6g0U54bTdb7qXwZZ2G92QopP8nSnqNCkP+DF6LrYxcZ+7weaLTSYnSTC7QU4a4ydn8PLSlx/D5l3/AW+RWQanXMVuz2qLcwLK7ijwXIx/d1neVMJ/y2pfk8SwmX7sp6jz4seT+8y//dPAO1zR/xZIiU0ajeZ1KkfWrOTcazeClxd2FUVh6ZVzRIOFKTqlESwMOJnJLoW7HcKY2Ya4Pg3tIBjoPfDtmhJevC7cLg1QeJsbBnm281SjAf4dyhY5kETpIETAXBHh9aXW9jLcNlWmNs1jQ/PMxzp5k21meg2mPu5GURo2tOljoOEJtgFsEF6bK+R5L+FIboy1p0c60he7WG6hyo4Xybga55YXfyk+2iZ6Rm8Na5OAoupD37khaMX1IYiW2Fven40/UH/Y63e57a7FASxcGs7dxMaJNp+suLYGy9dekNeEZerV4FuBWWDHFlvvHfTkB+qCt3PviAu1KZNi2/S9U9CQQT1jCpMhQuWEPPns9fwurZ+MpSwb44RuKe/L2/OWrdxevSBl6SKPDnoyn4ykdGe18xdXgpr219n5vu9+Czf/2FrxFM7R7mRjJRcCS7Qoh4sBrNgAls+EC/CZhpXaeSO7vqRivrGwaOv65Do39+iZhK24FaRrAYjuX5z0g+KLZjz50K2X4vl36UYM6zKYIsIWdTkQpt7jZW+o3N03SATfSOFK8jHqdXJKcrYSDOYCQZ+Q4yzI0/kHaIfCeX12yhKXtgr4Ku35m+ZqwFV9HZeO+MUDScHbPJFfLmi+JNops4pql3MWptwGntj/IqKPu2AWw0Qr6SzYdZbi/jxi4aXr6+OmLHK1fO2qKzU3TNP8Gdp4xQA==","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),o=i(28453),s=i(33617),p=i.n(s),d=i(17543),l=i.n(d),r=i(86013),c=i.n(r),m=i(63723),u=i.n(m),h=(i(18766),i(79329),i(9303));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:"eJzFWN1uG7sRfpUpb5oIa0lJnBxUV3Vz0sRokAixjaB1DIG7O6vlMZfkIbmSBWOBc9E36FVv+2h5kmLI3dXqJ07Sc9reGDJ3Zji/nG/mnnm+dGx2zS6xMpJ7dOwmYTm6zArjhVZsxi5LhCuTc4/QUcHZ/BxQ8VSig42uwWuodC6KDXCVQx2pfYmQo+dCOtAFcHAGM1GIDHwrZ8wSpg1aTled52zGImt3D0uY4ZZX6NGSmvdM8QrZjHUCFiJnCROkpuG+ZPu6n/9IN5MiHQf4kntQiLkjrVNstSU5Fn+uhcWczbytMWHObyTd5kRlJCmDd0bqHNms4NIRQVZixdnsnvmNCZTeCrVkCSu0rbjfnjTNTZSPzv9J5xvi2VV1bvVK5AgpSr2G3mxSsvNnFyN4xD1I5M6DVjig7Qx4zBKWaeVRebqIGyNFFpw8+cnRbfeHquv0J8w8edxSSLxAR1+jw79uIDmHBzfNmAs/en1ZkzCl/XeLmZOJCBZXAtchsZxYKvClcJDrrK7IvGYv5N93RZ8VQxkN8cgcLWXkobwtN1HGKnh/OR+QplpL5OogGymr4CQaoMMhrIWUbSXB+8s5rNBShYRYjeHKoXWRxmKGYoXAd0gg0znCSnDAiguZwLoUWUkJv4Gqdh5QtTnUug57z40hJDGcwKFCuXBHNUqAS6nXQi2hDqodEwy5sJh5uYG18KWuPfA8F8TOJTiPxo2HXgxa9I681LX99Z7ksKxFjjl4XVsotA1aonUJmFBmZIFQzts6I2YHeU3RDXYQKf02Vmfo3NZPnVeIaCA/AVQusnMouPNoE6iVIM/b2njMe5F4Z9AKVBkedUFw7iI8pK3D3bf7Yo62Et51llJoeJ4DSqSgOHB1VgKP37mvLboEhBJecOkScJ5XxiWgLXi8o3cFvDb0eOKdcJ6UX4t8id6B+FIefUCqkWygQ2F1FaJPvlGbYSL0enm9J+6Sgipc2z4KXksPKy7r4z4rhDz6sOz66K+6hopv2ujHEKbc4YtTQEU1lMP8xz8DCSOFLBrJs0jW268VDl+TyH7wHliM6b+orfy6XhexI2K09urDW1iXaLHPQ7Qxr1N6BqNgpP4aKp9u9V3W9tW3n74HGvLa64XFSqgcv6XWLtCHIFGaed2XWO11xb3IoBPlxtCSxoTwelgxFTzqgpliyVdC28dHAxrFLbTKcCHUAldoNwMtVV2laA+UfBeOKV9zvnGQol8jqqFuXVppJTfQdkTSbV2igh2fEJXbGr2j5fOmSZgXfqd7LAZwZJFSd2+aJpjijFYuNtKn0+lh0+8BVQtCqEopakUt5eZ3v10Xj8df62fc5U/fuPnpG0N50qp05h9mejp9+uzkyfRk+sPlkxez0z/Mnr8YT6fTv7GE3VVyCyFY3kKBznvx/8GBUFIoXHReWzydThfPWleeHvNeCxC6ol5xKXIoBMoc6E73GzoQrdX2PwQwD+j3kPlkcmf86QOpo7SHQtcq/3+be0yjhw08XfzQm/j80MRzFV1G08alvkX1v7Bwa8/weh+vJ1V3s1pEovCd7Rg7PI9GOsxqK/wmTDJ3J9yIk/h9dn1D80GFvtQ0BZk6KEwTzYxNutdlcj94ZxpG8uyqG4xCu2Gl98bNJhPHVZ7qu7E2qKghSJ66caarCTdisnoyfsKaZJ+HG/Nd9FiffC+L83wp1PJrfDdbV11QOGPEdhzWx40b8RfcsKSLx5CqnQxL5NTpKAKUJR+2U9irLtZ9OPdHl25y+bZh5ACaHRsvhtMFYzsTRDtWDqFwe3QUGrbfIgRibB980Mles285jvfY5w05rNDBu20avzeoLshQKoIQnX0bP6LMdIUdjhuNOpbPf/9XzzUa9U6Ko80n9Um9ry0YvUZb1DJ4tJB4J6gnh/VCFb71+wWHvJLonNwAQeulDX4VS+FprGhBT8YNT4UUVOVEponbwuChcGP4WKIv0dKn31saFnJcoaTHoUc1arkFVGttbwup1y4BDmnthELnAFXJVUaEXaoG8MxVHLmMFQ7BeUtai6ibVt7yzEPFFV8G9JvA0Fk5SkH1DFanNLs5Les4ndAORdswb0SDwv4iOPEVrSQsAp0SJLRYUl2t2hHFJXFEjHlNJqgcUnQeDOkiMgwIvFZSZ7chgAQ9wGh6YwWXhKiGOhK7t1w5agRRly4GvcNa5IlRwdHoyiFF+K1Qt242Gn1SJ3Dd59VHTJ3wePOoeyPW6/XB2/B4l+e18G/qFD6g0U54bTdb7qXwZZ2G92QopP8nSnqNCkP+DF6LrYxcZ+7weaLTSYnSTC7QU4a4ydn8PLSlx/D5l3/AW+RWQanXMVuz2qLcwLK7ijwXIx/d1neVMJ/y2pfk8SwmX7sp6jz4seT+8y//dPAO1zR/xZIiU0ajeZ1KkfWrOTcazeClxd2FUVh6ZVzRIOFKTqlESwMOJnJLoW7HcKY2Ya4Pg3tIBjoPfDtmhJevC7cLg1QeJsbBnm281SjAf4dyhY5kETpIETAXBHh9aXW9jLcNlWmNs1jQ/PMxzp5k21meg2mPu5GURo2tOljoOEJtgFsEF6bK+R5L+FIboy1p0c60he7WG6hyo4Xybga55YXfyk+2iZ6Rm8Na5OAoupD37khaMX1IYiW2Fven40/UH/Y63e57a7FASxcGs7dxMaJNp+suLYGy9dekNeEZerV4FuBWWDHFlvvHfTkB+qCt3PviAu1KZNi2/S9U9CQQT1jCpMhQuWEPPns9fwurZ+MpSwb44RuKe/L2/OWrdxevSBl6SKPDnoyn4ykdGe18xdXgpr219n5vu9+Czf/2FrxFM7R7mRjJRcCS7Qoh4sBrNgAls+EC/CZhpXaeSO7vqRivrGwaOv65Do39+iZhK24FaRrAYjuX5z0g+KLZjz50K2X4vl36UYM6zKYIsIWdTkQpt7jZW+o3N03SATfSOFK8jHqdXJKcrYSDOYCQZ+Q4yzI0/kHaIfCeX12yhKXtgr4Ku35m+ZqwFV9HZeO+MUDScHbPJFfLmi+JNops4pql3MWptwGntj/IqKPu2AWw0Qr6SzYdZbi/jxi4aXr6+OmLHK1fO2qKzU3TNP8Gdp4xQA==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},x=void 0,b={},v=[];function F(e){const t={p:"p",...(0,o.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:"Request"}),"\n",(0,n.jsx)(l(),{parameters:[{name:"template_id",in:"path",description:"ID of the template that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}]}),"\n",(0,n.jsx)(c(),{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:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},file:{type:"string",description:"You may provide the base64 encoded PDF file to replace the existing one",format:"base64",example:""},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:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5}},title:"template_template_id_body"}}}}}),"\n",(0,n.jsx)(u(),{id:void 0,label:void 0,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"}}}}}})]})}function g(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(F,{...e})}):F(e)}}}]); \ No newline at end of file diff --git a/assets/js/62b755e6.4db3ade4.js b/assets/js/62b755e6.4db3ade4.js new file mode 100644 index 000000000..455b620e2 --- /dev/null +++ b/assets/js/62b755e6.4db3ade4.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9350],{30456:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>y,contentTitle:()=>b,default:()=>f,frontMatter:()=>x,metadata:()=>s,toc:()=>j});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(33617),l=n.n(a),o=n(17543),p=n.n(o),c=n(86013),d=n.n(c),m=n(63723),u=n.n(m),h=(n(18766),n(79329),n(9303));const x={id:"getdocumentlist",title:"Get Document list from status",description:"### Document Types:",sidebar_label:"Get Document list from status",hide_title:!0,hide_table_of_contents:!0,api:"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},b=void 0,y={},j=[{value:"Document Types:",id:"document-types",level:3}];function g(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:"Request"}),"\n",(0,i.jsx)(p(),{parameters:[{name:"doctype",in:"path",description:"The type of documents to retrieve",required:!0,style:"simple",explode:!1,schema:{type:"string",enum:["draft","inprogress","completed","expired","declined"]}},{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10},{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}]}),"\n",(0,i.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,i.jsx)(u(),{id:void 0,label:void 0,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:!0},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:!0},redirect_url:{type:"string",format:"string",example:""},allow_modifications:{type:"boolean",example:!1},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:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example: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"}}}}}})]})}function f(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/62b755e6.65eb58f6.js b/assets/js/62b755e6.65eb58f6.js deleted file mode 100644 index 8c65464e9..000000000 --- a/assets/js/62b755e6.65eb58f6.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9350],{30456:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>g,contentTitle:()=>y,default:()=>X,frontMatter:()=>h,metadata:()=>n,toc:()=>j});const n=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":"eJztWc1uGzkSfpUa5rCJ0ZZkW05mdRoj4/V6N0iM2EGAjQ2B3V1SM2aTPSRbsmA0MId9gz3NdR4tT7Iosv9ky46VGeQ0F1siq4r187FYVbpljs8tm3xiP+ukzFE5y64ilqJNjCic0IpN2LNnz6DZhotVgXZyqd6jMwIXCByksA70DNJGBMTcYgpagVsVeKku1d4AdnZ+NnzmWkl2srNzqQAAdrs1cBl3wA1CUhqDyskVCAWp57SOu9IOSN4+yTtVu2dGzw1a+01Si5rZSzwgia91Xkh0mD5FXsYXCDGiAlsmCVo7K6VcQdLKWAqXAZcSDP5SCoMpWDFX3JUGw5ljOvP4pvB7Tz0Ra3quUm+S0iC1mqMB7rUQsUQv/dD7HBMp1LYGpQ1XvAKXIZQWzeBSsYjpAg0nXJymbMLm6JqgEwhYxApueI4ODYHqlimeI5uwVCeEBBYxQYAquMvYXZRdZOjhso4kp8HUSGMRaxzJJs6UGDHrVpLkW0E+ZxHDm0LqFNlkxqUlgiTDnLPJLfPnT5h1Rqg5UaoyJ9x7aHnFGjiwiLUxDCL9kaRv8Aq7qqqotU2KXLjGsl9KNKs1RRtFak1n2uR9PWs7WjVzfiNy0uxwNIoapVWZx2hYRXzcWzrZG/VUsNei+NM0ePjMUXVFcm2hlUVLtPujEf1bD2R3G6BFi/epcqgc0fOikCLxG8PPlphu7yug48+YeEgZEuNEONKgLaXr0XFjOBksHOb26/xhmdB7HxPkGu7WUNLYzv5xIq73D+Lsw7/IJzNBi9tJyJwr7GQ4rFdKIweJzkmaE257cdZ/oKtCIpR2W0soJHKLPim1N84bp2WK5nu5MmB4OwlBQ/CsVedA1lgxrU2oIqaXas2WJ8n/rH0iJH7yjs9m3wo4ozfHtjstQf2YIzaqhTkX8qvUMeJP9UKDtSLT6ivHjA9f7u8d/Phqj+iXIp2j+wP2h93t/O/wxsX6xuvL53g/LfXY25UuN1YRu9mSZ388riK22pLrFR213JLp4McqYtmWTOOXhGWfYp/g82+5U63Pq/6NcpgXkjucnod7MG3w8CiVv5QWVXqq3pn1XBJrLZGr/tH0AlURSwxyh+mRexyd+6P9g9290e7o1cXey8n475PDl4PRaPQfFrGbXHbWs5Q7ZP3kUH8vi/S7nIOKxxIvdPk08w2mwmDipqXZeLEfix0dx6XUy2muUzGr31b7+Lm+LiC9m+CJjZm8j5CWEIQFreQK+IILSXbCMkPli8UmCRNNHVOYGZ0Dh0bCwCtcOj01mAv1EELW64pzdFQOkrvof3AvkJScO5FAI8oOoCb1FtKHVFhP7DLM4XmKM15KBzFmfCG0eTHY5JYgbqpVglOhprigumrDpV1X8q1f9jUsX1mI0S2poO7pdpEJ27kvVEKt/9Z8QlS2M3pNyxHdsDs47D3hdx/E9esqFNWx06aUm+6PRtNxffHHo/H9ku49Fto4UNp1Af/hz6vp0Bi98Y3usLdZg8eMGo/G08PWqMP7Rp2qBZcihaOzU7jQ16i+r0X94104/n5MRSDy+2zN2P56MNJiUhrhVr7xutnlhdgN+5NPV1S55+gyXXdtvlNzGZuwYb+BG97WnVrFSJ5ZNH2cz0ltBWu5SmN9M9AFKqqPJI8t1RdDXojhYm9AhcNdHl4UW9Fjubsti3V8LtT8a3xXnavOKZwhYmsO62qdQvwbqdip49GnqhuuDLkvNSv6PtOeuY7SuwIVvYg+xv7wu+niI8pE5z5HUepsGL7893fP08TGg9BL+IE6+3elgUIv0VCPRXOAmcQb6vs9E+Z+z8JKlyTYIs8lWuuHHg7nhjuEVMyF49IX/0LNIeEFj4UUBGAi08RtoHcH7AA+ZugyNLT1N0OTnxQXKAn3bRpW8y7/L7W5nkm9tBFwiEsrFE1qUGVcJUTYRCECbYArQOXQFEZQT+IMaS2Cblo5wxMHOVd8jiQ7WnNVilIQVMHouLQOrJalVxkcF1LTtKQxSCGmYfhyTA2wQaBV6vcNZgSZBcK8FCnaCBKdIoQ2i0xQKcRoHRSki0jQDydKJXVy7YNH4x8oNKUPwSU9AX0did0Zriy940GXJgatwwqjqXOup0M7Ox8sUoTfCHUdxja78KnF1EeMrXB49byB/3K5vAf7F+s8J8L9s4yBkqkVTptVxz0XLitjf1X6QtovQdIJKvT46V2ETkaqE3v/5tHqMENZDM/REULs8Ojs1GfcF/Dl1//BG+RGQaaXAa1JaVCuYN4cRZ4LkQ9uaxMmzLQHXkYeTwL4aOyB1jUe/Jhx9+XX3yy8xSWN/OgKBUfu7JyVsRQJXNQ1id3ZmcBrX6+0dUo9GEu4ghjBZpygtBAcOBSBWwp1PYAjtfIzsjDyIzDQuudbM2Ot1e6PSbPuzEGnka9XLMoFWpJFj1+MgKmgksplRpfzcFpfmdo4gzMhJXwM5TrZdpSmUNTLdRXva6NOHZzRhXAZrvxk0aJyAzi7w+J3yoKeY0zJpx77mqpPCgCqtNCC5oz11LaVH3VA92Wh0GrDUj01bd0R1WLakISbWFvcrobp5J0kvp5rDc7Q0IHe7C4uhajh9KmBJRBa/wis6ammrMUTX0nUzTq9Jj/dleNfdTS5fTc7R7MQSTMqeuBGDz3xkEVMigSVxV61cHRy9gYWB4MRi3pP4xMu9/DN6evjt+fHpAwl0uCwvcFoMPI9uLYu56p30gl2g/ww//cVfpjQ333lbruq6q/fEv76LaH9LaGusWjwMCwkF77CrbvfUJ1+Ynd+Xpg0vyRcRSzT1hHJ7S1B5IORVUXLYQBORWvd9XUj8Gtc9Qb2Cy7Lunl+kLaerHekV/TFCKLdfMaDyH/+vo7cC3jKTx0bndNUpWrVV6pRtvFNdUUDplCWko5h9yhJsOjbfa+/WWsSTo4vmO/Rs/Vy+NqXw/UHkr5Rp/U6OShAf8nVGxlub0OpXVUtfdh6kKM2sKEmB11VVfV/7hH+lQ==","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=s(74848),r=s(28453),o=s(33617),p=s.n(o),a=s(17543),l=s.n(a),m=s(86013),d=s.n(m),c=s(63723),u=s.n(c),x=(s(18766),s(79329),s(9303));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:"eJztWc1uGzkSfpUa5rCJ0ZZkW05mdRoj4/V6N0iM2EGAjQ2B3V1SM2aTPSRbsmA0MId9gz3NdR4tT7Iosv9ky46VGeQ0F1siq4r187FYVbpljs8tm3xiP+ukzFE5y64ilqJNjCic0IpN2LNnz6DZhotVgXZyqd6jMwIXCByksA70DNJGBMTcYgpagVsVeKku1d4AdnZ+NnzmWkl2srNzqQAAdrs1cBl3wA1CUhqDyskVCAWp57SOu9IOSN4+yTtVu2dGzw1a+01Si5rZSzwgia91Xkh0mD5FXsYXCDGiAlsmCVo7K6VcQdLKWAqXAZcSDP5SCoMpWDFX3JUGw5ljOvP4pvB7Tz0Ra3quUm+S0iC1mqMB7rUQsUQv/dD7HBMp1LYGpQ1XvAKXIZQWzeBSsYjpAg0nXJymbMLm6JqgEwhYxApueI4ODYHqlimeI5uwVCeEBBYxQYAquMvYXZRdZOjhso4kp8HUSGMRaxzJJs6UGDHrVpLkW0E+ZxHDm0LqFNlkxqUlgiTDnLPJLfPnT5h1Rqg5UaoyJ9x7aHnFGjiwiLUxDCL9kaRv8Aq7qqqotU2KXLjGsl9KNKs1RRtFak1n2uR9PWs7WjVzfiNy0uxwNIoapVWZx2hYRXzcWzrZG/VUsNei+NM0ePjMUXVFcm2hlUVLtPujEf1bD2R3G6BFi/epcqgc0fOikCLxG8PPlphu7yug48+YeEgZEuNEONKgLaXr0XFjOBksHOb26/xhmdB7HxPkGu7WUNLYzv5xIq73D+Lsw7/IJzNBi9tJyJwr7GQ4rFdKIweJzkmaE257cdZ/oKtCIpR2W0soJHKLPim1N84bp2WK5nu5MmB4OwlBQ/CsVedA1lgxrU2oIqaXas2WJ8n/rH0iJH7yjs9m3wo4ozfHtjstQf2YIzaqhTkX8qvUMeJP9UKDtSLT6ivHjA9f7u8d/Phqj+iXIp2j+wP2h93t/O/wxsX6xuvL53g/LfXY25UuN1YRu9mSZ388riK22pLrFR213JLp4McqYtmWTOOXhGWfYp/g82+5U63Pq/6NcpgXkjucnod7MG3w8CiVv5QWVXqq3pn1XBJrLZGr/tH0AlURSwxyh+mRexyd+6P9g9290e7o1cXey8n475PDl4PRaPQfFrGbXHbWs5Q7ZP3kUH8vi/S7nIOKxxIvdPk08w2mwmDipqXZeLEfix0dx6XUy2muUzGr31b7+Lm+LiC9m+CJjZm8j5CWEIQFreQK+IILSXbCMkPli8UmCRNNHVOYGZ0Dh0bCwCtcOj01mAv1EELW64pzdFQOkrvof3AvkJScO5FAI8oOoCb1FtKHVFhP7DLM4XmKM15KBzFmfCG0eTHY5JYgbqpVglOhprigumrDpV1X8q1f9jUsX1mI0S2poO7pdpEJ27kvVEKt/9Z8QlS2M3pNyxHdsDs47D3hdx/E9esqFNWx06aUm+6PRtNxffHHo/H9ku49Fto4UNp1Af/hz6vp0Bi98Y3usLdZg8eMGo/G08PWqMP7Rp2qBZcihaOzU7jQ16i+r0X94104/n5MRSDy+2zN2P56MNJiUhrhVr7xutnlhdgN+5NPV1S55+gyXXdtvlNzGZuwYb+BG97WnVrFSJ5ZNH2cz0ltBWu5SmN9M9AFKqqPJI8t1RdDXojhYm9AhcNdHl4UW9Fjubsti3V8LtT8a3xXnavOKZwhYmsO62qdQvwbqdip49GnqhuuDLkvNSv6PtOeuY7SuwIVvYg+xv7wu+niI8pE5z5HUepsGL7893fP08TGg9BL+IE6+3elgUIv0VCPRXOAmcQb6vs9E+Z+z8JKlyTYIs8lWuuHHg7nhjuEVMyF49IX/0LNIeEFj4UUBGAi08RtoHcH7AA+ZugyNLT1N0OTnxQXKAn3bRpW8y7/L7W5nkm9tBFwiEsrFE1qUGVcJUTYRCECbYArQOXQFEZQT+IMaS2Cblo5wxMHOVd8jiQ7WnNVilIQVMHouLQOrJalVxkcF1LTtKQxSCGmYfhyTA2wQaBV6vcNZgSZBcK8FCnaCBKdIoQ2i0xQKcRoHRSki0jQDydKJXVy7YNH4x8oNKUPwSU9AX0did0Zriy940GXJgatwwqjqXOup0M7Ox8sUoTfCHUdxja78KnF1EeMrXB49byB/3K5vAf7F+s8J8L9s4yBkqkVTptVxz0XLitjf1X6QtovQdIJKvT46V2ETkaqE3v/5tHqMENZDM/REULs8Ojs1GfcF/Dl1//BG+RGQaaXAa1JaVCuYN4cRZ4LkQ9uaxMmzLQHXkYeTwL4aOyB1jUe/Jhx9+XX3yy8xSWN/OgKBUfu7JyVsRQJXNQ1id3ZmcBrX6+0dUo9GEu4ghjBZpygtBAcOBSBWwp1PYAjtfIzsjDyIzDQuudbM2Ot1e6PSbPuzEGnka9XLMoFWpJFj1+MgKmgksplRpfzcFpfmdo4gzMhJXwM5TrZdpSmUNTLdRXva6NOHZzRhXAZrvxk0aJyAzi7w+J3yoKeY0zJpx77mqpPCgCqtNCC5oz11LaVH3VA92Wh0GrDUj01bd0R1WLakISbWFvcrobp5J0kvp5rDc7Q0IHe7C4uhajh9KmBJRBa/wis6ammrMUTX0nUzTq9Jj/dleNfdTS5fTc7R7MQSTMqeuBGDz3xkEVMigSVxV61cHRy9gYWB4MRi3pP4xMu9/DN6evjt+fHpAwl0uCwvcFoMPI9uLYu56p30gl2g/ww//cVfpjQ333lbruq6q/fEv76LaH9LaGusWjwMCwkF77CrbvfUJ1+Ynd+Xpg0vyRcRSzT1hHJ7S1B5IORVUXLYQBORWvd9XUj8Gtc9Qb2Cy7Lunl+kLaerHekV/TFCKLdfMaDyH/+vo7cC3jKTx0bndNUpWrVV6pRtvFNdUUDplCWko5h9yhJsOjbfa+/WWsSTo4vmO/Rs/Vy+NqXw/UHkr5Rp/U6OShAf8nVGxlub0OpXVUtfdh6kKM2sKEmB11VVfV/7hH+lQ==",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,g={},j=[{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)(x.default,{as:"h1",className:"openapi__heading",children:"Get Document list from status"}),"\n",(0,i.jsx)(p(),{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:"Request"}),"\n",(0,i.jsx)(l(),{parameters:[{name:"doctype",in:"path",description:"The type of documents to retrieve",required:!0,style:"simple",explode:!1,schema:{type:"string",enum:["draft","inprogress","completed","expired","declined"]}},{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10},{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}]}),"\n",(0,i.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,i.jsx)(u(),{id:void 0,label:void 0,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:!0},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:!0},redirect_url:{type:"string",format:"string",example:""},allow_modifications:{type:"boolean",example:!1},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:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example: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"}}}}}})]})}function X(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/6d2e526e.89e61fc0.js b/assets/js/6d2e526e.89e61fc0.js deleted file mode 100644 index bfe6a7315..000000000 --- a/assets/js/6d2e526e.89e61fc0.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[5752],{50839:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>j,contentTitle:()=>f,default:()=>g,frontMatter:()=>v,metadata:()=>n,toc:()=>D});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":"eJy9V81u3DYQfpUpL20MeXftuCmqU900SI0GiRE7MFBnYVDSSGJNkSxJ7XqxENBD36CnXvtoeZJiSGlXu3bcBv252KvhzHDmm+H8rJnnlWPpNftO522Dyjs2T1iBLrfCeKEVS9lljfAWF/oWoei54PT8DLiUeulgpVvwGmzkcAZzUYp8y1pa3RCT3ZDchCVMG7ScbjgrWMqi9MDAEma45Q16tGTdmineIEvZwHAjCpYwQdYZ7mu2b/K51QtRIOjsJ8z9WQG63Bq0MZYlzOLPrbBYsNTbFhPm/ErSRU40RhID3hmpC2RpyaUjhrzGhrN0zfzKBE5vhapYwkptG+7HFLzjQUvKTH2c1cfcFazr5vFWdP5bXaxIU66VJ6/TNePGSJEHXKY/OfJlff/K6BWBZAlFL9DRqUXeS+ybtjWEdV3CvPDhYw/0rqNDi85o5aLK49mM/u2CO6RKj2IBrs1zdK5spVx9xpJ/y58heI979O0dAWu+N09ZsD6YdOofFzqeHT89PJodzr66PHqWnnydfvlsMpvNfmQJu2skyQ4Jxz2yEWTxu9tn6/PpHrY9picPwXihG/S1UBUsCcyl1apKwEjkDsHbFfCKCwWSe7T/IqporbaPo/Nplo0zSigpFN4MOXRzMpvdHG1AOHkkl5T2UOpWFf+vqw/d/7hDJzdPNw59ed+hM7XgUhShQF7qW1T/rz/j6328/n62isgUztmOs2N6dNJh3lrhV6EK3x1yIw7jeXo9p1JGmaKpghvtYt32NUvZdKgq0/WoZneMFNrFUNVbK1nKau+NS6dTx1WR6buJNqicqJTkmZvkuplyI6aLo8kR65J9GW7MJ/Fje/ipIs7zSqjqr+TmW6wuKJ4xZDuIbQLHjfgBVywZAjLm6ttajbxAG4JHafJ22zFeDMHeVnxGURSq1OGOPppvDKoLUamQC8HG/S55hTLXDVJD9DXCIPDh1z+CzBC4kKxBw2fv1Xv1prVg9BJt2UrgqoBS4p3IJAYhbMLZZixwyBuJzskVCOWxstwjFKISnksgKKnM5NzwTEhBiU5sOs4Lo7fiJnBVo6/R0tHnFoFDgQuU9D6At1433JOqTZdfantb0oCSAIesdUKhc4Cq5ionxiFYCWgLXAEqj9ZY4RCct2S1iLZp5S3PPTRc8QpJd7IDVYFSUEaD1VnrPDgt22AyeC6ktljA4JBCLNyEQHxBY4VFIGquG2OxpsxaIFStKNAlkOsCwYVQkwuqgAydB0O2iBwdKW2V1PltCB41XzCayozgkuadsY0k7i1XjoaUfhjrY7ABzFhNXRyjgQcH7xxShF8JdevSg4P36hCuNzl1hZkTHudfDK9kuVzeex1PdmVeCv99m8FbNNoJr+1qK10JX7dZeFFjJZuPqOklKgz5M3ovWx2Fzt39B0rUaY3STC/QU4a46en5WajMT+DDL7/BK+RWQa2XMVvz1qJcQTVcRcjFyEfYNoUVSh0SrybE85h8/Vw3IHhVc//hl98dvMYliPiEIpAHB+dtJkUOl9gY6qPu4CCF5xbpSj/QwNfcQ84VZAiu5pRKC8GBg4nSUqjbCZyqFbQOLSyFr0MyED3I7bhBuGxncMi4wwK0ChLDnZOtRURvHMoFOtJFDTJDwEJ4yuja6raKt42N6Z2zWAop4UoUFfrg22lRgOnJy0gmwEfmYEkPwte4Am4RHCo/gfM9kXDSGqMtWSGi8aWmTYQCgKowWijvUigsL/1Wf7JN9JxgFlo9QIoQ8g0cSa9mE5L4EnuPN9TJe6rbe7V+t9ZaLDFsQMHtbVyM6NPpekhLoGz9J2lNzYCqFs/DxIENFzI2nW/29YTuj7Zxb8oLtAuRY9/4PvKip4F5yhImRY7K4WiqOH15/goWTyczlow66N943NNXZ89fvL54QcZQIY2AHU1mkxmRaLBouBrd1C+j3223xR2sRwvVf7S79m3c452fGslFmKKCz+t+ALpmo102Ha+t84TVNCql12y9pjf4zsquI/LPLVqas+YJW3AreEZt/HrNCuHod7HZQT/q7Rdv+3X2CfztDfhBX4Y5RdGQsuCyDbtjwm5xtbeFd/MuGYYVMjZyPI8mHV6Snq2Ge8MvTVtR4jTP0fhHecfT5vmbi0uWsKzfoJuwojPLl7TT82W0VgeI4m5MtDWTXFUtr4g36qT5ior47nB2G4az/gd59SAeu1NbdIP+klMPCqzXcfDrug1/PPqoRA/swE3BmXdd9yc+jTvg","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 s=o(74848),i=o(28453),r=o(33617),d=o.n(r),p=o(17543),a=o.n(p),c=o(86013),u=o.n(c),l=o(63723),m=o.n(l),h=(o(18766),o(79329),o(9303));const v={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:"eJy9V81u3DYQfpUpL20MeXftuCmqU900SI0GiRE7MFBnYVDSSGJNkSxJ7XqxENBD36CnXvtoeZJiSGlXu3bcBv252KvhzHDmm+H8rJnnlWPpNftO522Dyjs2T1iBLrfCeKEVS9lljfAWF/oWoei54PT8DLiUeulgpVvwGmzkcAZzUYp8y1pa3RCT3ZDchCVMG7ScbjgrWMqi9MDAEma45Q16tGTdmineIEvZwHAjCpYwQdYZ7mu2b/K51QtRIOjsJ8z9WQG63Bq0MZYlzOLPrbBYsNTbFhPm/ErSRU40RhID3hmpC2RpyaUjhrzGhrN0zfzKBE5vhapYwkptG+7HFLzjQUvKTH2c1cfcFazr5vFWdP5bXaxIU66VJ6/TNePGSJEHXKY/OfJlff/K6BWBZAlFL9DRqUXeS+ybtjWEdV3CvPDhYw/0rqNDi85o5aLK49mM/u2CO6RKj2IBrs1zdK5spVx9xpJ/y58heI979O0dAWu+N09ZsD6YdOofFzqeHT89PJodzr66PHqWnnydfvlsMpvNfmQJu2skyQ4Jxz2yEWTxu9tn6/PpHrY9picPwXihG/S1UBUsCcyl1apKwEjkDsHbFfCKCwWSe7T/IqporbaPo/Nplo0zSigpFN4MOXRzMpvdHG1AOHkkl5T2UOpWFf+vqw/d/7hDJzdPNw59ed+hM7XgUhShQF7qW1T/rz/j6328/n62isgUztmOs2N6dNJh3lrhV6EK3x1yIw7jeXo9p1JGmaKpghvtYt32NUvZdKgq0/WoZneMFNrFUNVbK1nKau+NS6dTx1WR6buJNqicqJTkmZvkuplyI6aLo8kR65J9GW7MJ/Fje/ipIs7zSqjqr+TmW6wuKJ4xZDuIbQLHjfgBVywZAjLm6ttajbxAG4JHafJ22zFeDMHeVnxGURSq1OGOPppvDKoLUamQC8HG/S55hTLXDVJD9DXCIPDh1z+CzBC4kKxBw2fv1Xv1prVg9BJt2UrgqoBS4p3IJAYhbMLZZixwyBuJzskVCOWxstwjFKISnksgKKnM5NzwTEhBiU5sOs4Lo7fiJnBVo6/R0tHnFoFDgQuU9D6At1433JOqTZdfantb0oCSAIesdUKhc4Cq5ionxiFYCWgLXAEqj9ZY4RCct2S1iLZp5S3PPTRc8QpJd7IDVYFSUEaD1VnrPDgt22AyeC6ktljA4JBCLNyEQHxBY4VFIGquG2OxpsxaIFStKNAlkOsCwYVQkwuqgAydB0O2iBwdKW2V1PltCB41XzCayozgkuadsY0k7i1XjoaUfhjrY7ABzFhNXRyjgQcH7xxShF8JdevSg4P36hCuNzl1hZkTHudfDK9kuVzeex1PdmVeCv99m8FbNNoJr+1qK10JX7dZeFFjJZuPqOklKgz5M3ovWx2Fzt39B0rUaY3STC/QU4a46en5WajMT+DDL7/BK+RWQa2XMVvz1qJcQTVcRcjFyEfYNoUVSh0SrybE85h8/Vw3IHhVc//hl98dvMYliPiEIpAHB+dtJkUOl9gY6qPu4CCF5xbpSj/QwNfcQ84VZAiu5pRKC8GBg4nSUqjbCZyqFbQOLSyFr0MyED3I7bhBuGxncMi4wwK0ChLDnZOtRURvHMoFOtJFDTJDwEJ4yuja6raKt42N6Z2zWAop4UoUFfrg22lRgOnJy0gmwEfmYEkPwte4Am4RHCo/gfM9kXDSGqMtWSGi8aWmTYQCgKowWijvUigsL/1Wf7JN9JxgFlo9QIoQ8g0cSa9mE5L4EnuPN9TJe6rbe7V+t9ZaLDFsQMHtbVyM6NPpekhLoGz9J2lNzYCqFs/DxIENFzI2nW/29YTuj7Zxb8oLtAuRY9/4PvKip4F5yhImRY7K4WiqOH15/goWTyczlow66N943NNXZ89fvL54QcZQIY2AHU1mkxmRaLBouBrd1C+j3223xR2sRwvVf7S79m3c452fGslFmKKCz+t+ALpmo102Ha+t84TVNCql12y9pjf4zsquI/LPLVqas+YJW3AreEZt/HrNCuHod7HZQT/q7Rdv+3X2CfztDfhBX4Y5RdGQsuCyDbtjwm5xtbeFd/MuGYYVMjZyPI8mHV6Snq2Ge8MvTVtR4jTP0fhHecfT5vmbi0uWsKzfoJuwojPLl7TT82W0VgeI4m5MtDWTXFUtr4g36qT5ior47nB2G4az/gd59SAeu1NbdIP+klMPCqzXcfDrug1/PPqoRA/swE3BmXdd9yc+jTvg",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},f=void 0,j={},D=[];function J(e){const t={p:"p",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Revoke Document"}),"\n",(0,s.jsx)(d(),{method:"post",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Revoke document API allows you to revoke specific document from your documents."}),"\n",(0,s.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(a(),{parameters:[{name:"document_id",in:"path",description:"Provide objectId of document to revoke",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}]}),"\n",(0,s.jsx)(u(),{title:"Body",body:{content:{"application/json":{schema:{type:"object",properties:{reason:{type:"string",example:""}},title:"revokedocument"}}}}}),"\n",(0,s.jsx)(m(),{id:void 0,label:void 0,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"}}}}}})]})}function g(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(J,{...e})}):J(e)}}}]); \ No newline at end of file diff --git a/assets/js/6d2e526e.9f2d8c5b.js b/assets/js/6d2e526e.9f2d8c5b.js new file mode 100644 index 000000000..9a1fb7970 --- /dev/null +++ b/assets/js/6d2e526e.9f2d8c5b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[5752],{50839:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>k,contentTitle:()=>y,default:()=>x,frontMatter:()=>v,metadata:()=>n,toc:()=>g});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(33617),r=o.n(i),d=o(17543),u=o.n(d),l=o(86013),a=o.n(l),p=o(63723),m=o.n(p),h=(o(18766),o(79329),o(9303));const v={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},y=void 0,k={},g=[];function f(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:"Request"}),"\n",(0,c.jsx)(u(),{parameters:[{name:"document_id",in:"path",description:"Provide objectId of document to revoke",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}]}),"\n",(0,c.jsx)(a(),{title:"Body",body:{content:{"application/json":{schema:{type:"object",properties:{reason:{type:"string",example:""}},title:"revokedocument"}}}}}),"\n",(0,c.jsx)(m(),{id:void 0,label:void 0,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"}}}}}})]})}function x(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,c.jsx)(t,{...e,children:(0,c.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/7357a3c5.56289604.js b/assets/js/7357a3c5.56289604.js deleted file mode 100644 index e21d74ea6..000000000 --- a/assets/js/7357a3c5.56289604.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1665],{13980:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>u,contentTitle:()=>b,default:()=>k,frontMatter:()=>g,metadata:()=>a,toc:()=>S});const a=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":"eJy9V8Fu5LgR/ZVaXrJjyN1tr2eT6BRjMfE6GcwYay8MxGMYlFSSOKZILlnqdqMhYA/5g5xyzafNlwRFtdRq2zOJk8Vc7BbJKr6qemQ9bgTJKoj0RvzZ6gK9uE1EgSH3ypGyRqTiqkY4Q4J+Hk4vzkFqbVcB1rYFsuCRvMIlQoEklQ4gM9sSSAgOc1WqHMpoOhOJsA69ZMfnhUhFhdRPiUQ46WWDhJ7BbISRDYpU9NN3qhCJUIzGSarFY4g2+4g5nRdgSxgdevylVR4LkZJvMRGB1ppdBtU4jSIR+OC0LVCkpdSBF+Q1NlKkG0FrF1eSV6YSiSitbyRNR/BBRi+pcD8eZXV+XLtMdN0tbxucNQEDOzpeLPjfPtrQ5jmGULYaxnSIROTWEBri9dI5rfI4Mf8Y2GjzFF0fNGfOsxtS/ZZDLl4cR32U1Q/HH53okm3a38UavMyNwdVQgi4WFQ31zHk5pL8cGxle36sLfOzrf0UW2myCLvcoCYtTes7VzvB4cfzd4dHicPH7q6Pv05M/pq+/ny0Wi7+JRDw0mm23ZC0kRaSkSE+/W1d8hX0mA9tT4zGIruOJk+d4eGkbpFqZClZoCFbemioBp1EGBPJrkJVUBrQk9N/8dgRF763/ciZehmwauTJaGbwbDuHdyWJxdzQm4eRpEvpUgbEEpW1NMfsKgX6JpU/xfDm8k7s/jOG9fhreuVlKrYp4a1/ZezRft5DT7anfnqHu01n1i+K82At2Ot4HGTBvvaJ17BEPh9Kpw34+vbnl25d5Y7etJTYVqkUq5n1W55uxnXSCffnl0G5ar0UqaiIX0vk8SFNk9mFmHZqgKqNlFma5bebSqfnyaHYkuuSxjXTuReuxPXypSSBZKVP9J7vbXZouuZR9tfaSNdZMOvVXXItkqMV01bbj1ijjfdnxd2mj8bZC7x2aS1WZWN+4+ePOfI06tw2yTKAaYTD49Pd/RZvC5m2DhiIBo4dvPpgP5n3rwdkVeu6R0hRQanxQmcZohE2cG/VHQNloDEGvQRnCyktCKFSlSGrgHPFFkksnM6UVk5eXWbb2MOF/mMF1jVSj56nfeQQJBS5RM+dBtmQbSexqAA0r6+9LVkIJSMjaoAyGAGhqaXJeOFQhAetBGkBD6J1XASGQZ9Sqx2YNeZkTNNLICtl3speqArViqoK3WRsIgtVthAwsuKzHAoaADGIRZpzENyxvPAKP5rZxHmumzBKhalWBIYHcFgghnlUOwRSQYSBwjEXlGNhpa7TN72PxylZrcJavDiU1a60pRjYnL03g263HMtRgTJjzlpUP9gAPDn4OyBV+q8x9SA8OPphDuBk5dY1ZUIS33w70X61WT2j/at/mTNGPbQY/obNBkfXrnXWlqG6zeFSmTsaP3tMZGoz8mRyEnY/C5uHpyePReY3azS+RmCFhfnpxHm/bV/Dp13/AW5TeQG1XPVvz1qNeQzVsxZnrK9+nbbwsobSReDVnPO/Jx6oWAw0ZvK4lffr1nwHe4QpUf4T6RB4cXLSZVjlcYeO4U4aDgxR+iJIHaBgDqiVBLg1kCKGWTKWlkiDB9dZamfsZnJo1tAE9rBTVkQw8Hu32wuC8jOUOkMmABVgTLYY9ZztEPN4E1EsM7IubXoaAhSJmdO1tW/W7TcFsg/NYKq3hWhUVUozttCjAbYdX/TAnfAIHSz4QVOMapEcIaGgGF49M4kzrnPWMQvXgS8tPHi4AmsJZZSikUHhZ0s5/siN6VJbKmmeG+hTKMR3J1s1Ykv4kbiMeR2cf+EJ+dInv37UeS/S8YQx7VxentnS6GWgJzNb/h9ZRPVtDMo8qAhupdN9N/vTYT+zo6JvwvrxEv1Q5bjvaZ070PC6ei0RolaMJOFEKp2cXb2H53Wwhkklr/C8O9/zt+Q9v3l2+YTB8kfYJO5otZov4tLCBGmkmO+0evI9b2mYnn37bp/G2IxM+0NxpqaIWilFutjrmRoyP23T3ML5NRG0D8fRmwyfuZ6+7jod/adGzUrpNxFJ6JTNu2jcbUajAv4vx5fvZAL/9afuIfgXPvrGfxTxIC8O6Yil1y18iEfe43nvRd7ddMqgLhtXPn+Y5OppYPpGoezrv7M2VSARfkvuq5j6qmu0P9v4sqn250wPgv6y9njXYbHrF1HXj+n7qsxbbAIfVnKLbruv+DQvgGZI=","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 o=n(74848),r=n(28453),i=n(33617),d=n.n(i),l=n(17543),s=n.n(l),p=n(86013),f=n.n(p),c=n(63723),m=n.n(c),v=(n(18766),n(79329),n(9303));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:"eJy9V8Fu5LgR/ZVaXrJjyN1tr2eT6BRjMfE6GcwYay8MxGMYlFSSOKZILlnqdqMhYA/5g5xyzafNlwRFtdRq2zOJk8Vc7BbJKr6qemQ9bgTJKoj0RvzZ6gK9uE1EgSH3ypGyRqTiqkY4Q4J+Hk4vzkFqbVcB1rYFsuCRvMIlQoEklQ4gM9sSSAgOc1WqHMpoOhOJsA69ZMfnhUhFhdRPiUQ46WWDhJ7BbISRDYpU9NN3qhCJUIzGSarFY4g2+4g5nRdgSxgdevylVR4LkZJvMRGB1ppdBtU4jSIR+OC0LVCkpdSBF+Q1NlKkG0FrF1eSV6YSiSitbyRNR/BBRi+pcD8eZXV+XLtMdN0tbxucNQEDOzpeLPjfPtrQ5jmGULYaxnSIROTWEBri9dI5rfI4Mf8Y2GjzFF0fNGfOsxtS/ZZDLl4cR32U1Q/HH53okm3a38UavMyNwdVQgi4WFQ31zHk5pL8cGxle36sLfOzrf0UW2myCLvcoCYtTes7VzvB4cfzd4dHicPH7q6Pv05M/pq+/ny0Wi7+JRDw0mm23ZC0kRaSkSE+/W1d8hX0mA9tT4zGIruOJk+d4eGkbpFqZClZoCFbemioBp1EGBPJrkJVUBrQk9N/8dgRF763/ciZehmwauTJaGbwbDuHdyWJxdzQm4eRpEvpUgbEEpW1NMfsKgX6JpU/xfDm8k7s/jOG9fhreuVlKrYp4a1/ZezRft5DT7anfnqHu01n1i+K82At2Ot4HGTBvvaJ17BEPh9Kpw34+vbnl25d5Y7etJTYVqkUq5n1W55uxnXSCffnl0G5ar0UqaiIX0vk8SFNk9mFmHZqgKqNlFma5bebSqfnyaHYkuuSxjXTuReuxPXypSSBZKVP9J7vbXZouuZR9tfaSNdZMOvVXXItkqMV01bbj1ijjfdnxd2mj8bZC7x2aS1WZWN+4+ePOfI06tw2yTKAaYTD49Pd/RZvC5m2DhiIBo4dvPpgP5n3rwdkVeu6R0hRQanxQmcZohE2cG/VHQNloDEGvQRnCyktCKFSlSGrgHPFFkksnM6UVk5eXWbb2MOF/mMF1jVSj56nfeQQJBS5RM+dBtmQbSexqAA0r6+9LVkIJSMjaoAyGAGhqaXJeOFQhAetBGkBD6J1XASGQZ9Sqx2YNeZkTNNLICtl3speqArViqoK3WRsIgtVthAwsuKzHAoaADGIRZpzENyxvPAKP5rZxHmumzBKhalWBIYHcFgghnlUOwRSQYSBwjEXlGNhpa7TN72PxylZrcJavDiU1a60pRjYnL03g263HMtRgTJjzlpUP9gAPDn4OyBV+q8x9SA8OPphDuBk5dY1ZUIS33w70X61WT2j/at/mTNGPbQY/obNBkfXrnXWlqG6zeFSmTsaP3tMZGoz8mRyEnY/C5uHpyePReY3azS+RmCFhfnpxHm/bV/Dp13/AW5TeQG1XPVvz1qNeQzVsxZnrK9+nbbwsobSReDVnPO/Jx6oWAw0ZvK4lffr1nwHe4QpUf4T6RB4cXLSZVjlcYeO4U4aDgxR+iJIHaBgDqiVBLg1kCKGWTKWlkiDB9dZamfsZnJo1tAE9rBTVkQw8Hu32wuC8jOUOkMmABVgTLYY9ZztEPN4E1EsM7IubXoaAhSJmdO1tW/W7TcFsg/NYKq3hWhUVUozttCjAbYdX/TAnfAIHSz4QVOMapEcIaGgGF49M4kzrnPWMQvXgS8tPHi4AmsJZZSikUHhZ0s5/siN6VJbKmmeG+hTKMR3J1s1Ykv4kbiMeR2cf+EJ+dInv37UeS/S8YQx7VxentnS6GWgJzNb/h9ZRPVtDMo8qAhupdN9N/vTYT+zo6JvwvrxEv1Q5bjvaZ070PC6ei0RolaMJOFEKp2cXb2H53Wwhkklr/C8O9/zt+Q9v3l2+YTB8kfYJO5otZov4tLCBGmkmO+0evI9b2mYnn37bp/G2IxM+0NxpqaIWilFutjrmRoyP23T3ML5NRG0D8fRmwyfuZ6+7jod/adGzUrpNxFJ6JTNu2jcbUajAv4vx5fvZAL/9afuIfgXPvrGfxTxIC8O6Yil1y18iEfe43nvRd7ddMqgLhtXPn+Y5OppYPpGoezrv7M2VSARfkvuq5j6qmu0P9v4sqn250wPgv6y9njXYbHrF1HXj+n7qsxbbAIfVnKLbruv+DQvgGZI=",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,u={},S=[];function R(e){const t={p:"p",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(v.default,{as:"h1",className:"openapi__heading",children:"Get Folder"}),"\n",(0,o.jsx)(d(),{method:"get",path:"/folder/{folder_id}",context:"endpoint"}),"\n",(0,o.jsx)(t.p,{children:"The Get Folder API allows you to retrieve details about a specific folder."}),"\n",(0,o.jsx)(v.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,o.jsx)(s(),{parameters:[{name:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}]}),"\n",(0,o.jsx)(f(),{title:"Body",body:void 0}),"\n",(0,o.jsx)(m(),{id:void 0,label:void 0,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"}}}}}})]})}function k(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(R,{...e})}):R(e)}}}]); \ No newline at end of file diff --git a/assets/js/7357a3c5.6005cc6b.js b/assets/js/7357a3c5.6005cc6b.js new file mode 100644 index 000000000..f6a9ef0b3 --- /dev/null +++ b/assets/js/7357a3c5.6005cc6b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1665],{13980:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>j,contentTitle:()=>g,default:()=>k,frontMatter:()=>m,metadata:()=>o,toc:()=>x});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),i=n(28453),a=n(33617),d=n.n(a),l=n(17543),r=n.n(l),p=n(86013),c=n.n(p),f=n(63723),h=n.n(f),u=(n(18766),n(79329),n(9303));const m={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},g=void 0,j={},x=[];function y(e){const t={p:"p",...(0,i.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)(d(),{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:"Request"}),"\n",(0,s.jsx)(r(),{parameters:[{name:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}]}),"\n",(0,s.jsx)(c(),{title:"Body",body:void 0}),"\n",(0,s.jsx)(h(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{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"}}}}}})]})}function k(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/7ad5624c.2ce1b623.js b/assets/js/7ad5624c.2ce1b623.js new file mode 100644 index 000000000..638606364 --- /dev/null +++ b/assets/js/7ad5624c.2ce1b623.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[33],{82903:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>v,contentTitle:()=>V,default:()=>P,frontMatter:()=>g,metadata:()=>o,toc:()=>y});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":"eJy9V91uG7cSfpUpb9oIa/04boruVY0gcI0TNEbtwEAdweDujnYZc0mWnJUsCAJ60TfoVW/Po+VJDoa7K61sp+e4pwhgyNJwZjj/83EjSJZBpDfitTUkcwpinogCQ+6VI2WNSMVVhXCGBB0HnF6cg9TargKsbQNkwSN5hUuEAkkqHUBmtiGQEBzmaqFyyFvZsUiEdeglqz4vRCpKpO5MJMJJL2sk9GzRRhhZo0hFd36rCpEIxRY5SZV4aKbNPmJO5wXYBexVevy1UR4LkZJvMBGB1pqVBlU7jSIReO+0LVCkC6kDM+QV1lKkG0FrFznJK1OKRCysryUNKXgvo5ZUuB9nWZUfVy4T2+2crw3OmoCBFR1Pp/zv0NzQ5DmGsGg07CIikugsGmJ+6ZxWeTyYfAwstHlsXes1x86zGlLtlX0wnu1HNcuq++OPTmyTLv7PU/DRImSILI61VPpvyGeIP3SEcW5rVuUqa55tysns5ew4/rGK3KMkLE7pKTV7oePp8cuj2fRo+t3V7FV68n367avxdDr9RSTivo7edFVZSIpekiI9/N244gvcs33I1lV814BDgb4XtluWOnmqFi9tjVQpU8IKDcHKW1Mm4DTKgEB+DbKUyoCWhP6rf65I0Xvr/zpMz7NsO3BbGa0M3vaNeHsynd7OdkE4eRyEfrwZS7CwjSm+rKdPXP/X7pzcHu/c+faxO+dmKbUq4rS+sndovqw7w+upvf5x0aqWKZ6LA2eH9NbJgHnjFa3jZrg/kk4dtefpzZwnLteJ7TZKXCVUiVRMuuqfbPZbZCtYm1/2a6bxWqSiInIhnUyCNEVm78fWoQmqNFpmgcfQRDo1Wc7GPEweykjnnsWPzdFzRQLJUpnyv8nN94G65GS2+ToI1y5r0ql/4Vr0c/6Aq1u0FcoCfcycMgsbhbscvXNoLlVpYobj5Q8X8jXq3NbIAIEqhNGoF/n0+793UqMRFDZvajQUa3H8wXww7xoPzq7Q83aUpoCFxnuVaYxiWMezHfoIKGuNIeg1KENYekkIhSoVSQ0cJx4fuXQyU1pxCTObZWkPgy4IY7iukCr0fPS1R5BQ4BI1Vz7IhmwtiVX19sLK+rsF46AEJGRNUAZDADSVNDkz9plIwHqQBtAQeudVQAjk2WrV2mYNee79WhpZIutOYBisArXicgVvsyYQBKubaDLwtLceC+gdMohFiEF8w8DGIzA1t7XzWHHZLBHKRhUYEshtgRBix7ILpoAMA4FjW1SOgZU2Rtv8LiZw0WgNzvIAUVIzzBrayOLkpQm8kltb+hzsAua8ZcyDrYGj0fuAnOG3ytyFdDT6YI7gZldX15gFRTj/pm+B1Wr1qPRfHMqcKfqxyeBndDYosn69ly4VVU0W22WoZPej1XSGBmP9DJphr6OweXjcfUydVKjd5BKJKyRMTi/O48x9AZ9++wPeovQGKrtqqzVvPOo1lP1VHLk2823YdiMTFjYWXsURz9viYzyLgfoIXleSPv32Z4CfcAXKdC3FroxGF02mVQ5XWDvej2E0SuF1REFAPQ2okgS5NJAhhEpyKS2VBAmuldbK3I3h1KyhCehhpaiKxcD0KHfgBsdll+4AmQxYgDVRor9zvLeI6XVAvcTAunj1ZQhYKOKKrrxtyva2oTGdcx4XSmu4VkWJFH07LQpwHXnVkjngA3NwwQ1BFa5BeoSAhsZw8UAknjTOWc9WqNb4heUHDycATeGsMhRSKLxc0F5/si/0CDaVNU+Q2hDKXTiSTs0uJW0ndh7vqOMPPJQfDPLDeetxgZ4vjG7v8+JUV043fVkCV+v/U9YRUHe4kvFAi/R5o/zwUE/c6+jr8G5xiX6pcuy22mc6ehKZJyIRWuVoAg7wwunZxVtYvhxPRTJYj/9Dc0/enr9+89PlGzaGB2kbsNl4Op7G54UNVEszuGnw3n241zZ7FPVPP427xUx4TxOnpYqgKDq66QDNjdg/bdPBw3ieiMoGYobNhtvuvdfbLZN/bdAzaJonYim9khlv75uNKFTg78Xu4ftZJ7/5uXtDv4Cn39hPmt2DDMMIYyl1w79EIu5wffim3863SQ802LCW4TTP0dFA9BFePQB9Z2+uRCJ4Vh4CnLsIcLovrP1Jsw6RT2sAfzIMe1Jgs2nB03a742+PPivROdhzc4zm2+32P/cOGkc=","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":"Delete Contact","permalink":"/docs/API-docs/v1.1/deletecontact"}}');var a=n(74848),c=n(28453),s=n(33617),i=n.n(s),r=n(17543),p=n.n(r),d=n(86013),l=n.n(d),u=n(63723),m=n.n(u),h=(n(18766),n(79329),n(9303));const g={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:"eJy9V91uG7cSfpUpb9oIa/04boruVY0gcI0TNEbtwEAdweDujnYZc0mWnJUsCAJ60TfoVW/Po+VJDoa7K61sp+e4pwhgyNJwZjj/83EjSJZBpDfitTUkcwpinogCQ+6VI2WNSMVVhXCGBB0HnF6cg9TargKsbQNkwSN5hUuEAkkqHUBmtiGQEBzmaqFyyFvZsUiEdeglqz4vRCpKpO5MJMJJL2sk9GzRRhhZo0hFd36rCpEIxRY5SZV4aKbNPmJO5wXYBexVevy1UR4LkZJvMBGB1pqVBlU7jSIReO+0LVCkC6kDM+QV1lKkG0FrFznJK1OKRCysryUNKXgvo5ZUuB9nWZUfVy4T2+2crw3OmoCBFR1Pp/zv0NzQ5DmGsGg07CIikugsGmJ+6ZxWeTyYfAwstHlsXes1x86zGlLtlX0wnu1HNcuq++OPTmyTLv7PU/DRImSILI61VPpvyGeIP3SEcW5rVuUqa55tysns5ew4/rGK3KMkLE7pKTV7oePp8cuj2fRo+t3V7FV68n367avxdDr9RSTivo7edFVZSIpekiI9/N244gvcs33I1lV814BDgb4XtluWOnmqFi9tjVQpU8IKDcHKW1Mm4DTKgEB+DbKUyoCWhP6rf65I0Xvr/zpMz7NsO3BbGa0M3vaNeHsynd7OdkE4eRyEfrwZS7CwjSm+rKdPXP/X7pzcHu/c+faxO+dmKbUq4rS+sndovqw7w+upvf5x0aqWKZ6LA2eH9NbJgHnjFa3jZrg/kk4dtefpzZwnLteJ7TZKXCVUiVRMuuqfbPZbZCtYm1/2a6bxWqSiInIhnUyCNEVm78fWoQmqNFpmgcfQRDo1Wc7GPEweykjnnsWPzdFzRQLJUpnyv8nN94G65GS2+ToI1y5r0ql/4Vr0c/6Aq1u0FcoCfcycMgsbhbscvXNoLlVpYobj5Q8X8jXq3NbIAIEqhNGoF/n0+793UqMRFDZvajQUa3H8wXww7xoPzq7Q83aUpoCFxnuVaYxiWMezHfoIKGuNIeg1KENYekkIhSoVSQ0cJx4fuXQyU1pxCTObZWkPgy4IY7iukCr0fPS1R5BQ4BI1Vz7IhmwtiVX19sLK+rsF46AEJGRNUAZDADSVNDkz9plIwHqQBtAQeudVQAjk2WrV2mYNee79WhpZIutOYBisArXicgVvsyYQBKubaDLwtLceC+gdMohFiEF8w8DGIzA1t7XzWHHZLBHKRhUYEshtgRBix7ILpoAMA4FjW1SOgZU2Rtv8LiZw0WgNzvIAUVIzzBrayOLkpQm8kltb+hzsAua8ZcyDrYGj0fuAnOG3ytyFdDT6YI7gZldX15gFRTj/pm+B1Wr1qPRfHMqcKfqxyeBndDYosn69ly4VVU0W22WoZPej1XSGBmP9DJphr6OweXjcfUydVKjd5BKJKyRMTi/O48x9AZ9++wPeovQGKrtqqzVvPOo1lP1VHLk2823YdiMTFjYWXsURz9viYzyLgfoIXleSPv32Z4CfcAXKdC3FroxGF02mVQ5XWDvej2E0SuF1REFAPQ2okgS5NJAhhEpyKS2VBAmuldbK3I3h1KyhCehhpaiKxcD0KHfgBsdll+4AmQxYgDVRor9zvLeI6XVAvcTAunj1ZQhYKOKKrrxtyva2oTGdcx4XSmu4VkWJFH07LQpwHXnVkjngA3NwwQ1BFa5BeoSAhsZw8UAknjTOWc9WqNb4heUHDycATeGsMhRSKLxc0F5/si/0CDaVNU+Q2hDKXTiSTs0uJW0ndh7vqOMPPJQfDPLDeetxgZ4vjG7v8+JUV043fVkCV+v/U9YRUHe4kvFAi/R5o/zwUE/c6+jr8G5xiX6pcuy22mc6ehKZJyIRWuVoAg7wwunZxVtYvhxPRTJYj/9Dc0/enr9+89PlGzaGB2kbsNl4Op7G54UNVEszuGnw3n241zZ7FPVPP427xUx4TxOnpYqgKDq66QDNjdg/bdPBw3ieiMoGYobNhtvuvdfbLZN/bdAzaJonYim9khlv75uNKFTg78Xu4ftZJ7/5uXtDv4Cn39hPmt2DDMMIYyl1w79EIu5wffim3863SQ802LCW4TTP0dFA9BFePQB9Z2+uRCJ4Vh4CnLsIcLovrP1Jsw6RT2sAfzIMe1Jgs2nB03a742+PPivROdhzc4zm2+32P/cOGkc=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},V=void 0,v={},y=[];function I(e){const t={p:"p",...(0,c.R)(),...e.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)(t.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:"Request"}),"\n",(0,a.jsx)(p(),{parameters:[{name:"contact_id",in:"path",description:"objectId of contact",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}]}),"\n",(0,a.jsx)(l(),{title:"Body",body:void 0}),"\n",(0,a.jsx)(m(),{id:void 0,label:void 0,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"},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"}}}}}})]})}function P(e={}){const{wrapper:t}={...(0,c.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(I,{...e})}):I(e)}}}]); \ No newline at end of file diff --git a/assets/js/7ad5624c.6ad534f5.js b/assets/js/7ad5624c.6ad534f5.js deleted file mode 100644 index 3ad40f188..000000000 --- a/assets/js/7ad5624c.6ad534f5.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[33],{82903:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>X,contentTitle:()=>m,default:()=>h,frontMatter:()=>g,metadata:()=>a,toc:()=>y});const a=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":"eJy9V81u5DYSfpUKL5sx5P7xOFmsTjEGA8fIIGPEDgysp2FQUrXEMUUyZKnbjYaAHPYN9rTXfbR5kkVRUrfa9mTjJBjAaHcXq4r189UPt4JkGUR6K95YQzKnIBaJKDDkXjlS1ohUXFcI50jQc8DZ5QVIre06wMY2QBY8kle4QiiQpNIBZGYbAgnBYa6WKoe8k52IRFiHXrLqi0KkokTqz0QinPSyRkLPFm2FkTWKVPTnd6oQiVBskZNUicdm2uwj5nRRgF3CXqXHXxrlsRAp+QYTEWijWWlQtdMoEoEPTtsCRbqUOjBDXmEtRboVtHGRk7wypUjE0vpa0piCDzJqSYX7fp5V+UnlMtG2C742OGsCBlZ0Mpvxv0NzQ5PnGMKy0bCLiEiis2iI+aVzWuXxYPoxsND2qXWd1xw7z2pIdVcOwXixH9U8qx5OPjrRJn38X6bgo0XIEFkca6n0H5DPEL/rCZPc1qzKVda82JTT+ev5SfxjFblHSVic0XNq9kIns5PXx/PZ8ezv1/Nv09N/pN98O5nNZv8UiXioozc9KgtJ0UtSpMe/G1d8gXvax2w94vsCHAsMtdC2LHX6HBavbI1UKVPCGg3B2ltTJuA0yoBAfgOylMqAloT+q78OpOi99b8dppdZ1o7cVkYrg3dDId6dzmZ3810QTp8GYWhvxhIsbWOKL+vpM9f/tjundyc7d7556s6FWUmtititr+09mi/rzvh66q5/ClrVMcVzceDsmN45GTBvvKJNnAwPx9Kp4+48vV1wx2Wc2H6ixFFClUjFtEf/dLufIq1gbX41jJnGa5GKisiFdDoN0hSZfZhYhyao0miZBW5DU+nUdDWfcDN5LCOdexE/NscvFQkkS2XK/ye32AfqipPZ5esgXLusSad+wI0Y+vwBVz9oK5QF+pg5ZZY2Cvc5eu/QXKnSxAzHyx8P5BvUua2RFwSqEAaBT//6b5QpbN7UaChCMGr46oP5YN43Hpxdo+fJKE0BS40PKtMYhbCOZ7vNI6CsNYagN6AMYeklIRSqVCQ1cIy4deTSyUxpxfBlNsvSHkYVECZwUyFV6Pnobx5BQoEr1Ix6kA3ZWhKrGoyGtfX3S96BEpCQNUEZDAHQVNLkzDhkIQHrQRpAQ+idVwEhkGerVWebNeS57mtpZImsOzkIVYFaMVTB26wJBMHqJpoM3OmtxwIGhwxiESYcxLe81HgEpua2dh4rhswKoWxUgSGB3BYIIVYru2AKyDAQOLZF5RhYaWO0ze9j8paN1uAsNw8lNa9YYxtZnLw0gcdxZ8uQg13AnLe872Bn4NHRzwE5w++UuQ/p0dEHcwy3O0zdYBYU4eLrAf7r9foJ7F8dypwr+r7J4Cd0NiiyfrOXLhVVTRZLZaxk96PTdI4GI35GhbDXUdg8PK08pk4r1G56hcQICdOzy4vYb1/Bp1//De9QegOVXXdozRuPegPlcBVHrst8F7Zdu4SljcCrOOJ5Bz7eZTHQEMGbStKnX/8T4Edcg+pKqAvk0dFlk2mVwzXWjmdjODpK4U3cgIAGGlAlCXJpIEMIlWQorZQECa6T1srcT+DMbKAJ6GGtqIpgYHqUO3CD47JLd4BMBizAmigx3DnZW8T0OqBeYWBdPPYyBCwUMaIrb5uyu21sTO+cx6XSGm5UUSJF386KAlxPXndkDvjIHFxyQVCFG5AeIaChCVw+EoknjXPWsxWqM35p+bHDCUBTOKsMhRQKL5e015/sgR4XTWXNM6QuhHIXjqRXs0tJV4m9xzvq5AM35EdN/LDXelyi5wuj2/u8ONXD6XaAJTBa/wys4zLd75S8C3RbPk+T7x7riTMdfR3eL6/Qr1SO/UT7TEVPI/NUJEKrHE3A0a5wdn75DlavJzORjEbj7yju6buLN29/vHrLxnAj7QI2n8wms/i0sIFqaUY3jd66j2fadr9B/dXP4n4oEz7Q1Gmp4kIUHd32y8yt2D9r09GjeJGIygZihu2Wy+5nr9uWyb806HlhWiRiJb2SGU/u260oVODvxe7R+1knv/6pfz+/guff18+aPSwYhreLldQN/xKJuMfN4Xu+XbTJsGSwYR3DWZ6jo5Hok131YOE7f3stEsG98nC5uY/LTf+FtT9r1uHW0xnAn7yCPSuw3XaLU9vu+Lujz0r0Dg7cHKNF27b/AyPAGZI=","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":"Delete Contact","permalink":"/docs/API-docs/v1.1/deletecontact"}}');var o=n(74848),i=n(28453),s=n(33617),c=n.n(s),r=n(17543),d=n.n(r),p=n(86013),l=n.n(p),x=n(63723),u=n.n(x),I=(n(18766),n(79329),n(9303));const g={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:"eJy9V81u5DYSfpUKL5sx5P7xOFmsTjEGA8fIIGPEDgysp2FQUrXEMUUyZKnbjYaAHPYN9rTXfbR5kkVRUrfa9mTjJBjAaHcXq4r189UPt4JkGUR6K95YQzKnIBaJKDDkXjlS1ohUXFcI50jQc8DZ5QVIre06wMY2QBY8kle4QiiQpNIBZGYbAgnBYa6WKoe8k52IRFiHXrLqi0KkokTqz0QinPSyRkLPFm2FkTWKVPTnd6oQiVBskZNUicdm2uwj5nRRgF3CXqXHXxrlsRAp+QYTEWijWWlQtdMoEoEPTtsCRbqUOjBDXmEtRboVtHGRk7wypUjE0vpa0piCDzJqSYX7fp5V+UnlMtG2C742OGsCBlZ0Mpvxv0NzQ5PnGMKy0bCLiEiis2iI+aVzWuXxYPoxsND2qXWd1xw7z2pIdVcOwXixH9U8qx5OPjrRJn38X6bgo0XIEFkca6n0H5DPEL/rCZPc1qzKVda82JTT+ev5SfxjFblHSVic0XNq9kIns5PXx/PZ8ezv1/Nv09N/pN98O5nNZv8UiXioozc9KgtJ0UtSpMe/G1d8gXvax2w94vsCHAsMtdC2LHX6HBavbI1UKVPCGg3B2ltTJuA0yoBAfgOylMqAloT+q78OpOi99b8dppdZ1o7cVkYrg3dDId6dzmZ3810QTp8GYWhvxhIsbWOKL+vpM9f/tjundyc7d7556s6FWUmtititr+09mi/rzvh66q5/ClrVMcVzceDsmN45GTBvvKJNnAwPx9Kp4+48vV1wx2Wc2H6ixFFClUjFtEf/dLufIq1gbX41jJnGa5GKisiFdDoN0hSZfZhYhyao0miZBW5DU+nUdDWfcDN5LCOdexE/NscvFQkkS2XK/ye32AfqipPZ5esgXLusSad+wI0Y+vwBVz9oK5QF+pg5ZZY2Cvc5eu/QXKnSxAzHyx8P5BvUua2RFwSqEAaBT//6b5QpbN7UaChCMGr46oP5YN43Hpxdo+fJKE0BS40PKtMYhbCOZ7vNI6CsNYagN6AMYeklIRSqVCQ1cIy4deTSyUxpxfBlNsvSHkYVECZwUyFV6Pnobx5BQoEr1Ix6kA3ZWhKrGoyGtfX3S96BEpCQNUEZDAHQVNLkzDhkIQHrQRpAQ+idVwEhkGerVWebNeS57mtpZImsOzkIVYFaMVTB26wJBMHqJpoM3OmtxwIGhwxiESYcxLe81HgEpua2dh4rhswKoWxUgSGB3BYIIVYru2AKyDAQOLZF5RhYaWO0ze9j8paN1uAsNw8lNa9YYxtZnLw0gcdxZ8uQg13AnLe872Bn4NHRzwE5w++UuQ/p0dEHcwy3O0zdYBYU4eLrAf7r9foJ7F8dypwr+r7J4Cd0NiiyfrOXLhVVTRZLZaxk96PTdI4GI35GhbDXUdg8PK08pk4r1G56hcQICdOzy4vYb1/Bp1//De9QegOVXXdozRuPegPlcBVHrst8F7Zdu4SljcCrOOJ5Bz7eZTHQEMGbStKnX/8T4Edcg+pKqAvk0dFlk2mVwzXWjmdjODpK4U3cgIAGGlAlCXJpIEMIlWQorZQECa6T1srcT+DMbKAJ6GGtqIpgYHqUO3CD47JLd4BMBizAmigx3DnZW8T0OqBeYWBdPPYyBCwUMaIrb5uyu21sTO+cx6XSGm5UUSJF386KAlxPXndkDvjIHFxyQVCFG5AeIaChCVw+EoknjXPWsxWqM35p+bHDCUBTOKsMhRQKL5e015/sgR4XTWXNM6QuhHIXjqRXs0tJV4m9xzvq5AM35EdN/LDXelyi5wuj2/u8ONXD6XaAJTBa/wys4zLd75S8C3RbPk+T7x7riTMdfR3eL6/Qr1SO/UT7TEVPI/NUJEKrHE3A0a5wdn75DlavJzORjEbj7yju6buLN29/vHrLxnAj7QI2n8wms/i0sIFqaUY3jd66j2fadr9B/dXP4n4oEz7Q1Gmp4kIUHd32y8yt2D9r09GjeJGIygZihu2Wy+5nr9uWyb806HlhWiRiJb2SGU/u260oVODvxe7R+1knv/6pfz+/guff18+aPSwYhreLldQN/xKJuMfN4Xu+XbTJsGSwYR3DWZ6jo5Hok131YOE7f3stEsG98nC5uY/LTf+FtT9r1uHW0xnAn7yCPSuw3XaLU9vu+Lujz0r0Dg7cHKNF27b/AyPAGZI=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},m=void 0,X={},y=[];function b(e){const t={p:"p",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(I.default,{as:"h1",className:"openapi__heading",children:"Get Contact"}),"\n",(0,o.jsx)(c(),{method:"get",path:"/contact/{contact_id}",context:"endpoint"}),"\n",(0,o.jsx)(t.p,{children:"The Get Contact API allows you to retrieve details about a specific contact."}),"\n",(0,o.jsx)(I.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,o.jsx)(d(),{parameters:[{name:"contact_id",in:"path",description:"objectId of contact",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}]}),"\n",(0,o.jsx)(l(),{title:"Body",body:void 0}),"\n",(0,o.jsx)(u(),{id:void 0,label:void 0,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"},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"}}}}}})]})}function h(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/7ef59f7a.4a732e7a.js b/assets/js/7ef59f7a.4a732e7a.js new file mode 100644 index 000000000..a7350692c --- /dev/null +++ b/assets/js/7ef59f7a.4a732e7a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4865],{84605:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>g,contentTitle:()=>x,default:()=>b,frontMatter:()=>y,metadata:()=>o,toc:()=>h});const o=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":"eJy9GdtuGzf2V87ypY0wluRLkq6earSp627QGLUDA+sYAmfmzAxjDsmSHMmCIKAP+wf7tK/9tHzJ4nAuGsmKHaVpXmyJPPcbzzlaMs9zxyY37EedVCUq79htxFJ0iRXGC63YhF0VCGfooQWB04tzQMVjiQ4WugKvwaK3AmcIKXoupAMe68oDB2cwEZlIIG2whyxi2qDlRP08ZROWo28vWcQMt7xEj5bEWjLFS2QT1gJMRcoiJkgsw33BtmXV8XtM/HkKOuvkZRGz+HslLKZs4m2FEXN+IYmsE6WRyCKG90bqFNkk49IRQFJgydlkyfzCBEhvhcpZxDJtS+77J3jPA5UJMz8fxkVyVJiYrVa3xNYZrRw6InQ0HtO/TXldlSToXFZJ6IzCIpZo5UnyyZJxY6RIwsXovSOk5UPparXJepbIeFGzdJ77yu2rhVAHxurconNsFXUm3ZfMT2fi7ug4Lt7+QlQyQYf7USi8N24yGjUnlZXDRJdELSEdMzLLZxPtkegR9sLvL6cLHyjCiYTS+wtlJHKH4ESuukQJVtMyRfu0o7+Mj+pc249CLSEE1NXagOuEbVSgQJqrDV0+if57jRAjEj5ZJ5SFjgK3li+oHngs3dNWsnq3b9fcEtSPGWKnWFhyIZ+EjhG/bw7aWDOFVk+wOXn+4ujw+LuXhwQ/F2mO/i/oX9/uZ3+P9z7W90FenvfRVVXGaPvo3UmHfriK2P2eOEcnJ6uILfbEekms5nsiHX+3ilixJ9LJC4rlUMA/weafk1OdzVf9jPJYGsk9Ti/rPJi28fAoVEhKhyo9V2/sZi2JtZbIVZ81vY5UXi1yj+mpfzw6j8ZHxweH44Pxy6vDF5OTf06evxiOx+N/s4jdl3KtPUupTveLQ/O9MulX4VM3K1e6+jT1LabCYuKnld2Z2I/5jthxKfV8Wuq0fl+2AmUH39B0EGKVCj/1drOg7Jnln12PZgLnuPMJ+YKuCEX872Wy4xWaC1/UzdC0b+MA2iaMeEKqHiAIB1rJBfAZF5JiC+YFKvAFds83wTR5BJnVJXBoKQxDkFReTy2WQj2ZlW141NBTrRKcCjXFGdqdZbJDHJOCWyZ7YBH2qL2aInSyq3m91CX6Qqgc5qTw3GqVR9D0Mt4ugOdcKCCV7T++XFeL1uqdfcTaV/tJ1o8YoaRQOG079+nJeDw97Ixw8tAI3VSktIdMVyr9uqru4v+4QifT406h5w8VOlczLkUaprwrfYfq6+rTZ+9r9g+jWNRA4Z5tKNs/r5V0mFRW+EUYJ+8PuBEH9f3k5paGNIoU3cyhYf70BZuwUZsKo2Vv9lwxomdn7XQaHohupHBcpbG+H2qDiuqc5LGj4jriRoxmh0Pq4rZxuDF7wWN1sC+K8zwXKn8K73ZtqktyZ+2xDYOtnyQj/oX0JjX+6EM143mBPPT9K/qe6YDceOmNQUXtSfBxYL49xl+jTHSJtFmgmjoYtCgf/vNnhzUYdMU2ROPwnXqn3lQWjJ6jpZGaqxQyifeCKnTYWpThrltbOOSlROfkAoTymFvuEVKRC89lmMaohCTc8FhIQUFMYJqwLfTywA3hukBfoKWrbywChxRnKCn2gSp9yT2R6h6HubZ3mdRzFwGHuHJCoXOAquAqIcDWExFoC1wBKo/WWEFDorcktahl08pbnngoueI5Eu0I+sZKUQoKV7A6rpwHp2UVRAba02iLKbQKKcTUBSO+om2IRaDTRJfGYkFhM0PIK5GiiyDRKUI995IKKoUYnQdDsogEHRGtlNTJXXBgVkkJRlMJEVzScqYvI6F7y5WjxqqWpfVBZzBjNS1KsBZwMHjrkDz8Wqg7NxkM3qkDuOni6hpjJzzeftumwHw+fxD6zzZxzoT/uYrhNzTaCa/tYo2dC19UcUiXPpHuS03pDBWG+Oklw5pGqhP3MPvodFSgNKNL9BQhbnR6cR6q7jP48Md/4TVyq6DQ8zpak8qiXEDesiLL1Z6vzdYVTch0CLyCLJ7UwUdLMHS+teB1wf2HP/7n4Fecg1BNSpEqg8FFFUuRwFXTsLjBYAI/hGama2Ic+IJ7SLiCGMEVnEJpJjhwMDW2FOpuCKdqAZVDC9RThGCg84C3ocbG7sNBzB2moOueqmuc1hLReelQztARLXr8YgRMBfVbvrC6ymtufWEa5SxmQkq4rucn0u00TcE0x81YRQbviYMZJYQvcAHcIjjaZMLFFkq4qYzRlqQQtfCZpnGAHIAqNVoo7yaQWp75Nf1oHeihZxRa7TiqTbjuI6OGTOeSOhMbjbvT4TsqyluFfLPeWszQEsOg9tovRjThdNOGJVC0/pWwDus7rTxPfG9aoRfl+2064WVHW7o32SXamUja/d1HMnoUgEcsYlIkqBz2OobTs4vXMDsejlnUex4/IblHr89/ePXr5aswIaF1tcEOh+PhOCxFtPMlVz1O/VX59sO2XDdSf8NavXmcaX0wMpKL0Bo1M2zd1tyw3qZ90l+q30as0M4TyHJJyffWytWKjn+vwphxcxuxGbeC5Au9TyocfU67nflHNf32t2b9/gw+sp/fKXnbayhqNGZcVmG+jtgdLrZ+EVjd0h6nbjhItBriNEnQ+B7ug851o/07e3XFwlhWbDY6d6HRaT4Q9Z1ybXZAtQD0l9qxnQjLZd1ErVYdfH31UYxGwRaajHS7Wq3+D90I7A8=","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),i=n(28453),r=n(33617),s=n.n(r),p=n(17543),l=n.n(p),m=n(86013),c=n.n(m),d=n(63723),u=n.n(d),f=(n(18766),n(79329),n(9303));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:"eJy9GdtuGzf2V87ypY0wluRLkq6earSp627QGLUDA+sYAmfmzAxjDsmSHMmCIKAP+wf7tK/9tHzJ4nAuGsmKHaVpXmyJPPcbzzlaMs9zxyY37EedVCUq79htxFJ0iRXGC63YhF0VCGfooQWB04tzQMVjiQ4WugKvwaK3AmcIKXoupAMe68oDB2cwEZlIIG2whyxi2qDlRP08ZROWo28vWcQMt7xEj5bEWjLFS2QT1gJMRcoiJkgsw33BtmXV8XtM/HkKOuvkZRGz+HslLKZs4m2FEXN+IYmsE6WRyCKG90bqFNkk49IRQFJgydlkyfzCBEhvhcpZxDJtS+77J3jPA5UJMz8fxkVyVJiYrVa3xNYZrRw6InQ0HtO/TXldlSToXFZJ6IzCIpZo5UnyyZJxY6RIwsXovSOk5UPparXJepbIeFGzdJ77yu2rhVAHxurconNsFXUm3ZfMT2fi7ug4Lt7+QlQyQYf7USi8N24yGjUnlZXDRJdELSEdMzLLZxPtkegR9sLvL6cLHyjCiYTS+wtlJHKH4ESuukQJVtMyRfu0o7+Mj+pc249CLSEE1NXagOuEbVSgQJqrDV0+if57jRAjEj5ZJ5SFjgK3li+oHngs3dNWsnq3b9fcEtSPGWKnWFhyIZ+EjhG/bw7aWDOFVk+wOXn+4ujw+LuXhwQ/F2mO/i/oX9/uZ3+P9z7W90FenvfRVVXGaPvo3UmHfriK2P2eOEcnJ6uILfbEekms5nsiHX+3ilixJ9LJC4rlUMA/weafk1OdzVf9jPJYGsk9Ti/rPJi28fAoVEhKhyo9V2/sZi2JtZbIVZ81vY5UXi1yj+mpfzw6j8ZHxweH44Pxy6vDF5OTf06evxiOx+N/s4jdl3KtPUupTveLQ/O9MulX4VM3K1e6+jT1LabCYuKnld2Z2I/5jthxKfV8Wuq0fl+2AmUH39B0EGKVCj/1drOg7Jnln12PZgLnuPMJ+YKuCEX872Wy4xWaC1/UzdC0b+MA2iaMeEKqHiAIB1rJBfAZF5JiC+YFKvAFds83wTR5BJnVJXBoKQxDkFReTy2WQj2ZlW141NBTrRKcCjXFGdqdZbJDHJOCWyZ7YBH2qL2aInSyq3m91CX6Qqgc5qTw3GqVR9D0Mt4ugOdcKCCV7T++XFeL1uqdfcTaV/tJ1o8YoaRQOG079+nJeDw97Ixw8tAI3VSktIdMVyr9uqru4v+4QifT406h5w8VOlczLkUaprwrfYfq6+rTZ+9r9g+jWNRA4Z5tKNs/r5V0mFRW+EUYJ+8PuBEH9f3k5paGNIoU3cyhYf70BZuwUZsKo2Vv9lwxomdn7XQaHohupHBcpbG+H2qDiuqc5LGj4jriRoxmh0Pq4rZxuDF7wWN1sC+K8zwXKn8K73ZtqktyZ+2xDYOtnyQj/oX0JjX+6EM143mBPPT9K/qe6YDceOmNQUXtSfBxYL49xl+jTHSJtFmgmjoYtCgf/vNnhzUYdMU2ROPwnXqn3lQWjJ6jpZGaqxQyifeCKnTYWpThrltbOOSlROfkAoTymFvuEVKRC89lmMaohCTc8FhIQUFMYJqwLfTywA3hukBfoKWrbywChxRnKCn2gSp9yT2R6h6HubZ3mdRzFwGHuHJCoXOAquAqIcDWExFoC1wBKo/WWEFDorcktahl08pbnngoueI5Eu0I+sZKUQoKV7A6rpwHp2UVRAba02iLKbQKKcTUBSO+om2IRaDTRJfGYkFhM0PIK5GiiyDRKUI995IKKoUYnQdDsogEHRGtlNTJXXBgVkkJRlMJEVzScqYvI6F7y5WjxqqWpfVBZzBjNS1KsBZwMHjrkDz8Wqg7NxkM3qkDuOni6hpjJzzeftumwHw+fxD6zzZxzoT/uYrhNzTaCa/tYo2dC19UcUiXPpHuS03pDBWG+Oklw5pGqhP3MPvodFSgNKNL9BQhbnR6cR6q7jP48Md/4TVyq6DQ8zpak8qiXEDesiLL1Z6vzdYVTch0CLyCLJ7UwUdLMHS+teB1wf2HP/7n4Fecg1BNSpEqg8FFFUuRwFXTsLjBYAI/hGama2Ic+IJ7SLiCGMEVnEJpJjhwMDW2FOpuCKdqAZVDC9RThGCg84C3ocbG7sNBzB2moOueqmuc1hLReelQztARLXr8YgRMBfVbvrC6ymtufWEa5SxmQkq4rucn0u00TcE0x81YRQbviYMZJYQvcAHcIjjaZMLFFkq4qYzRlqQQtfCZpnGAHIAqNVoo7yaQWp75Nf1oHeihZxRa7TiqTbjuI6OGTOeSOhMbjbvT4TsqyluFfLPeWszQEsOg9tovRjThdNOGJVC0/pWwDus7rTxPfG9aoRfl+2064WVHW7o32SXamUja/d1HMnoUgEcsYlIkqBz2OobTs4vXMDsejlnUex4/IblHr89/ePXr5aswIaF1tcEOh+PhOCxFtPMlVz1O/VX59sO2XDdSf8NavXmcaX0wMpKL0Bo1M2zd1tyw3qZ90l+q30as0M4TyHJJyffWytWKjn+vwphxcxuxGbeC5Au9TyocfU67nflHNf32t2b9/gw+sp/fKXnbayhqNGZcVmG+jtgdLrZ+EVjd0h6nbjhItBriNEnQ+B7ug851o/07e3XFwlhWbDY6d6HRaT4Q9Z1ybXZAtQD0l9qxnQjLZd1ErVYdfH31UYxGwRaajHS7Wq3+D90I7A8=",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,g={},h=[];function j(e){const t={p:"p",...(0,i.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(f.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)(f.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,a.jsx)(l(),{parameters:[{name:"document_id",in:"path",description:"objectId of Document",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}]}),"\n",(0,a.jsx)(c(),{title:"Body",body:void 0}),"\n",(0,a.jsx)(u(),{id:void 0,label:void 0,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:!0},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:!0},redirect_url:{type:"string",format:"string",example:""},allow_modifications:{type:"boolean",example:!1},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:!1},remind_once_in_every:{type:"number",example:0}},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"}}}}}})]})}function b(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/7ef59f7a.e7cadeec.js b/assets/js/7ef59f7a.e7cadeec.js deleted file mode 100644 index 5e18ebd85..000000000 --- a/assets/js/7ef59f7a.e7cadeec.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4865],{84605:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>h,contentTitle:()=>b,default:()=>k,frontMatter:()=>g,metadata:()=>o,toc:()=>x});const o=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":"eJy9GctuGznyV2p42YnRluRHklmdxpjNerwbTIyxgwDrGAK7u1rNmE1ySLZkQRAwh/2DPe11Py1fsiiyu9WSFTvKZHKxJbLeL1aVlszzqWPjG/Y3ndUVKu/YbcJydJkVxgut2Jhdlwjn6KEFgbPLC0DFU4kOFroGr8GitwJnCDl6LqQDnuraAwdnMBOFyCBvsAcsYdqg5UT9ImdjNkXfXrKEGW55hR4tibVkilfIxqwFmIicJUyQWIb7km3LqtMPmPmLHHTRycsSZvG3WljM2djbGhPm/EISWScqI5ElDO+N1DmyccGlI4CsxIqz8ZL5hQmQ3go1ZQkrtK2475/gPQ9Uxsz8fJSW2XFpUrZa3RJbZ7Ry6IjQ8WhE/zbldXWWoXNFLaEzCktYppUnycdLxo2RIgsXww+OkJYPpYtqk/UskfEisnSe+9rtq4VQh8bqqUXn2CrpTLovmb+fi7vjk7R8+w+iUgg63I9C6b1x4+GwOamtHGS6ImoZ6ViQWb6YaI9Ej7AXfn85XfhAEU4klN5fKCOROwQnpqpLlGA1LXO0Tzv66/go5tp+FKKEEFBXawOuE7ZRgQJprjZ0+Sz6HzRCikj4ZJ1QFjoK3Fq+oHrgsXJPW8nq3b5dc8tQP2aInWJhxYV8EjpF/LE5aGPNlFo9web0+Yvjo5MfXh4R/FzkU/R/QP94u5/9Pd77VN8Hefm0j67qKkXbR+9OOvSjVcLu98Q5Pj1dJWyxJ9ZLYjXfE+nkh1XCyj2RTl9QLIcC/hk2/5Kc6my+6meUx8pI7nFyFfNg0sbDo1AhKR2q/EK9sZu1JNVaIld91vQ6Unm1yD3mZ/7x6DweHZ8cHo0ORy+vj16MT/86fv5iMBqN/sUSdl/JtfYspzrdLw7N99rk34RPbFaudf156lvMhcXMT2q7M7Ef8x2x41Lq+aTSeXxftgJlB9/QdBBinQs/8XazoOyZ5V9cj2YC57jzCfmKrghF/M9lsuMVmgtfxmZo0rdxAG0TRjwhVQ8QhAOt5AL4jAtJsQXzEhX4Ervnm2CaPILC6go4tBQGIUhqrycWK6GezMo2PCL0RKsMJ0JNcIZ2Z5nsEEek4JbJHliEPWqvpgid7mper3SFvhRqCnNSeG61mibQ9DLeLoBPuVBAKtvvvl5Xi9bqnX3E2lf7SdaPGKGkUDhpO/fJ6Wg0OeqMcPrQCN1UpLSHQtcq/7aq7uL/uEKnk5NOoecPFbpQMy5FHqa8a32H6tvq02fvI/uHUSwiULhnG8r2z6OSDrPaCr8I4+T9ITfiMN6Pb25pSKNI0c0cGuZPX7IxG7apMFz2Zs8VI3p21k6n4YHoRgrHVZ7q+4E2qKjOSZ46Kq5DbsRwdjSgLm4bhxuzFzzWh/uiOM+nQk2fwrtdm+qK3Bk9tmGw9ZNkxD+R3qTGH32oZjwvkYe+f0XfCx2QGy+9MaioPQk+Dsy3x/h3KDNdIW0WqKa2CB///b+A03okBGGg8N179V69qS0YPUdL4zRXORQS7wVV57CxqMJdt7JwyCuJzskFCOVxarlHyMVUeC7DJEblI+OGp0IKCmAC04RtoZcDbgDvSvQlWrr6i0XgkOMMJcU9UJWvuCdS3cMw1/aukHruEuCQ1k4odA5QlVxlBNh6IQFtgStA5dEaK2hA9JakFlE2rbzlmYeKKz5Fop1smCpHKShUweq0dh6clnUQGWhHoy3m0CqkEHM3ICO+ok2IRaDTTFfGYkkhM0OY1iJHl0Cmc4Q485IKKocUnQdDsogMHRGtldTZXXBeUUsJRlP5EFzSYqYvI6F7y5WjpirK0vqgM5ixmpYkGAU8OHjrkDz8Wqg7Nz44eK8O4aaLqXeYOuHx9vs2/Ofz+YOwf7aJcy78z3UKv6LRTnhtF2vsqfBlnYZU6RPpvkRK56gwxE8vEdY0cp25h5lHp8MSpRleoacIccOzy4tQcZ/Bx9//A6+RWwWlnsdozWqLcgHTlhVZLno+mq0rmFDoEHglWTyLwUcLMHS+teC7kvuPv//XwS84BxFTKBry4OCyTqXI4LppVtzBwRh+Co1M18A48CX3kHEFKYIrOYXSTHDgYCK2FOpuAGdqAbVDC9RPhGCg84C3ocbG3sNByh3moGM/1TVNa4novHIoZ+iIFj18KQLmgnotX1pdTyO3vjCNchYLISW8i7MT6XaW52Ca42akIoP3xMGCEsKXuABuERxtMeFyCyXc1MZoS1KIKHyhaRQgB6DKjRbKuzHklhd+TT9ZB3roF4VWO46iCdc9ZNKQ6VwSM7HRuDsdvKeCvFXEN2utxQItMQxqr/1iRBNON21YAkXrHwnrsLrTyvPM9yYVek1+3KYTXnW0lXtTXKGdiazd3X0io4cBeMgSJkWGymGvWzg7v3wNs5PBiCW9p/Ezknv4+uKnV79cvQrTEVoXDXY0GA1GYSGina+46nHqr8m3H7Xluon6E1bqzcNMq4OhkVyEtqiZX2NLc8N6W/Zxf6F+m7BSO08gyyUl31srVys6/q0OI8bNbcJm3AqSL/Q9uXD0Oe/25Z/U9Ptfm9X7M/jEbn6n5G2foajJmHFZh9k6YXe42Po1YHVLO5zYbJBoEeIsy9D4Hu6DrnWj9Tt/dc3CSFZuNjl3oclpPhD1nXJtdj9RAPpLrdhOhOUyNlCrVQcfrz6J0SjYQpORbler1f8ByerrWg==","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 r=n(74848),a=n(28453),i=n(33617),s=n.n(i),p=n(17543),l=n.n(p),m=n(86013),c=n.n(m),d=n(63723),u=n.n(d),y=(n(18766),n(79329),n(9303));const g={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:"eJy9GctuGznyV2p42YnRluRHklmdxpjNerwbTIyxgwDrGAK7u1rNmE1ySLZkQRAwh/2DPe11Py1fsiiyu9WSFTvKZHKxJbLeL1aVlszzqWPjG/Y3ndUVKu/YbcJydJkVxgut2Jhdlwjn6KEFgbPLC0DFU4kOFroGr8GitwJnCDl6LqQDnuraAwdnMBOFyCBvsAcsYdqg5UT9ImdjNkXfXrKEGW55hR4tibVkilfIxqwFmIicJUyQWIb7km3LqtMPmPmLHHTRycsSZvG3WljM2djbGhPm/EISWScqI5ElDO+N1DmyccGlI4CsxIqz8ZL5hQmQ3go1ZQkrtK2475/gPQ9Uxsz8fJSW2XFpUrZa3RJbZ7Ry6IjQ8WhE/zbldXWWoXNFLaEzCktYppUnycdLxo2RIgsXww+OkJYPpYtqk/UskfEisnSe+9rtq4VQh8bqqUXn2CrpTLovmb+fi7vjk7R8+w+iUgg63I9C6b1x4+GwOamtHGS6ImoZ6ViQWb6YaI9Ej7AXfn85XfhAEU4klN5fKCOROwQnpqpLlGA1LXO0Tzv66/go5tp+FKKEEFBXawOuE7ZRgQJprjZ0+Sz6HzRCikj4ZJ1QFjoK3Fq+oHrgsXJPW8nq3b5dc8tQP2aInWJhxYV8EjpF/LE5aGPNlFo9web0+Yvjo5MfXh4R/FzkU/R/QP94u5/9Pd77VN8Hefm0j67qKkXbR+9OOvSjVcLu98Q5Pj1dJWyxJ9ZLYjXfE+nkh1XCyj2RTl9QLIcC/hk2/5Kc6my+6meUx8pI7nFyFfNg0sbDo1AhKR2q/EK9sZu1JNVaIld91vQ6Unm1yD3mZ/7x6DweHZ8cHo0ORy+vj16MT/86fv5iMBqN/sUSdl/JtfYspzrdLw7N99rk34RPbFaudf156lvMhcXMT2q7M7Ef8x2x41Lq+aTSeXxftgJlB9/QdBBinQs/8XazoOyZ5V9cj2YC57jzCfmKrghF/M9lsuMVmgtfxmZo0rdxAG0TRjwhVQ8QhAOt5AL4jAtJsQXzEhX4Ervnm2CaPILC6go4tBQGIUhqrycWK6GezMo2PCL0RKsMJ0JNcIZ2Z5nsEEek4JbJHliEPWqvpgid7mper3SFvhRqCnNSeG61mibQ9DLeLoBPuVBAKtvvvl5Xi9bqnX3E2lf7SdaPGKGkUDhpO/fJ6Wg0OeqMcPrQCN1UpLSHQtcq/7aq7uL/uEKnk5NOoecPFbpQMy5FHqa8a32H6tvq02fvI/uHUSwiULhnG8r2z6OSDrPaCr8I4+T9ITfiMN6Pb25pSKNI0c0cGuZPX7IxG7apMFz2Zs8VI3p21k6n4YHoRgrHVZ7q+4E2qKjOSZ46Kq5DbsRwdjSgLm4bhxuzFzzWh/uiOM+nQk2fwrtdm+qK3Bk9tmGw9ZNkxD+R3qTGH32oZjwvkYe+f0XfCx2QGy+9MaioPQk+Dsy3x/h3KDNdIW0WqKa2CB///b+A03okBGGg8N179V69qS0YPUdL4zRXORQS7wVV57CxqMJdt7JwyCuJzskFCOVxarlHyMVUeC7DJEblI+OGp0IKCmAC04RtoZcDbgDvSvQlWrr6i0XgkOMMJcU9UJWvuCdS3cMw1/aukHruEuCQ1k4odA5QlVxlBNh6IQFtgStA5dEaK2hA9JakFlE2rbzlmYeKKz5Fop1smCpHKShUweq0dh6clnUQGWhHoy3m0CqkEHM3ICO+ok2IRaDTTFfGYkkhM0OY1iJHl0Cmc4Q485IKKocUnQdDsogMHRGtldTZXXBeUUsJRlP5EFzSYqYvI6F7y5WjpirK0vqgM5ixmpYkGAU8OHjrkDz8Wqg7Nz44eK8O4aaLqXeYOuHx9vs2/Ofz+YOwf7aJcy78z3UKv6LRTnhtF2vsqfBlnYZU6RPpvkRK56gwxE8vEdY0cp25h5lHp8MSpRleoacIccOzy4tQcZ/Bx9//A6+RWwWlnsdozWqLcgHTlhVZLno+mq0rmFDoEHglWTyLwUcLMHS+teC7kvuPv//XwS84BxFTKBry4OCyTqXI4LppVtzBwRh+Co1M18A48CX3kHEFKYIrOYXSTHDgYCK2FOpuAGdqAbVDC9RPhGCg84C3ocbG3sNByh3moGM/1TVNa4novHIoZ+iIFj18KQLmgnotX1pdTyO3vjCNchYLISW8i7MT6XaW52Ca42akIoP3xMGCEsKXuABuERxtMeFyCyXc1MZoS1KIKHyhaRQgB6DKjRbKuzHklhd+TT9ZB3roF4VWO46iCdc9ZNKQ6VwSM7HRuDsdvKeCvFXEN2utxQItMQxqr/1iRBNON21YAkXrHwnrsLrTyvPM9yYVek1+3KYTXnW0lXtTXKGdiazd3X0io4cBeMgSJkWGymGvWzg7v3wNs5PBiCW9p/Ezknv4+uKnV79cvQrTEVoXDXY0GA1GYSGina+46nHqr8m3H7Xluon6E1bqzcNMq4OhkVyEtqiZX2NLc8N6W/Zxf6F+m7BSO08gyyUl31srVys6/q0OI8bNbcJm3AqSL/Q9uXD0Oe/25Z/U9Ptfm9X7M/jEbn6n5G2foajJmHFZh9k6YXe42Po1YHVLO5zYbJBoEeIsy9D4Hu6DrnWj9Tt/dc3CSFZuNjl3oclpPhD1nXJtdj9RAPpLrdhOhOUyNlCrVQcfrz6J0SjYQpORbler1f8ByerrWg==",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,h={},x=[];function f(e){const t={p:"p",...(0,a.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(y.default,{as:"h1",className:"openapi__heading",children:"Get Document"}),"\n",(0,r.jsx)(s(),{method:"get",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,r.jsx)(t.p,{children:"The Get Document API enables you to retrieve details about a specific document."}),"\n",(0,r.jsx)(y.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,r.jsx)(l(),{parameters:[{name:"document_id",in:"path",description:"objectId of Document",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}]}),"\n",(0,r.jsx)(c(),{title:"Body",body:void 0}),"\n",(0,r.jsx)(u(),{id:void 0,label:void 0,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:!0},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:!0},redirect_url:{type:"string",format:"string",example:""},allow_modifications:{type:"boolean",example:!1},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:!1},remind_once_in_every:{type:"number",example:0}},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"}}}}}})]})}function k(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/851f8f65.069815d8.js b/assets/js/851f8f65.069815d8.js deleted file mode 100644 index 153532b69..000000000 --- a/assets/js/851f8f65.069815d8.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9070],{72700:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>y,contentTitle:()=>g,default:()=>j,frontMatter:()=>x,metadata:()=>i,toc:()=>f});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":"eJztPNlyHDeSv4Kp2AhZ3GJfJCWZq1UMLWls7XglhkWtY5bUcNBV2V0Qq4AygGKzzWDEPMwf7NO+zqf5SzYyAdTRB0lJtIeabT/IbBSORCIzkcjrMrJ8aqL94+iFSqoCpDXR+zhKwSRalFYoGe1HRxmwF5pPLAud2MHhK8bzXM0Mqwxow6xiU5CguQUmYcbSMB0bz1mp1blIhZyylFvOZsJmjLMxN/Bol4FMVAopm4gceifyRB6Jcp+9K3PFUzZXlWaHL/5Qz4cLYdvx1tYLGFdT9u7V1tb7rzJrS7Pf7/Oy7KkSpBFTmfOx6SWq6KfYsUwnD2M2y0ADzsoSLhlwI/I542nKZiKdgjUxsxlIlqhyzhKldCokt2BiVvIpMFkVY9AmZlymrFAamJCMMw08nW9btV0ZYP/x9s1rNlG64LbHDvPKxPVyqdCQ2HzuprcZ1Lt6YAI2jNVCTmNW8DPEl7Dsp0okZ7htAzLF/+PAg8NXhKutrbdVWSptIWU/ui3sb23hl28gVzPGNVD/RBWFkqzkmhdg6cAybumzhp8qoSH1x5LnARf7J3KbbW3ZeQn7W1vslUxFgsigCbGVqYnv23NdEUnY9W0JiZgI37WFOqYkm2UiyQgnM+7Os8x54sDUYEpIrDiH7sQXMZvjxC9AqgBBprT4WUnLczqOc9BWJDxvHxsCiF2N5doiOkslpA2tfgX2J388eHp0KJ6uELQUkVUISV8MsHOeV2A8VLOYZQjVD1BqMETsfl5EpExZBmKarV2Ppx8qYzsTs8ogmG0o/FrhlAi9QGib8NwAE5MOLgt+Bq3VmCIm5nmPfTNnKUx4lduYCaQ4qyvosdfKMl6WuUj4OAekXIbMw22lYZtO2ZODB0Tygs74kHgaDOMsFZMJaGRO/EhT+DEBOqSzRggQ59iMS6bkwkEnKld6mYSouYtHlihpQdoeOzjnIifg3WYNEzLJqxTYOOfJWczGeQUx05A6xp0DCq7Y0Tt1Ydx4nBN+mIEcqVBJhF8qv7wwzHio0h47yoRp+Ak/BlTTIsK0seq5dqJwZURBYDEGBRd5TIiL2Qc1ZlbYHGJk2JLLeYwSE2Jm4cKO1UXMkgySM/pL81QoNq6sVdJtLNWqTNVMelxOlLRG/LyCI8OXj8foKGa7MXsUsycxGw5iNhzFbLgbs+GjmA2fxGw0iNloFLPRbsxGjxxYoydxEPkBwW0AhiOHZfvlYBfl7vfCEGejwDS1DJ51ZPCwx7a2am7Ctr/85S8n8vJEMnYSIXOdRPvsJKq7nESx+4YyE78N/e8L/LEzeux/zvHno9ET/3NGXYe7/meGP0fDE3nlFzyRI4LE8qK8Bgr8fKcQ+F+eiLCNFsW2IM+wEQVRHD7gWXXgwQ9X7b3s4F6EFFbw3KzfTuhxj3bUgLS0qV3cFJHr+h3R53u0nTY8+IXEpPtEYrX1KTA8QTFa2v1ez98s6zfvlr03e2+B83lbf4RbR9F0hKJp/f5r6XWPkLAI0+dh4nGPFACSzOvx4DvcIyx0Ifo8HDxBHOCltB4B+PUe7b4FDn7wN7z7NtjdHu5tjwaj3Q4G8G3kOhTFdppuz+fzu8Ae6jx+eVR5gobqNDt8l060KlY8P+h10PTyOhH9HVT2/0RFfRx0WEjx3UcPi6Cx1C++tpZtVcrnD4ybKgytlTPs36hm8xaY9AnhoNdvkimReOCxT1DJxvjA6yEOtgmT/TTttzCJjWm6XRTbC434c5sQ32osil6a9hZ6Lp2OayxYmsZsuXlle5qyoijWNLv2TnO/KJZ30SsKDxspX18jk3idbT2f+A6/Fas0HNFd+Fo2QsuBkjmtTc+51Xy0cNlkQvoPnqjYQgcN0yrnGi7wXWqEkq733fNYYLFGs6d3LD0ByUrgUMG+euO194ee/HEL3Qmw5eZxSzvDSQ5YUhmrCqZhChes5NaCljTZOc9Fyukpt00NcMGLEp8A/T+fnKT/+i99MkDgG98yPAmWiqlAO1D/z8cH2//9fkWPqixBJ9wAywFXMjEDm/TYcQZ52ZiiZrNZb7Zjkkyp3NmhPhgNE/fvqRp/OCVwyx435cNVO3Wk0XrwI+ksvvcN2A7GuGFh5IonP9EY8dBwQLetf+9cc936HvfoxlkACT866wl+Pj6JCk4KCZIyNH8rm4E+id7XY9wjH9Ibxr6/BbNmIoWcjyFf/nRrRqubcz5XlefvYNTqbtVTdAtv+KEQsrZb0HYGcesjv1j46L5dreBvh5A2d4YrJ7BnOAGWCxMsN110tkd70xYZHCUA2TDHwMIANBAH6fG5XFADdjs2cJLIn90NS2A/Rh1rs2JY7YYVOgfTRgzOUQgpiqqo7aOTetaAssLrHm184Ui0u4cV2qe7tAK/uGEFNEauX+BEDsmOEewf12imvsc9khULIF3Pxp8iRTr39B1dsDczYNhWmwFXXMvY1V3INfOZ9dzXY2/wekObrBuEVrYkgdKiRe5zWbMG+dY3FNmsnB3uG7LDrae8trXuHlHfCrB+ZQr0/e769vkkIm3v/gsi1A7YtyZWZ5Qs+PSalzt9vkfk6eFZMkJsbR1qmIg8b7kUWWgKnh106UAOhXd7eWciXnVkCBfSKnwWBLftGCbkL7XkRsl443B094w70rZPlCUauFWaZdw4/ZsUfjwqdNjaDIoFU3wArTHHCxngxlMZ3t27cfT1oH1Ow0d7nXPaG3TOabDunK55NuIJmlJJU9vaoPnU4ms64tC+fLUssm2YFI/0pUTfSng9OGZQVZ6yXJyRVyUVpsz5HE81cKmHctFd9zxTyjQ9vMfsK7/h/a4nTml0xj3s1Y6J2xi8Fg6jdRbDxzuto9h78qTLMR2Guc37vVlv+RQGu/3hXt9ZtFYbtBozzHohfI0mwNhtzovsRLc6L+rZHNjG7PSpZqe7Ifedu3x1Dx+POpfFzuBTL4s7f1y3ueaGZ/VdPJ7v7BXbZrdbvl9/s3fk51PfbqNRj+9Mox4+3mlT4ePhHZhQ1yjOn0uJS/rxndEeuyvleBUB3kI7vlYl/mwCbQP7qxPp3t1o0sNBR0P7uqOgfT1qE+Xe3q2Isr3oAmWdROK/vnnzw2zwx2+n6uDg4OD123fZy3fTg4ODAn/3er2Vj6hVp03LoObqIwL9vUx3/JpVer0eohCDK/dpeL+U039z4+P1Y3onMoojVWLUplDyVRrtRynGeQYVPIrpGQHGfqPSebR/GfkQIfzTB+DgyP4Hg4Gil5FJMig4/hWeHxhaipGdURyRpxijS/Eco/1IjT9AgmuUGmGwAgyOpN77l6GXC4iMYq9mRfuR21cUR96WXzfVoaRlOomuwoLXTVW3NFMZ+qN+heA8GHP4idO8xqFXCwG1nzTTi9YMtLcCjtRzhd8svOBz05rXmfqixTheHIMcnvhRLOVzg5KiMu5WS3ieVDkqg3BRCj2vHaKkEbaoooa3XqmGd7h3FVNAE+g2SFxrPo/iSFgo2u1riECrjz+5BBRihqJSPnbsBwVjgN/7BvTW0MHz4qOh+KCAjYEOvcyU/Ojxw9HOcDTcGY5wBv+i/XQ8uq/LEHQJ4wAD5yANms52EwEaM4rC6t1Eo6E/bZtP4WZiPFoXGdwKSDQZPW94WQLXPQrQ/eTY7y5911dq7wZqvoqji5s3c8EStR3CjtlXOUyscxOyRGkJ+mE79uDebG60u3sVR/Obtzf/Irf3GA9vdvPufqR47SaW/R8B686TqzjKbob1uzqi/B8I7O6jq+Z2jchMB+FyOB2rdH4a5NbVTR3DRYH9JipPQaMWsiyvGlGDEgYzIU4X5fxYqRy4XCFoOqHEPmsFNV40+noryCwDfDg0ijDN3mjZ3kTsoMXwZFiIeBAGFVRdwUnUY68mLZ2ddOjFaObQlyKLpWIPaL1TU5EYf9D3vxFHD9pZG2hjbYKOAgjUmVkoypzSHmZoqB2TBy/tsfo/UvdqTCIA4boMC998VTx3kRa0oB/UzRlgXmPssedc1nHj3fhsdnlZkwFRx9UVu7zEUwV9ipfu1VXcNOBanQa6V12LhgTEeWdU3QTNwLqtNdSpOKeo4rgGH8fXBkBMpZDT00r7eVATvLrqdQhyAXAyV3scQFrTmZjKFbuu9RU66VtjfwnZngJwkv83eH9aPvtOrADlab989rR89iNmCJXgeM+hZyJk6jh/BnneY0+N1UpOny2g4Gnft68+Sg3nAmbEuHSqzSyLuK0n6nmY/oSCujk8YViiq0TwnEKMtEogeEXw3CQ+m42F0qAbSlga6ZI4SB/nUw3kfyFYeGUpI4oeZGHBp5xlGib//mABpw+evUXQMRnuaZ8/871fOUNAxs+BcTlntHGyWijtLF+TSpOYTHKuxcS//mJW5oDhUPg45InzojmMBjiOMi7PTPx0rJ8dAS/YmxIkQvDL3/6OPYJMfyXf6BT0LYT6q4nz1yn2AOXYg9iFZhG5C22sF9VOEnoKcXCtYR0fmo9uvpe16DfV2GAvGeZrRKvVYjoF9GL5HjTYJ7oATzJ3aRBUfBLs9iUSj6pMAA8JLLzGyKUlHH0IOe3aWVrYIQdae++9VVJdYmbMm6PDW+CSjEDbjlGcBcTt0s3B3hwdYnJdfdw99s7UmAio5Z0uDJ/h7FzwkIBTa/ZzF84CzpPh5WLb69fzaW3bbBmgVJiVEMXuUkcJVyejLk3cZF/iEanKohdR+Jwi4rIOHgmKGpFHqroNVd6ASc6mFUUPW2TfcGtSAGGTHCeksbpyoTwsrXTIB/Rk4cSEMQ2eAlawU2v+mIE0bjhnE24s6JhVUiDmdYV2wXpKuChBC5AJrESBBoc6FB03X1HdTLN3P3zvc27DHgJTjpED3cSQsqokqiFOqDMgw8ktbn2lPujF980Aou5GeYreuFmCNkqiiFN6yqWXoO49ihbMMWQ8d129qEAnGMKDHN4FJmjav/zt7y241loklgFzK/A0xfDWGyAkY7AjeIzg0lCiBFRdiHA+0L9ffAIgdMQ0p4VKa0Yyt6fxQwqINbVc9F75OiLAVEmG11Ytb00cZKzxRgVDdl8yDpNbv8T9woUwtpXDFyLtl+XDD4B4TFow0CMUuRppXs7bDN5EKqiF6eh5ILr5n/UjaIkXeGXVqYZCyNvdU207u1W1IKisKrgVCQtTmV43q9c5cwNfF+yrABpS47lQ+uEaVsXpTpVM4FTIUzgHfYvn/es6MpAMgmOwMwDZhi0gyV1nTeblDJPlOzhp3U6UX9yGEi2DpQvHWGW56gIVsqRDiHugB3eVUPZ+McawIBdYgqxGgiO80pZMYV+KLc1HWGwsaV+QqWk4GPwzW9J2Bl+OJW138AVZ0p4gsN7reLMAWqffrJQdwbV4/YAPikz25Jy9vif68shI53zfqxDcsMPoyv3XGP+C3G+3dXyNzgJCYxrfoX/NhL0QFkaDAf6ve5ovOkGDqNtWCeqKkyrP57+L4ts7Lq8/ghpasdJMeZ1czz6I0c8XyfnoEPG4Rpe+dgJPiJXOsdgM3njbtR5DOl0Lt0LmQsIpofg0VcmpBnM6GgxOh5E7mN1VaHyrCrAZqV+IzBlaL+rnvdVzxqdcSIY0ru8Qq6D1TeT3cZCtwESgodPdDhL2lpHwSlKODdU4OlJnIH/bnbaXt255BPWiyBsZEAnXib5Hnc22290mDSSVFnYe7R9fRhfbvBTb7vv+8fur93GEiFXo+y+VIYi5zaL9qL8YCmBAn5NT9/jSkW9NkYbLFOOXlsQjL0X/fNgbRlfx4piV4vSa/lBtf+wQY/lUyOlN4943KHqLx+hOqoOoRmUsxR8BdUZ/Du1ecSSQfDLg+DZAzCN1/NAEULwMZxyCHFbFLTRnuRiJEAIROrEFi9faimiB1cECw72Wm/44eNzJiV770Fe5xeutB0d37eduua5bnuvjhtZrJ3HQbIekEo52d0l3ejwkJWPnCd3fu4+uiDobr1AUdT0/FNW+6L/4PHN81xq/MTH/E5mYFyzMnngaM6mL/uvY+3xT1/4VqLC2N3WMPos2n7X2lzXmF7/kgpmhBmTV636v86hewXdBKexyHcbHIdftDIjrdgfEdU8GHX3U77CZodEqSXWsNUdSD9vaIaqA71EGCjlRJEC9VAvnQvcbCeClVwTkiSrqsk6tg6QxgQWcEQxn+B2GDb6pNCvVDPSkcjWiJjlcCDRS4CAo6Fvj9wVe5GBMjsHyFqZUt5BSv9Ea7O2NCS/5WOQCL2+X0OKYorn/TY/92HiOH2iXCX8OOd75tZkH6x4G/XSm9NkEPdAxVkDEcm9o6AOZcZk4m6K7icg2hkYOtNeWWhisYqcRauFgU9Jq5ISCSz4lHo07qEohR5FlmFZjNLkblVeO0ywXudIu4os2RAGlFHv58qLET/QMQmushgzp9txblk3sLPvukvF1EMfoRCkRFpEAGdgqmSssWYjOmCrPWamsc5Dga6sNIw63mkuDaq8PMvNnUCPMG33B+GSfdwbwhL8X8syV2dpmxzVN/QhjIyx0k/AXee9hd8y3wn5XjbGInzLCKj1vRk+FzaoxqQvtSeofbqZvQ93LljLQzJGqxKx4N6rE9LFeQP8tWKQQ0z84fEXa5kP2y1//h30PXEuWqZmj1qTSkM+bEptUgJJO3qGtVhbJrYCCGjGeOOLz90vA4I8Zt7/89X8New0zNK8iCzlEbm0dVuNcJOwohBJsbe2z5/SkaoUXdJKGXSoX+no4K93oXMizHjuQc7JON7cNttO4zjbohmuVC+UYjKikjxx2a/YaiMgeaiA/BzJ7Y924MTBIhfOgaVVN3WptYPzmulltuLeDNGXlQmYb2l4bcJx5kVxX3NkZsa7nimS4TtZZ1+8OMqXKk2afkVLdzB8vpLvRXbfUFDLlAjpiP019JI4T/Y7rVhffu6DIdmWthglQZGe3gisvhSen40CWrFvd4uPJ2tkZ6Pqml5C/IHkpVnonsO6meTN5C/pcJOH5u4aj+9S5H8VRLhLwRg9/dx18e/g9O9/pDaK49Ty4BXP3v3/1/OXrty8RGBSkDmHD3qA3INusMrbgsrVSt0Tu4rXWip3eFNTdFNTdFNTdFNTdFNT9ckq+bgrqbgrqbgrqbgrqbgrqbgrq/npI2BTU3RTU3RTU3RTU3RTU3RTU3RTU3RTU3RTU3RTU3RTU3RTUvT+yYlNQ977UKd0U1P0tKHBTUHdTUHdTUHdTUHdTUHdTUHdTUHdTUHdTUHdTUHdTUHdTUHdTUHdTUHdNQd1W2kW/zLmQrXxPl1t3vFBm930cZZh7t38cXV7iKu8wgwabf6oox+P4fRydcy0wOofS9uKQZoZ5HmeAyUrPXbDR9hEuHzvWpvjahWxFzJNzIw6Inq/t204PPHzz9iiKo1CprFAp5QXzGeaF8JlLjWklj1DbZZRzOa0o8SRyc165OhpZN63ujNLq/B+t7BUu5y0Iu/l2bhv4L25q5YDLS5eyR8ldrr/7tHaER2zojcf3/urq6v8AS3ubAA==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Self Sign","permalink":"/docs/API-docs/v1.1/selfsign"},"next":{"title":"Create Document","permalink":"/docs/API-docs/v1.1/createdocument"}}');var s=t(74848),o=t(28453),r=t(33617),l=t.n(r),d=t(17543),a=t.n(d),c=t(86013),h=t.n(c),p=t(63723),m=t.n(p),u=(t(18766),t(79329),t(9303));const x={id:"draftdocument",title:"Draft Document",description:"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztPNlyHDeSv4Kp2AhZ3GJfJCWZq1UMLWls7XglhkWtY5bUcNBV2V0Qq4AygGKzzWDEPMwf7NO+zqf5SzYyAdTRB0lJtIeabT/IbBSORCIzkcjrMrJ8aqL94+iFSqoCpDXR+zhKwSRalFYoGe1HRxmwF5pPLAud2MHhK8bzXM0Mqwxow6xiU5CguQUmYcbSMB0bz1mp1blIhZyylFvOZsJmjLMxN/Bol4FMVAopm4gceifyRB6Jcp+9K3PFUzZXlWaHL/5Qz4cLYdvx1tYLGFdT9u7V1tb7rzJrS7Pf7/Oy7KkSpBFTmfOx6SWq6KfYsUwnD2M2y0ADzsoSLhlwI/I542nKZiKdgjUxsxlIlqhyzhKldCokt2BiVvIpMFkVY9AmZlymrFAamJCMMw08nW9btV0ZYP/x9s1rNlG64LbHDvPKxPVyqdCQ2HzuprcZ1Lt6YAI2jNVCTmNW8DPEl7Dsp0okZ7htAzLF/+PAg8NXhKutrbdVWSptIWU/ui3sb23hl28gVzPGNVD/RBWFkqzkmhdg6cAybumzhp8qoSH1x5LnARf7J3KbbW3ZeQn7W1vslUxFgsigCbGVqYnv23NdEUnY9W0JiZgI37WFOqYkm2UiyQgnM+7Os8x54sDUYEpIrDiH7sQXMZvjxC9AqgBBprT4WUnLczqOc9BWJDxvHxsCiF2N5doiOkslpA2tfgX2J388eHp0KJ6uELQUkVUISV8MsHOeV2A8VLOYZQjVD1BqMETsfl5EpExZBmKarV2Ppx8qYzsTs8ogmG0o/FrhlAi9QGib8NwAE5MOLgt+Bq3VmCIm5nmPfTNnKUx4lduYCaQ4qyvosdfKMl6WuUj4OAekXIbMw22lYZtO2ZODB0Tygs74kHgaDOMsFZMJaGRO/EhT+DEBOqSzRggQ59iMS6bkwkEnKld6mYSouYtHlihpQdoeOzjnIifg3WYNEzLJqxTYOOfJWczGeQUx05A6xp0DCq7Y0Tt1Ydx4nBN+mIEcqVBJhF8qv7wwzHio0h47yoRp+Ak/BlTTIsK0seq5dqJwZURBYDEGBRd5TIiL2Qc1ZlbYHGJk2JLLeYwSE2Jm4cKO1UXMkgySM/pL81QoNq6sVdJtLNWqTNVMelxOlLRG/LyCI8OXj8foKGa7MXsUsycxGw5iNhzFbLgbs+GjmA2fxGw0iNloFLPRbsxGjxxYoydxEPkBwW0AhiOHZfvlYBfl7vfCEGejwDS1DJ51ZPCwx7a2am7Ctr/85S8n8vJEMnYSIXOdRPvsJKq7nESx+4YyE78N/e8L/LEzeux/zvHno9ET/3NGXYe7/meGP0fDE3nlFzyRI4LE8qK8Bgr8fKcQ+F+eiLCNFsW2IM+wEQVRHD7gWXXgwQ9X7b3s4F6EFFbw3KzfTuhxj3bUgLS0qV3cFJHr+h3R53u0nTY8+IXEpPtEYrX1KTA8QTFa2v1ez98s6zfvlr03e2+B83lbf4RbR9F0hKJp/f5r6XWPkLAI0+dh4nGPFACSzOvx4DvcIyx0Ifo8HDxBHOCltB4B+PUe7b4FDn7wN7z7NtjdHu5tjwaj3Q4G8G3kOhTFdppuz+fzu8Ae6jx+eVR5gobqNDt8l060KlY8P+h10PTyOhH9HVT2/0RFfRx0WEjx3UcPi6Cx1C++tpZtVcrnD4ybKgytlTPs36hm8xaY9AnhoNdvkimReOCxT1DJxvjA6yEOtgmT/TTttzCJjWm6XRTbC434c5sQ32osil6a9hZ6Lp2OayxYmsZsuXlle5qyoijWNLv2TnO/KJZ30SsKDxspX18jk3idbT2f+A6/Fas0HNFd+Fo2QsuBkjmtTc+51Xy0cNlkQvoPnqjYQgcN0yrnGi7wXWqEkq733fNYYLFGs6d3LD0ByUrgUMG+euO194ee/HEL3Qmw5eZxSzvDSQ5YUhmrCqZhChes5NaCljTZOc9Fyukpt00NcMGLEp8A/T+fnKT/+i99MkDgG98yPAmWiqlAO1D/z8cH2//9fkWPqixBJ9wAywFXMjEDm/TYcQZ52ZiiZrNZb7Zjkkyp3NmhPhgNE/fvqRp/OCVwyx435cNVO3Wk0XrwI+ksvvcN2A7GuGFh5IonP9EY8dBwQLetf+9cc936HvfoxlkACT866wl+Pj6JCk4KCZIyNH8rm4E+id7XY9wjH9Ibxr6/BbNmIoWcjyFf/nRrRqubcz5XlefvYNTqbtVTdAtv+KEQsrZb0HYGcesjv1j46L5dreBvh5A2d4YrJ7BnOAGWCxMsN110tkd70xYZHCUA2TDHwMIANBAH6fG5XFADdjs2cJLIn90NS2A/Rh1rs2JY7YYVOgfTRgzOUQgpiqqo7aOTetaAssLrHm184Ui0u4cV2qe7tAK/uGEFNEauX+BEDsmOEewf12imvsc9khULIF3Pxp8iRTr39B1dsDczYNhWmwFXXMvY1V3INfOZ9dzXY2/wekObrBuEVrYkgdKiRe5zWbMG+dY3FNmsnB3uG7LDrae8trXuHlHfCrB+ZQr0/e769vkkIm3v/gsi1A7YtyZWZ5Qs+PSalzt9vkfk6eFZMkJsbR1qmIg8b7kUWWgKnh106UAOhXd7eWciXnVkCBfSKnwWBLftGCbkL7XkRsl443B094w70rZPlCUauFWaZdw4/ZsUfjwqdNjaDIoFU3wArTHHCxngxlMZ3t27cfT1oH1Ow0d7nXPaG3TOabDunK55NuIJmlJJU9vaoPnU4ms64tC+fLUssm2YFI/0pUTfSng9OGZQVZ6yXJyRVyUVpsz5HE81cKmHctFd9zxTyjQ9vMfsK7/h/a4nTml0xj3s1Y6J2xi8Fg6jdRbDxzuto9h78qTLMR2Guc37vVlv+RQGu/3hXt9ZtFYbtBozzHohfI0mwNhtzovsRLc6L+rZHNjG7PSpZqe7Ifedu3x1Dx+POpfFzuBTL4s7f1y3ueaGZ/VdPJ7v7BXbZrdbvl9/s3fk51PfbqNRj+9Mox4+3mlT4ePhHZhQ1yjOn0uJS/rxndEeuyvleBUB3kI7vlYl/mwCbQP7qxPp3t1o0sNBR0P7uqOgfT1qE+Xe3q2Isr3oAmWdROK/vnnzw2zwx2+n6uDg4OD123fZy3fTg4ODAn/3er2Vj6hVp03LoObqIwL9vUx3/JpVer0eohCDK/dpeL+U039z4+P1Y3onMoojVWLUplDyVRrtRynGeQYVPIrpGQHGfqPSebR/GfkQIfzTB+DgyP4Hg4Gil5FJMig4/hWeHxhaipGdURyRpxijS/Eco/1IjT9AgmuUGmGwAgyOpN77l6GXC4iMYq9mRfuR21cUR96WXzfVoaRlOomuwoLXTVW3NFMZ+qN+heA8GHP4idO8xqFXCwG1nzTTi9YMtLcCjtRzhd8svOBz05rXmfqixTheHIMcnvhRLOVzg5KiMu5WS3ieVDkqg3BRCj2vHaKkEbaoooa3XqmGd7h3FVNAE+g2SFxrPo/iSFgo2u1riECrjz+5BBRihqJSPnbsBwVjgN/7BvTW0MHz4qOh+KCAjYEOvcyU/Ojxw9HOcDTcGY5wBv+i/XQ8uq/LEHQJ4wAD5yANms52EwEaM4rC6t1Eo6E/bZtP4WZiPFoXGdwKSDQZPW94WQLXPQrQ/eTY7y5911dq7wZqvoqji5s3c8EStR3CjtlXOUyscxOyRGkJ+mE79uDebG60u3sVR/Obtzf/Irf3GA9vdvPufqR47SaW/R8B686TqzjKbob1uzqi/B8I7O6jq+Z2jchMB+FyOB2rdH4a5NbVTR3DRYH9JipPQaMWsiyvGlGDEgYzIU4X5fxYqRy4XCFoOqHEPmsFNV40+noryCwDfDg0ijDN3mjZ3kTsoMXwZFiIeBAGFVRdwUnUY68mLZ2ddOjFaObQlyKLpWIPaL1TU5EYf9D3vxFHD9pZG2hjbYKOAgjUmVkoypzSHmZoqB2TBy/tsfo/UvdqTCIA4boMC998VTx3kRa0oB/UzRlgXmPssedc1nHj3fhsdnlZkwFRx9UVu7zEUwV9ipfu1VXcNOBanQa6V12LhgTEeWdU3QTNwLqtNdSpOKeo4rgGH8fXBkBMpZDT00r7eVATvLrqdQhyAXAyV3scQFrTmZjKFbuu9RU66VtjfwnZngJwkv83eH9aPvtOrADlab989rR89iNmCJXgeM+hZyJk6jh/BnneY0+N1UpOny2g4Gnft68+Sg3nAmbEuHSqzSyLuK0n6nmY/oSCujk8YViiq0TwnEKMtEogeEXw3CQ+m42F0qAbSlga6ZI4SB/nUw3kfyFYeGUpI4oeZGHBp5xlGib//mABpw+evUXQMRnuaZ8/871fOUNAxs+BcTlntHGyWijtLF+TSpOYTHKuxcS//mJW5oDhUPg45InzojmMBjiOMi7PTPx0rJ8dAS/YmxIkQvDL3/6OPYJMfyXf6BT0LYT6q4nz1yn2AOXYg9iFZhG5C22sF9VOEnoKcXCtYR0fmo9uvpe16DfV2GAvGeZrRKvVYjoF9GL5HjTYJ7oATzJ3aRBUfBLs9iUSj6pMAA8JLLzGyKUlHH0IOe3aWVrYIQdae++9VVJdYmbMm6PDW+CSjEDbjlGcBcTt0s3B3hwdYnJdfdw99s7UmAio5Z0uDJ/h7FzwkIBTa/ZzF84CzpPh5WLb69fzaW3bbBmgVJiVEMXuUkcJVyejLk3cZF/iEanKohdR+Jwi4rIOHgmKGpFHqroNVd6ASc6mFUUPW2TfcGtSAGGTHCeksbpyoTwsrXTIB/Rk4cSEMQ2eAlawU2v+mIE0bjhnE24s6JhVUiDmdYV2wXpKuChBC5AJrESBBoc6FB03X1HdTLN3P3zvc27DHgJTjpED3cSQsqokqiFOqDMgw8ktbn2lPujF980Aou5GeYreuFmCNkqiiFN6yqWXoO49ihbMMWQ8d129qEAnGMKDHN4FJmjav/zt7y241loklgFzK/A0xfDWGyAkY7AjeIzg0lCiBFRdiHA+0L9ffAIgdMQ0p4VKa0Yyt6fxQwqINbVc9F75OiLAVEmG11Ytb00cZKzxRgVDdl8yDpNbv8T9woUwtpXDFyLtl+XDD4B4TFow0CMUuRppXs7bDN5EKqiF6eh5ILr5n/UjaIkXeGXVqYZCyNvdU207u1W1IKisKrgVCQtTmV43q9c5cwNfF+yrABpS47lQ+uEaVsXpTpVM4FTIUzgHfYvn/es6MpAMgmOwMwDZhi0gyV1nTeblDJPlOzhp3U6UX9yGEi2DpQvHWGW56gIVsqRDiHugB3eVUPZ+McawIBdYgqxGgiO80pZMYV+KLc1HWGwsaV+QqWk4GPwzW9J2Bl+OJW138AVZ0p4gsN7reLMAWqffrJQdwbV4/YAPikz25Jy9vif68shI53zfqxDcsMPoyv3XGP+C3G+3dXyNzgJCYxrfoX/NhL0QFkaDAf6ve5ovOkGDqNtWCeqKkyrP57+L4ts7Lq8/ghpasdJMeZ1czz6I0c8XyfnoEPG4Rpe+dgJPiJXOsdgM3njbtR5DOl0Lt0LmQsIpofg0VcmpBnM6GgxOh5E7mN1VaHyrCrAZqV+IzBlaL+rnvdVzxqdcSIY0ru8Qq6D1TeT3cZCtwESgodPdDhL2lpHwSlKODdU4OlJnIH/bnbaXt255BPWiyBsZEAnXib5Hnc22290mDSSVFnYe7R9fRhfbvBTb7vv+8fur93GEiFXo+y+VIYi5zaL9qL8YCmBAn5NT9/jSkW9NkYbLFOOXlsQjL0X/fNgbRlfx4piV4vSa/lBtf+wQY/lUyOlN4943KHqLx+hOqoOoRmUsxR8BdUZ/Du1ecSSQfDLg+DZAzCN1/NAEULwMZxyCHFbFLTRnuRiJEAIROrEFi9faimiB1cECw72Wm/44eNzJiV770Fe5xeutB0d37eduua5bnuvjhtZrJ3HQbIekEo52d0l3ejwkJWPnCd3fu4+uiDobr1AUdT0/FNW+6L/4PHN81xq/MTH/E5mYFyzMnngaM6mL/uvY+3xT1/4VqLC2N3WMPos2n7X2lzXmF7/kgpmhBmTV636v86hewXdBKexyHcbHIdftDIjrdgfEdU8GHX3U77CZodEqSXWsNUdSD9vaIaqA71EGCjlRJEC9VAvnQvcbCeClVwTkiSrqsk6tg6QxgQWcEQxn+B2GDb6pNCvVDPSkcjWiJjlcCDRS4CAo6Fvj9wVe5GBMjsHyFqZUt5BSv9Ea7O2NCS/5WOQCL2+X0OKYorn/TY/92HiOH2iXCX8OOd75tZkH6x4G/XSm9NkEPdAxVkDEcm9o6AOZcZk4m6K7icg2hkYOtNeWWhisYqcRauFgU9Jq5ISCSz4lHo07qEohR5FlmFZjNLkblVeO0ywXudIu4os2RAGlFHv58qLET/QMQmushgzp9txblk3sLPvukvF1EMfoRCkRFpEAGdgqmSssWYjOmCrPWamsc5Dga6sNIw63mkuDaq8PMvNnUCPMG33B+GSfdwbwhL8X8syV2dpmxzVN/QhjIyx0k/AXee9hd8y3wn5XjbGInzLCKj1vRk+FzaoxqQvtSeofbqZvQ93LljLQzJGqxKx4N6rE9LFeQP8tWKQQ0z84fEXa5kP2y1//h30PXEuWqZmj1qTSkM+bEptUgJJO3qGtVhbJrYCCGjGeOOLz90vA4I8Zt7/89X8New0zNK8iCzlEbm0dVuNcJOwohBJsbe2z5/SkaoUXdJKGXSoX+no4K93oXMizHjuQc7JON7cNttO4zjbohmuVC+UYjKikjxx2a/YaiMgeaiA/BzJ7Y924MTBIhfOgaVVN3WptYPzmulltuLeDNGXlQmYb2l4bcJx5kVxX3NkZsa7nimS4TtZZ1+8OMqXKk2afkVLdzB8vpLvRXbfUFDLlAjpiP019JI4T/Y7rVhffu6DIdmWthglQZGe3gisvhSen40CWrFvd4uPJ2tkZ6Pqml5C/IHkpVnonsO6meTN5C/pcJOH5u4aj+9S5H8VRLhLwRg9/dx18e/g9O9/pDaK49Ty4BXP3v3/1/OXrty8RGBSkDmHD3qA3INusMrbgsrVSt0Tu4rXWip3eFNTdFNTdFNTdFNTdFNT9ckq+bgrqbgrqbgrqbgrqbgrqbgrq/npI2BTU3RTU3RTU3RTU3RTU3RTU3RTU3RTU3RTU3RTU3RTU3RTUvT+yYlNQ977UKd0U1P0tKHBTUHdTUHdTUHdTUHdTUHdTUHdTUHdTUHdTUHdTUHdTUHdTUHdTUHdTUHdNQd1W2kW/zLmQrXxPl1t3vFBm930cZZh7t38cXV7iKu8wgwabf6oox+P4fRydcy0wOofS9uKQZoZ5HmeAyUrPXbDR9hEuHzvWpvjahWxFzJNzIw6Inq/t204PPHzz9iiKo1CprFAp5QXzGeaF8JlLjWklj1DbZZRzOa0o8SRyc165OhpZN63ujNLq/B+t7BUu5y0Iu/l2bhv4L25q5YDLS5eyR8ldrr/7tHaER2zojcf3/urq6v8AS3ubAA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},g=void 0,y={},f=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Draft Document"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/draftdocument",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio Button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document before it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date"\n "page": 1\n "x": 173\n "y": 588\n "w": 114\n "h": 21\n "options": {\n "name": "date"\n "response": "04/15/2024"\n "format": "mm/dd/yyyy"\n "color": "black"\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,s.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(a(),{parameters:void 0}),"\n",(0,s.jsx)(h(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createdocument_body_widgets"}}},title:"createdocument_body_signers"}},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"{{sender_name}} has requested you to sign {{document_title}}"},email_body:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"

Hi {{receiver_name}},

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

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

Sign here

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

Thanks,
Team OpenSign\u2122

"},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5},prefill:{type:"object",description:"You can provide widgets which can embed before sending to signer",properties:{widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"textbox"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:100},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},title:"draftdocument_body"}}},required:!0}}),"\n",(0,s.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{document_id:{type:"string",format:"string",example:"hji2zxcv2P"},url:{type:"string",format:"string",example:"https://url-to-send-document.com"}},title:"inline_draft_doc_res_200_1"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/851f8f65.6def8ea3.js b/assets/js/851f8f65.6def8ea3.js new file mode 100644 index 000000000..7e3e5d0ea --- /dev/null +++ b/assets/js/851f8f65.6def8ea3.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9070],{72700:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>j,contentTitle:()=>y,default:()=>b,frontMatter:()=>x,metadata:()=>i,toc:()=>g});const i=JSON.parse('{"id":"API-docs/v1.1/draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","source":"@site/docs/API-docs/v1.1/draftdocument.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/draftdocument","permalink":"/docs/API-docs/v1.1/draftdocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","sidebar_label":"Draft Document","hide_title":true,"hide_table_of_contents":true,"api":"eJztPGtzHDdyfwWZSpUsZrgvkpLMKKqjJcVWzpFYFhXXhdTR2JneHYgzwBjAcLlmseo+3D/Ip3y9n+ZfkuoGMI99kJRE+6jL+oPMxeDRaHQ3Gv26jCyfmmj/OHqhkqoAaU30Po5SMIkWpRVKRvvRUQbsheYTy0IndnD4ivE8VzPDKgPaMKvYFCRoboFJmLE0TMfGc1ZqdS5SIacs5ZazmbAZ42zMDTzaZSATlULKJiKH3ok8kUei3GfvylzxlM1Vpdnhi3+v58OFsO14a+sFjKspe/dqa+v9V5m1pdnv93lZ9lQJ0oipzPnY9BJV9FPsWKaThzGbZaABZ2UJlwy4Efmc8TRlM5FOwZqY2QwkS1Q5Z4lSOhWSWzAxK/kUmKyKMWgTMy5TVigNTEjGmQaezret2q4MsP94++Y1myhdcNtjh3ll4nq5VGhIbD5309sM6l09MAEbxmohpzEr+BniS1j2cyWSM9y2AZni/3HgweErwtXW1tuqLJW2kLIf3Rb2t7bwyzeQqxnjGqh/oopCSVZyzQuwdGAZt/RZw8+V0JD6Y8nzgIv9E7nNtrbsvIT9rS32SqYiQWTQhNjK1MT37bmuiCTs+raEREyE79pCHVOSzTKRZISTGXfnWeY8cWBqMCUkVpxDd+KLmM1x4hcgVYAgU1r8oqTlOR3HOWgrEp63jw0BxK7Gcm0RnaUS0oZWvwL7kz8ePD06FE9XCFqKyCqEpC8G2DnPKzAeqlnMMoTqByg1GCJ2Py8iUqYsAzHN1q7H0w+VsZ2JWWUQzDYUfq1wSoReILRNeG6AiUkHlwU/g9ZqTBET87zHvpmzFCa8ym3MBFKc1RX02GtlGS/LXCR8nANSLkPm4bbSsE2n7MnBAyJ5QWd8SDwNhnGWiskENDInfqQp/JgAHdJZIwSIc2zGJVNy4aATlSu9TELU3MUjS5S0IG2PHZxzkRPwbrOGCZnkVQpsnPPkLGbjvIKYaUgd484BBVfs6J26MG48zgk/zECOVKgkwi+VX14YZjxUaY8dZcI0/IQfA6ppEWHaWPVcO1G4MqIgsBiDgos8JsTF7IMaMytsDjEybMnlPEaJCTGzcGHH6iJmSQbJGf2leSoUG1fWKuk2lmpVpmomPS4nSlojflnBkeHLx2N0FLPdmD2K2ZOYDQcxG45iNtyN2fBRzIZPYjYaxGw0itloN2ajRw6s0ZM4iPyA4DYAw5HDsv1ysIty93thiLNRYJpaBs86MnjYY1tbNTdh208//XQiL08kYycRMtdJtM9OorrLSRS7bygz8dvQ/77AHzujx/7nHH8+Gj3xP2fUdbjrf2b4czQ8kVd+wRM5IkgsL8proMDPdwqB/+WJCNtoUWwL8gwbURDF4QOeVQce/HDV3ssO7kVIYQXPzfrthB73aEcNSEub2sVNEbmu3xF9vkfbacODX0hMuk8kVlufAsMTFKOl3e/1/M2yfvNu2Xuz9xY4n7f1R7h1FE1HKJrW77+WXvcICYswfR4mHvdIASDJvB4PvsM9wkIXos/DwRPEAV5K6xGAX+/R7lvg4Ad/w7tvg93t4d72aDDa7WAA30auQ1Fsp+n2fD6/C+yhzuOXR5UnaKhOs8N36USrYsXzg14HTS+vE9HfQWX/T1TUx0GHhRTfffSwCBpL/eJra9lWpXz+wLipwtBaOcP+jWo2b4FJnxAOev0mmRKJBx77BJVsjA+8HuJgmzDZT9N+C5PYmKbbRbG90Ig/twnxrcai6KVpb6Hn0um4xoKlacyWm1e2pykrimJNs2vvNPeLYnkXvaLwsJHy9TUyidfZ1vOJ7/B7sUrDEd2Fr2UjtBwomdPa9JxbzUcLl00mpP/giYotdNAwrXKu4QLfpUYo6XrfPY8FFms0e3rH0hOQrAQOFeyrN157f+jJH7fQnQBbbh63tDOc5IAllbGqYBqmcMFKbi1oSZOd81yknJ5y29QAF7wo8QnQ//PJSfov/9wnAwS+8S3Dk2CpmAq0A/X/fHyw/d/vV/SoyhJ0wg2wHHAlEzOwSY8dZ5CXjSlqNpv1ZjsmyZTKnR3qg9Ewcf+eqvGHUwK37HFTPly1U0carQc/ks7ie9+A7WCMGxZGrnjyE40RDw0HdNv69841163vcY9unAWQ8KOznuDn45Oo4KSQIClD87eyGeiT6H09xj3yIb1h7PtbMGsmUsj5GPLlT7dmtLo553NVef4ORq3uVj1Ft/CGHwoha7sFbWcQtz7yi4WP7tvVCv52CGlzZ7hyAnuGE2C5MMFy00Vne7Q3bZHBUQKQDXMMLAxAA3GQHp/LBTVgt2MDJ4n82d2wBPZj1LE2K4bVblihczBtxOAchZCiqIraPjqpZw0oK7zu0cYXjkS7e1ihfbpLK/CLG1ZAY+T6BU7kkOwYwf5xjWbqe9wjWbEA0vVs/ClSpHNP39EFezMDhm21GXDFtYxd3YVcM59Zz3099gavN7TJukFoZUsSKC1a5D6XNWuQb31Dkc3K2eG+ITvcesprW+vuEfWtAOs3pkDf765vn08i0vbuvyBC7YB9a2J1RsmCT695udPne0SeHp4lI8TW1qGGicjzlkuRhabg2UGXDuRQeLeXdybiVUeGcCGtwmdBcNuOYUL+UktulIw3Dkd3z7gjbftEWaKBW6VZxo3Tv0nhx6NCh63NoFgwxQfQGnO8kAFuPJXh3b0bR18P2uc0fLTXOae9QeecBuvO6ZpnI56gKZU0ta0Nmk8tvqYjDu3LV8si24ZJ8UhfSvSthNeDYwZV5SnLxRl5VVJhypzP8VQDl3ooF911zzOlTNPDe8y+8hve73rilEZn3MNe7Zi4jcFr4TBaZzF8vNM6ir0nT7oc02GY27zfm/WWT2Gw2x/u9Z1Fa7VBqzHDrBfC12gCjN3mvMhOdKvzop7NgW3MTp9qdrobct+5y1f38PGoc1nsDD71srjzx3Wba254Vt/F4/nOXrFtdrvl+/V3e0d+PvXtNhr1+M406uHjnTYVPh7egQl1jeL8uZS4pB/fGe2xu1KOVxHgLbTja1XizybQNrC/OZHu3Y0mPRx0NLSvOwra16M2Ue7t3Yoo24suUNZJJP7rmzc/zAZ//HaqDg4ODl6/fZe9fDc9ODgo8Hev11v5iFp12rQMaq4+ItDfy3THr1ml1+shCjG4cp+G90s5/Vc3Pl4/pnciozhSJUZtCiVfpdF+lGKcZ1DBo5ieEWDsNyqdR/uXkQ8Rwj99AA6O7H8wGCh6GZkkg4LjX+H5gaGlGNkZxRF5ijG6FM8x2o/U+AMkuEapEQYrwOBI6r1/GXq5gMgo9mpWtB+5fUVx5G35dVMdSlqmk+gqLHjdVHVLM5WhP+pXCM6DMYefOM1rHHq1EFD7STO9aM1AeyvgSD1X+M3CCz43rXmdqS9ajOPFMcjhiR/FUj43KCkq4261hOdJlaMyCBel0PPaIUoaYYsqanjrlWp4h3tXMQU0gW6DxLXm8yiOhIWi3b6GCLT6+JNLQCFmKCrlY8d+UDAG+INvQG8NHTwvPhqKDwrYGOjQy0zJjx4/HO0MR8Od4Qhn8C/aT8ej+7oMQZcwDjBwDtKg6Ww3EaAxoyis3k00GvrTtvkUbibGo3WRwa2ARJPR84aXJXDdowDdT4797tJ3faX2bqDmqzi6uHkzFyxR2yHsmH2Vw8Q6NyFLlJagH7ZjD+7N5ka7u1dxNL95e/MvcnuP8fBmN+/uR4rXbmLZ/x6w7jy5iqPsZli/qyPK/47A7j66am7XiMx0EC6H07FK56dBbl3d1DFcFNhvovIUNGohy/KqETUoYTAT4nRRzo+VyoHLFYKmE0rss1ZQ40Wjr7eCzDLAh0OjCNPsjZbtTcQOWgxPhoWIB2FQQdUVnEQ99mrS0tlJh16MZg59KbJYKvaA1js1FYnxB33/G3H0oJ21gTbWJugogECdmYWizCntYYaG2jF58NIeq/8jda/GJAIQrsuw8M1XxXMXaUEL+kHdnAHmNcYee85lHTfejc9ml5c1GRB1XF2xy0s8VdCneOleXcVNA67VaaB71bVoSECcd0bVTdAMrNtaQ52Kc4oqjmvwcXxtAMRUCjk9rbSfBzXBq6tehyAXACdztccBpDWdialcsetaX6GTvjX2l5DtKQAn+X+D96fls+/EClCe9stnT8tnP2KGUAmO9xx6JkKmjvNnkOc99tRYreT02QIKnvZ9++qj1HAuYEaMS6fazLKI23qinofpTyiom8MThiW6SgTPKcRIqwSCVwTPTeKz2VgoDbqhhKWRLomD9HE+1UD+F4KFV5YyouhBFhZ8ylmmYfJvDxZw+uDZWwQdk+Ge9vkz3/uVMwRk/BwYl3NGGyerhdLO8jWpNInJJOdaTPzrL2ZlDhgOhY9DnjgvmsNogOMo4/LMxE/H+tkR8IK9KUEiBL/+9W/YI8j0V/KNTkHfQqi/mjh/nWIPUI49iF1oFpG70MZ6Ue0koacQB9ca1vGh+ejme1mLflONDfaSYb5GtFotplNAL5bvQYN9ogvwJHOXBkHFJ8FuXyLxqMoE8JDAwmuMXFrC0YeQ066dpYUdcqC1995bJdUlZsa8OTq8BS7JCLTtGMVZQNwu3RzszdEhJtfVx91j70yNiYBa3unC8BnOzgUPCTi1Zj934SzgPBleLra9fj2f1rbNlgFKhVkJUewudZRwdTLq0sRN9iUekaosehGFzykiLuvgkaCoEXmkqttQ5Q2Y5GxaUfSwRfYNtyYFEDbJcUIaqysXysPSSod8QE8WTkwY0+ApYAU7teaPGUjjhnM24caCjlklBWJeV2gXrKeEixK0AJnAShRocKhD0XHzFdXNNHv3w/c+5zbsITDlGDnQTQwpq0qiGuKEOgMynNzi1lfqg1583wwg6m6Up+iNmyVooySKOKWnXHoJ6t6jaMEcQ8Zz19WLCnSCITzI4V1ggqb961//1oJrrUViGTC3Ak9TDG+9AUIyBjuCxwguDSVKQNWFCOcD/YfFJwBCR0xzWqi0ZiRzexo/pIBYU8tF75WvIwJMlWR4bdXy1sRBxhpvVDBk9yXjMLn1S9wvXAhjWzl8IdJ+WT78AIjHpAUDPUKRq5Hm5bzN4E2kglqYjp4Hopv/WT+ClniBV1adaiiEvN091bazW1ULgsqqgluRsDCV6XWzep0zN/B1wb4KoCE1ngulH65hVZzuVMkEToU8hXPQt3jev64jA8kgOAY7A5Bt2AKS3HXWZF7OMFm+g5PW7UT5xW0o0TJYunCMVZarLlAhSzqEuAd6cFcJZe8XYwwLcoElyGokOMIrbckU9qXY0nyExcaS9gWZmoaDwT+yJW1n8OVY0nYHX5Al7QkC672ONwugdfrNStkRXIvXD/igyGRPztnre6Ivj4x0zve9CsENO4yu3H+N8S/I/XZbx9foLCA0pvEd+tdM2AthYTQY4P+6p/miEzSIum2VoK44qfJ8/k9RfHvH5fVHUEMrVpopr5Pr2Qcx+uUiOR8dIh7X6NLXTuAJsdI5FpvBG2+71mNIp2vhVshcSDglFJ+mKjnVYE5Hg8HpMHIHs7sKjW9VATYj9QuROUPrRf28t3rO+JQLyZDG9R1iFbS+ifw+DrIVmAg0dLrbQcLeMhJeScqxoRpHR+oM5O+70/by1i2PoF4UeSMDIuE60feos9l2u9ukgaTSws6j/ePL6GKbl2Lbfd8/fn/1Po4QsQp9/6UyBDG3WbQf9RdDAQzoc3LqHl868q0p0nCZYvzSknjkpeifD3vD6CpeHLNSnF7TH6rtjx1iLJ8KOb1p3PsGRW/xGN1JdRDVqIyl+COgzujPod0rjgSSTwYc3waIeaSOH5oAipfhjEOQw6q4heYsFyMRQiBCJ7Zg8VpbES2wOlhguNdy0x8Hjzs50Wsf+iq3eL314Oiu/dwt13XLc33c0HrtJA6a7ZBUwtHuLulOj4ekZOw8oft799EVUWfjFYqirueHotoX/RefZ47vWuM3JuZ/IBPzgoXZE09jJnXRfx17n2/q2r8CFdb2po7RZ9Hms9b+ssb84pdcMDPUgKx63e91HtUr+C4ohV2uw/g45LqdAXHd7oC47smgo4/6HTYzNFolqY615kjqYVs7RBXwPcpAISeKBKiXauFc6H4jAbz0ioA8UUVd1mlrq3WU9aitrVowOnLE0ME3lWalmoGeVK5O1CSHC4GGChwGBX1rfL/AixyMyTFg3sKUahdS+jdahL3NMeElH4tc4AXuklocYzQ6gOmxHxvv8QPtsuHPIcd7vzb1YO3DoKPOlD6boBc6xiqIWPINjX0gMy4TZ1d0txHZx9DQgTbbUguDlew0Qi0cbEpajdxQcMmnxKdxm+5ZCjmKLcO0GqPZ3ai8ctxmuciVdlFftCEKKiUkvrwo8RM9hdAiqyFD2j331mUTO+u+u2h8LcQxOlJKhEUkQEa2SuYKyxaiQ6bKc1Yq65wk+OJqw4jDrebSoOrrA838GdQI84ZfMD7h550BPOHvhTxzpba22XFNVz/C2AgL3UT8Rf572B3zrbDfVWMs5KeMsErPm9FTYbNqTCpDe5L6h5vp21D7sqUQNHOkKjEr3o4qMX2sGdB/CxYpxPQPDl+RxvmQ/fqX/2HfA9eSZWrmqDWpNOTzpswmFaGkk3doqxVGci2gsEaMJ474/B0TMPhjxu2vf/lfw17DDE2sjqVcUOphNc5Fwo5COMHW1j57Ts+qVohBJ3HYpXOhv4ez0o3OhTzrsQM5Jwt1c+NgO43rbINuuVbJUI4BiUr66GG3Zq+BiGyiBvJzINM31o4bA4NUOC+aVtXUrdYGxm+um9mGeztIU1YuZLeh/bUBx5kYyX3Fna0Ra3uuSIjrZJ51fe8gU6o+afYZKdbN/PFCyhvdd0tNIVsuoCP209RH4jjR77hudTG+C8psV95qmABFd3aruPJSeHI6DmTJuhUuPp6sna2BrnB6DflLkpdipYcCa2+aN5O3oM9FEp7Aazi6T537URzlIgFv+PD318G3h9+z853eIIpbT4RbMHf/+1fPX75++xKBQUHqEDbsDXoDss8qYwsuWyt1y+QuXm2t+OlNUd1NUd1NUd1NUd1NUd0vp+zrpqjupqjupqjupqjupqjupqjub4eETVHdTVHdTVHdTVHdTVHdTVHdTVHdTVHdTVHdTVHdTVHdTVHd+yMrNkV170ut0k1R3d+DAjdFdTdFdTdFdTdFdTdFdTdFdTdFdTdFdTdFdTdFdTdFdTdFdTdFdTdFddcU1W2lXvTLnAvZyvl0+XXHC6V238dRhvl3+8fR5SWu8g6zaLD554ryPI7fx9E51wKjcyh1Lw6pZpjrcQaYsPTcBRttH+HysWNtiq9dyFjEXDk34oDo+dq+7RTBwzdvj6I4CtXKCpVSbjCfYW4In7n0mFYCCbVdRjmX04qSTyI355WrpZF1U+vOKLXO/9HKYOFy3oKwm3PntoH/4qZWDri8dGl7lODl+rtPa0d4xIbeeHzvr66u/g9g3Ju1","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Self Sign","permalink":"/docs/API-docs/v1.1/selfsign"},"next":{"title":"Create Document","permalink":"/docs/API-docs/v1.1/createdocument"}}');var s=t(74848),o=t(28453),r=t(33617),l=t.n(r),d=t(17543),a=t.n(d),c=t(86013),p=t.n(c),h=t(63723),u=t.n(h),m=(t(18766),t(79329),t(9303));const x={id:"draftdocument",title:"Draft Document",description:"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztPGtzHDdyfwWZSpUsZrgvkpLMKKqjJcVWzpFYFhXXhdTR2JneHYgzwBjAcLlmseo+3D/Ip3y9n+ZfkuoGMI99kJRE+6jL+oPMxeDRaHQ3Gv26jCyfmmj/OHqhkqoAaU30Po5SMIkWpRVKRvvRUQbsheYTy0IndnD4ivE8VzPDKgPaMKvYFCRoboFJmLE0TMfGc1ZqdS5SIacs5ZazmbAZ42zMDTzaZSATlULKJiKH3ok8kUei3GfvylzxlM1Vpdnhi3+v58OFsO14a+sFjKspe/dqa+v9V5m1pdnv93lZ9lQJ0oipzPnY9BJV9FPsWKaThzGbZaABZ2UJlwy4Efmc8TRlM5FOwZqY2QwkS1Q5Z4lSOhWSWzAxK/kUmKyKMWgTMy5TVigNTEjGmQaezret2q4MsP94++Y1myhdcNtjh3ll4nq5VGhIbD5309sM6l09MAEbxmohpzEr+BniS1j2cyWSM9y2AZni/3HgweErwtXW1tuqLJW2kLIf3Rb2t7bwyzeQqxnjGqh/oopCSVZyzQuwdGAZt/RZw8+V0JD6Y8nzgIv9E7nNtrbsvIT9rS32SqYiQWTQhNjK1MT37bmuiCTs+raEREyE79pCHVOSzTKRZISTGXfnWeY8cWBqMCUkVpxDd+KLmM1x4hcgVYAgU1r8oqTlOR3HOWgrEp63jw0BxK7Gcm0RnaUS0oZWvwL7kz8ePD06FE9XCFqKyCqEpC8G2DnPKzAeqlnMMoTqByg1GCJ2Py8iUqYsAzHN1q7H0w+VsZ2JWWUQzDYUfq1wSoReILRNeG6AiUkHlwU/g9ZqTBET87zHvpmzFCa8ym3MBFKc1RX02GtlGS/LXCR8nANSLkPm4bbSsE2n7MnBAyJ5QWd8SDwNhnGWiskENDInfqQp/JgAHdJZIwSIc2zGJVNy4aATlSu9TELU3MUjS5S0IG2PHZxzkRPwbrOGCZnkVQpsnPPkLGbjvIKYaUgd484BBVfs6J26MG48zgk/zECOVKgkwi+VX14YZjxUaY8dZcI0/IQfA6ppEWHaWPVcO1G4MqIgsBiDgos8JsTF7IMaMytsDjEybMnlPEaJCTGzcGHH6iJmSQbJGf2leSoUG1fWKuk2lmpVpmomPS4nSlojflnBkeHLx2N0FLPdmD2K2ZOYDQcxG45iNtyN2fBRzIZPYjYaxGw0itloN2ajRw6s0ZM4iPyA4DYAw5HDsv1ysIty93thiLNRYJpaBs86MnjYY1tbNTdh208//XQiL08kYycRMtdJtM9OorrLSRS7bygz8dvQ/77AHzujx/7nHH8+Gj3xP2fUdbjrf2b4czQ8kVd+wRM5IkgsL8proMDPdwqB/+WJCNtoUWwL8gwbURDF4QOeVQce/HDV3ssO7kVIYQXPzfrthB73aEcNSEub2sVNEbmu3xF9vkfbacODX0hMuk8kVlufAsMTFKOl3e/1/M2yfvNu2Xuz9xY4n7f1R7h1FE1HKJrW77+WXvcICYswfR4mHvdIASDJvB4PvsM9wkIXos/DwRPEAV5K6xGAX+/R7lvg4Ad/w7tvg93t4d72aDDa7WAA30auQ1Fsp+n2fD6/C+yhzuOXR5UnaKhOs8N36USrYsXzg14HTS+vE9HfQWX/T1TUx0GHhRTfffSwCBpL/eJra9lWpXz+wLipwtBaOcP+jWo2b4FJnxAOev0mmRKJBx77BJVsjA+8HuJgmzDZT9N+C5PYmKbbRbG90Ig/twnxrcai6KVpb6Hn0um4xoKlacyWm1e2pykrimJNs2vvNPeLYnkXvaLwsJHy9TUyidfZ1vOJ7/B7sUrDEd2Fr2UjtBwomdPa9JxbzUcLl00mpP/giYotdNAwrXKu4QLfpUYo6XrfPY8FFms0e3rH0hOQrAQOFeyrN157f+jJH7fQnQBbbh63tDOc5IAllbGqYBqmcMFKbi1oSZOd81yknJ5y29QAF7wo8QnQ//PJSfov/9wnAwS+8S3Dk2CpmAq0A/X/fHyw/d/vV/SoyhJ0wg2wHHAlEzOwSY8dZ5CXjSlqNpv1ZjsmyZTKnR3qg9Ewcf+eqvGHUwK37HFTPly1U0carQc/ks7ie9+A7WCMGxZGrnjyE40RDw0HdNv69841163vcY9unAWQ8KOznuDn45Oo4KSQIClD87eyGeiT6H09xj3yIb1h7PtbMGsmUsj5GPLlT7dmtLo553NVef4ORq3uVj1Ft/CGHwoha7sFbWcQtz7yi4WP7tvVCv52CGlzZ7hyAnuGE2C5MMFy00Vne7Q3bZHBUQKQDXMMLAxAA3GQHp/LBTVgt2MDJ4n82d2wBPZj1LE2K4bVblihczBtxOAchZCiqIraPjqpZw0oK7zu0cYXjkS7e1ihfbpLK/CLG1ZAY+T6BU7kkOwYwf5xjWbqe9wjWbEA0vVs/ClSpHNP39EFezMDhm21GXDFtYxd3YVcM59Zz3099gavN7TJukFoZUsSKC1a5D6XNWuQb31Dkc3K2eG+ITvcesprW+vuEfWtAOs3pkDf765vn08i0vbuvyBC7YB9a2J1RsmCT695udPne0SeHp4lI8TW1qGGicjzlkuRhabg2UGXDuRQeLeXdybiVUeGcCGtwmdBcNuOYUL+UktulIw3Dkd3z7gjbftEWaKBW6VZxo3Tv0nhx6NCh63NoFgwxQfQGnO8kAFuPJXh3b0bR18P2uc0fLTXOae9QeecBuvO6ZpnI56gKZU0ta0Nmk8tvqYjDu3LV8si24ZJ8UhfSvSthNeDYwZV5SnLxRl5VVJhypzP8VQDl3ooF911zzOlTNPDe8y+8hve73rilEZn3MNe7Zi4jcFr4TBaZzF8vNM6ir0nT7oc02GY27zfm/WWT2Gw2x/u9Z1Fa7VBqzHDrBfC12gCjN3mvMhOdKvzop7NgW3MTp9qdrobct+5y1f38PGoc1nsDD71srjzx3Wba254Vt/F4/nOXrFtdrvl+/V3e0d+PvXtNhr1+M406uHjnTYVPh7egQl1jeL8uZS4pB/fGe2xu1KOVxHgLbTja1XizybQNrC/OZHu3Y0mPRx0NLSvOwra16M2Ue7t3Yoo24suUNZJJP7rmzc/zAZ//HaqDg4ODl6/fZe9fDc9ODgo8Hev11v5iFp12rQMaq4+ItDfy3THr1ml1+shCjG4cp+G90s5/Vc3Pl4/pnciozhSJUZtCiVfpdF+lGKcZ1DBo5ieEWDsNyqdR/uXkQ8Rwj99AA6O7H8wGCh6GZkkg4LjX+H5gaGlGNkZxRF5ijG6FM8x2o/U+AMkuEapEQYrwOBI6r1/GXq5gMgo9mpWtB+5fUVx5G35dVMdSlqmk+gqLHjdVHVLM5WhP+pXCM6DMYefOM1rHHq1EFD7STO9aM1AeyvgSD1X+M3CCz43rXmdqS9ajOPFMcjhiR/FUj43KCkq4261hOdJlaMyCBel0PPaIUoaYYsqanjrlWp4h3tXMQU0gW6DxLXm8yiOhIWi3b6GCLT6+JNLQCFmKCrlY8d+UDAG+INvQG8NHTwvPhqKDwrYGOjQy0zJjx4/HO0MR8Od4Qhn8C/aT8ej+7oMQZcwDjBwDtKg6Ww3EaAxoyis3k00GvrTtvkUbibGo3WRwa2ARJPR84aXJXDdowDdT4797tJ3faX2bqDmqzi6uHkzFyxR2yHsmH2Vw8Q6NyFLlJagH7ZjD+7N5ka7u1dxNL95e/MvcnuP8fBmN+/uR4rXbmLZ/x6w7jy5iqPsZli/qyPK/47A7j66am7XiMx0EC6H07FK56dBbl3d1DFcFNhvovIUNGohy/KqETUoYTAT4nRRzo+VyoHLFYKmE0rss1ZQ40Wjr7eCzDLAh0OjCNPsjZbtTcQOWgxPhoWIB2FQQdUVnEQ99mrS0tlJh16MZg59KbJYKvaA1js1FYnxB33/G3H0oJ21gTbWJugogECdmYWizCntYYaG2jF58NIeq/8jda/GJAIQrsuw8M1XxXMXaUEL+kHdnAHmNcYee85lHTfejc9ml5c1GRB1XF2xy0s8VdCneOleXcVNA67VaaB71bVoSECcd0bVTdAMrNtaQ52Kc4oqjmvwcXxtAMRUCjk9rbSfBzXBq6tehyAXACdztccBpDWdialcsetaX6GTvjX2l5DtKQAn+X+D96fls+/EClCe9stnT8tnP2KGUAmO9xx6JkKmjvNnkOc99tRYreT02QIKnvZ9++qj1HAuYEaMS6fazLKI23qinofpTyiom8MThiW6SgTPKcRIqwSCVwTPTeKz2VgoDbqhhKWRLomD9HE+1UD+F4KFV5YyouhBFhZ8ylmmYfJvDxZw+uDZWwQdk+Ge9vkz3/uVMwRk/BwYl3NGGyerhdLO8jWpNInJJOdaTPzrL2ZlDhgOhY9DnjgvmsNogOMo4/LMxE/H+tkR8IK9KUEiBL/+9W/YI8j0V/KNTkHfQqi/mjh/nWIPUI49iF1oFpG70MZ6Ue0koacQB9ca1vGh+ejme1mLflONDfaSYb5GtFotplNAL5bvQYN9ogvwJHOXBkHFJ8FuXyLxqMoE8JDAwmuMXFrC0YeQ066dpYUdcqC1995bJdUlZsa8OTq8BS7JCLTtGMVZQNwu3RzszdEhJtfVx91j70yNiYBa3unC8BnOzgUPCTi1Zj934SzgPBleLra9fj2f1rbNlgFKhVkJUewudZRwdTLq0sRN9iUekaosehGFzykiLuvgkaCoEXmkqttQ5Q2Y5GxaUfSwRfYNtyYFEDbJcUIaqysXysPSSod8QE8WTkwY0+ApYAU7teaPGUjjhnM24caCjlklBWJeV2gXrKeEixK0AJnAShRocKhD0XHzFdXNNHv3w/c+5zbsITDlGDnQTQwpq0qiGuKEOgMynNzi1lfqg1583wwg6m6Up+iNmyVooySKOKWnXHoJ6t6jaMEcQ8Zz19WLCnSCITzI4V1ggqb961//1oJrrUViGTC3Ak9TDG+9AUIyBjuCxwguDSVKQNWFCOcD/YfFJwBCR0xzWqi0ZiRzexo/pIBYU8tF75WvIwJMlWR4bdXy1sRBxhpvVDBk9yXjMLn1S9wvXAhjWzl8IdJ+WT78AIjHpAUDPUKRq5Hm5bzN4E2kglqYjp4Hopv/WT+ClniBV1adaiiEvN091bazW1ULgsqqgluRsDCV6XWzep0zN/B1wb4KoCE1ngulH65hVZzuVMkEToU8hXPQt3jev64jA8kgOAY7A5Bt2AKS3HXWZF7OMFm+g5PW7UT5xW0o0TJYunCMVZarLlAhSzqEuAd6cFcJZe8XYwwLcoElyGokOMIrbckU9qXY0nyExcaS9gWZmoaDwT+yJW1n8OVY0nYHX5Al7QkC672ONwugdfrNStkRXIvXD/igyGRPztnre6Ivj4x0zve9CsENO4yu3H+N8S/I/XZbx9foLCA0pvEd+tdM2AthYTQY4P+6p/miEzSIum2VoK44qfJ8/k9RfHvH5fVHUEMrVpopr5Pr2Qcx+uUiOR8dIh7X6NLXTuAJsdI5FpvBG2+71mNIp2vhVshcSDglFJ+mKjnVYE5Hg8HpMHIHs7sKjW9VATYj9QuROUPrRf28t3rO+JQLyZDG9R1iFbS+ifw+DrIVmAg0dLrbQcLeMhJeScqxoRpHR+oM5O+70/by1i2PoF4UeSMDIuE60feos9l2u9ukgaTSws6j/ePL6GKbl2Lbfd8/fn/1Po4QsQp9/6UyBDG3WbQf9RdDAQzoc3LqHl868q0p0nCZYvzSknjkpeifD3vD6CpeHLNSnF7TH6rtjx1iLJ8KOb1p3PsGRW/xGN1JdRDVqIyl+COgzujPod0rjgSSTwYc3waIeaSOH5oAipfhjEOQw6q4heYsFyMRQiBCJ7Zg8VpbES2wOlhguNdy0x8Hjzs50Wsf+iq3eL314Oiu/dwt13XLc33c0HrtJA6a7ZBUwtHuLulOj4ekZOw8oft799EVUWfjFYqirueHotoX/RefZ47vWuM3JuZ/IBPzgoXZE09jJnXRfx17n2/q2r8CFdb2po7RZ9Hms9b+ssb84pdcMDPUgKx63e91HtUr+C4ohV2uw/g45LqdAXHd7oC47smgo4/6HTYzNFolqY615kjqYVs7RBXwPcpAISeKBKiXauFc6H4jAbz0ioA8UUVd1mlrq3WU9aitrVowOnLE0ME3lWalmoGeVK5O1CSHC4GGChwGBX1rfL/AixyMyTFg3sKUahdS+jdahL3NMeElH4tc4AXuklocYzQ6gOmxHxvv8QPtsuHPIcd7vzb1YO3DoKPOlD6boBc6xiqIWPINjX0gMy4TZ1d0txHZx9DQgTbbUguDlew0Qi0cbEpajdxQcMmnxKdxm+5ZCjmKLcO0GqPZ3ai8ctxmuciVdlFftCEKKiUkvrwo8RM9hdAiqyFD2j331mUTO+u+u2h8LcQxOlJKhEUkQEa2SuYKyxaiQ6bKc1Yq65wk+OJqw4jDrebSoOrrA838GdQI84ZfMD7h550BPOHvhTxzpba22XFNVz/C2AgL3UT8Rf572B3zrbDfVWMs5KeMsErPm9FTYbNqTCpDe5L6h5vp21D7sqUQNHOkKjEr3o4qMX2sGdB/CxYpxPQPDl+RxvmQ/fqX/2HfA9eSZWrmqDWpNOTzpswmFaGkk3doqxVGci2gsEaMJ474/B0TMPhjxu2vf/lfw17DDE2sjqVcUOphNc5Fwo5COMHW1j57Ts+qVohBJ3HYpXOhv4ez0o3OhTzrsQM5Jwt1c+NgO43rbINuuVbJUI4BiUr66GG3Zq+BiGyiBvJzINM31o4bA4NUOC+aVtXUrdYGxm+um9mGeztIU1YuZLeh/bUBx5kYyX3Fna0Ra3uuSIjrZJ51fe8gU6o+afYZKdbN/PFCyhvdd0tNIVsuoCP209RH4jjR77hudTG+C8psV95qmABFd3aruPJSeHI6DmTJuhUuPp6sna2BrnB6DflLkpdipYcCa2+aN5O3oM9FEp7Aazi6T537URzlIgFv+PD318G3h9+z853eIIpbT4RbMHf/+1fPX75++xKBQUHqEDbsDXoDss8qYwsuWyt1y+QuXm2t+OlNUd1NUd1NUd1NUd1NUd0vp+zrpqjupqjupqjupqjupqjupqjub4eETVHdTVHdTVHdTVHdTVHdTVHdTVHdTVHdTVHdTVHdTVHdTVHd+yMrNkV170ut0k1R3d+DAjdFdTdFdTdFdTdFdTdFdTdFdTdFdTdFdTdFdTdFdTdFdTdFdTdFdTdFddcU1W2lXvTLnAvZyvl0+XXHC6V238dRhvl3+8fR5SWu8g6zaLD554ryPI7fx9E51wKjcyh1Lw6pZpjrcQaYsPTcBRttH+HysWNtiq9dyFjEXDk34oDo+dq+7RTBwzdvj6I4CtXKCpVSbjCfYW4In7n0mFYCCbVdRjmX04qSTyI355WrpZF1U+vOKLXO/9HKYOFy3oKwm3PntoH/4qZWDri8dGl7lODl+rtPa0d4xIbeeHzvr66u/g9g3Ju1",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,j={},g=[];function f(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(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:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio Button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document before it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date"\n "page": 1\n "x": 173\n "y": 588\n "w": 114\n "h": 21\n "options": {\n "name": "date"\n "response": "04/15/2024"\n "format": "mm/dd/yyyy"\n "color": "black"\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(a(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createdocument_body_widgets"}}},title:"createdocument_body_signers"}},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"{{sender_name}} has requested you to sign {{document_title}}"},email_body:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"

Hi {{receiver_name}},

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

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

Sign here

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

Thanks,
Team OpenSign\u2122

"},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5},prefill:{type:"object",description:"You can provide widgets which can embed before sending to signer",properties:{widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"textbox"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:100},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},title:"draftdocument_body"}}},required:!0}}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{document_id:{type:"string",format:"string",example:"hji2zxcv2P"},url:{type:"string",format:"string",example:"https://url-to-send-document.com"}},title:"inline_draft_doc_res_200_1"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/98334e25.0914355c.js b/assets/js/98334e25.0914355c.js deleted file mode 100644 index ca398e9d7..000000000 --- a/assets/js/98334e25.0914355c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7024],{16460:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>k,contentTitle:()=>g,default:()=>y,frontMatter:()=>Z,metadata:()=>i,toc:()=>m});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":"eJy9Vktv20YQ/iuTvbQRaElpUxTQKUZguEaNxKgd+CALwZIckhstdze7Qz0gCMih/6CnXvvT8kuKWZJ6OUmbtuhFj9l5zzePjSBZBjGZintMK2vnYpaIHEPmlSNljZiIuwrhEgk6Bji/uQKptV3C2jZAFkokWHaPjdciEdahlyx+lYuJKJF65YnwGJw1AYOYbMR34zF/Hdu7bbIMQygaDTs9IhGZNYSGmF86p1UWH0bvAgttRMgqrCX/orVDMRE2fYcZiUQ4z2pItSY7Rw8YA3llSpEIXMnaaSZVRC5MRqO1bfxZJ3HWeP2iYxlmthbbbSJIURRQRiuDb/vg3n43Hr/9UWy3zPN8/PxxkG8CejCWoLCNyZ/8d/Gh99Z/ObpT218KhJ3vw/jhcRhXZiG1yiMm7uwczf8byaF5as2zq6tas5yRdRtSZIrv4ijUQ3obZMCs8YrWYjLdiNWZdOqsfZ9MZ9tZImqkynaYZoclVWIiRssdvAP6BfoQ5bkX9lgK0uSpXQ2tQxNUabRMA+NoJJ0aLZ4Nn4ltciojnfsqfmzOvlYkkCyVKf9KbrbPzS3Xry3RUYZ2hZJO/YxrkfQFOORKhGLcVChz9LFYyhQ2Cndlee3Q3KrSxKJG46cD6R51Zmvk0UMVQi/w8dc/okxus6ZGQxF1UcOTB/NgXjcenF2i58EiTQ6FxpVKNUYhrONb6GdaQFlrDEGvQRnC0ktCyFWpSGrgHClTQiadTJVWjFhmsyzt4QD0YQj3FVKFnp++8QgSclygZqCDbMjWklhV7zQsrZ8X2i5DAhLSJiiDIQCaSpqMGfsqJGA9SANoCL3zKiAE8uy1an2zhrzMCGppZImsOzlKVY5aMVTB27QJBMHqJroMJJW2HnPoAzKIeRhyEi9Wjp+AqZmtnceKIbNAKBuVY0ggszlCiA3KIZgcUgwEjn1RGQZW2hhts3ksXtFoDc7yvFBSgy2OfGRx8tKEwvq69aWvwS5hzlteF9g6OBi8CcgVvlZmHiaDwYM5g+kOU/eYBkU4+7aH/3K5fAT7p8cyl4p+alL4BZ0Niqxf76VLRVWTxlY5VLL702q6RIMRPweNsNeR2yw87jymjirUbnSLxAgJo/Obqzhin8LHD7/BNUpvoLLLFq1Z41GvoexNcebayrdp201IKGwEXsUZz1rweXzfYKA+g/eVpI8ffg/wCpeg2hZqEzkY3DSpVhncYe20JAyDwQReemST1NOAKkmQSQMpQqgkQ2mhJEhwrbRWZj6Ec7OGhlfRUlEVwcD0KHcUBudlV+4AqQyYgzVRorc53HvE9DqgXmBgXbznUgTMFTGiK2+bsrV26EwXnMdCaQ33Ki+RYmzneQ6uIy9bMif8wB0suCGowjVIjxDQ0BBuTkTiS+Oc9eyFap0vLF9RXAA0ubPKUJhA7mVBe/3JHugZp1lZ8wlSm0K5S0fSqdmVpO3ELuIddfjAA/lkiB/PWo8FejYY2kuvr4tTHZymPSyB0fpvYM27maeWzOLpgLVUut0mL071xDWOvg6vi1v0C5X1R9tnOnoUmUciEVplaAIenAfnlzfXsPh+OBbJwWr8G809ur56efHq9oKd4UHaJuzZcDwcM8nZQLU0B5YOjujTnbbZH03/5N7uFi/hikZOSxXvnBjMprtRprvDd5aIygZi0mbDzfTG6+2Wye8b9Hz5zBKxkF7JlPfxdLZN+nXNR80c15y0LEPHF9BC6qbd+SeH3tG1dHlxJxLBU+f4TJjHM6H7wdr7J7M+0H18P7QO8CcfM58U2GzaE2S73fG3T5+V6ALsuTmBs+12+ydZv6Pt","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=o(74848),s=o(28453),l=o(33617),a=o.n(l),p=o(17543),r=o.n(p),c=o(86013),d=o.n(c),h=o(63723),b=o.n(h),u=(o(18766),o(79329),o(9303));const Z={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:"eJy9Vktv20YQ/iuTvbQRaElpUxTQKUZguEaNxKgd+CALwZIckhstdze7Qz0gCMih/6CnXvvT8kuKWZJ6OUmbtuhFj9l5zzePjSBZBjGZintMK2vnYpaIHEPmlSNljZiIuwrhEgk6Bji/uQKptV3C2jZAFkokWHaPjdciEdahlyx+lYuJKJF65YnwGJw1AYOYbMR34zF/Hdu7bbIMQygaDTs9IhGZNYSGmF86p1UWH0bvAgttRMgqrCX/orVDMRE2fYcZiUQ4z2pItSY7Rw8YA3llSpEIXMnaaSZVRC5MRqO1bfxZJ3HWeP2iYxlmthbbbSJIURRQRiuDb/vg3n43Hr/9UWy3zPN8/PxxkG8CejCWoLCNyZ/8d/Gh99Z/ObpT218KhJ3vw/jhcRhXZiG1yiMm7uwczf8byaF5as2zq6tas5yRdRtSZIrv4ijUQ3obZMCs8YrWYjLdiNWZdOqsfZ9MZ9tZImqkynaYZoclVWIiRssdvAP6BfoQ5bkX9lgK0uSpXQ2tQxNUabRMA+NoJJ0aLZ4Nn4ltciojnfsqfmzOvlYkkCyVKf9KbrbPzS3Xry3RUYZ2hZJO/YxrkfQFOORKhGLcVChz9LFYyhQ2Cndlee3Q3KrSxKJG46cD6R51Zmvk0UMVQi/w8dc/okxus6ZGQxF1UcOTB/NgXjcenF2i58EiTQ6FxpVKNUYhrONb6GdaQFlrDEGvQRnC0ktCyFWpSGrgHClTQiadTJVWjFhmsyzt4QD0YQj3FVKFnp++8QgSclygZqCDbMjWklhV7zQsrZ8X2i5DAhLSJiiDIQCaSpqMGfsqJGA9SANoCL3zKiAE8uy1an2zhrzMCGppZImsOzlKVY5aMVTB27QJBMHqJroMJJW2HnPoAzKIeRhyEi9Wjp+AqZmtnceKIbNAKBuVY0ggszlCiA3KIZgcUgwEjn1RGQZW2hhts3ksXtFoDc7yvFBSgy2OfGRx8tKEwvq69aWvwS5hzlteF9g6OBi8CcgVvlZmHiaDwYM5g+kOU/eYBkU4+7aH/3K5fAT7p8cyl4p+alL4BZ0Niqxf76VLRVWTxlY5VLL702q6RIMRPweNsNeR2yw87jymjirUbnSLxAgJo/Obqzhin8LHD7/BNUpvoLLLFq1Z41GvoexNcebayrdp201IKGwEXsUZz1rweXzfYKA+g/eVpI8ffg/wCpeg2hZqEzkY3DSpVhncYe20JAyDwQReemST1NOAKkmQSQMpQqgkQ2mhJEhwrbRWZj6Ec7OGhlfRUlEVwcD0KHcUBudlV+4AqQyYgzVRorc53HvE9DqgXmBgXbznUgTMFTGiK2+bsrV26EwXnMdCaQ33Ki+RYmzneQ6uIy9bMif8wB0suCGowjVIjxDQ0BBuTkTiS+Oc9eyFap0vLF9RXAA0ubPKUJhA7mVBe/3JHugZp1lZ8wlSm0K5S0fSqdmVpO3ELuIddfjAA/lkiB/PWo8FejYY2kuvr4tTHZymPSyB0fpvYM27maeWzOLpgLVUut0mL071xDWOvg6vi1v0C5X1R9tnOnoUmUciEVplaAIenAfnlzfXsPh+OBbJwWr8G809ur56efHq9oKd4UHaJuzZcDwcM8nZQLU0B5YOjujTnbbZH03/5N7uFi/hikZOSxXvnBjMprtRprvDd5aIygZi0mbDzfTG6+2Wye8b9Hz5zBKxkF7JlPfxdLZN+nXNR80c15y0LEPHF9BC6qbd+SeH3tG1dHlxJxLBU+f4TJjHM6H7wdr7J7M+0H18P7QO8CcfM58U2GzaE2S73fG3T5+V6ALsuTmBs+12+ydZv6Pt",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,k={},m=[];function v(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Get Webhook"}),"\n",(0,n.jsx)(a(),{method:"get",path:"/webhook",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"The Get Webhook API allow you to get webhook url"}),"\n",(0,n.jsx)(r(),{parameters:void 0}),"\n",(0,n.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,n.jsx)(b(),{id:void 0,label:void 0,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"}}}}}})]})}function y(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/98334e25.163938f2.js b/assets/js/98334e25.163938f2.js new file mode 100644 index 000000000..5baaed62e --- /dev/null +++ b/assets/js/98334e25.163938f2.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7024],{16460:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>g,contentTitle:()=>u,default:()=>v,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 i=t(74848),n=t(28453),r=t(33617),p=t.n(r),l=t(17543),a=t.n(l),d=t(86013),c=t.n(d),h=t(63723),b=t.n(h),m=(t(18766),t(79329),t(9303));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 f(e){const o={p:"p",...(0,n.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Get Webhook"}),"\n",(0,i.jsx)(p(),{method:"get",path:"/webhook",context:"endpoint"}),"\n",(0,i.jsx)(o.p,{children:"The Get Webhook API allow you to get webhook url"}),"\n",(0,i.jsx)(a(),{parameters:void 0}),"\n",(0,i.jsx)(c(),{title:"Body",body:void 0}),"\n",(0,i.jsx)(b(),{id:void 0,label:void 0,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"}}}}}})]})}function v(e={}){const{wrapper:o}={...(0,n.R)(),...e.components};return o?(0,i.jsx)(o,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/9c9cb35e.16dc0dc6.js b/assets/js/9c9cb35e.16dc0dc6.js new file mode 100644 index 000000000..f18593d5a --- /dev/null +++ b/assets/js/9c9cb35e.16dc0dc6.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4240],{19068:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>g,contentTitle:()=>j,default:()=>b,frontMatter:()=>x,metadata:()=>i,toc:()=>y});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":"eJztPNtyG7eSv4Kd2qrE3CFFUpLtaF9WyfFJvMcbq2J5U7uSjgLONDmwZoAJgBHFqFh1Hs4f7NO+nk/Ll2x1A5gLL5JsK4m9xTw44uDW3egGuhvdfRtZPjPR0Vl0CkWZcwsmuoijFEyiRWmFktFRdJoBC83sGw0cv7Pjk5eM57maG1YZ0IZZxRJsBJZUxqpC/MInOTAbJo7ZPBNJxgzoa2DcsEleQamFtIZNlWYzkKC5FXLGUpVUBWDDXNiMlRpSmAoJKTNWV4mtNJgBe1sqyUyVJGDMtMrrlRwYQsmY2QwIUA220tIwziopfq6A9Xqh96VIez1mM25ZwiWbAKKTIjYeIGiBM+HYpiRNbEpIxFRgZz/X4Fyey1NRHrG3Za54yhaq0uzkT3+up8B58dtZr/cnmFQz9vZlr3fxZWZtaY729nhZDlQJ0oiZzPnEDBJV7KXYsUynT5CCoAFnJViBG5EvGE9TNhfpDKwhjCVLVLlgiVI6FdKRvuQzYLIqJqBNzLhMWaE0MCEZZxp4uuhb1a8MsH9/8/p73I6C2wE7ySsT18ulQkNi84WbHikQsPrCUebpAe6PkLOYFfwKN1JY9nMlkitE24Aksvo9IVr1em+qslTaQsp+dCgc9XrY8jXkas64BuqfqKJQkpVc8wIscRtuGDZr+LkSGlLHKjzPAy2OzmUf93lRwlGvx17KVCRIDJoQvzI19X0HrisSCbu+8RvrurZIhzvvmBhpMuduP8ucJw5MDcgTVlxDd+KbmC1w4j+BVAGCTGnxi5KW57Qd16CtSHje3jYEkBjNck1yUSohbfjqV2D/5bcHd482xfMVgpYisQohqcUAu+Z5BcZDNY9ZhlD9AKUGQ/zt50VCypRlIGbZ1vV4+q4ytjMxqwyC2YbCrxV2icgLRLYpzw0wMe3QsuBX0FqNKTqEeD5gXy9YClNe5TZmAjnO6goG7HtlGS/LXCR02uBBgsLD8Yzo0y57dvCASF7QHp9odS1SwCMhFdMpaBRObKQp/JgAHfJZSQMQPZIcm3HJlFzZ6ETlSq+zEH3u0pElSlqQdsCOr7nICXiHrGFCJnmVApvkPLmK6ZyMmYbUCe4C8NSNHb9TFzxMHc2JPsxAjlyoJMIvlV9emObEGrDTTJhGnrAxkJoWEaZNVS+1U4UrIwmCiDEouMhjIlzM3qkJs8LmEKPAllwuYpZyCzGzcGMn6iZmSQbJFf2leSoUm1TW4kGNa6ZalamaS0/LqZLWiF82SGRoeX+KjmN2ELOnMXses9EwZqNxzEYHMRs9jdnoeczGw5iNxzEbH8Rs/NSBNX7uac1rArcBGI0dle3nQ108d18JQ5KNB6apz+B55wweDVivV0sTfvvpp5/O5e25ZOw8QuE6j47YeVR3OY9i14ZnJraN/O8b/LE/fuZ/LvDn0/Fz/3NOXUcH/meGP8ejc7n0C57LMUFieVHeAQU2PyoE/pdnIvxGi+K3cJ7hRzyI4tCAe9WBBxuWbVz2ERchhRU8N9vRCT0+IYwakNaQOkCkiF23Y0TNnxA6bXiwhY5J10THaqspCDxBMV7D/nDgb5btyLtlPxncW+B8HOpPEXU8mk7xaNqOf316fUJEWIXp4yjxbEAKAJ3M2+ngO3xCVOhC9HE0eI40wEtpOwGw9RPCvgUONvgb3rUND/qjw/54OD7oUABtI9ehKPpp2l8sFo9BPdR5/PKo8gQN1Wl2aIZOtSo2mB9kHTS9vE5EfweV/T9QUZ8EHRZStPu6Fmyw+NpatlUpX3xh3FRhaK2cYf9GNVu0wKQmhIOs3yRTIvHAY5+gkk3QwBsgDfpEyb003WtREj+mab8o+isf8WefCN/6WBSDNB2s9FzbHfexYGkas/XPG7+nKSuKYstn973zea8o1rEYFIWHjZSvrwbkfiCdbbuc+A6/l6g0EtFd+E4xQs+BkjmtTebcZjlauWwyIX2DZyq20kHDrMq5hhu0S41Q0vV+fBkLItZo9mTHkglIXgJHCvbla6+9P/Hsjyh0J8Av949bwwwnOfYOM6ZhBjes5NaCljTZNc9F6vxtffoAN7wo0QTY++v5efov/7xHDgi08S3DnWCpmAn0A+399ey4/98XG3pUZQk64QZYDriSiRnYZMDOMsjLxhU1n88H832TZErlzg/1zmiYun8v1eTdJYFbDrgpn2zC1LFGy+BH1lm19w3YDsW4YWHkBpOfeIxkaDSk29bbO3dct77HJ3TjrICEjc57gs1n51HBSSFBVobmb2Uz0OfRRT3GGfmQ3jP24gHCmokUcj6BfL3pwYJWf875QlVevoNTq4uq5+gW3bChELL2WxA6w7jVyG9WGl3bcoN8O4K0pTNcOUE8ww6wXJjguemSsz3au7bI4SjBuYYnwMIANqm59KOloAbsYWLgTiK/d/csgf0YdazdimG1e1bobEybMDhHIaQoqqL2j07rWQPJCq97tOmFI/HRIKzQ3t21FfjNPSt4t/2WBc7liPwYwf9xh2bqe3xCZ8UKSHeL8YecIp17+pEu2PsFMKDVFsAN1zJ2dRdyLXxmu/QN2Gu83tAn6wahly1JoLTokftY0axBfvANRT6rth9uO+e1e31C3LcBrN+YA32/x759PohJ29h/RozaAfvBzOqckgWf3WG5U/MnxJ4enjUnRK93omEq8rz1pMjCp/Cyg086kEPhn738YyJedeQIF9IqNAvCs+0EpvReaukZJePNg6O7Z9yWtt9E3Su00izjxunfpPDjVuGDrc2gWHHFB9Aad7yQAW7cldHj2Y3jr4btfRo9Pezs0+Gws0/Dbft0h9mIO2hKJU3ta4OmqSXXtMXh+/rVsiq2YVLc0hcS31aC9eCEQVV5ynJxRa8qqTBlzhe4q0FKPZSrz3XfZEqZpod/MfvSI3zUfYlTGh/jngzqh4mHOLxWNqO1F6Nn+62tOHz+vCsxHYF5iP3erLe+C8ODvdHhnvNobXZoNW6Y7YfwHZoAYw/ZL/ITPWi/qGezYTu304e6nR6H3fcf0+oePRt3Lov94YdeFo9uXLel5h6z+jGM50ezYtvi9kD79XezIz+e+w5+C4169Gy/zYXPRo/gQt2iOH8sJ67px4/Ge+yxlONNDPgA7fhOlfijGbQN7G/OpIePo0mPhh0N7auOgvbVuM2Uh4cPYsr2oiucdR6J//z69Q/z4V++nanj4+Pj79+8zV68nR0fHxf4ezAYbDSiNu02LYOaq48I9Pcy3fFbVhkMBkjClFt+RMP3Sjn7Vzc+3j5m4F+ffyPPzuFjPKZscOB8/ClQd/3jvDW/nZx/nAQy/9+5jOJIlRRQrOTLNDqKXHByCNWNYjIxwdivVbqIjm4jHz6Gf/rgLBy6985gEPRtZJIMCo5/BdMUw6anIsepMAIKtIniiOIJMIYauS86itTkHSQ2ivGtq0SHBBicg8Yd3YZeLmw2ir0yHh1FjvujOPIvPvUnBjJR+IZbptNoGRa8a6r6SzOVoT/quGWcByNTP3AaGrpcCRv/oJnaMywbsjaTca35IlqNUA8hqeE90Y2rY+7yRbgkhEWXSB0nSd2iOBIWivYqWzZNq/endAIKMaFYo/cdS9vCi/deE8eVmZIfNNB7ITbQ/IFUcq3rC3e37BiDHSEN2mm/idqNGUXODe7jmNCfsOWz9prurWBtzdNt0dytIFKTkUnKyxK4HlBQ9QfH61NKBM+TirIS6uOxg1kNao3ZaBlHN/cjc8MS1Q+h4uzLHKbWPe2yRGkJ+kk7XuSTQW58cLCMo8X96C0+S/Se4ebN78fuR4qxb/IP/ghY958v4yi7H9bv6iyAPxDYg6fL5q5bucovJypdXIZza3lfx3CpYD/MSXkpX+sUdIsQE6Vy4HKNEi+nzsuu2BdoeXwRu4AKCt4W2oQLhc3R0awhAUwEoTircFYxr3O4yG7mA2rROf8CP5C6ZKqJwV4yzGfchBNgVovZDND37HvQYB+eDpySq6QP8+DT4G0rNVwLVZkAHjqkMegvB/Qx2wyEy5kQcta1jlrUIbd3G/dBe3fwC15yEuPZX5+ePICWZLr1mc3q2HiHpZuDvT49wZQYMfVq2IC9NTUlAml5pwtDtYhdCx7C5uuzfeEeocH5HxUh2/HVD3wySp+tA5QKsxGi2GW/Ybx+nf+2NnGTM4VbpCqLvn/hMwGMhdJ06EhQ1IQ8VdVDuPIeSnI2qyjmz6LIhvwYCvtpUlqEdIl1pPenlQ5ZPJ4tsCdm2TV0ClTBTq35YwbSuOGcTbmxoGNMuUPK6wq1/HpKuClBC5AJbCSBBke6y0pv1Ju6NOjmh7z94ZXPlAs4BKGcoAS6iSFlVUlcQ5JQ5y2FnVtFfU1RQukAfblNQVtXPSi7yLskStBGSTRblJ5xKX5xLEwaCVo9E8h47rr6owJd1wgPSngXmHDW/vr3f7Tg2qpxrgPmVuBpikFp90BIpp1jeNS4NZR4AqouRDgf6H9bvQQQOhKay0KltSCZh/P4CYWxmfpc9G9p9TueqZIMFfz6vDVxOGONVysN2YpkUNJjXIn4wo0wtpV5E+Jj18+HHwDpmLRgIDUEpRp5Xi7aAt68L6qV6Sg/SHSztuprcE0WeGXVpYZCyIfdU23vmFX1QVBZVXArEhamMoNuLp57gglyXbAvA2jIjddC6SdbRBWnu1QygUshL+Ea9AMUvO/reJ6UL5C57RxAtmELRHLXWZMvNccU1w5NWrcTZQW2oTxE88A9om6yXe42JAM/uKuEcm6LCT7mu+dgFDU6OFRjS3aNoc/FmvLvojtb6jMyNkbD4f9nW2p/+PnYUgfDz8iWeo7Aejfq/QfQNv1m49kR3MJ3D3inyGlDDt27e6KXdRnXTuxNBG7EYbx0/zXmXzj37zEJnc3YuHW9OROQITKMh0P838oh2Kk4gcptXY0iX/xTFD/cp3z3HrjP6MW+i1hfZ+PvTCmLJEOaFWBM9yTfMOQeBNp0EzIXEi4DUS7Hw+HlYeTofbCJOG9UATYjrQr16blWWBiizAFTD6xeMD7jQjJcXj8irUDr+7jq/SC7iwgHw+HlqCbC4ToRXkoKeKciJKfqCuTvi2l7eeuWR1BvirwR7Ui4TtQedZBtf3dIGkgqLewiOjq7jW76vBR91350drG8QK6zmcLXllIZgpjbLDqK9tYeX6gKDLr2z24jMvGicOQZLlOMJlg79ngp9q5Hg1G0jFfHbDwm7+gPVf99hxjLZ0LO7ht30dDoDe6j26oOpRpVsBR/AdQF/Ua0e8WRQP7JgKPOj6RH9vihebJ6ETY5PCZteh9qNnP1xSc8+HTecFavqw2vMq1HmbPwIkKPHPUbR9QgFNXvEPhnrQufNSxbO/GD3jkihW18cECazbMRqQD7z+l2PXi6vHAEbnntKDi07XpycRAdH4r/1PUpRNGKDd8xpFft6K027RaT1i+5YrrVgGyymA47hsoGaoWLtksrjBRAWu0PiVYHQ6LV82HnjvcYNjM0NzVdx/VtTFdu+8bFa/UC+U/IqSLm9Rz1ugT5Bh1eeLgQ869pZpAnqqgLXPR6Ycivf/9HParXq+1i5+nDIIrXlWalmoPGuk5YvWKaw41A4w+HQUFthp70KPSZFzkYg+980sLMFW3CRDj0snk/TsJLPhG5wNPThfdSnGDrADYD9mMG+PSOTV9olxd4DTkeurX53CpPxeZKX02xBFbMOJtg8Rt0oIDMuEycr8adBORzQOMR/WClFgZr+miEWjjYlLSaJ5YVXPIZOQ1i1iZWCrnA45JpNUFXplF55Zx1lotcaRfVRQjRszsR8cVNiU2kXqKXS0OGvHvtPXYmdh5TJ+S+KtQEndMlwiISIMdFJXOFBZzQyV3lOSuVdY5n1GLbMOJwq7k0qHo6WMIe1ATzzjQwPvT5rQHc4VdCXrmiI312VvPVjzAxwkI3JXFV/p50x3wr7HfVBEsaKSOs0otm9EzYrJrQcd2epP7hZvo2FP1qHcbNHKlKzAZ9XCVmD7Mn996ARQ4xe8cnL+m6f8J+/dv/sFfAtWSZmjtuTSoN+aKpL0bluGjnHdnq25rctbzCml6WmFTOwgtCoOCPGbe//u1/Dfse5ui2ciLlQilOqkkukrp2m+n1jlz9tlZVtm4KlQtsRx86Z6UbnQt5NWDHckFeP/fUgMyA32lcBw3ygG+pl1ZXSWsgIj+TgfwayJ2IVXQmwCAV7mVCq2rmVmsD45HrxvgjbsdpysqVOH/0aTXgOLcNPQlw57/BKmcbUgM6Mfjd6jwgU6rDZY5YqvnUNvPHK8H/9Eqw9inkDQRyxH6aVqE8pKTHuP46oJCWFUWie95qmILGBU2nfB0vhWens8CWrJvr+/5s7ew3aXlCamy4JHkpNnp9sQqZeT19A/paJOC1qi0SvUed96I4ykUC3pj099fxtyev2PX+YBjFLfXsAcK99+rlNy++f/MCgcGD1BFsNBgOhuTzUsYWXLZW8nJy2uhLK9EttRK/q4+4q4+4q4+4q4+4q4+4q4+4q4+4q4+4q4+4q4+4htSuPuKuPuKuPuKuPuKuPuKuPuIuUX1XH3FXH3FXH3FXH3FXH3FXH3FXH3FXH3FXH3FXH3FXH3FXH3FXH/FR3ZG7+oi7+oi7+oi7+og7t9OuPuKuPuKuPuKuPuKuPuKuPuKuPuKuPuKuPiIGk7fSivbKnAvK/vP1Vlzi3tlq1cSLOMows+/oLLq9RQ58q/PlEj//XFES09lFHF1zLTByi5IC45DDholMV7DA2GoXiNY/xfVjt+EUPL6SC4lJeG7EMdHgzr7t5MOT129Oozia+MqOhUopmZjPMfGJz13uVys7ir7dRjmXs4oyqyI359IV38i6OXtXlLPn/2ilZ3G5aEHYTeZzaOC/iNTGAbe3Lh9wuaz7u6atIzxhQ2/cv4vlcvl/lt8sUA==","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 s=t(74848),r=t(28453),o=t(33617),l=t.n(o),a=t(17543),d=t.n(a),c=t(86013),p=t.n(c),h=t(63723),u=t.n(h),m=(t(18766),t(79329),t(9303));const x={id:"createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",sidebar_label:"Create Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztPNtyG7eSv4Kd2qrE3CFFUpLtaF9WyfFJvMcbq2J5U7uSjgLONDmwZoAJgBHFqFh1Hs4f7NO+nk/Ll2x1A5gLL5JsK4m9xTw44uDW3egGuhvdfRtZPjPR0Vl0CkWZcwsmuoijFEyiRWmFktFRdJoBC83sGw0cv7Pjk5eM57maG1YZ0IZZxRJsBJZUxqpC/MInOTAbJo7ZPBNJxgzoa2DcsEleQamFtIZNlWYzkKC5FXLGUpVUBWDDXNiMlRpSmAoJKTNWV4mtNJgBe1sqyUyVJGDMtMrrlRwYQsmY2QwIUA220tIwziopfq6A9Xqh96VIez1mM25ZwiWbAKKTIjYeIGiBM+HYpiRNbEpIxFRgZz/X4Fyey1NRHrG3Za54yhaq0uzkT3+up8B58dtZr/cnmFQz9vZlr3fxZWZtaY729nhZDlQJ0oiZzPnEDBJV7KXYsUynT5CCoAFnJViBG5EvGE9TNhfpDKwhjCVLVLlgiVI6FdKRvuQzYLIqJqBNzLhMWaE0MCEZZxp4uuhb1a8MsH9/8/p73I6C2wE7ySsT18ulQkNi84WbHikQsPrCUebpAe6PkLOYFfwKN1JY9nMlkitE24Aksvo9IVr1em+qslTaQsp+dCgc9XrY8jXkas64BuqfqKJQkpVc8wIscRtuGDZr+LkSGlLHKjzPAy2OzmUf93lRwlGvx17KVCRIDJoQvzI19X0HrisSCbu+8RvrurZIhzvvmBhpMuduP8ucJw5MDcgTVlxDd+KbmC1w4j+BVAGCTGnxi5KW57Qd16CtSHje3jYEkBjNck1yUSohbfjqV2D/5bcHd482xfMVgpYisQohqcUAu+Z5BcZDNY9ZhlD9AKUGQ/zt50VCypRlIGbZ1vV4+q4ytjMxqwyC2YbCrxV2icgLRLYpzw0wMe3QsuBX0FqNKTqEeD5gXy9YClNe5TZmAjnO6goG7HtlGS/LXCR02uBBgsLD8Yzo0y57dvCASF7QHp9odS1SwCMhFdMpaBRObKQp/JgAHfJZSQMQPZIcm3HJlFzZ6ETlSq+zEH3u0pElSlqQdsCOr7nICXiHrGFCJnmVApvkPLmK6ZyMmYbUCe4C8NSNHb9TFzxMHc2JPsxAjlyoJMIvlV9emObEGrDTTJhGnrAxkJoWEaZNVS+1U4UrIwmCiDEouMhjIlzM3qkJs8LmEKPAllwuYpZyCzGzcGMn6iZmSQbJFf2leSoUm1TW4kGNa6ZalamaS0/LqZLWiF82SGRoeX+KjmN2ELOnMXses9EwZqNxzEYHMRs9jdnoeczGw5iNxzEbH8Rs/NSBNX7uac1rArcBGI0dle3nQ108d18JQ5KNB6apz+B55wweDVivV0sTfvvpp5/O5e25ZOw8QuE6j47YeVR3OY9i14ZnJraN/O8b/LE/fuZ/LvDn0/Fz/3NOXUcH/meGP8ejc7n0C57LMUFieVHeAQU2PyoE/pdnIvxGi+K3cJ7hRzyI4tCAe9WBBxuWbVz2ERchhRU8N9vRCT0+IYwakNaQOkCkiF23Y0TNnxA6bXiwhY5J10THaqspCDxBMV7D/nDgb5btyLtlPxncW+B8HOpPEXU8mk7xaNqOf316fUJEWIXp4yjxbEAKAJ3M2+ngO3xCVOhC9HE0eI40wEtpOwGw9RPCvgUONvgb3rUND/qjw/54OD7oUABtI9ehKPpp2l8sFo9BPdR5/PKo8gQN1Wl2aIZOtSo2mB9kHTS9vE5EfweV/T9QUZ8EHRZStPu6Fmyw+NpatlUpX3xh3FRhaK2cYf9GNVu0wKQmhIOs3yRTIvHAY5+gkk3QwBsgDfpEyb003WtREj+mab8o+isf8WefCN/6WBSDNB2s9FzbHfexYGkas/XPG7+nKSuKYstn973zea8o1rEYFIWHjZSvrwbkfiCdbbuc+A6/l6g0EtFd+E4xQs+BkjmtTebcZjlauWwyIX2DZyq20kHDrMq5hhu0S41Q0vV+fBkLItZo9mTHkglIXgJHCvbla6+9P/Hsjyh0J8Av949bwwwnOfYOM6ZhBjes5NaCljTZNc9F6vxtffoAN7wo0QTY++v5efov/7xHDgi08S3DnWCpmAn0A+399ey4/98XG3pUZQk64QZYDriSiRnYZMDOMsjLxhU1n88H832TZErlzg/1zmiYun8v1eTdJYFbDrgpn2zC1LFGy+BH1lm19w3YDsW4YWHkBpOfeIxkaDSk29bbO3dct77HJ3TjrICEjc57gs1n51HBSSFBVobmb2Uz0OfRRT3GGfmQ3jP24gHCmokUcj6BfL3pwYJWf875QlVevoNTq4uq5+gW3bChELL2WxA6w7jVyG9WGl3bcoN8O4K0pTNcOUE8ww6wXJjguemSsz3au7bI4SjBuYYnwMIANqm59KOloAbsYWLgTiK/d/csgf0YdazdimG1e1bobEybMDhHIaQoqqL2j07rWQPJCq97tOmFI/HRIKzQ3t21FfjNPSt4t/2WBc7liPwYwf9xh2bqe3xCZ8UKSHeL8YecIp17+pEu2PsFMKDVFsAN1zJ2dRdyLXxmu/QN2Gu83tAn6wahly1JoLTokftY0axBfvANRT6rth9uO+e1e31C3LcBrN+YA32/x759PohJ29h/RozaAfvBzOqckgWf3WG5U/MnxJ4enjUnRK93omEq8rz1pMjCp/Cyg086kEPhn738YyJedeQIF9IqNAvCs+0EpvReaukZJePNg6O7Z9yWtt9E3Su00izjxunfpPDjVuGDrc2gWHHFB9Aad7yQAW7cldHj2Y3jr4btfRo9Pezs0+Gws0/Dbft0h9mIO2hKJU3ta4OmqSXXtMXh+/rVsiq2YVLc0hcS31aC9eCEQVV5ynJxRa8qqTBlzhe4q0FKPZSrz3XfZEqZpod/MfvSI3zUfYlTGh/jngzqh4mHOLxWNqO1F6Nn+62tOHz+vCsxHYF5iP3erLe+C8ODvdHhnvNobXZoNW6Y7YfwHZoAYw/ZL/ITPWi/qGezYTu304e6nR6H3fcf0+oePRt3Lov94YdeFo9uXLel5h6z+jGM50ezYtvi9kD79XezIz+e+w5+C4169Gy/zYXPRo/gQt2iOH8sJ67px4/Ge+yxlONNDPgA7fhOlfijGbQN7G/OpIePo0mPhh0N7auOgvbVuM2Uh4cPYsr2oiucdR6J//z69Q/z4V++nanj4+Pj79+8zV68nR0fHxf4ezAYbDSiNu02LYOaq48I9Pcy3fFbVhkMBkjClFt+RMP3Sjn7Vzc+3j5m4F+ffyPPzuFjPKZscOB8/ClQd/3jvDW/nZx/nAQy/9+5jOJIlRRQrOTLNDqKXHByCNWNYjIxwdivVbqIjm4jHz6Gf/rgLBy6985gEPRtZJIMCo5/BdMUw6anIsepMAIKtIniiOIJMIYauS86itTkHSQ2ivGtq0SHBBicg8Yd3YZeLmw2ir0yHh1FjvujOPIvPvUnBjJR+IZbptNoGRa8a6r6SzOVoT/quGWcByNTP3AaGrpcCRv/oJnaMywbsjaTca35IlqNUA8hqeE90Y2rY+7yRbgkhEWXSB0nSd2iOBIWivYqWzZNq/endAIKMaFYo/cdS9vCi/deE8eVmZIfNNB7ITbQ/IFUcq3rC3e37BiDHSEN2mm/idqNGUXODe7jmNCfsOWz9prurWBtzdNt0dytIFKTkUnKyxK4HlBQ9QfH61NKBM+TirIS6uOxg1kNao3ZaBlHN/cjc8MS1Q+h4uzLHKbWPe2yRGkJ+kk7XuSTQW58cLCMo8X96C0+S/Se4ebN78fuR4qxb/IP/ghY958v4yi7H9bv6iyAPxDYg6fL5q5bucovJypdXIZza3lfx3CpYD/MSXkpX+sUdIsQE6Vy4HKNEi+nzsuu2BdoeXwRu4AKCt4W2oQLhc3R0awhAUwEoTircFYxr3O4yG7mA2rROf8CP5C6ZKqJwV4yzGfchBNgVovZDND37HvQYB+eDpySq6QP8+DT4G0rNVwLVZkAHjqkMegvB/Qx2wyEy5kQcta1jlrUIbd3G/dBe3fwC15yEuPZX5+ePICWZLr1mc3q2HiHpZuDvT49wZQYMfVq2IC9NTUlAml5pwtDtYhdCx7C5uuzfeEeocH5HxUh2/HVD3wySp+tA5QKsxGi2GW/Ybx+nf+2NnGTM4VbpCqLvn/hMwGMhdJ06EhQ1IQ8VdVDuPIeSnI2qyjmz6LIhvwYCvtpUlqEdIl1pPenlQ5ZPJ4tsCdm2TV0ClTBTq35YwbSuOGcTbmxoGNMuUPK6wq1/HpKuClBC5AJbCSBBke6y0pv1Ju6NOjmh7z94ZXPlAs4BKGcoAS6iSFlVUlcQ5JQ5y2FnVtFfU1RQukAfblNQVtXPSi7yLskStBGSTRblJ5xKX5xLEwaCVo9E8h47rr6owJd1wgPSngXmHDW/vr3f7Tg2qpxrgPmVuBpikFp90BIpp1jeNS4NZR4AqouRDgf6H9bvQQQOhKay0KltSCZh/P4CYWxmfpc9G9p9TueqZIMFfz6vDVxOGONVysN2YpkUNJjXIn4wo0wtpV5E+Jj18+HHwDpmLRgIDUEpRp5Xi7aAt68L6qV6Sg/SHSztuprcE0WeGXVpYZCyIfdU23vmFX1QVBZVXArEhamMoNuLp57gglyXbAvA2jIjddC6SdbRBWnu1QygUshL+Ea9AMUvO/reJ6UL5C57RxAtmELRHLXWZMvNccU1w5NWrcTZQW2oTxE88A9om6yXe42JAM/uKuEcm6LCT7mu+dgFDU6OFRjS3aNoc/FmvLvojtb6jMyNkbD4f9nW2p/+PnYUgfDz8iWeo7Aejfq/QfQNv1m49kR3MJ3D3inyGlDDt27e6KXdRnXTuxNBG7EYbx0/zXmXzj37zEJnc3YuHW9OROQITKMh0P838oh2Kk4gcptXY0iX/xTFD/cp3z3HrjP6MW+i1hfZ+PvTCmLJEOaFWBM9yTfMOQeBNp0EzIXEi4DUS7Hw+HlYeTofbCJOG9UATYjrQr16blWWBiizAFTD6xeMD7jQjJcXj8irUDr+7jq/SC7iwgHw+HlqCbC4ToRXkoKeKciJKfqCuTvi2l7eeuWR1BvirwR7Ui4TtQedZBtf3dIGkgqLewiOjq7jW76vBR91350drG8QK6zmcLXllIZgpjbLDqK9tYeX6gKDLr2z24jMvGicOQZLlOMJlg79ngp9q5Hg1G0jFfHbDwm7+gPVf99hxjLZ0LO7ht30dDoDe6j26oOpRpVsBR/AdQF/Ua0e8WRQP7JgKPOj6RH9vihebJ6ETY5PCZteh9qNnP1xSc8+HTecFavqw2vMq1HmbPwIkKPHPUbR9QgFNXvEPhnrQufNSxbO/GD3jkihW18cECazbMRqQD7z+l2PXi6vHAEbnntKDi07XpycRAdH4r/1PUpRNGKDd8xpFft6K027RaT1i+5YrrVgGyymA47hsoGaoWLtksrjBRAWu0PiVYHQ6LV82HnjvcYNjM0NzVdx/VtTFdu+8bFa/UC+U/IqSLm9Rz1ugT5Bh1eeLgQ869pZpAnqqgLXPR6Ycivf/9HParXq+1i5+nDIIrXlWalmoPGuk5YvWKaw41A4w+HQUFthp70KPSZFzkYg+980sLMFW3CRDj0snk/TsJLPhG5wNPThfdSnGDrADYD9mMG+PSOTV9olxd4DTkeurX53CpPxeZKX02xBFbMOJtg8Rt0oIDMuEycr8adBORzQOMR/WClFgZr+miEWjjYlLSaJ5YVXPIZOQ1i1iZWCrnA45JpNUFXplF55Zx1lotcaRfVRQjRszsR8cVNiU2kXqKXS0OGvHvtPXYmdh5TJ+S+KtQEndMlwiISIMdFJXOFBZzQyV3lOSuVdY5n1GLbMOJwq7k0qHo6WMIe1ATzzjQwPvT5rQHc4VdCXrmiI312VvPVjzAxwkI3JXFV/p50x3wr7HfVBEsaKSOs0otm9EzYrJrQcd2epP7hZvo2FP1qHcbNHKlKzAZ9XCVmD7Mn996ARQ4xe8cnL+m6f8J+/dv/sFfAtWSZmjtuTSoN+aKpL0bluGjnHdnq25rctbzCml6WmFTOwgtCoOCPGbe//u1/Dfse5ui2ciLlQilOqkkukrp2m+n1jlz9tlZVtm4KlQtsRx86Z6UbnQt5NWDHckFeP/fUgMyA32lcBw3ygG+pl1ZXSWsgIj+TgfwayJ2IVXQmwCAV7mVCq2rmVmsD45HrxvgjbsdpysqVOH/0aTXgOLcNPQlw57/BKmcbUgM6Mfjd6jwgU6rDZY5YqvnUNvPHK8H/9Eqw9inkDQRyxH6aVqE8pKTHuP46oJCWFUWie95qmILGBU2nfB0vhWens8CWrJvr+/5s7ew3aXlCamy4JHkpNnp9sQqZeT19A/paJOC1qi0SvUed96I4ykUC3pj099fxtyev2PX+YBjFLfXsAcK99+rlNy++f/MCgcGD1BFsNBgOhuTzUsYWXLZW8nJy2uhLK9EttRK/q4+4q4+4q4+4q4+4q4+4q4+4q4+4q4+4q4+4q4+4htSuPuKuPuKuPuKuPuKuPuKuPuIuUX1XH3FXH3FXH3FXH3FXH3FXH3FXH3FXH3FXH3FXH3FXH3FXH3FXH/FR3ZG7+oi7+oi7+oi7+og7t9OuPuKuPuKuPuKuPuKuPuKuPuKuPuKuPuKuPiIGk7fSivbKnAvK/vP1Vlzi3tlq1cSLOMows+/oLLq9RQ58q/PlEj//XFES09lFHF1zLTByi5IC45DDholMV7DA2GoXiNY/xfVjt+EUPL6SC4lJeG7EMdHgzr7t5MOT129Oozia+MqOhUopmZjPMfGJz13uVys7ir7dRjmXs4oyqyI359IV38i6OXtXlLPn/2ilZ3G5aEHYTeZzaOC/iNTGAbe3Lh9wuaz7u6atIzxhQ2/cv4vlcvl/lt8sUA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},j=void 0,g={},y=[];function f(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.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:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document before it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date"\n "page": 1\n "x": 173\n "y": 588\n "w": 114\n "h": 21\n "options": {\n "name": "date"\n "response": "04/15/2024"\n "format": "mm/dd/yyyy"\n "color": "black"\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 528,\n "w": 114,\n "h": 21,\n "options": {\n "name": "dropdown",\n "values": ["male", "female", "other"],\n "response": "female",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"sample note"},description:{type:"string",format:"string",example:"sample description"},signers:{type:"array",description:"You can provide signer optionally if you it as default signer",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:""},name:{type:"string",format:"string",example:""},phone:{type:"string",format:"string",example:""},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"createtemplate_body_signers"}},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5},prefill:{type:"object",description:"You can provide widgets which can embed before sending to signer",properties:{widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"textbox"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:100},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},title:"createtemplate_body"}}},required:!0}}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Template created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bh2Hspnmch"},message:{type:"string",example:"Template created successfully!"}},title:"inline_response_200_5"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/9c9cb35e.683dbb00.js b/assets/js/9c9cb35e.683dbb00.js deleted file mode 100644 index 0c7d5dd7e..000000000 --- a/assets/js/9c9cb35e.683dbb00.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4240],{19068:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>j,contentTitle:()=>g,default:()=>f,frontMatter:()=>x,metadata:()=>s,toc:()=>b});const s=JSON.parse('{"id":"API-docs/v1.1/createtemplate","title":"Create Template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.","source":"@site/docs/API-docs/v1.1/createtemplate.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/createtemplate","permalink":"/docs/API-docs/v1.1/createtemplate","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createtemplate","title":"Create Template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.","sidebar_label":"Create Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztPNtyHLeOv8LTtVWJta3RzEiyHe3LKjnexHu8sSqWN7Ur6Sicbsw0rW6yQ7I1mqim6jycP9infT2fli/ZAkj2ZS6SbCuJvdV5cDTNGwACJAACuI0sn5no6Cw6haLMuQUTXcRRCibRorRCyegoOs2AhWb2jQaO39nxyUvG81zNDasMaMOsYgk2AksqY1UhfuGTHJgNE8dsnokkYwb0NTBu2CSvoNRCWsOmSrMZSNDcCjljqUqqArBhLmzGSg0pTIWElBmrq8RWGsyAvS2VZKZKEjBmWuX1Sg4MoWTMbAYEqAZbaWkYZ5UUP1fAdnZC70uR7uwwm3HLEi7ZBBCdFLHxAEELnAnHNiVpYlNCIqYCO/u5BufyXJ6K8oi9LXPFU7ZQlWYnf/63egqcF7+d7ez8GSbVjL19ubNz8WVmbWmO9vZ4WQ5UCdKImcz5xAwSVeyl2LFMp0+QgqABZyVYgRuRLxhPUzYX6QysIYwlS1S5YIlSOhXSkb7kM2CyKiagTcy4TFmhNDAhGWcaeLrYtWq3MsD+/c3r73E7Cm4H7CSvTFwvlwoNic0XbnqkQMDqC0eZpwe4P0LOYlbwK9xIYdnPlUiuEG0Dksjq94RotbPzpipLpS2k7EeHwtHODrZ8DbmaM66B+ieqKJRkJde8AEvchhuGzRp+roSG1LEKz/NAi6NzuYv7vCjhaGeHvZSpSJAYNCF+ZWrq+w5cVyQSdn3jN9Z1bZEOd94xMdJkzt1+ljlPHJgakCesuIbuxDcxW+DEfwapAgSZ0uIXJS3PaTuuQVuR8Ly9bQggMZrlmuSiVELa8NWvwP7Lbw/uHm2K5ysELUViFUJSiwF2zfMKjIdqHrMMofoBSg2G+NvPi4SUKctAzLKt6/H0XWVsZ2JWGQSzDYVfK+wSkReIbFOeG2Bi2qFlwa+gtRpTdAjxfMC+XrAUprzKbcwEcpzVFQzY98oyXpa5SOi0wYMEhYfjGbFLu+zZwQMieUF7fKLVtUgBj4RUTKegUTixkabwYwJ0yGclDUD0SHJsxiVTcmWjE5Urvc5C9LlLR5YoaUHaATu+5iIn4B2yhgmZ5FUKbJLz5CqmczJmGlInuAvAUzd2/E5d8DB1NCf6MAM5cqGSCL9UfnlhmhNrwE4zYRp5wsZAalpEmDZVvdROFa6MJAgixqDgIo+JcDF7pybMCptDjAJbcrmIWcotxMzCjZ2om5glGSRX9JfmqVBsUlmLBzWumWpVpmouPS2nSlojftkgkaHl/Sk6jtlBzJ7G7HnMRsOYjcYxGx3EbPQ0ZqPnMRsPYzYex2x8ELPxUwfW+LmnNa8J3AZgNHZUtp8PdfHcfSUMSTYemKY+g+edM3g0YDs7tTTht59++ulc3p5Lxs4jFK7z6IidR3WX8yh2bXhmYtvI/77BH/vjZ/7nAn8+HT/3P+fUdXTgf2b4czw6l0u/4LkcEySWF+UdUGDzo0Lgf3kmwm+0KH4L5xl+xIMoDg24Vx14sGHZxmUfcRFSWMFzsx2d0OMTwqgBaQ2pA0SK2HU7RtT8CaHThgdb6Jh0TXSstpqCwBMU4zXsDwf+ZtmOvFv2k8G9Bc7Hof4UUcej6RSPpu3416fXJ0SEVZg+jhLPBqQA0Mm8nQ6+wydEhS5EH0eD50gDvJS2EwBbPyHsW+Bgg7/hXdvwYHd0uDsejg86FEDbyHUoit003V0sFo9BPdR5/PKo8gQN1Wl2aIZOtSo2mB9kHTS9vE5EfweV/T9QUZ8EHRZStPu6Fmyw+NpatlUpX3xh3FRhaK2cYf9GNVu0wKQmhIOs3yRTIvHAY5+gkk3QwBsgDXaJkntputeiJH5M092i2F35iD93ifCtj0UxSNPBSs+13XEfC5amMVv/vPF7mrKiKLZ8dt87n/eKYh2LQVF42Ej5+mpA7gfS2bbLie/we4lKIxHdhe8UI/QcKJnT2mTObZajlcsmE9I3eKZiKx00zKqca7hBu9QIJV3vx5exIGKNZk92LJmA5CVwpGBfvvba+xPP/ohCdwL8cv+4NcxwkmPvMGMaZnDDSm4taEmTXfNcpM7ftksf4IYXJZoAe389P0//+Z/2yAGBNr5luBMsFTOBfqC9v54d7/73xYYeVVmCTrgBlgOuZGIGNhmwswzysnFFzefzwXzfJJlSufNDvTMapu7fSzV5d0nglgNuyiebMHWs0TL4kXVW7X0DtkMxblgYucHkJx4jGRoN6bb19s4d163v8QndOCsgYaPznmDz2XlUcFJIkJWh+VvZDPR5dFGPcUY+pPeMvXiAsGYihZxPIF9verCg1Z9zvlCVl+/g1Oqi6jm6RTdsKISs/RaEzjBuNfKblUbXttwg344gbekMV04Qz7ADLBcmeG665GyP9q4tcjhKcK7hCbAwgE1qLv1oKagBe5gYuJPI7909S2A/Rh1rt2JY7Z4VOhvTJgzOUQgpiqqo/aPTetZAssLrHm164Uh8NAgrtHd3bQV+c88K3m2/ZYFzOSI/RvB/3KGZ+h6f0FmxAtLdYvwhp0jnnn6kC/Z+AQxotQVww7WMXd2FXAuf2S59A/Yarzf0ybpB6GVLEigteuQ+VjRrkB98Q5HPqu2H28557V6fEPdtAOs35kDf77Fvnw9i0jb2nxGjdsB+MLM6p2TBZ3dY7tT8CbGnh2fNCbGzc6JhKvK89aTIwqfwsoNPOpBD4Z+9/GMiXnXkCBfSKjQLwrPtBKb0XmrpGSXjzYOju2fclrbfRN0rtNIs48bp36Tw41bhg63NoFhxxQfQGne8kAFu3JXR49mN46+G7X0aPT3s7NPhsLNPw237dIfZiDtoSiVN7WuDpqkl17TF4fv61bIqtmFS3NIXEt9WgvXghEFVecpycUWvKqkwZc4XuKtBSj2Uq89132RKmaaHfzH70iN81H2JUxof454M6oeJhzi8VjajtRejZ/utrTh8/rwrMR2BeYj93qy3vgvDg73R4Z7zaG12aDVumO2H8B2aAGMP2S/yEz1ov6hns2G92+lD3U6Pw+77j2l1j56NO5fF/vBDL4tHN67bUnOPWf0YxvOjWbFtcXug/fq72ZEfz30Hv4VGPXq23+bCZ6NHcKFuUZw/lhPX9ONH4z32WMrxJgZ8gHZ8p0r80QzaBvY3Z9LDx9GkR8OOhvZVR0H7atxmysPDBzFle9EVzjqPxH9+/fqH+fAv387U8fHx8fdv3mYv3s6Oj48L/D0YDDYaUZt2m5ZBzdVHBPp7me74LasMBgMkYcotP6Lhe6Wc/YsbH28fM/Cvz7+RZ+fwMR5TNjhwPv4UqLv+cd6a307OP04Cmf/vXEZxpEoKKFbyZRodRS44OYTqRjGZmGDs1ypdREe3kQ8fwz99cBYO3XtnMAj6NjJJBgXHv4JpimHTU5HjVBgBBdpEcUTxBBhDjdwXHUVq8g4SG8X41lWiQwIMzkHjjm5DLxc2G8VeGY+OIsf9URz5F5/6EwOZKHzDLdNptAwL3jVV/aWZytAfddwyzoORqR84DQ1droSNf9BM7RmWDVmbybjWfBGtRqiHkNTwnujG1TF3+SJcEsKiS6SOk6RuURwJC0V7lS2bptX7UzoBhZhQrNH7jqVt4cV7r4njykzJDxrovRAbaP5AKrnW9YW7W3aMwY6QBu10t4najRlFzg3u45jQn7Dls/aa7q1gbc3TbdHcrSBSk5FJyssSuB5QUPUHx+tTSgTPk4qyEurjsYNZDWqN2WgZRzf3I3PDErUbQsXZlzlMrXvaZYnSEvSTdrzIJ4Pc+OBgGUeL+9FbfJboPcPNm9+P3Y8UY9/kH/wRsO4/X8ZRdj+s39VZAH8gsAdPl81dt3KVX05UurgM59byvo7hUsF+mJPyUr7WKegWISZK5cDlGiVeTp2XXbEv0PL4InYBFRS8LbQJFwqbo6NZQwKYCEJxVuGsYl7ncJHdzAfUonP+BX4gdclUE4O9ZJjPuAknwKwWsxmg79n3oME+PB04JVdJH+bBp8HbVmq4FqoyATx0SGPQXw7oY7YZCJczIeSsax21qENu7zbug/bu4Be85CTGs78+PXkALcl022U2q2PjHZZuDvb69ARTYsTUq2ED9tbUlAik5Z0uDNUidi14CJuvz/aFe4QG539UhGzHVz/wySi7bB2gVJiNEMUu+w3j9ev8t7WJm5wp3CJVWfT9C58JYCyUpkNHgqIm5KmqHsKV91CSs1lFMX8WRTbkx1DYT5PSIqRLrCO9P610yOLxbIE9McuuoVOgCnZqzR8zkMYN52zKjQUdY8odUl5XqOXXU8JNCVqATGAjCTQ40l1WeqPe1KVBNz/k7Q+vfKZcwCEI5QQl0E0MKatK4hqShDpvKezcKuprihJKB+jLbQrauupB2UXeJVGCNkqi2aL0jEvxi2Nh0kjQ6plAxnPX1R8V6LpGeFDCu8CEs/bXv/+jBddWjXMdMLcCT1MMSrsHQjLtHMOjxq2hxBNQdSHC+UD/6+olgNCR0FwWKq0FyTycx08ojM3U56J/S6vf8UyVZKjg1+eticMZa7xaachWJIOSHuNKxBduhLGtzJsQH7t+PvwASMekBQOpISjVyPNy0Rbw5n1RrUxH+UGim7VVX4NrssArqy41FEI+7J5qe8esqg+CyqqCW5GwMJUZdHPx3BNMkOuCfRlAQ268Fko/2SKqON2lkglcCnkJ16AfoOB9X8fzpHyBzG3nALINWyCSu86afKk5prh2aNK6nSgrsA3lIZoH7hF1k+1ytyEZ+MFdJZRzW0zwMd89B6Oo0cGhGluyawx9LtaUfxftbanPyNgYDYf/n22p/eHnY0sdDD8jW+o5AuvdqPcfQNv0m41nR3AL3z3gnSKnDTl07+6JXtZlXDuxNxG4EYfx0v3XmH/h3L/HJHQ2Y+PW9eZMQIbIMB4O8X8rh2Cn4gQqt3U1inzxpyh+uE/57j1wn9GLfRexvs7G35lSFkmGNCvAmO5JvmHIPQi06SZkLiRcBqJcjofDy8PI0ftgE3HeqAJsRloV6tNzrbAwRJkDph5YvWB8xoVkuLx+RFqB1vdx1ftBdhcRDobDy1FNhMN1IryUFPBORUhO1RXI3xfT9vLWLY+g3hR5I9qRcJ2oPeog2/7ukDSQVFrYRXR0dhvd7PJS7Lr2o7OL5QVync0UvraUyhDE3GbRUbS39vhCVWDQtX92G5GJF4Ujz3CZYjTB2rHHS7F3PRqMomW8OmbjMXlHf6h233eIsXwm5Oy+cRcNjd7gPrqt6lCqUQVL8RdAXdBvRLtXHAnknww46vxIemSPH5onqxdhk8Nj0qb3oWYzV198woNP5w1n9bra8CrTepQ5Cy8i9MhRv3FEDUJR/Q6Bf9a68FnDsrUTP+idI1LYxgcHpNk8G5EKsP+cbteDp8sLR+CW146CQ9uuJxcH0fGh+E9dn0IUrdjwHUN61Y7eatNuMWn9kiumWw3IJovpsGOobKBWuGi7tMJIAaTV/pBodTAkWj0fdu54j2EzQ3NT03Vc38Z05bZvXLxWL5D/hJwqYl7PUa9LkG/Q4YWHCzH/mmYGeaKKusBFGPDr3/9BY4I57BwLOMOfMIDidaVZqeagsaYTVq6Y5nAj0PDDQVBQm6HnPAp75kUOxuAbn7QwcwWbMAkOPWzeh5Pwkk9ELvDkdKG9FCPYOnzNgP2YAT67Y9MX2uUEXkOOB25tOrdKU7G50ldTLH8VM84mWPgGnScgMy4T56dxpwD5G9BwRB9YqYXBej4aoRYONiWt5ollBZd8Rg6DuEOqFHKBRyXTaoJuTKPyyjnqLBe50i6iixCiJ3eKQnlxU2ITqZbo4dKQId9ee2+diZ231Am4rwg1Qcd0ibCIBMhpUclcYfEmdHBXec5KZZ3TGTXYNow43GouDaqdDpawBzXBvCMNjA97fmsAd/iVkFeu4MguO6t56keYGGGhm464KntPumO+Ffa7aoLljJQRVulFM3ombFZN6KhuT1L/cDN9Gwp+tQ7iZo5UJWaDLq4Ss4eZk3tvwCKHmL3jk5d01T9hv/7tf9gr4FqyTM0dtyaVhnzR1BajUly0845s9U1NrlpeYT0vS0wqZ+H1IFDwx4zbX//2v4Z9D3N0WaEIOULu7JxUk1wkdd02s7Nz5Gq3tSqyddOnXFA7+s85K93oXMirATuWC/L4uWcGZAb8TuM6aJD3e0uttLpCWgMR+ZgM5NdArkSsoDMBBqlwrxJaVTO3WhsYj1w3vh9xO05TVq7E+KM/qwHHuWzoOYA73w1WONuQFtCJv+9W5gGZUg0uc8RSzae2mT9eCfynF4K1TyFnIJAj9tO0iuQhJT3G9dcBhbOsKBHds1bDFDQuaDql63gpPDudBbZk3Tzf92drZ7tJyxNSYcMFyUux0eOLFcjM6+kb0NciAa9RbZHoPeq8F8VRLhLwhqS/u46/PXnFrvcHwyhuqWYPEO69Vy+/efH9mxcIDB6kjmCjwXAwJH+XMrbgsrWSl5PTRldaiWypFfi+NmJfG7GvjdjXRuxrI/a1EfvaiH1txL42Yl8bcQ2pvjZiXxuxr43Y10bsayP2tRH7JPW+NmJfG7GvjdjXRuxrI/a1EfvaiH1txL42Yl8bsa+N2NdG7GsjPqo7sq+N2NdG7Gsj9rURe7dTXxuxr43Y10bsayP2tRH72oh9bcS+NmJfGxGDyVspRXtlzgVl/vlaKy5p72y1YuJFHGWY1Xd0Ft3eIge+1flyiZ9/riiB6ewijq65Fhi5RQmBcchfwySmK1hgbLULRNs9xfVjt+EUPL6SB4kJeG7EMdHgzr7txMOT129Oozia+KqOhUopkZjPMemJz13eVyszir7dRjmXs4qyqiI359IV3si6+XpXlK/n/2ilZnG5aEHYTeRzaOC/iNTGAbe3Lhdwuaz7u6atIzxhQ2/cv4vlcvl/AS0rmw==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Draft Template","permalink":"/docs/API-docs/v1.1/drafttemplate"},"next":{"title":"Public Template","permalink":"/docs/API-docs/v1.1/publictemplate"}}');var i=t(74848),r=t(28453),o=t(33617),l=t.n(o),a=t(17543),d=t.n(a),c=t(86013),h=t.n(c),p=t(63723),u=t.n(p),m=(t(18766),t(79329),t(9303));const x={id:"createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",sidebar_label:"Create Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztPNtyHLeOv8LTtVWJta3RzEiyHe3LKjnexHu8sSqWN7Ur6Sicbsw0rW6yQ7I1mqim6jycP9infT2fli/ZAkj2ZS6SbCuJvdV5cDTNGwACJAACuI0sn5no6Cw6haLMuQUTXcRRCibRorRCyegoOs2AhWb2jQaO39nxyUvG81zNDasMaMOsYgk2AksqY1UhfuGTHJgNE8dsnokkYwb0NTBu2CSvoNRCWsOmSrMZSNDcCjljqUqqArBhLmzGSg0pTIWElBmrq8RWGsyAvS2VZKZKEjBmWuX1Sg4MoWTMbAYEqAZbaWkYZ5UUP1fAdnZC70uR7uwwm3HLEi7ZBBCdFLHxAEELnAnHNiVpYlNCIqYCO/u5BufyXJ6K8oi9LXPFU7ZQlWYnf/63egqcF7+d7ez8GSbVjL19ubNz8WVmbWmO9vZ4WQ5UCdKImcz5xAwSVeyl2LFMp0+QgqABZyVYgRuRLxhPUzYX6QysIYwlS1S5YIlSOhXSkb7kM2CyKiagTcy4TFmhNDAhGWcaeLrYtWq3MsD+/c3r73E7Cm4H7CSvTFwvlwoNic0XbnqkQMDqC0eZpwe4P0LOYlbwK9xIYdnPlUiuEG0Dksjq94RotbPzpipLpS2k7EeHwtHODrZ8DbmaM66B+ieqKJRkJde8AEvchhuGzRp+roSG1LEKz/NAi6NzuYv7vCjhaGeHvZSpSJAYNCF+ZWrq+w5cVyQSdn3jN9Z1bZEOd94xMdJkzt1+ljlPHJgakCesuIbuxDcxW+DEfwapAgSZ0uIXJS3PaTuuQVuR8Ly9bQggMZrlmuSiVELa8NWvwP7Lbw/uHm2K5ysELUViFUJSiwF2zfMKjIdqHrMMofoBSg2G+NvPi4SUKctAzLKt6/H0XWVsZ2JWGQSzDYVfK+wSkReIbFOeG2Bi2qFlwa+gtRpTdAjxfMC+XrAUprzKbcwEcpzVFQzY98oyXpa5SOi0wYMEhYfjGbFLu+zZwQMieUF7fKLVtUgBj4RUTKegUTixkabwYwJ0yGclDUD0SHJsxiVTcmWjE5Urvc5C9LlLR5YoaUHaATu+5iIn4B2yhgmZ5FUKbJLz5CqmczJmGlInuAvAUzd2/E5d8DB1NCf6MAM5cqGSCL9UfnlhmhNrwE4zYRp5wsZAalpEmDZVvdROFa6MJAgixqDgIo+JcDF7pybMCptDjAJbcrmIWcotxMzCjZ2om5glGSRX9JfmqVBsUlmLBzWumWpVpmouPS2nSlojftkgkaHl/Sk6jtlBzJ7G7HnMRsOYjcYxGx3EbPQ0ZqPnMRsPYzYex2x8ELPxUwfW+LmnNa8J3AZgNHZUtp8PdfHcfSUMSTYemKY+g+edM3g0YDs7tTTht59++ulc3p5Lxs4jFK7z6IidR3WX8yh2bXhmYtvI/77BH/vjZ/7nAn8+HT/3P+fUdXTgf2b4czw6l0u/4LkcEySWF+UdUGDzo0Lgf3kmwm+0KH4L5xl+xIMoDg24Vx14sGHZxmUfcRFSWMFzsx2d0OMTwqgBaQ2pA0SK2HU7RtT8CaHThgdb6Jh0TXSstpqCwBMU4zXsDwf+ZtmOvFv2k8G9Bc7Hof4UUcej6RSPpu3416fXJ0SEVZg+jhLPBqQA0Mm8nQ6+wydEhS5EH0eD50gDvJS2EwBbPyHsW+Bgg7/hXdvwYHd0uDsejg86FEDbyHUoit003V0sFo9BPdR5/PKo8gQN1Wl2aIZOtSo2mB9kHTS9vE5EfweV/T9QUZ8EHRZStPu6Fmyw+NpatlUpX3xh3FRhaK2cYf9GNVu0wKQmhIOs3yRTIvHAY5+gkk3QwBsgDXaJkntputeiJH5M092i2F35iD93ifCtj0UxSNPBSs+13XEfC5amMVv/vPF7mrKiKLZ8dt87n/eKYh2LQVF42Ej5+mpA7gfS2bbLie/we4lKIxHdhe8UI/QcKJnT2mTObZajlcsmE9I3eKZiKx00zKqca7hBu9QIJV3vx5exIGKNZk92LJmA5CVwpGBfvvba+xPP/ohCdwL8cv+4NcxwkmPvMGMaZnDDSm4taEmTXfNcpM7ftksf4IYXJZoAe389P0//+Z/2yAGBNr5luBMsFTOBfqC9v54d7/73xYYeVVmCTrgBlgOuZGIGNhmwswzysnFFzefzwXzfJJlSufNDvTMapu7fSzV5d0nglgNuyiebMHWs0TL4kXVW7X0DtkMxblgYucHkJx4jGRoN6bb19s4d163v8QndOCsgYaPznmDz2XlUcFJIkJWh+VvZDPR5dFGPcUY+pPeMvXiAsGYihZxPIF9verCg1Z9zvlCVl+/g1Oqi6jm6RTdsKISs/RaEzjBuNfKblUbXttwg344gbekMV04Qz7ADLBcmeG665GyP9q4tcjhKcK7hCbAwgE1qLv1oKagBe5gYuJPI7909S2A/Rh1rt2JY7Z4VOhvTJgzOUQgpiqqo/aPTetZAssLrHm164Uh8NAgrtHd3bQV+c88K3m2/ZYFzOSI/RvB/3KGZ+h6f0FmxAtLdYvwhp0jnnn6kC/Z+AQxotQVww7WMXd2FXAuf2S59A/Yarzf0ybpB6GVLEigteuQ+VjRrkB98Q5HPqu2H28557V6fEPdtAOs35kDf77Fvnw9i0jb2nxGjdsB+MLM6p2TBZ3dY7tT8CbGnh2fNCbGzc6JhKvK89aTIwqfwsoNPOpBD4Z+9/GMiXnXkCBfSKjQLwrPtBKb0XmrpGSXjzYOju2fclrbfRN0rtNIs48bp36Tw41bhg63NoFhxxQfQGne8kAFu3JXR49mN46+G7X0aPT3s7NPhsLNPw237dIfZiDtoSiVN7WuDpqkl17TF4fv61bIqtmFS3NIXEt9WgvXghEFVecpycUWvKqkwZc4XuKtBSj2Uq89132RKmaaHfzH70iN81H2JUxof454M6oeJhzi8VjajtRejZ/utrTh8/rwrMR2BeYj93qy3vgvDg73R4Z7zaG12aDVumO2H8B2aAGMP2S/yEz1ov6hns2G92+lD3U6Pw+77j2l1j56NO5fF/vBDL4tHN67bUnOPWf0YxvOjWbFtcXug/fq72ZEfz30Hv4VGPXq23+bCZ6NHcKFuUZw/lhPX9ONH4z32WMrxJgZ8gHZ8p0r80QzaBvY3Z9LDx9GkR8OOhvZVR0H7atxmysPDBzFle9EVzjqPxH9+/fqH+fAv387U8fHx8fdv3mYv3s6Oj48L/D0YDDYaUZt2m5ZBzdVHBPp7me74LasMBgMkYcotP6Lhe6Wc/YsbH28fM/Cvz7+RZ+fwMR5TNjhwPv4UqLv+cd6a307OP04Cmf/vXEZxpEoKKFbyZRodRS44OYTqRjGZmGDs1ypdREe3kQ8fwz99cBYO3XtnMAj6NjJJBgXHv4JpimHTU5HjVBgBBdpEcUTxBBhDjdwXHUVq8g4SG8X41lWiQwIMzkHjjm5DLxc2G8VeGY+OIsf9URz5F5/6EwOZKHzDLdNptAwL3jVV/aWZytAfddwyzoORqR84DQ1droSNf9BM7RmWDVmbybjWfBGtRqiHkNTwnujG1TF3+SJcEsKiS6SOk6RuURwJC0V7lS2bptX7UzoBhZhQrNH7jqVt4cV7r4njykzJDxrovRAbaP5AKrnW9YW7W3aMwY6QBu10t4najRlFzg3u45jQn7Dls/aa7q1gbc3TbdHcrSBSk5FJyssSuB5QUPUHx+tTSgTPk4qyEurjsYNZDWqN2WgZRzf3I3PDErUbQsXZlzlMrXvaZYnSEvSTdrzIJ4Pc+OBgGUeL+9FbfJboPcPNm9+P3Y8UY9/kH/wRsO4/X8ZRdj+s39VZAH8gsAdPl81dt3KVX05UurgM59byvo7hUsF+mJPyUr7WKegWISZK5cDlGiVeTp2XXbEv0PL4InYBFRS8LbQJFwqbo6NZQwKYCEJxVuGsYl7ncJHdzAfUonP+BX4gdclUE4O9ZJjPuAknwKwWsxmg79n3oME+PB04JVdJH+bBp8HbVmq4FqoyATx0SGPQXw7oY7YZCJczIeSsax21qENu7zbug/bu4Be85CTGs78+PXkALcl022U2q2PjHZZuDvb69ARTYsTUq2ED9tbUlAik5Z0uDNUidi14CJuvz/aFe4QG539UhGzHVz/wySi7bB2gVJiNEMUu+w3j9ev8t7WJm5wp3CJVWfT9C58JYCyUpkNHgqIm5KmqHsKV91CSs1lFMX8WRTbkx1DYT5PSIqRLrCO9P610yOLxbIE9McuuoVOgCnZqzR8zkMYN52zKjQUdY8odUl5XqOXXU8JNCVqATGAjCTQ40l1WeqPe1KVBNz/k7Q+vfKZcwCEI5QQl0E0MKatK4hqShDpvKezcKuprihJKB+jLbQrauupB2UXeJVGCNkqi2aL0jEvxi2Nh0kjQ6plAxnPX1R8V6LpGeFDCu8CEs/bXv/+jBddWjXMdMLcCT1MMSrsHQjLtHMOjxq2hxBNQdSHC+UD/6+olgNCR0FwWKq0FyTycx08ojM3U56J/S6vf8UyVZKjg1+eticMZa7xaachWJIOSHuNKxBduhLGtzJsQH7t+PvwASMekBQOpISjVyPNy0Rbw5n1RrUxH+UGim7VVX4NrssArqy41FEI+7J5qe8esqg+CyqqCW5GwMJUZdHPx3BNMkOuCfRlAQ268Fko/2SKqON2lkglcCnkJ16AfoOB9X8fzpHyBzG3nALINWyCSu86afKk5prh2aNK6nSgrsA3lIZoH7hF1k+1ytyEZ+MFdJZRzW0zwMd89B6Oo0cGhGluyawx9LtaUfxftbanPyNgYDYf/n22p/eHnY0sdDD8jW+o5AuvdqPcfQNv0m41nR3AL3z3gnSKnDTl07+6JXtZlXDuxNxG4EYfx0v3XmH/h3L/HJHQ2Y+PW9eZMQIbIMB4O8X8rh2Cn4gQqt3U1inzxpyh+uE/57j1wn9GLfRexvs7G35lSFkmGNCvAmO5JvmHIPQi06SZkLiRcBqJcjofDy8PI0ftgE3HeqAJsRloV6tNzrbAwRJkDph5YvWB8xoVkuLx+RFqB1vdx1ftBdhcRDobDy1FNhMN1IryUFPBORUhO1RXI3xfT9vLWLY+g3hR5I9qRcJ2oPeog2/7ukDSQVFrYRXR0dhvd7PJS7Lr2o7OL5QVync0UvraUyhDE3GbRUbS39vhCVWDQtX92G5GJF4Ujz3CZYjTB2rHHS7F3PRqMomW8OmbjMXlHf6h233eIsXwm5Oy+cRcNjd7gPrqt6lCqUQVL8RdAXdBvRLtXHAnknww46vxIemSPH5onqxdhk8Nj0qb3oWYzV198woNP5w1n9bra8CrTepQ5Cy8i9MhRv3FEDUJR/Q6Bf9a68FnDsrUTP+idI1LYxgcHpNk8G5EKsP+cbteDp8sLR+CW146CQ9uuJxcH0fGh+E9dn0IUrdjwHUN61Y7eatNuMWn9kiumWw3IJovpsGOobKBWuGi7tMJIAaTV/pBodTAkWj0fdu54j2EzQ3NT03Vc38Z05bZvXLxWL5D/hJwqYl7PUa9LkG/Q4YWHCzH/mmYGeaKKusBFGPDr3/9BY4I57BwLOMOfMIDidaVZqeagsaYTVq6Y5nAj0PDDQVBQm6HnPAp75kUOxuAbn7QwcwWbMAkOPWzeh5Pwkk9ELvDkdKG9FCPYOnzNgP2YAT67Y9MX2uUEXkOOB25tOrdKU7G50ldTLH8VM84mWPgGnScgMy4T56dxpwD5G9BwRB9YqYXBej4aoRYONiWt5ollBZd8Rg6DuEOqFHKBRyXTaoJuTKPyyjnqLBe50i6iixCiJ3eKQnlxU2ITqZbo4dKQId9ee2+diZ231Am4rwg1Qcd0ibCIBMhpUclcYfEmdHBXec5KZZ3TGTXYNow43GouDaqdDpawBzXBvCMNjA97fmsAd/iVkFeu4MguO6t56keYGGGhm464KntPumO+Ffa7aoLljJQRVulFM3ombFZN6KhuT1L/cDN9Gwp+tQ7iZo5UJWaDLq4Ss4eZk3tvwCKHmL3jk5d01T9hv/7tf9gr4FqyTM0dtyaVhnzR1BajUly0845s9U1NrlpeYT0vS0wqZ+H1IFDwx4zbX//2v4Z9D3N0WaEIOULu7JxUk1wkdd02s7Nz5Gq3tSqyddOnXFA7+s85K93oXMirATuWC/L4uWcGZAb8TuM6aJD3e0uttLpCWgMR+ZgM5NdArkSsoDMBBqlwrxJaVTO3WhsYj1w3vh9xO05TVq7E+KM/qwHHuWzoOYA73w1WONuQFtCJv+9W5gGZUg0uc8RSzae2mT9eCfynF4K1TyFnIJAj9tO0iuQhJT3G9dcBhbOsKBHds1bDFDQuaDql63gpPDudBbZk3Tzf92drZ7tJyxNSYcMFyUux0eOLFcjM6+kb0NciAa9RbZHoPeq8F8VRLhLwhqS/u46/PXnFrvcHwyhuqWYPEO69Vy+/efH9mxcIDB6kjmCjwXAwJH+XMrbgsrWSl5PTRldaiWypFfi+NmJfG7GvjdjXRuxrI/a1EfvaiH1txL42Yl8bcQ2pvjZiXxuxr43Y10bsayP2tRH7JPW+NmJfG7GvjdjXRuxrI/a1EfvaiH1txL42Yl8bsa+N2NdG7GsjPqo7sq+N2NdG7Gsj9rURe7dTXxuxr43Y10bsayP2tRH72oh9bcS+NmJfGxGDyVspRXtlzgVl/vlaKy5p72y1YuJFHGWY1Xd0Ft3eIge+1flyiZ9/riiB6ewijq65Fhi5RQmBcchfwySmK1hgbLULRNs9xfVjt+EUPL6SB4kJeG7EMdHgzr7txMOT129Oozia+KqOhUopkZjPMemJz13eVyszir7dRjmXs4qyqiI359IV3si6+XpXlK/n/2ilZnG5aEHYTeRzaOC/iNTGAbe3Lhdwuaz7u6atIzxhQ2/cv4vlcvl/AS0rmw==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},g=void 0,j={},b=[];function y(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(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:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,i.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document before it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date"\n "page": 1\n "x": 173\n "y": 588\n "w": 114\n "h": 21\n "options": {\n "name": "date"\n "response": "04/15/2024"\n "format": "mm/dd/yyyy"\n "color": "black"\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 528,\n "w": 114,\n "h": 21,\n "options": {\n "name": "dropdown",\n "values": ["male", "female", "other"],\n "response": "female",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(d(),{parameters:void 0}),"\n",(0,i.jsx)(h(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"sample note"},description:{type:"string",format:"string",example:"sample description"},signers:{type:"array",description:"You can provide signer optionally if you it as default signer",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:""},name:{type:"string",format:"string",example:""},phone:{type:"string",format:"string",example:""},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"createtemplate_body_signers"}},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5},prefill:{type:"object",description:"You can provide widgets which can embed before sending to signer",properties:{widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"textbox"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:100},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},title:"createtemplate_body"}}},required:!0}}),"\n",(0,i.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Template created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bh2Hspnmch"},message:{type:"string",example:"Template created successfully!"}},title:"inline_response_200_5"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function f(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/9cd612ce.56e55e5e.js b/assets/js/9cd612ce.56e55e5e.js deleted file mode 100644 index 31b06e194..000000000 --- a/assets/js/9cd612ce.56e55e5e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4372],{84121:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>w,contentTitle:()=>h,default:()=>j,frontMatter:()=>m,metadata:()=>n,toc:()=>I});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":"eJy9V81uJLcRfpVaXuIVWjMjrewkfYpgK2vZglewZAiIdiCwu6u7abFJmqye0WAwgA95g5xyzaPtkwTF/pkZ/WwiO8hFmq5i/X+sKq4FySqI9Fb81eoCvZgnosCQe+VIWSNScV0jFKiRELojcHp5DlJruwywsi2QHfhl5E9EIqxDL1nBeSFS0bE7rkiEk142SOjZ7loY2aBIRce+U4VIhGLDTlItHntjs58xp/MCbAmjQo+/tMpjIVLyLSYi0EqzyqAap1EkAh+ctgWKtJQ68IG8xkaKdC1o5eJJ8spUIhGl9Y2kXQo+yKglFdn3R3lZHNcuE5vNnM0GZ03AwIqOZzP+t+9taPMcQyhbDWNGRCJyawgN8XnpnFZ5ZEx/Diy0fupdFzRnzrMaUp3JIRevjePb+3D8ncPluRObpC9OcUrPqdkKHc+O3x0ezQ5nf7w++io9+XP65VeT2Wz2N5GIh0azbF/HQhKyXlKkt987BGW0Mng3ZO/ueDa7OzoWmw0fOnkujYd9qUEFMJYAG0erBDiNUpkAhc3bBg2B9QMGP5pDuLINUq1MBUtmLr01VQJOowwI5FcgK6kMaEno33z8XYWxBj+UEc37JULvrf98Yl8dGmcq+Q2GXpUONjJ/uWYns9ndu7FkJ09L1kfFIZW2NcXkfwf7F0P9HOaf+vM5SJ7MTu7+NIb35dPwzs1CalXEVkj2Hs2b/0N822ieMc+u7l9E1R2KfLEX7C69CzJg3npFqwjhh0Pp1GHHT2/njANGjt228tjEqRapmHaJna7H9r0RrM4vhvbeei1SURO5kE6nQZoisw8T69AEVRktszDJbTOVTk0XR5Mjwdjel5HOveo8toevFQkkK2Wq/yQ332bqiqvZFWwvX2PZpFPf40okQzl2T/UTrkbJA4wLoExpo3BfpA8OzZWqTCxxNP54Et6gzm2DPH6pRhgEPv39X1FmaBwRg1HDm4/mo/nQenB2iZ5nkjQFlBofVKYxCmETeeNcDygbjSHoFShDWHlJCIWqFEkNnCPuJrl0MlNaMX75mGVpDztXIEzgpkaq0TPrDx5BQoEL1Ax7kC3ZRhKrGrvd0vr7kjeMBCRkbVAGQwA0tTQ5HxyqkHBflAbQEHrnVUAI5Nlr1flmDXmZEzTSyApZd7KXqgK1YqiCt1kbCILVbXQZSCptPRYwBGQQizDhJJ7xOuERmJrbxnmsGTILhKpVBQbu3wVCiNeVQzAFZBgIHPuicgystDXa5vexeGWrNTjL3UNJzbvNro8sTl6awA2u82WowZgw5y1vGtg5eHDwU0Cu8IUy9yE9OOBxeDti6gazoAjnXwzwXy6XT2D/dl/mvaJv2wx+RGeDIutXW+lKUd1m8arsKhk/Ok3v0WDEz85F2OoobB6e3jymTmvUbnqFxAgJ09PL82sWfQuffv0HXKD0Bmq77NCatx71CqrBFGeuq3yXtrFfQmkj8GrOeN6Bj7dIDDRk8KaW9OnXfwb4AZeguivUJfLg4LLNtMrhGhvH4zIcHKTwtUc2SQMNqJYEuTSQIYRaMpQWSoIE10lrZe4ncGpW0Ab0sFRURzAwPcrthcF5GcsdIJMBC7AmSgw2J1uPmN4E1AsMrIvnXoaAhSJGdO1tW3XWdp3pg/NYKq3hRhUVUozttCjA9eRlR45r/9YdLPlCUI0rkB4hoKEJXD4SiZzWOevZC9U5X1p+SnAB0BTOKkMhhcLLkrb6ky3Qc06zsuYZUpdCOaYj6dWMJeluYh/xSJ3E1e9RE9/vtR5L9Gwwhr2ti1M9nG4HWAKj9ffAmid13P7yuEhgI5XupslfHuuJQx19Ez6UV+gXKsd+or1wo6fx8FQkQqscTcCdZeH0/eUFLN5NZiLZGY3/xeWeXpx/ffbD1Rk7w420S9jRZDaZMcnZQI00O5a+2X1LPp5q6+0S9dsenv3wJXygqdNSxc0nBrTuV5ZbMb4b0+2bc56I2gZi9nrNl+snrzcbJv/Soue9aJ6IhfRKZjyfb9eiUIF/F+Oj8sVAvvixf5++hWefr8/6PGwRhleIhdQtf4lE3ONq77G8mW+SYZFgtzr+aZ6jox3JJwvp3lb3zdnF2fWZSAS3xP0d5j7uMP0PNvCsY/vLTecD/+VN61mB9brbjzab8XzHelGij3E4zVmabzabfwPvNeFU","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),r=o(28453),i=o(33617),d=o.n(i),s=o(17543),a=o.n(s),p=o(86013),c=o.n(p),f=o(63723),u=o.n(f),b=(o(18766),o(79329),o(9303));const m={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:"eJy9V81uJLcRfpVaXuIVWjMjrewkfYpgK2vZglewZAiIdiCwu6u7abFJmqye0WAwgA95g5xyzaPtkwTF/pkZ/WwiO8hFmq5i/X+sKq4FySqI9Fb81eoCvZgnosCQe+VIWSNScV0jFKiRELojcHp5DlJruwywsi2QHfhl5E9EIqxDL1nBeSFS0bE7rkiEk142SOjZ7loY2aBIRce+U4VIhGLDTlItHntjs58xp/MCbAmjQo+/tMpjIVLyLSYi0EqzyqAap1EkAh+ctgWKtJQ68IG8xkaKdC1o5eJJ8spUIhGl9Y2kXQo+yKglFdn3R3lZHNcuE5vNnM0GZ03AwIqOZzP+t+9taPMcQyhbDWNGRCJyawgN8XnpnFZ5ZEx/Diy0fupdFzRnzrMaUp3JIRevjePb+3D8ncPluRObpC9OcUrPqdkKHc+O3x0ezQ5nf7w++io9+XP65VeT2Wz2N5GIh0azbF/HQhKyXlKkt987BGW0Mng3ZO/ueDa7OzoWmw0fOnkujYd9qUEFMJYAG0erBDiNUpkAhc3bBg2B9QMGP5pDuLINUq1MBUtmLr01VQJOowwI5FcgK6kMaEno33z8XYWxBj+UEc37JULvrf98Yl8dGmcq+Q2GXpUONjJ/uWYns9ndu7FkJ09L1kfFIZW2NcXkfwf7F0P9HOaf+vM5SJ7MTu7+NIb35dPwzs1CalXEVkj2Hs2b/0N822ieMc+u7l9E1R2KfLEX7C69CzJg3npFqwjhh0Pp1GHHT2/njANGjt228tjEqRapmHaJna7H9r0RrM4vhvbeei1SURO5kE6nQZoisw8T69AEVRktszDJbTOVTk0XR5Mjwdjel5HOveo8toevFQkkK2Wq/yQ332bqiqvZFWwvX2PZpFPf40okQzl2T/UTrkbJA4wLoExpo3BfpA8OzZWqTCxxNP54Et6gzm2DPH6pRhgEPv39X1FmaBwRg1HDm4/mo/nQenB2iZ5nkjQFlBofVKYxCmETeeNcDygbjSHoFShDWHlJCIWqFEkNnCPuJrl0MlNaMX75mGVpDztXIEzgpkaq0TPrDx5BQoEL1Ax7kC3ZRhKrGrvd0vr7kjeMBCRkbVAGQwA0tTQ5HxyqkHBflAbQEHrnVUAI5Nlr1flmDXmZEzTSyApZd7KXqgK1YqiCt1kbCILVbXQZSCptPRYwBGQQizDhJJ7xOuERmJrbxnmsGTILhKpVBQbu3wVCiNeVQzAFZBgIHPuicgystDXa5vexeGWrNTjL3UNJzbvNro8sTl6awA2u82WowZgw5y1vGtg5eHDwU0Cu8IUy9yE9OOBxeDti6gazoAjnXwzwXy6XT2D/dl/mvaJv2wx+RGeDIutXW+lKUd1m8arsKhk/Ok3v0WDEz85F2OoobB6e3jymTmvUbnqFxAgJ09PL82sWfQuffv0HXKD0Bmq77NCatx71CqrBFGeuq3yXtrFfQmkj8GrOeN6Bj7dIDDRk8KaW9OnXfwb4AZeguivUJfLg4LLNtMrhGhvH4zIcHKTwtUc2SQMNqJYEuTSQIYRaMpQWSoIE10lrZe4ncGpW0Ab0sFRURzAwPcrthcF5GcsdIJMBC7AmSgw2J1uPmN4E1AsMrIvnXoaAhSJGdO1tW3XWdp3pg/NYKq3hRhUVUozttCjA9eRlR45r/9YdLPlCUI0rkB4hoKEJXD4SiZzWOevZC9U5X1p+SnAB0BTOKkMhhcLLkrb6ky3Qc06zsuYZUpdCOaYj6dWMJeluYh/xSJ3E1e9RE9/vtR5L9Gwwhr2ti1M9nG4HWAKj9ffAmid13P7yuEhgI5XupslfHuuJQx19Ez6UV+gXKsd+or1wo6fx8FQkQqscTcCdZeH0/eUFLN5NZiLZGY3/xeWeXpx/ffbD1Rk7w420S9jRZDaZMcnZQI00O5a+2X1LPp5q6+0S9dsenv3wJXygqdNSxc0nBrTuV5ZbMb4b0+2bc56I2gZi9nrNl+snrzcbJv/Soue9aJ6IhfRKZjyfb9eiUIF/F+Oj8sVAvvixf5++hWefr8/6PGwRhleIhdQtf4lE3ONq77G8mW+SYZFgtzr+aZ6jox3JJwvp3lb3zdnF2fWZSAS3xP0d5j7uMP0PNvCsY/vLTecD/+VN61mB9brbjzab8XzHelGij3E4zVmabzabfwPvNeFU",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,w={},I=[];function k(e){const t={p:"p",...(0,r.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(b.default,{as:"h1",className:"openapi__heading",children:"Delete Folder"}),"\n",(0,l.jsx)(d(),{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)(b.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,l.jsx)(a(),{parameters:[{name:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"bK1cfd2hpb"}}]}),"\n",(0,l.jsx)(c(),{title:"Body",body:void 0}),"\n",(0,l.jsx)(u(),{id:void 0,label:void 0,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"}}}}}})]})}function j(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,l.jsx)(t,{...e,children:(0,l.jsx)(k,{...e})}):k(e)}}}]); \ No newline at end of file diff --git a/assets/js/9cd612ce.b75be620.js b/assets/js/9cd612ce.b75be620.js new file mode 100644 index 000000000..e41578926 --- /dev/null +++ b/assets/js/9cd612ce.b75be620.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4372],{84121:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>x,contentTitle:()=>b,default:()=>S,frontMatter:()=>u,metadata:()=>n,toc:()=>D});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),i=o(28453),a=o(33617),s=o.n(a),d=o(17543),r=o.n(d),p=o(86013),c=o.n(p),f=o(63723),m=o.n(f),I=(o(18766),o(79329),o(9303));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:"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},b=void 0,x={},D=[];function y(e){const t={p:"p",...(0,i.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)(s(),{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:"Request"}),"\n",(0,l.jsx)(r(),{parameters:[{name:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"bK1cfd2hpb"}}]}),"\n",(0,l.jsx)(c(),{title:"Body",body:void 0}),"\n",(0,l.jsx)(m(),{id:void 0,label:void 0,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"}}}}}})]})}function S(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,l.jsx)(t,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/ac7da374.4a1b8c9b.js b/assets/js/ac7da374.4a1b8c9b.js new file mode 100644 index 000000000..f38eb6e75 --- /dev/null +++ b/assets/js/ac7da374.4a1b8c9b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2043],{27845:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>h,contentTitle:()=>g,default:()=>S,frontMatter:()=>f,metadata:()=>a,toc:()=>y});const a=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=i(74848),s=i(28453),p=i(33617),n=i.n(p),o=i(17543),d=i.n(o),r=i(86013),m=i.n(r),c=i(63723),v=i.n(c),u=(i(18766),i(79329),i(9303));const f={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},g=void 0,h={},y=[];function D(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:"Request"}),"\n",(0,l.jsx)(d(),{parameters:[{name:"template_id",in:"path",description:"ID of the template that needs to be deleted",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}]}),"\n",(0,l.jsx)(m(),{title:"Body",body:void 0}),"\n",(0,l.jsx)(v(),{id:void 0,label:void 0,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"}}}}}})]})}function S(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,l.jsx)(t,{...e,children:(0,l.jsx)(D,{...e})}):D(e)}}}]); \ No newline at end of file diff --git a/assets/js/ac7da374.b0aacfe5.js b/assets/js/ac7da374.b0aacfe5.js deleted file mode 100644 index ff11d1a1a..000000000 --- a/assets/js/ac7da374.b0aacfe5.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2043],{27845:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>f,contentTitle:()=>v,default:()=>x,frontMatter:()=>u,metadata:()=>a,toc:()=>D});const a=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":"eJzNV81uHDcSfpUKL4mF1szIVhxsn6KNBUdYIRYiBQJWHgic7upuRmySIatnNBg0kEPeYE973UfzkyyKnJ4/yU6MLIK9SNPF+v2qWFVcCZJ1EPmduMHWaUkYxDQTJYbCK0fKGpGLmwbhDWokhIELzq4uwHk7VyUGWNoOFooaoAZBzpRWtASy4LG1cwQJwWGhKlUADfKVt21kHyhhBBcVyC2HCmAsaGtq9GAQSyxFJqxDL9mvi1LkooxeDU6JTDjpZYuEnmNaCSNbFLkYdN4rVqE4JiepEYeBXrwBW+15BdRIitYDBzRDSCZZj8dfOuWxFDn5DjMRaKnZWlCt0+wMPjptSxR5JXVghqLBVop8JWjpIid5ZWqRicr6VtKW0vdT1h+cNQEDS7ycTPjfQWIGL9dOQeiKAkOoOq2XX4hMFNYQGmJJ6ZxWRYRu/HNg8dVTh+zsZyyIcfQMNKlkPJEZ8aeu46OM4ebi74/NSxnc9+6V6LN1asoz+rTQy8nLV8cnk+PJNzcnr/PTv+Vfvx5NJpN/ikw8tppl1zksOcF9JkiR3n73T9ii2T3GNaVn5tPnYLy2LVKjTA0LNAQLb02dgdMoAwL5JchaKgOMtP8fooreW/9pdD7Ps34namW0Mng/1ND96WRyf7IB4fQTtWQsQWU7U/61oT5n/9MBnd6/3gT09dOALsxcalXGTnVjH9D8tfHsmqdk/mm1qsQUz8VesLv0FGTAovOKlrGxPR5Lp47TeX435XbBlWK3TTE2Q2pELsZDMxuvdhphL1ilnw+tsvNa5KIhciEfj4M05cw+jqxDE1RttJyFUWHbsXRqPD8ZnYg+O5SRzn0WP3bHnysSSNbK1L8nN92idc0ZTUnbw2yTOunUP3ApsiElu1zrWdGgLNHH9ClT2Si8TtQ7h+Za1SamORo/nCm3qAvbIk8PHiyDwIff/hNlSlt0LRqKdRg1fPHevDfvOg/OLtBXnQZpSqg0PqqZToMX23iWBi9ZCChbjSHoJShDWPs4E1StSGpgjLiDFNKl0awwMJtlaQ871yCM4LZBatDz0ZeeJ3eJc9Rc+iA7sq0kVjU4DQvrHyptFyEDCbMuKIMhAJpGmoIZhyxkYD1IA2gIvfMqIATy7LVKvllDXhYErTSyRtad7UFVolZcquDtrAsEweouugwklbYeSxgCisN6xCCe8/z1CEwtbOs8Nlwyc4S6470lg8KWCCFeWQ7BlDDDQODYF1VgnPmd0bZ4iMnjuQrOcgdRUvOusOsji5OXJvA0T74MOdgA5rzlAY3JwaOjnwJyhi+VeQj50dF7cwx3m5q6xVlQhNOvhvJfLBZPyv7FvsxbRd93M/gRnQ2KrF9upWtFTTeLV2VXyeYjaXqLBmP97FyErY7SFuHpzWPquEHtxtdIXCFhfHZ1EZvuC/jw67/gEqU30NhFqtai86iXUA+mGLmU+QTbpmdCZWPhNYx4kYqP1y4MNCB420j68Ou/A/yAC1DpCiUgj46uuplWxWZpDUdHOXznMe51Ay1teIU0vNyFRnIpzZUECS5Ja2UeRnBmltAF9Ns9l+lRbi8MxmWT7gAzGbAEa/aWytHWI6a3AfUcA+vi2TdDwFLxNkeNt12drO06sw7OY6W0hltV1kgxtrOyBLcmLxKZAd9xByu+ENTgEqRHCGhoBFcHIvGkc8569kIl5yurtV1wAtCUzipDIYfSy4q2+rNtoRcMs7LmGVKCcLvpZ2s1m5Skm7iOePs+eM8N+aCJ7/dajxV6NhjD3ubFqXU53Q1lCVytf6aseVpz15JFXCawlUqnafLtoZ442NG34V11jX6uClxPtI/c6HFkHotMaFWgCbizMJy9vbqE+avRRGQ7o/EPXO7x5cV35z9cn7Mz3EgTYCejyWjCJGcDtdLsWDp48B3OtdV2lfq/eh+upzrhI42dliquVRGp1Xofuts8B0Um8t2n4TQTjQ3ELKsV39yfvO57Jv/SoefFa5qJufRKznj4361EqQL/LjdPvI9i9NWP69fiC/i8V+azAQ27i+HFZS51x18iEw+4PHju9tM+GxYY9jhxnBUFOtqRfbIM722Ub84vz2/ORSa4Fe/vTg9xd1r/YAPPura/VCUf+C9veM8KrFZpL+v7DX86+qjEOsaBm3Ga9n3/X9wt74E=","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 n=i(74848),l=i(28453),s=i(33617),p=i.n(s),o=i(17543),d=i.n(o),c=i(86013),r=i.n(c),m=i(63723),h=i.n(m),y=(i(18766),i(79329),i(9303));const u={id:"delete-template",title:"Delete Template",description:"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed",sidebar_label:"Delete Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzNV81uHDcSfpUKL4mF1szIVhxsn6KNBUdYIRYiBQJWHgic7upuRmySIatnNBg0kEPeYE973UfzkyyKnJ4/yU6MLIK9SNPF+v2qWFVcCZJ1EPmduMHWaUkYxDQTJYbCK0fKGpGLmwbhDWokhIELzq4uwHk7VyUGWNoOFooaoAZBzpRWtASy4LG1cwQJwWGhKlUADfKVt21kHyhhBBcVyC2HCmAsaGtq9GAQSyxFJqxDL9mvi1LkooxeDU6JTDjpZYuEnmNaCSNbFLkYdN4rVqE4JiepEYeBXrwBW+15BdRIitYDBzRDSCZZj8dfOuWxFDn5DjMRaKnZWlCt0+wMPjptSxR5JXVghqLBVop8JWjpIid5ZWqRicr6VtKW0vdT1h+cNQEDS7ycTPjfQWIGL9dOQeiKAkOoOq2XX4hMFNYQGmJJ6ZxWRYRu/HNg8dVTh+zsZyyIcfQMNKlkPJEZ8aeu46OM4ebi74/NSxnc9+6V6LN1asoz+rTQy8nLV8cnk+PJNzcnr/PTv+Vfvx5NJpN/ikw8tppl1zksOcF9JkiR3n73T9ii2T3GNaVn5tPnYLy2LVKjTA0LNAQLb02dgdMoAwL5JchaKgOMtP8fooreW/9pdD7Ps34namW0Mng/1ND96WRyf7IB4fQTtWQsQWU7U/61oT5n/9MBnd6/3gT09dOALsxcalXGTnVjH9D8tfHsmqdk/mm1qsQUz8VesLv0FGTAovOKlrGxPR5Lp47TeX435XbBlWK3TTE2Q2pELsZDMxuvdhphL1ilnw+tsvNa5KIhciEfj4M05cw+jqxDE1RttJyFUWHbsXRqPD8ZnYg+O5SRzn0WP3bHnysSSNbK1L8nN92idc0ZTUnbw2yTOunUP3ApsiElu1zrWdGgLNHH9ClT2Si8TtQ7h+Za1SamORo/nCm3qAvbIk8PHiyDwIff/hNlSlt0LRqKdRg1fPHevDfvOg/OLtBXnQZpSqg0PqqZToMX23iWBi9ZCChbjSHoJShDWPs4E1StSGpgjLiDFNKl0awwMJtlaQ871yCM4LZBatDz0ZeeJ3eJc9Rc+iA7sq0kVjU4DQvrHyptFyEDCbMuKIMhAJpGmoIZhyxkYD1IA2gIvfMqIATy7LVKvllDXhYErTSyRtad7UFVolZcquDtrAsEweouugwklbYeSxgCisN6xCCe8/z1CEwtbOs8Nlwyc4S6470lg8KWCCFeWQ7BlDDDQODYF1VgnPmd0bZ4iMnjuQrOcgdRUvOusOsji5OXJvA0T74MOdgA5rzlAY3JwaOjnwJyhi+VeQj50dF7cwx3m5q6xVlQhNOvhvJfLBZPyv7FvsxbRd93M/gRnQ2KrF9upWtFTTeLV2VXyeYjaXqLBmP97FyErY7SFuHpzWPquEHtxtdIXCFhfHZ1EZvuC/jw67/gEqU30NhFqtai86iXUA+mGLmU+QTbpmdCZWPhNYx4kYqP1y4MNCB420j68Ou/A/yAC1DpCiUgj46uuplWxWZpDUdHOXznMe51Ay1teIU0vNyFRnIpzZUECS5Ja2UeRnBmltAF9Ns9l+lRbi8MxmWT7gAzGbAEa/aWytHWI6a3AfUcA+vi2TdDwFLxNkeNt12drO06sw7OY6W0hltV1kgxtrOyBLcmLxKZAd9xByu+ENTgEqRHCGhoBFcHIvGkc8569kIl5yurtV1wAtCUzipDIYfSy4q2+rNtoRcMs7LmGVKCcLvpZ2s1m5Skm7iOePs+eM8N+aCJ7/dajxV6NhjD3ubFqXU53Q1lCVytf6aseVpz15JFXCawlUqnafLtoZ442NG34V11jX6uClxPtI/c6HFkHotMaFWgCbizMJy9vbqE+avRRGQ7o/EPXO7x5cV35z9cn7Mz3EgTYCejyWjCJGcDtdLsWDp48B3OtdV2lfq/eh+upzrhI42dliquVRGp1Xofuts8B0Um8t2n4TQTjQ3ELKsV39yfvO57Jv/SoefFa5qJufRKznj4361EqQL/LjdPvI9i9NWP69fiC/i8V+azAQ27i+HFZS51x18iEw+4PHju9tM+GxYY9jhxnBUFOtqRfbIM722Ub84vz2/ORSa4Fe/vTg9xd1r/YAPPura/VCUf+C9veM8KrFZpL+v7DX86+qjEOsaBm3Ga9n3/X9wt74E=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},v=void 0,f={},D=[];function T(e){const t={p:"p",...(0,l.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(y.default,{as:"h1",className:"openapi__heading",children:"Delete Template"}),"\n",(0,n.jsx)(p(),{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)(y.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,n.jsx)(d(),{parameters:[{name:"template_id",in:"path",description:"ID of the template that needs to be deleted",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}]}),"\n",(0,n.jsx)(r(),{title:"Body",body:void 0}),"\n",(0,n.jsx)(h(),{id:void 0,label:void 0,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"}}}}}})]})}function x(e={}){const{wrapper:t}={...(0,l.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(T,{...e})}):T(e)}}}]); \ No newline at end of file diff --git a/assets/js/b2e6bd40.102fca2b.js b/assets/js/b2e6bd40.102fca2b.js new file mode 100644 index 000000000..c46654463 --- /dev/null +++ b/assets/js/b2e6bd40.102fca2b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7960],{48597:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>j,contentTitle:()=>v,default:()=>P,frontMatter:()=>g,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":"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":"Draft Template","permalink":"/docs/API-docs/v1.1/drafttemplate"}}');var i=n(74848),r=n(28453),o=n(33617),a=n.n(o),d=n(17543),l=n.n(d),p=n(86013),u=n.n(p),c=n(63723),m=n.n(c),q=(n(18766),n(79329),n(9303));const g={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},v=void 0,j={},f=[];function h(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:"Request"}),"\n",(0,i.jsx)(l(),{parameters:void 0}),"\n",(0,i.jsx)(u(),{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:!0}}),"\n",(0,i.jsx)(m(),{id:void 0,label:void 0,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"}}}}}})]})}function P(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}}}]); \ No newline at end of file diff --git a/assets/js/b2e6bd40.26bd5237.js b/assets/js/b2e6bd40.26bd5237.js deleted file mode 100644 index a5200a262..000000000 --- a/assets/js/b2e6bd40.26bd5237.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7960],{48597:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>x,contentTitle:()=>v,default:()=>q,frontMatter:()=>g,metadata:()=>i,toc:()=>N});const i=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":"eJztWM1uIzcSfpUKL7Mx2pI8O7kIXiNeZzAxdpAxxg6MhccQqO5qNWM2yfBHsiIIyCFvsKe97qPNkyyK7D/JykxmB7sLBLkYcpFVrPqqWPU1N8zzhWPTO/aNzkONyjt2n7ECXW6F8UIrNmVv0aEqwOKPAZ2HmgsJXkNwaKHUFpxYKKEWUDQmRu8Uy5g2aDlZuCw6G40JssAy1vz3V12s2XTDcq08Kk8/uTFS5FF7/IMjJzbM5RXWnH6RnrBYkNvtmTNRsIxhtHyfMb82yKZMz3/A3LOMGUvueIGODAyVppt2s/NWqAVZeeS1kSQyVi9FgV1kIAq2bY85oLmLW6sdgYqolVbXES60jiC0ePwE2oRe7wNpf938O8p13TkwcyGF91FHLoLzzcHcB4vdedEONHZAKPD46MeVryUltuZ+BBdcgVC5DAVCqaXUK0r1klvB5xIdwGbTwemFl7jdwmZDUaGdKV7jdpv1AjpvR2AqrZotFnMUyx2tToS9YicbqOKjEXY9K7hvBLmuDVfroQOpSGfBNnaUps2jHaz3HIeKuxYrLGCtAyWNLB2Ius/LvCnoz0oKGfkjI+zUnH0rDrhyOjZnp+bsFqHSBsFXwjXAlUIVLuZqhVKO4NR5q9XibA+C03EjP5xki0uBK+CqSPnurexj2xkaNT79XQc7SKtwkNuQCx6bprE6RyxgJXwFvkJQ+OjBeTQOuAPhUzctBcYYLPCFRYy9h3zhwVfaip9ia2wPPOVQWSz/8mwP02dn1+R6hRZPx/ys2X1ZxhgrvkTgag0xcKGVA21BkW9lsL5CC7nkVpRNH87ASOQOgdo0z310PiHa+nFTcfXgstO5PbtBXsMbg4o8eP/Lv2gH224zFkFjU2bjPOivy5YW+8bubcAocEYrl7r288kkNu+dW8Sy3z43PjwULLogDzbTdPEOT4jUQCk9LuQ5OlcGKdejnViFkkLhrA1m9nwymZ1MKORtxl78d6NCa7X91KCudY2+oq6yoshWVN4fDunFZDJ73kX04mlEx/0MVdpDqYMqQJTDyUo3hdZybS3mxCKO0+jcUWiGapGW0pVvFE0sqjjH0owFKZwH3Z8SR+v/E9kDIGi7F+XHkH4xO+mQ/uop0pdqyaUo4PzqEm70A6ov/gcx9xEOj/fpeHL1sY6EiXpvDCpuiutsJ9ihPAXpMA9W+DWb3m3Y4zE34jitT+/ut/cZo1LVRDGNdtFj7is2ZeO+wzAyYpdoXbQRrGRTVnlv3HQ8dlwVc/040gYVVY3kc0c0a8yNGC9PRidsm+3rcGM+aT+G409VcZ4vhFp8TO++x+eacpjStINSlyxuxN9wzbI2CcNdGRNUOxXyAm1MGJXG256gv2wTvMeeD1LkjiE/Ja9PuOvnca5dyvUHW/g9sQWqyVLHAm7aQ7slNpd4AfZJ9S3KXNdI2NGJA5tRp81G9DFa+OKdeqfeBAtGr9CWQUbgSomPYi4xKmEd11xXi8hric5J4uceF5Z7hEIshOey+xbOueFzIQV1Ttqmm/z0zdeN4LbCCN1ah2cWgUOBS5TUcCl1uuZ++FkNK20fSqlXLgMO8+CEQucAVcVVThvbTpBRbrgCVB6tscIhOG/Ja5F808pbSkrNFV/Ecsl2oCpQ0u1xYPU8OA9Oy5CS7rmQ2mIBbUBUAm5EIL58NLQEJCWyb7GitrVEWARRoMsg1wWCi72AQlAFzOl7x5AvIsf4RRyU1PlDTB4xKTCa5hZdB13u+Ejq3nLlaNwmX9ocdIDF6+McJgePjr53SBl+LdSDmx4dEcG462rqFudOeLz/U9uCV6vVk9b75a7OK+G/DXN4i0Y74bVd99oL4aswj+16aKT7J1l6hQpj/QyacW+j0Ll72v1JOq5QmvE1eqoQNz6/uoyj/kt4//M/4DVyq6DSq1StebAo17BojyLkUuYTbN2kjo851DMI8TwVX9PqWgRvK+7f//xPB9/hingWXaEE5NHRVZhLkcMN1kZyj+7oaAoXFulI38rAV9xDzhXMEVzFqZSWggMHk7SlUA8jOFfrRIq6xkfyqLcTRmy2bbodzLnDArSKGu2Zo94jktcO5RId2SLGNUfAQlAr95XVYZFOGzrTBGexFFLCrSgW6GNs50VBlDOKV0lMgA/cwZIuhK9wDdzG/udHcLWnEleCMdqSFyI533/XoyqMFsq7KRSWl763n/WFnhPMse0+ESUIeQdH1pjpUpJuYhNxJ02vUHtEYrfXWizR0oEx7D4vRjTldNeWJVC1fk5Z0zBoJkmkoQ274EZ8vW8n0km0tXtTXqNdihwbVvUrN3ocN49ZxqTIUTkc0NTzV1evYfnn0YRlA3r2Gy73+PXlxcvvrl+SM9RIE2Ano8loQiJiqjVXg5MOPLHuz7bBA+l/+CLb8MD4omQkF5F6x7g2DWu+G3yX0zNqRZR6esc2G7pa3xNNIPGPAS3x8fuMtc9OkY1nLYEkmv2AxMguks/HN3Q2bZchcdG9jxBiwEnjPM/R+A/uHbL+qzfXNyxj7ZtbrYv4vMBX9MDMV+ljWkcM02c+yTZMcrUIfEF7k03ivNT7dgnzQyTMzQ+Kql1S64GHu0w6hUF/KaiDCptNIuORwab9aelXNRpg292Uu/vtdvtvFy2NrQ==","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":"Draft Template","permalink":"/docs/API-docs/v1.1/drafttemplate"}}');var s=n(74848),o=n(28453),r=n(33617),a=n.n(r),d=n(17543),c=n.n(d),l=n(86013),p=n.n(l),u=n(63723),m=n.n(u),y=(n(18766),n(79329),n(9303));const g={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:"eJztWM1uIzcSfpUKL7Mx2pI8O7kIXiNeZzAxdpAxxg6MhccQqO5qNWM2yfBHsiIIyCFvsKe97qPNkyyK7D/JykxmB7sLBLkYcpFVrPqqWPU1N8zzhWPTO/aNzkONyjt2n7ECXW6F8UIrNmVv0aEqwOKPAZ2HmgsJXkNwaKHUFpxYKKEWUDQmRu8Uy5g2aDlZuCw6G40JssAy1vz3V12s2XTDcq08Kk8/uTFS5FF7/IMjJzbM5RXWnH6RnrBYkNvtmTNRsIxhtHyfMb82yKZMz3/A3LOMGUvueIGODAyVppt2s/NWqAVZeeS1kSQyVi9FgV1kIAq2bY85oLmLW6sdgYqolVbXES60jiC0ePwE2oRe7wNpf938O8p13TkwcyGF91FHLoLzzcHcB4vdedEONHZAKPD46MeVryUltuZ+BBdcgVC5DAVCqaXUK0r1klvB5xIdwGbTwemFl7jdwmZDUaGdKV7jdpv1AjpvR2AqrZotFnMUyx2tToS9YicbqOKjEXY9K7hvBLmuDVfroQOpSGfBNnaUps2jHaz3HIeKuxYrLGCtAyWNLB2Ius/LvCnoz0oKGfkjI+zUnH0rDrhyOjZnp+bsFqHSBsFXwjXAlUIVLuZqhVKO4NR5q9XibA+C03EjP5xki0uBK+CqSPnurexj2xkaNT79XQc7SKtwkNuQCx6bprE6RyxgJXwFvkJQ+OjBeTQOuAPhUzctBcYYLPCFRYy9h3zhwVfaip9ia2wPPOVQWSz/8mwP02dn1+R6hRZPx/ys2X1ZxhgrvkTgag0xcKGVA21BkW9lsL5CC7nkVpRNH87ASOQOgdo0z310PiHa+nFTcfXgstO5PbtBXsMbg4o8eP/Lv2gH224zFkFjU2bjPOivy5YW+8bubcAocEYrl7r288kkNu+dW8Sy3z43PjwULLogDzbTdPEOT4jUQCk9LuQ5OlcGKdejnViFkkLhrA1m9nwymZ1MKORtxl78d6NCa7X91KCudY2+oq6yoshWVN4fDunFZDJ73kX04mlEx/0MVdpDqYMqQJTDyUo3hdZybS3mxCKO0+jcUWiGapGW0pVvFE0sqjjH0owFKZwH3Z8SR+v/E9kDIGi7F+XHkH4xO+mQ/uop0pdqyaUo4PzqEm70A6ov/gcx9xEOj/fpeHL1sY6EiXpvDCpuiutsJ9ihPAXpMA9W+DWb3m3Y4zE34jitT+/ut/cZo1LVRDGNdtFj7is2ZeO+wzAyYpdoXbQRrGRTVnlv3HQ8dlwVc/040gYVVY3kc0c0a8yNGC9PRidsm+3rcGM+aT+G409VcZ4vhFp8TO++x+eacpjStINSlyxuxN9wzbI2CcNdGRNUOxXyAm1MGJXG256gv2wTvMeeD1LkjiE/Ja9PuOvnca5dyvUHW/g9sQWqyVLHAm7aQ7slNpd4AfZJ9S3KXNdI2NGJA5tRp81G9DFa+OKdeqfeBAtGr9CWQUbgSomPYi4xKmEd11xXi8hric5J4uceF5Z7hEIshOey+xbOueFzIQV1Ttqmm/z0zdeN4LbCCN1ah2cWgUOBS5TUcCl1uuZ++FkNK20fSqlXLgMO8+CEQucAVcVVThvbTpBRbrgCVB6tscIhOG/Ja5F808pbSkrNFV/Ecsl2oCpQ0u1xYPU8OA9Oy5CS7rmQ2mIBbUBUAm5EIL58NLQEJCWyb7GitrVEWARRoMsg1wWCi72AQlAFzOl7x5AvIsf4RRyU1PlDTB4xKTCa5hZdB13u+Ejq3nLlaNwmX9ocdIDF6+McJgePjr53SBl+LdSDmx4dEcG462rqFudOeLz/U9uCV6vVk9b75a7OK+G/DXN4i0Y74bVd99oL4aswj+16aKT7J1l6hQpj/QyacW+j0Ll72v1JOq5QmvE1eqoQNz6/uoyj/kt4//M/4DVyq6DSq1StebAo17BojyLkUuYTbN2kjo851DMI8TwVX9PqWgRvK+7f//xPB9/hingWXaEE5NHRVZhLkcMN1kZyj+7oaAoXFulI38rAV9xDzhXMEVzFqZSWggMHk7SlUA8jOFfrRIq6xkfyqLcTRmy2bbodzLnDArSKGu2Zo94jktcO5RId2SLGNUfAQlAr95XVYZFOGzrTBGexFFLCrSgW6GNs50VBlDOKV0lMgA/cwZIuhK9wDdzG/udHcLWnEleCMdqSFyI533/XoyqMFsq7KRSWl763n/WFnhPMse0+ESUIeQdH1pjpUpJuYhNxJ02vUHtEYrfXWizR0oEx7D4vRjTldNeWJVC1fk5Z0zBoJkmkoQ274EZ8vW8n0km0tXtTXqNdihwbVvUrN3ocN49ZxqTIUTkc0NTzV1evYfnn0YRlA3r2Gy73+PXlxcvvrl+SM9RIE2Ano8loQiJiqjVXg5MOPLHuz7bBA+l/+CLb8MD4omQkF5F6x7g2DWu+G3yX0zNqRZR6esc2G7pa3xNNIPGPAS3x8fuMtc9OkY1nLYEkmv2AxMguks/HN3Q2bZchcdG9jxBiwEnjPM/R+A/uHbL+qzfXNyxj7ZtbrYv4vMBX9MDMV+ljWkcM02c+yTZMcrUIfEF7k03ivNT7dgnzQyTMzQ+Kql1S64GHu0w6hUF/KaiDCptNIuORwab9aelXNRpg292Uu/vtdvtvFy2NrQ==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},v=void 0,x={},N=[];function k(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(y.default,{as:"h1",className:"openapi__heading",children:"Resend request mail"}),"\n",(0,s.jsx)(a(),{method:"post",path:"/resendmail",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"Resend request mail to user for signing document."}),"\n",(0,s.jsx)(y.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(c(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{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:!0}}),"\n",(0,s.jsx)(m(),{id:void 0,label:void 0,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"}}}}}})]})}function q(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(k,{...e})}):k(e)}}}]); \ No newline at end of file diff --git a/assets/js/b93339ed.bc214206.js b/assets/js/b93339ed.bc214206.js new file mode 100644 index 000000000..12a3043e1 --- /dev/null +++ b/assets/js/b93339ed.bc214206.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8749],{74289:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>j,contentTitle:()=>h,default:()=>y,frontMatter:()=>I,metadata:()=>a,toc:()=>w});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 d=o(74848),n=o(28453),s=o(33617),i=o.n(s),l=o(17543),r=o.n(l),p=o(86013),c=o.n(p),u=o(63723),m=o.n(u),f=(o(18766),o(79329),o(9303));const I={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},h=void 0,j={},w=[];function P(e){const t={p:"p",...(0,n.R)(),...e.components};return(0,d.jsxs)(d.Fragment,{children:[(0,d.jsx)(f.default,{as:"h1",className:"openapi__heading",children:"Update Folder"}),"\n",(0,d.jsx)(i(),{method:"put",path:"/folder/{folder_id}",context:"endpoint"}),"\n",(0,d.jsx)(t.p,{children:"The Update Folder API allows you to uodate folder name as well as parentFolderId."}),"\n",(0,d.jsx)(f.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,d.jsx)(r(),{parameters:[{name:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"bK1cfd2hpb"}}]}),"\n",(0,d.jsx)(c(),{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"}}}}}),"\n",(0,d.jsx)(m(),{id:void 0,label:void 0,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"}}}}}})]})}function y(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,d.jsx)(t,{...e,children:(0,d.jsx)(P,{...e})}):P(e)}}}]); \ No newline at end of file diff --git a/assets/js/b93339ed.c3230296.js b/assets/js/b93339ed.c3230296.js deleted file mode 100644 index 45c2d238e..000000000 --- a/assets/js/b93339ed.c3230296.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8749],{74289:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>j,contentTitle:()=>y,default:()=>W,frontMatter:()=>g,metadata:()=>r,toc:()=>u});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":"eJy9WM1u5DYSfpUKL5sx5O6242R3dYp3MDtxMpgxxh4YWE/DoKSSxJgiGZLqdqMhIIe8QU655tHmSRZFSmq17XHW2M1e7G6SVfzqq1/2lnleOZZes39qWaBly4QV6HIrjBdasZRd1ggfTME9QjwCp+dnwKXUawcb3YLX0OqwX8Z9xRsE7mCNUtJ/wy0qH4XPihlLmDZoOek/K1jK2qA9CrOEGW55gx4twdoy0sZSFrdvRMESJgiX4b5m98Hq7EfM/VkBuoRRocWfWmGxYKm3LSbM+Y0klU40RiJLGN4ZqQtkacmlowN5jQ1n6Zb5jQknvRWqYgkrtW24n67gHQ9aUpb9cJSXxXFtMtZ1y3gtOv8PXWxI1T7Qc6tXokDIUOo1jCYTmbnFHZksYblWHpUnHdwYKfLA3PxHR4q2E7A7O697ugJ3y2QwI7JDFFvygBfoSC6efRt4fp7JCtcDzi44buLn5+piXZcwL7yceDsj7rqOdiw6o5WLiI8Xi4eUujbP0bmylTDG13Poe5qkIbKea9Z3t+74e4PrM0MUxVAvTv1janZCx4vjrw6PFoeLv14efZOe/D39+pvZYrH4F0vYXSNJts8K0sYmvMXvkwWhpFB4M7B3c7xY3Bwd9ZyePEbjhW7Q10JVsEblYW21qhIwErlD8HYDvOJCgeQe7Rf/O37RWm2fZuV5yJ5i4YRYGEk4eUjCUMm0h1K3KhStP9vQp6LoIZ6nzTu5+dto3tcPzTtTKy5FESq517eo/r+OfOR6grof2iIeCvtsz9jpejTSYd5a4TehYdwdciMO4356vaRSTHGjqdWYNgCm1pGyeWR1vh17S8dIl10Nvae1kqWs9t64dD53XBWZvptpg8qJSkmeuVmumzk3Yr46mh2xLrkvw4151nlsD58r4jyvhKr+SG65o+mCXBm9tUfW6DNuxA+4Ycngi+mpvv3WyEPZ7xJGEfJ+1+xeDX7e7yzTZvGwVzBysVClDih6V78zqC5EpUKgBCvu9/srlLlukNqmrxEGgU+//B5kCp23DSofIjlo+OKj+qjetRaMXqOlXsFVAaXEO5FJDELYhL1xuHHIG4nOyQ0I5bGy1J0LUQnPJRDZVJFybngmpKAsoGOapC1MEsnN4KpGX6Olrb9YBA4FrlBS8gBvvW64J1UDaFhre1vSmJUAh6x1QqFzgKrmKqeDgzsT0Ba4AlQerbHCIThvCbWI2LTyluceGq54haQ72aOqQCko5sHqrHUenJZtgAyeC6ktFjAYpBALNyMSX9HQZBFoNdeNsVhT7K0QqlYU6BLIdYHgQjCQCaqADJ0HQ1hEji5Mjkrq/DY4r2ylBKOpBgkuaYKbYiRxb7lyVCYjlsEHI2HGapoAMAI8OPjgkDz8Rqhblx4cfFSHcD3G1BVmTnhcfjnk0Xq9fpA/L/ZlXgv/XZvBezTaCa/tZiddCV+3Wci5qZLxS9T0GhWG+Jlk1E5HoXP3MIVpdV6jNPML9BQhbn56fnZJoi/g08+/whvkVkGt1zFa89ai3EA1XEXMRc9H2saqC6UOgVcT43kMvn5oHRi8qrn/9PNvDt7iGkRMoUjkwcF5m0mRwyU2hlquOzhI4WWcXf2wBr7mHnKuIENwNadQWgkOHEyUlkLdzuBUbaB1aGEtfB2CgdaD3J4ZxMvobgcZd1iAVkFiuHO2Q0TrjUO5Qke6qHtmCFgITxFdW91W8bYpmN44i6WQEq5EUaEPtp0WBZh+eR2XifAJHCwpIXyNG+AWwaHyMzi/JxJ2WmO0JRQigi81vafIAagKo4XyLoXC8tLv9Ce7QA9PBKHVI0uRQj7SkfRqRpfETOwtHldnH6my3+sG+7XWYomWLgxm7/xiRB9O10NYAkXrfxPW1AyoavE8jCPYcCFjW/r2vp4wGqBt3LvyAu1K5Ni3xs9k9DwcnrOESZGjcjgZOU5fn7+B1VezBUsmPfY/SO75m7OXr95evCIwVEgjYUezxWwRHkba+YaryU17D+r7XW27G8X+lNd33+Q93vm5kVyE8SrYu+1Ho+H9yBKW7h7ey4TV2nna3m4p9z5Y2XW0/FOLloavZcJW3AqeUfu+3rJCOPpcjC/rz9r55fv+8foCHn3DP4p5mFYUjSorLtvwjkzYLW72fjHoll0yDCwEK+6/jJcfXpKWnfyD2Zcmrihxmudo/JNnp8Pm+YdLlrCsf/834RcGZvmafpLg6whVBy7CKBbWtkxyVbW8orNRJY1YVKX357PbMJ/1H8ioR8nYH9yiFfSXbHpUYLuNs1/Xjefj1mclel6H0+SZZdd1/wbGM271","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 a=o(74848),n=o(28453),d=o(33617),l=o.n(d),i=o(17543),p=o.n(i),s=o(86013),c=o.n(s),m=o(63723),f=o.n(m),v=(o(18766),o(79329),o(9303));const g={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:"eJy9WM1u5DYSfpUKL5sx5O6242R3dYp3MDtxMpgxxh4YWE/DoKSSxJgiGZLqdqMhIIe8QU655tHmSRZFSmq17XHW2M1e7G6SVfzqq1/2lnleOZZes39qWaBly4QV6HIrjBdasZRd1ggfTME9QjwCp+dnwKXUawcb3YLX0OqwX8Z9xRsE7mCNUtJ/wy0qH4XPihlLmDZoOek/K1jK2qA9CrOEGW55gx4twdoy0sZSFrdvRMESJgiX4b5m98Hq7EfM/VkBuoRRocWfWmGxYKm3LSbM+Y0klU40RiJLGN4ZqQtkacmlowN5jQ1n6Zb5jQknvRWqYgkrtW24n67gHQ9aUpb9cJSXxXFtMtZ1y3gtOv8PXWxI1T7Qc6tXokDIUOo1jCYTmbnFHZksYblWHpUnHdwYKfLA3PxHR4q2E7A7O697ugJ3y2QwI7JDFFvygBfoSC6efRt4fp7JCtcDzi44buLn5+piXZcwL7yceDsj7rqOdiw6o5WLiI8Xi4eUujbP0bmylTDG13Poe5qkIbKea9Z3t+74e4PrM0MUxVAvTv1janZCx4vjrw6PFoeLv14efZOe/D39+pvZYrH4F0vYXSNJts8K0sYmvMXvkwWhpFB4M7B3c7xY3Bwd9ZyePEbjhW7Q10JVsEblYW21qhIwErlD8HYDvOJCgeQe7Rf/O37RWm2fZuV5yJ5i4YRYGEk4eUjCUMm0h1K3KhStP9vQp6LoIZ6nzTu5+dto3tcPzTtTKy5FESq517eo/r+OfOR6grof2iIeCvtsz9jpejTSYd5a4TehYdwdciMO4356vaRSTHGjqdWYNgCm1pGyeWR1vh17S8dIl10Nvae1kqWs9t64dD53XBWZvptpg8qJSkmeuVmumzk3Yr46mh2xLrkvw4151nlsD58r4jyvhKr+SG65o+mCXBm9tUfW6DNuxA+4Ycngi+mpvv3WyEPZ7xJGEfJ+1+xeDX7e7yzTZvGwVzBysVClDih6V78zqC5EpUKgBCvu9/srlLlukNqmrxEGgU+//B5kCp23DSofIjlo+OKj+qjetRaMXqOlXsFVAaXEO5FJDELYhL1xuHHIG4nOyQ0I5bGy1J0LUQnPJRDZVJFybngmpKAsoGOapC1MEsnN4KpGX6Olrb9YBA4FrlBS8gBvvW64J1UDaFhre1vSmJUAh6x1QqFzgKrmKqeDgzsT0Ba4AlQerbHCIThvCbWI2LTyluceGq54haQ72aOqQCko5sHqrHUenJZtgAyeC6ktFjAYpBALNyMSX9HQZBFoNdeNsVhT7K0QqlYU6BLIdYHgQjCQCaqADJ0HQ1hEji5Mjkrq/DY4r2ylBKOpBgkuaYKbYiRxb7lyVCYjlsEHI2HGapoAMAI8OPjgkDz8Rqhblx4cfFSHcD3G1BVmTnhcfjnk0Xq9fpA/L/ZlXgv/XZvBezTaCa/tZiddCV+3Wci5qZLxS9T0GhWG+Jlk1E5HoXP3MIVpdV6jNPML9BQhbn56fnZJoi/g08+/whvkVkGt1zFa89ai3EA1XEXMRc9H2saqC6UOgVcT43kMvn5oHRi8qrn/9PNvDt7iGkRMoUjkwcF5m0mRwyU2hlquOzhI4WWcXf2wBr7mHnKuIENwNadQWgkOHEyUlkLdzuBUbaB1aGEtfB2CgdaD3J4ZxMvobgcZd1iAVkFiuHO2Q0TrjUO5Qke6qHtmCFgITxFdW91W8bYpmN44i6WQEq5EUaEPtp0WBZh+eR2XifAJHCwpIXyNG+AWwaHyMzi/JxJ2WmO0JRQigi81vafIAagKo4XyLoXC8tLv9Ce7QA9PBKHVI0uRQj7SkfRqRpfETOwtHldnH6my3+sG+7XWYomWLgxm7/xiRB9O10NYAkXrfxPW1AyoavE8jCPYcCFjW/r2vp4wGqBt3LvyAu1K5Ni3xs9k9DwcnrOESZGjcjgZOU5fn7+B1VezBUsmPfY/SO75m7OXr95evCIwVEgjYUezxWwRHkba+YaryU17D+r7XW27G8X+lNd33+Q93vm5kVyE8SrYu+1Ho+H9yBKW7h7ey4TV2nna3m4p9z5Y2XW0/FOLloavZcJW3AqeUfu+3rJCOPpcjC/rz9r55fv+8foCHn3DP4p5mFYUjSorLtvwjkzYLW72fjHoll0yDCwEK+6/jJcfXpKWnfyD2Zcmrihxmudo/JNnp8Pm+YdLlrCsf/834RcGZvmafpLg6whVBy7CKBbWtkxyVbW8orNRJY1YVKX357PbMJ/1H8ioR8nYH9yiFfSXbHpUYLuNs1/Xjefj1mclel6H0+SZZdd1/wbGM271",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,j={},u=[];function h(e){const t={p:"p",...(0,n.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(v.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)(v.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,a.jsx)(p(),{parameters:[{name:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"bK1cfd2hpb"}}]}),"\n",(0,a.jsx)(c(),{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"}}}}}),"\n",(0,a.jsx)(f(),{id:void 0,label:void 0,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"}}}}}})]})}function W(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(h,{...e})}):h(e)}}}]); \ No newline at end of file diff --git a/assets/js/c195e1f1.5e9d7258.js b/assets/js/c195e1f1.42e352ca.js similarity index 64% rename from assets/js/c195e1f1.5e9d7258.js rename to assets/js/c195e1f1.42e352ca.js index 13f07f82d..ef563b875 100644 --- a/assets/js/c195e1f1.5e9d7258.js +++ b/assets/js/c195e1f1.42e352ca.js @@ -1 +1 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6192],{19115:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>f,contentTitle:()=>g,default:()=>j,frontMatter:()=>x,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":"eJztW1FvGzmS/ivcfklitCXZSWZnjVywniQ7Y2wwMRJng4VlaKjukpoJm+wl2ZI1hoB92H+wT/e6P21+yaGK7G62LFt2ZoDdu/NgMGOxyapisapY/Iq8Shyf2+ToPHmts7oE5WxykSY52MyIygmtkqPkrAD2ygB3wJpebGZ0yRyUlcTm49MTxqXUS8tWumZOszkoMPhJwZLlDW02XbHPtXWsMnohcqHmLY2JyJlQ1gHPmZ6xupKaUwdOJGZCwmOhmCuAzbQpsc+UW/jmGdOGTYXiZvWEwQLMijlRAsmhAHIUJvPC81aQATsLbC1SYwYq7JHLFast5MTNsowrNoUwOvdTri0YJpQDM+MZMO7Y+d7ea5jWc/bxZG/v4nHhXGWPhkNeVQNdgbJiriSf2kGmy2GOHat89gSFri3Nv1PuWaTOwViN1V91TUJ4bQHLYcZr6diCy5rUgEpnS5HPAXXLUXRNOhKGKV5C77utq0obx+Ayg8oxFIy72kDKrONllTKhhBNc2pSJks9hMFYHA7a3ByUXcm9vrH766aexuhorxsYJUh8nR2yc0Odxkvp2AzzXSq7w24xLC6E9iB4N+SNc8rKSgIoZJ2O1DgzG6hC5IoObmfq/7sPzs4Y+l6fI5bOesjPh5C2ssIvDLvfjl4Hu83uG/DJdVlytbuYWOtxTn16TrFo4Jl3e5/sc+ebc3TJF/Ho/jgcH+6Pn+4ejw+d9Zt8gMweXbqovb+YXOtyPZbliOK7P7/ek1AKyL7cybHrch+P5ONEUAfcPx8lFx3Qf1em7He3tscZHC74AphWgZ5faAHMFV9TgvdUV3FFAshiRpsAsSMgwrkxXjWOT039L62V0leulumXNQo/7KdHP6KCvxD8gR8Nzodm0dk7fwpV6/QYs9/ZODcyElOyTj06oyqapCVjcAAMJfucg/WGLUBYM6k0op6OYzqYwQ70Lx4RltuAGcrYUrmCcovaAvVNyRfG2HUKhXRtWcMsqMKWwVmAA1YznOXYtaUlwyQ3YSisLXlAfj5FWtLq20LXMcTORuDfgV7gU1mGYb4YP/OzfCutwC9uIzTSrRg+4Cge7/WmbO3le9JGr3MCSTaEX/g7vGhSuUWTjZPRsePB8eDg6fBaTfPrVrtjRPh8nJadIy8bJDPzfke89u6elhl5beTWsOuoUKWnru5ksfd6uafGX7969X47+/P1cHx8fH//44WPx5uP8+Pi4xN+DwSDwCqS/+Wo/j+fQKKmbRZImusLcS2h1kidHSchfgs2jRzQ5l8iTNKm44SU4MJgGXhHn5CiJ0rIkTQSmgRV3RbKZG+rpZ8jcCeVsTf6SpImBv9XCQJ4cOVNDmli3kkjWCtyokjSBy0rqHJIjHzcSmxVQ8uToKnGrino6I9Q8SRPM9riLW8J2hyL9cDAtssOimibr9YVnC9Z9p/MVksq0cqAc/smrSoqMlDL8bFH0q4hnJ+55gnkRKuMibUTxc0RVGdSsE2BJUEwK7ivxj1E67NOKayo9VszHTC5ZuzjMVpCJ2apJGWkopYD4S8FSrtpEtctyT2ZMl8I5yFM/KqzQL3//bxtILDHiTsHnvb2tKFmnrTK6WXJj+ApNwkEZt9+gJKO366jTyHGW6doprhwypNTwVqVSh5jAZw1xLolUvBHfxvWzBoyJ2LkqtNrR++DwKf779AD7h5j99TrZLV2I6BPi1+yy0ZCp1hK4iseQH63TZu+9nX7Ipab6Mlmv08aSNyJFFAImH7wdTJq5r+81jJjMtMzBYES6TTIyOlD5ZNMQuilvHk6FjdykfwoNTsOWBbgCDDUvuXKMqHeZGPqiZsHYBwwPvP2zlrCYtpoaxgl5Vbfza/zREyHqy7jKmdLsEfGb2JoM4tEw/J7qfPWoG+kzHi+zQD8OIlDn1ndtz2UH454VINvGixp22xTe1+Gr2jpdMmITBlFoaY+ILATWAXvFFRMqk3VIf2YaFY5RiV1dNSYwIctYr9nVFa4lmAma/Hqddg3Iq9dAXuhbDGQgFr1RbRN0A9u2aChcVsKsJpi7+IZwnooFEHMl1HxSm0BHaew86JnhhuCUIAYdQN5al5irLbNuwxit7521f03ZYd2RyP8bvb+oXv4gtojyYli9fFG9/ASs0BV4j/PqmQmVe39fgpQD9sI6o9X85YYKXgxD+/alNLAQsCR3pVXtqGzqtiU0CDL9VdexpwjLMlNngkukWxmdQXMO8Tv1pWPWQWUZt3hWIbXMBNAcDONzA3TiIVl47QptxM+UtzQMX3BWGJj916MNnT56ieGWFWDgxZC/DL1PZjRHOp5ytWI0caGVxYMqAWSz2lBwzCQ3YhaSpJRVErgFhjkUzxwJ7zXayHFWcPXFpi+m5uUZ8JK9q0ChBL/841/Yo4nkJ+qdycHcIZSfzJgFisSPMI49SpluTmwzYawLAdrHv2AhXq4bXCcAWnI1YG/agG/rqcVeqqHXBVRnxHwOeG4MPWhw6lcPeFb4rYKk4jOM9ci9QuPRtW3EQwND85eABubBuLBQA/Zdm2GlLNIOHVnjuQ+2RHXENc/0q0D6NV/FuYaqyymYazolLBQh0DCK5XxlkRvle/iBy6wm1NH7MEMfxl2NzLGx/jgBazm18h08x5Cn+FTCu7PTO6w0Tojtezf2ua5fA0+DvTs7ZQvojHHAPtp2nZqF570uLNM5sIXgfulTtixERi63YiUizqBovULUjlGAgccu2D67LlAu7FaJUp9oYPytSbRthFkuDGROrsiAdO0QVRAhs6cYMNiWwXklnOn6Lj6zQ5OczWuR00rXpt3Twdg0guARdjd15qNCXpvmjBGM1gcxazs9NVrBThH9lIGyfjhnM24dmJTVitByU1foDQ1JuKzACFAZbFVBFLp375+YrRHYrX1eVoGxWmF402bOVYieCIwvC20x7S+49F1DmLBsCigVend/P2oQ/F/+8a+kk+vGQ8p1wTwHnucGrN0hIYFI3pwQUUQcacWc7kuE9MD8cbO0gNKRSU5Knbdmau9uQacIfznbxsSAgbX4m62zAresNtbauGBAFQSb4pTwYEFVCF3hfFsErIG6xE3e9x5Qj1kkA1Vc0GfQotQqdp8OF9Qb5OhAIKxvjZP4rZaGlZ7dK4kgb8lXbSEGaYfqEyiMPDk7ff0nKhv5bGILAoiHzCiK+uHXzj68dnpioBTqbnvmB79p0CI63bp97XTJnchYQ8oOWOjq1e107MUle9yoCr1jIbR5slVdntxEqwwmQk2o3rZ7E/qRmtEaaPeZglsCqFi2ZtH81uqxGpRtWYBiPZ1EOyVOuiclbkOVB0+3ncKvr2lcXGvs028c+AXKKWIiHlZG16fA2JwTrx3rfzUu4L/ussVj9HLIvU1btn+tkDfYAUG1J3/E/uawe/kwjmFPpsI6qm53DWprsG9eVcDNAKMYwx3n64qjvbSkPWoPdiQh6zS53D2ZS5bpfW1yoZD4Ywkzx+qqwvxXGwXmiY86foL/OZMbjdZpcgdXW/2vnN5TnN1y9+w+idwVXd3k3yLrM5S12C3rDyDmhfs3C/stCuvzwt8SmPSwpK9D7MRZsXOmpTa390T4nWBC5az4eWtY6tzhcO3/6UDIJu7fDExOYmSSoBki0C9VRBMjlRyORvi//tK+7tUPMa2tM8yQZ7WUq98l6d0LD7evR1NcuW+RofgsDn++zBaHpw2GXxv59fvSbkx+G8S8ccUDJelLcbepBOeojdx3eh/nst/mekQ2Wm+hpFAwaRZwkuts0swe+5VgbX/Hu5MM7XLT6b+/1jvYJ95In22zogiZUY/obNhVvgMOhUkw5svNxSCEbLRrU5amC5eaEmyPMQnDsOpCI8nMfzN7BGO2e/Ft2jv1OJIFV1fdTDzhXRp8NhpNsk6Jz7coUS24FDndQDvTX0D9hu5343S7ycXsnWePol6WsounifCd6HvSm23c7idpIauNcCuqxV7u80rs++9H5xdY4SzBFRqrupW2JDEWZY+SYT/UDa+iWLdOkKxZNBVe8sLWsSxX+VRfXt95eCWGi4MBlqA2x2zdqW7pD/X+fYdYx+dCzXeNu+g09gFX1S9cT29d1KvEnwG9ISxL3CuUuAvgeOzChUBjed+Vk980S97WfbeXctuC6XlT+4wLnG1981rRspWqKUy2dcmo+BjVHuNKfVMrjEuFoazeVgN7JT+ypK4elyT9mpsv2W/UkH5dSaRfEXmA+f8PwfwbKL83nm1Q9cHzHkgcLDRGO5u7IDH614PgNhG4G9GwG8CwwMCDPmj2G3BL+L4d5XjeAxdiTwwBpvGv5lx9QAfSg9GITm5PR3TEeTai08O3o15e3vflJM6uKYVuM2hKk+MsGVPhCwxYQs10HJ6adaK9iaLltdMUyEz78gAue7SwNKZxCQ9OIoXf4eWld7VhlV6CmdWSrHcm4VIgWIODoKRvXQUeeCnBWrmiW9NzuhOei7lwiIEHNDjjFZ8KKXDj9df6vJN0e7cdsE9dDf+RocvcsACJ+3ULd6l5F5CX2nyZ4V2AlHE2xbvWCMCCKrjKPNbrtw3CLBHsQZS6MgJTFWdQauFl08oZ9IySKz4nn017qspBYgizzOgpFhqslrX3PMeF1MaXWWhCdP2TbgC+wetPxh8HsTRjoEALXgQ83aa+nmFpg8ApKASi6OI8z5zIgIDPWkmdffEFslpKVmnni1Z46oxlxOHOcGXp6ryv7IQ1aBUWUH6w4YriRwu4wm+F+oK3M/EW5HlrU59gaoWD7vC6XC6v7dNP+mO+F+6HesreQ6WtcNqsutFz4Yp6Snt7TKT94Sl937wpiHbujkauM7vl/KwzOyxAVsMP4NBC7PD49IQyxSfsl7//k70FbhQr9NJba1YbkKvu+QJqzq+8V1ub6Pnr97UrUOMZD5c8Kew2GvxUcEc3rTBTEN6FvCL39k7rqRRZ9wxhb++oeQbQXfSggkB4hRAutGKFi7PKj5ZCfRmwY7XyzxLa3QfbaVxvGrTjRU8xoucCLc/4YQTiwhbkwr+EwHPHFBjkwlc1ja7nnlssTJhc/24vzu04z1m1cb8XMehOHA+zUsGOe7zVDbZeCe7dle3fhQCVV1ooZ49YbvjMdfTTjUu/tPdda2ruCzfqSAOZdkm8J4YZt63+Es5G1tmPtQZmQOVU23sdwysRzOm8MUuG1vprzNrjLbSdR6d3TH+3Vo0cmNK+m30AsxBZc+S+waOH1HmYpIkUGQTwJ+xdx9+fvmWLp4NRkka5/B2ce/j25NWbHz+8QWEwkHqFHQxGgxFh1Nq6kquI09a3SNHl057mo1ugDw+ZHh4yPTxkenjI9PCQ6eEh08NDpoeHTA8Pmf7THzJFwMqwklyoqIrkke/zjSJfkiZH8dulizQpECk/Ok+urjCx+IgYGjb/rSZU5/wiTRbcCEShCMwJ12LyCEO9IZ18/D6UDp+wG55BbZW/gaMVYtHkdR6L+gKrjYdX6wssNXtMGkXzPV55AfbPkE5H4VqlA0F1P+I4w0Tp1r5xaeH03YezJE2a2+slvdNKDF8iLsWXXtoIvKK2q0RyNa8J+Eo8zbW/z1T0MfgvhMGHPyL0rK+PPjjvp4H/xUltHXB15fF9Apt9f//pxhFBsU1vXJyL9Xr9P16p0kI=","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(33617),a=n.n(o),l=n(17543),d=n.n(l),p=n(86013),c=n.n(p),m=n(63723),u=n.n(m),h=(n(18766),n(79329),n(9303));const x={id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztW1FvGzmS/ivcfklitCXZSWZnjVywniQ7Y2wwMRJng4VlaKjukpoJm+wl2ZI1hoB92H+wT/e6P21+yaGK7G62LFt2ZoDdu/NgMGOxyapisapY/Iq8Shyf2+ToPHmts7oE5WxykSY52MyIygmtkqPkrAD2ygB3wJpebGZ0yRyUlcTm49MTxqXUS8tWumZOszkoMPhJwZLlDW02XbHPtXWsMnohcqHmLY2JyJlQ1gHPmZ6xupKaUwdOJGZCwmOhmCuAzbQpsc+UW/jmGdOGTYXiZvWEwQLMijlRAsmhAHIUJvPC81aQATsLbC1SYwYq7JHLFast5MTNsowrNoUwOvdTri0YJpQDM+MZMO7Y+d7ea5jWc/bxZG/v4nHhXGWPhkNeVQNdgbJiriSf2kGmy2GOHat89gSFri3Nv1PuWaTOwViN1V91TUJ4bQHLYcZr6diCy5rUgEpnS5HPAXXLUXRNOhKGKV5C77utq0obx+Ayg8oxFIy72kDKrONllTKhhBNc2pSJks9hMFYHA7a3ByUXcm9vrH766aexuhorxsYJUh8nR2yc0Odxkvp2AzzXSq7w24xLC6E9iB4N+SNc8rKSgIoZJ2O1DgzG6hC5IoObmfq/7sPzs4Y+l6fI5bOesjPh5C2ssIvDLvfjl4Hu83uG/DJdVlytbuYWOtxTn16TrFo4Jl3e5/sc+ebc3TJF/Ho/jgcH+6Pn+4ejw+d9Zt8gMweXbqovb+YXOtyPZbliOK7P7/ek1AKyL7cybHrch+P5ONEUAfcPx8lFx3Qf1em7He3tscZHC74AphWgZ5faAHMFV9TgvdUV3FFAshiRpsAsSMgwrkxXjWOT039L62V0leulumXNQo/7KdHP6KCvxD8gR8Nzodm0dk7fwpV6/QYs9/ZODcyElOyTj06oyqapCVjcAAMJfucg/WGLUBYM6k0op6OYzqYwQ70Lx4RltuAGcrYUrmCcovaAvVNyRfG2HUKhXRtWcMsqMKWwVmAA1YznOXYtaUlwyQ3YSisLXlAfj5FWtLq20LXMcTORuDfgV7gU1mGYb4YP/OzfCutwC9uIzTSrRg+4Cge7/WmbO3le9JGr3MCSTaEX/g7vGhSuUWTjZPRsePB8eDg6fBaTfPrVrtjRPh8nJadIy8bJDPzfke89u6elhl5beTWsOuoUKWnru5ksfd6uafGX7969X47+/P1cHx8fH//44WPx5uP8+Pi4xN+DwSDwCqS/+Wo/j+fQKKmbRZImusLcS2h1kidHSchfgs2jRzQ5l8iTNKm44SU4MJgGXhHn5CiJ0rIkTQSmgRV3RbKZG+rpZ8jcCeVsTf6SpImBv9XCQJ4cOVNDmli3kkjWCtyokjSBy0rqHJIjHzcSmxVQ8uToKnGrino6I9Q8SRPM9riLW8J2hyL9cDAtssOimibr9YVnC9Z9p/MVksq0cqAc/smrSoqMlDL8bFH0q4hnJ+55gnkRKuMibUTxc0RVGdSsE2BJUEwK7ivxj1E67NOKayo9VszHTC5ZuzjMVpCJ2apJGWkopYD4S8FSrtpEtctyT2ZMl8I5yFM/KqzQL3//bxtILDHiTsHnvb2tKFmnrTK6WXJj+ApNwkEZt9+gJKO366jTyHGW6doprhwypNTwVqVSh5jAZw1xLolUvBHfxvWzBoyJ2LkqtNrR++DwKf779AD7h5j99TrZLV2I6BPi1+yy0ZCp1hK4iseQH63TZu+9nX7Ipab6Mlmv08aSNyJFFAImH7wdTJq5r+81jJjMtMzBYES6TTIyOlD5ZNMQuilvHk6FjdykfwoNTsOWBbgCDDUvuXKMqHeZGPqiZsHYBwwPvP2zlrCYtpoaxgl5Vbfza/zREyHqy7jKmdLsEfGb2JoM4tEw/J7qfPWoG+kzHi+zQD8OIlDn1ndtz2UH454VINvGixp22xTe1+Gr2jpdMmITBlFoaY+ILATWAXvFFRMqk3VIf2YaFY5RiV1dNSYwIctYr9nVFa4lmAma/Hqddg3Iq9dAXuhbDGQgFr1RbRN0A9u2aChcVsKsJpi7+IZwnooFEHMl1HxSm0BHaew86JnhhuCUIAYdQN5al5irLbNuwxit7521f03ZYd2RyP8bvb+oXv4gtojyYli9fFG9/ASs0BV4j/PqmQmVe39fgpQD9sI6o9X85YYKXgxD+/alNLAQsCR3pVXtqGzqtiU0CDL9VdexpwjLMlNngkukWxmdQXMO8Tv1pWPWQWUZt3hWIbXMBNAcDONzA3TiIVl47QptxM+UtzQMX3BWGJj916MNnT56ieGWFWDgxZC/DL1PZjRHOp5ytWI0caGVxYMqAWSz2lBwzCQ3YhaSpJRVErgFhjkUzxwJ7zXayHFWcPXFpi+m5uUZ8JK9q0ChBL/841/Yo4nkJ+qdycHcIZSfzJgFisSPMI49SpluTmwzYawLAdrHv2AhXq4bXCcAWnI1YG/agG/rqcVeqqHXBVRnxHwOeG4MPWhw6lcPeFb4rYKk4jOM9ci9QuPRtW3EQwND85eABubBuLBQA/Zdm2GlLNIOHVnjuQ+2RHXENc/0q0D6NV/FuYaqyymYazolLBQh0DCK5XxlkRvle/iBy6wm1NH7MEMfxl2NzLGx/jgBazm18h08x5Cn+FTCu7PTO6w0Tojtezf2ua5fA0+DvTs7ZQvojHHAPtp2nZqF570uLNM5sIXgfulTtixERi63YiUizqBovULUjlGAgccu2D67LlAu7FaJUp9oYPytSbRthFkuDGROrsiAdO0QVRAhs6cYMNiWwXklnOn6Lj6zQ5OczWuR00rXpt3Twdg0guARdjd15qNCXpvmjBGM1gcxazs9NVrBThH9lIGyfjhnM24dmJTVitByU1foDQ1JuKzACFAZbFVBFLp375+YrRHYrX1eVoGxWmF402bOVYieCIwvC20x7S+49F1DmLBsCigVend/P2oQ/F/+8a+kk+vGQ8p1wTwHnucGrN0hIYFI3pwQUUQcacWc7kuE9MD8cbO0gNKRSU5Knbdmau9uQacIfznbxsSAgbX4m62zAresNtbauGBAFQSb4pTwYEFVCF3hfFsErIG6xE3e9x5Qj1kkA1Vc0GfQotQqdp8OF9Qb5OhAIKxvjZP4rZaGlZ7dK4kgb8lXbSEGaYfqEyiMPDk7ff0nKhv5bGILAoiHzCiK+uHXzj68dnpioBTqbnvmB79p0CI63bp97XTJnchYQ8oOWOjq1e107MUle9yoCr1jIbR5slVdntxEqwwmQk2o3rZ7E/qRmtEaaPeZglsCqFi2ZtH81uqxGpRtWYBiPZ1EOyVOuiclbkOVB0+3ncKvr2lcXGvs028c+AXKKWIiHlZG16fA2JwTrx3rfzUu4L/ussVj9HLIvU1btn+tkDfYAUG1J3/E/uawe/kwjmFPpsI6qm53DWprsG9eVcDNAKMYwx3n64qjvbSkPWoPdiQh6zS53D2ZS5bpfW1yoZD4Ywkzx+qqwvxXGwXmiY86foL/OZMbjdZpcgdXW/2vnN5TnN1y9+w+idwVXd3k3yLrM5S12C3rDyDmhfs3C/stCuvzwt8SmPSwpK9D7MRZsXOmpTa390T4nWBC5az4eWtY6tzhcO3/6UDIJu7fDExOYmSSoBki0C9VRBMjlRyORvi//tK+7tUPMa2tM8yQZ7WUq98l6d0LD7evR1NcuW+RofgsDn++zBaHpw2GXxv59fvSbkx+G8S8ccUDJelLcbepBOeojdx3eh/nst/mekQ2Wm+hpFAwaRZwkuts0swe+5VgbX/Hu5MM7XLT6b+/1jvYJ95In22zogiZUY/obNhVvgMOhUkw5svNxSCEbLRrU5amC5eaEmyPMQnDsOpCI8nMfzN7BGO2e/Ft2jv1OJIFV1fdTDzhXRp8NhpNsk6Jz7coUS24FDndQDvTX0D9hu5343S7ycXsnWePol6WsounifCd6HvSm23c7idpIauNcCuqxV7u80rs++9H5xdY4SzBFRqrupW2JDEWZY+SYT/UDa+iWLdOkKxZNBVe8sLWsSxX+VRfXt95eCWGi4MBlqA2x2zdqW7pD/X+fYdYx+dCzXeNu+g09gFX1S9cT29d1KvEnwG9ISxL3CuUuAvgeOzChUBjed+Vk980S97WfbeXctuC6XlT+4wLnG1981rRspWqKUy2dcmo+BjVHuNKfVMrjEuFoazeVgN7JT+ypK4elyT9mpsv2W/UkH5dSaRfEXmA+f8PwfwbKL83nm1Q9cHzHkgcLDRGO5u7IDH614PgNhG4G9GwG8CwwMCDPmj2G3BL+L4d5XjeAxdiTwwBpvGv5lx9QAfSg9GITm5PR3TEeTai08O3o15e3vflJM6uKYVuM2hKk+MsGVPhCwxYQs10HJ6adaK9iaLltdMUyEz78gAue7SwNKZxCQ9OIoXf4eWld7VhlV6CmdWSrHcm4VIgWIODoKRvXQUeeCnBWrmiW9NzuhOei7lwiIEHNDjjFZ8KKXDj9df6vJN0e7cdsE9dDf+RocvcsACJ+3ULd6l5F5CX2nyZ4V2AlHE2xbvWCMCCKrjKPNbrtw3CLBHsQZS6MgJTFWdQauFl08oZ9IySKz4nn017qspBYgizzOgpFhqslrX3PMeF1MaXWWhCdP2TbgC+wetPxh8HsTRjoEALXgQ83aa+nmFpg8ApKASi6OI8z5zIgIDPWkmdffEFslpKVmnni1Z46oxlxOHOcGXp6ryv7IQ1aBUWUH6w4YriRwu4wm+F+oK3M/EW5HlrU59gaoWD7vC6XC6v7dNP+mO+F+6HesreQ6WtcNqsutFz4Yp6Snt7TKT94Sl937wpiHbujkauM7vl/KwzOyxAVsMP4NBC7PD49IQyxSfsl7//k70FbhQr9NJba1YbkKvu+QJqzq+8V1ub6Pnr97UrUOMZD5c8Kew2GvxUcEc3rTBTEN6FvCL39k7rqRRZ9wxhb++oeQbQXfSggkB4hRAutGKFi7PKj5ZCfRmwY7XyzxLa3QfbaVxvGrTjRU8xoucCLc/4YQTiwhbkwr+EwHPHFBjkwlc1ja7nnlssTJhc/24vzu04z1m1cb8XMehOHA+zUsGOe7zVDbZeCe7dle3fhQCVV1ooZ49YbvjMdfTTjUu/tPdda2ruCzfqSAOZdkm8J4YZt63+Es5G1tmPtQZmQOVU23sdwysRzOm8MUuG1vprzNrjLbSdR6d3TH+3Vo0cmNK+m30AsxBZc+S+waOH1HmYpIkUGQTwJ+xdx9+fvmWLp4NRkka5/B2ce/j25NWbHz+8QWEwkHqFHQxGgxFh1Nq6kquI09a3SNHl057mo1ugDw+ZHh4yPTxkenjI9PCQ6eEh08NDpoeHTA8Pmf7THzJFwMqwklyoqIrkke/zjSJfkiZH8dulizQpECk/Ok+urjCx+IgYGjb/rSZU5/wiTRbcCEShCMwJ12LyCEO9IZ18/D6UDp+wG55BbZW/gaMVYtHkdR6L+gKrjYdX6wssNXtMGkXzPV55AfbPkE5H4VqlA0F1P+I4w0Tp1r5xaeH03YezJE2a2+slvdNKDF8iLsWXXtoIvKK2q0RyNa8J+Eo8zbW/z1T0MfgvhMGHPyL0rK+PPjjvp4H/xUltHXB15fF9Apt9f//pxhFBsU1vXJyL9Xr9P16p0kI=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},g=void 0,f={},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)(h.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.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}\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}\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}\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}\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}\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}\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.p,{children:[(0,i.jsx)(t.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document before it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"response:"})," Provide the value that should replace the existing response."]}),"\n"]}),"\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.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.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.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(d(),{parameters:[{name:"template_id",in:"path",description:"objectId of Template",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}]}),"\n",(0,i.jsx)(c(),{title:"Body",body:{content:{"application/json":{schema:{required:["signers"],type:"object",properties:{title:{type:"string",format:"string",example:"New document title",description:"An optional parameter specifying the title for the newly created document. If omitted, the template\u2019s title will be used by default.\n"},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"Accoutnant"},email:{type:"string",format:"mail",example:"joe@example.com"},name:{type:"string",example:"joe bee"},phone:{type:"string",example:"123123131"},widgets:{type:"array",items:{type:"object",properties:{name:{type:"string",example:"textbox_1"},readonly:{type:"boolean",example:!1},default:{type:"string",example:"my textbox"}},title:"createdocumenttemplate_id_Signers_widgets"}}},title:"createdocumenttemplate_id_Signers"}},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used.\n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"{{sender_name}} has requested you to sign {{document_title}}"},email_body:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"

Hi {{receiver_name}},

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

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

Sign here

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

Thanks,
Team OpenSign\u2122

"},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},file:{type:"string",description:"You may provide the base64 encoded PDF file to replace the existing one",format:"base64",example:""},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5},prefill:{type:"object",description:"You can provide widgets which can embed before sending to signer",properties:{widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"textbox"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:100},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},title:"createdocument_template_id_body"}}},required:!0}}),"\n",(0,i.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"hji2zxcv2P"},signurl:{type:"array",items:{type:"object",properties:{email:{type:"string",format:"string",example:"mail@example.com"},url:{type:"string",format:"string",example:"https://url-to-sign-document.com"}},title:"inline_response_doc_signurl"}},message:{type:"string",format:"string",example:"Document sent successfully!"}},title:"inline_response_doc"}}}},400:{description:"If you haven't add widgets and signers in template or not provide signers along with their roles in body",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Please setup template properly!"}},title:"inline_response_400_cc"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6192],{19115:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>g,contentTitle:()=>b,default:()=>y,frontMatter:()=>x,metadata:()=>r,toc:()=>f});const r=JSON.parse('{"id":"API-docs/v1.1/createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","source":"@site/docs/API-docs/v1.1/createdocumentwithtemplateid.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/createdocumentwithtemplateid","permalink":"/docs/API-docs/v1.1/createdocumentwithtemplateid","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","sidebar_label":"Create Document from Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztW1FvGzmS/iu8fklitCXZSeZmjVywniQ3Y2wwMRLngoVlaKjukpoJm+wl2ZI1hoB92H+wT/u6P21+yaKK7G62LFt2ZoDd2/VgMGOxyapisapY/Iq8Shyf2+ToPHmts7oE5WxykSY52MyIygmtkqPkrAD2ygB3wJpebGZ0yRyUlcTm49MTxqXUS8tWumZOszkoMPhJwZLlDW02XbHPtXWsMnohcqHmLY2JyJlQ1gHPmZ6xupKaUwdOJGZCwmOhmCuAzbQpsc+UW/jmGdOGTYXiZvWEwQLMijlRAsmhAHIUJvPC81aQATsLbC1SYwYq7JHLFast5MTNsowrNoUwOvdTri0YJpQDM+MZMO7Y+d7ea5jWc/bxZG/v4nHhXGWPhkNeVQNdgbJiriSf2kGmy2GOHat89gSFri3Nv1PuWaTOwViN1R91TUJ4bQHLYcZr6diCy5rUgEpnS5HPAXXLUXRNOhKGKV5C77utq0obx+Ayg8oxFIy72kDKrONllTKhhBNc2pSJks9hMFYHA7a3ByUXcm9vrH766aexuhorxsYJUh8nR2yc0Odxkvp2AzzXSq7w24xLC6E9iB4N+T1c8rKSgIoZJ2O1DgzG6hC5IoObmfq/7sPzs4Y+l6fI5bOesjPh5C2ssIvDLvfjl4Hu83uG/DJdVlytbuYWOtxTn16TrFo4Jl3e5/sc+ebc3TJF/Ho/jgcH+6Pn+4ejw+d9Zt8gMweXbqovb+YXOtyPZbliOK7P779JqQVkX25l2PS4D8fzcaIpAu4fjpOLjuk+qtN3O9rbY42PFnwBTCtAzy61AeYKrqjBe6sruKOAZDEiTYFZkJBhXJmuGscmp/+W1svoKtdLdcuahR73U6Kf0UFfib9DjobnQrNp7Zy+hSv1+g1Y7u2dGpgJKdknH51QlU1TE7C4AQYS/M5B+sMWoSwY1JtQTkcxnU1hhnoXjgnLbMEN5GwpXME4Re0Be6fkiuJtO4RCuzas4JZVYEphrcAAqhnPc+xa0pLgkhuwlVYWvKA+HiOtaHVtoWuZ42YicW/Ar3AprMMw3wwf+Nm/FdbhFrYRm2lWjR5wFQ52+9M2d/K86CNXuYElm0Iv/B3eNShco8jGyejZ8OD58HB0+Cwm+fSrXbGjfT5OSk6Rlo2TGfi/I997dk9LDb228mpYddQpUtLWdzNZ+rxd0+L/vnv3fjn6w/dzfXx8fPzjh4/Fm4/z4+PjEn8PBoPAK5D+5qv9PJ5Do6RuFkma6ApzL6HVSZ4cJSF/CTaPHtHkXCJP0qTihpfgwGAaeEWck6MkSsuSNBGYBlbcFclmbqinnyFzJ5SzNflLkiYG/lQLA3ly5EwNaWLdSiJZK3CjStIELiupc0iOfNxIbFZAyZOjq8StKurpjFDzJE0w2+MubgnbHYr0w8G0yA6Lapqs1xeeLVj3nc5XSCrTyoFy+CevKikyUsrws0XRryKenbjnCeZFqIyLtBHFzxFVZVCzToAlQTEpuK/EP0bpsE8rrqn0WDEfM7lk7eIwW0EmZqsmZaShlALiLwVLuWoT1S7LPZkxXQrnIE/9qLBCv/z5bzaQWGLEnYLPe3tbUbJOW2V0s+TG8BWahIMybr9BSUZv11GnkeMs07VTXDlkSKnhrUqlDjGBzxriXBKpeCO+jetnDRgTsXNVaLWj98HhU/z36QH2DzH763WyW7oQ0SfEr9lloyFTrSVwFY8hP1qnzd57O/2QS031ZbJep40lb0SKKARMPng7mDRzX99rGDGZaZmDwYh0m2RkdKDyyaYhdFPePJwKG7lJ/xQanIYtC3AFGGpecuUYUe8yMfRFzYKxDxgeePtnLWExbTU1jBPyqm7n1/ijJ0LUl3GVM6XZI+I3sTUZxKNh+D3V+epRN9JnPF5mgX4cRKDOre/anssOxj0rQLaNFzXstim8r8NXtXW6ZMQmDKLQ0h4RWQisA/aKKyZUJuuQ/sw0KhyjEru6akxgQpaxXrOrK1xLMBM0+fU67RqQV6+BvNC3GMhALHqj2iboBrZt0VC4rIRZTTB38Q3hPBULIOZKqPmkNoGO0th50DPDDcEpQQw6gLy1LjFXW2bdhjFa3ztr/5qyw7ojkf8Yvb+oXv4gtojyYli9fFG9/ASs0BV4j/PqmQmVe39fgpQD9sI6o9X85YYKXgxD+/alNLAQsCR3pVXtqGzqtiU0CDL9UdexpwjLMlNngkukWxmdQXMO8Tv1pWPWQWUZt3hWIbXMBNAcDONzA3TiIVl47QptxM+UtzQMX3BWGJj9z6MNnT56ieGWFWDgxZC/DL1PZjRHOp5ytWI0caGVxYMqAWSz2lBwzCQ3YhaSpJRVErgFhjkUzxwJ7zXayHFWcPXFpi+m5uUZ8JK9q0ChBL/85e/Yo4nkJ+qdycHcIZSfzJgFisSPMI49SpluTmwzYawLAdrHv2AhXq4bXCcAWnI1YG/agG/rqcVeqqHXBVRnxHwOeG4MPWhw6lcPeFb4rYKk4jOM9ci9QuPRtW3EQwND85eABubBuLBQA/Zdm2GlLNIOHVnjuQ+2RHXENc/0q0D6NV/FuYaqyymYazolLBQh0DCK5XxlkRvle/iBy6wm1NH7MEMfxl2NzLGx/jgBazm18h08x5Cn+FTCu7PTO6w0Tojtezf2ua5fA0+DvTs7ZQvojHHAPtp2nZqF570uLNM5sIXgfulTtixERi63YiUizqBovULUjlGAgccu2D67LlAu7FaJUp9oYPytSbRthFkuDGROrsiAdO0QVRAhs6cYMNiWwXklnOn6Lj6zQ5OczWuR00rXpt3Twdg0guARdjd15qNCXpvmjBGM1gcxazs9NVrBThH9lIGyfjhnM24dmJTVitByU1foDQ1JuKzACFAZbFVBFLp375+YrRHYrX1eVoGxWmF402bOVYieCIwvC20x7S+49F1DmLBsCigVend/P2oQ/F/+8vekk+vGQ8p1wTwHnucGrN0hIYFI3pwQUUQcacWc7kuE9MD8frO0gNKRSU5Knbdmau9uQacIfznbxsSAgbX4m62zAresNtbauGBAFQSb4pTwYEFVCF3hfFsErIG6xE3e9x5Qj1kkA1Vc0GfQotQqdp8OF9Qb5OhAIKxvjZP4rZaGlZ7dK4kgb8lXbSEGaYfqEyiMPDk7ff2/VDby2cQWBBAPmVEU9cOvnX147fTEQCnU3fbMD37ToEV0unX72umSO5GxhpQdsNDVq9vp2ItL9rhRFXrHQmjzZKu6PLmJVhlMhJpQvW33JvQjNaM10O4zBbcEULFszaL5rdVjNSjbsgDFejqJdkqcdE9K3IYqD55uO4VfX9O4uNbYp9848AuUU8REPKyMrk+BsTknXjvW/2pcwH/dZYvH6OWQe5u2bP9aIW+wA4JqT/6I/c1h9/JhHMOeTIV1VN3uGtTWYN+8qoCbAUYxhjvO1xVHe2lJe9Qe7EhC1mlyuXsylyzT+9rkQiHxxxJmjtVVhfmvNgrMEx91/AT/dSY3Gq3T5A6utvp/Ob2nOLvl7tl9ErkrurrJP0XWZyhrsVvWH0DMC/dPFvZbFNbnhb8lMOlhSV+H2ImzYudMS21u74nwO8GEylnx89aw1LnD4dr/04GQTdy/GZicxMgkQTNEoF+qiCZGKjkcjfB//aV93asfYlpbZ5ghz2opV/+VpHcvPNy+Hk1x5b5FhuKzOPz5MlscnjYYfm3k1+9LuzH5bRDzxhUPlKQvxd2mEpyjNnLf6X2cy36b6xHZaL2FkkLBpFnASa6zSTN77FeCtf0d704ytMtNp//+Wu9gn3gjfbbNiiJkRj2is2FX+Q44FCbBmC83F4MQstGuTVmaLlxqSrA9xiQMw6oLjSQz/83sEYzZ7sW3ae/U40gWXF11M/GEd2nw2Wg0yTolPt+iRLXgUuR0A+1MfwH1G7rfjdPtJhezd549inpZyi6eJsJ3ou9Jb7Zxu5+khaw2wq2oFnu5zyux778fnV9ghbMEV2is6lbaksRYlD1Khv1QN7yKYt06QbJm0VR4yQtbx7Jc5VN9eX3n4ZUYLg4GWILaHLN1p7qlP9T79x1iHZ8LNd817qLT2AdcVb9wPb11Ua8SfwD0hrAsca9Q4i6A47ELFwKN5X1XTn7TLHlb991eym0LpudN7TMucLb1zWtFy1aqpjDZ1iWj4mNUe4wr9U2tMC4VhrJ6Ww3slfzIkrp6XJL0a26+ZL9RQ/p1JZF+ReQB5v83gvk3UH5vPNug6oPnPZA4WGiMdjZ3QWL0rwfBbSJwN6JhN4BhgYEHfdDsN+CW8H07yvG8By7EnhgCTONfzbn6gA6kB6MRndyejuiI82xEp4dvR728vO/LSZxdUwrdZtCUJsdZMqbCFxiwhJrpODw160R7E0XLa6cpkJn25QFc9r29aGnbUXt7bZDz5okXmN7VhlV6CWZWS7LgmYRLgYANDoOSvnVVeOClBGvlim5Oz+leeC7mwiEOHhDhjFd8KqTAzddf7fOO0u3fdsA+dXX8R4YudMMCJO7ZLeSl5l1QXmrzZYb3AVLG2RTvWyMIC6rgKvN4r986CLdEwAeR6soITFecQamFl00rZ9A7Sq74nPw2jf2A5SAxjFlm9BSLDVbL2nuf40Jq40stNCG6AkpKfINXoIw/EmJ5xkCBVrwImLpNfU3D0iaBU1AIRtHleZ45kQGBn7WSOvvii2S1lKzSzheu8OQZy4jDneHK0vV5X90Ja9AqLCD9YMM1xY8WcIXfCvUFb2jiTcjz1q4+wdQKB90BdrlcXturn/THfC/cD/WUvYdKW+G0WXWj58IV9ZT295hI+8NT+r55VxDt3h2NXGd2yxlaZ3ZYgKyGH8Chhdjh8ekJZYtP2C9//it7C9woVuilt9asNiBX3RMG1Jxfea+2NtnzV/BrV6DGMx4uelLobTT4qeCOblthtiBUcCl/pfS0nkqRdU8R9vaOmqcA3WUPKgqElwjhUitWuTir/Ggp1JcBO1Yr/zSh3YGwncb1pkG7XvQcI3oy0PKMH0cgNmxBLvxrCDx7TIFBLnxl0+h67rnFwoTJ9e/34tyO85xVG3d8EYfuxPFQKxXtuMdc3WDrteDefdn+fQhQeaWFcvaI5YbPXEc/3bj4S/vftabmznCjjjSQaZfEe2KYcdvqL+JsZJ79eGtgBlRStb0XMrwSwZzOG7NkaK2/xqw95kJbenSCxxR4a+XIgSntu9kHMAuRNcfuGzx6SJ2HSZpIkUEAgML+dfz96Vu2eDoYJWmUz9/BuYdvT169+fHDGxQGA6lX2MFgNBgRTq2tK7mKOG19jxRdQO1pProJ+vCY6eEx08NjpofHTA+PmR4eMz08Znp4zPTwmOlf/TFTBK4MK8mFiipJHv0+3yj0JWlyFL9fukiTAtHyo/Pk6goTi4+Io2Hzn2pCds4v0mTBjUAkigCdcDUmj3DUG9LJx+9D+fAJu+Ep1Fb5G0haIR5NXufxqC+w2nh8tb7AcrPHpVE03+OVF2D/DOl0FK5VOxBY9yOOM0yUbu0blxdO3304S9KkucFe0lutxPAlYlN86aWNACxqu0okV/OawK/E01z7O01FH4f/Qjh8+CNC0Pr66AP0fhr4X5zU1gFXVx7jJ8DZ9/efbhwRFNv0xsW5WK/X/wCbdNL3","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),s=n(28453),a=n(33617),o=n.n(a),l=n(17543),d=n.n(l),p=n(86013),c=n.n(p),m=n(63723),u=n.n(m),h=(n(18766),n(79329),n(9303));const x={id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztW1FvGzmS/iu8fklitCXZSeZmjVywniQ3Y2wwMRLngoVlaKjukpoJm+wl2ZI1hoB92H+wT/u6P21+yaKK7G62LFt2ZoDd2/VgMGOxyapisapY/Iq8Shyf2+ToPHmts7oE5WxykSY52MyIygmtkqPkrAD2ygB3wJpebGZ0yRyUlcTm49MTxqXUS8tWumZOszkoMPhJwZLlDW02XbHPtXWsMnohcqHmLY2JyJlQ1gHPmZ6xupKaUwdOJGZCwmOhmCuAzbQpsc+UW/jmGdOGTYXiZvWEwQLMijlRAsmhAHIUJvPC81aQATsLbC1SYwYq7JHLFast5MTNsowrNoUwOvdTri0YJpQDM+MZMO7Y+d7ea5jWc/bxZG/v4nHhXGWPhkNeVQNdgbJiriSf2kGmy2GOHat89gSFri3Nv1PuWaTOwViN1R91TUJ4bQHLYcZr6diCy5rUgEpnS5HPAXXLUXRNOhKGKV5C77utq0obx+Ayg8oxFIy72kDKrONllTKhhBNc2pSJks9hMFYHA7a3ByUXcm9vrH766aexuhorxsYJUh8nR2yc0Odxkvp2AzzXSq7w24xLC6E9iB4N+T1c8rKSgIoZJ2O1DgzG6hC5IoObmfq/7sPzs4Y+l6fI5bOesjPh5C2ssIvDLvfjl4Hu83uG/DJdVlytbuYWOtxTn16TrFo4Jl3e5/sc+ebc3TJF/Ho/jgcH+6Pn+4ejw+d9Zt8gMweXbqovb+YXOtyPZbliOK7P779JqQVkX25l2PS4D8fzcaIpAu4fjpOLjuk+qtN3O9rbY42PFnwBTCtAzy61AeYKrqjBe6sruKOAZDEiTYFZkJBhXJmuGscmp/+W1svoKtdLdcuahR73U6Kf0UFfib9DjobnQrNp7Zy+hSv1+g1Y7u2dGpgJKdknH51QlU1TE7C4AQYS/M5B+sMWoSwY1JtQTkcxnU1hhnoXjgnLbMEN5GwpXME4Re0Be6fkiuJtO4RCuzas4JZVYEphrcAAqhnPc+xa0pLgkhuwlVYWvKA+HiOtaHVtoWuZ42YicW/Ar3AprMMw3wwf+Nm/FdbhFrYRm2lWjR5wFQ52+9M2d/K86CNXuYElm0Iv/B3eNShco8jGyejZ8OD58HB0+Cwm+fSrXbGjfT5OSk6Rlo2TGfi/I997dk9LDb228mpYddQpUtLWdzNZ+rxd0+L/vnv3fjn6w/dzfXx8fPzjh4/Fm4/z4+PjEn8PBoPAK5D+5qv9PJ5Do6RuFkma6ApzL6HVSZ4cJSF/CTaPHtHkXCJP0qTihpfgwGAaeEWck6MkSsuSNBGYBlbcFclmbqinnyFzJ5SzNflLkiYG/lQLA3ly5EwNaWLdSiJZK3CjStIELiupc0iOfNxIbFZAyZOjq8StKurpjFDzJE0w2+MubgnbHYr0w8G0yA6Lapqs1xeeLVj3nc5XSCrTyoFy+CevKikyUsrws0XRryKenbjnCeZFqIyLtBHFzxFVZVCzToAlQTEpuK/EP0bpsE8rrqn0WDEfM7lk7eIwW0EmZqsmZaShlALiLwVLuWoT1S7LPZkxXQrnIE/9qLBCv/z5bzaQWGLEnYLPe3tbUbJOW2V0s+TG8BWahIMybr9BSUZv11GnkeMs07VTXDlkSKnhrUqlDjGBzxriXBKpeCO+jetnDRgTsXNVaLWj98HhU/z36QH2DzH763WyW7oQ0SfEr9lloyFTrSVwFY8hP1qnzd57O/2QS031ZbJep40lb0SKKARMPng7mDRzX99rGDGZaZmDwYh0m2RkdKDyyaYhdFPePJwKG7lJ/xQanIYtC3AFGGpecuUYUe8yMfRFzYKxDxgeePtnLWExbTU1jBPyqm7n1/ijJ0LUl3GVM6XZI+I3sTUZxKNh+D3V+epRN9JnPF5mgX4cRKDOre/anssOxj0rQLaNFzXstim8r8NXtXW6ZMQmDKLQ0h4RWQisA/aKKyZUJuuQ/sw0KhyjEru6akxgQpaxXrOrK1xLMBM0+fU67RqQV6+BvNC3GMhALHqj2iboBrZt0VC4rIRZTTB38Q3hPBULIOZKqPmkNoGO0th50DPDDcEpQQw6gLy1LjFXW2bdhjFa3ztr/5qyw7ojkf8Yvb+oXv4gtojyYli9fFG9/ASs0BV4j/PqmQmVe39fgpQD9sI6o9X85YYKXgxD+/alNLAQsCR3pVXtqGzqtiU0CDL9UdexpwjLMlNngkukWxmdQXMO8Tv1pWPWQWUZt3hWIbXMBNAcDONzA3TiIVl47QptxM+UtzQMX3BWGJj9z6MNnT56ieGWFWDgxZC/DL1PZjRHOp5ytWI0caGVxYMqAWSz2lBwzCQ3YhaSpJRVErgFhjkUzxwJ7zXayHFWcPXFpi+m5uUZ8JK9q0ChBL/85e/Yo4nkJ+qdycHcIZSfzJgFisSPMI49SpluTmwzYawLAdrHv2AhXq4bXCcAWnI1YG/agG/rqcVeqqHXBVRnxHwOeG4MPWhw6lcPeFb4rYKk4jOM9ci9QuPRtW3EQwND85eABubBuLBQA/Zdm2GlLNIOHVnjuQ+2RHXENc/0q0D6NV/FuYaqyymYazolLBQh0DCK5XxlkRvle/iBy6wm1NH7MEMfxl2NzLGx/jgBazm18h08x5Cn+FTCu7PTO6w0Tojtezf2ua5fA0+DvTs7ZQvojHHAPtp2nZqF570uLNM5sIXgfulTtixERi63YiUizqBovULUjlGAgccu2D67LlAu7FaJUp9oYPytSbRthFkuDGROrsiAdO0QVRAhs6cYMNiWwXklnOn6Lj6zQ5OczWuR00rXpt3Twdg0guARdjd15qNCXpvmjBGM1gcxazs9NVrBThH9lIGyfjhnM24dmJTVitByU1foDQ1JuKzACFAZbFVBFLp375+YrRHYrX1eVoGxWmF402bOVYieCIwvC20x7S+49F1DmLBsCigVend/P2oQ/F/+8vekk+vGQ8p1wTwHnucGrN0hIYFI3pwQUUQcacWc7kuE9MD8frO0gNKRSU5Knbdmau9uQacIfznbxsSAgbX4m62zAresNtbauGBAFQSb4pTwYEFVCF3hfFsErIG6xE3e9x5Qj1kkA1Vc0GfQotQqdp8OF9Qb5OhAIKxvjZP4rZaGlZ7dK4kgb8lXbSEGaYfqEyiMPDk7ff2/VDby2cQWBBAPmVEU9cOvnX147fTEQCnU3fbMD37ToEV0unX72umSO5GxhpQdsNDVq9vp2ItL9rhRFXrHQmjzZKu6PLmJVhlMhJpQvW33JvQjNaM10O4zBbcEULFszaL5rdVjNSjbsgDFejqJdkqcdE9K3IYqD55uO4VfX9O4uNbYp9848AuUU8REPKyMrk+BsTknXjvW/2pcwH/dZYvH6OWQe5u2bP9aIW+wA4JqT/6I/c1h9/JhHMOeTIV1VN3uGtTWYN+8qoCbAUYxhjvO1xVHe2lJe9Qe7EhC1mlyuXsylyzT+9rkQiHxxxJmjtVVhfmvNgrMEx91/AT/dSY3Gq3T5A6utvp/Ob2nOLvl7tl9ErkrurrJP0XWZyhrsVvWH0DMC/dPFvZbFNbnhb8lMOlhSV+H2ImzYudMS21u74nwO8GEylnx89aw1LnD4dr/04GQTdy/GZicxMgkQTNEoF+qiCZGKjkcjfB//aV93asfYlpbZ5ghz2opV/+VpHcvPNy+Hk1x5b5FhuKzOPz5MlscnjYYfm3k1+9LuzH5bRDzxhUPlKQvxd2mEpyjNnLf6X2cy36b6xHZaL2FkkLBpFnASa6zSTN77FeCtf0d704ytMtNp//+Wu9gn3gjfbbNiiJkRj2is2FX+Q44FCbBmC83F4MQstGuTVmaLlxqSrA9xiQMw6oLjSQz/83sEYzZ7sW3ae/U40gWXF11M/GEd2nw2Wg0yTolPt+iRLXgUuR0A+1MfwH1G7rfjdPtJhezd549inpZyi6eJsJ3ou9Jb7Zxu5+khaw2wq2oFnu5zyux778fnV9ghbMEV2is6lbaksRYlD1Khv1QN7yKYt06QbJm0VR4yQtbx7Jc5VN9eX3n4ZUYLg4GWILaHLN1p7qlP9T79x1iHZ8LNd817qLT2AdcVb9wPb11Ua8SfwD0hrAsca9Q4i6A47ELFwKN5X1XTn7TLHlb991eym0LpudN7TMucLb1zWtFy1aqpjDZ1iWj4mNUe4wr9U2tMC4VhrJ6Ww3slfzIkrp6XJL0a26+ZL9RQ/p1JZF+ReQB5v83gvk3UH5vPNug6oPnPZA4WGiMdjZ3QWL0rwfBbSJwN6JhN4BhgYEHfdDsN+CW8H07yvG8By7EnhgCTONfzbn6gA6kB6MRndyejuiI82xEp4dvR728vO/LSZxdUwrdZtCUJsdZMqbCFxiwhJrpODw160R7E0XLa6cpkJn25QFc9r29aGnbUXt7bZDz5okXmN7VhlV6CWZWS7LgmYRLgYANDoOSvnVVeOClBGvlim5Oz+leeC7mwiEOHhDhjFd8KqTAzddf7fOO0u3fdsA+dXX8R4YudMMCJO7ZLeSl5l1QXmrzZYb3AVLG2RTvWyMIC6rgKvN4r986CLdEwAeR6soITFecQamFl00rZ9A7Sq74nPw2jf2A5SAxjFlm9BSLDVbL2nuf40Jq40stNCG6AkpKfINXoIw/EmJ5xkCBVrwImLpNfU3D0iaBU1AIRtHleZ45kQGBn7WSOvvii2S1lKzSzheu8OQZy4jDneHK0vV5X90Ja9AqLCD9YMM1xY8WcIXfCvUFb2jiTcjz1q4+wdQKB90BdrlcXturn/THfC/cD/WUvYdKW+G0WXWj58IV9ZT295hI+8NT+r55VxDt3h2NXGd2yxlaZ3ZYgKyGH8Chhdjh8ekJZYtP2C9//it7C9woVuilt9asNiBX3RMG1Jxfea+2NtnzV/BrV6DGMx4uelLobTT4qeCOblthtiBUcCl/pfS0nkqRdU8R9vaOmqcA3WUPKgqElwjhUitWuTir/Ggp1JcBO1Yr/zSh3YGwncb1pkG7XvQcI3oy0PKMH0cgNmxBLvxrCDx7TIFBLnxl0+h67rnFwoTJ9e/34tyO85xVG3d8EYfuxPFQKxXtuMdc3WDrteDefdn+fQhQeaWFcvaI5YbPXEc/3bj4S/vftabmznCjjjSQaZfEe2KYcdvqL+JsZJ79eGtgBlRStb0XMrwSwZzOG7NkaK2/xqw95kJbenSCxxR4a+XIgSntu9kHMAuRNcfuGzx6SJ2HSZpIkUEAgML+dfz96Vu2eDoYJWmUz9/BuYdvT169+fHDGxQGA6lX2MFgNBgRTq2tK7mKOG19jxRdQO1pProJ+vCY6eEx08NjpofHTA+PmR4eMz08Znp4zPTwmOlf/TFTBK4MK8mFiipJHv0+3yj0JWlyFL9fukiTAtHyo/Pk6goTi4+Io2Hzn2pCds4v0mTBjUAkigCdcDUmj3DUG9LJx+9D+fAJu+Ep1Fb5G0haIR5NXufxqC+w2nh8tb7AcrPHpVE03+OVF2D/DOl0FK5VOxBY9yOOM0yUbu0blxdO3304S9KkucFe0lutxPAlYlN86aWNACxqu0okV/OawK/E01z7O01FH4f/Qjh8+CNC0Pr66AP0fhr4X5zU1gFXVx7jJ8DZ9/efbhwRFNv0xsW5WK/X/wCbdNL3",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},b=void 0,g={},f=[];function j(e){const t={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Create Document from Template"}),"\n",(0,i.jsx)(o(),{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.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}\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}\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}\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}\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}\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}\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.p,{children:[(0,i.jsx)(t.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document before it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"response:"})," Provide the value that should replace the existing response."]}),"\n"]}),"\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.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.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.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(d(),{parameters:[{name:"template_id",in:"path",description:"objectId of Template",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}]}),"\n",(0,i.jsx)(c(),{title:"Body",body:{content:{"application/json":{schema:{required:["signers"],type:"object",properties:{title:{type:"string",format:"string",example:"New document title",description:"An optional parameter specifying the title for the newly created document. If omitted, the template\u2019s title will be used by default.\n"},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"Accoutnant"},email:{type:"string",format:"mail",example:"joe@example.com"},name:{type:"string",example:"joe bee"},phone:{type:"string",example:"123123131"},widgets:{type:"array",items:{type:"object",properties:{name:{type:"string",example:"textbox_1"},readonly:{type:"boolean",example:!1},default:{type:"string",example:"my textbox"}},title:"createdocumenttemplate_id_Signers_widgets"}}},title:"createdocumenttemplate_id_Signers"}},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used.\n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"{{sender_name}} has requested you to sign {{document_title}}"},email_body:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"

Hi {{receiver_name}},

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

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

Sign here

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

Thanks,
Team OpenSign\u2122

"},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},file:{type:"string",description:"You may provide the base64 encoded PDF file to replace the existing one",format:"base64",example:""},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5},prefill:{type:"object",description:"You can provide widgets which can embed before sending to signer",properties:{widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"textbox"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:100},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},title:"createdocument_template_id_body"}}},required:!0}}),"\n",(0,i.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"hji2zxcv2P"},signurl:{type:"array",items:{type:"object",properties:{email:{type:"string",format:"string",example:"mail@example.com"},url:{type:"string",format:"string",example:"https://url-to-sign-document.com"}},title:"inline_response_doc_signurl"}},message:{type:"string",format:"string",example:"Document sent successfully!"}},title:"inline_response_doc"}}}},400:{description:"If you haven't add widgets and signers in template or not provide signers along with their roles in body",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Please setup template properly!"}},title:"inline_response_400_cc"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function y(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/c4fbe420.13bfbdc1.js b/assets/js/c4fbe420.13bfbdc1.js deleted file mode 100644 index 1d2d8b362..000000000 --- a/assets/js/c4fbe420.13bfbdc1.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3795],{7258:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>j,contentTitle:()=>g,default:()=>b,frontMatter:()=>x,metadata:()=>s,toc:()=>f});const s=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":"eJztPNtyG7eSv4IztVWJuUOKpC6WtS+rOIojx5a0lnyVdBRwBuTAmgHGAEYUrVLVeTh/sE/7ej4tX7LVDWAuvEiyrTj2LvMQi4Nbo9Hd6G5091Vg6EgHW8fBEcvylBqmg9MwiJmOFM8NlyLYCo4SRnwz+VnRoeFiRLYPdgkTdJAyTQrNlCZGkkgx6BQV2siMf4RWYvzMIdFMXcBYqskgLViuuDCaDKUiIyaYojhxLKMiY9Aw5iYhuWIxG3LBYqKNKiJTKKY75GUuBdFFFDGth0VqV+ZSEDkktFwzJCZhCKpiplBCE0oKwT8UjLRacvCeRWY3brXIjzHTfCSoYTEA54ef8fhBSMYJjxISUUEGDLYaw04dwKwG7oBCmxS4ps5ZxIccOrvJOmQ7jjnASNN0EhJKWq1Cpa0W4ZrkSl7wmMV+NTkcAkopopZwYZga0oghrhjMIka4jJ+cUBGTIY14yk0TjSTm2ig+KGDlzok4EUc83yIv81TSmExkocjBz79U3Y0k8O241fqZDYoRebnbap3+mBiT662VFZrnHZkzAdhK6UB3IpmtxNAxj4eIK6YYzIr4YlTzdEJoHJMxj0fMaDwQQSKZT0gkpYq5sKSR0xEjosgGTOkQd5NJxQgXhBLFaDxpG9kuNCNPD/f3AA0ZNR1ykBY6LJeLuWKRSSd2ekCP39UP9nQ21oCGuBiFJKPngCVuyIeCR+ewbc0EHq0jGcRVq/Ua4C2xw7Wj8ZgQk3BNxmyQSHlO2AU0j3maEqP4aMRUq3Uifv/99xNxdSIIOQmwx0mwRU4CN8VJENomM8mZbfl5//HL5zt7R2dHbw92ynZPqVN9dn8uewx5Oj3DyxfPymZBs+nmve3n1QJCGtd+kDKqGVHsgrMxngMctd2rx0I5rCYn7OiyBQYxpeHrMXwh5Mr+04TmcPfJ3s6LOiy2B8soTxtddp5v7z5r9MkTKZrTHPy6v9ecp1C1WXb3nlik2PZr+OfUwetOZNsd0NHu853Do+3nB9D52p0jUMNhkedSwfG/tgS9Bcd8In5iqRwTqhhSTySzTAqSU0UzZlA2JtRgs2IfCq5YbIUbTVPPGVsnok1aLSCFrVaL7IqYR8Aals0nOQPJZvt2bFdgGeh66ESN7VpjJJBFVpwAh4yp5e48BUECXRUDKWX4BWtOfBmSCUz8MwO6sNMmUvGPUhiaIlFcMGV4RNM6EwOAKPoMVSiCcsmF8V/dCuStY1bgZWRRJ2UAtBiQlXGBLZqRC5oWTDuoxiFJAKoXLFdMo8R18wIiRUwSxkfJwvVo/L7QpjExKbSXox4Kt5Y/JUQvQ7QNaaoZ4cMGLjN6zmqrEZlb+d4hP01IzIa0SE1IOMgfowrWIXvSEJrnKY/wbgRxbi+eQrE2nrIjBwcIsAoAcWDvB7gRYg53A0gbaMQp3BgPHdCZvVBgeyhHTUIFkWLqoCOZSjVLQvi5iUcSSWGYMB2yfUF5isDbzWrCRZQWMSODlEbnId7sIVFwl8GpTFiaynFo6R274A2LOEf8EM1SoEIpAH4h3fJcV3dohxyB/Cn5CRo9qnERrutYdTJ8KGFlQIFnMYJyJUTEheS9HBDDTcpCYNiciklIYqs0sEszkJchiRIWneNfisZckkFhjBR2Y7GSeSzHwuFyKIXR/OMcjvQtn47RfkjWQrIRks2Q9Loh6fVD0lsLSW8jJL3NkPS7Ien3Q9JfC0l/w4LV33S4piWC6wD0+hbL5vvBLsjdZ1wjZ4PA1KUMHjdkcK9DWq2Sm6av3+qOLbuUtxXITGjrud+X8GO1/9D9nMDPjf6m+znGrr019zOBn/1e/Z7oIySGZvkNUEDzvULglQVLRPDN3bkngZdn8BEEUegbqqvYwQMN1/W9rMJeuOCG01Qv3o7v8Q3tqAJpZlNrsCkk18U7cjrIN7OdOjyosoCYtE0oVmtNnuERiv7M7tc77mZZvHm77Dez9xo4X7b1Ddg6iKYjEE2L919Kr28ICdMwfRkmHnZQAUDJvBgPrsM3hIUmRF+Gg03AAVxKixEArd/Q7mvgWAMMb3jb1l1r99bb/W5/rYEBsJRthyxrx3F7MpncB/ZA53HLg8rjNVSr2YFHYqhkNsf8QOug6uV0Ivzbq+zPQVEfsNIpAl6Apk/F2/91LdvImE5+0HYqP7RUzqB/pZpNamBiE8CBvpAokTxywEMfr5INwMDrAA7aiMmVOF6pYRI+xnE7y9pTH+FnGxFf+5hlnTjuTPWcOR37MSNxHJLZz3O/xzHJsmzBZ/u98Xkly2Z30ckyBxsqX4+ASZzOtphPXIevxSoVRzQXvpGNwI8kRYprozk3n4+mLpuEe7eNIyoy1UGxUZFSxS7BLtXTvpB75DHPYpVmj3YsmoDWGYioID/uO+39gSN/2EJzAvhy+7iZncEk2869SxQbsUuSU2OYEjjZBU15bN2wbeuqvKRZDibAyt9PTuJ//7cVdECAjW8InASJ+YiDV3Dl78fb7Xenc3oUec5UBD6plMFKOiTMRB1ynLA0rxyT4/G4M17VUSJlar2S77ViQ/v/Mzl4f4bg5h2q8wfzdmpJo2bwA+lM2/uamQbGqCZ+5ByTH2kMeajXxdvW2Ts3XLeuxzd040yBBI3We2J9e0FGUSEBUmbV39IkTJ0Ep+UYa+Sz+Jaxp3dg1oTHLKUDls423ZnRys8pncjC8bd3ajW36ii6hjdoyLgo/Ra4nW7N7ZjRy6nGk8rlOMXfFiF17vRXjmdPfwIk5dp7bprorI92ri10OApmHysGjPgBZFBS6RdzQQnY3djASiJ3drcsAf0Idizdin61W1ZoHEwdMTBHxgXPiqz0jw7LWT3KMqd71PEFI+Edxq9QP92ZFejlLSu4h6QFC5yIHvoxvP/jBs3U9fiGZMUUSDez8edIkcY9fU8X7O0M6LdVZ8A51zJ0tRdyyXx6Mfd1yD5cb+CTtYPAyxZFLDfgkftS1ixBvvMNhT6ruh9uMeXVe31D1DcHrD+ZAl2/+759PotI67v/jgi1AfadidU6JTM6usFyx+ZviDwdPDNOiFbrQLEhPBxXT4rEf/IvO/Ckw1KWuWcv95gIVx06wrkwEswC/0w9YEN8PccHa53Q6sHR3jP2SOsv5PZZWyqSUG31b1T44ajg+d4kLJtyxXvQKnc8Fx5uOJXe/dmN/Ufd+jn1NtYb57TebZxTd9E53WA2wgnqXApd+tpY1VTja1W+2s+9WqbZ1k8KR7oDQRyl9WCZQRZpTFJ+jq8qMdd5Sidwqp5LHZTTz3WPEyl11cO9mP3oNrzVfImTCh7jHnTKh4m7OLymDqN2Fr2Hq7WjWN/cbHJMg2HuYr9X682eQndtpbe+Yj1a8x1alRtmsRC+QRMg5C7nhX6iO50X9qwObOl2+ly30/2Q++p9Wt29h/3GZbHa/dzL4t6N6zrX3GJW34fxfG9WbJ3d7mi/fjU78supb+3P0Kh7D1frVPiwdw8u1AWK85dS4ox+fG+0R+5LOZ5HgHfQjm9Uib+YQOvA/ulEun4/mnSv29DQHjUUtEf9OlGur9+JKOuLTlHWScBf/bT/Ytz97clIbm9vb+8dvkx2Xo62t7cz+N3pdOYaUfNOG5cBzdXFh7p7Ge/4Bat0Oh1AYUwN3cLhK7kY/YcdHy4e03Gvz3+SZ2f9Ph5T5jhwvlwKlF3/Om/Nn8fnX8qBQRjIHEPfpdiNg60ghgB7H9YdhGhZMm1+kvEk2LoKXNQY/OlismDkynsNofpXgY4SllH4y1ukENwP0cFB6INygzDAMAKI9AeiC7ZcgHEQwhNXDn4IpmEOHLd15XvZ2OkgdDp4sBVYog/CwD30lJ8IE5GEp9s8HgbXfsGbpiq/VFNp/KOMcYd5ICD1M6fBoddTyQ2fNVN9husKrdVkVCk6CabzKHwkqn9GtOPKULt04u8GbsATUoZHYrcgDLhhWX2VBYem5KdjOmISdoIhRp86Fo+FZp+8JozDGO7PGeicD3Nwfkcs2dbZhZtHtg0xjiz2Smm7CtYNCQbMdW6jGN8fd0tH9TXtE8HMmkeLgrhrsaM6QUuU5jmjqoOx1J+dtIF5OzSNCswjKaViY2clqOXOetdhcHn7Zi5JJNs+Qpz8mLKhsS+6JJJKMPWgHibyzWyuv7Z2HQaT27c3+S639xAOb3z77l5jaH2VdvBXwLq6eR0Gye2w/loG//+FwK5tXFd3ncspKXPJBjKenHm5dX1bR3+pQD9ITNoV+ypmqoaIgZQpo2IGE7tD61yX5AcwOH4IbRwFxmxzpf2FYnOVFIsY5H9geJWXVcTpHDagm7g4WvDJ78AH1JJ0MdDQS/j5tJ1wwHz+EyTs2R7cJryhA5rRKIFMKxfdQYfeyZZDypEstAcP/NAQ65cycC2bhHGbKsHFqGkU1bCD3u763jv104EvcMlh0uL+0cEdcIkWW9tmP9l72u7SzkH2jw4gE4YPnRrWIS91iQmPWtroQkAtIhec+mj5UrZP7Nszs25H6fOuKhd9x+WgtMksQDHXcyEKIWLehumXSZozE1eJc3BEsjDg8neZikQblusGHhGKEpFHsrgLVd6CSUpGBYb6GWBZnxaD0T5VJgsXNgMU1f24UD55x5EF9IR00ApPHivQqTZ/SJjQdjglQ6oNUyGkhQLmVQHKfTklu8yZ4kxEbC4KFLOoOyvUXL2piYNmWsjLF89cuqTfg2fKAXCgnZjFpMiRapATynQlf3LTW59RlIA7mDpbpKDNqh6YVOQ8ETlTGlJqFZFqRAX/6FJsQSMBY2fAEprark5UgMca4AEObwLjZe0f//xXDa6FGucsYHYFGscQi3YLhGjRWYIHjVuxHCSgbEIE8zH1n9OXAECHTHOWybhkJH13Gj/A6DVdykX3hFY+3+kiSkDBL+WtDr2M1U6t1Ggioh2Jb3A57Jddcm1qCTc+LHZWPrxggMeoBgOqIcDVQPNiUmfw6llRTk2HaUG8maxVXoMzvEALI88Uy7i42z1Vd4oZWQqCwsiMGh4RP5XuNFPw7MuL5+sMcrctaECNF1yqBwtYFaY7kyJiZ1ycsQum7qDg7ZVhPDGdAHGbMWOiDptHkr3OqjSpMeQNN3BSu50wGbAO5TqYB/btdJ7tcrMh6emhSlRn2QDe8O0rMLAaCg5Z2ZJNY+h7sabcc+jSlvqOjI1et/t/2ZZa7X4/ttRa9zuypTYBWOc9vV0ALdJv5soO7w2+ecB7iU4b9OPe3BO8rNdh6bueh+CKHfrX9r/K/PNy/xaT0NqMlVvXmTN+M4iGfrcL/0wJQV8jxFeuqMqmpJO/BeHdfco3n4GvUnEzsn5K+r/qXGRRAjhboDdX3W8msbqvfIVNniaDJxHf5093X37c7e3xXb0rXqxHj3c3ds/zN68eP33UYZOnvaj/avKm/8q8fZ3q3feSR78+Td6JV3rweL14++adevtmV719/cLQ1+vbA5GIwZNfeDRZfz/od/mzx0+77173xoMnv3TfvXqUv8PJf+m+Oz/vRtne44HYhj752zf/xfff76w+/7jz8fnRzuXzj+mjDt378P7xZfTo+fnORvvdrmo/3x/89v6DyV+sx6t7b/jGJnvOXouj7rOoQQ1cpFywM3/UZ7jvMzhsS0lr8479UGbMJKgvYmkSJaHuSW7rexg1IXREuSCAOnWPVMCUuo1fPg2ymxCx1u2e9UokrM8iYVdgBD+WADqS50x83Z3Wlzd2eQD1MksroRVw2wnbg8Zm69/tJjWLCsXNJNg6vgou2zTnbdu+dXx6fRoGgFgJz0i51AgxNUmwFaxMvypBJSZ8szi+sjxYMpqmIoboiBlmozlfueh1esF1OD1mLnPe0J8V7U8dog0dcTG6bdxphaJDOEZ7Ug1EVTpuzn9joOS6c6j3CgMO5JMwCsYMYB6o40X1Frfjz9i/ks17+KrOcvopy79kNR6npu/hOc9NtdemY//Ug6835eNNUG0oKB9Y4M9SyT+uKLZ8nfAKdQ810f7aGqpsD3uo26xuotqwtnF9ahFcc0disGvdp2bjOhrOIfep6SwJginnRMNDMO0gWGisL7DV3ZJTNmkJyDxTcL1hgc3BltcgmriCyAfA1WoXcbXWRVxtdhvKi9thNUOlgqCeUaoZqEvUVQnQF06B/rgYSiReR1H7OROH4MkD2YLEP6NysjSSWVmwww/445//wjHezrceE5jhbxAQsl8okssxU1BVDauKpeySg0WLFd8ybNP4Tolh3DRLmdbweCkMG9mSaJDUB65D55yKaE4HUJkMXF8YqowxjzXZqzvkdcIgjACaflA2x/GCpSBvS59AvarZWKrzYSrHUCyMDKCQD3iFmEioiKwDykoBdKSARQzOvVxxDfWJFEDNLWxSGEUjQzIq6Ag9IWEDVTFLOYhKouQA/LNapoX1QBrKU6lshBpuCEMIMKpm5zKHJtSZwXWnWAJ0e+HckDq0bmDL4K7e2QA87jnAwiOG3phCpBJKk4HnvkhTkktjvemgmtdhhOFGUaFBn7aw+DMoEeY8hEy7MO6XmsEJP+Pi3BZQaZPjkqZes4HmhjXTK6d570FzzBNufi0GUJ5Jam6kmlSjR9wkxQBFdX2S8oed6YkvqVcTxNUcsYz0HA1QRnoFMkFXDpkBCtEr2we7eNM/IH/847/JM0aVIIkcW2qNCsXSSVW9DwvN4clbtJUXNfqgaQHV6gwSqRj5ZxFdVoaj5o9//I8me2wMvjhgIYvIVuugGKQ8Kssm6lZrizy2xRHLeojNdDAbpA8PA5TkdnTKxXmHbIuJrQKI7ydADPAdxzW2gW79BdUIqxqER7XVWaZZesHQRwoVgQYMawvic4uSxciuVgfGba6ZrwB7245jkk/lLICjrgLH+qLwnYNapxTU75uT5tDIJ2hWGmIixppieougQlPNH04lMuDTx8wnnwNRlYe009RKVAIm3Y7LrzZMZ0qJaMpaxYZMwYK6URyS5tyR07EnS9LMW/50srZGqTA0Qg3WX5A053Nd2VBRTe8PD6H0ZuQtqgUcvYKdV4IwSHnEnIXs7q7tJwfPyMVqpxuENdXsDsy98mz38c7e4Q4AA4LUIqzX6Xa66MiT2mRU1FbCEqMloU5fa7UQqGVl0mVl0mVl0mVl0mVl0mVl0mVl0mVl0mVl0mVl0mVl0mVlUrKsTLqsTPqV9r6sTLqsTLqsTLqsTLqsTLqsTLqsTLqsTLqsTPr17ttlZdJlZdJlZdJlZdJlZdLvqODjsjLp16DAZWXSZWXSZWXSZWXSZWXSZWXSZWXSZWXST3ZeLSuTLiuTLiuTLiuTLiuTLiuTLiuT/j+tTFpLfFvJU8pFLWXbZpYeT9UrPQ2DBDJPt46DqysgvJcqvb6Gzx8KzLI7Pg2DC6o4BGxh0mrokywh0+6cTYKt4LGNP2sfwfKhPWfMcJjK1YUsUTtiG7d+Y996cuzB/uFREAYDV1M1kzGm8dMxZObRsU1OrKXv4berIKViVGDqX2DnvLZlb5JmUuk5JpW6P2r5g1RMahA2s03tNuD/sKm5A66ubMLq9XXZ3zYtHOEQ63vD8Z1eX1//LxOiJQc=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Resend request mail","permalink":"/docs/API-docs/v1.1/resendrequestmail"},"next":{"title":"Create Template","permalink":"/docs/API-docs/v1.1/createtemplate"}}');var i=t(74848),r=t(28453),o=t(33617),l=t.n(o),d=t(17543),a=t.n(d),c=t(86013),p=t.n(c),h=t(63723),m=t.n(h),u=(t(18766),t(79329),t(9303));const x={id:"drafttemplate",title:"Draft Template",description:"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.",sidebar_label:"Draft Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztPNtyG7eSv4IztVWJuUOKpC6WtS+rOIojx5a0lnyVdBRwBuTAmgHGAEYUrVLVeTh/sE/7ej4tX7LVDWAuvEiyrTj2LvMQi4Nbo9Hd6G5091Vg6EgHW8fBEcvylBqmg9MwiJmOFM8NlyLYCo4SRnwz+VnRoeFiRLYPdgkTdJAyTQrNlCZGkkgx6BQV2siMf4RWYvzMIdFMXcBYqskgLViuuDCaDKUiIyaYojhxLKMiY9Aw5iYhuWIxG3LBYqKNKiJTKKY75GUuBdFFFDGth0VqV+ZSEDkktFwzJCZhCKpiplBCE0oKwT8UjLRacvCeRWY3brXIjzHTfCSoYTEA54ef8fhBSMYJjxISUUEGDLYaw04dwKwG7oBCmxS4ps5ZxIccOrvJOmQ7jjnASNN0EhJKWq1Cpa0W4ZrkSl7wmMV+NTkcAkopopZwYZga0oghrhjMIka4jJ+cUBGTIY14yk0TjSTm2ig+KGDlzok4EUc83yIv81TSmExkocjBz79U3Y0k8O241fqZDYoRebnbap3+mBiT662VFZrnHZkzAdhK6UB3IpmtxNAxj4eIK6YYzIr4YlTzdEJoHJMxj0fMaDwQQSKZT0gkpYq5sKSR0xEjosgGTOkQd5NJxQgXhBLFaDxpG9kuNCNPD/f3AA0ZNR1ykBY6LJeLuWKRSSd2ekCP39UP9nQ21oCGuBiFJKPngCVuyIeCR+ewbc0EHq0jGcRVq/Ua4C2xw7Wj8ZgQk3BNxmyQSHlO2AU0j3maEqP4aMRUq3Uifv/99xNxdSIIOQmwx0mwRU4CN8VJENomM8mZbfl5//HL5zt7R2dHbw92ynZPqVN9dn8uewx5Oj3DyxfPymZBs+nmve3n1QJCGtd+kDKqGVHsgrMxngMctd2rx0I5rCYn7OiyBQYxpeHrMXwh5Mr+04TmcPfJ3s6LOiy2B8soTxtddp5v7z5r9MkTKZrTHPy6v9ecp1C1WXb3nlik2PZr+OfUwetOZNsd0NHu853Do+3nB9D52p0jUMNhkedSwfG/tgS9Bcd8In5iqRwTqhhSTySzTAqSU0UzZlA2JtRgs2IfCq5YbIUbTVPPGVsnok1aLSCFrVaL7IqYR8Aals0nOQPJZvt2bFdgGeh66ESN7VpjJJBFVpwAh4yp5e48BUECXRUDKWX4BWtOfBmSCUz8MwO6sNMmUvGPUhiaIlFcMGV4RNM6EwOAKPoMVSiCcsmF8V/dCuStY1bgZWRRJ2UAtBiQlXGBLZqRC5oWTDuoxiFJAKoXLFdMo8R18wIiRUwSxkfJwvVo/L7QpjExKbSXox4Kt5Y/JUQvQ7QNaaoZ4cMGLjN6zmqrEZlb+d4hP01IzIa0SE1IOMgfowrWIXvSEJrnKY/wbgRxbi+eQrE2nrIjBwcIsAoAcWDvB7gRYg53A0gbaMQp3BgPHdCZvVBgeyhHTUIFkWLqoCOZSjVLQvi5iUcSSWGYMB2yfUF5isDbzWrCRZQWMSODlEbnId7sIVFwl8GpTFiaynFo6R274A2LOEf8EM1SoEIpAH4h3fJcV3dohxyB/Cn5CRo9qnERrutYdTJ8KGFlQIFnMYJyJUTEheS9HBDDTcpCYNiciklIYqs0sEszkJchiRIWneNfisZckkFhjBR2Y7GSeSzHwuFyKIXR/OMcjvQtn47RfkjWQrIRks2Q9Loh6fVD0lsLSW8jJL3NkPS7Ien3Q9JfC0l/w4LV33S4piWC6wD0+hbL5vvBLsjdZ1wjZ4PA1KUMHjdkcK9DWq2Sm6av3+qOLbuUtxXITGjrud+X8GO1/9D9nMDPjf6m+znGrr019zOBn/1e/Z7oIySGZvkNUEDzvULglQVLRPDN3bkngZdn8BEEUegbqqvYwQMN1/W9rMJeuOCG01Qv3o7v8Q3tqAJpZlNrsCkk18U7cjrIN7OdOjyosoCYtE0oVmtNnuERiv7M7tc77mZZvHm77Dez9xo4X7b1Ddg6iKYjEE2L919Kr28ICdMwfRkmHnZQAUDJvBgPrsM3hIUmRF+Gg03AAVxKixEArd/Q7mvgWAMMb3jb1l1r99bb/W5/rYEBsJRthyxrx3F7MpncB/ZA53HLg8rjNVSr2YFHYqhkNsf8QOug6uV0Ivzbq+zPQVEfsNIpAl6Apk/F2/91LdvImE5+0HYqP7RUzqB/pZpNamBiE8CBvpAokTxywEMfr5INwMDrAA7aiMmVOF6pYRI+xnE7y9pTH+FnGxFf+5hlnTjuTPWcOR37MSNxHJLZz3O/xzHJsmzBZ/u98Xkly2Z30ckyBxsqX4+ASZzOtphPXIevxSoVRzQXvpGNwI8kRYprozk3n4+mLpuEe7eNIyoy1UGxUZFSxS7BLtXTvpB75DHPYpVmj3YsmoDWGYioID/uO+39gSN/2EJzAvhy+7iZncEk2869SxQbsUuSU2OYEjjZBU15bN2wbeuqvKRZDibAyt9PTuJ//7cVdECAjW8InASJ+YiDV3Dl78fb7Xenc3oUec5UBD6plMFKOiTMRB1ynLA0rxyT4/G4M17VUSJlar2S77ViQ/v/Mzl4f4bg5h2q8wfzdmpJo2bwA+lM2/uamQbGqCZ+5ByTH2kMeajXxdvW2Ts3XLeuxzd040yBBI3We2J9e0FGUSEBUmbV39IkTJ0Ep+UYa+Sz+Jaxp3dg1oTHLKUDls423ZnRys8pncjC8bd3ajW36ii6hjdoyLgo/Ra4nW7N7ZjRy6nGk8rlOMXfFiF17vRXjmdPfwIk5dp7bprorI92ri10OApmHysGjPgBZFBS6RdzQQnY3djASiJ3drcsAf0Idizdin61W1ZoHEwdMTBHxgXPiqz0jw7LWT3KMqd71PEFI+Edxq9QP92ZFejlLSu4h6QFC5yIHvoxvP/jBs3U9fiGZMUUSDez8edIkcY9fU8X7O0M6LdVZ8A51zJ0tRdyyXx6Mfd1yD5cb+CTtYPAyxZFLDfgkftS1ixBvvMNhT6ruh9uMeXVe31D1DcHrD+ZAl2/+759PotI67v/jgi1AfadidU6JTM6usFyx+ZviDwdPDNOiFbrQLEhPBxXT4rEf/IvO/Ckw1KWuWcv95gIVx06wrkwEswC/0w9YEN8PccHa53Q6sHR3jP2SOsv5PZZWyqSUG31b1T44ajg+d4kLJtyxXvQKnc8Fx5uOJXe/dmN/Ufd+jn1NtYb57TebZxTd9E53WA2wgnqXApd+tpY1VTja1W+2s+9WqbZ1k8KR7oDQRyl9WCZQRZpTFJ+jq8qMdd5Sidwqp5LHZTTz3WPEyl11cO9mP3oNrzVfImTCh7jHnTKh4m7OLymDqN2Fr2Hq7WjWN/cbHJMg2HuYr9X682eQndtpbe+Yj1a8x1alRtmsRC+QRMg5C7nhX6iO50X9qwObOl2+ly30/2Q++p9Wt29h/3GZbHa/dzL4t6N6zrX3GJW34fxfG9WbJ3d7mi/fjU78supb+3P0Kh7D1frVPiwdw8u1AWK85dS4ox+fG+0R+5LOZ5HgHfQjm9Uib+YQOvA/ulEun4/mnSv29DQHjUUtEf9OlGur9+JKOuLTlHWScBf/bT/Ytz97clIbm9vb+8dvkx2Xo62t7cz+N3pdOYaUfNOG5cBzdXFh7p7Ge/4Bat0Oh1AYUwN3cLhK7kY/YcdHy4e03Gvz3+SZ2f9Ph5T5jhwvlwKlF3/Om/Nn8fnX8qBQRjIHEPfpdiNg60ghgB7H9YdhGhZMm1+kvEk2LoKXNQY/OlismDkynsNofpXgY4SllH4y1ukENwP0cFB6INygzDAMAKI9AeiC7ZcgHEQwhNXDn4IpmEOHLd15XvZ2OkgdDp4sBVYog/CwD30lJ8IE5GEp9s8HgbXfsGbpiq/VFNp/KOMcYd5ICD1M6fBoddTyQ2fNVN9husKrdVkVCk6CabzKHwkqn9GtOPKULt04u8GbsATUoZHYrcgDLhhWX2VBYem5KdjOmISdoIhRp86Fo+FZp+8JozDGO7PGeicD3Nwfkcs2dbZhZtHtg0xjiz2Smm7CtYNCQbMdW6jGN8fd0tH9TXtE8HMmkeLgrhrsaM6QUuU5jmjqoOx1J+dtIF5OzSNCswjKaViY2clqOXOetdhcHn7Zi5JJNs+Qpz8mLKhsS+6JJJKMPWgHibyzWyuv7Z2HQaT27c3+S639xAOb3z77l5jaH2VdvBXwLq6eR0Gye2w/loG//+FwK5tXFd3ncspKXPJBjKenHm5dX1bR3+pQD9ITNoV+ypmqoaIgZQpo2IGE7tD61yX5AcwOH4IbRwFxmxzpf2FYnOVFIsY5H9geJWXVcTpHDagm7g4WvDJ78AH1JJ0MdDQS/j5tJ1wwHz+EyTs2R7cJryhA5rRKIFMKxfdQYfeyZZDypEstAcP/NAQ65cycC2bhHGbKsHFqGkU1bCD3u763jv104EvcMlh0uL+0cEdcIkWW9tmP9l72u7SzkH2jw4gE4YPnRrWIS91iQmPWtroQkAtIhec+mj5UrZP7Nszs25H6fOuKhd9x+WgtMksQDHXcyEKIWLehumXSZozE1eJc3BEsjDg8neZikQblusGHhGKEpFHsrgLVd6CSUpGBYb6GWBZnxaD0T5VJgsXNgMU1f24UD55x5EF9IR00ApPHivQqTZ/SJjQdjglQ6oNUyGkhQLmVQHKfTklu8yZ4kxEbC4KFLOoOyvUXL2piYNmWsjLF89cuqTfg2fKAXCgnZjFpMiRapATynQlf3LTW59RlIA7mDpbpKDNqh6YVOQ8ETlTGlJqFZFqRAX/6FJsQSMBY2fAEprark5UgMca4AEObwLjZe0f//xXDa6FGucsYHYFGscQi3YLhGjRWYIHjVuxHCSgbEIE8zH1n9OXAECHTHOWybhkJH13Gj/A6DVdykX3hFY+3+kiSkDBL+WtDr2M1U6t1Ggioh2Jb3A57Jddcm1qCTc+LHZWPrxggMeoBgOqIcDVQPNiUmfw6llRTk2HaUG8maxVXoMzvEALI88Uy7i42z1Vd4oZWQqCwsiMGh4RP5XuNFPw7MuL5+sMcrctaECNF1yqBwtYFaY7kyJiZ1ycsQum7qDg7ZVhPDGdAHGbMWOiDptHkr3OqjSpMeQNN3BSu50wGbAO5TqYB/btdJ7tcrMh6emhSlRn2QDe8O0rMLAaCg5Z2ZJNY+h7sabcc+jSlvqOjI1et/t/2ZZa7X4/ttRa9zuypTYBWOc9vV0ALdJv5soO7w2+ecB7iU4b9OPe3BO8rNdh6bueh+CKHfrX9r/K/PNy/xaT0NqMlVvXmTN+M4iGfrcL/0wJQV8jxFeuqMqmpJO/BeHdfco3n4GvUnEzsn5K+r/qXGRRAjhboDdX3W8msbqvfIVNniaDJxHf5093X37c7e3xXb0rXqxHj3c3ds/zN68eP33UYZOnvaj/avKm/8q8fZ3q3feSR78+Td6JV3rweL14++adevtmV719/cLQ1+vbA5GIwZNfeDRZfz/od/mzx0+77173xoMnv3TfvXqUv8PJf+m+Oz/vRtne44HYhj752zf/xfff76w+/7jz8fnRzuXzj+mjDt378P7xZfTo+fnORvvdrmo/3x/89v6DyV+sx6t7b/jGJnvOXouj7rOoQQ1cpFywM3/UZ7jvMzhsS0lr8479UGbMJKgvYmkSJaHuSW7rexg1IXREuSCAOnWPVMCUuo1fPg2ymxCx1u2e9UokrM8iYVdgBD+WADqS50x83Z3Wlzd2eQD1MksroRVw2wnbg8Zm69/tJjWLCsXNJNg6vgou2zTnbdu+dXx6fRoGgFgJz0i51AgxNUmwFaxMvypBJSZ8szi+sjxYMpqmIoboiBlmozlfueh1esF1OD1mLnPe0J8V7U8dog0dcTG6bdxphaJDOEZ7Ug1EVTpuzn9joOS6c6j3CgMO5JMwCsYMYB6o40X1Frfjz9i/ks17+KrOcvopy79kNR6npu/hOc9NtdemY//Ug6835eNNUG0oKB9Y4M9SyT+uKLZ8nfAKdQ810f7aGqpsD3uo26xuotqwtnF9ahFcc0disGvdp2bjOhrOIfep6SwJginnRMNDMO0gWGisL7DV3ZJTNmkJyDxTcL1hgc3BltcgmriCyAfA1WoXcbXWRVxtdhvKi9thNUOlgqCeUaoZqEvUVQnQF06B/rgYSiReR1H7OROH4MkD2YLEP6NysjSSWVmwww/445//wjHezrceE5jhbxAQsl8okssxU1BVDauKpeySg0WLFd8ybNP4Tolh3DRLmdbweCkMG9mSaJDUB65D55yKaE4HUJkMXF8YqowxjzXZqzvkdcIgjACaflA2x/GCpSBvS59AvarZWKrzYSrHUCyMDKCQD3iFmEioiKwDykoBdKSARQzOvVxxDfWJFEDNLWxSGEUjQzIq6Ag9IWEDVTFLOYhKouQA/LNapoX1QBrKU6lshBpuCEMIMKpm5zKHJtSZwXWnWAJ0e+HckDq0bmDL4K7e2QA87jnAwiOG3phCpBJKk4HnvkhTkktjvemgmtdhhOFGUaFBn7aw+DMoEeY8hEy7MO6XmsEJP+Pi3BZQaZPjkqZes4HmhjXTK6d570FzzBNufi0GUJ5Jam6kmlSjR9wkxQBFdX2S8oed6YkvqVcTxNUcsYz0HA1QRnoFMkFXDpkBCtEr2we7eNM/IH/847/JM0aVIIkcW2qNCsXSSVW9DwvN4clbtJUXNfqgaQHV6gwSqRj5ZxFdVoaj5o9//I8me2wMvjhgIYvIVuugGKQ8Kssm6lZrizy2xRHLeojNdDAbpA8PA5TkdnTKxXmHbIuJrQKI7ydADPAdxzW2gW79BdUIqxqER7XVWaZZesHQRwoVgQYMawvic4uSxciuVgfGba6ZrwB7245jkk/lLICjrgLH+qLwnYNapxTU75uT5tDIJ2hWGmIixppieougQlPNH04lMuDTx8wnnwNRlYe009RKVAIm3Y7LrzZMZ0qJaMpaxYZMwYK6URyS5tyR07EnS9LMW/50srZGqTA0Qg3WX5A053Nd2VBRTe8PD6H0ZuQtqgUcvYKdV4IwSHnEnIXs7q7tJwfPyMVqpxuENdXsDsy98mz38c7e4Q4AA4LUIqzX6Xa66MiT2mRU1FbCEqMloU5fa7UQqGVl0mVl0mVl0mVl0mVl0mVl0mVl0mVl0mVl0mVl0mVl0mVlUrKsTLqsTPqV9r6sTLqsTLqsTLqsTLqsTLqsTLqsTLqsTLqsTPr17ttlZdJlZdJlZdJlZdJlZdLvqODjsjLp16DAZWXSZWXSZWXSZWXSZWXSZWXSZWXSZWXST3ZeLSuTLiuTLiuTLiuTLiuTLiuTLiuT/j+tTFpLfFvJU8pFLWXbZpYeT9UrPQ2DBDJPt46DqysgvJcqvb6Gzx8KzLI7Pg2DC6o4BGxh0mrokywh0+6cTYKt4LGNP2sfwfKhPWfMcJjK1YUsUTtiG7d+Y996cuzB/uFREAYDV1M1kzGm8dMxZObRsU1OrKXv4berIKViVGDqX2DnvLZlb5JmUuk5JpW6P2r5g1RMahA2s03tNuD/sKm5A66ubMLq9XXZ3zYtHOEQ63vD8Z1eX1//LxOiJQc=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},g=void 0,j={},f=[];function y(e){const 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:"Draft Template"}),"\n",(0,i.jsx)(l(),{method:"post",path:"/drafttemplate",context:"endpoint"}),"\n",(0,i.jsxs)(n.p,{children:["The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique ",(0,i.jsx)(n.strong,{children:"objectId"})," (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a ",(0,i.jsx)(n.strong,{children:"url"})," is provided, which offers a user interface for editing the template and facilitating document distribution."]}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"When document is created this webhook event will trigger"})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "event": "created",\n "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:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,i.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document before it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date"\n "page": 1\n "x": 173\n "y": 588\n "w": 114\n "h": 21\n "options": {\n "name": "date"\n "response": "04/15/2024"\n "format": "mm/dd/yyyy"\n "color": "black"\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 528,\n "w": 114,\n "h": 21,\n "options": {\n "name": "dropdown",\n "values": ["male", "female", "other"],\n "response": "female",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(a(),{parameters:void 0}),"\n",(0,i.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"sample note"},description:{type:"string",format:"string",example:"sample description"},signers:{type:"array",description:"You can provide signer optionally if you it as default signer",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:""},name:{type:"string",format:"string",example:""},phone:{type:"string",format:"string",example:""},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"createtemplate_body_signers"}},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5},prefill:{type:"object",description:"You can provide widgets which can embed before sending to signer",properties:{widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"textbox"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:100},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},title:"createtemplate_body"}}},required:!0}}),"\n",(0,i.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Template created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bh2Hspnmch"},url:{type:"string",example:"https://app.opensignlabs.com/drafttemplate/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2VtYWlsIjoicHJhZnVsbC5uYXZrYXIrYWRtaW5AbnhnbGFicy5jb20iLCJ0ZW1wbGF0ZV9pZCI6IkF0Zkk0cmNCbnAiLCJpYXQiOjE3MzEzMTExMzl9.aNqjCxc9MkE6-ZIr-MObKjqtpR5d3NXi68eMeWnT0Lc"}},title:"inline_response_draft_200"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/c4fbe420.4ae7e25d.js b/assets/js/c4fbe420.4ae7e25d.js new file mode 100644 index 000000000..09f713736 --- /dev/null +++ b/assets/js/c4fbe420.4ae7e25d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3795],{7258:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>g,contentTitle:()=>j,default:()=>b,frontMatter:()=>x,metadata:()=>s,toc:()=>f});const s=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":"eJztPNtyG7eSv4Kd2qrEPEOKpC6WtS+rOIojx5a0lnyVdBRwBuTAmgHGAEYUrVLVeTh/sE/7ej4tX7LVDWAuvEiyrTj2LvMQi4Nbo9Hd6G5091Vg6EgHW8fBEcvylBqmg9MwiJmOFM8NlyLYCo4SRnwz+VnRoeFiRLYPdgkTdJAyTQrNlCZGkkgx6BQV2siMf4RWYvzMIdFMXcBYqskgLViuuDCaDKUiIyaYojhxLKMiY9Aw5iYhuWIxG3LBYqKNKiJTKKY75GUuBdFFFDGth0VqV+ZSEDkktFwzJCZhCKpiplBCE0oKwT8UjLRacvCeRWY3brXIjzHTfCSoYTEA54ef8fhBSMYJjxISUUEGDLYaw04dwKwG7oBCmxS4ps5ZxIccOrvJOmQ7jjnASNN0EhJKWq1Cpa0W4ZrkSl7wmMV+NTkcAkopopZwYZga0oghrhjMIka4jJ+cUBGTIY14yk0TjSTm2ig+KGDlzok4EUc83yIv81TSmExkocjBz79U3Y0k8O241fqZDYoRebnbap3+mBiT662VFZrnHZkzAdhK6UB3IpmtxNAxj4eIK6YYzIr4YlTzdEJoHJMxj0fMaDwQQSKZT0gkpYq5sKSR0xEjosgGTOkQd5NJxQgXhBLFaDxpG9kuNCNPD/f3AA0ZNR1ykBY6LJeLuWKRSSd2ekCP39UP9nQ21oCGuBiFJKPngCVuyIeCR+ewbc0EHq0jGcRVq/Ua4C2xw7Wj8ZgQk3BNxmyQSHlO2AU0j3maEqP4aMRUq3Uifv/99xNxdSIIOQmwx0mwRU4CN8VJENomM8mZbfl5//HL5zt7R2dHbw92ynZPqVN9dn8uewx5Oj3DyxfPymZBs+nmve3n1QJCGtd+kDKqGVHsgrMxngMctd2rx0I5rCYn7OiyBQYxpeHrMXwh5Mr+04TmcPfJ3s6LOiy2B8soTxtddp5v7z5r9MkTKZrTHPy6v9ecp1C1WXb3nlik2PZr+OfUwetOZNsd0NHu853Do+3nB9D52p0jUMNhkedSwfG/tgS9Bcd8In5iqRwTqhhSTySzTAqSU0UzZlA2JtRgs2IfCq5YbIUbTVPPGVsnok1aLSCFrVaL7IqYR8Aals0nOQPJZvt2bFdgGeh66ESN7VpjJJBFVpwAh4yp5e48BUECXRUDKWX4BWtOfBmSCUz8MwO6sNMmUvGPUhiaIlFcMGV4RNM6EwOAKPoMVSiCcsmF8V/dCuStY1bgZWRRJ2UAtBiQlXGBLZqRC5oWTDuoxiFJAKoXLFdMo8R18wIiRUwSxkfJwvVo/L7QpjExKbSXox4Kt5Y/JUQvQ7QNaaoZ4cMGLjN6zmqrEZlb+d4hP01IzIa0SE1IOMgfowrWIXvSEJrnKY/wbgRxbi+eQrE2nrIjBwcIsAoAcWDvB7gRYg53A0gbaMQp3BgPHdCZvVBgeyhHTUIFkWLqoCOZSjVLQvi5iUcSSWGYMB2yfUF5isDbzWrCRZQWMSODlEbnId7sIVFwl8GpTFiaynFo6R274A2LOEf8EM1SoEIpAH4h3fJcV3dohxyB/Cn5CRo9qnERrutYdTJ8KGFlQIFnMYJyJUTEheS9HBDDTcpCYNiciklIYqs0sEszkJchiRIWneNfisZckkFhjBR2Y7GSeSzHwuFyKIXR/OMcjvQtn47RfkjWQrIRks2Q9Loh6fVD0lsLSW8jJL3NkPS7Ien3Q9JfC0l/w4LV33S4piWC6wD0+hbL5vvBLsjdZ1wjZ4PA1KUMHjdkcK9DWq2Sm6av3+qOLbuUtxXITGjrud+X8GO1/9D9nMDPjf6m+znGrr019zOBn/1e/Z7oIySGZvkNUEDzvULglQVLRPDN3bkngZdn8BEEUegbqqvYwQMN1/W9rMJeuOCG01Qv3o7v8Q3tqAJpZlNrsCkk18U7cjrIN7OdOjyosoCYtE0oVmtNnuERiv7M7tc77mZZvHm77Dez9xo4X7b1Ddg6iKYjEE2L919Kr28ICdMwfRkmHnZQAUDJvBgPrsM3hIUmRF+Gg03AAVxKixEArd/Q7mvgWAMMb3jb1l1r99bb/W5/rYEBsJRthyxrx3F7MpncB/ZA53HLg8rjNVSr2YFHYqhkNsf8QOug6uV0Ivzbq+zPQVEfsNIpAl6Apk/F2/91LdvImE5+0HYqP7RUzqB/pZpNamBiE8CBvpAokTxywEMfr5INwMDrAA7aiMmVOF6pYRI+xnE7y9pTH+FnGxFf+5hlnTjuTPWcOR37MSNxHJLZz3O/xzHJsmzBZ/u98Xkly2Z30ckyBxsqX4+ASZzOtphPXIevxSoVRzQXvpGNwI8kRYprozk3n4+mLpuEe7eNIyoy1UGxUZFSxS7BLtXTvpB75DHPYpVmj3YsmoDWGYioID/uO+39gSN/2EJzAvhy+7iZncEk2869SxQbsUuSU2OYEjjZBU15bN2wbeuqvKRZDibAyt9PTuK//fsKOiDAxjcEToLEfMTBK7jy9+Pt9rvTOT2KPGcqAp9UymAlHRJmog45TliaV47J8XjcGa/qKJEytV7J91qxof3/mRy8P0Nw8w7V+YN5O7WkUTP4gXSm7X3NTANjVBM/co7JjzSGPNTr4m3r7J0brlvX4xu6caZAgkbrPbG+vSCjqJAAKbPqb2kSpk6C03KMNfJZfMvY0zswa8JjltIBS2eb7sxo5eeUTmTh+Ns7tZpbdRRdwxs0ZFyUfgvcTrfmdszo5VTjSeVynOJvi5A6d/orx7OnPwGScu09N0101kc71xY6HAWzjxUDRvwAMiip9Iu5oATsbmxgJZE7u1uWgH4EO5ZuRb/aLSs0DqaOGJgj44JnRVb6R4flrB5lmdM96viCkfAO41eon+7MCvTylhXcQ9KCBU5ED/0Y3v9xg2bqenxDsmIKpJvZ+HOkSOOevqcL9nYG9NuqM+Ccaxm62gu5ZD69mPs6ZB+uN/DJ2kHgZYsilhvwyH0pa5Yg3/mGQp9V3Q+3mPLqvb4h6psD1p9Mga7ffd8+n0Wk9d1/R4TaAPvOxGqdkhkd3WC5Y/M3RJ4OnhknRKt1oNgQHo6rJ0XiP/mXHXjSYSnL3LOXe0yEqw4d4VwYCWaBf6YesCG+nuODtU5o9eBo7xl7pPUXcvusLRVJqLb6Nyr8cFTwfG8Slk254j1olTueCw83nErv/uzG/qNu/Zx6G+uNc1rvNs6pu+icbjAb4QR1LoUufW2saqrxtSpf7edeLdNs6yeFI92BII7SerDMIIs0Jik/x1eVmOs8pRM4Vc+lDsrp57rHiZS66uFezH50G95qvsRJBY9xDzrlw8RdHF5Th1E7i97D1dpRrG9uNjmmwTB3sd+r9WZPobu20ltfsR6t+Q6tyg2zWAjfoAkQcpfzQj/Rnc4Le1YHtnQ7fa7b6X7IffU+re7ew37jsljtfu5lce/GdZ1rbjGr78N4vjcrts5ud7Rfv5od+eXUt/ZnaNS9h6t1KnzYuwcX6gLF+UspcUY/vjfaI/elHM8jwDtoxzeqxF9MoHVg/3QiXb8fTbrXbWhojxoK2qN+nSjX1+9ElPVFpyjrJOCvftp/Me7+9mQkt7e3t/cOXyY7L0fb29sZ/O50OnONqHmnjcuA5uriQ929jHf8glU6nQ6gMKaGbuHwlVyM/sOODxeP6bjX5z/Js7N+H48pcxw4Xy4Fyq5/nbfmz+PzL+XAIAxkjqHvUuzGwVYQQ4C9D+sOQrQsmTY/yXgSbF0FLmoM/nQxWTBy5b2GUP2rQEcJyyj85S1SCO6H6OAg9EG5QRhgGAFE+gPRBVsuwDgI4YkrBz8E0zAHjtu68r1s7HQQOh082Aos0Qdh4B56yk+EiUjC020eD4Nrv+BNU5Vfqqk0/lHGuMM8EJD6mdPg0Oup5IbPmqk+w3WF1moyqhSdBNN5FD4S1T8j2nFlqF068XcDN+AJKcMjsVsQBtywrL7KgkNT8tMxHTEJO8EQo08di8dCs09eE8ZhDPfnDHTOhzk4vyOWbOvsws0j24YYRxZ7pbRdBeuGBAPmOrdRjO+Pu6Wj+pr2iWBmzaNFQdy12FGdoCVK85xR1cFY6s9O2sC8HZpGBeaRlFKxsbMS1HJnveswuLx9M5ckkm0fIU5+TNnQ2BddEkklmHpQDxP5ZjbXX1u7DoPJ7dubfJfbewiHN759d68xtL5KO/grYF3dvA6D5HZYfy2D//9CYNc2rqu7zuWUlLlkAxlPzrzcur6to79UoB8kJu2KfRUzVUPEQMqUUTGDid2hda5L8gMYHD+ENo4CY7a50v5CsblKikUM8j8wvMrLKuJ0DhvQTVwcLfjkd+ADakm6GGjoJfx82k44YD7/CRL2bA9uE97QAc1olECmlYvuoEPvZMsh5UgW2oMHfmiI9UsZuJZNwrhNleBi1DSKathBb3d975366cAXuOQwaXH/6OAOuESLrW2zn+w9bXdp5yD7RweQCcOHTg3rkJe6xIRHLW10IaAWkQtOfbR8Kdsn9u2ZWbej9HlXlYu+43JQ2mQWoJjruRCFEDFvw/TLJM2ZiavEOTgiWRhw+btMRaINy3UDjwhFicgjWdyFKm/BJCWjAkP9DLCsT4vBaJ8qk4ULmwGK6n5cKJ+848gCekI6aIUnjxXoVJs/JExoO5ySIdWGqRDSQgHzqgDlvpySXeZMcSYiNhcFilnUnRVqrt7UxEEzLeTli2cuXdLvwTPlADjQTsxiUuRINcgJZbqSP7nprc8oSsAdTJ0tUtBmVQ9MKnKeiJwpDSm1ikg1ooJ/dCm2oJGAsTNgCU1tVycqwGMN8ACHN4HxsvaPf/6rBtdCjXMWMLsCjWOIRbsFQrToLMGDxq1YDhJQNiGC+Zj6z+lLAKBDpjnLZFwykr47jR9g9Jou5aJ7Qiuf73QRJaDgl/JWh17GaqdWajQR0Y7EN7gc9ssuuTa1hBsfFjsrH14wwGNUgwHVEOBqoHkxqTN49awop6bDtCDeTNYqr8EZXqCFkWeKZVzc7Z6qO8WMLAVBYWRGDY+In0p3mil49uXF83UGudsWNKDGCy7VgwWsCtOdSRGxMy7O2AVTd1Dw9sownphOgLjNmDFRh80jyV5nVZrUGPKGGzip3U6YDFiHch3MA/t2Os92udmQ9PRQJaqzbABv+PYVGFgNBYesbMmmMfS9WFPuOXRpS31Hxkav2/2/bEutdr8fW2qt+x3ZUpsArPOe3i6AFuk3c2WH9wbfPOC9RKcN+nFv7gle1uuw9F3PQ3DFDv1r+19l/nm5f4tJaG3Gyq3rzBm/GURDv9uFf6aEoK8R4itXVGVT0sm/BeHdfco3n4GvUnEzsn5K+r/qXGRRAjhboDdX3W8msbqvfIVNniaDJxHf5093X37c7e3xXb0rXqxHj3c3ds/zN68eP33UYZOnvaj/avKm/8q8fZ3q3feSR78+Td6JV3rweL14++adevtmV719/cLQ1+vbA5GIwZNfeDRZfz/od/mzx0+77173xoMnv3TfvXqUv8PJf+m+Oz/vRtne44HYhj752zf/xfff76w+/7jz8fnRzuXzj+mjDt378P7xZfTo+fnORvvdrmo/3x/89v6DyV+sx6t7b/jGJnvOXouj7rOoQQ1cpFywM3/UZ7jvMzhsS0lr8479UGbMJKgvYmkSJaHuSW7rexg1IXREuSCAOnWPVMCUuo1fPg2ymxCx1u2e9UokrM8iYVdgBD+WADqS50x83Z3Wlzd2eQD1MksroRVw2wnbg8Zm69/tJjWLCsXNJNg6vgou2zTnbdu+dXx6fRoGgFgJz0i51AgxNUmwFaxMvypBJSZ8szi+sjxYMpqmIoboiBlmozlfueh1esF1OD1mLnPe0J8V7U8dog0dcTG6bdxphaJDOEZ7Ug1EVTpuzn9joOS6c6j3CgMO5JMwCsYMYB6o40X1Frfjz9i/ks17+KrOcvopy79kNR6npu/hOc9NtdemY//Ug6835eNNUG0oKB9Y4M9SyT+uKLZ8nfAKdQ810f7aGqpsD3uo26xuotqwtnF9ahFcc0disGvdp2bjOhrOIfep6SwJginnRMNDMO0gWGisL7DV3ZJTNmkJyDxTcL1hgc3BltcgmriCyAfA1WoXcbXWRVxtdhvKi9thNUOlgqCeUaoZqEvUVQnQF06B/rgYSiReR1H7OROH4MkD2YLEP6NysjSSWVmwo9XyQ/7457/KUa1WafDTskLYfqFILsdMQWU1rCyWsksOVi1WfcuwTeNbJYZy0yxlWsMDpjBsZMuiQWIfuA+dgyqiOR1AdTJwf2G4MsY91uSv7pDXCYNQAmj6Qdk8xwuWgswt/QL1ymZjqc6HqRxDwTAygGI+4BliIqEisk4oKwnQmQJWMTj4csU11ChSADW3sElhFI0MyaigI/SGhKSOrJilHMQlUXIAPlot08J6IQ3lqVQ2Sg03hGEEiMSdyxyaUG8G951iCdDuhXNF6tC6gi2Tu5pnA/C65wALjxh6ZAqRSihPBt77Ik1JLo31qIN6XocRhhtFhQad2sLiz6BEmPMSMu1CuV9qBif8jItzW0SlTY5LunrNBpob1kyxnOa/B80xT7j5tRhAiSapuZFqUo0ecZMUAxTX9UnKH3amJ76sXk0YV3PEMtJztEAZ6RXIBl05ZAYoRK9sH+zibf+A/PGP/ybPGFWCJHJsqTUqFEsnVQU/LDaHJ2/RVl7W6IemBVSsM0ikYuSfRnRZHY6aP/7xP5rssTH44yxL2dCQg2KQ8qgsnahbrS3y2BZILGsiNlPCbKA+PA5QktvRKRfnHbItJrYSIL6hADHAdxzX2Aa69hdUJKzqEB7VVmeZZukFQz8pVAUaMKwviE8uShYju1odGLe5Zs4C7G07jkk+lbcAzroKHOuPwrcOah1TUMNvTqpDI6egWW2IiRjriuktgkpNNX84lcyAzx8zn3weRFUi0k5TK1MJmHQ7Lr/aUJ0pRaIpbxUbMgUL6kaBSJpzR07HnixJM3f508naGqbC0Ai1WH9J0pzPdWdDVTW9PzyE8puRt6oWcPQKdl4JwiDlEXNWsru/tp8cPCMXq51uENbUszsw98qz3cc7e4c7AAwIUouwXqfb6aIzT2qTUVFbCcuMloQ6fbXVwqCW1UmX1UmX1UmX1UmX1UmX1UmX1UmX1UmX1UmX1UmX1UmX1UnJsjrpsjrpV9r7sjrpsjrpsjrpsjrpsjrpsjrpsjrpsjrpsjrp17tvl9VJl9VJl9VJl9VJl9VJv6Oij8vqpF+DApfVSZfVSZfVSZfVSZfVSZfVSZfVSZfVST/ZebWsTrqsTrqsTrqsTrqsTrqsTrqsTvr/tDppLfltJU8pF7W0bZtdejxVs/Q0DBLIPt06Dq6ugPBeqvT6Gj5/KDDT7vg0DC6o4hCwhYmroU+0hGy7czYJtoLHNv6sfQTLh/acMcNhKl8XMkXtiG3c+o196wmyB/uHR0EYDFxd1UzGmMpPx5CdR8c2QbGWwoffroKUilGB6X+BnfPalr5Jmoml55hY6v6o5RBSMalB2Mw4tduA/8Om5g64urJJq9fXZX/btHCEQ6zvDcd3en19/b8O1iW8","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Resend request mail","permalink":"/docs/API-docs/v1.1/resendrequestmail"},"next":{"title":"Create Template","permalink":"/docs/API-docs/v1.1/createtemplate"}}');var i=t(74848),r=t(28453),o=t(33617),l=t.n(o),d=t(17543),a=t.n(d),c=t(86013),p=t.n(c),h=t(63723),u=t.n(h),m=(t(18766),t(79329),t(9303));const x={id:"drafttemplate",title:"Draft Template",description:"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.",sidebar_label:"Draft Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztPNtyG7eSv4Kd2qrEPEOKpC6WtS+rOIojx5a0lnyVdBRwBuTAmgHGAEYUrVLVeTh/sE/7ej4tX7LVDWAuvEiyrTj2LvMQi4Nbo9Hd6G5091Vg6EgHW8fBEcvylBqmg9MwiJmOFM8NlyLYCo4SRnwz+VnRoeFiRLYPdgkTdJAyTQrNlCZGkkgx6BQV2siMf4RWYvzMIdFMXcBYqskgLViuuDCaDKUiIyaYojhxLKMiY9Aw5iYhuWIxG3LBYqKNKiJTKKY75GUuBdFFFDGth0VqV+ZSEDkktFwzJCZhCKpiplBCE0oKwT8UjLRacvCeRWY3brXIjzHTfCSoYTEA54ef8fhBSMYJjxISUUEGDLYaw04dwKwG7oBCmxS4ps5ZxIccOrvJOmQ7jjnASNN0EhJKWq1Cpa0W4ZrkSl7wmMV+NTkcAkopopZwYZga0oghrhjMIka4jJ+cUBGTIY14yk0TjSTm2ig+KGDlzok4EUc83yIv81TSmExkocjBz79U3Y0k8O241fqZDYoRebnbap3+mBiT662VFZrnHZkzAdhK6UB3IpmtxNAxj4eIK6YYzIr4YlTzdEJoHJMxj0fMaDwQQSKZT0gkpYq5sKSR0xEjosgGTOkQd5NJxQgXhBLFaDxpG9kuNCNPD/f3AA0ZNR1ykBY6LJeLuWKRSSd2ekCP39UP9nQ21oCGuBiFJKPngCVuyIeCR+ewbc0EHq0jGcRVq/Ua4C2xw7Wj8ZgQk3BNxmyQSHlO2AU0j3maEqP4aMRUq3Uifv/99xNxdSIIOQmwx0mwRU4CN8VJENomM8mZbfl5//HL5zt7R2dHbw92ynZPqVN9dn8uewx5Oj3DyxfPymZBs+nmve3n1QJCGtd+kDKqGVHsgrMxngMctd2rx0I5rCYn7OiyBQYxpeHrMXwh5Mr+04TmcPfJ3s6LOiy2B8soTxtddp5v7z5r9MkTKZrTHPy6v9ecp1C1WXb3nlik2PZr+OfUwetOZNsd0NHu853Do+3nB9D52p0jUMNhkedSwfG/tgS9Bcd8In5iqRwTqhhSTySzTAqSU0UzZlA2JtRgs2IfCq5YbIUbTVPPGVsnok1aLSCFrVaL7IqYR8Aals0nOQPJZvt2bFdgGeh66ESN7VpjJJBFVpwAh4yp5e48BUECXRUDKWX4BWtOfBmSCUz8MwO6sNMmUvGPUhiaIlFcMGV4RNM6EwOAKPoMVSiCcsmF8V/dCuStY1bgZWRRJ2UAtBiQlXGBLZqRC5oWTDuoxiFJAKoXLFdMo8R18wIiRUwSxkfJwvVo/L7QpjExKbSXox4Kt5Y/JUQvQ7QNaaoZ4cMGLjN6zmqrEZlb+d4hP01IzIa0SE1IOMgfowrWIXvSEJrnKY/wbgRxbi+eQrE2nrIjBwcIsAoAcWDvB7gRYg53A0gbaMQp3BgPHdCZvVBgeyhHTUIFkWLqoCOZSjVLQvi5iUcSSWGYMB2yfUF5isDbzWrCRZQWMSODlEbnId7sIVFwl8GpTFiaynFo6R274A2LOEf8EM1SoEIpAH4h3fJcV3dohxyB/Cn5CRo9qnERrutYdTJ8KGFlQIFnMYJyJUTEheS9HBDDTcpCYNiciklIYqs0sEszkJchiRIWneNfisZckkFhjBR2Y7GSeSzHwuFyKIXR/OMcjvQtn47RfkjWQrIRks2Q9Loh6fVD0lsLSW8jJL3NkPS7Ien3Q9JfC0l/w4LV33S4piWC6wD0+hbL5vvBLsjdZ1wjZ4PA1KUMHjdkcK9DWq2Sm6av3+qOLbuUtxXITGjrud+X8GO1/9D9nMDPjf6m+znGrr019zOBn/1e/Z7oIySGZvkNUEDzvULglQVLRPDN3bkngZdn8BEEUegbqqvYwQMN1/W9rMJeuOCG01Qv3o7v8Q3tqAJpZlNrsCkk18U7cjrIN7OdOjyosoCYtE0oVmtNnuERiv7M7tc77mZZvHm77Dez9xo4X7b1Ddg6iKYjEE2L919Kr28ICdMwfRkmHnZQAUDJvBgPrsM3hIUmRF+Gg03AAVxKixEArd/Q7mvgWAMMb3jb1l1r99bb/W5/rYEBsJRthyxrx3F7MpncB/ZA53HLg8rjNVSr2YFHYqhkNsf8QOug6uV0Ivzbq+zPQVEfsNIpAl6Apk/F2/91LdvImE5+0HYqP7RUzqB/pZpNamBiE8CBvpAokTxywEMfr5INwMDrAA7aiMmVOF6pYRI+xnE7y9pTH+FnGxFf+5hlnTjuTPWcOR37MSNxHJLZz3O/xzHJsmzBZ/u98Xkly2Z30ckyBxsqX4+ASZzOtphPXIevxSoVRzQXvpGNwI8kRYprozk3n4+mLpuEe7eNIyoy1UGxUZFSxS7BLtXTvpB75DHPYpVmj3YsmoDWGYioID/uO+39gSN/2EJzAvhy+7iZncEk2869SxQbsUuSU2OYEjjZBU15bN2wbeuqvKRZDibAyt9PTuK//fsKOiDAxjcEToLEfMTBK7jy9+Pt9rvTOT2KPGcqAp9UymAlHRJmog45TliaV47J8XjcGa/qKJEytV7J91qxof3/mRy8P0Nw8w7V+YN5O7WkUTP4gXSm7X3NTANjVBM/co7JjzSGPNTr4m3r7J0brlvX4xu6caZAgkbrPbG+vSCjqJAAKbPqb2kSpk6C03KMNfJZfMvY0zswa8JjltIBS2eb7sxo5eeUTmTh+Ns7tZpbdRRdwxs0ZFyUfgvcTrfmdszo5VTjSeVynOJvi5A6d/orx7OnPwGScu09N0101kc71xY6HAWzjxUDRvwAMiip9Iu5oATsbmxgJZE7u1uWgH4EO5ZuRb/aLSs0DqaOGJgj44JnRVb6R4flrB5lmdM96viCkfAO41eon+7MCvTylhXcQ9KCBU5ED/0Y3v9xg2bqenxDsmIKpJvZ+HOkSOOevqcL9nYG9NuqM+Ccaxm62gu5ZD69mPs6ZB+uN/DJ2kHgZYsilhvwyH0pa5Yg3/mGQp9V3Q+3mPLqvb4h6psD1p9Mga7ffd8+n0Wk9d1/R4TaAPvOxGqdkhkd3WC5Y/M3RJ4OnhknRKt1oNgQHo6rJ0XiP/mXHXjSYSnL3LOXe0yEqw4d4VwYCWaBf6YesCG+nuODtU5o9eBo7xl7pPUXcvusLRVJqLb6Nyr8cFTwfG8Slk254j1olTueCw83nErv/uzG/qNu/Zx6G+uNc1rvNs6pu+icbjAb4QR1LoUufW2saqrxtSpf7edeLdNs6yeFI92BII7SerDMIIs0Jik/x1eVmOs8pRM4Vc+lDsrp57rHiZS66uFezH50G95qvsRJBY9xDzrlw8RdHF5Th1E7i97D1dpRrG9uNjmmwTB3sd+r9WZPobu20ltfsR6t+Q6tyg2zWAjfoAkQcpfzQj/Rnc4Le1YHtnQ7fa7b6X7IffU+re7ew37jsljtfu5lce/GdZ1rbjGr78N4vjcrts5ud7Rfv5od+eXUt/ZnaNS9h6t1KnzYuwcX6gLF+UspcUY/vjfaI/elHM8jwDtoxzeqxF9MoHVg/3QiXb8fTbrXbWhojxoK2qN+nSjX1+9ElPVFpyjrJOCvftp/Me7+9mQkt7e3t/cOXyY7L0fb29sZ/O50OnONqHmnjcuA5uriQ929jHf8glU6nQ6gMKaGbuHwlVyM/sOODxeP6bjX5z/Js7N+H48pcxw4Xy4Fyq5/nbfmz+PzL+XAIAxkjqHvUuzGwVYQQ4C9D+sOQrQsmTY/yXgSbF0FLmoM/nQxWTBy5b2GUP2rQEcJyyj85S1SCO6H6OAg9EG5QRhgGAFE+gPRBVsuwDgI4YkrBz8E0zAHjtu68r1s7HQQOh082Aos0Qdh4B56yk+EiUjC020eD4Nrv+BNU5Vfqqk0/lHGuMM8EJD6mdPg0Oup5IbPmqk+w3WF1moyqhSdBNN5FD4S1T8j2nFlqF068XcDN+AJKcMjsVsQBtywrL7KgkNT8tMxHTEJO8EQo08di8dCs09eE8ZhDPfnDHTOhzk4vyOWbOvsws0j24YYRxZ7pbRdBeuGBAPmOrdRjO+Pu6Wj+pr2iWBmzaNFQdy12FGdoCVK85xR1cFY6s9O2sC8HZpGBeaRlFKxsbMS1HJnveswuLx9M5ckkm0fIU5+TNnQ2BddEkklmHpQDxP5ZjbXX1u7DoPJ7dubfJfbewiHN759d68xtL5KO/grYF3dvA6D5HZYfy2D//9CYNc2rqu7zuWUlLlkAxlPzrzcur6to79UoB8kJu2KfRUzVUPEQMqUUTGDid2hda5L8gMYHD+ENo4CY7a50v5CsblKikUM8j8wvMrLKuJ0DhvQTVwcLfjkd+ADakm6GGjoJfx82k44YD7/CRL2bA9uE97QAc1olECmlYvuoEPvZMsh5UgW2oMHfmiI9UsZuJZNwrhNleBi1DSKathBb3d975366cAXuOQwaXH/6OAOuESLrW2zn+w9bXdp5yD7RweQCcOHTg3rkJe6xIRHLW10IaAWkQtOfbR8Kdsn9u2ZWbej9HlXlYu+43JQ2mQWoJjruRCFEDFvw/TLJM2ZiavEOTgiWRhw+btMRaINy3UDjwhFicgjWdyFKm/BJCWjAkP9DLCsT4vBaJ8qk4ULmwGK6n5cKJ+848gCekI6aIUnjxXoVJs/JExoO5ySIdWGqRDSQgHzqgDlvpySXeZMcSYiNhcFilnUnRVqrt7UxEEzLeTli2cuXdLvwTPlADjQTsxiUuRINcgJZbqSP7nprc8oSsAdTJ0tUtBmVQ9MKnKeiJwpDSm1ikg1ooJ/dCm2oJGAsTNgCU1tVycqwGMN8ACHN4HxsvaPf/6rBtdCjXMWMLsCjWOIRbsFQrToLMGDxq1YDhJQNiGC+Zj6z+lLAKBDpjnLZFwykr47jR9g9Jou5aJ7Qiuf73QRJaDgl/JWh17GaqdWajQR0Y7EN7gc9ssuuTa1hBsfFjsrH14wwGNUgwHVEOBqoHkxqTN49awop6bDtCDeTNYqr8EZXqCFkWeKZVzc7Z6qO8WMLAVBYWRGDY+In0p3mil49uXF83UGudsWNKDGCy7VgwWsCtOdSRGxMy7O2AVTd1Dw9sownphOgLjNmDFRh80jyV5nVZrUGPKGGzip3U6YDFiHch3MA/t2Os92udmQ9PRQJaqzbABv+PYVGFgNBYesbMmmMfS9WFPuOXRpS31Hxkav2/2/bEutdr8fW2qt+x3ZUpsArPOe3i6AFuk3c2WH9wbfPOC9RKcN+nFv7gle1uuw9F3PQ3DFDv1r+19l/nm5f4tJaG3Gyq3rzBm/GURDv9uFf6aEoK8R4itXVGVT0sm/BeHdfco3n4GvUnEzsn5K+r/qXGRRAjhboDdX3W8msbqvfIVNniaDJxHf5093X37c7e3xXb0rXqxHj3c3ds/zN68eP33UYZOnvaj/avKm/8q8fZ3q3feSR78+Td6JV3rweL14++adevtmV719/cLQ1+vbA5GIwZNfeDRZfz/od/mzx0+77173xoMnv3TfvXqUv8PJf+m+Oz/vRtne44HYhj752zf/xfff76w+/7jz8fnRzuXzj+mjDt378P7xZfTo+fnORvvdrmo/3x/89v6DyV+sx6t7b/jGJnvOXouj7rOoQQ1cpFywM3/UZ7jvMzhsS0lr8479UGbMJKgvYmkSJaHuSW7rexg1IXREuSCAOnWPVMCUuo1fPg2ymxCx1u2e9UokrM8iYVdgBD+WADqS50x83Z3Wlzd2eQD1MksroRVw2wnbg8Zm69/tJjWLCsXNJNg6vgou2zTnbdu+dXx6fRoGgFgJz0i51AgxNUmwFaxMvypBJSZ8szi+sjxYMpqmIoboiBlmozlfueh1esF1OD1mLnPe0J8V7U8dog0dcTG6bdxphaJDOEZ7Ug1EVTpuzn9joOS6c6j3CgMO5JMwCsYMYB6o40X1Frfjz9i/ks17+KrOcvopy79kNR6npu/hOc9NtdemY//Ug6835eNNUG0oKB9Y4M9SyT+uKLZ8nfAKdQ810f7aGqpsD3uo26xuotqwtnF9ahFcc0disGvdp2bjOhrOIfep6SwJginnRMNDMO0gWGisL7DV3ZJTNmkJyDxTcL1hgc3BltcgmriCyAfA1WoXcbXWRVxtdhvKi9thNUOlgqCeUaoZqEvUVQnQF06B/rgYSiReR1H7OROH4MkD2YLEP6NysjSSWVmwo9XyQ/7457/KUa1WafDTskLYfqFILsdMQWU1rCyWsksOVi1WfcuwTeNbJYZy0yxlWsMDpjBsZMuiQWIfuA+dgyqiOR1AdTJwf2G4MsY91uSv7pDXCYNQAmj6Qdk8xwuWgswt/QL1ymZjqc6HqRxDwTAygGI+4BliIqEisk4oKwnQmQJWMTj4csU11ChSADW3sElhFI0MyaigI/SGhKSOrJilHMQlUXIAPlot08J6IQ3lqVQ2Sg03hGEEiMSdyxyaUG8G951iCdDuhXNF6tC6gi2Tu5pnA/C65wALjxh6ZAqRSihPBt77Ik1JLo31qIN6XocRhhtFhQad2sLiz6BEmPMSMu1CuV9qBif8jItzW0SlTY5LunrNBpob1kyxnOa/B80xT7j5tRhAiSapuZFqUo0ecZMUAxTX9UnKH3amJ76sXk0YV3PEMtJztEAZ6RXIBl05ZAYoRK9sH+zibf+A/PGP/ybPGFWCJHJsqTUqFEsnVQU/LDaHJ2/RVl7W6IemBVSsM0ikYuSfRnRZHY6aP/7xP5rssTH44yxL2dCQg2KQ8qgsnahbrS3y2BZILGsiNlPCbKA+PA5QktvRKRfnHbItJrYSIL6hADHAdxzX2Aa69hdUJKzqEB7VVmeZZukFQz8pVAUaMKwviE8uShYju1odGLe5Zs4C7G07jkk+lbcAzroKHOuPwrcOah1TUMNvTqpDI6egWW2IiRjriuktgkpNNX84lcyAzx8zn3weRFUi0k5TK1MJmHQ7Lr/aUJ0pRaIpbxUbMgUL6kaBSJpzR07HnixJM3f508naGqbC0Ai1WH9J0pzPdWdDVTW9PzyE8puRt6oWcPQKdl4JwiDlEXNWsru/tp8cPCMXq51uENbUszsw98qz3cc7e4c7AAwIUouwXqfb6aIzT2qTUVFbCcuMloQ6fbXVwqCW1UmX1UmX1UmX1UmX1UmX1UmX1UmX1UmX1UmX1UmX1UmX1UnJsjrpsjrpV9r7sjrpsjrpsjrpsjrpsjrpsjrpsjrpsjrpsjrp17tvl9VJl9VJl9VJl9VJl9VJv6Oij8vqpF+DApfVSZfVSZfVSZfVSZfVSZfVSZfVSZfVST/ZebWsTrqsTrqsTrqsTrqsTrqsTrqsTvr/tDppLfltJU8pF7W0bZtdejxVs/Q0DBLIPt06Dq6ugPBeqvT6Gj5/KDDT7vg0DC6o4hCwhYmroU+0hGy7czYJtoLHNv6sfQTLh/acMcNhKl8XMkXtiG3c+o196wmyB/uHR0EYDFxd1UzGmMpPx5CdR8c2QbGWwoffroKUilGB6X+BnfPalr5Jmoml55hY6v6o5RBSMalB2Mw4tduA/8Om5g64urJJq9fXZX/btHCEQ6zvDcd3en19/b8O1iW8",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},j=void 0,g={},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)(m.default,{as:"h1",className:"openapi__heading",children:"Draft Template"}),"\n",(0,i.jsx)(l(),{method:"post",path:"/drafttemplate",context:"endpoint"}),"\n",(0,i.jsxs)(n.p,{children:["The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique ",(0,i.jsx)(n.strong,{children:"objectId"})," (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a ",(0,i.jsx)(n.strong,{children:"url"})," is provided, which offers a user interface for editing the template and facilitating document distribution."]}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"When document is created this webhook event will trigger"})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "event": "created",\n "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:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,i.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document before it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date"\n "page": 1\n "x": 173\n "y": 588\n "w": 114\n "h": 21\n "options": {\n "name": "date"\n "response": "04/15/2024"\n "format": "mm/dd/yyyy"\n "color": "black"\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 528,\n "w": 114,\n "h": 21,\n "options": {\n "name": "dropdown",\n "values": ["male", "female", "other"],\n "response": "female",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(a(),{parameters:void 0}),"\n",(0,i.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"sample note"},description:{type:"string",format:"string",example:"sample description"},signers:{type:"array",description:"You can provide signer optionally if you it as default signer",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:""},name:{type:"string",format:"string",example:""},phone:{type:"string",format:"string",example:""},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"createtemplate_body_signers"}},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5},prefill:{type:"object",description:"You can provide widgets which can embed before sending to signer",properties:{widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"textbox"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:100},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},title:"createtemplate_body"}}},required:!0}}),"\n",(0,i.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Template created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bh2Hspnmch"},url:{type:"string",example:"https://app.opensignlabs.com/drafttemplate/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2VtYWlsIjoicHJhZnVsbC5uYXZrYXIrYWRtaW5AbnhnbGFicy5jb20iLCJ0ZW1wbGF0ZV9pZCI6IkF0Zkk0cmNCbnAiLCJpYXQiOjE3MzEzMTExMzl9.aNqjCxc9MkE6-ZIr-MObKjqtpR5d3NXi68eMeWnT0Lc"}},title:"inline_response_draft_200"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/c7e3ab5f.786c2d78.js b/assets/js/c7e3ab5f.786c2d78.js deleted file mode 100644 index dabb9a6c9..000000000 --- a/assets/js/c7e3ab5f.786c2d78.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4833],{86690:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>k,contentTitle:()=>y,default:()=>b,frontMatter:()=>u,metadata:()=>n,toc:()=>A});const n=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":"eJzVV19v4zYS/ypTvrQbKLaTTVucni63DbbBBd2gSRGgWSOgxLHEmiJZkrJjGAL60G9wT/d6H20/yWFISbaT7F4XdyhwL4k1nL+/Gc4MtyzwyrP8nr0xOvAyeDbPmEBfOmmDNJrl7LZG+A4VBoSeCc6vL4ErZdYeNqaFYMBhY1YIHMqeZeFMQ4duoBTGLCdwuYgS2oAyukIHGlEAB8tdkGWr+Mj/pQepF8Y1nPzIINTSR8MNX6IHGQC535BtkZwLNUoHDkvjxIRlzFh0UfZSsJwlpl43y5jljjcY0FH0W6Z5gyxn/fmDFCxjkqK3PNTsKSTXzqykQDDFL1iGSwFmMQY+OsQy5vDXVjoULA+uxYz5sFFkxsvGKmLAR6uMQJYvuPLEUNbYcJZvWdjYyBmc1BXLWEJin4KPPGrJma1Pi/qUe8G6bk5WvTXaoyc9p7MZ/Tv0f8hjclSAb8sSvV+0Sm2+YFmEAXUgQW6tkmXEcfqLJ+ntcy8TDoSqI9SDTLYHeF6KZ+f93x7Jd/u9fc26rM+TOA+fFjqdnb4+Ppkdz769PfkmP/tL/vU3k9ls9jPL2GOjSLbPqOABSW+QQe2+u2dsKWX7jD2lI+azl1C8MQ2GWuoK1qgDrJ3RVQZWIfcIwW2AV1xqUDyg+x+iis4Z92l0Ps+zbi9qqZXU+DCU0MPZbPZwMoJw9vFS0ibAwrRa/LmRvmD+0+GcPZyO4Xz9PJxLveJKithobs0S9Z8bzr75kMw/r1WZmOI5Owh2n56C9Fi2ToZNbHKPx9zK43Se38+pV1CdmF1/jI0x1Cxn076fTbe7ntgxUuhWQ9NsnWI5q0OwPp9OPdeiMI8TY1F7WWnFCz8pTTPlVk5XJ5MT1mVPZbi1n8WP7fHnivjAK6mr/yQ332F1Q/lMKTtAbEwct/LvuGHZkJB9rn5s1MgFupg8mmJRuE/TO4v6RlY6Jjkafzpe7lCVpkEaJaFGGAQ+/P6vKCNM2TaoQ6zCqOGL9/q9ftc6sGaNbtEq4FrAQuGjLBRGIWzi2TiwPfJGofdqA1IHrBwPCEJWMnAFhBF1j5JbXkglqYKJzaSJvncJ/ATuagw1Ojr60tEKIHCFigofeBsMzW9djU7D2rjlglaHDDgUrZcavQfUNdclMQ5ZyMA44BpQB3TWSY/ggyOvZfLN6ODo6jdc8wpJd3YAlUAlqVTBmaL1AbxRbXQZApfKOBQwBERLiJ8QiBc0kB1CWlwa67CmklkhVK0U6DMojUDw8cJSCFpAgT6AJV9kiZ6UtlqZchmTRzMVrKH+IbmiRWHfRxIPjmtP4z35MuRgBMw6Q8MZk4NHRz95pAxfSb30+dHRe30M92NN3WHhZcD5V0P5r9frZ2X/6lDmrQzftwX8iNZ4GYzb7KQrGeq2iFdlX8n4kTS9RY2xfvYuwk6HMKV/fvOIOq1R2ekNBqoQPz2/vowt9xV8+O0fcIXcaajNOlVr2TpUG6gGU4RcynyCbeyYsDCx8GpCvEzFR3sY+jAgeFfz8OG3f3r4Adcg0xVKQB4dXbeFkiXcYmNpPPqjoxzeOCSTYaBBqHmAkmsoEHzNqZRWktMam6SV1MsJnOsNtB4drGWoYzEQPcodhEG4jOn2UHCPAoyOEoPNyc4jojce1Qo96aLJVyCgkLTJhdqZtkrW9p3pg3O4kErBnRQVhhjbuRBge/I6keMKu3MHF3QhQo0b4A7Bow4TuH4iEk9aa40jL2RyfmHojUAJQC2skTr4HITji7DTn+0KvSSY467/jJQg5CMcWa9mTEm6iX3EI3XynhrykyZ+2GsdLtCRwRj2Li9W9uV0P5QlULX+N2VNs3p4gNA60HCp0jT561M9cayja/y7xQ26lSyxn2gfudHTyDxlGVOyRO1xb104f3t9BavXkxnL9kbjH7jc06vLNxc/3FyQM9RIE2Ank9lkRiRrfGi43rN0+Ep8Ota2uz3q//ZN2S8AAR/D1Cou4/4VQd32i9M9270x873n5DxjtfGBGLZbuuI/OdV1RP61RUf72TxjK+4kL2hLuN8yIT39FuPj8KNofvVj/858BX/0ZfpiIMN6o2m3WXHV0hfL2BI3h2/jbt5lw4pDriaG87JEG/ZEny3LBxvndxdXF7cXLGPUrA+3q2XcrvofZOBFzw7XruQD/aUd8EWB7TZtbl038qejj0r0MQ7cBNO867p/A0zVDXo=","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":"Get Contact","permalink":"/docs/API-docs/v1.1/getcontact"},"next":{"title":"Get Contact list","permalink":"/docs/API-docs/v1.1/contactlist"}}');var a=o(74848),c=o(28453),i=o(33617),r=o.n(i),l=o(17543),s=o.n(l),d=o(86013),p=o.n(d),m=o(63723),j=o.n(m),f=(o(18766),o(79329),o(9303));const u={id:"deletecontact",title:"Delete Contact",description:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record.",sidebar_label:"Delete Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVV19v4zYS/ypTvrQbKLaTTVucni63DbbBBd2gSRGgWSOgxLHEmiJZkrJjGAL60G9wT/d6H20/yWFISbaT7F4XdyhwL4k1nL+/Gc4MtyzwyrP8nr0xOvAyeDbPmEBfOmmDNJrl7LZG+A4VBoSeCc6vL4ErZdYeNqaFYMBhY1YIHMqeZeFMQ4duoBTGLCdwuYgS2oAyukIHGlEAB8tdkGWr+Mj/pQepF8Y1nPzIINTSR8MNX6IHGQC535BtkZwLNUoHDkvjxIRlzFh0UfZSsJwlpl43y5jljjcY0FH0W6Z5gyxn/fmDFCxjkqK3PNTsKSTXzqykQDDFL1iGSwFmMQY+OsQy5vDXVjoULA+uxYz5sFFkxsvGKmLAR6uMQJYvuPLEUNbYcJZvWdjYyBmc1BXLWEJin4KPPGrJma1Pi/qUe8G6bk5WvTXaoyc9p7MZ/Tv0f8hjclSAb8sSvV+0Sm2+YFmEAXUgQW6tkmXEcfqLJ+ntcy8TDoSqI9SDTLYHeF6KZ+f93x7Jd/u9fc26rM+TOA+fFjqdnb4+Ppkdz769PfkmP/tL/vU3k9ls9jPL2GOjSLbPqOABSW+QQe2+u2dsKWX7jD2lI+azl1C8MQ2GWuoK1qgDrJ3RVQZWIfcIwW2AV1xqUDyg+x+iis4Z92l0Ps+zbi9qqZXU+DCU0MPZbPZwMoJw9vFS0ibAwrRa/LmRvmD+0+GcPZyO4Xz9PJxLveJKithobs0S9Z8bzr75kMw/r1WZmOI5Owh2n56C9Fi2ToZNbHKPx9zK43Se38+pV1CdmF1/jI0x1Cxn076fTbe7ntgxUuhWQ9NsnWI5q0OwPp9OPdeiMI8TY1F7WWnFCz8pTTPlVk5XJ5MT1mVPZbi1n8WP7fHnivjAK6mr/yQ332F1Q/lMKTtAbEwct/LvuGHZkJB9rn5s1MgFupg8mmJRuE/TO4v6RlY6Jjkafzpe7lCVpkEaJaFGGAQ+/P6vKCNM2TaoQ6zCqOGL9/q9ftc6sGaNbtEq4FrAQuGjLBRGIWzi2TiwPfJGofdqA1IHrBwPCEJWMnAFhBF1j5JbXkglqYKJzaSJvncJ/ATuagw1Ojr60tEKIHCFigofeBsMzW9djU7D2rjlglaHDDgUrZcavQfUNdclMQ5ZyMA44BpQB3TWSY/ggyOvZfLN6ODo6jdc8wpJd3YAlUAlqVTBmaL1AbxRbXQZApfKOBQwBERLiJ8QiBc0kB1CWlwa67CmklkhVK0U6DMojUDw8cJSCFpAgT6AJV9kiZ6UtlqZchmTRzMVrKH+IbmiRWHfRxIPjmtP4z35MuRgBMw6Q8MZk4NHRz95pAxfSb30+dHRe30M92NN3WHhZcD5V0P5r9frZ2X/6lDmrQzftwX8iNZ4GYzb7KQrGeq2iFdlX8n4kTS9RY2xfvYuwk6HMKV/fvOIOq1R2ekNBqoQPz2/vowt9xV8+O0fcIXcaajNOlVr2TpUG6gGU4RcynyCbeyYsDCx8GpCvEzFR3sY+jAgeFfz8OG3f3r4Adcg0xVKQB4dXbeFkiXcYmNpPPqjoxzeOCSTYaBBqHmAkmsoEHzNqZRWktMam6SV1MsJnOsNtB4drGWoYzEQPcodhEG4jOn2UHCPAoyOEoPNyc4jojce1Qo96aLJVyCgkLTJhdqZtkrW9p3pg3O4kErBnRQVhhjbuRBge/I6keMKu3MHF3QhQo0b4A7Bow4TuH4iEk9aa40jL2RyfmHojUAJQC2skTr4HITji7DTn+0KvSSY467/jJQg5CMcWa9mTEm6iX3EI3XynhrykyZ+2GsdLtCRwRj2Li9W9uV0P5QlULX+N2VNs3p4gNA60HCp0jT561M9cayja/y7xQ26lSyxn2gfudHTyDxlGVOyRO1xb104f3t9BavXkxnL9kbjH7jc06vLNxc/3FyQM9RIE2Ank9lkRiRrfGi43rN0+Ep8Ota2uz3q//ZN2S8AAR/D1Cou4/4VQd32i9M9270x873n5DxjtfGBGLZbuuI/OdV1RP61RUf72TxjK+4kL2hLuN8yIT39FuPj8KNofvVj/858BX/0ZfpiIMN6o2m3WXHV0hfL2BI3h2/jbt5lw4pDriaG87JEG/ZEny3LBxvndxdXF7cXLGPUrA+3q2XcrvofZOBFzw7XruQD/aUd8EWB7TZtbl038qejj0r0MQ7cBNO867p/A0zVDXo=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},y=void 0,k={},A=[];function P(e){const t={p:"p",...(0,c.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(f.default,{as:"h1",className:"openapi__heading",children:"Delete Contact"}),"\n",(0,a.jsx)(r(),{method:"delete",path:"/contact/{contact_id}",context:"endpoint"}),"\n",(0,a.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,a.jsx)(f.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,a.jsx)(s(),{parameters:[{name:"contact_id",in:"path",description:"Provide objectId of contact to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}]}),"\n",(0,a.jsx)(p(),{title:"Body",body:void 0}),"\n",(0,a.jsx)(j(),{id:void 0,label:void 0,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"}}}}}})]})}function b(e={}){const{wrapper:t}={...(0,c.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(P,{...e})}):P(e)}}}]); \ No newline at end of file diff --git a/assets/js/c7e3ab5f.cf9a081c.js b/assets/js/c7e3ab5f.cf9a081c.js new file mode 100644 index 000000000..555ade2bb --- /dev/null +++ b/assets/js/c7e3ab5f.cf9a081c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4833],{86690:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>k,contentTitle:()=>h,default:()=>g,frontMatter:()=>y,metadata:()=>n,toc:()=>f});const n=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":"Get Contact","permalink":"/docs/API-docs/v1.1/getcontact"},"next":{"title":"Get Contact list","permalink":"/docs/API-docs/v1.1/contactlist"}}');var a=o(74848),i=o(28453),c=o(33617),r=o.n(c),l=o(17543),s=o.n(l),d=o(86013),p=o.n(d),m=o(63723),u=o.n(m),v=(o(18766),o(79329),o(9303));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:"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},h=void 0,k={},f=[];function b(e){const t={p:"p",...(0,i.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(v.default,{as:"h1",className:"openapi__heading",children:"Delete Contact"}),"\n",(0,a.jsx)(r(),{method:"delete",path:"/contact/{contact_id}",context:"endpoint"}),"\n",(0,a.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,a.jsx)(v.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,a.jsx)(s(),{parameters:[{name:"contact_id",in:"path",description:"Provide objectId of contact to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}]}),"\n",(0,a.jsx)(p(),{title:"Body",body:void 0}),"\n",(0,a.jsx)(u(),{id:void 0,label:void 0,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"}}}}}})]})}function g(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/d0524430.86082012.js b/assets/js/d0524430.5aa106b8.js similarity index 53% rename from assets/js/d0524430.86082012.js rename to assets/js/d0524430.5aa106b8.js index 0df727a0c..f362b59ea 100644 --- a/assets/js/d0524430.86082012.js +++ b/assets/js/d0524430.5aa106b8.js @@ -1 +1 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6235],{74402:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>I,contentTitle:()=>E,default:()=>C,frontMatter:()=>v,metadata:()=>o,toc:()=>g});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":"eJztWc1uGzkSfpUKA+zuCG3JzniAhU6j8WgzwvpHsGUYC8twqO6SmmOK7CHZkgVBwBz2Dfa01320PMmiyO5WS3aUSTIwgkAX/ZBVxfr5WCSrlszxiWXtW3aDo1TrB3YXsQRtbETmhFaszQYpguUzBG0gzxLuEApa6PR7wKXUcwsLnYPTgZDDvCC4vjyFeSriFISF3GJCNM6IyQQN4AyVs82hGqrXr19D1/9t099G46gJM4FzTNqNxlAdwE2KCjhYMVFo/JQFDomO8ykqF4FLhQ0CYS6kLNdoDtW7d++GajlUAEPmCYasDUMWpA9ZFGbcIsMw8fPFyfVZ93xwP/hXv1vN69GvGLteskXT+7miGAu5LeH68rSaVny6PX3eOVsvoLQr5vsSuUUwSCoCV4m3OlhYGlyx1UIVuKuZ4CpLo7c0ArAMX5vaXPXenncv67oECpxyITdIumed3ukGTZZqtSmm/8vFeXfIAsmKvu4KdYK/f1p8UGRJ0ikCNOidda8GnbN+NR8b5O5ZgqFaFYEm7LxpQkG6CZ7SeYTFguAzgFNw7pHzUsj5I2HfFWNwqdH5JAWXIiSGjx04nGaSElmn39tD4CuDQI0mNzUpvfO3wSmfiRFKDd83wxGyIzOEeRgtquPmMxAShHzzAKHBAhgfg8XHQfGRrLCqr/wnnBLHTYj1NJO485yooUHKAg/2c1JGudQ3j4mv59xA48RYxLw086R7Oej9o3fSGXQ3HFXF5stB9UMTEoyl2JlhSoovzDGlmD2iXgpRpcd33mJLoi8DE4uYztBwckovYW1GD6u/hOdX+VKLmMHfcrTuJ50sWHu59W7rGz0TCUJuJL26wqqwZo61cqgcMfIsk7RRhFatXy1xL5mNU5xy+kWrCIMJvRKvjaQXIkGNtQtEsYhlhrR1Ai0x5EbSV0FknRFqwiI21mbKXX0EHzltPdZmqXOZbbdaC52bg+L1eJAb+WNB0oz1lK1WEXPCeYaC5n5Etq9WNGXQZlrZoMObw8OnLrnK4xitHecSKu9+iid2m23Q5tI9Z/nazvLlHCKZgK00kotXGwYKRTC6L426f3N4eP/3wtLjZ43TU3SpUBOY+yRitJpEkIWd6MwC+IQLBXTvNa/+PKvRGG12G/1pmu1ywvHh4f1R5YSjp06o/GskcGmQJwvAR2GdfVmTd+mx28Cj+3ll4PFTA68tGlDawVjnKnlZo7bX3m3IcWXGD0/N6KkZlyLxFaSBfkD1spbUl3dheVL1ceoTF50s3iRP5OfZhqn18WCkxTg3wi1Y+3bJHg94Jg7CfPv2bnUXMdoAmvJ4pq3XmLuUtVlrXqVji2aGxnoBPoFWOdFylYz0Y1NnqOhElHxkKR+2eCZas6PmEVtF2zw8yz6JHvODT2Wxjk+EmnyM727tnCsKYIjRhouqSPFM/BMXLCojUKeKmCDgpMgTND5ahIvL9QnYLaO7rejuM4XkjrVXoojvRYbqiq4rhA5vxHZJ9AZlrKfoi5kpQsnw/t//8zzlDcfD10t4RdfDi9xApudo6PyhO9FY4qMYSV+GAJz6uXUlFflUorVyAUI5nBg6vRMxEY6Hhwjl05hnfCSkIOgTmSZuA7XdY5t0BXUpGpr6q6HqbIIzlLRjgOdOT7kjUdUNda7Nw5hquhFwGOVWKLQWUKVcxURYRjOigjBXgMqhyYywCNYZ0loE3bRyhscOplzxCYY6bd1VCUpBkAejR7l1YLXMvcrguJDahGqxN0ghJqFS3H3MaApolC7uBlOC3gxhkosEbQSxTqhgTREmE1QCI7QOMtJFxGhJaK6kjh988OjohUxT4hFcgh5v6EjsznBl6fISdCljUDksM5rOcAwKNhrXFinCp0I92OIVcFth6gZHVji8+1uJzvl8/mT7fLfJ81a4X/IRXGKmrXDaLNbcE+HSfOS3XF1I9SdIeosKPX5qG2otI9GxfbqDabSVosxaV+gIIbbV6fd8rv4O3v/+HzhFbhSkeh7QGucG5QIm5VLkuRD54LYq1cJYe+Cl5PE4gK+4yJYevEm5e//7fy2c4xxE2ELBkY1GPx9JEcOgKOHZRqMNJ+FuW5b1LLiUO4i5ghGCTTlBaSY4cMgCtxTqoQkdtaCmhIG5cKE8SOOeb8MM/3Ypw21hxKmRoZXnKNdsrjWi8alFOUNLsujAHCFgIraLkXVlCuMMjunxdyOSCTpvWydJICuG52GYHF5TB8e0IVyKC+AGwaJyTehvsfiZPMu0IS1EUH6sqXlDAUCVZFpQ/6UokVbyozXQ/RNCaPXMUHAhr9wRbVVai51YWFyNNv1LZ+sw2My1BsdoaEFv9joumSjgdFvCEgitXwJrOgwoa/HY30H88zGcSj9uy/H3ATRTezG+QjMTcfmI+cCObnniFouYFDEqi7V7Rudt/xRm3zcPWVQ7uf7A5m6d9k6651ddUoYSaXDYUfOweUhDdNWYclVb6apo411vtPG2j7fl+iK2b/7tCyf75t++87Nv/u0hsG/+7Zt/++bfvvn39SWNffNvj6hvrPlXFEQdPrpWJrnwBeiirxZqx7dlC4z6cSlVldu3bLmk4sS1kasVDf+Wo6GS9F3EZtwIPqL65u3dKirLqFRsfsAFa7OT8OQ7GNDCRC7zUJHdqsNTHThwdOIYM7eTtl747l9cDVjERkWvcqoT4jF8Tn1MPmdt5nuevgDou2k0tmSSq0nOJ0QbZFLll6pHm2XjB182Ln6QVeWUWtQ03KwnBzPok4x6lmG5DCXp1aqiD1Mf5CgcW1JT4O5Wq9X/AfqGGmI=","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),d=t(33617),r=t.n(d),l=t(17543),a=t.n(l),c=t(86013),h=t.n(c),p=t(63723),u=t.n(p),m=(t(18766),t(79329),t(9303));const v={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:"eJztWc1uGzkSfpUKA+zuCG3JzniAhU6j8WgzwvpHsGUYC8twqO6SmmOK7CHZkgVBwBz2Dfa01320PMmiyO5WS3aUSTIwgkAX/ZBVxfr5WCSrlszxiWXtW3aDo1TrB3YXsQRtbETmhFaszQYpguUzBG0gzxLuEApa6PR7wKXUcwsLnYPTgZDDvCC4vjyFeSriFISF3GJCNM6IyQQN4AyVs82hGqrXr19D1/9t099G46gJM4FzTNqNxlAdwE2KCjhYMVFo/JQFDomO8ykqF4FLhQ0CYS6kLNdoDtW7d++GajlUAEPmCYasDUMWpA9ZFGbcIsMw8fPFyfVZ93xwP/hXv1vN69GvGLteskXT+7miGAu5LeH68rSaVny6PX3eOVsvoLQr5vsSuUUwSCoCV4m3OlhYGlyx1UIVuKuZ4CpLo7c0ArAMX5vaXPXenncv67oECpxyITdIumed3ukGTZZqtSmm/8vFeXfIAsmKvu4KdYK/f1p8UGRJ0ikCNOidda8GnbN+NR8b5O5ZgqFaFYEm7LxpQkG6CZ7SeYTFguAzgFNw7pHzUsj5I2HfFWNwqdH5JAWXIiSGjx04nGaSElmn39tD4CuDQI0mNzUpvfO3wSmfiRFKDd83wxGyIzOEeRgtquPmMxAShHzzAKHBAhgfg8XHQfGRrLCqr/wnnBLHTYj1NJO485yooUHKAg/2c1JGudQ3j4mv59xA48RYxLw086R7Oej9o3fSGXQ3HFXF5stB9UMTEoyl2JlhSoovzDGlmD2iXgpRpcd33mJLoi8DE4uYztBwckovYW1GD6u/hOdX+VKLmMHfcrTuJ50sWHu59W7rGz0TCUJuJL26wqqwZo61cqgcMfIsk7RRhFatXy1xL5mNU5xy+kWrCIMJvRKvjaQXIkGNtQtEsYhlhrR1Ai0x5EbSV0FknRFqwiI21mbKXX0EHzltPdZmqXOZbbdaC52bg+L1eJAb+WNB0oz1lK1WEXPCeYaC5n5Etq9WNGXQZlrZoMObw8OnLrnK4xitHecSKu9+iid2m23Q5tI9Z/nazvLlHCKZgK00kotXGwYKRTC6L426f3N4eP/3wtLjZ43TU3SpUBOY+yRitJpEkIWd6MwC+IQLBXTvNa/+PKvRGG12G/1pmu1ywvHh4f1R5YSjp06o/GskcGmQJwvAR2GdfVmTd+mx28Cj+3ll4PFTA68tGlDawVjnKnlZo7bX3m3IcWXGD0/N6KkZlyLxFaSBfkD1spbUl3dheVL1ceoTF50s3iRP5OfZhqn18WCkxTg3wi1Y+3bJHg94Jg7CfPv2bnUXMdoAmvJ4pq3XmLuUtVlrXqVji2aGxnoBPoFWOdFylYz0Y1NnqOhElHxkKR+2eCZas6PmEVtF2zw8yz6JHvODT2Wxjk+EmnyM727tnCsKYIjRhouqSPFM/BMXLCojUKeKmCDgpMgTND5ahIvL9QnYLaO7rejuM4XkjrVXoojvRYbqiq4rhA5vxHZJ9AZlrKfoi5kpQsnw/t//8zzlDcfD10t4RdfDi9xApudo6PyhO9FY4qMYSV+GAJz6uXUlFflUorVyAUI5nBg6vRMxEY6Hhwjl05hnfCSkIOgTmSZuA7XdY5t0BXUpGpr6q6HqbIIzlLRjgOdOT7kjUdUNda7Nw5hquhFwGOVWKLQWUKVcxURYRjOigjBXgMqhyYywCNYZ0loE3bRyhscOplzxCYY6bd1VCUpBkAejR7l1YLXMvcrguJDahGqxN0ghJqFS3H3MaApolC7uBlOC3gxhkosEbQSxTqhgTREmE1QCI7QOMtJFxGhJaK6kjh988OjohUxT4hFcgh5v6EjsznBl6fISdCljUDksM5rOcAwKNhrXFinCp0I92OIVcFth6gZHVji8+1uJzvl8/mT7fLfJ81a4X/IRXGKmrXDaLNbcE+HSfOS3XF1I9SdIeosKPX5qG2otI9GxfbqDabSVosxaV+gIIbbV6fd8rv4O3v/+HzhFbhSkeh7QGucG5QIm5VLkuRD54LYq1cJYe+Cl5PE4gK+4yJYevEm5e//7fy2c4xxE2ELBkY1GPx9JEcOgKOHZRqMNJ+FuW5b1LLiUO4i5ghGCTTlBaSY4cMgCtxTqoQkdtaCmhIG5cKE8SOOeb8MM/3Ypw21hxKmRoZXnKNdsrjWi8alFOUNLsujAHCFgIraLkXVlCuMMjunxdyOSCTpvWydJICuG52GYHF5TB8e0IVyKC+AGwaJyTehvsfiZPMu0IS1EUH6sqXlDAUCVZFpQ/6UokVbyozXQ/RNCaPXMUHAhr9wRbVVai51YWFyNNv1LZ+sw2My1BsdoaEFv9joumSjgdFvCEgitXwJrOgwoa/HY30H88zGcSj9uy/H3ATRTezG+QjMTcfmI+cCObnniFouYFDEqi7V7Rudt/xRm3zcPWVQ7uf7A5m6d9k6651ddUoYSaXDYUfOweUhDdNWYclVb6apo411vtPG2j7fl+iK2b/7tCyf75t++87Nv/u0hsG/+7Zt/++bfvvn39SWNffNvj6hvrPlXFEQdPrpWJrnwBeiirxZqx7dlC4z6cSlVldu3bLmk4sS1kasVDf+Wo6GS9F3EZtwIPqL65u3dKirLqFRsfsAFa7OT8OQ7GNDCRC7zUJHdqsNTHThwdOIYM7eTtl747l9cDVjERkWvcqoT4jF8Tn1MPmdt5nuevgDou2k0tmSSq0nOJ0QbZFLll6pHm2XjB182Ln6QVeWUWtQ03KwnBzPok4x6lmG5DCXp1aqiD1Mf5CgcW1JT4O5Wq9X/AfqGGmI=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},E=void 0,I={},g=[{value:"Events:",id:"events",level:3}];function j(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)(m.default,{as:"h1",className:"openapi__heading",children:"Save or Update Webhook"}),"\n",(0,i.jsx)(r(),{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)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(a(),{parameters:void 0}),"\n",(0,i.jsx)(h(),{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"}}}}}),"\n",(0,i.jsx)(u(),{id:void 0,label:void 0,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"}}}}}})]})}function C(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6235],{74402:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>g,contentTitle:()=>N,default:()=>M,frontMatter:()=>u,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(33617),a=t.n(r),d=t(17543),l=t.n(d),c=t(86013),h=t.n(c),p=t(63723),m=t.n(p),E=(t(18766),t(79329),t(9303));const u={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},N=void 0,g={},v=[{value:"Events:",id:"events",level:3}];function I(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:"Request"}),"\n",(0,i.jsx)(l(),{parameters:void 0}),"\n",(0,i.jsx)(h(),{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"}}}}}),"\n",(0,i.jsx)(m(),{id:void 0,label:void 0,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"}}}}}})]})}function M(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(I,{...e})}):I(e)}}}]); \ No newline at end of file diff --git a/assets/js/d480dde9.9cb61f73.js b/assets/js/d480dde9.9cb61f73.js deleted file mode 100644 index bffabf75a..000000000 --- a/assets/js/d480dde9.9cb61f73.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3230],{94677:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>v,contentTitle:()=>I,default:()=>q,frontMatter:()=>u,metadata:()=>a,toc:()=>m});const a=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/isTXtoIa0lJ00N1qpEYqVEjMWoHPshCwN0d7TLikgyHqwcEATn0H/TUa39afkkxpFYvJ2nTFr3oMZz3fPNYiyArEqOxuMO8tnYmJpkokQqvXFDWiJG4rRFeoMaAsOWB8+tLkFrbBaxsC8FCmd4X2/fWa5EJ69BLVnJZipFILJ2VTHgkZw0hidFaPB0O+evY8E1bFEg0bTXsVIlMFNYENIH5pXNaFfFh8I5YaC2oqLGR/CusHIqRsPk7LILIhPOsJqhk0iO1OhzwUfDKVCITuJSN00zq4k2+l0A7j/TqkdhsMhFUiJzKaGXwbRfU26fD4dsfxGbDPM+Gzx4G94bQg7EBprY15aP/Li703vovh3Vq+0uBsPNdGN8/DOPSzKVWZUTErZ2h+X8jOTQfknl2ddloljOySSFFpvgujkI9pKcgCYvWq7ASo/FaLM+kU2fpfTSebCaZaDDUdg9n9lmGWozEYLFDNqGfo6eogjthJOoQHI0GA5KmzO2ybx0aUpXRMqd+YZuBdGowf9J/IjbZqYx07qv4sT37WhEKslKm+iu5yT49N1zCVKWjJO1qJZ36GVci62pwyJUJxdCpUZboY72UmdoovK3Ma4fmRlUm1jUaPx1Kd6gL2yDPnlAjdAIff/0jypS2aBs0IQIvanh0b+7N69aDswv0PFOkKWGqcalyjVEIm/hG3VAjlI1GIr0CZQJWXgaEUlUqSA2cI2UqKKSTudKKQctslqU9HOCe+nBXY6jR89M3HkFCiXPUjHWQbbCNDKyqcxoW1s+m2i4oAwl5S8ogEaCppSmYsatCBtaDNIAmoHdeEQIFz16r5Js1wcsiQCONrJB1Z0epKlErhip4m7cUgKxuo8sQpNLWYwldQAaxpD4n8WLp+AmYWtjGeawZMnOEqlUlUgaFLREo9iiHYErIkQI49kUVSKy0NdoWs1g8HqfgLI8MJTXY6ZGPLB68NDS1vkm+dDXYJcx5y3MZk4O93htCrvCVMjMa9Xr35gzGO0zdYU4q4OTbDv6LxeIB7B8fy7xU4ac2h1/QWVLB+tVeulKhbvPYKodKdn+SppdoMOLnoBH2Okpb0MPOY+qgRu0GNxgYITQ4v76MU/YxfPzwG1yh9AZqu0hoLVqPegVVZ4ozlyqf0rYbkjC1EXg1Z7xI4PP4vkUKXQbvahk+fvid4BUuQKUWSons9a7bXKsCbrFxWgakXm8Ezz2yydDRINQyQCEN5AhUS4bSXEmQ4JK0VmbWh3Ozgpa30UKFOoKB6VHuKAzOy67cBLkkLMGaKNHZ7O89YnpDqOdIrItXXY6ApeIlHmpv2ypZO3RmG5zHqdIa7lRZYYixnZcluC15kcjx5tm7g1NuiFDjCqRHIDShD9cnIvGldc569kIl56eWzyguAJrSWWUCjaD0chr2+rM90AtOs7LmE6SUQrlLR7ZVsytJ6sRtxDtq/54H8skQP561Hqfo2WAMe18Xp7ZwGnewBEbrv4E1r2eeWrKI1wM2Uum0TX481RM3OfqGXk9v0M9VgduN9pmOHkTmgciEVgUawoML4fzl9RXMv+sPRXawGv9Gcw+uLp9fvLq5YGd4kKaEPekP+0MmOUuhkebA0vEhfbrW1vvT6Z+f3dsNHHAZBk5LFW+eGNV6e6yMxWJ/7NeWApPWa+6qN15vNkx+36LnK2iSibn0Sua8mMeTTdbtbb5uZrji7BUFOj7f5lK3afmfHH1Hl9OLi6uL2wuRCZ5AxyfDLJ4M2x9soHsyqwP1x7dE8oE/+bD5pMB6nc6RzWbHn54+K7GNsePmHE42m82f8GaqNA==","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=t(74848),l=t(28453),d=t(33617),i=t.n(d),n=t(17543),p=t.n(n),r=t(86013),k=t.n(r),c=t(63723),h=t.n(c),b=(t(18766),t(79329),t(9303));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/isTXtoIa0lJ00N1qpEYqVEjMWoHPshCwN0d7TLikgyHqwcEATn0H/TUa39afkkxpFYvJ2nTFr3oMZz3fPNYiyArEqOxuMO8tnYmJpkokQqvXFDWiJG4rRFeoMaAsOWB8+tLkFrbBaxsC8FCmd4X2/fWa5EJ69BLVnJZipFILJ2VTHgkZw0hidFaPB0O+evY8E1bFEg0bTXsVIlMFNYENIH5pXNaFfFh8I5YaC2oqLGR/CusHIqRsPk7LILIhPOsJqhk0iO1OhzwUfDKVCITuJSN00zq4k2+l0A7j/TqkdhsMhFUiJzKaGXwbRfU26fD4dsfxGbDPM+Gzx4G94bQg7EBprY15aP/Li703vovh3Vq+0uBsPNdGN8/DOPSzKVWZUTErZ2h+X8jOTQfknl2ddloljOySSFFpvgujkI9pKcgCYvWq7ASo/FaLM+kU2fpfTSebCaZaDDUdg9n9lmGWozEYLFDNqGfo6eogjthJOoQHI0GA5KmzO2ybx0aUpXRMqd+YZuBdGowf9J/IjbZqYx07qv4sT37WhEKslKm+iu5yT49N1zCVKWjJO1qJZ36GVci62pwyJUJxdCpUZboY72UmdoovK3Ma4fmRlUm1jUaPx1Kd6gL2yDPnlAjdAIff/0jypS2aBs0IQIvanh0b+7N69aDswv0PFOkKWGqcalyjVEIm/hG3VAjlI1GIr0CZQJWXgaEUlUqSA2cI2UqKKSTudKKQctslqU9HOCe+nBXY6jR89M3HkFCiXPUjHWQbbCNDKyqcxoW1s+m2i4oAwl5S8ogEaCppSmYsatCBtaDNIAmoHdeEQIFz16r5Js1wcsiQCONrJB1Z0epKlErhip4m7cUgKxuo8sQpNLWYwldQAaxpD4n8WLp+AmYWtjGeawZMnOEqlUlUgaFLREo9iiHYErIkQI49kUVSKy0NdoWs1g8HqfgLI8MJTXY6ZGPLB68NDS1vkm+dDXYJcx5y3MZk4O93htCrvCVMjMa9Xr35gzGO0zdYU4q4OTbDv6LxeIB7B8fy7xU4ac2h1/QWVLB+tVeulKhbvPYKodKdn+SppdoMOLnoBH2Okpb0MPOY+qgRu0GNxgYITQ4v76MU/YxfPzwG1yh9AZqu0hoLVqPegVVZ4ozlyqf0rYbkjC1EXg1Z7xI4PP4vkUKXQbvahk+fvid4BUuQKUWSons9a7bXKsCbrFxWgakXm8Ezz2yydDRINQyQCEN5AhUS4bSXEmQ4JK0VmbWh3Ozgpa30UKFOoKB6VHuKAzOy67cBLkkLMGaKNHZ7O89YnpDqOdIrItXXY6ApeIlHmpv2ypZO3RmG5zHqdIa7lRZYYixnZcluC15kcjx5tm7g1NuiFDjCqRHIDShD9cnIvGldc569kIl56eWzyguAJrSWWUCjaD0chr2+rM90AtOs7LmE6SUQrlLR7ZVsytJ6sRtxDtq/54H8skQP561Hqfo2WAMe18Xp7ZwGnewBEbrv4E1r2eeWrKI1wM2Uum0TX481RM3OfqGXk9v0M9VgduN9pmOHkTmgciEVgUawoML4fzl9RXMv+sPRXawGv9Gcw+uLp9fvLq5YGd4kKaEPekP+0MmOUuhkebA0vEhfbrW1vvT6Z+f3dsNHHAZBk5LFW+eGNV6e6yMxWJ/7NeWApPWa+6qN15vNkx+36LnK2iSibn0Sua8mMeTTdbtbb5uZrji7BUFOj7f5lK3afmfHH1Hl9OLi6uL2wuRCZ5AxyfDLJ4M2x9soHsyqwP1x7dE8oE/+bD5pMB6nc6RzWbHn54+K7GNsePmHE42m82f8GaqNA==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},I=void 0,v={},m=[];function f(e){const o={p:"p",...(0,l.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(b.default,{as:"h1",className:"openapi__heading",children:"Delete Webhook"}),"\n",(0,s.jsx)(i(),{method:"delete",path:"/webhook",context:"endpoint"}),"\n",(0,s.jsx)(o.p,{children:"The Delete Webhook API allow you to delete webhook url"}),"\n",(0,s.jsx)(p(),{parameters:void 0}),"\n",(0,s.jsx)(k(),{title:"Body",body:void 0}),"\n",(0,s.jsx)(h(),{id:void 0,label:void 0,responses:{200:{description:"Successful operation",content:{"application/json":{schema:{type:"object",properties:{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"}}}}}})]})}function q(e={}){const{wrapper:o}={...(0,l.R)(),...e.components};return o?(0,s.jsx)(o,{...e,children:(0,s.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/d480dde9.a2cfa06b.js b/assets/js/d480dde9.a2cfa06b.js new file mode 100644 index 000000000..fe60841ae --- /dev/null +++ b/assets/js/d480dde9.a2cfa06b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3230],{94677:(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),i=o(33617),r=o.n(i),d=o(17543),a=o.n(d),c=o(86013),h=o.n(c),p=o(63723),b=o.n(p),k=(o(18766),o(79329),o(9303));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 v(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)(r(),{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)(a(),{parameters:void 0}),"\n",(0,s.jsx)(h(),{title:"Body",body:void 0}),"\n",(0,s.jsx)(b(),{id:void 0,label:void 0,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"}}}}}})]})}function I(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/da66eb9c.717af639.js b/assets/js/da66eb9c.717af639.js new file mode 100644 index 000000000..b680eb21e --- /dev/null +++ b/assets/js/da66eb9c.717af639.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2703],{56200:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>g,contentTitle:()=>x,default:()=>v,frontMatter:()=>f,metadata:()=>a,toc:()=>b});const a=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":"eJzdWM2OG7kRfpUKL7GFHkm2xxtEp0y8hm3EsAXPDAxkPBCoZrWaO2ySS7KlEQQBe9g3yCnXPJqfJCiyu9X68djOLhIgl4GGXSxWfVVkfVUbFvjCs8kN+9HkdYU6eHabMYE+d9IGaTSbsKsS4doKHhBaKbiYvgGulFl5qD06D8FAZYQs1sC1gDqJhxJBYOBSeTAFcPAWc1nIHESjaAjvTBTkAUIpfVRstFq32oNplXEocAWWO15hQOczWJsacq61CZCXXC/SgYVUCEbnCDIkC1qjpYfcIQ8ohixjxqLj5OIbwSYsHdL6xzK2O4hNbjZM8wrZhLW6ZlKwjEmCx/JQskPM3vxIDu+dHn3UiCI6NcfGL9Lj8OdaOhRsElyNGfNhreg0LyurkGUM760yAtmk4MqTQF5ixdlkw8LaRsngpF6wjBXGVTzsVrbb26QfffirEWvas2/q1JmlFAhzVKaHbw/5gJVVPKCHRzyAQu4DGI092daBxyxjudGBIJxsGLdWyTyCPPrJ02mbY9PN/CfMI+KOQhIkevqaAP+6gwQOjzBNmI8/OsjZNmPahO9WMyUXERwuJa5iPnu50Ck/+7r3cPy+I7qs6OvY0h4l0FFGHuvb7SZJ1Hyu8P3VtCc6N0Yh10fZSFkFZ8kBExdhJZWCpAPeX01hiY4uZozVEK7jnY4yDnOUS7p+fRHIjUBYSg5YcakyWJUyLynh11DVPgDqJoca6LB35WMSwxkcGySkP2lRlp4DqRe75+ZIMQjpMA9qDSsZSlMH4EJI2s4V+IDWD/soRis6IK9M7X47khwWtRQoIJjaQWFctDI+VjZeM/JAah9cndNmD6Km6EY/SJR+W2dy9H6HU4sKCfX0Z4Dap+0cCu4DugxqLQl5V9uAolOJ9xadRJ3jSQgiuLP4fjeA+2/HYoquksG3nlJouBCACmM9AV/nJfD0nYfaoc9AahkkVz4DH3hlfQbGQcB7elcgGEuPJ95LH8j4lRQLDB7kl/LoA9IdyXs2FM5UMfqEjV73E6GzK5gDdVcUVOmbqlXwWgVYclWfxsxhSrdZ7dSp27qP1WUqfJi0X394C6sSHXZxR5fyaE7PTlKMVEbjTaODQ5slXbYfpsvRC8HrYGYOK6kFfktuX2KIoFBYg+lSug6m4kHm0KryQ2hEUwCC6WdoBY9a8OZY8qU07vEXACR1M6rUM6lnuES37lmp62qO7sjId3GZ8kPwtYc5hhWi7tvWhjGxiFSByLZViRr2MCEpv3N6z8rn223Gggx7r/WsV/5nc6qm2+02uuKt0T4Vrqfj8XGR7YhTU/TpVlDUilqp9R9+v6qZlr9WP7gXT1/76flrS3nSmHQRHt70dPz02dmT8dn4T1dPfpic/3ny/IfheDz+O8vYfaV2JZuRNtZHL/7fW5BaSY2zFrXZ0/F49qyB8vwUek1Btg1TWXIlBRQSlQA60/+OAKJzxv2HhOEB+x5yn1xunT9/IHWI5xam1uJ/7e4pix528Hx23rn4/NjFNzpBRuT/ytyh/m94uPOnf3xIx5Op+1ktk1D8zvac7a8nJz3mtZNhHTuH+zNu5Vn6Prm5JT5eYSgNdR22Tq1GKNmEjdrXZbTpvTNbRvrcsm1EYrlhZQjWT0Yjz7WYm/uhsaipICg+98PcVCNu5Wj5ZPiEbbPDPdza75LH+ux7t/jAF1IvvrbvdgfVJYUzRWwPsC5u3Mq/4ZplbTz6Uk0nViKnSkcRoCz5sOt6Xrax7sJ52Cq0ncK3kf/DqnSSzvfZPGN7jL1p4/rUs1k6ScWab/uUg1QelPhO7lRlfb4lmAoTMW2S971FfUnuUerHmBx69hFVbips2dJg0G75/Ou/ul2DQQdNaiA+6U/6fe3AmhW6olYRx0LhvaRKTNuwit98bOKJzSOvFHqv1kAEduGo8RRyIQOR94bq5NzyuVSS7jaJGdrtoPc8+CF8LDGU6OjTHx1RcoFLVPQkdFxGL3Y0amXcXUGjhgw4zGsvNXoPqEuucxJsEzRSVK5TY2Od9Ag+OLJaJtuMDo7nASqu+SJyzAz6YAlUkm4xODOnDskbVacegAYkxkVWnxyKU4II4ktq/B0CrRIRdFjSbVo2jYDPUiOWsplc0ALm6ANYskXmmCYoWpn8Lk1HaqXAGnpZJVfEo/o20vbguPb0/Cdb2hh0gDV8E5OBg8G1R4rwW6nv/GQw+KTP4KbLq4849zLg7aP2ZVitVkcvwuP9Pa9keF3P4QNa42Uwbr3bvZChrOfxFekr6f5Jml6hxpg/vTdip0OY3B8/SrQ6KlHZ0SUGyhA/upi+icXoMXz+5R/wFrnTUJpVyta8dqjWsGiPIuRS5BNsXS2JXSCvQ0mI5yn5mnlMi+DHkofPv/zTwztcUZeTrhS5MhhM67mSOVy1I5jBYAIv4hCrN5aJo6Wca2offMkplag152DTbiX13RAu9Dp2z7E9jslA63HfnhvxvWvD7WHOPYrYl5W7M4c7iyLp96iW6Ntp3BwBhSSaG0pn6kU6rW9M45zDgrqej6nDI98uhADbLLeNHzUYO3OwMKlxWgN3CD72btODLfFLba1xZEXTORamHSKgFtZIHfwEhONF2OnPdokeZ4Vx+HC0lCDkHRxZo6YLSbqJjcfd6vATVYWD+rb/3jos0NGB0e1dXKxs0ummTUugbP0taU0shl4tnkeSFQc5qdD+5VBPJDzoKv++uES3lDk2xf4LN3oUhUcsY0rmqH2/8l68mr6F5bPhmGU91vANl3v09s2Ll+8uX5Ix9JAmwJ4Mx8MxLVnjQ8V176SDofVhbdvsKOb/64y74U40WRlZxWVkrs3AIrHOG9YjNZP+ePs2Y6XxgUQ2G3oErp3abmn55zoSipvbjC25k8RhIjVtpgCiIyJfhPvRh3ZgDN83KT/pUMsQNdHDOLFJ7OgO1wcj++3tNmtpIlmcJF4ku86uSM9Ow1HXQTw37bjIc7ThQdk+zZ9eX7GMzZvxexUn+czxFY3++SoZm6aJkQDHtQ1TXC9qviDZpHKbhjrlPiu+i6y4+UFOnYRjny4nL+gv+XRyw2aTGPd228mnT1/c0eDaSlNsbrfb7b8BOQ9Ukg==","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 i=n(74848),s=n(28453),o=n(33617),d=n.n(o),l=n(17543),r=n.n(l),c=n(86013),p=n.n(c),u=n(63723),m=n.n(u),h=(n(18766),n(79329),n(9303));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:"eJzdWM2OG7kRfpUKL7GFHkm2xxtEp0y8hm3EsAXPDAxkPBCoZrWaO2ySS7KlEQQBe9g3yCnXPJqfJCiyu9X68djOLhIgl4GGXSxWfVVkfVUbFvjCs8kN+9HkdYU6eHabMYE+d9IGaTSbsKsS4doKHhBaKbiYvgGulFl5qD06D8FAZYQs1sC1gDqJhxJBYOBSeTAFcPAWc1nIHESjaAjvTBTkAUIpfVRstFq32oNplXEocAWWO15hQOczWJsacq61CZCXXC/SgYVUCEbnCDIkC1qjpYfcIQ8ohixjxqLj5OIbwSYsHdL6xzK2O4hNbjZM8wrZhLW6ZlKwjEmCx/JQskPM3vxIDu+dHn3UiCI6NcfGL9Lj8OdaOhRsElyNGfNhreg0LyurkGUM760yAtmk4MqTQF5ixdlkw8LaRsngpF6wjBXGVTzsVrbb26QfffirEWvas2/q1JmlFAhzVKaHbw/5gJVVPKCHRzyAQu4DGI092daBxyxjudGBIJxsGLdWyTyCPPrJ02mbY9PN/CfMI+KOQhIkevqaAP+6gwQOjzBNmI8/OsjZNmPahO9WMyUXERwuJa5iPnu50Ck/+7r3cPy+I7qs6OvY0h4l0FFGHuvb7SZJ1Hyu8P3VtCc6N0Yh10fZSFkFZ8kBExdhJZWCpAPeX01hiY4uZozVEK7jnY4yDnOUS7p+fRHIjUBYSg5YcakyWJUyLynh11DVPgDqJoca6LB35WMSwxkcGySkP2lRlp4DqRe75+ZIMQjpMA9qDSsZSlMH4EJI2s4V+IDWD/soRis6IK9M7X47khwWtRQoIJjaQWFctDI+VjZeM/JAah9cndNmD6Km6EY/SJR+W2dy9H6HU4sKCfX0Z4Dap+0cCu4DugxqLQl5V9uAolOJ9xadRJ3jSQgiuLP4fjeA+2/HYoquksG3nlJouBCACmM9AV/nJfD0nYfaoc9AahkkVz4DH3hlfQbGQcB7elcgGEuPJ95LH8j4lRQLDB7kl/LoA9IdyXs2FM5UMfqEjV73E6GzK5gDdVcUVOmbqlXwWgVYclWfxsxhSrdZ7dSp27qP1WUqfJi0X394C6sSHXZxR5fyaE7PTlKMVEbjTaODQ5slXbYfpsvRC8HrYGYOK6kFfktuX2KIoFBYg+lSug6m4kHm0KryQ2hEUwCC6WdoBY9a8OZY8qU07vEXACR1M6rUM6lnuES37lmp62qO7sjId3GZ8kPwtYc5hhWi7tvWhjGxiFSByLZViRr2MCEpv3N6z8rn223Gggx7r/WsV/5nc6qm2+02uuKt0T4Vrqfj8XGR7YhTU/TpVlDUilqp9R9+v6qZlr9WP7gXT1/76flrS3nSmHQRHt70dPz02dmT8dn4T1dPfpic/3ny/IfheDz+O8vYfaV2JZuRNtZHL/7fW5BaSY2zFrXZ0/F49qyB8vwUek1Btg1TWXIlBRQSlQA60/+OAKJzxv2HhOEB+x5yn1xunT9/IHWI5xam1uJ/7e4pix528Hx23rn4/NjFNzpBRuT/ytyh/m94uPOnf3xIx5Op+1ktk1D8zvac7a8nJz3mtZNhHTuH+zNu5Vn6Prm5JT5eYSgNdR22Tq1GKNmEjdrXZbTpvTNbRvrcsm1EYrlhZQjWT0Yjz7WYm/uhsaipICg+98PcVCNu5Wj5ZPiEbbPDPdza75LH+ux7t/jAF1IvvrbvdgfVJYUzRWwPsC5u3Mq/4ZplbTz6Uk0nViKnSkcRoCz5sOt6Xrax7sJ52Cq0ncK3kf/DqnSSzvfZPGN7jL1p4/rUs1k6ScWab/uUg1QelPhO7lRlfb4lmAoTMW2S971FfUnuUerHmBx69hFVbips2dJg0G75/Ou/ul2DQQdNaiA+6U/6fe3AmhW6olYRx0LhvaRKTNuwit98bOKJzSOvFHqv1kAEduGo8RRyIQOR94bq5NzyuVSS7jaJGdrtoPc8+CF8LDGU6OjTHx1RcoFLVPQkdFxGL3Y0amXcXUGjhgw4zGsvNXoPqEuucxJsEzRSVK5TY2Od9Ag+OLJaJtuMDo7nASqu+SJyzAz6YAlUkm4xODOnDskbVacegAYkxkVWnxyKU4II4ktq/B0CrRIRdFjSbVo2jYDPUiOWsplc0ALm6ANYskXmmCYoWpn8Lk1HaqXAGnpZJVfEo/o20vbguPb0/Cdb2hh0gDV8E5OBg8G1R4rwW6nv/GQw+KTP4KbLq4849zLg7aP2ZVitVkcvwuP9Pa9keF3P4QNa42Uwbr3bvZChrOfxFekr6f5Jml6hxpg/vTdip0OY3B8/SrQ6KlHZ0SUGyhA/upi+icXoMXz+5R/wFrnTUJpVyta8dqjWsGiPIuRS5BNsXS2JXSCvQ0mI5yn5mnlMi+DHkofPv/zTwztcUZeTrhS5MhhM67mSOVy1I5jBYAIv4hCrN5aJo6Wca2offMkplag152DTbiX13RAu9Dp2z7E9jslA63HfnhvxvWvD7WHOPYrYl5W7M4c7iyLp96iW6Ntp3BwBhSSaG0pn6kU6rW9M45zDgrqej6nDI98uhADbLLeNHzUYO3OwMKlxWgN3CD72btODLfFLba1xZEXTORamHSKgFtZIHfwEhONF2OnPdokeZ4Vx+HC0lCDkHRxZo6YLSbqJjcfd6vATVYWD+rb/3jos0NGB0e1dXKxs0ummTUugbP0taU0shl4tnkeSFQc5qdD+5VBPJDzoKv++uES3lDk2xf4LN3oUhUcsY0rmqH2/8l68mr6F5bPhmGU91vANl3v09s2Ll+8uX5Ix9JAmwJ4Mx8MxLVnjQ8V176SDofVhbdvsKOb/64y74U40WRlZxWVkrs3AIrHOG9YjNZP+ePs2Y6XxgUQ2G3oErp3abmn55zoSipvbjC25k8RhIjVtpgCiIyJfhPvRh3ZgDN83KT/pUMsQNdHDOLFJ7OgO1wcj++3tNmtpIlmcJF4ku86uSM9Ow1HXQTw37bjIc7ThQdk+zZ9eX7GMzZvxexUn+czxFY3++SoZm6aJkQDHtQ1TXC9qviDZpHKbhjrlPiu+i6y4+UFOnYRjny4nL+gv+XRyw2aTGPd228mnT1/c0eDaSlNsbrfb7b8BOQ9Ukg==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},x=void 0,g={},b=[];function P(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Update Document"}),"\n",(0,i.jsx)(d(),{method:"put",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,i.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,i.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(r(),{parameters:[{name:"document_id",in:"path",description:"ID of the document that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}]}),"\n",(0,i.jsx)(p(),{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:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},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:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5}},title:"document_document_id_body"}}}}}),"\n",(0,i.jsx)(m(),{id:void 0,label:void 0,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"}}}}}})]})}function v(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(P,{...e})}):P(e)}}}]); \ No newline at end of file diff --git a/assets/js/da66eb9c.c63a2c44.js b/assets/js/da66eb9c.c63a2c44.js deleted file mode 100644 index ecee101cc..000000000 --- a/assets/js/da66eb9c.c63a2c44.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2703],{56200:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>A,contentTitle:()=>g,default:()=>F,frontMatter:()=>f,metadata:()=>o,toc:()=>j});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":"eJzdWF9vG7kR/ypzfGlirCUlca6onurmgsSokQixjQB1DIG7nNXyzCV5JFeyIAi4h36DPvW1Hy2fpBhyV1r9iZP0Di3QF0PmDoczvxlyfjMrFvjMs/Et+8kUTY06eHaXMYG+cNIGaTQbs+sK4cYKHhA6KTifXABXyiw8NB6dh2CgNkKWS+BaQJPEQ4UgMHCpPJgSOHiLhSxlAaJVNIB3JgryAKGSPio2Wi077cF0yjiUuADLHa8xoPMZLE0DBdfaBCgqrmfpwFIqBKMLBBmSBZ3R0kPhkAcUA5YxY9FxcvFCsDFLh3T+sYxtD2Lj2xXTvEY2Zp2uqRQsY5LgsTxUbB+zi5/I4Z3To48aUUSncmz9Ij0Of2mkQ8HGwTWYMR+Wik7zsrYKWcbwwSojkI1LrjwJFBXWnI1XLCxtlAxO6hnLWGlczcN2Zb2+S/rRh78YsaQ9u6ZOnJlLgZCjMj18e8gHrK3iAT084QEUch/AaOzJdg48ZRkrjA4E4XjFuLVKFhHk4c+eTlsdmm7yn7GIiDsKSZDo6WsC/OsOEjg8wjRmPv7YQM7WGdMmfLeaCbmI4HAucRHz2cuZTvnZ172D4/cdscmKvo417VECHWXkob7tbpJEzXOF768nPdHcGIVcH2QjZRWcJgdMXISFVAqSDnh/PYE5OrqYMVYDuIl3Oso4LFDO6fr1RaAwAmEuOWDNpcpgUcmiooRfQt34AKjbHGqhw96Vj0kMp3BokJD+qEVZeg6knm2fmwPFIKTDIqglLGSoTBOACyFpO1fgA1o/6KMYrdgAeW0a99uR5DBrpEABwTQOSuOilfGxsvGakQdS++CagjZ7EA1FN/pBovTbOlOg91ucOlRIqKc/A9Q+bedQch/QZdBoSci7xgYUG5X4YNFJ1AUehSCCO43vdwu4/3YsJuhqGXznKYWGCwGoMNYT8E1RAU/feWgc+gyklkFy5TPwgdfWZ2AcBHygdwWCsfR44oP0gYxfSDHD4EF+KY8+IN2RomdD6Uwdo0/Y6GU/ETZ2BbOn7pqCKn1btUreqABzrprjmDlM6TZtnDp2W3exukqFD5P2mw+XsKjQ4Sbu6FIe5fTsJMVIZTTeNDo4dFmyyfb9dDl4IXgTzNRhLbXAb8ntKwwRFAprMJuUboKpeZAFdKr8AFrRFIBg+hlaw5MOvBwrPpfGPf0CgKRuSpV6KvUU5+iWPSt1U+foDox8F5cpPwRfesgxLBB137YujIlFpApEti0q1LCDCUn5rdM7Vr5crzMWZNh5rae98j/NqZqu1+voirdG+1S4no9Gh0V2Q5zaok+3gqJWNkotf/j9qmZa/lr94F48f+snZ28t5Ulr0nl4fNPz0fMXp89Gp6M/Xj/7cXz2p/HLHwej0ehvLGMPtdqWbEbaWB+9+H9vQWolNU471KbPR6PpixbKs2PotQXZtkxlzpUUUEpUAuhM/zsCiM4Z9x8Shkfse8x9crlz/uyR1CGeW5pGi/+1u8csetzBs+nZxsWXhy5e6AQZkf9rc4/6v+Hh1p/+8SEdT6buZrVMQvE723G2v56c9Fg0ToZl7BweTrmVp+n7+PaO+HiNoTLUddgmtRqhYmM27F6X4ar3zqwZ6XPzrhGJ5YZVIVg/Hg491yI3DwNjUVNBUDz3g8LUQ27lcP5s8Iyts/093Nrvksfm9Hu3+MBnUs++tu9uC9UVhTNFbAewTdy4lX/FJcu6ePSl2k6sQk6VjiJAWfJh2/W87mK9Ced+q9B1Ct9G/ver0lE632fzjO0w9raN61PPdukoFWu/7VIOUrlX4jdyxyrryzXBVJqIaZu87y3qK3KPUj/GZN+zj6gKU2PHlroNn//+r7inczw1BaThh0/6k37fOLBmga5sVMSwVPggqQrTJqzjNx8beGLyyGuF3qslEHmdOWo6hZzJQMS9pTkFtzyXStK9JjFDux30ngY/gI8VhgodffqDIzoucI6KnoMNj9GzLYVaGHdf0pghAw5546VG7wF1xXVBgl1yRnrKdWpqrJMewQdHVstkm9HB8SJAzTWfRX6Z7UAlUEm6weBMTt2RN6pJ/J+GI8ZFRp8cihOCAYH4mpp+h0CrRAIdVnST5m0T4LPUhKVMJhe0gBx9AEu2yALT9EQrU9ynyUijFFhDr6rkijhU30baHhzXnp7+ZEsXgw1gLdfEZODJyY1HivCl1Pd+fHLySZ/C7SanPmLuZcC7J92rsFgsDl6Dp7t73sjwtsnhA1rjZTBuud09k6Fq8viC9JVs/kma3qDGmD+992GrQ5jCHz5ItDqsUNnhFQbKED88n1zEQvQUPv/6D7hE7jRUZpGytWgcqiXMuqMIuRT5BNumjsQOkDehIsSLlHztLKZD8GPFw+df/+nhHS6ow6ErlIA8OZk0uZIFXHfjl5OTMbyKA6zeSCaOlQquqXXwFadUoracg027ldT3AzjXy9g5x9Y4JgOtx307bsS3rgu3h5x7FLEnq7ZnDrYWRcLvUc3Rd5O4HAGFJIobKmeaWTqtb0zrnMOSOp6Pqbsj386FANsud00fNRdbc7A0qWlaAncIPvZtk70t8UtjrXFkRds1lqYbIKAW1kgd/BiE42XY6s+2iR7nhHHwcLCUIOQbOLJWzSYk6Sa2Hm9WB5+oIuzVtt231mGJjg6Mbm/jYmWbTrddWgJl629Ja2Iw9GrxIhKsOMRJRfbP+3oi2UFX+/flFbq5LLAt9F+40cMoPGQZU7JA7ftV9/zN5BLmLwYjlvUYwzdc7uHlxavX765ekzH0kCbAng1GgxEtWeNDzXXvpL2B9X5dW23p5f/rfLvlTTRVGVrFZWSt7bAiMc5b1iM04/5o+y5jlfGBRFYregRunFqvafmXJpKJ27uMzbmTxF8iLW0nAGJDQr4I95MP3bAYvm9KftShjh1qooZxWpOY0T0u98b167t11lFEsjhJvEp2nV6Tnq2Gg46DOG7acV4UaMOjsn2KP7m5ZhnL29F7Haf4zPEFjf35IhmbJomR/Ma1FVNczxo+I9mkcp0GOtUuI76PjLj9QU4dhWOXKicv6C/5dHTDapXY9nq9kU+fvrijxbWTptjcrdfrfwNBkFPd","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 i=n(74848),s=n(28453),a=n(33617),r=n.n(a),d=n(17543),c=n.n(d),p=n(86013),l=n.n(p),u=n(63723),m=n.n(u),h=(n(18766),n(79329),n(9303));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:"eJzdWF9vG7kR/ypzfGlirCUlca6onurmgsSokQixjQB1DIG7nNXyzCV5JFeyIAi4h36DPvW1Hy2fpBhyV1r9iZP0Di3QF0PmDoczvxlyfjMrFvjMs/Et+8kUTY06eHaXMYG+cNIGaTQbs+sK4cYKHhA6KTifXABXyiw8NB6dh2CgNkKWS+BaQJPEQ4UgMHCpPJgSOHiLhSxlAaJVNIB3JgryAKGSPio2Wi077cF0yjiUuADLHa8xoPMZLE0DBdfaBCgqrmfpwFIqBKMLBBmSBZ3R0kPhkAcUA5YxY9FxcvFCsDFLh3T+sYxtD2Lj2xXTvEY2Zp2uqRQsY5LgsTxUbB+zi5/I4Z3To48aUUSncmz9Ij0Of2mkQ8HGwTWYMR+Wik7zsrYKWcbwwSojkI1LrjwJFBXWnI1XLCxtlAxO6hnLWGlczcN2Zb2+S/rRh78YsaQ9u6ZOnJlLgZCjMj18e8gHrK3iAT084QEUch/AaOzJdg48ZRkrjA4E4XjFuLVKFhHk4c+eTlsdmm7yn7GIiDsKSZDo6WsC/OsOEjg8wjRmPv7YQM7WGdMmfLeaCbmI4HAucRHz2cuZTvnZ172D4/cdscmKvo417VECHWXkob7tbpJEzXOF768nPdHcGIVcH2QjZRWcJgdMXISFVAqSDnh/PYE5OrqYMVYDuIl3Oso4LFDO6fr1RaAwAmEuOWDNpcpgUcmiooRfQt34AKjbHGqhw96Vj0kMp3BokJD+qEVZeg6knm2fmwPFIKTDIqglLGSoTBOACyFpO1fgA1o/6KMYrdgAeW0a99uR5DBrpEABwTQOSuOilfGxsvGakQdS++CagjZ7EA1FN/pBovTbOlOg91ucOlRIqKc/A9Q+bedQch/QZdBoSci7xgYUG5X4YNFJ1AUehSCCO43vdwu4/3YsJuhqGXznKYWGCwGoMNYT8E1RAU/feWgc+gyklkFy5TPwgdfWZ2AcBHygdwWCsfR44oP0gYxfSDHD4EF+KY8+IN2RomdD6Uwdo0/Y6GU/ETZ2BbOn7pqCKn1btUreqABzrprjmDlM6TZtnDp2W3exukqFD5P2mw+XsKjQ4Sbu6FIe5fTsJMVIZTTeNDo4dFmyyfb9dDl4IXgTzNRhLbXAb8ntKwwRFAprMJuUboKpeZAFdKr8AFrRFIBg+hlaw5MOvBwrPpfGPf0CgKRuSpV6KvUU5+iWPSt1U+foDox8F5cpPwRfesgxLBB137YujIlFpApEti0q1LCDCUn5rdM7Vr5crzMWZNh5rae98j/NqZqu1+voirdG+1S4no9Gh0V2Q5zaok+3gqJWNkotf/j9qmZa/lr94F48f+snZ28t5Ulr0nl4fNPz0fMXp89Gp6M/Xj/7cXz2p/HLHwej0ehvLGMPtdqWbEbaWB+9+H9vQWolNU471KbPR6PpixbKs2PotQXZtkxlzpUUUEpUAuhM/zsCiM4Z9x8Shkfse8x9crlz/uyR1CGeW5pGi/+1u8csetzBs+nZxsWXhy5e6AQZkf9rc4/6v+Hh1p/+8SEdT6buZrVMQvE723G2v56c9Fg0ToZl7BweTrmVp+n7+PaO+HiNoTLUddgmtRqhYmM27F6X4ar3zqwZ6XPzrhGJ5YZVIVg/Hg491yI3DwNjUVNBUDz3g8LUQ27lcP5s8Iyts/093Nrvksfm9Hu3+MBnUs++tu9uC9UVhTNFbAewTdy4lX/FJcu6ePSl2k6sQk6VjiJAWfJh2/W87mK9Ced+q9B1Ct9G/ver0lE632fzjO0w9raN61PPdukoFWu/7VIOUrlX4jdyxyrryzXBVJqIaZu87y3qK3KPUj/GZN+zj6gKU2PHlroNn//+r7inczw1BaThh0/6k37fOLBmga5sVMSwVPggqQrTJqzjNx8beGLyyGuF3qslEHmdOWo6hZzJQMS9pTkFtzyXStK9JjFDux30ngY/gI8VhgodffqDIzoucI6KnoMNj9GzLYVaGHdf0pghAw5546VG7wF1xXVBgl1yRnrKdWpqrJMewQdHVstkm9HB8SJAzTWfRX6Z7UAlUEm6weBMTt2RN6pJ/J+GI8ZFRp8cihOCAYH4mpp+h0CrRAIdVnST5m0T4LPUhKVMJhe0gBx9AEu2yALT9EQrU9ynyUijFFhDr6rkijhU30baHhzXnp7+ZEsXgw1gLdfEZODJyY1HivCl1Pd+fHLySZ/C7SanPmLuZcC7J92rsFgsDl6Dp7t73sjwtsnhA1rjZTBuud09k6Fq8viC9JVs/kma3qDGmD+992GrQ5jCHz5ItDqsUNnhFQbKED88n1zEQvQUPv/6D7hE7jRUZpGytWgcqiXMuqMIuRT5BNumjsQOkDehIsSLlHztLKZD8GPFw+df/+nhHS6ow6ErlIA8OZk0uZIFXHfjl5OTMbyKA6zeSCaOlQquqXXwFadUoracg027ldT3AzjXy9g5x9Y4JgOtx307bsS3rgu3h5x7FLEnq7ZnDrYWRcLvUc3Rd5O4HAGFJIobKmeaWTqtb0zrnMOSOp6Pqbsj386FANsud00fNRdbc7A0qWlaAncIPvZtk70t8UtjrXFkRds1lqYbIKAW1kgd/BiE42XY6s+2iR7nhHHwcLCUIOQbOLJWzSYk6Sa2Hm9WB5+oIuzVtt231mGJjg6Mbm/jYmWbTrddWgJl629Ja2Iw9GrxIhKsOMRJRfbP+3oi2UFX+/flFbq5LLAt9F+40cMoPGQZU7JA7ftV9/zN5BLmLwYjlvUYwzdc7uHlxavX765ekzH0kCbAng1GgxEtWeNDzXXvpL2B9X5dW23p5f/rfLvlTTRVGVrFZWSt7bAiMc5b1iM04/5o+y5jlfGBRFYregRunFqvafmXJpKJ27uMzbmTxF8iLW0nAGJDQr4I95MP3bAYvm9KftShjh1qooZxWpOY0T0u98b167t11lFEsjhJvEp2nV6Tnq2Gg46DOG7acV4UaMOjsn2KP7m5ZhnL29F7Haf4zPEFjf35IhmbJomR/Ma1FVNczxo+I9mkcp0GOtUuI76PjLj9QU4dhWOXKicv6C/5dHTDapXY9nq9kU+fvrijxbWTptjcrdfrfwNBkFPd",sidebar_class_name:"put api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},g=void 0,A={},j=[];function b(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Update Document"}),"\n",(0,i.jsx)(r(),{method:"put",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,i.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,i.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(c(),{parameters:[{name:"document_id",in:"path",description:"ID of the document that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}]}),"\n",(0,i.jsx)(l(),{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:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},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:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5}},title:"document_document_id_body"}}}}}),"\n",(0,i.jsx)(m(),{id:void 0,label:void 0,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"}}}}}})]})}function F(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.10a1f6ec.js b/assets/js/runtime~main.4b911e1f.js similarity index 87% rename from assets/js/runtime~main.10a1f6ec.js rename to assets/js/runtime~main.4b911e1f.js index ccb537840..37da37f7d 100644 --- a/assets/js/runtime~main.10a1f6ec.js +++ b/assets/js/runtime~main.4b911e1f.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,c,f,d,b={},r={};function t(e){var a=r[e];if(void 0!==a)return a.exports;var c=r[e]={id:e,loaded:!1,exports:{}};return b[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=b,t.c=r,e=[],t.O=(a,c,f,d)=>{if(!c){var b=1/0;for(n=0;n=d)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(r=!1,d0&&e[n-1][2]>d;n--)e[n]=e[n-1];e[n]=[c,f,d]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,f){if(1&f&&(e=this(e)),8&f)return e;if("object"==typeof e&&e){if(4&f&&e.__esModule)return e;if(16&f&&"function"==typeof e.then)return e}var d=Object.create(null);t.r(d);var b={};a=a||[null,c({}),c([]),c(c)];for(var r=2&f&&e;"object"==typeof r&&!~a.indexOf(r);r=c(r))Object.getOwnPropertyNames(r).forEach((a=>b[a]=()=>e[a]));return b.default=()=>e,t.d(d,b),d},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce(((a,c)=>(t.f[c](e,a),a)),[])),t.u=e=>"assets/js/"+({33:"7ad5624c",89:"3009d411",108:"1b14d97a",157:"8001f939",285:"23f866da",291:"4f7a2d40",300:"833eda7d",419:"e5d81aec",448:"d77fb6a8",490:"ce589067",539:"cfb1e6eb",560:"500027af",636:"eaa24e23",746:"cf03142d",841:"d1393a72",849:"0058b4c6",850:"c6b74119",930:"05729a5b",956:"19e4dfff",962:"046910c8",1179:"489b8a4d",1235:"a7456010",1440:"277a78f5",1477:"2f6ff211",1640:"c9fa5aa5",1651:"19e5ad2a",1665:"7357a3c5",1679:"138cee78",1688:"9640838e",1706:"18b84479",1903:"acecf23e",1924:"d8b805fb",1972:"73664a40",2042:"reactPlayerTwitch",2043:"ac7da374",2089:"c7b98810",2131:"299c7a47",2264:"17e5210b",2634:"c4f5d8e4",2661:"8bd80e56",2703:"da66eb9c",2711:"9e4087bc",2723:"reactPlayerMux",2908:"2c416566",2959:"50ea61d6",3021:"4cff09f6",3073:"e9e778b7",3128:"c674cfb4",3148:"1e1b513c",3230:"d480dde9",3249:"ccc49370",3276:"e5aefb32",3333:"e48228d1",3381:"42f80fc5",3392:"reactPlayerVidyard",3404:"03e06346",3460:"5ce6d213",3633:"b97a0b7b",3637:"f4f34a3a",3694:"8717b14a",3795:"c4fbe420",3841:"56b5f4f8",3891:"8e4d0438",3976:"0e384e19",4001:"d281bdbe",4106:"882238ec",4134:"393be207",4212:"621db11d",4232:"5a144266",4240:"9c9cb35e",4372:"9cd612ce",4466:"56b0ffe9",4584:"f82cd581",4813:"6875c492",4833:"c7e3ab5f",4865:"7ef59f7a",4952:"6bef026b",5277:"8320e026",5305:"87a6df42",5314:"88a819d0",5342:"4227e71a",5373:"02e5f5c4",5506:"01274ace",5510:"02d4f5c5",5524:"21f05a2f",5550:"14716de7",5557:"d9f32620",5597:"b18842e4",5742:"aba21aa0",5752:"6d2e526e",5794:"3b49dc44",5855:"444a2573",5881:"63d7f7ab",5939:"837d4f04",5970:"0f8cf55d",6007:"611db08b",6011:"56f1c106",6061:"1f391b9e",6157:"3973fcf3",6173:"reactPlayerVimeo",6192:"c195e1f1",6235:"d0524430",6288:"eedafdee",6295:"d91ad230",6318:"bb4fa758",6328:"reactPlayerDailyMotion",6353:"5e1bb91e",6463:"reactPlayerKaltura",6473:"4c5e977b",6505:"cd2b86eb",6648:"0c0943c7",6653:"f214d5ff",6743:"e226bb09",6841:"f22c5875",6887:"reactPlayerFacebook",6940:"a000203c",6969:"14eb3368",7024:"98334e25",7068:"e92d0461",7098:"a7bd4aaa",7318:"e76c28ee",7458:"reactPlayerFilePlayer",7472:"814f3328",7477:"36994c47",7570:"reactPlayerMixcloud",7574:"70276854",7627:"reactPlayerStreamable",7643:"a6aa9e1f",7696:"1ee58ee1",7757:"eb56c656",7904:"5144c8d4",7910:"e4f5c862",7960:"b2e6bd40",7968:"489197af",8e3:"54a7b8f4",8025:"5e90a9b3",8046:"6621d3c0",8097:"ab2a161b",8110:"825a5e83",8121:"3a2db09e",8130:"f81c1134",8146:"c15d9823",8168:"6c0cc40d",8209:"01a85c17",8446:"reactPlayerYouTube",8462:"3217192f",8474:"652d83be",8503:"012b45bf",8564:"58abd73c",8609:"925b3f96",8734:"reactPlayerPreview",8737:"7661071f",8749:"b93339ed",8901:"1c57a399",8927:"b0378e01",8947:"ef8b811a",9024:"e5a49157",9048:"a94703ab",9070:"851f8f65",9099:"34593b53",9190:"6cb65baf",9239:"0c806540",9241:"11b7b3d8",9325:"59362658",9328:"e273c56f",9340:"reactPlayerWistia",9350:"62b755e6",9426:"38ec836e",9490:"02fcf422",9570:"a3008c1e",9611:"06b6ef6a",9647:"5e95c892",9858:"1f7895dc",9979:"reactPlayerSoundCloud"}[e]||e)+"."+{33:"6ad534f5",89:"67599f09",108:"b9723cd9",157:"be2f595e",285:"89427f12",291:"4d88e708",300:"d5462c6f",419:"26112334",448:"3492c614",490:"a197b5a8",539:"ddb32cf1",560:"183f80db",636:"23fdfdd6",746:"49f86803",841:"2e9f4f9b",849:"ea176c57",850:"3ac080ec",930:"9f35584c",956:"e6fef687",962:"0758599a",1179:"955bead1",1235:"e0fce024",1440:"5dc69857",1463:"6c989e27",1477:"c7a939ea",1640:"d2ce80bf",1651:"f6c81f16",1665:"56289604",1679:"9f7fe758",1688:"2582d322",1706:"23ffef42",1903:"9c2000d9",1924:"fdb8fe31",1936:"3329227e",1972:"6aa170c8",2042:"ccdbba13",2043:"b0aacfe5",2089:"4267cecd",2131:"920ad619",2264:"03a17636",2489:"a212f802",2634:"b5502b21",2661:"881ab85e",2703:"c63a2c44",2711:"999c03aa",2723:"ad84c6fe",2908:"9a88f7fa",2959:"16d5d1b8",3021:"8265c79a",3042:"040aac0d",3073:"cff2425c",3128:"e29762a5",3148:"9a6039c4",3230:"9cb61f73",3249:"d6c50b29",3276:"00ab24d9",3333:"099c2226",3381:"dfcbba2f",3392:"a7951473",3404:"0d5f551b",3460:"4901096f",3633:"d2a8f664",3637:"ffa80471",3694:"4d710693",3795:"13bfbdc1",3841:"cf1c6a97",3891:"c8de3ba8",3976:"2d4c4f66",4001:"183be27c",4106:"d9d3f988",4132:"a5c6ef5a",4134:"7b436152",4212:"5dccb1c7",4232:"686c24b3",4240:"683dbb00",4372:"56e55e5e",4466:"8b9f41be",4584:"a7d307eb",4622:"420bc0ab",4813:"1198d246",4833:"786c2d78",4865:"e7cadeec",4952:"9881366e",5013:"b10f6f78",5277:"b2de11fb",5305:"760fdd56",5314:"2ddf281e",5342:"34e886ef",5373:"2b72627a",5506:"9d141ac4",5510:"92a4db7d",5524:"47dbdaaf",5550:"76bbef59",5557:"dffbf1c4",5597:"3dcd4c42",5742:"ac359952",5752:"89e61fc0",5794:"c75a31d7",5855:"84d22ac9",5881:"3782c030",5939:"07a6668d",5970:"91dc704f",6007:"bc61a38c",6011:"1a38abf2",6061:"bb03b217",6157:"fccfe0be",6173:"40e527dc",6192:"5e9d7258",6235:"86082012",6288:"cb1b5f05",6295:"958608f5",6318:"213b74ab",6328:"a2ec01b1",6353:"c48fddc9",6463:"665cb544",6473:"0243df4f",6505:"c6903d64",6648:"2847553a",6653:"fdbc0c47",6743:"a3fe848c",6841:"50291cb3",6887:"f478ac9c",6940:"fd8689e0",6969:"408561bf",7024:"0914355c",7054:"cab4fa5c",7068:"b64a0c73",7085:"2efbf216",7098:"c920e4e4",7318:"2bd572be",7458:"e1cdf442",7472:"909d2cac",7477:"4aaebd1d",7570:"086b8299",7574:"d5e60f67",7627:"df6df631",7643:"4bb958af",7696:"d7f04e0f",7757:"13e692a4",7904:"3387244e",7910:"5b11649a",7960:"26bd5237",7968:"14065b3d",8e3:"58f8ce85",8025:"18e81984",8046:"eb383529",8097:"43a7d9e8",8110:"f2fff490",8121:"adb9cf78",8130:"29afdc55",8146:"bdf3ab1c",8160:"4a1cc722",8168:"11595f0e",8209:"b9e31ef1",8446:"594ab8ca",8462:"d040ed86",8474:"97c5edc0",8503:"45b8fe0a",8564:"fdfdf0e6",8609:"6bdc8628",8734:"1f259505",8737:"f138d21c",8749:"c3230296",8901:"ef3d0d2a",8927:"cee13eea",8947:"19410731",9024:"331564b7",9048:"9a2fc095",9070:"069815d8",9099:"9a97a9b7",9190:"dd359a70",9239:"cb86fd3c",9241:"c62c9d6a",9325:"cc9232ad",9328:"18a92a49",9340:"91290ba6",9350:"65eb58f6",9426:"4597631d",9490:"9b8fc054",9570:"4cdcbf30",9611:"6c00e256",9647:"2f22c378",9858:"678dd4bc",9979:"84827225"}[e]+".js",t.miniCssF=e=>{},t.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),f={},d="OpenSign-Docs:",t.l=(e,a,c,b)=>{if(f[e])f[e].push(a);else{var r,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n{r.onerror=r.onload=null,clearTimeout(s);var d=f[e];if(delete f[e],r.parentNode&&r.parentNode.removeChild(r),d&&d.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:r}),12e4);r.onerror=u.bind(null,r.onerror),r.onload=u.bind(null,r.onload),o&&document.head.appendChild(r)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),t.p="/",t.gca=function(e){return e={59362658:"9325",70276854:"7574","7ad5624c":"33","3009d411":"89","1b14d97a":"108","8001f939":"157","23f866da":"285","4f7a2d40":"291","833eda7d":"300",e5d81aec:"419",d77fb6a8:"448",ce589067:"490",cfb1e6eb:"539","500027af":"560",eaa24e23:"636",cf03142d:"746",d1393a72:"841","0058b4c6":"849",c6b74119:"850","05729a5b":"930","19e4dfff":"956","046910c8":"962","489b8a4d":"1179",a7456010:"1235","277a78f5":"1440","2f6ff211":"1477",c9fa5aa5:"1640","19e5ad2a":"1651","7357a3c5":"1665","138cee78":"1679","9640838e":"1688","18b84479":"1706",acecf23e:"1903",d8b805fb:"1924","73664a40":"1972",reactPlayerTwitch:"2042",ac7da374:"2043",c7b98810:"2089","299c7a47":"2131","17e5210b":"2264",c4f5d8e4:"2634","8bd80e56":"2661",da66eb9c:"2703","9e4087bc":"2711",reactPlayerMux:"2723","2c416566":"2908","50ea61d6":"2959","4cff09f6":"3021",e9e778b7:"3073",c674cfb4:"3128","1e1b513c":"3148",d480dde9:"3230",ccc49370:"3249",e5aefb32:"3276",e48228d1:"3333","42f80fc5":"3381",reactPlayerVidyard:"3392","03e06346":"3404","5ce6d213":"3460",b97a0b7b:"3633",f4f34a3a:"3637","8717b14a":"3694",c4fbe420:"3795","56b5f4f8":"3841","8e4d0438":"3891","0e384e19":"3976",d281bdbe:"4001","882238ec":"4106","393be207":"4134","621db11d":"4212","5a144266":"4232","9c9cb35e":"4240","9cd612ce":"4372","56b0ffe9":"4466",f82cd581:"4584","6875c492":"4813",c7e3ab5f:"4833","7ef59f7a":"4865","6bef026b":"4952","8320e026":"5277","87a6df42":"5305","88a819d0":"5314","4227e71a":"5342","02e5f5c4":"5373","01274ace":"5506","02d4f5c5":"5510","21f05a2f":"5524","14716de7":"5550",d9f32620:"5557",b18842e4:"5597",aba21aa0:"5742","6d2e526e":"5752","3b49dc44":"5794","444a2573":"5855","63d7f7ab":"5881","837d4f04":"5939","0f8cf55d":"5970","611db08b":"6007","56f1c106":"6011","1f391b9e":"6061","3973fcf3":"6157",reactPlayerVimeo:"6173",c195e1f1:"6192",d0524430:"6235",eedafdee:"6288",d91ad230:"6295",bb4fa758:"6318",reactPlayerDailyMotion:"6328","5e1bb91e":"6353",reactPlayerKaltura:"6463","4c5e977b":"6473",cd2b86eb:"6505","0c0943c7":"6648",f214d5ff:"6653",e226bb09:"6743",f22c5875:"6841",reactPlayerFacebook:"6887",a000203c:"6940","14eb3368":"6969","98334e25":"7024",e92d0461:"7068",a7bd4aaa:"7098",e76c28ee:"7318",reactPlayerFilePlayer:"7458","814f3328":"7472","36994c47":"7477",reactPlayerMixcloud:"7570",reactPlayerStreamable:"7627",a6aa9e1f:"7643","1ee58ee1":"7696",eb56c656:"7757","5144c8d4":"7904",e4f5c862:"7910",b2e6bd40:"7960","489197af":"7968","54a7b8f4":"8000","5e90a9b3":"8025","6621d3c0":"8046",ab2a161b:"8097","825a5e83":"8110","3a2db09e":"8121",f81c1134:"8130",c15d9823:"8146","6c0cc40d":"8168","01a85c17":"8209",reactPlayerYouTube:"8446","3217192f":"8462","652d83be":"8474","012b45bf":"8503","58abd73c":"8564","925b3f96":"8609",reactPlayerPreview:"8734","7661071f":"8737",b93339ed:"8749","1c57a399":"8901",b0378e01:"8927",ef8b811a:"8947",e5a49157:"9024",a94703ab:"9048","851f8f65":"9070","34593b53":"9099","6cb65baf":"9190","0c806540":"9239","11b7b3d8":"9241",e273c56f:"9328",reactPlayerWistia:"9340","62b755e6":"9350","38ec836e":"9426","02fcf422":"9490",a3008c1e:"9570","06b6ef6a":"9611","5e95c892":"9647","1f7895dc":"9858",reactPlayerSoundCloud:"9979"}[e]||e,t.p+t.u(e)},(()=>{var e={5354:0,1869:0};t.f.j=(a,c)=>{var f=t.o(e,a)?e[a]:void 0;if(0!==f)if(f)c.push(f[2]);else if(/^(1869|5354)$/.test(a))e[a]=0;else{var d=new Promise(((c,d)=>f=e[a]=[c,d]));c.push(f[2]=d);var b=t.p+t.u(a),r=new Error;t.l(b,(c=>{if(t.o(e,a)&&(0!==(f=e[a])&&(e[a]=void 0),f)){var d=c&&("load"===c.type?"missing":c.type),b=c&&c.target&&c.target.src;r.message="Loading chunk "+a+" failed.\n("+d+": "+b+")",r.name="ChunkLoadError",r.type=d,r.request=b,f[1](r)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var f,d,b=c[0],r=c[1],o=c[2],l=0;if(b.some((a=>0!==e[a]))){for(f in r)t.o(r,f)&&(t.m[f]=r[f]);if(o)var n=o(t)}for(a&&a(c);l{"use strict";var e,a,c,f,d,b={},r={};function t(e){var a=r[e];if(void 0!==a)return a.exports;var c=r[e]={id:e,loaded:!1,exports:{}};return b[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=b,t.c=r,e=[],t.O=(a,c,f,d)=>{if(!c){var b=1/0;for(n=0;n=d)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(r=!1,d0&&e[n-1][2]>d;n--)e[n]=e[n-1];e[n]=[c,f,d]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,f){if(1&f&&(e=this(e)),8&f)return e;if("object"==typeof e&&e){if(4&f&&e.__esModule)return e;if(16&f&&"function"==typeof e.then)return e}var d=Object.create(null);t.r(d);var b={};a=a||[null,c({}),c([]),c(c)];for(var r=2&f&&e;"object"==typeof r&&!~a.indexOf(r);r=c(r))Object.getOwnPropertyNames(r).forEach((a=>b[a]=()=>e[a]));return b.default=()=>e,t.d(d,b),d},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce(((a,c)=>(t.f[c](e,a),a)),[])),t.u=e=>"assets/js/"+({33:"7ad5624c",89:"3009d411",108:"1b14d97a",157:"8001f939",285:"23f866da",291:"4f7a2d40",300:"833eda7d",419:"e5d81aec",448:"d77fb6a8",490:"ce589067",539:"cfb1e6eb",560:"500027af",636:"eaa24e23",746:"cf03142d",841:"d1393a72",849:"0058b4c6",850:"c6b74119",930:"05729a5b",956:"19e4dfff",962:"046910c8",1179:"489b8a4d",1235:"a7456010",1440:"277a78f5",1477:"2f6ff211",1640:"c9fa5aa5",1651:"19e5ad2a",1665:"7357a3c5",1679:"138cee78",1688:"9640838e",1706:"18b84479",1903:"acecf23e",1924:"d8b805fb",1972:"73664a40",2042:"reactPlayerTwitch",2043:"ac7da374",2089:"c7b98810",2131:"299c7a47",2264:"17e5210b",2634:"c4f5d8e4",2661:"8bd80e56",2703:"da66eb9c",2711:"9e4087bc",2723:"reactPlayerMux",2908:"2c416566",2959:"50ea61d6",3021:"4cff09f6",3073:"e9e778b7",3128:"c674cfb4",3148:"1e1b513c",3230:"d480dde9",3249:"ccc49370",3276:"e5aefb32",3333:"e48228d1",3381:"42f80fc5",3392:"reactPlayerVidyard",3404:"03e06346",3460:"5ce6d213",3633:"b97a0b7b",3637:"f4f34a3a",3694:"8717b14a",3795:"c4fbe420",3841:"56b5f4f8",3891:"8e4d0438",3976:"0e384e19",4001:"d281bdbe",4106:"882238ec",4134:"393be207",4212:"621db11d",4232:"5a144266",4240:"9c9cb35e",4372:"9cd612ce",4466:"56b0ffe9",4584:"f82cd581",4813:"6875c492",4833:"c7e3ab5f",4865:"7ef59f7a",4952:"6bef026b",5277:"8320e026",5305:"87a6df42",5314:"88a819d0",5342:"4227e71a",5373:"02e5f5c4",5506:"01274ace",5510:"02d4f5c5",5524:"21f05a2f",5550:"14716de7",5557:"d9f32620",5597:"b18842e4",5742:"aba21aa0",5752:"6d2e526e",5794:"3b49dc44",5855:"444a2573",5881:"63d7f7ab",5939:"837d4f04",5970:"0f8cf55d",6007:"611db08b",6011:"56f1c106",6061:"1f391b9e",6157:"3973fcf3",6173:"reactPlayerVimeo",6192:"c195e1f1",6235:"d0524430",6288:"eedafdee",6295:"d91ad230",6318:"bb4fa758",6328:"reactPlayerDailyMotion",6353:"5e1bb91e",6463:"reactPlayerKaltura",6473:"4c5e977b",6505:"cd2b86eb",6648:"0c0943c7",6653:"f214d5ff",6743:"e226bb09",6841:"f22c5875",6887:"reactPlayerFacebook",6940:"a000203c",6969:"14eb3368",7024:"98334e25",7068:"e92d0461",7098:"a7bd4aaa",7318:"e76c28ee",7458:"reactPlayerFilePlayer",7472:"814f3328",7477:"36994c47",7570:"reactPlayerMixcloud",7574:"70276854",7627:"reactPlayerStreamable",7643:"a6aa9e1f",7696:"1ee58ee1",7757:"eb56c656",7904:"5144c8d4",7910:"e4f5c862",7960:"b2e6bd40",7968:"489197af",8e3:"54a7b8f4",8025:"5e90a9b3",8046:"6621d3c0",8097:"ab2a161b",8110:"825a5e83",8121:"3a2db09e",8130:"f81c1134",8146:"c15d9823",8168:"6c0cc40d",8209:"01a85c17",8446:"reactPlayerYouTube",8462:"3217192f",8474:"652d83be",8503:"012b45bf",8564:"58abd73c",8609:"925b3f96",8734:"reactPlayerPreview",8737:"7661071f",8749:"b93339ed",8901:"1c57a399",8927:"b0378e01",8947:"ef8b811a",9024:"e5a49157",9048:"a94703ab",9070:"851f8f65",9099:"34593b53",9190:"6cb65baf",9239:"0c806540",9241:"11b7b3d8",9325:"59362658",9328:"e273c56f",9340:"reactPlayerWistia",9350:"62b755e6",9426:"38ec836e",9490:"02fcf422",9570:"a3008c1e",9611:"06b6ef6a",9647:"5e95c892",9858:"1f7895dc",9979:"reactPlayerSoundCloud"}[e]||e)+"."+{33:"2ce1b623",89:"67599f09",108:"b9723cd9",157:"be2f595e",285:"fc639d99",291:"4d88e708",300:"d5462c6f",419:"26112334",448:"3492c614",490:"a197b5a8",539:"ddb32cf1",560:"183f80db",636:"23fdfdd6",746:"49f86803",841:"2e9f4f9b",849:"6a6bc5e1",850:"3ac080ec",930:"9f35584c",956:"e6fef687",962:"0758599a",1179:"955bead1",1235:"e0fce024",1440:"5dc69857",1463:"6c989e27",1477:"c7a939ea",1640:"d2ce80bf",1651:"d6aec8c4",1665:"6005cc6b",1679:"45f63326",1688:"2582d322",1706:"33c9f705",1903:"9c2000d9",1924:"fdb8fe31",1936:"3329227e",1972:"6aa170c8",2042:"ccdbba13",2043:"4a1b8c9b",2089:"4267cecd",2131:"920ad619",2264:"03a17636",2489:"a212f802",2634:"b5502b21",2661:"881ab85e",2703:"717af639",2711:"999c03aa",2723:"ad84c6fe",2908:"9a88f7fa",2959:"16d5d1b8",3021:"8265c79a",3042:"040aac0d",3073:"cff2425c",3128:"e29762a5",3148:"9a6039c4",3230:"a2cfa06b",3249:"d6c50b29",3276:"00ab24d9",3333:"099c2226",3381:"dfcbba2f",3392:"a7951473",3404:"273c75f9",3460:"827e01c6",3633:"d2a8f664",3637:"ffa80471",3694:"4d710693",3795:"4ae7e25d",3841:"cf1c6a97",3891:"c8de3ba8",3976:"2d4c4f66",4001:"183be27c",4106:"d9d3f988",4132:"a5c6ef5a",4134:"7b436152",4212:"5dccb1c7",4232:"804e9e11",4240:"16dc0dc6",4372:"b75be620",4466:"8b9f41be",4584:"a7d307eb",4622:"420bc0ab",4813:"1198d246",4833:"cf9a081c",4865:"4a732e7a",4952:"9881366e",5013:"b10f6f78",5277:"b2de11fb",5305:"760fdd56",5314:"2ddf281e",5342:"3f44a353",5373:"60be571e",5506:"9d141ac4",5510:"92a4db7d",5524:"47dbdaaf",5550:"76bbef59",5557:"dffbf1c4",5597:"3dcd4c42",5742:"ac359952",5752:"9f2d8c5b",5794:"c75a31d7",5855:"84d22ac9",5881:"3782c030",5939:"07a6668d",5970:"91dc704f",6007:"bc61a38c",6011:"1a38abf2",6061:"bb03b217",6157:"fccfe0be",6173:"40e527dc",6192:"42e352ca",6235:"5aa106b8",6288:"cb1b5f05",6295:"958608f5",6318:"213b74ab",6328:"a2ec01b1",6353:"c48fddc9",6463:"665cb544",6473:"0243df4f",6505:"c6903d64",6648:"2847553a",6653:"fdbc0c47",6743:"a3fe848c",6841:"50291cb3",6887:"f478ac9c",6940:"fd8689e0",6969:"408561bf",7024:"163938f2",7054:"cab4fa5c",7068:"b64a0c73",7085:"2efbf216",7098:"c920e4e4",7318:"2bd572be",7458:"e1cdf442",7472:"909d2cac",7477:"4aaebd1d",7570:"086b8299",7574:"d5e60f67",7627:"df6df631",7643:"4bb958af",7696:"d7f04e0f",7757:"13e692a4",7904:"d7ccdb73",7910:"5b11649a",7960:"102fca2b",7968:"14065b3d",8e3:"58f8ce85",8025:"18e81984",8046:"eb383529",8097:"43a7d9e8",8110:"f2fff490",8121:"adb9cf78",8130:"29afdc55",8146:"bdf3ab1c",8160:"4a1cc722",8168:"11595f0e",8209:"b9e31ef1",8446:"594ab8ca",8462:"d040ed86",8474:"97c5edc0",8503:"45b8fe0a",8564:"7661f930",8609:"6bdc8628",8734:"1f259505",8737:"f138d21c",8749:"bc214206",8901:"e05f6301",8927:"cee13eea",8947:"19410731",9024:"331564b7",9048:"9a2fc095",9070:"6def8ea3",9099:"8d3db6df",9190:"dd359a70",9239:"cb86fd3c",9241:"c62c9d6a",9325:"cc9232ad",9328:"18a92a49",9340:"91290ba6",9350:"4db3ade4",9426:"4597631d",9490:"9b8fc054",9570:"4cdcbf30",9611:"6c00e256",9647:"2f22c378",9858:"678dd4bc",9979:"84827225"}[e]+".js",t.miniCssF=e=>{},t.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),f={},d="OpenSign-Docs:",t.l=(e,a,c,b)=>{if(f[e])f[e].push(a);else{var r,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n{r.onerror=r.onload=null,clearTimeout(s);var d=f[e];if(delete f[e],r.parentNode&&r.parentNode.removeChild(r),d&&d.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:r}),12e4);r.onerror=u.bind(null,r.onerror),r.onload=u.bind(null,r.onload),o&&document.head.appendChild(r)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),t.p="/",t.gca=function(e){return e={59362658:"9325",70276854:"7574","7ad5624c":"33","3009d411":"89","1b14d97a":"108","8001f939":"157","23f866da":"285","4f7a2d40":"291","833eda7d":"300",e5d81aec:"419",d77fb6a8:"448",ce589067:"490",cfb1e6eb:"539","500027af":"560",eaa24e23:"636",cf03142d:"746",d1393a72:"841","0058b4c6":"849",c6b74119:"850","05729a5b":"930","19e4dfff":"956","046910c8":"962","489b8a4d":"1179",a7456010:"1235","277a78f5":"1440","2f6ff211":"1477",c9fa5aa5:"1640","19e5ad2a":"1651","7357a3c5":"1665","138cee78":"1679","9640838e":"1688","18b84479":"1706",acecf23e:"1903",d8b805fb:"1924","73664a40":"1972",reactPlayerTwitch:"2042",ac7da374:"2043",c7b98810:"2089","299c7a47":"2131","17e5210b":"2264",c4f5d8e4:"2634","8bd80e56":"2661",da66eb9c:"2703","9e4087bc":"2711",reactPlayerMux:"2723","2c416566":"2908","50ea61d6":"2959","4cff09f6":"3021",e9e778b7:"3073",c674cfb4:"3128","1e1b513c":"3148",d480dde9:"3230",ccc49370:"3249",e5aefb32:"3276",e48228d1:"3333","42f80fc5":"3381",reactPlayerVidyard:"3392","03e06346":"3404","5ce6d213":"3460",b97a0b7b:"3633",f4f34a3a:"3637","8717b14a":"3694",c4fbe420:"3795","56b5f4f8":"3841","8e4d0438":"3891","0e384e19":"3976",d281bdbe:"4001","882238ec":"4106","393be207":"4134","621db11d":"4212","5a144266":"4232","9c9cb35e":"4240","9cd612ce":"4372","56b0ffe9":"4466",f82cd581:"4584","6875c492":"4813",c7e3ab5f:"4833","7ef59f7a":"4865","6bef026b":"4952","8320e026":"5277","87a6df42":"5305","88a819d0":"5314","4227e71a":"5342","02e5f5c4":"5373","01274ace":"5506","02d4f5c5":"5510","21f05a2f":"5524","14716de7":"5550",d9f32620:"5557",b18842e4:"5597",aba21aa0:"5742","6d2e526e":"5752","3b49dc44":"5794","444a2573":"5855","63d7f7ab":"5881","837d4f04":"5939","0f8cf55d":"5970","611db08b":"6007","56f1c106":"6011","1f391b9e":"6061","3973fcf3":"6157",reactPlayerVimeo:"6173",c195e1f1:"6192",d0524430:"6235",eedafdee:"6288",d91ad230:"6295",bb4fa758:"6318",reactPlayerDailyMotion:"6328","5e1bb91e":"6353",reactPlayerKaltura:"6463","4c5e977b":"6473",cd2b86eb:"6505","0c0943c7":"6648",f214d5ff:"6653",e226bb09:"6743",f22c5875:"6841",reactPlayerFacebook:"6887",a000203c:"6940","14eb3368":"6969","98334e25":"7024",e92d0461:"7068",a7bd4aaa:"7098",e76c28ee:"7318",reactPlayerFilePlayer:"7458","814f3328":"7472","36994c47":"7477",reactPlayerMixcloud:"7570",reactPlayerStreamable:"7627",a6aa9e1f:"7643","1ee58ee1":"7696",eb56c656:"7757","5144c8d4":"7904",e4f5c862:"7910",b2e6bd40:"7960","489197af":"7968","54a7b8f4":"8000","5e90a9b3":"8025","6621d3c0":"8046",ab2a161b:"8097","825a5e83":"8110","3a2db09e":"8121",f81c1134:"8130",c15d9823:"8146","6c0cc40d":"8168","01a85c17":"8209",reactPlayerYouTube:"8446","3217192f":"8462","652d83be":"8474","012b45bf":"8503","58abd73c":"8564","925b3f96":"8609",reactPlayerPreview:"8734","7661071f":"8737",b93339ed:"8749","1c57a399":"8901",b0378e01:"8927",ef8b811a:"8947",e5a49157:"9024",a94703ab:"9048","851f8f65":"9070","34593b53":"9099","6cb65baf":"9190","0c806540":"9239","11b7b3d8":"9241",e273c56f:"9328",reactPlayerWistia:"9340","62b755e6":"9350","38ec836e":"9426","02fcf422":"9490",a3008c1e:"9570","06b6ef6a":"9611","5e95c892":"9647","1f7895dc":"9858",reactPlayerSoundCloud:"9979"}[e]||e,t.p+t.u(e)},(()=>{var e={5354:0,1869:0};t.f.j=(a,c)=>{var f=t.o(e,a)?e[a]:void 0;if(0!==f)if(f)c.push(f[2]);else if(/^(1869|5354)$/.test(a))e[a]=0;else{var d=new Promise(((c,d)=>f=e[a]=[c,d]));c.push(f[2]=d);var b=t.p+t.u(a),r=new Error;t.l(b,(c=>{if(t.o(e,a)&&(0!==(f=e[a])&&(e[a]=void 0),f)){var d=c&&("load"===c.type?"missing":c.type),b=c&&c.target&&c.target.src;r.message="Loading chunk "+a+" failed.\n("+d+": "+b+")",r.name="ChunkLoadError",r.type=d,r.request=b,f[1](r)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var f,d,b=c[0],r=c[1],o=c[2],l=0;if(b.some((a=>0!==e[a]))){for(f in r)t.o(r,f)&&(t.m[f]=r[f]);if(o)var n=o(t)}for(a&&a(c);l Archive | OpenSign™ - + diff --git a/blog/authors/index.html b/blog/authors/index.html index dd7b4537c..31aa6698e 100644 --- a/blog/authors/index.html +++ b/blog/authors/index.html @@ -5,7 +5,7 @@ Authors | OpenSign™ - + diff --git a/blog/first-blog-post/index.html b/blog/first-blog-post/index.html index d6c1e8090..3244b7a7e 100644 --- a/blog/first-blog-post/index.html +++ b/blog/first-blog-post/index.html @@ -5,7 +5,7 @@ First Blog Post | OpenSign™ - + diff --git a/blog/index.html b/blog/index.html index 84ecd4c2f..0b5025b83 100644 --- a/blog/index.html +++ b/blog/index.html @@ -5,7 +5,7 @@ Blog | OpenSign™ - + diff --git a/blog/long-blog-post/index.html b/blog/long-blog-post/index.html index 7a66addf5..6785b3e75 100644 --- a/blog/long-blog-post/index.html +++ b/blog/long-blog-post/index.html @@ -5,7 +5,7 @@ Long Blog Post | OpenSign™ - + diff --git a/blog/mdx-blog-post/index.html b/blog/mdx-blog-post/index.html index a9f01e093..b90c444d9 100644 --- a/blog/mdx-blog-post/index.html +++ b/blog/mdx-blog-post/index.html @@ -5,7 +5,7 @@ MDX Blog Post | OpenSign™ - + diff --git a/blog/tags/docusaurus/index.html b/blog/tags/docusaurus/index.html index 311df6167..a2ccfcba0 100644 --- a/blog/tags/docusaurus/index.html +++ b/blog/tags/docusaurus/index.html @@ -5,7 +5,7 @@ 4 posts tagged with "docusaurus" | OpenSign™ - + diff --git a/blog/tags/facebook/index.html b/blog/tags/facebook/index.html index 236cbf75f..7bb9c6ab3 100644 --- a/blog/tags/facebook/index.html +++ b/blog/tags/facebook/index.html @@ -5,7 +5,7 @@ One post tagged with "facebook" | OpenSign™ - + diff --git a/blog/tags/hello/index.html b/blog/tags/hello/index.html index 574ed8c51..117b587ad 100644 --- a/blog/tags/hello/index.html +++ b/blog/tags/hello/index.html @@ -5,7 +5,7 @@ 2 posts tagged with "hello" | OpenSign™ - + diff --git a/blog/tags/hola/index.html b/blog/tags/hola/index.html index ac4bf3f8b..756b5d114 100644 --- a/blog/tags/hola/index.html +++ b/blog/tags/hola/index.html @@ -5,7 +5,7 @@ One post tagged with "hola" | OpenSign™ - + diff --git a/blog/tags/index.html b/blog/tags/index.html index 331b9fe42..d2742a99f 100644 --- a/blog/tags/index.html +++ b/blog/tags/index.html @@ -5,7 +5,7 @@ Tags | OpenSign™ - + diff --git a/blog/welcome/index.html b/blog/welcome/index.html index 38061ca12..af44672d3 100644 --- a/blog/welcome/index.html +++ b/blog/welcome/index.html @@ -5,7 +5,7 @@ Welcome | OpenSign™ - + diff --git a/docs/API-docs/api-intro/index.html b/docs/API-docs/api-intro/index.html index be4449497..d2d869dbd 100644 --- a/docs/API-docs/api-intro/index.html +++ b/docs/API-docs/api-intro/index.html @@ -5,7 +5,7 @@ OpenSign APIs | OpenSign™ - + diff --git a/docs/API-docs/v1.1/contactlist/index.html b/docs/API-docs/v1.1/contactlist/index.html index 26c17a145..48ed7b20e 100644 --- a/docs/API-docs/v1.1/contactlist/index.html +++ b/docs/API-docs/v1.1/contactlist/index.html @@ -5,7 +5,7 @@ Get Contact list | OpenSign™ - + diff --git a/docs/API-docs/v1.1/createcontact/index.html b/docs/API-docs/v1.1/createcontact/index.html index 881f6cf1d..c9428f24b 100644 --- a/docs/API-docs/v1.1/createcontact/index.html +++ b/docs/API-docs/v1.1/createcontact/index.html @@ -5,7 +5,7 @@ Create Contact | OpenSign™ - + diff --git a/docs/API-docs/v1.1/createdocument/index.html b/docs/API-docs/v1.1/createdocument/index.html index 53595ce0e..9955a59c8 100644 --- a/docs/API-docs/v1.1/createdocument/index.html +++ b/docs/API-docs/v1.1/createdocument/index.html @@ -5,7 +5,7 @@ Create Document | OpenSign™ - + diff --git a/docs/API-docs/v1.1/createdocumentwithtemplateid/index.html b/docs/API-docs/v1.1/createdocumentwithtemplateid/index.html index 43ef81aaf..cdd540111 100644 --- a/docs/API-docs/v1.1/createdocumentwithtemplateid/index.html +++ b/docs/API-docs/v1.1/createdocumentwithtemplateid/index.html @@ -5,7 +5,7 @@ Create Document from Template | OpenSign™ - + diff --git a/docs/API-docs/v1.1/createfolder/index.html b/docs/API-docs/v1.1/createfolder/index.html index a466995aa..6e85f9a4e 100644 --- a/docs/API-docs/v1.1/createfolder/index.html +++ b/docs/API-docs/v1.1/createfolder/index.html @@ -5,7 +5,7 @@ Create Folder | OpenSign™ - + diff --git a/docs/API-docs/v1.1/createtemplate/index.html b/docs/API-docs/v1.1/createtemplate/index.html index 1a7c1bff6..d6d4102d3 100644 --- a/docs/API-docs/v1.1/createtemplate/index.html +++ b/docs/API-docs/v1.1/createtemplate/index.html @@ -5,7 +5,7 @@ Create Template | OpenSign™ - + diff --git a/docs/API-docs/v1.1/delete-template/index.html b/docs/API-docs/v1.1/delete-template/index.html index e9b6cac11..cde352988 100644 --- a/docs/API-docs/v1.1/delete-template/index.html +++ b/docs/API-docs/v1.1/delete-template/index.html @@ -5,7 +5,7 @@ Delete Template | OpenSign™ - + diff --git a/docs/API-docs/v1.1/delete-webhook/index.html b/docs/API-docs/v1.1/delete-webhook/index.html index ab2b4fb76..690355d8d 100644 --- a/docs/API-docs/v1.1/delete-webhook/index.html +++ b/docs/API-docs/v1.1/delete-webhook/index.html @@ -5,7 +5,7 @@ Delete Webhook | OpenSign™ - + diff --git a/docs/API-docs/v1.1/deletecontact/index.html b/docs/API-docs/v1.1/deletecontact/index.html index fea9be4f2..1606f04a5 100644 --- a/docs/API-docs/v1.1/deletecontact/index.html +++ b/docs/API-docs/v1.1/deletecontact/index.html @@ -5,7 +5,7 @@ Delete Contact | OpenSign™ - + diff --git a/docs/API-docs/v1.1/deletedocument/index.html b/docs/API-docs/v1.1/deletedocument/index.html index bce8e2608..9a0c120d0 100644 --- a/docs/API-docs/v1.1/deletedocument/index.html +++ b/docs/API-docs/v1.1/deletedocument/index.html @@ -5,7 +5,7 @@ Delete Document | OpenSign™ - + diff --git a/docs/API-docs/v1.1/deletefolder/index.html b/docs/API-docs/v1.1/deletefolder/index.html index 001f94b93..08cdbc800 100644 --- a/docs/API-docs/v1.1/deletefolder/index.html +++ b/docs/API-docs/v1.1/deletefolder/index.html @@ -5,7 +5,7 @@ Delete Folder | OpenSign™ - + diff --git a/docs/API-docs/v1.1/draftdocument/index.html b/docs/API-docs/v1.1/draftdocument/index.html index b2c12ee8c..5605fb546 100644 --- a/docs/API-docs/v1.1/draftdocument/index.html +++ b/docs/API-docs/v1.1/draftdocument/index.html @@ -5,7 +5,7 @@ Draft Document | OpenSign™ - + diff --git a/docs/API-docs/v1.1/drafttemplate/index.html b/docs/API-docs/v1.1/drafttemplate/index.html index d60543a1f..d0c45c438 100644 --- a/docs/API-docs/v1.1/drafttemplate/index.html +++ b/docs/API-docs/v1.1/drafttemplate/index.html @@ -5,7 +5,7 @@ Draft Template | OpenSign™ - + diff --git a/docs/API-docs/v1.1/folderlist/index.html b/docs/API-docs/v1.1/folderlist/index.html index 24bfb229f..7288f088a 100644 --- a/docs/API-docs/v1.1/folderlist/index.html +++ b/docs/API-docs/v1.1/folderlist/index.html @@ -5,7 +5,7 @@ Get folder list | OpenSign™ - + diff --git a/docs/API-docs/v1.1/get-template/index.html b/docs/API-docs/v1.1/get-template/index.html index 304530707..e49be212b 100644 --- a/docs/API-docs/v1.1/get-template/index.html +++ b/docs/API-docs/v1.1/get-template/index.html @@ -5,7 +5,7 @@ Get Template | OpenSign™ - + diff --git a/docs/API-docs/v1.1/get-user/index.html b/docs/API-docs/v1.1/get-user/index.html index 75777ee7e..8343343e4 100644 --- a/docs/API-docs/v1.1/get-user/index.html +++ b/docs/API-docs/v1.1/get-user/index.html @@ -5,7 +5,7 @@ Get your account details | OpenSign™ - + diff --git a/docs/API-docs/v1.1/get-webhook/index.html b/docs/API-docs/v1.1/get-webhook/index.html index fd2194627..63f30ff7c 100644 --- a/docs/API-docs/v1.1/get-webhook/index.html +++ b/docs/API-docs/v1.1/get-webhook/index.html @@ -5,7 +5,7 @@ Get Webhook | OpenSign™ - + diff --git a/docs/API-docs/v1.1/getcontact/index.html b/docs/API-docs/v1.1/getcontact/index.html index df75a46b4..fc22815d1 100644 --- a/docs/API-docs/v1.1/getcontact/index.html +++ b/docs/API-docs/v1.1/getcontact/index.html @@ -5,7 +5,7 @@ Get Contact | OpenSign™ - + diff --git a/docs/API-docs/v1.1/getdocument/index.html b/docs/API-docs/v1.1/getdocument/index.html index 5d5b16935..ef3bcd6ea 100644 --- a/docs/API-docs/v1.1/getdocument/index.html +++ b/docs/API-docs/v1.1/getdocument/index.html @@ -5,7 +5,7 @@ Get Document | OpenSign™ - + diff --git a/docs/API-docs/v1.1/getdocumentlist/index.html b/docs/API-docs/v1.1/getdocumentlist/index.html index 8cd499432..b264f1f4c 100644 --- a/docs/API-docs/v1.1/getdocumentlist/index.html +++ b/docs/API-docs/v1.1/getdocumentlist/index.html @@ -5,7 +5,7 @@ Get Document list from status | OpenSign™ - + diff --git a/docs/API-docs/v1.1/getfolder/index.html b/docs/API-docs/v1.1/getfolder/index.html index 842273bb8..59e3b0056 100644 --- a/docs/API-docs/v1.1/getfolder/index.html +++ b/docs/API-docs/v1.1/getfolder/index.html @@ -5,7 +5,7 @@ Get Folder | OpenSign™ - + diff --git a/docs/API-docs/v1.1/gettemplatelist/index.html b/docs/API-docs/v1.1/gettemplatelist/index.html index 5b15e13c2..5c2419770 100644 --- a/docs/API-docs/v1.1/gettemplatelist/index.html +++ b/docs/API-docs/v1.1/gettemplatelist/index.html @@ -5,7 +5,7 @@ Get Template list | OpenSign™ - + diff --git a/docs/API-docs/v1.1/index.html b/docs/API-docs/v1.1/index.html index aa6060d6d..d340ae4d1 100644 --- a/docs/API-docs/v1.1/index.html +++ b/docs/API-docs/v1.1/index.html @@ -5,10 +5,10 @@ OpenSign API v1.1 | OpenSign™ - + -

OpenSign API v1.1

+

OpenSign API v1.1

\ No newline at end of file diff --git a/docs/API-docs/v1.1/intro/index.html b/docs/API-docs/v1.1/intro/index.html index 6cf18d19a..4e2d26a2d 100644 --- a/docs/API-docs/v1.1/intro/index.html +++ b/docs/API-docs/v1.1/intro/index.html @@ -5,7 +5,7 @@ Overview | OpenSign™ - + diff --git a/docs/API-docs/v1.1/opensign-api-v-1-1/index.html b/docs/API-docs/v1.1/opensign-api-v-1-1/index.html index 9b6aaf1f7..975cb2eb0 100644 --- a/docs/API-docs/v1.1/opensign-api-v-1-1/index.html +++ b/docs/API-docs/v1.1/opensign-api-v-1-1/index.html @@ -3,15 +3,15 @@ -OpenSign API v1.1 | OpenSign™ +OpenSign API v1.1 | OpenSign™ - +
Version: 1.0.0

OpenSign API v1.1

-

Welcome to the OpenSign™ API documentation v1.1!

+

Welcome to the OpenSign™ API v1.1 documentation.

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™ delivers robust solutions tailored to your needs.

Explore our comprehensive guides, code samples, and best practices to unlock the full potential of OpenSign™ and transform your digital document processes.

Useful Links:

diff --git a/docs/API-docs/v1.1/publictemplate/index.html b/docs/API-docs/v1.1/publictemplate/index.html index 22c5a1fa0..ecdd0b4d0 100644 --- a/docs/API-docs/v1.1/publictemplate/index.html +++ b/docs/API-docs/v1.1/publictemplate/index.html @@ -5,7 +5,7 @@ Public Template | OpenSign™ - + diff --git a/docs/API-docs/v1.1/resendrequestmail/index.html b/docs/API-docs/v1.1/resendrequestmail/index.html index fcdef09f9..591999856 100644 --- a/docs/API-docs/v1.1/resendrequestmail/index.html +++ b/docs/API-docs/v1.1/resendrequestmail/index.html @@ -5,7 +5,7 @@ Resend request mail | OpenSign™ - + diff --git a/docs/API-docs/v1.1/revokedocument/index.html b/docs/API-docs/v1.1/revokedocument/index.html index 5bdf2f482..0e45fd8ae 100644 --- a/docs/API-docs/v1.1/revokedocument/index.html +++ b/docs/API-docs/v1.1/revokedocument/index.html @@ -5,7 +5,7 @@ Revoke Document | OpenSign™ - + diff --git a/docs/API-docs/v1.1/save-update-webhook/index.html b/docs/API-docs/v1.1/save-update-webhook/index.html index 7cb7bee07..4774c1015 100644 --- a/docs/API-docs/v1.1/save-update-webhook/index.html +++ b/docs/API-docs/v1.1/save-update-webhook/index.html @@ -5,7 +5,7 @@ Save or Update Webhook | OpenSign™ - + diff --git a/docs/API-docs/v1.1/selfsign/index.html b/docs/API-docs/v1.1/selfsign/index.html index 7bb5bb60d..4ac059d64 100644 --- a/docs/API-docs/v1.1/selfsign/index.html +++ b/docs/API-docs/v1.1/selfsign/index.html @@ -5,7 +5,7 @@ Self Sign | OpenSign™ - + diff --git a/docs/API-docs/v1.1/update-document/index.html b/docs/API-docs/v1.1/update-document/index.html index 2ae834a85..7bd4af513 100644 --- a/docs/API-docs/v1.1/update-document/index.html +++ b/docs/API-docs/v1.1/update-document/index.html @@ -5,7 +5,7 @@ Update Document | OpenSign™ - + diff --git a/docs/API-docs/v1.1/update-template/index.html b/docs/API-docs/v1.1/update-template/index.html index c0fb299cc..3c3ba8c46 100644 --- a/docs/API-docs/v1.1/update-template/index.html +++ b/docs/API-docs/v1.1/update-template/index.html @@ -5,7 +5,7 @@ Update Template | OpenSign™ - + diff --git a/docs/API-docs/v1.1/updatefolder/index.html b/docs/API-docs/v1.1/updatefolder/index.html index df18a347b..d78a7267d 100644 --- a/docs/API-docs/v1.1/updatefolder/index.html +++ b/docs/API-docs/v1.1/updatefolder/index.html @@ -5,7 +5,7 @@ Update Folder | OpenSign™ - + diff --git a/docs/API-docs/v1/contactlist/index.html b/docs/API-docs/v1/contactlist/index.html index 33279d001..42f9e5463 100644 --- a/docs/API-docs/v1/contactlist/index.html +++ b/docs/API-docs/v1/contactlist/index.html @@ -5,7 +5,7 @@ Get Contact list | OpenSign™ - + diff --git a/docs/API-docs/v1/createcontact/index.html b/docs/API-docs/v1/createcontact/index.html index f8bb38372..e02de706a 100644 --- a/docs/API-docs/v1/createcontact/index.html +++ b/docs/API-docs/v1/createcontact/index.html @@ -5,7 +5,7 @@ Create Contact | OpenSign™ - + diff --git a/docs/API-docs/v1/createdocument/index.html b/docs/API-docs/v1/createdocument/index.html index debdaaf41..088a23394 100644 --- a/docs/API-docs/v1/createdocument/index.html +++ b/docs/API-docs/v1/createdocument/index.html @@ -5,7 +5,7 @@ Create Document | OpenSign™ - + diff --git a/docs/API-docs/v1/createdocumentwithtemplateid/index.html b/docs/API-docs/v1/createdocumentwithtemplateid/index.html index e73660449..affeea52f 100644 --- a/docs/API-docs/v1/createdocumentwithtemplateid/index.html +++ b/docs/API-docs/v1/createdocumentwithtemplateid/index.html @@ -5,7 +5,7 @@ Create Document from Template | OpenSign™ - + diff --git a/docs/API-docs/v1/createfolder/index.html b/docs/API-docs/v1/createfolder/index.html index 3cc81ad26..547d865dd 100644 --- a/docs/API-docs/v1/createfolder/index.html +++ b/docs/API-docs/v1/createfolder/index.html @@ -5,7 +5,7 @@ Create Folder | OpenSign™ - + diff --git a/docs/API-docs/v1/createtemplate/index.html b/docs/API-docs/v1/createtemplate/index.html index cb342f34e..1bb932765 100644 --- a/docs/API-docs/v1/createtemplate/index.html +++ b/docs/API-docs/v1/createtemplate/index.html @@ -5,7 +5,7 @@ Create Template | OpenSign™ - + diff --git a/docs/API-docs/v1/delete-template/index.html b/docs/API-docs/v1/delete-template/index.html index e2357c803..8e940afef 100644 --- a/docs/API-docs/v1/delete-template/index.html +++ b/docs/API-docs/v1/delete-template/index.html @@ -5,7 +5,7 @@ Delete Template | OpenSign™ - + diff --git a/docs/API-docs/v1/delete-webhook/index.html b/docs/API-docs/v1/delete-webhook/index.html index 4247ade7c..7fec379e1 100644 --- a/docs/API-docs/v1/delete-webhook/index.html +++ b/docs/API-docs/v1/delete-webhook/index.html @@ -5,7 +5,7 @@ Delete Webhook | OpenSign™ - + diff --git a/docs/API-docs/v1/deletecontact/index.html b/docs/API-docs/v1/deletecontact/index.html index be0f44017..6d2b55a85 100644 --- a/docs/API-docs/v1/deletecontact/index.html +++ b/docs/API-docs/v1/deletecontact/index.html @@ -5,7 +5,7 @@ Delete Contact | OpenSign™ - + diff --git a/docs/API-docs/v1/deletedocument/index.html b/docs/API-docs/v1/deletedocument/index.html index 2790e288f..7570233e2 100644 --- a/docs/API-docs/v1/deletedocument/index.html +++ b/docs/API-docs/v1/deletedocument/index.html @@ -5,7 +5,7 @@ Delete Document | OpenSign™ - + diff --git a/docs/API-docs/v1/deletefolder/index.html b/docs/API-docs/v1/deletefolder/index.html index 43812503d..e57ad3ccc 100644 --- a/docs/API-docs/v1/deletefolder/index.html +++ b/docs/API-docs/v1/deletefolder/index.html @@ -5,7 +5,7 @@ Delete Folder | OpenSign™ - + diff --git a/docs/API-docs/v1/draftdocument/index.html b/docs/API-docs/v1/draftdocument/index.html index cff06e1ee..57e76bc73 100644 --- a/docs/API-docs/v1/draftdocument/index.html +++ b/docs/API-docs/v1/draftdocument/index.html @@ -5,7 +5,7 @@ Draft Document | OpenSign™ - + diff --git a/docs/API-docs/v1/drafttemplate/index.html b/docs/API-docs/v1/drafttemplate/index.html index 95f157ca0..0fc1bc496 100644 --- a/docs/API-docs/v1/drafttemplate/index.html +++ b/docs/API-docs/v1/drafttemplate/index.html @@ -5,7 +5,7 @@ Draft Template | OpenSign™ - + diff --git a/docs/API-docs/v1/folderlist/index.html b/docs/API-docs/v1/folderlist/index.html index 4ff288a94..48a34d7eb 100644 --- a/docs/API-docs/v1/folderlist/index.html +++ b/docs/API-docs/v1/folderlist/index.html @@ -5,7 +5,7 @@ Get folder list | OpenSign™ - + diff --git a/docs/API-docs/v1/get-template/index.html b/docs/API-docs/v1/get-template/index.html index 47a441884..c63e1bbd0 100644 --- a/docs/API-docs/v1/get-template/index.html +++ b/docs/API-docs/v1/get-template/index.html @@ -5,7 +5,7 @@ Get Template | OpenSign™ - + diff --git a/docs/API-docs/v1/get-user/index.html b/docs/API-docs/v1/get-user/index.html index dfbde1e0e..efe990ff6 100644 --- a/docs/API-docs/v1/get-user/index.html +++ b/docs/API-docs/v1/get-user/index.html @@ -5,7 +5,7 @@ Get your account details | OpenSign™ - + diff --git a/docs/API-docs/v1/get-webhook/index.html b/docs/API-docs/v1/get-webhook/index.html index bc0d8ba9e..124e39492 100644 --- a/docs/API-docs/v1/get-webhook/index.html +++ b/docs/API-docs/v1/get-webhook/index.html @@ -5,7 +5,7 @@ Get Webhook | OpenSign™ - + diff --git a/docs/API-docs/v1/getcontact/index.html b/docs/API-docs/v1/getcontact/index.html index a786760ad..5b4a51b3f 100644 --- a/docs/API-docs/v1/getcontact/index.html +++ b/docs/API-docs/v1/getcontact/index.html @@ -5,7 +5,7 @@ Get Contact | OpenSign™ - + diff --git a/docs/API-docs/v1/getdocument/index.html b/docs/API-docs/v1/getdocument/index.html index 5b427b046..298d9a856 100644 --- a/docs/API-docs/v1/getdocument/index.html +++ b/docs/API-docs/v1/getdocument/index.html @@ -5,7 +5,7 @@ Get Document | OpenSign™ - + diff --git a/docs/API-docs/v1/getdocumentlist/index.html b/docs/API-docs/v1/getdocumentlist/index.html index 568196ff4..a4c13a523 100644 --- a/docs/API-docs/v1/getdocumentlist/index.html +++ b/docs/API-docs/v1/getdocumentlist/index.html @@ -5,7 +5,7 @@ Get Document list from status | OpenSign™ - + diff --git a/docs/API-docs/v1/getfolder/index.html b/docs/API-docs/v1/getfolder/index.html index 619f03976..59af4d831 100644 --- a/docs/API-docs/v1/getfolder/index.html +++ b/docs/API-docs/v1/getfolder/index.html @@ -5,7 +5,7 @@ Get Folder | OpenSign™ - + diff --git a/docs/API-docs/v1/gettemplatelist/index.html b/docs/API-docs/v1/gettemplatelist/index.html index e65601139..0233622e8 100644 --- a/docs/API-docs/v1/gettemplatelist/index.html +++ b/docs/API-docs/v1/gettemplatelist/index.html @@ -5,7 +5,7 @@ Get Template list | OpenSign™ - + diff --git a/docs/API-docs/v1/index.html b/docs/API-docs/v1/index.html index b189b9ab3..8ffe455c7 100644 --- a/docs/API-docs/v1/index.html +++ b/docs/API-docs/v1/index.html @@ -5,7 +5,7 @@ OpenSign API v1 | OpenSign™ - + diff --git a/docs/API-docs/v1/intro/index.html b/docs/API-docs/v1/intro/index.html index 4be961e13..908ec7749 100644 --- a/docs/API-docs/v1/intro/index.html +++ b/docs/API-docs/v1/intro/index.html @@ -5,7 +5,7 @@ Overview | OpenSign™ - + diff --git a/docs/API-docs/v1/opensign-api-v-1/index.html b/docs/API-docs/v1/opensign-api-v-1/index.html index ec6a09c67..4612feda6 100644 --- a/docs/API-docs/v1/opensign-api-v-1/index.html +++ b/docs/API-docs/v1/opensign-api-v-1/index.html @@ -5,7 +5,7 @@ OpenSign API v1 | OpenSign™ - + diff --git a/docs/API-docs/v1/resendrequestmail/index.html b/docs/API-docs/v1/resendrequestmail/index.html index ccf95323e..6e00e178a 100644 --- a/docs/API-docs/v1/resendrequestmail/index.html +++ b/docs/API-docs/v1/resendrequestmail/index.html @@ -5,7 +5,7 @@ Resend request mail | OpenSign™ - + diff --git a/docs/API-docs/v1/revokedocument/index.html b/docs/API-docs/v1/revokedocument/index.html index fa7593c1c..8b2f01577 100644 --- a/docs/API-docs/v1/revokedocument/index.html +++ b/docs/API-docs/v1/revokedocument/index.html @@ -5,7 +5,7 @@ Revoke Document | OpenSign™ - + diff --git a/docs/API-docs/v1/save-update-webhook/index.html b/docs/API-docs/v1/save-update-webhook/index.html index cc5c35f70..6cebdb95d 100644 --- a/docs/API-docs/v1/save-update-webhook/index.html +++ b/docs/API-docs/v1/save-update-webhook/index.html @@ -5,7 +5,7 @@ Save or Update Webhook | OpenSign™ - + diff --git a/docs/API-docs/v1/selfsign/index.html b/docs/API-docs/v1/selfsign/index.html index c3f34fb51..30d6bc59f 100644 --- a/docs/API-docs/v1/selfsign/index.html +++ b/docs/API-docs/v1/selfsign/index.html @@ -5,7 +5,7 @@ Self Sign | OpenSign™ - + diff --git a/docs/API-docs/v1/update-document/index.html b/docs/API-docs/v1/update-document/index.html index d5a3d1ecd..ebc6476ac 100644 --- a/docs/API-docs/v1/update-document/index.html +++ b/docs/API-docs/v1/update-document/index.html @@ -5,7 +5,7 @@ Update Document | OpenSign™ - + diff --git a/docs/API-docs/v1/update-template/index.html b/docs/API-docs/v1/update-template/index.html index e0cd29fca..37ba0bac8 100644 --- a/docs/API-docs/v1/update-template/index.html +++ b/docs/API-docs/v1/update-template/index.html @@ -5,7 +5,7 @@ Update Template | OpenSign™ - + diff --git a/docs/API-docs/v1/updatefolder/index.html b/docs/API-docs/v1/updatefolder/index.html index 9e1743b82..3a007c715 100644 --- a/docs/API-docs/v1/updatefolder/index.html +++ b/docs/API-docs/v1/updatefolder/index.html @@ -5,7 +5,7 @@ Update Folder | OpenSign™ - + diff --git a/docs/category/cloud-storage/index.html b/docs/category/cloud-storage/index.html index 2507bce3c..0a0d1cadf 100644 --- a/docs/category/cloud-storage/index.html +++ b/docs/category/cloud-storage/index.html @@ -5,7 +5,7 @@ Cloud Storage | OpenSign™ - + diff --git a/docs/category/create-new-opensign-document/index.html b/docs/category/create-new-opensign-document/index.html index b8c2044b4..cb7099d18 100644 --- a/docs/category/create-new-opensign-document/index.html +++ b/docs/category/create-new-opensign-document/index.html @@ -5,7 +5,7 @@ Create New OpenSign Document | OpenSign™ - + diff --git a/docs/category/docker/index.html b/docs/category/docker/index.html index b6425d7ba..07f43a1e9 100644 --- a/docs/category/docker/index.html +++ b/docs/category/docker/index.html @@ -5,7 +5,7 @@ Docker | OpenSign™ - + diff --git a/docs/category/documents/index.html b/docs/category/documents/index.html index 81ca3a8fe..a977e63e9 100644 --- a/docs/category/documents/index.html +++ b/docs/category/documents/index.html @@ -5,7 +5,7 @@ Documents | OpenSign™ - + diff --git a/docs/category/faqs/index.html b/docs/category/faqs/index.html index 47eb7b043..a08529911 100644 --- a/docs/category/faqs/index.html +++ b/docs/category/faqs/index.html @@ -5,7 +5,7 @@ FAQs | OpenSign™ - + diff --git a/docs/category/guides/index.html b/docs/category/guides/index.html index 681a26853..afa0f254a 100644 --- a/docs/category/guides/index.html +++ b/docs/category/guides/index.html @@ -5,7 +5,7 @@ Guides | OpenSign™ - + diff --git a/docs/category/manage-docs-using-opensign-drive/index.html b/docs/category/manage-docs-using-opensign-drive/index.html index a69769a4d..050de3a7b 100644 --- a/docs/category/manage-docs-using-opensign-drive/index.html +++ b/docs/category/manage-docs-using-opensign-drive/index.html @@ -5,7 +5,7 @@ Manage Docs using OpenSign™ Drive | OpenSign™ - + diff --git a/docs/category/settings/index.html b/docs/category/settings/index.html index 88e3dd8cd..b540b91ae 100644 --- a/docs/category/settings/index.html +++ b/docs/category/settings/index.html @@ -5,7 +5,7 @@ Settings | OpenSign™ - + diff --git a/docs/category/templates/index.html b/docs/category/templates/index.html index a33040fa4..3a766a5af 100644 --- a/docs/category/templates/index.html +++ b/docs/category/templates/index.html @@ -5,7 +5,7 @@ Templates | OpenSign™ - + diff --git a/docs/contribute/CODE_OF_CONDUCT/index.html b/docs/contribute/CODE_OF_CONDUCT/index.html index 8cd4f3945..e6a6c9d78 100644 --- a/docs/contribute/CODE_OF_CONDUCT/index.html +++ b/docs/contribute/CODE_OF_CONDUCT/index.html @@ -5,7 +5,7 @@ Code of conduct | OpenSign™ - + diff --git a/docs/contribute/COMMUNITY/index.html b/docs/contribute/COMMUNITY/index.html index 92a73e6b0..6e40ac1cc 100644 --- a/docs/contribute/COMMUNITY/index.html +++ b/docs/contribute/COMMUNITY/index.html @@ -5,7 +5,7 @@ Community at OpenSign™ | OpenSign™ - + diff --git a/docs/contribute/INSTALLATION/index.html b/docs/contribute/INSTALLATION/index.html index b54e4f7f9..f509d6b00 100644 --- a/docs/contribute/INSTALLATION/index.html +++ b/docs/contribute/INSTALLATION/index.html @@ -5,7 +5,7 @@ Installation instructions | OpenSign™ - + diff --git a/docs/contribute/REPORTING_GUIDELINES/index.html b/docs/contribute/REPORTING_GUIDELINES/index.html index 54a9df03d..70130de50 100644 --- a/docs/contribute/REPORTING_GUIDELINES/index.html +++ b/docs/contribute/REPORTING_GUIDELINES/index.html @@ -5,7 +5,7 @@ OpenSign™ Reporting Guidelines | OpenSign™ - + diff --git a/docs/contribute/intro/index.html b/docs/contribute/intro/index.html index acb31ddc6..50127fbaf 100644 --- a/docs/contribute/intro/index.html +++ b/docs/contribute/intro/index.html @@ -5,7 +5,7 @@ Contributing to OpenSign | OpenSign™ - + diff --git a/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements/index.html b/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements/index.html index 4e8455933..200a3744e 100644 --- a/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements/index.html +++ b/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements/index.html @@ -5,7 +5,7 @@ Why am I getting 'Ensure this field is accurately filled and meets all requirements'? | OpenSign™ - + diff --git a/docs/help/FAQs/index.html b/docs/help/FAQs/index.html index accb57475..56e676957 100644 --- a/docs/help/FAQs/index.html +++ b/docs/help/FAQs/index.html @@ -5,7 +5,7 @@ Why is there no dropdown list when I sign a document myself? | OpenSign™ - + diff --git a/docs/help/New-Document/edit-document-before-sending/index.html b/docs/help/New-Document/edit-document-before-sending/index.html index 9e9ccb814..014ff187b 100644 --- a/docs/help/New-Document/edit-document-before-sending/index.html +++ b/docs/help/New-Document/edit-document-before-sending/index.html @@ -5,7 +5,7 @@ Editing Your Document Before Sending | OpenSign™ - + diff --git a/docs/help/New-Document/enforce-email-verification/index.html b/docs/help/New-Document/enforce-email-verification/index.html index 66f2eaeb7..99dc2bc2d 100644 --- a/docs/help/New-Document/enforce-email-verification/index.html +++ b/docs/help/New-Document/enforce-email-verification/index.html @@ -5,7 +5,7 @@ Enforce email OTP verification | OpenSign™ - + diff --git a/docs/help/New-Document/navigate-between-pages/index.html b/docs/help/New-Document/navigate-between-pages/index.html index a0a52e4d7..7eeb8fb27 100644 --- a/docs/help/New-Document/navigate-between-pages/index.html +++ b/docs/help/New-Document/navigate-between-pages/index.html @@ -5,7 +5,7 @@ Navigate between pages of a document | OpenSign™ - + diff --git a/docs/help/New-Document/request-signatures/index.html b/docs/help/New-Document/request-signatures/index.html index 39da55e6b..d7212fdfd 100644 --- a/docs/help/New-Document/request-signatures/index.html +++ b/docs/help/New-Document/request-signatures/index.html @@ -5,7 +5,7 @@ Request signatures | OpenSign™ - + diff --git a/docs/help/New-Document/sign-yourself/index.html b/docs/help/New-Document/sign-yourself/index.html index 9aa052bdd..3e6bcd1be 100644 --- a/docs/help/New-Document/sign-yourself/index.html +++ b/docs/help/New-Document/sign-yourself/index.html @@ -5,7 +5,7 @@ Sign your-self | OpenSign™ - + diff --git a/docs/help/OpenSign™ Drive/create-document/index.html b/docs/help/OpenSign™ Drive/create-document/index.html index 32bcc3820..e9ec11185 100644 --- a/docs/help/OpenSign™ Drive/create-document/index.html +++ b/docs/help/OpenSign™ Drive/create-document/index.html @@ -5,7 +5,7 @@ Create Docs & Folders | OpenSign™ - + diff --git a/docs/help/OpenSign™ Drive/list-grid-view/index.html b/docs/help/OpenSign™ Drive/list-grid-view/index.html index 82520a4a5..66aad46b2 100644 --- a/docs/help/OpenSign™ Drive/list-grid-view/index.html +++ b/docs/help/OpenSign™ Drive/list-grid-view/index.html @@ -5,7 +5,7 @@ Grid vs List view | OpenSign™ - + diff --git a/docs/help/OpenSign™ Drive/organize-documents/index.html b/docs/help/OpenSign™ Drive/organize-documents/index.html index a5d2e01d7..e8c525aaf 100644 --- a/docs/help/OpenSign™ Drive/organize-documents/index.html +++ b/docs/help/OpenSign™ Drive/organize-documents/index.html @@ -5,7 +5,7 @@ OpenSign™ Drive Interface Documentation | OpenSign™ - + diff --git a/docs/help/OpenSign™ Drive/rename-document/index.html b/docs/help/OpenSign™ Drive/rename-document/index.html index 27dcb9a2c..5960393b5 100644 --- a/docs/help/OpenSign™ Drive/rename-document/index.html +++ b/docs/help/OpenSign™ Drive/rename-document/index.html @@ -5,7 +5,7 @@ Rename documents from OpenSign™ Drive | OpenSign™ - + diff --git a/docs/help/Reports/completed/index.html b/docs/help/Reports/completed/index.html index 53295ff70..3681d5b32 100644 --- a/docs/help/Reports/completed/index.html +++ b/docs/help/Reports/completed/index.html @@ -5,7 +5,7 @@ Completed | OpenSign™ - + diff --git a/docs/help/Reports/contactbook/index.html b/docs/help/Reports/contactbook/index.html index af0f0a2f5..6cf034024 100644 --- a/docs/help/Reports/contactbook/index.html +++ b/docs/help/Reports/contactbook/index.html @@ -5,7 +5,7 @@ Contactbook | OpenSign™ - + diff --git a/docs/help/Reports/declined/index.html b/docs/help/Reports/declined/index.html index 148ad9b8f..199d6bd08 100644 --- a/docs/help/Reports/declined/index.html +++ b/docs/help/Reports/declined/index.html @@ -5,7 +5,7 @@ Declined | OpenSign™ - + diff --git a/docs/help/Reports/drafts/index.html b/docs/help/Reports/drafts/index.html index 41e216e3d..b59022789 100644 --- a/docs/help/Reports/drafts/index.html +++ b/docs/help/Reports/drafts/index.html @@ -5,7 +5,7 @@ Drafts | OpenSign™ - + diff --git a/docs/help/Reports/expired/index.html b/docs/help/Reports/expired/index.html index 08d67feef..82999f09b 100644 --- a/docs/help/Reports/expired/index.html +++ b/docs/help/Reports/expired/index.html @@ -5,7 +5,7 @@ Expired | OpenSign™ - + diff --git a/docs/help/Reports/in-progress/index.html b/docs/help/Reports/in-progress/index.html index fda5ca8f0..686c75a56 100644 --- a/docs/help/Reports/in-progress/index.html +++ b/docs/help/Reports/in-progress/index.html @@ -5,7 +5,7 @@ In Progress | OpenSign™ - + diff --git a/docs/help/Reports/need-your-sign/index.html b/docs/help/Reports/need-your-sign/index.html index 4aad4d27a..90fa4359d 100644 --- a/docs/help/Reports/need-your-sign/index.html +++ b/docs/help/Reports/need-your-sign/index.html @@ -5,7 +5,7 @@ Need your sign | OpenSign™ - + diff --git a/docs/help/Settings/APIToken/index.html b/docs/help/Settings/APIToken/index.html index c44d52fc0..e85e8c6c1 100644 --- a/docs/help/Settings/APIToken/index.html +++ b/docs/help/Settings/APIToken/index.html @@ -5,7 +5,7 @@ API Token | OpenSign™ - + diff --git a/docs/help/Settings/Custom-email-templates/index.html b/docs/help/Settings/Custom-email-templates/index.html index e988d4248..835655ede 100644 --- a/docs/help/Settings/Custom-email-templates/index.html +++ b/docs/help/Settings/Custom-email-templates/index.html @@ -5,7 +5,7 @@ Custom email templates | OpenSign™ - + diff --git a/docs/help/Settings/Preferences/index.html b/docs/help/Settings/Preferences/index.html index a8af194c1..55f4f5756 100644 --- a/docs/help/Settings/Preferences/index.html +++ b/docs/help/Settings/Preferences/index.html @@ -5,7 +5,7 @@ Preferences | OpenSign™ - + diff --git a/docs/help/Settings/SecurityManagement/index.html b/docs/help/Settings/SecurityManagement/index.html index 88a9f6bad..1f2ef98ab 100644 --- a/docs/help/Settings/SecurityManagement/index.html +++ b/docs/help/Settings/SecurityManagement/index.html @@ -5,7 +5,7 @@ Security | OpenSign™ - + diff --git a/docs/help/Settings/Teams/index.html b/docs/help/Settings/Teams/index.html index b1ecdee79..eb9dc22c1 100644 --- a/docs/help/Settings/Teams/index.html +++ b/docs/help/Settings/Teams/index.html @@ -5,7 +5,7 @@ Manage Teams | OpenSign™ - + diff --git a/docs/help/Settings/Webhook/index.html b/docs/help/Settings/Webhook/index.html index 554d719be..72725f967 100644 --- a/docs/help/Settings/Webhook/index.html +++ b/docs/help/Settings/Webhook/index.html @@ -5,7 +5,7 @@ Webhook | OpenSign™ - + diff --git a/docs/help/Settings/disabledocumentid/index.html b/docs/help/Settings/disabledocumentid/index.html index 068787605..71fb51489 100644 --- a/docs/help/Settings/disabledocumentid/index.html +++ b/docs/help/Settings/disabledocumentid/index.html @@ -5,7 +5,7 @@ Disable DocumentId | OpenSign™ - + diff --git a/docs/help/Settings/manage-users/index.html b/docs/help/Settings/manage-users/index.html index e61059eda..dacdce7a4 100644 --- a/docs/help/Settings/manage-users/index.html +++ b/docs/help/Settings/manage-users/index.html @@ -5,7 +5,7 @@ Manage users | OpenSign™ - + diff --git a/docs/help/Settings/my-signature/index.html b/docs/help/Settings/my-signature/index.html index 1144d209e..6141680fd 100644 --- a/docs/help/Settings/my-signature/index.html +++ b/docs/help/Settings/my-signature/index.html @@ -5,7 +5,7 @@ My Signature | OpenSign™ - + diff --git a/docs/help/Templates/create-template/index.html b/docs/help/Templates/create-template/index.html index 7ec019ef1..26fc1fd18 100644 --- a/docs/help/Templates/create-template/index.html +++ b/docs/help/Templates/create-template/index.html @@ -5,7 +5,7 @@ Create Templates | OpenSign™ - + diff --git a/docs/help/Templates/embed-template/index.html b/docs/help/Templates/embed-template/index.html index f8672c6f2..94e18f8bf 100644 --- a/docs/help/Templates/embed-template/index.html +++ b/docs/help/Templates/embed-template/index.html @@ -5,7 +5,7 @@ Embedding OpenSign templates | OpenSign™ - + diff --git a/docs/help/Templates/manage-templates/index.html b/docs/help/Templates/manage-templates/index.html index 00347133c..41d53fb92 100644 --- a/docs/help/Templates/manage-templates/index.html +++ b/docs/help/Templates/manage-templates/index.html @@ -5,7 +5,7 @@ Manage Templates | OpenSign™ - + diff --git a/docs/help/Templates/publicTemplate/index.html b/docs/help/Templates/publicTemplate/index.html index e4dede9c5..4ab881af6 100644 --- a/docs/help/Templates/publicTemplate/index.html +++ b/docs/help/Templates/publicTemplate/index.html @@ -5,7 +5,7 @@ Setting up an OpenSign template for public signing | OpenSign™ - + diff --git a/docs/help/Templates/quick-send/index.html b/docs/help/Templates/quick-send/index.html index 61ebe40ea..554e3ea95 100644 --- a/docs/help/Templates/quick-send/index.html +++ b/docs/help/Templates/quick-send/index.html @@ -5,7 +5,7 @@ Quickly Send the Document for Signature Using Template | OpenSign™ - + diff --git a/docs/help/Templates/use-template/index.html b/docs/help/Templates/use-template/index.html index a2d72b539..84b7f1675 100644 --- a/docs/help/Templates/use-template/index.html +++ b/docs/help/Templates/use-template/index.html @@ -5,7 +5,7 @@ Use template to create documents | OpenSign™ - + diff --git a/docs/help/intro/index.html b/docs/help/intro/index.html index e35416bf7..50a9317a1 100644 --- a/docs/help/intro/index.html +++ b/docs/help/intro/index.html @@ -5,7 +5,7 @@ Intro | OpenSign™ - + diff --git a/docs/intro/index.html b/docs/intro/index.html index 8f85469a9..4e1d3a8a0 100644 --- a/docs/intro/index.html +++ b/docs/intro/index.html @@ -5,7 +5,7 @@ Tutorial Intro | OpenSign™ - + diff --git a/docs/self-host/One-click-Install/DigitalOcean/index.html b/docs/self-host/One-click-Install/DigitalOcean/index.html index 65a3e6dd4..8da1a761e 100644 --- a/docs/self-host/One-click-Install/DigitalOcean/index.html +++ b/docs/self-host/One-click-Install/DigitalOcean/index.html @@ -5,7 +5,7 @@ Digital Ocean | OpenSign™ - + diff --git a/docs/self-host/cloud-storage/s3/index.html b/docs/self-host/cloud-storage/s3/index.html index 16107f4de..95f6d0480 100644 --- a/docs/self-host/cloud-storage/s3/index.html +++ b/docs/self-host/cloud-storage/s3/index.html @@ -5,7 +5,7 @@ AWS S3 | OpenSign™ - + diff --git a/docs/self-host/docker/run-locally/index.html b/docs/self-host/docker/run-locally/index.html index 6fff95d90..b99d55250 100644 --- a/docs/self-host/docker/run-locally/index.html +++ b/docs/self-host/docker/run-locally/index.html @@ -5,7 +5,7 @@ Self-host OpenSign™ with Docker on Linux/MacOS/Windows | OpenSign™ - + diff --git a/docs/self-host/docker/upgrade-deployment/index.html b/docs/self-host/docker/upgrade-deployment/index.html index 3d093159b..906655b73 100644 --- a/docs/self-host/docker/upgrade-deployment/index.html +++ b/docs/self-host/docker/upgrade-deployment/index.html @@ -5,7 +5,7 @@ OpenSign™ Self-Hosted 'Upgrade Deployment' Guide Using Docker on Linux, macOS, or Windows | OpenSign™ - + diff --git a/docs/self-host/guides/azure-vm-setup/index.html b/docs/self-host/guides/azure-vm-setup/index.html index 2eb4dbc0e..22be84cae 100644 --- a/docs/self-host/guides/azure-vm-setup/index.html +++ b/docs/self-host/guides/azure-vm-setup/index.html @@ -5,7 +5,7 @@ OpenSign Deployment Guide on Azure VM via command-line | OpenSign™ - + diff --git a/docs/self-host/guides/env-variables/index.html b/docs/self-host/guides/env-variables/index.html index 78e0f199e..0263b675d 100644 --- a/docs/self-host/guides/env-variables/index.html +++ b/docs/self-host/guides/env-variables/index.html @@ -5,7 +5,7 @@ ENV variables which are used to setup OpenSign™ with Docker on Localhost | OpenSign™ - + diff --git a/docs/self-host/guides/how-to-generate-self-signed-document-signing-certificate/index.html b/docs/self-host/guides/how-to-generate-self-signed-document-signing-certificate/index.html index 54e73ee7b..37eaa76c1 100644 --- a/docs/self-host/guides/how-to-generate-self-signed-document-signing-certificate/index.html +++ b/docs/self-host/guides/how-to-generate-self-signed-document-signing-certificate/index.html @@ -5,7 +5,7 @@ How to generate self-signed document signing certificate? | OpenSign™ - + diff --git a/docs/self-host/guides/upgrade-to-v2.1.0/index.html b/docs/self-host/guides/upgrade-to-v2.1.0/index.html index 138c500c2..c9d4538d8 100644 --- a/docs/self-host/guides/upgrade-to-v2.1.0/index.html +++ b/docs/self-host/guides/upgrade-to-v2.1.0/index.html @@ -5,7 +5,7 @@ How to upgrade self-hosted OpenSign to v2.1.0? | OpenSign™ - + diff --git a/docs/self-host/intro/index.html b/docs/self-host/intro/index.html index b50f6713d..9d830889e 100644 --- a/docs/self-host/intro/index.html +++ b/docs/self-host/intro/index.html @@ -5,7 +5,7 @@ Self-Hosting OpenSign | OpenSign™ - + diff --git a/index.html b/index.html index 90cc5f894..b0e7a8dee 100644 --- a/index.html +++ b/index.html @@ -5,7 +5,7 @@ Official OpenSign™ Docs - tutorials, API documentation, self-host help & much more. | OpenSign™ - + diff --git a/markdown-page/index.html b/markdown-page/index.html index 85fbffe1d..be1b06174 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -5,7 +5,7 @@ Markdown page example | OpenSign™ - +