WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-08-21 15:12:34 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
f6245cfada5d67697fa7a2ea9aa9c93058707d04
OpenSign/docs/docs/API-docs/opensign.yaml
T

2066 lines
78 KiB
YAML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
---
openapi: 3.0.3
info:
title: OpenSign API v1
description: "Welcome to the OpenSign™ API documentation! Our powerful and flexible API allows you to seamlessly integrate digital signing capabilities into your applications. Whether you're a developer looking to automate document workflows, a business seeking to enhance security, or an enterprise aiming for efficient contract management, our API provides robust solutions to meet your needs. Dive into our detailed guides, code examples, and best practices to start leveraging the full potential of OpenSign™ and transform your digital document processes today. \n\nSome useful links:\n- [OpenSign Website](https://www.opensignlabs.com)\n- [OpenSign Github repo](https://github.com/opensignlabs/opensign)"
termsOfService: http://www.opensignlabs.com/terms/
contact:
email: api@opensignlabs.com
license:
name: AGPL v 3.0
url: http://github.com/opensignlabs/opensign/LICENSE
version: 1.0.0
externalDocs:
description: Find out more about OpenSign
url: http://docs.opensignlabs.com
servers:
- url: https://sandbox.opensignlabs.com/api/v1
- url: https://app.opensignlabs.com/api/v1
- url: https://staging-app.opensignlabs.com/api/v1
tags:
- name: OpenSign
description: OpenSource DocuSign alternative
externalDocs:
description: Find out more
url: http://www.opensignlabs.com
- name: Github repo
description: Access the source code
externalDocs:
description: Visit github
url: http://github.com/opensignlabs/opensign
- name: User
description: Access detailed user information with the OpenSign™ API. Retrieve and manage user details effortlessly to enhance your application’s functionality and user experience.
- name: Contacts
description: Utilize the OpenSign™ API to efficiently manage contacts in your OpenSign contact book. Seamlessly add, update, and organize your contacts for a streamlined digital signing experience.
- name: Documents
description: Streamline your document management with the OpenSign™ API. Easily upload, delete and organize your documents for efficient digital signing and seamless workflow integration.
- name: Templates
description: Optimize your document creation process with the OpenSign™ API for managing reusable templates. Create, update, and organize templates effortlessly to ensure consistency and efficiency in your digital signing workflows.
- name: Webhook
description: Enhance your application’s responsiveness with the OpenSign™ API for managing webhooks. Easily set up, update, and manage webhooks to receive real-time notifications and automate your digital signing processes.
- name: Folder
description: Organize your documents efficiently with the OpenSign™ API for managing folders in OpenSign Drive. Create, update and manage folders seamlessly to keep your digital signing files structured and easily accessible.
paths:
/getuser:
get:
tags:
- User
summary: Get your account details
description: The Get User API enables you to get your own account details.
operationId: getUser
responses:
"200":
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/user'
"404":
description: User not found!
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_404'
"405":
description: Invalid API Token!
content:
application/json:
schema:
$ref: '#/components/schemas/invalidtoken'
security:
- x-api-token: []
/createcontact:
post:
tags:
- Contacts
summary: Create Contact
description: The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.
operationId: createcontact
requestBody:
description: Provide below parameter to create contact
content:
application/json:
schema:
$ref: '#/components/schemas/createcontact_body'
required: true
responses:
"200":
description: Contact created successfully!
content:
application/json:
schema:
$ref: '#/components/schemas/contact'
"401":
description: Contact already exists!
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_401_1'
"400":
description: "Something went wrong, please try again later!"
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_400_1'
"405":
description: Invalid API Token!
content:
application/json:
schema:
$ref: '#/components/schemas/invalidtoken'
security:
- x-api-token: []
/contact/{contact_id}:
get:
tags:
- Contacts
summary: Get Contact
description: The Get Contact API allows you to retrieve details about a specific contact.
operationId: getcontact
parameters:
- name: contact_id
in: path
description: objectId of contact
required: true
style: simple
explode: false
schema:
type: string
format: string
example: pH1bhc2hpb
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/contact'
"400":
description: "Something went wrong, please try again later!"
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_400_1'
"404":
description: Contact not found!
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_404_2'
"405":
description: Invalid API Token!
content:
application/json:
schema:
$ref: '#/components/schemas/invalidtoken'
security:
- x-api-token: []
delete:
tags:
- Contacts
summary: 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."
operationId: deletecontact
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
responses:
"200":
description: Contact deleted successfully!
content:
application/json:
schema:
$ref: '#/components/schemas/delete'
"400":
description: "Something went wrong, please try again later!"
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_400_1'
"404":
description: Contact not found!
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_404_2'
"405":
description: Invalid API Token!
content:
application/json:
schema:
$ref: '#/components/schemas/invalidtoken'
security:
- x-api-token: []
/contactlist:
get:
tags:
- Contacts
summary: 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."
operationId: contactlist
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
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_200'
"400":
description: "Something went wrong, please try again later!"
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_400_1'
"405":
description: Invalid API Token!
content:
application/json:
schema:
$ref: '#/components/schemas/invalidtoken'
security:
- x-api-token: []
/createdocument:
post:
tags:
- Documents
summary: Create Document
description: "The Create Document API allows users to generate new documents by providing data with base64 encoded file.\n\nUpload you pdf in our [**Debug UI**](https://app.opensignlabs.com/debugpdf) here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF\n\n**Below widgets are supported in the document:**\n\nCommon parameters of widgets:\n- **type:** Indicates the type of widget.\n- **page:** Specifies the page number on which you want to place the respective widget.\n- **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- **w, h:** Represents the width and height of the widget. You can adjust these values using the debug UI.\n- **required:** Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets.\n- **name:** Provides a different name for widgets if you are providing more than one widget.\n1. **signature:**\n```\n{\n \"type\":\"signature\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21\n}\n```\n- **Note:** At least one signature is required for each signer. All signature fields are compulsory by default.\n2. **stamp:**\n```\n{\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```\n3. **initials:**\n```\n{\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```\n4. **email:**\n```\n{\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 }\n}\n```\n5. **name:**\n```\n{\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 }\n}\n```\n6. **job title:**\n```\n{\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 }\n}\n```\n7. **company:**\n```\n{\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 }\n}\n```\n8. **date:**\n```\n{\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 }\n}\n ```\n- **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- **format:** Specify the date format of your choice from the options below.\n - \"dd/MM/yyyy\",\n - \"dd-mm-yyyy\", \n - \"yyyy-mm-dd\", \n - \"mm.dd.yyyy\", \n - \"mm-dd-yyyy\", \n - \"mmm dd, yyyy\", \n - \"mmmm dd, yyyy\", \n - \"dd mmm, yyyy\", \n - \"dd mmmm, yyy\"\n\n9. **textbox:**\n```\n{\n \"type\":\"textbox\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"textbox\",\n \"default\": \"name\",\n \"hint\": \"provide name\",\n \"regularexpression\":\"\"\n }\n}\n```\n- **default:** Provide a default value for the textbox (Optional).\n- **hint:** Provide a hint for the textbox (Optional).\n- **regularexpression:** Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional).\n\n10. **checkbox:**\n```\n{\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 \"validation\": {\n \"minselections\": 0, \n \"maxselections\": 0 \n }\n }\n}\n```\n- **values:** Provide options for the checkbox list.\n- **selectedvalues:** Provide values that need to be selected by default (Optional).\n- **readonly:** Set to true if you want to set the checkbox as readonly. By default, it's false\n- **hidelabel:** Set to true if you want to hide labels of the checkbox. By default, it's false.\n- **minselections:** Provide the minimum number of checkboxes that must be selected by the user.\n- **maxselections:** Provide the maximum number of checkboxes that can be selected by the user.\n\n11. **dropdown:**\n ```\n{\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 \"values\": [\"male\", \"female\", \"other\"],\n \"default\": \"male\"\n }\n }\n}\n```\n- **values:** Provide options for the dropdown list.\n- **default:** Provide the value that needs to be selected by default. Only one value is accepted. (Optional).\n12. **radio button:**\n```\n{\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 \"values\": [\"male\", \"female\", \"other\"],\n \"default\": \"male\"\n }\n }\n}\n``` \n- **values:** Provide options for the radio button list.\n- **default:** Provide the value that needs to be selected by default. Only one value is accepted. (Optional).\n13. **image:**\n```\n{\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```\n"
operationId: createdocument
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/createdocument_body'
required: true
responses:
"200":
description: Document created successfully!
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_200_1'
"400":
description: "Something went wrong, please try again later!"
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_400_1'
"405":
description: Invalid API Token!
content:
application/json:
schema:
$ref: '#/components/schemas/invalidtoken'
security:
- x-api-token: []
/createdocument/{template_id}:
post:
tags:
- Documents
summary: Create Document from Template
description: |
The Create Document API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.
operationId: createdocumentwithtemplateid
parameters:
- name: template_id
in: path
description: objectId of Template
required: true
style: simple
explode: false
schema:
type: string
format: string
example: pH1bhc2hpb
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/createdocument_template_id_body'
required: true
responses:
"200":
description: "In success response you will get url in response if you are also signer in document otherwise only get objectId, messsage"
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_200_2'
"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:
$ref: '#/components/schemas/inline_response_400_cc'
"405":
description: Invalid API Token!
content:
application/json:
schema:
$ref: '#/components/schemas/invalidtoken'
security:
- x-api-token: []
/document/{document_id}:
get:
tags:
- Documents
summary: Get Document
description: The Get Document API enables you to retrieve details about a specific document.
operationId: getdocument
parameters:
- name: document_id
in: path
description: objectId of Document
required: true
style: simple
explode: false
schema:
type: string
format: string
example: pH1bhc2hpb
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/document'
"400":
description: "Something went wrong, please try again later!"
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_400_1'
"404":
description: Document not found!
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_404_3'
"405":
description: Invalid API Token!
content:
application/json:
schema:
$ref: '#/components/schemas/invalidtoken'
security:
- x-api-token: []
put:
tags:
- Documents
summary: 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."
operationId: updateDocument
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
requestBody:
description: Provide below parameter to update templates (at least one parameter required)
content:
application/json:
schema:
$ref: '#/components/schemas/document_document_id_body'
responses:
"200":
description: Document updated successfully!
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_200_3'
"400":
description: Please provide valid field names!
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_400'
"404":
description: Document not found!
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_404_4'
"405":
description: Invalid API Token!
content:
application/json:
schema:
$ref: '#/components/schemas/invalidtoken'
security:
- x-api-token: []
delete:
tags:
- Documents
summary: Delete Document
description: The Delete document API allows you to remove specific document from your documents.
operationId: deletedocument
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
responses:
"200":
description: Document deleted successfully!
content:
application/json:
schema:
$ref: '#/components/schemas/delete'
"400":
description: "Something went wrong, please try again later!"
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_400_1'
"404":
description: Document not found!
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_404_3'
"405":
description: Invalid API Token!
content:
application/json:
schema:
$ref: '#/components/schemas/invalidtoken'
security:
- x-api-token: []
/documentlist/{doctype}:
get:
tags:
- Documents
summary: Get Document list from status
description: |
### Document Types:
Retrieve a list of documents based on type
1. **Draft Documents:**
- Documents that are currently in draft status.
2. **In-Progress Documents:**
- Documents that are currently in progress.
3. **Completed Documents:**
- Documents that have been successfully completed with all required signatures.
4. **Expired Documents:**
- Documents that have expired and are no longer accessible.
5. **Declined Documents:**
- Documents that have been declined by the user.
operationId: getdocumentlist
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
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_200_4'
"404":
description: Report not available!
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_404_5'
"405":
description: Invalid API Token!
content:
application/json:
schema:
$ref: '#/components/schemas/invalidtoken'
security:
- x-api-token: []
/resendmail:
post:
tags:
- Documents
summary: Resend request mail
description: |
Resend request mail to user for signing document.
operationId: Resendrequestmail
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/resendmail_body'
required: true
responses:
"200":
description: ""
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_200_10'
"400":
description: ""
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_400_2'
"404":
description: |
- document not found if document id is not correct.
- user not found if provided user email is not present in signer list of document
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_404_1'
"405":
description: Invalid API Token!
content:
application/json:
schema:
$ref: '#/components/schemas/invalidtoken'
security:
- x-api-token: []
/createtemplate:
post:
tags:
- Templates
summary: 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.\n\nUpload you pdf in our [**Debug UI**](https://app.opensignlabs.com/debugpdf) here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF.\n\n**Below widgets are supported in the document:**\n\nCommon parameters of widgets:\n\n- **type:** Indicates the type of widget.\n- **page:** Specifies the page number on which you want to place the respective widget.\n- **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- **w, h:** Represents the width and height of the widget. You can adjust these values using the debug UI.\n- **required:** Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets.\n- **name:** Provides a different name for widgets if you are providing more than one widget.\n1. **signature:**\n```\n{\n \"type\":\"signature\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21\n}\n```\n2. **stamp:**\n```\n{\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```\n3. **initials:**\n```\n{\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```\n4. **email:**\n```\n{\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 }\n}\n```\n5. **name:**\n```\n{\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 }\n}\n```\n6. **job title:**\n```\n{\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 }\n}\n```\n7. **company:**\n```\n{\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 }\n}\n```\n8. **date:**\n```\n{\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 }\n}\n ```\n- **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- **format:** Specify the date format of your choice from the options below.\n - \"dd/MM/yyyy\",\n - \"dd-mm-yyyy\", \n - \"yyyy-mm-dd\", \n - \"mm.dd.yyyy\", \n - \"mm-dd-yyyy\", \n - \"mmm dd, yyyy\", \n - \"mmmm dd, yyyy\", \n - \"dd mmm, yyyy\", \n - \"dd mmmm, yyy\"\n\n9. **textbox:**\n```\n{\n \"type\":\"textbox\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"textbox\",\n \"default\": \"name\",\n \"hint\": \"provide name\",\n \"regularexpression\":\"\"\n }\n}\n```\n- **default:** Provide a default value for the textbox (Optional).\n- **hint:** Provide a hint for the textbox (Optional).\n- **regularexpression:** Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional).\n\n10. **checkbox:**\n```\n{\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 \"validation\": {\n \"minselections\": 0, \n \"maxselections\": 0 \n }\n }\n}\n```\n- **values:** Provide options for the checkbox list.\n- **selectedvalues:** Provide values that need to be selected by default (Optional).\n- **readonly:** Set to true if you want to set the checkbox as readonly. By default, it's false\n- **hidelabel:** Set to true if you want to hide labels of the checkbox. By default, it's false.\n- **minselections:** Provide the minimum number of checkboxes that must be selected by the user.\n- **maxselections:** Provide the maximum number of checkboxes that can be selected by the user.\n\n11. **dropdown:**\n ```\n{\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 \"values\": [\"male\", \"female\", \"other\"],\n \"default\": \"male\"\n }\n }\n}\n```\n- **values:** Provide options for the dropdown list.\n- **default:** Provide the value that needs to be selected by default. Only one value is accepted. (Optional).\n12. **radio button:**\n```\n{\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 \"values\": [\"male\", \"female\", \"other\"],\n \"default\": \"male\"\n }\n }\n}\n``` \n- **values:** Provide options for the radio button list.\n- **default:** Provide the value that needs to be selected by default. Only one value is accepted. (Optional).\n\n13. **image:**\n```\n{\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``` \n"
operationId: createtemplate
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/createtemplate_body'
required: true
responses:
"200":
description: Template created successfully!
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_200_5'
"400":
description: "Something went wrong, please try again later!"
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_400_1'
"405":
description: Invalid API Token!
content:
application/json:
schema:
$ref: '#/components/schemas/invalidtoken'
security:
- x-api-token: []
/template/{template_id}:
get:
tags:
- Templates
summary: 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.
operationId: getTemplate
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
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/template'
"400":
description: "Something went wrong, please try again later!"
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_400_1'
"404":
description: Template not found!
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_404_6'
"405":
description: Invalid API Token!
content:
application/json:
schema:
$ref: '#/components/schemas/invalidtoken'
security:
- x-api-token: []
put:
tags:
- Templates
summary: Update Template
description: The Update Template API enables you to modify and update the details of a specific template.
operationId: updateTemplate
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
requestBody:
description: Provide below parameter to update templates (at least one parameter required)
content:
application/json:
schema:
$ref: '#/components/schemas/template_template_id_body'
responses:
"200":
description: Template updated successfully!
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_200_3'
"400":
description: Please provide valid field names!
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_400'
"404":
description: Template not found!
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_404_7'
"405":
description: Invalid API Token!
content:
application/json:
schema:
$ref: '#/components/schemas/invalidtoken'
security:
- x-api-token: []
delete:
tags:
- Templates
summary: 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
operationId: deleteTemplate
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
responses:
"200":
description: Template deleted successfully!
content:
application/json:
schema:
$ref: '#/components/schemas/delete'
"400":
description: "Something went wrong, please try again later!"
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_400_1'
"404":
description: Template not found!
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_404_6'
"405":
description: Invalid API Token!
content:
application/json:
schema:
$ref: '#/components/schemas/invalidtoken'
security:
- x-api-token: []
/templatelist:
get:
tags:
- Templates
summary: 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."
operationId: gettemplatelist
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
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_200_6'
"405":
description: Invalid API Token!
content:
application/json:
schema:
$ref: '#/components/schemas/invalidtoken'
security:
- x-api-token: []
/webhook:
get:
tags:
- Webhook
summary: Get Webhook
description: The Get Webhook API allow you to get webhook url
operationId: getWebhook
responses:
"200":
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_200_7'
"404":
description: User not found!
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_404'
"405":
description: Invalid API Token!
content:
application/json:
schema:
$ref: '#/components/schemas/invalidtoken'
security:
- x-api-token: []
post:
tags:
- Webhook
summary: Save or Update Webhook
description: "The save or update Webhook API allow you to save webhook url which is used to trigger events\n### events:\n\n1. **viewed:**\n - When signer viewed document this event will trigger.\n ```\n {\n \"event\": \"viewed\",\n \"objectId\":\"DOCUMENT_ID\"\n \"file\": \"DOCUMENT_URL\",\n \"name\": \"DOCUMENT_NAME\",\n \"note\": \"Please review and sign this document\",\n \"description\": \"\",\n \"signers\": [\n {\n \"name\": \"SIGNER_NAME\",\n \"email\": \"SIGNER_EMAIL\",\n \"phone\": \"SIGNER_PHONE\"\n }\n ],\n \"viewedBy\": \"SIGNER_EMAIL\",\n \"viewedAt\": \"TIMESTAMP\",\n \"createdAt\": \"TIMESTAMP\"\n }\n2. **created:**\n - When document is created this event will trigger.\n ```\n {\n \"event\": \"created\",\n \"objectId\":\"DOCUMENT_ID\"\n \"file\": \"DOCUMENT_URL\",\n \"name\": \"DOCUMENT_NAME\",\n \"note\": \"Please review and sign this document\",\n \"description\": \"\",\n \"signers\": [\n {\n \"name\": \"SIGNER_NAME\",\n \"email\": \"SIGNER_EMAIL\",\n \"phone\": \"SIGNER_PHONE\"\n }\n ],\n \"createdAt\": \"TIMESTAMP\"\n }\n \n3. **signed:**\n - When document is signed by signer this event will trigger.\n ```\n {\n \"event\": \"signed\",\n \"objectId\":\"DOCUMENT_ID\"\n \"file\": \"DOCUMENT_URL\",\n \"name\": \"DOCUMENT_NAME\",\n \"note\": \"Please review and sign this document\",\n \"description\": \"\",\n \"signers\": [\n {\n \"name\": \"SIGNER_NAME\",\n \"email\": \"SIGNER_EMAIL\",\n \"phone\": \"SIGNER_PHONE\"\n },\n ]\n \"signedAt\": \"TIMESTAMP\",\n \"createdAt\": \"TIMESTAMP\"\n } \n4. **completed:**\n - When document is signed by all signers this event will trigger.\n ```\n {\n \"event\": \"completed\",\n \"objectId\":\"DOCUMENT_ID\"\n \"file\": \"DOCUMENT_URL\",\n \"name\": \"DOCUMENT_NAME\",\n \"note\": \"Please review and sign this document\",\n \"description\": \"\",\n \"signers\": [\n {\n \"name\": \"SIGNER_NAME\",\n \"email\": \"SIGNER_EMAIL\",\n \"phone\": \"SIGNER_PHONE\"\n }\n ],\n \"completedAt\": \"TIMESTAMP\",\n \"createdAt\": \"TIMESTAMP\"\n }\n \n5. **declined:**\n - When document is declined by signer this event will trigger.\n ```\n {\n \"event\": \"declined\",\n \"objectId\":\"DOCUMENT_ID\"\n \"file\": \"DOCUMENT_URL\",\n \"name\": \"DOCUMENT_NAME\",\n \"note\": \"Please review and sign this document\",\n \"description\": \"\",\n \"signers\": [\n {\n \"name\": \"SIGNER_NAME\",\n \"email\": \"SIGNER_EMAIL\",\n \"phone\": \"SIGNER_PHONE\"\n }\n ],\n \"declinedBy\": \"SIGNER_EMAIL\",\n \"declinedAt\": \"TIMESTAMP\",\n \"createdAt\": \"TIMESTAMP\"\n }\n"
operationId: save&updateWebhook
requestBody:
description: Provide url to create Webhook
content:
application/json:
schema:
$ref: '#/components/schemas/webhook_body'
responses:
"200":
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_200_8'
"400":
description: "Something went wrong, please try again later!"
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_400_1'
"401":
description: Webhook url already exists!
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_401_w'
"404":
description: User not found!
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_404'
"405":
description: Invalid API Token!
content:
application/json:
schema:
$ref: '#/components/schemas/invalidtoken'
security:
- x-api-token: []
delete:
tags:
- Webhook
summary: Delete Webhook
description: The Delete Webhook API allow you to delete webhook url
operationId: deleteWebhook
responses:
"200":
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_200_9'
"404":
description: User not found!
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_404'
"405":
description: Invalid API Token!
content:
application/json:
schema:
$ref: '#/components/schemas/invalidtoken'
security:
- x-api-token: []
/createfolder:
post:
tags:
- Folder
summary: Create Folder
description: The Create Folder API allows you to create folder.
operationId: createfolder
requestBody:
description: Provide below parameter to create folder
content:
application/json:
schema:
$ref: '#/components/schemas/folder_body'
required: true
responses:
"200":
description: folder created successfully!
content:
application/json:
schema:
$ref: '#/components/schemas/folder'
"400":
description: "Something went wrong, please try again later!"
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_400_1'
"405":
description: Invalid API Token!
content:
application/json:
schema:
$ref: '#/components/schemas/invalidtoken'
security:
- x-api-token: []
/folder/{folder_id}:
get:
tags:
- Folder
summary: Get Folder
description: The Get Folder API allows you to retrieve details about a specific folder.
operationId: getfolder
parameters:
- name: folder_id
in: path
description: objectId of folder
required: true
style: simple
explode: false
schema:
type: string
format: string
example: pH1bhc2hpb
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/folder_res'
"400":
description: "Something went wrong, please try again later!"
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_400_1'
"404":
description: folder not found.
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_404_8'
"405":
description: Invalid API Token!
content:
application/json:
schema:
$ref: '#/components/schemas/invalidtoken'
security:
- x-api-token: []
put:
tags:
- Folder
summary: Update Folder
description: The Update Folder API allows you to uodate folder name as well as parentFolderId.
operationId: updatefolder
parameters:
- name: folder_id
in: path
description: objectId of folder
required: true
style: simple
explode: false
schema:
type: string
format: string
example: bK1cfd2hpb
requestBody:
description: Provide below parameter to create folder
content:
application/json:
schema:
$ref: '#/components/schemas/folder_body'
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_200_11'
"400":
description: "Something went wrong, please try again later!"
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_400_1'
"404":
description: folder not found.
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_404_8'
"405":
description: Invalid API token!
content:
application/json:
schema:
$ref: '#/components/schemas/invalidtoken'
security:
- x-api-token: []
delete:
tags:
- Folder
summary: Delete Folder
description: The delete Folder API allows you to delete folder.
operationId: deletefolder
parameters:
- name: folder_id
in: path
description: objectId of folder
required: true
style: simple
explode: false
schema:
type: string
format: string
example: bK1cfd2hpb
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_200_12'
"400":
description: |
- folder is not empty, contains document or folder.
- Something went wrong, please try again later!
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_400_3'
"404":
description: folder not found.
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_404_8'
"405":
description: Invalid API token!
content:
application/json:
schema:
$ref: '#/components/schemas/invalidtoken'
security:
- x-api-token: []
/folderlist:
get:
tags:
- Folder
summary: Get folder list
description: The Folder List API empowers you to retrieve a list of folder with or without parentFolderId
operationId: folderlist
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
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_200_13'
"400":
description: "Something went wrong, please try again later!"
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_400_1'
"405":
description: Invalid API Token!
content:
application/json:
schema:
$ref: '#/components/schemas/invalidtoken'
security:
- x-api-token: []
components:
schemas:
date:
type: string
example: 2023-10-07T16:49:56.000Z
xml:
name: date
template:
type: object
properties:
objectId:
type: string
format: string
example: x1Hbnms2Pg
title:
type: string
example: sample template
note:
type: string
example: template note
folder:
$ref: '#/components/schemas/template_folder'
file:
type: string
example: https://templateuser.com
owner:
type: string
example: template creator name
signers:
type: array
items:
$ref: '#/components/schemas/template_Signers'
sendInOrder:
type: boolean
example: true
createdAt:
$ref: '#/components/schemas/date'
updatedAt:
$ref: '#/components/schemas/date'
xml:
name: template
contact:
type: object
properties:
objectId:
type: string
format: string
example: ph1bhx2jp
name:
type: string
format: string
example: joe bee
email:
type: string
format: string
example: joebee@example.com
phone:
type: string
format: string
example: "4131231231"
createdAt:
$ref: '#/components/schemas/date'
updatedAt:
$ref: '#/components/schemas/date'
xml:
name: contactdetails
folder:
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:
$ref: '#/components/schemas/date'
updatedAt:
$ref: '#/components/schemas/date'
xml:
name: folderdetails
folder_res:
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:
$ref: '#/components/schemas/date'
updatedAt:
$ref: '#/components/schemas/date'
user:
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:
$ref: '#/components/schemas/date'
updatedAt:
$ref: '#/components/schemas/date'
xml:
name: user
document:
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:
$ref: '#/components/schemas/document_folder'
owner:
type: string
format: string
example: joe bee
signers:
type: array
items:
$ref: '#/components/schemas/template_Signers'
sendInOrder:
type: boolean
example: true
createdAt:
$ref: '#/components/schemas/date'
updatedAt:
$ref: '#/components/schemas/date'
xml:
name: document
invalidtoken:
type: object
properties:
error:
type: string
example: Invalid API token!
xml:
name: invalidtoken
delete:
type: object
properties:
objectId:
type: string
example: Bxh2aspHp3
deletedAt:
$ref: '#/components/schemas/date'
xml:
name: delete
inline_response_404:
type: object
properties:
error:
type: string
example: User not found!
createcontact_body:
required:
- email
- name
- phone
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"
folder_body:
required:
- foldername
type: object
properties:
folderName:
type: string
format: string
example: new folder
parentFolderId:
type: string
format: string
example: ""
inline_response_401_1:
type: object
properties:
error:
type: string
example: Contact already exists!
inline_response_400_1:
type: object
properties:
error:
type: string
example: "Something went wrong, please try again later!"
inline_response_401_w:
type: object
properties:
error:
type: string
example: Webhook url already exists!
inline_response_404_2:
type: object
properties:
error:
type: string
example: Contact not found!
inline_response_200:
type: object
properties:
result:
type: array
items:
$ref: '#/components/schemas/contact'
draftdocument_body:
required:
- file
- signers
- title
type: object
properties:
file:
type: string
format: base64
example: base64 encoded pdf
title:
type: string
format: string
example: sample document
description:
type: string
format: string
example: sample Description
note:
type: string
format: string
example: sample Note
signers:
type: array
items:
$ref: '#/components/schemas/draftdocument_body_signers'
sendInOrder:
type: boolean
example: true
enableOTP:
type: boolean
example: false
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."
enableTour:
type: boolean
example: false
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."
createdocument_body:
required:
- file
- signers
- title
type: object
properties:
file:
type: string
format: base64
example: base64 encoded pdf
title:
type: string
format: string
example: sample document
description:
type: string
format: string
example: sample Description
note:
type: string
format: string
example: sample Note
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:
$ref: '#/components/schemas/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}}."
example: ""
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}}."
example: ""
sendInOrder:
type: boolean
example: true
enableOTP:
type: boolean
example: false
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."
enableTour:
type: boolean
example: false
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."
type: object
properties:
objectId:
type: string
format: string
example: hji2zxcv2P
url:
type: string
format: string
example: https://url-to-edit-document
inline_response_200_1:
type: object
properties:
objectId:
type: string
format: string
example: hji2zxcv2P
url:
type: string
format: string
example: https://url-to-sign-document.com
createdocumenttemplate_id_Signers:
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"
createdocument_template_id_body:
required:
- signers
type: object
properties:
signers:
type: array
items:
$ref: '#/components/schemas/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.
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}}."
example: ""
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}}."
example: ""
sendInOrder:
type: boolean
example: true
timeToCompleteDays:
type: number
description: time to complete days is used to calculate expiry date of your document
format: number
example: 15
enableOTP:
type: boolean
example: false
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."
enableTour:
type: boolean
example: false
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."
resendmail_body:
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.
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}}."
example: ""
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}}."
example: ""
inline_response_200_2:
type: object
properties:
objectId:
type: string
format: string
example: hji2zxcv2P
url:
type: string
format: string
example: https://example.com
message:
type: string
format: string
example: Document sent successfully!
inline_response_404_3:
type: object
properties:
error:
type: string
example: Document not found!
document_document_id_body:
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
example: false
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."
enableTour:
type: boolean
example: false
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."
inline_response_200_3:
type: object
properties:
objectId:
type: string
example: asd2HsP4Hp
updatedAt:
$ref: '#/components/schemas/date'
inline_response_400:
type: object
properties:
error:
type: string
format: string
example: Please provide valid field names!
inline_response_404_4:
type: object
properties:
error:
type: string
format: string
example: Document not found!
inline_response_200_4:
type: object
properties:
result:
type: array
items:
$ref: '#/components/schemas/document'
inline_response_404_5:
type: object
properties:
error:
type: string
example: Report not available!
createtemplate_body:
required:
- file
- signers
- title
type: object
properties:
file:
type: string
format: base64
example: base64 encoded file
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:
$ref: '#/components/schemas/createtemplate_body_signers'
sendInOrder:
type: boolean
example: true
enableOTP:
type: boolean
example: false
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."
enableTour:
type: boolean
example: false
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."
inline_response_200_5:
type: object
properties:
objectId:
type: string
example: Bh2Hspnmch
message:
type: string
example: Template created successfully!
inline_response_404_6:
type: object
properties:
error:
type: string
example: Template not found!
template_template_id_body:
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
example: false
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."
enableTour:
type: boolean
example: false
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."
inline_response_404_7:
type: object
properties:
error:
type: string
format: string
example: Template not found!
inline_response_200_6:
type: object
properties:
result:
type: array
items:
$ref: '#/components/schemas/template'
inline_response_200_7:
type: object
properties:
webhook:
type: string
example: https://your-webhook-url@example.com
webhook_body:
required:
- Url
type: object
properties:
url:
type: string
format: string
example: https://your-webhook-url@example.com
inline_response_200_8:
type: object
properties:
result:
type: string
example: Webhook updated successfully!
inline_response_200_9:
type: object
properties:
result:
type: string
example: Webhook deleted successfully!
template_Signers:
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:
$ref: '#/components/schemas/template_Signers_widgets'
inline_response_400_cc:
type: object
properties:
error:
type: string
format: string
example: Please setup template properly!
draftdocument_body_signers:
type: object
properties:
email:
type: string
format: string
example: joebee@example.com
name:
type: string
format: string
example: joe bee
phone:
type: string
format: string
example: "123121312"
createdocument_body_widgets:
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
createdocument_body_signers:
type: object
properties:
role:
type: string
format: string
example: ceo
email:
type: string
format: string
example: joebee@example.com
name:
type: string
format: string
example: joe bee
phone:
type: string
format: string
example: "123121312"
widgets:
type: array
items:
$ref: '#/components/schemas/createdocument_body_widgets'
createtemplate_body_widgets:
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
createtemplate_body_signers:
type: object
properties:
role:
type: string
format: string
example: ceo
email:
type: string
format: string
example: ""
name:
type: string
format: string
example: ""
phone:
type: string
format: string
example: ""
widgets:
type: array
items:
$ref: '#/components/schemas/createtemplate_body_widgets'
template_folder:
type: object
properties:
objectId:
type: string
format: string
example: x1Hbnms2Pg
name:
type: string
example: folder name
document_folder:
type: object
properties:
objectId:
type: string
format: string
example: FGik23bhUJ
name:
type: string
format: string
example: folder name
template_Signers_widgets:
type: object
properties:
type:
type: string
description: "Allowed values - signature, stamp."
format: string
example: signature
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
page:
type: number
format: number
example: 1
inline_response_200_10:
type: object
properties:
result:
type: string
format: string
example: mail sent successfully.
inline_response_400_2:
type: object
properties:
error:
type: string
format: string
example: Something went wrong.
inline_response_404_1:
type: object
properties:
error:
type: string
format: string
example: document not found or user not found.
inline_response_404_8:
type: object
properties:
error:
type: string
format: string
example: folder not found.
inline_response_200_11:
type: object
properties:
objectId:
type: string
format: string
example: Hks2JpewIp
updatedAt:
$ref: '#/components/schemas/date'
inline_response_200_12:
type: object
properties:
objectId:
type: string
format: string
example: Hks2JpewIp
deletedAt:
$ref: '#/components/schemas/date'
inline_response_400_3:
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!"
inline_response_200_13:
type: object
properties:
result:
type: array
items:
$ref: '#/components/schemas/folder_res'
securitySchemes:
x-api-token:
type: apiKey
name: x-api-token
in: header
Reference in New Issue View Git Blame Copy Permalink