{ "swagger": "2.0", "info": { "version": "v5", "title": "API Version: 5.0", "description": "" }, "host": "esign.alphatrust.com", "basePath": "/rest", "schemes": [ "https" ], "paths": { "/api/v5/auditreports": { "post": { "tags": [ "AuditReports" ], "summary": "Get Audit Report.", "operationId": "GetAuditReports", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "auditReportDetailsRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/AuditReportDetailsRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AuditReportDetailsServiceReturnModel" } } } } }, "/api/v5/communications/communicationtest": { "get": { "tags": [ "Communications" ], "summary": "CommunicationTest - Verify API Endpoint Connectivity", "operationId": "CommunicationTest", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DefaultServiceReturnModel" } } } } }, "/api/v5/communications/serviceauthenticationtest": { "post": { "tags": [ "Communications" ], "summary": "ServiceAuthenticationTest - Verify API Credentials", "operationId": "ServiceAuthenticationTest", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DefaultServiceReturnModel" } } } } }, "/api/v5/documents": { "put": { "tags": [ "Documents" ], "summary": "Update an existing Document.", "operationId": "UpdateDocuments", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "documentUpdateRequestModel", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DocumentUpdateRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DefaultServiceReturnModel" } } } }, "post": { "tags": [ "Documents" ], "summary": "Get an existing Document.", "operationId": "GetDocuments", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "documentRequestModel", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DocumentDetailsRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DocumentDetailsServiceReturnModel" } } } } }, "/api/v5/documents/void": { "put": { "tags": [ "Documents" ], "summary": "Void an existing Document.", "operationId": "VoidDocuments", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "documentVoidRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DocumentVoidRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DefaultServiceReturnModel" } } } } }, "/api/v5/documents/completed": { "put": { "tags": [ "Documents" ], "summary": "Update Documents Completed.", "operationId": "UpdateDocumentsCompleted", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "documentCompletedUpdateRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DocumentCompletedUpdateRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DefaultServiceReturnModel" } } } } }, "/api/v5/documents/formfields": { "put": { "tags": [ "Documents" ], "summary": "Update Document Form Fields.", "operationId": "UpdateDocumentFormFields", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "documentUpdateFormFieldsRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DocumentUpdateFormFieldsRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DefaultServiceReturnModel" } } } } }, "/api/v5/documents/textstamps": { "put": { "tags": [ "Documents" ], "summary": "Update Document Text Stamps.", "operationId": "UpdateDocumentTextStamps", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "documentUpdateTextStampsRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DocumentUpdateTextStampsRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DefaultServiceReturnModel" } } } } }, "/api/v5/documents/files": { "post": { "tags": [ "Documents" ], "summary": "Retrieve Document Files.", "operationId": "GetDocumentFiles", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "documentFileRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DocumentFileDetailsRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DocumentFileDetailsServiceReturnModel" } } } } }, "/api/v5/documents/insert": { "post": { "tags": [ "Documents" ], "summary": "Insert a Document.", "operationId": "InsertDocuments", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "documentInsertRequestModel", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DocumentInsertRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DocumentDetailsServiceReturnModel" } } } } }, "/api/v5/documents/filelinks": { "post": { "tags": [ "Documents" ], "summary": "Retrieve Document File Links.", "operationId": "GetDocumentFileLinks", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "documentFileLinkRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DocumentFileLinkDetailsRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DocumentFileLinkDetailsServiceReturnModel" } } } } }, "/api/v5/documents/tiffformat": { "post": { "tags": [ "Documents" ], "summary": "Retrieve Documents in TIFF Format.", "operationId": "GetDocumentFilesInTiffFormat", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "documentTiffRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DocumentTiffDetailsRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DocumentFileDetailsServiceReturnModel" } } } } }, "/api/v5/documents/completedstatusauthenticity": { "post": { "tags": [ "Documents" ], "summary": "Verify Completed Document Authenticity.", "operationId": "VerifyCompletedDocumentsAuthenticity", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "documentVerifyRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DocumentVerifyRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DocumentVerificationServiceReturnModel" } } } } }, "/api/v5/documentsupdateable": { "post": { "tags": [ "DocumentsUpdateable" ], "summary": "Get the Document object that you can use to update with the UpdateDocuments() method.", "operationId": "GetDocumentsUpdateable", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "documentRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DocumentUpdateableRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DocumentUpdateableServiceReturnModel" } } } } }, "/api/v5/documentsupdateable/completed": { "post": { "tags": [ "DocumentsUpdateable" ], "summary": "Get the Document object that's in the 'Completed' status that you can use to update with the UpdateDocuments()\r\nmethod.", "operationId": "GetDocumentsCompletedUpdateable", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "documentCompletedUpdateableRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DocumentCompletedUpdateableRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DocumentCompletedUpdateableServiceReturnModel" } } } } }, "/api/v5/fileattachments": { "post": { "tags": [ "FileAttachments" ], "summary": "Get File Attachments.", "operationId": "GetFileAttachments", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "fileAttachmentRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/FileAttachmentDetailsRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FileAttachmentDetailsServiceReturnModel" } } } } }, "/api/v5/fileattachments/insert": { "post": { "tags": [ "FileAttachments" ], "summary": "Insert File Attachments.", "operationId": "InsertFileAttachments", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "fileAttachmentInsertRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/FileAttachmentInsertRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FileAttachmentDetailsServiceReturnModel" } } } } }, "/api/v5/groups": { "put": { "tags": [ "Groups" ], "summary": "Update an existing Group.", "operationId": "UpdateGroupsAsync", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "groupUpdateRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/GroupUpdateRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DefaultServiceReturnModel" } } } }, "post": { "tags": [ "Groups" ], "summary": "Get group information.", "operationId": "GetGroups", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "groupRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/GroupDetailsRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GroupDetailsServiceReturnModel" } } } }, "delete": { "tags": [ "Groups" ], "summary": "Delete a Group.", "operationId": "DeleteGroupsAsync", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "groupDeleteRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/GroupDeleteRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DefaultServiceReturnModel" } } } } }, "/api/v5/groups/insert": { "post": { "tags": [ "Groups" ], "summary": "insert a Group.", "operationId": "InsertGroupsAsync", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "groupInsertRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/GroupInsertRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GroupDetailsServiceReturnModel" } } } } }, "/api/v5/groupsupdateable": { "post": { "tags": [ "GroupsUpdateable" ], "summary": "Get Groups Updateable.", "operationId": "GetGroupsUpdateable", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "groupUpdateableRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/GroupUpdateableRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GroupUpdateableServiceReturnModel" } } } } }, "/api/v5/htmlwrapper": { "post": { "tags": [ "HtmlWrapper" ], "summary": "Get Process Html Wrapper Request.", "operationId": "GetProcessHtmlWrapperAsync", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "groupHtmlWrapperRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/GroupHtmlWrapperRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GroupHtmlWrapperServiceReturnModel" } } } } }, "/api/v5/participantfileattachments": { "post": { "tags": [ "ParticipantFileAttachments" ], "summary": "Get File Attachments.", "operationId": "GetFileAttachments", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "fileAttachmentRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/FileAttachmentDetailsRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FileAttachmentDetailsServiceReturnModel" } } } } }, "/api/v5/participantfileattachments/insert": { "post": { "tags": [ "ParticipantFileAttachments" ], "summary": "Insert File Attachments.", "operationId": "InsertFileAttachments", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "fileAttachmentInsertRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/ParticipantFileAttachmentInsertRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FileAttachmentDetailsServiceReturnModel" } } } } }, "/api/v5/participants": { "put": { "tags": [ "Participants" ], "summary": "Update Participant.", "operationId": "UpdateParticipants", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "participantUpdateRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/ParticipantUpdateRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DefaultServiceReturnModel" } } } }, "post": { "tags": [ "Participants" ], "summary": "Get a Participant.", "operationId": "GetParticipants", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "participantRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/ParticipantDetailsRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ParticipantDetailsServiceReturnModel" } } } } }, "/api/v5/participants/workflowactionstatus": { "put": { "tags": [ "Participants" ], "summary": "Update Participant Workflow Action Status.", "operationId": "UpdateParticipantWorkflowActionStatus", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "participantWorkflowActionUpdateRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/ParticipantWorkflowActionUpdateRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ParticipantWorkflowActionServiceReturnModel" } } } } }, "/api/v5/participants/insert": { "post": { "tags": [ "Participants" ], "summary": "Insert a Participant.", "operationId": "InsertParticipants", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "participantInsertRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/ParticipantInsertRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ParticipantDetailsServiceReturnModel" } } } } }, "/api/v5/participants/emailnotification": { "post": { "tags": [ "Participants" ], "summary": "Re-send Participant Email Notification.", "operationId": "ResendParticipantEmailNotifications", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "participantResendNotificationRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/ParticipantResendNotificationRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DefaultServiceReturnModel" } } } } }, "/api/v5/participants/encryptedcredentials": { "post": { "tags": [ "Participants" ], "summary": "Get Participant Encrypted Credentials.", "operationId": "GetParticipantEncryptedCredentials", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "participantEncryptedCredentialsRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/ParticipantEncryptedCredentialsRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ParticipantEncryptedCredentialsServiceReturnModel" } } } } }, "/api/v5/participantsupdateable/participantAuthentication": { "put": { "tags": [ "ParticipantsUpdateable" ], "operationId": "UpdateParticipantAuthentications", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ParticipantAuthenticationUpdateRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DefaultServiceReturnModel" } } } } }, "/api/v5/participantsupdateable/participantWorkflowActions": { "put": { "tags": [ "ParticipantsUpdateable" ], "operationId": "UpdateParticipantWorkflowActions", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "participantWorkflowActionsUpdateRequestModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ParticipantWorkflowActionsUpdateRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DefaultServiceReturnModel" } } } } }, "/api/v5/participantsupdateable/participantContentPlaceholders": { "put": { "tags": [ "ParticipantsUpdateable" ], "operationId": "UpdateParticipantContentPlaceholders", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "participantContentPlaceholderUpdateRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ParticipantContentPlaceholderUpdateRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DefaultServiceReturnModel" } } } } }, "/api/v5/participantsupdateable": { "post": { "tags": [ "ParticipantsUpdateable" ], "summary": "Get Participant Updateable.", "operationId": "GetParticipantsUpdateable", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "participantUpdateableRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/ParticipantUpdateableRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ParticipantUpdateableServiceReturnModel" } } } } }, "/api/v5/participantsupdateable/authentication": { "post": { "tags": [ "ParticipantsUpdateable" ], "operationId": "GetParticipantAuthenticationsUpdateable", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ParticipantAuthenticationUpdateableRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ParticipantAuthenticationUpdateableServiceReturnModel" } } } } }, "/api/v5/participantsupdateable/workflowActions": { "post": { "tags": [ "ParticipantsUpdateable" ], "operationId": "GetParticipantWorkflowActionsUpdateable", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "participantWorkflowActionsUpdateableRequestModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ParticipantWorkflowActionsUpdateableRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ParticipantWorkflowActionsUpdateableReturnModel" } } } } }, "/api/v5/participantsupdateable/contentPlaceholders": { "post": { "tags": [ "ParticipantsUpdateable" ], "operationId": "GetParticipantContentPlaceholdersUpdateable", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "participantContentPlaceholderUpdateableRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ParticipantContentPlaceholderUpdateableRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ParticipantContentPlaceholderUpdateableServiceReturnModel" } } } } }, "/api/v5/participantsupdateable/insertContentPlaceholders": { "post": { "tags": [ "ParticipantsUpdateable" ], "operationId": "InsertParticipantContentPlaceholders", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "participantContentPlaceholderInsertRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ParticipantContentPlaceholderInsertRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ParticipantContentPlaceholderDetailsServiceReturnModel" } } } } }, "/api/v5/participantsupdateable/deleteContentPlaceholders": { "delete": { "tags": [ "ParticipantsUpdateable" ], "operationId": "DeleteParticipantContentPlaceholderAsync", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "participantContentPlaceholderDeleteRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ParticipantContentPlaceholderDeleteRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DefaultServiceReturnModel" } } } } }, "/api/v5/pdf/seal": { "post": { "tags": [ "Pdf" ], "summary": "Seal PDF", "operationId": "SealPdfs", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "transactionCertifySealRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/TransactionCertifySealRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CertifySealPdfsServiceReturnModel" } } } } }, "/api/v5/pdf/certify": { "post": { "tags": [ "Pdf" ], "summary": "Certify PDF", "operationId": "CertifyPdfs", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "transactionCertifySealRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/TransactionCertifySealRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CertifySealPdfsServiceReturnModel" } } } } }, "/api/v5/pdf/dataFiles": { "post": { "tags": [ "Pdf" ], "summary": "Get PDF Data Files.", "operationId": "GetPdfDataFiles", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "documentPdfDataFileRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DocumentPdfDataFileDetailsRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DocumentFileDetailsServiceReturnModel" } } } } }, "/api/v5/public/getpreloadscripts": { "get": { "tags": [ "Public" ], "operationId": "GetPreloadScripts", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PreloadScriptsModel" } } } } }, "/api/v5/securitytoken": { "post": { "tags": [ "SecurityToken" ], "summary": "Get Transaction Security Token Data.", "operationId": "GetTransactionTokenData", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "transactionTokenDataRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/TransactionTokenDataRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TransactionTokenDataServiceReturnModel" } } } } }, "/api/v5/tasks": { "put": { "tags": [ "Tasks" ], "summary": "Update Task.", "operationId": "UpdateTasks", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "taskUpdateRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/TaskUpdateRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DefaultServiceReturnModel" } } } }, "post": { "tags": [ "Tasks" ], "summary": "Get Task.", "operationId": "GetTasks", "consumes": [ "application/json", "text/json", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "taskRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/TaskDetailsRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TaskDetailsServiceReturnModel" } } } } }, "/api/v5/tasks/workflowactionstatus": { "put": { "tags": [ "Tasks" ], "summary": "Update Task Workflow Action Status.", "operationId": "UpdateTaskWorkflowActionStatus", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "taskWorkflowActionUpdateRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/TaskWorkflowActionUpdateRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TaskWorkflowActionServiceReturnModel" } } } } }, "/api/v5/tasks/insert": { "post": { "tags": [ "Tasks" ], "summary": "Insert a Task.", "operationId": "InsertTasks", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "taskInsertRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/TaskInsertRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TaskDetailsServiceReturnModel" } } } } }, "/api/v5/tasks/remotesign": { "post": { "tags": [ "Tasks" ], "summary": "Remote Sign a Task.", "operationId": "RemoteSign", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "taskRemoteSignRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/TaskRemoteSignRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DefaultServiceReturnModel" } } } } }, "/api/v5/tasksupdateable/taskWorkflowActions": { "put": { "tags": [ "TasksUpdateable" ], "operationId": "UpdateTaskWorkflowActions", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "taskWorkflowActionsUpdateRequestModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TaskWorkflowActionsUpdateRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DefaultServiceReturnModel" } } } } }, "/api/v5/tasksupdateable": { "post": { "tags": [ "TasksUpdateable" ], "summary": "Get Task Updateable.", "operationId": "GetTasksUpdateable", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "taskUpdateableRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/TaskUpdateableRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TaskUpdateableServiceReturnModel" } } } } }, "/api/v5/tasksupdateable/workflowActions": { "post": { "tags": [ "TasksUpdateable" ], "operationId": "GetTaskWorkflowActionsUpdateable", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "taskWorkflowActionsUpdateableRequestModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TaskWorkflowActionsUpdateableRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TaskWorkflowActionsUpdateableReturnModel" } } } } }, "/api/v5/transactions": { "put": { "tags": [ "Transactions" ], "summary": "Update an existing Transaction.", "operationId": "UpdateTransactions", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "transactionUpdateRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/TransactionUpdateRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DefaultServiceReturnModel" } } } }, "post": { "tags": [ "Transactions" ], "summary": "Get Transaction.", "operationId": "GetTransactions", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "transRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/TransactionDetailsRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TransactionDetailsServiceReturnModel" } } } } }, "/api/v5/transactions/close": { "put": { "tags": [ "Transactions" ], "summary": "Close Transaction.", "operationId": "CloseTransactions", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "transCloseRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/TransactionCloseRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DefaultServiceReturnModel" } } } } }, "/api/v5/transactions/create": { "post": { "tags": [ "Transactions" ], "summary": "Create Transaction.", "operationId": "CreateTransactions", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "transCreateRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/TransactionCreateRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TransactionDetailsServiceReturnModel" } } } } }, "/api/v5/transactions/events": { "post": { "tags": [ "Transactions" ], "summary": "Retrieve Transaction Events", "operationId": "GetTransactionEvents", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "transactionEventsRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/TransactionEventsRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TransactionEventsServiceReturnModel" } } } } }, "/api/v5/transactions/evidencepackage": { "post": { "tags": [ "Transactions" ], "summary": "Get Transaction Evidence Package.", "operationId": "GetTransactionEvidencePackages", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "transactionEvidencePackageRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/TransactionEvidencePackageRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TransactionEvidencePackageServiceReturnModel" } } } } }, "/api/v5/transactionsupdateable": { "post": { "tags": [ "TransactionsUpdateable" ], "summary": "Get Transaction Updateable.", "operationId": "GetTransactionsUpdateable", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "transUpdateableRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/TransactionUpdateableRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TransactionUpdateableServiceReturnModel" } } } } }, "/api/v5/users": { "put": { "tags": [ "Users" ], "summary": "Update an existing User.", "operationId": "UpdateUsersAsync", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "userUpdateRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/UserUpdateRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DefaultServiceReturnModel" } } } }, "post": { "tags": [ "Users" ], "summary": "Get User.", "operationId": "GetUsers", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "userRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/UserDetailsRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDetailsServiceReturnModel" } } } }, "delete": { "tags": [ "Users" ], "summary": "Delete a User.", "operationId": "DeleteUsersAsync", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "userDeleteRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/UserDeleteRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DefaultServiceReturnModel" } } } } }, "/api/v5/users/insert": { "post": { "tags": [ "Users" ], "summary": "Insert User.", "operationId": "InsertUsersAsync", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "userInsertRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/UserInsertRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDetailsServiceReturnModel" } } } } }, "/api/v5/usersupdateable": { "post": { "tags": [ "UsersUpdateable" ], "summary": "Get Users Updateable.", "operationId": "GetUsersUpdateable", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "userUpdateableRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/UserUpdateableRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserUpdateableServiceReturnModel" } } } } }, "/api/v5/workflows": { "post": { "tags": [ "Workflows" ], "summary": "Get Workflows", "operationId": "GetWorkflows", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "workflowRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/WorkflowRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/WorkflowTransactionServiceReturnModel" } } } } }, "/api/v5/workflows/list": { "post": { "tags": [ "Workflows" ], "summary": "Get Workflow List", "operationId": "GetWorkflowList", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "workflowsListRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/WorkflowListRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/WorkflowListServiceReturnModel" } } } } }, "/api/v5/workflows/launch": { "post": { "tags": [ "Workflows" ], "summary": "Get Workflow Launch Rules", "operationId": "GetWorkflowLaunchRules", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "launchRulesRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/WorkflowLaunchRulesRequestModel" } }, { "name": "ApiKey", "in": "header", "required": true, "type": "string" }, { "name": "ApiSecret", "in": "header", "required": true, "type": "string" }, { "name": "ApiUsername", "in": "header", "required": true, "type": "string" }, { "name": "ApiPassword", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/WorkflowLaunchRulesServiceReturnModel" } } } } } }, "definitions": { "AuditReportDetailsRequestModel": { "type": "object", "properties": { "IDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "IDs", "wrapped": true } }, "TransactionIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "TransactionIDs", "wrapped": true } }, "ParticipantIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "ParticipantIDs", "wrapped": true } }, "TaskIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "TaskIDs", "wrapped": true } }, "AuditReportType": { "enum": [ "Pdf", "Xml" ], "type": "string" }, "EnableLogging": { "type": "boolean" }, "TimeZoneID": { "type": "string" } }, "xml": { "name": "AuditReportDetailsRequestModel" } }, "AuditReportDetailsServiceReturnModel": { "type": "object", "properties": { "IsSuccessful": { "type": "boolean" }, "Message": { "type": "string" }, "AuditReports": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/AuditReportDetailsModel" } ], "xml": { "name": "AuditReport" } }, "xml": { "name": "AuditReports", "wrapped": true } }, "ProcessingTime": { "type": "string" }, "TimeZoneUtcOffset": { "format": "double", "type": "number" } }, "xml": { "name": "AuditReportDetailsServiceReturnModel" } }, "AuditReportDetailsModel": { "type": "object", "properties": { "DocumentID": { "format": "int32", "type": "integer" }, "AuditReport": { "$ref": "#/definitions/DocumentFileModel" } }, "xml": { "name": "AuditReportDetailsModel" } }, "DocumentFileModel": { "type": "object", "properties": { "FileBytes": { "format": "byte", "type": "string" }, "FileName": { "type": "string" }, "MimeType": { "type": "string" } }, "xml": { "name": "DocumentFileModel" } }, "DefaultServiceReturnModel": { "type": "object", "properties": { "IsSuccessful": { "type": "boolean" }, "Message": { "type": "string" }, "ProcessingTime": { "type": "string" }, "TimeZoneUtcOffset": { "format": "double", "type": "number" } }, "xml": { "name": "DefaultServiceReturnModel" } }, "DocumentUpdateRequestModel": { "type": "object", "properties": { "Documents": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/DocumentUpdateModel" } ], "xml": { "name": "Document" } }, "xml": { "name": "Documents", "wrapped": true } }, "EnableLogging": { "type": "boolean" } }, "xml": { "name": "DocumentUpdateRequestModel" } }, "DocumentUpdateModel": { "required": [ "ID", "Title" ], "type": "object", "properties": { "ID": { "format": "int32", "type": "integer" }, "Title": { "type": "string" }, "UserFileNameType": { "enum": [ "UseDocTitleSlashUserFileNamePlusSignerNamesPlusExtension", "UseOldNameFormatOfDocumentIdPlusExtension", "UseSignerNamesPlusDocTitleSlashUserFileNamePlusExtension", "UseDocTitleSlashUserFileNamePlusSignerNamesInLastCommaFirstOrderPlusExtension", "UseSignerNamesInLastCommaFirstOrderPlusDocTitleSlashUserFileNamePlusExtension", "UseDocTitleSlashUserFileNameOnly", "UseDocFileNamePlusSignerNamesInFirstNameLastNamePlusDocumentID", "UseDocFileNamePlusDocumentID" ], "type": "string" }, "UserFileName": { "type": "string" }, "InformationText": { "type": "string" }, "ContactText": { "type": "string" }, "EmailTemplateSetName": { "type": "string" }, "EnableSignatureInformationAnnotation": { "type": "boolean" }, "NeverAllowAsEmailAttachment": { "type": "boolean" }, "IsOptional": { "type": "boolean" }, "DeleteDate": { "format": "date-time", "type": "string" }, "Fields": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/FormFieldModel" } ], "xml": { "name": "Field" } }, "xml": { "name": "Fields", "wrapped": true } }, "IncludeAuditReportWithCompletedDocuments": { "type": "boolean" } }, "xml": { "name": "DocumentUpdateModel" } }, "FormFieldModel": { "required": [ "Name", "Value" ], "type": "object", "properties": { "Name": { "type": "string" }, "Value": { "type": "string" } }, "xml": { "name": "FormFieldModel" } }, "DocumentDetailsRequestModel": { "type": "object", "properties": { "ProntoID": { "type": "string" }, "IDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "IDs", "wrapped": true } }, "TransactionIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "TransactionIDs", "wrapped": true } }, "ParticipantIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "ParticipantIDs", "wrapped": true } }, "TaskIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "TaskIDs", "wrapped": true } }, "MetaDataName": { "type": "string" }, "MetaDataValue": { "type": "string" }, "StatusType": { "enum": [ "All", "Validating", "Pending", "TheRealPending", "Completed", "EmailSent", "Closed", "Cancelled", "Expired", "Voided" ], "type": "string" }, "SearchDateType": { "enum": [ "CreatedDate", "ClosedDate" ], "type": "string" }, "SearchDateFrom": { "format": "date-time", "type": "string" }, "SearchDateTo": { "format": "date-time", "type": "string" }, "Includes": { "$ref": "#/definitions/DocumentIncludesModel" }, "EnableLogging": { "type": "boolean" }, "ResultsCountLimit": { "format": "int32", "type": "integer" }, "ResultsCountStart": { "format": "int32", "type": "integer" }, "TimeZoneID": { "type": "string" } }, "xml": { "name": "DocumentDetailsRequestModel" } }, "DocumentIncludesModel": { "type": "object", "properties": { "IncludeFile": { "type": "boolean" }, "FileIncludes": { "$ref": "#/definitions/DocumentFileIncludesModel" }, "IncludeMetaData": { "type": "boolean" }, "IncludeWorkflowActions": { "type": "boolean" }, "IncludeTasks": { "type": "boolean" }, "TaskIncludes": { "$ref": "#/definitions/TaskIncludesModel" }, "IncludeTests": { "type": "boolean" }, "IncludeVersions": { "type": "boolean" } }, "xml": { "name": "DocumentIncludesModel" } }, "DocumentFileIncludesModel": { "type": "object", "properties": { "IncludeNonWatermarkedVersion": { "type": "boolean" }, "IncludePdfStampedWithCopyWatermark": { "type": "boolean" }, "IncludeFileUnlocked": { "type": "boolean" }, "IncludeOriginalSourceFile": { "type": "boolean" }, "IncludeSpecificVersion": { "format": "int32", "type": "integer" } }, "xml": { "name": "DocumentFileIncludesModel" } }, "TaskIncludesModel": { "type": "object", "properties": { "IncludeWorkflowActions": { "type": "boolean" }, "IncludeFileAttachments": { "type": "boolean" }, "IncludeTests": { "type": "boolean" }, "IncludeSignatureBlock": { "type": "boolean" }, "IncludeFileAttachmentsInfoOnly": { "type": "boolean" } }, "xml": { "name": "TaskIncludesModel" } }, "DocumentDetailsServiceReturnModel": { "type": "object", "properties": { "IsSuccessful": { "type": "boolean" }, "Message": { "type": "string" }, "Documents": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/DocumentDetailsModel" } ], "xml": { "name": "Document" } }, "xml": { "name": "Documents", "wrapped": true } }, "ProcessingTime": { "type": "string" }, "TimeZoneUtcOffset": { "format": "double", "type": "number" } }, "xml": { "name": "DocumentDetailsServiceReturnModel" } }, "DocumentDetailsModel": { "type": "object", "properties": { "ID": { "format": "int32", "type": "integer" }, "AccessToken": { "type": "string" }, "TransactionID": { "format": "int32", "type": "integer" }, "StatusID": { "format": "int32", "type": "integer" }, "Title": { "type": "string" }, "UserFileNameType": { "enum": [ "UseDocTitleSlashUserFileNamePlusSignerNamesPlusExtension", "UseOldNameFormatOfDocumentIdPlusExtension", "UseSignerNamesPlusDocTitleSlashUserFileNamePlusExtension", "UseDocTitleSlashUserFileNamePlusSignerNamesInLastCommaFirstOrderPlusExtension", "UseSignerNamesInLastCommaFirstOrderPlusDocTitleSlashUserFileNamePlusExtension", "UseDocTitleSlashUserFileNameOnly", "UseDocFileNamePlusSignerNamesInFirstNameLastNamePlusDocumentID", "UseDocFileNamePlusDocumentID" ], "type": "string" }, "UserFileName": { "type": "string" }, "InformationText": { "type": "string" }, "ContactText": { "type": "string" }, "EmailTemplateSetName": { "type": "string" }, "EnableSignatureInformationAnnotation": { "type": "boolean" }, "NeverAllowAsEmailAttachment": { "type": "boolean" }, "DoNotFlattenPdfFormFields": { "type": "boolean" }, "IsOptional": { "type": "boolean" }, "PageStamp": { "$ref": "#/definitions/PageStampModel" }, "AdditionalSignaturePage": { "$ref": "#/definitions/AdditionalSignaturePageModel" }, "ServiceType": { "enum": [ "Sign", "SignAndCertify", "SignAndSeal" ], "type": "string" }, "SourceFileType": { "enum": [ "Pdf", "Html" ], "type": "string" }, "SourceFileAccessType": { "enum": [ "File", "Inline" ], "type": "string" }, "DisplayBitonalPdfPageImages": { "type": "boolean" }, "PdfPageCount": { "format": "int32", "type": "integer" }, "PdfPageImageRenderDpi": { "format": "double", "type": "number" }, "File": { "$ref": "#/definitions/DocumentFileModel" }, "CreatedDate": { "format": "date-time", "type": "string" }, "ClosedDate": { "format": "date-time", "type": "string" }, "DeleteDate": { "format": "date-time", "type": "string" }, "DeletedDate": { "format": "date-time", "type": "string" }, "Watermark": { "$ref": "#/definitions/WatermarkModel" }, "WorkflowActions": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/DocumentWorkflowActionModel" } ], "xml": { "name": "WorkflowAction" } }, "xml": { "name": "WorkflowActions", "wrapped": true } }, "Tasks": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/TaskDetailsModel" } ], "xml": { "name": "Task" } }, "xml": { "name": "Tasks", "wrapped": true } }, "MetaData": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/MetaDataModel" } ], "xml": { "name": "MetaDat" } }, "xml": { "name": "MetaData", "wrapped": true } }, "IsCertifyPending": { "type": "boolean" }, "IsSealPending": { "type": "boolean" }, "CertifiedDate": { "format": "date-time", "type": "string" }, "SealedDate": { "format": "date-time", "type": "string" }, "Versions": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/DocumentVersionModel" } ], "xml": { "name": "Version" } }, "xml": { "name": "Versions", "wrapped": true } }, "Status": { "enum": [ "All", "Validating", "Pending", "TheRealPending", "Completed", "EmailSent", "Closed", "Cancelled", "Expired", "Voided" ], "type": "string" }, "IncludeAuditReportWithCompletedDocuments": { "type": "boolean" }, "FileSizeInKb": { "format": "int32", "type": "integer" } }, "xml": { "name": "DocumentDetailsModel" } }, "PageStampModel": { "type": "object", "properties": { "Type": { "enum": [ "DocumentId", "DocumentIdGray", "Bates", "BatesGray", "OtherValue" ], "type": "string" }, "Value": { "format": "int32", "type": "integer" }, "OtherValue": { "type": "string" }, "Increment": { "format": "int32", "type": "integer" } }, "xml": { "name": "PageStampModel" } }, "AdditionalSignaturePageModel": { "type": "object", "properties": { "HeaderText": { "maxLength": 80, "minLength": 0, "type": "string" }, "StatementText": { "type": "string" }, "NumberOfPages": { "format": "int32", "type": "integer" } }, "xml": { "name": "AdditionalSignaturePageModel" } }, "WatermarkModel": { "required": [ "Position", "Text" ], "type": "object", "properties": { "Position": { "enum": [ "Diagonal", "Top", "Bottom", "TopAndBottom" ], "type": "string" }, "Text": { "maxLength": 32, "minLength": 0, "type": "string" } }, "xml": { "name": "WatermarkModel" } }, "DocumentWorkflowActionModel": { "type": "object", "properties": { "Data": { "type": "string" }, "Url": { "maxLength": 512, "minLength": 0, "type": "string" }, "Description": { "maxLength": 128, "minLength": 0, "type": "string" }, "Type": { "enum": [ "SubscribeToStatusChangeNotificationsByPost", "SubscribeToStatusChangeNotificationsByGet", "SubscribeToCertifyStatusNotificationsByPost", "SubscribeToCertifyStatusNotificationsByGet", "SubscribeToSealStatusNotificationsByPost", "SubscribeToSealStatusNotificationsByGet", "SubscribeToSkippedDocumentNotificationsByPost", "SubscribeToSkippedDocumentNotificationsByGet", "CecobanNom151" ], "type": "string" }, "ActionStatus": { "format": "int32", "type": "integer" }, "PhoneNumber": { "maxLength": 64, "minLength": 0, "type": "string" }, "EmailAddress": { "maxLength": 128, "minLength": 0, "type": "string" }, "StartedDate": { "format": "date-time", "type": "string" }, "NextRetryDate": { "format": "date-time", "type": "string" }, "RetryLimitDate": { "format": "date-time", "type": "string" }, "CompletedDate": { "format": "date-time", "type": "string" }, "CustomHeaders": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/CustomHeaderModel" } ], "xml": { "name": "CustomHeader" } }, "xml": { "name": "CustomHeaders", "wrapped": true } } }, "xml": { "name": "DocumentWorkflowActionModel" } }, "TaskDetailsModel": { "type": "object", "properties": { "ID": { "format": "int32", "type": "integer" }, "DocumentID": { "format": "int32", "type": "integer" }, "ParticipantID": { "format": "int32", "type": "integer" }, "StatusID": { "format": "int32", "type": "integer" }, "Type": { "enum": [ "Signature", "Initial", "Acknowledgement", "Delivery", "NoActionRequired", "CarbonCopy", "FormFiller" ], "type": "string" }, "SignatureApplicationType": { "enum": [ "FontStamped", "ImageStamped", "FontStampedUnicode", "MouseDrawn", "HardwareCaptureDevice", "Registered", "TouchPreferred" ], "type": "string" }, "SignatureSizeType": { "enum": [ "Normal", "Small", "ExtraSmall" ], "type": "string" }, "SignatureCount": { "format": "int32", "type": "integer" }, "PdfFormFillingAllowed": { "type": "boolean" }, "PdfFormFillingFieldPrefix": { "type": "string" }, "CreatedDate": { "format": "date-time", "type": "string" }, "ClosedDate": { "format": "date-time", "type": "string" }, "NotificationSentDate": { "format": "date-time", "type": "string" }, "TaskStartedDate": { "format": "date-time", "type": "string" }, "IntentConfirmedDate": { "format": "date-time", "type": "string" }, "IpAddress": { "type": "string" }, "HostName": { "type": "string" }, "AccessToken": { "type": "string" }, "EmailTemplateSetName": { "type": "string" }, "LastComment": { "type": "string" }, "SignatureBlock": { "$ref": "#/definitions/SignatureBlockModel" }, "WorkflowActions": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/TaskWorkflowActionModel" } ], "xml": { "name": "WorkflowAction" } }, "xml": { "name": "WorkflowActions", "wrapped": true } }, "FileAttachments": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/FileAttachmentDetailsModel" } ], "xml": { "name": "FileAttachment" } }, "xml": { "name": "FileAttachments", "wrapped": true } }, "IsOptional": { "type": "boolean" }, "TouchPreferredSecondarySignatureApplicationType": { "enum": [ "FontStamped", "Registered" ], "type": "string" }, "PromptToDrawNewSignature": { "type": "boolean" }, "Status": { "enum": [ "All", "Validating", "Pending", "TheRealPending", "Completed", "EmailSent", "Closed", "Cancelled", "Expired", "Voided" ], "type": "string" }, "EmailTemplateSetLanguage": { "type": "string" }, "Copy": { "type": "string" }, "Name": { "type": "string" }, "AccountTemplateSet": { "type": "string" }, "AccountTemplateSetLanguage": { "type": "string" }, "EmailAddress": { "type": "string" }, "Document": { "$ref": "#/definitions/DocumentDetailsModel" } }, "xml": { "name": "TaskDetailsModel" } }, "MetaDataModel": { "required": [ "Name", "Value" ], "type": "object", "properties": { "Name": { "maxLength": 128, "minLength": 0, "type": "string" }, "Value": { "maxLength": 256, "minLength": 0, "type": "string" } }, "xml": { "name": "MetaDataModel" } }, "DocumentVersionModel": { "required": [ "ID", "DocumentID", "Version", "TransID", "ProntoID", "FileName" ], "type": "object", "properties": { "ID": { "format": "int32", "type": "integer" }, "DocumentID": { "format": "int32", "type": "integer" }, "Version": { "format": "int32", "type": "integer" }, "TransID": { "format": "int32", "type": "integer" }, "ProntoID": { "maxLength": 64, "minLength": 0, "type": "string" }, "FileName": { "type": "string" }, "TSCreate": { "format": "date-time", "type": "string" }, "TSSealed": { "format": "date-time", "type": "string" }, "TSCertified": { "format": "date-time", "type": "string" }, "SealPending": { "format": "int32", "type": "integer" }, "CertifyPending": { "format": "int32", "type": "integer" }, "DocumentSHA256Hash": { "type": "string" }, "VersionInfo": { "type": "string" }, "IsFinal": { "type": "boolean" } }, "xml": { "name": "DocumentVersionModel" } }, "CustomHeaderModel": { "type": "object", "properties": { "Name": { "type": "string" }, "Value": { "type": "string" } }, "xml": { "name": "CustomHeaderModel" } }, "SignatureBlockModel": { "required": [ "Signature" ], "type": "object", "properties": { "Signature": { "$ref": "#/definitions/SignatureModel" }, "AdditionalPdfDataPlacements": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/SignatureBlockPdfDataPlacementModel" } ], "xml": { "name": "AdditionalPdfDataPlacement" } }, "xml": { "name": "AdditionalPdfDataPlacements", "wrapped": true } }, "AdditionalHtmlDataPlacements": { "$ref": "#/definitions/SignatureBlockHtmlDataPlacementModel" }, "PdfOpenPromptPageNumber": { "format": "int32", "type": "integer" }, "HtmlOpenPromptAnchor": { "type": "string" } }, "xml": { "name": "SignatureBlockModel" } }, "TaskWorkflowActionModel": { "type": "object", "properties": { "Data": { "type": "string" }, "Url": { "maxLength": 512, "minLength": 0, "type": "string" }, "Description": { "maxLength": 128, "minLength": 0, "type": "string" }, "Type": { "enum": [ "Custom", "DocumentReview", "UploadAdditionalAttachments", "Generic", "SubscribeToStatusChangeNotificationsByPost", "SubscribeToStatusChangeNotificationsByGet" ], "type": "string" }, "ActionStatus": { "format": "int32", "type": "integer" }, "ButtonTextPositive": { "maxLength": 128, "minLength": 0, "type": "string" }, "ButtonTextNegative": { "maxLength": 128, "minLength": 0, "type": "string" }, "Content": { "type": "string" }, "NotRequiredAfterFirstOccurrence": { "type": "boolean" }, "PhoneNumber": { "maxLength": 64, "minLength": 0, "type": "string" }, "EmailAddress": { "maxLength": 128, "minLength": 0, "type": "string" }, "StartedDate": { "format": "date-time", "type": "string" }, "NextRetryDate": { "format": "date-time", "type": "string" }, "RetryLimitDate": { "format": "date-time", "type": "string" }, "CompletedDate": { "format": "date-time", "type": "string" }, "CustomHeaders": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/CustomHeaderModel" } ], "xml": { "name": "CustomHeader" } }, "xml": { "name": "CustomHeaders", "wrapped": true } } }, "xml": { "name": "TaskWorkflowActionModel" } }, "FileAttachmentDetailsModel": { "required": [ "TaskID", "FileBytes", "FileName", "FileExtension", "FileMimeType", "ParticipantID" ], "type": "object", "properties": { "ID": { "format": "int32", "type": "integer" }, "TaskID": { "format": "int32", "type": "integer" }, "FileBytes": { "format": "byte", "type": "string" }, "FileName": { "maxLength": 128, "minLength": 0, "type": "string" }, "FileExtension": { "maxLength": 10, "minLength": 0, "type": "string" }, "FileMimeType": { "maxLength": 128, "minLength": 0, "type": "string" }, "CreatedDate": { "format": "date-time", "type": "string" }, "ParticipantID": { "format": "int32", "type": "integer" } }, "xml": { "name": "FileAttachmentDetailsModel" } }, "SignatureModel": { "required": [ "PdfPlacement" ], "type": "object", "properties": { "PdfPlacement": { "$ref": "#/definitions/PdfSignaturePlacementModel" }, "ApplicationType": { "enum": [ "FontStamped", "ImageStamped", "FontStampedUnicode", "MouseDrawn", "HardwareCaptureDevice", "Registered", "TouchPreferred" ], "type": "string" }, "ApplicationSize": { "enum": [ "Normal", "Small", "ExtraSmall" ], "type": "string" }, "DisplaySignHereTagForHardwareCaptureDeviceSignatureOnHtmlDocuments": { "type": "boolean" }, "FontName": { "type": "string" }, "FontColor": { "enum": [ "Blue", "Black", "Red" ], "type": "string" }, "IsBold": { "type": "boolean" }, "IsItalic": { "type": "boolean" }, "ImageStampedFontSize": { "format": "int32", "type": "integer" }, "ButtonPositiveText": { "type": "string" }, "ButtonNegativeText": { "type": "string" }, "PlaceSignatureOnAdditionalPdfSignaturePage": { "type": "boolean" }, "TouchPreferredSecondaryApplicationType": { "enum": [ "FontStamped", "Registered" ], "type": "string" }, "PromptToDrawNewSignature": { "type": "boolean" } }, "xml": { "name": "SignatureModel" } }, "SignatureBlockPdfDataPlacementModel": { "type": "object", "properties": { "FormField_FieldName": { "type": "string" }, "FormField_InstanceOfField": { "format": "int32", "type": "integer" }, "SearchText_TextToSearch": { "type": "string" }, "SearchText_SpecificPageNumberToSearch": { "format": "int32", "type": "integer" }, "SearchText_InstanceOfText": { "format": "int32", "type": "integer" }, "PageCoordinates_PageNumber": { "format": "int32", "type": "integer" }, "SearchText_OffsetStartPosition": { "enum": [ "Right", "Bottom", "Left", "Top" ], "type": "string" }, "XOffset": { "format": "float", "type": "number" }, "YOffset": { "format": "float", "type": "number" }, "AutoFit": { "type": "boolean" }, "MaxWidth": { "format": "float", "type": "number" }, "MaxHeight": { "format": "float", "type": "number" }, "FontSizeMinimum": { "format": "float", "type": "number" }, "ExcludeIfPlacementNotFound": { "type": "boolean" }, "Type": { "enum": [ "ShortDate", "MediumDate", "LongDate", "DateTime", "PrintedName", "Title", "Organization", "EmailAddress", "IpAddress", "CustomText", "DocumentID", "TaskID", "SealImage", "ClientSigData", "SigningLocation_City", "SigningLocation_StateProv", "SigningLocation_Country", "SigningLocation_CityAndStateProv", "SigningLocation_CityAndCountry", "SigningLocation_StateProvAndCountry", "SigningLocation_CityStateProvAndCountry" ], "type": "string" }, "FontName": { "enum": [ "Helvetica", "Courier", "Times", "Helvetica_Bold", "Helvetica_Oblique", "Helvetica_BoldOblique", "Courier_Bold", "Courier_Oblique", "Courier_BoldOblique", "Times_Bold", "Times_Italic", "Times_BoldItalic" ], "type": "string" }, "FontColor": { "enum": [ "Inherit", "Blue", "Black", "Red" ], "type": "string" }, "CustomText": { "type": "string" }, "FontSize": { "format": "float", "type": "number" } }, "xml": { "name": "SignatureBlockPdfDataPlacementModel" } }, "SignatureBlockHtmlDataPlacementModel": { "type": "object", "properties": { "DisplayTitle": { "type": "boolean" }, "DisplayOrganization": { "type": "boolean" }, "DisplayEmailAddress": { "type": "boolean" }, "DisplayDateTime": { "type": "boolean" }, "DisplayPrintedName": { "type": "boolean" } }, "xml": { "name": "SignatureBlockHtmlDataPlacementModel" } }, "PdfSignaturePlacementModel": { "type": "object", "properties": { "FormField_FieldName": { "type": "string" }, "FormField_InstanceOfField": { "format": "int32", "type": "integer" }, "SearchText_TextToSearch": { "type": "string" }, "SearchText_SpecificPageNumberToSearch": { "format": "int32", "type": "integer" }, "SearchText_InstanceOfText": { "format": "int32", "type": "integer" }, "PageCoordinates_PageNumber": { "format": "int32", "type": "integer" }, "SearchText_OffsetStartPosition": { "enum": [ "Right", "Bottom", "Left", "Top" ], "type": "string" }, "XOffset": { "format": "float", "type": "number" }, "YOffset": { "format": "float", "type": "number" }, "AutoFit": { "type": "boolean" }, "MaxWidth": { "format": "float", "type": "number" }, "MaxHeight": { "format": "float", "type": "number" }, "FontSizeMinimum": { "format": "float", "type": "number" }, "ExcludeIfPlacementNotFound": { "type": "boolean" } }, "xml": { "name": "PdfSignaturePlacementModel" } }, "DocumentVoidRequestModel": { "required": [ "IDs" ], "type": "object", "properties": { "IDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "IDs", "wrapped": true } }, "EnableLogging": { "type": "boolean" } }, "xml": { "name": "DocumentVoidRequestModel" } }, "DocumentCompletedUpdateRequestModel": { "type": "object", "properties": { "EnableLogging": { "type": "boolean" }, "Documents": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/DocumentCompletedUpdateModel" } ], "xml": { "name": "Document" } }, "xml": { "name": "Documents", "wrapped": true } } }, "xml": { "name": "DocumentCompletedUpdateRequestModel" } }, "DocumentCompletedUpdateModel": { "required": [ "ID", "Title" ], "type": "object", "properties": { "ID": { "format": "int32", "type": "integer" }, "Title": { "type": "string" }, "UserFileNameType": { "enum": [ "UseDocTitleSlashUserFileNamePlusSignerNamesPlusExtension", "UseOldNameFormatOfDocumentIdPlusExtension", "UseSignerNamesPlusDocTitleSlashUserFileNamePlusExtension", "UseDocTitleSlashUserFileNamePlusSignerNamesInLastCommaFirstOrderPlusExtension", "UseSignerNamesInLastCommaFirstOrderPlusDocTitleSlashUserFileNamePlusExtension", "UseDocTitleSlashUserFileNameOnly", "UseDocFileNamePlusSignerNamesInFirstNameLastNamePlusDocumentID", "UseDocFileNamePlusDocumentID" ], "type": "string" }, "UserFileName": { "type": "string" }, "DeleteDate": { "format": "date-time", "type": "string" } }, "xml": { "name": "DocumentCompletedUpdateModel" } }, "DocumentUpdateFormFieldsRequestModel": { "required": [ "DocumentFormFields" ], "type": "object", "properties": { "DocumentFormFields": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/DocumentFormFieldsModel" } ], "xml": { "name": "DocumentFormField" } }, "xml": { "name": "DocumentFormFields", "wrapped": true } }, "EnableLogging": { "type": "boolean" } }, "xml": { "name": "DocumentUpdateFormFieldsRequestModel" } }, "DocumentFormFieldsModel": { "required": [ "DocumentID", "FormFields" ], "type": "object", "properties": { "DocumentID": { "format": "int32", "type": "integer" }, "FormFields": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/FormFieldModel" } ], "xml": { "name": "FormField" } }, "xml": { "name": "FormFields", "wrapped": true } }, "ClearAllFieldsBeforeUpdate": { "type": "boolean" } }, "xml": { "name": "DocumentFormFieldsModel" } }, "DocumentUpdateTextStampsRequestModel": { "required": [ "DocumentTextStamps" ], "type": "object", "properties": { "DocumentTextStamps": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/DocumentTextStampsModel" } ], "xml": { "name": "DocumentTextStamp" } }, "xml": { "name": "DocumentTextStamps", "wrapped": true } }, "EnableLogging": { "type": "boolean" } }, "xml": { "name": "DocumentUpdateTextStampsRequestModel" } }, "DocumentTextStampsModel": { "required": [ "DocumentID", "TextStamps" ], "type": "object", "properties": { "DocumentID": { "format": "int32", "type": "integer" }, "TextStamps": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/TextStampModel" } ], "xml": { "name": "TextStamp" } }, "xml": { "name": "TextStamps", "wrapped": true } } }, "xml": { "name": "DocumentTextStampsModel" } }, "TextStampModel": { "required": [ "TextToStamp", "FontSize" ], "type": "object", "properties": { "TextToStamp": { "type": "string" }, "FontSize": { "format": "float", "type": "number" }, "FontColor": { "enum": [ "Black", "Blue", "Red" ], "type": "string" }, "FontName": { "type": "string" }, "FormField_FieldName": { "type": "string" }, "FormField_Instance": { "format": "int32", "type": "integer" }, "SearchText_Text": { "type": "string" }, "SearchText_StartPosition": { "enum": [ "Right", "Bottom", "Left", "Top" ], "type": "string" }, "SearchText_Instance": { "format": "int32", "type": "integer" }, "PageCoordinates_PageNumber": { "format": "int32", "type": "integer" }, "XOffset": { "format": "int32", "type": "integer" }, "YOffset": { "format": "int32", "type": "integer" } }, "xml": { "name": "TextStampModel" } }, "DocumentFileDetailsRequestModel": { "type": "object", "properties": { "ProntoID": { "type": "string" }, "IDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "IDs", "wrapped": true } }, "TransactionIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "TransactionIDs", "wrapped": true } }, "ParticipantIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "ParticipantIDs", "wrapped": true } }, "TaskIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "TaskIDs", "wrapped": true } }, "MetaDataName": { "type": "string" }, "MetaDataValue": { "type": "string" }, "StatusType": { "enum": [ "All", "Validating", "Pending", "TheRealPending", "Completed", "EmailSent", "Closed", "Cancelled", "Expired", "Voided" ], "type": "string" }, "SearchDateType": { "enum": [ "CreatedDate", "ClosedDate" ], "type": "string" }, "SearchDateFrom": { "format": "date-time", "type": "string" }, "SearchDateTo": { "format": "date-time", "type": "string" }, "EnableLogging": { "type": "boolean" }, "ResultsCountLimit": { "format": "int32", "type": "integer" }, "ResultsCountStart": { "format": "int32", "type": "integer" }, "Includes": { "$ref": "#/definitions/DocumentFileIncludesModel" }, "TimeZoneID": { "type": "string" } }, "xml": { "name": "DocumentFileDetailsRequestModel" } }, "DocumentFileDetailsServiceReturnModel": { "type": "object", "properties": { "IsSuccessful": { "type": "boolean" }, "Message": { "type": "string" }, "DocumentFiles": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/DocumentFileDetailsModel" } ], "xml": { "name": "DocumentFile" } }, "xml": { "name": "DocumentFiles", "wrapped": true } }, "ProcessingTime": { "type": "string" }, "TimeZoneUtcOffset": { "format": "double", "type": "number" } }, "xml": { "name": "DocumentFileDetailsServiceReturnModel" } }, "DocumentFileDetailsModel": { "type": "object", "properties": { "DocumentID": { "format": "int32", "type": "integer" }, "File": { "$ref": "#/definitions/DocumentFileModel" } }, "xml": { "name": "DocumentFileDetailsModel" } }, "DocumentInsertRequestModel": { "required": [ "Documents" ], "type": "object", "properties": { "Documents": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/DocumentInsertModel" } ], "xml": { "name": "Document" } }, "xml": { "name": "Documents", "wrapped": true } }, "ResponseIncludes": { "$ref": "#/definitions/DocumentIncludesModel" }, "EnableLogging": { "type": "boolean" }, "TimeZoneID": { "type": "string" } }, "xml": { "name": "DocumentInsertRequestModel" } }, "DocumentInsertModel": { "required": [ "TransactionID", "Title", "Source", "Tasks" ], "type": "object", "properties": { "TransactionID": { "format": "int32", "type": "integer" }, "Title": { "type": "string" }, "Source": { "$ref": "#/definitions/SourceModel" }, "UserFileNameType": { "enum": [ "UseDocTitleSlashUserFileNamePlusSignerNamesPlusExtension", "UseOldNameFormatOfDocumentIdPlusExtension", "UseSignerNamesPlusDocTitleSlashUserFileNamePlusExtension", "UseDocTitleSlashUserFileNamePlusSignerNamesInLastCommaFirstOrderPlusExtension", "UseSignerNamesInLastCommaFirstOrderPlusDocTitleSlashUserFileNamePlusExtension", "UseDocTitleSlashUserFileNameOnly", "UseDocFileNamePlusSignerNamesInFirstNameLastNamePlusDocumentID", "UseDocFileNamePlusDocumentID" ], "type": "string" }, "UserFileName": { "type": "string" }, "InformationText": { "type": "string" }, "ContactText": { "type": "string" }, "EmailTemplateSetName": { "type": "string" }, "EnableSignatureInformationAnnotation": { "type": "boolean" }, "NeverAllowAsEmailAttachment": { "type": "boolean" }, "DoNotFlattenPdfFormFields": { "type": "boolean" }, "IsOptional": { "type": "boolean" }, "PageStamp": { "$ref": "#/definitions/PageStampModel" }, "AdditionalSignaturePage": { "$ref": "#/definitions/AdditionalSignaturePageModel" }, "ServiceType": { "enum": [ "Sign", "SignAndCertify", "SignAndSeal" ], "type": "string" }, "PdfPageImageRenderDpi": { "format": "double", "type": "number" }, "DeleteDate": { "format": "date-time", "type": "string" }, "WorkflowActions": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/DocumentWorkflowActionModel" } ], "xml": { "name": "WorkflowAction" } }, "xml": { "name": "WorkflowActions", "wrapped": true } }, "Tasks": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/TaskInsertModel" } ], "xml": { "name": "Task" } }, "xml": { "name": "Tasks", "wrapped": true } }, "MetaData": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/MetaDataModel" } ], "xml": { "name": "MetaDat" } }, "xml": { "name": "MetaData", "wrapped": true } }, "Watermark": { "$ref": "#/definitions/WatermarkModel" }, "DisplayBitonalPdfPageImages": { "type": "boolean" }, "Fields": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/FormFieldModel" } ], "xml": { "name": "Field" } }, "xml": { "name": "Fields", "wrapped": true } }, "TextStamps": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/TextStampModel" } ], "xml": { "name": "TextStamp" } }, "xml": { "name": "TextStamps", "wrapped": true } }, "IncludeAuditReportWithCompletedDocuments": { "type": "boolean" }, "FieldMetadata": { "$ref": "#/definitions/FormFieldMetadataModel" } }, "xml": { "name": "DocumentInsertModel" } }, "SourceModel": { "type": "object", "properties": { "FileBytes": { "format": "byte", "type": "string" }, "FilePath": { "maxLength": 255, "minLength": 0, "type": "string" }, "FileUrl": { "type": "string" } }, "xml": { "name": "SourceModel" } }, "TaskInsertModel": { "type": "object", "properties": { "DocumentID": { "format": "int32", "maximum": 2147483647, "minimum": 0, "type": "integer" }, "ParticipantID": { "format": "int32", "maximum": 2147483647, "minimum": 0, "type": "integer" }, "Type": { "enum": [ "Signature", "Initial", "Acknowledgement", "Delivery", "NoActionRequired", "CarbonCopy", "FormFiller" ], "type": "string" }, "PdfFormFillingEnabled": { "type": "boolean" }, "PdfFormFillingFieldPrefix": { "type": "string" }, "SignatureBlock": { "$ref": "#/definitions/SignatureBlockModel" }, "WorkflowActions": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/TaskWorkflowActionModel" } ], "xml": { "name": "WorkflowAction" } }, "xml": { "name": "WorkflowActions", "wrapped": true } }, "IsOptional": { "type": "boolean" } }, "xml": { "name": "TaskInsertModel" } }, "FormFieldMetadataModel": { "type": "object", "properties": { "FormFieldProperties": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/FormFieldPropertyModel" } ], "xml": { "name": "FormFieldPropertie" } }, "xml": { "name": "FormFieldProperties", "wrapped": true } }, "FormFieldRules": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/FormFieldRuleModel" } ], "xml": { "name": "FormFieldRule" } }, "xml": { "name": "FormFieldRules", "wrapped": true } } }, "xml": { "name": "FormFieldMetadataModel" } }, "FormFieldPropertyModel": { "required": [ "FormFieldName", "FormFieldID" ], "type": "object", "properties": { "FormFieldName": { "type": "string" }, "FormFieldID": { "type": "string" }, "AsSuffix": { "type": "boolean" }, "Format": { "type": "string" }, "IncludeMaskCharacters": { "type": "boolean" }, "Mask": { "type": "string" }, "Placeholder": { "type": "string" }, "SubType": { "enum": [ "TextBox", "ComboBox", "ListBox", "RadioButton", "CheckBox", "Button", "MultiLineTextBox", "Barcode", "InvalidNameOrType", "Signature", "Image", "Number", "Currency", "Date", "EmailAddress", "PhoneNumber", "SocialSecurityNumber" ], "type": "string" }, "SymbolAbbreviation": { "type": "string" }, "Validation": { "$ref": "#/definitions/FormFieldValidationModel" }, "HasDateRange": { "type": "boolean" } }, "xml": { "name": "FormFieldPropertyModel" } }, "FormFieldRuleModel": { "type": "object", "properties": { "Role": { "type": "string" }, "Actions": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/FormFieldRuleAction" } ], "xml": { "name": "Action" } }, "xml": { "name": "Actions", "wrapped": true } }, "Conditions": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/FormFieldRuleCondition" } ], "xml": { "name": "Condition" } }, "xml": { "name": "Conditions", "wrapped": true } }, "Conjunction": { "type": "string" } }, "xml": { "name": "FormFieldRuleModel" } }, "FormFieldValidationModel": { "type": "object", "properties": { "Min": { "format": "int32", "type": "integer" }, "Max": { "format": "int32", "type": "integer" }, "RegEx": { "type": "string" }, "RegExErrorMessage": { "type": "string" }, "MaxDate": { "type": "string" }, "MaxDateUnit": { "type": "string" }, "MaxDateType": { "type": "string" }, "MinDate": { "type": "string" }, "MinDateUnit": { "type": "string" }, "MinDateType": { "type": "string" } }, "xml": { "name": "FormFieldValidationModel" } }, "FormFieldRuleAction": { "type": "object", "properties": { "FieldID": { "type": "string" }, "Type": { "type": "string" }, "Value": { "type": "string" } }, "xml": { "name": "FormFieldRuleAction" } }, "FormFieldRuleCondition": { "type": "object", "properties": { "CheckboxVerb": { "type": "string" }, "DateVerb": { "type": "string" }, "Field": { "$ref": "#/definitions/FormFieldRuleFormField" }, "FieldID": { "type": "string" }, "NumberVerb": { "type": "string" }, "OptionID": { "type": "string" }, "Value": { "type": "string" }, "Verb": { "type": "string" } }, "xml": { "name": "FormFieldRuleCondition" } }, "FormFieldRuleFormField": { "type": "object", "properties": { "FieldName": { "type": "string" }, "FieldID": { "type": "string" }, "IsRequired": { "type": "boolean" }, "Label": { "type": "string" }, "Options": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/FormFieldRuleFormFieldOption" } ], "xml": { "name": "Option" } }, "xml": { "name": "Options", "wrapped": true } }, "Type": { "format": "int32", "type": "integer" }, "Value": { "type": "object", "xml": { "name": "Object" } }, "Width": { "format": "double", "type": "number" } }, "xml": { "name": "FormFieldRuleFormField" } }, "FormFieldRuleFormFieldOption": { "type": "object", "properties": { "FieldName": { "type": "string" }, "Id": { "type": "string" }, "Name": { "type": "string" }, "Value": { "type": "string" } }, "xml": { "name": "FormFieldRuleFormFieldOption" } }, "DocumentFileLinkDetailsRequestModel": { "type": "object", "properties": { "LinkRequests": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/DocumentLinkRequestModel" } ], "xml": { "name": "LinkRequest" } }, "xml": { "name": "LinkRequests", "wrapped": true } }, "EnableLogging": { "type": "boolean" }, "TimeZoneID": { "type": "string" } }, "xml": { "name": "DocumentFileLinkDetailsRequestModel" } }, "DocumentLinkRequestModel": { "type": "object", "properties": { "DocumentID": { "format": "int32", "type": "integer" }, "ParticipantID": { "format": "int32", "type": "integer" }, "TransactionID": { "format": "int32", "type": "integer" }, "DownloadFileName": { "type": "string" }, "ExpiresInSeconds": { "format": "int32", "type": "integer" }, "Includes": { "$ref": "#/definitions/DocumentFileLinkIncludesModel" }, "DisplayPdfAsHtmlFormat": { "type": "boolean" } }, "xml": { "name": "DocumentLinkRequestModel" } }, "DocumentFileLinkIncludesModel": { "type": "object", "properties": { "IncludeNonWatermarkedVersion": { "type": "boolean" }, "IncludePdfStampedWithCopyWatermark": { "type": "boolean" } }, "xml": { "name": "DocumentFileLinkIncludesModel" } }, "DocumentFileLinkDetailsServiceReturnModel": { "type": "object", "properties": { "IsSuccessful": { "type": "boolean" }, "Message": { "type": "string" }, "DocumentFileLinks": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/DocumentFileLinkDetailsModel" } ], "xml": { "name": "DocumentFileLink" } }, "xml": { "name": "DocumentFileLinks", "wrapped": true } }, "ProcessingTime": { "type": "string" }, "TimeZoneUtcOffset": { "format": "double", "type": "number" } }, "xml": { "name": "DocumentFileLinkDetailsServiceReturnModel" } }, "DocumentFileLinkDetailsModel": { "type": "object", "properties": { "Url": { "type": "string" } }, "xml": { "name": "DocumentFileLinkDetailsModel" } }, "DocumentTiffDetailsRequestModel": { "type": "object", "properties": { "ProntoID": { "type": "string" }, "IDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "IDs", "wrapped": true } }, "TransactionIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "TransactionIDs", "wrapped": true } }, "ParticipantIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "ParticipantIDs", "wrapped": true } }, "TaskIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "TaskIDs", "wrapped": true } }, "MetaDataName": { "type": "string" }, "MetaDataValue": { "type": "string" }, "StatusType": { "enum": [ "All", "Validating", "Pending", "TheRealPending", "Completed", "EmailSent", "Closed", "Cancelled", "Expired", "Voided" ], "type": "string" }, "SearchDateType": { "enum": [ "CreatedDate", "ClosedDate" ], "type": "string" }, "SearchDateFrom": { "format": "date-time", "type": "string" }, "SearchDateTo": { "format": "date-time", "type": "string" }, "EnableLogging": { "type": "boolean" }, "ResultsCountLimit": { "format": "int32", "type": "integer" }, "ResultsCountStart": { "format": "int32", "type": "integer" }, "Dpi": { "format": "int32", "type": "integer" }, "BitsPerPixel": { "format": "int32", "type": "integer" }, "CompressionType": { "enum": [ "Group4", "Lzw", "None" ], "type": "string" }, "Includes": { "$ref": "#/definitions/DocumentFileIncludesModel" }, "TimeZoneID": { "type": "string" } }, "xml": { "name": "DocumentTiffDetailsRequestModel" } }, "DocumentVerifyRequestModel": { "required": [ "DocumentFiles" ], "type": "object", "properties": { "DocumentFiles": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/DocumentVerifyModel" } ], "xml": { "name": "DocumentFile" } }, "xml": { "name": "DocumentFiles", "wrapped": true } }, "EnableLogging": { "type": "boolean" } }, "xml": { "name": "DocumentVerifyRequestModel" } }, "DocumentVerifyModel": { "required": [ "ID", "FileBytes" ], "type": "object", "properties": { "ID": { "format": "int32", "type": "integer" }, "FileBytes": { "format": "byte", "type": "string" } }, "xml": { "name": "DocumentVerifyModel" } }, "DocumentVerificationServiceReturnModel": { "type": "object", "properties": { "IsSuccessful": { "type": "boolean" }, "Message": { "type": "string" }, "Results": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/DocumentVerificationResult" } ], "xml": { "name": "Result" } }, "xml": { "name": "Results", "wrapped": true } }, "ProcessingTime": { "type": "string" }, "TimeZoneUtcOffset": { "format": "double", "type": "number" } }, "xml": { "name": "DocumentVerificationServiceReturnModel" } }, "DocumentVerificationResult": { "type": "object", "properties": { "ID": { "format": "int32", "type": "integer" }, "IsVerified": { "type": "boolean" }, "Status": { "enum": [ "Verified", "Sealed", "Certified", "NotSealed", "NotCertified", "Invalid" ], "type": "string" } }, "xml": { "name": "DocumentVerificationResult" } }, "DocumentUpdateableRequestModel": { "type": "object", "properties": { "ProntoID": { "type": "string" }, "IDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "IDs", "wrapped": true } }, "TransactionIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "TransactionIDs", "wrapped": true } }, "ParticipantIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "ParticipantIDs", "wrapped": true } }, "TaskIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "TaskIDs", "wrapped": true } }, "MetaDataName": { "type": "string" }, "MetaDataValue": { "type": "string" }, "StatusType": { "enum": [ "All", "Validating", "Pending", "TheRealPending", "Completed", "EmailSent", "Closed", "Cancelled", "Expired", "Voided" ], "type": "string" }, "SearchDateType": { "enum": [ "CreatedDate", "ClosedDate" ], "type": "string" }, "SearchDateFrom": { "format": "date-time", "type": "string" }, "SearchDateTo": { "format": "date-time", "type": "string" }, "EnableLogging": { "type": "boolean" }, "ResultsCountLimit": { "format": "int32", "type": "integer" }, "ResultsCountStart": { "format": "int32", "type": "integer" }, "IncludeTests": { "type": "boolean" }, "TimeZoneID": { "type": "string" } }, "xml": { "name": "DocumentUpdateableRequestModel" } }, "DocumentUpdateableServiceReturnModel": { "type": "object", "properties": { "IsSuccessful": { "type": "boolean" }, "Message": { "type": "string" }, "UpdateableDocuments": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/DocumentUpdateModel" } ], "xml": { "name": "UpdateableDocument" } }, "xml": { "name": "UpdateableDocuments", "wrapped": true } }, "ProcessingTime": { "type": "string" }, "TimeZoneUtcOffset": { "format": "double", "type": "number" } }, "xml": { "name": "DocumentUpdateableServiceReturnModel" } }, "DocumentCompletedUpdateableRequestModel": { "type": "object", "properties": { "ProntoID": { "type": "string" }, "IDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "IDs", "wrapped": true } }, "TransactionIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "TransactionIDs", "wrapped": true } }, "ParticipantIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "ParticipantIDs", "wrapped": true } }, "TaskIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "TaskIDs", "wrapped": true } }, "MetaDataName": { "type": "string" }, "MetaDataValue": { "type": "string" }, "SearchDateType": { "enum": [ "CreatedDate", "ClosedDate" ], "type": "string" }, "SearchDateFrom": { "format": "date-time", "type": "string" }, "SearchDateTo": { "format": "date-time", "type": "string" }, "EnableLogging": { "type": "boolean" }, "ResultsCountLimit": { "format": "int32", "type": "integer" }, "ResultsCountStart": { "format": "int32", "type": "integer" } }, "xml": { "name": "DocumentCompletedUpdateableRequestModel" } }, "DocumentCompletedUpdateableServiceReturnModel": { "type": "object", "properties": { "IsSuccessful": { "type": "boolean" }, "Message": { "type": "string" }, "UpdateableDocuments": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/DocumentCompletedUpdateModel" } ], "xml": { "name": "UpdateableDocument" } }, "xml": { "name": "UpdateableDocuments", "wrapped": true } }, "ProcessingTime": { "type": "string" }, "TimeZoneUtcOffset": { "format": "double", "type": "number" } }, "xml": { "name": "DocumentCompletedUpdateableServiceReturnModel" } }, "FileAttachmentDetailsRequestModel": { "type": "object", "properties": { "IDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "IDs", "wrapped": true } }, "TaskIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "TaskIDs", "wrapped": true } }, "DocumentIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "DocumentIDs", "wrapped": true } }, "ParticipantIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "ParticipantIDs", "wrapped": true } }, "TransactionIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "TransactionIDs", "wrapped": true } }, "ProntoID": { "type": "string" }, "EnableLogging": { "type": "boolean" }, "ResultsCountLimit": { "format": "int32", "type": "integer" }, "ResultsCountStart": { "format": "int32", "type": "integer" } }, "xml": { "name": "FileAttachmentDetailsRequestModel" } }, "FileAttachmentDetailsServiceReturnModel": { "type": "object", "properties": { "IsSuccessful": { "type": "boolean" }, "Message": { "type": "string" }, "FileAttachments": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/FileAttachmentDetailsModel" } ], "xml": { "name": "FileAttachment" } }, "xml": { "name": "FileAttachments", "wrapped": true } }, "ProcessingTime": { "type": "string" }, "TimeZoneUtcOffset": { "format": "double", "type": "number" } }, "xml": { "name": "FileAttachmentDetailsServiceReturnModel" } }, "FileAttachmentInsertRequestModel": { "required": [ "FileAttachments" ], "type": "object", "properties": { "FileAttachments": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/FileAttachmentInsertModel" } ], "xml": { "name": "FileAttachment" } }, "xml": { "name": "FileAttachments", "wrapped": true } }, "EnableLogging": { "type": "boolean" } }, "xml": { "name": "FileAttachmentInsertRequestModel" } }, "FileAttachmentInsertModel": { "required": [ "TaskID", "FileBytes", "FileName", "FileMimeType" ], "type": "object", "properties": { "TaskID": { "format": "int32", "type": "integer" }, "FileBytes": { "format": "byte", "type": "string" }, "FileName": { "maxLength": 128, "minLength": 0, "pattern": ".+\\.([^.]+)$", "type": "string" }, "FileMimeType": { "maxLength": 128, "minLength": 0, "type": "string" } }, "xml": { "name": "FileAttachmentInsertModel" } }, "GroupUpdateRequestModel": { "required": [ "Groups" ], "type": "object", "properties": { "Groups": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/GroupUpdateModel" } ], "xml": { "name": "Group" } }, "xml": { "name": "Groups", "wrapped": true } }, "EnableLogging": { "type": "boolean" } }, "xml": { "name": "GroupUpdateRequestModel" } }, "GroupUpdateModel": { "required": [ "ProntoID", "Name", "OwnerName", "OwnerEmail" ], "type": "object", "properties": { "ProntoID": { "maxLength": 64, "minLength": 0, "type": "string" }, "Name": { "maxLength": 128, "minLength": 0, "type": "string" }, "OwnerName": { "maxLength": 64, "minLength": 0, "type": "string" }, "OwnerEmail": { "maxLength": 128, "minLength": 0, "type": "string" }, "ParentID": { "maxLength": 64, "minLength": 0, "type": "string" }, "IsActive": { "type": "boolean" }, "DefaultDocumentRetentionInDays": { "format": "int32", "type": "integer" }, "ProcessSessionExpirationInMinutes": { "format": "int32", "type": "integer" }, "DefaultUserPasswordChangeInDays": { "format": "int32", "type": "integer" }, "PrivacyPolicy": { "$ref": "#/definitions/GroupPrivacyPolicyModel" }, "IsAdminLockedOut": { "type": "boolean" }, "DefaultBrand": { "maxLength": 128, "minLength": 0, "type": "string" }, "DefaultContentSet": { "maxLength": 128, "minLength": 0, "type": "string" }, "DefaultEmailTemplateSet": { "maxLength": 128, "minLength": 0, "type": "string" }, "DefaultEmailTemplateSetLanguage": { "maxLength": 128, "minLength": 0, "type": "string" }, "DisableSignatureChrome": { "type": "boolean" }, "SignatureChromeHeader": { "type": "string" }, "SignatureChromeFooter": { "type": "string" }, "CascadePermissions": { "type": "boolean" }, "SmsUrl": { "type": "string" }, "SmsUrlExpiresInDays": { "format": "int32", "type": "integer" }, "MasterID": { "type": "string" }, "DefaultTimeZoneID": { "type": "string" }, "IsAccountAdminLockedOut": { "type": "boolean" }, "AuthChallengeQuestionsBadLoginLimit": { "format": "int32", "type": "integer" }, "AuthOneTimePasscodeBadLoginLimit": { "format": "int32", "type": "integer" }, "OneTimePasscodeTimeoutInSeconds": { "format": "int32", "type": "integer" }, "OneTimePasscodeLength": { "format": "int32", "type": "integer" } }, "xml": { "name": "GroupUpdateModel" } }, "GroupPrivacyPolicyModel": { "required": [ "Label", "Url" ], "type": "object", "properties": { "Label": { "maxLength": 64, "minLength": 0, "type": "string" }, "Url": { "maxLength": 256, "minLength": 0, "type": "string" } }, "xml": { "name": "GroupPrivacyPolicyModel" } }, "GroupDetailsRequestModel": { "type": "object", "properties": { "ProntoIDs": { "type": "array", "items": { "type": "string", "allOf": [ {} ], "xml": { "name": "string" } }, "xml": { "name": "ProntoIDs", "wrapped": true } }, "OwnerName": { "type": "string" }, "OwnerEmail": { "type": "string" }, "ParentID": { "maxLength": 64, "minLength": 0, "type": "string" }, "IsActive": { "type": "boolean" }, "DefaultDocumentRetentionInDays": { "format": "int32", "type": "integer" }, "ProcessSessionExpirationInMinutes": { "format": "int32", "type": "integer" }, "DefaultUserPasswordChangeInDays": { "format": "int32", "type": "integer" }, "EnableLogging": { "type": "boolean" }, "ResultsCountLimit": { "format": "int32", "type": "integer" }, "ResultsCountStart": { "format": "int32", "type": "integer" }, "DefaultBrand": { "maxLength": 128, "minLength": 0, "type": "string" }, "DefaultContentSet": { "maxLength": 128, "minLength": 0, "type": "string" }, "DefaultEmailTemplateSet": { "maxLength": 128, "minLength": 0, "type": "string" }, "DefaultEmailTemplateSetLanguage": { "maxLength": 8, "minLength": 0, "type": "string" }, "DisableSignatureChrome": { "type": "boolean" }, "SignatureChromeHeader": { "type": "string" }, "SignatureChromeFooter": { "type": "string" }, "SmsUrl": { "type": "string" }, "SmsUrlExpiresInDays": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "MasterID": { "type": "string" } }, "xml": { "name": "GroupDetailsRequestModel" } }, "GroupDetailsServiceReturnModel": { "type": "object", "properties": { "IsSuccessful": { "type": "boolean" }, "Message": { "type": "string" }, "Groups": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/GroupDetailsModel" } ], "xml": { "name": "Group" } }, "xml": { "name": "Groups", "wrapped": true } }, "ProcessingTime": { "type": "string" }, "TimeZoneUtcOffset": { "format": "double", "type": "number" } }, "xml": { "name": "GroupDetailsServiceReturnModel" } }, "GroupDetailsModel": { "type": "object", "properties": { "ProntoID": { "type": "string" }, "AuthData": { "type": "string" }, "Name": { "type": "string" }, "OwnerName": { "type": "string" }, "OwnerEmail": { "type": "string" }, "ParentID": { "type": "string" }, "IsActive": { "type": "boolean" }, "DefaultDocumentRetentionInDays": { "format": "int32", "type": "integer" }, "ProcessSessionExpirationInMinutes": { "format": "int32", "type": "integer" }, "DefaultUserPasswordChangeInDays": { "format": "int32", "type": "integer" }, "CreatedDate": { "format": "date-time", "type": "string" }, "MasterID": { "type": "string" }, "ParentName": { "type": "string" }, "ContinueOnFailFlags": { "format": "int32", "type": "integer" }, "LogoUrl": { "type": "string" }, "DigitalSignatureType": { "format": "int32", "type": "integer" }, "DoNotInheritDigitalSignatureTypeFromParent": { "type": "boolean" }, "PrivacyPolicy": { "$ref": "#/definitions/GroupPrivacyPolicyModel" }, "IsAdminLockedOut": { "type": "boolean" }, "AdminHasPermission": { "type": "boolean" }, "DefaultBrand": { "type": "string" }, "DefaultContentSet": { "type": "string" }, "DefaultEmailTemplateSet": { "type": "string" }, "Parent": { "$ref": "#/definitions/GroupDetailsModel" }, "IsMfaEnabled": { "type": "boolean" }, "MfaEmailTemplate": { "$ref": "#/definitions/GroupMfaEmailTemplateModel" }, "EnableMultifactorAuth": { "type": "boolean" }, "DefaultEmailTemplateSetLanguage": { "type": "string" }, "DisableSignatureChrome": { "type": "boolean" }, "SignatureChromeHeader": { "type": "string" }, "SignatureChromeFooter": { "type": "string" }, "CascadePermissions": { "type": "boolean" }, "EmailIntegration": { "$ref": "#/definitions/ThirdPartyCredentialDetailsModel" }, "AccountName": { "type": "string" }, "SmsUrl": { "type": "string" }, "SmsUrlExpiresInDays": { "format": "int32", "type": "integer" }, "DefaultTimeZoneID": { "type": "string" }, "IsAccountAdminLockedOut": { "type": "boolean" }, "AccountAdminHasPermission": { "type": "boolean" }, "AuthChallengeQuestionsBadLoginLimit": { "format": "int32", "type": "integer" }, "AuthOneTimePasscodeBadLoginLimit": { "format": "int32", "type": "integer" }, "OneTimePasscodeTimeoutInSeconds": { "format": "int32", "type": "integer" }, "OneTimePasscodeLength": { "format": "int32", "type": "integer" } }, "xml": { "name": "GroupDetailsModel" } }, "GroupMfaEmailTemplateModel": { "type": "object", "properties": { "Body": { "type": "string" }, "Subject": { "type": "string" }, "UseCustomMfa": { "type": "boolean" } }, "xml": { "name": "GroupMfaEmailTemplateModel" } }, "ThirdPartyCredentialDetailsModel": { "type": "object", "properties": { "ID": { "format": "int32", "type": "integer" }, "ProntoID": { "type": "string" }, "Type": { "type": "string" }, "Name": { "type": "string" }, "Data": { "type": "string" }, "Credential": { "$ref": "#/definitions/BaseCredential" }, "IsAccountWide": { "type": "boolean" }, "ClientID": { "type": "string" }, "ClientSecret": { "type": "string" }, "IsActive": { "type": "boolean" }, "IsSignActive": { "type": "boolean" } }, "xml": { "name": "ThirdPartyCredentialDetailsModel" } }, "BaseCredential": { "type": "object", "properties": {}, "xml": { "name": "BaseCredential" } }, "GroupDeleteRequestModel": { "required": [ "Groups" ], "type": "object", "properties": { "Groups": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/GroupDeleteModel" } ], "xml": { "name": "Group" } }, "xml": { "name": "Groups", "wrapped": true } }, "EnableLogging": { "type": "boolean" } }, "xml": { "name": "GroupDeleteRequestModel" } }, "GroupDeleteModel": { "type": "object", "properties": { "ProntoID": { "type": "string" } }, "xml": { "name": "GroupDeleteModel" } }, "GroupInsertRequestModel": { "required": [ "Groups" ], "type": "object", "properties": { "Groups": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/GroupInsertModel" } ], "xml": { "name": "Group" } }, "xml": { "name": "Groups", "wrapped": true } }, "EnableLogging": { "type": "boolean" } }, "xml": { "name": "GroupInsertRequestModel" } }, "GroupInsertModel": { "required": [ "Name", "OwnerName", "OwnerEmail" ], "type": "object", "properties": { "ProntoID": { "maxLength": 64, "minLength": 0, "type": "string" }, "Name": { "maxLength": 128, "minLength": 0, "type": "string" }, "OwnerName": { "maxLength": 64, "minLength": 0, "type": "string" }, "OwnerEmail": { "maxLength": 128, "minLength": 0, "type": "string" }, "ParentID": { "maxLength": 64, "minLength": 0, "type": "string" }, "IsActive": { "type": "boolean" }, "DefaultDocumentRetentionInDays": { "format": "int32", "type": "integer" }, "ProcessSessionExpirationInMinutes": { "format": "int32", "type": "integer" }, "DefaultUserPasswordChangeInDays": { "format": "int32", "type": "integer" }, "PrivacyPolicy": { "$ref": "#/definitions/GroupPrivacyPolicyModel" }, "DefaultBrand": { "maxLength": 128, "minLength": 0, "type": "string" }, "DefaultContentSet": { "maxLength": 128, "minLength": 0, "type": "string" }, "DefaultEmailTemplateSet": { "maxLength": 128, "minLength": 0, "type": "string" }, "IsAdminLockedOut": { "type": "boolean" }, "DefaultEmailTemplateSetLanguage": { "maxLength": 128, "minLength": 0, "type": "string" }, "DisableSignatureChrome": { "type": "boolean" }, "SignatureChromeHeader": { "maxLength": 64, "minLength": 0, "type": "string" }, "SignatureChromeFooter": { "maxLength": 64, "minLength": 0, "type": "string" }, "CascadePermissions": { "type": "boolean" }, "SmsUrl": { "type": "string" }, "SmsUrlExpiresInDays": { "format": "int32", "type": "integer" }, "MasterID": { "type": "string" }, "DefaultTimeZoneID": { "type": "string" }, "IsAccountAdminLockedOut": { "type": "boolean" }, "AuthChallengeQuestionsBadLoginLimit": { "format": "int32", "type": "integer" }, "AuthOneTimePasscodeBadLoginLimit": { "format": "int32", "type": "integer" }, "OneTimePasscodeTimeoutInSeconds": { "format": "int32", "type": "integer" }, "OneTimePasscodeLength": { "format": "int32", "type": "integer" } }, "xml": { "name": "GroupInsertModel" } }, "GroupUpdateableRequestModel": { "type": "object", "properties": { "ProntoIDs": { "type": "array", "items": { "type": "string", "allOf": [ {} ], "xml": { "name": "string" } }, "xml": { "name": "ProntoIDs", "wrapped": true } }, "OwnerName": { "type": "string" }, "OwnerEmail": { "type": "string" }, "ParentID": { "maxLength": 64, "minLength": 0, "type": "string" }, "IsActive": { "type": "boolean" }, "DefaultDocumentRetentionInDays": { "format": "int32", "type": "integer" }, "ProcessSessionExpirationInMinutes": { "format": "int32", "type": "integer" }, "DefaultUserPasswordChangeInDays": { "format": "int32", "type": "integer" }, "EnableLogging": { "type": "boolean" }, "ResultsCountLimit": { "format": "int32", "type": "integer" }, "ResultsCountStart": { "format": "int32", "type": "integer" }, "DefaultBrand": { "maxLength": 128, "minLength": 0, "type": "string" }, "DefaultContentSet": { "maxLength": 128, "minLength": 0, "type": "string" }, "DefaultEmailTemplateSet": { "maxLength": 128, "minLength": 0, "type": "string" }, "DefaultEmailTemplateSetLanguage": { "maxLength": 128, "minLength": 0, "type": "string" }, "DisableSignatureChrome": { "type": "boolean" }, "SignatureChromeHeader": { "type": "string" }, "SignatureChromeFooter": { "type": "string" }, "CascadePermissions": { "type": "boolean" }, "SmsUrl": { "type": "string" }, "SmsUrlExpiresInDays": { "format": "int32", "type": "integer" } }, "xml": { "name": "GroupUpdateableRequestModel" } }, "GroupUpdateableServiceReturnModel": { "type": "object", "properties": { "IsSuccessful": { "type": "boolean" }, "Message": { "type": "string" }, "UpdateableGroups": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/GroupUpdateModel" } ], "xml": { "name": "UpdateableGroup" } }, "xml": { "name": "UpdateableGroups", "wrapped": true } }, "ProcessingTime": { "type": "string" }, "TimeZoneUtcOffset": { "format": "double", "type": "number" } }, "xml": { "name": "GroupUpdateableServiceReturnModel" } }, "GroupHtmlWrapperRequestModel": { "type": "object", "properties": { "EnableLogging": { "type": "boolean" }, "ParticipantID": { "format": "int32", "type": "integer" }, "ProntoID": { "type": "string" }, "Language": { "type": "string" } }, "xml": { "name": "GroupHtmlWrapperRequestModel" } }, "GroupHtmlWrapperServiceReturnModel": { "type": "object", "properties": { "IsSuccessful": { "type": "boolean" }, "Message": { "type": "string" }, "HtmlWrapper": { "$ref": "#/definitions/GroupHtmlWrapperModel" }, "ProcessingTime": { "type": "string" }, "TimeZoneUtcOffset": { "format": "double", "type": "number" } }, "xml": { "name": "GroupHtmlWrapperServiceReturnModel" } }, "GroupHtmlWrapperModel": { "type": "object", "properties": { "HeaderHtml": { "type": "string" }, "FooterHtml": { "type": "string" } }, "xml": { "name": "GroupHtmlWrapperModel" } }, "ParticipantFileAttachmentInsertRequestModel": { "required": [ "FileAttachments" ], "type": "object", "properties": { "FileAttachments": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/ParticipantFileAttachmentInsertModel" } ], "xml": { "name": "FileAttachment" } }, "xml": { "name": "FileAttachments", "wrapped": true } }, "EnableLogging": { "type": "boolean" } }, "xml": { "name": "ParticipantFileAttachmentInsertRequestModel" } }, "ParticipantFileAttachmentInsertModel": { "required": [ "ParticipantID", "FileBytes", "FileName", "FileMimeType" ], "type": "object", "properties": { "ParticipantID": { "format": "int32", "type": "integer" }, "FileBytes": { "format": "byte", "type": "string" }, "FileName": { "maxLength": 128, "minLength": 0, "pattern": ".+\\.([^.]+)$", "type": "string" }, "FileMimeType": { "maxLength": 128, "minLength": 0, "type": "string" } }, "xml": { "name": "ParticipantFileAttachmentInsertModel" } }, "ParticipantUpdateRequestModel": { "required": [ "Participants" ], "type": "object", "properties": { "Participants": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/ParticipantUpdateModel" } ], "xml": { "name": "Participant" } }, "xml": { "name": "Participants", "wrapped": true } }, "EnableLogging": { "type": "boolean" } }, "xml": { "name": "ParticipantUpdateRequestModel" } }, "ParticipantUpdateModel": { "required": [ "ID" ], "type": "object", "properties": { "ID": { "format": "int32", "type": "integer" }, "Authentication": { "$ref": "#/definitions/AuthenticationModel" }, "EmailTemplateSetName": { "type": "string" }, "SendRequestViaEmail": { "type": "boolean" }, "CompletedTransactionNotificationType": { "enum": [ "DoNotSendEmail", "SendEmailWithoutDocumentsAttached", "SendEmailWithDocumentsAttached" ], "type": "string" }, "DisableDocumentDownloads": { "type": "boolean" }, "EnableAccessToAllTransactionDocuments": { "type": "boolean" }, "CertificationType": { "enum": [ "Server", "Client" ], "type": "string" }, "CompletedDocumentBehaviorType": { "enum": [ "RedirectToClientReturnUrl", "RedisplayCompletedDocumentWithContinuePrompt" ], "type": "string" }, "CancelledTaskBehaviorType": { "enum": [ "AutomaticSuspend", "DisplayCancelOrSuspendOption", "AutomaticCancel" ], "type": "string" }, "ErrorBehaviorType": { "enum": [ "RedirectToClientReturnUrl", "DisplaySystemErrorPage" ], "type": "string" }, "DocumentTaskStatusPageBehaviorType": { "enum": [ "Off", "DisplayBeforeEachDocument", "DisplayBeforeEachTask" ], "type": "string" }, "ConfirmSignatureIntent": { "type": "boolean" }, "ClientReturnUrl": { "type": "string" }, "FullName": { "type": "string" }, "QueryForName": { "type": "boolean" }, "NormalizeFullName": { "type": "boolean" }, "EmailAddress": { "pattern": "^(?![.])([^@,;<>\\^]+@[^\\s@<>,;\\^]+\\.[^\\s@<>,;\\^]+)$", "type": "string" }, "QueryForEmailAddress": { "type": "boolean" }, "Title": { "type": "string" }, "QueryForTitle": { "type": "boolean" }, "Organization": { "type": "string" }, "QueryForOrganization": { "type": "boolean" }, "ThirdPartyData": { "type": "string" }, "DownloadWindowInMinutes": { "format": "int32", "type": "integer" }, "DownloadLimit": { "format": "int32", "type": "integer" }, "Jurisdiction": { "$ref": "#/definitions/ParticipantJurisdictionModel" }, "EmailNotifications": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/EmailNotificationModel" } ], "xml": { "name": "EmailNotification" } }, "xml": { "name": "EmailNotifications", "wrapped": true } }, "WorkflowActions": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/ParticipantWorkflowActionModel" } ], "xml": { "name": "WorkflowAction" } }, "xml": { "name": "WorkflowActions", "wrapped": true } }, "EmailTemplatePlaceholders": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/EmailTemplatePlaceholderModel" } ], "xml": { "name": "EmailTemplatePlaceholder" } }, "xml": { "name": "EmailTemplatePlaceholders", "wrapped": true } }, "ContentPlaceholders": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/ContentPlaceholderModel" } ], "xml": { "name": "ContentPlaceholder" } }, "xml": { "name": "ContentPlaceholders", "wrapped": true } }, "ContentSetName": { "maxLength": 128, "minLength": 0, "type": "string" }, "LanguagePreferred": { "type": "string" }, "AllowReassignment": { "type": "boolean" }, "Role": { "maxLength": 48, "minLength": 0, "pattern": "^[^&]*$", "type": "string" }, "Initials": { "maxLength": 4, "minLength": 0, "type": "string" }, "QueryForInitials": { "type": "boolean" }, "Authentication2": { "$ref": "#/definitions/AuthenticationModel" }, "BrandName": { "maxLength": 128, "minLength": 0, "type": "string" }, "SendRequestViaSms": { "type": "boolean" }, "PhoneNumber": { "maxLength": 64, "minLength": 0, "type": "string" }, "SmsCredentialName": { "maxLength": 64, "minLength": 0, "type": "string" }, "IsDefinedParticipant": { "type": "boolean" }, "SessionTimeoutUrl": { "type": "string" }, "QueryForCity": { "type": "boolean" }, "QueryForCountry": { "type": "boolean" }, "QueryForStateProv": { "type": "boolean" }, "DisplayAllPages": { "type": "boolean" } }, "xml": { "name": "ParticipantUpdateModel" } }, "AuthenticationModel": { "required": [ "Type" ], "type": "object", "properties": { "Type": { "enum": [ "Password", "PasswordHashed", "RegisteredUser", "Federation", "Experian", "KBA", "Mobile", "Questions" ], "type": "string" }, "Data": { "type": "string" }, "TwoFactorAuthentication": { "$ref": "#/definitions/AuthenticationModel" }, "Provider": { "format": "int32", "type": "integer" }, "Questions": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/ParticipantQuestionModel" } ], "xml": { "name": "Question" } }, "xml": { "name": "Questions", "wrapped": true } } }, "xml": { "name": "AuthenticationModel" } }, "ParticipantJurisdictionModel": { "type": "object", "properties": { "Country": { "type": "string" }, "StateProvince": { "type": "string" } }, "xml": { "name": "ParticipantJurisdictionModel" } }, "EmailNotificationModel": { "type": "object", "properties": { "Subject": { "maxLength": 256, "minLength": 0, "type": "string" }, "BodyHtml": { "type": "string" }, "Placeholders": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/EmailNotificationPlaceholderModel" } ], "xml": { "name": "Placeholder" } }, "xml": { "name": "Placeholders", "wrapped": true } }, "SendDelayInMinutes": { "format": "int32", "type": "integer" } }, "xml": { "name": "EmailNotificationModel" } }, "ParticipantWorkflowActionModel": { "type": "object", "properties": { "Data": { "type": "string" }, "Url": { "maxLength": 512, "minLength": 0, "type": "string" }, "Description": { "maxLength": 128, "minLength": 0, "type": "string" }, "Type": { "enum": [ "Custom", "ProcessExplanation", "ConsumerDisclosureAgreement", "DocumentReview", "HttpHeaderCheck", "Generic", "SubscribeToStatusChangeNotificationsByPost", "SubscribeToStatusChangeNotificationsByGet", "SubscribeToPreciseIdVictimStatementNotificationsByPost", "SubscribeToPreciseIdVictimStatementNotificationsByGet", "SubscribeToAuthenticationFailureNotificationsByPost", "SubscribeToAuthenticationFailureNotificationsByGet", "SubscribeToSessionStartNotificationsByPost", "SubscribeToSessionStartNotificationsByGet", "SubscribeToReassignedNotificationsByPost", "SubscribeToReassignedNotificationsByGet", "DefineParticipant", "UploadAdditionalAttachments" ], "type": "string" }, "ActionStatus": { "format": "int32", "type": "integer" }, "IsPreAuthentication": { "type": "boolean" }, "NotRequiredAfterFirstOccurrence": { "type": "boolean" }, "ButtonTextPositive": { "maxLength": 128, "minLength": 0, "type": "string" }, "ButtonTextNegative": { "maxLength": 128, "minLength": 0, "type": "string" }, "Content": { "type": "string" }, "DefineParticipantOptions": { "$ref": "#/definitions/ParticipantActionDefineParticipantOptionsModel" }, "PhoneNumber": { "maxLength": 64, "minLength": 0, "type": "string" }, "EmailAddress": { "maxLength": 128, "minLength": 0, "type": "string" }, "StartedDate": { "format": "date-time", "type": "string" }, "NextRetryDate": { "format": "date-time", "type": "string" }, "RetryLimitDate": { "format": "date-time", "type": "string" }, "CompletedDate": { "format": "date-time", "type": "string" }, "CustomHeaders": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/CustomHeaderModel" } ], "xml": { "name": "CustomHeader" } }, "xml": { "name": "CustomHeaders", "wrapped": true } } }, "xml": { "name": "ParticipantWorkflowActionModel" } }, "EmailTemplatePlaceholderModel": { "required": [ "Name", "Value" ], "type": "object", "properties": { "Name": { "maxLength": 50, "minLength": 0, "type": "string" }, "Value": { "type": "string" } }, "xml": { "name": "EmailTemplatePlaceholderModel" } }, "ContentPlaceholderModel": { "required": [ "Name", "Value" ], "type": "object", "properties": { "Name": { "maxLength": 50, "minLength": 0, "pattern": "^[a-zA-Z0-9_]*$", "type": "string" }, "Value": { "type": "string" } }, "xml": { "name": "ContentPlaceholderModel" } }, "ParticipantQuestionModel": { "required": [ "Question", "Answer" ], "type": "object", "properties": { "Question": { "maxLength": 128, "minLength": 0, "type": "string" }, "Answer": { "maxLength": 64, "minLength": 0, "type": "string" } }, "xml": { "name": "ParticipantQuestionModel" } }, "EmailNotificationPlaceholderModel": { "required": [ "Name", "Value" ], "type": "object", "properties": { "Name": { "maxLength": 50, "minLength": 0, "pattern": "^[a-zA-Z0-9_]*$", "type": "string" }, "Value": { "type": "string" } }, "xml": { "name": "EmailNotificationPlaceholderModel" } }, "ParticipantActionDefineParticipantOptionsModel": { "type": "object", "properties": { "Authentication": { "$ref": "#/definitions/ParticipantDefinedAuthenticationOptionModel" }, "Authentication2": { "$ref": "#/definitions/ParticipantDefinedAuthenticationOptionModel" }, "EmailAddress": { "$ref": "#/definitions/ParticipantDefinedOptionModel" }, "EmailMessage": { "$ref": "#/definitions/ParticipantDefinedOptionModel" }, "FullName": { "$ref": "#/definitions/ParticipantDefinedOptionModel" }, "Organization": { "$ref": "#/definitions/ParticipantDefinedOptionModel" }, "RoleToUpdate": { "type": "string" }, "Title": { "$ref": "#/definitions/ParticipantDefinedOptionModel" }, "PhoneNumber": { "$ref": "#/definitions/ParticipantDefinedOptionModel" } }, "xml": { "name": "ParticipantActionDefineParticipantOptionsModel" } }, "ParticipantDefinedAuthenticationOptionModel": { "type": "object", "properties": { "IsDisplayed": { "type": "boolean" }, "CustomFieldLabel": { "type": "string" } }, "xml": { "name": "ParticipantDefinedAuthenticationOptionModel" } }, "ParticipantDefinedOptionModel": { "type": "object", "properties": { "IsDisplayed": { "type": "boolean" }, "CustomLabel": { "type": "string" }, "IsPrepopulated": { "type": "boolean" }, "IsReadonly": { "type": "boolean" }, "IsRequired": { "type": "boolean" } }, "xml": { "name": "ParticipantDefinedOptionModel" } }, "ParticipantDetailsRequestModel": { "type": "object", "properties": { "IDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "IDs", "wrapped": true } }, "ProntoID": { "type": "string" }, "TransactionIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "TransactionIDs", "wrapped": true } }, "DocumentIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "DocumentIDs", "wrapped": true } }, "TaskIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "TaskIDs", "wrapped": true } }, "StatusType": { "enum": [ "All", "Validating", "Pending", "TheRealPending", "Completed", "EmailSent", "Closed", "Cancelled", "Expired", "Voided" ], "type": "string" }, "FullName": { "maxLength": 64, "minLength": 0, "type": "string" }, "EmailAddress": { "maxLength": 128, "minLength": 0, "type": "string" }, "Title": { "maxLength": 64, "minLength": 0, "type": "string" }, "Organization": { "maxLength": 128, "minLength": 0, "type": "string" }, "SearchDateType": { "enum": [ "CreatedDate", "ClosedDate" ], "type": "string" }, "SearchDateFrom": { "format": "date-time", "type": "string" }, "SearchDateTo": { "format": "date-time", "type": "string" }, "Includes": { "$ref": "#/definitions/ParticipantIncludesModel" }, "EnableLogging": { "type": "boolean" }, "ResultsCountLimit": { "format": "int32", "type": "integer" }, "ResultsCountStart": { "format": "int32", "type": "integer" }, "TimeZoneID": { "type": "string" } }, "xml": { "name": "ParticipantDetailsRequestModel" } }, "ParticipantIncludesModel": { "type": "object", "properties": { "IncludeEmailNotifications": { "type": "boolean" }, "IncludeWorkflowActions": { "type": "boolean" }, "IncludeEmailTemplatePlaceholders": { "type": "boolean" }, "IncludeTasks": { "type": "boolean" }, "TaskIncludes": { "$ref": "#/definitions/TaskIncludesModel" }, "IncludeTests": { "type": "boolean" }, "IncludeContentPlaceholders": { "type": "boolean" } }, "xml": { "name": "ParticipantIncludesModel" } }, "ParticipantDetailsServiceReturnModel": { "type": "object", "properties": { "IsSuccessful": { "type": "boolean" }, "Message": { "type": "string" }, "Participants": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/ParticipantDetailsModel" } ], "xml": { "name": "Participant" } }, "xml": { "name": "Participants", "wrapped": true } }, "ProcessingTime": { "type": "string" }, "TimeZoneUtcOffset": { "format": "double", "type": "number" } }, "xml": { "name": "ParticipantDetailsServiceReturnModel" } }, "ParticipantDetailsModel": { "type": "object", "properties": { "ID": { "format": "int32", "type": "integer" }, "AccessToken": { "type": "string" }, "Authentication": { "$ref": "#/definitions/AuthenticationModel" }, "TransactionID": { "format": "int32", "type": "integer" }, "Url": { "type": "string" }, "EmailTemplateSetName": { "type": "string" }, "StatusID": { "format": "int32", "type": "integer" }, "CreatedDate": { "format": "date-time", "type": "string" }, "ClosedDate": { "format": "date-time", "type": "string" }, "LastNotificationSentDate": { "format": "date-time", "type": "string" }, "NextNotificationSendDate": { "format": "date-time", "type": "string" }, "EmailsSentCount": { "format": "int32", "type": "integer" }, "MaxEmailsAllowed": { "format": "int32", "type": "integer" }, "SendRequestViaEmail": { "type": "boolean" }, "CompletedTransactionNotificationType": { "enum": [ "DoNotSendEmail", "SendEmailWithoutDocumentsAttached", "SendEmailWithDocumentsAttached" ], "type": "string" }, "DisableDocumentDownloads": { "type": "boolean" }, "EnableAccessToAllTransactionDocuments": { "type": "boolean" }, "CertificationType": { "enum": [ "Server", "Client" ], "type": "string" }, "CompletedDocumentBehaviorType": { "enum": [ "RedirectToClientReturnUrl", "RedisplayCompletedDocumentWithContinuePrompt" ], "type": "string" }, "CancelledTaskBehaviorType": { "enum": [ "AutomaticSuspend", "DisplayCancelOrSuspendOption", "AutomaticCancel" ], "type": "string" }, "ErrorBehaviorType": { "enum": [ "RedirectToClientReturnUrl", "DisplaySystemErrorPage" ], "type": "string" }, "DocumentTaskStatusPageBehaviorType": { "enum": [ "Off", "DisplayBeforeEachDocument", "DisplayBeforeEachTask" ], "type": "string" }, "ConfirmSignatureIntent": { "type": "boolean" }, "ClientReturnUrl": { "type": "string" }, "FullName": { "type": "string" }, "QueryForName": { "type": "boolean" }, "NormalizeFullName": { "type": "boolean" }, "EmailAddress": { "type": "string" }, "QueryForEmailAddress": { "type": "boolean" }, "Title": { "type": "string" }, "QueryForTitle": { "type": "boolean" }, "Organization": { "type": "string" }, "QueryForOrganization": { "type": "boolean" }, "ThirdPartyData": { "type": "string" }, "DownloadWindowInMinutes": { "format": "int32", "type": "integer" }, "DownloadLimit": { "format": "int32", "type": "integer" }, "Jurisdiction": { "$ref": "#/definitions/ParticipantJurisdictionModel" }, "EmailNotifications": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/EmailNotificationModel" } ], "xml": { "name": "EmailNotification" } }, "xml": { "name": "EmailNotifications", "wrapped": true } }, "WorkflowActions": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/ParticipantWorkflowActionModel" } ], "xml": { "name": "WorkflowAction" } }, "xml": { "name": "WorkflowActions", "wrapped": true } }, "EmailTemplatePlaceholders": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/EmailTemplatePlaceholderModel" } ], "xml": { "name": "EmailTemplatePlaceholder" } }, "xml": { "name": "EmailTemplatePlaceholders", "wrapped": true } }, "Tasks": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/TaskDetailsModel" } ], "xml": { "name": "Task" } }, "xml": { "name": "Tasks", "wrapped": true } }, "AccessOrder": { "format": "int32", "type": "integer" }, "ContentPlaceholders": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/ContentPlaceholderModel" } ], "xml": { "name": "ContentPlaceholder" } }, "xml": { "name": "ContentPlaceholders", "wrapped": true } }, "ContentSetName": { "maxLength": 128, "minLength": 0, "type": "string" }, "LanguagePreferred": { "type": "string" }, "AllowReassignment": { "type": "boolean" }, "Role": { "type": "string" }, "Initials": { "type": "string" }, "QueryForInitials": { "type": "boolean" }, "BrandName": { "maxLength": 128, "minLength": 0, "type": "string" }, "EmailSentDate": { "format": "date-time", "type": "string" }, "Status": { "enum": [ "All", "Validating", "Pending", "TheRealPending", "Completed", "EmailSent", "Closed", "Cancelled", "Expired", "Voided" ], "type": "string" }, "SendRequestViaSms": { "type": "boolean" }, "PhoneNumber": { "maxLength": 64, "minLength": 0, "type": "string" }, "SmsCredentialName": { "maxLength": 64, "minLength": 0, "type": "string" }, "TinyUrl": { "type": "string" }, "SessionTimeoutUrl": { "type": "string" }, "SignLocationCity": { "type": "string" }, "SignLocationCountry": { "type": "string" }, "SignLocationStateProv": { "type": "string" }, "QueryForCity": { "type": "boolean" }, "QueryForCountry": { "type": "boolean" }, "QueryForStateProv": { "type": "boolean" }, "DisplayAllPages": { "type": "boolean" }, "FileAttachments": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/FileAttachmentDetailsModel" } ], "xml": { "name": "FileAttachment" } }, "xml": { "name": "FileAttachments", "wrapped": true } } }, "xml": { "name": "ParticipantDetailsModel" } }, "ParticipantWorkflowActionUpdateRequestModel": { "required": [ "WorkflowAction" ], "type": "object", "properties": { "EnableLogging": { "type": "boolean" }, "WorkflowAction": { "$ref": "#/definitions/ParticipantWorkflowActionUpdateModel" } }, "xml": { "name": "ParticipantWorkflowActionUpdateRequestModel" } }, "ParticipantWorkflowActionUpdateModel": { "required": [ "ParticipantID", "ID" ], "type": "object", "properties": { "ParticipantID": { "format": "int32", "type": "integer" }, "ID": { "format": "int32", "type": "integer" }, "IsCompleted": { "type": "boolean" } }, "xml": { "name": "ParticipantWorkflowActionUpdateModel" } }, "ParticipantWorkflowActionServiceReturnModel": { "type": "object", "properties": { "IsSuccessful": { "type": "boolean" }, "Message": { "type": "string" }, "ReturnUrl": { "type": "string" }, "ProcessingTime": { "type": "string" }, "TimeZoneUtcOffset": { "format": "double", "type": "number" } }, "xml": { "name": "ParticipantWorkflowActionServiceReturnModel" } }, "ParticipantInsertRequestModel": { "required": [ "Participants" ], "type": "object", "properties": { "Participants": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/ParticipantInsertModel" } ], "xml": { "name": "Participant" } }, "xml": { "name": "Participants", "wrapped": true } }, "ResponseIncludes": { "$ref": "#/definitions/ParticipantIncludesModel" }, "EnableLogging": { "type": "boolean" }, "TimeZoneID": { "type": "string" } }, "xml": { "name": "ParticipantInsertRequestModel" } }, "ParticipantInsertModel": { "type": "object", "properties": { "TransactionID": { "format": "int32", "type": "integer" }, "Authentication": { "$ref": "#/definitions/AuthenticationModel" }, "EmailTemplateSetName": { "type": "string" }, "SendRequestViaEmail": { "type": "boolean" }, "CompletedTransactionNotificationType": { "enum": [ "DoNotSendEmail", "SendEmailWithoutDocumentsAttached", "SendEmailWithDocumentsAttached" ], "type": "string" }, "DisableDocumentDownloads": { "type": "boolean" }, "EnableAccessToAllTransactionDocuments": { "type": "boolean" }, "CertificationType": { "enum": [ "Server", "Client" ], "type": "string" }, "CompletedDocumentBehaviorType": { "enum": [ "RedirectToClientReturnUrl", "RedisplayCompletedDocumentWithContinuePrompt" ], "type": "string" }, "CancelledTaskBehaviorType": { "enum": [ "AutomaticSuspend", "DisplayCancelOrSuspendOption", "AutomaticCancel" ], "type": "string" }, "ErrorBehaviorType": { "enum": [ "RedirectToClientReturnUrl", "DisplaySystemErrorPage" ], "type": "string" }, "DocumentTaskStatusPageBehaviorType": { "enum": [ "Off", "DisplayBeforeEachDocument", "DisplayBeforeEachTask" ], "type": "string" }, "ConfirmSignatureIntent": { "type": "boolean" }, "ClientReturnUrl": { "type": "string" }, "FullName": { "type": "string" }, "QueryForName": { "type": "boolean" }, "NormalizeFullName": { "type": "boolean" }, "EmailAddress": { "pattern": "^(?![.])([^@,;<>\\^]+@[^\\s@<>,;\\^]+\\.[^\\s@<>,;\\^]+)$", "type": "string" }, "QueryForEmailAddress": { "type": "boolean" }, "Title": { "maxLength": 64, "minLength": 0, "type": "string" }, "QueryForTitle": { "type": "boolean" }, "Organization": { "maxLength": 128, "minLength": 0, "type": "string" }, "QueryForOrganization": { "type": "boolean" }, "ThirdPartyData": { "type": "string" }, "DownloadWindowInMinutes": { "format": "int32", "type": "integer" }, "DownloadLimit": { "format": "int32", "type": "integer" }, "Jurisdiction": { "$ref": "#/definitions/ParticipantJurisdictionModel" }, "EmailNotifications": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/EmailNotificationModel" } ], "xml": { "name": "EmailNotification" } }, "xml": { "name": "EmailNotifications", "wrapped": true } }, "WorkflowActions": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/ParticipantWorkflowActionModel" } ], "xml": { "name": "WorkflowAction" } }, "xml": { "name": "WorkflowActions", "wrapped": true } }, "EmailTemplatePlaceholders": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/EmailTemplatePlaceholderModel" } ], "xml": { "name": "EmailTemplatePlaceholder" } }, "xml": { "name": "EmailTemplatePlaceholders", "wrapped": true } }, "Tasks": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/TaskInsertModel" } ], "xml": { "name": "Task" } }, "xml": { "name": "Tasks", "wrapped": true } }, "AccessOrder": { "format": "int32", "type": "integer" }, "ContentPlaceholders": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/ContentPlaceholderModel" } ], "xml": { "name": "ContentPlaceholder" } }, "xml": { "name": "ContentPlaceholders", "wrapped": true } }, "ContentSetName": { "maxLength": 128, "minLength": 0, "type": "string" }, "LanguagePreferred": { "type": "string" }, "AllowReassignment": { "type": "boolean" }, "Role": { "maxLength": 48, "minLength": 0, "pattern": "^[^&]*$", "type": "string" }, "Initials": { "maxLength": 4, "minLength": 0, "type": "string" }, "QueryForInitials": { "type": "boolean" }, "BrandName": { "maxLength": 128, "minLength": 0, "type": "string" }, "PdfFieldForFullName": { "maxLength": 128, "minLength": 0, "type": "string" }, "PdfFieldForFirstName": { "maxLength": 128, "minLength": 0, "type": "string" }, "PdfFieldForLastName": { "maxLength": 128, "minLength": 0, "type": "string" }, "PdfFieldForEmailAddress": { "maxLength": 128, "minLength": 0, "type": "string" }, "PdfFieldForTitle": { "maxLength": 128, "minLength": 0, "type": "string" }, "PdfFieldForOrganization": { "maxLength": 128, "minLength": 0, "type": "string" }, "OverrideDefaultParticipantPdfFields": { "type": "boolean" }, "SendRequestViaSms": { "type": "boolean" }, "PhoneNumber": { "maxLength": 64, "minLength": 0, "type": "string" }, "SmsCredentialName": { "maxLength": 64, "minLength": 0, "type": "string" }, "ParticipantInsertIdentity": { "format": "int32", "type": "integer" }, "IsDefinedParticipant": { "type": "boolean" }, "SessionTimeoutUrl": { "type": "string" }, "QueryForCity": { "type": "boolean" }, "QueryForCountry": { "type": "boolean" }, "QueryForStateProv": { "type": "boolean" }, "DisplayAllPages": { "type": "boolean" } }, "xml": { "name": "ParticipantInsertModel" } }, "ParticipantResendNotificationRequestModel": { "required": [ "Participants" ], "type": "object", "properties": { "Participants": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/ParticipantResendNotificationModel" } ], "xml": { "name": "Participant" } }, "xml": { "name": "Participants", "wrapped": true } }, "EnableLogging": { "type": "boolean" } }, "xml": { "name": "ParticipantResendNotificationRequestModel" } }, "ParticipantResendNotificationModel": { "required": [ "ID" ], "type": "object", "properties": { "ID": { "format": "int32", "type": "integer" }, "EmailAddress": { "pattern": "^(?![.])([^@,;<>\\^]+@[^\\s@<>,;\\^]+\\.[^\\s@<>,;\\^]+)$", "type": "string" } }, "xml": { "name": "ParticipantResendNotificationModel" } }, "ParticipantEncryptedCredentialsRequestModel": { "required": [ "Credentials" ], "type": "object", "properties": { "EnableLogging": { "type": "boolean" }, "Credentials": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/ParticipantCredentialsModel" } ], "xml": { "name": "Credential" } }, "xml": { "name": "Credentials", "wrapped": true } } }, "xml": { "name": "ParticipantEncryptedCredentialsRequestModel" } }, "ParticipantCredentialsModel": { "required": [ "ParticipantID", "Password" ], "type": "object", "properties": { "ParticipantID": { "format": "int32", "type": "integer" }, "Username": { "type": "string" }, "Password": { "type": "string" }, "ExpirationInSeconds": { "format": "int32", "type": "integer" } }, "xml": { "name": "ParticipantCredentialsModel" } }, "ParticipantEncryptedCredentialsServiceReturnModel": { "type": "object", "properties": { "IsSuccessful": { "type": "boolean" }, "Message": { "type": "string" }, "EncryptedCredentials": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/ParticipantEncryptedCredentialsModel" } ], "xml": { "name": "EncryptedCredential" } }, "xml": { "name": "EncryptedCredentials", "wrapped": true } }, "ProcessingTime": { "type": "string" }, "TimeZoneUtcOffset": { "format": "double", "type": "number" } }, "xml": { "name": "ParticipantEncryptedCredentialsServiceReturnModel" } }, "ParticipantEncryptedCredentialsModel": { "type": "object", "properties": { "Username": { "type": "string" }, "Password": { "type": "string" } }, "xml": { "name": "ParticipantEncryptedCredentialsModel" } }, "ParticipantAuthenticationUpdateRequestModel": { "required": [ "ParticipantAuthentications" ], "type": "object", "properties": { "ParticipantAuthentications": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/ParticipantAuthenticationUpdateModel" } ], "xml": { "name": "ParticipantAuthentication" } }, "xml": { "name": "ParticipantAuthentications", "wrapped": true } }, "EnableLogging": { "type": "boolean" } }, "xml": { "name": "ParticipantAuthenticationUpdateRequestModel" } }, "ParticipantAuthenticationUpdateModel": { "required": [ "ParticipantID" ], "type": "object", "properties": { "ParticipantID": { "format": "int32", "type": "integer" }, "Authentication": { "$ref": "#/definitions/AuthenticationModel" } }, "xml": { "name": "ParticipantAuthenticationUpdateModel" } }, "ParticipantWorkflowActionsUpdateRequestModel": { "required": [ "ParticipantWorkflowActions" ], "type": "object", "properties": { "ParticipantWorkflowActions": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/ParticipantWorkflowActionsUpdateModel" } ], "xml": { "name": "ParticipantWorkflowAction" } }, "xml": { "name": "ParticipantWorkflowActions", "wrapped": true } }, "EnableLogging": { "type": "boolean" } }, "xml": { "name": "ParticipantWorkflowActionsUpdateRequestModel" } }, "ParticipantWorkflowActionsUpdateModel": { "required": [ "ID", "Count" ], "type": "object", "properties": { "ID": { "format": "int32", "type": "integer" }, "Count": { "format": "int32", "type": "integer" }, "Data": { "type": "string" }, "Url": { "type": "string" }, "Description": { "type": "string" }, "ButtonTextPositive": { "type": "string" }, "ButtonTextNegative": { "type": "string" }, "Content": { "type": "string" }, "PhoneNumber": { "type": "string" }, "EmailAddress": { "type": "string" }, "CustomHeaders": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/CustomHeaderModel" } ], "xml": { "name": "CustomHeader" } }, "xml": { "name": "CustomHeaders", "wrapped": true } } }, "xml": { "name": "ParticipantWorkflowActionsUpdateModel" } }, "ParticipantContentPlaceholderUpdateRequestModel": { "required": [ "ParticipantContentPlaceholders" ], "type": "object", "properties": { "ParticipantContentPlaceholders": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/ParticipantContentPlaceholderUpdateModel" } ], "xml": { "name": "ParticipantContentPlaceholder" } }, "xml": { "name": "ParticipantContentPlaceholders", "wrapped": true } }, "EnableLogging": { "type": "boolean" } }, "xml": { "name": "ParticipantContentPlaceholderUpdateRequestModel" } }, "ParticipantContentPlaceholderUpdateModel": { "required": [ "ID", "ParticipantID", "Name", "Value" ], "type": "object", "properties": { "ID": { "format": "int32", "type": "integer" }, "ParticipantID": { "format": "int32", "type": "integer" }, "Name": { "maxLength": 50, "minLength": 0, "type": "string" }, "Value": { "type": "string" } }, "xml": { "name": "ParticipantContentPlaceholderUpdateModel" } }, "ParticipantUpdateableRequestModel": { "type": "object", "properties": { "IDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "IDs", "wrapped": true } }, "ProntoID": { "type": "string" }, "TransactionIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "TransactionIDs", "wrapped": true } }, "DocumentIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "DocumentIDs", "wrapped": true } }, "TaskIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "TaskIDs", "wrapped": true } }, "StatusType": { "enum": [ "All", "Validating", "Pending", "TheRealPending", "Completed", "EmailSent", "Closed", "Cancelled", "Expired", "Voided" ], "type": "string" }, "FullName": { "maxLength": 64, "minLength": 0, "type": "string" }, "EmailAddress": { "maxLength": 128, "minLength": 0, "type": "string" }, "Title": { "maxLength": 64, "minLength": 0, "type": "string" }, "Organization": { "maxLength": 128, "minLength": 0, "type": "string" }, "SearchDateType": { "enum": [ "CreatedDate", "ClosedDate" ], "type": "string" }, "SearchDateFrom": { "format": "date-time", "type": "string" }, "SearchDateTo": { "format": "date-time", "type": "string" }, "EnableLogging": { "type": "boolean" }, "ResultsCountLimit": { "format": "int32", "type": "integer" }, "ResultsCountStart": { "format": "int32", "type": "integer" }, "IncludeTests": { "type": "boolean" }, "TimeZoneID": { "type": "string" } }, "xml": { "name": "ParticipantUpdateableRequestModel" } }, "ParticipantUpdateableServiceReturnModel": { "type": "object", "properties": { "IsSuccessful": { "type": "boolean" }, "Message": { "type": "string" }, "UpdateableParticipants": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/ParticipantUpdateModel" } ], "xml": { "name": "UpdateableParticipant" } }, "xml": { "name": "UpdateableParticipants", "wrapped": true } }, "ProcessingTime": { "type": "string" }, "TimeZoneUtcOffset": { "format": "double", "type": "number" } }, "xml": { "name": "ParticipantUpdateableServiceReturnModel" } }, "ParticipantAuthenticationUpdateableRequestModel": { "type": "object", "properties": { "IDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "IDs", "wrapped": true } }, "ProntoID": { "type": "string" }, "ParticipantIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "ParticipantIDs", "wrapped": true } }, "EnableLogging": { "type": "boolean" } }, "xml": { "name": "ParticipantAuthenticationUpdateableRequestModel" } }, "ParticipantAuthenticationUpdateableServiceReturnModel": { "type": "object", "properties": { "IsSuccessful": { "type": "boolean" }, "Message": { "type": "string" }, "UpdateableParticipantAuthentications": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/ParticipantAuthenticationUpdateModel" } ], "xml": { "name": "UpdateableParticipantAuthentication" } }, "xml": { "name": "UpdateableParticipantAuthentications", "wrapped": true } }, "ProcessingTime": { "type": "string" }, "TimeZoneUtcOffset": { "format": "double", "type": "number" } }, "xml": { "name": "ParticipantAuthenticationUpdateableServiceReturnModel" } }, "ParticipantWorkflowActionsUpdateableRequestModel": { "required": [ "IDs" ], "type": "object", "properties": { "IDs": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/ParticipantWorkflowActionIDModel" } ], "xml": { "name": "ID" } }, "xml": { "name": "IDs", "wrapped": true } }, "EnableLogging": { "type": "boolean" } }, "xml": { "name": "ParticipantWorkflowActionsUpdateableRequestModel" } }, "ParticipantWorkflowActionIDModel": { "required": [ "ParticipantID" ], "type": "object", "properties": { "ParticipantID": { "format": "int32", "type": "integer" }, "ActionCount": { "format": "int32", "type": "integer" } }, "xml": { "name": "ParticipantWorkflowActionIDModel" } }, "ParticipantWorkflowActionsUpdateableReturnModel": { "type": "object", "properties": { "IsSuccessful": { "type": "boolean" }, "Message": { "type": "string" }, "UpdateableParticipantWorkflowActions": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/ParticipantWorkflowActionsUpdateModel" } ], "xml": { "name": "UpdateableParticipantWorkflowAction" } }, "xml": { "name": "UpdateableParticipantWorkflowActions", "wrapped": true } }, "ProcessingTime": { "type": "string" }, "TimeZoneUtcOffset": { "format": "double", "type": "number" } }, "xml": { "name": "ParticipantWorkflowActionsUpdateableReturnModel" } }, "ParticipantContentPlaceholderUpdateableRequestModel": { "type": "object", "properties": { "IDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "IDs", "wrapped": true } }, "ProntoID": { "type": "string" }, "ParticipantIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "ParticipantIDs", "wrapped": true } }, "EnableLogging": { "type": "boolean" } }, "xml": { "name": "ParticipantContentPlaceholderUpdateableRequestModel" } }, "ParticipantContentPlaceholderUpdateableServiceReturnModel": { "type": "object", "properties": { "IsSuccessful": { "type": "boolean" }, "Message": { "type": "string" }, "UpdateableParticipantContentPlaceholders": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/ParticipantContentPlaceholderUpdateModel" } ], "xml": { "name": "UpdateableParticipantContentPlaceholder" } }, "xml": { "name": "UpdateableParticipantContentPlaceholders", "wrapped": true } }, "ProcessingTime": { "type": "string" }, "TimeZoneUtcOffset": { "format": "double", "type": "number" } }, "xml": { "name": "ParticipantContentPlaceholderUpdateableServiceReturnModel" } }, "ParticipantContentPlaceholderInsertRequestModel": { "required": [ "ParticipantContentPlaceholders" ], "type": "object", "properties": { "ParticipantContentPlaceholders": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/ParticipantContentPlaceholderInsertModel" } ], "xml": { "name": "ParticipantContentPlaceholder" } }, "xml": { "name": "ParticipantContentPlaceholders", "wrapped": true } }, "EnableLogging": { "type": "boolean" } }, "xml": { "name": "ParticipantContentPlaceholderInsertRequestModel" } }, "ParticipantContentPlaceholderInsertModel": { "type": "object", "properties": { "ParticipantID": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "Value": { "type": "string" } }, "xml": { "name": "ParticipantContentPlaceholderInsertModel" } }, "ParticipantContentPlaceholderDetailsServiceReturnModel": { "type": "object", "properties": { "IsSuccessful": { "type": "boolean" }, "Message": { "type": "string" }, "ParticipantContentPlaceholders": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/ParticipantContentPlaceholderDetailsModel" } ], "xml": { "name": "ParticipantContentPlaceholder" } }, "xml": { "name": "ParticipantContentPlaceholders", "wrapped": true } }, "ProcessingTime": { "type": "string" }, "TimeZoneUtcOffset": { "format": "double", "type": "number" } }, "xml": { "name": "ParticipantContentPlaceholderDetailsServiceReturnModel" } }, "ParticipantContentPlaceholderDetailsModel": { "type": "object", "properties": { "ID": { "format": "int32", "type": "integer" }, "ParticipantID": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "Value": { "type": "string" } }, "xml": { "name": "ParticipantContentPlaceholderDetailsModel" } }, "ParticipantContentPlaceholderDeleteRequestModel": { "required": [ "ParticipantContentPlaceholders" ], "type": "object", "properties": { "ParticipantContentPlaceholders": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/ParticipantContentPlaceholderDeleteModel" } ], "xml": { "name": "ParticipantContentPlaceholder" } }, "xml": { "name": "ParticipantContentPlaceholders", "wrapped": true } }, "EnableLogging": { "type": "boolean" } }, "xml": { "name": "ParticipantContentPlaceholderDeleteRequestModel" } }, "ParticipantContentPlaceholderDeleteModel": { "type": "object", "properties": { "ID": { "format": "int32", "type": "integer" }, "ParticipantID": { "format": "int32", "type": "integer" }, "Name": { "type": "string" } }, "xml": { "name": "ParticipantContentPlaceholderDeleteModel" } }, "TransactionCertifySealRequestModel": { "required": [ "Transactions" ], "type": "object", "properties": { "Transactions": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/TransactionCertifySealPdfModel" } ], "xml": { "name": "Transaction" } }, "xml": { "name": "Transactions", "wrapped": true } }, "EnableLogging": { "type": "boolean" }, "TimeZoneID": { "type": "string" } }, "xml": { "name": "TransactionCertifySealRequestModel" } }, "TransactionCertifySealPdfModel": { "required": [ "Description", "Pdfs" ], "type": "object", "properties": { "Description": { "type": "string" }, "Pdfs": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/DocumentPdfModel" } ], "xml": { "name": "Pdf" } }, "xml": { "name": "Pdfs", "wrapped": true } }, "IsTest": { "type": "boolean" }, "IsRemoteCertify": { "type": "boolean" }, "RemoteCertifierName": { "type": "string" }, "RemoteCertifierTitle": { "type": "string" }, "RemoteCertifierOrganization": { "type": "string" }, "RemoteCertifierEmail": { "type": "string" } }, "xml": { "name": "TransactionCertifySealPdfModel" } }, "DocumentPdfModel": { "required": [ "Title" ], "type": "object", "properties": { "Title": { "type": "string" }, "DeletionDate": { "format": "date-time", "type": "string" }, "FileBytes": { "format": "byte", "type": "string" }, "FileSystemPath": { "type": "string" }, "NotificationUrl": { "type": "string" }, "IsNotificationTypeGet": { "type": "boolean" }, "NotificationData": { "type": "string" } }, "xml": { "name": "DocumentPdfModel" } }, "CertifySealPdfsServiceReturnModel": { "type": "object", "properties": { "IsSuccessful": { "type": "boolean" }, "Message": { "type": "string" }, "Pdfs": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/DocumentPdfDetailsModel" } ], "xml": { "name": "Pdf" } }, "xml": { "name": "Pdfs", "wrapped": true } }, "ProcessingTime": { "type": "string" }, "TimeZoneUtcOffset": { "format": "double", "type": "number" } }, "xml": { "name": "CertifySealPdfsServiceReturnModel" } }, "DocumentPdfDetailsModel": { "type": "object", "properties": { "IsPendingCertification": { "type": "boolean" }, "DocumentID": { "format": "int32", "type": "integer" }, "DocumentFile": { "$ref": "#/definitions/DocumentFileModel" } }, "xml": { "name": "DocumentPdfDetailsModel" } }, "DocumentPdfDataFileDetailsRequestModel": { "type": "object", "properties": { "ProntoID": { "type": "string" }, "IDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "IDs", "wrapped": true } }, "TransactionIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "TransactionIDs", "wrapped": true } }, "ParticipantIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "ParticipantIDs", "wrapped": true } }, "TaskIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "TaskIDs", "wrapped": true } }, "MetaDataName": { "type": "string" }, "MetaDataValue": { "type": "string" }, "StatusType": { "enum": [ "All", "Validating", "Pending", "TheRealPending", "Completed", "EmailSent", "Closed", "Cancelled", "Expired", "Voided" ], "type": "string" }, "SearchDateType": { "enum": [ "CreatedDate", "ClosedDate" ], "type": "string" }, "SearchDateFrom": { "format": "date-time", "type": "string" }, "SearchDateTo": { "format": "date-time", "type": "string" }, "EnableLogging": { "type": "boolean" }, "ResultsCountLimit": { "format": "int32", "type": "integer" }, "ResultsCountStart": { "format": "int32", "type": "integer" }, "IsCsvFormat": { "type": "boolean" }, "TimeZoneID": { "type": "string" } }, "xml": { "name": "DocumentPdfDataFileDetailsRequestModel" } }, "PreloadScriptsModel": { "type": "object", "properties": { "IsSuccessful": { "type": "boolean" }, "Message": { "type": "string" }, "PreloadScripts": { "type": "array", "items": { "type": "string", "allOf": [ {} ], "xml": { "name": "string" } }, "xml": { "name": "PreloadScripts", "wrapped": true } }, "ProcessingTime": { "type": "string" }, "TimeZoneUtcOffset": { "format": "double", "type": "number" } }, "xml": { "name": "PreloadScriptsModel" } }, "TransactionTokenDataRequestModel": { "required": [ "SecurityToken" ], "type": "object", "properties": { "SecurityToken": { "pattern": "^[A-Fa-f0-9]{8}(?:-[A-Fa-f0-9]{4}){3}-[A-Fa-f0-9]{12}$", "type": "string" }, "EnableLogging": { "type": "boolean" } }, "xml": { "name": "TransactionTokenDataRequestModel" } }, "TransactionTokenDataServiceReturnModel": { "type": "object", "properties": { "IsSuccessful": { "type": "boolean" }, "Message": { "type": "string" }, "TokenData": { "$ref": "#/definitions/TransactionTokenDataModel" }, "ProcessingTime": { "type": "string" }, "TimeZoneUtcOffset": { "format": "double", "type": "number" } }, "xml": { "name": "TransactionTokenDataServiceReturnModel" } }, "TransactionTokenDataModel": { "required": [ "TransactionID" ], "type": "object", "properties": { "TransactionID": { "format": "int32", "type": "integer" }, "TransactionStatus": { "enum": [ "All", "Validating", "Pending", "TheRealPending", "Completed", "EmailSent", "Closed", "Cancelled", "Expired", "Voided" ], "type": "string" }, "ParticipantID": { "format": "int32", "type": "integer" }, "ParticipantStatus": { "enum": [ "All", "Validating", "Pending", "TheRealPending", "Completed", "EmailSent", "Closed", "Cancelled", "Expired", "Voided" ], "type": "string" }, "DocumentID": { "format": "int32", "type": "integer" }, "DocumentStatus": { "enum": [ "All", "Validating", "Pending", "TheRealPending", "Completed", "EmailSent", "Closed", "Cancelled", "Expired", "Voided" ], "type": "string" }, "DocumentCertifySealStatus": { "enum": [ "All", "Validating", "Pending", "TheRealPending", "Completed", "EmailSent", "Closed", "Cancelled", "Expired", "Voided" ], "type": "string" }, "TaskID": { "format": "int32", "type": "integer" }, "TaskStatus": { "enum": [ "All", "Validating", "Pending", "TheRealPending", "Completed", "EmailSent", "Closed", "Cancelled", "Expired", "Voided" ], "type": "string" }, "ActionNumber": { "format": "int32", "type": "integer" }, "ActionStatus": { "enum": [ "All", "Validating", "Pending", "TheRealPending", "Completed", "EmailSent", "Closed", "Cancelled", "Expired", "Voided" ], "type": "string" }, "VictimStatement": { "type": "string" }, "Comment": { "type": "string" }, "EventType": { "enum": [ "TransactionStatusUpdate", "ParticipantStatusUpdate", "DocumentStatusUpdate", "TaskStatusUpdate", "ParticipantSessionStart", "ParticipantAuthenticationFailure", "ParticipantVictimStatement", "DocumentSkipped", "DocumentCertified", "DocumentSealed", "ParticipantWorkflowAction", "TaskWorkflowAction", "ParticipantReassigned", "ParticipantDefined", "ParticipantAuthenticationSuccess" ], "type": "string" }, "ParticipantRole": { "type": "string" }, "ReassignedPartID": { "format": "int32", "type": "integer" } }, "xml": { "name": "TransactionTokenDataModel" } }, "TaskUpdateRequestModel": { "required": [ "Tasks" ], "type": "object", "properties": { "Tasks": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/TaskUpdateModel" } ], "xml": { "name": "Task" } }, "xml": { "name": "Tasks", "wrapped": true } }, "EnableLogging": { "type": "boolean" } }, "xml": { "name": "TaskUpdateRequestModel" } }, "TaskUpdateModel": { "required": [ "ID", "ParticipantID" ], "type": "object", "properties": { "ID": { "format": "int32", "type": "integer" }, "ParticipantID": { "format": "int32", "type": "integer" } }, "xml": { "name": "TaskUpdateModel" } }, "TaskDetailsRequestModel": { "type": "object", "properties": { "IDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "IDs", "wrapped": true } }, "ProntoID": { "type": "string" }, "TransactionIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "TransactionIDs", "wrapped": true } }, "DocumentIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "DocumentIDs", "wrapped": true } }, "ParticipantIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "ParticipantIDs", "wrapped": true } }, "StatusType": { "enum": [ "All", "Validating", "Pending", "TheRealPending", "Completed", "EmailSent", "Closed", "Cancelled", "Expired", "Voided" ], "type": "string" }, "SearchDateType": { "enum": [ "CreatedDate", "ClosedDate" ], "type": "string" }, "SearchDateFrom": { "format": "date-time", "type": "string" }, "SearchDateTo": { "format": "date-time", "type": "string" }, "Includes": { "$ref": "#/definitions/TaskIncludesModel" }, "EnableLogging": { "type": "boolean" }, "ResultsCountLimit": { "format": "int32", "type": "integer" }, "ResultsCountStart": { "format": "int32", "type": "integer" }, "AccessToken": { "type": "string" }, "TimeZoneID": { "type": "string" } }, "xml": { "name": "TaskDetailsRequestModel" } }, "TaskDetailsServiceReturnModel": { "type": "object", "properties": { "IsSuccessful": { "type": "boolean" }, "Message": { "type": "string" }, "Tasks": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/TaskDetailsModel" } ], "xml": { "name": "Task" } }, "xml": { "name": "Tasks", "wrapped": true } }, "ProcessingTime": { "type": "string" }, "TimeZoneUtcOffset": { "format": "double", "type": "number" } }, "xml": { "name": "TaskDetailsServiceReturnModel" } }, "TaskWorkflowActionUpdateRequestModel": { "required": [ "WorkflowAction" ], "type": "object", "properties": { "EnableLogging": { "type": "boolean" }, "WorkflowAction": { "$ref": "#/definitions/TaskWorkflowActionUpdateModel" } }, "xml": { "name": "TaskWorkflowActionUpdateRequestModel" } }, "TaskWorkflowActionUpdateModel": { "required": [ "TaskID", "ID" ], "type": "object", "properties": { "TaskID": { "format": "int32", "type": "integer" }, "ID": { "format": "int32", "type": "integer" }, "IsCompleted": { "type": "boolean" } }, "xml": { "name": "TaskWorkflowActionUpdateModel" } }, "TaskWorkflowActionServiceReturnModel": { "type": "object", "properties": { "IsSuccessful": { "type": "boolean" }, "Message": { "type": "string" }, "ReturnUrl": { "type": "string" }, "ProcessingTime": { "type": "string" }, "TimeZoneUtcOffset": { "format": "double", "type": "number" } }, "xml": { "name": "TaskWorkflowActionServiceReturnModel" } }, "TaskInsertRequestModel": { "required": [ "Tasks" ], "type": "object", "properties": { "Tasks": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/TaskInsertModel" } ], "xml": { "name": "Task" } }, "xml": { "name": "Tasks", "wrapped": true } }, "ResponseIncludes": { "$ref": "#/definitions/TaskIncludesModel" }, "EnableLogging": { "type": "boolean" }, "TimeZoneID": { "type": "string" } }, "xml": { "name": "TaskInsertRequestModel" } }, "TaskRemoteSignRequestModel": { "required": [ "Tasks" ], "type": "object", "properties": { "EnableLogging": { "type": "boolean" }, "Tasks": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/TaskRemoteSignModel" } ], "xml": { "name": "Task" } }, "xml": { "name": "Tasks", "wrapped": true } } }, "xml": { "name": "TaskRemoteSignRequestModel" } }, "TaskRemoteSignModel": { "required": [ "ID", "IpAddress" ], "type": "object", "properties": { "ID": { "format": "int32", "type": "integer" }, "Username": { "type": "string" }, "Password": { "type": "string" }, "IpAddress": { "pattern": "^([\\d]{1,3}\\.){3}[\\d]{1,3}$", "type": "string" } }, "xml": { "name": "TaskRemoteSignModel" } }, "TaskWorkflowActionsUpdateRequestModel": { "required": [ "TaskWorkflowActions" ], "type": "object", "properties": { "TaskWorkflowActions": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/TaskWorkflowActionsUpdateModel" } ], "xml": { "name": "TaskWorkflowAction" } }, "xml": { "name": "TaskWorkflowActions", "wrapped": true } }, "EnableLogging": { "type": "boolean" } }, "xml": { "name": "TaskWorkflowActionsUpdateRequestModel" } }, "TaskWorkflowActionsUpdateModel": { "required": [ "ID", "Count" ], "type": "object", "properties": { "ID": { "format": "int32", "type": "integer" }, "Count": { "format": "int32", "type": "integer" }, "Data": { "type": "string" }, "Url": { "type": "string" }, "Description": { "type": "string" }, "ButtonTextPositive": { "type": "string" }, "ButtonTextNegative": { "type": "string" }, "Content": { "type": "string" }, "PhoneNumber": { "type": "string" }, "EmailAddress": { "type": "string" }, "CustomHeaders": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/CustomHeaderModel" } ], "xml": { "name": "CustomHeader" } }, "xml": { "name": "CustomHeaders", "wrapped": true } } }, "xml": { "name": "TaskWorkflowActionsUpdateModel" } }, "TaskUpdateableRequestModel": { "type": "object", "properties": { "IDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "IDs", "wrapped": true } }, "ProntoID": { "type": "string" }, "TransactionIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "TransactionIDs", "wrapped": true } }, "DocumentIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "DocumentIDs", "wrapped": true } }, "ParticipantIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "ParticipantIDs", "wrapped": true } }, "SearchDateType": { "enum": [ "CreatedDate", "ClosedDate" ], "type": "string" }, "SearchDateFrom": { "format": "date-time", "type": "string" }, "SearchDateTo": { "format": "date-time", "type": "string" }, "StatusType": { "enum": [ "All", "Validating", "Pending", "TheRealPending", "Completed", "EmailSent", "Closed", "Cancelled", "Expired", "Voided" ], "type": "string" }, "EnableLogging": { "type": "boolean" }, "ResultsCountLimit": { "format": "int32", "type": "integer" }, "ResultsCountStart": { "format": "int32", "type": "integer" }, "IncludeTests": { "type": "boolean" }, "TimeZoneID": { "type": "string" } }, "xml": { "name": "TaskUpdateableRequestModel" } }, "TaskUpdateableServiceReturnModel": { "type": "object", "properties": { "IsSuccessful": { "type": "boolean" }, "Message": { "type": "string" }, "UpdateableTasks": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/TaskUpdateModel" } ], "xml": { "name": "UpdateableTask" } }, "xml": { "name": "UpdateableTasks", "wrapped": true } }, "ProcessingTime": { "type": "string" }, "TimeZoneUtcOffset": { "format": "double", "type": "number" } }, "xml": { "name": "TaskUpdateableServiceReturnModel" } }, "TaskWorkflowActionsUpdateableRequestModel": { "required": [ "IDs" ], "type": "object", "properties": { "IDs": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/TaskWorkflowActionIDModel" } ], "xml": { "name": "ID" } }, "xml": { "name": "IDs", "wrapped": true } }, "EnableLogging": { "type": "boolean" } }, "xml": { "name": "TaskWorkflowActionsUpdateableRequestModel" } }, "TaskWorkflowActionIDModel": { "required": [ "ActionCount" ], "type": "object", "properties": { "TaskID": { "format": "int32", "type": "integer" }, "ActionCount": { "format": "int32", "type": "integer" } }, "xml": { "name": "TaskWorkflowActionIDModel" } }, "TaskWorkflowActionsUpdateableReturnModel": { "type": "object", "properties": { "IsSuccessful": { "type": "boolean" }, "Message": { "type": "string" }, "UpdateableTaskWorkflowActions": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/TaskWorkflowActionsUpdateModel" } ], "xml": { "name": "UpdateableTaskWorkflowAction" } }, "xml": { "name": "UpdateableTaskWorkflowActions", "wrapped": true } }, "ProcessingTime": { "type": "string" }, "TimeZoneUtcOffset": { "format": "double", "type": "number" } }, "xml": { "name": "TaskWorkflowActionsUpdateableReturnModel" } }, "TransactionUpdateRequestModel": { "type": "object", "properties": { "Transactions": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/TransactionUpdateModel" } ], "xml": { "name": "Transaction" } }, "xml": { "name": "Transactions", "wrapped": true } }, "EnableLogging": { "type": "boolean" } }, "xml": { "name": "TransactionUpdateRequestModel" } }, "TransactionUpdateModel": { "required": [ "ID", "ProntoID", "Description" ], "type": "object", "properties": { "ID": { "format": "int32", "type": "integer" }, "ProntoID": { "type": "string" }, "Description": { "type": "string" }, "IsTest": { "type": "boolean" }, "IsParticipantOrderNonSequential": { "type": "boolean" }, "DisableCompleteNotificationAttachments": { "type": "boolean" }, "CompleteNotificationEmailAddresses": { "type": "array", "items": { "type": "string", "allOf": [ {} ], "xml": { "name": "string" } }, "xml": { "name": "CompleteNotificationEmailAddresses", "wrapped": true } }, "OutgoingEmailDetails": { "$ref": "#/definitions/OutgoingEmailDetailsModel" }, "Jurisdiction": { "$ref": "#/definitions/JurisdictionModel" }, "CreatorUserID": { "format": "int32", "type": "integer" }, "ExpirationDate": { "format": "date-time", "type": "string" }, "EmailTemplateSetName": { "type": "string" }, "SessionExpirationMinutes": { "format": "int32", "type": "integer" }, "SendCompletedNotification": { "type": "boolean" }, "SendCancelledNotification": { "type": "boolean" }, "SendExpiredNotification": { "type": "boolean" }, "EnableMessagePromptOnCancel": { "type": "boolean" }, "ThirdPartyNotifications": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/TransactionNotificationDetailsModel" } ], "xml": { "name": "ThirdPartyNotification" } }, "xml": { "name": "ThirdPartyNotifications", "wrapped": true } }, "IncludeUploadedAttachmentsInThirdPartyNotifications": { "type": "boolean" }, "EmailTemplateSetLanguage": { "type": "string" }, "TSCleanup": { "format": "date-time", "type": "string" }, "AuthChallengeQuestionsBadLoginLimit": { "format": "int32", "maximum": 2147483647, "minimum": 1, "type": "integer" }, "AuthOneTimePasscodeBadLoginLimit": { "format": "int32", "maximum": 2147483647, "minimum": 1, "type": "integer" }, "OneTimePasscodeTimeoutInSeconds": { "format": "int32", "maximum": 2147483647, "minimum": 1, "type": "integer" } }, "xml": { "name": "TransactionUpdateModel" } }, "OutgoingEmailDetailsModel": { "type": "object", "properties": { "FromName": { "maxLength": 64, "minLength": 0, "type": "string" }, "FromEmailAddress": { "maxLength": 64, "minLength": 0, "type": "string" }, "FooterContent": { "type": "string" } }, "xml": { "name": "OutgoingEmailDetailsModel" } }, "JurisdictionModel": { "type": "object", "properties": { "Rule": { "maxLength": 20, "minLength": 0, "type": "string" }, "Country": { "maxLength": 2, "minLength": 0, "type": "string" }, "StateProvince": { "maxLength": 8, "minLength": 0, "type": "string" } }, "xml": { "name": "JurisdictionModel" } }, "TransactionNotificationDetailsModel": { "required": [ "EmailAddress" ], "type": "object", "properties": { "FullName": { "maxLength": 64, "minLength": 0, "type": "string" }, "EmailAddress": { "maxLength": 128, "minLength": 0, "type": "string" }, "Language": { "maxLength": 8, "minLength": 0, "type": "string" }, "Placeholders": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/TransactionNotificationPlaceholderModel" } ], "xml": { "name": "Placeholder" } }, "xml": { "name": "Placeholders", "wrapped": true } } }, "xml": { "name": "TransactionNotificationDetailsModel" } }, "TransactionNotificationPlaceholderModel": { "required": [ "Name", "Value" ], "type": "object", "properties": { "Name": { "maxLength": 50, "minLength": 0, "pattern": "^[a-zA-Z0-9_]*$", "type": "string" }, "Value": { "type": "string" } }, "xml": { "name": "TransactionNotificationPlaceholderModel" } }, "TransactionDetailsRequestModel": { "type": "object", "properties": { "ProntoID": { "type": "string" }, "IDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "IDs", "wrapped": true } }, "DocumentIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "DocumentIDs", "wrapped": true } }, "ParticipantIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "ParticipantIDs", "wrapped": true } }, "TaskIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "TaskIDs", "wrapped": true } }, "MetaDataName": { "type": "string" }, "MetaDataValue": { "type": "string" }, "StatusType": { "enum": [ "All", "Validating", "Pending", "TheRealPending", "Completed", "EmailSent", "Closed", "Cancelled", "Expired", "Voided" ], "type": "string" }, "SearchDateType": { "enum": [ "CreatedDate", "ClosedDate" ], "type": "string" }, "SearchDateFrom": { "format": "date-time", "type": "string" }, "SearchDateTo": { "format": "date-time", "type": "string" }, "Includes": { "$ref": "#/definitions/TransactionIncludesModel" }, "EnableLogging": { "type": "boolean" }, "ResultsCountLimit": { "format": "int32", "type": "integer" }, "ResultsCountStart": { "format": "int32", "type": "integer" }, "SearchText": { "type": "string" }, "CreatorUserID": { "format": "int32", "type": "integer" }, "TimeZoneID": { "type": "string" }, "SearchEntityType": { "enum": [ "Everything", "Transactions", "Documents", "Participants", "Tasks" ], "type": "string" } }, "xml": { "name": "TransactionDetailsRequestModel" } }, "TransactionIncludesModel": { "type": "object", "properties": { "IncludeWorkflowActions": { "type": "boolean" }, "IncludeMetaData": { "type": "boolean" }, "IncludeParticipants": { "type": "boolean" }, "ParticipantIncludes": { "$ref": "#/definitions/ParticipantIncludesModel" }, "IncludeDocuments": { "type": "boolean" }, "DocumentIncludes": { "$ref": "#/definitions/DocumentIncludesModel" }, "IncludeTests": { "type": "boolean" }, "IncludeThirdPartyNotifications": { "type": "boolean" } }, "xml": { "name": "TransactionIncludesModel" } }, "TransactionDetailsServiceReturnModel": { "type": "object", "properties": { "IsSuccessful": { "type": "boolean" }, "Message": { "type": "string" }, "Transactions": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/TransactionDetailsModel" } ], "xml": { "name": "Transaction" } }, "xml": { "name": "Transactions", "wrapped": true } }, "ProcessingTime": { "type": "string" }, "TimeZoneUtcOffset": { "format": "double", "type": "number" } }, "xml": { "name": "TransactionDetailsServiceReturnModel" } }, "TransactionDetailsModel": { "type": "object", "properties": { "ID": { "format": "int32", "type": "integer" }, "ProntoID": { "type": "string" }, "IsTest": { "type": "boolean" }, "StatusID": { "format": "int32", "type": "integer" }, "IsParticipantOrderNonSequential": { "type": "boolean" }, "DisableCompleteNotificationAttachments": { "type": "boolean" }, "CompleteNotificationEmailAddresses": { "type": "array", "items": { "type": "string", "allOf": [ {} ], "xml": { "name": "string" } }, "xml": { "name": "CompleteNotificationEmailAddresses", "wrapped": true } }, "OutgoingEmailDetails": { "$ref": "#/definitions/OutgoingEmailDetailsModel" }, "Jurisdiction": { "$ref": "#/definitions/JurisdictionModel" }, "CreatorUserID": { "format": "int32", "type": "integer" }, "ExpirationDate": { "format": "date-time", "type": "string" }, "Description": { "type": "string" }, "CreatedDate": { "format": "date-time", "type": "string" }, "ClosedDate": { "format": "date-time", "type": "string" }, "FilesDeletedDate": { "format": "date-time", "type": "string" }, "EmailTemplateSetName": { "type": "string" }, "SessionExpirationMinutes": { "format": "int32", "type": "integer" }, "Documents": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/DocumentDetailsModel" } ], "xml": { "name": "Document" } }, "xml": { "name": "Documents", "wrapped": true } }, "Participants": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/ParticipantDetailsModel" } ], "xml": { "name": "Participant" } }, "xml": { "name": "Participants", "wrapped": true } }, "WorkflowActions": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/TransactionWorkflowActionModel" } ], "xml": { "name": "WorkflowAction" } }, "xml": { "name": "WorkflowActions", "wrapped": true } }, "MetaData": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/MetaDataModel" } ], "xml": { "name": "MetaDat" } }, "xml": { "name": "MetaData", "wrapped": true } }, "SendCompletedNotification": { "type": "boolean" }, "SendCancelledNotification": { "type": "boolean" }, "SendExpiredNotification": { "type": "boolean" }, "EnableMessagePromptOnCancel": { "type": "boolean" }, "Status": { "enum": [ "All", "Validating", "Pending", "TheRealPending", "Completed", "EmailSent", "Closed", "Cancelled", "Expired", "Voided" ], "type": "string" }, "AccountName": { "type": "string" }, "ThirdPartyNotifications": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/TransactionNotificationDetailsModel" } ], "xml": { "name": "ThirdPartyNotification" } }, "xml": { "name": "ThirdPartyNotifications", "wrapped": true } }, "EnforceAddDigitalSignaturesForAllPDFDocumentsType": { "enum": [ "None", "Certification", "Seal" ], "type": "string" }, "IncludeUploadedAttachmentsInThirdPartyNotifications": { "type": "boolean" }, "TimeZone": { "type": "string" }, "VoidedDate": { "format": "date-time", "type": "string" }, "EmailTemplateSetLanguage": { "type": "string" }, "IsAccountAdminLockedOut": { "type": "boolean" }, "TimeZoneID": { "type": "string" }, "CleanupDate": { "format": "date-time", "type": "string" }, "IsAdminLockedOut": { "type": "boolean" }, "AuthChallengeQuestionsBadLoginLimit": { "format": "int32", "type": "integer" }, "AuthOneTimePasscodeBadLoginLimit": { "format": "int32", "type": "integer" }, "OneTimePasscodeTimeoutInSeconds": { "format": "int32", "type": "integer" }, "IsAuthenticationOnly": { "type": "boolean" } }, "xml": { "name": "TransactionDetailsModel" } }, "TransactionWorkflowActionModel": { "type": "object", "properties": { "Data": { "type": "string" }, "Url": { "maxLength": 512, "minLength": 0, "type": "string" }, "Description": { "maxLength": 128, "minLength": 0, "type": "string" }, "Type": { "enum": [ "SubscribeToStatusChangeNotificationsByPost", "SubscribeToStatusChangeNotificationsByGet" ], "type": "string" }, "ActionStatus": { "format": "int32", "type": "integer" }, "PhoneNumber": { "maxLength": 64, "minLength": 0, "type": "string" }, "EmailAddress": { "maxLength": 128, "minLength": 0, "type": "string" }, "StartedDate": { "format": "date-time", "type": "string" }, "NextRetryDate": { "format": "date-time", "type": "string" }, "RetryLimitDate": { "format": "date-time", "type": "string" }, "CompletedDate": { "format": "date-time", "type": "string" }, "CustomHeaders": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/CustomHeaderModel" } ], "xml": { "name": "CustomHeader" } }, "xml": { "name": "CustomHeaders", "wrapped": true } } }, "xml": { "name": "TransactionWorkflowActionModel" } }, "TransactionCloseRequestModel": { "required": [ "IDs" ], "type": "object", "properties": { "IDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "IDs", "wrapped": true } }, "EnableLogging": { "type": "boolean" } }, "xml": { "name": "TransactionCloseRequestModel" } }, "TransactionCreateRequestModel": { "required": [ "Transactions" ], "type": "object", "properties": { "Transactions": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/TransactionCreateModel" } ], "xml": { "name": "Transaction" } }, "xml": { "name": "Transactions", "wrapped": true } }, "ResponseIncludes": { "$ref": "#/definitions/TransactionIncludesModel" }, "EnableLogging": { "type": "boolean" }, "TimeZoneID": { "type": "string" } }, "xml": { "name": "TransactionCreateRequestModel" } }, "TransactionCreateModel": { "required": [ "ProntoID", "Description", "Participants" ], "type": "object", "properties": { "ProntoID": { "type": "string" }, "IsTest": { "type": "boolean" }, "Description": { "maxLength": 256, "minLength": 0, "type": "string" }, "IsParticipantOrderNonSequential": { "type": "boolean" }, "DisableCompleteNotificationAttachments": { "type": "boolean" }, "CompleteNotificationEmailAddresses": { "type": "array", "items": { "type": "string", "allOf": [ {} ], "xml": { "name": "string" } }, "xml": { "name": "CompleteNotificationEmailAddresses", "wrapped": true } }, "OutgoingEmailDetails": { "$ref": "#/definitions/OutgoingEmailDetailsModel" }, "Jurisdiction": { "$ref": "#/definitions/JurisdictionModel" }, "CreatorUserID": { "format": "int32", "type": "integer" }, "ExpirationDate": { "format": "date-time", "type": "string" }, "EmailTemplateSetName": { "type": "string" }, "SessionExpirationMinutes": { "format": "int32", "type": "integer" }, "Documents": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/DocumentInsertModel" } ], "xml": { "name": "Document" } }, "xml": { "name": "Documents", "wrapped": true } }, "Participants": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/ParticipantInsertModel" } ], "xml": { "name": "Participant" } }, "xml": { "name": "Participants", "wrapped": true } }, "WorkflowActions": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/TransactionWorkflowActionModel" } ], "xml": { "name": "WorkflowAction" } }, "xml": { "name": "WorkflowActions", "wrapped": true } }, "MetaData": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/MetaDataModel" } ], "xml": { "name": "MetaDat" } }, "xml": { "name": "MetaData", "wrapped": true } }, "SendCompletedNotification": { "type": "boolean" }, "SendCancelledNotification": { "type": "boolean" }, "SendExpiredNotification": { "type": "boolean" }, "EnableMessagePromptOnCancel": { "type": "boolean" }, "ThirdPartyNotifications": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/TransactionNotificationDetailsModel" } ], "xml": { "name": "ThirdPartyNotification" } }, "xml": { "name": "ThirdPartyNotifications", "wrapped": true } }, "EnforceAddDigitalSignaturesForAllPDFDocumentsType": { "enum": [ "None", "Certification", "Seal" ], "type": "string" }, "IncludeUploadedAttachmentsInThirdPartyNotifications": { "type": "boolean" }, "EmailTemplateSetLanguage": { "type": "string" }, "TimeZoneID": { "type": "string" }, "AuthChallengeQuestionsBadLoginLimit": { "format": "int32", "maximum": 2147483647, "minimum": 1, "type": "integer" }, "AuthOneTimePasscodeBadLoginLimit": { "format": "int32", "maximum": 2147483647, "minimum": 1, "type": "integer" }, "OneTimePasscodeTimeoutInSeconds": { "format": "int32", "maximum": 2147483647, "minimum": 1, "type": "integer" }, "IsAuthenticationOnly": { "type": "boolean" } }, "xml": { "name": "TransactionCreateModel" } }, "TransactionEventsRequestModel": { "type": "object", "properties": { "ProntoID": { "type": "string" }, "IDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "IDs", "wrapped": true } }, "DocumentIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "DocumentIDs", "wrapped": true } }, "ParticipantIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "ParticipantIDs", "wrapped": true } }, "TaskIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "TaskIDs", "wrapped": true } }, "MetaDataName": { "type": "string" }, "MetaDataValue": { "type": "string" }, "StatusType": { "enum": [ "All", "Validating", "Pending", "TheRealPending", "Completed", "EmailSent", "Closed", "Cancelled", "Expired", "Voided" ], "type": "string" }, "SearchDateType": { "enum": [ "CreatedDate", "ClosedDate" ], "type": "string" }, "SearchDateFrom": { "format": "date-time", "type": "string" }, "SearchDateTo": { "format": "date-time", "type": "string" }, "ResultsCountLimit": { "format": "int32", "type": "integer" }, "ResultsCountStart": { "format": "int32", "type": "integer" }, "SearchText": { "type": "string" }, "EnableLogging": { "type": "boolean" }, "CreatorUserID": { "format": "int32", "type": "integer" }, "TimeZoneID": { "type": "string" }, "SearchEntityType": { "enum": [ "Everything", "Transactions", "Documents", "Participants", "Tasks" ], "type": "string" } }, "xml": { "name": "TransactionEventsRequestModel" } }, "TransactionEventsServiceReturnModel": { "type": "object", "properties": { "IsSuccessful": { "type": "boolean" }, "Message": { "type": "string" }, "TransactionEvents": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/TransactionEventDetailsModel" } ], "xml": { "name": "TransactionEvent" } }, "xml": { "name": "TransactionEvents", "wrapped": true } }, "ProcessingTime": { "type": "string" }, "TimeZoneUtcOffset": { "format": "double", "type": "number" } }, "xml": { "name": "TransactionEventsServiceReturnModel" } }, "TransactionEventDetailsModel": { "type": "object", "properties": { "EventDetails": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/EventDetailsModel" } ], "xml": { "name": "EventDetail" } }, "xml": { "name": "EventDetails", "wrapped": true } } }, "xml": { "name": "TransactionEventDetailsModel" } }, "EventDetailsModel": { "type": "object", "properties": { "ID": { "format": "int32", "type": "integer" }, "TransactionID": { "format": "int32", "type": "integer" }, "ParticipantID": { "format": "int32", "type": "integer" }, "DocumentID": { "format": "int32", "type": "integer" }, "TaskID": { "format": "int32", "type": "integer" }, "Type": { "enum": [ "Sign", "Api", "Cp", "Automated" ], "type": "string" }, "Description": { "type": "string" }, "CreatedDate": { "format": "date-time", "type": "string" } }, "xml": { "name": "EventDetailsModel" } }, "TransactionEvidencePackageRequestModel": { "type": "object", "properties": { "ProntoID": { "type": "string" }, "IDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "IDs", "wrapped": true } }, "DocumentIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "DocumentIDs", "wrapped": true } }, "ParticipantIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "ParticipantIDs", "wrapped": true } }, "TaskIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "TaskIDs", "wrapped": true } }, "MetaDataName": { "type": "string" }, "MetaDataValue": { "type": "string" }, "StatusType": { "enum": [ "All", "Validating", "Pending", "TheRealPending", "Completed", "EmailSent", "Closed", "Cancelled", "Expired", "Voided" ], "type": "string" }, "SearchDateType": { "enum": [ "CreatedDate", "ClosedDate" ], "type": "string" }, "SearchDateFrom": { "format": "date-time", "type": "string" }, "SearchDateTo": { "format": "date-time", "type": "string" }, "ResultsCountLimit": { "format": "int32", "type": "integer" }, "ResultsCountStart": { "format": "int32", "type": "integer" }, "SearchText": { "type": "string" }, "Includes": { "$ref": "#/definitions/EvidencePackageIncludesModel" }, "EnableLogging": { "type": "boolean" }, "CreatorUserID": { "format": "int32", "type": "integer" }, "TimeZoneID": { "type": "string" }, "SearchEntityType": { "enum": [ "Everything", "Transactions", "Documents", "Participants", "Tasks" ], "type": "string" } }, "xml": { "name": "TransactionEvidencePackageRequestModel" } }, "EvidencePackageIncludesModel": { "type": "object", "properties": { "IncludeAuditReport": { "type": "boolean" }, "IncludeDocuments": { "type": "boolean" }, "IncludeTransactionEventHistory": { "type": "boolean" } }, "xml": { "name": "EvidencePackageIncludesModel" } }, "TransactionEvidencePackageServiceReturnModel": { "type": "object", "properties": { "IsSuccessful": { "type": "boolean" }, "Message": { "type": "string" }, "EvidencePackages": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/TransactionEvidencePackageModel" } ], "xml": { "name": "EvidencePackage" } }, "xml": { "name": "EvidencePackages", "wrapped": true } }, "ProcessingTime": { "type": "string" }, "TimeZoneUtcOffset": { "format": "double", "type": "number" } }, "xml": { "name": "TransactionEvidencePackageServiceReturnModel" } }, "TransactionEvidencePackageModel": { "type": "object", "properties": { "TransactionEvidencePackageDetails": { "$ref": "#/definitions/TransactionEvidencePackageDetailsModel" }, "DocumentsPackage": { "$ref": "#/definitions/DocumentFileModel" }, "TransactionEvents": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/EventDetailsModel" } ], "xml": { "name": "TransactionEvent" } }, "xml": { "name": "TransactionEvents", "wrapped": true } } }, "xml": { "name": "TransactionEvidencePackageModel" } }, "TransactionEvidencePackageDetailsModel": { "type": "object", "properties": { "ID": { "format": "int32", "type": "integer" }, "ProntoID": { "type": "string" }, "GroupName": { "type": "string" }, "Status": { "enum": [ "All", "Validating", "Pending", "TheRealPending", "Completed", "EmailSent", "Closed", "Cancelled", "Expired", "Voided" ], "type": "string" }, "CreatedDate": { "format": "date-time", "type": "string" }, "ClosedDate": { "format": "date-time", "type": "string" }, "ExpirationDate": { "format": "date-time", "type": "string" }, "IsTest": { "type": "boolean" }, "TransactionEvidencePackageDocumentDetails": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/TransactionEvidencePackageDocumentDetailsModel" } ], "xml": { "name": "TransactionEvidencePackageDocumentDetail" } }, "xml": { "name": "TransactionEvidencePackageDocumentDetails", "wrapped": true } } }, "xml": { "name": "TransactionEvidencePackageDetailsModel" } }, "TransactionEvidencePackageDocumentDetailsModel": { "type": "object", "properties": { "DocumentID": { "format": "int32", "type": "integer" }, "Title": { "type": "string" }, "Type": { "type": "string" }, "Status": { "enum": [ "All", "Validating", "Pending", "TheRealPending", "Completed", "EmailSent", "Closed", "Cancelled", "Expired", "Voided" ], "type": "string" }, "CreatedDate": { "format": "date-time", "type": "string" }, "DocumentVersionDetails": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/DocumentVersionDetailModel" } ], "xml": { "name": "DocumentVersionDetail" } }, "xml": { "name": "DocumentVersionDetails", "wrapped": true } } }, "xml": { "name": "TransactionEvidencePackageDocumentDetailsModel" } }, "DocumentVersionDetailModel": { "type": "object", "properties": { "ID": { "format": "int32", "type": "integer" }, "DocumentID": { "format": "int32", "type": "integer" }, "Version": { "format": "int32", "type": "integer" }, "FileName": { "type": "string" }, "CreateDate": { "format": "date-time", "type": "string" }, "SealedDate": { "format": "date-time", "type": "string" }, "CertifiedDate": { "format": "date-time", "type": "string" }, "IsSealPending": { "type": "boolean" }, "IsCertifyPending": { "type": "boolean" }, "DocumentSHA256Hash": { "type": "string" }, "VersionInfo": { "type": "string" }, "IsFinal": { "type": "boolean" } }, "xml": { "name": "DocumentVersionDetailModel" } }, "TransactionUpdateableRequestModel": { "type": "object", "properties": { "ProntoID": { "type": "string" }, "IDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "IDs", "wrapped": true } }, "DocumentIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "DocumentIDs", "wrapped": true } }, "ParticipantIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "ParticipantIDs", "wrapped": true } }, "TaskIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "TaskIDs", "wrapped": true } }, "MetaDataName": { "type": "string" }, "MetaDataValue": { "type": "string" }, "StatusType": { "enum": [ "All", "Validating", "Pending", "TheRealPending", "Completed", "EmailSent", "Closed", "Cancelled", "Expired", "Voided" ], "type": "string" }, "SearchDateType": { "enum": [ "CreatedDate", "ClosedDate" ], "type": "string" }, "SearchDateFrom": { "format": "date-time", "type": "string" }, "SearchDateTo": { "format": "date-time", "type": "string" }, "EnableLogging": { "type": "boolean" }, "ResultsCountLimit": { "format": "int32", "type": "integer" }, "ResultsCountStart": { "format": "int32", "type": "integer" }, "IncludeTests": { "type": "boolean" }, "SearchText": { "type": "string" }, "CreatorUserID": { "format": "int32", "type": "integer" }, "TimeZoneID": { "type": "string" }, "SearchEntityType": { "enum": [ "Everything", "Transactions", "Documents", "Participants", "Tasks" ], "type": "string" } }, "xml": { "name": "TransactionUpdateableRequestModel" } }, "TransactionUpdateableServiceReturnModel": { "type": "object", "properties": { "IsSuccessful": { "type": "boolean" }, "Message": { "type": "string" }, "UpdateableTransactions": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/TransactionUpdateModel" } ], "xml": { "name": "UpdateableTransaction" } }, "xml": { "name": "UpdateableTransactions", "wrapped": true } }, "ProcessingTime": { "type": "string" }, "TimeZoneUtcOffset": { "format": "double", "type": "number" } }, "xml": { "name": "TransactionUpdateableServiceReturnModel" } }, "UserUpdateRequestModel": { "required": [ "Users" ], "type": "object", "properties": { "Users": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/UserUpdateModel" } ], "xml": { "name": "User" } }, "xml": { "name": "Users", "wrapped": true } }, "EnableLogging": { "type": "boolean" } }, "xml": { "name": "UserUpdateRequestModel" } }, "UserUpdateModel": { "required": [ "ID", "ProntoID", "Username", "SigningAuthorityType", "FirstName", "LastName", "EmailAddress", "SecurityQuestion", "SecurityAnswer", "ControlPanelAuthorityType" ], "type": "object", "properties": { "ID": { "format": "int32", "type": "integer" }, "ProntoID": { "maxLength": 64, "minLength": 0, "type": "string" }, "Username": { "maxLength": 63, "minLength": 0, "type": "string" }, "SigningAuthorityType": { "enum": [ "DirectlyAssignedInThisGroupOnly", "DirectlyAssignedInAllGroups", "ThisGroupOnly", "AllGroups", "SystemWide", "NotAllowed" ], "type": "string" }, "FirstName": { "maxLength": 16, "minLength": 0, "type": "string" }, "LastName": { "maxLength": 30, "minLength": 0, "type": "string" }, "EmailAddress": { "maxLength": 128, "minLength": 0, "pattern": "^(?![.])([^@,;<>\\^]+@[^\\s@<>,;\\^]+\\.[^\\s@<>,;\\^]+)$", "type": "string" }, "SecurityQuestion": { "maxLength": 256, "minLength": 0, "type": "string" }, "SecurityAnswer": { "maxLength": 256, "minLength": 0, "type": "string" }, "Title": { "maxLength": 64, "minLength": 0, "type": "string" }, "Organization": { "maxLength": 128, "minLength": 0, "type": "string" }, "SignatureImage": { "format": "byte", "type": "string" }, "ControlPanelAuthorityType": { "enum": [ "SigningOnly", "GroupUser", "AccountWideUser", "GroupManager", "AccountWideManager", "GroupAdmin", "AccountWideAdmin", "SystemWideAdmin", "ApiOnly", "SystemWideApi" ], "type": "string" }, "ViewUnassignedRegUserTransactions": { "type": "boolean" }, "FederatedUsername": { "maxLength": 150, "minLength": 0, "type": "string" }, "RequirePasswordChangeOnFirstUse": { "type": "boolean" }, "Password": { "maxLength": 128, "minLength": 0, "type": "string" }, "IsLockedOut": { "type": "boolean" }, "IsExpired": { "type": "boolean" }, "PasswordChangeInDays": { "format": "int32", "type": "integer" }, "Permissions": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/UserPermissionUpdateModel" } ], "xml": { "name": "Permission" } }, "xml": { "name": "Permissions", "wrapped": true } }, "Federations": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/UserFederationInsertModel" } ], "xml": { "name": "Federation" } }, "xml": { "name": "Federations", "wrapped": true } } }, "xml": { "name": "UserUpdateModel" } }, "UserPermissionUpdateModel": { "required": [ "ProntoID", "PermissionSetID" ], "type": "object", "properties": { "ProntoID": { "maxLength": 64, "minLength": 0, "type": "string" }, "PermissionSetID": { "format": "int32", "type": "integer" }, "AllowOpenSigning": { "type": "boolean" }, "AllowOpenSigningQueue": { "type": "boolean" } }, "xml": { "name": "UserPermissionUpdateModel" } }, "UserFederationInsertModel": { "required": [ "UserName", "ThirdPartyCredentialID" ], "type": "object", "properties": { "UserName": { "maxLength": 64, "minLength": 0, "type": "string" }, "ThirdPartyCredentialID": { "format": "int32", "type": "integer" } }, "xml": { "name": "UserFederationInsertModel" } }, "UserDetailsRequestModel": { "type": "object", "properties": { "ProntoIDs": { "type": "array", "items": { "type": "string", "allOf": [ {} ], "xml": { "name": "string" } }, "xml": { "name": "ProntoIDs", "wrapped": true } }, "IDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "IDs", "wrapped": true } }, "Usernames": { "type": "array", "items": { "type": "string", "allOf": [ {} ], "xml": { "name": "string" } }, "xml": { "name": "Usernames", "wrapped": true } }, "EmailAddresses": { "type": "array", "items": { "type": "string", "allOf": [ {} ], "xml": { "name": "string" } }, "xml": { "name": "EmailAddresses", "wrapped": true } }, "IsLockedOut": { "type": "boolean" }, "IsExpired": { "type": "boolean" }, "SigningAuthorityType": { "enum": [ "DirectlyAssignedInThisGroupOnly", "DirectlyAssignedInAllGroups", "ThisGroupOnly", "AllGroups", "SystemWide", "NotAllowed" ], "type": "string" }, "ControlPanelAuthorityType": { "enum": [ "SigningOnly", "GroupUser", "AccountWideUser", "GroupManager", "AccountWideManager", "GroupAdmin", "AccountWideAdmin", "SystemWideAdmin", "ApiOnly", "SystemWideApi" ], "type": "string" }, "EnableLogging": { "type": "boolean" }, "ResultsCountLimit": { "format": "int32", "type": "integer" }, "ResultsCountStart": { "format": "int32", "type": "integer" }, "FederationUsernames": { "type": "array", "items": { "type": "string", "allOf": [ {} ], "xml": { "name": "string" } }, "xml": { "name": "FederationUsernames", "wrapped": true } } }, "xml": { "name": "UserDetailsRequestModel" } }, "UserDetailsServiceReturnModel": { "type": "object", "properties": { "IsSuccessful": { "type": "boolean" }, "Message": { "type": "string" }, "Users": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/UserDetailsModel" } ], "xml": { "name": "User" } }, "xml": { "name": "Users", "wrapped": true } }, "ProcessingTime": { "type": "string" }, "TimeZoneUtcOffset": { "format": "double", "type": "number" } }, "xml": { "name": "UserDetailsServiceReturnModel" } }, "UserDetailsModel": { "type": "object", "properties": { "ID": { "format": "int32", "type": "integer" }, "ProntoID": { "type": "string" }, "Username": { "type": "string" }, "SigningAuthorityType": { "enum": [ "DirectlyAssignedInThisGroupOnly", "DirectlyAssignedInAllGroups", "ThisGroupOnly", "AllGroups", "SystemWide", "NotAllowed" ], "type": "string" }, "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "EmailAddress": { "type": "string" }, "SecurityQuestion": { "type": "string" }, "SecurityAnswer": { "type": "string" }, "Title": { "type": "string" }, "Organization": { "type": "string" }, "SignatureImage": { "format": "byte", "type": "string" }, "ControlPanelAuthorityType": { "enum": [ "SigningOnly", "GroupUser", "AccountWideUser", "GroupManager", "AccountWideManager", "GroupAdmin", "AccountWideAdmin", "SystemWideAdmin", "ApiOnly", "SystemWideApi" ], "type": "string" }, "ViewUnassignedRegUserTransactions": { "type": "boolean" }, "FederatedUsername": { "type": "string" }, "RequirePasswordChangeOnFirstUse": { "type": "boolean" }, "CreatedDate": { "format": "date-time", "type": "string" }, "LastModifiedDate": { "format": "date-time", "type": "string" }, "AccessCount": { "format": "int32", "type": "integer" }, "IsLockedOut": { "type": "boolean" }, "IsExpired": { "type": "boolean" }, "PasswordChangeInDays": { "format": "int32", "type": "integer" }, "Initials": { "type": "string" }, "Permissions": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/PermissionDetailsModel" } ], "xml": { "name": "Permission" } }, "xml": { "name": "Permissions", "wrapped": true } }, "IsSystemAdmin": { "type": "boolean" }, "LastLoginDate": { "format": "date-time", "type": "string" }, "IsAccountAdmin": { "type": "boolean" }, "MasterID": { "type": "string" }, "AllowInstallationTestsAccess": { "type": "boolean" }, "MobileNumber": { "type": "string" }, "DateFormat": { "type": "string" }, "TimeZone": { "type": "string" }, "ThirdPartyCredentialIDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "ThirdPartyCredentialIDs", "wrapped": true } } }, "xml": { "name": "UserDetailsModel" } }, "PermissionDetailsModel": { "type": "object", "properties": { "Name": { "type": "string" }, "ProntoID": { "type": "string" }, "AllowGroup": { "type": "boolean" }, "AllowChildGroup": { "type": "boolean" }, "AllowUser": { "type": "boolean" }, "AllowReportsView": { "type": "boolean" }, "AllowProcessLaunch": { "type": "boolean" }, "AllowWorkflow": { "type": "boolean" }, "AllowWebForm": { "type": "boolean" }, "AllowDocumentTemplate": { "type": "boolean" }, "AllowEmailTemplate": { "type": "boolean" }, "AllowContent": { "type": "boolean" }, "AllowBrands": { "type": "boolean" }, "AllowTheme": { "type": "boolean" }, "AllowAction": { "type": "boolean" }, "AllowApi": { "type": "boolean" }, "AllowPermission": { "type": "boolean" }, "AllowPermissionSet": { "type": "boolean" }, "AllowLogo": { "type": "boolean" }, "AllowDev": { "type": "boolean" }, "AllowSystemWideAdmin": { "type": "boolean" }, "AllowThirdPartyCredentialAdmin": { "type": "boolean" }, "AllowOpenSigning": { "type": "boolean" }, "AllowOpenSigningQueue": { "type": "boolean" }, "AllowReportsGroupTransactions": { "type": "boolean" }, "AllowReportsDocuments": { "type": "boolean" } }, "xml": { "name": "PermissionDetailsModel" } }, "UserDeleteRequestModel": { "required": [ "Users" ], "type": "object", "properties": { "Users": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/UserDeleteModel" } ], "xml": { "name": "User" } }, "xml": { "name": "Users", "wrapped": true } }, "EnableLogging": { "type": "boolean" } }, "xml": { "name": "UserDeleteRequestModel" } }, "UserDeleteModel": { "type": "object", "properties": { "ID": { "format": "int32", "type": "integer" }, "Username": { "type": "string" } }, "xml": { "name": "UserDeleteModel" } }, "UserInsertRequestModel": { "required": [ "Users" ], "type": "object", "properties": { "Users": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/UserInsertModel" } ], "xml": { "name": "User" } }, "xml": { "name": "Users", "wrapped": true } }, "EnableLogging": { "type": "boolean" } }, "xml": { "name": "UserInsertRequestModel" } }, "UserInsertModel": { "required": [ "ProntoID", "Username", "FirstName", "LastName", "EmailAddress", "Password" ], "type": "object", "properties": { "ProntoID": { "maxLength": 64, "minLength": 0, "type": "string" }, "Username": { "maxLength": 63, "minLength": 0, "type": "string" }, "FirstName": { "maxLength": 16, "minLength": 0, "type": "string" }, "LastName": { "maxLength": 30, "minLength": 0, "type": "string" }, "EmailAddress": { "maxLength": 128, "minLength": 0, "pattern": "^(?![.])([^@,;<>\\^]+@[^\\s@<>,;\\^]+\\.[^\\s@<>,;\\^]+)$", "type": "string" }, "SecurityQuestion": { "maxLength": 256, "minLength": 0, "type": "string" }, "SecurityAnswer": { "maxLength": 256, "minLength": 0, "type": "string" }, "Title": { "maxLength": 64, "minLength": 0, "type": "string" }, "Organization": { "maxLength": 128, "minLength": 0, "type": "string" }, "SignatureImage": { "format": "byte", "type": "string" }, "RequirePasswordChangeOnFirstUse": { "type": "boolean" }, "Password": { "maxLength": 128, "minLength": 0, "type": "string" }, "IsLockedOut": { "type": "boolean" }, "IsExpired": { "type": "boolean" }, "PasswordChangeInDays": { "format": "int32", "type": "integer" }, "Permissions": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/UserPermissionInsertModel" } ], "xml": { "name": "Permission" } }, "xml": { "name": "Permissions", "wrapped": true } }, "MiddleName": { "maxLength": 16, "minLength": 0, "type": "string" }, "Suffix": { "type": "string" }, "Federations": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/UserFederationInsertModel" } ], "xml": { "name": "Federation" } }, "xml": { "name": "Federations", "wrapped": true } } }, "xml": { "name": "UserInsertModel" } }, "UserPermissionInsertModel": { "required": [ "ProntoID", "PermissionSetID" ], "type": "object", "properties": { "ProntoID": { "maxLength": 64, "minLength": 0, "type": "string" }, "PermissionSetID": { "format": "int32", "type": "integer" }, "AllowOpenSigning": { "type": "boolean" }, "AllowOpenSigningQueue": { "type": "boolean" } }, "xml": { "name": "UserPermissionInsertModel" } }, "UserUpdateableRequestModel": { "type": "object", "properties": { "ProntoIDs": { "type": "array", "items": { "type": "string", "allOf": [ {} ], "xml": { "name": "string" } }, "xml": { "name": "ProntoIDs", "wrapped": true } }, "IDs": { "type": "array", "items": { "type": "integer", "allOf": [ {} ], "xml": { "name": "int" } }, "xml": { "name": "IDs", "wrapped": true } }, "Usernames": { "type": "array", "items": { "type": "string", "allOf": [ {} ], "xml": { "name": "string" } }, "xml": { "name": "Usernames", "wrapped": true } }, "EmailAddresses": { "type": "array", "items": { "type": "string", "allOf": [ {} ], "xml": { "name": "string" } }, "xml": { "name": "EmailAddresses", "wrapped": true } }, "IsLockedOut": { "type": "boolean" }, "IsExpired": { "type": "boolean" }, "SigningAuthorityType": { "enum": [ "DirectlyAssignedInThisGroupOnly", "DirectlyAssignedInAllGroups", "ThisGroupOnly", "AllGroups", "SystemWide", "NotAllowed" ], "type": "string" }, "ControlPanelAuthorityType": { "enum": [ "SigningOnly", "GroupUser", "AccountWideUser", "GroupManager", "AccountWideManager", "GroupAdmin", "AccountWideAdmin", "SystemWideAdmin", "ApiOnly", "SystemWideApi" ], "type": "string" }, "EnableLogging": { "type": "boolean" }, "ResultsCountLimit": { "format": "int32", "type": "integer" }, "ResultsCountStart": { "format": "int32", "type": "integer" } }, "xml": { "name": "UserUpdateableRequestModel" } }, "UserUpdateableServiceReturnModel": { "type": "object", "properties": { "IsSuccessful": { "type": "boolean" }, "Message": { "type": "string" }, "UpdateableUsers": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/UserUpdateModel" } ], "xml": { "name": "UpdateableUser" } }, "xml": { "name": "UpdateableUsers", "wrapped": true } }, "ProcessingTime": { "type": "string" }, "TimeZoneUtcOffset": { "format": "double", "type": "number" } }, "xml": { "name": "UserUpdateableServiceReturnModel" } }, "WorkflowRequestModel": { "type": "object", "properties": { "Workflows": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/WorkflowIdModel" } ], "xml": { "name": "Workflow" } }, "xml": { "name": "Workflows", "wrapped": true } }, "EnableLogging": { "type": "boolean" } }, "xml": { "name": "WorkflowRequestModel" } }, "WorkflowIdModel": { "type": "object", "properties": { "ID": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "DocumentUploads": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/WorkflowDocumentModel" } ], "xml": { "name": "DocumentUpload" } }, "xml": { "name": "DocumentUploads", "wrapped": true } } }, "xml": { "name": "WorkflowIdModel" } }, "WorkflowDocumentModel": { "type": "object", "properties": { "ID": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "FileBytes": { "format": "byte", "type": "string" } }, "xml": { "name": "WorkflowDocumentModel" } }, "WorkflowTransactionServiceReturnModel": { "type": "object", "properties": { "IsSuccessful": { "type": "boolean" }, "Message": { "type": "string" }, "Transactions": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/TransactionCreateModel" } ], "xml": { "name": "Transaction" } }, "xml": { "name": "Transactions", "wrapped": true } }, "ProcessingTime": { "type": "string" }, "TimeZoneUtcOffset": { "format": "double", "type": "number" } }, "xml": { "name": "WorkflowTransactionServiceReturnModel" } }, "WorkflowListRequestModel": { "required": [ "ProntoID" ], "type": "object", "properties": { "UserID": { "format": "int32", "type": "integer" }, "ProntoID": { "type": "string" }, "Name": { "type": "string" }, "IsPublicLaunch": { "type": "boolean" }, "IsPrivate": { "type": "boolean" }, "IsGroupShared": { "type": "boolean" }, "IsSubGroupShared": { "type": "boolean" }, "EnableLogging": { "type": "boolean" } }, "xml": { "name": "WorkflowListRequestModel" } }, "WorkflowListServiceReturnModel": { "type": "object", "properties": { "IsSuccessful": { "type": "boolean" }, "Message": { "type": "string" }, "Workflows": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/WorkflowListDetailsModel" } ], "xml": { "name": "Workflow" } }, "xml": { "name": "Workflows", "wrapped": true } }, "ProcessingTime": { "type": "string" }, "TimeZoneUtcOffset": { "format": "double", "type": "number" } }, "xml": { "name": "WorkflowListServiceReturnModel" } }, "WorkflowListDetailsModel": { "type": "object", "properties": { "ID": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "ProntoID": { "type": "string" }, "Name": { "type": "string" }, "CreatedBy": { "type": "string" }, "CreatedDate": { "format": "date-time", "type": "string" }, "LastModifiedDate": { "format": "date-time", "type": "string" }, "IsPublicLaunch": { "type": "boolean" }, "IsPrivate": { "type": "boolean" }, "IsGroupShared": { "type": "boolean" }, "IsSubGroupShared": { "type": "boolean" } }, "xml": { "name": "WorkflowListDetailsModel" } }, "WorkflowLaunchRulesRequestModel": { "type": "object", "properties": { "ID": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "EnableLogging": { "type": "boolean" } }, "xml": { "name": "WorkflowLaunchRulesRequestModel" } }, "WorkflowLaunchRulesServiceReturnModel": { "type": "object", "properties": { "IsSuccessful": { "type": "boolean" }, "Message": { "type": "string" }, "Workflow": { "$ref": "#/definitions/WorkflowLaunchDetailsModel" }, "ProcessingTime": { "type": "string" }, "TimeZoneUtcOffset": { "format": "double", "type": "number" } }, "xml": { "name": "WorkflowLaunchRulesServiceReturnModel" } }, "WorkflowLaunchDetailsModel": { "type": "object", "properties": { "ID": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "ProntoID": { "type": "string" }, "Name": { "type": "string" }, "CreatedBy": { "type": "string" }, "CreateDate": { "format": "date-time", "type": "string" }, "LastModifiedDate": { "format": "date-time", "type": "string" }, "IsPrivate": { "type": "boolean" }, "IsGroupShared": { "type": "boolean" }, "IsSubGroupShared": { "type": "boolean" }, "IsPublic": { "type": "boolean" }, "Participants": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/ParticipantLaunchDetails" } ], "xml": { "name": "Participant" } }, "xml": { "name": "Participants", "wrapped": true } }, "Documents": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/DocumentLaunchDetails" } ], "xml": { "name": "Document" } }, "xml": { "name": "Documents", "wrapped": true } }, "LaunchHeading": { "type": "string" }, "LaunchInstructions": { "type": "string" }, "LaunchSubmitButtonText": { "type": "string" } }, "xml": { "name": "WorkflowLaunchDetailsModel" } }, "ParticipantLaunchDetails": { "type": "object", "properties": { "ID": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Role": { "type": "string" }, "FullName": { "type": "string" }, "EmailAddress": { "type": "string" }, "PhoneNumber": { "type": "string" }, "Title": { "type": "string" }, "Organization": { "type": "string" }, "IsLaunchOptional": { "type": "boolean" }, "FullNameLabelText": { "type": "string" }, "EmailAddressLabelText": { "type": "string" }, "TitleLabelText": { "type": "string" }, "OrganizationLabelText": { "type": "string" } }, "xml": { "name": "ParticipantLaunchDetails" } }, "DocumentLaunchDetails": { "type": "object", "properties": { "ID": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Title": { "type": "string" }, "IsLaunchOptional": { "type": "boolean" }, "UploadRequiredAtLaunch": { "type": "boolean" }, "Tasks": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/definitions/TaskLaunchDetails" } ], "xml": { "name": "Task" } }, "xml": { "name": "Tasks", "wrapped": true } } }, "xml": { "name": "DocumentLaunchDetails" } }, "TaskLaunchDetails": { "type": "object", "properties": { "ID": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Label": { "type": "string" }, "IsOptional": { "type": "boolean" } }, "xml": { "name": "TaskLaunchDetails" } } } }