{ "openapi": "3.0.1", "info": { "title": "BoldSign API", "version": "1" }, "servers": [ { "url": "https://api.boldsign.com" } ], "paths": { "/v1/brand/create": { "post": { "tags": [ "Branding" ], "summary": "Create the brand.", "operationId": "CreateBrand", "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "BrandLogo", "BrandName" ], "type": "object", "properties": { "BrandName": { "title": "String", "type": "string" }, "BrandLogo": { "title": "IFormFile", "type": "string", "format": "binary" }, "BackgroundColor": { "title": "String", "type": "string" }, "ButtonColor": { "title": "String", "type": "string" }, "ButtonTextColor": { "title": "String", "type": "string" }, "EmailDisplayName": { "title": "String", "type": "string" }, "DisclaimerDescription": { "title": "String", "type": "string" }, "DisclaimerTitle": { "title": "String", "type": "string" }, "RedirectUrl": { "title": "String", "type": "string" }, "IsDefault": { "title": "Boolean", "type": "boolean", "default": false }, "CanHideTagLine": { "title": "Boolean", "type": "boolean", "default": false }, "CombineAuditTrail": { "title": "Boolean", "type": "boolean", "default": false }, "EmailSignedDocument": { "title": "EmailSignedDocument", "enum": [ "Attachment", "DocumentLink" ], "type": "string", "default": "Attachment" }, "DocumentTimeZone": { "title": "String", "type": "string" }, "ShowBuiltInFormFields": { "title": "Boolean", "type": "boolean", "default": true }, "AllowCustomFieldCreation": { "title": "Boolean", "type": "boolean", "default": false }, "ShowSharedCustomFields": { "title": "Boolean", "type": "boolean", "default": false }, "HideDecline": { "title": "Nullable`1", "type": "boolean" }, "HideSave": { "title": "Nullable`1", "type": "boolean" } } }, "encoding": { "BrandName": { "style": "form" }, "BrandLogo": { "style": "form" }, "BackgroundColor": { "style": "form" }, "ButtonColor": { "style": "form" }, "ButtonTextColor": { "style": "form" }, "EmailDisplayName": { "style": "form" }, "DisclaimerDescription": { "style": "form" }, "DisclaimerTitle": { "style": "form" }, "RedirectUrl": { "style": "form" }, "IsDefault": { "style": "form" }, "CanHideTagLine": { "style": "form" }, "CombineAuditTrail": { "style": "form" }, "EmailSignedDocument": { "style": "form" }, "DocumentTimeZone": { "style": "form" }, "ShowBuiltInFormFields": { "style": "form" }, "AllowCustomFieldCreation": { "style": "form" }, "ShowSharedCustomFields": { "style": "form" }, "HideDecline": { "style": "form" }, "HideSave": { "style": "form" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCreated" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCreated" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCreated" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCreated" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCreated" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCreated" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCreated" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCreated" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCreated" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCreated" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCreated" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCreated" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCreated" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCreated" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCreated" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCreated" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } } } } }, "/v1/brand/edit": { "post": { "tags": [ "Branding" ], "summary": "Edit the brand.", "operationId": "EditBrand", "parameters": [ { "name": "brandId", "in": "query", "description": "The brand id.", "required": true, "schema": { "title": "String", "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "BrandLogo", "BrandName" ], "type": "object", "properties": { "BrandName": { "title": "String", "type": "string" }, "BrandLogo": { "title": "IFormFile", "type": "string", "format": "binary" }, "BackgroundColor": { "title": "String", "type": "string" }, "ButtonColor": { "title": "String", "type": "string" }, "ButtonTextColor": { "title": "String", "type": "string" }, "EmailDisplayName": { "title": "String", "type": "string" }, "DisclaimerDescription": { "title": "String", "type": "string" }, "DisclaimerTitle": { "title": "String", "type": "string" }, "RedirectUrl": { "title": "String", "type": "string" }, "IsDefault": { "title": "Boolean", "type": "boolean", "default": false }, "CanHideTagLine": { "title": "Boolean", "type": "boolean", "default": false }, "CombineAuditTrail": { "title": "Boolean", "type": "boolean", "default": false }, "EmailSignedDocument": { "title": "EmailSignedDocument", "enum": [ "Attachment", "DocumentLink" ], "type": "string", "default": "Attachment" }, "DocumentTimeZone": { "title": "String", "type": "string" }, "ShowBuiltInFormFields": { "title": "Boolean", "type": "boolean", "default": true }, "AllowCustomFieldCreation": { "title": "Boolean", "type": "boolean", "default": false }, "ShowSharedCustomFields": { "title": "Boolean", "type": "boolean", "default": false }, "HideDecline": { "title": "Nullable`1", "type": "boolean" }, "HideSave": { "title": "Nullable`1", "type": "boolean" } } }, "encoding": { "BrandName": { "style": "form" }, "BrandLogo": { "style": "form" }, "BackgroundColor": { "style": "form" }, "ButtonColor": { "style": "form" }, "ButtonTextColor": { "style": "form" }, "EmailDisplayName": { "style": "form" }, "DisclaimerDescription": { "style": "form" }, "DisclaimerTitle": { "style": "form" }, "RedirectUrl": { "style": "form" }, "IsDefault": { "style": "form" }, "CanHideTagLine": { "style": "form" }, "CombineAuditTrail": { "style": "form" }, "EmailSignedDocument": { "style": "form" }, "DocumentTimeZone": { "style": "form" }, "ShowBuiltInFormFields": { "style": "form" }, "AllowCustomFieldCreation": { "style": "form" }, "ShowSharedCustomFields": { "style": "form" }, "HideDecline": { "style": "form" }, "HideSave": { "style": "form" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCreated" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCreated" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCreated" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCreated" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCreated" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCreated" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCreated" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCreated" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCreated" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCreated" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCreated" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCreated" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCreated" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCreated" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCreated" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCreated" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } } } } }, "/v1/brand/delete": { "delete": { "tags": [ "Branding" ], "summary": "Delete the brand.", "operationId": "DeleteBrand", "parameters": [ { "name": "brandId", "in": "query", "description": "brand Id.", "required": true, "schema": { "title": "String", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandingMessage" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandingMessage" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandingMessage" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandingMessage" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandingMessage" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandingMessage" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandingMessage" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandingMessage" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandingMessage" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandingMessage" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandingMessage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandingMessage" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandingMessage" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandingMessage" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandingMessage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandingMessage" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } } } } }, "/v1/brand/resetdefault": { "post": { "tags": [ "Branding" ], "summary": "Reset default brand.", "operationId": "ResetDefaultBrand", "parameters": [ { "name": "brandId", "in": "query", "description": "brand Id.", "required": true, "schema": { "title": "String", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandingMessage" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandingMessage" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandingMessage" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandingMessage" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandingMessage" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandingMessage" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandingMessage" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandingMessage" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandingMessage" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandingMessage" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandingMessage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandingMessage" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandingMessage" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandingMessage" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandingMessage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandingMessage" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } } } } }, "/v1/brand/list": { "get": { "tags": [ "Branding" ], "summary": "List all the brands.", "operationId": "BrandList", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandingRecords" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/v1/customField/create": { "post": { "tags": [ "Custom Field" ], "summary": "Create the custom field.", "operationId": "CreateCustomField", "requestBody": { "description": "The custom field details.", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCustomFieldDetails" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCustomFieldDetails" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCustomFieldDetails" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCustomFieldDetails" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCustomFieldDetails" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCustomFieldDetails" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCustomFieldDetails" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCustomFieldDetails" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCustomFieldDetails" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCustomFieldDetails" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCustomFieldDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCustomFieldDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCustomFieldDetails" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCustomFieldDetails" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCustomFieldDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCustomFieldDetails" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCustomFieldDetails" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.CustomFieldMessage" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.CustomFieldMessage" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.CustomFieldMessage" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.CustomFieldMessage" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.CustomFieldMessage" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.CustomFieldMessage" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.CustomFieldMessage" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.CustomFieldMessage" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.CustomFieldMessage" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.CustomFieldMessage" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.CustomFieldMessage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.CustomFieldMessage" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.CustomFieldMessage" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.CustomFieldMessage" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.CustomFieldMessage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.CustomFieldMessage" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } } } } }, "/v1/customField/edit": { "post": { "tags": [ "Custom Field" ], "summary": "Edit the custom field.", "operationId": "EditCustomField", "parameters": [ { "name": "customFieldId", "in": "query", "description": "The custom field id.", "required": true, "schema": { "title": "String", "type": "string" } } ], "requestBody": { "description": "The custom field details.", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCustomFieldDetails" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCustomFieldDetails" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCustomFieldDetails" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCustomFieldDetails" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCustomFieldDetails" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCustomFieldDetails" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCustomFieldDetails" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCustomFieldDetails" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCustomFieldDetails" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCustomFieldDetails" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCustomFieldDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCustomFieldDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCustomFieldDetails" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCustomFieldDetails" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCustomFieldDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCustomFieldDetails" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BrandCustomFieldDetails" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.CustomFieldMessage" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.CustomFieldMessage" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.CustomFieldMessage" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.CustomFieldMessage" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.CustomFieldMessage" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.CustomFieldMessage" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.CustomFieldMessage" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.CustomFieldMessage" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.CustomFieldMessage" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.CustomFieldMessage" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.CustomFieldMessage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.CustomFieldMessage" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.CustomFieldMessage" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.CustomFieldMessage" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.CustomFieldMessage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.CustomFieldMessage" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } } } } }, "/v1/customField/delete": { "delete": { "tags": [ "Custom Field" ], "summary": "Delete the custom field.", "operationId": "DeleteCustomField", "parameters": [ { "name": "customFieldId", "in": "query", "description": "The custom field id.", "required": true, "schema": { "title": "String", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.DocumentViewer.GRPC.V1.DeleteCustomFieldReply" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.DocumentViewer.GRPC.V1.DeleteCustomFieldReply" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.DocumentViewer.GRPC.V1.DeleteCustomFieldReply" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.DocumentViewer.GRPC.V1.DeleteCustomFieldReply" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.DocumentViewer.GRPC.V1.DeleteCustomFieldReply" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.DocumentViewer.GRPC.V1.DeleteCustomFieldReply" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.DocumentViewer.GRPC.V1.DeleteCustomFieldReply" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.DocumentViewer.GRPC.V1.DeleteCustomFieldReply" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.DocumentViewer.GRPC.V1.DeleteCustomFieldReply" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.DocumentViewer.GRPC.V1.DeleteCustomFieldReply" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.DocumentViewer.GRPC.V1.DeleteCustomFieldReply" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.DocumentViewer.GRPC.V1.DeleteCustomFieldReply" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.DocumentViewer.GRPC.V1.DeleteCustomFieldReply" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.DocumentViewer.GRPC.V1.DeleteCustomFieldReply" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BoldSign.DocumentViewer.GRPC.V1.DeleteCustomFieldReply" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.DocumentViewer.GRPC.V1.DeleteCustomFieldReply" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } } } } }, "/v1/customField/list": { "get": { "tags": [ "Custom Field" ], "summary": "List the custom fields respective to the brand id.", "operationId": "CustomFieldsList", "parameters": [ { "name": "brandId", "in": "query", "description": "The brand id.", "required": true, "schema": { "title": "String", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.CustomFieldCollection" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } } } } }, "/v1/customField/createEmbeddedCustomFieldUrl": { "post": { "tags": [ "Custom Field" ], "summary": "Generates a URL for creating or modifying custom fields within your application's embedded Designer.", "operationId": "EmbedCustomField", "parameters": [ { "name": "BrandId", "in": "query", "description": "The Brand ID for custom fields must be configured", "required": true, "schema": { "title": "String", "type": "string" } }, { "name": "LinkValidTill", "in": "query", "description": "This property is used to set the validity of the generated URL. Its maximum validity is 30 days", "schema": { "title": "Nullable`1", "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.EmbeddedCustomFieldCreated" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } } } } }, "/v1/document/send": { "post": { "tags": [ "Document" ], "summary": "Sends the document for sign.", "operationId": "SendDocument", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "Files": { "title": "List`1", "type": "array", "items": { "title": "IFormFile", "type": "string", "format": "binary" } }, "Title": { "title": "String", "maxLength": 256, "minLength": 0, "type": "string" }, "Message": { "title": "String", "maxLength": 5000, "minLength": 0, "type": "string" }, "Signers": { "title": "IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.DocumentSigner" } }, "CC": { "title": "IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.DocumentCC" } }, "EnableSigningOrder": { "title": "Boolean", "type": "boolean", "default": false }, "ExpiryDays": { "title": "Int32", "type": "integer", "format": "int32", "deprecated": true }, "ExpiryDateType": { "title": "ExpiryDateType", "enum": [ "Days", "Hours", "SpecificDateTime" ], "type": "string", "default": "Days" }, "ExpiryValue": { "title": "Int64", "type": "integer", "format": "int64", "default": 60 }, "ReminderSettings.EnableAutoReminder": { "title": "Boolean", "type": "boolean", "default": false }, "ReminderSettings.ReminderDays": { "title": "Int32", "type": "integer", "format": "int32", "default": 3 }, "ReminderSettings.ReminderCount": { "title": "Int32", "type": "integer", "format": "int32", "default": 3 }, "EnableEmbeddedSigning": { "title": "Boolean", "type": "boolean", "default": false, "deprecated": true }, "DisableEmails": { "title": "Boolean", "type": "boolean", "default": false }, "DisableSMS": { "title": "Boolean", "type": "boolean", "default": false }, "BrandId": { "title": "String", "type": "string" }, "HideDocumentId": { "title": "Nullable`1", "type": "boolean", "default": false }, "Labels": { "title": "IEnumerable`1", "type": "array", "items": { "title": "String", "type": "string" } }, "FileUrls": { "title": "Uri[]", "type": "array", "items": { "title": "Uri", "type": "string", "format": "uri" } }, "SendLinkValidTill": { "title": "Nullable`1", "type": "string", "format": "date-time" }, "UseTextTags": { "title": "Boolean", "type": "boolean", "default": false }, "TextTagDefinitions": { "title": "List`1", "type": "array", "items": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.TextTags.Models.TextTagDefinition" } }, "EnablePrintAndSign": { "title": "Boolean", "type": "boolean", "default": false }, "EnableReassign": { "title": "Boolean", "type": "boolean", "default": true }, "DisableExpiryAlert": { "title": "Boolean", "type": "boolean", "default": false }, "DocumentInfo": { "title": "IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.DocumentInfo" } }, "OnBehalfOf": { "title": "String", "type": "string" }, "AutoDetectFields": { "title": "Boolean", "type": "boolean", "default": false } } }, "encoding": { "Files": { "style": "form" }, "Title": { "style": "form" }, "Message": { "style": "form" }, "Signers": { "style": "form" }, "CC": { "style": "form" }, "EnableSigningOrder": { "style": "form" }, "ExpiryDays": { "style": "form" }, "ExpiryDateType": { "style": "form" }, "ExpiryValue": { "style": "form" }, "ReminderSettings.EnableAutoReminder": { "style": "form" }, "ReminderSettings.ReminderDays": { "style": "form" }, "ReminderSettings.ReminderCount": { "style": "form" }, "EnableEmbeddedSigning": { "style": "form" }, "DisableEmails": { "style": "form" }, "DisableSMS": { "style": "form" }, "BrandId": { "style": "form" }, "HideDocumentId": { "style": "form" }, "Labels": { "style": "form" }, "FileUrls": { "style": "form" }, "SendLinkValidTill": { "style": "form" }, "UseTextTags": { "style": "form" }, "TextTagDefinitions": { "style": "form" }, "EnablePrintAndSign": { "style": "form" }, "EnableReassign": { "style": "form" }, "DisableExpiryAlert": { "style": "form" }, "DocumentInfo": { "style": "form" }, "OnBehalfOf": { "style": "form" }, "AutoDetectFields": { "style": "form" } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.DocumentCreated" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } } } } }, "/v1/document/extendExpiry": { "patch": { "tags": [ "Document" ], "summary": "Extends the expiration date of the document.", "operationId": "ExtendExpiry", "parameters": [ { "name": "documentId", "in": "query", "description": "Document Id.", "required": true, "schema": { "title": "String", "type": "string" } } ], "requestBody": { "description": "The new expiry value should be specified in yyyy-MM-dd format for days type, ISO date time format for specific date time and integer for hours type.", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ExtendExpiry" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ExtendExpiry" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ExtendExpiry" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ExtendExpiry" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ExtendExpiry" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ExtendExpiry" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ExtendExpiry" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ExtendExpiry" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ExtendExpiry" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ExtendExpiry" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ExtendExpiry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ExtendExpiry" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ExtendExpiry" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ExtendExpiry" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ExtendExpiry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ExtendExpiry" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ExtendExpiry" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } } } } }, "/v1/document/createEmbeddedRequestUrl": { "post": { "tags": [ "Document" ], "summary": "Generates a send URL which embeds document sending process into your application.", "operationId": "CreateEmbeddedRequestUrlDocument", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "RedirectUrl": { "title": "Uri", "type": "string", "format": "uri" }, "ShowToolbar": { "title": "Boolean", "type": "boolean", "default": false }, "SendViewOption": { "title": "PageViewOption", "enum": [ "PreparePage", "FillingPage" ], "type": "string", "default": "PreparePage" }, "ShowSaveButton": { "title": "Boolean", "type": "boolean", "default": true }, "Locale": { "title": "Locales", "enum": [ "EN", "NO", "FR", "DE", "ES", "BG", "CS", "DA", "IT", "NL", "PL", "PT", "RO", "RU", "SV" ], "type": "string", "default": "EN" }, "ShowSendButton": { "title": "Boolean", "type": "boolean", "default": true }, "ShowPreviewButton": { "title": "Boolean", "type": "boolean", "default": true }, "ShowNavigationButtons": { "title": "Boolean", "type": "boolean", "default": true }, "ShowTooltip": { "title": "Boolean", "type": "boolean", "default": false }, "Files": { "title": "List`1", "type": "array", "items": { "title": "IFormFile", "type": "string", "format": "binary" } }, "Title": { "title": "String", "maxLength": 256, "minLength": 0, "type": "string" }, "Message": { "title": "String", "maxLength": 5000, "minLength": 0, "type": "string" }, "Signers": { "title": "IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.DocumentSigner" } }, "CC": { "title": "IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.DocumentCC" } }, "EnableSigningOrder": { "title": "Boolean", "type": "boolean", "default": false }, "ExpiryDays": { "title": "Int32", "type": "integer", "format": "int32", "deprecated": true }, "ExpiryDateType": { "title": "ExpiryDateType", "enum": [ "Days", "Hours", "SpecificDateTime" ], "type": "string", "default": "Days" }, "ExpiryValue": { "title": "Int64", "type": "integer", "format": "int64", "default": 60 }, "ReminderSettings.EnableAutoReminder": { "title": "Boolean", "type": "boolean", "default": false }, "ReminderSettings.ReminderDays": { "title": "Int32", "type": "integer", "format": "int32", "default": 3 }, "ReminderSettings.ReminderCount": { "title": "Int32", "type": "integer", "format": "int32", "default": 3 }, "EnableEmbeddedSigning": { "title": "Boolean", "type": "boolean", "default": false, "deprecated": true }, "DisableEmails": { "title": "Boolean", "type": "boolean", "default": false }, "DisableSMS": { "title": "Boolean", "type": "boolean", "default": false }, "BrandId": { "title": "String", "type": "string" }, "HideDocumentId": { "title": "Nullable`1", "type": "boolean", "default": false }, "Labels": { "title": "IEnumerable`1", "type": "array", "items": { "title": "String", "type": "string" } }, "FileUrls": { "title": "Uri[]", "type": "array", "items": { "title": "Uri", "type": "string", "format": "uri" } }, "SendLinkValidTill": { "title": "Nullable`1", "type": "string", "format": "date-time" }, "UseTextTags": { "title": "Boolean", "type": "boolean", "default": false }, "TextTagDefinitions": { "title": "List`1", "type": "array", "items": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.TextTags.Models.TextTagDefinition" } }, "EnablePrintAndSign": { "title": "Boolean", "type": "boolean", "default": false }, "EnableReassign": { "title": "Boolean", "type": "boolean", "default": true }, "DisableExpiryAlert": { "title": "Boolean", "type": "boolean", "default": false }, "DocumentInfo": { "title": "IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.DocumentInfo" } }, "OnBehalfOf": { "title": "String", "type": "string" }, "AutoDetectFields": { "title": "Boolean", "type": "boolean", "default": false } } }, "encoding": { "RedirectUrl": { "style": "form" }, "ShowToolbar": { "style": "form" }, "SendViewOption": { "style": "form" }, "ShowSaveButton": { "style": "form" }, "Locale": { "style": "form" }, "ShowSendButton": { "style": "form" }, "ShowPreviewButton": { "style": "form" }, "ShowNavigationButtons": { "style": "form" }, "ShowTooltip": { "style": "form" }, "Files": { "style": "form" }, "Title": { "style": "form" }, "Message": { "style": "form" }, "Signers": { "style": "form" }, "CC": { "style": "form" }, "EnableSigningOrder": { "style": "form" }, "ExpiryDays": { "style": "form" }, "ExpiryDateType": { "style": "form" }, "ExpiryValue": { "style": "form" }, "ReminderSettings.EnableAutoReminder": { "style": "form" }, "ReminderSettings.ReminderDays": { "style": "form" }, "ReminderSettings.ReminderCount": { "style": "form" }, "EnableEmbeddedSigning": { "style": "form" }, "DisableEmails": { "style": "form" }, "DisableSMS": { "style": "form" }, "BrandId": { "style": "form" }, "HideDocumentId": { "style": "form" }, "Labels": { "style": "form" }, "FileUrls": { "style": "form" }, "SendLinkValidTill": { "style": "form" }, "UseTextTags": { "style": "form" }, "TextTagDefinitions": { "style": "form" }, "EnablePrintAndSign": { "style": "form" }, "EnableReassign": { "style": "form" }, "DisableExpiryAlert": { "style": "form" }, "DocumentInfo": { "style": "form" }, "OnBehalfOf": { "style": "form" }, "AutoDetectFields": { "style": "form" } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.EmbeddedSendCreated" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } } } } }, "/v1/document/list": { "get": { "tags": [ "Document" ], "summary": "List user documents.", "operationId": "ListDocuments", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "title": "Int32", "type": "integer", "format": "int32", "default": 10 } }, { "name": "Page", "in": "query", "required": true, "schema": { "title": "Int32", "type": "integer", "format": "int32", "default": 1 } }, { "name": "SentBy", "in": "query", "schema": { "title": "List`1", "type": "array", "items": { "title": "String", "type": "string" } } }, { "name": "Recipients", "in": "query", "schema": { "title": "List`1", "type": "array", "items": { "title": "String", "type": "string" } } }, { "name": "StartDate", "in": "query", "schema": { "title": "Nullable`1", "type": "string", "format": "date-time" } }, { "name": "Status", "in": "query", "schema": { "title": "List`1", "type": "array", "items": { "title": "Status", "enum": [ "None", "WaitingForMe", "WaitingForOthers", "NeedAttention", "Completed", "Declined", "Revoked", "Expired", "Draft" ], "type": "string" } } }, { "name": "EndDate", "in": "query", "schema": { "title": "Nullable`1", "type": "string", "format": "date-time" } }, { "name": "SearchKey", "in": "query", "schema": { "title": "String", "type": "string" } }, { "name": "Labels", "in": "query", "schema": { "title": "IEnumerable`1", "type": "array", "items": { "title": "String", "type": "string" } } }, { "name": "TransmitType", "in": "query", "schema": { "title": "TransmitType", "enum": [ "Sent", "Received", " Both" ], "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.DocumentRecords" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } } } } }, "/v1/document/teamlist": { "get": { "tags": [ "Document" ], "summary": "Get user Team documents.", "operationId": "TeamDocuments", "parameters": [ { "name": "Status", "in": "query", "description": "Status of the document such as In-progress, Completed, Decline, Expired, Revoked, Draft.", "schema": { "title": "List`1", "type": "array", "items": { "title": "Status", "enum": [ "None", "WaitingForMe", "WaitingForOthers", "NeedAttention", "Completed", "Declined", "Revoked", "Expired", "Draft" ], "type": "string" } } }, { "name": "UserId", "in": "query", "description": "UserId of the Team document.", "schema": { "title": "List`1", "type": "array", "items": { "title": "String", "type": "string" } } }, { "name": "TeamId", "in": "query", "description": "TeamId of the Team document.", "schema": { "title": "List`1", "type": "array", "items": { "title": "String", "type": "string" } } }, { "name": "SearchKey", "in": "query", "description": "Documents can be listed by the search key present in the document like document title, document ID, sender or recipient(s) name, etc.,", "schema": { "title": "String", "type": "string" } }, { "name": "PageSize", "in": "query", "description": "Page size specified in get document list request.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "default": 10 } }, { "name": "Page", "in": "query", "description": "Page index specified in get document list request.", "required": true, "schema": { "title": "Int32", "type": "integer", "format": "int32", "default": 1 } }, { "name": "EndDate", "in": "query", "description": "End date of the document", "schema": { "title": "Nullable`1", "type": "string", "format": "date-time" } }, { "name": "StartDate", "in": "query", "description": "Start date of the document", "schema": { "title": "Nullable`1", "type": "string", "format": "date-time" } }, { "name": "Labels", "in": "query", "description": "Labels of the document.", "schema": { "title": "IEnumerable`1", "type": "array", "items": { "title": "String", "type": "string" } } }, { "name": "TransmitType", "in": "query", "description": "Transmit type as Sent, Received and Both.", "schema": { "title": "TransmitType", "enum": [ "Sent", "Received", " Both" ], "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.TeamDocumentRecords" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } } } } }, "/v1/document/behalfList": { "get": { "tags": [ "Document" ], "summary": "Gets the behalf documents.", "operationId": "BehalfDocuments", "parameters": [ { "name": "Status", "in": "query", "description": "Filter documents based on their current status, including In-progress, Completed, Declined, Expired, and Revoked.", "schema": { "title": "List`1", "type": "array", "items": { "title": "Status", "enum": [ "None", "WaitingForMe", "WaitingForOthers", "NeedAttention", "Completed", "Declined", "Revoked", "Expired", "Draft" ], "type": "string" } } }, { "name": "PageType", "in": "query", "description": "The filter used to differentiate between documents sent on the user's behalf and documents sent by the user on behalf of others. The API will return documents based on the specified value.", "schema": { "title": "PageType", "enum": [ "BehalfOfOthers", "BehalfOfMe" ], "type": "string" } }, { "name": "EmailAddress", "in": "query", "description": "The sender identity's email used to filter the documents returned in the API. The API will return documents that were sent on behalf of the specified email address.", "schema": { "title": "List`1", "type": "array", "items": { "title": "String", "type": "string" } } }, { "name": "SearchKey", "in": "query", "description": "The search key used to filter the documents returned in the API. The API will return documents that contain the search key in the document title, document ID, sender or signer(s) name, etc.", "schema": { "title": "String", "type": "string" } }, { "name": "PageSize", "in": "query", "description": "Page size specified in get document list request.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "default": 10 } }, { "name": "Page", "in": "query", "description": "Page index specified in get document list request (cursor).", "required": true, "schema": { "title": "Int32", "type": "integer", "format": "int32", "default": 1 } }, { "name": "EndDate", "in": "query", "description": "The end date used to filter the documents returned in the API. The API will return documents that were created on or before this date.", "schema": { "title": "Nullable`1", "type": "string", "format": "date-time" } }, { "name": "StartDate", "in": "query", "description": "The start date used to filter the documents returned in the API. The API will return documents that were created on or after this date", "schema": { "title": "Nullable`1", "type": "string", "format": "date-time" } }, { "name": "Signers", "in": "query", "description": "A list of signer email addresses used to filter the documents returned in the API. The API will return documents where the signer's email address matches one of the email addresses provided in this list", "schema": { "title": "List`1", "type": "array", "items": { "title": "String", "type": "string" } } }, { "name": "Labels", "in": "query", "description": "A list of labels or tags used to filter the documents returned in the API. The API will return documents that have been tagged with one or more of the labels provided in this list", "schema": { "title": "IEnumerable`1", "type": "array", "items": { "title": "String", "type": "string" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BehalfDocumentRecords" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } } } } }, "/v1/document/properties": { "get": { "tags": [ "Document" ], "summary": "Get summary of the document.", "operationId": "GetProperties", "parameters": [ { "name": "documentId", "in": "query", "description": "Document Id.", "required": true, "schema": { "title": "String", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.DocumentProperties" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } } } } }, "/v1/document/download": { "get": { "tags": [ "Document" ], "summary": "Download the document.", "operationId": "DownloadDocument", "parameters": [ { "name": "documentId", "in": "query", "description": "Document Id.", "required": true, "schema": { "title": "String", "type": "string" } }, { "name": "onBehalfOf", "in": "query", "description": "The on behalfof email address.", "schema": { "title": "String", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "title": "FileStreamResult", "type": "string", "format": "binary" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "title": "FileStreamResult", "type": "string", "format": "binary" } }, "application/json;odata.metadata=minimal": { "schema": { "title": "FileStreamResult", "type": "string", "format": "binary" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "title": "FileStreamResult", "type": "string", "format": "binary" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "title": "FileStreamResult", "type": "string", "format": "binary" } }, "application/json;odata.metadata=full": { "schema": { "title": "FileStreamResult", "type": "string", "format": "binary" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "title": "FileStreamResult", "type": "string", "format": "binary" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "title": "FileStreamResult", "type": "string", "format": "binary" } }, "application/json;odata.metadata=none": { "schema": { "title": "FileStreamResult", "type": "string", "format": "binary" } }, "application/json;odata.streaming=true": { "schema": { "title": "FileStreamResult", "type": "string", "format": "binary" } }, "application/json;odata.streaming=false": { "schema": { "title": "FileStreamResult", "type": "string", "format": "binary" } }, "application/json": { "schema": { "title": "FileStreamResult", "type": "string", "format": "binary" } }, "application/xml": { "schema": { "title": "FileStreamResult", "type": "string", "format": "binary" } }, "application/prs.odatatestxx-odata": { "schema": { "title": "FileStreamResult", "type": "string", "format": "binary" } }, "text/plain": { "schema": { "title": "FileStreamResult", "type": "string", "format": "binary" } }, "text/json": { "schema": { "title": "FileStreamResult", "type": "string", "format": "binary" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } } } } }, "/v1/document/downloadAttachment": { "get": { "tags": [ "Document" ], "summary": "Download the Attachment.", "operationId": "DownloadAttachment", "parameters": [ { "name": "documentId", "in": "query", "description": "Document Id.", "required": true, "schema": { "title": "String", "type": "string" } }, { "name": "attachmentId", "in": "query", "description": "Attachment Id(Get attachment ID from Properties API).", "required": true, "schema": { "title": "String", "type": "string" } }, { "name": "onBehalfOf", "in": "query", "description": "The on behalfof email address.", "schema": { "title": "String", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "title": "FileStreamResult", "type": "string", "format": "binary" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "title": "FileStreamResult", "type": "string", "format": "binary" } }, "application/json;odata.metadata=minimal": { "schema": { "title": "FileStreamResult", "type": "string", "format": "binary" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "title": "FileStreamResult", "type": "string", "format": "binary" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "title": "FileStreamResult", "type": "string", "format": "binary" } }, "application/json;odata.metadata=full": { "schema": { "title": "FileStreamResult", "type": "string", "format": "binary" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "title": "FileStreamResult", "type": "string", "format": "binary" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "title": "FileStreamResult", "type": "string", "format": "binary" } }, "application/json;odata.metadata=none": { "schema": { "title": "FileStreamResult", "type": "string", "format": "binary" } }, "application/json;odata.streaming=true": { "schema": { "title": "FileStreamResult", "type": "string", "format": "binary" } }, "application/json;odata.streaming=false": { "schema": { "title": "FileStreamResult", "type": "string", "format": "binary" } }, "application/json": { "schema": { "title": "FileStreamResult", "type": "string", "format": "binary" } }, "application/xml": { "schema": { "title": "FileStreamResult", "type": "string", "format": "binary" } }, "application/prs.odatatestxx-odata": { "schema": { "title": "FileStreamResult", "type": "string", "format": "binary" } }, "text/plain": { "schema": { "title": "FileStreamResult", "type": "string", "format": "binary" } }, "text/json": { "schema": { "title": "FileStreamResult", "type": "string", "format": "binary" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } } } } }, "/v1/document/downloadAuditLog": { "get": { "tags": [ "Document" ], "summary": "Download the audit trail document.", "operationId": "DownloadAuditLog", "parameters": [ { "name": "documentId", "in": "query", "description": "Document Id.", "required": true, "schema": { "title": "String", "type": "string" } }, { "name": "onBehalfOf", "in": "query", "description": "The on behalfof email address.", "schema": { "title": "String", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "title": "FileStreamResult", "type": "string", "format": "binary" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "title": "FileStreamResult", "type": "string", "format": "binary" } }, "application/json;odata.metadata=minimal": { "schema": { "title": "FileStreamResult", "type": "string", "format": "binary" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "title": "FileStreamResult", "type": "string", "format": "binary" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "title": "FileStreamResult", "type": "string", "format": "binary" } }, "application/json;odata.metadata=full": { "schema": { "title": "FileStreamResult", "type": "string", "format": "binary" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "title": "FileStreamResult", "type": "string", "format": "binary" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "title": "FileStreamResult", "type": "string", "format": "binary" } }, "application/json;odata.metadata=none": { "schema": { "title": "FileStreamResult", "type": "string", "format": "binary" } }, "application/json;odata.streaming=true": { "schema": { "title": "FileStreamResult", "type": "string", "format": "binary" } }, "application/json;odata.streaming=false": { "schema": { "title": "FileStreamResult", "type": "string", "format": "binary" } }, "application/json": { "schema": { "title": "FileStreamResult", "type": "string", "format": "binary" } }, "application/xml": { "schema": { "title": "FileStreamResult", "type": "string", "format": "binary" } }, "application/prs.odatatestxx-odata": { "schema": { "title": "FileStreamResult", "type": "string", "format": "binary" } }, "text/plain": { "schema": { "title": "FileStreamResult", "type": "string", "format": "binary" } }, "text/json": { "schema": { "title": "FileStreamResult", "type": "string", "format": "binary" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } } } } }, "/v1/document/revoke": { "post": { "tags": [ "Document" ], "summary": "Revoke the document.", "operationId": "RevokeDocument", "parameters": [ { "name": "documentId", "in": "query", "description": "Document Id.", "required": true, "schema": { "title": "String", "type": "string" } } ], "requestBody": { "description": "RevokeDetails.", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.RevokeDocument" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.RevokeDocument" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.RevokeDocument" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.RevokeDocument" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.RevokeDocument" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.RevokeDocument" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.RevokeDocument" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.RevokeDocument" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.RevokeDocument" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.RevokeDocument" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.RevokeDocument" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.RevokeDocument" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.RevokeDocument" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.RevokeDocument" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.RevokeDocument" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.RevokeDocument" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.RevokeDocument" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } } } } }, "/v1/document/delete": { "delete": { "tags": [ "Document" ], "summary": "Delete the document.", "operationId": "DeleteDocument", "parameters": [ { "name": "documentId", "in": "query", "description": "Document Id.", "required": true, "schema": { "title": "String", "type": "string" } }, { "name": "deletePermanently", "in": "query", "description": "Delete Permanently.", "schema": { "title": "Boolean", "type": "boolean", "default": false } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } } } } }, "/v1/document/remind": { "post": { "tags": [ "Document" ], "summary": "Send reminder to pending signers.", "operationId": "RemindDocument", "parameters": [ { "name": "documentId", "in": "query", "description": "Document Id.", "required": true, "schema": { "title": "String", "type": "string" } }, { "name": "receiverEmails", "in": "query", "description": "Signer emails.", "schema": { "title": "String[]", "type": "array", "items": { "title": "String", "type": "string" } } } ], "requestBody": { "description": "Reminder Message for signers.", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ReminderMessage" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ReminderMessage" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ReminderMessage" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ReminderMessage" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ReminderMessage" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ReminderMessage" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ReminderMessage" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ReminderMessage" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ReminderMessage" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ReminderMessage" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ReminderMessage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ReminderMessage" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ReminderMessage" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ReminderMessage" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ReminderMessage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ReminderMessage" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ReminderMessage" } } } }, "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } } } } }, "/v1/document/changeAccessCode": { "patch": { "tags": [ "Document" ], "summary": "Changes the access code for the given document signer.", "operationId": "ChangeAccessCode", "parameters": [ { "name": "DocumentId", "in": "query", "required": true, "schema": { "title": "String", "type": "string" } }, { "name": "EmailId", "in": "query", "schema": { "title": "String", "type": "string" } }, { "name": "ZOrder", "in": "query", "schema": { "title": "Nullable`1", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The new access code.", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.AccessCodeDetails" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.AccessCodeDetails" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.AccessCodeDetails" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.AccessCodeDetails" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.AccessCodeDetails" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.AccessCodeDetails" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.AccessCodeDetails" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.AccessCodeDetails" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.AccessCodeDetails" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.AccessCodeDetails" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.AccessCodeDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.AccessCodeDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.AccessCodeDetails" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.AccessCodeDetails" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.AccessCodeDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.AccessCodeDetails" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.AccessCodeDetails" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } } } } }, "/v1/document/changeRecipient": { "patch": { "tags": [ "Document" ], "summary": "Change recipient details of a document.", "parameters": [ { "name": "documentId", "in": "query", "description": "The documentID details.", "required": true, "schema": { "title": "String", "type": "string" } } ], "requestBody": { "description": "The new recipient details.", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ViewModel.ChangeRecipient" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ViewModel.ChangeRecipient" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ViewModel.ChangeRecipient" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ViewModel.ChangeRecipient" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ViewModel.ChangeRecipient" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ViewModel.ChangeRecipient" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ViewModel.ChangeRecipient" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ViewModel.ChangeRecipient" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ViewModel.ChangeRecipient" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ViewModel.ChangeRecipient" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ViewModel.ChangeRecipient" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ViewModel.ChangeRecipient" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ViewModel.ChangeRecipient" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ViewModel.ChangeRecipient" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ViewModel.ChangeRecipient" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ViewModel.ChangeRecipient" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ViewModel.ChangeRecipient" } } }, "required": true }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } } } } }, "/v1/document/getEmbeddedSignLink": { "get": { "tags": [ "Document" ], "summary": "Get sign link for Embedded Sign.", "operationId": "GetEmbeddedSignLink", "parameters": [ { "name": "DocumentId", "in": "query", "required": true, "schema": { "title": "String", "type": "string" } }, { "name": "SignerEmail", "in": "query", "schema": { "title": "String", "type": "string" } }, { "name": "CountryCode", "in": "query", "schema": { "title": "String", "type": "string" } }, { "name": "PhoneNumber", "in": "query", "schema": { "title": "String", "type": "string" } }, { "name": "SignLinkValidTill", "in": "query", "schema": { "title": "Nullable`1", "type": "string", "format": "date-time" } }, { "name": "RedirectUrl", "in": "query", "schema": { "title": "Uri", "type": "string", "format": "uri" } } ], "responses": { "200": { "description": "Success", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.EmbeddedSigningLink" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.EmbeddedSigningLink" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.EmbeddedSigningLink" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.EmbeddedSigningLink" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.EmbeddedSigningLink" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.EmbeddedSigningLink" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.EmbeddedSigningLink" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.EmbeddedSigningLink" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.EmbeddedSigningLink" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.EmbeddedSigningLink" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.EmbeddedSigningLink" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.EmbeddedSigningLink" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.EmbeddedSigningLink" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.EmbeddedSigningLink" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.EmbeddedSigningLink" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.EmbeddedSigningLink" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } } } } }, "/v1/document/addTags": { "patch": { "tags": [ "Document" ], "summary": "Add the Tags in Documents.", "operationId": "AddTag", "requestBody": { "description": "Contains DocumentId and LabelNames for Adding Tags.", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.DocumentTags" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.DocumentTags" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.DocumentTags" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.DocumentTags" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.DocumentTags" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.DocumentTags" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.DocumentTags" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.DocumentTags" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.DocumentTags" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.DocumentTags" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.DocumentTags" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.DocumentTags" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.DocumentTags" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.DocumentTags" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.DocumentTags" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.DocumentTags" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.DocumentTags" } } } }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } } } } }, "/v1/document/deleteTags": { "delete": { "tags": [ "Document" ], "summary": "Delete the Tags in Documents.", "operationId": "DeleteTag", "requestBody": { "description": "Contains DocumentId and LabelNames for Adding Tags.", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.DocumentTags" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.DocumentTags" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.DocumentTags" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.DocumentTags" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.DocumentTags" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.DocumentTags" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.DocumentTags" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.DocumentTags" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.DocumentTags" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.DocumentTags" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.DocumentTags" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.DocumentTags" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.DocumentTags" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.DocumentTags" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.DocumentTags" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.DocumentTags" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.DocumentTags" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } } } } }, "/v1/document/RemoveAuthentication": { "patch": { "tags": [ "Document" ], "summary": "Remove the access code for the given document signer.", "operationId": "RemoveAuthentication", "parameters": [ { "name": "DocumentId", "in": "query", "description": "Document ID of the signature request", "required": true, "schema": { "title": "String", "type": "string" } } ], "requestBody": { "description": "To remove access code.", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.RemoveAuthentication" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.RemoveAuthentication" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.RemoveAuthentication" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.RemoveAuthentication" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.RemoveAuthentication" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.RemoveAuthentication" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.RemoveAuthentication" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.RemoveAuthentication" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.RemoveAuthentication" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.RemoveAuthentication" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.RemoveAuthentication" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.RemoveAuthentication" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.RemoveAuthentication" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.RemoveAuthentication" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.RemoveAuthentication" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.RemoveAuthentication" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.RemoveAuthentication" } } } }, "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } } } } }, "/v1/document/addAuthentication": { "patch": { "tags": [ "Document" ], "summary": "The add authentication to recipient.", "operationId": "AddAuthentication", "parameters": [ { "name": "documentId", "in": "query", "description": "The DocumentId.", "required": true, "schema": { "title": "String", "type": "string" } } ], "requestBody": { "description": "Access code details.", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.AccessCodeDetail" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.AccessCodeDetail" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.AccessCodeDetail" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.AccessCodeDetail" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.AccessCodeDetail" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.AccessCodeDetail" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.AccessCodeDetail" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.AccessCodeDetail" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.AccessCodeDetail" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.AccessCodeDetail" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.AccessCodeDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.AccessCodeDetail" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.AccessCodeDetail" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.AccessCodeDetail" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.AccessCodeDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.AccessCodeDetail" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.AccessCodeDetail" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } } } } }, "/v1/plan/apiCreditsCount": { "get": { "tags": [ "Plan" ], "summary": "Gets the Api credits details.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.BillingViewModel" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } } } } }, "/v1/senderIdentities/create": { "post": { "tags": [ "Sender Identities" ], "summary": "Creates sender identity.", "operationId": "CreateSenderIdentities", "requestBody": { "description": "The create sender identity request.", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateSenderIdentityRequest" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateSenderIdentityRequest" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateSenderIdentityRequest" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateSenderIdentityRequest" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateSenderIdentityRequest" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateSenderIdentityRequest" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateSenderIdentityRequest" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateSenderIdentityRequest" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateSenderIdentityRequest" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateSenderIdentityRequest" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateSenderIdentityRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateSenderIdentityRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateSenderIdentityRequest" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateSenderIdentityRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateSenderIdentityRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateSenderIdentityRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateSenderIdentityRequest" } } }, "required": true }, "responses": { "201": { "description": "Created" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } } } } }, "/v1/senderIdentities/update": { "post": { "tags": [ "Sender Identities" ], "summary": "Updates sender identity.", "operationId": "UpdateSenderIdentities", "parameters": [ { "name": "email", "in": "query", "description": "The email address.", "required": true, "schema": { "title": "String", "type": "string" } } ], "requestBody": { "description": "The create sender identity request.", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.EditSenderIdentityRequest" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.EditSenderIdentityRequest" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.EditSenderIdentityRequest" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.EditSenderIdentityRequest" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.EditSenderIdentityRequest" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.EditSenderIdentityRequest" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.EditSenderIdentityRequest" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.EditSenderIdentityRequest" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.EditSenderIdentityRequest" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.EditSenderIdentityRequest" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.EditSenderIdentityRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.EditSenderIdentityRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.EditSenderIdentityRequest" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.EditSenderIdentityRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.EditSenderIdentityRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.EditSenderIdentityRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.EditSenderIdentityRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } } } } }, "/v1/senderIdentities/delete": { "delete": { "tags": [ "Sender Identities" ], "summary": "Deletes sender identity.", "operationId": "DeleteSenderIdentities", "parameters": [ { "name": "email", "in": "query", "description": "The email address.", "required": true, "schema": { "title": "String", "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } } } } }, "/v1/senderIdentities/resendInvitation": { "post": { "tags": [ "Sender Identities" ], "summary": "Resends sender identity invitation.", "operationId": "ResendInvitationSenderIdentities", "parameters": [ { "name": "email", "in": "query", "description": "The email address.", "required": true, "schema": { "title": "String", "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } } } } }, "/v1/senderIdentities/rerequest": { "post": { "tags": [ "Sender Identities" ], "summary": "Rerequests denied sender identity.", "operationId": "ReRequestSenderIdentities", "parameters": [ { "name": "email", "in": "query", "description": "The email address.", "required": true, "schema": { "title": "String", "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } } } } }, "/v1/senderIdentities/list": { "get": { "tags": [ "Sender Identities" ], "summary": "Lists sender identity.", "operationId": "ListSenderIdentities", "parameters": [ { "name": "PageSize", "in": "query", "description": "Page size specified in get sender identity list request.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "default": 10 } }, { "name": "Page", "in": "query", "description": "Page index specified in get sender identity request.", "required": true, "schema": { "title": "Int32", "type": "integer", "format": "int32", "default": 1 } }, { "name": "Search", "in": "query", "description": "Users can be listed by the search key present in the sender identity like sender identity name and email address", "schema": { "title": "String", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.SenderIdentityList" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } } } } }, "/v1/teams/get": { "get": { "tags": [ "Teams" ], "summary": "Get Team details.", "operationId": "GetTeam", "parameters": [ { "name": "teamId", "in": "query", "description": "Team Id.", "required": true, "schema": { "title": "String", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.TeamResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } } } } }, "/v1/teams/list": { "get": { "tags": [ "Teams" ], "summary": "List Teams.", "operationId": "ListTeams", "parameters": [ { "name": "Page", "in": "query", "description": "Page index specified in get team list request.", "required": true, "schema": { "title": "Int32", "type": "integer", "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size specified in get team list request.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "default": 10 } }, { "name": "SearchKey", "in": "query", "description": "Teams can be listed by the search key", "schema": { "title": "String", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.TeamListResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } } } } }, "/v1/teams/create": { "post": { "tags": [ "Teams" ], "summary": "Create Team.", "operationId": "CreateTeam", "requestBody": { "description": "team creation.", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateTeamRequest" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateTeamRequest" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateTeamRequest" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateTeamRequest" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateTeamRequest" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateTeamRequest" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateTeamRequest" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateTeamRequest" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateTeamRequest" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateTeamRequest" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateTeamRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateTeamRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateTeamRequest" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateTeamRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateTeamRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateTeamRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateTeamRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.TeamCreated" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } } } } }, "/v1/teams/update": { "put": { "tags": [ "Teams" ], "summary": "Update Team.", "operationId": "UpdateTeam", "requestBody": { "description": "update team.", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.TeamUpdateRequest" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.TeamUpdateRequest" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.TeamUpdateRequest" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.TeamUpdateRequest" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.TeamUpdateRequest" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.TeamUpdateRequest" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.TeamUpdateRequest" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.TeamUpdateRequest" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.TeamUpdateRequest" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.TeamUpdateRequest" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.TeamUpdateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.TeamUpdateRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.TeamUpdateRequest" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.TeamUpdateRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.TeamUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.TeamUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.TeamUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } } } } }, "/v1/template/list": { "get": { "tags": [ "Template" ], "summary": "List all the templates.", "operationId": "ListTemplates", "parameters": [ { "name": "TemplateType", "in": "query", "schema": { "title": "TemplateType", "enum": [ "mytemplates", "sharedtemplate", "all" ], "type": "string" } }, { "name": "PageSize", "in": "query", "schema": { "title": "Int32", "type": "integer", "format": "int32", "default": 10 } }, { "name": "Page", "in": "query", "required": true, "schema": { "title": "Int32", "type": "integer", "format": "int32", "default": 1 } }, { "name": "SearchKey", "in": "query", "schema": { "title": "String", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.TemplateRecords" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/v1/template/create": { "post": { "tags": [ "Template" ], "summary": "Creates a new template.", "operationId": "CreateTemplate", "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "Title" ], "type": "object", "properties": { "Title": { "title": "String", "maxLength": 256, "minLength": 0, "type": "string" }, "Description": { "title": "String", "maxLength": 5000, "minLength": 0, "type": "string" }, "DocumentTitle": { "title": "String", "maxLength": 256, "minLength": 0, "type": "string" }, "DocumentMessage": { "title": "String", "maxLength": 5000, "minLength": 0, "type": "string" }, "Files": { "title": "List`1", "type": "array", "items": { "title": "IFormFile", "type": "string", "format": "binary" } }, "FileUrls": { "title": "Uri[]", "type": "array", "items": { "title": "Uri", "type": "string", "format": "uri" } }, "Roles": { "title": "IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ViewModel.TemplateRole" } }, "AllowModifyFiles": { "title": "Boolean", "type": "boolean", "default": true }, "CC": { "title": "IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.DocumentCC" } }, "BrandId": { "title": "String", "type": "string" }, "AllowMessageEditing": { "title": "Boolean", "type": "boolean", "default": true }, "AllowNewRoles": { "title": "Boolean", "type": "boolean", "default": true }, "AllowNewFiles": { "title": "Boolean", "type": "boolean", "default": true }, "EnableReassign": { "title": "Boolean", "type": "boolean", "default": true }, "EnablePrintAndSign": { "title": "Boolean", "type": "boolean", "default": false }, "EnableSigningOrder": { "title": "Boolean", "type": "boolean", "default": false }, "DocumentInfo": { "title": "IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.DocumentInfo" } }, "UseTextTags": { "title": "Boolean", "type": "boolean", "default": false }, "TextTagDefinitions": { "title": "List`1", "type": "array", "items": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.TextTags.Models.TextTagDefinition" } }, "AutoDetectFields": { "title": "Boolean", "type": "boolean", "default": false } } }, "encoding": { "Title": { "style": "form" }, "Description": { "style": "form" }, "DocumentTitle": { "style": "form" }, "DocumentMessage": { "style": "form" }, "Files": { "style": "form" }, "FileUrls": { "style": "form" }, "Roles": { "style": "form" }, "AllowModifyFiles": { "style": "form" }, "CC": { "style": "form" }, "BrandId": { "style": "form" }, "AllowMessageEditing": { "style": "form" }, "AllowNewRoles": { "style": "form" }, "AllowNewFiles": { "style": "form" }, "EnableReassign": { "style": "form" }, "EnablePrintAndSign": { "style": "form" }, "EnableSigningOrder": { "style": "form" }, "DocumentInfo": { "style": "form" }, "UseTextTags": { "style": "form" }, "TextTagDefinitions": { "style": "form" }, "AutoDetectFields": { "style": "form" } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ViewModel.TemplateCreated" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } } } } }, "/v1/template/createEmbeddedTemplateUrl": { "post": { "tags": [ "Template" ], "summary": "Generates a create URL to embeds template create process into your application.", "operationId": "CreateEmbeddedTemplateUrl", "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "Title" ], "type": "object", "properties": { "RedirectUrl": { "title": "Uri", "type": "string", "format": "uri" }, "ShowToolbar": { "title": "Boolean", "type": "boolean", "default": false }, "ViewOption": { "title": "PageViewOption", "enum": [ "PreparePage", "FillingPage" ], "type": "string", "default": "PreparePage" }, "ShowSaveButton": { "title": "Boolean", "type": "boolean", "default": true }, "Locale": { "title": "Locales", "enum": [ "EN", "NO", "FR", "DE", "ES", "BG", "CS", "DA", "IT", "NL", "PL", "PT", "RO", "RU", "SV" ], "type": "string", "default": "EN" }, "ShowSendButton": { "title": "Nullable`1", "type": "boolean", "deprecated": true }, "ShowCreateButton": { "title": "Boolean", "type": "boolean", "default": true }, "ShowPreviewButton": { "title": "Boolean", "type": "boolean", "default": true }, "ShowNavigationButtons": { "title": "Boolean", "type": "boolean", "default": true }, "LinkValidTill": { "title": "Nullable`1", "type": "string", "format": "date-time" }, "ShowTooltip": { "title": "Boolean", "type": "boolean", "default": false }, "Title": { "title": "String", "maxLength": 256, "minLength": 0, "type": "string" }, "Description": { "title": "String", "maxLength": 5000, "minLength": 0, "type": "string" }, "DocumentTitle": { "title": "String", "maxLength": 256, "minLength": 0, "type": "string" }, "DocumentMessage": { "title": "String", "maxLength": 5000, "minLength": 0, "type": "string" }, "Files": { "title": "List`1", "type": "array", "items": { "title": "IFormFile", "type": "string", "format": "binary" } }, "FileUrls": { "title": "Uri[]", "type": "array", "items": { "title": "Uri", "type": "string", "format": "uri" } }, "Roles": { "title": "IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ViewModel.TemplateRole" } }, "AllowModifyFiles": { "title": "Boolean", "type": "boolean", "default": true }, "CC": { "title": "IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.DocumentCC" } }, "BrandId": { "title": "String", "type": "string" }, "AllowMessageEditing": { "title": "Boolean", "type": "boolean", "default": true }, "AllowNewRoles": { "title": "Boolean", "type": "boolean", "default": true }, "AllowNewFiles": { "title": "Boolean", "type": "boolean", "default": true }, "EnableReassign": { "title": "Boolean", "type": "boolean", "default": true }, "EnablePrintAndSign": { "title": "Boolean", "type": "boolean", "default": false }, "EnableSigningOrder": { "title": "Boolean", "type": "boolean", "default": false }, "DocumentInfo": { "title": "IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.DocumentInfo" } }, "UseTextTags": { "title": "Boolean", "type": "boolean", "default": false }, "TextTagDefinitions": { "title": "List`1", "type": "array", "items": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.TextTags.Models.TextTagDefinition" } }, "AutoDetectFields": { "title": "Boolean", "type": "boolean", "default": false } } }, "encoding": { "RedirectUrl": { "style": "form" }, "ShowToolbar": { "style": "form" }, "ViewOption": { "style": "form" }, "ShowSaveButton": { "style": "form" }, "Locale": { "style": "form" }, "ShowSendButton": { "style": "form" }, "ShowCreateButton": { "style": "form" }, "ShowPreviewButton": { "style": "form" }, "ShowNavigationButtons": { "style": "form" }, "LinkValidTill": { "style": "form" }, "ShowTooltip": { "style": "form" }, "Title": { "style": "form" }, "Description": { "style": "form" }, "DocumentTitle": { "style": "form" }, "DocumentMessage": { "style": "form" }, "Files": { "style": "form" }, "FileUrls": { "style": "form" }, "Roles": { "style": "form" }, "AllowModifyFiles": { "style": "form" }, "CC": { "style": "form" }, "BrandId": { "style": "form" }, "AllowMessageEditing": { "style": "form" }, "AllowNewRoles": { "style": "form" }, "AllowNewFiles": { "style": "form" }, "EnableReassign": { "style": "form" }, "EnablePrintAndSign": { "style": "form" }, "EnableSigningOrder": { "style": "form" }, "DocumentInfo": { "style": "form" }, "UseTextTags": { "style": "form" }, "TextTagDefinitions": { "style": "form" }, "AutoDetectFields": { "style": "form" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.EmbeddedTemplateCreated" } } } } } } }, "/v1/template/getEmbeddedTemplateEditUrl": { "post": { "tags": [ "Template" ], "summary": "Generates a edit URL to embeds template edit process into your application.", "operationId": "getEmbeddedTemplateEditUrl", "parameters": [ { "name": "templateId", "in": "query", "description": "The template id.", "required": true, "schema": { "title": "String", "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "RedirectUrl": { "title": "Uri", "type": "string", "format": "uri" }, "ShowToolbar": { "title": "Boolean", "type": "boolean", "default": false }, "ViewOption": { "title": "PageViewOption", "enum": [ "PreparePage", "FillingPage" ], "type": "string", "default": "PreparePage" }, "ShowSaveButton": { "title": "Boolean", "type": "boolean", "default": true }, "Locale": { "title": "Locales", "enum": [ "EN", "NO", "FR", "DE", "ES", "BG", "CS", "DA", "IT", "NL", "PL", "PT", "RO", "RU", "SV" ], "type": "string", "default": "EN" }, "ShowCreateButton": { "title": "Boolean", "type": "boolean", "default": true }, "ShowPreviewButton": { "title": "Boolean", "type": "boolean", "default": true }, "ShowNavigationButtons": { "title": "Boolean", "type": "boolean", "default": true }, "LinkValidTill": { "title": "Nullable`1", "type": "string", "format": "date-time" }, "ShowTooltip": { "title": "Boolean", "type": "boolean", "default": false } } }, "encoding": { "RedirectUrl": { "style": "form" }, "ShowToolbar": { "style": "form" }, "ViewOption": { "style": "form" }, "ShowSaveButton": { "style": "form" }, "Locale": { "style": "form" }, "ShowCreateButton": { "style": "form" }, "ShowPreviewButton": { "style": "form" }, "ShowNavigationButtons": { "style": "form" }, "LinkValidTill": { "style": "form" }, "ShowTooltip": { "style": "form" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.Models.EmbeddedTemplateEdited" } } } } } } }, "/v1/template/delete": { "delete": { "tags": [ "Template" ], "summary": "Deletes a template.", "operationId": "DeleteTemplate", "parameters": [ { "name": "templateId", "in": "query", "description": "The template id.", "required": true, "schema": { "title": "String", "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/v1/template/send": { "post": { "tags": [ "Template" ], "summary": "Send a document for signature using a Template.", "operationId": "SendUsingTemplate", "parameters": [ { "name": "templateId", "in": "query", "description": "The template id.", "required": true, "schema": { "title": "String", "type": "string" } } ], "requestBody": { "description": "it contains page,page size and status details.", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.SendForSignFromTemplate" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.SendForSignFromTemplate" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.SendForSignFromTemplate" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.SendForSignFromTemplate" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.SendForSignFromTemplate" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.SendForSignFromTemplate" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.SendForSignFromTemplate" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.SendForSignFromTemplate" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.SendForSignFromTemplate" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.SendForSignFromTemplate" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.SendForSignFromTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.SendForSignFromTemplate" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.SendForSignFromTemplate" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.SendForSignFromTemplate" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.SendForSignFromTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.SendForSignFromTemplate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.SendForSignFromTemplate" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.DocumentCreated" } } } } } } }, "/v1/template/createEmbeddedRequestUrl": { "post": { "tags": [ "Template" ], "summary": "Generates a send URL using a template which embeds document sending process into your application.", "operationId": "CreateEmbeddedRequestUrlTemplate", "parameters": [ { "name": "templateId", "in": "query", "description": "The template id.", "required": true, "schema": { "title": "String", "type": "string" } } ], "requestBody": { "description": "Document details, roles and specifications to generate the send url.", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.EmbeddedTemplateRequest" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.EmbeddedTemplateRequest" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.EmbeddedTemplateRequest" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.EmbeddedTemplateRequest" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.EmbeddedTemplateRequest" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.EmbeddedTemplateRequest" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.EmbeddedTemplateRequest" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.EmbeddedTemplateRequest" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.EmbeddedTemplateRequest" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.EmbeddedTemplateRequest" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.EmbeddedTemplateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.EmbeddedTemplateRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.EmbeddedTemplateRequest" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.EmbeddedTemplateRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.EmbeddedTemplateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.EmbeddedTemplateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.EmbeddedTemplateRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.EmbeddedSendCreated" } } } } } } }, "/v1/template/properties": { "get": { "tags": [ "Template" ], "summary": "Get summary of the template.", "operationId": "GetProperties", "parameters": [ { "name": "templateId", "in": "query", "description": "Template Id.", "required": true, "schema": { "title": "String", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.TemplateProperties" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } } } } }, "/v1/template/download": { "get": { "tags": [ "Template" ], "summary": "Download the template.", "operationId": "Download", "parameters": [ { "name": "templateId", "in": "query", "description": "Template Id.", "required": true, "schema": { "title": "String", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "title": "FileStreamResult", "type": "string", "format": "binary" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } } } } }, "/v1/users/create": { "post": { "tags": [ "User" ], "summary": "Create the user.", "operationId": "CreateUser", "requestBody": { "description": "The create user.", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "title": "List`1", "type": "array", "items": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateUser" } } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "title": "List`1", "type": "array", "items": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateUser" } } }, "application/json;odata.metadata=minimal": { "schema": { "title": "List`1", "type": "array", "items": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateUser" } } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "title": "List`1", "type": "array", "items": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateUser" } } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "title": "List`1", "type": "array", "items": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateUser" } } }, "application/json;odata.metadata=full": { "schema": { "title": "List`1", "type": "array", "items": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateUser" } } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "title": "List`1", "type": "array", "items": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateUser" } } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "title": "List`1", "type": "array", "items": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateUser" } } }, "application/json;odata.metadata=none": { "schema": { "title": "List`1", "type": "array", "items": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateUser" } } }, "application/json;odata.streaming=true": { "schema": { "title": "List`1", "type": "array", "items": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateUser" } } }, "application/json;odata.streaming=false": { "schema": { "title": "List`1", "type": "array", "items": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateUser" } } }, "application/json": { "schema": { "title": "List`1", "type": "array", "items": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateUser" } } }, "application/xml": { "schema": { "title": "List`1", "type": "array", "items": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateUser" } } }, "application/prs.odatatestxx-odata": { "schema": { "title": "List`1", "type": "array", "items": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateUser" } } }, "application/json-patch+json": { "schema": { "title": "List`1", "type": "array", "items": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateUser" } } }, "text/json": { "schema": { "title": "List`1", "type": "array", "items": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateUser" } } }, "application/*+json": { "schema": { "title": "List`1", "type": "array", "items": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.CreateUser" } } } } }, "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } } } } }, "/v1/users/update": { "put": { "tags": [ "User" ], "summary": "Update new User role.", "operationId": "UpdateUser", "requestBody": { "description": "update query.", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.UpdateUser" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.UpdateUser" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.UpdateUser" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.UpdateUser" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.UpdateUser" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.UpdateUser" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.UpdateUser" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.UpdateUser" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.UpdateUser" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.UpdateUser" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.UpdateUser" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.UpdateUser" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.UpdateUser" } }, "application/prs.odatatestxx-odata": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.UpdateUser" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.UpdateUser" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.UpdateUser" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.UpdateUser" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } } } } }, "/v1/users/resendInvitation": { "post": { "tags": [ "User" ], "summary": "Resend the users invitation.", "operationId": "ResendInvitation", "parameters": [ { "name": "UserId", "in": "query", "required": true, "schema": { "title": "String", "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } } } } }, "/v1/users/cancelInvitation": { "post": { "tags": [ "User" ], "summary": "Cancel the users invitation.", "operationId": "CancelInvitation", "parameters": [ { "name": "UserId", "in": "query", "required": true, "schema": { "title": "String", "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } } } } }, "/v1/users/list": { "get": { "tags": [ "User" ], "summary": "List user documents.", "operationId": "ListUsers", "parameters": [ { "name": "PageSize", "in": "query", "description": "Page size specified in get user list request.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "default": 10 } }, { "name": "Page", "in": "query", "description": "Page index specified in get user list request.", "required": true, "schema": { "title": "Int32", "type": "integer", "format": "int32", "default": 1 } }, { "name": "Search", "in": "query", "description": "Users can be listed by the search based on the user ID", "schema": { "title": "String", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.UserRecords" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } } } } }, "/v1/users/get": { "get": { "tags": [ "User" ], "summary": "Get summary of the user.", "operationId": "GetUser", "parameters": [ { "name": "userId", "in": "query", "description": "User Id.", "required": true, "schema": { "title": "String", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.UserProperties" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.ErrorResult" } } } } } } } }, "components": { "schemas": { "BoldSign.ApiManagement.Models.AttachmentInfo": { "title": "AttachmentInfo", "required": [ "allowedFileTypes", "title" ], "type": "object", "properties": { "title": { "title": "String", "type": "string", "nullable": true }, "description": { "title": "String", "type": "string", "nullable": true }, "allowedFileTypes": { "title": "String", "type": "string", "nullable": true, "deprecated": true }, "acceptedFileTypes": { "title": "String[]", "type": "array", "items": { "title": "String", "type": "string" }, "nullable": true } }, "additionalProperties": false }, "BoldSign.ApiManagement.Models.AuditTrail": { "title": "AuditTrail", "type": "object", "properties": { "id": { "title": "String", "type": "string", "nullable": true }, "name": { "title": "String", "type": "string", "nullable": true }, "email": { "title": "String", "type": "string", "nullable": true }, "toName": { "title": "String", "type": "string", "nullable": true }, "toEmail": { "title": "String", "type": "string", "nullable": true }, "ipaddress": { "title": "String", "type": "string", "nullable": true }, "action": { "title": "DocumentAuditAction", "enum": [ "Sent", "Viewed", "Signed", "Completed", "Downloaded", "Reassigned", "Declined", "Recalled", "Created", "AuthenticationFailed", "Reminder", "AccessCodeChanged", "AccessCodeViewed", "DownloadedForPrintSign", "FormCreated", "EmailOTP", "AuthenticationRemoved", "DownloadedAuditTrail", "Cloned", "Deleted", "MovedToTrash", "Restored", "AutoReminder", "Resend", "Reviewed", "InitiatePrintSign", "CancelPrintSign", "CompletePrintSign", "GeneratedEmbeddedSignLink", "EmbeddedSigned", "EmbeddedReviewed", "ExpiryDateExtended", "Attachment", "EditRecipient", "AuthenticationAdded", "AutoReminderON", "AutoReminderOFF", "SMSOTP", "PhoneNumberChanged", "UnlockedSmsOtp", "SmsAuthenticationAdded", "SmsAuthenticationRemoved", "SmsOtpVerify", "SmsAuthenticationFailed", "UnlockEmailOTP", "EmailAuthenticationAdded", "EmailAuthenticationRemoved", "EmailOtpVerify", "EmailAuthenticationFailed", "SMSOTPResend", "EmailOTPResend", "ResumeDocumentSigning", "EmailOTPAuthenticationAdded", "EmailOTPAuthenticationRemoved", "EmailOTPAuthenticationFailed", "EmailOTPVerified", "IdentityVerificationInitiated", "IdentityVerificationRemoved", "IdentityVerificationCompleted", "IdentityVerificationFailed", "DownloadedVerificationData", "ManualIdentityVerificationCompleted", "IdentityVerificationReset", "CreateEmbeddedVerificationLink", "SensitiveDataDownloaded", "IdVerificationRemoved", "IdVerificationAdded", "ManualIdentityVerificationInitiated" ], "type": "string" }, "timestamp": { "title": "Int64", "type": "integer", "format": "int64" } }, "additionalProperties": false }, "BoldSign.ApiManagement.Models.ConditionalRule": { "title": "ConditionalRule", "type": "object", "properties": { "fieldId": { "title": "String", "type": "string", "nullable": true }, "isChecked": { "title": "Boolean", "type": "boolean" }, "value": { "title": "String", "type": "string", "nullable": true } }, "additionalProperties": false }, "BoldSign.ApiManagement.Models.CreateSenderIdentityRequest": { "title": "CreateSenderIdentityRequest", "required": [ "email", "name" ], "type": "object", "properties": { "name": { "title": "String", "maxLength": 50, "minLength": 0, "type": "string" }, "email": { "title": "String", "maxLength": 250, "minLength": 0, "type": "string" }, "notificationSettings": { "$ref": "#/components/schemas/BoldSign.ApiManagement.ViewModel.NotificationSettings" }, "brandId": { "title": "String", "type": "string", "nullable": true }, "redirectUrl": { "title": "Uri", "type": "string", "format": "uri", "nullable": true } }, "additionalProperties": false }, "BoldSign.ApiManagement.Models.CreateTeamRequest": { "title": "CreateTeamRequest", "required": [ "teamName" ], "type": "object", "properties": { "teamName": { "title": "String", "maxLength": 255, "minLength": 0, "type": "string" } }, "additionalProperties": false }, "BoldSign.ApiManagement.Models.CreateUser": { "title": "CreateUser", "required": [ "emailId" ], "type": "object", "properties": { "emailId": { "title": "String", "minLength": 1, "type": "string" }, "teamId": { "title": "String", "type": "string", "nullable": true }, "userRole": { "title": "UserRoleType", "enum": [ "Admin", "TeamAdmin", "Member" ], "type": "string" }, "metaData": { "title": "Dictionary`2", "maxLength": 50, "type": "object", "additionalProperties": { "title": "String", "type": "string", "nullable": true }, "nullable": true } }, "additionalProperties": false }, "BoldSign.ApiManagement.Models.CustomFormField": { "title": "CustomFormField", "required": [ "fieldType", "font" ], "type": "object", "properties": { "fieldType": { "title": "FieldType", "enum": [ "Signature", "Initial", "CheckBox", "TextBox", "Label", "DateSigned", "RadioButton", "Image", "Attachment", "EditableDate", "Hyperlink", "Dropdown", "Title", "Company" ], "type": "string" }, "width": { "title": "Single", "type": "number", "format": "float" }, "height": { "title": "Single", "type": "number", "format": "float" }, "isRequired": { "title": "Boolean", "type": "boolean" }, "isReadOnly": { "title": "Boolean", "type": "boolean" }, "value": { "title": "String", "type": "string", "nullable": true }, "fontSize": { "title": "Single", "minimum": 0, "type": "number", "format": "float", "default": 13 }, "font": { "title": "FontFamily", "enum": [ "Helvetica", "Courier", "TimesRoman", "NotoSans" ], "type": "string" }, "fontHexColor": { "title": "String", "type": "string", "nullable": true }, "isBoldFont": { "title": "Boolean", "type": "boolean" }, "isItalicFont": { "title": "Boolean", "type": "boolean" }, "isUnderLineFont": { "title": "Boolean", "type": "boolean" }, "lineHeight": { "title": "Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32", "default": 15 }, "characterLimit": { "title": "Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32", "default": 0 }, "placeHolder": { "title": "String", "type": "string", "nullable": true }, "validationType": { "title": "ValidationType", "enum": [ "None", "NumbersOnly", "EmailAddress", "Currency", "CustomRegex" ], "type": "string" }, "validationCustomRegex": { "title": "String", "type": "string", "nullable": true }, "validationCustomRegexMessage": { "title": "String", "type": "string", "nullable": true }, "dateFormat": { "title": "String", "type": "string", "nullable": true }, "timeFormat": { "title": "String", "type": "string", "nullable": true }, "imageInfo": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.ImageInfo" }, "attachmentInfo": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.AttachmentInfo" }, "editableDateFieldSettings": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.EditableDateFieldSettings" }, "hyperlinkText": { "title": "String", "type": "string", "nullable": true }, "dataSyncTag": { "title": "String", "type": "string", "nullable": true }, "dropdownOptions": { "title": "String[]", "type": "array", "items": { "title": "String", "type": "string" }, "nullable": true }, "textAlign": { "title": "TextAlign", "enum": [ "Left", "Center", "Right" ], "type": "string" }, "textDirection": { "title": "TextDirection", "enum": [ "LTR", "RTL" ], "type": "string" }, "characterSpacing": { "title": "Single", "type": "number", "format": "float" }, "idPrefix": { "title": "String", "type": "string", "nullable": true }, "restrictIdPrefixChange": { "title": "Boolean", "type": "boolean", "default": false } }, "additionalProperties": false }, "BoldSign.ApiManagement.Models.DocumentCC": { "title": "DocumentCC", "required": [ "emailAddress" ], "type": "object", "properties": { "emailAddress": { "title": "String", "minLength": 1, "type": "string" } }, "additionalProperties": false }, "BoldSign.ApiManagement.Models.DocumentSigner": { "title": "DocumentSigner", "required": [ "name" ], "type": "object", "properties": { "name": { "title": "String", "minLength": 1, "type": "string" }, "emailAddress": { "title": "String", "type": "string", "nullable": true }, "privateMessage": { "title": "String", "maxLength": 5000, "type": "string", "nullable": true }, "authenticationType": { "title": "AuthenticationType", "enum": [ "None", "EmailOTP", "AccessCode", "SMSOTP", "IdVerification" ], "type": "string" }, "phoneNumber": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.PhoneNumber" }, "deliveryMode": { "title": "DeliveryMode", "enum": [ "Email", "SMS", "EmailAndSMS" ], "type": "string" }, "authenticationCode": { "title": "String", "maxLength": 50, "type": "string", "nullable": true }, "identityVerificationSettings": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.IdentityVerificationSettings" }, "signerOrder": { "title": "Int32", "type": "integer", "format": "int32" }, "enableEmailOTP": { "title": "Boolean", "type": "boolean" }, "signerType": { "title": "SignerType", "enum": [ "Signer", "Reviewer", "InPersonSigner" ], "type": "string" }, "hostEmail": { "title": "String", "type": "string", "nullable": true }, "signerRole": { "title": "String", "type": "string", "nullable": true }, "allowFieldConfiguration": { "title": "Boolean", "type": "boolean" }, "formFields": { "title": "IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/BoldSign.ApiManagement.Models.FormField" }, "nullable": true }, "language": { "title": "Languages", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ], "type": "integer", "description": "
Description:
Description:
Description:
Description:
Description:
Description: