diff --git a/404.html b/404.html index f87b491b1..9defe00d0 100644 --- a/404.html +++ b/404.html @@ -5,7 +5,7 @@ Page Not Found | OpenSign™ - + diff --git a/assets/js/0058b4c6.7642116e.js b/assets/js/0058b4c6.5ccc2f0a.js similarity index 60% rename from assets/js/0058b4c6.7642116e.js rename to assets/js/0058b4c6.5ccc2f0a.js index 705ef1f9d..3756254ec 100644 --- a/assets/js/0058b4c6.7642116e.js +++ b/assets/js/0058b4c6.5ccc2f0a.js @@ -1 +1 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[849],{86164(e){e.exports=JSON.parse('{"version":{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"link","href":"/docs/help/intro","label":"Intro","docId":"help/intro","unlisted":false},{"type":"category","label":"Create New OpenSign Document","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/docs/help/New-Document/sign-yourself","label":"Sign your-self","docId":"help/New-Document/sign-yourself","unlisted":false},{"type":"link","href":"/docs/help/New-Document/request-signatures","label":"Request signatures","docId":"help/New-Document/request-signatures","unlisted":false},{"type":"link","href":"/docs/help/New-Document/widgets","label":"Widgets in OpenSign","docId":"help/New-Document/widgets","unlisted":false},{"type":"link","href":"/docs/help/New-Document/edit-document-before-sending","label":"Editing Your Document Before Sending","docId":"help/New-Document/edit-document-before-sending","unlisted":false},{"type":"link","href":"/docs/help/New-Document/enforce-email-verification","label":"Enforce email OTP verification","docId":"help/New-Document/enforce-email-verification","unlisted":false}],"href":"/docs/category/create-new-opensign-document"},{"type":"category","label":"Manage Docs using OpenSign\u2122 Drive","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/docs/help/OpenSign\u2122 Drive/create-document","label":"Create Docs & Folders","docId":"help/OpenSign\u2122 Drive/create-document","unlisted":false},{"type":"link","href":"/docs/help/OpenSign\u2122 Drive/list-grid-view","label":"Grid vs List view","docId":"help/OpenSign\u2122 Drive/list-grid-view","unlisted":false},{"type":"link","href":"/docs/help/OpenSign\u2122 Drive/organize-documents","label":"OpenSign\u2122 Drive Interface Documentation","docId":"help/OpenSign\u2122 Drive/organize-documents","unlisted":false},{"type":"link","href":"/docs/help/OpenSign\u2122 Drive/rename-document","label":"Rename documents from OpenSign\u2122 Drive","docId":"help/OpenSign\u2122 Drive/rename-document","unlisted":false}],"href":"/docs/category/manage-docs-using-opensign-drive"},{"type":"category","label":"Documents","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/docs/help/Reports/need-your-sign","label":"Need your sign","docId":"help/Reports/need-your-sign","unlisted":false},{"type":"link","href":"/docs/help/Reports/in-progress","label":"In Progress","docId":"help/Reports/in-progress","unlisted":false},{"type":"link","href":"/docs/help/Reports/completed","label":"Completed","docId":"help/Reports/completed","unlisted":false},{"type":"link","href":"/docs/help/Reports/drafts","label":"Drafts","docId":"help/Reports/drafts","unlisted":false},{"type":"link","href":"/docs/help/Reports/declined","label":"Declined","docId":"help/Reports/declined","unlisted":false},{"type":"link","href":"/docs/help/Reports/expired","label":"Expired","docId":"help/Reports/expired","unlisted":false},{"type":"link","href":"/docs/help/Reports/contactbook","label":"Contactbook","docId":"help/Reports/contactbook","unlisted":false}],"href":"/docs/category/documents"},{"type":"category","label":"Templates","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/docs/help/Templates/create-template","label":"Create Templates","docId":"help/Templates/create-template","unlisted":false},{"type":"link","href":"/docs/help/Templates/manage-templates","label":"Manage Templates","docId":"help/Templates/manage-templates","unlisted":false},{"type":"link","href":"/docs/help/Templates/use-template","label":"Use template to create documents","docId":"help/Templates/use-template","unlisted":false},{"type":"link","href":"/docs/help/Templates/quick-send","label":"Bulk Document Send for Signature Using Template","docId":"help/Templates/quick-send","unlisted":false},{"type":"link","href":"/docs/help/Templates/publicTemplate","label":"Setting up an OpenSign template for public signing","docId":"help/Templates/publicTemplate","unlisted":false},{"type":"link","href":"/docs/help/Templates/embed-template","label":"Embedding OpenSign templates","docId":"help/Templates/embed-template","unlisted":false}],"href":"/docs/category/templates"},{"type":"category","label":"Settings","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/docs/help/Settings/my-signature","label":"My Signature","docId":"help/Settings/my-signature","unlisted":false},{"type":"link","href":"/docs/help/Settings/APIToken","label":"API Token","docId":"help/Settings/APIToken","unlisted":false},{"type":"link","href":"/docs/help/Settings/Webhook","label":"Webhook","docId":"help/Settings/Webhook","unlisted":false},{"type":"link","href":"/docs/help/Settings/Preferences","label":"Preferences","docId":"help/Settings/Preferences","unlisted":false},{"type":"link","href":"/docs/help/Settings/Teams","label":"Manage Teams","docId":"help/Settings/Teams","unlisted":false},{"type":"link","href":"/docs/help/Settings/manage-users","label":"Manage users","docId":"help/Settings/manage-users","unlisted":false},{"type":"link","href":"/docs/help/Settings/disabledocumentid","label":"Disable DocumentId","docId":"help/Settings/disabledocumentid","unlisted":false},{"type":"link","href":"/docs/help/Settings/Custom-email-templates","label":"Custom email templates","docId":"help/Settings/Custom-email-templates","unlisted":false},{"type":"link","href":"/docs/help/Settings/SecurityManagement","label":"Security","docId":"help/Settings/SecurityManagement","unlisted":false}],"href":"/docs/category/settings"},{"type":"category","label":"User Menu","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/docs/help/User Menu/Profile","label":"Profile","docId":"help/User Menu/Profile","unlisted":false},{"type":"category","label":"Console","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/docs/help/User Menu/Console/analystics","label":"Analytics","docId":"help/User Menu/Console/analystics","unlisted":false},{"type":"link","href":"/docs/help/User Menu/Console/general","label":"General","docId":"help/User Menu/Console/general","unlisted":false},{"type":"link","href":"/docs/help/User Menu/Console/branding","label":"Branding","docId":"help/User Menu/Console/branding","unlisted":false},{"type":"link","href":"/docs/help/User Menu/Console/globalSMTP","label":"Global SMTP","docId":"help/User Menu/Console/globalSMTP","unlisted":false},{"type":"link","href":"/docs/help/User Menu/Console/emails","label":"Mail","docId":"help/User Menu/Console/emails","unlisted":false},{"type":"link","href":"/docs/help/User Menu/Console/custom_filestorage","label":"Custom File Storage","docId":"help/User Menu/Console/custom_filestorage","unlisted":false},{"type":"link","href":"/docs/help/User Menu/Console/signing_certificate","label":"Custom Signing Certificate","docId":"help/User Menu/Console/signing_certificate","unlisted":false},{"type":"link","href":"/docs/help/User Menu/Console/organizations","label":"Organizations","docId":"help/User Menu/Console/organizations","unlisted":false},{"type":"link","href":"/docs/help/User Menu/Console/orgadmin","label":"Org Admins","docId":"help/User Menu/Console/orgadmin","unlisted":false}],"href":"/docs/category/console"}],"href":"/docs/category/user-menu"},{"type":"category","label":"FAQs","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/docs/help/FAQs/","label":"Why is there no dropdown list when I sign a document myself?","docId":"help/FAQs/FAQs","unlisted":false},{"type":"link","href":"/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements","label":"Why am I getting \'Ensure this field is accurately filled and meets all requirements\'?","docId":"help/FAQs/Ensure this field is accurately filled and meets all requirements","unlisted":false},{"type":"link","href":"/docs/help/FAQs/Credit-Deductions","label":"Credit-Deductions","docId":"help/FAQs/Credit-Deductions","unlisted":false},{"type":"link","href":"/docs/help/FAQs/Max File Upload Size","label":"Max File Upload Size","docId":"help/FAQs/Max File Upload Size","unlisted":false},{"type":"link","href":"/docs/help/FAQs/User Deletion","label":"User Deletion","docId":"help/FAQs/User Deletion","unlisted":false}],"href":"/docs/category/faqs"}],"selfhostSidebar":[{"type":"link","href":"/docs/self-host/intro","label":"Self-Hosting OpenSign","docId":"self-host/intro","unlisted":false},{"type":"category","label":"Docker","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/docs/self-host/docker/run-locally","label":"Self-host OpenSign\u2122 with Docker on Linux/MacOS/Windows","docId":"self-host/docker/run-locally","unlisted":false},{"type":"link","href":"/docs/self-host/docker/upgrade-deployment","label":"OpenSign\u2122 Self-Hosted \'Upgrade Deployment\' Guide Using Docker on Linux, macOS, or Windows","docId":"self-host/docker/upgrade-deployment","unlisted":false}],"href":"/docs/category/docker"},{"type":"category","label":"Cloud Storage","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/docs/self-host/cloud-storage/s3","label":"AWS S3","docId":"self-host/cloud-storage/s3","unlisted":false}],"href":"/docs/category/cloud-storage"},{"type":"category","label":"Guides","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/docs/self-host/guides/azure-vm-setup","label":"OpenSign Deployment Guide on Azure VM via command-line","docId":"self-host/guides/azure-vm-setup","unlisted":false},{"type":"link","href":"/docs/self-host/guides/env-variables","label":"ENV variables which are used to setup OpenSign\u2122 with Docker on Localhost","docId":"self-host/guides/env-variables","unlisted":false},{"type":"link","href":"/docs/self-host/guides/how-to-generate-self-signed-document-signing-certificate","label":"How to generate self-signed document signing certificate?","docId":"self-host/guides/how-to-generate-self-signed-document-signing-certificate","unlisted":false},{"type":"link","href":"/docs/self-host/guides/upgrade-to-v2.1.0","label":"How to upgrade self-hosted OpenSign to v2.1.0?","docId":"self-host/guides/upgrade-to-v2.1.0","unlisted":false}],"href":"/docs/category/guides"},{"type":"category","label":"One-click-Install","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/docs/self-host/One-click-Install/DigitalOcean","label":"Digital Ocean","docId":"self-host/One-click-Install/DigitalOcean","unlisted":false}]}],"contributeSidebar":[{"type":"link","href":"/docs/contribute/CODE_OF_CONDUCT","label":"Code of conduct","docId":"contribute/CODE_OF_CONDUCT","unlisted":false},{"type":"link","href":"/docs/contribute/intro","label":"Contributing to OpenSign","docId":"contribute/intro","unlisted":false},{"type":"link","href":"/docs/contribute/INSTALLATION","label":"Installation instructions","docId":"contribute/INSTALLATION","unlisted":false},{"type":"link","href":"/docs/contribute/COMMUNITY","label":"Community at OpenSign\u2122","docId":"contribute/COMMUNITY","unlisted":false},{"type":"link","href":"/docs/contribute/REPORTING_GUIDELINES","label":"OpenSign\u2122 Reporting Guidelines","docId":"contribute/REPORTING_GUIDELINES","unlisted":false}],"apiSidebar":[{"type":"category","label":"v1.2","collapsed":false,"items":[{"type":"link","href":"/docs/API-docs/v1.2/opensign-api-v-1-2","label":"Introduction","docId":"API-docs/v1.2/opensign-api-v-1-2","unlisted":false},{"type":"category","label":"User","items":[{"type":"link","href":"/docs/API-docs/v1.2/get-user","label":"Get your account details","className":"get api-method","docId":"API-docs/v1.2/get-user","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/getcredits","label":"Get your API credits","className":"get api-method","docId":"API-docs/v1.2/getcredits","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Contacts","items":[{"type":"link","href":"/docs/API-docs/v1.2/createcontact","label":"Create Contact","className":"post api-method","docId":"API-docs/v1.2/createcontact","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/getcontact","label":"Get Contact","className":"get api-method","docId":"API-docs/v1.2/getcontact","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/deletecontact","label":"Delete Contact","className":"delete api-method","docId":"API-docs/v1.2/deletecontact","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/contactlist","label":"Get Contact list","className":"get api-method","docId":"API-docs/v1.2/contactlist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Documents","items":[{"type":"link","href":"/docs/API-docs/v1.2/selfsign","label":"Self Sign","className":"post api-method","docId":"API-docs/v1.2/selfsign","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/draftdocument","label":"Draft Document","className":"post api-method","docId":"API-docs/v1.2/draftdocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/createdocument","label":"Create Document","className":"post api-method","docId":"API-docs/v1.2/createdocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/createdocumentwithtemplateid","label":"Create Document from Template","className":"post api-method","docId":"API-docs/v1.2/createdocumentwithtemplateid","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/getdocument","label":"Get Document","className":"get api-method","docId":"API-docs/v1.2/getdocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/update-document","label":"Update Document","className":"put api-method","docId":"API-docs/v1.2/update-document","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/revokedocument","label":"Revoke Document","className":"post api-method","docId":"API-docs/v1.2/revokedocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/deletedocument","label":"Delete Document","className":"delete api-method","docId":"API-docs/v1.2/deletedocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/getdocumentlist","label":"Get Document list from status","className":"get api-method","docId":"API-docs/v1.2/getdocumentlist","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/resendrequestmail","label":"Resend request mail","className":"post api-method","docId":"API-docs/v1.2/resendrequestmail","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/getsignerips","label":"Get Signer IPs","className":"get api-method","docId":"API-docs/v1.2/getsignerips","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/getformdata","label":"Get Formdata","className":"get api-method","docId":"API-docs/v1.2/getformdata","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/getsigninglinks","label":"Get Signing Links","className":"get api-method","docId":"API-docs/v1.2/getsigninglinks","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Templates","items":[{"type":"link","href":"/docs/API-docs/v1.2/drafttemplate","label":"Draft Template","className":"post api-method","docId":"API-docs/v1.2/drafttemplate","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/createtemplate","label":"Create Template","className":"post api-method","docId":"API-docs/v1.2/createtemplate","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/publictemplate","label":"Public Template","className":"post api-method","docId":"API-docs/v1.2/publictemplate","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/get-template","label":"Get Template","className":"get api-method","docId":"API-docs/v1.2/get-template","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/update-template","label":"Update Template","className":"put api-method","docId":"API-docs/v1.2/update-template","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/delete-template","label":"Delete Template","className":"delete api-method","docId":"API-docs/v1.2/delete-template","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/gettemplatelist","label":"Get Template list","className":"get api-method","docId":"API-docs/v1.2/gettemplatelist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Webhook","items":[{"type":"link","href":"/docs/API-docs/v1.2/get-webhook","label":"Get Webhook","className":"get api-method","docId":"API-docs/v1.2/get-webhook","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/save-update-webhook","label":"Save or Update Webhook","className":"post api-method","docId":"API-docs/v1.2/save-update-webhook","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/delete-webhook","label":"Delete Webhook","className":"delete api-method","docId":"API-docs/v1.2/delete-webhook","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Folder","items":[{"type":"link","href":"/docs/API-docs/v1.2/createfolder","label":"Create Folder","className":"post api-method","docId":"API-docs/v1.2/createfolder","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/getfolder","label":"Get Folder","className":"get api-method","docId":"API-docs/v1.2/getfolder","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/updatefolder","label":"Update Folder","className":"put api-method","docId":"API-docs/v1.2/updatefolder","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/deletefolder","label":"Delete Folder","className":"delete api-method","docId":"API-docs/v1.2/deletefolder","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/folderlist","label":"Get folder list","className":"get api-method","docId":"API-docs/v1.2/folderlist","unlisted":false}],"collapsed":true,"collapsible":true}],"collapsible":true,"href":"/docs/API-docs/v1.2"},{"type":"category","label":"v1.1","collapsed":false,"items":[{"type":"link","href":"/docs/API-docs/v1.1/opensign-api-v-1-1","label":"Introduction","docId":"API-docs/v1.1/opensign-api-v-1-1","unlisted":false},{"type":"category","label":"User","items":[{"type":"link","href":"/docs/API-docs/v1.1/get-user","label":"Get your account details","className":"get api-method","docId":"API-docs/v1.1/get-user","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/getcredits","label":"Get your API credits","className":"get api-method","docId":"API-docs/v1.1/getcredits","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Contacts","items":[{"type":"link","href":"/docs/API-docs/v1.1/createcontact","label":"Create Contact","className":"post api-method","docId":"API-docs/v1.1/createcontact","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/getcontact","label":"Get Contact","className":"get api-method","docId":"API-docs/v1.1/getcontact","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/deletecontact","label":"Delete Contact","className":"delete api-method","docId":"API-docs/v1.1/deletecontact","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/contactlist","label":"Get Contact list","className":"get api-method","docId":"API-docs/v1.1/contactlist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Documents","items":[{"type":"link","href":"/docs/API-docs/v1.1/selfsign","label":"Self Sign","className":"post api-method","docId":"API-docs/v1.1/selfsign","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/draftdocument","label":"Draft Document","className":"post api-method","docId":"API-docs/v1.1/draftdocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/createdocument","label":"Create Document","className":"post api-method","docId":"API-docs/v1.1/createdocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/createdocumentwithtemplateid","label":"Create Document from Template","className":"post api-method","docId":"API-docs/v1.1/createdocumentwithtemplateid","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/getdocument","label":"Get Document","className":"get api-method","docId":"API-docs/v1.1/getdocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/update-document","label":"Update Document","className":"put api-method","docId":"API-docs/v1.1/update-document","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/revokedocument","label":"Revoke Document","className":"post api-method","docId":"API-docs/v1.1/revokedocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/deletedocument","label":"Delete Document","className":"delete api-method","docId":"API-docs/v1.1/deletedocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/getdocumentlist","label":"Get Document list from status","className":"get api-method","docId":"API-docs/v1.1/getdocumentlist","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/resendrequestmail","label":"Resend request mail","className":"post api-method","docId":"API-docs/v1.1/resendrequestmail","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/getsignerips","label":"Get Signer IPs","className":"get api-method","docId":"API-docs/v1.1/getsignerips","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/getformdata","label":"Get Formdata","className":"get api-method","docId":"API-docs/v1.1/getformdata","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/getsigninglinks","label":"Get Signing Links","className":"get api-method","docId":"API-docs/v1.1/getsigninglinks","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Templates","items":[{"type":"link","href":"/docs/API-docs/v1.1/drafttemplate","label":"Draft Template","className":"post api-method","docId":"API-docs/v1.1/drafttemplate","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/createtemplate","label":"Create Template","className":"post api-method","docId":"API-docs/v1.1/createtemplate","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/publictemplate","label":"Public Template","className":"post api-method","docId":"API-docs/v1.1/publictemplate","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/get-template","label":"Get Template","className":"get api-method","docId":"API-docs/v1.1/get-template","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/update-template","label":"Update Template","className":"put api-method","docId":"API-docs/v1.1/update-template","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/delete-template","label":"Delete Template","className":"delete api-method","docId":"API-docs/v1.1/delete-template","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/gettemplatelist","label":"Get Template list","className":"get api-method","docId":"API-docs/v1.1/gettemplatelist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Webhook","items":[{"type":"link","href":"/docs/API-docs/v1.1/get-webhook","label":"Get Webhook","className":"get api-method","docId":"API-docs/v1.1/get-webhook","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/save-update-webhook","label":"Save or Update Webhook","className":"post api-method","docId":"API-docs/v1.1/save-update-webhook","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/delete-webhook","label":"Delete Webhook","className":"delete api-method","docId":"API-docs/v1.1/delete-webhook","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Folder","items":[{"type":"link","href":"/docs/API-docs/v1.1/createfolder","label":"Create Folder","className":"post api-method","docId":"API-docs/v1.1/createfolder","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/getfolder","label":"Get Folder","className":"get api-method","docId":"API-docs/v1.1/getfolder","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/updatefolder","label":"Update Folder","className":"put api-method","docId":"API-docs/v1.1/updatefolder","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/deletefolder","label":"Delete Folder","className":"delete api-method","docId":"API-docs/v1.1/deletefolder","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/folderlist","label":"Get folder list","className":"get api-method","docId":"API-docs/v1.1/folderlist","unlisted":false}],"collapsed":true,"collapsible":true}],"collapsible":true,"href":"/docs/API-docs/v1.1"},{"type":"category","label":"v1","collapsed":true,"items":[{"type":"link","href":"/docs/API-docs/v1/opensign-api-v-1","label":"Introduction","docId":"API-docs/v1/opensign-api-v-1","unlisted":false},{"type":"category","label":"User","items":[{"type":"link","href":"/docs/API-docs/v1/get-user","label":"Get your account details","className":"get api-method","docId":"API-docs/v1/get-user","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Contacts","items":[{"type":"link","href":"/docs/API-docs/v1/createcontact","label":"Create Contact","className":"post api-method","docId":"API-docs/v1/createcontact","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/getcontact","label":"Get Contact","className":"get api-method","docId":"API-docs/v1/getcontact","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/deletecontact","label":"Delete Contact","className":"delete api-method","docId":"API-docs/v1/deletecontact","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/contactlist","label":"Get Contact list","className":"get api-method","docId":"API-docs/v1/contactlist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Documents","items":[{"type":"link","href":"/docs/API-docs/v1/selfsign","label":"Self Sign","className":"post api-method","docId":"API-docs/v1/selfsign","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/draftdocument","label":"Draft Document","className":"post api-method","docId":"API-docs/v1/draftdocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/createdocument","label":"Create Document","className":"post api-method","docId":"API-docs/v1/createdocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/createdocumentwithtemplateid","label":"Create Document from Template","className":"post api-method","docId":"API-docs/v1/createdocumentwithtemplateid","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/getdocument","label":"Get Document","className":"get api-method","docId":"API-docs/v1/getdocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/update-document","label":"Update Document","className":"put api-method","docId":"API-docs/v1/update-document","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/revokedocument","label":"Revoke Document","className":"post api-method","docId":"API-docs/v1/revokedocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/deletedocument","label":"Delete Document","className":"delete api-method","docId":"API-docs/v1/deletedocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/getdocumentlist","label":"Get Document list from status","className":"get api-method","docId":"API-docs/v1/getdocumentlist","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/resendrequestmail","label":"Resend request mail","className":"post api-method","docId":"API-docs/v1/resendrequestmail","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Templates","items":[{"type":"link","href":"/docs/API-docs/v1/drafttemplate","label":"Draft Template","className":"post api-method","docId":"API-docs/v1/drafttemplate","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/createtemplate","label":"Create Template","className":"post api-method","docId":"API-docs/v1/createtemplate","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/get-template","label":"Get Template","className":"get api-method","docId":"API-docs/v1/get-template","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/update-template","label":"Update Template","className":"put api-method","docId":"API-docs/v1/update-template","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/delete-template","label":"Delete Template","className":"delete api-method","docId":"API-docs/v1/delete-template","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/gettemplatelist","label":"Get Template list","className":"get api-method","docId":"API-docs/v1/gettemplatelist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Webhook","items":[{"type":"link","href":"/docs/API-docs/v1/get-webhook","label":"Get Webhook","className":"get api-method","docId":"API-docs/v1/get-webhook","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/save-update-webhook","label":"Save or Update Webhook","className":"post api-method","docId":"API-docs/v1/save-update-webhook","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/delete-webhook","label":"Delete Webhook","className":"delete api-method","docId":"API-docs/v1/delete-webhook","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Folder","items":[{"type":"link","href":"/docs/API-docs/v1/createfolder","label":"Create Folder","className":"post api-method","docId":"API-docs/v1/createfolder","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/getfolder","label":"Get Folder","className":"get api-method","docId":"API-docs/v1/getfolder","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/updatefolder","label":"Update Folder","className":"put api-method","docId":"API-docs/v1/updatefolder","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/deletefolder","label":"Delete Folder","className":"delete api-method","docId":"API-docs/v1/deletefolder","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/folderlist","label":"Get folder list","className":"get api-method","docId":"API-docs/v1/folderlist","unlisted":false}],"collapsed":true,"collapsible":true}],"collapsible":true,"href":"/docs/API-docs/v1"}]},"docs":{"API-docs/api-intro":{"id":"API-docs/api-intro","title":"OpenSign APIs","description":"Welcome to the OpenSign API. Choose a version from the sidebar:"},"API-docs/v1.1/contactlist":{"id":"API-docs/v1.1/contactlist","title":"Get Contact list","description":"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.","sidebar":"apiSidebar"},"API-docs/v1.1/createcontact":{"id":"API-docs/v1.1/createcontact","title":"Create Contact","description":"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.","sidebar":"apiSidebar"},"API-docs/v1.1/createdocument":{"id":"API-docs/v1.1/createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file.","sidebar":"apiSidebar"},"API-docs/v1.1/createdocumentwithtemplateid":{"id":"API-docs/v1.1/createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","sidebar":"apiSidebar"},"API-docs/v1.1/createfolder":{"id":"API-docs/v1.1/createfolder","title":"Create Folder","description":"The Create Folder API allows you to create folder.","sidebar":"apiSidebar"},"API-docs/v1.1/createtemplate":{"id":"API-docs/v1.1/createtemplate","title":"Create Template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.","sidebar":"apiSidebar"},"API-docs/v1.1/delete-template":{"id":"API-docs/v1.1/delete-template","title":"Delete Template","description":"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed","sidebar":"apiSidebar"},"API-docs/v1.1/delete-webhook":{"id":"API-docs/v1.1/delete-webhook","title":"Delete Webhook","description":"The Delete Webhook API allow you to delete webhook url","sidebar":"apiSidebar"},"API-docs/v1.1/deletecontact":{"id":"API-docs/v1.1/deletecontact","title":"Delete Contact","description":"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact\'s information, this API makes it easy to delete their record.","sidebar":"apiSidebar"},"API-docs/v1.1/deletedocument":{"id":"API-docs/v1.1/deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","sidebar":"apiSidebar"},"API-docs/v1.1/deletefolder":{"id":"API-docs/v1.1/deletefolder","title":"Delete Folder","description":"The delete Folder API allows you to delete folder.","sidebar":"apiSidebar"},"API-docs/v1.1/draftdocument":{"id":"API-docs/v1.1/draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","sidebar":"apiSidebar"},"API-docs/v1.1/drafttemplate":{"id":"API-docs/v1.1/drafttemplate","title":"Draft Template","description":"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.","sidebar":"apiSidebar"},"API-docs/v1.1/folderlist":{"id":"API-docs/v1.1/folderlist","title":"Get folder list","description":"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId","sidebar":"apiSidebar"},"API-docs/v1.1/get-template":{"id":"API-docs/v1.1/get-template","title":"Get Template","description":"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.","sidebar":"apiSidebar"},"API-docs/v1.1/get-user":{"id":"API-docs/v1.1/get-user","title":"Get your account details","description":"The Get User API enables you to get your own account details.","sidebar":"apiSidebar"},"API-docs/v1.1/get-webhook":{"id":"API-docs/v1.1/get-webhook","title":"Get Webhook","description":"The Get Webhook API allow you to get webhook url","sidebar":"apiSidebar"},"API-docs/v1.1/getcontact":{"id":"API-docs/v1.1/getcontact","title":"Get Contact","description":"The Get Contact API allows you to retrieve details about a specific contact.","sidebar":"apiSidebar"},"API-docs/v1.1/getcredits":{"id":"API-docs/v1.1/getcredits","title":"Get your API credits","description":"The Get Credits API returns details about the credits available to your account:","sidebar":"apiSidebar"},"API-docs/v1.1/getdocument":{"id":"API-docs/v1.1/getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","sidebar":"apiSidebar"},"API-docs/v1.1/getdocumentlist":{"id":"API-docs/v1.1/getdocumentlist","title":"Get Document list from status","description":"### Document Types:","sidebar":"apiSidebar"},"API-docs/v1.1/getfolder":{"id":"API-docs/v1.1/getfolder","title":"Get Folder","description":"The Get Folder API allows you to retrieve details about a specific folder.","sidebar":"apiSidebar"},"API-docs/v1.1/getformdata":{"id":"API-docs/v1.1/getformdata","title":"Get Formdata","description":"The Get Formdata API enables you to retrieve widget data filled by signers who signed the document.","sidebar":"apiSidebar"},"API-docs/v1.1/getsignerips":{"id":"API-docs/v1.1/getsignerips","title":"Get Signer IPs","description":"The Get Signer IPs API enables you to retrieve IPs of signers who signed the document.","sidebar":"apiSidebar"},"API-docs/v1.1/getsigninglinks":{"id":"API-docs/v1.1/getsigninglinks","title":"Get Signing Links","description":"The Get Signing Links API enables you to retrieve signing urls of signers for the document.","sidebar":"apiSidebar"},"API-docs/v1.1/gettemplatelist":{"id":"API-docs/v1.1/gettemplatelist","title":"Get Template list","description":"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.","sidebar":"apiSidebar"},"API-docs/v1.1/intro":{"id":"API-docs/v1.1/intro","title":"Overview","description":"OpenSign\u2122 API offers a robust suite of functionalities for digital document management and electronic signatures. Designed to cater to a wide array of business needs, the API facilitates the creation, signing, and management of digital documents. It ensures secure and efficient processes, complying with international legal standards for electronic signatures."},"API-docs/v1.1/opensign-api-v-1-1":{"id":"API-docs/v1.1/opensign-api-v-1-1","title":"OpenSign API v1.1","description":"Welcome to the **OpenSign\u2122 API v1.1** documentation.","sidebar":"apiSidebar"},"API-docs/v1.1/publictemplate":{"id":"API-docs/v1.1/publictemplate","title":"Public Template","description":"The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique **template_id** and a **public_url**. The **public_url** is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing.","sidebar":"apiSidebar"},"API-docs/v1.1/resendrequestmail":{"id":"API-docs/v1.1/resendrequestmail","title":"Resend request mail","description":"Resend request mail to user for signing document.","sidebar":"apiSidebar"},"API-docs/v1.1/revokedocument":{"id":"API-docs/v1.1/revokedocument","title":"Revoke Document","description":"The Revoke document API allows you to revoke specific document from your documents.","sidebar":"apiSidebar"},"API-docs/v1.1/save-update-webhook":{"id":"API-docs/v1.1/save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.","sidebar":"apiSidebar"},"API-docs/v1.1/selfsign":{"id":"API-docs/v1.1/selfsign","title":"Self Sign","description":"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.","sidebar":"apiSidebar"},"API-docs/v1.1/update-document":{"id":"API-docs/v1.1/update-document","title":"Update Document","description":"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.","sidebar":"apiSidebar"},"API-docs/v1.1/update-template":{"id":"API-docs/v1.1/update-template","title":"Update Template","description":"The Update Template API enables you to modify and update the details of a specific template.","sidebar":"apiSidebar"},"API-docs/v1.1/updatefolder":{"id":"API-docs/v1.1/updatefolder","title":"Update Folder","description":"The Update Folder API allows you to uodate folder name as well as parentFolderId.","sidebar":"apiSidebar"},"API-docs/v1.2/contactlist":{"id":"API-docs/v1.2/contactlist","title":"Get Contact list","description":"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.","sidebar":"apiSidebar"},"API-docs/v1.2/createcontact":{"id":"API-docs/v1.2/createcontact","title":"Create Contact","description":"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.","sidebar":"apiSidebar"},"API-docs/v1.2/createdocument":{"id":"API-docs/v1.2/createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file.","sidebar":"apiSidebar"},"API-docs/v1.2/createdocumentwithtemplateid":{"id":"API-docs/v1.2/createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","sidebar":"apiSidebar"},"API-docs/v1.2/createfolder":{"id":"API-docs/v1.2/createfolder","title":"Create Folder","description":"The Create Folder API allows you to create folder.","sidebar":"apiSidebar"},"API-docs/v1.2/createtemplate":{"id":"API-docs/v1.2/createtemplate","title":"Create Template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.","sidebar":"apiSidebar"},"API-docs/v1.2/delete-template":{"id":"API-docs/v1.2/delete-template","title":"Delete Template","description":"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed","sidebar":"apiSidebar"},"API-docs/v1.2/delete-webhook":{"id":"API-docs/v1.2/delete-webhook","title":"Delete Webhook","description":"The Delete Webhook API allow you to delete webhook url","sidebar":"apiSidebar"},"API-docs/v1.2/deletecontact":{"id":"API-docs/v1.2/deletecontact","title":"Delete Contact","description":"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact\'s information, this API makes it easy to delete their record.","sidebar":"apiSidebar"},"API-docs/v1.2/deletedocument":{"id":"API-docs/v1.2/deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","sidebar":"apiSidebar"},"API-docs/v1.2/deletefolder":{"id":"API-docs/v1.2/deletefolder","title":"Delete Folder","description":"The delete Folder API allows you to delete folder.","sidebar":"apiSidebar"},"API-docs/v1.2/draftdocument":{"id":"API-docs/v1.2/draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","sidebar":"apiSidebar"},"API-docs/v1.2/drafttemplate":{"id":"API-docs/v1.2/drafttemplate","title":"Draft Template","description":"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.","sidebar":"apiSidebar"},"API-docs/v1.2/folderlist":{"id":"API-docs/v1.2/folderlist","title":"Get folder list","description":"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId","sidebar":"apiSidebar"},"API-docs/v1.2/get-template":{"id":"API-docs/v1.2/get-template","title":"Get Template","description":"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.","sidebar":"apiSidebar"},"API-docs/v1.2/get-user":{"id":"API-docs/v1.2/get-user","title":"Get your account details","description":"The Get User API enables you to get your own account details.","sidebar":"apiSidebar"},"API-docs/v1.2/get-webhook":{"id":"API-docs/v1.2/get-webhook","title":"Get Webhook","description":"The Get Webhook API allow you to get webhook url","sidebar":"apiSidebar"},"API-docs/v1.2/getcontact":{"id":"API-docs/v1.2/getcontact","title":"Get Contact","description":"The Get Contact API allows you to retrieve details about a specific contact.","sidebar":"apiSidebar"},"API-docs/v1.2/getcredits":{"id":"API-docs/v1.2/getcredits","title":"Get your API credits","description":"The Get Credits API returns details about the credits available to your account:","sidebar":"apiSidebar"},"API-docs/v1.2/getdocument":{"id":"API-docs/v1.2/getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","sidebar":"apiSidebar"},"API-docs/v1.2/getdocumentlist":{"id":"API-docs/v1.2/getdocumentlist","title":"Get Document list from status","description":"### Document Types:","sidebar":"apiSidebar"},"API-docs/v1.2/getfolder":{"id":"API-docs/v1.2/getfolder","title":"Get Folder","description":"The Get Folder API allows you to retrieve details about a specific folder.","sidebar":"apiSidebar"},"API-docs/v1.2/getformdata":{"id":"API-docs/v1.2/getformdata","title":"Get Formdata","description":"The Get Formdata API enables you to retrieve widget data filled by signers who signed the document.","sidebar":"apiSidebar"},"API-docs/v1.2/getsignerips":{"id":"API-docs/v1.2/getsignerips","title":"Get Signer IPs","description":"The Get Signer IPs API enables you to retrieve IPs of signers who signed the document.","sidebar":"apiSidebar"},"API-docs/v1.2/getsigninglinks":{"id":"API-docs/v1.2/getsigninglinks","title":"Get Signing Links","description":"The Get Signing Links API enables you to retrieve signing urls of signers for the document.","sidebar":"apiSidebar"},"API-docs/v1.2/gettemplatelist":{"id":"API-docs/v1.2/gettemplatelist","title":"Get Template list","description":"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.","sidebar":"apiSidebar"},"API-docs/v1.2/intro":{"id":"API-docs/v1.2/intro","title":"Overview","description":"OpenSign\u2122 API v1.2 \u2014 the open-source DocuSign alternative, built for developers and trusted by enterprises."},"API-docs/v1.2/opensign-api-v-1-2":{"id":"API-docs/v1.2/opensign-api-v-1-2","title":"OpenSign API v1.2","description":"Welcome to the **OpenSign\u2122 API v1.2** documentation.","sidebar":"apiSidebar"},"API-docs/v1.2/publictemplate":{"id":"API-docs/v1.2/publictemplate","title":"Public Template","description":"The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique **template_id** and a **public_url**. The **public_url** is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing.","sidebar":"apiSidebar"},"API-docs/v1.2/resendrequestmail":{"id":"API-docs/v1.2/resendrequestmail","title":"Resend request mail","description":"Resend request mail to user for signing document.","sidebar":"apiSidebar"},"API-docs/v1.2/revokedocument":{"id":"API-docs/v1.2/revokedocument","title":"Revoke Document","description":"The Revoke document API allows you to revoke specific document from your documents.","sidebar":"apiSidebar"},"API-docs/v1.2/save-update-webhook":{"id":"API-docs/v1.2/save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.","sidebar":"apiSidebar"},"API-docs/v1.2/selfsign":{"id":"API-docs/v1.2/selfsign","title":"Self Sign","description":"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.","sidebar":"apiSidebar"},"API-docs/v1.2/update-document":{"id":"API-docs/v1.2/update-document","title":"Update Document","description":"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.","sidebar":"apiSidebar"},"API-docs/v1.2/update-template":{"id":"API-docs/v1.2/update-template","title":"Update Template","description":"The Update Template API enables you to modify and update the details of a specific template.","sidebar":"apiSidebar"},"API-docs/v1.2/updatefolder":{"id":"API-docs/v1.2/updatefolder","title":"Update Folder","description":"The Update Folder API allows you to uodate folder name as well as parentFolderId.","sidebar":"apiSidebar"},"API-docs/v1/contactlist":{"id":"API-docs/v1/contactlist","title":"Get Contact list","description":"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.","sidebar":"apiSidebar"},"API-docs/v1/createcontact":{"id":"API-docs/v1/createcontact","title":"Create Contact","description":"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.","sidebar":"apiSidebar"},"API-docs/v1/createdocument":{"id":"API-docs/v1/createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file.","sidebar":"apiSidebar"},"API-docs/v1/createdocumentwithtemplateid":{"id":"API-docs/v1/createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","sidebar":"apiSidebar"},"API-docs/v1/createfolder":{"id":"API-docs/v1/createfolder","title":"Create Folder","description":"The Create Folder API allows you to create folder.","sidebar":"apiSidebar"},"API-docs/v1/createtemplate":{"id":"API-docs/v1/createtemplate","title":"Create Template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.","sidebar":"apiSidebar"},"API-docs/v1/delete-template":{"id":"API-docs/v1/delete-template","title":"Delete Template","description":"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed","sidebar":"apiSidebar"},"API-docs/v1/delete-webhook":{"id":"API-docs/v1/delete-webhook","title":"Delete Webhook","description":"The Delete Webhook API allow you to delete webhook url","sidebar":"apiSidebar"},"API-docs/v1/deletecontact":{"id":"API-docs/v1/deletecontact","title":"Delete Contact","description":"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact\'s information, this API makes it easy to delete their record.","sidebar":"apiSidebar"},"API-docs/v1/deletedocument":{"id":"API-docs/v1/deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","sidebar":"apiSidebar"},"API-docs/v1/deletefolder":{"id":"API-docs/v1/deletefolder","title":"Delete Folder","description":"The delete Folder API allows you to delete folder.","sidebar":"apiSidebar"},"API-docs/v1/draftdocument":{"id":"API-docs/v1/draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","sidebar":"apiSidebar"},"API-docs/v1/drafttemplate":{"id":"API-docs/v1/drafttemplate","title":"Draft Template","description":"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.","sidebar":"apiSidebar"},"API-docs/v1/folderlist":{"id":"API-docs/v1/folderlist","title":"Get folder list","description":"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId","sidebar":"apiSidebar"},"API-docs/v1/get-template":{"id":"API-docs/v1/get-template","title":"Get Template","description":"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.","sidebar":"apiSidebar"},"API-docs/v1/get-user":{"id":"API-docs/v1/get-user","title":"Get your account details","description":"The Get User API enables you to get your own account details.","sidebar":"apiSidebar"},"API-docs/v1/get-webhook":{"id":"API-docs/v1/get-webhook","title":"Get Webhook","description":"The Get Webhook API allow you to get webhook url","sidebar":"apiSidebar"},"API-docs/v1/getcontact":{"id":"API-docs/v1/getcontact","title":"Get Contact","description":"The Get Contact API allows you to retrieve details about a specific contact.","sidebar":"apiSidebar"},"API-docs/v1/getdocument":{"id":"API-docs/v1/getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","sidebar":"apiSidebar"},"API-docs/v1/getdocumentlist":{"id":"API-docs/v1/getdocumentlist","title":"Get Document list from status","description":"### Document Types:","sidebar":"apiSidebar"},"API-docs/v1/getfolder":{"id":"API-docs/v1/getfolder","title":"Get Folder","description":"The Get Folder API allows you to retrieve details about a specific folder.","sidebar":"apiSidebar"},"API-docs/v1/gettemplatelist":{"id":"API-docs/v1/gettemplatelist","title":"Get Template list","description":"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.","sidebar":"apiSidebar"},"API-docs/v1/intro":{"id":"API-docs/v1/intro","title":"Overview","description":"OpenSign\u2122 API offers a robust suite of functionalities for digital document management and electronic signatures. Designed to cater to a wide array of business needs, the API facilitates the creation, signing, and management of digital documents. It ensures secure and efficient processes, complying with international legal standards for electronic signatures."},"API-docs/v1/opensign-api-v-1":{"id":"API-docs/v1/opensign-api-v-1","title":"OpenSign API v1","description":"Welcome to the OpenSign\u2122 API documentation!","sidebar":"apiSidebar"},"API-docs/v1/resendrequestmail":{"id":"API-docs/v1/resendrequestmail","title":"Resend request mail","description":"Resend request mail to user for signing document.","sidebar":"apiSidebar"},"API-docs/v1/revokedocument":{"id":"API-docs/v1/revokedocument","title":"Revoke Document","description":"The Revoke document API allows you to revoke specific document from your documents.","sidebar":"apiSidebar"},"API-docs/v1/save-update-webhook":{"id":"API-docs/v1/save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.","sidebar":"apiSidebar"},"API-docs/v1/selfsign":{"id":"API-docs/v1/selfsign","title":"Self Sign","description":"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.","sidebar":"apiSidebar"},"API-docs/v1/update-document":{"id":"API-docs/v1/update-document","title":"Update Document","description":"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.","sidebar":"apiSidebar"},"API-docs/v1/update-template":{"id":"API-docs/v1/update-template","title":"Update Template","description":"The Update Template API enables you to modify and update the details of a specific template.","sidebar":"apiSidebar"},"API-docs/v1/updatefolder":{"id":"API-docs/v1/updatefolder","title":"Update Folder","description":"The Update Folder API allows you to uodate folder name as well as parentFolderId.","sidebar":"apiSidebar"},"contribute/CODE_OF_CONDUCT":{"id":"contribute/CODE_OF_CONDUCT","title":"Code of conduct","description":"1. Introduction","sidebar":"contributeSidebar"},"contribute/COMMUNITY":{"id":"contribute/COMMUNITY","title":"Community at OpenSign\u2122","description":"Welcome to the OpenSign\u2122 Community page! OpenSign\u2122 is dedicated to fostering a vibrant and engaging community where members can connect, share ideas and collaborate on the OpenSign\u2122 project. This page provides links to our active social media platforms and community channels, offering various ways for you to join and participate in the OpenSign\u2122 community. Whether you\'re looking for support, eager to contribute or just want to stay updated, you\'ll find a platform that suits your preference. Connect with us on Discord for real-time discussions, follow us on Twitter for the latest updates, engage with our professional network on LinkedIn or join our Facebook group for a broader community experience. Join us in our mission to develop OpenSign\u2122 as the premier open-source alternative to DocuSign.","sidebar":"contributeSidebar"},"contribute/INSTALLATION":{"id":"contribute/INSTALLATION","title":"Installation instructions","description":"You can use our app as a cloud version from OpenSignLabs","sidebar":"contributeSidebar"},"contribute/intro":{"id":"contribute/intro","title":"Contributing to OpenSign","description":"Hello there! Thank you for considering contributing to OpenSign, the open-source alternative to DocuSign. OpenSign is not just a project, but a community endeavor that aims to create a robust, user-friendly, and secure electronic signature solution. Your contributions, irrespective of their size, are valuable in making this vision a reality.","sidebar":"contributeSidebar"},"contribute/REPORTING_GUIDELINES":{"id":"contribute/REPORTING_GUIDELINES","title":"OpenSign\u2122 Reporting Guidelines","description":"This document provides guidelines for reporting issues, suggesting enhancements, and submitting pull requests to the OpenSign\u2122 GitHub repository. Adhering to these guidelines helps maintain the project\'s quality and efficiency.","sidebar":"contributeSidebar"},"help/FAQs/Credit-Deductions":{"id":"help/FAQs/Credit-Deductions","title":"Credit-Deductions","description":"1. When are Premium Credits deducted? Which actions use Premium Credits?","sidebar":"tutorialSidebar"},"help/FAQs/Ensure this field is accurately filled and meets all requirements":{"id":"help/FAQs/Ensure this field is accurately filled and meets all requirements","title":"Why am I getting \'Ensure this field is accurately filled and meets all requirements\'?","description":"This happens when you leave a field blank or when you don\u2019t enter correct values in the field, for example not entering email address in correct format.","sidebar":"tutorialSidebar"},"help/FAQs/FAQs":{"id":"help/FAQs/FAQs","title":"Why is there no dropdown list when I sign a document myself?","description":"The dropdown list field is available only when you request a signature from others or when you create a template. This is because dropdown lists function as temporary widgets, allowing the user to select one of multiple values. Once a signer selects a value from the dropdown, it is embedded into the document as text. When you sign a document yourself, OpenSign digitally signs it immediately upon clicking the finish button. Therefore, you can use the text widget to add the necessary text to the document.","sidebar":"tutorialSidebar"},"help/FAQs/Max File Upload Size":{"id":"help/FAQs/Max File Upload Size","title":"Max File Upload Size","description":"\u2753 What is the default maximum file size that can be uploaded to OpenSign?","sidebar":"tutorialSidebar"},"help/FAQs/User Deletion":{"id":"help/FAQs/User Deletion","title":"User Deletion","description":"\u2753 Who can delete users?","sidebar":"tutorialSidebar"},"help/intro":{"id":"help/intro","title":"Intro","description":"\ud83c\udf1fGet ready for an electrifying journey at OpenSign\u2122, the most incredibly documented open source document signing solution! \ud83d\ude80 This is your go-to spot for diving deep into everything OpenSign\u2122 has to offer. Whether you\u2019re just starting out or you\u2019re a seasoned pro eager to uncover even more cool features, we\u2019ve got you covered with the most awesome, top-notch guides and resources around. Get ready to make the most out of OpenSign\u2122 \ud83c\udf89\ud83d\udcda\ud83d\udd0d Your adventure in excellence starts here! \ud83c\udf08\u2728\ud83c\udf1f","sidebar":"tutorialSidebar"},"help/New-Document/edit-document-before-sending":{"id":"help/New-Document/edit-document-before-sending","title":"Editing Your Document Before Sending","description":"OpenSign\u2122 lets you polish your PDF before you send it out\u2014whether you\u2019re signing it yourself, requesting signatures, or saving it as a template. You get four core editing controls right in the preview:","sidebar":"tutorialSidebar"},"help/New-Document/enforce-email-verification":{"id":"help/New-Document/enforce-email-verification","title":"Enforce email OTP verification","description":"The \\"Enable OTP Verification\\" feature in OpenSign is designed to add an extra layer of security to the document-signing process by verifying the signer\u2019s email address. Here\u2019s an in-depth look at how it works, when to use it, and its impact on the signing process.","sidebar":"tutorialSidebar"},"help/New-Document/request-signatures":{"id":"help/New-Document/request-signatures","title":"Request signatures","description":"Interface Overview","sidebar":"tutorialSidebar"},"help/New-Document/sign-yourself":{"id":"help/New-Document/sign-yourself","title":"Sign your-self","description":"Interface Overview","sidebar":"tutorialSidebar"},"help/New-Document/widgets":{"id":"help/New-Document/widgets","title":"Widgets in OpenSign","description":"Widgets in OpenSign are interactive fields that you can place on your documents to collect information, signatures, or confirmations from recipients during the signing process.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/create-document":{"id":"help/OpenSign\u2122 Drive/create-document","title":"Create Docs & Folders","description":"OpenSign Drive offers a streamlined way to manage, sign, and request signatures on your important documents. Whether you\'re drafting an offer letter or storing signed agreements, organizing your documents effectively is crucial. Here\u2019s a step-by-step guide on how to create documents and folders in OpenSign Drive.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/list-grid-view":{"id":"help/OpenSign\u2122 Drive/list-grid-view","title":"Grid vs List view","description":"- Navigate to OpenSign drive using the main menu or clicking this link.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/organize-documents":{"id":"help/OpenSign\u2122 Drive/organize-documents","title":"OpenSign\u2122 Drive Interface Documentation","description":"Overview","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/rename-document":{"id":"help/OpenSign\u2122 Drive/rename-document","title":"Rename documents from OpenSign\u2122 Drive","description":"The OpenSign\u2122 Drive interface allows users to rename their documents efficiently.","sidebar":"tutorialSidebar"},"help/Reports/completed":{"id":"help/Reports/completed","title":"Completed","description":"---","sidebar":"tutorialSidebar"},"help/Reports/contactbook":{"id":"help/Reports/contactbook","title":"Contactbook","description":"The Contactbook report in OpenSign enables you to add and manage contacts.","sidebar":"tutorialSidebar"},"help/Reports/declined":{"id":"help/Reports/declined","title":"Declined","description":"The \\"Declined documents\\" report within OpenSign serves as a vital tool for managing and reviewing all declined documents that have been processed through the platform. This guide will walk you through the key features and functionalities of the \\"Declined documents\\" report, enabling you to efficiently navigate and manage your signed documents.","sidebar":"tutorialSidebar"},"help/Reports/drafts":{"id":"help/Reports/drafts","title":"Drafts","description":"The Draft documents section in OpenSign helps you manage all your in-progress documents easily. This feature allows you to save, review, and edit documents before sending them for signature. Here\'s a detailed overview of how to navigate and use the Draft Documents report effectively.","sidebar":"tutorialSidebar"},"help/Reports/expired":{"id":"help/Reports/expired","title":"Expired","description":"The Expired documents report in OpenSign allows you to manage and review documents that have reached their expiration date without being signed. This feature is essential for maintaining an organized record of inactive documents that may require follow-up or archival.","sidebar":"tutorialSidebar"},"help/Reports/in-progress":{"id":"help/Reports/in-progress","title":"In Progress","description":"The In-Progress documents report in OpenSign helps you monitor and manage documents that are currently in the signing process. This report enables you to monitor the status of your documents, manually share the document URL, track document progress, resend reminders, revoke access, or delete documents that are no longer required. Here\u2019s a detailed guide on how to use the In-Progress documents report effectively.","sidebar":"tutorialSidebar"},"help/Reports/need-your-sign":{"id":"help/Reports/need-your-sign","title":"Need your sign","description":"The \\"Need your sign\\" feature in OpenSign is designed to simplify the process of managing documents that require your signature. This guide will walk you through the various elements of the \\"Need your sign\\" report, helping you to efficiently navigate and complete your pending signing tasks.","sidebar":"tutorialSidebar"},"help/Settings/APIToken":{"id":"help/Settings/APIToken","title":"API Token","description":"To authenticate and use OpenSign API endpoints, you\u2019ll need a valid API token (x-api-token).","sidebar":"tutorialSidebar"},"help/Settings/Custom-email-templates":{"id":"help/Settings/Custom-email-templates","title":"Custom email templates","description":"\ud83d\ude80 Steps to Set Up Custom Email Templates","sidebar":"tutorialSidebar"},"help/Settings/disabledocumentid":{"id":"help/Settings/disabledocumentid","title":"Disable DocumentId","description":"Whenever a document is signed by all parties, OpenSign\u2122 adds a DocumentId at the top left corner of the digitally signed document.","sidebar":"tutorialSidebar"},"help/Settings/manage-users":{"id":"help/Settings/manage-users","title":"Manage users","description":"The User Management feature in OpenSign allows administrators to add, edit, and manage users within the platform. This functionality is available on Self-Hosted, Teams, and Enterprise plans.","sidebar":"tutorialSidebar"},"help/Settings/my-signature":{"id":"help/Settings/my-signature","title":"My Signature","description":"This guide provides instructions on how to save your signature and initials using the OpenSign application. Once saved, you can use them with one click when signing documents. To create your signature, start by clicking the \\"My Signature\\" link under \\"settings\\" menu.","sidebar":"tutorialSidebar"},"help/Settings/Preferences":{"id":"help/Settings/Preferences","title":"Preferences","description":"The Preferences page in OpenSign\u2122 allows users and administrators to tailor the signing experience to suit individual, team, or organizational needs. Below is a breakdown of all configurable options and what they control.","sidebar":"tutorialSidebar"},"help/Settings/SecurityManagement":{"id":"help/Settings/SecurityManagement","title":"Security","description":"\u2705 Two-Factor Authentication (2FA)","sidebar":"tutorialSidebar"},"help/Settings/Teams":{"id":"help/Settings/Teams","title":"Manage Teams","description":"The Teams feature in OpenSign allows you to organize your users into structured groups for easier management, permissions control, and streamlined workflow configuration.","sidebar":"tutorialSidebar"},"help/Settings/Webhook":{"id":"help/Settings/Webhook","title":"Webhook","description":"\ud83d\udd14 What is a Webhook?","sidebar":"tutorialSidebar"},"help/Templates/create-template":{"id":"help/Templates/create-template","title":"Create Templates","description":"Getting Started","sidebar":"tutorialSidebar"},"help/Templates/embed-template":{"id":"help/Templates/embed-template","title":"Embedding OpenSign templates","description":"OpenSign Template Embedding allows users to seamlessly integrate public document templates into their websites or applications. By embedding templates, you can provide a direct and interactive signing experience for your users without requiring them to leave your platform. This feature supports various technologies like React, Next.js, HTML, JavaScript, and Angular, making it easy to add signing capabilities to different web projects.","sidebar":"tutorialSidebar"},"help/Templates/manage-templates":{"id":"help/Templates/manage-templates","title":"Manage Templates","description":"Viewing and Managing Templates","sidebar":"tutorialSidebar"},"help/Templates/publicTemplate":{"id":"help/Templates/publicTemplate","title":"Setting up an OpenSign template for public signing","description":"The OpenSign Public profile feature offers the ultimate public document signing solution without any need for integrations. With this feature, users can share document templates publicly, allowing anyone to access and sign the documents directly through the shared templates. This streamlines the signing process by providing a seamless, accessible way for public signers to complete documents without additional steps or integrations.","sidebar":"tutorialSidebar"},"help/Templates/quick-send":{"id":"help/Templates/quick-send","title":"Bulk Document Send for Signature Using Template","description":"Overview","sidebar":"tutorialSidebar"},"help/Templates/use-template":{"id":"help/Templates/use-template","title":"Use template to create documents","description":"Step 1: Begin New Template Creation","sidebar":"tutorialSidebar"},"help/User Menu/Console/analystics":{"id":"help/User Menu/Console/analystics","title":"Analytics","description":"Documents Signed","sidebar":"tutorialSidebar"},"help/User Menu/Console/branding":{"id":"help/User Menu/Console/branding","title":"Branding","description":"Custom Subdomain","sidebar":"tutorialSidebar"},"help/User Menu/Console/custom_filestorage":{"id":"help/User Menu/Console/custom_filestorage","title":"Custom File Storage","description":"\ud83c\udf29\ufe0f Introduction to BYOC (Bring Your Own Cloud)","sidebar":"tutorialSidebar"},"help/User Menu/Console/emails":{"id":"help/User Menu/Console/emails","title":"Mail","description":"This page allows the admin user to configure and manage customized email templates at the organization level.","sidebar":"tutorialSidebar"},"help/User Menu/Console/general":{"id":"help/User Menu/Console/general","title":"General","description":"The General Settings section in OpenSign provides key administrative settings to help you manage and control the overall configuration of your OpenSign platform.","sidebar":"tutorialSidebar"},"help/User Menu/Console/globalSMTP":{"id":"help/User Menu/Console/globalSMTP","title":"Global SMTP","description":"\ud83c\udfe2 SMTP at the Organization Level","sidebar":"tutorialSidebar"},"help/User Menu/Console/orgadmin":{"id":"help/User Menu/Console/orgadmin","title":"Org Admins","description":"The Org Admins section allows administrators to manage organization-level admin users within OpenSign.","sidebar":"tutorialSidebar"},"help/User Menu/Console/organizations":{"id":"help/User Menu/Console/organizations","title":"Organizations","description":"The Organizations section in OpenSign allows administrators to create and manage separate groups within a Team or Enterprise account.","sidebar":"tutorialSidebar"},"help/User Menu/Console/signing_certificate":{"id":"help/User Menu/Console/signing_certificate","title":"Custom Signing Certificate","description":"The Custom Signing Certificate page allows you to upload and manage your own digital signing certificate (PFX format) for secure and verified document signing in OpenSign.","sidebar":"tutorialSidebar"},"help/User Menu/Profile":{"id":"help/User Menu/Profile","title":"Profile","description":"The Profile in OpenSign allows users to manage their personal and account-related details. You can update your information, verify your email, and set up a public profile.","sidebar":"tutorialSidebar"},"intro":{"id":"intro","title":"Tutorial Intro","description":"Let\'s discover Docusaurus in less than 5 minutes."},"self-host/cloud-storage/s3":{"id":"self-host/cloud-storage/s3","title":"AWS S3","description":"You can create an AWS S3 bucket to store your uploaded documents using OpenSign\u2122","sidebar":"selfhostSidebar"},"self-host/docker/run-locally":{"id":"self-host/docker/run-locally","title":"Self-host OpenSign\u2122 with Docker on Linux/MacOS/Windows","description":"Steps to run OpenSign\u2122 with docker on Linux/MacOS/Windows:","sidebar":"selfhostSidebar"},"self-host/docker/upgrade-deployment":{"id":"self-host/docker/upgrade-deployment","title":"OpenSign\u2122 Self-Hosted \'Upgrade Deployment\' Guide Using Docker on Linux, macOS, or Windows","description":"This guide provides step-by-step instructions to upgrade the deployment of OpenSign using Docker.","sidebar":"selfhostSidebar"},"self-host/guides/azure-vm-setup":{"id":"self-host/guides/azure-vm-setup","title":"OpenSign Deployment Guide on Azure VM via command-line","description":"\ud83e\uddf1 Prerequisites","sidebar":"selfhostSidebar"},"self-host/guides/env-variables":{"id":"self-host/guides/env-variables","title":"ENV variables which are used to setup OpenSign\u2122 with Docker on Localhost","description":"Information About ENV variables which are used to setup OpenSign\u2122 with Docker on Localhost","sidebar":"selfhostSidebar"},"self-host/guides/how-to-generate-self-signed-document-signing-certificate":{"id":"self-host/guides/how-to-generate-self-signed-document-signing-certificate","title":"How to generate self-signed document signing certificate?","description":"","sidebar":"selfhostSidebar"},"self-host/guides/upgrade-to-v2.1.0":{"id":"self-host/guides/upgrade-to-v2.1.0","title":"How to upgrade self-hosted OpenSign to v2.1.0?","description":"For self-hosted deployments, version 2.1.0 introduces changes to the signup process:","sidebar":"selfhostSidebar"},"self-host/intro":{"id":"self-host/intro","title":"Self-Hosting OpenSign","description":"This section of the OpenSign\u2122 documentation is dedicated to guiding you through the process of self-hosting the OpenSign platform. Self-hosting OpenSign allows for greater control and customization, ensuring that it aligns perfectly with your specific needs and infrastructure requirements. We cover everything from initial setup, configuration options, to maintenance best practices. Whether you are an individual enthusiast or a professional looking to deploy OpenSign in a corporate environment, this guide will provide you with the necessary steps and tips to successfully self-host OpenSign\u2122 - the best open source document signing infrastructure.","sidebar":"selfhostSidebar"},"self-host/One-click-Install/DigitalOcean":{"id":"self-host/One-click-Install/DigitalOcean","title":"Digital Ocean","description":"OpenSign application consists of 3 components -","sidebar":"selfhostSidebar"}}}}')}}]); \ No newline at end of file +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[849],{86164(e){e.exports=JSON.parse('{"version":{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"link","href":"/docs/help/intro","label":"Intro","docId":"help/intro","unlisted":false},{"type":"category","label":"Create New OpenSign Document","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/docs/help/New-Document/sign-yourself","label":"Sign your-self","docId":"help/New-Document/sign-yourself","unlisted":false},{"type":"link","href":"/docs/help/New-Document/request-signatures","label":"Request signatures","docId":"help/New-Document/request-signatures","unlisted":false},{"type":"link","href":"/docs/help/New-Document/widgets","label":"Widgets in OpenSign","docId":"help/New-Document/widgets","unlisted":false},{"type":"link","href":"/docs/help/New-Document/edit-document-before-sending","label":"Editing Your Document Before Sending","docId":"help/New-Document/edit-document-before-sending","unlisted":false},{"type":"link","href":"/docs/help/New-Document/enforce-email-verification","label":"Enforce email OTP verification","docId":"help/New-Document/enforce-email-verification","unlisted":false}],"href":"/docs/category/create-new-opensign-document"},{"type":"category","label":"Manage Docs using OpenSign\u2122 Drive","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/docs/help/OpenSign\u2122 Drive/create-document","label":"Create Docs & Folders","docId":"help/OpenSign\u2122 Drive/create-document","unlisted":false},{"type":"link","href":"/docs/help/OpenSign\u2122 Drive/list-grid-view","label":"Grid vs List view","docId":"help/OpenSign\u2122 Drive/list-grid-view","unlisted":false},{"type":"link","href":"/docs/help/OpenSign\u2122 Drive/organize-documents","label":"OpenSign\u2122 Drive Interface Documentation","docId":"help/OpenSign\u2122 Drive/organize-documents","unlisted":false},{"type":"link","href":"/docs/help/OpenSign\u2122 Drive/rename-document","label":"Rename documents from OpenSign\u2122 Drive","docId":"help/OpenSign\u2122 Drive/rename-document","unlisted":false}],"href":"/docs/category/manage-docs-using-opensign-drive"},{"type":"category","label":"Documents","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/docs/help/Reports/need-your-sign","label":"Need your sign","docId":"help/Reports/need-your-sign","unlisted":false},{"type":"link","href":"/docs/help/Reports/in-progress","label":"In Progress","docId":"help/Reports/in-progress","unlisted":false},{"type":"link","href":"/docs/help/Reports/completed","label":"Completed","docId":"help/Reports/completed","unlisted":false},{"type":"link","href":"/docs/help/Reports/drafts","label":"Drafts","docId":"help/Reports/drafts","unlisted":false},{"type":"link","href":"/docs/help/Reports/declined","label":"Declined","docId":"help/Reports/declined","unlisted":false},{"type":"link","href":"/docs/help/Reports/expired","label":"Expired","docId":"help/Reports/expired","unlisted":false},{"type":"link","href":"/docs/help/Reports/contactbook","label":"Contactbook","docId":"help/Reports/contactbook","unlisted":false}],"href":"/docs/category/documents"},{"type":"category","label":"Templates","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/docs/help/Templates/create-template","label":"Create Templates","docId":"help/Templates/create-template","unlisted":false},{"type":"link","href":"/docs/help/Templates/manage-templates","label":"Manage Templates","docId":"help/Templates/manage-templates","unlisted":false},{"type":"link","href":"/docs/help/Templates/use-template","label":"Use template to create documents","docId":"help/Templates/use-template","unlisted":false},{"type":"link","href":"/docs/help/Templates/quick-send","label":"Bulk Document Send for Signature Using Template","docId":"help/Templates/quick-send","unlisted":false},{"type":"link","href":"/docs/help/Templates/publicTemplate","label":"Setting up an OpenSign template for public signing","docId":"help/Templates/publicTemplate","unlisted":false},{"type":"link","href":"/docs/help/Templates/embed-template","label":"Embedding OpenSign templates","docId":"help/Templates/embed-template","unlisted":false}],"href":"/docs/category/templates"},{"type":"category","label":"Settings","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/docs/help/Settings/my-signature","label":"My Signature","docId":"help/Settings/my-signature","unlisted":false},{"type":"link","href":"/docs/help/Settings/APIToken","label":"API Token","docId":"help/Settings/APIToken","unlisted":false},{"type":"link","href":"/docs/help/Settings/Webhook","label":"Webhook","docId":"help/Settings/Webhook","unlisted":false},{"type":"link","href":"/docs/help/Settings/Preferences","label":"Preferences","docId":"help/Settings/Preferences","unlisted":false},{"type":"link","href":"/docs/help/Settings/Teams","label":"Manage Teams","docId":"help/Settings/Teams","unlisted":false},{"type":"link","href":"/docs/help/Settings/manage-users","label":"Manage users","docId":"help/Settings/manage-users","unlisted":false},{"type":"link","href":"/docs/help/Settings/disabledocumentid","label":"Disable DocumentId","docId":"help/Settings/disabledocumentid","unlisted":false},{"type":"link","href":"/docs/help/Settings/Custom-email-templates","label":"Custom email templates","docId":"help/Settings/Custom-email-templates","unlisted":false},{"type":"link","href":"/docs/help/Settings/SecurityManagement","label":"Security","docId":"help/Settings/SecurityManagement","unlisted":false}],"href":"/docs/category/settings"},{"type":"category","label":"User Menu","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/docs/help/User Menu/Profile","label":"Profile","docId":"help/User Menu/Profile","unlisted":false},{"type":"category","label":"Console","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/docs/help/User Menu/Console/analystics","label":"Analytics","docId":"help/User Menu/Console/analystics","unlisted":false},{"type":"link","href":"/docs/help/User Menu/Console/general","label":"General","docId":"help/User Menu/Console/general","unlisted":false},{"type":"link","href":"/docs/help/User Menu/Console/branding","label":"Branding","docId":"help/User Menu/Console/branding","unlisted":false},{"type":"link","href":"/docs/help/User Menu/Console/globalSMTP","label":"Global SMTP","docId":"help/User Menu/Console/globalSMTP","unlisted":false},{"type":"link","href":"/docs/help/User Menu/Console/emails","label":"Mail","docId":"help/User Menu/Console/emails","unlisted":false},{"type":"link","href":"/docs/help/User Menu/Console/custom_filestorage","label":"Custom File Storage","docId":"help/User Menu/Console/custom_filestorage","unlisted":false},{"type":"link","href":"/docs/help/User Menu/Console/signing_certificate","label":"Custom Signing Certificate","docId":"help/User Menu/Console/signing_certificate","unlisted":false},{"type":"link","href":"/docs/help/User Menu/Console/organizations","label":"Organizations","docId":"help/User Menu/Console/organizations","unlisted":false},{"type":"link","href":"/docs/help/User Menu/Console/orgadmin","label":"Org Admins","docId":"help/User Menu/Console/orgadmin","unlisted":false}],"href":"/docs/category/console"}],"href":"/docs/category/user-menu"},{"type":"category","label":"FAQs","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/docs/help/FAQs/","label":"Why is there no dropdown list when I sign a document myself?","docId":"help/FAQs/FAQs","unlisted":false},{"type":"link","href":"/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements","label":"Why am I getting \'Ensure this field is accurately filled and meets all requirements\'?","docId":"help/FAQs/Ensure this field is accurately filled and meets all requirements","unlisted":false},{"type":"link","href":"/docs/help/FAQs/Credit-Deductions","label":"Credit-Deductions","docId":"help/FAQs/Credit-Deductions","unlisted":false},{"type":"link","href":"/docs/help/FAQs/Max File Upload Size","label":"Max File Upload Size","docId":"help/FAQs/Max File Upload Size","unlisted":false},{"type":"link","href":"/docs/help/FAQs/User Deletion","label":"User Deletion","docId":"help/FAQs/User Deletion","unlisted":false}],"href":"/docs/category/faqs"}],"selfhostSidebar":[{"type":"link","href":"/docs/self-host/intro","label":"Self-Hosting OpenSign","docId":"self-host/intro","unlisted":false},{"type":"category","label":"Docker","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/docs/self-host/docker/run-locally","label":"Self-host OpenSign\u2122 with Docker on Linux/MacOS/Windows","docId":"self-host/docker/run-locally","unlisted":false},{"type":"link","href":"/docs/self-host/docker/upgrade-deployment","label":"OpenSign\u2122 Self-Hosted \'Upgrade Deployment\' Guide Using Docker on Linux, macOS, or Windows","docId":"self-host/docker/upgrade-deployment","unlisted":false}],"href":"/docs/category/docker"},{"type":"category","label":"Cloud Storage","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/docs/self-host/cloud-storage/s3","label":"AWS S3","docId":"self-host/cloud-storage/s3","unlisted":false}],"href":"/docs/category/cloud-storage"},{"type":"category","label":"Guides","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/docs/self-host/guides/azure-vm-setup","label":"OpenSign Deployment Guide on Azure VM via command-line","docId":"self-host/guides/azure-vm-setup","unlisted":false},{"type":"link","href":"/docs/self-host/guides/env-variables","label":"ENV variables which are used to setup OpenSign\u2122 with Docker on Localhost","docId":"self-host/guides/env-variables","unlisted":false},{"type":"link","href":"/docs/self-host/guides/how-to-generate-self-signed-document-signing-certificate","label":"How to generate self-signed document signing certificate?","docId":"self-host/guides/how-to-generate-self-signed-document-signing-certificate","unlisted":false},{"type":"link","href":"/docs/self-host/guides/upgrade-to-v2.1.0","label":"How to upgrade self-hosted OpenSign to v2.1.0?","docId":"self-host/guides/upgrade-to-v2.1.0","unlisted":false}],"href":"/docs/category/guides"},{"type":"category","label":"One-click-Install","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/docs/self-host/One-click-Install/DigitalOcean","label":"Digital Ocean","docId":"self-host/One-click-Install/DigitalOcean","unlisted":false}]}],"contributeSidebar":[{"type":"link","href":"/docs/contribute/CODE_OF_CONDUCT","label":"Code of conduct","docId":"contribute/CODE_OF_CONDUCT","unlisted":false},{"type":"link","href":"/docs/contribute/intro","label":"Contributing to OpenSign","docId":"contribute/intro","unlisted":false},{"type":"link","href":"/docs/contribute/INSTALLATION","label":"Installation instructions","docId":"contribute/INSTALLATION","unlisted":false},{"type":"link","href":"/docs/contribute/COMMUNITY","label":"Community at OpenSign\u2122","docId":"contribute/COMMUNITY","unlisted":false},{"type":"link","href":"/docs/contribute/REPORTING_GUIDELINES","label":"OpenSign\u2122 Reporting Guidelines","docId":"contribute/REPORTING_GUIDELINES","unlisted":false}],"apiSidebar":[{"type":"category","label":"v1.2","collapsed":false,"items":[{"type":"link","href":"/docs/API-docs/v1.2/opensign-api-v-1-2","label":"Introduction","docId":"API-docs/v1.2/opensign-api-v-1-2","unlisted":false},{"type":"category","label":"User","items":[{"type":"link","href":"/docs/API-docs/v1.2/get-user","label":"Get your account details","className":"get api-method","docId":"API-docs/v1.2/get-user","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/getcredits","label":"Get your API credits","className":"get api-method","docId":"API-docs/v1.2/getcredits","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Contacts","items":[{"type":"link","href":"/docs/API-docs/v1.2/createcontact","label":"Create Contact","className":"post api-method","docId":"API-docs/v1.2/createcontact","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/getcontact","label":"Get Contact","className":"get api-method","docId":"API-docs/v1.2/getcontact","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/deletecontact","label":"Delete Contact","className":"delete api-method","docId":"API-docs/v1.2/deletecontact","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/contactlist","label":"Get Contact list","className":"get api-method","docId":"API-docs/v1.2/contactlist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Documents","items":[{"type":"link","href":"/docs/API-docs/v1.2/selfsign","label":"Self Sign","className":"post api-method","docId":"API-docs/v1.2/selfsign","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/draftdocument","label":"Draft Document","className":"post api-method","docId":"API-docs/v1.2/draftdocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/createdocument","label":"Create Document","className":"post api-method","docId":"API-docs/v1.2/createdocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/createdocumentwithtemplateid","label":"Create Document from Template","className":"post api-method","docId":"API-docs/v1.2/createdocumentwithtemplateid","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/getdocument","label":"Get Document","className":"get api-method","docId":"API-docs/v1.2/getdocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/update-document","label":"Update Document","className":"put api-method","docId":"API-docs/v1.2/update-document","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/revokedocument","label":"Revoke Document","className":"post api-method","docId":"API-docs/v1.2/revokedocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/deletedocument","label":"Delete Document","className":"delete api-method","docId":"API-docs/v1.2/deletedocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/getdocumentlist","label":"Get Document list from status","className":"get api-method","docId":"API-docs/v1.2/getdocumentlist","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/resendrequestmail","label":"Resend request mail","className":"post api-method","docId":"API-docs/v1.2/resendrequestmail","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/getsignerips","label":"Get Signer IPs","className":"get api-method","docId":"API-docs/v1.2/getsignerips","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/getformdata","label":"Get Formdata","className":"get api-method","docId":"API-docs/v1.2/getformdata","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/getsigninglinks","label":"Get Signing Links","className":"get api-method","docId":"API-docs/v1.2/getsigninglinks","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Templates","items":[{"type":"link","href":"/docs/API-docs/v1.2/drafttemplate","label":"Draft Template","className":"post api-method","docId":"API-docs/v1.2/drafttemplate","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/createtemplate","label":"Create Template","className":"post api-method","docId":"API-docs/v1.2/createtemplate","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/publictemplate","label":"Public Template","className":"post api-method","docId":"API-docs/v1.2/publictemplate","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/get-template","label":"Get Template","className":"get api-method","docId":"API-docs/v1.2/get-template","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/update-template","label":"Update Template","className":"put api-method","docId":"API-docs/v1.2/update-template","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/delete-template","label":"Delete Template","className":"delete api-method","docId":"API-docs/v1.2/delete-template","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/gettemplatelist","label":"Get Template list","className":"get api-method","docId":"API-docs/v1.2/gettemplatelist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Webhook","items":[{"type":"link","href":"/docs/API-docs/v1.2/get-webhook","label":"Get Webhook","className":"get api-method","docId":"API-docs/v1.2/get-webhook","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/save-update-webhook","label":"Save or Update Webhook","className":"post api-method","docId":"API-docs/v1.2/save-update-webhook","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/delete-webhook","label":"Delete Webhook","className":"delete api-method","docId":"API-docs/v1.2/delete-webhook","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Folder","items":[{"type":"link","href":"/docs/API-docs/v1.2/createfolder","label":"Create Folder","className":"post api-method","docId":"API-docs/v1.2/createfolder","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/getfolder","label":"Get Folder","className":"get api-method","docId":"API-docs/v1.2/getfolder","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/updatefolder","label":"Update Folder","className":"put api-method","docId":"API-docs/v1.2/updatefolder","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/deletefolder","label":"Delete Folder","className":"delete api-method","docId":"API-docs/v1.2/deletefolder","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.2/folderlist","label":"Get folder list","className":"get api-method","docId":"API-docs/v1.2/folderlist","unlisted":false}],"collapsed":true,"collapsible":true}],"collapsible":true,"href":"/docs/API-docs/v1.2"},{"type":"category","label":"v1.1","collapsed":false,"items":[{"type":"link","href":"/docs/API-docs/v1.1/opensign-api-v-1-1","label":"Introduction","docId":"API-docs/v1.1/opensign-api-v-1-1","unlisted":false},{"type":"category","label":"User","items":[{"type":"link","href":"/docs/API-docs/v1.1/get-user","label":"Get your account details","className":"get api-method","docId":"API-docs/v1.1/get-user","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/getcredits","label":"Get your API credits","className":"get api-method","docId":"API-docs/v1.1/getcredits","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Contacts","items":[{"type":"link","href":"/docs/API-docs/v1.1/createcontact","label":"Create Contact","className":"post api-method","docId":"API-docs/v1.1/createcontact","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/getcontact","label":"Get Contact","className":"get api-method","docId":"API-docs/v1.1/getcontact","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/deletecontact","label":"Delete Contact","className":"delete api-method","docId":"API-docs/v1.1/deletecontact","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/contactlist","label":"Get Contact list","className":"get api-method","docId":"API-docs/v1.1/contactlist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Documents","items":[{"type":"link","href":"/docs/API-docs/v1.1/selfsign","label":"Self Sign","className":"post api-method","docId":"API-docs/v1.1/selfsign","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/draftdocument","label":"Draft Document","className":"post api-method","docId":"API-docs/v1.1/draftdocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/createdocument","label":"Create Document","className":"post api-method","docId":"API-docs/v1.1/createdocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/createdocumentwithtemplateid","label":"Create Document from Template","className":"post api-method","docId":"API-docs/v1.1/createdocumentwithtemplateid","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/getdocument","label":"Get Document","className":"get api-method","docId":"API-docs/v1.1/getdocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/update-document","label":"Update Document","className":"put api-method","docId":"API-docs/v1.1/update-document","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/revokedocument","label":"Revoke Document","className":"post api-method","docId":"API-docs/v1.1/revokedocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/deletedocument","label":"Delete Document","className":"delete api-method","docId":"API-docs/v1.1/deletedocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/getdocumentlist","label":"Get Document list from status","className":"get api-method","docId":"API-docs/v1.1/getdocumentlist","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/resendrequestmail","label":"Resend request mail","className":"post api-method","docId":"API-docs/v1.1/resendrequestmail","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/getsignerips","label":"Get Signer IPs","className":"get api-method","docId":"API-docs/v1.1/getsignerips","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/getformdata","label":"Get Formdata","className":"get api-method","docId":"API-docs/v1.1/getformdata","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/getsigninglinks","label":"Get Signing Links","className":"get api-method","docId":"API-docs/v1.1/getsigninglinks","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Templates","items":[{"type":"link","href":"/docs/API-docs/v1.1/drafttemplate","label":"Draft Template","className":"post api-method","docId":"API-docs/v1.1/drafttemplate","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/createtemplate","label":"Create Template","className":"post api-method","docId":"API-docs/v1.1/createtemplate","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/publictemplate","label":"Public Template","className":"post api-method","docId":"API-docs/v1.1/publictemplate","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/get-template","label":"Get Template","className":"get api-method","docId":"API-docs/v1.1/get-template","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/update-template","label":"Update Template","className":"put api-method","docId":"API-docs/v1.1/update-template","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/delete-template","label":"Delete Template","className":"delete api-method","docId":"API-docs/v1.1/delete-template","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/gettemplatelist","label":"Get Template list","className":"get api-method","docId":"API-docs/v1.1/gettemplatelist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Webhook","items":[{"type":"link","href":"/docs/API-docs/v1.1/get-webhook","label":"Get Webhook","className":"get api-method","docId":"API-docs/v1.1/get-webhook","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/save-update-webhook","label":"Save or Update Webhook","className":"post api-method","docId":"API-docs/v1.1/save-update-webhook","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/delete-webhook","label":"Delete Webhook","className":"delete api-method","docId":"API-docs/v1.1/delete-webhook","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Folder","items":[{"type":"link","href":"/docs/API-docs/v1.1/createfolder","label":"Create Folder","className":"post api-method","docId":"API-docs/v1.1/createfolder","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/getfolder","label":"Get Folder","className":"get api-method","docId":"API-docs/v1.1/getfolder","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/updatefolder","label":"Update Folder","className":"put api-method","docId":"API-docs/v1.1/updatefolder","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/deletefolder","label":"Delete Folder","className":"delete api-method","docId":"API-docs/v1.1/deletefolder","unlisted":false},{"type":"link","href":"/docs/API-docs/v1.1/folderlist","label":"Get folder list","className":"get api-method","docId":"API-docs/v1.1/folderlist","unlisted":false}],"collapsed":true,"collapsible":true}],"collapsible":true,"href":"/docs/API-docs/v1.1"},{"type":"category","label":"v1","collapsed":true,"items":[{"type":"link","href":"/docs/API-docs/v1/opensign-api-v-1","label":"Introduction","docId":"API-docs/v1/opensign-api-v-1","unlisted":false},{"type":"category","label":"User","items":[{"type":"link","href":"/docs/API-docs/v1/get-user","label":"Get your account details","className":"get api-method","docId":"API-docs/v1/get-user","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Contacts","items":[{"type":"link","href":"/docs/API-docs/v1/createcontact","label":"Create Contact","className":"post api-method","docId":"API-docs/v1/createcontact","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/getcontact","label":"Get Contact","className":"get api-method","docId":"API-docs/v1/getcontact","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/deletecontact","label":"Delete Contact","className":"delete api-method","docId":"API-docs/v1/deletecontact","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/contactlist","label":"Get Contact list","className":"get api-method","docId":"API-docs/v1/contactlist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Documents","items":[{"type":"link","href":"/docs/API-docs/v1/selfsign","label":"Self Sign","className":"post api-method","docId":"API-docs/v1/selfsign","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/draftdocument","label":"Draft Document","className":"post api-method","docId":"API-docs/v1/draftdocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/createdocument","label":"Create Document","className":"post api-method","docId":"API-docs/v1/createdocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/createdocumentwithtemplateid","label":"Create Document from Template","className":"post api-method","docId":"API-docs/v1/createdocumentwithtemplateid","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/getdocument","label":"Get Document","className":"get api-method","docId":"API-docs/v1/getdocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/update-document","label":"Update Document","className":"put api-method","docId":"API-docs/v1/update-document","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/revokedocument","label":"Revoke Document","className":"post api-method","docId":"API-docs/v1/revokedocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/deletedocument","label":"Delete Document","className":"delete api-method","docId":"API-docs/v1/deletedocument","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/getdocumentlist","label":"Get Document list from status","className":"get api-method","docId":"API-docs/v1/getdocumentlist","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/resendrequestmail","label":"Resend request mail","className":"post api-method","docId":"API-docs/v1/resendrequestmail","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Templates","items":[{"type":"link","href":"/docs/API-docs/v1/drafttemplate","label":"Draft Template","className":"post api-method","docId":"API-docs/v1/drafttemplate","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/createtemplate","label":"Create Template","className":"post api-method","docId":"API-docs/v1/createtemplate","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/get-template","label":"Get Template","className":"get api-method","docId":"API-docs/v1/get-template","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/update-template","label":"Update Template","className":"put api-method","docId":"API-docs/v1/update-template","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/delete-template","label":"Delete Template","className":"delete api-method","docId":"API-docs/v1/delete-template","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/gettemplatelist","label":"Get Template list","className":"get api-method","docId":"API-docs/v1/gettemplatelist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Webhook","items":[{"type":"link","href":"/docs/API-docs/v1/get-webhook","label":"Get Webhook","className":"get api-method","docId":"API-docs/v1/get-webhook","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/save-update-webhook","label":"Save or Update Webhook","className":"post api-method","docId":"API-docs/v1/save-update-webhook","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/delete-webhook","label":"Delete Webhook","className":"delete api-method","docId":"API-docs/v1/delete-webhook","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Folder","items":[{"type":"link","href":"/docs/API-docs/v1/createfolder","label":"Create Folder","className":"post api-method","docId":"API-docs/v1/createfolder","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/getfolder","label":"Get Folder","className":"get api-method","docId":"API-docs/v1/getfolder","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/updatefolder","label":"Update Folder","className":"put api-method","docId":"API-docs/v1/updatefolder","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/deletefolder","label":"Delete Folder","className":"delete api-method","docId":"API-docs/v1/deletefolder","unlisted":false},{"type":"link","href":"/docs/API-docs/v1/folderlist","label":"Get folder list","className":"get api-method","docId":"API-docs/v1/folderlist","unlisted":false}],"collapsed":true,"collapsible":true}],"collapsible":true,"href":"/docs/API-docs/v1"}]},"docs":{"API-docs/api-intro":{"id":"API-docs/api-intro","title":"OpenSign APIs","description":"Welcome to the OpenSign API. Choose a version from the sidebar:"},"API-docs/v1.1/contactlist":{"id":"API-docs/v1.1/contactlist","title":"Get Contact list","description":"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.","sidebar":"apiSidebar"},"API-docs/v1.1/createcontact":{"id":"API-docs/v1.1/createcontact","title":"Create Contact","description":"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.","sidebar":"apiSidebar"},"API-docs/v1.1/createdocument":{"id":"API-docs/v1.1/createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file.","sidebar":"apiSidebar"},"API-docs/v1.1/createdocumentwithtemplateid":{"id":"API-docs/v1.1/createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","sidebar":"apiSidebar"},"API-docs/v1.1/createfolder":{"id":"API-docs/v1.1/createfolder","title":"Create Folder","description":"The Create Folder API allows you to create folder.","sidebar":"apiSidebar"},"API-docs/v1.1/createtemplate":{"id":"API-docs/v1.1/createtemplate","title":"Create Template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.","sidebar":"apiSidebar"},"API-docs/v1.1/delete-template":{"id":"API-docs/v1.1/delete-template","title":"Delete Template","description":"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed","sidebar":"apiSidebar"},"API-docs/v1.1/delete-webhook":{"id":"API-docs/v1.1/delete-webhook","title":"Delete Webhook","description":"The Delete Webhook API allow you to delete webhook url","sidebar":"apiSidebar"},"API-docs/v1.1/deletecontact":{"id":"API-docs/v1.1/deletecontact","title":"Delete Contact","description":"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact\'s information, this API makes it easy to delete their record.","sidebar":"apiSidebar"},"API-docs/v1.1/deletedocument":{"id":"API-docs/v1.1/deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","sidebar":"apiSidebar"},"API-docs/v1.1/deletefolder":{"id":"API-docs/v1.1/deletefolder","title":"Delete Folder","description":"The delete Folder API allows you to delete folder.","sidebar":"apiSidebar"},"API-docs/v1.1/draftdocument":{"id":"API-docs/v1.1/draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","sidebar":"apiSidebar"},"API-docs/v1.1/drafttemplate":{"id":"API-docs/v1.1/drafttemplate","title":"Draft Template","description":"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.","sidebar":"apiSidebar"},"API-docs/v1.1/folderlist":{"id":"API-docs/v1.1/folderlist","title":"Get folder list","description":"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId","sidebar":"apiSidebar"},"API-docs/v1.1/get-template":{"id":"API-docs/v1.1/get-template","title":"Get Template","description":"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.","sidebar":"apiSidebar"},"API-docs/v1.1/get-user":{"id":"API-docs/v1.1/get-user","title":"Get your account details","description":"The Get User API enables you to get your own account details.","sidebar":"apiSidebar"},"API-docs/v1.1/get-webhook":{"id":"API-docs/v1.1/get-webhook","title":"Get Webhook","description":"The Get Webhook API allow you to get webhook url","sidebar":"apiSidebar"},"API-docs/v1.1/getcontact":{"id":"API-docs/v1.1/getcontact","title":"Get Contact","description":"The Get Contact API allows you to retrieve details about a specific contact.","sidebar":"apiSidebar"},"API-docs/v1.1/getcredits":{"id":"API-docs/v1.1/getcredits","title":"Get your API credits","description":"The Get Credits API returns details about the credits available to your account:","sidebar":"apiSidebar"},"API-docs/v1.1/getdocument":{"id":"API-docs/v1.1/getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","sidebar":"apiSidebar"},"API-docs/v1.1/getdocumentlist":{"id":"API-docs/v1.1/getdocumentlist","title":"Get Document list from status","description":"### Document Types:","sidebar":"apiSidebar"},"API-docs/v1.1/getfolder":{"id":"API-docs/v1.1/getfolder","title":"Get Folder","description":"The Get Folder API allows you to retrieve details about a specific folder.","sidebar":"apiSidebar"},"API-docs/v1.1/getformdata":{"id":"API-docs/v1.1/getformdata","title":"Get Formdata","description":"The Get Formdata API enables you to retrieve widget data filled by signers who signed the document.","sidebar":"apiSidebar"},"API-docs/v1.1/getsignerips":{"id":"API-docs/v1.1/getsignerips","title":"Get Signer IPs","description":"The Get Signer IPs API enables you to retrieve IPs of signers who signed the document.","sidebar":"apiSidebar"},"API-docs/v1.1/getsigninglinks":{"id":"API-docs/v1.1/getsigninglinks","title":"Get Signing Links","description":"The Get Signing Links API enables you to retrieve signing urls of signers for the document.","sidebar":"apiSidebar"},"API-docs/v1.1/gettemplatelist":{"id":"API-docs/v1.1/gettemplatelist","title":"Get Template list","description":"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.","sidebar":"apiSidebar"},"API-docs/v1.1/intro":{"id":"API-docs/v1.1/intro","title":"Overview","description":"OpenSign\u2122 API offers a robust suite of functionalities for digital document management and electronic signatures. Designed to cater to a wide array of business needs, the API facilitates the creation, signing, and management of digital documents. It ensures secure and efficient processes, complying with international legal standards for electronic signatures."},"API-docs/v1.1/opensign-api-v-1-1":{"id":"API-docs/v1.1/opensign-api-v-1-1","title":"OpenSign API v1.1","description":"Welcome to the **OpenSign\u2122 API v1.1** documentation.","sidebar":"apiSidebar"},"API-docs/v1.1/publictemplate":{"id":"API-docs/v1.1/publictemplate","title":"Public Template","description":"The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique **template_id** and a **public_url**. The **public_url** is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing.","sidebar":"apiSidebar"},"API-docs/v1.1/resendrequestmail":{"id":"API-docs/v1.1/resendrequestmail","title":"Resend request mail","description":"Resend request mail to user for signing document.","sidebar":"apiSidebar"},"API-docs/v1.1/revokedocument":{"id":"API-docs/v1.1/revokedocument","title":"Revoke Document","description":"The Revoke document API allows you to revoke specific document from your documents.","sidebar":"apiSidebar"},"API-docs/v1.1/save-update-webhook":{"id":"API-docs/v1.1/save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.","sidebar":"apiSidebar"},"API-docs/v1.1/selfsign":{"id":"API-docs/v1.1/selfsign","title":"Self Sign","description":"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.","sidebar":"apiSidebar"},"API-docs/v1.1/update-document":{"id":"API-docs/v1.1/update-document","title":"Update Document","description":"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.","sidebar":"apiSidebar"},"API-docs/v1.1/update-template":{"id":"API-docs/v1.1/update-template","title":"Update Template","description":"The Update Template API enables you to modify and update the details of a specific template.","sidebar":"apiSidebar"},"API-docs/v1.1/updatefolder":{"id":"API-docs/v1.1/updatefolder","title":"Update Folder","description":"The Update Folder API allows you to uodate folder name as well as parentFolderId.","sidebar":"apiSidebar"},"API-docs/v1.2/contactlist":{"id":"API-docs/v1.2/contactlist","title":"Get Contact list","description":"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.","sidebar":"apiSidebar"},"API-docs/v1.2/createcontact":{"id":"API-docs/v1.2/createcontact","title":"Create Contact","description":"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.","sidebar":"apiSidebar"},"API-docs/v1.2/createdocument":{"id":"API-docs/v1.2/createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file.","sidebar":"apiSidebar"},"API-docs/v1.2/createdocumentwithtemplateid":{"id":"API-docs/v1.2/createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","sidebar":"apiSidebar"},"API-docs/v1.2/createfolder":{"id":"API-docs/v1.2/createfolder","title":"Create Folder","description":"The Create Folder API allows you to create folder.","sidebar":"apiSidebar"},"API-docs/v1.2/createtemplate":{"id":"API-docs/v1.2/createtemplate","title":"Create Template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.","sidebar":"apiSidebar"},"API-docs/v1.2/delete-template":{"id":"API-docs/v1.2/delete-template","title":"Delete Template","description":"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed","sidebar":"apiSidebar"},"API-docs/v1.2/delete-webhook":{"id":"API-docs/v1.2/delete-webhook","title":"Delete Webhook","description":"The Delete Webhook API allow you to delete webhook url","sidebar":"apiSidebar"},"API-docs/v1.2/deletecontact":{"id":"API-docs/v1.2/deletecontact","title":"Delete Contact","description":"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact\'s information, this API makes it easy to delete their record.","sidebar":"apiSidebar"},"API-docs/v1.2/deletedocument":{"id":"API-docs/v1.2/deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","sidebar":"apiSidebar"},"API-docs/v1.2/deletefolder":{"id":"API-docs/v1.2/deletefolder","title":"Delete Folder","description":"The delete Folder API allows you to delete folder.","sidebar":"apiSidebar"},"API-docs/v1.2/draftdocument":{"id":"API-docs/v1.2/draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","sidebar":"apiSidebar"},"API-docs/v1.2/drafttemplate":{"id":"API-docs/v1.2/drafttemplate","title":"Draft Template","description":"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.","sidebar":"apiSidebar"},"API-docs/v1.2/folderlist":{"id":"API-docs/v1.2/folderlist","title":"Get folder list","description":"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId","sidebar":"apiSidebar"},"API-docs/v1.2/get-template":{"id":"API-docs/v1.2/get-template","title":"Get Template","description":"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.","sidebar":"apiSidebar"},"API-docs/v1.2/get-user":{"id":"API-docs/v1.2/get-user","title":"Get your account details","description":"The Get User API enables you to get your own account details.","sidebar":"apiSidebar"},"API-docs/v1.2/get-webhook":{"id":"API-docs/v1.2/get-webhook","title":"Get Webhook","description":"The Get Webhook API allow you to get webhook url","sidebar":"apiSidebar"},"API-docs/v1.2/getcontact":{"id":"API-docs/v1.2/getcontact","title":"Get Contact","description":"The Get Contact API allows you to retrieve details about a specific contact.","sidebar":"apiSidebar"},"API-docs/v1.2/getcredits":{"id":"API-docs/v1.2/getcredits","title":"Get your API credits","description":"The Get Credits API returns details about the credits available to your account:","sidebar":"apiSidebar"},"API-docs/v1.2/getdocument":{"id":"API-docs/v1.2/getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","sidebar":"apiSidebar"},"API-docs/v1.2/getdocumentlist":{"id":"API-docs/v1.2/getdocumentlist","title":"Get Document list from status","description":"### Document Types:","sidebar":"apiSidebar"},"API-docs/v1.2/getfolder":{"id":"API-docs/v1.2/getfolder","title":"Get Folder","description":"The Get Folder API allows you to retrieve details about a specific folder.","sidebar":"apiSidebar"},"API-docs/v1.2/getformdata":{"id":"API-docs/v1.2/getformdata","title":"Get Formdata","description":"The Get Formdata API enables you to retrieve widget data filled by signers who signed the document.","sidebar":"apiSidebar"},"API-docs/v1.2/getsignerips":{"id":"API-docs/v1.2/getsignerips","title":"Get Signer IPs","description":"The Get Signer IPs API enables you to retrieve IPs of signers who signed the document.","sidebar":"apiSidebar"},"API-docs/v1.2/getsigninglinks":{"id":"API-docs/v1.2/getsigninglinks","title":"Get Signing Links","description":"The Get Signing Links API enables you to retrieve signing urls of signers for the document.","sidebar":"apiSidebar"},"API-docs/v1.2/gettemplatelist":{"id":"API-docs/v1.2/gettemplatelist","title":"Get Template list","description":"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.","sidebar":"apiSidebar"},"API-docs/v1.2/intro":{"id":"API-docs/v1.2/intro","title":"Overview","description":"OpenSign\u2122 API v1.2 \u2014 the open-source DocuSign alternative, built for developers and trusted by enterprises."},"API-docs/v1.2/opensign-api-v-1-2":{"id":"API-docs/v1.2/opensign-api-v-1-2","title":"OpenSign API v1.2","description":"# OpenSign\u2122 API v1.2","sidebar":"apiSidebar"},"API-docs/v1.2/publictemplate":{"id":"API-docs/v1.2/publictemplate","title":"Public Template","description":"The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique **template_id** and a **public_url**. The **public_url** is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing.","sidebar":"apiSidebar"},"API-docs/v1.2/resendrequestmail":{"id":"API-docs/v1.2/resendrequestmail","title":"Resend request mail","description":"Resend request mail to user for signing document.","sidebar":"apiSidebar"},"API-docs/v1.2/revokedocument":{"id":"API-docs/v1.2/revokedocument","title":"Revoke Document","description":"The Revoke document API allows you to revoke specific document from your documents.","sidebar":"apiSidebar"},"API-docs/v1.2/save-update-webhook":{"id":"API-docs/v1.2/save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.","sidebar":"apiSidebar"},"API-docs/v1.2/selfsign":{"id":"API-docs/v1.2/selfsign","title":"Self Sign","description":"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.","sidebar":"apiSidebar"},"API-docs/v1.2/update-document":{"id":"API-docs/v1.2/update-document","title":"Update Document","description":"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.","sidebar":"apiSidebar"},"API-docs/v1.2/update-template":{"id":"API-docs/v1.2/update-template","title":"Update Template","description":"The Update Template API enables you to modify and update the details of a specific template.","sidebar":"apiSidebar"},"API-docs/v1.2/updatefolder":{"id":"API-docs/v1.2/updatefolder","title":"Update Folder","description":"The Update Folder API allows you to uodate folder name as well as parentFolderId.","sidebar":"apiSidebar"},"API-docs/v1/contactlist":{"id":"API-docs/v1/contactlist","title":"Get Contact list","description":"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.","sidebar":"apiSidebar"},"API-docs/v1/createcontact":{"id":"API-docs/v1/createcontact","title":"Create Contact","description":"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.","sidebar":"apiSidebar"},"API-docs/v1/createdocument":{"id":"API-docs/v1/createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file.","sidebar":"apiSidebar"},"API-docs/v1/createdocumentwithtemplateid":{"id":"API-docs/v1/createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","sidebar":"apiSidebar"},"API-docs/v1/createfolder":{"id":"API-docs/v1/createfolder","title":"Create Folder","description":"The Create Folder API allows you to create folder.","sidebar":"apiSidebar"},"API-docs/v1/createtemplate":{"id":"API-docs/v1/createtemplate","title":"Create Template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.","sidebar":"apiSidebar"},"API-docs/v1/delete-template":{"id":"API-docs/v1/delete-template","title":"Delete Template","description":"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed","sidebar":"apiSidebar"},"API-docs/v1/delete-webhook":{"id":"API-docs/v1/delete-webhook","title":"Delete Webhook","description":"The Delete Webhook API allow you to delete webhook url","sidebar":"apiSidebar"},"API-docs/v1/deletecontact":{"id":"API-docs/v1/deletecontact","title":"Delete Contact","description":"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact\'s information, this API makes it easy to delete their record.","sidebar":"apiSidebar"},"API-docs/v1/deletedocument":{"id":"API-docs/v1/deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","sidebar":"apiSidebar"},"API-docs/v1/deletefolder":{"id":"API-docs/v1/deletefolder","title":"Delete Folder","description":"The delete Folder API allows you to delete folder.","sidebar":"apiSidebar"},"API-docs/v1/draftdocument":{"id":"API-docs/v1/draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","sidebar":"apiSidebar"},"API-docs/v1/drafttemplate":{"id":"API-docs/v1/drafttemplate","title":"Draft Template","description":"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.","sidebar":"apiSidebar"},"API-docs/v1/folderlist":{"id":"API-docs/v1/folderlist","title":"Get folder list","description":"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId","sidebar":"apiSidebar"},"API-docs/v1/get-template":{"id":"API-docs/v1/get-template","title":"Get Template","description":"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.","sidebar":"apiSidebar"},"API-docs/v1/get-user":{"id":"API-docs/v1/get-user","title":"Get your account details","description":"The Get User API enables you to get your own account details.","sidebar":"apiSidebar"},"API-docs/v1/get-webhook":{"id":"API-docs/v1/get-webhook","title":"Get Webhook","description":"The Get Webhook API allow you to get webhook url","sidebar":"apiSidebar"},"API-docs/v1/getcontact":{"id":"API-docs/v1/getcontact","title":"Get Contact","description":"The Get Contact API allows you to retrieve details about a specific contact.","sidebar":"apiSidebar"},"API-docs/v1/getdocument":{"id":"API-docs/v1/getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","sidebar":"apiSidebar"},"API-docs/v1/getdocumentlist":{"id":"API-docs/v1/getdocumentlist","title":"Get Document list from status","description":"### Document Types:","sidebar":"apiSidebar"},"API-docs/v1/getfolder":{"id":"API-docs/v1/getfolder","title":"Get Folder","description":"The Get Folder API allows you to retrieve details about a specific folder.","sidebar":"apiSidebar"},"API-docs/v1/gettemplatelist":{"id":"API-docs/v1/gettemplatelist","title":"Get Template list","description":"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.","sidebar":"apiSidebar"},"API-docs/v1/intro":{"id":"API-docs/v1/intro","title":"Overview","description":"OpenSign\u2122 API offers a robust suite of functionalities for digital document management and electronic signatures. Designed to cater to a wide array of business needs, the API facilitates the creation, signing, and management of digital documents. It ensures secure and efficient processes, complying with international legal standards for electronic signatures."},"API-docs/v1/opensign-api-v-1":{"id":"API-docs/v1/opensign-api-v-1","title":"OpenSign API v1","description":"Welcome to the OpenSign\u2122 API documentation!","sidebar":"apiSidebar"},"API-docs/v1/resendrequestmail":{"id":"API-docs/v1/resendrequestmail","title":"Resend request mail","description":"Resend request mail to user for signing document.","sidebar":"apiSidebar"},"API-docs/v1/revokedocument":{"id":"API-docs/v1/revokedocument","title":"Revoke Document","description":"The Revoke document API allows you to revoke specific document from your documents.","sidebar":"apiSidebar"},"API-docs/v1/save-update-webhook":{"id":"API-docs/v1/save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.","sidebar":"apiSidebar"},"API-docs/v1/selfsign":{"id":"API-docs/v1/selfsign","title":"Self Sign","description":"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.","sidebar":"apiSidebar"},"API-docs/v1/update-document":{"id":"API-docs/v1/update-document","title":"Update Document","description":"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.","sidebar":"apiSidebar"},"API-docs/v1/update-template":{"id":"API-docs/v1/update-template","title":"Update Template","description":"The Update Template API enables you to modify and update the details of a specific template.","sidebar":"apiSidebar"},"API-docs/v1/updatefolder":{"id":"API-docs/v1/updatefolder","title":"Update Folder","description":"The Update Folder API allows you to uodate folder name as well as parentFolderId.","sidebar":"apiSidebar"},"contribute/CODE_OF_CONDUCT":{"id":"contribute/CODE_OF_CONDUCT","title":"Code of conduct","description":"1. Introduction","sidebar":"contributeSidebar"},"contribute/COMMUNITY":{"id":"contribute/COMMUNITY","title":"Community at OpenSign\u2122","description":"Welcome to the OpenSign\u2122 Community page! OpenSign\u2122 is dedicated to fostering a vibrant and engaging community where members can connect, share ideas and collaborate on the OpenSign\u2122 project. This page provides links to our active social media platforms and community channels, offering various ways for you to join and participate in the OpenSign\u2122 community. Whether you\'re looking for support, eager to contribute or just want to stay updated, you\'ll find a platform that suits your preference. Connect with us on Discord for real-time discussions, follow us on Twitter for the latest updates, engage with our professional network on LinkedIn or join our Facebook group for a broader community experience. Join us in our mission to develop OpenSign\u2122 as the premier open-source alternative to DocuSign.","sidebar":"contributeSidebar"},"contribute/INSTALLATION":{"id":"contribute/INSTALLATION","title":"Installation instructions","description":"You can use our app as a cloud version from OpenSignLabs","sidebar":"contributeSidebar"},"contribute/intro":{"id":"contribute/intro","title":"Contributing to OpenSign","description":"Hello there! Thank you for considering contributing to OpenSign, the open-source alternative to DocuSign. OpenSign is not just a project, but a community endeavor that aims to create a robust, user-friendly, and secure electronic signature solution. Your contributions, irrespective of their size, are valuable in making this vision a reality.","sidebar":"contributeSidebar"},"contribute/REPORTING_GUIDELINES":{"id":"contribute/REPORTING_GUIDELINES","title":"OpenSign\u2122 Reporting Guidelines","description":"This document provides guidelines for reporting issues, suggesting enhancements, and submitting pull requests to the OpenSign\u2122 GitHub repository. Adhering to these guidelines helps maintain the project\'s quality and efficiency.","sidebar":"contributeSidebar"},"help/FAQs/Credit-Deductions":{"id":"help/FAQs/Credit-Deductions","title":"Credit-Deductions","description":"1. When are Premium Credits deducted? Which actions use Premium Credits?","sidebar":"tutorialSidebar"},"help/FAQs/Ensure this field is accurately filled and meets all requirements":{"id":"help/FAQs/Ensure this field is accurately filled and meets all requirements","title":"Why am I getting \'Ensure this field is accurately filled and meets all requirements\'?","description":"This happens when you leave a field blank or when you don\u2019t enter correct values in the field, for example not entering email address in correct format.","sidebar":"tutorialSidebar"},"help/FAQs/FAQs":{"id":"help/FAQs/FAQs","title":"Why is there no dropdown list when I sign a document myself?","description":"The dropdown list field is available only when you request a signature from others or when you create a template. This is because dropdown lists function as temporary widgets, allowing the user to select one of multiple values. Once a signer selects a value from the dropdown, it is embedded into the document as text. When you sign a document yourself, OpenSign digitally signs it immediately upon clicking the finish button. Therefore, you can use the text widget to add the necessary text to the document.","sidebar":"tutorialSidebar"},"help/FAQs/Max File Upload Size":{"id":"help/FAQs/Max File Upload Size","title":"Max File Upload Size","description":"\u2753 What is the default maximum file size that can be uploaded to OpenSign?","sidebar":"tutorialSidebar"},"help/FAQs/User Deletion":{"id":"help/FAQs/User Deletion","title":"User Deletion","description":"\u2753 Who can delete users?","sidebar":"tutorialSidebar"},"help/intro":{"id":"help/intro","title":"Intro","description":"\ud83c\udf1fGet ready for an electrifying journey at OpenSign\u2122, the most incredibly documented open source document signing solution! \ud83d\ude80 This is your go-to spot for diving deep into everything OpenSign\u2122 has to offer. Whether you\u2019re just starting out or you\u2019re a seasoned pro eager to uncover even more cool features, we\u2019ve got you covered with the most awesome, top-notch guides and resources around. Get ready to make the most out of OpenSign\u2122 \ud83c\udf89\ud83d\udcda\ud83d\udd0d Your adventure in excellence starts here! \ud83c\udf08\u2728\ud83c\udf1f","sidebar":"tutorialSidebar"},"help/New-Document/edit-document-before-sending":{"id":"help/New-Document/edit-document-before-sending","title":"Editing Your Document Before Sending","description":"OpenSign\u2122 lets you polish your PDF before you send it out\u2014whether you\u2019re signing it yourself, requesting signatures, or saving it as a template. You get four core editing controls right in the preview:","sidebar":"tutorialSidebar"},"help/New-Document/enforce-email-verification":{"id":"help/New-Document/enforce-email-verification","title":"Enforce email OTP verification","description":"The \\"Enable OTP Verification\\" feature in OpenSign is designed to add an extra layer of security to the document-signing process by verifying the signer\u2019s email address. Here\u2019s an in-depth look at how it works, when to use it, and its impact on the signing process.","sidebar":"tutorialSidebar"},"help/New-Document/request-signatures":{"id":"help/New-Document/request-signatures","title":"Request signatures","description":"Interface Overview","sidebar":"tutorialSidebar"},"help/New-Document/sign-yourself":{"id":"help/New-Document/sign-yourself","title":"Sign your-self","description":"Interface Overview","sidebar":"tutorialSidebar"},"help/New-Document/widgets":{"id":"help/New-Document/widgets","title":"Widgets in OpenSign","description":"Widgets in OpenSign are interactive fields that you can place on your documents to collect information, signatures, or confirmations from recipients during the signing process.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/create-document":{"id":"help/OpenSign\u2122 Drive/create-document","title":"Create Docs & Folders","description":"OpenSign Drive offers a streamlined way to manage, sign, and request signatures on your important documents. Whether you\'re drafting an offer letter or storing signed agreements, organizing your documents effectively is crucial. Here\u2019s a step-by-step guide on how to create documents and folders in OpenSign Drive.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/list-grid-view":{"id":"help/OpenSign\u2122 Drive/list-grid-view","title":"Grid vs List view","description":"- Navigate to OpenSign drive using the main menu or clicking this link.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/organize-documents":{"id":"help/OpenSign\u2122 Drive/organize-documents","title":"OpenSign\u2122 Drive Interface Documentation","description":"Overview","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/rename-document":{"id":"help/OpenSign\u2122 Drive/rename-document","title":"Rename documents from OpenSign\u2122 Drive","description":"The OpenSign\u2122 Drive interface allows users to rename their documents efficiently.","sidebar":"tutorialSidebar"},"help/Reports/completed":{"id":"help/Reports/completed","title":"Completed","description":"---","sidebar":"tutorialSidebar"},"help/Reports/contactbook":{"id":"help/Reports/contactbook","title":"Contactbook","description":"The Contactbook report in OpenSign enables you to add and manage contacts.","sidebar":"tutorialSidebar"},"help/Reports/declined":{"id":"help/Reports/declined","title":"Declined","description":"The \\"Declined documents\\" report within OpenSign serves as a vital tool for managing and reviewing all declined documents that have been processed through the platform. This guide will walk you through the key features and functionalities of the \\"Declined documents\\" report, enabling you to efficiently navigate and manage your signed documents.","sidebar":"tutorialSidebar"},"help/Reports/drafts":{"id":"help/Reports/drafts","title":"Drafts","description":"The Draft documents section in OpenSign helps you manage all your in-progress documents easily. This feature allows you to save, review, and edit documents before sending them for signature. Here\'s a detailed overview of how to navigate and use the Draft Documents report effectively.","sidebar":"tutorialSidebar"},"help/Reports/expired":{"id":"help/Reports/expired","title":"Expired","description":"The Expired documents report in OpenSign allows you to manage and review documents that have reached their expiration date without being signed. This feature is essential for maintaining an organized record of inactive documents that may require follow-up or archival.","sidebar":"tutorialSidebar"},"help/Reports/in-progress":{"id":"help/Reports/in-progress","title":"In Progress","description":"The In-Progress documents report in OpenSign helps you monitor and manage documents that are currently in the signing process. This report enables you to monitor the status of your documents, manually share the document URL, track document progress, resend reminders, revoke access, or delete documents that are no longer required. Here\u2019s a detailed guide on how to use the In-Progress documents report effectively.","sidebar":"tutorialSidebar"},"help/Reports/need-your-sign":{"id":"help/Reports/need-your-sign","title":"Need your sign","description":"The \\"Need your sign\\" feature in OpenSign is designed to simplify the process of managing documents that require your signature. This guide will walk you through the various elements of the \\"Need your sign\\" report, helping you to efficiently navigate and complete your pending signing tasks.","sidebar":"tutorialSidebar"},"help/Settings/APIToken":{"id":"help/Settings/APIToken","title":"API Token","description":"To authenticate and use OpenSign API endpoints, you\u2019ll need a valid API token (x-api-token).","sidebar":"tutorialSidebar"},"help/Settings/Custom-email-templates":{"id":"help/Settings/Custom-email-templates","title":"Custom email templates","description":"\ud83d\ude80 Steps to Set Up Custom Email Templates","sidebar":"tutorialSidebar"},"help/Settings/disabledocumentid":{"id":"help/Settings/disabledocumentid","title":"Disable DocumentId","description":"Whenever a document is signed by all parties, OpenSign\u2122 adds a DocumentId at the top left corner of the digitally signed document.","sidebar":"tutorialSidebar"},"help/Settings/manage-users":{"id":"help/Settings/manage-users","title":"Manage users","description":"The User Management feature in OpenSign allows administrators to add, edit, and manage users within the platform. This functionality is available on Self-Hosted, Teams, and Enterprise plans.","sidebar":"tutorialSidebar"},"help/Settings/my-signature":{"id":"help/Settings/my-signature","title":"My Signature","description":"This guide provides instructions on how to save your signature and initials using the OpenSign application. Once saved, you can use them with one click when signing documents. To create your signature, start by clicking the \\"My Signature\\" link under \\"settings\\" menu.","sidebar":"tutorialSidebar"},"help/Settings/Preferences":{"id":"help/Settings/Preferences","title":"Preferences","description":"The Preferences page in OpenSign\u2122 allows users and administrators to tailor the signing experience to suit individual, team, or organizational needs. Below is a breakdown of all configurable options and what they control.","sidebar":"tutorialSidebar"},"help/Settings/SecurityManagement":{"id":"help/Settings/SecurityManagement","title":"Security","description":"\u2705 Two-Factor Authentication (2FA)","sidebar":"tutorialSidebar"},"help/Settings/Teams":{"id":"help/Settings/Teams","title":"Manage Teams","description":"The Teams feature in OpenSign allows you to organize your users into structured groups for easier management, permissions control, and streamlined workflow configuration.","sidebar":"tutorialSidebar"},"help/Settings/Webhook":{"id":"help/Settings/Webhook","title":"Webhook","description":"\ud83d\udd14 What is a Webhook?","sidebar":"tutorialSidebar"},"help/Templates/create-template":{"id":"help/Templates/create-template","title":"Create Templates","description":"Getting Started","sidebar":"tutorialSidebar"},"help/Templates/embed-template":{"id":"help/Templates/embed-template","title":"Embedding OpenSign templates","description":"OpenSign Template Embedding allows users to seamlessly integrate public document templates into their websites or applications. By embedding templates, you can provide a direct and interactive signing experience for your users without requiring them to leave your platform. This feature supports various technologies like React, Next.js, HTML, JavaScript, and Angular, making it easy to add signing capabilities to different web projects.","sidebar":"tutorialSidebar"},"help/Templates/manage-templates":{"id":"help/Templates/manage-templates","title":"Manage Templates","description":"Viewing and Managing Templates","sidebar":"tutorialSidebar"},"help/Templates/publicTemplate":{"id":"help/Templates/publicTemplate","title":"Setting up an OpenSign template for public signing","description":"The OpenSign Public profile feature offers the ultimate public document signing solution without any need for integrations. With this feature, users can share document templates publicly, allowing anyone to access and sign the documents directly through the shared templates. This streamlines the signing process by providing a seamless, accessible way for public signers to complete documents without additional steps or integrations.","sidebar":"tutorialSidebar"},"help/Templates/quick-send":{"id":"help/Templates/quick-send","title":"Bulk Document Send for Signature Using Template","description":"Overview","sidebar":"tutorialSidebar"},"help/Templates/use-template":{"id":"help/Templates/use-template","title":"Use template to create documents","description":"Step 1: Begin New Template Creation","sidebar":"tutorialSidebar"},"help/User Menu/Console/analystics":{"id":"help/User Menu/Console/analystics","title":"Analytics","description":"Documents Signed","sidebar":"tutorialSidebar"},"help/User Menu/Console/branding":{"id":"help/User Menu/Console/branding","title":"Branding","description":"Custom Subdomain","sidebar":"tutorialSidebar"},"help/User Menu/Console/custom_filestorage":{"id":"help/User Menu/Console/custom_filestorage","title":"Custom File Storage","description":"\ud83c\udf29\ufe0f Introduction to BYOC (Bring Your Own Cloud)","sidebar":"tutorialSidebar"},"help/User Menu/Console/emails":{"id":"help/User Menu/Console/emails","title":"Mail","description":"This page allows the admin user to configure and manage customized email templates at the organization level.","sidebar":"tutorialSidebar"},"help/User Menu/Console/general":{"id":"help/User Menu/Console/general","title":"General","description":"The General Settings section in OpenSign provides key administrative settings to help you manage and control the overall configuration of your OpenSign platform.","sidebar":"tutorialSidebar"},"help/User Menu/Console/globalSMTP":{"id":"help/User Menu/Console/globalSMTP","title":"Global SMTP","description":"\ud83c\udfe2 SMTP at the Organization Level","sidebar":"tutorialSidebar"},"help/User Menu/Console/orgadmin":{"id":"help/User Menu/Console/orgadmin","title":"Org Admins","description":"The Org Admins section allows administrators to manage organization-level admin users within OpenSign.","sidebar":"tutorialSidebar"},"help/User Menu/Console/organizations":{"id":"help/User Menu/Console/organizations","title":"Organizations","description":"The Organizations section in OpenSign allows administrators to create and manage separate groups within a Team or Enterprise account.","sidebar":"tutorialSidebar"},"help/User Menu/Console/signing_certificate":{"id":"help/User Menu/Console/signing_certificate","title":"Custom Signing Certificate","description":"The Custom Signing Certificate page allows you to upload and manage your own digital signing certificate (PFX format) for secure and verified document signing in OpenSign.","sidebar":"tutorialSidebar"},"help/User Menu/Profile":{"id":"help/User Menu/Profile","title":"Profile","description":"The Profile in OpenSign allows users to manage their personal and account-related details. You can update your information, verify your email, and set up a public profile.","sidebar":"tutorialSidebar"},"intro":{"id":"intro","title":"Tutorial Intro","description":"Let\'s discover Docusaurus in less than 5 minutes."},"self-host/cloud-storage/s3":{"id":"self-host/cloud-storage/s3","title":"AWS S3","description":"You can create an AWS S3 bucket to store your uploaded documents using OpenSign\u2122","sidebar":"selfhostSidebar"},"self-host/docker/run-locally":{"id":"self-host/docker/run-locally","title":"Self-host OpenSign\u2122 with Docker on Linux/MacOS/Windows","description":"Steps to run OpenSign\u2122 with docker on Linux/MacOS/Windows:","sidebar":"selfhostSidebar"},"self-host/docker/upgrade-deployment":{"id":"self-host/docker/upgrade-deployment","title":"OpenSign\u2122 Self-Hosted \'Upgrade Deployment\' Guide Using Docker on Linux, macOS, or Windows","description":"This guide provides step-by-step instructions to upgrade the deployment of OpenSign using Docker.","sidebar":"selfhostSidebar"},"self-host/guides/azure-vm-setup":{"id":"self-host/guides/azure-vm-setup","title":"OpenSign Deployment Guide on Azure VM via command-line","description":"\ud83e\uddf1 Prerequisites","sidebar":"selfhostSidebar"},"self-host/guides/env-variables":{"id":"self-host/guides/env-variables","title":"ENV variables which are used to setup OpenSign\u2122 with Docker on Localhost","description":"Information About ENV variables which are used to setup OpenSign\u2122 with Docker on Localhost","sidebar":"selfhostSidebar"},"self-host/guides/how-to-generate-self-signed-document-signing-certificate":{"id":"self-host/guides/how-to-generate-self-signed-document-signing-certificate","title":"How to generate self-signed document signing certificate?","description":"","sidebar":"selfhostSidebar"},"self-host/guides/upgrade-to-v2.1.0":{"id":"self-host/guides/upgrade-to-v2.1.0","title":"How to upgrade self-hosted OpenSign to v2.1.0?","description":"For self-hosted deployments, version 2.1.0 introduces changes to the signup process:","sidebar":"selfhostSidebar"},"self-host/intro":{"id":"self-host/intro","title":"Self-Hosting OpenSign","description":"This section of the OpenSign\u2122 documentation is dedicated to guiding you through the process of self-hosting the OpenSign platform. Self-hosting OpenSign allows for greater control and customization, ensuring that it aligns perfectly with your specific needs and infrastructure requirements. We cover everything from initial setup, configuration options, to maintenance best practices. Whether you are an individual enthusiast or a professional looking to deploy OpenSign in a corporate environment, this guide will provide you with the necessary steps and tips to successfully self-host OpenSign\u2122 - the best open source document signing infrastructure.","sidebar":"selfhostSidebar"},"self-host/One-click-Install/DigitalOcean":{"id":"self-host/One-click-Install/DigitalOcean","title":"Digital Ocean","description":"OpenSign application consists of 3 components -","sidebar":"selfhostSidebar"}}}}')}}]); \ No newline at end of file diff --git a/assets/js/044432a7.3a7a4235.js b/assets/js/044432a7.3a7a4235.js deleted file mode 100644 index f4599bc60..000000000 --- a/assets/js/044432a7.3a7a4235.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[6800],{24159(e,n,t){t.r(n),t.d(n,{assets:()=>y,contentTitle:()=>b,default:()=>j,frontMatter:()=>x,metadata:()=>s,toc:()=>f});const s=JSON.parse('{"id":"API-docs/v1.2/publictemplate","title":"Public Template","description":"The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique **template_id** and a **public_url**. The **public_url** is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing.","source":"@site/docs/API-docs/v1.2/publictemplate.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/publictemplate","permalink":"/docs/API-docs/v1.2/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":"eJztPV1zG7mRfwU3dXW2mSFF0pLt1Vbuol37Nr44tsuWb2tPUhRwBiRhzQCzAEYUo2JVHvIP7ule89P2l1x1A5jB8Eu05HXk1OzDWhx8NbobjUZ3o3EdGTrR0eFJdMzyIqOG6egsjlKmE8ULw6WIDqPjKSNvy1HGE+JrkaO3LwnNMjnTpNRMaWIkSRSDIuN7ImZKDdFMXTJCNRllJSsUF0aTsVRkwgRT1HAxIalMypxBwYybKSkUS9mYC5YSbVSZmFIx3SM/TpkgtOqecE10mSRM63GZZXM3fBoTM7XwKWZKJTShpBT855KRTsc3Pudpp0OoSAklnU6BkzsvVdbp9AhMt/kNhrK/szmhOCQfZQzb53RORozoKVUstfBTMUekxIQJOspghmbKckCRm7RtqvlEBHMfUc1SIgXC7wHtkd/LGbuEzsLPhBvNsjFJqBDSAAC5TPmYs5SYqZLlZErMlGvy4d2rbwk3UI9IkSGoJQwDFPBDW8xxKSqouJj0TsWpOObFIflQZJKmZC5LRd4+/8+6mZEEvp10Os/ZqJyQDy87nbOHU2MKfbi3R4uiJwsmoL+MjnQvkfleChWLdPwoJrMpUwx6ReAY1RyQmwIO0wkzGicsSCKLOUmkVCkXwFQxKeiEEVHmI6Z0bGkgFSMcmEMxms67RnZLzch/vX/zGiaaU9Mjb7NSx9VwKVcsMcA00D1g1s/qgSXEk33gPS4mMcnpBZCQG/JzyZMLmLZmIoV/Hachrjqd92VRSGVYSn60UzjsdKDkO5bJGaGKYf1E5rkUpKCK5szg0oFlAsWK/Vzymo2yzOPi8FR0SacjaM4OOx3ywbIzT5kwQHSF5ESC2wY9W9/MC6z/UqQ8cSuSEfhK5LhZFZAKVd8XLIEubdUA1cCYsylPpojDGbX0LzKa2GkppguWGH7Jmh1fxWQOHT9nQnoIplLxv0hhaIbku2TK8IRmIZkBQKiqDVUoIwrJhfFf3QjkJ0dOoDYS0fEhgJYCcnMusEQzckmzkmkH1SwmU4DqHSsU07j8XL+4flMyZXwy3TgeTT+W2jQ6JqV2C72Cwo3lqYroZYi2Mc00I3zcwGVOL1gwGpEof2nWI9/NScrGtMxMTDhwqFEl65HX0hBaFBlPKEgj4AFYbBTkZRep7Nin12Sft0pe8pSBYEz5eMwULGYoxC5cGw8d8GWBDWB6uNLMFKXJEqETmUm1ykL4uYlHkkhhmDA9cnRJeYbA28lqwkWSlSkjo4wmFzHuGTFRINWBKnMGW05s1wdWgY3F4hzxQzTLgAulAPiFdMPDVuGgSkHAgzz36w8KPapxEK5DrLpVPpYwMqDAL0nCcsqzGBEXk49yRAw3GYthgRdUzGOSUsNiYtiVGcmrmCRTllzgX4qmXJJRaYwUdmKpkkUqZ8LhciyF0fwva1akL/l0jA5jsh+TJzF5FpNBPyaDYUwG+zEZPInJ4FlMhv2YDIcxGe7HZPjEgjV85nBNKwSHAAyGFsvm68LulKfsHBqew9zOqTZMcX0B4toqGbhte00CKvpdGZYXS+sdkGsy5WnKBBkrmRPFEl5wlCZWGlRdxwAPUTApoYnVVy651SIcDqpO5UwA3nBErsibgon3oCnQJJEl0BgxbJGK6KxJDju8FOSY0VzjzF8Iw1ShuGYgqoWuMCBMzVt2A4RvoQDYhZKiKYE2U3MTdQLKwA76imuUubD16Wo3nTV200GPdDqVnINvf/7zn0/F9akg5DQCsXcaHZLTqKpyGsW2DHYzKBu431fw4/Hwqfs5h59Phs/czxlWHey7n1P4OfRN3eKCbzgw1uDC2KGdgCUBCFBpcSoWDtpTMcRpGJoXW6YAxV8KfL9NwUfYX2JfAEtwFZ4NM7Y1Vmb7GGbLBTecZnrzhH2NezTnJZDWT7uutDLzfZg5CrPN08biezTnEB4owU3UFuGmGxT57QChGG5B0XKfm4QwtEL1aAWTBz2nw2xGpJ3CvcFjAM7nQuNSl5+OxSeARdhPj2E/3YzKasu9R/hchulzIXVdv5+O2ac91IJRPdmMV1fhHmG1CdHnwulqr5+O0WeAUdDzNqMTSu8RLgNwoMApzbasv98dHHSH/eF+A59gnrAV8rybpt35fH43WuRcnFs4oFFQP6dX6wvAagK6Y0WJqsQZg6pmzdJVqtt6S4QEjdNhApROf/60Wi8Ys1B5XjUu4Nm/ruVOPPi3P5D/EY7hI39CZalTm+vzSGX/Cc/QRqZ0/kDbrnzT6ugF9ZeVYwsmFgEcaAtLppInDnio4w9cIzD39AAHXSTqXpruBUSFj2nazfPu0kf42UUeCD7meS9Ne0s1VxjFfsxJmsZk9fPa72lK8jzf8Nl+b3zey/PVWfTy3MHmsOd5b4XOORc8L+GIBGY1e0JP0b557NGbO1pyQTqdn3766afuH//Yff680/E0dEM4Lg4sGXYEevWZRgiZvtM5JC/HJPyE1gRrx0EpUJ0M0ZTtK0zlTPgDER4bFUlLMChWBla0JoH5GDpj3EyZao4DJlrPsnB8REuvNNMe+YCnS/jbn8Kq0xKepL7poa0bj8abZaer8KXEZy0lmwNvFa2bRVNDtq6oRV4wFev1JsUmZUYVuwLzn+ZSrMjE2+yBn7a/LYlFz8u1qQUNi860y7ylgzx84w7hjyr74tJcoLcjkpTaoE1iwq5IQY1hSmBnlzTjqbX3d/EDu6J5AbaVvT+dnqa/+dc9tOyC8dRYk0LKJxwM8nt/Ojnq/s/ZmhplUTCVUM1IxmAkHRNmkh45mbKsqH0Cs9msN3usk6mUmXUIfNSKje3/z+Xo4zmCW/SoLh6tm6llhsCSCsyybEjFxRlgjGriW66xpSJpcNUM+qjBOVPFFhXO1bhHescSSFBozdJQfAJbPyq3wLys/luCzDmNzurtHq2nLL2h7dkOyxNWQ0ZHLFst+vSlldG5LN2K9t6C5lQdRwd4c6pQZRDG6fTjoJBeLRXassWadWoREi5Tv9v75ekpQDKuq42kgc6wtfMZoOdHMIbOJPAiugZkVHHpnVdBBdhuy8AbSJF2NwwB9QhWrPw1frQbRmgQZmUnd7qCdzyNq149yvxGHuILWoLXtVYTtozgdIXNI4CXZ/MAp2KAZkhvvtxyPnE17pGsWAJp+zK+jRRp7My32VJvtQD9tMIFuGZ7hap2Y60Wn968+nrkjbWp+0Zgb08SVoCmdeelWYG88w6FVuPQhL6Z88Ja94j71oD1K3Ogq/e5d59bMWk4+6+IURtg78ys1uif08kW+w0W3yP2dPCsmKIGaMe3+8UW+zOWb5/OoN+YzkFzOk/6tzhPNYa9+3GqX31cY39eHgpOzmVGV4R9yhKe0wwDRBDu4R1W4G2OVg4w4PDvZV6UJlxSaLRBseF1AB/2YB23v4lJNyadmOzF5GFMHvXIO4aBEkkVVOFUAq5s6ASHUK4SvKBJqSDQSsHEY8J6kx65vv65pMJwM18sSIdcX0MM2GLRgzV2IeTMxlWcgEfYEIiLqo9MqUz0mjgqmeg9OFvtvWaz7nPnOt5zoD0iD+XSgt960HQo+LLnLQtVwCQwyutKIbNnTgzk4brI6JzQMXihbbAHNrMxQT1A8SEZkt/+OxkMe/1+TPr2b/LQT3D4CNcwepASlm1zQWLxTSu4H67g+uc6gXTQ32kJh8PecgVDF+cYIoDj3qiO1Yv7HhpG6sksm2IDnR1w5oJMp7LMUtgbbdAnq8LzKo2903mr2JhnWRCdR/wnv6Yh2ollLHcRYS4uDw4rGInAhZGwbnyoRqczYmMJUQgQHohmvyAM1I5tN+ZGhAfGW0pFplRbKwpiGiCG+EeIFV2Kh/Dg1TERXHjYgZUHn8/eN/ymydxPDhrMfdDcnzYy9yYO3mIGhCa6kEJX3j5WFwVch33676sHh2VO8p0CuTEcpo7qQSGGjJPxCxbKGi6018EclMtRbt9PpdR1DRdo5uSuPmwGsEkFMWyPelXgx12dWoOnjxtKxLMv6NRqUqm/vzc42Nvq1VpygHz6UZCQXUiKNvOdSIo1a5q2Lp+7uHzuviIef06z6+DpsHFaeLxtc74nZtdwRd1gcP0cZtVbnVzX2TfDdbijZfOLWRjvzpb7v4atZUlwPx38A2wtd2XRFZPKZ2NK8rnsKes4cweDylYryp05NwT2V+feg89jfFk663zT0Aa/GYbcenBwN24NoVliudOI//d3b97N+n/4YSKPjo6OXr//MH3xYXJ0dJTD716vt9Ygt44NcBjQn901H7fFo7qwYZRer4fOeGroITbfK8TkW9s+3tym56LtfiUvwcGX9hLcXW5UVb/MnrXOJfDrSYa7rtkojmSBVyKleJlGh5G9cuiv/EUxko1p851M59HhdeQufcCfLggfmu591HBr8zrSyZTlFP7y5IZ7nmOeQVc2JEVHcYSBj3DpE9gxOozk6CNLTBRD6EQB1m6moQ9sd3jta9nLcVHsVP3oMLLLIYojF05QfSJMJBJis4p0HC1i7Om8oFrPpEq3dll9qbuEDizEn9hQ4x/VBUroBy6k3bIbbLpYuih7q57CHhY1XerOqFJ0Hi3fyfU30YrgqgFYRZwFL5v7/YgbsMdV16OwWhRH3LA8HGUD1ZX8dEwnTMJMMOD7NuQFGXSbdsVUils1dKGqt2n6UY7Ob8WONa3Pd8dxkwWaF8Ogl0rR8PeQqnBIF51WKAmXl3vkCG7osNRp64d13Bt4Nyq76aNDG2A5pXCD25CMUbBHieBmS/MO4CVnM+jhkLxjCeOXDrbwxjBUwZihb60XH/sWcumqIi2AsX1X0MbeZ3Lfm91+C+2XIaou01rJykSZg/irFoAFNYojPxSIwGB12nqLOHKArVmRO64hW7pK3yY1mxQh3XpCsb1V07tJnvj6uBboJBzT2kxXxjzedMU3uFnoLKu0KBhVPbxpe+tL35gkgGZJiVfYq123MbMK1Gpmg0UcXd08mSuSyK6/P0weZmxsbFgaSaQSTD0Kw4zvzeSG+/uLOJrfPL35Vzm9p0C82c2z+xEvXteX0v8RsD5+toij6c2w/r66Gv4PBHb/yaLWhCKb+qJKbjGS6fzcy63FTRW9ygH1ILHBS/FGpUwFiBhJmTEqVjABgdH2BPwAThEPYhsMindAudJe3SAzcLEouyNU+5EV1k6ltdfD/D068Bu+gA+ohetypKGW8P1p2+GIEaP4ZMLA4+JqYGN3Z5nRZAqZGlyIau0+LBS75LLUHjxww4AOkDGD+TPAp1sFaYfH9AA7QRC4nXsvpA58cdg85+JcQotzG5a+A1rxDvISYu1kLLwccqnI5AJuN8CadxlJfPYBv9mWwvAMr9IWgPvUx54DAnHXXZ4zxWC5HnkhxlIlTBMLcYDbGi14GsJTB9OQykOQBwF2HuDxKNMVcshzi0Mk6AO0dDQxhp8WcYQ5Zc7leJxxwZA1b8WHfp6gIutyBHHK1Ob6ANdylXLFpYzxBn2u6wQr7qq3u8ctCLuCAGqaESNlhidMe09boXay+wTt3fI3x293mBfalboWMHffGznf9kHeHL+F3Bl87E5+cC+gWh1+udFGFQInMXLJqb9fX+33c6uOMetOsfpUg596LmtFl6wClHK9FqLY5ggCFFZZglY6rpOxwLKVpQEvKHcXzbVhhd6CyGNZ7iKpbsAkJZMSrw8ZEOM+kQaGsde5L7iw2YjQxODucqxVrj2ePFagUtA/pAXStjklY/SGx5ChCDCvSjAoVF2yq4IpDlEna1GgmEUdZCm6WcNsnhc+vHvlUvAEN1S8XPUdwwIokGtQUqyImOWprx5xmADRt+lIt6qOYiyNO8YUTGkpwEIi1YQK/hfLwqilgoFlxKY0s1Xd9gGeOBRzwK8NYPz++8vf/h7AtfGMugqYHYGmKcRF3AAhWpEsw4MAUqyAXVE2IYL+mPrdsmIQVULQZnSyC0nvzuNv8VqGrkSgiyqoohp0mUzBJFDtwTqu7q+7o4ZGs1SV+EIWMF92xbUJkjr4s+WqfHjnbmDVMNhtKk2tLJ2HC7yOtpBL3WH6Cd5M71KpRqsbR2nkuWI5F7vpLqHp3shKEJRG5tTwhPiudK+ZtMd6lP26zusYI+DGSy7Vo7XgGZ6zY/m923Gf07m+WdGENqgdulYkpXPECGbwaqiN7Krgal7dk0RntcfkDaerAxQkMNlzKRIG+grkG9vhSBIEawFgI2ZmjIkQc56EstIWbKIQVBgaFFu6VNfAIUCYMzVh5wmcqnFNsB1I3OlAV50O6VpAnMTXpXKGXpeOC0UbSLm6dwDHJc6p7pTW6lKYBS1I0FaAfcTaBm3/gE+CkLtcMuEIdeo2zSDJSqCHwAUFXqeGc8FAyEo4m5fWtJdYOzP0AumjYJx425y8dK8uy1JIAeVH9xoPTA5MtIRmEle7ma7LfYNAvcTsP1PcHZF+4Mqy4/iUXKgl/fLX/9OghboQSt2DKWwsxZgr1B7xZmPYq19sfjk6487yahPS8PH8XIrzWsqtZZhmy60MtCZ+q6loCbdH4OBe3wJOB+4ARNs9Fv5p2q9W6Lt5MEDIZxrwtTQMjGsTqtKs2tMsGQ0mvqMhI9mhNnEDGuc2sB01hiZThgmDUlZA6jzpjgt2A35QJxkCeoL5iolz9JrsYnZzm/YioOZJBM4V9JikUWxdS9HZIo5GSXLbHmE//537jRt1jJ+GjW8ruTNHSUIeQg7IlCRUjaRNaPjo0KnqNIV1iGrYktbeIKpFPoqThv7Fg4Nrj1T/OSTa+MB1BsrtvgS/wduzAWZnzEdw2wBjHfEUjJqgrN0JTYvnr2Yy3Wb/dHF6rfXzKzIPDvr9f2br5+P+12P93O9/RdbPZwCs86ffLE02nT7Xyg4fH7C9wUfJrOcwk2p7TdiBwOntohnWIbheDsOF/a822HohfoMR11p5az+/M0D6ySAahv0+/LMkBL29y5vCwpTK/xLFuwcZ3CDR68TL2/F1dPnsbV6IPJmiJK+yMG9vFTJbsB/v2fbAev/hIeDpb5tj5Ezr5oaxZgCX/9psR1dIJS7QhOlJcL4UzWHJvL+OJu9lzqxSPYNNfqYkaGPudGHUnNAJHA+gG/UZScSUuomZPw2ybdjY7/fPBxUSDlaR8FLgrX5M5H0sL5j4sjMNhzd2eAD1Ks9qiRJxWwnLo8Zkw+92kpolpeJmHh2eXEdXXVrwri0/PDlbnAEXmqnEqB+pEWJqptFhtLcSBIT51EExPrmOcF1UzK+pSCEwdkXa0oLvXQ56w2gRL7dZK5231Gdl91ObaEMnXExuandW4+g90NGSqoGpWp0s+B8Y6JOOEGGtOOLAP1NGwRAEqAf2eFeHTr3wRPZBTevilFbClKKopu9yLJEPJWpEBy1vnGvifYJwnxMfa4PhM1X0TFTPMaoiXKIoiFmBH0EUShQtxZXUEQ+VVn5SM34VM+CV5gFqm8P9fVTLng5Qf3n8DFWD/SeLM0umwEmI4YMbPF3uUL3Op+OKAm9I44s167tPTTM3zjA0Kzdsu8um3Y1m1g1WVg9y05rovq4z4g0ONpnPDtZarVxX6y0UrjA8/q4/yrqT7O6n0uAwuIYPvP7T5AKI/QUueNxHLtjvIxc86zdUL0eDuodagUItqVKS3ARqRQi0nTNYn1yMJS5ux8JVxmMQvigcVhRmliUyrxIOdzq+yS9/+3vVqtOpDsrWPQZWjzelIoWcMTUubRbjccauMA0zNGM5lmk0r+HNVpqDbQTC6YRhE7ST4c3U2hdKElrQEc847C72hiCaX4MNyj5egbeN57J8oOzd20uWwaZU2ZyDhzDITKqLMbyuAVaYETghwULDxJSKxDo4rKREQz0c0Os8z9oogJpb2KQwiiaG5FTQCVraYxIiK2UZh+2EKDkC/5+WWWk9XIbyTCpraMYJYVgsIvHFVQFFqPWDIFJsCqvr0rm5dGzdjFbiuTcaRuDlLwAWDiY+I0kpwIltowVK8FJL47zMctyAEZobRYWGE4GzbTsaVAhzHiimnTHtg2ZA4VdcXNjE0V1yUvHVj2ykuWHNvFTLEuJRs80P3Py+HMGDAVJzI9W8bj3hZlqOcDsLO6l+2J5+8E9/BJvV7te831ujnN47evsS1aFH5Je//i95xagSZCpnlluTUrFs3nxlxFLeoq3SZtDHSUt4YcMgk4qJD8XwGPxxSg1aZl+zGZjA7ZKy4Xk/MFM/BfNvpPET7qxC2J5iubwEB6IQDEhD1Tx89AKfGqkM3048YYi9Pco742XdAiMDT5vb8mkU5Ce3tjQult+hiUlZpM0Prka93NCsWRWnio5N07aJr62g61rJ0lgG9vYyDw0itVDSWM9pkY490Ks74E6Q48hLwAfjY6+1Y925sOCignNQuQErSeXi4rmq3+hxAAYqw3rIaiexJlarRr9PA1EreL0R0SuUggkXS0ctO+EeOXLh9j5odW3EahxEocaNQNIeee/gz3eLaf2W2I702kDVb30sKpTTuetPzGvrqQ9mWIp24oo5G3wUL6u3zV0OPSKAO918OqjgbhGfeGFAmmn2Pl2YWGOGMNQGKHnliRZ8rYMaXlbRb8bvmbrkiT9/b5Cje1h5L4qjjCfMWVac1nD0w9tX5PJxrw9qS3Vo2EGk7r16+f2L1+9fADBAAouwQa/f66PZQGqTUxGMtPR+1bJGEVymaJ+7ap+7ap+7ap+7ap+7ap+7ap+7ap+7ap+7ap+7ap+7Wr1D3j531T531T53tQlF7XNX7XNX7XNX7XNX7XNX7XNX7XNX/6y5D9vnrtrnrjaJz/a5q/a5q/a5q3udd7V97qp97qp97qp97qp97qp97qp97mr77nMrJm2fu/r0jMvtc1ftc1ftc1ftc1ftc1fbV3D73FX73FX73FX73FX73FX73FX73FX73FX73FX73FX73FX73FX73FX73FX73NVX8dxVkH1ir8goxyQ6LteTzX9zsvwI1lkcTSFBzuFJdH0NLPlBZYsFfP65xKwbJ2dxdEkVhwh9zK0T+1QwkO/igkHKlO/t9ZHuMYwfW0LjbdellEKQy8a2sHePt9YNc/i8ffP+GJJ1uIe6cpliKjA6g/wYdGaTmARJNPDbdZRRMSkxAUdk+1zYxMbTZuqbC0x94/4IsnhAPpgawmZOHDsN+D9Mam2D62ubVmexqOrboo0tHGJ9baDf2WKx+H+e8T3u","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Template","permalink":"/docs/API-docs/v1.2/createtemplate"},"next":{"title":"Get Template","permalink":"/docs/API-docs/v1.2/get-template"}}');var i=t(74848),r=t(28453),l=t(57742),o=t.n(l),a=t(78178),d=t.n(a),c=t(19624),p=t.n(c),h=t(96226),u=t.n(h),m=(t(77675),t(19365),t(51107)),g=t(21312);const x={id:"publictemplate",title:"Public Template",description:"The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique **template_id** and a **public_url**. The **public_url** is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing.",sidebar_label:"Public Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztPV1zG7mRfwU3dXW2mSFF0pLt1Vbuol37Nr44tsuWb2tPUhRwBiRhzQCzAEYUo2JVHvIP7ule89P2l1x1A5jB8Eu05HXk1OzDWhx8NbobjUZ3o3EdGTrR0eFJdMzyIqOG6egsjlKmE8ULw6WIDqPjKSNvy1HGE+JrkaO3LwnNMjnTpNRMaWIkSRSDIuN7ImZKDdFMXTJCNRllJSsUF0aTsVRkwgRT1HAxIalMypxBwYybKSkUS9mYC5YSbVSZmFIx3SM/TpkgtOqecE10mSRM63GZZXM3fBoTM7XwKWZKJTShpBT855KRTsc3Pudpp0OoSAklnU6BkzsvVdbp9AhMt/kNhrK/szmhOCQfZQzb53RORozoKVUstfBTMUekxIQJOspghmbKckCRm7RtqvlEBHMfUc1SIgXC7wHtkd/LGbuEzsLPhBvNsjFJqBDSAAC5TPmYs5SYqZLlZErMlGvy4d2rbwk3UI9IkSGoJQwDFPBDW8xxKSqouJj0TsWpOObFIflQZJKmZC5LRd4+/8+6mZEEvp10Os/ZqJyQDy87nbOHU2MKfbi3R4uiJwsmoL+MjnQvkfleChWLdPwoJrMpUwx6ReAY1RyQmwIO0wkzGicsSCKLOUmkVCkXwFQxKeiEEVHmI6Z0bGkgFSMcmEMxms67RnZLzch/vX/zGiaaU9Mjb7NSx9VwKVcsMcA00D1g1s/qgSXEk33gPS4mMcnpBZCQG/JzyZMLmLZmIoV/Hachrjqd92VRSGVYSn60UzjsdKDkO5bJGaGKYf1E5rkUpKCK5szg0oFlAsWK/Vzymo2yzOPi8FR0SacjaM4OOx3ywbIzT5kwQHSF5ESC2wY9W9/MC6z/UqQ8cSuSEfhK5LhZFZAKVd8XLIEubdUA1cCYsylPpojDGbX0LzKa2GkppguWGH7Jmh1fxWQOHT9nQnoIplLxv0hhaIbku2TK8IRmIZkBQKiqDVUoIwrJhfFf3QjkJ0dOoDYS0fEhgJYCcnMusEQzckmzkmkH1SwmU4DqHSsU07j8XL+4flMyZXwy3TgeTT+W2jQ6JqV2C72Cwo3lqYroZYi2Mc00I3zcwGVOL1gwGpEof2nWI9/NScrGtMxMTDhwqFEl65HX0hBaFBlPKEgj4AFYbBTkZRep7Nin12Sft0pe8pSBYEz5eMwULGYoxC5cGw8d8GWBDWB6uNLMFKXJEqETmUm1ykL4uYlHkkhhmDA9cnRJeYbA28lqwkWSlSkjo4wmFzHuGTFRINWBKnMGW05s1wdWgY3F4hzxQzTLgAulAPiFdMPDVuGgSkHAgzz36w8KPapxEK5DrLpVPpYwMqDAL0nCcsqzGBEXk49yRAw3GYthgRdUzGOSUsNiYtiVGcmrmCRTllzgX4qmXJJRaYwUdmKpkkUqZ8LhciyF0fwva1akL/l0jA5jsh+TJzF5FpNBPyaDYUwG+zEZPInJ4FlMhv2YDIcxGe7HZPjEgjV85nBNKwSHAAyGFsvm68LulKfsHBqew9zOqTZMcX0B4toqGbhte00CKvpdGZYXS+sdkGsy5WnKBBkrmRPFEl5wlCZWGlRdxwAPUTApoYnVVy651SIcDqpO5UwA3nBErsibgon3oCnQJJEl0BgxbJGK6KxJDju8FOSY0VzjzF8Iw1ShuGYgqoWuMCBMzVt2A4RvoQDYhZKiKYE2U3MTdQLKwA76imuUubD16Wo3nTV200GPdDqVnINvf/7zn0/F9akg5DQCsXcaHZLTqKpyGsW2DHYzKBu431fw4/Hwqfs5h59Phs/czxlWHey7n1P4OfRN3eKCbzgw1uDC2KGdgCUBCFBpcSoWDtpTMcRpGJoXW6YAxV8KfL9NwUfYX2JfAEtwFZ4NM7Y1Vmb7GGbLBTecZnrzhH2NezTnJZDWT7uutDLzfZg5CrPN08biezTnEB4owU3UFuGmGxT57QChGG5B0XKfm4QwtEL1aAWTBz2nw2xGpJ3CvcFjAM7nQuNSl5+OxSeARdhPj2E/3YzKasu9R/hchulzIXVdv5+O2ac91IJRPdmMV1fhHmG1CdHnwulqr5+O0WeAUdDzNqMTSu8RLgNwoMApzbasv98dHHSH/eF+A59gnrAV8rybpt35fH43WuRcnFs4oFFQP6dX6wvAagK6Y0WJqsQZg6pmzdJVqtt6S4QEjdNhApROf/60Wi8Ys1B5XjUu4Nm/ruVOPPi3P5D/EY7hI39CZalTm+vzSGX/Cc/QRqZ0/kDbrnzT6ugF9ZeVYwsmFgEcaAtLppInDnio4w9cIzD39AAHXSTqXpruBUSFj2nazfPu0kf42UUeCD7meS9Ne0s1VxjFfsxJmsZk9fPa72lK8jzf8Nl+b3zey/PVWfTy3MHmsOd5b4XOORc8L+GIBGY1e0JP0b557NGbO1pyQTqdn3766afuH//Yff680/E0dEM4Lg4sGXYEevWZRgiZvtM5JC/HJPyE1gRrx0EpUJ0M0ZTtK0zlTPgDER4bFUlLMChWBla0JoH5GDpj3EyZao4DJlrPsnB8REuvNNMe+YCnS/jbn8Kq0xKepL7poa0bj8abZaer8KXEZy0lmwNvFa2bRVNDtq6oRV4wFev1JsUmZUYVuwLzn+ZSrMjE2+yBn7a/LYlFz8u1qQUNi860y7ylgzx84w7hjyr74tJcoLcjkpTaoE1iwq5IQY1hSmBnlzTjqbX3d/EDu6J5AbaVvT+dnqa/+dc9tOyC8dRYk0LKJxwM8nt/Ojnq/s/ZmhplUTCVUM1IxmAkHRNmkh45mbKsqH0Cs9msN3usk6mUmXUIfNSKje3/z+Xo4zmCW/SoLh6tm6llhsCSCsyybEjFxRlgjGriW66xpSJpcNUM+qjBOVPFFhXO1bhHescSSFBozdJQfAJbPyq3wLys/luCzDmNzurtHq2nLL2h7dkOyxNWQ0ZHLFst+vSlldG5LN2K9t6C5lQdRwd4c6pQZRDG6fTjoJBeLRXassWadWoREi5Tv9v75ekpQDKuq42kgc6wtfMZoOdHMIbOJPAiugZkVHHpnVdBBdhuy8AbSJF2NwwB9QhWrPw1frQbRmgQZmUnd7qCdzyNq149yvxGHuILWoLXtVYTtozgdIXNI4CXZ/MAp2KAZkhvvtxyPnE17pGsWAJp+zK+jRRp7My32VJvtQD9tMIFuGZ7hap2Y60Wn968+nrkjbWp+0Zgb08SVoCmdeelWYG88w6FVuPQhL6Z88Ja94j71oD1K3Ogq/e5d59bMWk4+6+IURtg78ys1uif08kW+w0W3yP2dPCsmKIGaMe3+8UW+zOWb5/OoN+YzkFzOk/6tzhPNYa9+3GqX31cY39eHgpOzmVGV4R9yhKe0wwDRBDu4R1W4G2OVg4w4PDvZV6UJlxSaLRBseF1AB/2YB23v4lJNyadmOzF5GFMHvXIO4aBEkkVVOFUAq5s6ASHUK4SvKBJqSDQSsHEY8J6kx65vv65pMJwM18sSIdcX0MM2GLRgzV2IeTMxlWcgEfYEIiLqo9MqUz0mjgqmeg9OFvtvWaz7nPnOt5zoD0iD+XSgt960HQo+LLnLQtVwCQwyutKIbNnTgzk4brI6JzQMXihbbAHNrMxQT1A8SEZkt/+OxkMe/1+TPr2b/LQT3D4CNcwepASlm1zQWLxTSu4H67g+uc6gXTQ32kJh8PecgVDF+cYIoDj3qiO1Yv7HhpG6sksm2IDnR1w5oJMp7LMUtgbbdAnq8LzKo2903mr2JhnWRCdR/wnv6Yh2ollLHcRYS4uDw4rGInAhZGwbnyoRqczYmMJUQgQHohmvyAM1I5tN+ZGhAfGW0pFplRbKwpiGiCG+EeIFV2Kh/Dg1TERXHjYgZUHn8/eN/ymydxPDhrMfdDcnzYy9yYO3mIGhCa6kEJX3j5WFwVch33676sHh2VO8p0CuTEcpo7qQSGGjJPxCxbKGi6018EclMtRbt9PpdR1DRdo5uSuPmwGsEkFMWyPelXgx12dWoOnjxtKxLMv6NRqUqm/vzc42Nvq1VpygHz6UZCQXUiKNvOdSIo1a5q2Lp+7uHzuviIef06z6+DpsHFaeLxtc74nZtdwRd1gcP0cZtVbnVzX2TfDdbijZfOLWRjvzpb7v4atZUlwPx38A2wtd2XRFZPKZ2NK8rnsKes4cweDylYryp05NwT2V+feg89jfFk663zT0Aa/GYbcenBwN24NoVliudOI//d3b97N+n/4YSKPjo6OXr//MH3xYXJ0dJTD716vt9Ygt44NcBjQn901H7fFo7qwYZRer4fOeGroITbfK8TkW9s+3tym56LtfiUvwcGX9hLcXW5UVb/MnrXOJfDrSYa7rtkojmSBVyKleJlGh5G9cuiv/EUxko1p851M59HhdeQufcCfLggfmu591HBr8zrSyZTlFP7y5IZ7nmOeQVc2JEVHcYSBj3DpE9gxOozk6CNLTBRD6EQB1m6moQ9sd3jta9nLcVHsVP3oMLLLIYojF05QfSJMJBJis4p0HC1i7Om8oFrPpEq3dll9qbuEDizEn9hQ4x/VBUroBy6k3bIbbLpYuih7q57CHhY1XerOqFJ0Hi3fyfU30YrgqgFYRZwFL5v7/YgbsMdV16OwWhRH3LA8HGUD1ZX8dEwnTMJMMOD7NuQFGXSbdsVUils1dKGqt2n6UY7Ob8WONa3Pd8dxkwWaF8Ogl0rR8PeQqnBIF51WKAmXl3vkCG7osNRp64d13Bt4Nyq76aNDG2A5pXCD25CMUbBHieBmS/MO4CVnM+jhkLxjCeOXDrbwxjBUwZihb60XH/sWcumqIi2AsX1X0MbeZ3Lfm91+C+2XIaou01rJykSZg/irFoAFNYojPxSIwGB12nqLOHKArVmRO64hW7pK3yY1mxQh3XpCsb1V07tJnvj6uBboJBzT2kxXxjzedMU3uFnoLKu0KBhVPbxpe+tL35gkgGZJiVfYq123MbMK1Gpmg0UcXd08mSuSyK6/P0weZmxsbFgaSaQSTD0Kw4zvzeSG+/uLOJrfPL35Vzm9p0C82c2z+xEvXteX0v8RsD5+toij6c2w/r66Gv4PBHb/yaLWhCKb+qJKbjGS6fzcy63FTRW9ygH1ILHBS/FGpUwFiBhJmTEqVjABgdH2BPwAThEPYhsMindAudJe3SAzcLEouyNU+5EV1k6ltdfD/D068Bu+gA+ohetypKGW8P1p2+GIEaP4ZMLA4+JqYGN3Z5nRZAqZGlyIau0+LBS75LLUHjxww4AOkDGD+TPAp1sFaYfH9AA7QRC4nXsvpA58cdg85+JcQotzG5a+A1rxDvISYu1kLLwccqnI5AJuN8CadxlJfPYBv9mWwvAMr9IWgPvUx54DAnHXXZ4zxWC5HnkhxlIlTBMLcYDbGi14GsJTB9OQykOQBwF2HuDxKNMVcshzi0Mk6AO0dDQxhp8WcYQ5Zc7leJxxwZA1b8WHfp6gIutyBHHK1Ob6ANdylXLFpYzxBn2u6wQr7qq3u8ctCLuCAGqaESNlhidMe09boXay+wTt3fI3x293mBfalboWMHffGznf9kHeHL+F3Bl87E5+cC+gWh1+udFGFQInMXLJqb9fX+33c6uOMetOsfpUg596LmtFl6wClHK9FqLY5ggCFFZZglY6rpOxwLKVpQEvKHcXzbVhhd6CyGNZ7iKpbsAkJZMSrw8ZEOM+kQaGsde5L7iw2YjQxODucqxVrj2ePFagUtA/pAXStjklY/SGx5ChCDCvSjAoVF2yq4IpDlEna1GgmEUdZCm6WcNsnhc+vHvlUvAEN1S8XPUdwwIokGtQUqyImOWprx5xmADRt+lIt6qOYiyNO8YUTGkpwEIi1YQK/hfLwqilgoFlxKY0s1Xd9gGeOBRzwK8NYPz++8vf/h7AtfGMugqYHYGmKcRF3AAhWpEsw4MAUqyAXVE2IYL+mPrdsmIQVULQZnSyC0nvzuNv8VqGrkSgiyqoohp0mUzBJFDtwTqu7q+7o4ZGs1SV+EIWMF92xbUJkjr4s+WqfHjnbmDVMNhtKk2tLJ2HC7yOtpBL3WH6Cd5M71KpRqsbR2nkuWI5F7vpLqHp3shKEJRG5tTwhPiudK+ZtMd6lP26zusYI+DGSy7Vo7XgGZ6zY/m923Gf07m+WdGENqgdulYkpXPECGbwaqiN7Krgal7dk0RntcfkDaerAxQkMNlzKRIG+grkG9vhSBIEawFgI2ZmjIkQc56EstIWbKIQVBgaFFu6VNfAIUCYMzVh5wmcqnFNsB1I3OlAV50O6VpAnMTXpXKGXpeOC0UbSLm6dwDHJc6p7pTW6lKYBS1I0FaAfcTaBm3/gE+CkLtcMuEIdeo2zSDJSqCHwAUFXqeGc8FAyEo4m5fWtJdYOzP0AumjYJx425y8dK8uy1JIAeVH9xoPTA5MtIRmEle7ma7LfYNAvcTsP1PcHZF+4Mqy4/iUXKgl/fLX/9OghboQSt2DKWwsxZgr1B7xZmPYq19sfjk6487yahPS8PH8XIrzWsqtZZhmy60MtCZ+q6loCbdH4OBe3wJOB+4ARNs9Fv5p2q9W6Lt5MEDIZxrwtTQMjGsTqtKs2tMsGQ0mvqMhI9mhNnEDGuc2sB01hiZThgmDUlZA6jzpjgt2A35QJxkCeoL5iolz9JrsYnZzm/YioOZJBM4V9JikUWxdS9HZIo5GSXLbHmE//537jRt1jJ+GjW8ruTNHSUIeQg7IlCRUjaRNaPjo0KnqNIV1iGrYktbeIKpFPoqThv7Fg4Nrj1T/OSTa+MB1BsrtvgS/wduzAWZnzEdw2wBjHfEUjJqgrN0JTYvnr2Yy3Wb/dHF6rfXzKzIPDvr9f2br5+P+12P93O9/RdbPZwCs86ffLE02nT7Xyg4fH7C9wUfJrOcwk2p7TdiBwOntohnWIbheDsOF/a822HohfoMR11p5az+/M0D6ySAahv0+/LMkBL29y5vCwpTK/xLFuwcZ3CDR68TL2/F1dPnsbV6IPJmiJK+yMG9vFTJbsB/v2fbAev/hIeDpb5tj5Ezr5oaxZgCX/9psR1dIJS7QhOlJcL4UzWHJvL+OJu9lzqxSPYNNfqYkaGPudGHUnNAJHA+gG/UZScSUuomZPw2ybdjY7/fPBxUSDlaR8FLgrX5M5H0sL5j4sjMNhzd2eAD1Ks9qiRJxWwnLo8Zkw+92kpolpeJmHh2eXEdXXVrwri0/PDlbnAEXmqnEqB+pEWJqptFhtLcSBIT51EExPrmOcF1UzK+pSCEwdkXa0oLvXQ56w2gRL7dZK5231Gdl91ObaEMnXExuandW4+g90NGSqoGpWp0s+B8Y6JOOEGGtOOLAP1NGwRAEqAf2eFeHTr3wRPZBTevilFbClKKopu9yLJEPJWpEBy1vnGvifYJwnxMfa4PhM1X0TFTPMaoiXKIoiFmBH0EUShQtxZXUEQ+VVn5SM34VM+CV5gFqm8P9fVTLng5Qf3n8DFWD/SeLM0umwEmI4YMbPF3uUL3Op+OKAm9I44s167tPTTM3zjA0Kzdsu8um3Y1m1g1WVg9y05rovq4z4g0ONpnPDtZarVxX6y0UrjA8/q4/yrqT7O6n0uAwuIYPvP7T5AKI/QUueNxHLtjvIxc86zdUL0eDuodagUItqVKS3ARqRQi0nTNYn1yMJS5ux8JVxmMQvigcVhRmliUyrxIOdzq+yS9/+3vVqtOpDsrWPQZWjzelIoWcMTUubRbjccauMA0zNGM5lmk0r+HNVpqDbQTC6YRhE7ST4c3U2hdKElrQEc847C72hiCaX4MNyj5egbeN57J8oOzd20uWwaZU2ZyDhzDITKqLMbyuAVaYETghwULDxJSKxDo4rKREQz0c0Os8z9oogJpb2KQwiiaG5FTQCVraYxIiK2UZh+2EKDkC/5+WWWk9XIbyTCpraMYJYVgsIvHFVQFFqPWDIFJsCqvr0rm5dGzdjFbiuTcaRuDlLwAWDiY+I0kpwIltowVK8FJL47zMctyAEZobRYWGE4GzbTsaVAhzHiimnTHtg2ZA4VdcXNjE0V1yUvHVj2ykuWHNvFTLEuJRs80P3Py+HMGDAVJzI9W8bj3hZlqOcDsLO6l+2J5+8E9/BJvV7te831ujnN47evsS1aFH5Je//i95xagSZCpnlluTUrFs3nxlxFLeoq3SZtDHSUt4YcMgk4qJD8XwGPxxSg1aZl+zGZjA7ZKy4Xk/MFM/BfNvpPET7qxC2J5iubwEB6IQDEhD1Tx89AKfGqkM3048YYi9Pco742XdAiMDT5vb8mkU5Ce3tjQult+hiUlZpM0Prka93NCsWRWnio5N07aJr62g61rJ0lgG9vYyDw0itVDSWM9pkY490Ks74E6Q48hLwAfjY6+1Y925sOCignNQuQErSeXi4rmq3+hxAAYqw3rIaiexJlarRr9PA1EreL0R0SuUggkXS0ctO+EeOXLh9j5odW3EahxEocaNQNIeee/gz3eLaf2W2I702kDVb30sKpTTuetPzGvrqQ9mWIp24oo5G3wUL6u3zV0OPSKAO918OqjgbhGfeGFAmmn2Pl2YWGOGMNQGKHnliRZ8rYMaXlbRb8bvmbrkiT9/b5Cje1h5L4qjjCfMWVac1nD0w9tX5PJxrw9qS3Vo2EGk7r16+f2L1+9fADBAAouwQa/f66PZQGqTUxGMtPR+1bJGEVymaJ+7ap+7ap+7ap+7ap+7ap+7ap+7ap+7ap+7ap+7ap+7Wr1D3j531T531T53tQlF7XNX7XNX7XNX7XNX7XNX7XNX7XNX/6y5D9vnrtrnrjaJz/a5q/a5q/a5q3udd7V97qp97qp97qp97qp97qp97qp97mr77nMrJm2fu/r0jMvtc1ftc1ftc1ftc1ftc1fbV3D73FX73FX73FX73FX73FX73FX73FX73FX73FX73FX73FX73FX73FX73FX73NVX8dxVkH1ir8goxyQ6LteTzX9zsvwI1lkcTSFBzuFJdH0NLPlBZYsFfP65xKwbJ2dxdEkVhwh9zK0T+1QwkO/igkHKlO/t9ZHuMYwfW0LjbdellEKQy8a2sHePt9YNc/i8ffP+GJJ1uIe6cpliKjA6g/wYdGaTmARJNPDbdZRRMSkxAUdk+1zYxMbTZuqbC0x94/4IsnhAPpgawmZOHDsN+D9Mam2D62ubVmexqOrboo0tHGJ9baDf2WKx+H+e8T3u",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},b=void 0,y={},f=[];function w(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Public Template"}),"\n",(0,i.jsx)(o(),{method:"post",path:"/publictemplate",context:"endpoint"}),"\n",(0,i.jsxs)(n.p,{children:["The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique ",(0,i.jsx)(n.strong,{children:"template_id"})," and a ",(0,i.jsx)(n.strong,{children:"public_url"}),". The ",(0,i.jsx)(n.strong,{children:"public_url"})," is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing."]}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Unique identifier for this widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Specify the hint for widgets. This parameter is optional and is not applicable to the following widgets: checkbox, radio button, dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "hint": "Provide signature"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp",\n "hint": "Provide stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials",\n "hint": "Provide initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide email",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide name",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide job title",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide company",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12,\n "min_date": "",\n "max_date": "",\n "readonly": false,\n "signing_date": false,\n "hint": "Provide date"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"min_date:"})," Provide the minimum restriction date. The date must be in ",(0,i.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"max_date:"})," Provide the maximum restriction date. The date must be in ",(0,i.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"signing_date"}),": If signing_date is set to true, the signing date is shown to the signer during signing. You may set either signing_date or default, but not both. Using both is not supported."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,i.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"14",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Provide number",\n "formula": "",\n "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,i.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"decimalplaces:"})," Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"15",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"cells"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "cells",\n "page": 1,\n "x": 100,\n "y": 100,\n "w": 114,\n "h": 50,\n "options": {\n "name": "cells",\n "required": true,\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"cell_count:"})," Specify the number of cells that should be returned to the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,i.jsx)(n.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "required": true,\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "response": "04/15/2024",\n "format": "mm/dd/yyyy",\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "required": true,\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 528,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "values": ["male", "female", "other"],\n "response": "female",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,i.jsx)(g.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,i.jsx)(d(),{parameters:void 0}),"\n",(0,i.jsx)(p(),{...t(11580)}),"\n",(0,i.jsx)(u(),{...t(60966)})]})}function j(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(w,{...e})}):w(e)}},11580(e){e.exports=JSON.parse('{"title":"Body","body":{"content":{"application/json":{"schema":{"required":["file","signers","title"],"type":"object","properties":{"file":{"type":"string","format":"base64","example":"base64 encoded pdf"},"file_password":{"type":"string","format":"string","example":""},"title":{"type":"string","format":"string","example":"sample template"},"note":{"type":"string","format":"string","example":"sample note"},"description":{"type":"string","format":"string","example":"sample description"},"signers":{"type":"array","description":"You can provide signer optionally if you it as default signer","items":{"type":"object","properties":{"role":{"type":"string","format":"string","example":"ceo"},"email":{"type":"string","format":"string","example":""},"name":{"type":"string","format":"string","example":""},"phone":{"type":"string","format":"string","example":""},"company":{"type":"string","format":"string","example":""},"job_title":{"type":"string","format":"string","example":""},"signer_role":{"type":"string","format":"string","description":"Specifies the role of the recipient in the signing process. Allowed values:\\n- **signer** (default): Must have at least one signature widget.\\n- **viewer**: Receives the document to view only; must have no widgets.\\n- **approver**: Reviews and approves the document; no signature widget required.\\n","enum":["signer","viewer","approver"],"example":"signer"},"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Allowed values - signature, stamp.","format":"string","example":"signature"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":244},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":71},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":38},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":46}},"title":"createtemplate_body_widgets"}}},"title":"createtemplate_body_signers"}},"sendInOrder":{"type":"boolean","description":"If set to \'true\', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to \'true\'.","example":true},"send_in_order_strict":{"type":"boolean","description":"When set to \'true\', each signer is blocked from accessing the document until all preceding signers have completed their action. Enforces strict sequential signing. Only applies when \'sendInOrder\' is also \'true\'. Defaults to \'false\'.","example":false},"allow_offline_sign":{"type":"boolean","description":"If set to \'true\', signers can submit a copy of documents created from this template signed using an external tool for owner review. Defaults to \'false\'.","example":false},"enableOTP":{"type":"boolean","description":"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.","example":false},"enableTour":{"type":"boolean","description":"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.","example":false},"redirect_url":{"type":"string","description":"Specifies the URL where the signer will be redirected upon completing the document signing process.","example":""},"sender_name":{"type":"string","description":"The name of the person or organization on whose behalf the email is being sent.","example":"opensign\u2122"},"sender_email":{"type":"string","description":"The email address of the person or organization that users can reply to.","example":"mailer@opensignlabs.com"},"allow_modifications":{"type":"boolean","description":"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.","example":false},"auto_reminder":{"type":"boolean","description":"Set to true to enable automatic reminders. Set to false to disable them (default behavior).","example":false},"timeToCompleteDays":{"type":"number","description":"time to complete days is used to calculate expiry date of your document","format":"number","example":15},"remind_once_in_every":{"type":"number","description":"Number of days between reminders. This is only applicable when auto_reminder is set to true.","example":5},"merge_certificate":{"type":"boolean","description":"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\\n\\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\\n\\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\\n","example":false},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed. \\n"},"prefill":{"type":"object","description":"You can provide widgets which can embed before sending to signer","properties":{"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","format":"string","example":"textbox"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":100},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":30},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":40},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":80},"options":{"type":"object","properties":{"name":{"type":"string","example":"textbox"},"response":{"type":"string","example":"joe"},"color":{"type":"string","example":"red"},"fontsize":{"type":"number","example":12}}}}}}},"title":"prefill"}},"title":"createtemplate_body"}}},"required":true}}')},60966(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Template created successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"template_id":{"type":"string","example":"Av8Pmpnmch"},"public_url":{"type":"string","example":"https://app.example.com/publicsign?templateid=Av8Pmpnmch"},"message":{"type":"string","example":"Public template created successfully!"}},"title":"inline_response_publictemplate"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/044432a7.3e475826.js b/assets/js/044432a7.3e475826.js new file mode 100644 index 000000000..a0fef8463 --- /dev/null +++ b/assets/js/044432a7.3e475826.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[6800],{24159(e,n,t){t.r(n),t.d(n,{assets:()=>f,contentTitle:()=>y,default:()=>w,frontMatter:()=>g,metadata:()=>i,toc:()=>b});const i=JSON.parse('{"id":"API-docs/v1.2/publictemplate","title":"Public Template","description":"The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique **template_id** and a **public_url**. The **public_url** is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing.","source":"@site/docs/API-docs/v1.2/publictemplate.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/publictemplate","permalink":"/docs/API-docs/v1.2/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":"eJztPe1yHLeRr4IbX53EzexylyJlZX3JhZYUWxdbYolUXD6SIbEz2F2IM8AYwHC5obcqP1L3AFf35/7mJe7/PYqf5KobHzOzX/ySFTm1rkrEHXw1Go1Go7vRfR0ZOtJR/zg6YnmRUcN0dBpHKdOJ4oXhUkT96GjMyEE5yHhCfC2yf/CK0CyTE01KzZQmRpJEMSgyvidixtQQzdQlI1STQVayQnFhNBlKRUZMMEUNFyOSyqTMGRRMuBmTQrGUDblgKdFGlYkpFdMd8t2YCUJD94RrosskYVoPyyybuuHTmJixhU8xUyqhCSWl4D+UjLRavvEZT1stQkVKKGm1CpzcWamyVqtDYLrNbzCU/Z1NCcUh+SBj2D6nUzJgRI+pYqmFn4opIiUmTNBBBjM0Y5YDitykbVPNR6I29wHVLCVSIPwe0A75Wk7YJXRW/0y40SwbkoQKIQ0AkMuUDzlLiRkrWY7GxIy5Ju/efvMF4QbqESkyBLWEYWAF/NAWc1yKABUXo86JOBFHvOiTd0UmaUqmslTk4MXvq2ZGEvh23Gq9YINyRN69arVOH4+NKXR/e5sWRUcWTEB/GR3oTiLz7RQqFulwKyaTMVMMekXgGNUckJsCDtMRMxonLEgiiylJpFQpF0BUMSnoiBFR5gOmdGzXQCpGOBCHYjSdto1sl5qRfz988xommlPTIQdZqeMwXMoVSwwQDXQPmPWzemQX4uku0B4Xo5jk9AKWkBvyQ8mTC5i2ZiKFfx2lIa5arcOyKKQyLCXf2Sn0Wy0o+ZJlckKoYlg/kXkuBSmoojkzuHVgm0CxYj+UvCKjLPO46J+INmm1BM1Zv9Ui7yw585QJA4uucDlxwW2Djq1vpgXWfyVSnrgdyQh8JXLYrApIhaqHBUugS1u1hmogzMmYJ2PE4YTa9S8ymthpKaYLlhh+yZodX8VkCh2/YEJ6CMZS8T9LYWiGy3fJlOEJzerLDABCVW2oQh5RSC6M/+pGIN+75YTVxkV0dAigpYDcnAss0Yxc0qxk2kE1ickYoHrLCsU0bj/XL+7flIwZH41XjkfT96U2jY5Jqd1GD1C4sfyqInoZom1IM80IHzZwmdMLVhuNSOS/NOuQL6ckZUNaZiYmHCjUqJJ1yGtpCC2KjCcUuBHQAGw2CvyyjavsyKfTJJ8DJS95yoAxpnw4ZAo2MxRiF66Nhw7ossAGMD3caWaM3GRuoROZSbVIQvi5iUeSSGGYMB2yf0l5hsDbyWrCRZKVKSODjCYXMZ4ZMVHA1WFVpgyOnNjuD6wCB4vFOeKHaJYBFUoB8AvphoejwkGVAoMHfu73HxR6VOMgXNex6nb5UMLIgAK/JQnLKc9iRFxM3ssBMdxkLIYNXlAxjUlKDYuJYVdmIK9ikoxZcoF/KZpySQalMVLYiaVKFqmcCIfLoRRG8z8v2ZG+5O4Y3YnJbkyexuRZTHrdmPR2YtLbjUnvaUx6z2Ky043Jzk5MdnZjsvPUgrXzzOGaBgTXAejtWCybXxZ2xzxlZ9DwDOZ2RrVhiusLYNdWyMBj20sSUNGfyrC9WFqdgFyTMU9TJshQyZwolvCCIzex3CB0HQM8RMGkhCZWXrnkVopwOAidyokAvOGIXJE3BROHICnQJJElrDFi2CIV0VktOZzwUpAjRnONM38pDFOF4poBqxY6YECYirbsAQjf6gzgNispmhxo9WquWp3aysAJ+g3XyHPh6NPhNJ00TtNeh7Ragc/Bt/Pz8xNxfSIIOYmA7Z1EfXIShSonUWzL4DSDsp77fQU/nux87n5O4efTnWfu5wSr9nbdzzH83PFN3eaCbzgw1uDC2KEdgyU1EKDS7ETMHLQnYgenYWherJkCFH8s8P0xBR/hfIl9AWzBRXhWzNjWWJjtE5gtF9xwmunVE/Y1PqE5z4G0fNpVpYWZ78LMkZmtnjYWf0JzrsMDJXiI2iI8dGtF/jhAKHbWoGi+z1VMGFqheLSAyb2Ok2FWI9JO4ZPBYw2cD4XGuS7vjsWngEU4T4/gPF2NynDkfkL4nIfpQyF1Wb93x+znHZSCUTxZjVdX4RPCahOiD4XTxV7vjtFngFGQ81ajE0o/IVzWwIECJzTbsu5uu7fX3unu7DbwCeoJWyHP22nank6nD1uLnIszCwc0qtXP6dXyAtCagOwYViKUOGVQaNYsXVx1W29uIUHidJgAodPfP63UC8osFJ4XlQt4969quRsP/u0v5N/CNXzgb6gsdWJzdR8J+p/6HdrIlE4faduVbxquXlB/Xji2YGIRwIG6sGQseeKAhzr+wjUAdU8HcNDGRd1O0+3aosLHNG3neXvuI/xsIw3UPuZ5J007czUXCMV+zEmaxmTx89LvaUryPF/x2X5vfN7O88VZdPLcweaw52lvYZ1zLnhewhUJ1Gr2hp6ifvPIozd3a8kFabW+//7779vfftt+8aLV8mvohnBUXNNk2BHo1QcaoU70rVafvBqS+ifUJlg9DnKBcDNEVbavMJYT4S9EeG1UJC1BoRgUrKhNAvUxdMa4GTPVHAdUtJ5k4fqIml5pxh3yDm+X8Le/hYXbEt6kft1BXTdejVfzTlfhY7HPiks2B17LWlezpgZvXRCLPGMqlstNio3KjCp2Beo/zaVY4In3OQPvdr7NsUVPy5WqBRWLTrXLvKaDPH7jLuFbQb84NxfobZ8kpTaokxixK1JQY5gS2NklzXhq9f1t/MCuaF6AbmX7Tycn6a/+eRs1u6A8NValkPIRB4X89p+O99v/cbqkRlkUTCVUM5IxGEnHhJmkQ47HLCsqm8BkMulMnuhkLGVmDQLvtWJD+/9ncvD+DMEtOlQXW8tmaomhpkkFYplXpOLmrGGMauJbLtGl4tLgrul1UYJzqoo1Ipyr8QnJHXMgQaFVS0PxMRz9KNwC8bLqbwk85yQ6rY571J6y9Ia2p7fYnrAbMjpg2WLR3bdWRqeydDvaWwuaU3UUXcObE4WCQhin041rhfRqrtCWzZbsU4uQ+jb1p73fnn4FSMZ1OEga6Ky3djYDtPwIxtCYBFZE14AMApU+eBcEwG63DbyCFNfuhiGgHsGKwV7jR7thhMbCLJzkTlbwhqdh6NWjzB/kdXxBS7C6VmLCmhGcrLB6BLDyrB7gRPRQDenVl2vuJ67GJ8Qr5kBav43vw0UaJ/N9jtR7bUA/rfoGXHK8QlV7sIbNp1fvvg55Y3XqvhHo25OEFSBpPXhrBpBvfUKh1riuQl9NefVanxD1LQHrZ6ZAV+9Dnz73ItL67H9BhNoA+9bEapX+OR2t0d9g8SdEng6eBVVUD/X49rxYo3/G8vXT6XUb09lrTudp9x73qcawD79OdcPHJfrn+aHg5lxmdIHZpyzhOc3QQQTh3nnADrzP1coBBhT+XOZFaepbCpU2yDa8DODdHqzh9lcxacekFZPtmDyOyVaHvGXoKJEEpwonEnBlXSc4uHKVYAVNSgWOVgomHhPWGXXI9fUPJRWGm+lsRlrk+hp8wGazDuyxCyEn1q/iGCzChoBfVHVlSmWil/hRyURvw91q+zWbtF840/G2A22LPJZzG37tRdOh4OPetyxUNSKBUV4HgczeOdGRh+sio1NCh2CFts4e2Mz6BHUAxX2yQ37zW9Lb6XS7Menav8ljP8GdLdzDaEFKWLbOBInFN+3gbn0HVz+XMaS97q22cH3Ye+5g6OIMXQRw3BvFsWpzf4KKkWoy86rYmswOOHNOpmNZZimcjdbpkwX3vCCxt1oHig15ltW884j/5Pc0eDuxjOXOI8z55cFlBT0RuDAS9o131Wi1BmwowQsB3ANR7VdzA7Vj24O54eGB/pZSkTHVVouCmAaIwf8RfEXn/CE8eJVPBBcediDl3ofT9+38ukncT/caxL3XPJ9WEvcqCl6jBoQmupBCB2sfq4pqVId9+u+LF4d5SvKdwnKjO0zl1YNMDAkn4xeszmu40F4Gc1DOe7k9H0upqxrO0czxXd1vOrBJBT5sW53g+PFQo1bv8ycNIeLZRzRqNVepu7vd29tea9WaM4Dc/SpIyG2WFHXmt1pSrFmt6cbk8xCTz8N3xJMPqXbtfb7TuC08WXc4fyJq1/qOukHh+iHUqve6uS7Tb9b34S01mx9Nw/hwstz9OXQtc4z7897fQdfyUBJdUKl8MKIkH0qfsowyb6FQWatFeTDl1oH92al378MoX+buOr9uSIO/3qlT697ew6i1Ds0cyZ1E/I9fvnk76f7hq5Hc39/ff334bvzy3Wh/fz+H351OZ6lCbhkZ4DAgP7tnPu6IR3FhxSidTgeN8dTQPjbfLsToC9s+Xt2m47ztfiYrwd7HthI8nG+Eqh/nzFpmEvj5OMND92wUR7LAJ5FSvEqjfmSfHPonf1GMy8a0+VKm06h/HblHH/Cnc8KHptvvNbzavI50MmY5hb/8csM7zyHPoCvrkqKjOELHR3j0CeQY9SM5eM8SE8XgOlGAtptp6APb9a99Lfs4LoqdqB/1I7sdojhy7gThE2EikeCbVaTDaBZjT2cF1XoiVbq2y/Cl6hI6sBDfsaHGP8IDSugHHqTdsxtsOpt7KHuvnuo9zKp1qTqjStFpNP8m179EK2pPDUAr4jR42dSfR9yAPi48j8JqURxxw/L6KCtWXcm7YzphEmaCDt/3WV7gQfdpV4yluFdD56p6n6bv5eDsXuRYrfXZ7XHcJIHmwzDoJQga/h1ScId03mmFkvB4uUP24YUOS5203q/83sC6EfSmW33rYDmm8ILbkIxR0EeJ2suW5hvAS84m0EOfvGUJ45cOtvqLYaiCPkNfWCs+9i3k3FNFWgBh+66gjX3P5L43u/0C2s9DFB7TWs7KRJkD+wsbwIIaxZEfClhgbXfaerM4coAt2ZG33EO2dHF9m6vZXBHSriYU21c1nZv4ia+Pe4GO6mNanenCmEernvjWXhY6zSotCkZVB1/a3vvRNwYJoFlS4hP2cOo2ZhZADTPrzeLo6ubJXJFEtv37YfI4Y0Nj3dJIIpVgaqvuZvzJTG5nd3cWR9Obpzf9RU7vc1i8yc2z+w4fXleP0v8esD55Nouj8c2wfh2ehv8dgd19OqskociGvgjBLQYynZ55vjW7qaIXOaAeBDZ4Jd6olKkaIgZSZoyKBUyAY7S9AT+CW8Sj2DqD4htQrrQXN8gETCzKngjhPLLM2om09nmYf0cHdsOX8AGlcF0ONNQSvj9tOxwwYhQfjRhYXFwNbOzeLDOajCFSg3NRrcyHhWKXXJbagwdmGJABMmYwfgbYdIOTdv2aXsNOzQnczr1TXx344rB5xsWZhBZn1i39FmjFN8hziLWTsfByiKUikwt43QB73kUk8dEH/GFbCsMzfEpbAO5T73sOCMRTd37OFJ3lOuSlGEqVME0sxDXcVmjB2xDeOpiGUB6CPKph5xFejzIdkENeWBzigj5CTUcTY/hpFkcYU+ZMDocZFwxJ81506OcJIrIuB+CnTG2sDzAth5ArLmSMV+hzXQVYcU+93TtuQdgVOFDTjBgpM7xh2nfaCqWT20/Qvi1/c3Rwi3mhXqltAXPvvZHybR/kzdEBxM7gQ3fzg3cBYXf47UYbVQjcxMglp/59fTjvp1YcY9acYuWpBj11XNSKNlkEKOV6KUSxjREEKAxRghY6roKxwLaVpQErKHcPzbVhhV6DyCNZ3oZT3YBJSkYlPh8ywMZ9IA10Y69iX3BhoxGhisG95VgqXHs8eaxApVr/EBZI2+aUDNEaHkOEIsC8KkGhELpkVwVTHLxOlqJAMYs6iFJ0s4TZvC+8e/uNC8FTe6Hi+arvGDZAgVSDnGKBxcxPffGKwwSwvlVXukVxFH1p3DWmYEpLARoSqUZU8D9bEkYpFRQsAzamma3qjg+wxCGbA3ptAOPP35/++rcaXCvvqIuA2RFomoJfxA0QohbJEjwwIMUKOBVlEyLoj6nfzQsGUWCCNqKT3Uj69jR+gM8ydGCBzqsgeDXoMhmDSiCcwToO79fdVUOjWioEvpAFzJddcW1qQR383XKRP7x1L7AqGOwxlaaWl07rG7zytpBz3WH4Cd4M7xJEo8WDozTyTLGci9vJLnXVvZGBEZRG5tTwhPiudKcZtMdalP2+zisfI6DGSy7V1lLwDM/ZkXzuTtwXdKpvFjShDUqHrhVJ6RQxghG8GmIjuyq4moZ3kmis9pi84Xa1h4wEJnsmRcJAXoF4Y7e4ktSctQCwATMTxkQdc34JZZAWbKAQFBgaKzb3qK6BQ4AwZ2rEzhK4VeOeYLdY4lYLumq1SNsC4ji+LpVT9LpwXMjagMtVvQM4LnBOeFNaiUv1KGi1AG0F6EesbtD2D/gkCLmLJVMfoQrdphkEWanJIfBAgVeh4ZwzEJISzuaVVe0lVs8MvUD4KBgnXjcnz93DY1kKIaD86F7igcmBipbQTOJuN+NlsW8QqFcY/WeMpyOuH5iy7Dg+JBdKST/95X80SKHOhVJ3YAorS9HnCqVHfNlY79VvNr8dnXJnfrcJafhweibFWcXllhJMs+VaAlriv9UUtIQ7I3BwL28BpQN1AKLtGQv/NPVXC+u7ejBAyAca8LU0DJRrI6rSLJxpdhkNBr6jdUKyQ62iBlTOrSA7agxNxgwDBqWsgNB50l0X7AH8qAoyBOsJ6ismztBqchu1mzu0Z7XVPI7AuIIWkzSKrWkpOp3F0SBJ7tsjnOe/c7/xoI7x007j20LszEGSkMcQAzIlCVUDaQMabvWdqE5T2Icohs1J7Y1FtchHdtKQv3jt4toh4T+LxI89VZjpzz1HRx7W83GZ6nW9lcSLLvbWg3En8wG8o0AvTrzfo4wrK0NJU5f7symD12l2nQfiRq/7C1J89rrdf2S97pPuL0evu9v9Bel1nwGwzlPgZm6y6l69lHd4z4f1Dd5LZm2imVTra8LZCuZ856exDMHVdtiZ2f8qVbRn4jeop63+uvJgcKpVPxlEw063C//MMUGvyfNKvnqw6H+K4tu7T9zA0auQ0uvxtX/57CAvRJ6MkZOH+NLrW9WJrXb8btv2QHr/5iHg6W+aY+RM6+aBsWQAF9nbrEdXfZW4QOWsX4KzOT8Vu8y7y9bkUObMXhcmcLRPlAQ5092bjJoSOoKLD3SjPuASMaVuIua7QbYOG7vd7lkvIGFvEQmvBMYrwBDlR/KCiY870/rwxg4PoF7lWcVRIm4rYXnUmGz9u52kZkmpuJlG/ePr6KpNC9625f3j09kpUKEZS/RnkhohpmYc9aPtBfcmjBQPIv/xdYT7IhC/piIFl98FbksLvn3Z6+xEs3i+zVLuvKY+K9t3baINHXExuqndaYWjQ1hHu1QNTFXiZMH/wECedAtRrxVHHOhnzCiouAD1QB5vK6ewl36RvbvWMg+sBQesKKrWd95LyjtJNfye5g/OJZ5MNUemY+9FhI5BwS8oquYYBd+dKKp548CPmn9NFM15zFS+HEEqP64IP3hDeKG5h9Lmzu4uimWf91B+efIMRYPdp7NTu0w18yc6Rq6w4Tl1wTJrlSuq2XkaX6zBwn1qKvBxhnWFeUNrPa+0XqlAXqE/9iA39aTu6zL1ZG9vlWJwb6k+znW1XPfiCusX++WXdHdHv/0l9G61a1fHJVTjpaUmzYAPNNDMky7SzG4XaeZZtyGouRWreqjELZSpgkjlpluJTSAbncJu5mIokRU4gg+Rn4FVIyuZ33mfhejQP/31b6EaaHd+S1qtI3yhxERby1IljMAzYRtJOkNbJgbr/+kv/00GJc9s7OeUXbIMDhRIv6BK7YIMsBBGWndsFOb6uCN09MJg8eGqjoaz1FrL2piVgbB2ZfYH7gJScMhWAdoqMYIgVG9fHh4NywzzKpBD0BZV9tpGiHvIzCDglhsSjgDMEBPem6W0oaZEQ4ViYLnlEEsc3cismp9ZRTnYtlVN45DxIUumSWaRY9MwWMPkJROpVASM721ug1a3223457PPyFdWb0YOIWwhS+HrS9gvwccBDawJVWpqxw0nsNcwn9e4/TmxfB4HQZ/nWmGf/Cv0UH34bQhU0Gr99J//RY6/lpNGvpHmgLd/Xn5oJ6W39w9eobCyZdf/NcacU8zbEMFZesTFv4HOB+fSarlDmzBxyZUUgFrwLTy/9aF+jneoQkkjXTYDZx4eDiGujxiRDCgY3PLnluI5aHOe04IOeMZBNoLvP5Ln1LCRVFPyI/kO9PMhG4gkP56IH9vtNv4PqrZa/lG9brXIj+Q5SsXWBSQmZWGjzyt2KS8cTaUMbTRVBga/7BX5up5Dqh3s+cuSZylRrHRGpZA9x+fCaePz+BAG/YuQfQQcMaWCXTANljY3xCHLhm3YnzjEV54KIGdMe051qyu8BgcTccmN1coNIXWJ63QuB5AF/3CM2nqXHydsvYyLC9w+wuvS0Am/SnHisazo0JDvpLqAkWyP4JtSQYeWSI8TcGWGFtYbdMgFzbh2ljiUzX2/zyG9SOIW71vLJ3APOGASW04GUl4AiY0UzdHwh77TrpPfywzsWNjHGzTw6jpk7kVpYNMvFJDj0DbyfXzHBmMpL2wnzisW2VEbzXvsEpNv1BShmljKRAcTwkRqM5+47lCl6voyijPQo9q8AFYFDxIFuP1aFQOs4I/NrQGEjwaX12wCfMcfGJ/BtgGrCFNVlic3Bs1OxPlXL4/Itl+J7T5Pz3HE5ndY43PrXTQAW6A2itE8w1xOQA2KpaVI4YlULf+NTX2Ty0swSYkUstG4Z/mwtW2Ey0n1sN8brLKpVY25Fa06bLVC0p6gJsAEQ9azJZFCl7mNUQOzPnCScPtASWOdHsAG5rL5nAgoJ+cnTbH5JDr3XNvvc9BWWMvmRKoL7m1nTCRqWrhewZoc3vBL0T8R5wdvDo/IdlPzcU7+73/J+cG7BYzj51oDT4zb/Zoaol4Nd4uvtVAwNx4WAI8AlJ57/Lyx4i05dFsbtpaS2YkAu/j5yRIh2D8rIj9aK905aKBXTBRpaMlMwSZ/BRdhDp5BzjwPEoozvrvxAsPBQJbgJBcyZ3n4Dy19vJUZnAMgFJ07bnlO7DUa6cu+5gGL6PlJ/aIBKz3kDPStiZJao0AQMmYpWRqGlm7FrBO+pecQqaFvjx4YHZi9dRIo1cKB42A6J63gfY+sC2UG7wCw1gffsohz69h+XnGbOR/8ofROa9Ys75h0iIDh/NBtZ945Hrp7ToV7CSCmoTq7Aqy5o6Ny6eQKvTos80HWYg1Dz8EF7/Hz51sAnMuVciL2iWATQHuSVNh2274KeYH26PCGP7ijnJ/AjaFqJyvDeRyIIbbHhk1w5g/BsIrb9jwPi/my7uvDNJ5c1g8gwFgZsazJq43Ohfcw2n0D7w7DHMCDljSgIY+9w47dJdWO5+n5Vs09LYAG66Uwv5OpZ4xD7XOMB47lUoDZjDs3AAC3MFOC5izy+Pz49HzrCyLBcdK68wJqjSRcjJniZknXcyJYlYjoZSX/OTms9gX2BKjYwB1tUQY7tCIinnd3kBuDwBKuIM0e1uprQuuX78A6vtD4Jj3R+fyJ+0emILwLrNG/kC9pcjGhKtUYlIoajhLqFKpCYyAOmx1o4Cu2E1cxsxIwuezZrGm9Ti9cULyYoL0LCTiGXNqBnT9FLUuQtfMPPN6xVyHJQDF7aiZjKkawEUBGqB3UHBh/WiZ2LyC80HXIClQK60gAj0An3LnCpHOE8U4zuN59w8UFkkObHAcJ6js20NywZsDgeUxvYZvfl1lGvIyOG+6GS41t9hU3X5cDyPsmNTdSTatWI27G5QDXst42/HAdeFk6qG8fcpnCLo+YytH94pCpS57cMP1tSGunt7fQ82VOidjUDqBHDfAd3Uw9WXB37Tz2cJBmmOa7z8OajFCkRjW0U1HRgi91cMQpvBm6+TqN6vr5RnGU8YQ5+5XTtux/dfANuXzS6YK6J6hmb7GW29+8ev7y9eFLAMZtk6gf9TrdTheNM1KbnIraSHN3n3lNTO0x7iZd6iZd6iZd6iZd6iZd6iZd6iZd6iZd6iZd6iZd6iZd6mIMok261E261E261FUo2qRL3aRL3aRL3aRL3aRL3aRL3aRL/UeNnb1Jl7pJl7qKfW7SpW7SpW7SpX7Scfs36VI36VI36VI36VI36VI36VI36VLXnz73ItJNutS7Z+zYpEvdpEvdpEvdpEvdpEtdv4M36VI36VI36VI36VI36VI36VI36VI36VI36VI36VI36VI36VI36VI36VI36VJ/EelSa1G7touMcgxV6CJq2iiDx/NJVE/jaAxhCPvH0fU1kOQ7lc1m8PmHEmObHZ/G0SVVHDz0MYJh7APuQZywCwaB6Z7b5yPtIxg/tguNr13nAjdCxEDbYh/nvrZuPVIihMqAkGgu0WsuUwy4SicQV4xObKi4WvAx/HYdZVSMSgxcFtk+ZzYxxrgZYPACAwy6P2rRzyDqXgVhM/KgnQb8P0xqaYPraxu8cDYL9W3RyhYOsb42rN/pbDb7fyAO4X0=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Template","permalink":"/docs/API-docs/v1.2/createtemplate"},"next":{"title":"Get Template","permalink":"/docs/API-docs/v1.2/get-template"}}');var s=t(74848),r=t(28453),o=t(57742),l=t.n(o),a=t(78178),d=t.n(a),c=t(19624),h=t.n(c),p=t(96226),u=t.n(p),m=(t(77675),t(19365),t(51107)),x=t(21312);const g={id:"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:"eJztPe1yHLeRr4IbX53EzexylyJlZX3JhZYUWxdbYolUXD6SIbEz2F2IM8AYwHC5obcqP1L3AFf35/7mJe7/PYqf5KobHzOzX/ySFTm1rkrEHXw1Go1Go7vRfR0ZOtJR/zg6YnmRUcN0dBpHKdOJ4oXhUkT96GjMyEE5yHhCfC2yf/CK0CyTE01KzZQmRpJEMSgyvidixtQQzdQlI1STQVayQnFhNBlKRUZMMEUNFyOSyqTMGRRMuBmTQrGUDblgKdFGlYkpFdMd8t2YCUJD94RrosskYVoPyyybuuHTmJixhU8xUyqhCSWl4D+UjLRavvEZT1stQkVKKGm1CpzcWamyVqtDYLrNbzCU/Z1NCcUh+SBj2D6nUzJgRI+pYqmFn4opIiUmTNBBBjM0Y5YDitykbVPNR6I29wHVLCVSIPwe0A75Wk7YJXRW/0y40SwbkoQKIQ0AkMuUDzlLiRkrWY7GxIy5Ju/efvMF4QbqESkyBLWEYWAF/NAWc1yKABUXo86JOBFHvOiTd0UmaUqmslTk4MXvq2ZGEvh23Gq9YINyRN69arVOH4+NKXR/e5sWRUcWTEB/GR3oTiLz7RQqFulwKyaTMVMMekXgGNUckJsCDtMRMxonLEgiiylJpFQpF0BUMSnoiBFR5gOmdGzXQCpGOBCHYjSdto1sl5qRfz988xommlPTIQdZqeMwXMoVSwwQDXQPmPWzemQX4uku0B4Xo5jk9AKWkBvyQ8mTC5i2ZiKFfx2lIa5arcOyKKQyLCXf2Sn0Wy0o+ZJlckKoYlg/kXkuBSmoojkzuHVgm0CxYj+UvCKjLPO46J+INmm1BM1Zv9Ui7yw585QJA4uucDlxwW2Djq1vpgXWfyVSnrgdyQh8JXLYrApIhaqHBUugS1u1hmogzMmYJ2PE4YTa9S8ymthpKaYLlhh+yZodX8VkCh2/YEJ6CMZS8T9LYWiGy3fJlOEJzerLDABCVW2oQh5RSC6M/+pGIN+75YTVxkV0dAigpYDcnAss0Yxc0qxk2kE1ickYoHrLCsU0bj/XL+7flIwZH41XjkfT96U2jY5Jqd1GD1C4sfyqInoZom1IM80IHzZwmdMLVhuNSOS/NOuQL6ckZUNaZiYmHCjUqJJ1yGtpCC2KjCcUuBHQAGw2CvyyjavsyKfTJJ8DJS95yoAxpnw4ZAo2MxRiF66Nhw7ossAGMD3caWaM3GRuoROZSbVIQvi5iUeSSGGYMB2yf0l5hsDbyWrCRZKVKSODjCYXMZ4ZMVHA1WFVpgyOnNjuD6wCB4vFOeKHaJYBFUoB8AvphoejwkGVAoMHfu73HxR6VOMgXNex6nb5UMLIgAK/JQnLKc9iRFxM3ssBMdxkLIYNXlAxjUlKDYuJYVdmIK9ikoxZcoF/KZpySQalMVLYiaVKFqmcCIfLoRRG8z8v2ZG+5O4Y3YnJbkyexuRZTHrdmPR2YtLbjUnvaUx6z2Ky043Jzk5MdnZjsvPUgrXzzOGaBgTXAejtWCybXxZ2xzxlZ9DwDOZ2RrVhiusLYNdWyMBj20sSUNGfyrC9WFqdgFyTMU9TJshQyZwolvCCIzex3CB0HQM8RMGkhCZWXrnkVopwOAidyokAvOGIXJE3BROHICnQJJElrDFi2CIV0VktOZzwUpAjRnONM38pDFOF4poBqxY6YECYirbsAQjf6gzgNispmhxo9WquWp3aysAJ+g3XyHPh6NPhNJ00TtNeh7Ragc/Bt/Pz8xNxfSIIOYmA7Z1EfXIShSonUWzL4DSDsp77fQU/nux87n5O4efTnWfu5wSr9nbdzzH83PFN3eaCbzgw1uDC2KEdgyU1EKDS7ETMHLQnYgenYWherJkCFH8s8P0xBR/hfIl9AWzBRXhWzNjWWJjtE5gtF9xwmunVE/Y1PqE5z4G0fNpVpYWZ78LMkZmtnjYWf0JzrsMDJXiI2iI8dGtF/jhAKHbWoGi+z1VMGFqheLSAyb2Ok2FWI9JO4ZPBYw2cD4XGuS7vjsWngEU4T4/gPF2NynDkfkL4nIfpQyF1Wb93x+znHZSCUTxZjVdX4RPCahOiD4XTxV7vjtFngFGQ81ajE0o/IVzWwIECJzTbsu5uu7fX3unu7DbwCeoJWyHP22nank6nD1uLnIszCwc0qtXP6dXyAtCagOwYViKUOGVQaNYsXVx1W29uIUHidJgAodPfP63UC8osFJ4XlQt4969quRsP/u0v5N/CNXzgb6gsdWJzdR8J+p/6HdrIlE4faduVbxquXlB/Xji2YGIRwIG6sGQseeKAhzr+wjUAdU8HcNDGRd1O0+3aosLHNG3neXvuI/xsIw3UPuZ5J007czUXCMV+zEmaxmTx89LvaUryPF/x2X5vfN7O88VZdPLcweaw52lvYZ1zLnhewhUJ1Gr2hp6ifvPIozd3a8kFabW+//7779vfftt+8aLV8mvohnBUXNNk2BHo1QcaoU70rVafvBqS+ifUJlg9DnKBcDNEVbavMJYT4S9EeG1UJC1BoRgUrKhNAvUxdMa4GTPVHAdUtJ5k4fqIml5pxh3yDm+X8Le/hYXbEt6kft1BXTdejVfzTlfhY7HPiks2B17LWlezpgZvXRCLPGMqlstNio3KjCp2Beo/zaVY4In3OQPvdr7NsUVPy5WqBRWLTrXLvKaDPH7jLuFbQb84NxfobZ8kpTaokxixK1JQY5gS2NklzXhq9f1t/MCuaF6AbmX7Tycn6a/+eRs1u6A8NValkPIRB4X89p+O99v/cbqkRlkUTCVUM5IxGEnHhJmkQ47HLCsqm8BkMulMnuhkLGVmDQLvtWJD+/9ncvD+DMEtOlQXW8tmaomhpkkFYplXpOLmrGGMauJbLtGl4tLgrul1UYJzqoo1Ipyr8QnJHXMgQaFVS0PxMRz9KNwC8bLqbwk85yQ6rY571J6y9Ia2p7fYnrAbMjpg2WLR3bdWRqeydDvaWwuaU3UUXcObE4WCQhin041rhfRqrtCWzZbsU4uQ+jb1p73fnn4FSMZ1OEga6Ky3djYDtPwIxtCYBFZE14AMApU+eBcEwG63DbyCFNfuhiGgHsGKwV7jR7thhMbCLJzkTlbwhqdh6NWjzB/kdXxBS7C6VmLCmhGcrLB6BLDyrB7gRPRQDenVl2vuJ67GJ8Qr5kBav43vw0UaJ/N9jtR7bUA/rfoGXHK8QlV7sIbNp1fvvg55Y3XqvhHo25OEFSBpPXhrBpBvfUKh1riuQl9NefVanxD1LQHrZ6ZAV+9Dnz73ItL67H9BhNoA+9bEapX+OR2t0d9g8SdEng6eBVVUD/X49rxYo3/G8vXT6XUb09lrTudp9x73qcawD79OdcPHJfrn+aHg5lxmdIHZpyzhOc3QQQTh3nnADrzP1coBBhT+XOZFaepbCpU2yDa8DODdHqzh9lcxacekFZPtmDyOyVaHvGXoKJEEpwonEnBlXSc4uHKVYAVNSgWOVgomHhPWGXXI9fUPJRWGm+lsRlrk+hp8wGazDuyxCyEn1q/iGCzChoBfVHVlSmWil/hRyURvw91q+zWbtF840/G2A22LPJZzG37tRdOh4OPetyxUNSKBUV4HgczeOdGRh+sio1NCh2CFts4e2Mz6BHUAxX2yQ37zW9Lb6XS7Menav8ljP8GdLdzDaEFKWLbOBInFN+3gbn0HVz+XMaS97q22cH3Ye+5g6OIMXQRw3BvFsWpzf4KKkWoy86rYmswOOHNOpmNZZimcjdbpkwX3vCCxt1oHig15ltW884j/5Pc0eDuxjOXOI8z55cFlBT0RuDAS9o131Wi1BmwowQsB3ANR7VdzA7Vj24O54eGB/pZSkTHVVouCmAaIwf8RfEXn/CE8eJVPBBcediDl3ofT9+38ukncT/caxL3XPJ9WEvcqCl6jBoQmupBCB2sfq4pqVId9+u+LF4d5SvKdwnKjO0zl1YNMDAkn4xeszmu40F4Gc1DOe7k9H0upqxrO0czxXd1vOrBJBT5sW53g+PFQo1bv8ycNIeLZRzRqNVepu7vd29tea9WaM4Dc/SpIyG2WFHXmt1pSrFmt6cbk8xCTz8N3xJMPqXbtfb7TuC08WXc4fyJq1/qOukHh+iHUqve6uS7Tb9b34S01mx9Nw/hwstz9OXQtc4z7897fQdfyUBJdUKl8MKIkH0qfsowyb6FQWatFeTDl1oH92al378MoX+buOr9uSIO/3qlT697ew6i1Ds0cyZ1E/I9fvnk76f7hq5Hc39/ff334bvzy3Wh/fz+H351OZ6lCbhkZ4DAgP7tnPu6IR3FhxSidTgeN8dTQPjbfLsToC9s+Xt2m47ztfiYrwd7HthI8nG+Eqh/nzFpmEvj5OMND92wUR7LAJ5FSvEqjfmSfHPonf1GMy8a0+VKm06h/HblHH/Cnc8KHptvvNbzavI50MmY5hb/8csM7zyHPoCvrkqKjOELHR3j0CeQY9SM5eM8SE8XgOlGAtptp6APb9a99Lfs4LoqdqB/1I7sdojhy7gThE2EikeCbVaTDaBZjT2cF1XoiVbq2y/Cl6hI6sBDfsaHGP8IDSugHHqTdsxtsOpt7KHuvnuo9zKp1qTqjStFpNP8m179EK2pPDUAr4jR42dSfR9yAPi48j8JqURxxw/L6KCtWXcm7YzphEmaCDt/3WV7gQfdpV4yluFdD56p6n6bv5eDsXuRYrfXZ7XHcJIHmwzDoJQga/h1ScId03mmFkvB4uUP24YUOS5203q/83sC6EfSmW33rYDmm8ILbkIxR0EeJ2suW5hvAS84m0EOfvGUJ45cOtvqLYaiCPkNfWCs+9i3k3FNFWgBh+66gjX3P5L43u/0C2s9DFB7TWs7KRJkD+wsbwIIaxZEfClhgbXfaerM4coAt2ZG33EO2dHF9m6vZXBHSriYU21c1nZv4ia+Pe4GO6mNanenCmEernvjWXhY6zSotCkZVB1/a3vvRNwYJoFlS4hP2cOo2ZhZADTPrzeLo6ubJXJFEtv37YfI4Y0Nj3dJIIpVgaqvuZvzJTG5nd3cWR9Obpzf9RU7vc1i8yc2z+w4fXleP0v8esD55Nouj8c2wfh2ehv8dgd19OqskociGvgjBLQYynZ55vjW7qaIXOaAeBDZ4Jd6olKkaIgZSZoyKBUyAY7S9AT+CW8Sj2DqD4htQrrQXN8gETCzKngjhPLLM2om09nmYf0cHdsOX8AGlcF0ONNQSvj9tOxwwYhQfjRhYXFwNbOzeLDOajCFSg3NRrcyHhWKXXJbagwdmGJABMmYwfgbYdIOTdv2aXsNOzQnczr1TXx344rB5xsWZhBZn1i39FmjFN8hziLWTsfByiKUikwt43QB73kUk8dEH/GFbCsMzfEpbAO5T73sOCMRTd37OFJ3lOuSlGEqVME0sxDXcVmjB2xDeOpiGUB6CPKph5xFejzIdkENeWBzigj5CTUcTY/hpFkcYU+ZMDocZFwxJ81506OcJIrIuB+CnTG2sDzAth5ArLmSMV+hzXQVYcU+93TtuQdgVOFDTjBgpM7xh2nfaCqWT20/Qvi1/c3Rwi3mhXqltAXPvvZHybR/kzdEBxM7gQ3fzg3cBYXf47UYbVQjcxMglp/59fTjvp1YcY9acYuWpBj11XNSKNlkEKOV6KUSxjREEKAxRghY6roKxwLaVpQErKHcPzbVhhV6DyCNZ3oZT3YBJSkYlPh8ywMZ9IA10Y69iX3BhoxGhisG95VgqXHs8eaxApVr/EBZI2+aUDNEaHkOEIsC8KkGhELpkVwVTHLxOlqJAMYs6iFJ0s4TZvC+8e/uNC8FTe6Hi+arvGDZAgVSDnGKBxcxPffGKwwSwvlVXukVxFH1p3DWmYEpLARoSqUZU8D9bEkYpFRQsAzamma3qjg+wxCGbA3ptAOPP35/++rcaXCvvqIuA2RFomoJfxA0QohbJEjwwIMUKOBVlEyLoj6nfzQsGUWCCNqKT3Uj69jR+gM8ydGCBzqsgeDXoMhmDSiCcwToO79fdVUOjWioEvpAFzJddcW1qQR383XKRP7x1L7AqGOwxlaaWl07rG7zytpBz3WH4Cd4M7xJEo8WDozTyTLGci9vJLnXVvZGBEZRG5tTwhPiudKcZtMdalP2+zisfI6DGSy7V1lLwDM/ZkXzuTtwXdKpvFjShDUqHrhVJ6RQxghG8GmIjuyq4moZ3kmis9pi84Xa1h4wEJnsmRcJAXoF4Y7e4ktSctQCwATMTxkQdc34JZZAWbKAQFBgaKzb3qK6BQ4AwZ2rEzhK4VeOeYLdY4lYLumq1SNsC4ji+LpVT9LpwXMjagMtVvQM4LnBOeFNaiUv1KGi1AG0F6EesbtD2D/gkCLmLJVMfoQrdphkEWanJIfBAgVeh4ZwzEJISzuaVVe0lVs8MvUD4KBgnXjcnz93DY1kKIaD86F7igcmBipbQTOJuN+NlsW8QqFcY/WeMpyOuH5iy7Dg+JBdKST/95X80SKHOhVJ3YAorS9HnCqVHfNlY79VvNr8dnXJnfrcJafhweibFWcXllhJMs+VaAlriv9UUtIQ7I3BwL28BpQN1AKLtGQv/NPVXC+u7ejBAyAca8LU0DJRrI6rSLJxpdhkNBr6jdUKyQ62iBlTOrSA7agxNxgwDBqWsgNB50l0X7AH8qAoyBOsJ6ismztBqchu1mzu0Z7XVPI7AuIIWkzSKrWkpOp3F0SBJ7tsjnOe/c7/xoI7x007j20LszEGSkMcQAzIlCVUDaQMabvWdqE5T2Icohs1J7Y1FtchHdtKQv3jt4toh4T+LxI89VZjpzz1HRx7W83GZ6nW9lcSLLvbWg3En8wG8o0AvTrzfo4wrK0NJU5f7symD12l2nQfiRq/7C1J89rrdf2S97pPuL0evu9v9Bel1nwGwzlPgZm6y6l69lHd4z4f1Dd5LZm2imVTra8LZCuZ856exDMHVdtiZ2f8qVbRn4jeop63+uvJgcKpVPxlEw063C//MMUGvyfNKvnqw6H+K4tu7T9zA0auQ0uvxtX/57CAvRJ6MkZOH+NLrW9WJrXb8btv2QHr/5iHg6W+aY+RM6+aBsWQAF9nbrEdXfZW4QOWsX4KzOT8Vu8y7y9bkUObMXhcmcLRPlAQ5092bjJoSOoKLD3SjPuASMaVuIua7QbYOG7vd7lkvIGFvEQmvBMYrwBDlR/KCiY870/rwxg4PoF7lWcVRIm4rYXnUmGz9u52kZkmpuJlG/ePr6KpNC9625f3j09kpUKEZS/RnkhohpmYc9aPtBfcmjBQPIv/xdYT7IhC/piIFl98FbksLvn3Z6+xEs3i+zVLuvKY+K9t3baINHXExuqndaYWjQ1hHu1QNTFXiZMH/wECedAtRrxVHHOhnzCiouAD1QB5vK6ewl36RvbvWMg+sBQesKKrWd95LyjtJNfye5g/OJZ5MNUemY+9FhI5BwS8oquYYBd+dKKp548CPmn9NFM15zFS+HEEqP64IP3hDeKG5h9Lmzu4uimWf91B+efIMRYPdp7NTu0w18yc6Rq6w4Tl1wTJrlSuq2XkaX6zBwn1qKvBxhnWFeUNrPa+0XqlAXqE/9iA39aTu6zL1ZG9vlWJwb6k+znW1XPfiCusX++WXdHdHv/0l9G61a1fHJVTjpaUmzYAPNNDMky7SzG4XaeZZtyGouRWreqjELZSpgkjlpluJTSAbncJu5mIokRU4gg+Rn4FVIyuZ33mfhejQP/31b6EaaHd+S1qtI3yhxERby1IljMAzYRtJOkNbJgbr/+kv/00GJc9s7OeUXbIMDhRIv6BK7YIMsBBGWndsFOb6uCN09MJg8eGqjoaz1FrL2piVgbB2ZfYH7gJScMhWAdoqMYIgVG9fHh4NywzzKpBD0BZV9tpGiHvIzCDglhsSjgDMEBPem6W0oaZEQ4ViYLnlEEsc3cismp9ZRTnYtlVN45DxIUumSWaRY9MwWMPkJROpVASM721ug1a3223457PPyFdWb0YOIWwhS+HrS9gvwccBDawJVWpqxw0nsNcwn9e4/TmxfB4HQZ/nWmGf/Cv0UH34bQhU0Gr99J//RY6/lpNGvpHmgLd/Xn5oJ6W39w9eobCyZdf/NcacU8zbEMFZesTFv4HOB+fSarlDmzBxyZUUgFrwLTy/9aF+jneoQkkjXTYDZx4eDiGujxiRDCgY3PLnluI5aHOe04IOeMZBNoLvP5Ln1LCRVFPyI/kO9PMhG4gkP56IH9vtNv4PqrZa/lG9brXIj+Q5SsXWBSQmZWGjzyt2KS8cTaUMbTRVBga/7BX5up5Dqh3s+cuSZylRrHRGpZA9x+fCaePz+BAG/YuQfQQcMaWCXTANljY3xCHLhm3YnzjEV54KIGdMe051qyu8BgcTccmN1coNIXWJ63QuB5AF/3CM2nqXHydsvYyLC9w+wuvS0Am/SnHisazo0JDvpLqAkWyP4JtSQYeWSI8TcGWGFtYbdMgFzbh2ljiUzX2/zyG9SOIW71vLJ3APOGASW04GUl4AiY0UzdHwh77TrpPfywzsWNjHGzTw6jpk7kVpYNMvFJDj0DbyfXzHBmMpL2wnzisW2VEbzXvsEpNv1BShmljKRAcTwkRqM5+47lCl6voyijPQo9q8AFYFDxIFuP1aFQOs4I/NrQGEjwaX12wCfMcfGJ/BtgGrCFNVlic3Bs1OxPlXL4/Itl+J7T5Pz3HE5ndY43PrXTQAW6A2itE8w1xOQA2KpaVI4YlULf+NTX2Ty0swSYkUstG4Z/mwtW2Ey0n1sN8brLKpVY25Fa06bLVC0p6gJsAEQ9azJZFCl7mNUQOzPnCScPtASWOdHsAG5rL5nAgoJ+cnTbH5JDr3XNvvc9BWWMvmRKoL7m1nTCRqWrhewZoc3vBL0T8R5wdvDo/IdlPzcU7+73/J+cG7BYzj51oDT4zb/Zoaol4Nd4uvtVAwNx4WAI8AlJ57/Lyx4i05dFsbtpaS2YkAu/j5yRIh2D8rIj9aK905aKBXTBRpaMlMwSZ/BRdhDp5BzjwPEoozvrvxAsPBQJbgJBcyZ3n4Dy19vJUZnAMgFJ07bnlO7DUa6cu+5gGL6PlJ/aIBKz3kDPStiZJao0AQMmYpWRqGlm7FrBO+pecQqaFvjx4YHZi9dRIo1cKB42A6J63gfY+sC2UG7wCw1gffsohz69h+XnGbOR/8ofROa9Ys75h0iIDh/NBtZ945Hrp7ToV7CSCmoTq7Aqy5o6Ny6eQKvTos80HWYg1Dz8EF7/Hz51sAnMuVciL2iWATQHuSVNh2274KeYH26PCGP7ijnJ/AjaFqJyvDeRyIIbbHhk1w5g/BsIrb9jwPi/my7uvDNJ5c1g8gwFgZsazJq43Ohfcw2n0D7w7DHMCDljSgIY+9w47dJdWO5+n5Vs09LYAG66Uwv5OpZ4xD7XOMB47lUoDZjDs3AAC3MFOC5izy+Pz49HzrCyLBcdK68wJqjSRcjJniZknXcyJYlYjoZSX/OTms9gX2BKjYwB1tUQY7tCIinnd3kBuDwBKuIM0e1uprQuuX78A6vtD4Jj3R+fyJ+0emILwLrNG/kC9pcjGhKtUYlIoajhLqFKpCYyAOmx1o4Cu2E1cxsxIwuezZrGm9Ti9cULyYoL0LCTiGXNqBnT9FLUuQtfMPPN6xVyHJQDF7aiZjKkawEUBGqB3UHBh/WiZ2LyC80HXIClQK60gAj0An3LnCpHOE8U4zuN59w8UFkkObHAcJ6js20NywZsDgeUxvYZvfl1lGvIyOG+6GS41t9hU3X5cDyPsmNTdSTatWI27G5QDXst42/HAdeFk6qG8fcpnCLo+YytH94pCpS57cMP1tSGunt7fQ82VOidjUDqBHDfAd3Uw9WXB37Tz2cJBmmOa7z8OajFCkRjW0U1HRgi91cMQpvBm6+TqN6vr5RnGU8YQ5+5XTtux/dfANuXzS6YK6J6hmb7GW29+8ev7y9eFLAMZtk6gf9TrdTheNM1KbnIraSHN3n3lNTO0x7iZd6iZd6iZd6iZd6iZd6iZd6iZd6iZd6iZd6iZd6iZd6mIMok261E261E261FUo2qRL3aRL3aRL3aRL3aRL3aRL3aRL/UeNnb1Jl7pJl7qKfW7SpW7SpW7SpX7Scfs36VI36VI36VI36VI36VI36VI36VLXnz73ItJNutS7Z+zYpEvdpEvdpEvdpEvdpEtdv4M36VI36VI36VI36VI36VI36VI36VI36VI36VI36VI36VI36VI36VI36VI36VJ/EelSa1G7touMcgxV6CJq2iiDx/NJVE/jaAxhCPvH0fU1kOQ7lc1m8PmHEmObHZ/G0SVVHDz0MYJh7APuQZywCwaB6Z7b5yPtIxg/tguNr13nAjdCxEDbYh/nvrZuPVIihMqAkGgu0WsuUwy4SicQV4xObKi4WvAx/HYdZVSMSgxcFtk+ZzYxxrgZYPACAwy6P2rRzyDqXgVhM/KgnQb8P0xqaYPraxu8cDYL9W3RyhYOsb42rN/pbDb7fyAO4X0=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},y=void 0,f={},b=[];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:"Public Template"}),"\n",(0,s.jsx)(l(),{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:"name:"})," Unique identifier for this widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Specify the hint for widgets. This parameter is optional and is not applicable to the following widgets: checkbox, radio button, dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "hint": "Provide signature"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp",\n "hint": "Provide stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials",\n "hint": "Provide initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide email",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide name",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide job title",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide company",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12,\n "min_date": "",\n "max_date": "",\n "readonly": false,\n "signing_date": false,\n "hint": "Provide date"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"min_date:"})," Provide the minimum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"max_date:"})," Provide the maximum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"signing_date"}),": If signing_date is set to true, the signing date is shown to the signer during signing. You may set either signing_date or default, but not both. Using both is not supported."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"14",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Provide number",\n "formula": "",\n "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,s.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"decimalplaces:"})," Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"15",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"cells"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "cells",\n "page": 1,\n "x": 100,\n "y": 100,\n "w": 114,\n "h": 50,\n "options": {\n "name": "cells",\n "required": true,\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"cell_count:"})," Specify the number of cells that should be returned to the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,s.jsx)(n.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "required": true,\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "response": "04/15/2024",\n "format": "mm/dd/yyyy",\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "required": true,\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 528,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "values": ["male", "female", "other"],\n "response": "female",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(x.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(h(),{...t(11580)}),"\n",(0,s.jsx)(u(),{...t(60966)})]})}function w(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(j,{...e})}):j(e)}},11580(e){e.exports=JSON.parse('{"title":"Body","body":{"content":{"application/json":{"schema":{"required":["file","signers","title"],"type":"object","properties":{"file":{"type":"string","format":"base64","example":"base64 encoded pdf"},"file_password":{"type":"string","format":"string","example":""},"title":{"type":"string","format":"string","example":"sample template"},"note":{"type":"string","format":"string","example":"sample note"},"description":{"type":"string","format":"string","example":"sample description"},"signers":{"type":"array","description":"You can provide signer optionally if you it as default signer","items":{"type":"object","properties":{"role":{"type":"string","format":"string","example":"ceo"},"email":{"type":"string","format":"string","example":""},"name":{"type":"string","format":"string","example":""},"phone":{"type":"string","format":"string","example":""},"company":{"type":"string","format":"string","example":""},"job_title":{"type":"string","format":"string","example":""},"signer_role":{"type":"string","format":"string","description":"Specifies the role of the recipient in the signing process. Allowed values:\\n- **signer** (default): Must have at least one signature widget.\\n- **viewer**: Receives the document to view only; must have no widgets.\\n- **approver**: Reviews and approves the document; no signature widget required.\\n","enum":["signer","viewer","approver"],"example":"signer"},"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Allowed values - signature, stamp.","format":"string","example":"signature"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":244},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":71},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":38},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":46}},"title":"createtemplate_body_widgets"}}},"title":"createtemplate_body_signers"}},"sendInOrder":{"type":"boolean","description":"If set to \'true\', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to \'true\'.","example":true},"send_in_order_strict":{"type":"boolean","description":"When set to \'true\', each signer is blocked from accessing the document until all preceding signers have completed their action. Enforces strict sequential signing. Only applies when \'sendInOrder\' is also \'true\'. Defaults to \'false\'.","example":false},"allow_offline_sign":{"type":"boolean","description":"If set to \'true\', signers can submit a copy of documents created from this template signed using an external tool for owner review. Defaults to \'false\'.","example":false},"enableOTP":{"type":"boolean","description":"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.","example":false},"enableTour":{"type":"boolean","description":"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.","example":false},"redirect_url":{"type":"string","description":"Specifies the URL where the signer will be redirected upon completing the document signing process.","example":""},"sender_name":{"type":"string","description":"The name of the person or organization on whose behalf the email is being sent.","example":"opensign\u2122"},"sender_email":{"type":"string","description":"The email address of the person or organization that users can reply to.","example":"mailer@opensignlabs.com"},"allow_modifications":{"type":"boolean","description":"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.","example":false},"auto_reminder":{"type":"boolean","description":"Set to true to enable automatic reminders. Set to false to disable them (default behavior).","example":false},"timeToCompleteDays":{"type":"number","description":"time to complete days is used to calculate expiry date of your document","format":"number","example":15},"remind_once_in_every":{"type":"number","description":"Number of days between reminders. This is only applicable when auto_reminder is set to true.","example":5},"merge_certificate":{"type":"boolean","description":"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\\n\\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\\n\\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\\n","example":false},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed. \\n"},"cc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"cc (carbon copy): Users added here will receive a notification email once the document is completed.\\n"},"prefill":{"type":"object","description":"You can provide widgets which can embed before sending to signer","properties":{"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","format":"string","example":"textbox"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":100},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":30},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":40},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":80},"options":{"type":"object","properties":{"name":{"type":"string","example":"textbox"},"response":{"type":"string","example":"joe"},"color":{"type":"string","example":"red"},"fontsize":{"type":"number","example":12}}}}}}},"title":"prefill"}},"title":"createtemplate_body"}}},"required":true}}')},60966(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Template created successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"template_id":{"type":"string","example":"Av8Pmpnmch"},"public_url":{"type":"string","example":"https://app.example.com/publicsign?templateid=Av8Pmpnmch"},"message":{"type":"string","example":"Public template created successfully!"}},"title":"inline_response_publictemplate"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/0ba00a8d.36e4dd53.js b/assets/js/0ba00a8d.36e4dd53.js new file mode 100644 index 000000000..91b8f1594 --- /dev/null +++ b/assets/js/0ba00a8d.36e4dd53.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[2815],{80832(e,o,t){t.r(o),t.d(o,{assets:()=>v,contentTitle:()=>c,default:()=>O,frontMatter:()=>A,metadata:()=>n,toc:()=>I});const n=JSON.parse('{"id":"API-docs/v1.2/get-webhook","title":"Get Webhook","description":"The Get Webhook API allow you to get webhook url","source":"@site/docs/API-docs/v1.2/get-webhook.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/get-webhook","permalink":"/docs/API-docs/v1.2/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":"eJy9WF9vG8cR/yrTM1BYxJGU0xQFmCKNIyuOUTcWTKl+EAXdcm/I23Bv9zK7dxQhEchD0Q9Q9KWv/RJ970fxJylm9+74R4mdNEUfbEl7s/N/fjM794kXS5dMrpN3OC+sXSU3aZKjk6Qqr6xJJsllgfASPbQE8PziFQit7Ro2tgZvYYke1u3HmnSSJrZCEnz9VZ5MkiX6jnmaELrKGocumdwnn5ye8o9DedNaSnRuUWvo+SRpIq3xaDzTi6rSSoYP428dX7pPnCywFPyb31SYTBI7/xalT9KkImbjVRTZKrpH6Dwps0zSBO9EWWk+Kryv3GQ83tiahu2NYU36i5ZkJG2ZbLdp4pUPF5TRyuBtZ9ztJ6ent79Ltlum+fT008dGXjkkMNbDwtYm/9X/zj4ksvRh645lf8gQVr4z47ePzXhlGqFVHnLi0q7Q/H8t2Rfvo3hW9a7UfM+IMpoUiML35MDU/fNopENZk/KbZHJ9n9wNRaWG8fvk+mZ7kyYl+sK2Oc0KC18kk2S87tPbITVILtznWtjlkhMmn9u7ka3QOLU0Wswd59FYVGrcPBt9kmzT4zuiqn4WPdbDn3vFebFUZvmxezc730w5fjFEBx7qAyUq9UfcJGkXgH2qNFGcNwWKHCkES5mFDZfbsLyp0EzV0oSgBuHHgPQEOpr3f/lnTzYzM/M5DAYMV2zI0NmaJMILK+vAT2iPZIRXDcL77/8O81pprgGCHBvUnHouBU+185jDfANoPFJFyqEbDQbMf1/uUjXoAgQKkJYT0mMKFdm8lqzokFDkG8Ahe1T4mhAqLfzCUgm+IFsvCxDglFlqTOHt+fSSEe/5xasRTNHkkFtZl2i8Cyr2TFIohRFLBI8l88Ogs5CrQKLMEpwXvnagDBAKDV6VmIIwOYja21J4ZKWJrVOEvRjQaoFyI3V0jtAa1soXtvbQoMktgbZyNVRmxI4YDof848kT7gyepU69II85n543SBsg/K5G56GsnQcpiDZRbl+rrKEvELK9/MggZkYQkmXZzOx9nMDvAyD3B5+3NDMzGLz/69/g+mu7jg3JcN/AI4E3T7ukz610j7OdT8cF6mo8jUa58fOLVwHWTmL8v7EeHEdyXSAhi5rjUpk/wJXDYMtg0JY5oGkUWcOuHQzgafaTYSA7Yb4VWW+5nvooiMUCZXC15gzOhRdHoTizhHAmKjFXWjGK8vkDnAmPS0sbeIB3hfAhZaUwkFt4mJmH4XAY/jHpYPCiy7rBAB7gjFBwVjs0eQp1lYe/CBu7anMqR877XXoOu7Dv0rflfNnla+D8Za10DoS1E3O9l8zBXKgIh5UWEnNYq3yJ3n0WdGDPWINgiatgE8Qi9SKmqBdDrs8g4mWXBY6PA+l+VfV+bbmAMo3yoVXBgqeblulFPddKwqH600IQgoAqfuxKTyuzCuVjbMdVK+dDLSjCvOP5gsTCwztLK5YUOYoG97SztOcT4SDnGy64fKGM0ComXAlMQR3fM2u8kG3w/hRxItRAq4yM32HOo1pFdkmiLIVXUmi96Zh8ZXWOFHm8oaUwLGunmTJO5dhDMLwgTsdFvNTxaOe9yOQtSmQahqMhwxFgw4hjrFeLdjpwEDOTwK4NoMkrq4zv2PHE0vHypLBBEFLa2vjgEUmYKw/cSaiMEXw4LA1O/Pff/8PBN7hm3OkaxhMuG42CndNFuJMh9MxkL88vYdxFYjxReRYkHp5zjDMoOIJzRAPOE4qSB6k8ZANhXptcGA+VIFGiZ09xAhGWtsE8sBwMKsKF0jqUNigHxq6B0NfEfBzyXY96AwuyZRfRHcPBgFvDitOwn7EBhVNIXDbSGleXOOqsvhDOrS3lwwuyHiW3vIsXX8G0ripLfmb4O2SzZKE03lYt8SzJOtTu6nxu8w3DoYG1pSA9VDAaSZuq5epGHV/MwZrJzGQXb6aXMJYBXzo3ZvDvf0F2cfXI4+F470KXjONJR3d7SBaqpaN69OFIXvjAGMEuzTr/vFksOIAwbUubS4usnpkpevZLeAHd2kh1y1dnyYSnB4QHWAjtMANr4EcMDTn0A5Z6C3jHI7PymgeQAI48oaiIk628HnB4NEAhix4s+vhOY368tZr7AA9FWYuWGcSBO+SXkBIrBha2KRLcktXIkV4o1DkISda5MBAEK7i6yNYe3QguC0IEpo/57LooT2LrYekM9liIRnFxHzecVqcMBk9zXIha+5MAXWFmaIcqRgaNwvkA/btpKnaGCBFZo3DNfHq0cSFL++mGHUXIVGCN3nQg3XaX+J7t8DkTVUW2iezOhImVzf2mI8c79lrbOqI2LcQHYQ89tAiaWwNnttrA07OzE1ZOVYpxdGaeg8E1u13Knbfbsu8dCUJbswyIy/bgnXJhBshmyXz/njW9rWmfDGlsGyHb+ibYR3Ec+3kfzPNSKA0izwkdYwejGuZc772O1CK54IFubs1QsmX7OA4YuFgj8TAAyvUBzUfwWq1wZ0PK6h9oA09dLQtufLFKdhWv8uyEW1ej8tYPUTWOF6m8jXvnAWiErjENDSeiFHtWK3Ysd1PAsvIbEERiA0+z65vs5DOwpfKBS3Stt6BMgdQeHrI+GsGeN0LpUKnnu/mvncP2TrgmhEO4evv6B2awaRwRQ7/7GXNjP7D0T5BDDh984fW3z6/gLS4fXf7YyzI77rh/RnLKBpD6NXwp5GotKHdwZstKeBUm1A2T8mVOjkXNI8i8IxzKllDHCRiaZyGNm2ejZ/0DpRsTXGyJvrAOoYmCIyCJPh6W25ZyMO/8HrgaC3PC2DVlIcySC4FnhL1GrRj481rGWgj6MmsbnqNCQ200OgfWF0hrnpWM5Rw/dMeVQ37evVZmFdJhCNf9BPUO50553D1P1uv1I0+fhDtf1VpDN6OHgvvIoyZee6n81/Uc3mJlnfKWNrtbS+WLeh5iuX+3/6Nl0M3S/aLnlzymAstLpNKBXcAUqVHyI+aPPZOPT2a8QjhaOxxuBwgXSIw77uApKCrVPjuvOz2A1fsldvA2qR2pw8KKoS/uP7445hMWT2zCm0Vrb7uD+bC9SZpoJdE43FtoPX958Rqa34xOk3RvmfMTYjl+/ers/JvpOSvTlkkySZ6NTkenfFRZ50th9iTtrX2PtzD3uzXff7MhbldFHu/8uNJChc1cMOa+3apd96vamzQprPN8dH/P9XtFervl4+9qJN7V3aRJI0hxoYdNXdotmHgNt8INOy0MOgkT6jpuqY5Wkwf7vZfnl0maiJo12V9srcJiq/2FuXefzGaP9+HGKyrA//P67Qcv3N/Hpdl229PHTz96ozWwo2YH3my32/8ApzN1nA==","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Template list","permalink":"/docs/API-docs/v1.2/gettemplatelist"},"next":{"title":"Save or Update Webhook","permalink":"/docs/API-docs/v1.2/save-update-webhook"}}');var a=t(74848),s=t(28453),i=t(57742),r=t.n(i),p=t(78178),l=t.n(p),m=t(19624),d=t.n(m),h=t(96226),k=t.n(h),u=(t(77675),t(19365),t(51107));t(21312);const A={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:"eJy9WF9vG8cR/yrTM1BYxJGU0xQFmCKNIyuOUTcWTKl+EAXdcm/I23Bv9zK7dxQhEchD0Q9Q9KWv/RJ970fxJylm9+74R4mdNEUfbEl7s/N/fjM794kXS5dMrpN3OC+sXSU3aZKjk6Qqr6xJJsllgfASPbQE8PziFQit7Ro2tgZvYYke1u3HmnSSJrZCEnz9VZ5MkiX6jnmaELrKGocumdwnn5ye8o9DedNaSnRuUWvo+SRpIq3xaDzTi6rSSoYP428dX7pPnCywFPyb31SYTBI7/xalT9KkImbjVRTZKrpH6Dwps0zSBO9EWWk+Kryv3GQ83tiahu2NYU36i5ZkJG2ZbLdp4pUPF5TRyuBtZ9ztJ6ent79Ltlum+fT008dGXjkkMNbDwtYm/9X/zj4ksvRh645lf8gQVr4z47ePzXhlGqFVHnLi0q7Q/H8t2Rfvo3hW9a7UfM+IMpoUiML35MDU/fNopENZk/KbZHJ9n9wNRaWG8fvk+mZ7kyYl+sK2Oc0KC18kk2S87tPbITVILtznWtjlkhMmn9u7ka3QOLU0Wswd59FYVGrcPBt9kmzT4zuiqn4WPdbDn3vFebFUZvmxezc730w5fjFEBx7qAyUq9UfcJGkXgH2qNFGcNwWKHCkES5mFDZfbsLyp0EzV0oSgBuHHgPQEOpr3f/lnTzYzM/M5DAYMV2zI0NmaJMILK+vAT2iPZIRXDcL77/8O81pprgGCHBvUnHouBU+185jDfANoPFJFyqEbDQbMf1/uUjXoAgQKkJYT0mMKFdm8lqzokFDkG8Ahe1T4mhAqLfzCUgm+IFsvCxDglFlqTOHt+fSSEe/5xasRTNHkkFtZl2i8Cyr2TFIohRFLBI8l88Ogs5CrQKLMEpwXvnagDBAKDV6VmIIwOYja21J4ZKWJrVOEvRjQaoFyI3V0jtAa1soXtvbQoMktgbZyNVRmxI4YDof848kT7gyepU69II85n543SBsg/K5G56GsnQcpiDZRbl+rrKEvELK9/MggZkYQkmXZzOx9nMDvAyD3B5+3NDMzGLz/69/g+mu7jg3JcN/AI4E3T7ukz610j7OdT8cF6mo8jUa58fOLVwHWTmL8v7EeHEdyXSAhi5rjUpk/wJXDYMtg0JY5oGkUWcOuHQzgafaTYSA7Yb4VWW+5nvooiMUCZXC15gzOhRdHoTizhHAmKjFXWjGK8vkDnAmPS0sbeIB3hfAhZaUwkFt4mJmH4XAY/jHpYPCiy7rBAB7gjFBwVjs0eQp1lYe/CBu7anMqR877XXoOu7Dv0rflfNnla+D8Za10DoS1E3O9l8zBXKgIh5UWEnNYq3yJ3n0WdGDPWINgiatgE8Qi9SKmqBdDrs8g4mWXBY6PA+l+VfV+bbmAMo3yoVXBgqeblulFPddKwqH600IQgoAqfuxKTyuzCuVjbMdVK+dDLSjCvOP5gsTCwztLK5YUOYoG97SztOcT4SDnGy64fKGM0ComXAlMQR3fM2u8kG3w/hRxItRAq4yM32HOo1pFdkmiLIVXUmi96Zh8ZXWOFHm8oaUwLGunmTJO5dhDMLwgTsdFvNTxaOe9yOQtSmQahqMhwxFgw4hjrFeLdjpwEDOTwK4NoMkrq4zv2PHE0vHypLBBEFLa2vjgEUmYKw/cSaiMEXw4LA1O/Pff/8PBN7hm3OkaxhMuG42CndNFuJMh9MxkL88vYdxFYjxReRYkHp5zjDMoOIJzRAPOE4qSB6k8ZANhXptcGA+VIFGiZ09xAhGWtsE8sBwMKsKF0jqUNigHxq6B0NfEfBzyXY96AwuyZRfRHcPBgFvDitOwn7EBhVNIXDbSGleXOOqsvhDOrS3lwwuyHiW3vIsXX8G0ripLfmb4O2SzZKE03lYt8SzJOtTu6nxu8w3DoYG1pSA9VDAaSZuq5epGHV/MwZrJzGQXb6aXMJYBXzo3ZvDvf0F2cfXI4+F470KXjONJR3d7SBaqpaN69OFIXvjAGMEuzTr/vFksOIAwbUubS4usnpkpevZLeAHd2kh1y1dnyYSnB4QHWAjtMANr4EcMDTn0A5Z6C3jHI7PymgeQAI48oaiIk628HnB4NEAhix4s+vhOY368tZr7AA9FWYuWGcSBO+SXkBIrBha2KRLcktXIkV4o1DkISda5MBAEK7i6yNYe3QguC0IEpo/57LooT2LrYekM9liIRnFxHzecVqcMBk9zXIha+5MAXWFmaIcqRgaNwvkA/btpKnaGCBFZo3DNfHq0cSFL++mGHUXIVGCN3nQg3XaX+J7t8DkTVUW2iezOhImVzf2mI8c79lrbOqI2LcQHYQ89tAiaWwNnttrA07OzE1ZOVYpxdGaeg8E1u13Knbfbsu8dCUJbswyIy/bgnXJhBshmyXz/njW9rWmfDGlsGyHb+ibYR3Ec+3kfzPNSKA0izwkdYwejGuZc772O1CK54IFubs1QsmX7OA4YuFgj8TAAyvUBzUfwWq1wZ0PK6h9oA09dLQtufLFKdhWv8uyEW1ej8tYPUTWOF6m8jXvnAWiErjENDSeiFHtWK3Ysd1PAsvIbEERiA0+z65vs5DOwpfKBS3Stt6BMgdQeHrI+GsGeN0LpUKnnu/mvncP2TrgmhEO4evv6B2awaRwRQ7/7GXNjP7D0T5BDDh984fW3z6/gLS4fXf7YyzI77rh/RnLKBpD6NXwp5GotKHdwZstKeBUm1A2T8mVOjkXNI8i8IxzKllDHCRiaZyGNm2ejZ/0DpRsTXGyJvrAOoYmCIyCJPh6W25ZyMO/8HrgaC3PC2DVlIcySC4FnhL1GrRj481rGWgj6MmsbnqNCQ200OgfWF0hrnpWM5Rw/dMeVQ37evVZmFdJhCNf9BPUO50553D1P1uv1I0+fhDtf1VpDN6OHgvvIoyZee6n81/Uc3mJlnfKWNrtbS+WLeh5iuX+3/6Nl0M3S/aLnlzymAstLpNKBXcAUqVHyI+aPPZOPT2a8QjhaOxxuBwgXSIw77uApKCrVPjuvOz2A1fsldvA2qR2pw8KKoS/uP7445hMWT2zCm0Vrb7uD+bC9SZpoJdE43FtoPX958Rqa34xOk3RvmfMTYjl+/ers/JvpOSvTlkkySZ6NTkenfFRZ50th9iTtrX2PtzD3uzXff7MhbldFHu/8uNJChc1cMOa+3apd96vamzQprPN8dH/P9XtFervl4+9qJN7V3aRJI0hxoYdNXdotmHgNt8INOy0MOgkT6jpuqY5Wkwf7vZfnl0maiJo12V9srcJiq/2FuXefzGaP9+HGKyrA//P67Qcv3N/Hpdl229PHTz96ozWwo2YH3my32/8ApzN1nA==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},c=void 0,v={},I=[];function f(e){const o={p:"p",...(0,s.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Get Webhook"}),"\n",(0,a.jsx)(r(),{method:"get",path:"/webhook",context:"endpoint"}),"\n",(0,a.jsx)(o.p,{children:"The Get Webhook API allow you to get webhook url"}),"\n",(0,a.jsx)(l(),{parameters:void 0}),"\n",(0,a.jsx)(d(),{...t(58661)}),"\n",(0,a.jsx)(k(),{...t(94859)})]})}function O(e={}){const{wrapper:o}={...(0,s.R)(),...e.components};return o?(0,a.jsx)(o,{...e,children:(0,a.jsx)(f,{...e})}):f(e)}},58661(e){e.exports={title:"Body"}},94859(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"webhook":{"type":"string","example":"https://your-webhook-url@example.com"}},"title":"inline_response_200_7"}}}},"404":{"description":"User not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"User not found!"}},"title":"inline_response_404"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/0ba00a8d.647fe89f.js b/assets/js/0ba00a8d.647fe89f.js deleted file mode 100644 index f1711ee86..000000000 --- a/assets/js/0ba00a8d.647fe89f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[2815],{80832(e,o,t){t.r(o),t.d(o,{assets:()=>u,contentTitle:()=>g,default:()=>A,frontMatter:()=>b,metadata:()=>n,toc:()=>y});const n=JSON.parse('{"id":"API-docs/v1.2/get-webhook","title":"Get Webhook","description":"The Get Webhook API allow you to get webhook url","source":"@site/docs/API-docs/v1.2/get-webhook.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/get-webhook","permalink":"/docs/API-docs/v1.2/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":"eJy9V81uGzcQfpUpD22yWEtOmqKAcolRGK5RIwlqBz7YgkHtzmoZc0mGHEoWBAE59A166rWPlicphrsrr+Tmry16sSVyfr755ae1IDkPYnIlLnFWW3srprkoMRReOVLWiIm4qBFOkKATgKPXpyC1tktY2QhkYY4Ey+4yei1yYR16yeqnpZiIOVJvPBceg7MmYBCTtXh6eMj/dv2dx6LAEKqoYWtH5KKwhtAQy0vntCrSxfhtYKW1CEWNjeRPtHIoJsLO3mJBIhfOsxlSrcsO6EAwkFdmLnKBd7Jxmo9qIhcm4/HKRn/QaRxEr190IqPCNmKzyQUpSgrKaGXwpg/u5unh4c2PYrNhmWeHzx4G+SagB2MJKhtN+c1/Fx96b/2no9v3/alAGHwfxg8Pwzg1C6lVmXriwt6i+X8jGbqn1j1DvWs06xnZtCEloXQvdkIdnrdBBiyiV7QSk6u1uDuQTh2095Or6Waaiwaptl1PM2BJtZiI8XLb3gH9An1I+jwL970UpCln9m5kHZqg5kbLWeA+Gkunxosno6dik+/rSOe+Sh7jwdeqBJJzZeaf05ve5+ac69eWaCdD20JJp37Blcj7AgylcqG4b2qUJfpULGUqm5S7srxyaM7V3KSiJuf7C+kSdWEb5NVDNUKW9Soffvtzq5VlUNoiNmgotd/o2lybV9GDs0v0vFykKaHSeKdmGpMaNuku9HstoGw0hqBXoAzh3EtCKNVckdTAeVJmDoV0cqa04q5lMcvaHgaNH0ZwWSPV6PnqO48gocQFam52kJFsI4lN9Xhhaf1tpe0y5CBhFoMyGAKgqaUpWLCvRA7WgzSAhtA7rwJCIM+oVYvNGvKyIGikkXNk2zkMk1WiVtyu4O0sBoJgdUyQgaTS1mMJfUAGsQwpicd3jq+ATwvbOI81t80CYR5ViSGHwpYIIQ0ph2BKmGEgcIxFFRjYaDTaFrepgFXUGpzlnaGkBlvtYGR18tKEyvqmxdLXYJsw5y0/GdgCzLI3AbnCZ8rchkmWXZsDuNr21SXOgiKcPupHYLlcPmj9x7s6J4p+jjP4FZ0Niqxf3WvPFdVxlsZlaGT7pbV0ggZT/wyG4d5GaYvwcPr4dFyjduNzJO6QMD56fZrW7GP48P53OEPpDdR22XZrET3qFcx7V5y5tvJt2rZbEiqbGq/mjBdt83l8FzFQn8HLWtKH938EeIlLUKYbKQ4ly5gMXGDjNDv5Fna+nqlAWTYBj41dYAnRGOTSSL8CJ71skLjfGFpAPiAswXmslNZQSpJQeduk6UI/0Bix62tRKY03ToawtL68FvcCIMsSS0ZaeGQg1CHKIbpy96CTuB83RfXguvSyovvbFqquEibwNlLbwM7bhSoRejQpqc5bwiLFVFY96ESWbmxVpaeVzXwR8uR5D/zAf0vBYuB0kgU0kveY5ekI7cfW4XZTMT6qUfmttR5gm+0bbzX+PTKe0lYoQPta85TuJupBXj+b6AeV4oBdnGlV7Ac8gqOiQMeJXUgdMUwgy1pEWQaPSqxk1PQ4hyxbKFzyKX+WjqvE30Zw3uFveNHVcoEgCTTKQGC7LEmKHmGpyjnSc2gNDRWM7S7Dc+hNB2jkqrNnVv19CtVGAjkwzCOmfFrDo2t+Cveez91XzmOFnnMXWo7dD7VT3RBf9csAeEf8m2XCrIjfClkk0oaNVLp9x1/s20kECn0TXlXn6Beq6OnyR/boOAmPRS60KtAEHBCzo5PXZ7D4fnQo8gEp+YKVOj47/en45fkxg+EStAl7MjocHfKRs4EaaQaeBj9f9tnE+p6u/pNfOh3lIbyjsdNSJYaZgll37PBq+5NjmovaBuKj9XomA77xerPh43cRPXPOaS4W0ise38Q4854oMZ28xRUnLc2BYEEdW7a1R7F3eOrJ8YXIBe/6XYJ2mwha94Gt91dmNbC9y9xaAPyXaeTfKqzXLfnbbLby7dVHNboAe2lO4HSz2fwFcyIuFQ==","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Template list","permalink":"/docs/API-docs/v1.2/gettemplatelist"},"next":{"title":"Save or Update Webhook","permalink":"/docs/API-docs/v1.2/save-update-webhook"}}');var a=t(74848),s=t(28453),i=t(57742),l=t.n(i),p=t(78178),r=t.n(p),c=t(19624),d=t.n(c),k=t(96226),m=t.n(k),h=(t(77675),t(19365),t(51107));t(21312);const b={id:"get-webhook",title:"Get Webhook",description:"The Get Webhook API allow you to get webhook url",sidebar_label:"Get Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V81uGzcQfpUpD22yWEtOmqKAcolRGK5RIwlqBz7YgkHtzmoZc0mGHEoWBAE59A166rWPlicphrsrr+Tmry16sSVyfr755ae1IDkPYnIlLnFWW3srprkoMRReOVLWiIm4qBFOkKATgKPXpyC1tktY2QhkYY4Ey+4yei1yYR16yeqnpZiIOVJvPBceg7MmYBCTtXh6eMj/dv2dx6LAEKqoYWtH5KKwhtAQy0vntCrSxfhtYKW1CEWNjeRPtHIoJsLO3mJBIhfOsxlSrcsO6EAwkFdmLnKBd7Jxmo9qIhcm4/HKRn/QaRxEr190IqPCNmKzyQUpSgrKaGXwpg/u5unh4c2PYrNhmWeHzx4G+SagB2MJKhtN+c1/Fx96b/2no9v3/alAGHwfxg8Pwzg1C6lVmXriwt6i+X8jGbqn1j1DvWs06xnZtCEloXQvdkIdnrdBBiyiV7QSk6u1uDuQTh2095Or6Waaiwaptl1PM2BJtZiI8XLb3gH9An1I+jwL970UpCln9m5kHZqg5kbLWeA+Gkunxosno6dik+/rSOe+Sh7jwdeqBJJzZeaf05ve5+ac69eWaCdD20JJp37Blcj7AgylcqG4b2qUJfpULGUqm5S7srxyaM7V3KSiJuf7C+kSdWEb5NVDNUKW9Soffvtzq5VlUNoiNmgotd/o2lybV9GDs0v0vFykKaHSeKdmGpMaNuku9HstoGw0hqBXoAzh3EtCKNVckdTAeVJmDoV0cqa04q5lMcvaHgaNH0ZwWSPV6PnqO48gocQFam52kJFsI4lN9Xhhaf1tpe0y5CBhFoMyGAKgqaUpWLCvRA7WgzSAhtA7rwJCIM+oVYvNGvKyIGikkXNk2zkMk1WiVtyu4O0sBoJgdUyQgaTS1mMJfUAGsQwpicd3jq+ATwvbOI81t80CYR5ViSGHwpYIIQ0ph2BKmGEgcIxFFRjYaDTaFrepgFXUGpzlnaGkBlvtYGR18tKEyvqmxdLXYJsw5y0/GdgCzLI3AbnCZ8rchkmWXZsDuNr21SXOgiKcPupHYLlcPmj9x7s6J4p+jjP4FZ0Niqxf3WvPFdVxlsZlaGT7pbV0ggZT/wyG4d5GaYvwcPr4dFyjduNzJO6QMD56fZrW7GP48P53OEPpDdR22XZrET3qFcx7V5y5tvJt2rZbEiqbGq/mjBdt83l8FzFQn8HLWtKH938EeIlLUKYbKQ4ly5gMXGDjNDv5Fna+nqlAWTYBj41dYAnRGOTSSL8CJ71skLjfGFpAPiAswXmslNZQSpJQeduk6UI/0Bix62tRKY03ToawtL68FvcCIMsSS0ZaeGQg1CHKIbpy96CTuB83RfXguvSyovvbFqquEibwNlLbwM7bhSoRejQpqc5bwiLFVFY96ESWbmxVpaeVzXwR8uR5D/zAf0vBYuB0kgU0kveY5ekI7cfW4XZTMT6qUfmttR5gm+0bbzX+PTKe0lYoQPta85TuJupBXj+b6AeV4oBdnGlV7Ac8gqOiQMeJXUgdMUwgy1pEWQaPSqxk1PQ4hyxbKFzyKX+WjqvE30Zw3uFveNHVcoEgCTTKQGC7LEmKHmGpyjnSc2gNDRWM7S7Dc+hNB2jkqrNnVv19CtVGAjkwzCOmfFrDo2t+Cveez91XzmOFnnMXWo7dD7VT3RBf9csAeEf8m2XCrIjfClkk0oaNVLp9x1/s20kECn0TXlXn6Beq6OnyR/boOAmPRS60KtAEHBCzo5PXZ7D4fnQo8gEp+YKVOj47/en45fkxg+EStAl7MjocHfKRs4EaaQaeBj9f9tnE+p6u/pNfOh3lIbyjsdNSJYaZgll37PBq+5NjmovaBuKj9XomA77xerPh43cRPXPOaS4W0ise38Q4854oMZ28xRUnLc2BYEEdW7a1R7F3eOrJ8YXIBe/6XYJ2mwha94Gt91dmNbC9y9xaAPyXaeTfKqzXLfnbbLby7dVHNboAe2lO4HSz2fwFcyIuFQ==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},g=void 0,u={},y=[];function v(e){const o={p:"p",...(0,s.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Get Webhook"}),"\n",(0,a.jsx)(l(),{method:"get",path:"/webhook",context:"endpoint"}),"\n",(0,a.jsx)(o.p,{children:"The Get Webhook API allow you to get webhook url"}),"\n",(0,a.jsx)(r(),{parameters:void 0}),"\n",(0,a.jsx)(d(),{...t(58661)}),"\n",(0,a.jsx)(m(),{...t(94859)})]})}function A(e={}){const{wrapper:o}={...(0,s.R)(),...e.components};return o?(0,a.jsx)(o,{...e,children:(0,a.jsx)(v,{...e})}):v(e)}},58661(e){e.exports={title:"Body"}},94859(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"webhook":{"type":"string","example":"https://your-webhook-url@example.com"}},"title":"inline_response_200_7"}}}},"404":{"description":"User not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"User not found!"}},"title":"inline_response_404"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/0c03cd54.19c557da.js b/assets/js/0c03cd54.19c557da.js deleted file mode 100644 index 31cc25214..000000000 --- a/assets/js/0c03cd54.19c557da.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[1265],{27491(e,t,n){n.r(t),n.d(t,{assets:()=>I,contentTitle:()=>f,default:()=>y,frontMatter:()=>b,metadata:()=>i,toc:()=>F});const i=JSON.parse('{"id":"API-docs/v1.2/getsigninglinks","title":"Get Signing Links","description":"The Get Signing Links API enables you to retrieve signing urls of signers for the document.","source":"@site/docs/API-docs/v1.2/getsigninglinks.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/getsigninglinks","permalink":"/docs/API-docs/v1.2/getsigninglinks","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getsigninglinks","title":"Get Signing Links","description":"The Get Signing Links API enables you to retrieve signing urls of signers for the document.","sidebar_label":"Get Signing Links","hide_title":true,"hide_table_of_contents":true,"api":"eJy9WMFyGzcS/ZVeHLL21IiUFe+FucSbuBRVVLErcsoHicUCBz0cWBgAAXpIcVmsymH/YE973U/zl6QaM0MOSTm2andzkTiD7sbrbnT3w2wEyUUUk1vxvSuaGi1FMc2FwlgE7Uk7KybiXYVwiQQ3emG1XcC1tvcRXr29ArRybjDC2jVADgJS0LhEiJ1kE0wEV6ZnDBFKF4AqBNVtNrqzIhfOY5C815USE7FA6tQN7yNy4WWQNRIGBroRVtYoJqK3MdNK5EIzUC+pEsfo3fwDFnSlGEfvpMhFwF8bHVCJCYUGcxFpbdhs1LU3KHKBD944hWJSShNZoKiwlmKyEbT2SZKCtguRi9KFWtLwDT7IZGUi5N8viuKi8vNKbLdT3jZ6ZyNGNnRxfs7/DvHGpigwxrIxsAuMyEXhLDHyyUZI740u0sL4Q2SlzSm61m2OXmAzpNst+2g81Y/qg774x0OxvHgrtrngBDXBDIzIEOSa80BYx8/DwFpq81QMrPNt9zgqXM1IDlF8mStEPk7G4yaYM3Jn7MvZ7kAms9tckKYkrK3RFmd92mbKFbPe++1Q8PjYbtPqy8cyfONqpIrrY4WWYBWcXeTgDcqIQGENciG1BSMJw1/+d6nHEFx4LFj70DwN2R/F6eX5+ezFLggvT4PQlyJYR1C6xqo/19XH9v9jh17Ovt459LdTh67sUhqtUl985+7R/rn+DLendnuG+lCn+uh6pm6F0ro4cHb4vnUyYtEETevUcx/OpNdn7frkdsqdjE+K6xp2atJUiYkYD4tgvBk06a1gm2HZt/FUubtijNKquXsYOY+WTRg5j1yMY+n1ePlidCG2+bGO9P5J8ticPVUlklxou/ic3nQfrhtOaZu1g6DtO6XXPyK3yi4nQ6lujlUoFYaUP21Ll5S7TL3xaHkOpzynzY/n3Xs0hauR5zGP2izrVT7+8z87rSzbzeB0Ikd39s6+aQJ4t8LAs0daBaXBBz032M76Oq3thn1EWRuM0axBW8JFkISg9EKTNDsCUEgv59poPsgs5lg7wKAW4gjeV0gVBl76a0CQoHCJhs8/yIZcLYlN9Xhh5cJ9adwq5iBh3kRtMUZAW0lbsGCfiRxcAGkBLWHwQUeESIFR6xabsxRkQVBLKxfItnMYBkuh0XxcIbh5EwmiM02CDCS1cQEV9A5ZRBVTEF8zbQgI/LZwtQ9Y8bFZIiwarTDmUDiFEFPdsgtWwRwjgWcsusDIRhtrXHGfElg2xoB33Ea0NMxihhhZnYK0kSdei6XPwS5gPjhmFNgCzLJfInKGE42bZNmdPYPb3bl6j/OoCafP+hJYrVYnR//5oc6lph+aOfyM3kVNLqz32gtNVTNP5TI0sntoLV2ixXR+BsWwt6FcEU+rj9+OKzR+fIPEJySOX729Sp33OXz87V9wjTJYqNyqPa1FE9CsYdFvxZFrM9+Gbdc4E0uVDVUc8aI9fMwWMVIfwfeVpI+//TvCT7gCbbuSYleyjJnyO6w9D0n4Cg4er3WkLJtAwNotUUFjLXJqZFjDnuUmaBH5BaECH7DUxoCSJKEMru7o9EBjxFvfiVIbnHkZ48oFdSf2AiCVQsVIi4AMhDpEOTReHb7oJPblpqkaLKsgS9qvtlBNS/EhuIbaA+yDW2qF0KNJQfXBERbJJ1X2oKUxbjVzZZnmLZv5IuRp5yPwg/2TVWgih5Ncd1HhhqB0bH+2G+46VXc10WFnrQfYRnsWnMHHkXGV9jecdoBzlR4G6iSunw30SabYYd/MjS6OHR7Bq6JAz4FdStNgnECWtYiyDJ4pLGVj6HkOWbbUuOK3/Ft6zhI/jdLdjvHX3OgquUSQBMz7CFwXJUlNQFhptUD6BlpDQwXrusX4DfSmI9Ry3dmz6349ueoaAjkw3F3I9tfCo/F5OOUClhg4dim9+6L2uivi274ZAPeI/6aZMFHiWSELGlxdeI5/e2wncSoMdXxT3mBY6qK/b3yij46T8FjkwugCbcQBV3t1+fYall+PzkU+ICVf0FLH11ffvf7p5jWD4RS0AXsxOh+d8yvvItXSDnY6udsfc4rNnsf+3z8GdCyJ8IHG3khtB7e8lmPeiqPvA5Php4BpLioXicU2m7mM+Esw2y2//rXBwGx2moulDJrBJiLadQS1u+l/0vdnP3cfDZ7DJ74qPIq+J36WWV8qUDERIhf3uD76jrGdbvOe/TG0VqIt7oHuyVXigI9fvn4ncsED7JB13ifW2f1g64/iOqSjLQD+y9z4UYXNpmW02+1Ovl36pEbnYC/NQZput9vfAaPrkVY=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Formdata","permalink":"/docs/API-docs/v1.2/getformdata"},"next":{"title":"Draft Template","permalink":"/docs/API-docs/v1.2/drafttemplate"}}');var s=n(74848),o=n(28453),r=n(57742),a=n.n(r),l=n(78178),g=n.n(l),c=n(19624),d=n.n(c),p=n(96226),u=n.n(p),h=(n(77675),n(19365),n(51107)),m=n(21312);const b={id:"getsigninglinks",title:"Get Signing Links",description:"The Get Signing Links API enables you to retrieve signing urls of signers for the document.",sidebar_label:"Get Signing Links",hide_title:!0,hide_table_of_contents:!0,api:"eJy9WMFyGzcS/ZVeHLL21IiUFe+FucSbuBRVVLErcsoHicUCBz0cWBgAAXpIcVmsymH/YE973U/zl6QaM0MOSTm2andzkTiD7sbrbnT3w2wEyUUUk1vxvSuaGi1FMc2FwlgE7Uk7KybiXYVwiQQ3emG1XcC1tvcRXr29ArRybjDC2jVADgJS0LhEiJ1kE0wEV6ZnDBFKF4AqBNVtNrqzIhfOY5C815USE7FA6tQN7yNy4WWQNRIGBroRVtYoJqK3MdNK5EIzUC+pEsfo3fwDFnSlGEfvpMhFwF8bHVCJCYUGcxFpbdhs1LU3KHKBD944hWJSShNZoKiwlmKyEbT2SZKCtguRi9KFWtLwDT7IZGUi5N8viuKi8vNKbLdT3jZ6ZyNGNnRxfs7/DvHGpigwxrIxsAuMyEXhLDHyyUZI740u0sL4Q2SlzSm61m2OXmAzpNst+2g81Y/qg774x0OxvHgrtrngBDXBDIzIEOSa80BYx8/DwFpq81QMrPNt9zgqXM1IDlF8mStEPk7G4yaYM3Jn7MvZ7kAms9tckKYkrK3RFmd92mbKFbPe++1Q8PjYbtPqy8cyfONqpIrrY4WWYBWcXeTgDcqIQGENciG1BSMJw1/+d6nHEFx4LFj70DwN2R/F6eX5+ezFLggvT4PQlyJYR1C6xqo/19XH9v9jh17Ovt459LdTh67sUhqtUl985+7R/rn+DLendnuG+lCn+uh6pm6F0ro4cHb4vnUyYtEETevUcx/OpNdn7frkdsqdjE+K6xp2atJUiYkYD4tgvBk06a1gm2HZt/FUubtijNKquXsYOY+WTRg5j1yMY+n1ePlidCG2+bGO9P5J8ticPVUlklxou/ic3nQfrhtOaZu1g6DtO6XXPyK3yi4nQ6lujlUoFYaUP21Ll5S7TL3xaHkOpzynzY/n3Xs0hauR5zGP2izrVT7+8z87rSzbzeB0Ikd39s6+aQJ4t8LAs0daBaXBBz032M76Oq3thn1EWRuM0axBW8JFkISg9EKTNDsCUEgv59poPsgs5lg7wKAW4gjeV0gVBl76a0CQoHCJhs8/yIZcLYlN9Xhh5cJ9adwq5iBh3kRtMUZAW0lbsGCfiRxcAGkBLWHwQUeESIFR6xabsxRkQVBLKxfItnMYBkuh0XxcIbh5EwmiM02CDCS1cQEV9A5ZRBVTEF8zbQgI/LZwtQ9Y8bFZIiwarTDmUDiFEFPdsgtWwRwjgWcsusDIRhtrXHGfElg2xoB33Ea0NMxihhhZnYK0kSdei6XPwS5gPjhmFNgCzLJfInKGE42bZNmdPYPb3bl6j/OoCafP+hJYrVYnR//5oc6lph+aOfyM3kVNLqz32gtNVTNP5TI0sntoLV2ixXR+BsWwt6FcEU+rj9+OKzR+fIPEJySOX729Sp33OXz87V9wjTJYqNyqPa1FE9CsYdFvxZFrM9+Gbdc4E0uVDVUc8aI9fMwWMVIfwfeVpI+//TvCT7gCbbuSYleyjJnyO6w9D0n4Cg4er3WkLJtAwNotUUFjLXJqZFjDnuUmaBH5BaECH7DUxoCSJKEMru7o9EBjxFvfiVIbnHkZ48oFdSf2AiCVQsVIi4AMhDpEOTReHb7oJPblpqkaLKsgS9qvtlBNS/EhuIbaA+yDW2qF0KNJQfXBERbJJ1X2oKUxbjVzZZnmLZv5IuRp5yPwg/2TVWgih5Ncd1HhhqB0bH+2G+46VXc10WFnrQfYRnsWnMHHkXGV9jecdoBzlR4G6iSunw30SabYYd/MjS6OHR7Bq6JAz4FdStNgnECWtYiyDJ4pLGVj6HkOWbbUuOK3/Ft6zhI/jdLdjvHX3OgquUSQBMz7CFwXJUlNQFhptUD6BlpDQwXrusX4DfSmI9Ry3dmz6349ueoaAjkw3F3I9tfCo/F5OOUClhg4dim9+6L2uivi274ZAPeI/6aZMFHiWSELGlxdeI5/e2wncSoMdXxT3mBY6qK/b3yij46T8FjkwugCbcQBV3t1+fYall+PzkU+ICVf0FLH11ffvf7p5jWD4RS0AXsxOh+d8yvvItXSDnY6udsfc4rNnsf+3z8GdCyJ8IHG3khtB7e8lmPeiqPvA5Php4BpLioXicU2m7mM+Esw2y2//rXBwGx2moulDJrBJiLadQS1u+l/0vdnP3cfDZ7DJ74qPIq+J36WWV8qUDERIhf3uD76jrGdbvOe/TG0VqIt7oHuyVXigI9fvn4ncsED7JB13ifW2f1g64/iOqSjLQD+y9z4UYXNpmW02+1Ovl36pEbnYC/NQZput9vfAaPrkVY=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},f=void 0,I={},F=[];function S(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 Signing Links"}),"\n",(0,s.jsx)(a(),{method:"get",path:"/signinglinks/{document_id}",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Get Signing Links API enables you to retrieve signing urls of signers for the document."}),"\n",(0,s.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(m.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(g(),{...n(18467)}),"\n",(0,s.jsx)(d(),{...n(77025)}),"\n",(0,s.jsx)(u(),{...n(54695)})]})}function y(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(S,{...e})}):S(e)}},18467(e){e.exports=JSON.parse('{"parameters":[{"name":"document_id","in":"path","description":"objectId of Document","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"aB2cc2hpbh"}}]}')},77025(e){e.exports={title:"Body"}},54695(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"hji2zxcv2P"},"signurl":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","format":"string","example":"mail@example.com"},"url":{"type":"string","format":"string","example":"https://url-to-sign-document.com"}},"title":"inline_response_doc_signurl"}}},"title":"getsigninglinks"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"Document not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Document not found!"}},"title":"inline_response_404_3"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/0c03cd54.4b8ae5df.js b/assets/js/0c03cd54.4b8ae5df.js new file mode 100644 index 000000000..f6c6fb6fa --- /dev/null +++ b/assets/js/0c03cd54.4b8ae5df.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[1265],{27491(e,t,n){n.r(t),n.d(t,{assets:()=>D,contentTitle:()=>f,default:()=>P,frontMatter:()=>S,metadata:()=>s,toc:()=>I});const s=JSON.parse('{"id":"API-docs/v1.2/getsigninglinks","title":"Get Signing Links","description":"The Get Signing Links API enables you to retrieve signing urls of signers for the document.","source":"@site/docs/API-docs/v1.2/getsigninglinks.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/getsigninglinks","permalink":"/docs/API-docs/v1.2/getsigninglinks","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getsigninglinks","title":"Get Signing Links","description":"The Get Signing Links API enables you to retrieve signing urls of signers for the document.","sidebar_label":"Get Signing Links","hide_title":true,"hide_table_of_contents":true,"api":"eJy9Wc1yG8cRfpXOqCpFohYAJSsXOOWYpmiZFcViEWR0IFjEYKeBHWN2Zj0zuyBCosqHVB4glUuueYnc8yh6klTP7C4WICVZ5cQH/WC3p//7657ee+b5wrHRNXtl0jJH7R27SZhAl1pZeGk0G7HLDOE1ehjLhZZ6AW+kXjo4Pj8D1Hym0MHalOANWPRWYoXgasrSKgdmHn6jdTA3FnyGIGphg4lmCTMFWk6yzgQbsQX6+rgiOSxhBbc8R4+WFL1nmufIRqzhcSsFS5gkRQvuM7avvZn9gKk/E6RHYyRLmMUfS2lRsJG3JSbM+bUitk7mhUKWMLwrlBHIRnOuHBGkGeacje6ZXxeB0lupFyxhc2Nz7rtP8I4HLiPGv3mRpi+yYpaxzeaGxLrCaIeOGL04OqJ/dvV1ZZqic/NSQesYlrDUaE+aj+4ZLwol0/Bi+IOjQ/ePtYtmk/cssfEyimy88bl2ZD/IF3+5S6sX52yTMApQaVWHCbeWrykOHnP3aTUw51J9rg505uv65yA1OWmyq8XPM8X7wo2Gw9Kqvjd9sqXfJmRgu0mYlz4QS62kxtsmbLfCpLeN9Zsu4X7absLbl09FeGxy9BnVxwq1h5U1epFAoZA7BG/XwBdcalDco/3N/y70aK2xTzlr65rP0+xjfnp5dHT7vHXCy8dOaEoRtPEwN6UWv66pT8n/uEEvb79oDfrdY4POdMWVFAEXL80S9a9rT1e8j+JJ1bs81EeNmTIShfdsx9ju82ikw7S00q8D5t71eSH78f3o+oaQjDLF1IAdQNpnbMSG3SIY3ndAesOIp60aGA+V2xaj41rMzN3AFKiJheIzR8U45IUcVs8HL9gm2T/Di+Kz6LHsf+4R5/lC6sWnzt1s3TWmkMao7Thti5SF/CMSVNYx6VLVfSxDLtCG+Ek9N+FwHam3BWrqwyHOQfh+v3sGDc37v/6rJZvoif4Kej3q5WRI35nSphg6YuDHlUeruZcVwvuf/gGzUiofGrbAChVlo0vA29J5FDBbA2qPtrDSoRv0esS/K3chq3ou4JAaylGPCRTWiDIlRfsWuVgDBvjlvrQIheKecBt8Zk25yICDo0zCBC5Ox5fUEI/PzwYwRi3aCSLOFC2TBHKu+QLBY078MOjM02U7kjjPfelAarDIFXiZYwJcC+ClNzn3SEpbsk7a7aACSs4xXacqOocrBSvpM1N6qFALY0GZdNmXekCO6Pf79M+zZzQ2eZI69tx6FPT0tEK7Bho/0HnIS+ch5dauo9y2fElDGpWmnfyYQsyMIGQ6nU505+UIfk8ctg++qmkmutd7/7e/w/V3ZkVT2gI1jRW4J/DmoEl6YVL3ONvp6TBDVQzH0Sg3PD4/C0h3GOP/vfHgKJKrDC2SqBkupP4DXFH3yBB6vbrMAXUlrdHk2l4PDqY/Gwamh8S3sMYbqqc2Cnw+xzS4WlEGC+75XihOjEU44QWfSSUJWOn5A5xwjwtj1/AA7zLuQ8qmXIMw8DDRD/1+P/wh0l6vHZJ7PXiAE4ucstqhFgmUhQi/LFZmWeeUQMr7bXr2m7Bv07fmfNnka+D8TSmVAIulo/l6m8zBXCgs9gvFUxSwkoIGjy+DDuQZoxGMpSpYt1N3LWKMat6n+gwiXjdZ4OhxIO1WVevXmgtIXUkfuhfMlVk1TM/LmZIp7Ko/zrhF4FDEl03pUU8I5aNNw1VJ56EZxRueryyfe3hn7JIkRY68wo52dI1ofcIdCDrhgsvnUnMlY8LlcVJp+J4Y7XlaB+9PESdCDdTKpPE9zIxZUootLM9z7mXKlVo3TL41SqCNPN7aBdcka6uZ1E4KbCEYXllKx3k81PB4h7PMmGVkcoEpEg3BUZ/gCLCq5xI5rwcGBzEzLZiVBtSiMFL7ht2VaxS6aC5gPE1NqX3wSGpRSA/USWgopgg+7JYGJf77n/7p4HtcEe40DeMZlY1CTs5pItzI4Gqip69PL2HYRGI4kmIaJO4+pxhPIaMIzhA1OG+R5zRdiZANFkWpBdcethc9oASymJsKRWDZ6xUW51KpUNogHWizogtnaYmPQzrrUa1hbk3eRHTLsNej1rCkNGyvYIDcSbRUNqnRrsxx0Fh9zp1bGSv659Z4TKnlnb/6FsZlURjrJ5rew3TC5lLhbVETT9i0Qe2mzmdGrAkONayMDdJDBaNO7bqoubpBwxcFGD2a6On52/ElDNOAL40bp/Cff8P0/OqRx8PjzoEmGYejhu52lyxUS0P16MWevPCCMIJcOm3883Y+pwC2KwEqLWvURI/Rk1+4UmZ1ayJVuDBN2IimB4QHCBfqKRgNHzA05NATlnoDdCuXqfRqXS8fCAuEjDhZy2sBh0YD5GnWgkUb33HMjwujqA/QUDSt0XIKcQYP+cXTFAsCFrIpEtxao5AiPZeoBPDUGufCQBCsoOqypvToBnCZWUQg+pjPronyKLYekk5gjxmvJBX3fsOpdZpC70DgnJfKHwboCjNDPVQRMtD9zAfo305TsTNEiJhWElfEp0Ubt7OGCY6ySFRgtFo3IF13FwjRbPB5yovCmiqyO+E6Vjb1m4Yc78hrdeuI2tQQH4Q9tNDC7cxoODHFGg5OTg5JOVlIwtGJPgaNK3J7mm69XZd960jgyuhFQFyyB++kCzPAdMJm3XNGt7YmbTIksW2EbGubYBvFYeznbTBPafsAXAiLjrCDUA0F1Xuro62RnNNANzO6n5JlXRyHsPcAo1PcDYB0bUDFAN7IJW5tSEj9HW3gwJVpRo0vVsm24qWYHlLrqqSo/RBVo3hZKeq4Nx6AiqsSk9BwIkqRZ5Ukx1I3BcwLv4aw24GD6fXN9PBLMLn0gUt0rTcgdYa2frjLem8EO664VKFST7fzXz2HdZ5QTdDC4erizRMz2DiOiKHffcbc2A4s7RVkl8NHb3jt6dMruMDFo8OfullO9zvun9E6aQJI/Ra+4elyxa1wcGLygnsZJtQ1kdJhSo55SSPIrCHspzWhihMwVM9DGlfPB8/bC0ozJrjYEn1mHEIVBUdA4m08DLUt6WDW+D1w1QZmFmPXTDOuF1QINCN0GrUk4BdlGmsh6EusTbiOcgWlVugcGJ+hXdGspA3l+K47rhzS9S4slsMbuG4nqHc4c9Lj9nqyWq0eefownPm2VKrd8YaC+8SlJh57Lf135QwusDBOemPX21ML6bNyFmLZPdv+qBk0s3S7+/kll6nA8hJtHlbnY7SVTD9h/tAT+fAwrNP31g672wGLc7SEO27nKsgLWV87rxs9gNT7JXbQgqkeqTsrX9p/fL3PJ+yiyIS389reegfzcXtZwpRMUTvs7LiOX5+/geqLwRFLOsucnxHL4Zuzk9Pvx6ekTF0mbMSeD44GR/SoMM7nXHckPfomsr+Lud/u//7vH1Hq7ZLHOz8sFJe6sx2Pu7lrtvddZdT9hHKTsMw4T2T39wQDV1ZtNvT4xxItbQFvElZxK0nZsMCrpy7RfiH5oO0HF/UN7xA+8DXmSe2bhZmmbVnoJ2zEWMKWuN77/rO52STN1oxUixTHYXrrnH20gt3ZY74+vWQJ4yX5qrutW4ZtXf0f4v6kXrtrvKgA/U07xScP3N/HTeBm09LHVx88URvYUJOTbjabzX8BisjY3Q==","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Formdata","permalink":"/docs/API-docs/v1.2/getformdata"},"next":{"title":"Draft Template","permalink":"/docs/API-docs/v1.2/drafttemplate"}}');var i=n(74848),o=n(28453),r=n(57742),l=n.n(r),a=n(78178),p=n.n(a),c=n(19624),g=n.n(c),m=n(96226),d=n.n(m),u=(n(77675),n(19365),n(51107)),h=n(21312);const S={id:"getsigninglinks",title:"Get Signing Links",description:"The Get Signing Links API enables you to retrieve signing urls of signers for the document.",sidebar_label:"Get Signing Links",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Wc1yG8cRfpXOqCpFohYAJSsXOOWYpmiZFcViEWR0IFjEYKeBHWN2Zj0zuyBCosqHVB4glUuueYnc8yh6klTP7C4WICVZ5cQH/WC3p//7657ee+b5wrHRNXtl0jJH7R27SZhAl1pZeGk0G7HLDOE1ehjLhZZ6AW+kXjo4Pj8D1Hym0MHalOANWPRWYoXgasrSKgdmHn6jdTA3FnyGIGphg4lmCTMFWk6yzgQbsQX6+rgiOSxhBbc8R4+WFL1nmufIRqzhcSsFS5gkRQvuM7avvZn9gKk/E6RHYyRLmMUfS2lRsJG3JSbM+bUitk7mhUKWMLwrlBHIRnOuHBGkGeacje6ZXxeB0lupFyxhc2Nz7rtP8I4HLiPGv3mRpi+yYpaxzeaGxLrCaIeOGL04OqJ/dvV1ZZqic/NSQesYlrDUaE+aj+4ZLwol0/Bi+IOjQ/ePtYtmk/cssfEyimy88bl2ZD/IF3+5S6sX52yTMApQaVWHCbeWrykOHnP3aTUw51J9rg505uv65yA1OWmyq8XPM8X7wo2Gw9Kqvjd9sqXfJmRgu0mYlz4QS62kxtsmbLfCpLeN9Zsu4X7absLbl09FeGxy9BnVxwq1h5U1epFAoZA7BG/XwBdcalDco/3N/y70aK2xTzlr65rP0+xjfnp5dHT7vHXCy8dOaEoRtPEwN6UWv66pT8n/uEEvb79oDfrdY4POdMWVFAEXL80S9a9rT1e8j+JJ1bs81EeNmTIShfdsx9ju82ikw7S00q8D5t71eSH78f3o+oaQjDLF1IAdQNpnbMSG3SIY3ndAesOIp60aGA+V2xaj41rMzN3AFKiJheIzR8U45IUcVs8HL9gm2T/Di+Kz6LHsf+4R5/lC6sWnzt1s3TWmkMao7Thti5SF/CMSVNYx6VLVfSxDLtCG+Ek9N+FwHam3BWrqwyHOQfh+v3sGDc37v/6rJZvoif4Kej3q5WRI35nSphg6YuDHlUeruZcVwvuf/gGzUiofGrbAChVlo0vA29J5FDBbA2qPtrDSoRv0esS/K3chq3ou4JAaylGPCRTWiDIlRfsWuVgDBvjlvrQIheKecBt8Zk25yICDo0zCBC5Ox5fUEI/PzwYwRi3aCSLOFC2TBHKu+QLBY078MOjM02U7kjjPfelAarDIFXiZYwJcC+ClNzn3SEpbsk7a7aACSs4xXacqOocrBSvpM1N6qFALY0GZdNmXekCO6Pf79M+zZzQ2eZI69tx6FPT0tEK7Bho/0HnIS+ch5dauo9y2fElDGpWmnfyYQsyMIGQ6nU505+UIfk8ctg++qmkmutd7/7e/w/V3ZkVT2gI1jRW4J/DmoEl6YVL3ONvp6TBDVQzH0Sg3PD4/C0h3GOP/vfHgKJKrDC2SqBkupP4DXFH3yBB6vbrMAXUlrdHk2l4PDqY/Gwamh8S3sMYbqqc2Cnw+xzS4WlEGC+75XihOjEU44QWfSSUJWOn5A5xwjwtj1/AA7zLuQ8qmXIMw8DDRD/1+P/wh0l6vHZJ7PXiAE4ucstqhFgmUhQi/LFZmWeeUQMr7bXr2m7Bv07fmfNnka+D8TSmVAIulo/l6m8zBXCgs9gvFUxSwkoIGjy+DDuQZoxGMpSpYt1N3LWKMat6n+gwiXjdZ4OhxIO1WVevXmgtIXUkfuhfMlVk1TM/LmZIp7Ko/zrhF4FDEl03pUU8I5aNNw1VJ56EZxRueryyfe3hn7JIkRY68wo52dI1ofcIdCDrhgsvnUnMlY8LlcVJp+J4Y7XlaB+9PESdCDdTKpPE9zIxZUootLM9z7mXKlVo3TL41SqCNPN7aBdcka6uZ1E4KbCEYXllKx3k81PB4h7PMmGVkcoEpEg3BUZ/gCLCq5xI5rwcGBzEzLZiVBtSiMFL7ht2VaxS6aC5gPE1NqX3wSGpRSA/USWgopgg+7JYGJf77n/7p4HtcEe40DeMZlY1CTs5pItzI4Gqip69PL2HYRGI4kmIaJO4+pxhPIaMIzhA1OG+R5zRdiZANFkWpBdcethc9oASymJsKRWDZ6xUW51KpUNogHWizogtnaYmPQzrrUa1hbk3eRHTLsNej1rCkNGyvYIDcSbRUNqnRrsxx0Fh9zp1bGSv659Z4TKnlnb/6FsZlURjrJ5rew3TC5lLhbVETT9i0Qe2mzmdGrAkONayMDdJDBaNO7bqoubpBwxcFGD2a6On52/ElDNOAL40bp/Cff8P0/OqRx8PjzoEmGYejhu52lyxUS0P16MWevPCCMIJcOm3883Y+pwC2KwEqLWvURI/Rk1+4UmZ1ayJVuDBN2IimB4QHCBfqKRgNHzA05NATlnoDdCuXqfRqXS8fCAuEjDhZy2sBh0YD5GnWgkUb33HMjwujqA/QUDSt0XIKcQYP+cXTFAsCFrIpEtxao5AiPZeoBPDUGufCQBCsoOqypvToBnCZWUQg+pjPronyKLYekk5gjxmvJBX3fsOpdZpC70DgnJfKHwboCjNDPVQRMtD9zAfo305TsTNEiJhWElfEp0Ubt7OGCY6ySFRgtFo3IF13FwjRbPB5yovCmiqyO+E6Vjb1m4Yc78hrdeuI2tQQH4Q9tNDC7cxoODHFGg5OTg5JOVlIwtGJPgaNK3J7mm69XZd960jgyuhFQFyyB++kCzPAdMJm3XNGt7YmbTIksW2EbGubYBvFYeznbTBPafsAXAiLjrCDUA0F1Xuro62RnNNANzO6n5JlXRyHsPcAo1PcDYB0bUDFAN7IJW5tSEj9HW3gwJVpRo0vVsm24qWYHlLrqqSo/RBVo3hZKeq4Nx6AiqsSk9BwIkqRZ5Ukx1I3BcwLv4aw24GD6fXN9PBLMLn0gUt0rTcgdYa2frjLem8EO664VKFST7fzXz2HdZ5QTdDC4erizRMz2DiOiKHffcbc2A4s7RVkl8NHb3jt6dMruMDFo8OfullO9zvun9E6aQJI/Ra+4elyxa1wcGLygnsZJtQ1kdJhSo55SSPIrCHspzWhihMwVM9DGlfPB8/bC0ozJrjYEn1mHEIVBUdA4m08DLUt6WDW+D1w1QZmFmPXTDOuF1QINCN0GrUk4BdlGmsh6EusTbiOcgWlVugcGJ+hXdGspA3l+K47rhzS9S4slsMbuG4nqHc4c9Lj9nqyWq0eefownPm2VKrd8YaC+8SlJh57Lf135QwusDBOemPX21ML6bNyFmLZPdv+qBk0s3S7+/kll6nA8hJtHlbnY7SVTD9h/tAT+fAwrNP31g672wGLc7SEO27nKsgLWV87rxs9gNT7JXbQgqkeqTsrX9p/fL3PJ+yiyIS389reegfzcXtZwpRMUTvs7LiOX5+/geqLwRFLOsucnxHL4Zuzk9Pvx6ekTF0mbMSeD44GR/SoMM7nXHckPfomsr+Lud/u//7vH1Hq7ZLHOz8sFJe6sx2Pu7lrtvddZdT9hHKTsMw4T2T39wQDV1ZtNvT4xxItbQFvElZxK0nZsMCrpy7RfiH5oO0HF/UN7xA+8DXmSe2bhZmmbVnoJ2zEWMKWuN77/rO52STN1oxUixTHYXrrnH20gt3ZY74+vWQJ4yX5qrutW4ZtXf0f4v6kXrtrvKgA/U07xScP3N/HTeBm09LHVx88URvYUJOTbjabzX8BisjY3Q==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},f=void 0,D={},I=[];function k(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Get Signing Links"}),"\n",(0,i.jsx)(l(),{method:"get",path:"/signinglinks/{document_id}",context:"endpoint"}),"\n",(0,i.jsx)(t.p,{children:"The Get Signing Links API enables you to retrieve signing urls of signers for the document."}),"\n",(0,i.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,i.jsx)(h.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,i.jsx)(p(),{...n(18467)}),"\n",(0,i.jsx)(g(),{...n(77025)}),"\n",(0,i.jsx)(d(),{...n(54695)})]})}function P(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(k,{...e})}):k(e)}},18467(e){e.exports=JSON.parse('{"parameters":[{"name":"document_id","in":"path","description":"objectId of Document","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"aB2cc2hpbh"}}]}')},77025(e){e.exports={title:"Body"}},54695(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"hji2zxcv2P"},"signurl":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","format":"string","example":"mail@example.com"},"url":{"type":"string","format":"string","example":"https://url-to-sign-document.com"}},"title":"inline_response_doc_signurl"}}},"title":"getsigninglinks"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"Document not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Document not found!"}},"title":"inline_response_404_3"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/257dcba5.729c21d9.js b/assets/js/257dcba5.729c21d9.js deleted file mode 100644 index bdc72d805..000000000 --- a/assets/js/257dcba5.729c21d9.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[5824],{50172(e,n,t){t.r(n),t.d(n,{assets:()=>b,contentTitle:()=>f,default:()=>w,frontMatter:()=>x,metadata:()=>i,toc:()=>y});const i=JSON.parse('{"id":"API-docs/v1.2/drafttemplate","title":"Draft Template","description":"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.","source":"@site/docs/API-docs/v1.2/drafttemplate.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/drafttemplate","permalink":"/docs/API-docs/v1.2/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":"eJztPV1zGzeSfwU3dXWOuUOKpCXHVuquTrEVR1lb0tlyHFvSasEZkIQ1A0wAjChaxap92H9wT/e6Py2/5KobwHzxQ7KseJU75iEWB1+NRnej0d1oXAWGjnSwfRwcsTRLqGE6OA2DmOlI8cxwKYLt4GjMiC8mzxUdGi5GZOdwjzBBBwnTJNdMaWIkiRSDSlGujUz5JyglxvccEs3UBbSlmgySnGWKC6PJUCoyYoIpih3HMspTBgUTbsYkUyxmQy5YTLRReWRyxXSHvM2kIDqPIqb1ME/syFwKIoeEFmOGxIwZgqqYyZXQhJJc8F9zRlotOfjIIrMXt1rkm5hpPhLUsBiA883PePwwJJMxj8YkooIMGEw1hpk6gFkF3AGFMilwTJ2xiA85VHaddchOHHOAkSbJNCSUtFq5SlotwjXJlLzgMYv9aHI4BJRSRC3hwjA1pBFDXDHoRYxwGN85oSImQxrxhJs6GknMtVF8kMPInRNxIo54tk3eZomkMZnKXJHD5z+U1Y0k8O241XrOBvmIvN1rtU6/GRuT6e2NDZplHZkxAdhK6EB3IpluxFAxi4eIK6YY9Ir4YlTzZEpoHJMJj0fMaFwQQSKZTUkkpYq5sKSR0REjIk8HTOkQZ5NKxQgXhBLFaDxtG9nONSM/vTnYBzSk1HTIYZLrsBgu5opFJpna7gE9flYP7Oo83gQa4mIUkpSeA5a4Ib/mPDqHaWsmcGkdySCuWq13AG+BHa4djceEmDHXZMIGYynPCbuA4glPEmIUH42YarVOxF//+tcTcXUiCDkJsMZJsE1OAtfFSRDaIjPNmC15fvDs7avd/aOzo/eHu0W5p9RGnb3nRY0hT5o9vH39sigWNG0W7++8KgcQ0rjyw4RRzYhiF5xNcB1gqe1cPRaKZhU5YVsXJdCIKQ1fj+ELIVf2nzo0b/Ze7O++rsJia7CU8qRWZffVzt7LWp1sLEW9m8MfD/br/eSq0sve/guLFFs+g39OHbxuRXbcAh3tvdp9c7Tz6hAqz9w6AjW8ybNMKlj+d5agt2GZT8T3LJETQhVD6olkmkpBMqpoygzKxjE1WKzYrzlXLLbCjSaJ54ztE9EmrRbgZrvVIm+tlOIxEwbkiELWtySHDTq2PpAO1N8TMY+AlaxYmGYMJGGtKrAYVH3jRJOtWmE8kF1W/ABHTaiVBlkCggeqKgZSzfALVu/4MiRT6Pg5Azqy3Y6l4p+kMDRBIrpgyvCIJlWmBwBRVBqqUGRlkgvjv7oRyHvH3MD7yNJOKgFoMSA35QJLNCMXNMmZdlBNQjIGqF6zTDGNEtr1C4gXMRkzPhovHY/GH3Ntah2TXHu566FwY/lVRfQyRNuQJpoRPqzhMqXnrDIakZndDzrk+ymJ2ZDmiQkJB3llVM46ZF8aQrMs4RHupUADdqPKFWvjKjvy6dTJ59DuJ7CDxBz2EpBOUIhduDYeOqBLuwHB9FDumjEVRIrGQkcykWqehPBzHY8kksIwYTpk54LyBIG3k9WEiyjJY0YGCY3OQ9QEQqJg74NVmbIkkZPQ8gdWwR0ZcY74IZolQIVSAPxCuuG5LvfcDjkCRin4Dwo9qnEQrqtYdTJ/KGFkQIFnSYJyKETEheSjHBDDTcJCYPCMimlIYqtksEszkJchicYsOse/FI25JIPcGCnsxGIls1hOhMPlUAqj+acFHOlLPh+j/ZBshuRxSJ6EpNcNSa8fkt5mSHqPQ9J7EpJ+NyT9fkj6myHpP7Zg9Z84XNMCwVUAen2LZfPHwu6Yx+wMGp7B3M6oNkxxfQ7imuCOblXXOHRa1KUpFDfYueLajj/mccwEGSqZEsUinnGUJlYaFF2HAA9RMCmhyTBPkim54JpXcFB0KicC1Tr4yhU5yJh4A9ssjSKZwxojhi1SEZ3lkotkCqAeMZpqnPkuKIeZ4pqBqBa6wIAwJW1ZdQi+VQXATVZS1CXQ8tVctjqVlYEd9CXXKHNh69PFbjqp7aa9Dmm1CjnXVKRKbamoUugdsJtBWc/9voQfj/rfup9T+Pm4/8T9nGDV3qb7OYaffd/UMRd8c7rLSQAIdHqSFbCkAgJUmgH4pcLQx4kYmmYrJgHFX2sCfqOCj7DDhL6g1Mmq8CyZs63h5lvO9hHMlgtuOE308gn7Gvdozg2QFk+7rDQ3802YOYqz5dN2Ou29mXMVHlSBYRu1RbjtVor8hoBQ9FegqNnnMjEMrVBBmsPkVsdpMcsRaadwb/BYAeeu0Njo8vOx+BiwCDvqEeyoy1FZbLr3CJ9NmO4KqYv6/XzMfttBPRgVlOV4dRXuEVbrEN0VTud7/XyMPgGMgqa3HJ1Qeo9wWQHHWkFQbbZl3c12b6vd7/Y3a/gEc5WtkKbtOG5Pp9MvW4uUizMLR8XuggX0cnEBWNFAeyxWoigBHYaLUdGsXjq/6rZeYyFB53SYALXTn0Ct3gsWSlSf580LePova7kzD/7tj+Sv4CA+YIWR1CnOFRurtwdWT9FGxnT6QNuufNPi8AX1m+qxBROLAA60jUZjySMHPNTxR64BGHw6gIM2LupGHG9UFhU+xnE7TduNj/CzjTRQ+ZimnTjuNGrOEYr9mJI4Dsn854Xf45ikabrks/1e+7yRpvOz6KSpg81hz9Pe3DqnXPA0h0MSmFntGT1G0/eRR2/q1pIL0mq9f//+ffvVq/bz562WX0M3hKPiii3DjkAv72iEKtG3Wttkb0iqn9CeYC05KAWKsyHa1n2FsZwIfySyJk8S52Bg9lWtPSmlU+yMcTNmqj6OVCXJwgESzlsDacYd8hbPl/C3P4cV5yU8Sz0FwekOx8tlp6vwtcRnKSXrA68UrctFU022zqlFXjBli/UmxUZ5QhW7BAOgbhqpb7sHft7+1hCLnpZLYwuaFp1xl3lbB/nmwB3DHxYWxsZcoLcd52kjio3YJcmoMUwJ7OyCJjy2HrG29Rpd0jQD68rGX05O4j/96wbadsF8aqxRIeYjDg6ajb8c77Q/nC6okWcZUxG4BxIGI+mQMBN1yPGYJVnpI5pMJp3JIx2NpUysg+ijVmxo/38mBx/PENysQ3X2cNFMLTFUbKlALE1TKjJnBWNUE99ygTUVlwa5ptdFDc4ZK1aocK7GPdI7GiBBoTVMn6CbJUgpKrdAvKz8W4LMOQlOy+0e7acsvqbt6Q3YE7ghoQOWzBd9PmsldCpzx9HeX1CfqqPoCt6cKlSYhHE63YoHKKWXjcKT0vvT4FOLkCqb+t3es6dfAZJwXWwkNXRWWzuvAfp+BLN+4wEjvgEZFFT6xVxQAHYzNvAmUly7a4aAegQrFh4bP9o1I9QWZm4nd7qCdz0Ni149yvxGXsUXtASXeKkmrBjB6QrLR3A+/SUDnIgeGiK9AXPF+cTVuEeyogHSaja+jRSp7cy32VJvxYB+WlUGXLC9QlW7sRbMp5dzX4ccWKu6bwQW9yhiGWhaX8yaBcg33qHQalw1oi+nvGqte0R9C8D6nSnQ1bvr3edWRFqd/R+IUGtg35hYrdE/paMV9hssvkfkWYVnsYnD1ZgzVvXQ0m93lBUWaixfPeFetzbhrfqEH3dvceKqDfvlB67uCvzMDQVn6zyhc9tBzCKe0gSDSBDu/hfw6G0OXw4w4IFnMs1yU2U6NOugYPFagg+NsM7dP4WkHZJWSDZC8k1IHnbIa4bBFFEReOGUBq5seAWHYLEcPKVRrpIpGSiYeEhYZ9QhV1e/5lQYbqazGWmRqyuIIJzNOsCF50JObOzFMXiNDYFIuvJQFctIL4i8k5HegNPXxj6btJ879/KGA+0h+UY2RMLKo6hDwdc9kVmoKkQCo+wXKps9lWKwD9dZQqeEDsFTbQNCsJmNG+oAirdJn/z7f5Bev9PthqRr/4boTjvB/kPkYfQxRSxZ5aTE4us4uFvl4PLnIpG11b0RC1eHvSUHQxdnGEaA416rsJXMfQ9NJ+VkmsbailYPOLP7px7LPIlh97TxvqwI6Cx0+lbrULEhxGmWEXzEf/I8DRFRLGGpixpzsXtwnMFoBS6MBL7x4Ryt1oANJUQqQEApGgZpGeNnx7Zbdy0KBIMOpSJjqq2dBTENEEPErBmztBEz4cEr4ya48LADKffuziLYf1on7sdbNeLequ9PS4l7GQWvMBRCE51JoQt/ICuLKlSnigDahUeLJiX5TmG5MWSmjPxBIYaEk/BzVpU1XGivpTkom5Fwz8ZS6rKGC0Zzcldv14PcpII4t4edIjTkS91evW8f1ZSIJ1/R7VVfpe7mRm9rY6Xfq+Ei+fzDIiE3WVK0qt9oSbFmuaZrp9CXOIW+nCMe3aVhtvdtv3aeeLRqc74nhtkqR11jkr0Lw+utzraLLKBVPryh7fOr2SC/nCw3fw9rTENwf9v7J1hjvpRE54wud0aU5K4sLoso8wYml5V2li+m3Cqwvzv1bt2NeaZx1nla0waf9qvUurX1ZdTaNM5USO4k4D9/f/B60v3zi5Hc2dnZ2X/zdrz7drSzs5PC706ns9Bkt4gMcBjQn93FMLfFo7qwZJROp4PuemroNjbfyMToO9s+XN6m4+Lxfic/wtbX9iN8udwoqn6dPWuR0+D3kwxfyrNBGMgML8NKsRcH20EMV279Rc8gxFVj2nwv42mwfRW4eyHwp4vTh5YbHzVc3r0KdDRmKYW//GrDdV+4LxiE/ppeEAYYGQl3f4Eag2135TAIIbYiA3M409AHttu+8rXsbcogdJp+sB1YbgjCwMUbFJ8IE5GE4K0sHgazEHs6y6jWE6nilV0WX8ouoQML8Wc21PhHcW0W+oE7a7fsBpvOGvelb9VTtYdZuS5lZ1QpOg2aV7P9ZTUfAONikLzVL5n67YgbMMcVN6iwWhAG3LC0OsqSVVfy8zEdMQkzwYjw2ywviKDbtMNrobdp6GJZb9P0oxyc3Yocy7U+uzmO6yRQvzsGvRR6hr+qVMRLuvC1TEm4Nt8hO3CJh8VOWd8uA+PAuVGYTR9u2wjMMb1gBLZIRsEcJSqXX+rXBOHqMPSwTV6ziPELB1v1ijneLgb75XfWzY99C9m4zUgzIGzfFbSxV57c93q330H7JkTFfVsrWJnIUxB/BQNYUIMw8EOBCKxwp603CwMH2AKOvCEP2dL59a2vZn1FSLucUGiv3XSukye+PvICHVXHtCbTuTGPlt0Crlw+dIZVmmWMqg5exr11lgBMFEGTKMfEBcWmW5tZAWoxs94sDC6vn8wliWTbXzEm3yRsaGzcGomkEkw9rMYh35vJ9Tc3Z2EwvX560z/k9L6FxZtcP7t3eDe7vLf+z4D10ZNZGIyvh/XH4vb4PxHYzcezUhNySQyK5CUDGU/PvNyaXVfRqxxQDzJh7IkDFTNVQcRAyoRRMYcJiJy2B+AHcIh4ENpoUbwmypX26oZNjqHsjlDsR1ZYO5XW3h/zF+3AbbgLH1AJ1/lAQy3h+9O2wwHzCTcgQ4ytwW2GFXS/MBqNIbWHi2EtvYcZ5LiQufbggRcGdICEgWPFunSLKO7qKb2CnUqUuJ17p7o68MVh84yLMwktzmzc+g3QiteUG4i1k7HwckiiI6NzuP4APE8xF06RoMBvtrkwPMHbthngPvbB6YBA3HWbc6YYTdchu2IoVcQ0sRBXcFuiBQ9DeOpgGnK/CPKggp0HeDpKdIEc8tziEBf0ARo66hjDT7MwoLANnsnhMOGCIWneig79PEFF1vkAApmpTQ4DnuUicY/P6OLs+bxMAORvg7ur3oKwS4iwpgkxUiZ4wLRXuW2+lJtP0F4/Pzg6vMG80KzUtoC5K+FI+bYPcnB0COk1+NCd/ODiQMEdnt1orQqBkxi54NRfwS/2+6lVx5j1pkif/KWkp45LbNEm8wDFXC+EKCTU3xYvMkXNdVxm7wG2lbkBJ6hLl0S0YZlegcgjmd9EUl2DSUpGOd4vMiDGfa4NjHMv02NwYdNQoYXBXfZYqFx7PHmsQKVK/yFhQtvmlAzRGR5CbirAvMrBnlB0yS4zpjgEnSxEgWIWdWe5WnjSWnVeePv6pcvZVLnC4uWq7xgYIEOqQUkxJ2KaU58/4jABom/ZkW5eHcVQGneMyZjSkNdLEalGVPBPLs8XaKlgXxmwMU1sVbd9gCMOxRzQaw0Yv//+9vd/VOBaekadB8yOQOMYwiKugRCNSJbgQQAplsGuKOsQQX9M/WdTMQgKIZjKuGAkfXMaP8R7G7oQgS6ooAhq0Hk0BpNAsQfrsLjg7o4aGq1SRW4MmcF82SXXppL3wZ8t5+XDa3dFq4TBblNxbGXptMrgZbCFbHSHGSp4PQNMoRrNbxy5kWeKpVzcTHepWu6NLARBbmRKDY+I70p36nl9rEPZ83VahhgBNV5wqR4uBM/wlB3JZ27HfU6n+npFE9qgduhakZhOESM+FV2pNrLLjKtpcZESfdUek9ecrrZQkMBkz6SIGOgr7IKpGxxJKrFaANiAmQljooo5v4Sy0BZsLhFUGGor1rh1V8MhQJgyNWJnEZyqkSfYDZa41YKuWi3StoA4ia9z5ey8LmMXijaQcmXvAI7LrVNcOi3VpWravA75UU4AYSHJbAY1sA3a/gGfBCF36WaqI0RU4I0/MDFDHpaKHgI3GHiZe87FAiEp4Wz2rGkvsmZm6AUyTME44ao5eele3KalkCXKj+41HpgcmGgJTSRyuxkvSo+DQO1hgqAx7o64fuDJsuP4rF2oJf32t/+BTIc+glJ3YApLSzHkCrVHvPpY7dUzm2dHZ9xpcpuQhg+nZ1KclVJuIcHUW64koAXhW3VFS7g9Agf3+hZQOlAHINrusfBP3X41t77LBwOE3NGA+9IwMK6NqIqTYk+zy2gwUyKtEpIdahk1oHFuCdlRY2g0ZphTKGYZ5FqU7rhgN+AHZR4iWE8wXzFxhk6Tm5jd3KY9q6zmcQC+FfSYxEFoPUvB6SwMBlF02x5hP/9P9xs36hA/9Wvf5lKoDqKIfDNIOKCHqoG0GTAfbjtVncbAh6iGNbT22qJa5KM4qelfvHJw7ZDiP4dEGx64yEC52pfgN/gy/SlLB3AdAUMd8RSMmqAs3Ql1i+fvZjJdZf90YXpr6+cfyDzY63b/L1s/H3X/ONbPze4fyPr5BIB17vTrpcmy0+dC2eHDA1Y3+CiZ9RwmUq2uCTsQOL1dMMMiBJfs0J/Z/0qDrRfi1xhxrZW39PM7A6SfDKKh3+3CPw0h6O1d3hRWZtZOpv8ShDcPMli9Bj6R8WpkfT/u/6gzkUZjwNkSq0ZZfTWJVYMnNtj0p/HgRcQP+E97bz/t9fb5nt4Tr7eiZ3uP986zX35+9tPTDpv+1Iv6P09/6f9s3r9L9N5HyaMffxp/ED/rwbOt/P0vH9T7X/bU+3evDX23tTMQYzF48QOPplsfB/0uf/nsp+6Hd73J4MUP3Q8/P80+YOc/dD+cn3ejdP/ZQOxAnez9L//FDz7uPnr1affTq6Pdy1efkqcduv/rx2eX0dNX57uP2x/2VPvVweDPH3812eut+NH+L/zxE/aKvRNH3ZdRjRq4QFOpX+oznPcZLLalpM1Fy/5Gpszq7RPMXq0kKHzuAGPUlNARnEAAdeoOqYApdR2/fB5kqxCx2e2e9QokbM0jYU9gZgHMEn8kz5n4ujOtDm/s8ADqZZqUQivgthKWB7XJVr/bSWoW5YqbabB9fBVctmnG27Z8+/h0dgpnaDOWEFeUSY0QUzMOtoONZpgRJOvHGJTjK8uDBaNpKmKIvJ1jNprxjYtepx/Mwmabhcy5oj7L25/bRBs64mJ0XbvTEkVvYBntStUQVSqsGf8zA43VrUO1VhhwIJ8xo2BqAswDdbwug7N2/Rr7sKlFkVBzgVBBUC5vM1rJByvV4o+aW/OCiKJKQNGxj+bBAJ0iPico5xgUMTRBUImKgR+VOJcgaESulDEVhd5/XNJ9EZXg1fIe6rP9zU1U/L7toYb06AkqH5uPZ6d2mSpuSIxPXOJLc8f2RV4jV1Txt9S+WMeB+1Q3pOMMq4brmvW4aTxeashdYsf1INftle7rIjNhb2uZgW5roV3MdbXYBuIKqwfsxYdld1a++bm3ctxcQAdew6pTAQQXAxU86iIVbHaRCp50a8qdW4Oyh1JFQz2sUMPcBEpVC/SpU+BPLoYSmduRcJF2GWQvCoc5lZwlkUyLrMetlm/y29//UbRqtYqjOC0e2TjIFcnkhCl4nAQf50jYJeaCxodTUizTaMDDq7M0BesLBOwJw0b2ZRG4+lp6W0lEMzqABz7AeYNXENHAW9mfdAeSW+N15qnMHyh7ufeCJbAnFVbt6uMgE6nOh4mcwJsbZABuTrABMTGmIrIuFCsp0RUAJoAy2bQ2CqDmFjYpjKKRISkVdIS2/JBUkRWzhMN2QpQcgIdRyyS3PjRDeSKVNWXjhDDuFpG4e5lBEZ4rQBApNgbuunCONB1aR6aVeO7ZkAHEEWQACwcjopEkF+Amt/EIOfjBpXF+bDmswQjNjaJCw5nDWc/dGhQIcz4upp257q1msMIvuTi32avb5Ligq3dsoLlh9dRYTQnxsN7mBTc/5gN4tUBqbqSalq1H3IzzAW5n1U6KH7anF/5lmspmdfN75G+s2U9v7BzuoTb0kPz2t/8mLxlVgozlxFJrlCuWTMtHcPC9Flx5i7ZCmUEvKs3h0ReDRCpGPthDFw+sUIO23302ASO7ZSkbAPiCmfLpoX8jtZ9wKRYCAxVL5QW4KIVgsDRUTasvb+ATJoVp3YknjOG3xgJnHi1bYOzhSX1bPgkqSdKttY4L/9pR+dhQnsX1D65GyW5oOC2KUeWqW081S2wiQqJkbiwBe4uchwaRmilprG82i4ce6Pkd8EaQ48gN4CvjY6+l6945yeAmhHOBuQELSeUC77kqH39yAFZUhsWQlW5oTaxSjZ6lGqLm8HotoudWCiac5YOER80Jd8iOi+f3YbELY2LDSpxrWAtV7ZA3Dv70ZlGz3xHbkV4YCvudj3aFcjp1/YlpaZ/14RKNeCqumLPyB2FTva3vcuhzAdzp2stWNOOOiY+9MCD1TH+fL0ysuUQYakOgvPJEM77QBQ7Pu+iD4Rt4NyzyZ/0lcnQDK28EYZDwiDnbjdMadl4cviQXjzrdIKwcGm4gUjde7j3b3X+zC8DAEliE9TrdThdNzFKblIrKSPg+WiGkmgpF5bbG+lm19bNq62fV1s+qrZ9VWz+rtn5Wbf2s2vpZtfWzavceu+tn1dbPqi3LQ7B+Vm39rFozlcf6WbX1s2rrZ9XuBT7Xz6qtn1X77PyS62fVioL1s2rrZ9VO1s+qrZ9VO1k/q3Y/coOvn1VbP6t2Jzrc+lm19bNq62fV1s+qrZ9V+wO9VrV+Vu1rUOD6WbX1s2q3zty9flZtEVOtn1VbP6u2flbtxk8NrJ9V+x24d/2s2vpZtfWzastF0PpZtfWzavfDKbR+Vm39rNr6WbX1s2rrZ9XWz6rdqXFm/aza+lm1/2fPqlWSkGxkCeWikl7MZkE6bjy2dhoGY8iStH0cXF0BRb5VyWwGn3/NMffK8WkYXFDFIYgfEyyFPiEQZD05Z5A455m9YdI+guFDu85457mRVwoyGtkW9gb6yrrVRE6HB2+OIGWLexAulTGmnKMTyJJCJzaVTSWVCn67ChIqRjmmYQlsnzObQHtcT4B0jgmQ3B+VXC6QFaiEsJ4ZyU4D/g+TWtjg6somV5rNivq2aGkLh1hfG5bvdDab/S9NYJSf","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Signing Links","permalink":"/docs/API-docs/v1.2/getsigninglinks"},"next":{"title":"Create Template","permalink":"/docs/API-docs/v1.2/createtemplate"}}');var s=t(74848),r=t(28453),o=t(57742),l=t.n(o),a=t(78178),d=t.n(a),c=t(19624),p=t.n(c),h=t(96226),m=t.n(h),u=(t(77675),t(19365),t(51107)),g=t(21312);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:"eJztPV1zGzeSfwU3dXWOuUOKpCXHVuquTrEVR1lb0tlyHFvSasEZkIQ1A0wAjChaxap92H9wT/e6Py2/5KobwHzxQ7KseJU75iEWB1+NRnej0d1oXAWGjnSwfRwcsTRLqGE6OA2DmOlI8cxwKYLt4GjMiC8mzxUdGi5GZOdwjzBBBwnTJNdMaWIkiRSDSlGujUz5JyglxvccEs3UBbSlmgySnGWKC6PJUCoyYoIpih3HMspTBgUTbsYkUyxmQy5YTLRReWRyxXSHvM2kIDqPIqb1ME/syFwKIoeEFmOGxIwZgqqYyZXQhJJc8F9zRlotOfjIIrMXt1rkm5hpPhLUsBiA883PePwwJJMxj8YkooIMGEw1hpk6gFkF3AGFMilwTJ2xiA85VHaddchOHHOAkSbJNCSUtFq5SlotwjXJlLzgMYv9aHI4BJRSRC3hwjA1pBFDXDHoRYxwGN85oSImQxrxhJs6GknMtVF8kMPInRNxIo54tk3eZomkMZnKXJHD5z+U1Y0k8O241XrOBvmIvN1rtU6/GRuT6e2NDZplHZkxAdhK6EB3IpluxFAxi4eIK6YY9Ir4YlTzZEpoHJMJj0fMaFwQQSKZTUkkpYq5sKSR0REjIk8HTOkQZ5NKxQgXhBLFaDxtG9nONSM/vTnYBzSk1HTIYZLrsBgu5opFJpna7gE9flYP7Oo83gQa4mIUkpSeA5a4Ib/mPDqHaWsmcGkdySCuWq13AG+BHa4djceEmDHXZMIGYynPCbuA4glPEmIUH42YarVOxF//+tcTcXUiCDkJsMZJsE1OAtfFSRDaIjPNmC15fvDs7avd/aOzo/eHu0W5p9RGnb3nRY0hT5o9vH39sigWNG0W7++8KgcQ0rjyw4RRzYhiF5xNcB1gqe1cPRaKZhU5YVsXJdCIKQ1fj+ELIVf2nzo0b/Ze7O++rsJia7CU8qRWZffVzt7LWp1sLEW9m8MfD/br/eSq0sve/guLFFs+g39OHbxuRXbcAh3tvdp9c7Tz6hAqz9w6AjW8ybNMKlj+d5agt2GZT8T3LJETQhVD6olkmkpBMqpoygzKxjE1WKzYrzlXLLbCjSaJ54ztE9EmrRbgZrvVIm+tlOIxEwbkiELWtySHDTq2PpAO1N8TMY+AlaxYmGYMJGGtKrAYVH3jRJOtWmE8kF1W/ABHTaiVBlkCggeqKgZSzfALVu/4MiRT6Pg5Azqy3Y6l4p+kMDRBIrpgyvCIJlWmBwBRVBqqUGRlkgvjv7oRyHvH3MD7yNJOKgFoMSA35QJLNCMXNMmZdlBNQjIGqF6zTDGNEtr1C4gXMRkzPhovHY/GH3Ntah2TXHu566FwY/lVRfQyRNuQJpoRPqzhMqXnrDIakZndDzrk+ymJ2ZDmiQkJB3llVM46ZF8aQrMs4RHupUADdqPKFWvjKjvy6dTJ59DuJ7CDxBz2EpBOUIhduDYeOqBLuwHB9FDumjEVRIrGQkcykWqehPBzHY8kksIwYTpk54LyBIG3k9WEiyjJY0YGCY3OQ9QEQqJg74NVmbIkkZPQ8gdWwR0ZcY74IZolQIVSAPxCuuG5LvfcDjkCRin4Dwo9qnEQrqtYdTJ/KGFkQIFnSYJyKETEheSjHBDDTcJCYPCMimlIYqtksEszkJchicYsOse/FI25JIPcGCnsxGIls1hOhMPlUAqj+acFHOlLPh+j/ZBshuRxSJ6EpNcNSa8fkt5mSHqPQ9J7EpJ+NyT9fkj6myHpP7Zg9Z84XNMCwVUAen2LZfPHwu6Yx+wMGp7B3M6oNkxxfQ7imuCOblXXOHRa1KUpFDfYueLajj/mccwEGSqZEsUinnGUJlYaFF2HAA9RMCmhyTBPkim54JpXcFB0KicC1Tr4yhU5yJh4A9ssjSKZwxojhi1SEZ3lkotkCqAeMZpqnPkuKIeZ4pqBqBa6wIAwJW1ZdQi+VQXATVZS1CXQ8tVctjqVlYEd9CXXKHNh69PFbjqp7aa9Dmm1CjnXVKRKbamoUugdsJtBWc/9voQfj/rfup9T+Pm4/8T9nGDV3qb7OYaffd/UMRd8c7rLSQAIdHqSFbCkAgJUmgH4pcLQx4kYmmYrJgHFX2sCfqOCj7DDhL6g1Mmq8CyZs63h5lvO9hHMlgtuOE308gn7Gvdozg2QFk+7rDQ3802YOYqz5dN2Ou29mXMVHlSBYRu1RbjtVor8hoBQ9FegqNnnMjEMrVBBmsPkVsdpMcsRaadwb/BYAeeu0Njo8vOx+BiwCDvqEeyoy1FZbLr3CJ9NmO4KqYv6/XzMfttBPRgVlOV4dRXuEVbrEN0VTud7/XyMPgGMgqa3HJ1Qeo9wWQHHWkFQbbZl3c12b6vd7/Y3a/gEc5WtkKbtOG5Pp9MvW4uUizMLR8XuggX0cnEBWNFAeyxWoigBHYaLUdGsXjq/6rZeYyFB53SYALXTn0Ct3gsWSlSf580LePova7kzD/7tj+Sv4CA+YIWR1CnOFRurtwdWT9FGxnT6QNuufNPi8AX1m+qxBROLAA60jUZjySMHPNTxR64BGHw6gIM2LupGHG9UFhU+xnE7TduNj/CzjTRQ+ZimnTjuNGrOEYr9mJI4Dsn854Xf45ikabrks/1e+7yRpvOz6KSpg81hz9Pe3DqnXPA0h0MSmFntGT1G0/eRR2/q1pIL0mq9f//+ffvVq/bz562WX0M3hKPiii3DjkAv72iEKtG3Wttkb0iqn9CeYC05KAWKsyHa1n2FsZwIfySyJk8S52Bg9lWtPSmlU+yMcTNmqj6OVCXJwgESzlsDacYd8hbPl/C3P4cV5yU8Sz0FwekOx8tlp6vwtcRnKSXrA68UrctFU022zqlFXjBli/UmxUZ5QhW7BAOgbhqpb7sHft7+1hCLnpZLYwuaFp1xl3lbB/nmwB3DHxYWxsZcoLcd52kjio3YJcmoMUwJ7OyCJjy2HrG29Rpd0jQD68rGX05O4j/96wbadsF8aqxRIeYjDg6ajb8c77Q/nC6okWcZUxG4BxIGI+mQMBN1yPGYJVnpI5pMJp3JIx2NpUysg+ijVmxo/38mBx/PENysQ3X2cNFMLTFUbKlALE1TKjJnBWNUE99ygTUVlwa5ptdFDc4ZK1aocK7GPdI7GiBBoTVMn6CbJUgpKrdAvKz8W4LMOQlOy+0e7acsvqbt6Q3YE7ghoQOWzBd9PmsldCpzx9HeX1CfqqPoCt6cKlSYhHE63YoHKKWXjcKT0vvT4FOLkCqb+t3es6dfAZJwXWwkNXRWWzuvAfp+BLN+4wEjvgEZFFT6xVxQAHYzNvAmUly7a4aAegQrFh4bP9o1I9QWZm4nd7qCdz0Ni149yvxGXsUXtASXeKkmrBjB6QrLR3A+/SUDnIgeGiK9AXPF+cTVuEeyogHSaja+jRSp7cy32VJvxYB+WlUGXLC9QlW7sRbMp5dzX4ccWKu6bwQW9yhiGWhaX8yaBcg33qHQalw1oi+nvGqte0R9C8D6nSnQ1bvr3edWRFqd/R+IUGtg35hYrdE/paMV9hssvkfkWYVnsYnD1ZgzVvXQ0m93lBUWaixfPeFetzbhrfqEH3dvceKqDfvlB67uCvzMDQVn6zyhc9tBzCKe0gSDSBDu/hfw6G0OXw4w4IFnMs1yU2U6NOugYPFagg+NsM7dP4WkHZJWSDZC8k1IHnbIa4bBFFEReOGUBq5seAWHYLEcPKVRrpIpGSiYeEhYZ9QhV1e/5lQYbqazGWmRqyuIIJzNOsCF50JObOzFMXiNDYFIuvJQFctIL4i8k5HegNPXxj6btJ879/KGA+0h+UY2RMLKo6hDwdc9kVmoKkQCo+wXKps9lWKwD9dZQqeEDsFTbQNCsJmNG+oAirdJn/z7f5Bev9PthqRr/4boTjvB/kPkYfQxRSxZ5aTE4us4uFvl4PLnIpG11b0RC1eHvSUHQxdnGEaA416rsJXMfQ9NJ+VkmsbailYPOLP7px7LPIlh97TxvqwI6Cx0+lbrULEhxGmWEXzEf/I8DRFRLGGpixpzsXtwnMFoBS6MBL7x4Ryt1oANJUQqQEApGgZpGeNnx7Zbdy0KBIMOpSJjqq2dBTENEEPErBmztBEz4cEr4ya48LADKffuziLYf1on7sdbNeLequ9PS4l7GQWvMBRCE51JoQt/ICuLKlSnigDahUeLJiX5TmG5MWSmjPxBIYaEk/BzVpU1XGivpTkom5Fwz8ZS6rKGC0Zzcldv14PcpII4t4edIjTkS91evW8f1ZSIJ1/R7VVfpe7mRm9rY6Xfq+Ei+fzDIiE3WVK0qt9oSbFmuaZrp9CXOIW+nCMe3aVhtvdtv3aeeLRqc74nhtkqR11jkr0Lw+utzraLLKBVPryh7fOr2SC/nCw3fw9rTENwf9v7J1hjvpRE54wud0aU5K4sLoso8wYml5V2li+m3Cqwvzv1bt2NeaZx1nla0waf9qvUurX1ZdTaNM5USO4k4D9/f/B60v3zi5Hc2dnZ2X/zdrz7drSzs5PC706ns9Bkt4gMcBjQn93FMLfFo7qwZJROp4PuemroNjbfyMToO9s+XN6m4+Lxfic/wtbX9iN8udwoqn6dPWuR0+D3kwxfyrNBGMgML8NKsRcH20EMV279Rc8gxFVj2nwv42mwfRW4eyHwp4vTh5YbHzVc3r0KdDRmKYW//GrDdV+4LxiE/ppeEAYYGQl3f4Eag2135TAIIbYiA3M409AHttu+8rXsbcogdJp+sB1YbgjCwMUbFJ8IE5GE4K0sHgazEHs6y6jWE6nilV0WX8ouoQML8Wc21PhHcW0W+oE7a7fsBpvOGvelb9VTtYdZuS5lZ1QpOg2aV7P9ZTUfAONikLzVL5n67YgbMMcVN6iwWhAG3LC0OsqSVVfy8zEdMQkzwYjw2ywviKDbtMNrobdp6GJZb9P0oxyc3Yocy7U+uzmO6yRQvzsGvRR6hr+qVMRLuvC1TEm4Nt8hO3CJh8VOWd8uA+PAuVGYTR9u2wjMMb1gBLZIRsEcJSqXX+rXBOHqMPSwTV6ziPELB1v1ijneLgb75XfWzY99C9m4zUgzIGzfFbSxV57c93q330H7JkTFfVsrWJnIUxB/BQNYUIMw8EOBCKxwp603CwMH2AKOvCEP2dL59a2vZn1FSLucUGiv3XSukye+PvICHVXHtCbTuTGPlt0Crlw+dIZVmmWMqg5exr11lgBMFEGTKMfEBcWmW5tZAWoxs94sDC6vn8wliWTbXzEm3yRsaGzcGomkEkw9rMYh35vJ9Tc3Z2EwvX560z/k9L6FxZtcP7t3eDe7vLf+z4D10ZNZGIyvh/XH4vb4PxHYzcezUhNySQyK5CUDGU/PvNyaXVfRqxxQDzJh7IkDFTNVQcRAyoRRMYcJiJy2B+AHcIh4ENpoUbwmypX26oZNjqHsjlDsR1ZYO5XW3h/zF+3AbbgLH1AJ1/lAQy3h+9O2wwHzCTcgQ4ytwW2GFXS/MBqNIbWHi2EtvYcZ5LiQufbggRcGdICEgWPFunSLKO7qKb2CnUqUuJ17p7o68MVh84yLMwktzmzc+g3QiteUG4i1k7HwckiiI6NzuP4APE8xF06RoMBvtrkwPMHbthngPvbB6YBA3HWbc6YYTdchu2IoVcQ0sRBXcFuiBQ9DeOpgGnK/CPKggp0HeDpKdIEc8tziEBf0ARo66hjDT7MwoLANnsnhMOGCIWneig79PEFF1vkAApmpTQ4DnuUicY/P6OLs+bxMAORvg7ur3oKwS4iwpgkxUiZ4wLRXuW2+lJtP0F4/Pzg6vMG80KzUtoC5K+FI+bYPcnB0COk1+NCd/ODiQMEdnt1orQqBkxi54NRfwS/2+6lVx5j1pkif/KWkp45LbNEm8wDFXC+EKCTU3xYvMkXNdVxm7wG2lbkBJ6hLl0S0YZlegcgjmd9EUl2DSUpGOd4vMiDGfa4NjHMv02NwYdNQoYXBXfZYqFx7PHmsQKVK/yFhQtvmlAzRGR5CbirAvMrBnlB0yS4zpjgEnSxEgWIWdWe5WnjSWnVeePv6pcvZVLnC4uWq7xgYIEOqQUkxJ2KaU58/4jABom/ZkW5eHcVQGneMyZjSkNdLEalGVPBPLs8XaKlgXxmwMU1sVbd9gCMOxRzQaw0Yv//+9vd/VOBaekadB8yOQOMYwiKugRCNSJbgQQAplsGuKOsQQX9M/WdTMQgKIZjKuGAkfXMaP8R7G7oQgS6ooAhq0Hk0BpNAsQfrsLjg7o4aGq1SRW4MmcF82SXXppL3wZ8t5+XDa3dFq4TBblNxbGXptMrgZbCFbHSHGSp4PQNMoRrNbxy5kWeKpVzcTHepWu6NLARBbmRKDY+I70p36nl9rEPZ83VahhgBNV5wqR4uBM/wlB3JZ27HfU6n+npFE9qgduhakZhOESM+FV2pNrLLjKtpcZESfdUek9ecrrZQkMBkz6SIGOgr7IKpGxxJKrFaANiAmQljooo5v4Sy0BZsLhFUGGor1rh1V8MhQJgyNWJnEZyqkSfYDZa41YKuWi3StoA4ia9z5ey8LmMXijaQcmXvAI7LrVNcOi3VpWravA75UU4AYSHJbAY1sA3a/gGfBCF36WaqI0RU4I0/MDFDHpaKHgI3GHiZe87FAiEp4Wz2rGkvsmZm6AUyTME44ao5eele3KalkCXKj+41HpgcmGgJTSRyuxkvSo+DQO1hgqAx7o64fuDJsuP4rF2oJf32t/+BTIc+glJ3YApLSzHkCrVHvPpY7dUzm2dHZ9xpcpuQhg+nZ1KclVJuIcHUW64koAXhW3VFS7g9Agf3+hZQOlAHINrusfBP3X41t77LBwOE3NGA+9IwMK6NqIqTYk+zy2gwUyKtEpIdahk1oHFuCdlRY2g0ZphTKGYZ5FqU7rhgN+AHZR4iWE8wXzFxhk6Tm5jd3KY9q6zmcQC+FfSYxEFoPUvB6SwMBlF02x5hP/9P9xs36hA/9Wvf5lKoDqKIfDNIOKCHqoG0GTAfbjtVncbAh6iGNbT22qJa5KM4qelfvHJw7ZDiP4dEGx64yEC52pfgN/gy/SlLB3AdAUMd8RSMmqAs3Ql1i+fvZjJdZf90YXpr6+cfyDzY63b/L1s/H3X/ONbPze4fyPr5BIB17vTrpcmy0+dC2eHDA1Y3+CiZ9RwmUq2uCTsQOL1dMMMiBJfs0J/Z/0qDrRfi1xhxrZW39PM7A6SfDKKh3+3CPw0h6O1d3hRWZtZOpv8ShDcPMli9Bj6R8WpkfT/u/6gzkUZjwNkSq0ZZfTWJVYMnNtj0p/HgRcQP+E97bz/t9fb5nt4Tr7eiZ3uP986zX35+9tPTDpv+1Iv6P09/6f9s3r9L9N5HyaMffxp/ED/rwbOt/P0vH9T7X/bU+3evDX23tTMQYzF48QOPplsfB/0uf/nsp+6Hd73J4MUP3Q8/P80+YOc/dD+cn3ejdP/ZQOxAnez9L//FDz7uPnr1affTq6Pdy1efkqcduv/rx2eX0dNX57uP2x/2VPvVweDPH3812eut+NH+L/zxE/aKvRNH3ZdRjRq4QFOpX+oznPcZLLalpM1Fy/5Gpszq7RPMXq0kKHzuAGPUlNARnEAAdeoOqYApdR2/fB5kqxCx2e2e9QokbM0jYU9gZgHMEn8kz5n4ujOtDm/s8ADqZZqUQivgthKWB7XJVr/bSWoW5YqbabB9fBVctmnG27Z8+/h0dgpnaDOWEFeUSY0QUzMOtoONZpgRJOvHGJTjK8uDBaNpKmKIvJ1jNprxjYtepx/Mwmabhcy5oj7L25/bRBs64mJ0XbvTEkVvYBntStUQVSqsGf8zA43VrUO1VhhwIJ8xo2BqAswDdbwug7N2/Rr7sKlFkVBzgVBBUC5vM1rJByvV4o+aW/OCiKJKQNGxj+bBAJ0iPico5xgUMTRBUImKgR+VOJcgaESulDEVhd5/XNJ9EZXg1fIe6rP9zU1U/L7toYb06AkqH5uPZ6d2mSpuSIxPXOJLc8f2RV4jV1Txt9S+WMeB+1Q3pOMMq4brmvW4aTxeashdYsf1INftle7rIjNhb2uZgW5roV3MdbXYBuIKqwfsxYdld1a++bm3ctxcQAdew6pTAQQXAxU86iIVbHaRCp50a8qdW4Oyh1JFQz2sUMPcBEpVC/SpU+BPLoYSmduRcJF2GWQvCoc5lZwlkUyLrMetlm/y29//UbRqtYqjOC0e2TjIFcnkhCl4nAQf50jYJeaCxodTUizTaMDDq7M0BesLBOwJw0b2ZRG4+lp6W0lEMzqABz7AeYNXENHAW9mfdAeSW+N15qnMHyh7ufeCJbAnFVbt6uMgE6nOh4mcwJsbZABuTrABMTGmIrIuFCsp0RUAJoAy2bQ2CqDmFjYpjKKRISkVdIS2/JBUkRWzhMN2QpQcgIdRyyS3PjRDeSKVNWXjhDDuFpG4e5lBEZ4rQBApNgbuunCONB1aR6aVeO7ZkAHEEWQACwcjopEkF+Amt/EIOfjBpXF+bDmswQjNjaJCw5nDWc/dGhQIcz4upp257q1msMIvuTi32avb5Ligq3dsoLlh9dRYTQnxsN7mBTc/5gN4tUBqbqSalq1H3IzzAW5n1U6KH7anF/5lmspmdfN75G+s2U9v7BzuoTb0kPz2t/8mLxlVgozlxFJrlCuWTMtHcPC9Flx5i7ZCmUEvKs3h0ReDRCpGPthDFw+sUIO23302ASO7ZSkbAPiCmfLpoX8jtZ9wKRYCAxVL5QW4KIVgsDRUTasvb+ATJoVp3YknjOG3xgJnHi1bYOzhSX1bPgkqSdKttY4L/9pR+dhQnsX1D65GyW5oOC2KUeWqW081S2wiQqJkbiwBe4uchwaRmilprG82i4ce6Pkd8EaQ48gN4CvjY6+l6945yeAmhHOBuQELSeUC77kqH39yAFZUhsWQlW5oTaxSjZ6lGqLm8HotoudWCiac5YOER80Jd8iOi+f3YbELY2LDSpxrWAtV7ZA3Dv70ZlGz3xHbkV4YCvudj3aFcjp1/YlpaZ/14RKNeCqumLPyB2FTva3vcuhzAdzp2stWNOOOiY+9MCD1TH+fL0ysuUQYakOgvPJEM77QBQ7Pu+iD4Rt4NyzyZ/0lcnQDK28EYZDwiDnbjdMadl4cviQXjzrdIKwcGm4gUjde7j3b3X+zC8DAEliE9TrdThdNzFKblIrKSPg+WiGkmgpF5bbG+lm19bNq62fV1s+qrZ9VWz+rtn5Wbf2s2vpZtfWzavceu+tn1dbPqi3LQ7B+Vm39rFozlcf6WbX1s2rrZ9XuBT7Xz6qtn1X77PyS62fVioL1s2rrZ9VO1s+qrZ9VO1k/q3Y/coOvn1VbP6t2Jzrc+lm19bNq62fV1s+qrZ9V+wO9VrV+Vu1rUOD6WbX1s2q3zty9flZtEVOtn1VbP6u2flbtxk8NrJ9V+x24d/2s2vpZtfWzastF0PpZtfWzavfDKbR+Vm39rNr6WbX1s2rrZ9XWz6rdqXFm/aza+lm1/2fPqlWSkGxkCeWikl7MZkE6bjy2dhoGY8iStH0cXF0BRb5VyWwGn3/NMffK8WkYXFDFIYgfEyyFPiEQZD05Z5A455m9YdI+guFDu85457mRVwoyGtkW9gb6yrrVRE6HB2+OIGWLexAulTGmnKMTyJJCJzaVTSWVCn67ChIqRjmmYQlsnzObQHtcT4B0jgmQ3B+VXC6QFaiEsJ4ZyU4D/g+TWtjg6somV5rNivq2aGkLh1hfG5bvdDab/S9NYJSf",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},f=void 0,b={},y=[];function j(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Draft Template"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/drafttemplate",context:"endpoint"}),"\n",(0,s.jsxs)(n.p,{children:["The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique ",(0,s.jsx)(n.strong,{children:"objectId"})," (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a ",(0,s.jsx)(n.strong,{children:"url"})," is provided, which offers a user interface for editing the template and facilitating document distribution."]}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"When document is created this webhook event will trigger"})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE",\n "url": "SIGNING_URL"\n }\n ],\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Unique identifier for this widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Specify the hint for widgets. This parameter is optional and is not applicable to the following widgets: checkbox, radio button, dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "hint": "Provide signature"\n }\n\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp",\n "hint": "Provide stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials",\n "hint": "Provide initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide email",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide name",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide job title",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide company",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12,\n "min_date": "",\n "max_date": "",\n "readonly": false,\n "signing_date": false,\n "hint": "Provide date"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"min_date:"})," Provide the minimum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"max_date:"})," Provide the maximum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"signing_date"}),": If signing_date is set to true, the signing date is shown to the signer during signing. You may set either signing_date or default, but not both. Using both is not supported."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image",\n "hint": "Provide image"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"14",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Provide number",\n "formula": "",\n "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,s.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"decimalplaces:"})," Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"15",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"cells"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "cells",\n "page": 1,\n "x": 100,\n "y": 100,\n "w": 114,\n "h": 50,\n "options": {\n "name": "cells",\n "required": true,\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"cell_count:"})," Specify the number of cells that should be returned to the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,s.jsx)(n.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "required": true,\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "response": "04/15/2024",\n "format": "mm/dd/yyyy",\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "required": true,\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 528,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "values": ["male", "female", "other"],\n "response": "female",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(g.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{...t(50988)}),"\n",(0,s.jsx)(m(),{...t(23638)})]})}function w(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(j,{...e})}):j(e)}},50988(e){e.exports=JSON.parse('{"title":"Body","body":{"content":{"application/json":{"schema":{"required":["file","signers","title"],"type":"object","properties":{"file":{"type":"string","format":"base64","example":"base64 encoded pdf"},"file_password":{"type":"string","format":"string","example":""},"title":{"type":"string","format":"string","example":"sample template"},"note":{"type":"string","format":"string","example":"sample note"},"description":{"type":"string","format":"string","example":"sample description"},"signers":{"type":"array","description":"You can provide signer optionally if you it as default signer","items":{"type":"object","properties":{"role":{"type":"string","format":"string","example":"ceo"},"email":{"type":"string","format":"string","example":""},"name":{"type":"string","format":"string","example":""},"phone":{"type":"string","format":"string","example":""},"company":{"type":"string","format":"string","example":""},"job_title":{"type":"string","format":"string","example":""},"signer_role":{"type":"string","format":"string","description":"Specifies the role of the recipient in the signing process. Allowed values:\\n- **signer** (default): Must have at least one signature widget.\\n- **viewer**: Receives the document to view only; must have no widgets.\\n- **approver**: Reviews and approves the document; no signature widget required.\\n","enum":["signer","viewer","approver"],"example":"signer"},"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Allowed values - signature, stamp.","format":"string","example":"signature"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":244},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":71},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":38},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":46}},"title":"createtemplate_body_widgets"}}},"title":"createtemplate_body_signers"}},"sendInOrder":{"type":"boolean","description":"If set to \'true\', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to \'true\'.","example":true},"send_in_order_strict":{"type":"boolean","description":"When set to \'true\', each signer is blocked from accessing the document until all preceding signers have completed their action. Enforces strict sequential signing. Only applies when \'sendInOrder\' is also \'true\'. Defaults to \'false\'.","example":false},"allow_offline_sign":{"type":"boolean","description":"If set to \'true\', signers can submit a copy of documents created from this template signed using an external tool for owner review. Defaults to \'false\'.","example":false},"enableOTP":{"type":"boolean","description":"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.","example":false},"enableTour":{"type":"boolean","description":"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.","example":false},"redirect_url":{"type":"string","description":"Specifies the URL where the signer will be redirected upon completing the document signing process.","example":""},"sender_name":{"type":"string","description":"The name of the person or organization on whose behalf the email is being sent.","example":"opensign\u2122"},"sender_email":{"type":"string","description":"The email address of the person or organization that users can reply to.","example":"mailer@opensignlabs.com"},"allow_modifications":{"type":"boolean","description":"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.","example":false},"auto_reminder":{"type":"boolean","description":"Set to true to enable automatic reminders. Set to false to disable them (default behavior).","example":false},"timeToCompleteDays":{"type":"number","description":"time to complete days is used to calculate expiry date of your document","format":"number","example":15},"remind_once_in_every":{"type":"number","description":"Number of days between reminders. This is only applicable when auto_reminder is set to true.","example":5},"merge_certificate":{"type":"boolean","description":"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\\n\\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\\n\\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\\n","example":false},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed. \\n"},"prefill":{"type":"object","description":"You can provide widgets which can embed before sending to signer","properties":{"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","format":"string","example":"textbox"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":100},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":30},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":40},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":80},"options":{"type":"object","properties":{"name":{"type":"string","example":"textbox"},"response":{"type":"string","example":"joe"},"color":{"type":"string","example":"red"},"fontsize":{"type":"number","example":12}}}}}}},"title":"prefill"}},"title":"createtemplate_body"}}},"required":true}}')},23638(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Template created successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","example":"Bh2Hspnmch"},"url":{"type":"string","example":"https://app.opensignlabs.com/drafttemplate/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2VtYWlsIjoicHJhZnVsbC5uYXZrYXIrYWRtaW5AbnhnbGFicy5jb20iLCJ0ZW1wbGF0ZV9pZCI6IkF0Zkk0cmNCbnAiLCJpYXQiOjE3MzEzMTExMzl9.aNqjCxc9MkE6-ZIr-MObKjqtpR5d3NXi68eMeWnT0Lc"}},"title":"inline_response_draft_200"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/257dcba5.a133040b.js b/assets/js/257dcba5.a133040b.js new file mode 100644 index 000000000..41d297a6f --- /dev/null +++ b/assets/js/257dcba5.a133040b.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[5824],{50172(e,n,t){t.r(n),t.d(n,{assets:()=>b,contentTitle:()=>y,default:()=>w,frontMatter:()=>g,metadata:()=>i,toc:()=>f});const i=JSON.parse('{"id":"API-docs/v1.2/drafttemplate","title":"Draft Template","description":"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.","source":"@site/docs/API-docs/v1.2/drafttemplate.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/drafttemplate","permalink":"/docs/API-docs/v1.2/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":"eJztPdt2G0dyv9KZzYlF7AAEIFKW6GSzNEXL9EokI1KWJZJLNmYaQIsz3ePuGYIQzXP2YU8+ICcved2fyHs+xV+SU9WXmcGNFHVZOoHP2RUxfa+uqq6uqq66CnI60MHGUXDI0iyhOdPBSRjETEeKZzmXItgIDoeMuGLyVNF+zsWAbO7vECZoL2GaFJopTXJJIsWgUlToXKb8PZSS3PUcEs3UBbSlmvSSgmWKi1yTvlRkwARTFDuOZVSkDApGPB+STLGY9blgMdG5KqK8UEy3yKtMCqKLKGJa94vEjMylILJPqB8zJPmQ4VQVywslNKGkEPzngpFGQ/besSjfiRsN8iBmmg8EzVkMk3PNT3m8EpLRkEdDElFBegyWGsNK7YRZZbo9CmVS4Jg6YxHvc6hsO2uRzTjmMEeaJOOQUNJoFCppNAjXJFPygscsdqPJfh9AShG0hIucqT6NGMKKQS9igMO4zgkVMenTiCc8r4ORxFznivcKGLl1LI7FIc82yKsskTQmY1kosv/0u7J6Lgl8O2o0nrJeMSCvdhqNkwfDPM/0xuoqzbKWzJgAaCW0p1uRTFdjqJjFfYQVUwx6RXgxqnkyJjSOyYjHA5Zr3BBBIpmNSSSlirkwqJHRASOiSHtM6RBXk0rFCBeEEsVoPG7mslloRn442NsFMKQ0b5H9pNChHy7mikV5MjbdA3jcqr4yu/NoDXCIi0FIUnoOUOI5+bng0TksWzOBW2tRBmHVaLyG+XrocG1xPCYkH3JNRqw3lPKcsAsoHvEkIbnigwFTjcaxODs7OxZXx4KQ4wBrHAcb5DiwXRwHoSnKxxkzJU/3tl692N49PD18s7/tyx2mTtTZeepr9Hky2cOrl899saDpZPHu5otyACFzW76fMKoZUeyCsxHuA2y1WauDgm9W4ROmtS+BRkxp+HoEXwi5Mv/UZ3Ow82x3+2V1LqYGSylPalW2X2zuPK/VyYZS1LvZ/35vt95PoSq97Ow+M0Ax5dfwz4mdr92RTbtBhzsvtg8ON1/sQ+Vru4+ADQdFlkkF2//aIPQGbPOx+JYlckSoYog9kUxTKUhGFU1ZjrxxSHMsVuzngisWG+ZGk8RRxsaxaJJGA2Cz0WiQV4ZL8ZiJHPiIQtI3KIcNWqY+oA7U3xExj4CUDFsYZww4Ya0qkBhUPbCsyVStEB7wLsN+gKJG1HCDLAHGA1UVA66W8wtW7/gyJGPo+CkDPDLdDqXi76XIaYJIdMFUziOaVIkeJoisMqcKWVYmucjdVzsCeWOJG2gfSdpyJZhaDMBNucASzcgFTQqm7axGIRnCrF6yTDGNHNr2C4AXMRkyPhjOHY/G7wqd1zomhXZ8183CjuV2FcHLEGx9mmhGeL8Gy5Ses8poRGbmPGiRb8ckZn1aJHlIOPCrXBWsRXZlTmiWJTzCsxRwwBxUhWJN3GWLPq06+uyb8wROkJjDWQLcCQqxC9vGzQ7w0hxAsDzku/mQCiLFxEZHMpFqGoXwcx2OJJIiZyJvkc0LyhOcvFmsJlxESREz0ktodB6iJBASBWcf7MqYJYkchYY+sAqeyAhzhA/RLAEslALmL6QdnuvyzG2RQyAUT39Q6ECNg3Bdharl+X0JIwMIHEkS5EMhAi4k72SP5DxPWAgEnlExDklshAx2mffkZUiiIYvO8S9FYy5Jr8hzKczCYiWzWI6EhWVfilzz9zMo0pV8OES7IVkLyaOQPA5Jpx2STjcknbWQdB6FpPM4JN12SLrdkHTXQtJ9ZKbVfWxhTT2AqxPodA2U898WdIc8ZqfQ8BTWdkp1zhTX58CuCZ7oRnSNQytFXeZecIOTK66d+EMex0yQvpIpUSziGUduYriB7zqE+RAFixKa9IskGZMLrnkFBr5TORIo1sFXrshexsQBHLM0imQBe4wQNkBFcJZbLpIxTPWQ0VTjyrdBOMwU1wxYtdAeAiIvccuIQ/CtygBus5OizoHm7+a83ansDJygz7lGngtHn/an6ah2mnZapNHwfG5SkCqlJV/Fyx1wmkFZx/6+hB8Pu1/bn2P4+aj72P4cYdXOmv05hJ9d19QSF3yzsstxAAC0cpJhsKQyBah0DdMvBYYuLiSnabZgEVD8pRbgDir4CCdM6ApKmaw6nzlrNjXsesvVPoTVcsFzThM9f8Guxj1a88SUZi+7rDS18jVYObKz+cu2Mu29WXN1PigCwzFqivDYrRS5AwFn0V0Aosk+57FhaIUC0hQk11tWipkPSLOEewPHynQ+FRgnuvxwKD4CKMKJeggn6nxQ+kP3HsFzck6fCqiz+v1wyH7dQjkYBZT5cLUV7hFU6zP6VDCd7vXDIfoYIAqS3nxwQuk9gmVlOkYLgmKzKWuvNTvrzW67u1aDJ6irTIU0bcZxczwef9xepFycmnlU9C5YQC9nF4AWDaRHvxO+BGQYLga+Wb10etdNvYmNBJnTQgLETncDNXIvaChRfJ5WL+Dtv6xl7zz4t7uSv4CLeI95JakVnCs6VqcPrN6icxnT8VfadOWa+ssX1J8Uj800sQjmgbrRaCh5ZCcPddyVqwcKnxbAoImbuhrHq5VNhY9x3EzT5sRH+NlEHKh8TNNWHLcmak4hivmYkjgOyfTnmd/jmKRpOuez+V77vJqm06topamdm4Wew72pfU654GkBlyRQs5o7eoyq70MH3tTuJRek0Xjz5s2b5osXzadPGw23h3YIi8UVXYYZgV5+ohGqSN9obJCdPql+Qn2C0eQgF/B3Q9StuwpDORLuSmRUniQuQMHsqhp9UkrH2Bnj+ZCp+jhSlSgLF0i4b/VkPmyRV3i/hL/dPczfl/Au9QQYp70cz+edtsKXYp8ll6wPvJC1zmdNNd46JRY5xpTNlpsUGxQJVewSFIB6Ukl91zPww863CbbocLlUtqBq0Sp3mdN1kAd79hq+4jWME2uB3jatpY0oNmCXJKN5zpTAzi5owmNjEWsaq9ElTTPQrqz++fg4/v0/rqJuF9SnuVEqxHzAwUCz+uejzebbkxk1iixjKgLzQMJgJB0SlkctcjRkSVbaiEajUWv0UEdDKRNjIHqnFeub/z+VvXenON2sRXW2MmulBhkqulRAlklVKhJnBWJUE9dyhjYVtwapptNGCc4qKxaIcLbGPZI7JqYEhUYxfYxmliClKNwC8rLybwk85zg4KY971J+y+Ia2J7cgT6CGhPZYMl304aSV0LEsLEU7e0F9qRajK3CzopBXCeNy2hULUEovJwqPS+vPBJ0agFTJ1J32jjzdDpCEa3+Q1MBZbW2tBmj7EczYjXuMuAak57H0o6nAT+x2ZOBUpLh3NwwB9QhW9BYbN9oNI9Q2Zuokt7KCMz31fa8OZO4gr8ILWoJJvBQTFoxgZYX5I1ib/pwBjkUHFZFOgbngfmJr3CNeMTGlxWR8Fy5SO5nvcqTeiQDdsqoEOON4harmYPXEp+dTX4vsGa26awQa9yhiGUhaH02afsq3PqFQa1xVos/HvGqte4R9M6b1mTHQ1vvUp8+dkLS6+t8QotamfWtkNUr/lA4W6G+w+B6hZ3U+s1UctsaUsqqDmn5zoizQUGP54gV32rUFr9cX/Kh9hxtXbdiPv3C1F8Bnaii4WxcJnToOYhbxlCboRILz7n4Ejd7l8mUnBjSwJdOsyKtEh2odZCxOSnCuEca4+/uQNEPSCMlqSB6EZKVFXjJ0poi844UVGrgy7hUcnMUKsJRGhUrGpKdg4SFhrUGLXF39XFCR83x8fU0a5OoKPAivr1tAhedCjozvxRFYjXMCnnTlpSqWkZ7heScjvQq3r9VdNmo+teblVTu1FfJATrCEhVdRC4IveyMzs6ogCYyy60U2cytFZx+us4SOCe2Dpdo4hGAz4zfUAhBvkC75lz+QTrfVboekbf4G706zwO4K0jDamCKWLDJSYvFNFNyuUnD5cxbLWm/fioSrw96RgqGLU3QjwHFvFNhK4r6HqpNyMZPK2opUDzAz56ceyiKJ4fQ0/r7MO3R6mb7R2FesD36apQcfcZ8cTYNHFEtYar3GrO8eXGfQW4GLXALdOHeORqPH+hI8FcChFBWDtPTxM2Obo7vmBYJOh1KRIdVGz4KQhhmDx2w+ZOmEz4SbXuk3wYWbO6By59NpBLtP6sj9aL2G3Ov182kucs/D4AWKQmiiMym0tweysqiCdco70M68WkxikusUthtdZkrPH2RiiDgJP2dVXsOFdlKaneWkJ9zWUEpd1rDOaJbv6o26k5tU4Oe20vKuIR9r9up8/bAmRDz+gmav+i6111Y766sL7V4TJpIPvywScpstRa36rbYUa5Z7ujQKfYxR6OMp4uGnVMx2vu7W7hMPFx3O90QxW6WoG1Syn0Lxeqe77SwNaJUOb6n7/GI6yI9Hy7XPoY2ZYNxfd/4O2piPRdEppcsnQ0ryqTQuszDzFiqXhXqWj8bc6mQ/O/aufxr1zMRd50lNGnzSrWLr+vrHYeukcqaCcscB//HbvZej9p+eDeTm5ubm7sGr4farwebmZgq/W63WTJXdLDTAYUB+tg/D7BGP4sKcUVqtFprraU43sPlqJgbfmPbh/DYt64/3mewI61/ajvDxfMNX/TJn1iyjwefjDB9Ls0EYyAwfw0qxEwcbQQxPbt1DzyDEXWM6/1bG42DjKrDvQuBP66cPLVffaXi8exXoaMhSCn+53YbnvvBeMAjdM70gDNAzEt7+AjYGG/bJYRCCb0UG6nCmoQ9st3HlapnXlEFoJf1gIzDUEISB9TfwnwgTkQTnrSzuB9ch9nSaUa1HUsULu/Rfyi6hAzPjD2yo8Q//bBb6gTdrd+wGm15PvJe+U0/VHq7LfSk7o0rRcTD5NNs9VnMOMNYHyWn9krE7jngO6jj/ggqrBWHAc5ZWR5mz60p+OKQjJmEl6BF+l+0FFnSXdvgs9C4NrS/rXZq+k73TO6Fjudent4dxHQXqb8egFy9nuKdK3l/Suq9lSsKz+RbZhEc8LLbC+kbpGAfGDa82XdkwHphDesEIHJGMgjpKVB6/1J8JwtNh6GGDvGQR4xd2btUn5vi6GPSX3xgzP/Yt5MRrRpoBYruuoI158mS/17v9BtpPzsi/tzWMlYkiBfbnCcBMNQgDNxSwwAp1mnrXYWAnNoMib0lDpnR6f+u7Wd8R0iwXFJpnN62b+Imrj7RAB9Uxjcp0aszDea+AK48PrWKVZhmjqoWPce8cJQADRdAkKjBwgT90ayvzU/Ur61yHweXNi7kkkWy6J8bkQcL6ufFbI5FUgqmVqh/yvVlcd23tOgzGNy9v/Jtc3teweaObV/ca32aX79b/HnN9+Pg6DIY3z/V7/3r87zjZtUfXpSRkgxj44CU9GY9PHd+6vqmiEzmgHkTC2BF7KmaqAoielAmjYgoS4DltLsBfwSXiq9B4i+IzUa60EzdMcAxlTgR/HhlmbUVa837MPbQDs+E2fEAhXBc9DbWE60+bDnvMBdyACDGmBjcRVtD8wmg0hNAe1oe1tB5mEONCFtpND6wwIAMkDAwrxqTrvbirt/QKdCpe4mbtreruwBcLzVMuTiW0ODV+67cAKz5TngCsWYyZL4cgOjI6h+cPQPMUY+H4AAXusC1EzhN8bZsB7GPnnA4AxFN3cs0UvelaZFv0pYqYJmbGFdiWYMHLEN46mIbYL4J8VYHOV3g7SrQHDnlqYIgb+hUqOuoQw0/XYUDhGDyV/X7CBUPUvBMeunWCiKyLHjgyUxMcBizLPnCPi+hi9fm8DADkXoPbp96CsEvwsKYJyaVM8IJpnnKbeCm3X6B5fr53uH+LdaFaqWkmZp+EI+abPsje4T6E1+B9e/ODhwOeOhy50VoVAjcxcsGpe4Lvz/uxEceYsaZIF/ylxKeWDWzRJNMTirmeOaOQUPda3EeKmuq4jN4DZCuLHIygNlwS0TnL9AJAHsriNpzqBkhSMijwfVEObNzF2kA/9zI8BhcmDBVqGOxjj5nCtYOTgwpUqvQfEia0aU5JH43hIcSmAsirAvQJvkt2mTHFwelkJggUM6A7LdTMm9ai+8Krl89tzKbKExbHV13HQAAZYg1yiikWM7n06SsOE8D65l3ppsVRdKWx15iMKQ1xvRSRakAFf2/jfIGUCvqVHhvSxFS1xwcY4pDNAb7WJuPO31//+rfKvObeUacnZkagcQxuETfMEJVIBuGBASmWwako6zOC/pj646RgEHgmmMrYE5K+PY7v47sN7VmgdSrwTg26iIagEvBnsA79A3d71dColfKxMWQG62WXXOeVuA/ubjnNH17aJ1rlHMwxFceGl46rBF46W8iJ7jBCBa9HgPGi0fTBUeTyVLGUi9vJLlXNfS49IyhymdKcR8R1pVv1uD7GoOzoOi1djAAbL7hUKzOnl/OUHcote+I+pWN9s6AJbVA6tK1ITMcIEReKrhQb2WXG1dg/pERbtYPkDberdWQksNhTKSIG8gq7YOoWV5KKrxZMrMfyEWOiCjm3hdJLCyaWCAoMtR2beHVXgyHMMGVqwE4juFUjTbBbbHGjAV01GqRpJmI5vi6U1fPaiF3I2oDLlb3DdGxsHf/otBSXqmHzWuR7OQKAhSQzEdRAN2j6B3gSnLkNN1MdIaICX/yBihnisFTkEHjBwMvYc9YXCFEJV7NjVHuRUTNDLxBhCsYJF63JcXf/mpZClCg3upN4YHGgoiU0kUjt+XBWeByc1A4GCBri6Yj7B5YsM46L2oVS0q9/+S+IdOg8KHULljC3FF2uUHrEp4/VXh2xOXK0yp1JahMy5/3xqRSnJZebiTD1lgsRaIb7Vl3QEvaMwMGdvAWYDtgBgDZnLPxT119N7e/8wQAgn2jAXZkzUK4NqIoTf6aZbcwxUiKtIpIZah42oHJuDtrRPKfRkGFMoZhlEGtR2uuCOYC/KuMQwX6C+oqJUzSa3EbtZg/t68puHgVgW0GLSRyExrIUnFyHQS+K7tojnOd/tL/xoA7xU7f2bSqEai+KyINewgE8VPWkiYC5smFFdRoDHaIYNiG11zbVAB/ZSU3+4pWLa4v4/wwQv/RSYaWfe40WPYzj4yzV62IriRNdysCuLO3BQwt04sT7Pcq4sjSU1HW5n00ZvEizax0Ql3rd35Dis9Nu/1/W6z5s/3b0umvt35Be9zFM1joK3MxN5t2rZ/IO5/iwuME7yYxNNJFqcU04W8Gcb900ZgG4JIfutfmvVEU7Jn6Detror0sPBqtadYtBMHTbbfhnggk6TZ5T8pUxw5PxPwTh7d0nFu+BC9G8GFjfDrvf60yk0RBgNkdfU1ZfjGJVt5BVNv5h2HsW8T3+w86r9zudXb6jd8TL9Whr59HOefbTj1s/PGmx8Q+dqPvj+Kfuj/mb14neeSd59P0Pw7fiR93bWi/e/PRWvflpR715/TKnr9c3e2Ioes++49F4/V2v2+bPt35ov33dGfWefdd+++OT7C12/l377fl5O0p3t3piE+pkb376N773bvvhi/fb718cbl++eJ88adHdn99tXUZPXpxvP2q+3VHNF3u9P737Oc9erscPd3/ijx6zF+y1OGw/j2rYwAUqgd1Wn+K6T2GzDSatzdr2A5kycyMZYVxuJUGUtVezXI0JHcDdCkCnPiEWMKVuopcPm9kiQKy126cdD4T1aSDsCIyZgPHvD+U5E192pdXhczM8TPUyTUqmFXBTCcuD2mKr380iNYsKxfNxsHF0FVw2acabpnzj6OT6BLQD+VCCx1QmNc6Y5sNgI1iddKCCNAToXXN0ZWjQE5qmIgaf4ilioxlfvei0usF1ONlmJnEuqM+K5oc20TkdcDG4qd1JCaID2EazUzVAlQJrxv/EQGK1+1CtFQYc0GfIKCjRAPKAHS9Lt7Ntt8fOIWyWj9eUi1cQlNs76Yfl3LBqnlWTR/MMX6mKq9SR81NC1yPveRSUawy8d1AQVPx94EfFgycIJnxySm8RL/cflXjv/S2cWN5Beba7toaC39cdlJAePkbhY+3R9YnZpoqBFT0v51gJrUJilj3MFlUsSbUvxiRiP9VNBLjCqkq+phefVIvPVVHP0VC7Kdc1sfbrLAVoZ32e6nF9psbPdjVbu2MLq6qD2WoAqwW4/TX3w2pXLqczsMbJY3WcASdrwJmHbcSZtTbizON2TRS0O1b2UAp0KLV5oc0utxTMQPo6AWrmoi+RFViE9+GngVMjK5mkvN/5ENW//vVvvhroj/5AGo1DfALFRFPLQkWMwDtkE846QWspZgz49S//SXoFT0wA6phdsATOE8gIogpt4xwwH8tat0wo6Oq4A3Qlw4j1XhmAprnY2OOamCiEsGbpWADcBeRskg+VLAZD1IeJAcTBerl9cAiZYyDVBzkAfVRpEa7F2YdkIQLu0ZVMNrmCwPTO8KVzmhdoClEMbMMcApqjo5oxJDCjigfruaroNBLeZ9E4SgxwTC4IY/q8YCKWioB5v8lN5Oxmswn//O535JnRzJEDiJzIYvi6DfTivSjQhBtRpcZmXH8AOx32WYXbnxHD53EQdKquFG6Qf4Yeyg9/qOTC+PXf/4McfS9HtXQ49QFv/379wCxKr27u76CssmL2fxfD3inmrJTgjT3g4l9Bq4RraTTsoU2YuOBKCgAteC+e3fpQP8NbWqZkLm1KBWuA7vchtJAYkAQwGPz+J7ZiC/RFWzSjPUi8w5mG77+QLZqzgVRj8gt5DRYAn6BGkl+OxS/NZhP/B1UbDfdqXzca5BeyhdcU42QSkiIzIfAVu5DnFqdihlagMg2E2/YSfW3PPqcT9vxtwZOYKFboelomn2apie/vfSz2b3xCHHD1lAqoYOxteXaIA5b0m0CfOMQzhwUaPk8oh3UJV+/CIi4wXZEUpA/5U2yn+0Uv4RGpT/9giPYAkplCR3oJF+dIPsJp69DLv8yz4qAMMiB5LdU5jGR6BO+XcnZo63QwAWdpaGH8Tftc0IRra+tD0dz1uwU5TiK7eS8Mn0AasJOJTDnpQZKgTMmBoimaFtE723bynUzAUoZ97KEJWVdnZp+sejb9VAE69k0j18drk4jIdGL9bpEdNdGAaPITVVWtmhjMRBcWwkRs0q/Y7lBpa/vKFWegqTXJCYySHyQKcCw2SgzYwV/qpAGIjyadXTYCvuMOjN8B2YDdhakyq5gdgybH4uzZ9iFZ9ffaDR6f4Yj177DHZ8Z/qQfWRp0rRtME04QBNigWFyKGN1iVJDwm/04qL8DoJWJIiWPf/QNpmyCbozJygDOJJWOjfLM7WnbYaPg8Ul4RgTmvjO9MJIUuUhMmB1a9byXh5r6SuXGrACubTSl0LKCcnB3Xxebj4MxxbUfnoA8xttORVOfcWeeYiNQ4s72CvdoHCZBi41ic7e8dHJLVum7ljPzPf5Oz/VdTEMfPlQYOGVc3KrnRqtWQWlytqYKJ8bAAeASA9MzBZ8+It+TAkjaQlpLJsQDL+9nxDCHYvVsivxg74BnouOcsFHFoxkrB6n8J92AOvkfWAQAkFGvet+N5hoOxNMENz+d1c/M/MPjxUiZwDoBQdGa55Rkxt2jEL/NcCGyuZ8fViwbsdJ8z0OhGSmqNAoFPa6dkkTO0pStm3PwNPvtQEBvm6IHRgdkbN4RCTR04dk5npOH9+5F1oczgXAwWevkbFnFmXOfPSm4z4eXfl84tzhj+LZP2ITasp7vpzLnfQ3dbVNi3BmLsq7NLgJo9OkqnUa7Qb8QwH2QtxvS0BU5+D7a2VmByNmHLsdgkgo0A7FFUQtuSfRlTAy3ePkiAd3g5O4YbQ9lOlqb5sJJwEPHdJE5zh6DfxVVznvvN3K56EzGNJ5fxNPBzLM1kxqjWRPfFO5gFn8PDRr8G8NEltdmQB84lyFBJSfE8PlupOMD5qcF+KUwylVczEaJ+O8QDx3ApgGzCraMBTDfLxwQNZuTB2dHJ2co3RIJrpnEYBtDmknAxZIrnM7qeEMHKbEjbpfxn5bDKF6AJ0LCBw9u0DHZgREQ87z5AbvQCi7+C1HtYqK/xrbdfgf19qvFNeqKzyRP3R6Ygfgzs0T+Rb2l0PqIq1hj1iuYcJdQxVIXGgBwmRVHPVWxGtmJiJGBy0TGp2zqtjr+gODFBOycVcD25MANbj41KqiLjSdBzcMdehSQ9xcypGQ2pGAAhgIxQOag5MP64iAwt4Hyha5+aqBDGVQFemY64dbaJJxDjlWZwvXvOxTmiQ5MceQnqNetpnrN6zOJJSK9gm++KJCFORkeCu+FSY5o94/n3RQ+Sz0nNc6nGZasBz4dFD/ey2tb/sB04Wdprbz/mMoVdHjKVooPHAeRhjW5Y/irk1tOrK+hbM6FErGsH0GcH+I6uXQVpxu2188jNg9QjRX/4OoxRCkVq1EJbFRXN+EwXSlzCXt+u12pUF683CIOER8xayKy2ZfPZ/nNy8bDVDsKKavYWe7n6fGdre/dgGyZjySTYCDqtdquNhnyp85SKykjmnnJY6kUn3pZ69f0yLe8yLe8yLe8yLe8yLe8yLe8yLe8yLe8yLe8yLe+9h+4yLe8yLe+8OFbLtLzLtLyToeCWaXmXaXmXaXnvBTyXaXmXaXk/OD75Mi2vL1im5V2m5T1epuVdpuU9XqblvR+5ZZZpeZdpeT+JDLdMy7tMy7tMy7tMy7tMy/sbyna6TMv7JTBwmZZ3mZb3zplflml5ZxHVMi3vMi3vMi3vrVNVLdPyfgbqXablXablXablnc+Clml5l2l574dRaJmWd5mWd5mWd5mWd5mWd5mW95MqZ5ZpeZdpef+fpeWtBG9bzRLKRSWIq4k1eTSRrPckDIYQi3LjKLi6Aox8pZLra/j8c4ER7o5OwuCCKg5O/BjGMnRhFyFa3DmD8IRb5oVJ8xCGD80+45vnieidEDfStNjEpS+sWw2XCQFTIDCeTSicyhgD+9IRRJejIxMwsBKCDr9dBQkVgwLD1wWmz2uTgGVYDzN5jmEm7R+VGHgQe7GcYT3+pFkG/D8samaDqysTwvL62tc3RXNbWMC62rB9J9fX1/8Lsj84PQ==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Signing Links","permalink":"/docs/API-docs/v1.2/getsigninglinks"},"next":{"title":"Create Template","permalink":"/docs/API-docs/v1.2/createtemplate"}}');var s=t(74848),r=t(28453),o=t(57742),l=t.n(o),a=t(78178),d=t.n(a),c=t(19624),p=t.n(c),h=t(96226),m=t.n(h),u=(t(77675),t(19365),t(51107)),x=t(21312);const g={id:"drafttemplate",title:"Draft Template",description:"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.",sidebar_label:"Draft Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztPdt2G0dyv9KZzYlF7AAEIFKW6GSzNEXL9EokI1KWJZJLNmYaQIsz3ePuGYIQzXP2YU8+ICcved2fyHs+xV+SU9WXmcGNFHVZOoHP2RUxfa+uqq6uqq66CnI60MHGUXDI0iyhOdPBSRjETEeKZzmXItgIDoeMuGLyVNF+zsWAbO7vECZoL2GaFJopTXJJIsWgUlToXKb8PZSS3PUcEs3UBbSlmvSSgmWKi1yTvlRkwARTFDuOZVSkDApGPB+STLGY9blgMdG5KqK8UEy3yKtMCqKLKGJa94vEjMylILJPqB8zJPmQ4VQVywslNKGkEPzngpFGQ/besSjfiRsN8iBmmg8EzVkMk3PNT3m8EpLRkEdDElFBegyWGsNK7YRZZbo9CmVS4Jg6YxHvc6hsO2uRzTjmMEeaJOOQUNJoFCppNAjXJFPygscsdqPJfh9AShG0hIucqT6NGMKKQS9igMO4zgkVMenTiCc8r4ORxFznivcKGLl1LI7FIc82yKsskTQmY1kosv/0u7J6Lgl8O2o0nrJeMSCvdhqNkwfDPM/0xuoqzbKWzJgAaCW0p1uRTFdjqJjFfYQVUwx6RXgxqnkyJjSOyYjHA5Zr3BBBIpmNSSSlirkwqJHRASOiSHtM6RBXk0rFCBeEEsVoPG7mslloRn442NsFMKQ0b5H9pNChHy7mikV5MjbdA3jcqr4yu/NoDXCIi0FIUnoOUOI5+bng0TksWzOBW2tRBmHVaLyG+XrocG1xPCYkH3JNRqw3lPKcsAsoHvEkIbnigwFTjcaxODs7OxZXx4KQ4wBrHAcb5DiwXRwHoSnKxxkzJU/3tl692N49PD18s7/tyx2mTtTZeepr9Hky2cOrl899saDpZPHu5otyACFzW76fMKoZUeyCsxHuA2y1WauDgm9W4ROmtS+BRkxp+HoEXwi5Mv/UZ3Ow82x3+2V1LqYGSylPalW2X2zuPK/VyYZS1LvZ/35vt95PoSq97Ow+M0Ax5dfwz4mdr92RTbtBhzsvtg8ON1/sQ+Vru4+ADQdFlkkF2//aIPQGbPOx+JYlckSoYog9kUxTKUhGFU1ZjrxxSHMsVuzngisWG+ZGk8RRxsaxaJJGA2Cz0WiQV4ZL8ZiJHPiIQtI3KIcNWqY+oA7U3xExj4CUDFsYZww4Ya0qkBhUPbCsyVStEB7wLsN+gKJG1HCDLAHGA1UVA66W8wtW7/gyJGPo+CkDPDLdDqXi76XIaYJIdMFUziOaVIkeJoisMqcKWVYmucjdVzsCeWOJG2gfSdpyJZhaDMBNucASzcgFTQqm7axGIRnCrF6yTDGNHNr2C4AXMRkyPhjOHY/G7wqd1zomhXZ8183CjuV2FcHLEGx9mmhGeL8Gy5Ses8poRGbmPGiRb8ckZn1aJHlIOPCrXBWsRXZlTmiWJTzCsxRwwBxUhWJN3GWLPq06+uyb8wROkJjDWQLcCQqxC9vGzQ7w0hxAsDzku/mQCiLFxEZHMpFqGoXwcx2OJJIiZyJvkc0LyhOcvFmsJlxESREz0ktodB6iJBASBWcf7MqYJYkchYY+sAqeyAhzhA/RLAEslALmL6QdnuvyzG2RQyAUT39Q6ECNg3Bdharl+X0JIwMIHEkS5EMhAi4k72SP5DxPWAgEnlExDklshAx2mffkZUiiIYvO8S9FYy5Jr8hzKczCYiWzWI6EhWVfilzz9zMo0pV8OES7IVkLyaOQPA5Jpx2STjcknbWQdB6FpPM4JN12SLrdkHTXQtJ9ZKbVfWxhTT2AqxPodA2U898WdIc8ZqfQ8BTWdkp1zhTX58CuCZ7oRnSNQytFXeZecIOTK66d+EMex0yQvpIpUSziGUduYriB7zqE+RAFixKa9IskGZMLrnkFBr5TORIo1sFXrshexsQBHLM0imQBe4wQNkBFcJZbLpIxTPWQ0VTjyrdBOMwU1wxYtdAeAiIvccuIQ/CtygBus5OizoHm7+a83ansDJygz7lGngtHn/an6ah2mnZapNHwfG5SkCqlJV/Fyx1wmkFZx/6+hB8Pu1/bn2P4+aj72P4cYdXOmv05hJ9d19QSF3yzsstxAAC0cpJhsKQyBah0DdMvBYYuLiSnabZgEVD8pRbgDir4CCdM6ApKmaw6nzlrNjXsesvVPoTVcsFzThM9f8Guxj1a88SUZi+7rDS18jVYObKz+cu2Mu29WXN1PigCwzFqivDYrRS5AwFn0V0Aosk+57FhaIUC0hQk11tWipkPSLOEewPHynQ+FRgnuvxwKD4CKMKJeggn6nxQ+kP3HsFzck6fCqiz+v1wyH7dQjkYBZT5cLUV7hFU6zP6VDCd7vXDIfoYIAqS3nxwQuk9gmVlOkYLgmKzKWuvNTvrzW67u1aDJ6irTIU0bcZxczwef9xepFycmnlU9C5YQC9nF4AWDaRHvxO+BGQYLga+Wb10etdNvYmNBJnTQgLETncDNXIvaChRfJ5WL+Dtv6xl7zz4t7uSv4CLeI95JakVnCs6VqcPrN6icxnT8VfadOWa+ssX1J8Uj800sQjmgbrRaCh5ZCcPddyVqwcKnxbAoImbuhrHq5VNhY9x3EzT5sRH+NlEHKh8TNNWHLcmak4hivmYkjgOyfTnmd/jmKRpOuez+V77vJqm06topamdm4Wew72pfU654GkBlyRQs5o7eoyq70MH3tTuJRek0Xjz5s2b5osXzadPGw23h3YIi8UVXYYZgV5+ohGqSN9obJCdPql+Qn2C0eQgF/B3Q9StuwpDORLuSmRUniQuQMHsqhp9UkrH2Bnj+ZCp+jhSlSgLF0i4b/VkPmyRV3i/hL/dPczfl/Au9QQYp70cz+edtsKXYp8ll6wPvJC1zmdNNd46JRY5xpTNlpsUGxQJVewSFIB6Ukl91zPww863CbbocLlUtqBq0Sp3mdN1kAd79hq+4jWME2uB3jatpY0oNmCXJKN5zpTAzi5owmNjEWsaq9ElTTPQrqz++fg4/v0/rqJuF9SnuVEqxHzAwUCz+uejzebbkxk1iixjKgLzQMJgJB0SlkctcjRkSVbaiEajUWv0UEdDKRNjIHqnFeub/z+VvXenON2sRXW2MmulBhkqulRAlklVKhJnBWJUE9dyhjYVtwapptNGCc4qKxaIcLbGPZI7JqYEhUYxfYxmliClKNwC8rLybwk85zg4KY971J+y+Ia2J7cgT6CGhPZYMl304aSV0LEsLEU7e0F9qRajK3CzopBXCeNy2hULUEovJwqPS+vPBJ0agFTJ1J32jjzdDpCEa3+Q1MBZbW2tBmj7EczYjXuMuAak57H0o6nAT+x2ZOBUpLh3NwwB9QhW9BYbN9oNI9Q2Zuokt7KCMz31fa8OZO4gr8ILWoJJvBQTFoxgZYX5I1ib/pwBjkUHFZFOgbngfmJr3CNeMTGlxWR8Fy5SO5nvcqTeiQDdsqoEOON4harmYPXEp+dTX4vsGa26awQa9yhiGUhaH02afsq3PqFQa1xVos/HvGqte4R9M6b1mTHQ1vvUp8+dkLS6+t8QotamfWtkNUr/lA4W6G+w+B6hZ3U+s1UctsaUsqqDmn5zoizQUGP54gV32rUFr9cX/Kh9hxtXbdiPv3C1F8Bnaii4WxcJnToOYhbxlCboRILz7n4Ejd7l8mUnBjSwJdOsyKtEh2odZCxOSnCuEca4+/uQNEPSCMlqSB6EZKVFXjJ0poi844UVGrgy7hUcnMUKsJRGhUrGpKdg4SFhrUGLXF39XFCR83x8fU0a5OoKPAivr1tAhedCjozvxRFYjXMCnnTlpSqWkZ7heScjvQq3r9VdNmo+teblVTu1FfJATrCEhVdRC4IveyMzs6ogCYyy60U2cytFZx+us4SOCe2Dpdo4hGAz4zfUAhBvkC75lz+QTrfVboekbf4G706zwO4K0jDamCKWLDJSYvFNFNyuUnD5cxbLWm/fioSrw96RgqGLU3QjwHFvFNhK4r6HqpNyMZPK2opUDzAz56ceyiKJ4fQ0/r7MO3R6mb7R2FesD36apQcfcZ8cTYNHFEtYar3GrO8eXGfQW4GLXALdOHeORqPH+hI8FcChFBWDtPTxM2Obo7vmBYJOh1KRIdVGz4KQhhmDx2w+ZOmEz4SbXuk3wYWbO6By59NpBLtP6sj9aL2G3Ov182kucs/D4AWKQmiiMym0tweysqiCdco70M68WkxikusUthtdZkrPH2RiiDgJP2dVXsOFdlKaneWkJ9zWUEpd1rDOaJbv6o26k5tU4Oe20vKuIR9r9up8/bAmRDz+gmav+i6111Y766sL7V4TJpIPvywScpstRa36rbYUa5Z7ujQKfYxR6OMp4uGnVMx2vu7W7hMPFx3O90QxW6WoG1Syn0Lxeqe77SwNaJUOb6n7/GI6yI9Hy7XPoY2ZYNxfd/4O2piPRdEppcsnQ0ryqTQuszDzFiqXhXqWj8bc6mQ/O/aufxr1zMRd50lNGnzSrWLr+vrHYeukcqaCcscB//HbvZej9p+eDeTm5ubm7sGr4farwebmZgq/W63WTJXdLDTAYUB+tg/D7BGP4sKcUVqtFprraU43sPlqJgbfmPbh/DYt64/3mewI61/ajvDxfMNX/TJn1iyjwefjDB9Ls0EYyAwfw0qxEwcbQQxPbt1DzyDEXWM6/1bG42DjKrDvQuBP66cPLVffaXi8exXoaMhSCn+53YbnvvBeMAjdM70gDNAzEt7+AjYGG/bJYRCCb0UG6nCmoQ9st3HlapnXlEFoJf1gIzDUEISB9TfwnwgTkQTnrSzuB9ch9nSaUa1HUsULu/Rfyi6hAzPjD2yo8Q//bBb6gTdrd+wGm15PvJe+U0/VHq7LfSk7o0rRcTD5NNs9VnMOMNYHyWn9krE7jngO6jj/ggqrBWHAc5ZWR5mz60p+OKQjJmEl6BF+l+0FFnSXdvgs9C4NrS/rXZq+k73TO6Fjudent4dxHQXqb8egFy9nuKdK3l/Suq9lSsKz+RbZhEc8LLbC+kbpGAfGDa82XdkwHphDesEIHJGMgjpKVB6/1J8JwtNh6GGDvGQR4xd2btUn5vi6GPSX3xgzP/Yt5MRrRpoBYruuoI158mS/17v9BtpPzsi/tzWMlYkiBfbnCcBMNQgDNxSwwAp1mnrXYWAnNoMib0lDpnR6f+u7Wd8R0iwXFJpnN62b+Imrj7RAB9Uxjcp0aszDea+AK48PrWKVZhmjqoWPce8cJQADRdAkKjBwgT90ayvzU/Ur61yHweXNi7kkkWy6J8bkQcL6ufFbI5FUgqmVqh/yvVlcd23tOgzGNy9v/Jtc3teweaObV/ca32aX79b/HnN9+Pg6DIY3z/V7/3r87zjZtUfXpSRkgxj44CU9GY9PHd+6vqmiEzmgHkTC2BF7KmaqAoielAmjYgoS4DltLsBfwSXiq9B4i+IzUa60EzdMcAxlTgR/HhlmbUVa837MPbQDs+E2fEAhXBc9DbWE60+bDnvMBdyACDGmBjcRVtD8wmg0hNAe1oe1tB5mEONCFtpND6wwIAMkDAwrxqTrvbirt/QKdCpe4mbtreruwBcLzVMuTiW0ODV+67cAKz5TngCsWYyZL4cgOjI6h+cPQPMUY+H4AAXusC1EzhN8bZsB7GPnnA4AxFN3cs0UvelaZFv0pYqYJmbGFdiWYMHLEN46mIbYL4J8VYHOV3g7SrQHDnlqYIgb+hUqOuoQw0/XYUDhGDyV/X7CBUPUvBMeunWCiKyLHjgyUxMcBizLPnCPi+hi9fm8DADkXoPbp96CsEvwsKYJyaVM8IJpnnKbeCm3X6B5fr53uH+LdaFaqWkmZp+EI+abPsje4T6E1+B9e/ODhwOeOhy50VoVAjcxcsGpe4Lvz/uxEceYsaZIF/ylxKeWDWzRJNMTirmeOaOQUPda3EeKmuq4jN4DZCuLHIygNlwS0TnL9AJAHsriNpzqBkhSMijwfVEObNzF2kA/9zI8BhcmDBVqGOxjj5nCtYOTgwpUqvQfEia0aU5JH43hIcSmAsirAvQJvkt2mTHFwelkJggUM6A7LdTMm9ai+8Krl89tzKbKExbHV13HQAAZYg1yiikWM7n06SsOE8D65l3ppsVRdKWx15iMKQ1xvRSRakAFf2/jfIGUCvqVHhvSxFS1xwcY4pDNAb7WJuPO31//+rfKvObeUacnZkagcQxuETfMEJVIBuGBASmWwako6zOC/pj646RgEHgmmMrYE5K+PY7v47sN7VmgdSrwTg26iIagEvBnsA79A3d71dColfKxMWQG62WXXOeVuA/ubjnNH17aJ1rlHMwxFceGl46rBF46W8iJ7jBCBa9HgPGi0fTBUeTyVLGUi9vJLlXNfS49IyhymdKcR8R1pVv1uD7GoOzoOi1djAAbL7hUKzOnl/OUHcote+I+pWN9s6AJbVA6tK1ITMcIEReKrhQb2WXG1dg/pERbtYPkDberdWQksNhTKSIG8gq7YOoWV5KKrxZMrMfyEWOiCjm3hdJLCyaWCAoMtR2beHVXgyHMMGVqwE4juFUjTbBbbHGjAV01GqRpJmI5vi6U1fPaiF3I2oDLlb3DdGxsHf/otBSXqmHzWuR7OQKAhSQzEdRAN2j6B3gSnLkNN1MdIaICX/yBihnisFTkEHjBwMvYc9YXCFEJV7NjVHuRUTNDLxBhCsYJF63JcXf/mpZClCg3upN4YHGgoiU0kUjt+XBWeByc1A4GCBri6Yj7B5YsM46L2oVS0q9/+S+IdOg8KHULljC3FF2uUHrEp4/VXh2xOXK0yp1JahMy5/3xqRSnJZebiTD1lgsRaIb7Vl3QEvaMwMGdvAWYDtgBgDZnLPxT119N7e/8wQAgn2jAXZkzUK4NqIoTf6aZbcwxUiKtIpIZah42oHJuDtrRPKfRkGFMoZhlEGtR2uuCOYC/KuMQwX6C+oqJUzSa3EbtZg/t68puHgVgW0GLSRyExrIUnFyHQS+K7tojnOd/tL/xoA7xU7f2bSqEai+KyINewgE8VPWkiYC5smFFdRoDHaIYNiG11zbVAB/ZSU3+4pWLa4v4/wwQv/RSYaWfe40WPYzj4yzV62IriRNdysCuLO3BQwt04sT7Pcq4sjSU1HW5n00ZvEizax0Ql3rd35Dis9Nu/1/W6z5s/3b0umvt35Be9zFM1joK3MxN5t2rZ/IO5/iwuME7yYxNNJFqcU04W8Gcb900ZgG4JIfutfmvVEU7Jn6Detror0sPBqtadYtBMHTbbfhnggk6TZ5T8pUxw5PxPwTh7d0nFu+BC9G8GFjfDrvf60yk0RBgNkdfU1ZfjGJVt5BVNv5h2HsW8T3+w86r9zudXb6jd8TL9Whr59HOefbTj1s/PGmx8Q+dqPvj+Kfuj/mb14neeSd59P0Pw7fiR93bWi/e/PRWvflpR715/TKnr9c3e2Ioes++49F4/V2v2+bPt35ov33dGfWefdd+++OT7C12/l377fl5O0p3t3piE+pkb376N773bvvhi/fb718cbl++eJ88adHdn99tXUZPXpxvP2q+3VHNF3u9P737Oc9erscPd3/ijx6zF+y1OGw/j2rYwAUqgd1Wn+K6T2GzDSatzdr2A5kycyMZYVxuJUGUtVezXI0JHcDdCkCnPiEWMKVuopcPm9kiQKy126cdD4T1aSDsCIyZgPHvD+U5E192pdXhczM8TPUyTUqmFXBTCcuD2mKr380iNYsKxfNxsHF0FVw2acabpnzj6OT6BLQD+VCCx1QmNc6Y5sNgI1iddKCCNAToXXN0ZWjQE5qmIgaf4ilioxlfvei0usF1ONlmJnEuqM+K5oc20TkdcDG4qd1JCaID2EazUzVAlQJrxv/EQGK1+1CtFQYc0GfIKCjRAPKAHS9Lt7Ntt8fOIWyWj9eUi1cQlNs76Yfl3LBqnlWTR/MMX6mKq9SR81NC1yPveRSUawy8d1AQVPx94EfFgycIJnxySm8RL/cflXjv/S2cWN5Beba7toaC39cdlJAePkbhY+3R9YnZpoqBFT0v51gJrUJilj3MFlUsSbUvxiRiP9VNBLjCqkq+phefVIvPVVHP0VC7Kdc1sfbrLAVoZ32e6nF9psbPdjVbu2MLq6qD2WoAqwW4/TX3w2pXLqczsMbJY3WcASdrwJmHbcSZtTbizON2TRS0O1b2UAp0KLV5oc0utxTMQPo6AWrmoi+RFViE9+GngVMjK5mkvN/5ENW//vVvvhroj/5AGo1DfALFRFPLQkWMwDtkE846QWspZgz49S//SXoFT0wA6phdsATOE8gIogpt4xwwH8tat0wo6Oq4A3Qlw4j1XhmAprnY2OOamCiEsGbpWADcBeRskg+VLAZD1IeJAcTBerl9cAiZYyDVBzkAfVRpEa7F2YdkIQLu0ZVMNrmCwPTO8KVzmhdoClEMbMMcApqjo5oxJDCjigfruaroNBLeZ9E4SgxwTC4IY/q8YCKWioB5v8lN5Oxmswn//O535JnRzJEDiJzIYvi6DfTivSjQhBtRpcZmXH8AOx32WYXbnxHD53EQdKquFG6Qf4Yeyg9/qOTC+PXf/4McfS9HtXQ49QFv/379wCxKr27u76CssmL2fxfD3inmrJTgjT3g4l9Bq4RraTTsoU2YuOBKCgAteC+e3fpQP8NbWqZkLm1KBWuA7vchtJAYkAQwGPz+J7ZiC/RFWzSjPUi8w5mG77+QLZqzgVRj8gt5DRYAn6BGkl+OxS/NZhP/B1UbDfdqXzca5BeyhdcU42QSkiIzIfAVu5DnFqdihlagMg2E2/YSfW3PPqcT9vxtwZOYKFboelomn2apie/vfSz2b3xCHHD1lAqoYOxteXaIA5b0m0CfOMQzhwUaPk8oh3UJV+/CIi4wXZEUpA/5U2yn+0Uv4RGpT/9giPYAkplCR3oJF+dIPsJp69DLv8yz4qAMMiB5LdU5jGR6BO+XcnZo63QwAWdpaGH8Tftc0IRra+tD0dz1uwU5TiK7eS8Mn0AasJOJTDnpQZKgTMmBoimaFtE723bynUzAUoZ97KEJWVdnZp+sejb9VAE69k0j18drk4jIdGL9bpEdNdGAaPITVVWtmhjMRBcWwkRs0q/Y7lBpa/vKFWegqTXJCYySHyQKcCw2SgzYwV/qpAGIjyadXTYCvuMOjN8B2YDdhakyq5gdgybH4uzZ9iFZ9ffaDR6f4Yj177DHZ8Z/qQfWRp0rRtME04QBNigWFyKGN1iVJDwm/04qL8DoJWJIiWPf/QNpmyCbozJygDOJJWOjfLM7WnbYaPg8Ul4RgTmvjO9MJIUuUhMmB1a9byXh5r6SuXGrACubTSl0LKCcnB3Xxebj4MxxbUfnoA8xttORVOfcWeeYiNQ4s72CvdoHCZBi41ic7e8dHJLVum7ljPzPf5Oz/VdTEMfPlQYOGVc3KrnRqtWQWlytqYKJ8bAAeASA9MzBZ8+It+TAkjaQlpLJsQDL+9nxDCHYvVsivxg74BnouOcsFHFoxkrB6n8J92AOvkfWAQAkFGvet+N5hoOxNMENz+d1c/M/MPjxUiZwDoBQdGa55Rkxt2jEL/NcCGyuZ8fViwbsdJ8z0OhGSmqNAoFPa6dkkTO0pStm3PwNPvtQEBvm6IHRgdkbN4RCTR04dk5npOH9+5F1oczgXAwWevkbFnFmXOfPSm4z4eXfl84tzhj+LZP2ITasp7vpzLnfQ3dbVNi3BmLsq7NLgJo9OkqnUa7Qb8QwH2QtxvS0BU5+D7a2VmByNmHLsdgkgo0A7FFUQtuSfRlTAy3ePkiAd3g5O4YbQ9lOlqb5sJJwEPHdJE5zh6DfxVVznvvN3K56EzGNJ5fxNPBzLM1kxqjWRPfFO5gFn8PDRr8G8NEltdmQB84lyFBJSfE8PlupOMD5qcF+KUwylVczEaJ+O8QDx3ApgGzCraMBTDfLxwQNZuTB2dHJ2co3RIJrpnEYBtDmknAxZIrnM7qeEMHKbEjbpfxn5bDKF6AJ0LCBw9u0DHZgREQ87z5AbvQCi7+C1HtYqK/xrbdfgf19qvFNeqKzyRP3R6Ygfgzs0T+Rb2l0PqIq1hj1iuYcJdQxVIXGgBwmRVHPVWxGtmJiJGBy0TGp2zqtjr+gODFBOycVcD25MANbj41KqiLjSdBzcMdehSQ9xcypGQ2pGAAhgIxQOag5MP64iAwt4Hyha5+aqBDGVQFemY64dbaJJxDjlWZwvXvOxTmiQ5MceQnqNetpnrN6zOJJSK9gm++KJCFORkeCu+FSY5o94/n3RQ+Sz0nNc6nGZasBz4dFD/ey2tb/sB04Wdprbz/mMoVdHjKVooPHAeRhjW5Y/irk1tOrK+hbM6FErGsH0GcH+I6uXQVpxu2188jNg9QjRX/4OoxRCkVq1EJbFRXN+EwXSlzCXt+u12pUF683CIOER8xayKy2ZfPZ/nNy8bDVDsKKavYWe7n6fGdre/dgGyZjySTYCDqtdquNhnyp85SKykjmnnJY6kUn3pZ69f0yLe8yLe8yLe8yLe8yLe8yLe8yLe8yLe8yLe8yLe+9h+4yLe8yLe+8OFbLtLzLtLyToeCWaXmXaXmXaXnvBTyXaXmXaXk/OD75Mi2vL1im5V2m5T1epuVdpuU9XqblvR+5ZZZpeZdpeT+JDLdMy7tMy7tMy7tMy7tMy/sbyna6TMv7JTBwmZZ3mZb3zplflml5ZxHVMi3vMi3vMi3vrVNVLdPyfgbqXablXablXablnc+Clml5l2l574dRaJmWd5mWd5mWd5mWd5mWd5mW95MqZ5ZpeZdpef+fpeWtBG9bzRLKRSWIq4k1eTSRrPckDIYQi3LjKLi6Aox8pZLra/j8c4ER7o5OwuCCKg5O/BjGMnRhFyFa3DmD8IRb5oVJ8xCGD80+45vnieidEDfStNjEpS+sWw2XCQFTIDCeTSicyhgD+9IRRJejIxMwsBKCDr9dBQkVgwLD1wWmz2uTgGVYDzN5jmEm7R+VGHgQe7GcYT3+pFkG/D8samaDqysTwvL62tc3RXNbWMC62rB9J9fX1/8Lsj84PQ==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},y=void 0,b={},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)(u.default,{as:"h1",className:"openapi__heading",children:"Draft Template"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/drafttemplate",context:"endpoint"}),"\n",(0,s.jsxs)(n.p,{children:["The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique ",(0,s.jsx)(n.strong,{children:"objectId"})," (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a ",(0,s.jsx)(n.strong,{children:"url"})," is provided, which offers a user interface for editing the template and facilitating document distribution."]}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"When document is created this webhook event will trigger"})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE",\n "url": "SIGNING_URL"\n }\n ],\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Unique identifier for this widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Specify the hint for widgets. This parameter is optional and is not applicable to the following widgets: checkbox, radio button, dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "hint": "Provide signature"\n }\n\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp",\n "hint": "Provide stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials",\n "hint": "Provide initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide email",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide name",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide job title",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide company",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12,\n "min_date": "",\n "max_date": "",\n "readonly": false,\n "signing_date": false,\n "hint": "Provide date"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"min_date:"})," Provide the minimum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"max_date:"})," Provide the maximum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"signing_date"}),": If signing_date is set to true, the signing date is shown to the signer during signing. You may set either signing_date or default, but not both. Using both is not supported."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image",\n "hint": "Provide image"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"14",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Provide number",\n "formula": "",\n "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,s.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"decimalplaces:"})," Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"15",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"cells"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "cells",\n "page": 1,\n "x": 100,\n "y": 100,\n "w": 114,\n "h": 50,\n "options": {\n "name": "cells",\n "required": true,\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"cell_count:"})," Specify the number of cells that should be returned to the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,s.jsx)(n.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "required": true,\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "response": "04/15/2024",\n "format": "mm/dd/yyyy",\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "required": true,\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 528,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "values": ["male", "female", "other"],\n "response": "female",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(x.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{...t(50988)}),"\n",(0,s.jsx)(m(),{...t(23638)})]})}function w(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(j,{...e})}):j(e)}},50988(e){e.exports=JSON.parse('{"title":"Body","body":{"content":{"application/json":{"schema":{"required":["file","signers","title"],"type":"object","properties":{"file":{"type":"string","format":"base64","example":"base64 encoded pdf"},"file_password":{"type":"string","format":"string","example":""},"title":{"type":"string","format":"string","example":"sample template"},"note":{"type":"string","format":"string","example":"sample note"},"description":{"type":"string","format":"string","example":"sample description"},"signers":{"type":"array","description":"You can provide signer optionally if you it as default signer","items":{"type":"object","properties":{"role":{"type":"string","format":"string","example":"ceo"},"email":{"type":"string","format":"string","example":""},"name":{"type":"string","format":"string","example":""},"phone":{"type":"string","format":"string","example":""},"company":{"type":"string","format":"string","example":""},"job_title":{"type":"string","format":"string","example":""},"signer_role":{"type":"string","format":"string","description":"Specifies the role of the recipient in the signing process. Allowed values:\\n- **signer** (default): Must have at least one signature widget.\\n- **viewer**: Receives the document to view only; must have no widgets.\\n- **approver**: Reviews and approves the document; no signature widget required.\\n","enum":["signer","viewer","approver"],"example":"signer"},"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Allowed values - signature, stamp.","format":"string","example":"signature"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":244},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":71},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":38},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":46}},"title":"createtemplate_body_widgets"}}},"title":"createtemplate_body_signers"}},"sendInOrder":{"type":"boolean","description":"If set to \'true\', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to \'true\'.","example":true},"send_in_order_strict":{"type":"boolean","description":"When set to \'true\', each signer is blocked from accessing the document until all preceding signers have completed their action. Enforces strict sequential signing. Only applies when \'sendInOrder\' is also \'true\'. Defaults to \'false\'.","example":false},"allow_offline_sign":{"type":"boolean","description":"If set to \'true\', signers can submit a copy of documents created from this template signed using an external tool for owner review. Defaults to \'false\'.","example":false},"enableOTP":{"type":"boolean","description":"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.","example":false},"enableTour":{"type":"boolean","description":"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.","example":false},"redirect_url":{"type":"string","description":"Specifies the URL where the signer will be redirected upon completing the document signing process.","example":""},"sender_name":{"type":"string","description":"The name of the person or organization on whose behalf the email is being sent.","example":"opensign\u2122"},"sender_email":{"type":"string","description":"The email address of the person or organization that users can reply to.","example":"mailer@opensignlabs.com"},"allow_modifications":{"type":"boolean","description":"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.","example":false},"auto_reminder":{"type":"boolean","description":"Set to true to enable automatic reminders. Set to false to disable them (default behavior).","example":false},"timeToCompleteDays":{"type":"number","description":"time to complete days is used to calculate expiry date of your document","format":"number","example":15},"remind_once_in_every":{"type":"number","description":"Number of days between reminders. This is only applicable when auto_reminder is set to true.","example":5},"merge_certificate":{"type":"boolean","description":"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\\n\\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\\n\\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\\n","example":false},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed. \\n"},"cc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"cc (carbon copy): Users added here will receive a notification email once the document is completed.\\n"},"prefill":{"type":"object","description":"You can provide widgets which can embed before sending to signer","properties":{"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","format":"string","example":"textbox"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":100},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":30},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":40},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":80},"options":{"type":"object","properties":{"name":{"type":"string","example":"textbox"},"response":{"type":"string","example":"joe"},"color":{"type":"string","example":"red"},"fontsize":{"type":"number","example":12}}}}}}},"title":"prefill"}},"title":"createtemplate_body"}}},"required":true}}')},23638(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Template created successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","example":"Bh2Hspnmch"},"url":{"type":"string","example":"https://app.opensignlabs.com/drafttemplate/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2VtYWlsIjoicHJhZnVsbC5uYXZrYXIrYWRtaW5AbnhnbGFicy5jb20iLCJ0ZW1wbGF0ZV9pZCI6IkF0Zkk0cmNCbnAiLCJpYXQiOjE3MzEzMTExMzl9.aNqjCxc9MkE6-ZIr-MObKjqtpR5d3NXi68eMeWnT0Lc"}},"title":"inline_response_draft_200"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/293ced56.6c072cba.js b/assets/js/293ced56.6c072cba.js new file mode 100644 index 000000000..fc18e6931 --- /dev/null +++ b/assets/js/293ced56.6c072cba.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[3588],{97016(e,t,n){n.r(t),n.d(t,{assets:()=>b,contentTitle:()=>P,default:()=>U,frontMatter:()=>g,metadata:()=>i,toc:()=>I});const i=JSON.parse('{"id":"API-docs/v1.2/update-document","title":"Update Document","description":"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.","source":"@site/docs/API-docs/v1.2/update-document.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/update-document","permalink":"/docs/API-docs/v1.2/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":"eJzdWt1uG8cVfpXTDVBLxJKUHSdFmSKNIyuOUdcSJLkGKgnkcOeQnGo4s52ZJUXIBHJR9AGK3vS2L9H7PkqepDjzs7v88V+SpkAvbEm7Z86c/znnm73PHJvabHCVPdVFNUflbHaTZxxtYUTphFbZILucIbwqOXMIiQqenD0HJqVeWqgsGgtOw1xzMVkBUxyqQO5mCBwdE9KCngADW2IhJqIAHhn14KX2hMyBmwnrGWslV4m704kZgwkuoWSGzdGhsTmsdAUFU0o7KGZMTcOGEyERtCoQhAsSJKGFhcIgc8h7WZ7pEg0jFZ/zbJCFTZJ+WZ41G2WDq/tMsTlmgyzxGgqe5Zkg85TMzbJtmz1/Sgpv7O51VIjcKzXGqBfxMfjnShjk2cCZCvPMupWk3ayYlxKzPMO7UmqO2WDCpCWCYoZzlg3uM7cqPaUzQk2zPJtoM2euebJe3wT+aN3Xmq9ozaaoZ0YvBEcYo9Qt+7Ys73BeSubQwgFzIJFZB1phizYpcJjlWaGVIxMO7jNWllIU3sj9P1na7X5XdD3+Exbe4oZc4gRaehsM/n4FyTjMm2mQWf9LbfJsnWdKu49mc0YqIhhcCFz6eLZiqkJ8tnlv2PHjtqijos1jTWskR0MRucuvWU2UqNhY4unlWYt0rLVEpnaikaIKukEB7R/CUkgJgQecXp7BAg0lpvdVD175nPY0BgsUC0q/NgkUmiMsBAOcMyFzWM5EMaOAX8G8sg5QxRiKpsNWyvsghi7sCsSF3StRHsqBUNOm3OwwBi4MFk6uYCncTFcOGOeCljMJ1mFpe20reilqQ17qyvx4SzKYVoIjB6crAxNtvJS+WJU+zUgDoawzVUGLLfCKvOv1IFL6vTS6QGsbOyWrEFGLfw6obFjOYMKsQ5NDpQRZ3lSlQ16zxLsSjUBV4F4TeOMOff2OBrcfboszNHPhbNKUXMM4B5TozxOwVTEDFt4zVxm0OQglnGDS5mAdm5c2B23A4R3VFXC6pOKJd8I6En4p+BSdBfG2ODpHypGiJcPE6Ln3PtlGrdqBUMvl9Ba7S3KqsPHUmrBKOlgwWe23mUXFh0INteFohkGADzDa6xkqsOho+wdkwQc5ICtmUXTafyx1cYs8KlFQLKQQqUO9Uk5ISgooKUG9okn5GVsgFJrEpRhwMxQGWBEy+0RNtCnQQpAYLB0NipyRgqUHp/78pdqNFpYk8APS9rk6JV0fkIxM2iR/D54GY3mTPvD2ebDXZAZDhg4rI/cVuE1LXYReAYNDXp2/IFEM1qmCJqTemCp1YIzUefji5JXfsdp2hu0UVVY5PTQ4F4rjh5SDi+BInwlO11WgcnrOnCggsbI9iKQhZp1uJ/UcDlK8jXHGFkKbw7cYkNgNqbmh0MMFmlVLSlXNx2h2hHzpH1NKcbayMEa3RFRt2VLk69rxhZfN+37DJkRlG6U3pPwsHLdishpqNWzSfa8dN3XbFrnTIe6dDnThsu1A375ps3UyqXAIgd88HVAkOxmIus4QLfTDbub8tbpWnY4X4T2bUZP5E21IHe8AznHKDJdobegUg2EpZnNgdQTrtBUdaU3o80ZKak9a1AV1UF4mBOYcK2bIyWkcS1ScyqvP5aHn+qBp4XrXvv8oUQ0LLbVpe40Zw1bU7jqc293EXbe8eZWNZYW+paXGdixZcZvdrPNsXBQ/lCOd+F/Fv3uFnme5f/Ro49nO1DIuCjgYS0HmYWbsq0K5OhzE3oZxOkZ9QdlqczacGozvp4mdUSJV2B5AMN7PrSJp+N/WjTRb55kTbqNvHbYGoeGY5or1eu0rlC21siHpHx0d7Y4b9QgZxx/qD6gYTyopV7/46eaH8Ph9nTSz/NG39uzxtyV5JIr0xL170aOjR592Hx51j351+fDzweNfDz77vHd0dPTHLM/u5rIZXjLilrWt5/9uPRBKCoXDZLXho6Oj4afRlI/3WS+OJmWc2RZMCg4TgZID7Wl/QgOiMdr8wNHpHfK9S31SOSn/+B2hQ8V4oivF/9fq7pPo3Qo+Hj6uVfxsV8XnKpiMYJBLfYvq59Cw0ae9vQvbk6ibUS0CkX+fbSjbfh6UtFhURriVx1DuuqwU3fB+cHVDyMQc3UwT/lJWAXRxs2yQ9VN16d+36sw6I35mkSAZ30VmM+dKO+j3LVN8rO96ukRFZ6RkY0tls89K0V887D3K1vn2GlaWH0WPVfdjl1jHpkJN37fupjHVBbkzeGzDYM3JUorfIR0t0R9tqohJzZBRA0seoCg5b/Cfk+Tr2p3boEnCTD4MBtk+k/YCG21cI8s2sIvY/rWH8Pho71Ca8K+9w1d8uTlm0H5bbX1Nt6+b/uxtTWxc1e6Q9nc7sdn58FP9Y6jX5OGJ9uEQ8+60RHVBnqGs9eG07ZRPINF8/5d/1mTUi34JnQ41vRSaXasrUwSQ1/Nj0qFRzFHv8P13f4dxJaTzqAbHBUqqLTanOcDSOT5eBdCnNMKi7XU6xL+971Qs0HrQtu5v0eMiPIAhXYOMrwC7tdWBYEeqv+BmRlfTme+t1VRiDucnF5eTSpI2NFyppiW2NfDimeQwZ4pNWzAmycyK23octI65yuMLBpkEJ+aY+3iPgxyS0Ia0E6bVJ0kxwWJVyGAcmsUT7rRAxbUBmuO7Qvmmv9vt0o9PPoFnocuHC8eMQ05PTyj0IKK0AT8rmDGrsG9djBMCMmpl/AhCrvtNRqPRtWq9HMBviEPz4MtIQ1PP93/9G1x9q5c0y01RERiOWxveHKQyxnVhd+sXPe3PUJb9i6CU7T85e+7PrcPg/5fagSVPxtmdgO+pUL+lTtXr0unEwg2oFsJoRabtdOBg9MGFfXRIfEujnaYK2aB/kwkW3tSSIpgzx7ZccawNwjEr2VhIQcckPX8Dx8zhVJsVvIHXBNrHewbgGt5cqzfdbtf/I9JOp7446XTgDRz7+4UcqEDlscXNqYTq2xhTHCnum/DsJrc34Rs5X6Z49Zy/roTkYLCKsEGNyfvJsDTYLSUrkCe47AsvA1mGoHptKAtWNUYUt7hAOelSfvotnqUosPR4a9C0jV1rrEothAuzxITuDiLTs2osRQGb4l/MmKEJpAwvU+pJoW59+iiduEphXX2hkHg+NWzi4LU2t7RT4EgwVyOdBxCTTZgFTiusN/lEKCaFjVgLUZjE91grx4rovN+HOuFzIApThPcw1vqWQmxq2NxDO0zKVWLyjT/cAo9TM2WK9mokE8pSL1yX6aeGwjGciLUnXuN4pvVtYHIeBzYqR10qR4CL2GU2hyGEyDSglwpQ8VIL5RI7PwhGXs4IpOmvKHSVAAM6Ix3QSULNLXnwzWZqUOB//90/LLzEJdWddGB8QmlDGA6a2sNpDyav1ejZySX0kyf6A8FHfsfN5+TjUQAqx4RFWWeQzalX5j4aDPJKcaZc674PKIAMzvUCuWfZ6ZQGJ/7agDlGY6vSSzDoKkN8LNJah3IVkNTo0YZhp0NHwy2FYT22AjIrwsVFoZWt5thLWp8xa5fa8O6Z0S6AjWdPv4GLqiy1cdeK3sPoOqP7x2EZia+zUaraKc9pWg7I2lKb2wBwuxmgKsyqjFwJLwx8kTCbwbUanZ1eXEI/3F8mM47g3/+C0dmrHYv7x60FdT89SHTDTTKfLYlq58XWfv4F1Qgy6SjZ53QyIQfCRUxtSi2j5bUi5HN0Hfs5Hah8Z3WdDQJ0+ibAoiOCp96iqI+hPZoS6npHM5Ggi58IwFKHEuHVuF9dcKg18Hh7YlP79yLEx7mWdA5QUzSK1XIEYaLy8UWAfEmFhXQKBEOjJZKnw6DLCqOt9Q2B14Kyy+jKoUdaDSIQfYhnm7w8CEcP7U7FPsDAldk5cKJMI+gkzPjQly7fM8SmCjZuaZtuKpwMoUSMqKknPnW12UQqvaFi6+9h4Vik02WM92aqzyNW0sQf2B0zFTKbzptEjndktXh0BGliifebvalLS4CzjnW5goPj40MSTpSC6ui1egIKl2T2omisHdO+NiQwqdXUV1zSp75FGl1TW96s06rWNa+DIQ/HRhh20iFYe7Ef78OTM088gMY4N2ipdlBVI7RVNTI20FsA6roE1P0QiPGFuMVGh5zE35AGDtI9W8iSJuMFHx22bh9r0chfRvDo92SBcOOV+wMnVCmyrBRkWBuQ79KtwKObcDC6uhkdfgF6Hj+1CKZ1GoSaoYkPN1lvtWBPFkxIn6knTf8X+7DWE8oJGkbpGmi3B7sILaI/7z6ib6wblnoE2eTwzpm9Xn3yirD8ncXvwwpG2yfuH9BYoX2R+iV8zYrbJTPcwrGel8wJ36GuiJQWU3B4wBTGibBbREIZOmBYPPRhvHjYe1gPKKlNiDekbqYt0kW7DQ0FdWi1P3Qc9cfJ7p6r0jA2GE7N8NGN7fkeoXVQCyr8vCpCLnh5iXW4L2cSKhWuPdwMzZJ6JQIc+FZgvLJI490LoW59OHThqu6gXuPYCofNeLJcLncsfejXfFNJWX+25BPuPUNNWPZMuG+rMZxjqa1w2qyaVVPhZtXY+7K9tv4jMki9dI3k/ZhhyrO8RDP3l0UXaBaieI/6fUfk/cNrgl+2gKRNdMDgBA3VHbsxCrJSxLHzKskBJN6P0cPfkoSW2iOSVPoCovXVNh+PLJIKp5Oob0TV3q1vlmdSFKhsG+J68uzsBSw+7R0RplLDcx/gy/6L58cnLy9OSJiYJtkge9g76h352zJt3Zyp1k5b38ltIzH3DZb7//pZXQQp6WOOfimZ8BBxvPAP8O5V1kIPB+0v6m7ybKatI5L7e6o7r4xcr+nxnysPzl3d5NmCGUEFymPAsc3j+++R2+Y+OE/fqMHHfZy3V6EExSrCYf25FpDGW1xtfSW4Jsgu4rEkcaA4DnJ1L4lPw2EH3idAOax44vvOd9K28fSzV5eESMYv/ub+48HMsCWBlWwZhA0F2SPN/tl9JpmaVmxKtIHlOnwUMduEn289/Bx/IaX2mmMTlw5a0P+k094F9/cB2l6va/rw6q0rol0TNfnmZr1e/weMLjG4","sidebar_class_name":"put api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Document","permalink":"/docs/API-docs/v1.2/getdocument"},"next":{"title":"Revoke Document","permalink":"/docs/API-docs/v1.2/revokedocument"}}');var o=n(74848),s=n(28453),a=n(57742),c=n.n(a),r=n(78178),p=n.n(r),d=n(19624),l=n.n(d),m=n(96226),u=n.n(m),h=(n(77675),n(19365),n(51107)),f=n(21312);const g={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:"eJzdWt1uG8cVfpXTDVBLxJKUHSdFmSKNIyuOUdcSJLkGKgnkcOeQnGo4s52ZJUXIBHJR9AGK3vS2L9H7PkqepDjzs7v88V+SpkAvbEm7Z86c/znnm73PHJvabHCVPdVFNUflbHaTZxxtYUTphFbZILucIbwqOXMIiQqenD0HJqVeWqgsGgtOw1xzMVkBUxyqQO5mCBwdE9KCngADW2IhJqIAHhn14KX2hMyBmwnrGWslV4m704kZgwkuoWSGzdGhsTmsdAUFU0o7KGZMTcOGEyERtCoQhAsSJKGFhcIgc8h7WZ7pEg0jFZ/zbJCFTZJ+WZ41G2WDq/tMsTlmgyzxGgqe5Zkg85TMzbJtmz1/Sgpv7O51VIjcKzXGqBfxMfjnShjk2cCZCvPMupWk3ayYlxKzPMO7UmqO2WDCpCWCYoZzlg3uM7cqPaUzQk2zPJtoM2euebJe3wT+aN3Xmq9ozaaoZ0YvBEcYo9Qt+7Ys73BeSubQwgFzIJFZB1phizYpcJjlWaGVIxMO7jNWllIU3sj9P1na7X5XdD3+Exbe4oZc4gRaehsM/n4FyTjMm2mQWf9LbfJsnWdKu49mc0YqIhhcCFz6eLZiqkJ8tnlv2PHjtqijos1jTWskR0MRucuvWU2UqNhY4unlWYt0rLVEpnaikaIKukEB7R/CUkgJgQecXp7BAg0lpvdVD175nPY0BgsUC0q/NgkUmiMsBAOcMyFzWM5EMaOAX8G8sg5QxRiKpsNWyvsghi7sCsSF3StRHsqBUNOm3OwwBi4MFk6uYCncTFcOGOeCljMJ1mFpe20reilqQ17qyvx4SzKYVoIjB6crAxNtvJS+WJU+zUgDoawzVUGLLfCKvOv1IFL6vTS6QGsbOyWrEFGLfw6obFjOYMKsQ5NDpQRZ3lSlQ16zxLsSjUBV4F4TeOMOff2OBrcfboszNHPhbNKUXMM4B5TozxOwVTEDFt4zVxm0OQglnGDS5mAdm5c2B23A4R3VFXC6pOKJd8I6En4p+BSdBfG2ODpHypGiJcPE6Ln3PtlGrdqBUMvl9Ba7S3KqsPHUmrBKOlgwWe23mUXFh0INteFohkGADzDa6xkqsOho+wdkwQc5ICtmUXTafyx1cYs8KlFQLKQQqUO9Uk5ISgooKUG9okn5GVsgFJrEpRhwMxQGWBEy+0RNtCnQQpAYLB0NipyRgqUHp/78pdqNFpYk8APS9rk6JV0fkIxM2iR/D54GY3mTPvD2ebDXZAZDhg4rI/cVuE1LXYReAYNDXp2/IFEM1qmCJqTemCp1YIzUefji5JXfsdp2hu0UVVY5PTQ4F4rjh5SDi+BInwlO11WgcnrOnCggsbI9iKQhZp1uJ/UcDlK8jXHGFkKbw7cYkNgNqbmh0MMFmlVLSlXNx2h2hHzpH1NKcbayMEa3RFRt2VLk69rxhZfN+37DJkRlG6U3pPwsHLdishpqNWzSfa8dN3XbFrnTIe6dDnThsu1A375ps3UyqXAIgd88HVAkOxmIus4QLfTDbub8tbpWnY4X4T2bUZP5E21IHe8AznHKDJdobegUg2EpZnNgdQTrtBUdaU3o80ZKak9a1AV1UF4mBOYcK2bIyWkcS1ScyqvP5aHn+qBp4XrXvv8oUQ0LLbVpe40Zw1bU7jqc293EXbe8eZWNZYW+paXGdixZcZvdrPNsXBQ/lCOd+F/Fv3uFnme5f/Ro49nO1DIuCjgYS0HmYWbsq0K5OhzE3oZxOkZ9QdlqczacGozvp4mdUSJV2B5AMN7PrSJp+N/WjTRb55kTbqNvHbYGoeGY5or1eu0rlC21siHpHx0d7Y4b9QgZxx/qD6gYTyopV7/46eaH8Ph9nTSz/NG39uzxtyV5JIr0xL170aOjR592Hx51j351+fDzweNfDz77vHd0dPTHLM/u5rIZXjLilrWt5/9uPRBKCoXDZLXho6Oj4afRlI/3WS+OJmWc2RZMCg4TgZID7Wl/QgOiMdr8wNHpHfK9S31SOSn/+B2hQ8V4oivF/9fq7pPo3Qo+Hj6uVfxsV8XnKpiMYJBLfYvq59Cw0ae9vQvbk6ibUS0CkX+fbSjbfh6UtFhURriVx1DuuqwU3fB+cHVDyMQc3UwT/lJWAXRxs2yQ9VN16d+36sw6I35mkSAZ30VmM+dKO+j3LVN8rO96ukRFZ6RkY0tls89K0V887D3K1vn2GlaWH0WPVfdjl1jHpkJN37fupjHVBbkzeGzDYM3JUorfIR0t0R9tqohJzZBRA0seoCg5b/Cfk+Tr2p3boEnCTD4MBtk+k/YCG21cI8s2sIvY/rWH8Pho71Ca8K+9w1d8uTlm0H5bbX1Nt6+b/uxtTWxc1e6Q9nc7sdn58FP9Y6jX5OGJ9uEQ8+60RHVBnqGs9eG07ZRPINF8/5d/1mTUi34JnQ41vRSaXasrUwSQ1/Nj0qFRzFHv8P13f4dxJaTzqAbHBUqqLTanOcDSOT5eBdCnNMKi7XU6xL+971Qs0HrQtu5v0eMiPIAhXYOMrwC7tdWBYEeqv+BmRlfTme+t1VRiDucnF5eTSpI2NFyppiW2NfDimeQwZ4pNWzAmycyK23octI65yuMLBpkEJ+aY+3iPgxyS0Ia0E6bVJ0kxwWJVyGAcmsUT7rRAxbUBmuO7Qvmmv9vt0o9PPoFnocuHC8eMQ05PTyj0IKK0AT8rmDGrsG9djBMCMmpl/AhCrvtNRqPRtWq9HMBviEPz4MtIQ1PP93/9G1x9q5c0y01RERiOWxveHKQyxnVhd+sXPe3PUJb9i6CU7T85e+7PrcPg/5fagSVPxtmdgO+pUL+lTtXr0unEwg2oFsJoRabtdOBg9MGFfXRIfEujnaYK2aB/kwkW3tSSIpgzx7ZccawNwjEr2VhIQcckPX8Dx8zhVJsVvIHXBNrHewbgGt5cqzfdbtf/I9JOp7446XTgDRz7+4UcqEDlscXNqYTq2xhTHCnum/DsJrc34Rs5X6Z49Zy/roTkYLCKsEGNyfvJsDTYLSUrkCe47AsvA1mGoHptKAtWNUYUt7hAOelSfvotnqUosPR4a9C0jV1rrEothAuzxITuDiLTs2osRQGb4l/MmKEJpAwvU+pJoW59+iiduEphXX2hkHg+NWzi4LU2t7RT4EgwVyOdBxCTTZgFTiusN/lEKCaFjVgLUZjE91grx4rovN+HOuFzIApThPcw1vqWQmxq2NxDO0zKVWLyjT/cAo9TM2WK9mokE8pSL1yX6aeGwjGciLUnXuN4pvVtYHIeBzYqR10qR4CL2GU2hyGEyDSglwpQ8VIL5RI7PwhGXs4IpOmvKHSVAAM6Ix3QSULNLXnwzWZqUOB//90/LLzEJdWddGB8QmlDGA6a2sNpDyav1ejZySX0kyf6A8FHfsfN5+TjUQAqx4RFWWeQzalX5j4aDPJKcaZc674PKIAMzvUCuWfZ6ZQGJ/7agDlGY6vSSzDoKkN8LNJah3IVkNTo0YZhp0NHwy2FYT22AjIrwsVFoZWt5thLWp8xa5fa8O6Z0S6AjWdPv4GLqiy1cdeK3sPoOqP7x2EZia+zUaraKc9pWg7I2lKb2wBwuxmgKsyqjFwJLwx8kTCbwbUanZ1eXEI/3F8mM47g3/+C0dmrHYv7x60FdT89SHTDTTKfLYlq58XWfv4F1Qgy6SjZ53QyIQfCRUxtSi2j5bUi5HN0Hfs5Hah8Z3WdDQJ0+ibAoiOCp96iqI+hPZoS6npHM5Ggi58IwFKHEuHVuF9dcKg18Hh7YlP79yLEx7mWdA5QUzSK1XIEYaLy8UWAfEmFhXQKBEOjJZKnw6DLCqOt9Q2B14Kyy+jKoUdaDSIQfYhnm7w8CEcP7U7FPsDAldk5cKJMI+gkzPjQly7fM8SmCjZuaZtuKpwMoUSMqKknPnW12UQqvaFi6+9h4Vik02WM92aqzyNW0sQf2B0zFTKbzptEjndktXh0BGliifebvalLS4CzjnW5goPj40MSTpSC6ui1egIKl2T2omisHdO+NiQwqdXUV1zSp75FGl1TW96s06rWNa+DIQ/HRhh20iFYe7Ef78OTM088gMY4N2ipdlBVI7RVNTI20FsA6roE1P0QiPGFuMVGh5zE35AGDtI9W8iSJuMFHx22bh9r0chfRvDo92SBcOOV+wMnVCmyrBRkWBuQ79KtwKObcDC6uhkdfgF6Hj+1CKZ1GoSaoYkPN1lvtWBPFkxIn6knTf8X+7DWE8oJGkbpGmi3B7sILaI/7z6ib6wblnoE2eTwzpm9Xn3yirD8ncXvwwpG2yfuH9BYoX2R+iV8zYrbJTPcwrGel8wJ36GuiJQWU3B4wBTGibBbREIZOmBYPPRhvHjYe1gPKKlNiDekbqYt0kW7DQ0FdWi1P3Qc9cfJ7p6r0jA2GE7N8NGN7fkeoXVQCyr8vCpCLnh5iXW4L2cSKhWuPdwMzZJ6JQIc+FZgvLJI490LoW59OHThqu6gXuPYCofNeLJcLncsfejXfFNJWX+25BPuPUNNWPZMuG+rMZxjqa1w2qyaVVPhZtXY+7K9tv4jMki9dI3k/ZhhyrO8RDP3l0UXaBaieI/6fUfk/cNrgl+2gKRNdMDgBA3VHbsxCrJSxLHzKskBJN6P0cPfkoSW2iOSVPoCovXVNh+PLJIKp5Oob0TV3q1vlmdSFKhsG+J68uzsBSw+7R0RplLDcx/gy/6L58cnLy9OSJiYJtkge9g76h352zJt3Zyp1k5b38ltIzH3DZb7//pZXQQp6WOOfimZ8BBxvPAP8O5V1kIPB+0v6m7ybKatI5L7e6o7r4xcr+nxnysPzl3d5NmCGUEFymPAsc3j+++R2+Y+OE/fqMHHfZy3V6EExSrCYf25FpDGW1xtfSW4Jsgu4rEkcaA4DnJ1L4lPw2EH3idAOax44vvOd9K28fSzV5eESMYv/ub+48HMsCWBlWwZhA0F2SPN/tl9JpmaVmxKtIHlOnwUMduEn289/Bx/IaX2mmMTlw5a0P+k094F9/cB2l6va/rw6q0rol0TNfnmZr1e/weMLjG4",sidebar_class_name:"put api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},P=void 0,b={},I=[];function x(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Update Document"}),"\n",(0,o.jsx)(c(),{method:"put",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,o.jsx)(t.p,{children:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created."}),"\n",(0,o.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,o.jsx)(f.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,o.jsx)(p(),{...n(66370)}),"\n",(0,o.jsx)(l(),{...n(32744)}),"\n",(0,o.jsx)(u(),{...n(46658)})]})}function U(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(x,{...e})}):x(e)}},66370(e){e.exports=JSON.parse('{"parameters":[{"name":"document_id","in":"path","description":"ID of the document that needs to be updated","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string"}}]}')},32744(e){e.exports=JSON.parse('{"title":"Body","body":{"description":"Provide below parameter to update templates (at least one parameter required)","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","format":"string","example":"sample document"},"note":{"type":"string","format":"string","example":"Please review and sign this document"},"description":{"type":"string","format":"string","example":"document description"},"folderId":{"type":"string","example":""},"enableOTP":{"type":"boolean","description":"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.","example":false},"enableTour":{"type":"boolean","description":"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.","example":false},"allow_modifications":{"type":"boolean","description":"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.","example":false},"send_in_order_strict":{"type":"boolean","description":"When set to \'true\', each signer is blocked from accessing the document until all preceding signers have completed their action. Enforces strict sequential signing. Only applies when \'sendInOrder\' is also \'true\'. Defaults to \'false\'.","example":false},"redirect_url":{"type":"string","description":"Specifies the URL where the signer will be redirected upon completing the document signing process.","example":""},"auto_reminder":{"type":"boolean","description":"Set to true to enable automatic reminders. Set to false to disable them (default behavior).","example":false},"remind_once_in_every":{"type":"number","description":"Number of days between reminders. This is only applicable when auto_reminder is set to true.","example":5},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed. \\n"},"cc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"cc (carbon copy): Users added here will receive a notification email once the document is completed.\\n"}},"title":"document_document_id_body"}}}}}')},46658(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Document updated successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","example":"asd2HsP4Hp"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"title":"inline_response_200_3"}}}},"400":{"description":"Please provide valid field names!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","format":"string","example":"Please provide valid field names!"}},"title":"inline_response_400"}}}},"404":{"description":"Document not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","format":"string","example":"Document not found!"}},"title":"inline_response_404_4"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/293ced56.e44def03.js b/assets/js/293ced56.e44def03.js deleted file mode 100644 index 95fb3f0e2..000000000 --- a/assets/js/293ced56.e44def03.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[3588],{97016(e,t,o){o.r(t),o.d(t,{assets:()=>v,contentTitle:()=>y,default:()=>w,frontMatter:()=>g,metadata:()=>n,toc:()=>D});const n=JSON.parse('{"id":"API-docs/v1.2/update-document","title":"Update Document","description":"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.","source":"@site/docs/API-docs/v1.2/update-document.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/update-document","permalink":"/docs/API-docs/v1.2/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":"eJzdWc1uHLkRfpUKD5E9aM3IWnuDzF7WWRteYQ1LsGQYiCwM2M3qaa7YZC/JntFAGGAPeYOccs2j7ZMERfbvzNiWd40EyMXWdJPFqq9++FX1PfN86dj8mr0wWV2i9o7dJEygy6ysvDSazdlVgfCuEtwjtKvg+cUZcKXM2kHt0DrwBkojZL4BrgXUcbkvEAR6LpUDkwMHV2Emc5mBaARN4Y0JC7kHX0gXBButNq10b1phHHJcQ8UtL9GjdQlsTA0Z19p4yAqul/HAXCoEozME6aMGrdLSQWaRexRTljBToeVk4plgcxYPae1jCesPYvPre6Z5iWzOWlkLKVjCJMFTcV+wXczOXpDBo9ODjRpRBKNSbOwiORZ/qaVFwebe1pgw5zeKTnOyrBSyhOFdpYxANs+5crQgK7DkbH7P/KYKK72VeskSlhtbct8/2W5vonx0/m9GbGjPWNULa1ZSIKSozADfAfIey0pxjw4ecQ8KufNgNA7WtgY8ZgnLjPYE4fye8apSMgsgz352dNr9vuom/RmzgLgll3iJjt5GwD9vIIHDA0xz5sIfHeRsmzBt/BeLuSATESyuJK5DPDu51DE+h7JHOH7ZEV1UDGVsaY8SaCki9+X1u2klap4qPL+6GCxNjVHI9V40UlTBcTTAhIewlkpBlAHnVxewQkuJGXw1hXchp8MaixnKFaXfcAlkRiCsJAcsuVQJrAuZFRTwGyhr5wF1E0MNdDhI+RDEcAz7CgnpDmqUxHIg9bIvN3uCQUiLmVcbWEtfmNoDF0LSdq7AeazcdIhi0KID8srU9o8jyWFZS4ECvKkt5MYGLUOxqkKakQVSO2/rjDY7EDV5N9hBS+nvypoMnetxalGhRQP5CaB2cTuHnDuPNoFaS0Le1pVH0YnEuwqtRJ3hQQgCuItQvxvA3cOxuEBbSu9aS8k1XAhAheE+AVdnBfD4nvvaoktAauklVy4B53lZuQSMBY93VFfAm4qKJ95J50n5tRRL9A7kx+LoLVKOZAMdcmvK4H3CRm+GgdDp5c2OuCtyqnTNrZXzWnlYcVUfxsyhFgupF8YKtIuowANAe1+gBoeejj8iBI8SQJ4Vjep0fqpMdouiMSKjWGhDpAv1WnupKCmgogQNhrbGF3yFkBlSl2LAFygt8Cxm9kudG5uhg6gxOLoaNDmjDZYpnIf7l2o3OliTwkdk7Zk+J1uPSEeuXKv/FF5EsAKkRwGfo4OQWYwZuqitOlTgxkhdRq6A0SHv3r4mVSx2qYI2pl5KlToKRmIeoTgF4/dQ282wvaLKa28WFkupBT6kHFxGR4ZM8KarArU3Jfcyg1aUm0KzNMasN8OkLuFRG28pFnwljX38EQBJ3ILIDYUertBuBlrqukzR7in5JjymlBJ84yBFv0bUQ93ayDed47OgW/D9CBNa5XqjR1o+i9etzDcLoxd9uh/EcWzbrsqTCUmfTOAYroYODPTN2J2bScdLCMLh7QVFuhNAxDpjtNB/bpzzH/QHPZkEFT5zGJHMr3QgMd45vMUlt0Khc5EpRmApZhPgXQSb9ii60vrQF72WRE8GqzNiUEEnBO49zwoU5DSBFWpB5TXk8iJIPeop3PRD4B8V6kVmlLFDr3Fr+YborsfS7SfuduDNa5aqGgOlJWKbKp7dspttwtIs+70S6cb/vvk9zUzJkvDodPRsr2tJswwepUoSPNymoSpUm8fzhttwQddoKCg7NGfk1Ah+6Cb2Wom2wk4BCLxtwrz0I3a3GLQLi5TY93a7DXnsKqNdTI3Tk5N9Ut41Wk2TQLcolay8Vmrzp6/HsuPjz/FN7sTpj+7i6Y8VuaZR6bn/9KbTk9Nvjp+cHJ/85erJt/Onf50/+3Z6cnLyd5awu1L1FJ+RNDZEL/wePJBaSY2LFrXF6cnJ4psGyqeH0GsIfNV0NiuupIBcohJAZ7qvCCBaa+zvbDA+od+nzCeTW+OffiJ0qGTlptbif23uIY0+beDTxdPOxGf7Jp7pCBkNC67MLer/hoW9PcPjfTyeVB1HtYyLwns2Mnb4PBrpMKut9Jswabg75pU8ju/n1zfUv5foC0NTiqqOowlfsDmbtdVldj+oM1tG8uyqHVwErsUK7ys3n80c1yI1d1NToaabRPHUUf2c8UrOVk+mp2yb7O7hVfVF67E+/tItzvOl1MvP7bvpobokd0aPjQDrr5hK/oR0xzT+GK5qJjcFcqJ55AGKkrf9lORl6+vOnbujhXay8LBhwe7ldLD9H3b/jI06/IYkDVvV5tHB1q2dEh1sUZqXYzJO5+2Q327dIc757GNUr9k15BGHOUFDCR56vW/JZ7kJDm4y6bxCfUlYUx6GANlrtlBlpsS21ZtM2i2//ePf3a7JpPNTnH4QRzuvLVRmjTavVXBqrvBOEiembViGdy5MIGkUgbwkJqc2QN330hL7EnIpfd9WQcYrnkolqdDQMkO7LQxqlZvC+wJ9gZZeHVliIwJXqKg+dV2FXvY0ZG3sbU5zUuKMae2kJj6JuuA6Cy1hky2hvybaSrOBykqH1P+R1jLqZrS3PPNQcs2XoUFOYAiWQCWppIA1KY13nFF1HGDQdNfYMJKIBoURZwDxJU0tLQI9JbZksaDUXjVTDJfEKVJMLTJBC0jReahIF0ldKg0hNfXDcbRbU8NrfNOwmnykI233lmtHd1HUpfVBB1jT+aFrqP87h+Th11Lfuvlk8kEfw3UXV+8xddLjzaO2TK3X673y9Hi855X0P9YpvMXKOOmN3fS7l9IXdRpK2lBI9yNKeoUaQ/wMClYvQ5jM7VdIejorUFWzy9hCuNnzi7NwMz6G3379J7xGbjUUZh2jNastqg0s26MIuej5CFt3sYURFq99QYhnMfiaYXKL4PuC+99+/ZeDN7imEU1MKTJlMnmFHq6a4TH8GUY/X0vnJ5M5taFmRY271kiu4XYzGPLHgor0gFhwZTEPc0LueZyPNK1Wv2NKR39g9BVgUXHn1saKD2wwq47MX+rmW0A33U52x91Ju6JPt9CEda+F5bkfd2IOVR4vAGtqHwO4pXmtNgHUyhofJxaVyFulYzE3eR74EIl5kOajTy7ts/78ILWfmzZDCmO7EURzYFepSL84Neom/42CEe2FNQoPa9YPZxxEghXmDiOg9nD9LNB7niKDqzpVMts1eArPswzD8DPM7twcJpOo0WTSzVkeJzCZ0IVNT+lvXpGX6NcULhv9wxw7DNNGXz26264ZTH4HUdBwgzbt1PI7aEU7KPmmkac33VSzm1UPBDefU5qJATVMY4ozvuUs5mgJu+DePqkr2STxdVsMgGrEHykmRGTpruBx1hm648i1vt+VEzgv2tKd55doVzLDhu99pI7OwuIZS5iSGWo3JF/PX128htU30xPiBh1xfEBJnb0+++Hlm8uXpAy5IAL2ZHoyPQnTDuN8yfXgpJ3vnLuM4r7vMv5fP4s29JmG8bNKcRmal2ZgGxuPazbgtfPhF9GbhBXGeVpyf59yh++s2m7p8S91oI3XNwlbcSup7ITupClB4vAccAj3o7ftN0b4so+rBw1qmwRNHUIoFJED3+Jm5yvvlqhn0ymQxnHFD1Gv4yuS00vYazyp1Yk7Yln65Nphp3fx7oq4cvPFtgwff5nla6LRfB2VjR+gQg8Unt0zxfWy5ktaG0Vu41C7GDdGt6Exav4gow7CMe6YohX0L9l0cMP9fWy6tttufXz10R0Nru1q8s3Ndrv9D9rWjho=","sidebar_class_name":"put api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Document","permalink":"/docs/API-docs/v1.2/getdocument"},"next":{"title":"Revoke Document","permalink":"/docs/API-docs/v1.2/revokedocument"}}');var a=o(74848),i=o(28453),s=o(57742),r=o.n(s),d=o(78178),p=o.n(d),l=o(19624),c=o.n(l),u=o(96226),m=o.n(u),h=(o(77675),o(19365),o(51107)),f=o(21312);const g={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:"eJzdWc1uHLkRfpUKD5E9aM3IWnuDzF7WWRteYQ1LsGQYiCwM2M3qaa7YZC/JntFAGGAPeYOccs2j7ZMERfbvzNiWd40EyMXWdJPFqq9++FX1PfN86dj8mr0wWV2i9o7dJEygy6ysvDSazdlVgfCuEtwjtKvg+cUZcKXM2kHt0DrwBkojZL4BrgXUcbkvEAR6LpUDkwMHV2Emc5mBaARN4Y0JC7kHX0gXBButNq10b1phHHJcQ8UtL9GjdQlsTA0Z19p4yAqul/HAXCoEozME6aMGrdLSQWaRexRTljBToeVk4plgcxYPae1jCesPYvPre6Z5iWzOWlkLKVjCJMFTcV+wXczOXpDBo9ODjRpRBKNSbOwiORZ/qaVFwebe1pgw5zeKTnOyrBSyhOFdpYxANs+5crQgK7DkbH7P/KYKK72VeskSlhtbct8/2W5vonx0/m9GbGjPWNULa1ZSIKSozADfAfIey0pxjw4ecQ8KufNgNA7WtgY8ZgnLjPYE4fye8apSMgsgz352dNr9vuom/RmzgLgll3iJjt5GwD9vIIHDA0xz5sIfHeRsmzBt/BeLuSATESyuJK5DPDu51DE+h7JHOH7ZEV1UDGVsaY8SaCki9+X1u2klap4qPL+6GCxNjVHI9V40UlTBcTTAhIewlkpBlAHnVxewQkuJGXw1hXchp8MaixnKFaXfcAlkRiCsJAcsuVQJrAuZFRTwGyhr5wF1E0MNdDhI+RDEcAz7CgnpDmqUxHIg9bIvN3uCQUiLmVcbWEtfmNoDF0LSdq7AeazcdIhi0KID8srU9o8jyWFZS4ECvKkt5MYGLUOxqkKakQVSO2/rjDY7EDV5N9hBS+nvypoMnetxalGhRQP5CaB2cTuHnDuPNoFaS0Le1pVH0YnEuwqtRJ3hQQgCuItQvxvA3cOxuEBbSu9aS8k1XAhAheE+AVdnBfD4nvvaoktAauklVy4B53lZuQSMBY93VFfAm4qKJ95J50n5tRRL9A7kx+LoLVKOZAMdcmvK4H3CRm+GgdDp5c2OuCtyqnTNrZXzWnlYcVUfxsyhFgupF8YKtIuowANAe1+gBoeejj8iBI8SQJ4Vjep0fqpMdouiMSKjWGhDpAv1WnupKCmgogQNhrbGF3yFkBlSl2LAFygt8Cxm9kudG5uhg6gxOLoaNDmjDZYpnIf7l2o3OliTwkdk7Zk+J1uPSEeuXKv/FF5EsAKkRwGfo4OQWYwZuqitOlTgxkhdRq6A0SHv3r4mVSx2qYI2pl5KlToKRmIeoTgF4/dQ282wvaLKa28WFkupBT6kHFxGR4ZM8KarArU3Jfcyg1aUm0KzNMasN8OkLuFRG28pFnwljX38EQBJ3ILIDYUertBuBlrqukzR7in5JjymlBJ84yBFv0bUQ93ayDed47OgW/D9CBNa5XqjR1o+i9etzDcLoxd9uh/EcWzbrsqTCUmfTOAYroYODPTN2J2bScdLCMLh7QVFuhNAxDpjtNB/bpzzH/QHPZkEFT5zGJHMr3QgMd45vMUlt0Khc5EpRmApZhPgXQSb9ii60vrQF72WRE8GqzNiUEEnBO49zwoU5DSBFWpB5TXk8iJIPeop3PRD4B8V6kVmlLFDr3Fr+YborsfS7SfuduDNa5aqGgOlJWKbKp7dspttwtIs+70S6cb/vvk9zUzJkvDodPRsr2tJswwepUoSPNymoSpUm8fzhttwQddoKCg7NGfk1Ah+6Cb2Wom2wk4BCLxtwrz0I3a3GLQLi5TY93a7DXnsKqNdTI3Tk5N9Ut41Wk2TQLcolay8Vmrzp6/HsuPjz/FN7sTpj+7i6Y8VuaZR6bn/9KbTk9Nvjp+cHJ/85erJt/Onf50/+3Z6cnLyd5awu1L1FJ+RNDZEL/wePJBaSY2LFrXF6cnJ4psGyqeH0GsIfNV0NiuupIBcohJAZ7qvCCBaa+zvbDA+od+nzCeTW+OffiJ0qGTlptbif23uIY0+beDTxdPOxGf7Jp7pCBkNC67MLer/hoW9PcPjfTyeVB1HtYyLwns2Mnb4PBrpMKut9Jswabg75pU8ju/n1zfUv5foC0NTiqqOowlfsDmbtdVldj+oM1tG8uyqHVwErsUK7ys3n80c1yI1d1NToaabRPHUUf2c8UrOVk+mp2yb7O7hVfVF67E+/tItzvOl1MvP7bvpobokd0aPjQDrr5hK/oR0xzT+GK5qJjcFcqJ55AGKkrf9lORl6+vOnbujhXay8LBhwe7ldLD9H3b/jI06/IYkDVvV5tHB1q2dEh1sUZqXYzJO5+2Q327dIc757GNUr9k15BGHOUFDCR56vW/JZ7kJDm4y6bxCfUlYUx6GANlrtlBlpsS21ZtM2i2//ePf3a7JpPNTnH4QRzuvLVRmjTavVXBqrvBOEiembViGdy5MIGkUgbwkJqc2QN330hL7EnIpfd9WQcYrnkolqdDQMkO7LQxqlZvC+wJ9gZZeHVliIwJXqKg+dV2FXvY0ZG3sbU5zUuKMae2kJj6JuuA6Cy1hky2hvybaSrOBykqH1P+R1jLqZrS3PPNQcs2XoUFOYAiWQCWppIA1KY13nFF1HGDQdNfYMJKIBoURZwDxJU0tLQI9JbZksaDUXjVTDJfEKVJMLTJBC0jReahIF0ldKg0hNfXDcbRbU8NrfNOwmnykI233lmtHd1HUpfVBB1jT+aFrqP87h+Th11Lfuvlk8kEfw3UXV+8xddLjzaO2TK3X673y9Hi855X0P9YpvMXKOOmN3fS7l9IXdRpK2lBI9yNKeoUaQ/wMClYvQ5jM7VdIejorUFWzy9hCuNnzi7NwMz6G3379J7xGbjUUZh2jNastqg0s26MIuej5CFt3sYURFq99QYhnMfiaYXKL4PuC+99+/ZeDN7imEU1MKTJlMnmFHq6a4TH8GUY/X0vnJ5M5taFmRY271kiu4XYzGPLHgor0gFhwZTEPc0LueZyPNK1Wv2NKR39g9BVgUXHn1saKD2wwq47MX+rmW0A33U52x91Ju6JPt9CEda+F5bkfd2IOVR4vAGtqHwO4pXmtNgHUyhofJxaVyFulYzE3eR74EIl5kOajTy7ts/78ILWfmzZDCmO7EURzYFepSL84Neom/42CEe2FNQoPa9YPZxxEghXmDiOg9nD9LNB7niKDqzpVMts1eArPswzD8DPM7twcJpOo0WTSzVkeJzCZ0IVNT+lvXpGX6NcULhv9wxw7DNNGXz26264ZTH4HUdBwgzbt1PI7aEU7KPmmkac33VSzm1UPBDefU5qJATVMY4ozvuUs5mgJu+DePqkr2STxdVsMgGrEHykmRGTpruBx1hm648i1vt+VEzgv2tKd55doVzLDhu99pI7OwuIZS5iSGWo3JF/PX128htU30xPiBh1xfEBJnb0+++Hlm8uXpAy5IAL2ZHoyPQnTDuN8yfXgpJ3vnLuM4r7vMv5fP4s29JmG8bNKcRmal2ZgGxuPazbgtfPhF9GbhBXGeVpyf59yh++s2m7p8S91oI3XNwlbcSup7ITupClB4vAccAj3o7ftN0b4so+rBw1qmwRNHUIoFJED3+Jm5yvvlqhn0ymQxnHFD1Gv4yuS00vYazyp1Yk7Yln65Nphp3fx7oq4cvPFtgwff5nla6LRfB2VjR+gQg8Unt0zxfWy5ktaG0Vu41C7GDdGt6Exav4gow7CMe6YohX0L9l0cMP9fWy6tttufXz10R0Nru1q8s3Ndrv9D9rWjho=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},y=void 0,v={},D=[];function N(e){const t={p:"p",...(0,i.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Update Document"}),"\n",(0,a.jsx)(r(),{method:"put",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,a.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,a.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,a.jsx)(f.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,a.jsx)(p(),{...o(66370)}),"\n",(0,a.jsx)(c(),{...o(32744)}),"\n",(0,a.jsx)(m(),{...o(46658)})]})}function w(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(N,{...e})}):N(e)}},66370(e){e.exports=JSON.parse('{"parameters":[{"name":"document_id","in":"path","description":"ID of the document that needs to be updated","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string"}}]}')},32744(e){e.exports=JSON.parse('{"title":"Body","body":{"description":"Provide below parameter to update templates (at least one parameter required)","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","format":"string","example":"sample document"},"note":{"type":"string","format":"string","example":"Please review and sign this document"},"description":{"type":"string","format":"string","example":"document description"},"folderId":{"type":"string","example":""},"enableOTP":{"type":"boolean","description":"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.","example":false},"enableTour":{"type":"boolean","description":"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.","example":false},"allow_modifications":{"type":"boolean","description":"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.","example":false},"send_in_order_strict":{"type":"boolean","description":"When set to \'true\', each signer is blocked from accessing the document until all preceding signers have completed their action. Enforces strict sequential signing. Only applies when \'sendInOrder\' is also \'true\'. Defaults to \'false\'.","example":false},"redirect_url":{"type":"string","description":"Specifies the URL where the signer will be redirected upon completing the document signing process.","example":""},"auto_reminder":{"type":"boolean","description":"Set to true to enable automatic reminders. Set to false to disable them (default behavior).","example":false},"remind_once_in_every":{"type":"number","description":"Number of days between reminders. This is only applicable when auto_reminder is set to true.","example":5},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed. \\n"}},"title":"document_document_id_body"}}}}}')},46658(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Document updated successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","example":"asd2HsP4Hp"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"title":"inline_response_200_3"}}}},"400":{"description":"Please provide valid field names!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","format":"string","example":"Please provide valid field names!"}},"title":"inline_response_400"}}}},"404":{"description":"Document not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","format":"string","example":"Document not found!"}},"title":"inline_response_404_4"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/2ea02f7b.8c763f74.js b/assets/js/2ea02f7b.8c763f74.js deleted file mode 100644 index c5d09c34a..000000000 --- a/assets/js/2ea02f7b.8c763f74.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[9316],{12704(e,t,n){n.r(t),n.d(t,{assets:()=>g,contentTitle:()=>x,default:()=>Q,frontMatter:()=>h,metadata:()=>o,toc:()=>I});const o=JSON.parse('{"id":"API-docs/v1.2/deletefolder","title":"Delete Folder","description":"The delete Folder API allows you to delete folder.","source":"@site/docs/API-docs/v1.2/deletefolder.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/deletefolder","permalink":"/docs/API-docs/v1.2/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":"eJy9WN1uI7cVfpUTXrS7wliSvU7aTm5qNO7GiZFdxA4WqC0I1PCMhjGHZMgzkgVBQC76Br3qbR9tn6Q4nBn9+GcTJ0VvbImH5/A7v/yotSA5jyK/EX93RmEQk0wojEXQnrSzIhfXFYJCg4TQboGz9xcgjXHLCCvXALleXib5UGTCeQySDVwokYtW3EpFJrwMskbCwOeuhZU1ily04qlWIhOaD/aSKvEQjZv9iAVdKHAlbA0G/KnRAZXIKTSYiUgrwyajrr1BkQm898YpFHkpTeQNRYW1FPla0MqnnRS0nYtMlC7UkvZX8F4mK7mYfXtclOqk8jOx2Uz42OidjRjZ0Ml4zP8O0camKDDGsjGwjYjIROEsoSXeL703ukiC0Y+RldaP0bVOc+QCmyHdHtnH4qV+fH0XT77xuLzwYpN1yVFn9JSZndLJ+OTN0fH4aPyn6+Mv8tO/5J9/MRyPx/8QmbivDet2eVSSkO2SJrP7vregrdEWp330pifj8fT4RGw2vOn0qTAedakGHcE6Aqw9rTLgMEptIyhXNDVaAhf6Gry1R3DlaqRK2zksWbgMzs4z8AZlRKCwAjmX2oKRhOGz29+VGGfxXZmq+TBFGIILnw7si13jSGW/4aAXhYMPmTyfs9PxePpmm7LTxynrvGKXStdYNfzflf2zrn6q5h/j+VRJno5Pp3/euvf5Y/cu7EIardIoJHeH9rP/g387b544nqEeNqJuNyW5OHB2f711MmLRBE2rVML3R9Lro1ae30y4Drhy3G6UpyFOlcjFqA3saL0d3xvB5sKiH+9NMCIXFZGP+WgUpVUzdz90Hm3Uc2vkLA4LV4+k16PF8fBEcG0f6kjvX7Qfm6OXqkSSc23nv6Q32UXqirPZJuwgXtu0Sa+/xZXI+nTs7+puuAolX2CcAG1Ll5S7JL3zaK/03KYUp8Mf3oQf0BSuRr5+qUIYDHqVj//8z1ZrMNhOkFSMw1t7a981AbxbYuB7SVoFpcF7PTOY1LBOsu3dHlHWBmM0K9CWcB4kISg91yQNcJx4ohTSy5k2mmuYtznWDrDXBnEIHyqkCgOL/hgQJChcoOHSB9mQqyWxqe3EW7pwVzLLyEDCrInaYoyAtpK24I19JjKejdICWsLgg44IkQKj1i02ZynIgqCWVs6RbWewHyyFRnO5QnCzJhJEZ5oEGUhq4wIq6B2yiCqmIJ4zpQgIvFq42gesuGwWCPNGK4w8wxVCTC3LLlgFM4wEnrHoAiMbbaxxxV1KYNkYA97xBNHSML/Zx8jqFKSNPORaLH0OtgHzwTHbwBbgYPBDRM7wpbZ3MR8M+Eq82dbVB5xFTTh51bfAcrl8VPqvD3Xeavq6mcH36F3U5MJqpz3XVDWz1C77RrZfWktv0WKqn71m2NlQroiPu49XRxUaP7pC4gqJo7P3F9es+ho+/vwvuEQZLFRu2VZr0QQ0K5j3R3Hk2sy3YdvOTChdKryKI160xcdMEiP1EfxQSfr4878jfIdL0LZrKXZlMHiLBNdYe74v4Q9w8PVSRxoMcghYuwUqaKxFTo0MK9ix3wQtIi8QKvABS20MKEkSyuDq1F0Y9jQSrbkVpTY49TLGpQvqVuw2gFQKFSMtAjIQ6hBl0Hh1uNDt2LWbpmpPrIIsaSdtoZoyYYLgGmoL2Ae30AqhR5OC6oMjLJJPquxBpxfD1JVlumrZzK9Cnk5+AH7v/GQVmsjhJAdoJc8xx90R24/tgdtJxfioQh221nqAbbSnwRl8Ghl3abspQnt3c5ceBupRXH8x0I8yxQ77ZmZ08dDhIZwVBXoO7EKaBmMOg0GLaDCAVwpL2Rh6ncFgsNC45FX+LD1nib8N4arDX/Ogq+QCQRIwBSRwXZQkNQFhqdUc6UtoDe0rWNcJ45fQm45Qy1Vnz656eXLVNQRyz3D3WONQDBPpfnB9Ht5yAUsMHLuU3l1Te9018U0/DIBnxO8ZJsyREu8uEoXDWmrT3uN/fWgn0SkMdXxXXmFY6AI7LvHMHB2lzSORCaMLtBH3aNrZ2/eXsHgzHItsj5T8ipE6urz42/l3V+cMhlPQBux4OB6Oecm7SLW0eyd9tf+Kf8gn1jv6+tue/B3tIbynkTdSJ86ZHFp3ZPFGbF/s+e61P8lE5SKxeL2eyYg/BLPZ8PJPDQZmpJNMLGTQ3M6JUXatrbbP+WcdefV998vAa3jyh4MnMff8zTJ5S30mciEycYerg58pNpNN1lM4htXK2w7d03z0FDjg01+dX55fn4tM8EV0yB7vEnvsPvABTwI7pJUtBv7LHPdJhfW6ZaabzXZ/K3pWo/Ox381Rmmw2m/8CLC9rfA==","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Update Folder","permalink":"/docs/API-docs/v1.2/updatefolder"},"next":{"title":"Get folder list","permalink":"/docs/API-docs/v1.2/folderlist"}}');var r=n(74848),l=n(28453),d=n(57742),s=n.n(d),i=n(78178),a=n.n(i),p=n(19624),c=n.n(p),m=n(96226),f=n.n(m),u=(n(77675),n(19365),n(51107)),y=n(21312);const h={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:"eJy9WN1uI7cVfpUTXrS7wliSvU7aTm5qNO7GiZFdxA4WqC0I1PCMhjGHZMgzkgVBQC76Br3qbR9tn6Q4nBn9+GcTJ0VvbImH5/A7v/yotSA5jyK/EX93RmEQk0wojEXQnrSzIhfXFYJCg4TQboGz9xcgjXHLCCvXALleXib5UGTCeQySDVwokYtW3EpFJrwMskbCwOeuhZU1ily04qlWIhOaD/aSKvEQjZv9iAVdKHAlbA0G/KnRAZXIKTSYiUgrwyajrr1BkQm898YpFHkpTeQNRYW1FPla0MqnnRS0nYtMlC7UkvZX8F4mK7mYfXtclOqk8jOx2Uz42OidjRjZ0Ml4zP8O0camKDDGsjGwjYjIROEsoSXeL703ukiC0Y+RldaP0bVOc+QCmyHdHtnH4qV+fH0XT77xuLzwYpN1yVFn9JSZndLJ+OTN0fH4aPyn6+Mv8tO/5J9/MRyPx/8QmbivDet2eVSSkO2SJrP7vregrdEWp330pifj8fT4RGw2vOn0qTAedakGHcE6Aqw9rTLgMEptIyhXNDVaAhf6Gry1R3DlaqRK2zksWbgMzs4z8AZlRKCwAjmX2oKRhOGz29+VGGfxXZmq+TBFGIILnw7si13jSGW/4aAXhYMPmTyfs9PxePpmm7LTxynrvGKXStdYNfzflf2zrn6q5h/j+VRJno5Pp3/euvf5Y/cu7EIardIoJHeH9rP/g387b544nqEeNqJuNyW5OHB2f711MmLRBE2rVML3R9Lro1ae30y4Drhy3G6UpyFOlcjFqA3saL0d3xvB5sKiH+9NMCIXFZGP+WgUpVUzdz90Hm3Uc2vkLA4LV4+k16PF8fBEcG0f6kjvX7Qfm6OXqkSSc23nv6Q32UXqirPZJuwgXtu0Sa+/xZXI+nTs7+puuAolX2CcAG1Ll5S7JL3zaK/03KYUp8Mf3oQf0BSuRr5+qUIYDHqVj//8z1ZrMNhOkFSMw1t7a981AbxbYuB7SVoFpcF7PTOY1LBOsu3dHlHWBmM0K9CWcB4kISg91yQNcJx4ohTSy5k2mmuYtznWDrDXBnEIHyqkCgOL/hgQJChcoOHSB9mQqyWxqe3EW7pwVzLLyEDCrInaYoyAtpK24I19JjKejdICWsLgg44IkQKj1i02ZynIgqCWVs6RbWewHyyFRnO5QnCzJhJEZ5oEGUhq4wIq6B2yiCqmIJ4zpQgIvFq42gesuGwWCPNGK4w8wxVCTC3LLlgFM4wEnrHoAiMbbaxxxV1KYNkYA97xBNHSML/Zx8jqFKSNPORaLH0OtgHzwTHbwBbgYPBDRM7wpbZ3MR8M+Eq82dbVB5xFTTh51bfAcrl8VPqvD3Xeavq6mcH36F3U5MJqpz3XVDWz1C77RrZfWktv0WKqn71m2NlQroiPu49XRxUaP7pC4gqJo7P3F9es+ho+/vwvuEQZLFRu2VZr0QQ0K5j3R3Hk2sy3YdvOTChdKryKI160xcdMEiP1EfxQSfr4878jfIdL0LZrKXZlMHiLBNdYe74v4Q9w8PVSRxoMcghYuwUqaKxFTo0MK9ix3wQtIi8QKvABS20MKEkSyuDq1F0Y9jQSrbkVpTY49TLGpQvqVuw2gFQKFSMtAjIQ6hBl0Hh1uNDt2LWbpmpPrIIsaSdtoZoyYYLgGmoL2Ae30AqhR5OC6oMjLJJPquxBpxfD1JVlumrZzK9Cnk5+AH7v/GQVmsjhJAdoJc8xx90R24/tgdtJxfioQh221nqAbbSnwRl8Ghl3abspQnt3c5ceBupRXH8x0I8yxQ77ZmZ08dDhIZwVBXoO7EKaBmMOg0GLaDCAVwpL2Rh6ncFgsNC45FX+LD1nib8N4arDX/Ogq+QCQRIwBSRwXZQkNQFhqdUc6UtoDe0rWNcJ45fQm45Qy1Vnz656eXLVNQRyz3D3WONQDBPpfnB9Ht5yAUsMHLuU3l1Te9018U0/DIBnxO8ZJsyREu8uEoXDWmrT3uN/fWgn0SkMdXxXXmFY6AI7LvHMHB2lzSORCaMLtBH3aNrZ2/eXsHgzHItsj5T8ipE6urz42/l3V+cMhlPQBux4OB6Oecm7SLW0eyd9tf+Kf8gn1jv6+tue/B3tIbynkTdSJ86ZHFp3ZPFGbF/s+e61P8lE5SKxeL2eyYg/BLPZ8PJPDQZmpJNMLGTQ3M6JUXatrbbP+WcdefV998vAa3jyh4MnMff8zTJ5S30mciEycYerg58pNpNN1lM4htXK2w7d03z0FDjg01+dX55fn4tM8EV0yB7vEnvsPvABTwI7pJUtBv7LHPdJhfW6ZaabzXZ/K3pWo/Ox381Rmmw2m/8CLC9rfA==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},x=void 0,g={},I=[];function L(e){const t={p:"p",...(0,l.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Delete Folder"}),"\n",(0,r.jsx)(s(),{method:"delete",path:"/folder/{folder_id}",context:"endpoint"}),"\n",(0,r.jsx)(t.p,{children:"The delete Folder API allows you to delete folder."}),"\n",(0,r.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,r.jsx)(y.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,r.jsx)(a(),{...n(80554)}),"\n",(0,r.jsx)(c(),{...n(90272)}),"\n",(0,r.jsx)(f(),{...n(72266)})]})}function Q(e={}){const{wrapper:t}={...(0,l.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(L,{...e})}):L(e)}},80554(e){e.exports=JSON.parse('{"parameters":[{"name":"folder_id","in":"path","description":"objectId of folder","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"bK1cfd2hpb"}}]}')},90272(e){e.exports={title:"Body"}},72266(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"Hks2JpewIp"},"deletedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"title":"inline_response_200_12"}}}},"400":{"description":"- folder is not empty, contains document or folder.\\n- Something went wrong, please try again later!\\n","content":{"application/json":{"schema":{"type":"object","oneOf":[{"properties":{"error":{"type":"string","example":"folder is not empty, contains document or folder."}}},{"properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}}}],"title":"inline_response_400_3"}}}},"404":{"description":"folder not found.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","format":"string","example":"folder not found."}},"title":"inline_response_404_8"}}}},"405":{"description":"Invalid API token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/2ea02f7b.a7dc9de2.js b/assets/js/2ea02f7b.a7dc9de2.js new file mode 100644 index 000000000..052c4e80d --- /dev/null +++ b/assets/js/2ea02f7b.a7dc9de2.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[9316],{12704(e,t,n){n.r(t),n.d(t,{assets:()=>S,contentTitle:()=>W,default:()=>X,frontMatter:()=>O,metadata:()=>o,toc:()=>g});const o=JSON.parse('{"id":"API-docs/v1.2/deletefolder","title":"Delete Folder","description":"The delete Folder API allows you to delete folder.","source":"@site/docs/API-docs/v1.2/deletefolder.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/deletefolder","permalink":"/docs/API-docs/v1.2/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":"eJy9GdtuI7f1V064QLEWRhc7m7RVirSO7WzcbLOGZXeBWoaHGh5pGHHICcmRLNgC8lD0A4q+9LU/0fd+yn5JcciZkWR7d7NJ0Ydd2+S533nmjnk+c2x4xb42SqBl1wkT6DIrSy+NZkN2kSMIVOgRIggcnp0CV8osHaxMBd4099Nw32MJMyVaTgROBRuyeB1vWcJKbnmBHi3xvWOaF8iGLF7fSMESJolxyX3OHkpjJt9j5k8FmCm0BC3+UEmLgg29rTBhzq8UkXSyKBWyhOFtqYxANpxy5Qggy7HgbHjH/KoMkN5KPWMJmxpbcL99grc8UBmyybf72VQc5OWErdfXxNaVRjt0ROhgMKAfu9K6KsvQuWmloLUIS1hmtEftCZ6XpZJZuOh/7wjp7rF0UWmynCUyXkaWjS0+Vo9v5u7gjyUuT0u2TmrniEP/FJkN0sHg4NPu/qA7+PXF/ufDF78dfvZ5bzAY/IUl7LZQhFv7UXCPRNdLrzZ/bx1IraTGm8Z6NweDwc3+AVuvCejFU2bs1q4G6UAbD1iUfpUAmZFL7UCYrCpQezC2icGx7sLIFOhzqWewpMulNXqWQKmQOwRvV8BnXGpQ3KP9ZPyLHGM0vp6GaN51EVpr7PsN+9GqkaWSn8Hoo8xBTK7f7bMXg8HNp63LXjx2Wa0VqTQ1lRa9/13Yv1PV98X8Y3neF5IvBi9uftOq99lj9U71gispQin0Zo76k/+DfhttnmBPou4mooxA4Z7tKLt9HpV0mFVW+lUI4dsuL2U33g+vrikOKHLMppSHIu5zNmT9aNj+XVu+14zI2UVT3iur2JDl3pdu2O87rsXE3PZMidrJmVZ84nqZKfq8lP3Ffu+AUWzv4vCy/Ch4rLofi+I8n0k9+xDe9cZSI/JmdNiOvVq38VJ+iyuWNO7Yhqo7XI6cGhg5QOqpCci1k16XqEdypoOLA/OHnfAZNDBv//qvFmysx/pL6HSoa5MiXWcqmyEcm6wK9LjyaDX3coHw9sd/wKSSinLCgsAFKgpEl4C3lfMoYLIC1B5taaVD1+t0iP4235lcYBwDOGSGwtNjAqU1ospI0K5FLlaAXbIo95VFKBX3lKrgc2uqWQ4cnNQzhQmcn4wuqFkenp32YIRatPXPBRFbIgkUXPMZgseC6GGQmWfzAEI1znnuKwdSg0WuwMsCE+BaAK+8KbhHEtqSdtLipswqOcVslaloHK4ULKXPTeVhgVoYC8pk867UPTJEt9ulH8+ewUv0nriOPLceBZ2eLNCugEYTdB6KynnIuLWryLfNXJLQ5wjpVnykECMjMEnTdKy3LofwO6KwOfiyhhnrTuft3/4OV9+YJQ1lM9Q0cuADhtfPm6AXJnOPo51O+zmqsj+KSrn+4dnpBaHuRf9/Zzw48uQyR4vEaoIzqX8Pl9RIcoROp05zQL2Q1mgybacDz9OfXAbSPaJbWuMN5VPrBT6dYhZMrSiCBff8gSuOjEU44iWfSCWpptL5PRxxjzNjV3APb3LuQ8hmXIMwcD/W991uN/wj0E7nuIm6Tgfu4cgip6h2qEUCVSnCXxYXZl7HVD3/tuHZbdy+Cd+a8kUTr4HyV5VUAixWjk/UVjAHdaG02C0Vz1DAUooZevdFkIEsYzTSSFBwvQps0bYsRqimXcrPwOJlEwWOjgPodla1dq2pgNQL6UPjgqkyy4boWTVRMoNd8Uc5twgcynjZpJ6Seh7SR5uGqpLOQzOmNzSPLZ96eGPsnDhFinyBW9IZu2UT7kAQhgsmn0rNlYwBV8ShpaF7RMNTVjvvT7FOhByohcniPUyMmVOIzSwvCu5lxpVaNUTiWyfSeG1nXBOvjWRSOymwLcFwbCkcYxNsPfEGJ7kx80jkHDMkGCpHXSpHgAuqONp4Oa1nBQcxMi2YpQbUojRS+4bcpWsEOkdvJS4QeJaZSvtgkcyikB6ok9AcRB68300NCvy3P/7TwXe4pLrTNIxnlDYKORmn8XDDg6uxTl+eXEC/8UR/KEUaOO6ek49TyMmDE0QNzlvkBQ1WIkSDRVFpwbWHzQMQKIAsFmaBIpDsdEqLU6lUSO04FS/Boq8s0XFIuB7VCqbWFI1HNwQ7HWoNcwrD9nkGyJ1ES2mTGe2qAnuN1mfcuaWxontmjceMWt7Z8dcwqsrSWD/WdA/pmE2lwpuyBh6ztKnaTZ5PjFhROdSwNDZwDxmMOrOrsqbqeg1dFGD0cKzTs9ejC+hnob40ZkzhP/+G9OzykcXD8RZCE4z9YQN3swsWsqWBenTxgF+4oBpBJk0b+7yeTsmBMKpTm1LLGjXWI/Rkl7AGuDER6oZQx2xI0wPCPYTHdgpGwzsUDTH0hKbeAL3YZSa9ogEkFEeaUGSskzW/tuDQaIA8y9ti0fp3FOPj3CjqAzQUpXW1TCGO3yG+eJZhSYWFdIoAN9YoJE9PJSoBPLPGuTAQBC0ou6ypPLoeXOQWEQg+xrNrvDyMrYe4U7HHnC8kJffDhlPLlELnucApr5TfC6UrzAz1UEWVgZ5qPpT+zTQVO0MsEelC4pLotNXGhShtpxsylEWCAqPVqinSdXeJS52mPqe8LK1ZRHJHXMfMpn7TgOMtWa1uHVGausQHZvdtaeF2YjQcmXIFz4+O9kg4WUqqo2N9CBqXZPYs21i7TvvWkMCV0bNQcUkfvJUuzADpmE228YxudU3aYEhi2wjR1jbB1ov92M9bZ54UXCrgQlh0VDuoqqGgfG9ltHUl5zTQTYzuZqTZdh0HDFSMznDXAdK1DhU9eCXnuNEhIfF3pIHnrspyanwxSzYZL0W6R61rIUVthyga+ctKUfu9sQAsuKowCQ0nVimyrJJkWOqmcesA3Fq+gufp1XW69wWYQvpAJZrWG5A6R1sf7pJ+MIIdLrhUIVNPNvNfPYdtnVBO0O7h8vzVEzPYKI6Iod99xNzYDiztE2SXwntfeC32ySWc4+wR8odelunDjvtntE6aUKR+BV/xbL7kVjg4MkXJvQwT6opACZmCY1rRCDJpALtZDajiBAyL/RDGi/3efvtAacYEF1uiz41DWETGsSDx1h+G2pZ0MGnsHqhqAxOLsWtmOdczSgSaEbYataTCL6os5kKQl0ib8BzlCiqt0DkwPke7pFlJG4rxXXNcOqTn3Sup5yEcunDVTlBvcOKkx83zZLlcPrL0XsD5ulIKmhk9JNwHHjUR7aX031QTOMfSOOmNXW2wZtLn1ST4chu3/aMm0MzS9Ji6+KWPqUDyAm3haJk9QruQ2QfU73sC7++FZeWDtcPudsDiFC3VHbfzFOSlrJ+dV40cQOL9Ej1ot1SP1GF9RaUv7j/+8JBOWEORCq+ntb71Dub9+rKEKZmhdri13jp8efYKFp/2BizZWub8BF/2X50enXw3OiFh6jRhQ7bfG/QGdFQa5wuutzgdb3/9eLiHudus/X7ep5J6XeTx1vdLxWXY1QWF7uol2xVrv3QMN19JrhOWG+fp+u6O8vnSqvWajn+o0NIm7zphC24lJX7YxNXjk2g/g7xTkefn9VNtD5784PKkzM3eS9PSK7QFNmQsYXNc7XzeWV+vk2b1RWLF+8Mwgm1hPlqh7uwhj09enVycsITxiky0vXWbh61b/QsxeFKw3XVclIH+p93gkwh3d3Gjt1638PHqnRi1jg00Wel6vV7/F9ZSswM=","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Update Folder","permalink":"/docs/API-docs/v1.2/updatefolder"},"next":{"title":"Get folder list","permalink":"/docs/API-docs/v1.2/folderlist"}}');var s=n(74848),p=n(28453),l=n(57742),r=n.n(l),d=n(78178),i=n.n(d),a=n(19624),c=n.n(a),u=n(96226),m=n.n(u),h=(n(77675),n(19365),n(51107)),f=n(21312);const O={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:"eJy9GdtuI7f1V064QLEWRhc7m7RVirSO7WzcbLOGZXeBWoaHGh5pGHHICcmRLNgC8lD0A4q+9LU/0fd+yn5JcciZkWR7d7NJ0Ydd2+S533nmjnk+c2x4xb42SqBl1wkT6DIrSy+NZkN2kSMIVOgRIggcnp0CV8osHaxMBd4099Nw32MJMyVaTgROBRuyeB1vWcJKbnmBHi3xvWOaF8iGLF7fSMESJolxyX3OHkpjJt9j5k8FmCm0BC3+UEmLgg29rTBhzq8UkXSyKBWyhOFtqYxANpxy5Qggy7HgbHjH/KoMkN5KPWMJmxpbcL99grc8UBmyybf72VQc5OWErdfXxNaVRjt0ROhgMKAfu9K6KsvQuWmloLUIS1hmtEftCZ6XpZJZuOh/7wjp7rF0UWmynCUyXkaWjS0+Vo9v5u7gjyUuT0u2TmrniEP/FJkN0sHg4NPu/qA7+PXF/ufDF78dfvZ5bzAY/IUl7LZQhFv7UXCPRNdLrzZ/bx1IraTGm8Z6NweDwc3+AVuvCejFU2bs1q4G6UAbD1iUfpUAmZFL7UCYrCpQezC2icGx7sLIFOhzqWewpMulNXqWQKmQOwRvV8BnXGpQ3KP9ZPyLHGM0vp6GaN51EVpr7PsN+9GqkaWSn8Hoo8xBTK7f7bMXg8HNp63LXjx2Wa0VqTQ1lRa9/13Yv1PV98X8Y3neF5IvBi9uftOq99lj9U71gispQin0Zo76k/+DfhttnmBPou4mooxA4Z7tKLt9HpV0mFVW+lUI4dsuL2U33g+vrikOKHLMppSHIu5zNmT9aNj+XVu+14zI2UVT3iur2JDl3pdu2O87rsXE3PZMidrJmVZ84nqZKfq8lP3Ffu+AUWzv4vCy/Ch4rLofi+I8n0k9+xDe9cZSI/JmdNiOvVq38VJ+iyuWNO7Yhqo7XI6cGhg5QOqpCci1k16XqEdypoOLA/OHnfAZNDBv//qvFmysx/pL6HSoa5MiXWcqmyEcm6wK9LjyaDX3coHw9sd/wKSSinLCgsAFKgpEl4C3lfMoYLIC1B5taaVD1+t0iP4235lcYBwDOGSGwtNjAqU1ospI0K5FLlaAXbIo95VFKBX3lKrgc2uqWQ4cnNQzhQmcn4wuqFkenp32YIRatPXPBRFbIgkUXPMZgseC6GGQmWfzAEI1znnuKwdSg0WuwMsCE+BaAK+8KbhHEtqSdtLipswqOcVslaloHK4ULKXPTeVhgVoYC8pk867UPTJEt9ulH8+ewUv0nriOPLceBZ2eLNCugEYTdB6KynnIuLWryLfNXJLQ5wjpVnykECMjMEnTdKy3LofwO6KwOfiyhhnrTuft3/4OV9+YJQ1lM9Q0cuADhtfPm6AXJnOPo51O+zmqsj+KSrn+4dnpBaHuRf9/Zzw48uQyR4vEaoIzqX8Pl9RIcoROp05zQL2Q1mgybacDz9OfXAbSPaJbWuMN5VPrBT6dYhZMrSiCBff8gSuOjEU44iWfSCWpptL5PRxxjzNjV3APb3LuQ8hmXIMwcD/W991uN/wj0E7nuIm6Tgfu4cgip6h2qEUCVSnCXxYXZl7HVD3/tuHZbdy+Cd+a8kUTr4HyV5VUAixWjk/UVjAHdaG02C0Vz1DAUooZevdFkIEsYzTSSFBwvQps0bYsRqimXcrPwOJlEwWOjgPodla1dq2pgNQL6UPjgqkyy4boWTVRMoNd8Uc5twgcynjZpJ6Seh7SR5uGqpLOQzOmNzSPLZ96eGPsnDhFinyBW9IZu2UT7kAQhgsmn0rNlYwBV8ShpaF7RMNTVjvvT7FOhByohcniPUyMmVOIzSwvCu5lxpVaNUTiWyfSeG1nXBOvjWRSOymwLcFwbCkcYxNsPfEGJ7kx80jkHDMkGCpHXSpHgAuqONp4Oa1nBQcxMi2YpQbUojRS+4bcpWsEOkdvJS4QeJaZSvtgkcyikB6ok9AcRB68300NCvy3P/7TwXe4pLrTNIxnlDYKORmn8XDDg6uxTl+eXEC/8UR/KEUaOO6ek49TyMmDE0QNzlvkBQ1WIkSDRVFpwbWHzQMQKIAsFmaBIpDsdEqLU6lUSO04FS/Boq8s0XFIuB7VCqbWFI1HNwQ7HWoNcwrD9nkGyJ1ES2mTGe2qAnuN1mfcuaWxontmjceMWt7Z8dcwqsrSWD/WdA/pmE2lwpuyBh6ztKnaTZ5PjFhROdSwNDZwDxmMOrOrsqbqeg1dFGD0cKzTs9ejC+hnob40ZkzhP/+G9OzykcXD8RZCE4z9YQN3swsWsqWBenTxgF+4oBpBJk0b+7yeTsmBMKpTm1LLGjXWI/Rkl7AGuDER6oZQx2xI0wPCPYTHdgpGwzsUDTH0hKbeAL3YZSa9ogEkFEeaUGSskzW/tuDQaIA8y9ti0fp3FOPj3CjqAzQUpXW1TCGO3yG+eJZhSYWFdIoAN9YoJE9PJSoBPLPGuTAQBC0ou6ypPLoeXOQWEQg+xrNrvDyMrYe4U7HHnC8kJffDhlPLlELnucApr5TfC6UrzAz1UEWVgZ5qPpT+zTQVO0MsEelC4pLotNXGhShtpxsylEWCAqPVqinSdXeJS52mPqe8LK1ZRHJHXMfMpn7TgOMtWa1uHVGausQHZvdtaeF2YjQcmXIFz4+O9kg4WUqqo2N9CBqXZPYs21i7TvvWkMCV0bNQcUkfvJUuzADpmE228YxudU3aYEhi2wjR1jbB1ov92M9bZ54UXCrgQlh0VDuoqqGgfG9ltHUl5zTQTYzuZqTZdh0HDFSMznDXAdK1DhU9eCXnuNEhIfF3pIHnrspyanwxSzYZL0W6R61rIUVthyga+ctKUfu9sQAsuKowCQ0nVimyrJJkWOqmcesA3Fq+gufp1XW69wWYQvpAJZrWG5A6R1sf7pJ+MIIdLrhUIVNPNvNfPYdtnVBO0O7h8vzVEzPYKI6Iod99xNzYDiztE2SXwntfeC32ySWc4+wR8odelunDjvtntE6aUKR+BV/xbL7kVjg4MkXJvQwT6opACZmCY1rRCDJpALtZDajiBAyL/RDGi/3efvtAacYEF1uiz41DWETGsSDx1h+G2pZ0MGnsHqhqAxOLsWtmOdczSgSaEbYataTCL6os5kKQl0ib8BzlCiqt0DkwPke7pFlJG4rxXXNcOqTn3Sup5yEcunDVTlBvcOKkx83zZLlcPrL0XsD5ulIKmhk9JNwHHjUR7aX031QTOMfSOOmNXW2wZtLn1ST4chu3/aMm0MzS9Ji6+KWPqUDyAm3haJk9QruQ2QfU73sC7++FZeWDtcPudsDiFC3VHbfzFOSlrJ+dV40cQOL9Ej1ot1SP1GF9RaUv7j/+8JBOWEORCq+ntb71Dub9+rKEKZmhdri13jp8efYKFp/2BizZWub8BF/2X50enXw3OiFh6jRhQ7bfG/QGdFQa5wuutzgdb3/9eLiHudus/X7ep5J6XeTx1vdLxWXY1QWF7uol2xVrv3QMN19JrhOWG+fp+u6O8vnSqvWajn+o0NIm7zphC24lJX7YxNXjk2g/g7xTkefn9VNtD5784PKkzM3eS9PSK7QFNmQsYXNc7XzeWV+vk2b1RWLF+8Mwgm1hPlqh7uwhj09enVycsITxiky0vXWbh61b/QsxeFKw3XVclIH+p93gkwh3d3Gjt1638PHqnRi1jg00Wel6vV7/F9ZSswM=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},W=void 0,S={},g=[];function y(e){const t={p:"p",...(0,p.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Delete Folder"}),"\n",(0,s.jsx)(r(),{method:"delete",path:"/folder/{folder_id}",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The delete Folder API allows you to delete folder."}),"\n",(0,s.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(f.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(i(),{...n(80554)}),"\n",(0,s.jsx)(c(),{...n(90272)}),"\n",(0,s.jsx)(m(),{...n(72266)})]})}function X(e={}){const{wrapper:t}={...(0,p.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(y,{...e})}):y(e)}},80554(e){e.exports=JSON.parse('{"parameters":[{"name":"folder_id","in":"path","description":"objectId of folder","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"bK1cfd2hpb"}}]}')},90272(e){e.exports={title:"Body"}},72266(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"Hks2JpewIp"},"deletedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"title":"inline_response_200_12"}}}},"400":{"description":"- folder is not empty, contains document or folder.\\n- Something went wrong, please try again later!\\n","content":{"application/json":{"schema":{"type":"object","oneOf":[{"properties":{"error":{"type":"string","example":"folder is not empty, contains document or folder."}}},{"properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}}}],"title":"inline_response_400_3"}}}},"404":{"description":"folder not found.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","format":"string","example":"folder not found."}},"title":"inline_response_404_8"}}}},"405":{"description":"Invalid API token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/3a2a59a1.145a6958.js b/assets/js/3a2a59a1.145a6958.js new file mode 100644 index 000000000..46e72130e --- /dev/null +++ b/assets/js/3a2a59a1.145a6958.js @@ -0,0 +1 @@ +(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[5864],{40830(e,n,t){"use strict";t.r(n),t.d(n,{assets:()=>p,contentTitle:()=>h,default:()=>j,frontMatter:()=>c,metadata:()=>i,toc:()=>u});const i=JSON.parse('{"id":"API-docs/v1.2/opensign-api-v-1-2","title":"OpenSign API v1.2","description":"# OpenSign\u2122 API v1.2","source":"@site/docs/API-docs/v1.2/opensign-api-v-1-2.info.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/opensign-api-v-1-2","permalink":"/docs/API-docs/v1.2/opensign-api-v-1-2","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","sidebarPosition":0,"frontMatter":{"id":"opensign-api-v-1-2","title":"OpenSign API v1.2","description":"# OpenSign\u2122 API v1.2","sidebar_label":"Introduction","sidebar_position":0,"hide_title":true,"custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"v1.2","permalink":"/docs/API-docs/v1.2"},"next":{"title":"Get your account details","permalink":"/docs/API-docs/v1.2/get-user"}}');var s=t(74848),r=t(28453),o=(t(43905),t(51107)),l=t(23397),d=t.n(l),a=t(19365);t(69016);const c={id:"opensign-api-v-1-2",title:"OpenSign API v1.2",description:"# OpenSign\u2122 API v1.2",sidebar_label:"Introduction",sidebar_position:0,hide_title:!0,custom_edit_url:null},h="OpenSign\u2122 API v1.2",p={},u=[{value:"Getting Started",id:"getting-started",level:2},{value:"Core Capabilities",id:"core-capabilities",level:2},{value:"What\u2019s New in v1.2",id:"whats-new-in-v12",level:2},{value:"Cleaner Template Retrieval",id:"cleaner-template-retrieval",level:3},{value:"Password-Protected PDF Support",id:"password-protected-pdf-support",level:3},{value:"Offline Signing Control",id:"offline-signing-control",level:3},{value:"Signer Roles",id:"signer-roles",level:3},{value:"Carbon Copy (CC) Recipients",id:"carbon-copy-cc-recipients",level:3},{value:"Available Environments",id:"available-environments",level:2},{value:"Versioning & Backwards Compatibility",id:"versioning--backwards-compatibility",level:2},{value:"Useful Links",id:"useful-links",level:2}];function x(e){const n={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",li:"li",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)("span",{className:"theme-doc-version-badge badge badge--secondary",children:"Version: 1.0.0"}),"\n",(0,s.jsx)(o.default,{as:"h1",className:"openapi__heading",children:"OpenSign API v1.2"}),"\n",(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"opensign-api-v12",children:"OpenSign\u2122 API v1.2"})}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"The open-source DocuSign alternative \u2014 built for developers, trusted by enterprises."})}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"OpenSign\u2122 gives you a complete, production-ready e-signature platform through a single, RESTful API. Send documents for signature, manage templates, track signing status in real time, and automate your entire document lifecycle \u2014 all without vendor lock-in."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h2,{id:"getting-started",children:"Getting Started"}),"\n",(0,s.jsxs)(n.p,{children:["Every request must carry your API token in the ",(0,s.jsx)(n.code,{children:"x-api-token"})," header."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:"x-api-token: \n"})}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsxs)(n.strong,{children:["\u2192 ",(0,s.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/Settings/APIToken",children:"How to generate your API token"})]})}),"\n",(0,s.jsxs)(n.p,{children:["Not sure where to begin? Use the ",(0,s.jsx)(n.strong,{children:"sandbox environment"})," (",(0,s.jsx)(n.code,{children:"https://sandbox.opensignlabs.com/api/v1.2"}),") to prototype without affecting live data."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h2,{id:"core-capabilities",children:"Core Capabilities"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Category"}),(0,s.jsx)(n.th,{children:"What you can do"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.strong,{children:"Documents"})}),(0,s.jsx)(n.td,{children:"Create, send, update, revoke, and delete signature-request documents"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.strong,{children:"Templates"})}),(0,s.jsx)(n.td,{children:"Build reusable templates with pre-placed widgets; send to one or many signers"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.strong,{children:"Self-Sign"})}),(0,s.jsx)(n.td,{children:"Generate self-signed documents without a signer invitation flow"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.strong,{children:"Public Templates"})}),(0,s.jsx)(n.td,{children:"Share a public signing link \u2014 no signer list required"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.strong,{children:"Draft Workflow"})}),(0,s.jsx)(n.td,{children:"Save documents or templates as drafts and finalise them later"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.strong,{children:"Contacts"})}),(0,s.jsx)(n.td,{children:"Manage your signer contact book programmatically"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.strong,{children:"Folders"})}),(0,s.jsx)(n.td,{children:"Organise documents inside OpenSign Drive folders"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.strong,{children:"Webhooks"})}),(0,s.jsx)(n.td,{children:"Receive real-time event notifications at your own endpoint"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.strong,{children:"Users"})}),(0,s.jsx)(n.td,{children:"Retrieve account and credit information"})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h2,{id:"whats-new-in-v12",children:"What\u2019s New in v1.2"}),"\n",(0,s.jsx)(n.h3,{id:"cleaner-template-retrieval",children:"Cleaner Template Retrieval"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"GET /template/:id"})," and ",(0,s.jsx)(n.code,{children:"GET /templatelist"})," have been streamlined \u2014 redundant parameters are removed and ",(0,s.jsx)(n.strong,{children:"prefill data is now returned separately from signer parameters"}),", making responses easier to consume."]}),"\n",(0,s.jsx)(n.h3,{id:"password-protected-pdf-support",children:"Password-Protected PDF Support"}),"\n",(0,s.jsxs)(n.p,{children:["Pass ",(0,s.jsx)(n.code,{children:'"file_password"'})," in the request body when working with encrypted PDFs. Supported on:\n",(0,s.jsx)(n.code,{children:"POST /createtemplate"})," \xb7 ",(0,s.jsx)(n.code,{children:"PUT /template/:id"})," \xb7 ",(0,s.jsx)(n.code,{children:"POST /createdocument/:template_id"})," \xb7 ",(0,s.jsx)(n.code,{children:"POST /draftdocument"})," \xb7 ",(0,s.jsx)(n.code,{children:"POST /drafttemplate"})," \xb7 ",(0,s.jsx)(n.code,{children:"POST /selfsign"})]}),"\n",(0,s.jsx)(n.h3,{id:"offline-signing-control",children:"Offline Signing Control"}),"\n",(0,s.jsxs)(n.p,{children:["Set ",(0,s.jsx)(n.code,{children:'"allow_offline_sign": true | false'})," on ",(0,s.jsx)(n.code,{children:"POST /createtemplate"})," and ",(0,s.jsx)(n.code,{children:"PUT /template/:id"})," to explicitly enable or disable offline signing for each template."]}),"\n",(0,s.jsx)(n.h3,{id:"signer-roles",children:"Signer Roles"}),"\n",(0,s.jsxs)(n.p,{children:["The ",(0,s.jsx)(n.code,{children:"signers"})," object now accepts a ",(0,s.jsx)(n.code,{children:'"signer_role"'})," field across all creation routes. Three roles are supported:"]}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Role"}),(0,s.jsx)(n.th,{children:"Behaviour"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.code,{children:"signer"})," ",(0,s.jsx)(n.em,{children:"(default)"})]}),(0,s.jsx)(n.td,{children:"Must complete at least one signature widget"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"viewer"})}),(0,s.jsx)(n.td,{children:"Receives the document for review only \u2014 no widgets allowed"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"approver"})}),(0,s.jsx)(n.td,{children:"Can have any widgets except a signature requirement"})]})]})]}),"\n",(0,s.jsx)(n.h3,{id:"carbon-copy-cc-recipients",children:"Carbon Copy (CC) Recipients"}),"\n",(0,s.jsxs)(n.p,{children:["A new ",(0,s.jsx)(n.code,{children:'"cc"'})," field is now supported alongside the existing ",(0,s.jsx)(n.code,{children:'"bcc"'})," field on document, template, draft and self-sign creation/update routes. Email addresses listed in ",(0,s.jsx)(n.code,{children:'"cc"'})," receive a carbon-copy notification email once the document is completed. Like ",(0,s.jsx)(n.code,{children:'"bcc"'}),", on update routes (such as ",(0,s.jsx)(n.code,{children:"PUT /document/:id"}),") providing ",(0,s.jsx)(n.code,{children:'"cc"'})," overrides the template value, even when supplied as an empty array (",(0,s.jsx)(n.code,{children:"[]"}),"); omit the field to inherit the template value."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h2,{id:"available-environments",children:"Available Environments"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Environment"}),(0,s.jsx)(n.th,{children:"Base URL"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.strong,{children:"Sandbox"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"https://sandbox.opensignlabs.com/api/v1.2"})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.strong,{children:"Production"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"https://app.opensignlabs.com/api/v1.2"})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.strong,{children:"EU Region"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"https://eu-app.opensignlabs.com/api/v1.2"})})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h2,{id:"versioning--backwards-compatibility",children:"Versioning & Backwards Compatibility"}),"\n",(0,s.jsx)(n.p,{children:"v1.2 is fully backwards-compatible with v1 and v1.1 \u2014 all endpoints from those versions are available on this base URL with no breaking changes. New parameters introduced in v1.2 are optional unless otherwise noted."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h2,{id:"useful-links",children:"Useful Links"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"https://www.opensignlabs.com",children:"OpenSign Website"})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"https://docs.opensignlabs.com",children:"Full Documentation"})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"https://github.com/opensignlabs/opensign",children:"GitHub Repository"})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/Settings/APIToken",children:"Generate API Token"})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"https://www.opensignlabs.com/terms/",children:"Terms of Service"})}),"\n"]}),"\n",(0,s.jsxs)("div",{style:{marginBottom:"2rem"},children:[(0,s.jsx)(o.default,{id:"authentication",as:"h2",className:"openapi-tabs__heading",children:"Authentication"}),(0,s.jsx)(d(),{className:"openapi-tabs__security-schemes",children:(0,s.jsx)(a.default,{label:"API Key: x-api-token",value:"x-api-token",children:(0,s.jsx)("div",{children:(0,s.jsx)("table",{children:(0,s.jsxs)("tbody",{children:[(0,s.jsxs)("tr",{children:[(0,s.jsx)("th",{children:(0,s.jsx)(n.p,{children:"Security Scheme Type:"})}),(0,s.jsx)("td",{children:(0,s.jsx)(n.p,{children:"apiKey"})})]}),(0,s.jsxs)("tr",{children:[(0,s.jsx)("th",{children:(0,s.jsx)(n.p,{children:"Header parameter name:"})}),(0,s.jsx)("td",{children:(0,s.jsx)(n.p,{children:"x-api-token"})})]})]})})})})})]}),"\n",(0,s.jsxs)("div",{style:{display:"flex",flexDirection:"column",marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,s.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,s.jsx)(n.p,{children:"Contact"})}),(0,s.jsx)("span",{children:(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"mailto:api@opensignlabs.com",children:"api@opensignlabs.com"})})})]}),"\n",(0,s.jsxs)("div",{style:{marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,s.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,s.jsx)(n.p,{children:"Terms of Service"})}),(0,s.jsx)("a",{href:"http://www.opensignlabs.com/terms/",children:"http://www.opensignlabs.com/terms/"})]}),"\n",(0,s.jsxs)("div",{style:{marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,s.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,s.jsx)(n.p,{children:"License"})}),(0,s.jsx)("a",{href:"http://github.com/opensignlabs/opensign/LICENSE",children:(0,s.jsx)(n.p,{children:"AGPL v3.0"})})]})]})}function j(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(x,{...e})}):x(e)}},69016(e,n,t){"use strict";var i=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(n,"__esModule",{value:!0});const s=i(t(96540)),r=i(t(4213));n.default=function({url:e,proxy:n}){return s.default.createElement("div",{style:{float:"right"},className:"dropdown dropdown--hoverable dropdown--right"},s.default.createElement("button",{className:"export-button button button--sm button--secondary"},"Export"),s.default.createElement("ul",{className:"export-dropdown dropdown__menu"},s.default.createElement("li",null,s.default.createElement("a",{onClick:n=>{n.preventDefault(),(e=>{let n;(e.endsWith("json")||e.endsWith("yaml")||e.endsWith("yml"))&&(n=e.substring(e.lastIndexOf("/")+1)),r.default.saveAs(e,n||"openapi.txt")})(`${e}`)},className:"dropdown__link",href:`${e}`},"OpenAPI Spec"))))}},43905(e,n,t){"use strict";var i=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(n,"__esModule",{value:!0}),n.default=function(e){const{colorMode:n}=(0,r.useColorMode)(),{logo:t,darkLogo:i}=e,d=()=>"dark"===n?i?.altText??t?.altText:t?.altText,a=(0,o.default)(t?.url),c=(0,o.default)(i?.url);if(t&&i)return s.default.createElement(l.default,{alt:d(),sources:{light:a,dark:c},className:"openapi__logo"});if(t||i)return s.default.createElement(l.default,{alt:d(),sources:{light:a??c,dark:a??c},className:"openapi__logo"});return};const s=i(t(96540)),r=t(83262),o=i(t(86025)),l=i(t(15626))},4213(e,n){var t,i,s;i=[],void 0===(s="function"==typeof(t=function(){"use strict";function n(e,n){return void 0===n?n={autoBom:!1}:"object"!=typeof n&&(console.warn("Deprecated: Expected third argument to be a object"),n={autoBom:!n}),n.autoBom&&/^\s*(?:text\/\S*|application\/xml|\S*\/\S*\+xml)\s*;.*charset\s*=\s*utf-8/i.test(e.type)?new Blob(["\ufeff",e],{type:e.type}):e}function t(e,n,t){var i=new XMLHttpRequest;i.open("GET",e),i.responseType="blob",i.onload=function(){l(i.response,n,t)},i.onerror=function(){console.error("could not download file")},i.send()}function i(e){var n=new XMLHttpRequest;n.open("HEAD",e,!1);try{n.send()}catch(e){}return 200<=n.status&&299>=n.status}function s(e){try{e.dispatchEvent(new MouseEvent("click"))}catch(t){var n=document.createEvent("MouseEvents");n.initMouseEvent("click",!0,!0,window,0,0,0,80,20,!1,!1,!1,!1,0,null),e.dispatchEvent(n)}}var r="object"==typeof window&&window.window===window?window:"object"==typeof self&&self.self===self?self:"object"==typeof globalThis&&globalThis.global===globalThis?globalThis:void 0,o=r.navigator&&/Macintosh/.test(navigator.userAgent)&&/AppleWebKit/.test(navigator.userAgent)&&!/Safari/.test(navigator.userAgent),l=r.saveAs||("object"!=typeof window||window!==r?function(){}:"download"in HTMLAnchorElement.prototype&&!o?function(e,n,o){var l=r.URL||r.webkitURL,d=document.createElement("a");n=n||e.name||"download",d.download=n,d.rel="noopener","string"==typeof e?(d.href=e,d.origin===location.origin?s(d):i(d.href)?t(e,n,o):s(d,d.target="_blank")):(d.href=l.createObjectURL(e),setTimeout(function(){l.revokeObjectURL(d.href)},4e4),setTimeout(function(){s(d)},0))}:"msSaveOrOpenBlob"in navigator?function(e,r,o){if(r=r||e.name||"download","string"!=typeof e)navigator.msSaveOrOpenBlob(n(e,o),r);else if(i(e))t(e,r,o);else{var l=document.createElement("a");l.href=e,l.target="_blank",setTimeout(function(){s(l)})}}:function(e,n,i,s){if((s=s||open("","_blank"))&&(s.document.title=s.document.body.innerText="downloading..."),"string"==typeof e)return t(e,n,i);var l="application/octet-stream"===e.type,d=/constructor/i.test(r.HTMLElement)||r.safari,a=/CriOS\/[\d]+/.test(navigator.userAgent);if((a||l&&d||o)&&"undefined"!=typeof FileReader){var c=new FileReader;c.onloadend=function(){var e=c.result;e=a?e:e.replace(/^data:[^;]*;/,"data:attachment/file;"),s?s.location.href=e:location=e,s=null},c.readAsDataURL(e)}else{var h=r.URL||r.webkitURL,p=h.createObjectURL(e);s?s.location=p:location.href=p,s=null,setTimeout(function(){h.revokeObjectURL(p)},4e4)}});r.saveAs=l.saveAs=l,e.exports=l})?t.apply(n,i):t)||(e.exports=s)}}]); \ No newline at end of file diff --git a/assets/js/3a2a59a1.5624a408.js b/assets/js/3a2a59a1.5624a408.js deleted file mode 100644 index 41358ab0b..000000000 --- a/assets/js/3a2a59a1.5624a408.js +++ /dev/null @@ -1 +0,0 @@ -(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[5864],{40830(e,t,n){"use strict";n.r(t),n.d(t,{assets:()=>u,contentTitle:()=>p,default:()=>f,frontMatter:()=>c,metadata:()=>o,toc:()=>h});const o=JSON.parse('{"id":"API-docs/v1.2/opensign-api-v-1-2","title":"OpenSign API v1.2","description":"Welcome to the **OpenSign\u2122 API v1.2** documentation.","source":"@site/docs/API-docs/v1.2/opensign-api-v-1-2.info.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/opensign-api-v-1-2","permalink":"/docs/API-docs/v1.2/opensign-api-v-1-2","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","sidebarPosition":0,"frontMatter":{"id":"opensign-api-v-1-2","title":"OpenSign API v1.2","description":"Welcome to the **OpenSign\u2122 API v1.2** documentation.","sidebar_label":"Introduction","sidebar_position":0,"hide_title":true,"custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"v1.2","permalink":"/docs/API-docs/v1.2"},"next":{"title":"Get your account details","permalink":"/docs/API-docs/v1.2/get-user"}}');var i=n(74848),s=n(28453),a=(n(43905),n(51107)),r=n(23397),l=n.n(r),d=n(19365);n(69016);const c={id:"opensign-api-v-1-2",title:"OpenSign API v1.2",description:"Welcome to the **OpenSign\u2122 API v1.2** documentation.",sidebar_label:"Introduction",sidebar_position:0,hide_title:!0,custom_edit_url:null},p=void 0,u={},h=[];function m(e){const t={a:"a",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("span",{className:"theme-doc-version-badge badge badge--secondary",children:"Version: 1.0.0"}),"\n",(0,i.jsx)(a.default,{as:"h1",className:"openapi__heading",children:"OpenSign API v1.2"}),"\n",(0,i.jsxs)(t.p,{children:["Welcome to the ",(0,i.jsx)(t.strong,{children:"OpenSign\u2122 API v1.2"})," documentation."]}),"\n",(0,i.jsx)(t.p,{children:"Our powerful and flexible API empowers you to seamlessly integrate digital signing capabilities into your applications. Whether you're a developer automating document workflows, a business enhancing security, or an enterprise streamlining contract management, OpenSign\u2122 delivers robust solutions tailored to your needs."}),"\n",(0,i.jsx)(t.p,{children:"Explore our comprehensive guides, code samples, and best practices to unlock the full potential of OpenSign\u2122 and transform your digital document processes."}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"Useful Links:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.a,{href:"https://www.opensignlabs.com",children:"OpenSign Website"})}),"\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.a,{href:"https://github.com/opensignlabs/opensign",children:"OpenSign GitHub Repository"})}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.a,{href:"https://docs.opensignlabs.com/docs/help/Settings/APIToken",children:"Generate x-api-token"})," \u2013 Learn how to securely generate and manage your API token for authenticating requests."]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"What\u2019s New in v1.2"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Get Template & Get Template List"}),": removed unnecessary parameters and separated prefill data from signer parameters."]}),"\n",(0,i.jsx)(t.li,{children:'"file_password" parameter added in create template, update template, create document with template, draft document and self sign routes to provide password for protected pdfs.'}),"\n",(0,i.jsx)(t.li,{children:'"allow_offline_sign" parameter added in create template and update template routes to allow users to enable or disable offline signing for their templates.'}),"\n",(0,i.jsxs)(t.li,{children:['"signer_role" parameter added in the signers object of draft document, create document, create document with template, create template, and public template routes. Accepted values: ',(0,i.jsx)(t.strong,{children:"signer"})," (default), ",(0,i.jsx)(t.strong,{children:"viewer"}),", ",(0,i.jsx)(t.strong,{children:"approver"}),". Signers must have at least one signature widget; viewers must have no widgets; approvers may have any widgets without a signature requirement."]}),"\n"]}),"\n",(0,i.jsxs)("div",{style:{marginBottom:"2rem"},children:[(0,i.jsx)(a.default,{id:"authentication",as:"h2",className:"openapi-tabs__heading",children:"Authentication"}),(0,i.jsx)(l(),{className:"openapi-tabs__security-schemes",children:(0,i.jsx)(d.default,{label:"API Key: x-api-token",value:"x-api-token",children:(0,i.jsx)("div",{children:(0,i.jsx)("table",{children:(0,i.jsxs)("tbody",{children:[(0,i.jsxs)("tr",{children:[(0,i.jsx)("th",{children:(0,i.jsx)(t.p,{children:"Security Scheme Type:"})}),(0,i.jsx)("td",{children:(0,i.jsx)(t.p,{children:"apiKey"})})]}),(0,i.jsxs)("tr",{children:[(0,i.jsx)("th",{children:(0,i.jsx)(t.p,{children:"Header parameter name:"})}),(0,i.jsx)("td",{children:(0,i.jsx)(t.p,{children:"x-api-token"})})]})]})})})})})]}),"\n",(0,i.jsxs)("div",{style:{display:"flex",flexDirection:"column",marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,i.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,i.jsx)(t.p,{children:"Contact"})}),(0,i.jsx)("span",{children:(0,i.jsx)(t.p,{children:(0,i.jsx)(t.a,{href:"mailto:api@opensignlabs.com",children:"api@opensignlabs.com"})})})]}),"\n",(0,i.jsxs)("div",{style:{marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,i.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,i.jsx)(t.p,{children:"Terms of Service"})}),(0,i.jsx)("a",{href:"http://www.opensignlabs.com/terms/",children:"http://www.opensignlabs.com/terms/"})]}),"\n",(0,i.jsxs)("div",{style:{marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,i.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,i.jsx)(t.p,{children:"License"})}),(0,i.jsx)("a",{href:"http://github.com/opensignlabs/opensign/LICENSE",children:(0,i.jsx)(t.p,{children:"AGPL v3.0"})})]})]})}function f(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(m,{...e})}):m(e)}},69016(e,t,n){"use strict";var o=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});const i=o(n(96540)),s=o(n(4213));t.default=function({url:e,proxy:t}){return i.default.createElement("div",{style:{float:"right"},className:"dropdown dropdown--hoverable dropdown--right"},i.default.createElement("button",{className:"export-button button button--sm button--secondary"},"Export"),i.default.createElement("ul",{className:"export-dropdown dropdown__menu"},i.default.createElement("li",null,i.default.createElement("a",{onClick:t=>{t.preventDefault(),(e=>{let t;(e.endsWith("json")||e.endsWith("yaml")||e.endsWith("yml"))&&(t=e.substring(e.lastIndexOf("/")+1)),s.default.saveAs(e,t||"openapi.txt")})(`${e}`)},className:"dropdown__link",href:`${e}`},"OpenAPI Spec"))))}},43905(e,t,n){"use strict";var o=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0}),t.default=function(e){const{colorMode:t}=(0,s.useColorMode)(),{logo:n,darkLogo:o}=e,l=()=>"dark"===t?o?.altText??n?.altText:n?.altText,d=(0,a.default)(n?.url),c=(0,a.default)(o?.url);if(n&&o)return i.default.createElement(r.default,{alt:l(),sources:{light:d,dark:c},className:"openapi__logo"});if(n||o)return i.default.createElement(r.default,{alt:l(),sources:{light:d??c,dark:d??c},className:"openapi__logo"});return};const i=o(n(96540)),s=n(83262),a=o(n(86025)),r=o(n(15626))},4213(e,t){var n,o,i;o=[],void 0===(i="function"==typeof(n=function(){"use strict";function t(e,t){return void 0===t?t={autoBom:!1}:"object"!=typeof t&&(console.warn("Deprecated: Expected third argument to be a object"),t={autoBom:!t}),t.autoBom&&/^\s*(?:text\/\S*|application\/xml|\S*\/\S*\+xml)\s*;.*charset\s*=\s*utf-8/i.test(e.type)?new Blob(["\ufeff",e],{type:e.type}):e}function n(e,t,n){var o=new XMLHttpRequest;o.open("GET",e),o.responseType="blob",o.onload=function(){r(o.response,t,n)},o.onerror=function(){console.error("could not download file")},o.send()}function o(e){var t=new XMLHttpRequest;t.open("HEAD",e,!1);try{t.send()}catch(e){}return 200<=t.status&&299>=t.status}function i(e){try{e.dispatchEvent(new MouseEvent("click"))}catch(n){var t=document.createEvent("MouseEvents");t.initMouseEvent("click",!0,!0,window,0,0,0,80,20,!1,!1,!1,!1,0,null),e.dispatchEvent(t)}}var s="object"==typeof window&&window.window===window?window:"object"==typeof self&&self.self===self?self:"object"==typeof globalThis&&globalThis.global===globalThis?globalThis:void 0,a=s.navigator&&/Macintosh/.test(navigator.userAgent)&&/AppleWebKit/.test(navigator.userAgent)&&!/Safari/.test(navigator.userAgent),r=s.saveAs||("object"!=typeof window||window!==s?function(){}:"download"in HTMLAnchorElement.prototype&&!a?function(e,t,a){var r=s.URL||s.webkitURL,l=document.createElement("a");t=t||e.name||"download",l.download=t,l.rel="noopener","string"==typeof e?(l.href=e,l.origin===location.origin?i(l):o(l.href)?n(e,t,a):i(l,l.target="_blank")):(l.href=r.createObjectURL(e),setTimeout(function(){r.revokeObjectURL(l.href)},4e4),setTimeout(function(){i(l)},0))}:"msSaveOrOpenBlob"in navigator?function(e,s,a){if(s=s||e.name||"download","string"!=typeof e)navigator.msSaveOrOpenBlob(t(e,a),s);else if(o(e))n(e,s,a);else{var r=document.createElement("a");r.href=e,r.target="_blank",setTimeout(function(){i(r)})}}:function(e,t,o,i){if((i=i||open("","_blank"))&&(i.document.title=i.document.body.innerText="downloading..."),"string"==typeof e)return n(e,t,o);var r="application/octet-stream"===e.type,l=/constructor/i.test(s.HTMLElement)||s.safari,d=/CriOS\/[\d]+/.test(navigator.userAgent);if((d||r&&l||a)&&"undefined"!=typeof FileReader){var c=new FileReader;c.onloadend=function(){var e=c.result;e=d?e:e.replace(/^data:[^;]*;/,"data:attachment/file;"),i?i.location.href=e:location=e,i=null},c.readAsDataURL(e)}else{var p=s.URL||s.webkitURL,u=p.createObjectURL(e);i?i.location=u:location.href=u,i=null,setTimeout(function(){p.revokeObjectURL(u)},4e4)}});s.saveAs=r.saveAs=r,e.exports=r})?n.apply(t,o):n)||(e.exports=i)}}]); \ No newline at end of file diff --git a/assets/js/3b95ab04.a5996e14.js b/assets/js/3b95ab04.a5996e14.js new file mode 100644 index 000000000..c49f6a2c3 --- /dev/null +++ b/assets/js/3b95ab04.a5996e14.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[1543],{83669(e,n,t){t.r(n),t.d(n,{assets:()=>j,contentTitle:()=>g,default:()=>w,frontMatter:()=>b,metadata:()=>r,toc:()=>y});const r=JSON.parse('{"id":"API-docs/v1.2/get-template","title":"Get Template","description":"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.","source":"@site/docs/API-docs/v1.2/get-template.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/get-template","permalink":"/docs/API-docs/v1.2/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":"eJztPNtuGzuSv1LbB1gkgiRLjp2LZzE7Po5PTjCZEyN2Jti1DInqLqkZd5M9JFuyxhEwD4v9gMW+7Ov+xL7vp5wvWRTJbnVLsnxJJscLKIBjN1lF1o3FYvFyHRg21sHBeXCGaZYwgzq4aAYR6lDxzHApgoPgLEZ4gwYKEDg8eQssSeRUw0zmYCQoNIrjBCFCw3iigQ1lboCBzjDkIx6C8cjtshkNGtUEgWkYJjlmigujYSQVhAqZ4WIMkQzzFKl4yk0MmcIIR1xgBNqoPDS5Qt3uiZ5oND6gzqTQqEGO4JSPBSr4xKMxGn3QaBBMtw2NhuZjwQiPygaDQU9c9wRALzCzDHvBAfSCEqQXNF1dxsa2ruu/r+jj2e4L/zmjz+e7L/3n1IJ29/xnTJ+73Z6Y+w57YtdSYliabaCCqr8pBf5LWrVqKrOdUpnCv+RcYUSFRuXYLCoES+v0UMW8yssz4oULbjhL9M3sFBCPiKMFSStM7RFTmDKe3MyRrX5E7FTpoZpQJlK5qmHCwstK1UgKo/lfHcG7ZXHMI+wbvDJ9Gm19pg0qri8tJSOWaFyR0z7JiUi4WUyOwEcjpQo530tIz0lIn+UQzrhJNkiKQAyBPCJxLdP0vWT2gmQWyjRjYnazxDzAI5JXnaLvJa2XJK2ImQ3GRbWPSE4VcqgiwhHLE+PqOnut7n5rt7O7V5OVSpkHSNNWFLVms9nXyTnlou/oIKQKfMqu1lcoZJEUyazURFlDMQMX4xJtvZ5ekZ5Is0N5dbOqPMD30tZCKfWON2ryZknUVLnkbWMufEWm5IRHCEsACsd5whReZQq15lKsqOB7DKdux3qfGMPLjYoqIB7RuFoiiSonLMnRNnROpm1dOUkLF39LE6PqBRcLc8YEQ4PRLbgXd7AHEn/ChpisVt1flwmbydyb0ASV4SFL6qzyiBlvN15ufqg7lgqZdpqVSna1VOnq5quGYZcQkZJZJKdig7P1EI/IMJZI2qyzh5hMbdw/ZMCuStsukxSLuIRhbozcIPEq1COS+hqy/s6S93DfeoitKset+1I23hB02OpHpA5Pzyozdr0n8nSIasNKxtZvZqfbqbGzX2fneecBs3Kt26+flDtl4WI2PhYGFax0RDFXnrCVIR1hyFOWZAkLna3ufoW9PWB6tqvOEJNN+QZbfZuuOlVdLT7Xmd5+507Kqnb7QF1RE/1Q5k45+7c62IUaH10gtZSVO1E44kkCU5eWI+V1v11EvPuqrs7n+zV17tfH3o3qvElnGwJlQnFs9vyiGRdVFTnbNovy1cmvLrvdb7Gm6754VnNHL7/jmq4uk87eTnd/Z+OibieKdh66qLOmB7CSmPxWQXz3xW5tmnq2yVc8kiC+qoBbwvdvEaSvjP69v0f4tmTRL7q/Qfj2tcpYidK+mfhhJTn79RHa0jT5quZWX+1W5b2//3XyrlKzJLRewP/84/sP084f34zl4eHh4S+nH+Pjj+PDw8OUvtvt9kpgFzQDmaGyC8K3UXAQjNEUm09BM8iYYikaVLT/dW3JCA6CYp+qz6OgGXDa/8qYiYPlTbG3r2lKK6DBxMyAQIw0bYcNEUZowhipjYLx4MCyHWgzS6gnzdMsIULwKktkhMGBU32gwxhTFhxcW0URpFFcjIOmd5iuRIyD+fyiWQpJE8Jup0O/6qTqPAxR61GeQCmPoBmEUhgUhuBZliU8tBU7nzUhXa9SIYefMTQkOEXNGO66dMUk3830uhK8Ypbrg+Cq+/NQpHr3ZBzMm4FNMq9rYoGg7R+lyAlLSHMLUqkgCzpf0uKdMKsY82aQoejbUakr+EwpNiN7MZjq1XbnlYbPA9rttHZB1mFHdXAxbwYaRYSq7+xwE2UyQ0EJx2CBZDd/NmMRBKo/FMgJG+p2KFMvRj6a9aXol3ufVSaGUibIRLU1a6nzZpCiGmM/JGsYkQHh3dBG/DZlx8Zk+mBnp9BCrlEV5MqpQHVH5dmtZKlsotHKy+4M30V1N5i7kreRHqK0Qr1Vj58lwhAtWXfQ32eJQ8Q/+IJCFlksxS3d7O0/3+0+e/miS/A+9n44/672fkPdx8uWXjauors1ZxW9LCnRu/NmcHVPnN29vXkzmN0T6wV1Nb0n0rOX82YQ3xNp7znZsZslb5f5TaZ0R5lbb3VffOeXaKxKYU75X++ttV0Syw1LxrVeomzsRscxny9misVE7Q576L437b4/ghJshl5AOSf6VrxXUc2trCGDJnAP3+eiLwmjT8ILzd0cnz0105ejUcIFWm+7Fq8+f3+KkcJJ8L4LQiZA58OU0wGbUGYzG4nEXC/CEQsaQa7pFA0TgFcGlWAJGCkTe8bGOlFQOOE4bcNrl1ywwYultb2OeutMMTo0mx3Obmf3WavbaXVenHWfH+y9Oth/3u50Ov8aNIOrNFkYtF0xVib/8jvPou/SDwo2TPBM5ndTu8KIKwxNP1drffWm4RSUyk9l5ObKpbG/yWpyI/sKUy5utdACxfAUz+SRpFKDr9lMrxu/dTsjHDKA0GNBxGYauIZcY2QrWBLm1r7wKuNqBiRIMr6ZzFV5WOsWv7BvJUm89KUIkcYRTlCt9dUlVmfeDIZh+NCIi6KH2szZtEW7tTKKwb5DF5nLgq3z+nV1/IvM7VAv9kq9f4NpzMPY1mA6xAiGOJIKgZwSjXYjvaNYmUYe69y/etqQIH0+GqTwHJu4kAHoWOZJBCzLkKk22SeQBZ43Gq9xmI/h49tG4+JJEUOyLGsvh707EQFm0ehp3bCpE7u+bz8wKKkzcwWhbEkVcUGNP0lwZCDPMlQQSiVQPYWRkqln8PEw1+ncFD3V2Zv9v2TvWeemMG9p3uWRicm9Ocp/E1r3OjdFl3Vaf0Y+js1vTOzLzreIatf6jiLLcesaaWPAu4CkxbcPbvUNwW01lHX/FhFE4cSprB5rlIFmGWCuCUIrIeq8GeytS9qcyhRNTA59isLAVEkxbkKWINMIRs2AjRkXQM2pf/h22RxU6jbR3Y+yqtS4sGFvocv+XqfT75ZC2FsVwlklewMjmYvo+7K6rv/NDO31n5cM7a8y9FbYMyr2BP2ZvETxffmpdm9c96sWzB2QrQ9qzFbLHZMaw1xxM7MZ1KsWy3jL1R+cX1BykixF+tSrTbmaODgIyqzOznUl3ToPqD01KRKyNsouE0GaiWgor1Z9Fsv4zqTb3g3mzWWctT5uAzzmrfuiaMPGXIxvw7tYiOqU1Ok0VhPYIijL+B+RojKvjyqUz0jHyGglQBrgYiQtstfS+wwFrXGtjm3ny1PFD1DA/Ppv/12C0Y7B76HRoPCLGGlpmasQ4bUMc9seS+wS0vAJwq9/+08Y5jwxdikZ4QQTskTdpMy+NhSUzgDpVEGmuEbddjcwqv2O+QTd9RFWLjiaFOtGuT2J1aId8hlgq0xJAhkKzT5gYiXzcUzXS7gYJ9iED8enZ5TfPjx524ZTFFHl6giRWDbShJQJii4Lw7M0s/AS/BFO0IaZXAMXoJAWzDzFJjARAa3CUnIGdrWDwnCFZTeQ8BGGszBxwmF2m9vEdAlmgiKSChIZXra4sNdVWq0W/frhB7pXY2+6nBqmDEZUekyrIaBdA9QG0lwbCJlSM9dvOXSJQpqYBxX7GICzDNuJ3QOpVB7AP1ELi4LfVzbqf/33/4Dzn+WUJv4xCtolwKUOF7FDJEO9JniQod6JMcl2Th1Teufw5K31ck+d/n+RBjRpchqjQrdRMubin+GjdkFGo+GHOaCYcCUFibbRgCeDO7uBgY1dMiWNpPFUaoGNRnTET4whIQuOmGFLqjiiVdQRy9iQJ5ycKpV/gSNmcCzVDL7AJ9rkmfllWSThS098abVa9odAG43XhdU1GvAFjmy+pGmXZk1wWY0m5VzkpbepCO1CuzTPVqH2hfn6lstbU7blH3OeRKAw15TBWBhzeU+qZU/nRMWi8XeWBpKMFAhS0SiYlQkl38UpJqMWjU/bxZvCCjQV+4RS/UKWv+LlLltxMeHGzlwwSuS0aPQkHyY8hDr5pzFTCAwyV1kMvYSLSzt8RLGGhYRrA8UOWtHma8VGBj5JdUk9uRbZBCvUSVWRCdMQEYa2Ih9xwRLuDC51UUrR7pEUhoVeeX9yfsKOAU9M6OphKOUlmdhYsTRl9ohcMisa+UkmESrXxns1ZoL6WlDGhabFfOmmXysyx5FDKtr4hMNYykvXyAcMkWDIHbVsjgYn5HHsrk2RSAJnmTavByiiTHJhiuY+6oKgD8U9PRbaI0ZWIiEltgzQTEKhPWnwS31okOH/+rf/0vALTsnvFBPGDzRsKAWFanE70PfBkp4YvDk+g8Vsf8Cjge2xXk46HkBMGhwiCrrbhyxN7D0/sgaFUS4iJgwstmyBDEhhKicY2SYbDR+T26FNWSshp3QvMVf2viASrsFk5pakXqOLBhsNmhouyQzLHVVApjkqlxMTOk+xXXB9wrSeShW1TpQ09qw0nLz+CU7zLJPK9ATVw6Bnd7r6mQfuBYPCaxfjfCijGblDAVOpbO92BKMI1Szzrep20S5GIMVBTwxO3p+ewY7LxxZiHMD//g8MTj6uSNwWVxAKY9w5qERfVTA7WgqolYql/mwF+QgS6aCQz3uX4rY3MYkrGlpKJj1xiobkspoIL84FwBeXgR5Q5ucGRq0NreHUSMpMJjzkJqEAxDpHilC485O+v9LhUGiAjHJLxe3Ugn5/g/SDTGgeoKBo4L3lAFz8be2LhSFm5FiIJwfQpx1C0vSII+U5QiW1tgGBu9YqBSiZG9RtOIsVIhC8s2ddaPnATT3UOzl7jNmE0+BennA8TQNoPPHHA59a12VjhiKLywzQ2sxY17+Ipnw6xrVDuwDUTulttLXSMrohQbm9AqBTi4WTLlKSVpuFfx6wjFKWrrkjJtzIpvmmAMcrkpqfOhw13sXbzr6UroWpoRRwRFscT46OnhJxPOPkR3viEAROSexhuJC2H/alIIElUoytxyV+8IprGwMMepROXuBJUfLaLI2h6aYNa23lJFhqccfN56Uyj2kLF1gU0YlL1HbmwojGe0mj8p6cUUA3lKJlN2+qfhzsRjBQYryuAK5LhUZteMcvccFDk8ivUQNPdB7GNPG5UbIY8TwaPPUZZS8HRxrpS/HI673cR7JZn6adcJyXIskmnASr7b5SmpkZ2DQyPBmcXwye/g4kbUxRK060RgIXMSpfWG96KQQ7nDCe2JF6vIj/fBxWKaExQcmGjx/erYnBTl2IaOe7e8SNZcBSLkHqLWxc4ZXYxx/hA45XkG9bWQ6WZ9w/o6Jju6Sjf4QfWXg5ZSrSQBs6zHAboc4IlJDJOEY5hSDDArAVesDERcAw6VoznnTb3XKBUoQJ2k2JJpYaYeI6dg6JlfqQwu0wDgu521aFhKFCN2uGMRNjGggUI1Qmak6OP8pDNxYsvdS0SxOyBHKRoNZgT8xNKVaikzrRkmF81EjLu3dcXFpzaMF5GUF9wqHmBhfLk+l0uiLppxbnpzxJoIjR7YC7ZVHj0N5w83M+hA+YSc2NVLMF1pibOB9aXVZxyw/fQBFLl3mfr1lM2SbPUKXurQNUEx7ewv6OIfCdp/ZQ3FLaoZ4dUDhCu5ena0tBlnG/7Dwv6AAi72v4cKlaG1Lb/JU7A0P5j7WnlCwL70eeX5+D2cxv0AwSHqLPG/t8yuGbk3cwedbu0BZdmcy5gy533r09Ov7l9JiI8cMkOAi67U67Y7e3pDYpE5Weqo9mLKdhrhdpv+0DG9sHNrYPbGwf2Ng+sPEwIW0f2Ng+sLF9YGPjZaztAxvbBzbg0dwL3T6wsX1gY/vAxvaBje0DG9sHNrYPbGwf2OhtH9h4mKa2D2xsH9jYPrCxfWBj+8DG9oGN3+aBDX9mmRz2TpYwbk+M+/uR7rT3eXntIWgG1RNH9NB8LLUhkOtr2lj+qJL5nIr/ktsLgecXzWDCFKcdaHsk3J/jicqnMm7cUnvywUvjKdz9pY61zBSnsgUdybaWSdc5m8ElzpaeC5nT9T5/NJuodRCH9ohQBXfljH/toPyb47PA3viM60fCL+2RcP8Htb6WrvpZcUcA/U8H19ciXF+74+bzeQnvqm7E8AwW0CSki/l8/n+B2x+c","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Public Template","permalink":"/docs/API-docs/v1.2/publictemplate"},"next":{"title":"Update Template","permalink":"/docs/API-docs/v1.2/update-template"}}');var s=t(74848),l=t(28453),i=t(57742),a=t.n(i),o=t(78178),p=t.n(o),c=t(19624),d=t.n(c),m=t(96226),x=t.n(m),h=(t(77675),t(19365),t(51107)),u=t(21312);const b={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:"eJztPNtuGzuSv1LbB1gkgiRLjp2LZzE7Po5PTjCZEyN2Jti1DInqLqkZd5M9JFuyxhEwD4v9gMW+7Ov+xL7vp5wvWRTJbnVLsnxJJscLKIBjN1lF1o3FYvFyHRg21sHBeXCGaZYwgzq4aAYR6lDxzHApgoPgLEZ4gwYKEDg8eQssSeRUw0zmYCQoNIrjBCFCw3iigQ1lboCBzjDkIx6C8cjtshkNGtUEgWkYJjlmigujYSQVhAqZ4WIMkQzzFKl4yk0MmcIIR1xgBNqoPDS5Qt3uiZ5oND6gzqTQqEGO4JSPBSr4xKMxGn3QaBBMtw2NhuZjwQiPygaDQU9c9wRALzCzDHvBAfSCEqQXNF1dxsa2ruu/r+jj2e4L/zmjz+e7L/3n1IJ29/xnTJ+73Z6Y+w57YtdSYliabaCCqr8pBf5LWrVqKrOdUpnCv+RcYUSFRuXYLCoES+v0UMW8yssz4oULbjhL9M3sFBCPiKMFSStM7RFTmDKe3MyRrX5E7FTpoZpQJlK5qmHCwstK1UgKo/lfHcG7ZXHMI+wbvDJ9Gm19pg0qri8tJSOWaFyR0z7JiUi4WUyOwEcjpQo530tIz0lIn+UQzrhJNkiKQAyBPCJxLdP0vWT2gmQWyjRjYnazxDzAI5JXnaLvJa2XJK2ImQ3GRbWPSE4VcqgiwhHLE+PqOnut7n5rt7O7V5OVSpkHSNNWFLVms9nXyTnlou/oIKQKfMqu1lcoZJEUyazURFlDMQMX4xJtvZ5ekZ5Is0N5dbOqPMD30tZCKfWON2ryZknUVLnkbWMufEWm5IRHCEsACsd5whReZQq15lKsqOB7DKdux3qfGMPLjYoqIB7RuFoiiSonLMnRNnROpm1dOUkLF39LE6PqBRcLc8YEQ4PRLbgXd7AHEn/ChpisVt1flwmbydyb0ASV4SFL6qzyiBlvN15ufqg7lgqZdpqVSna1VOnq5quGYZcQkZJZJKdig7P1EI/IMJZI2qyzh5hMbdw/ZMCuStsukxSLuIRhbozcIPEq1COS+hqy/s6S93DfeoitKset+1I23hB02OpHpA5Pzyozdr0n8nSIasNKxtZvZqfbqbGzX2fneecBs3Kt26+flDtl4WI2PhYGFax0RDFXnrCVIR1hyFOWZAkLna3ufoW9PWB6tqvOEJNN+QZbfZuuOlVdLT7Xmd5+507Kqnb7QF1RE/1Q5k45+7c62IUaH10gtZSVO1E44kkCU5eWI+V1v11EvPuqrs7n+zV17tfH3o3qvElnGwJlQnFs9vyiGRdVFTnbNovy1cmvLrvdb7Gm6754VnNHL7/jmq4uk87eTnd/Z+OibieKdh66qLOmB7CSmPxWQXz3xW5tmnq2yVc8kiC+qoBbwvdvEaSvjP69v0f4tmTRL7q/Qfj2tcpYidK+mfhhJTn79RHa0jT5quZWX+1W5b2//3XyrlKzJLRewP/84/sP084f34zl4eHh4S+nH+Pjj+PDw8OUvtvt9kpgFzQDmaGyC8K3UXAQjNEUm09BM8iYYikaVLT/dW3JCA6CYp+qz6OgGXDa/8qYiYPlTbG3r2lKK6DBxMyAQIw0bYcNEUZowhipjYLx4MCyHWgzS6gnzdMsIULwKktkhMGBU32gwxhTFhxcW0URpFFcjIOmd5iuRIyD+fyiWQpJE8Jup0O/6qTqPAxR61GeQCmPoBmEUhgUhuBZliU8tBU7nzUhXa9SIYefMTQkOEXNGO66dMUk3830uhK8Ypbrg+Cq+/NQpHr3ZBzMm4FNMq9rYoGg7R+lyAlLSHMLUqkgCzpf0uKdMKsY82aQoejbUakr+EwpNiN7MZjq1XbnlYbPA9rttHZB1mFHdXAxbwYaRYSq7+xwE2UyQ0EJx2CBZDd/NmMRBKo/FMgJG+p2KFMvRj6a9aXol3ufVSaGUibIRLU1a6nzZpCiGmM/JGsYkQHh3dBG/DZlx8Zk+mBnp9BCrlEV5MqpQHVH5dmtZKlsotHKy+4M30V1N5i7kreRHqK0Qr1Vj58lwhAtWXfQ32eJQ8Q/+IJCFlksxS3d7O0/3+0+e/miS/A+9n44/672fkPdx8uWXjauors1ZxW9LCnRu/NmcHVPnN29vXkzmN0T6wV1Nb0n0rOX82YQ3xNp7znZsZslb5f5TaZ0R5lbb3VffOeXaKxKYU75X++ttV0Syw1LxrVeomzsRscxny9misVE7Q576L437b4/ghJshl5AOSf6VrxXUc2trCGDJnAP3+eiLwmjT8ILzd0cnz0105ejUcIFWm+7Fq8+f3+KkcJJ8L4LQiZA58OU0wGbUGYzG4nEXC/CEQsaQa7pFA0TgFcGlWAJGCkTe8bGOlFQOOE4bcNrl1ywwYultb2OeutMMTo0mx3Obmf3WavbaXVenHWfH+y9Oth/3u50Ov8aNIOrNFkYtF0xVib/8jvPou/SDwo2TPBM5ndTu8KIKwxNP1drffWm4RSUyk9l5ObKpbG/yWpyI/sKUy5utdACxfAUz+SRpFKDr9lMrxu/dTsjHDKA0GNBxGYauIZcY2QrWBLm1r7wKuNqBiRIMr6ZzFV5WOsWv7BvJUm89KUIkcYRTlCt9dUlVmfeDIZh+NCIi6KH2szZtEW7tTKKwb5DF5nLgq3z+nV1/IvM7VAv9kq9f4NpzMPY1mA6xAiGOJIKgZwSjXYjvaNYmUYe69y/etqQIH0+GqTwHJu4kAHoWOZJBCzLkKk22SeQBZ43Gq9xmI/h49tG4+JJEUOyLGsvh707EQFm0ehp3bCpE7u+bz8wKKkzcwWhbEkVcUGNP0lwZCDPMlQQSiVQPYWRkqln8PEw1+ncFD3V2Zv9v2TvWeemMG9p3uWRicm9Ocp/E1r3OjdFl3Vaf0Y+js1vTOzLzreIatf6jiLLcesaaWPAu4CkxbcPbvUNwW01lHX/FhFE4cSprB5rlIFmGWCuCUIrIeq8GeytS9qcyhRNTA59isLAVEkxbkKWINMIRs2AjRkXQM2pf/h22RxU6jbR3Y+yqtS4sGFvocv+XqfT75ZC2FsVwlklewMjmYvo+7K6rv/NDO31n5cM7a8y9FbYMyr2BP2ZvETxffmpdm9c96sWzB2QrQ9qzFbLHZMaw1xxM7MZ1KsWy3jL1R+cX1BykixF+tSrTbmaODgIyqzOznUl3ToPqD01KRKyNsouE0GaiWgor1Z9Fsv4zqTb3g3mzWWctT5uAzzmrfuiaMPGXIxvw7tYiOqU1Ok0VhPYIijL+B+RojKvjyqUz0jHyGglQBrgYiQtstfS+wwFrXGtjm3ny1PFD1DA/Ppv/12C0Y7B76HRoPCLGGlpmasQ4bUMc9seS+wS0vAJwq9/+08Y5jwxdikZ4QQTskTdpMy+NhSUzgDpVEGmuEbddjcwqv2O+QTd9RFWLjiaFOtGuT2J1aId8hlgq0xJAhkKzT5gYiXzcUzXS7gYJ9iED8enZ5TfPjx524ZTFFHl6giRWDbShJQJii4Lw7M0s/AS/BFO0IaZXAMXoJAWzDzFJjARAa3CUnIGdrWDwnCFZTeQ8BGGszBxwmF2m9vEdAlmgiKSChIZXra4sNdVWq0W/frhB7pXY2+6nBqmDEZUekyrIaBdA9QG0lwbCJlSM9dvOXSJQpqYBxX7GICzDNuJ3QOpVB7AP1ELi4LfVzbqf/33/4Dzn+WUJv4xCtolwKUOF7FDJEO9JniQod6JMcl2Th1Teufw5K31ck+d/n+RBjRpchqjQrdRMubin+GjdkFGo+GHOaCYcCUFibbRgCeDO7uBgY1dMiWNpPFUaoGNRnTET4whIQuOmGFLqjiiVdQRy9iQJ5ycKpV/gSNmcCzVDL7AJ9rkmfllWSThS098abVa9odAG43XhdU1GvAFjmy+pGmXZk1wWY0m5VzkpbepCO1CuzTPVqH2hfn6lstbU7blH3OeRKAw15TBWBhzeU+qZU/nRMWi8XeWBpKMFAhS0SiYlQkl38UpJqMWjU/bxZvCCjQV+4RS/UKWv+LlLltxMeHGzlwwSuS0aPQkHyY8hDr5pzFTCAwyV1kMvYSLSzt8RLGGhYRrA8UOWtHma8VGBj5JdUk9uRbZBCvUSVWRCdMQEYa2Ih9xwRLuDC51UUrR7pEUhoVeeX9yfsKOAU9M6OphKOUlmdhYsTRl9ohcMisa+UkmESrXxns1ZoL6WlDGhabFfOmmXysyx5FDKtr4hMNYykvXyAcMkWDIHbVsjgYn5HHsrk2RSAJnmTavByiiTHJhiuY+6oKgD8U9PRbaI0ZWIiEltgzQTEKhPWnwS31okOH/+rf/0vALTsnvFBPGDzRsKAWFanE70PfBkp4YvDk+g8Vsf8Cjge2xXk46HkBMGhwiCrrbhyxN7D0/sgaFUS4iJgwstmyBDEhhKicY2SYbDR+T26FNWSshp3QvMVf2viASrsFk5pakXqOLBhsNmhouyQzLHVVApjkqlxMTOk+xXXB9wrSeShW1TpQ09qw0nLz+CU7zLJPK9ATVw6Bnd7r6mQfuBYPCaxfjfCijGblDAVOpbO92BKMI1Szzrep20S5GIMVBTwxO3p+ewY7LxxZiHMD//g8MTj6uSNwWVxAKY9w5qERfVTA7WgqolYql/mwF+QgS6aCQz3uX4rY3MYkrGlpKJj1xiobkspoIL84FwBeXgR5Q5ucGRq0NreHUSMpMJjzkJqEAxDpHilC485O+v9LhUGiAjHJLxe3Ugn5/g/SDTGgeoKBo4L3lAFz8be2LhSFm5FiIJwfQpx1C0vSII+U5QiW1tgGBu9YqBSiZG9RtOIsVIhC8s2ddaPnATT3UOzl7jNmE0+BennA8TQNoPPHHA59a12VjhiKLywzQ2sxY17+Ipnw6xrVDuwDUTulttLXSMrohQbm9AqBTi4WTLlKSVpuFfx6wjFKWrrkjJtzIpvmmAMcrkpqfOhw13sXbzr6UroWpoRRwRFscT46OnhJxPOPkR3viEAROSexhuJC2H/alIIElUoytxyV+8IprGwMMepROXuBJUfLaLI2h6aYNa23lJFhqccfN56Uyj2kLF1gU0YlL1HbmwojGe0mj8p6cUUA3lKJlN2+qfhzsRjBQYryuAK5LhUZteMcvccFDk8ivUQNPdB7GNPG5UbIY8TwaPPUZZS8HRxrpS/HI673cR7JZn6adcJyXIskmnASr7b5SmpkZ2DQyPBmcXwye/g4kbUxRK060RgIXMSpfWG96KQQ7nDCe2JF6vIj/fBxWKaExQcmGjx/erYnBTl2IaOe7e8SNZcBSLkHqLWxc4ZXYxx/hA45XkG9bWQ6WZ9w/o6Jju6Sjf4QfWXg5ZSrSQBs6zHAboc4IlJDJOEY5hSDDArAVesDERcAw6VoznnTb3XKBUoQJ2k2JJpYaYeI6dg6JlfqQwu0wDgu521aFhKFCN2uGMRNjGggUI1Qmak6OP8pDNxYsvdS0SxOyBHKRoNZgT8xNKVaikzrRkmF81EjLu3dcXFpzaMF5GUF9wqHmBhfLk+l0uiLppxbnpzxJoIjR7YC7ZVHj0N5w83M+hA+YSc2NVLMF1pibOB9aXVZxyw/fQBFLl3mfr1lM2SbPUKXurQNUEx7ewv6OIfCdp/ZQ3FLaoZ4dUDhCu5ena0tBlnG/7Dwv6AAi72v4cKlaG1Lb/JU7A0P5j7WnlCwL70eeX5+D2cxv0AwSHqLPG/t8yuGbk3cwedbu0BZdmcy5gy533r09Ov7l9JiI8cMkOAi67U67Y7e3pDYpE5Weqo9mLKdhrhdpv+0DG9sHNrYPbGwf2Ng+sPEwIW0f2Ng+sLF9YGPjZaztAxvbBzbg0dwL3T6wsX1gY/vAxvaBje0DG9sHNrYPbGwf2OhtH9h4mKa2D2xsH9jYPrCxfWBj+8DG9oGN3+aBDX9mmRz2TpYwbk+M+/uR7rT3eXntIWgG1RNH9NB8LLUhkOtr2lj+qJL5nIr/ktsLgecXzWDCFKcdaHsk3J/jicqnMm7cUnvywUvjKdz9pY61zBSnsgUdybaWSdc5m8ElzpaeC5nT9T5/NJuodRCH9ohQBXfljH/toPyb47PA3viM60fCL+2RcP8Htb6WrvpZcUcA/U8H19ciXF+74+bzeQnvqm7E8AwW0CSki/l8/n+B2x+c",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},g=void 0,j={},y=[];function f(e){const n={code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",...(0,l.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Get Template"}),"\n",(0,s.jsx)(a(),{method:"get",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures."}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Responses of Signer Widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12,\n "min_date": "",\n "max_date": "",\n "readonly": false,\n "signing_date": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"14",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Enter number",\n "formula": "",\n "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"15",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"cells"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "cells",\n "page": 1,\n "x": 100,\n "y": 100,\n "w": 114,\n "h": 50,\n "options": {\n "name": "cells",\n "required": true,\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Responses of Prefill widgets"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "required": true,\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "response": "04/15/2024",\n "format": "mm/dd/yyyy",\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "required": true,\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,s.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(u.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(p(),{...t(23260)}),"\n",(0,s.jsx)(d(),{...t(78966)}),"\n",(0,s.jsx)(x(),{...t(53308)})]})}function w(e={}){const{wrapper:n}={...(0,l.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(f,{...e})}):f(e)}},23260(e){e.exports=JSON.parse('{"parameters":[{"name":"template_id","in":"path","description":"ID of template that needs to be fetched","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"strng"}}]}')},78966(e){e.exports={title:"Body"}},53308(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"x1Hbnms2Pg"},"title":{"type":"string","example":"sample template"},"note":{"type":"string","example":"template note"},"description":{"type":"string","example":"template description"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"sender_name":{"type":"string","example":"opensign"},"sender_email":{"type":"string","example":"mailer@opensignlabs.com"},"notify_on_signatures":{"type":"boolean","example":false},"merge_certificate":{"type":"boolean","example":false},"file":{"type":"string","example":"https://templateuser.com"},"owner":{"type":"string","example":"template creator name"},"signers":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","example":"ceo"},"name":{"type":"string","example":"joe bee"},"email":{"type":"string","example":"joebee@example.com"},"phone":{"type":"string","example":"456213871"},"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","format":"string","example":"textbox"},"page":{"type":"number","format":"number","example":1},"x":{"type":"number","format":"number","example":244},"y":{"type":"number","format":"number","example":71},"w":{"type":"number","format":"number","example":38},"h":{"type":"number","format":"number","example":46},"options":{"type":"object","properties":{"name":{"type":"string","format":"string","example":"textbox"},"color":{"type":"string","format":"string","example":"black"},"fontSize":{"type":"number","format":"number","example":12},"hide_text_with_asterisks":{"type":"boolean","format":"boolean","example":false}}}},"title":"template_Signers_widgets_details"}}},"title":"template_Signers_details"}},"sendInOrder":{"type":"boolean","example":true},"send_in_order_strict":{"type":"boolean","example":false},"allow_offline_sign":{"type":"boolean","description":"Whether signers can submit a copy of this template signed using an external tool for owner review. Defaults to false.","example":false},"createdAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"enableTour":{"type":"boolean","example":true},"redirect_url":{"type":"string","format":"string","example":""},"allow_modifications":{"type":"boolean","example":false},"auto_reminder":{"type":"boolean","example":false},"timeToCompleteDays":{"type":"number","description":"time to complete days is used to calculate expiry date of your document","format":"number","example":15},"remind_once_in_every":{"type":"number","example":0},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"]},"cc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"]},"prefill":{"type":"object","description":"You can provide widgets which can embed before sending to signer","properties":{"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","format":"string","example":"textbox"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":100},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":30},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":40},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":80},"options":{"type":"object","properties":{"name":{"type":"string","example":"textbox"},"response":{"type":"string","example":"joe"},"color":{"type":"string","example":"red"},"fontsize":{"type":"number","example":12}}}}}}},"title":"prefill"}},"xml":{"name":"template_details"},"title":"template_details"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"Template not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Template not found!"}},"title":"inline_response_404_6"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/3b95ab04.ff3e1f5e.js b/assets/js/3b95ab04.ff3e1f5e.js deleted file mode 100644 index e3af823c8..000000000 --- a/assets/js/3b95ab04.ff3e1f5e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[1543],{83669(e,n,t){t.r(n),t.d(n,{assets:()=>b,contentTitle:()=>y,default:()=>z,frontMatter:()=>g,metadata:()=>r,toc:()=>j});const r=JSON.parse('{"id":"API-docs/v1.2/get-template","title":"Get Template","description":"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.","source":"@site/docs/API-docs/v1.2/get-template.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/get-template","permalink":"/docs/API-docs/v1.2/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":"eJztG8tyG7nxVxAcEps14kuUbHMvq8Qur2pda5clx5VIKi440+TAmgFmAYxIropVe8gf5JRrPm2/JNUAZjjDlx7WykoVfZA5QDfQLzQaDfQ1NWysaf+MnkKaJcyAphcBjUCHimeGS0H79DQG8hYMKUDI0YdjwpJETjSZyZwYSRQYxeEKSASG8UQTNpS5IYzoDEI+4iExHrlZDqOJBnUFhGkyTHLIFBdGk5FUJFTADBdjEskwTwGbJ9zEJFMQwYgLiIg2Kg9NrkA3z8W5aDQ+gs6k0KCJHJETPhagyGcejcHofqOBMJ0maTQ0HwuGeNj2888/n4vrc0HIOTWzDM5pn5zTEuScBq4vY2Pb1/HfU/zY777wnzP8POy+9J8TC9rp+c8YP7udczH3E56LrqXEsDTbQgV2PygF/ktatWpss5Nim4Jfcq4gwkajcgiKDsHSOj3YMa/yso+8cMENZ4nezE4B8YQ4WpC0wlQPmYKU8WQzR7b7CbFTpQd7QplI5bqGCQsvK10jKYzmvzqCu2VzzCMYGJiaAa62AdMGFNeXlpIRSzSsyOkA5YQkbBaTI/DJSKlCzmMJ6RCF9EUOySk3yRZJIYhBkCckrmWaHktmL1BmoUwzJmabJeYBnpC86hQ9lrReorQiZrYYF/Y+ITlVyMGOCEYsT4zra/f2Ogd73Xa3V5OVSpkHSNO9KNqbzWZfJ+eUi4GjA5Eq8Cmbru9QwCIpklmpibIHYwYuxiXaej29Qj2hZodyullVHuCxtLVQSn3irZrcLImaKpe8bcyF78iUvOIRkCUABeM8YQqmmQKtuRQrKniM5dRpW+8TQ3i5VVEFxBNaV0skYecVS3KwA52haVtXjtKCxW9pYlDn9GJhzpBAaCC6AffiFvaA4k/YEJLVrrvrMmEzmXsTugJleMiSOqs8YsbbjZebX+qOpUKm7aDSyaZLna5vvmoY9ggRKZlFciK2OFsP8YQMY4mk7Tq7j8nU1v19FuyqtO0xSbGISzLMjZFbJF6FekJSX0PWHyx5D/fQS2xVOe7cl7LxlqDDdj8hdXh6Vpmx5z2Rp0NQW04ytn87O512jZ2DOjuH7XvsyrVpv35TbpeNi934jTCgyMpEGHPlCVtZ0hGEPGVJlrDQ2Wr3K+ztHtuzPXWGkGzLN9jum3TVrupq8bnO9A7at1JWddp76gqHGIQyd8o5uNHBLtT45AKppazcBwUjniRk4tJyqLzOw0XE3Vd1dR4e1NR5UF97G9W5SWdbAmVEcWye+0MzLLoqcrZjFu2rm19ddt2HONN1XuzX3NHLRzzT1WXS7rU6B62th7pWFLXue6izpkfISmLyoYL4zotubZva3+YrnkgQX1XADeH7QwTpK6u/90eEb0sW/aLzDcK3r1XGSpT2YOInK8nZr4/QlrbJVzW3+qpblffBwdfJu0rNktDOKf/7X99/nLR/fDuWR0dHRz+dfIrffBofHR2l+N1sNlcCOxpQmYGyB8LjiPbpGExx+UQDmjHFUjCg8P7r2pJB+7S4pxrwiAaU4/1XxkxMly/Fjl/jllZAExMzQwRApPE6bAhkBCaMAccoGKd9yzbVZpbgTJqnWYKEwDRLZAS071RPdRhDymj/2ioKIY3iYkwD7zBdixjT+fwiKIWkEaHbbuN/dVJ1Hoag9ShPSCkPGtBQCgPCIDzLsoSHtqP1RSPS9SoVcvgFQoOCUziM4W5K14zy3U6va4Eps1z36bTzw1CkuvthTOcBtUnmdUMsELT9UYocsYQ0NyCVCrKg8yUt3gqzijEPaAZiYFelruAzpdgM7cVAqlfHnVcGPqN422ntAq3Drmp6MQ+oBhGBGjg73EaZzEBgwpEukOzlz3YshAD1fYGcsKFuhjL1YuSj2UCKQXn3WWViKGUCTFRHs5Y6D2gKagyDEK1hhAYEt0Mb8ZuUHRuT6X6rVWgh16AKcuVEgLql8uxVslQ20WjlZW+Gb6O6Deau5E2khyCtUG/U4xcJZAiWrFvo74uEIcD3vqGQRRZLccM0vYPDbmf/5YsOwvvY+/78u967LXUfL1t62biK7s6cVfSypUTvzAM6vSNOt9ebB3R2R6wXONXkjkj7L+cBje+I1DtEO3a75M0y32RKt5S59VZ3xXd+CdeqFOaE/3pnrXVRLBuOjGu9RDnYRscxny92isVG7R576IE37YF/gkK3Qy+gnBM9Fu9VVHMra8jADdzDD7gYSMQYoPBCczvHZ1/NDORolHAB1tuuxavv359jwHCSeN9FQiaIzocpxwc2ocxmNhKJuV6EIxY0IrnGVzRMEJgaUIIlxEiZ2Dc21okSBVccJk3y2iUXbPBiaW2uo946U4iOzHaH02139/c67b32i9POYb/3qn9w2Gy32/+kAZ2mycKg7YmxsvmX33kWPco8INgwgVOZ307tCiKuIDSDXK311duWEy2Vn8rI7ZVLa3+b1eRGDhSkXNxooQWK4Smcyr9JbDXwms30uvVbtzPEQQMIPRaJ2EwTrkmuIbIdLAlza18wzbiaERQkGt9M5qp8rHWDXziwkkReBlKEgOsIrkCt9dUlVnse0GEY3jfiwuihtnMGtqlba8MYLHMpqnUuuS6rf8jcrsPiItM7HzKJeRjbHkiHEJEhjKQCgh4Dl6KRfhWv+PinujGvPgVESJ8sJlJ4jk1cyIDoWOZJRFiWAVNNNB6C5nHWaLyGYT4mn44bjYtnRYDHsqy5HJO2IgTMotHzutXhJPbw3bxnxFBnZkpCuSdVxAUO/iyBkSF5loEioVQC1HMyUjL1DD4d5trtTaFNnb3Z/yV7++1NMdjSpsgjE6PvcZR/E1p77U2hX53WH4CPY/ONiX3ZfoiQc63vKFIQNx5gtkajC0g8GfvIU2+IPKtxpvu32N4LJ45t9UCgjALL6G9NhFiJH+cB7a3LqJzIFEyMDn0CwpCJkmIckCwBpoEYNSNszLggOJz608OlWkCpm0R3N8qqUuPCxqSFLge9dnvQKYXQWxXCaSW1QkYyF9Hjsrpu/u0M9QaHJUMHqwwdC/uAxD5vP5WXIB6Xn+r0xk2/asHcAdl+WmO22u6Y1BDmipuZTW9O91jG91x//+wCM4doKdLnRW0+1MS0T8uUS+u6kgudUxxPXRXZUhsCl1kazUQ0lNNVn8Uy3rrqNLt0HizjrPVxW+Ah37srijZszMX4JryLhahOUJ1OYzWBLYKyjP8IGJV5fVShfLo4BoZhOmqAi5G0yF5L7zMQeAC1OraTr2xrkITSheHo2BuNAuX3f/23xGo0ymDbWqMtgXifK5LJCSjM8zIRkVECUz5MXLkGpLavLNjQwNIEtE5mhAsDY2UznXzMDUuIf81IQpaxIU84GjGCSRfoV9aBbpLidDqT+V8UEEYiuIIEbZ/guSWtV3KQiVSXIywdCQgjQzyggtYERMxEiICFJgIilT254tuETHENWPOBVHNHmxRGsdCQlAk2Bhw7IFVhRZBwNFei5DDXhmiZ5JZkgu5dKneksQzZvL0V4htMxSu3N+MxSEGMZnMFZJzzCHRAQhkBcaloZEFgiK8NyZAWHoI9QecikeGlVeAoTxKSSXQhnCUYAlRpRHSjmNC4b/tTlNdBKbBMSczel4UunzSght9xcekqW/bIWWlXn2GouYFFJDGZTFZM/3kd5y03P+RD8hEyqbmRarbAHnMT50O7XKqDlB9upLcgwNpPZTEsxohkqNcEMzLUrRiSrHUCBi1Et44+HFuv+5z8/tu/yTtgSpBYTpy1hrmCZEbGxVQoOad5J7bSadrkBstNjBIPnfHhDQxoU0jwc8zM77/9R5OfYEK48EsKWWk0anVOf66XPb3j2jQafaIglVeYXRECUDVMzcjiMsmSpgEbDETEByN4VGYu4HYHwApGE6c+t0nxQca0nkgVndMFAGFRBBFS6hIwZZonIC5TUmnwEIvlhnVTi+5IsZFZ9DpSk5GliSiZG2fAxam2oMYKNVPS2FehJItGBdGrCa1bUW5nXiK+Mr8dFYNkZT9dngYdQsS1++kmLD0V0mdi4KocrSDQSXuAafv1lOEqLTJrbvPGVVoX1IpcbxT0iqaQ4SwfJpVSOM9wkxyFIWQoWHez3Pd1avgYjTzz736eB6TRwGQdtuJvlqGW8Kvp6900SdHRxQyL6gzBmM8Q6aVkb3X8+eM74gaqIghZ5DC+I8XQmqRs5scTs0WOg5vYV/eVA/tLThRF0968Lm2f9V1OwQhswsiqd7GoM+4X8VnhDAj6iK9xJu7IIQxzKVp/0YL7+NqrMAMq1e9HJ6CueFhcRG3woy0L3KIBTXgI/vzj44Kjtx/ekav9ZhtTTWVQcguX2np3/Lc3P528QWJQBU5gnWa72bZpGqlNykRlpqqLWg4nrhfh666Kc1fFuavi3FVx7qo47yekXRXnropzV8W59cXvropzV8VJnkzxwa6Kc1fFuavi3FVx7qo4d1WcuyrOXRXn+a6K836a2lVx7qo4d1WcuyrOXRXnrorz21Rx+rc36LBbWcK4ffnkH+G7V0tn5fM9GtB+tYbzIqCx1AZBrq+HTMMnlczn2PxLbl+dn10E9IopjvfK9mmTv2OOynrMjVdqzz56aTwnty8HXctM8bpI4NMia5lYMxDQS5gt1aTO8Zm6f2KE1DoId4NcwV15q1Z78PX2zSm1ZQVx/WnTpX3a5H/g6Gvpqr95cgTgX3yAtRbh+to9m5rPS3jXtRHDM1hAo5Au5vP5/wDknbY4","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Public Template","permalink":"/docs/API-docs/v1.2/publictemplate"},"next":{"title":"Update Template","permalink":"/docs/API-docs/v1.2/update-template"}}');var a=t(74848),i=t(28453),s=t(57742),l=t.n(s),o=t(78178),p=t.n(o),c=t(19624),d=t.n(c),m=t(96226),x=t.n(m),u=(t(77675),t(19365),t(51107)),h=t(21312);const g={id:"get-template",title:"Get Template",description:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.",sidebar_label:"Get Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztG8tyG7nxVxAcEps14kuUbHMvq8Qur2pda5clx5VIKi440+TAmgFmAYxIropVe8gf5JRrPm2/JNUAZjjDlx7WykoVfZA5QDfQLzQaDfQ1NWysaf+MnkKaJcyAphcBjUCHimeGS0H79DQG8hYMKUDI0YdjwpJETjSZyZwYSRQYxeEKSASG8UQTNpS5IYzoDEI+4iExHrlZDqOJBnUFhGkyTHLIFBdGk5FUJFTADBdjEskwTwGbJ9zEJFMQwYgLiIg2Kg9NrkA3z8W5aDQ+gs6k0KCJHJETPhagyGcejcHofqOBMJ0maTQ0HwuGeNj2888/n4vrc0HIOTWzDM5pn5zTEuScBq4vY2Pb1/HfU/zY777wnzP8POy+9J8TC9rp+c8YP7udczH3E56LrqXEsDTbQgV2PygF/ktatWpss5Nim4Jfcq4gwkajcgiKDsHSOj3YMa/yso+8cMENZ4nezE4B8YQ4WpC0wlQPmYKU8WQzR7b7CbFTpQd7QplI5bqGCQsvK10jKYzmvzqCu2VzzCMYGJiaAa62AdMGFNeXlpIRSzSsyOkA5YQkbBaTI/DJSKlCzmMJ6RCF9EUOySk3yRZJIYhBkCckrmWaHktmL1BmoUwzJmabJeYBnpC86hQ9lrReorQiZrYYF/Y+ITlVyMGOCEYsT4zra/f2Ogd73Xa3V5OVSpkHSNO9KNqbzWZfJ+eUi4GjA5Eq8Cmbru9QwCIpklmpibIHYwYuxiXaej29Qj2hZodyullVHuCxtLVQSn3irZrcLImaKpe8bcyF78iUvOIRkCUABeM8YQqmmQKtuRQrKniM5dRpW+8TQ3i5VVEFxBNaV0skYecVS3KwA52haVtXjtKCxW9pYlDn9GJhzpBAaCC6AffiFvaA4k/YEJLVrrvrMmEzmXsTugJleMiSOqs8YsbbjZebX+qOpUKm7aDSyaZLna5vvmoY9ggRKZlFciK2OFsP8YQMY4mk7Tq7j8nU1v19FuyqtO0xSbGISzLMjZFbJF6FekJSX0PWHyx5D/fQS2xVOe7cl7LxlqDDdj8hdXh6Vpmx5z2Rp0NQW04ytn87O512jZ2DOjuH7XvsyrVpv35TbpeNi934jTCgyMpEGHPlCVtZ0hGEPGVJlrDQ2Wr3K+ztHtuzPXWGkGzLN9jum3TVrupq8bnO9A7at1JWddp76gqHGIQyd8o5uNHBLtT45AKppazcBwUjniRk4tJyqLzOw0XE3Vd1dR4e1NR5UF97G9W5SWdbAmVEcWye+0MzLLoqcrZjFu2rm19ddt2HONN1XuzX3NHLRzzT1WXS7rU6B62th7pWFLXue6izpkfISmLyoYL4zotubZva3+YrnkgQX1XADeH7QwTpK6u/90eEb0sW/aLzDcK3r1XGSpT2YOInK8nZr4/QlrbJVzW3+qpblffBwdfJu0rNktDOKf/7X99/nLR/fDuWR0dHRz+dfIrffBofHR2l+N1sNlcCOxpQmYGyB8LjiPbpGExx+UQDmjHFUjCg8P7r2pJB+7S4pxrwiAaU4/1XxkxMly/Fjl/jllZAExMzQwRApPE6bAhkBCaMAccoGKd9yzbVZpbgTJqnWYKEwDRLZAS071RPdRhDymj/2ioKIY3iYkwD7zBdixjT+fwiKIWkEaHbbuN/dVJ1Hoag9ShPSCkPGtBQCgPCIDzLsoSHtqP1RSPS9SoVcvgFQoOCUziM4W5K14zy3U6va4Eps1z36bTzw1CkuvthTOcBtUnmdUMsELT9UYocsYQ0NyCVCrKg8yUt3gqzijEPaAZiYFelruAzpdgM7cVAqlfHnVcGPqN422ntAq3Drmp6MQ+oBhGBGjg73EaZzEBgwpEukOzlz3YshAD1fYGcsKFuhjL1YuSj2UCKQXn3WWViKGUCTFRHs5Y6D2gKagyDEK1hhAYEt0Mb8ZuUHRuT6X6rVWgh16AKcuVEgLql8uxVslQ20WjlZW+Gb6O6Deau5E2khyCtUG/U4xcJZAiWrFvo74uEIcD3vqGQRRZLccM0vYPDbmf/5YsOwvvY+/78u967LXUfL1t62biK7s6cVfSypUTvzAM6vSNOt9ebB3R2R6wXONXkjkj7L+cBje+I1DtEO3a75M0y32RKt5S59VZ3xXd+CdeqFOaE/3pnrXVRLBuOjGu9RDnYRscxny92isVG7R576IE37YF/gkK3Qy+gnBM9Fu9VVHMra8jADdzDD7gYSMQYoPBCczvHZ1/NDORolHAB1tuuxavv359jwHCSeN9FQiaIzocpxwc2ocxmNhKJuV6EIxY0IrnGVzRMEJgaUIIlxEiZ2Dc21okSBVccJk3y2iUXbPBiaW2uo946U4iOzHaH02139/c67b32i9POYb/3qn9w2Gy32/+kAZ2mycKg7YmxsvmX33kWPco8INgwgVOZ307tCiKuIDSDXK311duWEy2Vn8rI7ZVLa3+b1eRGDhSkXNxooQWK4Smcyr9JbDXwms30uvVbtzPEQQMIPRaJ2EwTrkmuIbIdLAlza18wzbiaERQkGt9M5qp8rHWDXziwkkReBlKEgOsIrkCt9dUlVnse0GEY3jfiwuihtnMGtqlba8MYLHMpqnUuuS6rf8jcrsPiItM7HzKJeRjbHkiHEJEhjKQCgh4Dl6KRfhWv+PinujGvPgVESJ8sJlJ4jk1cyIDoWOZJRFiWAVNNNB6C5nHWaLyGYT4mn44bjYtnRYDHsqy5HJO2IgTMotHzutXhJPbw3bxnxFBnZkpCuSdVxAUO/iyBkSF5loEioVQC1HMyUjL1DD4d5trtTaFNnb3Z/yV7++1NMdjSpsgjE6PvcZR/E1p77U2hX53WH4CPY/ONiX3ZfoiQc63vKFIQNx5gtkajC0g8GfvIU2+IPKtxpvu32N4LJ45t9UCgjALL6G9NhFiJH+cB7a3LqJzIFEyMDn0CwpCJkmIckCwBpoEYNSNszLggOJz608OlWkCpm0R3N8qqUuPCxqSFLge9dnvQKYXQWxXCaSW1QkYyF9Hjsrpu/u0M9QaHJUMHqwwdC/uAxD5vP5WXIB6Xn+r0xk2/asHcAdl+WmO22u6Y1BDmipuZTW9O91jG91x//+wCM4doKdLnRW0+1MS0T8uUS+u6kgudUxxPXRXZUhsCl1kazUQ0lNNVn8Uy3rrqNLt0HizjrPVxW+Ah37srijZszMX4JryLhahOUJ1OYzWBLYKyjP8IGJV5fVShfLo4BoZhOmqAi5G0yF5L7zMQeAC1OraTr2xrkITSheHo2BuNAuX3f/23xGo0ymDbWqMtgXifK5LJCSjM8zIRkVECUz5MXLkGpLavLNjQwNIEtE5mhAsDY2UznXzMDUuIf81IQpaxIU84GjGCSRfoV9aBbpLidDqT+V8UEEYiuIIEbZ/guSWtV3KQiVSXIywdCQgjQzyggtYERMxEiICFJgIilT254tuETHENWPOBVHNHmxRGsdCQlAk2Bhw7IFVhRZBwNFei5DDXhmiZ5JZkgu5dKneksQzZvL0V4htMxSu3N+MxSEGMZnMFZJzzCHRAQhkBcaloZEFgiK8NyZAWHoI9QecikeGlVeAoTxKSSXQhnCUYAlRpRHSjmNC4b/tTlNdBKbBMSczel4UunzSght9xcekqW/bIWWlXn2GouYFFJDGZTFZM/3kd5y03P+RD8hEyqbmRarbAHnMT50O7XKqDlB9upLcgwNpPZTEsxohkqNcEMzLUrRiSrHUCBi1Et44+HFuv+5z8/tu/yTtgSpBYTpy1hrmCZEbGxVQoOad5J7bSadrkBstNjBIPnfHhDQxoU0jwc8zM77/9R5OfYEK48EsKWWk0anVOf66XPb3j2jQafaIglVeYXRECUDVMzcjiMsmSpgEbDETEByN4VGYu4HYHwApGE6c+t0nxQca0nkgVndMFAGFRBBFS6hIwZZonIC5TUmnwEIvlhnVTi+5IsZFZ9DpSk5GliSiZG2fAxam2oMYKNVPS2FehJItGBdGrCa1bUW5nXiK+Mr8dFYNkZT9dngYdQsS1++kmLD0V0mdi4KocrSDQSXuAafv1lOEqLTJrbvPGVVoX1IpcbxT0iqaQ4SwfJpVSOM9wkxyFIWQoWHez3Pd1avgYjTzz736eB6TRwGQdtuJvlqGW8Kvp6900SdHRxQyL6gzBmM8Q6aVkb3X8+eM74gaqIghZ5DC+I8XQmqRs5scTs0WOg5vYV/eVA/tLThRF0968Lm2f9V1OwQhswsiqd7GoM+4X8VnhDAj6iK9xJu7IIQxzKVp/0YL7+NqrMAMq1e9HJ6CueFhcRG3woy0L3KIBTXgI/vzj44Kjtx/ekav9ZhtTTWVQcguX2np3/Lc3P528QWJQBU5gnWa72bZpGqlNykRlpqqLWg4nrhfh666Kc1fFuavi3FVx7qo47yekXRXnropzV8W59cXvropzV8VJnkzxwa6Kc1fFuavi3FVx7qo4d1WcuyrOXRXn+a6K836a2lVx7qo4d1WcuyrOXRXnrorz21Rx+rc36LBbWcK4ffnkH+G7V0tn5fM9GtB+tYbzIqCx1AZBrq+HTMMnlczn2PxLbl+dn10E9IopjvfK9mmTv2OOynrMjVdqzz56aTwnty8HXctM8bpI4NMia5lYMxDQS5gt1aTO8Zm6f2KE1DoId4NcwV15q1Z78PX2zSm1ZQVx/WnTpX3a5H/g6Gvpqr95cgTgX3yAtRbh+to9m5rPS3jXtRHDM1hAo5Au5vP5/wDknbY4",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},y=void 0,b={},j=[];function f(e){const n={code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",...(0,i.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Get Template"}),"\n",(0,a.jsx)(l(),{method:"get",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,a.jsx)(n.p,{children:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures."}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.strong,{children:"Responses of Signer Widgets:"})}),"\n",(0,a.jsxs)(n.ol,{children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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,a.jsxs)(n.ol,{start:"2",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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,a.jsxs)(n.ol,{start:"3",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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,a.jsxs)(n.ol,{start:"4",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"5",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"6",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"7",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"8",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12,\n "min_date": "",\n "max_date": "",\n "readonly": false,\n "signing_date": false\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"9",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"10",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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,a.jsxs)(n.ol,{start:"11",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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,a.jsxs)(n.ol,{start:"12",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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,a.jsxs)(n.ol,{start:"13",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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,a.jsxs)(n.ol,{start:"14",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Enter number",\n "formula": "",\n "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"15",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"cells"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type": "cells",\n "page": 1,\n "x": 100,\n "y": 100,\n "w": 114,\n "h": 50,\n "options": {\n "name": "cells",\n "required": true,\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.strong,{children:"Responses of Prefill widgets"})}),"\n",(0,a.jsxs)(n.ol,{children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "required": true,\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"2",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "response": "04/15/2024",\n "format": "mm/dd/yyyy",\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"3",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"4",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"5",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "required": true,\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,a.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,a.jsx)(h.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,a.jsx)(p(),{...t(23260)}),"\n",(0,a.jsx)(d(),{...t(78966)}),"\n",(0,a.jsx)(x(),{...t(53308)})]})}function z(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(f,{...e})}):f(e)}},23260(e){e.exports=JSON.parse('{"parameters":[{"name":"template_id","in":"path","description":"ID of template that needs to be fetched","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"strng"}}]}')},78966(e){e.exports={title:"Body"}},53308(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"x1Hbnms2Pg"},"title":{"type":"string","example":"sample template"},"note":{"type":"string","example":"template note"},"description":{"type":"string","example":"template description"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"sender_name":{"type":"string","example":"opensign"},"sender_email":{"type":"string","example":"mailer@opensignlabs.com"},"notify_on_signatures":{"type":"boolean","example":false},"merge_certificate":{"type":"boolean","example":false},"file":{"type":"string","example":"https://templateuser.com"},"owner":{"type":"string","example":"template creator name"},"signers":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","example":"ceo"},"name":{"type":"string","example":"joe bee"},"email":{"type":"string","example":"joebee@example.com"},"phone":{"type":"string","example":"456213871"},"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","format":"string","example":"textbox"},"page":{"type":"number","format":"number","example":1},"x":{"type":"number","format":"number","example":244},"y":{"type":"number","format":"number","example":71},"w":{"type":"number","format":"number","example":38},"h":{"type":"number","format":"number","example":46},"options":{"type":"object","properties":{"name":{"type":"string","format":"string","example":"textbox"},"color":{"type":"string","format":"string","example":"black"},"fontSize":{"type":"number","format":"number","example":12},"hide_text_with_asterisks":{"type":"boolean","format":"boolean","example":false}}}},"title":"template_Signers_widgets_details"}}},"title":"template_Signers_details"}},"sendInOrder":{"type":"boolean","example":true},"send_in_order_strict":{"type":"boolean","example":false},"allow_offline_sign":{"type":"boolean","description":"Whether signers can submit a copy of this template signed using an external tool for owner review. Defaults to false.","example":false},"createdAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"enableTour":{"type":"boolean","example":true},"redirect_url":{"type":"string","format":"string","example":""},"allow_modifications":{"type":"boolean","example":false},"auto_reminder":{"type":"boolean","example":false},"timeToCompleteDays":{"type":"number","description":"time to complete days is used to calculate expiry date of your document","format":"number","example":15},"remind_once_in_every":{"type":"number","example":0},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"]},"prefill":{"type":"object","description":"You can provide widgets which can embed before sending to signer","properties":{"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","format":"string","example":"textbox"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":100},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":30},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":40},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":80},"options":{"type":"object","properties":{"name":{"type":"string","example":"textbox"},"response":{"type":"string","example":"joe"},"color":{"type":"string","example":"red"},"fontsize":{"type":"number","example":12}}}}}}},"title":"prefill"}},"xml":{"name":"template_details"},"title":"template_details"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"Template not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Template not found!"}},"title":"inline_response_404_6"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/3c9ed71a.c61f63ae.js b/assets/js/3c9ed71a.c61f63ae.js new file mode 100644 index 000000000..8a1a5367e --- /dev/null +++ b/assets/js/3c9ed71a.c61f63ae.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[5946],{49169(e,n,t){t.r(n),t.d(n,{assets:()=>j,contentTitle:()=>y,default:()=>w,frontMatter:()=>g,metadata:()=>i,toc:()=>f});const i=JSON.parse('{"id":"API-docs/v1.2/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.2/createdocument.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/createdocument","permalink":"/docs/API-docs/v1.2/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":"eJztPdlyGzmSv4Kt3lhbnCIp0vLRbI931Lan2zvdtsKSx9EreiWwCiRhVQHVQJUojsyIeZjYD9jYl32dn9j3/ZT+ko1MHHXw0GF3j3uGHTFjEYUjkUgk8gLyMsjpRAeD4+CZjIqUiVwH78IgZjpSPMu5FMEgOJoy8lQxmjPiapH9gxeEJomcaVJopjTJJZkwwRTUEmxGYtcfGc1JpuQ5j7mYkJjmlMx4PiUjqtmDPcJEJGMWkzFPWGcohuKIZwPyJkskjclcFoocPPu97w2GgbLjVusZGxUT8uZFq/Xu7jTPMz3odmmWdWTGhOYTkdCR7kQy7cZQMYvHOyGZTZli0CuJqCCMap7MCY1jMuPxhOU6JPmUCRLJbE4iKVXMBc2ZDklGJ4yIIh0xpUNCRUxSqRjhglCiGI3n7Vy2C83Ivx2+eknGUqU075CDpNChHy7mikV5Mjfd51PmZ3VHO2zoXHExCUlKzwBbPCc/Fjw6g2lrJmL4FxruH7xAXLVah0WWSZWzmLw1Uxi0WvDla5bIGaGKYf1IpqkUJKOKpizH5ZrSHD8r9mPBFYvNotAkcbgYDEWbtFqCpmzQapE3gv9YMMJjJnI+5kzBLEk+5do26Jj6+TzD+i9EzCNAHgIApUSO61UBqVD1MGMRdGmqVlBNpCCzKY+miMMZNeufJTQy01JMZyzK+Tmrd3wRkjl0/IwJ6SCYSsX/JEVOE1y+c6ZyHtGkuswAIFTVOVU5oD+TXOSu1I5AfrDLCauNi2jpEECLAbkpF/hFM3JOk4JpC9UsJFOA6jXLFNO4NWy/gHgRkynjk+na8Wj8vtB5rWNSaACzCoUdy60qopch2sY00YzwcQ2XKT1jldGIxD1Pkw75ek5iNqZFkoeEA4XmqmAd8lLmhGZZwiM6ShjSAGw2mheKtXGVLfl06uRzgByAaUJJzMdjpmAzw0fswrZx0AFdliwDd1o+pYJI0VjoSCZSLZMQFtfxSCIpcibyDtk/pzxB4M1kNeEiSoqYkVFCo7OQjJKChUSx2Gz0OQM2F1qmBVUI1RbniB+iWQJUKAXAL6QdnmuiLVRxhxzBRvH7Dz46VOMgXFexanf5WMLIgAK3JQlLKU9CRFxI3ssRyXmesBA2eEbFPAT+ykKSs4t8JC9CEk1ZdIZ/KRpzSUZFnkthJhYrmcVyJiwux1Lkmv9pxY50X26O0X5I9kLyICSPQtLbDUmvH5LeXkh6D0LSexSS/m5I+v2Q9PdC0n9gwOo/srimHsFVAHp9g+X814XdKY/ZCTQ8gbmdUJ0zxfUZsGvyFs4cJgC4ODTskl3kwPyQG/GJYHF5AnJNpjyOmSBjJVOiWMQzjtzEcAPfdQjwEAWTEpqMiySZk3OueQUHvlM5E4A3HJEr8ipj4pBPBKFRJAtYY8SwQSqis1xykcwB1CNGU40zfy5ypjLFNQNWLbTHgMhL2jIHIJRVGcB1VlLUOdD61Vy3OpWVgRP0O66R58LRp/1pOqudpr0OabU8n4Oy09PTobgcCkKGAbC9YTAgw8BXGQah+QanGXzr2d8X8ONe/6H9OYefD/qP7M8ZVu3t2Z9T+Nl3Te3mGgYDHBcrcJGbkS1/JRUIoNJiKBYW2KHo4yxymmYbZgCff17oiQffnVJQCMdL6D7ADlyGZ82MTY2l2d6D2XLBc04TvX7CrsZnNOcGSKunXVZamvkezBx52fpp4+fPaM5VeOALnqHmE565lU/uNEAo+htQ1OxzHQ+GVigdLWHyfseKMOsRaabw2eCxAs6nQmOjy5tj8QFgEY7TIzhO16PSn7ifET6bMH0qpK7q9+aYfdhBIRilk/V4tRU+I6zWIfpUOF3u9eYYfQQYBTFvPTrh62eEywo48MHKzObb7l67d7/d3+3v1fAJ1glTIU3bcdyez+cftxYpFycGDmhUqZ/Si9UfwGgCoqNfCf8FJBguJr5Z/evyqpt6jYUEgdNiAmROp34aoRdMVCg7L9sWUPUva1mFB/92+vj3oIWPnILKYis1l+qIN/9UVehcxnR+R5uuXFOveUH9pmxswMRPAAeawqKp5JEFHuo4fWsE1p4O4KCNi9qN425lUaEwjttp2m4Uws820kClME07cdxp1FwiFFOYkjgOyXLxyvI4Jmmarik25bXibpouz6KTphY2iz1He0vrnHLB0wI0JLCqGQUdKoKSYdGb2rXkgrRaP/zwww/t779vP3vWark1tENYKq4YMswI9OITjVAl+lZrQF6MSbUIjQnGjINcwCuG1qRqKkzlTDh9CLVGReIC7ImuqjEmpXSOnTGeT5mqjyNVSbKgPYKyNZL5tEPeoHIJfzslzCtLqEh9CYzTasbreaet8Euxz5JL1gfeyFrXs6Yab10SixxjylbLTYpNioQqdgHWP82lWOKJtzkDb3a+Ndiio+XS0oJ2RWvZZc7QQe6+sjr4jjcvNuYCve2TqNA5miQm7IJkNM+ZEtjZOU14THF/tLGAXdA0A9NK9z+Gw/g3/9xFwy7YTnNjUYj5hIM9vvsfx/vtf3+3okaRZUxFVDOSMBhJh4TlUYccT1mSlS6B2WzWmd3T0VTKxPgD3mvFxub/T+To/QmCm3WoznZWzdQQQ8WQCsTStKPi5qxgjGriWq4wpeLS4K7p7aIEZy0VG0Q4W+MzkjsaIMFHY5WGz8dw9KNwC8TLyr8l8Jxh8K487tF4yuIr2r67xvaE3ZDQEUuWP918ayV0Lgu7o52zoD5VS9EVvFlRyNuDcTq7YeUjvWh8NN8WK/apQUh1m7rT3m1PtwIk4dofJDV0VltblwE6fgRj6EsaMeIagJvOcYGP3QUesOttA2cfxbW7YgioR7Cid9e40a4YobYwSye5lRWc32nse3Uocwd5FV/QEryfpZiwYQQrK6wfAZw86wcYih5aIZ31coN+Ymt8RryiAdLmbXwbLlI7mW9zpN5qA7ppVTfgiuMVqpqD1W8+vX73dcgrY1J3jcDcHkUsA0nro7emB/naJxRajasW9PWUV631GVHfCrB+Zgq09T716XMrIq3O/ldEqDWwr02sxuif0skG+w1+/ozIswrPahOHrbFkrOqhpd+cKBss1Ph984R7u7UJ369P+MHuLTSu2rAfr3DtbsDP0lCgWxcJXToOYhbxlCYYQYJw9z9ij95G+bKAwR54KtOsyKubDs06yFiclODiIoxn9zchaYekFZJuSO6GZKdDXjOMpIh81IUVGrgysRVckFgW4CaNCpXMyUjBxEPCOpMOubz8saAi5/l8sSAtcnkJsVuLRQd24ZmQMxN4cQwu45xA4FSpVMUy0isCrWSku6B9dV+yWduFinUtaDvkrmywhI2qqEXBL6uRGagqRAKjvPQim9FKMdKH6yyhc0LH4KY20SDYzAQNdQDFA9Inv31Cev3O7m5Ids3f5K6bYH8H9zD6mCKWbHJS4uerdvBudQeXP1exrPu719rC1WFvuYOhixOMIcBxrxTYys39GZpOysk0jbUVqR5wZs5PPZVFEsPpqVheKMF8/J6X6VutA8XGPEkq4XvEFbk9DeFQLGGpDRmzgXugzmCoAhe5hH3jYjlarREbSwhTgPhBNAzSMsDPjG2O7loISAQRnlKRKdXGzoKYBoghQDKfsrQRMOHAK4MmuHCwAyn3Pp1FsP9lnbgf3K8R9/36+bSWuNdR8AZDITTRmRTa+wNZ+alCddinK19WLZqU5DqF5cZ4mTLsB5kYEk7Cz1iV13ChnZRmoWyGwT2dSqnLGjYSzfJdPahHuEkFQW47HR8a8rFur97DezUh4tEv6Paqr9LuXrd3v7vR79VwkdxcWSTkOkuKVvVrLSnWLNd06xT6GKfQx++Ie5/SMNt72K/pE/c2Hc6fiWG2uqOuMMl+CsPrrXTbVRbQ6j68pu3zF7NBfjxZ7v0c1pgG437Y+xtYYz6WRJeMLp+MKMmnsrisosxrmFw22lk+mnKrwP7s1Hv/05hnGrrOlzVp8Mt+lVrv3/84am0aZyokNwz4H79+9Xq2+4dvJnJ/f3//5eGb6fM3k/39/RR+dzqdlSa7VWSAw4D8bO8B2SMexYU1o3Q6HXTX05wOsHk3E5OvTPtwfZvOUARhIDO4qcWleBEHgwBFf+Y0gSBExDCdfy3jeTC4DGykP/xpI6+hafe9huthl4GOpiyl8JdDKFwogwtdQRiYQAQdhAGGu8HtMljrYBDI0XsWwWiZAnByzjT0ge0Gl66WuREVhFZ8CwaBmWIQBtaJ7Iv8XbIsHgeLEHs6yajWM6nijV36krJL6MBAfMOGGv/wehX0A7eQbtnNS2i6aNzIu1VPzyo94NxSdiTBCJWwnD2jc13p16izQfMiILQBNhLZViSmcw3sqNDmTI1oEhUJyKjsIuNq7qOoUFCtEJiH14/k4e3dX5RUU4JElaLzIAx4ztJq+RoqUvLmKxcxCZjBsOGbtn0v2Yix39kCMIfhwtP0xlC8l4yMGC56NpXixu17/Xu9fu9erw892JDIm/bhTHvQxXs5OrnVRojZeeCX8uT6C1KnufpVJOjFn1zu5ouPwLMBUZmSEdO6Q/bhTgiLrfg3KEOtwFzuDXE7AxPTN6XnjADTZRQMHKJymaJ+6+ycsxn0MCCvWcT4uYWtekcVqmCYylfGcYx9C9m4HEcziBVyXUEbc4PGlte7/QraNyHy1zcNW2eiSIH3mjkGYWBADcLADQX8t8IaTL1FGFjAbr/hzNfl9a2vZn1FSLucUGgucnSuYmauPu4POmFXc62jdZdKK3fZrKmOZhmjqoN3O299zbjOCL2A17mC7S3C4OLqyVyQSLbdjVVyN2Hj3ERCkUgqwdRONbL1s5lcf29vEQbzq6c3/1VO7yEs3uzq2b3Fq77lNei/Baz3Hi3CYHo1rN/6y8h/Q2D3HixKMawhpp6MZDw/cXxrcVVFJ1FAvbFMYqZerJQJ6xIgXLo/aQoEIykTRsUKRlO7u2ifRwD9C/xR1oo3mzL08Hm1DHsvdT7rvTLQ2kDiWnAm16AuqYINgw7ECZcaJJ6LzeuTri4eLEKSOzjeiS6Qjd/p2t+AozvVBwLAxVCGtDsQsDLJWZoleGN+Bn6KETo04g7x/5nDyGESAHBylRv46qPiqQkmxQFto/p1c2K1lA55SoW/cly/DEouLz0ZIHUsFuTyElaVqROQzhaLsCyAsWoFKICZEmWO+morX8TKhr6s0tTIwhhgbQqsVFYFwAZhF8r2AyrDYtGpEWQDcPTUWByw2NMZXNtdnrUXbHGlr439JWRbCoBO/mHw/jh78i1fAcrjbvbkcfbkLTwukTGz9wx6xlzEZufPWJJ0yGOdKykmTxooeNy15auXUqFIiBsXV7XspYlb31HHwvQDMOpy8bgmkSoiThOMogb52DkE0XsJRhyds0yDm5znRpJGoRsVNzpRDN2PRjotcnxMA40AbsDHlEwVG//2TgOnd57gPXIIH3jcpU9s7RfGLGUkbjEnOHG0oUllDLTjQiGbjBKq+NhaHEKSgXDO8OkBGhkHv8Gog+NoSsWZDh+P1BO4ke5vsv/0l79CDcfTX4hXKmbqGkwdbmIYg9od4GN3QhN9juTOlc7dTQvkhJZCvDayauvYi7sQhvDcs35djDTUEq6/krXmik8mDBy4tgY2tm8kMBpNzaGBUJXRCBkQjyy0Aw8IzKntsQ0R8bdCqla/CnYqt07M3DsruDqekFycSGhxYu7BXAOt+OZBA7FmMgZerskokdEZkAJIfGDw1OVrJ07VKkTOE7y6nwHuY3fZBRCI1NWcM8Xo3A55LsZSRUwTA3EFtyVa0OyKBi846QDgOxXs3EE7bKI9csgzg0Nc0DtoOK1jDIsWYYCCwYkcjxMuGAomt6JDN0+IG9bFCC5GUPO2kBMEPJrsGxL2gQhB2AVczUBuIBM8Vc0DEIbjXH8m5tGKV0cH15gA2qPbBjD7kASSuOmDvDo6gEd5/F6HG0d+G7h9RWtVCFj7yDmn7uEOr9bNjdbNjBvWHopVwunY53DaZBmgmOuVEIVGogMU+ievljouX3mC/SmLHKInuH3BAlnsBkQeyeI6LOkKTFIyKfBiYg6824lMeEGmfFSHC52rwoSqu1tiK20oDk8OK1Cp0n9ImNCmOSVjjKIJSSE4YF4V4KLwXbKLjCkO0WorUaCYQR2cG1fLJ3Wz0JvX39m3vSp33xwDdR3DBsiQapAlLPGS5tRXKgP27L4aQBDcMQbPWqsyprQUcL5JNaHCHp/GGAHOlBGb0sRUtecEePCRnwG9rjTP/fSXv1bgWmu3XAbMjEDjGOKproAQ/VKG4IHTKJbB8SfrEEF/TP2uqf8FntulMvYbSV+fxg/wwpf2vM5GI/loKF1EU5BZ/GGrQ/8yhrUoaXRB+Rd1ZAbzZRdc55XXYpwJcZk/vLZ3O0sYzHkUx4aXzqsbvIzSko3uUDfk9XejvAa8fEIUuTxRLOXiekJK1eWXS88IilymNOcRcV3pTv01MBOJ4vZ1WsYmAjWec6l21mxV6O5EiojB0c/OmbqGbacSRglugxHLZ4yJKmwOSdIfvOaNHzx7azhpXIitQQn+g5SpCTuJwDyJVMeugcRWC7pqtUjbAGJ5qi6Udc7al/SQeQAfKXsHcKwi5O+Dl5JH9QHDDvlWzgBhXpYFjcP0D/gkCLl9Bqo6QkQFXsYFgRfU9NxJRuZyEUb62iFMmB4uFs7GStuR8dpCL/DyG4wTbpqT45/+ojuF19vc6E6mgMmBo43QROJ+sjpF49kqBOoFPtw1xfMH1w+czGYc95oeyiE//fl/NAh0NrhZezvHyq9oqkBBDG8lV3t15OwIvlM3TDh6FjLn4/mJFCclH1lJMPWWGwloRWRlXZQRlgvj4E6iAUoH6gBEm1MM/qk7ApbWd/1ggJBPNCA4IsFLMaEqTvypYZYxxzcraZWQzFDrqAH1yDVkR/OcRlOGb33FLINXL6WVvM0RVzFTwXqCH4CJE4xBuI7/wh6Li8pqHgcQqoB+7zgITUxI8G4RBqMoum2PcGLW3IEhFvVrZUtPrY6iiNwdJRzQQ9VImrdIdwZWGKYx7EMUdBpycW1RDfKRndQkHF7RATtopQMX4S88RZjhzz03SxYmFnmV76oOknti093cd0KB0Sfwqdh0BHefMK4aVWSUHp2ddskZ9rN50za5xmxM8NYx9ivyHPV2d/+eHWP3dn89jrG93V+RY+wRAGtD2q7mJus01pW8w4WnbW7wXjITX5JItbkmnKnoczOBlasQXG6H/sL8V/ryHBO/wr9nHIBl/Jm1TrrJIBr6u7vwT305n9UEJzBXFGhqxPdS/ykIrx/8tnkNTPFqn+Mmrj59z/t/uojO+wcumKZuH7nhwXKr4CZo0wxtWmOl2TgVuyEKlcBz6TCXtpcxsdvKGnOB1lG3gCexjE7c7Beo4WldP+WuBYNfbjSa19f6iuEDQ5h7q6joUKbMKDYz6HcGzhiv4eVqTugEVDTY4+oTEhVT6qrtdzPINqFgb3f3pOeRcH8ZCS8EvoqCuQGO5BkTv+xMq8PnZngA9SJNSh4YcFMJvwe1yVbLzSQ1iwrF83kwOL4MLto0423zfXD8bvEOSDCfSoifzaRGiGk+DQZBdymcVjN1jtGMx5dm3/itoKmI4drA0vlAM94973UgiK/ZZuV5sqE+K9o3baJzOuFiclW7dyWODmEdzVLVMFXyqYz/gQGjsgtRrRUGHOhnyiiYuwD1QB6vyyDk526RXXjwqojfpYDfICjXtxmV64Jya3G2zaN+ReTs6sDZ3v1KyOqxiz7FgFIfT7oqRNRjwwV9+pjPShhnJYqzDMysxWViqGUj0rKMAfTKyHG5e3wUndMVeihk9/f2UBp92EOx7d4jlIj2HiyQ3suwmSCoh8Zg8HwzwOPj4hXq4QpbH/zfkQ++4YI3xLPaj2ztbKs8pvZTxQVZKzG+NFtU9y056vW+nJpDpelPWevbWOPacCDXTfgekFWW8/srDda2yWrjpP1YtXyttmJZI9b1rTU3q12xsazgM06tqHMZuL4DXObeLnKZvV3kMo92axqNXZmyh1IvQeXD6x52uqV+AUrEOzhEuBhLPIEsl/RZDUBCwBOsyfC/qNKqrwbmzyek1TrCy7VMtLUsVGSSIZksCQm60zERzU9//m8yKnhigtVids4SkGMgtZAqtH1Bh/kUCbpjMgxUx51gSDkmQvE2LfTdxsZh28aMQ4S1S+YC4Xgg9pJ8qmQxmaI5V0zghcXXzw+PxkWCOYPIIZhTy9RMtXg6yDokwBzkw/sAZsh34jyjOqd5gb4yxYCNcciTYdkReJqYYVUQR6EqprmEj1k0jxKDHJNiyPjGz5mIpSIQ6NHmJiFDu92Gf774gnxjDMvkEN7kZTGUPof94uNp0McfUaXmZlwv+DkXzGlFyDglRrzAQfAuVuXjgDyGHsqCJ/6NnVbrp//8L3L8rZzVUlzVB7z+yyiHZlK6u3/wAmXkHbP+L/FBVcWcGxuiQSdc/CsYR3EurZaVFQkT51xJAaiFWwyn15YlT3fsyZNLm6nHRiiMx/BonZiQBCgYbpQ1luIpmD2f0oyOeMJBJIfyD+QpzdlEqjn5QN6CA8tnupLkw1B8aLfb+D+o2mr5BGOtFvlg84mZcKOQFJnJrKLYuTyzNBUzvGJUZhdyy16Sr+35yNEr9vx1wZOYKFZYv2YlVjWfgt+ojS+7+BQfX/nMWnDlQyrYBXPv7LVDHLJk3Ib9iUN846hAQ3HDt6FLvPpgJnHOc2O+HkNaLtvpQTFKeETq4B9O0Z1FMvPRbb2EizPcPsIZnfFmaZm+y2FZ0XFO3kp1BiOZHuGEL6FDZ7jDCdUkhhbm3smYC5pwbZ3BqBK6fp+a097A+L3hE3Mn4KAV0kgDIynPgMQmiqboe4ZgNdfJ71GANH28whgDXYXMPobg2fQzBeRopE6/Em/ZaCrlmenE3r9BdtTG22nsHBNLVTwGmhjKxBgnwkRssnrZ7tD3YPvKFWcgDJmcN8ZHBZIDXDAyNgVYwQ/1rQGEjx7Jl2wGfMcdGF/AtgG3IVN+hd0YNBmK02+eH5GuW4nugMenOGK9HNb41MhoI3CW61wxmoIUFCM1KBYXIoYw8kbotmKpPAefrYgh05p9UQaz7+HzzbPyTRrn0U3mxoZsV7TssNXyCem8PQ2T55ngqkgKXaTmATaY9YFVwNoHSuYm7gacxDZT3VDAd3I6rGtrw+DUcW23z0HyN67/mVRn3DmXmYjUPLO9QkCDf35GisFQnB68OjwiVgd3aDwl//e/5PTgzRLGsbjSwBFjd+DqndSr4W5xtZY+NMbDD8AjAKWnDj+vjBhLDu3Whq2lZDIUEJpxOlwh7Lr7yeSDcWOfgqtmzUSRhlbMFMJCLsD+wiE4zUaIgIRi4z/seJ7h4CvNEJDpuvHre2jo47VM4BwAoejUcstTYqw3SF/mijqEDJwOq6oprPSYM3BMREpqjQIBzgJ2l5JFzjAURDFz3c9eRXCrPDBHD4wOzN7EqRRq6cCxMJ2Slr/nh6wLZQZ3f3XjbT/DIk7NFbrTkts0bvuNpYubNHErlkn7x5vsjTfTmbuGB91B9LzXvlx1dgFYs0dHGT7MldH9PnjWYjyoTyHc8+7TpzsAnM0DNhT7mIHzdBhEUYltu+3L15owYMM/P+Mjok6HoDGU7WQZWRJ6YgjNsWH0YncI+lXsmvPcL+bzargZ03hymUAZD2Pp7TW+4TYGst7Cq/0dXJn3c4BobVKDhtx1MWNml5Q7nsenO5UISQ8arJfC3IXmwQPLy9FNE+KBY7gUYDbhNk4GwM3yOUHzPLl7evzudOcrIiFI14SOA2pzSbiYMsXzFV03RLAyyd7zUv6zclilBPYEaOcQEbksgx0aERHPuxvIjV5g8SpIvYeNZkLf+vkbCB9ZanyVefK0eeL+kSl4mQzW6F/I1zQ6m1EVa3xPkeYcJdQ5VIXGQBwm893IVWxHtmJiJGBy3jMZQXudnldQnJigXYwVRE6dm4FtwFElA54xO40c3rFXIclIMXNqRlMqJrARQEaoHNQcGH9cRGYvILzQtc94VwgTaQNWmBm3sWJxgzDeaAbq3XdcnCE5tMmxl6DespHmOau/ht/E9A62+X2RJD69L264K5Qa0+wbnn9bjCCnqdQ8l2petprwfFqMcC2rbf0P24GTpb3X4GOUKezyiKkU45MOmTrn0RXT70LKVt3dwdCwhu26bh3AkDPgO/VsxzTjVu08dnCQeg6Cm8/D+FZRpK547cCIvjLGFqfwamznaw35m+cbhEHCI2Ydvdbasv/NwXfk/F5nNwgrHoFrrGX3uxdPn788fA7A2G0CNuzObmcX41GkzlMqKiM18kk3LTGVN0e26ae36ae36ae36ae36ae36adviNFt+ult+ult+ulPnt1gm356m356m3566T35bfrpbfrpbfrpbfrpbfrpbfrpbfrpf5RMA9v009v00+vY5zb99Db99Db99Ged5WSbfnqbfnqbfnqbfnqbfnqbfnqbfnrz6XMrIt2mn755fqNt+ult+ult+ult+ult+ult+ult+ult+ult+ult+ult+ulfkVNom356m356m356m356m356m376kxpn/k7ST1eeB+pmCeWi8qKkeUXvuJmU+l0YTOGZvcFxcHkJw7yBp62g+McCH1E6fhcG51RxCMvGF/pC96AcPEh0xuAVsafmzkD7CMYPzabHa3WNhwnhRTzTYh8pfWPd6kuAcCcf3l6yOdZSGeMTqHQGDxjRmXl7qvLKEZZdBgkVkwJfSApMnwuTBGJaf0DvDB/Qs39UnlmCt+FKCOsv65lpwP/DpFY2uLw0j/Phq2umvvm0toVFrKsN6/dusVj8P8ifuxQ=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Draft Document","permalink":"/docs/API-docs/v1.2/draftdocument"},"next":{"title":"Create Document from Template","permalink":"/docs/API-docs/v1.2/createdocumentwithtemplateid"}}');var s=t(74848),r=t(28453),o=t(57742),l=t.n(o),a=t(78178),d=t.n(a),c=t(19624),p=t.n(c),m=t(96226),h=t.n(m),u=(t(77675),t(19365),t(51107)),x=t(21312);const g={id:"createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file.",sidebar_label:"Create Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztPdlyGzmSv4Kt3lhbnCIp0vLRbI931Lan2zvdtsKSx9EreiWwCiRhVQHVQJUojsyIeZjYD9jYl32dn9j3/ZT+ko1MHHXw0GF3j3uGHTFjEYUjkUgk8gLyMsjpRAeD4+CZjIqUiVwH78IgZjpSPMu5FMEgOJoy8lQxmjPiapH9gxeEJomcaVJopjTJJZkwwRTUEmxGYtcfGc1JpuQ5j7mYkJjmlMx4PiUjqtmDPcJEJGMWkzFPWGcohuKIZwPyJkskjclcFoocPPu97w2GgbLjVusZGxUT8uZFq/Xu7jTPMz3odmmWdWTGhOYTkdCR7kQy7cZQMYvHOyGZTZli0CuJqCCMap7MCY1jMuPxhOU6JPmUCRLJbE4iKVXMBc2ZDklGJ4yIIh0xpUNCRUxSqRjhglCiGI3n7Vy2C83Ivx2+eknGUqU075CDpNChHy7mikV5Mjfd51PmZ3VHO2zoXHExCUlKzwBbPCc/Fjw6g2lrJmL4FxruH7xAXLVah0WWSZWzmLw1Uxi0WvDla5bIGaGKYf1IpqkUJKOKpizH5ZrSHD8r9mPBFYvNotAkcbgYDEWbtFqCpmzQapE3gv9YMMJjJnI+5kzBLEk+5do26Jj6+TzD+i9EzCNAHgIApUSO61UBqVD1MGMRdGmqVlBNpCCzKY+miMMZNeufJTQy01JMZyzK+Tmrd3wRkjl0/IwJ6SCYSsX/JEVOE1y+c6ZyHtGkuswAIFTVOVU5oD+TXOSu1I5AfrDLCauNi2jpEECLAbkpF/hFM3JOk4JpC9UsJFOA6jXLFNO4NWy/gHgRkynjk+na8Wj8vtB5rWNSaACzCoUdy60qopch2sY00YzwcQ2XKT1jldGIxD1Pkw75ek5iNqZFkoeEA4XmqmAd8lLmhGZZwiM6ShjSAGw2mheKtXGVLfl06uRzgByAaUJJzMdjpmAzw0fswrZx0AFdliwDd1o+pYJI0VjoSCZSLZMQFtfxSCIpcibyDtk/pzxB4M1kNeEiSoqYkVFCo7OQjJKChUSx2Gz0OQM2F1qmBVUI1RbniB+iWQJUKAXAL6QdnmuiLVRxhxzBRvH7Dz46VOMgXFexanf5WMLIgAK3JQlLKU9CRFxI3ssRyXmesBA2eEbFPAT+ykKSs4t8JC9CEk1ZdIZ/KRpzSUZFnkthJhYrmcVyJiwux1Lkmv9pxY50X26O0X5I9kLyICSPQtLbDUmvH5LeXkh6D0LSexSS/m5I+v2Q9PdC0n9gwOo/srimHsFVAHp9g+X814XdKY/ZCTQ8gbmdUJ0zxfUZsGvyFs4cJgC4ODTskl3kwPyQG/GJYHF5AnJNpjyOmSBjJVOiWMQzjtzEcAPfdQjwEAWTEpqMiySZk3OueQUHvlM5E4A3HJEr8ipj4pBPBKFRJAtYY8SwQSqis1xykcwB1CNGU40zfy5ypjLFNQNWLbTHgMhL2jIHIJRVGcB1VlLUOdD61Vy3OpWVgRP0O66R58LRp/1pOqudpr0OabU8n4Oy09PTobgcCkKGAbC9YTAgw8BXGQah+QanGXzr2d8X8ONe/6H9OYefD/qP7M8ZVu3t2Z9T+Nl3Te3mGgYDHBcrcJGbkS1/JRUIoNJiKBYW2KHo4yxymmYbZgCff17oiQffnVJQCMdL6D7ADlyGZ82MTY2l2d6D2XLBc04TvX7CrsZnNOcGSKunXVZamvkezBx52fpp4+fPaM5VeOALnqHmE565lU/uNEAo+htQ1OxzHQ+GVigdLWHyfseKMOsRaabw2eCxAs6nQmOjy5tj8QFgEY7TIzhO16PSn7ifET6bMH0qpK7q9+aYfdhBIRilk/V4tRU+I6zWIfpUOF3u9eYYfQQYBTFvPTrh62eEywo48MHKzObb7l67d7/d3+3v1fAJ1glTIU3bcdyez+cftxYpFycGDmhUqZ/Si9UfwGgCoqNfCf8FJBguJr5Z/evyqpt6jYUEgdNiAmROp34aoRdMVCg7L9sWUPUva1mFB/92+vj3oIWPnILKYis1l+qIN/9UVehcxnR+R5uuXFOveUH9pmxswMRPAAeawqKp5JEFHuo4fWsE1p4O4KCNi9qN425lUaEwjttp2m4Uws820kClME07cdxp1FwiFFOYkjgOyXLxyvI4Jmmarik25bXibpouz6KTphY2iz1He0vrnHLB0wI0JLCqGQUdKoKSYdGb2rXkgrRaP/zwww/t779vP3vWark1tENYKq4YMswI9OITjVAl+lZrQF6MSbUIjQnGjINcwCuG1qRqKkzlTDh9CLVGReIC7ImuqjEmpXSOnTGeT5mqjyNVSbKgPYKyNZL5tEPeoHIJfzslzCtLqEh9CYzTasbreaet8Euxz5JL1gfeyFrXs6Yab10SixxjylbLTYpNioQqdgHWP82lWOKJtzkDb3a+Ndiio+XS0oJ2RWvZZc7QQe6+sjr4jjcvNuYCve2TqNA5miQm7IJkNM+ZEtjZOU14THF/tLGAXdA0A9NK9z+Gw/g3/9xFwy7YTnNjUYj5hIM9vvsfx/vtf3+3okaRZUxFVDOSMBhJh4TlUYccT1mSlS6B2WzWmd3T0VTKxPgD3mvFxub/T+To/QmCm3WoznZWzdQQQ8WQCsTStKPi5qxgjGriWq4wpeLS4K7p7aIEZy0VG0Q4W+MzkjsaIMFHY5WGz8dw9KNwC8TLyr8l8Jxh8K487tF4yuIr2r67xvaE3ZDQEUuWP918ayV0Lgu7o52zoD5VS9EVvFlRyNuDcTq7YeUjvWh8NN8WK/apQUh1m7rT3m1PtwIk4dofJDV0VltblwE6fgRj6EsaMeIagJvOcYGP3QUesOttA2cfxbW7YgioR7Cid9e40a4YobYwSye5lRWc32nse3Uocwd5FV/QEryfpZiwYQQrK6wfAZw86wcYih5aIZ31coN+Ymt8RryiAdLmbXwbLlI7mW9zpN5qA7ppVTfgiuMVqpqD1W8+vX73dcgrY1J3jcDcHkUsA0nro7emB/naJxRajasW9PWUV631GVHfCrB+Zgq09T716XMrIq3O/ldEqDWwr02sxuif0skG+w1+/ozIswrPahOHrbFkrOqhpd+cKBss1Ph984R7u7UJ369P+MHuLTSu2rAfr3DtbsDP0lCgWxcJXToOYhbxlCYYQYJw9z9ij95G+bKAwR54KtOsyKubDs06yFiclODiIoxn9zchaYekFZJuSO6GZKdDXjOMpIh81IUVGrgysRVckFgW4CaNCpXMyUjBxEPCOpMOubz8saAi5/l8sSAtcnkJsVuLRQd24ZmQMxN4cQwu45xA4FSpVMUy0isCrWSku6B9dV+yWduFinUtaDvkrmywhI2qqEXBL6uRGagqRAKjvPQim9FKMdKH6yyhc0LH4KY20SDYzAQNdQDFA9Inv31Cev3O7m5Ids3f5K6bYH8H9zD6mCKWbHJS4uerdvBudQeXP1exrPu719rC1WFvuYOhixOMIcBxrxTYys39GZpOysk0jbUVqR5wZs5PPZVFEsPpqVheKMF8/J6X6VutA8XGPEkq4XvEFbk9DeFQLGGpDRmzgXugzmCoAhe5hH3jYjlarREbSwhTgPhBNAzSMsDPjG2O7loISAQRnlKRKdXGzoKYBoghQDKfsrQRMOHAK4MmuHCwAyn3Pp1FsP9lnbgf3K8R9/36+bSWuNdR8AZDITTRmRTa+wNZ+alCddinK19WLZqU5DqF5cZ4mTLsB5kYEk7Cz1iV13ChnZRmoWyGwT2dSqnLGjYSzfJdPahHuEkFQW47HR8a8rFur97DezUh4tEv6Paqr9LuXrd3v7vR79VwkdxcWSTkOkuKVvVrLSnWLNd06xT6GKfQx++Ie5/SMNt72K/pE/c2Hc6fiWG2uqOuMMl+CsPrrXTbVRbQ6j68pu3zF7NBfjxZ7v0c1pgG437Y+xtYYz6WRJeMLp+MKMmnsrisosxrmFw22lk+mnKrwP7s1Hv/05hnGrrOlzVp8Mt+lVrv3/84am0aZyokNwz4H79+9Xq2+4dvJnJ/f3//5eGb6fM3k/39/RR+dzqdlSa7VWSAw4D8bO8B2SMexYU1o3Q6HXTX05wOsHk3E5OvTPtwfZvOUARhIDO4qcWleBEHgwBFf+Y0gSBExDCdfy3jeTC4DGykP/xpI6+hafe9huthl4GOpiyl8JdDKFwogwtdQRiYQAQdhAGGu8HtMljrYBDI0XsWwWiZAnByzjT0ge0Gl66WuREVhFZ8CwaBmWIQBtaJ7Iv8XbIsHgeLEHs6yajWM6nijV36krJL6MBAfMOGGv/wehX0A7eQbtnNS2i6aNzIu1VPzyo94NxSdiTBCJWwnD2jc13p16izQfMiILQBNhLZViSmcw3sqNDmTI1oEhUJyKjsIuNq7qOoUFCtEJiH14/k4e3dX5RUU4JElaLzIAx4ztJq+RoqUvLmKxcxCZjBsOGbtn0v2Yix39kCMIfhwtP0xlC8l4yMGC56NpXixu17/Xu9fu9erw892JDIm/bhTHvQxXs5OrnVRojZeeCX8uT6C1KnufpVJOjFn1zu5ouPwLMBUZmSEdO6Q/bhTgiLrfg3KEOtwFzuDXE7AxPTN6XnjADTZRQMHKJymaJ+6+ycsxn0MCCvWcT4uYWtekcVqmCYylfGcYx9C9m4HEcziBVyXUEbc4PGlte7/QraNyHy1zcNW2eiSIH3mjkGYWBADcLADQX8t8IaTL1FGFjAbr/hzNfl9a2vZn1FSLucUGgucnSuYmauPu4POmFXc62jdZdKK3fZrKmOZhmjqoN3O299zbjOCL2A17mC7S3C4OLqyVyQSLbdjVVyN2Hj3ERCkUgqwdRONbL1s5lcf29vEQbzq6c3/1VO7yEs3uzq2b3Fq77lNei/Baz3Hi3CYHo1rN/6y8h/Q2D3HixKMawhpp6MZDw/cXxrcVVFJ1FAvbFMYqZerJQJ6xIgXLo/aQoEIykTRsUKRlO7u2ifRwD9C/xR1oo3mzL08Hm1DHsvdT7rvTLQ2kDiWnAm16AuqYINgw7ECZcaJJ6LzeuTri4eLEKSOzjeiS6Qjd/p2t+AozvVBwLAxVCGtDsQsDLJWZoleGN+Bn6KETo04g7x/5nDyGESAHBylRv46qPiqQkmxQFto/p1c2K1lA55SoW/cly/DEouLz0ZIHUsFuTyElaVqROQzhaLsCyAsWoFKICZEmWO+morX8TKhr6s0tTIwhhgbQqsVFYFwAZhF8r2AyrDYtGpEWQDcPTUWByw2NMZXNtdnrUXbHGlr439JWRbCoBO/mHw/jh78i1fAcrjbvbkcfbkLTwukTGz9wx6xlzEZufPWJJ0yGOdKykmTxooeNy15auXUqFIiBsXV7XspYlb31HHwvQDMOpy8bgmkSoiThOMogb52DkE0XsJRhyds0yDm5znRpJGoRsVNzpRDN2PRjotcnxMA40AbsDHlEwVG//2TgOnd57gPXIIH3jcpU9s7RfGLGUkbjEnOHG0oUllDLTjQiGbjBKq+NhaHEKSgXDO8OkBGhkHv8Gog+NoSsWZDh+P1BO4ke5vsv/0l79CDcfTX4hXKmbqGkwdbmIYg9od4GN3QhN9juTOlc7dTQvkhJZCvDayauvYi7sQhvDcs35djDTUEq6/krXmik8mDBy4tgY2tm8kMBpNzaGBUJXRCBkQjyy0Aw8IzKntsQ0R8bdCqla/CnYqt07M3DsruDqekFycSGhxYu7BXAOt+OZBA7FmMgZerskokdEZkAJIfGDw1OVrJ07VKkTOE7y6nwHuY3fZBRCI1NWcM8Xo3A55LsZSRUwTA3EFtyVa0OyKBi846QDgOxXs3EE7bKI9csgzg0Nc0DtoOK1jDIsWYYCCwYkcjxMuGAomt6JDN0+IG9bFCC5GUPO2kBMEPJrsGxL2gQhB2AVczUBuIBM8Vc0DEIbjXH8m5tGKV0cH15gA2qPbBjD7kASSuOmDvDo6gEd5/F6HG0d+G7h9RWtVCFj7yDmn7uEOr9bNjdbNjBvWHopVwunY53DaZBmgmOuVEIVGogMU+ievljouX3mC/SmLHKInuH3BAlnsBkQeyeI6LOkKTFIyKfBiYg6824lMeEGmfFSHC52rwoSqu1tiK20oDk8OK1Cp0n9ImNCmOSVjjKIJSSE4YF4V4KLwXbKLjCkO0WorUaCYQR2cG1fLJ3Wz0JvX39m3vSp33xwDdR3DBsiQapAlLPGS5tRXKgP27L4aQBDcMQbPWqsyprQUcL5JNaHCHp/GGAHOlBGb0sRUtecEePCRnwG9rjTP/fSXv1bgWmu3XAbMjEDjGOKproAQ/VKG4IHTKJbB8SfrEEF/TP2uqf8FntulMvYbSV+fxg/wwpf2vM5GI/loKF1EU5BZ/GGrQ/8yhrUoaXRB+Rd1ZAbzZRdc55XXYpwJcZk/vLZ3O0sYzHkUx4aXzqsbvIzSko3uUDfk9XejvAa8fEIUuTxRLOXiekJK1eWXS88IilymNOcRcV3pTv01MBOJ4vZ1WsYmAjWec6l21mxV6O5EiojB0c/OmbqGbacSRglugxHLZ4yJKmwOSdIfvOaNHzx7azhpXIitQQn+g5SpCTuJwDyJVMeugcRWC7pqtUjbAGJ5qi6Udc7al/SQeQAfKXsHcKwi5O+Dl5JH9QHDDvlWzgBhXpYFjcP0D/gkCLl9Bqo6QkQFXsYFgRfU9NxJRuZyEUb62iFMmB4uFs7GStuR8dpCL/DyG4wTbpqT45/+ojuF19vc6E6mgMmBo43QROJ+sjpF49kqBOoFPtw1xfMH1w+czGYc95oeyiE//fl/NAh0NrhZezvHyq9oqkBBDG8lV3t15OwIvlM3TDh6FjLn4/mJFCclH1lJMPWWGwloRWRlXZQRlgvj4E6iAUoH6gBEm1MM/qk7ApbWd/1ggJBPNCA4IsFLMaEqTvypYZYxxzcraZWQzFDrqAH1yDVkR/OcRlOGb33FLINXL6WVvM0RVzFTwXqCH4CJE4xBuI7/wh6Li8pqHgcQqoB+7zgITUxI8G4RBqMoum2PcGLW3IEhFvVrZUtPrY6iiNwdJRzQQ9VImrdIdwZWGKYx7EMUdBpycW1RDfKRndQkHF7RATtopQMX4S88RZjhzz03SxYmFnmV76oOknti093cd0KB0Sfwqdh0BHefMK4aVWSUHp2ddskZ9rN50za5xmxM8NYx9ivyHPV2d/+eHWP3dn89jrG93V+RY+wRAGtD2q7mJus01pW8w4WnbW7wXjITX5JItbkmnKnoczOBlasQXG6H/sL8V/ryHBO/wr9nHIBl/Jm1TrrJIBr6u7vwT305n9UEJzBXFGhqxPdS/ykIrx/8tnkNTPFqn+Mmrj59z/t/uojO+wcumKZuH7nhwXKr4CZo0wxtWmOl2TgVuyEKlcBz6TCXtpcxsdvKGnOB1lG3gCexjE7c7Beo4WldP+WuBYNfbjSa19f6iuEDQ5h7q6joUKbMKDYz6HcGzhiv4eVqTugEVDTY4+oTEhVT6qrtdzPINqFgb3f3pOeRcH8ZCS8EvoqCuQGO5BkTv+xMq8PnZngA9SJNSh4YcFMJvwe1yVbLzSQ1iwrF83kwOL4MLto0423zfXD8bvEOSDCfSoifzaRGiGk+DQZBdymcVjN1jtGMx5dm3/itoKmI4drA0vlAM94973UgiK/ZZuV5sqE+K9o3baJzOuFiclW7dyWODmEdzVLVMFXyqYz/gQGjsgtRrRUGHOhnyiiYuwD1QB6vyyDk526RXXjwqojfpYDfICjXtxmV64Jya3G2zaN+ReTs6sDZ3v1KyOqxiz7FgFIfT7oqRNRjwwV9+pjPShhnJYqzDMysxWViqGUj0rKMAfTKyHG5e3wUndMVeihk9/f2UBp92EOx7d4jlIj2HiyQ3suwmSCoh8Zg8HwzwOPj4hXq4QpbH/zfkQ++4YI3xLPaj2ztbKs8pvZTxQVZKzG+NFtU9y056vW+nJpDpelPWevbWOPacCDXTfgekFWW8/srDda2yWrjpP1YtXyttmJZI9b1rTU3q12xsazgM06tqHMZuL4DXObeLnKZvV3kMo92axqNXZmyh1IvQeXD6x52uqV+AUrEOzhEuBhLPIEsl/RZDUBCwBOsyfC/qNKqrwbmzyek1TrCy7VMtLUsVGSSIZksCQm60zERzU9//m8yKnhigtVids4SkGMgtZAqtH1Bh/kUCbpjMgxUx51gSDkmQvE2LfTdxsZh28aMQ4S1S+YC4Xgg9pJ8qmQxmaI5V0zghcXXzw+PxkWCOYPIIZhTy9RMtXg6yDokwBzkw/sAZsh34jyjOqd5gb4yxYCNcciTYdkReJqYYVUQR6EqprmEj1k0jxKDHJNiyPjGz5mIpSIQ6NHmJiFDu92Gf774gnxjDMvkEN7kZTGUPof94uNp0McfUaXmZlwv+DkXzGlFyDglRrzAQfAuVuXjgDyGHsqCJ/6NnVbrp//8L3L8rZzVUlzVB7z+yyiHZlK6u3/wAmXkHbP+L/FBVcWcGxuiQSdc/CsYR3EurZaVFQkT51xJAaiFWwyn15YlT3fsyZNLm6nHRiiMx/BonZiQBCgYbpQ1luIpmD2f0oyOeMJBJIfyD+QpzdlEqjn5QN6CA8tnupLkw1B8aLfb+D+o2mr5BGOtFvlg84mZcKOQFJnJrKLYuTyzNBUzvGJUZhdyy16Sr+35yNEr9vx1wZOYKFZYv2YlVjWfgt+ojS+7+BQfX/nMWnDlQyrYBXPv7LVDHLJk3Ib9iUN846hAQ3HDt6FLvPpgJnHOc2O+HkNaLtvpQTFKeETq4B9O0Z1FMvPRbb2EizPcPsIZnfFmaZm+y2FZ0XFO3kp1BiOZHuGEL6FDZ7jDCdUkhhbm3smYC5pwbZ3BqBK6fp+a097A+L3hE3Mn4KAV0kgDIynPgMQmiqboe4ZgNdfJ71GANH28whgDXYXMPobg2fQzBeRopE6/Em/ZaCrlmenE3r9BdtTG22nsHBNLVTwGmhjKxBgnwkRssnrZ7tD3YPvKFWcgDJmcN8ZHBZIDXDAyNgVYwQ/1rQGEjx7Jl2wGfMcdGF/AtgG3IVN+hd0YNBmK02+eH5GuW4nugMenOGK9HNb41MhoI3CW61wxmoIUFCM1KBYXIoYw8kbotmKpPAefrYgh05p9UQaz7+HzzbPyTRrn0U3mxoZsV7TssNXyCem8PQ2T55ngqkgKXaTmATaY9YFVwNoHSuYm7gacxDZT3VDAd3I6rGtrw+DUcW23z0HyN67/mVRn3DmXmYjUPLO9QkCDf35GisFQnB68OjwiVgd3aDwl//e/5PTgzRLGsbjSwBFjd+DqndSr4W5xtZY+NMbDD8AjAKWnDj+vjBhLDu3Whq2lZDIUEJpxOlwh7Lr7yeSDcWOfgqtmzUSRhlbMFMJCLsD+wiE4zUaIgIRi4z/seJ7h4CvNEJDpuvHre2jo47VM4BwAoejUcstTYqw3SF/mijqEDJwOq6oprPSYM3BMREpqjQIBzgJ2l5JFzjAURDFz3c9eRXCrPDBHD4wOzN7EqRRq6cCxMJ2Slr/nh6wLZQZ3f3XjbT/DIk7NFbrTkts0bvuNpYubNHErlkn7x5vsjTfTmbuGB91B9LzXvlx1dgFYs0dHGT7MldH9PnjWYjyoTyHc8+7TpzsAnM0DNhT7mIHzdBhEUYltu+3L15owYMM/P+Mjok6HoDGU7WQZWRJ6YgjNsWH0YncI+lXsmvPcL+bzargZ03hymUAZD2Pp7TW+4TYGst7Cq/0dXJn3c4BobVKDhtx1MWNml5Q7nsenO5UISQ8arJfC3IXmwQPLy9FNE+KBY7gUYDbhNk4GwM3yOUHzPLl7evzudOcrIiFI14SOA2pzSbiYMsXzFV03RLAyyd7zUv6zclilBPYEaOcQEbksgx0aERHPuxvIjV5g8SpIvYeNZkLf+vkbCB9ZanyVefK0eeL+kSl4mQzW6F/I1zQ6m1EVa3xPkeYcJdQ5VIXGQBwm893IVWxHtmJiJGBy3jMZQXudnldQnJigXYwVRE6dm4FtwFElA54xO40c3rFXIclIMXNqRlMqJrARQEaoHNQcGH9cRGYvILzQtc94VwgTaQNWmBm3sWJxgzDeaAbq3XdcnCE5tMmxl6DespHmOau/ht/E9A62+X2RJD69L264K5Qa0+wbnn9bjCCnqdQ8l2petprwfFqMcC2rbf0P24GTpb3X4GOUKezyiKkU45MOmTrn0RXT70LKVt3dwdCwhu26bh3AkDPgO/VsxzTjVu08dnCQeg6Cm8/D+FZRpK547cCIvjLGFqfwamznaw35m+cbhEHCI2Ydvdbasv/NwXfk/F5nNwgrHoFrrGX3uxdPn788fA7A2G0CNuzObmcX41GkzlMqKiM18kk3LTGVN0e26ae36ae36ae36ae36ae36adviNFt+ult+ult+ulPnt1gm356m356m3566T35bfrpbfrpbfrpbfrpbfrpbfrpbfrpf5RMA9v009v00+vY5zb99Db99Db99Ged5WSbfnqbfnqbfnqbfnqbfnqbfnqbfnrz6XMrIt2mn755fqNt+ult+ult+ult+ult+ult+ult+ult+ult+ult+ult+ulfkVNom356m356m356m356m356m376kxpn/k7ST1eeB+pmCeWi8qKkeUXvuJmU+l0YTOGZvcFxcHkJw7yBp62g+McCH1E6fhcG51RxCMvGF/pC96AcPEh0xuAVsafmzkD7CMYPzabHa3WNhwnhRTzTYh8pfWPd6kuAcCcf3l6yOdZSGeMTqHQGDxjRmXl7qvLKEZZdBgkVkwJfSApMnwuTBGJaf0DvDB/Qs39UnlmCt+FKCOsv65lpwP/DpFY2uLw0j/Phq2umvvm0toVFrKsN6/dusVj8P8ifuxQ=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},y=void 0,j={},f=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Create Document"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/createdocument",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The Create Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Unique identifier for this widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Specify the hint for widgets. This parameter is optional and is not applicable to the following widgets: checkbox, radio button, dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options":{\n "hint": "Provide signature"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp",\n "hint": "Provide stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials",\n "hint": "Provide initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide email",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide name",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide job title",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide company",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12,\n "min_date": "",\n "max_date": "",\n "readonly": false,\n "signing_date": false,\n "hint": "Provide date"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"min_date:"})," Provide the minimum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"max_date:"})," Provide the maximum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"signing_date"}),": If signing_date is set to true, the signing date is shown to the signer during signing. You may set either signing_date or default, but not both. Using both is not supported."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image",\n "hint": "Provide image"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"14",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Provide number",\n "formula": "",\n "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,s.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"decimalplaces:"})," Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"15",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"cells"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "cells",\n "page": 1,\n "x": 100,\n "y": 100,\n "w": 114,\n "h": 50,\n "options": {\n "name": "cells",\n "required": true,\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"cell_count:"})," Specify the number of cells that should be returned to the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,s.jsx)(n.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "required": true,\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "response": "04/15/2024",\n "format": "mm/dd/yyyy",\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "required": true,\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,s.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(x.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{...t(76914)}),"\n",(0,s.jsx)(h(),{...t(10200)})]})}function w(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}},76914(e){e.exports=JSON.parse('{"title":"Body","body":{"content":{"application/json":{"schema":{"required":["file","signers","title"],"type":"object","properties":{"file":{"type":"string","format":"base64","example":"base64 encoded pdf"},"file_password":{"type":"string","format":"string","example":""},"title":{"type":"string","format":"string","example":"sample document"},"note":{"type":"string","format":"string","example":"sample Note"},"description":{"type":"string","format":"string","example":"sample Description"},"timeToCompleteDays":{"type":"number","description":"time to complete days is used to calculate expiry date of your document","format":"number","example":15},"signers":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","format":"string","example":"ceo"},"email":{"type":"string","format":"string","example":"joebee@example.com"},"name":{"type":"string","format":"string","example":"joe bee"},"phone":{"type":"string","format":"string","example":"123121312"},"company":{"type":"string","format":"string","example":"opensign"},"job_title":{"type":"string","format":"string","example":"dev"},"signer_role":{"type":"string","format":"string","description":"Specifies the role of the recipient in the signing process. Allowed values:\\n- **signer** (default): Must have at least one signature widget.\\n- **viewer**: Receives the document to view only; must have no widgets.\\n- **approver**: Reviews and approves the document; no signature widget required.\\n","enum":["signer","viewer","approver"],"example":"signer"},"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Allowed values - signature, stamp.","format":"string","example":"signature"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":244},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":71},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":38},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":46}},"title":"createdocument_body_widgets"}}},"title":"createdocument_body_signers"}},"folderId":{"type":"string","example":""},"send_email":{"type":"boolean","description":"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \\"true\\". If the value of this parameter is \\"true\\" and no \'email_subject\'/\'email_body\' parameters are specified default email templates will be used. \\n","example":true},"email_subject":{"type":"string","description":"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.","example":"{{sender_name}} has requested you to sign {{document_title}}"},"email_body":{"type":"string","description":"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.","example":"

Hi {{receiver_name}},

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

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

Sign here

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

Thanks,
Team OpenSign\u2122

"},"sendInOrder":{"type":"boolean","description":"If set to \'true\', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to \'true\'.","example":true},"send_in_order_strict":{"type":"boolean","description":"When set to \'true\', each signer is blocked from accessing the document until all preceding signers have completed their action. Enforces strict sequential signing. Only applies when \'sendInOrder\' is also \'true\'. Defaults to \'false\'.","example":false},"allow_offline_sign":{"type":"boolean","description":"If set to \'true\', signers can submit a copy of this document signed using an external tool for owner review. Defaults to \'false\'.","example":false},"enableOTP":{"type":"boolean","description":"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.","example":false},"enableTour":{"type":"boolean","description":"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.","example":false},"redirect_url":{"type":"string","description":"Specifies the URL where the signer will be redirected upon completing the document signing process.","example":""},"sender_name":{"type":"string","description":"The name of the person or organization on whose behalf the email is being sent.","example":"opensign\u2122"},"sender_email":{"type":"string","description":"The email address of the person or organization that users can reply to.","example":"mailer@opensignlabs.com"},"allow_modifications":{"type":"boolean","description":"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.","example":false},"auto_reminder":{"type":"boolean","description":"Set to true to enable automatic reminders. Set to false to disable them (default behavior).","example":false},"remind_once_in_every":{"type":"number","description":"Number of days between reminders. This is only applicable when auto_reminder is set to true.","example":5},"merge_certificate":{"type":"boolean","description":"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\\n\\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\\n\\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\\n","example":false},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed. \\n"},"cc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"cc (carbon copy): Users added here will receive a notification email once the document is completed.\\n"},"prefill":{"type":"object","description":"You can provide widgets which can embed before sending to signer","properties":{"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","format":"string","example":"textbox"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":100},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":30},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":40},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":80},"options":{"type":"object","properties":{"name":{"type":"string","example":"textbox"},"response":{"type":"string","example":"joe"},"color":{"type":"string","example":"red"},"fontsize":{"type":"number","example":12}}}}}}},"title":"prefill"}},"title":"createdocument_body"}}},"required":true}}')},10200(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Document created successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"hji2zxcv2P"},"signurl":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","format":"string","example":"mail@example.com"},"url":{"type":"string","format":"string","example":"https://url-to-sign-document.com"}},"title":"inline_response_doc_signurl"}},"message":{"type":"string","format":"string","example":"Document sent successfully!"}},"title":"inline_response_doc"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/3c9ed71a.fde8d8da.js b/assets/js/3c9ed71a.fde8d8da.js deleted file mode 100644 index acccc2b14..000000000 --- a/assets/js/3c9ed71a.fde8d8da.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[5946],{49169(e,n,t){t.r(n),t.d(n,{assets:()=>y,contentTitle:()=>f,default:()=>j,frontMatter:()=>g,metadata:()=>s,toc:()=>w});const s=JSON.parse('{"id":"API-docs/v1.2/createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file.","source":"@site/docs/API-docs/v1.2/createdocument.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/createdocument","permalink":"/docs/API-docs/v1.2/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":"eJztPWtzGzeSfwU3dXW2ucPhw5LtKF7XKrYv8W3WdtnypXKSVwvOgCSsGWACYEQxKlbth/0H9+m+7k/LL7nqBjAvPkTJSlbeZT7EIgaPRqPR3egHcBkYOtHBwXHwQsZFxoTRwccwSJiOFc8NlyI4CI6mjDxXjBpGfC1y+PYVoWkqZ5oUmilNjCQTJpiCWoLNSOL7I6M5yZU85wkXE5JQQ8mMmykZUc0e7REmYpmwhIx5yqITcSKOeH5APuSppAmZy0KRty/+s+wNhoGy407nBRsVE/LhVafz8f7UmFwf9Ho0zyOZM6H5RKR0pKNYZr0EKubJ+EFIZlOmGPRKYioIo5qnc0KThMx4MmFGh8RMmSCxzOckllIlXFDDdEhyOmFEFNmIKR0SKhKSScUIF4QSxWgy7xrZLTQj//X+zWsyliqjJiJv00KH5XAJVyw26dx2b6asnNU97bGhjeJiEpKMngG2uCE/FTw+g2lrJhL4Fxoevn2FuOp03hd5LpVhCfnBTuGg04Ev37BUzghVDOvHMsukIDlVNGMGl2tKDX5W7KeCK5bYRaFp6nFxcCK6pNMRNGMHnQ75IPhPBSM8YcLwMWcKZknMlGvXILL1zTzH+q9EwmNAHgIApUSOm1UBqVD1fc5i6NJWraGaSEFmUx5PEYczatc/T2lsp6WYzlls+DlrdnwRkjl0/IIJ6SGYSsV/lsLQFJfvnCnDY5rWlxkAhKraUGUA/bnkwvhSNwL50S0nrDYuoqNDAC0B5GZc4BfNyDlNC6YdVLOQTAGqdyxXTOPWcP0C4kVCpoxPpmvHo8mnQptGx6TQAGYdCjeWX1VEL0O0jWmqGeHjBi4zesZqoxGJe56mEflmThI2pkVqQsKBQo0qWEReS0Nonqc8pqOUIQ3AZqOmUKyLq+zIJ2qSz1vkAEwTShI+HjMFmxk+YheujYcO6LJiGbjTzJQKIkVroWOZSrVMQljcxCOJpTBMmIgcnlOeIvB2sppwEadFwsgopfFZSEZpwUKiWGI3+pwBmwsd04IqhGqHc8QP0SwFKpQC4BfSDc810Q6qJCJHsFHK/QcfPapxEK7rWHW7fCxhZECB35KEZZSnISIuJJ/kiBhuUhbCBs+pmIfAX1lIDLswI3kRknjK4jP8S9GESzIqjJHCTixRMk/kTDhcjqUwmv+8Ykf6L9fH6DAkeyF5FJInIRn0QzIYhmSwF5LBo5AMnoRk2A/JcBiS4V5Iho8sWMMnDte0RHAdgMHQYtl8Wdid8oSdQsNTmNsp1YYprs+AXZMfQOYwAcAloWWX7MIA80NuxCeCJZUE5JpMeZIwQcZKZkSxmOccuYnlBmXXIcBDFExKaDIu0nROzrnmNRyUncqZALzhiFyRNzkT7/lEEBrHsoA1RgxbpCI6qyUX6RxAPWI00zjzl8IwlSuuGbBqoUsMCFPRlhWAUFZnANuspGhyoPWruW51aisDEvR7rpHngujTpTSdNaTpICKdTsnnoOwvf/nLibg8EYScBMD2ToIDchKUVU6C0H4DaQbfBu73Bfx4OHzsfs7h56PhE/dzhlUHe+7nFH4OfVO3uU6CAxwXK3Bh7MiOv5IaBFBpcSIWDtgTMcRZGJrlG2YAn39d6EkJvpdSUAjiJfQfYAcuw7NmxrbG0mwfwmy54IbTVK+fsK9xh+bcAmn1tKtKSzPfg5kjL1s/bfx8h+Zchwe+oAy1n1Dm1j55aYBQDDegqN3nOh4MrVA7WsLkfuRUmPWItFO4M3isgXNbaGx1eX0sPgIsgjg9AnG6HpWlxL1D+GzDdFtIXdXv9TH7OEIlGLWT9Xh1Fe4QVpsQ3RZOl3u9PkafAEZBzVuPTvh6h3BZAwc+OJ3ZfuvvdQf73WF/uNfAJ1gnbIUs6yZJdz6ff95aZFycWjigUa1+Ri9WfwCjCaiO5UqUX0CD4WJSNmt+XV51W6+1kKBwOkyAzumPn1bpBRMV6s7LtgU8+le13IEH//bn8T/BKXzkD6gscVpzdRwpzT/1I7SRCZ3f07Yr37Q8eUH9tm5swcRPAAeawuKp5LEDHur489YIrD0R4KCLi9pLkl5tUaEwSbpZ1m0Vws8u0kCtMMuiJIlaNZcIxRZmJElCsly8sjxJSJZla4pteaO4l2XLs4iyzMHmsOdpb2mdMy54VsAJCaxq9oAOFeGQ4dCbubXkgnQ6P/7444/dP/2p++JFp+PX0A3hqLhmyLAj0ItbGqFO9J3OAXk1JvUiNCZYMw5ygfJg6EyqtsJUzoQ/D+GpUZGkAHuir2qNSRmdY2eMmylTzXGkqkgWTo9w2BpJM43IBzxcwt/+EFYelvAg9RUwTncyXs87XYXfin1WXLI58EbWup41NXjrklrkGVO+Wm9SbFKkVLELsP5pLsUST7yJDLyefGuxRU/LlaUF7YrOssu8oYPcf+PO4A9K82JrLtDbIYkLbdAkMWEXJKfGMCWws3Oa8oTi/uhiAbugWQ6mld6fT06S3/17Dw27YDs11qKQ8AkHe3zvz8eH3f/5uKJGkedMxVQzkjIYSYeEmTgix1OW5pVLYDabRbOHOp5KmVp/wCet2Nj+/1SOPp0iuHlEdf5g1UwtMdQMqUAsbTsqbs4axqgmvuUKUyouDe6aQR81OGep2KDCuRp3SO9ogQQfrVUaPh+D6EflFoiXVX9L4DknwcdK3KPxlCVXtP24xfaE3ZDSEUuXP11/a6V0Lgu3o72zoDlVR9E1vDlVqLQH43T6Ye0jvWh9tN8WK/apRUh9m3pp77enXwGScl0KkgY6662dywAdP4Ix9CWNGPENwE3nucDn7oISsO22gbeP4tpdMQTUI1ixdNf40a4YobEwS5Lc6Qre7zQue/Uo84K8ji9oCd7PSk3YMILTFdaPAE6e9QOciAFaIb31csP5xNW4Q7yiBdLmbXwTLtKQzDcRqTfagH5a9Q24QrxCVStYy82n1+++iLyxJnXfCMztccxy0LQ+e2uWIG8todBqXLegr6e8eq07RH0rwPqVKdDVu23pcyMirc/+CyLUBthbE6s1+md0ssF+g5/vEHnW4Vlt4nA1loxVA7T0W4mywUKN3zdPeNBvTHi/OeFH/RucuBrDfv6Bq78BP0tDwdm6SOmSOEhYzDOaYgQJwj38jD16k8OXAwz2wHOZ5YWpbzo06yBj8VqCj4uwnt3fhaQbkk5IeiG5H5IHEXnHMJIiLqMunNLAlY2t4IIksgA3aVyodE5GCiYeEhZNInJ5+VNBheFmvliQDrm8hNitxSKCXXgm5MwGXhyDy9gQCJyqDlWJjPWKQCsZ6x6cvnqv2azrQ8V6DrQH5L5ssYSNR1GHgt/2RGahqhEJjPK6VNnsqRQjfbjOUzondAxuahsNgs1s0FAEKD4gQ/L7Z2QwjPr9kPTt3+S+n+DwAe5h9DHFLN3kpMTPV+3gfn0HVz9Xsaz9/lZbuD7sDXcwdHGKMQQ47pUKW7W576DppJpM21hb0+oBZ1Z+6qks0gSkp2KmUIKV8XulTt/pvFVszNO0Fr5HfJHf0xAOxVKWuZAxF7gHxxkMVeDCSNg3Ppaj0xmxsYQwBYgfRMMgrQL87NhWdDdCQGKI8JSKTKm2dhbENEAMAZJmyrJWwIQHrwqa4MLDDqQ8uD2L4PCrJnE/2m8Q935TPq0l7nUUvMFQCE10LoUu/YGs+lSjOuzTly8fLdqU5DuF5cZ4mSrsB5kYEk7Kz1id13ChvZbmoGyHwT2fSqmrGi4SzfFdfdCMcJMKgtweRGVoyOe6vQaPHzaUiCe/oduruUr9vd5gv7fR79VykVz/sEjINkuKVvWtlhRrVmu6cwp9jlPo83fEw9s0zA4eDxvniYebhPMdMczWd9QVJtnbMLze6Gy7ygJa34db2j5/Mxvk55Pl3q9hjWkx7seDf4A15nNJdMnocmtESW7L4rKKMrcwuWy0s3w25daB/dWpd/92zDOts85XDW3wq2GdWvf3P49a28aZGsmdBPy/v3nzbtb/47cTeXh4ePj6/Yfpyw+Tw8PDDH5HUbTSZLeKDHAY0J9dHpAT8agurBkliiJ011NDD7B5LxeTr237cH2b6EQEYSBzyNTiUrxKgoMAVX/mTwJBiIhh2nwjk3lwcBm4SH/400VeQ9PeJw3pYZeBjqcso/CXRygklEFCVxAGNhBBB2GA4W6QXQZrHRwEcvSJxTBargAcw5mGPrDdwaWvZTOigtCpb8FBYKcYhIFzIpdFZS5ZnoyDRYg9neZU65lUycYuy5KqS+jAQnzNhhr/KM9V0A9kId2wm9fQdNHKyLtRTy9qPeDcMnYkwQiVMsNe0Lmu9WuPs0E7ERDaABuJXSuS0LkGdlRoK1NjmsZFCjoqu8i5mpdRVKio1gishLccqYR3sL+oqKYCiSpF50EYcMOyevkaKlLy+isXMwmYwbDh67b9JNmIsT+4AjCH4cLT7NpQfJKMjBguej6V4trtB8OHg+Hg4WAIPbiQyOv24U170MUnOTq90UZI2HlQLuXp9gvSpLlmKhL0Ukoun/lSRuC5gKhcyZhpHZFDyAlhiVP/DqpQKzCXl4a4Bwc2pm9KzxkBpssoGDhELZmimXV2ztkMejgg71jM+LmDrZ6jClUwTOVr6zjGvoVsJcfRHGKFfFfQxmbQuPJmt19D+zZEZfqmZetMFBnwXjvHIAwsqEEY+KGA/9ZYg623CAMH2M03nP26vL7N1WyuCOlWEwptIkd0FTPz9XF/0Am7mmsdrUsqreWyOVMdzXNGVYS5nTdOM24ywlLBi65ge4swuLh6Mhckll2fsUrup2xsbCQUiaUSTD2oR7bemckN9/YWYTC/enrzL3J6j2HxZlfP7gdM9a3SoP8RsD58sgiD6dWwflcmI/8Dgd17tKjUsJaaejqSyfzU863FVRW9RgH1xjJNmHq1UidsaoCQdH/aVghGUqaMihWMppG76K5HgPMX+KOcFW82ZejhK49l2Ht15nPeKwutCyRuBGdyDcclVbCTIII44eoEiXKxnT7p66JgEZLcw/FOdYFs/F7P/QYc3atfEAAuhiqk3YOAlYlhWZ5ixvwM/BQjdGgkESn/s8LIYxIA8HqVH/hqUfHcBpPigK5RM92cuFNKRJ5TUaYcN5NByeVlSQZIHYsFubyEVWXqFLSzxSKsCmCsRgEqYLZEWVFfb1UWsaphWVZranVhDLC2BU4rqwPggrAL5fqBI8NiETUIsgU4emocDlhS0hmk7S7PulRscaW3xv4Ssh0FQCf/Mnh/mj/7jq8A5Wkvf/Y0f/YDXC6RM7v3LHrGXCR2589YmkbkqTZKismzFgqe9lz56qVUqBLixsVVrXpp47bsKHIw/QiMulo8rkmsipjTFKOoQT/2DkH0XoIRRxuWa3CTc2M1aVS68eBGJ4qh+9Fqp4XByzTQCOAHfErJVLHx7++1cHrvGeaRQ/jA0x595mq/smYpq3GLOcGJow1NKmugHRcK2WScUsXHzuIQkhyUc4ZXD9DYOvgtRj0cR1MqznT4dKSeQUZ6mcn+y9/+DjU8T38l3qiEqS2YOmRiWIPaPeBj90IbfY7kzpU2PtMCOaGjkPI0smrruMRdCEN4WbJ+XYw01BK+v4q1GsUnEwYOXFcDG7s7EhiNp1ZoIFRVNEIOxCML7cEDAvPH9sSFiJRZIXWrXw07tawTO/doBVdHCcnFqYQWpzYPZgu04p0HLcTayVh4uSajVMZnQAqg8YHBU1e3nfijViEMTzF1PwfcJz7ZBRCI1NWeM8Xo3Ii8FGOpYqaJhbiG2wotaHZFgxdIOgD4Xg0799AOm+oSOeSFxSEu6D00nDYxhkWLMEDF4FSOxykXDBWTG9GhnyfEDetiBIkR1N4t5BWBEk3uDgl3QYQg7AJSM5AbyBSlqr0AwnKc7WdiL614c/R2iwmgPbprAXMXSSCJ2z7Im6O3cClPudch46jcBn5f0UYVAtY+cs6pv7ijPNbN7ambWTesE4p1woncdThdsgxQwvVKiEKr0QEKyyuvljqubnmC/SkLA9ET3N1ggSx2AyKPZLENS7oCk5RMCkxMNMC7vcqECTLVpTpcaKMKG6rus8RW2lA8njxWoFKt/5AwoW1zSsYYRROSQnDAvCrARVF2yS5ypjhEq61EgWIWdSA3rtZPmmahD+++d3d71XLfPAP1HcMGyJFqkCUs8ZL21FceBpzsvhpAUNwxBs9Zq3KmtBQg36SaUOHEpzVGgDNlxKY0tVWdnAAPPvIzoNeV5rlf/vb3Glxr7ZbLgNkRaJJAPNUVEKJfyhI8cBrFchB/sgkR9MfUH9rnv6DkdplMyo2kt6fxt5jwpUte56KRymgoXcRT0FlKYavD8mYMZ1HS6IIqb9SROcyXXXBtarfFeBPiMn9453I7KxisPEoSy0vn9Q1eRWnJVnd4NuTNe6PKE/CyhCiMPFUs42I7JaXu8jOyZASFkRk1PCa+Kx01bwOzkSh+X2dVbCJQ4zmX6sGarQrdnUoRMxD97JypLWw7tTBKcBuMmJkxJuqweSTJUvDaO35Q9jZw0kqIbUAJ/oOMqQk7jcE8iVTHtkBipwNddTqkawFxPFUXyjln3U16yDyAj1S9AzjuIFTmg1eaR/0Cw4h8J2eAsFKXhROH7R/wSRBydw1UfYSYCkzGBYUXjunGa0Y2uQgjfd0QNkwPFwtn47Tt2HptoRe4+Q3GCTfNyfPPMtGdwu1tfnSvU8DkwNFGaCpxP7kzRevaKgTqFV7cNUX5g+sHTmY7jr9ND/WQX/76fxoUOhfcrEs7x8qvaKpARQyzkuu9enL2BB81DROenoU0fDw/leK04iMrCabZciMBrYisbKoywnFhHNxrNEDpQB2AaCvF4J+mI2BpfdcPBgi5pQHBEQleiglVSVpKDbuMBu+spHVCskOtowY8R64hO2oMjacM7/pKWA63XkqneVsRVzNTwXqCH4CJU4xB2MZ/4cTioraaxwGEKqDfOwlCGxMSfFyEwSiOb9ojSMyGOzDEomGjbOmq1VEck/ujlAN6qBpJexfpgwOnDNME9iEqOi29uLGoFvnIThoaDq+dASO00gHybMTuKg9PEzZ/EaXPb/ei02rdeKFqNoIMIYw+xoMk6ljemrnkMvrVfE6bHEgucnbnPvqC/CuDfv+f2X30sP/luI/2+l+Q++gJAOsCv67mJuvOdSt5hw/i2tzgk2Q2CiOVanNNkDzombLhh6sQXG2H4cL+V3m8PBO/wgtm3WRVlJaz4fnJIBqG/T7801zOFw31Ag71BRrk8FbRfwvC7UPENq+BLV7tmdvE1aef+PDni/h8+NaHnDStCNcULDcKAYI27QCgNbaMjVNxG6JQKVwqDnPplpoYdltbYy7QhugX8DSR8amf/QLPQVo3pdxWMJTLjabl5lpfMXxgCXNvFRW9lxmz6v8M+p2By6I8Bxk1J3QCBxnY4+oWiYopddX2ux5km1Cw1++fDkok7C8j4ZXAu0PwBv0jecbEbzvT+vDGDg+gXmRpxQMDbivh96Ax2Xq5naRmcaG4mQcHx5fBRZfmvGu/Hxx/XHwEEjRTCVGmudQIMTXT4CDoLQWdaqbOMebv+NLum3IraCoSCK5fkg80573zQQShbu02K+XJhvqs6F63iTZ0wsXkqnYfKxy9h3W0S9XAVMWncv5HBozKLUS9VhhwoJ8po2AUAtQDebyrQnVf+kX2QbSr4mKXwmKDoFrfduyqD11tRKO2Rf2K+NLV4aWD/Vpg57GP0cSwyzLqclUgZYkNHxpZRkbWgh1rsY5V+GIjehEDElvxiFWkXHkYOa52Txlr5s8KA1Syh3t7qI0+HqDa9vAJakR7jxZI71VwSRA0A0gwxLwdBvF5Xv2mU3/nqf4n8lS3HNWWeFZ7W501apVf0X2qOeoaJdbj5IqaHhhPvaXHo+F2aHsd1noA1jgAPMhNQ3cJyCr78v5Ks65rstqE5z7W7UOrbT3O1LO92aZmNVnBOfxBock3IG0F+MbDPvKNvT7yjSf9xhnF4brqoTpp4HGiPE24CVQnBjgWfASxwMVYokxxfK+8zR9kPsqkpZMlS2OZlZfpdzo1YixbdTqlYLAbCsyCbwpFcjljalzYG/rHKbvAJwagGcvwWxUEx2gGxsMUMl8Nm6AhGS9VqPzuJKY5HfGUg1Jjk9vt1q70Ih3Bmwk+jO6estdGnLMUdKHS7QFXY3o9dibV2RjC8cBMOQI/OJgwmZhSEVsfmxXQ6CsCS1b1hoE2CqDmFjYpjIL9nFFBJ8hpwvrOJQlLgfFqouQIXNBapoXlF4byVCqbJ4ETwlwvROLLixw+4fEYpJhiU9hF587TqkPr6baC1r0/NIKIkhxg4WADN5IUAgImbGRKARER0riIBjluwAjNjaJCwxHApWa4NSgR5pygTDtr8wfNYIW/5+LMPorQJcclXf3ARpob1rx0sc0JHjTbfMvNd8UIHsORmhup5lXrCTfTYoRaVL2T8oft6Vv/2lRNR9r+hpL31mqte4dvX6EW/oD88tf/Jd8zqgSZypml1rhQLJ1XD1vhw0+48hZtpRKNbnYQN4Dx2BKfk5Iegz9MqUHXxWs2Ax+R3VI2EeBbZsiRC6ok/0EaP+G6BUgQUCyT5+DDFoLB0lA1b8RrguwtPUOOPdnnttDm5az7VQvMQThpaoMnQT1+NXHeLKupl1GfISnypFngalTbDeV1+TlRdGyaxn/NUnvFLVGyMJaAvWHZQ4NIzZU01nmfJ2MP9LKk2wpyHLkFfG187LWK7XBeVMixcz5SN2DJqVzCJ1dVRKwDsKZkroasilPQxB7m0DHaQNQSXq9E9NJKwYTzYpTyuD3hiBy6HFKfHrMyNyas5buEjZSViLx38GfbZc98TWxHemVKzNc+6wW+03mlcZVuBh9P04qs44o5J1UQtk9VTSmHLkPAXfO1Oppzt4mPPTMgzTtkr89MrNUPVb+aPQmOdytjJODVMP1m/J6pcx57I9AaPtrDyr0gDFIeM2eCdFrD4bdvvyfnD6N+ENbOqluw1N73r56/fP3+JQADS2ARNoj6UR89JVKbjIraSK33ANsaRS1ndPd84O75wN3zgbvnA3fPB+6eD7wmRnfPB+6eD9w9H3jrt9Pung/cPR+4ez5w6T7Q3fOBu+cDd88H7p4P3D0fuHs+cPd84L/KTbG75wN3zweuY5+75wN3zwfung+807dU754P3D0fuHs+cPd84O75wN3zgbvnAzdLnxsR6e75wOvfT797PnD3fODu+cDd84G75wN3zwfung/cPR+4ez5w93zg7vnAL8gptHs+cPd84O75wN3zgbvnA3fPB96qceaf5PnAWpp7L08pF7W7juz9LsftRwU/hsEULoA5OA4uL2GYD3DpAhT/VGB6//HHMDinikNYNt4dE/qrTiCx/ozB/RbPbc5A9wjGD+2mx7S61pU5cFeLbWGTHDfWrd9R8/bN+yO4FcC9kZHJBC/nojNIxKczeytCLVsfyy6DlIpJgZn+ge1zYS/xnTavdjnDq13cH7XrAuDWkgrC5p0vdhrwf5jUygaXl/baGLwPxNa3n9a2cIj1tWH9Pi4Wi/8HcV8XhQ==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Draft Document","permalink":"/docs/API-docs/v1.2/draftdocument"},"next":{"title":"Create Document from Template","permalink":"/docs/API-docs/v1.2/createdocumentwithtemplateid"}}');var i=t(74848),r=t(28453),o=t(57742),l=t.n(o),a=t(78178),d=t.n(a),c=t(19624),p=t.n(c),h=t(96226),m=t.n(h),u=(t(77675),t(19365),t(51107)),x=t(21312);const g={id:"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:"eJztPWtzGzeSfwU3dXW2ucPhw5LtKF7XKrYv8W3WdtnypXKSVwvOgCSsGWACYEQxKlbth/0H9+m+7k/LL7nqBjAvPkTJSlbeZT7EIgaPRqPR3egHcBkYOtHBwXHwQsZFxoTRwccwSJiOFc8NlyI4CI6mjDxXjBpGfC1y+PYVoWkqZ5oUmilNjCQTJpiCWoLNSOL7I6M5yZU85wkXE5JQQ8mMmykZUc0e7REmYpmwhIx5yqITcSKOeH5APuSppAmZy0KRty/+s+wNhoGy407nBRsVE/LhVafz8f7UmFwf9Ho0zyOZM6H5RKR0pKNYZr0EKubJ+EFIZlOmGPRKYioIo5qnc0KThMx4MmFGh8RMmSCxzOckllIlXFDDdEhyOmFEFNmIKR0SKhKSScUIF4QSxWgy7xrZLTQj//X+zWsyliqjJiJv00KH5XAJVyw26dx2b6asnNU97bGhjeJiEpKMngG2uCE/FTw+g2lrJhL4Fxoevn2FuOp03hd5LpVhCfnBTuGg04Ev37BUzghVDOvHMsukIDlVNGMGl2tKDX5W7KeCK5bYRaFp6nFxcCK6pNMRNGMHnQ75IPhPBSM8YcLwMWcKZknMlGvXILL1zTzH+q9EwmNAHgIApUSOm1UBqVD1fc5i6NJWraGaSEFmUx5PEYczatc/T2lsp6WYzlls+DlrdnwRkjl0/IIJ6SGYSsV/lsLQFJfvnCnDY5rWlxkAhKraUGUA/bnkwvhSNwL50S0nrDYuoqNDAC0B5GZc4BfNyDlNC6YdVLOQTAGqdyxXTOPWcP0C4kVCpoxPpmvHo8mnQptGx6TQAGYdCjeWX1VEL0O0jWmqGeHjBi4zesZqoxGJe56mEflmThI2pkVqQsKBQo0qWEReS0Nonqc8pqOUIQ3AZqOmUKyLq+zIJ2qSz1vkAEwTShI+HjMFmxk+YheujYcO6LJiGbjTzJQKIkVroWOZSrVMQljcxCOJpTBMmIgcnlOeIvB2sppwEadFwsgopfFZSEZpwUKiWGI3+pwBmwsd04IqhGqHc8QP0SwFKpQC4BfSDc810Q6qJCJHsFHK/QcfPapxEK7rWHW7fCxhZECB35KEZZSnISIuJJ/kiBhuUhbCBs+pmIfAX1lIDLswI3kRknjK4jP8S9GESzIqjJHCTixRMk/kTDhcjqUwmv+8Ykf6L9fH6DAkeyF5FJInIRn0QzIYhmSwF5LBo5AMnoRk2A/JcBiS4V5Iho8sWMMnDte0RHAdgMHQYtl8Wdid8oSdQsNTmNsp1YYprs+AXZMfQOYwAcAloWWX7MIA80NuxCeCJZUE5JpMeZIwQcZKZkSxmOccuYnlBmXXIcBDFExKaDIu0nROzrnmNRyUncqZALzhiFyRNzkT7/lEEBrHsoA1RgxbpCI6qyUX6RxAPWI00zjzl8IwlSuuGbBqoUsMCFPRlhWAUFZnANuspGhyoPWruW51aisDEvR7rpHngujTpTSdNaTpICKdTsnnoOwvf/nLibg8EYScBMD2ToIDchKUVU6C0H4DaQbfBu73Bfx4OHzsfs7h56PhE/dzhlUHe+7nFH4OfVO3uU6CAxwXK3Bh7MiOv5IaBFBpcSIWDtgTMcRZGJrlG2YAn39d6EkJvpdSUAjiJfQfYAcuw7NmxrbG0mwfwmy54IbTVK+fsK9xh+bcAmn1tKtKSzPfg5kjL1s/bfx8h+Zchwe+oAy1n1Dm1j55aYBQDDegqN3nOh4MrVA7WsLkfuRUmPWItFO4M3isgXNbaGx1eX0sPgIsgjg9AnG6HpWlxL1D+GzDdFtIXdXv9TH7OEIlGLWT9Xh1Fe4QVpsQ3RZOl3u9PkafAEZBzVuPTvh6h3BZAwc+OJ3ZfuvvdQf73WF/uNfAJ1gnbIUs6yZJdz6ff95aZFycWjigUa1+Ri9WfwCjCaiO5UqUX0CD4WJSNmt+XV51W6+1kKBwOkyAzumPn1bpBRMV6s7LtgU8+le13IEH//bn8T/BKXzkD6gscVpzdRwpzT/1I7SRCZ3f07Yr37Q8eUH9tm5swcRPAAeawuKp5LEDHur489YIrD0R4KCLi9pLkl5tUaEwSbpZ1m0Vws8u0kCtMMuiJIlaNZcIxRZmJElCsly8sjxJSJZla4pteaO4l2XLs4iyzMHmsOdpb2mdMy54VsAJCaxq9oAOFeGQ4dCbubXkgnQ6P/7444/dP/2p++JFp+PX0A3hqLhmyLAj0ItbGqFO9J3OAXk1JvUiNCZYMw5ygfJg6EyqtsJUzoQ/D+GpUZGkAHuir2qNSRmdY2eMmylTzXGkqkgWTo9w2BpJM43IBzxcwt/+EFYelvAg9RUwTncyXs87XYXfin1WXLI58EbWup41NXjrklrkGVO+Wm9SbFKkVLELsP5pLsUST7yJDLyefGuxRU/LlaUF7YrOssu8oYPcf+PO4A9K82JrLtDbIYkLbdAkMWEXJKfGMCWws3Oa8oTi/uhiAbugWQ6mld6fT06S3/17Dw27YDs11qKQ8AkHe3zvz8eH3f/5uKJGkedMxVQzkjIYSYeEmTgix1OW5pVLYDabRbOHOp5KmVp/wCet2Nj+/1SOPp0iuHlEdf5g1UwtMdQMqUAsbTsqbs4axqgmvuUKUyouDe6aQR81OGep2KDCuRp3SO9ogQQfrVUaPh+D6EflFoiXVX9L4DknwcdK3KPxlCVXtP24xfaE3ZDSEUuXP11/a6V0Lgu3o72zoDlVR9E1vDlVqLQH43T6Ye0jvWh9tN8WK/apRUh9m3pp77enXwGScl0KkgY6662dywAdP4Ix9CWNGPENwE3nucDn7oISsO22gbeP4tpdMQTUI1ixdNf40a4YobEwS5Lc6Qre7zQue/Uo84K8ji9oCd7PSk3YMILTFdaPAE6e9QOciAFaIb31csP5xNW4Q7yiBdLmbXwTLtKQzDcRqTfagH5a9Q24QrxCVStYy82n1+++iLyxJnXfCMztccxy0LQ+e2uWIG8todBqXLegr6e8eq07RH0rwPqVKdDVu23pcyMirc/+CyLUBthbE6s1+md0ssF+g5/vEHnW4Vlt4nA1loxVA7T0W4mywUKN3zdPeNBvTHi/OeFH/RucuBrDfv6Bq78BP0tDwdm6SOmSOEhYzDOaYgQJwj38jD16k8OXAwz2wHOZ5YWpbzo06yBj8VqCj4uwnt3fhaQbkk5IeiG5H5IHEXnHMJIiLqMunNLAlY2t4IIksgA3aVyodE5GCiYeEhZNInJ5+VNBheFmvliQDrm8hNitxSKCXXgm5MwGXhyDy9gQCJyqDlWJjPWKQCsZ6x6cvnqv2azrQ8V6DrQH5L5ssYSNR1GHgt/2RGahqhEJjPK6VNnsqRQjfbjOUzondAxuahsNgs1s0FAEKD4gQ/L7Z2QwjPr9kPTt3+S+n+DwAe5h9DHFLN3kpMTPV+3gfn0HVz9Xsaz9/lZbuD7sDXcwdHGKMQQ47pUKW7W576DppJpM21hb0+oBZ1Z+6qks0gSkp2KmUIKV8XulTt/pvFVszNO0Fr5HfJHf0xAOxVKWuZAxF7gHxxkMVeDCSNg3Ppaj0xmxsYQwBYgfRMMgrQL87NhWdDdCQGKI8JSKTKm2dhbENEAMAZJmyrJWwIQHrwqa4MLDDqQ8uD2L4PCrJnE/2m8Q935TPq0l7nUUvMFQCE10LoUu/YGs+lSjOuzTly8fLdqU5DuF5cZ4mSrsB5kYEk7Kz1id13ChvZbmoGyHwT2fSqmrGi4SzfFdfdCMcJMKgtweRGVoyOe6vQaPHzaUiCe/oduruUr9vd5gv7fR79VykVz/sEjINkuKVvWtlhRrVmu6cwp9jlPo83fEw9s0zA4eDxvniYebhPMdMczWd9QVJtnbMLze6Gy7ygJa34db2j5/Mxvk55Pl3q9hjWkx7seDf4A15nNJdMnocmtESW7L4rKKMrcwuWy0s3w25daB/dWpd/92zDOts85XDW3wq2GdWvf3P49a28aZGsmdBPy/v3nzbtb/47cTeXh4ePj6/Yfpyw+Tw8PDDH5HUbTSZLeKDHAY0J9dHpAT8agurBkliiJ011NDD7B5LxeTr237cH2b6EQEYSBzyNTiUrxKgoMAVX/mTwJBiIhh2nwjk3lwcBm4SH/400VeQ9PeJw3pYZeBjqcso/CXRygklEFCVxAGNhBBB2GA4W6QXQZrHRwEcvSJxTBargAcw5mGPrDdwaWvZTOigtCpb8FBYKcYhIFzIpdFZS5ZnoyDRYg9neZU65lUycYuy5KqS+jAQnzNhhr/KM9V0A9kId2wm9fQdNHKyLtRTy9qPeDcMnYkwQiVMsNe0Lmu9WuPs0E7ERDaABuJXSuS0LkGdlRoK1NjmsZFCjoqu8i5mpdRVKio1gishLccqYR3sL+oqKYCiSpF50EYcMOyevkaKlLy+isXMwmYwbDh67b9JNmIsT+4AjCH4cLT7NpQfJKMjBguej6V4trtB8OHg+Hg4WAIPbiQyOv24U170MUnOTq90UZI2HlQLuXp9gvSpLlmKhL0Ukoun/lSRuC5gKhcyZhpHZFDyAlhiVP/DqpQKzCXl4a4Bwc2pm9KzxkBpssoGDhELZmimXV2ztkMejgg71jM+LmDrZ6jClUwTOVr6zjGvoVsJcfRHGKFfFfQxmbQuPJmt19D+zZEZfqmZetMFBnwXjvHIAwsqEEY+KGA/9ZYg623CAMH2M03nP26vL7N1WyuCOlWEwptIkd0FTPz9XF/0Am7mmsdrUsqreWyOVMdzXNGVYS5nTdOM24ywlLBi65ge4swuLh6Mhckll2fsUrup2xsbCQUiaUSTD2oR7bemckN9/YWYTC/enrzL3J6j2HxZlfP7gdM9a3SoP8RsD58sgiD6dWwflcmI/8Dgd17tKjUsJaaejqSyfzU863FVRW9RgH1xjJNmHq1UidsaoCQdH/aVghGUqaMihWMppG76K5HgPMX+KOcFW82ZejhK49l2Ht15nPeKwutCyRuBGdyDcclVbCTIII44eoEiXKxnT7p66JgEZLcw/FOdYFs/F7P/QYc3atfEAAuhiqk3YOAlYlhWZ5ixvwM/BQjdGgkESn/s8LIYxIA8HqVH/hqUfHcBpPigK5RM92cuFNKRJ5TUaYcN5NByeVlSQZIHYsFubyEVWXqFLSzxSKsCmCsRgEqYLZEWVFfb1UWsaphWVZranVhDLC2BU4rqwPggrAL5fqBI8NiETUIsgU4emocDlhS0hmk7S7PulRscaW3xv4Ssh0FQCf/Mnh/mj/7jq8A5Wkvf/Y0f/YDXC6RM7v3LHrGXCR2589YmkbkqTZKismzFgqe9lz56qVUqBLixsVVrXpp47bsKHIw/QiMulo8rkmsipjTFKOoQT/2DkH0XoIRRxuWa3CTc2M1aVS68eBGJ4qh+9Fqp4XByzTQCOAHfErJVLHx7++1cHrvGeaRQ/jA0x595mq/smYpq3GLOcGJow1NKmugHRcK2WScUsXHzuIQkhyUc4ZXD9DYOvgtRj0cR1MqznT4dKSeQUZ6mcn+y9/+DjU8T38l3qiEqS2YOmRiWIPaPeBj90IbfY7kzpU2PtMCOaGjkPI0smrruMRdCEN4WbJ+XYw01BK+v4q1GsUnEwYOXFcDG7s7EhiNp1ZoIFRVNEIOxCML7cEDAvPH9sSFiJRZIXWrXw07tawTO/doBVdHCcnFqYQWpzYPZgu04p0HLcTayVh4uSajVMZnQAqg8YHBU1e3nfijViEMTzF1PwfcJz7ZBRCI1NWeM8Xo3Ii8FGOpYqaJhbiG2wotaHZFgxdIOgD4Xg0799AOm+oSOeSFxSEu6D00nDYxhkWLMEDF4FSOxykXDBWTG9GhnyfEDetiBIkR1N4t5BWBEk3uDgl3QYQg7AJSM5AbyBSlqr0AwnKc7WdiL614c/R2iwmgPbprAXMXSSCJ2z7Im6O3cClPudch46jcBn5f0UYVAtY+cs6pv7ijPNbN7ambWTesE4p1woncdThdsgxQwvVKiEKr0QEKyyuvljqubnmC/SkLA9ET3N1ggSx2AyKPZLENS7oCk5RMCkxMNMC7vcqECTLVpTpcaKMKG6rus8RW2lA8njxWoFKt/5AwoW1zSsYYRROSQnDAvCrARVF2yS5ypjhEq61EgWIWdSA3rtZPmmahD+++d3d71XLfPAP1HcMGyJFqkCUs8ZL21FceBpzsvhpAUNwxBs9Zq3KmtBQg36SaUOHEpzVGgDNlxKY0tVWdnAAPPvIzoNeV5rlf/vb3Glxr7ZbLgNkRaJJAPNUVEKJfyhI8cBrFchB/sgkR9MfUH9rnv6DkdplMyo2kt6fxt5jwpUte56KRymgoXcRT0FlKYavD8mYMZ1HS6IIqb9SROcyXXXBtarfFeBPiMn9453I7KxisPEoSy0vn9Q1eRWnJVnd4NuTNe6PKE/CyhCiMPFUs42I7JaXu8jOyZASFkRk1PCa+Kx01bwOzkSh+X2dVbCJQ4zmX6sGarQrdnUoRMxD97JypLWw7tTBKcBuMmJkxJuqweSTJUvDaO35Q9jZw0kqIbUAJ/oOMqQk7jcE8iVTHtkBipwNddTqkawFxPFUXyjln3U16yDyAj1S9AzjuIFTmg1eaR/0Cw4h8J2eAsFKXhROH7R/wSRBydw1UfYSYCkzGBYUXjunGa0Y2uQgjfd0QNkwPFwtn47Tt2HptoRe4+Q3GCTfNyfPPMtGdwu1tfnSvU8DkwNFGaCpxP7kzRevaKgTqFV7cNUX5g+sHTmY7jr9ND/WQX/76fxoUOhfcrEs7x8qvaKpARQyzkuu9enL2BB81DROenoU0fDw/leK04iMrCabZciMBrYisbKoywnFhHNxrNEDpQB2AaCvF4J+mI2BpfdcPBgi5pQHBEQleiglVSVpKDbuMBu+spHVCskOtowY8R64hO2oMjacM7/pKWA63XkqneVsRVzNTwXqCH4CJU4xB2MZ/4cTioraaxwGEKqDfOwlCGxMSfFyEwSiOb9ojSMyGOzDEomGjbOmq1VEck/ujlAN6qBpJexfpgwOnDNME9iEqOi29uLGoFvnIThoaDq+dASO00gHybMTuKg9PEzZ/EaXPb/ei02rdeKFqNoIMIYw+xoMk6ljemrnkMvrVfE6bHEgucnbnPvqC/CuDfv+f2X30sP/luI/2+l+Q++gJAOsCv67mJuvOdSt5hw/i2tzgk2Q2CiOVanNNkDzombLhh6sQXG2H4cL+V3m8PBO/wgtm3WRVlJaz4fnJIBqG/T7801zOFw31Ag71BRrk8FbRfwvC7UPENq+BLV7tmdvE1aef+PDni/h8+NaHnDStCNcULDcKAYI27QCgNbaMjVNxG6JQKVwqDnPplpoYdltbYy7QhugX8DSR8amf/QLPQVo3pdxWMJTLjabl5lpfMXxgCXNvFRW9lxmz6v8M+p2By6I8Bxk1J3QCBxnY4+oWiYopddX2ux5km1Cw1++fDkok7C8j4ZXAu0PwBv0jecbEbzvT+vDGDg+gXmRpxQMDbivh96Ax2Xq5naRmcaG4mQcHx5fBRZfmvGu/Hxx/XHwEEjRTCVGmudQIMTXT4CDoLQWdaqbOMebv+NLum3IraCoSCK5fkg80573zQQShbu02K+XJhvqs6F63iTZ0wsXkqnYfKxy9h3W0S9XAVMWncv5HBozKLUS9VhhwoJ8po2AUAtQDebyrQnVf+kX2QbSr4mKXwmKDoFrfduyqD11tRKO2Rf2K+NLV4aWD/Vpg57GP0cSwyzLqclUgZYkNHxpZRkbWgh1rsY5V+GIjehEDElvxiFWkXHkYOa52Txlr5s8KA1Syh3t7qI0+HqDa9vAJakR7jxZI71VwSRA0A0gwxLwdBvF5Xv2mU3/nqf4n8lS3HNWWeFZ7W501apVf0X2qOeoaJdbj5IqaHhhPvaXHo+F2aHsd1noA1jgAPMhNQ3cJyCr78v5Ks65rstqE5z7W7UOrbT3O1LO92aZmNVnBOfxBock3IG0F+MbDPvKNvT7yjSf9xhnF4brqoTpp4HGiPE24CVQnBjgWfASxwMVYokxxfK+8zR9kPsqkpZMlS2OZlZfpdzo1YixbdTqlYLAbCsyCbwpFcjljalzYG/rHKbvAJwagGcvwWxUEx2gGxsMUMl8Nm6AhGS9VqPzuJKY5HfGUg1Jjk9vt1q70Ih3Bmwk+jO6estdGnLMUdKHS7QFXY3o9dibV2RjC8cBMOQI/OJgwmZhSEVsfmxXQ6CsCS1b1hoE2CqDmFjYpjIL9nFFBJ8hpwvrOJQlLgfFqouQIXNBapoXlF4byVCqbJ4ETwlwvROLLixw+4fEYpJhiU9hF587TqkPr6baC1r0/NIKIkhxg4WADN5IUAgImbGRKARER0riIBjluwAjNjaJCwxHApWa4NSgR5pygTDtr8wfNYIW/5+LMPorQJcclXf3ARpob1rx0sc0JHjTbfMvNd8UIHsORmhup5lXrCTfTYoRaVL2T8oft6Vv/2lRNR9r+hpL31mqte4dvX6EW/oD88tf/Jd8zqgSZypml1rhQLJ1XD1vhw0+48hZtpRKNbnYQN4Dx2BKfk5Iegz9MqUHXxWs2Ax+R3VI2EeBbZsiRC6ok/0EaP+G6BUgQUCyT5+DDFoLB0lA1b8RrguwtPUOOPdnnttDm5az7VQvMQThpaoMnQT1+NXHeLKupl1GfISnypFngalTbDeV1+TlRdGyaxn/NUnvFLVGyMJaAvWHZQ4NIzZU01nmfJ2MP9LKk2wpyHLkFfG187LWK7XBeVMixcz5SN2DJqVzCJ1dVRKwDsKZkroasilPQxB7m0DHaQNQSXq9E9NJKwYTzYpTyuD3hiBy6HFKfHrMyNyas5buEjZSViLx38GfbZc98TWxHemVKzNc+6wW+03mlcZVuBh9P04qs44o5J1UQtk9VTSmHLkPAXfO1Oppzt4mPPTMgzTtkr89MrNUPVb+aPQmOdytjJODVMP1m/J6pcx57I9AaPtrDyr0gDFIeM2eCdFrD4bdvvyfnD6N+ENbOqluw1N73r56/fP3+JQADS2ARNoj6UR89JVKbjIraSK33ANsaRS1ndPd84O75wN3zgbvnA3fPB+6eD7wmRnfPB+6eD9w9H3jrt9Pung/cPR+4ez5w6T7Q3fOBu+cDd88H7p4P3D0fuHs+cPd84L/KTbG75wN3zweuY5+75wN3zwfung+807dU754P3D0fuHs+cPd84O75wN3zgbvnAzdLnxsR6e75wOvfT797PnD3fODu+cDd84G75wN3zwfung/cPR+4ez5w93zg7vnAL8gptHs+cPd84O75wN3zgbvnA3fPB96qceaf5PnAWpp7L08pF7W7juz9LsftRwU/hsEULoA5OA4uL2GYD3DpAhT/VGB6//HHMDinikNYNt4dE/qrTiCx/ozB/RbPbc5A9wjGD+2mx7S61pU5cFeLbWGTHDfWrd9R8/bN+yO4FcC9kZHJBC/nojNIxKczeytCLVsfyy6DlIpJgZn+ge1zYS/xnTavdjnDq13cH7XrAuDWkgrC5p0vdhrwf5jUygaXl/baGLwPxNa3n9a2cIj1tWH9Pi4Wi/8HcV8XhQ==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},f=void 0,y={},w=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Create Document"}),"\n",(0,i.jsx)(l(),{method:"post",path:"/createdocument",context:"endpoint"}),"\n",(0,i.jsx)(n.p,{children:"The Create Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Unique identifier for this widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Specify the hint for widgets. This parameter is optional and is not applicable to the following widgets: checkbox, radio button, dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options":{\n "hint": "Provide signature"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp",\n "hint": "Provide stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials",\n "hint": "Provide initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide email",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide name",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide job title",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide company",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12,\n "min_date": "",\n "max_date": "",\n "readonly": false,\n "signing_date": false,\n "hint": "Provide date"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"min_date:"})," Provide the minimum restriction date. The date must be in ",(0,i.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"max_date:"})," Provide the maximum restriction date. The date must be in ",(0,i.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"signing_date"}),": If signing_date is set to true, the signing date is shown to the signer during signing. You may set either signing_date or default, but not both. Using both is not supported."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,i.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image",\n "hint": "Provide image"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"14",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Provide number",\n "formula": "",\n "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,i.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"decimalplaces:"})," Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"15",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"cells"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "cells",\n "page": 1,\n "x": 100,\n "y": 100,\n "w": 114,\n "h": 50,\n "options": {\n "name": "cells",\n "required": true,\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"cell_count:"})," Specify the number of cells that should be returned to the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,i.jsx)(n.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "required": true,\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "response": "04/15/2024",\n "format": "mm/dd/yyyy",\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "required": true,\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,i.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,i.jsx)(x.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,i.jsx)(d(),{parameters:void 0}),"\n",(0,i.jsx)(p(),{...t(76914)}),"\n",(0,i.jsx)(m(),{...t(10200)})]})}function j(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(b,{...e})}):b(e)}},76914(e){e.exports=JSON.parse('{"title":"Body","body":{"content":{"application/json":{"schema":{"required":["file","signers","title"],"type":"object","properties":{"file":{"type":"string","format":"base64","example":"base64 encoded pdf"},"file_password":{"type":"string","format":"string","example":""},"title":{"type":"string","format":"string","example":"sample document"},"note":{"type":"string","format":"string","example":"sample Note"},"description":{"type":"string","format":"string","example":"sample Description"},"timeToCompleteDays":{"type":"number","description":"time to complete days is used to calculate expiry date of your document","format":"number","example":15},"signers":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","format":"string","example":"ceo"},"email":{"type":"string","format":"string","example":"joebee@example.com"},"name":{"type":"string","format":"string","example":"joe bee"},"phone":{"type":"string","format":"string","example":"123121312"},"company":{"type":"string","format":"string","example":"opensign"},"job_title":{"type":"string","format":"string","example":"dev"},"signer_role":{"type":"string","format":"string","description":"Specifies the role of the recipient in the signing process. Allowed values:\\n- **signer** (default): Must have at least one signature widget.\\n- **viewer**: Receives the document to view only; must have no widgets.\\n- **approver**: Reviews and approves the document; no signature widget required.\\n","enum":["signer","viewer","approver"],"example":"signer"},"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Allowed values - signature, stamp.","format":"string","example":"signature"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":244},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":71},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":38},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":46}},"title":"createdocument_body_widgets"}}},"title":"createdocument_body_signers"}},"folderId":{"type":"string","example":""},"send_email":{"type":"boolean","description":"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \\"true\\". If the value of this parameter is \\"true\\" and no \'email_subject\'/\'email_body\' parameters are specified default email templates will be used. \\n","example":true},"email_subject":{"type":"string","description":"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.","example":"{{sender_name}} has requested you to sign {{document_title}}"},"email_body":{"type":"string","description":"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.","example":"

Hi {{receiver_name}},

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

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

Sign here

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

Thanks,
Team OpenSign\u2122

"},"sendInOrder":{"type":"boolean","description":"If set to \'true\', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to \'true\'.","example":true},"send_in_order_strict":{"type":"boolean","description":"When set to \'true\', each signer is blocked from accessing the document until all preceding signers have completed their action. Enforces strict sequential signing. Only applies when \'sendInOrder\' is also \'true\'. Defaults to \'false\'.","example":false},"allow_offline_sign":{"type":"boolean","description":"If set to \'true\', signers can submit a copy of this document signed using an external tool for owner review. Defaults to \'false\'.","example":false},"enableOTP":{"type":"boolean","description":"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.","example":false},"enableTour":{"type":"boolean","description":"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.","example":false},"redirect_url":{"type":"string","description":"Specifies the URL where the signer will be redirected upon completing the document signing process.","example":""},"sender_name":{"type":"string","description":"The name of the person or organization on whose behalf the email is being sent.","example":"opensign\u2122"},"sender_email":{"type":"string","description":"The email address of the person or organization that users can reply to.","example":"mailer@opensignlabs.com"},"allow_modifications":{"type":"boolean","description":"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.","example":false},"auto_reminder":{"type":"boolean","description":"Set to true to enable automatic reminders. Set to false to disable them (default behavior).","example":false},"remind_once_in_every":{"type":"number","description":"Number of days between reminders. This is only applicable when auto_reminder is set to true.","example":5},"merge_certificate":{"type":"boolean","description":"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\\n\\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\\n\\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\\n","example":false},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed. \\n"},"prefill":{"type":"object","description":"You can provide widgets which can embed before sending to signer","properties":{"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","format":"string","example":"textbox"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":100},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":30},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":40},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":80},"options":{"type":"object","properties":{"name":{"type":"string","example":"textbox"},"response":{"type":"string","example":"joe"},"color":{"type":"string","example":"red"},"fontsize":{"type":"number","example":12}}}}}}},"title":"prefill"}},"title":"createdocument_body"}}},"required":true}}')},10200(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Document created successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"hji2zxcv2P"},"signurl":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","format":"string","example":"mail@example.com"},"url":{"type":"string","format":"string","example":"https://url-to-sign-document.com"}},"title":"inline_response_doc_signurl"}},"message":{"type":"string","format":"string","example":"Document sent successfully!"}},"title":"inline_response_doc"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/44f24773.6457b597.js b/assets/js/44f24773.6457b597.js new file mode 100644 index 000000000..6594e6f50 --- /dev/null +++ b/assets/js/44f24773.6457b597.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[9038],{30383(e,t,n){n.r(t),n.d(t,{assets:()=>y,contentTitle:()=>x,default:()=>b,frontMatter:()=>f,metadata:()=>i,toc:()=>v});const i=JSON.parse('{"id":"API-docs/v1.2/createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","source":"@site/docs/API-docs/v1.2/createdocumentwithtemplateid.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/createdocumentwithtemplateid","permalink":"/docs/API-docs/v1.2/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":"eJztXN1yGzeWfhVsp2ptsZrUT+KZXcXrHUV2EtckscqSx5USXSTYfUjCagI9AJoUR1bVXEztA2ztzd7OS+z9PkqeZOsc/HQ3RVJmxjOZ3VUqiaRuNHBwcHB+P+AmsXxikuPL5LnKqhlIa5J3aZKDybQorVAyOU4upsBONXALLLRiY61mzMKsLPDxydlLxotCLQxbqopZxSYgQeMrCQuWh77ZaMneV8ayUqu5yIWcxD4GImdCGgs8Z2rMqrJQnBpw6mIsCngsJLNTYGOlZ9hmxA386gumNBsJyfVyj8Ec9JJZMQOiQwLkSEzmiOeRkB678MMa7I1pKLFFXixZZSCn0QzLuGQj8F/nbsqVAc2EtKDHPAPGLbvsdJ7DqJqwNy87nXePp9aW5nh/n5dlT5UgjZjIgo9ML1Oz/Rwblvl4D4muDM2/Zu5Fg529vuzLH1VFRDhuActhzKvCsjkvKmIDMp0tRD4B5C1H0hXxSGgm+Qxa701VlkpbBtcZlJYhYdxWGlJmLJ+VKRNSWMELkzIx4xMgEjqdqchhYOHaDhbCTgfcWNDCXJnjToe9nYJkIPmogDylqWBDTwONAHlkOhOGTUWeg3Ss1JCJUpBYOFbErlM2qizTMONCGjauimLJ5sKIUQG4nNh37FQtJK2In/WrEuS5mEjGs0xVtNJTYZgiWUYK+JyLAglmShZLJPUC+MwwLnP2Ate11MIAKwsuTeSAtDjb8xIyMV7S+PiMVsBz149Tcs1nYJGiMCgvqG9hmFSW8bIsRMYbMxkr3Dg4f9/VMcumkF2N1HXKNM+FQm5YJVOWa1XmaiGJrsMe63SQRUWn05fD4bAvb/qSsX6CK99Pjlk/odf9JHXPNfAcJ43vxrww4J97sWp88hu45rOyABTa+DlO2bU58/LY7n6ToMTh+vLWE9qXR0g9ErqZePfbLrS/V7CF2lZ/OxH7ORL7Xo3YhbDFFoqxicUmu5GdgdpC9t1Od6L9C6Q9U7OSy+Vmyn2DHUXFCQkr55YVNt8yh9Xud5rBE5xBzu0WxuPb3Wg/POwePOkeHRw9id/NhBy4jrBB/Zhfr3uMyk3ISXzVHOkuA1yrelZd1umE8VC1sNAQNcJMSDGrUEEaq0VGmgsboo5xXbEZGtERoN7rdH788ccfu99/333+vNMh48htzw/hacchWiPw6080QpMNnc4xezlmzUeo9gxY0nW6gjTaBdR3scFULWRQh2Q0NMsrjU180x5DUzjjS+oMhJ2Cbo+jdLCOznigrh0pO+2xN2Rb8Pegg70hhJz06K9QvFAWR+p6s4T5BrsJ2WxJ9nDLxlh5vcOu+DXta28otmxs32IXwi/7iTNd3aN+8q4ttL4ZClTwTqZ8jsaU1mCmNEoYl/TA+Sl2yi25YgbXeATMQAEZelSjZVg0Wol/oo3ubdyWze5b7LYWbkaHzU3Yl/+MIzZt7OZRqdUnGPLwgCxfNRuB3mL76P0uwx34R7g7q4KvaKscMjHjRVnwDEiejjabyfbQOwgl8//05SE5JxkUhdkimvj63iliqwG5cvjmyTo+r9lfH08+a8t3Pdyqx+f4gnEHEe7E2kxVVeQo1BpspaWLN7A5Bgref9RgSiXNHS3c2B6+Hw20QvQWroWxqLrC5763Mw1jURTsrfcWqVP3KHj6XAODAlzIRf3jEyENoNbD8EU1giHW6YxgrDR0OkxYp5C5hpwhxxh3M2Gv0Ftued4UFynNptywEvRMGIN2BPvOc2w68xR/J4xFvq0EIkRJoB3F5PB+TbxOETvu0Esucw0LNoKWsT3a2YGIXbJ+cvDF/uGT/aODoy+afX7+s9Vv3fclOhfk1+G+Bff7ir5tys733iRnU2VCENWSFBIoQyLqx0X9KqTjtAvPXIjZi67hDtrPt9rAJ0f+J6G+OdrGGdTahhxEClk3T4Berxca8buvXr1eHPz2m4k6OTk5+eH8zfTFm8nJyckM/+71en5Wvutf/Wwr1eRWWO5Pwq8w1mZe9WWSJqrElIxQ8mWeHCc+reF3M+710FzkSZrESBazQzc0seQ4aWRrkjQRmB0quZ0mqykjNXoPmX1JqZyQ1kjSRMPvK6EhT47JG0yMXRbYrREYSCRpAtdloXJIjp0JSEw2hRlPjm8SuyyppUW/MEkT54U2n/hwBEn69nA0zY6m5Si5vX3nhgVjv1L5ErvKlLQgLf7qw3Gkev+9QdJvGmPW5F4mzi+l7Jgnxc0RWaWRs1aAIUIxVtuV4h8aWTIX7d1h6YmsEwp1msE4CxUySfQp5SXIZMGiWMb8VZ38ejlmaiasrZM2boV++uN/Gt/FAu3JCFw6rOWnJbdpZEY9S641X6JIWJg1n29gklbreVRz5ATzN1ZyaXFAyjRsZSo1aHbwXkEzjYG9OCHeNup7BWg9sHE5VfKe1odHn+O/nx9iex/j7rryIUeIXbxXo8HPEp8c5vWyDDYx924PbQlz3o4AQ0KBveD2pd9Dqi5olhDClVplYEyPnWASC3KvlI7r4BC9XPbYi8/esVNrFDJwywrg6BpIqLOR3kvw4eVcwAJ7OGavIQMx97TVW0UxbEK5vC9dzEp9SxUTc64jXmISNXSF37iUn3/e7vZL/H6VIha0QY+UKchqVuuFJE0cqUmahKFQVdRL5Nvdpokn7OdvnvvF2DtJAxLM4Fk3PhkpVQCXzW9I4d6mwbPe3r8PbEfqOrm9TYPKWzEpDVsxOHcKYxDmfrvTZzTIWBU5aDRd2yijbQAyH6xqjHrKq8WNVtq2XcXw2pUtpkApB3y84NK6zGcdzzpJ9FrRJ1FauXphMIegK+gnpH5r95922GrmOLQlEZWKPaLxBqYigXi07/8eqXz5qP7SOf7G7+I8kkCNo5I3Ld1OjqAnaCygoES1Nw4Y0PvSQ8447hcGs9Iu94Wc80L4zd42IfV8fe/N1cFJBWUeJrNuOdsrdFoZq2aMJuE/IgtXb1Bv33vslEsmZFZUPsKqc+vs5iYImFOxt7fs5gYlBfQAN9TtbVo/wLFaD8gYuCfaKaLmV/ER1B/GZ41P4boUekkJK/fA24wmAT6pVWnfj1TYuNcS8hXCKQLzPIA8yi5WQe7OOlpTkp6P5v4dZnupwk7+3/D9afnsW7GGlKf75bOn5bO3wKaqBLefHXvGQuZOmyygKHrsqbFaycmzFRY83ffP1y+lJoNFyoBWte5llbexo56n6UdVNXeKMCzTVSZ4gf2S9Q6BvnMYry0zFkqD+124IqFzCZbYEZ9ooLSCs52VnSot/kDucxjwKWdTDeN/ebTC00fPqCw3BQ1P9/kz3/rlmObo/AG5ZDRxoaRB3UPl23GlSfVmBddi7H31lJXoOmBhQVqeWeeTEEcDHRdTLq9M+nSkn2GBLxYGf/rTn7FFsBMv5Sudg/4IQ9HpoPrqdFi3zoWMhTY2pKx100PZtF98jbVY9tgLnk1RoRlsIGM3LkntNLiQzL3NIHX1Sj5GE4EjlCgVqjLhO5QclOsCUHJcNTSmz8nKCe/leLMwgimfCxWyVOQA0PROiiLYsjCprXMyYlYVlktQlSmWv4RFIYsv5EDhWg5cTWO3JXWLEVdgVKjsKtT8eYY+bgixou9ZSSsKqrCXyKU81CuQbSTQq6vBqdDSYy/kWOkMDHOE+iVGsagXjESMolM02Fhmb0gr1bEL42oqd5bPO02Um3ekt+nWMOE6L/A5JuW8a7MiTqtT+JuuavBFyRkbqPG4EBIGFCXttKhNTphqNBOWcZapchm9rsgUj1XwQATJ4NqClqQmVUHuhgMaOFW8kecUgQSmxSgJ9auQUQX9IrxEUMyFOvWkPefLZqDhctt3WElAGsTPhAnlfGnCOPSCF1lFJDgT60p6auysRSvhQOyOsy01mEY4GfQJehMp2h2Mn7TIvTJtTzRFmI8Mm4I874PNOY0V5jTD4DjryKzDJ+gdEZ7l1cXZbsJmGzgT8rBdP+zVxRmbQ227sCKJokJtgnrlrSYsUzmwueBOwaZsMRUZWeilkzCQZAW8k9fc3Zjqa4vmXcJyYdZSlrroByW2IhLXDcByoSGzxZKkWlUWs/3C56XIdfhFxNsx+0JVO5ryTavG2aQiIi1Kcgg3QJu0gV1DvJquMuew+Ir12uzI6pqEFcDGjXFSBtK4bjgbU60qZZUkuJmuSuRf6BquS9ACHYNfhN0N7/X+EALDYUKj+WxSCdooibQpPeHSO5AIxVpgrpsck8I19U6TYSMg8/o30SaBS8zNhz3GeuLeR6sYvx5SodKfeAQE0UECVhm37mRPKONaahiDxrU0MTmw9i3F92T4CcbQ7DU4dVZR9XNl2WKW8ac//Tmpl29jVvXu+rmF4Hmuvd+wZSGp4ug0CFpeLGoumVUPC/czFg7ZDvo3q0jSJHpHM5VHBW52031nWLS1tcfnK7excmyqbIpaI/r9pokRJdCoSXH1I+hTlSgasUIVCr7iPhv12uOQalqc4507BLBcNo1MXdlWK92ui3JoiX8RHYkg4vs3VwA2lQ1ggAc2g0Q/IGdnz78mRLJLBaxBCGChouHXuM/vpEWxi0HJjVkovTaLuq3CQAJXWTXQMBPy4yLm8xr4hT+DZa2smnErMha6Mj3mmzpEhlVNAzmL1YMYse7F3fZXWMx1S+koHSiZAYaZBDO/333+ISJGyG8egV0AyOa0g8CqGO05aDAptRa7V4B0Pfb35VNHjqEDPQM9gUGGBQvSTLCbWiKmeF/MVNojZHB8H4eQh1z3jnT45GOsfNehN26eWkN8qxa4eDF/hFk+1z+uLSPK/WSbI2RcEqAQk0yYbo/HARyYUsh6iFXV5jNc2VQpNx7ylsZJt80p5OhbwhxHD+Fq1Ay8UD7OXIe8/8UtG7Fjg5qkZNdyoOSgtjMfUaraKkBrUErtcEt6h8Zl2nzUhdKP0oGMdpkg/NHOntxZ382DIUM+0YA/KAtYt2wmbmjzG7BoAVLKa0RBckNtkgbK3W4QO24tz6ZA+iSHEiQdKHlUV9Qa5SaPBdDgIkJM895v7to15jevv0Mm6Dq/CDqKfugY0zIlBcWO5NU83J1o6+/czbxjV0uQg0wV6qMAFZ6vt41OLpNRUTl4DaJyRgXPrpJ3t2kyyrKf2yO67y34REqPjlrP7pwUG2UZezwqBAoY1yNatHK5d+xTHjxHTUbrvZL9aG0LJ76kkFsLLUwrH/lXW+Z1DgQj7rHHl+/23NDrHI41UnGP24i4kb/xGuESPSzORy5O6dCp92My/mqgjm1OecRgpBFduGsXNWIWMRm3W3AZgyYwg2rH1LgN6WtQQrM6OjjAH20JfN4yl5jUqqhMQQf9/iFJPx6gt52lAYS4K0+m78XRH66z+dFZAFW1TduOK3s/dm0dwmblFB5SssHAbp2KP41a6aJrVRfn0o2eBXXbWG8hqc4SFnCQq2wQZn9Lfr0xfLKziMXlpv3fXut7hk+cQH6xTooapWP5iLLQNf7dF8pRraG+CTsca8rKxlA7NGk7z0IT9I2+JDH/ZPIIWiu9K/fOXKBiwFZlPRPX8X0c/OLgYJDVTHyyhok+LMYD3BfqCuQn3H4bp1tPrjm8dcMjqdezolaJiQ/d6X3Smm3zuZukgazSwi4Js3zd5aXouvfHl+8QCTwDO1WIfi6VIYoRvHyc7LdV3f5NQ9fdJtitngckNO3CuLEMl/lIXd896s1LsT8/7B0lt+nqN2uPhm9pD1V310+M5RMhJ/d9967m2Dmuqlu4Ft9qrVeK3wLuBr8szVYeCj4FjpkhXAgUltc17PpFWPKIj14PeY7A4suAEW4CgSMO+A64N1IVALwRv9sA6TYwujXstoW6JSDtCo62RnhGG9/EwwegZRNnGQNUD6Vs4SVJDmswY5K0AYsOGL8CkfvLEF9twNcDiun/EIppBcTkT1WsRcN4oVyHqfCv1kEEDp+0CuK+ZbPaGk5qNCuCrXrTarlpY01jQ0nDD+DS6bhdVhLZ+GglNe0/WZ+2fbI2Q+k/WZ+Niv01Ux04bjN0Xx+G+yj846O13Vo3ApTN6ilpxgctl/8d6mohx6qpmeMdGmiWyVCsxpCfNQUxNsNM1TPW6WBKDBe3a1SlM3dpjLuToyBQjcWw8qc//gcbVaJwWN4c5lCg82BSzG8bfzoY4oUcpodHrfqyOe6E0Ha482L2C6g8n7uafBc18pJBt9YcaNTp+hg71aqaTCnzJicFpOz1i/OLcVXQ5SvsHDNf9bU1LbhxymZc8kkdORLNPLuKmShjua3IgdSAOkrMIA26Bmsf4PQQYr50I4QuxBiyZVY45rirWxzEYg4yV5ohKK0rHH6o2+3ij88+Y9+4HCA7txwPVeLTF3QPToixHSiJa71040ZvKwTjw4YtHzJnxXvxwFvj5TF7ij3UD57Fc82dzk//9u/s8lu1aF3/0x6wvh4nV5lZcz+Oysz+FIpy/9xNyuyfnL0kx3TPrf8PdH5fQ0gbIgB/IuS/YhKD5tLpeJeMgZwLrSSyFo+gDD/aZRvuebNiFfo+NdBlPIaMWF2gBOfc8pWlOMXj76e85CNRCPSD8fkHdsotTJResg/sLdYalv7kfK7Yh7780O126T9s2unEi5g6HfbBXw2UkllIWVXm9JeGubryMpVDxJqReHbDstfi63uOdx5Rz19Vgk4cV77S1jgeYKeYrulSpTFGVV8SDciZcNYfTV2IofwQ51CMu7g/aYhvghQYfLyShjY1XyPwUs6FdWmmcaEWodOzalSIjLXJP59S5YGV7mXYeoWQV7R9ZDiPwQo8fhzSFKHP55qPLXur9BWO5HpE811TR3XtwBNuWI5fuNhyLCQvhPHlSWyhQ7+nzpQ7Gr93emIZvBd0ALypHyl1hSI20XxG1VDEBIdOvibv0PXxipAVpkmZkAbD16imn2sUR+dSxpV4C6OpUleuE394itRRl1B9mFCzrcyeYU4yCenIQOalwjuOfHeUI/R9WS0APR13w5IrJ6BpxOSeC2VxBT+0twYKPhWP0O8XMhqMz3DbYIUHdH0Blh+DF305/ObFBdsPK7F/LPIhjdh+jms8dA7YCGusxmrgs4IOw6I0aMgrmePJnZXTMhpmao7ZRJmzTsdbU9raDoi9qA/2h+JbsXS1P7+idYedDpqGq+aZfcOAG+GwepmSppo5LALO+sx7MN0zrayrc2A979ydju9LfM+G/ba700+G61KoLje6UPoq4E0RPaCXpe8VS+zx1L2Sx305PHt1fsF84BvYOGT//V9sePbmDsfpceODGCkfNyLlZjPaLaHVnRcr49EL1BHI0mHgzyvnoxK2FmeFW0uroi8RLDDsr/Fk8Wg1oQ0+uIrjEItXGyZKMrRmpghUuMakh0CMo8csoIfiEQl+vKhw0DUABI+3jtYj/Q4TzF5jMqkv0Skaem05ZC5lQvKFEO0SFQvOqRF54kq77DnPtDKGHAKaBe4urSoLhCDQAD5hRae/wiofO9ODo6Oyd8iJSt8xOJ6mIevEQ5qkulpA5q1HNZ2KGLrzj8Na26zAzt09e/G0ZlDSMWfnD5C6zsIZSuzuNNwxg/YmNPeX2PGVQwlCu8DuQ1QtrtJxiqDvx6ene0icv3WuL0/oasFhP8mymtt+29eXVFB60ARsTgTdDPvo2dffqRoEkEZhSJ3ZcEFvMIJxFfedPY+L+aIJsgNDlsthGiKNdVXG1XC6BGffvULDvhNXUM8BT5ewFjXscYB/uV1S73iRD/caINhI2kdXUSs61rC2gjO8fDfc+5LqNw18j1VMyClo/7Dd9YoLdhLv93tR+3/eD2s8wT2BoTdWoO/6YOfORSR7t4PfGB2WGIK0e9iajYtfv3iDlf47H9+XBRyuWtzfgcYLWXCN/pF9xbOrBde5YRjfcyvIQ11iU/wYhcPdszgKDbuZb1g4D5jND0mM54e9wxigBDfBBDgMglzmbmCPDWnct+hySqPAd+pVKjbS4KxmNuVyghsBfYSGoRao+PMqc3uB6MWu43UIlXSgCEyxLISH9eQrgvHGAIZ33wl5ReLQZZfRg3oLIyMs1OHJYrG4w+k9+ubrqijiNai04e4Jatxn3wj7bTVir6FURlill/VXE2Gn1YjWsvlt/MN3EHzpmKr/S4Ip6vIC9IygJOeg5yK7Z/r7Fpvv7xGKZyVF3M4OEDoI9Y5phYK8FD7svAx0MCTvL5mHu3iBXOpGqQ1z1WshszSFV2M/X58v3z7fJE0KkYEvrfq8ysk3Z9+x+ee9gyRtJN4/Yi33v3t5+uKH8xdIjN8mmKLuHfQOqNysjJ1x2Rhp7b27jRtVWpxvXG3ycGnvw6W9D5f2Plza+3Bp78OlvQ+X9j5c2vtwae/Dpb0Pl/Y+XNr7cGnvw6W9D5f2Plza+3Bp7/+SS3s9+hJ30H5ZcCEbSHCHXr1cAeonadKsyiFKaIpo1+PL5OYG8w1vEMmGj39fESDq8l2azLkWGOASesjXuvL1R+2aWabHr31dfY9tuPJ3Lf0BUioRT0oscXCqK1iuXDJ8i+eYPK4USXMtTh0B3Qvsp+7hDloZgbHuixOqsm1t24QHY80QMVz+irwZ3UmcaL5AKBVfOGqdq+Dus8VnN0nB5aQiiHzi+rx1x6anbRztFeFo/S84q7X8aANs3TTw/ziptR/c3DiMLkE+XXv3auMXnrGhNS7Ou9vb2/8BJlwLag==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Document","permalink":"/docs/API-docs/v1.2/createdocument"},"next":{"title":"Get Document","permalink":"/docs/API-docs/v1.2/getdocument"}}');var s=n(74848),r=n(28453),a=n(57742),o=n.n(a),l=n(78178),d=n.n(l),c=n(19624),p=n.n(c),m=n(96226),h=n.n(m),u=(n(77675),n(19365),n(51107)),g=n(21312);const f={id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztXN1yGzeWfhVsp2ptsZrUT+KZXcXrHUV2EtckscqSx5USXSTYfUjCagI9AJoUR1bVXEztA2ztzd7OS+z9PkqeZOsc/HQ3RVJmxjOZ3VUqiaRuNHBwcHB+P+AmsXxikuPL5LnKqhlIa5J3aZKDybQorVAyOU4upsBONXALLLRiY61mzMKsLPDxydlLxotCLQxbqopZxSYgQeMrCQuWh77ZaMneV8ayUqu5yIWcxD4GImdCGgs8Z2rMqrJQnBpw6mIsCngsJLNTYGOlZ9hmxA386gumNBsJyfVyj8Ec9JJZMQOiQwLkSEzmiOeRkB678MMa7I1pKLFFXixZZSCn0QzLuGQj8F/nbsqVAc2EtKDHPAPGLbvsdJ7DqJqwNy87nXePp9aW5nh/n5dlT5UgjZjIgo9ML1Oz/Rwblvl4D4muDM2/Zu5Fg529vuzLH1VFRDhuActhzKvCsjkvKmIDMp0tRD4B5C1H0hXxSGgm+Qxa701VlkpbBtcZlJYhYdxWGlJmLJ+VKRNSWMELkzIx4xMgEjqdqchhYOHaDhbCTgfcWNDCXJnjToe9nYJkIPmogDylqWBDTwONAHlkOhOGTUWeg3Ss1JCJUpBYOFbErlM2qizTMONCGjauimLJ5sKIUQG4nNh37FQtJK2In/WrEuS5mEjGs0xVtNJTYZgiWUYK+JyLAglmShZLJPUC+MwwLnP2Ate11MIAKwsuTeSAtDjb8xIyMV7S+PiMVsBz149Tcs1nYJGiMCgvqG9hmFSW8bIsRMYbMxkr3Dg4f9/VMcumkF2N1HXKNM+FQm5YJVOWa1XmaiGJrsMe63SQRUWn05fD4bAvb/qSsX6CK99Pjlk/odf9JHXPNfAcJ43vxrww4J97sWp88hu45rOyABTa+DlO2bU58/LY7n6ToMTh+vLWE9qXR0g9ErqZePfbLrS/V7CF2lZ/OxH7ORL7Xo3YhbDFFoqxicUmu5GdgdpC9t1Od6L9C6Q9U7OSy+Vmyn2DHUXFCQkr55YVNt8yh9Xud5rBE5xBzu0WxuPb3Wg/POwePOkeHRw9id/NhBy4jrBB/Zhfr3uMyk3ISXzVHOkuA1yrelZd1umE8VC1sNAQNcJMSDGrUEEaq0VGmgsboo5xXbEZGtERoN7rdH788ccfu99/333+vNMh48htzw/hacchWiPw6080QpMNnc4xezlmzUeo9gxY0nW6gjTaBdR3scFULWRQh2Q0NMsrjU180x5DUzjjS+oMhJ2Cbo+jdLCOznigrh0pO+2xN2Rb8Pegg70hhJz06K9QvFAWR+p6s4T5BrsJ2WxJ9nDLxlh5vcOu+DXta28otmxs32IXwi/7iTNd3aN+8q4ttL4ZClTwTqZ8jsaU1mCmNEoYl/TA+Sl2yi25YgbXeATMQAEZelSjZVg0Wol/oo3ubdyWze5b7LYWbkaHzU3Yl/+MIzZt7OZRqdUnGPLwgCxfNRuB3mL76P0uwx34R7g7q4KvaKscMjHjRVnwDEiejjabyfbQOwgl8//05SE5JxkUhdkimvj63iliqwG5cvjmyTo+r9lfH08+a8t3Pdyqx+f4gnEHEe7E2kxVVeQo1BpspaWLN7A5Bgref9RgSiXNHS3c2B6+Hw20QvQWroWxqLrC5763Mw1jURTsrfcWqVP3KHj6XAODAlzIRf3jEyENoNbD8EU1giHW6YxgrDR0OkxYp5C5hpwhxxh3M2Gv0Ftued4UFynNptywEvRMGIN2BPvOc2w68xR/J4xFvq0EIkRJoB3F5PB+TbxOETvu0Esucw0LNoKWsT3a2YGIXbJ+cvDF/uGT/aODoy+afX7+s9Vv3fclOhfk1+G+Bff7ir5tys733iRnU2VCENWSFBIoQyLqx0X9KqTjtAvPXIjZi67hDtrPt9rAJ0f+J6G+OdrGGdTahhxEClk3T4Berxca8buvXr1eHPz2m4k6OTk5+eH8zfTFm8nJyckM/+71en5Wvutf/Wwr1eRWWO5Pwq8w1mZe9WWSJqrElIxQ8mWeHCc+reF3M+710FzkSZrESBazQzc0seQ4aWRrkjQRmB0quZ0mqykjNXoPmX1JqZyQ1kjSRMPvK6EhT47JG0yMXRbYrREYSCRpAtdloXJIjp0JSEw2hRlPjm8SuyyppUW/MEkT54U2n/hwBEn69nA0zY6m5Si5vX3nhgVjv1L5ErvKlLQgLf7qw3Gkev+9QdJvGmPW5F4mzi+l7Jgnxc0RWaWRs1aAIUIxVtuV4h8aWTIX7d1h6YmsEwp1msE4CxUySfQp5SXIZMGiWMb8VZ38ejlmaiasrZM2boV++uN/Gt/FAu3JCFw6rOWnJbdpZEY9S641X6JIWJg1n29gklbreVRz5ATzN1ZyaXFAyjRsZSo1aHbwXkEzjYG9OCHeNup7BWg9sHE5VfKe1odHn+O/nx9iex/j7rryIUeIXbxXo8HPEp8c5vWyDDYx924PbQlz3o4AQ0KBveD2pd9Dqi5olhDClVplYEyPnWASC3KvlI7r4BC9XPbYi8/esVNrFDJwywrg6BpIqLOR3kvw4eVcwAJ7OGavIQMx97TVW0UxbEK5vC9dzEp9SxUTc64jXmISNXSF37iUn3/e7vZL/H6VIha0QY+UKchqVuuFJE0cqUmahKFQVdRL5Nvdpokn7OdvnvvF2DtJAxLM4Fk3PhkpVQCXzW9I4d6mwbPe3r8PbEfqOrm9TYPKWzEpDVsxOHcKYxDmfrvTZzTIWBU5aDRd2yijbQAyH6xqjHrKq8WNVtq2XcXw2pUtpkApB3y84NK6zGcdzzpJ9FrRJ1FauXphMIegK+gnpH5r95922GrmOLQlEZWKPaLxBqYigXi07/8eqXz5qP7SOf7G7+I8kkCNo5I3Ld1OjqAnaCygoES1Nw4Y0PvSQ8447hcGs9Iu94Wc80L4zd42IfV8fe/N1cFJBWUeJrNuOdsrdFoZq2aMJuE/IgtXb1Bv33vslEsmZFZUPsKqc+vs5iYImFOxt7fs5gYlBfQAN9TtbVo/wLFaD8gYuCfaKaLmV/ER1B/GZ41P4boUekkJK/fA24wmAT6pVWnfj1TYuNcS8hXCKQLzPIA8yi5WQe7OOlpTkp6P5v4dZnupwk7+3/D9afnsW7GGlKf75bOn5bO3wKaqBLefHXvGQuZOmyygKHrsqbFaycmzFRY83ffP1y+lJoNFyoBWte5llbexo56n6UdVNXeKMCzTVSZ4gf2S9Q6BvnMYry0zFkqD+124IqFzCZbYEZ9ooLSCs52VnSot/kDucxjwKWdTDeN/ebTC00fPqCw3BQ1P9/kz3/rlmObo/AG5ZDRxoaRB3UPl23GlSfVmBddi7H31lJXoOmBhQVqeWeeTEEcDHRdTLq9M+nSkn2GBLxYGf/rTn7FFsBMv5Sudg/4IQ9HpoPrqdFi3zoWMhTY2pKx100PZtF98jbVY9tgLnk1RoRlsIGM3LkntNLiQzL3NIHX1Sj5GE4EjlCgVqjLhO5QclOsCUHJcNTSmz8nKCe/leLMwgimfCxWyVOQA0PROiiLYsjCprXMyYlYVlktQlSmWv4RFIYsv5EDhWg5cTWO3JXWLEVdgVKjsKtT8eYY+bgixou9ZSSsKqrCXyKU81CuQbSTQq6vBqdDSYy/kWOkMDHOE+iVGsagXjESMolM02Fhmb0gr1bEL42oqd5bPO02Um3ekt+nWMOE6L/A5JuW8a7MiTqtT+JuuavBFyRkbqPG4EBIGFCXttKhNTphqNBOWcZapchm9rsgUj1XwQATJ4NqClqQmVUHuhgMaOFW8kecUgQSmxSgJ9auQUQX9IrxEUMyFOvWkPefLZqDhctt3WElAGsTPhAnlfGnCOPSCF1lFJDgT60p6auysRSvhQOyOsy01mEY4GfQJehMp2h2Mn7TIvTJtTzRFmI8Mm4I874PNOY0V5jTD4DjryKzDJ+gdEZ7l1cXZbsJmGzgT8rBdP+zVxRmbQ227sCKJokJtgnrlrSYsUzmwueBOwaZsMRUZWeilkzCQZAW8k9fc3Zjqa4vmXcJyYdZSlrroByW2IhLXDcByoSGzxZKkWlUWs/3C56XIdfhFxNsx+0JVO5ryTavG2aQiIi1Kcgg3QJu0gV1DvJquMuew+Ir12uzI6pqEFcDGjXFSBtK4bjgbU60qZZUkuJmuSuRf6BquS9ACHYNfhN0N7/X+EALDYUKj+WxSCdooibQpPeHSO5AIxVpgrpsck8I19U6TYSMg8/o30SaBS8zNhz3GeuLeR6sYvx5SodKfeAQE0UECVhm37mRPKONaahiDxrU0MTmw9i3F92T4CcbQ7DU4dVZR9XNl2WKW8ac//Tmpl29jVvXu+rmF4Hmuvd+wZSGp4ug0CFpeLGoumVUPC/czFg7ZDvo3q0jSJHpHM5VHBW52031nWLS1tcfnK7excmyqbIpaI/r9pokRJdCoSXH1I+hTlSgasUIVCr7iPhv12uOQalqc4507BLBcNo1MXdlWK92ui3JoiX8RHYkg4vs3VwA2lQ1ggAc2g0Q/IGdnz78mRLJLBaxBCGChouHXuM/vpEWxi0HJjVkovTaLuq3CQAJXWTXQMBPy4yLm8xr4hT+DZa2smnErMha6Mj3mmzpEhlVNAzmL1YMYse7F3fZXWMx1S+koHSiZAYaZBDO/333+ISJGyG8egV0AyOa0g8CqGO05aDAptRa7V4B0Pfb35VNHjqEDPQM9gUGGBQvSTLCbWiKmeF/MVNojZHB8H4eQh1z3jnT45GOsfNehN26eWkN8qxa4eDF/hFk+1z+uLSPK/WSbI2RcEqAQk0yYbo/HARyYUsh6iFXV5jNc2VQpNx7ylsZJt80p5OhbwhxHD+Fq1Ay8UD7OXIe8/8UtG7Fjg5qkZNdyoOSgtjMfUaraKkBrUErtcEt6h8Zl2nzUhdKP0oGMdpkg/NHOntxZ382DIUM+0YA/KAtYt2wmbmjzG7BoAVLKa0RBckNtkgbK3W4QO24tz6ZA+iSHEiQdKHlUV9Qa5SaPBdDgIkJM895v7to15jevv0Mm6Dq/CDqKfugY0zIlBcWO5NU83J1o6+/czbxjV0uQg0wV6qMAFZ6vt41OLpNRUTl4DaJyRgXPrpJ3t2kyyrKf2yO67y34REqPjlrP7pwUG2UZezwqBAoY1yNatHK5d+xTHjxHTUbrvZL9aG0LJ76kkFsLLUwrH/lXW+Z1DgQj7rHHl+/23NDrHI41UnGP24i4kb/xGuESPSzORy5O6dCp92My/mqgjm1OecRgpBFduGsXNWIWMRm3W3AZgyYwg2rH1LgN6WtQQrM6OjjAH20JfN4yl5jUqqhMQQf9/iFJPx6gt52lAYS4K0+m78XRH66z+dFZAFW1TduOK3s/dm0dwmblFB5SssHAbp2KP41a6aJrVRfn0o2eBXXbWG8hqc4SFnCQq2wQZn9Lfr0xfLKziMXlpv3fXut7hk+cQH6xTooapWP5iLLQNf7dF8pRraG+CTsca8rKxlA7NGk7z0IT9I2+JDH/ZPIIWiu9K/fOXKBiwFZlPRPX8X0c/OLgYJDVTHyyhok+LMYD3BfqCuQn3H4bp1tPrjm8dcMjqdezolaJiQ/d6X3Smm3zuZukgazSwi4Js3zd5aXouvfHl+8QCTwDO1WIfi6VIYoRvHyc7LdV3f5NQ9fdJtitngckNO3CuLEMl/lIXd896s1LsT8/7B0lt+nqN2uPhm9pD1V310+M5RMhJ/d9967m2Dmuqlu4Ft9qrVeK3wLuBr8szVYeCj4FjpkhXAgUltc17PpFWPKIj14PeY7A4suAEW4CgSMO+A64N1IVALwRv9sA6TYwujXstoW6JSDtCo62RnhGG9/EwwegZRNnGQNUD6Vs4SVJDmswY5K0AYsOGL8CkfvLEF9twNcDiun/EIppBcTkT1WsRcN4oVyHqfCv1kEEDp+0CuK+ZbPaGk5qNCuCrXrTarlpY01jQ0nDD+DS6bhdVhLZ+GglNe0/WZ+2fbI2Q+k/WZ+Niv01Ux04bjN0Xx+G+yj846O13Vo3ApTN6ilpxgctl/8d6mohx6qpmeMdGmiWyVCsxpCfNQUxNsNM1TPW6WBKDBe3a1SlM3dpjLuToyBQjcWw8qc//gcbVaJwWN4c5lCg82BSzG8bfzoY4oUcpodHrfqyOe6E0Ha482L2C6g8n7uafBc18pJBt9YcaNTp+hg71aqaTCnzJicFpOz1i/OLcVXQ5SvsHDNf9bU1LbhxymZc8kkdORLNPLuKmShjua3IgdSAOkrMIA26Bmsf4PQQYr50I4QuxBiyZVY45rirWxzEYg4yV5ohKK0rHH6o2+3ij88+Y9+4HCA7txwPVeLTF3QPToixHSiJa71040ZvKwTjw4YtHzJnxXvxwFvj5TF7ij3UD57Fc82dzk//9u/s8lu1aF3/0x6wvh4nV5lZcz+Oysz+FIpy/9xNyuyfnL0kx3TPrf8PdH5fQ0gbIgB/IuS/YhKD5tLpeJeMgZwLrSSyFo+gDD/aZRvuebNiFfo+NdBlPIaMWF2gBOfc8pWlOMXj76e85CNRCPSD8fkHdsotTJResg/sLdYalv7kfK7Yh7780O126T9s2unEi5g6HfbBXw2UkllIWVXm9JeGubryMpVDxJqReHbDstfi63uOdx5Rz19Vgk4cV77S1jgeYKeYrulSpTFGVV8SDciZcNYfTV2IofwQ51CMu7g/aYhvghQYfLyShjY1XyPwUs6FdWmmcaEWodOzalSIjLXJP59S5YGV7mXYeoWQV7R9ZDiPwQo8fhzSFKHP55qPLXur9BWO5HpE811TR3XtwBNuWI5fuNhyLCQvhPHlSWyhQ7+nzpQ7Gr93emIZvBd0ALypHyl1hSI20XxG1VDEBIdOvibv0PXxipAVpkmZkAbD16imn2sUR+dSxpV4C6OpUleuE394itRRl1B9mFCzrcyeYU4yCenIQOalwjuOfHeUI/R9WS0APR13w5IrJ6BpxOSeC2VxBT+0twYKPhWP0O8XMhqMz3DbYIUHdH0Blh+DF305/ObFBdsPK7F/LPIhjdh+jms8dA7YCGusxmrgs4IOw6I0aMgrmePJnZXTMhpmao7ZRJmzTsdbU9raDoi9qA/2h+JbsXS1P7+idYedDpqGq+aZfcOAG+GwepmSppo5LALO+sx7MN0zrayrc2A979ydju9LfM+G/ba700+G61KoLje6UPoq4E0RPaCXpe8VS+zx1L2Sx305PHt1fsF84BvYOGT//V9sePbmDsfpceODGCkfNyLlZjPaLaHVnRcr49EL1BHI0mHgzyvnoxK2FmeFW0uroi8RLDDsr/Fk8Wg1oQ0+uIrjEItXGyZKMrRmpghUuMakh0CMo8csoIfiEQl+vKhw0DUABI+3jtYj/Q4TzF5jMqkv0Skaem05ZC5lQvKFEO0SFQvOqRF54kq77DnPtDKGHAKaBe4urSoLhCDQAD5hRae/wiofO9ODo6Oyd8iJSt8xOJ6mIevEQ5qkulpA5q1HNZ2KGLrzj8Na26zAzt09e/G0ZlDSMWfnD5C6zsIZSuzuNNwxg/YmNPeX2PGVQwlCu8DuQ1QtrtJxiqDvx6ene0icv3WuL0/oasFhP8mymtt+29eXVFB60ARsTgTdDPvo2dffqRoEkEZhSJ3ZcEFvMIJxFfedPY+L+aIJsgNDlsthGiKNdVXG1XC6BGffvULDvhNXUM8BT5ewFjXscYB/uV1S73iRD/caINhI2kdXUSs61rC2gjO8fDfc+5LqNw18j1VMyClo/7Dd9YoLdhLv93tR+3/eD2s8wT2BoTdWoO/6YOfORSR7t4PfGB2WGIK0e9iajYtfv3iDlf47H9+XBRyuWtzfgcYLWXCN/pF9xbOrBde5YRjfcyvIQ11iU/wYhcPdszgKDbuZb1g4D5jND0mM54e9wxigBDfBBDgMglzmbmCPDWnct+hySqPAd+pVKjbS4KxmNuVyghsBfYSGoRao+PMqc3uB6MWu43UIlXSgCEyxLISH9eQrgvHGAIZ33wl5ReLQZZfRg3oLIyMs1OHJYrG4w+k9+ubrqijiNai04e4Jatxn3wj7bTVir6FURlill/VXE2Gn1YjWsvlt/MN3EHzpmKr/S4Ip6vIC9IygJOeg5yK7Z/r7Fpvv7xGKZyVF3M4OEDoI9Y5phYK8FD7svAx0MCTvL5mHu3iBXOpGqQ1z1WshszSFV2M/X58v3z7fJE0KkYEvrfq8ysk3Z9+x+ee9gyRtJN4/Yi33v3t5+uKH8xdIjN8mmKLuHfQOqNysjJ1x2Rhp7b27jRtVWpxvXG3ycGnvw6W9D5f2Plza+3Bp78OlvQ+X9j5c2vtwae/Dpb0Pl/Y+XNr7cGnvw6W9D5f2Plza+3Bp7/+SS3s9+hJ30H5ZcCEbSHCHXr1cAeonadKsyiFKaIpo1+PL5OYG8w1vEMmGj39fESDq8l2azLkWGOASesjXuvL1R+2aWabHr31dfY9tuPJ3Lf0BUioRT0oscXCqK1iuXDJ8i+eYPK4USXMtTh0B3Qvsp+7hDloZgbHuixOqsm1t24QHY80QMVz+irwZ3UmcaL5AKBVfOGqdq+Dus8VnN0nB5aQiiHzi+rx1x6anbRztFeFo/S84q7X8aANs3TTw/ziptR/c3DiMLkE+XXv3auMXnrGhNS7Ou9vb2/8BJlwLag==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},x=void 0,y={},v=[];function j(e){const t={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Create Document from Template"}),"\n",(0,s.jsx)(o(),{method:"post",path:"/createdocument/{template_id}",context:"endpoint"}),"\n",(0,s.jsxs)(t.p,{children:["The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at ",(0,s.jsx)(t.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(t.strong,{children:"Debug UI"})})," or using the Create Template API."]}),"\n",(0,s.jsx)(t.p,{children:"You can provide default value for all widgets based on their name all widgets support except signature, stamp, initials, image."}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"hint:"})," Specify the hint for widgets. This parameter is optional and is not applicable to the following widgets: checkbox, radio button, dropdown."]}),"\n",(0,s.jsxs)(t.ol,{children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "email",\n "readonly": false,\n "default": "email@example.com",\n "hint": "Provide email",\n "hide_text_with_asterisks": false\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"2",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "name",\n "readonly": false,\n "default": "joe",\n "hint": "Provide name",\n "hide_text_with_asterisks": false\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"3",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "job title",\n "readonly": false,\n "default": "ceo",\n "hint": "Provide job title",\n "hide_text_with_asterisks": false\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"4",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "company",\n "readonly": false,\n "default": "example pvt ltd",\n "hint": "Provide company",\n "hide_text_with_asterisks": false\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"5",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "date",\n "readonly": false,\n "default": "11-05-2025",\n "min_date": "",\n "max_date": "",\n "signing_date": false,\n "hint": "Provide date"\n}\n'})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"min_date:"})," Provide the minimum restriction date. The date must be in ",(0,s.jsx)(t.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"max_date:"})," Provide the maximum restriction date. The date must be in ",(0,s.jsx)(t.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"signing_date"}),": If signing_date is set to true, the signing date is shown to the signer during signing. You may set either signing_date or default, but not both. Using both is not supported."]}),"\n"]}),"\n",(0,s.jsxs)(t.ol,{start:"6",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "textbox",\n "readonly": false,\n "default": "my text",\n "hint": "Provide text",\n "hide_text_with_asterisks": false\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"7",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "checkbox",\n "readonly": false,\n "default": ["option-2"]\n}\n'})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"default:"})," You can have one or more than one value that needs to be selected by default."]}),"\n"]}),"\n",(0,s.jsxs)(t.ol,{start:"8",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "dropdown",\n "readonly": false,\n "default": "option1"\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"9",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "radio",\n "readonly": false,\n "default": "option1"\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"10",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"number"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "number",\n "readonly": false,\n "default": 0,\n "formula": "",\n "decimalplaces": 2,\n "hint": "Provide number",\n "hide_text_with_asterisks": false\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"11",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"cells"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "cells",\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "hide_text_with_asterisks": false \n}\n'})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"cell_count:"})," Specify the number of cells that should be returned to the user."]}),"\n"]}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"response:"})," Provide the value that should replace the existing response."]}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,s.jsx)(t.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,s.jsxs)(t.ol,{children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name":"textbox",\n "response":"andrew bee"\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"2",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "date",\n "response": "04/15/2024"\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"3",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "checkbox",\n "response": ["male", "female"]\n}\n'})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"response:"})," Must be chosen from the existing values of checkbox defined in the template."]}),"\n"]}),"\n",(0,s.jsxs)(t.ol,{start:"4",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "radio button",\n "response": "male"\n}\n'})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"response:"})," Must be chosen from the existing values of radio button defined in the template."]}),"\n"]}),"\n",(0,s.jsxs)(t.ol,{start:"5",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n}\n\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"6",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "dropdown",\n "response": "female"\n}\n'})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"response:"})," Must be chosen from the existing values of dropdown defined in the template."]}),"\n"]}),"\n",(0,s.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(g.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(d(),{...n(3751)}),"\n",(0,s.jsx)(p(),{...n(69901)}),"\n",(0,s.jsx)(h(),{...n(54243)})]})}function b(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(j,{...e})}):j(e)}},3751(e){e.exports=JSON.parse('{"parameters":[{"name":"template_id","in":"path","description":"objectId of Template","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"pH1bhc2hpb"}}]}')},69901(e){e.exports=JSON.parse('{"title":"Body","body":{"content":{"application/json":{"schema":{"required":["signers"],"type":"object","properties":{"title":{"type":"string","format":"string","example":"New document title","description":"An optional parameter specifying the title for the newly created document. If omitted, the template\u2019s title will be used by default.\\n"},"signers":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","example":"Accoutnant"},"email":{"type":"string","format":"mail","example":"joe@example.com"},"name":{"type":"string","example":"joe bee"},"phone":{"type":"string","example":"123123131"},"company":{"type":"string","format":"string","example":"opensign"},"job_title":{"type":"string","format":"string","example":"dev"},"signer_role":{"type":"string","format":"string","description":"Specifies the role of the recipient in the signing process. Allowed values:\\n- **signer** (default): Must have at least one signature widget.\\n- **viewer**: Receives the document to view only; must have no widgets.\\n- **approver**: Reviews and approves the document; no signature widget required.\\n","enum":["signer","viewer","approver"],"example":"signer"},"widgets":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"textbox_1"},"readonly":{"type":"boolean","example":false},"default":{"type":"string","example":"my textbox"}},"title":"createdocumenttemplate_id_Signers_widgets"}}},"title":"createdocumenttemplate_id_Signers"}},"folderId":{"type":"string","example":""},"send_email":{"type":"boolean","description":"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \\"true\\". If the value of this parameter is \\"true\\" and no \'email_subject\'/\'email_body\' parameters are specified default email templates will be used.\\n\\nIf the field is omitted or provided as an empty/invalid value, the template value is used.\\n","example":true},"email_subject":{"type":"string","description":"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.","example":"{{sender_name}} has requested you to sign {{document_title}}"},"email_body":{"type":"string","description":"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.","example":"

Hi {{receiver_name}},

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

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

Sign here

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

Thanks,
Team OpenSign\u2122

"},"sendInOrder":{"type":"boolean","description":"**true** - Only the first signer receives the signature request email initially. Each subsequent signer is notified in sequence, only after the previous signer has completed their signing. This is the default behavior.\\n\\n**false** - All signers receive the signature request email simultaneously.\\n\\nIf the field is omitted or provided as an empty/invalid value, the template value is used.\\n","example":true},"send_in_order_strict":{"type":"boolean","description":"**true** - Each signer is blocked from accessing the document until all preceding signers have completed their action. Enforces strict sequential signing. Only applies when sendInOrder is also true.\\n\\n**false** - Signers can access the document regardless of whether previous signers have completed.\\n\\nIf the field is omitted or provided as an empty/invalid value, the template value is used.\\n","example":false},"allow_offline_sign":{"type":"boolean","description":"**true** - Signers can submit a copy of this document signed using an external tool for owner review.\\n\\n**false** - Signers must complete signing within OpenSign.\\n\\nIf the field is omitted or provided as an empty/invalid value, the template value is used.\\n","example":false},"timeToCompleteDays":{"type":"number","description":"time to complete days is used to calculate expiry date of your document. If this field is present in the request body, it overrides the template value, even when set to 0. If omitted, the template value is used.","format":"number","example":15},"enableOTP":{"type":"boolean","description":"**true** - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. \\n\\n**false** - this option will disable OTP verification, allowing users to sign the document directly without additional steps.\\n\\nIf the field is omitted or provided as an empty/invalid value, the template value is used.\\n","example":false},"enableTour":{"type":"boolean","description":"**true** - this option will enable a guided tour for signers, providing instructions during the signing process. \\n\\n**false** - disable the guided tour, ensuring a faster, uninterrupted signing experience.\\n\\nIf the field is omitted or provided as an empty/invalid value, the template value is used.\\n","example":false},"sender_name":{"type":"string","description":"The name of the person or organization on whose behalf the email is being sent. If this field is present in the request body, it overrides the template value, even when set to an empty string (\\"\\"). If omitted, the template value is used.\\n\\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to \\"\\".\\n","example":"opensign\u2122"},"sender_email":{"type":"string","description":"The email address of the person or organization that users can reply to. If this field is present in the request body, it overrides the template value, even when set to an empty string (\\"\\"). If omitted, the template value is used.\\n\\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to \\"\\".\\n","example":"mailer@opensignlabs.com"},"allow_modifications":{"type":"boolean","description":"**true** - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. \\n\\n**false** - Restricts signers from adding any additional elements to the document. This is the default value.\\n\\nIf the field is omitted or provided as an empty/invalid value, the template value is used.\\n","example":false},"file":{"type":"string","description":"You may provide the base64 encoded PDF file to replace the existing one","format":"base64","example":""},"file_password":{"type":"string","format":"string","example":""},"auto_reminder":{"type":"boolean","description":"Set to true to enable automatic reminders. Set to false to disable them (default behavior). If the field is omitted or provided as an empty/invalid value, the template value is used.","example":false},"remind_once_in_every":{"type":"number","description":"Number of days between reminders. This is only applicable when auto_reminder is set to true. If this field is present in the request body, it overrides the template value, even when set to 0. If omitted, the template value is used.","example":5},"merge_certificate":{"type":"boolean","description":"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\\n\\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\\n\\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\\n","example":false},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"redirect_url":{"type":"string","description":"Specifies the URL where the signer will be redirected upon completing the document signing process. If this field is present in the request body, it overrides the template value, even when set to an empty string (\\"\\"). If omitted, the template value is used.","example":""},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed.\\nIf this field is present in the request body, it overrides the template value, even when provided as an empty array ([]).\\nIf omitted or provided empty string (\\"\\") the template value is used.\\n"},"cc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"cc (carbon copy): Users added here will receive a notification email once the document is completed.\\nIf this field is present in the request body, it overrides the template value, even when provided as an empty array ([]).\\nIf omitted or provided empty string (\\"\\") the template value is used.\\n"},"prefill":{"type":"object","properties":{"widgets":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","format":"string","example":"textbox"},"response":{"type":"string","format":"string","example":"andrew bee"}}}}}}},"title":"createdocument_template_id_body"}}},"required":true}}')},54243(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Document created successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"hji2zxcv2P"},"signurl":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","format":"string","example":"mail@example.com"},"url":{"type":"string","format":"string","example":"https://url-to-sign-document.com"}},"title":"inline_response_doc_signurl"}},"message":{"type":"string","format":"string","example":"Document sent successfully!"}},"title":"inline_response_doc"}}}},"400":{"description":"If you haven\'t add widgets and signers in template or not provide signers along with their roles in body","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","format":"string","example":"Please setup template properly!"}},"title":"inline_response_400_cc"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/44f24773.823a8669.js b/assets/js/44f24773.823a8669.js deleted file mode 100644 index 5abc50a0f..000000000 --- a/assets/js/44f24773.823a8669.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[9038],{30383(e,t,n){n.r(t),n.d(t,{assets:()=>y,contentTitle:()=>x,default:()=>v,frontMatter:()=>g,metadata:()=>i,toc:()=>b});const i=JSON.parse('{"id":"API-docs/v1.2/createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","source":"@site/docs/API-docs/v1.2/createdocumentwithtemplateid.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/createdocumentwithtemplateid","permalink":"/docs/API-docs/v1.2/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":"eJztPGtz3DhyfwXhh9ieokYP25tE67hOZzte13ltlS3H5ZJUsyDZM4RNAjwAnNGcaqruw/2DfMrX+2n7S1LdAPiYlzQ+7/mSaMu1kkig0ehu9Ju4jiyfmOj4PHqu0roEaU10GUcZmFSLygolo+PoLAf2TAO3wMIoNtaqZBbKqsDHJ6evGC8KNTNsrmpmFZuABI2vJMxYFmCzZM4+18aySqupyIScNDBGImNCGgs8Y2rM6qpQnAZwAjEWBdwXktkc2FjpEsck3MAPj5jSLBGS6/kDBlPQc2ZFCYSHBMgQmdQhzxtEhuzML2sQGtNQ4YismLPaQEarGZZyyRLwszO35dqAZkJa0GOeAuOWnQ8GzyGpJ+zDq8Hg8n5ubWWO9/d5VQ1VBdKIiSx4YoapKvczHFhl4weIdG1o/y1xzzrkHF7IC/lJ1YSEoxawDMa8Liyb8qImMiDR2UxkE0DackRdEY2EZpKX0Htv6qpS2jK4SqGyDBHjttYQM2N5WcVMSGEFL0zMRMknQCgMBrnIYGThyo5mwuYjbixoYb6Y48GAfcxBMpA8KSCLaSs40ONAK0DWEJ0Jw3KRZSAdKTWkohIkFo4UDeiYJbVlGkoupGHjuijmbCqMSApAdiLsBqiaSeKI3/XbCuR7MZGMp6mqidO5MEyRLCMGfMpFgQgzJYs5onoGvDSMy4y9QL5WWhhgVcGlaSggLe72fQWpGM9pfXxGHPDU9etUXPMSLGIUFuUFwRaGSWUZr6pCpLyzk7HCg4P796COWZpD+iVRVzHTPBMKqWGVjFmmVZWpmSS8DodsMEASFYPBhfzll18u5PWFZOwiQs5fRMfsIqLXF1HsnmvgGW4a3415YcA/92LVmfI7uOJlVQAKbTMdt+zGnHp57IPfJCjNchdy4RG9kEeIPSK6GXn32y64f1awBdsevJ2QfYjIflYJOxO22IIxDrE4ZDe0U1Bb0F4FuhPujxD3VJUVl/PNmPsBO4qKExJWTS0rbLZlD8vgd9rBY9xBxu0WwuPb3XA/PNw7eLx3dHD0uJlXCjlygHBA+5hfrXuMyk3ISfOqu9IqAdyodld7bDAI66FqYWEgaoRSSFHWqCCN1SIlzYUDUcc4UKxEI5oA6r3B4NOnT5/2fv557/nzwYCMI7dDv4THHZforcCvvtEKXTIMBsfs1Zh1H6HaM2BJ1+ka4sYuoL5rBuRqJoM6JKOhWVZrHOKHDhmawpLPCRgIm4Pur6N0sI7OeKCuTZTNh+wD2Rb8PehgbwghIz36A4oXymKirjZLmB+wm5CVc7KHWw7G0usdTsW/0Ln2hmLLwfYjdkH8/CJypmvv6CK67AutH4YCFbyTnE/RmBIPSqVRwrikB85PsTm35IoZ5HECzEABKXpUyTwwjTjxr3TQvY3bctj9iN144XZ02D2EF/LfcMWujd28Ko36BkseHpDlq8sE9BbbR+93We7AP8LTWRd8SVtlkIqSF1XBUyB5OtpsJvtL7yCUzP93IQ/JOUmhKMwW0cTXN24RR43IlcM3j9fRec35uj36rC/f7XLLHp+jC8YdhLgTa5OrushQqDXYWksXb+BwDBS8/6jBVEqaFS3cOR4ejgbiEL2FK2Esqq4w3UM71TAWRcE+em+RgLpHwdPnGhgU4EIugo9PhDSAWg/DF9UJhthgkMBYaRgMmLBOIXMNGUOKMe52wt6it9zzvCkuUprl3LAKdCmMQTuCsLMMh5Ye49fCWKTbUiBCmATcUUwOb9bE6xSxow695DLTMGMJ9Izt0c4ORAOSXUQHj/YPH+8fHRw96sJ8+NXqt4V9js4F+XV4bsH9vqRvu7LzszfJaa5MCKJ6kkICZUhE/bqoX4V0lHbhmQsxh41ruIP286M20Mmh/02w7662cQettiEHkULWzRug1+uFRvzn79++mx384eVEnZycnLx5/yF/8WFycnJS4t/D4dDvyoP+4autVJdagd3fhF5hrc20upBRHKkKUzJCyVdZdBz5tIY/zXjWw3CRRXHURLKYHbqmjUXHUSdbE8WRwOxQxW0eLaeMVPIZUvuKUjkhrRHFkYY/1kJDFh2TNxgZOy8QrBEYSERxBFdVoTKIjp0JiEyaQ8mj4+vIzisaadEvjOLIeaHdJz4cQZR+Okzy9CivkmixuHTLgrG/V9kcQaVKWpAWf/XhOGK9/9kg6tedNVt0zyPnl1J2zKPi9oik0khZK8AQohir7Yrxm06WzEV7KyQ9kW1CoU0zGGehQiaJplJegkwWzIp5k79qk1+vxkyVwto2aeM49Ouf/9t4EDO0Jwm4dFjPT4sWcUOMdpdcaz5HkbBQdp9vIJJW62nUUuQE8zdWcmlxQco0bCUqDegC+Kygm8ZAKE6It636WQFaDxxc5UreMPrw6CH+e3iI432MuyvnQ44QQXxWyeirxCeDacuW0SbirkLoS5jzdgQYEgqEgseXfg+puqBZQghXaZWCMUN2gkksyLxSOm6DQ/Ry2X0vPg+OnVqjkIFbVgBH10BCm430XoIPL6cCZgjhmL2DFMTU49YeFcVwCOXyfnQxK8GWqknMOUC8wiRqAIVzXMrPP++D/RHnL2PEgjYYkjIFWZetXojiyKEaxVFYClVFyyI/bhFHHrGvPzw3i7F3kkYkmMGz7kxJlCqAy+4cUriLOHjW2+H7wDZRV9FiEQeVt2RSOrZi9N4pjFHY+2KnabTIWBUZaDRd2zCjYwAyGy1rjHbLy8WNXtq2X8Xw2pXNcqCUAz6ecWld5rONZ50keq3okyi9XL0wmEPQNVxEpH5b959O2HLmOIwlEZWK3aP1RqYmgbi37/9OVDa/1850jr/xpzhrUKDBjZI3Pd1OjqBHaCygoES1Nw4Y0PvSQ8Y4nhcGZWXn+0JOeSH8Ye+bkHa/HnqXO7ipoMzDZtaxs8+hZ7WxqmS0CT+JLFx7QL19H7JnXDIh06L2EVabW2fX10HAnIpdLNj1NUoK6BEeqMUibh/gWr0HZAzcE+0UUXdW8wjaic2zzlS4qoSeU8LKPfA2o4uAT2rV2sORCgcPe0K+hDhFYJ4GkDWyi1WQ1V031pSk59bUXyG2lyoE8v+G7k+qpz+JNag82a+ePqmefgSWqwrceXbkGQuZOW0yg6IYsifGaiUnT5dI8GTfP1/PSk0Gi5QBcbWFskzbBtDQ4/RJ1d2TIgxLdZ0KXiBcst4h0HcO45VlxkJl8LwLVyR0LsEcAfGJBkorONtZ21xp8Sdyn8OCTzjLNYz//d4STe89pbJcDhqe7POnfvSrMe3R+QNyzmjjQkmDuofKt+Nak+pNC67F2PvqMavQdcDCgrQ8tc4nIYoGPM5yLr+Y+Emin2KBrykM/vqXv+KIYCdeybc6A30LQzEYoPoaDNhemwsZC21sSFnrroey6bz4GmsxH7IXPM1RoRkcIBswLkntNLiQzL1NIXb1Sj5GE4ErVCgVqjZhHkoOynUBKDmuGtqkz8nKCe/leLOQQM6nQoUsFTkAtL2Togi2LGxq656MKOvCcgmqNsX8e1gUsvhCjhTycuRqGrux1DGj4UBSqPRLqPnzFH3cEGI1vmctrSiowl4hlbJQr0CykUAvc4NToWXIXsix0ikY5hD1LEaxaBlGIkbRKRpsLLN3pJXq2IVxNZUV9nmniXLzDvU+3homXGcFPseknHdtlsRpeQt/V64GX5ScsZEajwshYURR0k5M7VLC1EkpLOMsVdW88boaovheBd+IIBlcWdCS1KQqyN1wjQZOFW+kOUUggWhNlIT6VchGBX0XWmJTzJl65lF7zufdQMPltldISY002D8TNpTxuQnr0AtepDWh4EysK+mpsbMWvYQDkbvZbaXBdMLJoE/Qm4jR7mD8pEXmlWl/ozG2+chwKMjzPtic01giTjcMbnbdEOvwMXpH1M/y9ux0N2GznT4T8rAdHPb27JRNobVdWJFEUaExQb3y3hCWqgzYVHCnYGM2y0VKFnruJAwkWQHv5HVPN6b6+qK5ilgmzFrMYhf9oMTWhOK6BVgmNKS2mJNUq9pitl/4vBS5Dt9FvB2xz1S9oynfxDXOJjUhaVGSQ7gB2sSd3jXsV9N16hwWX7Femx1Z5kngAA7urBMzkMaB4WxMtaqY1ZLazXRdIf0CaLiqQAt0DL4LuTve680hBIbD1I3ms0kVaKMk4qb0hEvvQGIr1gxz3eSYFG6od5oMS4DM699FmwQqMbcfdh/riQ9urWI8P6RCpT/xHRCEBwlYbRzfyZ5QxrXSMAaNvDRNcmDtW4rvyfBTG0MXanDqrKLq5xLbmizjr3/5a9Syb2NWdZV/jhE8y7T3G7YwkiqOToOg5cWi5pxZdce4r2Ackh3075Y7SaPGOypV1ihws5vuO8WirW09Pl+5bSrHpk5z1BqN32+6PaLUNGpi5H7T9KkqFI2mQhUKvuImG/XO9yG1uDjHO3MdwHLeNTJtZVstgV0X5RCLv4uOxCbimw9XaGyqOo0BvrEZJPoBGTt9/h/UkexSAWs6BLBQ0fFr3PSVtCiCGFXcmJnSa7Oo2yoMJHC1VSMNpZC3i5jft41f+DNY1tqqkluRsgDKDJkf6joyrOoayLKpHjQR64PmtP0GzFzHSofpSMkUMMykNvOb3ec3TccI+c0J2BmA7G47CKxqoj3XGkxKrUfupUa6IfvH8qkbiqEDXYKewCjFggVpJthNLRFRvC9mau07ZHB9H4eQh9xCRzx88rGpfLehNx6eVkP8pGbIvCZ/hFk+Bx95ywhzv9nuCimX1FCISSZMtzefA7hmSiHbJZZVm89wpblSbj2kLa0Tb9tTyNH3hLlZPYSrjWbghfJx5rrO++9u2YgcG9QkJbvmIyVHrZ25RalqqwCt6VLqh1vSOzQu0+ajLpR+lA4ktMsE4Y9+9mSFv5sXQ4J8owXfKAtYt+wmbujwG7BoAWLKazSC5JbaJA2Uu90gdtxanuZA+iSDCiR9UHKvrah1yk2+F0CDiwgxzXuzuevXmD+8e41E0G1+EXQj+gEwpmUqCoodyst5uJVo6x/czVyxqxXIUaoKdauGCk/XRQfIeZQUtWuvwa6cpODpl+hyEUdJmn4tRHTfe+0TMT066j1b+VIsSVN2PykEChjXCTGtmj849ikPnqEmI34vZT96x8KJLynkHqOF6eUjfzM2r3MgGFGP3T+/fOCWXudwrJGKG9xG5L5rgLy57P+b9Q1s8/uaMn/cNLDtCqJtysSy/2JL6X/Urf1TeZIG97vGOpjQro4ODvBHXxCf9zQy5k1qyoTTt2T/FMW37wHbTtLQ57YrTfLP4uhPV+n06DT07fS1546cvbk9al0Tx9KHXojJBh2+dSv+g8daF3tW7eFe9hrjRWA7/BaSUvmBgaNMpaOw+wW5jsbwyc4i1rCbzn+f1zcsHzmBfLROijrVSXmPEp1ti7WvxaJaQ30TTjiWLZVtorkwpO+fCU3dVTSTxPybySNorfSu1Dt1vrABW1ftThzgmyj46OBglLZEfLyGiD7ywm+Ez9QXkN/w+G3cbru57vLWLY+oXpVFqxIjHx3S+6i32+5zt0kDaa2FnVNb7NUer8See398fonNpiXYXGGDbaUMYYz9scfRfl/V7V93dN0iQrB6Gppt6RQ2B8twmSXqavVrYl6J/enh8ChaxMtz1n59vGU81Hu7TjGWT4Sc3DTvsqXYe+SqY1yPbq3Wq8QfAE+DZ0t3lO82zoFj8gEZgcLyru3sfRFY3rTgru+qbXpXz0MbarfXtGk1XekfbbAKPaJNi2inD7TTBtp2dvYaO6lXc6lVs20ibGx8t+U69PJ1W/maGMh36/Va8kgO2365KOr3xLne66UurL+tqajfU3TXKPN/qFFmqU/GN+6vbbjwQrmubO9fratCHz7u1Vz9yG5BL3wM0C069UoayxWNjWnzDVlzv4DL2OJxWcqV4qOl7Kefsj4z+HhtEsxPWZ/waOB1o2lctxsdro/0fKB3+6CtE3JsVjhR1+PvOfGXqH2FHKuurm0uXkBDS6p/OTj8CEWqyubeg8GgI2nNrMGg0djutGD6422tWaVmoMe1u0xhXMAV3QaB06Ckd23TLvASkyTFnC7qmFDCLBMTYdsGG5byiieiEOhJuA/i3LltnREzxOstQtvvPU33h8AUCnRAmiw2fsYcLMxM6S9jbB/GdEyCrSSYqgGZc5m66qWzg1QzwcCyvW7CWI1YC4ebklbjYS255BNSI3H3WLIMCtSqhmmVYDuAUUXtlIHlolDaNWfQhui7WyLiC/y0RgPDp2ikNOR4OKa+Am1i13VgSFJwCxK/a6S7WrBxCXN9VrFaYmeUy73X2PqkrG9dUuMejjjdai4N3dbi+kE8DxqC+YwNhIs2PhhADr8Wkq4Xwc7980auPkJihIX2hpXZbLbieDzoz3kp7E91wt5BpYywSs/b2RNh8zohZ6ULpPnDQXoZrrHpuCItjEylZs0lLyo1+zkU1f57l50z+yenr8j1fcB+/fN/sdfAtWS5mjlpTWsNxby9MQcp5zjvyNZ4ru7Gl9rmSPGU+49DyRIECn7MuaUULbo+Qvoj5T6BeAm2vWLmn1nvT/xEEz+N0FCqKSbcpARkDdfzXn85GtYmA+7VCDb9cJcO9xm8dgZ9fXHRV6cXUbffPvNZe39HT/CKY1ZXWf+BH9EeNzLGzetM87HtJzkNFO46AqZVbZ0Ah8gsYENErbSyLtNYZeOA9KoZuxXmtPIS8p31CWrbX+OLYnh9gS95+QUbTeU/5hK67eD3CHZ8yPWYtUlVw1wE5b4W7BJqha43EnqFU7jhqk4KkS5veMhOUrxsqP0waO1XQXHnS5+497HOsN9Zd/N3Qz8yB8is/Rjox/C9D77n89adCmF909O01OwqNPhkfBQvBy99K0elEaSd6V2DxSvhD/F5UAYMdcTfokzcV2fk13WSQBhFre0XsKBL83b8HvRUpCFzs0GP7tPg/SiOCpGCT/p5/+Dk5elrNn04PIjiTkh4C5W6//rVsxdv3r9AZJAFjmCHw4PhASVClbEll52V1l461vmctEf5zneddzeW3d1Ydndj2d2NZXc3lt3dWHZ3Y9ndjWV3N5bd3Vh2d2PZ3Y1ldzeW3d1Ydndj2d2NZXc3lv0vubHM9wXgCdqvCi5kp0fJ9VWcL7WQRXF03L2k7DKOcuzDOD6Prq8x3/ABa6z4+I81lerOL+NoyrXAAJeqYD4Pm63vM+5mme6/841pD9iG+87W4h+aHSR2OhBJXKHvC8yXblhbYBOn73hA1NyIZw6BvTOE00JY6aPBlg03wyVht47tNq6cvn1/htVFfz9ISReyRZrPsCTIZw5b5yq4y7zw2XVUcDmpqXkrcjAX7puRvN/h8YU6PPwvuKu19Oi3frht4P9xU2snXF+77hFqRnDj3auNMzxhw2hkzuVisfgfvhUiDw==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Document","permalink":"/docs/API-docs/v1.2/createdocument"},"next":{"title":"Get Document","permalink":"/docs/API-docs/v1.2/getdocument"}}');var s=n(74848),r=n(28453),a=n(57742),o=n.n(a),l=n(78178),d=n.n(l),c=n(19624),p=n.n(c),h=n(96226),m=n.n(h),u=(n(77675),n(19365),n(51107)),f=n(21312);const g={id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztPGtz3DhyfwXhh9ieokYP25tE67hOZzte13ltlS3H5ZJUsyDZM4RNAjwAnNGcaqruw/2DfMrX+2n7S1LdAPiYlzQ+7/mSaMu1kkig0ehu9Ju4jiyfmOj4PHqu0roEaU10GUcZmFSLygolo+PoLAf2TAO3wMIoNtaqZBbKqsDHJ6evGC8KNTNsrmpmFZuABI2vJMxYFmCzZM4+18aySqupyIScNDBGImNCGgs8Y2rM6qpQnAZwAjEWBdwXktkc2FjpEsck3MAPj5jSLBGS6/kDBlPQc2ZFCYSHBMgQmdQhzxtEhuzML2sQGtNQ4YismLPaQEarGZZyyRLwszO35dqAZkJa0GOeAuOWnQ8GzyGpJ+zDq8Hg8n5ubWWO9/d5VQ1VBdKIiSx4YoapKvczHFhl4weIdG1o/y1xzzrkHF7IC/lJ1YSEoxawDMa8Liyb8qImMiDR2UxkE0DackRdEY2EZpKX0Htv6qpS2jK4SqGyDBHjttYQM2N5WcVMSGEFL0zMRMknQCgMBrnIYGThyo5mwuYjbixoYb6Y48GAfcxBMpA8KSCLaSs40ONAK0DWEJ0Jw3KRZSAdKTWkohIkFo4UDeiYJbVlGkoupGHjuijmbCqMSApAdiLsBqiaSeKI3/XbCuR7MZGMp6mqidO5MEyRLCMGfMpFgQgzJYs5onoGvDSMy4y9QL5WWhhgVcGlaSggLe72fQWpGM9pfXxGHPDU9etUXPMSLGIUFuUFwRaGSWUZr6pCpLyzk7HCg4P796COWZpD+iVRVzHTPBMKqWGVjFmmVZWpmSS8DodsMEASFYPBhfzll18u5PWFZOwiQs5fRMfsIqLXF1HsnmvgGW4a3415YcA/92LVmfI7uOJlVQAKbTMdt+zGnHp57IPfJCjNchdy4RG9kEeIPSK6GXn32y64f1awBdsevJ2QfYjIflYJOxO22IIxDrE4ZDe0U1Bb0F4FuhPujxD3VJUVl/PNmPsBO4qKExJWTS0rbLZlD8vgd9rBY9xBxu0WwuPb3XA/PNw7eLx3dHD0uJlXCjlygHBA+5hfrXuMyk3ISfOqu9IqAdyodld7bDAI66FqYWEgaoRSSFHWqCCN1SIlzYUDUcc4UKxEI5oA6r3B4NOnT5/2fv557/nzwYCMI7dDv4THHZforcCvvtEKXTIMBsfs1Zh1H6HaM2BJ1+ka4sYuoL5rBuRqJoM6JKOhWVZrHOKHDhmawpLPCRgIm4Pur6N0sI7OeKCuTZTNh+wD2Rb8PehgbwghIz36A4oXymKirjZLmB+wm5CVc7KHWw7G0usdTsW/0Ln2hmLLwfYjdkH8/CJypmvv6CK67AutH4YCFbyTnE/RmBIPSqVRwrikB85PsTm35IoZ5HECzEABKXpUyTwwjTjxr3TQvY3bctj9iN144XZ02D2EF/LfcMWujd28Ko36BkseHpDlq8sE9BbbR+93We7AP8LTWRd8SVtlkIqSF1XBUyB5OtpsJvtL7yCUzP93IQ/JOUmhKMwW0cTXN24RR43IlcM3j9fRec35uj36rC/f7XLLHp+jC8YdhLgTa5OrushQqDXYWksXb+BwDBS8/6jBVEqaFS3cOR4ejgbiEL2FK2Esqq4w3UM71TAWRcE+em+RgLpHwdPnGhgU4EIugo9PhDSAWg/DF9UJhthgkMBYaRgMmLBOIXMNGUOKMe52wt6it9zzvCkuUprl3LAKdCmMQTuCsLMMh5Ye49fCWKTbUiBCmATcUUwOb9bE6xSxow695DLTMGMJ9Izt0c4ORAOSXUQHj/YPH+8fHRw96sJ8+NXqt4V9js4F+XV4bsH9vqRvu7LzszfJaa5MCKJ6kkICZUhE/bqoX4V0lHbhmQsxh41ruIP286M20Mmh/02w7662cQettiEHkULWzRug1+uFRvzn79++mx384eVEnZycnLx5/yF/8WFycnJS4t/D4dDvyoP+4autVJdagd3fhF5hrc20upBRHKkKUzJCyVdZdBz5tIY/zXjWw3CRRXHURLKYHbqmjUXHUSdbE8WRwOxQxW0eLaeMVPIZUvuKUjkhrRHFkYY/1kJDFh2TNxgZOy8QrBEYSERxBFdVoTKIjp0JiEyaQ8mj4+vIzisaadEvjOLIeaHdJz4cQZR+Okzy9CivkmixuHTLgrG/V9kcQaVKWpAWf/XhOGK9/9kg6tedNVt0zyPnl1J2zKPi9oik0khZK8AQohir7Yrxm06WzEV7KyQ9kW1CoU0zGGehQiaJplJegkwWzIp5k79qk1+vxkyVwto2aeM49Ouf/9t4EDO0Jwm4dFjPT4sWcUOMdpdcaz5HkbBQdp9vIJJW62nUUuQE8zdWcmlxQco0bCUqDegC+Kygm8ZAKE6It636WQFaDxxc5UreMPrw6CH+e3iI432MuyvnQ44QQXxWyeirxCeDacuW0SbirkLoS5jzdgQYEgqEgseXfg+puqBZQghXaZWCMUN2gkksyLxSOm6DQ/Ry2X0vPg+OnVqjkIFbVgBH10BCm430XoIPL6cCZgjhmL2DFMTU49YeFcVwCOXyfnQxK8GWqknMOUC8wiRqAIVzXMrPP++D/RHnL2PEgjYYkjIFWZetXojiyKEaxVFYClVFyyI/bhFHHrGvPzw3i7F3kkYkmMGz7kxJlCqAy+4cUriLOHjW2+H7wDZRV9FiEQeVt2RSOrZi9N4pjFHY+2KnabTIWBUZaDRd2zCjYwAyGy1rjHbLy8WNXtq2X8Xw2pXNcqCUAz6ecWld5rONZ50keq3okyi9XL0wmEPQNVxEpH5b959O2HLmOIwlEZWK3aP1RqYmgbi37/9OVDa/1850jr/xpzhrUKDBjZI3Pd1OjqBHaCygoES1Nw4Y0PvSQ8Y4nhcGZWXn+0JOeSH8Ye+bkHa/HnqXO7ipoMzDZtaxs8+hZ7WxqmS0CT+JLFx7QL19H7JnXDIh06L2EVabW2fX10HAnIpdLNj1NUoK6BEeqMUibh/gWr0HZAzcE+0UUXdW8wjaic2zzlS4qoSeU8LKPfA2o4uAT2rV2sORCgcPe0K+hDhFYJ4GkDWyi1WQ1V031pSk59bUXyG2lyoE8v+G7k+qpz+JNag82a+ePqmefgSWqwrceXbkGQuZOW0yg6IYsifGaiUnT5dI8GTfP1/PSk0Gi5QBcbWFskzbBtDQ4/RJ1d2TIgxLdZ0KXiBcst4h0HcO45VlxkJl8LwLVyR0LsEcAfGJBkorONtZ21xp8Sdyn8OCTzjLNYz//d4STe89pbJcDhqe7POnfvSrMe3R+QNyzmjjQkmDuofKt+Nak+pNC67F2PvqMavQdcDCgrQ8tc4nIYoGPM5yLr+Y+Emin2KBrykM/vqXv+KIYCdeybc6A30LQzEYoPoaDNhemwsZC21sSFnrroey6bz4GmsxH7IXPM1RoRkcIBswLkntNLiQzL1NIXb1Sj5GE4ErVCgVqjZhHkoOynUBKDmuGtqkz8nKCe/leLOQQM6nQoUsFTkAtL2Togi2LGxq656MKOvCcgmqNsX8e1gUsvhCjhTycuRqGrux1DGj4UBSqPRLqPnzFH3cEGI1vmctrSiowl4hlbJQr0CykUAvc4NToWXIXsix0ikY5hD1LEaxaBlGIkbRKRpsLLN3pJXq2IVxNZUV9nmniXLzDvU+3homXGcFPseknHdtlsRpeQt/V64GX5ScsZEajwshYURR0k5M7VLC1EkpLOMsVdW88boaovheBd+IIBlcWdCS1KQqyN1wjQZOFW+kOUUggWhNlIT6VchGBX0XWmJTzJl65lF7zufdQMPltldISY002D8TNpTxuQnr0AtepDWh4EysK+mpsbMWvYQDkbvZbaXBdMLJoE/Qm4jR7mD8pEXmlWl/ozG2+chwKMjzPtic01giTjcMbnbdEOvwMXpH1M/y9ux0N2GznT4T8rAdHPb27JRNobVdWJFEUaExQb3y3hCWqgzYVHCnYGM2y0VKFnruJAwkWQHv5HVPN6b6+qK5ilgmzFrMYhf9oMTWhOK6BVgmNKS2mJNUq9pitl/4vBS5Dt9FvB2xz1S9oynfxDXOJjUhaVGSQ7gB2sSd3jXsV9N16hwWX7Femx1Z5kngAA7urBMzkMaB4WxMtaqY1ZLazXRdIf0CaLiqQAt0DL4LuTve680hBIbD1I3ms0kVaKMk4qb0hEvvQGIr1gxz3eSYFG6od5oMS4DM699FmwQqMbcfdh/riQ9urWI8P6RCpT/xHRCEBwlYbRzfyZ5QxrXSMAaNvDRNcmDtW4rvyfBTG0MXanDqrKLq5xLbmizjr3/5a9Syb2NWdZV/jhE8y7T3G7YwkiqOToOg5cWi5pxZdce4r2Ackh3075Y7SaPGOypV1ihws5vuO8WirW09Pl+5bSrHpk5z1BqN32+6PaLUNGpi5H7T9KkqFI2mQhUKvuImG/XO9yG1uDjHO3MdwHLeNTJtZVstgV0X5RCLv4uOxCbimw9XaGyqOo0BvrEZJPoBGTt9/h/UkexSAWs6BLBQ0fFr3PSVtCiCGFXcmJnSa7Oo2yoMJHC1VSMNpZC3i5jft41f+DNY1tqqkluRsgDKDJkf6joyrOoayLKpHjQR64PmtP0GzFzHSofpSMkUMMykNvOb3ec3TccI+c0J2BmA7G47CKxqoj3XGkxKrUfupUa6IfvH8qkbiqEDXYKewCjFggVpJthNLRFRvC9mau07ZHB9H4eQh9xCRzx88rGpfLehNx6eVkP8pGbIvCZ/hFk+Bx95ywhzv9nuCimX1FCISSZMtzefA7hmSiHbJZZVm89wpblSbj2kLa0Tb9tTyNH3hLlZPYSrjWbghfJx5rrO++9u2YgcG9QkJbvmIyVHrZ25RalqqwCt6VLqh1vSOzQu0+ajLpR+lA4ktMsE4Y9+9mSFv5sXQ4J8owXfKAtYt+wmbujwG7BoAWLKazSC5JbaJA2Uu90gdtxanuZA+iSDCiR9UHKvrah1yk2+F0CDiwgxzXuzuevXmD+8e41E0G1+EXQj+gEwpmUqCoodyst5uJVo6x/czVyxqxXIUaoKdauGCk/XRQfIeZQUtWuvwa6cpODpl+hyEUdJmn4tRHTfe+0TMT066j1b+VIsSVN2PykEChjXCTGtmj849ikPnqEmI34vZT96x8KJLynkHqOF6eUjfzM2r3MgGFGP3T+/fOCWXudwrJGKG9xG5L5rgLy57P+b9Q1s8/uaMn/cNLDtCqJtysSy/2JL6X/Urf1TeZIG97vGOpjQro4ODvBHXxCf9zQy5k1qyoTTt2T/FMW37wHbTtLQ57YrTfLP4uhPV+n06DT07fS1546cvbk9al0Tx9KHXojJBh2+dSv+g8daF3tW7eFe9hrjRWA7/BaSUvmBgaNMpaOw+wW5jsbwyc4i1rCbzn+f1zcsHzmBfLROijrVSXmPEp1ti7WvxaJaQ30TTjiWLZVtorkwpO+fCU3dVTSTxPybySNorfSu1Dt1vrABW1ftThzgmyj46OBglLZEfLyGiD7ywm+Ez9QXkN/w+G3cbru57vLWLY+oXpVFqxIjHx3S+6i32+5zt0kDaa2FnVNb7NUer8See398fonNpiXYXGGDbaUMYYz9scfRfl/V7V93dN0iQrB6Gppt6RQ2B8twmSXqavVrYl6J/enh8ChaxMtz1n59vGU81Hu7TjGWT4Sc3DTvsqXYe+SqY1yPbq3Wq8QfAE+DZ0t3lO82zoFj8gEZgcLyru3sfRFY3rTgru+qbXpXz0MbarfXtGk1XekfbbAKPaJNi2inD7TTBtp2dvYaO6lXc6lVs20ibGx8t+U69PJ1W/maGMh36/Va8kgO2365KOr3xLne66UurL+tqajfU3TXKPN/qFFmqU/GN+6vbbjwQrmubO9fratCHz7u1Vz9yG5BL3wM0C069UoayxWNjWnzDVlzv4DL2OJxWcqV4qOl7Kefsj4z+HhtEsxPWZ/waOB1o2lctxsdro/0fKB3+6CtE3JsVjhR1+PvOfGXqH2FHKuurm0uXkBDS6p/OTj8CEWqyubeg8GgI2nNrMGg0djutGD6422tWaVmoMe1u0xhXMAV3QaB06Ckd23TLvASkyTFnC7qmFDCLBMTYdsGG5byiieiEOhJuA/i3LltnREzxOstQtvvPU33h8AUCnRAmiw2fsYcLMxM6S9jbB/GdEyCrSSYqgGZc5m66qWzg1QzwcCyvW7CWI1YC4ebklbjYS255BNSI3H3WLIMCtSqhmmVYDuAUUXtlIHlolDaNWfQhui7WyLiC/y0RgPDp2ikNOR4OKa+Am1i13VgSFJwCxK/a6S7WrBxCXN9VrFaYmeUy73X2PqkrG9dUuMejjjdai4N3dbi+kE8DxqC+YwNhIs2PhhADr8Wkq4Xwc7980auPkJihIX2hpXZbLbieDzoz3kp7E91wt5BpYywSs/b2RNh8zohZ6ULpPnDQXoZrrHpuCItjEylZs0lLyo1+zkU1f57l50z+yenr8j1fcB+/fN/sdfAtWS5mjlpTWsNxby9MQcp5zjvyNZ4ru7Gl9rmSPGU+49DyRIECn7MuaUULbo+Qvoj5T6BeAm2vWLmn1nvT/xEEz+N0FCqKSbcpARkDdfzXn85GtYmA+7VCDb9cJcO9xm8dgZ9fXHRV6cXUbffPvNZe39HT/CKY1ZXWf+BH9EeNzLGzetM87HtJzkNFO46AqZVbZ0Ah8gsYENErbSyLtNYZeOA9KoZuxXmtPIS8p31CWrbX+OLYnh9gS95+QUbTeU/5hK67eD3CHZ8yPWYtUlVw1wE5b4W7BJqha43EnqFU7jhqk4KkS5veMhOUrxsqP0waO1XQXHnS5+497HOsN9Zd/N3Qz8yB8is/Rjox/C9D77n89adCmF909O01OwqNPhkfBQvBy99K0elEaSd6V2DxSvhD/F5UAYMdcTfokzcV2fk13WSQBhFre0XsKBL83b8HvRUpCFzs0GP7tPg/SiOCpGCT/p5/+Dk5elrNn04PIjiTkh4C5W6//rVsxdv3r9AZJAFjmCHw4PhASVClbEll52V1l461vmctEf5zneddzeW3d1Ydndj2d2NZXc3lt3dWHZ3Y9ndjWV3N5bd3Vh2d2PZ3Y1ldzeW3d1Ydndj2d2NZXc3lv0vubHM9wXgCdqvCi5kp0fJ9VWcL7WQRXF03L2k7DKOcuzDOD6Prq8x3/ABa6z4+I81lerOL+NoyrXAAJeqYD4Pm63vM+5mme6/841pD9iG+87W4h+aHSR2OhBJXKHvC8yXblhbYBOn73hA1NyIZw6BvTOE00JY6aPBlg03wyVht47tNq6cvn1/htVFfz9ISReyRZrPsCTIZw5b5yq4y7zw2XVUcDmpqXkrcjAX7puRvN/h8YU6PPwvuKu19Oi3frht4P9xU2snXF+77hFqRnDj3auNMzxhw2hkzuVisfgfvhUiDw==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},x=void 0,y={},b=[];function j(e){const t={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Create Document from Template"}),"\n",(0,s.jsx)(o(),{method:"post",path:"/createdocument/{template_id}",context:"endpoint"}),"\n",(0,s.jsxs)(t.p,{children:["The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at ",(0,s.jsx)(t.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(t.strong,{children:"Debug UI"})})," or using the Create Template API."]}),"\n",(0,s.jsx)(t.p,{children:"You can provide default value for all widgets based on their name all widgets support except signature, stamp, initials, image."}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"hint:"})," Specify the hint for widgets. This parameter is optional and is not applicable to the following widgets: checkbox, radio button, dropdown."]}),"\n",(0,s.jsxs)(t.ol,{children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "email",\n "readonly": false,\n "default": "email@example.com",\n "hint": "Provide email",\n "hide_text_with_asterisks": false\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"2",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "name",\n "readonly": false,\n "default": "joe",\n "hint": "Provide name",\n "hide_text_with_asterisks": false\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"3",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "job title",\n "readonly": false,\n "default": "ceo",\n "hint": "Provide job title",\n "hide_text_with_asterisks": false\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"4",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "company",\n "readonly": false,\n "default": "example pvt ltd",\n "hint": "Provide company",\n "hide_text_with_asterisks": false\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"5",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "date",\n "readonly": false,\n "default": "11-05-2025",\n "min_date": "",\n "max_date": "",\n "signing_date": false,\n "hint": "Provide date"\n}\n'})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"min_date:"})," Provide the minimum restriction date. The date must be in ",(0,s.jsx)(t.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"max_date:"})," Provide the maximum restriction date. The date must be in ",(0,s.jsx)(t.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"signing_date"}),": If signing_date is set to true, the signing date is shown to the signer during signing. You may set either signing_date or default, but not both. Using both is not supported."]}),"\n"]}),"\n",(0,s.jsxs)(t.ol,{start:"6",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "textbox",\n "readonly": false,\n "default": "my text",\n "hint": "Provide text",\n "hide_text_with_asterisks": false\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"7",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "checkbox",\n "readonly": false,\n "default": ["option-2"]\n}\n'})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"default:"})," You can have one or more than one value that needs to be selected by default."]}),"\n"]}),"\n",(0,s.jsxs)(t.ol,{start:"8",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "dropdown",\n "readonly": false,\n "default": "option1"\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"9",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "radio",\n "readonly": false,\n "default": "option1"\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"10",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"number"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "number",\n "readonly": false,\n "default": 0,\n "formula": "",\n "decimalplaces": 2,\n "hint": "Provide number",\n "hide_text_with_asterisks": false\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"11",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"cells"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "cells",\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "hide_text_with_asterisks": false \n}\n'})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"cell_count:"})," Specify the number of cells that should be returned to the user."]}),"\n"]}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"response:"})," Provide the value that should replace the existing response."]}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,s.jsx)(t.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,s.jsxs)(t.ol,{children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name":"textbox",\n "response":"andrew bee"\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"2",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "date",\n "response": "04/15/2024"\n}\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"3",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "checkbox",\n "response": ["male", "female"]\n}\n'})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"response:"})," Must be chosen from the existing values of checkbox defined in the template."]}),"\n"]}),"\n",(0,s.jsxs)(t.ol,{start:"4",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "radio button",\n "response": "male"\n}\n'})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"response:"})," Must be chosen from the existing values of radio button defined in the template."]}),"\n"]}),"\n",(0,s.jsxs)(t.ol,{start:"5",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n}\n\n'})}),"\n",(0,s.jsxs)(t.ol,{start:"6",children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:'{\n "name": "dropdown",\n "response": "female"\n}\n'})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"response:"})," Must be chosen from the existing values of dropdown defined in the template."]}),"\n"]}),"\n",(0,s.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(f.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(d(),{...n(3751)}),"\n",(0,s.jsx)(p(),{...n(69901)}),"\n",(0,s.jsx)(m(),{...n(54243)})]})}function v(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(j,{...e})}):j(e)}},3751(e){e.exports=JSON.parse('{"parameters":[{"name":"template_id","in":"path","description":"objectId of Template","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"pH1bhc2hpb"}}]}')},69901(e){e.exports=JSON.parse('{"title":"Body","body":{"content":{"application/json":{"schema":{"required":["signers"],"type":"object","properties":{"title":{"type":"string","format":"string","example":"New document title","description":"An optional parameter specifying the title for the newly created document. If omitted, the template\u2019s title will be used by default.\\n"},"signers":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","example":"Accoutnant"},"email":{"type":"string","format":"mail","example":"joe@example.com"},"name":{"type":"string","example":"joe bee"},"phone":{"type":"string","example":"123123131"},"company":{"type":"string","format":"string","example":"opensign"},"job_title":{"type":"string","format":"string","example":"dev"},"signer_role":{"type":"string","format":"string","description":"Specifies the role of the recipient in the signing process. Allowed values:\\n- **signer** (default): Must have at least one signature widget.\\n- **viewer**: Receives the document to view only; must have no widgets.\\n- **approver**: Reviews and approves the document; no signature widget required.\\n","enum":["signer","viewer","approver"],"example":"signer"},"widgets":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"textbox_1"},"readonly":{"type":"boolean","example":false},"default":{"type":"string","example":"my textbox"}},"title":"createdocumenttemplate_id_Signers_widgets"}}},"title":"createdocumenttemplate_id_Signers"}},"folderId":{"type":"string","example":""},"send_email":{"type":"boolean","description":"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \\"true\\". If the value of this parameter is \\"true\\" and no \'email_subject\'/\'email_body\' parameters are specified default email templates will be used.\\n\\nIf the field is omitted or provided as an empty/invalid value, the template value is used.\\n","example":true},"email_subject":{"type":"string","description":"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.","example":"{{sender_name}} has requested you to sign {{document_title}}"},"email_body":{"type":"string","description":"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.","example":"

Hi {{receiver_name}},

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

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

Sign here

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

Thanks,
Team OpenSign\u2122

"},"sendInOrder":{"type":"boolean","description":"**true** - Only the first signer receives the signature request email initially. Each subsequent signer is notified in sequence, only after the previous signer has completed their signing. This is the default behavior.\\n\\n**false** - All signers receive the signature request email simultaneously.\\n\\nIf the field is omitted or provided as an empty/invalid value, the template value is used.\\n","example":true},"send_in_order_strict":{"type":"boolean","description":"**true** - Each signer is blocked from accessing the document until all preceding signers have completed their action. Enforces strict sequential signing. Only applies when sendInOrder is also true.\\n\\n**false** - Signers can access the document regardless of whether previous signers have completed.\\n\\nIf the field is omitted or provided as an empty/invalid value, the template value is used.\\n","example":false},"allow_offline_sign":{"type":"boolean","description":"**true** - Signers can submit a copy of this document signed using an external tool for owner review.\\n\\n**false** - Signers must complete signing within OpenSign.\\n\\nIf the field is omitted or provided as an empty/invalid value, the template value is used.\\n","example":false},"timeToCompleteDays":{"type":"number","description":"time to complete days is used to calculate expiry date of your document. If this field is present in the request body, it overrides the template value, even when set to 0. If omitted, the template value is used.","format":"number","example":15},"enableOTP":{"type":"boolean","description":"**true** - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. \\n\\n**false** - this option will disable OTP verification, allowing users to sign the document directly without additional steps.\\n\\nIf the field is omitted or provided as an empty/invalid value, the template value is used.\\n","example":false},"enableTour":{"type":"boolean","description":"**true** - this option will enable a guided tour for signers, providing instructions during the signing process. \\n\\n**false** - disable the guided tour, ensuring a faster, uninterrupted signing experience.\\n\\nIf the field is omitted or provided as an empty/invalid value, the template value is used.\\n","example":false},"sender_name":{"type":"string","description":"The name of the person or organization on whose behalf the email is being sent. If this field is present in the request body, it overrides the template value, even when set to an empty string (\\"\\"). If omitted, the template value is used.\\n\\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to \\"\\".\\n","example":"opensign\u2122"},"sender_email":{"type":"string","description":"The email address of the person or organization that users can reply to. If this field is present in the request body, it overrides the template value, even when set to an empty string (\\"\\"). If omitted, the template value is used.\\n\\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to \\"\\".\\n","example":"mailer@opensignlabs.com"},"allow_modifications":{"type":"boolean","description":"**true** - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. \\n\\n**false** - Restricts signers from adding any additional elements to the document. This is the default value.\\n\\nIf the field is omitted or provided as an empty/invalid value, the template value is used.\\n","example":false},"file":{"type":"string","description":"You may provide the base64 encoded PDF file to replace the existing one","format":"base64","example":""},"file_password":{"type":"string","format":"string","example":""},"auto_reminder":{"type":"boolean","description":"Set to true to enable automatic reminders. Set to false to disable them (default behavior). If the field is omitted or provided as an empty/invalid value, the template value is used.","example":false},"remind_once_in_every":{"type":"number","description":"Number of days between reminders. This is only applicable when auto_reminder is set to true. If this field is present in the request body, it overrides the template value, even when set to 0. If omitted, the template value is used.","example":5},"merge_certificate":{"type":"boolean","description":"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\\n\\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\\n\\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\\n","example":false},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"redirect_url":{"type":"string","description":"Specifies the URL where the signer will be redirected upon completing the document signing process. If this field is present in the request body, it overrides the template value, even when set to an empty string (\\"\\"). If omitted, the template value is used.","example":""},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed.\\nIf this field is present in the request body, it overrides the template value, even when provided as an empty array ([]).\\nIf omitted or provided empty string (\\"\\") the template value is used.\\n"},"prefill":{"type":"object","properties":{"widgets":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","format":"string","example":"textbox"},"response":{"type":"string","format":"string","example":"andrew bee"}}}}}}},"title":"createdocument_template_id_body"}}},"required":true}}')},54243(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Document created successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"hji2zxcv2P"},"signurl":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","format":"string","example":"mail@example.com"},"url":{"type":"string","format":"string","example":"https://url-to-sign-document.com"}},"title":"inline_response_doc_signurl"}},"message":{"type":"string","format":"string","example":"Document sent successfully!"}},"title":"inline_response_doc"}}}},"400":{"description":"If you haven\'t add widgets and signers in template or not provide signers along with their roles in body","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","format":"string","example":"Please setup template properly!"}},"title":"inline_response_400_cc"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/503125be.d29ef590.js b/assets/js/503125be.d29ef590.js deleted file mode 100644 index 81a4f7ea5..000000000 --- a/assets/js/503125be.d29ef590.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[5372],{39546(e,t,o){o.r(t),o.d(t,{assets:()=>x,contentTitle:()=>F,default:()=>T,frontMatter:()=>f,metadata:()=>n,toc:()=>b});const n=JSON.parse('{"id":"API-docs/v1.2/deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","source":"@site/docs/API-docs/v1.2/deletedocument.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/deletedocument","permalink":"/docs/API-docs/v1.2/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":"eJy9WFFvG7kR/itTPrSJsJZkx3eH7r3UbYycUeMSnH0IUFswqOWslmcuySNnJQuCgHvoP+hTX/vT8ksOw92VVraTS9D2XhItOTP85pvhzNAbQXIRRX4jXruiqdFSFLNMKIxF0J60syIX1xXCazRICKqTgrN3FyCNcasIa9cAOQhYuyVC9FjoUhd70TK4moXCbimORSacxyD5hAslcqGS/V5AZMLLIGskDIxuI6yskcU6gTutRCY0o/OSKvEY8rvgllohuPlPWNCFAlfuAZGD9jiRiYA/NzqgEjmFBjMRaW34oKhrb1gAH7xxCkVeShNZoKiwliLfCFr7JElB24XIROlCLWm4gg8yWcmFr07m1YmMSmy3Mz41emcjRrZzMp3yf4cO9OHokCqITVFgjGVjzPoPIhOFs8RM5RshvTe6SFxOfoqsvnkKs2WCiQ3MPOn28J6g5xzaw//rA4P33/lXYpv1sTqjTyudTE9eHR1Pj6bfXB9/nZ/+Of/q6/F0Ov2HyMRDbVi3D6okZLukyey/t0/E2pgNBbuVLQufPkfjlauRKm0XsGIyV8HZRQbeoIwIFNYgF1JbMJIw/A9ZxRBc+DQ7X4ZsO/BaW6Mt3vU5dHc6nd4d70g4/UQuWUdQusaq39fV587/tEOnd692Dn311KELu5RGq1SErt092t/Xn+Hx1B7/NFt1K5T2xYGzw/XWyYhFEzStU6V7OJJeH7X7+c2MywVnittXyVQdqRK5mPQ1bbIZVMatYJNh2dfOJhiRi4rIx3wyidKquXsYO4826oU1ch7Hhasn0uvJ8nh8IrbZYx3p/RfJY3P0pSqR5ELbxW/pzfZsXXFE26AdcLYLnfT677gWWR+SoVTXPCqUCkMKn7alS8pdoN56tFd6YVOY0+GPm8x7NIWrkfsJVQijUa/y4Z//2WmNRrvGkxJyfGtv7dsmgHcrDGVjQFoFpcEHPTeY1LBOe7vOGlHWBmM0a9CWcBEkd2K90CQNME9cRQrp5VwbzXnMYq5tuYOrEMfwvkKqMPDWnwKCBIVLNJz+IBtytSQ2tWuUKxfuS+7xGUiYN1FbjBHQVtIWLNhHIgMXQFpASxh80BEhUmDUusXmLAVZENTSygWy7QyGZCk0mtMVgps3kSA60yTIQFIbF1BB75BFVDGReM6dOSDwauFqH7DitFkiLBqtMGZQOIUQ07VlF6yCOUYCz1h0gZGNNta44j4FkHsreMdVREvDI8MQI6tTkDZyn+/mmS4GO8J8cNyksQU4Gv0YkSN8qe19zEejW3sEN7u8eo/zqAlnL/orsFqtnqT+y0OdN5q+a+bwA3oXNbmw3msvNFXNPF2XoZHdR2vpDVpM+TO4DHsbyhXx6e3j1UmFxk+ukDhD4uTs3UUqvC/hwy//gkuUwULlVm22Fk1As4ZFfxQz10a+pW1XN6F0KfEqZrxok48HMozUM/i+kvThl39H+B5XoG13pdiV0egNElxj7blHwh/h4PNSRxqN8m4qVdBYixwaGdawHy0TtIi8wDOWD1hqY0BJku3YyjxgGGiM+ehbUWqDd17GuHJB3Yq9AEilUDHSIiADoQ5RBo1XhwudxP66aaoG2yrIkva7LVRTJkwQXENtAvtu1O3RJFJ9cIRF8kmVPeg0r9+5skztls18FvJ08iPwg/OTVWgi00kO0EquY45vR2x/tgfuKhXjowp12FnrAbZs3wVn8HlkfEtbodiN9mmwPyDqCa+/SfSTSLHDvpkbXTx2eAxnRYGeiV1K02DMYTRqEY1G8EJhKRtDLzMYjZYaV7zKv6XnKPHXGK46/DUXukouESQBj30ErmNJUhMQVlotkL6F1tBQwbpuM34LvekItVx39uy630+uuoZADgx3bx6mYnzLrfBR+zzscgFLTE+3FN79pfa6u8Q3fTEArhH/TTHhOYl7hSzSGIe11Kbt4395bCeNVBjq+La8wrDUBXazxEfq6CQJT0QmjC7QRhyMamdv3l3C8tV4KrLBUPIZJXVyefG38++vzhkMh6Al7Hg8HU95ybtItbSDk7pX9Ov9M/eA681+iP0/Pbq7yYjwgSbeSJ1G0+Tzppspb8TgEZ4P39uzTFQuEotsNnMZ8cdgtlte/rnBwMPrLBNLGTTf+jR4dhVA7R7PH/X2xQ/dO/wlfPbT/Vlf+tHP8tyXrqjIhcjEPa4f/flgO9tm/fzHYFuJ9noPdJ+8JQ4G8tfnl+fX5yIT3MUOR8/7NHp2P/iAZ6EdzqQtBv6XB+RnFTabdqzdbnfy7dZHNTofe2nmabbdbn8FTn5ZEA==","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Revoke Document","permalink":"/docs/API-docs/v1.2/revokedocument"},"next":{"title":"Get Document list from status","permalink":"/docs/API-docs/v1.2/getdocumentlist"}}');var s=o(74848),i=o(28453),d=o(57742),a=o.n(d),l=o(78178),r=o.n(l),c=o(19624),u=o.n(c),m=o(96226),p=o.n(m),h=(o(77675),o(19365),o(51107)),y=o(21312);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:"eJy9WFFvG7kR/itTPrSJsJZkx3eH7r3UbYycUeMSnH0IUFswqOWslmcuySNnJQuCgHvoP+hTX/vT8ksOw92VVraTS9D2XhItOTP85pvhzNAbQXIRRX4jXruiqdFSFLNMKIxF0J60syIX1xXCazRICKqTgrN3FyCNcasIa9cAOQhYuyVC9FjoUhd70TK4moXCbimORSacxyD5hAslcqGS/V5AZMLLIGskDIxuI6yskcU6gTutRCY0o/OSKvEY8rvgllohuPlPWNCFAlfuAZGD9jiRiYA/NzqgEjmFBjMRaW34oKhrb1gAH7xxCkVeShNZoKiwliLfCFr7JElB24XIROlCLWm4gg8yWcmFr07m1YmMSmy3Mz41emcjRrZzMp3yf4cO9OHokCqITVFgjGVjzPoPIhOFs8RM5RshvTe6SFxOfoqsvnkKs2WCiQ3MPOn28J6g5xzaw//rA4P33/lXYpv1sTqjTyudTE9eHR1Pj6bfXB9/nZ/+Of/q6/F0Ov2HyMRDbVi3D6okZLukyey/t0/E2pgNBbuVLQufPkfjlauRKm0XsGIyV8HZRQbeoIwIFNYgF1JbMJIw/A9ZxRBc+DQ7X4ZsO/BaW6Mt3vU5dHc6nd4d70g4/UQuWUdQusaq39fV587/tEOnd692Dn311KELu5RGq1SErt092t/Xn+Hx1B7/NFt1K5T2xYGzw/XWyYhFEzStU6V7OJJeH7X7+c2MywVnittXyVQdqRK5mPQ1bbIZVMatYJNh2dfOJhiRi4rIx3wyidKquXsYO4826oU1ch7Hhasn0uvJ8nh8IrbZYx3p/RfJY3P0pSqR5ELbxW/pzfZsXXFE26AdcLYLnfT677gWWR+SoVTXPCqUCkMKn7alS8pdoN56tFd6YVOY0+GPm8x7NIWrkfsJVQijUa/y4Z//2WmNRrvGkxJyfGtv7dsmgHcrDGVjQFoFpcEHPTeY1LBOe7vOGlHWBmM0a9CWcBEkd2K90CQNME9cRQrp5VwbzXnMYq5tuYOrEMfwvkKqMPDWnwKCBIVLNJz+IBtytSQ2tWuUKxfuS+7xGUiYN1FbjBHQVtIWLNhHIgMXQFpASxh80BEhUmDUusXmLAVZENTSygWy7QyGZCk0mtMVgps3kSA60yTIQFIbF1BB75BFVDGReM6dOSDwauFqH7DitFkiLBqtMGZQOIUQ07VlF6yCOUYCz1h0gZGNNta44j4FkHsreMdVREvDI8MQI6tTkDZyn+/mmS4GO8J8cNyksQU4Gv0YkSN8qe19zEejW3sEN7u8eo/zqAlnL/orsFqtnqT+y0OdN5q+a+bwA3oXNbmw3msvNFXNPF2XoZHdR2vpDVpM+TO4DHsbyhXx6e3j1UmFxk+ukDhD4uTs3UUqvC/hwy//gkuUwULlVm22Fk1As4ZFfxQz10a+pW1XN6F0KfEqZrxok48HMozUM/i+kvThl39H+B5XoG13pdiV0egNElxj7blHwh/h4PNSRxqN8m4qVdBYixwaGdawHy0TtIi8wDOWD1hqY0BJku3YyjxgGGiM+ehbUWqDd17GuHJB3Yq9AEilUDHSIiADoQ5RBo1XhwudxP66aaoG2yrIkva7LVRTJkwQXENtAvtu1O3RJFJ9cIRF8kmVPeg0r9+5skztls18FvJ08iPwg/OTVWgi00kO0EquY45vR2x/tgfuKhXjowp12FnrAbZs3wVn8HlkfEtbodiN9mmwPyDqCa+/SfSTSLHDvpkbXTx2eAxnRYGeiV1K02DMYTRqEY1G8EJhKRtDLzMYjZYaV7zKv6XnKPHXGK46/DUXukouESQBj30ErmNJUhMQVlotkL6F1tBQwbpuM34LvekItVx39uy630+uuoZADgx3bx6mYnzLrfBR+zzscgFLTE+3FN79pfa6u8Q3fTEArhH/TTHhOYl7hSzSGIe11Kbt4395bCeNVBjq+La8wrDUBXazxEfq6CQJT0QmjC7QRhyMamdv3l3C8tV4KrLBUPIZJXVyefG38++vzhkMh6Al7Hg8HU95ybtItbSDk7pX9Ov9M/eA681+iP0/Pbq7yYjwgSbeSJ1G0+Tzppspb8TgEZ4P39uzTFQuEotsNnMZ8cdgtlte/rnBwMPrLBNLGTTf+jR4dhVA7R7PH/X2xQ/dO/wlfPbT/Vlf+tHP8tyXrqjIhcjEPa4f/flgO9tm/fzHYFuJ9noPdJ+8JQ4G8tfnl+fX5yIT3MUOR8/7NHp2P/iAZ6EdzqQtBv6XB+RnFTabdqzdbnfy7dZHNTofe2nmabbdbn8FTn5ZEA==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},F=void 0,x={},b=[];function I(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:"Delete Document"}),"\n",(0,s.jsx)(a(),{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:(0,s.jsx)(y.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(r(),{...o(86823)}),"\n",(0,s.jsx)(u(),{...o(52973)}),"\n",(0,s.jsx)(p(),{...o(17955)})]})}function T(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(I,{...e})}):I(e)}},86823(e){e.exports=JSON.parse('{"parameters":[{"name":"document_id","in":"path","description":"Provide objectId of document to delete","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"ph2bh2asd"}}]}')},52973(e){e.exports={title:"Body"}},17955(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Document deleted successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","example":"Bxh2aspHp3"},"deletedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"xml":{"name":"delete"},"title":"delete"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"Document not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Document not found!"}},"title":"inline_response_404_3"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/503125be.e73d9822.js b/assets/js/503125be.e73d9822.js new file mode 100644 index 000000000..1bd5e5f78 --- /dev/null +++ b/assets/js/503125be.e73d9822.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[5372],{39546(e,t,n){n.r(t),n.d(t,{assets:()=>x,contentTitle:()=>K,default:()=>b,frontMatter:()=>B,metadata:()=>o,toc:()=>D});const o=JSON.parse('{"id":"API-docs/v1.2/deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","source":"@site/docs/API-docs/v1.2/deletedocument.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/deletedocument","permalink":"/docs/API-docs/v1.2/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":"eJy9WV9vG8cR/yrTNVBIxJGUbCdFmSKtIimOUTcWRKkGKgri8nbI23Bv97K7dxQhEchD0Q9Q9KWv/RJ970fxJylm9+54lBQ7Rto82JLuZuf//GZ27o55vnBsdMVOTFrmqL1j1wkT6FIrCy+NZiN2kSGcoEKPIGoqODp7DVwps3KwNiV4AxZzUyG4AlM5l+mWdG5NTkS2feQGLGGmQMtJwmvBRkwE/g0BS1jBLc/RoyXt7pjmORJZTXAjBUuYJO0K7jP2UOUzayopEMzsO0z9awFmvlXIG4jiWMIsfl9Ki4KNvC0xYc6vFQlyMi8UEeBtoYxANppz5YggzTDnbHTH/LoIlN5KvWAJmxubc999grc8cBmxIns+y55zJ9hmc01SXWG0Q0d8nh8c0I9dA5pw1JoKcGWaonPzUqn1r1jCUqM9eWp0x3hRKJkGXw6/c3T87rGa0RPkWEue9zIKbxz0lEFb9b+6JeWLb4oXbJM0sTryHz70/OD5i/7hQf/gNxeHn49e/nb02eeDg4ODv7CE3eaKzjZB5R6Jr5debf/ePCKLMesS1k82RPzyKTeOTY4+k3oBK3Lmyhq9SKBQyB2Ct2vgCy41KO7R/g+9itYa+2HvfJpmm47VUiup8abJoZuXBwc3h60TXn4gl7TxMDelFr+sqU/J/7BBL29etAZ99tig17riSooAQhdmifqXtacr3kfxj7NVRqLwnu0Y230ejXSYllb6dUC62z4vZD++H11dE1xQppgtSgZ09BkbsWGDacO7DjJuGLG0VYOdpVVsxDLvCzcaDh3XYmZuB6ZA7eRCKz5zg9TkQ17IYXU4eM42ycMzvCg+iR7L/qcecZ4vpF587Nz11ltjimgM2o7P2tDxQv4R1yxpQtKlqptHhlygDeGTem7C4TpQbwvUY7nQIcxB+MMm8wwamvd//VdLNtET/SX0etQ1yZC+M6VNEagKAj+uPFrNvawQ3v/wD5iVUlFdWBBYoaJkdAl4WzrC/dkaUHu0hZUO3aDXI/5duQtZYWzCHFJDKeoxgcIaUaakaN8iF2vAPnmU+9IiFIp76lbgM2vKRQYcnNQLhQmcn44v5qUiawYwRi22TTuo2DJJIOeaLxA85sQPg848XQYSwjXnuS8dSA0WuQIvc0yAawG89CbnHuNQgNpL25kslJxjuk5VdA5XClbSZ6b0UKEWxoIy6bIv9YAc0e/36cezZ/AKvSepY8+tR0FPTyu0a6AOj85DXjoPKbd2HeW21Usa+gxh2smPKcTMCEKm0+lEd16O4HfEYfvgy5pmonu993/7O1x9Y1Y0ZSxQ04yDDwRe7zVJL0zqHmc7PR1mqIrhOBrlhkdnrwPQ7cf4f2s8OIrkKkOLJGqGC6l/D5fUPDKEXq8uc0BdSWs0ubbXg73pT4aB6T7xLazxhuqpjQKfzzENrlaUwYJ7/iAUx8YiHPOCz6SShKv0/B6OuceFsWu4h3cZ9yFlU65BGLif6Pt+vx/+EWmv146jvR7cw7FFTlntUIsEykKEvyxWZlnnVETGbXr2m7Bv07fmfNHka+D8VSmVAIul4zPVSeZgLhQW+4XiKQpYSbFA774IOpBnjEYwlqpgHcSibUWMUc37VJ9BxKsmCxw9DqTdqmr9WnMBqSvpQ/OCuTKrhulZOVMyhV31xxm3CByK+LIpPSX1MpSPNg1XJZ2HZtpteJ5YPvfwztglSYoceYUd7Yzt+IQ7EHTCBZfPpeZKxoTL46DS8D022vO0Dt6fIk6EGqiVSeN7mBmzpBRbWJ7n3MuUK7VumHxtlEAbeby1C65J1lYzqR1N+C1Mn1hKx3k81PB4h7PMmGVkco4pEg3BUZ/gCLCqxxK6sQSXO4iZacGsNKAWhZHaN+wuXaPQOXorsULgaWpK7YNHUotCeqBOQlcBiuD9bmlQ4r//4Z8OvsUV4U7TMJ5R2Sjk5Jwmwo0MriZ6+ur0AoZNJIYjKaZB4u5zivEUMorgDFGD8xZ5TsOVCNlgUZRacO1he7sCSqB4dxOBZa9XWJxLpUJpg3SgzQos+tISH4d01qNax4tdHdEtw16PWsOS0rC95gByJ9FS2aRGuzLHQWP1GXduZazon1njMaWWd3byNYzLojDWTzS9h+mEzaXCm6ImnrBpg9pNnc+MWBMcalgZG6SHCkad2nVRc3WDhi8KMHo00dOzt+MLGKYBXxo3TuE//4bp2eUjj4fHnQPt9DVq6G52yUK1NFSPXjyQF14QRpBLp41/3s7nFEAY16VNpWWNmugxevJLuITfmEh1Q0cnbETTA8I9hDvrFIyGHzE05NATlnoDdPGVqfSKBpAAjjShyIiTtbwWcGg0QJ5mLVi08R3H/Dg3ivoADUXTGi2n9e085BdPUywIWMimSHBjjUKK9FyiEsBTa5wLA0GwgqrLmtKjG8BFZhGB6GM+uybKo9h6SDqBPWa8klTcDxtOrdMUensC57xUfj9AV5gZ6qGKkIGuZz5A/3aaip0hQsS0krgiPi3auJCl22WIsdS3JK7AaLVuQLruLnGl0uDzlBeFNVVkd8x1rGzqNw053pLX6tYRtakhPgi7b6GF25nRcGyKNewdH++TcrKQhKMTfQQaV+T2NN16uy771pHAldGLgLhkD95KF2aA6YTNuueMbm1N2mRIYtsI2dY2wTaKw9jP22Ce5lwq4EJYdIQdhGooqN5bHW2N5JwGupnR/ZQs6+I4YOBidIq7AZCuDagYwBu5xK0NCam/ow3suTLNqPHFKtlWvBTTfWpdlRS1H6JqFC8rRR33xgNQcVViEhpORCnyrJLkWOqmgHnh18Ct5WvYm15dT/e/AJNLH7hE13oDUmdo64e7rB+MYEcVlypU6ul2/qvnsM4TqgnaN1yev3liBhvHETH0u0+YG9uBpb2C7HL44A2vPX16Cee4eHT4YzfL6cOO+2e0TpoAUr+Gr3i6XHErHBybvOBehgl1TaR0mJIjLNhg1hD205pQxQkYqsOQxtXh4LC9oDRjgost0WfGIVRRcAQk3sbDUNuSDmaN3wNXbWBmMXbNNON6QYVAM0KnUUsCflGmsRaCvsTahOsoV1Bqhc6B8RnaFc1K2lCO77rj0iFd795IvQzp0IerdoJ6hzMnPW6vJ6vV6pGn98OZr0uloJnRQ8F95FITj72S/ptyBudYGCe9sevtqYX0WTkLseyebf+oGTSzdLv6+TmXqcDyAm3uaD88RlvJ9CPmDz2RD/cntEJ4sHbY3Q5YnGNYebudqyAvZH3tvGr0AFLv59hB+6V6pA4rLIK+uP/4w0M+YRVFJryd1/bWO5gP28sSpmSK2mFnxXX06uwNVC8GByzpLHN+QiyHb14fn347PiVl6jJhI3Y4OBgc0KPCOJ9z3ZFUf3042X4e2PH13Xb593/6WFFvlDze+mGhuAwrvWDzXb2Lu2Kdjxej7neK64Rlxnkiubujsr+0arOhx9+XaGnpd52wiltJ+BAWdvWUJdqPDj9q7d55faPbh5/8yeNJW5qVmaZ9WegobMRYwpa4fvDZZXO9SZq9GSkbKY7C/NY5+2gHu7PIPDl9c3pxyhLGS3Jed2W3DCu7+hcS8KRqu7u8qAP9T4vFJw/c3cV14GbT0sdXP3qitrGhJj9dbzab/wIRoaCX","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Revoke Document","permalink":"/docs/API-docs/v1.2/revokedocument"},"next":{"title":"Get Document list from status","permalink":"/docs/API-docs/v1.2/getdocumentlist"}}');var a=n(74848),c=n(28453),s=n(57742),d=n.n(s),i=n(78178),l=n.n(i),p=n(19624),u=n.n(p),m=n(96226),r=n.n(m),h=(n(77675),n(19365),n(51107)),v=n(21312);const B={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:"eJy9WV9vG8cR/yrTNVBIxJGUbCdFmSKtIimOUTcWRKkGKgri8nbI23Bv97K7dxQhEchD0Q9Q9KWv/RJ970fxJylm9+54lBQ7Rto82JLuZuf//GZ27o55vnBsdMVOTFrmqL1j1wkT6FIrCy+NZiN2kSGcoEKPIGoqODp7DVwps3KwNiV4AxZzUyG4AlM5l+mWdG5NTkS2feQGLGGmQMtJwmvBRkwE/g0BS1jBLc/RoyXt7pjmORJZTXAjBUuYJO0K7jP2UOUzayopEMzsO0z9awFmvlXIG4jiWMIsfl9Ki4KNvC0xYc6vFQlyMi8UEeBtoYxANppz5YggzTDnbHTH/LoIlN5KvWAJmxubc999grc8cBmxIns+y55zJ9hmc01SXWG0Q0d8nh8c0I9dA5pw1JoKcGWaonPzUqn1r1jCUqM9eWp0x3hRKJkGXw6/c3T87rGa0RPkWEue9zIKbxz0lEFb9b+6JeWLb4oXbJM0sTryHz70/OD5i/7hQf/gNxeHn49e/nb02eeDg4ODv7CE3eaKzjZB5R6Jr5debf/ePCKLMesS1k82RPzyKTeOTY4+k3oBK3Lmyhq9SKBQyB2Ct2vgCy41KO7R/g+9itYa+2HvfJpmm47VUiup8abJoZuXBwc3h60TXn4gl7TxMDelFr+sqU/J/7BBL29etAZ99tig17riSooAQhdmifqXtacr3kfxj7NVRqLwnu0Y230ejXSYllb6dUC62z4vZD++H11dE1xQppgtSgZ09BkbsWGDacO7DjJuGLG0VYOdpVVsxDLvCzcaDh3XYmZuB6ZA7eRCKz5zg9TkQ17IYXU4eM42ycMzvCg+iR7L/qcecZ4vpF587Nz11ltjimgM2o7P2tDxQv4R1yxpQtKlqptHhlygDeGTem7C4TpQbwvUY7nQIcxB+MMm8wwamvd//VdLNtET/SX0etQ1yZC+M6VNEagKAj+uPFrNvawQ3v/wD5iVUlFdWBBYoaJkdAl4WzrC/dkaUHu0hZUO3aDXI/5duQtZYWzCHFJDKeoxgcIaUaakaN8iF2vAPnmU+9IiFIp76lbgM2vKRQYcnNQLhQmcn44v5qUiawYwRi22TTuo2DJJIOeaLxA85sQPg848XQYSwjXnuS8dSA0WuQIvc0yAawG89CbnHuNQgNpL25kslJxjuk5VdA5XClbSZ6b0UKEWxoIy6bIv9YAc0e/36cezZ/AKvSepY8+tR0FPTyu0a6AOj85DXjoPKbd2HeW21Usa+gxh2smPKcTMCEKm0+lEd16O4HfEYfvgy5pmonu993/7O1x9Y1Y0ZSxQ04yDDwRe7zVJL0zqHmc7PR1mqIrhOBrlhkdnrwPQ7cf4f2s8OIrkKkOLJGqGC6l/D5fUPDKEXq8uc0BdSWs0ubbXg73pT4aB6T7xLazxhuqpjQKfzzENrlaUwYJ7/iAUx8YiHPOCz6SShKv0/B6OuceFsWu4h3cZ9yFlU65BGLif6Pt+vx/+EWmv146jvR7cw7FFTlntUIsEykKEvyxWZlnnVETGbXr2m7Bv07fmfNHka+D8VSmVAIul4zPVSeZgLhQW+4XiKQpYSbFA774IOpBnjEYwlqpgHcSibUWMUc37VJ9BxKsmCxw9DqTdqmr9WnMBqSvpQ/OCuTKrhulZOVMyhV31xxm3CByK+LIpPSX1MpSPNg1XJZ2HZtpteJ5YPvfwztglSYoceYUd7Yzt+IQ7EHTCBZfPpeZKxoTL46DS8D022vO0Dt6fIk6EGqiVSeN7mBmzpBRbWJ7n3MuUK7VumHxtlEAbeby1C65J1lYzqR1N+C1Mn1hKx3k81PB4h7PMmGVkco4pEg3BUZ/gCLCqxxK6sQSXO4iZacGsNKAWhZHaN+wuXaPQOXorsULgaWpK7YNHUotCeqBOQlcBiuD9bmlQ4r//4Z8OvsUV4U7TMJ5R2Sjk5Jwmwo0MriZ6+ur0AoZNJIYjKaZB4u5zivEUMorgDFGD8xZ5TsOVCNlgUZRacO1he7sCSqB4dxOBZa9XWJxLpUJpg3SgzQos+tISH4d01qNax4tdHdEtw16PWsOS0rC95gByJ9FS2aRGuzLHQWP1GXduZazon1njMaWWd3byNYzLojDWTzS9h+mEzaXCm6ImnrBpg9pNnc+MWBMcalgZG6SHCkad2nVRc3WDhi8KMHo00dOzt+MLGKYBXxo3TuE//4bp2eUjj4fHnQPt9DVq6G52yUK1NFSPXjyQF14QRpBLp41/3s7nFEAY16VNpWWNmugxevJLuITfmEh1Q0cnbETTA8I9hDvrFIyGHzE05NATlnoDdPGVqfSKBpAAjjShyIiTtbwWcGg0QJ5mLVi08R3H/Dg3ivoADUXTGi2n9e085BdPUywIWMimSHBjjUKK9FyiEsBTa5wLA0GwgqrLmtKjG8BFZhGB6GM+uybKo9h6SDqBPWa8klTcDxtOrdMUensC57xUfj9AV5gZ6qGKkIGuZz5A/3aaip0hQsS0krgiPi3auJCl22WIsdS3JK7AaLVuQLruLnGl0uDzlBeFNVVkd8x1rGzqNw053pLX6tYRtakhPgi7b6GF25nRcGyKNewdH++TcrKQhKMTfQQaV+T2NN16uy771pHAldGLgLhkD95KF2aA6YTNuueMbm1N2mRIYtsI2dY2wTaKw9jP22Ce5lwq4EJYdIQdhGooqN5bHW2N5JwGupnR/ZQs6+I4YOBidIq7AZCuDagYwBu5xK0NCam/ow3suTLNqPHFKtlWvBTTfWpdlRS1H6JqFC8rRR33xgNQcVViEhpORCnyrJLkWOqmgHnh18Ct5WvYm15dT/e/AJNLH7hE13oDUmdo64e7rB+MYEcVlypU6ul2/qvnsM4TqgnaN1yev3liBhvHETH0u0+YG9uBpb2C7HL44A2vPX16Cee4eHT4YzfL6cOO+2e0TpoAUr+Gr3i6XHErHBybvOBehgl1TaR0mJIjLNhg1hD205pQxQkYqsOQxtXh4LC9oDRjgost0WfGIVRRcAQk3sbDUNuSDmaN3wNXbWBmMXbNNON6QYVAM0KnUUsCflGmsRaCvsTahOsoV1Bqhc6B8RnaFc1K2lCO77rj0iFd795IvQzp0IerdoJ6hzMnPW6vJ6vV6pGn98OZr0uloJnRQ8F95FITj72S/ptyBudYGCe9sevtqYX0WTkLseyebf+oGTSzdLv6+TmXqcDyAm3uaD88RlvJ9CPmDz2RD/cntEJ4sHbY3Q5YnGNYebudqyAvZH3tvGr0AFLv59hB+6V6pA4rLIK+uP/4w0M+YRVFJryd1/bWO5gP28sSpmSK2mFnxXX06uwNVC8GByzpLHN+QiyHb14fn347PiVl6jJhI3Y4OBgc0KPCOJ9z3ZFUf3042X4e2PH13Xb593/6WFFvlDze+mGhuAwrvWDzXb2Lu2Kdjxej7neK64Rlxnkiubujsr+0arOhx9+XaGnpd52wiltJ+BAWdvWUJdqPDj9q7d55faPbh5/8yeNJW5qVmaZ9WegobMRYwpa4fvDZZXO9SZq9GSkbKY7C/NY5+2gHu7PIPDl9c3pxyhLGS3Jed2W3DCu7+hcS8KRqu7u8qAP9T4vFJw/c3cV14GbT0sdXP3qitrGhJj9dbzab/wIRoaCX",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},K=void 0,x={},D=[];function g(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:"Delete Document"}),"\n",(0,a.jsx)(d(),{method:"delete",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,a.jsx)(t.p,{children:"The Delete document API allows you to remove specific document from your documents."}),"\n",(0,a.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,a.jsx)(v.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,a.jsx)(l(),{...n(86823)}),"\n",(0,a.jsx)(u(),{...n(52973)}),"\n",(0,a.jsx)(r(),{...n(17955)})]})}function b(e={}){const{wrapper:t}={...(0,c.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(g,{...e})}):g(e)}},86823(e){e.exports=JSON.parse('{"parameters":[{"name":"document_id","in":"path","description":"Provide objectId of document to delete","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"ph2bh2asd"}}]}')},52973(e){e.exports={title:"Body"}},17955(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Document deleted successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","example":"Bxh2aspHp3"},"deletedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"xml":{"name":"delete"},"title":"delete"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"Document not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Document not found!"}},"title":"inline_response_404_3"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/51e6fce0.875c4a9e.js b/assets/js/51e6fce0.875c4a9e.js deleted file mode 100644 index 82703f122..000000000 --- a/assets/js/51e6fce0.875c4a9e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[5174],{30761(e,t,r){r.r(t),r.d(t,{assets:()=>P,contentTitle:()=>O,default:()=>J,frontMatter:()=>v,metadata:()=>o,toc:()=>w});const o=JSON.parse('{"id":"API-docs/v1.2/createfolder","title":"Create Folder","description":"The Create Folder API allows you to create folder.","source":"@site/docs/API-docs/v1.2/createfolder.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/createfolder","permalink":"/docs/API-docs/v1.2/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":"eJzNWF9vI7cR/ypTPrQ5YS3Jzl2Kbl7qBterU+POiB0cUNswRruzWp65JENyJQuCgDz0G/Spr/1o90mKIXellXS5xG0R9EXQkjPDmd/84W93LQLOvchvxZ+NKsmJ+0yU5AsnbZBGi1zc1ATfOMJAkETg/OoCUCmz9LAyLQQDRdqv4v5YZMJYcsgGLkqRi7SddkUmHP3Qkg9/MuVK5OuD466cWciSYEbKLMGiw4YCuaNTRCYKowPpwDbQWiWLeOLkg2dDa+GLmhrkf3ygdFRymElbY0McalhZErkwsw9UBJEJ69jzIMmzXpJ9y7L5upf1wUk9F5mojGswDFfoCRurWEjTsvdzkwmLjnRI6DEgz7MlNptMBBniQzL6MGPsNryxiy24luKCt0b7FMHZdHoMcbLRwVmCb4uCvK9apVa/eQ6snwcvLT8/XFufzuqnsw+Wkfv/yMC3Zxr9q0d5RWyrw+08fMrMTulsevblyen0ZPr7m9Ov8pd/yF99NZ5Op38TmXhqFOvGIsxFiSHa7VPcP7e2/BXO2RyKJdBKCiiVF0elx1W3ycTLTxXWtWko1FLPYUk6wNIZPc/AKkJPENwKcI5Sg8JA7n9YaeSccZ8H6XmeDRtOaiU1PfRd9fByOn043YLw6hiEC71AJcs4JW/MI+lfN9Lh8SEdf5xjmYTivtgLdriegvRUtE6Glchv1+LpBK08Sfv57f3mPhMMrOEpb42PHmOoRS4mB0Pfk1uQ89FK65TIRR2C9flk4lGXM/M0Npa0l3OtcObHhWkmaOVkcTo+E5vsUAetfZY8tSfPVfEB51LPf07vfofQNWcxJWoPp2260Mq/0kpkfRqGUpmQXD01YWqyTHBxfLe7Kl/3Kd6/l4aD7njOCc6u1JWJXnRZfmdJX8u5jjUSozi889+TKkxDfOmGmmA06lU+/v1fW63RCEpTtA3pEKt5fKfv9LvWgTVLclWrAHUJlaInOVMU1aiJe1ve4AkbRd6rFUgdaO74fi/lXAZUwIBzxxZocSaV5CZgMcPaDgZ95MfwvqZQk+Ot3zkChJIWpLh3ANtgGgxsqvcXlsY9VsxgMkCYtV5q8h5I16gLFuxTmoFxgBpIB3LWSU/gg2OvZfLN6OCwCNCgxjmx7QyGYJWkJNc9ODNrfQBvVBtdBp6vxlEJfUCaqPQRxNdPlreAVwvTWEc119+CYN7KknwGhSkJfCwIDkGXMCMfwLIvsiDPRlutTPEYE8h3O1jDI0iiAlPt+cjqwaH2fAcmX/ocbAGzzjBJoOTgaPS9J87wpdSPPh+N7vQJ3G7r6j3NvAx0/0XfS8vl8qiHXuzrvJHhL+0MviNrvAzGrXbacxnqdhb7bmhk+5AsvSFNsX4GXbWzUZrCH7cxr05qUnZyTYErxE/Ory7i1H4BH3/8B1wSOg21WaZqLVpHagXz/ihGLmU+wbYdulCZWHg1I16k4utob4/g+xrDxx//6eEtLUHqrqU4lNHoDQW4ocbyfQS/hb3HS+nDaJSDo8YsqIRWa+LUoFvt6LKPrnniBeZ41lEllYISA0LlTBO7i9xAY8xH34lKKnqw6P3SuPJODBg4liWV7GnHw0PnUQaJqQwWOoldu8lQD7ZLh1XY7SZXVRV9AmfakArYdq8CvTcRVOtMoCLGVFa90/Ft5MFUVbyr2cwv8jyefOD84PxoFVrPcAYDpJHnmOHu8OlvOnA7qdi/UJN0W2u9gwntB2cUfdoz7tIk5CFd/tyl+0Ad4fqzQB9ligO27UzJ4jDgMZwXBVkGdoGqJZ/DaJQ8Go3gi5IqbFV4kcFotJC05FX+j5azxE9juO78b3jQ1bggwABMsQKYDiUMrSNYynJO4WtIhoYK2nSb/mvoTXtocNXZ06t+P4Zq2gA4MNy9DDEU4zu+Uw/u4f1bzlFFjrGL6d01tZVdE9/2wwB4Rvw3wyS+NxgdsIgckBqUKhGCPx7aiXyMXOPfVdfkFrKgjpT8xBydROGJyISSBWlPA553/ubqEhZfjqciG7CbXzBSJ5cX37x+e/2aneEUJMBOx9PxNL5OGR8a1IOT9r4QHPKJ9Y7//mefEzr+FOgpTKxCGUlrDGjd8c3b/Y8M95momY7mt2K9nqGn753abHj5h5Ycc9n7TCzQSe7jyGSznnoxQX2kFceUnD654dNZXLWJxR0QeOaOSSO10Gdlh4z56t31jcjErPsQ0piSdRwu+SMJLpm+8aeUyBfidwxeWwuFet7inGWTTWaLfNnsU83HSDW7PxxVv6VXAw/3OWgKg385qE8qrNeJxm42W/m09ZMaHbC9NGfvfrPZ/BtWmX0n","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Webhook","permalink":"/docs/API-docs/v1.2/delete-webhook"},"next":{"title":"Get Folder","permalink":"/docs/API-docs/v1.2/getfolder"}}');var a=r(74848),l=r(28453),n=r(57742),i=r.n(n),d=r(78178),s=r.n(d),c=r(19624),p=r.n(c),f=r(96226),m=r.n(f),x=(r(77675),r(19365),r(51107)),g=r(21312);const v={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:"eJzNWF9vI7cR/ypTPrQ5YS3Jzl2Kbl7qBterU+POiB0cUNswRruzWp65JENyJQuCgDz0G/Spr/1o90mKIXellXS5xG0R9EXQkjPDmd/84W93LQLOvchvxZ+NKsmJ+0yU5AsnbZBGi1zc1ATfOMJAkETg/OoCUCmz9LAyLQQDRdqv4v5YZMJYcsgGLkqRi7SddkUmHP3Qkg9/MuVK5OuD466cWciSYEbKLMGiw4YCuaNTRCYKowPpwDbQWiWLeOLkg2dDa+GLmhrkf3ygdFRymElbY0McalhZErkwsw9UBJEJ69jzIMmzXpJ9y7L5upf1wUk9F5mojGswDFfoCRurWEjTsvdzkwmLjnRI6DEgz7MlNptMBBniQzL6MGPsNryxiy24luKCt0b7FMHZdHoMcbLRwVmCb4uCvK9apVa/eQ6snwcvLT8/XFufzuqnsw+Wkfv/yMC3Zxr9q0d5RWyrw+08fMrMTulsevblyen0ZPr7m9Ov8pd/yF99NZ5Op38TmXhqFOvGIsxFiSHa7VPcP7e2/BXO2RyKJdBKCiiVF0elx1W3ycTLTxXWtWko1FLPYUk6wNIZPc/AKkJPENwKcI5Sg8JA7n9YaeSccZ8H6XmeDRtOaiU1PfRd9fByOn043YLw6hiEC71AJcs4JW/MI+lfN9Lh8SEdf5xjmYTivtgLdriegvRUtE6Glchv1+LpBK08Sfv57f3mPhMMrOEpb42PHmOoRS4mB0Pfk1uQ89FK65TIRR2C9flk4lGXM/M0Npa0l3OtcObHhWkmaOVkcTo+E5vsUAetfZY8tSfPVfEB51LPf07vfofQNWcxJWoPp2260Mq/0kpkfRqGUpmQXD01YWqyTHBxfLe7Kl/3Kd6/l4aD7njOCc6u1JWJXnRZfmdJX8u5jjUSozi889+TKkxDfOmGmmA06lU+/v1fW63RCEpTtA3pEKt5fKfv9LvWgTVLclWrAHUJlaInOVMU1aiJe1ve4AkbRd6rFUgdaO74fi/lXAZUwIBzxxZocSaV5CZgMcPaDgZ95MfwvqZQk+Ot3zkChJIWpLh3ANtgGgxsqvcXlsY9VsxgMkCYtV5q8h5I16gLFuxTmoFxgBpIB3LWSU/gg2OvZfLN6OCwCNCgxjmx7QyGYJWkJNc9ODNrfQBvVBtdBp6vxlEJfUCaqPQRxNdPlreAVwvTWEc119+CYN7KknwGhSkJfCwIDkGXMCMfwLIvsiDPRlutTPEYE8h3O1jDI0iiAlPt+cjqwaH2fAcmX/ocbAGzzjBJoOTgaPS9J87wpdSPPh+N7vQJ3G7r6j3NvAx0/0XfS8vl8qiHXuzrvJHhL+0MviNrvAzGrXbacxnqdhb7bmhk+5AsvSFNsX4GXbWzUZrCH7cxr05qUnZyTYErxE/Ory7i1H4BH3/8B1wSOg21WaZqLVpHagXz/ihGLmU+wbYdulCZWHg1I16k4utob4/g+xrDxx//6eEtLUHqrqU4lNHoDQW4ocbyfQS/hb3HS+nDaJSDo8YsqIRWa+LUoFvt6LKPrnniBeZ41lEllYISA0LlTBO7i9xAY8xH34lKKnqw6P3SuPJODBg4liWV7GnHw0PnUQaJqQwWOoldu8lQD7ZLh1XY7SZXVRV9AmfakArYdq8CvTcRVOtMoCLGVFa90/Ft5MFUVbyr2cwv8jyefOD84PxoFVrPcAYDpJHnmOHu8OlvOnA7qdi/UJN0W2u9gwntB2cUfdoz7tIk5CFd/tyl+0Ad4fqzQB9ligO27UzJ4jDgMZwXBVkGdoGqJZ/DaJQ8Go3gi5IqbFV4kcFotJC05FX+j5azxE9juO78b3jQ1bggwABMsQKYDiUMrSNYynJO4WtIhoYK2nSb/mvoTXtocNXZ06t+P4Zq2gA4MNy9DDEU4zu+Uw/u4f1bzlFFjrGL6d01tZVdE9/2wwB4Rvw3wyS+NxgdsIgckBqUKhGCPx7aiXyMXOPfVdfkFrKgjpT8xBydROGJyISSBWlPA553/ubqEhZfjqciG7CbXzBSJ5cX37x+e/2aneEUJMBOx9PxNL5OGR8a1IOT9r4QHPKJ9Y7//mefEzr+FOgpTKxCGUlrDGjd8c3b/Y8M95momY7mt2K9nqGn753abHj5h5Ycc9n7TCzQSe7jyGSznnoxQX2kFceUnD654dNZXLWJxR0QeOaOSSO10Gdlh4z56t31jcjErPsQ0piSdRwu+SMJLpm+8aeUyBfidwxeWwuFet7inGWTTWaLfNnsU83HSDW7PxxVv6VXAw/3OWgKg385qE8qrNeJxm42W/m09ZMaHbC9NGfvfrPZ/BtWmX0n",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},O=void 0,P={},w=[];function u(e){const t={p:"p",...(0,l.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(x.default,{as:"h1",className:"openapi__heading",children:"Create Folder"}),"\n",(0,a.jsx)(i(),{method:"post",path:"/createfolder",context:"endpoint"}),"\n",(0,a.jsx)(t.p,{children:"The Create Folder API allows you to create folder."}),"\n",(0,a.jsx)(x.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,a.jsx)(g.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,a.jsx)(s(),{parameters:void 0}),"\n",(0,a.jsx)(p(),{...r(94427)}),"\n",(0,a.jsx)(m(),{...r(96205)})]})}function J(e={}){const{wrapper:t}={...(0,l.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(u,{...e})}):u(e)}},94427(e){e.exports=JSON.parse('{"title":"Body","body":{"description":"Provide below parameter to create folder","content":{"application/json":{"schema":{"required":["foldername"],"type":"object","properties":{"folderName":{"type":"string","format":"string","example":"new folder"},"parentFolderId":{"type":"string","format":"string","example":""}},"title":"folder_body"}}},"required":true}}')},96205(e){e.exports=JSON.parse('{"responses":{"200":{"description":"folder created successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"ph1bhx2jp"},"folderName":{"type":"string","format":"string","example":"new folder"},"parentFolderId":{"type":"string","format":"string","example":"J2nas5kiPe"},"createdAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"xml":{"name":"folderdetails"},"title":"folder"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/51e6fce0.b99ca595.js b/assets/js/51e6fce0.b99ca595.js new file mode 100644 index 000000000..a2292f158 --- /dev/null +++ b/assets/js/51e6fce0.b99ca595.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[5174],{30761(e,t,a){a.r(t),a.d(t,{assets:()=>m,contentTitle:()=>N,default:()=>V,frontMatter:()=>J,metadata:()=>o,toc:()=>x});const o=JSON.parse('{"id":"API-docs/v1.2/createfolder","title":"Create Folder","description":"The Create Folder API allows you to create folder.","source":"@site/docs/API-docs/v1.2/createfolder.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/createfolder","permalink":"/docs/API-docs/v1.2/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":"eJzNGdtu3Lj1V04ZoIgHmouzyRadLbb1Ok42bZoYHrsB6jEsjnRmxAxFaklKY8EeYB+KfkDRl772J/reT8mXFIeUNBdnk3W3WPQhjk2e+51Ht8zxhWXjS/ZCyxQNu4pYijYxonBCKzZm5xnCsUHuEAIIHJ2+Ai6lXlmodQlOQxLu5/5+wCKmCzScCLxK2ZiF63DLImbwuxKt+0anNRvf7rE7NboSKcIMpV5BwQ3P0aG5x4VFLNHKoXJEgxeFFInnOHxvidAts0mGOaffiKEwmJKaAVvxHElVVxfIxkzP3mPiWMQKQ5I7gZbwAuwbgh3ftrDWGaEWLGJzbXLutk/whueFJCCFq1bOdcQKblC5YD0yyMNosfU6Yk44/0cgej0j263pYqObMyX6A1toZYMGT0aj+yYONBpzpmDLJEFr56WU9S8eYtZPGy8cP1zdIjucZTdP3hdkuf8PD/z+ieL22VKcItFq7HbkPkZmg/Rk9OSL/uGoP/rV+eGX46e/Hj/7cjAajf7MInaTS8L1QThmKXeebuvi9u+ySH8GPut9sGC0FB0X0rJ7oUdRt47Y048F1kTn6DKhFrBC5WBltFpEUEjkFsGZGviCCwWSOzT/w0hDY7T5tJEeJtl2wgklhcLrNquun45G14edEZ7dN8IrVXEpUl8lz/US1c+r6TZ7F9jf97EIQP6e7Si7fR6UtJiURriajS9v2U2fF6If7seXV+uriJFhNVX5QlsvMXcZG7PhXtG3aCo01lMpjWRjljlX2PFwaLlKZ/pmoAtUViyU5DM7SHQ+5IUYVoeDJ2wd7ePwongQPJb9h6JYxxdCLT6Hd7Wx0IS8GBy1Y6fOXbwQf8CaRa0btqEiJih6MuQhySJGwXG2aZUnrYt3+9J2obtf5xh5V6i59lI0Xn5boJqIhfIx4rXY7/mPoIX58Jd/dmBTNVVfQ69HEwFZpG91aRKE5zopPT0uHbVWJyqED9//HWalkA7m2kCKFUqKZBuBM6WlvjOrAZVDUxhh0Q56PaK/zXchKgwjBodEk/IOIyiMTsuEBO0b5GkN2CfXcFcahEJyR5UcXGZ0uciAgxVqITGCs5PJ+byUpM0AJqhSSHVS5qic9SJ2RCLIueILBIc50UMvM0+WHoRqiHXclRaEAoNcghM5RsBVCrx0OqcZpdalIe2EwY4NSDHHpE5kMA6XElbCZbp0UKFKtQGpk2VfqAEZot/v03+PHsFLdI64Thw3DlM6PanQ1NDMUZCX1kHCjakD3y71SUKXIcRbgRZDCDHPJI7jqdq6HMNviMLm4OsGZqp6vQ9//RtcfqtXNIotUNGAh3sMrx632ZPqxN5PGzodZiiL4SQoZYdHp698lTwI/n+jHVjy5CpDg8RqhguhfgsXVKgzhF6vqReAqhJGKzJtrweP4x9dT+IDolsY7TQlZucFPp9j4k0tKYJT7vieK461QTjmBZ8JKago0/kdHHOHC21quIN3GXc+ZBOuINVwN1V3/X7f/yPQXu95G3W9Htw1k3UEFlUaQWj5ERis9LKJqRQp7jfh2W/dvgnfhvJ5G6+e8jelkCkYLC2fya1g9upCYbBfSJ5gCiuRLtDZr7wMZBmtELShLKg9WzQdiwnKeZ/y07N42UaBpWMPup1VnV0bKiBUJZzvfDCn6b4helrOpEhgV/xJxg0ChyJctqknhVr69FG6pSqFddCOwS3N54bPHbzTZkmcAkVe4ZZ02mzZhFtICcN6k8+F4lKEgMvDUNDSPdbK8aRx3h9DnfA50AiThHuYab2kEFsYnufciYRLWbdEQn0ONN6aBVfEayOZUJZeQF2Zfm4oHEON7zzxDmeZ1stA5AwTJBgqR30qR4AVVRylnZg3w4aFEJkG9EoBqrTQQrmW3IVtBTpDZwRWCDxJdKmct0hiMBUOqJPQmEwevNtNDQr8D9//w8IbXFHdaRvGI0obiZyM03q45cHlVMUvT85h2HpiOBZp7DnunpOPY8jIgzNEBdYZ5DlNZqmPBoNpqVKu3ObFaIECyGCuK0w9yV6vMDgXUvrUBmFB6RUYdKUhOhYJ16GsYW503np0Q7DXo9awpDDsHlmA3IrmeaqVLXMctFqfcmtX2qT9U6MdJtTyTp+/gElZFNq4qaJ7iKdsLiReFw3wlMVt1W7znN56VA4VrLTx3H0Go0pMXTRU7aCliyloNZ6q+PTt5ByaKaw1Ywz//hfEpxf3LO6PtxDaYByOW7jrXTCfLS3UvYs9fv6CagSZNG7t83Y+JwfCpEltSi2j5VRN0JFd/IrhWgeoa0KdsjFNDwh3MOfSYgxawQ8o6mPoI5o6DXhDE7hwkgYQXxxpQhGhTjb8uoJDowHyJOuKReffSYiPMy2pD9BQFDfVMoYwv/v44kmCBRUW0ikAXBstkTw9FyhT4InR1vqBwGtB2WV06dAO4DwziEDwIZ5t6+VxaD3EnYo9ZrwSlNz7DaeRKYbe4xTnvJTuwJcuPzM0QxVVBnoKOV/6N9NU6AyhRMSVwBXR6aqN9VHaTTdkKIMEBVrJui3STXcJC6O2Pse8KIyuArljrkJmU79pwfGGrNa0jiBNU+I9s7uutHAz0wqOdVHD4+PjAxJOFILq6FQdAQ3H8ZQlycbaTdp3hgQutVr4ikv64I2wfgaIp2y2jadVp2vUBUMU2oaPtq4Jdl4chn7eOfMk50ICT1ODlmoHVTVMKd87GU1TyTkNdDOt+glptl3HAT0VrRLcdYCwnUPTAbwWS9zoEJH4O9LAY1smGTW+kCWbjBdpfECtqxJpY4cgGvnLiLTxe2sBqLgsMfINJ1QpsqwUZFjqpoB54WrgxvAaHseXV/HBV6Bz4TyVYFqnQagMTXO4S3pvBDuquJA+U082818zh22dUE7Q2/7i7PVHZrBJGBF9v3vA3NgNLN0TZJfCJ5+KHfbJBZzh4h7y556o8X7H/RMaK7QvUr+Eb3iyXHGTWjjWecGd8BNqTaCETMHhF3wwawH7SQMowwQM1aEP4+pwcNg9UNoxwYaW6DJtEarAOBQk3vlDU9sSFmat3T1VpWFmMHTNJONqQYlAM8JWoxZU+NMyCbng5SXS2j9HuYRSSbQWtMvQrGhWUppifNccFxbpefdaqKUPhz5cdhPUO5xZ4XDzPFmtVvcsfeBxXpRSQjuj+4T7zKMmoL0U7ttyBmdYaCucNvUGayFcVs68L7dxuz8aAu0s3e2NfspjypM8R5Nb0HOYoKlE8hn1h47AhwdT2kXs7S92twMG52io7tidpyAvRPPsvGzlABLvp+jh961hpPb7Lyp9YZHyu306fo9FKrydN/o2y5xP68siJkWCyuLWfuzo5elrqL4YjFi0tRX6Eb4cvn51fPJmckLCNGnCxuxwMBqM/BpaW5dztcVp58vK/h7mdrM3/O8+wzR7J4c3blhILvyyzyt02+zpLnc/zlxFLKM13viS3d5SIl8YuV7T8XclGtoBXkWs4kZQxvsNYNSurGixt8SadApC98+JO4HLMmy/9haftHMLGEd+Rvok7PamkSY+FrFZ8wEp1ynhGL6ij0t8RWsv+gTlXz3++w+d3TLJ1aLkC4INNGnLxksyw/aKbulXdM0vpFV7peotCXd3d0EN+klKfRTh9jas/9brDj5c/SBGY9gWmrx3tV6v/wNt5sSu","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Webhook","permalink":"/docs/API-docs/v1.2/delete-webhook"},"next":{"title":"Get Folder","permalink":"/docs/API-docs/v1.2/getfolder"}}');var r=a(74848),d=a(28453),l=a(57742),i=a.n(l),p=a(78178),s=a.n(p),n=a(19624),c=a.n(n),h=a(96226),u=a.n(h),f=(a(77675),a(19365),a(51107)),w=a(21312);const J={id:"createfolder",title:"Create Folder",description:"The Create Folder API allows you to create folder.",sidebar_label:"Create Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJzNGdtu3Lj1V04ZoIgHmouzyRadLbb1Ok42bZoYHrsB6jEsjnRmxAxFaklKY8EeYB+KfkDRl772J/reT8mXFIeUNBdnk3W3WPQhjk2e+51Ht8zxhWXjS/ZCyxQNu4pYijYxonBCKzZm5xnCsUHuEAIIHJ2+Ai6lXlmodQlOQxLu5/5+wCKmCzScCLxK2ZiF63DLImbwuxKt+0anNRvf7rE7NboSKcIMpV5BwQ3P0aG5x4VFLNHKoXJEgxeFFInnOHxvidAts0mGOaffiKEwmJKaAVvxHElVVxfIxkzP3mPiWMQKQ5I7gZbwAuwbgh3ftrDWGaEWLGJzbXLutk/whueFJCCFq1bOdcQKblC5YD0yyMNosfU6Yk44/0cgej0j263pYqObMyX6A1toZYMGT0aj+yYONBpzpmDLJEFr56WU9S8eYtZPGy8cP1zdIjucZTdP3hdkuf8PD/z+ieL22VKcItFq7HbkPkZmg/Rk9OSL/uGoP/rV+eGX46e/Hj/7cjAajf7MInaTS8L1QThmKXeebuvi9u+ySH8GPut9sGC0FB0X0rJ7oUdRt47Y048F1kTn6DKhFrBC5WBltFpEUEjkFsGZGviCCwWSOzT/w0hDY7T5tJEeJtl2wgklhcLrNquun45G14edEZ7dN8IrVXEpUl8lz/US1c+r6TZ7F9jf97EIQP6e7Si7fR6UtJiURriajS9v2U2fF6If7seXV+uriJFhNVX5QlsvMXcZG7PhXtG3aCo01lMpjWRjljlX2PFwaLlKZ/pmoAtUViyU5DM7SHQ+5IUYVoeDJ2wd7ePwongQPJb9h6JYxxdCLT6Hd7Wx0IS8GBy1Y6fOXbwQf8CaRa0btqEiJih6MuQhySJGwXG2aZUnrYt3+9J2obtf5xh5V6i59lI0Xn5boJqIhfIx4rXY7/mPoIX58Jd/dmBTNVVfQ69HEwFZpG91aRKE5zopPT0uHbVWJyqED9//HWalkA7m2kCKFUqKZBuBM6WlvjOrAZVDUxhh0Q56PaK/zXchKgwjBodEk/IOIyiMTsuEBO0b5GkN2CfXcFcahEJyR5UcXGZ0uciAgxVqITGCs5PJ+byUpM0AJqhSSHVS5qic9SJ2RCLIueILBIc50UMvM0+WHoRqiHXclRaEAoNcghM5RsBVCrx0OqcZpdalIe2EwY4NSDHHpE5kMA6XElbCZbp0UKFKtQGpk2VfqAEZot/v03+PHsFLdI64Thw3DlM6PanQ1NDMUZCX1kHCjakD3y71SUKXIcRbgRZDCDHPJI7jqdq6HMNviMLm4OsGZqp6vQ9//RtcfqtXNIotUNGAh3sMrx632ZPqxN5PGzodZiiL4SQoZYdHp698lTwI/n+jHVjy5CpDg8RqhguhfgsXVKgzhF6vqReAqhJGKzJtrweP4x9dT+IDolsY7TQlZucFPp9j4k0tKYJT7vieK461QTjmBZ8JKago0/kdHHOHC21quIN3GXc+ZBOuINVwN1V3/X7f/yPQXu95G3W9Htw1k3UEFlUaQWj5ERis9LKJqRQp7jfh2W/dvgnfhvJ5G6+e8jelkCkYLC2fya1g9upCYbBfSJ5gCiuRLtDZr7wMZBmtELShLKg9WzQdiwnKeZ/y07N42UaBpWMPup1VnV0bKiBUJZzvfDCn6b4helrOpEhgV/xJxg0ChyJctqknhVr69FG6pSqFddCOwS3N54bPHbzTZkmcAkVe4ZZ02mzZhFtICcN6k8+F4lKEgMvDUNDSPdbK8aRx3h9DnfA50AiThHuYab2kEFsYnufciYRLWbdEQn0ONN6aBVfEayOZUJZeQF2Zfm4oHEON7zzxDmeZ1stA5AwTJBgqR30qR4AVVRylnZg3w4aFEJkG9EoBqrTQQrmW3IVtBTpDZwRWCDxJdKmct0hiMBUOqJPQmEwevNtNDQr8D9//w8IbXFHdaRvGI0obiZyM03q45cHlVMUvT85h2HpiOBZp7DnunpOPY8jIgzNEBdYZ5DlNZqmPBoNpqVKu3ObFaIECyGCuK0w9yV6vMDgXUvrUBmFB6RUYdKUhOhYJ16GsYW503np0Q7DXo9awpDDsHlmA3IrmeaqVLXMctFqfcmtX2qT9U6MdJtTyTp+/gElZFNq4qaJ7iKdsLiReFw3wlMVt1W7znN56VA4VrLTx3H0Go0pMXTRU7aCliyloNZ6q+PTt5ByaKaw1Ywz//hfEpxf3LO6PtxDaYByOW7jrXTCfLS3UvYs9fv6CagSZNG7t83Y+JwfCpEltSi2j5VRN0JFd/IrhWgeoa0KdsjFNDwh3MOfSYgxawQ8o6mPoI5o6DXhDE7hwkgYQXxxpQhGhTjb8uoJDowHyJOuKReffSYiPMy2pD9BQFDfVMoYwv/v44kmCBRUW0ikAXBstkTw9FyhT4InR1vqBwGtB2WV06dAO4DwziEDwIZ5t6+VxaD3EnYo9ZrwSlNz7DaeRKYbe4xTnvJTuwJcuPzM0QxVVBnoKOV/6N9NU6AyhRMSVwBXR6aqN9VHaTTdkKIMEBVrJui3STXcJC6O2Pse8KIyuArljrkJmU79pwfGGrNa0jiBNU+I9s7uutHAz0wqOdVHD4+PjAxJOFILq6FQdAQ3H8ZQlycbaTdp3hgQutVr4ikv64I2wfgaIp2y2jadVp2vUBUMU2oaPtq4Jdl4chn7eOfMk50ICT1ODlmoHVTVMKd87GU1TyTkNdDOt+glptl3HAT0VrRLcdYCwnUPTAbwWS9zoEJH4O9LAY1smGTW+kCWbjBdpfECtqxJpY4cgGvnLiLTxe2sBqLgsMfINJ1QpsqwUZFjqpoB54WrgxvAaHseXV/HBV6Bz4TyVYFqnQagMTXO4S3pvBDuquJA+U082818zh22dUE7Q2/7i7PVHZrBJGBF9v3vA3NgNLN0TZJfCJ5+KHfbJBZzh4h7y556o8X7H/RMaK7QvUr+Eb3iyXHGTWjjWecGd8BNqTaCETMHhF3wwawH7SQMowwQM1aEP4+pwcNg9UNoxwYaW6DJtEarAOBQk3vlDU9sSFmat3T1VpWFmMHTNJONqQYlAM8JWoxZU+NMyCbng5SXS2j9HuYRSSbQWtMvQrGhWUppifNccFxbpefdaqKUPhz5cdhPUO5xZ4XDzPFmtVvcsfeBxXpRSQjuj+4T7zKMmoL0U7ttyBmdYaCucNvUGayFcVs68L7dxuz8aAu0s3e2NfspjypM8R5Nb0HOYoKlE8hn1h47AhwdT2kXs7S92twMG52io7tidpyAvRPPsvGzlABLvp+jh961hpPb7Lyp9YZHyu306fo9FKrydN/o2y5xP68siJkWCyuLWfuzo5elrqL4YjFi0tRX6Eb4cvn51fPJmckLCNGnCxuxwMBqM/BpaW5dztcVp58vK/h7mdrM3/O8+wzR7J4c3blhILvyyzyt02+zpLnc/zlxFLKM13viS3d5SIl8YuV7T8XclGtoBXkWs4kZQxvsNYNSurGixt8SadApC98+JO4HLMmy/9haftHMLGEd+Rvok7PamkSY+FrFZ8wEp1ynhGL6ij0t8RWsv+gTlXz3++w+d3TLJ1aLkC4INNGnLxksyw/aKbulXdM0vpFV7peotCXd3d0EN+klKfRTh9jas/9brDj5c/SBGY9gWmrx3tV6v/wNt5sSu",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},N=void 0,m={},x=[];function T(e){const t={p:"p",...(0,d.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(f.default,{as:"h1",className:"openapi__heading",children:"Create Folder"}),"\n",(0,r.jsx)(i(),{method:"post",path:"/createfolder",context:"endpoint"}),"\n",(0,r.jsx)(t.p,{children:"The Create Folder API allows you to create folder."}),"\n",(0,r.jsx)(f.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,r.jsx)(w.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,r.jsx)(s(),{parameters:void 0}),"\n",(0,r.jsx)(c(),{...a(94427)}),"\n",(0,r.jsx)(u(),{...a(96205)})]})}function V(e={}){const{wrapper:t}={...(0,d.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(T,{...e})}):T(e)}},94427(e){e.exports=JSON.parse('{"title":"Body","body":{"description":"Provide below parameter to create folder","content":{"application/json":{"schema":{"required":["foldername"],"type":"object","properties":{"folderName":{"type":"string","format":"string","example":"new folder"},"parentFolderId":{"type":"string","format":"string","example":""}},"title":"folder_body"}}},"required":true}}')},96205(e){e.exports=JSON.parse('{"responses":{"200":{"description":"folder created successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"ph1bhx2jp"},"folderName":{"type":"string","format":"string","example":"new folder"},"parentFolderId":{"type":"string","format":"string","example":"J2nas5kiPe"},"createdAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"xml":{"name":"folderdetails"},"title":"folder"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/61361021.072422c8.js b/assets/js/61361021.072422c8.js deleted file mode 100644 index 4b8e78408..000000000 --- a/assets/js/61361021.072422c8.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[1915],{54335(e,t,o){o.r(t),o.d(t,{assets:()=>v,contentTitle:()=>I,default:()=>A,frontMatter:()=>h,metadata:()=>n,toc:()=>y});const n=JSON.parse('{"id":"API-docs/v1.2/deletecontact","title":"Delete Contact","description":"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact\'s information, this API makes it easy to delete their record.","source":"@site/docs/API-docs/v1.2/deletecontact.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/deletecontact","permalink":"/docs/API-docs/v1.2/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":"eJzVWFFvI7cR/itTPjR3i7Uk+5wE3bzUTYyLUSN3iB0cUFswqOXsLmMuyZBcyYIgIA/9B33qa3/a/ZJgyF1pZfsud2gRoC+2RM4Mv/lmODPUhgVee1bcsG+NDrwMns1zJtCXTtogjWYFu24QvkOFAaEXgrO3F8CVMisPa9NBMOCwNUsEDmUvUjnT0qYbVhbG3E/goooa2oAyukYHGlEAB8tdkGWn+E7+Cw9SV8a1nHDkEBrp48Etv0cPMgByv6azRQIXGpQOHJbGiQnLmbHoou6FYAVLQr1tljPLHW8xoCPvN0zzFlnB+v07KVjOJHlveWjYY0reOrOUAsEsfsYyXAgw1c7xHSCWM4e/dNKhYEVwHebMh7WiY7xsrSIBfLDKCGRFxZUngbLBlrNiw8LaRsngpK5ZzhIT4xV84NFKwWxzsmhOuBdsu53Tqd4a7dGTnZPZjP4d4h/imIAK8F1ZovdVp9T6TyyPNKAOpMitVbKMPE5/9qS9eYoy8UCsOmI9yHT2QM9z/uzR/+2BsNvv7Su2zfs4ibPwcaWT2cmro+PZ0ezr6+OvitO/FF9+NZnNZv9gOXtoFen2ERU8INkNMqj99+0TsRSysWC/siXh0+dYvDIthkbqGlaoA6yc0XUOViH3CMGtgddcalA8oPsfsorOGfdxdj4P2XbktdRKarwbUujudDa7O96RcPrhVNImQGU6Lf5YT585/uPunN6d7Nz58qk7F3rJlRSx0Fybe9R/rDvj40M6/mmuyiQU99mBs+P15KTHsnMyrGORezjiVh6l/eJmTrWC8sTs62MsjKFhBZv29Wy62dfELSODbjkUzc4pVrAmBOuL6dRzLRbmYWIsai9rrfjCT0rTTrmV0+Xx5IRt88c63NrPksfu6HNVfOC11PXv6c33XF1RPFPIDhjbBY5b+Xdcs3wIyFiqbxsNcoEuBo+6WFTuw/TGor6StY5Bjoc/bi/vUJWmRWoloUHIskHl/T//s9PKMhCm7FrUIabj5Fbf6jedA2tW6KpOAdcCKoUPcqEwqmEb93ZN2yNvFXqv1iB1wNrxgCBkLQNXQDxRBSm55QupJGUxiZnU1UcXwU/gXYOhQUdbXzgaAwQuUVHyA++CoR6u6x1eWBl3X9H4kAOHReelRu8BdcN1SYJDJHIwDrgG1AGdddIj+OAItUzYjA6Orn/LNa+RbOcwJkugkpSu4Myi8wG8UV2EDIFLZRwKGByiQcRHEs+pKTuENLy01mFDabNEqDsp0OdQGoHg46UlF7SABfoAlrDIEj0Z7bQy5X0MIPVVsIZqiOSKhoUxRlIPjmtPLT5hGWKwI8w6Qw0aE8As+8kjRfhS6ntfZNmtPoKbXV69w4WXAecvhiuwWq2epP7LQ53XMnzfLeBHtMbLYNx6r13L0HSLeF3GRnZfkqXXqDHmz+gy7G0IU/qnt49Wpw0qO73CQBnip2dvL2LZfQnvf/0XXCJ3GhqzStladg7VGurhKGIuRT7RtquaUJmYeA0xXqbko1kMfRgYfNfw8P7Xf3v4AVcgdX+lyJUse40BrrG11B/hz3Dw9VL6kGVFP/AK6LRGCg13a9jPlBGaR1qg+co6rKRSIHjgaTImHtCNNCZ09C2rpMI7y71fGSdu2V4AuBAoCGnpkICEHlEOnRWHC73E/rrJ0Iy2heNV2O8mqKqKmMCZLqQEtv2QO6CJpFpnApbRJ1ENoONT4M5UVWy2ZOaTkMeTH4EfnR+tQueJzmAANac6Zuh2+PQxHbirVIQvPQIGawPAxPadMwqfR0a3NAn5fqinW3pI1BNef5foJ5Eih223ULJ87PAEzsoSLRG75KpDX0CWJURZBi8EVrxT4WUOWbaUuKJV+swtRYm+TeCqx99SoWs4vcYC0MgXwPQs8dA5hJUUNYZvIBkaK2jTb/pvYDDtoeXr3p5eD/vRVdMF4CPD/XOHqJjcUit81D4Pu5zDCh1xF8O7v9RW9pf4ZigGQDXivykmNCUNTz8axFouVerjf31sJw5U6Fr/prpCt5Ql9rPEB+roNApPWc6ULFF7HA1qZ6/fXsLy1WTG8tFQ8gkldXp58e35D1fnBIZCkAg7nswmM1qyxoeW69FJh+/zxwPFZj/B/t++5vvRK+BDmFrFZZx8I6mbfmS9YfvXfTF6yM9z1hgfSGCzWXCPPzm13dLyLx06moznOVtyJ6moxLm2LzBi9yz/IJsvfuxf+C/hU38TeNaRYbDUNFXGAsAKxnJ2j+vDXyW2820+DJcENQmk2jFSffJMOZj1vzu/PL8+ZzmjFnk4197Hubb/QAc8i+xw4E0Y6C9N388qbDZpZt5ud/Jp64MavY+DNNE03263vwHYW5eT","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Contact","permalink":"/docs/API-docs/v1.2/getcontact"},"next":{"title":"Get Contact list","permalink":"/docs/API-docs/v1.2/contactlist"}}');var a=o(74848),s=o(28453),r=o(57742),i=o.n(r),c=o(78178),d=o.n(c),l=o(19624),p=o.n(l),m=o(96226),u=o.n(m),f=(o(77675),o(19365),o(51107)),P=o(21312);const h={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:"eJzVWFFvI7cR/itTPjR3i7Uk+5wE3bzUTYyLUSN3iB0cUFswqOXsLmMuyZBcyYIgIA/9B33qa3/a/ZJgyF1pZfsud2gRoC+2RM4Mv/lmODPUhgVee1bcsG+NDrwMns1zJtCXTtogjWYFu24QvkOFAaEXgrO3F8CVMisPa9NBMOCwNUsEDmUvUjnT0qYbVhbG3E/goooa2oAyukYHGlEAB8tdkGWn+E7+Cw9SV8a1nHDkEBrp48Etv0cPMgByv6azRQIXGpQOHJbGiQnLmbHoou6FYAVLQr1tljPLHW8xoCPvN0zzFlnB+v07KVjOJHlveWjYY0reOrOUAsEsfsYyXAgw1c7xHSCWM4e/dNKhYEVwHebMh7WiY7xsrSIBfLDKCGRFxZUngbLBlrNiw8LaRsngpK5ZzhIT4xV84NFKwWxzsmhOuBdsu53Tqd4a7dGTnZPZjP4d4h/imIAK8F1ZovdVp9T6TyyPNKAOpMitVbKMPE5/9qS9eYoy8UCsOmI9yHT2QM9z/uzR/+2BsNvv7Su2zfs4ibPwcaWT2cmro+PZ0ezr6+OvitO/FF9+NZnNZv9gOXtoFen2ERU8INkNMqj99+0TsRSysWC/siXh0+dYvDIthkbqGlaoA6yc0XUOViH3CMGtgddcalA8oPsfsorOGfdxdj4P2XbktdRKarwbUujudDa7O96RcPrhVNImQGU6Lf5YT585/uPunN6d7Nz58qk7F3rJlRSx0Fybe9R/rDvj40M6/mmuyiQU99mBs+P15KTHsnMyrGORezjiVh6l/eJmTrWC8sTs62MsjKFhBZv29Wy62dfELSODbjkUzc4pVrAmBOuL6dRzLRbmYWIsai9rrfjCT0rTTrmV0+Xx5IRt88c63NrPksfu6HNVfOC11PXv6c33XF1RPFPIDhjbBY5b+Xdcs3wIyFiqbxsNcoEuBo+6WFTuw/TGor6StY5Bjoc/bi/vUJWmRWoloUHIskHl/T//s9PKMhCm7FrUIabj5Fbf6jedA2tW6KpOAdcCKoUPcqEwqmEb93ZN2yNvFXqv1iB1wNrxgCBkLQNXQDxRBSm55QupJGUxiZnU1UcXwU/gXYOhQUdbXzgaAwQuUVHyA++CoR6u6x1eWBl3X9H4kAOHReelRu8BdcN1SYJDJHIwDrgG1AGdddIj+OAItUzYjA6Orn/LNa+RbOcwJkugkpSu4Myi8wG8UV2EDIFLZRwKGByiQcRHEs+pKTuENLy01mFDabNEqDsp0OdQGoHg46UlF7SABfoAlrDIEj0Z7bQy5X0MIPVVsIZqiOSKhoUxRlIPjmtPLT5hGWKwI8w6Qw0aE8As+8kjRfhS6ntfZNmtPoKbXV69w4WXAecvhiuwWq2epP7LQ53XMnzfLeBHtMbLYNx6r13L0HSLeF3GRnZfkqXXqDHmz+gy7G0IU/qnt49Wpw0qO73CQBnip2dvL2LZfQnvf/0XXCJ3GhqzStladg7VGurhKGIuRT7RtquaUJmYeA0xXqbko1kMfRgYfNfw8P7Xf3v4AVcgdX+lyJUse40BrrG11B/hz3Dw9VL6kGVFP/AK6LRGCg13a9jPlBGaR1qg+co6rKRSIHjgaTImHtCNNCZ09C2rpMI7y71fGSdu2V4AuBAoCGnpkICEHlEOnRWHC73E/rrJ0Iy2heNV2O8mqKqKmMCZLqQEtv2QO6CJpFpnApbRJ1ENoONT4M5UVWy2ZOaTkMeTH4EfnR+tQueJzmAANac6Zuh2+PQxHbirVIQvPQIGawPAxPadMwqfR0a3NAn5fqinW3pI1BNef5foJ5Eih223ULJ87PAEzsoSLRG75KpDX0CWJURZBi8EVrxT4WUOWbaUuKJV+swtRYm+TeCqx99SoWs4vcYC0MgXwPQs8dA5hJUUNYZvIBkaK2jTb/pvYDDtoeXr3p5eD/vRVdMF4CPD/XOHqJjcUit81D4Pu5zDCh1xF8O7v9RW9pf4ZigGQDXivykmNCUNTz8axFouVerjf31sJw5U6Fr/prpCt5Ql9rPEB+roNApPWc6ULFF7HA1qZ6/fXsLy1WTG8tFQ8gkldXp58e35D1fnBIZCkAg7nswmM1qyxoeW69FJh+/zxwPFZj/B/t++5vvRK+BDmFrFZZx8I6mbfmS9YfvXfTF6yM9z1hgfSGCzWXCPPzm13dLyLx06moznOVtyJ6moxLm2LzBi9yz/IJsvfuxf+C/hU38TeNaRYbDUNFXGAsAKxnJ2j+vDXyW2820+DJcENQmk2jFSffJMOZj1vzu/PL8+ZzmjFnk4197Hubb/QAc8i+xw4E0Y6C9N388qbDZpZt5ud/Jp64MavY+DNNE03263vwHYW5eT",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},I=void 0,v={},y=[];function b(e){const t={p:"p",...(0,s.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)(i(),{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:(0,a.jsx)(P.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,a.jsx)(d(),{...o(96818)}),"\n",(0,a.jsx)(p(),{...o(93528)}),"\n",(0,a.jsx)(u(),{...o(17010)})]})}function A(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(b,{...e})}):b(e)}},96818(e){e.exports=JSON.parse('{"parameters":[{"name":"contact_id","in":"path","description":"Provide objectId of contact to delete","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"ph2bh2asd"}}]}')},93528(e){e.exports={title:"Body"}},17010(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Contact deleted successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","example":"Bxh2aspHp3"},"deletedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"xml":{"name":"delete"},"title":"delete"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"Contact not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Contact not found!"}},"title":"inline_response_404_2"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/61361021.f0586b79.js b/assets/js/61361021.f0586b79.js new file mode 100644 index 000000000..5b8fc87a7 --- /dev/null +++ b/assets/js/61361021.f0586b79.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[1915],{54335(e,t,o){o.r(t),o.d(t,{assets:()=>f,contentTitle:()=>g,default:()=>A,frontMatter:()=>x,metadata:()=>n,toc:()=>D});const n=JSON.parse('{"id":"API-docs/v1.2/deletecontact","title":"Delete Contact","description":"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact\'s information, this API makes it easy to delete their record.","source":"@site/docs/API-docs/v1.2/deletecontact.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/deletecontact","permalink":"/docs/API-docs/v1.2/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":"eJzVGdtu48b1V05ngdYWqIudTYoqRVrHdjZGt1nDsrtALcMacY7EiUYzzMyQsmALyEPRDyj60tf+RN/7KfslxZkhKcr27maRokAfdm2T534/h/fM87ljw2t2bLTnqXfsJmECXWpl7qXRbMguM4QTVOgRKiA4Oj8DrpRZOVibArwBi0tTInBIK5CZNUt6aesnU2MWPTibBQxtQBk9RwsaUQCHnFsv00LxBv5XDqSeGbvkJEcCPpMuMF7yBTqQHpC7NfEWUTifobRgMTVW9FjCTI424J4JNmQRqKLNEpZzy5fo0ZL290zzJbIhq97fSsESJkn7nPuMPTbJuTWlFAhm+j2m/kyAmTWKNwKxhFn8oZAWBRt6W2DCnF8rYuPkMlcEgHe5MgLZcMaVI4A0wyVnw3vm13mA9FbqOUtYtET7Cd7xQGXI8uxwmh1yJ9hmc0NcXW60Q0d0DgcD+rErf+3HKKgAV6QpOjcrlFr/giXBDKg9IfI8VzINdux/7wj7/qmU0Q5kVUtW9zLyrs3znD5b6b++I9nzb/PP2Cap/CSO/IeRDgeHn3UPBt3Bry8Pvhi+/M3w8y96g8Hgzyxhd0tFuJVHBfdIdL30avv35glYdFkbsHqyIeCXz1lxZJboM6nnsELtYWWNnieQK+QOwds18DmXGhT3aP+LVkVrjf2wdT5Nsk1La6mV1Hhbh9Dty8Hg9qAxwsv3h5I2Hmam0OJ/q+kz7D+szsvbw0adz5+qc6ZLrqQIhebSLFD/b9Vps/eR/dNYlREovGc7yrafRyUdpoWVfh2K3F2X57Ib3w+vb6hWUJyYbX0MhdFnbMj6VT3r329r4oYRQVvWRbOwig1Z5n3uhv2+41pMzV3P5KidnGvFp66XmmWf57JfHvQO2SZ5jMPz/JPgseh+KorzfC71/GN4N1tbjcif0WU7Fmscx3P5B1yzpHZIG6pqGxlygTY4j7pYQK7c9CZHPZJzHZwcmD9uLy+ghnn3l382YGM91l9Bp0P9mBTpOlPYFOHEpEWgx5VHq7mXJcK7H/8O00IqygoLAktUFIouAW8LRzV/ugbUHm1upUPX63SIfpvvXJYY+zt1dQpQjwnk1ogiJUG7FrlYA3bJotwXFiFX3FOjAp9ZU8wz4OCknitM4OJ0dDkrFGnTgxFqAcKkxRK1d0HEhkgCS675HMHjkuhhkJmniwBCNc157guaDsAiV+DlEhPgWgAvvFlyj3HuQO2lxYYNKDnDdJ2qaByuFKykz0zhoUQtjAVl0kVX6h4Zotvt0o8XL+AVek9cR55bj4KenpZo10DNHZ2HZeE8pNzadeTb5C5J6DOESSs+JhAjIzCZTCZj3Xo5hN8She2DryqYse503v31b3D9rVnRgDFHTbMNPmJ4s1cHvTCpexrt9LSfocr7o6iU6x+dn4Uytx/9/53x4MiTqwwtEqspzqX+HVy5MGBBp1OlOaAupTWaTNvpwN7kJ5eByT7Rza3xhvKp8QKfzTANplYUwYJ7/sgVx8YiHPOcT6WSVFXp+QMcc49zY9fwAG8z7kPIplyDMPAw1g/dbjf8I9BO56SOuk4HHuDYIqeodqhFAkUuwl8WS7OoYqoaLpvw7NZu34ZvRfmyjtdA+etCKgEWC8enqhXMQV3ILXZzxVMUsJJijt59GWQgyxiNYCxlwTqwRduwGKGadSk/A4tXdRQ4ehxA21nV2LWiAlKX0ofWBTNlVjXR82KqZAq74o8ybmmcz+PLOvWU1IuQPtrUVJV0HupBt6Z5YvnMw1tjF8QpUuQltqQztmUT7kAQhgsmn0nNlYwBt4xDSk233lICxT/GOhFyoBKmHsJp2aAQm1u+pAUi5UqtayLfGCXQRhpv7Jxr4rWVTGpHs31Tpk8sheMsItU03uI0M2YRiVxgigRD5ahL5QiwpIqjjZezalpwECPTgllpQC1yI7WvyV25WqAL9FYirVJpagrtg0VSi0L69j5EiO3UoMB/9+M/HHyHK6o7dcN4QWmjkJNxag/XPLga68mr00vo157oD6WYBI67z8nHE8jIg1NEDc5b5EsarUSIBoui0IJrD9u1CiiA4looAslOJ7c4k0qF1AbpQJsVWPSFJToOCdejWsfdsfLolmCnQ61hQWHYbDi0A0q0lDap0a5YYq/W+pw7tzJWdM+t8ZhSyzs/+QZGRZ4b68ea3sNkzGZS4W1eAY/ZpK7adZ5PjVhTOdSwMjZwDxmMOrXrvKLqejVdFGD0cKwn529Gl9BPQ32pzTiBf/8LJudXTyweHrcQ6mDsD2u4212wkC011JMXj/iFF1QjyKST2j5vZjNyIIyq1KbUskaN9Qg92SXs97cmQt0S6pgNaXpAeICwrk7AaHiPoiGGntHUG6CdV6bSKxpAQnGkCUXGOlnxawoOjQbI06wpFo1/RzE+LoyiPkBD0aSqlpNqLw/xxdMUcyospFMEuLVGIXl6JlEJ4Kk1zoWBIGhB2WVN4dH14DKziEDwMZ5d7eVhbD3EnYo9ZryUlNyPG04l0wQ6ewJnvFB+P5SuMDNUQxVVBlrNfCj922kqdoZYIialxBXRaaqNC1HaTDdkKIsEBUardV2kq+4SrzV1fZ7wPLemjOSOuY6ZTf2mBsc7slrVOqI0VYkPzB6a0sLt1Gg4Nvka9o6P90k4mUuqo2N9BBpXZPY03Vq7SvvGkMDpEBQqLumDd9KFGWAyZtM2ntGNrkkTDElsGyHamibYeLEf+3njzNMllwq4EBYd1Q6qaigo3xsZbVXJOQ10U6O7KWnWruOAgYrRKe46QLrGoaIHr+UCtzokJP6ONLDnijSjxhezZJvxUkz2qXWVUlR2iKKRv6wUld9rC0DJVYFJaDixSpFllSTDUjcFXOZ+Ddxavoa9yfXNZP9LMEvpA5VoWm9A6gxt9XCX9KMR7KjkUoVMPd3Of9Uc1npCOUG3hquL18/MYKM4IoZ+9wlzYzOwNCvILoUPbngN9ukVXOD8CfLHNsvJ4477J7ROmlCkfglf83Sx4lY4ODbLnHsZJtQ1gRIyBUc4rsG0BuymFaCKEzCUByGMy4PeQbOg1GOCiy3RZ8YhlJFxLEi88YfR8UQ6re0eqGoDU4uxa6YZ13NKBJoRWo1aUuEXRRpzIchLpE1YR7mCQit0DozP0K5oVtKGYnzXHFcOab17LfUihEMXrpsJ6i1OnfS4XU9Wq9UTS+8HnG8KpaCe0UPCfWSpiWivpP+2mMIF5sZJb+x6izWXPiumwZdt3OaPikA9SzeHn5+zTAWSl2iXji7DI7SlTD+ift8TeH9/TCeER2eH3euAxRlaqjtuZxXkuazWzutaDiDxfo4edF2qT+Z0wKLSF+8fv39MJxyiSIU3s0rf6gbzYX1ZwpRMUTtsHbiOXp2/hvKz3oAlrWPOT/Bl//XZ8el3o1MSpkoTNmQHvUFvQI9y4/yS6xan3e8ajw8x99vL3//tV5DqZOXxzvdzxWW4GAaj3lenvmu2/SoybH0AuUlYZpwngPt7qipXVm029PiHAi1dFG8SVnIrqfyEe2A1xInmc8Z7rbl3US2M+/BTv6U8q0h9kNN0jQv9ig0ZS9gC17tfczY3m6Q+ypGoEeAoDIct1Cfn3Z0b6cnp69PLU5YwXpDh2vfARbgHVr8Qg2cl2z0URhnof7paPotwfx9vjZtNAx9fvRej0rGGJjPdbDab/wCAX98a","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Contact","permalink":"/docs/API-docs/v1.2/getcontact"},"next":{"title":"Get Contact list","permalink":"/docs/API-docs/v1.2/contactlist"}}');var a=o(74848),i=o(28453),l=o(57742),s=o.n(l),r=o(78178),p=o.n(r),c=o(19624),d=o.n(c),m=o(96226),u=o.n(m),h=(o(77675),o(19365),o(51107)),y=o(21312);const x={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:"eJzVGdtu48b1V05ngdYWqIudTYoqRVrHdjZGt1nDsrtALcMacY7EiUYzzMyQsmALyEPRDyj60tf+RN/7KfslxZkhKcr27maRokAfdm2T534/h/fM87ljw2t2bLTnqXfsJmECXWpl7qXRbMguM4QTVOgRKiA4Oj8DrpRZOVibArwBi0tTInBIK5CZNUt6aesnU2MWPTibBQxtQBk9RwsaUQCHnFsv00LxBv5XDqSeGbvkJEcCPpMuMF7yBTqQHpC7NfEWUTifobRgMTVW9FjCTI424J4JNmQRqKLNEpZzy5fo0ZL290zzJbIhq97fSsESJkn7nPuMPTbJuTWlFAhm+j2m/kyAmTWKNwKxhFn8oZAWBRt6W2DCnF8rYuPkMlcEgHe5MgLZcMaVI4A0wyVnw3vm13mA9FbqOUtYtET7Cd7xQGXI8uxwmh1yJ9hmc0NcXW60Q0d0DgcD+rErf+3HKKgAV6QpOjcrlFr/giXBDKg9IfI8VzINdux/7wj7/qmU0Q5kVUtW9zLyrs3znD5b6b++I9nzb/PP2Cap/CSO/IeRDgeHn3UPBt3Bry8Pvhi+/M3w8y96g8Hgzyxhd0tFuJVHBfdIdL30avv35glYdFkbsHqyIeCXz1lxZJboM6nnsELtYWWNnieQK+QOwds18DmXGhT3aP+LVkVrjf2wdT5Nsk1La6mV1Hhbh9Dty8Hg9qAxwsv3h5I2Hmam0OJ/q+kz7D+szsvbw0adz5+qc6ZLrqQIhebSLFD/b9Vps/eR/dNYlREovGc7yrafRyUdpoWVfh2K3F2X57Ib3w+vb6hWUJyYbX0MhdFnbMj6VT3r329r4oYRQVvWRbOwig1Z5n3uhv2+41pMzV3P5KidnGvFp66XmmWf57JfHvQO2SZ5jMPz/JPgseh+KorzfC71/GN4N1tbjcif0WU7Fmscx3P5B1yzpHZIG6pqGxlygTY4j7pYQK7c9CZHPZJzHZwcmD9uLy+ghnn3l382YGM91l9Bp0P9mBTpOlPYFOHEpEWgx5VHq7mXJcK7H/8O00IqygoLAktUFIouAW8LRzV/ugbUHm1upUPX63SIfpvvXJYY+zt1dQpQjwnk1ogiJUG7FrlYA3bJotwXFiFX3FOjAp9ZU8wz4OCknitM4OJ0dDkrFGnTgxFqAcKkxRK1d0HEhkgCS675HMHjkuhhkJmniwBCNc157guaDsAiV+DlEhPgWgAvvFlyj3HuQO2lxYYNKDnDdJ2qaByuFKykz0zhoUQtjAVl0kVX6h4Zotvt0o8XL+AVek9cR55bj4KenpZo10DNHZ2HZeE8pNzadeTb5C5J6DOESSs+JhAjIzCZTCZj3Xo5hN8She2DryqYse503v31b3D9rVnRgDFHTbMNPmJ4s1cHvTCpexrt9LSfocr7o6iU6x+dn4Uytx/9/53x4MiTqwwtEqspzqX+HVy5MGBBp1OlOaAupTWaTNvpwN7kJ5eByT7Rza3xhvKp8QKfzTANplYUwYJ7/sgVx8YiHPOcT6WSVFXp+QMcc49zY9fwAG8z7kPIplyDMPAw1g/dbjf8I9BO56SOuk4HHuDYIqeodqhFAkUuwl8WS7OoYqoaLpvw7NZu34ZvRfmyjtdA+etCKgEWC8enqhXMQV3ILXZzxVMUsJJijt59GWQgyxiNYCxlwTqwRduwGKGadSk/A4tXdRQ4ehxA21nV2LWiAlKX0ofWBTNlVjXR82KqZAq74o8ybmmcz+PLOvWU1IuQPtrUVJV0HupBt6Z5YvnMw1tjF8QpUuQltqQztmUT7kAQhgsmn0nNlYwBt4xDSk233lICxT/GOhFyoBKmHsJp2aAQm1u+pAUi5UqtayLfGCXQRhpv7Jxr4rWVTGpHs31Tpk8sheMsItU03uI0M2YRiVxgigRD5ahL5QiwpIqjjZezalpwECPTgllpQC1yI7WvyV25WqAL9FYirVJpagrtg0VSi0L69j5EiO3UoMB/9+M/HHyHK6o7dcN4QWmjkJNxag/XPLga68mr00vo157oD6WYBI67z8nHE8jIg1NEDc5b5EsarUSIBoui0IJrD9u1CiiA4looAslOJ7c4k0qF1AbpQJsVWPSFJToOCdejWsfdsfLolmCnQ61hQWHYbDi0A0q0lDap0a5YYq/W+pw7tzJWdM+t8ZhSyzs/+QZGRZ4b68ea3sNkzGZS4W1eAY/ZpK7adZ5PjVhTOdSwMjZwDxmMOrXrvKLqejVdFGD0cKwn529Gl9BPQ32pzTiBf/8LJudXTyweHrcQ6mDsD2u4212wkC011JMXj/iFF1QjyKST2j5vZjNyIIyq1KbUskaN9Qg92SXs97cmQt0S6pgNaXpAeICwrk7AaHiPoiGGntHUG6CdV6bSKxpAQnGkCUXGOlnxawoOjQbI06wpFo1/RzE+LoyiPkBD0aSqlpNqLw/xxdMUcyospFMEuLVGIXl6JlEJ4Kk1zoWBIGhB2WVN4dH14DKziEDwMZ5d7eVhbD3EnYo9ZryUlNyPG04l0wQ6ewJnvFB+P5SuMDNUQxVVBlrNfCj922kqdoZYIialxBXRaaqNC1HaTDdkKIsEBUardV2kq+4SrzV1fZ7wPLemjOSOuY6ZTf2mBsc7slrVOqI0VYkPzB6a0sLt1Gg4Nvka9o6P90k4mUuqo2N9BBpXZPY03Vq7SvvGkMDpEBQqLumDd9KFGWAyZtM2ntGNrkkTDElsGyHamibYeLEf+3njzNMllwq4EBYd1Q6qaigo3xsZbVXJOQ10U6O7KWnWruOAgYrRKe46QLrGoaIHr+UCtzokJP6ONLDnijSjxhezZJvxUkz2qXWVUlR2iKKRv6wUld9rC0DJVYFJaDixSpFllSTDUjcFXOZ+Ddxavoa9yfXNZP9LMEvpA5VoWm9A6gxt9XCX9KMR7KjkUoVMPd3Of9Uc1npCOUG3hquL18/MYKM4IoZ+9wlzYzOwNCvILoUPbngN9ukVXOD8CfLHNsvJ4477J7ROmlCkfglf83Sx4lY4ODbLnHsZJtQ1gRIyBUc4rsG0BuymFaCKEzCUByGMy4PeQbOg1GOCiy3RZ8YhlJFxLEi88YfR8UQ6re0eqGoDU4uxa6YZ13NKBJoRWo1aUuEXRRpzIchLpE1YR7mCQit0DozP0K5oVtKGYnzXHFcOab17LfUihEMXrpsJ6i1OnfS4XU9Wq9UTS+8HnG8KpaCe0UPCfWSpiWivpP+2mMIF5sZJb+x6izWXPiumwZdt3OaPikA9SzeHn5+zTAWSl2iXji7DI7SlTD+ift8TeH9/TCeER2eH3euAxRlaqjtuZxXkuazWzutaDiDxfo4edF2qT+Z0wKLSF+8fv39MJxyiSIU3s0rf6gbzYX1ZwpRMUTtsHbiOXp2/hvKz3oAlrWPOT/Bl//XZ8el3o1MSpkoTNmQHvUFvQI9y4/yS6xan3e8ajw8x99vL3//tV5DqZOXxzvdzxWW4GAaj3lenvmu2/SoybH0AuUlYZpwngPt7qipXVm029PiHAi1dFG8SVnIrqfyEe2A1xInmc8Z7rbl3US2M+/BTv6U8q0h9kNN0jQv9ig0ZS9gC17tfczY3m6Q+ypGoEeAoDIct1Cfn3Z0b6cnp69PLU5YwXpDh2vfARbgHVr8Qg2cl2z0URhnof7paPotwfx9vjZtNAx9fvRej0rGGJjPdbDab/wCAX98a",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},g=void 0,f={},D=[];function I(e){const t={p:"p",...(0,i.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Delete Contact"}),"\n",(0,a.jsx)(s(),{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)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,a.jsx)(y.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,a.jsx)(p(),{...o(96818)}),"\n",(0,a.jsx)(d(),{...o(93528)}),"\n",(0,a.jsx)(u(),{...o(17010)})]})}function A(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(I,{...e})}):I(e)}},96818(e){e.exports=JSON.parse('{"parameters":[{"name":"contact_id","in":"path","description":"Provide objectId of contact to delete","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"ph2bh2asd"}}]}')},93528(e){e.exports={title:"Body"}},17010(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Contact deleted successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","example":"Bxh2aspHp3"},"deletedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"xml":{"name":"delete"},"title":"delete"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"Contact not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Contact not found!"}},"title":"inline_response_404_2"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/656c0f50.4617fca3.js b/assets/js/656c0f50.4617fca3.js new file mode 100644 index 000000000..8df2233d9 --- /dev/null +++ b/assets/js/656c0f50.4617fca3.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[4380],{93298(e,t,o){o.r(t),o.d(t,{assets:()=>m,contentTitle:()=>J,default:()=>R,frontMatter:()=>U,metadata:()=>a,toc:()=>X});const a=JSON.parse('{"id":"API-docs/v1.2/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.2/updatefolder.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/updatefolder","permalink":"/docs/API-docs/v1.2/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":"eJy9WV9vI7cR/ypTHlDYwkqynUvaKkVax+dcnFzvDMvuAbUML7U70jLikhuSu7JgC8hD0Q9Q9KWv/RJ970e5T1IMubta2Y4vRpo+3Nkmh8OZ3/zl7C1zfG7Z6JJ9pWWKhl1FLEWbGFE4oRUbsfMM4aJIuUMIJHB4egJcSr20sNIlOA2l9vuzsK94jsAtLFFK+llwg8qFwyfpgEVMF2g48T9J2YiVnns4zCJWcMNzdGhIrFtG3NiIhe1rkbKICZKr4C5j94XV0+8wcScp6Bm0DA1+XwqDKRs5U2LErFtJYmlFXkhkEcObQuoU2WjGpSWCJMOcs9Etc6vCUzoj1JxFbKZNzl13BW+45zJi02/3k1l6kBVTtl5fhWvRui91uiJW24KeGl2JFGGKUi+hVZnATAxuwGQRS7RyqBzx4EUhReKRG35nidFtR9iNnpc1XB67q6hRI6BDEBuygBNo6Vygfetxfp7KCpeNnGtvuI6dn8uLrdcRc8LJjrWnhN16TTsGbaGVDRIf7O09hNSWSYLWzkoJrX89B76nQWo867lqfb2wB98UuDwpCKLg6umhe4zN5tDB3sEn/f29/t5vzvc/G7383ejTzwZ7e3t/YRG7ySWdraOCuLEObuHvzoJQUii8btC7Ptjbu97frzF9+RiMY52jy4SawxKVg6XRah5BIZFbBGdWwOdcKJDcofnV/w5fNEabp1F5nmRPofCSUGhBePkQhCaTaQczXSqftH5pRZ/yoofyPK3ey+vftup9+lC9E1VxKVKfyZ1eoPr/GvKR60nUbdcWgcjvsy1lu+tBSYtJaYRb+YJx0+eF6If90eUVpWLyG02lpii9wFQ6RmwYUB3etrVlzYiXqZraUxrJRixzrrCj4dBylU71zUAXqKyYK8mndpDofMgLMaz2BwdsHd0/w4viWfRY9p97xDo+F2r+sXNXG5jGZMpgrS2wWpvxQnyLKxY1tuhS1eU3Q+7T/jpi5CFnm2J33Nh5u7J0i8XDWsHIxELNtJeiNvW7AtVYzJV3FK/F/Xr/AhqaD3/9V0s2URP1BfR61LoQIn2rS5MgvNJJ6flx6ag4OlEhfPjhHzAthaTIMpBihZLc2UbgTGkdpjBdASqHpjDCoh30esS/e+9cVBh6IQ6JJuUdRlAYnZYJCdo3yNMVYJ9Mw11pEArJHQU8uMzocp4BByvUXGIEZ8fjcypih6cnAxijSiHVSZmjctaL2DKJIOeKzxEc5sQPvcw8WXgSypPWcVdaEAoMcglO5BgBVynw0umcuoyVLg1pJwy214AUM0xWiQzgcClhKVymSwcVqlQbkDpZ9IUaEBD9fp9+vHgBr9E5unXsuHGY0upxhWYFdScEeWkdJNyYVbi3jX+S0GUIccfRYggu5i+J43iiOpsj+D1x2Cx8UdNMVK/34W9/h8uv9ZKaqTkqagXw3oVXO030pDqxD8OGVocZymI4DkrZ4eHpyTkd3Q32f6sdWLLkMkODdNUU50L9AS6oGGUIvV6dLwBVJYxWBG2vBzvxT84n8S7xLYx2mgKztQKfzTDxUEvy4JQ7fs8UR9ogHPGCT4UUlJlp/Q6OuMO5Niu4g/cZd95lE64g1XA3UXf9ft//I9Je71Xjdb0e3MGR70ojsKjSCEIfE4HBSi9qn0qR/H7jnv3G7Bv3rTmfN/7qOX9ZCpmCwdLyqew4s1cXCoP9QvIEU1iKdI7Ofu5lIGS0QtCGomDlr0XTXjFGOetTfPorXjdeYGnZk3ajqsW15gJCVcL58gcz6s9rpqflVIoEtsUfZ9wgcCjCZhN6UqiFDx+lG65SWAdNk97wfGX4zMF7bRZ0U+DIK+xIp00HE24hpRPWQz4TiksRHC4PjU/D90grx5PaeH8KecLHQC1MEvZhqvWCXGxueJ5zJxIu5aphEvJz4PHOzLmiuzaSCWXpDdOm6VeG3DHk+NYS73Gaab0ITM4wQaKhdNSndARYUcZR2olZ3XFYCJ5pQC8VoEoLLZRr2F3YRqAzdEZghcCTRJfKeUQSg6lwQJWEuimy4N12aJDjf/jhnxbe4pLyTlMwXlDYSOQETmPh5g4uJyp+fXwOw8YSw5FIY3/j9jrZOIaMLDhFVGCdQZ5Te5Z6bzCYlirlym3efBbIgQzmusLUs+z1CoMzIaUPbRAWlF6CQVca4mORzjqUK5gZnTcW3TDs9ag0LMgN22cTILeifmBqZcscB43Wp9zapTZp/9RohwmVvNNXX8G4LApt3ETRPsQTNhMSr4uaeMLiJms3cU6vNUqHCpba+Nt9BKNKzKqoudpBwxdT0Go0UfHpu/E5DMOrt4Exhv/8G+LTiweI++XOgcYZh6OG7nqbzEdLQ/Vg4959foNyBEEaN/i8m83IgDCuQ5tCy2g5UWN0hIufhVzrQHVNRydsRN0Dwh34kUIMWsGPKOp96BFNnQaaS4hEOEkNiE+O1KGIkCfr+9qEQ60B8iRrk0Vr33HwjzMtqQ5QUxTX2TKG0MR7/+JJggUlFtIpEFwbLZEsPRMoU+CJ0db6hsBrQdFldOnQDuA8M4hA9MGfbWPlUSg9dDsle8x4JSi47xecWqYYejspzngp3a5PXb5nqJsqygz03HM+9W+6qVAZQoqIK4FL4tNmG+u9tO1uCCiDRAVayVWTpOvqEiZbTX6OeVEYXQV2R1yFyKZ605DjDaFWl44gTZ3i/WV3bWrhZqoVHOliBTtHR7sknCgE5dGJOgRqjuMJS5IN2nXYt0ACl1rNfcYlffBGWN8DxBM27Z7TqtU1ap0hCmXDe1tbBFsrDkM9b415nHMhgaepQUu5g7IaphTvrYymzuScGrqpVv2ENOvmcUDPRasEtw0gbGvQdABvxAI3OkQk/pY0sGPLJKPCF6JkE/EijXepdFUirXEIopG9jEhruzcIQMVliZEvOCFLEbJSELBUTQHzwq2AG8NXsBNfXsW7n4POhfNcArROg1AZmnpxm/W9Fuyw4kL6SD3e9H91H9ZZoZig+cXF2ZtHerBxaBF9vXtG39g2LO0TZJvDk0/F9vTxBZzh/MHhjz1R4/sV989orNA+Sf0avuTJYslNauFI5wV3wneoKyKlw+Qcs5JakGlD2E9qQhk6YKj2vRtX+4P99oHStAk2lESXaYtQhYtDQuKtPTSVLWFh2uDuuSoNU4OhaiYZV3MKBOoROoVaUOJPyyTEgpeXWGv/HOUSSiXRWtAuQ7OkXklp8vFtOC4s0vPujVAL7w59uGw7qPc4tcLh5nmyXC4fIL3rz3xVSglNj+4D7iOPmnDstXBfl1M4w0Jb4bRZbU7NhcvKqbdl92z7R82g6aXpMXX+cx9TnuU5mtzSyH6MphLJR9QfOiIf7k5oFnFvfrE9HTA4Q0N5x249BXkh6mfnZSMHkHg/Rw8aX9QttR+CUeoLg5Q/3ufjh1mkwrtZrW89zHlaXxYxKRJUFjtDssPXp2+g+mSwx6LOVOgn2HL45uTo+O34mISpw4SN2P5gb7DnR/naupyrzk1bn4Duz2FuN8PDX+R7UT2WcnjjhoXkwg8Evb639TCv+eLBIjbafCq6ilimraPt21sK9wsj12ta/r5EQ+PCq4hV3AjKC37iV3dXafst6Ef13DmrX3K78OhXp0dlbuZrioZrvmrQ6CtiC1xtfeNaX62jZsRGYoX9o3B5/5y4bM4/mNbSjDCcOPQ93ZO03fHo6cU5i9i0/mKV+29izPAlfUTjyyBqSHZ+eOjXbpnkal7yOdEGljQU5CWZpTtRXPiJYv0LKfUoGNujxqAF/U86PXrg9jZMK9frlj5s/eiJGteGmixztV6v/wt1lUCk","sidebar_class_name":"put api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Folder","permalink":"/docs/API-docs/v1.2/getfolder"},"next":{"title":"Delete Folder","permalink":"/docs/API-docs/v1.2/deletefolder"}}');var r=o(74848),p=o(28453),i=o(57742),l=o.n(i),s=o(78178),n=o.n(s),d=o(19624),c=o.n(d),u=o(96226),f=o.n(u),h=(o(77675),o(19365),o(51107)),g=o(21312);const U={id:"updatefolder",title:"Update Folder",description:"The Update Folder API allows you to uodate folder name as well as parentFolderId.",sidebar_label:"Update Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9WV9vI7cR/ypTHlDYwkqynUvaKkVax+dcnFzvDMvuAbUML7U70jLikhuSu7JgC8hD0Q9Q9KWv/RJ970e5T1IMubta2Y4vRpo+3Nkmh8OZ3/zl7C1zfG7Z6JJ9pWWKhl1FLEWbGFE4oRUbsfMM4aJIuUMIJHB4egJcSr20sNIlOA2l9vuzsK94jsAtLFFK+llwg8qFwyfpgEVMF2g48T9J2YiVnns4zCJWcMNzdGhIrFtG3NiIhe1rkbKICZKr4C5j94XV0+8wcScp6Bm0DA1+XwqDKRs5U2LErFtJYmlFXkhkEcObQuoU2WjGpSWCJMOcs9Etc6vCUzoj1JxFbKZNzl13BW+45zJi02/3k1l6kBVTtl5fhWvRui91uiJW24KeGl2JFGGKUi+hVZnATAxuwGQRS7RyqBzx4EUhReKRG35nidFtR9iNnpc1XB67q6hRI6BDEBuygBNo6Vygfetxfp7KCpeNnGtvuI6dn8uLrdcRc8LJjrWnhN16TTsGbaGVDRIf7O09hNSWSYLWzkoJrX89B76nQWo867lqfb2wB98UuDwpCKLg6umhe4zN5tDB3sEn/f29/t5vzvc/G7383ejTzwZ7e3t/YRG7ySWdraOCuLEObuHvzoJQUii8btC7Ptjbu97frzF9+RiMY52jy4SawxKVg6XRah5BIZFbBGdWwOdcKJDcofnV/w5fNEabp1F5nmRPofCSUGhBePkQhCaTaQczXSqftH5pRZ/yoofyPK3ey+vftup9+lC9E1VxKVKfyZ1eoPr/GvKR60nUbdcWgcjvsy1lu+tBSYtJaYRb+YJx0+eF6If90eUVpWLyG02lpii9wFQ6RmwYUB3etrVlzYiXqZraUxrJRixzrrCj4dBylU71zUAXqKyYK8mndpDofMgLMaz2BwdsHd0/w4viWfRY9p97xDo+F2r+sXNXG5jGZMpgrS2wWpvxQnyLKxY1tuhS1eU3Q+7T/jpi5CFnm2J33Nh5u7J0i8XDWsHIxELNtJeiNvW7AtVYzJV3FK/F/Xr/AhqaD3/9V0s2URP1BfR61LoQIn2rS5MgvNJJ6flx6ag4OlEhfPjhHzAthaTIMpBihZLc2UbgTGkdpjBdASqHpjDCoh30esS/e+9cVBh6IQ6JJuUdRlAYnZYJCdo3yNMVYJ9Mw11pEArJHQU8uMzocp4BByvUXGIEZ8fjcypih6cnAxijSiHVSZmjctaL2DKJIOeKzxEc5sQPvcw8WXgSypPWcVdaEAoMcglO5BgBVynw0umcuoyVLg1pJwy214AUM0xWiQzgcClhKVymSwcVqlQbkDpZ9IUaEBD9fp9+vHgBr9E5unXsuHGY0upxhWYFdScEeWkdJNyYVbi3jX+S0GUIccfRYggu5i+J43iiOpsj+D1x2Cx8UdNMVK/34W9/h8uv9ZKaqTkqagXw3oVXO030pDqxD8OGVocZymI4DkrZ4eHpyTkd3Q32f6sdWLLkMkODdNUU50L9AS6oGGUIvV6dLwBVJYxWBG2vBzvxT84n8S7xLYx2mgKztQKfzTDxUEvy4JQ7fs8UR9ogHPGCT4UUlJlp/Q6OuMO5Niu4g/cZd95lE64g1XA3UXf9ft//I9Je71Xjdb0e3MGR70ojsKjSCEIfE4HBSi9qn0qR/H7jnv3G7Bv3rTmfN/7qOX9ZCpmCwdLyqew4s1cXCoP9QvIEU1iKdI7Ofu5lIGS0QtCGomDlr0XTXjFGOetTfPorXjdeYGnZk3ajqsW15gJCVcL58gcz6s9rpqflVIoEtsUfZ9wgcCjCZhN6UqiFDx+lG65SWAdNk97wfGX4zMF7bRZ0U+DIK+xIp00HE24hpRPWQz4TiksRHC4PjU/D90grx5PaeH8KecLHQC1MEvZhqvWCXGxueJ5zJxIu5aphEvJz4PHOzLmiuzaSCWXpDdOm6VeG3DHk+NYS73Gaab0ITM4wQaKhdNSndARYUcZR2olZ3XFYCJ5pQC8VoEoLLZRr2F3YRqAzdEZghcCTRJfKeUQSg6lwQJWEuimy4N12aJDjf/jhnxbe4pLyTlMwXlDYSOQETmPh5g4uJyp+fXwOw8YSw5FIY3/j9jrZOIaMLDhFVGCdQZ5Te5Z6bzCYlirlym3efBbIgQzmusLUs+z1CoMzIaUPbRAWlF6CQVca4mORzjqUK5gZnTcW3TDs9ag0LMgN22cTILeifmBqZcscB43Wp9zapTZp/9RohwmVvNNXX8G4LApt3ETRPsQTNhMSr4uaeMLiJms3cU6vNUqHCpba+Nt9BKNKzKqoudpBwxdT0Go0UfHpu/E5DMOrt4Exhv/8G+LTiweI++XOgcYZh6OG7nqbzEdLQ/Vg4959foNyBEEaN/i8m83IgDCuQ5tCy2g5UWN0hIufhVzrQHVNRydsRN0Dwh34kUIMWsGPKOp96BFNnQaaS4hEOEkNiE+O1KGIkCfr+9qEQ60B8iRrk0Vr33HwjzMtqQ5QUxTX2TKG0MR7/+JJggUlFtIpEFwbLZEsPRMoU+CJ0db6hsBrQdFldOnQDuA8M4hA9MGfbWPlUSg9dDsle8x4JSi47xecWqYYejspzngp3a5PXb5nqJsqygz03HM+9W+6qVAZQoqIK4FL4tNmG+u9tO1uCCiDRAVayVWTpOvqEiZbTX6OeVEYXQV2R1yFyKZ605DjDaFWl44gTZ3i/WV3bWrhZqoVHOliBTtHR7sknCgE5dGJOgRqjuMJS5IN2nXYt0ACl1rNfcYlffBGWN8DxBM27Z7TqtU1ap0hCmXDe1tbBFsrDkM9b415nHMhgaepQUu5g7IaphTvrYymzuScGrqpVv2ENOvmcUDPRasEtw0gbGvQdABvxAI3OkQk/pY0sGPLJKPCF6JkE/EijXepdFUirXEIopG9jEhruzcIQMVliZEvOCFLEbJSELBUTQHzwq2AG8NXsBNfXsW7n4POhfNcArROg1AZmnpxm/W9Fuyw4kL6SD3e9H91H9ZZoZig+cXF2ZtHerBxaBF9vXtG39g2LO0TZJvDk0/F9vTxBZzh/MHhjz1R4/sV989orNA+Sf0avuTJYslNauFI5wV3wneoKyKlw+Qcs5JakGlD2E9qQhk6YKj2vRtX+4P99oHStAk2lESXaYtQhYtDQuKtPTSVLWFh2uDuuSoNU4OhaiYZV3MKBOoROoVaUOJPyyTEgpeXWGv/HOUSSiXRWtAuQ7OkXklp8vFtOC4s0vPujVAL7w59uGw7qPc4tcLh5nmyXC4fIL3rz3xVSglNj+4D7iOPmnDstXBfl1M4w0Jb4bRZbU7NhcvKqbdl92z7R82g6aXpMXX+cx9TnuU5mtzSyH6MphLJR9QfOiIf7k5oFnFvfrE9HTA4Q0N5x249BXkh6mfnZSMHkHg/Rw8aX9QttR+CUeoLg5Q/3ufjh1mkwrtZrW89zHlaXxYxKRJUFjtDssPXp2+g+mSwx6LOVOgn2HL45uTo+O34mISpw4SN2P5gb7DnR/naupyrzk1bn4Duz2FuN8PDX+R7UT2WcnjjhoXkwg8Evb639TCv+eLBIjbafCq6ilimraPt21sK9wsj12ta/r5EQ+PCq4hV3AjKC37iV3dXafst6Ef13DmrX3K78OhXp0dlbuZrioZrvmrQ6CtiC1xtfeNaX62jZsRGYoX9o3B5/5y4bM4/mNbSjDCcOPQ93ZO03fHo6cU5i9i0/mKV+29izPAlfUTjyyBqSHZ+eOjXbpnkal7yOdEGljQU5CWZpTtRXPiJYv0LKfUoGNujxqAF/U86PXrg9jZMK9frlj5s/eiJGteGmixztV6v/wt1lUCk",sidebar_class_name:"put api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},J=void 0,m={},X=[];function j(e){const t={p:"p",...(0,p.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Update Folder"}),"\n",(0,r.jsx)(l(),{method:"put",path:"/folder/{folder_id}",context:"endpoint"}),"\n",(0,r.jsx)(t.p,{children:"The Update Folder API allows you to uodate folder name as well as parentFolderId."}),"\n",(0,r.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,r.jsx)(g.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,r.jsx)(n(),{...o(17132)}),"\n",(0,r.jsx)(c(),{...o(63366)}),"\n",(0,r.jsx)(f(),{...o(73260)})]})}function R(e={}){const{wrapper:t}={...(0,p.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(j,{...e})}):j(e)}},17132(e){e.exports=JSON.parse('{"parameters":[{"name":"folder_id","in":"path","description":"objectId of folder","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"bK1cfd2hpb"}}]}')},63366(e){e.exports=JSON.parse('{"title":"Body","body":{"description":"Provide below parameter to create folder","content":{"application/json":{"schema":{"required":["foldername"],"type":"object","properties":{"folderName":{"type":"string","format":"string","example":"new folder"},"parentFolderId":{"type":"string","format":"string","example":""}},"title":"folder_body"}}}}}')},73260(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"Hks2JpewIp"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"title":"inline_response_200_11"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"folder not found.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","format":"string","example":"folder not found."}},"title":"inline_response_404_8"}}}},"405":{"description":"Invalid API token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/656c0f50.e554156e.js b/assets/js/656c0f50.e554156e.js deleted file mode 100644 index b5bc8afac..000000000 --- a/assets/js/656c0f50.e554156e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[4380],{93298(e,t,o){o.r(t),o.d(t,{assets:()=>g,contentTitle:()=>w,default:()=>y,frontMatter:()=>x,metadata:()=>d,toc:()=>F});const d=JSON.parse('{"id":"API-docs/v1.2/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.2/updatefolder.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/updatefolder","permalink":"/docs/API-docs/v1.2/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":"eJy9WFFvI7cR/itTPqR3wlqSHSdtlZdeg+vFiXFnnH04oLZgUMtZLWMuyZBcrQVhgTz0H/Qpr/1p90uKIXelleVzYrTpi60lObPffMPhfMsNC3zp2eya/d0ogY7NMybQ507aII1mM3ZVInywggeEtAReXZwBV8o0HtamhmCgNnG+SPOaVwjcQ4NK0X/LHeqQjM/EmGXMWHSc/J8JNmN19J6MWcYsd7zCgI5gbRh5YzOWpm+lYBmThMvyULKHYM3iR8zDmQBTwNahw59q6VCwWXA1ZsyHtSKXXlZWIcsY3ltlBLJZwZWnBXmJFWezDQtrG1cGJ/WSZawwruJhOIL3PHqZscUPx3khTkq7YG07T69FH/5mxJpc7QO9cGYlBcIClWlgGzKRmTvckckylhsdUAfywa1VMo/MTX705GgzALuL87qjK3I3z/owEjtEsaMMBIme7NLat5Hn54WsselxtjFxgzw/1xdr24wFGdQg2wvirm1pxqG3RvuE+GQ6PaTU13mO3he1gu3+eg59T5PU76znhvXdnT/53mJzZomitNXFq/CYm53RyfTky6Pj6dH0T1fHX89O/zL76uvxdDr9B8vYfaXItqsK8sYGvKXnwYDUSmq87dm7PZlOb4+PO05PH6Px0lQYSqmX0KAO0DijlxlYhdwjBLcGvuRSg+IB3R/+d/yic8Y9zcrzkD3FwimxsCXh9JCE/iQzAQpT63ho/d6BPrWLDvE8Hd7p7Z+34X11GN6ZXnElRTzJg7lD/f9N5COvJ6j7W1umRXGe7QU7HE9BesxrJ8M6Noz7I27lUZqfXc/pKKZ9Y6jV2DoCptYxY5PE6mSz7S0tI19u1fee2ik2Y2UI1s8mE8+1WJj7sbGovVxqxRd+nJtqwq2crI7HJ6zNHtpwa5+1Huuj55r4wJdSL3/Nbr6j6ZJSmbK1R9Y2Z9zKH3DNsj4Xw1Vd+y2Rx2O/zRjtkPe7Zve6z/N+Zxk2i8NewSjFUhcmouhS/c6ivpRLHTdKjOJhv/+IKjcVUtsMJcJo1Jt8+ue/t1ajEQiT1xXqELf0+Ebf6He1A2sadNQvuBZQKLyXC4XRDKs4txU4Hnml0Hu1BqkDLh11aCGXMnAFRDidSjm3fCGVpEqgZYasHQyKyY/hY4mhREdTf3QIHASuUFEBAa+DqXggVz1eaIy7K0hqZcBhUXup0XtAXXKd08I+pRkYB1wD6oDOOukRfHCEWiZsRgfH8wAV13yJ5DuDIVkClaR9D84sah/AG1VHyBC4VMahgD4gjSh8JPE1CSeHQKO5qazDkvbfCmFZS4E+g9wIBB83BIWgBSzQB7CEReboo3rUyuR3MYFFrRRYQ+eQ5IpU3BAjmQfHtaejMmHpc7AlzDpDKgATwNHog0fK8LnUd342Gt3oI7je7quPuPAy4PxFX0tN0xzU0Mt9mzcyfFcv4D1a42Uwbr2zXspQ1otYd0Mn24fk6Q1qjPtnUFU7H8Lk/rCMaXRSorKTSwy0Q/zk1cXZFZm+hE8//wvOkTsNpWnSbs1rh2oNy/5VxFzKfKJte/JCYeLGK4nxPG2+Trj2DH4sefj08y8e3mIDUnclRaGMRm8wwBVWlnoufAF7j+fSh9FoBg4rs0IBtdZIqeFuvRO8PkLzSAMBBViHhVQKBA8cCmeqWF3oBhZjevUNK6TCW8u9b4wTN2ygobkQKAhpp6RDhyiDJL8GA92KXbnJUA6mheNF2M0mqKqImMCZOqQNbDsx36OJpFpnAuYxJlH0oONn060pitiwyc1vQh7f/AD84P3RK9Se6AwGUHM6xwxVh08/0wu3JxXhCyVKt/XWA0xs3zqj8HFkVKVpkYekAKhK94k64PVXiT7IFAVs64WS+cOAx/Aqz9ESsSuuavQzGI0SotEIXggseK3CywxGo5XEhkbpN7eUJXoaw2WHv6KDruQrBB6AZGQA07HEQ+0QGimWGL6B5GhooE036b+B3rWHiq87f3rdz8dQTR2ADxx3n2pExfiGeuqDPrzf5RwW6Ii7mN5dUVvZFfF1fxgAnRH/zWFCbZh6Bc+jEMSKS5UEwV8f+omiDF3l3xWX6FYyx06UfOYcncTFE5YxJXPUHgdi79Wbi3NYfTmesmygbn7DkTo5P/v29dvL1wSGUpAIOx5Px9P4SWp8qLgevGnvKuOhntjsRPDvcu/RyauA92FiFZdR2MZ4N50o7b/cWcZmuyuPecZK4wNNbzYL7vGDU21Lwz/V6Ej2zjO24k5StUfl2lW+2N5pfDbOF++7a4OX8OjtyaOYe52oSSTGMiQJl7E7XO/d1bTzNuulIsFK89+mlx9dkZed/cFXB2ndZJFK/sm1Q5l/8eGKZWzR3bxU8W6HOd7QZRBvElQTuYgiOI5tmOJ6WfMlrU0uSdxSb9xXxndRGXc/KKhHydiXzCkK+ksxPWqw2STV3bbb9WnqsxYdr/1qysy8bdv/ACEY+Q4=","sidebar_class_name":"put api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Folder","permalink":"/docs/API-docs/v1.2/getfolder"},"next":{"title":"Delete Folder","permalink":"/docs/API-docs/v1.2/deletefolder"}}');var s=o(74848),a=o(28453),n=o(57742),r=o.n(n),l=o(78178),i=o.n(l),p=o(19624),c=o.n(p),m=o(96226),u=o.n(m),h=(o(77675),o(19365),o(51107)),f=o(21312);const x={id:"updatefolder",title:"Update Folder",description:"The Update Folder API allows you to uodate folder name as well as parentFolderId.",sidebar_label:"Update Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9WFFvI7cR/itTPqR3wlqSHSdtlZdeg+vFiXFnnH04oLZgUMtZLWMuyZBcrQVhgTz0H/Qpr/1p90uKIXelleVzYrTpi60lObPffMPhfMsNC3zp2eya/d0ogY7NMybQ507aII1mM3ZVInywggeEtAReXZwBV8o0HtamhmCgNnG+SPOaVwjcQ4NK0X/LHeqQjM/EmGXMWHSc/J8JNmN19J6MWcYsd7zCgI5gbRh5YzOWpm+lYBmThMvyULKHYM3iR8zDmQBTwNahw59q6VCwWXA1ZsyHtSKXXlZWIcsY3ltlBLJZwZWnBXmJFWezDQtrG1cGJ/WSZawwruJhOIL3PHqZscUPx3khTkq7YG07T69FH/5mxJpc7QO9cGYlBcIClWlgGzKRmTvckckylhsdUAfywa1VMo/MTX705GgzALuL87qjK3I3z/owEjtEsaMMBIme7NLat5Hn54WsselxtjFxgzw/1xdr24wFGdQg2wvirm1pxqG3RvuE+GQ6PaTU13mO3he1gu3+eg59T5PU76znhvXdnT/53mJzZomitNXFq/CYm53RyfTky6Pj6dH0T1fHX89O/zL76uvxdDr9B8vYfaXItqsK8sYGvKXnwYDUSmq87dm7PZlOb4+PO05PH6Px0lQYSqmX0KAO0DijlxlYhdwjBLcGvuRSg+IB3R/+d/yic8Y9zcrzkD3FwimxsCXh9JCE/iQzAQpT63ho/d6BPrWLDvE8Hd7p7Z+34X11GN6ZXnElRTzJg7lD/f9N5COvJ6j7W1umRXGe7QU7HE9BesxrJ8M6Noz7I27lUZqfXc/pKKZ9Y6jV2DoCptYxY5PE6mSz7S0tI19u1fee2ik2Y2UI1s8mE8+1WJj7sbGovVxqxRd+nJtqwq2crI7HJ6zNHtpwa5+1Huuj55r4wJdSL3/Nbr6j6ZJSmbK1R9Y2Z9zKH3DNsj4Xw1Vd+y2Rx2O/zRjtkPe7Zve6z/N+Zxk2i8NewSjFUhcmouhS/c6ivpRLHTdKjOJhv/+IKjcVUtsMJcJo1Jt8+ue/t1ajEQiT1xXqELf0+Ebf6He1A2sadNQvuBZQKLyXC4XRDKs4txU4Hnml0Hu1BqkDLh11aCGXMnAFRDidSjm3fCGVpEqgZYasHQyKyY/hY4mhREdTf3QIHASuUFEBAa+DqXggVz1eaIy7K0hqZcBhUXup0XtAXXKd08I+pRkYB1wD6oDOOukRfHCEWiZsRgfH8wAV13yJ5DuDIVkClaR9D84sah/AG1VHyBC4VMahgD4gjSh8JPE1CSeHQKO5qazDkvbfCmFZS4E+g9wIBB83BIWgBSzQB7CEReboo3rUyuR3MYFFrRRYQ+eQ5IpU3BAjmQfHtaejMmHpc7AlzDpDKgATwNHog0fK8LnUd342Gt3oI7je7quPuPAy4PxFX0tN0xzU0Mt9mzcyfFcv4D1a42Uwbr2zXspQ1otYd0Mn24fk6Q1qjPtnUFU7H8Lk/rCMaXRSorKTSwy0Q/zk1cXZFZm+hE8//wvOkTsNpWnSbs1rh2oNy/5VxFzKfKJte/JCYeLGK4nxPG2+Trj2DH4sefj08y8e3mIDUnclRaGMRm8wwBVWlnoufAF7j+fSh9FoBg4rs0IBtdZIqeFuvRO8PkLzSAMBBViHhVQKBA8cCmeqWF3oBhZjevUNK6TCW8u9b4wTN2ygobkQKAhpp6RDhyiDJL8GA92KXbnJUA6mheNF2M0mqKqImMCZOqQNbDsx36OJpFpnAuYxJlH0oONn060pitiwyc1vQh7f/AD84P3RK9Se6AwGUHM6xwxVh08/0wu3JxXhCyVKt/XWA0xs3zqj8HFkVKVpkYekAKhK94k64PVXiT7IFAVs64WS+cOAx/Aqz9ESsSuuavQzGI0SotEIXggseK3CywxGo5XEhkbpN7eUJXoaw2WHv6KDruQrBB6AZGQA07HEQ+0QGimWGL6B5GhooE036b+B3rWHiq87f3rdz8dQTR2ADxx3n2pExfiGeuqDPrzf5RwW6Ii7mN5dUVvZFfF1fxgAnRH/zWFCbZh6Bc+jEMSKS5UEwV8f+omiDF3l3xWX6FYyx06UfOYcncTFE5YxJXPUHgdi79Wbi3NYfTmesmygbn7DkTo5P/v29dvL1wSGUpAIOx5Px9P4SWp8qLgevGnvKuOhntjsRPDvcu/RyauA92FiFZdR2MZ4N50o7b/cWcZmuyuPecZK4wNNbzYL7vGDU21Lwz/V6Ej2zjO24k5StUfl2lW+2N5pfDbOF++7a4OX8OjtyaOYe52oSSTGMiQJl7E7XO/d1bTzNuulIsFK89+mlx9dkZed/cFXB2ndZJFK/sm1Q5l/8eGKZWzR3bxU8W6HOd7QZRBvElQTuYgiOI5tmOJ6WfMlrU0uSdxSb9xXxndRGXc/KKhHydiXzCkK+ksxPWqw2STV3bbb9WnqsxYdr/1qysy8bdv/ACEY+Q4=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},w=void 0,g={},F=[];function X(e){const t={p:"p",...(0,a.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Update Folder"}),"\n",(0,s.jsx)(r(),{method:"put",path:"/folder/{folder_id}",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Update Folder API allows you to uodate folder name as well as parentFolderId."}),"\n",(0,s.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(f.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(i(),{...o(17132)}),"\n",(0,s.jsx)(c(),{...o(63366)}),"\n",(0,s.jsx)(u(),{...o(73260)})]})}function y(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(X,{...e})}):X(e)}},17132(e){e.exports=JSON.parse('{"parameters":[{"name":"folder_id","in":"path","description":"objectId of folder","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"bK1cfd2hpb"}}]}')},63366(e){e.exports=JSON.parse('{"title":"Body","body":{"description":"Provide below parameter to create folder","content":{"application/json":{"schema":{"required":["foldername"],"type":"object","properties":{"folderName":{"type":"string","format":"string","example":"new folder"},"parentFolderId":{"type":"string","format":"string","example":""}},"title":"folder_body"}}}}}')},73260(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"Hks2JpewIp"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"title":"inline_response_200_11"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"folder not found.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","format":"string","example":"folder not found."}},"title":"inline_response_404_8"}}}},"405":{"description":"Invalid API token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/703158d7.6bfdddc4.js b/assets/js/703158d7.6bfdddc4.js deleted file mode 100644 index d91e6aa0f..000000000 --- a/assets/js/703158d7.6bfdddc4.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[9330],{68762(e,t,n){n.r(t),n.d(t,{assets:()=>v,contentTitle:()=>h,default:()=>I,frontMatter:()=>y,metadata:()=>a,toc:()=>Q});const a=JSON.parse('{"id":"API-docs/v1.2/get-user","title":"Get your account details","description":"The Get User API enables you to get your own account details.","source":"@site/docs/API-docs/v1.2/get-user.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/get-user","permalink":"/docs/API-docs/v1.2/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":"eJy9V81u40YSfpVKH5IMQUuyPTPZKJd4F7OOEyMzWHswwNqG0SSLYo+b3Z3uomRBEJBD3iCnXPNo8ySL6hZlSp78GFnkIpHd9fPVf3ElSM6CmF6JtwG9uMlFhaH0ypGyRkzFZYNwigR8CydvzgCNLDQGWNoOyMIMiR892IUBWZa2MwQVklQ6jEQurEMvWdZZJaZihhTV5MJjcNYEDGK6EkeTCf/tar7oyhJDqDsNWyEiF6U1hIaYXjqnVRkvxu8DM61EKBtsJT/R0qGYClu8x5JELpxnMaSSynTMoLaUgbwyM5GL2vpW0vAE72XrNBP9+1TdHR0XzdtvxToXRrb4VAnfWoR/IjI7tlLpp/K/t1ggfr05GJW2ZVGusebJUJ6/ePnFP46PDo+OWcR7W1wq0k+WUuGc2UvbOmmWT+W2Dk1QMxNFeJSE1Ql9TMgDy9Hk6PjgcHIw+eLy8OX0+ZfTFy9Hk8nkvyIX9230Z4qLqCRFP1Mya/veuepv0LPeJ+s49Qdk6X3NhM8nzx9XQKw5Ywlq25nqk/9f8qP31v++7fu61wPcymhl8LYv4VsG35vx4rEZZ2Yutapi97i0d2j+XkuG6impfxwalYjivdgxdXiejAxYdl7RUkyvVuL+QDp1kO6nVzfrm1y0SI3ddDsGLKkRUzGeIXWp9wX0c/Qh8ndei6loiFyYjsdBmqqw96O+KLQsAlf4WDo1nh+OjsQ63+eRzj2JHruDp7IEkjNlZn/Ed/PgmwuOXwrRjoe2gZJOfYdL0bfQHapcKM6bBmUVC4TfaxuZN2F57dBcqJmJQY3K9+fWO9SlbZFHFDUIWdazfPjp1y1XlkFly65FQzH9Rtfm2rzuPDi7QM+TR5oKao33qtCYxl8b77bzL6BsNYagl6AM4cxLQqjUTJHUwH5SZgaldLJQWnHWMplNI3OQ+GEE7xqkBj1ffeYRJFQ4R83JDrIj20piUT1eWFh/V2u7CDlIKLqgDIYAaBppSibsI5GD9SANoCH0zquAEMgzapWwWUNelgStNHKGLDuHobMq1IrTFbwtukAQrO4iZOAhbz1W0BtkEKsQnfjq3vEV8CkPBo8Np80cYdapCkMOpa0QQixSNsFUUGAgcIxFlRhYaGe0Le9iAOtOa3CWe4aSGmy9g5HZyUsTeNIkLH0Mtg5z3vI+gQlglr0NyBE+V+YuTLPs2hzA1Tav3mERFOHN530JLBaLR6n/bJfnVNE3XQH/QWeDIuuXD9wzRU1XxHIZCtm+JEmnaDDmz6AYHmRUtgyPq49Pxw1qN75A4gwJ45M3Z7HNPoMPP/4M5yi9gcYuUraWnUe9hFmvij2XIp/ctu2SUNuYeA17vEzJ5/GHDgP1HnzXSPrw4y8BvscFKLMpKTYly3hnvMTWaVbyKey8nqtAWTYFj62dYwWdMcihkX4JTnrZInG+MbSAfEBYgfNYK62hkiSh9raN1YV+wDFi1deiVhpvnQxhYX11LR4IQFYVVow0LRpAG0Q5pI1gcLCheCg3Rc3guvKypofbBFXXERN421FKYOftXFUIPZroVOctYRltquoetNTaLm5tXcfRymL+FPKoeQ/8QH+UCjx24mva3bkhVCqkx6Rw26kYHzWo/FZaDzB5+9ZbjR9HxlWaiAKkac1VuuuoR379Q0c/ihQb7LpCq3Lf4BGclCU6duxc6g7DFLIsIcoy+LzCWnaanuWQZXOFCz7lZ+k4Svw2gosN/pYbXSPnCJJAowwEduMlSZ1HWKhqhvQVJEFDBmM3l+Er6EUHaOVyI88s+/toqu0I5EAwl5jysQ2PrnkU7o3P3SnnsUbPvgvpW6wvaqc2RXzVNwPgHvFXmkla8Q3JMi5tm08XnuNf78uJCxT6NryuL9DPVYmbXeI3+ug4Eo9FLrQq0QQcLGYnp2/OYX48moh8sJT8iZY6Pj/716vvL14xGA5BctjhaDKaxO8lG6iVZqDptP+S3fuK3V8tVg+761/+Ot4sQ4T3NHZaqrh7RjNXm73xSvR7400uGhuIj1arQgZ86/V6zcc/dOh5G73JxVx6xQjiLpr3KxQvmne4ZHfGChFMqLu0h+0t3zsb7OmrS5ELngK7q9tdXN02Dyy9vzLLgezdnS4B4F9eMD/KsFqltXC93tKnq9/k2BjYU7MDb9br9f8AZYjjuA==","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Introduction","permalink":"/docs/API-docs/v1.2/opensign-api-v-1-2"},"next":{"title":"Get your API credits","permalink":"/docs/API-docs/v1.2/getcredits"}}');var o=n(74848),s=n(28453),i=n(57742),r=n.n(i),l=n(78178),p=n.n(l),u=n(19624),c=n.n(u),d=n(96226),g=n.n(d),m=(n(77675),n(19365),n(51107));n(21312);const y={id:"get-user",title:"Get your account details",description:"The Get User API enables you to get your own account details.",sidebar_label:"Get your account details",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V81u40YSfpVKH5IMQUuyPTPZKJd4F7OOEyMzWHswwNqG0SSLYo+b3Z3uomRBEJBD3iCnXPNo8ySL6hZlSp78GFnkIpHd9fPVf3ElSM6CmF6JtwG9uMlFhaH0ypGyRkzFZYNwigR8CydvzgCNLDQGWNoOyMIMiR892IUBWZa2MwQVklQ6jEQurEMvWdZZJaZihhTV5MJjcNYEDGK6EkeTCf/tar7oyhJDqDsNWyEiF6U1hIaYXjqnVRkvxu8DM61EKBtsJT/R0qGYClu8x5JELpxnMaSSynTMoLaUgbwyM5GL2vpW0vAE72XrNBP9+1TdHR0XzdtvxToXRrb4VAnfWoR/IjI7tlLpp/K/t1ggfr05GJW2ZVGusebJUJ6/ePnFP46PDo+OWcR7W1wq0k+WUuGc2UvbOmmWT+W2Dk1QMxNFeJSE1Ql9TMgDy9Hk6PjgcHIw+eLy8OX0+ZfTFy9Hk8nkvyIX9230Z4qLqCRFP1Mya/veuepv0LPeJ+s49Qdk6X3NhM8nzx9XQKw5Ywlq25nqk/9f8qP31v++7fu61wPcymhl8LYv4VsG35vx4rEZZ2Yutapi97i0d2j+XkuG6impfxwalYjivdgxdXiejAxYdl7RUkyvVuL+QDp1kO6nVzfrm1y0SI3ddDsGLKkRUzGeIXWp9wX0c/Qh8ndei6loiFyYjsdBmqqw96O+KLQsAlf4WDo1nh+OjsQ63+eRzj2JHruDp7IEkjNlZn/Ed/PgmwuOXwrRjoe2gZJOfYdL0bfQHapcKM6bBmUVC4TfaxuZN2F57dBcqJmJQY3K9+fWO9SlbZFHFDUIWdazfPjp1y1XlkFly65FQzH9Rtfm2rzuPDi7QM+TR5oKao33qtCYxl8b77bzL6BsNYagl6AM4cxLQqjUTJHUwH5SZgaldLJQWnHWMplNI3OQ+GEE7xqkBj1ffeYRJFQ4R83JDrIj20piUT1eWFh/V2u7CDlIKLqgDIYAaBppSibsI5GD9SANoCH0zquAEMgzapWwWUNelgStNHKGLDuHobMq1IrTFbwtukAQrO4iZOAhbz1W0BtkEKsQnfjq3vEV8CkPBo8Np80cYdapCkMOpa0QQixSNsFUUGAgcIxFlRhYaGe0Le9iAOtOa3CWe4aSGmy9g5HZyUsTeNIkLH0Mtg5z3vI+gQlglr0NyBE+V+YuTLPs2hzA1Tav3mERFOHN530JLBaLR6n/bJfnVNE3XQH/QWeDIuuXD9wzRU1XxHIZCtm+JEmnaDDmz6AYHmRUtgyPq49Pxw1qN75A4gwJ45M3Z7HNPoMPP/4M5yi9gcYuUraWnUe9hFmvij2XIp/ctu2SUNuYeA17vEzJ5/GHDgP1HnzXSPrw4y8BvscFKLMpKTYly3hnvMTWaVbyKey8nqtAWTYFj62dYwWdMcihkX4JTnrZInG+MbSAfEBYgfNYK62hkiSh9raN1YV+wDFi1deiVhpvnQxhYX11LR4IQFYVVow0LRpAG0Q5pI1gcLCheCg3Rc3guvKypofbBFXXERN421FKYOftXFUIPZroVOctYRltquoetNTaLm5tXcfRymL+FPKoeQ/8QH+UCjx24mva3bkhVCqkx6Rw26kYHzWo/FZaDzB5+9ZbjR9HxlWaiAKkac1VuuuoR379Q0c/ihQb7LpCq3Lf4BGclCU6duxc6g7DFLIsIcoy+LzCWnaanuWQZXOFCz7lZ+k4Svw2gosN/pYbXSPnCJJAowwEduMlSZ1HWKhqhvQVJEFDBmM3l+Er6EUHaOVyI88s+/toqu0I5EAwl5jysQ2PrnkU7o3P3SnnsUbPvgvpW6wvaqc2RXzVNwPgHvFXmkla8Q3JMi5tm08XnuNf78uJCxT6NryuL9DPVYmbXeI3+ug4Eo9FLrQq0QQcLGYnp2/OYX48moh8sJT8iZY6Pj/716vvL14xGA5BctjhaDKaxO8lG6iVZqDptP+S3fuK3V8tVg+761/+Ot4sQ4T3NHZaqrh7RjNXm73xSvR7400uGhuIj1arQgZ86/V6zcc/dOh5G73JxVx6xQjiLpr3KxQvmne4ZHfGChFMqLu0h+0t3zsb7OmrS5ELngK7q9tdXN02Dyy9vzLLgezdnS4B4F9eMD/KsFqltXC93tKnq9/k2BjYU7MDb9br9f8AZYjjuA==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},h=void 0,v={},Q=[];function x(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Get your account details"}),"\n",(0,o.jsx)(r(),{method:"get",path:"/getuser",context:"endpoint"}),"\n",(0,o.jsx)(t.p,{children:"The Get User API enables you to get your own account details."}),"\n",(0,o.jsx)(p(),{parameters:void 0}),"\n",(0,o.jsx)(c(),{...n(63559)}),"\n",(0,o.jsx)(g(),{...n(22665)})]})}function I(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(x,{...e})}):x(e)}},63559(e){e.exports={title:"Body"}},22665(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"FGik23bhUJ"},"name":{"type":"string","format":"string","example":"Joe Bee"},"email":{"type":"string","format":"string","example":"joebee@example.com"},"phone":{"type":"string","format":"string","example":"4567832123"},"jobTitle":{"type":"string","format":"string","example":"dev"},"company":{"type":"string","format":"string","example":"opensign"},"createdAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"xml":{"name":"user"},"title":"user"}}}},"404":{"description":"User not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"User not found!"}},"title":"inline_response_404"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/703158d7.d7b826a5.js b/assets/js/703158d7.d7b826a5.js new file mode 100644 index 000000000..17312c5ca --- /dev/null +++ b/assets/js/703158d7.d7b826a5.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[9330],{68762(e,t,s){s.r(t),s.d(t,{assets:()=>T,contentTitle:()=>y,default:()=>x,frontMatter:()=>m,metadata:()=>o,toc:()=>q});const o=JSON.parse('{"id":"API-docs/v1.2/get-user","title":"Get your account details","description":"The Get User API enables you to get your own account details.","source":"@site/docs/API-docs/v1.2/get-user.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/get-user","permalink":"/docs/API-docs/v1.2/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":"eJy9GdtuI7f1V065QLEWRpK9l6RVijSO1+tsus0aK7sL1DI81PBIwxWHnJCckQXbQB6KfkDRl772J/reT9kvKQ45M7p4k42RIg+2JfLc7zy+YZ7PHRtdsHOHll0mTKDLrCy9NJqN2FmOcIIe6BYOT18Baj5V6GBlKvAG5ujpowWz1MCzzFTag0DPpXIDljBTouVE65VgIzZHH9gkzKIrjXbo2OiGPdnfpz/bnMdVlqFzs0pBR4QlLDPao/YEz8tSySxcDN87QrphLsux4PTJr0pkI2am7zHzLGGlJTJeRpbxmITqIJ23Us9ZwmbGFtxvnuA1L0pFQC9P5OLJ02l+/i27S5jmBT6UwrcG4WtEQseCS/VQ/PcGp4hfNQeDzBREqsyNfrAoz55/9vnvnj45ePKUSLw30zPp1YOpCKwJPTNFyfXqodimRO3kXAcSFrlHceg/RmSN8mT/ydP+wX5///Ozg89Gz34/ev7ZYH9//68sYddFsGf0CxPcBzv7qFb3vSrFr8DnbhesotDfAIvf7wjw2f6z+xkQck4bDzNTafGb/1/wo7XG/rTuu7zvNuSWWkmNV20KX5HwrRrP76vxStdcSRGqx5lZoP51Ndlk7yP7+66RESjcsy1VN8+jkg6zykq/YqOLG3bd56Xsx/vRxeXdZcIK9Llpqh0JzH3ORmw4R1/F2ufQ1mhdwK+sYiOWe1+60XDouBZTcz1ok0LxqaMMH/JSDuuDwRN2l+zi8LJ8EDxW/YeiOM/nUs8/hXe5ts2Y/BddtGWhzlG8lH/CFWtL6BZUwiTFTY5chASh7zMTkBu3vClRj+VcB6cG5rt96xG0MB/+9u8ObKIn+kvo9airkSJ9ZyqbIbwwWRXoceXRau5ljfDhh3/CtJKKcsCCwBoVhZ5LwNvKeRQwXQFqj7a00qEb9HpEf5PvXNZNq+RA9VGhxwRKa0SVkaB9i1ysAPtkUe4ri1Aq7qlegs+tqeY5cHBSzxUm8PZ4fEbt8PD01QDGqAUIk1UFau+CiB2RBAqu+RzBY0H0MMjMs0UAkXoOznNfOZAaLHIFXhaYANcCeOVNwT3Gpo7aS4sdG1ByhtkqU9E4XClYSp+bykONWhgLymSLvtQDMkS/36c/jx7RAOGJ69hz61HQ6XGNdgUWv6/QeSgq5yHj1q4i3y5XSUKfI6Qb8ZFCjIzAJE3Tid64HMEfiML64MsGZqJ7vQ9//wdcfGOWcXDRNFTgDsPLx23QC5O5+9FOp8McVTkcR6Xc8PD0VShre9H/3xkPjjy5zNEisZriXOo/0ggVdOn1mjQH1LW0RpNpez14nP7sMpDuEd3SGm8onzov8NkMs2BqRREsuOc7rjgyFuGIl3wqlaQqSue3cMQ9zo1dwS28y3kY6SDjGoSB24m+7ff74YdAe70XbdT1enALR6FpJ+BQiwRia03AYm0WTUwJpLhfh2e/dfs6fBvKZ228BspfV1IJsFg5GjnXwRzUhdJiv1Q8QwFLKebo3RdBBrKM0QjGUhasAlu0HYsxqlmf8jOwOGmjwNFxAN3Mqs6uDRWQupY+tCqYKbNsiZ5WUyUz2BZ/nHOLwKGMl23qKakXIX20aakq6XzIBWlRtDRfWD7z8M7YBXGKFHmNG9IZu2ET7kAQhgsmn0nNlYwBVwBB2JbukdGeZ43z/hzrRMiBRpgs3sPUmAWF2NzyouBeZlypVUvkpVECbaTxxs65Jl5ryaR2UmBXguGFpXCcRaSWxjuc5sYsIpG3mCHBUDnqUzkCrKniaOPlrJkOHPCNxwZqURqpfUuOJpaWlrcSa+zeI2SRzKKQHqiT0DBKHrzdTg0K/A8//MvBd7ikutM2jEeUNgo5Gaf1cMuDq4lOT47PYNh6YjiSIg0ct8/Jxynk5MEpogbnLfKCBikRosGiqLTg2kPJLS/Qk6UogCwWpkYRSPZ6pcWZVCqkNkgH2izBoq8s0XFIuB7VCmbWFK1H1wR7PWoNCwrD7gEGyJ1ES2mTGe2qAget1qfcuaWxon9qjceMWt7pi5cwrsrSWD/RdA/phM2kwquyAZ6wtK3abZ5PjVhROdSwNDZwDxmMOrOrsqHqBi1dFGD0aKLT0zfjMxjGR0FrxhT++x9IT8/vWTwcbyC0wTgctXBX22AhW1qoexc7/MIF1Qgyadra581sRg6EcZPalFrWqIkeoye7cKXM8spEqCtCnbARTQ8ItzDjymEKRsOPKBpi6COaegN4TSOz9GrVvMepFggZ62TDrys4NBogz/KuWHT+Hcf4eGsU9QEaitKmWqYQB+4QXzzLsKTCQjpFgCtrFJKnZxKVAJ5Z41wYCIIWlF3WVB7dAM5yiwgEH+PZtV4exdZD3KnYY85rScm923AamVLoPRY445Xye6F0hZmhGaqoMijkzofSv56mYmeIJSKtJS6JTldtXIjSbrohQ1kkKDBardoi3XQXCN5s63PKy9KaOpI74jpmNvWbFhyvyWpN64jSNCU+MLvtSgu3U6PhyJQreHx0tEfCyVJSHZ3oQ9C4JLNn2draTdp3hgSujJ6Hikv64LV0YQZIJ2y6iWd0p2vSBUMS20aItq4Jdl4cxn7eOfOYNhbAhbDoqHZQVUNB+d7JaJtKzmmgmxrdz0izzToOYe8BRme47QDpOoeKAbyWC1zrkJD4W9LAY1dlOTW+mCXrjJci3aPWVUvR2CGKRv6yUjR+by0ANVcVJqHhxCpFllWSDEvdFLAo/Qq4tXwFj9OLy3TvCzCF9IFKNK03IHWOtjncJr0zgh3WXKqQqcfr+a+ZwzZOKCe4Qzh/+/ojM9g4joih3z1gbuwGlu4Jsk3hJ194HfbxObzF+T3kT70s092O+xe0TppQpH4LX/NsseRWODiiTZKXYUJdESghU3DMKhpBpi1gP2sAVZyAoT4IYVwfDA66B0o7JrjYEn1uHEIdGceCxDt/GGpb0sG0tXugqg1MLcaumeVczykRaEbYaNSSCr+ospgLQV4ibcJzlCuotELnwPgc7ZJmJW0oxrfNce6QnnevpV6EcOjDRTdBvcOpkx7Xz5PlcnnP0nsB52WlFLQzeki4TzxqItqJ9N9UU3iLpXHSG7taY82lz6tp8OUmbvelIdDO0t2i55c8pgLJM7SFAzODMdpaZp9Qf+gJfLg3oRXCztpheztgcYaW6o7begryUjbPzotWDiDxfokecTUaRuqwsIorX9p/fLVLJyyeSIU3s0bfZgfz0/qyhCmZoXa4sdA6PDl9DfXTwT5LNpY5P8OXw9evjo6/Gx+TME2asBE7GOwP9sOe2ThfcL3B6aT9D8DO9n93JXOz3vn94v8qNEskj9d+WCouw84uqHnT7NsuWLtvu0xYbpyno5sbyuxzq+7u6Pj7Ci1t8S4TVnMrSYKww0va1RMt6Ba4InOGEYgRoKri/mpnabm1+Ts5PmMJ4xVJsrnyWoSVV/OBqLdXerVBe3sXFgWg37SY+yjCzU1cp93ddfDx6kcxGgVbaDLg5d3d3f8AO78rTg==","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Introduction","permalink":"/docs/API-docs/v1.2/opensign-api-v-1-2"},"next":{"title":"Get your API credits","permalink":"/docs/API-docs/v1.2/getcredits"}}');var a=s(74848),n=s(28453),i=s(57742),r=s.n(i),p=s(78178),c=s.n(p),d=s(19624),l=s.n(d),u=s(96226),g=s.n(u),z=(s(77675),s(19365),s(51107));s(21312);const m={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:"eJy9GdtuI7f1V065QLEWRpK9l6RVijSO1+tsus0aK7sL1DI81PBIwxWHnJCckQXbQB6KfkDRl772J/reT9kvKQ45M7p4k42RIg+2JfLc7zy+YZ7PHRtdsHOHll0mTKDLrCy9NJqN2FmOcIIe6BYOT18Baj5V6GBlKvAG5ujpowWz1MCzzFTag0DPpXIDljBTouVE65VgIzZHH9gkzKIrjXbo2OiGPdnfpz/bnMdVlqFzs0pBR4QlLDPao/YEz8tSySxcDN87QrphLsux4PTJr0pkI2am7zHzLGGlJTJeRpbxmITqIJ23Us9ZwmbGFtxvnuA1L0pFQC9P5OLJ02l+/i27S5jmBT6UwrcG4WtEQseCS/VQ/PcGp4hfNQeDzBREqsyNfrAoz55/9vnvnj45ePKUSLw30zPp1YOpCKwJPTNFyfXqodimRO3kXAcSFrlHceg/RmSN8mT/ydP+wX5///Ozg89Gz34/ev7ZYH9//68sYddFsGf0CxPcBzv7qFb3vSrFr8DnbhesotDfAIvf7wjw2f6z+xkQck4bDzNTafGb/1/wo7XG/rTuu7zvNuSWWkmNV20KX5HwrRrP76vxStdcSRGqx5lZoP51Ndlk7yP7+66RESjcsy1VN8+jkg6zykq/YqOLG3bd56Xsx/vRxeXdZcIK9Llpqh0JzH3ORmw4R1/F2ufQ1mhdwK+sYiOWe1+60XDouBZTcz1ok0LxqaMMH/JSDuuDwRN2l+zi8LJ8EDxW/YeiOM/nUs8/hXe5ts2Y/BddtGWhzlG8lH/CFWtL6BZUwiTFTY5chASh7zMTkBu3vClRj+VcB6cG5rt96xG0MB/+9u8ObKIn+kvo9airkSJ9ZyqbIbwwWRXoceXRau5ljfDhh3/CtJKKcsCCwBoVhZ5LwNvKeRQwXQFqj7a00qEb9HpEf5PvXNZNq+RA9VGhxwRKa0SVkaB9i1ysAPtkUe4ri1Aq7qlegs+tqeY5cHBSzxUm8PZ4fEbt8PD01QDGqAUIk1UFau+CiB2RBAqu+RzBY0H0MMjMs0UAkXoOznNfOZAaLHIFXhaYANcCeOVNwT3Gpo7aS4sdG1ByhtkqU9E4XClYSp+bykONWhgLymSLvtQDMkS/36c/jx7RAOGJ69hz61HQ6XGNdgUWv6/QeSgq5yHj1q4i3y5XSUKfI6Qb8ZFCjIzAJE3Tid64HMEfiML64MsGZqJ7vQ9//wdcfGOWcXDRNFTgDsPLx23QC5O5+9FOp8McVTkcR6Xc8PD0VShre9H/3xkPjjy5zNEisZriXOo/0ggVdOn1mjQH1LW0RpNpez14nP7sMpDuEd3SGm8onzov8NkMs2BqRREsuOc7rjgyFuGIl3wqlaQqSue3cMQ9zo1dwS28y3kY6SDjGoSB24m+7ff74YdAe70XbdT1enALR6FpJ+BQiwRia03AYm0WTUwJpLhfh2e/dfs6fBvKZ228BspfV1IJsFg5GjnXwRzUhdJiv1Q8QwFLKebo3RdBBrKM0QjGUhasAlu0HYsxqlmf8jOwOGmjwNFxAN3Mqs6uDRWQupY+tCqYKbNsiZ5WUyUz2BZ/nHOLwKGMl23qKakXIX20aakq6XzIBWlRtDRfWD7z8M7YBXGKFHmNG9IZu2ET7kAQhgsmn0nNlYwBVwBB2JbukdGeZ43z/hzrRMiBRpgs3sPUmAWF2NzyouBeZlypVUvkpVECbaTxxs65Jl5ryaR2UmBXguGFpXCcRaSWxjuc5sYsIpG3mCHBUDnqUzkCrKniaOPlrJkOHPCNxwZqURqpfUuOJpaWlrcSa+zeI2SRzKKQHqiT0DBKHrzdTg0K/A8//MvBd7ikutM2jEeUNgo5Gaf1cMuDq4lOT47PYNh6YjiSIg0ct8/Jxynk5MEpogbnLfKCBikRosGiqLTg2kPJLS/Qk6UogCwWpkYRSPZ6pcWZVCqkNkgH2izBoq8s0XFIuB7VCmbWFK1H1wR7PWoNCwrD7gEGyJ1ES2mTGe2qAget1qfcuaWxon9qjceMWt7pi5cwrsrSWD/RdA/phM2kwquyAZ6wtK3abZ5PjVhROdSwNDZwDxmMOrOrsqHqBi1dFGD0aKLT0zfjMxjGR0FrxhT++x9IT8/vWTwcbyC0wTgctXBX22AhW1qoexc7/MIF1Qgyadra581sRg6EcZPalFrWqIkeoye7cKXM8spEqCtCnbARTQ8ItzDjymEKRsOPKBpi6COaegN4TSOz9GrVvMepFggZ62TDrys4NBogz/KuWHT+Hcf4eGsU9QEaitKmWqYQB+4QXzzLsKTCQjpFgCtrFJKnZxKVAJ5Z41wYCIIWlF3WVB7dAM5yiwgEH+PZtV4exdZD3KnYY85rScm923AamVLoPRY445Xye6F0hZmhGaqoMijkzofSv56mYmeIJSKtJS6JTldtXIjSbrohQ1kkKDBardoi3XQXCN5s63PKy9KaOpI74jpmNvWbFhyvyWpN64jSNCU+MLvtSgu3U6PhyJQreHx0tEfCyVJSHZ3oQ9C4JLNn2draTdp3hgSujJ6Hikv64LV0YQZIJ2y6iWd0p2vSBUMS20aItq4Jdl4cxn7eOfOYNhbAhbDoqHZQVUNB+d7JaJtKzmmgmxrdz0izzToOYe8BRme47QDpOoeKAbyWC1zrkJD4W9LAY1dlOTW+mCXrjJci3aPWVUvR2CGKRv6yUjR+by0ANVcVJqHhxCpFllWSDEvdFLAo/Qq4tXwFj9OLy3TvCzCF9IFKNK03IHWOtjncJr0zgh3WXKqQqcfr+a+ZwzZOKCe4Qzh/+/ojM9g4joih3z1gbuwGlu4Jsk3hJ194HfbxObzF+T3kT70s092O+xe0TppQpH4LX/NsseRWODiiTZKXYUJdESghU3DMKhpBpi1gP2sAVZyAoT4IYVwfDA66B0o7JrjYEn1uHEIdGceCxDt/GGpb0sG0tXugqg1MLcaumeVczykRaEbYaNSSCr+ospgLQV4ibcJzlCuotELnwPgc7ZJmJW0oxrfNce6QnnevpV6EcOjDRTdBvcOpkx7Xz5PlcnnP0nsB52WlFLQzeki4TzxqItqJ9N9UU3iLpXHSG7taY82lz6tp8OUmbvelIdDO0t2i55c8pgLJM7SFAzODMdpaZp9Qf+gJfLg3oRXCztpheztgcYaW6o7begryUjbPzotWDiDxfokecTUaRuqwsIorX9p/fLVLJyyeSIU3s0bfZgfz0/qyhCmZoXa4sdA6PDl9DfXTwT5LNpY5P8OXw9evjo6/Gx+TME2asBE7GOwP9sOe2ThfcL3B6aT9D8DO9n93JXOz3vn94v8qNEskj9d+WCouw84uqHnT7NsuWLtvu0xYbpyno5sbyuxzq+7u6Pj7Ci1t8S4TVnMrSYKww0va1RMt6Ba4InOGEYgRoKri/mpnabm1+Ts5PmMJ4xVJsrnyWoSVV/OBqLdXerVBe3sXFgWg37SY+yjCzU1cp93ddfDx6kcxGgVbaDLg5d3d3f8AO78rTg==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},y=void 0,T={},q=[];function R(e){const t={p:"p",...(0,n.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(z.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(),{...s(63559)}),"\n",(0,a.jsx)(g(),{...s(22665)})]})}function x(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(R,{...e})}):R(e)}},63559(e){e.exports={title:"Body"}},22665(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"FGik23bhUJ"},"name":{"type":"string","format":"string","example":"Joe Bee"},"email":{"type":"string","format":"string","example":"joebee@example.com"},"phone":{"type":"string","format":"string","example":"4567832123"},"jobTitle":{"type":"string","format":"string","example":"dev"},"company":{"type":"string","format":"string","example":"opensign"},"createdAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"xml":{"name":"user"},"title":"user"}}}},"404":{"description":"User not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"User not found!"}},"title":"inline_response_404"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/74c638d3.95f1a2ef.js b/assets/js/74c638d3.95f1a2ef.js deleted file mode 100644 index 8db5d8a86..000000000 --- a/assets/js/74c638d3.95f1a2ef.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[1335],{51412(e,t,a){a.r(t),a.d(t,{assets:()=>f,contentTitle:()=>x,default:()=>k,frontMatter:()=>g,metadata:()=>s,toc:()=>y});const s=JSON.parse('{"id":"API-docs/v1.2/gettemplatelist","title":"Get Template list","description":"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.","source":"@site/docs/API-docs/v1.2/gettemplatelist.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/gettemplatelist","permalink":"/docs/API-docs/v1.2/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":"eJzdWc2OG7kRfpUKD4nd6JE045/daC9rZA17kMHayIxhJDMDgd1draaHTXJJtn4yELCHvEFOuebR/CRBkd2t1ki2vJtFNokPY4msIuufX5Xumedzx6bX7AprI7lHx25TVqDLrTBeaMWm7KpCeIUeOhK4EM7Di7fnwKXUSwdr3YDXYNFbgQsEDpIodAl8wYXkmUTw3fkjuKqEg7JROZ3PpfBrMFYvRIEOuAK9QLsQuAz8Um45U0DFMynUHBqH1tGdeaW1QyitrgFXwnna7TlgWaGC3CIP64XOmxqVdyOWMm3QcpLgvGBTNkffcZHsLGWGW16jR0vmuWeK18imTIpa0K4gw/zQoF2zlFn8oREWCzYtuXSYMufXkqhLbWuWMlwZqQtkU28b2s0rrDmb3rOar0Td1Gz6bDJJmV8bYlJNnaFlG+LjtaGDTiebtBfB3Qnzi0nw6Tsnm1s61xmtHDqiPZtM6L/d4HBNnqNzZSOhtyhLWa6VR+WJnhsjRR42xh8cMd3vC6CzD5gHs1s6xot4pUXXSD+g49ZyUlh4rN1x/rhMHu4pnbdCzVkaTMP9cKXXna1OX2eqdmdv52QTLzyt7h+xZXDhQx95xKW0P8LUUUMg3aSsFMfuqbw3bjoed6yUCKNc18StlwrtF94YckJbCDG1SZkTcxVC/eda2upjoueog1lCFH+O8INGyDCIhTUX8ih1hvhtu9DZwlRaHbnm6bPnZ6dPvv7qlG02GzIBquJcvbHFjhEzrSVyNeSkHGrpZ0LNNHHM6ILcf54x5OYmZaFsznRZSqFwRqY/yLebaO8r9BVaaD0FOVfgmqwWHjjk2qypXnoqrb2TA2kBjaPixxXgyqNVXILXWkKpLYSQAYtUb0fwHZa8kT4U1iDr6JD0IXSweOE/b96zydmTk9PJyeSrq9Pn06e/nz57PppMJn9hKVvVwadtPSvafGmzrP/emOI/ck94VPBKN1/mdouFsJj7WWMPRubnygrrnV/rQpRtVXRfGDWN1zOLtVBHI7RjidQzrXKkSMUFvRZ7VX+n6FNeYymkPJTyuxH5Z92EKGwfb1iKYo6eHl2RV2EH6wwLyLDUFoHyJbzOuo3hvRrSHvDzi1Dc/Wk+8bjymV6FosHneMg8+3CIKCHug1atxr7qbACu0o0sgBuD3I4IroBuLFwnyXeYNXN4d54kt4+6Ys6NGWmDiswieeaoiI0LIjRF+TjAHC7zJuQ0XbLgsgm52eu178nTTcpWx5VZQa5PtC2EosMfSSw9NMaghVxbhfZxhFZRwf8e5SYUqAdDeVe99f+kek9Iu+Vx7d6LwldU9qPkv4qsT0nW6risr1HMK/8rC/s1CavNw6L7iWpyHKkMakeHlI+CFSLOtdRHkBqBeUKEWnkn/nqwLG3T4WwT/20ft66I09ruMziEqB31dm14hlABn3Sazc4mk9nzFiw9nTzb7wXO1YJLUYTW8ErfofrNL9cJoLXHTDa83sfr99UXkSjssx1lh+sdIswbK/w6NICrE27ESdyfXt9Sd1Sjr3TbPYaO0VdsysYPGkmHdtF1kQEz9CDecVVkerUf5tyI8eJ0dMao7dvlOZgWn6HH5uSnsjjP50LNj/Hdbg10SU6Mftox0/YdN+KPSA9564UhVdvKVsgJ15DdhSp1YG5988aguhRzFTwbLt+rhChzXSNVBaoFSdKxfPzbP3uuJOknACEGRzfqRr1pLBi9REsdLFcFlBJXgiYWxIZ12OtHHA55LdE5uQahPM4tVZ9CzIXnMqAaAjg5NzwTUlDoEpkmbguD6Hcj6OD8Wje/szQyKXCBkiIeCOjVuxMLWGp7V9KwJQUOGSF6dA5QVVzlRNh5IgVtA9RXHq2xwiE4b0lqEWXTyluee6i54nOks1MYGqtAKShcweqscR6clk0QGTwXUlssoFNIIRYuGPEljRdsLOe5ro3FisJmgTBvaKyTQq4LhNgkkwqKUKHzYEgWkWNoORoldX4XHFg2UoLRVDgEl/RqDGUkdm+5clTqoyydD3qDGatpLoFRwCR555A8fCHUnZsmyY06ges+rt5j5oTH7eOzXC73Qv/xLs8r4V83GfwJjXbCa7vecs+Fr5ospMvwkP5LPOkVKgzxM0iG7RmFzt2B90/nblyhNONL9BQhbvzi7XmotY/h449/hwvkVkGllzFa88aiXMO8u4osFz0fzdaXytAN8sZXZPE8Bh8NldD5zoLvK+4//vgPB9/jEoRqU4pUSZKd8eBv96eFSTIFi7VeUDuqFJJruF3DdsgWRHNICx4LaN8vKLjnEaPFnmHAMaKrb8LMZGa4c0ttixu2JQBeFFiQpLFj7fviFGJrOVhoKbbpJnw12C4sL/12N4oqyyATWN34GMBdI9RJE4xqrPaYB52KshN6fwLwRZKHmx8IP7g/nLqdjcbGlgpCIVz8GC/sKxXJ5ysUdjCejQJGa89oqnNYMsrSbhQRn2zK0l1D7dn1qKH3PEUKmyaTIn+o8Ahe5DkaMmyAfm4KSRIlShJ4VMRZxuMUkoSmG7RKn7khL9G3EVy28tdU6CpOk2sPEjnNrlsrcd/Yrqv7BuJBQwalu7b3G+iOdlDzdXueWm/bYuEr3dC0ZntwO7clU4xu6Cl88HzuvnIWS7Rku+DebVIb0SbxdVcMgGrEv1NMIkpVnseZVjuHo3f824fnBBSFtnZvykua3OfdnPITdXQciMcsZVLk2ELmFhe8ePX2AhZPRhOWDkDJF5TU8cX5H15+f/mShCEXRIOdjiajSejstfM1V4ObdkpUi9R2rH2/Ra7/p7+AtNiMmpixkVwEPNxOtSKWvWY7WPY2ZZV2ntbv7zPu8J2Vmw0tx98hCOG2pWb7S8Qdrge/m4RUjZOwT9K2P3BsSW/pixVEG6B32oFFujDyxFow4NrrNXYA+6uXVyxM1KpdkHoXQGr7gU7vttR6cPYueo0C0F/S6SDD/X0EwJtNTx+3PsnRKthRk29uN5vNvwBft7Dx","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Template","permalink":"/docs/API-docs/v1.2/delete-template"},"next":{"title":"Get Webhook","permalink":"/docs/API-docs/v1.2/get-webhook"}}');var n=a(74848),o=a(28453),r=a(57742),i=a.n(r),l=a(78178),p=a.n(l),d=a(19624),m=a.n(d),u=a(96226),c=a.n(u),b=(a(77675),a(19365),a(51107)),h=a(21312);const g={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:"eJzdWc2OG7kRfpUKD4nd6JE045/daC9rZA17kMHayIxhJDMDgd1draaHTXJJtn4yELCHvEFOuebR/CRBkd2t1ki2vJtFNokPY4msIuufX5Xumedzx6bX7AprI7lHx25TVqDLrTBeaMWm7KpCeIUeOhK4EM7Di7fnwKXUSwdr3YDXYNFbgQsEDpIodAl8wYXkmUTw3fkjuKqEg7JROZ3PpfBrMFYvRIEOuAK9QLsQuAz8Um45U0DFMynUHBqH1tGdeaW1QyitrgFXwnna7TlgWaGC3CIP64XOmxqVdyOWMm3QcpLgvGBTNkffcZHsLGWGW16jR0vmuWeK18imTIpa0K4gw/zQoF2zlFn8oREWCzYtuXSYMufXkqhLbWuWMlwZqQtkU28b2s0rrDmb3rOar0Td1Gz6bDJJmV8bYlJNnaFlG+LjtaGDTiebtBfB3Qnzi0nw6Tsnm1s61xmtHDqiPZtM6L/d4HBNnqNzZSOhtyhLWa6VR+WJnhsjRR42xh8cMd3vC6CzD5gHs1s6xot4pUXXSD+g49ZyUlh4rN1x/rhMHu4pnbdCzVkaTMP9cKXXna1OX2eqdmdv52QTLzyt7h+xZXDhQx95xKW0P8LUUUMg3aSsFMfuqbw3bjoed6yUCKNc18StlwrtF94YckJbCDG1SZkTcxVC/eda2upjoueog1lCFH+O8INGyDCIhTUX8ih1hvhtu9DZwlRaHbnm6bPnZ6dPvv7qlG02GzIBquJcvbHFjhEzrSVyNeSkHGrpZ0LNNHHM6ILcf54x5OYmZaFsznRZSqFwRqY/yLebaO8r9BVaaD0FOVfgmqwWHjjk2qypXnoqrb2TA2kBjaPixxXgyqNVXILXWkKpLYSQAYtUb0fwHZa8kT4U1iDr6JD0IXSweOE/b96zydmTk9PJyeSrq9Pn06e/nz57PppMJn9hKVvVwadtPSvafGmzrP/emOI/ck94VPBKN1/mdouFsJj7WWMPRubnygrrnV/rQpRtVXRfGDWN1zOLtVBHI7RjidQzrXKkSMUFvRZ7VX+n6FNeYymkPJTyuxH5Z92EKGwfb1iKYo6eHl2RV2EH6wwLyLDUFoHyJbzOuo3hvRrSHvDzi1Dc/Wk+8bjymV6FosHneMg8+3CIKCHug1atxr7qbACu0o0sgBuD3I4IroBuLFwnyXeYNXN4d54kt4+6Ys6NGWmDiswieeaoiI0LIjRF+TjAHC7zJuQ0XbLgsgm52eu178nTTcpWx5VZQa5PtC2EosMfSSw9NMaghVxbhfZxhFZRwf8e5SYUqAdDeVe99f+kek9Iu+Vx7d6LwldU9qPkv4qsT0nW6risr1HMK/8rC/s1CavNw6L7iWpyHKkMakeHlI+CFSLOtdRHkBqBeUKEWnkn/nqwLG3T4WwT/20ft66I09ruMziEqB31dm14hlABn3Sazc4mk9nzFiw9nTzb7wXO1YJLUYTW8ErfofrNL9cJoLXHTDa83sfr99UXkSjssx1lh+sdIswbK/w6NICrE27ESdyfXt9Sd1Sjr3TbPYaO0VdsysYPGkmHdtF1kQEz9CDecVVkerUf5tyI8eJ0dMao7dvlOZgWn6HH5uSnsjjP50LNj/Hdbg10SU6Mftox0/YdN+KPSA9564UhVdvKVsgJ15DdhSp1YG5988aguhRzFTwbLt+rhChzXSNVBaoFSdKxfPzbP3uuJOknACEGRzfqRr1pLBi9REsdLFcFlBJXgiYWxIZ12OtHHA55LdE5uQahPM4tVZ9CzIXnMqAaAjg5NzwTUlDoEpkmbguD6Hcj6OD8Wje/szQyKXCBkiIeCOjVuxMLWGp7V9KwJQUOGSF6dA5QVVzlRNh5IgVtA9RXHq2xwiE4b0lqEWXTyluee6i54nOks1MYGqtAKShcweqscR6clk0QGTwXUlssoFNIIRYuGPEljRdsLOe5ro3FisJmgTBvaKyTQq4LhNgkkwqKUKHzYEgWkWNoORoldX4XHFg2UoLRVDgEl/RqDGUkdm+5clTqoyydD3qDGatpLoFRwCR555A8fCHUnZsmyY06ges+rt5j5oTH7eOzXC73Qv/xLs8r4V83GfwJjXbCa7vecs+Fr5ospMvwkP5LPOkVKgzxM0iG7RmFzt2B90/nblyhNONL9BQhbvzi7XmotY/h449/hwvkVkGllzFa88aiXMO8u4osFz0fzdaXytAN8sZXZPE8Bh8NldD5zoLvK+4//vgPB9/jEoRqU4pUSZKd8eBv96eFSTIFi7VeUDuqFJJruF3DdsgWRHNICx4LaN8vKLjnEaPFnmHAMaKrb8LMZGa4c0ttixu2JQBeFFiQpLFj7fviFGJrOVhoKbbpJnw12C4sL/12N4oqyyATWN34GMBdI9RJE4xqrPaYB52KshN6fwLwRZKHmx8IP7g/nLqdjcbGlgpCIVz8GC/sKxXJ5ysUdjCejQJGa89oqnNYMsrSbhQRn2zK0l1D7dn1qKH3PEUKmyaTIn+o8Ahe5DkaMmyAfm4KSRIlShJ4VMRZxuMUkoSmG7RKn7khL9G3EVy28tdU6CpOk2sPEjnNrlsrcd/Yrqv7BuJBQwalu7b3G+iOdlDzdXueWm/bYuEr3dC0ZntwO7clU4xu6Cl88HzuvnIWS7Rku+DebVIb0SbxdVcMgGrEv1NMIkpVnseZVjuHo3f824fnBBSFtnZvykua3OfdnPITdXQciMcsZVLk2ELmFhe8ePX2AhZPRhOWDkDJF5TU8cX5H15+f/mShCEXRIOdjiajSejstfM1V4ObdkpUi9R2rH2/Ra7/p7+AtNiMmpixkVwEPNxOtSKWvWY7WPY2ZZV2ntbv7zPu8J2Vmw0tx98hCOG2pWb7S8Qdrge/m4RUjZOwT9K2P3BsSW/pixVEG6B32oFFujDyxFow4NrrNXYA+6uXVyxM1KpdkHoXQGr7gU7vttR6cPYueo0C0F/S6SDD/X0EwJtNTx+3PsnRKthRk29uN5vNvwBft7Dx",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},x=void 0,f={},y=[];function w(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(b.default,{as:"h1",className:"openapi__heading",children:"Get Template list"}),"\n",(0,n.jsx)(i(),{method:"get",path:"/templatelist",context:"endpoint"}),"\n",(0,n.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,n.jsx)(b.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,n.jsx)(h.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,n.jsx)(p(),{...a(57373)}),"\n",(0,n.jsx)(m(),{...a(28527)}),"\n",(0,n.jsx)(c(),{...a(5185)})]})}function k(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(w,{...e})}):w(e)}},57373(e){e.exports=JSON.parse('{"parameters":[{"name":"limit","in":"query","required":false,"style":"form","explode":true,"schema":{"maximum":500,"type":"number"},"example":10},{"name":"skip","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"number"},"example":0}]}')},28527(e){e.exports={title:"Body"}},5185(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"x1Hbnms2Pg"},"title":{"type":"string","example":"sample template"},"note":{"type":"string","example":"template note"},"file":{"type":"string","example":"https://templateuser.com"},"owner":{"type":"string","example":"template creator name"},"signers":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","example":"ceo"},"name":{"type":"string","example":"joe bee"},"email":{"type":"string","example":"joebee@example.com"},"phone":{"type":"string","example":"456213871"}}}},"sendInOrder":{"type":"boolean","example":true},"send_in_order_strict":{"type":"boolean","example":false},"allow_offline_sign":{"type":"boolean","description":"Whether signers can submit a copy of this template signed using an external tool for owner review. Defaults to false.","example":false},"createdAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"enableTour":{"type":"boolean","example":true},"redirect_url":{"type":"string","format":"string","example":""},"allow_modifications":{"type":"boolean","example":false},"auto_reminder":{"type":"boolean","example":false},"remind_once_in_every":{"type":"number","example":0},"prefill":{"type":"object","description":"You can provide widgets which can embed before sending to signer","properties":{"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","format":"string","example":"textbox"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":100},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":30},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":40},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":80},"options":{"type":"object","properties":{"name":{"type":"string","example":"textbox"},"response":{"type":"string","example":"joe"},"color":{"type":"string","example":"red"},"fontsize":{"type":"number","example":12}}}}}}},"title":"prefill"}},"xml":{"name":"template"},"title":"template"}}},"title":"inline_response_200_6"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/74c638d3.e09a75e4.js b/assets/js/74c638d3.e09a75e4.js new file mode 100644 index 000000000..d0509d1c7 --- /dev/null +++ b/assets/js/74c638d3.e09a75e4.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[1335],{51412(e,t,a){a.r(t),a.d(t,{assets:()=>g,contentTitle:()=>b,default:()=>G,frontMatter:()=>v,metadata:()=>s,toc:()=>h});const s=JSON.parse('{"id":"API-docs/v1.2/gettemplatelist","title":"Get Template list","description":"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.","source":"@site/docs/API-docs/v1.2/gettemplatelist.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/gettemplatelist","permalink":"/docs/API-docs/v1.2/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":"eJzdWutuI7cVfpXTWaBYC6OLvZekSpHGsZ1do9ussbK7aC3D4swcaRhxyAnJkazaAvKj6AMU/dO/fYn+76PskxSH5Iwky7vaXNC0DZBslnPO4eHhuX7UbWTZxET9y+gci1Iwiya6iqMMTap5abmSUT86zxFeoIWaBF5xY+Hw7BSYEGpuYKEqsAo0Ws1xhsBAEIUaA5sxLlgiEGwtvwPnOTcwrmRK8pngdgGlVjOeoQEmQc1QzzjOHb8QK84YULJEcDmByqA2tGeaK2UQxloVgDfcWPracMA8RwmpRubWM5VWBUprOlEcqRI1Iw1Os6gfTdDWXKR7FEcl06xAi5rMcxtJVmDUjwQvOH3lZJhvK9SLKI40fltxjVnUHzNhMI6MXQiiHitdRHGEN6VQGUZ9qyv6muZYsKh/GxXshhdVEfWf9XpxZBclMcmqSFBHS+JjRUmC9nvLuFHBTHn5k2nw/j17yyuSa0olDRqiPej16I9N5zBVmqIx40pAY9EojlIlLUpL9KwsBU/dh+43hphutxVQyTeYOrNrEmO531KjqYRdo2NaMzowt1iY3fx+mW64oTRWczmJYmcaZtdXmrNHN/svE1mYg7MJ2cRyS6vbIlYMxv1P43nEJZXdwVRTgyNdxtGY79ont7Y0/W63ZqVA6KSqIG41l6g/ckcXE0qD86llHBk+kc7Vf6iltdqleorKmcV58YcIv1EICTq1sGBc7KROEL8IC7UtylzJHds8ffb8YP/Jp5/sR8vlkkyAMjuVr3W2YcREKYFMrnNSDAX6ay6vFXFc0wap/TCji81lHLm0ea3GY8ElXpPpH+TbDLS3OdocNYSbgpRJMFVScAsMUlUuKF9aSq3NJTvSDCpDyY9JwBuLWjIBVikBY6XBuQxopHzbgWMcs0pYl1idrp2HtHeug9mh/bB5D3oHT9r7vXbvk/P95/2nv+o/e97p9Xp/jOLopnB3GvJZFuIlRFnz96rM/iP7uKKC56r6uGvXmHGNqb2u9IOe+aG0EjWXX6iMj0NWNB/pNZVV1xoLLnd6aM3iqa+VTJE8FWdULbay/kbSp7jGMRfioZDf9Mg/qMp5YSjeMOfZBC0VXZ7m7gsWCWaQ4FhpBIoXV51V8OGtHBIE/PAk5L9+vzuxeGMTdeOSBpvgQ+bZboeIEvx3UDKc2Oa1DcDkqhIZsLJEpjvUroCqNFy2WseYVBO4OG21rh7XyZyVZUeVKMksgiWGklg3I8IyG++5NoeJtHIxTZvMmKhcbDbn2r7J/WUc3ew+zA2kqq10xiUJfyxwbKEqS9SQKi1R7/nWyh/wv+dwPXLUB11583iL/8njPaHTzXef7i3PbE5p32v+s+j6lHTNd+v6Evkktz+zsp+Ssqq8n3Tfk012dypruaPulHc2K0ScKqF2dGrUzFNHqKQ1/E8PpqVVOBws/T+r4lYncVrbLIPrLWpNvVpbl8Gl60/qk10f9HrXz0Oz9LT3bHsWOJUzJnjmRsNzNUX5i59uEkCtd5lsfXvrt98+PvdE7nu0cdj19bojTCvN7cINgDdtVvK2/96/vKLpqECbqzA9uonR5lE/6t4bJA3qWT1Fup6haeINk1mibrbdnJW8O9vvHEQ09m3yPBgWH6DHqv19WYxlEy4nu/iuVgYa0CX6e9ow06qOl/y3SIU83MI6VRhlc2TU15DduRwrxxzu5nWJcsAn0t2s2/x+dnkENc27P/+jIRvKofwcWi2q2HSQtlGVThGOVVo5eUy4htjyGcK77/4GScWFdY1xhjMU5H8mBqsrY6mPWQBKi7rU3KDptFokf33fCZ+hR0OoIyevtBhTe5RVDutoa2TZArBNFmW20gjkKJSwwOZaVZMcGFC3LjCGNyeDcxqrD89OOzBAma3wC6diIySGgklqSNaQEqtZOnUk1HIZy2xlgEvQSO0/LzAGJjOgnrKgDLqgTIzSco3NNiD4GNNFKrxxCIuZc5urysIMZaY0CJVO21x2yBDtdpv+ePSIsCIHtwws0xYzWj2hzhMIpUBjoaiMhZRpvfD7NgFLGlIuH635xwi8Z7hNRqPRUK597MOvScJq4fNAM5St1ru//BUuX6o51YoJSgIn8N6Gq3KTqdQ8UG9Uaro5irI78Icy3cOzU5fb9vz9f60sGLrJeY4aaasEJ1z+Bi6Mr0utVghzQDnjWkkybasFj0cfnQZGrtyVWllF8dTcAhuPMXWmFuTBGbPs3lUcUeN9xEqWcMEpldL6HRwxixOlF3AHb3NmnctSv54puBvKu3a77f4l0lbruPa6Vgvu4MhNf7Hr5mPwM1pME6SaBp/KkPx+5Z7t+tpX7hskN5ijk/xlxUUGGiuzCRi640KpsV0KlmJWzxmfOR3IMkoiKE1RsGjG47DFAMW4TfHptnhRe4Gh5TAer9Rq7BqkAJczbl29grFQ81roWZUInsKm+oOcaYI+S/+xDj3B5dSFj6zHHg+O1ohdLfNYs7GFt0pPaScvkc1wTTul12zCDGTEYZzJx5xwVO9wBRCFruUeKWlZGi7vdz5PuBgIyqT+OyRKTcnFJpoVBbM8ZUIsaiFfKZGh9jJe6wmTtNdKMy4NzX9Nmj7W5I5jz1TLeItJrtTUC3mDKRINpaM2pSPAGWUcqexqLAbvmQ6lAJRZqbi0tbgLUyv0poGd01RV0jqLpDSmW6BKQt0g3eDdZmiQ47/77u8GvsY55Z26YDyisKGBGvUK8Q57MDGUoxcn59DU+G6fZyO34+Y63fEIcrrBBFGCsRpZQf1U5rxBY1bJjEkLK5wZyIE0FmqGmRPZaoU2zoU2cANSzQlmrzTJMUi8FsXCTzHhRlcCWy0qDVNywwbIBWSGo3b9s5KmKrBTn/qMGTNXOmufaWUxpZJ3dvwVDKqyVNoOJX2H0dChlNdlIB5Gozpr13GeqGzhkfe50m53F8EoU70og1TTqeViBkr2h3J09npwDl2PLtVmHMG//gmjs4sti7vlNYbaGbv9mu56k8xFS0219eHefu4D5Qgy6ai2z2sP2MEghDaFllZiKAdoyS7bsN4w6lP3gHDn8bQRgQXvOajzoQdOahUQes9TbsXCv4C4bJdxnyfDfk3CodYAGcERQUxzvwPvH2+UoDpATdEoZMsR+K7b+RdLUywpsdCZPME1obt002OONBqnWhnjGgL/tqIkaFWFxx2NCETv/dnUt9z3pYd2p2SPOZtxCu77BSfoNILW48zjkXsudbmeITRVlBkEMnpjkmuVpp7gvRzCNElOk22M89KmuyFDeeQTlBSLOknXKJa7zTo/j1hJKJcXd8Skj2yqNzU53pDVQunw2oQU7za7a1IL04mScESA7eOjoz1Sjpec8uhQHoLEOZk9TVfWDmHfGBKYUHLiMi6dp3n1Gg2jZJ1PyeasceMMsS8bztuaItjcYtfX8+YyTwh+B5ZlGg3lDspqmFG8NzrqkMkZNXSJkm0HRa/ncXAgPhAIuXkB3DQXmnXgFZ/i6gwxqb+hDTw2VZpT4fNRsop4no32AggZ7OBVo/vS7lWRtm1QcQcUxK7g+CxFlhWcDOveH7Eo7QIc8giPR5dXo73PQBHMTlK8aa0CLnPUYXFT9L0W7LB5Aj1Z9X+hD1tboZhgBuHizasHerCBbxFdvfsefWPTsDQjyKaED054DffJBbzByRbzrslydL/i/h614colqV/ClyydzpnODBypomSWuw51QaTEDO6JmFqQpCZsp4FQ+A4YZvvOjWf7nf1mQKnbBONLos3pdXjmN/YJafUkraR/L0lquzupUkGi0VfNNGdyQoFAPcJaoeaU+LMq9bHg9CXRHlliAiop0BhQ9GAzp16JHviye45xYZDGu1dcTp07tOGy6aDeYmK4xdV4Mp/Ptyy953i+qoSAukd3AbdjqPFsL7h9WSXwBktluFV6seKacJtXibvLdd7mL0FA3Us3aM+PGaacyHPUhSGIcEC/AEh3HL9riby7NyQI4R7ssIkOaByjprxjNkZBVvIwdl7WegCp92PO4dE911I71Mq/XxL+8cV9OQ59oiO8HofzBgzmw+eN4kjwFAPUGPCUwxdnr2D2pNOL4jUw5yPusvvq9Ojk68EJKRPCJOpH+51ep+deRJSxBZNrO238ECQgXBvWvl0hfv+nvxwJmBaBv91SMO5wxPAa6DHAy2gDA7yKo1wZS+u3t5RtLrRYLmnZ/36DkMHQzq1+wTHFxdrvTVxl8S+I76UNPwxZkV7RXzQnWgdZxjXIRht6nkPX7K1xbWG0G0Dni5PzyL1E5pvg3tSBe+F/SHr9SS7WZG+ifl4B+i+d6UGG21sPHC6XDb3/9F6OcMCamu7marlc/hur3fh4","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Template","permalink":"/docs/API-docs/v1.2/delete-template"},"next":{"title":"Get Webhook","permalink":"/docs/API-docs/v1.2/get-webhook"}}');var l=a(74848),p=a(28453),o=a(57742),i=a.n(o),n=a(78178),r=a.n(n),m=a(19624),c=a.n(m),d=a(96226),u=a.n(d),x=(a(77675),a(19365),a(51107)),y=a(21312);const v={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:"eJzdWutuI7cVfpXTWaBYC6OLvZekSpHGsZ1do9ussbK7aC3D4swcaRhxyAnJkazaAvKj6AMU/dO/fYn+76PskxSH5Iwky7vaXNC0DZBslnPO4eHhuX7UbWTZxET9y+gci1Iwiya6iqMMTap5abmSUT86zxFeoIWaBF5xY+Hw7BSYEGpuYKEqsAo0Ws1xhsBAEIUaA5sxLlgiEGwtvwPnOTcwrmRK8pngdgGlVjOeoQEmQc1QzzjOHb8QK84YULJEcDmByqA2tGeaK2UQxloVgDfcWPracMA8RwmpRubWM5VWBUprOlEcqRI1Iw1Os6gfTdDWXKR7FEcl06xAi5rMcxtJVmDUjwQvOH3lZJhvK9SLKI40fltxjVnUHzNhMI6MXQiiHitdRHGEN6VQGUZ9qyv6muZYsKh/GxXshhdVEfWf9XpxZBclMcmqSFBHS+JjRUmC9nvLuFHBTHn5k2nw/j17yyuSa0olDRqiPej16I9N5zBVmqIx40pAY9EojlIlLUpL9KwsBU/dh+43hphutxVQyTeYOrNrEmO531KjqYRdo2NaMzowt1iY3fx+mW64oTRWczmJYmcaZtdXmrNHN/svE1mYg7MJ2cRyS6vbIlYMxv1P43nEJZXdwVRTgyNdxtGY79ont7Y0/W63ZqVA6KSqIG41l6g/ckcXE0qD86llHBk+kc7Vf6iltdqleorKmcV58YcIv1EICTq1sGBc7KROEL8IC7UtylzJHds8ffb8YP/Jp5/sR8vlkkyAMjuVr3W2YcREKYFMrnNSDAX6ay6vFXFc0wap/TCji81lHLm0ea3GY8ElXpPpH+TbDLS3OdocNYSbgpRJMFVScAsMUlUuKF9aSq3NJTvSDCpDyY9JwBuLWjIBVikBY6XBuQxopHzbgWMcs0pYl1idrp2HtHeug9mh/bB5D3oHT9r7vXbvk/P95/2nv+o/e97p9Xp/jOLopnB3GvJZFuIlRFnz96rM/iP7uKKC56r6uGvXmHGNqb2u9IOe+aG0EjWXX6iMj0NWNB/pNZVV1xoLLnd6aM3iqa+VTJE8FWdULbay/kbSp7jGMRfioZDf9Mg/qMp5YSjeMOfZBC0VXZ7m7gsWCWaQ4FhpBIoXV51V8OGtHBIE/PAk5L9+vzuxeGMTdeOSBpvgQ+bZboeIEvx3UDKc2Oa1DcDkqhIZsLJEpjvUroCqNFy2WseYVBO4OG21rh7XyZyVZUeVKMksgiWGklg3I8IyG++5NoeJtHIxTZvMmKhcbDbn2r7J/WUc3ew+zA2kqq10xiUJfyxwbKEqS9SQKi1R7/nWyh/wv+dwPXLUB11583iL/8njPaHTzXef7i3PbE5p32v+s+j6lHTNd+v6Evkktz+zsp+Ssqq8n3Tfk012dypruaPulHc2K0ScKqF2dGrUzFNHqKQ1/E8PpqVVOBws/T+r4lYncVrbLIPrLWpNvVpbl8Gl60/qk10f9HrXz0Oz9LT3bHsWOJUzJnjmRsNzNUX5i59uEkCtd5lsfXvrt98+PvdE7nu0cdj19bojTCvN7cINgDdtVvK2/96/vKLpqECbqzA9uonR5lE/6t4bJA3qWT1Fup6haeINk1mibrbdnJW8O9vvHEQ09m3yPBgWH6DHqv19WYxlEy4nu/iuVgYa0CX6e9ow06qOl/y3SIU83MI6VRhlc2TU15DduRwrxxzu5nWJcsAn0t2s2/x+dnkENc27P/+jIRvKofwcWi2q2HSQtlGVThGOVVo5eUy4htjyGcK77/4GScWFdY1xhjMU5H8mBqsrY6mPWQBKi7rU3KDptFokf33fCZ+hR0OoIyevtBhTe5RVDutoa2TZArBNFmW20gjkKJSwwOZaVZMcGFC3LjCGNyeDcxqrD89OOzBAma3wC6diIySGgklqSNaQEqtZOnUk1HIZy2xlgEvQSO0/LzAGJjOgnrKgDLqgTIzSco3NNiD4GNNFKrxxCIuZc5urysIMZaY0CJVO21x2yBDtdpv+ePSIsCIHtwws0xYzWj2hzhMIpUBjoaiMhZRpvfD7NgFLGlIuH635xwi8Z7hNRqPRUK597MOvScJq4fNAM5St1ru//BUuX6o51YoJSgIn8N6Gq3KTqdQ8UG9Uaro5irI78Icy3cOzU5fb9vz9f60sGLrJeY4aaasEJ1z+Bi6Mr0utVghzQDnjWkkybasFj0cfnQZGrtyVWllF8dTcAhuPMXWmFuTBGbPs3lUcUeN9xEqWcMEpldL6HRwxixOlF3AHb3NmnctSv54puBvKu3a77f4l0lbruPa6Vgvu4MhNf7Hr5mPwM1pME6SaBp/KkPx+5Z7t+tpX7hskN5ijk/xlxUUGGiuzCRi640KpsV0KlmJWzxmfOR3IMkoiKE1RsGjG47DFAMW4TfHptnhRe4Gh5TAer9Rq7BqkAJczbl29grFQ81roWZUInsKm+oOcaYI+S/+xDj3B5dSFj6zHHg+O1ohdLfNYs7GFt0pPaScvkc1wTTul12zCDGTEYZzJx5xwVO9wBRCFruUeKWlZGi7vdz5PuBgIyqT+OyRKTcnFJpoVBbM8ZUIsaiFfKZGh9jJe6wmTtNdKMy4NzX9Nmj7W5I5jz1TLeItJrtTUC3mDKRINpaM2pSPAGWUcqexqLAbvmQ6lAJRZqbi0tbgLUyv0poGd01RV0jqLpDSmW6BKQt0g3eDdZmiQ47/77u8GvsY55Z26YDyisKGBGvUK8Q57MDGUoxcn59DU+G6fZyO34+Y63fEIcrrBBFGCsRpZQf1U5rxBY1bJjEkLK5wZyIE0FmqGmRPZaoU2zoU2cANSzQlmrzTJMUi8FsXCTzHhRlcCWy0qDVNywwbIBWSGo3b9s5KmKrBTn/qMGTNXOmufaWUxpZJ3dvwVDKqyVNoOJX2H0dChlNdlIB5Gozpr13GeqGzhkfe50m53F8EoU70og1TTqeViBkr2h3J09npwDl2PLtVmHMG//gmjs4sti7vlNYbaGbv9mu56k8xFS0219eHefu4D5Qgy6ai2z2sP2MEghDaFllZiKAdoyS7bsN4w6lP3gHDn8bQRgQXvOajzoQdOahUQes9TbsXCv4C4bJdxnyfDfk3CodYAGcERQUxzvwPvH2+UoDpATdEoZMsR+K7b+RdLUywpsdCZPME1obt002OONBqnWhnjGgL/tqIkaFWFxx2NCETv/dnUt9z3pYd2p2SPOZtxCu77BSfoNILW48zjkXsudbmeITRVlBkEMnpjkmuVpp7gvRzCNElOk22M89KmuyFDeeQTlBSLOknXKJa7zTo/j1hJKJcXd8Skj2yqNzU53pDVQunw2oQU7za7a1IL04mScESA7eOjoz1Sjpec8uhQHoLEOZk9TVfWDmHfGBKYUHLiMi6dp3n1Gg2jZJ1PyeasceMMsS8bztuaItjcYtfX8+YyTwh+B5ZlGg3lDspqmFG8NzrqkMkZNXSJkm0HRa/ncXAgPhAIuXkB3DQXmnXgFZ/i6gwxqb+hDTw2VZpT4fNRsop4no32AggZ7OBVo/vS7lWRtm1QcQcUxK7g+CxFlhWcDOveH7Eo7QIc8giPR5dXo73PQBHMTlK8aa0CLnPUYXFT9L0W7LB5Aj1Z9X+hD1tboZhgBuHizasHerCBbxFdvfsefWPTsDQjyKaED054DffJBbzByRbzrslydL/i/h614colqV/ClyydzpnODBypomSWuw51QaTEDO6JmFqQpCZsp4FQ+A4YZvvOjWf7nf1mQKnbBONLos3pdXjmN/YJafUkraR/L0lquzupUkGi0VfNNGdyQoFAPcJaoeaU+LMq9bHg9CXRHlliAiop0BhQ9GAzp16JHviye45xYZDGu1dcTp07tOGy6aDeYmK4xdV4Mp/Ptyy953i+qoSAukd3AbdjqPFsL7h9WSXwBktluFV6seKacJtXibvLdd7mL0FA3Us3aM+PGaacyHPUhSGIcEC/AEh3HL9riby7NyQI4R7ssIkOaByjprxjNkZBVvIwdl7WegCp92PO4dE911I71Mq/XxL+8cV9OQ59oiO8HofzBgzmw+eN4kjwFAPUGPCUwxdnr2D2pNOL4jUw5yPusvvq9Ojk68EJKRPCJOpH+51ep+deRJSxBZNrO238ECQgXBvWvl0hfv+nvxwJmBaBv91SMO5wxPAa6DHAy2gDA7yKo1wZS+u3t5RtLrRYLmnZ/36DkMHQzq1+wTHFxdrvTVxl8S+I76UNPwxZkV7RXzQnWgdZxjXIRht6nkPX7K1xbWG0G0Dni5PzyL1E5pvg3tSBe+F/SHr9SS7WZG+ifl4B+i+d6UGG21sPHC6XDb3/9F6OcMCamu7marlc/hur3fh4",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},b=void 0,g={},h=[];function f(e){const t={p:"p",...(0,p.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(x.default,{as:"h1",className:"openapi__heading",children:"Get Template list"}),"\n",(0,l.jsx)(i(),{method:"get",path:"/templatelist",context:"endpoint"}),"\n",(0,l.jsx)(t.p,{children:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents."}),"\n",(0,l.jsx)(x.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,l.jsx)(y.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,l.jsx)(r(),{...a(57373)}),"\n",(0,l.jsx)(c(),{...a(28527)}),"\n",(0,l.jsx)(u(),{...a(5185)})]})}function G(e={}){const{wrapper:t}={...(0,p.R)(),...e.components};return t?(0,l.jsx)(t,{...e,children:(0,l.jsx)(f,{...e})}):f(e)}},57373(e){e.exports=JSON.parse('{"parameters":[{"name":"limit","in":"query","required":false,"style":"form","explode":true,"schema":{"maximum":500,"type":"number"},"example":10},{"name":"skip","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"number"},"example":0}]}')},28527(e){e.exports={title:"Body"}},5185(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"x1Hbnms2Pg"},"title":{"type":"string","example":"sample template"},"note":{"type":"string","example":"template note"},"file":{"type":"string","example":"https://templateuser.com"},"owner":{"type":"string","example":"template creator name"},"signers":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","example":"ceo"},"name":{"type":"string","example":"joe bee"},"email":{"type":"string","example":"joebee@example.com"},"phone":{"type":"string","example":"456213871"}}}},"sendInOrder":{"type":"boolean","example":true},"send_in_order_strict":{"type":"boolean","example":false},"allow_offline_sign":{"type":"boolean","description":"Whether signers can submit a copy of this template signed using an external tool for owner review. Defaults to false.","example":false},"createdAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"enableTour":{"type":"boolean","example":true},"redirect_url":{"type":"string","format":"string","example":""},"allow_modifications":{"type":"boolean","example":false},"auto_reminder":{"type":"boolean","example":false},"remind_once_in_every":{"type":"number","example":0},"prefill":{"type":"object","description":"You can provide widgets which can embed before sending to signer","properties":{"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","format":"string","example":"textbox"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":100},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":30},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":40},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":80},"options":{"type":"object","properties":{"name":{"type":"string","example":"textbox"},"response":{"type":"string","example":"joe"},"color":{"type":"string","example":"red"},"fontsize":{"type":"number","example":12}}}}}}},"title":"prefill"}},"xml":{"name":"template"},"title":"template"}}},"title":"inline_response_200_6"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/8871da57.bea9a2c0.js b/assets/js/8871da57.bea9a2c0.js new file mode 100644 index 000000000..5df234fb3 --- /dev/null +++ b/assets/js/8871da57.bea9a2c0.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[6742],{13164(e,t,a){a.r(t),a.d(t,{assets:()=>u,contentTitle:()=>T,default:()=>J,frontMatter:()=>I,metadata:()=>l,toc:()=>g});const l=JSON.parse('{"id":"API-docs/v1.2/delete-template","title":"Delete Template","description":"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed","source":"@site/docs/API-docs/v1.2/delete-template.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/delete-template","permalink":"/docs/API-docs/v1.2/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":"eJzNWV9vG8cR/yrTNVBIxJGUbCdFmSKtLCmOUDcWRKkGKgq65d2Qt+He7mV3j9RBIpCHoh+g6Etf+yX63o/iT1LM7t3xSMl2jBRBHxLbe7Pzf34zO7xnjs8tG12zS8wLyR1adhOxFG1iROGEVmzELjOEE5ToEBoqODo/g8LopUjRQqVLWAmXgcsQ+FRI4SpwGgzmeonAwRaYiJlIwDX3Z0bnnrw5sQM4mwHfUAgLSoPUao4GFGKKKYuYLtBw0ussZSOWeq0apVjECm54jg4N2XTPFM+RjVjD81YQC0E2FdxlbNfQsxPQsy2twGXceemWDJoiBJHEx+APpTCYspEzJUbMukqSNCvyQpIyeFdInSIbzbi0RJBkmHM2umeuKjylM0LNWcRm2uTcbU7W6xvibwutLFq68fzggP7YCUyjZa0U2DJJ0NpZKWX1KxaxRCuHytFNXhRSJN51w+8tXb9/rJCefo+JIz8acrQTQXg4Jo8/Vh3vuDd3xF7dZc+5Lb4tXrB1VIcmPXIfv/T84PmL/uFB/+A3l4dfjl7+dvTFl4ODg4O/sIjd5ZLu1jFMKcDriDnh5Obf60dkXuwWYX2yJuKXT7lxrHN0mVBzWKFysDJazSMoJHKL4EwFfM6FAvK0+R96FY3R5uPe+TzN1h2rhZJC4W2TQ7cvDw5uD1snvPxILintYKZLlf6ypj4l/+MGvbz9sjXoi8cGnakllyL1SHWpF6h+WXu64l0Q/zhbRSDy39mWsd3zYKTFpDTCVR7Y7vq8EP3wfXR9Q3BBmaI3oOjB0GVsxIYNmA3vO0C4ZsTSLBuoLI1kI5Y5V9jRcGi5Sqf6bqALVFbMleRTO0h0PuSFGC4PB8/ZOtq9w4vis+ix7H/uFev4XKj5p+7dbLw1poiGoG35rA0dL8QfsWJRE5IuVd0rMuQpGh8+oWbaX64D9bZANRZz5cPshe/2lGfQ0Lz/679asomaqK+h16PWSob0rS5NgnCik9Lz49KhUdyJJcL7H/8B01JIqgsDKS5RUjLaCJwpLeH+tAJUDk1hhEU76PWIf1fuXCzrPs0h0ZSiDiNq4GmZkKJ9gzytAPvkUe5Kg0CJQn0JXGZ0Oc+ojQs1lxjBxen4clZKsmYAY1QppDopc1TOehVbJhHkXPF5p8uTzjxZeBLCNeu4Ky0IBQa5BCdyjICrFHjpdE54UOnSkHXCYCsGpJhhUiUyOIdL6ecPXTpYokq1AamTRV+oATmi3+/TH8+ewWt0jqSOHTcOUzo9XaKpgHo5Wgd5aR0k3JgqyG2rlzSkwSDu5EcMITO8kDiOJ6rzcQS/Iw6bg69rmonq9d7/7e9w/a1e0UwxR0UjDe4IvNlrkj7ViX2c7XQ6zFAWw3Ewyg6Pzs880O2H+H+nHViK5CpDg2F8mQv1e7ii5pEh9Hp1mQOqpTBakWt7PdiLfzIMxPvEtzDaaaqnNgp8NsPEu1pSBqfc8Z1QHGuDcMyLMC4KtHT+AMfc4VybCh7gHY1elLIJV5BqeJioh36/7/8j0l7vpMm6Xg8e4Nggp6y2qNIIyiL1/zK41Is6pwIybtKz34R9k74153Ya9pxflUKmYLC0fCo7yRyG3sJgv5A8wRRWIp2js195HcgzWiFoQ1VQebFoWhFjlLM+1acX8brJAkvHnrRbVa1fay4g1FI437xgJvWqYXpeTqVIYFv9ccYNTeFF+NiUnhRq4ctH6YarFNZBM9c2PE8Mnzl4p82CJAWOfIkd7bTp+IRbSOmG9S6fCcWlCAmXh0Gl4XusleNJHbw/BZzwNVArk4TvMNV6QSk2NzzPuRMJl7JqmHyjZYom8Hhr5lyRrI1mQlmRYgvBcGIoHWfhUsPjHU4zrReByQUmSDQER32CI8AlIY7Sjl4w3uUWQmYa0CsFqNJCC+Uadle2UegCnRFIL6Ak0aVy3iOJwVQ4oE5CQz9F8GG7NCjx3//4Twvf4Ypwp2kYz6hsJHJyTjsu1TK4nKj49eklbLr9SKSxl7h9TjGOIaMIThEVWGeQ5zRcpT4bDKalSrlysHlMASVQeM2lnmWvVxicCSl9aYe32goMutIQH4t016GswkOvjuiGYa9HrWFBadg+cwC5FWiobBKtbJnjoLH6nFu70ibtnxvtMKGWd37yDYzLotDGTRR9h3jCZkLibVETT1jcoHZT51OdVgSHClbaeOm+glElpipqrnbQ8MUUtBpNVHz+dnwJw8TjS+PGGP7zb4jPrx553B93LjTJOBx1pq8uma+WhurRhx15/gNhBLk0bvzzdjajAMK4Lm0qLaPlRI3RkV+4lHp1qwPVLV2dsBFNDwgP4F+nMWgFHzDU59ATljoN9MQViXCSBhAPjjShiICTtbwWcGg0QJ5kLVi08R2H/LjQkvoADUVxjZYxhBHc5xdPEiwIWMimQHBrtESK9EygTIEnRlvrBwJvBVWX0aVfL1xmBhGIPuSzbaI8Cq2HpBPYY8aXgop7t+HUOsXQ20txxkvp9j10+ZmhHqoIGeh55jz0b6ap0BkCRMRLgSvi06KN9VnaTjfkKINEBVrJqgHpuruAj2aDzzEvaA8T2B1zFSqb+k1Djnfktbp1BG1qiPfCHlpo4WaqFRzrooK94+N9Uk4UgnB0oo5A4YrcniQbb9dl3zoSOK1rPOKSPXgnrJ8B4gmbdu9p1doatckQhbbhs61tgm0Uh6Gft8E8zbmQwNPUoCXsIFTDlOq91dHUSM5poJtq1U/Isi6OA3ouWiW4HQBh24CmA3gjFrixISL1t7SBPVsmGTW+UCWbihdpvF+vyWo/BNUoXsavzraWTUsuS4x8wwkoRZ6VghxL3RQwL1wF3BhewV58fRPvfwU6F85zCa51GoTK0NSH26x3RrCjJRfSV+rpZv6r57DOCdUE7RuuLt48MYONw4jo+91nzI3twNI+QbY5fPSF194+vYILnD+6/KmXZbzbcf+MxgrtQerX8IonixU3qYVjnRfcibDQJFK6TMnhF2wwbQj7SU0owwQMy0OfxsvDwWH7QGnGBNvsPrVFWAbBAZB4Gw9NbUtYmDZ+91yVhqnB0DWTjKs5FQLNCJ1GLQj40zIJteD1JdbaP0e5hFJJtBa0y9CsaFZSmnJ82x1XFul590aohU+HPly3E9Q7nFrhcPM8Wa1Wjzy97+98U0oJzYzuC+4Tj5pw7bVw35ZTuMBCW+G0qTa35sJl5dTHsnu3/UfNoJml29XPz3lMeZaXaHJLy+ExmqVIPmH+0BH5cH9CK4SdtcP2dsDgDA3hjt16CvJC1M/O60YPIPV+jh20X6pHar/CIugL+48/7PLxqygy4e2strfewXzcXhYxKRJUFjsrrqPX529g+WJwwKLOMucnxHL45uz49LvxKSlTlwkbscPBweCAjgptXc5VR9LOTxS7m5j7zfLv/+oXjXoP5fDODQvJhV8Eek/d1xu86/YHDBax7hRJP9Vk2joiub8nsLgycr2m4x9KNLQqvInYkhtBqOLXfPVslrY/SnzQR3sX9TtwHz7vd5EnDWq2bYpWbb4ZsRFjEVtgtfMDzfpmHTUrN9I4UBz50a9z99H6dmsHenL65vTylEWMl+TB7rZv4bd99V9IwJOqba8Bgw70f9pJPnnh/j5sEtfrlj58+uCN2saGmvx0s16v/wsKIcEw","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Update Template","permalink":"/docs/API-docs/v1.2/update-template"},"next":{"title":"Get Template list","permalink":"/docs/API-docs/v1.2/gettemplatelist"}}');var s=a(74848),o=a(28453),p=a(57742),i=a.n(p),n=a(78178),r=a.n(n),m=a(19624),d=a.n(m),c=a(96226),h=a.n(c),j=(a(77675),a(19365),a(51107)),b=a(21312);const I={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:"eJzNWV9vG8cR/yrTNVBIxJGUbCdFmSKtLCmOUDcWRKkGKgq65d2Qt+He7mV3j9RBIpCHoh+g6Etf+yX63o/iT1LM7t3xSMl2jBRBHxLbe7Pzf34zO7xnjs8tG12zS8wLyR1adhOxFG1iROGEVmzELjOEE5ToEBoqODo/g8LopUjRQqVLWAmXgcsQ+FRI4SpwGgzmeonAwRaYiJlIwDX3Z0bnnrw5sQM4mwHfUAgLSoPUao4GFGKKKYuYLtBw0ussZSOWeq0apVjECm54jg4N2XTPFM+RjVjD81YQC0E2FdxlbNfQsxPQsy2twGXceemWDJoiBJHEx+APpTCYspEzJUbMukqSNCvyQpIyeFdInSIbzbi0RJBkmHM2umeuKjylM0LNWcRm2uTcbU7W6xvibwutLFq68fzggP7YCUyjZa0U2DJJ0NpZKWX1KxaxRCuHytFNXhRSJN51w+8tXb9/rJCefo+JIz8acrQTQXg4Jo8/Vh3vuDd3xF7dZc+5Lb4tXrB1VIcmPXIfv/T84PmL/uFB/+A3l4dfjl7+dvTFl4ODg4O/sIjd5ZLu1jFMKcDriDnh5Obf60dkXuwWYX2yJuKXT7lxrHN0mVBzWKFysDJazSMoJHKL4EwFfM6FAvK0+R96FY3R5uPe+TzN1h2rhZJC4W2TQ7cvDw5uD1snvPxILintYKZLlf6ypj4l/+MGvbz9sjXoi8cGnakllyL1SHWpF6h+WXu64l0Q/zhbRSDy39mWsd3zYKTFpDTCVR7Y7vq8EP3wfXR9Q3BBmaI3oOjB0GVsxIYNmA3vO0C4ZsTSLBuoLI1kI5Y5V9jRcGi5Sqf6bqALVFbMleRTO0h0PuSFGC4PB8/ZOtq9w4vis+ix7H/uFev4XKj5p+7dbLw1poiGoG35rA0dL8QfsWJRE5IuVd0rMuQpGh8+oWbaX64D9bZANRZz5cPshe/2lGfQ0Lz/679asomaqK+h16PWSob0rS5NgnCik9Lz49KhUdyJJcL7H/8B01JIqgsDKS5RUjLaCJwpLeH+tAJUDk1hhEU76PWIf1fuXCzrPs0h0ZSiDiNq4GmZkKJ9gzytAPvkUe5Kg0CJQn0JXGZ0Oc+ojQs1lxjBxen4clZKsmYAY1QppDopc1TOehVbJhHkXPF5p8uTzjxZeBLCNeu4Ky0IBQa5BCdyjICrFHjpdE54UOnSkHXCYCsGpJhhUiUyOIdL6ecPXTpYokq1AamTRV+oATmi3+/TH8+ewWt0jqSOHTcOUzo9XaKpgHo5Wgd5aR0k3JgqyG2rlzSkwSDu5EcMITO8kDiOJ6rzcQS/Iw6bg69rmonq9d7/7e9w/a1e0UwxR0UjDe4IvNlrkj7ViX2c7XQ6zFAWw3Ewyg6Pzs880O2H+H+nHViK5CpDg2F8mQv1e7ii5pEh9Hp1mQOqpTBakWt7PdiLfzIMxPvEtzDaaaqnNgp8NsPEu1pSBqfc8Z1QHGuDcMyLMC4KtHT+AMfc4VybCh7gHY1elLIJV5BqeJioh36/7/8j0l7vpMm6Xg8e4Nggp6y2qNIIyiL1/zK41Is6pwIybtKz34R9k74153Ya9pxflUKmYLC0fCo7yRyG3sJgv5A8wRRWIp2js195HcgzWiFoQ1VQebFoWhFjlLM+1acX8brJAkvHnrRbVa1fay4g1FI437xgJvWqYXpeTqVIYFv9ccYNTeFF+NiUnhRq4ctH6YarFNZBM9c2PE8Mnzl4p82CJAWOfIkd7bTp+IRbSOmG9S6fCcWlCAmXh0Gl4XusleNJHbw/BZzwNVArk4TvMNV6QSk2NzzPuRMJl7JqmHyjZYom8Hhr5lyRrI1mQlmRYgvBcGIoHWfhUsPjHU4zrReByQUmSDQER32CI8AlIY7Sjl4w3uUWQmYa0CsFqNJCC+Uadle2UegCnRFIL6Ak0aVy3iOJwVQ4oE5CQz9F8GG7NCjx3//4Twvf4Ypwp2kYz6hsJHJyTjsu1TK4nKj49eklbLr9SKSxl7h9TjGOIaMIThEVWGeQ5zRcpT4bDKalSrlysHlMASVQeM2lnmWvVxicCSl9aYe32goMutIQH4t016GswkOvjuiGYa9HrWFBadg+cwC5FWiobBKtbJnjoLH6nFu70ibtnxvtMKGWd37yDYzLotDGTRR9h3jCZkLibVETT1jcoHZT51OdVgSHClbaeOm+glElpipqrnbQ8MUUtBpNVHz+dnwJw8TjS+PGGP7zb4jPrx553B93LjTJOBx1pq8uma+WhurRhx15/gNhBLk0bvzzdjajAMK4Lm0qLaPlRI3RkV+4lHp1qwPVLV2dsBFNDwgP4F+nMWgFHzDU59ATljoN9MQViXCSBhAPjjShiICTtbwWcGg0QJ5kLVi08R2H/LjQkvoADUVxjZYxhBHc5xdPEiwIWMimQHBrtESK9EygTIEnRlvrBwJvBVWX0aVfL1xmBhGIPuSzbaI8Cq2HpBPYY8aXgop7t+HUOsXQ20txxkvp9j10+ZmhHqoIGeh55jz0b6ap0BkCRMRLgSvi06KN9VnaTjfkKINEBVrJqgHpuruAj2aDzzEvaA8T2B1zFSqb+k1Djnfktbp1BG1qiPfCHlpo4WaqFRzrooK94+N9Uk4UgnB0oo5A4YrcniQbb9dl3zoSOK1rPOKSPXgnrJ8B4gmbdu9p1doatckQhbbhs61tgm0Uh6Gft8E8zbmQwNPUoCXsIFTDlOq91dHUSM5poJtq1U/Isi6OA3ouWiW4HQBh24CmA3gjFrixISL1t7SBPVsmGTW+UCWbihdpvF+vyWo/BNUoXsavzraWTUsuS4x8wwkoRZ6VghxL3RQwL1wF3BhewV58fRPvfwU6F85zCa51GoTK0NSH26x3RrCjJRfSV+rpZv6r57DOCdUE7RuuLt48MYONw4jo+91nzI3twNI+QbY5fPSF194+vYILnD+6/KmXZbzbcf+MxgrtQerX8IonixU3qYVjnRfcibDQJFK6TMnhF2wwbQj7SU0owwQMy0OfxsvDwWH7QGnGBNvsPrVFWAbBAZB4Gw9NbUtYmDZ+91yVhqnB0DWTjKs5FQLNCJ1GLQj40zIJteD1JdbaP0e5hFJJtBa0y9CsaFZSmnJ82x1XFul590aohU+HPly3E9Q7nFrhcPM8Wa1Wjzy97+98U0oJzYzuC+4Tj5pw7bVw35ZTuMBCW+G0qTa35sJl5dTHsnu3/UfNoJml29XPz3lMeZaXaHJLy+ExmqVIPmH+0BH5cH9CK4SdtcP2dsDgDA3hjt16CvJC1M/O60YPIPV+jh20X6pHar/CIugL+48/7PLxqygy4e2strfewXzcXhYxKRJUFjsrrqPX529g+WJwwKLOMucnxHL45uz49LvxKSlTlwkbscPBweCAjgptXc5VR9LOTxS7m5j7zfLv/+oXjXoP5fDODQvJhV8Eek/d1xu86/YHDBax7hRJP9Vk2joiub8nsLgycr2m4x9KNLQqvInYkhtBqOLXfPVslrY/SnzQR3sX9TtwHz7vd5EnDWq2bYpWbb4ZsRFjEVtgtfMDzfpmHTUrN9I4UBz50a9z99H6dmsHenL65vTylEWMl+TB7rZv4bd99V9IwJOqba8Bgw70f9pJPnnh/j5sEtfrlj58+uCN2saGmvx0s16v/wsKIcEw",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},T=void 0,u={},g=[];function w(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(j.default,{as:"h1",className:"openapi__heading",children:"Delete Template"}),"\n",(0,s.jsx)(i(),{method:"delete",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,s.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,s.jsx)(j.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(b.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(r(),{...a(63099)}),"\n",(0,s.jsx)(d(),{...a(63337)}),"\n",(0,s.jsx)(h(),{...a(86975)})]})}function J(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(w,{...e})}):w(e)}},63099(e){e.exports=JSON.parse('{"parameters":[{"name":"template_id","in":"path","description":"ID of the template that needs to be deleted","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string"}}]}')},63337(e){e.exports={title:"Body"}},86975(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Template deleted successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","example":"Bxh2aspHp3"},"deletedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"xml":{"name":"delete"},"title":"delete"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"Template not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Template not found!"}},"title":"inline_response_404_6"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/8871da57.e6e99a43.js b/assets/js/8871da57.e6e99a43.js deleted file mode 100644 index b11038283..000000000 --- a/assets/js/8871da57.e6e99a43.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[6742],{13164(e,t,s){s.r(t),s.d(t,{assets:()=>I,contentTitle:()=>g,default:()=>x,frontMatter:()=>v,metadata:()=>a,toc:()=>u});const a=JSON.parse('{"id":"API-docs/v1.2/delete-template","title":"Delete Template","description":"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed","source":"@site/docs/API-docs/v1.2/delete-template.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/delete-template","permalink":"/docs/API-docs/v1.2/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":"eJzNWFFvG7kR/itTPrSJsJZkx5eiupe6jZEzalyCsw8BagsGtTur5ZlL8shZyYIg4B76D+7pXvvT8kuKIXelleTkLmhx6EuiJWfIb74hZz56LUjOg5jciVusnZaEQUwzUWDIvXKkrBETcVshvEGNhNBZwcX7K3DeLlSBAVa2gaWiCqhCkDOlFa2ALHis7QJBQnCYq1LlQJ1/6W0dzbuRMISrEuTOQgUwFrQ1c/RgEAssRCasQy8Z11UhJqKIqDpQIhNOelkjoeeY1sLIGsVEdGs+KF5CcUxOUiUOA716A7bcQwVUSYq7Bw5ohpC25HU8/tgoj4WYkG8wE4FWmncLqnaaweCT07ZAMSmlDmyQV1hLMVkLWrloSV6ZuchEaX0taTey2Ux5/eCsCRjY42w85v8OEtOhbEFBaPIcQygbrVd/EJnIrSE0xJ7SOa3ySN3oh8Du62NAdvYD5sQ8eiaaVNo8DTPjx9DxScZwJ+JvT9WZDO4b90pssjY1xQV93ulsfPbq5HR8Mv7z7enryflfJl+9Ho7H43+KTDzVmn3bHBac4E0mSJHefW+OzOK2e4btyIaNz5+j8cbWSJUyc1iiIVh6a+YZOI0yIJBfgZxLZYCZ9v9DVtF76z/Pzpch2/SiVkYrgw/dGXo4H48fTrcknH/mLBlLUNrGFL9vqM/t//mAzh9ebwP66jigK7OQWhWxUt3aRzS/bzz97Sltf3xaVTKK82Iv2P54CjJg3nhFq1jYnk6kUydpfnI35XLBJ8XuimIshlSJiRh1xWy07hXCjeAl/aIrlY3XYiIqIhcmo1GQppjZp6F1aIKaGy1nYZjbeiSdGi1Oh2dikx36SOe+yB6bky91CSTnysx/zW+6Y+uGM5qStsfZNnXSqX/gSmRdSvpWba+oUBboY/qUKW10bhP1zqG5UXMT0xw3P+wpH1DntkbuHtxYBoPO5eO//r31GgygsHlTo6F4IIf35t68azw4u0RfNhqkKaDU+KRmOjVfrONcar5kIaCsNYagV6AM4dzHvqDmiqQG5omrSC5das8KA5tZ9vbQuwphCB8qpAo9T/3Jc/cucIGajz/IhmwtiZfq8MLS+sdS22XIQMKsCcpgCICmkiZnwy4TGVgP0gAaQu+8CgiBPKNWCZs15GVOUEsj58hrZ9Anq0Ct+LiCt7MmEASrmwgZSCptPRbQBRQbdiTxknuwR+DR3NbOY8XHZoEwb1i7ZJDbAiHEa8shmAJmGAgcY1E5xr7fGG3zx5hA7q3gLFcRJTXrhT5GdicvTeCOnrB0OdgS5rzlJo0J4GDwfUDO8LUyj2EyGNybE7jbnqsPOAuKcPqiuwLL5fLo6L/c93mr6JtmBt+hs0GR9aud91xR1czidekvsv1IK71Fg/H89C7Dbo3C5uH49vHoqELtRjdIfELC6OL9VSy8L+HjTz/DNUpvoLLLdFrzxqNewbzbiplLmU+0besmlDYevIoZz9PhY+mFgToGP1SSPv70S4BvcQnKtFeKQxkM3iLtVOsfYe/zWgUaDCatTi2gMQY5NdKvYKckI7SAPMAay3ksldZQSJJJxjIP6HseQ976XpRK44OTISytL+7FzgBkUWDBSHOPUWW2iDJoXLE/0FrsrlvU2dvpwsuSdrMJqi4jJvC2oXSAW6kOHZpIqvOWMI8xFWUHWmptlw+2LGO75WV+E/K48wH43v5xVWgC00kW0EiuY5ZvR0g/04bbSsX4qELlew+EBDCx/eCtxueR8S1NRgFS/+Zbuk/UEa+/SvRRpjhg18x0/1WTAh7CRZ6jY2IXUjcYJjAYJESDAbwosJSNppcZDAYLhUse5d/ScZb4awg3Lf6aC10l+RFFwLKPwLYsSWo8wlIVc6SvIS3UdzC2nQxfQ7d0gFqu2vXMqpuPodqG+KG2Xbh93TAVw3tuhQftc7/LeSzRM3cxvbtL7VR7ie+6YgBcI/6bYsI6iXuFzKOMw1oqnfr4Xw/XiZIKfR3elTfoFyrHVkt8oo6OovFIZEKrHE3AnlS7ePv+GhavhmOR9UTJbyipo+urv19+e3PJYDgFibDT4Xg45iFnA9XS9HY6eGofKor1TsT+X73MWz1F+EQjp6WKgjYytW6V6N32IS4yMek/yqeZqGwgNlmvZzLg915vNjz8Y4OeJe80EwvpFdeKKFfbulFsH9ef5OjFd+07/SV82fv+2YA61WhYMsbbLSZCZOIRVwd/aNhMN1knHRlxskiVoed79AzZ0/JvLq8vby9FJrgB7qvWx6ha2x+8wbPQ9uVswsD/srZ+1mG9Top4s9nap6lPerQxdtbM03Sz2fwH8Wd5qQ==","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Update Template","permalink":"/docs/API-docs/v1.2/update-template"},"next":{"title":"Get Template list","permalink":"/docs/API-docs/v1.2/gettemplatelist"}}');var i=s(74848),l=s(28453),o=s(57742),p=s.n(o),n=s(78178),r=s.n(n),d=s(19624),c=s.n(d),m=s(96226),h=s.n(m),S=(s(77675),s(19365),s(51107)),b=s(21312);const v={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:"eJzNWFFvG7kR/itTPrSJsJZkx5eiupe6jZEzalyCsw8BagsGtTur5ZlL8shZyYIg4B76D+7pXvvT8kuKIXelleTkLmhx6EuiJWfIb74hZz56LUjOg5jciVusnZaEQUwzUWDIvXKkrBETcVshvEGNhNBZwcX7K3DeLlSBAVa2gaWiCqhCkDOlFa2ALHis7QJBQnCYq1LlQJ1/6W0dzbuRMISrEuTOQgUwFrQ1c/RgEAssRCasQy8Z11UhJqKIqDpQIhNOelkjoeeY1sLIGsVEdGs+KF5CcUxOUiUOA716A7bcQwVUSYq7Bw5ohpC25HU8/tgoj4WYkG8wE4FWmncLqnaaweCT07ZAMSmlDmyQV1hLMVkLWrloSV6ZuchEaX0taTey2Ux5/eCsCRjY42w85v8OEtOhbEFBaPIcQygbrVd/EJnIrSE0xJ7SOa3ySN3oh8Du62NAdvYD5sQ8eiaaVNo8DTPjx9DxScZwJ+JvT9WZDO4b90pssjY1xQV93ulsfPbq5HR8Mv7z7enryflfJl+9Ho7H43+KTDzVmn3bHBac4E0mSJHefW+OzOK2e4btyIaNz5+j8cbWSJUyc1iiIVh6a+YZOI0yIJBfgZxLZYCZ9v9DVtF76z/Pzpch2/SiVkYrgw/dGXo4H48fTrcknH/mLBlLUNrGFL9vqM/t//mAzh9ebwP66jigK7OQWhWxUt3aRzS/bzz97Sltf3xaVTKK82Iv2P54CjJg3nhFq1jYnk6kUydpfnI35XLBJ8XuimIshlSJiRh1xWy07hXCjeAl/aIrlY3XYiIqIhcmo1GQppjZp6F1aIKaGy1nYZjbeiSdGi1Oh2dikx36SOe+yB6bky91CSTnysx/zW+6Y+uGM5qStsfZNnXSqX/gSmRdSvpWba+oUBboY/qUKW10bhP1zqG5UXMT0xw3P+wpH1DntkbuHtxYBoPO5eO//r31GgygsHlTo6F4IIf35t68azw4u0RfNhqkKaDU+KRmOjVfrONcar5kIaCsNYagV6AM4dzHvqDmiqQG5omrSC5das8KA5tZ9vbQuwphCB8qpAo9T/3Jc/cucIGajz/IhmwtiZfq8MLS+sdS22XIQMKsCcpgCICmkiZnwy4TGVgP0gAaQu+8CgiBPKNWCZs15GVOUEsj58hrZ9Anq0Ct+LiCt7MmEASrmwgZSCptPRbQBRQbdiTxknuwR+DR3NbOY8XHZoEwb1i7ZJDbAiHEa8shmAJmGAgcY1E5xr7fGG3zx5hA7q3gLFcRJTXrhT5GdicvTeCOnrB0OdgS5rzlJo0J4GDwfUDO8LUyj2EyGNybE7jbnqsPOAuKcPqiuwLL5fLo6L/c93mr6JtmBt+hs0GR9aud91xR1czidekvsv1IK71Fg/H89C7Dbo3C5uH49vHoqELtRjdIfELC6OL9VSy8L+HjTz/DNUpvoLLLdFrzxqNewbzbiplLmU+0besmlDYevIoZz9PhY+mFgToGP1SSPv70S4BvcQnKtFeKQxkM3iLtVOsfYe/zWgUaDCatTi2gMQY5NdKvYKckI7SAPMAay3ksldZQSJJJxjIP6HseQ976XpRK44OTISytL+7FzgBkUWDBSHOPUWW2iDJoXLE/0FrsrlvU2dvpwsuSdrMJqi4jJvC2oXSAW6kOHZpIqvOWMI8xFWUHWmptlw+2LGO75WV+E/K48wH43v5xVWgC00kW0EiuY5ZvR0g/04bbSsX4qELlew+EBDCx/eCtxueR8S1NRgFS/+Zbuk/UEa+/SvRRpjhg18x0/1WTAh7CRZ6jY2IXUjcYJjAYJESDAbwosJSNppcZDAYLhUse5d/ScZb4awg3Lf6aC10l+RFFwLKPwLYsSWo8wlIVc6SvIS3UdzC2nQxfQ7d0gFqu2vXMqpuPodqG+KG2Xbh93TAVw3tuhQftc7/LeSzRM3cxvbtL7VR7ie+6YgBcI/6bYsI6iXuFzKOMw1oqnfr4Xw/XiZIKfR3elTfoFyrHVkt8oo6OovFIZEKrHE3AnlS7ePv+GhavhmOR9UTJbyipo+urv19+e3PJYDgFibDT4Xg45iFnA9XS9HY6eGofKor1TsT+X73MWz1F+EQjp6WKgjYytW6V6N32IS4yMek/yqeZqGwgNlmvZzLg915vNjz8Y4OeJe80EwvpFdeKKFfbulFsH9ef5OjFd+07/SV82fv+2YA61WhYMsbbLSZCZOIRVwd/aNhMN1knHRlxskiVoed79AzZ0/JvLq8vby9FJrgB7qvWx6ha2x+8wbPQ9uVswsD/srZ+1mG9Top4s9nap6lPerQxdtbM03Sz2fwH8Wd5qQ==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},g=void 0,I={},u=[];function w(e){const t={p:"p",...(0,l.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(S.default,{as:"h1",className:"openapi__heading",children:"Delete Template"}),"\n",(0,i.jsx)(p(),{method:"delete",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,i.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,i.jsx)(S.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,i.jsx)(b.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,i.jsx)(r(),{...s(63099)}),"\n",(0,i.jsx)(c(),{...s(63337)}),"\n",(0,i.jsx)(h(),{...s(86975)})]})}function x(e={}){const{wrapper:t}={...(0,l.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(w,{...e})}):w(e)}},63099(e){e.exports=JSON.parse('{"parameters":[{"name":"template_id","in":"path","description":"ID of the template that needs to be deleted","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string"}}]}')},63337(e){e.exports={title:"Body"}},86975(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Template deleted successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","example":"Bxh2aspHp3"},"deletedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"xml":{"name":"delete"},"title":"delete"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"Template not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Template not found!"}},"title":"inline_response_404_6"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/94e1fa32.28eaba14.js b/assets/js/94e1fa32.28eaba14.js new file mode 100644 index 000000000..c5cc21e13 --- /dev/null +++ b/assets/js/94e1fa32.28eaba14.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[6582],{41501(e,t,o){o.r(t),o.d(t,{assets:()=>b,contentTitle:()=>g,default:()=>v,frontMatter:()=>h,metadata:()=>n,toc:()=>j});const n=JSON.parse('{"id":"API-docs/v1.2/getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","source":"@site/docs/API-docs/v1.2/getdocument.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/getdocument","permalink":"/docs/API-docs/v1.2/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":"eJy9Wt1uG7kVfpVTBihiYSTZjje71RbbdR0n6zbdGJbdALUNiTNzpOGKImdJjmTBFrAXRR+g6E1v+xK976PkSYpDzoxGtmJH+3eR2J45PDw8/+fj3DLHx5b1LtkrnRRTVM6y64ilaBMjcie0Yj12niG8QQcVCRyengAqHku0sNAFOA0GnRE4Q0jRcSEt8FgXDjjYHBMxEgmk5eoOi5jO0XDifpKyHhujq16yiOXc8Ck6NCTWLVN8iqzHKoKBSFnEBImVc5ex+7Lq+DtM3EkKelTLyyJm8PtCGExZz5kCI2bdQhJbK6a5RBYxvMmlTpH1RlxaIkgynHLWu2VukXtKZ4Qas4iNtJly13yCN9xz6bH8m704S/azPGbL5TVta3OtLFpitL+7Sz/W5bVFkqC1o0JCrRQWsUQrR5L3bhnPcykS/6L7naVFtw+lC8cm7Rli40TY0jruCrvtKYRq50aPDVrLllGt0m3ZvH4jJvsv4uziT8RlJOjhdhwy53Lb63bLJ4WRnURPiVtCZxyRWn400waLBmMn3PZyWv8LeTixUHp7oXKJ3CJYMVZ1oHitaZmiedrQP4+NQqxtxyFICH7pcqXAVcCWRyBHmqu1s3wS/+80QoxI60k7Pi3UHLgxfEH5wOHUPq0lozfbdrVbgvoxRWwUC6dcyCepY8SvyweVr+WZVk9sc/DZy/29F198vkf0c5GO0f2E84e32+nf4Y2L9Y2Xl4+by1UxjdE0l9dP6uV7y4jdbLlm/+BgGbHFlqs+p63mWy568cUyYtmWiw5eki/7BP4JOv8xMVXrfNmMKIfTXHKHg36Ig0HlD49S+aC0qNIT9c6s55JYa4lcNbem6ljSD4QaaFoxIAkT9/hCXzaXEeNS6vlAj0ZSKBxQxG5ct14E32foMjRQBjgkXIEt4qmgBiLR+YKqucuErXNjIE2hsEKNgSvAG4dGcQlOawkjbcBnGzA4EzjvwCsc8UI6S72Kl7WzSfrEIHeYHrrHo3J/d/9Fe2+3vfv5+d7L3sHvep+97Ozu7v6NRexmKldWZynVp2ZSLP8u8vRX2Sc0aee6+DSzG0yFwcQNCrMxoT3ms6w2/lSnoa7eC5DHvKZIhRs4s55It8xuPzoPk4fgxtL5M5oiOOwvusmG6jsXLgtN4KCpY09aJQrxhFQNQhAWtJIL4DMuJPkWzDNU4DJchaawUMYRjIyeAoeKQ8c7SeH0wOBUqCezUeUegXqgVYKUlXCGZmN5qBfuUrVCNUi01J/UMJTHXjZ4XLJYFuhnBxo5YsmTCbteRixOkh/LsbBo1rwv8o/2157RHr/4FssHLvXAY9ij/lQWp4NNQ01fT9FllJnn5BBzo9U4grLHdWYBfMyFAnIJ85ufb9pBY/TG/nLly9tJ1owooXxFqya6wcHu7mCvVsLBQyXU07LSDka6UOmve9RN+z9+oIPBi/pAnz080ImacSlSP/2f6wmqX/c8ze1d2P6hF4tA5N+ztcM2n4dDWkwKI9zCwww3bZ6Ldnjfu7ym4Z08RZf4hMclXMZ6rFuFQve2gUksGfEzswq18AW0HjUtV2msbzo6R0V1QPLYUhx2eS66s73OPltG99fwPN+KHov2tkus42Ohxk+tu16pqk/mDBZbU9gqVeXiz0i5qrRHk6qEbTLkfh5c0t8j7ReXVnqXo6K21dvYb36/U3wGFc2Hv/+nJrtSV+oraLUIqKKDtK0uTIIeAPL8uPTdoRMzhA8//AviQkjnu8QUZyjJE20EzhSWqla8AFQOTW6ERdtptYh/c9+xmJXIF7Wn5J8OI8iNTouEBG0b5OkCsE0a5a4wCFT/qH0ClxldjDNCxoQaS4zg7Lh/TvjP4elJB/qo0rqUWi9izSSCKVd8jHU99TLzZOJJKKmF1AxCgUHqhcUUI+AqBSq6U+6QhDZ0OmEaFVuKESaLRAblcCmB8jzhdzNUqTYgdTJpC9UhRbTbbfrx7Blhgo527TtuHKb09JhKMxDahtbBtLAOEm7MIuxbhy5JSD3DsOEfQwie4TcZDodXqvGyB78nDqsHX5U0V6rV+vCPf8LlN3pOvf0YFaFoeG/D6+eV06c6sQ+9nZ52M5R5tx8OZbuHpyc+y+0E+3+rHViy5DxDg7RVjGOh/gAXVDkyhFarDHNANRNGK1JtqwXPh5+cBoY7xDc32mmKp9oKfDTCxKtakgen3PF7pjjSBuGI5zwWUlBSped3cMQdjrVZwB28z7jzLkvDVarh7krdtdtt/49IW60aAW614A6OfAsXAY2CEYSBJaJxSk9Kn0qR/H7lnu3K7Cv3LTmfV/7qOf+xEDIFg4X1DWTtzP64kBts55InmEI5337pZSDNaIWgDUXBop4Vyy36KEdtik+/xZvKCyw9LmfFlVi1XksuINRMOF+5YCT1vGJ6WsRSJLAufj/jBoFDHl5WoSeFmvjwUbriKoV1UCHPFc9Xho8cvNdmQjsFjnyGDem0aeiEW0hphfUqHwnFpQgONw1dSsX3SCvHk9J4fwl5wsdAKUwS3kOs9QQ8vMunU+5EwqVcVExee6wu8HhnxlzRXivJhLIixToFwytD7hgAvtoS7zHOtJ4EJmeYINFQOmpTOgKclT3JakaE4Jl+ZAdUaa6FchW7C1sJdFZdMfAk0YVyXiMJzawOqJLQbEoWvFsPDXL8Dz/828K3OKe8UxWMZxQ2NHGgqS1c7cHllRq+OT6HbmWJbk+kQ7/j+nOy8RAysmCMqMA6g3xKnVXqvcFgWqiUKwerew0gBzI41TNMPctWKzc4ElL60KYBSuk5XakUhvhYpLUO5SIMVKVFVwxbLSoNE3LD+sYBkFuBhsIm0coWU+xUpz7l1s61SdunRjtMqOSdvnoN/SLPtXFXit7D8MpD9oO8JL5iwyprV3Ee63QR5r+5Nn53H8GoErPIS662U/HFFLTqXanh6bv+OXTDiFipcQj/+y8MTy8eaNw/biyou69eYyxtkvloqagevLi3n39BOYJUOqz08y6gV9AvQ5tCy2h5pfroSC8PMa4r1qPuAeEugEtD0Ao+clDvQxtO6jTQJZRIhJOL8nqNckEqQp4s96sTDrUGyJNsNV1X8gfkD860pDpATdGwzJZDCP239y+eJJhTYqEzBYIBIeRk6ZFAmQJPjLbWNwT+FBRdRhcObQfOM4MIRB/82VZW7oXSQ7tTsseMzwQF9/2CU8o0hNbzNIBzOz51+Z6hbKooM9Bs5nzqX3VToTKEFDH08I0ZrrKNXccjSFEBBgzYRZmky+oC3ppVfh7yPDd6FtgdcRUim+pNRY43pLWydARpyhTvN7urUws3sVZwROjl86OjHRJO5ILy6JU6BIVzUnuSrLRdhn2tSOBSq7HPuHQevBHW9wDDK4IgVuv06sooqp0hCmXDe1tdBGsrdkM9r415TNAZ8DSlOz+0vnJhSvFey2jKTM6poYu1antctpnHwQNwQCjNQ0CoNGjagbdigqszRCT+mjTw3BZJRoUvRMkq4kU63KHSNRNpqYcgGtnLiLS0e6UBmHFZYOQLTshSpFkpSLHWQ8bT3C3AgyvwfHh5Pdz5EjRhzsQlqNZpECpDUz5cZ32vBTusIbHjVf9X9mGNJxQTBDZcnL3d0IP1Q4vo690WfWPdsNQjyDqHRye8evXxBZzh+MHipybL4f2K+1c0VmifpH4Lf+TJZM5NauFIT3PuhO9QF0RKi8k5RgW1IHFF2E5KQhk6YJjteTee7XX26gGlahNsKIku0xZhFjYOCWkFUWoVLg/iSu+eq9IQGwxVM8m4GlMgUI/QKNSCEn9aJCEWvLzEOlz+cAmFkmgtaLq9mFOvRHe/6T3HuLBI491boSbeHdpwWXdQ7zG2wuFqPJnP5w80vePXvC6krD9p8AH3xFATlr0R7psihjPMtRVOm8Vq1Vi4rIi9LZtr6z9KBlUvXeM+P2WY8izP0Uwt3en00cxE8sTxu47IuztXBCHcgx3W0QGDIzSUd+zaKMhzUY6dl5UcQOL9lHP4jxBCS924eyD84+v7fDwORUd4NyrPW2Iwj5+XRUyKBJXFBr51+Ob0LcxedHYJ1q3BnE+wZfftydHxt/1jf98RwoT12F5nt7Prr3a1dVOuGjs1P/i5D8PcrmC/X+DjoBJKokvQbi658EBeeSMVQLhL1vheqNf8NOg6Ypm2jkhubyneL4xcLunx94W/NLi8jtiMG0HyeaSubK/S+sufj570+Vk5yu3AR74y2ih5hYwpgsV84aDbsohNcHHvu6YlIf8lPEaiBYpD36Y11j7AWdfAyjfH58xfsmTrsNzEw3LlL8R9o1zreF0QgP4n8HDjgtvbAPktlzV9ePXRFeUBK2pS0vVyufw/PXZ4eg==","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Document from Template","permalink":"/docs/API-docs/v1.2/createdocumentwithtemplateid"},"next":{"title":"Update Document","permalink":"/docs/API-docs/v1.2/update-document"}}');var a=o(74848),i=o(28453),s=o(57742),r=o.n(s),p=o(78178),l=o.n(p),m=o(19624),c=o.n(m),d=o(96226),u=o.n(d),y=(o(77675),o(19365),o(51107)),x=o(21312);const h={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:"eJy9Wt1uG7kVfpVTBihiYSTZjje71RbbdR0n6zbdGJbdALUNiTNzpOGKImdJjmTBFrAXRR+g6E1v+xK976PkSYpDzoxGtmJH+3eR2J45PDw8/+fj3DLHx5b1LtkrnRRTVM6y64ilaBMjcie0Yj12niG8QQcVCRyengAqHku0sNAFOA0GnRE4Q0jRcSEt8FgXDjjYHBMxEgmk5eoOi5jO0XDifpKyHhujq16yiOXc8Ck6NCTWLVN8iqzHKoKBSFnEBImVc5ex+7Lq+DtM3EkKelTLyyJm8PtCGExZz5kCI2bdQhJbK6a5RBYxvMmlTpH1RlxaIkgynHLWu2VukXtKZ4Qas4iNtJly13yCN9xz6bH8m704S/azPGbL5TVta3OtLFpitL+7Sz/W5bVFkqC1o0JCrRQWsUQrR5L3bhnPcykS/6L7naVFtw+lC8cm7Rli40TY0jruCrvtKYRq50aPDVrLllGt0m3ZvH4jJvsv4uziT8RlJOjhdhwy53Lb63bLJ4WRnURPiVtCZxyRWn400waLBmMn3PZyWv8LeTixUHp7oXKJ3CJYMVZ1oHitaZmiedrQP4+NQqxtxyFICH7pcqXAVcCWRyBHmqu1s3wS/+80QoxI60k7Pi3UHLgxfEH5wOHUPq0lozfbdrVbgvoxRWwUC6dcyCepY8SvyweVr+WZVk9sc/DZy/29F198vkf0c5GO0f2E84e32+nf4Y2L9Y2Xl4+by1UxjdE0l9dP6uV7y4jdbLlm/+BgGbHFlqs+p63mWy568cUyYtmWiw5eki/7BP4JOv8xMVXrfNmMKIfTXHKHg36Ig0HlD49S+aC0qNIT9c6s55JYa4lcNbem6ljSD4QaaFoxIAkT9/hCXzaXEeNS6vlAj0ZSKBxQxG5ct14E32foMjRQBjgkXIEt4qmgBiLR+YKqucuErXNjIE2hsEKNgSvAG4dGcQlOawkjbcBnGzA4EzjvwCsc8UI6S72Kl7WzSfrEIHeYHrrHo3J/d/9Fe2+3vfv5+d7L3sHvep+97Ozu7v6NRexmKldWZynVp2ZSLP8u8vRX2Sc0aee6+DSzG0yFwcQNCrMxoT3ms6w2/lSnoa7eC5DHvKZIhRs4s55It8xuPzoPk4fgxtL5M5oiOOwvusmG6jsXLgtN4KCpY09aJQrxhFQNQhAWtJIL4DMuJPkWzDNU4DJchaawUMYRjIyeAoeKQ8c7SeH0wOBUqCezUeUegXqgVYKUlXCGZmN5qBfuUrVCNUi01J/UMJTHXjZ4XLJYFuhnBxo5YsmTCbteRixOkh/LsbBo1rwv8o/2157RHr/4FssHLvXAY9ij/lQWp4NNQ01fT9FllJnn5BBzo9U4grLHdWYBfMyFAnIJ85ufb9pBY/TG/nLly9tJ1owooXxFqya6wcHu7mCvVsLBQyXU07LSDka6UOmve9RN+z9+oIPBi/pAnz080ImacSlSP/2f6wmqX/c8ze1d2P6hF4tA5N+ztcM2n4dDWkwKI9zCwww3bZ6Ldnjfu7ym4Z08RZf4hMclXMZ6rFuFQve2gUksGfEzswq18AW0HjUtV2msbzo6R0V1QPLYUhx2eS66s73OPltG99fwPN+KHov2tkus42Ohxk+tu16pqk/mDBZbU9gqVeXiz0i5qrRHk6qEbTLkfh5c0t8j7ReXVnqXo6K21dvYb36/U3wGFc2Hv/+nJrtSV+oraLUIqKKDtK0uTIIeAPL8uPTdoRMzhA8//AviQkjnu8QUZyjJE20EzhSWqla8AFQOTW6ERdtptYh/c9+xmJXIF7Wn5J8OI8iNTouEBG0b5OkCsE0a5a4wCFT/qH0ClxldjDNCxoQaS4zg7Lh/TvjP4elJB/qo0rqUWi9izSSCKVd8jHU99TLzZOJJKKmF1AxCgUHqhcUUI+AqBSq6U+6QhDZ0OmEaFVuKESaLRAblcCmB8jzhdzNUqTYgdTJpC9UhRbTbbfrx7Blhgo527TtuHKb09JhKMxDahtbBtLAOEm7MIuxbhy5JSD3DsOEfQwie4TcZDodXqvGyB78nDqsHX5U0V6rV+vCPf8LlN3pOvf0YFaFoeG/D6+eV06c6sQ+9nZ52M5R5tx8OZbuHpyc+y+0E+3+rHViy5DxDg7RVjGOh/gAXVDkyhFarDHNANRNGK1JtqwXPh5+cBoY7xDc32mmKp9oKfDTCxKtakgen3PF7pjjSBuGI5zwWUlBSped3cMQdjrVZwB28z7jzLkvDVarh7krdtdtt/49IW60aAW614A6OfAsXAY2CEYSBJaJxSk9Kn0qR/H7lnu3K7Cv3LTmfV/7qOf+xEDIFg4X1DWTtzP64kBts55InmEI5337pZSDNaIWgDUXBop4Vyy36KEdtik+/xZvKCyw9LmfFlVi1XksuINRMOF+5YCT1vGJ6WsRSJLAufj/jBoFDHl5WoSeFmvjwUbriKoV1UCHPFc9Xho8cvNdmQjsFjnyGDem0aeiEW0hphfUqHwnFpQgONw1dSsX3SCvHk9J4fwl5wsdAKUwS3kOs9QQ8vMunU+5EwqVcVExee6wu8HhnxlzRXivJhLIixToFwytD7hgAvtoS7zHOtJ4EJmeYINFQOmpTOgKclT3JakaE4Jl+ZAdUaa6FchW7C1sJdFZdMfAk0YVyXiMJzawOqJLQbEoWvFsPDXL8Dz/828K3OKe8UxWMZxQ2NHGgqS1c7cHllRq+OT6HbmWJbk+kQ7/j+nOy8RAysmCMqMA6g3xKnVXqvcFgWqiUKwerew0gBzI41TNMPctWKzc4ElL60KYBSuk5XakUhvhYpLUO5SIMVKVFVwxbLSoNE3LD+sYBkFuBhsIm0coWU+xUpz7l1s61SdunRjtMqOSdvnoN/SLPtXFXit7D8MpD9oO8JL5iwyprV3Ee63QR5r+5Nn53H8GoErPIS662U/HFFLTqXanh6bv+OXTDiFipcQj/+y8MTy8eaNw/biyou69eYyxtkvloqagevLi3n39BOYJUOqz08y6gV9AvQ5tCy2h5pfroSC8PMa4r1qPuAeEugEtD0Ao+clDvQxtO6jTQJZRIhJOL8nqNckEqQp4s96sTDrUGyJNsNV1X8gfkD860pDpATdGwzJZDCP239y+eJJhTYqEzBYIBIeRk6ZFAmQJPjLbWNwT+FBRdRhcObQfOM4MIRB/82VZW7oXSQ7tTsseMzwQF9/2CU8o0hNbzNIBzOz51+Z6hbKooM9Bs5nzqX3VToTKEFDH08I0ZrrKNXccjSFEBBgzYRZmky+oC3ppVfh7yPDd6FtgdcRUim+pNRY43pLWydARpyhTvN7urUws3sVZwROjl86OjHRJO5ILy6JU6BIVzUnuSrLRdhn2tSOBSq7HPuHQevBHW9wDDK4IgVuv06sooqp0hCmXDe1tdBGsrdkM9r415TNAZ8DSlOz+0vnJhSvFey2jKTM6poYu1antctpnHwQNwQCjNQ0CoNGjagbdigqszRCT+mjTw3BZJRoUvRMkq4kU63KHSNRNpqYcgGtnLiLS0e6UBmHFZYOQLTshSpFkpSLHWQ8bT3C3AgyvwfHh5Pdz5EjRhzsQlqNZpECpDUz5cZ32vBTusIbHjVf9X9mGNJxQTBDZcnL3d0IP1Q4vo690WfWPdsNQjyDqHRye8evXxBZzh+MHipybL4f2K+1c0VmifpH4Lf+TJZM5NauFIT3PuhO9QF0RKi8k5RgW1IHFF2E5KQhk6YJjteTee7XX26gGlahNsKIku0xZhFjYOCWkFUWoVLg/iSu+eq9IQGwxVM8m4GlMgUI/QKNSCEn9aJCEWvLzEOlz+cAmFkmgtaLq9mFOvRHe/6T3HuLBI491boSbeHdpwWXdQ7zG2wuFqPJnP5w80vePXvC6krD9p8AH3xFATlr0R7psihjPMtRVOm8Vq1Vi4rIi9LZtr6z9KBlUvXeM+P2WY8izP0Uwt3en00cxE8sTxu47IuztXBCHcgx3W0QGDIzSUd+zaKMhzUY6dl5UcQOL9lHP4jxBCS924eyD84+v7fDwORUd4NyrPW2Iwj5+XRUyKBJXFBr51+Ob0LcxedHYJ1q3BnE+wZfftydHxt/1jf98RwoT12F5nt7Prr3a1dVOuGjs1P/i5D8PcrmC/X+DjoBJKokvQbi658EBeeSMVQLhL1vheqNf8NOg6Ypm2jkhubyneL4xcLunx94W/NLi8jtiMG0HyeaSubK/S+sufj570+Vk5yu3AR74y2ih5hYwpgsV84aDbsohNcHHvu6YlIf8lPEaiBYpD36Y11j7AWdfAyjfH58xfsmTrsNzEw3LlL8R9o1zreF0QgP4n8HDjgtvbAPktlzV9ePXRFeUBK2pS0vVyufw/PXZ4eg==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},g=void 0,b={},j=[];function f(e){const t={p:"p",...(0,i.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(y.default,{as:"h1",className:"openapi__heading",children:"Get Document"}),"\n",(0,a.jsx)(r(),{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)(y.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,a.jsx)(x.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,a.jsx)(l(),{...o(33154)}),"\n",(0,a.jsx)(c(),{...o(68936)}),"\n",(0,a.jsx)(u(),{...o(53026)})]})}function v(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(f,{...e})}):f(e)}},33154(e){e.exports=JSON.parse('{"parameters":[{"name":"document_id","in":"path","description":"objectId of Document","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"pH1bhc2hpb"}}]}')},68936(e){e.exports={title:"Body"}},53026(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","format":"string","example":"in-progress"},"objectId":{"type":"string","format":"string","example":"FGik23bhUJ"},"file":{"type":"string","format":"string","example":"https://exampleurl.com"},"certificate":{"type":"string","format":"string","example":"https://certificateurl.com"},"title":{"type":"string","format":"string","example":"sample doc"},"note":{"type":"string","format":"string","example":"please sign document"},"folder":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"FGik23bhUJ"},"name":{"type":"string","format":"string","example":"folder name"}},"title":"document_folder"},"owner":{"type":"string","format":"string","example":"joe bee"},"signers":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","example":"ceo"},"name":{"type":"string","example":"joe bee"},"email":{"type":"string","example":"joebee@example.com"},"phone":{"type":"string","example":"456213871"},"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","format":"string","example":"textbox"},"page":{"type":"number","format":"number","example":1},"x":{"type":"number","format":"number","example":244},"y":{"type":"number","format":"number","example":71},"w":{"type":"number","format":"number","example":38},"h":{"type":"number","format":"number","example":46},"options":{"type":"object","properties":{"name":{"type":"string","format":"string","example":"textbox"}}}},"title":"template_Signers_widgets"}}},"title":"template_Signers"}},"sendInOrder":{"type":"boolean","example":true},"send_in_order_strict":{"type":"boolean","example":false},"allow_offline_sign":{"type":"boolean","description":"Whether signers can submit a copy of this document signed using an external tool for owner review. Defaults to false.","example":false},"createdAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"enableTour":{"type":"boolean","example":true},"redirect_url":{"type":"string","format":"string","example":""},"allow_modifications":{"type":"boolean","example":false},"audit_trail":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"joebee@example.com"},"viewed":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"signed":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"title":"documentwithstatus_audit_trail"}},"template_id":{"type":"string","example":"template_id is only available when the document is created from a template."},"auto_reminder":{"type":"boolean","example":false},"remind_once_in_every":{"type":"number","example":0},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"]},"cc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"]}},"xml":{"name":"documentwithstatus"},"title":"documentwithstatus"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"Document not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Document not found!"}},"title":"inline_response_404_3"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/94e1fa32.afa5864c.js b/assets/js/94e1fa32.afa5864c.js deleted file mode 100644 index 0b802632f..000000000 --- a/assets/js/94e1fa32.afa5864c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[6582],{41501(e,t,n){n.r(t),n.d(t,{assets:()=>f,contentTitle:()=>y,default:()=>S,frontMatter:()=>g,metadata:()=>a,toc:()=>h});const a=JSON.parse('{"id":"API-docs/v1.2/getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","source":"@site/docs/API-docs/v1.2/getdocument.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/getdocument","permalink":"/docs/API-docs/v1.2/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":"eJy9Gdtu28j1V07noU0EWpIvSbbalw26adZtsAnWDgLUNoQheShOPJyZnRlKFgwB+9A/6FNf+2n5kuLMkBRlKbaVzebFFofnnDn3G2+Z5zPHJhfsR53VFSrv2FXCcnSZFcYLrdiEnZcIr9FDCwIv350CKp5KdLDUNXgNFr0VOEfI0XMhHfBU1x44OIOZKEQGeYM9ZAnTBi0n6qc5m7AZ+vYlS5jhllfo0RJbt0zxCtmEtQBTkbOECWLLcF+yu7zq9CNm/jQHXXT8soRZ/LUWFnM28bbGhDm/lETWicpIZAnDGyN1jmxScOkIICux4mxyy/zSBEhvhZqxhBXaVtz3T/CGByoTZn46TMvsqDQpW62u6FpntHLoiNDReEz/Nvl1dZahc0UtoVMKS1imlSfOJ7eMGyNFFl6MPjpCut3mLopN2rNExot4pfPc125fKYQ6MFbPLDrHVkmn0n3J/P21uD46Tsv3/yAqhaDD/SiU3hs3GY2ak9rKYaYropaRjAWp5YuJ9kj0CHvh9+fThR/k4URC6f2ZMhK5Q3BiprpACVrTMkf7sKG/jo1irO1HIXIIAXW1VuA6YBsRyJEWakOWR9H/qBFSRMIn7YS00FHg1vIl5QOPlXtYS1bvtu36tgz1fYrYyRZWXMgHoVPEH5qD1tdMqdUD15w8e350ePzdi0OCX4h8hv53yB/f7qd/jzc+1TeBXz7ro6u6StH20buTDv1wlbCbPXGOTk5WCVvuifWCrlrsiXT83Sph5Z5IJ8/Jl0MCf4TOvySmOp2v+hHlsTKSe5yexTiYtv5wL1QISocqP1Vv7WYuSbWWyFX/aqqODfxUqKkmjClxmPn7EUPZXCWMS6kXU10UUiicUsTuxNssgh9K9CVaaAIcMq7A1WklqIHItFlSNfelcF1ujKA51E6oGXAFeOPRKi7Bay2h0BZCtgGLc4GLIfyIBa+ld9SrBF6Hu7jPLHKP+Ut/f1QejY+ODw7HB+MX54fPJyd/nTx7PhyPx/9iCbup5NrqLKf61E+KzXNt8m9yT2zSznX9OLNbzIXFzE9ruzOh3eezrDN+pfNYV+8EyH1eU+fCT73dTKR7ZrcvzsPkIbizdH5FU0SH/UMv2VF9F8KXsQmc9nUcQNtEIR7gqgcIwoFWcgl8zoUk34JFiQp8ievQFA6aOILC6go4tBSGwUlqr6cWK6EezEate0ToqVYZUlbCOdqd5aFDHFO1QjXNtNSPahgasVc9GhcslTWG2YFGjlTy7JpdrRKWZtmXUqwd2g3vS8LR0cbZFVnnjr23zMnuNXZTOU52TRxnukJfUtpckLUWVqtZAk0D6u0S+IwLBWQv+6evN4qgtXpn87d2tP0467u7UKHctOPW9GQ8nh52SjjZVkI3yirtodC1yr+tqLvuv1+gk+lxJ9CzbYFO1ZxLkYfR/Fxfo/q28vSv9/H6bS8WESi8ZxvC9s+jkA6z2gq/DDuAmwNuxEF8P7m4osmaPEU3y4OwNPAlm7BRGwqj297CYMWInp23K4VQ3bo50HGVp/pmqA0qStKSp47icMSNGM0Ph0dsldzF4cbsBY/1wb4ozvOZULOH8K7Wqjojc0aLbShsnaqM+CdSrmrs0Ydqdiol8jCsrei50AG5sdJbg4p6ymDjcPlWG4cy0xVSi0UFYTBoUT79+38d1mDQVYrgjcNLdane1haMXqClPQhXORQSbwSVl7BqqsK7btfkkFcSnZNLEMrjzHKPkIuZ8FyGxpBSSMYNT4UU5MQEpgnbQi8O3BDaxnOp679YBA45zlGS7wOVqYp7ItVVtoW214XUC5cAh5R6T3QOUJVcZQTYWiIBbUNTqjxaYwVN9t4S1yLyppW3PPNQccVnSLQT6CsrRynIXcHqtHYenJZ1YBlouaYt5tAKpBBzF5T4ilZYFoFOM10ZiyW5zRxhVoscXQKZzhHisoJEUDmk6DwY4kVkGJrjWkmdXQcDFrWUYDSlEMEl9eB9HgndW64cdYWRl9YGncKM1bTdwsjgYPDeIVn4jVDXbjIYXKoDuOj86gOmTni8etKGwGKx2HL9p5s4r4X/qU7hFzTaCa/tco09E76s0xAufSLdQ6T0GhUG/+kFw5pGrjO3HX10OipRmtEZevIQN3r57jRk3afw6bf/wBvkVkGpF9Fbs9qiXMKsvYo0Fy0f1dYlzTC38NqXpPEsOh9tLtH5VoMfSu4//fZfBz/jAoRqQopEGQxoR3vetFrwZ9h4fCOcHwwmYLHScxqclEIyDbdLWG9cA2sO6YDaN2OxEFJCzj2PvVyc0HoYQ7r6Mmz3poY7t9A2v2RrAOB5jjlxGnvCrhdMIA5BvYMGYh1uwpe917nlhV+/jazKIi7NrK59dGBj9VzkCC03QanGao9ZkCkvWqa3Z9VHcR5uvsN87/5AFaitC49xBKOEkAsXf8YLu0xF/PkShe2otQxGbU9pbbWbM4rSdmiOxZuidFNRW3p9UNFbliKBTZ1Kkd0VeAgvswwNKXbOZY1uAoNB5GgwgCd5nLqfJjAYhCnLDgb0mxuyEj0NodlTQEWJruRzBO6Bej4PutES97VFiOuO7yES6iMo3bx030NL2kHFlw09tWzfB1GbDxMd4ebjQPg4cUml8E753KxyFgu0pLtg3nVQG9EE8UWbDIByxO9JJmHTrZXncfvSDLhUx3+4Syf0U2gr97Y4QzsXWbvq/kweHQXgEUuYFBkqh70+7eXrd29gfjwc03jSNSWPSKmjN6d/e/Xz2aswVKN1UWGHw/FwHPaH2vmKq95N/a9Kd9uJ23X7+gd8gWpaItq0jYzkIjSkzdojNpMXrPdRatL//nSVsFI7TyC3tyl3+N7K1YqOf63DZHpxlbA5t4L4Cx1nE/p593nps5I++aX5UvUUPvMpayfnbYenqL0LkUgrmYRd4/LOx7MVjbBNm0esRYgYxT3crXlho+l+/eqchUm+3Gwvr0N72fwg6jv52uw7IwP0l5rgnQi3t7F1Xa06+PjqsxiNgC00KelqtVr9H6jXDyU=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Document from Template","permalink":"/docs/API-docs/v1.2/createdocumentwithtemplateid"},"next":{"title":"Update Document","permalink":"/docs/API-docs/v1.2/update-document"}}');var o=n(74848),r=n(28453),i=n(57742),s=n.n(i),p=n(78178),l=n.n(p),c=n(19624),m=n.n(c),d=n(96226),u=n.n(d),b=(n(77675),n(19365),n(51107)),x=n(21312);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:"eJy9Gdtu28j1V07noU0EWpIvSbbalw26adZtsAnWDgLUNoQheShOPJyZnRlKFgwB+9A/6FNf+2n5kuLMkBRlKbaVzebFFofnnDn3G2+Z5zPHJhfsR53VFSrv2FXCcnSZFcYLrdiEnZcIr9FDCwIv350CKp5KdLDUNXgNFr0VOEfI0XMhHfBU1x44OIOZKEQGeYM9ZAnTBi0n6qc5m7AZ+vYlS5jhllfo0RJbt0zxCtmEtQBTkbOECWLLcF+yu7zq9CNm/jQHXXT8soRZ/LUWFnM28bbGhDm/lETWicpIZAnDGyN1jmxScOkIICux4mxyy/zSBEhvhZqxhBXaVtz3T/CGByoTZn46TMvsqDQpW62u6FpntHLoiNDReEz/Nvl1dZahc0UtoVMKS1imlSfOJ7eMGyNFFl6MPjpCut3mLopN2rNExot4pfPc125fKYQ6MFbPLDrHVkmn0n3J/P21uD46Tsv3/yAqhaDD/SiU3hs3GY2ak9rKYaYropaRjAWp5YuJ9kj0CHvh9+fThR/k4URC6f2ZMhK5Q3BiprpACVrTMkf7sKG/jo1irO1HIXIIAXW1VuA6YBsRyJEWakOWR9H/qBFSRMIn7YS00FHg1vIl5QOPlXtYS1bvtu36tgz1fYrYyRZWXMgHoVPEH5qD1tdMqdUD15w8e350ePzdi0OCX4h8hv53yB/f7qd/jzc+1TeBXz7ro6u6StH20buTDv1wlbCbPXGOTk5WCVvuifWCrlrsiXT83Sph5Z5IJ8/Jl0MCf4TOvySmOp2v+hHlsTKSe5yexTiYtv5wL1QISocqP1Vv7WYuSbWWyFX/aqqODfxUqKkmjClxmPn7EUPZXCWMS6kXU10UUiicUsTuxNssgh9K9CVaaAIcMq7A1WklqIHItFlSNfelcF1ujKA51E6oGXAFeOPRKi7Bay2h0BZCtgGLc4GLIfyIBa+ld9SrBF6Hu7jPLHKP+Ut/f1QejY+ODw7HB+MX54fPJyd/nTx7PhyPx/9iCbup5NrqLKf61E+KzXNt8m9yT2zSznX9OLNbzIXFzE9ruzOh3eezrDN+pfNYV+8EyH1eU+fCT73dTKR7ZrcvzsPkIbizdH5FU0SH/UMv2VF9F8KXsQmc9nUcQNtEIR7gqgcIwoFWcgl8zoUk34JFiQp8ievQFA6aOILC6go4tBSGwUlqr6cWK6EezEate0ToqVYZUlbCOdqd5aFDHFO1QjXNtNSPahgasVc9GhcslTWG2YFGjlTy7JpdrRKWZtmXUqwd2g3vS8LR0cbZFVnnjr23zMnuNXZTOU52TRxnukJfUtpckLUWVqtZAk0D6u0S+IwLBWQv+6evN4qgtXpn87d2tP0467u7UKHctOPW9GQ8nh52SjjZVkI3yirtodC1yr+tqLvuv1+gk+lxJ9CzbYFO1ZxLkYfR/Fxfo/q28vSv9/H6bS8WESi8ZxvC9s+jkA6z2gq/DDuAmwNuxEF8P7m4osmaPEU3y4OwNPAlm7BRGwqj297CYMWInp23K4VQ3bo50HGVp/pmqA0qStKSp47icMSNGM0Ph0dsldzF4cbsBY/1wb4ozvOZULOH8K7Wqjojc0aLbShsnaqM+CdSrmrs0Ydqdiol8jCsrei50AG5sdJbg4p6ymDjcPlWG4cy0xVSi0UFYTBoUT79+38d1mDQVYrgjcNLdane1haMXqClPQhXORQSbwSVl7BqqsK7btfkkFcSnZNLEMrjzHKPkIuZ8FyGxpBSSMYNT4UU5MQEpgnbQi8O3BDaxnOp679YBA45zlGS7wOVqYp7ItVVtoW214XUC5cAh5R6T3QOUJVcZQTYWiIBbUNTqjxaYwVN9t4S1yLyppW3PPNQccVnSLQT6CsrRynIXcHqtHYenJZ1YBlouaYt5tAKpBBzF5T4ilZYFoFOM10ZiyW5zRxhVoscXQKZzhHisoJEUDmk6DwY4kVkGJrjWkmdXQcDFrWUYDSlEMEl9eB9HgndW64cdYWRl9YGncKM1bTdwsjgYPDeIVn4jVDXbjIYXKoDuOj86gOmTni8etKGwGKx2HL9p5s4r4X/qU7hFzTaCa/tco09E76s0xAufSLdQ6T0GhUG/+kFw5pGrjO3HX10OipRmtEZevIQN3r57jRk3afw6bf/wBvkVkGpF9Fbs9qiXMKsvYo0Fy0f1dYlzTC38NqXpPEsOh9tLtH5VoMfSu4//fZfBz/jAoRqQopEGQxoR3vetFrwZ9h4fCOcHwwmYLHScxqclEIyDbdLWG9cA2sO6YDaN2OxEFJCzj2PvVyc0HoYQ7r6Mmz3poY7t9A2v2RrAOB5jjlxGnvCrhdMIA5BvYMGYh1uwpe917nlhV+/jazKIi7NrK59dGBj9VzkCC03QanGao9ZkCkvWqa3Z9VHcR5uvsN87/5AFaitC49xBKOEkAsXf8YLu0xF/PkShe2otQxGbU9pbbWbM4rSdmiOxZuidFNRW3p9UNFbliKBTZ1Kkd0VeAgvswwNKXbOZY1uAoNB5GgwgCd5nLqfJjAYhCnLDgb0mxuyEj0NodlTQEWJruRzBO6Bej4PutES97VFiOuO7yES6iMo3bx030NL2kHFlw09tWzfB1GbDxMd4ebjQPg4cUml8E753KxyFgu0pLtg3nVQG9EE8UWbDIByxO9JJmHTrZXncfvSDLhUx3+4Syf0U2gr97Y4QzsXWbvq/kweHQXgEUuYFBkqh70+7eXrd29gfjwc03jSNSWPSKmjN6d/e/Xz2aswVKN1UWGHw/FwHPaH2vmKq95N/a9Kd9uJ23X7+gd8gWpaItq0jYzkIjSkzdojNpMXrPdRatL//nSVsFI7TyC3tyl3+N7K1YqOf63DZHpxlbA5t4L4Cx1nE/p593nps5I++aX5UvUUPvMpayfnbYenqL0LkUgrmYRd4/LOx7MVjbBNm0esRYgYxT3crXlho+l+/eqchUm+3Gwvr0N72fwg6jv52uw7IwP0l5rgnQi3t7F1Xa06+PjqsxiNgC00KelqtVr9H6jXDyU=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},y=void 0,f={},h=[];function j(e){const t={p:"p",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(b.default,{as:"h1",className:"openapi__heading",children:"Get Document"}),"\n",(0,o.jsx)(s(),{method:"get",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,o.jsx)(t.p,{children:"The Get Document API enables you to retrieve details about a specific document."}),"\n",(0,o.jsx)(b.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,o.jsx)(x.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,o.jsx)(l(),{...n(33154)}),"\n",(0,o.jsx)(m(),{...n(68936)}),"\n",(0,o.jsx)(u(),{...n(53026)})]})}function S(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(j,{...e})}):j(e)}},33154(e){e.exports=JSON.parse('{"parameters":[{"name":"document_id","in":"path","description":"objectId of Document","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"pH1bhc2hpb"}}]}')},68936(e){e.exports={title:"Body"}},53026(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","format":"string","example":"in-progress"},"objectId":{"type":"string","format":"string","example":"FGik23bhUJ"},"file":{"type":"string","format":"string","example":"https://exampleurl.com"},"certificate":{"type":"string","format":"string","example":"https://certificateurl.com"},"title":{"type":"string","format":"string","example":"sample doc"},"note":{"type":"string","format":"string","example":"please sign document"},"folder":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"FGik23bhUJ"},"name":{"type":"string","format":"string","example":"folder name"}},"title":"document_folder"},"owner":{"type":"string","format":"string","example":"joe bee"},"signers":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","example":"ceo"},"name":{"type":"string","example":"joe bee"},"email":{"type":"string","example":"joebee@example.com"},"phone":{"type":"string","example":"456213871"},"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","format":"string","example":"textbox"},"page":{"type":"number","format":"number","example":1},"x":{"type":"number","format":"number","example":244},"y":{"type":"number","format":"number","example":71},"w":{"type":"number","format":"number","example":38},"h":{"type":"number","format":"number","example":46},"options":{"type":"object","properties":{"name":{"type":"string","format":"string","example":"textbox"}}}},"title":"template_Signers_widgets"}}},"title":"template_Signers"}},"sendInOrder":{"type":"boolean","example":true},"send_in_order_strict":{"type":"boolean","example":false},"allow_offline_sign":{"type":"boolean","description":"Whether signers can submit a copy of this document signed using an external tool for owner review. Defaults to false.","example":false},"createdAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"enableTour":{"type":"boolean","example":true},"redirect_url":{"type":"string","format":"string","example":""},"allow_modifications":{"type":"boolean","example":false},"audit_trail":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"joebee@example.com"},"viewed":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"signed":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"title":"documentwithstatus_audit_trail"}},"template_id":{"type":"string","example":"template_id is only available when the document is created from a template."},"auto_reminder":{"type":"boolean","example":false},"remind_once_in_every":{"type":"number","example":0},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"]}},"xml":{"name":"documentwithstatus"},"title":"documentwithstatus"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"Document not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Document not found!"}},"title":"inline_response_404_3"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/951b8254.b27a519c.js b/assets/js/951b8254.b27a519c.js deleted file mode 100644 index 5ac6a997c..000000000 --- a/assets/js/951b8254.b27a519c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[6289],{36258(e,t,a){a.r(t),a.d(t,{assets:()=>g,contentTitle:()=>y,default:()=>L,frontMatter:()=>b,metadata:()=>i,toc:()=>x});const i=JSON.parse('{"id":"API-docs/v1.2/update-template","title":"Update Template","description":"The Update Template API enables you to modify and update the details of a specific template.","source":"@site/docs/API-docs/v1.2/update-template.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/update-template","permalink":"/docs/API-docs/v1.2/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":"eJzFWd1yG7cVfpVTXFQ2Z0XKjp1MmZu4iWtr6rE0ljyeVtZwsIuzXERYYANgSXE0nMlF36BXve2j5Uk6B9hfkpblJG1vbBELHJw/HHznwx3zfOnY/IpdYlkp7tGx64QJdJmVlZdGszm7LBDeV4J7hHYWvDg/BdQ8VehgY2rwBkojZL4BrgXUcbYvEAR6LpUDkwMHV2Emc5mBb+RMWcJMhZbTVqeCzVlc2u7DElZxy0v0aEnNO6Z5iWzOWgELKVjCJKlZcV+wXd1Pf6CdSZF2BfiCe9CIwpHWKTbakhyLP9XSomBzb2tMmPMbRbs5WVaKlMHbShmBbJ5z5WhCVmDJ2fyO+U0VZnor9ZIlLDe25L4f2W6vo3x0/s9GbGjNWNVza1ZSIKSozBo6s0nJ1p9tjOAR96CQOw9G42Bua8BjlrDMaI/a00a8qpTMgpNnPzra7W5fdZP+iJknj1sKiZfo6Gt0+OcNJOfw4KY5c+GPTl+2TZg2/ovFnJOJCBZXEtchsZxcavCFdCBMVpdk3nYn5F+2RZcVQxlbWqMEWsrIfXn9apoZT8HZ5flgamqMQq73spGyCo6jASYMwloq1ZwkOLs8hxVaOiEhVlN479C6OMdihnKFwEdTIDMCYSU5YMmlSmBdyKyghN9AWTsPqJscalyHneemEJIYjmFfISHdQY0S4EqZtdRLqINqhwSDkBYzrzawlr4wtQcuhKTlXIHzWLnp0ItBi86Rl6a2v92THJa1FCjAm9pCbmzQEq1LoArHjCyQ2nlbZ7TYgagpusEOmkp/V9Zk6Fzvp9YrNGkgPwHULi7nkHPn0SZQa0met3XlUXQi8bZCK1FneNAFwbmLUEgbh7uH++IcbSm9ay2l0HAhABVSUBy4OiuAx+/c1xZdAlJLL7lyCTjPy8olYCx4vKW6At5UVDzxVjpPyq+lWKJ3ID+VR++Qzkg20CG3pgzRJ9/ozTAROr282RF3SUGVrrk+cl4rDyuu6sM+c6jFQuqFsQLtIirwAKd9KFCDQ0/bH5EHjxJAnhWN6rR/qkx2g6IxIqNcaFOkS/Vae6noUEBFBzQY2hpf8BVCZkhdygFfoLTAs3iyX+rc2AwdRI3B0dWgKRhtskzhTKsNhNqNDtak8BFZe6rPyNYj0pEr1+o/hR+is4JLj4J/jg66LJfqYC0ee+hvpoaSb5oDE7M+5Q6/fgaoqewIOP/hL0DCaEOLleJZnNaljNE4LMBx+V4JJRGLiju3NvZgxb2vgpMAi7HkLGqrPm/YRUQhGDPs/bs35FuL3dlHG2tJSldPFIyEaUK1DdHcS4PdkrGnIa+9WVgspRb4kPp2ETMzHG1vurJWe1NyLzNoRbkpNFPjIfRmWKVKeNQeoBQLvpLGPj6YEVHcwugM6SzhCu1moKWuyxTtnpJvwzDVCME3DlL0a0Q91K09yqbL5CzoFpJ55BOa5XqjR1o+j/hB5puF0Yu+fh3049i2XZUnE5I+mcAxXA4DmFnk3tidq1bHWxXC5u2NS7qTgwjPxmyh/9y4iH3UH/VkElT4zGba+N9rw7fG4xze4ZJbodC5CH2jYylnE+BdBpt2K7qj+9QXvZaEtwazM4KEQScE7j3PChQUNIEVakH3RShOiyD1qMek048BUFWoF5lRxg6jxq3lG8LvHku3f3C3g2hesVTVGDA6IfVU8eyGXW8TlmbZr5VIEOa75vc0MyVLwtDT0dheO5RmGTxKlST3cJuGqlBtHs8bsMYFVcZQUHZw2yio0fl04MaVRLr+ygiu2ybMSz8Cq4tB97NIqZnYbrfhFLvKaBcPxtOTk/0eo+vfmp6HQAEVrLxWavOH369piMOfg8/ciaev3fmz1xUFplHphb9/0dOTp18dPzk5Pvnm8snX82d/mj//enpycvJ3lrDbUvUdCxNN59F6L/4eDEitpMZF67XF05OTxVeNK58d8l7Tj7QX4oorKSCXqATQnu53dCBaa+yv7Jfu0e8+88nk1vhn96QOFazc1Fr8v809pNH9Bj5bfNOZ+HzfxFMdXUbkxqW5Qf2/sLC3Z7i9j9uTquOslnFS+M5Gxg7Ho5EOs9pKvwnEye0xr+Rx/D6/uiY6okRfGCJdqjooTATKnM3a6jK7G9SZLSN5dtXyMAFpscL7ys1nM8e1SM3t1FSo6R5RPHVUPWe8krPVk+lTtk121/Cq+qL5WB9/6RLn+VLq5efWXfeuuqBwxoiNHNZfMJX8K9IN08RjOKshogrkBPIoApQl73rS52Ub6y6cu0xJS5Q8jPvY6wQPsRlDMoOxEWHRQKRh590MHexEW9LrYMfVfIy9Be2zg+oZ28XpNLKDixshh+Ho80+hwGbVEGIchgsNWnjozb+lgOYmRL85ZmcV6gsKBB3SkD17jSWqzJTYtrWTSbvkl3/8u1s1mXRBjEwPwbez2kJl1mjzWoWI5wpvJcHlwLaW4VtHtzrkJYE8tQFiGpY2xF0upe9bSMh4xVOpJFUhmmZotYVBIXNT+FCgL9DSpyNLQEXgChUVr67h0MseoayNvcmVWTuCk2ntpCaoibrgOgvtb3OUApdAiJZ4kMpKh9TrktYy6ma0tzzzUHLNl4EMSGDoLIFKUr0Ba1KispxRdSRriFI2NtAv0aBA5wYnviSG1iLQKAEpiwWd+1XD2LgkMmbx3JEJWkCKzkNFukjqyIlw1dT7hwASNILK+KY5N/lIR1ruLdeOLqqoSxuDzmFNU4iu6QreO6QIv5H6xs0nk4/6GK66vPqAqZMerx+1NWy9Xu/VrsfjNa+kf12n8A4r46Q3dtOvXkpf1Gmod0Mh3Y8o6RVqDPkzqGa9DGEyt18+aXRWoKpmF7G7cLMX56fh2nwMv/z8T3iD3GoozDpma1ZbVBtYtluR52Lko9u6Wy/Qdbz2BXk8i8nXEOetBz8U3P/y878cvMU10VHxSJEpk8kr9P0zxR9h9PONdH4ymVOHalbU02uNFBpuN33D4mK1RRogiFxZzAMnyj2PXFDThfUrprT1x3HF+8gGvHxsCqSOrV9f75Ndaj9pZ/THLfRn3Wdhee7HTZpDlcfbwZraxwRuMWCrTXBqZY2PZEYl8lbpWOlNngewRGIepPnonacd6/cPUnuOuOEvjO3YiWbDrlKRfpEh6145GgWjtxfWKDysWc/bOIjoK1ASI0ft+fWzjt6LFBlc1akaPF81Bk/hRZZhIHoDT+nmMJlEjSaTjoJ5nMBkQrc5jdLfvKIo0a8pXDT6B84+EIejF57utmtI2G8hChou0KZlaL+FVrQLDF6Upzcdg9vx8gPBzdNRQyZQNzXGP+NbzmKOlnwXwtsf6ko2h/iqLQZANeK3FBNCuXRX8MjrhsY5ArHvduUEQIy2dGf5BdqVzLABg5+oo7MwecYSpmSG2g2R2YtX529g9dX0hLBBhyofUFJnb06/f/n24iUpQyGIDnsyPZmeBCLEOF9yPdhp5211F1Hc9S3If/sptsG49AAwqxSXocNoONXYHVyxAVSdD19hrxNWGOdpyt0dEb3vrdpuafinOsC3q+uErbiVpGloIZpSIA5TdUOzH71r3zXhyx50DxrUInlNMD4c2IhFb3Cz87K8JQjYwHnSOM74Pup1fElyegl73SH1I3FFLA/3zh22Y+fvLwmzNq/EZXhwZpavCc7ydVQ2PnqFRiWM3THF9bLmS5obRW4j71yMu5eb0L00f5BRB90xbmuiFfQv2XRwwd1d7Iy2225+/PTJFY1f29kUm+vtdvsfyEOG/w==","sidebar_class_name":"put api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Template","permalink":"/docs/API-docs/v1.2/get-template"},"next":{"title":"Delete Template","permalink":"/docs/API-docs/v1.2/delete-template"}}');var n=a(74848),o=a(28453),p=a(57742),s=a.n(p),l=a(78178),r=a.n(l),d=a(19624),c=a.n(d),m=a(96226),h=a.n(m),u=(a(77675),a(19365),a(51107)),f=a(21312);const b={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:"eJzFWd1yG7cVfpVTXFQ2Z0XKjp1MmZu4iWtr6rE0ljyeVtZwsIuzXERYYANgSXE0nMlF36BXve2j5Uk6B9hfkpblJG1vbBELHJw/HHznwx3zfOnY/IpdYlkp7tGx64QJdJmVlZdGszm7LBDeV4J7hHYWvDg/BdQ8VehgY2rwBkojZL4BrgXUcbYvEAR6LpUDkwMHV2Emc5mBb+RMWcJMhZbTVqeCzVlc2u7DElZxy0v0aEnNO6Z5iWzOWgELKVjCJKlZcV+wXd1Pf6CdSZF2BfiCe9CIwpHWKTbakhyLP9XSomBzb2tMmPMbRbs5WVaKlMHbShmBbJ5z5WhCVmDJ2fyO+U0VZnor9ZIlLDe25L4f2W6vo3x0/s9GbGjNWNVza1ZSIKSozBo6s0nJ1p9tjOAR96CQOw9G42Bua8BjlrDMaI/a00a8qpTMgpNnPzra7W5fdZP+iJknj1sKiZfo6Gt0+OcNJOfw4KY5c+GPTl+2TZg2/ovFnJOJCBZXEtchsZxcavCFdCBMVpdk3nYn5F+2RZcVQxlbWqMEWsrIfXn9apoZT8HZ5flgamqMQq73spGyCo6jASYMwloq1ZwkOLs8hxVaOiEhVlN479C6OMdihnKFwEdTIDMCYSU5YMmlSmBdyKyghN9AWTsPqJscalyHneemEJIYjmFfISHdQY0S4EqZtdRLqINqhwSDkBYzrzawlr4wtQcuhKTlXIHzWLnp0ItBi86Rl6a2v92THJa1FCjAm9pCbmzQEq1LoArHjCyQ2nlbZ7TYgagpusEOmkp/V9Zk6Fzvp9YrNGkgPwHULi7nkHPn0SZQa0met3XlUXQi8bZCK1FneNAFwbmLUEgbh7uH++IcbSm9ay2l0HAhABVSUBy4OiuAx+/c1xZdAlJLL7lyCTjPy8olYCx4vKW6At5UVDzxVjpPyq+lWKJ3ID+VR++Qzkg20CG3pgzRJ9/ozTAROr282RF3SUGVrrk+cl4rDyuu6sM+c6jFQuqFsQLtIirwAKd9KFCDQ0/bH5EHjxJAnhWN6rR/qkx2g6IxIqNcaFOkS/Vae6noUEBFBzQY2hpf8BVCZkhdygFfoLTAs3iyX+rc2AwdRI3B0dWgKRhtskzhTKsNhNqNDtak8BFZe6rPyNYj0pEr1+o/hR+is4JLj4J/jg66LJfqYC0ee+hvpoaSb5oDE7M+5Q6/fgaoqewIOP/hL0DCaEOLleJZnNaljNE4LMBx+V4JJRGLiju3NvZgxb2vgpMAi7HkLGqrPm/YRUQhGDPs/bs35FuL3dlHG2tJSldPFIyEaUK1DdHcS4PdkrGnIa+9WVgspRb4kPp2ETMzHG1vurJWe1NyLzNoRbkpNFPjIfRmWKVKeNQeoBQLvpLGPj6YEVHcwugM6SzhCu1moKWuyxTtnpJvwzDVCME3DlL0a0Q91K09yqbL5CzoFpJ55BOa5XqjR1o+j/hB5puF0Yu+fh3049i2XZUnE5I+mcAxXA4DmFnk3tidq1bHWxXC5u2NS7qTgwjPxmyh/9y4iH3UH/VkElT4zGba+N9rw7fG4xze4ZJbodC5CH2jYylnE+BdBpt2K7qj+9QXvZaEtwazM4KEQScE7j3PChQUNIEVakH3RShOiyD1qMek048BUFWoF5lRxg6jxq3lG8LvHku3f3C3g2hesVTVGDA6IfVU8eyGXW8TlmbZr5VIEOa75vc0MyVLwtDT0dheO5RmGTxKlST3cJuGqlBtHs8bsMYFVcZQUHZw2yio0fl04MaVRLr+ygiu2ybMSz8Cq4tB97NIqZnYbrfhFLvKaBcPxtOTk/0eo+vfmp6HQAEVrLxWavOH369piMOfg8/ciaev3fmz1xUFplHphb9/0dOTp18dPzk5Pvnm8snX82d/mj//enpycvJ3lrDbUvUdCxNN59F6L/4eDEitpMZF67XF05OTxVeNK58d8l7Tj7QX4oorKSCXqATQnu53dCBaa+yv7Jfu0e8+88nk1vhn96QOFazc1Fr8v809pNH9Bj5bfNOZ+HzfxFMdXUbkxqW5Qf2/sLC3Z7i9j9uTquOslnFS+M5Gxg7Ho5EOs9pKvwnEye0xr+Rx/D6/uiY6okRfGCJdqjooTATKnM3a6jK7G9SZLSN5dtXyMAFpscL7ys1nM8e1SM3t1FSo6R5RPHVUPWe8krPVk+lTtk121/Cq+qL5WB9/6RLn+VLq5efWXfeuuqBwxoiNHNZfMJX8K9IN08RjOKshogrkBPIoApQl73rS52Ub6y6cu0xJS5Q8jPvY6wQPsRlDMoOxEWHRQKRh590MHexEW9LrYMfVfIy9Be2zg+oZ28XpNLKDixshh+Ho80+hwGbVEGIchgsNWnjozb+lgOYmRL85ZmcV6gsKBB3SkD17jSWqzJTYtrWTSbvkl3/8u1s1mXRBjEwPwbez2kJl1mjzWoWI5wpvJcHlwLaW4VtHtzrkJYE8tQFiGpY2xF0upe9bSMh4xVOpJFUhmmZotYVBIXNT+FCgL9DSpyNLQEXgChUVr67h0MseoayNvcmVWTuCk2ntpCaoibrgOgvtb3OUApdAiJZ4kMpKh9TrktYy6ma0tzzzUHLNl4EMSGDoLIFKUr0Ba1KispxRdSRriFI2NtAv0aBA5wYnviSG1iLQKAEpiwWd+1XD2LgkMmbx3JEJWkCKzkNFukjqyIlw1dT7hwASNILK+KY5N/lIR1ruLdeOLqqoSxuDzmFNU4iu6QreO6QIv5H6xs0nk4/6GK66vPqAqZMerx+1NWy9Xu/VrsfjNa+kf12n8A4r46Q3dtOvXkpf1Gmod0Mh3Y8o6RVqDPkzqGa9DGEyt18+aXRWoKpmF7G7cLMX56fh2nwMv/z8T3iD3GoozDpma1ZbVBtYtluR52Lko9u6Wy/Qdbz2BXk8i8nXEOetBz8U3P/y878cvMU10VHxSJEpk8kr9P0zxR9h9PONdH4ymVOHalbU02uNFBpuN33D4mK1RRogiFxZzAMnyj2PXFDThfUrprT1x3HF+8gGvHxsCqSOrV9f75Ndaj9pZ/THLfRn3Wdhee7HTZpDlcfbwZraxwRuMWCrTXBqZY2PZEYl8lbpWOlNngewRGIepPnonacd6/cPUnuOuOEvjO3YiWbDrlKRfpEh6145GgWjtxfWKDysWc/bOIjoK1ASI0ft+fWzjt6LFBlc1akaPF81Bk/hRZZhIHoDT+nmMJlEjSaTjoJ5nMBkQrc5jdLfvKIo0a8pXDT6B84+EIejF57utmtI2G8hChou0KZlaL+FVrQLDF6Upzcdg9vx8gPBzdNRQyZQNzXGP+NbzmKOlnwXwtsf6ko2h/iqLQZANeK3FBNCuXRX8MjrhsY5ArHvduUEQIy2dGf5BdqVzLABg5+oo7MwecYSpmSG2g2R2YtX529g9dX0hLBBhyofUFJnb06/f/n24iUpQyGIDnsyPZmeBCLEOF9yPdhp5211F1Hc9S3If/sptsG49AAwqxSXocNoONXYHVyxAVSdD19hrxNWGOdpyt0dEb3vrdpuafinOsC3q+uErbiVpGloIZpSIA5TdUOzH71r3zXhyx50DxrUInlNMD4c2IhFb3Cz87K8JQjYwHnSOM74Pup1fElyegl73SH1I3FFLA/3zh22Y+fvLwmzNq/EZXhwZpavCc7ydVQ2PnqFRiWM3THF9bLmS5obRW4j71yMu5eb0L00f5BRB90xbmuiFfQv2XRwwd1d7Iy2225+/PTJFY1f29kUm+vtdvsfyEOG/w==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},y=void 0,g={},x=[];function v(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Update Template"}),"\n",(0,n.jsx)(s(),{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)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,n.jsx)(f.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,n.jsx)(r(),{...a(9525)}),"\n",(0,n.jsx)(c(),{...a(93399)}),"\n",(0,n.jsx)(h(),{...a(46681)})]})}function L(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(v,{...e})}):v(e)}},9525(e){e.exports=JSON.parse('{"parameters":[{"name":"template_id","in":"path","description":"ID of the template that needs to be updated","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string"}}]}')},93399(e){e.exports=JSON.parse('{"title":"Body","body":{"description":"Provide below parameter to update templates (at least one parameter required)","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","format":"string","example":"sample template"},"note":{"type":"string","format":"string","example":"Please review and sign this document"},"description":{"type":"string","format":"string","example":"template description"},"folderId":{"type":"string","example":""},"enableOTP":{"type":"boolean","description":"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.","example":false},"enableTour":{"type":"boolean","description":"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.","example":false},"allow_modifications":{"type":"boolean","description":"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.","example":false},"send_in_order_strict":{"type":"boolean","description":"When set to \'true\', each signer is blocked from accessing the document until all preceding signers have completed their action. Enforces strict sequential signing. Only applies when \'sendInOrder\' is also \'true\'. Defaults to \'false\'.","example":false},"file":{"type":"string","description":"You may provide the base64 encoded PDF file to replace the existing one","format":"base64","example":""},"file_password":{"type":"string","format":"string","example":""},"redirect_url":{"type":"string","description":"Specifies the URL where the signer will be redirected upon completing the document signing process.","example":""},"auto_reminder":{"type":"boolean","description":"Set to true to enable automatic reminders. Set to false to disable them (default behavior).","example":false},"remind_once_in_every":{"type":"number","description":"Number of days between reminders. This is only applicable when auto_reminder is set to true.","example":5},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed.\\n"}},"title":"template_template_id_body"}}}}}')},46681(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Template updated successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","example":"asd2HsP4Hp"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"title":"inline_response_200_3"}}}},"400":{"description":"Please provide valid field names!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","format":"string","example":"Please provide valid field names!"}},"title":"inline_response_400"}}}},"404":{"description":"Template not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","format":"string","example":"Template not found!"}},"title":"inline_response_404_7"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/951b8254.d1634b06.js b/assets/js/951b8254.d1634b06.js new file mode 100644 index 000000000..052b9fb3f --- /dev/null +++ b/assets/js/951b8254.d1634b06.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[6289],{36258(e,t,i){i.r(t),i.d(t,{assets:()=>J,contentTitle:()=>y,default:()=>F,frontMatter:()=>h,metadata:()=>a,toc:()=>T});const a=JSON.parse('{"id":"API-docs/v1.2/update-template","title":"Update Template","description":"The Update Template API enables you to modify and update the details of a specific template.","source":"@site/docs/API-docs/v1.2/update-template.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/update-template","permalink":"/docs/API-docs/v1.2/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":"eJzFWt1uG8cVfpXTDVBLxJKUHSdBmaKtIyuOUdcSJLlGKwnkcOeQnGg4s52ZJUXIBHpR9AGK3vS2L9H7PkqepDjzs7v8iWU3aXphS9o9c+b8zznf7H3m2NRmg6vsEuelZA5tdpNnHG1hROmEVtkgu5whvCk5cwiJCp6dvQRUbCzRwkpX4DTMNReTFTDFoQrUbobA0TEhLegJMLAlFmIiCnCRTy/LM12iYbTVS54NsrA07ZPlWckMm6NDQ2LeZ4rNMRtkicFQ8CzPBIlZMjfLtmV/+Zx2JkHSCnAz5kAhcktSjzFKS3wM/qkSBnk2cKbCPLNuJWk3K+alJGHwrpSaYzaYMGmJoJjhnGWD+8ytSk/pjFDTLM8m2syZa56s1zeBP1r3leYrWrMp6pnRC8ERxij1Emq1Schkz+QjOGAOJDLrQCts0SYFDrM8K7RyqBxtxMpSisIbuf+tpd3ud0XX42+xcGRxQy5xAi29DQZ/WEEyDvNmGmTW/1LLm63zTGn30WzOSEUEgwuBSx9YVkwVuJmwwHVRzUm99ZbLP26LOiraPNa0RnI0FJG7/JrVRBmy4PTyrEU61loiUzvRSFEF3aCA9g9hKaSMmQSnl2ewQEMZ4n3VgzcWjQ00BgsUCwS2QQKF5ggLwQDnTMgcljNRzCjgVzCvrANUMYai6bC2XA98EEMXdgXiwu6VKAcmpV4KNYXKi7aPMXBhsHByBUvhZrpywDgXtJxJsA5L22tb0UtRG/JSV+aHW5LBtBIcOThdGZho46VEY3MofZqRBkJZZ6qCFlvgFXnX60Gk9HtpdIHWNnZKViGiFv8cUNmwnMGEWYcmh0oJsrypSoe8Zol3JRqBqsC9JvDGHfpCGg1uP9wWZ2jmwtmkKbmGcQ4okZxiwVbFDFh4z1xl0OYglHCCSZuDdWxe2hy0AYd3VFfA6ZKKJ94J60j4peBTdBbE98XROVKOFC0ZJkbPvffJNmrVDoRaLqe32F2SU4WNx8eEVdLBgslqv80sKj4UaqgNRzMMAnyA0d7OUIFFR9s/Igs+ygFZMYui0/5jqYtb5FGJgmIhhUgd6pVyQlJSQEkJ6hVNys/YAqHQJC7FgJuhMMCKkNknaqJNgRaCxGDpaFDkjBQsPThVcgW+dqOFJQn8iLR9qU5J10ckI5M2yd+D58FY3qSPvH0e7TXZRMi9tXjTQn/QFczZKiZMiPoxs/j5U0BFZYfD2fOvgZjRhgZLyYpAVoeMVtguwGH5TgklFsOSWbvUZm/FfV8FJwYGQ8kZVkY+rNhF6EIwRNib81dkW4N17qMJtWRMR09gjNTT+GrrvbkTBtslY0dCVjk9NDgXiuOH1LeLEJk+tZ2uy1rl9Jw5UUBiZXsQSUMSOt2uUnM4SAk0xhlbCG0O90ZEYDfUqkDKJVygWbWkVNV8jGZHyNf+MdUIzlYWxuiWiKotW0plXUdy4WXzwbxhE6KyjdIbUn4W+gcxWQ21Gjb1a68dN3XbFrnTIe6dDnThsu3AwiBz2mwdtSqcquA3TycuyU4Gon42RAv9sJtF7Fpdq07Hi/DAZkq7H2vD19rhAM5xygyXaG1ofYNhKWZzYHUE67QVndFN6PNGSuq3WtQFtYReJgTmHCtmyMlpHEtUnM4LX5yGnuujpiftXfuGqkQ1LLTUpu01ZgxbUf/ucG53E3fd8uZVNpYV+h6dOvWxZMVtdrPOs3FR/LccqYX5Tfy7V+h5lvtHTzae7YxD46KAg7EUZB5mxr4qlKvDQWzWGKfK6AvKVt+24dRgfEq4zUoibHNkRNP91AqSfj+FZus8c8JttOHD1lw3HNOYtF6vfX2ypVY2pPyTo6Pd6ameTOM0R+0OleJJJeXqZz/eOBQePzQYMMuffGPPnn5TkkeiSM/c+xc9OXryaffxUffoi8vHnw+e/mLw2ee9o6OjP2Z5djeXzSyW8ThTJeuFv1sPhJJC4TBZbfjk6Gj4aTTl033Wi5NWOuoXTAoOE4GSA+1pf0QDojHafOwh/7B871OfVE7KP31P6FApnuhK8f+3uvsker+CT4df1Cp+tqviSxVMRrDNpb5F9VNo2OjT3t6F7UnUzagWgci/zzaUbT8PSlosKiPcykNCd11Wim54P7i6IaBljm6mCU4qKy8wQUODrJ+qS/++VWfWGfEzi4Qw+R4ymzlX2kG/b5niY33X0yUqOiElG1sqm31Wiv7ice9Jts6317Cy/Ch6rLofu8Q6NhVq+tC6m8ZUF+TO4LENgzUnSyl+i3S0RH+0qSLENkNG7St5gKLkvIGzTpKva3duY0AJAvowVGdnxt2H07RhmizbgGJi89fGFOKjvTN2gvP2zpLxZZiaaJ+teSXLticQerLV8Ucm+xvtz76vv42r2s3T/kYo9kEffuR/DPWa3D/RPlZiUp6WqC7IbZTSPta2PfYJJJrv/vLPmoza1F9Bp0P9MMVt1+rKFAjPdVF5fkw6NIo5aiy++/PfYVwJ6TyCw3GBkgqPzWlEsHTIj1cB4CqNsGh7nQ7xb+87FYuIUNetL3oMiAfgp2uQ8RVgt7Y6UJxRcQY3M7qaznzbraYSczg/ubicVJK0oblLNd2yrUEmzySHOVNs2oJsSWZW3NaTonXMVR5LMcgkODHH3CdDnPGQhDaknTCtJkqKCRarQgbjEO6QMLYFKq4NEGbRFcrPA91ul3588gm8CAMAXDhmHHJ6ekKhBxGRDlhhwYxZhX3rSp3QnlGrHIwgFAK/yWg0ulatlwP4JXFoHvwq0tBA9N1f/wZX3+gljXlTVAT849aGNwepxnFd2N3iRk/7M5Rl/yIoZfvPzl76Q+0w+P+1dmDJk3GsJ5B/KtSvqY31unQ6saoDqoUwWpFpOx04GH1w1R8dEt/SaKepfDZI52SChTe1pAjmzLEtVxxrg3DMSjYWUtAZSs/fwTFzONVmBe/gLV1QUMgWTAHX8O5avet2u/4fkXY6z1PUdTrwDo5pnMQcqHrlsf/Nqb7q2xhTHCnum/DsJrc34Rs519dAnvNXlZAcDFYRUajvH/zQWBrsesyHJ2jwSy8DWYauJbShLFjVeFjc4gLlpEv56bd4kaLA0uOtGdQ2dq1xObUQLgwaE7oniUzPqrEUBWyKfzFjhsaTMrxMqSeFuvXpo3TiKoV19eVJ4vncsImDt9rc0k6BI0F6jXQeLE02YRY4rbDe5BOhmBQ2wjBEYRLfY60cK6LzfhfqhM+BKEwR3sNY61sKsalhc4/6MClXicnX/uQLPE7NlCnaq5FMKEuNcl2mnxsKx3Bc1p54i+OZ1reByXmc5qgcdakcAS6o4rRnOwshMg3opQJUvNRCucTOT4mRlzMCaTQsCl0lLIHOSAd0klDnSx58t5kaFPjf/fkfFl7jkupOOjA+obQheAdNcwMZ92DyWo1enFxC09wNBB/5HTefk49HAZQdE0xlnUE2p0aa+2gwyCvFmXINdmGBAsjgXC+Qe5adTmlw4q9ImGM00yq9BIOuMsTHIq11KFcBNY4ebRh2OnQ03FIY1jMtILMiXNIUWtlqjr2k9VlsMrpnRruAQxLmelGVpTbuWtF7GF1vdiTX2ShV7ZTnNEoH0G2pzW0A892McFyzKiNXghIDXyQ4Z3CtRmenF5fQ93AVJjOO4N//gtHZmx2L+8etBSkY+4NWs90m89mSqHZebO3nX1CNIJOOkn1OJxNyIFzE1KbUMlpeKwJFR9ex2dOByndW19kgoKrvAmI6IuTqexT1MbRHUwJk72hgEnTJFbFZ6lAi8hr3qwsOtQb+bqG+9k7yX4T4ONeSzgFqikaxWo4gjFs+vujyoaTCQjoFgqHREsnTYQpmhdHW+obAa0HZZXTl0IOwBhGIPsSzTV4ehKOHdqdiHxDiyuwcOFGmEXQSnHzoS5fvGWJTBRs30k03FU6GUCJG1PETn7rabIKY3lBxLvCIcSzS6eLJezPV5xErCQ4I7I6ZCplN500ixzuyWjw6gjSxxPvN3tWlJWBdx7pcwcHx8SEJJ0pBdfRaPQOFSzJ7UTTWjmlfGxKY1Gpq0y1Jff0xuqa2vFmnVa1rXgdDHo6NMAmlQ7D2Yj/e/Sdnnnh0jXFu0FLtoKpGQKxqZGxwuYDidQnF+y8wOnglbrHRISfxN6SBg3SnGLKkyXjBR4etm9ZaNPKXETz6vR7q/O1e7g+cUKXIslKQYW0AxUu3Ag99wsHo6mZ0+CXouXCeSzCt0yDUDE18uMl6qwV7tmBC+kw9afq/2Ie1nlBO0KRKN0S7PdhFaBH9efcRfWPdsNQjyCaH9w709eqTNwTz7yx+CEgYbZ+4v0djhfZF6ufwFStul8xwC8d6XjInfIe6IlJaTMHh0VQYJ8JuEQll6IBh8diH8eJx73E9oKQ2Id4Gu5m2SB8V2NBQUIdW+0NHHGCc7O65Kg1jg+HULGZMTSkRqEdoHdSCCj+vipALXl5iHb4NYBIqFW5E3AzNknolQiP4VmC8sUjj3Suhbn04dOGq7qDe4tgKh814slwudyx96Nd8XUkJqUf3CffAUBOWvRDum2oM51hqK5w2q2bVVLhZNfa+bK+t/4gMUi9dw3w/ZJjyLC/RzP090gWahSgeUL/viLx/eE3YzBbKtIkOGJygobpjN0ZBVoo4dl4lOYDE+yF6+CuU0FJ7uJJKX4C7frPNx8OOpMLpJOobIbf365vlmRQFKtvGv569OHsFi097R4Sp1NjdB/iy/+rl8cnrixMSJqZJNsge9456R/4iTVs3Z6q109a3edtIzH0D9P6vP+WLSCJ9QNIvJRMex4138gGDvcpagGC7MSRMaqatI5L7e8r/N0au1/T4T5UHya5u8mzBjCBJPVAb2y2+/6q3rfbBefouDj7ug8C9CiW8VBFY6s+XgPjd4mrry8Q1QWcRNCWJA8VxkKt7SXwaDjsYPKG+YcUz3/+9l7YNep+9uSRkMH5lOPcfLGaGLQk0ZMsgbCiMHg72z+4zydS0YlOiDSzX4buF2SZGfOsx4vgLKbXXHJvgcdCC/ied9i64vw/483pd04dX37si2jVRk29u1uv1fwBP8yqd","sidebar_class_name":"put api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Template","permalink":"/docs/API-docs/v1.2/get-template"},"next":{"title":"Delete Template","permalink":"/docs/API-docs/v1.2/delete-template"}}');var n=i(74848),s=i(28453),l=i(57742),o=i.n(l),d=i(78178),p=i.n(d),r=i(19624),c=i.n(r),m=i(96226),u=i.n(m),g=(i(77675),i(19365),i(51107)),f=i(21312);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:"eJzFWt1uG8cVfpXTDVBLxJKUHSdBmaKtIyuOUdcSJLlGKwnkcOeQnGg4s52ZJUXIBHpR9AGK3vS2L9H7PkqepDjzs7v8iWU3aXphS9o9c+b8zznf7H3m2NRmg6vsEuelZA5tdpNnHG1hROmEVtkgu5whvCk5cwiJCp6dvQRUbCzRwkpX4DTMNReTFTDFoQrUbobA0TEhLegJMLAlFmIiCnCRTy/LM12iYbTVS54NsrA07ZPlWckMm6NDQ2LeZ4rNMRtkicFQ8CzPBIlZMjfLtmV/+Zx2JkHSCnAz5kAhcktSjzFKS3wM/qkSBnk2cKbCPLNuJWk3K+alJGHwrpSaYzaYMGmJoJjhnGWD+8ytSk/pjFDTLM8m2syZa56s1zeBP1r3leYrWrMp6pnRC8ERxij1Emq1Schkz+QjOGAOJDLrQCts0SYFDrM8K7RyqBxtxMpSisIbuf+tpd3ud0XX42+xcGRxQy5xAi29DQZ/WEEyDvNmGmTW/1LLm63zTGn30WzOSEUEgwuBSx9YVkwVuJmwwHVRzUm99ZbLP26LOiraPNa0RnI0FJG7/JrVRBmy4PTyrEU61loiUzvRSFEF3aCA9g9hKaSMmQSnl2ewQEMZ4n3VgzcWjQ00BgsUCwS2QQKF5ggLwQDnTMgcljNRzCjgVzCvrANUMYai6bC2XA98EEMXdgXiwu6VKAcmpV4KNYXKi7aPMXBhsHByBUvhZrpywDgXtJxJsA5L22tb0UtRG/JSV+aHW5LBtBIcOThdGZho46VEY3MofZqRBkJZZ6qCFlvgFXnX60Gk9HtpdIHWNnZKViGiFv8cUNmwnMGEWYcmh0oJsrypSoe8Zol3JRqBqsC9JvDGHfpCGg1uP9wWZ2jmwtmkKbmGcQ4okZxiwVbFDFh4z1xl0OYglHCCSZuDdWxe2hy0AYd3VFfA6ZKKJ94J60j4peBTdBbE98XROVKOFC0ZJkbPvffJNmrVDoRaLqe32F2SU4WNx8eEVdLBgslqv80sKj4UaqgNRzMMAnyA0d7OUIFFR9s/Igs+ygFZMYui0/5jqYtb5FGJgmIhhUgd6pVyQlJSQEkJ6hVNys/YAqHQJC7FgJuhMMCKkNknaqJNgRaCxGDpaFDkjBQsPThVcgW+dqOFJQn8iLR9qU5J10ckI5M2yd+D58FY3qSPvH0e7TXZRMi9tXjTQn/QFczZKiZMiPoxs/j5U0BFZYfD2fOvgZjRhgZLyYpAVoeMVtguwGH5TgklFsOSWbvUZm/FfV8FJwYGQ8kZVkY+rNhF6EIwRNib81dkW4N17qMJtWRMR09gjNTT+GrrvbkTBtslY0dCVjk9NDgXiuOH1LeLEJk+tZ2uy1rl9Jw5UUBiZXsQSUMSOt2uUnM4SAk0xhlbCG0O90ZEYDfUqkDKJVygWbWkVNV8jGZHyNf+MdUIzlYWxuiWiKotW0plXUdy4WXzwbxhE6KyjdIbUn4W+gcxWQ21Gjb1a68dN3XbFrnTIe6dDnThsu3AwiBz2mwdtSqcquA3TycuyU4Gon42RAv9sJtF7Fpdq07Hi/DAZkq7H2vD19rhAM5xygyXaG1ofYNhKWZzYHUE67QVndFN6PNGSuq3WtQFtYReJgTmHCtmyMlpHEtUnM4LX5yGnuujpiftXfuGqkQ1LLTUpu01ZgxbUf/ucG53E3fd8uZVNpYV+h6dOvWxZMVtdrPOs3FR/LccqYX5Tfy7V+h5lvtHTzae7YxD46KAg7EUZB5mxr4qlKvDQWzWGKfK6AvKVt+24dRgfEq4zUoibHNkRNP91AqSfj+FZus8c8JttOHD1lw3HNOYtF6vfX2ypVY2pPyTo6Pd6ameTOM0R+0OleJJJeXqZz/eOBQePzQYMMuffGPPnn5TkkeiSM/c+xc9OXryaffxUffoi8vHnw+e/mLw2ee9o6OjP2Z5djeXzSyW8ThTJeuFv1sPhJJC4TBZbfjk6Gj4aTTl033Wi5NWOuoXTAoOE4GSA+1pf0QDojHafOwh/7B871OfVE7KP31P6FApnuhK8f+3uvsker+CT4df1Cp+tqviSxVMRrDNpb5F9VNo2OjT3t6F7UnUzagWgci/zzaUbT8PSlosKiPcykNCd11Wim54P7i6IaBljm6mCU4qKy8wQUODrJ+qS/++VWfWGfEzi4Qw+R4ymzlX2kG/b5niY33X0yUqOiElG1sqm31Wiv7ice9Jts6317Cy/Ch6rLofu8Q6NhVq+tC6m8ZUF+TO4LENgzUnSyl+i3S0RH+0qSLENkNG7St5gKLkvIGzTpKva3duY0AJAvowVGdnxt2H07RhmizbgGJi89fGFOKjvTN2gvP2zpLxZZiaaJ+teSXLticQerLV8Ucm+xvtz76vv42r2s3T/kYo9kEffuR/DPWa3D/RPlZiUp6WqC7IbZTSPta2PfYJJJrv/vLPmoza1F9Bp0P9MMVt1+rKFAjPdVF5fkw6NIo5aiy++/PfYVwJ6TyCw3GBkgqPzWlEsHTIj1cB4CqNsGh7nQ7xb+87FYuIUNetL3oMiAfgp2uQ8RVgt7Y6UJxRcQY3M7qaznzbraYSczg/ubicVJK0oblLNd2yrUEmzySHOVNs2oJsSWZW3NaTonXMVR5LMcgkODHH3CdDnPGQhDaknTCtJkqKCRarQgbjEO6QMLYFKq4NEGbRFcrPA91ul3588gm8CAMAXDhmHHJ6ekKhBxGRDlhhwYxZhX3rSp3QnlGrHIwgFAK/yWg0ulatlwP4JXFoHvwq0tBA9N1f/wZX3+gljXlTVAT849aGNwepxnFd2N3iRk/7M5Rl/yIoZfvPzl76Q+0w+P+1dmDJk3GsJ5B/KtSvqY31unQ6saoDqoUwWpFpOx04GH1w1R8dEt/SaKepfDZI52SChTe1pAjmzLEtVxxrg3DMSjYWUtAZSs/fwTFzONVmBe/gLV1QUMgWTAHX8O5avet2u/4fkXY6z1PUdTrwDo5pnMQcqHrlsf/Nqb7q2xhTHCnum/DsJrc34Rs519dAnvNXlZAcDFYRUajvH/zQWBrsesyHJ2jwSy8DWYauJbShLFjVeFjc4gLlpEv56bd4kaLA0uOtGdQ2dq1xObUQLgwaE7oniUzPqrEUBWyKfzFjhsaTMrxMqSeFuvXpo3TiKoV19eVJ4vncsImDt9rc0k6BI0F6jXQeLE02YRY4rbDe5BOhmBQ2wjBEYRLfY60cK6LzfhfqhM+BKEwR3sNY61sKsalhc4/6MClXicnX/uQLPE7NlCnaq5FMKEuNcl2mnxsKx3Bc1p54i+OZ1reByXmc5qgcdakcAS6o4rRnOwshMg3opQJUvNRCucTOT4mRlzMCaTQsCl0lLIHOSAd0klDnSx58t5kaFPjf/fkfFl7jkupOOjA+obQheAdNcwMZ92DyWo1enFxC09wNBB/5HTefk49HAZQdE0xlnUE2p0aa+2gwyCvFmXINdmGBAsjgXC+Qe5adTmlw4q9ImGM00yq9BIOuMsTHIq11KFcBNY4ebRh2OnQ03FIY1jMtILMiXNIUWtlqjr2k9VlsMrpnRruAQxLmelGVpTbuWtF7GF1vdiTX2ShV7ZTnNEoH0G2pzW0A892McFyzKiNXghIDXyQ4Z3CtRmenF5fQ93AVJjOO4N//gtHZmx2L+8etBSkY+4NWs90m89mSqHZebO3nX1CNIJOOkn1OJxNyIFzE1KbUMlpeKwJFR9ex2dOByndW19kgoKrvAmI6IuTqexT1MbRHUwJk72hgEnTJFbFZ6lAi8hr3qwsOtQb+bqG+9k7yX4T4ONeSzgFqikaxWo4gjFs+vujyoaTCQjoFgqHREsnTYQpmhdHW+obAa0HZZXTl0IOwBhGIPsSzTV4ehKOHdqdiHxDiyuwcOFGmEXQSnHzoS5fvGWJTBRs30k03FU6GUCJG1PETn7rabIKY3lBxLvCIcSzS6eLJezPV5xErCQ4I7I6ZCplN500ixzuyWjw6gjSxxPvN3tWlJWBdx7pcwcHx8SEJJ0pBdfRaPQOFSzJ7UTTWjmlfGxKY1Gpq0y1Jff0xuqa2vFmnVa1rXgdDHo6NMAmlQ7D2Yj/e/Sdnnnh0jXFu0FLtoKpGQKxqZGxwuYDidQnF+y8wOnglbrHRISfxN6SBg3SnGLKkyXjBR4etm9ZaNPKXETz6vR7q/O1e7g+cUKXIslKQYW0AxUu3Ag99wsHo6mZ0+CXouXCeSzCt0yDUDE18uMl6qwV7tmBC+kw9afq/2Ie1nlBO0KRKN0S7PdhFaBH9efcRfWPdsNQjyCaH9w709eqTNwTz7yx+CEgYbZ+4v0djhfZF6ufwFStul8xwC8d6XjInfIe6IlJaTMHh0VQYJ8JuEQll6IBh8diH8eJx73E9oKQ2Id4Gu5m2SB8V2NBQUIdW+0NHHGCc7O65Kg1jg+HULGZMTSkRqEdoHdSCCj+vipALXl5iHb4NYBIqFW5E3AzNknolQiP4VmC8sUjj3Suhbn04dOGq7qDe4tgKh814slwudyx96Nd8XUkJqUf3CffAUBOWvRDum2oM51hqK5w2q2bVVLhZNfa+bK+t/4gMUi9dw3w/ZJjyLC/RzP090gWahSgeUL/viLx/eE3YzBbKtIkOGJygobpjN0ZBVoo4dl4lOYDE+yF6+CuU0FJ7uJJKX4C7frPNx8OOpMLpJOobIbf365vlmRQFKtvGv569OHsFi097R4Sp1NjdB/iy/+rl8cnrixMSJqZJNsge9456R/4iTVs3Z6q109a3edtIzH0D9P6vP+WLSCJ9QNIvJRMex4138gGDvcpagGC7MSRMaqatI5L7e8r/N0au1/T4T5UHya5u8mzBjCBJPVAb2y2+/6q3rfbBefouDj7ug8C9CiW8VBFY6s+XgPjd4mrry8Q1QWcRNCWJA8VxkKt7SXwaDjsYPKG+YcUz3/+9l7YNep+9uSRkMH5lOPcfLGaGLQk0ZMsgbCiMHg72z+4zydS0YlOiDSzX4buF2SZGfOsx4vgLKbXXHJvgcdCC/ied9i64vw/483pd04dX37si2jVRk29u1uv1fwBP8yqd",sidebar_class_name:"put api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},y=void 0,J={},T=[];function x(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(g.default,{as:"h1",className:"openapi__heading",children:"Update Template"}),"\n",(0,n.jsx)(o(),{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)(g.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,n.jsx)(f.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,n.jsx)(p(),{...i(9525)}),"\n",(0,n.jsx)(c(),{...i(93399)}),"\n",(0,n.jsx)(u(),{...i(46681)})]})}function F(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(x,{...e})}):x(e)}},9525(e){e.exports=JSON.parse('{"parameters":[{"name":"template_id","in":"path","description":"ID of the template that needs to be updated","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string"}}]}')},93399(e){e.exports=JSON.parse('{"title":"Body","body":{"description":"Provide below parameter to update templates (at least one parameter required)","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","format":"string","example":"sample template"},"note":{"type":"string","format":"string","example":"Please review and sign this document"},"description":{"type":"string","format":"string","example":"template description"},"folderId":{"type":"string","example":""},"enableOTP":{"type":"boolean","description":"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.","example":false},"enableTour":{"type":"boolean","description":"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.","example":false},"allow_modifications":{"type":"boolean","description":"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.","example":false},"send_in_order_strict":{"type":"boolean","description":"When set to \'true\', each signer is blocked from accessing the document until all preceding signers have completed their action. Enforces strict sequential signing. Only applies when \'sendInOrder\' is also \'true\'. Defaults to \'false\'.","example":false},"file":{"type":"string","description":"You may provide the base64 encoded PDF file to replace the existing one","format":"base64","example":""},"file_password":{"type":"string","format":"string","example":""},"redirect_url":{"type":"string","description":"Specifies the URL where the signer will be redirected upon completing the document signing process.","example":""},"auto_reminder":{"type":"boolean","description":"Set to true to enable automatic reminders. Set to false to disable them (default behavior).","example":false},"remind_once_in_every":{"type":"number","description":"Number of days between reminders. This is only applicable when auto_reminder is set to true.","example":5},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed.\\n"},"cc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"cc (carbon copy): Users added here will receive a notification email once the document is completed.\\n"}},"title":"template_template_id_body"}}}}}')},46681(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Template updated successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","example":"asd2HsP4Hp"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"title":"inline_response_200_3"}}}},"400":{"description":"Please provide valid field names!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","format":"string","example":"Please provide valid field names!"}},"title":"inline_response_400"}}}},"404":{"description":"Template not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","format":"string","example":"Template not found!"}},"title":"inline_response_404_7"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/98732f61.e5fa7be2.js b/assets/js/98732f61.e5fa7be2.js deleted file mode 100644 index 6953d1182..000000000 --- a/assets/js/98732f61.e5fa7be2.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[1065],{73407(e,t,s){s.r(t),s.d(t,{assets:()=>x,contentTitle:()=>j,default:()=>m,frontMatter:()=>G,metadata:()=>r,toc:()=>g});const r=JSON.parse('{"id":"API-docs/v1.2/getcredits","title":"Get your API credits","description":"The Get Credits API returns details about the credits available to your account:","source":"@site/docs/API-docs/v1.2/getcredits.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/getcredits","permalink":"/docs/API-docs/v1.2/getcredits","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getcredits","title":"Get your API credits","description":"The Get Credits API returns details about the credits available to your account:","sidebar_label":"Get your API credits","hide_title":true,"hide_table_of_contents":true,"api":"eJztWFtvI7cV/iunfGizg7Gk3SYtqrzUDQzXiJFd1F4sUNswKPKMhjGHZHjRBYKAPBT9Ae1TX/vT9pcUh3PRSHawCVrkpQEW3pnhuXznwnPRjkW+DGx+x94H9OyhZBKD8MpFZQ2bs9sa4RIjfOVRqhjg/N0VeIzJmwASI1c6AF/YFCHWCKKj4iuuNF9ohGhha5MHLoRNJs7vzb0pCqe5eeyI50UxSFdG6CRRwlrFumUMaTHgAeKbwG2NAcFjwAi8VRwi9xFsBchFDQbXsFBaK7MEsRUaJ/cG4GLDG6dxDldVK5qkgfN2pSQGeD2bDfgdemisiTVwI4kY0EiSkY0kiS3CL2bgseHKKLMsW6ELrrkRHbxA9pPgFiZJGJCSKIObOEJIruFS2hd945IXNQ8oIaDjnkfUW6i8beAGY1RmGeDj3/+RA3Rrn9Dktz+lLbzz2KjU9IImcC7lmTWDsdKCsRFw45THbDD3CNboLSRSZ8kcrnXrryHEHkFYE1KDctJGNdrI9Rg6JU9IDVl7HPOiyHpOrC0Kiq0K4NGR+wz5r6YcilwPikXyHk3U21GWVdYT1g6HR4Nrrh8lj9jDuBmnUUcARHBvWMmsQ8/p6EqyOVti7JSxknkMzpqAgc137M1sRv8dX5GbJASGUCUNgxxWMmFNRBOJnjunlcgH028DMe1YEDU2nJ7i1iGbM7v4FkVkJXOexETVqhy7bURtUrNAz0qGbVaz+WxfsiN3fpL6KF6fpB57dUQcoldmyUpWWd/wyOYsE4yY2ZvZm9+dzf5w9vr3t7PZPP+bzGazv7I9gVAxE3UwHj0Gtt/TyecvO3sUR0rbyiYj/3fuRu+tf8m8gzkvQ/hVRt3i/vw5bqquY+KfE/Cp7rHbldHK4GOf5Y8Evjfji+dmXJkV10oeqszPa8lYfWzVE9RNo4nP8KY1KRPlc3Zk6vh7a2RAkbyKWza/27HNGXfqrD2f3z3sH0rWYKxtVxMIMI81m7PpUYUI6FfoQxaRvGZzVsfownw6DdzIhd1MrEMT1NJovggTYZspd2q6ej15w/blKQ937ifRYzr7qSwh8qUyy0/xPRzcc0MhbKN05KQhVtypr3HLyj4GY6qSKUqdGrlEn+OlTGUzcxeZtw7NjVqaHNes/HQM+YBa2CaPE9QRiqJn+fi3fw9cRQHSitSgiTkDczt4S43ertFTfaamU2ncKGoaxIZNPgu5x0cLAXmjMQS9BWUiLqnNglRLRR2I/JRHCu74QmlFiUtk/YhzyP0wgQ81xho9Hf2G2ipIXKGmfAeeom04tewBL6ytf6q0XYcSOCxSUAZDADQ1N4II+0iUYD1wA2gieudVoNnHE2rVYrMmei4iNNzwJZLsEsbOkqgVpSt4u0ghQrA6ZchAw5z1KIeZzSDKkJ14sXF0BPRV2MZ5rCltVgjLRMNTCcJKhJDvKZlgJCwwRHCERQnMg1Ay2oqnHMAq0TxhqWwormlAGGMk9ui5CdRTWix9DAaHOW+p62Lomv77gBTha2WeaPa4N2dwN+TVB1wEFfHhs/4KrNfrZ6n/6pjnUsU/pwX8BZ0NKlq/PXAvVazTIl+XsZDhpZV0iQZz/owuw0GGtCI8v330dVqjdtN+qJuev7vKlfYVfPz+n3CN3Buo7brNVpE8jYHLXhV5ro1867ahUOYRiadYk8dFm3wev0sYYu/BDzWPH7//V4BvcA3KdFeKTCkKWgFusXGalPwajl6vVYhFMadJ2K5QQjIGKTTcb4EG1QYj5RtB6ydXCc5jpXQewXg7xZIf0I84JqT6nlVK46PjIaytl/fsQABc0qqg8kxKQGKHqITk5PGHjuJw3Wh6PxxLz6t4OG2h6ipjAm9TbBO42xWgR5Od6ryNKLJNsupBc63t+tFWVe6uJOZHIc+aT8CP9GepNOj6/IomD7+WbkdoH1uFQ6UifLFG5QdpPcDW24/eanwZWd6qMlGAtmHTLT121DO/ftLRzyJFBru00EqcGjyBcyHQkWNXXCcMcyiKFlFRwGcSK550fFVCUawUrukrPXNHUaK3Cdx0+BsqdDVfIe1hGnmIYDsv8Zg8LXNyifFLaAWNGYztDsOX0IsO0PBtJ89s+/NsKi3CfCSYrpjyuQxP8qZx0j6Pu5zHCj35Lof3cKmd6i7xXV8MgGrEf1NMaDCiXsFFnttoidVtH//jqZw8Q6FvwtvqBv1KCexmiR+oo9NMPGUl00qgCTiazc4v313D6reTGStHQ8mPKKnT66uvLr65uSAwFILWYa8ns8mMPjkbYsPNSBOVqKEEHoa1I4fvDqPrLz90/PJDx//BDx3duB5xE6dOc5UXpHwRd91yczf++eOhZLUNkb7udgse8L3X+z19/i6hp63poWQr7hWByztT2c/5tA094ZbufC7jjAh1apeFkyXxaNO6vLhlJaNR5Xi/eMr7RfdA0vsjsx3JPl48WgD0l7agFxl2u3Z32e8H+vboBzk6A3tq8uHDfr//D/mTjkI=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get your account details","permalink":"/docs/API-docs/v1.2/get-user"},"next":{"title":"Create Contact","permalink":"/docs/API-docs/v1.2/createcontact"}}');var i=s(74848),n=s(28453),a=s(57742),c=s.n(a),d=s(78178),o=s.n(d),l=s(19624),p=s.n(l),u=s(96226),h=s.n(u),f=(s(77675),s(19365),s(51107));s(21312);const G={id:"getcredits",title:"Get your API credits",description:"The Get Credits API returns details about the credits available to your account:",sidebar_label:"Get your API credits",hide_title:!0,hide_table_of_contents:!0,api:"eJztWFtvI7cV/iunfGizg7Gk3SYtqrzUDQzXiJFd1F4sUNswKPKMhjGHZHjRBYKAPBT9Ae1TX/vT9pcUh3PRSHawCVrkpQEW3pnhuXznwnPRjkW+DGx+x94H9OyhZBKD8MpFZQ2bs9sa4RIjfOVRqhjg/N0VeIzJmwASI1c6AF/YFCHWCKKj4iuuNF9ohGhha5MHLoRNJs7vzb0pCqe5eeyI50UxSFdG6CRRwlrFumUMaTHgAeKbwG2NAcFjwAi8VRwi9xFsBchFDQbXsFBaK7MEsRUaJ/cG4GLDG6dxDldVK5qkgfN2pSQGeD2bDfgdemisiTVwI4kY0EiSkY0kiS3CL2bgseHKKLMsW6ELrrkRHbxA9pPgFiZJGJCSKIObOEJIruFS2hd945IXNQ8oIaDjnkfUW6i8beAGY1RmGeDj3/+RA3Rrn9Dktz+lLbzz2KjU9IImcC7lmTWDsdKCsRFw45THbDD3CNboLSRSZ8kcrnXrryHEHkFYE1KDctJGNdrI9Rg6JU9IDVl7HPOiyHpOrC0Kiq0K4NGR+wz5r6YcilwPikXyHk3U21GWVdYT1g6HR4Nrrh8lj9jDuBmnUUcARHBvWMmsQ8/p6EqyOVti7JSxknkMzpqAgc137M1sRv8dX5GbJASGUCUNgxxWMmFNRBOJnjunlcgH028DMe1YEDU2nJ7i1iGbM7v4FkVkJXOexETVqhy7bURtUrNAz0qGbVaz+WxfsiN3fpL6KF6fpB57dUQcoldmyUpWWd/wyOYsE4yY2ZvZm9+dzf5w9vr3t7PZPP+bzGazv7I9gVAxE3UwHj0Gtt/TyecvO3sUR0rbyiYj/3fuRu+tf8m8gzkvQ/hVRt3i/vw5bqquY+KfE/Cp7rHbldHK4GOf5Y8Evjfji+dmXJkV10oeqszPa8lYfWzVE9RNo4nP8KY1KRPlc3Zk6vh7a2RAkbyKWza/27HNGXfqrD2f3z3sH0rWYKxtVxMIMI81m7PpUYUI6FfoQxaRvGZzVsfownw6DdzIhd1MrEMT1NJovggTYZspd2q6ej15w/blKQ937ifRYzr7qSwh8qUyy0/xPRzcc0MhbKN05KQhVtypr3HLyj4GY6qSKUqdGrlEn+OlTGUzcxeZtw7NjVqaHNes/HQM+YBa2CaPE9QRiqJn+fi3fw9cRQHSitSgiTkDczt4S43ertFTfaamU2ncKGoaxIZNPgu5x0cLAXmjMQS9BWUiLqnNglRLRR2I/JRHCu74QmlFiUtk/YhzyP0wgQ81xho9Hf2G2ipIXKGmfAeeom04tewBL6ytf6q0XYcSOCxSUAZDADQ1N4II+0iUYD1wA2gieudVoNnHE2rVYrMmei4iNNzwJZLsEsbOkqgVpSt4u0ghQrA6ZchAw5z1KIeZzSDKkJ14sXF0BPRV2MZ5rCltVgjLRMNTCcJKhJDvKZlgJCwwRHCERQnMg1Ay2oqnHMAq0TxhqWwormlAGGMk9ui5CdRTWix9DAaHOW+p62Lomv77gBTha2WeaPa4N2dwN+TVB1wEFfHhs/4KrNfrZ6n/6pjnUsU/pwX8BZ0NKlq/PXAvVazTIl+XsZDhpZV0iQZz/owuw0GGtCI8v330dVqjdtN+qJuev7vKlfYVfPz+n3CN3Buo7brNVpE8jYHLXhV5ro1867ahUOYRiadYk8dFm3wev0sYYu/BDzWPH7//V4BvcA3KdFeKTCkKWgFusXGalPwajl6vVYhFMadJ2K5QQjIGKTTcb4EG1QYj5RtB6ydXCc5jpXQewXg7xZIf0I84JqT6nlVK46PjIaytl/fsQABc0qqg8kxKQGKHqITk5PGHjuJw3Wh6PxxLz6t4OG2h6ipjAm9TbBO42xWgR5Od6ryNKLJNsupBc63t+tFWVe6uJOZHIc+aT8CP9GepNOj6/IomD7+WbkdoH1uFQ6UifLFG5QdpPcDW24/eanwZWd6qMlGAtmHTLT121DO/ftLRzyJFBru00EqcGjyBcyHQkWNXXCcMcyiKFlFRwGcSK550fFVCUawUrukrPXNHUaK3Cdx0+BsqdDVfIe1hGnmIYDsv8Zg8LXNyifFLaAWNGYztDsOX0IsO0PBtJ89s+/NsKi3CfCSYrpjyuQxP8qZx0j6Pu5zHCj35Lof3cKmd6i7xXV8MgGrEf1NMaDCiXsFFnttoidVtH//jqZw8Q6FvwtvqBv1KCexmiR+oo9NMPGUl00qgCTiazc4v313D6reTGStHQ8mPKKnT66uvLr65uSAwFILWYa8ns8mMPjkbYsPNSBOVqKEEHoa1I4fvDqPrLz90/PJDx//BDx3duB5xE6dOc5UXpHwRd91yczf++eOhZLUNkb7udgse8L3X+z19/i6hp63poWQr7hWByztT2c/5tA094ZbufC7jjAh1apeFkyXxaNO6vLhlJaNR5Xi/eMr7RfdA0vsjsx3JPl48WgD0l7agFxl2u3Z32e8H+vboBzk6A3tq8uHDfr//D/mTjkI=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},j=void 0,x={},g=[];function K(e){const t={p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(f.default,{as:"h1",className:"openapi__heading",children:"Get your API credits"}),"\n",(0,i.jsx)(c(),{method:"get",path:"/getcredits",context:"endpoint"}),"\n",(0,i.jsx)(t.p,{children:"The Get Credits API returns details about the credits available to your account:"}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"plan_credits:"})," Credits included with your subscription plan. These reset at the start of each new billing cycle.\nExample: If your plan provides 100 credits per month and you end\nthe cycle with 50 remaining, your balance resets to 100 at the\nstart of the next cycle."]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"addon_credits:"})," Credits purchased separately from Settings \u2192 API Token \u2192 Buy Premium Credits. Add-on credits do not expire and are only used once all plan credits are consumed."]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"total_credits:"})," The sum of ",(0,i.jsx)(t.strong,{children:"plan_credits"})," and ",(0,i.jsx)(t.strong,{children:"addon_credits"}),". This represents the total credits currently available for use."]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"renewal_date:"})," The Subscription renewal date"]}),"\n",(0,i.jsx)(o(),{parameters:void 0}),"\n",(0,i.jsx)(p(),{...s(6977)}),"\n",(0,i.jsx)(h(),{...s(85287)})]})}function m(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(K,{...e})}):K(e)}},6977(e){e.exports={title:"Body"}},85287(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"plan_credits":{"type":"number","example":0},"addon_credits":{"type":"number","example":0},"total_credits":{"type":"number","example":0},"renewal_date":{"type":"string","format":"date","example":"2026-09-17T00:00:00.000Z"}},"title":"credits_res"}}}},"400":{"description":"Subscription not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Subscription not found!"}}}}}},"404":{"description":"User not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"User not found!"}},"title":"inline_response_404"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/98732f61.e64405b6.js b/assets/js/98732f61.e64405b6.js new file mode 100644 index 000000000..6313a5515 --- /dev/null +++ b/assets/js/98732f61.e64405b6.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[1065],{73407(e,t,s){s.r(t),s.d(t,{assets:()=>v,contentTitle:()=>g,default:()=>N,frontMatter:()=>F,metadata:()=>r,toc:()=>w});const r=JSON.parse('{"id":"API-docs/v1.2/getcredits","title":"Get your API credits","description":"The Get Credits API returns details about the credits available to your account:","source":"@site/docs/API-docs/v1.2/getcredits.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/getcredits","permalink":"/docs/API-docs/v1.2/getcredits","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getcredits","title":"Get your API credits","description":"The Get Credits API returns details about the credits available to your account:","sidebar_label":"Get your API credits","hide_title":true,"hide_table_of_contents":true,"api":"eJztGdtuI7f1V065QLEWRhdvkxZVirSO19kY3WaNld0FahkezvBIw4hDTkiOZME2kIeiH1D0pa/9ib73U/ZLikPOjEa2k02QIi8NsF5b5OG533XLPF86Nr1kFw4tu0qYQJdbWXlpNJuy8wLhFXo4tiikd3B0dgoWfW21A4GeS+WAZ6b24AuEvIHiay4VzxSCN7A1tQWe56bWfjrXcz0YVIrr6wZ4Ohh02KXOVS1QwEb6Ij50ddbxA/RuBOcFOgSLDj3wSNh5bj2YBSDPC9C4gUwqJfUS8m2ucDTXACc3vKwUTuF0EVETNqisWUuBDg4nk47/Ci2URvsCuBYEDKgF4QhCEsbI4ccTsFhyqaVeJhFpxhXXecOeI/kJcWSTMHScEiqNN77HIamGC2Ge1E1V27zgDgU4rLjlHtUWFtaUMEPvpV46eP+3vwcDnZsV6vDps3oLZxZLWZctohEcCTE0uhNWGNDGA95U0mIQmFsEo9UWaiJnSByuVNRXZ2KLkBvt6hLFKFrVG89Vn3VyHleXJO2+zQeDQOeBtIMB2VY6sFiR+jTpryAf8lx1hPPaWtRebXtetjCWeG34sKhxw9W14B5bNmZ9N2oAgADmmiXMVGg5XZ0KNmVL9A0xljCLrjLaoWPTW/ZiMqFf+yEyq/McnVvUCjo8LGG50R61J3heVUrm4WL8laNHt8zlBZac/vLbCtmUmewrzD1LWGUJjZeRZF9tPWhdlxlaljCMXs2mk/uE7anzg9B79vogdF+rPWDnrdRLlrCFsSX3bMoCQO8xezF58evh5LfDw9+cTybT8G80mUz+wu6JCekDUMPGtUXH7u/p5qOnld2zI7ntwtRa/O/UjdYa+5R4O3GeZuEXgevI90eP+abs2gf+KRl+SLuvdqmV1Hjdevk1Md+K8fFjMU71mispdlnmp5WkT95H8sTqTanoneZlFCkAhXu2J2r/PArpMK+t9Fs2vbxlN0NeyWG8n15e3V8lrERfmCYnEMPcF2zKxnsZwqFdo3UBRW0Vm7LC+8pNx2PHtcjMzchUqJ1casUzN8pNOeaVHK8PRy/YffLwDa+qHwSP9fCHPnGeL6Vefujd1U49MzJhtNKekjpb8Ur+EbcsaW3Qh0qYJNcpkAu0wV5SL0x43FjmTYV6Jpc62DUQf9iGPIMW5v1f/9WBUbr/FAYDSvAkyNCZ2uYIL01eB3xcebSae7lGeP/NPyCrpfKhWghcoyLvcwl4WzuPArItoPZoKysdutFgQPj7dJdyjS60AxxyQz7pMaEOQtQ5MTq0yMUWcEga5b62SDXTU2YEX1hTLwvg4KReKkzg7cnsnIrG0dnpCGaoBQiT12Uoe8RihySBkmu+RPBYEj4MPPN8FUCoyXGe+5raJ7DIFXhZYhIree1NyT3G3gS1pxLfkgElFxi7GVIOlXjqaqiZW6MWxoIy+Woodairw+GQfj17Rv0g9Rswo1YGBZ2erNFuweLXNToPZe085NzabaTbhStxSBU97flHCtEzApE0Tee6dzmF3xGG3cGnDQzVeWpwLr8wG2qylqip9OIDglfPW6cXJnePvZ1OxwWqatw2UeOjs9OQ2Q6i/b80HhxZclOgDf1shkupfw8XDoMsg0ET5oB6La3RpNrBAJ6n3zsNpAeEt7LGG4qnzgp8scA8qFqRBwvu+QNTHBuLcMwrnkklKZHS+R0cc49LY7dwB+8K7oPL5lxTq3c313fD4TD8EOhg8LL1usEA7qhL5OTVDrVIoK5E+GRxbVaNTwkkv9+557A1+859G8znrb8GzJ/VUgmwWLs4GbSXsZWuLA4rxfPQ/IslevdJ4IE0YzSCsRQF20AWbUdihmoxpPgMJF61XuDoOID2o6rTa4MFpF5LH6oVLJTZtEjP6kzJHPbZnxXU8nKo4mUbekrqVQgfbVqsSjofYkFaFC3Ol5YvPLwzdkWUIka+xh53xvZ0wh0IeuGCyhdScyWjw5VAELbFe2y053ljvD/FPBEHp8hMHu8hM2ZFLra0vCy5lzlXatsi+dwogTbieGOXXBOtHWdSOymwS8Hw0pI7LuKjFsc7zApjVhHJW8yRYCgdDSkdAa4p42jj5aJpEBxEz7RgNpoGrMpI7Vt01LS0uLyVuMZ2hgwaieUXqJJQ20kWvNsPDXL899/808GXuKG80xaMZxQ2Cjkpp7VwS4OruU5fnZzDuLXEeCpFGijun5ONUyjIghmiBuct8pJ6KRG8waKoteDaA81qJXrSFDmQxdKsUTTzT2VxIVWYRDhIB9psmvH6iTmvsegO4WBApWFFbtiNKYDcSbQUNs14NmqlPuPObYwVwzNrPOZU8s5efg6zuqqM9XNN95DO2UIqvK4a4DlL26zdxnlmxJbSoYaNsYF6iGDUud1WDVY3avGGCXI61+nZm9k5jPOQX1o1pvCff0N6dvFI4+G496B1xvG0hbveBwvR0kI9unhAL1xQjiCVpq1+3iwWZECYNaFNoWWNmusZetILV8psrk2Euqanczal7gHhDhZcOUzBaPgWQYMPPSGpNzR6K5lLmmlRh+RIHYqMebKh1yUcag3ClqNF09l3Fv3jrVFUB6gpSptsmULsuYN/8TzHihILyRQBrq1RSJZeSFQCeG6Nc6EhCFKEmdnUHh0N6BYRCD76s2utPI2lh6hTsseCryUF98OC0/CUwuC5wAWvlT8IqSv0DE1TRZlBIXc+pP5dNxUrQ0wR6VrihvB02SZuC7ruhhRlkaDiMqNJ0k11gWDNNj+nvKJFUER3zHWMbKo3LTjekNaa0hG5aVJ8IHbXpRZuM6Ph2FRbeH58fEDMyUpSHp3ro7CaSucsz3fabsK+UyRwZfQyZFySB2+kCz1AOmdZ/53RnaxJ5wxJLBvB27oi2FlxHOt5Z8yTkksFXAiLjnIHZTUUFO8dj7bJ5JwauszoYU6S9fM4YMAS1kR7BpCuM6gYwWu5wp0MCbG/xw08d3VeUOGLUbKLeCnSg2ZP1+ghskb2smF3F7ZEbS5fc1VjEgpOzFKkWSVJsVRNAcvKb4Fby7fwPL28Sg8+AVPKuEiMqvUGpC7QNof7qB+0YEfdFupk1/81fVjvhGKCO4SLt6+f6MFmsUUM9e4H9I1dw9KNIPsYvnPC616fXMBbXD56/KHJMn1Ycf+M1kkTktQv4TOerzbcCgfHpqy4l6FD3RIoPSbnWNTUgmQt4DBvANvt6vowuPH6cHTYDShtm+BiSfSFcQjrSDgmpN1W0FDZkg6yVu8BqzaQWYxVMy+4XlIgUI/QK9SSEr+o8xgLgd+wEw3jKFdQa4XOgfEF2g31Str4Zg26U8eFQxrvXku9Cu4whMuug3qHmZMed+PJZrN5pOmD8ObzWiloe/QQcB8YauKzV9J/UWfwFivjpDd2u3u1lL6os2DL/tvuQ4Og7aW7Xc+PGaYCynO0paNt8AztWuYfEH/sCXx8EDa0D9YO+9sBiwu0lHfc3ijIK9mMnZctH0Ds/Rg5aKHUtNRhZ0WpL+4//vAQT9g9kQhvFo28zQ7mu+VlCVMyR+2wt9M6enX2Gta/Gk1Y0lvmfA9bjl+fHp98OTshZpowYVN2OJqMJnRUGedLrnuU6MuebobeLbn2FH67W/n9/AXRz18Q/R98QdSsOT3e+HGluAyL5RCIt81S+LL/tdFVwgrjPJ3e3lL5ubDq/p6Ov67R0rb5KmFrbiUxF3bNSbsfpS3yCrcU86FPZwSo6rhkfbBc39tQvzo5ZwnjNTHT38uuwl62+YOwt1d628O9v7CNDND/tD1+8sHtbdz53t938PHqW180ArbQpMOr+/v7/wJFwdXJ","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get your account details","permalink":"/docs/API-docs/v1.2/get-user"},"next":{"title":"Create Contact","permalink":"/docs/API-docs/v1.2/createcontact"}}');var a=s(74848),n=s(28453),i=s(57742),o=s.n(i),c=s(78178),d=s.n(c),p=s(19624),u=s.n(p),l=s(96226),h=s.n(l),b=(s(77675),s(19365),s(51107));s(21312);const F={id:"getcredits",title:"Get your API credits",description:"The Get Credits API returns details about the credits available to your account:",sidebar_label:"Get your API credits",hide_title:!0,hide_table_of_contents:!0,api:"eJztGdtuI7f1V065QLEWRhdvkxZVirSO19kY3WaNld0FahkezvBIw4hDTkiOZME2kIeiH1D0pa/9ib73U/ZLikPOjEa2k02QIi8NsF5b5OG533XLPF86Nr1kFw4tu0qYQJdbWXlpNJuy8wLhFXo4tiikd3B0dgoWfW21A4GeS+WAZ6b24AuEvIHiay4VzxSCN7A1tQWe56bWfjrXcz0YVIrr6wZ4Ohh02KXOVS1QwEb6Ij50ddbxA/RuBOcFOgSLDj3wSNh5bj2YBSDPC9C4gUwqJfUS8m2ucDTXACc3vKwUTuF0EVETNqisWUuBDg4nk47/Ci2URvsCuBYEDKgF4QhCEsbI4ccTsFhyqaVeJhFpxhXXecOeI/kJcWSTMHScEiqNN77HIamGC2Ge1E1V27zgDgU4rLjlHtUWFtaUMEPvpV46eP+3vwcDnZsV6vDps3oLZxZLWZctohEcCTE0uhNWGNDGA95U0mIQmFsEo9UWaiJnSByuVNRXZ2KLkBvt6hLFKFrVG89Vn3VyHleXJO2+zQeDQOeBtIMB2VY6sFiR+jTpryAf8lx1hPPaWtRebXtetjCWeG34sKhxw9W14B5bNmZ9N2oAgADmmiXMVGg5XZ0KNmVL9A0xljCLrjLaoWPTW/ZiMqFf+yEyq/McnVvUCjo8LGG50R61J3heVUrm4WL8laNHt8zlBZac/vLbCtmUmewrzD1LWGUJjZeRZF9tPWhdlxlaljCMXs2mk/uE7anzg9B79vogdF+rPWDnrdRLlrCFsSX3bMoCQO8xezF58evh5LfDw9+cTybT8G80mUz+wu6JCekDUMPGtUXH7u/p5qOnld2zI7ntwtRa/O/UjdYa+5R4O3GeZuEXgevI90eP+abs2gf+KRl+SLuvdqmV1Hjdevk1Md+K8fFjMU71mispdlnmp5WkT95H8sTqTanoneZlFCkAhXu2J2r/PArpMK+t9Fs2vbxlN0NeyWG8n15e3V8lrERfmCYnEMPcF2zKxnsZwqFdo3UBRW0Vm7LC+8pNx2PHtcjMzchUqJ1casUzN8pNOeaVHK8PRy/YffLwDa+qHwSP9fCHPnGeL6Vefujd1U49MzJhtNKekjpb8Ur+EbcsaW3Qh0qYJNcpkAu0wV5SL0x43FjmTYV6Jpc62DUQf9iGPIMW5v1f/9WBUbr/FAYDSvAkyNCZ2uYIL01eB3xcebSae7lGeP/NPyCrpfKhWghcoyLvcwl4WzuPArItoPZoKysdutFgQPj7dJdyjS60AxxyQz7pMaEOQtQ5MTq0yMUWcEga5b62SDXTU2YEX1hTLwvg4KReKkzg7cnsnIrG0dnpCGaoBQiT12Uoe8RihySBkmu+RPBYEj4MPPN8FUCoyXGe+5raJ7DIFXhZYhIree1NyT3G3gS1pxLfkgElFxi7GVIOlXjqaqiZW6MWxoIy+Woodairw+GQfj17Rv0g9Rswo1YGBZ2erNFuweLXNToPZe085NzabaTbhStxSBU97flHCtEzApE0Tee6dzmF3xGG3cGnDQzVeWpwLr8wG2qylqip9OIDglfPW6cXJnePvZ1OxwWqatw2UeOjs9OQ2Q6i/b80HhxZclOgDf1shkupfw8XDoMsg0ET5oB6La3RpNrBAJ6n3zsNpAeEt7LGG4qnzgp8scA8qFqRBwvu+QNTHBuLcMwrnkklKZHS+R0cc49LY7dwB+8K7oPL5lxTq3c313fD4TD8EOhg8LL1usEA7qhL5OTVDrVIoK5E+GRxbVaNTwkkv9+557A1+859G8znrb8GzJ/VUgmwWLs4GbSXsZWuLA4rxfPQ/IslevdJ4IE0YzSCsRQF20AWbUdihmoxpPgMJF61XuDoOID2o6rTa4MFpF5LH6oVLJTZtEjP6kzJHPbZnxXU8nKo4mUbekrqVQgfbVqsSjofYkFaFC3Ol5YvPLwzdkWUIka+xh53xvZ0wh0IeuGCyhdScyWjw5VAELbFe2y053ljvD/FPBEHp8hMHu8hM2ZFLra0vCy5lzlXatsi+dwogTbieGOXXBOtHWdSOymwS8Hw0pI7LuKjFsc7zApjVhHJW8yRYCgdDSkdAa4p42jj5aJpEBxEz7RgNpoGrMpI7Vt01LS0uLyVuMZ2hgwaieUXqJJQ20kWvNsPDXL899/808GXuKG80xaMZxQ2Cjkpp7VwS4OruU5fnZzDuLXEeCpFGijun5ONUyjIghmiBuct8pJ6KRG8waKoteDaA81qJXrSFDmQxdKsUTTzT2VxIVWYRDhIB9psmvH6iTmvsegO4WBApWFFbtiNKYDcSbQUNs14NmqlPuPObYwVwzNrPOZU8s5efg6zuqqM9XNN95DO2UIqvK4a4DlL26zdxnlmxJbSoYaNsYF6iGDUud1WDVY3avGGCXI61+nZm9k5jPOQX1o1pvCff0N6dvFI4+G496B1xvG0hbveBwvR0kI9unhAL1xQjiCVpq1+3iwWZECYNaFNoWWNmusZetILV8psrk2Euqanczal7gHhDhZcOUzBaPgWQYMPPSGpNzR6K5lLmmlRh+RIHYqMebKh1yUcag3ClqNF09l3Fv3jrVFUB6gpSptsmULsuYN/8TzHihILyRQBrq1RSJZeSFQCeG6Nc6EhCFKEmdnUHh0N6BYRCD76s2utPI2lh6hTsseCryUF98OC0/CUwuC5wAWvlT8IqSv0DE1TRZlBIXc+pP5dNxUrQ0wR6VrihvB02SZuC7ruhhRlkaDiMqNJ0k11gWDNNj+nvKJFUER3zHWMbKo3LTjekNaa0hG5aVJ8IHbXpRZuM6Ph2FRbeH58fEDMyUpSHp3ro7CaSucsz3fabsK+UyRwZfQyZFySB2+kCz1AOmdZ/53RnaxJ5wxJLBvB27oi2FlxHOt5Z8yTkksFXAiLjnIHZTUUFO8dj7bJ5JwauszoYU6S9fM4YMAS1kR7BpCuM6gYwWu5wp0MCbG/xw08d3VeUOGLUbKLeCnSg2ZP1+ghskb2smF3F7ZEbS5fc1VjEgpOzFKkWSVJsVRNAcvKb4Fby7fwPL28Sg8+AVPKuEiMqvUGpC7QNof7qB+0YEfdFupk1/81fVjvhGKCO4SLt6+f6MFmsUUM9e4H9I1dw9KNIPsYvnPC616fXMBbXD56/KHJMn1Ycf+M1kkTktQv4TOerzbcCgfHpqy4l6FD3RIoPSbnWNTUgmQt4DBvANvt6vowuPH6cHTYDShtm+BiSfSFcQjrSDgmpN1W0FDZkg6yVu8BqzaQWYxVMy+4XlIgUI/QK9SSEr+o8xgLgd+wEw3jKFdQa4XOgfEF2g31Str4Zg26U8eFQxrvXku9Cu4whMuug3qHmZMed+PJZrN5pOmD8ObzWiloe/QQcB8YauKzV9J/UWfwFivjpDd2u3u1lL6os2DL/tvuQ4Og7aW7Xc+PGaYCynO0paNt8AztWuYfEH/sCXx8EDa0D9YO+9sBiwu0lHfc3ijIK9mMnZctH0Ds/Rg5aKHUtNRhZ0WpL+4//vAQT9g9kQhvFo28zQ7mu+VlCVMyR+2wt9M6enX2Gta/Gk1Y0lvmfA9bjl+fHp98OTshZpowYVN2OJqMJnRUGedLrnuU6MuebobeLbn2FH67W/n9/AXRz18Q/R98QdSsOT3e+HGluAyL5RCIt81S+LL/tdFVwgrjPJ3e3lL5ubDq/p6Ov67R0rb5KmFrbiUxF3bNSbsfpS3yCrcU86FPZwSo6rhkfbBc39tQvzo5ZwnjNTHT38uuwl62+YOwt1d628O9v7CNDND/tD1+8sHtbdz53t938PHqW180ArbQpMOr+/v7/wJFwdXJ",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},g=void 0,v={},w=[];function U(e){const t={p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(b.default,{as:"h1",className:"openapi__heading",children:"Get your API credits"}),"\n",(0,a.jsx)(o(),{method:"get",path:"/getcredits",context:"endpoint"}),"\n",(0,a.jsx)(t.p,{children:"The Get Credits API returns details about the credits available to your account:"}),"\n",(0,a.jsxs)(t.p,{children:[(0,a.jsx)(t.strong,{children:"plan_credits:"})," Credits included with your subscription plan. These reset at the start of each new billing cycle.\nExample: If your plan provides 100 credits per month and you end\nthe cycle with 50 remaining, your balance resets to 100 at the\nstart of the next cycle."]}),"\n",(0,a.jsxs)(t.p,{children:[(0,a.jsx)(t.strong,{children:"addon_credits:"})," Credits purchased separately from Settings \u2192 API Token \u2192 Buy Premium Credits. Add-on credits do not expire and are only used once all plan credits are consumed."]}),"\n",(0,a.jsxs)(t.p,{children:[(0,a.jsx)(t.strong,{children:"total_credits:"})," The sum of ",(0,a.jsx)(t.strong,{children:"plan_credits"})," and ",(0,a.jsx)(t.strong,{children:"addon_credits"}),". This represents the total credits currently available for use."]}),"\n",(0,a.jsxs)(t.p,{children:[(0,a.jsx)(t.strong,{children:"renewal_date:"})," The Subscription renewal date"]}),"\n",(0,a.jsx)(d(),{parameters:void 0}),"\n",(0,a.jsx)(u(),{...s(6977)}),"\n",(0,a.jsx)(h(),{...s(85287)})]})}function N(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(U,{...e})}):U(e)}},6977(e){e.exports={title:"Body"}},85287(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"plan_credits":{"type":"number","example":0},"addon_credits":{"type":"number","example":0},"total_credits":{"type":"number","example":0},"renewal_date":{"type":"string","format":"date","example":"2026-09-17T00:00:00.000Z"}},"title":"credits_res"}}}},"400":{"description":"Subscription not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Subscription not found!"}}}}}},"404":{"description":"User not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"User not found!"}},"title":"inline_response_404"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/a3b21423.31961bd6.js b/assets/js/a3b21423.31961bd6.js new file mode 100644 index 000000000..755ce4653 --- /dev/null +++ b/assets/js/a3b21423.31961bd6.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[7533],{35063(e,t,o){o.r(t),o.d(t,{assets:()=>b,contentTitle:()=>P,default:()=>g,frontMatter:()=>h,metadata:()=>n,toc:()=>k});const n=JSON.parse('{"id":"API-docs/v1.2/revokedocument","title":"Revoke Document","description":"The Revoke document API allows you to revoke specific document from your documents.","source":"@site/docs/API-docs/v1.2/revokedocument.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/revokedocument","permalink":"/docs/API-docs/v1.2/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":"eJy9WV9vG7kR/ypTBihsYSXZSe6K6oprE8eXCy69GJbdALUMi1qOtDxzyT2Su7JgC7iHoh+g6Etf+yX63o+ST1IMubtayT7ngrveQ/6IOxzO398Mh7fM84Vjowv2yqRljto7dpkwgS61svDSaDZiZxnCKVbmGkHUVPDi5A1wpczSwcqU4A3YSOEKTOVcphvSuTU5Edl2yQ1YwkyBltMJbwQbsbi7IWAJK7jlOXq0JN0t0zxHNmINwZUULGGSpCu4z9iuyCfWVFIgmNl3mPo3Asx8I1ArLEuYxe9LaVGwkbclJsz5laKDnMwLRQR4UygjkI3mXDkiSDPMORvdMr8qAqW3Ui9YwubG5tx3V/CGBy4jVmRPZ9lT7gRbry/jqej8SyNWxCk12pPWo1vGi0LJNNhl+J0jXW7vHxm1IiNZsqKX6OirRV7v2BVtIwhbrxPmpQ8/doy+XtNHi64w2kWWTw8O6J9t4zahUltRgCvTFJ2bl0qtfsOSX0qfxnmPa/TyhgxbfF08Y0H6INIL//impwdPn/UPD/oHvzs7/Hz0/Pejzz4fHBwc/JUl7CZXtLcJOO6RdUwWf693yep4umfb2qbPHzLj2OToM6kXsCRjLq3RiwQKhdwheLsCvuBSg+Ie7S9oVbTW2Met82mSdSNKaiU1XjUxdPX84ODqsDXC80diSRsPc1Nq8euq+tD5jyv0/OpZq9Bn9xV6oyuupAgAeWauUf+6+nSP9/H4+9EqI1H4zraU7a5HJR2mpZV+FVD4ps8L2Y/fRxeXBGUUKYYQvDAu4rbP2IgNG1QZ3nYwe82Ioa0aVC+tYiOWeV+40XDouBYzczMwBWonF1rxmRukJh/yQg6rw8FTtk529/Ci+CR6LPufusV5vpB68bF9lxtbjcmf0WVbFmsdxwv5Da5Y0jikS1WXtQy5QBucR2FyuqkYx42zN4jPyItSz004o/bmuwL1WC50iIUg426VfAINzYe//bslm+iJ/hJ6PSr7pG/fmdKmCJQqgR9XHq3mXlYIH374J8xKqSh5LAisUFHEugS8LZ1HAbMVoPZoCysdukGvR/y75y5khbGL4JAaUs1jAoU1okxJ0L5FLlaAfTI896VFKBT3VG7BZ9aUiww4OKkXChM4PR6fzUtF2gxgjFpsuo4gYsskgZxrvkDwmBM/DDLz9DqQEPg5z33pQGqwyBV4mWMCXAvgpTc59xi7GtRe2k5rpOQc01WqonG4UrCUPjOlhwq1MBaUSa/7Ug/IEP1+n/558gReo/d06thz61HQ6nGFdgV1swB56Tyk3NpVPLdNcZLQZwjTThhNIQZQOGQ6nU505+MI/kAcNgtf1jQT3et9+Ps/4OJrs6Q2aYGamjTcOfByr8kNYVJ3PylodZihKobjqJQbvjh5E9BwP/r/W+PBkSeXGVqko2a4kPqPcE4VJkPo9Wo0ANSVtEaTaXs92Jv+ZLSY7hPfwhpvKO1aL/D5HNNgakURLLjnO644MhbhiBd8JpUk8KX1OzjiHhfGruAO3mfch5BNuQZh4G6i7/r9fvhDpL1e20/3enAHRxY5RbVDLRIoCxF+xR4hxpRAivtNePYbt2/Ct+Z81sRr4PyylEqAxdLxmeoEc1AXCov9QvEUBSylWKB3XwQZyDJGIxhLWbAKx6JtjxijmvcpP8MRr5socLQcSLtZ1dq15gJSV9KHCgdzZZYN05NypmQK2+KPM24ROBTxY5N6SurrkD7aNFyVdB6adr3h+cryuYf3xl7TSZEjr7AjnbEdm3AHgna4YPK51FzJGHB57GYavkdGe57WzvtzxImQA7UwafwOM2OuKcQWluc59zLlSq0aJl8ZJdBGHu/sgms6ayOZ1I6uKC1Mv7IUjvO4qeHxHmeZMdeRySmmSDQER32CI8Cq7l3oyhVM7iBGpgWz1IBaFEZq37A7d41Ap+itxAqBp6kptQ8WSS0K6YEqCd1lyIN326lBgf/hh385+BaXhDtNwXhCaaOQk3EaDzdncDXR09fHZzBsPDEcSTENJ26vk4+nkJEHZ4ganLfIc+rARIgGi6LUgmsPm+shUABZzE2FIrDs9QqLc6lUSG2QDrRZgkVfWuLjkPZ6VKt4M609umHY61FpuKYwbO9CgNxJtJQ2qdGuzHHQaH3CnVsaK/on1nhMqeSdvPoKxmVRGOsnmr7DdMLmUuFVURNP2LRB7SbPZ0asCA41LI0Np4cMRp3aVVFzdYOGLwowejTR05N34zMYpgFfGjNO4b//genJ+T2Lh+XOhrZJGzV0V9tkIVsaqnsfds4LHwgjyKTTxj7v5nNyIIzr1KbUskZN9Bg92SVMEa5MpLqirRM2ou4B4Q7CpXsKRsOPKBpi6AFNvQG6uctUekUNSABH6lBkxMn6vBZwqDVAnmYtWLT+Hcf4ODWK6gA1RdMaLaf1eCHEF09TLAhYSKdIcGWNQvL0XKISwFNrnAsNQdCCssua0qMbwFlmEYHoYzy7xsujWHrodAJ7zHglKbl3C04t0xR6ewLnvFR+P0BX6BnqpoqQge5wPkD/ppuKlSFCxLSSuCQ+Ldq4EKWbaY6xVLckLsFotWpAuq4ucSbU4POUF4U1VWR3xHXMbKo3DTnekNXq0hGlqSE+HHbXQgu3M6PhyBQr2Ds62ifhZCEJRyf6BWhcktnTdGPtOu1bQwJXRi8C4pI+eCNd6AGmEzbr7jO61TVpgyGJZSNEW1sEWy8OYz1vnXmcc6mAC2HREXYQqqGgfG9ltDWSc2roZkb3U9Ksi+OAgYvRKW47QLrWoWIAb+U1bnRISPwtaWDPlWlGhS9mySbjpZjuU+mqpKjtEEUjf1kpar83FoCKqxKTUHAiSpFllSTDUjUFzAu/Am4tX8He9OJyuv8FmFz6wCWa1huQOkNbL26z3mnBXlRcqpCpx5v+r+7DOiuUEzSUOD99+0APNo4tYqh3n9A3tg1LewXZ5vDoRbDdfXwOp7i4t/ljF9DpbsX9C1onTQCp38JLnl4vuRUOjkxecC9Dh7oiUtpMwRGmcDBrCPtpTahiBwzVYQjj6nBw2F5QmjbBxZLoM+MQqnhwBCTe+sNQ2ZIOZo3dA1dtYGYxVs0043pBiUA9QqdQSwJ+UaYxF4K8xNqE6yhXUGqFzoHxGdol9UraUIxvm+PcIV3v3kp9HcKhDxdtB/UeZ0563FxPlsvlPUvvhz1flUpB06OHhPvIpSZuey391+UMTrEwTnpjV5tdC+mzchZ82d3b/qgZNL10Ox/6OZepwPIMbe5owD1GW8n0I+oPPZEP9yc0adiZTmxPByzOMczs3dZVkBeyvnZeNHIAifdz9KDxRd1ShzkXQV8ck/xpl0+YV5EK7+a1vvWo5nF9WcKUTFE77MzBXrw+eQvVs8EBSzozn5/gy+HbN0fH346PSZg6TdiIHQ4OBge0RKOwnOvOSfXzyavN+8aWrTtPAP+n15Z68OTxxg8LxWWY+wWdb+uR3QXrvL6Mug8tlwnLaLg3umC3t5T251at17T8fYmWJoOXCau4lYQPYa5Xd1mifTX5UW33Tusb3T785DebB3VpJmuaxmqhotBYLGHXuNp5N1pfrpNmvEbCRoqjKFL/jPhsONwb19J8MO54ETq+R2m781HqX1nCZvWbTx4elZjlS3qF4ssobcTC+JpDa7dMcb0o+YJoI0+aCPKSPNYdJ16HcWL9H9LqQXtszxmjGvQ3KfXghtvbOKpcr1v6+OlHd9SGbajJOZfr9fp/ZfMNjw==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Update Document","permalink":"/docs/API-docs/v1.2/update-document"},"next":{"title":"Delete Document","permalink":"/docs/API-docs/v1.2/deletedocument"}}');var s=o(74848),a=o(28453),p=o(57742),i=o.n(p),d=o(78178),c=o.n(d),r=o(19624),m=o.n(r),u=o(96226),l=o.n(u),v=(o(77675),o(19365),o(51107)),x=o(21312);const h={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:"eJy9WV9vG7kR/ypTBihsYSXZSe6K6oprE8eXCy69GJbdALUMi1qOtDxzyT2Su7JgC7iHoh+g6Etf+yX63o+ST1IMubtayT7ngrveQ/6IOxzO398Mh7fM84Vjowv2yqRljto7dpkwgS61svDSaDZiZxnCKVbmGkHUVPDi5A1wpczSwcqU4A3YSOEKTOVcphvSuTU5Edl2yQ1YwkyBltMJbwQbsbi7IWAJK7jlOXq0JN0t0zxHNmINwZUULGGSpCu4z9iuyCfWVFIgmNl3mPo3Asx8I1ArLEuYxe9LaVGwkbclJsz5laKDnMwLRQR4UygjkI3mXDkiSDPMORvdMr8qAqW3Ui9YwubG5tx3V/CGBy4jVmRPZ9lT7gRbry/jqej8SyNWxCk12pPWo1vGi0LJNNhl+J0jXW7vHxm1IiNZsqKX6OirRV7v2BVtIwhbrxPmpQ8/doy+XtNHi64w2kWWTw8O6J9t4zahUltRgCvTFJ2bl0qtfsOSX0qfxnmPa/TyhgxbfF08Y0H6INIL//impwdPn/UPD/oHvzs7/Hz0/Pejzz4fHBwc/JUl7CZXtLcJOO6RdUwWf693yep4umfb2qbPHzLj2OToM6kXsCRjLq3RiwQKhdwheLsCvuBSg+Ie7S9oVbTW2Met82mSdSNKaiU1XjUxdPX84ODqsDXC80diSRsPc1Nq8euq+tD5jyv0/OpZq9Bn9xV6oyuupAgAeWauUf+6+nSP9/H4+9EqI1H4zraU7a5HJR2mpZV+FVD4ps8L2Y/fRxeXBGUUKYYQvDAu4rbP2IgNG1QZ3nYwe82Ioa0aVC+tYiOWeV+40XDouBYzczMwBWonF1rxmRukJh/yQg6rw8FTtk529/Ci+CR6LPufusV5vpB68bF9lxtbjcmf0WVbFmsdxwv5Da5Y0jikS1WXtQy5QBucR2FyuqkYx42zN4jPyItSz004o/bmuwL1WC50iIUg426VfAINzYe//bslm+iJ/hJ6PSr7pG/fmdKmCJQqgR9XHq3mXlYIH374J8xKqSh5LAisUFHEugS8LZ1HAbMVoPZoCysdukGvR/y75y5khbGL4JAaUs1jAoU1okxJ0L5FLlaAfTI896VFKBT3VG7BZ9aUiww4OKkXChM4PR6fzUtF2gxgjFpsuo4gYsskgZxrvkDwmBM/DDLz9DqQEPg5z33pQGqwyBV4mWMCXAvgpTc59xi7GtRe2k5rpOQc01WqonG4UrCUPjOlhwq1MBaUSa/7Ug/IEP1+n/558gReo/d06thz61HQ6nGFdgV1swB56Tyk3NpVPLdNcZLQZwjTThhNIQZQOGQ6nU505+MI/kAcNgtf1jQT3et9+Ps/4OJrs6Q2aYGamjTcOfByr8kNYVJ3PylodZihKobjqJQbvjh5E9BwP/r/W+PBkSeXGVqko2a4kPqPcE4VJkPo9Wo0ANSVtEaTaXs92Jv+ZLSY7hPfwhpvKO1aL/D5HNNgakURLLjnO644MhbhiBd8JpUk8KX1OzjiHhfGruAO3mfch5BNuQZh4G6i7/r9fvhDpL1e20/3enAHRxY5RbVDLRIoCxF+xR4hxpRAivtNePYbt2/Ct+Z81sRr4PyylEqAxdLxmeoEc1AXCov9QvEUBSylWKB3XwQZyDJGIxhLWbAKx6JtjxijmvcpP8MRr5socLQcSLtZ1dq15gJSV9KHCgdzZZYN05NypmQK2+KPM24ROBTxY5N6SurrkD7aNFyVdB6adr3h+cryuYf3xl7TSZEjr7AjnbEdm3AHgna4YPK51FzJGHB57GYavkdGe57WzvtzxImQA7UwafwOM2OuKcQWluc59zLlSq0aJl8ZJdBGHu/sgms6ayOZ1I6uKC1Mv7IUjvO4qeHxHmeZMdeRySmmSDQER32CI8Cq7l3oyhVM7iBGpgWz1IBaFEZq37A7d41Ap+itxAqBp6kptQ8WSS0K6YEqCd1lyIN326lBgf/hh385+BaXhDtNwXhCaaOQk3EaDzdncDXR09fHZzBsPDEcSTENJ26vk4+nkJEHZ4ganLfIc+rARIgGi6LUgmsPm+shUABZzE2FIrDs9QqLc6lUSG2QDrRZgkVfWuLjkPZ6VKt4M609umHY61FpuKYwbO9CgNxJtJQ2qdGuzHHQaH3CnVsaK/on1nhMqeSdvPoKxmVRGOsnmr7DdMLmUuFVURNP2LRB7SbPZ0asCA41LI0Np4cMRp3aVVFzdYOGLwowejTR05N34zMYpgFfGjNO4b//genJ+T2Lh+XOhrZJGzV0V9tkIVsaqnsfds4LHwgjyKTTxj7v5nNyIIzr1KbUskZN9Bg92SVMEa5MpLqirRM2ou4B4Q7CpXsKRsOPKBpi6AFNvQG6uctUekUNSABH6lBkxMn6vBZwqDVAnmYtWLT+Hcf4ODWK6gA1RdMaLaf1eCHEF09TLAhYSKdIcGWNQvL0XKISwFNrnAsNQdCCssua0qMbwFlmEYHoYzy7xsujWHrodAJ7zHglKbl3C04t0xR6ewLnvFR+P0BX6BnqpoqQge5wPkD/ppuKlSFCxLSSuCQ+Ldq4EKWbaY6xVLckLsFotWpAuq4ucSbU4POUF4U1VWR3xHXMbKo3DTnekNXq0hGlqSE+HHbXQgu3M6PhyBQr2Ds62ifhZCEJRyf6BWhcktnTdGPtOu1bQwJXRi8C4pI+eCNd6AGmEzbr7jO61TVpgyGJZSNEW1sEWy8OYz1vnXmcc6mAC2HREXYQqqGgfG9ltDWSc2roZkb3U9Ksi+OAgYvRKW47QLrWoWIAb+U1bnRISPwtaWDPlWlGhS9mySbjpZjuU+mqpKjtEEUjf1kpar83FoCKqxKTUHAiSpFllSTDUjUFzAu/Am4tX8He9OJyuv8FmFz6wCWa1huQOkNbL26z3mnBXlRcqpCpx5v+r+7DOiuUEzSUOD99+0APNo4tYqh3n9A3tg1LewXZ5vDoRbDdfXwOp7i4t/ljF9DpbsX9C1onTQCp38JLnl4vuRUOjkxecC9Dh7oiUtpMwRGmcDBrCPtpTahiBwzVYQjj6nBw2F5QmjbBxZLoM+MQqnhwBCTe+sNQ2ZIOZo3dA1dtYGYxVs0043pBiUA9QqdQSwJ+UaYxF4K8xNqE6yhXUGqFzoHxGdol9UraUIxvm+PcIV3v3kp9HcKhDxdtB/UeZ0563FxPlsvlPUvvhz1flUpB06OHhPvIpSZuey391+UMTrEwTnpjV5tdC+mzchZ82d3b/qgZNL10Ox/6OZepwPIMbe5owD1GW8n0I+oPPZEP9yc0adiZTmxPByzOMczs3dZVkBeyvnZeNHIAifdz9KDxRd1ShzkXQV8ck/xpl0+YV5EK7+a1vvWo5nF9WcKUTFE77MzBXrw+eQvVs8EBSzozn5/gy+HbN0fH346PSZg6TdiIHQ4OBge0RKOwnOvOSfXzyavN+8aWrTtPAP+n15Z68OTxxg8LxWWY+wWdb+uR3QXrvL6Mug8tlwnLaLg3umC3t5T251at17T8fYmWJoOXCau4lYQPYa5Xd1mifTX5UW33Tusb3T785DebB3VpJmuaxmqhotBYLGHXuNp5N1pfrpNmvEbCRoqjKFL/jPhsONwb19J8MO54ETq+R2m781HqX1nCZvWbTx4elZjlS3qF4ssobcTC+JpDa7dMcb0o+YJoI0+aCPKSPNYdJ16HcWL9H9LqQXtszxmjGvQ3KfXghtvbOKpcr1v6+OlHd9SGbajJOZfr9fp/ZfMNjw==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},P=void 0,b={},k=[];function S(e){const t={p:"p",...(0,a.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(v.default,{as:"h1",className:"openapi__heading",children:"Revoke Document"}),"\n",(0,s.jsx)(i(),{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)(v.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(x.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(c(),{...o(70510)}),"\n",(0,s.jsx)(m(),{...o(56252)}),"\n",(0,s.jsx)(l(),{...o(43654)})]})}function g(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(S,{...e})}):S(e)}},70510(e){e.exports=JSON.parse('{"parameters":[{"name":"document_id","in":"path","description":"Provide objectId of document to revoke","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"ph2bh2asd"}}]}')},56252(e){e.exports=JSON.parse('{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string","example":""}},"title":"revokedocument"}}}}}')},43654(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Document revoked successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","example":"Bxh2aspHp3"},"revokedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"xml":{"name":"revoke"},"title":"revoke"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"Document not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Document not found!"}},"title":"inline_response_404_3"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/a3b21423.8290bb4e.js b/assets/js/a3b21423.8290bb4e.js deleted file mode 100644 index 58fd77745..000000000 --- a/assets/js/a3b21423.8290bb4e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[7533],{35063(e,t,o){o.r(t),o.d(t,{assets:()=>j,contentTitle:()=>y,default:()=>v,frontMatter:()=>k,metadata:()=>n,toc:()=>q});const n=JSON.parse('{"id":"API-docs/v1.2/revokedocument","title":"Revoke Document","description":"The Revoke document API allows you to revoke specific document from your documents.","source":"@site/docs/API-docs/v1.2/revokedocument.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/revokedocument","permalink":"/docs/API-docs/v1.2/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":"eJy9WMFuIzcS/ZVaHnZnhLYke5wstnNZJxlMjBgZY+xggLUNg2pWqxmzSYZkSxaEBnLYP9hTrvm0+ZJFkd1SS/I4M9hsLraarCq+elUsFrlmgc89y2/Yt6ZoatTBs7uMCfSFkzZIo1nOriuEd7gwDwiik4Kzy3PgSpmlh5VpIBhwScJbLGQpi61o6UxNQm4z5McsY8ai47TCuWA5S9q9AMuY5Y7XGNARujXTvEaWs17gXgqWMUnoLA8V24d86cxCCgQz+wmLcC7AlFtAG7AsYw5/bqRDwfLgGsyYDytFC3lZW0UC+GiVEcjykitPAkWFNWf5moWVjZLBST1nGSuNq3kYjuAjj1ZyZquTWXXCvWBte5dWRR++NmJFlgqjA3mdrxm3Vski8jL5yZMv68Mlk1dEkiMWg0RPsw55p7EPbQuEtW3GggzxY4/0tqVJh94a7ZPJk+mU/u2S26dKx6IA3xQFel82Sq3+wrI/yp8+eM979PUjEWu/s69YRB8hnYXnlU6mJ6+OjqdH079fH3+Zn/4j/+LL8XQ6/RfL2GOtSLdPOB6QDShL3+2+WJdPB9x2nJ4+ReOVqTFUUs9hSWQundHzDKxC7hGCWwGfc6lB8YDuD2QVnTPueXY+D9kwo6RWUuN9n0P3p9Pp/fGGhNNnckmbAKVptPhzXX1q/ecdOr1/tXHoi0OHzvWCKyligbw2D6j/XH+Gy4e0/GG2yiQU59mOs8Px5KTHonEyrGIVfjziVh6l+fzmjkoZZYqhCm6NT3U7VCxnk76qTNaDmt0yMugWfVVvnGI5q0KwPp9MPNdiZh7HxqL2cq4Vn/lxYeoJt3KyOB6fsDbb1+HWfpY8Nkefq+IDn0s9/z29uy1XVxTPFLIdxjaB41Z+jyuW9QEZSnXHWoVcoIvBozR5tz0xXvfB3lZ8RlGUujRxjS6aby3qKznXMRcixv1T8j2qwtRIB2KoEEajXuXDv3/baI1Gm5MzZu34Vt/qt40Da5boykYB1wJKhY9ypjCqYR3nNq2BR14r9F6tQOqAc8cDgpBzGbgCopNKTcEtn0klKdlJzKSeYbBf/BjeVxgqdDT1N4fAQeACFe0R4E0wNQ9kanPSL417KKlJyYDDrPFSo/eAuuK6IME+YBkYB1wD6oDOOukRfHCEWiZsRgfHiwA113yOZDuDIVkClaSsBmdmjQ/gjWoiZAhcKuNQQO+QRhQ+kviaWguHQKOFqa3DirJrgTBvpECfQWEEgo/hJhe0gBn6AJawyAI9GW20MsVDDCAdwGANlRrJFfU8Q4ykHhzXnhqVriHrYrAhzDpDJzkmgKPRjx4pwhdSP/h8NLrVR3Czyav3OPMy4N2Lfqcsl8uDHfJyV+eNDN81M3iH1ngZjFtttecyVM0s7qqhkc1HsvQGNcb8GeyZrQ1hCn+4SWl0UqGykysMlCF+cnZ5HqvzS/jwy3/gArnTUJllytaicahWMO+XIuZS5BNtm+IKpYmJVxHjRUq+rrfrGXxf8fDhl189/IBLkLrbUuTKaPQGA1xjbekghb/CzueF9GE0ysFhbRYooNEaKTTcrWDbG0doHmkgoADrsJRKgeCBp76beEA30BjT0reslArvLfd+aZy4ZVsB4EKgIKSFQwISOkQZNFbsDnQS2+0mQzWYFo6XYTuboKoyYgJnmpAS2Ha9eo8mkmqdCVhEn0TZg44XjntTlvFMJjOfhDyuvAd+sH60Co0nOoMB1JzqmKHd4dPPtOCmUhG+UKF0G2s9wMT2vTMKn0ZGuzQJ+e5uEm8mO0Qd8Pq7RB9Eihy2zUzJYt/hMZwVBVoidsFVgz6H0SghGo3ghcCSNyq8zGA0Wkhc0ij95paiRF9juOrw11ToKr5A4AGoNwxgOpZ4aBzCUoo5hq8gGRoqaNNN+q+gN+2h5qvOnl7189FV0wTgA8PdpY2oGN/Sibl3yu6ecg5LjHfPGN7tpray28Q3fTEAqhH/SzGhY5jOCl7EXg9rLlU67v+5byf2Xehq/7a8QreQBXYtx0fq6CQKT1jGlCxQexz0c2dvLi9g8Wo8Zdmgd/mEkjq5OP/m9Q9XrwkMhSARdjyejqc0RC1dzfVgpe4Z4NvtPX2H68FV9v/0atA1UAEfw8QqLmP/Gn1ed63nDRu8IuTDB4O7jFXUpOY3bL2ecY8/OtW2NPxzg4463LuMLbiTtOtjf9pVALG5/X/U2xfvuoeEl/DJbw9P+tJ3iJraw7hFqb3L2AOu9t4/2rs269tEApskvkmQjq7JztbCwbWD+tykkQrCs7LDPv/y7dU1y9ise7uo4+MIc3xJryl8mdCaSFF6laCxNVNczxs+J9lkkzpbOjp32+KH2BZ3P8irJ/nY7ZeTG/SXnHpSYb1OLXfbbuTT1Ec1OmJ7aQrOXdu2/wU2tMX5","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Update Document","permalink":"/docs/API-docs/v1.2/update-document"},"next":{"title":"Delete Document","permalink":"/docs/API-docs/v1.2/deletedocument"}}');var s=o(74848),i=o(28453),r=o(57742),a=o.n(r),c=o(78178),d=o.n(c),l=o(19624),p=o.n(l),u=o(96226),m=o.n(u),h=(o(77675),o(19365),o(51107)),g=o(21312);const k={id:"revokedocument",title:"Revoke Document",description:"The Revoke document API allows you to revoke specific document from your documents.",sidebar_label:"Revoke Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9WMFuIzcS/ZVaHnZnhLYke5wstnNZJxlMjBgZY+xggLUNg2pWqxmzSYZkSxaEBnLYP9hTrvm0+ZJFkd1SS/I4M9hsLraarCq+elUsFrlmgc89y2/Yt6ZoatTBs7uMCfSFkzZIo1nOriuEd7gwDwiik4Kzy3PgSpmlh5VpIBhwScJbLGQpi61o6UxNQm4z5McsY8ai47TCuWA5S9q9AMuY5Y7XGNARujXTvEaWs17gXgqWMUnoLA8V24d86cxCCgQz+wmLcC7AlFtAG7AsYw5/bqRDwfLgGsyYDytFC3lZW0UC+GiVEcjykitPAkWFNWf5moWVjZLBST1nGSuNq3kYjuAjj1ZyZquTWXXCvWBte5dWRR++NmJFlgqjA3mdrxm3Vski8jL5yZMv68Mlk1dEkiMWg0RPsw55p7EPbQuEtW3GggzxY4/0tqVJh94a7ZPJk+mU/u2S26dKx6IA3xQFel82Sq3+wrI/yp8+eM979PUjEWu/s69YRB8hnYXnlU6mJ6+OjqdH079fH3+Zn/4j/+LL8XQ6/RfL2GOtSLdPOB6QDShL3+2+WJdPB9x2nJ4+ReOVqTFUUs9hSWQundHzDKxC7hGCWwGfc6lB8YDuD2QVnTPueXY+D9kwo6RWUuN9n0P3p9Pp/fGGhNNnckmbAKVptPhzXX1q/ecdOr1/tXHoi0OHzvWCKyligbw2D6j/XH+Gy4e0/GG2yiQU59mOs8Px5KTHonEyrGIVfjziVh6l+fzmjkoZZYqhCm6NT3U7VCxnk76qTNaDmt0yMugWfVVvnGI5q0KwPp9MPNdiZh7HxqL2cq4Vn/lxYeoJt3KyOB6fsDbb1+HWfpY8Nkefq+IDn0s9/z29uy1XVxTPFLIdxjaB41Z+jyuW9QEZSnXHWoVcoIvBozR5tz0xXvfB3lZ8RlGUujRxjS6aby3qKznXMRcixv1T8j2qwtRIB2KoEEajXuXDv3/baI1Gm5MzZu34Vt/qt40Da5boykYB1wJKhY9ypjCqYR3nNq2BR14r9F6tQOqAc8cDgpBzGbgCopNKTcEtn0klKdlJzKSeYbBf/BjeVxgqdDT1N4fAQeACFe0R4E0wNQ9kanPSL417KKlJyYDDrPFSo/eAuuK6IME+YBkYB1wD6oDOOukRfHCEWiZsRgfHiwA113yOZDuDIVkClaSsBmdmjQ/gjWoiZAhcKuNQQO+QRhQ+kviaWguHQKOFqa3DirJrgTBvpECfQWEEgo/hJhe0gBn6AJawyAI9GW20MsVDDCAdwGANlRrJFfU8Q4ykHhzXnhqVriHrYrAhzDpDJzkmgKPRjx4pwhdSP/h8NLrVR3Czyav3OPMy4N2Lfqcsl8uDHfJyV+eNDN81M3iH1ngZjFtttecyVM0s7qqhkc1HsvQGNcb8GeyZrQ1hCn+4SWl0UqGykysMlCF+cnZ5HqvzS/jwy3/gArnTUJllytaicahWMO+XIuZS5BNtm+IKpYmJVxHjRUq+rrfrGXxf8fDhl189/IBLkLrbUuTKaPQGA1xjbekghb/CzueF9GE0ysFhbRYooNEaKTTcrWDbG0doHmkgoADrsJRKgeCBp76beEA30BjT0reslArvLfd+aZy4ZVsB4EKgIKSFQwISOkQZNFbsDnQS2+0mQzWYFo6XYTuboKoyYgJnmpAS2Ha9eo8mkmqdCVhEn0TZg44XjntTlvFMJjOfhDyuvAd+sH60Co0nOoMB1JzqmKHd4dPPtOCmUhG+UKF0G2s9wMT2vTMKn0ZGuzQJ+e5uEm8mO0Qd8Pq7RB9Eihy2zUzJYt/hMZwVBVoidsFVgz6H0SghGo3ghcCSNyq8zGA0Wkhc0ij95paiRF9juOrw11ToKr5A4AGoNwxgOpZ4aBzCUoo5hq8gGRoqaNNN+q+gN+2h5qvOnl7189FV0wTgA8PdpY2oGN/Sibl3yu6ecg5LjHfPGN7tpray28Q3fTEAqhH/SzGhY5jOCl7EXg9rLlU67v+5byf2Xehq/7a8QreQBXYtx0fq6CQKT1jGlCxQexz0c2dvLi9g8Wo8Zdmgd/mEkjq5OP/m9Q9XrwkMhSARdjyejqc0RC1dzfVgpe4Z4NvtPX2H68FV9v/0atA1UAEfw8QqLmP/Gn1ed63nDRu8IuTDB4O7jFXUpOY3bL2ecY8/OtW2NPxzg4463LuMLbiTtOtjf9pVALG5/X/U2xfvuoeEl/DJbw9P+tJ3iJraw7hFqb3L2AOu9t4/2rs269tEApskvkmQjq7JztbCwbWD+tykkQrCs7LDPv/y7dU1y9ise7uo4+MIc3xJryl8mdCaSFF6laCxNVNczxs+J9lkkzpbOjp32+KH2BZ3P8irJ/nY7ZeTG/SXnHpSYb1OLXfbbuTT1Ec1OmJ7aQrOXdu2/wU2tMX5",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},y=void 0,j={},q=[];function f(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)(a(),{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:(0,s.jsx)(g.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(d(),{...o(70510)}),"\n",(0,s.jsx)(p(),{...o(56252)}),"\n",(0,s.jsx)(m(),{...o(43654)})]})}function v(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(f,{...e})}):f(e)}},70510(e){e.exports=JSON.parse('{"parameters":[{"name":"document_id","in":"path","description":"Provide objectId of document to revoke","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"ph2bh2asd"}}]}')},56252(e){e.exports=JSON.parse('{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string","example":""}},"title":"revokedocument"}}}}}')},43654(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Document revoked successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","example":"Bxh2aspHp3"},"revokedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"xml":{"name":"revoke"},"title":"revoke"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"Document not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Document not found!"}},"title":"inline_response_404_3"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/b3eb04bc.6ffb5f7c.js b/assets/js/b3eb04bc.6ffb5f7c.js deleted file mode 100644 index 5c76c8f9c..000000000 --- a/assets/js/b3eb04bc.6ffb5f7c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[1210],{53630(e,t,r){r.r(t),r.d(t,{assets:()=>g,contentTitle:()=>v,default:()=>y,frontMatter:()=>b,metadata:()=>i,toc:()=>J});const i=JSON.parse('{"id":"API-docs/v1.2/folderlist","title":"Get folder list","description":"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId","source":"@site/docs/API-docs/v1.2/folderlist.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/folderlist","permalink":"/docs/API-docs/v1.2/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":"eJy9WF9vG7kR/ypTPrQXYS3JTnJFdS81itT11UiC2ocAtQ2D2p3VMuaSPHJWfyAIuId+gz71tR8tn6QYcldaycolbq/3YmvJmeFv/g+5FiRnQUxuxZ+tLtCL+0wUGHKvHClrxETcVAhpD65UIDh/fwlYO7tAH2BlGyALHskrnCNI0ExjSygTy0JRBTb9tw2Bkx4NJXmXhciEdeglH3VZiIlIXCxDZMJJL2sk9IxvLYysUUzEEwmKUf7YoF+JQ+x2+hFzuix2gEQmPP7YKI+FmJRSB8xEoJXGeLivRSZw6bQtcLedV1hLMVkLWjmmC+SVmYksMkjqr+BS1i4KE5tNtsWsVa3oEOpX4yDf7MGo5VLVTS0mr8fjrANlmnqKXmx6GE7HPQjhUblfDMHnzxxv7llucNYEDEx7Nh7zv33HhCbPMYSy0bANAJGJ3BpCQ0wvndMqjxujj4GZ1k8BJP9yqHgWQyod6TE0mnp00nvJCivCOnyZvwub5/rcVafTann20bFJUry9jdZ/nhiDiy5aN9lhvD9T1vdnRobXj+o9Hsr6b5GFZtpDl3uUhMU5HRO1Yzwbn708OR2fjH9/c/rt5NUfJq+/HY7H47+LTCxrzbxtmBaSIlJSpPvfjSt+hXN6C0nFB49BbPrrymhl8KEL8Yez8fjh9CXTbDLx6lisX9saqVJmBgs0BAtvzSwDp1EGBPIrkDOpDGhJ6H/zyyUBem/9z1vrech+zgqv2ApbI7x+aoRLM5daFbF73NhHNL+upv3jKR3PUPdjQiWiuC/2lO2vJyUD5o1XtIqdaXkinTpJ+5Pbey6BbFjLHW2GqZVRJSZitNffAvp519war8VEVEQuTEajIE0xtcuhdWiCmhktp2GY23oknRrNT4dngiv7Po907ln02Jw8lyWQnCkz+xLf/c481+zC5KU9I+0qs1N/RS7NrQ/6VG23qlDGYrPh79JG5tYz7xyaazUz0a/x8MMJ4APq3NbIQwpVCINBx/LpH//ecg0GUNi8qdFQjMDhnbkz7xoPccrhJiVNAaXGpZpqPDoBBZS1xhD0CpQhnHlJCIWaKZIa2E6cZbl0cqq04sBlMsvcHnqxH4bwoUKq0PPW7zxPVAXOUXO8g2zI1pJYVIcXFtY/ltouQgYSpk1QBkMANJU0ORN2nsh4CpMG0BB651VACOQZtUrYrCEvc4JaGjlDlp1B31gFasXhCt5Om0AQrG4iZCCptPVYQKeQQSxCNOIbniA8Aq/mtnYeKw6bOcKsUQWGDHJbIISYp6yCKWCKgcAxFpVjYKGN0TZ/jA4sG63BWS4bSmqe6/oYmZ28NIGbWMLS+WBrMOctjx6YAA4GPwRkD18p8xgmg8GdOYHbbVx9wGlQhPffdCmwWCyehP6LfZ4LRX9ppvA3dDYosn61454pqpppTJe+kO1HknSBBmP89JJhJ6OweXiafbw6qlC70TUSR0gYnb+/jJX2BXz66Z9whdIbqOwiRWveeNQrmHVHseWS55PZtoUSShsDr2KL5yn4eG7EQJ0FP1SSPv30rwBvcQHKtCnFqgwGF0hwg7XjHgK/hb1Pvk4MBhPwWNs5FtAYg+wa6Vewm/0jtIC8QFiA81gqraGQJKH0to7Zhb7HMeSj70SpND44GcLC+uJO7AhAFgUWjDRNL0AtogzSmNFbaCl26cb3md124WVJu90EVZcRE3jbUApg5+1cFQgdmmhU5y1hHnUqyg601NouHmxZxv7KYr4KeTz5AHzv/CgVmsDmJAtoJNcxy9kR0s904LZSMT6qUPmttA5gsvaDtxqPI+MsTUQBUsPmLN031BO7ftHQTzzFCrtmqlV+qPAQzvMcHRt2LnWDYQKDQUI0GMA3BZay0fQig8FgrnDBq/xbOvYSfw3husVfc6GrJF9sCXgsIrCtlSQ1HmGhihnSd5AE9RmMbTfDd9CJDlDLVSvPrLr97d1Y9gS3VzM2xfCOW+FB+9zvch5L9Gy76N5dUjvVJvFtVwyAa8T/Ukzi0G8NyTzObVhLpVMf/+OhnDhDoa/Du/Ia/Vzl2M4Sn6mjo0g8EpnQKkcTsDebnV+8v4L5y+FYZL2h5CtK6ujq8k9v3l6/YTDsgmSw0+F4OI43IhuolqZ3Epeo9vGindP2bL3eTa3/76eRdkQiXNLIaaniUBqVX7cD5W3/weQ+E5UNxKvr9VQG/MHrzYaX032fx8w233c3/s/qdvTp5CiiR1wde5aJuRcfQrIj5yam7l3ka2jbB4wd6T1/eMW0cerOukmRFU08qRD0uJ5cM/Zm9Ys3NyIT3Oz2J9THOKG2P1h6t2VWPdn7o2sCwH9Zp6MM63WafjebLX3a+ixHq2BHzfa/32w2/wGqBupU","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Folder","permalink":"/docs/API-docs/v1.2/deletefolder"},"next":{"title":"v1.1","permalink":"/docs/API-docs/v1.1"}}');var s=r(74848),n=r(28453),o=r(57742),l=r.n(o),a=r(78178),p=r.n(a),d=r(19624),m=r.n(d),c=r(96226),h=r.n(c),x=(r(77675),r(19365),r(51107)),f=r(21312);const b={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:"eJy9WF9vG7kR/ypTPrQXYS3JTnJFdS81itT11UiC2ocAtQ2D2p3VMuaSPHJWfyAIuId+gz71tR8tn6QYcldaycolbq/3YmvJmeFv/g+5FiRnQUxuxZ+tLtCL+0wUGHKvHClrxETcVAhpD65UIDh/fwlYO7tAH2BlGyALHskrnCNI0ExjSygTy0JRBTb9tw2Bkx4NJXmXhciEdeglH3VZiIlIXCxDZMJJL2sk9IxvLYysUUzEEwmKUf7YoF+JQ+x2+hFzuix2gEQmPP7YKI+FmJRSB8xEoJXGeLivRSZw6bQtcLedV1hLMVkLWjmmC+SVmYksMkjqr+BS1i4KE5tNtsWsVa3oEOpX4yDf7MGo5VLVTS0mr8fjrANlmnqKXmx6GE7HPQjhUblfDMHnzxxv7llucNYEDEx7Nh7zv33HhCbPMYSy0bANAJGJ3BpCQ0wvndMqjxujj4GZ1k8BJP9yqHgWQyod6TE0mnp00nvJCivCOnyZvwub5/rcVafTann20bFJUry9jdZ/nhiDiy5aN9lhvD9T1vdnRobXj+o9Hsr6b5GFZtpDl3uUhMU5HRO1Yzwbn708OR2fjH9/c/rt5NUfJq+/HY7H47+LTCxrzbxtmBaSIlJSpPvfjSt+hXN6C0nFB49BbPrrymhl8KEL8Yez8fjh9CXTbDLx6lisX9saqVJmBgs0BAtvzSwDp1EGBPIrkDOpDGhJ6H/zyyUBem/9z1vrech+zgqv2ApbI7x+aoRLM5daFbF73NhHNL+upv3jKR3PUPdjQiWiuC/2lO2vJyUD5o1XtIqdaXkinTpJ+5Pbey6BbFjLHW2GqZVRJSZitNffAvp519war8VEVEQuTEajIE0xtcuhdWiCmhktp2GY23oknRrNT4dngiv7Po907ln02Jw8lyWQnCkz+xLf/c481+zC5KU9I+0qs1N/RS7NrQ/6VG23qlDGYrPh79JG5tYz7xyaazUz0a/x8MMJ4APq3NbIQwpVCINBx/LpH//ecg0GUNi8qdFQjMDhnbkz7xoPccrhJiVNAaXGpZpqPDoBBZS1xhD0CpQhnHlJCIWaKZIa2E6cZbl0cqq04sBlMsvcHnqxH4bwoUKq0PPW7zxPVAXOUXO8g2zI1pJYVIcXFtY/ltouQgYSpk1QBkMANJU0ORN2nsh4CpMG0BB651VACOQZtUrYrCEvc4JaGjlDlp1B31gFasXhCt5Om0AQrG4iZCCptPVYQKeQQSxCNOIbniA8Aq/mtnYeKw6bOcKsUQWGDHJbIISYp6yCKWCKgcAxFpVjYKGN0TZ/jA4sG63BWS4bSmqe6/oYmZ28NIGbWMLS+WBrMOctjx6YAA4GPwRkD18p8xgmg8GdOYHbbVx9wGlQhPffdCmwWCyehP6LfZ4LRX9ppvA3dDYosn61454pqpppTJe+kO1HknSBBmP89JJhJ6OweXiafbw6qlC70TUSR0gYnb+/jJX2BXz66Z9whdIbqOwiRWveeNQrmHVHseWS55PZtoUSShsDr2KL5yn4eG7EQJ0FP1SSPv30rwBvcQHKtCnFqgwGF0hwg7XjHgK/hb1Pvk4MBhPwWNs5FtAYg+wa6Vewm/0jtIC8QFiA81gqraGQJKH0to7Zhb7HMeSj70SpND44GcLC+uJO7AhAFgUWjDRNL0AtogzSmNFbaCl26cb3md124WVJu90EVZcRE3jbUApg5+1cFQgdmmhU5y1hHnUqyg601NouHmxZxv7KYr4KeTz5AHzv/CgVmsDmJAtoJNcxy9kR0s904LZSMT6qUPmttA5gsvaDtxqPI+MsTUQBUsPmLN031BO7ftHQTzzFCrtmqlV+qPAQzvMcHRt2LnWDYQKDQUI0GMA3BZay0fQig8FgrnDBq/xbOvYSfw3husVfc6GrJF9sCXgsIrCtlSQ1HmGhihnSd5AE9RmMbTfDd9CJDlDLVSvPrLr97d1Y9gS3VzM2xfCOW+FB+9zvch5L9Gy76N5dUjvVJvFtVwyAa8T/Ukzi0G8NyTzObVhLpVMf/+OhnDhDoa/Du/Ia/Vzl2M4Sn6mjo0g8EpnQKkcTsDebnV+8v4L5y+FYZL2h5CtK6ujq8k9v3l6/YTDsgmSw0+F4OI43IhuolqZ3Epeo9vGindP2bL3eTa3/76eRdkQiXNLIaaniUBqVX7cD5W3/weQ+E5UNxKvr9VQG/MHrzYaX032fx8w233c3/s/qdvTp5CiiR1wde5aJuRcfQrIj5yam7l3ka2jbB4wd6T1/eMW0cerOukmRFU08qRD0uJ5cM/Zm9Ys3NyIT3Oz2J9THOKG2P1h6t2VWPdn7o2sCwH9Zp6MM63WafjebLX3a+ixHq2BHzfa/32w2/wGqBupU",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},v=void 0,g={},J=[];function u(e){const t={p:"p",...(0,n.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(x.default,{as:"h1",className:"openapi__heading",children:"Get folder list"}),"\n",(0,s.jsx)(l(),{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)(x.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(f.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(p(),{...r(95257)}),"\n",(0,s.jsx)(m(),{...r(95619)}),"\n",(0,s.jsx)(h(),{...r(30149)})]})}function y(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(u,{...e})}):u(e)}},95257(e){e.exports=JSON.parse('{"parameters":[{"name":"parentFolderId","in":"query","description":"objectId of folder","required":false,"style":"form","explode":false,"schema":{"type":"string","format":"string","example":""}},{"name":"limit","in":"query","required":false,"style":"form","explode":true,"schema":{"maximum":500,"type":"number"},"example":10},{"name":"skip","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"number"},"example":0}]}')},95619(e){e.exports={title:"Body"}},30149(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"ph1bhx2jp"},"folderName":{"type":"string","format":"string","example":"new folder"},"parentFolderId":{"type":"string","format":"string","example":"J2nas5kiPe"},"parentFolderName":{"type":"string","format":"string","example":"new sub folder"},"createdAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"title":"folder_res"}}},"title":"inline_response_200_13"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/b3eb04bc.fdce2266.js b/assets/js/b3eb04bc.fdce2266.js new file mode 100644 index 000000000..070ac9824 --- /dev/null +++ b/assets/js/b3eb04bc.fdce2266.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[1210],{53630(e,t,a){a.r(t),a.d(t,{assets:()=>g,contentTitle:()=>P,default:()=>w,frontMatter:()=>f,metadata:()=>i,toc:()=>y});const i=JSON.parse('{"id":"API-docs/v1.2/folderlist","title":"Get folder list","description":"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId","source":"@site/docs/API-docs/v1.2/folderlist.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/folderlist","permalink":"/docs/API-docs/v1.2/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":"eJy9GdtuI7f1V065QLEWRhc72RRVirSO13GcbncNy+4CtQwPNXOkYcQhJyRHsmALyEPRDyj60tf+RN/7KfslxSFnRiPZe3GT5iHxijw3nvs5c8ccn1k2vGLfaJmiYdcRS9EmRhROaMWG7CJDCHfwSlgHh2engHmhl2gsrHQJToNBZwQuEDhIgtFTmAaUpXAZ6PBXlw4KblC5QO80ZRHTBRpOrE5TNmQBi2iwiBXc8BwdGpLvjimeIxuyBxQESflDiWbFdmXXk+8xcafpRiAWMYM/lMJgyoZTLi1GzLqVRM/c5CxieFtIneLmOskw52x4x9yqIDjrjFAzFnkE7toneMvzwhNj63XUyCxFLtyuqJ8shzPllhg5vxV5mbPhi8EgqoVSZT5Bw9YtGfYHLRHsXBQ/mwTv5zlYXxNdW2hl0RLswWBAf7YNY8skQWunpYTGAVjEEq0cKkfwvCikSPxF/3tLSHcPBQj2JVcxRMaJwNKgLaVrwXFjOD1YOMztx/Frt3mqzYtsf5LdHnxfkEqCv7322n8aGYXL2lvX0a6/P5HWdweK2xdzcYa7tP5XyWw5aUmXGOQO00P3GKkN4sHg4LPu/qA7+M3F/hfDz387fPFFbzAY/IVF7DaXhFu5acqdl9QJJ9u/yyL9Bfi0DsITbwxatm6fCyWFwpvaxW8OBoOb/c8IZh2xzx/z9ZHO0WVCzWCJysHSaDWLoJDILYIzK+AzLhRI7tD86ucLAjRGmw9r62mSfUgLn5MWGiW8eKiEU7XgUqS+elzoOapf9qVt9i6wJ1G3fUIEIH/Pth7bPg+PtJiURriVr0y3XV6IbrgfXl1TCiTFaqpoMwylzGVsyPpb9c2iWdTFrTSSDVnmXGGH/b7lKp3o254uUFkxU5JPbC/ReZ8Xor/Y7x0wyuzbOLwongSPZfepKNbxmVCzj+Fdb9QzIhMGK20paZOZC/FHpNRc2aANVVWrDLlPNmv6PdUeubLMmwLVSMyUt6tnvtsBPIMa5t1f/9WAjdVYfQWdDvU29JCu1aVJEF7qpPT0uHRoFHdigfDux3/ApBTSwVQbSHGBkrzPRuBMaR2mMFkBKoemMMKi7XU6RL/NdyYWGJolDokmn3QYQWF0WiYkaNcgT1eAXdIod6VBKCR3lIrBZUaXsww4WKFmEiM4Px5dUOU8PDvtwQhVCqlOyhyVs17EhkgEOVd8huAwJ3roZebJ3INQ3FvHXWlBKDDIJTiRYwRcpcBLp3PukIQ29DphsGEDUkwxWSUyKIdL2fR3C1SpNiB1Mu8K1SNFdLtd+vPsGZygc8R15LhxmNLp8QLNCqgRQesgL62DhBuzCnybcCUJXYYQt/wjhuAZnkkcx2PVuhzC74jC5uCrCmasOp13f/s7XH2rl9S6zlBR/4E7DK+f106f6sQ+9HY67Wcoi/4oPMr2D89OfWbbC/Z/rR1YsuQyQ4PEaoIzoX4Pl5RcM4ROpwpzQLUQRitSbacDz+NPTgPxHtEtjHaa4qmxAp9OMfGqluTBKXd8xxRH2iAc8YJPhBSUSOn8Ho64w5k2K7iHtxl33mUTriDVcD9W991u1/9HoJ3Oy9rrOh24hyPfCURgUaURhHodgcGFnlc+lSL5/cY9u7XZN+5bUb6o/dVT/roUMgWDpeUT2XLmMFwUBruF5AmmsBTpDJ390stAmtEKafjIuVp5tjSyVCxGKKddik/P4qT2AkvHHrQdVY1eKyog1EI4X61gKvWyJnpWTqRIYFv8UcYNTUZFuKxDTwo19+GjdE3Vz051U17TfGn41MFbbebEKVDkC2xJp01LJ9xCShjWq3wqFJciOFweCnlN90grx5PKeH8KecLHQCVMEu5hovWcXGxmeJ5zJxIu5aomElrJQOONmXFFvDaSCWVFik0KhpeG3DEUwcYSb3GSaT0PRM4xQYKhdNSldAS4oIyjtBPTqkGwEDzTgF4qQJUWWihXk7u0tUDnzVSaJLpUzmskMZgKB1RJqM8lC95vhwY5/rsf/2nhNS4p79QF4xmFjUROyqktXPPgcqzik+ML6NeW6A9FGnuO2+dk4xgysuAEUYF1BnlO3VTqvcFgWqqUKz8qV+MvkAMZzPUCU0+y0ykMToWUPrRBWFB6SVN4aYiORcJ1KFcwNTqvLboh2OlQaZiTGzazGiC3Ag2FTaKVLXPs1a8+49YutUm7Z0Y7TKjknb38BkZlUWjjxoruIR6zqZB4U1TAYxbXWbuO84lOV5QOFSy18dx9BKNKzKqoqNpeTRdT0Go4VvHZm9EF9MOkUasxhv/8G+Kzywca98cthNoZ+8Ma7mYbzEdLDfXgYoefv6AcQSqNa/28mU7JgDCqQptCy2g5ViN0pBcupV7e6AB1Q6hjNqTuAeEe/Ogdg1bwnod6H3rkpU4DDegiEU5SA+KTI3UoIuTJil+TcKg1QJ5kTbJo7DsK/nGuJdUBaoriKlvGEHpu7188SbCgxEJvCgA3RkskS08FyhR4YrS1viHwr6DoMrp0aHtwkRlEIPjgz7a28jCUHuJOyR4zvhAU3LsFp5Iphs7zFKe8lG7Ppy7fM1RNFWUGGl+cT/2bbipUhpAi4oXAJdFpso31Xtp0N6QogwQFWslVnaSr6gLemnV+jnlRGL0I5I64CpFN9aYGx1vSWlU6gjRVivfM7pvUws1EKzjSxQqeHx3tkXCiEJRHx+oQaPSOxyxJNtquwr5RJHCp1cxnXHoP3grre4B4zCZtPK2at0aNM0ShbHhva4pgY8V+qOeNMY9zLiTwNDVoKXdQVsOU4r2R0VSZnFNDN9Gqm9DL2nkc0FPRKsFtAwjbGDTtwSsxx80bIhJ/Sxp4bssko8IXomQT8SKN96h0LURa6SGIRvYyIq3sXmsAFlyWGPmCE7IUaVYKUixVU9p6uhX4XRI8j6+u470vQefCeSpBtU6DUBma6nCb9E4LdrjgQvpIPd70f1Uf1jqhmKB5/PL81SM92Ci0iL7ePaFvbBqWZgTZpvDBCa/BPr6Ec5w9QP7YZBnvVtw/o7FC+yT1a/iaJ/MlN6mFI50X3Anfoa4IlJDJOaYltSCTGrCbVIAydMCw2PduvNjv7TcDSt0m2FASXaYtwiIwDgmJN/bQVLaEhUmtd09VaZgYDFUzybiaUSBQj9Aq1IISf1omIRa8vERa+3GUSyiVRGtBuwzNknolpcnHt9VxaZHGu1dCzb07dOGq6aDe4sQKh5vxZLlcPtD0nsf5ppQS6h7dB9xHhpqAdiLct+UEzrHQVjhtVhusmXBZOfG2bOM2PyoCdS/d7Hp+yjDlSV6gyS0t8UdoFiL5yPP7jsD7e2NaIeysHba3AwanaCjv2K1RkBeiGjuvajmAxPsp7/DL0tBS+50Vpb6w//jDLh2/e6InvJlW7612MB9+L4uYFAkqi62d1uHJ2StYfNYbsKi1zPkEW/ZfnR4dvx4dkzBVmLAh2+8NegO/SdbW5Vy1OJ2gqz/6VPutLV3fbbZ9/+9PStVqyeGt6xeSC7/M84+/qxZxV+0PTdcRy7R1dHp3RyF/aeR6TcfhOwmt56qeavOl5L1ve/ST06MSzXH12OcsXyr8B6ToEb4Bqf6e9Cmw1YefDeg1/TCCYP22Mqo3bPTQgHPoO70W1oP17NaO8+T4gkWMl6Ta9mZv7jd71T+Ien2lVi3a2yu/IAD9n970KMLdXdgartcNfLh6L0b1wBqa9H+9Xq//CxEnMeo=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Folder","permalink":"/docs/API-docs/v1.2/deletefolder"},"next":{"title":"v1.1","permalink":"/docs/API-docs/v1.1"}}');var o=a(74848),r=a(28453),s=a(57742),l=a.n(s),d=a(78178),n=a.n(d),p=a(19624),c=a.n(p),m=a(96226),x=a.n(m),h=(a(77675),a(19365),a(51107)),u=a(21312);const f={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:"eJy9GdtuI7f1V065QLEWRhc72RRVirSO13GcbncNy+4CtQwPNXOkYcQhJyRHsmALyEPRDyj60tf+RN/7KfslxSFnRiPZe3GT5iHxijw3nvs5c8ccn1k2vGLfaJmiYdcRS9EmRhROaMWG7CJDCHfwSlgHh2engHmhl2gsrHQJToNBZwQuEDhIgtFTmAaUpXAZ6PBXlw4KblC5QO80ZRHTBRpOrE5TNmQBi2iwiBXc8BwdGpLvjimeIxuyBxQESflDiWbFdmXXk+8xcafpRiAWMYM/lMJgyoZTLi1GzLqVRM/c5CxieFtIneLmOskw52x4x9yqIDjrjFAzFnkE7toneMvzwhNj63XUyCxFLtyuqJ8shzPllhg5vxV5mbPhi8EgqoVSZT5Bw9YtGfYHLRHsXBQ/mwTv5zlYXxNdW2hl0RLswWBAf7YNY8skQWunpYTGAVjEEq0cKkfwvCikSPxF/3tLSHcPBQj2JVcxRMaJwNKgLaVrwXFjOD1YOMztx/Frt3mqzYtsf5LdHnxfkEqCv7322n8aGYXL2lvX0a6/P5HWdweK2xdzcYa7tP5XyWw5aUmXGOQO00P3GKkN4sHg4LPu/qA7+M3F/hfDz387fPFFbzAY/IVF7DaXhFu5acqdl9QJJ9u/yyL9Bfi0DsITbwxatm6fCyWFwpvaxW8OBoOb/c8IZh2xzx/z9ZHO0WVCzWCJysHSaDWLoJDILYIzK+AzLhRI7tD86ucLAjRGmw9r62mSfUgLn5MWGiW8eKiEU7XgUqS+elzoOapf9qVt9i6wJ1G3fUIEIH/Pth7bPg+PtJiURriVr0y3XV6IbrgfXl1TCiTFaqpoMwylzGVsyPpb9c2iWdTFrTSSDVnmXGGH/b7lKp3o254uUFkxU5JPbC/ReZ8Xor/Y7x0wyuzbOLwongSPZfepKNbxmVCzj+Fdb9QzIhMGK20paZOZC/FHpNRc2aANVVWrDLlPNmv6PdUeubLMmwLVSMyUt6tnvtsBPIMa5t1f/9WAjdVYfQWdDvU29JCu1aVJEF7qpPT0uHRoFHdigfDux3/ApBTSwVQbSHGBkrzPRuBMaR2mMFkBKoemMMKi7XU6RL/NdyYWGJolDokmn3QYQWF0WiYkaNcgT1eAXdIod6VBKCR3lIrBZUaXsww4WKFmEiM4Px5dUOU8PDvtwQhVCqlOyhyVs17EhkgEOVd8huAwJ3roZebJ3INQ3FvHXWlBKDDIJTiRYwRcpcBLp3PukIQ29DphsGEDUkwxWSUyKIdL2fR3C1SpNiB1Mu8K1SNFdLtd+vPsGZygc8R15LhxmNLp8QLNCqgRQesgL62DhBuzCnybcCUJXYYQt/wjhuAZnkkcx2PVuhzC74jC5uCrCmasOp13f/s7XH2rl9S6zlBR/4E7DK+f106f6sQ+9HY67Wcoi/4oPMr2D89OfWbbC/Z/rR1YsuQyQ4PEaoIzoX4Pl5RcM4ROpwpzQLUQRitSbacDz+NPTgPxHtEtjHaa4qmxAp9OMfGqluTBKXd8xxRH2iAc8YJPhBSUSOn8Ho64w5k2K7iHtxl33mUTriDVcD9W991u1/9HoJ3Oy9rrOh24hyPfCURgUaURhHodgcGFnlc+lSL5/cY9u7XZN+5bUb6o/dVT/roUMgWDpeUT2XLmMFwUBruF5AmmsBTpDJ390stAmtEKafjIuVp5tjSyVCxGKKddik/P4qT2AkvHHrQdVY1eKyog1EI4X61gKvWyJnpWTqRIYFv8UcYNTUZFuKxDTwo19+GjdE3Vz051U17TfGn41MFbbebEKVDkC2xJp01LJ9xCShjWq3wqFJciOFweCnlN90grx5PKeH8KecLHQCVMEu5hovWcXGxmeJ5zJxIu5aomElrJQOONmXFFvDaSCWVFik0KhpeG3DEUwcYSb3GSaT0PRM4xQYKhdNSldAS4oIyjtBPTqkGwEDzTgF4qQJUWWihXk7u0tUDnzVSaJLpUzmskMZgKB1RJqM8lC95vhwY5/rsf/2nhNS4p79QF4xmFjUROyqktXPPgcqzik+ML6NeW6A9FGnuO2+dk4xgysuAEUYF1BnlO3VTqvcFgWqqUKz8qV+MvkAMZzPUCU0+y0ykMToWUPrRBWFB6SVN4aYiORcJ1KFcwNTqvLboh2OlQaZiTGzazGiC3Ag2FTaKVLXPs1a8+49YutUm7Z0Y7TKjknb38BkZlUWjjxoruIR6zqZB4U1TAYxbXWbuO84lOV5QOFSy18dx9BKNKzKqoqNpeTRdT0Go4VvHZm9EF9MOkUasxhv/8G+Kzywca98cthNoZ+8Ma7mYbzEdLDfXgYoefv6AcQSqNa/28mU7JgDCqQptCy2g5ViN0pBcupV7e6AB1Q6hjNqTuAeEe/Ogdg1bwnod6H3rkpU4DDegiEU5SA+KTI3UoIuTJil+TcKg1QJ5kTbJo7DsK/nGuJdUBaoriKlvGEHpu7188SbCgxEJvCgA3RkskS08FyhR4YrS1viHwr6DoMrp0aHtwkRlEIPjgz7a28jCUHuJOyR4zvhAU3LsFp5Iphs7zFKe8lG7Ppy7fM1RNFWUGGl+cT/2bbipUhpAi4oXAJdFpso31Xtp0N6QogwQFWslVnaSr6gLemnV+jnlRGL0I5I64CpFN9aYGx1vSWlU6gjRVivfM7pvUws1EKzjSxQqeHx3tkXCiEJRHx+oQaPSOxyxJNtquwr5RJHCp1cxnXHoP3grre4B4zCZtPK2at0aNM0ShbHhva4pgY8V+qOeNMY9zLiTwNDVoKXdQVsOU4r2R0VSZnFNDN9Gqm9DL2nkc0FPRKsFtAwjbGDTtwSsxx80bIhJ/Sxp4bssko8IXomQT8SKN96h0LURa6SGIRvYyIq3sXmsAFlyWGPmCE7IUaVYKUixVU9p6uhX4XRI8j6+u470vQefCeSpBtU6DUBma6nCb9E4LdrjgQvpIPd70f1Uf1jqhmKB5/PL81SM92Ci0iL7ePaFvbBqWZgTZpvDBCa/BPr6Ec5w9QP7YZBnvVtw/o7FC+yT1a/iaJ/MlN6mFI50X3Anfoa4IlJDJOaYltSCTGrCbVIAydMCw2PduvNjv7TcDSt0m2FASXaYtwiIwDgmJN/bQVLaEhUmtd09VaZgYDFUzybiaUSBQj9Aq1IISf1omIRa8vERa+3GUSyiVRGtBuwzNknolpcnHt9VxaZHGu1dCzb07dOGq6aDe4sQKh5vxZLlcPtD0nsf5ppQS6h7dB9xHhpqAdiLct+UEzrHQVjhtVhusmXBZOfG2bOM2PyoCdS/d7Hp+yjDlSV6gyS0t8UdoFiL5yPP7jsD7e2NaIeysHba3AwanaCjv2K1RkBeiGjuvajmAxPsp7/DL0tBS+50Vpb6w//jDLh2/e6InvJlW7612MB9+L4uYFAkqi62d1uHJ2StYfNYbsKi1zPkEW/ZfnR4dvx4dkzBVmLAh2+8NegO/SdbW5Vy1OJ2gqz/6VPutLV3fbbZ9/+9PStVqyeGt6xeSC7/M84+/qxZxV+0PTdcRy7R1dHp3RyF/aeR6TcfhOwmt56qeavOl5L1ve/ST06MSzXH12OcsXyr8B6ToEb4Bqf6e9Cmw1YefDeg1/TCCYP22Mqo3bPTQgHPoO70W1oP17NaO8+T4gkWMl6Ta9mZv7jd71T+Ien2lVi3a2yu/IAD9n970KMLdXdgartcNfLh6L0b1wBqa9H+9Xq//CxEnMeo=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},P=void 0,g={},y=[];function F(e){const t={p:"p",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Get folder list"}),"\n",(0,o.jsx)(l(),{method:"get",path:"/folderlist",context:"endpoint"}),"\n",(0,o.jsx)(t.p,{children:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId"}),"\n",(0,o.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,o.jsx)(u.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,o.jsx)(n(),{...a(95257)}),"\n",(0,o.jsx)(c(),{...a(95619)}),"\n",(0,o.jsx)(x(),{...a(30149)})]})}function w(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(F,{...e})}):F(e)}},95257(e){e.exports=JSON.parse('{"parameters":[{"name":"parentFolderId","in":"query","description":"objectId of folder","required":false,"style":"form","explode":false,"schema":{"type":"string","format":"string","example":""}},{"name":"limit","in":"query","required":false,"style":"form","explode":true,"schema":{"maximum":500,"type":"number"},"example":10},{"name":"skip","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"number"},"example":0}]}')},95619(e){e.exports={title:"Body"}},30149(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"ph1bhx2jp"},"folderName":{"type":"string","format":"string","example":"new folder"},"parentFolderId":{"type":"string","format":"string","example":"J2nas5kiPe"},"parentFolderName":{"type":"string","format":"string","example":"new sub folder"},"createdAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"title":"folder_res"}}},"title":"inline_response_200_13"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/b9fdab4b.2866c83f.js b/assets/js/b9fdab4b.2866c83f.js deleted file mode 100644 index aba42f97e..000000000 --- a/assets/js/b9fdab4b.2866c83f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[8089],{86761(e,t,s){s.r(t),s.d(t,{assets:()=>x,contentTitle:()=>D,default:()=>f,frontMatter:()=>b,metadata:()=>n,toc:()=>A});const n=JSON.parse('{"id":"API-docs/v1.2/getsignerips","title":"Get Signer IPs","description":"The Get Signer IPs API enables you to retrieve IPs of signers who signed the document.","source":"@site/docs/API-docs/v1.2/getsignerips.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/getsignerips","permalink":"/docs/API-docs/v1.2/getsignerips","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getsignerips","title":"Get Signer IPs","description":"The Get Signer IPs API enables you to retrieve IPs of signers who signed the document.","sidebar_label":"Get Signer IPs","hide_title":true,"hide_table_of_contents":true,"api":"eJzNWFFzG7cR/isbPDQ250xKspKml5e4raqo1dgeSx4/SBwNeNjjwcIBCLBHisPhTB7yD/LU1/40/5LO4u7IoyTbcdvJ9EU6Atjdb3eB3Q9YC5LzKPIr8VdXNDVaimKaCYWxCNqTdlbk4rJCOEWCCz23GODsdYQXr88ArZwZjLByDZCDgBQ0LjDNuxJiWh1hWbn2WwFVCKqzM7621/alI8zhstKtRh3BWbMCuZDasHIoXYBLlHUEaRWcWMLgg44I3kgbx9dWZMJ5DJKhnimRizlSa1n7KDLhZZA1EgZ2ci2srFHkogdxo5XIhGYnvaRK3Pfczd5jQWeK/ekDJDIR8KdGB1Qip9BgJiKtDKuNuvYGRSbwzhunUOSlNJEXFBXWUuRrQSufVlLQdi4yUbpQSxqO4J1MWnIh/3xUFEeVn1Vis5my2eidjRhZ0dHBAf/bxxubosAYy8bANioiE4WzxMjztZDeG12kicn7yELrh+hatzl6gdWQbk320fhSP/52qm+Pns+qt38Xm0y02bnh9Oz0yBDkilNBWMfPI8FaavMYjJ3R9w5niD90A+PC1Wxc+xupVMAYPy19+Kfn48Pvvh0fjw+/+6PYbDJxVyeD3QZqnTjz8U2XE1ZOmsxuMnm4+Y9E9yaTiuPHsn3haqRK2zks0RIsg7PzDLxBGREorEDOpbZgJGH46n+3DTAEFz4dvi9DthkEQFujLd70W/3m+ODg5nAbhOOHQeiPJVhHULrGqt/X1cfsf9qh45vnW4e+eejQmV1Io1UqiJfuFu3v68/QPLXmH+5h3S5K82LP2eF462TEogmaVqn+3j2TXj9r5/OrKVc13imuq9ypYFMlcjHZFvHJelCtN4IVhkVfz5tgRC4qIh/zySRKq2bubuw8WpY3chb55E+k15PF4fhIbLL7MtL7L1qPzbMvFYkk59rOPyc33cXqgvPZpmwvYrt66fU/kAtml5Dhqq6hVSgVhpQ8bUuXhLs0vfJouZmnJCfj9xvfOzSFq5H7Ojft0agX+fDLv7ZSo9G2m6ftmFr6qyaAd0sM3IS4aZcG7zT38sQZ6jS3JQ0RZW0wRrMCbQnnQRKC0nNN0iTWwDWkkF7OtNG8i3mZY+kAg4MQx/CuQqow8NTXAUGCwgUa3vwgG3K1JFbV44WlC7elccuYgYRZE7XFGAFtJW3BC/tMZOACSAu4ox6RAqPWLTZnKciCoJZWzpF1ZzAMlkKjebtCcLMmEkRnmgQZSGrjAtOiziGLqGIK4gnzh4DAo4WrfcCKt80CYd5ohTGDwimEmA4tu2AVzDASeMaiC4ystLHGFbcpgWVjDHjHNURLw3RmiJHFKUgbuYu3WPocbAPmg2NqgS3A0ehtRM7wuba3MR+Nru0zuNruq3c4i5pw+qQ/Asvl8sHWf7ovc6rpx2YGb9C7qMmF1U56rqlqZum4DJVsf7SaTtFi2j+Dw7DToVwRH54+Hp1UaPzkAol3SJy8eH2Wyu5T+PDzr3COMlio3LLdrUUT0Kxg3pviyLWZb8O2rZqJucqGKo540W4+po0YqY/gu0rSh5//GeElLkHb7kixK6MR0+1LrD13SPgD7P0815FGoxwC1m6BChprkVMjwwp2dDdBi8gDhAp8wFIbA0qShDK4uuPnA4kxm74WpTZ442WMSxfUtdgtAKkUKkZaBGQg1CHKoPFqf6BbsTtumqrBtAqypN1sC9W0dwYIrqF2A/vgFloh9GhSUH1whEXySZU9aGmMW964skzNltX8JuTJ8j3wA/tJKzSRw0muu/BwQVA6tp+twW2lYnxUoQ5bbT3AjhMGZ/BxZHxK+ytT2735lO4H6kFcPxvoB5lih30zM7q47/AYXhQFeg7sQpoGYw6jUYtoNIInCkvZGHqawWi00LjkUf6WnrPEv8bdBTFCzYWukgsEScCkj8B1UZLUBISlVnOk76FVNBSwrpuM30OvOkItV50+u+rnk6uuIZADxd3NrLtgiux++9zvcgFLDBy7lN7dofa6O8RXfTEArhH/TTFhlsS9QhY0uMBwH//hvp5EqDDU8VV5gWGhC+y4xEfq6CQtnohMGF0g3xl2RO3F6etzWDwfH4hsQEp+Q0mdnJ/95eTlxQmD4RS0ATscH4wPeMi7SLW0A0v7DwT3CcV6x2D/358TOoZFeEcTb6ROBDfFbt2R0ysxfGHIh48J00xULhKvWa9nMuLbYDYbHv6pwcAceJqJhQya4SQG25UStX0r+Gjcnrzpnh2ewkfeJR6F3jNGy3QxnWyRC5GJW1zdewnZTDdZTxsZWruirQoD2QcXkD0Wf3pyKTLBnW+frt4mutp9sPZHce3z2BYA/2VS/ajAet1S4c1mu76d+qhE52C/moM03Ww2/waNF7is","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Resend request mail","permalink":"/docs/API-docs/v1.2/resendrequestmail"},"next":{"title":"Get Formdata","permalink":"/docs/API-docs/v1.2/getformdata"}}');var i=s(74848),r=s(28453),o=s(57742),a=s.n(o),p=s(78178),c=s.n(p),h=s(19624),l=s.n(h),d=s(96226),u=s.n(d),g=(s(77675),s(19365),s(51107)),m=s(21312);const b={id:"getsignerips",title:"Get Signer IPs",description:"The Get Signer IPs API enables you to retrieve IPs of signers who signed the document.",sidebar_label:"Get Signer IPs",hide_title:!0,hide_table_of_contents:!0,api:"eJzNWFFzG7cR/isbPDQ250xKspKml5e4raqo1dgeSx4/SBwNeNjjwcIBCLBHisPhTB7yD/LU1/40/5LO4u7IoyTbcdvJ9EU6Atjdb3eB3Q9YC5LzKPIr8VdXNDVaimKaCYWxCNqTdlbk4rJCOEWCCz23GODsdYQXr88ArZwZjLByDZCDgBQ0LjDNuxJiWh1hWbn2WwFVCKqzM7621/alI8zhstKtRh3BWbMCuZDasHIoXYBLlHUEaRWcWMLgg44I3kgbx9dWZMJ5DJKhnimRizlSa1n7KDLhZZA1EgZ2ci2srFHkogdxo5XIhGYnvaRK3Pfczd5jQWeK/ekDJDIR8KdGB1Qip9BgJiKtDKuNuvYGRSbwzhunUOSlNJEXFBXWUuRrQSufVlLQdi4yUbpQSxqO4J1MWnIh/3xUFEeVn1Vis5my2eidjRhZ0dHBAf/bxxubosAYy8bANioiE4WzxMjztZDeG12kicn7yELrh+hatzl6gdWQbk320fhSP/52qm+Pns+qt38Xm0y02bnh9Oz0yBDkilNBWMfPI8FaavMYjJ3R9w5niD90A+PC1Wxc+xupVMAYPy19+Kfn48Pvvh0fjw+/+6PYbDJxVyeD3QZqnTjz8U2XE1ZOmsxuMnm4+Y9E9yaTiuPHsn3haqRK2zks0RIsg7PzDLxBGREorEDOpbZgJGH46n+3DTAEFz4dvi9DthkEQFujLd70W/3m+ODg5nAbhOOHQeiPJVhHULrGqt/X1cfsf9qh45vnW4e+eejQmV1Io1UqiJfuFu3v68/QPLXmH+5h3S5K82LP2eF462TEogmaVqn+3j2TXj9r5/OrKVc13imuq9ypYFMlcjHZFvHJelCtN4IVhkVfz5tgRC4qIh/zySRKq2bubuw8WpY3chb55E+k15PF4fhIbLL7MtL7L1qPzbMvFYkk59rOPyc33cXqgvPZpmwvYrt66fU/kAtml5Dhqq6hVSgVhpQ8bUuXhLs0vfJouZmnJCfj9xvfOzSFq5H7Ojft0agX+fDLv7ZSo9G2m6ftmFr6qyaAd0sM3IS4aZcG7zT38sQZ6jS3JQ0RZW0wRrMCbQnnQRKC0nNN0iTWwDWkkF7OtNG8i3mZY+kAg4MQx/CuQqow8NTXAUGCwgUa3vwgG3K1JFbV44WlC7elccuYgYRZE7XFGAFtJW3BC/tMZOACSAu4ox6RAqPWLTZnKciCoJZWzpF1ZzAMlkKjebtCcLMmEkRnmgQZSGrjAtOiziGLqGIK4gnzh4DAo4WrfcCKt80CYd5ohTGDwimEmA4tu2AVzDASeMaiC4ystLHGFbcpgWVjDHjHNURLw3RmiJHFKUgbuYu3WPocbAPmg2NqgS3A0ehtRM7wuba3MR+Nru0zuNruq3c4i5pw+qQ/Asvl8sHWf7ovc6rpx2YGb9C7qMmF1U56rqlqZum4DJVsf7SaTtFi2j+Dw7DToVwRH54+Hp1UaPzkAol3SJy8eH2Wyu5T+PDzr3COMlio3LLdrUUT0Kxg3pviyLWZb8O2rZqJucqGKo540W4+po0YqY/gu0rSh5//GeElLkHb7kixK6MR0+1LrD13SPgD7P0815FGoxwC1m6BChprkVMjwwp2dDdBi8gDhAp8wFIbA0qShDK4uuPnA4kxm74WpTZ442WMSxfUtdgtAKkUKkZaBGQg1CHKoPFqf6BbsTtumqrBtAqypN1sC9W0dwYIrqF2A/vgFloh9GhSUH1whEXySZU9aGmMW964skzNltX8JuTJ8j3wA/tJKzSRw0muu/BwQVA6tp+twW2lYnxUoQ5bbT3AjhMGZ/BxZHxK+ytT2735lO4H6kFcPxvoB5lih30zM7q47/AYXhQFeg7sQpoGYw6jUYtoNIInCkvZGHqawWi00LjkUf6WnrPEv8bdBTFCzYWukgsEScCkj8B1UZLUBISlVnOk76FVNBSwrpuM30OvOkItV50+u+rnk6uuIZADxd3NrLtgiux++9zvcgFLDBy7lN7dofa6O8RXfTEArhH/TTFhlsS9QhY0uMBwH//hvp5EqDDU8VV5gWGhC+y4xEfq6CQtnohMGF0g3xl2RO3F6etzWDwfH4hsQEp+Q0mdnJ/95eTlxQmD4RS0ATscH4wPeMi7SLW0A0v7DwT3CcV6x2D/358TOoZFeEcTb6ROBDfFbt2R0ysxfGHIh48J00xULhKvWa9nMuLbYDYbHv6pwcAceJqJhQya4SQG25UStX0r+Gjcnrzpnh2ewkfeJR6F3jNGy3QxnWyRC5GJW1zdewnZTDdZTxsZWruirQoD2QcXkD0Wf3pyKTLBnW+frt4mutp9sPZHce3z2BYA/2VS/ajAet1S4c1mu76d+qhE52C/moM03Ww2/waNF7is",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},D=void 0,x={},A=[];function W(e){const t={p:"p",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(g.default,{as:"h1",className:"openapi__heading",children:"Get Signer IPs"}),"\n",(0,i.jsx)(a(),{method:"get",path:"/signerips/{document_id}",context:"endpoint"}),"\n",(0,i.jsx)(t.p,{children:"The Get Signer IPs API enables you to retrieve IPs of signers who signed the document."}),"\n",(0,i.jsx)(t.p,{children:"Note: This API is only available for Teams and Enterprise plans."}),"\n",(0,i.jsx)(g.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,i.jsx)(m.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,i.jsx)(c(),{...s(949)}),"\n",(0,i.jsx)(l(),{...s(84823)}),"\n",(0,i.jsx)(u(),{...s(62393)})]})}function f(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(W,{...e})}):W(e)}},949(e){e.exports=JSON.parse('{"parameters":[{"name":"document_id","in":"path","description":"objectId of Document","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"aB2cc2hpbh"}}]}')},84823(e){e.exports={title:"Body"}},62393(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"FGik23bhUJ"},"signer_ips":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"joebee@example.com"},"ip_address":{"type":"string","example":"193.186.4.187"}},"xml":{"name":"signerIpsResponse"},"title":"signer_ips"}}},"xml":{"name":"signerIpsResponse"},"title":"signerIpsResponse"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"Document not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Document not found!"}},"title":"inline_response_404_3"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/b9fdab4b.7731be4d.js b/assets/js/b9fdab4b.7731be4d.js new file mode 100644 index 000000000..da54eaf6f --- /dev/null +++ b/assets/js/b9fdab4b.7731be4d.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[8089],{86761(e,t,s){s.r(t),s.d(t,{assets:()=>b,contentTitle:()=>I,default:()=>N,frontMatter:()=>g,metadata:()=>a,toc:()=>P});const a=JSON.parse('{"id":"API-docs/v1.2/getsignerips","title":"Get Signer IPs","description":"The Get Signer IPs API enables you to retrieve IPs of signers who signed the document.","source":"@site/docs/API-docs/v1.2/getsignerips.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/getsignerips","permalink":"/docs/API-docs/v1.2/getsignerips","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getsignerips","title":"Get Signer IPs","description":"The Get Signer IPs API enables you to retrieve IPs of signers who signed the document.","sidebar_label":"Get Signer IPs","hide_title":true,"hide_table_of_contents":true,"api":"eJzNGdtuG7n1V04ZoLCFkWQnabvVFtt1HMfrNk0My24eLMNDDY80jDjkLMmRLNgC9qHoBxR96Wt/ou/9lHxJcciZkWQ7yaZbLPqQ2CbP/c4zt8zzqWODS/bSZFWB2jt2lTCBLrOy9NJoNmDnOcIxehjKqUYLJ6cODk5PADUfK3SwNBV4Axa9lTjHcG8m4AK0g0Vu4u8CfI4gaj69kR7pN8bjAM5zGSlKB0arJfA5l4qIw8RYOEdeOOBawJH2aEsrHUKpuHa9kWYJMyVaTqKeCDZgU/SRsywdS1jJLS/QoyUlb5nmBbIBa4S4loIlTJKSJfc5u6+5Gb/HzJ8I0qcxEEuYxe8raVGwgbcVJsz5pSKyThalQpYwvCmVEcgGE64cAWQ5FpwNbplflgHSW6mnLGETYwvuN0/whgcqA8ZfPM2yp3k5ztlqdUVsXWm0Q0eEnu7t0Y9teV2VZejcpFLQWoUlLDPak+SDW8bLUsksXPTfO0K6fShdVJusZ4mMl5FlY40v1ePVsZw9fTbOL/7AVgmL3rkm96zpcGv5klzhsXCflwQLLtVjYqyZvjc4Rvy2PuhlpiDmsrzmQlh07tPY+7991tv/6te95739r37DVquE3RSBYR1AUYmT0p3VPiHiXnq1vgwarv4r1K3LQOL5Y94emgJ9LvUUFqg9LKzR0wRKhdwheLsEPuVSg+Ie7S/+d2GA1hr7afN9mWSrDQNIraTG6ybUr5/v7V3vt0Z4/tAITVqCNh4mptLi51X1Mf6fVuj59bNWoV89VOhEz7mSIhTEczND/fPqs8neR/YPY1hGoHDPtpTdPI9KOswqK/0y1N+bLi9lN94PLq+oqlGkmLpyh4LtczZg/baI9283qvWKEUE7b+p5ZRUbsNz70g36fce1GJubnilRE77iY0eZ3+el7M/3e0/ZKrmPw8vyi+Cx6n4pivN8KvX0c3hXa1sNyZ/RZVsWW9fLUv4RqWDWDtmEqhtajlygDc6TemICcu2mtyVqaubByYH5/cb3BBqYD3/5ZwtGLfsb6HRoICBFus5UNsPQGgM9rjxazb2cI3z44e8wrqTyoYkLnKOiUHQJeFs5jwLGS8C2o7tep0P0N/lO5byeLzhkhgLUYwKlNaLKSNCuRS6WgF2yKPeVDXOBp14EPremmubAwUk9VZjA2dHwnDrjwelJD4aoRTuLuCBiSySBgms+RfBYED0MMvNsFkCoqjnPfeVAarDIFXhZYBImFF55U3CPJLQl7aRdjzyg5ASzZaaicbhSsJA+N5WHOWphLCiTzbpSh9mo2+3SjydPaPbyxHXoufUo6PRojnYJNIeg81BUzkPGrV1Gvm3ukoQ0dKUb8ZFCjIzAJE3Tkd64HMDviML64JsaZqQ7nQ9//RtcfmcWNO1NUdN8gfcYXu00QS9M5h5GO532c1RlfxiVcv2D05NQ5naj/98YD448ucjRIrEa41Tq38MFtY4codOp0xxQz6U1mkzb6cBO+qPLQLpLdEtrvKF8ar3AJxPMgqkVRbDgnt9zxaGxCIe85GOpJFVVOr+DQ+5xauwS7uBdzn0I2YxrEAbuRvqu2+2GfwTa6bSTdqcDd3BokVNUO9QigaoU4S+LczOrY0ogxf06PLuN29fhW1M+b+I1UH5RSSXAYuXCKN0Gc1AXSovdUvEMBSykoKn56yADWcZoBGMpC5btGF+zGKKadCk/A4vjJgocHddT/lqs1q41FZB6Ln1oXTBRZtEQPa3GSmawLf4w5xaBQxkvm9RTUs9C+mjTUFXSeWhm8obmS8snHt4ZOyNOkSKf44Z0xm7YhDsQhBEfGhOpuZIx4Io4pjR0D432PKud96dYJ0IO1MJk8R7GxswoxKaWFwX3MuNKLRsir4wSaCONt3bKNfFaSya1kwLbEgwvLYXjJCI1NN7hODdmFomcYYYEQ+WoS+UIcF4PJXJSTwsOYmRaMAsNqEVppPYNuQvXCHTWPOR4lplK+2CRzKKQHqiT0KBPHrzbTg0K/A8//MPBG1xQ3WkaxhNKG4WcjNN4uOHB1Uinx0fn0G880R9IkQaO2+fk4xRy8uAYUYPzFnlBo5UI0WBRVFpw7WH94gMKIIuFmaMIJDud0uJEKhVSm56b2izo4VpZouOQcD2qJUysKRqPrgl2OtQaZhSG7VsMkDuJltImM9pVBfYarU+5cwtjRffUGo8ZtbzTl69gWJWlsX6k6R7SEZtIhddlDTxiaVO1mzwfG7GkcqhhYWzgHjIYdWaXZU3V9Rq6KMDowUinp2+H59DPQn1pzJjCv/8F6enFA4uH4w2EJhj7gwbuehssZEsD9eDiHr9wQTWCTJo29nk7mZADw16BtKLUskaN9BA92YUrZRbXJkJdE+qIDWh6QLiD8LJOwWj4iKIhhh7R1Bug57nMpFfLeolBtUDIWCdrfm3BodEAeZa3xaL1b70POTOK+gANRWldLVOIA3iIL55lWFJhIZ3qt6E1CsnTE4lKAM+scS4MBEELyi5rKo+uB+e5RQSCj/HsGi8PYush7lTsMedzScl9v+HUMqXQ2RE44ZXyu6F0hZmhHqqoMtDjzIfSv56mYmeIJSKdS1wQnbbauK2FTjCURYKKW5y6SNfdBYI3m/qc8rK0Zh7JHXIdM5v6TQOON2S1unVEaeoSH5jdtaWF27HRcGjKJewcHu6ScLKUVEdH+gA0LsjsWba2dp32rSGBK6OnoeKSPngjXZgB0hEbb+IZ3eqatMGQxLYRoq1tgq0X+7Gft848or0F1BsIdKFzoaB8b2W0dSXnNNCNje5mpNlmHYew/QCjM9x2gHStQ0UPXssZrnVISPwtaWDHVVlOjS9myTrjpUh3qXXNpajtEEUjf1kpar83FoA5VxUmoeHEKkWWVZIMS90UsCj9EsKGB3bSy6t092swhfSBSjStNyB1jrY+3CZ9bwQ7aJeDR+v5r57DNk4oJ2jbcHH2+pEZbBhHxNDvvmBubAeW9gmyTeGTL7wW++gCznD6APlzL8v0fsf9M1onTShSv4QXPJstuBUODk1Rci/DhLokUEKm4JhUNIKMG8BuVgOqOAHDfD+E8Xy/t98+UJoxwcWW6HPjEOaRcSxI62WtobYlHYwbuweq2sDYYuyaWc71lBKBZoSNRi2p8Isqi7kQ5CXSJjxHuYJKK3QOjM/RLmhW0oZifNscFw7pefda6lkIhy5cthPUOxw76XH9PFksFg8svRtwXlVKtcvekHCfedREtGPpv6vGcIalcdIbu1xjTaXPq3Hw5SZu+0dNoJml28XPT3lMBZLnaIuwix+incvsM+r3PYH3d8NS/d7aYXs7YHGCluqO23oK8lLWz87LRg4g8X6KHrRdqkfqjcUv7T++vU8nLKJIhbeTWt96B/NpfVnClMyQdq3rBdfB8elrmD/r7bFkY5nzI3zZf31yePRmeETC1GlC6+TeXm+PjkrjfMH1BqftDyv3FzG3683f//tnmHoz5fHG90vFZVgMBtvd1ku9S7b5ZWaw+RHmKmG5cZ5gbm+pflxYtVrR8fcVWtodXiVszq0kccLmrx7XRPuN5aN22zmrn4a78JHvOY+K3mzaNK3ZQiNiA8YSNsPlvS9Iq6tV0qzbSLQIcRDGvg3cB4vbre3n8dE5SxivyFCba75ZWPPVvxD1R+Xa3v9FAeh/WkY+inB7G1eIq1ULH68+ilEr2ECTka5Wq9V/APX5AEI=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Resend request mail","permalink":"/docs/API-docs/v1.2/resendrequestmail"},"next":{"title":"Get Formdata","permalink":"/docs/API-docs/v1.2/getformdata"}}');var n=s(74848),o=s(28453),i=s(57742),r=s.n(i),c=s(78178),l=s.n(c),p=s(19624),d=s.n(p),m=s(96226),u=s.n(m),S=(s(77675),s(19365),s(51107)),h=s(21312);const g={id:"getsignerips",title:"Get Signer IPs",description:"The Get Signer IPs API enables you to retrieve IPs of signers who signed the document.",sidebar_label:"Get Signer IPs",hide_title:!0,hide_table_of_contents:!0,api:"eJzNGdtuG7n1V04ZoLCFkWQnabvVFtt1HMfrNk0My24eLMNDDY80jDjkLMmRLNgC9qHoBxR96Wt/ou/9lHxJcciZkWQ7yaZbLPqQ2CbP/c4zt8zzqWODS/bSZFWB2jt2lTCBLrOy9NJoNmDnOcIxehjKqUYLJ6cODk5PADUfK3SwNBV4Axa9lTjHcG8m4AK0g0Vu4u8CfI4gaj69kR7pN8bjAM5zGSlKB0arJfA5l4qIw8RYOEdeOOBawJH2aEsrHUKpuHa9kWYJMyVaTqKeCDZgU/SRsywdS1jJLS/QoyUlb5nmBbIBa4S4loIlTJKSJfc5u6+5Gb/HzJ8I0qcxEEuYxe8raVGwgbcVJsz5pSKyThalQpYwvCmVEcgGE64cAWQ5FpwNbplflgHSW6mnLGETYwvuN0/whgcqA8ZfPM2yp3k5ztlqdUVsXWm0Q0eEnu7t0Y9teV2VZejcpFLQWoUlLDPak+SDW8bLUsksXPTfO0K6fShdVJusZ4mMl5FlY40v1ePVsZw9fTbOL/7AVgmL3rkm96zpcGv5klzhsXCflwQLLtVjYqyZvjc4Rvy2PuhlpiDmsrzmQlh07tPY+7991tv/6te95739r37DVquE3RSBYR1AUYmT0p3VPiHiXnq1vgwarv4r1K3LQOL5Y94emgJ9LvUUFqg9LKzR0wRKhdwheLsEPuVSg+Ie7S/+d2GA1hr7afN9mWSrDQNIraTG6ybUr5/v7V3vt0Z4/tAITVqCNh4mptLi51X1Mf6fVuj59bNWoV89VOhEz7mSIhTEczND/fPqs8neR/YPY1hGoHDPtpTdPI9KOswqK/0y1N+bLi9lN94PLq+oqlGkmLpyh4LtczZg/baI9283qvWKEUE7b+p5ZRUbsNz70g36fce1GJubnilRE77iY0eZ3+el7M/3e0/ZKrmPw8vyi+Cx6n4pivN8KvX0c3hXa1sNyZ/RZVsWW9fLUv4RqWDWDtmEqhtajlygDc6TemICcu2mtyVqaubByYH5/cb3BBqYD3/5ZwtGLfsb6HRoICBFus5UNsPQGgM9rjxazb2cI3z44e8wrqTyoYkLnKOiUHQJeFs5jwLGS8C2o7tep0P0N/lO5byeLzhkhgLUYwKlNaLKSNCuRS6WgF2yKPeVDXOBp14EPremmubAwUk9VZjA2dHwnDrjwelJD4aoRTuLuCBiSySBgms+RfBYED0MMvNsFkCoqjnPfeVAarDIFXhZYBImFF55U3CPJLQl7aRdjzyg5ASzZaaicbhSsJA+N5WHOWphLCiTzbpSh9mo2+3SjydPaPbyxHXoufUo6PRojnYJNIeg81BUzkPGrV1Gvm3ukoQ0dKUb8ZFCjIzAJE3Tkd64HMDviML64JsaZqQ7nQ9//RtcfmcWNO1NUdN8gfcYXu00QS9M5h5GO532c1RlfxiVcv2D05NQ5naj/98YD448ucjRIrEa41Tq38MFtY4codOp0xxQz6U1mkzb6cBO+qPLQLpLdEtrvKF8ar3AJxPMgqkVRbDgnt9zxaGxCIe85GOpJFVVOr+DQ+5xauwS7uBdzn0I2YxrEAbuRvqu2+2GfwTa6bSTdqcDd3BokVNUO9QigaoU4S+LczOrY0ogxf06PLuN29fhW1M+b+I1UH5RSSXAYuXCKN0Gc1AXSovdUvEMBSykoKn56yADWcZoBGMpC5btGF+zGKKadCk/A4vjJgocHddT/lqs1q41FZB6Ln1oXTBRZtEQPa3GSmawLf4w5xaBQxkvm9RTUs9C+mjTUFXSeWhm8obmS8snHt4ZOyNOkSKf44Z0xm7YhDsQhBEfGhOpuZIx4Io4pjR0D432PKud96dYJ0IO1MJk8R7GxswoxKaWFwX3MuNKLRsir4wSaCONt3bKNfFaSya1kwLbEgwvLYXjJCI1NN7hODdmFomcYYYEQ+WoS+UIcF4PJXJSTwsOYmRaMAsNqEVppPYNuQvXCHTWPOR4lplK+2CRzKKQHqiT0KBPHrzbTg0K/A8//MPBG1xQ3WkaxhNKG4WcjNN4uOHB1Uinx0fn0G880R9IkQaO2+fk4xRy8uAYUYPzFnlBo5UI0WBRVFpw7WH94gMKIIuFmaMIJDud0uJEKhVSm56b2izo4VpZouOQcD2qJUysKRqPrgl2OtQaZhSG7VsMkDuJltImM9pVBfYarU+5cwtjRffUGo8ZtbzTl69gWJWlsX6k6R7SEZtIhddlDTxiaVO1mzwfG7GkcqhhYWzgHjIYdWaXZU3V9Rq6KMDowUinp2+H59DPQn1pzJjCv/8F6enFA4uH4w2EJhj7gwbuehssZEsD9eDiHr9wQTWCTJo29nk7mZADw16BtKLUskaN9BA92YUrZRbXJkJdE+qIDWh6QLiD8LJOwWj4iKIhhh7R1Bug57nMpFfLeolBtUDIWCdrfm3BodEAeZa3xaL1b70POTOK+gANRWldLVOIA3iIL55lWFJhIZ3qt6E1CsnTE4lKAM+scS4MBEELyi5rKo+uB+e5RQSCj/HsGi8PYush7lTsMedzScl9v+HUMqXQ2RE44ZXyu6F0hZmhHqqoMtDjzIfSv56mYmeIJSKdS1wQnbbauK2FTjCURYKKW5y6SNfdBYI3m/qc8rK0Zh7JHXIdM5v6TQOON2S1unVEaeoSH5jdtaWF27HRcGjKJewcHu6ScLKUVEdH+gA0LsjsWba2dp32rSGBK6OnoeKSPngjXZgB0hEbb+IZ3eqatMGQxLYRoq1tgq0X+7Gft848or0F1BsIdKFzoaB8b2W0dSXnNNCNje5mpNlmHYew/QCjM9x2gHStQ0UPXssZrnVISPwtaWDHVVlOjS9myTrjpUh3qXXNpajtEEUjf1kpar83FoA5VxUmoeHEKkWWVZIMS90UsCj9EsKGB3bSy6t092swhfSBSjStNyB1jrY+3CZ9bwQ7aJeDR+v5r57DNk4oJ2jbcHH2+pEZbBhHxNDvvmBubAeW9gmyTeGTL7wW++gCznD6APlzL8v0fsf9M1onTShSv4QXPJstuBUODk1Rci/DhLokUEKm4JhUNIKMG8BuVgOqOAHDfD+E8Xy/t98+UJoxwcWW6HPjEOaRcSxI62WtobYlHYwbuweq2sDYYuyaWc71lBKBZoSNRi2p8Isqi7kQ5CXSJjxHuYJKK3QOjM/RLmhW0oZifNscFw7pefda6lkIhy5cthPUOxw76XH9PFksFg8svRtwXlVKtcvekHCfedREtGPpv6vGcIalcdIbu1xjTaXPq3Hw5SZu+0dNoJml28XPT3lMBZLnaIuwix+incvsM+r3PYH3d8NS/d7aYXs7YHGCluqO23oK8lLWz87LRg4g8X6KHrRdqkfqjcUv7T++vU8nLKJIhbeTWt96B/NpfVnClMyQdq3rBdfB8elrmD/r7bFkY5nzI3zZf31yePRmeETC1GlC6+TeXm+PjkrjfMH1BqftDyv3FzG3683f//tnmHoz5fHG90vFZVgMBtvd1ku9S7b5ZWaw+RHmKmG5cZ5gbm+pflxYtVrR8fcVWtodXiVszq0kccLmrx7XRPuN5aN22zmrn4a78JHvOY+K3mzaNK3ZQiNiA8YSNsPlvS9Iq6tV0qzbSLQIcRDGvg3cB4vbre3n8dE5SxivyFCba75ZWPPVvxD1R+Xa3v9FAeh/WkY+inB7G1eIq1ULH68+ilEr2ECTka5Wq9V/APX5AEI=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},I=void 0,b={},P=[];function f(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(S.default,{as:"h1",className:"openapi__heading",children:"Get Signer IPs"}),"\n",(0,n.jsx)(r(),{method:"get",path:"/signerips/{document_id}",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"The Get Signer IPs API enables you to retrieve IPs of signers who signed the document."}),"\n",(0,n.jsx)(t.p,{children:"Note: This API is only available for Teams and Enterprise plans."}),"\n",(0,n.jsx)(S.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,n.jsx)(h.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,n.jsx)(l(),{...s(949)}),"\n",(0,n.jsx)(d(),{...s(84823)}),"\n",(0,n.jsx)(u(),{...s(62393)})]})}function N(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(f,{...e})}):f(e)}},949(e){e.exports=JSON.parse('{"parameters":[{"name":"document_id","in":"path","description":"objectId of Document","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"aB2cc2hpbh"}}]}')},84823(e){e.exports={title:"Body"}},62393(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"FGik23bhUJ"},"signer_ips":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"joebee@example.com"},"ip_address":{"type":"string","example":"193.186.4.187"}},"xml":{"name":"signerIpsResponse"},"title":"signer_ips"}}},"xml":{"name":"signerIpsResponse"},"title":"signerIpsResponse"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"Document not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Document not found!"}},"title":"inline_response_404_3"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/bd0e2f4c.6a40aeb6.js b/assets/js/bd0e2f4c.6a40aeb6.js deleted file mode 100644 index 55ec9851b..000000000 --- a/assets/js/bd0e2f4c.6a40aeb6.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[2403],{17886(e,t,o){o.r(t),o.d(t,{assets:()=>R,contentTitle:()=>y,default:()=>V,frontMatter:()=>k,metadata:()=>s,toc:()=>m});const s=JSON.parse('{"id":"API-docs/v1.2/delete-webhook","title":"Delete Webhook","description":"The Delete Webhook API allow you to delete webhook url","source":"@site/docs/API-docs/v1.2/delete-webhook.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/delete-webhook","permalink":"/docs/API-docs/v1.2/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":"eJy9V81u20YQfpXJHtqEoCUnTQ9VLjUaIzVqJEHtwAfbMFbkUNx4ubvdHUoWBAE59A166rWPlicpZpeUKDm/bdGLRO78ffO7w5UgOQticikucFpbeyuuc1FiKLxypKwRE3FeIzxHjYTQ8cDR6xOQWtsFLG0LZKFM9EVHb70WubAOvWQlJ6WYiMTSW8mFx+CsCRjEZCWeHB7y367hs7YoMISq1bBRJXJRWENoiPmlc1oVkTB+G1hoJUJRYyP5iZYOxUTY6VssSOTCeVZDKpn0GFpNA75AXpmZyAXeycZpPur9TdhLCBtEevlArNe5IEWRUxmtDN70Tt08OTy8+UGs18zz9PDpfefeBPRgLEFlW1M++O/8Qu+t/7Rb+7Y/5QiD7934/r4bJ2YutSpjRZzbWzT/rydD85TMM9S7RrOckU1yKTJFuthxdXienAxYtF7RUkwuV+LuQDp1kOiTy+v1dS4apNpuy5kxS6rFRIwXm8oO6OfoQ1TBnTARNZELk/E4SFNO7d3IOjRBzYyW0zAqbDOWTo3nj0dPxDrfl5HOfRU/tgdfKxJIzpSZfU7uehueM05hytJOkDa5kk79gkuR9zkYcuVCcenUKEv0MV/KVDYKd5l55dCcqZmJeY3G94fSBerCNsizh2qELOtF3v/+10Yqy6C0RdugoViBoytzZV61HpxdoOe5Ik0JlcY7NdUYxbCJtNAPtoCy0RiCXoIyhDMvCaFUM0VSA8dJmRkU0smp0ooLl9ksS3sY1H4YwUWNVKNn0rceQUKJc9Rc7yBbso0kVtXjhYX1t5W2i5CDhGkblMEQAE0tTcGMfSZysB6kATSE3nkVEAJ5Rq0SNmvIy4KgkUbOkHXnMAxWiVpxuYK30zYQBKvbCBlIKm09ltA7ZBDLEIN4fOeYBHxa2MZ5rLls5gizVpUYcihsiRBin7ILpoQpBgLHWFSBgZW2RtviNiaQRyo4y2NDSQ222sHI4uSlCZX1TcLS52ATMOctz2ZMALPsTUDO8Kkyt2GSZVfmAC43dXWB06AIrx/2LbBYLO6V/qNdmReKfm6n8Cs6GxRZv9xKzxTV7TS2y1DJ5iVpeoEGY/0MmmGro7RFuN99fDquUbvxGRJXSBgfvT6Jk/YRvH/3B5yi9AZqu0jVWrQe9RJmvSmOXMp8CttmUEJlY+HVHPEiFZ/H31oM1Efwopb0/t2fAV7iApTpWopdybIXSHCOjdNs5BvYeT1VgbJsAh4bO8cSWmOQUyP9Epz0skHiemNoAfmAr1bnsVJaQylJQuVtE7sL/UBixKavRKU03jgZwsL68kpsGUCWJZaMtPDIQKhDlEPryt2DjmPbborqAbn0sqItNUHVVcQE3raUCth5O1clQo8mBtV5S1hEn8qqBx23pRtbVfF2ZTVfhDxa3gM/sJ92sDZwOMkCGslzzHJ3hPSYDG4mFeOjGpXfaOsBpmjfeKvxw8i4SxNTgHRhc5fuBupeXD8b6HuZYoddO9Wq2Hd4BEdFgY4DO5e6xTCBLEuIsgwelljJVtOjHLJsrnDBp/wsHWeJ30Zw1uFveNDVco4gCTTKQGC7KElqPcJClTOkZ5AUDQWM7YjhGfSqAzRy2ekzy54eXbUtgRwo5hZTPo7h0RVfhXvX5+4t57FCz7GL6d02tVNdE1/2wwB4RvybYcKLEd8Vsoh7GzZS6XSP/7ivJ+5Q6JvwqjpDP1cFdrvER+boODKPRS60KtAEHOxmRy9en8L8u9GhyAdLyReM1PHpyU/HL8+OGQynIAXs8ehwdMhHzgZqpBlY2v2E2V8oVtul9Z9/8HS7D+EdjZ2WKm6b0atVtyZeisX2M6u2gfhotZrKgG+8Xq/5+LcWPe+f17mYS6+4j+P2mfcbE++Vt7jk6MWGEMyo27R27a3bOzvr8+PT4/NjkQue+7vL2m1c1roHNtCTzHKgfneLSxj4l1fKDwqsVmkRXK83/In0UYnOx56bY3i9Xq//BkDpNFw=","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Save or Update Webhook","permalink":"/docs/API-docs/v1.2/save-update-webhook"},"next":{"title":"Create Folder","permalink":"/docs/API-docs/v1.2/createfolder"}}');var i=o(74848),l=o(28453),n=o(57742),p=o.n(n),d=o(78178),r=o.n(d),c=o(19624),a=o.n(c),b=o(96226),u=o.n(b),h=(o(77675),o(19365),o(51107));o(21312);const k={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:"eJy9V81u20YQfpXJHtqEoCUnTQ9VLjUaIzVqJEHtwAfbMFbkUNx4ubvdHUoWBAE59A166rWPlicpZpeUKDm/bdGLRO78ffO7w5UgOQticikucFpbeyuuc1FiKLxypKwRE3FeIzxHjYTQ8cDR6xOQWtsFLG0LZKFM9EVHb70WubAOvWQlJ6WYiMTSW8mFx+CsCRjEZCWeHB7y367hs7YoMISq1bBRJXJRWENoiPmlc1oVkTB+G1hoJUJRYyP5iZYOxUTY6VssSOTCeVZDKpn0GFpNA75AXpmZyAXeycZpPur9TdhLCBtEevlArNe5IEWRUxmtDN70Tt08OTy8+UGs18zz9PDpfefeBPRgLEFlW1M++O/8Qu+t/7Rb+7Y/5QiD7934/r4bJ2YutSpjRZzbWzT/rydD85TMM9S7RrOckU1yKTJFuthxdXienAxYtF7RUkwuV+LuQDp1kOiTy+v1dS4apNpuy5kxS6rFRIwXm8oO6OfoQ1TBnTARNZELk/E4SFNO7d3IOjRBzYyW0zAqbDOWTo3nj0dPxDrfl5HOfRU/tgdfKxJIzpSZfU7uehueM05hytJOkDa5kk79gkuR9zkYcuVCcenUKEv0MV/KVDYKd5l55dCcqZmJeY3G94fSBerCNsizh2qELOtF3v/+10Yqy6C0RdugoViBoytzZV61HpxdoOe5Ik0JlcY7NdUYxbCJtNAPtoCy0RiCXoIyhDMvCaFUM0VSA8dJmRkU0smp0ooLl9ksS3sY1H4YwUWNVKNn0rceQUKJc9Rc7yBbso0kVtXjhYX1t5W2i5CDhGkblMEQAE0tTcGMfSZysB6kATSE3nkVEAJ5Rq0SNmvIy4KgkUbOkHXnMAxWiVpxuYK30zYQBKvbCBlIKm09ltA7ZBDLEIN4fOeYBHxa2MZ5rLls5gizVpUYcihsiRBin7ILpoQpBgLHWFSBgZW2RtviNiaQRyo4y2NDSQ222sHI4uSlCZX1TcLS52ATMOctz2ZMALPsTUDO8Kkyt2GSZVfmAC43dXWB06AIrx/2LbBYLO6V/qNdmReKfm6n8Cs6GxRZv9xKzxTV7TS2y1DJ5iVpeoEGY/0MmmGro7RFuN99fDquUbvxGRJXSBgfvT6Jk/YRvH/3B5yi9AZqu0jVWrQe9RJmvSmOXMp8CttmUEJlY+HVHPEiFZ/H31oM1Efwopb0/t2fAV7iApTpWopdybIXSHCOjdNs5BvYeT1VgbJsAh4bO8cSWmOQUyP9Epz0skHiemNoAfmAr1bnsVJaQylJQuVtE7sL/UBixKavRKU03jgZwsL68kpsGUCWJZaMtPDIQKhDlEPryt2DjmPbborqAbn0sqItNUHVVcQE3raUCth5O1clQo8mBtV5S1hEn8qqBx23pRtbVfF2ZTVfhDxa3gM/sJ92sDZwOMkCGslzzHJ3hPSYDG4mFeOjGpXfaOsBpmjfeKvxw8i4SxNTgHRhc5fuBupeXD8b6HuZYoddO9Wq2Hd4BEdFgY4DO5e6xTCBLEuIsgwelljJVtOjHLJsrnDBp/wsHWeJ30Zw1uFveNDVco4gCTTKQGC7KElqPcJClTOkZ5AUDQWM7YjhGfSqAzRy2ekzy54eXbUtgRwo5hZTPo7h0RVfhXvX5+4t57FCz7GL6d02tVNdE1/2wwB4RvybYcKLEd8Vsoh7GzZS6XSP/7ivJ+5Q6JvwqjpDP1cFdrvER+boODKPRS60KtAEHOxmRy9en8L8u9GhyAdLyReM1PHpyU/HL8+OGQynIAXs8ehwdMhHzgZqpBlY2v2E2V8oVtul9Z9/8HS7D+EdjZ2WKm6b0atVtyZeisX2M6u2gfhotZrKgG+8Xq/5+LcWPe+f17mYS6+4j+P2mfcbE++Vt7jk6MWGEMyo27R27a3bOzvr8+PT4/NjkQue+7vL2m1c1roHNtCTzHKgfneLSxj4l1fKDwqsVmkRXK83/In0UYnOx56bY3i9Xq//BkDpNFw=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},y=void 0,R={},m=[];function O(e){const t={p:"p",...(0,l.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Delete Webhook"}),"\n",(0,i.jsx)(p(),{method:"delete",path:"/webhook",context:"endpoint"}),"\n",(0,i.jsx)(t.p,{children:"The Delete Webhook API allow you to delete webhook url"}),"\n",(0,i.jsx)(r(),{parameters:void 0}),"\n",(0,i.jsx)(a(),{...o(1356)}),"\n",(0,i.jsx)(u(),{...o(58326)})]})}function V(e={}){const{wrapper:t}={...(0,l.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(O,{...e})}):O(e)}},1356(e){e.exports={title:"Body"}},58326(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Webhook deleted successfully!"}},"title":"inline_response_200_9"}}}},"404":{"description":"User not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"User not found!"}},"title":"inline_response_404"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/bd0e2f4c.acc0fa29.js b/assets/js/bd0e2f4c.acc0fa29.js new file mode 100644 index 000000000..98d3a5fdc --- /dev/null +++ b/assets/js/bd0e2f4c.acc0fa29.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[2403],{17886(e,t,o){o.r(t),o.d(t,{assets:()=>k,contentTitle:()=>S,default:()=>f,frontMatter:()=>b,metadata:()=>s,toc:()=>z});const s=JSON.parse('{"id":"API-docs/v1.2/delete-webhook","title":"Delete Webhook","description":"The Delete Webhook API allow you to delete webhook url","source":"@site/docs/API-docs/v1.2/delete-webhook.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/delete-webhook","permalink":"/docs/API-docs/v1.2/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":"eJy9WM1uHMcRfpXyCAjExewupTiHrAMnMknLQhSL0JLRgUtwentqd9rs6R5X98xyQS7gQ5AHCHLJNS+Rex5FTxJU98zsD23JioMcJJI91fVfX1XXfeLF0iWTq+Qdzgtrb5PrNMnRSVKVV9Ykk+SiQDhFjR6hpYEX569AaG1XsLY1eAt5/L5qv9ekkzSxFZJgJq/yZJJEkk5KmhC6yhqHLpncJ8+Pj/nHvuBpLSU6t6g19KySNJHWeDSe6UVVaSXDh/F3ji/dJ04WWAr+za8rTCaJnX+H0idpUhGz8SqKJHS19jt0zpMyyyRN8E6Uleajzt6oew6u10ivP0s2mzTxygdKZbQyeNMZdfP8+Pjmt8lmwzSfH3/+2LhLhwTGeljY2uSf/e/sQiJLHzbrUPaHDGHlOzN+89iMV6YRWuUhIy7sLZr/ryW74n0Uz6relZrvGVFGkwJR+J7smbp7Ho10KGtSfp1Mru6Tu6Go1DB+n1xdb67TpERf2G06s87CF8kkGa/6zHZIDZILLLgSJknhfeUm47ETJp/bu5Gt0Di1NFrM3UjaciwqNW6ejZ4nm/TwjqiqT6LHevipV5wXS2WWH7t3vXXPlEMYo7TnpD5WolJ/xHWSdjHYpUoTxalToMiRQryUWdhwuY3MmwrNVC1NiGsQfghKT6Cjef+Xf/ZkMzMzX8JgwJDFhgydrUkinFpZB35CeyQjvGoQ3v/wd5jXSnMZEOTYoObscyl4qh2X+3wNaDxSRcqhGw0GzH9X7lI16AIGCpCWc9JjChXZvJas6JBQ5GvAIXtU+JoQKi38wlIJviBbLwsQ4JRZakzh7dn0gsHuxfmrEUzR5JBbWZdovAsq9kxSKIURSwSPJfPDoLOQt4FEmSU4L3ztQBkgFBq8KjEFYXIQtbel8MhKE1unCHsxoNUC5Vrq6ByhNayUL2ztoUGTWwJt5e1QmRE7Yjgc8o8nT+Ales9Sp16Qx5xPzxqkNRB+X6PzUNbOgxRE6yi3L1fW0BcI2U5+ZBAzIwjJsmxmdj5O4HfMYXvwZUszM4PB+7/+Da6+sSvuSEs03DLwQOD10y7pcyvd42zn03GBuhpPo1Fu/OL8VUC2oxj/b60Hx5FcFUjIoua4VOb3cOkw2DIYtGUOaBpF1rBrBwN4mv1sGMiOmG9F1luupz4KYrFAGVytOYNz4cVBKE4sIZyISsyVVgykfP4AJ8Lj0tIaHuBdIXxIWSkM5BYeZuZhOByGf0w6GJx2WTcYwAOcEArOaocmT6Gu8vAXYWNv25xqm3+fnsMu7Nv0bTlfdPkaOH9VK50DYe3EXO8kczAXKsJhpYXEHFYqX6J3XwQd2DPWIFjiKlgHsUi9iCnqxZDrM4h42WWB4+NAultVvV9bLqBMo3zoVrDg8aZlel7PtZKwr/60EIQgoIofu9LTytyG8jG246qV86EWFGHe8TwlsfDwztItS4ocRYM72lna8YlwkPMNF1y+UEZoFROuBKagju+JNV7INnh/ijgRaqBVRsbvMOfBpiK7JFGWwisptF53TL62OkeKPN7QUhiWtdVMGady7CEYTonTcREvdTza4SkyeYsSmYbhaMhwBNgw4hjr1aIdEBzEzCSwKwNo8soq4zt2PLR0vDwpbBCElLY2PnhEEubKA3cSKmMEH/ZLgxP//Q//cPAtrhh3uobxhMtGo2DndBHuZAg9M9nLswsYd5EYT1SeBYn75xzjDAqO4BzRgPOEouRZKg/ZQJjXJhfGQyVIlOjZU5xAhKVtMA8sB4OKcKG0DqUNyoGxKyD0NTEfh3zXo17DgmzZRXTLcDDg1nDLadiP14DCKSQuG2mNq0scdVafC+dWlvLhOVmPklve+enXMK2rypKfGf4O2SxZKI03VUs8S7IOtbs6n9t8zXBoYGUpSA8VjEbSumq5ulHHF3OwZjIz2fmb6QWMZcCXzo0Z/PtfkJ1fPvJ4ON650CXjeNLR3eyThWrpqB59OJAXPjBGsEuzzj9vFgsOIEzb0ubSIqtnZoqe/RKeQDc2Ut3w1Vky4ekB4QEWQjvMwBr4CUNDDv2Ipd4C3vHUrLzmASSAI08oKuJkK68HHB4NUMiiB4s+vtOYH2+t5j7AQ1HWomUGceYO+SWkxIqBhW2KBDdkNXKkFwp1DkKSdS4MBMEKri6ytUc3gouCEIHpYz67LsqT2HpYOoM9FqJRXNyHDafVKYPB0xwXotb+KEBXmBnaoYqRQaNwPkD/dpqKnSFCRNYoXDGfHm1cyNJ+umFHETIVWKPXHUi33SU+aDt8zkRVkW0iuxNhYmVzv+nI8Y691raOqE0L8UHYQw8tgubWwImt1vD05OSIlVOVYhydmRdgcMVul3Lr7bbse0eC0NYsA+KyPXinXJgBslky371nTW9r2idDGttGyLa+CfZRHMd+3gfzrBRKg8hzQsfYwaiGOdd7ryO1SC54oJtbM5Rs2S6OAwYu1kjcD4ByfUDzEbxWt7i1IWX197SBp66WBTe+WCXbild5dsStq1F564eoGseLVN7GvfMANELXmIaGE1GKPasVO5a7KWBZ+TUIIrGGp9nVdXb0BdhS+cAlutZbUKZAag/3WR+MYC8aoXSo1LPt/NfOYTsnXBPCIVy+ff0jM9g0joih333C3NgPLP0TZJ/DB194/e2zS3iLy0eXP/ayzA477p+RnLIBpH4FXwl5uxKUOzixZSW8ChPqmkn5MidH2KvAvCMcypZQxwkYmmchjZtno2f9A6UbE1xsib6wDqGJgiMgiT4eltuWcjDv/B64Ggtzwtg1ZSHMkguBZ4SdRq0Y+PNaxloI+jJrG56jQkNtNDoH1hdIK56VjOUc33fHpUN+3r1W5jakwxCu+gnqHc6d8rh9nqxWq0eePgp3vq61hm5GDwX3kUdNvPZS+W/qObzFyjrlLa23t5bKF/U8xHL3bv9Hy6Cbpftdzy95TAWWF0ilA7uAKVKj5EfMH3smHx/NeIVwsHbY3w4QLpAYd9zeU1BUqn12XnV6AKv3S+zghVI7UoedFUNf3H/84ZBP2D2xCW8Wrb3tDubD9iZpopVE43Bnp/Xi5flraH49Ok7SnWXOz4jl+PWrk7Nvp2esTFsmySR5NjoeHfNRZZ0vhdmRtL/6PVzE3G+Xff/9orjdGXm88+NKCxW2dMGq+3a9dpWstuvpwjrPR/f3XMiXpDcbPv6+RuK93XWaNIIUV3zY2qXdpon3cbe4Zu+FiSdhQl3HddXBmnJv13d69vrs4ixJE1GzMrtLrtuw5Gp/YQHdJ7PeYb+//Yo68P+8ivvRC/f3cYG22fT08dNP3mht7KjZh9ebzeY/62J74w==","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Save or Update Webhook","permalink":"/docs/API-docs/v1.2/save-update-webhook"},"next":{"title":"Create Folder","permalink":"/docs/API-docs/v1.2/createfolder"}}');var n=o(74848),i=o(28453),d=o(57742),r=o.n(d),l=o(78178),a=o.n(l),p=o(19624),h=o.n(p),c=o(96226),u=o.n(c),w=(o(77675),o(19365),o(51107));o(21312);const b={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:"eJy9WM1uHMcRfpXyCAjExewupTiHrAMnMknLQhSL0JLRgUtwentqd9rs6R5X98xyQS7gQ5AHCHLJNS+Rex5FTxJU98zsD23JioMcJJI91fVfX1XXfeLF0iWTq+Qdzgtrb5PrNMnRSVKVV9Ykk+SiQDhFjR6hpYEX569AaG1XsLY1eAt5/L5qv9ekkzSxFZJgJq/yZJJEkk5KmhC6yhqHLpncJ8+Pj/nHvuBpLSU6t6g19KySNJHWeDSe6UVVaSXDh/F3ji/dJ04WWAr+za8rTCaJnX+H0idpUhGz8SqKJHS19jt0zpMyyyRN8E6Uleajzt6oew6u10ivP0s2mzTxygdKZbQyeNMZdfP8+Pjmt8lmwzSfH3/+2LhLhwTGeljY2uSf/e/sQiJLHzbrUPaHDGHlOzN+89iMV6YRWuUhIy7sLZr/ryW74n0Uz6relZrvGVFGkwJR+J7smbp7Ho10KGtSfp1Mru6Tu6Go1DB+n1xdb67TpERf2G06s87CF8kkGa/6zHZIDZILLLgSJknhfeUm47ETJp/bu5Gt0Di1NFrM3UjaciwqNW6ejZ4nm/TwjqiqT6LHevipV5wXS2WWH7t3vXXPlEMYo7TnpD5WolJ/xHWSdjHYpUoTxalToMiRQryUWdhwuY3MmwrNVC1NiGsQfghKT6Cjef+Xf/ZkMzMzX8JgwJDFhgydrUkinFpZB35CeyQjvGoQ3v/wd5jXSnMZEOTYoObscyl4qh2X+3wNaDxSRcqhGw0GzH9X7lI16AIGCpCWc9JjChXZvJas6JBQ5GvAIXtU+JoQKi38wlIJviBbLwsQ4JRZakzh7dn0gsHuxfmrEUzR5JBbWZdovAsq9kxSKIURSwSPJfPDoLOQt4FEmSU4L3ztQBkgFBq8KjEFYXIQtbel8MhKE1unCHsxoNUC5Vrq6ByhNayUL2ztoUGTWwJt5e1QmRE7Yjgc8o8nT+Ales9Sp16Qx5xPzxqkNRB+X6PzUNbOgxRE6yi3L1fW0BcI2U5+ZBAzIwjJsmxmdj5O4HfMYXvwZUszM4PB+7/+Da6+sSvuSEs03DLwQOD10y7pcyvd42zn03GBuhpPo1Fu/OL8VUC2oxj/b60Hx5FcFUjIoua4VOb3cOkw2DIYtGUOaBpF1rBrBwN4mv1sGMiOmG9F1luupz4KYrFAGVytOYNz4cVBKE4sIZyISsyVVgykfP4AJ8Lj0tIaHuBdIXxIWSkM5BYeZuZhOByGf0w6GJx2WTcYwAOcEArOaocmT6Gu8vAXYWNv25xqm3+fnsMu7Nv0bTlfdPkaOH9VK50DYe3EXO8kczAXKsJhpYXEHFYqX6J3XwQd2DPWIFjiKlgHsUi9iCnqxZDrM4h42WWB4+NAultVvV9bLqBMo3zoVrDg8aZlel7PtZKwr/60EIQgoIofu9LTytyG8jG246qV86EWFGHe8TwlsfDwztItS4ocRYM72lna8YlwkPMNF1y+UEZoFROuBKagju+JNV7INnh/ijgRaqBVRsbvMOfBpiK7JFGWwisptF53TL62OkeKPN7QUhiWtdVMGady7CEYTonTcREvdTza4SkyeYsSmYbhaMhwBNgw4hjr1aIdEBzEzCSwKwNo8soq4zt2PLR0vDwpbBCElLY2PnhEEubKA3cSKmMEH/ZLgxP//Q//cPAtrhh3uobxhMtGo2DndBHuZAg9M9nLswsYd5EYT1SeBYn75xzjDAqO4BzRgPOEouRZKg/ZQJjXJhfGQyVIlOjZU5xAhKVtMA8sB4OKcKG0DqUNyoGxKyD0NTEfh3zXo17DgmzZRXTLcDDg1nDLadiP14DCKSQuG2mNq0scdVafC+dWlvLhOVmPklve+enXMK2rypKfGf4O2SxZKI03VUs8S7IOtbs6n9t8zXBoYGUpSA8VjEbSumq5ulHHF3OwZjIz2fmb6QWMZcCXzo0Z/PtfkJ1fPvJ4ON650CXjeNLR3eyThWrpqB59OJAXPjBGsEuzzj9vFgsOIEzb0ubSIqtnZoqe/RKeQDc2Ut3w1Vky4ekB4QEWQjvMwBr4CUNDDv2Ipd4C3vHUrLzmASSAI08oKuJkK68HHB4NUMiiB4s+vtOYH2+t5j7AQ1HWomUGceYO+SWkxIqBhW2KBDdkNXKkFwp1DkKSdS4MBMEKri6ytUc3gouCEIHpYz67LsqT2HpYOoM9FqJRXNyHDafVKYPB0xwXotb+KEBXmBnaoYqRQaNwPkD/dpqKnSFCRNYoXDGfHm1cyNJ+umFHETIVWKPXHUi33SU+aDt8zkRVkW0iuxNhYmVzv+nI8Y691raOqE0L8UHYQw8tgubWwImt1vD05OSIlVOVYhydmRdgcMVul3Lr7bbse0eC0NYsA+KyPXinXJgBslky371nTW9r2idDGttGyLa+CfZRHMd+3gfzrBRKg8hzQsfYwaiGOdd7ryO1SC54oJtbM5Rs2S6OAwYu1kjcD4ByfUDzEbxWt7i1IWX197SBp66WBTe+WCXbild5dsStq1F564eoGseLVN7GvfMANELXmIaGE1GKPasVO5a7KWBZ+TUIIrGGp9nVdXb0BdhS+cAlutZbUKZAag/3WR+MYC8aoXSo1LPt/NfOYTsnXBPCIVy+ff0jM9g0joih333C3NgPLP0TZJ/DB194/e2zS3iLy0eXP/ayzA477p+RnLIBpH4FXwl5uxKUOzixZSW8ChPqmkn5MidH2KvAvCMcypZQxwkYmmchjZtno2f9A6UbE1xsib6wDqGJgiMgiT4eltuWcjDv/B64Ggtzwtg1ZSHMkguBZ4SdRq0Y+PNaxloI+jJrG56jQkNtNDoH1hdIK56VjOUc33fHpUN+3r1W5jakwxCu+gnqHc6d8rh9nqxWq0eePgp3vq61hm5GDwX3kUdNvPZS+W/qObzFyjrlLa23t5bKF/U8xHL3bv9Hy6Cbpftdzy95TAWWF0ilA7uAKVKj5EfMH3smHx/NeIVwsHbY3w4QLpAYd9zeU1BUqn12XnV6AKv3S+zghVI7UoedFUNf3H/84ZBP2D2xCW8Wrb3tDubD9iZpopVE43Bnp/Xi5flraH49Ok7SnWXOz4jl+PWrk7Nvp2esTFsmySR5NjoeHfNRZZ0vhdmRtL/6PVzE3G+Xff/9orjdGXm88+NKCxW2dMGq+3a9dpWstuvpwjrPR/f3XMiXpDcbPv6+RuK93XWaNIIUV3zY2qXdpon3cbe4Zu+FiSdhQl3HddXBmnJv13d69vrs4ixJE1GzMrtLrtuw5Gp/YQHdJ7PeYb+//Yo68P+8ivvRC/f3cYG22fT08dNP3mht7KjZh9ebzeY/62J74w==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},S=void 0,k={},z=[];function X(e){const t={p:"p",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(w.default,{as:"h1",className:"openapi__heading",children:"Delete Webhook"}),"\n",(0,n.jsx)(r(),{method:"delete",path:"/webhook",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"The Delete Webhook API allow you to delete webhook url"}),"\n",(0,n.jsx)(a(),{parameters:void 0}),"\n",(0,n.jsx)(h(),{...o(1356)}),"\n",(0,n.jsx)(u(),{...o(58326)})]})}function f(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(X,{...e})}):X(e)}},1356(e){e.exports={title:"Body"}},58326(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Webhook deleted successfully!"}},"title":"inline_response_200_9"}}}},"404":{"description":"User not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"User not found!"}},"title":"inline_response_404"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/be3c2a14.977da1a1.js b/assets/js/be3c2a14.977da1a1.js deleted file mode 100644 index 33a533f4b..000000000 --- a/assets/js/be3c2a14.977da1a1.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[862],{85149(e,t,o){o.r(t),o.d(t,{assets:()=>I,contentTitle:()=>k,default:()=>x,frontMatter:()=>u,metadata:()=>a,toc:()=>h});const a=JSON.parse('{"id":"API-docs/v1.2/getfolder","title":"Get Folder","description":"The Get Folder API allows you to retrieve details about a specific folder.","source":"@site/docs/API-docs/v1.2/getfolder.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/getfolder","permalink":"/docs/API-docs/v1.2/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":"eJy9WN1uI7cVfpVTXrS7wliSHW/aTm5qFFvHqbG7iB0sUNswqJkzGq45JEOekSwIAnLRN8hVbvto+yTFIWekke3dxG2wN7aG5Dn8zv83sxYk50HkV+IfVpfoxU0mSgyFV46UNSIXlzXCKRKkfTh5dwZSa7sMsLItkAWP5BUuEEokqXQAObMtgYTgsFCVKqCKomORCevQS1Z8VopczJHSlsiEk142SOgZzFoY2aDIRdq+VaXIhGI0TlItHkK0sw9Y0FkJtoKtQo8/tspjKXLyLWYi0EqzyqAap1FkAu+dtiWKvJI68IGixkaKfC1o5eJJ8srMRSYq6xtJwxW8l1FLLty3h7O6OKrdTGw2N3xtcNYEDKzoaDrlf/toQ1sUGELVati6Q2SisIbQEJ+XzmlVxI3Jh8BC68foktHsOc9qSKUre1882476cFbfH31wYpN1bn8TY/A8NQaXfQg2MahoKGXO8yF9d2RkeHWn3uFDXf8rstDOBugKj5KwPKGnVO0Ej6ZHXx0cTg+mf748/Do//mv+6uvxdDr9l8jEfaNZtkvWUlJESor08Ll15Re4Z7DQVY3HIDYb3jh+Kg8vbINUKzOHJRqCpbdmnoHTKAMC+RXIuVQGtCT0f/j9EhS9t/7znngesqHlymhl8LYvwtvj6fT2cOuE48dOSK4CYwkq25py/AUM/VyWPsbzefOOb/+yNe/VY/POzEJqVcaufWnv0HzZQA6vp3Q9Q91PZ5UOxX2xZ+xwPRkZsGi9olWcEfcH0qmDtJ9f3XD35byx3WiJQ4VqkYtJ8upkvR0nG8G6/KIfN63XIhc1kQv5ZBKkKWf2fmwdmqDmRstZGBe2mUinJovD8ZHYZA9lpHPPOo/twXNFAsm5MvNfk7vZuemCQ5miteesbcykU//Elcj6WAxPdRO3Rhn75YafKxuFuwi9dWgu1NzE+MbLH07m96gL2yDTBKoRRqNe5OO//7OVGo2gtEXboKGYieNrc23eth6cXaLnOSlNCZXGezXTGMWwiXtbDhJQNhpD0CtQhnDuJSGUaq5IamA/cTMppJMzpRUnMB+zLO1hUANhDO9rpBo9b/3JI0gocYGa8x5kS7aRxKp6vLC0/q5iNpSBhFkblMEQAE0tTcEH+0hkYD1IA2gIvfMqIATyjFolbNaQlwVBI42cI+vOYOisErXidAVvZ20gCFa3ETIw6bIeS+gNMohliE58zRTHI/BqYRvnsea0WSDMW1ViyKCwJUKI9commBJmGAgcY1EFBlbaGm2LuxjAqtUanOX2oaRmvjXEyOLkpQnc4RKWPgZbhzlvmf1gAjga/RCQI3yuzF3IR6NrcwBX27x6j7OgCG9e9CWwXC4fpf7LfZlTRd+2M/genQ2KrF/tpOeK6nYWy2WoZPuQNJ2iwZg/g2LY6ShtER5XH69OatRucoHEGRImJ+/OYsd9CR9/+hnOUXoDtV2mbC1aj3oF8/4q9lyKfHLbtmFCZWPi1ezxIiUfM1sM1HvwfS3p40+/BHiDS1CmKyk2ZTRi4n6JjeNRCX+EvcdzFWg0ysFjYxdYQmsMcmikX8GOjUdoAXmBsATnsVJaQylJQuVtE6sL/UBizFdfi0ppvHUyhKX15bXYHQBZllgy0kTAgDpEGSSmNFjoTuzKTVE92C69rGi3m6DqKmICb1tKCey8XagSoUcTneq8JSyiTWXVg45vNre2quKcZTW/CXm8+QH4wf1RK7SB3UkW0EjuY5arI6Sf6cJtp2J8VKPyW209wOTtW281Po2MqzQdCpAGN1fpvqMe+fVXHf0oUmywa2daFQ8NHsNJUaBjxy6kbjHkMBolRKMRvCixkq2mlxmMRguFS17l39JxlPhpDBcd/oYbXS0XCJKA2R+B7bwkqfUIS1XOkb6BpGgoYGy3Gb6BXnWARq46fWbV70dTuxfWreLu5ZFdMb7mUfhgfO5POY8VevZdDO+uqJ3qiviqbwbAPeL/aSbxvcUakkXkb9hIpdMc/9tDPZFLoW/C2+oC/UIV2HGJT/TRSTw8EZnQqkATcMDRTk7fncPiq/FUZANS8hta6uT87O+v31y8ZjAcguSww/F0PI0vdTZQI83gpt2nhodkYr0jrr/vR4mOCxHe08RpqSILjVauOwZ5JbafFfLdJ4mbTNQ2EG+v1zMZ8AevNxte/rFFzxz1JhML6RXXeKSZXb2X228OnzTwxffd54uX8OTXjScx96TOMKOLxSdyITJxh6u9bymbm03W8zqGlfZT2Q4kH70c7DHs09eXIhM8mvb55F3kk90P1v4kqn2imQDwX2a9Twqs14mrbjbb82nrkxKdgf1pdtHNZrP5L/5No6s=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Folder","permalink":"/docs/API-docs/v1.2/createfolder"},"next":{"title":"Update Folder","permalink":"/docs/API-docs/v1.2/updatefolder"}}');var i=o(74848),s=o(28453),n=o(57742),r=o.n(n),l=o(78178),d=o.n(l),p=o(19624),c=o.n(p),f=o(96226),m=o.n(f),b=(o(77675),o(19365),o(51107)),g=o(21312);const u={id:"getfolder",title:"Get Folder",description:"The Get Folder API allows you to retrieve details about a specific folder.",sidebar_label:"Get Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9WN1uI7cVfpVTXrS7wliSHW/aTm5qFFvHqbG7iB0sUNswqJkzGq45JEOekSwIAnLRN8hVbvto+yTFIWekke3dxG2wN7aG5Dn8zv83sxYk50HkV+IfVpfoxU0mSgyFV46UNSIXlzXCKRKkfTh5dwZSa7sMsLItkAWP5BUuEEokqXQAObMtgYTgsFCVKqCKomORCevQS1Z8VopczJHSlsiEk142SOgZzFoY2aDIRdq+VaXIhGI0TlItHkK0sw9Y0FkJtoKtQo8/tspjKXLyLWYi0EqzyqAap1FkAu+dtiWKvJI68IGixkaKfC1o5eJJ8srMRSYq6xtJwxW8l1FLLty3h7O6OKrdTGw2N3xtcNYEDKzoaDrlf/toQ1sUGELVati6Q2SisIbQEJ+XzmlVxI3Jh8BC68foktHsOc9qSKUre1882476cFbfH31wYpN1bn8TY/A8NQaXfQg2MahoKGXO8yF9d2RkeHWn3uFDXf8rstDOBugKj5KwPKGnVO0Ej6ZHXx0cTg+mf748/Do//mv+6uvxdDr9l8jEfaNZtkvWUlJESor08Ll15Re4Z7DQVY3HIDYb3jh+Kg8vbINUKzOHJRqCpbdmnoHTKAMC+RXIuVQGtCT0f/j9EhS9t/7znngesqHlymhl8LYvwtvj6fT2cOuE48dOSK4CYwkq25py/AUM/VyWPsbzefOOb/+yNe/VY/POzEJqVcaufWnv0HzZQA6vp3Q9Q91PZ5UOxX2xZ+xwPRkZsGi9olWcEfcH0qmDtJ9f3XD35byx3WiJQ4VqkYtJ8upkvR0nG8G6/KIfN63XIhc1kQv5ZBKkKWf2fmwdmqDmRstZGBe2mUinJovD8ZHYZA9lpHPPOo/twXNFAsm5MvNfk7vZuemCQ5miteesbcykU//Elcj6WAxPdRO3Rhn75YafKxuFuwi9dWgu1NzE+MbLH07m96gL2yDTBKoRRqNe5OO//7OVGo2gtEXboKGYieNrc23eth6cXaLnOSlNCZXGezXTGMWwiXtbDhJQNhpD0CtQhnDuJSGUaq5IamA/cTMppJMzpRUnMB+zLO1hUANhDO9rpBo9b/3JI0gocYGa8x5kS7aRxKp6vLC0/q5iNpSBhFkblMEQAE0tTcEH+0hkYD1IA2gIvfMqIATyjFolbNaQlwVBI42cI+vOYOisErXidAVvZ20gCFa3ETIw6bIeS+gNMohliE58zRTHI/BqYRvnsea0WSDMW1ViyKCwJUKI9commBJmGAgcY1EFBlbaGm2LuxjAqtUanOX2oaRmvjXEyOLkpQnc4RKWPgZbhzlvmf1gAjga/RCQI3yuzF3IR6NrcwBX27x6j7OgCG9e9CWwXC4fpf7LfZlTRd+2M/genQ2KrF/tpOeK6nYWy2WoZPuQNJ2iwZg/g2LY6ShtER5XH69OatRucoHEGRImJ+/OYsd9CR9/+hnOUXoDtV2mbC1aj3oF8/4q9lyKfHLbtmFCZWPi1ezxIiUfM1sM1HvwfS3p40+/BHiDS1CmKyk2ZTRi4n6JjeNRCX+EvcdzFWg0ysFjYxdYQmsMcmikX8GOjUdoAXmBsATnsVJaQylJQuVtE6sL/UBizFdfi0ppvHUyhKX15bXYHQBZllgy0kTAgDpEGSSmNFjoTuzKTVE92C69rGi3m6DqKmICb1tKCey8XagSoUcTneq8JSyiTWXVg45vNre2quKcZTW/CXm8+QH4wf1RK7SB3UkW0EjuY5arI6Sf6cJtp2J8VKPyW209wOTtW281Po2MqzQdCpAGN1fpvqMe+fVXHf0oUmywa2daFQ8NHsNJUaBjxy6kbjHkMBolRKMRvCixkq2mlxmMRguFS17l39JxlPhpDBcd/oYbXS0XCJKA2R+B7bwkqfUIS1XOkb6BpGgoYGy3Gb6BXnWARq46fWbV70dTuxfWreLu5ZFdMb7mUfhgfO5POY8VevZdDO+uqJ3qiviqbwbAPeL/aSbxvcUakkXkb9hIpdMc/9tDPZFLoW/C2+oC/UIV2HGJT/TRSTw8EZnQqkATcMDRTk7fncPiq/FUZANS8hta6uT87O+v31y8ZjAcguSww/F0PI0vdTZQI83gpt2nhodkYr0jrr/vR4mOCxHe08RpqSILjVauOwZ5JbafFfLdJ4mbTNQ2EG+v1zMZ8AevNxte/rFFzxz1JhML6RXXeKSZXb2X228OnzTwxffd54uX8OTXjScx96TOMKOLxSdyITJxh6u9bymbm03W8zqGlfZT2Q4kH70c7DHs09eXIhM8mvb55F3kk90P1v4kqn2imQDwX2a9Twqs14mrbjbb82nrkxKdgf1pdtHNZrP5L/5No6s=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},k=void 0,I={},h=[];function v(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(b.default,{as:"h1",className:"openapi__heading",children:"Get Folder"}),"\n",(0,i.jsx)(r(),{method:"get",path:"/folder/{folder_id}",context:"endpoint"}),"\n",(0,i.jsx)(t.p,{children:"The Get Folder API allows you to retrieve details about a specific folder."}),"\n",(0,i.jsx)(b.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,i.jsx)(g.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,i.jsx)(d(),{...o(44907)}),"\n",(0,i.jsx)(c(),{...o(90617)}),"\n",(0,i.jsx)(m(),{...o(11407)})]})}function x(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(v,{...e})}):v(e)}},44907(e){e.exports=JSON.parse('{"parameters":[{"name":"folder_id","in":"path","description":"objectId of folder","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"pH1bhc2hpb"}}]}')},90617(e){e.exports={title:"Body"}},11407(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"ph1bhx2jp"},"folderName":{"type":"string","format":"string","example":"new folder"},"parentFolderId":{"type":"string","format":"string","example":"J2nas5kiPe"},"parentFolderName":{"type":"string","format":"string","example":"new sub folder"},"createdAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"title":"folder_res"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"folder not found.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","format":"string","example":"folder not found."}},"title":"inline_response_404_8"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/be3c2a14.993abd75.js b/assets/js/be3c2a14.993abd75.js new file mode 100644 index 000000000..9a6a2e37c --- /dev/null +++ b/assets/js/be3c2a14.993abd75.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[862],{85149(e,t,o){o.r(t),o.d(t,{assets:()=>b,contentTitle:()=>g,default:()=>I,frontMatter:()=>f,metadata:()=>s,toc:()=>F});const s=JSON.parse('{"id":"API-docs/v1.2/getfolder","title":"Get Folder","description":"The Get Folder API allows you to retrieve details about a specific folder.","source":"@site/docs/API-docs/v1.2/getfolder.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/getfolder","permalink":"/docs/API-docs/v1.2/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":"eJy9GdtuI7f1V065QGELI8l2NmmrFGkdr7Nxut01LLsL1DI81PBIw4hDTkiOZMEWkIeiH1D0pa/9ib73U/ZLikPOjCTbuxs3wT7s2ibP/c4zt8zzqWODS/aNUQItu0qYQJdZWXppNBuw8xzhJXqI93B4egJcKbNwsDQVeAMWvZU4RxDouVQO+NhUHji4EjM5kRlMAmqPJcyUaDkRPhFswKbo4xVLWMktL9CjJWFumeYFsgGL19dSsIRJkqbkPmf3RTTj7zHzJwLMBFqCFn+opEXBBt5WmDDnl4pIOlmUClnC8KZURiAbTLhyBJDlWHA2uGV+WQZIb6WesoRNjC243zzBGx6oDFj57f44zw7ycsxWqyti60qjHToidLC3Rz+2pXVVlqFzk0pBaw6WsMxoj9oTPC9LJbNw0f/eEdLtQ+mi0mQ5S2S8jCwbWzxZj3x/nN8cfF+yVVKb/XXwwdPIaFw0LlgFp6L2MXKeLtJ3B5q7z2fyFO/T+n8lc9V4Q7rMIvcoDv1jpNaIB3sHn3X397p7vznf/2Lw/HeDz7/o7e3t/ZUl7KZQhFsHq+A+SOqlV5t/V6X4BHw2DuqssejYakUXzx+Lw6Ep0OdST2GB2sPCGj1NoFTIHYK3S+BTLjUo7tH+6pcLULTW2A9b4mmSbWoutZIar5skvH6+t3e93xrh+UMjRFOBNh4mptKi9wkU/VCUPpTnw+o9v/5tq97nD9U70XOupAhV+9zMUH9aR26y95E9ibodzjIChXu2pezmeVTSYVZZ6ZehR9x0eSm78X5weUXVl+LG1K0lNBWfswHrR6v2b9t2smJEy86bdlNZxQYs9750g37fcS3G5qZnStROTrXiY9fLTNHnpezP93sHbJXcx+Fl+SR4rLpPRXGeT6Wefgzvam2mIbkyemvLWK3PeCn/hEuWNL7YhKo7bo481MsV/T0xAbn20JsS9VBOdfBvYH6/Mz+DBubd3/7dgo30SH8FnQ6NFqRI15nKZggvTFYFelx5tJp7OUd49+M/YVxJRQlhQeAcFUWhS8DbynkUMF4Cao+2tNKh63U6RH+T71TOMY4rHDJDsekxgdIaUWUkaNciF0vALlmU+8oilIp7ylPwuTXVNKdxRuqpwgTOjofn1LwPT096MEQtQJisKlB7F0RsiSRQcM2nCB4LoodBZp7NAgiVN+e5rxxIDRa5Ai8LTIBrAbzypuAeSWhL2kmLLRtQcoLZMlPROFwpWEif09A1Ry2MBWWyWVfqHhmi2+3Sj2fPaIrzxHXoufUo6PR4jnYJNCqh81BUzkPGrV1Gvm3akoQ+R0g34iOFGBmBSZqmI71xOYDfE4X1wVc1zEh3Ou/+/g+4/NYsaHicoqYRCO8xvNppgl6YzD2Mdjrt56jK/jAq5fqHpyehwu1G/782Hhx5cpGjRWI1xqnUf4AL6iE5QqdTpzmgnktrNJm204Gd9CeXgXSX6JbWeEP51HqBTyaYBVMrimDBPb/niiNjEY54ycdSSSqodH4HR9zj1Ngl3MHbnPsQshnXIAzcjfRdt9sN/wi003nRRF2nA3dwFIaZBBxqkUAcORKwODezOqYEUtyvw7PbuH0dvjXl8yZeA+WvK6kEWKwcH6uNYA7qQmmxWyqeoYCFFFP07ssgA1nGaARjKQuWgS3alsUQ1aRL+RlYvGyiwNFxAN3MqtauNRWQei596FowUWbRED2txkpmsC3+MOcWgUMZL5vUU1LPQvpo01BV0nlong0NzReWTzy8NXZGnCJFPscN6YzdsAl3IAjDBZNPpOZKxoAr4rzS0D0y2vOsdt6fY50IOVALk8V7GBszoxCbWl4U3MuMK7VsiMRpONJ4Y6dcE6+1ZFI7KbAtwfDCUjjGJth64i2Oc2NmkcgZZkgwVI66VI4A51RxtPH0kgsmdxAj04JZaEAtSiO1b8hduEags+ZdyLPMVNoHi2QWhfRAnYSGIPLg3XZqUOC/+/FfDl7jgupO0zCeUdoo5GScxsMND65GOn15fA79xhP9gRRp4Lh9Tj5OIScPjhE1OG+RFzRViRANFkWlBdce1g9SoACyWJg5ikCy0yktTqRSIbVBOtBmQe/gyhIdh4TrUS1hYk3ReHRNsNOh1jCjMGyfi4DcSbSUNpnRriqw12h9yp1bGCu6p9Z4zKjlnb74BoZVWRrrR5ruIR2xiVR4XdbAI5Y2VbvJ87ERSyqHGhbGBu4hg1FndlnWVF2voYsCjB6MdHr6ZngO/fhYasyYwn//A+npxQOLh+MNhCYY+4MG7nobLGRLA/Xg4h6/cEE1gkyaNvZ5M5mQA2FYpzalljVqpIfoyS5hXXFtItQ1oY7YgKYHhDsIj/8UjIb3KBpi6BFNvQHaIMhMekUDSCiONKHIWCdrfm3BodEAeZa3xaL17zDGx5lR1AdoKErraplCnL1DfPEsw5IKC+kUAa6tUUienkhUAnhmjXNhIAhaUHZZU3l0PTjPLSIQfIxn13h5EFsPcadijzmfS0ru+w2nlimFzo7ACa+U3w2lK8wM9VBFlYFeaT6U/vU0FTtDLBHpXOKC6LTVxoUobacbMpRFggKj1bIp0nV3icunpj6nvCytmUdyR1zHzKZ+04DjDVmtbh1RmrrEB2Z3bWnhdmw0HJlyCTtHR7sknCwl1dGRPgTaHqQjlmVra9dp3xoSuDJ6Giou6YM30oUZIB2x8Sae0a2uSRsMSWwbIdraJth6sR/7eevM44JLBVwIi45qB1U1FJTvrYy2ruScBrqx0d2MNNus44CBitEZbjtAutahogev5AzXOiQk/pY0sOOqLKfGF7NknfFSpLvUuuZS1HaIopG/rBS13xsLwJyrCpPQcGKVIssqSYalbgpYlH4J3Fq+hJ308ird/RJMIX2gEk3rDUido60Pt0nfG8EO51yqkKnH6/mvnsM2TignaO1wcfbqkRlsGEfE0O+eMDe2A0v7BNmm8MEXXot9fAFnOH2A/LGXZXq/4/4FrZMmFKlfw9c8my24FQ6OTFFyL8OEuiRQQqbgmFQ0gowbwG5WA6o4AcN8P4TxfL+33z5QmjHBxZboc+MQ5pFxLEi89YehtiUdjBu7B6rawNhi7JpZzvWUEoFmhI1GLanwiyqLuRDkJdImPEe5gkordA6Mz9EuaFbShmJ82xwXDul590rqWQiHLly2E9RbHDvpcf08WSwWDyy9G3C+qZSCZkYPCfeRR01Eeyn9t9UYzrA0Tnpjl2usqfR5NQ6+3MRt/6gJNLN0u/P5OY+pQPIcbeFouT5EO5fZR9TvewLv745ohXBv7bC9HbA4QUt1x209BXkp62fnZSMHkHg/R4+w740jddhdUemL+48/3qcTdlCkwptJrW+9g/mwvixhSmaoHW7stg5fnr6C+We9PZZsLHN+gi/7r06Ojl8Pj0mYOk3YgO339np7YRlunC+43uC0/kRzfwlzu174/bIfc+odkscb3y8Vl2F7F7S8rTdvl6z9HDNYf8q5SlhunKfr21tK8gurVis6/qFCS7u9q4TNuZVUDcJ6rp6pRPut5r0K7pzV77ddePSr0KMyN8swTZuw0CvYgLGEzXC59Q1qdbVKmn0YiRXvD8NctoH5YKm6tZl8eXzOEsYrss/mHm4W9nD1L0T9Uam2F3RRAPqftoWPItzexh3fatXCx6v3YtQKNtBkoqvVavU/b9jrMg==","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Folder","permalink":"/docs/API-docs/v1.2/createfolder"},"next":{"title":"Update Folder","permalink":"/docs/API-docs/v1.2/updatefolder"}}');var n=o(74848),i=o(28453),r=o(57742),l=o.n(r),a=o(78178),d=o.n(a),p=o(19624),c=o.n(p),m=o(96226),R=o.n(m),h=(o(77675),o(19365),o(51107)),u=o(21312);const f={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:"eJy9GdtuI7f1V065QGELI8l2NmmrFGkdr7Nxut01LLsL1DI81PBIw4hDTkiOZMEWkIeiH1D0pa/9ib73U/ZLikPOjCTbuxs3wT7s2ibP/c4zt8zzqWODS/aNUQItu0qYQJdZWXppNBuw8xzhJXqI93B4egJcKbNwsDQVeAMWvZU4RxDouVQO+NhUHji4EjM5kRlMAmqPJcyUaDkRPhFswKbo4xVLWMktL9CjJWFumeYFsgGL19dSsIRJkqbkPmf3RTTj7zHzJwLMBFqCFn+opEXBBt5WmDDnl4pIOlmUClnC8KZURiAbTLhyBJDlWHA2uGV+WQZIb6WesoRNjC243zzBGx6oDFj57f44zw7ycsxWqyti60qjHToidLC3Rz+2pXVVlqFzk0pBaw6WsMxoj9oTPC9LJbNw0f/eEdLtQ+mi0mQ5S2S8jCwbWzxZj3x/nN8cfF+yVVKb/XXwwdPIaFw0LlgFp6L2MXKeLtJ3B5q7z2fyFO/T+n8lc9V4Q7rMIvcoDv1jpNaIB3sHn3X397p7vznf/2Lw/HeDz7/o7e3t/ZUl7KZQhFsHq+A+SOqlV5t/V6X4BHw2DuqssejYakUXzx+Lw6Ep0OdST2GB2sPCGj1NoFTIHYK3S+BTLjUo7tH+6pcLULTW2A9b4mmSbWoutZIar5skvH6+t3e93xrh+UMjRFOBNh4mptKi9wkU/VCUPpTnw+o9v/5tq97nD9U70XOupAhV+9zMUH9aR26y95E9ibodzjIChXu2pezmeVTSYVZZ6ZehR9x0eSm78X5weUXVl+LG1K0lNBWfswHrR6v2b9t2smJEy86bdlNZxQYs9750g37fcS3G5qZnStROTrXiY9fLTNHnpezP93sHbJXcx+Fl+SR4rLpPRXGeT6Wefgzvam2mIbkyemvLWK3PeCn/hEuWNL7YhKo7bo481MsV/T0xAbn20JsS9VBOdfBvYH6/Mz+DBubd3/7dgo30SH8FnQ6NFqRI15nKZggvTFYFelx5tJp7OUd49+M/YVxJRQlhQeAcFUWhS8DbynkUMF4Cao+2tNKh63U6RH+T71TOMY4rHDJDsekxgdIaUWUkaNciF0vALlmU+8oilIp7ylPwuTXVNKdxRuqpwgTOjofn1LwPT096MEQtQJisKlB7F0RsiSRQcM2nCB4LoodBZp7NAgiVN+e5rxxIDRa5Ai8LTIBrAbzypuAeSWhL2kmLLRtQcoLZMlPROFwpWEif09A1Ry2MBWWyWVfqHhmi2+3Sj2fPaIrzxHXoufUo6PR4jnYJNCqh81BUzkPGrV1Gvm3akoQ+R0g34iOFGBmBSZqmI71xOYDfE4X1wVc1zEh3Ou/+/g+4/NYsaHicoqYRCO8xvNppgl6YzD2Mdjrt56jK/jAq5fqHpyehwu1G/782Hhx5cpGjRWI1xqnUf4AL6iE5QqdTpzmgnktrNJm204Gd9CeXgXSX6JbWeEP51HqBTyaYBVMrimDBPb/niiNjEY54ycdSSSqodH4HR9zj1Ngl3MHbnPsQshnXIAzcjfRdt9sN/wi003nRRF2nA3dwFIaZBBxqkUAcORKwODezOqYEUtyvw7PbuH0dvjXl8yZeA+WvK6kEWKwcH6uNYA7qQmmxWyqeoYCFFFP07ssgA1nGaARjKQuWgS3alsUQ1aRL+RlYvGyiwNFxAN3MqtauNRWQei596FowUWbRED2txkpmsC3+MOcWgUMZL5vUU1LPQvpo01BV0nlong0NzReWTzy8NXZGnCJFPscN6YzdsAl3IAjDBZNPpOZKxoAr4rzS0D0y2vOsdt6fY50IOVALk8V7GBszoxCbWl4U3MuMK7VsiMRpONJ4Y6dcE6+1ZFI7KbAtwfDCUjjGJth64i2Oc2NmkcgZZkgwVI66VI4A51RxtPH0kgsmdxAj04JZaEAtSiO1b8hduEags+ZdyLPMVNoHi2QWhfRAnYSGIPLg3XZqUOC/+/FfDl7jgupO0zCeUdoo5GScxsMND65GOn15fA79xhP9gRRp4Lh9Tj5OIScPjhE1OG+RFzRViRANFkWlBdce1g9SoACyWJg5ikCy0yktTqRSIbVBOtBmQe/gyhIdh4TrUS1hYk3ReHRNsNOh1jCjMGyfi4DcSbSUNpnRriqw12h9yp1bGCu6p9Z4zKjlnb74BoZVWRrrR5ruIR2xiVR4XdbAI5Y2VbvJ87ERSyqHGhbGBu4hg1FndlnWVF2voYsCjB6MdHr6ZngO/fhYasyYwn//A+npxQOLh+MNhCYY+4MG7nobLGRLA/Xg4h6/cEE1gkyaNvZ5M5mQA2FYpzalljVqpIfoyS5hXXFtItQ1oY7YgKYHhDsIj/8UjIb3KBpi6BFNvQHaIMhMekUDSCiONKHIWCdrfm3BodEAeZa3xaL17zDGx5lR1AdoKErraplCnL1DfPEsw5IKC+kUAa6tUUienkhUAnhmjXNhIAhaUHZZU3l0PTjPLSIQfIxn13h5EFsPcadijzmfS0ru+w2nlimFzo7ACa+U3w2lK8wM9VBFlYFeaT6U/vU0FTtDLBHpXOKC6LTVxoUobacbMpRFggKj1bIp0nV3icunpj6nvCytmUdyR1zHzKZ+04DjDVmtbh1RmrrEB2Z3bWnhdmw0HJlyCTtHR7sknCwl1dGRPgTaHqQjlmVra9dp3xoSuDJ6Giou6YM30oUZIB2x8Sae0a2uSRsMSWwbIdraJth6sR/7eevM44JLBVwIi45qB1U1FJTvrYy2ruScBrqx0d2MNNus44CBitEZbjtAutahogev5AzXOiQk/pY0sOOqLKfGF7NknfFSpLvUuuZS1HaIopG/rBS13xsLwJyrCpPQcGKVIssqSYalbgpYlH4J3Fq+hJ308ird/RJMIX2gEk3rDUido60Pt0nfG8EO51yqkKnH6/mvnsM2TignaO1wcfbqkRlsGEfE0O+eMDe2A0v7BNmm8MEXXot9fAFnOH2A/LGXZXq/4/4FrZMmFKlfw9c8my24FQ6OTFFyL8OEuiRQQqbgmFQ0gowbwG5WA6o4AcN8P4TxfL+33z5QmjHBxZboc+MQ5pFxLEi89YehtiUdjBu7B6rawNhi7JpZzvWUEoFmhI1GLanwiyqLuRDkJdImPEe5gkordA6Mz9EuaFbShmJ82xwXDul590rqWQiHLly2E9RbHDvpcf08WSwWDyy9G3C+qZSCZkYPCfeRR01Eeyn9t9UYzrA0Tnpjl2usqfR5NQ6+3MRt/6gJNLN0u/P5OY+pQPIcbeFouT5EO5fZR9TvewLv745ohXBv7bC9HbA4QUt1x209BXkp62fnZSMHkHg/R4+w740jddhdUemL+48/3qcTdlCkwptJrW+9g/mwvixhSmaoHW7stg5fnr6C+We9PZZsLHN+gi/7r06Ojl8Pj0mYOk3YgO339np7YRlunC+43uC0/kRzfwlzu174/bIfc+odkscb3y8Vl2F7F7S8rTdvl6z9HDNYf8q5SlhunKfr21tK8gurVis6/qFCS7u9q4TNuZVUDcJ6rp6pRPut5r0K7pzV77ddePSr0KMyN8swTZuw0CvYgLGEzXC59Q1qdbVKmn0YiRXvD8NctoH5YKm6tZl8eXzOEsYrss/mHm4W9nD1L0T9Uam2F3RRAPqftoWPItzexh3fatXCx6v3YtQKNtBkoqvVavU/b9jrMg==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},g=void 0,b={},F=[];function x(e){const t={p:"p",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Get Folder"}),"\n",(0,n.jsx)(l(),{method:"get",path:"/folder/{folder_id}",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"The Get Folder API allows you to retrieve details about a specific folder."}),"\n",(0,n.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,n.jsx)(u.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,n.jsx)(d(),{...o(44907)}),"\n",(0,n.jsx)(c(),{...o(90617)}),"\n",(0,n.jsx)(R(),{...o(11407)})]})}function I(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(x,{...e})}):x(e)}},44907(e){e.exports=JSON.parse('{"parameters":[{"name":"folder_id","in":"path","description":"objectId of folder","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"pH1bhc2hpb"}}]}')},90617(e){e.exports={title:"Body"}},11407(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"ph1bhx2jp"},"folderName":{"type":"string","format":"string","example":"new folder"},"parentFolderId":{"type":"string","format":"string","example":"J2nas5kiPe"},"parentFolderName":{"type":"string","format":"string","example":"new sub folder"},"createdAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"title":"folder_res"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"folder not found.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","format":"string","example":"folder not found."}},"title":"inline_response_404_8"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/c081699b.3e91ece8.js b/assets/js/c081699b.3e91ece8.js new file mode 100644 index 000000000..9fb5a0b49 --- /dev/null +++ b/assets/js/c081699b.3e91ece8.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[5741],{65629(e,s,t){t.r(s),t.d(s,{assets:()=>v,contentTitle:()=>q,default:()=>y,frontMatter:()=>h,metadata:()=>n,toc:()=>T});const n=JSON.parse('{"id":"API-docs/v1.2/resendrequestmail","title":"Resend request mail","description":"Resend request mail to user for signing document.","source":"@site/docs/API-docs/v1.2/resendrequestmail.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/resendrequestmail","permalink":"/docs/API-docs/v1.2/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":"eJztWt1uG7kVfpXTCdCNhZHkZNMbretu1vFmg6Ybw7IbFJYhUTNnNFxxyFmSI1mVDexF0QcoetPbvkTv+yh5kuKQw5mR7E02DdoCxV7EkTjk4fn9zs9oG1m2MNHoKnqhkqpAaU10HUcpmkTz0nIlo1F0jgZlChq/r9BYKBgXYBVUBjVkSoPhC8nlAtKaxGAiozhSJWpGFF6lDY2aBFGI4qj+9pVKN9FoGyVKWpSWPrKyFDxxp4ffGWJiG5kkx4LRJzrHNabEdrhzytMojtBRvo4juykxGkVq/h0mNoqjUhM7lqMhAt1Do23YbKzmckFUblhRCloqtVrxFBvJgKfRXbjmgZO7egunnaKc1jKtCqcu1IZUqLF/T7Veey0PdPrL+usgUUXDwNRUXrwPMnJSGVtfzGylsbnP0YGaDnAJFm/sMLeFIMMWzA7ghEngMhFVipApIdSaTL1imrO5QAOw3TbqtNwKvLuD7ZakQj2VrMC7u7hdoPt2FspcyXqLxgT5audUs4TtwWatcxRvSq4305TZeiFRRcnkpsuAd9JppWs6UtHmwY6u9xiHnJmgK0xhoyoyGlF6QOrWLvPaoT/JKETkZ4tER+XxN/wBVo6G5fFRefwWIVclgs25qRWXcZkaZ6s1CjGAI2O1kovjPRUcDev1h42sccVxDUym3t4tlX3dNoQGNU9/UJXumJUbSHSVcOZAs9QqQUxhzW0ONkeQeGPBWCwNMAPcejTNODoZNLCFRnTYQ7ywyuZK8z86aAwXHjHINWa//mxPp58dj4n1HDUeDdlxvftV5mTM2QqByQ04wbmSBpQGSbxllbY5akgE0zyrcTiGUiAzCATTLLGOea/RwMdFzuTSxEdzfXyBrIA3JUri4N2f/k47oru7OHJKi0aRdvmgDZc7etgCu9UVugVTKmk8aj89PHTgvRNFUfzT88b7k4JGU4kHwdQH3sMZwgMomcdUSYLGZJUQm8GOrFwKLnEahJk+PTycPjkkke/i6Nl/VirUWumPFWqsCrQ5ocqaJFuTe79fpGeHh9OnjUTP7kvUb3OoVBYyVckUeNbNrBQp9CxRWmNCVUTfp86dA3VSTf0jH/L1wdI5lctjPseC4MaCam9xqfV/qdkHlKD0npQf0vSz6ZNG07+6r+lXcsUET+H52Su4UEuUv/gvyNxK2L3e+uuJ1ZvCFUyEvU4ot8k9j3aE7a57IQ0mleZ2E42uttFNn5W875+Prq7vruOIXFVRiVkq4zhmNo9G0bBFmIiI6BVq42hUWkSjKLe2NKPh0DCZztXNQJUoyWsEmxsqs4as5MPVk8HT6C7eP8PK8qP2Y9X/2CPGsgWXiw+du271MyYbejPtaKkxFiv5b3ETxcEI3V1xxMl3cmQpamcwco3ztkA/DQbeq54fLJGbCvl+8Xqvdv20mmu35Pq5Wvh/qhbIJzPlHLiGh7DFgYsLgP2i+lGXTLNtIifyGHq9ixyBgqlvVKUTBOp5HT0mLGrJLF8hvPvhrzCvuLCut01xhYIg0MRgdeWMPt8ASou61NygGfR6RL9774KvvEGAAdW9Ai3GZMy0SojRvkaWbgD7rd1LwSwlDrC5VtUiBwaGy4XAGM5PxxdZJUiaAYypXQxOZZr22xGJoWCSLRAsFkQPHc8sWTYdurHMVoYSpEbyMF5gHDxFFcyi9yKUlutOSAueYbJJhFcOE8I5pKosrFCmSoNQybLP5YAU0e/36b9Hj+AlWku3ji3TFlNaPV2h3rTtbmUsJEzrjb+3yRmu8ckRZh2MmoFHJ3fJbDabyM7DERwRhXbhuN4zkb3euz//Ba6+UWuKqAVKGkvg3oXXjwPwpiox9xGXVoc5inI49kKZ4fOzVy69Hnj7f6uoBNQIa4ogumqOCy5/A5cGnSy9Xp1qAOWKayVJtb0ePJ795FQ0O6hBwSrC9MYKLMswcaoW5MEps2zPFCdKI5ywks254JTNaf0WTpjFhdIbuIW3ObPOZRMmIVVwO5G3/X7f/aOtvV4zIer14BZONDLyagrqGKoydd80rtSy9qkUye9b9+wHs7fuW1O+CP7qKH9VcUEjkcpQP9s6s0fBUmO/FCxxqJgu0JovHA+kGSWRYKkgoApTlvqKMYqsT/HprngZvMDQstvajapGr6GO5HLFrQM2yIRaB6Jn1VzwBHbZH+dMIzAo/cMQeoLLpQsfqXaq09DzBJovNMssvFV6STd5igS+LXdKd3TCDKR0wjiVZ1wywb3DFUA7dKB74oHY8/g7jxObkHsIvmugniu1JBdbaFYUzPKECbEJRL5WIkXtabzRCybprpYzLg2VAg1Mv9Dkjpk/FGi8xXmu1NITOfeJ2sFRn+AIcFWXx00uMeA9U4NaS0CZlopLG8hdmsDQOVrNkfJUkqiqToGJxpRTS+CrcrLg7W5okOO/++FvBr7FNeFOSBiPKGwEMlJOsHC4g4mJnL08vYBhsMRwxNOZu3F3nWw88+lzjijBWI2soJI+dd6gMa1kyqSFkmlWoCVNMTcNKtQKU0ey1ys1ZlwIF9q+3VmDRltpomOQzloUm+6AsUOw16PUsCQ3bDpqQGY4agqbRElTFTgIUp8xY9ZKp/0zrSwmlPLOXnwN46oslbYTSc9hNokyLnBa1psn0SygdohzN8Ja5yhhrbS73UUwykRvypqqGQS6mIKSo4mcnb0ZX8AwcfgS1DiDf/4DZmeX9zTuljsHgjMOR2HfdHebi5aw696DvfvcA8IIUuks6OdNlpEBYVyHNoWWVmIix2hJL4xmclPld03p6CQaUfWAcAsZEwZnoCT8iKDOhx6Q1CrAG2rduBVUgDhwpAqFe5ys72sAh0oDZEnegEVj37H3j3MlKA9QUTSr0XIGvvFz/sWSBEsCFpLJb5hqJZAsnXEUKbBEK2NcQeCkoOjSqrJoBnCRa0Sg/d6fTbDyyKceup3AHnO24hTc+wmn5mkGvccpZqwS9sBBl6sZ6qKKkIHqTOugv62mfGbwEDGj0pzoNGhjnJc21Q0pqi7glRSbANJ1dgFnzYDPM1ZSw+PJ0SC2KYzDdrwhrdWpox3scu3L8tsGWpieKwknqtzA45OTA2KOl5xwdCKfg8Q1qT1JWm3XYd8oEphQcuEQl+TBG25cDTCbRPPuOSUbWePGGWKfNnzLEpJgY8Whz+eNMU9dr8TSVKMh7CBUw5TiveGxbrmo4nWS9ROSrIvjdcelZIK7BqCepzZoOoDXfImtDDGxv8MNPDZVklPi81HSRjxPZwf1fKjWg2eN7KV5Wts9aABWTFQYu4TjUYo0KzgplrIpYFHaDTCt2QYez66uZwdfgCq472W8aq0CLnPU9eIu6b0S7PmKceEi9bSt/+o6rLNCMUGN0+X56wdqsLEvEV2++4i6sSlYmhZkl8J7pwzN6dNLOMfFvcMfmm7M9jPu71EbrhxI/RK+YslyzXRq4ITeEFjuKtQNbaXD5BxupArzsLGf1BuFr4Bh9cS58erJ4EnToIQywfiUaHNlEFb+Yg9IrLGHkn4iMA96d1SlgrlGnzWTnMkFBQLVCJ1EzQn40yrxseD4JdLKtaNMQCUFGgOKGuQ11Ur0iiPdc4xLg9TeveZy6dyhD1dNBfUW54ZbbNuT9Xp9T9MH7szXlRAQanQXcB9oavyxl9x+U83hHEtluFV6055acJtXc2fL7tnmS00g1NLNwPFTmilH8gJ1YWhuO0a94skHxB9a2j48cMPdvdHX7nRAY4aacMfstIKs5HXbeRX4AGLvU+Sg8UVdUrvBaT0PYyX/cp+OG4CSCG+yWt56Dvh+eaM4EjxBabAzWH3+8uw1rD4fHEZxZ6D4E2w5fP3q5PTb8SkxU4dJNIqeDA4Hh7REs9WCyc5ND/woYH8a03ml/2/+hqCeXLp3oKVg3A2LnVzbes571XmTRC/+cxoCj66i7Zai+ZIGW7T8fYWaJsjXcRRelLr5cRxGnjQYXiLNEE88z/0Lupu2i8pPT/fG5jSz9Seeu0LpvXu7c2oq+6I4Cm+JC5W6F2JsTT+JYGv/+sdDiH8xRWvbSDC5qNiC9nqaNKWlCd/uiHfpRrz1B5IqPJKbDoe7s18vBv0loR48sN368bGbufr9/tGPnqgVG3aT7a7v7u7+BUkSX1w=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Document list from status","permalink":"/docs/API-docs/v1.2/getdocumentlist"},"next":{"title":"Get Signer IPs","permalink":"/docs/API-docs/v1.2/getsignerips"}}');var o=t(74848),i=t(28453),r=t(57742),a=t.n(r),d=t(78178),l=t.n(d),p=t(19624),c=t.n(p),u=t(96226),m=t.n(u),g=(t(77675),t(19365),t(51107)),b=t(21312);const h={id:"resendrequestmail",title:"Resend request mail",description:"Resend request mail to user for signing document.",sidebar_label:"Resend request mail",hide_title:!0,hide_table_of_contents:!0,api:"eJztWt1uG7kVfpXTCdCNhZHkZNMbretu1vFmg6Ybw7IbFJYhUTNnNFxxyFmSI1mVDexF0QcoetPbvkTv+yh5kuKQw5mR7E02DdoCxV7EkTjk4fn9zs9oG1m2MNHoKnqhkqpAaU10HUcpmkTz0nIlo1F0jgZlChq/r9BYKBgXYBVUBjVkSoPhC8nlAtKaxGAiozhSJWpGFF6lDY2aBFGI4qj+9pVKN9FoGyVKWpSWPrKyFDxxp4ffGWJiG5kkx4LRJzrHNabEdrhzytMojtBRvo4juykxGkVq/h0mNoqjUhM7lqMhAt1Do23YbKzmckFUblhRCloqtVrxFBvJgKfRXbjmgZO7egunnaKc1jKtCqcu1IZUqLF/T7Veey0PdPrL+usgUUXDwNRUXrwPMnJSGVtfzGylsbnP0YGaDnAJFm/sMLeFIMMWzA7ghEngMhFVipApIdSaTL1imrO5QAOw3TbqtNwKvLuD7ZakQj2VrMC7u7hdoPt2FspcyXqLxgT5audUs4TtwWatcxRvSq4305TZeiFRRcnkpsuAd9JppWs6UtHmwY6u9xiHnJmgK0xhoyoyGlF6QOrWLvPaoT/JKETkZ4tER+XxN/wBVo6G5fFRefwWIVclgs25qRWXcZkaZ6s1CjGAI2O1kovjPRUcDev1h42sccVxDUym3t4tlX3dNoQGNU9/UJXumJUbSHSVcOZAs9QqQUxhzW0ONkeQeGPBWCwNMAPcejTNODoZNLCFRnTYQ7ywyuZK8z86aAwXHjHINWa//mxPp58dj4n1HDUeDdlxvftV5mTM2QqByQ04wbmSBpQGSbxllbY5akgE0zyrcTiGUiAzCATTLLGOea/RwMdFzuTSxEdzfXyBrIA3JUri4N2f/k47oru7OHJKi0aRdvmgDZc7etgCu9UVugVTKmk8aj89PHTgvRNFUfzT88b7k4JGU4kHwdQH3sMZwgMomcdUSYLGZJUQm8GOrFwKLnEahJk+PTycPjkkke/i6Nl/VirUWumPFWqsCrQ5ocqaJFuTe79fpGeHh9OnjUTP7kvUb3OoVBYyVckUeNbNrBQp9CxRWmNCVUTfp86dA3VSTf0jH/L1wdI5lctjPseC4MaCam9xqfV/qdkHlKD0npQf0vSz6ZNG07+6r+lXcsUET+H52Su4UEuUv/gvyNxK2L3e+uuJ1ZvCFUyEvU4ot8k9j3aE7a57IQ0mleZ2E42uttFNn5W875+Prq7vruOIXFVRiVkq4zhmNo9G0bBFmIiI6BVq42hUWkSjKLe2NKPh0DCZztXNQJUoyWsEmxsqs4as5MPVk8HT6C7eP8PK8qP2Y9X/2CPGsgWXiw+du271MyYbejPtaKkxFiv5b3ETxcEI3V1xxMl3cmQpamcwco3ztkA/DQbeq54fLJGbCvl+8Xqvdv20mmu35Pq5Wvh/qhbIJzPlHLiGh7DFgYsLgP2i+lGXTLNtIifyGHq9ixyBgqlvVKUTBOp5HT0mLGrJLF8hvPvhrzCvuLCut01xhYIg0MRgdeWMPt8ASou61NygGfR6RL9774KvvEGAAdW9Ai3GZMy0SojRvkaWbgD7rd1LwSwlDrC5VtUiBwaGy4XAGM5PxxdZJUiaAYypXQxOZZr22xGJoWCSLRAsFkQPHc8sWTYdurHMVoYSpEbyMF5gHDxFFcyi9yKUlutOSAueYbJJhFcOE8I5pKosrFCmSoNQybLP5YAU0e/36b9Hj+AlWku3ji3TFlNaPV2h3rTtbmUsJEzrjb+3yRmu8ckRZh2MmoFHJ3fJbDabyM7DERwRhXbhuN4zkb3euz//Ba6+UWuKqAVKGkvg3oXXjwPwpiox9xGXVoc5inI49kKZ4fOzVy69Hnj7f6uoBNQIa4ogumqOCy5/A5cGnSy9Xp1qAOWKayVJtb0ePJ795FQ0O6hBwSrC9MYKLMswcaoW5MEps2zPFCdKI5ywks254JTNaf0WTpjFhdIbuIW3ObPOZRMmIVVwO5G3/X7f/aOtvV4zIer14BZONDLyagrqGKoydd80rtSy9qkUye9b9+wHs7fuW1O+CP7qKH9VcUEjkcpQP9s6s0fBUmO/FCxxqJgu0JovHA+kGSWRYKkgoApTlvqKMYqsT/HprngZvMDQstvajapGr6GO5HLFrQM2yIRaB6Jn1VzwBHbZH+dMIzAo/cMQeoLLpQsfqXaq09DzBJovNMssvFV6STd5igS+LXdKd3TCDKR0wjiVZ1wywb3DFUA7dKB74oHY8/g7jxObkHsIvmugniu1JBdbaFYUzPKECbEJRL5WIkXtabzRCybprpYzLg2VAg1Mv9Dkjpk/FGi8xXmu1NITOfeJ2sFRn+AIcFWXx00uMeA9U4NaS0CZlopLG8hdmsDQOVrNkfJUkqiqToGJxpRTS+CrcrLg7W5okOO/++FvBr7FNeFOSBiPKGwEMlJOsHC4g4mJnL08vYBhsMRwxNOZu3F3nWw88+lzjijBWI2soJI+dd6gMa1kyqSFkmlWoCVNMTcNKtQKU0ey1ys1ZlwIF9q+3VmDRltpomOQzloUm+6AsUOw16PUsCQ3bDpqQGY4agqbRElTFTgIUp8xY9ZKp/0zrSwmlPLOXnwN46oslbYTSc9hNokyLnBa1psn0SygdohzN8Ja5yhhrbS73UUwykRvypqqGQS6mIKSo4mcnb0ZX8AwcfgS1DiDf/4DZmeX9zTuljsHgjMOR2HfdHebi5aw696DvfvcA8IIUuks6OdNlpEBYVyHNoWWVmIix2hJL4xmclPld03p6CQaUfWAcAsZEwZnoCT8iKDOhx6Q1CrAG2rduBVUgDhwpAqFe5ys72sAh0oDZEnegEVj37H3j3MlKA9QUTSr0XIGvvFz/sWSBEsCFpLJb5hqJZAsnXEUKbBEK2NcQeCkoOjSqrJoBnCRa0Sg/d6fTbDyyKceup3AHnO24hTc+wmn5mkGvccpZqwS9sBBl6sZ6qKKkIHqTOugv62mfGbwEDGj0pzoNGhjnJc21Q0pqi7glRSbANJ1dgFnzYDPM1ZSw+PJ0SC2KYzDdrwhrdWpox3scu3L8tsGWpieKwknqtzA45OTA2KOl5xwdCKfg8Q1qT1JWm3XYd8oEphQcuEQl+TBG25cDTCbRPPuOSUbWePGGWKfNnzLEpJgY8Whz+eNMU9dr8TSVKMh7CBUw5TiveGxbrmo4nWS9ROSrIvjdcelZIK7BqCepzZoOoDXfImtDDGxv8MNPDZVklPi81HSRjxPZwf1fKjWg2eN7KV5Wts9aABWTFQYu4TjUYo0KzgplrIpYFHaDTCt2QYez66uZwdfgCq472W8aq0CLnPU9eIu6b0S7PmKceEi9bSt/+o6rLNCMUGN0+X56wdqsLEvEV2++4i6sSlYmhZkl8J7pwzN6dNLOMfFvcMfmm7M9jPu71EbrhxI/RK+YslyzXRq4ITeEFjuKtQNbaXD5BxupArzsLGf1BuFr4Bh9cS58erJ4EnToIQywfiUaHNlEFb+Yg9IrLGHkn4iMA96d1SlgrlGnzWTnMkFBQLVCJ1EzQn40yrxseD4JdLKtaNMQCUFGgOKGuQ11Ur0iiPdc4xLg9TeveZy6dyhD1dNBfUW54ZbbNuT9Xp9T9MH7szXlRAQanQXcB9oavyxl9x+U83hHEtluFV6055acJtXc2fL7tnmS00g1NLNwPFTmilH8gJ1YWhuO0a94skHxB9a2j48cMPdvdHX7nRAY4aacMfstIKs5HXbeRX4AGLvU+Sg8UVdUrvBaT0PYyX/cp+OG4CSCG+yWt56Dvh+eaM4EjxBabAzWH3+8uw1rD4fHEZxZ6D4E2w5fP3q5PTb8SkxU4dJNIqeDA4Hh7REs9WCyc5ND/woYH8a03ml/2/+hqCeXLp3oKVg3A2LnVzbes571XmTRC/+cxoCj66i7Zai+ZIGW7T8fYWaJsjXcRRelLr5cRxGnjQYXiLNEE88z/0Lupu2i8pPT/fG5jSz9Seeu0LpvXu7c2oq+6I4Cm+JC5W6F2JsTT+JYGv/+sdDiH8xRWvbSDC5qNiC9nqaNKWlCd/uiHfpRrz1B5IqPJKbDoe7s18vBv0loR48sN368bGbufr9/tGPnqgVG3aT7a7v7u7+BUkSX1w=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},q=void 0,v={},T=[];function x(e){const s={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:"Resend request mail"}),"\n",(0,o.jsx)(a(),{method:"post",path:"/resendmail",context:"endpoint"}),"\n",(0,o.jsx)(s.p,{children:"Resend request mail to user for signing document."}),"\n",(0,o.jsx)(g.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,o.jsx)(b.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,o.jsx)(l(),{parameters:void 0}),"\n",(0,o.jsx)(c(),{...t(91734)}),"\n",(0,o.jsx)(m(),{...t(73436)})]})}function y(e={}){const{wrapper:s}={...(0,i.R)(),...e.components};return s?(0,o.jsx)(s,{...e,children:(0,o.jsx)(x,{...e})}):x(e)}},91734(e){e.exports=JSON.parse('{"title":"Body","body":{"content":{"application/json":{"schema":{"required":["document_id","email"],"type":"object","properties":{"document_id":{"type":"string","example":"provide document id"},"email":{"type":"string","description":"provide user mail from signers to re-send request mail.\\n","example":"user@example.com"},"email_subject":{"type":"string","description":"Custom signature request email subject in text/html format. Can include following variables {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.","example":"{{sender_name}} has requested you to sign {{document_title}}"},"email_body":{"type":"string","description":"Custom signature request email body in text/html format. Can include following variables {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.","example":"

Hi {{receiver_name}},

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

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

Sign here

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

Thanks,
Team OpenSign\u2122

"}},"title":"resendmail_body"}}},"required":true}}')},73436(e){e.exports=JSON.parse('{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","format":"string","example":"mail sent successfully."}},"title":"inline_response_200_10"}}}},"400":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","format":"string","example":"Something went wrong."}},"title":"inline_response_400_2"}}}},"404":{"description":"- document not found if document id is not correct.\\n- user not found if provided user email is not present in signer list of document\\n","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","format":"string","example":"document not found or user not found."}},"title":"inline_response_404_1"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/c081699b.e867724d.js b/assets/js/c081699b.e867724d.js deleted file mode 100644 index fd55ebda7..000000000 --- a/assets/js/c081699b.e867724d.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[5741],{65629(e,t,n){n.r(t),n.d(t,{assets:()=>W,contentTitle:()=>b,default:()=>f,frontMatter:()=>x,metadata:()=>s,toc:()=>j});const s=JSON.parse('{"id":"API-docs/v1.2/resendrequestmail","title":"Resend request mail","description":"Resend request mail to user for signing document.","source":"@site/docs/API-docs/v1.2/resendrequestmail.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/resendrequestmail","permalink":"/docs/API-docs/v1.2/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":"eJztWM2OG7kRfpUKD/Fa6JFkx7loJ4N1HMM7yGBteGYxCMYDgequVnOHTXL5I40iCNjDvsGecs2j+UmCIvtPGq1/YiQBgr0IapJVrPqK/KqKW+b50rHZDfuLzkONyjt2m7ECXW6F8UIrNmNv0aEqwOKPAZ2HmgsJXkNwaKHUFpxYKqGWUDQqxu8Uy5g2aDlpOC86HY0K0sAy1nz9WRcbNtuyXCuPytNfbowUeZSe/ODIiC1zeYU1p38kJywWZHa751wULGMYNd9mzG8MshnTix8w9yxjxpI5XqAjBUOh2bZd7LwVakla7nltJA0Zq1eiwM4zEAXbtdsckdzHrZWOQEXUSqvrCBdaRxBaPHkAbUKvt4Gkv2k+x7muOwPmLiT3PmrIi+B8szH3wWK3X9QDjR4QCjze+0nla0mBrbkfwwuuQKhchgKh1FLqNYV6xa3gC4kOYLvt4PTCS9ztYLslr9DOFa9xt8v6Adpvb8BUWjVLLOYoVntS3RD2gt3YQBTvjbCbecF9M5Dr2nC1GRqQDuk82EaP0rR4vIf1geFQcddihQVsdKCgkaYjXvdxWTQH+ouCQkp+iwg7NWffiiOmnE7M2ak5u0aotEHwlXANcKVQhYuxWqOUYzh13mq1PDuA4HTSjB8PssWVwDVwVaR491oOse0UjRub/qaDHYRVOMhtyAWPpGmszhELWAtfga8QFN57cB6NA+5A+MSmpcDogwW+tIiRe8gWHnylrfh7pMZ2w1MOlcXyT48OMH10dkmmV2jxdMLPmtXnZfSx4isErjYQHRdaOdAWFNlWBusrtJBLbkXZ8HAGRiJ3CETTPPfR+IRoa8dVxdWdy04X9uwKeQ2vDSqy4P3P/6QVbLfLWASNzZiN+aC/Ljua7Ind24BxwBmtXGLtp9NpJO+9W8SyT88bH04KFl2QR8k0XbzjGSIRKIXHhTxH58og5Wa856tQUiict87Mn06n8ydTcnmXsWf/Wa/QWm0/16lLXaOviFXW5NmajveHXXo2nc6fdh49e+jRSZ9DlfZQ6qAKEOUws9JNoblcW4s5VREnKXXuCTRJtUhT6co3giYeqpjHUo4FKZwH3e8SU+v/EtkjIGh74OXHkH42f9Ih/ceHSJ+rFZeigOdvzuFK36H63X/B597D4fY+bU+m3texYCLujU7FRXGe7Tk7HE9OOsyDFX7DZjdbdn/CjThJ87Ob291txuioaioxjXbRYu4rNmOTnmEYKbErtC7qCFayGau8N242mTiuioW+H2uDik6N5AtHZdaEGzFZPRk/ZbvsUIYb81nrMZx8rojzfCnU8mNytz0+lxTDFKY9lLpgcSP+ihuWtUEYrsqYoLNTIS/QxoDR0XjbF+gv2wAfVM9HS+SuQn5YvD6oXb+s5tovuX6rFv6fqgU6k6WOB7ihh3ZJJJd4AQ6L6muUua6RsKMdR6OB1k5qNOpOa0LmnXqnXgcLRq/RlkFG8EqJ92IhMYphHedcdx6R1xKdk1Sje1xa7hEKsRSey64fzrnhCyEFsSct002MegJ2Y7iuMMK30eGRReBQ4AolkS6FT9fcD1trWGt7V0q9dhlwWAQnFDoHqCquclrYskFG8eEKUHm0xgqH4Lwlq0WyTStvKTA1V3wZj0w2DAEUKOkGObB6EZwHp2VIgfdcSG2xgNYhOgYugvjy3tAU0CgV/BYroq4VwjKIAl0GuS4QXOQDckEVsKCex5AtIsfYFQcldX4XA0jVFBhNuYuuhC73bCRxb7lylHKTLW0MOsDiFXIOk4Gj0fcOKcIXQt252WhERcZNd66uceGEx9uvWhper9cP6Pfxvswr4b8NC3iLRjvhtd300kvhq7CIlD1U0n0kTa9QYTw/A0LudRQ6dw8zAI1OKpRmcomeToibPH9zHtP9Y3j/0y9wgdwqqPQ6ndY8WJQbWLZbEXIp8gm2LlvHBx3iDUI8T4evobsWweuK+/c//cPBd7imWitdKXJlNHqFHq6wNpI2+T3sfV4I50ejGVis9YoKOKWQQsPtBgy3vEZP5y2SKNIAEayxWAopoeCeD59PBhKxUHzHSiFxbrhza22Ld6xfALygelEoyC2SIb6xKINgiv2BZkV/3SLxdtOF5aXvZ5Opskykb3Xw6QC3ObG1JoJqrPaYR5+KsjWaU/s+12UZizxS80mWx50PjB/sH7XGqjJ+oqKHASKEQrj0N23YMRXZ5ysUttPWGpjQnlst8bhlkdibF61UNcaCew+oB7h+FOgHkSKHTVhIkR86PIbneY6GgF1xGdDNYDRKFo1G8FWBJQ/SP85gNKIkTaP0nxuKEn2N4bKxvyaiS6nOA+UvD7pBKWXntSiW6L+GpGgooHQz6b6GVrWDmm/61NnMR1d18MAP3n6Exf719KCE289yFku0hF0Mb3+pjWgu8U1LBkAc8SVkQmm4yeGxAWjqOm7EN4d6YiGPtnavy0u0K5FjU8/+Co9O4uIJy5gUOSqHgwbh+as3F7D6w3jKskFh/AmUOrk4f/Hyu8uXZAyFIAH2ZDwdT2mIeoSaq8FORx63D6uKwdP0v/kW3lTg8S3PSC5i0xP92jb9ys3gRYQesCtqZmY3bLtdcIffU4FGwz8GtNQJ3WasffCLfVDWlu7U4Nwh1cIvks0nV7Q3LZchdQEH7R/1Hkki3aMPrh32W29eX16xjLWvnbUu4sMOX9PTPl+nZwwdMUwPLDS2ZZKrZeBLWpt0UrdBGWe/VbmLrUrzh7xqp9RmYOF+D5PcoF9y6qjAdpvaoNg7pPVp6lclGmDb1RS7291u9y+FYBfV","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Document list from status","permalink":"/docs/API-docs/v1.2/getdocumentlist"},"next":{"title":"Get Signer IPs","permalink":"/docs/API-docs/v1.2/getsignerips"}}');var i=n(74848),r=n(28453),o=n(57742),a=n.n(o),d=n(78178),u=n.n(d),l=n(19624),c=n.n(l),m=n(96226),p=n.n(m),g=(n(77675),n(19365),n(51107)),h=n(21312);const x={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:"eJztWM2OG7kRfpUKD/Fa6JFkx7loJ4N1HMM7yGBteGYxCMYDgequVnOHTXL5I40iCNjDvsGecs2j+UmCIvtPGq1/YiQBgr0IapJVrPqK/KqKW+b50rHZDfuLzkONyjt2m7ECXW6F8UIrNmNv0aEqwOKPAZ2HmgsJXkNwaKHUFpxYKqGWUDQqxu8Uy5g2aDlpOC86HY0K0sAy1nz9WRcbNtuyXCuPytNfbowUeZSe/ODIiC1zeYU1p38kJywWZHa751wULGMYNd9mzG8MshnTix8w9yxjxpI5XqAjBUOh2bZd7LwVakla7nltJA0Zq1eiwM4zEAXbtdsckdzHrZWOQEXUSqvrCBdaRxBaPHkAbUKvt4Gkv2k+x7muOwPmLiT3PmrIi+B8szH3wWK3X9QDjR4QCjze+0nla0mBrbkfwwuuQKhchgKh1FLqNYV6xa3gC4kOYLvt4PTCS9ztYLslr9DOFa9xt8v6Adpvb8BUWjVLLOYoVntS3RD2gt3YQBTvjbCbecF9M5Dr2nC1GRqQDuk82EaP0rR4vIf1geFQcddihQVsdKCgkaYjXvdxWTQH+ouCQkp+iwg7NWffiiOmnE7M2ak5u0aotEHwlXANcKVQhYuxWqOUYzh13mq1PDuA4HTSjB8PssWVwDVwVaR491oOse0UjRub/qaDHYRVOMhtyAWPpGmszhELWAtfga8QFN57cB6NA+5A+MSmpcDogwW+tIiRe8gWHnylrfh7pMZ2w1MOlcXyT48OMH10dkmmV2jxdMLPmtXnZfSx4isErjYQHRdaOdAWFNlWBusrtJBLbkXZ8HAGRiJ3CETTPPfR+IRoa8dVxdWdy04X9uwKeQ2vDSqy4P3P/6QVbLfLWASNzZiN+aC/Ljua7Ind24BxwBmtXGLtp9NpJO+9W8SyT88bH04KFl2QR8k0XbzjGSIRKIXHhTxH58og5Wa856tQUiict87Mn06n8ydTcnmXsWf/Wa/QWm0/16lLXaOviFXW5NmajveHXXo2nc6fdh49e+jRSZ9DlfZQ6qAKEOUws9JNoblcW4s5VREnKXXuCTRJtUhT6co3giYeqpjHUo4FKZwH3e8SU+v/EtkjIGh74OXHkH42f9Ih/ceHSJ+rFZeigOdvzuFK36H63X/B597D4fY+bU+m3texYCLujU7FRXGe7Tk7HE9OOsyDFX7DZjdbdn/CjThJ87Ob291txuioaioxjXbRYu4rNmOTnmEYKbErtC7qCFayGau8N242mTiuioW+H2uDik6N5AtHZdaEGzFZPRk/ZbvsUIYb81nrMZx8rojzfCnU8mNytz0+lxTDFKY9lLpgcSP+ihuWtUEYrsqYoLNTIS/QxoDR0XjbF+gv2wAfVM9HS+SuQn5YvD6oXb+s5tovuX6rFv6fqgU6k6WOB7ihh3ZJJJd4AQ6L6muUua6RsKMdR6OB1k5qNOpOa0LmnXqnXgcLRq/RlkFG8EqJ92IhMYphHedcdx6R1xKdk1Sje1xa7hEKsRSey64fzrnhCyEFsSct002MegJ2Y7iuMMK30eGRReBQ4AolkS6FT9fcD1trWGt7V0q9dhlwWAQnFDoHqCquclrYskFG8eEKUHm0xgqH4Lwlq0WyTStvKTA1V3wZj0w2DAEUKOkGObB6EZwHp2VIgfdcSG2xgNYhOgYugvjy3tAU0CgV/BYroq4VwjKIAl0GuS4QXOQDckEVsKCex5AtIsfYFQcldX4XA0jVFBhNuYuuhC73bCRxb7lylHKTLW0MOsDiFXIOk4Gj0fcOKcIXQt252WhERcZNd66uceGEx9uvWhper9cP6Pfxvswr4b8NC3iLRjvhtd300kvhq7CIlD1U0n0kTa9QYTw/A0LudRQ6dw8zAI1OKpRmcomeToibPH9zHtP9Y3j/0y9wgdwqqPQ6ndY8WJQbWLZbEXIp8gm2LlvHBx3iDUI8T4evobsWweuK+/c//cPBd7imWitdKXJlNHqFHq6wNpI2+T3sfV4I50ejGVis9YoKOKWQQsPtBgy3vEZP5y2SKNIAEayxWAopoeCeD59PBhKxUHzHSiFxbrhza22Ld6xfALygelEoyC2SIb6xKINgiv2BZkV/3SLxdtOF5aXvZ5Opskykb3Xw6QC3ObG1JoJqrPaYR5+KsjWaU/s+12UZizxS80mWx50PjB/sH7XGqjJ+oqKHASKEQrj0N23YMRXZ5ysUttPWGpjQnlst8bhlkdibF61UNcaCew+oB7h+FOgHkSKHTVhIkR86PIbneY6GgF1xGdDNYDRKFo1G8FWBJQ/SP85gNKIkTaP0nxuKEn2N4bKxvyaiS6nOA+UvD7pBKWXntSiW6L+GpGgooHQz6b6GVrWDmm/61NnMR1d18MAP3n6Exf719KCE289yFku0hF0Mb3+pjWgu8U1LBkAc8SVkQmm4yeGxAWjqOm7EN4d6YiGPtnavy0u0K5FjU8/+Co9O4uIJy5gUOSqHgwbh+as3F7D6w3jKskFh/AmUOrk4f/Hyu8uXZAyFIAH2ZDwdT2mIeoSaq8FORx63D6uKwdP0v/kW3lTg8S3PSC5i0xP92jb9ys3gRYQesCtqZmY3bLtdcIffU4FGwz8GtNQJ3WasffCLfVDWlu7U4Nwh1cIvks0nV7Q3LZchdQEH7R/1Hkki3aMPrh32W29eX16xjLWvnbUu4sMOX9PTPl+nZwwdMUwPLDS2ZZKrZeBLWpt0UrdBGWe/VbmLrUrzh7xqp9RmYOF+D5PcoF9y6qjAdpvaoNg7pPVp6lclGmDb1RS7291u9y+FYBfV",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},b=void 0,W={},j=[];function q(e){const t={p:"p",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(g.default,{as:"h1",className:"openapi__heading",children:"Resend request mail"}),"\n",(0,i.jsx)(a(),{method:"post",path:"/resendmail",context:"endpoint"}),"\n",(0,i.jsx)(t.p,{children:"Resend request mail to user for signing document."}),"\n",(0,i.jsx)(g.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,i.jsx)(h.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,i.jsx)(u(),{parameters:void 0}),"\n",(0,i.jsx)(c(),{...n(91734)}),"\n",(0,i.jsx)(p(),{...n(73436)})]})}function f(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(q,{...e})}):q(e)}},91734(e){e.exports=JSON.parse('{"title":"Body","body":{"content":{"application/json":{"schema":{"required":["document_id","email"],"type":"object","properties":{"document_id":{"type":"string","example":"provide document id"},"email":{"type":"string","description":"provide user mail from signers to re-send request mail.\\n","example":"user@example.com"},"email_subject":{"type":"string","description":"Custom signature request email subject in text/html format. Can include following variables {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.","example":"{{sender_name}} has requested you to sign {{document_title}}"},"email_body":{"type":"string","description":"Custom signature request email body in text/html format. Can include following variables {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.","example":"

Hi {{receiver_name}},

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

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

Sign here

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

Thanks,
Team OpenSign\u2122

"}},"title":"resendmail_body"}}},"required":true}}')},73436(e){e.exports=JSON.parse('{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","format":"string","example":"mail sent successfully."}},"title":"inline_response_200_10"}}}},"400":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","format":"string","example":"Something went wrong."}},"title":"inline_response_400_2"}}}},"404":{"description":"- document not found if document id is not correct.\\n- user not found if provided user email is not present in signer list of document\\n","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","format":"string","example":"document not found or user not found."}},"title":"inline_response_404_1"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/d387ddbc.6d78f6de.js b/assets/js/d387ddbc.6d78f6de.js new file mode 100644 index 000000000..aef4379b3 --- /dev/null +++ b/assets/js/d387ddbc.6d78f6de.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[206],{4746(e,t,a){a.r(t),a.d(t,{assets:()=>j,contentTitle:()=>f,default:()=>x,frontMatter:()=>w,metadata:()=>s,toc:()=>b});const s=JSON.parse('{"id":"API-docs/v1.2/getformdata","title":"Get Formdata","description":"The Get Formdata API enables you to retrieve widget data filled by signers who signed the document.","source":"@site/docs/API-docs/v1.2/getformdata.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/getformdata","permalink":"/docs/API-docs/v1.2/getformdata","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getformdata","title":"Get Formdata","description":"The Get Formdata API enables you to retrieve widget data filled by signers who signed the document.","sidebar_label":"Get Formdata","hide_title":true,"hide_table_of_contents":true,"api":"eJzVGdtuG7n1V04ZoLCFkWQ72RdtsV2v43jdpolh2c2DZVjU8EjDFYecJTkjC7aAfSj6AUVf+tqf6Hs/JV9SHHJmJNlOssa2CzRAYoc8PPf73DHPZ44Nrthrk5Y5au/YdcIEutTKwkuj2YBdZAgn6OGNsbngnsPh2Smg5hOFDpamBG/AorcSK4SFFDP0EOCmUikUMFmCkzON1sEiM/F3AT5DEDXR3kiP9DvjcQAXmXSBgHRgtFoCr7hURAumxsIF8twB1wKOtUdbWOkQCsW16400S5gp0HLi+1SwAZuhn9ZMs4QV3PIcPVoS+I5pniMbsIaHGylYwiQJXHCfsYdaMJMfMPWnAswUGmWxhFn8sZQWBRt4W2LCnF8qQutkXihkCcPbQhmBbDDlyhFAmmHO2eCO+WURIL2VesYSRqxyv3mCtzxgGTD+3UGaHmTFJGOr1TWRdYXRDh0hOtjbox/b/LoyTdG5aamgVQpLWGq0J84Hd4wXhZJpuOj/4OjR3WPuotikPUtovIwkG208V443J3J+8HKSXf6BrRLmpafT56Fw4RfyHULhyHSC+2ej2d/v7+/3D/YOvgpoPPeley6O1NAvHgWhIMCb4GprLNxaviS38pi7L2s1uuRjHtYUfzATmCASPcy5VF+EniB+Gw96qcnpXYxQ97/mMtp2tXbVzz9J0bAV/UnYba7WZDbUunaYzcOnX9DdeUP4wcPtu4Dg1VMRNDQ5+kzqGSxQe1hYo2cJFAq5Q/B2CXzGpQbFPdrf/PdCC6019vPKeh5nqw35pVZS401jk5tXe3s3+60SXj1WQpPqQBsPU1Nq8euK+hT9zwv06uZlK9BXjwU61RVXUoQac2HmqH9deTbJ+0j+sQfLCBTu2Zawm+dRSIdpaaVfhpp22+WF7Mb7wdU1VQryFFMXw1AEfcYGrN8EQv9uowCuGOGzVVMiS6vYgGXeF27Q7zuuxcTc9kyBmoq44hNHSaXPC9mv9nsHbJU8fMOL4lnwWHaf+8R5PpN69qV312tVDcmc0WJbClsnxEL+ESkj1vbYhKp7hAy5QBtsJ/XUhMe1ld4XqIdypoONA/GHvcQLaGA+/uWfLRg1Qd9Ap0P9FgnSdaa0KYZuI+DjyqPV3MsK4eNPf4dJKZUPbZHAChV5okvA29L52HZh2yO5XqdD+DfpzmRVN3AcmkqWQGGNKFNitGuRiyVglzTKfWlDpxU6KvCZNeUsAw5O6pnCBM6PhxfUbByenfZgiFq03Z0LLLZIEsi55jMEjznhw8AzT+cBhJJaLMYgNVjkCrzMMQk9Hy+9yblHYtqSdNKum0hQcorpMlVROVwpWEifmdJDhVoYC8qk867Uodvsdrv048ULam09UR16bj0KOj2u0C6BWjt0HvLSeUi5tctItw1d4pDa2PGGf4whekYgMh6PR3rjcgC/Iwzrg29qmJHudD7+9W9w9b1ZUDs9Q00tGz4geL3TOL0wqXvs7XTaz1AV/WEUyvUPz05DltuN9n9nPDiy5CJDi0RqgjOpfw+XVDkyhE6nDnNAXUlrNKm204Gd8c9OA+NdwltY4w3FU2sFPp1iGlStyIMp+zwwxZGxCEe84BOpJCVVOr+HI+5xZuwS7uFDxn1w2ZRrEAbuR/q+2+2GvwTa6bSDTKcD93BkkZNXO9QigbIQ4X8WKzOvfUog+f3aPbuN2dfuW2O+aPw1YP6ulEqAxdKF4aR15iAuFBa7heIpinoicl8HHkgzRiMYS1GwHoxqEkNU0y7FZyBx0niBo+N6blqz1eq1xgJSV9KHygVTZRYN0rNyomQK2+wPM24ROBTxsgk9JfU8hI82DVYlnYdmzGlwvrZ86uGDsXOiFDHyCje4M3ZDJ9yBoBdxdJtKzZWMDpfHLqXBe2S052ltvD/FPBFioGYmjfcwMWZOLjazPM+5lylXatkgeWOUQBtxvLczronWmjOpnRTYpmB4bckdp/FRg+MDTjJj5hHJOaZIMJSOupSOAKu6J5HTullwED3TglloQC0KI7Vv0F26hqHzZlLmaWpK7YNGUotCeqBKQtMGWfB+OzTI8T/+9A8H73BBeacpGC8obBRyUk5j4YYGVyM9Pjm+gH5jif5AinGguH1ONh5DRhacIGpw3iLPqbMSwRssilILrj2sh2ggB7KYmwpFQNnpFBZp5o/Tv3SgzYI2A6UlPA7prUe1hKk1eWPRNcJOh0rDnNywHW8BuZNoKWxSo12ZY6+R+ow7tzBWdM+s8ZhSyTt7/QaGZVEY60ea7mE8YlOp8KaogUds3GTtJs4nRiwpHWpYGBuohwhGndplUWN1vQYvCjB6MNLjs/fDC+inIb80ahzDv/8F47PLRxoPxxsPGmfsDxq4m22wEC0N1KOLB/TCBeUIUum40c/76ZQMCMM6tCm0rFEjPURPeuFKmcWNiVA39HTEBtQ9INxDWFaMwWj4hKDBh56Q1BugjYdMpVfLektEuUDImCdrem3CodYAeZq1yaK17zD6x7lRVAeoKRrX2XIMsf8O/sXTFAtKLCRTBLixRiFZeipRCeCpNc6FhiBIQdFlTenR9eAis4hA8NGfXWPlQSw9RJ2SPWa8khTcDwtOzdMYOjsCp7xUfjekrtAz1E0VZQaazXxI/etuqt6VRTyVxAXhabON21qRBUVZJKi4F6uTdF1dIFizyc9jXhTWVBHdEdcxsqneNOB4S1qrS0fkpk7xgdh9m1q4nRgNR6ZYws7R0S4xJwtJeXSkD0HjgtSepmtt12HfKhK4MnoWMi7Jg7fShR5gPGKTzXdGt7ImrTMksWwEb2uLYGvFfqznrTGPaSMCXAiLjnIHZTUUFO8tj7bO5JwauonR3ZQk28zjEPYqYHSK2waQrjWo6MFbOce1DAmxv8UN7LgyzajwxShZR7wU410qXZUUtR4ia2QvK0Vt90YDUHFVYhIKTsxSpFklSbFUTQHzwi8hrHBgZ3x1Pd79GkwufcASVesNSJ2hrQ+3UT9owQ7bdevxuv+r+7CNE4oJWjZcnr99ogcbxhYx1Ltn9I1tw9KOINsYPjvhta+PL+EcZ48ef2myHD+suH9G66QJSeq38B1P5wtuhYMjkxfcy9ChLgmUHpNzTEtqQSYNYDetAVXsgKHaD25c7ff22wGlaRNcLIk+Mw6hioRjQlqvvw2VLelg0ug9YNUGJhZj1UwzrmcUCNQjbBRqSYlflGmMhcAvoTZhHOUKSq3QOTA+Q7ugXkkb8vFtdVw6pPHurdTz4A5duGo7qA84cdLjejxZLBaPNL0b3rwplWr35yHgvjDUxGcn0n9fTuAcC+OkN3a5fjWTPisnwZabb9v/1AiaXrrd+/ySYSqgvECbO/ocMERbyfQL4vc9gfd3w2eKB2uH7e2AxSlayjtuaxTkhazHzquGDyD2fokctFyqW+qwv4orZdp/fPsQT9hDkQjvp7W89Q7m8/KyhCmZYr3/rfcphydnb6F62dtjycYy52fYsv/29Oj43fCYmKnDhFb5vb3eHh0Vxvmc6w1Km9+tHq5h7tZrv/+rb1z1ksrjre8XisuwIgxqvKvXe1ds47PXYPML13XCMuM8gdzdUSa5tGq1ouMfS7S0RLxOWMWtJG7CDrBu3ET7AeuTOtw5r4fEXfjEx7InOW92bpoWbqEksQFjCZvj8sHnudX1KmkWb8RahDgMDeDG20cb3K016MnxBUsYL0lPmwu/eVj41b8Q9if52t4ERgboX1pLPvng7i4uE1erFj5effJFLWADTUq6Xq1W/wFv7HuE","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Signer IPs","permalink":"/docs/API-docs/v1.2/getsignerips"},"next":{"title":"Get Signing Links","permalink":"/docs/API-docs/v1.2/getsigninglinks"}}');var n=a(74848),i=a(28453),o=a(57742),r=a.n(o),d=a(78178),p=a.n(d),c=a(19624),m=a.n(c),l=a(96226),h=a.n(l),u=(a(77675),a(19365),a(51107)),g=a(21312);const w={id:"getformdata",title:"Get Formdata",description:"The Get Formdata API enables you to retrieve widget data filled by signers who signed the document.",sidebar_label:"Get Formdata",hide_title:!0,hide_table_of_contents:!0,api:"eJzVGdtuG7n1V04ZoLCFkWQ72RdtsV2v43jdpolh2c2DZVjU8EjDFYecJTkjC7aAfSj6AUVf+tqf6Hs/JV9SHHJmJNlOssa2CzRAYoc8PPf73DHPZ44Nrthrk5Y5au/YdcIEutTKwkuj2YBdZAgn6OGNsbngnsPh2Smg5hOFDpamBG/AorcSK4SFFDP0EOCmUikUMFmCkzON1sEiM/F3AT5DEDXR3kiP9DvjcQAXmXSBgHRgtFoCr7hURAumxsIF8twB1wKOtUdbWOkQCsW16400S5gp0HLi+1SwAZuhn9ZMs4QV3PIcPVoS+I5pniMbsIaHGylYwiQJXHCfsYdaMJMfMPWnAswUGmWxhFn8sZQWBRt4W2LCnF8qQutkXihkCcPbQhmBbDDlyhFAmmHO2eCO+WURIL2VesYSRqxyv3mCtzxgGTD+3UGaHmTFJGOr1TWRdYXRDh0hOtjbox/b/LoyTdG5aamgVQpLWGq0J84Hd4wXhZJpuOj/4OjR3WPuotikPUtovIwkG208V443J3J+8HKSXf6BrRLmpafT56Fw4RfyHULhyHSC+2ej2d/v7+/3D/YOvgpoPPeley6O1NAvHgWhIMCb4GprLNxaviS38pi7L2s1uuRjHtYUfzATmCASPcy5VF+EniB+Gw96qcnpXYxQ97/mMtp2tXbVzz9J0bAV/UnYba7WZDbUunaYzcOnX9DdeUP4wcPtu4Dg1VMRNDQ5+kzqGSxQe1hYo2cJFAq5Q/B2CXzGpQbFPdrf/PdCC6019vPKeh5nqw35pVZS401jk5tXe3s3+60SXj1WQpPqQBsPU1Nq8euK+hT9zwv06uZlK9BXjwU61RVXUoQac2HmqH9deTbJ+0j+sQfLCBTu2Zawm+dRSIdpaaVfhpp22+WF7Mb7wdU1VQryFFMXw1AEfcYGrN8EQv9uowCuGOGzVVMiS6vYgGXeF27Q7zuuxcTc9kyBmoq44hNHSaXPC9mv9nsHbJU8fMOL4lnwWHaf+8R5PpN69qV312tVDcmc0WJbClsnxEL+ESkj1vbYhKp7hAy5QBtsJ/XUhMe1ld4XqIdypoONA/GHvcQLaGA+/uWfLRg1Qd9Ap0P9FgnSdaa0KYZuI+DjyqPV3MsK4eNPf4dJKZUPbZHAChV5okvA29L52HZh2yO5XqdD+DfpzmRVN3AcmkqWQGGNKFNitGuRiyVglzTKfWlDpxU6KvCZNeUsAw5O6pnCBM6PhxfUbByenfZgiFq03Z0LLLZIEsi55jMEjznhw8AzT+cBhJJaLMYgNVjkCrzMMQk9Hy+9yblHYtqSdNKum0hQcorpMlVROVwpWEifmdJDhVoYC8qk867Uodvsdrv048ULam09UR16bj0KOj2u0C6BWjt0HvLSeUi5tctItw1d4pDa2PGGf4whekYgMh6PR3rjcgC/Iwzrg29qmJHudD7+9W9w9b1ZUDs9Q00tGz4geL3TOL0wqXvs7XTaz1AV/WEUyvUPz05DltuN9n9nPDiy5CJDi0RqgjOpfw+XVDkyhE6nDnNAXUlrNKm204Gd8c9OA+NdwltY4w3FU2sFPp1iGlStyIMp+zwwxZGxCEe84BOpJCVVOr+HI+5xZuwS7uFDxn1w2ZRrEAbuR/q+2+2GvwTa6bSDTKcD93BkkZNXO9QigbIQ4X8WKzOvfUog+f3aPbuN2dfuW2O+aPw1YP6ulEqAxdKF4aR15iAuFBa7heIpinoicl8HHkgzRiMYS1GwHoxqEkNU0y7FZyBx0niBo+N6blqz1eq1xgJSV9KHygVTZRYN0rNyomQK2+wPM24ROBTxsgk9JfU8hI82DVYlnYdmzGlwvrZ86uGDsXOiFDHyCje4M3ZDJ9yBoBdxdJtKzZWMDpfHLqXBe2S052ltvD/FPBFioGYmjfcwMWZOLjazPM+5lylXatkgeWOUQBtxvLczronWmjOpnRTYpmB4bckdp/FRg+MDTjJj5hHJOaZIMJSOupSOAKu6J5HTullwED3TglloQC0KI7Vv0F26hqHzZlLmaWpK7YNGUotCeqBKQtMGWfB+OzTI8T/+9A8H73BBeacpGC8obBRyUk5j4YYGVyM9Pjm+gH5jif5AinGguH1ONh5DRhacIGpw3iLPqbMSwRssilILrj2sh2ggB7KYmwpFQNnpFBZp5o/Tv3SgzYI2A6UlPA7prUe1hKk1eWPRNcJOh0rDnNywHW8BuZNoKWxSo12ZY6+R+ow7tzBWdM+s8ZhSyTt7/QaGZVEY60ea7mE8YlOp8KaogUds3GTtJs4nRiwpHWpYGBuohwhGndplUWN1vQYvCjB6MNLjs/fDC+inIb80ahzDv/8F47PLRxoPxxsPGmfsDxq4m22wEC0N1KOLB/TCBeUIUum40c/76ZQMCMM6tCm0rFEjPURPeuFKmcWNiVA39HTEBtQ9INxDWFaMwWj4hKDBh56Q1BugjYdMpVfLektEuUDImCdrem3CodYAeZq1yaK17zD6x7lRVAeoKRrX2XIMsf8O/sXTFAtKLCRTBLixRiFZeipRCeCpNc6FhiBIQdFlTenR9eAis4hA8NGfXWPlQSw9RJ2SPWa8khTcDwtOzdMYOjsCp7xUfjekrtAz1E0VZQaazXxI/etuqt6VRTyVxAXhabON21qRBUVZJKi4F6uTdF1dIFizyc9jXhTWVBHdEdcxsqneNOB4S1qrS0fkpk7xgdh9m1q4nRgNR6ZYws7R0S4xJwtJeXSkD0HjgtSepmtt12HfKhK4MnoWMi7Jg7fShR5gPGKTzXdGt7ImrTMksWwEb2uLYGvFfqznrTGPaSMCXAiLjnIHZTUUFO8tj7bO5JwauonR3ZQk28zjEPYqYHSK2waQrjWo6MFbOce1DAmxv8UN7LgyzajwxShZR7wU410qXZUUtR4ia2QvK0Vt90YDUHFVYhIKTsxSpFklSbFUTQHzwi8hrHBgZ3x1Pd79GkwufcASVesNSJ2hrQ+3UT9owQ7bdevxuv+r+7CNE4oJWjZcnr99ogcbxhYx1Ltn9I1tw9KOINsYPjvhta+PL+EcZ48ef2myHD+suH9G66QJSeq38B1P5wtuhYMjkxfcy9ChLgmUHpNzTEtqQSYNYDetAVXsgKHaD25c7ff22wGlaRNcLIk+Mw6hioRjQlqvvw2VLelg0ug9YNUGJhZj1UwzrmcUCNQjbBRqSYlflGmMhcAvoTZhHOUKSq3QOTA+Q7ugXkkb8vFtdVw6pPHurdTz4A5duGo7qA84cdLjejxZLBaPNL0b3rwplWr35yHgvjDUxGcn0n9fTuAcC+OkN3a5fjWTPisnwZabb9v/1AiaXrrd+/ySYSqgvECbO/ocMERbyfQL4vc9gfd3w2eKB2uH7e2AxSlayjtuaxTkhazHzquGDyD2fokctFyqW+qwv4orZdp/fPsQT9hDkQjvp7W89Q7m8/KyhCmZYr3/rfcphydnb6F62dtjycYy52fYsv/29Oj43fCYmKnDhFb5vb3eHh0Vxvmc6w1Km9+tHq5h7tZrv/+rb1z1ksrjre8XisuwIgxqvKvXe1ds47PXYPML13XCMuM8gdzdUSa5tGq1ouMfS7S0RLxOWMWtJG7CDrBu3ET7AeuTOtw5r4fEXfjEx7InOW92bpoWbqEksQFjCZvj8sHnudX1KmkWb8RahDgMDeDG20cb3K016MnxBUsYL0lPmwu/eVj41b8Q9if52t4ERgboX1pLPvng7i4uE1erFj5effJFLWADTUq6Xq1W/wFv7HuE",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},f=void 0,j={},b=[];function P(e){const t={p:"p",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Get Formdata"}),"\n",(0,n.jsx)(r(),{method:"get",path:"/formdata/{document_id}",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"The Get Formdata API enables you to retrieve widget data filled by signers who signed the document."}),"\n",(0,n.jsx)(t.p,{children:"Note: This API is only available for Teams and Enterprise plans."}),"\n",(0,n.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,n.jsx)(g.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,n.jsx)(p(),{...a(66993)}),"\n",(0,n.jsx)(m(),{...a(92811)}),"\n",(0,n.jsx)(h(),{...a(73149)})]})}function x(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(P,{...e})}):P(e)}},66993(e){e.exports=JSON.parse('{"parameters":[{"name":"document_id","in":"path","description":"objectId of Document","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"aB2cc2hpbh"}}]}')},92811(e){e.exports={title:"Body"}},73149(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"FGik23bhUJ"},"title":{"type":"string","format":"string","example":"sample doc"},"sent_date":{"type":"string","format":"string","example":"11/11/2025"},"status":{"type":"string","format":"string","example":"completed"},"form_data":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"job bee"},"email":{"type":"string","example":"jobbee@exampl.com"},"widgets":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"job title"},"response":{"type":"string","example":"ceo"}}}}},"xml":{"name":"form_data"},"title":"form_data"}}},"xml":{"name":"formdataResponse"},"title":"formdataResponse"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"Document not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Document not found!"}},"title":"inline_response_404_3"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/d387ddbc.c8ea37d8.js b/assets/js/d387ddbc.c8ea37d8.js deleted file mode 100644 index 92a9049db..000000000 --- a/assets/js/d387ddbc.c8ea37d8.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[206],{4746(e,t,n){n.r(t),n.d(t,{assets:()=>y,contentTitle:()=>f,default:()=>F,frontMatter:()=>h,metadata:()=>o,toc:()=>M});const o=JSON.parse('{"id":"API-docs/v1.2/getformdata","title":"Get Formdata","description":"The Get Formdata API enables you to retrieve widget data filled by signers who signed the document.","source":"@site/docs/API-docs/v1.2/getformdata.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/getformdata","permalink":"/docs/API-docs/v1.2/getformdata","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getformdata","title":"Get Formdata","description":"The Get Formdata API enables you to retrieve widget data filled by signers who signed the document.","sidebar_label":"Get Formdata","hide_title":true,"hide_table_of_contents":true,"api":"eJzVWM1yG7kRfpUODonNGpOS7L3MXtZJtIoSle2y5PJBUqnAQQ8HFgbAAj2kWCxW7SFvkFOu+2h+kq3GzJBDUrZXlWSr4oM8BNDdX/8A/QErQXIWRX4t/uqKpkZLUdxmQmEsgvaknRW5uKoQzpDgRxdqJUnC63fngFZODUZYugbIQUAKGucIC61mSJDWldoYVDBdQtQziyHConLttwKqEFRndHxjb+wbR5jDVaVjMqAjOGuWIOdSG7YFpQtwhbKOIK2CU0sYfNARwRtp4/jGikw4j0Ey7nMlcjFDKjvQIhNeBlkjYWCHV8LKGkUuegx3WolMaHbYS6rEfhTc9BMWdK7AldAHS2Qi4E+NDqhETqHBTERaGlYbde0NikzggzdOochLaSIvKCqspchXgpY+raSg7UxkgqFKGo7gg0xaciH/fFIUJ5WfVmK9vmWz0TsbMbKik6Mj/m8Xb2yKAmMsGwOboIhMFM4SI89XQnpvdJEmJp8iC60O0bVuc/QCqyHdmuyj8VQ/fjzT9ycvp9WHv4t1JkgTjz5NRUwfXDusInLqlKQnqzk+nhwfT06OTr5LakhSE5+qo3D8QahYBS+8S6W21SJDkEsuK8I6fjuqbUkeYtha/OSmMEVke1hLbb65eor4QzswLlzNcu0Ojf9rlG1u19tS/bpIgU6s+V8mHmqzNTMI67ZghoOPS/Dc+97wnuDuXFLw6rEddOlqpErbGSzQEiyCs7MMvEEZESgsQc6ktmAkYfjDf29rYQgufD1YT0O2HvivrdEW7/qc3L06Oro73gTh1WEQ+qMOrCMoXWPV7+vqY/a/7tCru5cbh747dOjczqXRKvWYK3eP9vf1Z2ieWvOHFazbRWle7Dg7HG+djFg0QdMy9bSHF9LrF+18fn3LnYIrxXXNMDVBqkQuJv1GmKwGDXAtWF+Y9y2yCUbkoiLyMZ9MorRq6h7GzqPlJm7kNPKhMpFeT+bH4xOxzvZlpPdPWo/Ni6eKRJIzbWffkrvdhuqS09lmbCdg2wPR638gn4hdPoarOo5QoVQYUu60LV0S7rL01qO91DObcpyM73OJj2gKVyMTJ6ZBo1Ev8vmfv2ykRqMNP0rVmEjS2yaAdwsM3NeZBpUGHzSzo0TK6jS3YWURZW0wRrMEbQlnQRKC0jNN0iQexkdIIb2caqO5iHmZY+kAg30Qx/CxQqow8NSfAoIEhXM0XPsgG3K1JFbV44WFC/elcYuYgYRpE7XFGAFtJW3BC/tMZOACSAu4JXORAqPWLTZnKciCoJZWzpB1ZzAMlkKjuVwhuGkTCaIzTYIMJLVxgYlm55BFVDEF8ZQpWUDgUW7hASsumznCrNEKYwaFUwgt0WAXrIIpRgLPWHSBkZU21rjiPiWwbIwB7/gI0dIwQxxiZHEK0kbecy2WPgebgPngmK1hC3A0+hCRM3yh7X3MR6Mb+wKuN3X1EadRE94+67fAYrE4KP3nuzJnmv7WTOE9ehc1ubDcSs80Vc00bZehks2PVtMZWkz1M9gMWx3KFfFw9/HopELjJ5dIXCFx8vrdeTp1n8Pnn/8FFyiDhcot2motmoBmCbPeFEeuzXwbts2hme4CsqGKI160xcdMHCP1EfxYSfr8878jvMEFaNttKXZlNOLbzBXWnhsk/BF2fl7oSKNRDgFrN0cFjbXIqZFhCdsbRIIWkQcIFfiAfNnprj3B1d2NZyAxZtM3otQG77yMceGCuhHbBSCVQsVIi4AMhDpEGTRe7Q50K7bbTVM1mFZBlrSdbaGaMmGC4BpqC9gHN9cKoUeTguqDIyyST6rsQUtj3OLOlWXqtazmNyFPlvfAD+wnrdBEDie57kbJB4LSsf1sDW5OKsZHFeqw0dYDbKN9F5zBx5HxLu0voW3z5l26G6iDuH4z0AeZYod9MzW62Hd4DK+LAj0Hdi5NgzGH0ahFNBrBM4WlbAw9z2A0mmtc8Ch/S89Z4l9juOzw13zQVXKOIAmY8xG4LkqSmtDfwb+HVtFQwLpuMn4PveoItVx2+uyyn0+uuoZADhR3l93uyi6y/fa52+UClhg4dim9203tdbeJr/vDAPiM+E8OEyZJ3CtkkThcdzXiPv7Dvp7EpzDU8W15iWGuC+y4xBfO0UlaPBGZMLrA7h7T8YLXZ+8uYP5yfCSyASn5DUfq5OL8L6dvLk8ZDKegDdjx+Gh8xEPeRaqlHVgavr/s04nVlr7+X73VdGSL8IEm3kidqG4K46qjqddi8HyTD19qbjNRuUi8ZLWayogfglmvefinBgOT4dtMzGXQjCZx2e5QUZuHmC/G8Nn77k3nOXzh0edR5D13tEwc0x4XuRCZuMfl3jPT+nad9QSSobUr2vNhIHtwE9mh82enVyIT3AN3iet9Iq7dB2t/FNcuo20B8F+m148KrFYtKV6vN+vbqS9KdA72qzlIt+v1+lfSvzP9","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Signer IPs","permalink":"/docs/API-docs/v1.2/getsignerips"},"next":{"title":"Get Signing Links","permalink":"/docs/API-docs/v1.2/getsigninglinks"}}');var i=n(74848),a=n(28453),r=n(57742),s=n.n(r),d=n(78178),l=n.n(d),p=n(19624),m=n.n(p),c=n(96226),g=n.n(c),u=(n(77675),n(19365),n(51107)),b=n(21312);const h={id:"getformdata",title:"Get Formdata",description:"The Get Formdata API enables you to retrieve widget data filled by signers who signed the document.",sidebar_label:"Get Formdata",hide_title:!0,hide_table_of_contents:!0,api:"eJzVWM1yG7kRfpUODonNGpOS7L3MXtZJtIoSle2y5PJBUqnAQQ8HFgbAAj2kWCxW7SFvkFOu+2h+kq3GzJBDUrZXlWSr4oM8BNDdX/8A/QErQXIWRX4t/uqKpkZLUdxmQmEsgvaknRW5uKoQzpDgRxdqJUnC63fngFZODUZYugbIQUAKGucIC61mSJDWldoYVDBdQtQziyHConLttwKqEFRndHxjb+wbR5jDVaVjMqAjOGuWIOdSG7YFpQtwhbKOIK2CU0sYfNARwRtp4/jGikw4j0Ey7nMlcjFDKjvQIhNeBlkjYWCHV8LKGkUuegx3WolMaHbYS6rEfhTc9BMWdK7AldAHS2Qi4E+NDqhETqHBTERaGlYbde0NikzggzdOochLaSIvKCqspchXgpY+raSg7UxkgqFKGo7gg0xaciH/fFIUJ5WfVmK9vmWz0TsbMbKik6Mj/m8Xb2yKAmMsGwOboIhMFM4SI89XQnpvdJEmJp8iC60O0bVuc/QCqyHdmuyj8VQ/fjzT9ycvp9WHv4t1JkgTjz5NRUwfXDusInLqlKQnqzk+nhwfT06OTr5LakhSE5+qo3D8QahYBS+8S6W21SJDkEsuK8I6fjuqbUkeYtha/OSmMEVke1hLbb65eor4QzswLlzNcu0Ojf9rlG1u19tS/bpIgU6s+V8mHmqzNTMI67ZghoOPS/Dc+97wnuDuXFLw6rEddOlqpErbGSzQEiyCs7MMvEEZESgsQc6ktmAkYfjDf29rYQgufD1YT0O2HvivrdEW7/qc3L06Oro73gTh1WEQ+qMOrCMoXWPV7+vqY/a/7tCru5cbh747dOjczqXRKvWYK3eP9vf1Z2ieWvOHFazbRWle7Dg7HG+djFg0QdMy9bSHF9LrF+18fn3LnYIrxXXNMDVBqkQuJv1GmKwGDXAtWF+Y9y2yCUbkoiLyMZ9MorRq6h7GzqPlJm7kNPKhMpFeT+bH4xOxzvZlpPdPWo/Ni6eKRJIzbWffkrvdhuqS09lmbCdg2wPR638gn4hdPoarOo5QoVQYUu60LV0S7rL01qO91DObcpyM73OJj2gKVyMTJ6ZBo1Ev8vmfv2ykRqMNP0rVmEjS2yaAdwsM3NeZBpUGHzSzo0TK6jS3YWURZW0wRrMEbQlnQRKC0jNN0iQexkdIIb2caqO5iHmZY+kAg30Qx/CxQqow8NSfAoIEhXM0XPsgG3K1JFbV44WFC/elcYuYgYRpE7XFGAFtJW3BC/tMZOACSAu4JXORAqPWLTZnKciCoJZWzpB1ZzAMlkKjuVwhuGkTCaIzTYIMJLVxgYlm55BFVDEF8ZQpWUDgUW7hASsumznCrNEKYwaFUwgt0WAXrIIpRgLPWHSBkZU21rjiPiWwbIwB7/gI0dIwQxxiZHEK0kbecy2WPgebgPngmK1hC3A0+hCRM3yh7X3MR6Mb+wKuN3X1EadRE94+67fAYrE4KP3nuzJnmv7WTOE9ehc1ubDcSs80Vc00bZehks2PVtMZWkz1M9gMWx3KFfFw9/HopELjJ5dIXCFx8vrdeTp1n8Pnn/8FFyiDhcot2motmoBmCbPeFEeuzXwbts2hme4CsqGKI160xcdMHCP1EfxYSfr8878jvMEFaNttKXZlNOLbzBXWnhsk/BF2fl7oSKNRDgFrN0cFjbXIqZFhCdsbRIIWkQcIFfiAfNnprj3B1d2NZyAxZtM3otQG77yMceGCuhHbBSCVQsVIi4AMhDpEGTRe7Q50K7bbTVM1mFZBlrSdbaGaMmGC4BpqC9gHN9cKoUeTguqDIyyST6rsQUtj3OLOlWXqtazmNyFPlvfAD+wnrdBEDie57kbJB4LSsf1sDW5OKsZHFeqw0dYDbKN9F5zBx5HxLu0voW3z5l26G6iDuH4z0AeZYod9MzW62Hd4DK+LAj0Hdi5NgzGH0ahFNBrBM4WlbAw9z2A0mmtc8Ch/S89Z4l9juOzw13zQVXKOIAmY8xG4LkqSmtDfwb+HVtFQwLpuMn4PveoItVx2+uyyn0+uuoZADhR3l93uyi6y/fa52+UClhg4dim9203tdbeJr/vDAPiM+E8OEyZJ3CtkkThcdzXiPv7Dvp7EpzDU8W15iWGuC+y4xBfO0UlaPBGZMLrA7h7T8YLXZ+8uYP5yfCSyASn5DUfq5OL8L6dvLk8ZDKegDdjx+Gh8xEPeRaqlHVgavr/s04nVlr7+X73VdGSL8IEm3kidqG4K46qjqddi8HyTD19qbjNRuUi8ZLWayogfglmvefinBgOT4dtMzGXQjCZx2e5QUZuHmC/G8Nn77k3nOXzh0edR5D13tEwc0x4XuRCZuMfl3jPT+nad9QSSobUr2vNhIHtwE9mh82enVyIT3AN3iet9Iq7dB2t/FNcuo20B8F+m148KrFYtKV6vN+vbqS9KdA72qzlIt+v1+lfSvzP9",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},f=void 0,y={},M=[];function I(e){const t={p:"p",...(0,a.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Get Formdata"}),"\n",(0,i.jsx)(s(),{method:"get",path:"/formdata/{document_id}",context:"endpoint"}),"\n",(0,i.jsx)(t.p,{children:"The Get Formdata API enables you to retrieve widget data filled by signers who signed the document."}),"\n",(0,i.jsx)(t.p,{children:"Note: This API is only available for Teams and Enterprise plans."}),"\n",(0,i.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,i.jsx)(b.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,i.jsx)(l(),{...n(66993)}),"\n",(0,i.jsx)(m(),{...n(92811)}),"\n",(0,i.jsx)(g(),{...n(73149)})]})}function F(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(I,{...e})}):I(e)}},66993(e){e.exports=JSON.parse('{"parameters":[{"name":"document_id","in":"path","description":"objectId of Document","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"aB2cc2hpbh"}}]}')},92811(e){e.exports={title:"Body"}},73149(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"FGik23bhUJ"},"title":{"type":"string","format":"string","example":"sample doc"},"sent_date":{"type":"string","format":"string","example":"11/11/2025"},"status":{"type":"string","format":"string","example":"completed"},"form_data":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"job bee"},"email":{"type":"string","example":"jobbee@exampl.com"},"widgets":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"job title"},"response":{"type":"string","example":"ceo"}}}}},"xml":{"name":"form_data"},"title":"form_data"}}},"xml":{"name":"formdataResponse"},"title":"formdataResponse"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"Document not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Document not found!"}},"title":"inline_response_404_3"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/d48fee54.1b74d8ab.js b/assets/js/d48fee54.1b74d8ab.js new file mode 100644 index 000000000..6396acca6 --- /dev/null +++ b/assets/js/d48fee54.1b74d8ab.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[1332],{96455(e,n,i){i.r(n),i.d(n,{assets:()=>x,contentTitle:()=>f,default:()=>w,frontMatter:()=>g,metadata:()=>t,toc:()=>j});const t=JSON.parse('{"id":"API-docs/v1.2/selfsign","title":"Self Sign","description":"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.","source":"@site/docs/API-docs/v1.2/selfsign.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/selfsign","permalink":"/docs/API-docs/v1.2/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":"eJztPO1yG0dyr9JZpyIRtwAIiJIVnk45WdLZSmxJJVJROaSOHOwOgBF3Z9YzswBxFKr84yoPkMqfVCV/7iXyP4+iJ0l1z8x+ACApyj6fLoGrbBM7Xz09Pf09fRFZNjHR/lH0RCVlzqU10ds4SrlJtCisUDLajw6nHAzPxkZMJDx6+QwmXHLNLDfA4PWrb8FOmQUu2SjjBsaac2MXGQfsL+QE1BgYpH7+HnyvSkiYBJYZBUImWZlyULQYy6DQvJvysZA8hblIJ9yaGOZTkUzBTt2cXNN4ngoLSgM/L5hMoSyUBGZAcp7ytAeHU2Gg0GomUgI0QMPPC64FlwlOlouMabCK5v7w438e4Ba/V6XG/X748b9gnKk5CEntLwouqQMrit6xPJaHotiH10WmWAoLVWp4+eR31UZxVvx21Ok84aNyAq+fdTpvb0+tLcx+v49zqIJLBCtjI9NLVN5PsWORjndwy1xznNXtlRmRLYClDaTYKZeQqGIBiVI6FRJPJIaCTTjIMh9xbWJAzORKc9wDA81Zuuha1S0Nh388ePEcxkrnzPbgZVaauFouFZonNlu46XHvYVe3DIyY4ff2wFgt5CSGnJ0hWoWFH0qRnOG2DZdpQOqjl88IV53OQVkUSluewhu3hf1OB1u+4ohjpjn1T1SeKwkF0yznlmvjqAubNf+hFJrowk6BZVnAxf6x7EKnI1nO9zsdeC3FDyUHkXJpxVhwjbsEi/TgBvRcf7soqP8zmYqEyBkBwK9Isq2uiFTselDwBKd0XRuoBiU9lSIO58ydf5GxxG1Lc1PwxIoZb098HsMCJ37CpQoQTJUWf1DSsoyOb8a1FQnLmseMANJ1sExbRH+hhLThq1+huml42nSIng4RtBSRmwtJLYbDjGUlNx6qeQxThOoVLzQ3yBXCvIh4mcKUi8n00vVY+q40tjUxlAbBbELh1wqnSujlhLYxywwHMW7hMmdnvLFaxTF68NUCUj5mZWZjEEihVpe8B8+VxZuaiQQZE9EAXjZmS827dMqefHpt8nlZ84xUjMdc42XGRprCjwnQIV06JoPbo5tmp0yCkisHnahM6XUSos9tPEKipCVO+WjGREbAu82ail2OMpacxTDKSh6D5qm76AueZWoeu/tBXZAhOpwTfpCNIxUqifBL5ZcXBoyHqmKc4f5hY8WccRFhmlj1t3yscGVEQbiSwHMmspgQF8M7NQIrbMZjvOAFk4sYUmZ5DJaf25E6jyGZ8uRspM49vsZKWiP+sOHWhZabY20Yw14M92K4H8NgN4bBMIbBXgyDezEM7scw3I1hOIxhuBfD8J7D6fC+xyerkNgEYDB0mLSfHwanIuUn2HiC8J8wY7kW5gzZLrxB2eEkdho7tsfPLTKxSsimtSQTBqYiTbmEsVY5aJ6IQhBXcLe6mjqGUWlBI+DSwLjMsgXMhBGNfVaTqjkKcidahW4I1yRRJZ4jYdEhjlBWH6vMFgjqIWe5IYw+lZbrQgvDkeVKU2FA2pp+nCDDb82L/DGnJduc5PITCycQg2apUIgNq2QMqVZFqubSS8JvhSHeiSLMVFJx3pKKgx50OhW/wm+np6fH8uJYAhxHyL6Oo304jqoux1Hs2lAqYdvA/z7HH3eGX/qfC/x5b3jf/5xT18Ge/znFn8Mw1F+g42if1qUOQlq3sueT0IAAOy2P5dIDeyyHtAvL8uKKHWDznxd6qMAP0gY/opiIQwPesnV4Ltmx67G22zu4WyGFFSwzl2849PiM9rwC0uZt153Wdr6HOyd+dfm2qfkz2nMTHmwhWeiaSHY2mgLHJyiGV6Bodc7LeDCOIi1nDZN3e14VuRyRbgufDR4b4PxcaFyZ8uZYvIdYRJF5iCLzclRWUvUzwucqTD8XUjfNe3PMftkjZZY0kMvx6jt8RlhtQ/Rz4XR91ptj9D5iFFW5y9GJrZ8RLhvgYIPXi13b7l53cLc73B3utfCJXgbXIc+7adpdLBY/7SxyIU8cHDio0T9n55sbvAOoaqTTuOJsXb+V40K10u8XNctgLDrVllnuNOR1TwAZ6nUvb7rQ38F6/g5t5lEwJ3ka3E6VYVE5a5oGr1UpW9wybqowtLKhsP+qBuzApCaEgxxXyVSJxAOPfYLlNELfTA9x0KWj66dpv3F0+DFNu3neXfmIP7t00o2Ped5L095KzzVycB9zSNMY1j9v/J6mkOf5JZ/d99bnfp6v76KX5x42j71AYWvnnAsp8hLtIPSBOXMaO6Ip4dGb+7MUEjqd77///vvud991nzzpdMIZ+iU8rTbcDm4Fdv4zrdAk+k5nH56NofmJTH/ndKG7Xpl/aNZUHaZqLoPV4x2waYnev9DVuX5ytqDJuLBTrtvrKF2TLNqIaFKNlJ324DWZkPh3MLUqk4jMpb9H9uht3Ms5pO/wSzHJmhe2F76SgaL3FW3XdebT4qBryk9gTMVm7UjzSZkxzc/RV2eEkmuc71Mk3c2k2ApbDLRc+0zIC+j9sDy4LOD2C29p71TOwJW94GyPICmNJcfDhJ9DwazlWtJkM5aJlNH96NIHfs7yAp0k/d8fH6e/+ts+uWHR02md3yAVE4He8/7vjx51/+Xthh5lUXCdMMMh47iSiYHbpAdHU54VtQN/Pp/35ndMMlUqc977d0bzsfvviRq9OyFwix4zxc6mnTpiaLg9kVhWvZ50ORsYYwbCyA2OTzoaujWDXdLTvD/iCkXN9/iMtIsVkLDR+ZCx+QgFPKmwSLy8/lshzzmO3tbinlydPL1m7NuPuJ54GzI24tl6082vVsYWqvQ3Orj221v1FN3Am1d4Ku8tbWc3bjSy85VG17bccE8dQprXNEj7cD3DCUAmTCVIWuhsjvYOfgrTYPANyXbEIQyAUUWlP/kWVIB93DUIXlA6u2uWwH5AHavgSuVPvXqF1sGsSXKvK4Qo0biaNaAsCPImvnBkabiu1YQrVvC6wuUrYEjm8gWO5YB8jSJnkytMEGr+jLhEE55L3FWux5q9NSCnpEPXFU4War96w4Pd1obvtjd8b/cT1InWsleioqEz7DZ4js7LjK1pAClPRM4yikfS0sOfwME2+GtWof4U/cHDjvT9WOVFaR19e80BLRPi8YHQQyDOhSB+FUM3hk4M/Rhux7DTg1ecQndJFebzdC+0C+YJCakq0Z+flDpbwEgjbmLgvUkPLi5+KJm0wi6WS+jAxQWmOyyXPeQUZ1LNXaTvCGMbFjBSX+sFqUrMhsi+SkwfFYj+cz7vhmSLvgdtB26rFc54pTblUbDGTlvHjEOfV0zB6T0U+RWmyNgC2BjDHS46SMNcELmHGNiHIfzmIQyGvd3dGHbd33A7rD/coYtE/u6EZ1c5u6n5umu027xG9c9NfOPu7kfdo+ayn6iU4xQnFIuidTcr6xs50GeonNebWXUHNOQG4syJDDNVZZai1NDcllryKp/DS40ojlSBSUBCyWdptB+FBKEoJlxzY79S6SLav4h8YBb/9EE0HNR/ZzC56CIyyZTnDP8KZ4TpSGOR8SiOnLVpojgizyXmJiFpRfuRGr3jiY1itIoKVKO4wTlo3P5F6OWSVKLYe6Ci/chlr0Rx5C2F6hNwmSh0uxTpOFrGNNNJwYyZK51eOWX1pZ4SJ3AQ33CgoT+qKCnOg4khnzjNcxy6XMnn+qSZnjRmoL3l/FAhm8645U/YwjTmdRQVraaR4RikosSPgpQtDNr8pXHklbAsKTP0FvDzQuhF5SojF1WFkga81UoVvIO7y0A1DYguIRatbn5ACVeIAAr03HTsO8VHnP/Wf0C5QOfL8htD8U5xGHE622Kq5I3HD4Z3BsPBncEQZ/BO7JvOEWQcTvFOjU4+id5TPsPxXg42RjOt2SKKI2F5bq4/Ste6vnabBB9hxJ6nwWTp1rHr2AV1e9fdhtCfMM8m/HqyP7wsUayRu+LZLSsKznSP8rU+OXWwfZMqDap3zb1ZxtH59Zs5h0R1QxYa3M742Dp/CSRKS653mv7vz2Zzw729ZRwtrt/e4q9ye1/i4c2v390bSt+rUxv/ErDeub+Mo+n1sH5TJRj+BYHdu7es5XiUaM4stzwvcJKTkUoXJ4FvLZsdgyoUJJbr6oUSahYqS7l+tlGpaKsQmEh7sipqRkplnMkNjKaVx8SQ1xnycaAHxWt88yknI6pyfdDspvLZeH+LU7t8uKHlwhUG1Xtd8uOoh9GE2kQjr8lqKlXoS6lUUsEtWu/ElMTGb/X9b8TQrWbSL+ZV1oGvAAJ1hnAEmM6bZQg3ahA9qP4h9bTCJAIQJHZY+HpR8di5nGlBP6idQgpeze3BYyarFMN2YhhcXFREQNSxXMLFBZ4q1yco95fLuP6Aa7U+kGh3XzRPuJi1RlWfeD2w+tYY6pQpCsO4D17eNwHwoZpS+3lQ51wuey2CXAEcpuSEIxzwtKIzTOFb33WlMtFJfzT215DtKQAn+X+D9wfFw2/EBlAe9IuHD4qHbzBhvODu7jn0jIVM3c2f8yzrwQNjtZKThysoeND33zcfpeYzwed0celU61lWcVtN1PMw4QuKxuEJA4kuE8EyirVolfCQxU8WKKaeGssLg35dYV3kkPJ9SfNnE8055YwiLKy0lCBPVmRY8AGDqebj39xawemth5RTih6aB3320Pd+5ly/UzbjwOQCaOPkAVfaubDHpSY2mWRMi7E3WWMoMo5xIbRoWeJc0g6jAY7DKZNnJn4w0g8xO7XKav3wxz9hD7oGlHV7qEr9ETydPNVdd7Y+FZZ4npsEGExKShWwiKfAnihkVSelC2msLp3zOMRtm2FeOg9jej7tvosOIpfnOuXN+WPg0rjhDMbkdYihlAJzb3VZIOWsv7FpkTItsEQHgXtggmd0PS9oZ3/jeyP3NqYRjQ5yIEzM/XMgb2pWLw9C7vHq1jcKXn9PrgcQhSS5FH3coODaKIm0pPSESU+qTvFXBg23KctcV3dfBSZaUDgdE9g3Glkf/vinBlyXWp/rgLkVWJqi/+kaCMn1gw4eQzEDzYtsAVa1IcL5uP7tqq6F0OVcT/hJglYZ3Rn+ERTe6SCNdzrQdYnYnrxN6V5S2PAoiM4Rj7SeHfHm+X+VLBOcC2nrLVYPvlFzPkOC9VcYGa2bX6GLmCD3mfDNFRImKVMB7zlqJzhxlSSDWe71Ei61m0icduOZDMaH3Xr0iAXXia/aUyDlKguI0eM1v3pIzcfNoYMKWKYoAd02nselbaCe0fuEKbECyvbAGJZbJzwMolz8Dz/+Bz6YC25zU6l3G1tJQ6MnfJSy0Zw1aGvhJU+vrY8FLiCVFePFiZInlaQwGwmmPfJKAmrccVLXlecNXnYCPqWjC0GLe76O/EQidfhXgj53xbR4xtr5Xr4YIuRnWhAdePvwik+YTrPqArtjtPT8jjUJyS11GTWQ+LyE7Ji1LJlyeu6Q8gIf8CkJt2oDpKGd43mi+4PLE3Jef4zbxnOoZeM0jyJ8vkT+4jSKnfM7eruMo1GSfOqMyLxa/rWYPg1b39YeuI6SBG6PMoHoYXqk3LPKnX14TbyQpXgPSea0ial9qA75xE5awga1n8CVPOp+6Q3i/n6JnV1nBDs7ufbze9MMH0cqadz1H+7u4v/aG3jSumioaZQJSm56YvQ3UfzxQYar3Yju82bT/Cq/4PSdGP7hPJkNX+J5XaLWXDmBd2OUOsP3uYi5bsUJSLw2cCtkJiQ/CWg7Ge7ungwQt8s42tuEvgOVcycB5ojEOSrrlSi0egFsgrIMjWr9M2KTa6301V6Om0F2FRL2Wki4u46EZ5Jya+gF+6E64/KX3WlzeeuWR1DPc6IVp2lGwnWi9qi12eZ3t0nDk1ILu4j2jy6i8y4rRNe17x+9Xb5FbcxOFYbmCmUIYman0X7Ub0TqDNczDK/hDES0FR0aJlNMfVlzqbFC9GeDHgYOVsdsdMFd0Z+X3ZsOMZZNhJxcN+5tjZ0DPEF3SC0c1ey3EP/Ekf/6I2j2iiOBlDPlLEXXHQY6jJKv6vjm03C8IfK4KZi4FkuMogafXAn4hXhfK4S3ys83BOU2x+QGd5vRMBfvohBWFcHaFJSqcBHCTFWUqRE4asSN6lBQKxJEwZ1GbOeovh5VGCVEUQYUfhju7ZGf/ssBObTv3Cdf8d695duW2zSK2q5RCuivOvh+mr+q7a7a+mD+D/lg2i4Yb1O0XRKBwCoXQMsOXzXDLzWJN1rEfsHN1o9vbKrWm9VkryV/vEJ4k95L5HtjRUzSX+XqeTaKL2Kyqzzpiyaiq25oxDyETueQHpVw2TWq1AkHVOjcc+8Mk7kZVcb48OO/w6gUmfO0p3zGMxSyWOtEl8anLvLqrbfpuafSzXUnYuZItjaMODnDUucB61IJFODd+mZgLAFVM7BTrcrJlIwyOcEk8ldPDw7HZUZFTOAAjaJw7Uw7GIBlUCQGeavYBMKMBRiCq8lYZkv0V2DiagbIrONwl1SOJhjdMyxZohsqdibGPFkkmUOOq3lip6q0MOMyVRoylZx1hXtZ3u128X9ffAFfO/MQDvDZEU/x69MZ14vKj05ZpwnTeuHWrbSS4Eg5bcjBU3ASkBahlKJG4z48wBnqDw+rTMtO58O//hscfaPmyHNC1aCVBT8+c+7Abcr0H718Rgrcjjv/5/RmBG0Y5xfEUNZEyH9AI4f20ul4dQa4nAmtJKK204Hbpx+t7pzueLZplS8d4k6BjceYlysnkCEFp8yylaN4jJmCj1nBRiITqC/i9/fwmFk+UXoB7+ENuqGq0jsK3h/L991ul/7Frp1OVZyp04H38JhsoJjYXgxl4cpAaD5TZ56mUk4JNnW5k3DsNfn6mQ8DvdLMX5UiS0Hz0juAG4E2O6XSTJRaWNUq+HVV6gfrnSiNt2ARfNBhiQOejbt4P2mJrwMVoBraXfFQmBqvwTEi5ExYZ4ZSLSY/6ctylIkE2uAfTMkpBYVrDFcvE/KMro8MkU1KbK/rCQUsaza28EbpM1zJzYjiqYYO8+MrnDADKY5wJSjGQrJMOILLnb0S5n3sRJWD8TvHJxZBOlNugRNlI6XOkMQmmuU5o4cB2SJM8jvSftwcL8hpa5qQCWkwRbRi0080kqNTmaqTeMNHU6XO3CSvvK2P7KhLuVl8RpVuGpa/AUeZGn2AwGXqygz56ciH4OeyWnCU5K54h/M0aarQhZIE7V48wfftq4GET37F55yKbAWB8QVeG3T+cV2dcFiDZcfy9Ounh9APJ9HfF+kprdj+jmd86hSMEecSC1ZxlmdUWQypQfO0lCnGwFfizprnaoaeV5li6SfNx+TVZJa5F2rzOiky+GWzhXML+xOtJ+x0qgpZlZeDqnlx7XLhpClz92QHd/3S2wjdl1pZF8hAV68vnXUssR1Oj9sGxXF0Grh2uOeotpKXEeZKn4ngIuYy0YvCz2p6UJfkUnL/WJ6+fHFwCP12osMp/M9/w+nL12sYp8+NAYEY+/tVjkS7G92W0GutYWU9agim6mnAz4vxGA8QDvzVxqulVXYs8WXH6XFESQ8nyvUizSok/MJ754w+Rb/mJRslGtqwU6swopWJRGBNNB97Qw3FB8r8ehXDoYdoDFO8/DTV+R44+nilMpQDqBSdem55Cs61QPTFkoQXyFhwT67DCRpveNJjwTHdKNHKGFIIaBd4u7QqLaekDc05YH+fRxFOed+JHlwdmT2fspnAy70qcDxMp9AJGd87xLpIZwjZm8wCauKWWH+tTfmsKDcPGi84T8Vt2i5uQpQ3cejpnWfSIWGf+XQ9NxkrMCbipsPQf2U6hO78HLHmRUedNiC0M1zeV6zFeUIfY227248f7yBwvqDRsXwEks8R7UlSY9tf+7pWD4VdTHiCw8+FIR3g9BjV8nqcquNDcUUMsRMbzqgLQrA6xb6T59VhPm3G77ghyeXCXRWMtdfW+Xi7VLXv5h5c+Fac8XoPMYLfggZumzKZouBzt6S+8SI93WmEnCvQ8Lw0FVNzjxg9L6eEoZgEjuNSiNlM+GgXglvYBZBjHG6fHr093fk1KHygSWkehFqLtSOnXAu7YeoVFayuCPa01v+8Htb4gncCTUsMMa/rYAdORSR5dwO9sVJYKhOkPcOVnqxq9NPXGARaG3ydB+10VeL+M9f4CAHP6O/gK5aczZlODb23YVaQhrrArjgYicOV8BqFjt3Ed8ycBgyzgStROOgNKgMlqAkmREox/jlzC/uwYaOUl/OZjALeaVapYKS5k5rJlMkJXgTUERqCWiDjT8vE3QWCF6euSneV0sXL0IUwFz7im64QxmvD0bz7VsgzIocuHFUa1Bs+MsLy9oPfVUzv0JjflVkGQUenC3eNUeOGfS3sN+UIiywqI6zSi3rURNhpOaKzbI6tfvgJgi5dubR/ijFFUx5ynVOU8YDrmUiu2X4fa0ia/g4FeFfcq23vAAWOke+YlinICuHNzqMAB7SfWd98Hy6lnVRqcs17Jw0rxMakBdrCi7Hfr/c1X73fKI4ykXBpeMN1/+jrl9/C7E5vN4obTuuPOMv+t88eP31+8BSB8dcEHa293d4uhVmVsTmTjZXQoCJNYtUH03hrsy3auy3auy3auy3auy3auy3auy3auy3auy3auy3auy3auy3auy3auy3auy3auy3auy3auy3auy3auy3auy3auy3auy3auy3auy3auy3auy3auy3auy3auy3a++fjEtuivduivduivduivZfco23R3j970V7/ABMB6RcZE7LxXt09ED6qS/m+jaMpvh3eP4ouLjCD5DW+58PPP5Rc48Pjt3E0Y1pghI2eHcfhrSw+9jzj+HTysQvxdg9x5dhphZSOtfLaGh/7uhGPKPv5yr7N582Yy40P43xhsVylOEazOb6ZY3P3ms8THr2CZVQrMWNyUtLb08jNic978WFj+23wGb0N9n80nrDiw9cawvajYbcN/C9uauOAiwv37piemrr+runSER6xoTee3Nvlcvm/mR19sg==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Contact list","permalink":"/docs/API-docs/v1.2/contactlist"},"next":{"title":"Draft Document","permalink":"/docs/API-docs/v1.2/draftdocument"}}');var s=i(74848),a=i(28453),r=i(57742),l=i.n(r),o=i(78178),d=i.n(o),c=i(19624),p=i.n(c),h=i(96226),u=i.n(h),m=(i(77675),i(19365),i(51107)),y=i(21312);const g={id:"selfsign",title:"Self Sign",description:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.",sidebar_label:"Self Sign",hide_title:!0,hide_table_of_contents:!0,api:"eJztPO1yG0dyr9JZpyIRtwAIiJIVnk45WdLZSmxJJVJROaSOHOwOgBF3Z9YzswBxFKr84yoPkMqfVCV/7iXyP4+iJ0l1z8x+ACApyj6fLoGrbBM7Xz09Pf09fRFZNjHR/lH0RCVlzqU10ds4SrlJtCisUDLajw6nHAzPxkZMJDx6+QwmXHLNLDfA4PWrb8FOmQUu2SjjBsaac2MXGQfsL+QE1BgYpH7+HnyvSkiYBJYZBUImWZlyULQYy6DQvJvysZA8hblIJ9yaGOZTkUzBTt2cXNN4ngoLSgM/L5hMoSyUBGZAcp7ytAeHU2Gg0GomUgI0QMPPC64FlwlOlouMabCK5v7w438e4Ba/V6XG/X748b9gnKk5CEntLwouqQMrit6xPJaHotiH10WmWAoLVWp4+eR31UZxVvx21Ok84aNyAq+fdTpvb0+tLcx+v49zqIJLBCtjI9NLVN5PsWORjndwy1xznNXtlRmRLYClDaTYKZeQqGIBiVI6FRJPJIaCTTjIMh9xbWJAzORKc9wDA81Zuuha1S0Nh388ePEcxkrnzPbgZVaauFouFZonNlu46XHvYVe3DIyY4ff2wFgt5CSGnJ0hWoWFH0qRnOG2DZdpQOqjl88IV53OQVkUSluewhu3hf1OB1u+4ohjpjn1T1SeKwkF0yznlmvjqAubNf+hFJrowk6BZVnAxf6x7EKnI1nO9zsdeC3FDyUHkXJpxVhwjbsEi/TgBvRcf7soqP8zmYqEyBkBwK9Isq2uiFTselDwBKd0XRuoBiU9lSIO58ydf5GxxG1Lc1PwxIoZb098HsMCJ37CpQoQTJUWf1DSsoyOb8a1FQnLmseMANJ1sExbRH+hhLThq1+huml42nSIng4RtBSRmwtJLYbDjGUlNx6qeQxThOoVLzQ3yBXCvIh4mcKUi8n00vVY+q40tjUxlAbBbELh1wqnSujlhLYxywwHMW7hMmdnvLFaxTF68NUCUj5mZWZjEEihVpe8B8+VxZuaiQQZE9EAXjZmS827dMqefHpt8nlZ84xUjMdc42XGRprCjwnQIV06JoPbo5tmp0yCkisHnahM6XUSos9tPEKipCVO+WjGREbAu82ail2OMpacxTDKSh6D5qm76AueZWoeu/tBXZAhOpwTfpCNIxUqifBL5ZcXBoyHqmKc4f5hY8WccRFhmlj1t3yscGVEQbiSwHMmspgQF8M7NQIrbMZjvOAFk4sYUmZ5DJaf25E6jyGZ8uRspM49vsZKWiP+sOHWhZabY20Yw14M92K4H8NgN4bBMIbBXgyDezEM7scw3I1hOIxhuBfD8J7D6fC+xyerkNgEYDB0mLSfHwanIuUn2HiC8J8wY7kW5gzZLrxB2eEkdho7tsfPLTKxSsimtSQTBqYiTbmEsVY5aJ6IQhBXcLe6mjqGUWlBI+DSwLjMsgXMhBGNfVaTqjkKcidahW4I1yRRJZ4jYdEhjlBWH6vMFgjqIWe5IYw+lZbrQgvDkeVKU2FA2pp+nCDDb82L/DGnJduc5PITCycQg2apUIgNq2QMqVZFqubSS8JvhSHeiSLMVFJx3pKKgx50OhW/wm+np6fH8uJYAhxHyL6Oo304jqoux1Hs2lAqYdvA/z7HH3eGX/qfC/x5b3jf/5xT18Ge/znFn8Mw1F+g42if1qUOQlq3sueT0IAAOy2P5dIDeyyHtAvL8uKKHWDznxd6qMAP0gY/opiIQwPesnV4Ltmx67G22zu4WyGFFSwzl2849PiM9rwC0uZt153Wdr6HOyd+dfm2qfkz2nMTHmwhWeiaSHY2mgLHJyiGV6Bodc7LeDCOIi1nDZN3e14VuRyRbgufDR4b4PxcaFyZ8uZYvIdYRJF5iCLzclRWUvUzwucqTD8XUjfNe3PMftkjZZY0kMvx6jt8RlhtQ/Rz4XR91ptj9D5iFFW5y9GJrZ8RLhvgYIPXi13b7l53cLc73B3utfCJXgbXIc+7adpdLBY/7SxyIU8cHDio0T9n55sbvAOoaqTTuOJsXb+V40K10u8XNctgLDrVllnuNOR1TwAZ6nUvb7rQ38F6/g5t5lEwJ3ka3E6VYVE5a5oGr1UpW9wybqowtLKhsP+qBuzApCaEgxxXyVSJxAOPfYLlNELfTA9x0KWj66dpv3F0+DFNu3neXfmIP7t00o2Ped5L095KzzVycB9zSNMY1j9v/J6mkOf5JZ/d99bnfp6v76KX5x42j71AYWvnnAsp8hLtIPSBOXMaO6Ip4dGb+7MUEjqd77///vvud991nzzpdMIZ+iU8rTbcDm4Fdv4zrdAk+k5nH56NofmJTH/ndKG7Xpl/aNZUHaZqLoPV4x2waYnev9DVuX5ytqDJuLBTrtvrKF2TLNqIaFKNlJ324DWZkPh3MLUqk4jMpb9H9uht3Ms5pO/wSzHJmhe2F76SgaL3FW3XdebT4qBryk9gTMVm7UjzSZkxzc/RV2eEkmuc71Mk3c2k2ApbDLRc+0zIC+j9sDy4LOD2C29p71TOwJW94GyPICmNJcfDhJ9DwazlWtJkM5aJlNH96NIHfs7yAp0k/d8fH6e/+ts+uWHR02md3yAVE4He8/7vjx51/+Xthh5lUXCdMMMh47iSiYHbpAdHU54VtQN/Pp/35ndMMlUqc977d0bzsfvviRq9OyFwix4zxc6mnTpiaLg9kVhWvZ50ORsYYwbCyA2OTzoaujWDXdLTvD/iCkXN9/iMtIsVkLDR+ZCx+QgFPKmwSLy8/lshzzmO3tbinlydPL1m7NuPuJ54GzI24tl6082vVsYWqvQ3Orj221v1FN3Am1d4Ku8tbWc3bjSy85VG17bccE8dQprXNEj7cD3DCUAmTCVIWuhsjvYOfgrTYPANyXbEIQyAUUWlP/kWVIB93DUIXlA6u2uWwH5AHavgSuVPvXqF1sGsSXKvK4Qo0biaNaAsCPImvnBkabiu1YQrVvC6wuUrYEjm8gWO5YB8jSJnkytMEGr+jLhEE55L3FWux5q9NSCnpEPXFU4War96w4Pd1obvtjd8b/cT1InWsleioqEz7DZ4js7LjK1pAClPRM4yikfS0sOfwME2+GtWof4U/cHDjvT9WOVFaR19e80BLRPi8YHQQyDOhSB+FUM3hk4M/Rhux7DTg1ecQndJFebzdC+0C+YJCakq0Z+flDpbwEgjbmLgvUkPLi5+KJm0wi6WS+jAxQWmOyyXPeQUZ1LNXaTvCGMbFjBSX+sFqUrMhsi+SkwfFYj+cz7vhmSLvgdtB26rFc54pTblUbDGTlvHjEOfV0zB6T0U+RWmyNgC2BjDHS46SMNcELmHGNiHIfzmIQyGvd3dGHbd33A7rD/coYtE/u6EZ1c5u6n5umu027xG9c9NfOPu7kfdo+ayn6iU4xQnFIuidTcr6xs50GeonNebWXUHNOQG4syJDDNVZZai1NDcllryKp/DS40ojlSBSUBCyWdptB+FBKEoJlxzY79S6SLav4h8YBb/9EE0HNR/ZzC56CIyyZTnDP8KZ4TpSGOR8SiOnLVpojgizyXmJiFpRfuRGr3jiY1itIoKVKO4wTlo3P5F6OWSVKLYe6Ci/chlr0Rx5C2F6hNwmSh0uxTpOFrGNNNJwYyZK51eOWX1pZ4SJ3AQ33CgoT+qKCnOg4khnzjNcxy6XMnn+qSZnjRmoL3l/FAhm8645U/YwjTmdRQVraaR4RikosSPgpQtDNr8pXHklbAsKTP0FvDzQuhF5SojF1WFkga81UoVvIO7y0A1DYguIRatbn5ACVeIAAr03HTsO8VHnP/Wf0C5QOfL8htD8U5xGHE622Kq5I3HD4Z3BsPBncEQZ/BO7JvOEWQcTvFOjU4+id5TPsPxXg42RjOt2SKKI2F5bq4/Ste6vnabBB9hxJ6nwWTp1rHr2AV1e9fdhtCfMM8m/HqyP7wsUayRu+LZLSsKznSP8rU+OXWwfZMqDap3zb1ZxtH59Zs5h0R1QxYa3M742Dp/CSRKS653mv7vz2Zzw729ZRwtrt/e4q9ye1/i4c2v390bSt+rUxv/ErDeub+Mo+n1sH5TJRj+BYHdu7es5XiUaM4stzwvcJKTkUoXJ4FvLZsdgyoUJJbr6oUSahYqS7l+tlGpaKsQmEh7sipqRkplnMkNjKaVx8SQ1xnycaAHxWt88yknI6pyfdDspvLZeH+LU7t8uKHlwhUG1Xtd8uOoh9GE2kQjr8lqKlXoS6lUUsEtWu/ElMTGb/X9b8TQrWbSL+ZV1oGvAAJ1hnAEmM6bZQg3ahA9qP4h9bTCJAIQJHZY+HpR8di5nGlBP6idQgpeze3BYyarFMN2YhhcXFREQNSxXMLFBZ4q1yco95fLuP6Aa7U+kGh3XzRPuJi1RlWfeD2w+tYY6pQpCsO4D17eNwHwoZpS+3lQ51wuey2CXAEcpuSEIxzwtKIzTOFb33WlMtFJfzT215DtKQAn+X+D9wfFw2/EBlAe9IuHD4qHbzBhvODu7jn0jIVM3c2f8yzrwQNjtZKThysoeND33zcfpeYzwed0celU61lWcVtN1PMw4QuKxuEJA4kuE8EyirVolfCQxU8WKKaeGssLg35dYV3kkPJ9SfNnE8055YwiLKy0lCBPVmRY8AGDqebj39xawemth5RTih6aB3320Pd+5ly/UzbjwOQCaOPkAVfaubDHpSY2mWRMi7E3WWMoMo5xIbRoWeJc0g6jAY7DKZNnJn4w0g8xO7XKav3wxz9hD7oGlHV7qEr9ETydPNVdd7Y+FZZ4npsEGExKShWwiKfAnihkVSelC2msLp3zOMRtm2FeOg9jej7tvosOIpfnOuXN+WPg0rjhDMbkdYihlAJzb3VZIOWsv7FpkTItsEQHgXtggmd0PS9oZ3/jeyP3NqYRjQ5yIEzM/XMgb2pWLw9C7vHq1jcKXn9PrgcQhSS5FH3coODaKIm0pPSESU+qTvFXBg23KctcV3dfBSZaUDgdE9g3Glkf/vinBlyXWp/rgLkVWJqi/+kaCMn1gw4eQzEDzYtsAVa1IcL5uP7tqq6F0OVcT/hJglYZ3Rn+ERTe6SCNdzrQdYnYnrxN6V5S2PAoiM4Rj7SeHfHm+X+VLBOcC2nrLVYPvlFzPkOC9VcYGa2bX6GLmCD3mfDNFRImKVMB7zlqJzhxlSSDWe71Ei61m0icduOZDMaH3Xr0iAXXia/aUyDlKguI0eM1v3pIzcfNoYMKWKYoAd02nselbaCe0fuEKbECyvbAGJZbJzwMolz8Dz/+Bz6YC25zU6l3G1tJQ6MnfJSy0Zw1aGvhJU+vrY8FLiCVFePFiZInlaQwGwmmPfJKAmrccVLXlecNXnYCPqWjC0GLe76O/EQidfhXgj53xbR4xtr5Xr4YIuRnWhAdePvwik+YTrPqArtjtPT8jjUJyS11GTWQ+LyE7Ji1LJlyeu6Q8gIf8CkJt2oDpKGd43mi+4PLE3Jef4zbxnOoZeM0jyJ8vkT+4jSKnfM7eruMo1GSfOqMyLxa/rWYPg1b39YeuI6SBG6PMoHoYXqk3LPKnX14TbyQpXgPSea0ial9qA75xE5awga1n8CVPOp+6Q3i/n6JnV1nBDs7ufbze9MMH0cqadz1H+7u4v/aG3jSumioaZQJSm56YvQ3UfzxQYar3Yju82bT/Cq/4PSdGP7hPJkNX+J5XaLWXDmBd2OUOsP3uYi5bsUJSLw2cCtkJiQ/CWg7Ge7ungwQt8s42tuEvgOVcycB5ojEOSrrlSi0egFsgrIMjWr9M2KTa6301V6Om0F2FRL2Wki4u46EZ5Jya+gF+6E64/KX3WlzeeuWR1DPc6IVp2lGwnWi9qi12eZ3t0nDk1ILu4j2jy6i8y4rRNe17x+9Xb5FbcxOFYbmCmUIYman0X7Ub0TqDNczDK/hDES0FR0aJlNMfVlzqbFC9GeDHgYOVsdsdMFd0Z+X3ZsOMZZNhJxcN+5tjZ0DPEF3SC0c1ey3EP/Ekf/6I2j2iiOBlDPlLEXXHQY6jJKv6vjm03C8IfK4KZi4FkuMogafXAn4hXhfK4S3ys83BOU2x+QGd5vRMBfvohBWFcHaFJSqcBHCTFWUqRE4asSN6lBQKxJEwZ1GbOeovh5VGCVEUQYUfhju7ZGf/ssBObTv3Cdf8d695duW2zSK2q5RCuivOvh+mr+q7a7a+mD+D/lg2i4Yb1O0XRKBwCoXQMsOXzXDLzWJN1rEfsHN1o9vbKrWm9VkryV/vEJ4k95L5HtjRUzSX+XqeTaKL2Kyqzzpiyaiq25oxDyETueQHpVw2TWq1AkHVOjcc+8Mk7kZVcb48OO/w6gUmfO0p3zGMxSyWOtEl8anLvLqrbfpuafSzXUnYuZItjaMODnDUucB61IJFODd+mZgLAFVM7BTrcrJlIwyOcEk8ldPDw7HZUZFTOAAjaJw7Uw7GIBlUCQGeavYBMKMBRiCq8lYZkv0V2DiagbIrONwl1SOJhjdMyxZohsqdibGPFkkmUOOq3lip6q0MOMyVRoylZx1hXtZ3u128X9ffAFfO/MQDvDZEU/x69MZ14vKj05ZpwnTeuHWrbSS4Eg5bcjBU3ASkBahlKJG4z48wBnqDw+rTMtO58O//hscfaPmyHNC1aCVBT8+c+7Abcr0H718Rgrcjjv/5/RmBG0Y5xfEUNZEyH9AI4f20ul4dQa4nAmtJKK204Hbpx+t7pzueLZplS8d4k6BjceYlysnkCEFp8yylaN4jJmCj1nBRiITqC/i9/fwmFk+UXoB7+ENuqGq0jsK3h/L991ul/7Frp1OVZyp04H38JhsoJjYXgxl4cpAaD5TZ56mUk4JNnW5k3DsNfn6mQ8DvdLMX5UiS0Hz0juAG4E2O6XSTJRaWNUq+HVV6gfrnSiNt2ARfNBhiQOejbt4P2mJrwMVoBraXfFQmBqvwTEi5ExYZ4ZSLSY/6ctylIkE2uAfTMkpBYVrDFcvE/KMro8MkU1KbK/rCQUsaza28EbpM1zJzYjiqYYO8+MrnDADKY5wJSjGQrJMOILLnb0S5n3sRJWD8TvHJxZBOlNugRNlI6XOkMQmmuU5o4cB2SJM8jvSftwcL8hpa5qQCWkwRbRi0080kqNTmaqTeMNHU6XO3CSvvK2P7KhLuVl8RpVuGpa/AUeZGn2AwGXqygz56ciH4OeyWnCU5K54h/M0aarQhZIE7V48wfftq4GET37F55yKbAWB8QVeG3T+cV2dcFiDZcfy9Ounh9APJ9HfF+kprdj+jmd86hSMEecSC1ZxlmdUWQypQfO0lCnGwFfizprnaoaeV5li6SfNx+TVZJa5F2rzOiky+GWzhXML+xOtJ+x0qgpZlZeDqnlx7XLhpClz92QHd/3S2wjdl1pZF8hAV68vnXUssR1Oj9sGxXF0Grh2uOeotpKXEeZKn4ngIuYy0YvCz2p6UJfkUnL/WJ6+fHFwCP12osMp/M9/w+nL12sYp8+NAYEY+/tVjkS7G92W0GutYWU9agim6mnAz4vxGA8QDvzVxqulVXYs8WXH6XFESQ8nyvUizSok/MJ754w+Rb/mJRslGtqwU6swopWJRGBNNB97Qw3FB8r8ehXDoYdoDFO8/DTV+R44+nilMpQDqBSdem55Cs61QPTFkoQXyFhwT67DCRpveNJjwTHdKNHKGFIIaBd4u7QqLaekDc05YH+fRxFOed+JHlwdmT2fspnAy70qcDxMp9AJGd87xLpIZwjZm8wCauKWWH+tTfmsKDcPGi84T8Vt2i5uQpQ3cejpnWfSIWGf+XQ9NxkrMCbipsPQf2U6hO78HLHmRUedNiC0M1zeV6zFeUIfY227248f7yBwvqDRsXwEks8R7UlSY9tf+7pWD4VdTHiCw8+FIR3g9BjV8nqcquNDcUUMsRMbzqgLQrA6xb6T59VhPm3G77ghyeXCXRWMtdfW+Xi7VLXv5h5c+Fac8XoPMYLfggZumzKZouBzt6S+8SI93WmEnCvQ8Lw0FVNzjxg9L6eEoZgEjuNSiNlM+GgXglvYBZBjHG6fHr093fk1KHygSWkehFqLtSOnXAu7YeoVFayuCPa01v+8Htb4gncCTUsMMa/rYAdORSR5dwO9sVJYKhOkPcOVnqxq9NPXGARaG3ydB+10VeL+M9f4CAHP6O/gK5aczZlODb23YVaQhrrArjgYicOV8BqFjt3Ed8ycBgyzgStROOgNKgMlqAkmREox/jlzC/uwYaOUl/OZjALeaVapYKS5k5rJlMkJXgTUERqCWiDjT8vE3QWCF6euSneV0sXL0IUwFz7im64QxmvD0bz7VsgzIocuHFUa1Bs+MsLy9oPfVUzv0JjflVkGQUenC3eNUeOGfS3sN+UIiywqI6zSi3rURNhpOaKzbI6tfvgJgi5dubR/ijFFUx5ynVOU8YDrmUiu2X4fa0ia/g4FeFfcq23vAAWOke+YlinICuHNzqMAB7SfWd98Hy6lnVRqcs17Jw0rxMakBdrCi7Hfr/c1X73fKI4ykXBpeMN1/+jrl9/C7E5vN4obTuuPOMv+t88eP31+8BSB8dcEHa293d4uhVmVsTmTjZXQoCJNYtUH03hrsy3auy3auy3auy3auy3auy3auy3auy3auy3auy3auy3auy3auy3auy3auy3auy3auy3auy3auy3auy3auy3auy3auy3auy3auy3auy3auy3auy3auy3auy3a++fjEtuivduivduivduivZfco23R3j970V7/ABMB6RcZE7LxXt09ED6qS/m+jaMpvh3eP4ouLjCD5DW+58PPP5Rc48Pjt3E0Y1pghI2eHcfhrSw+9jzj+HTysQvxdg9x5dhphZSOtfLaGh/7uhGPKPv5yr7N582Yy40P43xhsVylOEazOb6ZY3P3ms8THr2CZVQrMWNyUtLb08jNic978WFj+23wGb0N9n80nrDiw9cawvajYbcN/C9uauOAiwv37piemrr+runSER6xoTee3Nvlcvm/mR19sg==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},f=void 0,x={},j=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Self Sign"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/selfsign",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Unique identifier for this widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Specify the hint for widgets. This parameter is optional and is not applicable to the following widgets: checkbox, radio button, dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options":{\n "hint": "Provide signature"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp",\n "hint": "Provide stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials",\n "hint": "Provide initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide email",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide name",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide job title",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide company",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12,\n "min_date": "",\n "max_date": "",\n "signing_date": false,\n "hint": "Provide date"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"min_date:"})," Provide the minimum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"max_date:"})," Provide the maximum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"signing_date"}),": If signing_date is set to true, the signing date is shown to the signer during signing. You may set either signing_date or default, but not both. Using both is not supported."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image",\n "hint": "Provide image"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "default": 0,\n "formula": "",\n "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hint": "Provide number",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,s.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"decimalplaces:"})," Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"cells"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "cells",\n "page": 1,\n "x": 100,\n "y": 100,\n "w": 114,\n "h": 50,\n "options": {\n "name": "cells",\n "required": true,\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"cell_count:"})," Specify the number of cells that should be returned to the user."]}),"\n"]}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(y.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{...i(25816)}),"\n",(0,s.jsx)(u(),{...i(40402)})]})}function w(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}},25816(e){e.exports=JSON.parse('{"title":"Body","body":{"content":{"application/json":{"schema":{"required":["file","signers","title"],"type":"object","properties":{"file":{"type":"string","format":"base64","example":"base64 encoded pdf"},"file_password":{"type":"string","format":"string","example":""},"title":{"type":"string","format":"string","example":"sample document"},"note":{"type":"string","format":"string","example":"sample Note"},"description":{"type":"string","format":"string","example":"sample Description"},"timeToCompleteDays":{"type":"number","description":"time to complete days is used to calculate expiry date of your document","format":"number","example":15},"signer":{"type":"object","properties":{"role":{"type":"string","format":"string","example":"ceo"},"email":{"type":"string","format":"string","example":"joebee@example.com"},"name":{"type":"string","format":"string","example":"joe bee"},"phone":{"type":"string","format":"string","example":"123121312"},"company":{"type":"string","format":"string","example":"opensign"},"job_title":{"type":"string","format":"string","example":"dev"},"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Allowed values - signature, stamp.","format":"string","example":"signature"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":244},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":71},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":38},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":46}},"title":"createtemplate_body_widgets"}}},"title":"selfsigndocument_body_signer"},"folderId":{"type":"string","example":""},"send_email":{"type":"boolean","description":"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \\"true\\". If the value of this parameter is \\"true\\" and no \'email_subject\'/\'email_body\' parameters are specified default email templates will be used. \\n","example":true},"email_subject":{"type":"string","description":"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.","example":"{{sender_name}} has requested you to sign {{document_title}}"},"email_body":{"type":"string","description":"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.","example":"

Hi {{receiver_name}},

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

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

Sign here

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

Thanks,
Team OpenSign\u2122

"},"enableTour":{"type":"boolean","description":"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.","example":false},"redirect_url":{"type":"string","description":"Specifies the URL where the signer will be redirected upon completing the document signing process.","example":""},"sender_name":{"type":"string","description":"The name of the person or organization on whose behalf the email is being sent.","example":"opensign\u2122"},"sender_email":{"type":"string","description":"The email address of the person or organization that users can reply to.","example":"mailer@opensignlabs.com"},"merge_certificate":{"type":"boolean","description":"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\\n\\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\\n\\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\\n","example":false},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed.\\n"},"cc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"cc (carbon copy): Users added here will receive a notification email once the document is completed.\\n"}},"title":"selfsigndocument_body"}}},"required":true}}')},40402(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Document created successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"hji2zxcv2P"},"url":{"type":"string","format":"string","example":"https://url-to-sign-document.com"}},"title":"inline_response_200_1"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/d48fee54.9e6fd416.js b/assets/js/d48fee54.9e6fd416.js deleted file mode 100644 index 073b90798..000000000 --- a/assets/js/d48fee54.9e6fd416.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[1332],{96455(e,n,t){t.r(n),t.d(n,{assets:()=>y,contentTitle:()=>x,default:()=>w,frontMatter:()=>f,metadata:()=>i,toc:()=>b});const i=JSON.parse('{"id":"API-docs/v1.2/selfsign","title":"Self Sign","description":"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.","source":"@site/docs/API-docs/v1.2/selfsign.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/selfsign","permalink":"/docs/API-docs/v1.2/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":"eJztXG2TGzdy/iudqVQk8YbkklrJyp5OdbLl2EpkSeVdlcrZ3dsDZ5oktDPAGMAsl95ilT/cP8inVCVf7qfpl6S6gRnO8GVfZPtOSegP8nLw1mg0Gt1PN3AVOTGx0cFx9EInZY7K2eg0jlK0iZGFk1pFB9HRFMFiNrZyouD525cwQYVGOLQg4N33r8BNhQNUYpShhbFBtG6eIVB9qSagxyAgDf334AddQiIUiMxqkCrJyhRB82Aig8JgN8WxVJjCTKYTdDaG2VQmU3BT3ycabo+pdKAN4GUhVAploRUICwoxxbQHR1NpoTD6QqZMaEUNXhZoJKqEOstlJgw4zX1//Pm/DmmKP+jS0Hw//vzfMM70DKTi8jcFKq4giqJ3ok7UkSwO4F2RaZHCXJcG3r74l3qi1Ct9O+50XuConMC7l53O6f2pc4U96PepD12gIrIyMbK9ROf9lCoW6fgBTRkNUq9+rsLKbA4ibTDFTVFBoos5JFqbVCpakRgKMUFQZT5CY2MgzuTaIM1BgEGRzrtOd0uL8K+Hb17DWJtcuB68zUob18Ol0mDisrnvnuZezeqehZGw+HgfrDNSTWLIxTmxVTr4sZTJOU3bokorpj5/+5J51ekclkWhjcMU3vspHHQ6VPIlEo+FQa6f6DzXCgphRI4OjfXSRcUGfyylYblwUxBZVvHi4ER1odNRIseDTgfeKfljiSBTVE6OJRqaJTiSB9+g5+u7ecH1X6pUJizORAB9JZFtVSWmUtXDAhPq0ldtsBq0ClJKPJwJv/5FJhI/LYO2wMTJC2x3fBnDnDp+gUpXFEy1kT9p5UTGy3eBxslEZM1lJgJ5OzhhHLG/0FK56msYod5ptNq8iEEOibSUmJtLxSUW4UJkJdpA1SyGKVH1PRYGLWmFql9ivEphinIy3TqeSD+U1rU6htISmU0qwljVqjJ7kdk2FplFkOMWL3Nxjo3Rao3Rgy/nkOJYlJmLQZKEOlNiD15rRzs1kwkpJpYB2mzClQa7vMpBfHpt8Xm71BmpHI/R0GamQu4itKmoI7n0SoamxzvNTYUCrVYWOtGZNusixJ/bfIREK8ea8vmFkBkT7ydra3U5ykRyHsMoKzEGg6nf6HPMMj2L/f7gKqQQPc+ZP6TGSQq1IvqVDsNLCzZQVSvOav9RYa2caRBpm1wNu3ysaWRiQbUlAXMhs5gZF8MHPQInXYYxbfBCqHkMqXAYg8NLN9KXMSRTTM5H+jLwa6yVs/KnDbuuKrk714Yx7MfwOIYnMQz2YhgMYxjsxzB4HMPgSQzDvRiGwxiG+zEMH3ueDp8EfoqaiU0CBkPPSff5cXAqUzyjwjOi/0xYh0bac1K78J7ODn9ip7FXe3jpSInVh2y6PMmkhalMU1QwNjoHg4ksJGsFv6vrrmMYlQ4MEa4sjMssm8OFtLIxz7pTPaOD3B+t0jQO1yTRJa0jc9Ezjlm2XFaVzYnUIxS5ZY5+rRyawkiLpHKVrTmg3FJ+/EFG35ob+TarpdqaZPuKVSsQgxGp1MQNp1UMqdFFqmcqnISvpGXdSUeYrU/FWetUHPSg06n1FX3785//fKKuThTASUTq6yQ6gJOornISxb6MTiUqG4Tfl/Tj4fCL8HNOPx8Pn4SfM6462A8/p/RzWDUNG+gkOuBxuYJUzo8c9CQ0KKBKixO1CMSeqCHPwom8uGYGVPzbUg81+dVpQx/pmIirAtpl6/RsmbGvsTbbhzRbqaSTIrPbJ1zV+IzmvELS5mkvK63NfJ9mzvpq+7S5+DOac5MeKuGz0Bfx2dkoqjQ+UzG8hkWrfW7TwdSKrZw1Tj7qBVNkOyP9FD4bPjbI+bXYuNLl3bn4mLhIR+YRHZnbWVmfqp8RP1dp+rWYuqnfu3P2ix4bs2yBbOdrqPAZcbVN0a/F0/Ve787RJ8RRMuW2s5NKPyNeNsihgmAX+7K9/e7gUXe4N9xv8ZNQBl8hz7tp2p3P579sLXKpzjwd1KhRPxeXmwsCAFQX8mpcs7a+3spykVkZ5kuWZeUsetNWOPQW8joSwI76slZwXfjvynv+jnzmUeVOYlrBTrVjUYM1TYfX6VTM71nfVdW09qGo/qoF7MnkIqKDgatkqmUSiKc6lec0ImymRzzo8tL107TfWDr6mKbdPO+ufKSfXV7pxsc876Vpb6Xmmjj4jzmkaQzrnzd+T1PI83zLZ/+99bmf5+uz6OV5oC1wr5KwtXXOpZJ5SX4QYWDenaaK5EoE9uZhLaWCTueHH374ofvdd90XLzqdag3DEEFWG7CDH0Fc/kojNIW+0zmAl2NofmLX34MuvNdr94/cmrrCVM9U5fUEADYtCf2rqnroJxdz7gylm6Jpj6PNUmTJRySXaqTdtAfv2IWkvytXq3aJ2F36Z1KPwcfdriFDhb+VklzqwvbA1ypQQl/Jd11XPi0Numb8VIqp2GwdGZyUmTB4SVidlVqtab5POenudoqtqMVKlpeYCaOAAYfFCrKA+2+Cp/2gBgNX5kK9PYektI6BhwleQiGcQ6O4swuRyVTw/ujyB7wUeUEgSf9PJyfp7/6xzzAsIZ3O4wapnEhCz/t/On7e/ffTDTXKokCTCIuQIY1kY0CX9OB4ilmxBPBns1lv9tAmU60zj95/sAbH/t8zPfpwxuQWPWGLB5tm6oWhAXuSsKyinrw5GxwTFqqWG4BPXhreNYM9ttMCHnGNoRZqfEbWxQpJVOgxZCo+pgOeTVgSXlz+rUnnnESny+OeoU5Mb2h7eovtSbshEyPM1ovuvrUyMddl2NEVtN+eapDoBt+CwVOjtzydvbhRKC5XCn3ZYsM+9QxpbtPqtK+2Z7UCkElbHyQtdjZbB4CfwzQUfCOxHSFUDWBUS+kv3gU1YbfbBhUKymt3wxBUD7hiHVyp8dTrR2gtzNpJHmyFKko0rnutWFYd5E1+UcvSolmaCdeMEGyF7SNQSGb7ACdqwFijzMXkGheEiz8jLdGkZwtc5Wus+VsDBiU9u64BWbj8+gkP9loTftSe8OO9TzAnWsNey4qGzbDX0DkmLzOxZgGkmMhcZByP5KGHv0CDbcBrVqn+FPsh0E7y/ZXOi9J5+Q6WA3kmrOMrQa8CcT4E8bsYujF0YujHcD+GBz34Hjl0l9RhviD30vhgnlSQ6pLw/KQ02RxGhngTA/YmPbi6+rEUykk3XyygA1dXlO6wWPRIU5wrPfORvmOKbTigSP3SLkh1YjdE9nVi+2RA9F/jrFslW/QDaQ/gvl7RjNdaU4EFa+q0tczU9HWtFLzdw5FfaYtMzEGMKdzho4PczAeRe8SBAxjCH57BYNjb24thz/8N96vxhw94IzHenWB2HdjNxTdto73mNlr+3KQ3Hu3dah81h/1Eo5y6OONYFI+72VjfqIE+Q+N8OZlVOKBxbhDP/JFhp7rMUjo1DLrSKKzzOcKpEcWRLigJSGr1Mo0OoipBKIqZ12jdlzqdRwdXUQjM0p8hiEaN+h8sJRddRTaZYi7or2qNKB1pLDOM4sh7mzaKI0YuKTeJRCs6iPToAyYuiskrKsiMQkt9cLuDq6qWT1KJ4oBARQeRz16J4ih4CvUnQJVogl2KdBwtYu7prBDWzrRJr+2y/rLskjrwFN+xoeU/6igp9UOJIZ/YzWtquljJ5/qknl40euC55XikSU1n6PCFmNtGv16iotU0MmpDUpSEVpCKuSWfv7RevBKRJWVGaAFeFtLMa6iMIaqaJQ1665FqegePFpXUNCjaIixG332BEtTEAA703LXtB40jxD+GD3Qu8PqK/M5UfNAII+S1LaZa3bn9YPhwMBw8HAyphwBi37WP6oyjLj7o0dknyXuKF9Q+nION1sIYMY/iSDrM7c1L6UvXx26L4HOK2GNauSzdZew69kHd3k27oarPnBcTvFnsj7YlijVyV4K6FUWBwvQ4X+uTUwfbO6m2oHo37JtFHF3ePJlLSHS3ykKD+xmOncdLINFGoXnQxL8/m8kN9/cXcTS/eXrz/5XT+4IWb3bz7N5z+t4ytfHvQevDJ4s4mt5M67d1guHfkdj9x4vlOR4lBoVDh3lBnZyNdDo/q/TWolmxMoWqE8tXDYcSWRY6S9G83GhUtE0ISqQ9Wz1qRlpnKNQGRdPKYxKk6yxjHISgBItvNkV2omrog3u3NWYT8BZvdoVwQwvClZbMe1PiSdSjaMLSRWPUZDWVqqrLqVRKwz0e78yWrMbv9cNv4tC9ZtIv5VUuA18VCVwZqiWgdN4sI7rJguhB/R+bpzUniYDqxK4Gvvmo+MpDzjxgaNROIYVg5vbgK6HqFMN2YhhcXdVCwNKxWMDVFa0qmjM69xeLePmBxmp94KPdfzGYoLxotao/4bJh/a3R1BtTHIbxH8J53yQghGpKE/ohm3Ox6LUEcoVwmDIIxzzAtJYzSuFbn3VtMvFK35r7a8wOEkCd/L/h+9Pi2bdyAylP+8Wzp8Wz95QwXqDfe549Y6lSv/NnmGU9eGqd0WrybIUFT/vh++alNHghccYbl1d12csqb+uOeoEmukHRWDxpITFlIkXGsRajE6yy+NkDpdRT67CwhOtK5yOHnO/Llr+YGETOGSVaROk4QZ69yGrApwKmBsd/uLfC03vPOKeUEJqnffEs1H7pod+puEAQag48cUbAtfEQ9rg0rCaTTBg5Di5rDEWGFBcij1YkHpL2HK3oOJoKdW7jpyPzjLJT66zWj3/5K9XgbcBZt0e6NLfQ6YxUd/3ahlRY1nm+ExAwKTlVwBGfKvXEIatlUrpU1pnSg8dV3LYZ5uX1sLYX0u67BBD5PNcpNvuPAZX1zQWMGXWIoVSScm9NWZDkrN+xaYkyD7AggMBfMKE1ulkXtLO/6b6RvxvTiEZX50DVMYbrQMHVrG8eVLnHq1PfePCGfXIzgXRIMqQY4gYFGqsVyZI2E6GCqHrDX1ty3KYi81X9fpWUaMHhdEpg3+hkffzLXxt0bfU+1wnzI4g0JfzpBgoZ+iGAx3LMwGCRzcHpNkXUH5o/rtpaRF2OZoJnCXllvGfwFhLe6ZCMdzrQ9YnYQbxt6W9SuOpSEK8jLemyd+Jb0P91skwFLqStu1g9+FbP8IIENmxhUrS+f00QMVMeMuGbIyRCcaYC7XOyTqjjOkmGstyXQ/jUbhZxnk1QMhQf9uPxJRYaJ75uTpUo11lAgi+vhdGr1HyaHAFUIDLNCeiucT0ubRP1ku8nTFkVcLYHxbD8ONXFIM7F//jzf9KFuQo2t7V5t7GULTS+wscpG81eK2utusnTa9tjlRZQ2snx/Eyrs/qksBsFpt3yWgFq7HE213XQDeHsBLpKxxuCBw96nfSJIukItwRD7opt6Yy19d0+GDHkVxqQALwD+B4nwqRZvYH9Mjq+fieaguSH2iYNfHxuETvhnEimyNcdUizoAp9WcG/pgDSsc1pPgj9QnTF4fRvYJmioRWM1jyO6vsR4cRrFHvyOThdxNEqST+2RlFcLX4v507D1be2C6yhJ4P4ok8QeYUbaX6t8cADvWBeKlPYhnzltYWovqmc+q5PWYUPWT6WVmHU3uYrem1yi4cGBoSuEWlm/SYZ7e/S/9jxetMSRzuMyofONL+L8QxTfHoq/Hmzznzc7sNehZ9MPcvjTZXIxfEvLtuXwv7aD4OyXJqNbrMS5br1f+BBq8FaqTCo8q9h2NtzbOxsQbxdxtL+JfYc6R68nZ8TEGZm09YHhzBzEhDQ+uZ7mV+QmGqPN9VjA3Si7jgn7LSY8WmfCS8UZKHzP+0ifo/rbzrQ5vPPDE6mXOcuKt8ci6StxedSabPO7n6TFpDTSzaOD46vosisK2fXlB8eni1OyWdxUUwCr0JYpFm4aHUT9RjzLormgIBT1wEJby6EVKqUEkTXgSRSyfzHoEby+2mYjUHVNfSy7d21inZhINbmp3emSO4e0gn6RWjxaauFC/huSGg5L0KwVR5IkZ4oiJYCLwgFWq++XUcCvq+Wt4nObQm5rEbcoaujJlbBYFRVrBbpW1fqG0NXmyNXgUTNm5KNCHOip4zybQjc1L6pgTB2LaYRXGtGVZcCkFS/hEEgjAnK83B51sKGKNQwYpB/u7zOa/cWAYd+HTxhR3X+8OG2Bi1HUBhA57L0Kg/0yVKcN6uyQiv9DSEUbqAiWd9txrwSsdpRb3uqqs7rVcdzoN4YBN/sIobBpgG42JoMteVu7cEGabKxZ7YXNWV9LpgOJ1eZaVAWzROf1reBOp8HJulWnU+suLw1k3L8pDRR6hmZc+qvG4wwv+a40NcOcy5YIPoqcXIBsDgS5TNgd5KwekdWARiIKMZKZpBOXqukgl8tD2/bo8ncVA7hnfFrRBWZ0UJPI6lwwYFLbrzNtzukZFHpNBEaUbkWOCKqpUIkHLfwZEpNMkr+zvIxtnSGqpadNK2dIGHOhxIS3SdwUO0gxI61hwegRJUVanZVe2J2QmTY+S4AnRKJvmYlfXxZUxKEhUrUGpyRfFwG6snRdnq7s8jKHB1FGhCQXRIskT9ZpKFWm6e0SQpHLjDKhyN4hNaDHLRqpuTNCWTJTQ2JCWIOaYQFVQht8xncWaYVfSXXub3d34biWq/c4stJhO698dY88aLf5RrpvyxG9zqGtdNrMl60n0k3LER/0zU7qH76nb8IDPtA4xm+fwXbofU/bf/72JZuID+Djz/8Br1AYBVM989KalAazef1WkH+Jhlfes6228Bi3JF1JHE+88AUVX3Hw/VQ4BiBeI7/G47eUz2z6Bh0chYgQ/BO0ftJFe7r1YjDXFwQKKoW0NMLMW8EmOjhqfIdADoYxhBMe7Ak++rIFp9udtA2Wk6gZfEsDJuU9sTpkFUNZpO0PocZyu/FhUxenRoxd24Un09QfdEaXzgtwdTekooaZWhjtPBpapOOKaI4LnunxmB0D6uZWlIN/Y6lFfGN87jVgh05X+DTd+glgchiw1lQh11yaZTgvEOi5fUZm2GbKlsCvBe9pcIJji1FrfL2R0WsrRRMuylEmk9UJ9+B5kiAj3iEdPty0ooTiOkvyQUzJ9hJn9JX+FgWtEv3qwWGgn7O//fHugM5sx0/HLC0Sbxf+HnxHzQZKV5mtv4eqa8uXsGpzocp8panq0gW4aRlRkwYD1BTFq4Z/+5Rj4I94x8u73NSFDJv4uFIG0L4mc3dl4lOS2G5hpzGYD6KQG0FnesbIvhkformQSQUSbNGjfa7cj+Iokwkqiw2n8vk3b1/BxcPeXhQ33KlbqNT+q5dfff368GsihpbAM2zQ2+vtMUymrcuFaox0SPv30DsCK5l5taO9e3Rt9+ja7tG13aNru0fXdo+u7R5d2z26tnt0bffo2u7Rtd2ja7tH13aPru0eXds9urZ7dG336Nru0bXdo2u7R9d2j67tHl3bPbq2e3Rt9+ja7tG13aNru0fXdo+u/XZaYvfo2u7Rtd2ja7tH17bso92ja7/5o2vhagAR0i8yIVXjJpW/unK8fIrtNI6mdKvl4Di6uqIMkneUaU6ffyzR0JWY0zi6EEZShI0vxMTVLQ66hnCOlNT/lQ/xdo9o5NhbhZyOtXIPiK6h+BY+Oe7aus2LN2/fHB5RynZ4GCLXKbUxYkbZ3GLm88yD4PH9DMFv3WRCTUq+FRH5PuniCaWRtm+tnPOtlfBH43IFXclYUti+zuKnQf/SpDY2uLryN2L4EoSv74u2tgiMrWrTyp0uFov/AQ0M2hQ=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Contact list","permalink":"/docs/API-docs/v1.2/contactlist"},"next":{"title":"Draft Document","permalink":"/docs/API-docs/v1.2/draftdocument"}}');var s=t(74848),r=t(28453),o=t(57742),a=t.n(o),l=t(78178),d=t.n(l),p=t(19624),c=t.n(p),h=t(96226),m=t.n(h),u=(t(77675),t(19365),t(51107)),g=t(21312);const f={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:"eJztXG2TGzdy/iudqVQk8YbkklrJyp5OdbLl2EpkSeVdlcrZ3dsDZ5oktDPAGMAsl95ilT/cP8inVCVf7qfpl6S6gRnO8GVfZPtOSegP8nLw1mg0Gt1PN3AVOTGx0cFx9EInZY7K2eg0jlK0iZGFk1pFB9HRFMFiNrZyouD525cwQYVGOLQg4N33r8BNhQNUYpShhbFBtG6eIVB9qSagxyAgDf334AddQiIUiMxqkCrJyhRB82Aig8JgN8WxVJjCTKYTdDaG2VQmU3BT3ycabo+pdKAN4GUhVAploRUICwoxxbQHR1NpoTD6QqZMaEUNXhZoJKqEOstlJgw4zX1//Pm/DmmKP+jS0Hw//vzfMM70DKTi8jcFKq4giqJ3ok7UkSwO4F2RaZHCXJcG3r74l3qi1Ct9O+50XuConMC7l53O6f2pc4U96PepD12gIrIyMbK9ROf9lCoW6fgBTRkNUq9+rsLKbA4ibTDFTVFBoos5JFqbVCpakRgKMUFQZT5CY2MgzuTaIM1BgEGRzrtOd0uL8K+Hb17DWJtcuB68zUob18Ol0mDisrnvnuZezeqehZGw+HgfrDNSTWLIxTmxVTr4sZTJOU3bokorpj5/+5J51ekclkWhjcMU3vspHHQ6VPIlEo+FQa6f6DzXCgphRI4OjfXSRcUGfyylYblwUxBZVvHi4ER1odNRIseDTgfeKfljiSBTVE6OJRqaJTiSB9+g5+u7ecH1X6pUJizORAB9JZFtVSWmUtXDAhPq0ldtsBq0ClJKPJwJv/5FJhI/LYO2wMTJC2x3fBnDnDp+gUpXFEy1kT9p5UTGy3eBxslEZM1lJgJ5OzhhHLG/0FK56msYod5ptNq8iEEOibSUmJtLxSUW4UJkJdpA1SyGKVH1PRYGLWmFql9ivEphinIy3TqeSD+U1rU6htISmU0qwljVqjJ7kdk2FplFkOMWL3Nxjo3Rao3Rgy/nkOJYlJmLQZKEOlNiD15rRzs1kwkpJpYB2mzClQa7vMpBfHpt8Xm71BmpHI/R0GamQu4itKmoI7n0SoamxzvNTYUCrVYWOtGZNusixJ/bfIREK8ea8vmFkBkT7ydra3U5ykRyHsMoKzEGg6nf6HPMMj2L/f7gKqQQPc+ZP6TGSQq1IvqVDsNLCzZQVSvOav9RYa2caRBpm1wNu3ysaWRiQbUlAXMhs5gZF8MHPQInXYYxbfBCqHkMqXAYg8NLN9KXMSRTTM5H+jLwa6yVs/KnDbuuKrk714Yx7MfwOIYnMQz2YhgMYxjsxzB4HMPgSQzDvRiGwxiG+zEMH3ueDp8EfoqaiU0CBkPPSff5cXAqUzyjwjOi/0xYh0bac1K78J7ODn9ip7FXe3jpSInVh2y6PMmkhalMU1QwNjoHg4ksJGsFv6vrrmMYlQ4MEa4sjMssm8OFtLIxz7pTPaOD3B+t0jQO1yTRJa0jc9Ezjlm2XFaVzYnUIxS5ZY5+rRyawkiLpHKVrTmg3FJ+/EFG35ob+TarpdqaZPuKVSsQgxGp1MQNp1UMqdFFqmcqnISvpGXdSUeYrU/FWetUHPSg06n1FX3785//fKKuThTASUTq6yQ6gJOornISxb6MTiUqG4Tfl/Tj4fCL8HNOPx8Pn4SfM6462A8/p/RzWDUNG+gkOuBxuYJUzo8c9CQ0KKBKixO1CMSeqCHPwom8uGYGVPzbUg81+dVpQx/pmIirAtpl6/RsmbGvsTbbhzRbqaSTIrPbJ1zV+IzmvELS5mkvK63NfJ9mzvpq+7S5+DOac5MeKuGz0Bfx2dkoqjQ+UzG8hkWrfW7TwdSKrZw1Tj7qBVNkOyP9FD4bPjbI+bXYuNLl3bn4mLhIR+YRHZnbWVmfqp8RP1dp+rWYuqnfu3P2ix4bs2yBbOdrqPAZcbVN0a/F0/Ve787RJ8RRMuW2s5NKPyNeNsihgmAX+7K9/e7gUXe4N9xv8ZNQBl8hz7tp2p3P579sLXKpzjwd1KhRPxeXmwsCAFQX8mpcs7a+3spykVkZ5kuWZeUsetNWOPQW8joSwI76slZwXfjvynv+jnzmUeVOYlrBTrVjUYM1TYfX6VTM71nfVdW09qGo/qoF7MnkIqKDgatkqmUSiKc6lec0ImymRzzo8tL107TfWDr6mKbdPO+ufKSfXV7pxsc876Vpb6Xmmjj4jzmkaQzrnzd+T1PI83zLZ/+99bmf5+uz6OV5oC1wr5KwtXXOpZJ5SX4QYWDenaaK5EoE9uZhLaWCTueHH374ofvdd90XLzqdag3DEEFWG7CDH0Fc/kojNIW+0zmAl2NofmLX34MuvNdr94/cmrrCVM9U5fUEADYtCf2rqnroJxdz7gylm6Jpj6PNUmTJRySXaqTdtAfv2IWkvytXq3aJ2F36Z1KPwcfdriFDhb+VklzqwvbA1ypQQl/Jd11XPi0Numb8VIqp2GwdGZyUmTB4SVidlVqtab5POenudoqtqMVKlpeYCaOAAYfFCrKA+2+Cp/2gBgNX5kK9PYektI6BhwleQiGcQ6O4swuRyVTw/ujyB7wUeUEgSf9PJyfp7/6xzzAsIZ3O4wapnEhCz/t/On7e/ffTDTXKokCTCIuQIY1kY0CX9OB4ilmxBPBns1lv9tAmU60zj95/sAbH/t8zPfpwxuQWPWGLB5tm6oWhAXuSsKyinrw5GxwTFqqWG4BPXhreNYM9ttMCHnGNoRZqfEbWxQpJVOgxZCo+pgOeTVgSXlz+rUnnnESny+OeoU5Mb2h7eovtSbshEyPM1ovuvrUyMddl2NEVtN+eapDoBt+CwVOjtzydvbhRKC5XCn3ZYsM+9QxpbtPqtK+2Z7UCkElbHyQtdjZbB4CfwzQUfCOxHSFUDWBUS+kv3gU1YbfbBhUKymt3wxBUD7hiHVyp8dTrR2gtzNpJHmyFKko0rnutWFYd5E1+UcvSolmaCdeMEGyF7SNQSGb7ACdqwFijzMXkGheEiz8jLdGkZwtc5Wus+VsDBiU9u64BWbj8+gkP9loTftSe8OO9TzAnWsNey4qGzbDX0DkmLzOxZgGkmMhcZByP5KGHv0CDbcBrVqn+FPsh0E7y/ZXOi9J5+Q6WA3kmrOMrQa8CcT4E8bsYujF0YujHcD+GBz34Hjl0l9RhviD30vhgnlSQ6pLw/KQ02RxGhngTA/YmPbi6+rEUykk3XyygA1dXlO6wWPRIU5wrPfORvmOKbTigSP3SLkh1YjdE9nVi+2RA9F/jrFslW/QDaQ/gvl7RjNdaU4EFa+q0tczU9HWtFLzdw5FfaYtMzEGMKdzho4PczAeRe8SBAxjCH57BYNjb24thz/8N96vxhw94IzHenWB2HdjNxTdto73mNlr+3KQ3Hu3dah81h/1Eo5y6OONYFI+72VjfqIE+Q+N8OZlVOKBxbhDP/JFhp7rMUjo1DLrSKKzzOcKpEcWRLigJSGr1Mo0OoipBKIqZ12jdlzqdRwdXUQjM0p8hiEaN+h8sJRddRTaZYi7or2qNKB1pLDOM4sh7mzaKI0YuKTeJRCs6iPToAyYuiskrKsiMQkt9cLuDq6qWT1KJ4oBARQeRz16J4ih4CvUnQJVogl2KdBwtYu7prBDWzrRJr+2y/rLskjrwFN+xoeU/6igp9UOJIZ/YzWtquljJ5/qknl40euC55XikSU1n6PCFmNtGv16iotU0MmpDUpSEVpCKuSWfv7RevBKRJWVGaAFeFtLMa6iMIaqaJQ1665FqegePFpXUNCjaIixG332BEtTEAA703LXtB40jxD+GD3Qu8PqK/M5UfNAII+S1LaZa3bn9YPhwMBw8HAyphwBi37WP6oyjLj7o0dknyXuKF9Q+nION1sIYMY/iSDrM7c1L6UvXx26L4HOK2GNauSzdZew69kHd3k27oarPnBcTvFnsj7YlijVyV4K6FUWBwvQ4X+uTUwfbO6m2oHo37JtFHF3ePJlLSHS3ykKD+xmOncdLINFGoXnQxL8/m8kN9/cXcTS/eXrz/5XT+4IWb3bz7N5z+t4ytfHvQevDJ4s4mt5M67d1guHfkdj9x4vlOR4lBoVDh3lBnZyNdDo/q/TWolmxMoWqE8tXDYcSWRY6S9G83GhUtE0ISqQ9Wz1qRlpnKNQGRdPKYxKk6yxjHISgBItvNkV2omrog3u3NWYT8BZvdoVwQwvClZbMe1PiSdSjaMLSRWPUZDWVqqrLqVRKwz0e78yWrMbv9cNv4tC9ZtIv5VUuA18VCVwZqiWgdN4sI7rJguhB/R+bpzUniYDqxK4Gvvmo+MpDzjxgaNROIYVg5vbgK6HqFMN2YhhcXdVCwNKxWMDVFa0qmjM69xeLePmBxmp94KPdfzGYoLxotao/4bJh/a3R1BtTHIbxH8J53yQghGpKE/ohm3Ox6LUEcoVwmDIIxzzAtJYzSuFbn3VtMvFK35r7a8wOEkCd/L/h+9Pi2bdyAylP+8Wzp8Wz95QwXqDfe549Y6lSv/NnmGU9eGqd0WrybIUFT/vh++alNHghccYbl1d12csqb+uOeoEmukHRWDxpITFlIkXGsRajE6yy+NkDpdRT67CwhOtK5yOHnO/Llr+YGETOGSVaROk4QZ69yGrApwKmBsd/uLfC03vPOKeUEJqnffEs1H7pod+puEAQag48cUbAtfEQ9rg0rCaTTBg5Di5rDEWGFBcij1YkHpL2HK3oOJoKdW7jpyPzjLJT66zWj3/5K9XgbcBZt0e6NLfQ6YxUd/3ahlRY1nm+ExAwKTlVwBGfKvXEIatlUrpU1pnSg8dV3LYZ5uX1sLYX0u67BBD5PNcpNvuPAZX1zQWMGXWIoVSScm9NWZDkrN+xaYkyD7AggMBfMKE1ulkXtLO/6b6RvxvTiEZX50DVMYbrQMHVrG8eVLnHq1PfePCGfXIzgXRIMqQY4gYFGqsVyZI2E6GCqHrDX1ty3KYi81X9fpWUaMHhdEpg3+hkffzLXxt0bfU+1wnzI4g0JfzpBgoZ+iGAx3LMwGCRzcHpNkXUH5o/rtpaRF2OZoJnCXllvGfwFhLe6ZCMdzrQ9YnYQbxt6W9SuOpSEK8jLemyd+Jb0P91skwFLqStu1g9+FbP8IIENmxhUrS+f00QMVMeMuGbIyRCcaYC7XOyTqjjOkmGstyXQ/jUbhZxnk1QMhQf9uPxJRYaJ75uTpUo11lAgi+vhdGr1HyaHAFUIDLNCeiucT0ubRP1ku8nTFkVcLYHxbD8ONXFIM7F//jzf9KFuQo2t7V5t7GULTS+wscpG81eK2utusnTa9tjlRZQ2snx/Eyrs/qksBsFpt3yWgFq7HE213XQDeHsBLpKxxuCBw96nfSJIukItwRD7opt6Yy19d0+GDHkVxqQALwD+B4nwqRZvYH9Mjq+fieaguSH2iYNfHxuETvhnEimyNcdUizoAp9WcG/pgDSsc1pPgj9QnTF4fRvYJmioRWM1jyO6vsR4cRrFHvyOThdxNEqST+2RlFcLX4v507D1be2C6yhJ4P4ok8QeYUbaX6t8cADvWBeKlPYhnzltYWovqmc+q5PWYUPWT6WVmHU3uYrem1yi4cGBoSuEWlm/SYZ7e/S/9jxetMSRzuMyofONL+L8QxTfHoq/Hmzznzc7sNehZ9MPcvjTZXIxfEvLtuXwv7aD4OyXJqNbrMS5br1f+BBq8FaqTCo8q9h2NtzbOxsQbxdxtL+JfYc6R68nZ8TEGZm09YHhzBzEhDQ+uZ7mV+QmGqPN9VjA3Si7jgn7LSY8WmfCS8UZKHzP+0ifo/rbzrQ5vPPDE6mXOcuKt8ci6StxedSabPO7n6TFpDTSzaOD46vosisK2fXlB8eni1OyWdxUUwCr0JYpFm4aHUT9RjzLormgIBT1wEJby6EVKqUEkTXgSRSyfzHoEby+2mYjUHVNfSy7d21inZhINbmp3emSO4e0gn6RWjxaauFC/huSGg5L0KwVR5IkZ4oiJYCLwgFWq++XUcCvq+Wt4nObQm5rEbcoaujJlbBYFRVrBbpW1fqG0NXmyNXgUTNm5KNCHOip4zybQjc1L6pgTB2LaYRXGtGVZcCkFS/hEEgjAnK83B51sKGKNQwYpB/u7zOa/cWAYd+HTxhR3X+8OG2Bi1HUBhA57L0Kg/0yVKcN6uyQiv9DSEUbqAiWd9txrwSsdpRb3uqqs7rVcdzoN4YBN/sIobBpgG42JoMteVu7cEGabKxZ7YXNWV9LpgOJ1eZaVAWzROf1reBOp8HJulWnU+suLw1k3L8pDRR6hmZc+qvG4wwv+a40NcOcy5YIPoqcXIBsDgS5TNgd5KwekdWARiIKMZKZpBOXqukgl8tD2/bo8ncVA7hnfFrRBWZ0UJPI6lwwYFLbrzNtzukZFHpNBEaUbkWOCKqpUIkHLfwZEpNMkr+zvIxtnSGqpadNK2dIGHOhxIS3SdwUO0gxI61hwegRJUVanZVe2J2QmTY+S4AnRKJvmYlfXxZUxKEhUrUGpyRfFwG6snRdnq7s8jKHB1FGhCQXRIskT9ZpKFWm6e0SQpHLjDKhyN4hNaDHLRqpuTNCWTJTQ2JCWIOaYQFVQht8xncWaYVfSXXub3d34biWq/c4stJhO698dY88aLf5RrpvyxG9zqGtdNrMl60n0k3LER/0zU7qH76nb8IDPtA4xm+fwXbofU/bf/72JZuID+Djz/8Br1AYBVM989KalAazef1WkH+Jhlfes6228Bi3JF1JHE+88AUVX3Hw/VQ4BiBeI7/G47eUz2z6Bh0chYgQ/BO0ftJFe7r1YjDXFwQKKoW0NMLMW8EmOjhqfIdADoYxhBMe7Ak++rIFp9udtA2Wk6gZfEsDJuU9sTpkFUNZpO0PocZyu/FhUxenRoxd24Un09QfdEaXzgtwdTekooaZWhjtPBpapOOKaI4LnunxmB0D6uZWlIN/Y6lFfGN87jVgh05X+DTd+glgchiw1lQh11yaZTgvEOi5fUZm2GbKlsCvBe9pcIJji1FrfL2R0WsrRRMuylEmk9UJ9+B5kiAj3iEdPty0ooTiOkvyQUzJ9hJn9JX+FgWtEv3qwWGgn7O//fHugM5sx0/HLC0Sbxf+HnxHzQZKV5mtv4eqa8uXsGpzocp8panq0gW4aRlRkwYD1BTFq4Z/+5Rj4I94x8u73NSFDJv4uFIG0L4mc3dl4lOS2G5hpzGYD6KQG0FnesbIvhkformQSQUSbNGjfa7cj+Iokwkqiw2n8vk3b1/BxcPeXhQ33KlbqNT+q5dfff368GsihpbAM2zQ2+vtMUymrcuFaox0SPv30DsCK5l5taO9e3Rt9+ja7tG13aNru0fXdo+u7R5d2z26tnt0bffo2u7Rtd2ja7tH13aPru0eXds9urZ7dG336Nru0bXdo2u7R9d2j67tHl3bPbq2e3Rt9+ja7tG13aNru0fXdo+u/XZaYvfo2u7Rtd2ja7tH17bso92ja7/5o2vhagAR0i8yIVXjJpW/unK8fIrtNI6mdKvl4Di6uqIMkneUaU6ffyzR0JWY0zi6EEZShI0vxMTVLQ66hnCOlNT/lQ/xdo9o5NhbhZyOtXIPiK6h+BY+Oe7aus2LN2/fHB5RynZ4GCLXKbUxYkbZ3GLm88yD4PH9DMFv3WRCTUq+FRH5PuniCaWRtm+tnPOtlfBH43IFXclYUti+zuKnQf/SpDY2uLryN2L4EoSv74u2tgiMrWrTyp0uFov/AQ0M2hQ=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},x=void 0,y={},b=[];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)(u.default,{as:"h1",className:"openapi__heading",children:"Self Sign"}),"\n",(0,s.jsx)(a(),{method:"post",path:"/selfsign",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Unique identifier for this widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Specify the hint for widgets. This parameter is optional and is not applicable to the following widgets: checkbox, radio button, dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options":{\n "hint": "Provide signature"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp",\n "hint": "Provide stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials",\n "hint": "Provide initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide email",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide name",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide job title",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide company",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12,\n "min_date": "",\n "max_date": "",\n "signing_date": false,\n "hint": "Provide date"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"min_date:"})," Provide the minimum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"max_date:"})," Provide the maximum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"signing_date"}),": If signing_date is set to true, the signing date is shown to the signer during signing. You may set either signing_date or default, but not both. Using both is not supported."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image",\n "hint": "Provide image"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "default": 0,\n "formula": "",\n "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hint": "Provide number",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,s.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"decimalplaces:"})," Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"cells"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "cells",\n "page": 1,\n "x": 100,\n "y": 100,\n "w": 114,\n "h": 50,\n "options": {\n "name": "cells",\n "required": true,\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"cell_count:"})," Specify the number of cells that should be returned to the user."]}),"\n"]}),"\n",(0,s.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(g.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(c(),{...t(25816)}),"\n",(0,s.jsx)(m(),{...t(40402)})]})}function w(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(j,{...e})}):j(e)}},25816(e){e.exports=JSON.parse('{"title":"Body","body":{"content":{"application/json":{"schema":{"required":["file","signers","title"],"type":"object","properties":{"file":{"type":"string","format":"base64","example":"base64 encoded pdf"},"file_password":{"type":"string","format":"string","example":""},"title":{"type":"string","format":"string","example":"sample document"},"note":{"type":"string","format":"string","example":"sample Note"},"description":{"type":"string","format":"string","example":"sample Description"},"timeToCompleteDays":{"type":"number","description":"time to complete days is used to calculate expiry date of your document","format":"number","example":15},"signer":{"type":"object","properties":{"role":{"type":"string","format":"string","example":"ceo"},"email":{"type":"string","format":"string","example":"joebee@example.com"},"name":{"type":"string","format":"string","example":"joe bee"},"phone":{"type":"string","format":"string","example":"123121312"},"company":{"type":"string","format":"string","example":"opensign"},"job_title":{"type":"string","format":"string","example":"dev"},"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Allowed values - signature, stamp.","format":"string","example":"signature"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":244},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":71},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":38},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":46}},"title":"createtemplate_body_widgets"}}},"title":"selfsigndocument_body_signer"},"folderId":{"type":"string","example":""},"send_email":{"type":"boolean","description":"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \\"true\\". If the value of this parameter is \\"true\\" and no \'email_subject\'/\'email_body\' parameters are specified default email templates will be used. \\n","example":true},"email_subject":{"type":"string","description":"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.","example":"{{sender_name}} has requested you to sign {{document_title}}"},"email_body":{"type":"string","description":"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.","example":"

Hi {{receiver_name}},

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

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

Sign here

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

Thanks,
Team OpenSign\u2122

"},"enableTour":{"type":"boolean","description":"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.","example":false},"redirect_url":{"type":"string","description":"Specifies the URL where the signer will be redirected upon completing the document signing process.","example":""},"sender_name":{"type":"string","description":"The name of the person or organization on whose behalf the email is being sent.","example":"opensign\u2122"},"sender_email":{"type":"string","description":"The email address of the person or organization that users can reply to.","example":"mailer@opensignlabs.com"},"merge_certificate":{"type":"boolean","description":"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\\n\\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\\n\\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\\n","example":false},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed.\\n"}},"title":"selfsigndocument_body"}}},"required":true}}')},40402(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Document created successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"hji2zxcv2P"},"url":{"type":"string","format":"string","example":"https://url-to-sign-document.com"}},"title":"inline_response_200_1"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/d5380080.64c97fde.js b/assets/js/d5380080.64c97fde.js deleted file mode 100644 index 19f18eaf9..000000000 --- a/assets/js/d5380080.64c97fde.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[603],{62727(e,n,t){t.r(n),t.d(n,{assets:()=>j,contentTitle:()=>k,default:()=>M,frontMatter:()=>N,metadata:()=>i,toc:()=>v});const i=JSON.parse('{"id":"API-docs/v1.2/save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.","source":"@site/docs/API-docs/v1.2/save-update-webhook.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/save-update-webhook","permalink":"/docs/API-docs/v1.2/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":"eJztGdtuG7fyV6YM0NMs1pKdpsCB+lI31XGF4xssGcGBZTjU7kjLmktuSa5kQRDQh/MH5+m89tPyJcWQu6uLE+VWBEGgF1tLzgznxuFcFszxiWWdG/YSR5nW9+w2ZinaxIjCCa1Yhw0yBMunCNpAWaTcIVSwcHzZAy6lnlmY6xKcDoAcZhXA9dUpzDKRZCAslBZTgnFGTCZoAKeonG0N1VA9efIEuv6zQ59RdNSCqcAZpp0oGqoDeJmhAg5WTBQav2WBQ6qTMkflYnCZsIEgzISU9RmtoXr16tVQLYYKYMg8wJB1YMgC9SGLw46bFxg2frl4cX3WPR/cDf5z2W329eg3TFwv3YLp/dJAjIXcpnB9ddpsK55vb58fn60OUNpV+5cSuUUwSCwCV6mXOkhYC9ygrZkqYDc7QVWWVm9oBWAR/m1y0++dnHev1nkJEJhzITdAumfHvdMNmCLTapPM5a8X590hCyBL+ndbsRP0/fP8rSRrkOPKQIPeWbc/OD67bPYTg9y9EWColpWhyXeetaAC3XSeWnnkixXARzhOhbn3nM/lOe9j9l02BpcZXU4ycBlCavjYgcO8kBTIji97exf4wlxgDaY0a1R65ydBKR/pIxQavm+FJ2RHZAj7MJo3z81HeEgg8tU7CC1WjvEut3i3U7wjKizXT/4bXonnLUh0Xkjc+U6seYOUlT/YjwkZ9VFfvU98Oe8GGifGIuG1mC+6V4Pev3ovjgfdDUU1tvl0p/qhBSkmUuyMMDXEJ8aYmszeoz6XR9Ua35nF1kCf5kwsZrpAw0kpvZR1GBVW34byq67UYmbw9xKt+1mnc9ZZbNVtl0ZPRYpQGklVVzgVVsiJVg6VI0ReFJIuitCq/Zsl7AWzSYY5p190ijCYUpV4bSRViORqrFN5FItZYYhbJ9ASQmkk/auArDNCTVjMxtrk3K2v4AOnq8c6LHOusJ12e65Lc1BVjwelkT9VIK1E52y5jJkTziNUMHcjkn25pC2DttDKBh6eHR4+Vkm/TBK0dlxKaLT7IZrYLbZBW0r3JslXctaVc7BkCrbhSM6/2RBQKHKju1qou2eHh3f/rCR9/kbhdI4uE2oCMx9EjFaTGIpwE52ZA59woYDyXvPN3yc1GqPNbqE/jLNdSnh+eHh31Cjh6LESGv0aCVwa5Okc8EFYZz+vyLv42C3g0d2sEfD5YwGvLRpQ2sFYlyr9vEJtn71bkOeNGD88FqOnplyK1HeQBvoe1eeVZP14F44nVh9yH7joZfEieSC/zzZEXV8PQlpMSiPcnHVuFuzhgBfiIOx3bm6XtzGjC6Apjhfaeo65y1iHtWdNOLZopmisJ+ADaBMTLVfpSD+0dIGKXkTJR5biYZsXoj09aj1jy3gbhxfFB8FjefChKNbxiVCTd+HdrpTTJwMGG22oqLEUL8S/cc7i2gLrUDET5DgZ8hSNtxb5xdXqBezW1t1mdPebQnTH2jNR2feiQNWndIW8wwux3RJ9iTLROfpmZoYQRTXK6//+2WBFUZPqeD/2jc6L0kChZ2joDaK8aCzxQYykb0UA5n5v1U1Fnku0Vs5BKIcTQy94KibC8VCMUExNeMFHQgpyfwLThG1g7QbZFqWhLkNDW/8w1KFNcYqSbg3w0umcOyLVZKkzbe7H1NeNgcOotEKhtYAq4yohwNqiMTWFuQJUDk1hhEWwzhDXIvCmlTM8cZBzxScYerXrykpRCnJ7MHpUWgdWy9KzDI4LqU3oGHuBFGIausXdh4K2gFYpeTeYkftNESalSNHGkOiUmtZkZRJBpTBC66AgXkSCloiWSurk3huQnl8oNAUfwSXo8QaPhO4MV5YSmMBLbYNGYYXR9I5jYDCKri2ShU+FurdVJXDT+NVLHFnh8Pa72kNns9mjK/R0E+dEuF/LEVxhoa1w2sxX2BPhsnLkr906keYjUDpBhd5/1i7VikaqE/v4FtNqO0NZtPvoyENs+/iy5+P1U3j9x//gFLlRkOlZ8NakNCjnMKmPIs0Fywe1NeEWxto7XkYaT4LzVclsrcGXGXev//i/hXOcgVDVlSJRougEHQzqHt63sPF5KqyLog4YzPUUUyiVQjINN3MouOE5OvI3X5MgLVAaVhgcU9GVcsdhbHReTxpWGC06OpRIdwW3dqZNOmQrAOBpiilxWmXadZMxrqcmq4UKYnXdhMvWtkOTstkNrMpxqKGMLl1w4KJK8GtuvFILox0mXqZ0XDPtZzR3ejz2bzSReS/O/clbzK+d76nSVMf4T1Sc4pim22HDz3BgE6mIP5ehMA21msGg7Tujqf58E2d0S6tqEMKzT7d0U1GP9PpORT+yFAlclCMpkm2BW3CcJFiQYqdclmg7EEWBoyiC71Ic81K6pzFEkZ9jmCii37wgK9FXC/oV/zkFuswPyhxQEuxAV1rirjQIM5FO0P0YJmAbCEpXm/ZHqElbyPm8oqfm9b4XVZeu6jAEwlUlR6po+Rpz6xnefOUMjtGQ7rx5V5e6ENUlvqmDAVCM+JRgQs8wvRU88dmfL9xDPvDTNh2fiaHJ7cW4j2Yqkrp8fEscbXvgNouZFAkqi2sZ3vHJ5SlMv28dsngtZ3iPkNo+7b3onve7xAyZICjsqHXYOqQlSvJyrtZO6lcD1OuNAep2YrFYpcD7seu+ZbUfu+5nbvux694F9mPX/dh1P3bdj12/vKCxH7vuPeorG7tWrWiHD65dSC5867+aaIau/U09fKRJaEb9/M4NWyxG3OK1kcslLf9eoqFhwG3MptwIaof4UUBcN7CpzX+Pc9ZhL0LJdzCggwlclqEXvjUBoQ58wAidiJ2w6yOHy4v+gMVsVE2Jc50SjuEzmiDzGeswP232bVc/x6S1BZNcTUo+IdhAk3ru1LPbbNjf+4Z99YOkqrfUfI3DzU5+EIP+klBvRFgswjBguWzgw9ZbMSrF1tBkuNvlcvkXUcCkew==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Webhook","permalink":"/docs/API-docs/v1.2/get-webhook"},"next":{"title":"Delete Webhook","permalink":"/docs/API-docs/v1.2/delete-webhook"}}');var s=t(74848),o=t(28453),r=t(57742),d=t.n(r),c=t(78178),l=t.n(c),a=t(19624),p=t.n(a),h=t(96226),E=t.n(h),u=(t(77675),t(19365),t(51107)),g=t(21312);const N={id:"save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.",sidebar_label:"Save or Update Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJztGdtuG7fyV6YM0NMs1pKdpsCB+lI31XGF4xssGcGBZTjU7kjLmktuSa5kQRDQh/MH5+m89tPyJcWQu6uLE+VWBEGgF1tLzgznxuFcFszxiWWdG/YSR5nW9+w2ZinaxIjCCa1Yhw0yBMunCNpAWaTcIVSwcHzZAy6lnlmY6xKcDoAcZhXA9dUpzDKRZCAslBZTgnFGTCZoAKeonG0N1VA9efIEuv6zQ59RdNSCqcAZpp0oGqoDeJmhAg5WTBQav2WBQ6qTMkflYnCZsIEgzISU9RmtoXr16tVQLYYKYMg8wJB1YMgC9SGLw46bFxg2frl4cX3WPR/cDf5z2W329eg3TFwv3YLp/dJAjIXcpnB9ddpsK55vb58fn60OUNpV+5cSuUUwSCwCV6mXOkhYC9ygrZkqYDc7QVWWVm9oBWAR/m1y0++dnHev1nkJEJhzITdAumfHvdMNmCLTapPM5a8X590hCyBL+ndbsRP0/fP8rSRrkOPKQIPeWbc/OD67bPYTg9y9EWColpWhyXeetaAC3XSeWnnkixXARzhOhbn3nM/lOe9j9l02BpcZXU4ycBlCavjYgcO8kBTIji97exf4wlxgDaY0a1R65ydBKR/pIxQavm+FJ2RHZAj7MJo3z81HeEgg8tU7CC1WjvEut3i3U7wjKizXT/4bXonnLUh0Xkjc+U6seYOUlT/YjwkZ9VFfvU98Oe8GGifGIuG1mC+6V4Pev3ovjgfdDUU1tvl0p/qhBSkmUuyMMDXEJ8aYmszeoz6XR9Ua35nF1kCf5kwsZrpAw0kpvZR1GBVW34byq67UYmbw9xKt+1mnc9ZZbNVtl0ZPRYpQGklVVzgVVsiJVg6VI0ReFJIuitCq/Zsl7AWzSYY5p190ijCYUpV4bSRViORqrFN5FItZYYhbJ9ASQmkk/auArDNCTVjMxtrk3K2v4AOnq8c6LHOusJ12e65Lc1BVjwelkT9VIK1E52y5jJkTziNUMHcjkn25pC2DttDKBh6eHR4+Vkm/TBK0dlxKaLT7IZrYLbZBW0r3JslXctaVc7BkCrbhSM6/2RBQKHKju1qou2eHh3f/rCR9/kbhdI4uE2oCMx9EjFaTGIpwE52ZA59woYDyXvPN3yc1GqPNbqE/jLNdSnh+eHh31Cjh6LESGv0aCVwa5Okc8EFYZz+vyLv42C3g0d2sEfD5YwGvLRpQ2sFYlyr9vEJtn71bkOeNGD88FqOnplyK1HeQBvoe1eeVZP14F44nVh9yH7joZfEieSC/zzZEXV8PQlpMSiPcnHVuFuzhgBfiIOx3bm6XtzGjC6Apjhfaeo65y1iHtWdNOLZopmisJ+ADaBMTLVfpSD+0dIGKXkTJR5biYZsXoj09aj1jy3gbhxfFB8FjefChKNbxiVCTd+HdrpTTJwMGG22oqLEUL8S/cc7i2gLrUDET5DgZ8hSNtxb5xdXqBezW1t1mdPebQnTH2jNR2feiQNWndIW8wwux3RJ9iTLROfpmZoYQRTXK6//+2WBFUZPqeD/2jc6L0kChZ2joDaK8aCzxQYykb0UA5n5v1U1Fnku0Vs5BKIcTQy94KibC8VCMUExNeMFHQgpyfwLThG1g7QbZFqWhLkNDW/8w1KFNcYqSbg3w0umcOyLVZKkzbe7H1NeNgcOotEKhtYAq4yohwNqiMTWFuQJUDk1hhEWwzhDXIvCmlTM8cZBzxScYerXrykpRCnJ7MHpUWgdWy9KzDI4LqU3oGHuBFGIausXdh4K2gFYpeTeYkftNESalSNHGkOiUmtZkZRJBpTBC66AgXkSCloiWSurk3huQnl8oNAUfwSXo8QaPhO4MV5YSmMBLbYNGYYXR9I5jYDCKri2ShU+FurdVJXDT+NVLHFnh8Pa72kNns9mjK/R0E+dEuF/LEVxhoa1w2sxX2BPhsnLkr906keYjUDpBhd5/1i7VikaqE/v4FtNqO0NZtPvoyENs+/iy5+P1U3j9x//gFLlRkOlZ8NakNCjnMKmPIs0Fywe1NeEWxto7XkYaT4LzVclsrcGXGXev//i/hXOcgVDVlSJRougEHQzqHt63sPF5KqyLog4YzPUUUyiVQjINN3MouOE5OvI3X5MgLVAaVhgcU9GVcsdhbHReTxpWGC06OpRIdwW3dqZNOmQrAOBpiilxWmXadZMxrqcmq4UKYnXdhMvWtkOTstkNrMpxqKGMLl1w4KJK8GtuvFILox0mXqZ0XDPtZzR3ejz2bzSReS/O/clbzK+d76nSVMf4T1Sc4pim22HDz3BgE6mIP5ehMA21msGg7Tujqf58E2d0S6tqEMKzT7d0U1GP9PpORT+yFAlclCMpkm2BW3CcJFiQYqdclmg7EEWBoyiC71Ic81K6pzFEkZ9jmCii37wgK9FXC/oV/zkFuswPyhxQEuxAV1rirjQIM5FO0P0YJmAbCEpXm/ZHqElbyPm8oqfm9b4XVZeu6jAEwlUlR6po+Rpz6xnefOUMjtGQ7rx5V5e6ENUlvqmDAVCM+JRgQs8wvRU88dmfL9xDPvDTNh2fiaHJ7cW4j2Yqkrp8fEscbXvgNouZFAkqi2sZ3vHJ5SlMv28dsngtZ3iPkNo+7b3onve7xAyZICjsqHXYOqQlSvJyrtZO6lcD1OuNAep2YrFYpcD7seu+ZbUfu+5nbvux694F9mPX/dh1P3bdj12/vKCxH7vuPeorG7tWrWiHD65dSC5867+aaIau/U09fKRJaEb9/M4NWyxG3OK1kcslLf9eoqFhwG3MptwIaof4UUBcN7CpzX+Pc9ZhL0LJdzCggwlclqEXvjUBoQ58wAidiJ2w6yOHy4v+gMVsVE2Jc50SjuEzmiDzGeswP232bVc/x6S1BZNcTUo+IdhAk3ru1LPbbNjf+4Z99YOkqrfUfI3DzU5+EIP+klBvRFgswjBguWzgw9ZbMSrF1tBkuNvlcvkXUcCkew==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},k=void 0,j={},v=[{value:"Events:",id:"events",level:3}];function m(e){const n={code:"code",h3:"h3",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Save or Update Webhook"}),"\n",(0,s.jsx)(d(),{method:"post",path:"/webhook",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The save or update Webhook API allows you to save a webhook URL which is used to trigger events."}),"\n",(0,s.jsx)(n.h3,{id:"events",children:"Events:"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"1. viewed:"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"When a signer views a document, this event will trigger."}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "event": "viewed",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "viewedBy": "SIGNER_EMAIL",\n "viewedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"2. created:"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"When a document is created, this event will trigger."}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"When a document is created through the draft template API, this event will trigger."}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE",\n "url": "SIGNING_URL"\n }\n ],\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"3. signed:"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"When a document is signed by a signer, this event will trigger."}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "event": "signed",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signer": {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n },\n "signedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"4. completed:"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"When a document is signed by all signers, this event will trigger."}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "event": "completed",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "certificate": "CERTIFICATE_URL",\n "completedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"5. declined:"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"When a document is declined by a signer, this event will trigger."}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "event": "declined",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "declinedBy": "SIGNER_EMAIL",\n "declinedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,s.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(g.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(l(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{...t(93764)}),"\n",(0,s.jsx)(E(),{...t(1790)})]})}function M(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(m,{...e})}):m(e)}},93764(e){e.exports=JSON.parse('{"title":"Body","body":{"description":"Provide url to create Webhook","content":{"application/json":{"schema":{"required":["Url"],"type":"object","properties":{"url":{"type":"string","format":"string","example":"https://your-webhook-url@example.com"}},"title":"webhook_body"}}}}}')},1790(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Webhook updated successfully!"}},"title":"inline_response_200_8"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"401":{"description":"Webhook url already exists!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Webhook url already exists!"}},"title":"inline_response_401_w"}}}},"404":{"description":"User not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"User not found!"}},"title":"inline_response_404"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/d5380080.93a2f541.js b/assets/js/d5380080.93a2f541.js new file mode 100644 index 000000000..a7c89e75d --- /dev/null +++ b/assets/js/d5380080.93a2f541.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[603],{62727(e,n,t){t.r(n),t.d(n,{assets:()=>b,contentTitle:()=>S,default:()=>j,frontMatter:()=>M,metadata:()=>o,toc:()=>E});const o=JSON.parse('{"id":"API-docs/v1.2/save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.","source":"@site/docs/API-docs/v1.2/save-update-webhook.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/save-update-webhook","permalink":"/docs/API-docs/v1.2/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":"eJztGttuG8f1V07WQGARvEiJAxRMkUamaUeoLROiVKMQBXG4e8idajizmZklRUgE8lD0A4q+9LU/0fd+ir+kOHNZXuTQsR0YQcAHW9LOmTPnNuc25y6xbGKS9mXyBke5UjfJVT3J0KSaF5YrmbST8xzBsBmC0lAWGbMIARaOeyfAhFBzAwtVglUekME8AFycvYR5ztMcuIHSYEYwVvPJBDXgDKU1zYEcyEePHkHX/dmmP2u1oybMOM4xa9dqA9mANzlKYGD4RKJ2SwYYZCotpyhtHWzOjUcIcy5EPKM5kMPhcCDvBhJgkDiAQdKGQeKxD5K6X7GLAv3Cs9edi1fd0/Pr87/2utW6Gv0NU3uSbcGcPKsgxlxsY7g4e1ktSzbdXj49frU6QCob1nsCmUHQSCQCk5nj2nMYGa62ranK765WvKgMfb2kLwB3/scmNf2TF6fds3VaPAROGRcbIN1XxycvN2CKXMlNNL0fXp92B4kHWdKPq0COl/fTxc+ijCDHQUHnJ6+6/fPjV71qPdXI7DsBBnIZFE2281UTAuim8UThkS0GgI8wnLBzbzmfy3J+idp36RhsrlU5ycHmCJlmYwsWp4UgR3bcO9mbwG/MBNZgSr2G5eT0hRfKR9oIuYavmz6E7PAMfh1GiyrcfISFeCS/ewOhj8Ew3mcW7zeK93iF5frJv0KUeNKEVE0LgTvjxJo1CBHswXyMy4hH/e5t4rcTN1BbPuYpi2x2umfnJ89POsfn3Q1BVbr5dKP6pgkZpoLv9DAR4hN9TESzt6jPZVFR4juz2Aj0acaU1BNVoGYklJMsaSdUWH3py69YqdUTjT+WaOxTlS2S9t1W3dbTasYzhFILqrr8qbDanCppUVrayIpC0EXhSrb+Zmj3XWLSHKeMfqNTuMaMqsQLLahCJFNL2sGiknpSaKLWcjS0odSCfgQgYzWXk6SejJWeMrv+BW8ZXb2kneTWFqbdai1UqRuhemyUWnwfQJqpmibLZT2x3LoNAeZ6RLwvl7Sk0RRKGk/DV4eHD0XSL9MUjRmXAirpfogkdrOt0ZTCvovzFZ+xcvaazMBUFInFFxsMcklmdB2Zuv7q8PD6D4HTJ+9kTk3R5lxOYO6ciFZyUofC30SrF8AmjEugvFd/8etxjVorvZvpD6NslxCeHB5eH1VCOHoohEq+WgATGlm2ALzlxprPy/IuOnYzeHQ9rxh88pDBC4MapLIwVqXMPi9T22fvZuRJxcY3D9k4kTMmeOY6SOfqBuXn5WT9eOuPJ1Jvp85xUWRxLDkgt55ssLr+3TNpMC01t4ukfXmX3DZYwRt+vX15tbyqJ3QBFPnxQhlHMbN50k5a88odG9Qz1MYhcA608omGyWykbpuqQEkRUbCRIX/YYgVvzY6aXyXL+vYeVhQfBI9l40O3GMsmXE7et+9qJZw+KdDraENElaZYwf+Mi6QeNbAOVU84GU6OLEPttEV2cbaKgN2o3W1Cd8cUwjtWjoig39cFyj6lK2QdjontlugjiDBv//6fCoxSwO+gVqOGKQmkYVSpU4RnKi0dPiYsasksnyG8/elfMCq5oMukIcMZCrJhqi10aazPDlFa1IXmBk2T0smBXD93wmfoG6+sKmXqUGiVlSkR2ghup0GaYbbUCNT1oDBc9UQo/5QTgXU46/bPKTAe906a0EeZVYmacSRWSOowZZJNsOqiOJpZeuNAyMsby2xpgEvQyARYPsW6SwJZadWUshBSCXHHNa5SY8HHmC5S4YVD9dac21yVFmYoM6VBqPSmwaXrGDcaDd84hhdoLZ3at0xTgSUHsjtDvYCQHcG0NBZSpvXCn1tdeqKQmkLDNTsbgrcwd4hLxdYW2/BHZ0zVh+/Wcv+3//gnXP6g5pRsTVBSeoFbB149jjaZqdQ8vDX0tZWjKFp9z5RpHfdOnH888Po/VRYMaXKeo0Y6aoQTLv8EFxRKc4RaLbgLQDnjWkkSba0Gj4e/2J0MDwhvoZVVdC8rLbDxGFMnakEWnDHLtlTRURqhwwo24oKTO6bv99BhFidKL+Ae3uTMOpNNmYRMwf1A3jcaDfePQGu1Z9HqajW4h47LWutgUGb1kDXVqa5QN8GmMiS7X5lnI6p9Zb4B83m0V4f5aclFBhpLw0ZizZgdu1BobBSCpZjBnGcTtOZbRwNJRkn3FjJlchE7AvGIPopxg+6nO+JFtAJDn0MrYUVWJdf4rMHljFsX82As1Dwi7ZUjwVPYJL+fM00vLYVfjFdPcHnjro9UEavgxkLM4SPOZ64P+kbpGzrJY6SnmxV1Sq/JhBnfOTVO5GMumeDe4KY+bYt4O0palgblvfJ+wt2BQEzq12FEyVGh1USz6ZRZnjIhFhHJcyUy1B7Haz1hks5aUcalobqmctPPNJnj2G+KOEIC5pGcYYoEQ+6oQe4oFNpShQ4BV9KAt0wNai4BZVYoLm1ER6lPxGU1R3rlSlNVSuskkmrMuAWKJFTjkAbvN68GGf7bn/5t4BTn5HdiwKCXr45ARsKJGo5nMDGQwxfdc2hFTbTaPBu6Eze/k46HkJMGR4gSjNXIpr7LQNagMStlxqSFgmk2RUuSIgPSOFUzzBzKWq3QOKbeA11t6lRINQeNttSExyDttSgWMNZqGjW6QlirUWi4ITOsSjFAZjhqV4AqacopVu99PWbMXOms0dPKYkohr/fsOfTLolDaDiStw9A3Ja6LADxIhtFrx3tOFSC5Qwlzpd3p7gajTPWiCFhNM+LFDJRsD+Sw97p/Di1fFUcxDuF//4Vh7+KBxN3ntQ3RGFvtCHe9CeZuS4R6sLB1nlsgH0EiHUb5vB6PSYHQD1ebrpZWYiD7aEku7uH1Wnmoa9pK/QSrS4R7GDNhcAhKws8w6mzoHZxaBXhLuTe3ghIQ5xwpQ+HeT4bzKodDqQGyNK+cRaXfvrePMyUoDlBSNAzecgg+c3f2xdIUC3IsxJMHuNaK+lBDGHMUGbBUK2NcQuC4oNulVWnRNOE814hA8N6eTdRy24ceOp2cPeZsxulybwecQNMQao8zHLNS2APnulzOEJIq8gxUrFrn+lfZlI8M3kUM3eulHq68jfEPTjG7IUGFfpiSYhGddIgu/hk9+uchKwqtZh5dh0l/syneRHC8JamF0OGpCS7eHXZfuRamR0pCRxULeNzpHBBxvODkRwfyGCTOSexpupJ2uPaVIIEJJSfO4xI/roglxQ8HyWh9n5Lrz/HBGOrhwc11AGMQrLTYCuMEUZld6tcByzKNhnwHeTXM6L5XNOrgyRkldCMlGylxtu7HwXX9QMkUNxVAL4Kx09uEl/wGVzzUifwNauCxKdOcAp+/Jasbz7PhAYWuGc+CHDxppC/Ns6D36olxxkSJdRdwvJciyQpOgqVoCjgt7AKY1mwBj4eXV8ODb0FNuXVYvGitAi5z1OHjJuqtFOx4xrhwN7W7yv9CHrb2he4EdV9oQONhDtb3KaKLdx+QN1YJS1WCbGLYWSlWu7sXcIaTB5vfV6EOtyPuX1AbrpyT+hKesvRmznRmoKOmBbPcZagLAqXNZByuBwejCNhIA6DwGTDMjpwZz46aR1WBEtME40OizZVBmPmDvUNilT5U6H+PotwdVqlgpNFHzTRnckIXgXKEtUDNyfFnZervgqOXUCtXjjIBpRRoDCibo55TrkSN+GzLMC4MUnn3kssbZw4NuKwyqDc4MtziqjyZz+cPJH3g9jwvhYCYo7sL956ixm97we0P5QjOsFCGW6UXq10TbvNy5HS5vrf6IyCIuXTVMfqUYsqhPEc9NaDG0Ec94+l72G9ZAm8duN78VvtiszugcYya/I7ZKAVZwUPZeRnpACLvU/ig9kVIqV3ni1yf76N8v43HdbCIhdfjwG9okezmN6kngqcoDa51xo5f9F7C7OvmYVJf67X8Al22Xp50uqf9LhETrknSTo6ah81D+kTNsSmTayf1w+DZxcbg2XZD5m7VOtyPq+2f+vbjavtZpf242t4E9uNq+3G1/bjaflztt+c09uNqe4v6nY2rhSd8i7e2VQjG3chEmATz0w6XcWiLJshymoNoXyZ3d9QPudBiuaTPP5aoaYjiqp7MmObUOHEjFPX48E/jETe4SNpJx5d8jXM6mMBF6WcItiZHaHLB7zh2readsOujGtQ4T+rJKEzXTVVGezSb0+QdmyftxE3puccjN/9F3+4SweSkZBOC9ThpVoGVJIH1QYcbN+gQfiGu4pJcrFG4OQHh2aD/ial3bri780MUy2UF75d+dkcQbIQmxV0tl8v/A3Tj7AI=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Webhook","permalink":"/docs/API-docs/v1.2/get-webhook"},"next":{"title":"Delete Webhook","permalink":"/docs/API-docs/v1.2/delete-webhook"}}');var i=t(74848),s=t(28453),a=t(57742),r=t.n(a),d=t(78178),c=t.n(d),l=t(19624),p=t.n(l),h=t(96226),N=t.n(h),u=(t(77675),t(19365),t(51107)),m=t(21312);const M={id:"save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.",sidebar_label:"Save or Update Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJztGttuG8f1V07WQGARvEiJAxRMkUamaUeoLROiVKMQBXG4e8idajizmZklRUgE8lD0A4q+9LU/0fd+ir+kOHNZXuTQsR0YQcAHW9LOmTPnNuc25y6xbGKS9mXyBke5UjfJVT3J0KSaF5YrmbST8xzBsBmC0lAWGbMIARaOeyfAhFBzAwtVglUekME8AFycvYR5ztMcuIHSYEYwVvPJBDXgDKU1zYEcyEePHkHX/dmmP2u1oybMOM4xa9dqA9mANzlKYGD4RKJ2SwYYZCotpyhtHWzOjUcIcy5EPKM5kMPhcCDvBhJgkDiAQdKGQeKxD5K6X7GLAv3Cs9edi1fd0/Pr87/2utW6Gv0NU3uSbcGcPKsgxlxsY7g4e1ktSzbdXj49frU6QCob1nsCmUHQSCQCk5nj2nMYGa62ranK765WvKgMfb2kLwB3/scmNf2TF6fds3VaPAROGRcbIN1XxycvN2CKXMlNNL0fXp92B4kHWdKPq0COl/fTxc+ijCDHQUHnJ6+6/fPjV71qPdXI7DsBBnIZFE2281UTAuim8UThkS0GgI8wnLBzbzmfy3J+idp36RhsrlU5ycHmCJlmYwsWp4UgR3bcO9mbwG/MBNZgSr2G5eT0hRfKR9oIuYavmz6E7PAMfh1GiyrcfISFeCS/ewOhj8Ew3mcW7zeK93iF5frJv0KUeNKEVE0LgTvjxJo1CBHswXyMy4hH/e5t4rcTN1BbPuYpi2x2umfnJ89POsfn3Q1BVbr5dKP6pgkZpoLv9DAR4hN9TESzt6jPZVFR4juz2Aj0acaU1BNVoGYklJMsaSdUWH3py69YqdUTjT+WaOxTlS2S9t1W3dbTasYzhFILqrr8qbDanCppUVrayIpC0EXhSrb+Zmj3XWLSHKeMfqNTuMaMqsQLLahCJFNL2sGiknpSaKLWcjS0odSCfgQgYzWXk6SejJWeMrv+BW8ZXb2kneTWFqbdai1UqRuhemyUWnwfQJqpmibLZT2x3LoNAeZ6RLwvl7Sk0RRKGk/DV4eHD0XSL9MUjRmXAirpfogkdrOt0ZTCvovzFZ+xcvaazMBUFInFFxsMcklmdB2Zuv7q8PD6D4HTJ+9kTk3R5lxOYO6ciFZyUofC30SrF8AmjEugvFd/8etxjVorvZvpD6NslxCeHB5eH1VCOHoohEq+WgATGlm2ALzlxprPy/IuOnYzeHQ9rxh88pDBC4MapLIwVqXMPi9T22fvZuRJxcY3D9k4kTMmeOY6SOfqBuXn5WT9eOuPJ1Jvp85xUWRxLDkgt55ssLr+3TNpMC01t4ukfXmX3DZYwRt+vX15tbyqJ3QBFPnxQhlHMbN50k5a88odG9Qz1MYhcA608omGyWykbpuqQEkRUbCRIX/YYgVvzY6aXyXL+vYeVhQfBI9l40O3GMsmXE7et+9qJZw+KdDraENElaZYwf+Mi6QeNbAOVU84GU6OLEPttEV2cbaKgN2o3W1Cd8cUwjtWjoig39cFyj6lK2QdjontlugjiDBv//6fCoxSwO+gVqOGKQmkYVSpU4RnKi0dPiYsasksnyG8/elfMCq5oMukIcMZCrJhqi10aazPDlFa1IXmBk2T0smBXD93wmfoG6+sKmXqUGiVlSkR2ghup0GaYbbUCNT1oDBc9UQo/5QTgXU46/bPKTAe906a0EeZVYmacSRWSOowZZJNsOqiOJpZeuNAyMsby2xpgEvQyARYPsW6SwJZadWUshBSCXHHNa5SY8HHmC5S4YVD9dac21yVFmYoM6VBqPSmwaXrGDcaDd84hhdoLZ3at0xTgSUHsjtDvYCQHcG0NBZSpvXCn1tdeqKQmkLDNTsbgrcwd4hLxdYW2/BHZ0zVh+/Wcv+3//gnXP6g5pRsTVBSeoFbB149jjaZqdQ8vDX0tZWjKFp9z5RpHfdOnH888Po/VRYMaXKeo0Y6aoQTLv8EFxRKc4RaLbgLQDnjWkkSba0Gj4e/2J0MDwhvoZVVdC8rLbDxGFMnakEWnDHLtlTRURqhwwo24oKTO6bv99BhFidKL+Ae3uTMOpNNmYRMwf1A3jcaDfePQGu1Z9HqajW4h47LWutgUGb1kDXVqa5QN8GmMiS7X5lnI6p9Zb4B83m0V4f5aclFBhpLw0ZizZgdu1BobBSCpZjBnGcTtOZbRwNJRkn3FjJlchE7AvGIPopxg+6nO+JFtAJDn0MrYUVWJdf4rMHljFsX82As1Dwi7ZUjwVPYJL+fM00vLYVfjFdPcHnjro9UEavgxkLM4SPOZ64P+kbpGzrJY6SnmxV1Sq/JhBnfOTVO5GMumeDe4KY+bYt4O0palgblvfJ+wt2BQEzq12FEyVGh1USz6ZRZnjIhFhHJcyUy1B7Haz1hks5aUcalobqmctPPNJnj2G+KOEIC5pGcYYoEQ+6oQe4oFNpShQ4BV9KAt0wNai4BZVYoLm1ER6lPxGU1R3rlSlNVSuskkmrMuAWKJFTjkAbvN68GGf7bn/5t4BTn5HdiwKCXr45ARsKJGo5nMDGQwxfdc2hFTbTaPBu6Eze/k46HkJMGR4gSjNXIpr7LQNagMStlxqSFgmk2RUuSIgPSOFUzzBzKWq3QOKbeA11t6lRINQeNttSExyDttSgWMNZqGjW6QlirUWi4ITOsSjFAZjhqV4AqacopVu99PWbMXOms0dPKYkohr/fsOfTLolDaDiStw9A3Ja6LADxIhtFrx3tOFSC5Qwlzpd3p7gajTPWiCFhNM+LFDJRsD+Sw97p/Di1fFUcxDuF//4Vh7+KBxN3ntQ3RGFvtCHe9CeZuS4R6sLB1nlsgH0EiHUb5vB6PSYHQD1ebrpZWYiD7aEku7uH1Wnmoa9pK/QSrS4R7GDNhcAhKws8w6mzoHZxaBXhLuTe3ghIQ5xwpQ+HeT4bzKodDqQGyNK+cRaXfvrePMyUoDlBSNAzecgg+c3f2xdIUC3IsxJMHuNaK+lBDGHMUGbBUK2NcQuC4oNulVWnRNOE814hA8N6eTdRy24ceOp2cPeZsxulybwecQNMQao8zHLNS2APnulzOEJIq8gxUrFrn+lfZlI8M3kUM3eulHq68jfEPTjG7IUGFfpiSYhGddIgu/hk9+uchKwqtZh5dh0l/syneRHC8JamF0OGpCS7eHXZfuRamR0pCRxULeNzpHBBxvODkRwfyGCTOSexpupJ2uPaVIIEJJSfO4xI/roglxQ8HyWh9n5Lrz/HBGOrhwc11AGMQrLTYCuMEUZld6tcByzKNhnwHeTXM6L5XNOrgyRkldCMlGylxtu7HwXX9QMkUNxVAL4Kx09uEl/wGVzzUifwNauCxKdOcAp+/Jasbz7PhAYWuGc+CHDxppC/Ns6D36olxxkSJdRdwvJciyQpOgqVoCjgt7AKY1mwBj4eXV8ODb0FNuXVYvGitAi5z1OHjJuqtFOx4xrhwN7W7yv9CHrb2he4EdV9oQONhDtb3KaKLdx+QN1YJS1WCbGLYWSlWu7sXcIaTB5vfV6EOtyPuX1AbrpyT+hKesvRmznRmoKOmBbPcZagLAqXNZByuBwejCNhIA6DwGTDMjpwZz46aR1WBEtME40OizZVBmPmDvUNilT5U6H+PotwdVqlgpNFHzTRnckIXgXKEtUDNyfFnZervgqOXUCtXjjIBpRRoDCibo55TrkSN+GzLMC4MUnn3kssbZw4NuKwyqDc4MtziqjyZz+cPJH3g9jwvhYCYo7sL956ixm97we0P5QjOsFCGW6UXq10TbvNy5HS5vrf6IyCIuXTVMfqUYsqhPEc9NaDG0Ec94+l72G9ZAm8duN78VvtiszugcYya/I7ZKAVZwUPZeRnpACLvU/ig9kVIqV3ni1yf76N8v43HdbCIhdfjwG9okezmN6kngqcoDa51xo5f9F7C7OvmYVJf67X8Al22Xp50uqf9LhETrknSTo6ah81D+kTNsSmTayf1w+DZxcbg2XZD5m7VOtyPq+2f+vbjavtZpf242t4E9uNq+3G1/bjaflztt+c09uNqe4v6nY2rhSd8i7e2VQjG3chEmATz0w6XcWiLJshymoNoXyZ3d9QPudBiuaTPP5aoaYjiqp7MmObUOHEjFPX48E/jETe4SNpJx5d8jXM6mMBF6WcItiZHaHLB7zh2readsOujGtQ4T+rJKEzXTVVGezSb0+QdmyftxE3puccjN/9F3+4SweSkZBOC9ThpVoGVJIH1QYcbN+gQfiGu4pJcrFG4OQHh2aD/ial3bri780MUy2UF75d+dkcQbIQmxV0tl8v/A3Tj7AI=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},S=void 0,b={},E=[{value:"Events:",id:"events",level:3}];function T(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)(u.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)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,i.jsx)(m.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,i.jsx)(c(),{parameters:void 0}),"\n",(0,i.jsx)(p(),{...t(93764)}),"\n",(0,i.jsx)(N(),{...t(1790)})]})}function j(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(T,{...e})}):T(e)}},93764(e){e.exports=JSON.parse('{"title":"Body","body":{"description":"Provide url to create Webhook","content":{"application/json":{"schema":{"required":["Url"],"type":"object","properties":{"url":{"type":"string","format":"string","example":"https://your-webhook-url@example.com"}},"title":"webhook_body"}}}}}')},1790(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Webhook updated successfully!"}},"title":"inline_response_200_8"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"401":{"description":"Webhook url already exists!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Webhook url already exists!"}},"title":"inline_response_401_w"}}}},"404":{"description":"User not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"User not found!"}},"title":"inline_response_404"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/ec5e470a.2e07c8be.js b/assets/js/ec5e470a.2e07c8be.js deleted file mode 100644 index bf8b257b3..000000000 --- a/assets/js/ec5e470a.2e07c8be.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[2923],{56483(e,t,o){o.r(t),o.d(t,{assets:()=>L,contentTitle:()=>u,default:()=>k,frontMatter:()=>x,metadata:()=>i,toc:()=>g});const i=JSON.parse('{"id":"API-docs/v1.2/contactlist","title":"Get Contact list","description":"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.","source":"@site/docs/API-docs/v1.2/contactlist.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/contactlist","permalink":"/docs/API-docs/v1.2/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":"eJzNWF9vHLcR/ypTPrTxYXV/ZDtFLy8RAkMVKsRGpMBAJUHg7s7eUuKSDDl7p8PhgDz0G/Spr/1o/iTFkLt3e5IcR20QFDDkW3JmOPwNZ+ZHbgTJRRDzK/GdNSQLCuImEyWGwitHyhoxF5c1QjcL5yoQnHw4A2ycXaEPsLYtkAWP5BUuESRolrEVFJ3FDJy3S1UqswAJhW2cxxpNUEuEpcIVy0qtQS6l0jLXuNMEZdi+7wdya+/HIhPWoZfs3Vkp5qKb5GVFJpz0skFCz7vaCCMbFHOhVaN4VvGGfmrRr0UmPP7UKo+lmFdSB8xEoLVm6cr6RmQCH5y2JYo5+ZZnixobKeYb0cgH1bSNmL+dTjNBa8dKpm1y9GLLerJxbGg23WY7F8K9cr+ZB59fc7q9YbvBWRMwsOzxdMr/HQY1tEWBIVSthh2aIotYoiGWl85pVcSJyV1gpc1TB2x+h0WE3bMZUmlJj6HVNJCT3kvesCJswpf10zBHdycZyCuzEFmERtJwZLd34epZXj8c3zmGJOH+MgN3FiFHjIg2Uun/Qj9H/LYbGBe2YVOutubFrryZvZ4dx39sgtNGmvVLjVjHibYwbOLO5rekSL/YkxKX0QWPkrA8oef099LH0+PXR7Pp0fTPl7Ov52/+Mn/79Xg6nf5dZOKhiYB2CVFKikB3Pu2+W1f+DutsH4t1ZaREkkqHoUI3I7bbwaAyWhm87TPtlrNsGyXePJdvF7ZBqrkErtAQrLw1iwycRhkQyK9BLqQyoCWh/8Nvl4jovfW/jOPLPPslCN5Mp7ezHQhvn4JwZpZSqzI2kEt7j+b33elweUrLPz0GKgnFeXGw2eF42mTAovWK1rHTPBxJp47S/PzqhsswA2u5RS0wtSaqxVxMDhtWQL/su1XrtZiLmsiF+WQSpClz+zDuk1jLPHBJmUinJsvZ+FhweznUkc69SB7bo5eqBJILZRZf0rvZ43PBMUxhOkBp3x6c+htyf+iCMJTqWmaNsuRWt+XvykblLjTvHZoLtTAxsHHxxxTmI+rCNshEhWqE0ahX+fSPf++0RiMobdE2aCgewfG1uTbvWw+R6XCnlKaESuODYpLyHAsKKBuNIeg1KEO48JIQSrVQJDUwTpxmhXQyV1rxyWUxmzjO4PCHMXyskWr0PPUnz6yqxCVqPvAgW7KNJDbV+wsr6+8rbVchAwl5G5TBEABNLU3Bgn0kMrAepAE0hN55FRACefZaJd+sIc9Er5FGLpBtZzAEq0St+LiCt3kbCILVbXQZuGxajyX0GzKIZYggvmMa4xESlRvyv0WrSgwZFLZECDFReQumhBwDgWNfVIGBjbZG2+I+BrBqtQZnuW4oqZlADn1kdfLSBG5qyZc+BjvAnLfMfzA5OBr9GJAjfK7MfZiPRtfmCK525+oj5kER3nzVp8BqtXpy9F8d6pwq+mubww/obFBk/XqvvVBUt3lMl6GR3UeydIoG4/kZJMPeRmmL8DT7eHRSo3aTCyQ+IWFy8uEsltpX8Onnf8I5Sm+gtqt0WovWo17Dol+KkUuRT7DtKiVUNh68mhEv0uFj8oqBegQ/1pI+/fyvAN/jiol7Sineymh0igSX2DhuIvBHOPjkK8VoNAePjV1iCa0xyKGRfg17Mh9dC8gDhCU4j5XSGkpJEipvm5hd6AcaY176WlRK462TIaysL6/FXgBkWWLJniZiA9R5lEFiIIOBTmKfborqwXTpZUX72eSqrqJP4G1L6QCnaxBC700E1XlLWMQ9lVXvtNTarm5tVcUGy2Z+ledx5UfOD9aPVqENDCdZQBMvW5azI6SfacFdpWL/qEbld9Z6BxPat95qfN4zztIkFCB1bM7SQ6Ce4PpFoJ9Eijfs2lyr4vGGx3BSFOgY2KXULYY5jEbJo9EIviqxkq2mVxmMRnwJ5VH+LR1Hib/GcNH533ChqyVfbgmYFxHYDiVJrUdYqXKB9A0kQ0MFY7vJ8A30pgM0ct3ZM+t+Pm7VtgRyYLi7HzIU42tuhY/a52GX81ihZ+xiePdJ7VSXxFd9MQCuEf9LMUlXkkSLmXyluxL38W8f24kkCn0T3lcX6JeqwI5LfKaOTqLwRGRCqwJNwAE5Ozn9cA7L1+OpyAak5FeU1Mn52Xfvvr94x85wCBJgs/F0PI0XNBuokWawEpeo/tGjI2oHYG/2vPX/8IGko1WEDzRxWqrIZCNgm46FXh08m9xkoraBeHizyWXAH73ebnk4vVQwN+2KxP6t4h7Xg5eVmGRiLiJh/Ixs9wSyF73hD69YNnLmrKd5vGDSSVk80HpySThg2qfvLkUmuFMd0sv7SC+7H2y9nzLrge1D3pkc4L+8p2cVNptEXbfbnXya+qxGt8FemkNzs91u/wP5h9cH","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Contact","permalink":"/docs/API-docs/v1.2/deletecontact"},"next":{"title":"Self Sign","permalink":"/docs/API-docs/v1.2/selfsign"}}');var a=o(74848),n=o(28453),s=o(57742),r=o.n(s),p=o(78178),l=o.n(p),c=o(19624),m=o.n(c),d=o(96226),y=o.n(d),h=(o(77675),o(19365),o(51107)),v=o(21312);const x={id:"contactlist",title:"Get Contact list",description:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.",sidebar_label:"Get Contact list",hide_title:!0,hide_table_of_contents:!0,api:"eJzNWF9vHLcR/ypTPrTxYXV/ZDtFLy8RAkMVKsRGpMBAJUHg7s7eUuKSDDl7p8PhgDz0G/Spr/1o/iTFkLt3e5IcR20QFDDkW3JmOPwNZ+ZHbgTJRRDzK/GdNSQLCuImEyWGwitHyhoxF5c1QjcL5yoQnHw4A2ycXaEPsLYtkAWP5BUuESRolrEVFJ3FDJy3S1UqswAJhW2cxxpNUEuEpcIVy0qtQS6l0jLXuNMEZdi+7wdya+/HIhPWoZfs3Vkp5qKb5GVFJpz0skFCz7vaCCMbFHOhVaN4VvGGfmrRr0UmPP7UKo+lmFdSB8xEoLVm6cr6RmQCH5y2JYo5+ZZnixobKeYb0cgH1bSNmL+dTjNBa8dKpm1y9GLLerJxbGg23WY7F8K9cr+ZB59fc7q9YbvBWRMwsOzxdMr/HQY1tEWBIVSthh2aIotYoiGWl85pVcSJyV1gpc1TB2x+h0WE3bMZUmlJj6HVNJCT3kvesCJswpf10zBHdycZyCuzEFmERtJwZLd34epZXj8c3zmGJOH+MgN3FiFHjIg2Uun/Qj9H/LYbGBe2YVOutubFrryZvZ4dx39sgtNGmvVLjVjHibYwbOLO5rekSL/YkxKX0QWPkrA8oef099LH0+PXR7Pp0fTPl7Ov52/+Mn/79Xg6nf5dZOKhiYB2CVFKikB3Pu2+W1f+DutsH4t1ZaREkkqHoUI3I7bbwaAyWhm87TPtlrNsGyXePJdvF7ZBqrkErtAQrLw1iwycRhkQyK9BLqQyoCWh/8Nvl4jovfW/jOPLPPslCN5Mp7ezHQhvn4JwZpZSqzI2kEt7j+b33elweUrLPz0GKgnFeXGw2eF42mTAovWK1rHTPBxJp47S/PzqhsswA2u5RS0wtSaqxVxMDhtWQL/su1XrtZiLmsiF+WQSpClz+zDuk1jLPHBJmUinJsvZ+FhweznUkc69SB7bo5eqBJILZRZf0rvZ43PBMUxhOkBp3x6c+htyf+iCMJTqWmaNsuRWt+XvykblLjTvHZoLtTAxsHHxxxTmI+rCNshEhWqE0ahX+fSPf++0RiMobdE2aCgewfG1uTbvWw+R6XCnlKaESuODYpLyHAsKKBuNIeg1KEO48JIQSrVQJDUwTpxmhXQyV1rxyWUxmzjO4PCHMXyskWr0PPUnz6yqxCVqPvAgW7KNJDbV+wsr6+8rbVchAwl5G5TBEABNLU3Bgn0kMrAepAE0hN55FRACefZaJd+sIc9Er5FGLpBtZzAEq0St+LiCt3kbCILVbXQZuGxajyX0GzKIZYggvmMa4xESlRvyv0WrSgwZFLZECDFReQumhBwDgWNfVIGBjbZG2+I+BrBqtQZnuW4oqZlADn1kdfLSBG5qyZc+BjvAnLfMfzA5OBr9GJAjfK7MfZiPRtfmCK525+oj5kER3nzVp8BqtXpy9F8d6pwq+mubww/obFBk/XqvvVBUt3lMl6GR3UeydIoG4/kZJMPeRmmL8DT7eHRSo3aTCyQ+IWFy8uEsltpX8Onnf8I5Sm+gtqt0WovWo17Dol+KkUuRT7DtKiVUNh68mhEv0uFj8oqBegQ/1pI+/fyvAN/jiol7Sineymh0igSX2DhuIvBHOPjkK8VoNAePjV1iCa0xyKGRfg17Mh9dC8gDhCU4j5XSGkpJEipvm5hd6AcaY176WlRK462TIaysL6/FXgBkWWLJniZiA9R5lEFiIIOBTmKfborqwXTpZUX72eSqrqJP4G1L6QCnaxBC700E1XlLWMQ9lVXvtNTarm5tVcUGy2Z+ledx5UfOD9aPVqENDCdZQBMvW5azI6SfacFdpWL/qEbld9Z6BxPat95qfN4zztIkFCB1bM7SQ6Ce4PpFoJ9Eijfs2lyr4vGGx3BSFOgY2KXULYY5jEbJo9EIviqxkq2mVxmMRnwJ5VH+LR1Hib/GcNH533ChqyVfbgmYFxHYDiVJrUdYqXKB9A0kQ0MFY7vJ8A30pgM0ct3ZM+t+Pm7VtgRyYLi7HzIU42tuhY/a52GX81ihZ+xiePdJ7VSXxFd9MQCuEf9LMUlXkkSLmXyluxL38W8f24kkCn0T3lcX6JeqwI5LfKaOTqLwRGRCqwJNwAE5Ozn9cA7L1+OpyAak5FeU1Mn52Xfvvr94x85wCBJgs/F0PI0XNBuokWawEpeo/tGjI2oHYG/2vPX/8IGko1WEDzRxWqrIZCNgm46FXh08m9xkoraBeHizyWXAH73ebnk4vVQwN+2KxP6t4h7Xg5eVmGRiLiJh/Ixs9wSyF73hD69YNnLmrKd5vGDSSVk80HpySThg2qfvLkUmuFMd0sv7SC+7H2y9nzLrge1D3pkc4L+8p2cVNptEXbfbnXya+qxGt8FemkNzs91u/wP5h9cH",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},u=void 0,L={},g=[];function f(e){const t={p:"p",...(0,n.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(h.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)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,a.jsx)(v.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,a.jsx)(l(),{...o(6815)}),"\n",(0,a.jsx)(m(),{...o(23861)}),"\n",(0,a.jsx)(y(),{...o(76699)})]})}function k(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(f,{...e})}):f(e)}},6815(e){e.exports=JSON.parse('{"parameters":[{"name":"limit","in":"query","required":false,"style":"form","explode":true,"schema":{"maximum":500,"type":"number"},"example":10},{"name":"skip","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"number"},"example":0}]}')},23861(e){e.exports={title:"Body"}},76699(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"ph1bhx2jp"},"name":{"type":"string","format":"string","example":"joe bee"},"email":{"type":"string","format":"string","example":"joebee@example.com"},"phone":{"type":"string","format":"string","example":"4131231231"},"company":{"type":"string","format":"string","example":"opensign"},"job_title":{"type":"string","format":"string","example":"dev"},"createdAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"xml":{"name":"contactdetails"},"title":"contact"}}},"title":"inline_response_200"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/ec5e470a.7ac2a895.js b/assets/js/ec5e470a.7ac2a895.js new file mode 100644 index 000000000..ef638decd --- /dev/null +++ b/assets/js/ec5e470a.7ac2a895.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[2923],{56483(e,t,a){a.r(t),a.d(t,{assets:()=>F,contentTitle:()=>f,default:()=>I,frontMatter:()=>g,metadata:()=>n,toc:()=>V});const n=JSON.parse('{"id":"API-docs/v1.2/contactlist","title":"Get Contact list","description":"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.","source":"@site/docs/API-docs/v1.2/contactlist.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/contactlist","permalink":"/docs/API-docs/v1.2/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":"eJzNGdtuG7n1V04ZoIiF0cW5bFFtsV2v43iDTTeGZTdALcPDmTnSMOKQsyRHsmAL2IeiH1D0pa/9ib73U/IlxSFnRiM7l3V3sSiQxDF57neeuWGOzy0bX7BDrRxPnWWXEcvQpkaUTmjFxuwsR6hv4bWwDg5OXgEWpV6hsbDWFTgNBp0RuETgIAlGzyCtKUZQGr0UmVBz4JDqojSYo7JiibAUuCJYLiXwJReSJxJbTBCK6JvmINF6MWAR0yUaTtK9ytiY1ZfElkWs5IYX6NCQVjdM8QLZmElRCLoVpNAPFZo1i5jBHyphMGPjGZcWI2bdWhL0TJuCRQyvS6kzZGNnKrpNcyw4G9+wgl+LoirY+PloFDG3LglJVUWChm0IjxclEdofbaJWBLsQ5S8mwcd5jjaXRNeWWlm0BPtkNKIfu061VZqitbNKQmtNFnlbonIEz8tSitRfDN9ZQrq5L4BO3mHqzW6IjBOBpUFbSdeB48ZwUlg4LOzn8cMxebeFtM4INWeRNw133ZNWd1bm+0l+/eRdSSYJdn8YgXcaIUH0Fi24kP8DfoL4dX0wSHVBpMpcqweL8mz/6f4T/4dIUNpwtX4oEV1Sos0VkXinkysnnHywJBkuvQgGucPswH0Ifwv9ZPTkaX9/1B/97mz/i/Gz34+ffzEYjUZ/YRG7LrxB64TIuPOGrmVqf6/K7Ffgs7kLVpeRDB0X0nYR6hu22XQOhZJC4VWTaVeUZRsP8exD+TbRBbqcSuAKlYOV0WoeQSmRWwRn1sDnXCiQ3KH5zS+XiGiMNp+248Mk+5QJno1GV/utEZ7fN8IrteRSZL6BnOkFql9X0y57F9jfDwMRgPw921G2ex6UtJhWRri17zTXfV6KfrgfX1xSGSbDampRcwytyeVszIa7DcuiWTbdqjKSjVnuXGnHw6HlKkv09aBJYskTSyVlyEsxXO4PnjBqL7s4vCwfBI9V/6Eo1vG5UPPP4V1u7TMhHwY37Vhp2x5K8R1Sf6id0IWqW2aOPKNWt6HfZ9oj1655U6KaiLnyjvXM744wj6CBef/Xf7VgUzVVX0GvRwMOKdK3ujIpwgudVp4elw6N4o4mlfc//gOSSkgHM20gwyVKCj8bgTOVdZhBsgZUDk1phEU76PWIfpfvXCwxDExhDJLo0A9HWZWSoH2DPFsD9smi3FUGoZTcUWkGlxtdzXPgYIWaS4zg9GhyRu374OTVACaoMsh0WhWonPUitkQiKLjicwSHBdFDLzNPFx6EEt867io/bRnkEpwoMAKuMuCV0wV3GKYwVE4YbNmAFDNM16kMxqERbiVcrisHS1SZNiB1uugLNSBD9Pt9+vHoERyjc8R14rhxmNHp0RLNGmgaQuugqKyDlBuzDnzbfCUJXY4Qd+IjhhAZnkkcx1PVuRzDH4jC9uCrGmaqer33f/s7XHyrVzS+zlHREIR3GF4+boI+06m9H+10OsxRlsNJUMoOD05e+dK2F/z/vXZgyZOrHA0SqwTnQv0Rzqm65gi9Xp3mgGopjFZk2l4PHsc/uQzEe0S3NNppyqfWC3w2w9SbWlIEZ9zxO6441AbhkJc8EVJQJaXzWzjkDufarOEW3ubc+ZBNuYJMw+1U3fb7ff+XQHu9F03U9XpwC4d+SIjAosoiCK08AoNLvahjKkOK+2149hu3b8O3pnzWxKun/E0lZAYGK+vfCG0we3WhNNgvJU8xg5XI5ujsl14GsoxWCNpQFqw9W3q21CwmKGd9yk/P4riJAkvHHrSbVa1dayog1FI4365gJvWqIXpSJVKksCv+JOeGXkdluGxSTwq18OmjdEPVv5+al0FD84XhMwdvtVkQp0CRL7EjnTYdm3ALGWFYb/KZUFyKEHBF6OQN3ebZ5yn+KdQJnwO1MHWvAnp6UYjNDS8K7kTKpVw3RF5qmaEJNN6YOVfEayuZUFZk2JZgeGEoHGcBqaHxFpNc60UgcoopEgyVoz6VI8AlVRylnZjVE4KFEJkG9EoBqqzUQrmG3LltBDptX6ZpqivlvEVSg5lwQJ2E5l7y4O1ualDgv//xnxa+xxXVnaZhPKK0kcjJOI2HGx5cTlV8fHQGw8YTw7HIYs9x95x8HENOHkwQFVhnkBc0TmU+Ggxmlcq4crB9zwIFkMFCLzHzJHu90uBMSOlTG4QFpVf0Eq8M0bFIuA7lGmZGF41HtwR7PWoNCwrD9sEIyK1AQ2mTamWrAgeN1ifc2pU2Wf/EaIcptbyTFy9hUpWlNm6q6B7iKZsJiVdlDTxlcVO1mzxPdLamcqhgpY3n7jMYVWrWZU3VDhq6mIFW46mKT95MzmAYHiGNGWP4z78hPjm/Z3F/3EFognE4buCudsF8tjRQ9y7u8PMXVCPIpHFjnzezGTkQJnVqU2oZLadqgo7swqXUqysdoK4IdcrGND0g3IJ//8egFXxEUR9DH9DUaaAtgUiFkzSA+OJIE4oIdbLm1xYcGg2Qp3lbLFr/TkJ8nGpJfYCGoriuljGEodvHF09TLKmwkE4B4MpoieTpmUCZAU+NttYPBF4Lyi6jK4d2AGe5QQSCD/FsGy+PQ+sh7lTsMedLQcl9t+HUMsXQe5zhjFfS7fnS5WeGeqiiykDvF+dL/3aaCp0hlIiYVk9Ep6021kdpO92QoQyGBZWS66ZI190FvDeb+hzzknZcgdwhVyGzqd804HhNVqtbR5CmLvGe2W1bWrhJtIJDXa7h8eHhHgknSkF1dKoOQOGKzJ6mW2vXad8aErjUau4rLumD18L6GSCesqSLp1Wra9QGQxTaho+2tgm2XhyGft4684hWJMCzzKCl2kFVDTPK91ZGU1dyTgNdolU/Jc26dRz8ogW0SnHXAcK2Ds0G8FoscKtDROLvSAOPbZXm1PhClmwzXmTxXmcF2YpG/jIiq/3eWACWXFYY+YYTqhRZVgoyLHVT2ny6NfiFFjyOLy7jvS9BF8J5KsG0ToNQOZr6cJf0nRHsoN16Hm3nv3oO65xQTtCD/Pz09QdmsEkYEX2/e8Dc2A4s7RNkl8InX3gt9tE5nOL8HvLnXpbx3Y77ZzRWaF+kfgvf8HSx4iazcEibLyf8hLomUEKm4JhVNIIkDWA/rQFlmIBhue/DeLk/2G8fKM2YYENLdLm2CMvAOBSk7RZaU9sSFpLG7p6q0pAYDF0zzbmaUyLQjNBp1IIKf1alIRe8vERa++col1ApidaCdjmaFc1KSlOM75rj3CI9714LtfDh0IeLdoJ6i4kVDrfPk9Vqdc/Sex7nZSUlNDO6T7jPPGoC2rFw31YJnGKprXDarLdYc+HyKvG+7OK2v9QEmlm6Xfb8nMeUJ3mGprD0tWCCZinSz6g/dAQ+3JvSCuHO2mF3O2Bwhobqjt15CvJS1M/Oi0YOIPF+jh5hlRvWibS0Cjtm2n98fZeOXz6RCm9mtb71DubT+rKISZGisthZah0cn7yG5dPBiEWdZc5P8OXw9avDo+8nRyRMnSZszPYHo8HIL7a1dQVXHU7H6NqPRfWCa8fYN9t93//hh6V6HeXw2g1LyYXfAHqD3dTbu4udz02XEcu1dXR8c0N14tzIzYaOwxce2unVg9j2G88C150vUr4nsDHzi7aPwNafjragl/SLEQTrd41Rsx4jhgHnwI9pHax7y9WdDeXx0RmLGK9Ix+5abuHXcvV/iHpzpdYd2rv7uiAA/Us6fRDh5ias/DabFj5cfRSjVrCBJtdcbjab/wJbCh6d","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Contact","permalink":"/docs/API-docs/v1.2/deletecontact"},"next":{"title":"Self Sign","permalink":"/docs/API-docs/v1.2/selfsign"}}');var o=a(74848),i=a(28453),s=a(57742),l=a.n(s),c=a(78178),p=a.n(c),r=a(19624),d=a.n(r),m=a(96226),u=a.n(m),G=(a(77675),a(19365),a(51107)),h=a(21312);const g={id:"contactlist",title:"Get Contact list",description:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.",sidebar_label:"Get Contact list",hide_title:!0,hide_table_of_contents:!0,api:"eJzNGdtuG7n1V04ZoIiF0cW5bFFtsV2v43iDTTeGZTdALcPDmTnSMOKQsyRHsmAL2IeiH1D0pa/9ib73U/IlxSFnRiM7l3V3sSiQxDF57neeuWGOzy0bX7BDrRxPnWWXEcvQpkaUTmjFxuwsR6hv4bWwDg5OXgEWpV6hsbDWFTgNBp0RuETgIAlGzyCtKUZQGr0UmVBz4JDqojSYo7JiibAUuCJYLiXwJReSJxJbTBCK6JvmINF6MWAR0yUaTtK9ytiY1ZfElkWs5IYX6NCQVjdM8QLZmElRCLoVpNAPFZo1i5jBHyphMGPjGZcWI2bdWhL0TJuCRQyvS6kzZGNnKrpNcyw4G9+wgl+LoirY+PloFDG3LglJVUWChm0IjxclEdofbaJWBLsQ5S8mwcd5jjaXRNeWWlm0BPtkNKIfu061VZqitbNKQmtNFnlbonIEz8tSitRfDN9ZQrq5L4BO3mHqzW6IjBOBpUFbSdeB48ZwUlg4LOzn8cMxebeFtM4INWeRNw133ZNWd1bm+0l+/eRdSSYJdn8YgXcaIUH0Fi24kP8DfoL4dX0wSHVBpMpcqweL8mz/6f4T/4dIUNpwtX4oEV1Sos0VkXinkysnnHywJBkuvQgGucPswH0Ifwv9ZPTkaX9/1B/97mz/i/Gz34+ffzEYjUZ/YRG7LrxB64TIuPOGrmVqf6/K7Ffgs7kLVpeRDB0X0nYR6hu22XQOhZJC4VWTaVeUZRsP8exD+TbRBbqcSuAKlYOV0WoeQSmRWwRn1sDnXCiQ3KH5zS+XiGiMNp+248Mk+5QJno1GV/utEZ7fN8IrteRSZL6BnOkFql9X0y57F9jfDwMRgPw921G2ex6UtJhWRri17zTXfV6KfrgfX1xSGSbDampRcwytyeVszIa7DcuiWTbdqjKSjVnuXGnHw6HlKkv09aBJYskTSyVlyEsxXO4PnjBqL7s4vCwfBI9V/6Eo1vG5UPPP4V1u7TMhHwY37Vhp2x5K8R1Sf6id0IWqW2aOPKNWt6HfZ9oj1655U6KaiLnyjvXM744wj6CBef/Xf7VgUzVVX0GvRwMOKdK3ujIpwgudVp4elw6N4o4mlfc//gOSSkgHM20gwyVKCj8bgTOVdZhBsgZUDk1phEU76PWIfpfvXCwxDExhDJLo0A9HWZWSoH2DPFsD9smi3FUGoZTcUWkGlxtdzXPgYIWaS4zg9GhyRu374OTVACaoMsh0WhWonPUitkQiKLjicwSHBdFDLzNPFx6EEt867io/bRnkEpwoMAKuMuCV0wV3GKYwVE4YbNmAFDNM16kMxqERbiVcrisHS1SZNiB1uugLNSBD9Pt9+vHoERyjc8R14rhxmNHp0RLNGmgaQuugqKyDlBuzDnzbfCUJXY4Qd+IjhhAZnkkcx1PVuRzDH4jC9uCrGmaqer33f/s7XHyrVzS+zlHREIR3GF4+boI+06m9H+10OsxRlsNJUMoOD05e+dK2F/z/vXZgyZOrHA0SqwTnQv0Rzqm65gi9Xp3mgGopjFZk2l4PHsc/uQzEe0S3NNppyqfWC3w2w9SbWlIEZ9zxO6441AbhkJc8EVJQJaXzWzjkDufarOEW3ubc+ZBNuYJMw+1U3fb7ff+XQHu9F03U9XpwC4d+SIjAosoiCK08AoNLvahjKkOK+2149hu3b8O3pnzWxKun/E0lZAYGK+vfCG0we3WhNNgvJU8xg5XI5ujsl14GsoxWCNpQFqw9W3q21CwmKGd9yk/P4riJAkvHHrSbVa1dayog1FI4365gJvWqIXpSJVKksCv+JOeGXkdluGxSTwq18OmjdEPVv5+al0FD84XhMwdvtVkQp0CRL7EjnTYdm3ALGWFYb/KZUFyKEHBF6OQN3ebZ5yn+KdQJnwO1MHWvAnp6UYjNDS8K7kTKpVw3RF5qmaEJNN6YOVfEayuZUFZk2JZgeGEoHGcBqaHxFpNc60UgcoopEgyVoz6VI8AlVRylnZjVE4KFEJkG9EoBqqzUQrmG3LltBDptX6ZpqivlvEVSg5lwQJ2E5l7y4O1ualDgv//xnxa+xxXVnaZhPKK0kcjJOI2HGx5cTlV8fHQGw8YTw7HIYs9x95x8HENOHkwQFVhnkBc0TmU+Ggxmlcq4crB9zwIFkMFCLzHzJHu90uBMSOlTG4QFpVf0Eq8M0bFIuA7lGmZGF41HtwR7PWoNCwrD9sEIyK1AQ2mTamWrAgeN1ifc2pU2Wf/EaIcptbyTFy9hUpWlNm6q6B7iKZsJiVdlDTxlcVO1mzxPdLamcqhgpY3n7jMYVWrWZU3VDhq6mIFW46mKT95MzmAYHiGNGWP4z78hPjm/Z3F/3EFognE4buCudsF8tjRQ9y7u8PMXVCPIpHFjnzezGTkQJnVqU2oZLadqgo7swqXUqysdoK4IdcrGND0g3IJ//8egFXxEUR9DH9DUaaAtgUiFkzSA+OJIE4oIdbLm1xYcGg2Qp3lbLFr/TkJ8nGpJfYCGoriuljGEodvHF09TLKmwkE4B4MpoieTpmUCZAU+NttYPBF4Lyi6jK4d2AGe5QQSCD/FsGy+PQ+sh7lTsMedLQcl9t+HUMsXQe5zhjFfS7fnS5WeGeqiiykDvF+dL/3aaCp0hlIiYVk9Ep6021kdpO92QoQyGBZWS66ZI190FvDeb+hzzknZcgdwhVyGzqd804HhNVqtbR5CmLvGe2W1bWrhJtIJDXa7h8eHhHgknSkF1dKoOQOGKzJ6mW2vXad8aErjUau4rLumD18L6GSCesqSLp1Wra9QGQxTaho+2tgm2XhyGft4684hWJMCzzKCl2kFVDTPK91ZGU1dyTgNdolU/Jc26dRz8ogW0SnHXAcK2Ds0G8FoscKtDROLvSAOPbZXm1PhClmwzXmTxXmcF2YpG/jIiq/3eWACWXFYY+YYTqhRZVgoyLHVT2ny6NfiFFjyOLy7jvS9BF8J5KsG0ToNQOZr6cJf0nRHsoN16Hm3nv3oO65xQTtCD/Pz09QdmsEkYEX2/e8Dc2A4s7RNkl8InX3gt9tE5nOL8HvLnXpbx3Y77ZzRWaF+kfgvf8HSx4iazcEibLyf8hLomUEKm4JhVNIIkDWA/rQFlmIBhue/DeLk/2G8fKM2YYENLdLm2CMvAOBSk7RZaU9sSFpLG7p6q0pAYDF0zzbmaUyLQjNBp1IIKf1alIRe8vERa++col1ApidaCdjmaFc1KSlOM75rj3CI9714LtfDh0IeLdoJ6i4kVDrfPk9Vqdc/Sex7nZSUlNDO6T7jPPGoC2rFw31YJnGKprXDarLdYc+HyKvG+7OK2v9QEmlm6Xfb8nMeUJ3mGprD0tWCCZinSz6g/dAQ+3JvSCuHO2mF3O2Bwhobqjt15CvJS1M/Oi0YOIPF+jh5hlRvWibS0Cjtm2n98fZeOXz6RCm9mtb71DubT+rKISZGisthZah0cn7yG5dPBiEWdZc5P8OXw9avDo+8nRyRMnSZszPYHo8HIL7a1dQVXHU7H6NqPRfWCa8fYN9t93//hh6V6HeXw2g1LyYXfAHqD3dTbu4udz02XEcu1dXR8c0N14tzIzYaOwxce2unVg9j2G88C150vUr4nsDHzi7aPwNafjragl/SLEQTrd41Rsx4jhgHnwI9pHax7y9WdDeXx0RmLGK9Ix+5abuHXcvV/iHpzpdYd2rv7uiAA/Us6fRDh5ias/DabFj5cfRSjVrCBJtdcbjab/wJbCh6d",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},f=void 0,F={},V=[];function b(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:"Get Contact list"}),"\n",(0,o.jsx)(l(),{method:"get",path:"/contactlist",context:"endpoint"}),"\n",(0,o.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,o.jsx)(G.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,o.jsx)(h.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,o.jsx)(p(),{...a(6815)}),"\n",(0,o.jsx)(d(),{...a(23861)}),"\n",(0,o.jsx)(u(),{...a(76699)})]})}function I(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(b,{...e})}):b(e)}},6815(e){e.exports=JSON.parse('{"parameters":[{"name":"limit","in":"query","required":false,"style":"form","explode":true,"schema":{"maximum":500,"type":"number"},"example":10},{"name":"skip","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"number"},"example":0}]}')},23861(e){e.exports={title:"Body"}},76699(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"ph1bhx2jp"},"name":{"type":"string","format":"string","example":"joe bee"},"email":{"type":"string","format":"string","example":"joebee@example.com"},"phone":{"type":"string","format":"string","example":"4131231231"},"company":{"type":"string","format":"string","example":"opensign"},"job_title":{"type":"string","format":"string","example":"dev"},"createdAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"xml":{"name":"contactdetails"},"title":"contact"}}},"title":"inline_response_200"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/ed918ad6.21a5c6e1.js b/assets/js/ed918ad6.21a5c6e1.js deleted file mode 100644 index 035b89d1e..000000000 --- a/assets/js/ed918ad6.21a5c6e1.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[8413],{85849(e,t,n){n.r(t),n.d(t,{assets:()=>D,contentTitle:()=>h,default:()=>v,frontMatter:()=>y,metadata:()=>s,toc:()=>b});const s=JSON.parse('{"id":"API-docs/v1.2/getdocumentlist","title":"Get Document list from status","description":"### Document Types:","source":"@site/docs/API-docs/v1.2/getdocumentlist.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/getdocumentlist","permalink":"/docs/API-docs/v1.2/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":"eJztWV9v28gR/yrTDdBeBFqSHTvX6l4uuKSu2yAJYgcBGhvCkhyJGy93ebtDyYIh4B76DfrU1360fJJidkmKspTEvh7ydC+2uJyZnT+/nZ0Z3gqScy8mH8Rzm9UlGvLiKhE5+sypipQ1YiIePXoE7Wu4WFXoJ5fmLZJTuECQoJUnsDPIWxGQSo85WAO0qvDSXJrDIQwGz52cUSfJTwaDSwMAcLBZAyokgXQIWe0cGtIrUAbywOlJUu2HLO+I5Z2ZgzfOzh16/6ukVg1zkPiEJf5ky0ojYX4feYVcIKSIBnydZej9rNZ6BVknY6moAKk1OPy5Vg5z8GpuJNUO457HvOeLmyq8u++O2NBLkweTjAVtzRwdyKCFSjUG6SfB55hpZR5qUN5ypSugAqH26IaXRiTCVugk4+IsFxMxR2qDziAQiaikkyUSOgbVrTCyRDERuc0YCSIRigFVSSrEXZRdFBjgso0ksuAapIlEtI4UE3I1JsLTSrN8r9jnIhF4U2mbo5jMpPZMkBVYSjG5FWH/ifDklJkzpalLxn2AVlCshYNIRBfDKDJsyfpGr4ir9TrpbNOqVNRa9nONbrWlaKtIo+nMurKvZ2NHp2Ypb1TJmp2Mx0mrtKnLFJ1YM58Mlk4Oxz0V/LWqfjMNPr/neH3Fcn1ljUfPtEfjMf/bDuTmNECHluBTQ2iI6WVVaZWFF6OPnpludxWw6UfMAqQciyEVt3Toa009OumcZIMVYem/zh+XGb27mGDXSNpCSWu7+Oupuj56khbv/s4+mSlefJiEgqjyk9GoWamdHma2ZGmk6OHifPjBR4VFGEsPllBplB5DUupOXDDO6hzdt3JlxPDDJEQNIbCuNw4UrRXTxoR1IuzSbNlyL/kfbUiEzM/eCdns1wLO2f2x3eyWof2SI/aqhaVU+qvUKeKPzUKLtaqw5ivbHJ88PTp88ufvD8V6zd71aPIz89ptgyK1VqM0fU5OJQ39VJmpZY4pb5DRlxlDilonQmptl1M7m3GenbLr9/Jt55v3BVKBDppIQSb5Rk5LRSAhs9WKbxQqlO9AHklzqL0yc5AG8IbQGamBrNUwsw4CbMDhQuFyCM9xJmsdr6Og63Cf9plDSZg/oy+792h89OTgcHww/v7i8Onk+C+Tk6fD8Xj8T5GImzLEtL01JaHoo7t5rqv8m+yDRqYaL2x9v7A7zJXDjKa124vMLx040QW/tLmaNZeDvx9qCMtKS8Kp2puKNrv0CEF5sEavQC6k0mwnLAs0odrpYKI8NDGFmbMlSGglDIPCNdmpw1KZz52MbaCeIzGA2F38P7oXWEopSWXQivJDaEiDhfwjVz4QU4ElfJdHOEKKhVwo6x7vhWMUN7UmQz6NuODCYOeCv6vkq7AcijC58pAiLbki7Ol2wUepc1+8yjv/bfmEqfzG6C0tx5xZ7uCwdwfdzehi3c/zyoQE0dYi06PxeHrcZKvj8fFuTfIWK+sIjKVNwP/w2xUl6Jzde8lssLdfgy8ZdTw+np50Rp3sGnVmFlKrHJ69OYMLe43m21rU357i9rsxVZEovBdbxvbX23smq52iVegcbg5kpQ7i+8mHKy49S6TCNm1HaDWoEBMx6ncgo9um1VgLlucWbSMSclJXgnlp8tTeDG2Fhu8CLVPPF+RIVmq0OBweCa6ut3lkVT2IHuuDh7J4knNl5l/ju9q46pzDGSO25bBNsVKpfyBXK008+lRNx1CgDLXSmp9nNjA3UXpdoTnn8pBjHDbfuXxRZ7YMOYpT52DQsnz61387rsGgy6kBjaE9fV07qOwSHTcK3MzONN5w8xrYsAzvPKxszcI9ylKj96FzJ5w7SQi5miuSOlznfJNnspKp0opBzGSWuR30zoEfQlsurGz9J8fjixwXqBn7XSo2880dsLTueqbt0icgIeWKgccNaAppMiZsI5GAdaGUMISucooLa3KstYq6WUNOZgSlNHKOLDuBvrNy1IrhCs6mtSfwVtdBZSCptOWWvzXIIOZxgvCCuziHwKvctDosGDYLhHmtcvQJZDZHiL0Cm2BySNETVKyLyjCUNLXRNrsOAeQZBlSWU4iSmq+Bvo7MTk4az3d51KWNQeewyllu/5oRx2DwziNH+KUy13H2cAAfOly9x9Qrwqvv2iOwXC53oP94m+dU0d/qFDihekXWrTbcc0VFnYbj0hfSPURJp2gw4Kd3GDYycpv53dPHq6MCdTU6R2KE+NGzN2ch6z6GT7/8G16idAYKu4xozWqHegXzdiv2XIx8dFuXNEO1KWsq2ONZBB/37uip9eD7QtKnX/7j4RUueW4VjxSbMhicIsFFU5TAH2Hr8aXyNBhM+O62Cy53jUEOjXQr2MxpgmoeeYELncrhTGkNuSQZq55YV/c4hrz1ZeiBp5X0fmldfik2BCDzHHPWNFZPXdWUQCxdewsNxea48cxs8zoO/rq3UVU9iz2rszVFAFfOLlSO0GoTnFo5S5gFm/JZq/Ruh3EvzcPOd5Tv7R+khimZ71V21nV1W7Nhl6lYPypQuU5aq2D09pS7xv2a8SltW514eYdibctRO379qqN3IsUGV3WqVXbX4CE8yzKs2LELqWv0ExgMokaDQVecPk5gMODuiVf5t6w4Svw0hPNG/5ITXRg7SgKeRhDYxkthTApLlc+RfoAoqM9gbPPS/wCtaA+lXDXyzKp9H0y1NXeDG8HNeIxdEQebd67P7VvO4Qwd+y6Ed3OoK9Uc4g9tMgDOEf9PMuEiie8KGXvmps/ne/zHu3JCPYWu9K9n5+gWKmunTJ/Jo6NAPBKJ0CpD47FXpz07ffMSFk+GY5H0ipJ7pNTRy7OfXrw6f8HKcAiiww6H4+E4jBusp1Ka3k6corqvCeHTQcwyYbh/t7643dSzv3+G+P0zRPcZoqluCW9oVGmpQm/RzB1iX/BB3PkyMWk/QlwlorCemOT2liHyzun1mpfj7JzbhSZvb6bn17jqzfpD3otji8/SNkP5DekVPzjFtPv3+Czyv3vbRO4x3OcryV7ntP2AWfWVapVtfbO+WidtQ8A6xrcx3/f4djrLrfbs9MWFCNORYrsRuQ6NSPODpe/VabtDiQrwX3b1Xobb29jkrNcdfXz1WY7GwJaaHXS1Xq//BzM3IxQ=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Document","permalink":"/docs/API-docs/v1.2/deletedocument"},"next":{"title":"Resend request mail","permalink":"/docs/API-docs/v1.2/resendrequestmail"}}');var i=n(74848),l=n(28453),r=n(57742),o=n.n(r),p=n(78178),a=n.n(p),c=n(19624),d=n.n(c),m=n(96226),u=n.n(m),f=(n(77675),n(19365),n(51107)),x=n(21312);const y={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:"eJztWV9v28gR/yrTDdBeBFqSHTvX6l4uuKSu2yAJYgcBGhvCkhyJGy93ebtDyYIh4B76DfrU1360fJJidkmKspTEvh7ydC+2uJyZnT+/nZ0Z3gqScy8mH8Rzm9UlGvLiKhE5+sypipQ1YiIePXoE7Wu4WFXoJ5fmLZJTuECQoJUnsDPIWxGQSo85WAO0qvDSXJrDIQwGz52cUSfJTwaDSwMAcLBZAyokgXQIWe0cGtIrUAbywOlJUu2HLO+I5Z2ZgzfOzh16/6ukVg1zkPiEJf5ky0ojYX4feYVcIKSIBnydZej9rNZ6BVknY6moAKk1OPy5Vg5z8GpuJNUO457HvOeLmyq8u++O2NBLkweTjAVtzRwdyKCFSjUG6SfB55hpZR5qUN5ypSugAqH26IaXRiTCVugk4+IsFxMxR2qDziAQiaikkyUSOgbVrTCyRDERuc0YCSIRigFVSSrEXZRdFBjgso0ksuAapIlEtI4UE3I1JsLTSrN8r9jnIhF4U2mbo5jMpPZMkBVYSjG5FWH/ifDklJkzpalLxn2AVlCshYNIRBfDKDJsyfpGr4ir9TrpbNOqVNRa9nONbrWlaKtIo+nMurKvZ2NHp2Ypb1TJmp2Mx0mrtKnLFJ1YM58Mlk4Oxz0V/LWqfjMNPr/neH3Fcn1ljUfPtEfjMf/bDuTmNECHluBTQ2iI6WVVaZWFF6OPnpludxWw6UfMAqQciyEVt3Toa009OumcZIMVYem/zh+XGb27mGDXSNpCSWu7+Oupuj56khbv/s4+mSlefJiEgqjyk9GoWamdHma2ZGmk6OHifPjBR4VFGEsPllBplB5DUupOXDDO6hzdt3JlxPDDJEQNIbCuNw4UrRXTxoR1IuzSbNlyL/kfbUiEzM/eCdns1wLO2f2x3eyWof2SI/aqhaVU+qvUKeKPzUKLtaqw5ivbHJ88PTp88ufvD8V6zd71aPIz89ptgyK1VqM0fU5OJQ39VJmpZY4pb5DRlxlDilonQmptl1M7m3GenbLr9/Jt55v3BVKBDppIQSb5Rk5LRSAhs9WKbxQqlO9AHklzqL0yc5AG8IbQGamBrNUwsw4CbMDhQuFyCM9xJmsdr6Og63Cf9plDSZg/oy+792h89OTgcHww/v7i8Onk+C+Tk6fD8Xj8T5GImzLEtL01JaHoo7t5rqv8m+yDRqYaL2x9v7A7zJXDjKa124vMLx040QW/tLmaNZeDvx9qCMtKS8Kp2puKNrv0CEF5sEavQC6k0mwnLAs0odrpYKI8NDGFmbMlSGglDIPCNdmpw1KZz52MbaCeIzGA2F38P7oXWEopSWXQivJDaEiDhfwjVz4QU4ElfJdHOEKKhVwo6x7vhWMUN7UmQz6NuODCYOeCv6vkq7AcijC58pAiLbki7Ol2wUepc1+8yjv/bfmEqfzG6C0tx5xZ7uCwdwfdzehi3c/zyoQE0dYi06PxeHrcZKvj8fFuTfIWK+sIjKVNwP/w2xUl6Jzde8lssLdfgy8ZdTw+np50Rp3sGnVmFlKrHJ69OYMLe43m21rU357i9rsxVZEovBdbxvbX23smq52iVegcbg5kpQ7i+8mHKy49S6TCNm1HaDWoEBMx6ncgo9um1VgLlucWbSMSclJXgnlp8tTeDG2Fhu8CLVPPF+RIVmq0OBweCa6ut3lkVT2IHuuDh7J4knNl5l/ju9q46pzDGSO25bBNsVKpfyBXK008+lRNx1CgDLXSmp9nNjA3UXpdoTnn8pBjHDbfuXxRZ7YMOYpT52DQsnz61387rsGgy6kBjaE9fV07qOwSHTcK3MzONN5w8xrYsAzvPKxszcI9ylKj96FzJ5w7SQi5miuSOlznfJNnspKp0opBzGSWuR30zoEfQlsurGz9J8fjixwXqBn7XSo2880dsLTueqbt0icgIeWKgccNaAppMiZsI5GAdaGUMISucooLa3KstYq6WUNOZgSlNHKOLDuBvrNy1IrhCs6mtSfwVtdBZSCptOWWvzXIIOZxgvCCuziHwKvctDosGDYLhHmtcvQJZDZHiL0Cm2BySNETVKyLyjCUNLXRNrsOAeQZBlSWU4iSmq+Bvo7MTk4az3d51KWNQeewyllu/5oRx2DwziNH+KUy13H2cAAfOly9x9Qrwqvv2iOwXC53oP94m+dU0d/qFDihekXWrTbcc0VFnYbj0hfSPURJp2gw4Kd3GDYycpv53dPHq6MCdTU6R2KE+NGzN2ch6z6GT7/8G16idAYKu4xozWqHegXzdiv2XIx8dFuXNEO1KWsq2ONZBB/37uip9eD7QtKnX/7j4RUueW4VjxSbMhicIsFFU5TAH2Hr8aXyNBhM+O62Cy53jUEOjXQr2MxpgmoeeYELncrhTGkNuSQZq55YV/c4hrz1ZeiBp5X0fmldfik2BCDzHHPWNFZPXdWUQCxdewsNxea48cxs8zoO/rq3UVU9iz2rszVFAFfOLlSO0GoTnFo5S5gFm/JZq/Ruh3EvzcPOd5Tv7R+khimZ71V21nV1W7Nhl6lYPypQuU5aq2D09pS7xv2a8SltW514eYdibctRO379qqN3IsUGV3WqVXbX4CE8yzKs2LELqWv0ExgMokaDQVecPk5gMODuiVf5t6w4Svw0hPNG/5ITXRg7SgKeRhDYxkthTApLlc+RfoAoqM9gbPPS/wCtaA+lXDXyzKp9H0y1NXeDG8HNeIxdEQebd67P7VvO4Qwd+y6Ed3OoK9Uc4g9tMgDOEf9PMuEiie8KGXvmps/ne/zHu3JCPYWu9K9n5+gWKmunTJ/Jo6NAPBKJ0CpD47FXpz07ffMSFk+GY5H0ipJ7pNTRy7OfXrw6f8HKcAiiww6H4+E4jBusp1Ka3k6corqvCeHTQcwyYbh/t7643dSzv3+G+P0zRPcZoqluCW9oVGmpQm/RzB1iX/BB3PkyMWk/QlwlorCemOT2liHyzun1mpfj7JzbhSZvb6bn17jqzfpD3otji8/SNkP5DekVPzjFtPv3+Czyv3vbRO4x3OcryV7ntP2AWfWVapVtfbO+WidtQ8A6xrcx3/f4djrLrfbs9MWFCNORYrsRuQ6NSPODpe/VabtDiQrwX3b1Xobb29jkrNcdfXz1WY7GwJaaHXS1Xq//BzM3IxQ=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},h=void 0,D={},b=[{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,l.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(f.default,{as:"h1",className:"openapi__heading",children:"Get Document list from status"}),"\n",(0,i.jsx)(o(),{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)(f.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,i.jsx)(x.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,i.jsx)(a(),{...n(61962)}),"\n",(0,i.jsx)(d(),{...n(70688)}),"\n",(0,i.jsx)(u(),{...n(61866)})]})}function v(e={}){const{wrapper:t}={...(0,l.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(g,{...e})}):g(e)}},61962(e){e.exports=JSON.parse('{"parameters":[{"name":"doctype","in":"path","description":"The type of documents to retrieve","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["draft","inprogress","completed","expired","declined"]}},{"name":"limit","in":"query","required":false,"style":"form","explode":true,"schema":{"maximum":500,"type":"number"},"example":10},{"name":"skip","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"number"},"example":0}]}')},70688(e){e.exports={title:"Body"}},61866(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"FGik23bhUJ"},"file":{"type":"string","format":"string","example":"https://exampleurl.com"},"title":{"type":"string","format":"string","example":"sample doc"},"note":{"type":"string","format":"string","example":"please sign document"},"folder":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"FGik23bhUJ"},"name":{"type":"string","format":"string","example":"folder name"}},"title":"document_folder"},"owner":{"type":"string","format":"string","example":"joe bee"},"signers":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","example":"ceo"},"name":{"type":"string","example":"joe bee"},"email":{"type":"string","example":"joebee@example.com"},"phone":{"type":"string","example":"456213871"}}}},"sendInOrder":{"type":"boolean","example":true},"send_in_order_strict":{"type":"boolean","example":false},"allow_offline_sign":{"type":"boolean","description":"Whether signers can submit a copy of this document signed using an external tool for owner review. Defaults to false.","example":false},"createdAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"enableTour":{"type":"boolean","example":true},"redirect_url":{"type":"string","format":"string","example":""},"allow_modifications":{"type":"boolean","example":false},"template_id":{"type":"string","example":"template_id is only available when the document is created from a template."},"auto_reminder":{"type":"boolean","description":"Set to true to enable automatic reminders. Set to false to disable them (default behavior).","example":false},"remind_once_in_every":{"type":"number","description":"Number of days between reminders. This is only applicable when auto_reminder is set to true.","example":0}},"xml":{"name":"document"},"title":"document"}}},"title":"inline_response_200_4"}}}},"404":{"description":"Report not available!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Report not available!"}},"title":"inline_response_404_5"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/ed918ad6.6be82ba5.js b/assets/js/ed918ad6.6be82ba5.js new file mode 100644 index 000000000..342a714df --- /dev/null +++ b/assets/js/ed918ad6.6be82ba5.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[8413],{85849(e,t,n){n.r(t),n.d(t,{assets:()=>j,contentTitle:()=>D,default:()=>b,frontMatter:()=>x,metadata:()=>s,toc:()=>y});const s=JSON.parse('{"id":"API-docs/v1.2/getdocumentlist","title":"Get Document list from status","description":"### Document Types:","source":"@site/docs/API-docs/v1.2/getdocumentlist.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/getdocumentlist","permalink":"/docs/API-docs/v1.2/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":"eJztWltvHLcV/iunY6CwFnuTLSftpkijyrKi1rUFXWqgXkHLmTm7wyyHnJCcXS2kBfJQ9AcUfelr/0Tf+1PyS9pDci4rrW0pCfKUB1vSzOHhufFcPs5NZNnMRKP30UuVlDlKa6LLbpSiSTQvLFcyGkVPnjyB6jWcrwo0o7E8Ras5LhAYCG4sqCmkFQuImcEUlAS7KnAsx3K3D53OS82mtuZkRp3OWAIA9JpnYDNmgWmEpNQapRUr4BJSt9JYZkvTJ37PiN+x7J1oNdNozA/iWoTFjuNz4nig8kKgxfQh/DK2QIgRJZgySdCYaSnECpKax5LbDJgQoPHbkmtMwfCZZLbU6Pfcoz0Prwv37qE7YqBnMnUqSQVCyRlqYE4KHgt03F84m2MiuHysQmm1Kl6BzRBKg7o/llE3UgVqRnFxnEajaIa2cjoFQdSNCqZZjhY1BdVNJFmO0ShKVUKREHUjTgFVMJtFd6PsPEMXLpuRZBXoEGlRN6oMGY2sLrEbGbsSxN9wsnnUjfC6ECrFaDRlwhBBkmHOotFN5PYfRcZqLmdEKcuc4t6FlhOsCoeoG9U+9CzdliSvt0p0uV53a90Ez7mtNPu2RL3aELQSJEg6VTpvyxn0qMXM2TXPSbIXw2G3ElqWeYw6WtM65jQd7Q5bIpg5L34yCT6853B9SXxNoaRBQ7TPhkP6senI5jRAHS3OptKitETPikLwxL0YfGNo0c19AVT8DSYupDSxsdxvqdGUwrbomNaMFOYWc/Pp9f4xRe/9mCDTMLsRJZXu0asjPn/2PM4u/kg2mXJ6+DgOmbWFGQ0G4UmpRT9ROXGz3D6enXG/0FEhFlLZR3MoBDKDLinVJ84pp0SK+ucypY/hx3HwEoJbum4MGFVaXAUV1t1ILeWGLg/i/41yiZDWk3VcNvuhAafVdt82uyWoPmaIrWJhzrj4JHWM+FV4UMVakSn5iW32Xnz2bPf5bz7fjdZrsq5BmR7Lt3ozKGKlBDLZXkmpJNBfcXmlaMUVbZDYjy90KWrdjZgQanmlplPKs1dk+q3rNvPNuwxthhqCpyBhVJHjnFtgkKhiRRXFZtzUQe5JUygNlzNgEvDaopZMgFVKwFRpcGEDGhccl314iVNWCl+OnKz9bdInGpnFdN9+3LzPhs+e93aHveHn57ufjfZ+O3rxWX84HP416kbXufNpVTWZxagd3eHvskh/ln1QsljguSof5naNKdeY2KtSb43Mjx24qHZ+rlI+DcXBPCxqLOaFYBav+NZU1OzSIgRuQEmxArZgXJCesMxQum6nDhNuIPgUplrlwKDi0HcCl1Zdacy5/NDJ2AzUM7QUQGQu+unNC8QlZ5YnULEyfQikTkP6JeXGEdsMc3ia+nCEGDO24ErvbA1Hz+5KyQTpNOKCGoN7Bf6ukG/cY9eEsZWBGO2SOsKWbOd0lGrz+VJe22/DJkRlGqU3pBxSZrkTh60adDejR+t2nufSJYiqF7l6Nhxe7YVstTfcu9+TnGKhtAWpbOPwX/10TQlqrbYWmSb2tkvwMaX2hntXL2qlXtxX6lgumOAp7J8cw7mao/x5NWpvb/32933KPZF7H20o235e1Zmk1Nyu3ORw3WMF7/n3o/eX1HrmaDMVxg43atgsGkWD9gQyuAmjxjoifnpRDSIuJ9UtmGEyjdV1XxUoqRYIFhsqkANW8MFit/8sou56cw0rikfRY9l77BJj2YzL2afWXTamOiN3eo9tGKxpVgr+J6RuJfijTRUmhgyZ65XW9PdUucXBS28LlGfUHpKP3eb3sAGoaL7/279rMho/v4ROh2Y6UqRnVKkTdAOn48eEK7iW/3/i/P67f0JccmFd4U1xgYIi0XQpaRjrp1CUFnWhuUHTpwF2LNv7zvgCDaxU6Sq+n926NN+nZUKC9jSydAXYqwdwoDROFQlsplU5y4ABdQMCu3B6eHZO08v+yTFlYpm25lESsWbShZxJNsO6LDiZWTJ3JNRbeMiCwAaN1F7wHLt+cvdZH0loTdpx3So8gk8xWSXCG4cgBMISVGlhgTJVGoRK5j0u3Zzf6/Xox5MncITW0q5nlmmLKT09pKzvAAg0FvLSWEiY1iu/b310SUIqfZNWfEzAR4bbZDKZjGXr5Qh+RxyaB18GmrHsdL7/+z/g/ddqSYl/hpJmQLyz4eXTKuhTlZj70U5PBxmKYnDmlTKD/ZNjl+V2vP/fKAuGPLnMULsiGeOMy9/DhXF1EjqdcMwB5YJrJcm0nQ48nTw4DUx2iG+hlVUOmqi8wKZTTJypBUVwyiy744oDpREOWMFiLjglVXp+CwfM4kzpFdzCO4JcKGSpX00V3I7lba/Xc/+ItNOp4ZlOB27hwHUiXaDuugu+B+xSh6rmIaZSpLhvwrNXub0J38D5vIpXx/kPJRcpaCxDj1G99ABWobFXCJY4QCudoTVfOBnIMkoiKE2nYFW332GLMxTTHp1Pt8VRFQWGHof2uxGrtmvgAlwuuHWVC6ZCLSumJ2UseAKb4p9lBIMxKPzL6ugJLufu+EhVcXVAZQ3GVVZ22OI7pee0k+dIQFgjndItmzDj0UjjTD7lkgluQmNGFLrie6CkZUlw3p99nnBnIAiT+PcQKzX3UCTLXR/ICEUMTF65OdbzeKtnTNJejWRcGp5inYLhpaZw9MNv7Yl3GGdKzT2TU0yQaCgd9SgdAS4o40hlm7YbfGS6KQhQpoXi0lbsLkwlUAMBJ4kqpXUWSWgMsECVhNp98uDt5tGgwP/+u38ZeINLyjtVwSCY+YAaZ9S1h6s9mBjLydHhOQwqTwxGPJ24HTefk48nbWzWamS5RzMpGjSmpUyZtNBAlQ5H1ZirRcBVO51C45QL4Y42tbFSLQmILDXxMUhrLYqVnwuCRxuGnQ6VhjmFYY2XATLDUdOxSZQ0Ze5RWtL6hBmzVDolONtiQiXv5OUrOCsL6hnHkt7DZOxQp6siEI+jSZW1q3Meq3Tl2/Cl0m53d4JRJnpVBK40XHi+DqEfjeXk5O3ZOQz8pFOZcQL//Q9MTi7uWdw9bi2ognEwak1XbTJ3Wiqqey/u7OdeUI4gk04q+7z1gACchaNNR0srMZY0Jk3GW2CDcTTyc9atn6EmdBnxAUVdDG3RlEa0a+qgOd0XhGmNOpQwi4X96oRDrQGyJGuGxEr+Mx8fp0pQHaCmaBKy5QR8/+3ii/D7ghIL6eQJrgg9Ik9POYoUWKKVMa4hcFrQ6dKqtOjGMo0IRO/j2VReHvnSQ7tTsvczY6nvFZwg0wQ61YC541KX6xlCU0WZgVBD61J/0035yuBTxIQwE+JTZxuzOVaToTyy4mfIkKRDdQHnzSo/T1hRaLXw7A6Y9Ceb6k1FjtdktVA6vDQhxbvNbuvUwnSsJBwQIPT04GCHhOMFpzw6lvsgcUlmT5LG2uHY14YERhctLuOSPnjNjesBJuMobq9TDZzarYOhGy6xKNrqIlh7ceDree3MQ4L3gKUpXUigcZULUzrvtYw6ZHJGDV2sZM9BXe08Dg4kBAIA7uMa1Q1HH17zOTY6dEn8DWngqSmTjAqfPyXNiefpZIdK14KnwQ5eNPKX5mnwe2UBWDBRYtcVHJ+lyLKCk2GNQ+Hywq7AwavwdPL+crLzBSiC8YiLN61VwGWGOjzcZH2nBduvkZ3Dpv8LfVjrCZ0JgsEvTl9v6cHOfIvo6t0j+sa6YalHkE0OH53w6tWHF3CKs3uLPzVZTu5W3L+gNly5JPVr+ANL5kumUwN028ksdx3qikhpMQWHv8iMK8JeEgiF74BhsevCeLHb360HlKpNML4k2kwZhIXf2CekBmmji2ECkeLK7o6rVBBr9FUzyZic0UGgHqFVqDkl/rRM/Flw8hJr5cZRJqCUgm6DFQHCS+qV6F4kvRMYFwZpvHvN5dyFQw/e1x3UO4wNt9iMJ8vl8p6ld9yaV6UQ9RWqO3CfGGr8siNuvy5jIDzIcKv0qlk14zYrY+fL9tr6j8Cg6qVr3OfHDFOO5Tnq3BDmd4Z6wZNPqD+wRD7YcRfCd2CHTXRA4xQ15R2zMQqygoex830lB5B4P0YPApdCS+3wK38/QvjHV3f5OByKVHg7DfoGDObj+kbdSPAEpcEWvrV/dPIaFs/7w6jbAnMe4MvB6+ODwzdnhyRMOCbRKNrtD/tDd02jjM2ZbO10hM23E36S8b2nQxju4jI3DQ74y+cbv3y+UX++EVBBi9d2UAjGHSYb7ms8nvo+uvNFx6j6eOOyG2XKWCK5uaEQudBivabH/psDgllDb9x8dTDHVesbCVem/XXPB2nDxwwN6SX9oTnRbt/jg5H/9DR4bgce8nXJVuNUOKpctYWqhK1ss75cdysglWT0b/ddQ99adw+R34C1jw7PI3erlG0CuHMH4IZfiPtWmTaRXS8A/U+m3rrg5saDw+t1Te9ffXBFULCiJgNdrtfr/wFN+Gqb","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Document","permalink":"/docs/API-docs/v1.2/deletedocument"},"next":{"title":"Resend request mail","permalink":"/docs/API-docs/v1.2/resendrequestmail"}}');var l=n(74848),i=n(28453),r=n(57742),a=n.n(r),o=n(78178),p=n.n(o),d=n(19624),m=n.n(d),c=n(96226),u=n.n(c),h=(n(77675),n(19365),n(51107)),g=n(21312);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:"eJztWltvHLcV/iunY6CwFnuTLSftpkijyrKi1rUFXWqgXkHLmTm7wyyHnJCcXS2kBfJQ9AcUfelr/0Tf+1PyS9pDci4rrW0pCfKUB1vSzOHhufFcPs5NZNnMRKP30UuVlDlKa6LLbpSiSTQvLFcyGkVPnjyB6jWcrwo0o7E8Ras5LhAYCG4sqCmkFQuImcEUlAS7KnAsx3K3D53OS82mtuZkRp3OWAIA9JpnYDNmgWmEpNQapRUr4BJSt9JYZkvTJ37PiN+x7J1oNdNozA/iWoTFjuNz4nig8kKgxfQh/DK2QIgRJZgySdCYaSnECpKax5LbDJgQoPHbkmtMwfCZZLbU6Pfcoz0Prwv37qE7YqBnMnUqSQVCyRlqYE4KHgt03F84m2MiuHysQmm1Kl6BzRBKg7o/llE3UgVqRnFxnEajaIa2cjoFQdSNCqZZjhY1BdVNJFmO0ShKVUKREHUjTgFVMJtFd6PsPEMXLpuRZBXoEGlRN6oMGY2sLrEbGbsSxN9wsnnUjfC6ECrFaDRlwhBBkmHOotFN5PYfRcZqLmdEKcuc4t6FlhOsCoeoG9U+9CzdliSvt0p0uV53a90Ez7mtNPu2RL3aELQSJEg6VTpvyxn0qMXM2TXPSbIXw2G3ElqWeYw6WtM65jQd7Q5bIpg5L34yCT6853B9SXxNoaRBQ7TPhkP6senI5jRAHS3OptKitETPikLwxL0YfGNo0c19AVT8DSYupDSxsdxvqdGUwrbomNaMFOYWc/Pp9f4xRe/9mCDTMLsRJZXu0asjPn/2PM4u/kg2mXJ6+DgOmbWFGQ0G4UmpRT9ROXGz3D6enXG/0FEhFlLZR3MoBDKDLinVJ84pp0SK+ucypY/hx3HwEoJbum4MGFVaXAUV1t1ILeWGLg/i/41yiZDWk3VcNvuhAafVdt82uyWoPmaIrWJhzrj4JHWM+FV4UMVakSn5iW32Xnz2bPf5bz7fjdZrsq5BmR7Lt3ozKGKlBDLZXkmpJNBfcXmlaMUVbZDYjy90KWrdjZgQanmlplPKs1dk+q3rNvPNuwxthhqCpyBhVJHjnFtgkKhiRRXFZtzUQe5JUygNlzNgEvDaopZMgFVKwFRpcGEDGhccl314iVNWCl+OnKz9bdInGpnFdN9+3LzPhs+e93aHveHn57ufjfZ+O3rxWX84HP416kbXufNpVTWZxagd3eHvskh/ln1QsljguSof5naNKdeY2KtSb43Mjx24qHZ+rlI+DcXBPCxqLOaFYBav+NZU1OzSIgRuQEmxArZgXJCesMxQum6nDhNuIPgUplrlwKDi0HcCl1Zdacy5/NDJ2AzUM7QUQGQu+unNC8QlZ5YnULEyfQikTkP6JeXGEdsMc3ia+nCEGDO24ErvbA1Hz+5KyQTpNOKCGoN7Bf6ukG/cY9eEsZWBGO2SOsKWbOd0lGrz+VJe22/DJkRlGqU3pBxSZrkTh60adDejR+t2nufSJYiqF7l6Nhxe7YVstTfcu9+TnGKhtAWpbOPwX/10TQlqrbYWmSb2tkvwMaX2hntXL2qlXtxX6lgumOAp7J8cw7mao/x5NWpvb/32933KPZF7H20o235e1Zmk1Nyu3ORw3WMF7/n3o/eX1HrmaDMVxg43atgsGkWD9gQyuAmjxjoifnpRDSIuJ9UtmGEyjdV1XxUoqRYIFhsqkANW8MFit/8sou56cw0rikfRY9l77BJj2YzL2afWXTamOiN3eo9tGKxpVgr+J6RuJfijTRUmhgyZ65XW9PdUucXBS28LlGfUHpKP3eb3sAGoaL7/279rMho/v4ROh2Y6UqRnVKkTdAOn48eEK7iW/3/i/P67f0JccmFd4U1xgYIi0XQpaRjrp1CUFnWhuUHTpwF2LNv7zvgCDaxU6Sq+n926NN+nZUKC9jSydAXYqwdwoDROFQlsplU5y4ABdQMCu3B6eHZO08v+yTFlYpm25lESsWbShZxJNsO6LDiZWTJ3JNRbeMiCwAaN1F7wHLt+cvdZH0loTdpx3So8gk8xWSXCG4cgBMISVGlhgTJVGoRK5j0u3Zzf6/Xox5MncITW0q5nlmmLKT09pKzvAAg0FvLSWEiY1iu/b310SUIqfZNWfEzAR4bbZDKZjGXr5Qh+RxyaB18GmrHsdL7/+z/g/ddqSYl/hpJmQLyz4eXTKuhTlZj70U5PBxmKYnDmlTKD/ZNjl+V2vP/fKAuGPLnMULsiGeOMy9/DhXF1EjqdcMwB5YJrJcm0nQ48nTw4DUx2iG+hlVUOmqi8wKZTTJypBUVwyiy744oDpREOWMFiLjglVXp+CwfM4kzpFdzCO4JcKGSpX00V3I7lba/Xc/+ItNOp4ZlOB27hwHUiXaDuugu+B+xSh6rmIaZSpLhvwrNXub0J38D5vIpXx/kPJRcpaCxDj1G99ABWobFXCJY4QCudoTVfOBnIMkoiKE2nYFW332GLMxTTHp1Pt8VRFQWGHof2uxGrtmvgAlwuuHWVC6ZCLSumJ2UseAKb4p9lBIMxKPzL6ugJLufu+EhVcXVAZQ3GVVZ22OI7pee0k+dIQFgjndItmzDj0UjjTD7lkgluQmNGFLrie6CkZUlw3p99nnBnIAiT+PcQKzX3UCTLXR/ICEUMTF65OdbzeKtnTNJejWRcGp5inYLhpaZw9MNv7Yl3GGdKzT2TU0yQaCgd9SgdAS4o40hlm7YbfGS6KQhQpoXi0lbsLkwlUAMBJ4kqpXUWSWgMsECVhNp98uDt5tGgwP/+u38ZeINLyjtVwSCY+YAaZ9S1h6s9mBjLydHhOQwqTwxGPJ24HTefk48nbWzWamS5RzMpGjSmpUyZtNBAlQ5H1ZirRcBVO51C45QL4Y42tbFSLQmILDXxMUhrLYqVnwuCRxuGnQ6VhjmFYY2XATLDUdOxSZQ0Ze5RWtL6hBmzVDolONtiQiXv5OUrOCsL6hnHkt7DZOxQp6siEI+jSZW1q3Meq3Tl2/Cl0m53d4JRJnpVBK40XHi+DqEfjeXk5O3ZOQz8pFOZcQL//Q9MTi7uWdw9bi2ognEwak1XbTJ3Wiqqey/u7OdeUI4gk04q+7z1gACchaNNR0srMZY0Jk3GW2CDcTTyc9atn6EmdBnxAUVdDG3RlEa0a+qgOd0XhGmNOpQwi4X96oRDrQGyJGuGxEr+Mx8fp0pQHaCmaBKy5QR8/+3ii/D7ghIL6eQJrgg9Ik9POYoUWKKVMa4hcFrQ6dKqtOjGMo0IRO/j2VReHvnSQ7tTsvczY6nvFZwg0wQ61YC541KX6xlCU0WZgVBD61J/0035yuBTxIQwE+JTZxuzOVaToTyy4mfIkKRDdQHnzSo/T1hRaLXw7A6Y9Ceb6k1FjtdktVA6vDQhxbvNbuvUwnSsJBwQIPT04GCHhOMFpzw6lvsgcUlmT5LG2uHY14YERhctLuOSPnjNjesBJuMobq9TDZzarYOhGy6xKNrqIlh7ceDree3MQ4L3gKUpXUigcZULUzrvtYw6ZHJGDV2sZM9BXe08Dg4kBAIA7uMa1Q1HH17zOTY6dEn8DWngqSmTjAqfPyXNiefpZIdK14KnwQ5eNPKX5mnwe2UBWDBRYtcVHJ+lyLKCk2GNQ+Hywq7AwavwdPL+crLzBSiC8YiLN61VwGWGOjzcZH2nBduvkZ3Dpv8LfVjrCZ0JgsEvTl9v6cHOfIvo6t0j+sa6YalHkE0OH53w6tWHF3CKs3uLPzVZTu5W3L+gNly5JPVr+ANL5kumUwN028ksdx3qikhpMQWHv8iMK8JeEgiF74BhsevCeLHb360HlKpNML4k2kwZhIXf2CekBmmji2ECkeLK7o6rVBBr9FUzyZic0UGgHqFVqDkl/rRM/Flw8hJr5cZRJqCUgm6DFQHCS+qV6F4kvRMYFwZpvHvN5dyFQw/e1x3UO4wNt9iMJ8vl8p6ld9yaV6UQ9RWqO3CfGGr8siNuvy5jIDzIcKv0qlk14zYrY+fL9tr6j8Cg6qVr3OfHDFOO5Tnq3BDmd4Z6wZNPqD+wRD7YcRfCd2CHTXRA4xQ15R2zMQqygoex830lB5B4P0YPApdCS+3wK38/QvjHV3f5OByKVHg7DfoGDObj+kbdSPAEpcEWvrV/dPIaFs/7w6jbAnMe4MvB6+ODwzdnhyRMOCbRKNrtD/tDd02jjM2ZbO10hM23E36S8b2nQxju4jI3DQ74y+cbv3y+UX++EVBBi9d2UAjGHSYb7ms8nvo+uvNFx6j6eOOyG2XKWCK5uaEQudBivabH/psDgllDb9x8dTDHVesbCVem/XXPB2nDxwwN6SX9oTnRbt/jg5H/9DR4bgce8nXJVuNUOKpctYWqhK1ss75cdysglWT0b/ddQ99adw+R34C1jw7PI3erlG0CuHMH4IZfiPtWmTaRXS8A/U+m3rrg5saDw+t1Te9ffXBFULCiJgNdrtfr/wFN+Gqb",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},D=void 0,j={},y=[{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,i.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Get Document list from status"}),"\n",(0,l.jsx)(a(),{method:"get",path:"/documentlist/{doctype}",context:"endpoint"}),"\n",(0,l.jsx)(t.h3,{id:"document-types",children:"Document Types:"}),"\n",(0,l.jsx)(t.p,{children:"Retrieve a list of documents based on type"}),"\n",(0,l.jsxs)(t.ol,{children:["\n",(0,l.jsxs)(t.li,{children:["\n",(0,l.jsx)(t.p,{children:(0,l.jsx)(t.strong,{children:"Draft Documents:"})}),"\n",(0,l.jsxs)(t.ul,{children:["\n",(0,l.jsx)(t.li,{children:"Documents that are currently in draft status."}),"\n"]}),"\n"]}),"\n",(0,l.jsxs)(t.li,{children:["\n",(0,l.jsx)(t.p,{children:(0,l.jsx)(t.strong,{children:"In-Progress Documents:"})}),"\n",(0,l.jsxs)(t.ul,{children:["\n",(0,l.jsx)(t.li,{children:"Documents that are currently in progress."}),"\n"]}),"\n"]}),"\n",(0,l.jsxs)(t.li,{children:["\n",(0,l.jsx)(t.p,{children:(0,l.jsx)(t.strong,{children:"Completed Documents:"})}),"\n",(0,l.jsxs)(t.ul,{children:["\n",(0,l.jsx)(t.li,{children:"Documents that have been successfully completed with all required signatures."}),"\n"]}),"\n"]}),"\n",(0,l.jsxs)(t.li,{children:["\n",(0,l.jsx)(t.p,{children:(0,l.jsx)(t.strong,{children:"Expired Documents:"})}),"\n",(0,l.jsxs)(t.ul,{children:["\n",(0,l.jsx)(t.li,{children:"Documents that have expired and are no longer accessible."}),"\n"]}),"\n"]}),"\n",(0,l.jsxs)(t.li,{children:["\n",(0,l.jsx)(t.p,{children:(0,l.jsx)(t.strong,{children:"Declined Documents:"})}),"\n",(0,l.jsxs)(t.ul,{children:["\n",(0,l.jsx)(t.li,{children:"Documents that have been declined by the user."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,l.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,l.jsx)(g.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,l.jsx)(p(),{...n(61962)}),"\n",(0,l.jsx)(m(),{...n(70688)}),"\n",(0,l.jsx)(u(),{...n(61866)})]})}function b(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,l.jsx)(t,{...e,children:(0,l.jsx)(f,{...e})}):f(e)}},61962(e){e.exports=JSON.parse('{"parameters":[{"name":"doctype","in":"path","description":"The type of documents to retrieve","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["draft","inprogress","completed","expired","declined"]}},{"name":"limit","in":"query","required":false,"style":"form","explode":true,"schema":{"maximum":500,"type":"number"},"example":10},{"name":"skip","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"number"},"example":0}]}')},70688(e){e.exports={title:"Body"}},61866(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"FGik23bhUJ"},"file":{"type":"string","format":"string","example":"https://exampleurl.com"},"title":{"type":"string","format":"string","example":"sample doc"},"note":{"type":"string","format":"string","example":"please sign document"},"folder":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"FGik23bhUJ"},"name":{"type":"string","format":"string","example":"folder name"}},"title":"document_folder"},"owner":{"type":"string","format":"string","example":"joe bee"},"signers":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","example":"ceo"},"name":{"type":"string","example":"joe bee"},"email":{"type":"string","example":"joebee@example.com"},"phone":{"type":"string","example":"456213871"}}}},"sendInOrder":{"type":"boolean","example":true},"send_in_order_strict":{"type":"boolean","example":false},"allow_offline_sign":{"type":"boolean","description":"Whether signers can submit a copy of this document signed using an external tool for owner review. Defaults to false.","example":false},"createdAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"enableTour":{"type":"boolean","example":true},"redirect_url":{"type":"string","format":"string","example":""},"allow_modifications":{"type":"boolean","example":false},"template_id":{"type":"string","example":"template_id is only available when the document is created from a template."},"auto_reminder":{"type":"boolean","description":"Set to true to enable automatic reminders. Set to false to disable them (default behavior).","example":false},"remind_once_in_every":{"type":"number","description":"Number of days between reminders. This is only applicable when auto_reminder is set to true.","example":0}},"xml":{"name":"document"},"title":"document"}}},"title":"inline_response_200_4"}}}},"404":{"description":"Report not available!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Report not available!"}},"title":"inline_response_404_5"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/fdae908b.3960018d.js b/assets/js/fdae908b.3960018d.js deleted file mode 100644 index 068a39321..000000000 --- a/assets/js/fdae908b.3960018d.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[5678],{78377(e,t,a){a.r(t),a.d(t,{assets:()=>g,contentTitle:()=>j,default:()=>y,frontMatter:()=>h,metadata:()=>n,toc:()=>P});const n=JSON.parse('{"id":"API-docs/v1.2/createcontact","title":"Create Contact","description":"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.","source":"@site/docs/API-docs/v1.2/createcontact.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/createcontact","permalink":"/docs/API-docs/v1.2/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":"eJzVWN1u5LYVfpVTXrTZgTw/9iZFlZu4i8XWiJE1YgcL1DaMI+loRJsiGZKa8WAwQC76Br3qbR9tn6Q4lDSjGXs3MVpsW8AwNCTP4Xd++ZFrEXDuRXot3hgdMA9e3CaiIJ87aYM0WqTiqiJ44wgDQbcITi/OAJUySw8r00AwQGVpXFDkvVpB3q7WtIS8UwuhwgA5amB59ODlXJPzUBrHOhzI2hoXUAcoTN7UpIMfi0QYSw4ZyVkhUtFq7pSKRDj6uSEf/myKlUjXB8AvnFnIgiAjZZZg0WFNgRzD7RDuFPEX6cBK0Fol87jn5N6zprXweUU18hfvKB0V7DOqUSqRCI01sd/CypJIhcnuKSq1jtEHSZ4l46p03a/ywUk9F4kojasxDEfoEWureNG9YfgkNkm32cvlM6LvuoFxbmpWZSujXwxldnxyPDuZnRzPWEVuaot69VIlxpLmyLOKe5PdBRnUi5EUtBCbTSI64f2kuMs4FzY8vwtVcA3FAW+N9m04jqfTpynTJ3irsgDf5Dl5XzZKrX73kjT5fCq0w5zRL7PcVrOsejy+t+y///N8ej07mR3Hv/+JfEq6NCpOw3Pyu9XH0+OTo9n0aPrHq9k36es/pV9/M55Op38ViXis1a7QRYEhOrpP0/53Y4svsM/mcFlXHwUFlMoPBfouuIlV8/q5urg0NYVK6jksSQdYOqPnCVhF6AmCWwHOUWpQGMj9B+uEnDPu8256GbJh25BaSU13fVO4ez2d3s22Tph9ujmgcoTFCuhR+uC/rLmfwvB5w2YDw75+atiZXqCSRTzWr8wD6S9r03D70G7/NH1luyjOiz1jh+OtkZ7yxsmwEun1WjweoZVH7Xx6fbu5TQRnjGE6YY2PiDFUIhWTQ3bhyS3I+aimcUqkogrB+nQy8aiLzDyO+/6jMPPcDSdo5WQxGx+LTXIog9a+aD01Ry8V8QHnUs9/Te5256JLDmMbqT1HbeOFVn5Pq57kpHurEiE5fSrCglyMGWfHjztO9raP8TaM/QG0PX+eO1K2J8qQdAzOiF3b3+v6fSOXujTRgm74vSV9Kec6Jlj0wCHF/UAqNzUxMwwVwWjUi3z82z+3UqPRlpnGUhjf6Bv9vnFgzZJc2ShAXUCp6FFmiqIY1XFuy5I9Yd1xZKkDzR2T0ELOZUAVGTH3sRwtZlJJriBeZlp+PChCP4YPFYWKInX+gyNAKGhBigsPsAmmxsCqerywNO6hZL6eAELWeKnJeyBdoc55YZ8OCRgHqIF0IGed9AQ+OEYtW2xGB8f9p0aNc2LdCQydVZCSXDPgTNb4AN6oJkIGPnaMowJ6gzRR4aMT3z5angIe5SA7qji+C4J5IwvyCeSmIPAxQ9gEXUBGPoBlLDInz0obrUz+EAPIfA2s4f4lUYEp9zCyeHCoPZOCFksfg63DrDNM/KgFOBr95IkjfC71g09Hoxt9BNfbvPpAmZeBbr/q63C5XD6pv1f7Mu9k+EuTwY9kjZfBuNVOei5D1WSxZodKtj9aTe9IU8yfQUXudBQm909bAI9OKlJ2ckmBM8RPTi/OYst/BR9/+TucEzoNlVm22Zo3jtQK5v1W7Lk28q3bth07XuOwCRV7PG+Tr7ub9R78UGH4+Ms/PPxAS5C6Kyk2ZTR6RwGuqLZ8SsPvYe/nufRhNErBUW0WVECjNXFo0K12dzofoXniAebt1lEplYICA0LpTN3dNwcSY976RpRS0Z1F75fGFTdicE3EoqCCkXaXxdAhSqBlcIOBbsWu3GSoBtOFw3J3re2gqjJiAmea0Caw7e6rPZroVOtMoDzaVJQ96Hj3vjNlGQ96VvObkMedD8AP9o9aofHsTr7Sa+Q+Zrg6fPvZbrjtVIwvVCTdVlsPsPX2nTOKnkfGVdo/AbTMgat031FP/Pqrjn4SKTbYNpmS+aHBYzjNc7Ls2AWqhnwKo1GLaDSCrwoqsVHhVQKj0ULSkkf5Gy1HiX+N4bLDX3Ojq3BBgAGYeAYwnZcwNI5gKYs5hW+hVTQU0Kab9N9Cr9pDjatOn17189FU0wTAgeLuhsuuGN/waXhwhu+fco5Kcuy7GN5dUVvZFfF13wyAe8S/00zaK13Lo5gEdmc9WvndoZ5I5sjV/n15SW4hc+oIzSf66CQunohEKJmT9kN2cfru4hwWJ+OpSAbM6De01Mn52Zu3P1y+ZTAcgtZhs/F0PI0XXONDjXqw0/6D2CGhWO/Y83/5+axjcYEew8QqlJE7R9esO9p7ffCodpuIimlxei3W6ww9/eTUZsPDPzfkmFPfJmKBTnJLiIw66Rkg8+QHWnXXFNLh6Iq35+WqacnkwUWCKWwr0VbjZ9cOmfvF+8srkYise/irTcEyDpf8KIhLkYr4dhipR3y247G1UKjnDc4jE406mbTyubXPeB8i4+0+2Kp+Sq8GCPepcGsG/2ejnhVYr1s2vdls17dTn5ToHNuv5vDdbjabfwG8xZhd","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get your API credits","permalink":"/docs/API-docs/v1.2/getcredits"},"next":{"title":"Get Contact","permalink":"/docs/API-docs/v1.2/getcontact"}}');var o=a(74848),s=a(28453),r=a(57742),i=a.n(r),c=a(78178),p=a.n(c),l=a(19624),d=a.n(l),m=a(96226),u=a.n(m),f=(a(77675),a(19365),a(51107)),w=a(21312);const h={id:"createcontact",title:"Create Contact",description:"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.",sidebar_label:"Create Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVWN1u5LYVfpVTXrTZgTw/9iZFlZu4i8XWiJE1YgcL1DaMI+loRJsiGZKa8WAwQC76Br3qbR9tn6Q4lDSjGXs3MVpsW8AwNCTP4Xd++ZFrEXDuRXot3hgdMA9e3CaiIJ87aYM0WqTiqiJ44wgDQbcITi/OAJUySw8r00AwQGVpXFDkvVpB3q7WtIS8UwuhwgA5amB59ODlXJPzUBrHOhzI2hoXUAcoTN7UpIMfi0QYSw4ZyVkhUtFq7pSKRDj6uSEf/myKlUjXB8AvnFnIgiAjZZZg0WFNgRzD7RDuFPEX6cBK0Fol87jn5N6zprXweUU18hfvKB0V7DOqUSqRCI01sd/CypJIhcnuKSq1jtEHSZ4l46p03a/ywUk9F4kojasxDEfoEWureNG9YfgkNkm32cvlM6LvuoFxbmpWZSujXwxldnxyPDuZnRzPWEVuaot69VIlxpLmyLOKe5PdBRnUi5EUtBCbTSI64f2kuMs4FzY8vwtVcA3FAW+N9m04jqfTpynTJ3irsgDf5Dl5XzZKrX73kjT5fCq0w5zRL7PcVrOsejy+t+y///N8ej07mR3Hv/+JfEq6NCpOw3Pyu9XH0+OTo9n0aPrHq9k36es/pV9/M55Op38ViXis1a7QRYEhOrpP0/53Y4svsM/mcFlXHwUFlMoPBfouuIlV8/q5urg0NYVK6jksSQdYOqPnCVhF6AmCWwHOUWpQGMj9B+uEnDPu8256GbJh25BaSU13fVO4ez2d3s22Tph9ujmgcoTFCuhR+uC/rLmfwvB5w2YDw75+atiZXqCSRTzWr8wD6S9r03D70G7/NH1luyjOiz1jh+OtkZ7yxsmwEun1WjweoZVH7Xx6fbu5TQRnjGE6YY2PiDFUIhWTQ3bhyS3I+aimcUqkogrB+nQy8aiLzDyO+/6jMPPcDSdo5WQxGx+LTXIog9a+aD01Ry8V8QHnUs9/Te5256JLDmMbqT1HbeOFVn5Pq57kpHurEiE5fSrCglyMGWfHjztO9raP8TaM/QG0PX+eO1K2J8qQdAzOiF3b3+v6fSOXujTRgm74vSV9Kec6Jlj0wCHF/UAqNzUxMwwVwWjUi3z82z+3UqPRlpnGUhjf6Bv9vnFgzZJc2ShAXUCp6FFmiqIY1XFuy5I9Yd1xZKkDzR2T0ELOZUAVGTH3sRwtZlJJriBeZlp+PChCP4YPFYWKInX+gyNAKGhBigsPsAmmxsCqerywNO6hZL6eAELWeKnJeyBdoc55YZ8OCRgHqIF0IGed9AQ+OEYtW2xGB8f9p0aNc2LdCQydVZCSXDPgTNb4AN6oJkIGPnaMowJ6gzRR4aMT3z5angIe5SA7qji+C4J5IwvyCeSmIPAxQ9gEXUBGPoBlLDInz0obrUz+EAPIfA2s4f4lUYEp9zCyeHCoPZOCFksfg63DrDNM/KgFOBr95IkjfC71g09Hoxt9BNfbvPpAmZeBbr/q63C5XD6pv1f7Mu9k+EuTwY9kjZfBuNVOei5D1WSxZodKtj9aTe9IU8yfQUXudBQm909bAI9OKlJ2ckmBM8RPTi/OYst/BR9/+TucEzoNlVm22Zo3jtQK5v1W7Lk28q3bth07XuOwCRV7PG+Tr7ub9R78UGH4+Ms/PPxAS5C6Kyk2ZTR6RwGuqLZ8SsPvYe/nufRhNErBUW0WVECjNXFo0K12dzofoXniAebt1lEplYICA0LpTN3dNwcSY976RpRS0Z1F75fGFTdicE3EoqCCkXaXxdAhSqBlcIOBbsWu3GSoBtOFw3J3re2gqjJiAmea0Caw7e6rPZroVOtMoDzaVJQ96Hj3vjNlGQ96VvObkMedD8AP9o9aofHsTr7Sa+Q+Zrg6fPvZbrjtVIwvVCTdVlsPsPX2nTOKnkfGVdo/AbTMgat031FP/Pqrjn4SKTbYNpmS+aHBYzjNc7Ls2AWqhnwKo1GLaDSCrwoqsVHhVQKj0ULSkkf5Gy1HiX+N4bLDX3Ojq3BBgAGYeAYwnZcwNI5gKYs5hW+hVTQU0Kab9N9Cr9pDjatOn17189FU0wTAgeLuhsuuGN/waXhwhu+fco5Kcuy7GN5dUVvZFfF13wyAe8S/00zaK13Lo5gEdmc9WvndoZ5I5sjV/n15SW4hc+oIzSf66CQunohEKJmT9kN2cfru4hwWJ+OpSAbM6De01Mn52Zu3P1y+ZTAcgtZhs/F0PI0XXONDjXqw0/6D2CGhWO/Y83/5+axjcYEew8QqlJE7R9esO9p7ffCodpuIimlxei3W6ww9/eTUZsPDPzfkmFPfJmKBTnJLiIw66Rkg8+QHWnXXFNLh6Iq35+WqacnkwUWCKWwr0VbjZ9cOmfvF+8srkYise/irTcEyDpf8KIhLkYr4dhipR3y247G1UKjnDc4jE406mbTyubXPeB8i4+0+2Kp+Sq8GCPepcGsG/2ejnhVYr1s2vdls17dTn5ToHNuv5vDdbjabfwG8xZhd",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},j=void 0,g={},P=[];function C(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(f.default,{as:"h1",className:"openapi__heading",children:"Create Contact"}),"\n",(0,o.jsx)(i(),{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)(f.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,o.jsx)(w.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,o.jsx)(p(),{parameters:void 0}),"\n",(0,o.jsx)(d(),{...a(21305)}),"\n",(0,o.jsx)(u(),{...a(48047)})]})}function y(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(C,{...e})}):C(e)}},21305(e){e.exports=JSON.parse('{"title":"Body","body":{"description":"Provide below parameter to create contact","content":{"application/json":{"schema":{"required":["email","name"],"type":"object","properties":{"name":{"type":"string","format":"string","example":"joe bee"},"email":{"type":"string","format":"string","example":"joebee@example.com"},"phone":{"type":"string","format":"string","example":"1232131321"},"company":{"type":"string","format":"string","example":"opensign"},"job_title":{"type":"string","format":"string","example":"dev"}},"title":"createcontact_body"}}},"required":true}}')},48047(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Contact created successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"ph1bhx2jp"},"name":{"type":"string","format":"string","example":"joe bee"},"email":{"type":"string","format":"string","example":"joebee@example.com"},"phone":{"type":"string","format":"string","example":"4131231231"},"company":{"type":"string","format":"string","example":"opensign"},"job_title":{"type":"string","format":"string","example":"dev"},"createdAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"xml":{"name":"contactdetails"},"title":"contact"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"401":{"description":"Contact already exists!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Contact already exists!"}},"title":"inline_response_401_1"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/fdae908b.87ba8777.js b/assets/js/fdae908b.87ba8777.js new file mode 100644 index 000000000..2e56fec38 --- /dev/null +++ b/assets/js/fdae908b.87ba8777.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[5678],{78377(e,t,a){a.r(t),a.d(t,{assets:()=>y,contentTitle:()=>f,default:()=>U,frontMatter:()=>x,metadata:()=>n,toc:()=>b});const n=JSON.parse('{"id":"API-docs/v1.2/createcontact","title":"Create Contact","description":"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.","source":"@site/docs/API-docs/v1.2/createcontact.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/createcontact","permalink":"/docs/API-docs/v1.2/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":"eJzVGdtuG8f1V07XQGERS1KUnRRlijSOrDhG3FgQpRqoKGiHu4fcMWdnNjOzSxESgTwU/YCiL33tT/S9n+IvKc7MznJJ+RIhRdoCvkgzZ879vreRZQsTjS+jYyUtS62JruIoQ5NqXlquZDSOznOEY43MIjRA8Oz0JTAh1MrAWlVgFeB8rrQVaIxYQ+qhJa4gbdCCzZmFlEmg98yA4QuJ2sBcacKhgRel0pZJC5lKqwKlNYMojlSJmhEnL7NoHHnMDdIojjT+UKGxX6tsHY1v9xg/1armGcIMhVpByTQr0KImdhsOt4joJ5SWkLCyFDx1NIdvDWG6jUyaY8HoJ6LINWakMywYF1EcSVYg6c2uS4zGkZq9RYe01MS95WjopYMa3wYoYzWXiyiO5koXzHZP8IYVpSCgt4rYx2gTN8Qe/n6G+FVzMEhVQajKXMkHszI6enI0ejJ6cjQiFKkqSibXD0WiSpRkeULxVs2uLbfiwZxkWEebTRw1j3ed4npGvrCh+62prK7QHZhSSePNcXR4eN9lgoN7lBmYKk3RmHklxPpXD3GTj7uCPyaPfpjkZT6a5TdHb0vS3/+5Pz0dPRkduT//E/4UN26UPbPve7+FPjo8etIfHfYPf3M++nz89Lfjzz4fHB4e/imKo5tCbAM9yph1ig5uGn6vyuwXoLPZB2viI0PLuDDdByELblzUPH1fXExUgTbncgErlBZWWslFDKVAZhCsXgNbMC5BMIv6PxgnqLXSH1fTwzjrpg0uBZd4HZLC9dPDw+tRq4TRh5MDExpZtga84caaX1bcD/HwccFGHcE+uy/YS1kzwTNX1s/VEuUvK1OXvPXk77sv90DuPtoRtnvuhTSYVprbdTS+vI1u+qzkfX8/vrzaXMUReYyidqJUxnHMbB6No+F+d2FQ16iNQ1NpEY2j3NrSjIdDw2Q2UzeDkH8EmxnKhkNW8mE9GhxFm3j/DSvLB8Fj1X/oE2PZgsvFp95dbVU0ITN6S+0oqrUXK/l3uA5NzngHKo44uU+OLEPtbEbecbbtyU6CjVszhgLU1p/3lZS2onSbjk6N2Kb9nawfEjmXc+UkaI5flygnfCGdgzkN7Le4jyDAvPvzP1qwqZzKL6HXowaYKPaNqnSK8FyllcPHhEUtmeU1wrsf/wazigvrOtoMaxQUBiYGqytDvcRsDSgt6lJzg2bQ6xH+Lt0Fr9E31AxIVoEWYyi1yqqUGO03Id8n0ZmtNEIpmKXSBjbXqlrkwMBwuRAYw9nJ5HxeCZJmABOU2bavdiy2SGIomGQLBIsF4UPHM0uXDoQyq7HMVga4BI1MgOUFxsBkBqyyqqBG2nXwKC3X2JIBweeYrlPhlcOEgBW3uaos1CgzpUGodNnnckCK6Pf79N+jR/ACrSWqE8u0xYxOT2rUa2iafSgqQ6OE1mtPt80bxKHNEZKOkybg3dMRSZJkKjuXY/gdYdgefNnATGWv9+4vf4XLb9WK5oUFShpDcI/g1eMQeZlKzf2Qo9NhjqIcTrxQZvjs9KVLsQfe/t8rC4YsucpRI5Ga4YLL38MFla8coddrcg2grLlWklTb68Hj5CfnouSA8JZaWUVB3VqBzeeYOlUL8uCMWbZnimOlEY5ZyWZccMrodH4Hx8ziQuk13MEbGuvIZWm0yxTcTeVdv993fwm013sevK7Xg7tmkIzBoMxi8K1QDBprtWx8KkPy+6179oPZt+7bYD4P/uowf11xkYHGyrCZ6DizExdKjf1SsBQzWPFsgdZ84XggzSiJoDRFwbodSxsSExTzPsWnI/EieIGhYwfajapWrw0W4LLm1pVNmNMI2iA9rWaCp7DL/iRnGoFB6S9D6Akuly58pApYBTcWwmwTcD7XbG7hjdJLouQxsho73Cnd0QkzkNEL41Q+55IJ7h2u8K1SwBvWAg7jH3yecDHQMNMUS5gptSQXW2hWFMzylAmxDki+USJD7XG81gsmidaWMy4Njeltmn6uyR3n/lHA8QZnuVJLj+QMUyQYSkd9SkeANWUcqSyfN52KAe+ZGtRKAsqsVFzagO7CBIbO0GqONQJLU1VJ6zSSasy4BaokNDeQBe92Q4Mc/92PfzfwPa4o74SC8YjCRiAj5QQLBxpMTGXy4uQchsESwzHPEkdx95xsnEBOFpwhSjBWIyuorcucN2jMKpnRsqRdaxggB9JYqBozh7LXKzXOuRAutIEbkGoFGm2lCY9BemtRrGGuVREsukXY61FpWJIbtpMzIDO82aEoaaoCB0HqU2bMSumsf6qVxZRK3unzb2BSlbTYmUq6h2QazbnA67IBnkZJyNohzmmAp3QoYaW0o+4iGGWq12WD1QwCXsxAyfFUJqevJ+fQtHBBjQn865+QnF7c07g77jwIzjgcB7jrXTAXLQHq3sUePXdBOYJUmgT9vJ7PyYAwaUKbQksrMZUTtKQXt1C7Vh7qmp5OozF1Dwh3MGfCYAJKwgcEdT70HklpN3dD7Tu3ghoQlxypQ+E+Tzb02oRDrQGyNG+TRWvfifePMyWoDlBTlDTZMgHf/Dv/YmmKJSUWkskDXGslkCw95ygyYKlWxriGwElB0aVVZdEM4DzXiEDw3p9NsPLYlx6iTskec1ZzCu79gtPwlEDvcYZzVgl74FKX6xmapooyAw2I1qX+bTflK4NPEUnNcUV42mxjnJe23Q0pSiNBgZJiHZJ0U138ejTk54SVpVa1R3fMpI9sqjcBHG9Ia03p8Nw0Kd4Ru2tTC9MzJeFYlWt4fHx8QMzxklMencpnbuWaTKM03Wq7CftWkcCEkguXcUkeN0CS4ZNpNOu+U7KVNW6dIfZlw3lbWwRbKw59PW+NeUItPrAs02god1BWw4ziveVRN5mcUUM3U7KfkmTdPA5uUAAlU9w1ADetQbMBvOJL3MoQE/s73MBjU6U5FT4fJduI51lyQKWr5lmjB88a2UvzrLF70ADUTFQYu4LjsxRpVnBSLFVTwKK0a2BaszU8Ti6vkoMvQBXcOixetVYBlznq5nAX9V4L9qxmXLhIPdn2f00f1jmhmKCNx8XZq/f0YBPfIrp694C+sW1Y2hFkF8NHx8z29ckFnOHi3uNPjbfJfsX9I2rDlUtSv4avWbpcMZ0ZOKap0HLXoa4JlB6Tc7ilLcwCYD9tAIXvgKEeOTeuR4NRO6CENsH4kmhzZRBqT9gnJNbaQ1HZ4gZmQe8Oq1Qw0+irZpozuaBAoB6hU6g5Jf6sSn0sOH4JtXLjKBNQSfqQAsrmqFfUK0lFPr6rjguDNN694nLp3KEPl20H9QZnhlvcjier1eqepg/cm28qISD06C7gPjHU+GcvuP22msEZlspwq/R6+2rBbV7NnC27b9tfGgShl26XTj9nmHIoz1EXBtQcJqhrnn5C/KEl8OHBlLYIe7uP3e2AxjlqyjtmZxRkJW/GzsvABxB7P0cOvwr3+ydanjU7Elbyr/bxuCUYifB63sjbLII+Lm8UR4KnKE13K/PsxekrqJ8MDqO4s1H6CbYcvnp5fPL95ISYacKEtjaDw8Gh+zCgjC2Y7FDa/ZC4v4i53W4d/8ufHZvtl8UbOywF427n6FRz26wLL/c+Rl7FUU7rxPFldHtLOeFCi82Gjn+oUNMu8iqOaqY5JQ+3iYzD5oz2i0tcN+tdlLZ/TuQJXFR+Cbe3gKXVn3/xzLVbH4XtbjypeYziaNZ8MC1URm80W9HHVLaKxpH75uoGKPe5k85uI8HkomILt8FzOGnZxyrSQ3dTuHSbwuYHkipcyXWHw90VoheD/iWh3vvg9tZvITebFt5fffBFo9gATea72mw2/wY1n9/k","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get your API credits","permalink":"/docs/API-docs/v1.2/getcredits"},"next":{"title":"Get Contact","permalink":"/docs/API-docs/v1.2/getcontact"}}');var o=a(74848),s=a(28453),r=a(57742),c=a.n(r),i=a(78178),l=a.n(i),p=a(19624),d=a.n(p),m=a(96226),g=a.n(m),u=(a(77675),a(19365),a(51107)),j=a(21312);const x={id:"createcontact",title:"Create Contact",description:"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.",sidebar_label:"Create Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVGdtuG8f1V07XQGERS1KUnRRlijSOrDhG3FgQpRqoKGiHu4fcMWdnNjOzSxESgTwU/YCiL33tT/S9n+IvKc7MznJJ+RIhRdoCvkgzZ879vreRZQsTjS+jYyUtS62JruIoQ5NqXlquZDSOznOEY43MIjRA8Oz0JTAh1MrAWlVgFeB8rrQVaIxYQ+qhJa4gbdCCzZmFlEmg98yA4QuJ2sBcacKhgRel0pZJC5lKqwKlNYMojlSJmhEnL7NoHHnMDdIojjT+UKGxX6tsHY1v9xg/1armGcIMhVpByTQr0KImdhsOt4joJ5SWkLCyFDx1NIdvDWG6jUyaY8HoJ6LINWakMywYF1EcSVYg6c2uS4zGkZq9RYe01MS95WjopYMa3wYoYzWXiyiO5koXzHZP8IYVpSCgt4rYx2gTN8Qe/n6G+FVzMEhVQajKXMkHszI6enI0ejJ6cjQiFKkqSibXD0WiSpRkeULxVs2uLbfiwZxkWEebTRw1j3ed4npGvrCh+62prK7QHZhSSePNcXR4eN9lgoN7lBmYKk3RmHklxPpXD3GTj7uCPyaPfpjkZT6a5TdHb0vS3/+5Pz0dPRkduT//E/4UN26UPbPve7+FPjo8etIfHfYPf3M++nz89Lfjzz4fHB4e/imKo5tCbAM9yph1ig5uGn6vyuwXoLPZB2viI0PLuDDdByELblzUPH1fXExUgTbncgErlBZWWslFDKVAZhCsXgNbMC5BMIv6PxgnqLXSH1fTwzjrpg0uBZd4HZLC9dPDw+tRq4TRh5MDExpZtga84caaX1bcD/HwccFGHcE+uy/YS1kzwTNX1s/VEuUvK1OXvPXk77sv90DuPtoRtnvuhTSYVprbdTS+vI1u+qzkfX8/vrzaXMUReYyidqJUxnHMbB6No+F+d2FQ16iNQ1NpEY2j3NrSjIdDw2Q2UzeDkH8EmxnKhkNW8mE9GhxFm3j/DSvLB8Fj1X/oE2PZgsvFp95dbVU0ITN6S+0oqrUXK/l3uA5NzngHKo44uU+OLEPtbEbecbbtyU6CjVszhgLU1p/3lZS2onSbjk6N2Kb9nawfEjmXc+UkaI5flygnfCGdgzkN7Le4jyDAvPvzP1qwqZzKL6HXowaYKPaNqnSK8FyllcPHhEUtmeU1wrsf/wazigvrOtoMaxQUBiYGqytDvcRsDSgt6lJzg2bQ6xH+Lt0Fr9E31AxIVoEWYyi1yqqUGO03Id8n0ZmtNEIpmKXSBjbXqlrkwMBwuRAYw9nJ5HxeCZJmABOU2bavdiy2SGIomGQLBIsF4UPHM0uXDoQyq7HMVga4BI1MgOUFxsBkBqyyqqBG2nXwKC3X2JIBweeYrlPhlcOEgBW3uaos1CgzpUGodNnnckCK6Pf79N+jR/ACrSWqE8u0xYxOT2rUa2iafSgqQ6OE1mtPt80bxKHNEZKOkybg3dMRSZJkKjuXY/gdYdgefNnATGWv9+4vf4XLb9WK5oUFShpDcI/g1eMQeZlKzf2Qo9NhjqIcTrxQZvjs9KVLsQfe/t8rC4YsucpRI5Ga4YLL38MFla8coddrcg2grLlWklTb68Hj5CfnouSA8JZaWUVB3VqBzeeYOlUL8uCMWbZnimOlEY5ZyWZccMrodH4Hx8ziQuk13MEbGuvIZWm0yxTcTeVdv993fwm013sevK7Xg7tmkIzBoMxi8K1QDBprtWx8KkPy+6179oPZt+7bYD4P/uowf11xkYHGyrCZ6DizExdKjf1SsBQzWPFsgdZ84XggzSiJoDRFwbodSxsSExTzPsWnI/EieIGhYwfajapWrw0W4LLm1pVNmNMI2iA9rWaCp7DL/iRnGoFB6S9D6Akuly58pApYBTcWwmwTcD7XbG7hjdJLouQxsho73Cnd0QkzkNEL41Q+55IJ7h2u8K1SwBvWAg7jH3yecDHQMNMUS5gptSQXW2hWFMzylAmxDki+USJD7XG81gsmidaWMy4Njeltmn6uyR3n/lHA8QZnuVJLj+QMUyQYSkd9SkeANWUcqSyfN52KAe+ZGtRKAsqsVFzagO7CBIbO0GqONQJLU1VJ6zSSasy4BaokNDeQBe92Q4Mc/92PfzfwPa4o74SC8YjCRiAj5QQLBxpMTGXy4uQchsESwzHPEkdx95xsnEBOFpwhSjBWIyuorcucN2jMKpnRsqRdaxggB9JYqBozh7LXKzXOuRAutIEbkGoFGm2lCY9BemtRrGGuVREsukXY61FpWJIbtpMzIDO82aEoaaoCB0HqU2bMSumsf6qVxZRK3unzb2BSlbTYmUq6h2QazbnA67IBnkZJyNohzmmAp3QoYaW0o+4iGGWq12WD1QwCXsxAyfFUJqevJ+fQtHBBjQn865+QnF7c07g77jwIzjgcB7jrXTAXLQHq3sUePXdBOYJUmgT9vJ7PyYAwaUKbQksrMZUTtKQXt1C7Vh7qmp5OozF1Dwh3MGfCYAJKwgcEdT70HklpN3dD7Tu3ghoQlxypQ+E+Tzb02oRDrQGyNG+TRWvfifePMyWoDlBTlDTZMgHf/Dv/YmmKJSUWkskDXGslkCw95ygyYKlWxriGwElB0aVVZdEM4DzXiEDw3p9NsPLYlx6iTskec1ZzCu79gtPwlEDvcYZzVgl74FKX6xmapooyAw2I1qX+bTflK4NPEUnNcUV42mxjnJe23Q0pSiNBgZJiHZJ0U138ejTk54SVpVa1R3fMpI9sqjcBHG9Ia03p8Nw0Kd4Ru2tTC9MzJeFYlWt4fHx8QMzxklMencpnbuWaTKM03Wq7CftWkcCEkguXcUkeN0CS4ZNpNOu+U7KVNW6dIfZlw3lbWwRbKw59PW+NeUItPrAs02god1BWw4ziveVRN5mcUUM3U7KfkmTdPA5uUAAlU9w1ADetQbMBvOJL3MoQE/s73MBjU6U5FT4fJduI51lyQKWr5lmjB88a2UvzrLF70ADUTFQYu4LjsxRpVnBSLFVTwKK0a2BaszU8Ti6vkoMvQBXcOixetVYBlznq5nAX9V4L9qxmXLhIPdn2f00f1jmhmKCNx8XZq/f0YBPfIrp694C+sW1Y2hFkF8NHx8z29ckFnOHi3uNPjbfJfsX9I2rDlUtSv4avWbpcMZ0ZOKap0HLXoa4JlB6Tc7ilLcwCYD9tAIXvgKEeOTeuR4NRO6CENsH4kmhzZRBqT9gnJNbaQ1HZ4gZmQe8Oq1Qw0+irZpozuaBAoB6hU6g5Jf6sSn0sOH4JtXLjKBNQSfqQAsrmqFfUK0lFPr6rjguDNN694nLp3KEPl20H9QZnhlvcjier1eqepg/cm28qISD06C7gPjHU+GcvuP22msEZlspwq/R6+2rBbV7NnC27b9tfGgShl26XTj9nmHIoz1EXBtQcJqhrnn5C/KEl8OHBlLYIe7uP3e2AxjlqyjtmZxRkJW/GzsvABxB7P0cOvwr3+ydanjU7Elbyr/bxuCUYifB63sjbLII+Lm8UR4KnKE13K/PsxekrqJ8MDqO4s1H6CbYcvnp5fPL95ISYacKEtjaDw8Gh+zCgjC2Y7FDa/ZC4v4i53W4d/8ufHZvtl8UbOywF427n6FRz26wLL/c+Rl7FUU7rxPFldHtLOeFCi82Gjn+oUNMu8iqOaqY5JQ+3iYzD5oz2i0tcN+tdlLZ/TuQJXFR+Cbe3gKXVn3/xzLVbH4XtbjypeYziaNZ8MC1URm80W9HHVLaKxpH75uoGKPe5k85uI8HkomILt8FzOGnZxyrSQ3dTuHSbwuYHkipcyXWHw90VoheD/iWh3vvg9tZvITebFt5fffBFo9gATea72mw2/wY1n9/k",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},f=void 0,y={},b=[];function z(e){const t={p:"p",...(0,s.R)(),...e.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)(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)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,o.jsx)(j.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,o.jsx)(l(),{parameters:void 0}),"\n",(0,o.jsx)(d(),{...a(21305)}),"\n",(0,o.jsx)(g(),{...a(48047)})]})}function U(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(z,{...e})}):z(e)}},21305(e){e.exports=JSON.parse('{"title":"Body","body":{"description":"Provide below parameter to create contact","content":{"application/json":{"schema":{"required":["email","name"],"type":"object","properties":{"name":{"type":"string","format":"string","example":"joe bee"},"email":{"type":"string","format":"string","example":"joebee@example.com"},"phone":{"type":"string","format":"string","example":"1232131321"},"company":{"type":"string","format":"string","example":"opensign"},"job_title":{"type":"string","format":"string","example":"dev"}},"title":"createcontact_body"}}},"required":true}}')},48047(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Contact created successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"ph1bhx2jp"},"name":{"type":"string","format":"string","example":"joe bee"},"email":{"type":"string","format":"string","example":"joebee@example.com"},"phone":{"type":"string","format":"string","example":"4131231231"},"company":{"type":"string","format":"string","example":"opensign"},"job_title":{"type":"string","format":"string","example":"dev"},"createdAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"xml":{"name":"contactdetails"},"title":"contact"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"401":{"description":"Contact already exists!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Contact already exists!"}},"title":"inline_response_401_1"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/fdf3f392.13d45470.js b/assets/js/fdf3f392.13d45470.js deleted file mode 100644 index 80997dcf3..000000000 --- a/assets/js/fdf3f392.13d45470.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[5740],{70328(t,e,a){a.r(e),a.d(e,{assets:()=>S,contentTitle:()=>g,default:()=>h,frontMatter:()=>v,metadata:()=>n,toc:()=>b});const n=JSON.parse('{"id":"API-docs/v1.2/getcontact","title":"Get Contact","description":"The Get Contact API allows you to retrieve details about a specific contact.","source":"@site/docs/API-docs/v1.2/getcontact.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/getcontact","permalink":"/docs/API-docs/v1.2/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":"eJy9WFFvGzcS/itTPtwlwlqSHbeHU19qFIFrnNEEtYsAZxsGdzmrpc0lWXJWsiAI6MP9g3vqa39afslhuLvSynbaulcECBwtOTP8ZsiZ+ci1IDmPYnYlvnWWZEFR3GRCYSyC9qSdFTNxWSGcIkEnASfvz0Aa45YRVq4BchCQgsYFgkKS2kSQuWsIJESPhS51AUWrOxaZcB6DZNNnSszEHKmbE5nwMsgaCQMjWgsraxQz0c3faiUyoRmRl1SJxzBdfocFnSlwJexMBvyp0QGVmFFoMBORVoaNRl17gyIT+OCNUyhmpTSRBYoKaylma0ErnyQpaDsXmShdqCUNR/BBJisz4b87zKviqPK52GxueNnonY0Y2dDRdMr/7cONTVFgjGVjYBsRkSVn0RLLS++NLtLE5C6y0voputZrjl1gM6TbJftgvNiP6jCvHo7uvNhkXfxfZuDOIeSIrI611OZP6OeI33QD48LVbMpXzr4YyvHhm8Oj9I9NFK720q5easR5tFHPLZu4c/ktaTIvRqJwkSAElITqhJ7T30kfTY/eHBxOD6b/uDz8anb8z9mXX42n0+m/RSYe6hTQLjGUpBToDtP2u/HqM6yzeSzWJV1XA4YKfTpuNqx1/Fw6XLgaqdJ2Dku0BMvg7DwDb1BGBAorkHOpLRhJGL746/IEQ3Dht8P0MmSbgdvaGm3xtq8Ft8fT6e3hNgjHT4PQV1jrCErXWPV5PX1m+d925/j2aOvOl0/dObMLabRKDePS3aP9vO4Ml6d2+aeHVrdCaV7sOTscb52MWDRB0yo1p4cD6fVBOz+7uuGiz+fEdU0tdTOqxExMutM/We8a2UawtbDoO10TjJiJisjH2WQSpVW5exj3tcfIPHIlnEivJ4vD8ZHYZI91pPcvksfm4KUqkeRc2/nv6d3sAnXBm9nu1164trsmvf4XrkTfavakul5foVQY0s5pW7qk3O3RO4/2Qs9t2uG0+GNO8AFN4WpkjkIVwmjUq3z8z69brdEIlCuaGi2lszi+ttf2XRPAuyUGbtDSKigNPujcYFLDOs1tCVBEWRuM0axAW8J5kISg9FyTNMBx4vJRSC9zbTQfYRZzrB1gkAVxDB8qpAoDT/09IEhQuEDDJx9kQ66WxKZ6vLB04b5kKpaBhLyJ2mKMgLaStmDBficycAGkBbSEwQcdESIFRq1bbM5S4NyvpZVzZNsZDIOl0Gg+rhBc3kSC6EyTIANXexdQQe+QRVQxBfEtc6uAwKPcfwNWfGwWCPNGK4wZFE4hxJSx7IJVkGMk8IxFFxjZaGONK+7TBpaNMeAdFxAtDTO9IUZWpyBt5F7cYun3YBswHxzTLmwBjkY/RuQdPtf2Ps5Go2t7AFfbc/UB86gJb171KbBcLp8c/df7Oqeavmty+AG9i5pcWO2055qqJk/pMjSy/WgtnaLFdH4GybCzoVwRn2Yfj04qNH5ygcQnJE5O3p+lmvsaPv78XzhHGSxUbtme1qIJaFYw75fiyLU734ZtWzKhdOngVRzxoj18TKkxUh/BD5Wkjz//EuF7XIK2XUqxK6MRXxsusfbcHOFvsPd5riONRjMIWLsFKmisRd4aGVawuwgkaBF5gFCBD1hqY0BJklAGV6fswjDQGPPS16LUBm+9jHHpgroWOwGQSqFipC0fA+oQZdASp8FAJ7FLN03VYFoFWdJutoVqyoQJgmuoPcA+uIVWCD2aFFQfHGGRfFJlDzpdq25dWaZOy2b+EPK08iPwg/WTVWgih5McoJVcxxxnR2x/tgtuKxXjowp12FrrAbbRvg3O4PPIOEtboQht6+Ys3Q/Uk7j+bqCf7BQ77Jvc6OKxw2M4KQr0HNiFNA3GGYxGLaLRCF4pLGVj6HUGo9FC45JH+bf0vEv8NYaLDn/Nha6SCwRJwHyPwHVRktQEhKVWc6SvoTU0VLCum4xfQ286Qi1XnT276ueTq91teWu4u7VyKMbX3Aoftc/9LhewxMCxS9u7S2qvuyS+6osBcI34f4pJe5Nq2TyzsPaKx338m8d2EpvCUMd35QWGhS6w4xKfqKOTJDwRmTC6QBtxwNJOTt+fw+LNeCqyASn5AyV1cn727dvvL94yGN6CNmCH4+l4mu6VLlIt7WClwUPHYzax3nHXv/pNpKNDhA808UbqREWTo+uORl6J3ZvGbPAicpOJykVigfU6lxF/DGaz4eGfGgxMVW8ysZBBc6Inrtklvdq+eHzSyVc/dI8nr+H5x5VnYffUzjKvSykoZkJk4h5X+485m5tN1tM7BtYKtNk7UH1yS9ij2qdvL0UmuEPt08r7RCu7H2z9WVj7fLMFwH+Z/D6rsF63lHWz2cq3U5/U6BzspTlGN5vN5n9xXdBK","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Contact","permalink":"/docs/API-docs/v1.2/createcontact"},"next":{"title":"Delete Contact","permalink":"/docs/API-docs/v1.2/deletecontact"}}');var o=a(74848),s=a(28453),c=a(57742),i=a.n(c),p=a(78178),r=a.n(p),l=a(19624),d=a.n(l),x=a(96226),u=a.n(x),m=(a(77675),a(19365),a(51107)),f=a(21312);const v={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:"eJy9WFFvGzcS/itTPtwlwlqSHbeHU19qFIFrnNEEtYsAZxsGdzmrpc0lWXJWsiAI6MP9g3vqa39afslhuLvSynbaulcECBwtOTP8ZsiZ+ci1IDmPYnYlvnWWZEFR3GRCYSyC9qSdFTNxWSGcIkEnASfvz0Aa45YRVq4BchCQgsYFgkKS2kSQuWsIJESPhS51AUWrOxaZcB6DZNNnSszEHKmbE5nwMsgaCQMjWgsraxQz0c3faiUyoRmRl1SJxzBdfocFnSlwJexMBvyp0QGVmFFoMBORVoaNRl17gyIT+OCNUyhmpTSRBYoKaylma0ErnyQpaDsXmShdqCUNR/BBJisz4b87zKviqPK52GxueNnonY0Y2dDRdMr/7cONTVFgjGVjYBsRkSVn0RLLS++NLtLE5C6y0voputZrjl1gM6TbJftgvNiP6jCvHo7uvNhkXfxfZuDOIeSIrI611OZP6OeI33QD48LVbMpXzr4YyvHhm8Oj9I9NFK720q5easR5tFHPLZu4c/ktaTIvRqJwkSAElITqhJ7T30kfTY/eHBxOD6b/uDz8anb8z9mXX42n0+m/RSYe6hTQLjGUpBToDtP2u/HqM6yzeSzWJV1XA4YKfTpuNqx1/Fw6XLgaqdJ2Dku0BMvg7DwDb1BGBAorkHOpLRhJGL746/IEQ3Dht8P0MmSbgdvaGm3xtq8Ft8fT6e3hNgjHT4PQV1jrCErXWPV5PX1m+d925/j2aOvOl0/dObMLabRKDePS3aP9vO4Ml6d2+aeHVrdCaV7sOTscb52MWDRB0yo1p4cD6fVBOz+7uuGiz+fEdU0tdTOqxExMutM/We8a2UawtbDoO10TjJiJisjH2WQSpVW5exj3tcfIPHIlnEivJ4vD8ZHYZI91pPcvksfm4KUqkeRc2/nv6d3sAnXBm9nu1164trsmvf4XrkTfavakul5foVQY0s5pW7qk3O3RO4/2Qs9t2uG0+GNO8AFN4WpkjkIVwmjUq3z8z69brdEIlCuaGi2lszi+ttf2XRPAuyUGbtDSKigNPujcYFLDOs1tCVBEWRuM0axAW8J5kISg9FyTNMBx4vJRSC9zbTQfYRZzrB1gkAVxDB8qpAoDT/09IEhQuEDDJx9kQ66WxKZ6vLB04b5kKpaBhLyJ2mKMgLaStmDBficycAGkBbSEwQcdESIFRq1bbM5S4NyvpZVzZNsZDIOl0Gg+rhBc3kSC6EyTIANXexdQQe+QRVQxBfEtc6uAwKPcfwNWfGwWCPNGK4wZFE4hxJSx7IJVkGMk8IxFFxjZaGONK+7TBpaNMeAdFxAtDTO9IUZWpyBt5F7cYun3YBswHxzTLmwBjkY/RuQdPtf2Ps5Go2t7AFfbc/UB86gJb171KbBcLp8c/df7Oqeavmty+AG9i5pcWO2055qqJk/pMjSy/WgtnaLFdH4GybCzoVwRn2Yfj04qNH5ygcQnJE5O3p+lmvsaPv78XzhHGSxUbtme1qIJaFYw75fiyLU734ZtWzKhdOngVRzxoj18TKkxUh/BD5Wkjz//EuF7XIK2XUqxK6MRXxsusfbcHOFvsPd5riONRjMIWLsFKmisRd4aGVawuwgkaBF5gFCBD1hqY0BJklAGV6fswjDQGPPS16LUBm+9jHHpgroWOwGQSqFipC0fA+oQZdASp8FAJ7FLN03VYFoFWdJutoVqyoQJgmuoPcA+uIVWCD2aFFQfHGGRfFJlDzpdq25dWaZOy2b+EPK08iPwg/WTVWgih5McoJVcxxxnR2x/tgtuKxXjowp12FrrAbbRvg3O4PPIOEtboQht6+Ys3Q/Uk7j+bqCf7BQ77Jvc6OKxw2M4KQr0HNiFNA3GGYxGLaLRCF4pLGVj6HUGo9FC45JH+bf0vEv8NYaLDn/Nha6SCwRJwHyPwHVRktQEhKVWc6SvoTU0VLCum4xfQ286Qi1XnT276ueTq91teWu4u7VyKMbX3Aoftc/9LhewxMCxS9u7S2qvuyS+6osBcI34f4pJe5Nq2TyzsPaKx338m8d2EpvCUMd35QWGhS6w4xKfqKOTJDwRmTC6QBtxwNJOTt+fw+LNeCqyASn5AyV1cn727dvvL94yGN6CNmCH4+l4mu6VLlIt7WClwUPHYzax3nHXv/pNpKNDhA808UbqREWTo+uORl6J3ZvGbPAicpOJykVigfU6lxF/DGaz4eGfGgxMVW8ysZBBc6Inrtklvdq+eHzSyVc/dI8nr+H5x5VnYffUzjKvSykoZkJk4h5X+485m5tN1tM7BtYKtNk7UH1yS9ij2qdvL0UmuEPt08r7RCu7H2z9WVj7fLMFwH+Z/D6rsF63lHWz2cq3U5/U6BzspTlGN5vN5n9xXdBK",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},g=void 0,S={},b=[];function y(t){const e={p:"p",...(0,s.R)(),...t.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Get Contact"}),"\n",(0,o.jsx)(i(),{method:"get",path:"/contact/{contact_id}",context:"endpoint"}),"\n",(0,o.jsx)(e.p,{children:"The Get Contact API allows you to retrieve details about a specific contact."}),"\n",(0,o.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,o.jsx)(f.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,o.jsx)(r(),{...a(87021)}),"\n",(0,o.jsx)(d(),{...a(59967)}),"\n",(0,o.jsx)(u(),{...a(29425)})]})}function h(t={}){const{wrapper:e}={...(0,s.R)(),...t.components};return e?(0,o.jsx)(e,{...t,children:(0,o.jsx)(y,{...t})}):y(t)}},87021(t){t.exports=JSON.parse('{"parameters":[{"name":"contact_id","in":"path","description":"objectId of contact","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"pH1bhc2hpb"}}]}')},59967(t){t.exports={title:"Body"}},29425(t){t.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"ph1bhx2jp"},"name":{"type":"string","format":"string","example":"joe bee"},"email":{"type":"string","format":"string","example":"joebee@example.com"},"phone":{"type":"string","format":"string","example":"4131231231"},"company":{"type":"string","format":"string","example":"opensign"},"job_title":{"type":"string","format":"string","example":"dev"},"createdAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"xml":{"name":"contactdetails"},"title":"contact"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"Contact not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Contact not found!"}},"title":"inline_response_404_2"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/fdf3f392.cda41a69.js b/assets/js/fdf3f392.cda41a69.js new file mode 100644 index 000000000..cf4a5b8a9 --- /dev/null +++ b/assets/js/fdf3f392.cda41a69.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[5740],{70328(t,e,a){a.r(e),a.d(e,{assets:()=>j,contentTitle:()=>g,default:()=>I,frontMatter:()=>b,metadata:()=>n,toc:()=>q});const n=JSON.parse('{"id":"API-docs/v1.2/getcontact","title":"Get Contact","description":"The Get Contact API allows you to retrieve details about a specific contact.","source":"@site/docs/API-docs/v1.2/getcontact.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/getcontact","permalink":"/docs/API-docs/v1.2/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":"eJy9GdtuG7n1V04ZoLCFkWR7s1tUW2zX6zhZo2liWHYD1DIszvBIw4giZ0nOyIItYB+KfkDRl772J/reT8mXFIecGUm2k6y7iwWSOCbP/c4zt8zzqWODS3ZktOeZd+wqYQJdZmXhpdFswM5zhFfooYaAw9MT4EqZhYOlKcEbsOitxApBoOdSOeCpKT1wcAVmciIzyCJujyXMFGg5kT4RbMCm6Os7lrCCWz5Hj5YkumWaz5ENWH1/LQVLmCSJCu5zdl9Mk77HzJ8IMBNYk7T4QyktCjbwtsSEOb9URNTJeaGQJQxvCmUEssGEK0cAWY5zzga3zC+LAOmt1FOWsImxc+43T/CGByoDVny/n+bZQV6kbLW6IrauMNqhI0IHe3v0Y1tcV2YZOjcpFbQWYUlQFrUneF4USmbhov/eEdLtQ+mi1mQ7S2S8jCwbYzxZj3w/zW8O3hdsldT2fxqB9wYhRSR0nHOp/g/8FPHb+qCXmTmRKnKjnyzK8/0v9g/CHyKRmXnB9fKpREyB2smpJhLvTXrtpVdPlkRgFUSwyD2KQ/8Y/hr6YO/gi+7+Xnfvd+f7Xw2e/37w5Ve9vb29v7KE3cyDQevEENwHQ9cytb+XhfgV+Kzug9VJV9eATYQmHVcrwnr+WDoMzRx9LvUUFqg9LKzR0wQKhdwheLsEPuVSg+Ie7W9+uTxBa439tJmeJtlqQ22pldR43dSC6+d7e9f7rRGePzRCU2G18TAxpRa/rqaPsP+0Os+vD1p1vnyozomuuJIiNIxzM0P966qzyd5H9g+DVkagcM+2lN08j0o6zEor/TI0p5suL2Q33g8ur6joU5yYuqmFbuZzNmD9Ovr7t+tGtmJEzVZNpyutYgOWe1+4Qb/vuBapuek1tUfx1FEl7PNC9qv93gFbJfdxeFE8CR7L7lNRnOdTqaefw7taG2pIzoz+2jJX6zVeyD/hkjWtZguq7vU5coE2eE7qiQnItY/eFqiHcqqDhwPz+zPBM2hgPvzt3y3YSI/0N9Dp0GBDinSdKW2G8MJkZaDHlUeruZcVwocf/wlpKRWlhAWBFSqKQ5eAt6XzKCBdAmqPtrDSoet1OkR/k+9UVhhnJQ7UhhR6TKCwRpQZCdq1yMUSsEsW5b60CIXinjoK+NyacprTLCX1VGECZ8fDc5oaDk9PejBELUCYrJyj9i6I2BJJYM41nyJ4nBM9DDLzbBZAqKA5z33pQGqwyBV4OccEuBbAS2/m3CMJbUk7abFlA0pOMFtmKhqHKwUL6XOa+CrUwlhQJpt1pe6RIbrdLv149oxmSE9ch55bj4JOjyu0S6AZDZ2Heek8ZNzaZeTbJi5J6HOE8UZ8jCFGRmAyHo9HeuNyAH8gCuuDb2qYke50Pvz9H3D5vVnQ5DpFTbMX3mN4tdMEvTCZexjtdNrPURX9YVTK9Q9PT0KN243+f2M8OPLkIkeLxCrFqdR/hAvqGjlCp1OnOaCupDWaTNvpwM74J5eB8S7RLazxhvKp9QKfTDALplYUwYJ7fs8VR8YiHPGCp1JJKql0fgdH3OPU2CXcwbuc+xCyGdcgDNyN9F232w1/CbTTedFEXacDd3AUZpsEHGqRQJxAErBYmVkdUwIp7tfh2W3cvg7fmvJ5E6+B8nelVAIslo6naiOYg7pQWOwWimcoYCHFFL37OshAljEawVjKgmVgi7ZlMUQ16VJ+BhavmihwdBxAN7OqtWtNBaSupA99CybKLBqip2WqZAbb4g9zbhE4FPGyST0l9SykjzYNVSWdh+a90tB8YfnEwztjZ8QpUuQVbkhn7IZNuANBGC6YfCI1VzIG3DxOKA3d5rkXKP451omQA7Uwda+C1JgZhdjU8vmce5lxpZYNkZdGCbSRxls75Zp4rSWT2kmBbQmGF5bCcRKRGhrvMM2NmUUiZ5ghwVA56lI5Aqyo4mjj6RkZTO4gRqYFs9CAWhRGat+Qu3CNQGfNo5RnmSm1DxbJLArpgToJjevkwbvt1KDA//Djvxy8wQXVnaZhPKO0UcjJOI2HGx5cjfT41fE59BtP9AdSjAPH7XPy8Rhy8mCKqMF5i3xOc5UI0WBRlFpw7WH9FgYKIItzU6EIJDudwuJEKhVSG6QDbRb0CC8t0XFIuB7VEibWzBuPrgl2OtQaZhSG7TsVkDuJltImM9qVc+w1Wp9y5xbGiu6pNR4zanmnL17CsCwKY/1I0z2MR2wiFV4XNfCIjZuq3eR5asSSyqGGhbGBe8hg1JldFjVV12voogCjByM9Pn07PId+fDs1ZhzDf/8D49OLBxYPxxsITTD2Bw3c9TZYyJYG6sHFPX7hgmoEmXTc2OftZEIOhGGd2pRa1qiRHqInu4RdybWJUNeEOmIDmh4Q7iBsHcZgNHxE0RBDj2jqDdDqQmbSKxpAQnGkCUXGOlnzawsOjQbIs7wtFq1/hzE+zoyiPkBD0biulmOI03eIL55lWFBhIZ0iwLU1CsnTE4lKAM+scS4MBEELyi5rSo+uB+e5RQSCj/HsGi8PYush7lTsMeeVpOS+33BqmcbQ2RE44aXyu6F0hZmhHqqoMtC7zIfSv56mYmeIJWJcSVwQnbbauBCl7XRDhrJIUGC0WjZFuu4ucfPV1OcxLwprqkjuiOuY2dRvGnC8IavVrSNKU5f4wOyuLS3cpkbDkSmWsHN0tEvCyUJSHR3pQ9C4ILNn2draddq3hgSujJ6Gikv64I10YQYYj1i6iWd0q2vSBkMS20aItrYJtl7sx37eOvOYNjvAhbDoqHZQVUNB+d7KaOtKzmmgS43uZqTZZh2HsB8CozPcdoB0rUNFD17LGa51SEj8LWlgx5VZTo0vZsk646UY71LrqqSo7RBFI39ZKWq/NxaAiqsSk9BwYpUiyypJhqVuCjgv/BK4tXwJO+PLq/Hu12Dm0gcq0bTegNQ52vpwm/S9Eeyw4lKFTD1ez3/1HLZxQjlBi4aLs9ePzGDDOCKGfveEubEdWNonyDaFT77wWuzjCzjD6QPkz70sx/c77l/QOmlCkfotfMez2YJb4eCIFnZehgl1SaCETMExKWkESRvAblYDqjgBQ7Ufwrja7+23D5RmTHCxJfrcOIQqMo4Fibf+MNS2pIO0sXugqg2kFmPXzHKup5QINCNsNGpJhV+UWcyFIC+RNuE5yhWUWqFzYHyOdkGzkjYU49vmuHBIz7vXUs9COHThsp2g3mHqpMf182SxWDyw9G7AeVkqBc2MHhLuM4+aiPZK+u/LFM6wME56Y5drrKn0eZkGX27itr/UBJpZut36/JzHVCB5jnbuaK0/RFvJ7DPq9z2B93dHtEK4t3bY3g5YnKCluuO2noK8kPWz87KRA0i8n6NH3EDHLShtr+JqnPYf396nE7ZQpMLbSa1vvYP5tL4sYUpmqB1ubLcOX52+huqL3h5LNpY5P8GX/dcnR8dvhsckTJ0mbMD2e3u9vbCPN87Pud7gtPGB6P4W5na98/ulvyXVaySPN75fKC7DCi8oeluv3y7Z+lvQYONL0lXCcuM8AdzeUqZfWLVa0fEPJVpa8V0lrOJWUkkIO7p6sBLtl6KPKrlzVj/iduHxj1KPit2sxDTtw0LHYAPGEjbD5fZHsNXVKmnWYiRYBDgM49kG6oPt6taK8tXxOUsYL8lGm+u4WVjH1f8h6o+Ktb2niwLQv7Q0fBTh9jau+larFj5efRSjVrCBJhtdrVar/wEMcBfg","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Contact","permalink":"/docs/API-docs/v1.2/createcontact"},"next":{"title":"Delete Contact","permalink":"/docs/API-docs/v1.2/deletecontact"}}');var o=a(74848),s=a(28453),i=a(57742),c=a.n(i),p=a(78178),l=a.n(p),r=a(19624),d=a.n(r),m=a(96226),u=a.n(m),h=(a(77675),a(19365),a(51107)),C=a(21312);const b={id:"getcontact",title:"Get Contact",description:"The Get Contact API allows you to retrieve details about a specific contact.",sidebar_label:"Get Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJy9GdtuG7n1V04ZoLCFkWR7s1tUW2zX6zhZo2liWHYD1DIszvBIw4giZ0nOyIItYB+KfkDRl772J/reT8mXFIecGUm2k6y7iwWSOCbP/c4zt8zzqWODS3ZktOeZd+wqYQJdZmXhpdFswM5zhFfooYaAw9MT4EqZhYOlKcEbsOitxApBoOdSOeCpKT1wcAVmciIzyCJujyXMFGg5kT4RbMCm6Os7lrCCWz5Hj5YkumWaz5ENWH1/LQVLmCSJCu5zdl9Mk77HzJ8IMBNYk7T4QyktCjbwtsSEOb9URNTJeaGQJQxvCmUEssGEK0cAWY5zzga3zC+LAOmt1FOWsImxc+43T/CGByoDVny/n+bZQV6kbLW6IrauMNqhI0IHe3v0Y1tcV2YZOjcpFbQWYUlQFrUneF4USmbhov/eEdLtQ+mi1mQ7S2S8jCwbYzxZj3w/zW8O3hdsldT2fxqB9wYhRSR0nHOp/g/8FPHb+qCXmTmRKnKjnyzK8/0v9g/CHyKRmXnB9fKpREyB2smpJhLvTXrtpVdPlkRgFUSwyD2KQ/8Y/hr6YO/gi+7+Xnfvd+f7Xw2e/37w5Ve9vb29v7KE3cyDQevEENwHQ9cytb+XhfgV+Kzug9VJV9eATYQmHVcrwnr+WDoMzRx9LvUUFqg9LKzR0wQKhdwheLsEPuVSg+Ie7W9+uTxBa439tJmeJtlqQ22pldR43dSC6+d7e9f7rRGePzRCU2G18TAxpRa/rqaPsP+0Os+vD1p1vnyozomuuJIiNIxzM0P966qzyd5H9g+DVkagcM+2lN08j0o6zEor/TI0p5suL2Q33g8ur6joU5yYuqmFbuZzNmD9Ovr7t+tGtmJEzVZNpyutYgOWe1+4Qb/vuBapuek1tUfx1FEl7PNC9qv93gFbJfdxeFE8CR7L7lNRnOdTqaefw7taG2pIzoz+2jJX6zVeyD/hkjWtZguq7vU5coE2eE7qiQnItY/eFqiHcqqDhwPz+zPBM2hgPvzt3y3YSI/0N9Dp0GBDinSdKW2G8MJkZaDHlUeruZcVwocf/wlpKRWlhAWBFSqKQ5eAt6XzKCBdAmqPtrDSoet1OkR/k+9UVhhnJQ7UhhR6TKCwRpQZCdq1yMUSsEsW5b60CIXinjoK+NyacprTLCX1VGECZ8fDc5oaDk9PejBELUCYrJyj9i6I2BJJYM41nyJ4nBM9DDLzbBZAqKA5z33pQGqwyBV4OccEuBbAS2/m3CMJbUk7abFlA0pOMFtmKhqHKwUL6XOa+CrUwlhQJpt1pe6RIbrdLv149oxmSE9ch55bj4JOjyu0S6AZDZ2Heek8ZNzaZeTbJi5J6HOE8UZ8jCFGRmAyHo9HeuNyAH8gCuuDb2qYke50Pvz9H3D5vVnQ5DpFTbMX3mN4tdMEvTCZexjtdNrPURX9YVTK9Q9PT0KN243+f2M8OPLkIkeLxCrFqdR/hAvqGjlCp1OnOaCupDWaTNvpwM74J5eB8S7RLazxhvKp9QKfTDALplYUwYJ7fs8VR8YiHPGCp1JJKql0fgdH3OPU2CXcwbuc+xCyGdcgDNyN9F232w1/CbTTedFEXacDd3AUZpsEHGqRQJxAErBYmVkdUwIp7tfh2W3cvg7fmvJ5E6+B8nelVAIslo6naiOYg7pQWOwWimcoYCHFFL37OshAljEawVjKgmVgi7ZlMUQ16VJ+BhavmihwdBxAN7OqtWtNBaSupA99CybKLBqip2WqZAbb4g9zbhE4FPGyST0l9SykjzYNVSWdh+a90tB8YfnEwztjZ8QpUuQVbkhn7IZNuANBGC6YfCI1VzIG3DxOKA3d5rkXKP451omQA7Uwda+C1JgZhdjU8vmce5lxpZYNkZdGCbSRxls75Zp4rSWT2kmBbQmGF5bCcRKRGhrvMM2NmUUiZ5ghwVA56lI5Aqyo4mjj6RkZTO4gRqYFs9CAWhRGat+Qu3CNQGfNo5RnmSm1DxbJLArpgToJjevkwbvt1KDA//Djvxy8wQXVnaZhPKO0UcjJOI2HGx5cjfT41fE59BtP9AdSjAPH7XPy8Rhy8mCKqMF5i3xOc5UI0WBRlFpw7WH9FgYKIItzU6EIJDudwuJEKhVSG6QDbRb0CC8t0XFIuB7VEibWzBuPrgl2OtQaZhSG7TsVkDuJltImM9qVc+w1Wp9y5xbGiu6pNR4zanmnL17CsCwKY/1I0z2MR2wiFV4XNfCIjZuq3eR5asSSyqGGhbGBe8hg1JldFjVV12voogCjByM9Pn07PId+fDs1ZhzDf/8D49OLBxYPxxsITTD2Bw3c9TZYyJYG6sHFPX7hgmoEmXTc2OftZEIOhGGd2pRa1qiRHqInu4RdybWJUNeEOmIDmh4Q7iBsHcZgNHxE0RBDj2jqDdDqQmbSKxpAQnGkCUXGOlnzawsOjQbIs7wtFq1/hzE+zoyiPkBD0biulmOI03eIL55lWFBhIZ0iwLU1CsnTE4lKAM+scS4MBEELyi5rSo+uB+e5RQSCj/HsGi8PYush7lTsMeeVpOS+33BqmcbQ2RE44aXyu6F0hZmhHqqoMtC7zIfSv56mYmeIJWJcSVwQnbbauBCl7XRDhrJIUGC0WjZFuu4ucfPV1OcxLwprqkjuiOuY2dRvGnC8IavVrSNKU5f4wOyuLS3cpkbDkSmWsHN0tEvCyUJSHR3pQ9C4ILNn2draddq3hgSujJ6Gikv64I10YQYYj1i6iWd0q2vSBkMS20aItrYJtl7sx37eOvOYNjvAhbDoqHZQVUNB+d7KaOtKzmmgS43uZqTZZh2HsB8CozPcdoB0rUNFD17LGa51SEj8LWlgx5VZTo0vZsk646UY71LrqqSo7RBFI39ZKWq/NxaAiqsSk9BwYpUiyypJhqVuCjgv/BK4tXwJO+PLq/Hu12Dm0gcq0bTegNQ52vpwm/S9Eeyw4lKFTD1ez3/1HLZxQjlBi4aLs9ePzGDDOCKGfveEubEdWNonyDaFT77wWuzjCzjD6QPkz70sx/c77l/QOmlCkfotfMez2YJb4eCIFnZehgl1SaCETMExKWkESRvAblYDqjgBQ7Ufwrja7+23D5RmTHCxJfrcOIQqMo4Fibf+MNS2pIO0sXugqg2kFmPXzHKup5QINCNsNGpJhV+UWcyFIC+RNuE5yhWUWqFzYHyOdkGzkjYU49vmuHBIz7vXUs9COHThsp2g3mHqpMf182SxWDyw9G7AeVkqBc2MHhLuM4+aiPZK+u/LFM6wME56Y5drrKn0eZkGX27itr/UBJpZut36/JzHVCB5jnbuaK0/RFvJ7DPq9z2B93dHtEK4t3bY3g5YnKCluuO2noK8kPWz87KRA0i8n6NH3EDHLShtr+JqnPYf396nE7ZQpMLbSa1vvYP5tL4sYUpmqB1ubLcOX52+huqL3h5LNpY5P8GX/dcnR8dvhsckTJ0mbMD2e3u9vbCPN87Pud7gtPGB6P4W5na98/ulvyXVaySPN75fKC7DCi8oeluv3y7Z+lvQYONL0lXCcuM8AdzeUqZfWLVa0fEPJVpa8V0lrOJWUkkIO7p6sBLtl6KPKrlzVj/iduHxj1KPit2sxDTtw0LHYAPGEjbD5fZHsNXVKmnWYiRYBDgM49kG6oPt6taK8tXxOUsYL8lGm+u4WVjH1f8h6o+Ktb2niwLQv7Q0fBTh9jau+larFj5efRSjVrCBJhtdrVar/wEMcBfg",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},g=void 0,j={},q=[];function y(t){const e={p:"p",...(0,s.R)(),...t.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(h.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)(e.p,{children:"The Get Contact API allows you to retrieve details about a specific contact."}),"\n",(0,o.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,o.jsx)(C.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,o.jsx)(l(),{...a(87021)}),"\n",(0,o.jsx)(d(),{...a(59967)}),"\n",(0,o.jsx)(u(),{...a(29425)})]})}function I(t={}){const{wrapper:e}={...(0,s.R)(),...t.components};return e?(0,o.jsx)(e,{...t,children:(0,o.jsx)(y,{...t})}):y(t)}},87021(t){t.exports=JSON.parse('{"parameters":[{"name":"contact_id","in":"path","description":"objectId of contact","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"pH1bhc2hpb"}}]}')},59967(t){t.exports={title:"Body"}},29425(t){t.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"ph1bhx2jp"},"name":{"type":"string","format":"string","example":"joe bee"},"email":{"type":"string","format":"string","example":"joebee@example.com"},"phone":{"type":"string","format":"string","example":"4131231231"},"company":{"type":"string","format":"string","example":"opensign"},"job_title":{"type":"string","format":"string","example":"dev"},"createdAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"xml":{"name":"contactdetails"},"title":"contact"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"Contact not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Contact not found!"}},"title":"inline_response_404_2"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/ff9450a5.707c5668.js b/assets/js/ff9450a5.707c5668.js deleted file mode 100644 index 2d47b6247..000000000 --- a/assets/js/ff9450a5.707c5668.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[7377],{15483(e,n,t){t.r(n),t.d(n,{assets:()=>y,contentTitle:()=>f,default:()=>j,frontMatter:()=>x,metadata:()=>i,toc:()=>w});const i=JSON.parse('{"id":"API-docs/v1.2/draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","source":"@site/docs/API-docs/v1.2/draftdocument.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/draftdocument","permalink":"/docs/API-docs/v1.2/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":"eJztPWtzGzeSfwU3dXWOucPhw5LtKF7XKrE38W3WdtnypXKSlwvOgCSsGWACYERxVazaD/sP7tN93Z+WX3LVDWBefIiSlaydYz7EIgaPRqPR3egHcBUYOtXB0WnwTMZFxoTRwfswSJiOFc8NlyI4Ck5mjDxTdGKIr0SOX78gNE3lXJNCM6WJkWTKBFPUMCLYnCS+OzJekFzJC55wMSUJNZTMuZkRSsZUs4cHhIlYJiwhE56y6EyciROeH5F3eSppQhayUOT1sz+W/cFAUHba6Txj42JK3r3odN5/MTMm10e9Hs3zSOZMaD4VKR3rKJZZL4GKeTK5H5L5jCkGvZKYCsKo5umC0CQhc55MmdEhMTMmSCzzBYmlVAkX1DAdkpxOGRFFNmZKh4SKhGRSMcIFoUQxmiy6RnYLzch/vn31kkykyqiJyOu00GE5XMIVi026sN2bGStndU97bGijuJiGJKPngC9uyE8Fj89h2pqJBP6FhsevXyCuOp23RZ5LZVhCfrBTOOp04MvXLJVzQhXD+rHMMilIThXNmMEFm1GDnxX7qeCKJW5Z0tTj4uhMdEmnI2jGjjod8k7wnwpGeMKE4RPOFMySmBnXrkFk65tFjvVfiITHgDwEAEqJnDSrAlKh6tucxdClrVpDNZGCzGc8niEO59Suf57S2E5LMZ2z2PAL1uz4MiQL6PgZE9JDMJOK/00KQ1NcvgumDI9pWl9mABCqakOVAfTnkgvjS90I5Ee3nLDauIiODgG0BJCbcYFfNCMXNC2YdlDNQzIDqN6wXDGNm8P1C4gXCZkxPp1tHI8mHwptGh2TQgOYdSjcWH5VEb0M0TahqWaETxq4zOg5q41GJG56mkbk6wVJ2IQWqQkJBwo1qmAReSkNoXme8piOU4Y0AJuNmkKxLq6yI5+oST6vkQcwTShJ+GTCFGxm+IhduDYeOqDLimngTjMzKogUrYWOZSrVKglhcROPJJbCMGEicnxBeYrA28lqwkWcFgkj45TG5yEZpwULiWKJ3egLBowutPsDqxCqHc4RP0SzFKhQCoBfSDc810Q7qJKInMBGKfcffPSoxkG4rmPV7fKJhJEBBX5LEpZRnoaIuJB8kGNiuElZCBs8p2IRAodlITHs0ozlZUjiGYvP8S9FEy7JuDBGCjuxRMk8kXPhcDmRwmj+tzU70n+5OUaHITkIycOQPA7JoB+SwTAkg4OQDB6GZPA4JMN+SIbDkAwPQjJ8aMEaPg69iPAIrgMwGFosm88LuzOesBE0HMHcRlQbprg+B3ZNfgCZwwQAl4SWXbJLA8wPuRGfCpZUEpBrMuNJwgSZKJkRxWKec+QmlhuUXYcAD1EwKaHJpEjTBbngmtdwUHYq5wLwhiNyRV7lTLzlU0FoHMsC1hgxbJGK6KyWXKQLAPWE0UzjzJ8Lw1SuuGbAqoUuMSBMRVtWAEJZnQHsspKiyYE2r+am1amtDEjQ77lGnguiT5fSdN6QpoOIdDoln4Oyv/71r2fi6kwQchYA2zsLjshZUFY5C0L7DaQZfBu435fw48Hwkfu5gJ8Ph4/dzzlWHRy4nzP4OfRN3eY6C45wXKzAhbEjO/5KahBApeWZWDpgz8QQZ2Folm+ZAXz+ZaEnJfheSkEhiJfQf4AduArPhhnbGiuzfQCz5YIbTlO9ecK+xic05xZI66ddVVqZ+QHMHHnZ5mnj509oznV44AvKUPsJZW7tk5cGCMVwC4rafW7iwdAKtaMVTB5GToXZjEg7hU8GjzVw7gqNrS5vjsWHgEUQpycgTjejspS4nxA+2zDdFVLX9XtzzD6KUAlG7WQzXl2FTwirTYjuCqervd4co48Bo6DmbUYnfP2EcFkDBz44ndl+6x90B4fdYX940MAnWCdshSzrJkl3sVh83FpkXIwsHNCoVj+jl+s/gNEEVMdyJcovoMFwMS2bNb+urrqt11pIUDgdJkDn9MdPq/SCkQp151XbAh79q1ruwIN/+/P4n+EUPvYHVJY4rbk6jpTmn/oR2siELu5p25VvWp68oH5bN7Zg4ieAA01h8Uzy2AEPdfx5awzWnghw0MVF7SVJr7aoUJgk3SzrtgrhZxdpoFaYZVGSRK2aK4RiCzOSJCFZLV5bniQky7INxba8UdzLstVZRFnmYHPY87S3ss4ZFzwr4IQEVjV7QIeKcMhw6M3cWnJBOp0ff/zxx+6f/9x99qzT8WvohnBUXDNk2BHo5R2NUCf6TueIvJiQehEaE6wZB7lAeTB0RlVbYSbnwp+H8NSoSFKAPdFXtcakjC6wM8bNjKnmOFJVJAunRzhsjaWZReQdHi7hb38IKw9LeJD6EhinOxlv5p2uwq/FPisu2Rx4K2vdzJoavHVFLfKMKV+vNyk2LVKq2CVY/zSXYoUn3kYG3ky+tdiip+XK0oJ2RWfZZd7QQb545c7g90vzYmsu0NsxiQtt0CQxZZckp8YwJbCzC5ryhOL+6GIBu6RZDqaV3l/OzpLf/XsPDbtgOzXWopDwKQd7fO8vp8fd/36/pkaR50zFVDOSMhhJh4SZOCKnM5bmlUtgPp9H8wc6nkmZWn/AB63YxP5/JMcfRghuHlGd3183U0sMNUMqEEvbjoqbs4YxqolvucaUikuDu2bQRw3OWSq2qHCuxiekd7RAgo/WKg2fT0H0o3ILxMuqvyXwnLPgfSXu0XjKkmvavt9he8JuSOmYpaufbr61UrqQhdvR3lnQnKqj6BrenCpU2oNxOv2w9pFetj7ab8s1+9QipL5NvbT329OvAEm5LgVJA5311s5lgI4fwRj6ksaM+AbgqPNc4GN3QQnYbtvA20dx7a4ZAuoRrFi6a/xo14zQWJgVSe50Be93mpS9epR5QV7HF7QE/2elJmwZwekKm0cAJ8/mAc7EAK2Q3nq55XzianxCvKIF0vZtfBsu0pDMtxGpt9qAflr1DbhGvEJVK1jLzac3776IvLImdd8IzO1xzHLQtD56a5Yg7yyh0GpsLehfowV9M+XV7eyfEPWtAesXpkBX766lz62ItD77z4hQG2DvTKzW6J/R6Rb7DX7+hMizDs96E4ersWKsGqCl30qULRZq/L59woN+Y8KHzQk/7N/ixNUY9uMPXP0t+FkZCs7WRUpXxEHCYp7RFCNIEO7hR+zR2xy+HGCwB76RWV6Y+qZDsw4yFq8l+LgI69n9XUi6IemEpBeSL0JyPyJvGEZSxGXUhVMauLKxFVyQRBbgJo0LlS7IWMHEQ8KiaUSurn4qqDDcLJZL0iFXVxC9tVxGsAvPhZzbwItTcBkbAoFT1aEqkbFeE2glY92D01fvJZt3fbBYz4F2n3whWyxh61HUoeDXPZFZqGpEAqO8LFU2eyrFSB+u85QuCJ2Am9pGg2AzGzQUAYqPyJD8/ikZDKN+PyR9+zf5wk9weB/3MPqYYpZuc1Li5+t2cL++g6uf61jWYX+nLVwf9pY7GLoYYQwBjnutwlZt7k/QdFJNpm2srWn1gDMrP/VMFmkC0lMxUyjByvi9UqfvdF4rNuFpWgvfI77I72kIh2Ipy1zImAvcg+MMhipwYSTsGx/L0emM2URCmALED6JhkFYBfnZsK7obISCxYtRIRWZUWzsLYhoghgBJM2NZK2DCg1cFTXDhYQdSHtydRXD4ZZO4Hx42iPuwKZ82EvcmCt5iKIQmOpdCl/5AVn2qUR326ctXjxZtSvKdwnJjvEwV9oNMDAkn5eeszmu40F5Lc1C2w+C+mUmpqxouEs3xXX3UjHCTCoLc7kdlaMjHur0Gjx40lIjHv6Lbq7lK/YPe4LC31e/VcpHc/LBIyC5Lilb1nZYUa1ZruncKfYxT6ON3xIO7NMwOHg0b54kH24TzJ2KYre+oa0yyd2F4vdXZdp0FtL4Pd7R9/mo2yI8ny4PKGjO+M2tMi3E/GvwLrDEfS6IrRpc7I0pyVxaXdZS5g8llq53loym3DuwvTr2Hd2OeaZ11vmxog18O69R6ePhx1No2ztRI7izg//X1qzfz/p++ncrj4+Pjl2/fzZ6/mx4fH2fwO4qitSa7dWSAw4D+7PKAnIhHdWHDKFEUobueGnqEzXu5mH5l24eb20RnIggDmUOuFpfiRRIcBQlkd/mDQBAiXpg2X8tkERxdBS7QH/50gdfQsvdBQ3rYVaDjGcso/OXxCQllkM8VhAHGuEFOGSxwcBTI8QcWwxi5AhgMZxpaYu2jK1/LpkEFodPZgqPAzisIA+c5LovKBLI8mQTLEHsa5VTruVTJ1i7LkqpL6MBCfMOGGv8oD1PQD6Qe3bKbl9B02crDu1VPz2o94NwydiLB8pQyw57Rha71a8+wQTv9D9oA74hdK5LQhQYeVGgrSGOaxkUKiim7zLlalKFTqJ3WyKqEtxyphHdwuAwDG7NSB4kqRRdBGHDDsnr5BipS8uYrFzMJmMFY4Zu2/SDZmLE/uAKwgeHC0+zGUHyQjIwZLno+k+LG7QfDB4Ph4MFgCD24OMib9uHtedDFBzke3WojJOwiKJdytPuCNGmumX8EvZTiyqe7lGF3LgoqVzJmWkfkGBJBWOJ0vqMqvgps5KX17f6RDeSb0QtGgNMyClYNUcugaKaaXXA2hx6OyBsWM37hYKsnpkIVjE35ynqLsW8hWxlxNIcAId8VtLFpM6682e1X0L4NUZmzaXk5E0UGHNfOMQgDC2oQBn4o4L811mDrLcPAAXb7DWe/rq5vczWbK0K61YRCm70RXcfMfH3cH3TKrudaJ5sySWsJbM4+R/OcURVhQuetc4ubjLDU6qJr2N4yDC6vn8wliWXXp6mSL1I2MTb8icRSCabu18NZP5nJDQ8OlmGwuH56i89yeo9g8ebXz+4HzO+tcp//FbA+eLwMg9n1sH5XZiD/C4E9eLis1LAAzdLM88PRWCaLkedby+sqeo0C6k1kmjD1Yq1O2NQAIdN+1FYIxlKmjIo1jKaRsOhuRYBDFzihnOluPmPo1ivPYth7ddBzLisLrYsebkRkcg1nJFWwsyCC4ODq2IhysZ0z6euiYBGS3MPxRrpANn6v534Dju7VbwUAv0IVx+5BwMrEsCxPMU1+Ds6JMXoxkoiU/1lh5DEJAHi9yg98vaj4xkaQ4oCuUTPHnLizSUS+oaLMM25mgJKrq5IMkDqWS3J1BavK1Ai0s+UyrApgrEYBKmC2RFlRX29VFrGqYVlWa2p1YYyqtgVOK6sD4CKvC+X6gSPDchk1CLIFOLpnHA5YUtIZ5OquzrpUbHGld8b+CrIdBUAn/2/w/iR/+h1fA8qTXv70Sf70B7hRImd271n0TLhI7M6fszSNyBNtlBTTpy0UPOm58vVLqVAlxI2Lq1r10sZt2VHkYPoRGHW1eFyTWBUxpymGToN+7L2A6LIEy402LNfgG+fGatKodOPBjU4VQ5+j1U4Lgzdo4NHfD/iEkplik9/fa+H03lNMHoeYgSc9+tTVfmFtUVbjFguCE0fDmVTWKjspFLLJOKWKT5ydISQ5KOcM7xugsfXqW4x6OE5mVJzr8MlYPYU09DJ9/ed//BNqeJ7+QrxSCVM7MHVIv7BWtHvAx+6FNuQcyZ0rbXx6BXJCRyHlaWTd1nHZuhB78Lxk/boYa6glfH8VazWKT6cMvLauBjZ2FyMwGs+s0ECoqhCEHIhHFtqDBwTmj+2JiwspU0Hqpr4admqpJnbu0RqujhKSi5GEFiOb/LIDWvGigxZi7WQsvFyTcSrjcyAF0PjAyqmrK078UasQhqeYr58D7hOf4QIIROpqz5liSG5EnouJVDHTxEJcw22FFrS1opkLJB0AfK+GnXtofE11iRzyzOIQF/QeWkubGMOiZRigYjCSk0nKBUPF5FZ06OcJwcK6GEM2BLUXCnlFoESTuzjC3QohCLuEfAzkBjJFqWpvfbAcZ/eZ2JsqXp283mECaITuWsDc7RFI4rYP8urkNdzEU+51SDMqt4HfV7RRhYC1j1xw6m/rKI91C3vqZtb36oRinXAidwdOl6wClHC9FqLQanSAwvKmq5WOq6udYH/KwkDIBHfXViCL3YLIE1nswpKuwSQl0wKzEQ3wbq8yYVZMdZMOF9qowsan+9SwtTYUjyePFahU6z8kTGjbnJIJhs6EpBAcMK8K8EuUXbLLnCkOIWprUaCYRR3Ijev1k6ZZ6N2b792FXrWEN89AfcewAXKkGmQJK7ykPfW1hwEnu68HEBR3DLxz1qqcKS0FyDepplQ48WmNEeBBGbMZTW1VJyfAbY/8DOh1rXnu53/8swbXRrvlKmB2BJokEER1DYTojLIED5xGsRzEn2xCBP0x9Yf2+S8ouV0mk3Ij6d1p/DVmeemS17kQpDIEShfxDHSWUtjqsLwOw1mUNPqdymt0ZA7zZZdcm9oVMd6EuMof3riEzgoGK4+SxPLSRX2DV6FZstUdng1587Ko8gS8KiEKI0eKZVzspqTU/XxGloygMDKjhsfEd6Wj5hVgNvzE7+usCkgEarzgUt3fsFWhu5EUMQPRzy6Y2sG2U4udBLfBmJk5Y6IOm0eSLAWvvdgHZW8DJ60s2AaU4D/ImJqyUQzmSaQ6tgMSOx3oqtMhXQuI46m6UM4j667PQ+YBfKTqHcBxB6EyCbzSPOq3FkbkOzkHhJW6LJw4bP+AT4KQu7uf6iPEVGAGLii8cEw3XjOyGUUY3uuGsLF5uFg4G6dtx9ZVC73AdW8wTrhtTp5/ltntFK5s86N7nQImB442QlOJ+8mdKVp3VSFQL/C2rhnKH1w/8CzbcfwVeqiH/Pz3/9Wg0LmIZl3aOdZ+RVMFKmKYilzv1ZOzJ/ioaZjw9Cyk4ZPFSIpRxUfWEkyz5VYCWhNO2VRlhOPCOLjXaIDSgToA0VaKwT9NR8DK+m4eDBByRwOCIxK8FFOqkrSUGnYZDV5USeuEZIfaRA14jtxAdtQYGs8YXvCVsByuupRO87YirmamgvUEPwATIww82MV/4cTisraapwHEJ6C3OwlCGwgSvF+GwTiOb9sjSMyGOzDEomGjbOWC1XEcky/GKQf0UDWW9gLS+0dOGaYJ7ENUdFp6cWNRLfKRnTQ0HF47A3rU2SDddf6dJmT+7kmf0u4Fp9W58Q7VbAxJQRhwjMdI1LC8LXPFYfSLeZy2uY9csOzeefQZeVcG/f5v2Xn0oP/5OI8O+p+R8+gxAOtiva7nJptOdWt5h4/b2t7gg2Q2BiOVantNkDvol7IRh+sQXG2H4dL+V/m7PBOvlzUCuazRH9tUgVnOgOfnglgY9vvwT3M1nzV0CzjRF2iNw3tE/y0Id48K274EJbT8xtFasw98+LfL+GL4GvC4wYKwtQNHiIVK4f5uEF/dUv/Bk2wNt1yg5Q5RPEpkPFJMj4b9/mgQ2IU5WIfGtzJjVvmdAzLnYLAvTwFGLQidghoPNK7uEKtMqevI72aQrcGEp6HRQQMJh6tIeCHwugy8Nv5EnjPx6860PryxwwOol1la8YCA20r4PWhMtl5uJ6lZXChuFsHR6VVw2aU579rvR6fvl+/hIGpmEgIrc6kRYmpmwVHQa8dZaqYuMODt9MqSb0mRmooEwslX2CPNee9iEEGcV7vNWna6pT4rujdtog2dcjG9rt37CkVvYRntSjUQVel/Of8TAwXQrUO9VhhwIJ8Zo2ARAcwDdbypolOf+zX2EaTrgkJXYkKDoFreduCmj9tshGK2Jd2a4Mr1sZWDw1pU46kPUMSYwzLkcF0UYYkNHxdYhgXWIv1qgX5V7F4jdA+j8VrBeFWYWKmLn1abpwy08qryAHXM4cEBKmOPBqi1PHiMCsHBwyWSexVZEQTN6AkMqm7HAHycS7vp0d67aX9DbtqWl9YSz3pXozPFrHOquU81L1WjxLpbXFHT/eCptzT3N2zubZP7RvP3Buu3B7lp5S0BWWdcPVxr03RN1tuv3Me6cWS9ocPZOXa3WdSMBms4h9eTm3wDEjWAbzzoI9846CPfeNxvqOgO11UPlaKN2nSpTLsJVAozaMXvQSxwMZEoUxzfK++vB5GPMmnlYMXSWGbl9fGdTo0Yy1adTikY7IYCm9irQpFczpmaFPZO+knKLvFSfWjGMvxWRYAxmoHlLIVcT8OmaEXFawQqpzOJaU7HPOWg09h0bru1K7VIR/BKgI8hu6fsRQkXLAVVqLT5w2WQXm2fS3U+gVg0sNGNwQkM9jsmZlTE1sFkBTQ6SsCQU93ar40CqLmFTQqjYD9nVNApcpqwvnNJwlJgvJooOQb/q5ZpYfmFoTyVyiYJ4IQwuwmR+Pwyh094OgQpptgMdtGFczPq0Lp5raB1L+6MIZwiB1g4GICNJIWAaAEbllFAOIA0zp0vJw0YoblRVGg4Dbi8BLcGJcKcB5BpZ2p9pxms8PdcnNtnALrktKSrH9hYc8Oa1wy2OcH9ZptvufmuGMPzL1JzI9Wiaj3lZlaMUYuqd1L+sD19619YqulIu9/J8daabHXv+PULVMLvk5///j/ke0aVIDM5t9QaF4qli+oxJ3zqCFfeoq3UodHHDOIGMB5b4nNS0mPwhxk1aLd/yebgILFbykbBf8sMOXERheQ/SOMnXDAA0fGKZfICHLhCMFgaqhaNYEWQvaVbxLEn+8QUmnycabtqgQH4Z01t8CyoB28mzpVjz7xlyGNIijxpFrga1XZDeV1+Rk2/afnWLLWXuhIlC2MJ2NtVPTSI1FxJYz3XeTLxQK9Kup0gx5FbwNfGx16rwAbnQoSsMucgdAOWnMqlOHJVhYM6AGtK5nrIKie9JvYsh17BBqJW8HotoldWCiacF+OUx+0JR+TYZU363JC1iSFhLdkjbORrROStgz/bLXXkK2I70mvzQb7yKR/wnS4qjau0svtgklZYGVfMeWiCsH2qako59JcB7povtNGcu0186pkBad6aenNmYo1eqPrhsdwpSTTnawME4J0s/WrylqkLHntbzAY+2sPKvSAMUh4zZ4FzWsPxt6+/JxcPon4Q1s6qO7DU3vcvvnn+8u1zAAaWwCJsEPWjPjoKpDYZFbWRmk/gtRWKWpbk/sG8/YN5+wfz9g/m7R/M2z+Yt38wb/9g3v7BvP2Deb/ebbL7B/M2XaK7fzBv/2DeKh73D+btH8xbudRv/2De/sG8/YN5+wfzfpN3o+4fzNs/mLeJfe4fzNs/mLd/MO+Tvpd5/2De/sG8/YN5+wfz9g/m7R/M2z+Yt1363IpI9w/m3fxG9v2DefsH8/YP5u0fzNs/mLd/MG//YN7+wbz9g3n7B/P2D+Z9Rk6h/YN5+wfz9g/m7R/M2z+Yt38w706NM7+RB/Nqae69PKVc1K4cste7nLae0XsfBjO4/uXoNLi6glHewZ0LUPxTgdn9p+/D4IIqDlHZeHNM6G86gbz6cwbXW3xjUwa6JzB8aPc8ZtW1LsyBq1psC5vjuLVu/Yaa16/ensClAO59iEwmeDUVnUMePp3bSxFqyfpYdhWkVEwLTPQPbJ9Le4HtrHmzyzne7OL+qN0WAJeWVBA2r3yx04D/w6TWNri6srfG4HUgtr79tLGFQ6yvDcv3frlc/h/7PLfy","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Self Sign","permalink":"/docs/API-docs/v1.2/selfsign"},"next":{"title":"Create Document","permalink":"/docs/API-docs/v1.2/createdocument"}}');var s=t(74848),r=t(28453),o=t(57742),l=t.n(o),a=t(78178),d=t.n(a),c=t(19624),h=t.n(c),p=t(96226),u=t.n(p),m=(t(77675),t(19365),t(51107)),g=t(21312);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:"eJztPWtzGzeSfwU3dXWOucPhw5LtKF7XKrE38W3WdtnypXKSlwvOgCSsGWACYERxVazaD/sP7tN93Z+WX3LVDWBefIiSlaydYz7EIgaPRqPR3egHcBUYOtXB0WnwTMZFxoTRwfswSJiOFc8NlyI4Ck5mjDxTdGKIr0SOX78gNE3lXJNCM6WJkWTKBFPUMCLYnCS+OzJekFzJC55wMSUJNZTMuZkRSsZUs4cHhIlYJiwhE56y6EyciROeH5F3eSppQhayUOT1sz+W/cFAUHba6Txj42JK3r3odN5/MTMm10e9Hs3zSOZMaD4VKR3rKJZZL4GKeTK5H5L5jCkGvZKYCsKo5umC0CQhc55MmdEhMTMmSCzzBYmlVAkX1DAdkpxOGRFFNmZKh4SKhGRSMcIFoUQxmiy6RnYLzch/vn31kkykyqiJyOu00GE5XMIVi026sN2bGStndU97bGijuJiGJKPngC9uyE8Fj89h2pqJBP6FhsevXyCuOp23RZ5LZVhCfrBTOOp04MvXLJVzQhXD+rHMMilIThXNmMEFm1GDnxX7qeCKJW5Z0tTj4uhMdEmnI2jGjjod8k7wnwpGeMKE4RPOFMySmBnXrkFk65tFjvVfiITHgDwEAEqJnDSrAlKh6tucxdClrVpDNZGCzGc8niEO59Suf57S2E5LMZ2z2PAL1uz4MiQL6PgZE9JDMJOK/00KQ1NcvgumDI9pWl9mABCqakOVAfTnkgvjS90I5Ee3nLDauIiODgG0BJCbcYFfNCMXNC2YdlDNQzIDqN6wXDGNm8P1C4gXCZkxPp1tHI8mHwptGh2TQgOYdSjcWH5VEb0M0TahqWaETxq4zOg5q41GJG56mkbk6wVJ2IQWqQkJBwo1qmAReSkNoXme8piOU4Y0AJuNmkKxLq6yI5+oST6vkQcwTShJ+GTCFGxm+IhduDYeOqDLimngTjMzKogUrYWOZSrVKglhcROPJJbCMGEicnxBeYrA28lqwkWcFgkj45TG5yEZpwULiWKJ3egLBowutPsDqxCqHc4RP0SzFKhQCoBfSDc810Q7qJKInMBGKfcffPSoxkG4rmPV7fKJhJEBBX5LEpZRnoaIuJB8kGNiuElZCBs8p2IRAodlITHs0ozlZUjiGYvP8S9FEy7JuDBGCjuxRMk8kXPhcDmRwmj+tzU70n+5OUaHITkIycOQPA7JoB+SwTAkg4OQDB6GZPA4JMN+SIbDkAwPQjJ8aMEaPg69iPAIrgMwGFosm88LuzOesBE0HMHcRlQbprg+B3ZNfgCZwwQAl4SWXbJLA8wPuRGfCpZUEpBrMuNJwgSZKJkRxWKec+QmlhuUXYcAD1EwKaHJpEjTBbngmtdwUHYq5wLwhiNyRV7lTLzlU0FoHMsC1hgxbJGK6KyWXKQLAPWE0UzjzJ8Lw1SuuGbAqoUuMSBMRVtWAEJZnQHsspKiyYE2r+am1amtDEjQ77lGnguiT5fSdN6QpoOIdDoln4Oyv/71r2fi6kwQchYA2zsLjshZUFY5C0L7DaQZfBu435fw48Hwkfu5gJ8Ph4/dzzlWHRy4nzP4OfRN3eY6C45wXKzAhbEjO/5KahBApeWZWDpgz8QQZ2Folm+ZAXz+ZaEnJfheSkEhiJfQf4AduArPhhnbGiuzfQCz5YIbTlO9ecK+xic05xZI66ddVVqZ+QHMHHnZ5mnj509oznV44AvKUPsJZW7tk5cGCMVwC4rafW7iwdAKtaMVTB5GToXZjEg7hU8GjzVw7gqNrS5vjsWHgEUQpycgTjejspS4nxA+2zDdFVLX9XtzzD6KUAlG7WQzXl2FTwirTYjuCqervd4co48Bo6DmbUYnfP2EcFkDBz44ndl+6x90B4fdYX940MAnWCdshSzrJkl3sVh83FpkXIwsHNCoVj+jl+s/gNEEVMdyJcovoMFwMS2bNb+urrqt11pIUDgdJkDn9MdPq/SCkQp151XbAh79q1ruwIN/+/P4n+EUPvYHVJY4rbk6jpTmn/oR2siELu5p25VvWp68oH5bN7Zg4ieAA01h8Uzy2AEPdfx5awzWnghw0MVF7SVJr7aoUJgk3SzrtgrhZxdpoFaYZVGSRK2aK4RiCzOSJCFZLV5bniQky7INxba8UdzLstVZRFnmYHPY87S3ss4ZFzwr4IQEVjV7QIeKcMhw6M3cWnJBOp0ff/zxx+6f/9x99qzT8WvohnBUXDNk2BHo5R2NUCf6TueIvJiQehEaE6wZB7lAeTB0RlVbYSbnwp+H8NSoSFKAPdFXtcakjC6wM8bNjKnmOFJVJAunRzhsjaWZReQdHi7hb38IKw9LeJD6EhinOxlv5p2uwq/FPisu2Rx4K2vdzJoavHVFLfKMKV+vNyk2LVKq2CVY/zSXYoUn3kYG3ky+tdiip+XK0oJ2RWfZZd7QQb545c7g90vzYmsu0NsxiQtt0CQxZZckp8YwJbCzC5ryhOL+6GIBu6RZDqaV3l/OzpLf/XsPDbtgOzXWopDwKQd7fO8vp8fd/36/pkaR50zFVDOSMhhJh4SZOCKnM5bmlUtgPp9H8wc6nkmZWn/AB63YxP5/JMcfRghuHlGd3183U0sMNUMqEEvbjoqbs4YxqolvucaUikuDu2bQRw3OWSq2qHCuxiekd7RAgo/WKg2fT0H0o3ILxMuqvyXwnLPgfSXu0XjKkmvavt9he8JuSOmYpaufbr61UrqQhdvR3lnQnKqj6BrenCpU2oNxOv2w9pFetj7ab8s1+9QipL5NvbT329OvAEm5LgVJA5311s5lgI4fwRj6ksaM+AbgqPNc4GN3QQnYbtvA20dx7a4ZAuoRrFi6a/xo14zQWJgVSe50Be93mpS9epR5QV7HF7QE/2elJmwZwekKm0cAJ8/mAc7EAK2Q3nq55XzianxCvKIF0vZtfBsu0pDMtxGpt9qAflr1DbhGvEJVK1jLzac3776IvLImdd8IzO1xzHLQtD56a5Yg7yyh0GpsLehfowV9M+XV7eyfEPWtAesXpkBX766lz62ItD77z4hQG2DvTKzW6J/R6Rb7DX7+hMizDs96E4ersWKsGqCl30qULRZq/L59woN+Y8KHzQk/7N/ixNUY9uMPXP0t+FkZCs7WRUpXxEHCYp7RFCNIEO7hR+zR2xy+HGCwB76RWV6Y+qZDsw4yFq8l+LgI69n9XUi6IemEpBeSL0JyPyJvGEZSxGXUhVMauLKxFVyQRBbgJo0LlS7IWMHEQ8KiaUSurn4qqDDcLJZL0iFXVxC9tVxGsAvPhZzbwItTcBkbAoFT1aEqkbFeE2glY92D01fvJZt3fbBYz4F2n3whWyxh61HUoeDXPZFZqGpEAqO8LFU2eyrFSB+u85QuCJ2Am9pGg2AzGzQUAYqPyJD8/ikZDKN+PyR9+zf5wk9weB/3MPqYYpZuc1Li5+t2cL++g6uf61jWYX+nLVwf9pY7GLoYYQwBjnutwlZt7k/QdFJNpm2srWn1gDMrP/VMFmkC0lMxUyjByvi9UqfvdF4rNuFpWgvfI77I72kIh2Ipy1zImAvcg+MMhipwYSTsGx/L0emM2URCmALED6JhkFYBfnZsK7obISCxYtRIRWZUWzsLYhoghgBJM2NZK2DCg1cFTXDhYQdSHtydRXD4ZZO4Hx42iPuwKZ82EvcmCt5iKIQmOpdCl/5AVn2qUR326ctXjxZtSvKdwnJjvEwV9oNMDAkn5eeszmu40F5Lc1C2w+C+mUmpqxouEs3xXX3UjHCTCoLc7kdlaMjHur0Gjx40lIjHv6Lbq7lK/YPe4LC31e/VcpHc/LBIyC5Lilb1nZYUa1ZruncKfYxT6ON3xIO7NMwOHg0b54kH24TzJ2KYre+oa0yyd2F4vdXZdp0FtL4Pd7R9/mo2yI8ny4PKGjO+M2tMi3E/GvwLrDEfS6IrRpc7I0pyVxaXdZS5g8llq53loym3DuwvTr2Hd2OeaZ11vmxog18O69R6ePhx1No2ztRI7izg//X1qzfz/p++ncrj4+Pjl2/fzZ6/mx4fH2fwO4qitSa7dWSAw4D+7PKAnIhHdWHDKFEUobueGnqEzXu5mH5l24eb20RnIggDmUOuFpfiRRIcBQlkd/mDQBAiXpg2X8tkERxdBS7QH/50gdfQsvdBQ3rYVaDjGcso/OXxCQllkM8VhAHGuEFOGSxwcBTI8QcWwxi5AhgMZxpaYu2jK1/LpkEFodPZgqPAzisIA+c5LovKBLI8mQTLEHsa5VTruVTJ1i7LkqpL6MBCfMOGGv8oD1PQD6Qe3bKbl9B02crDu1VPz2o94NwydiLB8pQyw57Rha71a8+wQTv9D9oA74hdK5LQhQYeVGgrSGOaxkUKiim7zLlalKFTqJ3WyKqEtxyphHdwuAwDG7NSB4kqRRdBGHDDsnr5BipS8uYrFzMJmMFY4Zu2/SDZmLE/uAKwgeHC0+zGUHyQjIwZLno+k+LG7QfDB4Ph4MFgCD24OMib9uHtedDFBzke3WojJOwiKJdytPuCNGmumX8EvZTiyqe7lGF3LgoqVzJmWkfkGBJBWOJ0vqMqvgps5KX17f6RDeSb0QtGgNMyClYNUcugaKaaXXA2hx6OyBsWM37hYKsnpkIVjE35ynqLsW8hWxlxNIcAId8VtLFpM6682e1X0L4NUZmzaXk5E0UGHNfOMQgDC2oQBn4o4L811mDrLcPAAXb7DWe/rq5vczWbK0K61YRCm70RXcfMfH3cH3TKrudaJ5sySWsJbM4+R/OcURVhQuetc4ubjLDU6qJr2N4yDC6vn8wliWXXp6mSL1I2MTb8icRSCabu18NZP5nJDQ8OlmGwuH56i89yeo9g8ebXz+4HzO+tcp//FbA+eLwMg9n1sH5XZiD/C4E9eLis1LAAzdLM88PRWCaLkedby+sqeo0C6k1kmjD1Yq1O2NQAIdN+1FYIxlKmjIo1jKaRsOhuRYBDFzihnOluPmPo1ivPYth7ddBzLisLrYsebkRkcg1nJFWwsyCC4ODq2IhysZ0z6euiYBGS3MPxRrpANn6v534Dju7VbwUAv0IVx+5BwMrEsCxPMU1+Ds6JMXoxkoiU/1lh5DEJAHi9yg98vaj4xkaQ4oCuUTPHnLizSUS+oaLMM25mgJKrq5IMkDqWS3J1BavK1Ai0s+UyrApgrEYBKmC2RFlRX29VFrGqYVlWa2p1YYyqtgVOK6sD4CKvC+X6gSPDchk1CLIFOLpnHA5YUtIZ5OquzrpUbHGld8b+CrIdBUAn/2/w/iR/+h1fA8qTXv70Sf70B7hRImd271n0TLhI7M6fszSNyBNtlBTTpy0UPOm58vVLqVAlxI2Lq1r10sZt2VHkYPoRGHW1eFyTWBUxpymGToN+7L2A6LIEy402LNfgG+fGatKodOPBjU4VQ5+j1U4Lgzdo4NHfD/iEkplik9/fa+H03lNMHoeYgSc9+tTVfmFtUVbjFguCE0fDmVTWKjspFLLJOKWKT5ydISQ5KOcM7xugsfXqW4x6OE5mVJzr8MlYPYU09DJ9/ed//BNqeJ7+QrxSCVM7MHVIv7BWtHvAx+6FNuQcyZ0rbXx6BXJCRyHlaWTd1nHZuhB78Lxk/boYa6glfH8VazWKT6cMvLauBjZ2FyMwGs+s0ECoqhCEHIhHFtqDBwTmj+2JiwspU0Hqpr4admqpJnbu0RqujhKSi5GEFiOb/LIDWvGigxZi7WQsvFyTcSrjcyAF0PjAyqmrK078UasQhqeYr58D7hOf4QIIROpqz5liSG5EnouJVDHTxEJcw22FFrS1opkLJB0AfK+GnXtofE11iRzyzOIQF/QeWkubGMOiZRigYjCSk0nKBUPF5FZ06OcJwcK6GEM2BLUXCnlFoESTuzjC3QohCLuEfAzkBjJFqWpvfbAcZ/eZ2JsqXp283mECaITuWsDc7RFI4rYP8urkNdzEU+51SDMqt4HfV7RRhYC1j1xw6m/rKI91C3vqZtb36oRinXAidwdOl6wClHC9FqLQanSAwvKmq5WOq6udYH/KwkDIBHfXViCL3YLIE1nswpKuwSQl0wKzEQ3wbq8yYVZMdZMOF9qowsan+9SwtTYUjyePFahU6z8kTGjbnJIJhs6EpBAcMK8K8EuUXbLLnCkOIWprUaCYRR3Ijev1k6ZZ6N2b792FXrWEN89AfcewAXKkGmQJK7ykPfW1hwEnu68HEBR3DLxz1qqcKS0FyDepplQ48WmNEeBBGbMZTW1VJyfAbY/8DOh1rXnu53/8swbXRrvlKmB2BJokEER1DYTojLIED5xGsRzEn2xCBP0x9Yf2+S8ouV0mk3Ij6d1p/DVmeemS17kQpDIEShfxDHSWUtjqsLwOw1mUNPqdymt0ZA7zZZdcm9oVMd6EuMof3riEzgoGK4+SxPLSRX2DV6FZstUdng1587Ko8gS8KiEKI0eKZVzspqTU/XxGloygMDKjhsfEd6Wj5hVgNvzE7+usCkgEarzgUt3fsFWhu5EUMQPRzy6Y2sG2U4udBLfBmJk5Y6IOm0eSLAWvvdgHZW8DJ60s2AaU4D/ImJqyUQzmSaQ6tgMSOx3oqtMhXQuI46m6UM4j667PQ+YBfKTqHcBxB6EyCbzSPOq3FkbkOzkHhJW6LJw4bP+AT4KQu7uf6iPEVGAGLii8cEw3XjOyGUUY3uuGsLF5uFg4G6dtx9ZVC73AdW8wTrhtTp5/ltntFK5s86N7nQImB442QlOJ+8mdKVp3VSFQL/C2rhnKH1w/8CzbcfwVeqiH/Pz3/9Wg0LmIZl3aOdZ+RVMFKmKYilzv1ZOzJ/ioaZjw9Cyk4ZPFSIpRxUfWEkyz5VYCWhNO2VRlhOPCOLjXaIDSgToA0VaKwT9NR8DK+m4eDBByRwOCIxK8FFOqkrSUGnYZDV5USeuEZIfaRA14jtxAdtQYGs8YXvCVsByuupRO87YirmamgvUEPwATIww82MV/4cTisraapwHEJ6C3OwlCGwgSvF+GwTiOb9sjSMyGOzDEomGjbOWC1XEcky/GKQf0UDWW9gLS+0dOGaYJ7ENUdFp6cWNRLfKRnTQ0HF47A3rU2SDddf6dJmT+7kmf0u4Fp9W58Q7VbAxJQRhwjMdI1LC8LXPFYfSLeZy2uY9csOzeefQZeVcG/f5v2Xn0oP/5OI8O+p+R8+gxAOtiva7nJptOdWt5h4/b2t7gg2Q2BiOVantNkDvol7IRh+sQXG2H4dL+V/m7PBOvlzUCuazRH9tUgVnOgOfnglgY9vvwT3M1nzV0CzjRF2iNw3tE/y0Id48K274EJbT8xtFasw98+LfL+GL4GvC4wYKwtQNHiIVK4f5uEF/dUv/Bk2wNt1yg5Q5RPEpkPFJMj4b9/mgQ2IU5WIfGtzJjVvmdAzLnYLAvTwFGLQidghoPNK7uEKtMqevI72aQrcGEp6HRQQMJh6tIeCHwugy8Nv5EnjPx6860PryxwwOol1la8YCA20r4PWhMtl5uJ6lZXChuFsHR6VVw2aU579rvR6fvl+/hIGpmEgIrc6kRYmpmwVHQa8dZaqYuMODt9MqSb0mRmooEwslX2CPNee9iEEGcV7vNWna6pT4rujdtog2dcjG9rt37CkVvYRntSjUQVel/Of8TAwXQrUO9VhhwIJ8Zo2ARAcwDdbypolOf+zX2EaTrgkJXYkKDoFreduCmj9tshGK2Jd2a4Mr1sZWDw1pU46kPUMSYwzLkcF0UYYkNHxdYhgXWIv1qgX5V7F4jdA+j8VrBeFWYWKmLn1abpwy08qryAHXM4cEBKmOPBqi1PHiMCsHBwyWSexVZEQTN6AkMqm7HAHycS7vp0d67aX9DbtqWl9YSz3pXozPFrHOquU81L1WjxLpbXFHT/eCptzT3N2zubZP7RvP3Buu3B7lp5S0BWWdcPVxr03RN1tuv3Me6cWS9ocPZOXa3WdSMBms4h9eTm3wDEjWAbzzoI9846CPfeNxvqOgO11UPlaKN2nSpTLsJVAozaMXvQSxwMZEoUxzfK++vB5GPMmnlYMXSWGbl9fGdTo0Yy1adTikY7IYCm9irQpFczpmaFPZO+knKLvFSfWjGMvxWRYAxmoHlLIVcT8OmaEXFawQqpzOJaU7HPOWg09h0bru1K7VIR/BKgI8hu6fsRQkXLAVVqLT5w2WQXm2fS3U+gVg0sNGNwQkM9jsmZlTE1sFkBTQ6SsCQU93ar40CqLmFTQqjYD9nVNApcpqwvnNJwlJgvJooOQb/q5ZpYfmFoTyVyiYJ4IQwuwmR+Pwyh094OgQpptgMdtGFczPq0Lp5raB1L+6MIZwiB1g4GICNJIWAaAEbllFAOIA0zp0vJw0YoblRVGg4Dbi8BLcGJcKcB5BpZ2p9pxms8PdcnNtnALrktKSrH9hYc8Oa1wy2OcH9ZptvufmuGMPzL1JzI9Wiaj3lZlaMUYuqd1L+sD19619YqulIu9/J8daabHXv+PULVMLvk5///j/ke0aVIDM5t9QaF4qli+oxJ3zqCFfeoq3UodHHDOIGMB5b4nNS0mPwhxk1aLd/yebgILFbykbBf8sMOXERheQ/SOMnXDAA0fGKZfICHLhCMFgaqhaNYEWQvaVbxLEn+8QUmnycabtqgQH4Z01t8CyoB28mzpVjz7xlyGNIijxpFrga1XZDeV1+Rk2/afnWLLWXuhIlC2MJ2NtVPTSI1FxJYz3XeTLxQK9Kup0gx5FbwNfGx16rwAbnQoSsMucgdAOWnMqlOHJVhYM6AGtK5nrIKie9JvYsh17BBqJW8HotoldWCiacF+OUx+0JR+TYZU363JC1iSFhLdkjbORrROStgz/bLXXkK2I70mvzQb7yKR/wnS4qjau0svtgklZYGVfMeWiCsH2qako59JcB7povtNGcu0186pkBad6aenNmYo1eqPrhsdwpSTTnawME4J0s/WrylqkLHntbzAY+2sPKvSAMUh4zZ4FzWsPxt6+/JxcPon4Q1s6qO7DU3vcvvnn+8u1zAAaWwCJsEPWjPjoKpDYZFbWRmk/gtRWKWpbk/sG8/YN5+wfz9g/m7R/M2z+Yt38wb/9g3v7BvP2Deb/ebbL7B/M2XaK7fzBv/2DeKh73D+btH8xbudRv/2De/sG8/YN5+wfzfpN3o+4fzNs/mLeJfe4fzNs/mLd/MO+Tvpd5/2De/sG8/YN5+wfz9g/m7R/M2z+Yt1363IpI9w/m3fxG9v2DefsH8/YP5u0fzNs/mLd/MG//YN7+wbz9g3n7B/P2D+Z9Rk6h/YN5+wfz9g/m7R/M2z+Yt38w706NM7+RB/Nqae69PKVc1K4cste7nLae0XsfBjO4/uXoNLi6glHewZ0LUPxTgdn9p+/D4IIqDlHZeHNM6G86gbz6cwbXW3xjUwa6JzB8aPc8ZtW1LsyBq1psC5vjuLVu/Yaa16/ensClAO59iEwmeDUVnUMePp3bSxFqyfpYdhWkVEwLTPQPbJ9Le4HtrHmzyzne7OL+qN0WAJeWVBA2r3yx04D/w6TWNri6srfG4HUgtr79tLGFQ6yvDcv3frlc/h/7PLfy",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},f=void 0,y={},w=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Draft Document"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/draftdocument",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Unique identifier for this widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Specify the hint for widgets. This parameter is optional and is not applicable to the following widgets: checkbox, radio button, dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options":{\n "hint": "Provide signature"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp",\n "hint": "Provide stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials",\n "hint": "Provide initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide email",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide name",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide job title",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide company",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12,\n "min_date": "",\n "max_date": "",\n "readonly": false,\n "signing_date": false,\n "hint": "Provide date"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"min_date:"})," Provide the minimum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"max_date:"})," Provide the maximum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"signing_date"}),": If signing_date is set to true, the signing date is shown to the signer during signing. You may set either signing_date or default, but not both. Using both is not supported."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio Button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image",\n "hint": "Provide image"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"14",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Provide number",\n "formula": "",\n "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,s.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"decimalplaces:"})," Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"15",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"cells"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "cells",\n "page": 1,\n "x": 100,\n "y": 100,\n "w": 114,\n "h": 50,\n "options": {\n "name": "cells",\n "required": true,\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"cell_count:"})," Specify the number of cells that should be returned to the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,s.jsx)(n.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "required": true,\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "response": "04/15/2024",\n "format": "mm/dd/yyyy",\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "required": true,\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(g.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(h(),{...t(78599)}),"\n",(0,s.jsx)(u(),{...t(40777)})]})}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)}},78599(e){e.exports=JSON.parse('{"title":"Body","body":{"content":{"application/json":{"schema":{"required":["file","title"],"type":"object","properties":{"file":{"type":"string","format":"base64","example":"base64 encoded pdf"},"file_password":{"type":"string","format":"string","example":""},"title":{"type":"string","format":"string","example":"sample document"},"note":{"type":"string","format":"string","example":"sample Note"},"description":{"type":"string","format":"string","example":"sample Description"},"timeToCompleteDays":{"type":"number","description":"time to complete days is used to calculate expiry date of your document","format":"number","example":15},"signers":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","format":"string","example":"ceo"},"email":{"type":"string","format":"string","example":"joebee@example.com"},"name":{"type":"string","format":"string","example":"joe bee"},"phone":{"type":"string","format":"string","example":"123121312"},"company":{"type":"string","format":"string","example":"opensign"},"job_title":{"type":"string","format":"string","example":"dev"},"signer_role":{"type":"string","format":"string","description":"Specifies the role of the recipient in the signing process. Allowed values:\\n- **signer** (default): Must have at least one signature widget.\\n- **viewer**: Receives the document to view only; must have no widgets.\\n- **approver**: Reviews and approves the document; no signature widget required.\\n","enum":["signer","viewer","approver"],"example":"signer"},"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Allowed values - signature, stamp.","format":"string","example":"signature"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":244},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":71},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":38},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":46}},"title":"createdocument_body_widgets"}}},"title":"createdocument_body_signers"}},"folderId":{"type":"string","example":""},"send_email":{"type":"boolean","description":"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \\"true\\". If the value of this parameter is \\"true\\" and no \'email_subject\'/\'email_body\' parameters are specified default email templates will be used. \\n","example":true},"email_subject":{"type":"string","description":"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.","example":"{{sender_name}} has requested you to sign {{document_title}}"},"email_body":{"type":"string","description":"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.","example":"

Hi {{receiver_name}},

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

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

Sign here

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

Thanks,
Team OpenSign\u2122

"},"sendInOrder":{"type":"boolean","description":"If set to \'true\', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to \'true\'.","example":true},"send_in_order_strict":{"type":"boolean","description":"When set to \'true\', each signer is blocked from accessing the document until all preceding signers have completed their action. Enforces strict sequential signing. Only applies when \'sendInOrder\' is also \'true\'. Defaults to \'false\'.","example":false},"allow_offline_sign":{"type":"boolean","description":"If set to \'true\', signers can submit a copy of this document signed using an external tool for owner review. Defaults to \'false\'.","example":false},"enableOTP":{"type":"boolean","description":"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.","example":false},"enableTour":{"type":"boolean","description":"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.","example":false},"redirect_url":{"type":"string","description":"Specifies the URL where the signer will be redirected upon completing the document signing process.","example":""},"sender_name":{"type":"string","description":"The name of the person or organization on whose behalf the email is being sent.","example":"opensign\u2122"},"sender_email":{"type":"string","description":"The email address of the person or organization that users can reply to.","example":"mailer@opensignlabs.com"},"allow_modifications":{"type":"boolean","description":"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.","example":false},"auto_reminder":{"type":"boolean","description":"Set to true to enable automatic reminders. Set to false to disable them (default behavior).","example":false},"remind_once_in_every":{"type":"number","description":"Number of days between reminders. This is only applicable when auto_reminder is set to true.","example":5},"merge_certificate":{"type":"boolean","description":"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\\n\\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\\n\\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\\n","example":false},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed.\\n"},"prefill":{"type":"object","description":"You can provide widgets which can embed before sending to signer","properties":{"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","format":"string","example":"textbox"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":100},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":30},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":40},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":80},"options":{"type":"object","properties":{"name":{"type":"string","example":"textbox"},"response":{"type":"string","example":"joe"},"color":{"type":"string","example":"red"},"fontsize":{"type":"number","example":12}}}}}}},"title":"prefill"}},"title":"draftdocument_body"}}},"required":true}}')},40777(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Document created successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"document_id":{"type":"string","format":"string","example":"hji2zxcv2P"},"url":{"type":"string","format":"string","example":"https://url-to-send-document.com"}},"title":"inline_draft_doc_res_200_1"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/ff9450a5.95443097.js b/assets/js/ff9450a5.95443097.js new file mode 100644 index 000000000..c3c9f47c0 --- /dev/null +++ b/assets/js/ff9450a5.95443097.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[7377],{15483(e,n,t){t.r(n),t.d(n,{assets:()=>f,contentTitle:()=>y,default:()=>w,frontMatter:()=>x,metadata:()=>i,toc:()=>j});const i=JSON.parse('{"id":"API-docs/v1.2/draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","source":"@site/docs/API-docs/v1.2/draftdocument.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/draftdocument","permalink":"/docs/API-docs/v1.2/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":"eJztPWtzGzeSfwU3uTpb3CEp0rLjMF7fKrY38W1iqyx5XTnRK4EzIAlrBpgAM6K4Mqv2w9b9gKv7cl/3T9z3+yn5JVfdeMyDDz3s9To5pmrXIgaPRqPRaHQ3ui+DnE50MDgOnsqoSJnIdfA2DGKmI8WznEsRDIKjKSNPFR3nxFUi+wfPCU0SOdOk0ExpkksyYYIpmjMi2IzErjsympNMyXMeczEhMc0pmfF8SigZUc0e7BEmIhmzmIx5wjpDMRRHPBuQ11kiaUzmslDk4OnvfX8wEJQdt1pP2aiYkNfPW623d6d5nulBt0uzrCMzJjSfiISOdCeSaTeGilk83gnJbMoUg15JRAVhVPNkTmgckxmPJyzXIcmnTJBIZnMSSaliLmjOdEgyOmFEFOmIKR0SKmKSSsUIF4QSxWg8b+eyXWhG/u3w5QsyliqleYccJIUO/XAxVyzKk7npPp8yP6s72mFD54qLSUhSegb44jn5qeDRGUxbMxHDv9Bw/+A54qrVOiyyTKqcxeSNmcKg1YIv37BEzghVDOtHMk2lIBlVNGU5LtiU5vhZsZ8KrlhslyVJHC4GQ9EmrZagKRu0WuS14D8VjPCYiZyPOVMwS5JPubYNOqZ+Ps+w/nMR8wiQhwBAKZHjelVAKlQ9zFgEXZqqFVQTKchsyqMp4nBGzfpnCY3MtBTTGYtyfs7qHV+EZA4dP2VCOgimUvE/S5HTBJfvnKmcRzSpLjMACFV1TlUO6M8kF7krtSOQH+1ywmrjIlo6BNBiQG7KBX7RjJzTpGDaQjULyRSgesUyxTRuDtsvIF7EZMr4ZLp2PBq/K3Re65gUGsCsQmHHcquK6GWItjFNNCN8XMNlSs9YZTQicdPTpEO+mZOYjWmR5CHhQKG5KliHvJA5oVmW8IiOEoY0AJuN5oVibVxlSz6dOvkcIA9gmlAS8/GYKdjM8BG7sG0cdECXJdPAnZZPqSBSNBY6kolUyySExXU8kkiKnIm8Q/bPKU8QeDNZTbiIkiJmZJTQ6Cwko6RgIVEsNht9zoDRhWZ/YBVCtcU54odolgAVSgHwC2mH55poC1XcIUewUfz+g48O1TgI11Ws2l0+ljAyoMBtScJSypMQEReSd3JEcp4nLIQNnlExD4HDspDk7CIfyYuQRFMWneFfisZcklGR51KYicVKZrGcCYvLsRS55n9esSPdl5tjtB+SvZA8CMnDkPR2Q9Lrh6S3F5Leg5D0HoakvxuSfj8k/b2Q9B8YsPoPQ3dEOARXAej1DZbzXxZ2pzxmJ9DwBOZ2QnXOFNdnwK7JGzhzmADg4tCwS3aRA/NDbsQngsXlCcg1mfI4ZoKMlUyJYhHPOHITww181yHAQxRMSmgyLpJkTs655hUc+E7lTADecESuyMuMiUM+EYRGkSxgjRHDBqmIznLJRTIHUI8YTTXO/JnImcoU1wxYtdAeAyIvacscgFBWZQDXWUlR50DrV3Pd6lRWBk7Q77lGngtHn/an6ax2mvY6pNXyfA7KTk9Ph+JyKAgZBsD2hsGADANfZRiE5hucZvCtZ39fwI97/S/tzzn8fNB/aH/OsGpvz/6cws++a2o31zAY4LhYgYvcjGz5K6lAAJUWQ7GwwA5FH2eR0zTbMAP4/PeFnnjw3SkFhXC8hO4D7MBleNbM2NRYmu09mC0XPOc00esn7Gp8RnNugLR62mWlpZnvwcyRl62fNn7+jOZchQe+4BlqPuGZW/nkTgOEor8BRc0+1/FgaIXS0RIm73esCLMekWYKnw0eK+B8LDQ2urw5Fh8AFuE4PYLjdD0q/Yn7GeGzCdPHQuqqfm+O2S87KASjdLIer7bCZ4TVOkQfC6fLvd4cow8BoyDmrUcnfP2McFkBBz5Ymdl8291r9+63+7v9vRo+QTthKqRpO47b8/n8w9Yi5eLEwAGNKvVTerH6AyhNQHT0K+G/gATDxcQ3q39dXnVTr7GQIHBaTIDM6a6fRugFJRXKzsu6Bbz6l7XshQf/dvfxH+AWPnIXVBZbqbm8jnj1T/UKncuYzu9o05Vr6m9eUL8pGxsw8RPAgaqwaCp5ZIGHOu6+NQJtTwdw0MZF7cZxt7KoUBjH7TRtNwrhZxtpoFKYpp047jRqLhGKKUxJHIdkuXhleRyTNE3XFJvyWnE3TZdn0UlTC5vFnqO9pXVOueBpATck0KqZCzpUhEuGRW9q15IL0mr9+OOPP7Z/+KH99Gmr5dbQDmGpuKLIMCPQi480QpXoW60BeT4m1SJUJhg1DnIBfzG0SlVTYSpnwt2H8NaoSFyAPtFVNcqklM6xM8bzKVP1caQqSRZuj3DZGsl82iGv8XIJf7tLmL8s4UXqK2Cc9ma8nnfaCp+KfZZcsj7wRta6njXVeOuSWOQYU7ZablJsUiRUsQvQ/mkuxRJPvM0ZeLPzrcEWHS2XmhbUK1rNLnOKDnL3pb2D73j1YmMu0Ns+iQqdo0piwi5IRvOcKYGdndOExxT3RxsL2AVNM1CtdP80HMa/+ecuKnZBd5objULMJxz08d0/He+3//3tihpFljEVUc1IwmAkHRKWRx1yPGVJVpoEZrNZZ3ZPR1MpE2MPeKcVG5v/P5GjdycIbtahOttZNVNDDBVFKhBLU4+Km7OCMaqJa7lClYpLg7umt4sSnNVUbBDhbI3PSO5ogAQfjVYaPh/D0Y/CLRAvK/+WwHOGwdvyuEflKYuvaPv2GtsTdkNCRyxZ/nTzrZXQuSzsjnbGgvpULUVX8GZFIa8PxunshpWP9KLx0XxbrNinBiHVbepOe7c93QqQhGt/kNTQWW1tTQZo+BGMoS1pxIhrAIY6xwU+dBd4wK63DZx+FNfuiiGgHsGK3lzjRrtihNrCLJ3kVlZwdqex79WhzB3kVXxBS7B/lmLChhGsrLB+BDDyrB9gKHqohXTayw33E1vjM+IVDZA2b+PbcJHayXybI/VWG9BNq7oBVxyvUNUcrH7z6fW7r0NeGpW6awTq9ihiGUhaH7w1PcjXPqFQa2w06N+gBn095VX17J8R9a0A6+9Mgbbexz59bkWk1dn/ggi1Bva1idUo/VM62aC/wc+fEXlW4Vmt4rA1lpRVPdT0mxNlg4Yav2+ecG+3NuH79Qk/2L3Fjas27IdfuHY34GdpKLhbFwldOg5iFvGUJuhBgnD3P2CP3ubyZQGDPfBEplmRVzcdqnWQsTgpwflFGMvub0LSDkkrJN2Q3A3JToe8YuhJEXmvCys0cGV8K7ggsSzATBoVKpmTkYKJh4R1Jh1yeflTQUXO8/liQVrk8hK8txaLDuzCMyFnxvHiGEzGOQHHqfJSFctIr3C0kpHuwu2r+4LN2s5ZrGtB2yF3ZYMlbLyKWhR82huZgapCJDDKCy+ymVspevpwnSV0TugYzNTGGwSbGaehDqB4QPrkt49Jr9/Z3Q3Jrvmb3HUT7O/gHkYbU8SSTUZK/HzVDt6t7uDy5yqWdX/3Wlu4OuwtdzB0cYI+BDjulQJbubk/Q9VJOZmmsrYi1QPOzPmpp7JIYjg9FcsLJZj33/Myfat1oNiYJ0nFfY+4IrenwR2KJSy1LmPWcQ+uM+iqwEUuYd84X45Wa8TGEtwUwH8QFYO0dPAzY5uju+YCEilGc6nIlGqjZ0FMA8TgIJlPWdpwmHDglU4TXDjYgZR7H08j2P+qTtwP7teI+379fFpL3OsoeIOiEJroTArt7YGs/FShOuzTlS9fLZqU5DqF5UZ/mdLtB5kYEk7Cz1iV13ChnZRmoWy6wT2ZSqnLGtYTzfJdPah7uEkFTm47He8a8qFmr96X92pCxMNPaPaqr9LuXrd3v7vR7tUwkdz8skjIdZYUterXWlKsWa7p1ij0IUahD98R9z6mYrb3Zb92n7i36XD+TBSz1R11hUr2Yyheb3W3XaUBre7Da+o+P5kO8sPJcq/Uxow+mjamwbi/7P0DtDEfSqJLSpePRpTkY2lcVlHmNVQuG/UsH0y5VWD/7tR7/+OoZxp3na9q0uBX/Sq13r//YdTaVM5USG4Y8D9+8/LVbPcP307k/v7+/ovD19Nnryf7+/sp/O50OitVdqvIAIcB+dm+A7JHPIoLa0bpdDporqc5HWDzbiYmX5v24fo2naEIwkBm8FaLS/E8DgZBDK+73EUgCBEvTOffyHgeDC4D6+gPf1rHa2jZfafhedhloKMpSyn85fAJD8rgPVcQBujjBm/KYIGDQSBH71gEY2QKYMg509ASaw8uXS3zDCoIrcwWDAIzryAMrOXYF/kHZFk8DhYh9nSSUa1nUsUbu/QlZZfQgYH4hg01/uEvU9APPD26ZTcvoOmi8Q7vVj09rfSAc0vZkQTNU8Jy9pTOdaVfc4cNms//oA3wjsi2IjGda+BBhTYHaUSTqEhAMGUXGVdz7zqF0mmFrDy8fiQPb+/+IgyMz0oVJKoUnQdhwHOWVsvXUJGSN1+5iEnADPoK37TtO8lGjP3OFoAODBeepjeG4p1kZMRw0bOpFDdu3+vf6/V793p96MH6Qd60D6fPgy7eydHJrTZCzM4Dv5Qn11+QOs3V3x9BL/64cs9dvNud9YLKlIyY1h2yDw9BWGxlvkHpXwU6cq992xkYR74pPWcEOC2joNUQlRcU9adm55zNoIcBecUixs8tbNWHqVAFfVO+NtZi7FvIxos4moGDkOsK2phnM7a83u3X0L4JkX+zaXg5E0UKHNfMMQgDA2oQBm4o4L8V1mDqLcLAAnb7DWe+Lq9vfTXrK0La5YRC83qjcxUzc/Vxf9AJu5prHa17SVp5wGb1czTLGFUdfNB567fFdUbopbrOFWxvEQYXV0/mgkSy7Z6pkrsJG+fG/YlEUgmmdqrurJ/N5Pp7e4swmF89vfkvcnpfwuLNrp7dG3zfW759/kfAeu/hIgymV8P6nX+B/A8Edu/BohTDAlRLM8cPT0Yynp84vrW4qqKTKKDeWCYxU89XyoR1CRBe2p80BYKRlAmjYgWjqT1YtFER4NIFRiiruptNGZr1/F0Mey8vetZkZaC13sM1j0yu4Y6kCjYMOuAcXF4b8Vxsvpl0dfFgEZLcwfFOdIFs/E7X/gYc3alGBQC7QunH7kDAyiRnaZbgM/kZGCdGaMWIO8T/Zw4jh0kAwMlVbuCrj4onxoMUB7SN6m/Mib2bdMgTKvw74/oLUHJ56ckAqWOxIJeXsKpMnYB0tliEZQGMVStAAcyUKHPUV1v5IlY29GWVpkYWRq9qU2ClsioA1vO6ULYfuDIsFp0aQTYAR/OMxQGLPZ3BW93lWXvBFlf62thfQralAOjk/w3eH2WPv+MrQHnUzR4/yh6/gYgSGTN7z6BnzEVsdv6MJUmHPNK5kmLyuIGCR11bvnopFYqEuHFxVctemrj1HXUsTD8Coy4Xj2sSqSLiNEHXaZCPnRUQTZagudE5yzTYxnluJGkUuvHiRieKoc3RSKdFjhE08OrvBnxEyVSx8W/vNHB65zE+HgefgUdd+tjWfm50UUbiFnOCE0fFmVRGKzsuFLLJKKGKj62eISQZCOcM4w3QyFj1DUYdHEdTKs50+GikHsMzdP98/ee//g1qOJ7+XLxUMVPXYOrw/MJo0e4AH7sTGpdzJHeudO6eVyAntBTibyOrto59rQu+B88869fFSEMt4forWWuu+GTCwGpra2BjGxiB0WhqDg2EqnRByIB4ZKEdeEBg7toeW78Q/xSkquqrYKfy1MTMvbOCq+MJycWJhBYn5vHLNdCKgQ4aiDWTMfByTUaJjM6AFEDiAy2nLkOcuKtWIXKe4Hv9DHAfuxcugECkruacKbrkdsgzMZYqYpoYiCu4LdGCulZUc8FJBwDfqWDnDipfE+2RQ54aHOKC3kFtaR1jWLQIAxQMTuR4nHDBUDC5FR26eYKzsC5G8BqCmoBCThDwaLKBI2xUCEHYBbzHQG4gEzxVTdQHw3GuPxMTqeLl0cE1JoBK6LYBzEaPQBI3fZCXRwcQicfvdXhm5LeB21e0VoWAto+cc+qidfhr3dzcupmxvdpDsUo4HRsDp02WAYq5XglRaCQ6QKGPdLXUcRnaCfanLHJwmeA2bAWy2A2IPJLFdVjSFZikZFLga8QceLcTmfBVTBlJhwudq8L4p7unYSt1KA5PDitQqdJ/SJjQpjklY3SdCUkhOGBeFWCX8F2yi4wpDi5qK1GgmEEdnBtXyyd1tdDrV9/bgF6VB2+OgbqOYQNkSDXIEpZ4SXPqKy8D9uy+GkAQ3NHxzmqrMqa0FHC+STWhwh6fRhkBFpQRm9LEVLXnBJjtkZ8Bva5Uz/38179V4Fqrt1wGzIxA4xicqK6AEI1RhuCB0yiWwfEn6xBBf0z9rnn/Czy3S2XsN5K+Po0f4Csv7XmddUHyLlC6iKYgs/jDVoc+HIbVKGm0O/kwOjKD+bILrvNKiBinQlzmD6/sg84SBnMexbHhpfPqBi9ds2SjO7wb8nqwKH8DXj4hilyeKJZycT0hpWrny6VnBEUuU5rziLiudKceAsy4n7h9nZYOiUCN51yqnTVbFbo7kSJicPSzc6auodup+E6C2WDE8hljogqbQ5L0B68J7INnbw0njVewNSjBfpAyNWEnEagnkerYNZDYakFXrRZpG0AsT9WFshZZGz4PmQfwkbJ3AMdehPwj8FLyqEYt7JDv5AwQ5mVZuHGY/gGfBCG3sZ+qI0RU4AtcEHjhmp47yci8KEL3XjuE8c3DxcLZWGk7MqZa6AXCvcE44aY5Of7pX7dTCNnmRncyBUwODG2EJhL3k71TNGJVIVDPMVrXFM8fXD+wLJtxXAg9lEN+/st/axDorEez9nqOlV9RVYGCGD5FrvbqyNkRfKeumHD0LGTOx/MTKU5KPrKSYOotNxLQCnfKuigjLBfGwZ1EA5QO1AGINqcY/FM3BCyt7/rBACEfaUAwRIKVYkJVnPhTwyxjjoEqaZWQzFDrqAHvkWvIjuY5jaYMA3zFLINQl9JK3uaIq6ipYD3BDsDECToeXMd+YY/FRWU1jwPwT0BrdxyExhEkeLsIg1EU3bZHODFr5sAQi/q1sqUAq6MoIndHCQf0UDWSJgDpzsAKwzSGfYiCTkMuri2qQT6yk5qEwyt3QIu6Tz1BmN+nmVlm3I9XWa7qILmomu6xvhMJzG0Co8OmI3juhK7UeEFG2dFpaZdMYX83W9omw5h1A96axX5BdqPe7u6v2Sx2b/eXYxbb2/0FmcUeArDWi+1qbrLuvrqSdziPtM0N3klmvEsSqTbXhBMVLW7Gl3IVgsvt0F+Y/0pLnmPi1bKai5oxZ2Cb0uXMqibdXBAL/d1d+Ke+mk9rUhPoKgrUM2KE1H8Kwuv7u21eAg8tv7Ef2vQd7//5IjrvHwAe1+hGNnZgCbFQCUQmh+Or7SU7vKNXcMsF6iQRxSexjE4U0yf93d2TXmAWZm8VGg9lyoxYPwNkzsAU4e83uZoTOoELCtC4+ohYZUpdRX43g2wFJhwNnezVkHB/GQnPBQYCwYD4R/KMiU870+rwuRkeQL1Ik5IHBNxUwu9BbbLVcjNJzaJC8XweDI4vg4s2zXjbfB8cv128hSt2PpXgMppJjRDTfBoMgm7Tg1QzdY6ufMeXhnw9RWoqYnCUX2KPNOPd814HPNiabVay0w31WdG+aROd0wkXk6vavS1RdAjLaFaqhqhS/sv4HxgIgHYdqrXCgAP5TBkFXQ9gHqjjVel3+8ytsfONXeXuuuTtGgTl8jZdUp1Has3JtHnSrXAbXe012rtf8dc8dq6X6E3pnSlX+Ud6bDiPR+/wWPFhrLgwll6JNadE9DNsuBmWDnBeFj8uN493IXOicg9lzP7eHgpjX/ZQarn3EAWCvQcLJPfSZyQI6n4h6C7e9G74MGN93Va/NUD/igzQDfuzIZ7VRlSrZFplLrSfKva3WokxJNmiumHFUa83ZNSsCU1jwlrF/hq9vgO5rr/2gKxSG99fqa21TVZr5uzHqtpntQrHanCur6y4We2KimEFn3FSdZ3LwIMV4DL3dpHL7O0il3m4WxPo7cqUPZRiOcreXvS20y3Fa5Ch38IhwsVY4glkuaSP4w8CAp5gTYb/RZVWfTXQ/T0mrdYRPidloq1loSKGCYBMXoAEbcmYeuXnv/wXGRU8MZ5aMTtnCYgxkExHFdrGjGE+KYDumJj61XEn6E+NqT+8SgcNl7GxVrYxxw5h7ZK5gC8aSMAknypZTKaoyxQTiCn46tnh0bhIMEsOOQRdYpmOqOZMBnl2BGhDvG8bwAwZPpxZUOc0L9BQpBiwMQ6ZISw7AjMLM6wKnAhURTOV8DGL5lFikGOS6hjD8DkTsVQEvBza3KQgaLfb8M8XX5BvjVaVHEIUWhZD6TPYL96ZBA3cEVVqbsb1cp+zP5xWhIxTYsQLHARfH1U+Dsgj6KEseOyjyrRaP//Hf5Lj7+SsltapPuD1Y4Ecmknp7v7BcxSRd8z6v8AQooo5Gy64Qk64+FfQDeJcWi0rKxImzrmSAlALLvyn15YlT3fsyZNLm5vGmufHYwjTJiYkAQqGN1SNpXgCWr8nNKMjnnCQyKH8PXlCczaRak7ekzdgvfG5nSR5PxTv2+02/g+qtlo+p1arRd6TJ3jbNL42ISkyk0tEsXN5ZmkqZvi+psyn45a9JF/b85GjV+z5m4InMVGssEa9iqNmPgWjSRtjmfikFl/7XFLw3kEq2AVzb+m0QxyyZNyG/YlDfOuoQENxQ7GvS7x6Tx5xznOjvR1DIirb6UExSnhE6uAfTtGWQzLz0W29hIsz3D7C6VzxLWWZsMphGVOTvZHqDEYyPcIJX0KHlmCHE6oJXlbMo4sxFzTh2lpC8Ubo+n1iTnsD4w+GT8ydgINKOCMNjKQ8AxKbKJqi4RU8tVwnv0cB0vTxEg3sugqZff7v2fRTBeRopE6/Em/YaCrlmenEPj5BdtTGp1nsHFMpVRTmmhjKRAcfwkRs8ljZ7lD1bvvKFWcgDJksL8ZAA5IDvK4x6gVYwff1rQGEj+a4F2wGfMcdGF/AtgGbGVN+hd0YNBmK02+fHZGuW4nugMenOGK9HNb41MhoI7AU61wxmoIUFCM1KBYXIgYf6obfsmKpPAeDpYght5iNoYIZ5zBg8ayMwuLMmcncqFDtipYdtlo+BZvXJ2G6OONZFEmhi9SEHINZH9gLWPtAydw4nYCF1OZmGwr4Tk6H9dvaMDh1XNvtc5D8jd17JtUZd5ZVJiI1z2yvYM33AVekGAzF6cHLwyPSNdosh8ZT8r//Q04PXi9hHIsrDRwxdgeu3km9Wu1qv/ShMR5+AB4BKD11+HlpxFhyaLc2bC0lk6EAv4TT4Qph173IJe+NDfcULBVrJoo0tGKm4BNxAeoXDp5Z1j0CJBTr/GDH8wwH4xKDN6Lrxq/voaGPVzKBcwCEolPLLU+JUd4gfZlH2WAvPx1Wr6aw0mPOQC8fKak1CgQ4C9hdShY5Qz8IxcxbN+uH71Z5YI4eGB2YvXHSKNTSgWNhOiUt/8gNWRfKDO7x5sanboZFnJr3Y6clt2k8dRtL5zRonDYsk/bhiuxzL9OZe4MG3YHruL99uersArBmj47Sd5Yrc/d771mLMSA+AV/Hu0+e7ABwNvPVUOxj1snTYRBFJbbtti/jE6G3gg+44t2BTodwYyjbydKtIvTEEJpjw9yL3SHoV7FrznO/mM+qvlZM48llvEQ8jKWx05hG2+jFeXPDJ/keHon7OYCrMqlBQ+46hymzS8odz+PTnYp7oAcN1kthtj7zxN/ycrRShHjgGC4FmE24dRIBcLN8TtDsSe6eHr893fmaSPBQNX7TgNpcEi6mTPF8RdcNEaxMK/eslP+sHFYpgT0Bt3NwB1yWwQ6NiIjn3Q3kRi+w+CtIvYeNakLf+tlr8J1YanyVevK0eeL+kSmIxQVr9C/kGxqdzaiKNUYQpDlHCXUOVaExEIfJ9TZyFduRrZgYCZic90wOzF6n5y8oTkzQzsEI3IbOzcDW26aS882onUYO79irkGSkmDk1oykVE9gIICNUDmoOjD8uIrMXEF7o2ud4K4RxMwEtzIxbR6m4QRivNYPr3fdcnCE5tMmxl6DesJHmOavHf29iegfb/L5IEp/SFjfcFZca0+xbnn9XjCCLp9Q8l2petprwfFqMcC2rbf0P24GTpb3R4EMuU9jlEVMpOuccMnXOoyum34Ukpbq7g35RDd11XTuA/lbAd+oZfmnG7bXz2MFB6lH3bz4PY1pEkRqNH1YVRTO+0sEUp/BybOdrFfmb5xuEQcIjZu2cVtuy/+3B9+T8Xmc3CCsWgWusZff750+evTh8BsDYbQI67M5uZxfdMaTOUyoqI9VTKDcVMZUoG9uEy9uEy9uEy9uEy9uEy9uEy9uEy9uEy9uEy9uEy58uG8E24fK6JAzbhMvbhMvLeNwmXN4mXF4KCr1NuLxNuLxNuLxNuPyrjK2/Tbi8Tbi8jn1uEy5vEy5vEy5/1nk9tgmXtwmXtwmXtwmXtwmXtwmXtwmXN58+tyLSbcLlm2f02SZc3iZc3iZc3iZc3iZc3iZc3iZc3iZc3iZc3iZc3iZc/gUZhbYJl7cJl7cJl7cJl7cJl7cJlz+qcuZXknC5Eh6omyWUi0pgRxNE77iRhvltGEwhyN7gOLi8hFFeQ2QrKP6pwBhKx2/D4JwqDl7ZGJ8vdPHkIB7RGYMgYk/Mk4H2EQwfmj2Pr+oaYQkhIJ5psY+EvrFuNQ4gPMmH0Es2v1gqYwwASmcQv4jOTOipSpAjLLsMEiomBQZICkyfC5MAYVqPn3eG8fPsH5UoSxAaroSwHljPTAP+Hya1ssHlpYnNh0HXTH3zaW0Li1hXG5bv7WKx+D8PRVuQ","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Self Sign","permalink":"/docs/API-docs/v1.2/selfsign"},"next":{"title":"Create Document","permalink":"/docs/API-docs/v1.2/createdocument"}}');var s=t(74848),r=t(28453),o=t(57742),l=t.n(o),a=t(78178),d=t.n(a),c=t(19624),h=t.n(c),p=t(96226),m=t.n(p),u=(t(77675),t(19365),t(51107)),g=t(21312);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:"eJztPWtzGzeSfwU3uTpb3CEp0rLjMF7fKrY38W1iqyx5XTnRK4EzIAlrBpgAM6K4Mqv2w9b9gKv7cl/3T9z3+yn5JVfdeMyDDz3s9To5pmrXIgaPRqPRaHQ3ui+DnE50MDgOnsqoSJnIdfA2DGKmI8WznEsRDIKjKSNPFR3nxFUi+wfPCU0SOdOk0ExpkksyYYIpmjMi2IzErjsympNMyXMeczEhMc0pmfF8SigZUc0e7BEmIhmzmIx5wjpDMRRHPBuQ11kiaUzmslDk4OnvfX8wEJQdt1pP2aiYkNfPW623d6d5nulBt0uzrCMzJjSfiISOdCeSaTeGilk83gnJbMoUg15JRAVhVPNkTmgckxmPJyzXIcmnTJBIZnMSSaliLmjOdEgyOmFEFOmIKR0SKmKSSsUIF4QSxWg8b+eyXWhG/u3w5QsyliqleYccJIUO/XAxVyzKk7npPp8yP6s72mFD54qLSUhSegb44jn5qeDRGUxbMxHDv9Bw/+A54qrVOiyyTKqcxeSNmcKg1YIv37BEzghVDOtHMk2lIBlVNGU5LtiU5vhZsZ8KrlhslyVJHC4GQ9EmrZagKRu0WuS14D8VjPCYiZyPOVMwS5JPubYNOqZ+Ps+w/nMR8wiQhwBAKZHjelVAKlQ9zFgEXZqqFVQTKchsyqMp4nBGzfpnCY3MtBTTGYtyfs7qHV+EZA4dP2VCOgimUvE/S5HTBJfvnKmcRzSpLjMACFV1TlUO6M8kF7krtSOQH+1ywmrjIlo6BNBiQG7KBX7RjJzTpGDaQjULyRSgesUyxTRuDtsvIF7EZMr4ZLp2PBq/K3Re65gUGsCsQmHHcquK6GWItjFNNCN8XMNlSs9YZTQicdPTpEO+mZOYjWmR5CHhQKG5KliHvJA5oVmW8IiOEoY0AJuN5oVibVxlSz6dOvkcIA9gmlAS8/GYKdjM8BG7sG0cdECXJdPAnZZPqSBSNBY6kolUyySExXU8kkiKnIm8Q/bPKU8QeDNZTbiIkiJmZJTQ6Cwko6RgIVEsNht9zoDRhWZ/YBVCtcU54odolgAVSgHwC2mH55poC1XcIUewUfz+g48O1TgI11Ws2l0+ljAyoMBtScJSypMQEReSd3JEcp4nLIQNnlExD4HDspDk7CIfyYuQRFMWneFfisZcklGR51KYicVKZrGcCYvLsRS55n9esSPdl5tjtB+SvZA8CMnDkPR2Q9Lrh6S3F5Leg5D0HoakvxuSfj8k/b2Q9B8YsPoPQ3dEOARXAej1DZbzXxZ2pzxmJ9DwBOZ2QnXOFNdnwK7JGzhzmADg4tCwS3aRA/NDbsQngsXlCcg1mfI4ZoKMlUyJYhHPOHITww181yHAQxRMSmgyLpJkTs655hUc+E7lTADecESuyMuMiUM+EYRGkSxgjRHDBqmIznLJRTIHUI8YTTXO/JnImcoU1wxYtdAeAyIvacscgFBWZQDXWUlR50DrV3Pd6lRWBk7Q77lGngtHn/an6ax2mvY6pNXyfA7KTk9Ph+JyKAgZBsD2hsGADANfZRiE5hucZvCtZ39fwI97/S/tzzn8fNB/aH/OsGpvz/6cws++a2o31zAY4LhYgYvcjGz5K6lAAJUWQ7GwwA5FH2eR0zTbMAP4/PeFnnjw3SkFhXC8hO4D7MBleNbM2NRYmu09mC0XPOc00esn7Gp8RnNugLR62mWlpZnvwcyRl62fNn7+jOZchQe+4BlqPuGZW/nkTgOEor8BRc0+1/FgaIXS0RIm73esCLMekWYKnw0eK+B8LDQ2urw5Fh8AFuE4PYLjdD0q/Yn7GeGzCdPHQuqqfm+O2S87KASjdLIer7bCZ4TVOkQfC6fLvd4cow8BoyDmrUcnfP2McFkBBz5Ymdl8291r9+63+7v9vRo+QTthKqRpO47b8/n8w9Yi5eLEwAGNKvVTerH6AyhNQHT0K+G/gATDxcQ3q39dXnVTr7GQIHBaTIDM6a6fRugFJRXKzsu6Bbz6l7XshQf/dvfxH+AWPnIXVBZbqbm8jnj1T/UKncuYzu9o05Vr6m9eUL8pGxsw8RPAgaqwaCp5ZIGHOu6+NQJtTwdw0MZF7cZxt7KoUBjH7TRtNwrhZxtpoFKYpp047jRqLhGKKUxJHIdkuXhleRyTNE3XFJvyWnE3TZdn0UlTC5vFnqO9pXVOueBpATck0KqZCzpUhEuGRW9q15IL0mr9+OOPP7Z/+KH99Gmr5dbQDmGpuKLIMCPQi480QpXoW60BeT4m1SJUJhg1DnIBfzG0SlVTYSpnwt2H8NaoSFyAPtFVNcqklM6xM8bzKVP1caQqSRZuj3DZGsl82iGv8XIJf7tLmL8s4UXqK2Cc9ma8nnfaCp+KfZZcsj7wRta6njXVeOuSWOQYU7ZablJsUiRUsQvQ/mkuxRJPvM0ZeLPzrcEWHS2XmhbUK1rNLnOKDnL3pb2D73j1YmMu0Ns+iQqdo0piwi5IRvOcKYGdndOExxT3RxsL2AVNM1CtdP80HMa/+ecuKnZBd5objULMJxz08d0/He+3//3tihpFljEVUc1IwmAkHRKWRx1yPGVJVpoEZrNZZ3ZPR1MpE2MPeKcVG5v/P5GjdycIbtahOttZNVNDDBVFKhBLU4+Km7OCMaqJa7lClYpLg7umt4sSnNVUbBDhbI3PSO5ogAQfjVYaPh/D0Y/CLRAvK/+WwHOGwdvyuEflKYuvaPv2GtsTdkNCRyxZ/nTzrZXQuSzsjnbGgvpULUVX8GZFIa8PxunshpWP9KLx0XxbrNinBiHVbepOe7c93QqQhGt/kNTQWW1tTQZo+BGMoS1pxIhrAIY6xwU+dBd4wK63DZx+FNfuiiGgHsGK3lzjRrtihNrCLJ3kVlZwdqex79WhzB3kVXxBS7B/lmLChhGsrLB+BDDyrB9gKHqohXTayw33E1vjM+IVDZA2b+PbcJHayXybI/VWG9BNq7oBVxyvUNUcrH7z6fW7r0NeGpW6awTq9ihiGUhaH7w1PcjXPqFQa2w06N+gBn095VX17J8R9a0A6+9Mgbbexz59bkWk1dn/ggi1Bva1idUo/VM62aC/wc+fEXlW4Vmt4rA1lpRVPdT0mxNlg4Yav2+ecG+3NuH79Qk/2L3Fjas27IdfuHY34GdpKLhbFwldOg5iFvGUJuhBgnD3P2CP3ubyZQGDPfBEplmRVzcdqnWQsTgpwflFGMvub0LSDkkrJN2Q3A3JToe8YuhJEXmvCys0cGV8K7ggsSzATBoVKpmTkYKJh4R1Jh1yeflTQUXO8/liQVrk8hK8txaLDuzCMyFnxvHiGEzGOQHHqfJSFctIr3C0kpHuwu2r+4LN2s5ZrGtB2yF3ZYMlbLyKWhR82huZgapCJDDKCy+ymVspevpwnSV0TugYzNTGGwSbGaehDqB4QPrkt49Jr9/Z3Q3Jrvmb3HUT7O/gHkYbU8SSTUZK/HzVDt6t7uDy5yqWdX/3Wlu4OuwtdzB0cYI+BDjulQJbubk/Q9VJOZmmsrYi1QPOzPmpp7JIYjg9FcsLJZj33/Myfat1oNiYJ0nFfY+4IrenwR2KJSy1LmPWcQ+uM+iqwEUuYd84X45Wa8TGEtwUwH8QFYO0dPAzY5uju+YCEilGc6nIlGqjZ0FMA8TgIJlPWdpwmHDglU4TXDjYgZR7H08j2P+qTtwP7teI+379fFpL3OsoeIOiEJroTArt7YGs/FShOuzTlS9fLZqU5DqF5UZ/mdLtB5kYEk7Cz1iV13ChnZRmoWy6wT2ZSqnLGtYTzfJdPah7uEkFTm47He8a8qFmr96X92pCxMNPaPaqr9LuXrd3v7vR7tUwkdz8skjIdZYUterXWlKsWa7p1ij0IUahD98R9z6mYrb3Zb92n7i36XD+TBSz1R11hUr2Yyheb3W3XaUBre7Da+o+P5kO8sPJcq/Uxow+mjamwbi/7P0DtDEfSqJLSpePRpTkY2lcVlHmNVQuG/UsH0y5VWD/7tR7/+OoZxp3na9q0uBX/Sq13r//YdTaVM5USG4Y8D9+8/LVbPcP307k/v7+/ovD19Nnryf7+/sp/O50OitVdqvIAIcB+dm+A7JHPIoLa0bpdDporqc5HWDzbiYmX5v24fo2naEIwkBm8FaLS/E8DgZBDK+73EUgCBEvTOffyHgeDC4D6+gPf1rHa2jZfafhedhloKMpSyn85fAJD8rgPVcQBujjBm/KYIGDQSBH71gEY2QKYMg509ASaw8uXS3zDCoIrcwWDAIzryAMrOXYF/kHZFk8DhYh9nSSUa1nUsUbu/QlZZfQgYH4hg01/uEvU9APPD26ZTcvoOmi8Q7vVj09rfSAc0vZkQTNU8Jy9pTOdaVfc4cNms//oA3wjsi2IjGda+BBhTYHaUSTqEhAMGUXGVdz7zqF0mmFrDy8fiQPb+/+IgyMz0oVJKoUnQdhwHOWVsvXUJGSN1+5iEnADPoK37TtO8lGjP3OFoAODBeepjeG4p1kZMRw0bOpFDdu3+vf6/V793p96MH6Qd60D6fPgy7eydHJrTZCzM4Dv5Qn11+QOs3V3x9BL/64cs9dvNud9YLKlIyY1h2yDw9BWGxlvkHpXwU6cq992xkYR74pPWcEOC2joNUQlRcU9adm55zNoIcBecUixs8tbNWHqVAFfVO+NtZi7FvIxos4moGDkOsK2phnM7a83u3X0L4JkX+zaXg5E0UKHNfMMQgDA2oQBm4o4L8V1mDqLcLAAnb7DWe+Lq9vfTXrK0La5YRC83qjcxUzc/Vxf9AJu5prHa17SVp5wGb1czTLGFUdfNB567fFdUbopbrOFWxvEQYXV0/mgkSy7Z6pkrsJG+fG/YlEUgmmdqrurJ/N5Pp7e4swmF89vfkvcnpfwuLNrp7dG3zfW759/kfAeu/hIgymV8P6nX+B/A8Edu/BohTDAlRLM8cPT0Yynp84vrW4qqKTKKDeWCYxU89XyoR1CRBe2p80BYKRlAmjYgWjqT1YtFER4NIFRiiruptNGZr1/F0Mey8vetZkZaC13sM1j0yu4Y6kCjYMOuAcXF4b8Vxsvpl0dfFgEZLcwfFOdIFs/E7X/gYc3alGBQC7QunH7kDAyiRnaZbgM/kZGCdGaMWIO8T/Zw4jh0kAwMlVbuCrj4onxoMUB7SN6m/Mib2bdMgTKvw74/oLUHJ56ckAqWOxIJeXsKpMnYB0tliEZQGMVStAAcyUKHPUV1v5IlY29GWVpkYWRq9qU2ClsioA1vO6ULYfuDIsFp0aQTYAR/OMxQGLPZ3BW93lWXvBFlf62thfQralAOjk/w3eH2WPv+MrQHnUzR4/yh6/gYgSGTN7z6BnzEVsdv6MJUmHPNK5kmLyuIGCR11bvnopFYqEuHFxVctemrj1HXUsTD8Coy4Xj2sSqSLiNEHXaZCPnRUQTZagudE5yzTYxnluJGkUuvHiRieKoc3RSKdFjhE08OrvBnxEyVSx8W/vNHB65zE+HgefgUdd+tjWfm50UUbiFnOCE0fFmVRGKzsuFLLJKKGKj62eISQZCOcM4w3QyFj1DUYdHEdTKs50+GikHsMzdP98/ee//g1qOJ7+XLxUMVPXYOrw/MJo0e4AH7sTGpdzJHeudO6eVyAntBTibyOrto59rQu+B88869fFSEMt4forWWuu+GTCwGpra2BjGxiB0WhqDg2EqnRByIB4ZKEdeEBg7toeW78Q/xSkquqrYKfy1MTMvbOCq+MJycWJhBYn5vHLNdCKgQ4aiDWTMfByTUaJjM6AFEDiAy2nLkOcuKtWIXKe4Hv9DHAfuxcugECkruacKbrkdsgzMZYqYpoYiCu4LdGCulZUc8FJBwDfqWDnDipfE+2RQ54aHOKC3kFtaR1jWLQIAxQMTuR4nHDBUDC5FR26eYKzsC5G8BqCmoBCThDwaLKBI2xUCEHYBbzHQG4gEzxVTdQHw3GuPxMTqeLl0cE1JoBK6LYBzEaPQBI3fZCXRwcQicfvdXhm5LeB21e0VoWAto+cc+qidfhr3dzcupmxvdpDsUo4HRsDp02WAYq5XglRaCQ6QKGPdLXUcRnaCfanLHJwmeA2bAWy2A2IPJLFdVjSFZikZFLga8QceLcTmfBVTBlJhwudq8L4p7unYSt1KA5PDitQqdJ/SJjQpjklY3SdCUkhOGBeFWCX8F2yi4wpDi5qK1GgmEEdnBtXyyd1tdDrV9/bgF6VB2+OgbqOYQNkSDXIEpZ4SXPqKy8D9uy+GkAQ3NHxzmqrMqa0FHC+STWhwh6fRhkBFpQRm9LEVLXnBJjtkZ8Bva5Uz/38179V4Fqrt1wGzIxA4xicqK6AEI1RhuCB0yiWwfEn6xBBf0z9rnn/Czy3S2XsN5K+Po0f4Csv7XmddUHyLlC6iKYgs/jDVoc+HIbVKGm0O/kwOjKD+bILrvNKiBinQlzmD6/sg84SBnMexbHhpfPqBi9ds2SjO7wb8nqwKH8DXj4hilyeKJZycT0hpWrny6VnBEUuU5rziLiudKceAsy4n7h9nZYOiUCN51yqnTVbFbo7kSJicPSzc6auodup+E6C2WDE8hljogqbQ5L0B68J7INnbw0njVewNSjBfpAyNWEnEagnkerYNZDYakFXrRZpG0AsT9WFshZZGz4PmQfwkbJ3AMdehPwj8FLyqEYt7JDv5AwQ5mVZuHGY/gGfBCG3sZ+qI0RU4AtcEHjhmp47yci8KEL3XjuE8c3DxcLZWGk7MqZa6AXCvcE44aY5Of7pX7dTCNnmRncyBUwODG2EJhL3k71TNGJVIVDPMVrXFM8fXD+wLJtxXAg9lEN+/st/axDorEez9nqOlV9RVYGCGD5FrvbqyNkRfKeumHD0LGTOx/MTKU5KPrKSYOotNxLQCnfKuigjLBfGwZ1EA5QO1AGINqcY/FM3BCyt7/rBACEfaUAwRIKVYkJVnPhTwyxjjoEqaZWQzFDrqAHvkWvIjuY5jaYMA3zFLINQl9JK3uaIq6ipYD3BDsDECToeXMd+YY/FRWU1jwPwT0BrdxyExhEkeLsIg1EU3bZHODFr5sAQi/q1sqUAq6MoIndHCQf0UDWSJgDpzsAKwzSGfYiCTkMuri2qQT6yk5qEwyt3QIu6Tz1BmN+nmVlm3I9XWa7qILmomu6xvhMJzG0Co8OmI3juhK7UeEFG2dFpaZdMYX83W9omw5h1A96axX5BdqPe7u6v2Sx2b/eXYxbb2/0FmcUeArDWi+1qbrLuvrqSdziPtM0N3klmvEsSqTbXhBMVLW7Gl3IVgsvt0F+Y/0pLnmPi1bKai5oxZ2Cb0uXMqibdXBAL/d1d+Ke+mk9rUhPoKgrUM2KE1H8Kwuv7u21eAg8tv7Ef2vQd7//5IjrvHwAe1+hGNnZgCbFQCUQmh+Or7SU7vKNXcMsF6iQRxSexjE4U0yf93d2TXmAWZm8VGg9lyoxYPwNkzsAU4e83uZoTOoELCtC4+ohYZUpdRX43g2wFJhwNnezVkHB/GQnPBQYCwYD4R/KMiU870+rwuRkeQL1Ik5IHBNxUwu9BbbLVcjNJzaJC8XweDI4vg4s2zXjbfB8cv128hSt2PpXgMppJjRDTfBoMgm7Tg1QzdY6ufMeXhnw9RWoqYnCUX2KPNOPd814HPNiabVay0w31WdG+aROd0wkXk6vavS1RdAjLaFaqhqhS/sv4HxgIgHYdqrXCgAP5TBkFXQ9gHqjjVel3+8ytsfONXeXuuuTtGgTl8jZdUp1Has3JtHnSrXAbXe012rtf8dc8dq6X6E3pnSlX+Ud6bDiPR+/wWPFhrLgwll6JNadE9DNsuBmWDnBeFj8uN493IXOicg9lzP7eHgpjX/ZQarn3EAWCvQcLJPfSZyQI6n4h6C7e9G74MGN93Va/NUD/igzQDfuzIZ7VRlSrZFplLrSfKva3WokxJNmiumHFUa83ZNSsCU1jwlrF/hq9vgO5rr/2gKxSG99fqa21TVZr5uzHqtpntQrHanCur6y4We2KimEFn3FSdZ3LwIMV4DL3dpHL7O0il3m4WxPo7cqUPZRiOcreXvS20y3Fa5Ch38IhwsVY4glkuaSP4w8CAp5gTYb/RZVWfTXQ/T0mrdYRPidloq1loSKGCYBMXoAEbcmYeuXnv/wXGRU8MZ5aMTtnCYgxkExHFdrGjGE+KYDumJj61XEn6E+NqT+8SgcNl7GxVrYxxw5h7ZK5gC8aSMAknypZTKaoyxQTiCn46tnh0bhIMEsOOQRdYpmOqOZMBnl2BGhDvG8bwAwZPpxZUOc0L9BQpBiwMQ6ZISw7AjMLM6wKnAhURTOV8DGL5lFikGOS6hjD8DkTsVQEvBza3KQgaLfb8M8XX5BvjVaVHEIUWhZD6TPYL96ZBA3cEVVqbsb1cp+zP5xWhIxTYsQLHARfH1U+Dsgj6KEseOyjyrRaP//Hf5Lj7+SsltapPuD1Y4Ecmknp7v7BcxSRd8z6v8AQooo5Gy64Qk64+FfQDeJcWi0rKxImzrmSAlALLvyn15YlT3fsyZNLm5vGmufHYwjTJiYkAQqGN1SNpXgCWr8nNKMjnnCQyKH8PXlCczaRak7ekzdgvfG5nSR5PxTv2+02/g+qtlo+p1arRd6TJ3jbNL42ISkyk0tEsXN5ZmkqZvi+psyn45a9JF/b85GjV+z5m4InMVGssEa9iqNmPgWjSRtjmfikFl/7XFLw3kEq2AVzb+m0QxyyZNyG/YlDfOuoQENxQ7GvS7x6Tx5xznOjvR1DIirb6UExSnhE6uAfTtGWQzLz0W29hIsz3D7C6VzxLWWZsMphGVOTvZHqDEYyPcIJX0KHlmCHE6oJXlbMo4sxFzTh2lpC8Ubo+n1iTnsD4w+GT8ydgINKOCMNjKQ8AxKbKJqi4RU8tVwnv0cB0vTxEg3sugqZff7v2fRTBeRopE6/Em/YaCrlmenEPj5BdtTGp1nsHFMpVRTmmhjKRAcfwkRs8ljZ7lD1bvvKFWcgDJksL8ZAA5IDvK4x6gVYwff1rQGEj+a4F2wGfMcdGF/AtgGbGVN+hd0YNBmK02+fHZGuW4nugMenOGK9HNb41MhoI7AU61wxmoIUFCM1KBYXIgYf6obfsmKpPAeDpYght5iNoYIZ5zBg8ayMwuLMmcncqFDtipYdtlo+BZvXJ2G6OONZFEmhi9SEHINZH9gLWPtAydw4nYCF1OZmGwr4Tk6H9dvaMDh1XNvtc5D8jd17JtUZd5ZVJiI1z2yvYM33AVekGAzF6cHLwyPSNdosh8ZT8r//Q04PXi9hHIsrDRwxdgeu3km9Wu1qv/ShMR5+AB4BKD11+HlpxFhyaLc2bC0lk6EAv4TT4Qph173IJe+NDfcULBVrJoo0tGKm4BNxAeoXDp5Z1j0CJBTr/GDH8wwH4xKDN6Lrxq/voaGPVzKBcwCEolPLLU+JUd4gfZlH2WAvPx1Wr6aw0mPOQC8fKak1CgQ4C9hdShY5Qz8IxcxbN+uH71Z5YI4eGB2YvXHSKNTSgWNhOiUt/8gNWRfKDO7x5sanboZFnJr3Y6clt2k8dRtL5zRonDYsk/bhiuxzL9OZe4MG3YHruL99uersArBmj47Sd5Yrc/d771mLMSA+AV/Hu0+e7ABwNvPVUOxj1snTYRBFJbbtti/jE6G3gg+44t2BTodwYyjbydKtIvTEEJpjw9yL3SHoV7FrznO/mM+qvlZM48llvEQ8jKWx05hG2+jFeXPDJ/keHon7OYCrMqlBQ+46hymzS8odz+PTnYp7oAcN1kthtj7zxN/ycrRShHjgGC4FmE24dRIBcLN8TtDsSe6eHr893fmaSPBQNX7TgNpcEi6mTPF8RdcNEaxMK/eslP+sHFYpgT0Bt3NwB1yWwQ6NiIjn3Q3kRi+w+CtIvYeNakLf+tlr8J1YanyVevK0eeL+kSmIxQVr9C/kGxqdzaiKNUYQpDlHCXUOVaExEIfJ9TZyFduRrZgYCZic90wOzF6n5y8oTkzQzsEI3IbOzcDW26aS882onUYO79irkGSkmDk1oykVE9gIICNUDmoOjD8uIrMXEF7o2ud4K4RxMwEtzIxbR6m4QRivNYPr3fdcnCE5tMmxl6DesJHmOavHf29iegfb/L5IEp/SFjfcFZca0+xbnn9XjCCLp9Q8l2petprwfFqMcC2rbf0P24GTpb3R4EMuU9jlEVMpOuccMnXOoyum34Ukpbq7g35RDd11XTuA/lbAd+oZfmnG7bXz2MFB6lH3bz4PY1pEkRqNH1YVRTO+0sEUp/BybOdrFfmb5xuEQcIjZu2cVtuy/+3B9+T8Xmc3CCsWgWusZff750+evTh8BsDYbQI67M5uZxfdMaTOUyoqI9VTKDcVMZUoG9uEy9uEy9uEy9uEy9uEy9uEy9uEy9uEy9uEy9uEy58uG8E24fK6JAzbhMvbhMvLeNwmXN4mXF4KCr1NuLxNuLxNuLxNuPyrjK2/Tbi8Tbi8jn1uEy5vEy5vEy5/1nk9tgmXtwmXtwmXtwmXtwmXtwmXtwmXN58+tyLSbcLlm2f02SZc3iZc3iZc3iZc3iZc3iZc3iZc3iZc3iZc3iZc3iZc/gUZhbYJl7cJl7cJl7cJl7cJl7cJlz+qcuZXknC5Eh6omyWUi0pgRxNE77iRhvltGEwhyN7gOLi8hFFeQ2QrKP6pwBhKx2/D4JwqDl7ZGJ8vdPHkIB7RGYMgYk/Mk4H2EQwfmj2Pr+oaYQkhIJ5psY+EvrFuNQ4gPMmH0Es2v1gqYwwASmcQv4jOTOipSpAjLLsMEiomBQZICkyfC5MAYVqPn3eG8fPsH5UoSxAaroSwHljPTAP+Hya1ssHlpYnNh0HXTH3zaW0Li1hXG5bv7WKx+D8PRVuQ",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},y=void 0,f={},j=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(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:"name:"})," Unique identifier for this widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Specify the hint for widgets. This parameter is optional and is not applicable to the following widgets: checkbox, radio button, dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options":{\n "hint": "Provide signature"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp",\n "hint": "Provide stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials",\n "hint": "Provide initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide email",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide name",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide job title",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide company",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12,\n "min_date": "",\n "max_date": "",\n "readonly": false,\n "signing_date": false,\n "hint": "Provide date"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"min_date:"})," Provide the minimum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"max_date:"})," Provide the maximum restriction date. The date must be in ",(0,s.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"signing_date"}),": If signing_date is set to true, the signing date is shown to the signer during signing. You may set either signing_date or default, but not both. Using both is not supported."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio Button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image",\n "hint": "Provide image"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"14",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Provide number",\n "formula": "",\n "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,s.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"decimalplaces:"})," Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"15",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"cells"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "cells",\n "page": 1,\n "x": 100,\n "y": 100,\n "w": 114,\n "h": 50,\n "options": {\n "name": "cells",\n "required": true,\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"cell_count:"})," Specify the number of cells that should be returned to the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,s.jsx)(n.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "required": true,\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "response": "04/15/2024",\n "format": "mm/dd/yyyy",\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "required": true,\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,s.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(g.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(h(),{...t(78599)}),"\n",(0,s.jsx)(m(),{...t(40777)})]})}function w(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}},78599(e){e.exports=JSON.parse('{"title":"Body","body":{"content":{"application/json":{"schema":{"required":["file","title"],"type":"object","properties":{"file":{"type":"string","format":"base64","example":"base64 encoded pdf"},"file_password":{"type":"string","format":"string","example":""},"title":{"type":"string","format":"string","example":"sample document"},"note":{"type":"string","format":"string","example":"sample Note"},"description":{"type":"string","format":"string","example":"sample Description"},"timeToCompleteDays":{"type":"number","description":"time to complete days is used to calculate expiry date of your document","format":"number","example":15},"signers":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","format":"string","example":"ceo"},"email":{"type":"string","format":"string","example":"joebee@example.com"},"name":{"type":"string","format":"string","example":"joe bee"},"phone":{"type":"string","format":"string","example":"123121312"},"company":{"type":"string","format":"string","example":"opensign"},"job_title":{"type":"string","format":"string","example":"dev"},"signer_role":{"type":"string","format":"string","description":"Specifies the role of the recipient in the signing process. Allowed values:\\n- **signer** (default): Must have at least one signature widget.\\n- **viewer**: Receives the document to view only; must have no widgets.\\n- **approver**: Reviews and approves the document; no signature widget required.\\n","enum":["signer","viewer","approver"],"example":"signer"},"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Allowed values - signature, stamp.","format":"string","example":"signature"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":244},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":71},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":38},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":46}},"title":"createdocument_body_widgets"}}},"title":"createdocument_body_signers"}},"folderId":{"type":"string","example":""},"send_email":{"type":"boolean","description":"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \\"true\\". If the value of this parameter is \\"true\\" and no \'email_subject\'/\'email_body\' parameters are specified default email templates will be used. \\n","example":true},"email_subject":{"type":"string","description":"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.","example":"{{sender_name}} has requested you to sign {{document_title}}"},"email_body":{"type":"string","description":"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.","example":"

Hi {{receiver_name}},

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

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

Sign here

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

Thanks,
Team OpenSign\u2122

"},"sendInOrder":{"type":"boolean","description":"If set to \'true\', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to \'true\'.","example":true},"send_in_order_strict":{"type":"boolean","description":"When set to \'true\', each signer is blocked from accessing the document until all preceding signers have completed their action. Enforces strict sequential signing. Only applies when \'sendInOrder\' is also \'true\'. Defaults to \'false\'.","example":false},"allow_offline_sign":{"type":"boolean","description":"If set to \'true\', signers can submit a copy of this document signed using an external tool for owner review. Defaults to \'false\'.","example":false},"enableOTP":{"type":"boolean","description":"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.","example":false},"enableTour":{"type":"boolean","description":"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.","example":false},"redirect_url":{"type":"string","description":"Specifies the URL where the signer will be redirected upon completing the document signing process.","example":""},"sender_name":{"type":"string","description":"The name of the person or organization on whose behalf the email is being sent.","example":"opensign\u2122"},"sender_email":{"type":"string","description":"The email address of the person or organization that users can reply to.","example":"mailer@opensignlabs.com"},"allow_modifications":{"type":"boolean","description":"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.","example":false},"auto_reminder":{"type":"boolean","description":"Set to true to enable automatic reminders. Set to false to disable them (default behavior).","example":false},"remind_once_in_every":{"type":"number","description":"Number of days between reminders. This is only applicable when auto_reminder is set to true.","example":5},"merge_certificate":{"type":"boolean","description":"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\\n\\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\\n\\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\\n","example":false},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed.\\n"},"cc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"cc (carbon copy): Users added here will receive a notification email once the document is completed.\\n"},"prefill":{"type":"object","description":"You can provide widgets which can embed before sending to signer","properties":{"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","format":"string","example":"textbox"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":100},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":30},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":40},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":80},"options":{"type":"object","properties":{"name":{"type":"string","example":"textbox"},"response":{"type":"string","example":"joe"},"color":{"type":"string","example":"red"},"fontsize":{"type":"number","example":12}}}}}}},"title":"prefill"}},"title":"draftdocument_body"}}},"required":true}}')},40777(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Document created successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"document_id":{"type":"string","format":"string","example":"hji2zxcv2P"},"url":{"type":"string","format":"string","example":"https://url-to-send-document.com"}},"title":"inline_draft_doc_res_200_1"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/ffa808c5.5122d11a.js b/assets/js/ffa808c5.5122d11a.js deleted file mode 100644 index c44b39c65..000000000 --- a/assets/js/ffa808c5.5122d11a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[8744],{28248(e,n,t){t.r(n),t.d(n,{assets:()=>y,contentTitle:()=>f,default:()=>w,frontMatter:()=>x,metadata:()=>s,toc:()=>j});const s=JSON.parse('{"id":"API-docs/v1.2/createtemplate","title":"Create Template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.","source":"@site/docs/API-docs/v1.2/createtemplate.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/createtemplate","permalink":"/docs/API-docs/v1.2/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":"eJztPV1zGzeSfwU3dXW2ucMRSUu2o9RdrWL7Et9mbZctXyonabngDEjCmgEmAEYUo2LVPuw/uKd73Z+WX3LVDWA++CVakh35bvLgiIOvRqO70ehuNK4CQyc6ODwJjlmWp9QwHZyFQcJ0rHhuuBTBYXA8ZcQXk+eKUfhOjt6+IjRN5UyTQjOliZEkhkJG4kIbmfFf6ShlxPiOQzKb8nhKNFMXjFBNRmnBcsWF0WQsFZkwwRQ1XExIIuMiY1Aw42ZKcsUSNuaCJUQbVcSmUExH5EMuBdFFHDOtx0VajmTB4FKExEwZAqqYKZTQhJJC8F8KRjodX3vIk06HmCk1JKaCjBhMJ4HZOIBYDZwRhTIpsGOds5iPOVR2fUWn4lQc8/yQfMhTSRMyl4Uib1/8e9kF9AvfTjqdF2xUTMiHV53O2cOpMbk+3NujeR7JnAnNJyKlIx3FMttLoGKejB8BBpli0CvCyqjm6ZzQJCEznkyY0ThjQWKZz0kspUq4sKjP6YQRUWQjpnRIqEhIJhUjXBBKFKPJvGtkt9CM/Mf7N69hOTJqIvI2LXRYDpdwxWKTzm33gAE/qwcWM0/2YX24mIQko+ewkNyQXwoen8O0NROIVrcmiKtO532R51IZlpCf7BQOOx0o+Y6lckaoYlg/llkmBcmpohkzSG2wYFCs2C8FVyyxpELT1OPi8FR0SacjaMYOOx3ywS48T5gwsGoKic5MuXYNIlvfzHOs/0okPAbkIQDwlchxsyogFaq+d4Rgq9ZQDZRiiR5wOKN2/fOUxnZaigENGX7Bmh1fhmQOHb9gQnoIplLxX6UwNMXlu2DK8Jim9WUGAJEwDVXIR7nkwvivbgTys1tOWG1cREeHAFoCyM24wBLNyAVNC6YdVLOQTAGqdyxXTCM/uH4B8SIhU8Yn043j0eRjoU2jY1JoALMOhRvLryqilyHaxjTVjPBxA5cZPWe10YhEoUXTiHw3Jwkb0yI1IeFAoUYVLCKvpSE0z1Meo3QCGgBmoyBTurjKjnyiJvm8VfKCJwxESMLHY6aAmaEQu3BtPHRAlzk2gOkhp5kpFUSKpYWOZSrVKgnh5yYeSSyFYcJE5OiC8hSBt5PVhIs4LRJGRimNz0OUqyFRLLGMPmcgpUPLH1gFhK/FOeKHaJYCFUoB8Avphue6knAROQZGKfkPCj2qcRCu61h1XD6WMDKgwLMkYRnlaYiIC8lHOSKGm5SFwOA5FfOQJNSwkBh2aUbyMiTxlMXn+JeiCZdkVBgDgh3GTJTMEzkTDpdjKYzmv67hSF/y6RgdhGQ/JE9C8iwk/V5I+oOQ9PdD0n8Skv6zkAx6IRkMQjLYD8ngiQVr8MzhmpYIrgPQH1gsm68Lu1OesCE0HMLchlQbprg+B3FNfoI9hwkALrF7LlQst0k+gZ273AG5JlOeJEyQsZIZUSzmOUdpYqVB2XUI8BAFkxKajIs0nZMLrnkNB2WnciYAbzgiV+RNzsR7PhGExrEsYI0RwxapiM5qyUU6B1CPGc00zvylMEzlimsGolroEgPCVLRlN0D4VhcAu6ykaEqgzau5aXVqKwM76I9co8yFrU+Xu+mssZv2I9LplHIOvv31r389FVengpDTAMTeaXBIToOyymkQ2jLYzaCs735fwo/Hg6fu5xx+Phk8cz9nWLW/735O4efAN3XMBd9wYKzBhbFDOwFLaiBApcWpWDhoT8UAp2Folm+ZAhR/KfD9NgUfYX8JfQGw4Co8G2Zsa6zM9jHMlgtuOE315gn7GvdozksgrZ92VWll5vswcxRmm6eNxfdoznV4oAQ3UVuEm26tyG8HCMVgC4qW+9wkhKEVqkcrmDyInA6zGZF2CvcGjzVw7gqNS11+OhafABZhPz2G/XQzKsst9x7hcxmmu0Lqun4/HbNPI9SCUT3ZjFdX4R5htQnRXeF0tddPx+gzwCjoeZvRCaX3CJc1cKDAKc22rLff7R90B73BfgOfYJ6wFbKsmyTd+Xx+u7XIuBhaOKBRrX5GL9cXgNUEdMdyJcoS0GC4mJTNmqWrq27rLS0kaJwOE6B0+vOn1XrBKIXK86pxAc/+VS134sG//YH8z3AMH/kTKkuc2lyzZ3n7T/0MbWRC5w+07co3LY9eUH9ZObZgYhHAgbaweCp57ICHOv7ANQJzTwQ46OKi7iXJXm1R4WOSdLOsu/QRfnaRBmofsyxKkmip5gqh2I8ZSZKQrH5e+z1JSJZlGz7b743Pe1m2OosoyxxsDnue9lbWOeOCZwUckcCsZk/oUBFOGQ69mVtLLkin8/PPP//c/fOfuy9edDp+Dd0Qjoprlgw7Ar28oxHqRN/pHJJXY1L/hNYEa8dBKVCeDNHc6ytM5Uz4AxEeGxVJCjAo+qrWmpTROXbGuJky1RxHqopk4fgIp62RNNOIfMDTJfztT2HlaQlPUt9EaBXGo/Fm2ekqfCnxWUnJ5sBbRetm0dSQrStqkRdM+Xq9SbFJkVLFLsH8p7kUKzLxJnvgp+1vS2LR03JlakHDojPtMm/pIA/fuEP4o9K+uDQX6O3IeS6IYhN2SXJqDFMCO7ugKU+s46OLH9glzXKwrez95fQ0+cM/76FlF4ynxpoUEj7hYJDf+8vJUfe/ztbUKPKcqZhqRlIGI+mQMBNH5GTK0rzyCcxms2j2WMdTKVPrEPioFRvbf4dy9HGI4OYR1fmjdTO1xFCzpAKxLBtSkTlrGKOa+JZrbKm4NMg1/R5qcM5UsUWFczXukd6xBBIUWrM0FJ/A1o/KLRAvq/6WIHNOg7Nqu0frKUuuaXu2A3sCN6R0xNLVok9nrZTOZeE42nsLmlN1FF3Dm1OFSoMwTqcX1grp5VKhLVus4VOLkDqb+t3es6dfAZJyXW4kDXTWWzufAXp+BLM+uhEjvgEZlVR6ay4oAduNDbyBFNfumiGgHsGKpb/Gj3bNCI2FWdnJna7gHU/jslePMr+R1/EFLcF7W6kJW0ZwusLmEZz/dMMAp6KPZkhvvtxyPnE17pGsWAJpOxvfRIo0duabbKk3YkA/rToDrtleoardWEvm05u5LyJvrE3dNwJ7exyzHDStW7NmCfLOOxRajesm9M2UV691j6hvDVifmQJdvbvefW5EpPXZf0WE2gB7Z2K1Rv+MTrbYb7D4HpFnHZ71Jg5XY8VY1UdLv91RtliosXz7hPu9xoQPmhN+0rvBiasx7O0PXL0t+FkZCs7WRUpXtoOExTyjKYaQINyDW/DoTQ5fDjDggecyywtTZzo066Bg8VqCD4ywrt0/hKQbkk5I9kLyMCSPIvKOYShFXIZdOKWBKxtcwQVJZAF+0rhQ6ZyMFEw8JCyaROTq6peCCsPNfLEgHXJ1BdFai0UEXHgu5MxGXpyAz9gQiJyqDlWJjPWaSCsZ6z04fe29ZrPuC+dc3nOgPSIP5ZJI2HoUdSj4sicyC1WNSGCU16XKZk+lGOrDdZ7SOaFj8FPbcBBsZqOGIkDxIRmQf/030h9EvV5IevZv8tBPcPAIeRh9TDFLtzkpsfg6Du7VObj6uU5kHfR2YuH6sDfkYOhiiEEEOO61ClvF3PfQdFJNZtlYW9PqAWd2/9RTWaQJ7J42gJKVAXylTg8RCG8VG/M0rUXwEf/JczVERLGUZS5qzMXuwYEGoxW4MBI4x4dzdDojNpYQqQAhhGgapFWMnx3dbt6NKBAM/JSKTKm2lhbENcAMMZJmyrKlmAkPXhU3wYWHHYi5f3c2wcE3TfJ+ctAg74PmDrWRvDfR8BZTITTRuRS69AiyqqhGd9in/756uFimJd8pLDeGzFSRPyjGkHRSfs7q0oYL7fU0B+VyJNzzqZS6quGC0Zzk1YfNIDepIM7tUVQGh9zW8dV/+rihRjz7go6v5ir19vf6B3tbPV9LTpJPPy4SssuSol19pyXFmtWatm6h27iFbs8Rj+/SNNt/OmicKB5v257viWm2zlHXGGXvwvR6o9PtOhtonQ93tH5+MSvk7cly/3PYY5YE99P+72CPuS2Jrphd7owoyV3ZXNZR5g5Gl62WlltTbh3Yz069B3djoFk67XzT0Aa/GdSp9eDgdtS6bJ6pkdxpwP/zuzfvZr0/fT+RR0dHR6/ff5i+/DA5OjrK4HcURWuNduvIAIcB/dldBXJbPKoLG0aJoggd9tTQQ2y+l4vJt7Z9uLlN5CLyPpMn4eBLexJuLzfKql9mz1rnNvh8kuF2PEvcf6ciCAOZ4xVDKV4lwWFgryv6y3tBiMvHtPlOJvPg8CpwF0TgTxewD033Pmq4FnkV6HjKMgp/+WWHi5RjnkJXNnxFB2GAQZJwqxLIMjgM5Ogji00QQphFDpZxpqEPbHd45WvZi3RB6FT+4DCwbBGEgQs9KD8RJmIJcVx5Mg4WIfY0zKnWM6mSrV2WX6ouoQML8Sc21PhHeRUS+oHLazfsBpsulm6i3qineg+Lal2qzqhSdB4sX3r1t9Z8LIwLR/IGwHTu9yVuwDJXXqXCakEYcMOy+igbVl3JT8d0zCTMBIPDb7K8IItu0i6fSnGjhi6s9SZNP8rR8EbkWK31cHccN0mgeYkMeikVDn9nqQyddJFsuZJwGzkiR3CbhyVOaz+sYuTAz1FaUB8d2mDMKYUb0YakjIJdStRuwTTvC15wNoMeDsk7FjN+4WCr3y6GKhhf9K31+GPfQi5da6Q5ELbvCtrYu0/ue7Pbb6H9MkTlxdsIJSsTRQbir2QAC2oQBn4oEIE17rT1FmHgAFvDkTvykC1dXd/majZXhHSrCYX2Bk50nTzx9ZEX6KQ+prWerox5vOk6cO0WorOx0jxnVEV4K/fGF8TxDj5N4wKvwZe7b2NmJajlzPqLMLi8fjKXJJZdf9eYPEzZ2NgQNhJLJZh6VA9JvjeTG+zvL8Jgfv305l/l9J7C4s2un91PeEm7usD+e8D6+NkiDKbXw/pDeY38dwR2/8mi0oSWNMXhSCbzoZdbi+sqepUD6kEShFfijUqYqiFiJGXKqFjBBARR25PwAzhNPAht4CjeF+VKe3WDzMDVouyOUO5HVlg7ldZeJfN37sCD+BI+oDaui5GGWsL3p22HI0aM4pMJA8+Lq4GN3f1mRjGbh3DhrJUjMVfsgstCe/DAHQM6QMrAw2K9u2VAd/24XsNOLWDczj2qrw58cdgccjGU0GJoQ9h3QCveV15CrJ2MhZdDbhIZn8NNCOB5iilGykwFfrMthOEpXrvNAfeJj1MHBOKuuzxnioF1EXkpxlLFTBMLcQ23FVrwVISnDqYh7YcgD2rYeYDHpFSXyCEvLA5xQR+gxaOJMfy0CANM2TKU43HKBUPSvBEd+nmCiqyLEcQ0U5sXBJzMZb4Uyw6JN+xzXSVpcdfC3Z1vQdglBFvTlBgpUzxp2jvdCrWT3Sdo76G/OX67w7zQvtS1gLm74Uj5tg/y5vgt5NngY3fygzsEJXd4dqONKgROYuSCU38Xv9zv51YdY9atYvWpBj1FLsNFl6wClHC9FqLQpuABFJZJeFY6rhK3ANvKwoA3lLtL6dqwXG9B5LEsdpFU12CSkkmBV40MiHGfdAND3qs8GVzY7D5oanD3PtYq1x5PHitQqdZ/SJjQtjklY/SLh5D3BzCvCjAslF2yy5wpDvEna1GgmEXdsFBrT1rbzgsf3v3o0vXUbrN4ueo7BgbIkWpQUqyImOWprx5xmADRt+lIt6qOYlSNO8bkTGkpwFIi1YQK/qslYdRSwdAyYlOa2qpu+wCPHIo5oNcGMH7//e3v/6jBtfGMugqYHYEmCURIXAMhWpMswYMAUiyHXVE2IYL+mPrjsmIQlEIwk0nJSHp3Gn+LVzh0KQJddEEZ3aCLeAomgXIP1mF5190dNTSap8okGTKH+bJLrk0tAYQ/W67Kh3futlYFg92mksTK0nmdwauoC7nUHaaq4M1UMKVqtLpxFEYOFcu42E13qZvwjSwFQWFkRg2Pie9KR80EP9az7Pk6q6KNgBovuFSP1oJneMaO5XO3476gc329ogltUDt0rUhC54gRnwGsUhvZZc7VvLxTiU5rj8lrTlcHKEhgskMpYgb6CrtgaocjSS1sCwAbMTNjTNQx55dQltqCTSqCCkNjxZYu4DVwCBBmTE3YMIZTNfIE22GJOx3oqtMhXQuIk/i6UM7g61J3oWgDKVf1DuC4JDvl/dNKXapnTIvID3IGCAtJDvYRaxu0/QM+CULu8s7UR4ipwMt/YGuGhCw1PQQuM2BkoRvCBgUhKeFsXlnTXmztzdALpJqCccJtc/LSvbxYSyFdlB/dazwwOTDREppK5HYzXZcnB4F6hZmCprg74vqBS8uO49N3oZb029/+R4MW6oIpdQRT2FiKsVeoPeItyHqvntk8OzrjzjK3CWn4eD6UYlhJubUE02y5lYDWxHE1FS3h9ggc3OtbQOlAHYBou8fC/5r2q5X13TwYIOSOBnwtDQPj2oSqJC33NLuMBpPk0Toh2aE2UQMa5zaQHTWGxlOGyYUSlkOaPemOC3YDflAlJIL1BPMVE0P0nuxidnOb9qK2micBOFnQY5IEoXUxBWeLMBjF8U17hP38j+43btQhfho0vq0kpxzFMXk4Sjmgh6qRtMkPHx06VZ0mwIeohi1p7Y1FtchHcdLQv3jt4Fp6ktCXBEi0cYLrDJTbfQl+g7dnA8zkmI3gZgLGPOIpGDVBWbkTmhbPz2Yy3Wb/dPF6rfXzKzIP9nu9/8vWz8e9r8f6ud/7iqyfzwBY51e/XppsOn2ulR0+TmB7g4+SWc9hKtX2mrADgdPbRTWsQ3DFDoOF/a8y2Hohfo0R11p5Kz+/M0D6ySAaBr0e/G9JCDaSEoPpoUxYnM7/KQh3DzLYvgb286u1/v4KWd9NBz/oXGTxNECdX+umJF/T5JoJ1PHGBRoVPVKGg15veBBYfO+vQ857mTGr3c5gt50pCWqRU/ONmhM6AT0dhld3iCum1HVU9WmQbUPCfq837JdIOFhFwiuBV/ExT/WxPGfiy860PryxwwOol1lasXbAbSUsDxqTrX+3k9QsLhQ38+Dw5Cq47NKcd2354cnZ4gyozkwlhN/kUiPE1EyDw2BvJRoHE4WDhnpyFaABLvAiT1ORQKTqitijOd+76EeDYBEut1krJrfUZ0X3U5toQydcTK5rd1bh6D2so12qBqYqvS7nf2Kg2LmFqNcKAw70M2UULDKAeiCPd1UM00u/yD66aF3A0Eq8UBBU67sc1ONjehphOss72JrAm1rczYkPesE4ljKMJajmGJShJkFQCx6BH7VwkCBYCvCoQg9K9fikIvzSee+11z6qfYP9fdSPnvZRkXj8DPfo/SeLM7tMNW8dxvNtcDm50+0654orqrklGl+sfd19atqbcYZ1+27DyLpsY91o79xg7vQgN8167us6a1r/YJMd62Ct+ch1td5U4Arr59D1Z0p3pNz9eFg7la2hA6+INKkAgnGBCh73kAr2e0gFz3oNHcitQdVDpcmgulJqK24ClUYCascZ8CcXY4nM7Ui4TFMMwheFw4rmytJYZmWW4E7HN/nt7/8oW3U65YnV+qnA/PCmUCSXM6bgaQSwHoxTdom5k6EZy7BMo50LL5vSDIwUENcmDJvYdw/gsmjllCQxzemIpxx2F3tlD+2gtQ1KR5AMGi8Az2XxQNnrsBcshU2pNP7WXnggM6nOx/CKBJhDRuANBFMJE1MqYutpsJISLeZwUq6SM2ujAGpuYZPCKBobklFBJ2jyDkkdWQlLOWwnRMkROOK0TAvrajKUp1JZiy9OCONUEYkvL3MoQvUbBJFiU+CuC+dv0qH191mJ5x5WGIG7PQdYONjajCSFAG+yddsX4C6Wxrl75bgBIzQ3igoNqrkzMrs1KBHmXEFMO6vWB81ghX/k4txme+6Sk5KufmIjzQ1rJpNalhCPmm2+5+aHYgRZ/qXmRqp51XrCzbQY4XZW76T8YXv63r+bUdusdr95/d5ax/Te0dtXqA49Ir/97b/Jj4wqQaZyZqk1LhRL59UTHfiiBa68RVupzaCzkRbwLIZBIhUTHxPhMfjTlBo0kb5mM7BFW5aycXLfM1O9ffIvpPETLpFC/JximbwAT54QDJaGqnn9pQoArbJAO/GEMe/2TO2siFULDNE7bW7Lp0Etqbg1anHh31vx23NIijxpfnA1KnZD+2JZnCg6Nk0jo2apTd1HlCyMJWBvuPLQIFJzJY11YebJ2AO9ugPuBDmOvAR8bXzstfJwO18S3BxwniI3YCmpXKA6V9XzMw7AmsqwHrLKW6uJ1arRAdNA1Aper0X0ykrBhPNilPJ4ecIROXLx7z56dG3oaFgLBw0bEZ0Ree/gz3YLLv2W2I702ojRb31QKJTTuetPzCszpo8qWAo74oo5Y3gQLqu3zV0OXROAO914d4fm3DHxiRcGpJkb79OFibUqCENtpJBXnmjO13qK4TkU/Wb8nqkLHjOn62+Qo3tYeS8Ig5THzJk4nNZw9P3bH8nF46gHakt5aNhBpO79+Or5y9fvXwIwsAQWYf2oF/XQEiu1yaiojfTcUtpxpbIvxdCXR8v2Yaf2Yaf2Yaf2Yaf2Yaf2Yaf7/PRQ+7BT+7BT+7BT+7BT+7DT7z7n9mGn9mGn9mGn+4HP9mGn9mGnT85v1z7sVBa0Dzu1Dzudtg87tQ87nbYPO92P7MTtw07tw053osO1Dzu1Dzu1Dzu1Dzu1Dzt9Re/ltA87fQkKbB92ah92unHm4PZhp3VM1T7s1D7s1D7stHOq8/Zhp8/Ave3DTu3DTu3DTtuEUPuwU/uw0/1wC7UPO7UPO7UPO7UPO7UPO7UPO92peaZ92Kl92On/6cNOtfQOe3lKOWapcVmbbYKZk+Xnns7CYAoZaA5PgqsrIM0PKl0s4PMvBaa1ODkLgwuqOETzY/Ka0OdagYQS5wxykjy3V026xzB+aBccr5Mu5eyBZDG2hb3cu7VuPUnO2zfvjyEbhnuSKpMJJr2iM0hAQWc2S0gtSwV+uwpSKiYFZrgIbJ8Lm8J32swtc465ZdwftTQZkHClgrCZdMZOA/6FSa1tcHVl89YsFmV9W7SxhUOsrw3rd7ZYLP4XYBCbMw==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Draft Template","permalink":"/docs/API-docs/v1.2/drafttemplate"},"next":{"title":"Public Template","permalink":"/docs/API-docs/v1.2/publictemplate"}}');var i=t(74848),r=t(28453),o=t(57742),l=t.n(o),a=t(78178),d=t.n(a),c=t(19624),h=t.n(c),p=t(96226),u=t.n(p),m=(t(77675),t(19365),t(51107)),g=t(21312);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:"eJztPV1zGzeSfwU3dXW2ucMRSUu2o9RdrWL7Et9mbZctXyonabngDEjCmgEmAEYUo2LVPuw/uKd73Z+WX3LVDWA++CVakh35bvLgiIOvRqO70ehuNK4CQyc6ODwJjlmWp9QwHZyFQcJ0rHhuuBTBYXA8ZcQXk+eKUfhOjt6+IjRN5UyTQjOliZEkhkJG4kIbmfFf6ShlxPiOQzKb8nhKNFMXjFBNRmnBcsWF0WQsFZkwwRQ1XExIIuMiY1Aw42ZKcsUSNuaCJUQbVcSmUExH5EMuBdFFHDOtx0VajmTB4FKExEwZAqqYKZTQhJJC8F8KRjodX3vIk06HmCk1JKaCjBhMJ4HZOIBYDZwRhTIpsGOds5iPOVR2fUWn4lQc8/yQfMhTSRMyl4Uib1/8e9kF9AvfTjqdF2xUTMiHV53O2cOpMbk+3NujeR7JnAnNJyKlIx3FMttLoGKejB8BBpli0CvCyqjm6ZzQJCEznkyY0ThjQWKZz0kspUq4sKjP6YQRUWQjpnRIqEhIJhUjXBBKFKPJvGtkt9CM/Mf7N69hOTJqIvI2LXRYDpdwxWKTzm33gAE/qwcWM0/2YX24mIQko+ewkNyQXwoen8O0NROIVrcmiKtO532R51IZlpCf7BQOOx0o+Y6lckaoYlg/llkmBcmpohkzSG2wYFCs2C8FVyyxpELT1OPi8FR0SacjaMYOOx3ywS48T5gwsGoKic5MuXYNIlvfzHOs/0okPAbkIQDwlchxsyogFaq+d4Rgq9ZQDZRiiR5wOKN2/fOUxnZaigENGX7Bmh1fhmQOHb9gQnoIplLxX6UwNMXlu2DK8Jim9WUGAJEwDVXIR7nkwvivbgTys1tOWG1cREeHAFoCyM24wBLNyAVNC6YdVLOQTAGqdyxXTCM/uH4B8SIhU8Yn043j0eRjoU2jY1JoALMOhRvLryqilyHaxjTVjPBxA5cZPWe10YhEoUXTiHw3Jwkb0yI1IeFAoUYVLCKvpSE0z1Meo3QCGgBmoyBTurjKjnyiJvm8VfKCJwxESMLHY6aAmaEQu3BtPHRAlzk2gOkhp5kpFUSKpYWOZSrVKgnh5yYeSSyFYcJE5OiC8hSBt5PVhIs4LRJGRimNz0OUqyFRLLGMPmcgpUPLH1gFhK/FOeKHaJYCFUoB8Avphue6knAROQZGKfkPCj2qcRCu61h1XD6WMDKgwLMkYRnlaYiIC8lHOSKGm5SFwOA5FfOQJNSwkBh2aUbyMiTxlMXn+JeiCZdkVBgDgh3GTJTMEzkTDpdjKYzmv67hSF/y6RgdhGQ/JE9C8iwk/V5I+oOQ9PdD0n8Skv6zkAx6IRkMQjLYD8ngiQVr8MzhmpYIrgPQH1gsm68Lu1OesCE0HMLchlQbprg+B3FNfoI9hwkALrF7LlQst0k+gZ273AG5JlOeJEyQsZIZUSzmOUdpYqVB2XUI8BAFkxKajIs0nZMLrnkNB2WnciYAbzgiV+RNzsR7PhGExrEsYI0RwxapiM5qyUU6B1CPGc00zvylMEzlimsGolroEgPCVLRlN0D4VhcAu6ykaEqgzau5aXVqKwM76I9co8yFrU+Xu+mssZv2I9LplHIOvv31r389FVengpDTAMTeaXBIToOyymkQ2jLYzaCs735fwo/Hg6fu5xx+Phk8cz9nWLW/735O4efAN3XMBd9wYKzBhbFDOwFLaiBApcWpWDhoT8UAp2Folm+ZAhR/KfD9NgUfYX8JfQGw4Co8G2Zsa6zM9jHMlgtuOE315gn7GvdozksgrZ92VWll5vswcxRmm6eNxfdoznV4oAQ3UVuEm26tyG8HCMVgC4qW+9wkhKEVqkcrmDyInA6zGZF2CvcGjzVw7gqNS11+OhafABZhPz2G/XQzKsst9x7hcxmmu0Lqun4/HbNPI9SCUT3ZjFdX4R5htQnRXeF0tddPx+gzwCjoeZvRCaX3CJc1cKDAKc22rLff7R90B73BfgOfYJ6wFbKsmyTd+Xx+u7XIuBhaOKBRrX5GL9cXgNUEdMdyJcoS0GC4mJTNmqWrq27rLS0kaJwOE6B0+vOn1XrBKIXK86pxAc/+VS134sG//YH8z3AMH/kTKkuc2lyzZ3n7T/0MbWRC5w+07co3LY9eUH9ZObZgYhHAgbaweCp57ICHOv7ANQJzTwQ46OKi7iXJXm1R4WOSdLOsu/QRfnaRBmofsyxKkmip5gqh2I8ZSZKQrH5e+z1JSJZlGz7b743Pe1m2OosoyxxsDnue9lbWOeOCZwUckcCsZk/oUBFOGQ69mVtLLkin8/PPP//c/fOfuy9edDp+Dd0Qjoprlgw7Ar28oxHqRN/pHJJXY1L/hNYEa8dBKVCeDNHc6ytM5Uz4AxEeGxVJCjAo+qrWmpTROXbGuJky1RxHqopk4fgIp62RNNOIfMDTJfztT2HlaQlPUt9EaBXGo/Fm2ekqfCnxWUnJ5sBbRetm0dSQrStqkRdM+Xq9SbFJkVLFLsH8p7kUKzLxJnvgp+1vS2LR03JlakHDojPtMm/pIA/fuEP4o9K+uDQX6O3IeS6IYhN2SXJqDFMCO7ugKU+s46OLH9glzXKwrez95fQ0+cM/76FlF4ynxpoUEj7hYJDf+8vJUfe/ztbUKPKcqZhqRlIGI+mQMBNH5GTK0rzyCcxms2j2WMdTKVPrEPioFRvbf4dy9HGI4OYR1fmjdTO1xFCzpAKxLBtSkTlrGKOa+JZrbKm4NMg1/R5qcM5UsUWFczXukd6xBBIUWrM0FJ/A1o/KLRAvq/6WIHNOg7Nqu0frKUuuaXu2A3sCN6R0xNLVok9nrZTOZeE42nsLmlN1FF3Dm1OFSoMwTqcX1grp5VKhLVus4VOLkDqb+t3es6dfAZJyXW4kDXTWWzufAXp+BLM+uhEjvgEZlVR6ay4oAduNDbyBFNfumiGgHsGKpb/Gj3bNCI2FWdnJna7gHU/jslePMr+R1/EFLcF7W6kJW0ZwusLmEZz/dMMAp6KPZkhvvtxyPnE17pGsWAJpOxvfRIo0duabbKk3YkA/rToDrtleoardWEvm05u5LyJvrE3dNwJ7exyzHDStW7NmCfLOOxRajesm9M2UV691j6hvDVifmQJdvbvefW5EpPXZf0WE2gB7Z2K1Rv+MTrbYb7D4HpFnHZ71Jg5XY8VY1UdLv91RtliosXz7hPu9xoQPmhN+0rvBiasx7O0PXL0t+FkZCs7WRUpXtoOExTyjKYaQINyDW/DoTQ5fDjDggecyywtTZzo066Bg8VqCD4ywrt0/hKQbkk5I9kLyMCSPIvKOYShFXIZdOKWBKxtcwQVJZAF+0rhQ6ZyMFEw8JCyaROTq6peCCsPNfLEgHXJ1BdFai0UEXHgu5MxGXpyAz9gQiJyqDlWJjPWaSCsZ6z04fe29ZrPuC+dc3nOgPSIP5ZJI2HoUdSj4sicyC1WNSGCU16XKZk+lGOrDdZ7SOaFj8FPbcBBsZqOGIkDxIRmQf/030h9EvV5IevZv8tBPcPAIeRh9TDFLtzkpsfg6Du7VObj6uU5kHfR2YuH6sDfkYOhiiEEEOO61ClvF3PfQdFJNZtlYW9PqAWd2/9RTWaQJ7J42gJKVAXylTg8RCG8VG/M0rUXwEf/JczVERLGUZS5qzMXuwYEGoxW4MBI4x4dzdDojNpYQqQAhhGgapFWMnx3dbt6NKBAM/JSKTKm2lhbENcAMMZJmyrKlmAkPXhU3wYWHHYi5f3c2wcE3TfJ+ctAg74PmDrWRvDfR8BZTITTRuRS69AiyqqhGd9in/756uFimJd8pLDeGzFSRPyjGkHRSfs7q0oYL7fU0B+VyJNzzqZS6quGC0Zzk1YfNIDepIM7tUVQGh9zW8dV/+rihRjz7go6v5ir19vf6B3tbPV9LTpJPPy4SssuSol19pyXFmtWatm6h27iFbs8Rj+/SNNt/OmicKB5v257viWm2zlHXGGXvwvR6o9PtOhtonQ93tH5+MSvk7cly/3PYY5YE99P+72CPuS2Jrphd7owoyV3ZXNZR5g5Gl62WlltTbh3Yz069B3djoFk67XzT0Aa/GdSp9eDgdtS6bJ6pkdxpwP/zuzfvZr0/fT+RR0dHR6/ff5i+/DA5OjrK4HcURWuNduvIAIcB/dldBXJbPKoLG0aJoggd9tTQQ2y+l4vJt7Z9uLlN5CLyPpMn4eBLexJuLzfKql9mz1rnNvh8kuF2PEvcf6ciCAOZ4xVDKV4lwWFgryv6y3tBiMvHtPlOJvPg8CpwF0TgTxewD033Pmq4FnkV6HjKMgp/+WWHi5RjnkJXNnxFB2GAQZJwqxLIMjgM5Ogji00QQphFDpZxpqEPbHd45WvZi3RB6FT+4DCwbBGEgQs9KD8RJmIJcVx5Mg4WIfY0zKnWM6mSrV2WX6ouoQML8Sc21PhHeRUS+oHLazfsBpsulm6i3qineg+Lal2qzqhSdB4sX3r1t9Z8LIwLR/IGwHTu9yVuwDJXXqXCakEYcMOy+igbVl3JT8d0zCTMBIPDb7K8IItu0i6fSnGjhi6s9SZNP8rR8EbkWK31cHccN0mgeYkMeikVDn9nqQyddJFsuZJwGzkiR3CbhyVOaz+sYuTAz1FaUB8d2mDMKYUb0YakjIJdStRuwTTvC15wNoMeDsk7FjN+4WCr3y6GKhhf9K31+GPfQi5da6Q5ELbvCtrYu0/ue7Pbb6H9MkTlxdsIJSsTRQbir2QAC2oQBn4oEIE17rT1FmHgAFvDkTvykC1dXd/majZXhHSrCYX2Bk50nTzx9ZEX6KQ+prWerox5vOk6cO0WorOx0jxnVEV4K/fGF8TxDj5N4wKvwZe7b2NmJajlzPqLMLi8fjKXJJZdf9eYPEzZ2NgQNhJLJZh6VA9JvjeTG+zvL8Jgfv305l/l9J7C4s2un91PeEm7usD+e8D6+NkiDKbXw/pDeY38dwR2/8mi0oSWNMXhSCbzoZdbi+sqepUD6kEShFfijUqYqiFiJGXKqFjBBARR25PwAzhNPAht4CjeF+VKe3WDzMDVouyOUO5HVlg7ldZeJfN37sCD+BI+oDaui5GGWsL3p22HI0aM4pMJA8+Lq4GN3f1mRjGbh3DhrJUjMVfsgstCe/DAHQM6QMrAw2K9u2VAd/24XsNOLWDczj2qrw58cdgccjGU0GJoQ9h3QCveV15CrJ2MhZdDbhIZn8NNCOB5iilGykwFfrMthOEpXrvNAfeJj1MHBOKuuzxnioF1EXkpxlLFTBMLcQ23FVrwVISnDqYh7YcgD2rYeYDHpFSXyCEvLA5xQR+gxaOJMfy0CANM2TKU43HKBUPSvBEd+nmCiqyLEcQ0U5sXBJzMZb4Uyw6JN+xzXSVpcdfC3Z1vQdglBFvTlBgpUzxp2jvdCrWT3Sdo76G/OX67w7zQvtS1gLm74Uj5tg/y5vgt5NngY3fygzsEJXd4dqONKgROYuSCU38Xv9zv51YdY9atYvWpBj1FLsNFl6wClHC9FqLQpuABFJZJeFY6rhK3ANvKwoA3lLtL6dqwXG9B5LEsdpFU12CSkkmBV40MiHGfdAND3qs8GVzY7D5oanD3PtYq1x5PHitQqdZ/SJjQtjklY/SLh5D3BzCvCjAslF2yy5wpDvEna1GgmEXdsFBrT1rbzgsf3v3o0vXUbrN4ueo7BgbIkWpQUqyImOWprx5xmADRt+lIt6qOYlSNO8bkTGkpwFIi1YQK/qslYdRSwdAyYlOa2qpu+wCPHIo5oNcGMH7//e3v/6jBtfGMugqYHYEmCURIXAMhWpMswYMAUiyHXVE2IYL+mPrjsmIQlEIwk0nJSHp3Gn+LVzh0KQJddEEZ3aCLeAomgXIP1mF5190dNTSap8okGTKH+bJLrk0tAYQ/W67Kh3futlYFg92mksTK0nmdwauoC7nUHaaq4M1UMKVqtLpxFEYOFcu42E13qZvwjSwFQWFkRg2Pie9KR80EP9az7Pk6q6KNgBovuFSP1oJneMaO5XO3476gc329ogltUDt0rUhC54gRnwGsUhvZZc7VvLxTiU5rj8lrTlcHKEhgskMpYgb6CrtgaocjSS1sCwAbMTNjTNQx55dQltqCTSqCCkNjxZYu4DVwCBBmTE3YMIZTNfIE22GJOx3oqtMhXQuIk/i6UM7g61J3oWgDKVf1DuC4JDvl/dNKXapnTIvID3IGCAtJDvYRaxu0/QM+CULu8s7UR4ipwMt/YGuGhCw1PQQuM2BkoRvCBgUhKeFsXlnTXmztzdALpJqCccJtc/LSvbxYSyFdlB/dazwwOTDREppK5HYzXZcnB4F6hZmCprg74vqBS8uO49N3oZb029/+R4MW6oIpdQRT2FiKsVeoPeItyHqvntk8OzrjzjK3CWn4eD6UYlhJubUE02y5lYDWxHE1FS3h9ggc3OtbQOlAHYBou8fC/5r2q5X13TwYIOSOBnwtDQPj2oSqJC33NLuMBpPk0Toh2aE2UQMa5zaQHTWGxlOGyYUSlkOaPemOC3YDflAlJIL1BPMVE0P0nuxidnOb9qK2micBOFnQY5IEoXUxBWeLMBjF8U17hP38j+43btQhfho0vq0kpxzFMXk4Sjmgh6qRtMkPHx06VZ0mwIeohi1p7Y1FtchHcdLQv3jt4Fp6ktCXBEi0cYLrDJTbfQl+g7dnA8zkmI3gZgLGPOIpGDVBWbkTmhbPz2Yy3Wb/dPF6rfXzKzIP9nu9/8vWz8e9r8f6ud/7iqyfzwBY51e/XppsOn2ulR0+TmB7g4+SWc9hKtX2mrADgdPbRTWsQ3DFDoOF/a8y2Hohfo0R11p5Kz+/M0D6ySAaBr0e/G9JCDaSEoPpoUxYnM7/KQh3DzLYvgb286u1/v4KWd9NBz/oXGTxNECdX+umJF/T5JoJ1PHGBRoVPVKGg15veBBYfO+vQ857mTGr3c5gt50pCWqRU/ONmhM6AT0dhld3iCum1HVU9WmQbUPCfq837JdIOFhFwiuBV/ExT/WxPGfiy860PryxwwOol1lasXbAbSUsDxqTrX+3k9QsLhQ38+Dw5Cq47NKcd2354cnZ4gyozkwlhN/kUiPE1EyDw2BvJRoHE4WDhnpyFaABLvAiT1ORQKTqitijOd+76EeDYBEut1krJrfUZ0X3U5toQydcTK5rd1bh6D2so12qBqYqvS7nf2Kg2LmFqNcKAw70M2UULDKAeiCPd1UM00u/yD66aF3A0Eq8UBBU67sc1ONjehphOss72JrAm1rczYkPesE4ljKMJajmGJShJkFQCx6BH7VwkCBYCvCoQg9K9fikIvzSee+11z6qfYP9fdSPnvZRkXj8DPfo/SeLM7tMNW8dxvNtcDm50+0654orqrklGl+sfd19atqbcYZ1+27DyLpsY91o79xg7vQgN8167us6a1r/YJMd62Ct+ch1td5U4Arr59D1Z0p3pNz9eFg7la2hA6+INKkAgnGBCh73kAr2e0gFz3oNHcitQdVDpcmgulJqK24ClUYCascZ8CcXY4nM7Ui4TFMMwheFw4rmytJYZmWW4E7HN/nt7/8oW3U65YnV+qnA/PCmUCSXM6bgaQSwHoxTdom5k6EZy7BMo50LL5vSDIwUENcmDJvYdw/gsmjllCQxzemIpxx2F3tlD+2gtQ1KR5AMGi8Az2XxQNnrsBcshU2pNP7WXnggM6nOx/CKBJhDRuANBFMJE1MqYutpsJISLeZwUq6SM2ujAGpuYZPCKBobklFBJ2jyDkkdWQlLOWwnRMkROOK0TAvrajKUp1JZiy9OCONUEYkvL3MoQvUbBJFiU+CuC+dv0qH191mJ5x5WGIG7PQdYONjajCSFAG+yddsX4C6Wxrl75bgBIzQ3igoNqrkzMrs1KBHmXEFMO6vWB81ghX/k4txme+6Sk5KufmIjzQ1rJpNalhCPmm2+5+aHYgRZ/qXmRqp51XrCzbQY4XZW76T8YXv63r+bUdusdr95/d5ax/Te0dtXqA49Ir/97b/Jj4wqQaZyZqk1LhRL59UTHfiiBa68RVupzaCzkRbwLIZBIhUTHxPhMfjTlBo0kb5mM7BFW5aycXLfM1O9ffIvpPETLpFC/JximbwAT54QDJaGqnn9pQoArbJAO/GEMe/2TO2siFULDNE7bW7Lp0Etqbg1anHh31vx23NIijxpfnA1KnZD+2JZnCg6Nk0jo2apTd1HlCyMJWBvuPLQIFJzJY11YebJ2AO9ugPuBDmOvAR8bXzstfJwO18S3BxwniI3YCmpXKA6V9XzMw7AmsqwHrLKW6uJ1arRAdNA1Aper0X0ykrBhPNilPJ4ecIROXLx7z56dG3oaFgLBw0bEZ0Ree/gz3YLLv2W2I702ojRb31QKJTTuetPzCszpo8qWAo74oo5Y3gQLqu3zV0OXROAO914d4fm3DHxiRcGpJkb79OFibUqCENtpJBXnmjO13qK4TkU/Wb8nqkLHjOn62+Qo3tYeS8Ig5THzJk4nNZw9P3bH8nF46gHakt5aNhBpO79+Or5y9fvXwIwsAQWYf2oF/XQEiu1yaiojfTcUtpxpbIvxdCXR8v2Yaf2Yaf2Yaf2Yaf2Yaf2Yaf7/PRQ+7BT+7BT+7BT+7BT+7DT7z7n9mGn9mGn9mGn+4HP9mGn9mGnT85v1z7sVBa0Dzu1Dzudtg87tQ87nbYPO92P7MTtw07tw053osO1Dzu1Dzu1Dzu1Dzu1Dzt9Re/ltA87fQkKbB92ah92unHm4PZhp3VM1T7s1D7s1D7stHOq8/Zhp8/Ave3DTu3DTu3DTtuEUPuwU/uw0/1wC7UPO7UPO7UPO7UPO7UPO7UPO92peaZ92Kl92On/6cNOtfQOe3lKOWapcVmbbYKZk+Xnns7CYAoZaA5PgqsrIM0PKl0s4PMvBaa1ODkLgwuqOETzY/Ka0OdagYQS5wxykjy3V026xzB+aBccr5Mu5eyBZDG2hb3cu7VuPUnO2zfvjyEbhnuSKpMJJr2iM0hAQWc2S0gtSwV+uwpSKiYFZrgIbJ8Lm8J32swtc465ZdwftTQZkHClgrCZdMZOA/6FSa1tcHVl89YsFmV9W7SxhUOsrw3rd7ZYLP4XYBCbMw==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},f=void 0,y={},j=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Create Template"}),"\n",(0,i.jsx)(l(),{method:"post",path:"/createtemplate",context:"endpoint"}),"\n",(0,i.jsxs)(n.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,i.jsx)(n.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Unique identifier for this widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Specify the hint for widgets. This parameter is optional and is not applicable to the following widgets: checkbox, radio button, dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "hint": "Provide signature"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp",\n "hint": "Provide stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials",\n "hint": "Provide initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide email",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide name",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide job title",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide company",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12,\n "min_date": "",\n "max_date": "",\n "readonly": false,\n "signing_date": false,\n "hint": "Provide date"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"min_date:"})," Provide the minimum restriction date. The date must be in ",(0,i.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"max_date:"})," Provide the maximum restriction date. The date must be in ",(0,i.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"signing_date"}),": If signing_date is set to true, the signing date is shown to the signer during signing. You may set either signing_date or default, but not both. Using both is not supported."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,i.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image",\n "hint": "Provide image"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"14",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Provide number",\n "formula": "",\n "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,i.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"decimalplaces:"})," Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"15",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"cells"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "cells",\n "page": 1,\n "x": 100,\n "y": 100,\n "w": 114,\n "h": 50,\n "options": {\n "name": "cells",\n "required": true,\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"cell_count:"})," Specify the number of cells that should be returned to the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,i.jsx)(n.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "required": true,\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "response": "04/15/2024",\n "format": "mm/dd/yyyy",\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "required": true,\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 528,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "values": ["male", "female", "other"],\n "response": "female",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,i.jsx)(g.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,i.jsx)(d(),{parameters:void 0}),"\n",(0,i.jsx)(h(),{...t(96277)}),"\n",(0,i.jsx)(u(),{...t(72315)})]})}function w(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(b,{...e})}):b(e)}},96277(e){e.exports=JSON.parse('{"title":"Body","body":{"content":{"application/json":{"schema":{"required":["file","signers","title"],"type":"object","properties":{"file":{"type":"string","format":"base64","example":"base64 encoded pdf"},"file_password":{"type":"string","format":"string","example":""},"title":{"type":"string","format":"string","example":"sample template"},"note":{"type":"string","format":"string","example":"sample note"},"description":{"type":"string","format":"string","example":"sample description"},"signers":{"type":"array","description":"You can provide signer optionally if you it as default signer","items":{"type":"object","properties":{"role":{"type":"string","format":"string","example":"ceo"},"email":{"type":"string","format":"string","example":""},"name":{"type":"string","format":"string","example":""},"phone":{"type":"string","format":"string","example":""},"company":{"type":"string","format":"string","example":""},"job_title":{"type":"string","format":"string","example":""},"signer_role":{"type":"string","format":"string","description":"Specifies the role of the recipient in the signing process. Allowed values:\\n- **signer** (default): Must have at least one signature widget.\\n- **viewer**: Receives the document to view only; must have no widgets.\\n- **approver**: Reviews and approves the document; no signature widget required.\\n","enum":["signer","viewer","approver"],"example":"signer"},"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Allowed values - signature, stamp.","format":"string","example":"signature"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":244},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":71},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":38},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":46}},"title":"createtemplate_body_widgets"}}},"title":"createtemplate_body_signers"}},"sendInOrder":{"type":"boolean","description":"If set to \'true\', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to \'true\'.","example":true},"send_in_order_strict":{"type":"boolean","description":"When set to \'true\', each signer is blocked from accessing the document until all preceding signers have completed their action. Enforces strict sequential signing. Only applies when \'sendInOrder\' is also \'true\'. Defaults to \'false\'.","example":false},"allow_offline_sign":{"type":"boolean","description":"If set to \'true\', signers can submit a copy of documents created from this template signed using an external tool for owner review. Defaults to \'false\'.","example":false},"enableOTP":{"type":"boolean","description":"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.","example":false},"enableTour":{"type":"boolean","description":"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.","example":false},"redirect_url":{"type":"string","description":"Specifies the URL where the signer will be redirected upon completing the document signing process.","example":""},"sender_name":{"type":"string","description":"The name of the person or organization on whose behalf the email is being sent.","example":"opensign\u2122"},"sender_email":{"type":"string","description":"The email address of the person or organization that users can reply to.","example":"mailer@opensignlabs.com"},"allow_modifications":{"type":"boolean","description":"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.","example":false},"auto_reminder":{"type":"boolean","description":"Set to true to enable automatic reminders. Set to false to disable them (default behavior).","example":false},"timeToCompleteDays":{"type":"number","description":"time to complete days is used to calculate expiry date of your document","format":"number","example":15},"remind_once_in_every":{"type":"number","description":"Number of days between reminders. This is only applicable when auto_reminder is set to true.","example":5},"merge_certificate":{"type":"boolean","description":"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\\n\\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\\n\\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\\n","example":false},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed. \\n"},"prefill":{"type":"object","description":"You can provide widgets which can embed before sending to signer","properties":{"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","format":"string","example":"textbox"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":100},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":30},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":40},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":80},"options":{"type":"object","properties":{"name":{"type":"string","example":"textbox"},"response":{"type":"string","example":"joe"},"color":{"type":"string","example":"red"},"fontsize":{"type":"number","example":12}}}}}}},"title":"prefill"}},"title":"createtemplate_body"}}},"required":true}}')},72315(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Template created successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","example":"Bh2Hspnmch"},"message":{"type":"string","example":"Template created successfully!"}},"title":"inline_response_200_5"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/ffa808c5.913f44ae.js b/assets/js/ffa808c5.913f44ae.js new file mode 100644 index 000000000..d71658ac0 --- /dev/null +++ b/assets/js/ffa808c5.913f44ae.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[8744],{28248(e,n,t){t.r(n),t.d(n,{assets:()=>f,contentTitle:()=>y,default:()=>w,frontMatter:()=>g,metadata:()=>s,toc:()=>j});const s=JSON.parse('{"id":"API-docs/v1.2/createtemplate","title":"Create Template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.","source":"@site/docs/API-docs/v1.2/createtemplate.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/createtemplate","permalink":"/docs/API-docs/v1.2/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":"eJztPe1yHDdyr4KMU5G4N7vcXZGyvE4uR0s6WzlbUonUuRxSIbEz2F2IM8AYwHC5prfqflzlAVL5k7/3EvmfR/GTpLrxMTP7RYr6MJ2sq2xzB1+NRqPR6G50X0WGjnU0OI6OWF5k1DAdvYmjlOlE8cJwKaJBdDRhxBeTx4pR+E4OXj4jNMvkVJNSM6WJkSSBQkaSUhuZ85/oMGPE+I5jMp3wZEI0UxeMUE2GWckKxYXRZCQVGTPBFDVcjEkqkzJnUDDlZkIKxVI24oKlRBtVJqZUTHfI60IKosskYVqPyiyMZMHgUsTETBgCqpgpldCEklLwH0tGWi1f+5SnrRYxE2pIQgUZMphOCrNxALEaOEMKZVJgx7pgCR9xqOz66pyIE3HEiwF5XWSSpmQmS0VePvlj6AL6hW/HrdYTNizH5PWzVuvN/YkxhR7s7tKi6MiCCc3HIqND3UlkvptCxSId7QAGmWLQK8LKqObZjNA0JVOejpnROGNBElnMSCKlSrmwqC/omBFR5kOmdEyoSEkuFSNcEEoUo+msbWS71Iz8y+GL57AcOTUd8jIrdRyGS7liiclmtnvAgJ/VPYuZh3uwPlyMY5LTc1hIbsiPJU/OYdqaCUSrWxPEVat1WBaFVIal5Hs7hUGrBSVfsUxOCVUM6ycyz6UgBVU0ZwapDRYMihX7seSKpZZUaJZ5XAxORJu0WoLmbNBqkdd24XnKhIFVU0h0ZsK1a9Cx9c2swPrPRMoTQB4CAF+JHDWrAlKh6qEjBFu1hmqgFEv0gMMptetfZDSx01IMaMjwC9bs+DImM+j4CRPSQzCRiv8khaEZLt8FU4YnNKsvMwCIhGmown1USC6M/+pGID+45YTVxkV0dAigpYDcnAss0Yxc0Kxk2kE1jckEoHrFCsU07gfXLyBepGTC+Hiydjyavi21aXRMSg1g1qFwY/lVRfQyRNuIZpoRPmrgMqfnrDYakci0aNYhX81Iyka0zExMOFCoUSXrkOfSEFoUGU+QOwENwGajwFPauMqOfDpN8nmp5AVPGbCQlI9GTMFmhkLswrXx0AFdFtgApoc7zUyoIFIsLHQiM6mWSQg/N/FIEikME6ZDDi4ozxB4O1lNuEiyMmVkmNHkPEa+GhPFUrvRZwy4dGz3B1YB5mtxjvghmmVAhVIA/EK64bmuOFyHHMFGCfsPCj2qcRCu61h1u3wkYWRAgd+ShOWUZzEiLiZv5ZAYbjIWwwYvqJjFJKWGxcSwSzOUlzFJJiw5x78UTbkkw9IYYOwwZqpkkcqpcLgcSWE0/2nFjvQl747Rfkz2YvIwJo9i0uvGpNePSW8vJr2HMek9ikm/G5N+Pyb9vZj0H1qw+o8crmlAcB2AXt9i2fy2sDvhKTuFhqcwt1OqDVNcnwO7Jt/DmcMEAJfaMxcqhmOSj+HkDicg12TC05QJMlIyJ4olvODITSw3CF3HAA9RMCmhyajMshm54JrXcBA6lVMBeMMRuSIvCiYO+VgQmiSyhDVGDFukIjqrJRfZDEA9YjTXOPOnwjBVKK4ZsGqhAwaEqWjLHoDwrc4AbrKSosmB1q/mutWprQycoN9yjTwXjj4dTtNp4zTtdUirFfgcfDs7OzsRVyeCkJMI2N5JNCAnUahyEsW2DE4zKOu535fw40H/c/dzBj8f9h+5n1Os2ttzPyfws++bus0F33BgrMGFsUM7BktqIECl+YmYO2hPRB+nYWhebJgCFH8q8P0xBR/hfIl9AWzBZXjWzNjWWJrtA5gtF9xwmun1E/Y17tCcF0BaPe2q0tLM92DmyMzWTxuL79Cc6/BACR6itggP3VqRPw4Qiv4GFC32uY4JQysUj5Ywud9xMsx6RNop3Bk81sD5UGhc6PLdsfgQsAjn6RGcp+tRGY7cO4TPRZg+FFJX9fvumP28g1Iwiifr8eoq3CGsNiH6UDhd7vXdMfoIMApy3np0QukdwmUNHChwQrMt6+61e/vtfre/18AnqCdshTxvp2l7Npu931rkXJxaOKBRrX5OL1cXgNYEZMewEqEEJBguxqFZs3R51W29hYUEidNhAoROf/+0Ui8opVB4XlYu4N2/quVuPPi3v5B/B9fwob+hstSJzTV9ltf/1O/QRqZ0dk/brnzTcPWC+ovCsQUTiwAO1IUlE8kTBzzU8ReuIah7OoCDNi7qbpru1hYVPqZpO8/bCx/hZxtpoPYxzztp2lmouUQo9mNO0jQmy59Xfk9Tkuf5ms/2e+Pzbp4vz6KT5w42hz1Pe0vrnHPB8xKuSKBWszd0qAi3DIfe3K0lF6TV+uGHH35of/dd+8mTVsuvoRvCUXFNk2FHoJcfaIQ60bdaA/JsROqfUJtg9TjIBcLNENW9vsJEToW/EOG1UZG0BIWir2q1STmdYWeMmwlTzXGkqkgWro9w2xpKM+mQ13i7hL/9LSzclvAm9UUHtcJ4NV7PO12FT8U+Ky7ZHHgja13Pmhq8dUks8oypWC03KTYuM6rYJaj/NJdiiSfe5gx8t/NtgS16Wq5ULahYdKpd5jUd5P4LdwnfCfrFhblAbwfOckEUG7NLUlBjmBLY2QXNeGoNH238wC5pXoBuZfffTk7S3/39Lmp2QXlqrEoh5WMOCvndfzs+aP/rmxU1yqJgKqGakYzBSDomzCQdcjxhWVHZBKbTaWf6QCcTKTNrEHirFRvZ/57K4dtTBLfoUF3srJqpJYaaJhWIZVGRipuzhjGqiW+5QpeKS4O7ptdFCc6pKjaIcK7GHZI7FkCCQquWhuJjOPpRuAXiZdXfEnjOSfSmOu5Re8rSa9q+ucH2hN2Q0SHLlovefWtldCZLt6O9taA5VUfRNbw5USgohHE63bhWSC8XCm3ZfMU+tQipb1N/2vvt6VeAZFyHg6SBznprZzNAy49g1kY3ZMQ3IMNApe+9CwJgN9sGXkGKa3fNEFCPYMVgr/GjXTNCY2GWTnInK3jD0yj06lHmD/I6vqAlWG8rMWHDCE5WWD+Cs5+uGeBE9FAN6dWXG+4nrsYd4hULIG3exrfhIo2T+TZH6q02oJ9WfQOuOF6hqj1Yw+bT63dfh7ywOnXfCPTtScIKkLTee2sGkG98QqHWuK5CX0959Vp3iPpWgPWRKdDV+9Cnz62ItD773xChNsC+MbFapX9Oxxv0N1h8h8izDs9qFYersaSs6qGm354oGzTUWL55wr1uY8L7zQk/7N7ixtUY9v0vXN0N+FkaCu7WZUaXjoOUJTynGbqQINz999ijt7l8OcBgDzyWeVGa+qZDtQ4yFi8leMcIa9r9XUzaMWnFZDcm92Oy0yGvGLpSJMHtwgkNXFnnCi5IKkuwkyalymZkqGDiMWGdcYdcXf1YUmG4mc3npEWursBbaz7vwC48F3JqPS+OwWZsCHhOVZeqVCZ6haeVTPQu3L52n7Np+4kzLu860HbIfbnAEjZeRR0KPu2NzEJVIxIY5XkQ2eytFF19uC4yOiN0BHZq6w6CzazXUAdQPCB98k+/J71+p9uNSdf+Te77CfZ3cA+jjSlh2SYjJRZft4O79R1c/VzFsva7N9rC9WFvuYOhi1N0IsBxrxXYqs19B1Un1WQWlbU1qR5wZs9PPZFllsLpaR0oWXDgCzI9eCC8VGzEs6zmwUf8J7+rwSOKZSx3XmPOdw8uNOitwIWRsHO8O0erNWQjCZ4K4EKIqkFa+fjZ0e3h3fACQcdPqciEaqtpQVwDzOAjaSYsX/CZ8OBVfhNceNiBmHsfTifY/6JJ3g/3G+S93zyh1pL3OhreoCqEJrqQQgeLIKuKanSHffrvy5eLRVryncJyo8tM5fmDbAxJJ+PnrM5tuNBeTnNQLnrCPZ5IqasazhnNcV49aDq5SQV+bjud4Bzyvoav3ucPGmLEo09o+GquUndvt7e/u9HytWAkeffrIiE3WVLUq99oSbFmtaZbs9D7mIXef0c8+JCq2d7n/caN4sGm4/mOqGbrO+oapeyHUL3e6na7Sgda34c31H5+Mi3k+5Pl3sfQxyww7s97v4I+5n1JdEnt8sGIknwoncsqyryB0mWjpuW9KbcO7Een3v0Po6BZuO180ZAGv+jXqXV///2odVE9UyO5k4j/+asXr6bdP309lgcHBwfPD19Pnr4eHxwc5PC70+msVNqtIgMcBuRn9xTIHfEoLqwZpdPpoMGeGjrA5ruFGH9p28fr23ScR95HsiTsf2pLwvvzjVD105xZq8wGH48zvN+eJe6fExHFkSzwiaEUz9JoENnniv7xXhTj8jFtvpLpLBpcRe6BCPzpHPah6e5bDc8iryKdTFhO4S+/7PCQcsQz6Mq6r+gojtBJEl5VAllGg0gO37LERDG4WRSgGWca+sB2gytfyz6ki2In8keDyG6LKI6c60H4RJhIJPhxFekomsfY02lBtZ5KlW7sMnypuoQOLMTv2FDjH+EpJPQDj9du2Q02nS+8RL1VT/Ue5tW6VJ1RpegsWnz06l+teV8Y547kFYDZzJ9L3IBmLjylwmpRHHHD8vooa1ZdyXfHdMIkzASdw2+zvMCLbtOumEhxq4bOrfU2Td/K4emtyLFa69Ob47hJAs1HZNBLEDj8m6XgOuk82Qol4TVyhxzAax6WOql9UPnIgZ0jaFB3BtYZc0LhRbQhGaOglxK1VzDN94IXnE2hhwF5xRLGLxxs9dfFUAX9i760Fn/sW8iFZ420AML2XUEb+/bJfW92+yW0X4QoPLztIGdlosyB/YUNYEGN4sgPBSywtjttvXkcOcBW7Mgb7iFbury+zdVsrghpVxOK7QucznX8xNfHvUDH9TGt9nRpzKN1z4FrrxCdjpUWBaOqg69yb/1AHN/g0ywp8Rl8OH0bMwughpn15nF0ef1kLkki2/6tMbmfsZGxLmwkkUowtVN3Sb4zk+vv7c3jaHb99Ga/yel9Dos3vX523+Mj7eoB+68B64NH8ziaXA/rN+EZ+a8I7N7DeSUJLUiKp0OZzk4935pfV9GLHFAPgiA8Ey9UylQNEUMpM0bFEibAidrehO/BbeJebB1H8b0oV9qLG2QKphZlT4RwHllm7URa+5TMv7kDC+JT+IDSuC6HGmoJ35+2HQ4ZMYqPxwwsL64GNnbvmxnFaB7CubNWhsRCsQsuS+3BA3MMyAAZAwuLte4Gh+76db2GnZrDuJ17p7468MVh85SLUwktTq0L+w3Qiu+VFxBrJ2Ph5RCbRCbn8BIC9jzFECMhUoE/bEtheIbPbgvAfer91AGBeOouzpmiY12HPBUjqRKmiYW4htsKLXgrwlsH0xD2Q5B7Nezcw2tSpgNyyBOLQ1zQe6jxaGIMP83jCEO2nMrRKOOCIWneig79PEFE1uUQfJqpjQsCRuYQL8Vuh9Qr9rmugrS4Z+Huzbcg7BKcrWlGjJQZ3jTtm26F0snNJ2jfob84enmDeaF+qW0Bc2/DkfJtH+TF0UuIs8FH7uYHbwjC7vDbjTaqELiJkQtO/Vv8cN7PrDjGrFnFylMNeuq4CBdtsgxQyvVKiGIbggdQGILwLHVcBW6BbStLA9ZQ7h6la8MKvQGRR7K8Cae6BpOUjEt8amSAjfugG+jyXsXJ4MJG90FVg3v3sVK49njyWIFKtf5jwoS2zSkZoV08hrg/gHlVgmIhdMkuC6Y4+J+sRIFiFnWnpVp509p0X3j96lsXrqf2msXzVd8xbIACqQY5xRKLWZz68hWHCWB96650y+IoetW4a0zBlJYCNCVSjangP1kSRikVFC1DNqGZreqOD7DIIZsDem0A48/fX/76txpca++oy4DZEWiagofENRCiNskSPDAgxQo4FWUTIuiPqT8sCgZRYIK5TMNG0jen8Zf4hEMHFui8C4J3gy6TCagEwhms4/DW3V01NKqnQpAMWcB82SXXphYAwt8tl/nDK/daq4LBHlNpannprL7BK68LudAdhqrgzVAwQTRaPjhKI08Vy7m4mexSV+EbGRhBaWRODU+I70p3mgF+rGXZ7+u88jYCarzgUu2sBM/wnB3Jx+7EfUJn+npBE9qgdOhakZTOECM+AlglNrLLgqtZeFOJRmuPyWtuV/vISGCyp1IkDOQVdsHUDa4kNbctAGzIzJQxUcecX0IZpAUbVAQFhsaKLTzAa+AQIMyZGrPTBG7VuCfYDZa41YKuWi3StoA4jq9L5RS+LnQXsjbgclXvAI4LshPen1biUj1iWod8I6eAsJgUoB+xukHbP+CTIOQu7kx9hIQKfPwHumYIyFKTQ+AxA3oWuiGsUxCSEs7mmVXtJVbfDL1AqCkYJ940J8/dw8NaCuGi/Ohe4oHJgYqW0EzibjeTVXFyEKhnGClogqcjrh+YtOw4PnwXSkm//OW/NEihzplSd2AKa0vR9wqlR3wFWe/Vbza/HZ1yZ3G3CWn4aHYqxWnF5VYSTLPlRgJa4cfVFLSEOyNwcC9vAaUDdQCi7RkL/2vqr5bWd/1ggJAPNOBzaRgo18ZUpVk40+wyGgySR+uEZIdaRw2onFtDdtQYmkwYBhdKWQFh9qS7LtgD+F4VkAjWE9RXTJyi9eQmajd3aM9rq3kcgZEFLSZpFFsTU/RmHkfDJLltj3Ce/8H9xoM6xk/9xrel4JTDJCH3hxkH9FA1lDb44c7Aieo0hX2IYtiC1N5YVIt8ZCcN+YvXLq7BkoS2JFBrf+Kpwkw/9hwdeVgPyFWq181WEi+62FsPxqjMh/DmAr058X6PMq6sDCVNXe5HUwZv0uw6T8StXvc3pPjsdbv/l/W6D7q/Hb3uXvc3pNd9BMA6j4Hrucm6e/VK3uE9IDY3eCuZtYlmUm2uCWcrmPOdv8YqBFfboT+3/1SqaM/Er1FPW/115cHgVKt+MoiGfrcL/1tggo1wy6BUCaGYs9nfRfHN3Sc2r4H9/GylJ0OFrK8m/W90IfJkEuFtRusmJ1/R5JoJ1PHGBapLPVJO+93u6X5k8b23CjmHMmdWbp/CGTtVEgQ+d4ExakboGG4gMLz6gLhiSl1HVe8G2SYk7HW7p72AhP1lJDwTGGQAI3AfyXMmPu1M68MbOzyAepln1daOuK2E5VFjsvXvdpKaJaXiZhYNjq+iyzYteNuWD47fzN8A1ZmJBMeiQmqEmJpJNIh2l/yMMAQ6yN7HVxGqFiPP8jQVKfjgLrE9WvDdi16nH83jxTYr2eSG+qxsv2sTbeiYi/F17d5UODqEdbRL1cBUJdcV/E8MBDu3EPVaccSBfiaMgq4JUA/k8aryznrqF9n7Ta1yhVryhIqian0X3ZW8t1LDAWnxBFvhUlTzKDr27jzooRMcdKJqjlFwoomimlsM/Kg5ukTRgutK5VQRxOPjivCDW4KXXnso9vX39lA++ryHgsSDR3hG7z2cv7HLVLNDoqfiGmOau7evMhu5oprBpfHFWg7cp6YmHWdY11w31MeL2uO1mtw1ilwPclNh6b6u0hP29tdp6PZXKsZcV6uVIK6wfsNefVt2l+Wb3wbfrXbtDreCarzY0qQZcEoGmnnQRZrZ6yLNPOo2JCa3YlUPldyDwk2Qbdx0K/kFhJQ3sJu5GElkBY7gQ7hmYNXIShZ33mchpPMvf/1bqAZqlt+TVusInwwx0dayVAkj8HLXhn/O0KiIEfZ/+ct/kmHJMxuwOWUXLIMDBXImqFK7yAAsxH7WHRs6uT7uGD2uMMJ7uDOjBSu1Zqs2plIgrF3Z34G7gDhKzETJcjxBtZEYQ+SoV08PjyBvBSRDIIegtqkMp4249JBOQcB1s5ZLwygI5O7tQ9pQU6LFQDEwoXIIAI7+XFbfzqzGGozMqnb1z/iIJbMks8ixuROshfCCiVQqAlbwNreRptvtNvzvs8/I11aBRQ4h1iBL4etT2C/B2QAtnQlVambHDSewV/We1bj9GbF8HgdBJ+Ra4YD8I/RQffh9iB3Qav3y7/9Bjr+R00ayjuaAN3/xfWgnpXcPXj5DYWXHrv9zDBSnmDfmgffymIt/BuULzqXVcoc2YeKCKykAteDkd3bjQ/0MLzOFkka6FATOTjsaQTAeMSYZUDD4yS8sxWNQqzymBR3yjINsBN9/Jo+pYWOpZuRn8j0oykMKD0l+PhE/t9tt/Beqtlr+nbtutcjPNsELs74YMSkLGzJesQt57mgqZWgsqdIm+GWvyNf1HJLKYM9flTxLiWKlbiaGCUle2vhiPcQu/zKkDAGPSKlgF8yCycsNcciyURv2Jw7xtacCDZ8XdKi6wmvw9BAX3Fj12AjyjbhOX5bDjCekCf7hBNXmpLCFfutlXJzj9hFeqYVe8VVeEo9lRUeGfC/VOYxkewQnkQo6NAl6nIBPMbSwbpkjLmjGtTOJoWzu+30MOUESt3jfWT6Be8ABk9hyMpTyHEhsrGiOFjh0Ynad/FFmYFDCPl6gpVXXIXNPPAObfqKAHEe2ke/jezacSHluO3HuqciO2mhnYxeYMaOmkdTEUiZ6ehAmUpuuxHWHuk3Xl1GcgULTBvO3unCQKMD/1t71YQV/bm4NIHy0fDxnU+A7/sD4DLYNmCeYqtIauTFodiLOvn56RHb9SuwOeHqGIza/wxqfWTefIRjltFGM5hkmKQJqUCwtRQpvlmpJa2y+mlxegG1IpJBCxr2Th61tw1JOq7f23nKUzayOyq1o1WGrFTLthPs6ZgWyLiaJFLrMbWAZmPVLJwm3XypprPcBGKNcCp4TAeXk7KQpNp9EZ55r+30OagNrYpxKdc69EYuJRM0K1yuYdcOjeikGJ+Ls5YvDI7JwGToj//Pf5Ozl6yWM4+daA0+Mu4Na4qZ6NdwtvtZSwcJ4WAA8AlB65vHzwoq35NBtbdhaSmYnAgzUZycrhGD/zof8bM1lZ6AKXjNRpKEVMwXj+CVchDm46Dg7OUgozgruxgsMB6NPgrdaI+sUwH9o6eOVzOAcAKHozHHLM2Kv0Uhf9nkNmCbPTuoXDVjpEWeg+EyU1BoFAp9LiyhZGoYmZ8WsN7yl5xA6YWCPHhgdmL211pdq6cBxMJ2RVnCDR9aFMoO3xG90hrcs4sx6mJ9V3GbBGX4kvfeYtY87Jh1CUjiHcNuZ91KH7h5T4VzyxSxUZ5eANXd0VL6VXKF7hWU+yFqsheYx+MLdf/x4B4BzCU5OxAERbApoT5IK227bVzEo0DAcHtUHv5CzE7gxVO1kZcGOAzHE9thAaguHYFjFXXueh8V8Wne6YRpPLmuQDzBW1iRre2qjl98trGffwkPAMAdwZSUNaMh97zljd0m143l6tlPzEwugwXopTMpkn4Q5Xo5q4BgPHMulALMZd/Z4ALcwM4J2JXL/7PjN2c6XRIIHo/WrBdQaSbiYMMXNiq4XRLAqe9DTSv5zcljtC+wJULGBX9iyDHZoRUQ8795BbgwCS7iCNHvYqK8JrZ++BjP1UuPr9ERniyfun5mCeCuwRv9AvqLJ+ZSqVGOcKGo4SqgzqAqNgThsSp+hr9hOXMXMSsDkomdTnfU6vXBB8WKC9r4c4KFxYQd2jg211D7W4D70eMdehSRDxeypmUyoGMNGABmhdlBzYPxpmdi9gPBC1yGVTymsRR9eZU6580lJFwjjtWZwvfuWi3MkhzY5DhLU92youWHNKL+LmN7BNn8ss4x4GR033DWXGtvsa26+KYeQrE1qbqSaVa3G3EzKIa5lvW344TrwsnRQ377PZQq7PGIqRz+IQ6YueHLN9HchF53e3UEXlAUlYlM7gK4twHd04ypIC+6uncceDtKMrfzu87C2GxSpUQ3tVFS04Cs9DXEKL0Zuvk6junm+URxlPGHOkOS0LQdfv/yWXDzodEHdE1SzN1jL3W+fPX76/PApAOO2STSIep1up4v2bqlNTkVtJHv/C5Lxoiam9ip2mxh0mxh0mxh0mxh0mxh0mxj0Lqeu3CYG3SYG3SYG3SYG3SYG/dXnvE0Muk0Muk0MejfwuU0Muk0M+s7xkbeJQUPBNjHoNjHoyTYx6DYx6Mk2MejdyG6xTQy6TQz6QWS4bWLQbWLQbWLQbWLQbWLQ31C+xW1i0E9BgdvEoNvEoLfOPLFNDLpqU20Tg24Tg24Tg944Vc42MehH2L3bxKDbxKDbxKCbmNA2Meg2MejdMAttE4NuE4NuE4NuE4NuE4NuE4N+UPXMNjHoNjHo/9PEoLWwWLtFRjnGAnRZP2wYv+PFdKFv4mgCcf4Gx9HVFZDma5XN5/D5xxKDhx2/iaMLqjh482OIwNhHtINAXOcMIr89tk9N2kcwfmwXHJ+TLkRGhJB8tsUB4mBj3XooQohFATHHXErTXKYYWpROIXAXndpYbLXoXvjtKsqoGJcYGSyyfc5tCohJM4LfOUbwc3/UwotBWLsKwmZoPzsN+C9MamWDqysbHXA+D/Vt0doWDrG+Nqzfm/l8/r/njD7R","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Draft Template","permalink":"/docs/API-docs/v1.2/drafttemplate"},"next":{"title":"Public Template","permalink":"/docs/API-docs/v1.2/publictemplate"}}');var i=t(74848),r=t(28453),o=t(57742),l=t.n(o),a=t(78178),d=t.n(a),c=t(19624),h=t.n(c),p=t(96226),u=t.n(p),m=(t(77675),t(19365),t(51107)),x=t(21312);const g={id:"createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",sidebar_label:"Create Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztPe1yHDdyr4KMU5G4N7vcXZGyvE4uR0s6WzlbUonUuRxSIbEz2F2IM8AYwHC5prfqflzlAVL5k7/3EvmfR/GTpLrxMTP7RYr6MJ2sq2xzB1+NRqPR6G50X0WGjnU0OI6OWF5k1DAdvYmjlOlE8cJwKaJBdDRhxBeTx4pR+E4OXj4jNMvkVJNSM6WJkSSBQkaSUhuZ85/oMGPE+I5jMp3wZEI0UxeMUE2GWckKxYXRZCQVGTPBFDVcjEkqkzJnUDDlZkIKxVI24oKlRBtVJqZUTHfI60IKosskYVqPyiyMZMHgUsTETBgCqpgpldCEklLwH0tGWi1f+5SnrRYxE2pIQgUZMphOCrNxALEaOEMKZVJgx7pgCR9xqOz66pyIE3HEiwF5XWSSpmQmS0VePvlj6AL6hW/HrdYTNizH5PWzVuvN/YkxhR7s7tKi6MiCCc3HIqND3UlkvptCxSId7QAGmWLQK8LKqObZjNA0JVOejpnROGNBElnMSCKlSrmwqC/omBFR5kOmdEyoSEkuFSNcEEoUo+msbWS71Iz8y+GL57AcOTUd8jIrdRyGS7liiclmtnvAgJ/VPYuZh3uwPlyMY5LTc1hIbsiPJU/OYdqaCUSrWxPEVat1WBaFVIal5Hs7hUGrBSVfsUxOCVUM6ycyz6UgBVU0ZwapDRYMihX7seSKpZZUaJZ5XAxORJu0WoLmbNBqkdd24XnKhIFVU0h0ZsK1a9Cx9c2swPrPRMoTQB4CAF+JHDWrAlKh6qEjBFu1hmqgFEv0gMMptetfZDSx01IMaMjwC9bs+DImM+j4CRPSQzCRiv8khaEZLt8FU4YnNKsvMwCIhGmown1USC6M/+pGID+45YTVxkV0dAigpYDcnAss0Yxc0Kxk2kE1jckEoHrFCsU07gfXLyBepGTC+Hiydjyavi21aXRMSg1g1qFwY/lVRfQyRNuIZpoRPmrgMqfnrDYakci0aNYhX81Iyka0zExMOFCoUSXrkOfSEFoUGU+QOwENwGajwFPauMqOfDpN8nmp5AVPGbCQlI9GTMFmhkLswrXx0AFdFtgApoc7zUyoIFIsLHQiM6mWSQg/N/FIEikME6ZDDi4ozxB4O1lNuEiyMmVkmNHkPEa+GhPFUrvRZwy4dGz3B1YB5mtxjvghmmVAhVIA/EK64bmuOFyHHMFGCfsPCj2qcRCu61h1u3wkYWRAgd+ShOWUZzEiLiZv5ZAYbjIWwwYvqJjFJKWGxcSwSzOUlzFJJiw5x78UTbkkw9IYYOwwZqpkkcqpcLgcSWE0/2nFjvQl747Rfkz2YvIwJo9i0uvGpNePSW8vJr2HMek9ikm/G5N+Pyb9vZj0H1qw+o8crmlAcB2AXt9i2fy2sDvhKTuFhqcwt1OqDVNcnwO7Jt/DmcMEAJfaMxcqhmOSj+HkDicg12TC05QJMlIyJ4olvODITSw3CF3HAA9RMCmhyajMshm54JrXcBA6lVMBeMMRuSIvCiYO+VgQmiSyhDVGDFukIjqrJRfZDEA9YjTXOPOnwjBVKK4ZsGqhAwaEqWjLHoDwrc4AbrKSosmB1q/mutWprQycoN9yjTwXjj4dTtNp4zTtdUirFfgcfDs7OzsRVyeCkJMI2N5JNCAnUahyEsW2DE4zKOu535fw40H/c/dzBj8f9h+5n1Os2ttzPyfws++bus0F33BgrMGFsUM7BktqIECl+YmYO2hPRB+nYWhebJgCFH8q8P0xBR/hfIl9AWzBZXjWzNjWWJrtA5gtF9xwmun1E/Y17tCcF0BaPe2q0tLM92DmyMzWTxuL79Cc6/BACR6itggP3VqRPw4Qiv4GFC32uY4JQysUj5Ywud9xMsx6RNop3Bk81sD5UGhc6PLdsfgQsAjn6RGcp+tRGY7cO4TPRZg+FFJX9fvumP28g1Iwiifr8eoq3CGsNiH6UDhd7vXdMfoIMApy3np0QukdwmUNHChwQrMt6+61e/vtfre/18AnqCdshTxvp2l7Npu931rkXJxaOKBRrX5OL1cXgNYEZMewEqEEJBguxqFZs3R51W29hYUEidNhAoROf/+0Ui8opVB4XlYu4N2/quVuPPi3v5B/B9fwob+hstSJzTV9ltf/1O/QRqZ0dk/brnzTcPWC+ovCsQUTiwAO1IUlE8kTBzzU8ReuIah7OoCDNi7qbpru1hYVPqZpO8/bCx/hZxtpoPYxzztp2lmouUQo9mNO0jQmy59Xfk9Tkuf5ms/2e+Pzbp4vz6KT5w42hz1Pe0vrnHPB8xKuSKBWszd0qAi3DIfe3K0lF6TV+uGHH35of/dd+8mTVsuvoRvCUXFNk2FHoJcfaIQ60bdaA/JsROqfUJtg9TjIBcLNENW9vsJEToW/EOG1UZG0BIWir2q1STmdYWeMmwlTzXGkqkgWro9w2xpKM+mQ13i7hL/9LSzclvAm9UUHtcJ4NV7PO12FT8U+Ky7ZHHgja13Pmhq8dUks8oypWC03KTYuM6rYJaj/NJdiiSfe5gx8t/NtgS16Wq5ULahYdKpd5jUd5P4LdwnfCfrFhblAbwfOckEUG7NLUlBjmBLY2QXNeGoNH238wC5pXoBuZfffTk7S3/39Lmp2QXlqrEoh5WMOCvndfzs+aP/rmxU1yqJgKqGakYzBSDomzCQdcjxhWVHZBKbTaWf6QCcTKTNrEHirFRvZ/57K4dtTBLfoUF3srJqpJYaaJhWIZVGRipuzhjGqiW+5QpeKS4O7ptdFCc6pKjaIcK7GHZI7FkCCQquWhuJjOPpRuAXiZdXfEnjOSfSmOu5Re8rSa9q+ucH2hN2Q0SHLlovefWtldCZLt6O9taA5VUfRNbw5USgohHE63bhWSC8XCm3ZfMU+tQipb1N/2vvt6VeAZFyHg6SBznprZzNAy49g1kY3ZMQ3IMNApe+9CwJgN9sGXkGKa3fNEFCPYMVgr/GjXTNCY2GWTnInK3jD0yj06lHmD/I6vqAlWG8rMWHDCE5WWD+Cs5+uGeBE9FAN6dWXG+4nrsYd4hULIG3exrfhIo2T+TZH6q02oJ9WfQOuOF6hqj1Yw+bT63dfh7ywOnXfCPTtScIKkLTee2sGkG98QqHWuK5CX0959Vp3iPpWgPWRKdDV+9Cnz62ItD773xChNsC+MbFapX9Oxxv0N1h8h8izDs9qFYersaSs6qGm354oGzTUWL55wr1uY8L7zQk/7N7ixtUY9v0vXN0N+FkaCu7WZUaXjoOUJTynGbqQINz999ijt7l8OcBgDzyWeVGa+qZDtQ4yFi8leMcIa9r9XUzaMWnFZDcm92Oy0yGvGLpSJMHtwgkNXFnnCi5IKkuwkyalymZkqGDiMWGdcYdcXf1YUmG4mc3npEWursBbaz7vwC48F3JqPS+OwWZsCHhOVZeqVCZ6haeVTPQu3L52n7Np+4kzLu860HbIfbnAEjZeRR0KPu2NzEJVIxIY5XkQ2eytFF19uC4yOiN0BHZq6w6CzazXUAdQPCB98k+/J71+p9uNSdf+Te77CfZ3cA+jjSlh2SYjJRZft4O79R1c/VzFsva7N9rC9WFvuYOhi1N0IsBxrxXYqs19B1Un1WQWlbU1qR5wZs9PPZFllsLpaR0oWXDgCzI9eCC8VGzEs6zmwUf8J7+rwSOKZSx3XmPOdw8uNOitwIWRsHO8O0erNWQjCZ4K4EKIqkFa+fjZ0e3h3fACQcdPqciEaqtpQVwDzOAjaSYsX/CZ8OBVfhNceNiBmHsfTifY/6JJ3g/3G+S93zyh1pL3OhreoCqEJrqQQgeLIKuKanSHffrvy5eLRVryncJyo8tM5fmDbAxJJ+PnrM5tuNBeTnNQLnrCPZ5IqasazhnNcV49aDq5SQV+bjud4Bzyvoav3ucPGmLEo09o+GquUndvt7e/u9HytWAkeffrIiE3WVLUq99oSbFmtaZbs9D7mIXef0c8+JCq2d7n/caN4sGm4/mOqGbrO+oapeyHUL3e6na7Sgda34c31H5+Mi3k+5Pl3sfQxyww7s97v4I+5n1JdEnt8sGIknwoncsqyryB0mWjpuW9KbcO7Een3v0Po6BZuO180ZAGv+jXqXV///2odVE9UyO5k4j/+asXr6bdP309lgcHBwfPD19Pnr4eHxwc5PC70+msVNqtIgMcBuRn9xTIHfEoLqwZpdPpoMGeGjrA5ruFGH9p28fr23ScR95HsiTsf2pLwvvzjVD105xZq8wGH48zvN+eJe6fExHFkSzwiaEUz9JoENnniv7xXhTj8jFtvpLpLBpcRe6BCPzpHPah6e5bDc8iryKdTFhO4S+/7PCQcsQz6Mq6r+gojtBJEl5VAllGg0gO37LERDG4WRSgGWca+sB2gytfyz6ki2In8keDyG6LKI6c60H4RJhIJPhxFekomsfY02lBtZ5KlW7sMnypuoQOLMTv2FDjH+EpJPQDj9du2Q02nS+8RL1VT/Ue5tW6VJ1RpegsWnz06l+teV8Y547kFYDZzJ9L3IBmLjylwmpRHHHD8vooa1ZdyXfHdMIkzASdw2+zvMCLbtOumEhxq4bOrfU2Td/K4emtyLFa69Ob47hJAs1HZNBLEDj8m6XgOuk82Qol4TVyhxzAax6WOql9UPnIgZ0jaFB3BtYZc0LhRbQhGaOglxK1VzDN94IXnE2hhwF5xRLGLxxs9dfFUAX9i760Fn/sW8iFZ420AML2XUEb+/bJfW92+yW0X4QoPLztIGdlosyB/YUNYEGN4sgPBSywtjttvXkcOcBW7Mgb7iFbury+zdVsrghpVxOK7QucznX8xNfHvUDH9TGt9nRpzKN1z4FrrxCdjpUWBaOqg69yb/1AHN/g0ywp8Rl8OH0bMwughpn15nF0ef1kLkki2/6tMbmfsZGxLmwkkUowtVN3Sb4zk+vv7c3jaHb99Ga/yel9Dos3vX523+Mj7eoB+68B64NH8ziaXA/rN+EZ+a8I7N7DeSUJLUiKp0OZzk4935pfV9GLHFAPgiA8Ey9UylQNEUMpM0bFEibAidrehO/BbeJebB1H8b0oV9qLG2QKphZlT4RwHllm7URa+5TMv7kDC+JT+IDSuC6HGmoJ35+2HQ4ZMYqPxwwsL64GNnbvmxnFaB7CubNWhsRCsQsuS+3BA3MMyAAZAwuLte4Gh+76db2GnZrDuJ17p7468MVh85SLUwktTq0L+w3Qiu+VFxBrJ2Ph5RCbRCbn8BIC9jzFECMhUoE/bEtheIbPbgvAfer91AGBeOouzpmiY12HPBUjqRKmiYW4htsKLXgrwlsH0xD2Q5B7Nezcw2tSpgNyyBOLQ1zQe6jxaGIMP83jCEO2nMrRKOOCIWneig79PEFE1uUQfJqpjQsCRuYQL8Vuh9Qr9rmugrS4Z+Huzbcg7BKcrWlGjJQZ3jTtm26F0snNJ2jfob84enmDeaF+qW0Bc2/DkfJtH+TF0UuIs8FH7uYHbwjC7vDbjTaqELiJkQtO/Vv8cN7PrDjGrFnFylMNeuq4CBdtsgxQyvVKiGIbggdQGILwLHVcBW6BbStLA9ZQ7h6la8MKvQGRR7K8Cae6BpOUjEt8amSAjfugG+jyXsXJ4MJG90FVg3v3sVK49njyWIFKtf5jwoS2zSkZoV08hrg/gHlVgmIhdMkuC6Y4+J+sRIFiFnWnpVp509p0X3j96lsXrqf2msXzVd8xbIACqQY5xRKLWZz68hWHCWB96650y+IoetW4a0zBlJYCNCVSjangP1kSRikVFC1DNqGZreqOD7DIIZsDem0A48/fX/76txpca++oy4DZEWiagofENRCiNskSPDAgxQo4FWUTIuiPqT8sCgZRYIK5TMNG0jen8Zf4hEMHFui8C4J3gy6TCagEwhms4/DW3V01NKqnQpAMWcB82SXXphYAwt8tl/nDK/daq4LBHlNpannprL7BK68LudAdhqrgzVAwQTRaPjhKI08Vy7m4mexSV+EbGRhBaWRODU+I70p3mgF+rGXZ7+u88jYCarzgUu2sBM/wnB3Jx+7EfUJn+npBE9qgdOhakZTOECM+AlglNrLLgqtZeFOJRmuPyWtuV/vISGCyp1IkDOQVdsHUDa4kNbctAGzIzJQxUcecX0IZpAUbVAQFhsaKLTzAa+AQIMyZGrPTBG7VuCfYDZa41YKuWi3StoA4jq9L5RS+LnQXsjbgclXvAI4LshPen1biUj1iWod8I6eAsJgUoB+xukHbP+CTIOQu7kx9hIQKfPwHumYIyFKTQ+AxA3oWuiGsUxCSEs7mmVXtJVbfDL1AqCkYJ940J8/dw8NaCuGi/Ohe4oHJgYqW0EzibjeTVXFyEKhnGClogqcjrh+YtOw4PnwXSkm//OW/NEihzplSd2AKa0vR9wqlR3wFWe/Vbza/HZ1yZ3G3CWn4aHYqxWnF5VYSTLPlRgJa4cfVFLSEOyNwcC9vAaUDdQCi7RkL/2vqr5bWd/1ggJAPNOBzaRgo18ZUpVk40+wyGgySR+uEZIdaRw2onFtDdtQYmkwYBhdKWQFh9qS7LtgD+F4VkAjWE9RXTJyi9eQmajd3aM9rq3kcgZEFLSZpFFsTU/RmHkfDJLltj3Ce/8H9xoM6xk/9xrel4JTDJCH3hxkH9FA1lDb44c7Aieo0hX2IYtiC1N5YVIt8ZCcN+YvXLq7BkoS2JFBrf+Kpwkw/9hwdeVgPyFWq181WEi+62FsPxqjMh/DmAr058X6PMq6sDCVNXe5HUwZv0uw6T8StXvc3pPjsdbv/l/W6D7q/Hb3uXvc3pNd9BMA6j4Hrucm6e/VK3uE9IDY3eCuZtYlmUm2uCWcrmPOdv8YqBFfboT+3/1SqaM/Er1FPW/115cHgVKt+MoiGfrcL/1tggo1wy6BUCaGYs9nfRfHN3Sc2r4H9/GylJ0OFrK8m/W90IfJkEuFtRusmJ1/R5JoJ1PHGBapLPVJO+93u6X5k8b23CjmHMmdWbp/CGTtVEgQ+d4ExakboGG4gMLz6gLhiSl1HVe8G2SYk7HW7p72AhP1lJDwTGGQAI3AfyXMmPu1M68MbOzyAepln1daOuK2E5VFjsvXvdpKaJaXiZhYNjq+iyzYteNuWD47fzN8A1ZmJBMeiQmqEmJpJNIh2l/yMMAQ6yN7HVxGqFiPP8jQVKfjgLrE9WvDdi16nH83jxTYr2eSG+qxsv2sTbeiYi/F17d5UODqEdbRL1cBUJdcV/E8MBDu3EPVaccSBfiaMgq4JUA/k8aryznrqF9n7Ta1yhVryhIqian0X3ZW8t1LDAWnxBFvhUlTzKDr27jzooRMcdKJqjlFwoomimlsM/Kg5ukTRgutK5VQRxOPjivCDW4KXXnso9vX39lA++ryHgsSDR3hG7z2cv7HLVLNDoqfiGmOau7evMhu5oprBpfHFWg7cp6YmHWdY11w31MeL2uO1mtw1ilwPclNh6b6u0hP29tdp6PZXKsZcV6uVIK6wfsNefVt2l+Wb3wbfrXbtDreCarzY0qQZcEoGmnnQRZrZ6yLNPOo2JCa3YlUPldyDwk2Qbdx0K/kFhJQ3sJu5GElkBY7gQ7hmYNXIShZ33mchpPMvf/1bqAZqlt+TVusInwwx0dayVAkj8HLXhn/O0KiIEfZ/+ct/kmHJMxuwOWUXLIMDBXImqFK7yAAsxH7WHRs6uT7uGD2uMMJ7uDOjBSu1Zqs2plIgrF3Z34G7gDhKzETJcjxBtZEYQ+SoV08PjyBvBSRDIIegtqkMp4249JBOQcB1s5ZLwygI5O7tQ9pQU6LFQDEwoXIIAI7+XFbfzqzGGozMqnb1z/iIJbMks8ixuROshfCCiVQqAlbwNreRptvtNvzvs8/I11aBRQ4h1iBL4etT2C/B2QAtnQlVambHDSewV/We1bj9GbF8HgdBJ+Ra4YD8I/RQffh9iB3Qav3y7/9Bjr+R00ayjuaAN3/xfWgnpXcPXj5DYWXHrv9zDBSnmDfmgffymIt/BuULzqXVcoc2YeKCKykAteDkd3bjQ/0MLzOFkka6FATOTjsaQTAeMSYZUDD4yS8sxWNQqzymBR3yjINsBN9/Jo+pYWOpZuRn8j0oykMKD0l+PhE/t9tt/Beqtlr+nbtutcjPNsELs74YMSkLGzJesQt57mgqZWgsqdIm+GWvyNf1HJLKYM9flTxLiWKlbiaGCUle2vhiPcQu/zKkDAGPSKlgF8yCycsNcciyURv2Jw7xtacCDZ8XdKi6wmvw9BAX3Fj12AjyjbhOX5bDjCekCf7hBNXmpLCFfutlXJzj9hFeqYVe8VVeEo9lRUeGfC/VOYxkewQnkQo6NAl6nIBPMbSwbpkjLmjGtTOJoWzu+30MOUESt3jfWT6Be8ABk9hyMpTyHEhsrGiOFjh0Ynad/FFmYFDCPl6gpVXXIXNPPAObfqKAHEe2ke/jezacSHluO3HuqciO2mhnYxeYMaOmkdTEUiZ6ehAmUpuuxHWHuk3Xl1GcgULTBvO3unCQKMD/1t71YQV/bm4NIHy0fDxnU+A7/sD4DLYNmCeYqtIauTFodiLOvn56RHb9SuwOeHqGIza/wxqfWTefIRjltFGM5hkmKQJqUCwtRQpvlmpJa2y+mlxegG1IpJBCxr2Th61tw1JOq7f23nKUzayOyq1o1WGrFTLthPs6ZgWyLiaJFLrMbWAZmPVLJwm3XypprPcBGKNcCp4TAeXk7KQpNp9EZ55r+30OagNrYpxKdc69EYuJRM0K1yuYdcOjeikGJ+Ls5YvDI7JwGToj//Pf5Ozl6yWM4+daA0+Mu4Na4qZ6NdwtvtZSwcJ4WAA8AlB65vHzwoq35NBtbdhaSmYnAgzUZycrhGD/zof8bM1lZ6AKXjNRpKEVMwXj+CVchDm46Dg7OUgozgruxgsMB6NPgrdaI+sUwH9o6eOVzOAcAKHozHHLM2Kv0Uhf9nkNmCbPTuoXDVjpEWeg+EyU1BoFAp9LiyhZGoYmZ8WsN7yl5xA6YWCPHhgdmL211pdq6cBxMJ2RVnCDR9aFMoO3xG90hrcs4sx6mJ9V3GbBGX4kvfeYtY87Jh1CUjiHcNuZ91KH7h5T4VzyxSxUZ5eANXd0VL6VXKF7hWU+yFqsheYx+MLdf/x4B4BzCU5OxAERbApoT5IK227bVzEo0DAcHtUHv5CzE7gxVO1kZcGOAzHE9thAaguHYFjFXXueh8V8Wne6YRpPLmuQDzBW1iRre2qjl98trGffwkPAMAdwZSUNaMh97zljd0m143l6tlPzEwugwXopTMpkn4Q5Xo5q4BgPHMulALMZd/Z4ALcwM4J2JXL/7PjN2c6XRIIHo/WrBdQaSbiYMMXNiq4XRLAqe9DTSv5zcljtC+wJULGBX9iyDHZoRUQ8795BbgwCS7iCNHvYqK8JrZ++BjP1UuPr9ERniyfun5mCeCuwRv9AvqLJ+ZSqVGOcKGo4SqgzqAqNgThsSp+hr9hOXMXMSsDkomdTnfU6vXBB8WKC9r4c4KFxYQd2jg211D7W4D70eMdehSRDxeypmUyoGMNGABmhdlBzYPxpmdi9gPBC1yGVTymsRR9eZU6580lJFwjjtWZwvfuWi3MkhzY5DhLU92youWHNKL+LmN7BNn8ss4x4GR033DWXGtvsa26+KYeQrE1qbqSaVa3G3EzKIa5lvW344TrwsnRQ377PZQq7PGIqRz+IQ6YueHLN9HchF53e3UEXlAUlYlM7gK4twHd04ypIC+6uncceDtKMrfzu87C2GxSpUQ3tVFS04Cs9DXEKL0Zuvk6junm+URxlPGHOkOS0LQdfv/yWXDzodEHdE1SzN1jL3W+fPX76/PApAOO2STSIep1up4v2bqlNTkVtJHv/C5Lxoiam9ip2mxh0mxh0mxh0mxh0mxh0mxj0Lqeu3CYG3SYG3SYG3SYG3SYG/dXnvE0Muk0Muk0MejfwuU0Muk0M+s7xkbeJQUPBNjHoNjHoyTYx6DYx6Mk2MejdyG6xTQy6TQz6QWS4bWLQbWLQbWLQbWLQbWLQ31C+xW1i0E9BgdvEoNvEoLfOPLFNDLpqU20Tg24Tg24Tg944Vc42MehH2L3bxKDbxKDbxKCbmNA2Meg2MejdMAttE4NuE4NuE4NuE4NuE4NuE4N+UPXMNjHoNjHo/9PEoLWwWLtFRjnGAnRZP2wYv+PFdKFv4mgCcf4Gx9HVFZDma5XN5/D5xxKDhx2/iaMLqjh482OIwNhHtINAXOcMIr89tk9N2kcwfmwXHJ+TLkRGhJB8tsUB4mBj3XooQohFATHHXErTXKYYWpROIXAXndpYbLXoXvjtKsqoGJcYGSyyfc5tCohJM4LfOUbwc3/UwotBWLsKwmZoPzsN+C9MamWDqysbHXA+D/Vt0doWDrG+Nqzfm/l8/r/njD7R",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},y=void 0,f={},j=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Create Template"}),"\n",(0,i.jsx)(l(),{method:"post",path:"/createtemplate",context:"endpoint"}),"\n",(0,i.jsxs)(n.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,i.jsx)(n.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Unique identifier for this widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hide_text_with_asterisks:"})," When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Specify the hint for widgets. This parameter is optional and is not applicable to the following widgets: checkbox, radio button, dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "hint": "Provide signature"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp",\n "hint": "Provide stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials",\n "hint": "Provide initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide email",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide name",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide job title",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12,\n "hint": "Provide company",\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12,\n "min_date": "",\n "max_date": "",\n "readonly": false,\n "signing_date": false,\n "hint": "Provide date"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"min_date:"})," Provide the minimum restriction date. The date must be in ",(0,i.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"max_date:"})," Provide the maximum restriction date. The date must be in ",(0,i.jsx)(n.strong,{children:"YYYY-MM-DD"})," format."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"signing_date"}),": If signing_date is set to true, the signing date is shown to the signer during signing. You may set either signing_date or default, but not both. Using both is not supported."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,i.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image",\n "hint": "Provide image"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"14",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"number"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "number",\n "page": 1,\n "x": 107,\n "y": 528,\n "w": 60,\n "h": 21,\n "options": {\n "name": "number",\n "required": true,\n "readonly": false,\n "default": 0,\n "hint": "Provide number",\n "formula": "",\n "decimalplaces": 2,\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"formula:"})," Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more ",(0,i.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/New-Document/widgets",children:"visit here"})," (optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default number (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"decimalplaces:"})," Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"15",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"cells"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "cells",\n "page": 1,\n "x": 100,\n "y": 100,\n "w": 114,\n "h": 50,\n "options": {\n "name": "cells",\n "required": true,\n "readonly": false,\n "cell_count": 5,\n "default": "",\n "hint": "",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12,\n "hide_text_with_asterisks": false\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"cell_count:"})," Specify the number of cells that should be returned to the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document ",(0,i.jsx)(n.strong,{children:"before"})," it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of widgets supported in Prefill"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 290,\n "y": 165,\n "w": 150,\n "h": 20,\n "options": {\n "required": true,\n "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 173,\n "y": 588,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "response": "04/15/2024",\n "format": "mm/dd/yyyy",\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "required": true,\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 528,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "values": ["male", "female", "other"],\n "response": "female",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,i.jsx)(x.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,i.jsx)(d(),{parameters:void 0}),"\n",(0,i.jsx)(h(),{...t(96277)}),"\n",(0,i.jsx)(u(),{...t(72315)})]})}function w(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(b,{...e})}):b(e)}},96277(e){e.exports=JSON.parse('{"title":"Body","body":{"content":{"application/json":{"schema":{"required":["file","signers","title"],"type":"object","properties":{"file":{"type":"string","format":"base64","example":"base64 encoded pdf"},"file_password":{"type":"string","format":"string","example":""},"title":{"type":"string","format":"string","example":"sample template"},"note":{"type":"string","format":"string","example":"sample note"},"description":{"type":"string","format":"string","example":"sample description"},"signers":{"type":"array","description":"You can provide signer optionally if you it as default signer","items":{"type":"object","properties":{"role":{"type":"string","format":"string","example":"ceo"},"email":{"type":"string","format":"string","example":""},"name":{"type":"string","format":"string","example":""},"phone":{"type":"string","format":"string","example":""},"company":{"type":"string","format":"string","example":""},"job_title":{"type":"string","format":"string","example":""},"signer_role":{"type":"string","format":"string","description":"Specifies the role of the recipient in the signing process. Allowed values:\\n- **signer** (default): Must have at least one signature widget.\\n- **viewer**: Receives the document to view only; must have no widgets.\\n- **approver**: Reviews and approves the document; no signature widget required.\\n","enum":["signer","viewer","approver"],"example":"signer"},"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Allowed values - signature, stamp.","format":"string","example":"signature"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":244},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":71},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":38},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":46}},"title":"createtemplate_body_widgets"}}},"title":"createtemplate_body_signers"}},"sendInOrder":{"type":"boolean","description":"If set to \'true\', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to \'true\'.","example":true},"send_in_order_strict":{"type":"boolean","description":"When set to \'true\', each signer is blocked from accessing the document until all preceding signers have completed their action. Enforces strict sequential signing. Only applies when \'sendInOrder\' is also \'true\'. Defaults to \'false\'.","example":false},"allow_offline_sign":{"type":"boolean","description":"If set to \'true\', signers can submit a copy of documents created from this template signed using an external tool for owner review. Defaults to \'false\'.","example":false},"enableOTP":{"type":"boolean","description":"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.","example":false},"enableTour":{"type":"boolean","description":"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.","example":false},"redirect_url":{"type":"string","description":"Specifies the URL where the signer will be redirected upon completing the document signing process.","example":""},"sender_name":{"type":"string","description":"The name of the person or organization on whose behalf the email is being sent.","example":"opensign\u2122"},"sender_email":{"type":"string","description":"The email address of the person or organization that users can reply to.","example":"mailer@opensignlabs.com"},"allow_modifications":{"type":"boolean","description":"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.","example":false},"auto_reminder":{"type":"boolean","description":"Set to true to enable automatic reminders. Set to false to disable them (default behavior).","example":false},"timeToCompleteDays":{"type":"number","description":"time to complete days is used to calculate expiry date of your document","format":"number","example":15},"remind_once_in_every":{"type":"number","description":"Number of days between reminders. This is only applicable when auto_reminder is set to true.","example":5},"merge_certificate":{"type":"boolean","description":"**true** - This will ensure that the completion certificate is included in the completed PDF document. However, please note that once merged, the certificate cannot be separated from the main document.\\n\\n**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.\\n\\nIf nothing is set, it will use the owner\u2019s preferences. If the owner\u2019s preferences are also not set, it will default to false.\\n","example":false},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed. \\n"},"cc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"cc (carbon copy): Users added here will receive a notification email once the document is completed.\\n"},"prefill":{"type":"object","description":"You can provide widgets which can embed before sending to signer","properties":{"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","format":"string","example":"textbox"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":100},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":30},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":40},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":80},"options":{"type":"object","properties":{"name":{"type":"string","example":"textbox"},"response":{"type":"string","example":"joe"},"color":{"type":"string","example":"red"},"fontsize":{"type":"number","example":12}}}}}}},"title":"prefill"}},"title":"createtemplate_body"}}},"required":true}}')},72315(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Template created successfully!","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string","example":"Bh2Hspnmch"},"message":{"type":"string","example":"Template created successfully!"}},"title":"inline_response_200_5"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.f7a4f38a.js b/assets/js/runtime~main.7d735a75.js similarity index 86% rename from assets/js/runtime~main.f7a4f38a.js rename to assets/js/runtime~main.7d735a75.js index 41bb5f595..5e8b22f00 100644 --- a/assets/js/runtime~main.f7a4f38a.js +++ b/assets/js/runtime~main.7d735a75.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,c,f,b,d={},r={};function t(e){var a=r[e];if(void 0!==a)return a.exports;var c=r[e]={id:e,loaded:!1,exports:{}};return d[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=d,t.c=r,e=[],t.O=(a,c,f,b)=>{if(!c){var d=1/0;for(n=0;n=b)&&Object.keys(t.O).every(e=>t.O[e](c[o]))?c.splice(o--,1):(r=!1,b0&&e[n-1][2]>b;n--)e[n]=e[n-1];e[n]=[c,f,b]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,f){if(1&f&&(e=this(e)),8&f)return e;if("object"==typeof e&&e){if(4&f&&e.__esModule)return e;if(16&f&&"function"==typeof e.then)return e}var b=Object.create(null);t.r(b);var d={};a=a||[null,c({}),c([]),c(c)];for(var r=2&f&&e;("object"==typeof r||"function"==typeof r)&&!~a.indexOf(r);r=c(r))Object.getOwnPropertyNames(r).forEach(a=>d[a]=()=>e[a]);return d.default=()=>e,t.d(b,d),b},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce((a,c)=>(t.f[c](e,a),a),[])),t.u=e=>"assets/js/"+({33:"7ad5624c",89:"3009d411",108:"1b14d97a",157:"8001f939",206:"d387ddbc",225:"0a7196e9",284:"107ddcf4",285:"23f866da",291:"4f7a2d40",300:"833eda7d",419:"e5d81aec",448:"d77fb6a8",490:"ce589067",539:"cfb1e6eb",560:"500027af",603:"d5380080",636:"eaa24e23",746:"cf03142d",791:"4acb0154",841:"d1393a72",849:"0058b4c6",850:"c6b74119",862:"be3c2a14",930:"05729a5b",956:"19e4dfff",962:"046910c8",1065:"98732f61",1170:"c1e4445e",1179:"489b8a4d",1210:"b3eb04bc",1235:"a7456010",1265:"0c03cd54",1332:"d48fee54",1335:"74c638d3",1440:"277a78f5",1477:"2f6ff211",1543:"3b95ab04",1640:"c9fa5aa5",1651:"19e5ad2a",1665:"7357a3c5",1679:"138cee78",1688:"9640838e",1706:"18b84479",1903:"acecf23e",1915:"61361021",1924:"d8b805fb",1972:"73664a40",2042:"reactPlayerTwitch",2043:"ac7da374",2075:"5c485335",2076:"common",2089:"c7b98810",2131:"299c7a47",2264:"17e5210b",2403:"bd0e2f4c",2634:"c4f5d8e4",2661:"8bd80e56",2703:"da66eb9c",2711:"9e4087bc",2723:"reactPlayerMux",2815:"0ba00a8d",2823:"9b0b43bf",2908:"2c416566",2923:"ec5e470a",3021:"4cff09f6",3073:"e9e778b7",3128:"c674cfb4",3148:"1e1b513c",3230:"d480dde9",3249:"ccc49370",3276:"e5aefb32",3333:"e48228d1",3381:"42f80fc5",3392:"reactPlayerVidyard",3404:"03e06346",3460:"5ce6d213",3522:"e785206d",3588:"293ced56",3633:"b97a0b7b",3637:"f4f34a3a",3694:"8717b14a",3724:"2ffc1e57",3795:"c4fbe420",3841:"56b5f4f8",3891:"8e4d0438",3976:"0e384e19",3979:"64218a31",4001:"d281bdbe",4106:"882238ec",4134:"393be207",4212:"621db11d",4232:"5a144266",4240:"9c9cb35e",4360:"fdd9b680",4372:"9cd612ce",4380:"656c0f50",4466:"56b0ffe9",4504:"5a9dd378",4584:"f82cd581",4813:"6875c492",4833:"c7e3ab5f",4865:"7ef59f7a",4952:"6bef026b",5174:"51e6fce0",5277:"8320e026",5305:"87a6df42",5314:"88a819d0",5342:"4227e71a",5372:"503125be",5373:"02e5f5c4",5506:"01274ace",5510:"02d4f5c5",5524:"21f05a2f",5550:"14716de7",5557:"d9f32620",5597:"b18842e4",5678:"fdae908b",5740:"fdf3f392",5741:"c081699b",5742:"aba21aa0",5752:"6d2e526e",5794:"3b49dc44",5824:"257dcba5",5855:"444a2573",5864:"3a2a59a1",5881:"63d7f7ab",5919:"980c6622",5939:"837d4f04",5946:"3c9ed71a",5970:"0f8cf55d",6007:"611db08b",6011:"56f1c106",6061:"1f391b9e",6157:"3973fcf3",6173:"reactPlayerVimeo",6192:"c195e1f1",6235:"d0524430",6288:"eedafdee",6289:"951b8254",6295:"d91ad230",6302:"873e7b96",6318:"bb4fa758",6328:"reactPlayerDailyMotion",6353:"5e1bb91e",6463:"reactPlayerKaltura",6473:"4c5e977b",6505:"cd2b86eb",6582:"94e1fa32",6648:"0c0943c7",6653:"f214d5ff",6742:"8871da57",6743:"e226bb09",6800:"044432a7",6827:"0edab2fb",6841:"f22c5875",6854:"7c0adceb",6887:"reactPlayerFacebook",6940:"a000203c",6969:"14eb3368",7024:"98334e25",7068:"e92d0461",7075:"4d139b56",7098:"a7bd4aaa",7318:"e76c28ee",7377:"ff9450a5",7381:"20f41f87",7458:"reactPlayerFilePlayer",7472:"814f3328",7477:"36994c47",7533:"a3b21423",7570:"reactPlayerMixcloud",7574:"70276854",7627:"reactPlayerStreamable",7643:"a6aa9e1f",7696:"1ee58ee1",7757:"eb56c656",7797:"767ebc75",7904:"5144c8d4",7910:"e4f5c862",7960:"b2e6bd40",7968:"489197af",8e3:"54a7b8f4",8025:"5e90a9b3",8045:"fff7b69d",8046:"6621d3c0",8089:"b9fdab4b",8097:"ab2a161b",8110:"825a5e83",8121:"3a2db09e",8130:"f81c1134",8146:"c15d9823",8168:"6c0cc40d",8209:"01a85c17",8413:"ed918ad6",8446:"reactPlayerYouTube",8462:"3217192f",8474:"652d83be",8503:"012b45bf",8564:"58abd73c",8609:"925b3f96",8734:"reactPlayerPreview",8737:"7661071f",8744:"ffa808c5",8749:"b93339ed",8901:"1c57a399",8927:"b0378e01",8947:"ef8b811a",9024:"e5a49157",9038:"44f24773",9048:"a94703ab",9070:"851f8f65",9099:"34593b53",9144:"dc8c216b",9190:"6cb65baf",9239:"0c806540",9241:"11b7b3d8",9260:"96f83544",9316:"2ea02f7b",9325:"59362658",9328:"e273c56f",9330:"703158d7",9340:"reactPlayerWistia",9350:"62b755e6",9426:"38ec836e",9429:"fa501e35",9490:"02fcf422",9570:"a3008c1e",9611:"06b6ef6a",9647:"5e95c892",9858:"1f7895dc",9979:"reactPlayerSoundCloud"}[e]||e)+"."+{33:"f6a38190",89:"5fffa456",108:"64a23058",157:"f11295d1",206:"c8ea37d8",225:"b6e1febc",284:"faf99a96",285:"323d81b9",291:"cbdacfa5",300:"75038f51",419:"9c4ab6f7",448:"7252287b",490:"5ac1d5e0",539:"aaefd5d7",560:"88575e3b",603:"64c97fde",636:"62348973",746:"1f9f4180",791:"a22ebdb5",841:"872fa0da",849:"7642116e",850:"1804dfd1",862:"977da1a1",930:"9839796a",956:"a9f72a7c",962:"573682f2",1065:"e5fa7be2",1071:"c7360ae7",1170:"4335d1d5",1179:"90e682e1",1210:"6ffb5f7c",1235:"003a3080",1265:"19c557da",1332:"9e6fd416",1335:"95f1a2ef",1440:"4a429fea",1477:"0bf93bf5",1543:"ff3e1f5e",1640:"39d3866c",1651:"456209b0",1665:"1ede26e4",1679:"09d89b2c",1688:"8bf5a1f2",1706:"7a9128dc",1903:"785e5b99",1915:"072422c8",1924:"5bf7ac2a",1972:"32ef8307",2042:"32fe4d68",2043:"a547ee47",2075:"b8d821b1",2076:"fdf3d109",2089:"b085e51e",2131:"b81984ef",2237:"108a9157",2264:"1d4eadc9",2403:"6a40aeb6",2634:"888e8dd3",2661:"811da9ef",2703:"3444bc9f",2711:"50fcce99",2723:"38950730",2815:"647fe89f",2823:"14ed211e",2908:"08ef6789",2923:"2e07c8be",3021:"796c3720",3073:"bbbe330e",3128:"daf594c6",3148:"2c761e08",3230:"2ba7de5a",3249:"1b8a4762",3276:"008069e2",3333:"3f02f75e",3381:"3bb33213",3392:"b97ea8b4",3404:"287ef655",3460:"2c09e8ba",3522:"34ed0fa3",3554:"6e0477fe",3588:"e44def03",3633:"3543e66d",3637:"cbfc4a48",3694:"6b9c4a2d",3724:"7ab9019b",3795:"83c3cb4c",3841:"d1bf0557",3891:"5eda4897",3976:"202c8cb6",3979:"2dc08ef1",4001:"153f1231",4106:"414f7bf5",4129:"3f33ee0f",4134:"5c69a236",4212:"44e9a0aa",4232:"31c1c944",4240:"e9f5b614",4360:"fbe0dc5f",4372:"073baa5b",4380:"e554156e",4466:"0bbb4afd",4504:"2c0be4fa",4528:"46620c6e",4584:"912dd911",4813:"0ebf699a",4833:"0e8215f8",4865:"d44ee1ec",4952:"5ee671fe",5174:"875c4a9e",5277:"124e5d30",5305:"27ce96bb",5314:"86e352e8",5342:"e04ea00d",5372:"d29ef590",5373:"9d8345bc",5453:"43c63b5b",5506:"03f5edc2",5510:"54d0d61d",5524:"92cf30e2",5550:"34ea4889",5557:"d35dd9e2",5597:"2e736c9e",5678:"3960018d",5740:"13d45470",5741:"e867724d",5742:"3a86eee7",5752:"f7d7ed8f",5794:"93887e5a",5824:"729c21d9",5855:"fe0cb846",5864:"5624a408",5881:"1b445937",5919:"f03d02d3",5939:"6b7e3125",5946:"fde8d8da",5970:"34d283be",6007:"5231c69b",6011:"d98b5ead",6061:"f82b3f46",6157:"901c6cfd",6173:"105dd0ca",6192:"52cdc692",6235:"92382723",6288:"20a24892",6289:"b27a519c",6295:"453ed46f",6302:"f9c7eea2",6318:"1f3b4b7a",6328:"144e834f",6353:"8b83f2fe",6463:"aac36e3b",6473:"e486fbe3",6505:"34c430ba",6582:"afa5864c",6648:"f1cfda77",6653:"ebbab114",6742:"e6e99a43",6743:"1caebb95",6800:"3a7a4235",6827:"fd6dbe54",6841:"66228efa",6854:"c14aaf5b",6887:"7787cb28",6940:"cbf19973",6969:"a76ceb22",7024:"cbe389b6",7068:"49b54587",7075:"cdb488f7",7098:"8d5f8fb2",7318:"bb403124",7377:"707c5668",7381:"e13a36c3",7458:"2fcc11dd",7472:"3d15491a",7477:"34d27d99",7533:"8290bb4e",7570:"03fef906",7574:"685b1e0d",7627:"7889e0e7",7643:"e077d460",7696:"ddf4fc1f",7757:"435a037b",7797:"c1c27f9c",7904:"48a68cda",7910:"64e06668",7960:"26dcf7b4",7968:"1ceec687",8e3:"5f213fe5",8025:"17a95b1d",8045:"e787489a",8046:"e134ab25",8089:"2866c83f",8097:"cf6b15bb",8110:"90090a5e",8121:"2d763874",8130:"76b1143f",8146:"5c2d59cd",8168:"33966b2f",8209:"ac7054ae",8413:"21a5c6e1",8446:"0d3ab8a6",8462:"1f56558e",8474:"888ddfc8",8503:"fb529628",8564:"338d50e6",8609:"d9a84c9a",8734:"9c808716",8737:"f6668c3d",8744:"5122d11a",8749:"acc67002",8901:"7e9acdf0",8927:"30c60b74",8947:"5ba068d6",9024:"939e06e8",9038:"823a8669",9048:"1a05ce91",9070:"e97dbd53",9099:"e208adbc",9144:"c36fb6c6",9190:"213303b0",9239:"9a4ec69f",9241:"76c52664",9260:"2347dc4f",9316:"8c763f74",9325:"7f576902",9328:"e61f2389",9330:"6bfdddc4",9340:"8c6018fb",9350:"51187a34",9426:"3ed9bf1b",9429:"a89949da",9490:"c1150a5d",9570:"b73d3f30",9611:"eca73feb",9647:"74f05f80",9858:"edde97f7",9979:"316d7e72"}[e]+".js",t.miniCssF=e=>{},t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),f={},b="OpenSign-Docs:",t.l=(e,a,c,d)=>{if(f[e])f[e].push(a);else{var r,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n{r.onerror=r.onload=null,clearTimeout(s);var b=f[e];if(delete f[e],r.parentNode&&r.parentNode.removeChild(r),b&&b.forEach(e=>e(c)),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:r}),12e4);r.onerror=u.bind(null,r.onerror),r.onload=u.bind(null,r.onload),o&&document.head.appendChild(r)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),t.p="/",t.gca=function(e){return e={59362658:"9325",61361021:"1915",70276854:"7574","7ad5624c":"33","3009d411":"89","1b14d97a":"108","8001f939":"157",d387ddbc:"206","0a7196e9":"225","107ddcf4":"284","23f866da":"285","4f7a2d40":"291","833eda7d":"300",e5d81aec:"419",d77fb6a8:"448",ce589067:"490",cfb1e6eb:"539","500027af":"560",d5380080:"603",eaa24e23:"636",cf03142d:"746","4acb0154":"791",d1393a72:"841","0058b4c6":"849",c6b74119:"850",be3c2a14:"862","05729a5b":"930","19e4dfff":"956","046910c8":"962","98732f61":"1065",c1e4445e:"1170","489b8a4d":"1179",b3eb04bc:"1210",a7456010:"1235","0c03cd54":"1265",d48fee54:"1332","74c638d3":"1335","277a78f5":"1440","2f6ff211":"1477","3b95ab04":"1543",c9fa5aa5:"1640","19e5ad2a":"1651","7357a3c5":"1665","138cee78":"1679","9640838e":"1688","18b84479":"1706",acecf23e:"1903",d8b805fb:"1924","73664a40":"1972",reactPlayerTwitch:"2042",ac7da374:"2043","5c485335":"2075",common:"2076",c7b98810:"2089","299c7a47":"2131","17e5210b":"2264",bd0e2f4c:"2403",c4f5d8e4:"2634","8bd80e56":"2661",da66eb9c:"2703","9e4087bc":"2711",reactPlayerMux:"2723","0ba00a8d":"2815","9b0b43bf":"2823","2c416566":"2908",ec5e470a:"2923","4cff09f6":"3021",e9e778b7:"3073",c674cfb4:"3128","1e1b513c":"3148",d480dde9:"3230",ccc49370:"3249",e5aefb32:"3276",e48228d1:"3333","42f80fc5":"3381",reactPlayerVidyard:"3392","03e06346":"3404","5ce6d213":"3460",e785206d:"3522","293ced56":"3588",b97a0b7b:"3633",f4f34a3a:"3637","8717b14a":"3694","2ffc1e57":"3724",c4fbe420:"3795","56b5f4f8":"3841","8e4d0438":"3891","0e384e19":"3976","64218a31":"3979",d281bdbe:"4001","882238ec":"4106","393be207":"4134","621db11d":"4212","5a144266":"4232","9c9cb35e":"4240",fdd9b680:"4360","9cd612ce":"4372","656c0f50":"4380","56b0ffe9":"4466","5a9dd378":"4504",f82cd581:"4584","6875c492":"4813",c7e3ab5f:"4833","7ef59f7a":"4865","6bef026b":"4952","51e6fce0":"5174","8320e026":"5277","87a6df42":"5305","88a819d0":"5314","4227e71a":"5342","503125be":"5372","02e5f5c4":"5373","01274ace":"5506","02d4f5c5":"5510","21f05a2f":"5524","14716de7":"5550",d9f32620:"5557",b18842e4:"5597",fdae908b:"5678",fdf3f392:"5740",c081699b:"5741",aba21aa0:"5742","6d2e526e":"5752","3b49dc44":"5794","257dcba5":"5824","444a2573":"5855","3a2a59a1":"5864","63d7f7ab":"5881","980c6622":"5919","837d4f04":"5939","3c9ed71a":"5946","0f8cf55d":"5970","611db08b":"6007","56f1c106":"6011","1f391b9e":"6061","3973fcf3":"6157",reactPlayerVimeo:"6173",c195e1f1:"6192",d0524430:"6235",eedafdee:"6288","951b8254":"6289",d91ad230:"6295","873e7b96":"6302",bb4fa758:"6318",reactPlayerDailyMotion:"6328","5e1bb91e":"6353",reactPlayerKaltura:"6463","4c5e977b":"6473",cd2b86eb:"6505","94e1fa32":"6582","0c0943c7":"6648",f214d5ff:"6653","8871da57":"6742",e226bb09:"6743","044432a7":"6800","0edab2fb":"6827",f22c5875:"6841","7c0adceb":"6854",reactPlayerFacebook:"6887",a000203c:"6940","14eb3368":"6969","98334e25":"7024",e92d0461:"7068","4d139b56":"7075",a7bd4aaa:"7098",e76c28ee:"7318",ff9450a5:"7377","20f41f87":"7381",reactPlayerFilePlayer:"7458","814f3328":"7472","36994c47":"7477",a3b21423:"7533",reactPlayerMixcloud:"7570",reactPlayerStreamable:"7627",a6aa9e1f:"7643","1ee58ee1":"7696",eb56c656:"7757","767ebc75":"7797","5144c8d4":"7904",e4f5c862:"7910",b2e6bd40:"7960","489197af":"7968","54a7b8f4":"8000","5e90a9b3":"8025",fff7b69d:"8045","6621d3c0":"8046",b9fdab4b:"8089",ab2a161b:"8097","825a5e83":"8110","3a2db09e":"8121",f81c1134:"8130",c15d9823:"8146","6c0cc40d":"8168","01a85c17":"8209",ed918ad6:"8413",reactPlayerYouTube:"8446","3217192f":"8462","652d83be":"8474","012b45bf":"8503","58abd73c":"8564","925b3f96":"8609",reactPlayerPreview:"8734","7661071f":"8737",ffa808c5:"8744",b93339ed:"8749","1c57a399":"8901",b0378e01:"8927",ef8b811a:"8947",e5a49157:"9024","44f24773":"9038",a94703ab:"9048","851f8f65":"9070","34593b53":"9099",dc8c216b:"9144","6cb65baf":"9190","0c806540":"9239","11b7b3d8":"9241","96f83544":"9260","2ea02f7b":"9316",e273c56f:"9328","703158d7":"9330",reactPlayerWistia:"9340","62b755e6":"9350","38ec836e":"9426",fa501e35:"9429","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 b=new Promise((c,b)=>f=e[a]=[c,b]);c.push(f[2]=b);var d=t.p+t.u(a),r=new Error;t.l(d,c=>{if(t.o(e,a)&&(0!==(f=e[a])&&(e[a]=void 0),f)){var b=c&&("load"===c.type?"missing":c.type),d=c&&c.target&&c.target.src;r.message="Loading chunk "+a+" failed.\n("+b+": "+d+")",r.name="ChunkLoadError",r.type=b,r.request=d,f[1](r)}},"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var f,b,[d,r,o]=c,l=0;if(d.some(a=>0!==e[a])){for(f in r)t.o(r,f)&&(t.m[f]=r[f]);if(o)var n=o(t)}for(a&&a(c);l{"use strict";var e,a,c,f,b,d={},r={};function t(e){var a=r[e];if(void 0!==a)return a.exports;var c=r[e]={id:e,loaded:!1,exports:{}};return d[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=d,t.c=r,e=[],t.O=(a,c,f,b)=>{if(!c){var d=1/0;for(n=0;n=b)&&Object.keys(t.O).every(e=>t.O[e](c[o]))?c.splice(o--,1):(r=!1,b0&&e[n-1][2]>b;n--)e[n]=e[n-1];e[n]=[c,f,b]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,f){if(1&f&&(e=this(e)),8&f)return e;if("object"==typeof e&&e){if(4&f&&e.__esModule)return e;if(16&f&&"function"==typeof e.then)return e}var b=Object.create(null);t.r(b);var d={};a=a||[null,c({}),c([]),c(c)];for(var r=2&f&&e;("object"==typeof r||"function"==typeof r)&&!~a.indexOf(r);r=c(r))Object.getOwnPropertyNames(r).forEach(a=>d[a]=()=>e[a]);return d.default=()=>e,t.d(b,d),b},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce((a,c)=>(t.f[c](e,a),a),[])),t.u=e=>"assets/js/"+({33:"7ad5624c",89:"3009d411",108:"1b14d97a",157:"8001f939",206:"d387ddbc",225:"0a7196e9",284:"107ddcf4",285:"23f866da",291:"4f7a2d40",300:"833eda7d",419:"e5d81aec",448:"d77fb6a8",490:"ce589067",539:"cfb1e6eb",560:"500027af",603:"d5380080",636:"eaa24e23",746:"cf03142d",791:"4acb0154",841:"d1393a72",849:"0058b4c6",850:"c6b74119",862:"be3c2a14",930:"05729a5b",956:"19e4dfff",962:"046910c8",1065:"98732f61",1170:"c1e4445e",1179:"489b8a4d",1210:"b3eb04bc",1235:"a7456010",1265:"0c03cd54",1332:"d48fee54",1335:"74c638d3",1440:"277a78f5",1477:"2f6ff211",1543:"3b95ab04",1640:"c9fa5aa5",1651:"19e5ad2a",1665:"7357a3c5",1679:"138cee78",1688:"9640838e",1706:"18b84479",1903:"acecf23e",1915:"61361021",1924:"d8b805fb",1972:"73664a40",2042:"reactPlayerTwitch",2043:"ac7da374",2075:"5c485335",2076:"common",2089:"c7b98810",2131:"299c7a47",2264:"17e5210b",2403:"bd0e2f4c",2634:"c4f5d8e4",2661:"8bd80e56",2703:"da66eb9c",2711:"9e4087bc",2723:"reactPlayerMux",2815:"0ba00a8d",2823:"9b0b43bf",2908:"2c416566",2923:"ec5e470a",3021:"4cff09f6",3073:"e9e778b7",3128:"c674cfb4",3148:"1e1b513c",3230:"d480dde9",3249:"ccc49370",3276:"e5aefb32",3333:"e48228d1",3381:"42f80fc5",3392:"reactPlayerVidyard",3404:"03e06346",3460:"5ce6d213",3522:"e785206d",3588:"293ced56",3633:"b97a0b7b",3637:"f4f34a3a",3694:"8717b14a",3724:"2ffc1e57",3795:"c4fbe420",3841:"56b5f4f8",3891:"8e4d0438",3976:"0e384e19",3979:"64218a31",4001:"d281bdbe",4106:"882238ec",4134:"393be207",4212:"621db11d",4232:"5a144266",4240:"9c9cb35e",4360:"fdd9b680",4372:"9cd612ce",4380:"656c0f50",4466:"56b0ffe9",4504:"5a9dd378",4584:"f82cd581",4813:"6875c492",4833:"c7e3ab5f",4865:"7ef59f7a",4952:"6bef026b",5174:"51e6fce0",5277:"8320e026",5305:"87a6df42",5314:"88a819d0",5342:"4227e71a",5372:"503125be",5373:"02e5f5c4",5506:"01274ace",5510:"02d4f5c5",5524:"21f05a2f",5550:"14716de7",5557:"d9f32620",5597:"b18842e4",5678:"fdae908b",5740:"fdf3f392",5741:"c081699b",5742:"aba21aa0",5752:"6d2e526e",5794:"3b49dc44",5824:"257dcba5",5855:"444a2573",5864:"3a2a59a1",5881:"63d7f7ab",5919:"980c6622",5939:"837d4f04",5946:"3c9ed71a",5970:"0f8cf55d",6007:"611db08b",6011:"56f1c106",6061:"1f391b9e",6157:"3973fcf3",6173:"reactPlayerVimeo",6192:"c195e1f1",6235:"d0524430",6288:"eedafdee",6289:"951b8254",6295:"d91ad230",6302:"873e7b96",6318:"bb4fa758",6328:"reactPlayerDailyMotion",6353:"5e1bb91e",6463:"reactPlayerKaltura",6473:"4c5e977b",6505:"cd2b86eb",6582:"94e1fa32",6648:"0c0943c7",6653:"f214d5ff",6742:"8871da57",6743:"e226bb09",6800:"044432a7",6827:"0edab2fb",6841:"f22c5875",6854:"7c0adceb",6887:"reactPlayerFacebook",6940:"a000203c",6969:"14eb3368",7024:"98334e25",7068:"e92d0461",7075:"4d139b56",7098:"a7bd4aaa",7318:"e76c28ee",7377:"ff9450a5",7381:"20f41f87",7458:"reactPlayerFilePlayer",7472:"814f3328",7477:"36994c47",7533:"a3b21423",7570:"reactPlayerMixcloud",7574:"70276854",7627:"reactPlayerStreamable",7643:"a6aa9e1f",7696:"1ee58ee1",7757:"eb56c656",7797:"767ebc75",7904:"5144c8d4",7910:"e4f5c862",7960:"b2e6bd40",7968:"489197af",8e3:"54a7b8f4",8025:"5e90a9b3",8045:"fff7b69d",8046:"6621d3c0",8089:"b9fdab4b",8097:"ab2a161b",8110:"825a5e83",8121:"3a2db09e",8130:"f81c1134",8146:"c15d9823",8168:"6c0cc40d",8209:"01a85c17",8413:"ed918ad6",8446:"reactPlayerYouTube",8462:"3217192f",8474:"652d83be",8503:"012b45bf",8564:"58abd73c",8609:"925b3f96",8734:"reactPlayerPreview",8737:"7661071f",8744:"ffa808c5",8749:"b93339ed",8901:"1c57a399",8927:"b0378e01",8947:"ef8b811a",9024:"e5a49157",9038:"44f24773",9048:"a94703ab",9070:"851f8f65",9099:"34593b53",9144:"dc8c216b",9190:"6cb65baf",9239:"0c806540",9241:"11b7b3d8",9260:"96f83544",9316:"2ea02f7b",9325:"59362658",9328:"e273c56f",9330:"703158d7",9340:"reactPlayerWistia",9350:"62b755e6",9426:"38ec836e",9429:"fa501e35",9490:"02fcf422",9570:"a3008c1e",9611:"06b6ef6a",9647:"5e95c892",9858:"1f7895dc",9979:"reactPlayerSoundCloud"}[e]||e)+"."+{33:"f6a38190",89:"5fffa456",108:"64a23058",157:"f11295d1",206:"6d78f6de",225:"b6e1febc",284:"faf99a96",285:"323d81b9",291:"cbdacfa5",300:"75038f51",419:"9c4ab6f7",448:"7252287b",490:"5ac1d5e0",539:"aaefd5d7",560:"88575e3b",603:"93a2f541",636:"62348973",746:"1f9f4180",791:"a22ebdb5",841:"872fa0da",849:"5ccc2f0a",850:"1804dfd1",862:"993abd75",930:"9839796a",956:"a9f72a7c",962:"573682f2",1065:"e64405b6",1071:"c7360ae7",1170:"4335d1d5",1179:"90e682e1",1210:"fdce2266",1235:"003a3080",1265:"4b8ae5df",1332:"1b74d8ab",1335:"e09a75e4",1440:"4a429fea",1477:"0bf93bf5",1543:"a5996e14",1640:"39d3866c",1651:"456209b0",1665:"1ede26e4",1679:"09d89b2c",1688:"8bf5a1f2",1706:"7a9128dc",1903:"785e5b99",1915:"f0586b79",1924:"5bf7ac2a",1972:"32ef8307",2042:"32fe4d68",2043:"a547ee47",2075:"b8d821b1",2076:"fdf3d109",2089:"b085e51e",2131:"b81984ef",2237:"108a9157",2264:"1d4eadc9",2403:"acc0fa29",2634:"888e8dd3",2661:"811da9ef",2703:"3444bc9f",2711:"50fcce99",2723:"38950730",2815:"36e4dd53",2823:"14ed211e",2908:"08ef6789",2923:"7ac2a895",3021:"796c3720",3073:"bbbe330e",3128:"daf594c6",3148:"2c761e08",3230:"2ba7de5a",3249:"1b8a4762",3276:"008069e2",3333:"3f02f75e",3381:"3bb33213",3392:"b97ea8b4",3404:"287ef655",3460:"2c09e8ba",3522:"34ed0fa3",3554:"6e0477fe",3588:"6c072cba",3633:"3543e66d",3637:"cbfc4a48",3694:"6b9c4a2d",3724:"7ab9019b",3795:"83c3cb4c",3841:"d1bf0557",3891:"5eda4897",3976:"202c8cb6",3979:"2dc08ef1",4001:"153f1231",4106:"414f7bf5",4129:"3f33ee0f",4134:"5c69a236",4212:"44e9a0aa",4232:"31c1c944",4240:"e9f5b614",4360:"fbe0dc5f",4372:"073baa5b",4380:"4617fca3",4466:"0bbb4afd",4504:"2c0be4fa",4528:"46620c6e",4584:"912dd911",4813:"0ebf699a",4833:"0e8215f8",4865:"d44ee1ec",4952:"5ee671fe",5174:"b99ca595",5277:"124e5d30",5305:"27ce96bb",5314:"86e352e8",5342:"e04ea00d",5372:"e73d9822",5373:"9d8345bc",5453:"43c63b5b",5506:"03f5edc2",5510:"54d0d61d",5524:"92cf30e2",5550:"34ea4889",5557:"d35dd9e2",5597:"2e736c9e",5678:"87ba8777",5740:"cda41a69",5741:"3e91ece8",5742:"3a86eee7",5752:"f7d7ed8f",5794:"93887e5a",5824:"a133040b",5855:"fe0cb846",5864:"145a6958",5881:"1b445937",5919:"f03d02d3",5939:"6b7e3125",5946:"c61f63ae",5970:"34d283be",6007:"5231c69b",6011:"d98b5ead",6061:"f82b3f46",6157:"901c6cfd",6173:"105dd0ca",6192:"52cdc692",6235:"92382723",6288:"20a24892",6289:"d1634b06",6295:"453ed46f",6302:"f9c7eea2",6318:"1f3b4b7a",6328:"144e834f",6353:"8b83f2fe",6463:"aac36e3b",6473:"e486fbe3",6505:"34c430ba",6582:"28eaba14",6648:"f1cfda77",6653:"ebbab114",6742:"bea9a2c0",6743:"1caebb95",6800:"3e475826",6827:"fd6dbe54",6841:"66228efa",6854:"c14aaf5b",6887:"7787cb28",6940:"cbf19973",6969:"a76ceb22",7024:"cbe389b6",7068:"49b54587",7075:"cdb488f7",7098:"8d5f8fb2",7318:"bb403124",7377:"95443097",7381:"e13a36c3",7458:"2fcc11dd",7472:"3d15491a",7477:"34d27d99",7533:"31961bd6",7570:"03fef906",7574:"685b1e0d",7627:"7889e0e7",7643:"e077d460",7696:"ddf4fc1f",7757:"435a037b",7797:"c1c27f9c",7904:"48a68cda",7910:"64e06668",7960:"26dcf7b4",7968:"1ceec687",8e3:"5f213fe5",8025:"17a95b1d",8045:"e787489a",8046:"e134ab25",8089:"7731be4d",8097:"cf6b15bb",8110:"90090a5e",8121:"2d763874",8130:"76b1143f",8146:"5c2d59cd",8168:"33966b2f",8209:"ac7054ae",8413:"6be82ba5",8446:"0d3ab8a6",8462:"1f56558e",8474:"888ddfc8",8503:"fb529628",8564:"338d50e6",8609:"d9a84c9a",8734:"9c808716",8737:"f6668c3d",8744:"913f44ae",8749:"acc67002",8901:"7e9acdf0",8927:"30c60b74",8947:"5ba068d6",9024:"939e06e8",9038:"6457b597",9048:"1a05ce91",9070:"e97dbd53",9099:"e208adbc",9144:"c36fb6c6",9190:"213303b0",9239:"9a4ec69f",9241:"76c52664",9260:"2347dc4f",9316:"a7dc9de2",9325:"7f576902",9328:"e61f2389",9330:"d7b826a5",9340:"8c6018fb",9350:"51187a34",9426:"3ed9bf1b",9429:"a89949da",9490:"c1150a5d",9570:"b73d3f30",9611:"eca73feb",9647:"74f05f80",9858:"edde97f7",9979:"316d7e72"}[e]+".js",t.miniCssF=e=>{},t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),f={},b="OpenSign-Docs:",t.l=(e,a,c,d)=>{if(f[e])f[e].push(a);else{var r,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n{r.onerror=r.onload=null,clearTimeout(s);var b=f[e];if(delete f[e],r.parentNode&&r.parentNode.removeChild(r),b&&b.forEach(e=>e(c)),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:r}),12e4);r.onerror=u.bind(null,r.onerror),r.onload=u.bind(null,r.onload),o&&document.head.appendChild(r)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),t.p="/",t.gca=function(e){return e={59362658:"9325",61361021:"1915",70276854:"7574","7ad5624c":"33","3009d411":"89","1b14d97a":"108","8001f939":"157",d387ddbc:"206","0a7196e9":"225","107ddcf4":"284","23f866da":"285","4f7a2d40":"291","833eda7d":"300",e5d81aec:"419",d77fb6a8:"448",ce589067:"490",cfb1e6eb:"539","500027af":"560",d5380080:"603",eaa24e23:"636",cf03142d:"746","4acb0154":"791",d1393a72:"841","0058b4c6":"849",c6b74119:"850",be3c2a14:"862","05729a5b":"930","19e4dfff":"956","046910c8":"962","98732f61":"1065",c1e4445e:"1170","489b8a4d":"1179",b3eb04bc:"1210",a7456010:"1235","0c03cd54":"1265",d48fee54:"1332","74c638d3":"1335","277a78f5":"1440","2f6ff211":"1477","3b95ab04":"1543",c9fa5aa5:"1640","19e5ad2a":"1651","7357a3c5":"1665","138cee78":"1679","9640838e":"1688","18b84479":"1706",acecf23e:"1903",d8b805fb:"1924","73664a40":"1972",reactPlayerTwitch:"2042",ac7da374:"2043","5c485335":"2075",common:"2076",c7b98810:"2089","299c7a47":"2131","17e5210b":"2264",bd0e2f4c:"2403",c4f5d8e4:"2634","8bd80e56":"2661",da66eb9c:"2703","9e4087bc":"2711",reactPlayerMux:"2723","0ba00a8d":"2815","9b0b43bf":"2823","2c416566":"2908",ec5e470a:"2923","4cff09f6":"3021",e9e778b7:"3073",c674cfb4:"3128","1e1b513c":"3148",d480dde9:"3230",ccc49370:"3249",e5aefb32:"3276",e48228d1:"3333","42f80fc5":"3381",reactPlayerVidyard:"3392","03e06346":"3404","5ce6d213":"3460",e785206d:"3522","293ced56":"3588",b97a0b7b:"3633",f4f34a3a:"3637","8717b14a":"3694","2ffc1e57":"3724",c4fbe420:"3795","56b5f4f8":"3841","8e4d0438":"3891","0e384e19":"3976","64218a31":"3979",d281bdbe:"4001","882238ec":"4106","393be207":"4134","621db11d":"4212","5a144266":"4232","9c9cb35e":"4240",fdd9b680:"4360","9cd612ce":"4372","656c0f50":"4380","56b0ffe9":"4466","5a9dd378":"4504",f82cd581:"4584","6875c492":"4813",c7e3ab5f:"4833","7ef59f7a":"4865","6bef026b":"4952","51e6fce0":"5174","8320e026":"5277","87a6df42":"5305","88a819d0":"5314","4227e71a":"5342","503125be":"5372","02e5f5c4":"5373","01274ace":"5506","02d4f5c5":"5510","21f05a2f":"5524","14716de7":"5550",d9f32620:"5557",b18842e4:"5597",fdae908b:"5678",fdf3f392:"5740",c081699b:"5741",aba21aa0:"5742","6d2e526e":"5752","3b49dc44":"5794","257dcba5":"5824","444a2573":"5855","3a2a59a1":"5864","63d7f7ab":"5881","980c6622":"5919","837d4f04":"5939","3c9ed71a":"5946","0f8cf55d":"5970","611db08b":"6007","56f1c106":"6011","1f391b9e":"6061","3973fcf3":"6157",reactPlayerVimeo:"6173",c195e1f1:"6192",d0524430:"6235",eedafdee:"6288","951b8254":"6289",d91ad230:"6295","873e7b96":"6302",bb4fa758:"6318",reactPlayerDailyMotion:"6328","5e1bb91e":"6353",reactPlayerKaltura:"6463","4c5e977b":"6473",cd2b86eb:"6505","94e1fa32":"6582","0c0943c7":"6648",f214d5ff:"6653","8871da57":"6742",e226bb09:"6743","044432a7":"6800","0edab2fb":"6827",f22c5875:"6841","7c0adceb":"6854",reactPlayerFacebook:"6887",a000203c:"6940","14eb3368":"6969","98334e25":"7024",e92d0461:"7068","4d139b56":"7075",a7bd4aaa:"7098",e76c28ee:"7318",ff9450a5:"7377","20f41f87":"7381",reactPlayerFilePlayer:"7458","814f3328":"7472","36994c47":"7477",a3b21423:"7533",reactPlayerMixcloud:"7570",reactPlayerStreamable:"7627",a6aa9e1f:"7643","1ee58ee1":"7696",eb56c656:"7757","767ebc75":"7797","5144c8d4":"7904",e4f5c862:"7910",b2e6bd40:"7960","489197af":"7968","54a7b8f4":"8000","5e90a9b3":"8025",fff7b69d:"8045","6621d3c0":"8046",b9fdab4b:"8089",ab2a161b:"8097","825a5e83":"8110","3a2db09e":"8121",f81c1134:"8130",c15d9823:"8146","6c0cc40d":"8168","01a85c17":"8209",ed918ad6:"8413",reactPlayerYouTube:"8446","3217192f":"8462","652d83be":"8474","012b45bf":"8503","58abd73c":"8564","925b3f96":"8609",reactPlayerPreview:"8734","7661071f":"8737",ffa808c5:"8744",b93339ed:"8749","1c57a399":"8901",b0378e01:"8927",ef8b811a:"8947",e5a49157:"9024","44f24773":"9038",a94703ab:"9048","851f8f65":"9070","34593b53":"9099",dc8c216b:"9144","6cb65baf":"9190","0c806540":"9239","11b7b3d8":"9241","96f83544":"9260","2ea02f7b":"9316",e273c56f:"9328","703158d7":"9330",reactPlayerWistia:"9340","62b755e6":"9350","38ec836e":"9426",fa501e35:"9429","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 b=new Promise((c,b)=>f=e[a]=[c,b]);c.push(f[2]=b);var d=t.p+t.u(a),r=new Error;t.l(d,c=>{if(t.o(e,a)&&(0!==(f=e[a])&&(e[a]=void 0),f)){var b=c&&("load"===c.type?"missing":c.type),d=c&&c.target&&c.target.src;r.message="Loading chunk "+a+" failed.\n("+b+": "+d+")",r.name="ChunkLoadError",r.type=b,r.request=d,f[1](r)}},"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var f,b,[d,r,o]=c,l=0;if(d.some(a=>0!==e[a])){for(f in r)t.o(r,f)&&(t.m[f]=r[f]);if(o)var n=o(t)}for(a&&a(c);l Archive | OpenSign™ - + diff --git a/blog/authors/index.html b/blog/authors/index.html index 17666a154..f2c19a132 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 eeed07921..87e6d4a5d 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 83388d8b6..11e52d61e 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 7895f34f5..e9604e50b 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 8eb9aabe6..4089a625e 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 7ed66dd35..3ed0bad4a 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 144792b74..9422f85d5 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 b73d3af77..51669aff6 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 6cebdafba..7fb1e9721 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 bae571e16..96b88b6a8 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 13231c01e..1b3b31dca 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 247e46845..8d7030a35 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 c360cfa75..49617147e 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 3eb053c19..22a9c64b0 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 947a3cda1..cfd8bd9b5 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 4832d906d..7316de03c 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 7454fc3d5..4bd82e555 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 1298a0631..9ea9ea317 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 074481a25..b36946cdb 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 082b17684..aca2f8c78 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 78cb5b84b..cef296353 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 393471a00..6a3d93bfa 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 419ea1cb6..445f4d68a 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 d17edaaab..049944ec4 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 393ef6596..6d355ff9f 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 474ece54a..2c0c86291 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 ce409d44a..a5d1a7bd1 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 93565897f..5eae22736 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 7e85d4cec..7190df6f9 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 529ca482f..4c7a9144b 100644 --- a/docs/API-docs/v1.1/getcontact/index.html +++ b/docs/API-docs/v1.1/getcontact/index.html @@ -5,7 +5,7 @@ Get Contact | OpenSign™ - + diff --git a/docs/API-docs/v1.1/getcredits/index.html b/docs/API-docs/v1.1/getcredits/index.html index a9a1ceae4..b63cbd931 100644 --- a/docs/API-docs/v1.1/getcredits/index.html +++ b/docs/API-docs/v1.1/getcredits/index.html @@ -5,7 +5,7 @@ Get your API credits | OpenSign™ - + diff --git a/docs/API-docs/v1.1/getdocument/index.html b/docs/API-docs/v1.1/getdocument/index.html index aa88a3634..a0f63b982 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 5fda60cce..56880c112 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 eae5dbb53..c2e98a5c6 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/getformdata/index.html b/docs/API-docs/v1.1/getformdata/index.html index 594b05ea6..3987b1d84 100644 --- a/docs/API-docs/v1.1/getformdata/index.html +++ b/docs/API-docs/v1.1/getformdata/index.html @@ -5,7 +5,7 @@ Get Formdata | OpenSign™ - + diff --git a/docs/API-docs/v1.1/getsignerips/index.html b/docs/API-docs/v1.1/getsignerips/index.html index 76a313b3b..236179eda 100644 --- a/docs/API-docs/v1.1/getsignerips/index.html +++ b/docs/API-docs/v1.1/getsignerips/index.html @@ -5,7 +5,7 @@ Get Signer IPs | OpenSign™ - + diff --git a/docs/API-docs/v1.1/getsigninglinks/index.html b/docs/API-docs/v1.1/getsigninglinks/index.html index 7ccabda96..a14dc9d73 100644 --- a/docs/API-docs/v1.1/getsigninglinks/index.html +++ b/docs/API-docs/v1.1/getsigninglinks/index.html @@ -5,7 +5,7 @@ Get Signing Links | OpenSign™ - + diff --git a/docs/API-docs/v1.1/gettemplatelist/index.html b/docs/API-docs/v1.1/gettemplatelist/index.html index ea86183c8..9eee8d014 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 5e7eb287e..f11e70d75 100644 --- a/docs/API-docs/v1.1/index.html +++ b/docs/API-docs/v1.1/index.html @@ -5,7 +5,7 @@ OpenSign API v1.1 | OpenSign™ - + diff --git a/docs/API-docs/v1.1/intro/index.html b/docs/API-docs/v1.1/intro/index.html index ce3cec860..445a912e0 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 6e5323c15..f2daf0155 100644 --- a/docs/API-docs/v1.1/opensign-api-v-1-1/index.html +++ b/docs/API-docs/v1.1/opensign-api-v-1-1/index.html @@ -5,7 +5,7 @@ OpenSign API v1.1 | OpenSign™ - + diff --git a/docs/API-docs/v1.1/publictemplate/index.html b/docs/API-docs/v1.1/publictemplate/index.html index 4f6e03109..29fe6e3f8 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 0b9990359..ec83f0700 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 4bbb22925..a2df580a2 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 cca046440..ee29feecc 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 c2d79c37d..3c5245ad0 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 6890deb07..9a0b48108 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 4628d43dc..15520a3d2 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 ebee4d193..26894a798 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.2/contactlist/index.html b/docs/API-docs/v1.2/contactlist/index.html index f9febc9c2..30f263f4f 100644 --- a/docs/API-docs/v1.2/contactlist/index.html +++ b/docs/API-docs/v1.2/contactlist/index.html @@ -5,7 +5,7 @@ Get Contact list | OpenSign™ - + diff --git a/docs/API-docs/v1.2/createcontact/index.html b/docs/API-docs/v1.2/createcontact/index.html index da0db5572..d01e4c616 100644 --- a/docs/API-docs/v1.2/createcontact/index.html +++ b/docs/API-docs/v1.2/createcontact/index.html @@ -5,7 +5,7 @@ Create Contact | OpenSign™ - + diff --git a/docs/API-docs/v1.2/createdocument/index.html b/docs/API-docs/v1.2/createdocument/index.html index bed76beed..980e450c7 100644 --- a/docs/API-docs/v1.2/createdocument/index.html +++ b/docs/API-docs/v1.2/createdocument/index.html @@ -5,7 +5,7 @@ Create Document | OpenSign™ - + diff --git a/docs/API-docs/v1.2/createdocumentwithtemplateid/index.html b/docs/API-docs/v1.2/createdocumentwithtemplateid/index.html index e0ae97ab9..3cf5f29aa 100644 --- a/docs/API-docs/v1.2/createdocumentwithtemplateid/index.html +++ b/docs/API-docs/v1.2/createdocumentwithtemplateid/index.html @@ -5,7 +5,7 @@ Create Document from Template | OpenSign™ - + diff --git a/docs/API-docs/v1.2/createfolder/index.html b/docs/API-docs/v1.2/createfolder/index.html index 3978f12b6..19abc4b96 100644 --- a/docs/API-docs/v1.2/createfolder/index.html +++ b/docs/API-docs/v1.2/createfolder/index.html @@ -5,7 +5,7 @@ Create Folder | OpenSign™ - + diff --git a/docs/API-docs/v1.2/createtemplate/index.html b/docs/API-docs/v1.2/createtemplate/index.html index 1242bd2dd..c03c1306f 100644 --- a/docs/API-docs/v1.2/createtemplate/index.html +++ b/docs/API-docs/v1.2/createtemplate/index.html @@ -5,7 +5,7 @@ Create Template | OpenSign™ - + diff --git a/docs/API-docs/v1.2/delete-template/index.html b/docs/API-docs/v1.2/delete-template/index.html index b8cc7cafd..944796f7f 100644 --- a/docs/API-docs/v1.2/delete-template/index.html +++ b/docs/API-docs/v1.2/delete-template/index.html @@ -5,7 +5,7 @@ Delete Template | OpenSign™ - + diff --git a/docs/API-docs/v1.2/delete-webhook/index.html b/docs/API-docs/v1.2/delete-webhook/index.html index 4e547c5ad..beff60aa1 100644 --- a/docs/API-docs/v1.2/delete-webhook/index.html +++ b/docs/API-docs/v1.2/delete-webhook/index.html @@ -5,7 +5,7 @@ Delete Webhook | OpenSign™ - + diff --git a/docs/API-docs/v1.2/deletecontact/index.html b/docs/API-docs/v1.2/deletecontact/index.html index 934444a57..baae8335e 100644 --- a/docs/API-docs/v1.2/deletecontact/index.html +++ b/docs/API-docs/v1.2/deletecontact/index.html @@ -5,7 +5,7 @@ Delete Contact | OpenSign™ - + diff --git a/docs/API-docs/v1.2/deletedocument/index.html b/docs/API-docs/v1.2/deletedocument/index.html index 9929b35b6..a7f8136be 100644 --- a/docs/API-docs/v1.2/deletedocument/index.html +++ b/docs/API-docs/v1.2/deletedocument/index.html @@ -5,7 +5,7 @@ Delete Document | OpenSign™ - + diff --git a/docs/API-docs/v1.2/deletefolder/index.html b/docs/API-docs/v1.2/deletefolder/index.html index d8483b843..29c008720 100644 --- a/docs/API-docs/v1.2/deletefolder/index.html +++ b/docs/API-docs/v1.2/deletefolder/index.html @@ -5,7 +5,7 @@ Delete Folder | OpenSign™ - + diff --git a/docs/API-docs/v1.2/draftdocument/index.html b/docs/API-docs/v1.2/draftdocument/index.html index 539f77a14..7978effdd 100644 --- a/docs/API-docs/v1.2/draftdocument/index.html +++ b/docs/API-docs/v1.2/draftdocument/index.html @@ -5,7 +5,7 @@ Draft Document | OpenSign™ - + diff --git a/docs/API-docs/v1.2/drafttemplate/index.html b/docs/API-docs/v1.2/drafttemplate/index.html index 8834e7ef5..91ab9dc6d 100644 --- a/docs/API-docs/v1.2/drafttemplate/index.html +++ b/docs/API-docs/v1.2/drafttemplate/index.html @@ -5,7 +5,7 @@ Draft Template | OpenSign™ - + diff --git a/docs/API-docs/v1.2/folderlist/index.html b/docs/API-docs/v1.2/folderlist/index.html index 791b8a5ab..63a5f84c1 100644 --- a/docs/API-docs/v1.2/folderlist/index.html +++ b/docs/API-docs/v1.2/folderlist/index.html @@ -5,7 +5,7 @@ Get folder list | OpenSign™ - + diff --git a/docs/API-docs/v1.2/get-template/index.html b/docs/API-docs/v1.2/get-template/index.html index 507b19377..520d84492 100644 --- a/docs/API-docs/v1.2/get-template/index.html +++ b/docs/API-docs/v1.2/get-template/index.html @@ -5,7 +5,7 @@ Get Template | OpenSign™ - + diff --git a/docs/API-docs/v1.2/get-user/index.html b/docs/API-docs/v1.2/get-user/index.html index 956c35e28..abffe722b 100644 --- a/docs/API-docs/v1.2/get-user/index.html +++ b/docs/API-docs/v1.2/get-user/index.html @@ -5,7 +5,7 @@ Get your account details | OpenSign™ - + diff --git a/docs/API-docs/v1.2/get-webhook/index.html b/docs/API-docs/v1.2/get-webhook/index.html index 5be41d1bf..f49332355 100644 --- a/docs/API-docs/v1.2/get-webhook/index.html +++ b/docs/API-docs/v1.2/get-webhook/index.html @@ -5,7 +5,7 @@ Get Webhook | OpenSign™ - + diff --git a/docs/API-docs/v1.2/getcontact/index.html b/docs/API-docs/v1.2/getcontact/index.html index c0438b064..480a2ef0b 100644 --- a/docs/API-docs/v1.2/getcontact/index.html +++ b/docs/API-docs/v1.2/getcontact/index.html @@ -5,7 +5,7 @@ Get Contact | OpenSign™ - + diff --git a/docs/API-docs/v1.2/getcredits/index.html b/docs/API-docs/v1.2/getcredits/index.html index b92afa81a..3473d6c18 100644 --- a/docs/API-docs/v1.2/getcredits/index.html +++ b/docs/API-docs/v1.2/getcredits/index.html @@ -5,7 +5,7 @@ Get your API credits | OpenSign™ - + diff --git a/docs/API-docs/v1.2/getdocument/index.html b/docs/API-docs/v1.2/getdocument/index.html index 4b2dd43b7..9d5b20a1f 100644 --- a/docs/API-docs/v1.2/getdocument/index.html +++ b/docs/API-docs/v1.2/getdocument/index.html @@ -5,7 +5,7 @@ Get Document | OpenSign™ - + diff --git a/docs/API-docs/v1.2/getdocumentlist/index.html b/docs/API-docs/v1.2/getdocumentlist/index.html index 9f02be003..668002d79 100644 --- a/docs/API-docs/v1.2/getdocumentlist/index.html +++ b/docs/API-docs/v1.2/getdocumentlist/index.html @@ -5,7 +5,7 @@ Get Document list from status | OpenSign™ - + diff --git a/docs/API-docs/v1.2/getfolder/index.html b/docs/API-docs/v1.2/getfolder/index.html index 1842c25db..792b5cf11 100644 --- a/docs/API-docs/v1.2/getfolder/index.html +++ b/docs/API-docs/v1.2/getfolder/index.html @@ -5,7 +5,7 @@ Get Folder | OpenSign™ - + diff --git a/docs/API-docs/v1.2/getformdata/index.html b/docs/API-docs/v1.2/getformdata/index.html index 5b3365a46..16cb3579f 100644 --- a/docs/API-docs/v1.2/getformdata/index.html +++ b/docs/API-docs/v1.2/getformdata/index.html @@ -5,7 +5,7 @@ Get Formdata | OpenSign™ - + diff --git a/docs/API-docs/v1.2/getsignerips/index.html b/docs/API-docs/v1.2/getsignerips/index.html index 423696a18..17148d846 100644 --- a/docs/API-docs/v1.2/getsignerips/index.html +++ b/docs/API-docs/v1.2/getsignerips/index.html @@ -5,7 +5,7 @@ Get Signer IPs | OpenSign™ - + diff --git a/docs/API-docs/v1.2/getsigninglinks/index.html b/docs/API-docs/v1.2/getsigninglinks/index.html index 4279d4d5f..18e40d71f 100644 --- a/docs/API-docs/v1.2/getsigninglinks/index.html +++ b/docs/API-docs/v1.2/getsigninglinks/index.html @@ -5,7 +5,7 @@ Get Signing Links | OpenSign™ - + diff --git a/docs/API-docs/v1.2/gettemplatelist/index.html b/docs/API-docs/v1.2/gettemplatelist/index.html index d84be4f7f..2f4fa6703 100644 --- a/docs/API-docs/v1.2/gettemplatelist/index.html +++ b/docs/API-docs/v1.2/gettemplatelist/index.html @@ -5,7 +5,7 @@ Get Template list | OpenSign™ - + diff --git a/docs/API-docs/v1.2/index.html b/docs/API-docs/v1.2/index.html index 223730ca1..07f365b94 100644 --- a/docs/API-docs/v1.2/index.html +++ b/docs/API-docs/v1.2/index.html @@ -5,13 +5,13 @@ OpenSign API v1.2 | OpenSign™ - + -

OpenSign API v1.2

+

OpenSign API v1.2

\ No newline at end of file diff --git a/docs/API-docs/v1.2/intro/index.html b/docs/API-docs/v1.2/intro/index.html index 968158339..4e066a061 100644 --- a/docs/API-docs/v1.2/intro/index.html +++ b/docs/API-docs/v1.2/intro/index.html @@ -5,7 +5,7 @@ Overview | OpenSign™ - + diff --git a/docs/API-docs/v1.2/opensign-api-v-1-2/index.html b/docs/API-docs/v1.2/opensign-api-v-1-2/index.html index 14c9b0a08..b4bf70ec6 100644 --- a/docs/API-docs/v1.2/opensign-api-v-1-2/index.html +++ b/docs/API-docs/v1.2/opensign-api-v-1-2/index.html @@ -3,36 +3,63 @@ -OpenSign API v1.2 | OpenSign™ +OpenSign API v1.2 | OpenSign™ - + -
Version: 1.0.0 +
Version: 1.0.0

OpenSign API v1.2

-

Welcome to the OpenSign™ API v1.2 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:

+

OpenSign™ API v1.2

+
+

The open-source DocuSign alternative — built for developers, trusted by enterprises.

+
+

OpenSign™ gives you a complete, production-ready e-signature platform through a single, RESTful API. Send documents for signature, manage templates, track signing status in real time, and automate your entire document lifecycle — all without vendor lock-in.

+
+

Getting Started​

+

Every request must carry your API token in the x-api-token header.

+
x-api-token: <your-api-token>
+

→ How to generate your API token

+

Not sure where to begin? Use the sandbox environment (https://sandbox.opensignlabs.com/api/v1.2) to prototype without affecting live data.

+
+

Core Capabilities​

+
CategoryWhat you can do
DocumentsCreate, send, update, revoke, and delete signature-request documents
TemplatesBuild reusable templates with pre-placed widgets; send to one or many signers
Self-SignGenerate self-signed documents without a signer invitation flow
Public TemplatesShare a public signing link — no signer list required
Draft WorkflowSave documents or templates as drafts and finalise them later
ContactsManage your signer contact book programmatically
FoldersOrganise documents inside OpenSign Drive folders
WebhooksReceive real-time event notifications at your own endpoint
UsersRetrieve account and credit information
+
+

What’s New in v1.2​

+

Cleaner Template Retrieval​

+

GET /template/:id and GET /templatelist have been streamlined — redundant parameters are removed and prefill data is now returned separately from signer parameters, making responses easier to consume.

+

Password-Protected PDF Support​

+

Pass "file_password" in the request body when working with encrypted PDFs. Supported on: +POST /createtemplate · PUT /template/:id · POST /createdocument/:template_id · POST /draftdocument · POST /drafttemplate · POST /selfsign

+

Offline Signing Control​

+

Set "allow_offline_sign": true | false on POST /createtemplate and PUT /template/:id to explicitly enable or disable offline signing for each template.

+

Signer Roles​

+

The signers object now accepts a "signer_role" field across all creation routes. Three roles are supported:

+
RoleBehaviour
signer (default)Must complete at least one signature widget
viewerReceives the document for review only — no widgets allowed
approverCan have any widgets except a signature requirement
+

Carbon Copy (CC) Recipients​

+

A new "cc" field is now supported alongside the existing "bcc" field on document, template, draft and self-sign creation/update routes. Email addresses listed in "cc" receive a carbon-copy notification email once the document is completed. Like "bcc", on update routes (such as PUT /document/:id) providing "cc" overrides the template value, even when supplied as an empty array ([]); omit the field to inherit the template value.

+
+

Available Environments​

+
EnvironmentBase URL
Sandboxhttps://sandbox.opensignlabs.com/api/v1.2
Productionhttps://app.opensignlabs.com/api/v1.2
EU Regionhttps://eu-app.opensignlabs.com/api/v1.2
+
+

Versioning & Backwards Compatibility​

+

v1.2 is fully backwards-compatible with v1 and v1.1 — all endpoints from those versions are available on this base URL with no breaking changes. New parameters introduced in v1.2 are optional unless otherwise noted.

+
+ -

What’s New in v1.2

-
    -
  • Get Template & Get Template List: removed unnecessary parameters and separated prefill data from signer parameters.
    • -
  • "file_password" parameter added in create template, update template, create document with template, draft document and self sign routes to provide password for protected pdfs.
    • -
  • "allow_offline_sign" parameter added in create template and update template routes to allow users to enable or disable offline signing for their templates.
    • -
  • "signer_role" parameter added in the signers object of draft document, create document, create document with template, create template, and public template routes. Accepted values: signer (default), viewer, approver. Signers must have at least one signature widget; viewers must have no widgets; approvers may have any widgets without a signature requirement.
    • +
  • Full Documentation
    • +
  • GitHub Repository
    • +
  • Generate API Token
    • +
  • Terms of Service

Authentication​

Security Scheme Type:

apiKey

Header parameter name:

x-api-token

-

License

AGPL v3.0

+

License

AGPL v3.0

\ No newline at end of file diff --git a/docs/API-docs/v1.2/publictemplate/index.html b/docs/API-docs/v1.2/publictemplate/index.html index 3bb32a800..152f3ca93 100644 --- a/docs/API-docs/v1.2/publictemplate/index.html +++ b/docs/API-docs/v1.2/publictemplate/index.html @@ -5,7 +5,7 @@ Public Template | OpenSign™ - + diff --git a/docs/API-docs/v1.2/resendrequestmail/index.html b/docs/API-docs/v1.2/resendrequestmail/index.html index 78accdfb1..dc2c84ba6 100644 --- a/docs/API-docs/v1.2/resendrequestmail/index.html +++ b/docs/API-docs/v1.2/resendrequestmail/index.html @@ -5,7 +5,7 @@ Resend request mail | OpenSign™ - + diff --git a/docs/API-docs/v1.2/revokedocument/index.html b/docs/API-docs/v1.2/revokedocument/index.html index ce05cb938..239ad2e7b 100644 --- a/docs/API-docs/v1.2/revokedocument/index.html +++ b/docs/API-docs/v1.2/revokedocument/index.html @@ -5,7 +5,7 @@ Revoke Document | OpenSign™ - + diff --git a/docs/API-docs/v1.2/save-update-webhook/index.html b/docs/API-docs/v1.2/save-update-webhook/index.html index 2503d2c25..916396ffb 100644 --- a/docs/API-docs/v1.2/save-update-webhook/index.html +++ b/docs/API-docs/v1.2/save-update-webhook/index.html @@ -5,7 +5,7 @@ Save or Update Webhook | OpenSign™ - + diff --git a/docs/API-docs/v1.2/selfsign/index.html b/docs/API-docs/v1.2/selfsign/index.html index fac701cdb..33269e151 100644 --- a/docs/API-docs/v1.2/selfsign/index.html +++ b/docs/API-docs/v1.2/selfsign/index.html @@ -5,7 +5,7 @@ Self Sign | OpenSign™ - + diff --git a/docs/API-docs/v1.2/update-document/index.html b/docs/API-docs/v1.2/update-document/index.html index ada0b81d5..af2f9a8b5 100644 --- a/docs/API-docs/v1.2/update-document/index.html +++ b/docs/API-docs/v1.2/update-document/index.html @@ -5,7 +5,7 @@ Update Document | OpenSign™ - + diff --git a/docs/API-docs/v1.2/update-template/index.html b/docs/API-docs/v1.2/update-template/index.html index 9364e681d..1433fa909 100644 --- a/docs/API-docs/v1.2/update-template/index.html +++ b/docs/API-docs/v1.2/update-template/index.html @@ -5,7 +5,7 @@ Update Template | OpenSign™ - + diff --git a/docs/API-docs/v1.2/updatefolder/index.html b/docs/API-docs/v1.2/updatefolder/index.html index b1f07e21b..432321c1c 100644 --- a/docs/API-docs/v1.2/updatefolder/index.html +++ b/docs/API-docs/v1.2/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 b7fea5cc7..8f53bc1f2 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 35a2d5582..02b055941 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 cb901f94b..791149622 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 4e2b14e7b..25e630f27 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 b5359f9af..fddfd99a1 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 e900304bf..303065425 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 52abfa87f..4afcdfbc4 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 844c6c8ec..147c78d27 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 b75f0f5a6..5fe1abc4c 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 59c00f806..739d94652 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 b683b701b..ffef1a719 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 7feff8529..5e32f7a9d 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 61be62402..8d7a716fe 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 2b14b5d5a..9eb65476f 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 e441ac141..3be434b61 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 92cc21006..eba2bf072 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 56c410bd2..a538d90a8 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 29e14d143..1e2e0d564 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 c44b89405..bbd9b2785 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 c6eaf8780..b77472752 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 02872f867..ee3ea578b 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 1acb72571..2b0ddc31a 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 51d112196..0f37aea26 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 51c9de641..310ab7447 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 15629634d..bf70b8f36 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 1b813d7e7..b0b0c6f35 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 1c7f92b0d..0a92d09b6 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 683db1203..3d6c2c3dc 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 5da6b7329..92d9e8c2d 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 1070b8a93..09e5b7591 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 840ba2791..5be7f713c 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 f06c6d491..6065ab9a1 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 427bb9cad..8f39f243c 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/console/index.html b/docs/category/console/index.html index 54b38a96e..27cd3f655 100644 --- a/docs/category/console/index.html +++ b/docs/category/console/index.html @@ -5,7 +5,7 @@ Console | OpenSign™ - + diff --git a/docs/category/create-new-opensign-document/index.html b/docs/category/create-new-opensign-document/index.html index 8e8dd0fdf..faaf7297c 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 99f774323..98afcf525 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 4af78528f..d2106e80d 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 84023e958..2027da7f5 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 cfce18322..0c5401c4c 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 2728ca4ce..cca54e6e4 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 d32c91284..f411940b8 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 a579906be..75b510f1f 100644 --- a/docs/category/templates/index.html +++ b/docs/category/templates/index.html @@ -5,7 +5,7 @@ Templates | OpenSign™ - + diff --git a/docs/category/user-menu/index.html b/docs/category/user-menu/index.html index 799560cf8..b9e139ceb 100644 --- a/docs/category/user-menu/index.html +++ b/docs/category/user-menu/index.html @@ -5,7 +5,7 @@ User Menu | OpenSign™ - + diff --git a/docs/contribute/CODE_OF_CONDUCT/index.html b/docs/contribute/CODE_OF_CONDUCT/index.html index b8b4f67f5..f81b2545d 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 5804ddc3f..6e83db9ae 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 aab8364b5..23c6854f4 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 a60adfbd1..0bc2d4019 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 a488f112d..aff020310 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/Credit-Deductions/index.html b/docs/help/FAQs/Credit-Deductions/index.html index 3803516cb..d5213e60d 100644 --- a/docs/help/FAQs/Credit-Deductions/index.html +++ b/docs/help/FAQs/Credit-Deductions/index.html @@ -5,7 +5,7 @@ Credit-Deductions | 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 9cbc919ef..fecf65e13 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/Max File Upload Size/index.html b/docs/help/FAQs/Max File Upload Size/index.html index 9b00985fe..5ae52f428 100644 --- a/docs/help/FAQs/Max File Upload Size/index.html +++ b/docs/help/FAQs/Max File Upload Size/index.html @@ -5,7 +5,7 @@ Max File Upload Size | OpenSign™ - + diff --git a/docs/help/FAQs/User Deletion/index.html b/docs/help/FAQs/User Deletion/index.html index cc70aaf7a..ae695bfc6 100644 --- a/docs/help/FAQs/User Deletion/index.html +++ b/docs/help/FAQs/User Deletion/index.html @@ -5,7 +5,7 @@ User Deletion | OpenSign™ - + diff --git a/docs/help/FAQs/index.html b/docs/help/FAQs/index.html index 232407ec5..d6ec3418a 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 4441e94c2..bca09af9f 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 b686ac893..f4989072d 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/request-signatures/index.html b/docs/help/New-Document/request-signatures/index.html index 6939c9de7..a4e8d033d 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 f8dadc56c..23c50b506 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/New-Document/widgets/index.html b/docs/help/New-Document/widgets/index.html index e81cadfa5..9068df065 100644 --- a/docs/help/New-Document/widgets/index.html +++ b/docs/help/New-Document/widgets/index.html @@ -5,7 +5,7 @@ Widgets in OpenSign | OpenSign™ - + diff --git a/docs/help/OpenSign™ Drive/create-document/index.html b/docs/help/OpenSign™ Drive/create-document/index.html index 257e29374..ca045532d 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 298500576..2e1e00d31 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 0e3eeb619..1e520fbe3 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 4aecc538f..aeea734ef 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 3f0f3faf8..f3fee4f38 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 e2bfef7bf..2d32591e4 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 0fc1ac3fd..d8fb300c4 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 23a2704c8..4b7e994c0 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 ba639eac0..011bd63f6 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 5437d9151..016d6c5af 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 385c7a4bb..79bfbf277 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 892afc04b..b2203eb46 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 8e8806e79..39bf7f7a9 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 def2e2da3..f2ae3e960 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 0d39c0140..995bd7ed1 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 54cb8bba3..c7afdccfc 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 d9b0e80b3..fcfaff5d1 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 0226b3eea..a17f76005 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 6137d7f57..25e8a3219 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 40222191c..c75396476 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 a89b84942..e967b3254 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 69b485530..c8663cedc 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 e170bb60f..8fc1e64ba 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 ecda4b403..7eb10f804 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 ab9672486..92e1a9eaa 100644 --- a/docs/help/Templates/quick-send/index.html +++ b/docs/help/Templates/quick-send/index.html @@ -5,7 +5,7 @@ Bulk Document Send for Signature Using Template | OpenSign™ - + diff --git a/docs/help/Templates/use-template/index.html b/docs/help/Templates/use-template/index.html index e22d4a35b..8f3f61665 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/User Menu/Console/analystics/index.html b/docs/help/User Menu/Console/analystics/index.html index 0f45dea75..1ef732766 100644 --- a/docs/help/User Menu/Console/analystics/index.html +++ b/docs/help/User Menu/Console/analystics/index.html @@ -5,7 +5,7 @@ Analytics | OpenSign™ - + diff --git a/docs/help/User Menu/Console/branding/index.html b/docs/help/User Menu/Console/branding/index.html index 47dd17242..a5ff1d067 100644 --- a/docs/help/User Menu/Console/branding/index.html +++ b/docs/help/User Menu/Console/branding/index.html @@ -5,7 +5,7 @@ Branding | OpenSign™ - + diff --git a/docs/help/User Menu/Console/custom_filestorage/index.html b/docs/help/User Menu/Console/custom_filestorage/index.html index 513b729b0..172539e2e 100644 --- a/docs/help/User Menu/Console/custom_filestorage/index.html +++ b/docs/help/User Menu/Console/custom_filestorage/index.html @@ -5,7 +5,7 @@ Custom File Storage | OpenSign™ - + diff --git a/docs/help/User Menu/Console/emails/index.html b/docs/help/User Menu/Console/emails/index.html index 812c986f5..940edfa62 100644 --- a/docs/help/User Menu/Console/emails/index.html +++ b/docs/help/User Menu/Console/emails/index.html @@ -5,7 +5,7 @@ Mail | OpenSign™ - + diff --git a/docs/help/User Menu/Console/general/index.html b/docs/help/User Menu/Console/general/index.html index 542445224..101ecb16f 100644 --- a/docs/help/User Menu/Console/general/index.html +++ b/docs/help/User Menu/Console/general/index.html @@ -5,7 +5,7 @@ General | OpenSign™ - + diff --git a/docs/help/User Menu/Console/globalSMTP/index.html b/docs/help/User Menu/Console/globalSMTP/index.html index 577376cc5..33966053f 100644 --- a/docs/help/User Menu/Console/globalSMTP/index.html +++ b/docs/help/User Menu/Console/globalSMTP/index.html @@ -5,7 +5,7 @@ Global SMTP | OpenSign™ - + diff --git a/docs/help/User Menu/Console/orgadmin/index.html b/docs/help/User Menu/Console/orgadmin/index.html index ac22b43f6..55416bd39 100644 --- a/docs/help/User Menu/Console/orgadmin/index.html +++ b/docs/help/User Menu/Console/orgadmin/index.html @@ -5,7 +5,7 @@ Org Admins | OpenSign™ - + diff --git a/docs/help/User Menu/Console/organizations/index.html b/docs/help/User Menu/Console/organizations/index.html index cba23d6d7..70dfa9dbb 100644 --- a/docs/help/User Menu/Console/organizations/index.html +++ b/docs/help/User Menu/Console/organizations/index.html @@ -5,7 +5,7 @@ Organizations | OpenSign™ - + diff --git a/docs/help/User Menu/Console/signing_certificate/index.html b/docs/help/User Menu/Console/signing_certificate/index.html index e162c8052..9f74e896e 100644 --- a/docs/help/User Menu/Console/signing_certificate/index.html +++ b/docs/help/User Menu/Console/signing_certificate/index.html @@ -5,7 +5,7 @@ Custom Signing Certificate | OpenSign™ - + diff --git a/docs/help/User Menu/Profile/index.html b/docs/help/User Menu/Profile/index.html index 0ca3fd20f..a14b8fc88 100644 --- a/docs/help/User Menu/Profile/index.html +++ b/docs/help/User Menu/Profile/index.html @@ -5,7 +5,7 @@ Profile | OpenSign™ - + diff --git a/docs/help/intro/index.html b/docs/help/intro/index.html index 38b0ea92b..d701f1a39 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 9859c8fe3..51017446c 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 a338f10d7..ff91929e7 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 67898e3b3..70173555e 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 17e029338..dac082064 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 643ae3d1e..dd6bd4cdf 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 3de6f9b59..d35cd0b2f 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 956497f0d..dc376c1b3 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 d39cb40dd..e762b801e 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 d00a942e4..86d711e0c 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 caa51ef3b..fa9c300e7 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 4105dcaeb..7dd737faa 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 61a126a4d..74a319bf5 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -5,7 +5,7 @@ Markdown page example | OpenSign™ - +