apiDefinition.swagger.json

{
  "swagger": "2.0",
  "info": {
    "contact": {
      "email": "integrations@getaccept.com",
      "name": "GetAccept API Team",
      "url": "https://app.getaccept.com/api"
    },
    "description": "GetAccept provides a sales enablement platform for sales to design, send, promote, track, and e-sign sales documents, leveraging sales collateral, contract management, proposals, and electronic signatures in one place.",
    "license": {
      "name": "Apache 2.0",
      "url": "https://www.apache.org/licenses/LICENSE-2.0.html"
    },
    "termsOfService": "https://www.getaccept.com/terms.html",
    "title": "GetAccept",
    "version": "1.6"
  },
  "host": "api.getaccept.com",
  "basePath": "/v1",
  "schemes": [
    "https"
  ],
  "paths": {
    "/attachments": {
      "get": {
        "produces": [
          "application/json"
        ],
        "parameters": [],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/Attachments"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Attachments"
        ],
        "description": "Receive a list of available attachments. You can add new attachments in GetAccept using a new document.",
        "operationId": "ListAttachments",
        "summary": "List attachments"
      }
    },
    "/auth": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "A JSON object containing authentication credentials",
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "description": "Authentication model",
              "properties": {
                "client_id": {
                  "default": "",
                  "description": "The client id of your app if you received one from our API team",
                  "type": "string"
                },
                "email": {
                  "description": "This is the email of the user in GetAccept",
                  "format": "email",
                  "type": "string"
                },
                "entity_id": {
                  "default": "",
                  "description": "This specifies what entity to select if multiple entities are available for a user. If no value is specified the default entity will be selected.",
                  "type": "string"
                },
                "password": {
                  "description": "This is the password of the user in GetAccept",
                  "format": "password",
                  "type": "string"
                }
              },
              "required": [
                "email",
                "password"
              ],
              "type": "object",
              "x-examples": {
                "Example": {
                  "email": "user@example.com",
                  "password": "mysecret"
                }
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "properties": {
                "access_token": {
                  "description": "Token to be used in consequtive requests using bearer header",
                  "type": "string"
                },
                "expires_in": {
                  "description": "Seconds until the access token expires",
                  "format": "int64",
                  "minimum": 0,
                  "type": "integer"
                }
              },
              "type": "object"
            }
          },
          "400": {
            "description": "Invalid data",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "security": [],
        "tags": [
          "Authentication"
        ],
        "description": "Token based authentication is recommended for server-based access or access from clients where OAuth is not suitable. Access tokens has to be requested using an administrators login credentials.\nRequests should include the header Content-Type with value application/json",
        "operationId": "Authenticate",
        "summary": "Authentication by token",
        "x-ms-visibility": "internal"
      }
    },
    "/communication-templates": {
      "get": {
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "default": 0,
            "description": "Start list from record x",
            "in": "query",
            "name": "offset",
            "type": "integer"
          },
          {
            "default": 20,
            "description": "Number of records to list",
            "in": "query",
            "name": "limit",
            "type": "integer"
          },
          {
            "description": "Filter list on status",
            "enum": [
              "published",
              "draft"
            ],
            "in": "query",
            "name": "statuses",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "properties": {
                "communication_templates": {
                  "items": {
                    "$ref": "#/definitions/CommunicationTemplate"
                  },
                  "type": "array"
                }
              },
              "type": "object"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Communication Templates"
        ],
        "description": "Receive a list of available communication templates.",
        "operationId": "GetCommunicationTemplates",
        "summary": "Get communication templates"
      },
      "post": {
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "properties": {
                "tags": {
                  "items": {
                    "type": "string"
                  },
                  "type": "array"
                },
                "conversation_sendout_template": {
                  "type": "object"
                },
                "email_sendout_reminder_template": {
                  "type": "object"
                },
                "email_sendout_template": {
                  "type": "object"
                },
                "language": {
                  "description": "One language code in ISO 639 form",
                  "type": "string"
                },
                "name": {
                  "description": "Communication template name",
                  "type": "string"
                },
                "signed_sendout_template": {
                  "type": "object"
                },
                "status": {
                  "enum": [
                    "published",
                    "draft"
                  ],
                  "type": "string"
                }
              },
              "required": [
                "name",
                "language"
              ],
              "type": "object"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/CommunicationTemplate"
            }
          },
          "400": {
            "description": "Invalid data",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Communication Templates"
        ],
        "description": "Create a communication template.",
        "operationId": "CreateCommunicationTemplate",
        "summary": "Create communication template"
      }
    },
    "/communication-templates/{communicationTemplateId}": {
      "get": {
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "Communication Template ID",
            "in": "path",
            "name": "communicationTemplateId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/CommunicationTemplate"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Communication Templates"
        ],
        "description": "Receive a specific communication template.",
        "operationId": "GetCommunicationTemplate",
        "summary": "Get communication template"
      },
      "put": {
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "Communication Template ID",
            "in": "path",
            "name": "communicationTemplateId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "properties": {
                "tags": {
                  "items": {
                    "type": "string"
                  },
                  "type": "array"
                },
                "conversation_sendout_template": {
                  "type": "object"
                },
                "email_sendout_reminder_template": {
                  "type": "object"
                },
                "email_sendout_template": {
                  "type": "object"
                },
                "language": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "signed_sendout_template": {
                  "type": "object"
                },
                "status": {
                  "enum": [
                    "published",
                    "draft"
                  ],
                  "type": "string"
                }
              },
              "type": "object"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "No Content"
          },
          "400": {
            "description": "Invalid data",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Communication Templates"
        ],
        "description": "Updates a specific communication template.",
        "operationId": "UpdateCommunicationTemplate",
        "summary": "Update communication template"
      }
    },
    "/contacts": {
      "get": {
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "Filter list on status",
            "enum": [
              "active",
              "inactive",
              "signed"
            ],
            "in": "query",
            "name": "filter",
            "type": "string"
          },
          {
            "description": "How to sort results",
            "enum": [
              "name",
              "email",
              "company_name",
              "document_count",
              "created"
            ],
            "in": "query",
            "name": "sort_by",
            "type": "string"
          },
          {
            "description": "Sort order of results",
            "enum": [
              "asc",
              "desc"
            ],
            "in": "query",
            "name": "sort_order",
            "type": "string"
          },
          {
            "description": "Include documents from team members",
            "in": "query",
            "name": "showteam",
            "type": "boolean"
          },
          {
            "description": "Include all contacts from entity",
            "in": "query",
            "name": "showall",
            "type": "boolean"
          },
          {
            "default": 0,
            "description": "Start list from record x",
            "in": "query",
            "name": "offset",
            "type": "integer"
          },
          {
            "default": 100,
            "description": "Number of records to list",
            "in": "query",
            "name": "limit",
            "type": "integer"
          },
          {
            "description": "Search string to match first_name, last_name or email",
            "in": "query",
            "name": "search",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/Contacts"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Contacts"
        ],
        "description": "Receive a list of available contact for the current entity.\nAll contacts added as a recipient are saved as a contact and is available for later use on that entity.",
        "operationId": "ListContacts",
        "summary": "List contacts"
      },
      "post": {
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "A JSON object containing contact information",
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "properties": {
                "company_name": {
                  "description": "Associated company name",
                  "type": "string",
                  "x-ms-summary": "Company Name"
                },
                "company_number": {
                  "description": "Associated company number",
                  "type": "string",
                  "x-ms-summary": "Company Number"
                },
                "email": {
                  "description": "Email address of the contact",
                  "type": "string",
                  "x-ms-summary": "Email"
                },
                "first_name": {
                  "description": "First name of the contact",
                  "type": "string",
                  "x-ms-summary": "First name"
                },
                "fullname": {
                  "description": "Use to specify full name instead of first/last name",
                  "type": "string",
                  "x-ms-summary": "Full name"
                },
                "last_name": {
                  "description": "Last name of the contact",
                  "type": "string",
                  "x-ms-summary": "Last name"
                },
                "mobile": {
                  "description": "Mobile number in international format",
                  "type": "string",
                  "x-ms-summary": "Mobile"
                },
                "note": {
                  "description": "Optional internal note for contact",
                  "type": "string",
                  "x-ms-summary": "Note"
                },
                "phone": {
                  "description": "Phone number in international format",
                  "type": "string",
                  "x-ms-summary": "Phone"
                },
                "title": {
                  "description": "The title of the contact, ex. CEO, Sales manager",
                  "type": "string",
                  "x-ms-summary": "Title"
                }
              },
              "type": "object"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "properties": {
                "contact_id": {
                  "description": "ID of the created contact",
                  "example": "abc58129f",
                  "type": "string",
                  "x-ms-summary": "Contact ID"
                }
              },
              "type": "object"
            }
          },
          "400": {
            "description": "Invalid data",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Contacts"
        ],
        "description": "This will create a new contact in the database for the current entity",
        "operationId": "CreateContact",
        "summary": "Create contact",
        "x-ms-visibility": "important"
      }
    },
    "/contacts/{contactId}": {
      "delete": {
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "Contact ID",
            "in": "path",
            "name": "contactId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "204": {
            "description": "No Content"
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Contacts"
        ],
        "description": "Delete a contact. Contacts who are connected to active or signed documents cannot be deleted.",
        "operationId": "DeleteContact",
        "summary": "Delete contact"
      }
    },
    "/custom-data/entity": {
      "get": {
        "produces": [
          "application/json"
        ],
        "parameters": [],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/EntityCustomData"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Custom Data"
        ],
        "description": "Get the custom data settings for the current entity.",
        "operationId": "GetEntityCustomData",
        "summary": "Get entity custom data properties"
      },
      "post": {
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "properties": {
                "key": {
                  "description": "Unique key for the custom data property",
                  "type": "string"
                },
                "label": {
                  "description": "Human-readable label",
                  "type": "string"
                },
                "value_type": {
                  "description": "Type of value: string, number, boolean",
                  "enum": [
                    "string",
                    "number",
                    "boolean"
                  ],
                  "type": "string"
                }
              },
              "required": [
                "key",
                "value_type",
                "label"
              ],
              "type": "object"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          },
          "400": {
            "description": "Invalid data",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Custom Data"
        ],
        "description": "Add a new custom data property to the current entity.",
        "operationId": "AddEntityCustomDataProperty",
        "summary": "Add entity custom data property"
      }
    },
    "/custom-data/entity/{propertyKey}": {
      "delete": {
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "Property Key",
            "in": "path",
            "name": "propertyKey",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "204": {
            "description": "No Content"
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Custom Data"
        ],
        "description": "Delete a custom data property from the current entity.",
        "operationId": "DeleteEntityCustomDataProperty",
        "summary": "Delete entity custom data property"
      }
    },
    "/documents": {
      "get": {
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "Filter list on status",
            "enum": [
              "draft",
              "sent",
              "viewed",
              "reviewed",
              "signed",
              "rejected",
              "recalled"
            ],
            "in": "query",
            "name": "filter",
            "type": "string",
            "x-ms-summary": "Filter list on status"
          },
          {
            "description": "How to sort results",
            "enum": [
              "name",
              "value",
              "created",
              "recipient",
              "status",
              "owner"
            ],
            "in": "query",
            "name": "sort_by",
            "type": "string",
            "x-ms-summary": "How to sort results"
          },
          {
            "description": "Sort order of results",
            "enum": [
              "asc",
              "desc"
            ],
            "in": "query",
            "name": "sort_order",
            "type": "string",
            "x-ms-summary": "Sort order of results"
          },
          {
            "description": "Include documents from team members",
            "enum": [
              true,
              false
            ],
            "in": "query",
            "name": "showteam",
            "type": "boolean",
            "x-ms-summary": "Include documents from team members"
          },
          {
            "description": "Include all documents from entity",
            "enum": [
              true,
              false
            ],
            "in": "query",
            "name": "showall",
            "type": "boolean",
            "x-ms-summary": "Include all documents from entity"
          },
          {
            "description": "An external ID is a custom field which can contain a unique record identifier from a system outside of GetAccept",
            "in": "query",
            "name": "external_id",
            "type": "string",
            "x-ms-summary": "External ID"
          },
          {
            "description": "Start list from record x until limit",
            "in": "query",
            "name": "offset",
            "type": "number",
            "x-ms-summary": "Offset"
          },
          {
            "description": "Number of records to list",
            "in": "query",
            "name": "limit",
            "type": "number",
            "x-ms-summary": "Limit"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/Documents"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Documents"
        ],
        "description": "Get a list of available documents",
        "operationId": "ListDocuments",
        "summary": "List documents"
      },
      "post": {
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "A JSON object containing document information",
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "properties": {
                "attachments": {
                  "description": "Attachments",
                  "items": {
                    "properties": {
                      "id": {
                        "description": "Attachment ID received from list or after upload",
                        "type": "string",
                        "x-ms-dynamic-values": {
                          "operationId": "ListAttachments",
                          "value-collection": "attachments",
                          "value-path": "attachment_id",
                          "value-title": "attachment_title"
                        },
                        "x-ms-summary": "ID"
                      },
                      "require_view": {
                        "description": "Require that recipient view the attachment",
                        "enum": [
                          true,
                          false
                        ],
                        "example": true,
                        "type": "boolean",
                        "x-ms-summary": "Require view",
                        "x-nullable": true
                      },
                      "type": {
                        "description": "file or external where file is an uploaded file and external is a link to an external file",
                        "enum": [
                          "file",
                          "external"
                        ],
                        "type": "string",
                        "x-ms-summary": "Type"
                      }
                    },
                    "type": "object"
                  },
                  "type": "array",
                  "x-ms-summary": "Attachment"
                },
                "custom_data": {
                  "description": "A list of custom data to include with the document. If the property is already defined on the template, it will be overridden by the value provided here.",
                  "properties": {
                    "properties": {
                      "description": "An array of objects containing custom data properties",
                      "items": {
                        "properties": {
                          "key": {
                            "description": "Key of the custom data property",
                            "type": "string",
                            "x-ms-summary": "Key"
                          },
                          "label": {
                            "description": "Label of the custom data property",
                            "type": "string",
                            "x-ms-summary": "Label"
                          },
                          "value": {
                            "description": "Value of the custom data property",
                            "type": "string",
                            "x-ms-summary": "Value"
                          },
                          "value_type": {
                            "description": "Type of the value: string, number, boolean",
                            "enum": [
                              "string",
                              "number",
                              "boolean"
                            ],
                            "type": "string",
                            "x-ms-summary": "Value Type"
                          }
                        },
                        "type": "object"
                      },
                      "type": "array",
                      "x-ms-summary": "Properties"
                    }
                  },
                  "type": "object",
                  "x-ms-summary": "Custom Data",
                  "x-ms-visibility": "advanced"
                },
                "custom_fields": {
                  "description": "Custom field",
                  "items": {
                    "properties": {
                      "id": {
                        "description": "ID of custom template field",
                        "type": "string",
                        "x-ms-summary": "Field ID"
                      },
                      "name": {
                        "description": "Name of custom template field",
                        "type": "string",
                        "x-ms-summary": "Field Name"
                      },
                      "value": {
                        "description": "Value of custom template field",
                        "type": "string",
                        "x-ms-summary": "Field Value"
                      }
                    },
                    "type": "object"
                  },
                  "type": "array",
                  "x-ms-summary": "Custom"
                },
                "custom_pricing_tables": {
                  "description": "Pricing",
                  "items": {
                    "properties": {
                      "currency_settings": {
                        "description": "Currency Settings",
                        "properties": {
                          "currency": {
                            "description": "Currency, ex. SEK",
                            "type": "string",
                            "x-ms-summary": "Currency"
                          },
                          "locale": {
                            "description": "Locale, ex. sv-SE",
                            "type": "string",
                            "x-ms-summary": "Locale"
                          }
                        },
                        "type": "object",
                        "x-ms-summary": "Currency Settings",
                        "x-ms-visibility": "advanced"
                      },
                      "display_name": {
                        "description": "Display name of the pricing table",
                        "type": "string",
                        "x-ms-summary": "Display Name",
                        "x-ms-visibility": "advanced"
                      },
                      "external_id": {
                        "description": "External ID to represent the summary object within a third-party system",
                        "type": "string",
                        "x-ms-summary": "External ID",
                        "x-ms-visibility": "advanced"
                      },
                      "id": {
                        "description": "Table ID",
                        "type": "string",
                        "x-ms-summary": "Table ID",
                        "x-ms-visibility": "advanced"
                      },
                      "pre_calculated": {
                        "default": false,
                        "description": "If pricing table totals should be pre-calculated",
                        "enum": [
                          true,
                          false
                        ],
                        "example": true,
                        "type": "boolean",
                        "x-ms-summary": "Precalculated totals",
                        "x-ms-visibility": "advanced"
                      },
                      "sections": {
                        "description": "Sections",
                        "items": {
                          "properties": {
                            "display_name": {
                              "description": "Display name of the pricing table",
                              "type": "string",
                              "x-ms-summary": "Display Name"
                            },
                            "id": {
                              "description": "Section ID",
                              "type": "string",
                              "x-ms-summary": "ID"
                            },
                            "rows": {
                              "additionalProperties": {
                                "items": {
                                  "type": "object"
                                },
                                "type": "array"
                              },
                              "description": "Array with values object with array of column_id, value",
                              "example": [
                                {
                                  "values": [
                                    {
                                      "column_id": "abc123",
                                      "value": "My product"
                                    },
                                    {
                                      "column_id": "def456",
                                      "value": 240
                                    }
                                  ]
                                }
                              ],
                              "x-ms-summary": "Rows"
                            },
                            "section_summary": {
                              "properties": {
                                "discount": {
                                  "properties": {
                                    "enabled": {
                                      "description": "If section discount should be enabled",
                                      "enum": [
                                        true,
                                        false
                                      ],
                                      "example": true,
                                      "type": "boolean",
                                      "x-ms-summary": "Enabled",
                                      "x-nullable": true
                                    },
                                    "flat_fee": {
                                      "description": "If section should use using flat fee discounts",
                                      "enum": [
                                        true,
                                        false
                                      ],
                                      "example": true,
                                      "type": "boolean",
                                      "x-ms-summary": "Flat fee",
                                      "x-nullable": true
                                    },
                                    "value": {
                                      "description": "The value for section discount",
                                      "type": "string",
                                      "x-ms-summary": "Discount Value"
                                    }
                                  },
                                  "type": "object",
                                  "x-ms-summary": "Discount"
                                },
                                "price": {
                                  "properties": {
                                    "enabled": {
                                      "description": "If section price should be enabled",
                                      "enum": [
                                        true,
                                        false
                                      ],
                                      "example": true,
                                      "type": "boolean",
                                      "x-ms-summary": "Enabled",
                                      "x-nullable": true
                                    },
                                    "flat_fee": {
                                      "description": "If section should use using flat fee pricing",
                                      "enum": [
                                        true,
                                        false
                                      ],
                                      "example": true,
                                      "type": "boolean",
                                      "x-ms-summary": "Flat fee",
                                      "x-nullable": true
                                    },
                                    "value": {
                                      "description": "The value for section price",
                                      "type": "string",
                                      "x-ms-summary": "Price Value"
                                    }
                                  },
                                  "type": "object",
                                  "x-ms-summary": "Price"
                                },
                                "tax": {
                                  "properties": {
                                    "enabled": {
                                      "description": "If section tax should be enabled",
                                      "enum": [
                                        true,
                                        false
                                      ],
                                      "example": true,
                                      "type": "boolean",
                                      "x-ms-summary": "Enabled",
                                      "x-nullable": true
                                    },
                                    "flat_fee": {
                                      "description": "If section should use using flat fee taxes",
                                      "enum": [
                                        true,
                                        false
                                      ],
                                      "example": true,
                                      "type": "boolean",
                                      "x-ms-summary": "Flat fee",
                                      "x-nullable": true
                                    },
                                    "value": {
                                      "description": "The value for section tax",
                                      "type": "string",
                                      "x-ms-summary": "Tax Value"
                                    }
                                  },
                                  "type": "object",
                                  "x-ms-summary": "Tax"
                                }
                              },
                              "type": "object",
                              "x-ms-summary": "Summary Values"
                            }
                          },
                          "type": "object"
                        },
                        "type": "array",
                        "x-ms-summary": "Section",
                        "x-ms-visibility": "advanced"
                      },
                      "summary_values": {
                        "properties": {
                          "discount": {
                            "properties": {
                              "enabled": {
                                "description": "If pricing table discount should be enabled",
                                "enum": [
                                  true,
                                  false
                                ],
                                "example": true,
                                "type": "boolean",
                                "x-ms-summary": "Enabled",
                                "x-ms-visibility": "advanced",
                                "x-nullable": true
                              },
                              "flat_fee": {
                                "description": "If pricing table should use using flat fee discounts",
                                "enum": [
                                  true,
                                  false
                                ],
                                "example": true,
                                "type": "boolean",
                                "x-ms-summary": "Flat fee",
                                "x-ms-visibility": "advanced",
                                "x-nullable": true
                              },
                              "value": {
                                "description": "The value for summary discount",
                                "type": "string",
                                "x-ms-summary": "Discount Value"
                              }
                            },
                            "type": "object",
                            "x-ms-summary": "Discount"
                          },
                          "price": {
                            "properties": {
                              "enabled": {
                                "description": "If pricing table price should be enabled",
                                "enum": [
                                  true,
                                  false
                                ],
                                "example": true,
                                "type": "boolean",
                                "x-ms-summary": "Enabled",
                                "x-ms-visibility": "advanced",
                                "x-nullable": true
                              },
                              "flat_fee": {
                                "description": "If pricing table should use using flat fee pricing",
                                "enum": [
                                  true,
                                  false
                                ],
                                "example": true,
                                "type": "boolean",
                                "x-ms-summary": "Flat fee",
                                "x-ms-visibility": "advanced",
                                "x-nullable": true
                              },
                              "value": {
                                "description": "The value for summary price",
                                "type": "string",
                                "x-ms-summary": "Price Value"
                              }
                            },
                            "type": "object",
                            "x-ms-summary": "Price"
                          },
                          "tax": {
                            "properties": {
                              "enabled": {
                                "description": "If pricing table tax should be enabled",
                                "enum": [
                                  true,
                                  false
                                ],
                                "example": true,
                                "type": "boolean",
                                "x-ms-summary": "Enabled",
                                "x-ms-visibility": "advanced",
                                "x-nullable": true
                              },
                              "flat_fee": {
                                "description": "If pricing table should use using flat fee taxes",
                                "enum": [
                                  true,
                                  false
                                ],
                                "example": true,
                                "type": "boolean",
                                "x-ms-summary": "Flat fee",
                                "x-ms-visibility": "advanced",
                                "x-nullable": true
                              },
                              "value": {
                                "description": "The value for summary tax",
                                "type": "string",
                                "x-ms-summary": "Value"
                              }
                            },
                            "type": "object",
                            "x-ms-summary": "Tax"
                          }
                        },
                        "type": "object",
                        "x-ms-summary": "Summary Values",
                        "x-ms-visibility": "advanced"
                      }
                    },
                    "type": "object"
                  },
                  "type": "array",
                  "x-ms-summary": "Pricing",
                  "x-ms-visibility": "advanced"
                },
                "email_send_message": {
                  "description": "Use this to specify a message to the recipient(s) when sending out the document",
                  "type": "string",
                  "x-ms-summary": "Email message",
                  "x-ms-visibility": "advanced"
                },
                "expiration_date": {
                  "description": "Date and time when the document should expire",
                  "format": "date-time",
                  "type": "string",
                  "x-ms-summary": "Expiration date",
                  "x-ms-visibility": "advanced"
                },
                "external_eid_signature": {
                  "description": "If true, enables external EID signature for the document, allowing recipients to sign using an external Electronic ID provider. Incompatible with is_selfsign.",
                  "enum": [
                    true,
                    false
                  ],
                  "example": true,
                  "type": "boolean",
                  "x-ms-summary": "External EID signature",
                  "x-ms-visibility": "advanced",
                  "x-nullable": true
                },
                "external_id": {
                  "description": "External system ID for identification",
                  "type": "string",
                  "x-ms-summary": "External ID"
                },
                "external_signature_settings": {
                  "description": "Optional configuration for external EID signature. Only applicable when external_eid_signature is enabled. EID verification at signing is always required. When verify_recipient_ssn is enabled, the SSN from the EID provider is matched against the recipient's verify_eid_number.",
                  "properties": {
                    "identification_stages": {
                      "description": "Stages where additional EID identification is required. Available value is \"View\" (require EID verification before viewing the document). EID verification at signing is always required.",
                      "items": {
                        "enum": [
                          "View"
                        ],
                        "type": "string"
                      },
                      "type": "array"
                    }
                  },
                  "type": "object",
                  "x-ms-summary": "External signature settings",
                  "x-ms-visibility": "advanced"
                },
                "file_content": {
                  "description": "Base64 encoded file content",
                  "type": "string",
                  "x-ms-summary": "File content"
                },
                "file_ids": {
                  "description": "Comma-separated, unique file-ids received when uploading files",
                  "type": "string",
                  "x-ms-summary": "File IDs"
                },
                "file_name": {
                  "description": "Filename of the document, with the extension. This will be helpful for converting different file-types.",
                  "type": "string",
                  "x-ms-summary": "File name"
                },
                "file_url": {
                  "description": "Url to document file. Documents must be public available for download",
                  "type": "string",
                  "x-ms-summary": "File URL"
                },
                "is_automatic_sending": {
                  "description": "If the document should be sent after creation",
                  "enum": [
                    true,
                    false
                  ],
                  "example": true,
                  "type": "boolean",
                  "x-ms-summary": "Send automatically",
                  "x-ms-visibility": "important",
                  "x-nullable": true
                },
                "is_reminder_sending": {
                  "description": "Should automatic reminders be sent",
                  "enum": [
                    true,
                    false
                  ],
                  "example": true,
                  "type": "boolean",
                  "x-ms-summary": "Send reminders",
                  "x-ms-visibility": "advanced",
                  "x-nullable": true
                },
                "is_scheduled_sending": {
                  "description": "Should the sending be scheduled for sending in the future",
                  "enum": [
                    true,
                    false
                  ],
                  "example": true,
                  "type": "boolean",
                  "x-ms-summary": "Schedule sending",
                  "x-ms-visibility": "advanced",
                  "x-nullable": true
                },
                "is_signing": {
                  "description": "Should the document be sent for signing",
                  "enum": [
                    true,
                    false
                  ],
                  "example": true,
                  "type": "boolean",
                  "x-ms-summary": "Sign document",
                  "x-ms-visibility": "advanced",
                  "x-nullable": true
                },
                "is_signing_biometric": {
                  "description": "Use handwritten signature",
                  "enum": [
                    true,
                    false
                  ],
                  "example": true,
                  "type": "boolean",
                  "x-ms-summary": "Handwritten signature",
                  "x-ms-visibility": "advanced",
                  "x-nullable": true
                },
                "is_signing_forward": {
                  "description": "Should recipients be able to transfer signature rights",
                  "enum": [
                    true,
                    false
                  ],
                  "example": true,
                  "type": "boolean",
                  "x-ms-summary": "Allow signature transfer",
                  "x-ms-visibility": "advanced",
                  "x-nullable": true
                },
                "is_signing_initials": {
                  "description": "Sign document using recipient initials",
                  "enum": [
                    true,
                    false
                  ],
                  "example": true,
                  "type": "boolean",
                  "x-ms-summary": "Sign with initials",
                  "x-ms-visibility": "advanced",
                  "x-nullable": true
                },
                "is_sms_sending": {
                  "description": "Should the document be sent to recipient mobile by text",
                  "enum": [
                    true,
                    false
                  ],
                  "example": true,
                  "type": "boolean",
                  "x-ms-summary": "Send SMS",
                  "x-nullable": true
                },
                "name": {
                  "description": "Enter a name of the document",
                  "type": "string",
                  "x-ms-summary": "Document name",
                  "x-ms-visibility": "important"
                },
                "recipients": {
                  "items": {
                    "properties": {
                      "company_name": {
                        "description": "Company name of the recipient",
                        "type": "string",
                        "x-ms-summary": "Company name",
                        "x-ms-visibility": "important"
                      },
                      "company_number": {
                        "description": "Company number of the recipient",
                        "type": "string",
                        "x-ms-summary": "Company number",
                        "x-ms-visibility": "important"
                      },
                      "email": {
                        "description": "Email address of the recipient",
                        "type": "string",
                        "x-ms-summary": "Email",
                        "x-ms-visibility": "important"
                      },
                      "first_name": {
                        "description": "Recipient first name",
                        "type": "string",
                        "x-ms-summary": "First name",
                        "x-ms-visibility": "important"
                      },
                      "fullname": {
                        "description": "Use to specify full name instead of first/last name",
                        "type": "string",
                        "x-ms-summary": "Full name",
                        "x-ms-visibility": "important"
                      },
                      "last_name": {
                        "description": "Last name of recipient",
                        "type": "string",
                        "x-ms-summary": "Last name",
                        "x-ms-visibility": "important"
                      },
                      "mobile": {
                        "description": "Mobile phone in international format",
                        "type": "string",
                        "x-ms-summary": "Mobile"
                      },
                      "note": {
                        "description": "Additional note for a recipient",
                        "type": "string",
                        "x-ms-summary": "Note",
                        "x-ms-visibility": "advanced"
                      },
                      "order_num": {
                        "description": "If signing order is enabled",
                        "example": 1,
                        "format": "int32",
                        "type": "integer",
                        "x-ms-summary": "Signing order",
                        "x-ms-visibility": "advanced",
                        "x-nullable": true
                      },
                      "role": {
                        "description": "The kind of recipient in the document. Available values:\n- signer: signer of the document\n- internalApprover: used for internal approval processes and will not appear in the signing certificate\n- externalApprover: used for external approval processes and will appear in the signing certificate, alongside other signers\n- cc: view only\n",
                        "enum": [
                          "signer",
                          "internalApprover",
                          "externalApprover",
                          "cc"
                        ],
                        "type": "string",
                        "x-ms-summary": "Recipient type",
                        "x-ms-visibility": "important"
                      },
                      "role_name": {
                        "description": "The name of the role in a template",
                        "type": "string",
                        "x-ms-summary": "Template role",
                        "x-ms-visibility": "important"
                      },
                      "settings": {
                        "description": "Per-recipient signature settings.",
                        "properties": {
                          "exclude_verified_eid_signature": {
                            "description": "Only applies when the document has external_eid_signature enabled. If true, this recipient may sign with a handwritten signature instead of verifying with a verified EID. Note: the additional non-QES signatures do not degrade the security of the document's existing QES signatures, but are of a lower assurance level (advanced or SES). Someone inspecting the document may see that it contains non-QES signatures.",
                            "enum": [
                              true,
                              false
                            ],
                            "example": true,
                            "type": "boolean",
                            "x-ms-summary": "Exclude verified EID signature",
                            "x-ms-visibility": "advanced",
                            "x-nullable": true
                          }
                        },
                        "type": "object",
                        "x-ms-summary": "Recipient settings",
                        "x-ms-visibility": "advanced"
                      },
                      "verify_eid": {
                        "description": "Verify using EID",
                        "enum": [
                          true,
                          false
                        ],
                        "example": true,
                        "type": "boolean",
                        "x-ms-summary": "Verify EID",
                        "x-ms-visibility": "advanced",
                        "x-nullable": true
                      },
                      "verify_eid_type": {
                        "description": "EID type to be used for personal verification",
                        "type": "string",
                        "x-ms-summary": "EID type",
                        "x-ms-visibility": "advanced"
                      },
                      "verify_qna": {
                        "description": "Should a question be asked",
                        "enum": [
                          true,
                          false
                        ],
                        "example": true,
                        "type": "boolean",
                        "x-ms-summary": "Enable question",
                        "x-ms-visibility": "advanced",
                        "x-nullable": true
                      },
                      "verify_qna_answer": {
                        "description": "The answer to question",
                        "example": "123456789",
                        "type": "string",
                        "x-ms-summary": "Verification answer",
                        "x-ms-visibility": "advanced"
                      },
                      "verify_qna_open": {
                        "description": "Should question be asked before opening document",
                        "enum": [
                          true,
                          false
                        ],
                        "example": true,
                        "type": "boolean",
                        "x-ms-summary": "Question on open",
                        "x-ms-visibility": "advanced",
                        "x-nullable": true
                      },
                      "verify_qna_question": {
                        "description": "Question to ask for verification",
                        "example": "Enter your SSN",
                        "type": "string",
                        "x-ms-summary": "Verification question",
                        "x-ms-visibility": "advanced"
                      },
                      "verify_qna_sign": {
                        "description": "Should a question be asked before signing",
                        "enum": [
                          true,
                          false
                        ],
                        "example": true,
                        "type": "boolean",
                        "x-ms-summary": "Sign question",
                        "x-ms-visibility": "advanced",
                        "x-nullable": true
                      },
                      "verify_sms": {
                        "description": "Verify recipient by SMS",
                        "enum": [
                          true,
                          false
                        ],
                        "example": true,
                        "type": "boolean",
                        "x-ms-summary": "Verify SMS",
                        "x-ms-visibility": "advanced",
                        "x-nullable": true
                      },
                      "verify_sms_open": {
                        "description": "Verify SMS on open",
                        "enum": [
                          true,
                          false
                        ],
                        "example": true,
                        "type": "boolean",
                        "x-ms-summary": "Verify SMS on open",
                        "x-ms-visibility": "advanced"
                      },
                      "verify_sms_sign": {
                        "description": "Should a SMS verify the recipient before signing",
                        "enum": [
                          true,
                          false
                        ],
                        "example": true,
                        "type": "boolean",
                        "x-ms-summary": "Verify by SMS",
                        "x-ms-visibility": "advanced",
                        "x-nullable": true
                      }
                    },
                    "type": "object"
                  },
                  "type": "array",
                  "x-ms-summary": "Recipient"
                },
                "scheduled_sending_time": {
                  "description": "Date and time when the document should be sent out",
                  "format": "date-time",
                  "type": "string",
                  "x-ms-summary": "Schedule send date",
                  "x-ms-visibility": "advanced"
                },
                "sender_email": {
                  "description": "Send from other email than authenticated user",
                  "type": "string",
                  "x-ms-summary": "Sender email override",
                  "x-ms-visibility": "advanced"
                },
                "sender_id": {
                  "description": "Send from other user than authenticated",
                  "type": "string",
                  "x-ms-dynamic-values": {
                    "operationId": "ListUsers",
                    "value-collection": "users",
                    "value-path": "user_id",
                    "value-title": "email"
                  },
                  "x-ms-summary": "Sender user override",
                  "x-ms-visibility": "advanced"
                },
                "template_id": {
                  "description": "Select a template to use for the sending",
                  "type": "string",
                  "x-ms-dynamic-values": {
                    "operationId": "ListTemplates",
                    "value-collection": "templates",
                    "value-path": "id",
                    "value-title": "name"
                  },
                  "x-ms-summary": "Template ID",
                  "x-ms-visibility": "important"
                },
                "type": {
                  "default": "sales",
                  "description": "Set the type/category of the document",
                  "enum": [
                    "sales",
                    "introduction",
                    "hr",
                    "other"
                  ],
                  "example": "sales",
                  "type": "string",
                  "x-ms-summary": "Document type",
                  "x-ms-visibility": "important"
                },
                "value": {
                  "description": "Value of deal or document",
                  "format": "float",
                  "type": "number",
                  "x-ms-summary": "Document value",
                  "x-ms-visibility": "important",
                  "x-nullable": true
                },
                "video_id": {
                  "description": "Select a video to use for the sending",
                  "type": "string",
                  "x-ms-dynamic-values": {
                    "operationId": "ListVideos",
                    "value-collection": "videos",
                    "value-path": "video_id",
                    "value-title": "video_title"
                  },
                  "x-ms-summary": "Video ID",
                  "x-ms-visibility": "advanced"
                }
              },
              "required": [
                "name"
              ],
              "type": "object"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/Document"
            }
          },
          "400": {
            "description": "Invalid data",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Documents"
        ],
        "description": "You must create a document to be able to send it to a recipient. When creating a document you can refer to previously uploaded files with file_id or you can choose to create a document and upload the files in on API post. You can only upload ONE file when including a file in the create document POST.\n\nUse either file_ids parameter to use existing uploaded file(s), file_content to send the document as base64 encoded string or do a multipart post with file parameter.\n\nAll recipients must have either a valid e-mail or a mobile number.\n\nAll events are recorded using requestor IP address. You can override this using header CLIENT_IP containing the end-users public IP address.",
        "operationId": "CreateDocument",
        "summary": "Create and send document or template"
      }
    },
    "/documents/external/{externalId}": {
      "get": {
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "External ID",
            "in": "path",
            "name": "externalId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/Document"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Documents"
        ],
        "description": "Get a document by the external id specified when document was created.",
        "operationId": "GetDocumentByExternalId",
        "summary": "Get document by external ID"
      }
    },
    "/documents/{documentId}": {
      "delete": {
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "Document ID",
            "in": "path",
            "name": "documentId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "204": {
            "description": "No Content"
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Documents"
        ],
        "description": "Delete a single document.",
        "operationId": "DeleteDocument",
        "summary": "Delete document"
      },
      "get": {
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "Document ID",
            "in": "path",
            "name": "documentId",
            "required": true,
            "type": "string",
            "x-ms-dynamic-values": {
              "operationId": "ListDocuments",
              "value-path": "id",
              "value-title": "name"
            },
            "x-ms-summary": "Document ID",
            "x-ms-url-encoding": "single"
          },
          {
            "description": "Include document attachments",
            "in": "query",
            "name": "with_attachments",
            "type": "boolean"
          },
          {
            "description": "Include document pages",
            "in": "query",
            "name": "with_pages",
            "type": "boolean"
          },
          {
            "description": "Include document statistics",
            "in": "query",
            "name": "with_stats",
            "type": "boolean"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/Document"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "403": {
            "description": "Access denied",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Documents"
        ],
        "description": "Get document details by specifying a document id.",
        "operationId": "GetDocumentDetails",
        "summary": "Get document details"
      },
      "put": {
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "Document ID",
            "in": "path",
            "name": "documentId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "properties": {
                "tags": {
                  "description": "Document tags (comma separated without space)",
                  "type": "string"
                },
                "contract_end_date": {
                  "description": "End date of contract for contract management",
                  "type": "string"
                },
                "contract_start_date": {
                  "description": "Start date of contract for contract management",
                  "type": "string"
                },
                "external_client_id": {
                  "description": "Creation source of the document",
                  "type": "string"
                },
                "external_id": {
                  "description": "Change external ID of the document",
                  "type": "string"
                },
                "value": {
                  "description": "Update the value parameter of the Document",
                  "type": "number"
                }
              },
              "type": "object"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          },
          "400": {
            "description": "Invalid data",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Documents"
        ],
        "description": "Update different document properties during the lifecycle of the document.",
        "operationId": "UpdateDocument",
        "summary": "Update document"
      }
    },
    "/documents/{documentId}/attachments": {
      "get": {
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "Document ID",
            "in": "path",
            "name": "documentId",
            "required": true,
            "type": "string",
            "x-ms-dynamic-values": {
              "operationId": "ListDocuments",
              "value-path": "id",
              "value-title": "name"
            },
            "x-ms-summary": "Document ID",
            "x-ms-url-encoding": "single"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/Attachments"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "403": {
            "description": "Access denied",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Documents"
        ],
        "description": "Get document attachments by specifying a document id.",
        "operationId": "GetDocumentAttachments",
        "summary": "Get document attachments"
      }
    },
    "/documents/{documentId}/attachments/{documentAttachmentId}/upload": {
      "post": {
        "consumes": [
          "multipart/form-data"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "Document ID",
            "in": "path",
            "name": "documentId",
            "required": true,
            "type": "string"
          },
          {
            "description": "Document Attachment ID",
            "in": "path",
            "name": "documentAttachmentId",
            "required": true,
            "type": "string"
          },
          {
            "format": "binary",
            "in": "formData",
            "name": "file",
            "type": "string"
          }
        ],
        "responses": {
          "204": {
            "description": "No Content"
          },
          "400": {
            "description": "Invalid data",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Documents"
        ],
        "description": "Uploads a file for a specific attachment on a document.",
        "operationId": "UploadFileToDocumentAttachment",
        "summary": "Upload file to document attachment"
      }
    },
    "/documents/{documentId}/comments": {
      "get": {
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "Document ID",
            "in": "path",
            "name": "documentId",
            "required": true,
            "type": "string",
            "x-ms-summary": "Document ID"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "items": {
                "$ref": "#/definitions/Comment"
              },
              "type": "array"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Documents"
        ],
        "description": "Get a list of chat comments for a document.",
        "operationId": "GetComments",
        "summary": "Get comments"
      },
      "post": {
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "Document ID",
            "in": "path",
            "name": "documentId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "properties": {
                "position": {
                  "description": "A json-string of the page and x-y-position coordinates where the comment should be placed. Example: { page: 'a8bafd97', top: 230, left: 19 }",
                  "type": "string"
                },
                "text": {
                  "description": "The comment text to be added to the document",
                  "type": "string"
                }
              },
              "required": [
                "text"
              ],
              "type": "object"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/CommentResponse"
            }
          },
          "400": {
            "description": "Invalid data",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Documents"
        ],
        "description": "Creates a new comment in a document.",
        "operationId": "CreateComment",
        "summary": "Create comment"
      }
    },
    "/documents/{documentId}/custom-data": {
      "get": {
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "Document ID",
            "in": "path",
            "name": "documentId",
            "required": true,
            "type": "string"
          },
          {
            "default": 20,
            "description": "Number of records to list",
            "in": "query",
            "name": "limit",
            "type": "integer"
          },
          {
            "default": 0,
            "description": "Start list from record x",
            "in": "query",
            "name": "offset",
            "type": "integer"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "properties": {
                "custom_data": {
                  "items": {
                    "$ref": "#/definitions/CustomDataProperty"
                  },
                  "type": "array"
                },
                "total_count": {
                  "type": "integer"
                }
              },
              "type": "object"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Custom Data"
        ],
        "description": "Get all custom data properties for a document.",
        "operationId": "GetDocumentCustomData",
        "summary": "Get document custom data properties"
      },
      "post": {
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "Document ID",
            "in": "path",
            "name": "documentId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "properties": {
                "property": {
                  "properties": {
                    "key": {
                      "description": "Key of the custom data property",
                      "type": "string"
                    },
                    "label": {
                      "description": "Human-readable label",
                      "type": "string"
                    },
                    "value": {
                      "description": "Value for the custom data property"
                    },
                    "value_type": {
                      "description": "Type of value: string, number, boolean",
                      "type": "string"
                    }
                  },
                  "required": [
                    "key",
                    "value",
                    "label",
                    "value_type"
                  ],
                  "type": "object"
                }
              },
              "required": [
                "property"
              ],
              "type": "object"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/CustomDataProperty"
            }
          },
          "400": {
            "description": "Invalid data",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Custom Data"
        ],
        "description": "Add a custom data property to a document.",
        "operationId": "AddDocumentCustomDataProperty",
        "summary": "Add document custom data property"
      }
    },
    "/documents/{documentId}/custom-data/{customDataId}": {
      "delete": {
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "Document ID",
            "in": "path",
            "name": "documentId",
            "required": true,
            "type": "string"
          },
          {
            "description": "Custom Data ID",
            "in": "path",
            "name": "customDataId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "204": {
            "description": "No Content"
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Custom Data"
        ],
        "description": "Delete a custom data property from a document.",
        "operationId": "DeleteDocumentCustomDataProperty",
        "summary": "Delete document custom data property"
      },
      "get": {
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "Document ID",
            "in": "path",
            "name": "documentId",
            "required": true,
            "type": "string"
          },
          {
            "description": "Custom Data ID",
            "in": "path",
            "name": "customDataId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/CustomDataProperty"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Custom Data"
        ],
        "description": "Get a specific custom data property for a document.",
        "operationId": "GetDocumentCustomDataProperty",
        "summary": "Get document custom data property"
      },
      "put": {
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "Document ID",
            "in": "path",
            "name": "documentId",
            "required": true,
            "type": "string"
          },
          {
            "description": "Custom Data ID",
            "in": "path",
            "name": "customDataId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "properties": {
                "property": {
                  "properties": {
                    "label": {
                      "type": "string"
                    },
                    "value": {},
                    "value_type": {
                      "type": "string"
                    }
                  },
                  "type": "object"
                }
              },
              "type": "object"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "No Content"
          },
          "400": {
            "description": "Invalid data",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Custom Data"
        ],
        "description": "Update a custom data property for a document.",
        "operationId": "UpdateDocumentCustomDataProperty",
        "summary": "Update document custom data property"
      }
    },
    "/documents/{documentId}/download": {
      "get": {
        "produces": [
          "application/json",
          "application/pdf"
        ],
        "parameters": [
          {
            "description": "Document ID",
            "in": "path",
            "name": "documentId",
            "required": true,
            "type": "string",
            "x-ms-dynamic-values": {
              "operationId": "ListDocuments",
              "value-path": "id",
              "value-title": "name"
            },
            "x-ms-summary": "Document ID",
            "x-ms-url-encoding": "single"
          },
          {
            "description": "Return the binary file directly",
            "enum": [
              "true",
              "false"
            ],
            "in": "query",
            "name": "direct",
            "required": false,
            "type": "string",
            "x-ms-summary": "Return the binary file directly"
          },
          {
            "description": "Return the file content as base64 encoded",
            "enum": [
              "true",
              "false"
            ],
            "in": "query",
            "name": "with_file_content",
            "required": false,
            "type": "string",
            "x-ms-summary": "Return file as base64"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "Content-Disposition": {
                "type": "string"
              }
            },
            "schema": {
              "properties": {
                "document_url": {
                  "description": "URL to download the document (accessible for 10 minutes)",
                  "type": "string"
                },
                "file": {
                  "description": "File name",
                  "type": "string"
                },
                "file_content": {
                  "description": "Base64 encoded file content (returned when with_file_content=true)",
                  "type": "string"
                }
              },
              "type": "object"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Documents"
        ],
        "description": "Document file can always be downloaded but most likely you want to download it when it has status Signed. \n\nYou can select to receive a download-url or get the binary file.\n\nThe download URL is accessable 10 minutes after a request has been made.",
        "operationId": "DownloadDocument",
        "summary": "Download document",
        "x-ms-visibility": "important"
      }
    },
    "/documents/{documentId}/events": {
      "get": {
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "Document ID",
            "in": "path",
            "name": "documentId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "items": {
                "$ref": "#/definitions/Event"
              },
              "type": "array"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Documents"
        ],
        "description": "Get a list of document events for a document.",
        "operationId": "GetEvents",
        "summary": "Get events"
      }
    },
    "/documents/{documentId}/expiration": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "Document ID",
            "in": "path",
            "name": "documentId",
            "required": true,
            "type": "string",
            "x-ms-dynamic-values": {
              "operationId": "ListDocuments",
              "value-path": "id",
              "value-title": "name"
            },
            "x-ms-summary": "Document ID",
            "x-ms-url-encoding": "single"
          },
          {
            "description": "An optional JSON object containing seal information",
            "in": "body",
            "name": "body",
            "schema": {
              "properties": {
                "expiration_date": {
                  "description": "Date and time when the document should expire (UTC)",
                  "format": "date-time",
                  "type": "string",
                  "x-ms-summary": "Expiration date"
                },
                "send_notification": {
                  "default": false,
                  "description": "Should a notification about the update be sent to recipients",
                  "enum": [
                    true,
                    false
                  ],
                  "example": false,
                  "type": "boolean",
                  "x-ms-summary": "Send notification",
                  "x-nullable": true
                }
              },
              "type": "object"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "properties": {
                "status": {
                  "description": "Status of update",
                  "format": "int32",
                  "type": "integer",
                  "x-ms-summary": "Status",
                  "x-nullable": true
                }
              },
              "type": "object"
            }
          },
          "400": {
            "description": "Invalid data",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Documents"
        ],
        "description": "Use this method to update the expiration date and time for a document.",
        "operationId": "UpdateExpiration",
        "summary": "Update document expiration"
      }
    },
    "/documents/{documentId}/fields": {
      "get": {
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "Document ID",
            "in": "path",
            "name": "documentId",
            "required": true,
            "type": "string",
            "x-ms-dynamic-values": {
              "operationId": "ListDocuments",
              "value-path": "id",
              "value-title": "name"
            },
            "x-ms-summary": "Document ID",
            "x-ms-url-encoding": "single"
          },
          {
            "description": "Resolve editor fields to their values",
            "in": "query",
            "name": "resolveEditorFields",
            "type": "boolean",
            "x-ms-summary": "Resolve editor fields"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/Fields"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Documents"
        ],
        "description": "Get a list of fields for a document or template. Can be used both before and after a document has been signed.",
        "operationId": "ListDocumentFields",
        "summary": "Get document fields"
      },
      "post": {
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "Document ID",
            "in": "path",
            "name": "documentId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "properties": {
                "field_height": {
                  "description": "Height of field in points",
                  "type": "number"
                },
                "field_label": {
                  "description": "Label to place next to the field",
                  "type": "string"
                },
                "field_left": {
                  "description": "Left position of field relative to document (in points)",
                  "type": "number"
                },
                "field_top": {
                  "description": "Top position of field relative to document (in points)",
                  "type": "number"
                },
                "field_type": {
                  "description": "The type of field: text, merge, check, signature, initials, formatted",
                  "type": "string"
                },
                "field_value": {
                  "description": "Pre-defined/Filled value",
                  "type": "string"
                },
                "field_width": {
                  "description": "Width of field in points",
                  "type": "number"
                },
                "is_collectable": {
                  "description": "If the field is to be filled out by sender/recipient",
                  "type": "boolean"
                },
                "is_editable": {
                  "description": "If the field can be edited by the sender",
                  "type": "boolean"
                },
                "is_required": {
                  "description": "If the field is required to be filled out",
                  "type": "boolean"
                },
                "page_id": {
                  "description": "Unique page id",
                  "type": "string"
                },
                "page_num": {
                  "description": "Actual page number in document (1-x)",
                  "type": "integer"
                },
                "recipient_id": {
                  "description": "Unique ID of the recipient to fill out this field",
                  "type": "string"
                }
              },
              "required": [
                "field_type",
                "field_top",
                "field_left",
                "field_width",
                "field_height"
              ],
              "type": "object"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/FieldResponse"
            }
          },
          "400": {
            "description": "Invalid data",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Documents"
        ],
        "description": "Creates a new field in a document.",
        "operationId": "CreateField",
        "summary": "Create a field"
      },
      "put": {
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "Document ID",
            "in": "path",
            "name": "documentId",
            "required": true,
            "type": "string",
            "x-ms-summary": "Document ID"
          },
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "properties": {
                "editor_fields": {
                  "items": {
                    "properties": {
                      "id": {
                        "description": "Field ID",
                        "type": "string"
                      },
                      "name": {
                        "description": "Field name",
                        "type": "string"
                      },
                      "value": {
                        "description": "New field value",
                        "type": "string"
                      }
                    },
                    "type": "object"
                  },
                  "type": "array"
                }
              },
              "type": "object"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "No Content"
          },
          "400": {
            "description": "Invalid data",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Documents"
        ],
        "description": "Update fields in a document.",
        "operationId": "UpdateDocumentFields",
        "summary": "Update document fields"
      }
    },
    "/documents/{documentId}/forward": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "Document ID",
            "in": "path",
            "name": "documentId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "properties": {
                "company_name": {
                  "description": "Name of the company",
                  "type": "string"
                },
                "company_number": {
                  "description": "Associated company number",
                  "type": "string"
                },
                "email": {
                  "description": "Email of the new recipient",
                  "type": "string"
                },
                "first_name": {
                  "description": "First name of the new recipient",
                  "type": "string"
                },
                "last_name": {
                  "description": "Last name of the new recipient",
                  "type": "string"
                },
                "mobile": {
                  "description": "Mobile number of the new recipient",
                  "type": "string"
                },
                "recipient_id": {
                  "description": "Only when transfer signature rights",
                  "type": "string"
                },
                "title": {
                  "description": "Title of the recipient",
                  "type": "string"
                },
                "transfer": {
                  "description": "Transfer signature rights to forwarded recipient",
                  "type": "boolean"
                }
              },
              "required": [
                "first_name",
                "last_name",
                "email"
              ],
              "type": "object"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "No Content"
          },
          "400": {
            "description": "Invalid data",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Documents"
        ],
        "description": "Forward a document to a new recipient.",
        "operationId": "ForwardDocument",
        "summary": "Forward document"
      }
    },
    "/documents/{documentId}/log": {
      "get": {
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "Document ID",
            "in": "path",
            "name": "documentId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "items": {
                "$ref": "#/definitions/LogEntry"
              },
              "type": "array"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Documents"
        ],
        "description": "Get a detailed log of events for a specific document.",
        "operationId": "GetDetailedLog",
        "summary": "Get detailed log"
      }
    },
    "/documents/{documentId}/pages": {
      "get": {
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "Document ID",
            "in": "path",
            "name": "documentId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "properties": {
                "page_count": {
                  "type": "integer"
                },
                "pages": {
                  "items": {
                    "$ref": "#/definitions/Page"
                  },
                  "type": "array"
                }
              },
              "type": "object"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Documents"
        ],
        "description": "Get a list of pages for a document.",
        "operationId": "GetPages",
        "summary": "Get pages"
      }
    },
    "/documents/{documentId}/preview": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "Document ID",
            "in": "path",
            "name": "documentId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "properties": {
                "custom_fields": {
                  "items": {
                    "type": "object"
                  },
                  "type": "array"
                },
                "external_id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "recipients": {
                  "items": {
                    "type": "object"
                  },
                  "type": "array"
                },
                "template_id": {
                  "type": "string"
                },
                "type": {
                  "type": "string"
                },
                "value": {
                  "type": "number"
                }
              },
              "type": "object"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/PreviewResponse"
            }
          },
          "400": {
            "description": "Invalid data",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Documents"
        ],
        "description": "Generates a preview of an existing document or template.",
        "operationId": "GetDocumentPreview",
        "summary": "Get document preview"
      }
    },
    "/documents/{documentId}/pricing-tables": {
      "get": {
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "Document ID",
            "in": "path",
            "name": "documentId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/PricingTables"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Documents"
        ],
        "description": "Get all pricing tables for a document.",
        "operationId": "GetDocumentPricingTables",
        "summary": "Get document pricing tables"
      },
      "put": {
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "Document ID",
            "in": "path",
            "name": "documentId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "properties": {
                "pricing_tables": {
                  "items": {
                    "$ref": "#/definitions/PricingTable"
                  },
                  "type": "array"
                }
              },
              "type": "object"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "No Content"
          },
          "400": {
            "description": "Invalid data",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Documents"
        ],
        "description": "Update pricing tables in a document.",
        "operationId": "UpdateDocumentPricingTables",
        "summary": "Update document pricing tables"
      }
    },
    "/documents/{documentId}/recipients": {
      "get": {
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "Document ID",
            "in": "path",
            "name": "documentId",
            "required": true,
            "type": "string",
            "x-ms-dynamic-values": {
              "operationId": "ListDocuments",
              "value-path": "id",
              "value-title": "name"
            },
            "x-ms-summary": "Document ID",
            "x-ms-url-encoding": "single"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/Recipients"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Documents"
        ],
        "description": "Get a list of recipients for a specific document.",
        "operationId": "ListRecipients",
        "summary": "Get document recipients"
      }
    },
    "/documents/{documentId}/recipients/{recipientId}": {
      "delete": {
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "Document ID",
            "in": "path",
            "name": "documentId",
            "required": true,
            "type": "string"
          },
          {
            "description": "Recipient ID",
            "in": "path",
            "name": "recipientId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "204": {
            "description": "No Content"
          },
          "400": {
            "description": "Invalid data",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Documents"
        ],
        "description": "Recall a signer for a document.",
        "operationId": "RecallSigner",
        "summary": "Recall signer"
      }
    },
    "/documents/{documentId}/reminders": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "Document ID",
            "in": "path",
            "name": "documentId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "properties": {
                "not_opened": {
                  "description": "Send if recipients haven't opened the document",
                  "type": "boolean"
                },
                "not_signed": {
                  "description": "Send if recipients haven't signed the document",
                  "type": "boolean"
                },
                "text": {
                  "description": "The text content of the reminder",
                  "type": "string"
                },
                "type": {
                  "description": "Type of reminder to send: email, sms, video",
                  "enum": [
                    "email",
                    "sms",
                    "video"
                  ],
                  "type": "string"
                },
                "video_id": {
                  "description": "Only when using video reminders",
                  "type": "string"
                }
              },
              "required": [
                "type",
                "text"
              ],
              "type": "object"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          },
          "400": {
            "description": "Invalid data",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Documents"
        ],
        "description": "Send a manual reminder for a document.",
        "operationId": "SendReminder",
        "summary": "Send reminder"
      }
    },
    "/documents/{documentId}/revisions": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "Document ID",
            "in": "path",
            "name": "documentId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "schema": {
              "properties": {
                "message": {
                  "default": "",
                  "description": "Revision message",
                  "type": "string"
                },
                "send_document": {
                  "default": false,
                  "description": "Determine if the document should be sent to recipients",
                  "type": "boolean"
                }
              },
              "type": "object"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "No Content"
          },
          "400": {
            "description": "Invalid data",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Documents"
        ],
        "description": "Create a new document revision.",
        "operationId": "CreateRevision",
        "summary": "Create revision"
      }
    },
    "/documents/{documentId}/seal": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "Document ID",
            "in": "path",
            "name": "documentId",
            "required": true,
            "type": "string",
            "x-ms-dynamic-values": {
              "operationId": "ListDocuments",
              "value-path": "id",
              "value-title": "name"
            },
            "x-ms-summary": "Document ID",
            "x-ms-url-encoding": "single"
          },
          {
            "description": "An optional JSON object containing seal information",
            "in": "body",
            "name": "body",
            "schema": {
              "properties": {
                "sender_email": {
                  "description": "Use this to specify the sender user/owner by email address to be used for self-signing the document.",
                  "type": "string"
                },
                "sender_id": {
                  "description": "Use this to specify the sender user/owner by id to be used for self-signing the document.",
                  "type": "string",
                  "x-ms-dynamic-values": {
                    "operationId": "ListUsers",
                    "value-collection": "users",
                    "value-path": "user_id",
                    "value-title": "name"
                  }
                }
              },
              "type": "object"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/Recipients"
            }
          },
          "400": {
            "description": "Invalid data",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Documents"
        ],
        "description": "If you prefer to send the document manually you can use this method to seal the document. Do not use this method if you send the document automatically or if you use the send document method above.\n\nThis API call triggers the document seal action and can only be performed on documents with document_status = draft. The method will return individual access/signing links for each recipient.\n\nIf document was created using self-sign option it will also be self-signed by the authenticated or specified user before sealing.",
        "operationId": "SealDocument",
        "summary": "Seal document",
        "x-ms-visibility": "internal"
      }
    },
    "/documents/{documentId}/send": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "Document ID",
            "in": "path",
            "name": "documentId",
            "required": true,
            "type": "string",
            "x-ms-dynamic-values": {
              "operationId": "ListDocuments",
              "value-path": "id",
              "value-title": "name"
            },
            "x-ms-summary": "Document ID",
            "x-ms-url-encoding": "single"
          },
          {
            "description": "An optional JSON object containing sending information",
            "in": "body",
            "name": "body",
            "schema": {
              "properties": {
                "sender_email": {
                  "description": "Use this to specify the sender user/owner by email address to be used for self-signing the document.",
                  "format": "email",
                  "type": "string"
                },
                "sender_id": {
                  "description": "Use this to specify the sender user/owner by id to be used for self-signing the document.",
                  "type": "string",
                  "x-ms-dynamic-values": {
                    "operationId": "ListUsers",
                    "value-collection": "users",
                    "value-path": "user_id",
                    "value-title": "name"
                  }
                }
              },
              "type": "object"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/Document"
            }
          },
          "400": {
            "description": "Invalid data",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Documents"
        ],
        "description": "When you send a document via GetAccept, we deliver an email to all recipients, each containing a unique, secured link. This API call triggers the document send action and can only be performed on documents with document_status = draft. The document will be sent to recipients you provided when it was created.\n\nIf document was created using self-sign option it will also be self-signed by the authenticated or specified user before sending.",
        "operationId": "SendDocument",
        "summary": "Send existing document",
        "x-ms-visibility": "advanced"
      }
    },
    "/documents/{documentId}/status": {
      "get": {
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "Document ID",
            "in": "path",
            "name": "documentId",
            "required": true,
            "type": "string",
            "x-ms-summary": "Document ID"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/StatusResponse"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Documents"
        ],
        "description": "Get the current status of a document.",
        "operationId": "GetDocumentStatus",
        "summary": "Get document status"
      }
    },
    "/email/templates": {
      "get": {
        "produces": [
          "application/json"
        ],
        "parameters": [],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "additionalProperties": {
                "items": {
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    },
                    "type": {
                      "type": "string"
                    }
                  },
                  "type": "object"
                },
                "type": "array"
              },
              "type": "object"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Templates"
        ],
        "description": "Get a list of email templates on the entity.",
        "operationId": "ListEmailTemplates",
        "summary": "List email templates"
      },
      "post": {
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "properties": {
                "code": {
                  "description": "Template HTML code",
                  "type": "string"
                },
                "name": {
                  "description": "Template name",
                  "type": "string"
                }
              },
              "required": [
                "name",
                "code"
              ],
              "type": "object"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/EmailTemplate"
            }
          },
          "400": {
            "description": "Invalid data",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Templates"
        ],
        "description": "Create a new email template.",
        "operationId": "CreateEmailTemplate",
        "summary": "Create email template"
      }
    },
    "/email/templates/{emailTemplateId}": {
      "get": {
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "Email Template ID",
            "in": "path",
            "name": "emailTemplateId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/EmailTemplate"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Templates"
        ],
        "description": "Get detailed information about an email template.",
        "operationId": "GetEmailTemplateDetails",
        "summary": "Get email template details"
      },
      "put": {
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "Email Template ID",
            "in": "path",
            "name": "emailTemplateId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "properties": {
                "code": {
                  "description": "Template HTML code",
                  "type": "string"
                },
                "name": {
                  "description": "Template name",
                  "type": "string"
                }
              },
              "type": "object"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "No Content"
          },
          "400": {
            "description": "Invalid data",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Templates"
        ],
        "description": "Update an existing email template.",
        "operationId": "UpdateEmailTemplate",
        "summary": "Update email template"
      }
    },
    "/folders": {
      "get": {
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "Show folders of a specific type: archive or template",
            "enum": [
              "archive",
              "template"
            ],
            "in": "query",
            "name": "type",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "properties": {
                "folders": {
                  "items": {
                    "$ref": "#/definitions/Folder"
                  },
                  "type": "array"
                }
              },
              "type": "object"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Others"
        ],
        "description": "List and get details of existing folders in GetAccept.",
        "operationId": "ListFolders",
        "summary": "List folders"
      }
    },
    "/folders/{folderId}": {
      "get": {
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "Folder ID",
            "in": "path",
            "name": "folderId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "properties": {
                "folder": {
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    },
                    "type": {
                      "type": "string"
                    }
                  },
                  "type": "object"
                },
                "subfolders": {
                  "items": {
                    "type": "object"
                  },
                  "type": "array"
                }
              },
              "type": "object"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Others"
        ],
        "description": "Get subfolder and current path for a specific folder.",
        "operationId": "GetFolderDetails",
        "summary": "Get folder details"
      }
    },
    "/notifications": {
      "get": {
        "produces": [
          "application/json"
        ],
        "parameters": [],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "items": {
                "type": "object"
              },
              "type": "array"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Others"
        ],
        "description": "List notification for current user",
        "operationId": "ListNotifications",
        "summary": "List notifications"
      }
    },
    "/refresh": {
      "get": {
        "produces": [
          "application/json"
        ],
        "parameters": [],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "properties": {
                "access_token": {
                  "type": "string"
                },
                "expires_in": {
                  "format": "int64",
                  "type": "integer"
                }
              },
              "type": "object"
            }
          }
        },
        "tags": [
          "Authentication"
        ],
        "description": "You can request a refreshed of the access token before the original token has expired.",
        "operationId": "RefreshToken",
        "summary": "Refresh an access token",
        "x-ms-visibility": "internal"
      }
    },
    "/refresh/{entityId}": {
      "get": {
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "Entity ID to switch to",
            "in": "path",
            "name": "entityId",
            "required": true,
            "type": "string",
            "x-ms-summary": "Entity ID"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "properties": {
                "access_token": {
                  "description": "New access token for the entity",
                  "type": "string"
                },
                "expires_in": {
                  "format": "int64",
                  "type": "integer"
                }
              },
              "type": "object"
            }
          }
        },
        "tags": [
          "Authentication"
        ],
        "description": "Change entity using the same refresh method with additional parameter for the entity. The response will include a new access token that should be used when accessing the new entity.",
        "operationId": "SwitchEntity",
        "summary": "Switch entity",
        "x-ms-visibility": "internal"
      }
    },
    "/revoke": {
      "get": {
        "produces": [
          "application/json"
        ],
        "parameters": [],
        "responses": {
          "200": {
            "description": "OK"
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Authentication"
        ],
        "description": "Revoke an access token before it has expired.",
        "operationId": "RevokeToken",
        "summary": "Revoke access token",
        "x-ms-visibility": "internal"
      }
    },
    "/subscriptions": {
      "get": {
        "produces": [
          "application/json"
        ],
        "parameters": [],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/Subscriptions"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Subscriptions"
        ],
        "description": "Receive a list of available subscriptions for the current entity.",
        "operationId": "ListSubscriptions",
        "summary": "List subscriptions",
        "x-ms-visibility": "internal"
      },
      "post": {
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "A JSON object containing subscription information",
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "properties": {
                "host": {
                  "description": "The host name to send the post to",
                  "type": "string",
                  "x-ms-visibility": "internal"
                },
                "event": {
                  "description": "Event trigger",
                  "enum": [
                    "document.created",
                    "document.sent",
                    "document.viewed",
                    "document.reviewed",
                    "document.signed",
                    "document.approved",
                    "document.expired",
                    "document.rejected",
                    "document.downloaded",
                    "document.printed",
                    "document.forwarded",
                    "document.partially_signed",
                    "document.commented",
                    "document.hardbounced",
                    "document.imported"
                  ],
                  "example": "document.signed",
                  "type": "string",
                  "x-ms-dynamic-values": {
                    "operationId": "ListSubscriptionEvents",
                    "value-path": "value",
                    "value-title": "name"
                  },
                  "x-ms-summary": "Select event",
                  "x-ms-visibility": "important"
                },
                "global": {
                  "default": true,
                  "description": "If the webhook should catch events for all entity users.",
                  "enum": [
                    true,
                    false
                  ],
                  "example": true,
                  "type": "boolean",
                  "x-ms-summary": "All entity users",
                  "x-nullable": true
                },
                "notification_email": {
                  "description": "If the event fails, send a notification to this email instead of the sender",
                  "example": "hostmaster@example.com",
                  "type": "string",
                  "x-ms-summary": "Error email",
                  "x-ms-visibility": "advanced"
                },
                "payload": {
                  "description": "Additional payload data to post",
                  "type": "string",
                  "x-ms-summary": "Payload",
                  "x-ms-visibility": "advanced"
                },
                "target_url": {
                  "description": "The URL to post payload to on event",
                  "example": "https://abc.x.pipedream.net/",
                  "type": "string",
                  "x-ms-notification-url": true,
                  "x-ms-visibility": "internal"
                }
              },
              "required": [
                "event",
                "target_url"
              ],
              "type": "object"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/Subscription"
            }
          },
          "400": {
            "description": "Invalid data",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Subscriptions"
        ],
        "description": "This call will create a new subscription.\nThe response will be wrapped in an array even for single object according to REST hook standards.\n\n>Events\n  * `document.created` - Document is created\n  * `document.sent` - Document is sent\n  * `document.viewed` - Document is sent\n  * `document.signed` - Document is signed\n  * `document.approved` - Document is approved\n  * `document.expired` - Document has expired\n  * `document.rejected` - Document is rejected\n  * `document.downloaded` - Document is downloaded\n  * `document.printed` - Document is printed\n  * `document.forwarded` - Document is forwarded\n  * `document.partially_signed` - Document has been partially signed\n  * `document.commented` - Document is commented\n  * `document.hardbounced` - Document is hardbounced\n  * `document.imported` - Document is imported",
        "operationId": "CreateSubscription",
        "summary": "Subscribe to document events",
        "x-ms-summary": "When a document status changes",
        "x-ms-trigger": "single",
        "x-ms-trigger-hint": "Trigger when a document status is changed",
        "x-ms-visibility": "important"
      },
      "x-ms-notification-content": {
        "schema": {
          "$ref": "#/definitions/Webhook"
        }
      }
    },
    "/subscriptions/errors": {
      "get": {
        "produces": [
          "application/json"
        ],
        "parameters": [],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "items": {
                "properties": {
                  "created_at": {
                    "type": "string"
                  },
                  "event": {
                    "type": "string"
                  },
                  "payload": {
                    "type": "string"
                  },
                  "result": {
                    "type": "string"
                  },
                  "retry": {
                    "type": "string"
                  },
                  "status": {
                    "type": "string"
                  },
                  "target_url": {
                    "type": "string"
                  }
                },
                "type": "object"
              },
              "type": "array"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Subscriptions"
        ],
        "description": "Get the last errors for active subscriptions.",
        "operationId": "GetSubscriptionErrors",
        "summary": "Get subscription errors"
      }
    },
    "/subscriptions/events": {
      "get": {
        "produces": [
          "application/json"
        ],
        "parameters": [],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "items": {
                "properties": {
                  "name": {
                    "type": "string"
                  },
                  "value": {
                    "type": "string"
                  }
                },
                "type": "object"
              },
              "type": "array"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Subscriptions"
        ],
        "description": "This call will return a list of available subscription events",
        "operationId": "ListSubscriptionEvents",
        "summary": "List available subscription events",
        "x-ms-visibility": "internal"
      }
    },
    "/subscriptions/events/rejected": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "A JSON object containing subscription information",
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "properties": {
                "host": {
                  "description": "The host name to send the post to",
                  "type": "string",
                  "x-ms-visibility": "internal"
                },
                "event": {
                  "default": "document.rejected",
                  "description": "Event trigger",
                  "type": "string",
                  "x-ms-summary": "Event trigger",
                  "x-ms-visibility": "internal"
                },
                "global": {
                  "default": true,
                  "description": "If the webhook should catch events for all entity users.",
                  "enum": [
                    true,
                    false
                  ],
                  "example": true,
                  "type": "boolean",
                  "x-ms-summary": "All entity users",
                  "x-nullable": true
                },
                "notification_email": {
                  "description": "If the event fails, send a notification to this email instead of the sender",
                  "example": "hostmaster@example.com",
                  "type": "string",
                  "x-ms-summary": "Error email",
                  "x-ms-visibility": "advanced"
                },
                "payload": {
                  "description": "Additional payload data to post",
                  "type": "string",
                  "x-ms-summary": "Payload",
                  "x-ms-visibility": "advanced"
                },
                "target_url": {
                  "description": "The URL to post payload to on event",
                  "example": "https://abc.x.pipedream.net/",
                  "type": "string",
                  "x-ms-notification-url": true,
                  "x-ms-visibility": "internal"
                }
              },
              "required": [
                "event",
                "target_url"
              ],
              "type": "object"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/Subscription"
            }
          },
          "400": {
            "description": "Invalid data",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Others"
        ],
        "description": "Triggers when a document has been rejected by any of the recipients",
        "operationId": "CreateRejectedSubscription",
        "summary": "When a document has been rejected",
        "x-ms-summary": "When a document has been rejected",
        "x-ms-trigger": "single",
        "x-ms-visibility": "important"
      },
      "x-ms-notification-content": {
        "schema": {
          "$ref": "#/definitions/Webhook"
        }
      }
    },
    "/subscriptions/events/reviewed": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "A JSON object containing subscription information",
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "properties": {
                "host": {
                  "description": "The host name to send the post to",
                  "type": "string",
                  "x-ms-visibility": "internal"
                },
                "event": {
                  "default": "document.reviewed",
                  "description": "Event trigger",
                  "type": "string",
                  "x-ms-summary": "Event trigger",
                  "x-ms-visibility": "internal"
                },
                "global": {
                  "default": true,
                  "description": "If the webhook should catch events for all entity users.",
                  "enum": [
                    true,
                    false
                  ],
                  "example": true,
                  "type": "boolean",
                  "x-ms-summary": "All entity users",
                  "x-nullable": true
                },
                "notification_email": {
                  "description": "If the event fails, send a notification to this email instead of the sender",
                  "example": "hostmaster@example.com",
                  "type": "string",
                  "x-ms-summary": "Error email",
                  "x-ms-visibility": "advanced"
                },
                "payload": {
                  "description": "Additional payload data to post",
                  "type": "string",
                  "x-ms-summary": "Payload",
                  "x-ms-visibility": "advanced"
                },
                "target_url": {
                  "description": "The URL to post payload to on event",
                  "example": "https://abc.x.pipedream.net/",
                  "type": "string",
                  "x-ms-notification-url": true,
                  "x-ms-visibility": "internal"
                }
              },
              "required": [
                "event",
                "target_url"
              ],
              "type": "object"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/Subscription"
            }
          },
          "400": {
            "description": "Invalid data",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Others"
        ],
        "description": "Triggers when a document has been reviewed by any of the recipients",
        "operationId": "CreateReviewedSubscription",
        "summary": "When a document has been reviewed",
        "x-ms-summary": "When a document has been reviewed",
        "x-ms-trigger": "single",
        "x-ms-visibility": "important"
      },
      "x-ms-notification-content": {
        "schema": {
          "$ref": "#/definitions/Webhook"
        }
      }
    },
    "/subscriptions/events/signed": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "A JSON object containing subscription information",
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "properties": {
                "host": {
                  "description": "The host name to send the post to",
                  "type": "string",
                  "x-ms-visibility": "internal"
                },
                "event": {
                  "default": "document.signed",
                  "description": "Event trigger",
                  "type": "string",
                  "x-ms-summary": "Event trigger",
                  "x-ms-visibility": "internal"
                },
                "global": {
                  "default": true,
                  "description": "If the webhook should catch events for all entity users.",
                  "enum": [
                    true,
                    false
                  ],
                  "example": true,
                  "type": "boolean",
                  "x-ms-summary": "All entity users",
                  "x-nullable": true
                },
                "notification_email": {
                  "description": "If the event fails, send a notification to this email instead of the sender",
                  "example": "hostmaster@example.com",
                  "type": "string",
                  "x-ms-summary": "Error email",
                  "x-ms-visibility": "advanced"
                },
                "payload": {
                  "description": "Additional payload data to post",
                  "type": "string",
                  "x-ms-summary": "Payload",
                  "x-ms-visibility": "advanced"
                },
                "target_url": {
                  "description": "The URL to post payload to on event",
                  "example": "https://abc.x.pipedream.net/",
                  "type": "string",
                  "x-ms-notification-url": true,
                  "x-ms-visibility": "internal"
                }
              },
              "required": [
                "event",
                "target_url"
              ],
              "type": "object"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/Subscription"
            }
          },
          "400": {
            "description": "Invalid data",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Others"
        ],
        "description": "Triggers when a document has been signed by all signing parties",
        "operationId": "CreateSignedSubscription",
        "summary": "When a document has been signed",
        "x-ms-summary": "When a document has been signed",
        "x-ms-trigger": "single",
        "x-ms-visibility": "important"
      },
      "x-ms-notification-content": {
        "schema": {
          "$ref": "#/definitions/Webhook"
        }
      }
    },
    "/subscriptions/test": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "properties": {
                "document_id": {
                  "description": "The document id to trigger the event for",
                  "type": "string"
                },
                "event": {
                  "description": "The event to trigger",
                  "type": "string"
                },
                "recipient_id": {
                  "description": "The recipient to trigger the event for",
                  "type": "string"
                }
              },
              "required": [
                "event",
                "document_id"
              ],
              "type": "object"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          },
          "400": {
            "description": "Invalid data",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Subscriptions"
        ],
        "description": "Simulate or test a subscription / webhook event.",
        "operationId": "TestSubscription",
        "summary": "Test subscription"
      }
    },
    "/subscriptions/{subscriptionId}": {
      "delete": {
        "parameters": [
          {
            "description": "Subscription ID",
            "in": "path",
            "name": "subscriptionId",
            "required": true,
            "type": "string",
            "x-ms-summary": "Subscription ID",
            "x-ms-url-encoding": "single"
          }
        ],
        "responses": {
          "204": {
            "description": "No Content"
          }
        },
        "tags": [
          "Subscriptions"
        ],
        "description": "Delete a single subscription.",
        "operationId": "DeleteSubscription",
        "summary": "Delete subscription",
        "x-ms-visibility": "internal"
      },
      "get": {
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "Subscription ID",
            "in": "path",
            "name": "subscriptionId",
            "required": true,
            "type": "string",
            "x-ms-summary": "Subscription ID",
            "x-ms-url-encoding": "single"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/Subscription"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Subscriptions"
        ],
        "description": "This call will return details of a single subscription",
        "operationId": "GetSubscriptionDetails",
        "summary": "Get subscription details",
        "x-ms-visibility": "internal"
      }
    },
    "/teams": {
      "get": {
        "produces": [
          "application/json"
        ],
        "parameters": [],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "properties": {
                "teams": {
                  "items": {
                    "$ref": "#/definitions/Team"
                  },
                  "type": "array"
                }
              },
              "type": "object"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Users"
        ],
        "description": "List of current teams for the entity.",
        "operationId": "ListTeams",
        "summary": "List teams"
      }
    },
    "/templates": {
      "get": {
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "default": "true",
            "description": "Show all templates for entity",
            "in": "query",
            "name": "showall",
            "type": "string",
            "x-ms-summary": "Show all"
          },
          {
            "description": "Show templates in a specific folder",
            "in": "query",
            "name": "folder_id",
            "type": "string",
            "x-ms-summary": "Folder ID"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "properties": {
                "templates": {
                  "items": {
                    "properties": {
                      "tags": {
                        "type": "string"
                      },
                      "created_at": {
                        "type": "string"
                      },
                      "external_editor_type": {
                        "type": "string"
                      },
                      "field_count": {
                        "format": "int32",
                        "type": "integer"
                      },
                      "id": {
                        "type": "string"
                      },
                      "is_editable": {
                        "type": "boolean"
                      },
                      "is_private": {
                        "type": "boolean"
                      },
                      "name": {
                        "type": "string"
                      },
                      "page_count": {
                        "format": "int32",
                        "type": "integer"
                      },
                      "role_count": {
                        "format": "int32",
                        "type": "integer"
                      },
                      "sender_name": {
                        "type": "string"
                      },
                      "sender_thumb_url": {
                        "type": "string"
                      },
                      "thumb_url": {
                        "type": "string"
                      },
                      "type": {
                        "type": "string"
                      },
                      "user_id": {
                        "type": "string"
                      },
                      "video_id": {
                        "type": "string"
                      },
                      "video_thumb_url": {
                        "type": "string"
                      }
                    },
                    "type": "object"
                  },
                  "type": "array"
                }
              },
              "type": "object"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Templates"
        ],
        "description": "Receive a list of available document templates. You can add new templates under the Templates-section in GetAccept.",
        "operationId": "ListTemplates",
        "summary": "List templates",
        "x-ms-visibility": "important"
      }
    },
    "/templates/{templateId}/custom-images": {
      "get": {
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "Template ID",
            "in": "path",
            "name": "templateId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "properties": {
                "custom_images": {
                  "items": {
                    "properties": {
                      "id": {
                        "description": "ID of the custom image",
                        "type": "string"
                      },
                      "name": {
                        "description": "Name of the custom image",
                        "type": "string"
                      }
                    },
                    "type": "object"
                  },
                  "type": "array"
                }
              },
              "type": "object"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Templates"
        ],
        "description": "Get a list of custom images on a template.",
        "operationId": "GetTemplateCustomImages",
        "summary": "Get template custom images"
      }
    },
    "/templates/{templateId}/fields": {
      "get": {
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "Template ID",
            "in": "path",
            "name": "templateId",
            "required": true,
            "type": "string",
            "x-ms-dynamic-values": {
              "operationId": "ListTemplates",
              "value-collection": "templates",
              "value-path": "id",
              "value-title": "name"
            },
            "x-ms-summary": "Template ID",
            "x-ms-url-encoding": "single"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/Fields"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Templates"
        ],
        "description": "Receive a list of fields for a specific template.",
        "operationId": "ListFields",
        "summary": "Get template fields"
      }
    },
    "/templates/{templateId}/fields_roles": {
      "get": {
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "Template ID",
            "in": "path",
            "name": "templateId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "properties": {
                "fields": {
                  "items": {
                    "properties": {
                      "field_id": {
                        "type": "string"
                      },
                      "role_name": {
                        "type": "string"
                      }
                    },
                    "type": "object"
                  },
                  "type": "array"
                }
              },
              "type": "object"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Templates"
        ],
        "description": "Receive a list of fields and associated role for a specific template.",
        "operationId": "ListTemplateFieldRoles",
        "summary": "Get template field roles"
      }
    },
    "/templates/{templateId}/pricing-tables": {
      "get": {
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "Template ID",
            "in": "path",
            "name": "templateId",
            "required": true,
            "type": "string",
            "x-ms-dynamic-values": {
              "operationId": "ListTemplates",
              "value-collection": "templates",
              "value-path": "id",
              "value-title": "name"
            },
            "x-ms-summary": "Template ID",
            "x-ms-url-encoding": "single"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/PricingTables"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Templates"
        ],
        "description": "Receive a list of pricing-table items for a specific template.",
        "operationId": "GetPricingTables",
        "summary": "Get template pricing tables"
      }
    },
    "/templates/{templateId}/roles": {
      "get": {
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "Template ID",
            "in": "path",
            "name": "templateId",
            "required": true,
            "type": "string",
            "x-ms-dynamic-values": {
              "operationId": "ListTemplates",
              "value-collection": "templates",
              "value-path": "id",
              "value-title": "name"
            },
            "x-ms-summary": "Template ID",
            "x-ms-url-encoding": "single"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "properties": {
                "roles": {
                  "items": {
                    "properties": {
                      "email": {
                        "type": "string"
                      },
                      "first_name": {
                        "type": "string"
                      },
                      "last_name": {
                        "type": "string"
                      },
                      "mobile": {
                        "type": "string"
                      },
                      "role": {
                        "type": "string"
                      },
                      "role_id": {
                        "type": "string"
                      },
                      "role_name": {
                        "type": "string"
                      }
                    },
                    "type": "object"
                  },
                  "type": "array"
                }
              },
              "type": "object"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Templates"
        ],
        "description": "Receive a list of roles for a specific template.",
        "operationId": "ListRoles",
        "summary": "Get template roles"
      }
    },
    "/test": {
      "get": {
        "produces": [
          "application/json"
        ],
        "parameters": [],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/TestResponse"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Authentication"
        ],
        "description": "Test authentication and get current entity and user ID.",
        "operationId": "TestAuthentication",
        "summary": "Test authentication"
      }
    },
    "/upload": {
      "post": {
        "consumes": [
          "application/json",
          "multipart/form-data"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "A JSON object containing the uploaded document information",
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "properties": {
                "file_content": {
                  "description": "Send the file as base64 encoded. Note that base64 encoding files will increase the file size with about 30%",
                  "type": "string",
                  "x-ms-summary": "File content"
                },
                "file_name": {
                  "description": "Filename of the document, with the extension. This will be helpful for converting different file-types.",
                  "type": "string",
                  "x-ms-summary": "File name"
                },
                "file_url": {
                  "description": "Url to document file. File must be available for download without any authorization",
                  "type": "string",
                  "x-ms-summary": "File URL"
                }
              },
              "type": "object"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "properties": {
                "file_id": {
                  "description": "ID of the uploaded file to be used in file_ids when creating a document",
                  "type": "string"
                },
                "file_status": {
                  "description": "Status of the uploaded file",
                  "type": "string"
                }
              },
              "type": "object"
            }
          },
          "400": {
            "description": "Invalid data",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Documents"
        ],
        "description": "You can upload one file at a time and get a file id. The file id is used to connect a file with a GetAccept document which is sent to recipients. If you want to upload mutliple files you run multiple POST. We only accept files up to 10 MB as default. Uploaded file need to be imported/added to a document within 48 hours after uploading.\n\nWe recommended you to upload PDF files in order to guarantee the same look when sent. Other file types can be converted, such as:\n\nMirosoft Office: doc, docx, xl, xls, xlsx, ppt, pptx\nMac: numbers, key\nImages: jpg, jpeg, png\nOther: html, tex, csv",
        "operationId": "UploadDocument",
        "summary": "Upload a document file",
        "x-ms-visibility": "important"
      }
    },
    "/upload/archive": {
      "post": {
        "consumes": [
          "application/json",
          "multipart/form-data"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "properties": {
                "tags": {
                  "description": "Document tags",
                  "type": "string"
                },
                "company_name": {
                  "description": "Associated company",
                  "type": "string"
                },
                "company_number": {
                  "description": "Associated company number",
                  "type": "string"
                },
                "contract_end_date": {
                  "description": "End date of contract",
                  "type": "string"
                },
                "contract_start_date": {
                  "description": "Start date of contract",
                  "type": "string"
                },
                "file_content": {
                  "description": "Base64 encoded file content",
                  "type": "string"
                },
                "file_ids": {
                  "description": "Previously uploaded file IDs",
                  "type": "string"
                },
                "file_name": {
                  "description": "Filename of the archived document",
                  "type": "string"
                },
                "file_url": {
                  "description": "URL to file",
                  "type": "string"
                },
                "name": {
                  "description": "Name of the document",
                  "type": "string"
                },
                "sender_id": {
                  "description": "Sender user/owner ID",
                  "type": "string"
                },
                "sign_date": {
                  "description": "Date and time when the document was signed",
                  "type": "string"
                },
                "type": {
                  "description": "Type of document: sales, hr, introduction, other",
                  "type": "string"
                },
                "value": {
                  "description": "Monetary value of document",
                  "type": "number"
                }
              },
              "type": "object"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/Document"
            }
          },
          "400": {
            "description": "Invalid data",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Archive"
        ],
        "description": "Upload already signed files to the document archive / contract management.",
        "operationId": "UploadToArchive",
        "summary": "Upload to archive"
      }
    },
    "/upload/attachment": {
      "post": {
        "consumes": [
          "application/json",
          "multipart/form-data"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "A JSON object containing the uploaded attachment information",
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "properties": {
                "file_content": {
                  "description": "Send the file as base64 encoded. Note that base64 encoding files will increase the file size with about 30%",
                  "type": "string",
                  "x-ms-summary": "File content"
                },
                "file_name": {
                  "description": "Filename of the document, with the extension. This will be helpful for converting different file-types.",
                  "type": "string",
                  "x-ms-summary": "File name"
                },
                "file_url": {
                  "description": "Url to document file. File must be available for download without any authorization",
                  "type": "string",
                  "x-ms-summary": "File URL"
                }
              },
              "type": "object"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "properties": {
                "filename": {
                  "description": "File name of the attachment",
                  "type": "string",
                  "x-ms-summary": "File name"
                },
                "id": {
                  "description": "ID of the uploaded attachment to be used in attachment_id when creating a document",
                  "type": "string",
                  "x-ms-summary": "Attachment ID"
                },
                "title": {
                  "description": "Title of the attachment",
                  "type": "string",
                  "x-ms-summary": "Attachment title"
                },
                "type": {
                  "description": "Type of the attachment",
                  "type": "string",
                  "x-ms-summary": "Attachment type"
                }
              },
              "type": "object"
            }
          },
          "400": {
            "description": "Invalid data",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Attachments"
        ],
        "description": "You can upload attachment files to include with documents you send.\nSuccessful request will return the attachment_id. Use attachment_id to assign an attachment to a document.",
        "operationId": "UploadAttachment",
        "summary": "Upload an attachment"
      }
    },
    "/upload/video": {
      "post": {
        "consumes": [
          "application/json",
          "multipart/form-data"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "A JSON object containing the uploaded video information",
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "properties": {
                "file_content": {
                  "description": "Send the file as base64 encoded. Note that base64 encoding files will increase the file size with about 30%",
                  "type": "string",
                  "x-ms-summary": "File content"
                },
                "file_name": {
                  "description": "Filename of the document, with the extension. This will be helpful for converting different file-types.",
                  "type": "string",
                  "x-ms-summary": "File name"
                },
                "file_url": {
                  "description": "Url to document file. File must be available for download without any authorization",
                  "type": "string",
                  "x-ms-summary": "File URL"
                }
              },
              "type": "object"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "properties": {
                "file_status": {
                  "description": "Status of the video",
                  "type": "string",
                  "x-ms-summary": "File status"
                },
                "filename": {
                  "description": "File name of the video",
                  "type": "string",
                  "x-ms-summary": "File name"
                },
                "job_id": {
                  "description": "Id of the processing job converting and compressing the video. Poll for job status updates using /video/job/<ID>.",
                  "type": "string",
                  "x-ms-summary": "Job ID"
                },
                "video_id": {
                  "description": "ID of the uploaded video to be used in video_id when creating a document",
                  "type": "string",
                  "x-ms-summary": "Video ID"
                }
              },
              "type": "object"
            }
          },
          "400": {
            "description": "Invalid data",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Videos"
        ],
        "description": "You can upload attachment files to include with documents you send.\nSuccessful request will return the attachment_id. Use attachment_id to assign an attachment to a document.",
        "operationId": "UploadVideo",
        "summary": "Upload a video"
      }
    },
    "/users": {
      "get": {
        "produces": [
          "application/json"
        ],
        "parameters": [],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/Users"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Users"
        ],
        "description": "Fetch a list of active users for the current authenticated entity",
        "operationId": "ListUsers",
        "summary": "List users"
      },
      "post": {
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "A JSON object containing user information",
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "properties": {
                "company_name": {
                  "description": "Associated company name",
                  "type": "string"
                },
                "company_number": {
                  "description": "Associated company number",
                  "type": "string"
                },
                "email": {
                  "description": "Email address of the contact",
                  "type": "string"
                },
                "first_name": {
                  "description": "First name of the contact",
                  "type": "string"
                },
                "fullname": {
                  "description": "Use to specify full name instead of first/last name",
                  "type": "string"
                },
                "last_name": {
                  "description": "Last name of the contact",
                  "type": "string"
                },
                "mobile": {
                  "description": "Mobile number in international format",
                  "type": "string"
                },
                "note": {
                  "description": "Optional internal note for contact",
                  "type": "string"
                },
                "phone": {
                  "description": "Phone number in international format",
                  "type": "string"
                },
                "title": {
                  "description": "The title of the contact, ex. CEO, Sales manager",
                  "type": "string"
                }
              },
              "type": "object"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/User"
            }
          },
          "400": {
            "description": "Invalid data",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Users"
        ],
        "description": "This will create a new contact in the database for the current entity",
        "operationId": "CreateUser",
        "summary": "Create user",
        "x-ms-visibility": "important"
      }
    },
    "/users/{userId}": {
      "delete": {
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "User ID",
            "in": "path",
            "name": "userId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "204": {
            "description": "No Content"
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Users"
        ],
        "description": "Delete a user.",
        "operationId": "DeleteUser",
        "summary": "Delete user"
      },
      "get": {
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "User ID",
            "in": "path",
            "name": "userId",
            "required": true,
            "type": "string",
            "x-ms-dynamic-values": {
              "operationId": "ListUsers",
              "value-collection": "users",
              "value-path": "user_id",
              "value-title": "name"
            },
            "x-ms-summary": "User ID",
            "x-ms-url-encoding": "single"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/User"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Users"
        ],
        "description": "This call will return details of a single user.\nReceive details and available entities of the current authenticated user using user-id *me*",
        "operationId": "GetUserDetails",
        "summary": "Get user details"
      }
    },
    "/users/{userId}/statistics": {
      "get": {
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "User ID",
            "in": "path",
            "name": "userId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "properties": {
                "daterange": {
                  "type": "object"
                },
                "statistics": {
                  "type": "object"
                }
              },
              "type": "object"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Users"
        ],
        "description": "Get statistics for a single user.",
        "operationId": "GetUserStatistics",
        "summary": "Get user statistics"
      }
    },
    "/video/job/{videoId}": {
      "get": {
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "Video ID",
            "in": "path",
            "name": "videoId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/VideoJobStatus"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Videos"
        ],
        "description": "Get current processing status of an uploaded video.",
        "operationId": "GetVideoJobStatus",
        "summary": "Get video job status"
      }
    },
    "/videos": {
      "get": {
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "default": 0,
            "description": "Start list from record x",
            "in": "query",
            "name": "offset",
            "type": "integer"
          },
          {
            "description": "Number of records to list",
            "in": "query",
            "name": "limit",
            "type": "integer"
          },
          {
            "description": "Include presigned url for video",
            "in": "query",
            "name": "include_video_url",
            "type": "boolean"
          },
          {
            "description": "Include url for thumbnail",
            "in": "query",
            "name": "include_thumb_url",
            "type": "boolean"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "properties": {
                "videos": {
                  "items": {
                    "properties": {
                      "created_at": {
                        "type": "string"
                      },
                      "editable": {
                        "type": "boolean"
                      },
                      "published": {
                        "type": "boolean"
                      },
                      "saved": {
                        "type": "boolean"
                      },
                      "thumb_url": {
                        "type": "string"
                      },
                      "video_id": {
                        "type": "string"
                      },
                      "video_title": {
                        "type": "string"
                      },
                      "video_type": {
                        "type": "string"
                      },
                      "video_url": {
                        "type": "string"
                      }
                    },
                    "type": "object"
                  },
                  "type": "array"
                }
              },
              "type": "object"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Videos"
        ],
        "description": "Receive a list of available videos on the entity. You can add new videos in the mobile app or inside GetAccept.",
        "operationId": "ListVideos",
        "summary": "List videos"
      }
    },
    "/videos/{videoId}": {
      "get": {
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "description": "Video ID",
            "in": "path",
            "name": "videoId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/Video"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "The specified resource was not found",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "tags": [
          "Videos"
        ],
        "description": "Get a specific video based on video id.",
        "operationId": "GetVideo",
        "summary": "Get video"
      }
    }
  },
  "definitions": {
    "Attachment": {
      "description": "Document attachment",
      "properties": {
        "access_recipient_names": {
          "description": "Recipients with access to the attachment",
          "items": {
            "type": "string"
          },
          "type": "array",
          "x-ms-summary": "Access Recipients",
          "x-ms-visibility": "advanced"
        },
        "attachment_description": {
          "description": "Description of the attachment",
          "type": "string",
          "x-ms-summary": "Description"
        },
        "attachment_download_url": {
          "description": "URL to download the attachment",
          "type": "string",
          "x-ms-summary": "Download URL"
        },
        "attachment_extension": {
          "description": "File extension of the attachment",
          "type": "string",
          "x-ms-summary": "File Extension",
          "x-ms-visibility": "advanced"
        },
        "attachment_filename": {
          "description": "Filename of the attachment",
          "type": "string",
          "x-ms-summary": "Filename",
          "x-ms-visibility": "advanced"
        },
        "attachment_id": {
          "description": "ID of the attachment",
          "type": "string",
          "x-ms-summary": "ID"
        },
        "attachment_preview_url": {
          "description": "Internal URL to preview the attachment",
          "type": "string",
          "x-ms-summary": "Preview URL",
          "x-ms-visibility": "advanced"
        },
        "attachment_title": {
          "description": "Title of the attachment",
          "type": "string",
          "x-ms-summary": "Title"
        },
        "attachment_type": {
          "description": "Type of the attachment",
          "type": "string",
          "x-ms-summary": "Type"
        },
        "attachment_url": {
          "description": "Url of the attachment",
          "type": "string",
          "x-ms-summary": "URL"
        },
        "last_attachment_view": {
          "description": "Date and time when the attachment was last viewed",
          "type": "string",
          "x-ms-summary": "Last View",
          "x-ms-visibility": "advanced"
        },
        "restrict_access": {
          "description": "Attachment has restricted access",
          "type": "boolean",
          "x-ms-summary": "Restricted access",
          "x-ms-visibility": "advanced"
        }
      },
      "title": "Attachment",
      "type": "object",
      "x-ms-summary": "Attachment"
    },
    "Attachments": {
      "description": "Attachment list",
      "properties": {
        "attachments": {
          "items": {
            "$ref": "#/definitions/Attachment"
          },
          "type": "array"
        }
      },
      "title": "Attachments",
      "type": "object",
      "x-ms-summary": "Attachments"
    },
    "Comment": {
      "description": "Document comment",
      "properties": {
        "created_at": {
          "description": "The timestamp when the comment was created",
          "type": "string"
        },
        "email": {
          "description": "Email of the person creating the comment",
          "type": "string"
        },
        "full_name": {
          "description": "Name of the person creating the comment",
          "type": "string"
        },
        "id": {
          "description": "Unique ID of the comment",
          "type": "string"
        },
        "self": {
          "description": "If this comment is created by the current authenticated user",
          "type": "integer"
        },
        "text": {
          "description": "The commented text",
          "type": "string"
        },
        "thumb_url": {
          "description": "Thumbnail of the person creating the comment",
          "type": "string"
        }
      },
      "title": "Comment",
      "type": "object"
    },
    "CommentResponse": {
      "description": "Comment creation response",
      "properties": {
        "comment_id": {
          "description": "ID of the created comment",
          "type": "string"
        }
      },
      "title": "Comment Response",
      "type": "object"
    },
    "CommunicationTemplate": {
      "description": "Communication template details",
      "properties": {
        "tags": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "conversation_sendout_template": {
          "properties": {
            "automatic_message": {
              "type": "boolean"
            },
            "automatic_reminder_message": {
              "type": "boolean"
            },
            "conversation_starter": {
              "type": "string"
            },
            "reminder_message": {
              "type": "string"
            }
          },
          "type": "object"
        },
        "created_at": {
          "type": "string"
        },
        "created_by": {
          "type": "string"
        },
        "email_sendout_reminder_template": {
          "properties": {
            "automatic_message": {
              "type": "boolean"
            },
            "button_text": {
              "type": "string"
            },
            "email_subject": {
              "type": "string"
            },
            "footer": {
              "type": "string"
            },
            "message": {
              "type": "string"
            },
            "sms_message": {
              "type": "string"
            }
          },
          "type": "object"
        },
        "email_sendout_template": {
          "properties": {
            "automatic_message": {
              "type": "boolean"
            },
            "button_text": {
              "type": "string"
            },
            "email_subject": {
              "type": "string"
            },
            "footer": {
              "type": "string"
            },
            "message": {
              "type": "string"
            },
            "sms_message": {
              "type": "string"
            }
          },
          "type": "object"
        },
        "entity_id": {
          "description": "Entity ID",
          "type": "string"
        },
        "id": {
          "description": "Communication template ID",
          "type": "string"
        },
        "language": {
          "description": "Language code in ISO 639 form",
          "type": "string"
        },
        "name": {
          "description": "Template name",
          "type": "string"
        },
        "signed_sendout_template": {
          "properties": {
            "button_text": {
              "type": "string"
            },
            "email_subject": {
              "type": "string"
            },
            "footer": {
              "type": "string"
            },
            "message": {
              "type": "string"
            }
          },
          "type": "object"
        },
        "status": {
          "enum": [
            "published",
            "draft"
          ],
          "type": "string"
        },
        "type": {
          "type": "string"
        },
        "updated_at": {
          "type": "string"
        },
        "updated_by": {
          "type": "string"
        }
      },
      "title": "Communication Template",
      "type": "object"
    },
    "Contact": {
      "description": "Every unique e-mail address (or mobile number) is defined as a contact.",
      "properties": {
        "company_id": {
          "description": "Company ID",
          "type": "string",
          "x-ms-summary": "Company ID"
        },
        "company_logo_url": {
          "description": "Company logo",
          "type": "string",
          "x-ms-summary": "Company logo"
        },
        "company_name": {
          "description": "Company name of the contact",
          "type": "string",
          "x-ms-summary": "Company name"
        },
        "company_number": {
          "description": "Company number of the contact",
          "type": "string",
          "x-ms-summary": "Company number"
        },
        "contact_id": {
          "description": "Contact ID",
          "type": "string",
          "x-ms-summary": "Contact ID",
          "x-ms-visibility": "advanced"
        },
        "created_at": {
          "description": "Date of created contact",
          "type": "string",
          "x-ms-summary": "Created"
        },
        "document_count": {
          "description": "Number of documents for a contact",
          "type": "number",
          "x-ms-summary": "Documents",
          "x-ms-visibility": "advanced"
        },
        "email": {
          "description": "Name of the created document",
          "type": "string",
          "x-ms-summary": "Contact email"
        },
        "first_name": {
          "description": "First name of the contact",
          "type": "string",
          "x-ms-summary": "First name"
        },
        "fullname": {
          "description": "Full name of the contact",
          "type": "string",
          "x-ms-summary": "Full name"
        },
        "gender": {
          "description": "Gender of the recipient",
          "type": "string",
          "x-ms-summary": "Gender",
          "x-ms-visibility": "advanced"
        },
        "last_name": {
          "description": "Last name of the contact",
          "type": "string",
          "x-ms-summary": "Last name"
        },
        "mobile": {
          "description": "Mobile number of the contact",
          "type": "string",
          "x-ms-summary": "Mobile"
        },
        "note": {
          "description": "Note of the contact",
          "type": "string",
          "x-ms-summary": "Note",
          "x-ms-visibility": "advanced"
        },
        "thumb_url": {
          "description": "Thumb URL of the contact",
          "type": "string",
          "x-ms-summary": "Thumb URL"
        },
        "title": {
          "description": "Title of the contact",
          "type": "string",
          "x-ms-summary": "Title"
        }
      },
      "title": "Contact",
      "type": "object",
      "x-ms-summary": "Contact"
    },
    "Contacts": {
      "description": "Contact list",
      "properties": {
        "contacts": {
          "items": {
            "$ref": "#/definitions/Contact"
          },
          "type": "array"
        }
      },
      "title": "Contacts",
      "type": "object",
      "x-ms-summary": "Contacts"
    },
    "CustomDataProperty": {
      "description": "Custom data property details",
      "properties": {
        "document_id": {
          "description": "Document ID",
          "type": "string"
        },
        "id": {
          "description": "Property ID",
          "type": "string"
        },
        "property": {
          "properties": {
            "key": {
              "description": "Property key",
              "type": "string"
            },
            "label": {
              "description": "Human-readable label",
              "type": "string"
            },
            "value": {
              "description": "Property value"
            },
            "value_type": {
              "description": "Value type: string, number, boolean",
              "type": "string"
            }
          },
          "type": "object"
        }
      },
      "title": "Custom Data Property",
      "type": "object"
    },
    "Document": {
      "description": "A document is one or multiple uploaded file(s) that is to be sent to one or many recipients created by a user.",
      "properties": {
        "tags": {
          "description": "Document tags",
          "type": "string",
          "x-ms-summary": "Tags"
        },
        "auto_comment_email": {
          "type": "string",
          "x-ms-visibility": "internal"
        },
        "auto_comment_text": {
          "description": "Automatic chat text",
          "type": "string",
          "x-ms-summary": "Automatic chat text",
          "x-ms-visibility": "advanced"
        },
        "company_id": {
          "description": "Company ID",
          "type": "string",
          "x-ms-summary": "Company ID",
          "x-ms-visibility": "internal"
        },
        "company_logo_url": {
          "type": "string",
          "x-ms-summary": "Company Logo URL",
          "x-ms-visibility": "internal"
        },
        "company_name": {
          "description": "Company Name",
          "type": "string",
          "x-ms-summary": "Company Name",
          "x-ms-visibility": "advanced"
        },
        "company_number": {
          "type": "string",
          "x-ms-visibility": "internal"
        },
        "created_at": {
          "description": "When document was created",
          "type": "string",
          "x-ms-summary": "Created at",
          "x-ms-visibility": "advanced"
        },
        "download_url": {
          "description": "URL to download signed document",
          "type": "string",
          "x-ms-summary": "Download URL"
        },
        "email_send_message": {
          "description": "Sending email message",
          "type": "string",
          "x-ms-summary": "Email message",
          "x-ms-visibility": "advanced"
        },
        "email_send_subject": {
          "description": "Email subject text",
          "type": "string",
          "x-ms-summary": "Email Subject",
          "x-ms-visibility": "advanced"
        },
        "email_send_template_id": {
          "type": "string",
          "x-ms-summary": "Email send template ID",
          "x-ms-visibility": "internal"
        },
        "entity_auto_comment_text": {
          "type": "string",
          "x-ms-visibility": "internal"
        },
        "expiration_date": {
          "description": "Document expiration date",
          "type": "string",
          "x-ms-summary": "Expiration date"
        },
        "external_client_id": {
          "type": "string",
          "x-ms-summary": "External Client ID",
          "x-ms-visibility": "advanced"
        },
        "external_editor_id": {
          "description": "ID in external editor",
          "type": "string",
          "x-ms-summary": "External Editor ID",
          "x-ms-visibility": "advanced"
        },
        "external_editor_type": {
          "type": "string",
          "x-ms-summary": "External Editor Type",
          "x-ms-visibility": "advanced"
        },
        "external_id": {
          "type": "string",
          "x-ms-summary": "External ID"
        },
        "field_count": {
          "description": "Number of fields in document",
          "format": "int32",
          "type": "integer",
          "x-ms-summary": "Field count",
          "x-ms-visibility": "advanced"
        },
        "id": {
          "type": "string",
          "x-ms-summary": "ID",
          "x-ms-visibility": "important"
        },
        "is_auto_comment": {
          "description": "If automatic chat comment is enabled",
          "type": "boolean",
          "x-ms-summary": "Auto comment",
          "x-ms-visibility": "advanced"
        },
        "is_auto_comment_email": {
          "description": "If automatic chat email is enabled",
          "type": "boolean",
          "x-ms-summary": "Auto Comment Email",
          "x-ms-visibility": "advanced"
        },
        "is_identify_recipient": {
          "description": "If document has identify recipient enabled",
          "type": "boolean",
          "x-ms-summary": "Identify Recipient",
          "x-ms-visibility": "advanced"
        },
        "is_private": {
          "description": "If the document is private",
          "type": "boolean",
          "x-ms-summary": "Is private",
          "x-ms-visibility": "advanced"
        },
        "is_reminder_sending": {
          "description": "If automatic reminders are enabled",
          "type": "boolean",
          "x-ms-summary": "Send reminders",
          "x-ms-visibility": "advanced"
        },
        "is_scheduled_sending": {
          "description": "If the document has scheduled sending",
          "type": "boolean",
          "x-ms-summary": "Scheduled sending",
          "x-ms-visibility": "advanced"
        },
        "is_selfsign": {
          "description": "If document has been self-signed by sender",
          "type": "boolean",
          "x-ms-summary": "Self-signing",
          "x-ms-visibility": "advanced"
        },
        "is_signed": {
          "description": "If the document has been signed",
          "type": "boolean",
          "x-ms-summary": "Is signed",
          "x-ms-visibility": "advanced"
        },
        "is_signing": {
          "description": "If document is signable",
          "type": "boolean",
          "x-ms-summary": "Signable document",
          "x-ms-visibility": "advanced"
        },
        "is_signing_biometric": {
          "description": "If handwritten signature is enabled",
          "type": "boolean",
          "x-ms-summary": "Handwritten signature",
          "x-ms-visibility": "advanced"
        },
        "is_signing_forward": {
          "description": "If transfer of signing rights is enabled",
          "type": "boolean",
          "x-ms-summary": "Allow signature transfer",
          "x-ms-visibility": "advanced"
        },
        "is_signing_initials": {
          "type": "boolean",
          "x-ms-summary": "Signing Initials",
          "x-ms-visibility": "internal"
        },
        "is_signing_order": {
          "description": "If recipient signing order is enabled",
          "type": "boolean",
          "x-ms-summary": "Signature order",
          "x-ms-visibility": "advanced"
        },
        "is_video": {
          "description": "If the document has a introduction video",
          "type": "boolean",
          "x-ms-summary": "Has Video",
          "x-ms-visibility": "advanced"
        },
        "name": {
          "description": "Name of document",
          "type": "string",
          "x-ms-summary": "Name",
          "x-ms-visibility": "important"
        },
        "parent_id": {
          "description": "ID of previous document version",
          "type": "string",
          "x-ms-summary": "Parent ID"
        },
        "preview_url": {
          "description": "Link to internal preview of document",
          "type": "string",
          "x-ms-summary": "Preview URL",
          "x-ms-visibility": "advanced"
        },
        "recipients": {
          "items": {
            "$ref": "#/definitions/Recipient"
          },
          "type": "array"
        },
        "scheduled_sending_time": {
          "description": "When the document was scheduled for sending",
          "type": "string",
          "x-ms-summary": "Scheduled sending time",
          "x-ms-visibility": "advanced"
        },
        "send_date": {
          "description": "Document send date",
          "type": "string",
          "x-ms-summary": "Send date"
        },
        "sender_email": {
          "description": "Email address of sender user",
          "type": "string",
          "x-ms-summary": "Sender email"
        },
        "sender_name": {
          "description": "Name of sender user",
          "type": "string",
          "x-ms-summary": "Sender name"
        },
        "sender_thumb_url": {
          "description": "Thumb image of sender user",
          "type": "string",
          "x-ms-summary": "Sender thumb URL",
          "x-ms-visibility": "advanced"
        },
        "sign_date": {
          "description": "Document sign date",
          "type": "string",
          "x-ms-summary": "Sign date"
        },
        "status": {
          "description": "Current status of document",
          "type": "string",
          "x-ms-summary": "Status",
          "x-ms-visibility": "important"
        },
        "thumb_url": {
          "description": "Thumb image of document",
          "type": "string",
          "x-ms-summary": "Thumb URL",
          "x-ms-visibility": "advanced"
        },
        "type": {
          "description": "Document type",
          "type": "string",
          "x-ms-summary": "Type"
        },
        "unique_id": {
          "description": "Unique ID for document",
          "format": "int32",
          "type": "integer",
          "x-ms-summary": "Unique ID"
        },
        "user_id": {
          "description": "ID of the sender user",
          "type": "string",
          "x-ms-summary": "User ID",
          "x-ms-visibility": "advanced"
        },
        "value": {
          "description": "Value of document",
          "format": "float",
          "type": "number",
          "x-ms-summary": "Value"
        }
      },
      "title": "Document",
      "type": "object",
      "x-ms-summary": "Document"
    },
    "Documents": {
      "description": "Document list",
      "items": {
        "properties": {
          "tags": {
            "type": "string"
          },
          "company_name": {
            "type": "string"
          },
          "created_at": {
            "type": "string"
          },
          "expiration_date": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "is_private": {
            "type": "boolean"
          },
          "is_signing": {
            "type": "boolean"
          },
          "name": {
            "type": "string"
          },
          "sender_name": {
            "type": "string"
          },
          "sender_thumb": {
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "value": {
            "format": "int32",
            "type": "integer"
          }
        },
        "type": "object"
      },
      "title": "Documents",
      "type": "array",
      "x-ms-summary": "Documents"
    },
    "EditorField": {
      "description": "Editor Field details",
      "properties": {
        "id": {
          "description": "ID",
          "type": "string",
          "x-ms-summary": "ID",
          "x-ms-visibility": "advanced"
        },
        "input_settings": {
          "description": "Settings",
          "properties": {
            "label": {
              "description": "Label",
              "type": "string",
              "x-ms-summary": "Label"
            },
            "options": {
              "description": "Options",
              "items": {
                "type": "string"
              },
              "type": "array",
              "x-ms-summary": "Options"
            },
            "required": {
              "description": "Required",
              "type": "boolean",
              "x-ms-summary": "Required"
            },
            "type": {
              "description": "Type",
              "type": "string",
              "x-ms-summary": "Type"
            }
          },
          "type": "object",
          "x-ms-summary": "Settings"
        },
        "recipient_id": {
          "description": "Recipient ID",
          "type": "string",
          "x-ms-summary": "Recipient ID"
        },
        "type": {
          "description": "Type",
          "type": "string",
          "x-ms-summary": "Type"
        },
        "user_id": {
          "description": "User ID",
          "type": "string",
          "x-ms-summary": "User ID"
        }
      },
      "title": "Editor Field",
      "type": "object",
      "x-ms-summary": "Editor Field"
    },
    "EmailTemplate": {
      "description": "Email template details",
      "properties": {
        "code": {
          "description": "Template HTML code",
          "type": "string"
        },
        "entity_id": {
          "description": "Entity ID",
          "type": "string"
        },
        "id": {
          "description": "Template ID",
          "type": "string"
        },
        "name": {
          "description": "Template name",
          "type": "string"
        }
      },
      "title": "Email Template",
      "type": "object"
    },
    "EntityCustomData": {
      "description": "Entity custom data settings",
      "properties": {
        "allowed_properties": {
          "items": {
            "properties": {
              "key": {
                "description": "Property key",
                "type": "string"
              },
              "label": {
                "description": "Property label",
                "type": "string"
              },
              "property_type": {
                "description": "Property type",
                "type": "string"
              },
              "value_type": {
                "description": "Value type",
                "type": "string"
              }
            },
            "type": "object"
          },
          "type": "array"
        },
        "entity_id": {
          "description": "Entity ID",
          "type": "string"
        }
      },
      "title": "Entity Custom Data",
      "type": "object"
    },
    "Error": {
      "properties": {
        "description": {
          "type": "string"
        },
        "error": {
          "type": "string"
        },
        "status": {
          "type": "number"
        }
      },
      "title": "Error",
      "type": "object",
      "x-ms-summary": "Error"
    },
    "Event": {
      "description": "Document event details",
      "properties": {
        "company_name": {
          "type": "string"
        },
        "created_at": {
          "type": "string"
        },
        "document_id": {
          "type": "string"
        },
        "document_name": {
          "type": "string"
        },
        "document_status": {
          "type": "string"
        },
        "email": {
          "type": "string"
        },
        "event_meta_data": {
          "type": "string"
        },
        "event_name": {
          "type": "string"
        },
        "first_name": {
          "type": "string"
        },
        "gender": {
          "type": "string"
        },
        "last_name": {
          "type": "string"
        },
        "thumb_url": {
          "type": "string"
        }
      },
      "title": "Event",
      "type": "object"
    },
    "Field": {
      "description": "Field details",
      "properties": {
        "company_name": {
          "description": "Company Name",
          "type": "string",
          "x-ms-summary": "Company Name",
          "x-ms-visibility": "advanced"
        },
        "company_number": {
          "description": "Company Number",
          "type": "string",
          "x-ms-summary": "Company Number",
          "x-ms-visibility": "advanced"
        },
        "field_id": {
          "description": "Field ID",
          "type": "string",
          "x-ms-summary": "Field ID",
          "x-ms-visibility": "advanced"
        },
        "field_label": {
          "description": "Label",
          "type": "string",
          "x-ms-summary": "Label"
        },
        "field_options": {
          "description": "Options",
          "items": {
            "properties": {
              "value": {
                "type": "string",
                "x-ms-summary": "Value"
              }
            },
            "type": "object"
          },
          "type": "array",
          "x-ms-summary": "Options",
          "x-ms-visibility": "advanced"
        },
        "field_type": {
          "description": "Type",
          "type": "string",
          "x-ms-summary": "Type"
        },
        "field_value": {
          "description": "Value",
          "type": "string",
          "x-ms-summary": "Value"
        },
        "is_collectable": {
          "description": "Collecting field",
          "type": "boolean",
          "x-ms-visibility": "advanced"
        },
        "is_editable": {
          "description": "Editable field",
          "type": "boolean",
          "x-ms-visibility": "advanced"
        },
        "is_required": {
          "description": "Required field",
          "type": "boolean"
        },
        "page_id": {
          "description": "Page ID",
          "type": "string",
          "x-ms-summary": "Page ID",
          "x-ms-visibility": "advanced"
        },
        "recipient_id": {
          "description": "Recipient ID",
          "type": "string",
          "x-ms-summary": "Recipient ID",
          "x-ms-visibility": "advanced"
        },
        "recipient_name": {
          "description": "Recipient Name",
          "type": "string",
          "x-ms-summary": "Recipient Name",
          "x-ms-visibility": "advanced"
        },
        "role_name": {
          "description": "Role Name",
          "type": "string",
          "x-ms-summary": "Role Name",
          "x-ms-visibility": "advanced"
        }
      },
      "title": "Field",
      "type": "object",
      "x-ms-summary": "Field"
    },
    "FieldResponse": {
      "description": "Field creation response",
      "properties": {
        "field_id": {
          "description": "ID of the created field",
          "type": "string"
        }
      },
      "title": "Field Response",
      "type": "object"
    },
    "Fields": {
      "description": "Field list",
      "properties": {
        "editor_fields": {
          "items": {
            "$ref": "#/definitions/EditorField"
          },
          "type": "array"
        },
        "fields": {
          "items": {
            "$ref": "#/definitions/Field"
          },
          "type": "array"
        }
      },
      "title": "Fields",
      "type": "object",
      "x-ms-summary": "Fields"
    },
    "Folder": {
      "description": "Folder details",
      "properties": {
        "id": {
          "description": "Folder ID",
          "type": "string"
        },
        "name": {
          "description": "Folder name",
          "type": "string"
        },
        "type": {
          "description": "Folder type: archive or template",
          "enum": [
            "archive",
            "template"
          ],
          "type": "string"
        }
      },
      "title": "Folder",
      "type": "object"
    },
    "LogEntry": {
      "description": "Detailed log entry",
      "properties": {
        "created_at": {
          "type": "string"
        },
        "document_id": {
          "type": "string"
        },
        "email": {
          "type": "string"
        },
        "event_meta_data": {
          "type": "string"
        },
        "event_name": {
          "type": "string"
        },
        "first_name": {
          "type": "string"
        },
        "geo_city": {
          "type": "string"
        },
        "geo_country_name": {
          "type": "string"
        },
        "geo_ip": {
          "type": "string"
        },
        "last_name": {
          "type": "string"
        }
      },
      "title": "Log Entry",
      "type": "object"
    },
    "Page": {
      "description": "Document page details",
      "properties": {
        "clicks": {
          "type": "integer"
        },
        "description": {
          "type": "string"
        },
        "order_num": {
          "type": "integer"
        },
        "page_height": {
          "type": "number"
        },
        "page_id": {
          "type": "string"
        },
        "page_num": {
          "type": "integer"
        },
        "page_time": {
          "type": "number"
        },
        "page_type": {
          "type": "integer"
        },
        "page_type_name": {
          "type": "string"
        },
        "page_width": {
          "type": "number"
        },
        "thumb_url": {
          "type": "string"
        },
        "title": {
          "type": "string"
        },
        "video_hash": {
          "type": "string"
        },
        "view_duration_seconds": {
          "type": "number"
        }
      },
      "title": "Page",
      "type": "object"
    },
    "PreviewResponse": {
      "description": "Document preview response",
      "properties": {
        "preview_url": {
          "description": "URL to preview PDF",
          "type": "string"
        }
      },
      "title": "Preview Response",
      "type": "object"
    },
    "PricingColumn": {
      "description": "Pricing Table Column",
      "properties": {
        "column_id": {
          "description": "ID",
          "type": "string",
          "x-ms-summary": "ID"
        },
        "display_name": {
          "description": "Display Name",
          "type": "string",
          "x-ms-summary": "Display Name"
        },
        "enabled": {
          "description": "Enabled",
          "enum": [
            true,
            false
          ],
          "example": false,
          "type": "boolean",
          "x-ms-summary": "Enabled"
        },
        "name": {
          "description": "Name",
          "type": "string",
          "x-ms-summary": "Name"
        }
      },
      "title": "Column",
      "type": "object",
      "x-ms-summary": "Column"
    },
    "PricingSection": {
      "description": "Pricing Table Section",
      "properties": {
        "columns": {
          "items": {
            "$ref": "#/definitions/PricingColumn"
          },
          "type": "array"
        },
        "display_name": {
          "description": "Display Name",
          "type": "string",
          "x-ms-summary": "Display Name"
        },
        "name": {
          "description": "Name",
          "type": "string",
          "x-ms-summary": "Name"
        },
        "section_id": {
          "description": "ID",
          "type": "string",
          "x-ms-summary": "ID"
        }
      },
      "title": "Section",
      "type": "object",
      "x-ms-summary": "Section"
    },
    "PricingTable": {
      "description": "Pricing Table",
      "properties": {
        "currency_settings": {
          "description": "Currency Settings",
          "properties": {
            "currency": {
              "description": "Currency",
              "type": "string",
              "x-ms-summary": "Currency"
            },
            "locale": {
              "description": "Locale",
              "type": "string",
              "x-ms-summary": "Locale"
            }
          },
          "title": "Currency Settings",
          "type": "object",
          "x-ms-summary": "Currency Settings"
        },
        "pre_calculated": {
          "description": "Pre calculated totals",
          "type": "boolean",
          "x-ms-summary": "Pre calculated totals"
        },
        "sections": {
          "items": {
            "$ref": "#/definitions/PricingSection"
          },
          "type": "array"
        },
        "table_id": {
          "description": "Table ID",
          "type": "string",
          "x-ms-summary": "ID"
        }
      },
      "title": "Table",
      "type": "object",
      "x-ms-summary": "Table"
    },
    "PricingTables": {
      "description": "Pricing Tables",
      "properties": {
        "pricing_tables": {
          "items": {
            "$ref": "#/definitions/PricingTable"
          },
          "type": "array"
        }
      },
      "title": "Pricing",
      "type": "object",
      "x-ms-summary": "Pricing"
    },
    "Recipient": {
      "description": "Every unique e-mail address (or mobile number) that is connected to a document is a recipient.",
      "properties": {
        "company_name": {
          "description": "Company name of the recipient",
          "type": "string",
          "x-ms-summary": "Company name"
        },
        "company_number": {
          "description": "Company number of the recipient",
          "type": "string",
          "x-ms-summary": "Company number"
        },
        "document_url": {
          "description": "Unique URL for the recipient to view/sign",
          "type": "string",
          "x-ms-summary": "Document URL",
          "x-ms-visibility": "important"
        },
        "email": {
          "description": "Email of the recipient",
          "type": "string",
          "x-ms-summary": "Recipient email"
        },
        "first_name": {
          "description": "First name of the recipient",
          "type": "string",
          "x-ms-summary": "First name"
        },
        "fullname": {
          "description": "Full name of the recipient",
          "type": "string",
          "x-ms-summary": "Full name"
        },
        "gender": {
          "description": "Gender of the recipient",
          "type": "string",
          "x-ms-summary": "Gender",
          "x-ms-visibility": "advanced"
        },
        "id": {
          "description": "ID of the recipient",
          "type": "string",
          "x-ms-summary": "ID",
          "x-ms-visibility": "advanced"
        },
        "last_name": {
          "description": "Last name of the recipient",
          "type": "string",
          "x-ms-summary": "Last name"
        },
        "mobile": {
          "description": "Mobile number of the recipient",
          "type": "string",
          "x-ms-summary": "Mobile"
        },
        "note": {
          "description": "Note of the recipient",
          "type": "string",
          "x-ms-summary": "Note",
          "x-ms-visibility": "advanced"
        },
        "order_num": {
          "description": "Signing order of the recipient",
          "type": "string",
          "x-ms-summary": "Signing order num",
          "x-ms-visibility": "advanced"
        },
        "role": {
          "type": "string",
          "x-ms-visibility": "internal"
        },
        "settings": {
          "description": "Per-recipient signature settings.",
          "properties": {
            "exclude_verified_eid_signature": {
              "description": "Only applies when the document has external_eid_signature enabled. If true, this recipient may sign with a handwritten signature instead of verifying with a verified EID. Note: the additional non-QES signatures do not degrade the security of the document's existing QES signatures, but are of a lower assurance level (advanced or SES). Someone inspecting the document may see that it contains non-QES signatures.",
              "type": "boolean",
              "x-ms-summary": "Exclude verified EID signature",
              "x-ms-visibility": "advanced"
            }
          },
          "type": "object",
          "x-ms-summary": "Recipient settings",
          "x-ms-visibility": "advanced"
        },
        "signing_methods": {
          "description": "Signing methods used by the recipient",
          "items": {
            "$ref": "#/definitions/SigningMethod"
          },
          "type": "array",
          "x-ms-summary": "Signing methods",
          "x-ms-visibility": "advanced"
        },
        "status": {
          "description": "Status of the recipient",
          "type": "string",
          "x-ms-summary": "Status"
        },
        "thumb_url": {
          "description": "Thumb URL of the recipient",
          "type": "string",
          "x-ms-summary": "Thumb URL"
        },
        "title": {
          "description": "Title of the recipient",
          "type": "string",
          "x-ms-summary": "Title"
        }
      },
      "title": "Recipient",
      "type": "object",
      "x-ms-summary": "Recipient"
    },
    "Recipients": {
      "description": "Recipient list",
      "properties": {
        "recipients": {
          "items": {
            "$ref": "#/definitions/Recipient"
          },
          "type": "array"
        }
      },
      "title": "Recipients",
      "type": "object",
      "x-ms-summary": "Recipients"
    },
    "SigningMethod": {
      "description": "Details about a signing method used by the recipient",
      "properties": {
        "signed_at": {
          "description": "ISO 8601 timestamp of when the signing occurred",
          "type": "string"
        },
        "type": {
          "description": "The type of signing method used",
          "enum": [
            "eid",
            "biometric",
            "sms",
            "initials",
            "signature"
          ],
          "type": "string"
        },
        "verified_name": {
          "description": "Name verified from eID transaction",
          "type": "string"
        },
        "verified_phone": {
          "description": "Phone number used for SMS verification",
          "type": "string"
        }
      },
      "title": "SigningMethod",
      "type": "object"
    },
    "StatusResponse": {
      "description": "Document status response",
      "properties": {
        "status": {
          "description": "Current document status",
          "type": "string"
        }
      },
      "title": "Status Response",
      "type": "object"
    },
    "Subscription": {
      "description": "Subscription details",
      "properties": {
        "host": {
          "description": "Host",
          "type": "string",
          "x-ms-summary": "Host"
        },
        "created_at": {
          "description": "Created",
          "type": "string",
          "x-ms-summary": "Created"
        },
        "event": {
          "description": "Event",
          "type": "string",
          "x-ms-summary": "Event"
        },
        "global": {
          "description": "Global",
          "type": "boolean",
          "x-ms-summary": "Global"
        },
        "id": {
          "description": "ID of the subscription",
          "type": "string",
          "x-ms-summary": "Subscription ID"
        },
        "notification_email": {
          "description": "Notification Email",
          "type": "string",
          "x-ms-summary": "Notification Email"
        },
        "payload": {
          "description": "Payload",
          "type": "string",
          "x-ms-summary": "Payload"
        },
        "status": {
          "description": "Status of subscription",
          "format": "int32",
          "type": "integer",
          "x-ms-summary": "Status",
          "x-nullable": true
        },
        "subscription_id": {
          "description": "ID of the subscription",
          "type": "string",
          "x-ms-summary": "Subscription ID"
        },
        "target_url": {
          "description": "Target URL",
          "type": "string",
          "x-ms-summary": "Target URL"
        }
      },
      "title": "Subscription",
      "type": "object",
      "x-ms-summary": "Subscription"
    },
    "Subscriptions": {
      "description": "Subscription list",
      "items": {
        "$ref": "#/definitions/Subscription"
      },
      "title": "Subscriptions",
      "type": "array",
      "x-ms-summary": "Subscriptions"
    },
    "Team": {
      "description": "Team details",
      "properties": {
        "name": {
          "description": "Team name",
          "type": "string"
        },
        "status": {
          "description": "Team status",
          "type": "string"
        },
        "team_id": {
          "description": "Team ID",
          "type": "string"
        },
        "team_user_count": {
          "description": "Number of users in team",
          "type": "integer"
        }
      },
      "title": "Team",
      "type": "object"
    },
    "TestResponse": {
      "description": "Authentication test response",
      "properties": {
        "entity_id": {
          "description": "Current entity ID",
          "type": "string"
        },
        "user_id": {
          "description": "Current user ID",
          "type": "string"
        }
      },
      "title": "Test Response",
      "type": "object"
    },
    "User": {
      "description": "A user is defined by it´s e-mail address and is connected to one or many entities.\n\n### User Roles\n\n#### Administrator:\n- View all documents\n- Edit all documents\n- Change entity settings, info and billing\n- Add new users to the entity\n- Assign entity roles\n\n#### Manager:\n- View team documents\n- Edit all documents\n- Add new users to the entity\n\n## Entity\nAn entity is the top node and all users and corresponding documents are connected to an entity. An entity is often the same as a company, a country or a department in a large organization.\n",
      "properties": {
        "app_mode": {
          "type": "string",
          "x-ms-summary": "App Mode"
        },
        "disallow_create": {
          "type": "boolean"
        },
        "email": {
          "description": "Email address of the user",
          "type": "string",
          "x-ms-summary": "Email"
        },
        "entity_id": {
          "type": "string",
          "x-ms-summary": "Entity ID"
        },
        "entity_name": {
          "type": "string",
          "x-ms-summary": "Entity Name"
        },
        "first_name": {
          "description": "First name of the user",
          "type": "string",
          "x-ms-summary": "First name"
        },
        "id": {
          "description": "ID of the user",
          "type": "string",
          "x-ms-summary": "ID"
        },
        "language": {
          "type": "string",
          "x-ms-summary": "Language"
        },
        "last_name": {
          "description": "Last name of the user",
          "type": "string",
          "x-ms-summary": "Last name"
        },
        "mobile": {
          "description": "Mobile number in international format",
          "type": "string",
          "x-ms-summary": "mobile"
        },
        "note": {
          "description": "Optional internal note for user",
          "type": "string",
          "x-ms-summary": "Note"
        },
        "phone": {
          "description": "Phone number in international format",
          "type": "string",
          "x-ms-summary": "Phone"
        },
        "role": {
          "enum": [
            "user",
            "manager",
            "admin"
          ],
          "example": "user",
          "type": "string",
          "x-ms-summary": "Role"
        },
        "skip_invitation": {
          "enum": [
            true,
            false
          ],
          "example": false,
          "type": "boolean",
          "x-ms-summary": "Skip sending invitation",
          "x-nullable": true
        },
        "status": {
          "type": "string",
          "x-ms-summary": "Status"
        },
        "team_id": {
          "type": "string",
          "x-ms-summary": "Team ID"
        },
        "thumb_url": {
          "type": "string",
          "x-ms-summary": "Thumb URL"
        },
        "timezone": {
          "type": "string",
          "x-ms-summary": "Timezone"
        },
        "title": {
          "description": "The title of the user, ex. CEO, Sales manager",
          "type": "string",
          "x-ms-summary": "Title"
        }
      },
      "title": "User",
      "type": "object",
      "x-ms-summary": "User"
    },
    "Users": {
      "description": "User list",
      "properties": {
        "users": {
          "items": {
            "properties": {
              "email": {
                "type": "string",
                "x-ms-summary": "Email"
              },
              "first_name": {
                "type": "string",
                "x-ms-summary": "First Name"
              },
              "last_login": {
                "type": "string",
                "x-ms-summary": "Last Login"
              },
              "last_name": {
                "type": "string",
                "x-ms-summary": "Last Name"
              },
              "name": {
                "type": "string",
                "x-ms-summary": "User Name"
              },
              "role": {
                "type": "string",
                "x-ms-summary": "Role"
              },
              "status": {
                "type": "string",
                "x-ms-summary": "Status"
              },
              "team_name": {
                "type": "string",
                "x-ms-summary": "Team Name"
              },
              "user_id": {
                "type": "string",
                "x-ms-summary": "User ID"
              }
            },
            "type": "object"
          },
          "type": "array"
        }
      },
      "title": "Users",
      "type": "object",
      "x-ms-summary": "Users"
    },
    "Video": {
      "description": "Video details",
      "properties": {
        "created_at": {
          "description": "Creation date",
          "type": "string"
        },
        "editable": {
          "description": "If video is editable",
          "type": "boolean"
        },
        "published": {
          "description": "If video is published",
          "type": "boolean"
        },
        "saved": {
          "description": "If video is saved",
          "type": "boolean"
        },
        "thumb_url": {
          "description": "Thumbnail URL",
          "type": "string"
        },
        "video_id": {
          "description": "Video ID",
          "type": "string"
        },
        "video_title": {
          "description": "Video title",
          "type": "string"
        },
        "video_type": {
          "description": "Video type",
          "type": "string"
        },
        "video_url": {
          "description": "Video URL",
          "type": "string"
        }
      },
      "title": "Video",
      "type": "object"
    },
    "VideoJobStatus": {
      "description": "Video processing job status",
      "properties": {
        "Status": {
          "description": "Current processing status",
          "type": "string"
        },
        "thumb_url": {
          "description": "URL to video thumbnail",
          "type": "string"
        },
        "video_url": {
          "description": "URL to processed video",
          "type": "string"
        }
      },
      "title": "Video Job Status",
      "type": "object"
    },
    "Webhook": {
      "description": "Webhook payload",
      "properties": {
        "custom_fields": {
          "additionalProperties": {
            "type": "string"
          },
          "type": "object",
          "x-ms-summary": "Custom Fields"
        },
        "document": {
          "$ref": "#/definitions/Document"
        },
        "entity": {
          "description": "Entity for the webhook",
          "properties": {
            "custom_domain": {
              "description": "Custom domain setting for entity",
              "type": "string",
              "x-ms-summary": "Entity custom domain",
              "x-ms-visibility": "advanced"
            },
            "email_send_message": {
              "description": "Default email message",
              "type": "string",
              "x-ms-summary": "Default email message",
              "x-ms-visibility": "advanced"
            },
            "email_send_subject": {
              "description": "Default email subject",
              "type": "string",
              "x-ms-summary": "Default email subject",
              "x-ms-visibility": "advanced"
            },
            "sub_domain": {
              "description": "Sub-domain for the entity",
              "type": "string",
              "x-ms-summary": "Entity sub-domain",
              "x-ms-visibility": "advanced"
            }
          },
          "type": "object",
          "x-ms-summary": "Entity"
        },
        "event": {
          "type": "string",
          "x-ms-summary": "Event name"
        },
        "event_action": {
          "type": "string",
          "x-ms-summary": "Event action"
        },
        "event_type": {
          "type": "string",
          "x-ms-summary": "Event type"
        },
        "recipient": {
          "$ref": "#/definitions/Recipient"
        },
        "subscription_id": {
          "type": "string",
          "x-ms-summary": "Subscription ID"
        }
      },
      "title": "Webhook",
      "type": "object",
      "x-ms-summary": "Webhook"
    }
  },
  "securityDefinitions": {
    "Oauth2": {
      "authorizationUrl": "https://app.getaccept.com/oauth2/authorize",
      "description": "For testing purpose, use client_id **api** and client_secret **app**",
      "flow": "accessCode",
      "scopes": {
        "basic": "Grants basic access to operations"
      },
      "tokenUrl": "https://app.getaccept.com/oauth2/token",
      "type": "oauth2"
    },
    "Token": {
      "description": "Enter your bearer token",
      "in": "header",
      "name": "Authorization",
      "type": "apiKey"
    }
  },
  "security": [
    {
      "Oauth2": [
        "basic"
      ]
    },
    {
      "Token": []
    }
  ],
  "tags": [
    {
      "externalDocs": {
        "url": "https://app.getaccept.com/api/#authentication"
      },
      "description": "Authentication with the GetAccept API can be made using JWT tokens (JSON Web Tokens) or OAuth 2.0 Authorization Framework http://oauth.net/2/  All requests must be made via HTTPS. All configuration URLs (webhooks, etc) should begin with https:// as well.",
      "name": "Authentication"
    },
    {
      "externalDocs": {
        "url": "https://app.getaccept.com/api/#contacts"
      },
      "description": "Everything related to contacts",
      "name": "Contacts"
    },
    {
      "externalDocs": {
        "url": "https://app.getaccept.com/api/#documents"
      },
      "description": "Everything related to documents",
      "name": "Documents"
    },
    {
      "externalDocs": {
        "url": "https://app.getaccept.com/api/#subscriptions"
      },
      "description": "To simplify the process of checking a documents status and make it more efficient in an integrated application, you can enable API Webhooks. Enable webhooks as a user with administrator privileges in the Settings | Integration | Webhooks. We support multiple webhooks for one application. Events will be POSTed to your webhook URLs and should be handled by you. A POST must be answered and your endpoint will need to return a 2xx HTTP. Otherwise, the callback will be considered a failure and will be retried later. Retries will be made after 1, 12, 24, and 48 hours. The sender (or notification_email) will receive an email notification after a failed attempt.",
      "name": "Subscriptions"
    },
    {
      "externalDocs": {
        "url": "https://app.getaccept.com/api/#templates"
      },
      "description": "GetAccept has extensive support for creating templates in different formats. You can use form fields to receive input data from a recipient or word files to merge custom data into a document.",
      "name": "Templates"
    },
    {
      "externalDocs": {
        "url": "https://app.getaccept.com/api/#users"
      },
      "description": "General user methods for creating, listing of users, single user details and statistics and managing existing users.",
      "name": "Users"
    },
    {
      "externalDocs": {
        "url": "https://app.getaccept.com/api/#attachments"
      },
      "description": "You can upload an attachment and reuse it in many documents.",
      "name": "Attachments"
    },
    {
      "externalDocs": {
        "url": "https://app.getaccept.com/api/#video"
      },
      "description": "You can upload videos and reuse it in many documents.",
      "name": "Videos"
    },
    {
      "externalDocs": {
        "url": "https://app.getaccept.com/api/#archive"
      },
      "description": "You can upload already signed documents to the document archive to make them searchable and use in your contract management process.",
      "name": "Archive"
    },
    {
      "externalDocs": {
        "url": "https://app.getaccept.com/api/#custom-data"
      },
      "description": "Custom Data enables you to define and use your own document properties as a complement to the default properties.",
      "name": "Custom Data"
    },
    {
      "externalDocs": {
        "url": "https://app.getaccept.com/api/#communication-templates"
      },
      "description": "Communication templates allow you to customize email and SMS messages sent to recipients.",
      "name": "Communication Templates"
    },
    {
      "description": "Additional endpoints used in various integrations.",
      "name": "Others"
    }
  ],
  "x-components": {
    "responses": {
      "AccessDenied": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "description": "Access denied"
      },
      "Invalid": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "description": "Invalid data"
      },
      "NotFound": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "description": "The specified resource was not found"
      },
      "Unauthorized": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "description": "Unauthorized"
      }
    },
    "headers": {
      "X-Rate-Limit-Limit": {
        "description": "The number of allowed requests in the current period",
        "schema": {
          "format": "int32",
          "type": "integer"
        }
      },
      "X-Rate-Limit-Remaining": {
        "description": "The number of remaining requests in the current period",
        "schema": {
          "format": "int32",
          "type": "integer"
        }
      },
      "X-Rate-Limit-Reset": {
        "description": "The number of seconds left in the current period",
        "schema": {
          "format": "int32",
          "type": "integer"
        }
      }
    }
  },
  "x-ms-connector-metadata": [
    {
      "propertyName": "Website",
      "propertyValue": "https://www.getaccept.com"
    },
    {
      "propertyName": "Privacy policy",
      "propertyValue": "https://www.getaccept.com/privacy-policy"
    },
    {
      "propertyName": "Categories",
      "propertyValue": "Sales and CRM;Productivity"
    }
  ]
}