{ "openapi": "3.0.1", "info": { "title": "Doctavian", "version": "1.0", "description": "Combined Doctavian OpenAPI specification." }, "servers": [ { "url": "https://apim-mavenheadless-dev-westeu-1.azure-api.net" } ], "security": [ { "apiKeyHeader": [] }, { "apiKeyQuery": [] } ], "tags": [ { "name": "Document" }, { "name": "Template" }, { "name": "Data" }, { "name": "Data Source" }, { "name": "Document Request" }, { "name": "Document Solution Configuration" }, { "name": "Document Solution" }, { "name": "Option Value" }, { "name": "Envelope" }, { "name": "AuditTrail" }, { "name": "User" }, { "name": "Signature" }, { "name": "Content" }, { "name": "Attachment" }, { "name": "MFA" }, { "name": "Comment" }, { "name": "Folder" }, { "name": "Term Definitions" }, { "name": "Consents" }, { "name": "Locale" }, { "name": "Session" }, { "name": "Status" }, { "name": "Token" }, { "name": "Service" }, { "name": "Settings" }, { "name": "Callback" }, { "name": "Auth" }, { "name": "Reply" }, { "name": "Subscription" } ], "paths": { "/documents/document/manage": { "post": { "tags": [ "Document" ], "summary": "Document Manage", "description": "This endpoint performs external file operations on existing documents, such as copying, moving, deleting (currently only supports OneDrive), or converting documents, without modifying their internal content. It allows you to manage how and where documents are stored across supported platforms like Storage, Salesforce, and OneDrive.

\n**Copy**: If both source and target are provided in the payload, the document is duplicated from the source location to the target location. Requires the same fileFormat in both source and target document and source.remove must be \"none\".
\n**Move**: Transfers the document from the source to the target location with deletion from the source. Requires the same fileFormat in both source and target document and source.remove must be \"delete\" or \"permanentDelete\".
\n**Delete**: Deletes the specified document if only the source document is provided and source.remove is \"delete\" or \"permanentDelete\". Target document is not in the payload in this case.
\n**Convert**: Transforms the document format (e.g., docx → pdf, xlsx → pdf) while transferring it between same or different locations. Requires both source and target document with differing fileFormat values.", "operationId": "post-documentmanage", "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } }, { "name": "X-Client-Authorization", "in": "header", "description": "Encrypted (AES) JWT token to identify and authorize the calling client system responsible for requesting the document generation. This header is required when retrieving the template and/or data used to populate the template from the client’s side, and for delivering the final generated document on the client’s side.", "schema": { "enum": [ "{{clientToken}}" ], "type": "string", "default": "{{clientToken}}" } }, { "name": "X-Service-Authorization", "in": "header", "description": "Encrypted (AES) JWT token to represent a user that doesn’t have a Microsoft Account and that is allowed to use the subscription.", "schema": { "enum": [ "{{secretToken}}" ], "type": "string", "default": "{{secretToken}}" } }, { "name": "X-Email", "in": "header", "description": "Email of the user who starts the process, needed for GAS script processing", "schema": { "enum": [ "{{email}}" ], "type": "string" } } ], "requestBody": { "description": "**externalContext**
\nA contextual reference used to link the document generation request to an external system, process, or transaction. Often used for traceability or auditing purposes.\n\n---\n\n**sourceDocument**
\nIdentifies the input document and its properties, serving as the starting point for file operations like copying to a new location, moving with deletion, deleting outright, or converting to a different format.\n\n**sourceDocument.options**
\nFine-tunes the loading process for the source document to meet specific requirements, such as retaining formatting or handling special features during operations like copying or conversion.\n\n---\n\n**targetDocument**
\nDefines the properties of the output document resulting from the file operation (e.g., the destination for Copy, Move, or Convert operations). It specifies the document’s metadata, format, delivery method, storage location, and processing options, determining how the processed document is saved and managed. This node is omitted for Delete operations, as no output document is generated.\n\n**targetDocument.options.salesforce**
\nSpecifies how the document will be stored or associated with records in Salesforce. Includes fields such as `fileId`, `fileType`, `fileParentId`, and `ownerId`.\n\n**targetDocument.options.onedrive**
\nSpecifies how the document will be shared or stored via Microsoft OneDrive. Includes permission settings like anonymous access, edit/view rights, and user-specific sharing.", "content": { "application/json": { "schema": { "type": "object", "properties": { "externalContext": { "type": "object", "properties": { "id": { "type": "string", "description": "External reference ID used for contextual tracking.", "default": "12345" } } }, "sourceDocument": { "required": [ "urn", "fileFormat", "loadMethod", "remove" ], "type": "object", "properties": { "urn": { "type": "string", "description": "URN of the source document stored in the system.", "default": "{{generateDocumentTemplateId}}" }, "fileFormat": { "enum": [ "docx", "xlsx", "pdf" ], "type": "string", "description": "File format of the source document (e.g., docx, xlsx, pdf).", "default": "xlsx" }, "loadMethod": { "enum": [ "Storage", "Salesforce", "OneDrive" ], "type": "string", "description": "Source of the document where it is stored (e.g., Storage, Salesforce, OneDrive).", "default": "Storage" }, "remove": { "type": "string", "description": "Flag indicating whether to remove the source document (e.g., none, delete, permanentDelete)", "default": "none" }, "options": { "type": "object", "properties": { "docxLoadOptions": { "type": "string", "description": "JSON string for DOCX load options, default \"{\\\"PreserveUnsupportedFeatures\\\": true}\".", "default": "{ \"PreserveUnsupportedFeatures\": true }" } } } } }, "targetDocument": { "required": [ "name", "fileFormat", "deliveryMethod", "path" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the target document without file extension.", "default": "Document" }, "fileFormat": { "enum": [ "docx", "xlsx", "pdf" ], "type": "string", "description": "Format of the generated document (e.g., docx, xlsx, pdf).", "default": "xlsx" }, "deliveryMethod": { "enum": [ "Storage", "Salesforce", "OneDrive" ], "type": "string", "description": "Place where the document will be stored (e.g., Storage, Salesforce, OneDrive).", "default": "Storage" }, "path": { "type": "string", "description": "Target folder or path for delivery. Optional based on storage provider.", "default": "" }, "options": { "type": "object", "properties": { "pdfSaveOptions": { "type": "string", "description": "JSON string for PDF output settings, default \"{\\\"ConformanceLevel\\\": \\\"PdfA3a\\\", \\\"Version\\\": \\\"PDF_1_7\\\", \\\"ImageDpi\\\": 750}\".", "default": "{ \"ConformanceLevel\": \"PdfA3a\", \"Version\": \"PDF_1_7\", \"ImageDpi\": 750 }" }, "docxSaveOptions": { "type": "string", "description": "JSON string for DOCX output customizations.", "default": "" }, "salesforce": { "type": "object", "properties": { "networkId": { "type": "string", "description": "ID of specific Salesforce Experience Cloud site or community where the generated document should be stored or associated.", "default": "" }, "fileId": { "type": "string", "description": "ID of existing file (ContentDocument) to update/replace.", "default": "" }, "fileType": { "enum": [ "File", "Attachment" ], "type": "string", "description": "File handling capabilities in Salesforce (e.g., File, Attachment).", "default": "" }, "fileParentId": { "type": "string", "description": "Salesforce record to which the file is attached.", "default": "" }, "ownerId": { "type": "string", "description": "Salesforce user or queue ID who should own the file.", "default": "" } } }, "onedrive": { "type": "object", "properties": { "viewAnonymous": { "type": "boolean", "description": "Allow public viewing via link of the generated document.", "default": false }, "editAnonymous": { "type": "boolean", "description": "Allow public editing via link of the generated document.", "default": false }, "editUsers": { "type": "array", "items": { "type": "string", "default": "user@example.com" }, "description": "List of users for the link with edit access." }, "viewUsers": { "type": "array", "items": { "type": "string", "default": "user@example.com" }, "description": "List of users for the link with view access." } } } } } } }, "data": { "type": "object", "properties": { "embedded": { "type": "string", "description": "Arbitrary key-value pairs written into PDF document properties.", "default": "" } } } } }, "example": { "externalContext": { "id": "{{yourExternalContextId}}" }, "sourceDocument": { "urn": "{{documentURN}}", "fileFormat": "docx", "//xlsx": null, "pdf \"loadMethod\"": "Storage", "//Salesforce": null, "OneDrive \"remove\"": "none", "//delete": null, "permanentDelete \"options\"": { "docxLoadOptions": "{ \"PreserveUnsupportedFeatures\": true }" } }, "targetDocument": { "name": "{{documentName}}", "fileFormat": "docx", "//xlsx": null, "pdf \"deliveryMethod\"": "Storage", "//Salesforce": null, "OneDrive \"path\"": "root", "options": { "pdfSaveOptions": "{ \"ConformanceLevel\": \"PdfA3a\", \"Version\": \"PDF_1_7\", \"ImageDpi\": 750 }", "docxSaveOptions": "{}", "salesforce": { "networkId": "{{siteId}}", "fileId": "{{targetFileId}}", "fileType": "File", "//Attachment \"fileParentId\"": "{{recordId}}", "ownerId": "{{ownerUserId}}" }, "onedrive": { "viewAnonymous": true, "//false \"editAnonymous\"": true, "//false \"editUsers\"": [ "user@example.com" ], "viewUsers": [ "user@example.com" ] } } }, "data": { "embedded": "key:value" } } } } }, "responses": { "201": { "description": "This response confirms that the document management operation (such as copy, move, delete, or convert) was successfully completed. It returns metadata about the resulting document, including its name, format, storage location, and URN. The response also includes consumption metrics indicating how many documents and pages were processed, which are relevant for billing or quotas.", "content": { "application/json": { "schema": { "required": [ "result", "consumption", "externalContext", "origin", "dateTime", "userId", "operationId" ], "type": "object", "properties": { "result": { "required": [ "statusCode", "message", "data" ], "type": "object", "properties": { "statusCode": { "enum": [ "201" ], "type": "string", "description": "Confirming the document was successfully managed." }, "message": { "type": "string", "description": "A simple status message." }, "data": { "required": [ "document" ], "type": "object", "properties": { "document": { "required": [ "deliveryMethod", "name", "fileFormat", "urn" ], "type": "object", "properties": { "deliveryMethod": { "enum": [ "Salesforce", "Storage", "OneDrive" ], "type": "string", "description": "The source system where the managed document is stored." }, "name": { "type": "string", "description": "The name of the managed document (without file extension)." }, "fileFormat": { "enum": [ "docx", "xlsx", "pdf" ], "type": "string", "description": "The format of the managed document." }, "urn": { "type": "string", "description": "A unique identifier used to retrieve or reference the managed document." } } } } } } }, "consumption": { "type": "array", "items": { "required": [ "dimension", "value" ], "type": "object", "properties": { "dimension": { "enum": [ "pages-managed", "documents-managed" ], "type": "string", "description": "The type of resource consumed (e.g., pages-managed, documents-managed)." }, "value": { "type": "number", "description": "The measured quantity for the dimension." } } } }, "externalContext": { "required": [ "actionRequestId" ], "type": "object", "properties": { "actionRequestId": { "type": "string", "description": "External reference ID used for contextual tracking." } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the request." }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the request was completed and the response returned.", "format": "date-time" }, "userId": { "type": "string", "description": "The unique identifier of the user or system that initiated the request." }, "operationId": { "type": "string", "description": "A system-generated ID that uniquely identifies this operation. Can be used for tracing, auditing, or support." } } }, "example": { "result": { "statusCode": "201", "message": "Created", "data": { "document": { "deliveryMethod": "{{deliveryMethod}}", "name": "{{documentName}}", "fileFormat": "{{fileFormat}}", "urn": "{{documentURN}}:{{documentName}}.{{fileFormat}}" } } }, "consumption": [ { "dimension": "pages-managed", "value": "" }, { "dimension": "documents-managed", "value": "" } ], "externalContext": { "actionRequestId": "{{externalContextId}}" }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}", "userId": "{{userId}}", "operationId": "{{operationId}}" } } } }, "400": { "description": "This response indicates that the request was malformed or invalid due to missing or unsupported parameters, such as an incorrect file format or improperly structured payload. It includes detailed error information with specific error codes, messages, and a user-friendly explanation to help diagnose the issue.", "content": { "application/json": { "schema": { "required": [ "error", "externalContext", "origin", "dateTime", "userId", "operationId" ], "type": "object", "properties": { "error": { "required": [ "statusCode", "message", "innerErrors" ], "type": "object", "properties": { "statusCode": { "enum": [ "400" ], "type": "string", "description": "Indicating a bad request was made." }, "message": { "type": "string", "description": "A high-level description of the error." }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage", "eventId" ], "type": "object", "properties": { "code": { "type": "string", "description": "An error code indicating the type of issue encountered." }, "message": { "type": "string", "description": "A description of the specific error encountered." }, "userMessage": { "type": "string", "description": "A message intended for the end-user, advising on how to resolve the issue." }, "eventId": { "type": "string", "description": "A unique identifier for tracing the error in logs or debugging." } } } }, "externalErrors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code from the external service." }, "message": { "type": "string", "description": "A description of the external error." } }, "description": "Detailed list of errors originating from external services." } } } }, "externalContext": { "required": [ "actionRequestId" ], "type": "object", "properties": { "actionRequestId": { "type": "string", "description": "External reference ID used for contextual tracking." } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the document manage request." }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the response was returned.", "format": "date-time" }, "userId": { "type": "string", "description": "The unique identifier of the user or system that initiated the request." }, "operationId": { "type": "string", "description": "A system-generated ID that uniquely identifies this operation. Can be used for tracing, auditing, or support." } } }, "example": { "error": { "statusCode": "400", "message": "Bad Request", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}", "eventId": "{{eventId}}" } ], "externalErrors": [] }, "externalContext": { "actionRequestId": "{{externalContextId}}" }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}", "userId": "{{userId}}", "operationId": "{{operationId}}" } } } } } } }, "/documents/document/merge": { "post": { "tags": [ "Document" ], "summary": "Document Merge", "description": "This endpoint allows you to merge multiple PDF documents into a single consolidated PDF file, preserving the order you specify. The sequence of merged files is determined in the payload in each source document, and all source files must be in PDF format. The merged output can be stored in Storage, Salesforce, or OneDrive and source documents can optionally be removed from the source after merging.", "operationId": "post-documentmerge", "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } }, { "name": "X-Client-Authorization", "in": "header", "description": "Encrypted (AES) JWT token to identify and authorize the calling client system responsible for requesting the document generation. This header is required when retrieving the template and/or data used to populate the template from the client’s side, and for delivering the final generated document on the client’s side.", "schema": { "enum": [ "{{clientToken}}" ], "type": "string", "default": "{{clientToken}}" } }, { "name": "X-Service-Authorization", "in": "header", "description": "Encrypted (AES) JWT token to represent a user that doesn’t have a Microsoft Account and that is allowed to use the subscription.", "schema": { "enum": [ "{{secretToken}}" ], "type": "string", "default": "{{secretToken}}" } }, { "name": "X-Email", "in": "header", "description": "Email of the user who starts the process, needed for GAS script processing", "schema": { "enum": [ "{{email}}" ], "type": "string" } } ], "requestBody": { "description": "**externalContext**
\nA contextual reference used to link the document generation request to an external system, process, or transaction. Often used for traceability or auditing purposes.\n\n---\n\n**sourceDocuments**
\nIdentifies the input documents (e.g., Word, Excel, or PDF files) and their properties, serving as the inputs for the merge and conversion process to create a unified target document.\n\n---\n\n**targetDocument**
\nDefines the properties of the output document resulting from merging the source documents. It specifies the document’s metadata, format (typically PDF for merged outputs), delivery method, storage location, and processing options, determining how the merged document is saved and managed.\n\n**targetDocument.options.salesforce**
\nSpecifies how the document will be stored or associated with records in Salesforce. Includes fields such as `fileId`, `fileType`, `fileParentId`, and `ownerId`.\n\n**targetDocument.options.onedrive**
\nSpecifies how the document will be shared or stored via Microsoft OneDrive. Includes permission settings like anonymous access, edit/view rights, and user-specific sharing.", "content": { "application/json": { "schema": { "type": "object", "properties": { "externalContext": { "type": "object", "properties": { "id": { "type": "string", "description": "External reference ID used for contextual tracking.", "default": "12345" } } }, "sourceDocuments": { "type": "array", "items": { "required": [ "urn", "fileFormat", "loadMethod", "remove" ], "type": "object", "properties": { "urn": { "type": "string", "description": "URN of the source document stored in the system.", "default": "{{sourceDocumentId}}" }, "fileFormat": { "enum": [ "pdf" ], "type": "string", "description": "File format of the source document (e.g., pdf).", "default": "pdf" }, "loadMethod": { "enum": [ "Storage", "Salesforce", "OneDrive" ], "type": "string", "description": "Source of the document where it is stored (e.g., Storage, Salesforce, OneDrive).", "default": "Storage" }, "order": { "type": "integer", "description": "Order in which the document should be merged.", "default": 1 }, "remove": { "type": "string", "description": "Flag indicating whether to remove the source document after merging (e.g., none, delete, permanentDelete).", "default": "none" } } } }, "targetDocument": { "required": [ "name", "fileFormat", "deliveryMethod", "path" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the target document without file extension.", "default": "Document" }, "fileFormat": { "enum": [ "pdf" ], "type": "string", "description": "Format of the generated document (e.g., pdf).", "default": "pdf" }, "deliveryMethod": { "enum": [ "Storage", "Salesforce", "OneDrive" ], "type": "string", "description": "Place where the document will be stored (e.g., Storage, Salesforce, OneDrive).", "default": "Storage" }, "path": { "type": "string", "description": "Target folder or path for delivery. Optional based on storage provider.", "default": "" }, "options": { "type": "object", "properties": { "pdfSaveOptions": { "type": "string", "description": "JSON string for PDF output settings, default \"{\\\"ConformanceLevel\\\": \\\"PdfA3a\\\", \\\"Version\\\": \\\"PDF_1_7\\\", \\\"ImageDpi\\\": 750}\".", "default": "{ \"ConformanceLevel\": \"PdfA3a\", \"Version\": \"PDF_1_7\", \"ImageDpi\": 750 }" }, "salesforce": { "type": "object", "properties": { "networkId": { "type": "string", "description": "ID of specific Salesforce Experience Cloud site or community where the generated document should be stored or associated.", "default": "" }, "fileId": { "type": "string", "description": "ID of existing file (ContentDocument) to update/replace.", "default": "" }, "fileType": { "enum": [ "File", "Attachment" ], "type": "string", "description": "File handling capabilities in Salesforce (e.g., File, Attachment).", "default": "" }, "fileParentId": { "type": "string", "description": "Salesforce record to which the file is attached.", "default": "" }, "ownerId": { "type": "string", "description": "Salesforce user or queue ID who should own the file.", "default": "" } } }, "onedrive": { "type": "object", "properties": { "viewAnonymous": { "type": "boolean", "description": "Allow public viewing via link of the generated document.", "default": false }, "editAnonymous": { "type": "boolean", "description": "Allow public editing via link of the generated document.", "default": false }, "editUsers": { "type": "array", "items": { "type": "string", "default": "user@example.com" }, "description": "List of users for the link with edit access." }, "viewUsers": { "type": "array", "items": { "type": "string", "default": "user@example.com" }, "description": "List of users for the link with view access." } } } } } } }, "data": { "type": "object", "properties": { "embedded": { "type": "string", "description": "Arbitrary key-value pairs written into PDF document properties.", "default": "" } } } } }, "example": { "externalContext": { "id": "{{yourExternalContextId}}" }, "sourceDocuments": [ { "urn": "{{document1URN}}", "loadMethod": "Storage", "order": 1, "remove": "none" }, { "urn": "{{document2URN}}", "loadMethod": "Storage", "order": 2, "remove": "none" } ], "targetDocument": { "name": "{{documentName}}", "fileFormat": "pdf", "deliveryMethod": "Storage", "path": "root", "options": { "pdfSaveOptions": "{ \"ConformanceLevel\": \"PdfA3a\", \"Version\": \"PDF_1_7\", \"ImageDpi\": 750 }", "salesforce": { "networkId": "{{siteId}}", "fileId": "{{targetFileId}}", "fileType": "File", "fileParentId": "{{recordId}}", "ownerId": "{{ownerUserId}}" }, "onedrive": { "viewAnonymous": true, "editAnonymous": true, "editUsers": [ "user@example.com" ], "viewUsers": [ "user@example.com" ] } } }, "data": { "embedded": "key:value" } } } } }, "responses": { "201": { "description": "This response confirms that the merge operation was successfully completed. It returns metadata about the newly created PDF document, including its name, delivery method, file format, and a unique URN that can be used to reference or download the file. Additionally, it provides consumption details, such as the number of documents merged and total pages processed.", "content": { "application/json": { "schema": { "required": [ "result", "consumption", "externalContext", "origin", "dateTime", "userId", "operationId" ], "type": "object", "properties": { "result": { "required": [ "statusCode", "message", "data" ], "type": "object", "properties": { "statusCode": { "enum": [ "201" ], "type": "string", "description": "Confirming the document was successfully merged." }, "message": { "type": "string", "description": "A simple status message." }, "data": { "required": [ "document" ], "type": "object", "properties": { "document": { "required": [ "deliveryMethod", "name", "fileFormat", "urn" ], "type": "object", "properties": { "deliveryMethod": { "enum": [ "Salesforce", "Storage", "OneDrive" ], "type": "string", "description": "The source system where the merged document is stored." }, "name": { "type": "string", "description": "The name of the merged document (without file extension)." }, "fileFormat": { "enum": [ "docx", "xlsx", "pdf" ], "type": "string", "description": "The format of the merged document." }, "urn": { "type": "string", "description": "A unique identifier used to retrieve or reference the merged document." } } } } } } }, "consumption": { "type": "array", "items": { "required": [ "dimension", "value" ], "type": "object", "properties": { "dimension": { "enum": [ "pages-merged", "documents-merged" ], "type": "string", "description": "The type of resource consumed (e.g., pages-merged, documents-merged)." }, "value": { "type": "number", "description": "The measured quantity for the dimension." } } } }, "externalContext": { "required": [ "actionRequestId" ], "type": "object", "properties": { "actionRequestId": { "type": "string", "description": "External reference ID used for contextual tracking." } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the document merge request." }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the document merge was completed and the response returned.", "format": "date-time" }, "userId": { "type": "string", "description": "The unique identifier of the user or system that initiated the request." }, "operationId": { "type": "string", "description": "A system-generated ID that uniquely identifies this operation. Can be used for tracing, auditing, or support." } } }, "example": { "result": { "statusCode": "201", "message": "Created", "data": { "document": { "deliveryMethod": "{{deliveryMethod}}", "name": "{{documentName}}", "fileFormat": "{{fileFormat}}", "urn": "{{documentURN}}:{{documentName}}.{{fileFormat}}" } } }, "consumption": [ { "dimension": "pages-merged", "value": "" }, { "dimension": "documents-merged", "value": "" } ], "externalContext": { "actionRequestId": "{{externalContextId}}" }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}", "userId": "{{userId}}", "operationId": "{{operationId}}" } } } }, "400": { "description": "This response indicates that the merge request was invalid or improperly formed. It includes detailed error information such as status code, internal error codes, developer-facing messages, and user-friendly error descriptions to help diagnose the issue.", "content": { "application/json": { "schema": { "required": [ "error", "externalContext", "origin", "dateTime", "userId", "operationId" ], "type": "object", "properties": { "error": { "required": [ "statusCode", "message", "innerErrors" ], "type": "object", "properties": { "statusCode": { "enum": [ "400" ], "type": "string", "description": "Indicating a bad request was made." }, "message": { "type": "string", "description": "A high-level description of the error." }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage", "eventId" ], "type": "object", "properties": { "code": { "type": "string", "description": "An error code indicating the type of issue encountered." }, "message": { "type": "string", "description": "A description of the specific error encountered." }, "userMessage": { "type": "string", "description": "A message intended for the end-user, advising on how to resolve the issue." }, "eventId": { "type": "string", "description": "A unique identifier for tracing the error in logs or debugging." } } } }, "externalErrors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code from the external service." }, "message": { "type": "string", "description": "A description of the external error." } }, "description": "Detailed list of errors originating from external services." } } } }, "externalContext": { "required": [ "actionRequestId" ], "type": "object", "properties": { "actionRequestId": { "type": "string", "description": "External reference ID used for contextual tracking." } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the document merge request." }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the response was returned.", "format": "date-time" }, "userId": { "type": "string", "description": "The unique identifier of the user or system that initiated the request." }, "operationId": { "type": "string", "description": "A system-generated ID that uniquely identifies this operation. Can be used for tracing, auditing, or support." } } }, "example": { "error": { "statusCode": "400", "message": "Bad Request", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}", "eventId": "{{eventId}}" } ], "externalErrors": [] }, "externalContext": { "actionRequestId": "{{externalContextId}}" }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}", "userId": "{{userId}}", "operationId": "{{operationId}}" } } } } } } }, "/documents/document/generate": { "post": { "tags": [ "Document" ], "summary": "Document Generate", "description": "This is an object representing a document request in the system. You can use this endpoint to generate documents (e.g. PDF, DOCX, XLSX) by specifying a template, providing the data to populate that template, and choosing where and how the final file should be delivered.
\n\nThe document output can be stored in Salesforce, OneDrive, or Azure storage solution, and may include advanced options like anonymous sharing, file ownership, and metadata tagging.
\n\nYou can also attach additional related templates, pass custom variables, and render dynamic content using GraphQL queries or stored data sources.
\n\nRelated guide: [Document Template Configuration](https://docs.mavenmule.com/maven-documents/elements-reference)", "operationId": "post-documentsgenerate", "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } }, { "name": "X-Client-Authorization", "in": "header", "description": "Encrypted (AES) JWT token to identify and authorize the calling client system responsible for requesting the document generation. This header is required when retrieving the template and/or data used to populate the template from the client’s side, and for delivering the final generated document on the client’s side. The JWT must contain the following claims:

\n**sub**: Current user session.
\n**Destination**: Path to which should be used to make a callback.
\n**full_name**: Name of the user that made the request.
\n**email**: The email address of the user that made the request.
\n**iss**: The issuer claim identifies the principal that issued the JWT. URL of the issuer.
\n**oid**: Object Id claim represents a unique Id of the user that made the request, for example in Salesforce case this will be User record Id.
\n**clientId**: Id representing the client. Eg OrgId.
\n**zoneInfo**: Zone information.
\n**locale**: Localization information.", "schema": { "enum": [ "{{clientToken}}" ], "type": "string", "default": "{{clientToken}}" } }, { "name": "X-Service-Authorization", "in": "header", "description": "Encrypted (AES) JWT token to represent a user that doesn’t have a Microsoft Account and that is allowed to use the subscription. The JWT must contain the following claims:

\n**amp_subscription**: The offering subscription key which is used to validate that the client has a valid license.
\n**full_name**: Name of the user that made the request.
\n**email**: The email address of the user that made the request.
\n**iss**: The issuer claim identifies the principal that issued the JWT. URL of the issuer.
\n**oid**: Object Id claim represents a unique Id of the user that made the request, for example in Salesforce case this will be User record Id.
\n**zoneInfo**: Zone information.
\n**locale**: Localization information.", "schema": { "enum": [ "{{secretToken}}" ], "type": "string", "default": "{{secretToken}}" } }, { "name": "X-Email", "in": "header", "description": "Email of the user who starts the process, needed for GAS script processing", "schema": { "enum": [ "{{email}}" ], "type": "string" } } ], "requestBody": { "description": "\n**externalContext**
\nA contextual reference used to link the document generation request to an external system, process, or transaction. Often used for traceability or auditing purposes.\n\n---\n\n**template**
\nDefines the primary document template to be used for generating the document. It includes the template’s metadata, source, file format, and any related templates used during processing.\n\n**template.options**
\nProvides additional configuration for how the template is loaded or processed (e.g., preserving unsupported features or applying file-specific handling options).\n\n**template.relatedItems**
\nAn array of additional templates associated with the primary template. These may be appended or merged during document generation.\n\n---\n\n**data**
\nDefines the source of data and variables that populate the template's placeholders or fields. It includes the method of data retrieval (e.g., from storage, Salesforce, OneDrive) and any static or dynamic content used in the final document.\n\n**data.variables**
\nList of reusable name–value pairs injected into the data. Useful for passing static values, global variables, GraphQL expressions, or field formulas. \n**Note:** This section is should be reviewed by Tomislav and Ivan A.\n\n**data.embedded**
\nAn optional string providing inline key–value metadata pairs that may be embedded in the output file (e.g., in a PDF's metadata section).\n\n---\n\n**document**
\nDefines the configuration and metadata of the final generated document, including its name, locale, format, timezone, delivery method, and storage destination.\n\n**document.options.salesforce**
\nSpecifies how the document will be stored or associated with records in Salesforce. Includes fields such as `fileId`, `fileType`, `fileParentId`, and `ownerId`.\n\n**document.options.onedrive**
\nSpecifies how the document will be shared or stored via Microsoft OneDrive. Includes permission settings like anonymous access, edit/view rights, and user-specific sharing.\n\n**document.options.googledrive**
\nSpecifies how the document will be shared or stored via Google Drive. Includes permission settings like anonymous access, edit/view rights, and user-specific sharing.", "content": { "application/json": { "schema": { "type": "object", "properties": { "externalContext": { "type": "object", "properties": { "id": { "type": "string", "description": "External reference ID used for contextual tracking.", "default": "12345" } } }, "template": { "required": [ "urn", "fileFormat", "loadMethod" ], "type": "object", "properties": { "name": { "type": "string", "description": "Template name (as known in Salesforce, Storage, or OneDrive).", "default": "" }, "urn": { "type": "string", "description": "Template identifier. Can be a Salesforce ContentVersion ID, Storage key, or OneDrive file ID.", "default": "{{generateDocumentTemplateId}}" }, "fileFormat": { "enum": [ "docx", "xlsx" ], "type": "string", "description": "Template file format without dot (e.g., docx, xlsx).", "default": "xlsx" }, "loadMethod": { "enum": [ "Storage", "Salesforce", "OneDrive" ], "type": "string", "description": "Source of the template where it is stored (e.g., Storage, Salesforce, OneDrive).", "default": "Storage" }, "options": { "type": "object", "properties": { "docxLoadOptions": { "type": "string", "description": "JSON string for DOCX load options, default \"{\\\"PreserveUnsupportedFeatures\\\": true}\".", "default": "{ \"PreserveUnsupportedFeatures\": true }" } } }, "relatedItems": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the related template. Must match the name used in the root template.", "default": "" }, "urn": { "type": "string", "description": "Identifier of the related template, used to locate the file.", "default": "" }, "fileFormat": { "type": "string", "description": "Format of the related template file (e.g., docx, xlsx).", "default": "" }, "loadMethod": { "enum": [ "Storage", "Salesforce", "OneDrive" ], "type": "string", "description": "Source system from which to load the related template (e.g., Storage, Salesforce, OneDrive).", "default": "" } } } } } }, "data": { "required": [ "urn", "loadMethod" ], "type": "object", "properties": { "loadMethod": { "enum": [ "Storage", "Salesforce", "OneDrive" ], "type": "string", "description": "Source of the data (e.g., Storage, Salesforce, OneDrive).", "default": "Storage" }, "urn": { "type": "string", "description": "Data identifier for the data source used to populate the template provided in the template URN (e.g., GraphQL endpoint, Storage key, OneDrive file ID).", "default": "{{generateDocumentDataId}}" }, "variables": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Variable name (e.g., myExpressionField).", "default": "" }, "value": { "type": "string", "description": "Raw value or expression placeholder.", "default": "" }, "type": { "enum": [ "fieldExpression", "graphql", "global" ], "type": "string", "description": "Type of variable.", "default": "" } } } }, "query": { "type": "string", "description": "JSON-encoded GraphQL query, used if loadMethod is GraphQL.", "default": "" }, "embedded": { "type": "string", "description": "Arbitrary key-value pairs written into PDF document properties.", "default": "" } } }, "document": { "required": [ "timezone", "locale", "name", "fileFormat", "deliveryMethod" ], "type": "object", "properties": { "timezone": { "type": "string", "description": "Timezone used for date/time formatting.", "default": "(GMT+01:00) Central European Standard Time (Europe/Zagreb)" }, "locale": { "type": "string", "description": "Locale for language-specific formatting. Supported values follow the [Unicode CLDR Project](https://cldr.unicode.org/), such as [`en-GB`, `es-MX`, and others](https://github.com/unicode-org/cldr-json/tree/main/cldr-json/cldr-dates-full/main).", "default": "en_US_POSIX" }, "name": { "type": "string", "description": "Name of the generated document without file extension.", "default": "Document" }, "fileFormat": { "enum": [ "docx", "xlsx", "pdf" ], "type": "string", "description": "Format of the generated document (e.g., docx, xlsx, pdf).", "default": "pdf" }, "deliveryMethod": { "enum": [ "Storage", "Salesforce", "OneDrive" ], "type": "string", "description": "Place where the document will be stored (e.g., Storage, Salesforce, OneDrive).", "default": "Storage" }, "path": { "type": "string", "description": "Target folder or path for delivery. Optional based on storage provider.", "default": "" }, "options": { "type": "object", "properties": { "pdfSaveOptions": { "type": "string", "description": "JSON string for PDF output settings, default \"{\\\"ConformanceLevel\\\": \\\"PdfA3a\\\", \\\"Version\\\": \\\"PDF_1_7\\\", \\\"ImageDpi\\\": 750}\".", "default": "{ \"ConformanceLevel\": \"PdfA3a\", \"Version\": \"PDF_1_7\", \"ImageDpi\": 750 }" }, "docxSaveOptions": { "type": "string", "description": "JSON string for DOCX output customizations.", "default": "" }, "salesforce": { "type": "object", "properties": { "fileId": { "type": "string", "description": "ID of existing file (ContentDocument) to update/replace.", "default": "" }, "fileType": { "enum": [ "File", "Attachment" ], "type": "string", "description": "File handling capabilities in Salesforce (e.g., File, Attachment).", "default": "" }, "fileParentId": { "type": "string", "description": "Salesforce record to which the file is attached.", "default": "" }, "ownerId": { "type": "string", "description": "Salesforce user or queue ID who should own the file.", "default": "" } } }, "onedrive": { "type": "object", "properties": { "viewAnonymous": { "type": "boolean", "description": "Allow public viewing via link of the generated document.", "default": false }, "editAnonymous": { "type": "boolean", "description": "Allow public editing via link of the generated document.", "default": false }, "editUsers": { "type": "array", "items": { "type": "string", "default": "user@example.com" }, "description": "List of users for the link with edit access." }, "viewUsers": { "type": "array", "items": { "type": "string", "default": "user@example.com" }, "description": "List of users for the link with view access." } } } } } } } } }, "example": { "externalContext": { "id": "{{yourExternalContextId}}" }, "template": { "name": "{{templateName}}", "urn": "{{templateURN}}", "fileFormat": "docx", "loadMethod": "Storage", "options": { "docxLoadOptions": "{ \"PreserveUnsupportedFeatures\": true }" }, "relatedItems": [ { "name": "{{relatedTemplateName}}", "urn": "{{relatedTemplateURN}}", "fileFormat": "docx", "loadMethod": "Storage" } ] }, "data": { "loadMethod": "Storage", "urn": "{{dataURN}}", "variables": [ { "name": "createdDate", "value": "{!$now()}", "type": "fieldExpression" }, { "name": "requestId", "value": "{!requestId}", "type": "graphql" }, { "name": "customerName", "value": "Jane Doe", "type": "global" } ], "query": "{\"query\":\"{Account {Name Description Owner.Username Id Opportunities {StageName OpportunityLineItems {Name}} Contacts {Id}}}\"}", "embedded": "key:value" }, "document": { "timezone": "(GMT+00:00) Greenwich Mean Time (Europe/Dublin)", "locale": "en_IE_EURO", "name": "{{finalDocumentName}}", "fileFormat": "docx", "deliveryMethod": "Storage", "path": "root", "options": { "pdfSaveOptions": "{ \"ConformanceLevel\": \"PdfA3a\", \"Version\": \"PDF_1_7\", \"ImageDpi\": 750 }", "docxSaveOptions": "{}", "salesforce": { "fileId": "{{targetFileId}}", "fileType": "File", "fileParentId": "{{recordId}}", "ownerId": "{{ownerUserId}}" }, "onedrive": { "viewAnonymous": true, "editAnonymous": true, "editUsers": [ "user@example.com" ], "viewUsers": [ "user@example.com" ] }, "googleDrive": { "viewAnonymous": true, "editAnonymous": true, "editUsers": [ "user@example.com" ], "viewUsers": [ "user@example.com" ] }, "googleGenerate": { "nativeMergeEnabled": true, "nativeImageMergeEnabled": true } } } } } } }, "responses": { "201": { "description": "This response indicates that the document was successfully generated and delivered using the specified deliveryMethod. It includes metadata about the generated document (such as name, format, and unique URN), usage metrics (e.g., pages generated), and contextual information useful for tracking and auditing the operation.", "content": { "application/json": { "schema": { "required": [ "result", "consumption", "externalContext", "origin", "dateTime", "userId", "operationId" ], "type": "object", "properties": { "result": { "required": [ "statusCode", "message", "data" ], "type": "object", "properties": { "statusCode": { "enum": [ "201" ], "type": "string", "description": "Confirming the document was successfully created." }, "message": { "type": "string", "description": "A simple status message." }, "data": { "required": [ "document" ], "type": "object", "properties": { "document": { "required": [ "deliveryMethod", "name", "fileFormat", "urn" ], "type": "object", "properties": { "deliveryMethod": { "enum": [ "Salesforce", "Storage", "OneDrive" ], "type": "string", "description": "The source system where the generated document is stored." }, "name": { "type": "string", "description": "The name of the generated document (without file extension)." }, "fileFormat": { "enum": [ "docx", "xlsx", "pdf" ], "type": "string", "description": "The format of the generated document." }, "urn": { "type": "string", "description": "A unique identifier used to retrieve or reference the generated document." } } } } } } }, "consumption": { "type": "array", "items": { "required": [ "dimension", "value" ], "type": "object", "properties": { "dimension": { "enum": [ "pages-generated", "documents-generated" ], "type": "string", "description": "The type of resource consumed (e.g., pages-generated, documents-generated)." }, "value": { "type": "number", "description": "The measured quantity for the dimension." } } } }, "externalContext": { "required": [ "actionRequestId" ], "type": "object", "properties": { "actionRequestId": { "type": "string", "description": "External reference ID used for contextual tracking." } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the document generation request." }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the document generation was completed and the response returned.", "format": "date-time" }, "userId": { "type": "string", "description": "The unique identifier of the user or system that initiated the request." }, "operationId": { "type": "string", "description": "A system-generated ID that uniquely identifies this generation operation. Can be used for tracing, auditing, or support." } } }, "example": { "result": { "statusCode": "201", "message": "Created", "data": { "document": { "deliveryMethod": "{{deliveryMethod}}", "name": "{{documentName}}", "fileFormat": "{{fileFormat}}", "urn": "{{documentURN}}:{{documentName}}.{{fileFormat}}" } } }, "consumption": [ { "dimension": "pages-generated", "value": "" }, { "dimension": "documents-generated", "value": "" } ], "externalContext": { "actionRequestId": "{{externalContextId}}" }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}", "userId": "{{userId}}", "operationId": "{{operationId}}" } } } }, "400": { "description": "This response indicates that the request was invalid or improperly formed. It provides details about the error that occurred, including specific error codes, messages, and guidance for the user on how to resolve the issue.", "content": { "application/json": { "schema": { "required": [ "error", "externalContext", "origin", "dateTime", "userId", "operationId" ], "type": "object", "properties": { "error": { "required": [ "statusCode", "message", "innerErrors" ], "type": "object", "properties": { "statusCode": { "enum": [ "400" ], "type": "string", "description": "Indicating a bad request was made." }, "message": { "type": "string", "description": "A high-level description of the error." }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage", "eventId" ], "type": "object", "properties": { "code": { "type": "string", "description": "An error code indicating the type of issue encountered." }, "message": { "type": "string", "description": "A description of the specific error encountered." }, "userMessage": { "type": "string", "description": "A message intended for the end-user, advising on how to resolve the issue." }, "eventId": { "type": "string", "description": "A unique identifier for tracing the error in logs or debugging." } } } }, "externalErrors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code from the external service." }, "message": { "type": "string", "description": "A description of the external error." } }, "description": "Detailed list of errors originating from external services." } } } }, "externalContext": { "required": [ "actionRequestId" ], "type": "object", "properties": { "actionRequestId": { "type": "string", "description": "External reference ID used for contextual tracking." } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the document generation request." }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the response was returned.", "format": "date-time" }, "userId": { "type": "string", "description": "The unique identifier of the user or system that initiated the request." }, "operationId": { "type": "string", "description": "A system-generated ID that uniquely identifies this operation. Can be used for tracing, auditing, or support." } } }, "example": { "error": { "statusCode": "400", "message": "Bad Request", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}", "eventId": "{{eventId}}" } ], "externalErrors": [] }, "externalContext": { "actionRequestId": "{{externalContextId}}" }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}", "userId": "{{userId}}", "operationId": "{{operationId}}" } } } } } } }, "/documents/document/generate/async": { "post": { "tags": [ "Document" ], "summary": "Document Generate Async", "description": "This endpoint allows you to initiate an asynchronous document generation request. Similar to the [Documents Generate](https://apim-mavenheadless-dev-westeu.developer.azure-api.net/api-details#api=documents&operation=post-documentsgenerate)\n endpoint, it enables you to generate documents (e.g. PDF, DOCX, XLSX) by specifying a template, supplying structured data, and configuring output options such as format, storage location, and delivery method. Unlike the synchronous variant, this endpoint immediately returns control to the caller and processes the document generation in the background, returning a response via a callback, promise, depending on your integration setup once the document is ready. This endpoint is useful when generating complex documents that may require longer processing times or when you prefer non-blocking operations.", "operationId": "async-test", "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } }, { "name": "X-Client-Authorization", "in": "header", "description": "Encrypted (AES) JWT token to identify and authorize the calling client system responsible for requesting the document generation. This header is required when retrieving the template and/or data used to populate the template from the client’s side, and for delivering the final generated document on the client’s side.", "schema": { "enum": [ "{{clientToken}}" ], "type": "string", "default": "{{clientToken}}" } }, { "name": "X-Service-Authorization", "in": "header", "description": "Encrypted (AES) JWT token to represent a user that doesn’t have a Microsoft Account and that is allowed to use the subscription.", "schema": { "enum": [ "{{secretToken}}" ], "type": "string", "default": "{{secretToken}}" } }, { "name": "X-Email", "in": "header", "description": "Email of the user who starts the process, needed for GAS script processing", "schema": { "enum": [ "{{email}}" ], "type": "string" } } ], "requestBody": { "description": "\n**externalContext**
\nA contextual reference used to link the document generation request to an external system, process, or transaction. Often used for traceability or auditing purposes.\n\n---\n\n**template**
\nDefines the primary document template to be used for generating the document. It includes the template’s metadata, source, file format, and any related templates used during processing.\n\n**template.options**
\nProvides additional configuration for how the template is loaded or processed (e.g., preserving unsupported features or applying file-specific handling options).\n\n**template.relatedItems**
\nAn array of additional templates associated with the primary template. These may be appended or merged during document generation.\n\n---\n\n**data**
\nDefines the source of data and variables that populate the template's placeholders or fields. It includes the method of data retrieval (e.g., from storage, Salesforce, OneDrive) and any static or dynamic content used in the final document.\n\n**data.variables**
\nList of reusable name–value pairs injected into the data. Useful for passing static values, global variables, GraphQL expressions, or field formulas. \n**Note:** This section is should be reviewed by Tomislav and Ivan A.\n\n**data.embedded**
\nAn optional string providing inline key–value metadata pairs that may be embedded in the output file (e.g., in a PDF's metadata section).\n\n---\n\n**document**
\nDefines the configuration and metadata of the final generated document, including its name, locale, format, timezone, delivery method, and storage destination.\n\n**document.options.salesforce**
\nSpecifies how the document will be stored or associated with records in Salesforce. Includes fields such as `fileId`, `fileType`, `fileParentId`, and `ownerId`.\n\n**document.options.onedrive**
\nSpecifies how the document will be shared or stored via Microsoft OneDrive. Includes permission settings like anonymous access, edit/view rights, and user-specific sharing.\n\n**document.options.googledrive**
\nSpecifies how the document will be shared or stored via Google Drive. Includes permission settings like anonymous access, edit/view rights, and user-specific sharing.", "content": { "application/json": { "schema": { "type": "object", "properties": { "externalContext": { "type": "object", "properties": { "id": { "type": "string", "description": "External reference ID used for contextual tracking.", "default": "12345" } } }, "template": { "required": [ "urn", "fileFormat", "loadMethod" ], "type": "object", "properties": { "name": { "type": "string", "description": "Template name (as known in Salesforce, Storage, or OneDrive).", "default": "" }, "urn": { "type": "string", "description": "Template identifier. Can be a Salesforce ContentVersion ID, Storage key, or OneDrive file ID.", "default": "{{generateDocumentTemplateId}}" }, "fileFormat": { "enum": [ "docx", "xlsx" ], "type": "string", "description": "Template file format without dot (e.g., docx, xlsx).", "default": "xlsx" }, "loadMethod": { "enum": [ "Storage", "Salesforce", "OneDrive" ], "type": "string", "description": "Source of the template where it is stored (e.g., Storage, Salesforce, OneDrive).", "default": "Storage" }, "options": { "type": "object", "properties": { "docxLoadOptions": { "type": "string", "description": "JSON string for DOCX load options, default \"{\\\"PreserveUnsupportedFeatures\\\": true}\".", "default": "{ \"PreserveUnsupportedFeatures\": true }" } } }, "relatedItems": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the related template. Must match the name used in the root template.", "default": "" }, "urn": { "type": "string", "description": "Identifier of the related template, used to locate the file.", "default": "" }, "fileFormat": { "type": "string", "description": "Format of the related template file (e.g., docx).", "default": "" }, "loadMethod": { "enum": [ "Storage", "Salesforce", "OneDrive" ], "type": "string", "description": "Source system from which to load the related template (e.g., Storage, Salesforce, OneDrive).", "default": "" } } } } } }, "data": { "required": [ "urn", "loadMethod" ], "type": "object", "properties": { "loadMethod": { "enum": [ "Storage", "Salesforce", "OneDrive" ], "type": "string", "description": "Source of the data (e.g., Storage, Salesforce, OneDrive).", "default": "Storage" }, "urn": { "type": "string", "description": "Data identifier for the data source used to populate the template provided in the template URN (e.g., GraphQL endpoint, Storage key, OneDrive file ID).", "default": "{{generateDocumentDataId}}" }, "variables": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Variable name (e.g., myExpressionField).", "default": "" }, "value": { "type": "string", "description": "Raw value or expression placeholder.", "default": "" }, "type": { "enum": [ "fieldExpression", "graphql", "global" ], "type": "string", "description": "Type of variable.", "default": "" } } } }, "query": { "type": "string", "description": "JSON-encoded GraphQL query, used if loadMethod is GraphQL.", "default": "" }, "embedded": { "type": "string", "description": "Arbitrary key-value pairs written into PDF document properties.", "default": "" } } }, "document": { "required": [ "timezone", "locale", "name", "fileFormat", "deliveryMethod" ], "type": "object", "properties": { "timezone": { "type": "string", "description": "Timezone used for date/time formatting.", "default": "(GMT+01:00) Central European Standard Time (Europe/Zagreb)" }, "locale": { "type": "string", "description": "Locale for language-specific formatting. Supported values follow the [Unicode CLDR Project](https://cldr.unicode.org/), such as [`en-GB`, `es-MX`, and others](https://github.com/unicode-org/cldr-json/tree/main/cldr-json/cldr-dates-full/main).", "default": "en_US_POSIX" }, "name": { "type": "string", "description": "Name of the generated document without file extension.", "default": "Document" }, "fileFormat": { "enum": [ "docx", "xlsx", "pdf" ], "type": "string", "description": "Format of the generated document (e.g., docx, xlsx, pdf).", "default": "pdf" }, "deliveryMethod": { "enum": [ "Storage", "Salesforce", "OneDrive" ], "type": "string", "description": "Place where the document will be stored (e.g., Storage, Salesforce, OneDrive).", "default": "Storage" }, "path": { "type": "string", "description": "Target folder or path for delivery. Optional based on storage provider.", "default": "" }, "options": { "type": "object", "properties": { "pdfSaveOptions": { "type": "string", "description": "JSON string for PDF output settings, default \"{\\\"ConformanceLevel\\\": \\\"PdfA3a\\\", \\\"Version\\\": \\\"PDF_1_7\\\", \\\"ImageDpi\\\": 750}\".", "default": "{ \"ConformanceLevel\": \"PdfA3a\", \"Version\": \"PDF_1_7\", \"ImageDpi\": 750 }" }, "docxSaveOptions": { "type": "string", "description": "JSON string for DOCX output customizations.", "default": "" }, "salesforce": { "type": "object", "properties": { "fileId": { "type": "string", "description": "ID of existing file (ContentDocument) to update/replace.", "default": "" }, "fileType": { "enum": [ "File", "Attachment" ], "type": "string", "description": "File handling capabilities in Salesforce (e.g., File, Attachment).", "default": "" }, "fileParentId": { "type": "string", "description": "Salesforce record to which the file is attached.", "default": "" }, "ownerId": { "type": "string", "description": "Salesforce user or queue ID who should own the file.", "default": "" } } }, "onedrive": { "type": "object", "properties": { "viewAnonymous": { "type": "boolean", "description": "Allow public viewing via link of the generated document.", "default": false }, "editAnonymous": { "type": "boolean", "description": "Allow public editing via link of the generated document.", "default": false }, "editUsers": { "type": "array", "items": { "type": "string", "default": "user@example.com" }, "description": "List of users for the link with edit access." }, "viewUsers": { "type": "array", "items": { "type": "string", "default": "user@example.com" }, "description": "List of users for the link with view access." } } } } } } } } }, "example": { "externalContext": { "id": "{{yourExternalContextId}}" }, "template": { "name": "{{templateName}}", "urn": "{{templateURN}}", "fileFormat": "docx", "loadMethod": "Storage", "options": { "docxLoadOptions": "{ \"PreserveUnsupportedFeatures\": true }" }, "relatedItems": [ { "name": "{{relatedTemplateName}}", "urn": "{{relatedTemplateURN}}", "fileFormat": "docx", "loadMethod": "Storage" } ] }, "data": { "loadMethod": "Storage", "urn": "{{dataURN}}", "variables": [ { "name": "createdDate", "value": "{!$now()}", "type": "fieldExpression" }, { "name": "requestId", "value": "{!requestId}", "type": "graphql" }, { "name": "customerName", "value": "Jane Doe", "type": "global" } ], "query": "{\"query\":\"{Account {Name Description Owner.Username Id Opportunities {StageName OpportunityLineItems {Name}} Contacts {Id}}}\"}", "embedded": "key:value" }, "document": { "timezone": "(GMT+00:00) Greenwich Mean Time (Europe/Dublin)", "locale": "en_IE_EURO", "name": "{{finalDocumentName}}", "fileFormat": "docx", "deliveryMethod": "Storage", "path": "root", "options": { "pdfSaveOptions": "{ \"ConformanceLevel\": \"PdfA3a\", \"Version\": \"PDF_1_7\", \"ImageDpi\": 750 }", "docxSaveOptions": "{}", "salesforce": { "fileId": "{{targetFileId}}", "fileType": "File", "fileParentId": "{{recordId}}", "ownerId": "{{ownerUserId}}" }, "onedrive": { "viewAnonymous": true, "editAnonymous": true, "editUsers": [ "user@example.com" ], "viewUsers": [ "user@example.com" ] }, "googleDrive": { "viewAnonymous": true, "editAnonymous": true, "editUsers": [ "user@example.com" ], "viewUsers": [ "user@example.com" ] }, "googleGenerate": { "nativeMergeEnabled": true, "nativeImageMergeEnabled": true } } } } } } }, "responses": { "201": { "description": "This response indicates that the document was successfully generated and delivered using the specified deliveryMethod. It includes metadata about the generated document (such as name, format, and unique URN), usage metrics (e.g., pages generated), and contextual information useful for tracking and auditing the operation.", "content": { "application/json": { "schema": { "required": [ "result", "consumption", "externalContext", "origin", "dateTime", "userId", "operationId" ], "type": "object", "properties": { "result": { "required": [ "statusCode", "message", "data" ], "type": "object", "properties": { "statusCode": { "enum": [ "201" ], "type": "string", "description": "Confirming the document was successfully created." }, "message": { "type": "string", "description": "A simple status message." }, "data": { "required": [ "document" ], "type": "object", "properties": { "document": { "required": [ "deliveryMethod", "name", "fileFormat", "urn" ], "type": "object", "properties": { "deliveryMethod": { "enum": [ "Salesforce", "Storage", "OneDrive" ], "type": "string", "description": "The source system where the generated document is stored." }, "name": { "type": "string", "description": "The name of the generated document (without file extension)." }, "fileFormat": { "enum": [ "docx", "xlsx", "pdf" ], "type": "string", "description": "The format of the generated document." }, "urn": { "type": "string", "description": "A unique identifier used to retrieve or reference the generated document." } } } } } } }, "consumption": { "type": "array", "items": { "required": [ "dimension", "value" ], "type": "object", "properties": { "dimension": { "enum": [ "pages-generated", "documents-generated" ], "type": "string", "description": "The type of resource consumed (e.g., pages-generated, documents-generated)." }, "value": { "type": "number", "description": "The measured quantity for the dimension." } } } }, "externalContext": { "required": [ "actionRequestId" ], "type": "object", "properties": { "actionRequestId": { "type": "string", "description": "External reference ID used for contextual tracking." } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the document generation request." }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the document generation was completed and the response returned.", "format": "date-time" }, "userId": { "type": "string", "description": "The unique identifier of the user or system that initiated the request." }, "operationId": { "type": "string", "description": "A system-generated ID that uniquely identifies this generation operation. Can be used for tracing, auditing, or support." } } }, "example": { "result": { "statusCode": "201", "message": "Created", "data": { "document": { "deliveryMethod": "{{deliveryMethod}}", "name": "{{documentName}}", "fileFormat": "{{fileFormat}}", "urn": "{{documentURN}}:{{documentName}}.{{fileFormat}}" } } }, "consumption": [ { "dimension": "pages-generated", "value": "" }, { "dimension": "documents-generated", "value": "" } ], "externalContext": { "actionRequestId": "{{externalContextId}}" }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}", "userId": "{{userId}}", "operationId": "{{operationId}}" } } } }, "400": { "description": "This response indicates that the request was invalid or improperly formed. It provides details about the error that occurred, including specific error codes, messages, and guidance for the user on how to resolve the issue.", "content": { "application/json": { "schema": { "required": [ "error", "externalContext", "origin", "dateTime", "userId", "operationId" ], "type": "object", "properties": { "error": { "required": [ "statusCode", "message", "innerErrors" ], "type": "object", "properties": { "statusCode": { "enum": [ "400" ], "type": "string", "description": "Indicating a bad request was made." }, "message": { "type": "string", "description": "A high-level description of the error." }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage", "eventId" ], "type": "object", "properties": { "code": { "type": "string", "description": "An error code indicating the type of issue encountered." }, "message": { "type": "string", "description": "A description of the specific error encountered." }, "userMessage": { "type": "string", "description": "A message intended for the end-user, advising on how to resolve the issue." }, "eventId": { "type": "string", "description": "A unique identifier for tracing the error in logs or debugging." } } } }, "externalErrors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code from the external service." }, "message": { "type": "string", "description": "A description of the external error." } }, "description": "Detailed list of errors originating from external services." } } } }, "externalContext": { "required": [ "actionRequestId" ], "type": "object", "properties": { "actionRequestId": { "type": "string", "description": "External reference ID used for contextual tracking." } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the document generation request." }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the response was returned.", "format": "date-time" }, "userId": { "type": "string", "description": "The unique identifier of the user or system that initiated the request." }, "operationId": { "type": "string", "description": "A system-generated ID that uniquely identifies this operation. Can be used for tracing, auditing, or support." } } }, "example": { "error": { "statusCode": "400", "message": "Bad Request", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}", "eventId": "{{eventId}}" } ], "externalErrors": [] }, "externalContext": { "actionRequestId": "{{externalContextId}}" }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}", "userId": "{{userId}}", "operationId": "{{operationId}}" } } } } } } }, "/documents/template/upload": { "post": { "tags": [ "Template" ], "summary": "Template Upload", "description": "This endpoint allows you to upload template files (e.g. DOCX, DOC, XLSX, XLS, PDF) to the Storage system. The maximum file size is 20MB in Production and 10MB in Staging environments. Once uploaded (only in form-data format), the template file is assigned an internal ID, which can be referenced in other requests, such as document generation. If multiple files are uploaded in a single request, the order in which they appear in the form-data (required body format) will be preserved. The uploaded template is automatically deleted from Storage after a document generation request is made—regardless of whether the request succeeds or fails. If you need to use the same template again, it must be uploaded again.", "operationId": "templates-upload", "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "responses": { "201": { "description": "This response confirms that the template file was successfully uploaded. It includes the internal Storage ID assigned to the uploaded template file, which can be used in subsequent requests that reference Storage as a template source.", "content": { "application/json": { "schema": { "required": [ "result", "origin", "dateTime", "operationId" ], "type": "object", "properties": { "result": { "required": [ "data", "statusCode", "message" ], "type": "object", "properties": { "data": { "required": [ "files" ], "type": "object", "properties": { "files": { "minItems": 1, "type": "array", "items": { "required": [ "id", "fileName" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the uploaded file.", "example": "{{uploadedFileId}}" }, "fileName": { "type": "string", "description": "Name of the uploaded file including extension.", "example": "{{uploadedFileName}}" } } }, "description": "Array of uploaded file objects." } } }, "statusCode": { "type": "integer", "description": "HTTP status code indicating the result of the upload operation.", "example": 201 }, "message": { "type": "string", "description": "Response message describing the outcome of the upload request.", "example": "Created" } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the upload request.", "example": "{{originEnvironment}}" }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the response was generated.", "format": "date-time", "example": "{{responseTimestamp}}" }, "operationId": { "type": "string", "description": "A system-generated ID that uniquely identifies this operation. Can be used for tracing, auditing, or support.", "example": "{{operationId}}" } } }, "example": { "result": { "data": { "files": [ { "id": "{{uploadedTemplateId}}", "fileName": "{{uploadedTemplateName}}" } ] }, "statusCode": 201, "message": "Created" }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}", "operationId": "{{operationId}}" } } } }, "400": { "description": "This response indicates that the uploaded file type is invalid or not supported. It includes detailed error information such as error codes, descriptive messages, and guidance on how to correct the issue.", "content": { "application/json": { "schema": { "required": [ "error", "origin", "dateTime" ], "type": "object", "properties": { "error": { "required": [ "statusCode", "message", "innerErrors" ], "type": "object", "properties": { "statusCode": { "enum": [ "400" ], "type": "string", "description": "Indicating a bad request was made." }, "message": { "type": "string", "description": "A high-level description of the error." }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage" ], "type": "object", "properties": { "code": { "type": "string", "description": "An error code indicating the type of issue encountered." }, "message": { "type": "string", "description": "A description of the specific error encountered." }, "userMessage": { "type": "string", "description": "A message intended for the end-user, advising on how to resolve the issue." } } } } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the document generation request." }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the response was returned.", "format": "date-time" } } }, "example": { "error": { "statusCode": "400", "message": "Bad Request", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}" } ] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}" } } } } } } }, "/documents/data/upload": { "post": { "tags": [ "Data" ], "summary": "Data Upload", "description": "This endpoint allows you to upload structured data (e.g. JSON) to the Storage system. The maximum file size is 20MB in Production and 10MB in Staging environments. Once uploaded, the data is assigned an internal ID, which can be referenced in other requests, such as document generation. The uploaded data is automatically deleted from Storage after a document generation request is made—regardless of whether the request succeeds or fails. If you need to use the same data again, it must be uploaded again.", "operationId": "data-upload", "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "responses": { "201": { "description": "This response confirms that the data was successfully uploaded. It includes the internal Storage ID assigned to the uploaded data, which can be used in subsequent requests that reference Storage as a data source.", "content": { "application/json": { "schema": { "required": [ "result", "origin", "dateTime", "operationId" ], "type": "object", "properties": { "result": { "required": [ "data", "statusCode", "message" ], "type": "object", "properties": { "data": { "required": [ "files" ], "type": "object", "properties": { "files": { "minItems": 1, "type": "array", "items": { "required": [ "id", "fileName" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the uploaded file.", "example": "{{uploadedFileId}}" }, "fileName": { "type": "string", "description": "Name of the uploaded file including extension.", "example": "{{uploadedFileName}}" } } }, "description": "Array of uploaded file objects." } } }, "statusCode": { "type": "integer", "description": "HTTP status code indicating the result of the upload operation.", "example": 201 }, "message": { "type": "string", "description": "Response message describing the outcome of the upload request.", "example": "Created" } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the upload request.", "example": "{{originEnvironment}}" }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the response was generated.", "format": "date-time", "example": "{{responseTimestamp}}" }, "operationId": { "type": "string", "description": "A system-generated ID that uniquely identifies this operation. Can be used for tracing, auditing, or support.", "example": "{{operationId}}" } } }, "example": { "result": { "data": { "files": [ { "id": "{{uploadedDataId}}", "fileName": "{{uploadedDataName}}" } ] }, "statusCode": 201, "message": "Created" }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}", "operationId": "{{operationId}}" } } } }, "400": { "description": "This response indicates that the uploaded file type is invalid or not supported. It includes detailed error information such as error codes, descriptive messages, and guidance on how to correct the issue.", "content": { "application/json": { "schema": { "required": [ "error", "origin", "dateTime" ], "type": "object", "properties": { "error": { "required": [ "statusCode", "message", "innerErrors" ], "type": "object", "properties": { "statusCode": { "enum": [ "400" ], "type": "string", "description": "Indicating a bad request was made." }, "message": { "type": "string", "description": "A high-level description of the error." }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage" ], "type": "object", "properties": { "code": { "type": "string", "description": "An error code indicating the type of issue encountered." }, "message": { "type": "string", "description": "A description of the specific error encountered." }, "userMessage": { "type": "string", "description": "A message intended for the end-user, advising on how to resolve the issue." } } } } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the document generation request." }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the response was returned.", "format": "date-time" } } }, "example": { "error": { "statusCode": "400", "message": "Bad Request", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}" } ] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}" } } } } } } }, "/documents/document/{documentId}/download": { "get": { "tags": [ "Document" ], "summary": "Document Download", "description": "This endpoint is used to download a previously generated document where delivery method was Storage using its unique URN. When called with a valid documentURN, it returns the final document file (e.g. PDF, DOCX, XLSX) as a binary response (octet-stream). The documentURN must refer to a document that has been successfully generated and stored in Storage system.", "operationId": "download-document", "parameters": [ { "name": "documentId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "This response returns the final document file (e.g. PDF, DOCX, XLSX) as a binary response (octet-stream).", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" }, "examples": { "document": { "summary": "Binary document stream", "description": "The binary content of the requested document (e.g., PDF)", "value": "The binary content of the requested document (e.g., PDF)" } } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "required": [ "error", "origin", "dateTime" ], "type": "object", "properties": { "error": { "required": [ "statusCode", "message", "innerErrors" ], "type": "object", "properties": { "statusCode": { "enum": [ "400" ], "type": "string", "description": "Indicating a bad request was made." }, "message": { "type": "string", "description": "A high-level description of the error." }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage" ], "type": "object", "properties": { "code": { "type": "string", "description": "An error code indicating the type of issue encountered." }, "message": { "type": "string", "description": "A description of the specific error encountered." }, "userMessage": { "type": "string", "description": "A message intended for the end-user, advising on how to resolve the issue." }, "urn": { "type": "string", "description": "URN sent in the request." } } } } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the document generation request." }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the response was returned.", "format": "date-time" } } }, "example": { "error": { "statusCode": "400", "message": "Bad Request", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}", "urn": "{{sentUrn}}" } ] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "required": [ "error", "origin", "dateTime" ], "type": "object", "properties": { "error": { "required": [ "statusCode", "message", "innerErrors" ], "type": "object", "properties": { "statusCode": { "enum": [ "404" ], "type": "string", "description": "Indicates that the requested document was not found." }, "message": { "type": "string", "description": "A high-level description of the error." }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage" ], "type": "object", "properties": { "code": { "type": "string", "description": "An error code indicating the type of issue encountered." }, "message": { "type": "string", "description": "A description of the specific error encountered." }, "userMessage": { "type": "string", "description": "A message intended for the end-user, advising on how to resolve the issue." } } } } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the document generation request." }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the response was returned.", "format": "date-time" } } }, "example": { "error": { "statusCode": "404", "message": "Not Found", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}" } ] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}" } } } } } } }, "/documents/document/merge/async": { "post": { "tags": [ "Document" ], "summary": "Document Merge Async", "description": "This endpoint initiates an asynchronous operation to merge multiple source documents into a single PDF, preserving the order specified in the request. Just like synchronous merge endpoint, it supports platforms like Storage, Salesforce, and OneDrive. Unlike the synchronous version, it returns immediately and processes the requested operation in the background. The result can be tracked or received via promise or callback, depending on your integration setup. This approach is ideal for handling large files, slower systems, or when non-blocking execution is preferred.", "operationId": "merge-async", "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } }, { "name": "X-Client-Authorization", "in": "header", "description": "Encrypted (AES) JWT token to identify and authorize the calling client system responsible for requesting the document generation. This header is required when retrieving the template and/or data used to populate the template from the client’s side, and for delivering the final generated document on the client’s side.", "schema": { "enum": [ "{{clientToken}}" ], "type": "string", "default": "{{clientToken}}" } }, { "name": "X-Service-Authorization", "in": "header", "description": "Encrypted (AES) JWT token to represent a user that doesn’t have a Microsoft Account and that is allowed to use the subscription.", "schema": { "enum": [ "{{secretToken}}" ], "type": "string", "default": "{{secretToken}}" } }, { "name": "X-Email", "in": "header", "description": "Email of the user who starts the process, needed for GAS script processing", "schema": { "enum": [ "{{email}}" ], "type": "string" } } ], "requestBody": { "description": "**externalContext**
\nA contextual reference used to link the document generation request to an external system, process, or transaction. Often used for traceability or auditing purposes.\n\n---\n\n**sourceDocuments**
\nIdentifies the input documents (e.g., Word, Excel, or PDF files) and their properties, serving as the inputs for the merge and conversion process to create a unified target document.\n\n---\n\n**targetDocument**
\nDefines the properties of the output document resulting from merging the source documents. It specifies the document’s metadata, format (typically PDF for merged outputs), delivery method, storage location, and processing options, determining how the merged document is saved and managed.\n\n**targetDocument.options.salesforce**
\nSpecifies how the document will be stored or associated with records in Salesforce. Includes fields such as `fileId`, `fileType`, `fileParentId`, and `ownerId`.\n\n**targetDocument.options.onedrive**
\nSpecifies how the document will be shared or stored via Microsoft OneDrive. Includes permission settings like anonymous access, edit/view rights, and user-specific sharing.", "content": { "application/json": { "schema": { "type": "object", "properties": { "externalContext": { "type": "object", "properties": { "id": { "type": "string", "description": "External reference ID used for contextual tracking.", "default": "12345" } } }, "sourceDocuments": { "type": "array", "items": { "required": [ "urn", "fileFormat", "loadMethod", "remove" ], "type": "object", "properties": { "urn": { "type": "string", "description": "URN of the source document stored in the system.", "default": "{{sourceDocumentId}}" }, "fileFormat": { "enum": [ "pdf" ], "type": "string", "description": "File format of the source document (e.g., pdf).", "default": "pdf" }, "loadMethod": { "enum": [ "Storage", "Salesforce", "OneDrive" ], "type": "string", "description": "Source of the document where it is stored (e.g., Storage, Salesforce, OneDrive).", "default": "Storage" }, "order": { "type": "integer", "description": "Order in which the document should be merged.", "default": 1 }, "remove": { "type": "string", "description": "Flag indicating whether to remove the source document after merging (e.g., none, delete, permanentDelete).", "default": "none" } } } }, "targetDocument": { "required": [ "name", "fileFormat", "deliveryMethod", "path" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the target document without file extension.", "default": "Document" }, "fileFormat": { "enum": [ "pdf" ], "type": "string", "description": "Format of the generated document (e.g., pdf).", "default": "pdf" }, "deliveryMethod": { "enum": [ "Storage", "Salesforce", "OneDrive" ], "type": "string", "description": "Place where the document will be stored (e.g., Storage, Salesforce, OneDrive).", "default": "Storage" }, "path": { "type": "string", "description": "Target folder or path for delivery. Optional based on storage provider.", "default": "" }, "options": { "type": "object", "properties": { "pdfSaveOptions": { "type": "string", "description": "JSON string for PDF output settings, default \"{\\\"ConformanceLevel\\\": \\\"PdfA3a\\\", \\\"Version\\\": \\\"PDF_1_7\\\", \\\"ImageDpi\\\": 750}\".", "default": "{ \"ConformanceLevel\": \"PdfA3a\", \"Version\": \"PDF_1_7\", \"ImageDpi\": 750 }" }, "salesforce": { "type": "object", "properties": { "networkId": { "type": "string", "description": "ID of specific Salesforce Experience Cloud site or community where the generated document should be stored or associated.", "default": "" }, "fileId": { "type": "string", "description": "ID of existing file (ContentDocument) to update/replace.", "default": "" }, "fileType": { "enum": [ "File", "Attachment" ], "type": "string", "description": "File handling capabilities in Salesforce (e.g., File, Attachment).", "default": "" }, "fileParentId": { "type": "string", "description": "Salesforce record to which the file is attached.", "default": "" }, "ownerId": { "type": "string", "description": "Salesforce user or queue ID who should own the file.", "default": "" } } }, "onedrive": { "type": "object", "properties": { "viewAnonymous": { "type": "boolean", "description": "Allow public viewing via link of the generated document.", "default": false }, "editAnonymous": { "type": "boolean", "description": "Allow public editing via link of the generated document.", "default": false }, "editUsers": { "type": "array", "items": { "type": "string", "default": "user@example.com" }, "description": "List of users for the link with edit access." }, "viewUsers": { "type": "array", "items": { "type": "string", "default": "user@example.com" }, "description": "List of users for the link with view access." } } } } } } }, "data": { "type": "object", "properties": { "embedded": { "type": "string", "description": "Arbitrary key-value pairs written into PDF document properties.", "default": "" } } } } }, "example": { "externalContext": { "id": "{{yourExternalContextId}}" }, "sourceDocuments": [ { "urn": "{{document1URN}}", "loadMethod": "Storage", "order": 1, "remove": "none" }, { "urn": "{{document2URN}}", "loadMethod": "Storage", "order": 2, "remove": "none" } ], "targetDocument": { "name": "{{documentName}}", "fileFormat": "pdf", "deliveryMethod": "Storage", "path": "root", "options": { "pdfSaveOptions": "{ \"ConformanceLevel\": \"PdfA3a\", \"Version\": \"PDF_1_7\", \"ImageDpi\": 750 }", "salesforce": { "networkId": "{{siteId}}", "fileId": "{{targetFileId}}", "fileType": "File", "fileParentId": "{{recordId}}", "ownerId": "{{ownerUserId}}" }, "onedrive": { "viewAnonymous": true, "editAnonymous": true, "editUsers": [ "user@example.com" ], "viewUsers": [ "user@example.com" ] } } }, "data": { "embedded": "key:value" } } } } }, "responses": { "201": { "description": "This response confirms that the merge operation was successfully completed. It returns metadata about the newly created PDF document, including its name, delivery method, file format, and a unique URN that can be used to reference or download the file. Additionally, it provides consumption details, such as the number of documents merged and total pages processed.", "content": { "application/json": { "schema": { "required": [ "result", "consumption", "externalContext", "origin", "dateTime", "userId", "operationId" ], "type": "object", "properties": { "result": { "required": [ "statusCode", "message", "data" ], "type": "object", "properties": { "statusCode": { "enum": [ "201" ], "type": "string", "description": "Confirming the document was successfully merged." }, "message": { "type": "string", "description": "A simple status message." }, "data": { "required": [ "document" ], "type": "object", "properties": { "document": { "required": [ "deliveryMethod", "name", "fileFormat", "urn" ], "type": "object", "properties": { "deliveryMethod": { "enum": [ "Salesforce", "Storage", "OneDrive" ], "type": "string", "description": "The source system where the merged document is stored." }, "name": { "type": "string", "description": "The name of the merged document (without file extension)." }, "fileFormat": { "enum": [ "docx", "xlsx", "pdf" ], "type": "string", "description": "The format of the merged document." }, "urn": { "type": "string", "description": "A unique identifier used to retrieve or reference the merged document." } } } } } } }, "consumption": { "type": "array", "items": { "required": [ "dimension", "value" ], "type": "object", "properties": { "dimension": { "enum": [ "pages-merged", "documents-merged" ], "type": "string", "description": "The type of resource consumed (e.g., pages-merged, documents-merged)." }, "value": { "type": "number", "description": "The measured quantity for the dimension." } } } }, "externalContext": { "required": [ "actionRequestId" ], "type": "object", "properties": { "actionRequestId": { "type": "string", "description": "External reference ID used for contextual tracking." } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the document merge request." }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the document merge was completed and the response returned.", "format": "date-time" }, "userId": { "type": "string", "description": "The unique identifier of the user or system that initiated the request." }, "operationId": { "type": "string", "description": "A system-generated ID that uniquely identifies this operation. Can be used for tracing, auditing, or support." } } }, "example": { "result": { "statusCode": "201", "message": "Created", "data": { "document": { "deliveryMethod": "{{deliveryMethod}}", "name": "{{documentName}}", "fileFormat": "{{fileFormat}}", "urn": "{{documentURN}}:{{documentName}}.{{fileFormat}}" } } }, "consumption": [ { "dimension": "pages-merged", "value": "" }, { "dimension": "documents-merged", "value": "" } ], "externalContext": { "actionRequestId": "{{externalContextId}}" }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}", "userId": "{{userId}}", "operationId": "{{operationId}}" } } } }, "400": { "description": "This response indicates that the merge request was invalid or improperly formed. It includes detailed error information such as status code, internal error codes, developer-facing messages, and user-friendly error descriptions to help diagnose the issue.", "content": { "application/json": { "schema": { "required": [ "error", "externalContext", "origin", "dateTime", "userId", "operationId" ], "type": "object", "properties": { "error": { "required": [ "statusCode", "message", "innerErrors" ], "type": "object", "properties": { "statusCode": { "enum": [ "400" ], "type": "string", "description": "Indicating a bad request was made." }, "message": { "type": "string", "description": "A high-level description of the error." }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage", "eventId" ], "type": "object", "properties": { "code": { "type": "string", "description": "An error code indicating the type of issue encountered." }, "message": { "type": "string", "description": "A description of the specific error encountered." }, "userMessage": { "type": "string", "description": "A message intended for the end-user, advising on how to resolve the issue." }, "eventId": { "type": "string", "description": "A unique identifier for tracing the error in logs or debugging." } } } }, "externalErrors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code from the external service." }, "message": { "type": "string", "description": "A description of the external error." } }, "description": "Detailed list of errors originating from external services." } } } }, "externalContext": { "required": [ "actionRequestId" ], "type": "object", "properties": { "actionRequestId": { "type": "string", "description": "External reference ID used for contextual tracking." } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the document merge request." }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the response was returned.", "format": "date-time" }, "userId": { "type": "string", "description": "The unique identifier of the user or system that initiated the request." }, "operationId": { "type": "string", "description": "A system-generated ID that uniquely identifies this operation. Can be used for tracing, auditing, or support." } } }, "example": { "error": { "statusCode": "400", "message": "Bad Request", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}", "eventId": "{{eventId}}" } ], "externalErrors": [] }, "externalContext": { "actionRequestId": "{{externalContextId}}" }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}", "userId": "{{userId}}", "operationId": "{{operationId}}" } } } } } } }, "/documents/document/manage/async": { "post": { "tags": [ "Document" ], "summary": "Document Manage Async", "description": "This endpoint allows you to initiate asynchronous document management operations, such as copying, moving, deleting (currently only supports OneDrive), or converting documents, across platforms like Storage, Salesforce, and OneDrive, without modifying their internal content. Unlike the synchronous version, it returns immediately and processes the requested operation in the background. The result can be tracked or received via promise or callback, depending on your integration setup. This approach is ideal for handling large files, slower systems, or when non-blocking execution is preferred.", "operationId": "manage-async", "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } }, { "name": "X-Client-Authorization", "in": "header", "description": "Encrypted (AES) JWT token to identify and authorize the calling client system responsible for requesting the document generation. This header is required when retrieving the template and/or data used to populate the template from the client’s side, and for delivering the final generated document on the client’s side.", "schema": { "enum": [ "{{clientToken}}" ], "type": "string", "default": "{{clientToken}}" } }, { "name": "X-Service-Authorization", "in": "header", "description": "Encrypted (AES) JWT token to represent a user that doesn’t have a Microsoft Account and that is allowed to use the subscription.", "schema": { "enum": [ "{{secretToken}}" ], "type": "string", "default": "{{secretToken}}" } }, { "name": "X-Email", "in": "header", "description": "Email of the user who starts the process, needed for GAS script processing", "schema": { "enum": [ "{{email}}" ], "type": "string" } } ], "requestBody": { "description": "**externalContext**
\nA contextual reference used to link the document generation request to an external system, process, or transaction. Often used for traceability or auditing purposes.\n\n---\n\n**sourceDocument**
\nIdentifies the input document and its properties, serving as the starting point for file operations like copying to a new location, moving with deletion, deleting outright, or converting to a different format.\n\n**sourceDocument.options**
\nFine-tunes the loading process for the source document to meet specific requirements, such as retaining formatting or handling special features during operations like copying or conversion.\n\n---\n\n**targetDocument**
\nDefines the properties of the output document resulting from the file operation (e.g., the destination for Copy, Move, or Convert operations). It specifies the document’s metadata, format, delivery method, storage location, and processing options, determining how the processed document is saved and managed. This node is omitted for Delete operations, as no output document is generated.\n\n**targetDocument.options.salesforce**
\nSpecifies how the document will be stored or associated with records in Salesforce. Includes fields such as `fileId`, `fileType`, `fileParentId`, and `ownerId`.\n\n**targetDocument.options.onedrive**
\nSpecifies how the document will be shared or stored via Microsoft OneDrive. Includes permission settings like anonymous access, edit/view rights, and user-specific sharing.\n\n**document.options.googledrive**
\nSpecifies how the document will be shared or stored via Google Drive. Includes permission settings like anonymous access, edit/view rights, and user-specific sharing.", "content": { "application/json": { "schema": { "type": "object", "properties": { "externalContext": { "type": "object", "properties": { "id": { "type": "string", "description": "External reference ID used for contextual tracking.", "default": "12345" } } }, "sourceDocument": { "required": [ "urn", "fileFormat", "loadMethod", "remove" ], "type": "object", "properties": { "urn": { "type": "string", "description": "URN of the source document stored in the system.", "default": "{{generateDocumentTemplateId}}" }, "fileFormat": { "enum": [ "docx", "xlsx", "pdf" ], "type": "string", "description": "File format of the source document (e.g., docx, xlsx, pdf).", "default": "xlsx" }, "loadMethod": { "enum": [ "Storage", "Salesforce", "OneDrive" ], "type": "string", "description": "Source of the document where it is store (e.g., Storage, Salesforce, OneDrive).", "default": "Storage" }, "remove": { "type": "string", "description": "Flag indicating whether to remove the source document (e.g., none, delete, permanentDelete).", "default": "none" }, "options": { "type": "object", "properties": { "docxLoadOptions": { "type": "string", "description": "JSON string for DOCX load options, default \"{\\\"PreserveUnsupportedFeatures\\\": true}\".", "default": "{ \"PreserveUnsupportedFeatures\": true }" } } } } }, "targetDocument": { "required": [ "name", "fileFormat", "deliveryMethod", "path" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the target document without file extension.", "default": "Document" }, "fileFormat": { "enum": [ "docx", "xlsx", "pdf" ], "type": "string", "description": "Format of the generated document (e.g., docx, xlsx, pdf).", "default": "xlsx" }, "deliveryMethod": { "enum": [ "Storage", "Salesforce", "OneDrive" ], "type": "string", "description": "Place where the document will be stored (e.g., Storage, Salesforce, OneDrive).", "default": "Storage" }, "path": { "type": "string", "description": "Target folder or path for delivery. Optional based on storage provider.", "default": "" }, "options": { "type": "object", "properties": { "pdfSaveOptions": { "type": "string", "description": "JSON string for PDF output settings, default \"{\\\"ConformanceLevel\\\": \\\"PdfA3a\\\", \\\"Version\\\": \\\"PDF_1_7\\\", \\\"ImageDpi\\\": 750}\".", "default": "{ \"ConformanceLevel\": \"PdfA3a\", \"Version\": \"PDF_1_7\", \"ImageDpi\": 750 }" }, "docxSaveOptions": { "type": "string", "description": "JSON string for DOCX output customizations.", "default": "" }, "salesforce": { "type": "object", "properties": { "networkId": { "type": "string", "description": "ID of specific Salesforce Experience Cloud site or community where the generated document should be stored or associated.", "default": "" }, "fileId": { "type": "string", "description": "ID of existing file (ContentDocument) to update/replace.", "default": "" }, "fileType": { "enum": [ "File", "Attachment" ], "type": "string", "description": "File handling capabilities in Salesforce (e.g., File, Attachment).", "default": "" }, "fileParentId": { "type": "string", "description": "Salesforce record to which the file is attached.", "default": "" }, "ownerId": { "type": "string", "description": "Salesforce user or queue ID who should own the file.", "default": "" } } }, "onedrive": { "type": "object", "properties": { "viewAnonymous": { "type": "boolean", "description": "Allow public viewing via link of the generated document.", "default": false }, "editAnonymous": { "type": "boolean", "description": "Allow public editing via link of the generated document.", "default": false }, "editUsers": { "type": "array", "items": { "type": "string", "default": "user@example.com" }, "description": "List of users for the link with edit access." }, "viewUsers": { "type": "array", "items": { "type": "string", "default": "user@example.com" }, "description": "List of users for the link with view access." } } } } } } }, "data": { "type": "object", "properties": { "embedded": { "type": "string", "description": "Arbitrary key-value pairs written into PDF document properties.", "default": "" } } } } }, "example": { "externalContext": { "id": "{{yourExternalContextId}}" }, "sourceDocument": { "urn": "{{documentURN}}", "fileFormat": "docx", "loadMethod": "Storage", "remove": "none", "options": { "docxLoadOptions": "{ \"PreserveUnsupportedFeatures\": true }" } }, "targetDocument": { "name": "{{documentName}}", "fileFormat": "docx", "deliveryMethod": "Storage", "path": "root", "options": { "pdfSaveOptions": "{ \"ConformanceLevel\": \"PdfA3a\", \"Version\": \"PDF_1_7\", \"ImageDpi\": 750 }", "docxSaveOptions": "{}", "salesforce": { "networkId": "{{siteId}}", "fileId": "{{targetFileId}}", "fileType": "File", "fileParentId": "{{recordId}}", "ownerId": "{{ownerUserId}}" }, "onedrive": { "viewAnonymous": true, "editAnonymous": true, "editUsers": [ "user@example.com" ], "viewUsers": [ "user@example.com" ] }, "googleDrive": { "viewAnonymous": true, "editAnonymous": true, "editUsers": [ "user@example.com" ], "viewUsers": [ "user@example.com" ] } } }, "data": { "embedded": "key:value" } } } } }, "responses": { "201": { "description": "This response confirms that the document management operation (such as copy, move, delete, or convert) was successfully completed. It returns metadata about the resulting document, including its name, format, storage location, and URN. The response also includes consumption metrics indicating how many documents and pages were processed, which are relevant for billing or quotas.", "content": { "application/json": { "schema": { "required": [ "result", "consumption", "externalContext", "origin", "dateTime", "userId", "operationId" ], "type": "object", "properties": { "result": { "required": [ "statusCode", "message", "data" ], "type": "object", "properties": { "statusCode": { "enum": [ "201" ], "type": "string", "description": "Confirming the document was successfully managed." }, "message": { "type": "string", "description": "A simple status message." }, "data": { "required": [ "document" ], "type": "object", "properties": { "document": { "required": [ "deliveryMethod", "name", "fileFormat", "urn" ], "type": "object", "properties": { "deliveryMethod": { "enum": [ "Salesforce", "Storage", "OneDrive" ], "type": "string", "description": "The source system where the managed document is stored." }, "name": { "type": "string", "description": "The name of the managed document (without file extension)." }, "fileFormat": { "enum": [ "docx", "xlsx", "pdf" ], "type": "string", "description": "The format of the managed document." }, "urn": { "type": "string", "description": "A unique identifier used to retrieve or reference the managed document." } } } } } } }, "consumption": { "type": "array", "items": { "required": [ "dimension", "value" ], "type": "object", "properties": { "dimension": { "enum": [ "pages-managed", "documents-managed" ], "type": "string", "description": "The type of resource consumed (e.g., pages-managed, documents-managed)." }, "value": { "type": "number", "description": "The measured quantity for the dimension." } } } }, "externalContext": { "required": [ "actionRequestId" ], "type": "object", "properties": { "actionRequestId": { "type": "string", "description": "External reference ID used for contextual tracking." } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the request." }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the document manage was completed and the response returned.", "format": "date-time" }, "userId": { "type": "string", "description": "The unique identifier of the user or system that initiated the request." }, "operationId": { "type": "string", "description": "A system-generated ID that uniquely identifies this operation. Can be used for tracing, auditing, or support." } } }, "example": { "result": { "statusCode": "201", "message": "Created", "data": { "document": { "deliveryMethod": "{{deliveryMethod}}", "name": "{{documentName}}", "fileFormat": "{{fileFormat}}", "urn": "{{documentURN}}:{{documentName}}.{{fileFormat}}" } } }, "consumption": [ { "dimension": "pages-managed", "value": "" }, { "dimension": "documents-managed", "value": "" } ], "externalContext": { "actionRequestId": "{{externalContextId}}" }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}", "userId": "{{userId}}", "operationId": "{{operationId}}" } } } }, "400": { "description": "This response indicates that the request was malformed or invalid due to missing or unsupported parameters, such as an incorrect file format or improperly structured payload. It includes detailed error information with specific error codes, messages, and a user-friendly explanation to help diagnose the issue.", "content": { "application/json": { "schema": { "required": [ "error", "externalContext", "origin", "dateTime", "userId", "operationId" ], "type": "object", "properties": { "error": { "required": [ "statusCode", "message", "innerErrors" ], "type": "object", "properties": { "statusCode": { "enum": [ "400" ], "type": "string", "description": "Indicating a bad request was made." }, "message": { "type": "string", "description": "A high-level description of the error." }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage", "eventId" ], "type": "object", "properties": { "code": { "type": "string", "description": "An error code indicating the type of issue encountered." }, "message": { "type": "string", "description": "A description of the specific error encountered." }, "userMessage": { "type": "string", "description": "A message intended for the end-user, advising on how to resolve the issue." }, "eventId": { "type": "string", "description": "A unique identifier for tracing the error in logs or debugging." } } } }, "externalErrors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code from the external service." }, "message": { "type": "string", "description": "A description of the external error." } }, "description": "Detailed list of errors originating from external services." } } } }, "externalContext": { "required": [ "actionRequestId" ], "type": "object", "properties": { "actionRequestId": { "type": "string", "description": "External reference ID used for contextual tracking." } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the document manage request." }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the response was returned.", "format": "date-time" }, "userId": { "type": "string", "description": "The unique identifier of the user or system that initiated the request." }, "operationId": { "type": "string", "description": "A system-generated ID that uniquely identifies this operation. Can be used for tracing, auditing, or support." } } }, "example": { "error": { "statusCode": "400", "message": "Bad Request", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}", "eventId": "{{eventId}}" } ], "externalErrors": [] }, "externalContext": { "actionRequestId": "{{externalContextId}}" }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}", "userId": "{{userId}}", "operationId": "{{operationId}}" } } } } } } }, "/documents/document/upload": { "post": { "tags": [ "Document" ], "summary": "Document Upload", "description": "This endpoint allows you to upload DOCX and PDF files to Storage, serving as a general-purpose document upload mechanism. The maximum file size for upload is 20MB in Production and 10MB in Staging environments. Once uploaded, each document is assigned a unique URN that can be referenced in processes like Document Merge. If multiple files are uploaded in a single request, the order in which they appear in the form-data will be preserved.", "operationId": "document-upload", "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "responses": { "201": { "description": "This is the response returned when a document is successfully uploaded to Storage. The uploaded document is stored and assigned a unique id (URN), which can then be used later for signing operations (e.g., as part of an envelope). This response confirms that the upload operation completed successfully.", "content": { "application/json": { "schema": { "required": [ "result", "origin", "dateTime", "operationId" ], "type": "object", "properties": { "result": { "required": [ "data", "statusCode", "message" ], "type": "object", "properties": { "data": { "required": [ "files" ], "type": "object", "properties": { "files": { "minItems": 1, "type": "array", "items": { "required": [ "id", "fileName" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the uploaded file.", "example": "{{uploadedFileId}}" }, "fileName": { "type": "string", "description": "Name of the uploaded file including extension.", "example": "{{uploadedFileName}}" } } }, "description": "Array of uploaded file objects." } } }, "statusCode": { "type": "integer", "description": "HTTP status code indicating the result of the upload operation.", "example": 201 }, "message": { "type": "string", "description": "Response message describing the outcome of the upload request.", "example": "Created" } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the upload request.", "example": "{{originEnvironment}}" }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the response was generated.", "format": "date-time", "example": "{{responseTimestamp}}" }, "operationId": { "type": "string", "description": "A system-generated ID that uniquely identifies this operation. Can be used for tracing, auditing, or support.", "example": "{{operationId}}" } } }, "example": { "result": { "data": { "files": [ { "id": "{{uploadedFileId}}", "fileName": "{{uploadedFileName}}" } ] }, "statusCode": 201, "message": "Created" }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}", "operationId": "{{operationId}}" } } } } } } }, "/documents/document/reference": { "post": { "tags": [ "Document" ], "summary": "Document Reference", "description": "Document Reference", "operationId": "document-reference", "responses": { "200": { "description": "" } } } }, "/documents/datasource/create": { "post": { "tags": [ "Data Source" ], "summary": "Data Source Create", "description": "Creates a new data source configuration to be used in document generation.", "operationId": "data-source-create", "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request.", "required": true, "schema": { "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access.", "required": true, "schema": { "type": "string", "default": "{{apiKey}}" } } ], "requestBody": { "description": "The data source object to be created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSourceModel" }, "example": { "dataSourceGuid": "string", "subscriptionGuid": "string", "ownerGuid": "string", "lastModifiedUserGuid": "string", "name": "string", "description": "string", "urn": "string", "query": "string", "variables": "string", "loadMethod": "string", "createdDate": "string", "lastModifiedDate": "string", "isDeleted": true } } } }, "responses": { "200": { "description": "Data source created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSourceModel" }, "example": { "dataSourceGuid": "string", "subscriptionGuid": "string", "ownerGuid": "string", "lastModifiedUserGuid": "string", "name": "string", "description": "string", "urn": "string", "query": "string", "variables": "string", "loadMethod": "string", "createdDate": "string", "lastModifiedDate": "string", "isDeleted": true } } } } } } }, "/documents/document/create": { "post": { "tags": [ "Document" ], "summary": "Document Create", "description": "Creates a new document record or metadata entry in the system.", "operationId": "document-create", "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request.", "required": true, "schema": { "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access.", "required": true, "schema": { "type": "string", "default": "{{apiKey}}" } } ], "requestBody": { "description": "The document object to be created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentModel" }, "example": { "documentGuid": "string", "subscriptionGuid": "string", "ownerGuid": "string", "lastModifiedUserGuid": "string", "title": "string", "urn": "string", "url": "string", "path": "string", "fileFormat": "string", "deliveryMethod": "string", "viewAnonymousLink": "string", "editAnonymousLink": "string", "viewUserLink": "string", "editUserLink": "string", "viewOrganizationLink": "string", "editOrganizationLink": "string", "succeededViewUserEmailList": "string", "succeededEditUserEmailList": "string", "failedViewUserEmailList": "string", "failedEditUserEmailList": "string", "createdDate": "string", "lastModifiedDate": "string", "isDeleted": true } } } }, "responses": { "200": { "description": "Document record created successfully.", "content": { "application/json": { "schema": { "type": "object", "properties": { "document": { "type": "object", "properties": { "documentGuid": { "type": "string", "format": "uuid" }, "subscriptionGuid": { "type": "string", "format": "uuid" }, "ownerGuid": { "type": "string", "format": "uuid" }, "lastModifiedUserGuid": { "type": "string", "format": "uuid" }, "title": { "type": "string", "nullable": true }, "urn": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "path": { "type": "string", "nullable": true }, "fileFormat": { "type": "string", "nullable": true }, "deliveryMethod": { "type": "string", "nullable": true }, "viewAnonymousLink": { "type": "string", "nullable": true }, "editAnonymousLink": { "type": "string", "nullable": true }, "viewUserLink": { "type": "string", "nullable": true }, "editUserLink": { "type": "string", "nullable": true }, "viewOrganizationLink": { "type": "string", "nullable": true }, "editOrganizationLink": { "type": "string", "nullable": true }, "succeededViewUserEmailList": { "type": "string", "nullable": true }, "succeededEditUserEmailList": { "type": "string", "nullable": true }, "failedViewUserEmailList": { "type": "string", "nullable": true }, "failedEditUserEmailList": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "lastModifiedDate": { "type": "string", "format": "date-time" }, "isDeleted": { "type": "boolean" } } } } }, "example": { "document": { "documentGuid": "string", "subscriptionGuid": "string", "ownerGuid": "string", "lastModifiedUserGuid": "string", "title": "string", "urn": "string", "url": "string", "path": "string", "fileFormat": "string", "deliveryMethod": "string", "viewAnonymousLink": "string", "editAnonymousLink": "string", "viewUserLink": "string", "editUserLink": "string", "viewOrganizationLink": "string", "editOrganizationLink": "string", "succeededViewUserEmailList": "string", "succeededEditUserEmailList": "string", "failedViewUserEmailList": "string", "failedEditUserEmailList": "string", "createdDate": "string", "lastModifiedDate": "string", "isDeleted": true } } } } } } } }, "/documents/request/create": { "post": { "tags": [ "Document Request" ], "summary": "Document Request Create", "description": "Initializes a new document generation request, allowing for tracking of the generation lifecycle.", "operationId": "request-create", "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request.", "required": true, "schema": { "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access.", "required": true, "schema": { "type": "string", "default": "{{apiKey}}" } } ], "requestBody": { "description": "The document request object to be created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentRequestModel" }, "example": { "documentRequestGuid": "string", "subscriptionGuid": "string", "documentTemplateGuid": "string", "dataGuid": "string", "documentGuid": "string", "documentSolutionConfigurationGuid": "string", "ownerGuid": "string", "lastModifiedUserGuid": "string", "recordId": "string", "name": "string", "status": "string", "embeddedData": "string", "title": "string", "fileFormat": "string", "processingType": "string", "deliveryMethod": "string", "path": "string", "pdfConformanceLevel": "string", "pdfVersion": "string", "language": "string", "locale": "string", "timeZone": "string", "viewAnonymous": true, "editAnonymous": true, "viewOrganization": true, "editOrganization": true, "viewUser": true, "editUser": true, "viewUserEmailList": "string", "editUserEmailList": "string", "createdDate": "string", "completedDate": "string", "lastModifiedDate": "string", "isDeleted": true } } } }, "responses": { "200": { "description": "Document request created successfully.", "content": { "application/json": { "schema": { "type": "object", "properties": { "documentRequest": { "type": "object", "properties": { "documentRequestGuid": { "type": "string", "format": "uuid" }, "subscriptionGuid": { "type": "string", "format": "uuid" }, "documentTemplateGuid": { "type": "string", "format": "uuid" }, "dataGuid": { "type": "string", "format": "uuid" }, "documentGuid": { "type": "string", "format": "uuid", "nullable": true }, "documentSolutionConfigurationGuid": { "type": "string", "format": "uuid", "nullable": true }, "ownerGuid": { "type": "string", "format": "uuid" }, "lastModifiedUserGuid": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "embeddedData": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "fileFormat": { "type": "string", "nullable": true }, "processingType": { "type": "string", "nullable": true }, "deliveryMethod": { "type": "string", "nullable": true }, "path": { "type": "string", "nullable": true }, "pdfConformanceLevel": { "type": "string", "nullable": true }, "pdfVersion": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "locale": { "type": "string", "nullable": true }, "timeZone": { "type": "string", "nullable": true }, "viewAnonymous": { "type": "boolean" }, "editAnonymous": { "type": "boolean" }, "viewOrganization": { "type": "boolean" }, "editOrganization": { "type": "boolean" }, "viewUser": { "type": "boolean" }, "editUser": { "type": "boolean" }, "viewUserEmailList": { "type": "string", "nullable": true }, "editUserEmailList": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "completedDate": { "type": "string", "format": "date-time", "nullable": true }, "lastModifiedDate": { "type": "string", "format": "date-time", "nullable": true }, "isDeleted": { "type": "boolean" } } } } }, "example": { "documentRequest": { "documentRequestGuid": "string", "subscriptionGuid": "string", "documentTemplateGuid": "string", "dataGuid": "string", "documentGuid": "string", "documentSolutionConfigurationGuid": "string", "ownerGuid": "string", "lastModifiedUserGuid": "string", "recordId": "string", "name": "string", "status": "string", "embeddedData": "string", "title": "string", "fileFormat": "string", "processingType": "string", "deliveryMethod": "string", "path": "string", "pdfConformanceLevel": "string", "pdfVersion": "string", "language": "string", "locale": "string", "timeZone": "string", "viewAnonymous": true, "editAnonymous": true, "viewOrganization": true, "editOrganization": true, "viewUser": true, "editUser": true, "viewUserEmailList": "string", "editUserEmailList": "string", "createdDate": "string", "completedDate": "string", "lastModifiedDate": "string", "isDeleted": true } } } } } } } }, "/documents/configuration/create": { "post": { "tags": [ "Document Solution Configuration" ], "summary": "Document Solution Configuration Create", "description": "Creates a new document solution configuration profile.", "operationId": "configuration-create", "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request.", "required": true, "schema": { "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access.", "required": true, "schema": { "type": "string", "default": "{{apiKey}}" } } ], "requestBody": { "description": "The configuration object to be created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentSolutionConfigurationModel" }, "example": { "documentSolutionConfigurationGuid": "string", "documentSolutionGuid": "string", "subscriptionGuid": "string", "ownerGuid": "string", "lastModifiedUserGuid": "string", "name": "string", "description": "string", "title": "string", "fileFormat": "string", "processingType": "string", "deliveryMethod": "string", "path": "string", "pdfConformanceLevel": "string", "pdfVersion": "string", "language": "string", "locale": "string", "timeZone": "string", "embeddedData": "string", "viewAnonymous": true, "editAnonymous": true, "viewOrganization": true, "editOrganization": true, "viewUser": true, "editUser": true, "viewUserEmailList": "string", "editUserEmailList": "string", "createdDate": "string", "lastModifiedDate": "string", "isDeleted": true } } } }, "responses": { "200": { "description": "Configuration profile created successfully.", "content": { "application/json": { "schema": { "type": "object", "properties": { "documentSolutionConfiguration": { "type": "object", "properties": { "documentSolutionConfigurationGuid": { "type": "string", "format": "uuid" }, "documentSolutionGuid": { "type": "string", "format": "uuid" }, "subscriptionGuid": { "type": "string", "format": "uuid" }, "ownerGuid": { "type": "string", "format": "uuid" }, "lastModifiedUserGuid": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "fileFormat": { "type": "string", "nullable": true }, "processingType": { "type": "string", "nullable": true }, "deliveryMethod": { "type": "string", "nullable": true }, "path": { "type": "string", "nullable": true }, "pdfConformanceLevel": { "type": "string", "nullable": true }, "pdfVersion": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "locale": { "type": "string", "nullable": true }, "timeZone": { "type": "string", "nullable": true }, "embeddedData": { "type": "string", "nullable": true }, "viewAnonymous": { "type": "boolean" }, "editAnonymous": { "type": "boolean" }, "viewOrganization": { "type": "boolean" }, "editOrganization": { "type": "boolean" }, "viewUser": { "type": "boolean" }, "editUser": { "type": "boolean" }, "viewUserEmailList": { "type": "string", "nullable": true }, "editUserEmailList": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "lastModifiedDate": { "type": "string", "format": "date-time" }, "isDeleted": { "type": "boolean" } } } } }, "example": { "documentSolutionConfiguration": { "documentSolutionConfigurationGuid": "string", "documentSolutionGuid": "string", "subscriptionGuid": "string", "ownerGuid": "string", "lastModifiedUserGuid": "string", "name": "string", "description": "string", "title": "string", "fileFormat": "string", "processingType": "string", "deliveryMethod": "string", "path": "string", "pdfConformanceLevel": "string", "pdfVersion": "string", "language": "string", "locale": "string", "timeZone": "string", "embeddedData": "string", "viewAnonymous": true, "editAnonymous": true, "viewOrganization": true, "editOrganization": true, "viewUser": true, "editUser": true, "viewUserEmailList": "string", "editUserEmailList": "string", "createdDate": "string", "lastModifiedDate": "string", "isDeleted": true } } } } } } } }, "/documents/solution/create": { "post": { "tags": [ "Document Solution" ], "summary": "Document Solution Create", "description": "Creates a new document solution grouping.", "operationId": "solution-create", "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request.", "required": true, "schema": { "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access.", "required": true, "schema": { "type": "string", "default": "{{apiKey}}" } } ], "requestBody": { "description": "The document solution object to be created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentSolutionModel" }, "example": { "documentSolutionGuid": "string", "subscriptionGuid": "string", "ownerGuid": "string", "lastModifiedUserGuid": "string", "dataGuid": "string", "name": "string", "description": "string", "createdDate": "string", "lastModifiedDate": "string", "isDeleted": true } } } }, "responses": { "200": { "description": "Document solution created successfully.", "content": { "application/json": { "schema": { "type": "object", "properties": { "documentSolution": { "type": "object", "properties": { "documentSolutionGuid": { "type": "string", "format": "uuid", "nullable": true }, "subscriptionGuid": { "type": "string", "format": "uuid", "nullable": true }, "ownerGuid": { "type": "string", "format": "uuid", "nullable": true }, "lastModifiedUserGuid": { "type": "string", "format": "uuid", "nullable": true }, "dataGuid": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "lastModifiedDate": { "type": "string", "format": "date-time" }, "isDeleted": { "type": "boolean" } } } } }, "example": { "documentSolution": { "documentSolutionGuid": "string", "subscriptionGuid": "string", "ownerGuid": "string", "lastModifiedUserGuid": "string", "dataGuid": "string", "name": "string", "description": "string", "createdDate": "string", "lastModifiedDate": "string", "isDeleted": true } } } } } } } }, "/documents/template/create": { "post": { "tags": [ "Template" ], "summary": "Template Create", "description": "Creates a new template definition or metadata record.", "operationId": "template-create", "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request.", "required": true, "schema": { "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access.", "required": true, "schema": { "type": "string", "default": "{{apiKey}}" } } ], "requestBody": { "description": "The template object to be created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentTemplateModel" }, "example": { "documentTemplateGuid": "string", "subscriptionGuid": "string", "ownerGuid": "string", "lastModifiedUserGuid": "string", "name": "string", "description": "string", "title": "string", "urn": "string", "url": "string", "viewAnonymousLink": "string", "editAnonymousLink": "string", "viewUserLink": "string", "editUserLink": "string", "viewOrganizationLink": "string", "editOrganizationLink": "string", "fileFormat": "string", "loadMethod": "string", "path": "string", "createdDate": "string", "lastModifiedDate": "string", "isDeleted": true } } } }, "responses": { "200": { "description": "Template definition created successfully.", "content": { "application/json": { "schema": { "type": "object", "properties": { "documentTemplate": { "type": "object", "properties": { "documentTemplateGuid": { "type": "string", "format": "uuid" }, "subscriptionGuid": { "type": "string", "format": "uuid" }, "ownerGuid": { "type": "string", "format": "uuid" }, "lastModifiedUserGuid": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "urn": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "viewAnonymousLink": { "type": "string", "nullable": true }, "editAnonymousLink": { "type": "string", "nullable": true }, "viewUserLink": { "type": "string", "nullable": true }, "editUserLink": { "type": "string", "nullable": true }, "viewOrganizationLink": { "type": "string", "nullable": true }, "editOrganizationLink": { "type": "string", "nullable": true }, "fileFormat": { "type": "string", "nullable": true }, "loadMethod": { "type": "string", "nullable": true }, "path": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "lastModifiedDate": { "type": "string", "format": "date-time" }, "isDeleted": { "type": "boolean" } } } } }, "example": { "documentTemplate": { "documentTemplateGuid": "string", "subscriptionGuid": "string", "ownerGuid": "string", "lastModifiedUserGuid": "string", "name": "string", "description": "string", "title": "string", "urn": "string", "url": "string", "viewAnonymousLink": "string", "editAnonymousLink": "string", "viewUserLink": "string", "editUserLink": "string", "viewOrganizationLink": "string", "editOrganizationLink": "string", "fileFormat": "string", "loadMethod": "string", "path": "string", "createdDate": "string", "lastModifiedDate": "string", "isDeleted": true } } } } } } } }, "/documents/option/{entityType}/{entityId}/create": { "post": { "tags": [ "Option Value" ], "summary": "Document Option Value Create", "description": "Creates a new configuration option value scoped to a specific entity type and entity ID.", "operationId": "option-value-create", "parameters": [ { "name": "entityType", "in": "path", "description": "The type of entity the option belongs to.", "required": true, "schema": { "type": "string" } }, { "name": "entityId", "in": "path", "description": "The unique identifier (GUID) of the entity.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request.", "required": true, "schema": { "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access.", "required": true, "schema": { "type": "string", "default": "{{apiKey}}" } } ], "requestBody": { "description": "The option value object to be created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OptionValueModel" }, "example": { "optionValueGuid": "string", "entityType": "string", "entityId": "string", "optionDefinitionId": 0, "customKey": "string", "customGroup": "string", "value": "string", "effectiveKey": "string", "effectiveGroup": "string", "systemType": "string", "createdDate": "string", "lastModifiedDate": "string" } } } }, "responses": { "200": { "description": "Option value created successfully.", "content": { "application/json": { "schema": { "type": "object", "properties": { "optionValue": { "type": "object", "properties": { "optionValueGuid": { "type": "string", "format": "uuid" }, "entityType": { "type": "string", "nullable": true }, "entityId": { "type": "string", "format": "uuid" }, "optionDefinitionId": { "type": "integer", "nullable": true }, "customKey": { "type": "string", "nullable": true }, "customGroup": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "effectiveKey": { "type": "string", "nullable": true }, "effectiveGroup": { "type": "string", "nullable": true }, "systemType": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "lastModifiedDate": { "type": "string", "format": "date-time" } } } } }, "example": { "optionValue": { "optionValueGuid": "string", "entityType": "string", "entityId": "string", "optionDefinitionId": 0, "customKey": "string", "customGroup": "string", "value": "string", "effectiveKey": "string", "effectiveGroup": "string", "systemType": "string", "createdDate": "string", "lastModifiedDate": "string" } } } } } } } }, "/documents/datasource/{dataSourceGuid}/delete": { "delete": { "tags": [ "Data Source" ], "summary": "Data Source Delete", "description": "Deletes a specific data source configuration from the system.", "operationId": "data-source-delete", "parameters": [ { "name": "dataSourceGuid", "in": "path", "description": "The unique identifier (GUID) of the data source to delete.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request.", "required": true, "schema": { "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access.", "required": true, "schema": { "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "Data source deleted successfully.", "content": { "application/json": { "schema": { "type": "object", "properties": { "dataSourceGuid": { "type": "string", "format": "uuid" }, "message": { "type": "string", "example": "Data source deleted successfully." } } }, "example": { "dataSourceGuid": "string", "message": "Data source deleted successfully." } } } } } } }, "/documents/document/{documentGuid}/delete": { "delete": { "tags": [ "Document" ], "summary": "Document Delete", "description": "Deletes a specific document record from the system.", "operationId": "document-delete", "parameters": [ { "name": "documentGuid", "in": "path", "description": "The unique identifier (GUID) of the document to delete.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request.", "required": true, "schema": { "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access.", "required": true, "schema": { "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "Document record deleted successfully.", "content": { "application/json": { "schema": { "type": "object", "properties": { "documentGuid": { "type": "string", "format": "uuid" }, "message": { "type": "string", "example": "Document deleted successfully." } } }, "example": { "documentGuid": "string", "message": "Document deleted successfully." } } } } } } }, "/documents/request/{documentRequestGuid}/delete": { "delete": { "tags": [ "Document Request" ], "summary": "Document Request Delete", "description": "Cancels and deletes a specific document generation request.", "operationId": "document-request-delete", "parameters": [ { "name": "documentRequestGuid", "in": "path", "description": "The unique identifier (GUID) of the document request to delete.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request.", "required": true, "schema": { "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access.", "required": true, "schema": { "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "Document request deleted successfully.", "content": { "application/json": { "schema": { "type": "object", "properties": { "documentRequestGuid": { "type": "string", "format": "uuid" }, "message": { "type": "string", "example": "DocumentRequest deleted successfully." } } }, "example": { "documentRequestGuid": "string", "message": "DocumentRequest deleted successfully." } } } } } } }, "/documents/configuration/{documentSolutionConfigurationGuid}/delete": { "delete": { "tags": [ "Document Solution Configuration" ], "summary": "Document Solution Configuration Delete", "description": "Deletes a specific document solution configuration.", "operationId": "document-solution-configuration-delete", "parameters": [ { "name": "documentSolutionConfigurationGuid", "in": "path", "description": "The unique identifier (GUID) of the configuration to delete.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request.", "required": true, "schema": { "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access.", "required": true, "schema": { "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "Configuration deleted successfully.", "content": { "application/json": { "schema": { "type": "object", "properties": { "documentSolutionConfigurationGuid": { "type": "string", "format": "uuid" }, "message": { "type": "string", "example": "DocumentSolutionConfiguration deleted successfully." } } }, "example": { "documentSolutionConfigurationGuid": "string", "message": "DocumentSolutionConfiguration deleted successfully." } } } } } } }, "/documents/solution/{documentSolutionGuid}/delete": { "delete": { "tags": [ "Document Solution" ], "summary": "Document Solution Delete", "description": "Deletes a specific document solution from the system.", "operationId": "document-solution-delete", "parameters": [ { "name": "documentSolutionGuid", "in": "path", "description": "The unique identifier (GUID) of the solution to delete.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request.", "required": true, "schema": { "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access.", "required": true, "schema": { "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "Document solution deleted successfully.", "content": { "application/json": { "schema": { "type": "object", "properties": { "documentSolutionGuid": { "type": "string", "format": "uuid" }, "message": { "type": "string", "example": "DocumentSolution deleted successfully." } } }, "example": { "documentSolutionGuid": "string", "message": "DocumentSolution deleted successfully." } } } } } } }, "/documents/template/{documentTemplateGuid}/delete": { "delete": { "tags": [ "Template" ], "summary": "Template Delete", "description": "Deletes a specific template definition from the system.", "operationId": "template-delete", "parameters": [ { "name": "documentTemplateGuid", "in": "path", "description": "The unique identifier (GUID) of the template to delete.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request.", "required": true, "schema": { "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access.", "required": true, "schema": { "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "Template deleted successfully.", "content": { "application/json": { "schema": { "type": "object", "properties": { "documentTemplateGuid": { "type": "string", "format": "uuid" }, "message": { "type": "string", "example": "DocumentTemplate deleted successfully." } } }, "example": { "documentTemplateGuid": "string", "message": "DocumentTemplate deleted successfully." } } } } } } }, "/documents/option/{optionValueGuid}/delete": { "delete": { "tags": [ "Option Value" ], "summary": "Document Option Value Delete", "description": "Deletes a specific document option value.", "operationId": "document-option-value-delete", "parameters": [ { "name": "optionValueGuid", "in": "path", "description": "The unique identifier (GUID) of the option value to delete.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request.", "required": true, "schema": { "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access.", "required": true, "schema": { "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "Option value deleted successfully.", "content": { "application/json": { "schema": { "type": "object", "properties": { "optionValueGuid": { "type": "string", "format": "uuid" }, "Message": { "type": "string", "example": "Option value deleted successfully." } } }, "example": { "optionValueGuid": "string", "Message": "Option value deleted successfully." } } } } } } }, "/documents/datasource/{dataSourceGuid}/get": { "get": { "tags": [ "Data Source" ], "summary": "Data Source Get", "description": "Retrieves the detailed configuration of a specific data source using its unique GUID.", "operationId": "data-source-get", "parameters": [ { "name": "dataSourceGuid", "in": "path", "description": "The unique identifier (GUID) of the data source.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request.", "required": true, "schema": { "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment.", "required": true, "schema": { "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "Data source retrieved successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSourceModel" }, "example": { "dataSourceGuid": "string", "subscriptionGuid": "string", "ownerGuid": "string", "lastModifiedUserGuid": "string", "name": "string", "description": "string", "urn": "string", "query": "string", "variables": "string", "loadMethod": "string", "createdDate": "string", "lastModifiedDate": "string", "isDeleted": true } } } } } } }, "/documents/datasource/list": { "get": { "tags": [ "Data Source" ], "summary": "Data Source List", "description": "Retrieves a paginated list of all available data sources configured in the system.", "operationId": "data-source-list", "parameters": [ { "name": "top", "in": "query", "description": "Number of records to retrieve (for pagination).", "schema": { "type": "integer" } }, { "name": "skip", "in": "query", "description": "Number of records to skip (for pagination).", "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "description": "Field name to sort by.", "schema": { "type": "string" } }, { "name": "order", "in": "query", "description": "Sort order (e.g., asc or desc).", "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request.", "required": true, "schema": { "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access.", "required": true, "schema": { "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "List of data sources retrieved successfully.", "content": { "application/json": { "schema": { "type": "object", "properties": { "dataSources": { "type": "array", "items": { "type": "object", "properties": { "dataSourceGuid": { "type": "string", "format": "uuid", "nullable": true }, "subscriptionGuid": { "type": "string", "format": "uuid", "nullable": true }, "ownerGuid": { "type": "string", "format": "uuid", "nullable": true }, "lastModifiedUserGuid": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "urn": { "type": "string", "nullable": true }, "query": { "type": "string", "nullable": true }, "variables": { "type": "string", "nullable": true }, "loadMethod": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "lastModifiedDate": { "type": "string", "format": "date-time" }, "isDeleted": { "type": "boolean" } } } }, "rowCount": { "type": "integer", "description": "Total number of data sources available." } } }, "example": { "dataSources": [ { "dataSourceGuid": "string", "subscriptionGuid": "string", "ownerGuid": "string", "lastModifiedUserGuid": "string", "name": "string", "description": "string", "urn": "string", "query": "string", "variables": "string", "loadMethod": "string", "createdDate": "string", "lastModifiedDate": "string", "isDeleted": true } ], "rowCount": 0 } } } } } } }, "/documents/document/{documentGuid}/get": { "get": { "tags": [ "Document" ], "summary": "Document Get", "description": "Retrieves the metadata and details of a specific document using its unique GUID.", "operationId": "document-get", "parameters": [ { "name": "documentGuid", "in": "path", "description": "The unique identifier (GUID) of the document.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request.", "required": true, "schema": { "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment.", "required": true, "schema": { "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "Document metadata retrieved successfully.", "content": { "application/json": { "schema": { "type": "object", "properties": { "document": { "type": "object", "properties": { "documentGuid": { "type": "string", "format": "uuid" }, "subscriptionGuid": { "type": "string", "format": "uuid" }, "ownerGuid": { "type": "string", "format": "uuid" }, "lastModifiedUserGuid": { "type": "string", "format": "uuid" }, "title": { "type": "string", "nullable": true }, "urn": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "path": { "type": "string", "nullable": true }, "fileFormat": { "type": "string", "nullable": true }, "deliveryMethod": { "type": "string", "nullable": true }, "viewAnonymousLink": { "type": "string", "nullable": true }, "editAnonymousLink": { "type": "string", "nullable": true }, "viewUserLink": { "type": "string", "nullable": true }, "editUserLink": { "type": "string", "nullable": true }, "viewOrganizationLink": { "type": "string", "nullable": true }, "editOrganizationLink": { "type": "string", "nullable": true }, "succeededViewUserEmailList": { "type": "string", "nullable": true }, "succeededEditUserEmailList": { "type": "string", "nullable": true }, "failedViewUserEmailList": { "type": "string", "nullable": true }, "failedEditUserEmailList": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "lastModifiedDate": { "type": "string", "format": "date-time" }, "isDeleted": { "type": "boolean" } } } } }, "example": { "document": { "documentGuid": "string", "subscriptionGuid": "string", "ownerGuid": "string", "lastModifiedUserGuid": "string", "title": "string", "urn": "string", "url": "string", "path": "string", "fileFormat": "string", "deliveryMethod": "string", "viewAnonymousLink": "string", "editAnonymousLink": "string", "viewUserLink": "string", "editUserLink": "string", "viewOrganizationLink": "string", "editOrganizationLink": "string", "succeededViewUserEmailList": "string", "succeededEditUserEmailList": "string", "failedViewUserEmailList": "string", "failedEditUserEmailList": "string", "createdDate": "string", "lastModifiedDate": "string", "isDeleted": true } } } } } } } }, "/documents/document/list": { "get": { "tags": [ "Document" ], "summary": "Document List", "description": "Retrieves a paginated list of all document records in the system.", "operationId": "document-list", "parameters": [ { "name": "top", "in": "query", "description": "Number of records to retrieve (for pagination).", "schema": { "type": "integer" } }, { "name": "skip", "in": "query", "description": "Number of records to skip (for pagination).", "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "description": "Field name to sort by.", "schema": { "type": "string" } }, { "name": "order", "in": "query", "description": "Sort order (e.g., asc or desc).", "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request.", "required": true, "schema": { "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access.", "required": true, "schema": { "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "List of documents retrieved successfully.", "content": { "application/json": { "schema": { "type": "object", "properties": { "documents": { "type": "array", "items": { "type": "object", "properties": { "documentGuid": { "type": "string", "format": "uuid" }, "subscriptionGuid": { "type": "string", "format": "uuid" }, "ownerGuid": { "type": "string", "format": "uuid" }, "lastModifiedUserGuid": { "type": "string", "format": "uuid" }, "title": { "type": "string", "nullable": true }, "urn": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "path": { "type": "string", "nullable": true }, "fileFormat": { "type": "string", "nullable": true }, "deliveryMethod": { "type": "string", "nullable": true }, "viewAnonymousLink": { "type": "string", "nullable": true }, "editAnonymousLink": { "type": "string", "nullable": true }, "viewUserLink": { "type": "string", "nullable": true }, "editUserLink": { "type": "string", "nullable": true }, "viewOrganizationLink": { "type": "string", "nullable": true }, "editOrganizationLink": { "type": "string", "nullable": true }, "succeededViewUserEmailList": { "type": "string", "nullable": true }, "succeededEditUserEmailList": { "type": "string", "nullable": true }, "failedViewUserEmailList": { "type": "string", "nullable": true }, "failedEditUserEmailList": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "lastModifiedDate": { "type": "string", "format": "date-time" }, "isDeleted": { "type": "boolean" } } } }, "rowCount": { "type": "integer", "description": "Total number of documents available." } } }, "example": { "documents": [ { "documentGuid": "string", "subscriptionGuid": "string", "ownerGuid": "string", "lastModifiedUserGuid": "string", "title": "string", "urn": "string", "url": "string", "path": "string", "fileFormat": "string", "deliveryMethod": "string", "viewAnonymousLink": "string", "editAnonymousLink": "string", "viewUserLink": "string", "editUserLink": "string", "viewOrganizationLink": "string", "editOrganizationLink": "string", "succeededViewUserEmailList": "string", "succeededEditUserEmailList": "string", "failedViewUserEmailList": "string", "failedEditUserEmailList": "string", "createdDate": "string", "lastModifiedDate": "string", "isDeleted": true } ], "rowCount": 0 } } } } } } }, "/documents/request/{documentRequestGuid}/get": { "get": { "tags": [ "Document Request" ], "summary": "Document Request Get", "description": "Retrieves the current status, details, and metadata of a specific document request using its unique GUID.", "operationId": "document-request-get", "parameters": [ { "name": "documentRequestGuid", "in": "path", "description": "The unique identifier (GUID) of the document request.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request.", "required": true, "schema": { "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment.", "required": true, "schema": { "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "Document request details retrieved successfully.", "content": { "application/json": { "schema": { "type": "object", "properties": { "documentRequest": { "type": "object", "properties": { "documentRequestGuid": { "type": "string", "format": "uuid" }, "subscriptionGuid": { "type": "string", "format": "uuid" }, "documentTemplateGuid": { "type": "string", "format": "uuid" }, "dataGuid": { "type": "string", "format": "uuid" }, "documentGuid": { "type": "string", "format": "uuid", "nullable": true }, "documentSolutionConfigurationGuid": { "type": "string", "format": "uuid", "nullable": true }, "ownerGuid": { "type": "string", "format": "uuid" }, "lastModifiedUserGuid": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "embeddedData": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "fileFormat": { "type": "string", "nullable": true }, "processingType": { "type": "string", "nullable": true }, "deliveryMethod": { "type": "string", "nullable": true }, "path": { "type": "string", "nullable": true }, "pdfConformanceLevel": { "type": "string", "nullable": true }, "pdfVersion": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "locale": { "type": "string", "nullable": true }, "timeZone": { "type": "string", "nullable": true }, "viewAnonymous": { "type": "boolean" }, "editAnonymous": { "type": "boolean" }, "viewOrganization": { "type": "boolean" }, "editOrganization": { "type": "boolean" }, "viewUser": { "type": "boolean" }, "editUser": { "type": "boolean" }, "viewUserEmailList": { "type": "string", "nullable": true }, "editUserEmailList": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "completedDate": { "type": "string", "format": "date-time", "nullable": true }, "lastModifiedDate": { "type": "string", "format": "date-time", "nullable": true }, "isDeleted": { "type": "boolean" } } } } }, "example": { "documentRequest": { "documentRequestGuid": "string", "subscriptionGuid": "string", "documentTemplateGuid": "string", "dataGuid": "string", "documentGuid": "string", "documentSolutionConfigurationGuid": "string", "ownerGuid": "string", "lastModifiedUserGuid": "string", "recordId": "string", "name": "string", "status": "string", "embeddedData": "string", "title": "string", "fileFormat": "string", "processingType": "string", "deliveryMethod": "string", "path": "string", "pdfConformanceLevel": "string", "pdfVersion": "string", "language": "string", "locale": "string", "timeZone": "string", "viewAnonymous": true, "editAnonymous": true, "viewOrganization": true, "editOrganization": true, "viewUser": true, "editUser": true, "viewUserEmailList": "string", "editUserEmailList": "string", "createdDate": "string", "completedDate": "string", "lastModifiedDate": "string", "isDeleted": true } } } } } } } }, "/documents/request/list": { "get": { "tags": [ "Document Request" ], "summary": "Document Request List", "description": "Retrieves a paginated list of all document generation requests, useful for auditing or polling status.", "operationId": "document-request-list", "parameters": [ { "name": "top", "in": "query", "description": "Number of records to retrieve (for pagination).", "schema": { "type": "integer" } }, { "name": "skip", "in": "query", "description": "Number of records to skip (for pagination).", "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "description": "Field name to sort by.", "schema": { "type": "string" } }, { "name": "order", "in": "query", "description": "Sort order (e.g., asc or desc).", "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request.", "required": true, "schema": { "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access.", "required": true, "schema": { "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "List of document requests retrieved successfully.", "content": { "application/json": { "schema": { "type": "object", "properties": { "documentRequests": { "type": "array", "items": { "type": "object", "properties": { "documentRequestGuid": { "type": "string", "format": "uuid" }, "subscriptionGuid": { "type": "string", "format": "uuid" }, "documentTemplateGuid": { "type": "string", "format": "uuid" }, "dataGuid": { "type": "string", "format": "uuid" }, "documentGuid": { "type": "string", "format": "uuid", "nullable": true }, "documentSolutionConfigurationGuid": { "type": "string", "format": "uuid", "nullable": true }, "ownerGuid": { "type": "string", "format": "uuid" }, "lastModifiedUserGuid": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "embeddedData": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "fileFormat": { "type": "string", "nullable": true }, "processingType": { "type": "string", "nullable": true }, "deliveryMethod": { "type": "string", "nullable": true }, "path": { "type": "string", "nullable": true }, "pdfConformanceLevel": { "type": "string", "nullable": true }, "pdfVersion": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "locale": { "type": "string", "nullable": true }, "timeZone": { "type": "string", "nullable": true }, "viewAnonymous": { "type": "boolean" }, "editAnonymous": { "type": "boolean" }, "viewOrganization": { "type": "boolean" }, "editOrganization": { "type": "boolean" }, "viewUser": { "type": "boolean" }, "editUser": { "type": "boolean" }, "viewUserEmailList": { "type": "string", "nullable": true }, "editUserEmailList": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "completedDate": { "type": "string", "format": "date-time", "nullable": true }, "lastModifiedDate": { "type": "string", "format": "date-time", "nullable": true }, "isDeleted": { "type": "boolean" } } } }, "rowCount": { "type": "integer", "description": "Total number of document requests available." } } }, "example": { "documentRequests": [ { "documentRequestGuid": "string", "subscriptionGuid": "string", "documentTemplateGuid": "string", "dataGuid": "string", "documentGuid": "string", "documentSolutionConfigurationGuid": "string", "ownerGuid": "string", "lastModifiedUserGuid": "string", "recordId": "string", "name": "string", "status": "string", "embeddedData": "string", "title": "string", "fileFormat": "string", "processingType": "string", "deliveryMethod": "string", "path": "string", "pdfConformanceLevel": "string", "pdfVersion": "string", "language": "string", "locale": "string", "timeZone": "string", "viewAnonymous": true, "editAnonymous": true, "viewOrganization": true, "editOrganization": true, "viewUser": true, "editUser": true, "viewUserEmailList": "string", "editUserEmailList": "string", "createdDate": "string", "completedDate": "string", "lastModifiedDate": "string", "isDeleted": true } ], "rowCount": 0 } } } } } } }, "/documents/configuration/{documentSolutionConfigurationGuid}/get": { "get": { "tags": [ "Document Solution Configuration" ], "summary": "Document Solution Configuration Get", "description": "Retrieves the details of a specific document solution configuration using its unique GUID.", "operationId": "document-solution-configuration-get", "parameters": [ { "name": "documentSolutionConfigurationGuid", "in": "path", "description": "The unique identifier (GUID) of the document solution configuration.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request.", "required": true, "schema": { "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment.", "required": true, "schema": { "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "Configuration details retrieved successfully.", "content": { "application/json": { "schema": { "type": "object", "properties": { "documentSolutionConfiguration": { "type": "object", "properties": { "documentSolutionConfigurationGuid": { "type": "string", "format": "uuid" }, "documentSolutionGuid": { "type": "string", "format": "uuid" }, "subscriptionGuid": { "type": "string", "format": "uuid" }, "ownerGuid": { "type": "string", "format": "uuid" }, "lastModifiedUserGuid": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "fileFormat": { "type": "string", "nullable": true }, "processingType": { "type": "string", "nullable": true }, "deliveryMethod": { "type": "string", "nullable": true }, "path": { "type": "string", "nullable": true }, "pdfConformanceLevel": { "type": "string", "nullable": true }, "pdfVersion": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "locale": { "type": "string", "nullable": true }, "timeZone": { "type": "string", "nullable": true }, "embeddedData": { "type": "string", "nullable": true }, "viewAnonymous": { "type": "boolean" }, "editAnonymous": { "type": "boolean" }, "viewOrganization": { "type": "boolean" }, "editOrganization": { "type": "boolean" }, "viewUser": { "type": "boolean" }, "editUser": { "type": "boolean" }, "viewUserEmailList": { "type": "string", "nullable": true }, "editUserEmailList": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "lastModifiedDate": { "type": "string", "format": "date-time" }, "isDeleted": { "type": "boolean" } } } } }, "example": { "documentSolutionConfiguration": { "documentSolutionConfigurationGuid": "string", "documentSolutionGuid": "string", "subscriptionGuid": "string", "ownerGuid": "string", "lastModifiedUserGuid": "string", "name": "string", "description": "string", "title": "string", "fileFormat": "string", "processingType": "string", "deliveryMethod": "string", "path": "string", "pdfConformanceLevel": "string", "pdfVersion": "string", "language": "string", "locale": "string", "timeZone": "string", "embeddedData": "string", "viewAnonymous": true, "editAnonymous": true, "viewOrganization": true, "editOrganization": true, "viewUser": true, "editUser": true, "viewUserEmailList": "string", "editUserEmailList": "string", "createdDate": "string", "lastModifiedDate": "string", "isDeleted": true } } } } } } } }, "/documents/configuration/list": { "get": { "tags": [ "Document Solution Configuration" ], "summary": "Document Solution Configuration List", "description": "Retrieves a paginated list of all document solution configurations.", "operationId": "document-solution-configuration-list", "parameters": [ { "name": "top", "in": "query", "description": "Number of records to retrieve (for pagination).", "schema": { "type": "integer" } }, { "name": "skip", "in": "query", "description": "Number of records to skip (for pagination).", "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "description": "Field name to sort by.", "schema": { "type": "string" } }, { "name": "order", "in": "query", "description": "Sort order (e.g., asc or desc).", "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request.", "required": true, "schema": { "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access.", "required": true, "schema": { "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "List of configurations retrieved successfully.", "content": { "application/json": { "schema": { "type": "object", "properties": { "documentSolutionConfigurations": { "type": "array", "items": { "type": "object", "properties": { "documentSolutionConfigurationGuid": { "type": "string", "format": "uuid" }, "documentSolutionGuid": { "type": "string", "format": "uuid" }, "subscriptionGuid": { "type": "string", "format": "uuid" }, "ownerGuid": { "type": "string", "format": "uuid" }, "lastModifiedUserGuid": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "fileFormat": { "type": "string", "nullable": true }, "processingType": { "type": "string", "nullable": true }, "deliveryMethod": { "type": "string", "nullable": true }, "path": { "type": "string", "nullable": true }, "pdfConformanceLevel": { "type": "string", "nullable": true }, "pdfVersion": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "locale": { "type": "string", "nullable": true }, "timeZone": { "type": "string", "nullable": true }, "embeddedData": { "type": "string", "nullable": true }, "viewAnonymous": { "type": "boolean" }, "editAnonymous": { "type": "boolean" }, "viewOrganization": { "type": "boolean" }, "editOrganization": { "type": "boolean" }, "viewUser": { "type": "boolean" }, "editUser": { "type": "boolean" }, "viewUserEmailList": { "type": "string", "nullable": true }, "editUserEmailList": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "lastModifiedDate": { "type": "string", "format": "date-time" }, "isDeleted": { "type": "boolean" } } } }, "rowCount": { "type": "integer", "description": "Total number of configurations available." } } }, "example": { "documentSolutionConfigurations": [ { "documentSolutionConfigurationGuid": "string", "documentSolutionGuid": "string", "subscriptionGuid": "string", "ownerGuid": "string", "lastModifiedUserGuid": "string", "name": "string", "description": "string", "title": "string", "fileFormat": "string", "processingType": "string", "deliveryMethod": "string", "path": "string", "pdfConformanceLevel": "string", "pdfVersion": "string", "language": "string", "locale": "string", "timeZone": "string", "embeddedData": "string", "viewAnonymous": true, "editAnonymous": true, "viewOrganization": true, "editOrganization": true, "viewUser": true, "editUser": true, "viewUserEmailList": "string", "editUserEmailList": "string", "createdDate": "string", "lastModifiedDate": "string", "isDeleted": true } ], "rowCount": 0 } } } } } } }, "/documents/solution/{documentSolutionGuid}/get": { "get": { "tags": [ "Document Solution" ], "summary": "Document Solution Get", "description": "Retrieves the properties and details of a specific document solution using its unique GUID.", "operationId": "document-solution-get", "parameters": [ { "name": "documentSolutionGuid", "in": "path", "description": "The unique identifier (GUID) of the document solution.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request.", "required": true, "schema": { "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment.", "required": true, "schema": { "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "Solution details retrieved successfully.", "content": { "application/json": { "schema": { "type": "object", "properties": { "documentSolution": { "type": "object", "properties": { "documentSolutionGuid": { "type": "string", "format": "uuid", "nullable": true }, "subscriptionGuid": { "type": "string", "format": "uuid", "nullable": true }, "ownerGuid": { "type": "string", "format": "uuid", "nullable": true }, "lastModifiedUserGuid": { "type": "string", "format": "uuid", "nullable": true }, "dataGuid": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "lastModifiedDate": { "type": "string", "format": "date-time" }, "isDeleted": { "type": "boolean" } } } } }, "example": { "documentSolution": { "documentSolutionGuid": "string", "subscriptionGuid": "string", "ownerGuid": "string", "lastModifiedUserGuid": "string", "dataGuid": "string", "name": "string", "description": "string", "createdDate": "string", "lastModifiedDate": "string", "isDeleted": true } } } } } } } }, "/documents/solution/list": { "get": { "tags": [ "Document Solution" ], "summary": "Document Solution List", "description": "Retrieves a paginated list of all configured document solutions in the system.", "operationId": "document-solution-list", "parameters": [ { "name": "top", "in": "query", "description": "Number of records to retrieve (for pagination).", "schema": { "type": "integer" } }, { "name": "skip", "in": "query", "description": "Number of records to skip (for pagination).", "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "description": "Field name to sort by.", "schema": { "type": "string" } }, { "name": "order", "in": "query", "description": "Sort order (e.g., asc or desc).", "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request.", "required": true, "schema": { "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access.", "required": true, "schema": { "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "List of solutions retrieved successfully.", "content": { "application/json": { "schema": { "type": "object", "properties": { "documentSolutions": { "type": "array", "items": { "type": "object", "properties": { "documentSolutionGuid": { "type": "string", "format": "uuid", "nullable": true }, "subscriptionGuid": { "type": "string", "format": "uuid", "nullable": true }, "ownerGuid": { "type": "string", "format": "uuid", "nullable": true }, "lastModifiedUserGuid": { "type": "string", "format": "uuid", "nullable": true }, "dataGuid": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "lastModifiedDate": { "type": "string", "format": "date-time" }, "isDeleted": { "type": "boolean" } } } }, "rowCount": { "type": "integer", "description": "Total number of solutions available." } } }, "example": { "documentSolutions": [ { "documentSolutionGuid": "string", "subscriptionGuid": "string", "ownerGuid": "string", "lastModifiedUserGuid": "string", "dataGuid": "string", "name": "string", "description": "string", "createdDate": "string", "lastModifiedDate": "string", "isDeleted": true } ], "rowCount": 0 } } } } } } }, "/documents/template/{documentTemplateGuid}/get": { "get": { "tags": [ "Template" ], "summary": "Template Get", "description": "Retrieves the metadata and details of a specific template record using its unique GUID.", "operationId": "template-get", "parameters": [ { "name": "documentTemplateGuid", "in": "path", "description": "The unique identifier (GUID) of the document template.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request.", "required": true, "schema": { "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment.", "required": true, "schema": { "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "Template metadata retrieved successfully.", "content": { "application/json": { "schema": { "type": "object", "properties": { "documentTemplate": { "type": "object", "properties": { "documentTemplateGuid": { "type": "string", "format": "uuid" }, "subscriptionGuid": { "type": "string", "format": "uuid" }, "ownerGuid": { "type": "string", "format": "uuid" }, "lastModifiedUserGuid": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "urn": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "viewAnonymousLink": { "type": "string", "nullable": true }, "editAnonymousLink": { "type": "string", "nullable": true }, "viewUserLink": { "type": "string", "nullable": true }, "editUserLink": { "type": "string", "nullable": true }, "viewOrganizationLink": { "type": "string", "nullable": true }, "editOrganizationLink": { "type": "string", "nullable": true }, "fileFormat": { "type": "string", "nullable": true }, "loadMethod": { "type": "string", "nullable": true }, "path": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "lastModifiedDate": { "type": "string", "format": "date-time" }, "isDeleted": { "type": "boolean" } } } } }, "example": { "documentTemplate": { "documentTemplateGuid": "string", "subscriptionGuid": "string", "ownerGuid": "string", "lastModifiedUserGuid": "string", "name": "string", "description": "string", "title": "string", "urn": "string", "url": "string", "viewAnonymousLink": "string", "editAnonymousLink": "string", "viewUserLink": "string", "editUserLink": "string", "viewOrganizationLink": "string", "editOrganizationLink": "string", "fileFormat": "string", "loadMethod": "string", "path": "string", "createdDate": "string", "lastModifiedDate": "string", "isDeleted": true } } } } } } } }, "/documents/template/list": { "get": { "tags": [ "Template" ], "summary": "Template List", "description": "Retrieves a paginated list of all available template definitions in the system.", "operationId": "template-list", "parameters": [ { "name": "top", "in": "query", "description": "Number of records to retrieve (for pagination).", "schema": { "type": "integer" } }, { "name": "skip", "in": "query", "description": "Number of records to skip (for pagination).", "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "description": "Field name to sort by.", "schema": { "type": "string" } }, { "name": "order", "in": "query", "description": "Sort order (e.g., asc or desc).", "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request.", "required": true, "schema": { "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access.", "required": true, "schema": { "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "List of templates retrieved successfully.", "content": { "application/json": { "schema": { "type": "object", "properties": { "documentTemplates": { "type": "array", "items": { "type": "object", "properties": { "documentTemplateGuid": { "type": "string", "format": "uuid" }, "subscriptionGuid": { "type": "string", "format": "uuid" }, "ownerGuid": { "type": "string", "format": "uuid" }, "lastModifiedUserGuid": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "urn": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "viewAnonymousLink": { "type": "string", "nullable": true }, "editAnonymousLink": { "type": "string", "nullable": true }, "viewUserLink": { "type": "string", "nullable": true }, "editUserLink": { "type": "string", "nullable": true }, "viewOrganizationLink": { "type": "string", "nullable": true }, "editOrganizationLink": { "type": "string", "nullable": true }, "fileFormat": { "type": "string", "nullable": true }, "loadMethod": { "type": "string", "nullable": true }, "path": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "lastModifiedDate": { "type": "string", "format": "date-time" }, "isDeleted": { "type": "boolean" } } } }, "rowCount": { "type": "integer", "description": "Total number of templates available." } } }, "example": { "documentTemplates": [ { "documentTemplateGuid": "string", "subscriptionGuid": "string", "ownerGuid": "string", "lastModifiedUserGuid": "string", "name": "string", "description": "string", "title": "string", "urn": "string", "url": "string", "viewAnonymousLink": "string", "editAnonymousLink": "string", "viewUserLink": "string", "editUserLink": "string", "viewOrganizationLink": "string", "editOrganizationLink": "string", "fileFormat": "string", "loadMethod": "string", "path": "string", "createdDate": "string", "lastModifiedDate": "string", "isDeleted": true } ], "rowCount": 0 } } } } } } }, "/documents/option/{optionValueGuid}/get": { "get": { "tags": [ "Option Value" ], "summary": "Document Option Value Get", "description": "Retrieves the details of a specific document option value using its unique GUID.", "operationId": "document-option-value-get", "parameters": [ { "name": "optionValueGuid", "in": "path", "description": "The unique identifier (GUID) of the option value.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request.", "required": true, "schema": { "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment.", "required": true, "schema": { "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "Option value retrieved successfully.", "content": { "application/json": { "schema": { "type": "object", "properties": { "optionValue": { "type": "object", "properties": { "optionValueGuid": { "type": "string", "format": "uuid" }, "entityType": { "type": "string", "nullable": true }, "entityId": { "type": "string", "format": "uuid" }, "optionDefinitionId": { "type": "integer", "nullable": true }, "customKey": { "type": "string", "nullable": true }, "customGroup": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "effectiveKey": { "type": "string", "nullable": true }, "effectiveGroup": { "type": "string", "nullable": true }, "systemType": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "lastModifiedDate": { "type": "string", "format": "date-time" } } } } }, "example": { "optionValue": { "optionValueGuid": "string", "entityType": "string", "entityId": "string", "optionDefinitionId": 0, "customKey": "string", "customGroup": "string", "value": "string", "effectiveKey": "string", "effectiveGroup": "string", "systemType": "string", "createdDate": "string", "lastModifiedDate": "string" } } } } } } } }, "/documents/option/{entityType}/{entityId}/list": { "get": { "tags": [ "Option Value" ], "summary": "Document Option Value List", "description": "Retrieves a list of all option values currently associated with a specific entity (e.g., a specific template or solution).", "operationId": "document-option-value-list", "parameters": [ { "name": "entityType", "in": "path", "description": "The type of entity the options belong to.", "required": true, "schema": { "type": "string" } }, { "name": "entityId", "in": "path", "description": "The unique identifier (GUID) of the entity.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request.", "required": true, "schema": { "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access.", "required": true, "schema": { "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "List of option values retrieved successfully.", "content": { "application/json": { "schema": { "type": "object", "properties": { "optionValues": { "type": "array", "items": { "type": "object", "properties": { "optionValueGuid": { "type": "string", "format": "uuid" }, "entityType": { "type": "string", "nullable": true }, "entityId": { "type": "string", "format": "uuid" }, "optionDefinitionId": { "type": "integer", "nullable": true }, "customKey": { "type": "string", "nullable": true }, "customGroup": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "effectiveKey": { "type": "string", "nullable": true }, "effectiveGroup": { "type": "string", "nullable": true }, "systemType": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "lastModifiedDate": { "type": "string", "format": "date-time" } } } }, "rowCount": { "type": "integer", "description": "Total number of option values returned." } } }, "example": { "optionValues": [ { "optionValueGuid": "string", "entityType": "string", "entityId": "string", "optionDefinitionId": 0, "customKey": "string", "customGroup": "string", "value": "string", "effectiveKey": "string", "effectiveGroup": "string", "systemType": "string", "createdDate": "string", "lastModifiedDate": "string" } ], "rowCount": 0 } } } } } } }, "/documents/option/{entityType}/{entityId}/replace": { "put": { "tags": [ "Option Value" ], "summary": "Document Option Value Replace", "description": "Bulk-replaces all existing option values for a specific entity with a new set of values.", "operationId": "document-option-value-replace", "parameters": [ { "name": "entityType", "in": "path", "description": "The type of entity to replace options for.", "required": true, "schema": { "type": "string" } }, { "name": "entityId", "in": "path", "description": "The unique identifier (GUID) of the entity.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request.", "required": true, "schema": { "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access.", "required": true, "schema": { "type": "string", "default": "{{apiKey}}" } } ], "requestBody": { "description": "An array of option value objects to replace the current set.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "optionValueGuid": { "type": "string", "format": "uuid" }, "entityType": { "type": "string", "nullable": true }, "entityId": { "type": "string", "format": "uuid" }, "optionDefinitionId": { "type": "integer", "nullable": true }, "customKey": { "type": "string", "nullable": true }, "customGroup": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "effectiveKey": { "type": "string", "nullable": true }, "effectiveGroup": { "type": "string", "nullable": true }, "systemType": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "lastModifiedDate": { "type": "string", "format": "date-time" } } } }, "example": [ { "optionValueGuid": "string", "entityType": "string", "entityId": "string", "optionDefinitionId": 0, "customKey": "string", "customGroup": "string", "value": "string", "effectiveKey": "string", "effectiveGroup": "string", "systemType": "string", "createdDate": "string", "lastModifiedDate": "string" } ] } } }, "responses": { "200": { "description": "Option values replaced successfully.", "content": { "application/json": { "schema": { "type": "object", "properties": { "entityId": { "type": "string", "format": "uuid" }, "entityType": { "type": "string" }, "Message": { "type": "string", "example": "Entity options replaced successfully." } } }, "example": { "entityId": "string", "entityType": "string", "Message": "Entity options replaced successfully." } } } } } } }, "/documents/datasource/{dataSourceGuid}/update": { "put": { "tags": [ "Data Source" ], "summary": "Data Source Update", "description": "Updates the properties of an existing data source configuration.", "operationId": "data-source-update", "parameters": [ { "name": "dataSourceGuid", "in": "path", "description": "The unique identifier (GUID) of the data source to update.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request.", "required": true, "schema": { "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access.", "required": true, "schema": { "type": "string", "default": "{{apiKey}}" } } ], "requestBody": { "description": "The data source object containing updated values.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSourceModel" }, "example": { "dataSourceGuid": "string", "subscriptionGuid": "string", "ownerGuid": "string", "lastModifiedUserGuid": "string", "name": "string", "description": "string", "urn": "string", "query": "string", "variables": "string", "loadMethod": "string", "createdDate": "string", "lastModifiedDate": "string", "isDeleted": true } } } }, "responses": { "200": { "description": "Data source updated successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSourceModel" }, "example": { "dataSourceGuid": "string", "subscriptionGuid": "string", "ownerGuid": "string", "lastModifiedUserGuid": "string", "name": "string", "description": "string", "urn": "string", "query": "string", "variables": "string", "loadMethod": "string", "createdDate": "string", "lastModifiedDate": "string", "isDeleted": true } } } } } } }, "/documents/document/{documentGuid}/update": { "put": { "tags": [ "Document" ], "summary": "Document Update", "description": "Updates the properties or metadata of an existing document record.", "operationId": "document-update", "parameters": [ { "name": "documentGuid", "in": "path", "description": "The unique identifier (GUID) of the document to update.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request.", "required": true, "schema": { "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access.", "required": true, "schema": { "type": "string", "default": "{{apiKey}}" } } ], "requestBody": { "description": "The document object containing updated values.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentModel" }, "example": { "documentGuid": "string", "subscriptionGuid": "string", "ownerGuid": "string", "lastModifiedUserGuid": "string", "title": "string", "urn": "string", "url": "string", "path": "string", "fileFormat": "string", "deliveryMethod": "string", "viewAnonymousLink": "string", "editAnonymousLink": "string", "viewUserLink": "string", "editUserLink": "string", "viewOrganizationLink": "string", "editOrganizationLink": "string", "succeededViewUserEmailList": "string", "succeededEditUserEmailList": "string", "failedViewUserEmailList": "string", "failedEditUserEmailList": "string", "createdDate": "string", "lastModifiedDate": "string", "isDeleted": true } } } }, "responses": { "200": { "description": "Document record updated successfully.", "content": { "application/json": { "schema": { "type": "object", "properties": { "document": { "type": "object", "properties": { "documentGuid": { "type": "string", "format": "uuid" }, "subscriptionGuid": { "type": "string", "format": "uuid" }, "ownerGuid": { "type": "string", "format": "uuid" }, "lastModifiedUserGuid": { "type": "string", "format": "uuid" }, "title": { "type": "string", "nullable": true }, "urn": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "path": { "type": "string", "nullable": true }, "fileFormat": { "type": "string", "nullable": true }, "deliveryMethod": { "type": "string", "nullable": true }, "viewAnonymousLink": { "type": "string", "nullable": true }, "editAnonymousLink": { "type": "string", "nullable": true }, "viewUserLink": { "type": "string", "nullable": true }, "editUserLink": { "type": "string", "nullable": true }, "viewOrganizationLink": { "type": "string", "nullable": true }, "editOrganizationLink": { "type": "string", "nullable": true }, "succeededViewUserEmailList": { "type": "string", "nullable": true }, "succeededEditUserEmailList": { "type": "string", "nullable": true }, "failedViewUserEmailList": { "type": "string", "nullable": true }, "failedEditUserEmailList": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "lastModifiedDate": { "type": "string", "format": "date-time" }, "isDeleted": { "type": "boolean" } } } } }, "example": { "document": { "documentGuid": "string", "subscriptionGuid": "string", "ownerGuid": "string", "lastModifiedUserGuid": "string", "title": "string", "urn": "string", "url": "string", "path": "string", "fileFormat": "string", "deliveryMethod": "string", "viewAnonymousLink": "string", "editAnonymousLink": "string", "viewUserLink": "string", "editUserLink": "string", "viewOrganizationLink": "string", "editOrganizationLink": "string", "succeededViewUserEmailList": "string", "succeededEditUserEmailList": "string", "failedViewUserEmailList": "string", "failedEditUserEmailList": "string", "createdDate": "string", "lastModifiedDate": "string", "isDeleted": true } } } } } } } }, "/documents/request/{documentRequestGuid}/update": { "put": { "tags": [ "Document Request" ], "summary": "Document Request Update", "description": "Updates the status or parameters of an existing document request.", "operationId": "document-request-update", "parameters": [ { "name": "documentRequestGuid", "in": "path", "description": "The unique identifier (GUID) of the document request to update.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request.", "required": true, "schema": { "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access.", "required": true, "schema": { "type": "string", "default": "{{apiKey}}" } } ], "requestBody": { "description": "The document request object containing updated values.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentRequestModel" }, "example": { "documentRequestGuid": "string", "subscriptionGuid": "string", "documentTemplateGuid": "string", "dataGuid": "string", "documentGuid": "string", "documentSolutionConfigurationGuid": "string", "ownerGuid": "string", "lastModifiedUserGuid": "string", "recordId": "string", "name": "string", "status": "string", "embeddedData": "string", "title": "string", "fileFormat": "string", "processingType": "string", "deliveryMethod": "string", "path": "string", "pdfConformanceLevel": "string", "pdfVersion": "string", "language": "string", "locale": "string", "timeZone": "string", "viewAnonymous": true, "editAnonymous": true, "viewOrganization": true, "editOrganization": true, "viewUser": true, "editUser": true, "viewUserEmailList": "string", "editUserEmailList": "string", "createdDate": "string", "completedDate": "string", "lastModifiedDate": "string", "isDeleted": true } } } }, "responses": { "200": { "description": "Document request updated successfully.", "content": { "application/json": { "schema": { "type": "object", "properties": { "documentRequest": { "type": "object", "properties": { "documentRequestGuid": { "type": "string", "format": "uuid" }, "subscriptionGuid": { "type": "string", "format": "uuid" }, "documentTemplateGuid": { "type": "string", "format": "uuid" }, "dataGuid": { "type": "string", "format": "uuid" }, "documentGuid": { "type": "string", "format": "uuid", "nullable": true }, "documentSolutionConfigurationGuid": { "type": "string", "format": "uuid", "nullable": true }, "ownerGuid": { "type": "string", "format": "uuid" }, "lastModifiedUserGuid": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "embeddedData": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "fileFormat": { "type": "string", "nullable": true }, "processingType": { "type": "string", "nullable": true }, "deliveryMethod": { "type": "string", "nullable": true }, "path": { "type": "string", "nullable": true }, "pdfConformanceLevel": { "type": "string", "nullable": true }, "pdfVersion": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "locale": { "type": "string", "nullable": true }, "timeZone": { "type": "string", "nullable": true }, "viewAnonymous": { "type": "boolean" }, "editAnonymous": { "type": "boolean" }, "viewOrganization": { "type": "boolean" }, "editOrganization": { "type": "boolean" }, "viewUser": { "type": "boolean" }, "editUser": { "type": "boolean" }, "viewUserEmailList": { "type": "string", "nullable": true }, "editUserEmailList": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "completedDate": { "type": "string", "format": "date-time", "nullable": true }, "lastModifiedDate": { "type": "string", "format": "date-time", "nullable": true }, "isDeleted": { "type": "boolean" } } } } }, "example": { "documentRequest": { "documentRequestGuid": "string", "subscriptionGuid": "string", "documentTemplateGuid": "string", "dataGuid": "string", "documentGuid": "string", "documentSolutionConfigurationGuid": "string", "ownerGuid": "string", "lastModifiedUserGuid": "string", "recordId": "string", "name": "string", "status": "string", "embeddedData": "string", "title": "string", "fileFormat": "string", "processingType": "string", "deliveryMethod": "string", "path": "string", "pdfConformanceLevel": "string", "pdfVersion": "string", "language": "string", "locale": "string", "timeZone": "string", "viewAnonymous": true, "editAnonymous": true, "viewOrganization": true, "editOrganization": true, "viewUser": true, "editUser": true, "viewUserEmailList": "string", "editUserEmailList": "string", "createdDate": "string", "completedDate": "string", "lastModifiedDate": "string", "isDeleted": true } } } } } } } }, "/documents/configuration/{documentSolutionConfigurationGuid}/update": { "put": { "tags": [ "Document Solution Configuration" ], "summary": "Document Solution Configuration Update", "description": "Updates the parameters of an existing document solution configuration.", "operationId": "document-solution-configuration-update", "parameters": [ { "name": "documentSolutionConfigurationGuid", "in": "path", "description": "The unique identifier (GUID) of the configuration to update.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request.", "required": true, "schema": { "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access.", "required": true, "schema": { "type": "string", "default": "{{apiKey}}" } } ], "requestBody": { "description": "The configuration object containing updated values.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentSolutionConfigurationModel" }, "example": { "documentSolutionConfigurationGuid": "string", "documentSolutionGuid": "string", "subscriptionGuid": "string", "ownerGuid": "string", "lastModifiedUserGuid": "string", "name": "string", "description": "string", "title": "string", "fileFormat": "string", "processingType": "string", "deliveryMethod": "string", "path": "string", "pdfConformanceLevel": "string", "pdfVersion": "string", "language": "string", "locale": "string", "timeZone": "string", "embeddedData": "string", "viewAnonymous": true, "editAnonymous": true, "viewOrganization": true, "editOrganization": true, "viewUser": true, "editUser": true, "viewUserEmailList": "string", "editUserEmailList": "string", "createdDate": "string", "lastModifiedDate": "string", "isDeleted": true } } } }, "responses": { "200": { "description": "Configuration updated successfully.", "content": { "application/json": { "schema": { "type": "object", "properties": { "documentSolutionConfiguration": { "type": "object", "properties": { "documentSolutionConfigurationGuid": { "type": "string", "format": "uuid" }, "documentSolutionGuid": { "type": "string", "format": "uuid" }, "subscriptionGuid": { "type": "string", "format": "uuid" }, "ownerGuid": { "type": "string", "format": "uuid" }, "lastModifiedUserGuid": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "fileFormat": { "type": "string", "nullable": true }, "processingType": { "type": "string", "nullable": true }, "deliveryMethod": { "type": "string", "nullable": true }, "path": { "type": "string", "nullable": true }, "pdfConformanceLevel": { "type": "string", "nullable": true }, "pdfVersion": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "locale": { "type": "string", "nullable": true }, "timeZone": { "type": "string", "nullable": true }, "embeddedData": { "type": "string", "nullable": true }, "viewAnonymous": { "type": "boolean" }, "editAnonymous": { "type": "boolean" }, "viewOrganization": { "type": "boolean" }, "editOrganization": { "type": "boolean" }, "viewUser": { "type": "boolean" }, "editUser": { "type": "boolean" }, "viewUserEmailList": { "type": "string", "nullable": true }, "editUserEmailList": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "lastModifiedDate": { "type": "string", "format": "date-time" }, "isDeleted": { "type": "boolean" } } } } }, "example": { "documentSolutionConfiguration": { "documentSolutionConfigurationGuid": "string", "documentSolutionGuid": "string", "subscriptionGuid": "string", "ownerGuid": "string", "lastModifiedUserGuid": "string", "name": "string", "description": "string", "title": "string", "fileFormat": "string", "processingType": "string", "deliveryMethod": "string", "path": "string", "pdfConformanceLevel": "string", "pdfVersion": "string", "language": "string", "locale": "string", "timeZone": "string", "embeddedData": "string", "viewAnonymous": true, "editAnonymous": true, "viewOrganization": true, "editOrganization": true, "viewUser": true, "editUser": true, "viewUserEmailList": "string", "editUserEmailList": "string", "createdDate": "string", "lastModifiedDate": "string", "isDeleted": true } } } } } } } }, "/documents/solution/{documentSolutionGuid}/update": { "put": { "tags": [ "Document Solution" ], "summary": "Document Solution Update", "description": "Updates the properties of an existing document solution.", "operationId": "document-solution-update", "parameters": [ { "name": "documentSolutionGuid", "in": "path", "description": "The unique identifier (GUID) of the solution to update.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request.", "required": true, "schema": { "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access.", "required": true, "schema": { "type": "string", "default": "{{apiKey}}" } } ], "requestBody": { "description": "The document solution object containing updated values.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentSolutionModel" }, "example": { "documentSolutionGuid": "string", "subscriptionGuid": "string", "ownerGuid": "string", "lastModifiedUserGuid": "string", "dataGuid": "string", "name": "string", "description": "string", "createdDate": "string", "lastModifiedDate": "string", "isDeleted": true } } } }, "responses": { "200": { "description": "Solution updated successfully.", "content": { "application/json": { "schema": { "type": "object", "properties": { "documentSolution": { "type": "object", "properties": { "documentSolutionGuid": { "type": "string", "format": "uuid", "nullable": true }, "subscriptionGuid": { "type": "string", "format": "uuid", "nullable": true }, "ownerGuid": { "type": "string", "format": "uuid", "nullable": true }, "lastModifiedUserGuid": { "type": "string", "format": "uuid", "nullable": true }, "dataGuid": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "lastModifiedDate": { "type": "string", "format": "date-time" }, "isDeleted": { "type": "boolean" } } } } }, "example": { "documentSolution": { "documentSolutionGuid": "string", "subscriptionGuid": "string", "ownerGuid": "string", "lastModifiedUserGuid": "string", "dataGuid": "string", "name": "string", "description": "string", "createdDate": "string", "lastModifiedDate": "string", "isDeleted": true } } } } } } } }, "/documents/template/{documentTemplateGuid}/update": { "put": { "tags": [ "Template" ], "summary": "Template Update", "description": "Updates the metadata, parameters, or configurations of an existing template.", "operationId": "template-update", "parameters": [ { "name": "documentTemplateGuid", "in": "path", "description": "The unique identifier (GUID) of the template to update.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request.", "required": true, "schema": { "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access.", "required": true, "schema": { "type": "string", "default": "{{apiKey}}" } } ], "requestBody": { "description": "The template object containing updated values.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentTemplateModel" }, "example": { "documentTemplateGuid": "string", "subscriptionGuid": "string", "ownerGuid": "string", "lastModifiedUserGuid": "string", "name": "string", "description": "string", "title": "string", "urn": "string", "url": "string", "viewAnonymousLink": "string", "editAnonymousLink": "string", "viewUserLink": "string", "editUserLink": "string", "viewOrganizationLink": "string", "editOrganizationLink": "string", "fileFormat": "string", "loadMethod": "string", "path": "string", "createdDate": "string", "lastModifiedDate": "string", "isDeleted": true } } } }, "responses": { "200": { "description": "Template updated successfully.", "content": { "application/json": { "schema": { "type": "object", "properties": { "documentTemplate": { "type": "object", "properties": { "documentTemplateGuid": { "type": "string", "format": "uuid" }, "subscriptionGuid": { "type": "string", "format": "uuid" }, "ownerGuid": { "type": "string", "format": "uuid" }, "lastModifiedUserGuid": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "urn": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "viewAnonymousLink": { "type": "string", "nullable": true }, "editAnonymousLink": { "type": "string", "nullable": true }, "viewUserLink": { "type": "string", "nullable": true }, "editUserLink": { "type": "string", "nullable": true }, "viewOrganizationLink": { "type": "string", "nullable": true }, "editOrganizationLink": { "type": "string", "nullable": true }, "fileFormat": { "type": "string", "nullable": true }, "loadMethod": { "type": "string", "nullable": true }, "path": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "lastModifiedDate": { "type": "string", "format": "date-time" }, "isDeleted": { "type": "boolean" } } } } }, "example": { "documentTemplate": { "documentTemplateGuid": "string", "subscriptionGuid": "string", "ownerGuid": "string", "lastModifiedUserGuid": "string", "name": "string", "description": "string", "title": "string", "urn": "string", "url": "string", "viewAnonymousLink": "string", "editAnonymousLink": "string", "viewUserLink": "string", "editUserLink": "string", "viewOrganizationLink": "string", "editOrganizationLink": "string", "fileFormat": "string", "loadMethod": "string", "path": "string", "createdDate": "string", "lastModifiedDate": "string", "isDeleted": true } } } } } } } }, "/documents/option/{optionValueGuid}/update": { "put": { "tags": [ "Option Value" ], "summary": "Document Option Value Update", "description": "Updates the contents of a specific document option value.", "operationId": "document-option-value-update", "parameters": [ { "name": "optionValueGuid", "in": "path", "description": "The unique identifier (GUID) of the option value to update.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request.", "required": true, "schema": { "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access.", "required": true, "schema": { "type": "string", "default": "{{apiKey}}" } } ], "requestBody": { "description": "The option value object containing updated values.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OptionValueModel" }, "example": { "optionValueGuid": "string", "entityType": "string", "entityId": "string", "optionDefinitionId": 0, "customKey": "string", "customGroup": "string", "value": "string", "effectiveKey": "string", "effectiveGroup": "string", "systemType": "string", "createdDate": "string", "lastModifiedDate": "string" } } } }, "responses": { "200": { "description": "Option value updated successfully.", "content": { "application/json": { "schema": { "type": "object", "properties": { "optionValue": { "type": "object", "properties": { "optionValueGuid": { "type": "string", "format": "uuid" }, "entityType": { "type": "string", "nullable": true }, "entityId": { "type": "string", "format": "uuid" }, "optionDefinitionId": { "type": "integer", "nullable": true }, "customKey": { "type": "string", "nullable": true }, "customGroup": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "effectiveKey": { "type": "string", "nullable": true }, "effectiveGroup": { "type": "string", "nullable": true }, "systemType": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "lastModifiedDate": { "type": "string", "format": "date-time" } } } } }, "example": { "optionValue": { "optionValueGuid": "string", "entityType": "string", "entityId": "string", "optionDefinitionId": 0, "customKey": "string", "customGroup": "string", "value": "string", "effectiveKey": "string", "effectiveGroup": "string", "systemType": "string", "createdDate": "string", "lastModifiedDate": "string" } } } } } } } }, "/signatures/envelope/accept": { "get": { "tags": [ "Envelope" ], "summary": "Envelope Accept", "description": "Records a recipient’s explicit agreement to the legal terms or conditions associated with an envelope.
\n* The envelope is identified by a unique transactionId (tid).\n* The tid is typically obtained from the email link sent to the recipient or via the GET /signatures/envelope/list endpoint.\n* Provide the tid as a query parameter.\n* This procedure occurs before the recipient views or signs any documents.", "operationId": "post-acceptlegaltermsfunction", "parameters": [ { "name": "tid", "in": "query", "description": "This is a unique identifier associated with a specific recipient and envelope within a given transaction. It is used to securely validate that the user has the appropriate authorization to perform actions related to that transaction.", "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "This is the response returned when the agreement to the legal terms or conditions associated with an envelope is successfully recorded.", "content": { "application/json": { "schema": { "required": [ "result", "origin", "dateTime" ], "type": "object", "properties": { "result": { "required": [ "statusCode", "message", "data" ], "type": "object", "properties": { "statusCode": { "type": "integer", "description": "HTTP status code indicating the result of the operation." }, "message": { "type": "string", "description": "Descriptive message confirming the result of the request." }, "data": { "required": [ "recipient" ], "type": "object", "properties": { "recipient": { "required": [ "id", "message" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the recipient." }, "message": { "type": "string", "description": "Descriptive message generated by the system to inform the user about the details of the result." } } } } } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the request." }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the request was completed and the response returned." } } }, "example": { "result": { "statusCode": 200, "message": "OK", "data": { "recipient": { "id": "b9bb72f7-6a46-468c-8282-997aab21bf2a", "message": "Legal document successfully accepted" } } }, "origin": "GET https://dev.headless.mavenmule.com/signatures/envelope/accept", "dateTime": "2025-10-31T13:22:21.1243942+00:00" } } } }, "400": { "description": "This response indicates that the request was invalid or improperly formed.
\nIt provides details about the error that occurred, including specific error codes, messages, and guidance for the user on how to resolve the issue.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope-accept-Get400ApplicationJsonResponse" }, "example": { "error": { "statusCode": "400", "message": "Bad Request", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}", "urn": "{{sentUrn}}" } ] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}" } } } } } } }, "/signatures/envelope/{envelopeId}/edit": { "put": { "tags": [ "Envelope" ], "summary": "Envelope Edit", "description": "Edits notification-related settings for an already sent envelope.
\n* The envelope is identified using the envelopeId path parameter.\n* This endpoint allows updating:\n * Envelope expiration settings\n * Envelope notification settings, including:\n * Expiration period\n * Alerts for recipients\n* Note: Documents, recipients, or fields within the envelope are not modified.", "operationId": "changeexpirationdatefunction", "parameters": [ { "name": "envelopeId", "in": "path", "description": "The envelopeId parameter in the URL is a unique identifier for the envelope whose notification settings are being edited. It specifies which already-sent envelope should be updated with the new expiration and alert configurations.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "envelope", "externalContext" ], "type": "object", "properties": { "envelope": { "required": [ "expireInDays", "alertDaysBeforeExpiry" ], "type": "object", "properties": { "expireInDays": { "type": "integer", "description": "Number of days until the envelope expires.", "default": 7 }, "alertDaysBeforeExpiry": { "type": "integer", "description": "Number of days before expiration of the envelope when an alert should be sent to the recipients.", "default": 3 } } }, "externalContext": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "External reference ID used for contextual tracking.", "default": "12345" } } } } }, "example": { "envelope": { "expireInDays": 7, "alertDaysBeforeExpiry": 3 }, "externalContext": { "id": "12345" } } } } }, "responses": { "200": { "description": "This is the response returned when the envelope is successfully edited.", "content": { "application/json": { "schema": { "required": [ "result", "origin", "dateTime", "userId" ], "type": "object", "properties": { "result": { "required": [ "statusCode", "message", "data" ], "type": "object", "properties": { "statusCode": { "type": "integer", "description": "HTTP status code indicating the result of the operation." }, "message": { "type": "string", "description": "Descriptive message confirming the result of the request." }, "data": { "required": [ "envelope" ], "type": "object", "properties": { "envelope": { "required": [ "id", "message" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the envelope." }, "message": { "type": "string", "description": "Descriptive message generated by the system to inform the user about the details of the result." } } } } } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the request." }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the request was completed and the response returned." }, "userId": { "type": "string", "description": "The unique identifier of the user or system that initiated the request." } } }, "example": { "result": { "statusCode": 200, "message": "OK", "data": { "envelope": { "id": "e08f7851-dc1-d2ff0857c4e4", "message": "EXPIRATION_UPDATED" } } }, "origin": "PUT https://dev.headless.mavenmule.com/signatures/envelope/e08f7851-dc1-d2ff0857c4e4/edit", "dateTime": "2025-11-04T07:24:36.5239869+00:00", "userId": "1d8b89c4-0889-f09ac3bc9b" } } } }, "400": { "description": "This response indicates that the request was invalid or improperly formed.
\nIt provides details about the error that occurred, including specific error codes, messages, and guidance for the user on how to resolve the issue.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope-envelopeId-edit-Put400ApplicationJsonResponse" }, "example": { "error": { "statusCode": 400, "message": "Bad Request", "innerErrors": [ { "code": "ENVELOPE_ID_INVALID", "message": "Envelope with ID 0f6dca08-c9cc-ba71-76b883c8bbb4 does not exist", "userMessage": "Envelope with ID 0f6dca08-c9cc-ba71-76b883c8bbb4 does not exist" } ], "externalErrors": [] }, "externalContext": { "test1": "testvalue" }, "origin": "PUT https://dev.headless.mavenmule.com/signatures/envelope/0f6dca08-c9cc-ba71-76b883c8bbb4/edit", "dateTime": "2025-11-04T07:40:12.0000000+00:00", "userId": "1d8b89c4-0-9af09ac3bc9b", "operationId": "5c1354f98690612f2eec2" } } } }, "404": { "description": "This response indicates that there’s no envelope found with the provided ID.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope-envelopeId-edit-Put404ApplicationJsonResponse" }, "example": { "error": { "statusCode": "404", "message": "Not Found", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}" } ] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}" } } } } } } }, "/signatures/document/manage": { "post": { "tags": [ "Document" ], "summary": "Document Manage", "description": "Manages documents across supported platforms (Storage, Salesforce, OneDrive) without modifying their internal content.
\n* Supported operations include:\n * Copy. Duplicate a document from source to target. The operation has the following requirements:\n * Same fileFormat for source and target.\n * source.remove = \"none\".\n * Move. Transfer a document from source to target and delete it from the source. The operation has the following requirements:\n * Same fileFormat for source and target.\n * source.remove = \"delete\" or \"permanentDelete\".\n * Delete. Remove a document when only the source is provided. The operation has the following requirements:\n * source.remove = \"delete\" or \"permanentDelete\".\n * No target allowed.\n * Convert. Change document format while transferring. The operation has the following requirements:\n * Both source and target required.\n * fileFormat must differ.", "operationId": "post-convertdocxtopdf", "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } }, { "name": "X-Client-Authorization", "in": "header", "description": "Encrypted (AES) JWT token to identify and authorize the calling client system responsible for requesting the document generation. This header is required when retrieving the template and/or data used to populate the template from the client’s side, and for delivering the final generated document on the client’s side. The JWT must contain the following claims:\n\n- **_sub_**: Current user session.\n- **_Destination_**: Path to which should be used to make a callback.\n- **_full_name_**: Name of the user that made the request.\n- **_email_**: The email address of the user that made the request.\n- **_iss_**: The issuer claim identifies the principal that issued the JWT. URL of the issuer.\n- **_oid_**: Object Id claim represents a unique Id of the user that made the request, for example in Salesforce case this will be User record Id.\n- **_clientId_**: Id representing the client. Eg OrgId.\n- **_zoneInfo_**: Zone information.\n- **_locale_**: Localization information.", "schema": { "type": "string" } }, { "name": "X-Service-Authorization", "in": "header", "description": "Encrypted (AES) JWT token to represent a user that doesn’t have a Microsoft Account and that is allowed to use the subscription. The JWT must contain the following claims:\n\n- **_amp_subscription_**: The offering subscription key which is used to validate that the client has a valid license.\n- **_full_name_**: Name of the user that made the request.\n- **_email_**: The email address of the user that made the request.\n- **_iss_**: The issuer claim identifies the principal that issued the JWT. URL of the issuer.\n- **_oid_**: Object Id claim represents a unique Id of the user that made the request, for example in Salesforce case this will be User record Id.\n- **_zoneInfo_**: Zone information.\n- **_locale_**: Localization information.", "schema": { "type": "string" } } ], "requestBody": { "description": "**externalContext**
\nA contextual reference used to link the document generation request to an external system, process, or transaction. Often used for traceability or auditing purposes.\n\n---\n\n**sourceDocument**
\nIdentifies the input document and its properties, serving as the starting point for file operations like copying to a new location, moving with deletion, deleting outright, or converting to a different format.\n\n**sourceDocument.options**
\nFine-tunes the loading process for the source document to meet specific requirements, such as retaining formatting or handling special features during operations like copying or conversion.\n\n---\n\n**targetDocument**
\nDefines the properties of the output document resulting from the file operation (e.g., the destination for Copy, Move, or Convert operations). It specifies the document’s metadata, format, delivery method, storage location, and processing options, determining how the processed document is saved and managed. This node is omitted for Delete operations, as no output document is generated.\n\n**targetDocument.options.salesforce**
\nSpecifies how the document will be stored or associated with records in Salesforce. Includes fields such as `fileId`, `fileType`, `fileParentId`, and `ownerId`.\n\n**targetDocument.options.onedrive**
\nSpecifies how the document will be shared or stored via Microsoft OneDrive. Includes permission settings like anonymous access, edit/view rights, and user-specific sharing.", "content": { "application/json": { "schema": { "type": "object", "properties": { "externalContext": { "type": "object", "properties": { "id": { "type": "string", "description": "External reference ID used for contextual tracking.", "default": "12345" } } }, "sourceDocument": { "required": [ "urn", "fileFormat", "loadMethod", "remove" ], "type": "object", "properties": { "urn": { "type": "string", "description": "URN of the source document stored in the system.", "default": "{{uploadedDocument}}" }, "fileFormat": { "enum": [ "docx", "xlsx", "pdf" ], "type": "string", "description": "File format of the source document (e.g., docx, xlsx, pdf).", "default": "pdf" }, "loadMethod": { "enum": [ "Storage", "Salesforce", "OneDrive" ], "type": "string", "description": "Source of the document where it is stored (e.g., Storage, Salesforce, OneDrive).", "default": "Storage" }, "remove": { "type": "string", "description": "Flag indicating whether to remove the source document (e.g., none, delete, permanentDelete)", "default": "none" }, "options": { "type": "object", "properties": { "docxLoadOptions": { "type": "string", "description": "JSON string for DOCX load options, default \"{\\\"PreserveUnsupportedFeatures\\\": true}\".", "default": "{ \"PreserveUnsupportedFeatures\": true }" } } } } }, "targetDocument": { "required": [ "name", "fileFormat", "deliveryMethod", "path" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the target document without file extension.", "default": "Document" }, "fileFormat": { "enum": [ "docx", "xlsx", "pdf" ], "type": "string", "description": "Format of the generated document (e.g., docx, xlsx, pdf).", "default": "pdf" }, "deliveryMethod": { "enum": [ "Storage", "Salesforce", "OneDrive" ], "type": "string", "description": "Place where the document will be stored (e.g., Storage, Salesforce, OneDrive).", "default": "Storage" }, "path": { "type": "string", "description": "Target folder or path for delivery. Optional based on storage provider.", "default": "" }, "options": { "type": "object", "properties": { "pdfSaveOptions": { "type": "string", "description": "JSON string for PDF output settings, default \"{\\\"ConformanceLevel\\\": \\\"PdfA3a\\\", \\\"Version\\\": \\\"PDF_1_7\\\", \\\"ImageDpi\\\": 750}\".", "default": "{ \"ConformanceLevel\": \"PdfA3a\", \"Version\": \"PDF_1_7\", \"ImageDpi\": 750 }" }, "docxSaveOptions": { "type": "string", "description": "JSON string for DOCX output customizations.", "default": "" }, "salesforce": { "type": "object", "properties": { "networkId": { "type": "string", "description": "ID of specific Salesforce Experience Cloud site or community where the generated document should be stored or associated.", "default": "" }, "fileId": { "type": "string", "description": "ID of existing file (ContentDocument) to update/replace.", "default": "" }, "fileType": { "enum": [ "File", "Attachment" ], "type": "string", "description": "File handling capabilities in Salesforce (e.g., File, Attachment).", "default": "" }, "fileParentId": { "type": "string", "description": "Salesforce record to which the file is attached.", "default": "" }, "ownerId": { "type": "string", "description": "Salesforce user or queue ID who should own the file.", "default": "" } } }, "onedrive": { "type": "object", "properties": { "viewAnonymous": { "type": "boolean", "description": "Allow public viewing via link of the generated document.", "default": false }, "editAnonymous": { "type": "boolean", "description": "Allow public editing via link of the generated document.", "default": false }, "editUsers": { "type": "array", "items": { "type": "string", "default": "user@example.com" }, "description": "List of users for the link with edit access." }, "viewUsers": { "type": "array", "items": { "type": "string", "default": "user@example.com" }, "description": "List of users for the link with view access." } } } } } } }, "data": { "type": "object", "properties": { "embedded": { "type": "string", "description": "Arbitrary key-value pairs written into PDF document properties.", "default": "" } } } } }, "example": "{\n \"externalContext\": {\n \"id\": \"12345\"\n },\n \"sourceDocument\": {\n \"urn\": \"{{uploadedDocument}}\",\n \"fileFormat\": \"pdf\",\n \"loadMethod\": \"Storage\",\n \"remove\": \"none\",\n \"options\": {\n \"docxLoadOptions\": \"{}\"\n }\n },\n \"targetDocument\": {\n \"name\": \"CopiedTest\",\n \"fileFormat\": \"pdf\",\n \"deliveryMethod\": \"Storage\",\n \"path\": \"root\",\n \"options\": {\n \"pdfSaveOptions\": \"{ \\\"ConformanceLevel\\\": \\\"PdfA3a\\\", \\\"Version\\\": \\\"PDF_1_7\\\", \\\"ImageDpi\\\": 750 }\",\n \"docxSaveOptions\": \"{}\",\n \"salesforce\": {\n \"networkId\": \"\",\n \"fileId\": \"\",\n \"fileType\": \"\", //Attachment, File\n \"fileParentId\": \"\",\n \"ownerId\": \"\"\n },\n \"onedrive\": {\n \"viewAnonymous\": true,\n \"editAnonymous\": true,\n \"editUsers\": [\n \"user@example.com\",\n \"user@example.com\" \n ],\n \"viewUsers\": [\n \"user@example.com\",\n \"user@example.com\" \n ]\n }\n }\n },\n \"data\": {\n \"embedded\": \"\"\n }\n}" } } }, "responses": { "201": { "description": "This response confirms that the document management operation (such as copy, move, delete, or convert) was successfully completed.
\nIt returns metadata about the resulting document, including its name, format, storage location, and URN.
\nThe response also includes consumption metrics indicating how many documents and pages were processed, which are relevant for billing or quotas.", "content": { "application/json": { "schema": { "required": [ "result", "consumption", "externalContext", "origin", "dateTime", "userId", "operationId" ], "type": "object", "properties": { "result": { "required": [ "statusCode", "message", "data" ], "type": "object", "properties": { "statusCode": { "enum": [ "201" ], "type": "string", "description": "Confirming the document was successfully managed." }, "message": { "type": "string", "description": "A simple status message." }, "data": { "required": [ "document" ], "type": "object", "properties": { "document": { "required": [ "deliveryMethod", "name", "fileFormat", "urn" ], "type": "object", "properties": { "deliveryMethod": { "enum": [ "Salesforce", "Storage", "OneDrive" ], "type": "string", "description": "The source system where the managed document is stored." }, "name": { "type": "string", "description": "The name of the managed document (without file extension)." }, "fileFormat": { "enum": [ "docx", "xlsx", "pdf" ], "type": "string", "description": "The format of the managed document." }, "urn": { "type": "string", "description": "A unique identifier used to retrieve or reference the managed document." } } } } } } }, "consumption": { "type": "array", "items": { "required": [ "dimension", "value" ], "type": "object", "properties": { "dimension": { "enum": [ "pages-managed", "documents-managed" ], "type": "string", "description": "The type of resource consumed (e.g., pages-managed, documents-managed)." }, "value": { "type": "number", "description": "The measured quantity for the dimension." } } } }, "externalContext": { "required": [ "actionRequestId" ], "type": "object", "properties": { "actionRequestId": { "type": "string", "description": "External reference ID used for contextual tracking." } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the request." }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the request was completed and the response returned." }, "userId": { "type": "string", "description": "The unique identifier of the user or system that initiated the request." }, "operationId": { "type": "string", "description": "A system-generated ID that uniquely identifies this operation. Can be used for tracing, auditing, or support." } } }, "example": { "result": { "statusCode": "201", "message": "Created", "data": { "document": { "deliveryMethod": "Storage", "name": "Sales Agreement DOCX", "fileFormat": "pdf", "urn": "20b8feea-a8e6-929d-5beb67a290b8" } } }, "consumption": [ { "dimension": "pages-managed", "value": 5 }, { "dimension": "documents-managed", "value": 1 } ], "origin": "POST https://dev.headless.mavenmule.com/signatures/document/manage", "dateTime": "2025-11-05T11:02:16.4722505+00:00", "userId": "1d8b89c4-0889-0c-9af09ac3bc9b", "operationId": "a9733c420a9e6336ea36ed98f31" } } } }, "400": { "description": "This response indicates that the request was invalid or improperly formed.
\nIt provides details about the error that occurred, including specific error codes, messages, and guidance for the user on how to resolve the issue.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document-manage-Post400ApplicationJsonReponse" }, "example": { "error": { "statusCode": "400", "message": "Bad Request", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}", "eventId": "{{eventId}}" } ], "externalErrors": [] }, "externalContext": { "actionRequestId": "{{externalContextId}}" }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}", "userId": "{{userId}}", "operationId": "{{operationId}}" } } } } } } }, "/signatures/envelope/decline": { "post": { "tags": [ "Envelope" ], "summary": "Envelope Decline", "description": "Declines a sent envelope.
\n* The envelope is identified using the transactionId (tid) query parameter, typically obtained from the GET /signatures/envelope/list endpoint.\n* This endpoint is for recipients only to refuse signing or completing the envelope, for example, due to disagreements with the document content.\n* Senders cannot decline an envelope.\n* Declining an envelope updates its status to \"Declined\".", "operationId": "declinefunction", "parameters": [ { "name": "tid", "in": "query", "description": "This is a unique identifier associated with a specific recipient and envelope within a given transaction. It is used to securely validate that the user has the appropriate authorization to perform actions related to that transaction.", "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "envelope" ], "type": "object", "properties": { "envelope": { "type": "object", "properties": { "declineReason": { "type": "string", "description": "The reason provided by the user for declining the envelope." } } } } }, "example": { "envelope": { "declineReason": "test" } } } } }, "responses": { "200": { "description": "This is the response returned when the envelope is successfully declined.", "content": { "application/json": { "schema": { "required": [ "result", "origin", "dateTime" ], "type": "object", "properties": { "result": { "required": [ "statusCode", "message", "data" ], "type": "object", "properties": { "statusCode": { "type": "integer", "description": "HTTP status code indicating the result of the operation." }, "message": { "type": "string", "description": "Descriptive message confirming the result of the request." }, "data": { "required": [ "envelope" ], "type": "object", "properties": { "envelope": { "required": [ "id", "message" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the envelope." }, "message": { "type": "string", "description": "Descriptive message generated by the system to inform the user about the details of the result." } } } } } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the request." }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the request was completed and the response returned." } } }, "example": { "result": { "statusCode": 200, "message": "OK", "data": { "envelope": { "id": "cc25cdaa-c6c3-4014-b29c-2f741f612ae0", "message": "Envelope successfully declined" } } }, "origin": "POST https://dev.headless.mavenmule.com/signatures/envelope/decline", "dateTime": "2025-11-03T12:29:54.7288359+00:00" } } } }, "400": { "description": "This response indicates that the request was invalid or improperly formed.
\nIt provides details about the error that occurred, including specific error codes, messages, and guidance for the user on how to resolve the issue.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope-decline-Post400ApplicationJsonResponse" }, "example": { "error": { "statusCode": "400", "message": "Bad Request", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}", "urn": "{{sentUrn}}" } ] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}" } } } } } } }, "/signatures/envelope/{envelopeId}/delete": { "delete": { "tags": [ "Envelope" ], "summary": "Envelope Delete", "description": "Deletes a specific envelope from the system.
\n* The envelope is identified using the envelopeId path parameter.\n* Only envelopes in the \"Draft\" state can be deleted, allowing the sender to discard envelopes that have not yet been sent to recipients.", "operationId": "delete-deleteenvelope", "parameters": [ { "name": "envelopeId", "in": "path", "description": "The ID of the envelope that should be deleted.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "This is the response returned when the envelope is successfully deleted.", "content": { "application/json": { "schema": { "required": [ "result", "origin", "dateTime", "userId" ], "type": "object", "properties": { "result": { "required": [ "statusCode", "message", "data" ], "type": "object", "properties": { "statusCode": { "type": "integer", "description": "HTTP status code indicating the result of the operation." }, "message": { "type": "string", "description": "Descriptive message confirming the result of the request." }, "data": { "required": [ "envelope" ], "type": "object", "properties": { "envelope": { "required": [ "id", "message" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the envelope." }, "message": { "type": "string", "description": "Descriptive message generated by the system to inform the user about the details of the result." } } } } } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the request." }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the request was completed and the response returned." }, "userId": { "type": "string", "description": "The unique identifier of the user or system that initiated the request." } } }, "example": { "result": { "statusCode": 200, "message": "OK", "data": { "envelope": { "id": "789cb83f-fdd", "message": "Envelope successfully deleted" } } }, "origin": "DELETE https://dev.headless.mavenmule.com/signatures/envelope/789cb83f-fdd/delete", "dateTime": "2025-11-03T12:40:42.3556288+00:00", "userId": "1d8b89c4--a90c-9af09ac3bc9b" } } } }, "400": { "description": "This response indicates that the request was invalid or improperly formed.
\nIt provides details about the error that occurred, including specific error codes, messages, and guidance for the user on how to resolve the issue.", "content": { "application/json": { "schema": { "required": [ "error", "origin", "dateTime", "userId", "operationId" ], "type": "object", "properties": { "error": { "required": [ "statusCode", "message", "innerErrors", "externalErrors" ], "type": "object", "properties": { "statusCode": { "enum": [ "400" ], "type": "string", "description": "Indicating a bad request was made." }, "message": { "type": "string", "description": "A high-level description of the error." }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage", "eventId" ], "type": "object", "properties": { "code": { "type": "string", "description": "An error code indicating the type of issue encountered." }, "message": { "type": "string", "description": "A description of the specific error encountered." }, "userMessage": { "type": "string", "description": "A message intended for the end-user, advising on how to resolve the issue." }, "eventId": { "type": "string", "description": "A unique identifier for tracing the error in logs or debugging." } } } }, "externalErrors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code from the external service." }, "message": { "type": "string", "description": "A description of the external error." } }, "description": "Detailed list of errors originating from external services." } } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the request." }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the request was completed and the response returned." }, "userId": { "type": "string", "description": "The unique identifier of the user or system that initiated the request." }, "operationId": { "type": "string", "description": "A system-generated ID that uniquely identifies this operation. Can be used for tracing, auditing, or support." } } }, "example": { "error": { "statusCode": "400", "message": "Bad Request", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}" } ], "externalErrors": [] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}", "userId": "{{userId}}", "operationId": "{{operationId}}" } } } } } } }, "/signatures/envelope/list": { "get": { "tags": [ "Envelope" ], "summary": "Envelope List", "description": "Retrieves a list of all envelopes associated with the authenticated user, including those created/sent by the user and those where the user is a recipient.
\n* Supports filtering, sorting, and pagination via query parameters to help developers query specific envelopes.\n* Query Parameters:\n * top (integer). Maximum number of envelopes to return (e.g., 25).\n * skip (integer). Number of envelopes to skip in the sorted results (e.g., 0).\n * sort (string). Column to sort by. Valid values: Subject, Recipients, Documents, Status, UploadDate, ExpireInDays.\n * order (string). Sort direction. Valid values: ASC, DESC.\n * folder (string). Folder to query. Valid values: Inbox, Sent, Drafts, Deleted, Action Required, Expiring Soon, Waiting for Others, Completed.\n * filter (JSON array). List of filter objects to refine results. Each filter includes:\n * column (string). Field to filter on (matches sort values).\n * condition (string). Filter condition:\n * For stringFilter: EMPTY, NOT_EMPTY, CONTAINS, CONTAINS_CASE_SENSITIVE, DOES_NOT_CONTAIN, DOES_NOT_CONTAIN_CASE_SENSITIVE, STARTS_WITH, STARTS_WITH_CASE_SENSITIVE, ENDS_WITH, ENDS_WITH_CASE_SENSITIVE, EQUAL, EQUAL_CASE_SENSITIVE, NULL, NOT_NULL.\n * For dateFilter: EQUAL, NOT_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL, GREATER_THAN, GREATER_THAN_OR_EQUAL, NULL, NOT_NULL.\n * value (string). Filter value:\n * string for stringFilter.\n * YYYY-MM-DD for dateFilter.\n * type (string):\n * Either stringFilter.\n * dateFilter.\n * key (string). Unique 12-character alphanumeric identifier for the filter.\n\nFilter example:
\n`envelope/list?$top=25&$skip=0&$sort=Subject&$order=ASC&$filter=[{\"column\":\"status\",\"condition\":\"CONTAINS\",\"value\":\"Failed\",\"type\":\"stringFilter\",\"key\":\"6e2d9f910ad9\"},{\"column\":\"uploadDate\",\"condition\":\"EQUAL\",\"value\":\"2025-06-30\",\"type\":\"dateFilter\",\"key\":\"068d7e1baf7d\"}]&$folder=Inbox`", "operationId": "get-envelope-page", "parameters": [ { "name": "top", "in": "query", "description": "Maximum number of envelopes to return.", "schema": { "type": "integer" } }, { "name": "skip", "in": "query", "description": "Number of envelopes to skip in the sorted results.", "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "description": "Column to sort by the results.", "schema": { "enum": [ "Subject", "Recipients", "Documents", "Status", "UploadDate", "ExpireInDays" ], "type": "string" } }, { "name": "order", "in": "query", "description": "The direction of the sort.", "schema": { "enum": [ "ASC", "DESC" ], "type": "string" } }, { "name": "folder", "in": "query", "description": "Specifies the envelope folder to query.", "schema": { "enum": [ "Inbox", "Sent", "Drafts", "Deleted", "Action Required", "Expiring Soon", "Waiting for Others", "Completed" ], "type": "string" } }, { "name": "filter", "in": "query", "description": "List of filter objects to refine results. Each filter includes:
\n* column (string). Field to filter on.\n* condition (string). Filter condition.\n* value (string). Filter value.\n* type (string):\n * stringFilter.\n * dateFilter.\n* key (string). Unique 12-character alphanumeric identifier for the filter.", "schema": { "enum": [ "Empty", "Not Empty", "Contains", "Contains Case Sensitive", "Does Not Contain", "Does Not Contain Case Sensitive", "Starts With", "Starts With Case Sensitive", "Ends With", "Ends With Case Sensitive", "Equal", "Equal Case Sensitive", "Null", "Not Null", "Less Than", "Less Than Or Equal", "Greater Than", "Greater Than Or Equal" ], "type": "JSON Array" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "This is the response returned when the list of available envelopes is successfully retrieved.", "content": { "application/json": { "schema": { "required": [ "result", "origin", "dateTime", "userId" ], "type": "object", "properties": { "result": { "required": [ "statusCode", "message", "data" ], "type": "object", "properties": { "statusCode": { "type": "integer", "description": "HTTP status code indicating the result of the operation." }, "message": { "type": "string", "description": "Descriptive message confirming the result of the request." }, "data": { "required": [ "envelopes", "rowCount" ], "type": "object", "properties": { "envelopes": { "type": "array", "items": { "required": [ "id", "createdBy", "creatorGuid", "status", "uploadDate", "sendDate", "subject", "transactionTokenId", "documents", "recipients", "isSignOrder", "expireInDays", "alertDaysBeforeExpiry" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the envelope." }, "createdBy": { "required": [ "id", "name", "email" ], "type": "object", "properties": { "id": { "type": "string", "description": "ID of the user who created the envelope." }, "name": { "type": "string", "description": "Name of the user who created the envelope." }, "email": { "type": "string", "description": "Email address of the creator." } } }, "creatorGuid": { "type": "string", "description": "GUID of the envelope creator." }, "status": { "type": "string", "description": "Current status of the envelope." }, "uploadDate": { "type": "string", "description": "Timestamp when the envelope was uploaded." }, "sendDate": { "type": "string", "description": "Timestamp when the envelope was sent." }, "subject": { "type": "string", "description": "Subject of the email sent with the envelope." }, "transactionTokenId": { "type": "string", "description": "Transaction token ID." }, "documents": { "type": "string", "description": "Name of the document in the envelope." }, "recipients": { "type": "string", "description": "Email address of the recipient." }, "isSignOrder": { "type": "boolean", "description": "Indicates if signing order is enforced." }, "expireInDays": { "type": "integer", "description": "Number of days until the envelope expires." }, "alertDaysBeforeExpiry": { "type": "integer", "description": "Number of days before expiry when alerts are sent." } } }, "description": "List of envelope objects returned by the request." }, "rowCount": { "type": "integer", "description": "Total count of envelopes returned." } } } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the request." }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the request was completed and the response returned." }, "userId": { "type": "string", "description": "The unique identifier of the user or system that initiated the request." } } }, "example": { "result": { "statusCode": 200, "message": "OK", "data": { "envelopes": [ { "id": "e08f7851-d2ff0857c4e4", "createdBy": { "id": "1d8b89c4-0889-49ac3bc9b", "name": "Roman", "email": "roman.khryshchanovich@mavenmule.com" }, "creatorGuid": "1d8b89c4-0889-49ac3bc9b", "status": "In Progress", "uploadDate": "2025-11-04T07:23:47.8770000+00:00", "sendDate": "2025-11-04T07:23:48.5600000+00:00", "subject": "Test", "transactionTokenId": "585194c6-af-1bf1f2d", "documents": "Sales Agreement.pdf", "recipients": "roman.khryshchanovich@mavenmule.com", "isSignOrder": false, "expireInDays": 30, "alertDaysBeforeExpiry": 1 }, { "id": "05a9ee69-ba1309b9ce", "createdBy": { "id": "1d8b89c4-0889f09ac3bc9b", "name": "Roman", "email": "roman.khryshchanovich@mavenmule.com" }, "creatorGuid": "1d8b89c4-09af09ac3bc9b", "status": "Declined", "uploadDate": "2025-11-04T07:07:47.9530000+00:00", "sendDate": "2025-11-04T07:07:49.6970000+00:00", "subject": "Test", "transactionTokenId": "a40194aa-f516de44d", "documents": "Sales Agreement.pdf", "recipients": "roman.khryshchanovich@mavenmule.com", "isSignOrder": false, "expireInDays": 30, "alertDaysBeforeExpiry": 1 }, { "id": "b1ddf86c-f16dfe4be11", "createdBy": { "id": "1d8b89c4-0889-9ac3bc9b", "name": "Roman", "email": "roman.khryshchanovich@mavenmule.com" }, "creatorGuid": "1d8b89c4-08809ac3bc9b", "status": "Completed", "uploadDate": "2025-11-04T07:05:59.4630000+00:00", "sendDate": "2025-11-04T07:06:00.0130000+00:00", "subject": "Test", "transactionTokenId": "b9e434c9-d09363157a", "documents": "Sales Agreement.pdf", "recipients": "roman.khryshchanovich@mavenmule.com", "isSignOrder": false, "expireInDays": 30, "alertDaysBeforeExpiry": 1 }, { "id": "cc25cdaa-c6c3-1f612ae0", "createdBy": { "id": "1d8b89c4-0889f09ac3bc9b", "name": "Roman", "email": "roman.khryshchanovich@mavenmule.com" }, "creatorGuid": "1d8b89c4-0f09ac3bc9b", "status": "Declined", "uploadDate": "2025-11-03T12:19:00.3600000+00:00", "sendDate": "2025-11-03T12:19:02.3100000+00:00", "subject": "TestPOstman", "transactionTokenId": "cf04e45d-e4d6b5367", "documents": "Sales Agreement.pdf", "recipients": "roman.khryshchanovich@mavenmule.com", "isSignOrder": false, "expireInDays": 30, "alertDaysBeforeExpiry": 1 }, { "id": "7a5d6a40-a222-4ce490ef1", "createdBy": { "id": "1d8b89c4-0889-409ac3bc9b", "name": "Roman", "email": "roman.khryshchanovich@mavenmule.com" }, "creatorGuid": "1d8b89c4-0889-4c3bc9b", "status": "Completed", "uploadDate": "2025-11-03T06:46:32.8830000+00:00", "sendDate": "2025-11-03T06:46:34.6300000+00:00", "subject": "TestPostman", "transactionTokenId": "98268dcc-ade3100dab", "documents": "Sales Agreement.pdf", "recipients": "roman.khryshchanovich@mavenmule.com", "isSignOrder": false, "expireInDays": 30, "alertDaysBeforeExpiry": 1 }, { "id": "eab98526-e8ec-4ca99dc", "createdBy": { "id": "1d8b89c4-0889-4d0c3bc9b", "name": "Roman", "email": "roman.khryshchanovich@mavenmule.com" }, "creatorGuid": "1d8b89c4-0889-4dac3bc9b", "status": "Completed", "uploadDate": "2025-10-31T12:57:01.8400000+00:00", "sendDate": "2025-10-31T12:57:03.8330000+00:00", "subject": "TestConsole", "transactionTokenId": "18b5fc5f-d0f9e3c895", "documents": "Sales Agreement DOCX.pdf", "recipients": "roman.khryshchanovich@mavenmule.com", "isSignOrder": false, "expireInDays": 30, "alertDaysBeforeExpiry": 1 }, { "id": "8952012a-b086-de18b4", "createdBy": { "id": "1d8b89c4-0889-4c3bc9b", "name": "Roman", "email": "roman.khryshchanovich@mavenmule.com" }, "creatorGuid": "1d8b89c4-088909ac3bc9b", "status": "Canceled", "uploadDate": "2025-10-31T09:37:33.4570000+00:00", "sendDate": "2025-10-31T09:41:07.2470000+00:00", "subject": "TestPostman", "transactionTokenId": "22822556-474c4e8d3d", "documents": "Test Document Name", "recipients": "roman.khryshchanovich@mavenmule.com", "isSignOrder": false, "expireInDays": 5, "alertDaysBeforeExpiry": 5 }, { "id": "7bcfe3ed-fc03-f2811cc614", "createdBy": { "id": "1d8b89c4-0889-49ac3bc9b", "name": "Roman", "email": "roman.khryshchanovich@mavenmule.com" }, "creatorGuid": "1d8b89c4-0809ac3bc9b", "status": "Completed", "uploadDate": "2025-10-31T06:54:51.5030000+00:00", "sendDate": "2025-10-31T06:54:53.4200000+00:00", "subject": "TestPostman", "transactionTokenId": "4488c59f-8e46e2fd03", "documents": "Sales Agreement.pdf", "recipients": "roman.khryshchanovich@mavenmule.com", "isSignOrder": false, "expireInDays": 30, "alertDaysBeforeExpiry": 1 }, { "id": "39318715-3fee-40b2055ea", "createdBy": { "id": "1d8b89c4-0889-09ac3bc9b", "name": "Roman", "email": "roman.khryshchanovich@mavenmule.com" }, "creatorGuid": "1d8b89c4-088-9af09ac3bc9b", "status": "In Progress", "uploadDate": "2025-10-31T06:36:22.2870000+00:00", "sendDate": "2025-10-31T06:36:24.0370000+00:00", "subject": "TestPostman", "transactionTokenId": null, "documents": "Sales Agreement.pdf", "recipients": "doloreskorben@gmail.com", "isSignOrder": false, "expireInDays": 30, "alertDaysBeforeExpiry": 1 } ], "rowCount": 9 } }, "origin": "GET https://dev.headless.mavenmule.com/signatures/envelope/list", "dateTime": "2025-11-04T07:24:14.0335257+00:00", "userId": "1d8b89c4-09af09ac3bc9b" } } } }, "400": { "description": "This response indicates that the request was invalid or improperly formed.
\nIt provides details about the error that occurred, including specific error codes, messages, and guidance for the user on how to resolve the issue.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope-list-Get400ApplicationJsonResponse" }, "example": { "error": { "statusCode": "400", "message": "Bad Request", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}", "urn": "{{sentUrn}}" } ] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}" } } } } } } }, "/signatures/document/{documentId}/get": { "get": { "tags": [ "Document", "Data" ], "summary": "Document Get", "description": "Retrieves metadata for a document included in an envelope in JSON format.
\n* Use the documentId (a unique document URN) to reference the document that is included into an envelope.\n* The request returns the document data in JSON format.\n* The document can be identified by a unique transactionId (tid).\n* Provide the tid as a query parameter.", "operationId": "get-getdocument", "parameters": [ { "name": "documentId", "in": "path", "description": "The ID(URN) of the document that is included into an envelope.", "required": true, "schema": { "type": "string" } }, { "name": "tid", "in": "query", "description": "This is a unique identifier associated with a specific recipient and envelope within a given transaction. It is used to securely validate that the user has the appropriate authorization to perform actions related to that transaction.", "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "The response body contains the data of the respective document in the JSON format.", "content": { "application/json": { "schema": { "required": [ "result", "origin", "dateTime", "userId" ], "type": "object", "properties": { "result": { "required": [ "statusCode", "message", "data" ], "type": "object", "properties": { "statusCode": { "type": "integer", "description": "HTTP status code indicating the result of the operation." }, "message": { "type": "string", "description": "Descriptive message confirming the result of the request." }, "data": { "required": [ "document" ], "type": "object", "properties": { "document": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the document." }, "name": { "type": "string", "description": "Name of the document." }, "externalContext": { "type": "object", "additionalProperties": { "type": "string" }, "description": "External reference ID used for contextual tracking." } } } } } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the request." }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the request was completed and the response returned." }, "userId": { "type": "string", "description": "The unique identifier of the user or system that initiated the request." } } }, "example": { "result": { "statusCode": 200, "message": "OK", "data": { "document": { "id": "629d2b7e-378f-46e-4e5646764c4d", "name": "Test Document Name", "externalContext": { "test1": "testvaluedocument" } } } }, "origin": "GET https://dev.headless.mavenmule.com/signatures/document/629d2b7e-378f-46e-4e5646764c4d/get", "dateTime": "2025-10-31T11:03:32.9773740+00:00", "userId": "1d8b89c4-0889-a90c-9af09ac3bc9b" } } } }, "400": { "description": "This response indicates that the request was invalid or improperly formed.
\nIt provides details about the error that occurred, including specific error codes, messages, and guidance for the user on how to resolve the issue.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document-documentId-get-Get400ApplicationJsonResponse" }, "example": { "error": { "statusCode": 400, "message": "Bad Request", "innerErrors": [ { "code": "DOCUMENT_ID_INVALID", "message": "Document with ID feea3b5df-9c328c0e does not exist", "userMessage": "Document with ID f-27f0cc328c0e does not exist" } ], "externalErrors": [] }, "origin": "GET https://dev.headless.mavenmule.com/signatures/document/feea3b5d-27f0cc328c0e/get", "dateTime": "2025-11-03T07:39:02.0000000+00:00", "userId": "1d8b89c4-09ac3bc9b", "operationId": "7ebd502c3e1ef9792" } } } }, "404": { "description": "This response indicates that the file with the provided ID is not found in the envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document-documentId-get-Get404ApplicationJsonResponse" }, "example": { "error": { "statusCode": "404", "message": "Not Found", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}" } ] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}" } } } } } } }, "/signatures/envelope/{envelopeId}/audit/get": { "get": { "tags": [ "Envelope", "AuditTrail" ], "summary": "Envelope Audit Log Get", "description": "Retrieves the audit trail for a specific envelope in JSON format.
\n* The envelope is identified using the envelopeId path parameter.\n* The JSON response contains a detailed log of all actions related to the envelope, including creation, sending, legal terms acceptance, receipt, and signing, performed by users or recipients.\n* This endpoint tracks the envelope’s lifecycle, supporting transparency, compliance, and accountability in the document signing workflow.", "operationId": "get-getenvelopeaudittrail", "parameters": [ { "name": "envelopeId", "in": "path", "description": "The ID of the envelope where the attachment will be added.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "The response body contains the data of the Audit trail in the JSON format.", "content": { "application/json": { "schema": { "required": [ "result", "origin", "dateTime", "userId" ], "type": "object", "properties": { "result": { "required": [ "statusCode", "message", "data" ], "type": "object", "properties": { "statusCode": { "type": "integer", "description": "HTTP status code indicating the result of the operation." }, "message": { "type": "string", "description": "Descriptive message confirming the result of the request." }, "data": { "required": [ "auditTrails" ], "type": "object", "properties": { "auditTrails": { "type": "array", "items": { "required": [ "id", "user", "action", "timestamp", "ipAddress", "additionalInfo" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the audit trail record." }, "user": { "required": [ "id", "name", "email" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the user who performed the action." }, "name": { "type": "string", "description": "Full name of the user." }, "email": { "type": "string", "description": "Email address of the user." } } }, "recipient": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the recipient." }, "name": { "type": "string", "description": "Full name of the recipient." }, "email": { "type": "string", "description": "Email of the recipient." } } }, "signGroup": { "type": "string", "description": "Optional signing group." }, "action": { "type": "string", "description": "Text description of the action performed." }, "timestamp": { "type": "string", "description": "UTC date and time when the action was performed.", "format": "date-time" }, "ipAddress": { "type": "string", "description": "IP address from which the action originated." }, "additionalInfo": { "type": "string", "description": "Any extra information associated with the audit entry." } } }, "description": "A list of audit events related to the envelope or recipient actions." } } } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the request." }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the request was completed and the response returned." }, "userId": { "type": "string", "description": "The unique identifier of the user or system that initiated the request." } } }, "example": { "result": { "statusCode": 200, "message": "OK", "data": { "auditTrails": [ { "id": "{{auditTrailId}}", "user": { "id": "{{userId}}", "name": "{{userName}}", "email": "{{userEmail}}" }, "recipient": { "id": "{{recipientId}}", "name": "{{recipientName}}", "email": "{{recipientEmail}}" }, "signGroup": "{{signGroupValue}}", "action": "{{actionDescription}}", "timestamp": "{{actionTimestamp}}", "ipAddress": "{{ipAddress}}", "additionalInfo": "{{additionalInfo}}" } ] } }, "origin": "{{requestOrigin}}", "dateTime": "{{responseTimestamp}}", "userId": "{{requestingUserId}}" } } } }, "400": { "description": "This response indicates that the request was invalid or improperly formed.
\nIt provides details about the error that occurred, including specific error codes, messages, and guidance for the user on how to resolve the issue.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope-envelopeId-audit-get-Get400ApplicationJsonResponse" }, "example": { "error": { "statusCode": "400", "message": "Bad Request", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}", "urn": "{{sentUrn}}" } ] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}" } } } }, "404": { "description": "This response indicates that there’s no Audit Trail found in the envelope with the provided ID.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope-envelopeId-audit-get-Get404ApplicationJsonResponse" }, "example": { "error": { "statusCode": "404", "message": "Not Found", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}" } ] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}" } } } } } } }, "/signatures/envelope/{envelopeId}/get": { "get": { "tags": [ "Envelope" ], "summary": "Envelope Get", "description": "Retrieves details of a specific envelope in JSON format.
\n* The envelope is identified using the envelopeId path parameter.\n* Secure access is ensured via the transactionId (tid) query parameter, restricting visibility to authorized recipients. The tid can be obtained from the GET /signatures/envelope/list endpoint.\n* This endpoint is available only to recipients for whom the envelope is intended.", "operationId": "get-getenvelopefunction", "parameters": [ { "name": "envelopeId", "in": "path", "description": "The ID of the needed envelope.", "required": true, "schema": { "type": "string" } }, { "name": "tid", "in": "query", "description": "This is a unique identifier associated with a specific recipient and envelope within a given transaction. It is used to securely validate that the user has the appropriate authorization to perform actions related to that transaction.", "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "This is the response returned when the envelope is successfully retrieved.", "content": { "application/json": { "schema": { "required": [ "result", "origin", "dateTime", "userId" ], "type": "object", "properties": { "result": { "required": [ "statusCode", "message", "data" ], "type": "object", "properties": { "statusCode": { "type": "integer", "description": "HTTP status code indicating the result of the operation." }, "message": { "type": "string", "description": "Descriptive message confirming the result of the request." }, "data": { "required": [ "envelope" ], "type": "object", "properties": { "envelope": { "required": [ "id", "message", "createdBy", "status", "subject" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the envelope." }, "createdBy": { "type": "object", "properties": { "id": { "type": "string", "description": "Creator's user ID." }, "name": { "type": "string", "description": "Creator's full name." }, "email": { "type": "string", "description": "Creator's email address." } }, "description": "Details about the user who created the envelope." }, "uploadDate": { "type": "string", "description": "Date when the envelope was uploaded.", "format": "date-time" }, "sendDate": { "type": "string", "description": "Date when the envelope was sent.", "format": "date-time" }, "status": { "type": "string", "description": "Current status of the envelope." }, "subject": { "type": "string", "description": "Subject of the envelope email." }, "message": { "type": "string", "description": "Message body sent with the envelope." }, "isSignOrder": { "type": "boolean", "description": "Indicates if recipients must sign in order." }, "expireInDays": { "type": "integer", "description": "Number of days before the envelope expires." }, "firstReminderDays": { "type": "integer", "description": "Days before the first reminder is sent." }, "repeatingReminderDays": { "type": "integer", "description": "Interval in days for repeated reminders." }, "notifyWhenOpened": { "type": "boolean", "description": "Flag to notify when document is opened." }, "notifyWhenSigned": { "type": "boolean", "description": "Flag to notify when document is signed." }, "alertDaysBeforeExpiry": { "type": "integer", "description": "Number of days before expiry to alert user." } } }, "documents": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the document." }, "name": { "type": "string", "description": "Document name." }, "externalContext": { "type": "object", "properties": { "id": { "type": "string", "description": "External reference ID used for contextual tracking." } } } } }, "description": "List of documents in the envelope." }, "originalDocuments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Original document ID." }, "referenceDocumentId": { "type": "string", "description": "Related document ID." }, "name": { "type": "string", "description": "Name of the original document." } } }, "description": "Original document versions before processing." }, "recipients": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Recipient ID." }, "name": { "type": "string", "description": "Recipient full name." }, "email": { "type": "string", "description": "Recipient email." }, "role": { "type": "string", "description": "Recipient role." }, "status": { "type": "string", "description": "Status of recipient's signing process." }, "signDate": { "type": "string", "description": "Date when recipient signed.", "format": "date-time" }, "signOrder": { "type": "integer", "description": "Order in which recipient signs." }, "signGroupId": { "type": "string", "description": "Identifier of group recipient." }, "userId": { "type": "string", "description": "Linked user ID." }, "mandatory": { "type": "boolean", "description": "Indicates if recipient's signature is mandatory." }, "externalContext": { "type": "object", "additionalProperties": { "type": "string" }, "description": "External reference ID used for contextual tracking." } } }, "description": "List of recipients for the envelope." }, "signGroups": { "type": "array", "items": {}, "description": "Optional groups used for grouped signing logic." }, "fields": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Field ID." }, "name": { "type": "string", "description": "Field name." }, "recipientId": { "type": "string", "description": "Associated recipient ID." }, "signGroupId": { "type": "string", "description": "Associated signing group ID." }, "documentId": { "type": "string", "description": "Associated document ID." }, "type": { "type": "string", "description": "Type of field (e.g., signature, text)." }, "value": { "type": "string", "description": "Value inserted in the field." }, "page": { "type": "integer", "description": "Page number where the field is placed." }, "height": { "type": "number", "description": "Height of the field in points." }, "width": { "type": "number", "description": "Width of the field in points." }, "positionX": { "type": "number", "description": "X-axis position on the page." }, "positionY": { "type": "number", "description": "Y-axis position on the page." }, "isRequired": { "type": "boolean", "description": "Whether the field is required to complete." }, "properties": { "type": "object", "description": "Optional field metadata and properties." }, "signerInfo": { "type": "object", "description": "Additional signer metadata." } } }, "description": "List of signing or form fields in the documents." }, "externalContext": { "type": "object", "additionalProperties": { "type": "string" }, "description": "External reference ID used for contextual tracking." } } } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the request." }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the request was completed and the response returned." }, "userId": { "type": "string", "description": "The unique identifier of the user or system that initiated the request." } } }, "example": { "result": { "statusCode": 200, "message": "OK", "data": { "envelope": { "id": "e08f7851-dc1d-482ff0857c4e4", "createdBy": { "id": "1d8b89c4-0889-4dbc9b", "name": "Roman", "email": "roman.khryshchanovich@mavenmule.com" }, "uploadDate": "2025-11-04T07:23:47.0000000+00:00", "sendDate": "2025-11-04T07:23:48.0000000+00:00", "status": "In Progress", "subject": "Test", "message": "", "isSignOrder": false, "expireInDays": 30, "firstReminderDays": null, "repeatingReminderDays": null, "notifyWhenOpened": false, "notifyWhenSigned": false, "alertDaysBeforeExpiry": 1 }, "documents": [ { "id": "e3dcc1e8-636f3e477d08f", "name": "Sales Agreement.pdf", "externalContext": null } ], "originalDocuments": [ { "id": "1dfc6687-de8cf82f4e8e39", "referenceDocumentId": "e3dcc1e8-62777d08f", "name": "Sales Agreement.pdf" } ], "recipients": [ { "id": "8e5e0faf-e3226ddbe817fe1", "name": "Roman", "email": "roman.khryshchanovich@mavenmule.com", "role": "signer", "status": "In Progress", "signDate": "", "signOrder": 1, "signGroupId": "00000000-000000000000", "userId": "1d8b89c4-088909ac3bc9b", "mandatory": true, "hostEmail": "", "isMFAEnabled": false, "phoneNumber": "", "externalContext": null } ], "signGroups": [], "fields": [ { "id": "37ba1cad-a347-67de11c8dc", "name": "a4b493088d0c4284ba389500c3ad853a", "recipientId": "8e5e0faf-e30-b6ddbe817fe1", "signGroupId": "00000000-0-000000000000", "documentId": "e3dcc1e9-36f3e477d08f", "type": "signature", "value": "", "page": 1, "height": 35, "width": 100, "positionX": 69.65325, "positionY": 24.26785, "isRequired": true, "properties": null, "signerInfo": null } ], "comments": {}, "externalContext": null } }, "origin": "GET https://dev.headless.mavenmule.com/signatures/envelope/e08f7851-dc1d-482ff0857c4e4/get", "dateTime": "2025-11-04T07:24:16.1567319+00:00", "userId": "1d8b89c4-090c-9af09ac3bc9b" } } } }, "400": { "description": "This response indicates that the request was invalid or improperly formed.
\nIt provides details about the error that occurred, including specific error codes, messages, and guidance for the user on how to resolve the issue.", "content": { "application/json": { "schema": { "required": [ "error", "origin", "dateTime", "userId", "operationId" ], "type": "object", "properties": { "error": { "required": [ "statusCode", "message", "innerErrors", "externalErrors" ], "type": "object", "properties": { "statusCode": { "enum": [ "400" ], "type": "string", "description": "Indicating a bad request was made." }, "message": { "type": "string", "description": "A high-level description of the error." }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage", "eventId" ], "type": "object", "properties": { "code": { "type": "string", "description": "An error code indicating the type of issue encountered." }, "message": { "type": "string", "description": "A description of the specific error encountered." }, "userMessage": { "type": "string", "description": "A message intended for the end-user, advising on how to resolve the issue." }, "eventId": { "type": "string", "description": "A unique identifier for tracing the error in logs or debugging." } } } }, "externalErrors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code from the external service." }, "message": { "type": "string", "description": "A description of the external error." } }, "description": "Detailed list of errors originating from external services." } } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the request." }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the request was completed and the response returned." }, "userId": { "type": "string", "description": "The unique identifier of the user or system that initiated the request." }, "operationId": { "type": "string", "description": "A system-generated ID that uniquely identifies this operation. Can be used for tracing, auditing, or support." } } }, "example": { "error": { "statusCode": "404", "message": "Not Found", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}" } ] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}" } } } } } } }, "/signatures/file/retrieve": { "get": { "tags": [ "Document" ], "summary": "File Retrieve", "description": "Downloads a document using its URL.
\n* Use the documentURL parameter to specify the document link.\n* The request returns the document as a binary stream (application/octet-stream).", "operationId": "post-getfilefromurl", "parameters": [ { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "Response body contains the binary content of the requested document (e.g., a PDF file), streamed directly to the client for download.", "content": { "application/octet-stream": {} } }, "400": { "description": "This response indicates that the request was invalid or improperly formed.
\nIt provides details about the error that occurred, including specific error codes, messages, and guidance for the user on how to resolve the issue.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document-documentURL-retrieve-Get400ApplicationJsonResponse" }, "example": { "error": { "statusCode": "400", "message": "Bad Request", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}", "urn": "{{sentUrn}}" } ] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}" } } } } } } }, "/signatures/user/activity/get": { "get": { "tags": [ "Data", "User" ], "summary": "User Activity Get", "description": "Retrieves a log of recent activities performed by or associated with the authenticated user.
\n* Possible actions include:\n * Create envelope.\n * Send envelope.\n * Receive envelope.\n * View envelope.\n * Cancel envelope.\n* The response provides a detailed audit trail in JSON format, including metadata such as envelope IDs, action types, timestamps, and additional information (e.g., recipient emails or token status).", "operationId": "get-getrecentactivity", "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "This is the response returned when the template is successfully retrieved.", "content": { "application/json": { "schema": { "required": [ "result", "origin", "dateTime", "userId" ], "type": "object", "properties": { "result": { "required": [ "statusCode", "message", "data" ], "type": "object", "properties": { "statusCode": { "type": "integer", "description": "HTTP status code indicating the result of the operation." }, "message": { "type": "string", "description": "Descriptive message confirming the result of the request." }, "data": { "required": [ "activityItems" ], "type": "object", "properties": { "activityItems": { "type": "array", "items": { "required": [ "auditTrailId", "envelopeId", "subject", "action", "timestamp", "additionalInfo" ], "type": "object", "properties": { "auditTrailId": { "type": "string", "description": "Unique identifier of the audit trail record." }, "envelopeId": { "type": "string", "description": "ID of the envelope related to this activity." }, "subject": { "type": "string", "description": "Subject of the email for the creted envelope." }, "action": { "type": "string", "description": "Description of the action performed (e.g., Envelope created, sent, viewed)." }, "timestamp": { "type": "string", "description": "UTC date and time when the activity occurred." }, "additionalInfo": { "type": "string", "description": "Additional context for the action (e.g., email address or error message)." }, "transactionTokenId": { "type": "string", "description": "Transaction token associated with the activity." } } }, "description": "List of user activity entries related to envelope events." } } } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the request." }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the request was completed and the response returned." }, "userId": { "type": "string", "description": "The unique identifier of the user or system that initiated the request." } } }, "example": { "result": { "statusCode": 200, "message": "OK", "data": { "activityItems": [ { "auditTrailId": "f617632c-27560744b5ce", "envelopeId": "21d7d3d8-8-cf357729fdc3", "subject": "TestMFA", "action": "Envelope sent", "timestamp": "2025-11-04T11:25:07.3270000+00:00", "additionalInfo": "hrishchanovich92@gmail.com", "transactionTokenId": null }, { "auditTrailId": "4dcc8b0368867eb104", "envelopeId": "21d7dcf357729fdc3", "subject": "TestMFA", "action": "Envelope created", "timestamp": "2025-11-04T11:25:07.3130000+00:00", "additionalInfo": "", "transactionTokenId": null }, { "auditTrailId": "5c9014c1-820e-350e2b8cf12", "envelopeId": "c4426538-4a74d8938a066a", "subject": "TestMFA", "action": "Envelope canceled", "timestamp": "2025-11-04T11:22:47.4400000+00:00", "additionalInfo": "", "transactionTokenId": null }, { "auditTrailId": "e4671822-84342682d6ea", "envelopeId": "5e84662b-5003520f0e4293", "subject": "TestMFA", "action": "Envelope received confirmation", "timestamp": "2025-11-04T11:19:51.9670000+00:00", "additionalInfo": "", "transactionTokenId": "9aaae92c-87149c1d684" }, { "auditTrailId": "fe55fab4-5c49054d5e4711", "envelopeId": "c4426538-4a70-484d8938a066a", "subject": "TestMFA", "action": "Envelope sent", "timestamp": "2025-11-04T11:19:15.5130000+00:00", "additionalInfo": "hrishchanovich92@gmail.com", "transactionTokenId": null }, { "auditTrailId": "ecf9083e-f827c4ec32589", "envelopeId": "c4426538-44d8938a066a", "subject": "TestMFA", "action": "Envelope created", "timestamp": "2025-11-04T11:19:15.4970000+00:00", "additionalInfo": "", "transactionTokenId": null }, { "auditTrailId": "8ee219a3-62a5190980187", "envelopeId": "5e84662b-501b-40f0e4293", "subject": "TestMFA", "action": "Envelope declined", "timestamp": "2025-11-04T11:18:39.5500000+00:00", "additionalInfo": "", "transactionTokenId": "9aaae92c-a7149c1d684" }, { "auditTrailId": "aeffb154-2162-476ee41a2", "envelopeId": "5e84662b-501-03520f0e4293", "subject": "TestMFA", "action": "Accepted legal terms", "timestamp": "2025-11-04T11:18:34.0870000+00:00", "additionalInfo": "", "transactionTokenId": "9aaae92c-8d00-9cd684" }, { "auditTrailId": "2d0d5caf-a5f10-a4adcf232f", "envelopeId": "5e84662b-501b-43520f0e4293", "subject": "TestMFA", "action": "Email opened", "timestamp": "2025-11-04T11:18:13.9770000+00:00", "additionalInfo": "", "transactionTokenId": "9aa92c-8d00-4714d684" }, { "auditTrailId": "a84e6941-3338-49bdfdc8117", "envelopeId": "5e84662b-501b0f0e4293", "subject": "TestMFA", "action": "Envelope sent", "timestamp": "2025-11-04T11:17:43.5330000+00:00", "additionalInfo": "roman.khryshchanovich@mavenmule.com", "transactionTokenId": null } ] } }, "origin": "GET https://dev.headless.mavenmule.com/signatures/user/activity/get", "dateTime": "2025-11-04T12:44:32.6360862+00:00", "userId": "1d8b89c4-0889-c-9af09ac3bc9b" } } } }, "400": { "description": "This response indicates that the request was invalid or improperly formed.
\nIt provides details about the error that occurred, including specific error codes, messages, and guidance for the user on how to resolve the issue.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User-activity-get-Get400ApplicationJsonResponse" }, "example": { "error": { "statusCode": "400", "message": "Bad Request", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}", "urn": "{{sentUrn}}" } ] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}" } } } }, "404": { "description": "This response indicates that there’s no template found with the provided ID.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User-activity-get-Get404ApplicationJsonResponse" }, "example": { "error": { "statusCode": "404", "message": "Not Found", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}" } ] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}" } } } } } } }, "/signatures/envelope/resend": { "get": { "tags": [ "Envelope" ], "summary": "Envelope Resend", "description": "Resends a sent envelope to its recipients when the original email link has expired.
\n* The envelope is identified using the transactionId (tid) query parameter, which can be obtained from the GET /signatures/envelope/list endpoint.\n* This endpoint generates a new email notification containing a fresh, secure link for recipients to access the envelope.", "operationId": "get-resendlink", "parameters": [ { "name": "tid", "in": "query", "description": "This is a unique identifier associated with a specific recipient and envelope within a given transaction. It is used to securely validate that the user has the appropriate authorization to perform actions related to that transaction.", "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "This is the response returned when the envelope is successfully declined.", "content": { "application/json": { "schema": { "required": [ "result", "origin", "dateTime" ], "type": "object", "properties": { "result": { "required": [ "statusCode", "message", "data" ], "type": "object", "properties": { "statusCode": { "type": "integer", "description": "HTTP status code indicating the result of the operation." }, "message": { "type": "string", "description": "Descriptive message confirming the result of the request." }, "data": { "required": [ "envelope" ], "type": "object", "properties": { "envelope": { "required": [ "id", "message" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the envelope." }, "message": { "type": "string", "description": "Descriptive message generated by the system to inform the user about the details of the result." } } } } } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the request." }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the request was completed and the response returned." } } }, "example": { "result": { "statusCode": 200, "message": "OK", "data": { "envelope": { "id": "{{envelopeId}}", "message": "{{resendConfirmationMessage}}" } } }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}" } } } }, "400": { "description": "This response indicates that the request was invalid or improperly formed.
\nIt provides details about the error that occurred, including specific error codes, messages, and guidance for the user on how to resolve the issue.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope-resend-Get400ApplicationJsonResponse" }, "example": { "error": { "statusCode": "400", "message": "Bad Request", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}", "urn": "{{sentUrn}}" } ] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}" } } } } } } }, "/signatures/envelope/{envelopeId}/restore": { "get": { "tags": [ "Envelope" ], "summary": "Envelope Restore", "description": "Restores a previously deleted draft envelope.
\n* The envelope is identified using the envelopeId path parameter.\n* This endpoint allows the sender to recover an envelope deleted while in the \"Draft\" state.\n* Upon restoration, the envelope returns to the \"Draft\" state, enabling the sender to continue editing or sending it.", "operationId": "post-restoreenvelope", "parameters": [ { "name": "envelopeId", "in": "path", "description": "The ID of the envelope that should be restored.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "This is the response returned when the envelope is successfully deleted.", "content": { "application/json": { "schema": { "required": [ "result", "origin", "dateTime", "userId" ], "type": "object", "properties": { "result": { "required": [ "statusCode", "message", "data" ], "type": "object", "properties": { "statusCode": { "type": "integer", "description": "HTTP status code indicating the result of the operation." }, "message": { "type": "string", "description": "Descriptive message confirming the result of the request." }, "data": { "required": [ "signature" ], "type": "object", "properties": { "signature": { "required": [ "id", "message" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the created signature." }, "message": { "type": "string", "description": "Descriptive message generated by the system to inform the user about the details of the result." } } } } } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the request." }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the request was completed and the response returned." }, "userId": { "type": "string", "description": "The unique identifier of the user or system that initiated the request." } } }, "example": { "result": { "statusCode": 200, "message": "OK", "data": { "envelope": { "id": "789cb83f-c225-46f00e4bfdd", "message": "Envelope successfully restored" } } }, "origin": "GET https://dev.headless.mavenmule.com/signatures/envelope/789cb83f-c225-46f00e4bfdd/restore", "dateTime": "2025-11-04T10:22:31.6356928+00:00", "userId": "1d8b89c4-080c-9af09ac3bc9b" } } } }, "400": { "description": "This response indicates that the request was invalid or improperly formed.
\nIt provides details about the error that occurred, including specific error codes, messages, and guidance for the user on how to resolve the issue.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope-envelopeId-restore-Get400ApplicationJsonResponse" }, "example": { "error": { "statusCode": 400, "message": "Bad Request", "innerErrors": [ { "code": "ENVELOPE_ID_INVALID", "message": "Envelope with ID 1df9-be76007e25fc does not exist", "userMessage": "Envelope with ID 1df9-be76007e25fc does not exist" } ], "externalErrors": [] }, "origin": "GET https://dev.headless.mavenmule.com/signatures/envelope/1df9-be76007e25fc/restore", "dateTime": "2025-11-04T10:25:22.0000000+00:00", "userId": "1d8b89c4-090c-9af09ac3bc9b", "operationId": "0e1f8c5d78d97f0a5d2dd1" } } } }, "404": { "description": "This response indicates that there’s no envelope found with the provided ID.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope-envelopeId-restore-Get404ApplicationJsonResponse" }, "example": { "error": { "statusCode": "404", "message": "Not Found", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}" } ] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}" } } } } } } }, "/signatures/signature/create": { "post": { "tags": [ "Envelope", "Signature" ], "summary": "Signature Create", "description": "Creates and stores a user’s signature in the Storage system.
\n* The signature is represented as a Base64-encoded image (e.g., PNG or JPG).\n* Each signature is assigned a unique ID, which can be used in other operations to reference the signature.\n* Users can save multiple signatures and optionally designate one as the default for the signing process.", "operationId": "post-savedefaultsignature", "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "signature" ], "type": "object", "properties": { "signature": { "required": [ "isDefault", "value" ], "type": "object", "properties": { "isDefault": { "type": "boolean", "description": "Indicates whether this signature should be the default option during signing.", "default": true }, "value": { "type": "string", "description": "The digital signature image, encoded in Base64 format. This should represent a hand-drawn signature captured as an image.", "default": "base64" } } }, "externalContext": { "type": "object", "properties": { "id": { "type": "string", "description": "External reference ID used for contextual tracking.", "default": "12345" } } } } }, "example": { "signature": { "isDefault": true, "value": "iVBORw0KGgoAAAANSUhEUgAAAyAAAAEsCAYAAAA7Ldc6AAAQA" } } } } }, "responses": { "201": { "description": "This is the response returned when the envelope is successfully declined.", "content": { "application/json": { "schema": { "required": [ "result", "origin", "dateTime", "userId" ], "type": "object", "properties": { "result": { "required": [ "statusCode", "message", "data" ], "type": "object", "properties": { "statusCode": { "type": "integer", "description": "HTTP status code indicating the result of the operation." }, "message": { "type": "string", "description": "Descriptive message confirming the result of the request." }, "data": { "required": [ "signature" ], "type": "object", "properties": { "signature": { "required": [ "id", "message" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the created signature." }, "message": { "type": "string", "description": "Descriptive message generated by the system to inform the user about the details of the result." } } } } } } }, "externalContext": { "type": "object", "properties": { "id": { "type": "string", "description": "External reference ID used for contextual tracking.", "default": "12345" } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the request." }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the request was completed and the response returned." }, "userId": { "type": "string", "description": "The unique identifier of the user or system that initiated the request." } } }, "example": { "result": { "statusCode": 201, "message": "Created", "data": { "signature": { "id": "3e1346f6-a534-4e53fcb0a4d", "message": "Signature successfully saved" } } }, "origin": "POST https://dev.headless.mavenmule.com/signatures/signature/create", "dateTime": "2025-11-04T11:29:04.2445642+00:00", "userId": "1d8b89c4-0889-4d0af09ac3bc9b" } } } }, "400": { "description": "This response indicates that the request was invalid or improperly formed.
\nIt provides details about the error that occurred, including specific error codes, messages, and guidance for the user on how to resolve the issue.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Signature-create-Post400ApplicationJsonResponse" }, "example": { "error": { "statusCode": "400", "message": "Bad Request", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}", "urn": "{{sentUrn}}" } ] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}" } } } } } } }, "/signatures/envelope/create": { "post": { "tags": [ "Envelope" ], "summary": "Envelope Create", "description": "Creates an envelope containing one or more documents, designated recipients, and signature fields.
\n* Documents must first be uploaded via the Storage endpoint and linked to recipients using referenceDocumentId and referenceSignerId.\n* Recipients are assigned roles (e.g., signer) and can be configured as mandatory or optional.\n* Signature fields are positioned precisely within documents and can include optional styling.\n* Envelope metadata includes:\n * Email subject.\n * Email message.\n * Sender details.\n * Signing order.\n * Expiration settings.\n * Reminders.\n * Notification triggers for signature events.", "operationId": "post-savepreparedenvelope", "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "required": [ "documents", "recipients", "fields", "envelope" ], "type": "object", "properties": { "documents": { "type": "array", "items": { "required": [ "referenceDocumentId", "name", "loadMethod", "urn" ], "type": "object", "properties": { "referenceDocumentId": { "type": "integer", "description": "A unique identifier for the document within the envelope used to map document fields to signers.", "default": 1 }, "name": { "type": "string", "description": "A descriptive name for the document.", "default": "Test Document Name" }, "loadMethod": { "enum": [ "Storage" ], "type": "string", "description": "The source method for loading the document. Only 'Storage' is currently supported." }, "urn": { "type": "string", "description": "Unique URN (identifier) of the uploaded document. Must be obtained from the `/document/upload` endpoint.", "default": "{{uploadedDocument}}" }, "externalContext": { "type": "object", "properties": { "id": { "type": "string", "description": "External reference ID used for contextual tracking.", "default": "123" } } } } } }, "recipients": { "type": "array", "items": { "required": [ "referenceSignerId", "name", "email", "role", "mandatory" ], "type": "object", "properties": { "referenceSignerId": { "type": "integer", "description": "A unique identifier for the recipient within the envelope that links this recipient to signature fields.", "default": 1 }, "name": { "type": "string", "description": "Full name of the recipient.", "default": "Test Example" }, "email": { "type": "string", "description": "Email address of the recipient.", "default": "user@example.com" }, "role": { "enum": [ "signer", "viewer, cc" ], "type": "string", "description": "The role of the recipient in the signing process (e.g., signer, viewer, cc)", "default": "signer" }, "mandatory": { "type": "boolean", "description": "Indicates whether the recipient must complete their action for the envelope to be finalized.", "default": true }, "externalContext": { "type": "object", "properties": { "id": { "type": "string", "description": "External reference ID used for contextual tracking.", "default": "456" } } } } } }, "fields": { "type": "array", "items": { "required": [ "type", "isRequired", "referenceSignerId", "referenceDocumentId", "positionX", "positionY", "height", "width", "page", "name" ], "type": "object", "properties": { "type": { "enum": [ "signature", "digitalsignature", "text", "initial", "company", "title", "number", "note", "name", "email", "date", "checkbox", "radio", "stamp", "drawing" ], "type": "string", "description": "Type of the field to be added to the document (e.g.,signature, digitalsignature, text, initial, company, title, number, note, name, email, date, checkbox, radio, stamp, drawing)." }, "isRequired": { "type": "boolean", "description": "Whether the field must be completed by the recipient.", "default": true }, "referenceSignerId": { "type": "integer", "description": "Links the field to a specific recipient (matches recipients.referenceSignerId).", "default": 1 }, "referenceDocumentId": { "type": "integer", "description": "Links the field to a specific document (matches documents.referenceDocumentId).", "default": 1 }, "positionX": { "type": "integer", "description": "The X-coordinate (in pixels) of the field’s top-left corner on the page.", "default": 10 }, "positionY": { "type": "integer", "description": "The Y-coordinate (in pixels) of the field’s top-left corner on the page.", "default": 10 }, "height": { "type": "integer", "description": "The height of the field (in pixels).", "default": 100 }, "width": { "type": "integer", "description": "The width of the field (in pixels).", "default": 100 }, "page": { "type": "integer", "description": "The page number of the document where the field is placed.", "default": 1 }, "name": { "type": "string", "description": "A unique identifier or label for the field., used internally for identification.", "default": "mds_signature" }, "properties": { "type": "object", "properties": { "fontFamily": { "type": "string", "description": "Font family used for rendering the field.", "default": "Arial" }, "fontSize": { "type": "integer", "description": "Font size in points.", "default": 13 }, "color": { "type": "string", "description": "Color of the text, e.g., 'red', '#FF0000'.", "default": "red" }, "bold": { "type": "boolean", "description": "Whether the text in the field is bold.", "default": false }, "italic": { "type": "boolean", "description": "Whether the text in the field is italicized.", "default": false }, "underline": { "type": "boolean", "description": "Whether the text in the field is underlined.", "default": false }, "textAlign": { "type": "string", "description": "The alignment of the text within the field (e.g., left, right, center).", "default": "center" } }, "description": "Optional styling properties for the fields." } } } }, "envelope": { "required": [ "subject", "message", "senderName", "senderEmail" ], "type": "object", "properties": { "subject": { "type": "string", "description": "Subject of the email sent to recipients.", "default": "Email Subject" }, "message": { "type": "string", "description": "Custom message included in the body of the email.", "default": "Email Message" }, "senderName": { "type": "string", "description": "Name of the sender shown in notifications.", "default": "Sender Example" }, "senderEmail": { "type": "string", "description": "Email address of the sender used for reply-to.", "default": "sender@example.com" }, "isSignOrder": { "type": "boolean", "description": "If true, recipients will sign the documents in the envelope in the order listed.", "default": false }, "expireInDays": { "type": "integer", "description": "Number of days until the envelope expires.", "default": 5 }, "alertDaysBeforeExpiry": { "type": "integer", "description": "Number of days before expiration of the envelope when an alert should be sent to the recipients.", "default": 5 }, "firstReminderDays": { "type": "integer", "description": "Number of days after sending the envelope when the first reminder should be sent.", "default": 3 }, "repeatingReminderDays": { "type": "integer", "description": "Frequency of subsequent reminders after the first reminder.", "default": 2 }, "notifyWhenOpened": { "type": "boolean", "description": "Used to notify the sender when the envelope is opened.", "default": true }, "notifyWhenSigned": { "type": "boolean", "description": "Used to notify the sender when the envelope is signed.", "default": true } } }, "externalContext": { "type": "object", "properties": { "id": { "type": "string", "description": "External reference ID used for contextual tracking.", "default": "789" } } } } }, "example": { "documents": [ { "referenceDocumentId": 1, "name": "Test Document Name", "loadMethod": "Storage", "urn": "{{uploadedDocument}}", "externalContext": { "id": "123" } } ], "recipients": [ { "referenceSignerId": 1, "name": "Test Example", "email": "user@example.com", "role": "signer", "mandatory": true, "externalContext": { "id": "456" } } ], "fields": [ { "type": "text", "isRequired": true, "referenceSignerId": 1, "referenceDocumentId": 1, "positionX": 10, "positionY": 10, "height": 100, "width": 100, "page": 1, "name": "mds_signature1", "properties": { "fontFamily": "Arial", "fontSize": 13, "color": "red", "bold": true, "italic": true, "underline": true, "textAlign": "center" } } ], "envelope": { "subject": "Email Subject", "message": "Email Message", "senderName": "Sender Example", "senderEmail": "sender@example.com", "isSignOrder": false, "expireInDays": 5, "alertDaysBeforeExpiry": 5, "firstReminderDays": 3, "repeatingReminderDays": 2, "notifyWhenOpened": true, "notifyWhenSigned": true }, "externalContext": { "id": "789" } } } } }, "responses": { "201": { "description": "This response is returned after a successful request to create an envelope for digital document signing.
\nThe envelope acts as a digital signing container that groups together documents, recipients, and signature fields.", "content": { "application/json": { "schema": { "required": [ "result", "externalContext", "origin", "dateTime", "userId", "operationId" ], "type": "object", "properties": { "result": { "required": [ "statusCode", "message", "data" ], "type": "object", "properties": { "statusCode": { "type": "integer", "description": "HTTP status code indicating the result of the operation.", "example": 201 }, "message": { "type": "string", "description": "Message describing the result of the request.", "example": "Created" }, "data": { "required": [ "envelope", "documents", "recipients", "signGroups", "fields" ], "type": "object", "properties": { "envelope": { "required": [ "id", "uploadDate", "status" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the envelope.", "example": "{{envelopeId}}" }, "uploadDate": { "type": "string", "description": "Timestamp when the envelope was uploaded.", "format": "date-time", "example": "{{uploadedDate}}" }, "status": { "enum": [ "Completed", "In Progress", "Expired", "Draft", "Failed", "Declined", "Canceled", "Delivery Failed" ], "type": "string", "description": "Status of the envelope.", "example": "{{envelopeStatus}}" } } }, "documents": { "type": "array", "items": { "required": [ "id", "externalContext" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the document from the envelope.", "example": "{{documentId}}" }, "externalContext": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "External reference ID used for contextual tracking.", "example": "{{documentExternalContext}}" } } } } } }, "recipients": { "type": "array", "items": { "required": [ "id", "externalContext" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the recipient of the envelope.", "example": "{{recipientId}}" }, "externalContext": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "External reference ID used for contextual tracking.", "example": "{{recipientExternalContext}}" } } } } } }, "signGroups": { "type": "array", "items": { "type": "object" }, "description": "Optional list of signature groups where one user from the group has to do the needed action." }, "fields": { "type": "array", "items": { "required": [ "id", "recipientId", "signGroupId", "documentId" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the field.", "example": "{{fieldId}}" }, "recipientId": { "type": "string", "description": "The ID of the recipient associated with the field.", "example": "{{recipientId}}" }, "signGroupId": { "type": "string", "description": "The ID of the signing group associated with the field.", "example": "{{signGroupId}}" }, "documentId": { "type": "string", "description": "The ID of the document where the field is placed.", "example": "{{documentId}}" } } } } } } } }, "externalContext": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "External reference ID used for contextual tracking.", "example": "{{envelopeExternalContext}}" } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the request.", "example": "{{originEnvironment}}" }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the request was completed and the response returned.", "example": "{{responseTimestamp}}" }, "userId": { "type": "string", "description": "The unique identifier of the user or system that initiated the request.", "example": "{{userId}}" }, "operationId": { "type": "string", "description": "A system-generated ID that uniquely identifies this operation. Can be used for tracing, auditing, or support.", "example": "{{operationId}}" } } }, "example": { "result": { "statusCode": 201, "message": "Created", "data": { "envelope": { "id": "{{envelopeId}}", "uploadDate": "{{uploadedDate}}", "status": "{{envelopeStatus}}" }, "documents": [ { "id": "{{documentId}}", "externalContext": { "id": "{{documentExternalContext}}" } } ], "recipients": [ { "id": "{{recipientId}}", "externalContext": { "id": "{{recipientExternalContext}}" } } ], "signGroups": [ {} ], "fields": [ { "id": "{{fieldId}}", "recipientId": "{{recipientId}}", "signGroupId": "{{signGroupId}}", "documentId": "{{documentId}}" } ] } }, "externalContext": { "id": "{{envelopeExternalContext}}" }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}", "userId": "{{userId}}", "operationId": "{{operationId}}" } } } }, "400": { "description": "This is the response returned when the request was formed incorrectly.
\nFor example, both an anchor string and manual positioning is added to the body of the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope-create-Post400ApplicationJsonResponse" }, "example": { "error": { "statusCode": 400, "message": "Bad Request", "innerErrors": [ { "code": "ANCHOR_PROVIDED_POSITION_NOT_REQUIRED", "message": "Field can only be positioned based on an anchor string or manual positioning, not both.", "userMessage": "Field can only be positioned based on an anchor string or manual positioning, not both. If you have provided anchorString in your request please remove all of the positioning fields(positionX, positionY, height, width, page)." } ], "externalErrors": [] }, "externalContext": { "test1": "testvalueenvelope" }, "origin": "POST https://dev.headless.mavenmule.com/signatures/envelope/create", "dateTime": "2025-10-31T09:27:55.0000000+00:00", "userId": "1d8b89c4-0889-4d03-a90c-9af09ac3bc9b", "operationId": "e6a5c583f9746252cc2fd5ff15fd836c" } } } }, "500": { "description": "This is the response returned when the request has the invalid data.
\nFor example, the referenced file doesn' t exist in Storage.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope-create-Post500ApplicationJsonResponse" }, "example": { "error": { "statusCode": 500, "message": "Internal Server Error", "innerErrors": [ { "code": "FILE_NOT_EXISTS_IN_STORAGE", "message": "File with identifier bddd84db-3305-4df7-a2af-52c691d2bfdf not found in storage.", "userMessage": "File with identifier bddd84db-3305-4df7-a2af-52c691d2bfdf not found in storage." } ], "externalErrors": [] }, "origin": "POST https://dev.headless.mavenmule.com/signatures/envelope/create", "dateTime": "2025-10-31T09:33:29.0000000+00:00", "operationId": "4292a54fa4469c01c0ab4cff3b03a1a2" } } } } } } }, "/signatures/envelope/{envelopeId}/send": { "get": { "tags": [ "Envelope" ], "summary": "Envelope Send", "description": "Sends a created envelope to its designated recipients.
\n* The envelope is identified using the envelopeId path parameter.\n* Once sent, recipients receive email notifications to review and sign the documents contained within the envelope.", "operationId": "post-sendpreparedenvelope", "parameters": [ { "name": "envelopeId", "in": "path", "description": "The unique identifier of the envelope that you want to send. This ID is returned when an envelope is initially created via the /signatures/envelope/create endpoint. It is used to reference the specific envelope containing documents, recipients, and fields that are ready to be dispatched for digital signing.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "This is the response returned when the envelope is successfully sent.", "content": { "application/json": { "schema": { "required": [ "result", "origin", "dateTime", "userId" ], "type": "object", "properties": { "result": { "required": [ "statusCode", "message", "data" ], "type": "object", "properties": { "statusCode": { "type": "integer", "description": "HTTP status code indicating the result of the operation." }, "message": { "type": "string", "description": "Descriptive message confirming the result of the request." }, "data": { "required": [ "envelope" ], "type": "object", "properties": { "envelope": { "required": [ "id", "message" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the envelope that was sent." }, "message": { "type": "string", "description": "Descriptive message generated by the system to inform the user about the details of the result." } }, "description": "Envelope metadata including its ID and an optional message." } } } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the request." }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the request was completed and the response returned." }, "userId": { "type": "string", "description": "The unique identifier of the user or system that initiated the request." } } }, "example": { "result": { "statusCode": 200, "message": "OK", "data": { "envelope": { "id": "789cb83f-c225-46f00e4bfdd", "message": "Envelope successfully sent" } } }, "origin": "GET https://dev.headless.mavenmule.com/signatures/envelope/789cb83f-c225-46f00e4bfdd/send", "dateTime": "2025-11-04T10:39:33.9227311+00:00", "userId": "1d8b89c4-08a90c-9af09ac3bc9b" } } } }, "400": { "description": "This response indicates that the request was invalid or improperly formed.
\nIt provides details about the error that occurred, including specific error codes, messages, and guidance for the user on how to resolve the issue.", "content": { "application/json": { "schema": { "required": [ "error", "origin", "dateTime", "userId", "operationId" ], "type": "object", "properties": { "error": { "required": [ "statusCode", "message", "innerErrors", "externalErrors" ], "type": "object", "properties": { "statusCode": { "enum": [ "400" ], "type": "string", "description": "Indicating a bad request was made." }, "message": { "type": "string", "description": "A high-level description of the error." }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage", "eventId" ], "type": "object", "properties": { "code": { "type": "string", "description": "An error code indicating the type of issue encountered." }, "message": { "type": "string", "description": "A description of the specific error encountered." }, "userMessage": { "type": "string", "description": "A message intended for the end-user, advising on how to resolve the issue." }, "eventId": { "type": "string", "description": "A unique identifier for tracing the error in logs or debugging." } } } }, "externalErrors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code from the external service." }, "message": { "type": "string", "description": "A description of the external error." } }, "description": "Detailed list of errors originating from external services." } } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the request." }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the response was returned." }, "userId": { "type": "string", "description": "The unique identifier of the user or system that initiated the request." }, "operationId": { "type": "string", "description": "A system-generated ID that uniquely identifies this operation. Can be used for tracing, auditing, or support." } } }, "example": { "error": { "statusCode": "400", "message": "Bad Request", "innerErrors": [ { "code": "DRAFT_ID_INVALID", "message": "Envelope draft with ID 8952012a-b086-4aaf-be18b4 does not exist", "userMessage": "Envelope draft with ID 8952012a-b086-4aaf-be18b4 does not exist" } ], "externalErrors": [] }, "origin": "GET https://dev.headless.mavenmule.com/signatures/envelope/8952012a-b086-4aaf-be18b4/send", "dateTime": "2025-11-04T10:41:21.7201070+00:00", "userId": "1d8b89c4-0889-4d-9af09ac3bc9b", "operationId": "148726246e5949f517ac87582" } } } }, "404": { "description": "This response indicates that there’s no envelope found with the provided ID.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope-envelopeId-SendGet404ApplicationJsonResponse" }, "example": { "error": { "statusCode": "404", "message": "Not Found", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}" } ] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}" } } } } } } }, "/signatures/envelope/sign": { "post": { "tags": [ "Envelope" ], "summary": "Envelope Sign", "description": "Signs a sent and opened envelope.
\n* The envelope is identified using the transactionId (tid) query parameter, typically obtained from the email link sent to the recipient or via the GET /signatures/envelope/list endpoint.\n* Field IDs required in the request body can be retrieved from the endpoint that provides details about the open envelope.\n* This endpoint allows recipients to apply signatures and fill required fields (e.g., initials, text, checkboxes) to complete their signing obligations.", "operationId": "post-signenvelope", "parameters": [ { "name": "tid", "in": "query", "description": "This is a unique identifier associated with a specific recipient and envelope within a given transaction. It is used to securely validate that the user has the appropriate authorization to perform actions related to that transaction.", "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "required": [ "fields" ], "type": "object", "properties": { "externalContext": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "External reference ID used for contextual tracking.", "default": "12345" } } }, "fields": { "type": "array", "items": { "required": [ "id", "value" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the field whose value is being set.", "default": "" }, "value": { "type": "string", "description": "Value to assign to the field.", "default": "" } } }, "description": "List of field values to be populated or updated." } } }, "example": { "externalContext": { "id": "12345" }, "fields": [ { "id": "{{fieldId}}", "value": "{{fieldValue}}" } ] } } } }, "responses": { "200": { "description": "This is the response returned when the envelope is successfully declined.", "content": { "application/json": { "schema": { "required": [ "result", "origin", "dateTime" ], "type": "object", "properties": { "result": { "required": [ "statusCode", "message", "data" ], "type": "object", "properties": { "statusCode": { "type": "integer", "description": "HTTP status code indicating the result of the operation." }, "message": { "type": "string", "description": "Descriptive message confirming the result of the request." }, "data": { "required": [ "envelope" ], "type": "object", "properties": { "envelope": { "required": [ "id", "message" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the envelope." }, "message": { "type": "string", "description": "Descriptive message generated by the system to inform the user about the details of the result." } } } } } } }, "externalContext": { "type": "object", "properties": { "id": { "type": "string", "description": "External reference ID used for contextual tracking." } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the request." }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the request was completed and the response returned." } } }, "example": { "result": { "statusCode": 200, "message": "OK", "data": { "envelope": { "id": "73dd243a-9183-4568-9ac2278c", "message": "Envelope successfully signed" } } }, "origin": "POST https://dev.headless.mavenmule.com/signatures/envelope/sign", "dateTime": "2025-11-04T10:42:56.2869115+00:00" } } } }, "400": { "description": "This response indicates that the request was invalid or improperly formed.
\nIt provides details about the error that occurred, including specific error codes, messages, and guidance for the user on how to resolve the issue.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope-sign-Post400ApplicationJsonResponse" }, "example": { "error": { "statusCode": "400", "message": "Bad Request", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}", "urn": "{{sentUrn}}" } ] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}" } } } } } } }, "/signatures/envelope/open": { "get": { "tags": [ "Envelope" ], "summary": "Envelope Open", "description": "Opens a sent envelope as a recipient to view or sign documents.
\n* The envelope is identified using the transactionId (tid) query parameter, which can be obtained from the GET /signatures/envelope/list endpoint.", "operationId": "get-startenveloperecipientprocess", "parameters": [ { "name": "tid", "in": "query", "description": "This is a unique identifier associated with a specific recipient and envelope within a given transaction. It is used to securely validate that the user has the appropriate authorization to perform actions related to that transaction.", "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "This is the response returned when the envelope is successfully opened.
\nThe response body shows data of the opened envelope.", "content": { "application/json": { "schema": { "required": [ "result", "origin", "dateTime" ], "type": "object", "properties": { "result": { "required": [ "statusCode", "message", "data" ], "type": "object", "properties": { "statusCode": { "type": "integer", "description": "HTTP status code indicating the result of the operation." }, "message": { "type": "string", "description": "Descriptive message confirming the result of the request." }, "data": { "required": [ "envelope" ], "type": "object", "properties": { "envelope": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the envelope." }, "createdBy": { "type": "object", "properties": { "id": { "type": "string", "description": "User ID of the envelope creator." } } }, "subject": { "type": "string", "description": "Subject line of the envelope email." }, "senderName": { "type": "string", "description": "Name of the sender." }, "senderEmail": { "type": "string", "description": "Email of the sender." }, "status": { "type": "string", "description": "Envelope status (e.g., Draft, Sent,...)." }, "notifyWhenOpened": { "type": "boolean", "description": "Used to notify the sender when the envelope is opened." }, "isSignOrder": { "type": "boolean", "description": "True if recipients must sign in order." } }, "description": "Details about the envelope." }, "documents": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the uploaded document." }, "name": { "type": "string", "description": "Document name." } } }, "description": "List of documents included in the envelope." }, "recipients": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of recipient." }, "name": { "type": "string", "description": "Full name of the recipient." }, "email": { "type": "string", "description": "Email of the recipient." }, "role": { "type": "string", "description": "Role in the process (e.g., signer, viewer)." }, "status": { "type": "string", "description": "Signing status (e.g., In Progress, Signed)." }, "signDate": { "type": "string", "description": "Date and time of signing, or null if not yet signed." }, "signOrder": { "type": "integer", "description": "Order number if signing order is enforced." }, "signGroupId": { "type": "string", "description": "Group identifie if part of a signing group." }, "userId": { "type": "string", "description": "Associated user identifier." }, "mandatory": { "type": "boolean", "description": "True if signing is mandatory for this recipient." } } }, "description": "List of recipients assigned to this envelope." }, "signGroups": { "type": "array", "items": { "type": "object" }, "description": "List of signing groups" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique field identifier" }, "name": { "type": "string", "description": "Field name." }, "recipientId": { "type": "string", "description": "The ID of the recipient associated with the field." }, "documentId": { "type": "string", "description": "The ID of the signing group associated with the field." }, "type": { "type": "string", "description": "Type of field (e.g., text, signature, checkbox)." }, "value": { "type": "string", "description": "Current field value if any." }, "page": { "type": "integer", "description": "Page number of the document the field is on." }, "height": { "type": "integer", "description": "Height of the field in pixels." }, "width": { "type": "integer", "description": "Width of the field in pixels." }, "positionX": { "type": "integer", "description": "The X-coordinate (in pixels) of the field’s top-left corner on the page." }, "positionY": { "type": "integer", "description": "The Y-coordinate (in pixels) of the field’s top-left corner on the page." }, "isRequired": { "type": "boolean", "description": "Whether the field is required to complete the signing." }, "properties": { "type": "object", "description": "Properties for the field." }, "signerInfo": { "type": "object", "description": "Detailed signer metadata." } } }, "description": "All fillable fields attached to the documents." }, "signer": { "type": "string", "description": "Identifier of the current signer in flow, if sequential signing is used." } } } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the request." }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the request was completed and the response returned." } } }, "example": { "result": { "statusCode": 200, "message": "OK", "data": { "envelope": { "id": "e08f7851-dc1d-4822ff0857c4e4", "createdBy": { "id": "1d8b89c4-0889-c-9af09ac3bc9b" }, "subject": "Test", "senderName": null, "senderEmail": null, "status": "In Progress", "notifyWhenOpened": false, "isSignOrder": false }, "documents": [ { "id": "e3dcc1e8-627c-436f3e477d08f", "name": "Sales Agreement.pdf" } ], "recipients": [ { "id": "8e5e0faf-e3b6ddbe817fe1", "name": "Roman", "email": "roman.khryshchanovich@mavenmule.com", "role": "signer", "status": "In Progress", "signDate": null, "signOrder": 0, "signGroupId": "00000000-0000-000000000000", "userId": null, "mandatory": true } ], "signGroups": [], "fields": [ { "id": "37ba1cad-a347-47de11c8dc", "name": "a4b493088d0c4284ba389500c3ad853a", "recipientId": "8e5e0faf-e322-6ddbe817fe1", "documentId": "e3dcc1e8-627cf3e477d08f", "type": "signature", "value": "", "page": 1, "height": 35, "width": 100, "positionX": "69.65325", "positionY": "24.26785", "isRequired": true, "properties": null, "signerInfo": null } ], "signer": "8e5e0faf-eddbe817fe1", "attachments": [], "comments": {}, "settings": [ { "settingKey": "ENABLE_COMMENTS", "label": "Enable Comments", "type": "Boolean", "application": "MDS", "category": "Sending Settings", "subCategory": "Comments", "value": "true", "isAnonymousSetting": true, "preserve": true }, { "settingKey": "SEND_MFA_CODE_VIA_EMAIL", "label": "Receive MFA codes via email", "type": "Boolean", "application": "MDS", "category": "Signing Settings", "subCategory": "Authentication", "value": "false", "isAnonymousSetting": true, "preserve": true }, { "settingKey": "ALLOW_MOBILE_SIGNING", "label": "Mobile Signing", "type": "Boolean", "application": "MDS", "category": "Signing Settings", "subCategory": "Recipient Experience", "value": "true", "isAnonymousSetting": true, "preserve": true }, { "settingKey": "ALLOWED_SIGNATURE_INPUT_METHOD", "label": "Signature Input", "type": "Select", "application": "MDS", "category": "Signing Settings", "subCategory": "Recipient Experience", "value": "Typed,Imported", "isAnonymousSetting": true, "preserve": true }, { "settingKey": "DECLINE_REASON_REQUIRED", "label": "Decline Reason Required", "type": "Boolean", "application": "MDS", "category": "Signing Settings", "subCategory": "Recipient Experience", "value": "false", "isAnonymousSetting": true, "preserve": true }, { "settingKey": "REDIRECT_AFTER_SIGNING_URL", "label": "Redirect After Signing", "type": "String", "application": "MDS", "category": "Signing Settings", "subCategory": "Recipient Experience", "value": "", "isAnonymousSetting": true, "preserve": true }, { "settingKey": "SIGNING_ALLOW_REASSIGNMENT", "label": "Allow Responsibility Switch", "type": "Boolean", "application": "MDS", "category": "Signing Settings", "subCategory": "Recipient Experience", "value": "true", "isAnonymousSetting": true, "preserve": true }, { "settingKey": "SIGNING_AUTO_NAVIGATION", "label": "Auto Navigation", "type": "Boolean", "application": "MDS", "category": "Signing Settings", "subCategory": "Recipient Experience", "value": "true", "isAnonymousSetting": true, "preserve": true } ] } }, "origin": "GET https://dev.headless.mavenmule.com/signatures/envelope/open", "dateTime": "2025-11-04T07:57:31.4244946+00:00" } } } }, "400": { "description": "This response indicates that the request was invalid or improperly formed.
\nIt provides details about the error that occurred, including specific error codes, messages, and guidance for the user on how to resolve the issue.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope-open-Get400ApplicationJsonResponse" }, "example": { "error": { "statusCode": "400", "message": "Bad Request", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}", "urn": "{{sentUrn}}" } ] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}" } } } } } } }, "/signatures/document/upload": { "post": { "tags": [ "Document" ], "summary": "Document Upload", "description": "Uploads files to the Storage system in either form-data or binary format.
\n* Files can be separate PDF documents included in an envelope.\n* After upload, each file is assigned a unique URN, which can be referenced in processes like envelope creation.\n* Upload Type:\n * Form-data. Multiple files per request; order preserved.\n * Max File Size:\n * Production: 20 MB.\n * Staging: 10 MB.\n * Allowed Formats:\n * DOCX.\n * DOC.\n * PDF.\n * Binary. One file per request; filename generated as `document${guid}.{extension}`.\n * Max File Size:\n * Production: 20 MB.\n * Staging: 10 MB.\n * Allowed Formats:\n * DOCX.\n * DOC.\n * PDF.", "operationId": "document-upload", "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "responses": { "201": { "description": "This is the response returned when a document is successfully uploaded to Storage.
\nThe uploaded document is stored and assigned a unique id (URN), which can then be used later for signing operations (e.g., as part of an envelope).
\nThis response confirms that the upload operation completed successfully.", "content": { "application/json": { "schema": { "required": [ "result", "origin", "dateTime", "operationId" ], "type": "object", "properties": { "result": { "required": [ "data", "statusCode", "message" ], "type": "object", "properties": { "data": { "required": [ "files" ], "type": "object", "properties": { "files": { "minItems": 1, "type": "array", "items": { "required": [ "id", "fileName" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the uploaded file.", "example": "{{uploadedFileId}}" }, "fileName": { "type": "string", "description": "Name of the uploaded file including extension.", "example": "{{uploadedFileName}}" } } }, "description": "Array of uploaded file objects." } } }, "statusCode": { "type": "integer", "description": "HTTP status code indicating the result of the upload operation.", "example": 201 }, "message": { "type": "string", "description": "Response message describing the outcome of the upload request.", "example": "Created" } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the request.", "example": "{{originEnvironment}}" }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the request was completed and the response returned.", "example": "{{responseTimestamp}}" }, "operationId": { "type": "string", "description": "A system-generated ID that uniquely identifies this operation. Can be used for tracing, auditing, or support.", "example": "{{operationId}}" } } }, "example": { "result": { "data": { "files": [ { "id": "b6a5f346-6b60-4c-d55782651280", "fileName": "Sales Agreement DOCX.docx" } ] }, "statusCode": 201, "message": "Created" }, "origin": "POST https://dev.headless.mavenmule.com/signatures/document/upload", "dateTime": "2025-11-05T11:02:07.0061745+00:00", "operationId": "be40dc606fbf6adc1702572ecb" } } } }, "400": { "description": "This is the response returned when the request was formed incorrectly.
\nFor example, the “form-data” type was chosen but the file to upload was not selected", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document-upload-Post400ApplicationJsonResponse" }, "example": { "error": { "statusCode": 400, "message": "Bad Request", "innerErrors": [ { "code": "FORM_DATA_EXPECTED", "message": "Request must be multipart/form-data.", "userMessage": "Request must be multipart/form-data." } ], "externalErrors": [] }, "origin": "POST https://dev.headless.mavenmule.com/documents/document/upload", "dateTime": "2025-10-31T08:19:03.0000000+00:00", "operationId": "a9733c420a9e6336ea36ed98f31" } } } } } } }, "/signatures/document/{documentId}/download": { "get": { "tags": [ "Document" ], "summary": "Document Download", "description": "Downloads a document from the Storage system that’s included in an envelope.
\n* Use the documentId (a unique document URN) to reference the stored document.\n* The request returns the document file as a binary stream (application/octet-stream).\n* The document can be identified by a unique transactionId (tid).\n* Provide the tid as a query parameter.", "operationId": "download", "parameters": [ { "name": "documentId", "in": "path", "description": "The ID(URN) of the document you would like to download from Storage.", "required": true, "schema": { "type": "string" } }, { "name": "tid", "in": "query", "description": "This is a unique identifier associated with a specific recipient and envelope within a given transaction. It is used to securely validate that the user has the appropriate authorization to perform actions related to that transaction.", "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "Response body contains the binary content of the requested document (e.g., a PDF file), streamed directly to the client for download.", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" }, "examples": { "document": { "summary": "Binary document stream", "description": "The binary content of the requested document (e.g., PDF)", "value": null } } } } }, "400": { "description": "This response indicates that the request was invalid or improperly formed.
\nIt provides details about the error that occurred, including specific error codes, messages, and guidance for the user on how to resolve the issue.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document-documentId-download-Get400ApplicationJsonResponse" }, "example": { "error": { "statusCode": "400", "message": "Bad Request", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}", "urn": "{{sentUrn}}" } ] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}" } } } }, "404": { "description": "This response indicates that the file with the provided ID is not found in the Storage system.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document-documentId-download-Get404ApplicationJsonResponse" }, "example": { "error": { "statusCode": "404", "message": "Not Found", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}" } ] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}" } } } } } } }, "/signatures/signature/{signatureId}/update": { "put": { "tags": [ "Envelope", "Signature" ], "summary": "Signature Update", "description": "Updates an existing saved signature for a user.
\n* The signature is identified using the signatureId path parameter.\n* This endpoint allows updating the signature’s properties, including the Base64-encoded image value and optionally setting it as the default signature for preselection during document signing.", "operationId": "update-signature", "parameters": [ { "name": "signatureId", "in": "path", "description": "The ID of the signature that should be updated.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "signature" ], "type": "object", "properties": { "signature": { "required": [ "isDefault", "value" ], "type": "object", "properties": { "isDefault": { "type": "boolean", "description": "Indicates whether this signature should be the default option during signing.", "default": true }, "value": { "type": "string", "description": "The digital signature image, encoded in Base64 format. This should represent a hand-drawn signature captured as an image.", "default": "base64Updated" } } }, "externalContext": { "type": "object", "properties": { "id": { "type": "string", "description": "External reference ID used for contextual tracking.", "default": "12345" } } } } }, "example": { "signature": { "isDefault": false, "value": "base64" }, "externalContext": { "id": "12345" } } } } }, "responses": { "200": { "description": "This is the response returned when the signature is successfully updated.", "content": { "application/json": { "schema": { "required": [ "result", "origin", "dateTime", "userId" ], "type": "object", "properties": { "result": { "required": [ "statusCode", "message", "data" ], "type": "object", "properties": { "statusCode": { "type": "integer", "description": "HTTP status code indicating the result of the operation." }, "message": { "type": "string", "description": "Descriptive message confirming the result of the request." }, "data": { "required": [ "signature" ], "type": "object", "properties": { "signature": { "required": [ "id", "message" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the created signature." }, "message": { "type": "string", "description": "Descriptive message generated by the system to inform the user about the details of the result." } } } } } } }, "externalContext": { "type": "object", "properties": { "id": { "type": "string", "description": "External reference ID used for contextual tracking.", "default": "12345" } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the request." }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the request was completed and the response returned." }, "userId": { "type": "string", "description": "The unique identifier of the user or system that initiated the request." } } }, "example": { "result": { "statusCode": 200, "message": "OK", "data": { "signature": { "id": "3e1346f6-a534-4e53fcb0a4d", "message": "Signature successfully saved" } } }, "origin": "PUT https://dev.headless.mavenmule.com/signatures/signature/3e1346f6-a534-4e53fcb0a4d/update", "dateTime": "2025-11-04T11:54:42.5961530+00:00", "userId": "1d8b89c4-0889-4d03-a90c-9af09ac3bc9b" } } } }, "400": { "description": "This response indicates that the request was invalid or improperly formed.
\nIt provides details about the error that occurred, including specific error codes, messages, and guidance for the user on how to resolve the issue.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Signature-signatureId-update-Put400ApplicationJsonResponse" }, "example": { "error": { "statusCode": "400", "message": "Bad Request", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}" } ], "externalErrors": [] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}", "userId": "{{userId}}", "operationId": "{{operationId}}" } } } }, "404": { "description": "This response indicates that there’s no signature found with the provided ID.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Signature-signatureId-update-Put404ApplicationJsonResponse" }, "example": { "error": { "statusCode": "404", "message": "Not Found", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}" } ] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}" } } } } } } }, "/signatures/envelope/{envelopeId}/update": { "put": { "tags": [ "Envelope", "Content" ], "summary": "Envelope Update ", "description": "Updates an envelope that is created but not yet sent for signing.
\n* The envelope must be in the \"Draft\" status.\n* The envelope is identified using the envelopeId path parameter.\n* This endpoint allows modification of:\n * Envelope documents.\n * Recipients.\n * Fields.\n * Envelope settings.\n * Associated metadata.\n* Use this endpoint to revise envelope details before initiating the signing process.", "operationId": "update-envelope", "parameters": [ { "name": "envelopeId", "in": "path", "description": "The unique identifier of the envelope to be updated. This ID is generated when the envelope is first created and is used to reference and modify the envelope before it is sent to recipients. It must match an existing envelope that is still in a draft (unsent) status.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "required": [ "documents", "recipients", "fields", "envelope", "externalContext" ], "type": "object", "properties": { "documents": { "type": "array", "items": { "required": [ "referenceDocumentId", "name", "loadMethod", "urn" ], "type": "object", "properties": { "referenceDocumentId": { "type": "integer", "description": "A unique identifier for the document within the envelope used to map document fields to recipients.", "default": 1 }, "name": { "type": "string", "description": "A descriptive name for the document.", "default": "Test Document Name" }, "loadMethod": { "enum": [ "Storage" ], "type": "string", "description": "The source method for loading the document. Only 'Storage' is currently supported." }, "urn": { "type": "string", "description": "Unique URN (identifier) of the uploaded document. Must be obtained from the `/document/upload` endpoint.", "default": "{{uploadedDocument}}" } } } }, "recipients": { "type": "array", "items": { "required": [ "referenceSignerId", "name", "email", "role", "mandatory" ], "type": "object", "properties": { "referenceSignerId": { "type": "integer", "description": "A unique identifier for the recipient within the envelope that links this recipient to signature fields.", "default": 1 }, "name": { "type": "string", "description": "Full name of the recipient.", "default": "Test Example" }, "email": { "type": "string", "description": "Email address of the recipient.", "default": "user@example.com" }, "role": { "enum": [ "signer", "viewer", "cc" ], "type": "string", "description": "The role of the recipient in the signing process (e.g., signer, viewer, cc).", "default": "viewer" }, "mandatory": { "type": "boolean", "description": "Indicates whether the recipient must complete their action for the envelope to be finalized.", "default": false } } } }, "fields": { "type": "array", "items": { "required": [ "type", "isRequired", "referenceSignerId", "referenceDocumentId", "positionX", "positionY", "height", "width", "page", "name" ], "type": "object", "properties": { "type": { "enum": [ "signature", "digitalsignature", "text", "initial", "company", "title", "number", "note", "name", "email", "date", "checkbox", "radio", "stamp", "drawing" ], "type": "string", "description": "Type of the field to be added to the document (e.g.,signature, digitalsignature, text, initial, company, title, number, note, name, email, date, checkbox, radio, stamp, drawing).", "default": "digitalsignature" }, "isRequired": { "type": "boolean", "description": "Whether the field must be completed by the recipient.", "default": true }, "referenceSignerId": { "type": "integer", "description": "Links the field to a specific recipient (matches recipients.referenceSignerId).", "default": 1 }, "referenceDocumentId": { "type": "integer", "description": "Links the field to a specific document (matches documents.referenceDocumentId).", "default": 1 }, "positionX": { "type": "number", "description": "The X-coordinate (in pixels) of the field’s top-left corner on the page.", "default": 10 }, "positionY": { "type": "number", "description": "The Y-coordinate (in pixels) of the field’s top-left corner on the page.", "default": 10 }, "height": { "type": "number", "description": "The height of the field (in pixels).", "default": 100 }, "width": { "type": "number", "description": "The width of the field (in pixels).", "default": 100 }, "page": { "type": "integer", "description": "The page number of the document where the field is placed.", "default": 1 }, "name": { "type": "string", "description": "A unique identifier or label for the field, used for identification.", "default": "mds_signature" }, "properties": { "type": "object", "properties": { "fontFamily": { "type": "string", "description": "Font family used for rendering the field.", "default": "Arial" }, "fontSize": { "type": "integer", "description": "Font size in points.", "default": 13 }, "color": { "type": "string", "description": "Color of the text, e.g., 'red', '#FF0000'.", "default": "red" }, "bold": { "type": "boolean", "description": "Whether the text in the field is bold.", "default": false }, "italic": { "type": "boolean", "description": "Whether the text in the field is italicized.", "default": false }, "underline": { "type": "boolean", "description": "Whether the text in the field is underlined.", "default": true }, "textAlign": { "type": "string", "description": "The alignment of the text within the field (e.g., left, right, center).", "default": "center" } }, "description": "Optional styling or field behavior properties." } } }, "description": "List of fields to be placed on the documents (e.g., signatures)." }, "envelope": { "required": [ "subject", "message", "senderName", "senderEmail", "isSignOrder", "expireInDays", "alertDaysBeforeExpiry", "firstReminderDays", "repeatingReminderDays", "notifyWhenOpened", "notifyWhenSigned" ], "type": "object", "properties": { "subject": { "type": "string", "description": "Subject of the email sent to recipients.", "default": "Email Subject" }, "message": { "type": "string", "description": "Custom message included in the body of the email.", "default": "Email Message" }, "senderName": { "type": "string", "description": "Name of the sender shown in notifications.", "default": "Sender Example" }, "senderEmail": { "type": "string", "description": "Email address of the sender used for reply-to.", "default": "sender@example.com" }, "isSignOrder": { "type": "boolean", "description": "If true, recipients will sign the documents in the envelope in the order listed.", "default": false }, "expireInDays": { "type": "integer", "description": "Number of days until the envelope expires.", "default": 5 }, "alertDaysBeforeExpiry": { "type": "integer", "description": "Number of days before expiration of the envelope when an alert should be sent to the recipients.", "default": 5 }, "firstReminderDays": { "type": "integer", "description": "Number of days after sending the envelope when the first reminder should be sent.", "default": 3 }, "repeatingReminderDays": { "type": "integer", "description": "Frequency of subsequent reminders after the first reminder.", "default": 2 }, "notifyWhenOpened": { "type": "boolean", "description": "Used to notify the sender when the envelope is opened.", "default": true }, "notifyWhenSigned": { "type": "boolean", "description": "Used to notify the sender when the envelope is signed.", "default": true } } }, "externalContext": { "type": "object", "properties": { "id": { "type": "string", "description": "External reference ID used for contextual tracking.", "default": "12345" } } } } }, "example": { "documents": [ { "referenceDocumentId": 1, "name": "Test Document Name", "loadMethod": "Storage", "urn": "{{uploadedDocument}}" } ], "recipients": [ { "referenceSignerId": 1, "name": "Test Example", "email": "user@example.com", "role": "signer", "mandatory": true } ], "fields": [ { "type": "signature", "isRequired": true, "referenceSignerId": 1, "referenceDocumentId": 1, "positionX": 10, "positionY": 10, "height": 100, "width": 100, "page": 1, "name": "mds_signature1", "properties": { "fontFamily": "Arial", "fontSize": 13, "color": "red", "bold": true, "italic": true, "underline": true, "textAlign": "center" } } ], "envelope": { "subject": "Email Subject", "message": "Email Message", "senderName": "Sender", "senderEmail": "sender@example.com", "isSignOrder": false, "expireInDays": 5, "alertDaysBeforeExpiry": 5, "firstReminderDays": 3, "repeatingReminderDays": 2, "notifyWhenOpened": true, "notifyWhenSigned": true }, "externalContext": { "id": "12345" } } } } }, "responses": { "200": { "description": "This response indicates that the envelope identified by the provided envelopeId was successfully updated.
\nAll submitted changes to documents, recipients, signature fields, and envelope metadata have been processed and saved.", "content": { "application/json": { "schema": { "required": [ "result", "externalContext", "origin", "dateTime", "userId", "operationId" ], "type": "object", "properties": { "result": { "required": [ "statusCode", "message", "data" ], "type": "object", "properties": { "statusCode": { "type": "integer", "description": "HTTP status code indicating the result of the operation.", "example": 201 }, "message": { "type": "string", "description": "Message describing the result of the request.", "example": "Created" }, "data": { "required": [ "envelope", "documents", "recipients", "signGroups", "fields" ], "type": "object", "properties": { "envelope": { "required": [ "id", "status" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the envelope.", "example": "{{envelopeId}}" }, "status": { "enum": [ "Completed", "In Progress", "Expired", "Draft", "Failed", "Declined", "Canceled", "Delivery Failed" ], "type": "string", "description": "Status of the envelope.", "example": "{{envelopeStatus}}" } } }, "documents": { "type": "array", "items": { "required": [ "id", "externalContext" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the document from the envelope.", "example": "{{documentId}}" }, "externalContext": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "External reference ID used for contextual tracking.", "example": "{{documentExternalContext}}" } } } } } }, "recipients": { "type": "array", "items": { "required": [ "id", "externalContext" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the recipient of the envelope.", "example": "{{recipientId}}" }, "externalContext": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "External reference ID used for contextual tracking.", "example": "{{recipientExternalContext}}" } } } } } }, "signGroups": { "type": "array", "items": { "type": "object" }, "description": "Optional list of signature groups where one user from the group has to do the needed action." }, "fields": { "type": "array", "items": { "required": [ "id", "recipientId", "signGroupId", "documentId" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the field.", "example": "{{fieldId}}" }, "recipientId": { "type": "string", "description": "The ID of the recipient associated with the field.", "example": "{{recipientId}}" }, "signGroupId": { "type": "string", "description": "The ID of the signing group associated with the field.", "example": "{{signGroupId}}" }, "documentId": { "type": "string", "description": "The ID of the document where the field is placed.", "example": "{{documentId}}" } } } } } } } }, "externalContext": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "External reference ID used for contextual tracking.", "example": "{{envelopeExternalContext}}" } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the request.", "example": "{{originEnvironment}}" }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the request was completed and the response returned.", "example": "{{responseTimestamp}}" }, "userId": { "type": "string", "description": "The unique identifier of the user or system that initiated the request.", "example": "{{userId}}" }, "operationId": { "type": "string", "description": "A system-generated ID that uniquely identifies this operation. Can be used for tracing, auditing, or support.", "example": "{{operationId}}" } } }, "example": { "result": { "statusCode": 200, "message": "OK", "data": { "envelope": { "id": "789cb83f-c225-46f0-bfdd", "status": "Draft" }, "documents": [ { "id": "e508516b-9273d-a65b7f8e69d8", "externalContext": null }, { "id": "16ef36a6-7738-49279b77fd394", "externalContext": null } ], "recipients": [ { "id": "5c33f8ae-b3ba-3a4f392f680", "externalContext": null } ], "signGroups": [], "fields": [ { "id": "ffc6a7e1-26d5-3-bccbc8f7deea", "recipientId": "5c33f8ae-b3ba-23a4f392f680", "signGroupId": "00000000-0000-0000000", "documentId": "e508516b-9275d-a65b7f8e69d8" }, { "id": "dc01bf88-b2fb-45a713acfe382d", "recipientId": "5c33f8ae-b3ba-456f392f680", "signGroupId": "00000000-00000000000", "documentId": "e508516b-925b7f8e69d8" } ] } }, "origin": "PUT https://dev.headless.mavenmule.com/signatures/envelope/789cb83f-c225-46f0-bfdd/update", "dateTime": "2025-11-04T10:49:44.6418508+00:00", "userId": "1d8b89c4-0889-4c-909ac3bc9b" } } } }, "400": { "description": "This response indicates that the request was invalid or improperly formed.
\nIt provides details about the error that occurred, including specific error codes, messages, and guidance for the user on how to resolve the issue.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope-envelopeId-update-Put400ApplicationJsonResponse" }, "example": { "error": { "statusCode": 400, "message": "Bad Request", "innerErrors": [ { "code": "DRAFT_ID_INVALID", "message": "Envelope draft with ID 8952012a-b086-4aaf-be18b4 does not exist", "userMessage": "Envelope draft with ID 8952012a-b086-4aaf-be18b4 does not exist" } ], "externalErrors": [] }, "origin": "GET https://dev.headless.mavenmule.com/signatures/envelope/8952012a-b086-4aaf-be18b4/send", "dateTime": "2025-11-04T10:41:21.0000000+00:00", "userId": "1d8b89c4-0889-4d-9af09ac3bc9b", "operationId": "148726246e5949f517ac87582" } } } }, "404": { "description": "This response indicates that there’s no envelope found with the provided ID.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope-envelopeId-update-Put404ApplicationJsonResponse" }, "example": { "error": { "statusCode": "404", "message": "Not Found", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}" } ] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}" } } } } } } }, "/signatures/envelope/{envelopeId}/audit/download": { "get": { "tags": [ "Envelope", "AuditTrail" ], "summary": "Envelope Audit Log Download", "description": "Retrieves the audit trail for a specific envelope as a downloadable file.
\n* The file provides a formal record of the envelope’s lifecycle for compliance, auditing, or record-keeping purposes.\n* The envelope is identified using the envelopeId path parameter.\n* The request returns the audit trail as a binary stream (application/octet-stream).", "operationId": "download-envelope-audit", "parameters": [ { "name": "envelopeId", "in": "path", "description": "The ID of the envelope where the attachment will be added.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "Response body contains the binary content of the Audit Trail for the specified envelope, typically formatted as a PDF or similar document, streamed directly to the client for download.
\nThe file contains a detailed log of all actions related to the envelope along with precise timestamps, user or recipient information, IP addresses, and any relevant additional details." }, "400": { "description": "This response indicates that the request was invalid or improperly formed.
\nIt provides details about the error that occurred, including specific error codes, messages, and guidance for the user on how to resolve the issue.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope-envelopeId-audit-download-Get400ApplicationJsonResponse" }, "example": { "error": { "statusCode": "400", "message": "Bad Request", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}", "urn": "{{sentUrn}}" } ] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}" } } } }, "404": { "description": "This response indicates that there’s no Audit Trail found in the envelope with the provided ID.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope-envelopeId-audit-download-Get404ApplicationJsonResponse" }, "example": { "error": { "statusCode": "404", "message": "Not Found", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}" } ] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}" } } } } } } }, "/signatures/signature/{signatureId}/get": { "get": { "tags": [ "Data", "Envelope", "Signature" ], "summary": "Signature Get", "description": "Retrieves details about a specific signature stored in the system.
\n* The signature is identified using the signatureId path parameter.\n* The endpoint returns the signature and its associated metadata in JSON format.", "operationId": "get-signature", "parameters": [ { "name": "signatureId", "in": "path", "description": "The ID of the signature which information should be retrieved.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "This is the response returned when the signature is successfully retrieved.
\nThe response includes all the needed signature data.", "content": { "application/json": { "schema": { "required": [ "result", "origin", "dateTime", "userId" ], "type": "object", "properties": { "result": { "required": [ "statusCode", "message", "data" ], "type": "object", "properties": { "statusCode": { "type": "integer", "description": "HTTP status code indicating the result of the operation." }, "message": { "type": "string", "description": "Descriptive message confirming the result of the request." }, "data": { "required": [ "signature" ], "type": "object", "properties": { "signature": { "required": [ "id", "data", "isDefault" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the digital signature." }, "data": { "type": "string", "description": "Base64-encoded image of the digital signature." }, "isDefault": { "type": "boolean", "description": "Indicates whether this signature is marked as the default for the user." } } } } } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the request." }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the request was completed and the response returned." }, "userId": { "type": "string", "description": "The unique identifier of the user or system that initiated the request." } } }, "example": { "result": { "statusCode": 200, "message": "OK", "data": { "signature": { "id": "3e1346f6-a534-4e53fcb0a4d", "data": "iVBORw0KGgoAAAANSUhEUgAAAyAAAAEsCAYAAAA7Ldc6AAAQAElEQVR4AeydBbwsR5X/hAGSURBVAMAc/JP7z78b4EAAAAASUVORK5CYII=", "isDefault": true } } }, "origin": "GET https://dev.headless.mavenmule.com/signatures/signature/3e1346f6-a534-4e53fcb0a4d/get", "dateTime": "2025-11-04T11:43:08.3136217+00:00", "userId": "1d8b89c4-0889c-9af09ac3bc9b" } } } }, "400": { "description": "This response indicates that the request was invalid or improperly formed.
\nIt provides details about the error that occurred, including specific error codes, messages, and guidance for the user on how to resolve the issue.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Signature-signatureId-get-Get400ApplicationJsonResponse" }, "example": { "error": { "statusCode": "400", "message": "Bad Request", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}" } ], "externalErrors": [] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}", "userId": "{{userId}}", "operationId": "{{operationId}}" } } } }, "404": { "description": "This response indicates that there’s no signature found with the provided ID.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Signature-signatureId-get-Get404ApplicationJsonResponse" }, "example": { "error": { "statusCode": "404", "message": "Not Found", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}" } ] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}" } } } } } } }, "/signatures/envelope/{envelopeId}/document/{documentId}/download": { "get": { "tags": [ "Document", "Envelope" ], "summary": "Envelope Document Download ", "description": "Downloads a specific document within an envelope.
\n* The envelope is identified using the envelopeId path parameter.\n* The document is identified using the documentId path parameter.\n* The envelope is authenticated via the transactionId (tid) query parameter.\n* The document is returned as a binary stream (application/octet-stream), typically in its original format (e.g., PDF, DOCX) or as a processed version (e.g., signed PDF).", "operationId": "download-document", "parameters": [ { "name": "envelopeId", "in": "path", "description": "The ID of the envelope where the attachment is added.", "required": true, "schema": { "type": "string" } }, { "name": "documentId", "in": "path", "description": "The needed string value.\nThe ID(URN) of the document you would like to download from the defined envelope.\n\n", "required": true, "schema": { "type": "string" } }, { "name": "tid", "in": "query", "description": "This is a unique identifier associated with a specific recipient and envelope within a given transaction. It is used to securely validate that the user has the appropriate authorization to perform actions related to that transaction.", "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "The response body contains the binary content of the document in PDF format.
\nThe content is streamed directly to the client, allowing the file to be downloaded in the same form." }, "400": { "description": "This is the response returned when the request was formed incorrectly.
\nIt includes detailed error information such as error codes, descriptive messages, and guidance on how to correct the issue.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope-envelopeId-document-documentId-download-Get400ApplicationJsonResponse" }, "example": { "error": { "statusCode": "400", "message": "Bad Request", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}", "urn": "{{sentUrn}}" } ] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}" } } } }, "404": { "description": "This response indicates that there’s no envelope found with the provided ID or there’re no documents found in the defined envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope-envelopeId-document-documentId-download-Get404ApplicationJsonResponse" }, "example": { "error": { "statusCode": "404", "message": "Not Found", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}" } ] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}" } } } } } } }, "/signatures/signature/list": { "get": { "tags": [ "Envelope", "Signature" ], "summary": "Signature List", "description": "Retrieves a list of all signatures associated with the authenticated user.
\n* Each signature includes the following metadata:\n * Unique ID\n * Whether the signature is marked as default\n * Base64-encoded image data", "operationId": "get-signatures-list", "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "This is the response returned when the list of available signatures is successfully retrieved.", "content": { "application/json": { "schema": { "required": [ "result", "origin", "dateTime", "userId" ], "type": "object", "properties": { "result": { "required": [ "statusCode", "message", "data" ], "type": "object", "properties": { "statusCode": { "type": "integer", "description": "HTTP status code indicating the result of the operation." }, "message": { "type": "string", "description": "Descriptive message confirming the result of the request." }, "data": { "required": [ "signature" ], "type": "object", "properties": { "signature": { "type": "array", "items": { "required": [ "id", "isDefault" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the digital signature.", "format": "uuid" }, "isDefault": { "type": "boolean", "description": "Indicates whether this signature is marked as the default for the user." } } }, "description": "List of user’s saved digital signatures." } } } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the request." }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the request was completed and the response returned." }, "userId": { "type": "string", "description": "The unique identifier of the user or system that initiated the request." } } }, "example": { "result": { "statusCode": 200, "message": "OK", "data": { "signature": [ { "id": "3e1346f6-a534-4e53fcb0a4d", "isDefault": true } ] } }, "origin": "GET https://dev.headless.mavenmule.com/signatures/signature/list", "dateTime": "2025-11-04T11:43:08.1266236+00:00", "userId": "1d8b89c4-0889-4-9af]3bc9b" } } } }, "400": { "description": "This response indicates that the request was invalid or improperly formed.
\nIt provides details about the error that occurred, including specific error codes, messages, and guidance for the user on how to resolve the issue.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Signature-list-Get400ApplicationJsonResponse" }, "example": { "error": { "statusCode": "400", "message": "Bad Request", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}" } ], "externalErrors": [] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}", "userId": "{{userId}}", "operationId": "{{operationId}}" } } } }, "404": { "description": "This response indicates that there’s no signature found with the provided ID.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Signature-list-Get404ApplicationJsonResponse" }, "example": { "error": { "statusCode": "404", "message": "Not Found", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}" } ] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}" } } } } } } }, "/signatures/signature/{signatureId}/delete": { "delete": { "tags": [ "Envelope", "Signature" ], "summary": "Signature Delete", "description": "Removes a specific signature from the Storage system.
\n* The signature is identified using the signatureId path parameter.\n* This endpoint allows users to delete a previously stored signature associated with their account.", "operationId": "delete-signature", "parameters": [ { "name": "signatureId", "in": "path", "description": "The ID of the signature that should be deleted.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "This response indicates that the signature identified by the provided signatureId was successfully deleted.", "content": { "application/json": { "schema": { "required": [ "result", "origin", "dateTime", "userId" ], "type": "object", "properties": { "result": { "required": [ "statusCode", "message", "data" ], "type": "object", "properties": { "statusCode": { "type": "integer", "description": "HTTP status code indicating the result of the operation." }, "message": { "type": "string", "description": "Descriptive message confirming the result of the request." }, "data": { "required": [ "signature" ], "type": "object", "properties": { "signature": { "required": [ "id", "message" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the created signature." }, "message": { "type": "string", "description": "Descriptive message generated by the system to inform the user about the details of the result." } } } } } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the request." }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the request was completed and the response returned." }, "userId": { "type": "string", "description": "The unique identifier of the user or system that initiated the request." } } }, "example": { "result": { "statusCode": 200, "message": "OK", "data": { "signature": { "id": "3e1346f6-a534-4e53fcb0a4d", "message": "SIGNATURE_DELETED" } } }, "origin": "DELETE https://dev.headless.mavenmule.com/signatures/signature/3e1346f6-a534-4e53fcb0a4d/delete", "dateTime": "2025-11-04T11:33:05.3790992+00:00", "userId": "1d8b89c4-0889-4d0f09ac3bc9b" } } } }, "400": { "description": "This response indicates that the request was invalid or improperly formed.
\nIt provides details about the error that occurred, including specific error codes, messages, and guidance for the user on how to resolve the issue.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Signature-signatureId-delete-Del400ApplicationJsonResponse" }, "example": { "error": { "statusCode": "400", "message": "Bad Request", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}" } ], "externalErrors": [] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}", "userId": "{{userId}}", "operationId": "{{operationId}}" } } } }, "404": { "description": "This response indicates that there’s no signature found with the provided ID.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Signature-signatureId-delete-Del404ApplicationJsonResponse" }, "example": { "error": { "statusCode": "404", "message": "Not Found", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}" } ] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}" } } } } } } }, "/signatures/envelope/{envelopeId}/cancel": { "get": { "tags": [ "Envelope" ], "summary": "Envelope Cancel ", "description": "Terminates the signing process by canceling a sent envelope.
\n* The envelope is identified using the envelopeId path parameter.\n* Once canceled, the envelope transitions to a final state of \"Canceled\", preventing any further actions by recipients (e.g., viewing or signing documents).\n* Use this endpoint when a sender needs to stop the process, for example, due to errors in the envelope, changes in requirements, or other reasons.", "operationId": "cancel-envelope", "parameters": [ { "name": "envelopeId", "in": "path", "description": "The ID of the envelope which Audit trail is needed.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "This response indicates that the sent envelope is cancelled successfully.
\nIt includes detailed information about the action.", "content": { "application/json": { "schema": { "required": [ "result", "origin", "dateTime" ], "type": "object", "properties": { "result": { "required": [ "statusCode", "message", "data" ], "type": "object", "properties": { "statusCode": { "type": "integer", "description": "HTTP status code indicating the result of the operation." }, "message": { "type": "string", "description": "Descriptive message confirming the result of the request." }, "data": { "required": [ "envelope" ], "type": "object", "properties": { "envelope": { "required": [ "id", "message" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the canceled envelope." }, "message": { "type": "string", "description": "Descriptive message generated by the system to inform the user about the details of the result." } } } } } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the request." }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the request was completed and the response returned." } } }, "example": { "result": { "statusCode": 200, "message": "OK", "data": { "envelope": { "id": "8912a-b086-4aaf-b1de", "message": "Envelope successfully cancelled" } } }, "origin": "GET https://dev.headless.mavenmule.com/signatures/envelope/8912a-b086-4aaf-b1de/cancel", "dateTime": "2025-11-03T11:30:04.1831907+00:00" } } } }, "400": { "description": "This is the response returned when the request was formed incorrectly.
\nIt includes detailed error information such as error codes, descriptive messages, and guidance on how to correct the issue.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope-envelopeId-cancel-Get400ApplicationJsonResponse" }, "example": { "error": { "statusCode": "400", "message": "Bad Request", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}", "urn": "{{sentUrn}}" } ] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}" } } } }, "404": { "description": "This response indicates that there’s no envelope found with the provided ID.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope-envelopeId-cancel-Get404ApplicationJsonResponse" }, "example": { "error": { "statusCode": "404", "message": "Not Found", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}" } ] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}" } } } } } } }, "/signatures/envelope/{envelopeId}/attachment/upload": { "post": { "tags": [ "Envelope", "Attachment" ], "summary": "Envelope Attachment Upload ", "description": "Uploads attachments to a specific envelope.
\n* Attach additional documents such as supporting files, contracts, or other materials to provide context for digital signing.\n* After upload, each file is assigned a unique URN, which can be referenced in processes like envelope creation.\n* Upload Type:\n * Form-data. Multiple files per request; order preserved.\n * Max File Size:\n * Production:20 MB.\n * Staging: 10 MB.\n * Allowed Formats:\n * Text.\n * Image.", "operationId": "upload-attachment", "parameters": [ { "name": "envelopeId", "in": "path", "description": "The ID of the envelope where the attachment will be added.", "required": true, "schema": { "type": "string" } }, { "name": "tid", "in": "query", "description": "This is a unique identifier associated with a specific recipient and envelope within a given transaction. It is used to securely validate that the user has the appropriate authorization to perform actions related to that transaction.", "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "responses": { "201": { "description": "This is the response returned when an attachment is successfully added to the envelope.
\nThe added attachment gets the ID assigned that can be referenced in other endpoints.", "content": { "application/json": { "schema": { "required": [ "result", "origin", "dateTime", "operationId" ], "type": "object", "properties": { "result": { "required": [ "statusCode", "message", "data" ], "type": "object", "properties": { "statusCode": { "type": "integer", "description": "HTTP status code indicating the result of the operation." }, "message": { "type": "string", "description": "Descriptive message indicating the result of the request." }, "data": { "required": [ "files" ], "type": "object", "properties": { "files": { "type": "array", "items": { "required": [ "id", "fileName" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the uploaded attachment file." }, "fileName": { "type": "string", "description": "Name of the uploaded attachment file." } } }, "description": "List of uploaded file objects." } } } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the request." }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the request was completed and the response returned." }, "operationId": { "type": "string", "description": "A system-generated ID that uniquely identifies this operation. Can be used for tracing, auditing, or support." } } }, "example": { "result": { "data": { "files": [ { "id": "76bb26-21b1-4d47132c4", "fileName": "SampleAttachment.jpg" } ] }, "statusCode": 201, "message": "Created" }, "origin": "POST https://dev.headless.mavenmule.com/signatures/envelope/7a5d60-a222-4c3e490ef1/attachment/upload", "dateTime": "2025-11-03T06:48:58.5308568+00:00", "operationId": "ea5716c820f26295b44c2fb2" } } } }, "400": { "description": "This is the response returned when the request was formed incorrectly.
\nFor example, the “form-data” type was chosen but the file to upload was not selected", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope-envelopeId-attachment-upload-Post400ApplicationJsonResponse" }, "example": { "error": { "statusCode": "400", "message": "Bad Request", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}", "urn": "{{sentUrn}}" } ] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}" } } } } } } }, "/signatures/envelope/{envelopeId}/attachment/{attachmentId}/download": { "get": { "tags": [ "Envelope", "Attachment" ], "summary": "Envelope Attachment Download", "description": "Downloads an attachment associated with an envelope.
\n* The attachment is returned in its original format as uploaded.", "operationId": "envelope-attachment-download", "parameters": [ { "name": "envelopeId", "in": "path", "description": "The ID of the envelope which Audit trail is needed.", "required": true, "schema": { "enum": [ "{{envelopeId}}" ], "type": "string", "default": "{{envelopeId}}" } }, { "name": "attachmentId", "in": "path", "description": "The needed string value. The ID of the needed attachment from the defined envelope.", "required": true, "schema": { "enum": [ "{{attachmentId}}" ], "type": "string", "default": "{{attachmentId}}" } }, { "name": "tid", "in": "query", "description": "This is a unique identifier associated with a specific recipient and envelope within a given transaction. It is used to securely validate that the user has the appropriate authorization to perform actions related to that transaction.", "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "The response body contains the binary content of the attachment in its original format, as it was uploaded.
\nThe content is streamed directly to the client, allowing the file to be downloaded in the same form (e.g., Excel, PDF, Word, etc.)." }, "400": { "description": "This response indicates that the request was invalid or improperly formed.
\nIt provides details about the error that occurred, including specific error codes, messages, and guidance for the user on how to resolve the issue.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope-envelopeId-attachment-attachmentId-download-Get400ApplicationJsonResponse" }, "example": { "error": { "statusCode": "400", "message": "Bad Request", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}", "urn": "{{sentUrn}}" } ] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}" } } } }, "404": { "description": "This response indicates that there’re no attachments found in the envelope with the provided ID.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope-envelopeId-attachment-attachmentId-download-Get404ApplicationJsonResponse" }, "example": { "error": { "statusCode": "404", "message": "Not Found", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}" } ] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}" } } } } } } }, "/signatures/envelope/check": { "get": { "tags": [ "Envelope" ], "summary": "Envelope Check", "description": "Verifies whether all required actions to open an envelope have been completed.
\n* The envelope is identified using the transactionId (tid) query parameter, typically obtained from the GET /signatures/envelope/list endpoint.\n* The endpoint checks for completion of required actions, such as:\n * Legal terms acceptance", "operationId": "envelope-check", "parameters": [ { "name": "tid", "in": "query", "description": "This is a unique identifier associated with a specific recipient and envelope within a given transaction. It is used to securely validate that the user has the appropriate authorization to perform actions related to that transaction.", "schema": { "type": "string" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "This is the response returned when the envelope is successfully checked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope-check-Get200ApplicationJsonResponse" }, "example": { "result": { "statusCode": 200, "message": "OK", "data": { "envelope": { "id": "eab98526-e8-6e99b7cc99dc", "uploadDate": "2025-10-31T12:57:01.0000000+00:00", "status": "In Progress" }, "recipient": { "id": "b9bb72f2-997aab21bf2a", "role": "signer", "name": "RomanK", "email": "roman.khryshchanovich@mavenmule.com", "status": "In Progress", "isTokenExpired": false, "legalAccepted": false, "isMfaEnabled": false, "isMfaValid": false, "hostEmail": "" }, "settings": [ { "settingKey": "ENABLE_COMMENTS", "label": "Enable Comments", "type": "Boolean", "application": "MDS", "category": "Sending Settings", "subCategory": "Comments", "value": "true", "isAnonymousSetting": true, "preserve": true }, { "settingKey": "ALLOW_MOBILE_SIGNING", "label": "Mobile Signing", "type": "Boolean", "application": "MDS", "category": "Signing Settings", "subCategory": "Recipient Experience", "value": "true", "isAnonymousSetting": true, "preserve": true }, { "settingKey": "ALLOWED_SIGNATURE_INPUT_METHOD", "label": "Signature Input", "type": "Select", "application": "MDS", "category": "Signing Settings", "subCategory": "Recipient Experience", "value": "Typed,Imported", "isAnonymousSetting": true, "preserve": true }, { "settingKey": "DECLINE_REASON_REQUIRED", "label": "Decline Reason Required", "type": "Boolean", "application": "MDS", "category": "Signing Settings", "subCategory": "Recipient Experience", "value": "false", "isAnonymousSetting": true, "preserve": true }, { "settingKey": "REDIRECT_AFTER_SIGNING_URL", "label": "Redirect After Signing", "type": "String", "application": "MDS", "category": "Signing Settings", "subCategory": "Recipient Experience", "value": "", "isAnonymousSetting": true, "preserve": true }, { "settingKey": "SIGNING_ALLOW_REASSIGNMENT", "label": "Allow Responsibility Switch", "type": "Boolean", "application": "MDS", "category": "Signing Settings", "subCategory": "Recipient Experience", "value": "true", "isAnonymousSetting": true, "preserve": true }, { "settingKey": "SIGNING_AUTO_NAVIGATION", "label": "Auto Navigation", "type": "Boolean", "application": "MDS", "category": "Signing Settings", "subCategory": "Recipient Experience", "value": "true", "isAnonymousSetting": true, "preserve": true } ] } }, "origin": "GET https://dev.headless.mavenmule.com/signatures/envelope/check", "dateTime": "2025-10-31T01:10:54.0000000+00:00" } } } }, "400": { "description": "This response indicates that the request was invalid or improperly formed.
\nIt provides details about the error that occurred, including specific error codes, messages, and guidance for the user on how to resolve the issue.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope-check-Get400ApplicationJsonResponse" }, "example": { "error": { "statusCode": "400", "message": "Bad Request", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}", "urn": "{{sentUrn}}" } ] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}" } } } } } } }, "/signatures/mfa/initiate": { "post": { "tags": [ "Envelope", "MFA" ], "summary": "MFA Initiate", "description": "Initiates the multi-factor authentication (MFA) process.
\n* The request generates an authentication code and sends it to the specified phone number or email address.", "operationId": "mfa-initiate", "parameters": [ { "name": "tid", "in": "query", "description": "This is a unique identifier associated with a specific recipient and envelope within a given transaction. It is used to securely validate that the user has the appropriate authorization to perform actions related to that transaction.", "schema": { "type": "string" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "This is the response returned when the multi-factor authentication is initiated successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Mfa-initiate-Post200ApplicationJsonResponse" }, "example": { "result": { "statusCode": 200, "message": "OK", "data": { "recipient": { "method": "sms", "destination": { "phoneNumber": "", "email": "hrishchanovich92@gmail.com" }, "expiresAt": "2025-11-05T06:48:48.0000000+00:00", "message": "MFA code successfully sent" } } }, "origin": "POST https://dev.headless.mavenmule.com/signatures/mfa/initiate", "dateTime": "2025-11-05T06:38:53.0000000+00:00" } } } }, "400": { "description": "This response indicates that the request was invalid or improperly formed.
\nIt provides details about the error that occurred, including specific error codes, messages, and guidance for the user on how to resolve the issue.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Mfa-initiate-Post400ApplicationJsonResponse" }, "example": { "error": { "statusCode": "400", "message": "Bad Request", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}", "urn": "{{sentUrn}}" } ] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}" } } } } } } }, "/signatures/mfa/verify": { "post": { "tags": [ "Envelope", "MFA" ], "summary": "MFA Verify", "description": "Verifies the code sent as part of the multi-factor authentication (MFA) process.
\n* Use this endpoint to confirm the authentication code received via phone or email.\n", "operationId": "mfa-verify", "parameters": [ { "name": "tid", "in": "query", "description": "This is a unique identifier associated with a specific recipient and envelope within a given transaction. It is used to securely validate that the user has the appropriate authorization to perform actions related to that transaction.", "schema": { "type": "string" } }, { "name": "X-Subscription-Key", "in": "header", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "This is the response returned when the multi-factor authentication was successfully verified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Mfa-verify-Post200ApplicationJsonResponse" }, "example": { "result": { "statusCode": 200, "message": "OK", "data": { "recipient": { "method": "sms", "destination": "", "message": "MFA code successfully verified" } } }, "origin": "POST https://dev.headless.mavenmule.com/signatures/mfa/verify", "dateTime": "2025-11-05T06:42:40.0000000+00:00" } } } }, "400": { "description": "This response indicates that the request was invalid or improperly formed.
\nIt provides details about the error that occurred, including specific error codes, messages, and guidance for the user on how to resolve the issue.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Mfa-verify-Post400ApplicationJsonResponse" }, "example": { "error": { "statusCode": 400, "message": "Bad Request", "innerErrors": [ { "code": "MFA_INVALID_OR_EXPIRED_CODE", "message": "Invalid or expired MFA code.", "userMessage": "Invalid or expired MFA code. Please request a new MFA code." } ], "externalErrors": [] }, "origin": "POST https://test.headless.mavenmule.com/signatures/mfa/verify", "dateTime": "2025-11-05T12:35:38.0000000+00:00", "operationId": "6f728f58d0bdf45c62e9ab24e65" } } } } } } }, "/signatures/template/{templateId}/envelope/create": { "post": { "tags": [ "Template", "Envelope" ], "summary": "Envelope Create From Template", "description": "Creates an envelope based on a provided template.
\n* Use the templateId parameter to specify the template.\n* Documents must first be uploaded via the Storage endpoint and linked to recipients using referenceDocumentId and referenceSignerId.\n* Template roles are converted into envelope recipients.", "operationId": "envelope-create-from-template", "parameters": [ { "name": "templateId", "in": "path", "description": "The ID of the template based on which the envelope is created.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" }, "example": { "envelope": { "subject": "TestPostman", "message": "" }, "message": { "subject": "TestPostman", "recipients": [ { "templateRole": "Role1", "name": "RomanK", "email": "roman.khryshchanovich@mavenmule.com" } ] }, "signGroups": [] } } } }, "responses": { "201": { "description": "This response is returned after a successful request to create an envelope from the existing template.
\nThe envelope acts as a digital signing container that groups together documents, recipients, and signature fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Template-templateId-envelope-create-Post201ApplicationJsonResponse" }, "example": { "result": { "statusCode": 201, "message": "Created", "data": { "envelope": { "id": "cc25cdaa-4-b29c-2f741f612ae0", "uploadDate": "2025-11-03T12:19:00.0000000+00:00", "status": "Draft" }, "documents": [ { "id": "0a01e9d6-897b1-fa5d3b1c3", "externalContext": null } ], "recipients": [ { "id": "df5c2206-56-00a8be08522d", "externalContext": null } ], "signGroups": [], "fields": [ { "id": "558329f7-a425-005077518b", "recipientId": "df5c2206-56e22d", "signGroupId": "0000000-0000000", "documentId": "0a01e-a5cbed3b1c3" } ] } }, "origin": "POST https://dev.headless.mavenmule.com/signatures/template/816f309c-8e823ee9/envelope/create", "dateTime": "2025-11-03T12:19:00.0000000+00:00", "userId": "1d8b89c4-0889-4d03-a90c-9af09ac3bc9b" } } } }, "400": { "description": "This is the response returned when the request was formed incorrectly.
\nFor example, both an anchor string and manual positioning is added to the body of the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Template-templateId-envelope-create-Post400ApplicationJsonResponse" }, "example": { "error": { "statusCode": 400, "message": "Bad Request", "innerErrors": [ { "code": "ANCHOR_PROVIDED_POSITION_NOT_REQUIRED", "message": "Field can only be positioned based on an anchor string or manual positioning, not both.", "userMessage": "Field can only be positioned based on an anchor string or manual positioning, not both. If you have provided anchorString in your request please remove all of the positioning fields(positionX, positionY, height, width, page)." } ], "externalErrors": [] }, "externalContext": { "test1": "testvalueenvelope" }, "origin": "POST https://dev.headless.mavenmule.com/signatures/envelope/create", "dateTime": "2025-10-31T09:27:55.0000000+00:00", "userId": "1d8b89c4-0889-4d03-a90c-9af09ac3bc9b", "operationId": "e6a5c583f9746252cc2fd5ff15fd836c" } } } }, "500": { "description": "This is the response returned when the request has the invalid data.
\nFor example, the referenced file doesn't exist in Storage.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Template-templateId-envelope-create-Post500ApplicationJsonResponse" }, "example": { "error": { "statusCode": 500, "message": "Internal Server Error", "innerErrors": [ { "code": "FILE_NOT_EXISTS_IN_STORAGE", "message": "File with identifier bddd84db-3305-4df7-a2af-52c691d2bfdf not found in storage.", "userMessage": "File with identifier bddd84db-3305-4df7-a2af-52c691d2bfdf not found in storage." } ], "externalErrors": [] }, "origin": "POST https://dev.headless.mavenmule.com/signatures/envelope/create", "dateTime": "2025-10-31T09:33:29.0000000+00:00", "operationId": "4292a54fa4469c01c0ab4cff3b03a1a2" } } } } } } }, "/signatures/template/create": { "post": { "tags": [ "Template" ], "summary": "Template Create", "description": "Creates a template containing one or more documents, template roles, and recipient roles.
\n* The created template is assigned a unique ID, stored in the templateId parameter.\n* Documents must first be uploaded via the Storage endpoint and linked to recipients using referenceDocumentId and referenceSignerId.\n* Template roles act as placeholders for actual recipients, which are defined when the template is used to create an envelope.\n* Recipient roles define the required actions for each recipient.", "operationId": "template-create", "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "X-Subscription-Key\nUnique API key used to identify and authorize access to a specific environment\n\n", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "responses": { "201": { "description": "This response is returned after a successful request to create a template of the future envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Template-create-Post201ApplicationJsonResponse" }, "example": { "result": { "statusCode": 201, "message": "Created", "data": { "template": { "id": "4c935dff-dd5-198f92a4561c", "uploadDate": "2025-11-04T12:22:15.0000000+00:00" }, "documents": [ { "id": "373112d7-aa25cb5b13a", "externalContext": null } ], "recipients": [ { "id": "d2ccb83c-ad6b7d7bb357cb7", "externalContext": null } ], "signGroups": [], "fields": [ { "id": "6723cd7e-980fcc5d1", "recipientId": "d2c83c-ad637cb7", "signGroupId": "000000-00000000", "documentId": "373112d7-aa2-4b1a" } ] } }, "origin": "POST https://dev.headless.mavenmule.com/signatures/template/create", "dateTime": "2025-11-04T12:22:15.0000000+00:00", "userId": "1d8b89c4-0889-9af09ac3bc9b" } } } }, "400": { "description": "This is the response returned when the request was formed incorrectly.
\nFor example, both an anchor string and manual positioning is added to the body of the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Template-create-Post400ApplicationJsonResponse" }, "example": { "error": { "statusCode": 400, "message": "Bad Request", "innerErrors": [ { "code": "ANCHOR_PROVIDED_POSITION_NOT_REQUIRED", "message": "Field can only be positioned based on an anchor string or manual positioning, not both.", "userMessage": "Field can only be positioned based on an anchor string or manual positioning, not both. If you have provided anchorString in your request please remove all of the positioning fields(positionX, positionY, height, width, page)." } ], "externalErrors": [] }, "externalContext": { "test1": "testvalueenvelope" }, "origin": "POST https://dev.headless.mavenmule.com/signatures/template/create", "dateTime": "2025-10-31T09:27:55.0000000+00:00", "userId": "1d8b8990c-9af09ac3bc9b", "operationId": "e6a5c583f2c2fd5ff15fd836c" } } } }, "500": { "description": "This is the response returned when the request has the invalid data.
\nFor example, the referenced file doesn' t exist in Storage.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Template-create-Post500ApplicationJsonResponse" }, "example": { "error": { "statusCode": 500, "message": "Internal Server Error", "innerErrors": [ { "code": "FILE_NOT_EXISTS_IN_STORAGE", "message": "File with identifier bddd84db-330dd2bfdf not found in storage.", "userMessage": "File with identifier bddd84db-330dd2bfdf not found in storage." } ], "externalErrors": [] }, "origin": "POST https://dev.headless.mavenmule.com/signatures/template/create", "dateTime": "2025-10-31T09:33:29.0000000+00:00", "operationId": "4292a54fb4cff3b03a1a2" } } } } } } }, "/signatures/template/{templateId}/delete": { "delete": { "tags": [ "Template" ], "summary": "Template Delete", "description": "Deletes a specific template from the system.
\n* The template is identified using the templateId path parameter.\n* Only templates accessible to the authenticated user can be deleted.", "operationId": "template-delete", "parameters": [ { "name": "templateId", "in": "path", "description": "The ID of the template that should be deleted.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "String Bearer {{authToken}}" ], "type": "string", "default": "String Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "This response indicates that the template identified by the provided templateId was successfully deleted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Template-templateId-delete-Del200ApplicationJsonResponse" }, "example": { "result": { "statusCode": 200, "message": "OK", "data": { "template": { "id": "4602f79a-5bf16cdf68f", "message": "Template successfully deleted" } } }, "origin": "DELETE https://dev.headless.mavenmule.com/signatures/template/4602f79a-9be6-4076-8eb7-85bf16cdf68f/delete", "dateTime": "2025-11-04T12:26:50.0000000+00:00", "userId": "1d8b89c4-0889-4d03-a90c-9af09ac3bc9b" } } } }, "400": { "description": "This response indicates that the request was invalid or improperly formed.
\nIt provides details about the error that occurred, including specific error codes, messages, and guidance for the user on how to resolve the issue.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Template-templateId-delete-Del400ApplicationJsonResponse" }, "example": { "error": { "statusCode": "400", "message": "Bad Request", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}" } ], "externalErrors": [] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}", "userId": "{{userId}}", "operationId": "{{operationId}}" } } } }, "404": { "description": "This response indicates that there’s no template found with the provided ID.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Template-templateId-delete-Del404ApplicationJsonResponse" }, "example": { "error": { "statusCode": "404", "message": "Not Found", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}" } ] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}" } } } } } } }, "/signatures/template/{templateId}/get": { "get": { "tags": [ "Template", "Data" ], "summary": "Template Get", "description": "Retrieves details of a specific template.
\n* The template is identified using the templateId path parameter.\n* Only templates accessible to the authenticated user are returned.", "operationId": "template-get", "parameters": [ { "name": "templateId", "in": "path", "description": "The ID of the needed template.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "This is the response returned when the template is successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Template-templateId-get-Get200ApplicationJsonResponse" }, "example": { "result": { "statusCode": 200, "message": "OK", "data": { "template": { "id": "e08f7851-dc1d-482ff0857c4e4", "createdBy": { "id": "1d8b89c4-0889-4d0c-9af09ac3bc9b", "name": "Roman", "email": "roman.khryshchanovich@mavenmule.com" }, "uploadDate": "2025-11-04T12:34:20.0000000+00:00", "sendDate": null, "status": "Template", "subject": "Sample", "message": "", "isSignOrder": false, "expireInDays": 30, "firstReminderDays": null, "repeatingReminderDays": null, "notifyWhenOpened": true, "notifyWhenSigned": true, "alertDaysBeforeExpiry": 1, "templateName": "Sample Template", "templateDescription": "" }, "documents": [ { "id": "53aa7efc-82fc-49b1330114c68", "name": "Sales Agreement.pdf", "externalContext": null } ], "recipients": [ { "id": "9ef72bea-765-b957a6ba80e9", "name": "", "email": "", "role": "signer", "status": "Template", "signDate": "", "signOrder": 1, "signGroupId": "00000000-000-000000000000", "userId": null, "mandatory": true, "isMFAEnabled": false, "phoneNumber": null, "hostEmail": null, "templateRole": "Sample Role", "externalContext": null } ], "signGroups": [], "fields": [ { "id": "69950844-1206-9711415", "name": "6a19f2a2630241c7e99cbdd34da", "recipientId": "9ef72bea-76fa-4957a6ba80e9", "signGroupId": "00000000-0000-000000000000", "documentId": "53aa7efc-82fc-46330114c68", "type": "signature", "value": "", "page": 1, "height": 35, "width": 100, "positionX": 117.2445, "positionY": 17.8811, "isRequired": true, "properties": null }, { "id": "ae726cea-1dc0-4df0c989ff30", "name": "d6a1b10eb7a64c891c78d3a85", "recipientId": "9ef72bea-76957a6ba80e9", "signGroupId": "00000000-000000000", "documentId": "53aa7efc-82330114c68", "type": "name", "value": "", "page": 1, "height": 35, "width": 100, "positionX": 235.016, "positionY": 17.8689, "isRequired": false, "properties": { "fontFamily": "Helvetica", "fontSize": 13, "color": "#000000", "bold": false, "italic": false, "underline": false, "textAlign": "left", "isSignedDate": false, "selectionGroup": null, "selectionValue": null } } ], "externalContext": null } }, "origin": "GET https://dev.headless.mavenmule.com/signatures/template/e08f7851-dc1d-482ff0857c4e4/get", "dateTime": "2025-11-04T12:36:06.0000000+00:00", "userId": "1d8b89c4-088af09ac3bc9b" } } } }, "400": { "description": "This response indicates that the request was invalid or improperly formed.
\nIt provides details about the error that occurred, including specific error codes, messages, and guidance for the user on how to resolve the issue.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Template-templateId-get-Get400ApplicationJsonResponse" }, "example": { "error": { "statusCode": "400", "message": "Bad Request", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}", "urn": "{{sentUrn}}" } ] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}" } } } }, "404": { "description": "This response indicates that there’s no template found with the provided ID.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Template-templateId-get-Get404ApplicationJsonResponse" }, "example": { "error": { "statusCode": "404", "message": "Not Found", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}" } ] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}" } } } } } } }, "/signatures/template/list": { "get": { "tags": [ "Template" ], "summary": "Template List", "description": "Retrieves a list of all templates associated with the authenticated user.
\n* Supports filtering, sorting, and pagination via query parameters.\n* Query Parameters:\n * top (integer). Maximum number of templates to return (e.g., 25).\n * skip (integer). Number of templates to skip in the sorted results (e.g., 0).\n * sort (string). Column to sort by. Valid values: Template Name, Template Roles, Documents, Creation Date.\n * order (string). Sort direction. Valid values: ASC, DESC.\n * filter (JSON array). List of filter objects to refine results. Each filter includes:\n * column (string). Field to filter on (matches sort values).\n * condition (string). Filter condition. \n * For stringFilter: EMPTY, NOT_EMPTY, CONTAINS, CONTAINS_CASE_SENSITIVE, DOES_NOT_CONTAIN, DOES_NOT_CONTAIN_CASE_SENSITIVE, STARTS_WITH, STARTS_WITH_CASE_SENSITIVE, ENDS_WITH, ENDS_WITH_CASE_SENSITIVE, EQUAL, EQUAL_CASE_SENSITIVE, NULL, NOT_NULL.\n * For dateFilter: EQUAL, NOT_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL, GREATER_THAN, GREATER_THAN_OR_EQUAL, NULL, NOT_NULL.\n * value (string). Filter value.\n * string for stringFilter.\n * YYYY-MM-DD for dateFilter.\n * type (string): \n * stringFilter.\n * dateFilter.\n * key (string). Unique 12-character alphanumeric identifier for the filter.", "operationId": "template-list", "parameters": [ { "name": "top", "in": "query", "description": "Maximum number of templates to return.", "schema": { "type": "integer" } }, { "name": "skip", "in": "query", "description": "Number of templates to skip in the sorted results.", "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "description": "Column to sort by the results.", "schema": { "enum": [ "Template Name", "Template Roles", "Documents", "Creation Date" ], "type": "string" } }, { "name": "order", "in": "query", "description": "The direction of the sort.", "schema": { "enum": [ "ASC", "DESC" ], "type": "string" } }, { "name": "filter", "in": "query", "description": "List of filter objects to refine results. Each filter includes:
\n* column (string). Field to filter on.\n* condition (string). Filter condition.\n* value (string). Filter value.\n* type (string):\n * stringFilter.\n * dateFilter.\n* key (string). Unique 12-character alphanumeric identifier for the filter.", "schema": { "enum": [ "Template Name", "Template Roles", "Documents", "Created Date", "Empty", "Not Empty", "Contains", "Contains Case Sensitive", "Does Not Contain", "Does Not Contain Case Sensitive", "Starts With", "Starts With Case Sensitive", "Ends With", "Ends With Case Sensitive", "Null", "Not Null", "Equal", "Equal Case Sensitive", "Less Than", "Less Than Or Equal", "Greater Than", "Greater Than Or Equal" ], "type": "JOSN Array" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "This is the response returned when the list of available templates is successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Template-list-Get200ApplicationJsonResponse" }, "example": { "result": { "statusCode": 200, "message": "OK", "data": { "templates": [ { "id": "4602f79a-9be6-4076-8eb7-85bf16cdf68f", "createdBy": { "id": "1d8b89c4-0889-4d03-a90c-9af09ac3bc9b", "name": "Roman", "email": "roman.khryshchanovich@mavenmule.com" }, "creatorGuid": "1d8b89c4-0889-4d03-a90c-9af09ac3bc9b", "status": "Template", "uploadDate": "2025-11-04T12:26:38.0000000+00:00", "sendDate": null, "subject": "", "transactionTokenId": null, "documents": "", "recipients": "", "isSignOrder": false, "expireInDays": 30, "alertDaysBeforeExpiry": 1, "templateName": "Template5", "templateDescription": "", "templateRoles": "r1" }, { "id": "4c935dff-d7ee-497b-80d5-198f92a4561c", "createdBy": { "id": "1d8b89c4-0889-4d03-a90c-9af09ac3bc9b", "name": "Roman", "email": "roman.khryshchanovich@mavenmule.com" }, "creatorGuid": "1d8b89c4-0889-4d03-a90c-9af09ac3bc9b", "status": "Template", "uploadDate": "2025-11-04T12:22:15.0000000+00:00", "sendDate": null, "subject": "", "transactionTokenId": null, "documents": "Sales Agreement.pdf", "recipients": "", "isSignOrder": false, "expireInDays": 30, "alertDaysBeforeExpiry": 1, "templateName": "Sample Template", "templateDescription": "", "templateRoles": "Sample Role 1" }, { "id": "816f309c-8e87-4f10-8873-0de066723ee9", "createdBy": { "id": "1d8b89c4-0889-4d03-a90c-9af09ac3bc9b", "name": "Roman", "email": "roman.khryshchanovich@mavenmule.com" }, "creatorGuid": "1d8b89c4-0889-4d03-a90c-9af09ac3bc9b", "status": "Template", "uploadDate": "2025-11-03T12:08:59.0000000+00:00", "sendDate": null, "subject": "", "transactionTokenId": null, "documents": "Sales Agreement.pdf", "recipients": "", "isSignOrder": false, "expireInDays": 30, "alertDaysBeforeExpiry": 1, "templateName": "TemplatePostman", "templateDescription": "", "templateRoles": "Role1" } ], "rowCount": 3 } }, "origin": "GET https://dev.headless.mavenmule.com/signatures/template/list", "dateTime": "2025-11-04T12:26:45.0000000+00:00", "userId": "1d8b89c4-0889-4d03-a90c-9af09ac3bc9b" } } } }, "400": { "description": "This response indicates that the request was invalid or improperly formed.
\nIt provides details about the error that occurred, including specific error codes, messages, and guidance for the user on how to resolve the issue.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Template-list-Get400ApplicationJsonResponse" }, "example": { "error": { "statusCode": "400", "message": "Bad Request", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}", "urn": "{{sentUrn}}" } ] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}" } } } } } } }, "/signatures/template/{templateId}/update": { "put": { "tags": [ "Template" ], "summary": "Template Update", "description": "Updates an existing template that has been created but not yet used to send an envelope.
\n* The template is identified using the templateId parameter.\n* This endpoint allows modification of:\n * Template information.\n * Included documents.\n * Assigned recipients.\n * Added fields.\n * Expiration settings.\n * Reminder settings.\n * Associated metadata.", "operationId": "template-update", "parameters": [ { "name": "templateId", "in": "path", "description": "The ID of the template that should be edited.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "This is the response returned when the template is successfully edited.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Template-templateId-update-Put200ApplicationJsonResponse" }, "example": { "result": { "statusCode": 200, "message": "OK", "data": { "template": { "id": "e08f7851-dc1-d2ff0857c4e4" }, "documents": [ { "id": "174b02df-b89c-6793450ca", "externalContext": null } ], "recipients": [ { "id": "c491b4bc-79b6-44d0-a34c6ab6", "externalContext": null } ], "signGroups": [], "fields": [ { "id": "93e22ca5-cf10-40ab-ecfb75c6", "recipientId": "c491b4bc-79b6-4a334c6ab6", "signGroupId": "00000000-000000000000", "documentId": "174b02df-b89c-4d393450ca" }, { "id": "ba1c7c7f-c05e972c8b406e", "recipientId": "c491b4bc-79b6-44d0-6ab6", "signGroupId": "00000000-0000-000000000", "documentId": "174b02df-bb3f6793450ca" } ] } }, "origin": "PUT https://dev.headless.mavenmule.com/signatures/template/e08f7851-dc1-d2ff0857c4e4/update", "dateTime": "2025-11-04T12:37:28.0000000+00:00", "userId": "1d8b89c4-0889-9af09ac3bc9b" } } } }, "400": { "description": "This response indicates that the request was invalid or improperly formed.
\nIt provides details about the error that occurred, including specific error codes, messages, and guidance for the user on how to resolve the issue.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Template-templateId-update-Put400ApplicationJsonResponse" }, "example": { "error": { "statusCode": 400, "message": "Bad Request", "innerErrors": [ { "code": "TEMPLATE_ID_INVALID", "message": "Template with ID 0f6dca08-76b883c8bbb4 does not exist", "userMessage": "Template with ID 0f6dca08-76b883c8bbb does not exist" } ], "externalErrors": [] }, "externalContext": { "test1": "testvalue" }, "origin": "PUT https://dev.headless.mavenmule.com/signatures/template/0f6dca08-76b883c8bbb/edit", "dateTime": "2025-11-04T07:40:12.0000000+00:00", "userId": "1d8b89c4-0ac3bc9b", "operationId": "5c1354f98612f2eec2" } } } }, "404": { "description": "This response indicates that there’s no template found with the provided ID.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Template-templateId-update-Put404ApplicationJsonResponse" }, "example": { "error": { "statusCode": "404", "message": "Not Found", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}" } ] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}" } } } } } } }, "/signatures/envelope/reassign": { "post": { "tags": [ "Envelope" ], "summary": "Envelope Reassign", "description": "Redirects a received envelope to another user.
\n* The envelope is identified using the transactionId (tid) query parameter, which can be obtained from the GET /signatures/envelope/list endpoint.\n* This endpoint allows the recipient to forward the envelope to another user instead of completing it.", "operationId": "envelope-reassign", "parameters": [ { "name": "tid", "in": "query", "description": "This is a unique identifier associated with a specific recipient and envelope within a given transaction. It is used to securely validate that the user has the appropriate authorization to perform actions related to that transaction.", "schema": { "type": "string" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "This is the response returned when the envelope is successfully declined.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope-reassign-Post200ApplicationJsonResponse" }, "example": { "result": { "statusCode": 200, "message": "OK", "data": { "envelope": { "id": "e08f7851-dc1d-4823-af58-d2ff0857c4e4", "message": "Envelope successfully reassigned" } } }, "origin": "POST https://dev.headless.mavenmule.com/signatures/envelope/reassign", "dateTime": "2025-11-04T08:23:29.0000000+00:00" } } } }, "400": { "description": "This response indicates that the request was invalid or improperly formed.
\nIt provides details about the error that occurred, including specific error codes, messages, and guidance for the user on how to resolve the issue.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope-reassign-Post400ApplicationJsonResponse" }, "example": { "error": { "statusCode": "400", "message": "Bad Request", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}", "urn": "{{sentUrn}}" } ] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}" } } } } } } }, "/signatures/document/{documentId}/comment": { "post": { "tags": [ "Document", "Comment" ], "summary": "Document Comment", "description": "Adds a text comment to a document that’s part of an envelope.
\n* The document must be uploaded to the Storage system before you can comment on it.\n* Use the documentId (a unique document URN) to reference the stored document.\n* The document can be identified by a unique transactionId (tid).\n* Provide the tid as a query parameter.", "operationId": "document-comment", "parameters": [ { "name": "documentId", "in": "path", "description": "The ID(URN) of the document from the envelope, where you’d like to place a comment.", "required": true, "schema": { "type": "string" } }, { "name": "tid", "in": "query", "description": "This is a unique identifier associated with a specific recipient and envelope within a given transaction. It is used to securely validate that the user has the appropriate authorization to perform actions related to that transaction.", "schema": { "type": "string" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "responses": { "201": { "description": "This response is returned after a successful request to place the comment.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document-documentId-comment-Post201ApplicationJsonResponse" }, "example": { "result": { "statusCode": 201, "message": "Created", "data": { "comments": { "629d2b7e-378f-88e-4e5646764c4d": [ { "id": 6, "commentGuid": "46e10767-8806-40bbe6fc", "documentId": 47, "signerId": 49, "parentCommentId": null, "parentCommentGuid": null, "content": "TEST", "pageNumber": 1, "positionX": 1201.95351573992, "positionY": 134.439541041483, "visibleTo": "[\"sender\",\"fc6f00f-f125-4939fa6\"]", "createdAt": "2025-10-31T10:44:30.0000000+00:00", "authorName": "RomanK", "authorEmail": "roman.khryshchanovich@mavenmule.com", "documentGuid": "629db7-378f-4e56476c4d" } ] } } }, "origin": "POST https://dev.headless.mavenmule.com/signatures/document/629db7-378f-4e56476c4d/comment", "dateTime": "2025-10-31T10:44:31.0000000+00:00", "userId": "1d8b89c4-0889--9af09ac3bc9b" } } } }, "400": { "description": "This is the response returned when the request was formed incorrectly.
\nIt includes detailed error information such as error codes, descriptive messages, and guidance on how to correct the issue.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document-documentId-comment-Post400ApplicationJsonResponse" }, "example": { "error": { "statusCode": "400", "message": "Bad Request", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}", "urn": "{{sentUrn}}" } ] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}" } } } } } } }, "/signatures/envelope/count": { "get": { "tags": [ "Envelope" ], "summary": "Envelope Count", "description": "The endpoint retrieves the number of envelopes and divides them by folders.", "operationId": "envelope-count", "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "String Bearer {{authToken}}" ], "type": "string", "default": "String Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "This response is returned after the amount of envelopes is successfully counted.
The number of envelopes is sorted by folders.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope-count-Get200ApplicationJsonResponse" }, "example": { "result": { "statusCode": 200, "message": "OK", "data": { "envelopes": { "inbox": 39, "sent": 39, "drafts": 1, "trash": 0, "todo": 5, "expiring": 2, "pending": 1, "completed": 22 } } }, "origin": "GET https://dev.headless.mavenmule.com/signatures/envelope/count", "dateTime": "2025-12-02T11:30:34.0000000+00:00", "userId": "b20878ce-1947-4e52-a2c8" } } } }, "400": { "description": "This is the response returned when the request was formed incorrectly.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope-count-Get400ApplicationJsonResponse" }, "example": { "error": { "statusCode": "400", "message": "Bad Request", "innerErrors": [ { "code": "{{errorCode}}", "message": "{{errorMessage}}", "userMessage": "{{message}}", "urn": "{{sentUrn}}" } ] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}" } } } } } } }, "/signatures/folder/{folderId}/get": { "get": { "tags": [ "Folder" ], "summary": "Folder Get", "description": "Retrieves the details and metadata of a specific folder using its unique ID.", "operationId": "folder-get", "parameters": [ { "name": "folderId", "in": "path", "description": "The unique identifier (GUID) of the folder to retrieve.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request.", "required": true, "schema": { "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment.", "required": true, "schema": { "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "Folder details retrieved successfully.", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 200 }, "message": { "type": "string", "example": "OK" }, "data": { "type": "object", "properties": { "folder": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The internal database identifier for the folder.", "example": 1 }, "FolderGuid": { "type": "string", "description": "The globally unique identifier for the folder.", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "SubscriptionUserId": { "type": "integer", "description": "The ID of the subscription user who owns or created the folder.", "example": 105 }, "Name": { "type": "string", "description": "The display name of the folder.", "example": "Q3 Financial Contracts" }, "NamespaceId": { "type": "integer", "description": "The namespace or tenant context the folder belongs to.", "example": 12 } }, "description": "Represents a folder entity used to organize documents and envelopes." } } } } } } }, "example": { "result": { "statusCode": 200, "message": "OK", "data": { "folder": { "Id": 1, "FolderGuid": "123e4567-e89b-12d3-a456-426614174000", "SubscriptionUserId": 105, "Name": "Q3 Financial Contracts", "NamespaceId": 12 } } } } } } } } } }, "/signatures/folder/list": { "get": { "tags": [ "Folder" ], "summary": "Folder List", "description": "Retrieves a paginated list of all folders associated with the authenticated user or namespace.", "operationId": "folder-list", "parameters": [ { "name": "top", "in": "query", "description": "Maximum number of folders to return.", "schema": { "type": "integer" } }, { "name": "skip", "in": "query", "description": "Number of folders to skip in the sorted results.", "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "description": "Column to sort the results by (e.g., Name).", "schema": { "type": "string" } }, { "name": "order", "in": "query", "description": "Sort direction (ASC or DESC).", "schema": { "enum": [ "ASC", "DESC" ], "type": "string" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request.", "required": true, "schema": { "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access.", "required": true, "schema": { "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "List of folders retrieved successfully.", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 200 }, "message": { "type": "string", "example": "OK" }, "data": { "type": "object", "properties": { "folders": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The internal database identifier for the folder.", "example": 1 }, "FolderGuid": { "type": "string", "description": "The globally unique identifier for the folder.", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "SubscriptionUserId": { "type": "integer", "description": "The ID of the subscription user who owns or created the folder.", "example": 105 }, "Name": { "type": "string", "description": "The display name of the folder.", "example": "Q3 Financial Contracts" }, "NamespaceId": { "type": "integer", "description": "The namespace or tenant context the folder belongs to.", "example": 12 } }, "description": "Represents a folder entity used to organize documents and envelopes." } }, "rowCount": { "type": "integer", "description": "Total number of folders available." } } } } } } }, "example": { "result": { "statusCode": 200, "message": "OK", "data": { "folders": [ { "Id": 1, "FolderGuid": "123e4567-e89b-12d3-a456-426614174000", "SubscriptionUserId": 105, "Name": "Q3 Financial Contracts", "NamespaceId": 12 } ], "rowCount": 0 } } } } } } } } }, "/signatures/folder/{folderId}/update": { "put": { "tags": [ "Folder" ], "summary": "Folder Update", "description": "Updates the properties (such as the Name) of an existing folder.", "operationId": "folder-update", "parameters": [ { "name": "folderId", "in": "path", "description": "The unique identifier (GUID) of the folder to update.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request.", "required": true, "schema": { "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access.", "required": true, "schema": { "type": "string", "default": "{{apiKey}}" } } ], "requestBody": { "description": "The folder object containing updated values.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderModel" }, "example": { "Id": 1, "FolderGuid": "123e4567-e89b-12d3-a456-426614174000", "SubscriptionUserId": 105, "Name": "Q3 Financial Contracts", "NamespaceId": 12 } } } }, "responses": { "200": { "description": "Folder updated successfully.", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 200 }, "message": { "type": "string", "example": "OK" }, "data": { "type": "object", "properties": { "folder": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The internal database identifier for the folder.", "example": 1 }, "FolderGuid": { "type": "string", "description": "The globally unique identifier for the folder.", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "SubscriptionUserId": { "type": "integer", "description": "The ID of the subscription user who owns or created the folder.", "example": 105 }, "Name": { "type": "string", "description": "The display name of the folder.", "example": "Q3 Financial Contracts" }, "NamespaceId": { "type": "integer", "description": "The namespace or tenant context the folder belongs to.", "example": 12 } }, "description": "Represents a folder entity used to organize documents and envelopes." } } } } } } }, "example": { "result": { "statusCode": 200, "message": "OK", "data": { "folder": { "Id": 1, "FolderGuid": "123e4567-e89b-12d3-a456-426614174000", "SubscriptionUserId": 105, "Name": "Q3 Financial Contracts", "NamespaceId": 12 } } } } } } } } } }, "/signatures/folder/create": { "post": { "tags": [ "Folder" ], "summary": "Folder Create", "description": "Creates a new folder in the specified namespace to organize documents and envelopes.", "operationId": "folder-create", "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request.", "required": true, "schema": { "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access.", "required": true, "schema": { "type": "string", "default": "{{apiKey}}" } } ], "requestBody": { "description": "The folder object to be created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderModel" }, "example": { "Id": 1, "FolderGuid": "123e4567-e89b-12d3-a456-426614174000", "SubscriptionUserId": 105, "Name": "Q3 Financial Contracts", "NamespaceId": 12 } } } }, "responses": { "201": { "description": "Folder created successfully.", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 201 }, "message": { "type": "string", "example": "Created" }, "data": { "type": "object", "properties": { "folder": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The internal database identifier for the folder.", "example": 1 }, "FolderGuid": { "type": "string", "description": "The globally unique identifier for the folder.", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "SubscriptionUserId": { "type": "integer", "description": "The ID of the subscription user who owns or created the folder.", "example": 105 }, "Name": { "type": "string", "description": "The display name of the folder.", "example": "Q3 Financial Contracts" }, "NamespaceId": { "type": "integer", "description": "The namespace or tenant context the folder belongs to.", "example": 12 } }, "description": "Represents a folder entity used to organize documents and envelopes." } } } } } } }, "example": { "result": { "statusCode": 201, "message": "Created", "data": { "folder": { "Id": 1, "FolderGuid": "123e4567-e89b-12d3-a456-426614174000", "SubscriptionUserId": 105, "Name": "Q3 Financial Contracts", "NamespaceId": 12 } } } } } } } } } }, "/signatures/folder/{folderId}/delete": { "delete": { "tags": [ "Folder" ], "summary": "Folder Delete", "description": "Deletes a specific folder from the system.", "operationId": "folder-delete", "parameters": [ { "name": "folderId", "in": "path", "description": "The unique identifier (GUID) of the folder to delete.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request.", "required": true, "schema": { "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access.", "required": true, "schema": { "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "Folder deleted successfully.", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 200 }, "message": { "type": "string", "example": "OK" }, "data": { "type": "object", "properties": { "folderId": { "type": "string", "format": "uuid" }, "message": { "type": "string", "example": "Folder deleted successfully." } } } } } } }, "example": { "result": { "statusCode": 200, "message": "OK", "data": { "folderId": "string", "message": "Folder deleted successfully." } } } } } } } } }, "/signatures/template/{templateId}/edit": { "put": { "tags": [ "Template" ], "summary": "Template Edit", "description": "Edits an existing template's properties.
\n* The template is identified using the templateId path parameter.\n* Currently, this endpoint allows moving a template to a specific folder by providing the folderId.\n* If folderId is provided as null, the template will be removed from its current folder and placed in the root directory.", "operationId": "template-edit", "parameters": [ { "name": "templateId", "in": "path", "description": "The unique identifier (GUID) of the template to be edited.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "type": "string", "default": "{{apiKey}}" } } ], "requestBody": { "description": "The payload containing the properties to edit on the template.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvelopeTemplateEditDTO" }, "example": { "template": { "folderId": "123e4567-e89b-12d3-a456-426614174000" }, "externalContext": { "id": "12345" } } } } }, "responses": { "200": { "description": "This response indicates that the template was successfully edited.", "content": { "application/json": { "schema": { "required": [ "result", "origin", "dateTime", "userId" ], "type": "object", "properties": { "result": { "required": [ "statusCode", "message", "data" ], "type": "object", "properties": { "statusCode": { "type": "integer", "description": "HTTP status code indicating the result of the operation.", "example": 200 }, "message": { "type": "string", "description": "Descriptive message confirming the result of the request.", "example": "OK" }, "data": { "required": [ "template" ], "type": "object", "properties": { "template": { "required": [ "id", "message" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the edited template.", "format": "uuid" }, "message": { "type": "string", "description": "Descriptive message generated by the system." } } } } } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the request." }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the request was completed.", "format": "date-time" }, "userId": { "type": "string", "description": "The unique identifier of the user or system that initiated the request." } } }, "example": { "result": { "statusCode": 200, "message": "OK", "data": { "template": { "id": "1df9-be76007e25fc", "message": "Template successfully edited" } } }, "origin": "PUT https://dev.headless.mavenmule.com/signatures/template/1df9-be76007e25fc/edit", "dateTime": "2025-11-04T10:25:22.0000000+00:00", "userId": "1d8b89c4-090c-9af09ac3bc9b" } } } }, "400": { "description": "This response indicates that the request was invalid, improperly formed, or the template edit operation failed in the database.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "string" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" } } } } } }, "externalContext": { "type": "object" }, "origin": { "type": "string" }, "dateTime": { "type": "string" }, "userId": { "type": "string" } } }, "example": { "error": { "statusCode": "400", "message": "Bad Request", "innerErrors": [ { "code": "TEMPLATE_EDIT_FAILED", "message": "Failed to update the template folder in the database.", "userMessage": "Could not edit the specified template." } ] }, "externalContext": { "id": "12345" }, "origin": "PUT https://dev.headless.mavenmule.com/signatures/template/1df9-be76007e25fc/edit", "dateTime": "2025-11-04T10:25:22.0000000+00:00", "userId": "1d8b89c4-090c-9af09ac3bc9b" } } } } } } }, "/clickwrap/termDefinitions/create": { "post": { "tags": [ "Term Definitions" ], "summary": "Term Definition Create ", "description": "This endpoint allows you to create a term definition — a versioned, immutable record containing the text or HTML content that will be shown to end-users during the Clickwrap acceptance process. Term definitions serve as the legal source of truth and historical record of what was presented to users at the time of acceptance. Because of their legal and audit purpose, term definitions cannot be updated or deleted via API. Once created, they can only be retrieved.", "operationId": "create-termdefinition", "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "externalContext": { "type": "object", "properties": { "id": { "type": "string", "description": "External reference ID used for contextual tracking.", "default": "12345" } } }, "termDefinition": { "required": [ "name", "code", "text" ], "type": "object", "properties": { "name": { "type": "string", "description": "The title of the text, which helps the user quickly identify the term definition when querying.", "default": "Terms & conditions" }, "code": { "type": "string", "description": "A designation for tracking the version of the term definition. Its usage is fully customizable and left to the user's discretion.", "default": "1.0" }, "text": { "type": "string", "description": "The content (plain text, HTML,...) of the terms that will be displayed to the end-user.", "default": "I agree to the terms and conditions..." } } } } }, "example": { "externalContext": { "id": "12345" }, "termDefinition": { "name": "{{termTitle}}", "code": "{{termVersionCode}}", "text": "{{termText}}" } } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "required": [ "result", "origin", "dateTime", "userId" ], "type": "object", "properties": { "result": { "required": [ "statusCode", "message", "data" ], "type": "object", "properties": { "statusCode": { "type": "integer", "description": "HTTP status code indicating the result of the operation." }, "message": { "type": "string", "description": "Descriptive message confirming the result of the request." }, "data": { "type": "array", "items": { "required": [ "termDefinition" ], "type": "object", "properties": { "termDefinition": { "required": [ "termDefinitionId" ], "type": "object", "properties": { "termDefinitionId": { "type": "string", "description": "Unique identifier of the created term definition." } } } } } } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the request." }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the request was completed and the response returned." }, "userId": { "type": "string", "description": "The unique identifier of the user or system that initiated the request." } } }, "example": { "result": { "statusCode": 201, "message": "Created", "data": [ { "termDefinition": { "termDefinitionId": "{{guid}}" } } ] }, "externalContext": { "id": "{{externalContextId}}" }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}", "userId": "{{userId}}" } } } } } } }, "/clickwrap/termDefinitions/list": { "get": { "tags": [ "Term Definitions" ], "summary": "Term Definition List", "description": "This endpoint retrieves a list of all available term definitions that the user has previously created.", "operationId": "list-termdefinition", "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "required": [ "result", "origin", "dateTime", "userId" ], "type": "object", "properties": { "result": { "required": [ "statusCode", "message", "data" ], "type": "object", "properties": { "statusCode": { "type": "integer", "description": "HTTP status code indicating the result of the operation." }, "message": { "type": "string", "description": "Descriptive message confirming the result of the request." }, "data": { "type": "array", "items": { "required": [ "termDefinition" ], "type": "object", "properties": { "termDefinition": { "required": [ "termDefinitionId", "name", "code", "text" ], "type": "object", "properties": { "termDefinitionId": { "type": "string", "description": "Unique identifier of the retrieved term definition.", "format": "uuid" }, "name": { "type": "string", "description": "The title of the term definition used for identification." }, "code": { "type": "string", "description": "Versioning or categorization code defined by the client." }, "text": { "type": "string", "description": "Text or HTML content of the term definition shown to end-users." } } } } }, "description": "Array of term definition results." } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the request." }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the request was completed and the response returned." }, "userId": { "type": "string", "description": "The unique identifier of the user or system that initiated the request." } } }, "example": { "result": { "statusCode": 200, "message": "OK", "data": [ { "termDefinition": { "termDefinitionId": "{{guid}}", "name": "{{termTitle}}", "code": "{{termVersionCode}}", "text": "{{termText}}" } } ] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}", "userId": "{{userId}}" } } } } } } }, "/clickwrap/termDefinitions/{termDefinitionId}/get": { "get": { "tags": [ "Term Definitions" ], "summary": "Term Definition Get", "description": "This endpoint retrieves a specific term definition based on the unique term definition id (GUID) provided in the path.", "operationId": "get-termdefinition", "parameters": [ { "name": "termDefinitionId", "in": "path", "required": true, "schema": { "enum": [ "" ] } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "required": [ "result", "origin", "dateTime", "userId" ], "type": "object", "properties": { "result": { "required": [ "statusCode", "message", "data" ], "type": "object", "properties": { "statusCode": { "type": "integer", "description": "HTTP status code indicating the result of the operation." }, "message": { "type": "string", "description": "Descriptive message confirming the result of the request." }, "data": { "type": "array", "items": { "required": [ "termDefinition" ], "type": "object", "properties": { "termDefinition": { "required": [ "termDefinitionId", "name", "code", "text" ], "type": "object", "properties": { "termDefinitionId": { "type": "string", "description": "Unique identifier of the retrieved term definition.", "format": "uuid" }, "name": { "type": "string", "description": "The title of the term definition used for identification." }, "code": { "type": "string", "description": "Versioning or categorization code defined by the client." }, "text": { "type": "string", "description": "Text or HTML content of the term definition shown to end-users." } } } } }, "description": "Array of term definition results." } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the request." }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the request was completed and the response returned." }, "userId": { "type": "string", "description": "The unique identifier of the user or system that initiated the request." } } }, "example": { "result": { "statusCode": 200, "message": "OK", "data": [ { "termDefinition": { "termDefinitionId": "{{guid}}", "name": "{{termTitle}}", "code": "{{termVersionCode}}", "text": "{{termText}}" } } ] }, "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}", "userId": "{{userId}}" } } } } } } }, "/clickwrap/consents/create": { "post": { "tags": [ "Consents" ], "summary": "Consent Create ", "description": "This endpoint creates a consent object and initiates a session to capture user agreement to specific terms or conditions (e.g., terms of service, privacy policies). The consent object is used to store both session-related metadata and consent details. This endpoint is important because it generates a unique session ID which is used to edit and link the consent to the user’s interaction in [consent edit](https://apim-mavenheadless-dev-westeu.developer.azure-api.net/api-details#api=clickwrap&operation=edit-consent) request, ensuring continuity and security.", "operationId": "create-consent", "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "consent" ], "type": "object", "properties": { "externalContext": { "type": "string", "description": "External reference ID used for contextual tracking." }, "consent": { "required": [ "termDefinitionId" ], "type": "object", "properties": { "termDefinitionId": { "type": "string", "description": "The unique ID of the term definition being presented for user consent." } } } } }, "example": { "externalContext": "12345", "consent": { "termDefinitionId": "{{termDefinitionId}}" } } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "required": [ "result", "origin", "dateTime", "userId" ], "type": "object", "properties": { "result": { "required": [ "statusCode", "message", "data" ], "type": "object", "properties": { "statusCode": { "type": "integer", "description": "HTTP status code indicating the result of the operation." }, "message": { "type": "string", "description": "Confirmation message for the operation." }, "data": { "type": "array", "items": { "required": [ "consent", "termDefinition" ], "type": "object", "properties": { "consent": { "required": [ "sessionId", "sessionStartDatetime", "sessionExpirationDatetime" ], "type": "object", "properties": { "sessionId": { "type": "string", "description": "Unique identifier for the created consent session." }, "sessionStartDatetime": { "type": "string", "description": "Timestamp indicating when the session started.", "format": "date-time" }, "sessionExpirationDatetime": { "type": "string", "description": "Timestamp indicating when the session expires.", "format": "date-time" } } }, "termDefinition": { "required": [ "text" ], "type": "object", "properties": { "text": { "type": "string", "description": "The term definition text shown to the user." } } } } } } } }, "externalContext": { "type": "string", "description": "External reference ID used for contextual tracking." }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the request." }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the request was completed and the response returned." }, "userId": { "type": "string", "description": "The unique identifier of the user or system that initiated the request." } } }, "example": { "result": { "statusCode": 201, "message": "Created", "data": [ { "consent": { "sessionId": "{{sessionId}}", "sessionStartDatetime": "{{sessionStartDatetime}}", "sessionExpirationDatetime": "{{sessionExpirationDatetime}}" }, "termDefinition": { "text": "{{termText}}" } } ] }, "externalContext": "{{externalContextId}}", "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}", "userId": "{{userId}}" } } } } } } }, "/clickwrap/consents/{sessionId}/edit": { "put": { "tags": [ "Consents" ], "summary": "Consent Edit ", "description": "This endpoint is used to update consent details identified by the provided sessionId from [consent create](https://apim-mavenheadless-dev-westeu.developer.azure-api.net/api-details#api=clickwrap&operation=create-consent) response, such as marking the consent as accepted after the user agrees to the terms, or modifying other consent attributes. The sessionId links the update to the specific session, ensuring secure and accurate tracking of the user’s consent interaction. Unlike typical update operations, this one requires the client to resend the Term Definition Text that was originally shown to the end-user to ensure consistency, preventing discrepancies or fraud.", "operationId": "edit-consent", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "enum": [ "" ] } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "externalContext", "consent", "termDefinition" ], "type": "object", "properties": { "externalContext": { "type": "string", "description": "External reference ID used for contextual tracking." }, "consent": { "required": [ "environmentData", "externalUserId", "accepted" ], "type": "object", "properties": { "environmentData": { "type": "string", "description": "Describes the user's environment at the time of the consent (e.g., OS, browser, screen resolution, user agent)." }, "additionalData": { "type": "string", "description": " Any custom metadata you wish to associate with the consent." }, "externalUserId": { "type": "string", "description": "External identifier for the user giving consent (e.g., an email address or user ID)." }, "accepted": { "type": "boolean", "description": "Indicates whether the user accepted (`true`) or rejected (`false`) the terms." } } }, "termDefinition": { "required": [ "text" ], "type": "object", "properties": { "text": { "type": "string", "description": "The full content of the terms that were presented to the end-user. This should match the original definition for verification." } } } } }, "example": { "externalContext": "12345", "consent": { "environmentData": "{{environmentDescription}}", "additionalData": "{{customConsentMetadata}}", "externalUserId": "{{externalUserId}}", "accepted": "true //false" }, "termDefinition": { "text": "{{termText}}" } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "required": [ "result", "origin", "dateTime", "userId" ], "type": "object", "properties": { "result": { "required": [ "statusCode", "message" ], "type": "object", "properties": { "statusCode": { "type": "integer", "description": "HTTP status code indicating the result of the operation." }, "message": { "type": "string", "description": "Confirmation message for the operation." } } }, "externalContext": { "type": "string", "description": "External reference ID used for contextual tracking." }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the request." }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the request was completed and the response returned." }, "userId": { "type": "string", "description": "The unique identifier of the user or system that initiated the request." } } }, "example": { "result": { "statusCode": 200, "message": "OK" }, "externalContext": "{{externalContextId}}", "origin": "{{originEnvironment}}", "dateTime": "{{responseTimestamp}}", "userId": "{{userId}}" } } } } } } }, "/clickwrap/consents/list": { "get": { "tags": [ "Consents" ], "summary": "Consent List ", "description": "This endpoint retrieves a list of consents associated with the requesting user or system.\nThis endpoint returns detailed information about each consent session, including timestamps, user environment data, acceptance status, and related term definitions.", "operationId": "list-consents", "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "required": [ "result", "origin", "dateTime", "userId" ], "type": "object", "properties": { "result": { "required": [ "statusCode", "message", "data" ], "type": "object", "properties": { "statusCode": { "type": "integer", "description": "HTTP status code indicating the result of the operation." }, "message": { "type": "string", "description": "Descriptive message confirming the result of the request." }, "data": { "type": "array", "items": { "required": [ "consent" ], "type": "object", "properties": { "consent": { "required": [ "ipAddress", "termDefinitionId", "sessionId", "sessionStartDatetime", "sessionExpirationDatetime", "environmentData", "additionalData", "externalUserId", "accepted", "acceptedDatetime" ], "type": "object", "properties": { "ipAddress": { "type": "string", "description": "IP address of the user who provided the consent." }, "termDefinitionId": { "type": "string", "description": "ID of the term definition agreed to." }, "sessionId": { "type": "string", "description": "Unique identifier for the consent session." }, "sessionStartDatetime": { "type": "string", "description": "Timestamp when the consent session started.", "format": "date-time" }, "sessionExpirationDatetime": { "type": "string", "description": "Timestamp when the consent session expires.", "format": "date-time" }, "environmentData": { "type": "string", "description": "Information about the user's environment (OS, browser, screen size, user agent, etc.)." }, "additionalData": { "type": "string", "description": "Any additional custom data stored with the consent." }, "externalUserId": { "type": "string", "description": "Identifier for the end user, e.g., email or user ID." }, "accepted": { "type": "boolean", "description": "Whether the consent was accepted (`true`) or rejected (`false`)." }, "acceptedDatetime": { "type": "string", "description": "Timestamp when the consent was accepted.", "format": "date-time" } } } } } } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the request." }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the request was completed and the response returned." }, "userId": { "type": "string", "description": "The unique identifier of the user or system that initiated the request." } } }, "example": "{\n \"result\": {\n \"statusCode\": 200,\n \"message\": \"OK\",\n \"data\": [\n {\n \"consent\": {\n \"ipAddress\": \"{{userIpAddress}}\",\n \"termDefinitionId\": \"{{termDefinitionId}}\",\n \"sessionId\": \"{{sessionId}}\",\n \"sessionStartDatetime\": \"{{sessionStartDatetime}}\",\n \"sessionExpirationDatetime\": \"{{sessionExpirationDatetime}}\",\n \"environmentData\": \"{{environmentDescription}}\",\n \"additionalData\": \"{{customConsentMetadata}}\",\n \"externalUserId\": \"{{externalUserIdentifier}}\",\n \"accepted\": true, //false\n \"acceptedDatetime\": \"{{acceptedTimestamp}}\"\n }\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\",\n \"userId\": \"{{userId}}\"\n}" } } } } } }, "/clickwrap/consents/{sessionId}/get": { "get": { "tags": [ "Consents" ], "summary": "Consent Get", "description": "This endpoint retrieves the details of a specific consent using the provided session Id. This includes information such as the session metadata (start and expiration times), consent status (accepted or not), external user identifier, and any associated data like environment or custom metadata.", "operationId": "consent-get", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "enum": [ "" ] } }, { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string", "default": "Bearer {{authToken}}" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string", "default": "{{apiKey}}" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "required": [ "result", "origin", "dateTime", "userId" ], "type": "object", "properties": { "result": { "required": [ "statusCode", "message", "data" ], "type": "object", "properties": { "statusCode": { "type": "integer", "description": "HTTP status code indicating the result of the operation." }, "message": { "type": "string", "description": "Descriptive message confirming the result of the request." }, "data": { "type": "array", "items": { "required": [ "consent" ], "type": "object", "properties": { "consent": { "required": [ "ipAddress", "termDefinitionId", "sessionId", "sessionStartDatetime", "sessionExpirationDatetime", "environmentData", "additionalData", "externalUserId", "accepted", "acceptedDatetime" ], "type": "object", "properties": { "ipAddress": { "type": "string", "description": "IP address of the user who provided the consent." }, "termDefinitionId": { "type": "string", "description": "ID of the term definition agreed to." }, "sessionId": { "type": "string", "description": "Unique identifier for the consent session." }, "sessionStartDatetime": { "type": "string", "description": "Timestamp when the consent session started.", "format": "date-time" }, "sessionExpirationDatetime": { "type": "string", "description": "Timestamp when the consent session expires.", "format": "date-time" }, "environmentData": { "type": "string", "description": "Information about the user's environment (OS, browser, screen size, user agent, etc.)." }, "additionalData": { "type": "string", "description": "Any additional custom data stored with the consent." }, "externalUserId": { "type": "string", "description": "Identifier for the end user, e.g., email or user ID." }, "accepted": { "type": "boolean", "description": "Whether the consent was accepted (`true`) or rejected (`false`)." }, "acceptedDatetime": { "type": "string", "description": "Timestamp when the consent was accepted.", "format": "date-time" } } } } } } } }, "origin": { "type": "string", "description": "The HTTP method and endpoint URL that initiated the request." }, "dateTime": { "type": "string", "description": "The exact UTC timestamp when the request was completed and the response returned." }, "userId": { "type": "string", "description": "The unique identifier of the user or system that initiated the request." } } }, "example": "{\n \"result\": {\n \"statusCode\": 200,\n \"message\": \"OK\",\n \"data\": [\n {\n \"consent\": {\n \"ipAddress\": \"{{userIpAddress}}\",\n \"termDefinitionId\": \"{{termDefinitionId}}\",\n \"sessionId\": \"{{sessionId}}\",\n \"sessionStartDatetime\": \"{{sessionStartDatetime}}\",\n \"sessionExpirationDatetime\": \"{{sessionExpirationDatetime}}\",\n \"environmentData\": \"{{environmentDescription}}\",\n \"additionalData\": \"{{customConsentMetadata}}\",\n \"externalUserId\": \"{{externalUserIdentifier}}\",\n \"accepted\": true, //false\n \"acceptedDatetime\": \"{{acceptedTimestamp}}\"\n }\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\",\n \"userId\": \"{{userId}}\"\n}" } } } } } }, "/common/locale/{folder}/{fileName}": { "get": { "tags": [ "Locale" ], "summary": "Locale Get", "description": "Locale Get", "operationId": "get-locale", "parameters": [ { "name": "folder", "in": "path", "required": true, "schema": {} }, { "name": "fileName", "in": "path", "required": true, "schema": {} } ], "responses": { "200": { "description": "" } } } }, "/common/locale/{folder}/{subfolder}/{fileName}": { "get": { "tags": [ "Locale" ], "summary": "Locale Get Subfolder", "description": "Locale Get Subfolder", "operationId": "get-locale-subfolder", "parameters": [ { "name": "folder", "in": "path", "required": true, "schema": {} }, { "name": "subfolder", "in": "path", "required": true, "schema": {} }, { "name": "fileName", "in": "path", "required": true, "schema": {} } ], "responses": { "200": { "description": "" } } } }, "/common/locale/{folder}/{subfolder}/{lang}/{fileName}": { "get": { "tags": [ "Locale" ], "summary": "Locale Get Language Subfolder", "description": "Locale Get Language Subfolder", "operationId": "get-locale-lang", "parameters": [ { "name": "folder", "in": "path", "required": true, "schema": {} }, { "name": "subfolder", "in": "path", "required": true, "schema": {} }, { "name": "lang", "in": "path", "required": true, "schema": {} }, { "name": "fileName", "in": "path", "required": true, "schema": {} } ], "responses": { "200": { "description": "" } } } }, "/common/session": { "get": { "tags": [ "Session" ], "summary": "Session Get", "description": "Session Get", "operationId": "get-session", "responses": { "200": { "description": "" } } } }, "/common/session/{sessionId}": { "get": { "tags": [ "Session" ], "summary": "Session Get by SessionId", "description": "Session Get by SessionId", "operationId": "get-session-sessionId", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": {} } ], "responses": { "200": { "description": "" } } } }, "/common/status": { "get": { "tags": [ "Status" ], "summary": "Status Get", "description": "Status Get", "operationId": "status", "responses": { "200": { "description": "" } } } }, "/common/token/{provider}": { "get": { "tags": [ "Token" ], "summary": "Token Get", "description": "Token Get", "operationId": "token-get", "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": {} } ], "responses": { "200": { "description": "" } } }, "post": { "tags": [ "Token" ], "summary": "Token Post", "description": "Token Post", "operationId": "token-post", "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": {} } ], "responses": { "200": { "description": "" } } } }, "/common/service/token": { "post": { "tags": [ "Service" ], "summary": "Service Token Post", "description": "Service Token Post", "operationId": "service-token-post", "responses": { "200": { "description": "" } } } }, "/common/user/get": { "get": { "tags": [ "User" ], "summary": "User Get", "description": "User Get", "operationId": "user-get", "responses": { "200": { "description": "" } } } }, "/common/settings/get": { "get": { "tags": [ "Settings" ], "summary": "Settings Get", "description": "Settings Get", "operationId": "settings-get", "responses": { "200": { "description": "" } } } }, "/common/settings/update": { "put": { "tags": [ "Settings" ], "summary": "Settings Update", "description": "Settings Update", "operationId": "settings-update", "responses": { "200": { "description": "" } } } }, "/common/user/contact/{userContactId}/get": { "get": { "tags": [ "User" ], "summary": "User Contact Get", "description": "User Contact Get", "operationId": "user-contact-get", "parameters": [ { "name": "userContactId", "in": "path", "required": true, "schema": {} } ], "responses": { "200": { "description": "" } } } }, "/common/user/contact/list": { "get": { "tags": [ "User" ], "summary": "User Contact List", "description": "User Contact List", "operationId": "user-contact-list", "responses": { "200": { "description": "" } } } }, "/common/user/contact/create": { "post": { "tags": [ "User" ], "summary": "User Contact Create", "description": "User Contact Create", "operationId": "user-contact-create", "responses": { "200": { "description": "" } } } }, "/common/user/contact/{userContactId}/update": { "put": { "tags": [ "User" ], "summary": "User Contact Update", "description": "User Contact Update", "operationId": "user-contact-update", "parameters": [ { "name": "userContactId", "in": "path", "required": true, "schema": {} } ], "responses": { "200": { "description": "" } } } }, "/common/user/contact/{userContactId}/delete": { "delete": { "tags": [ "User" ], "summary": "User Contact Delete", "description": "User Contact Delete", "operationId": "user-contact-delete", "parameters": [ { "name": "userContactId", "in": "path", "required": true, "schema": {} } ], "responses": { "200": { "description": "" } } } }, "/common/summary": { "get": { "summary": "Summary", "operationId": "summary", "responses": { "200": { "description": "" } } } }, "/content/{fileName}": { "get": { "summary": "Static Content Get", "description": "Static Content Get", "operationId": "static-content-get", "parameters": [ { "name": "fileName", "in": "path", "required": true, "schema": {} } ], "responses": { "200": { "description": "" } } } }, "/content/{folder}/{fileName}": { "get": { "summary": "Static Content Get by Folder", "operationId": "static-content-get-by-folder", "parameters": [ { "name": "folder", "in": "path", "required": true, "schema": {} }, { "name": "fileName", "in": "path", "required": true, "schema": {} } ], "responses": { "200": { "description": "" } } } }, "/drive/action": { "post": { "summary": "Drive Action", "description": "This endpoint functions as a secure, general-purpose proxy to third-party services.\n\nIt's designed to receive a request from a client that specifies the httpAction (e.g., GET, POST), the full targetUrl of an external API, and an optional request body. The proxy's primary role is to securely handle authentication with the target service by injecting the necessary API keys or tokens on the server side.\n\nAfter authenticating, it forwards the request to the targetUrl and relays the response from the third-party API directly back to the client. This is why we didn't provide any response example, since they are platform and request specific. This simplifies client applications by providing a single point of interaction and centralizing the management of sensitive credentials.", "operationId": "drive-action", "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.", "required": true, "schema": { "enum": [ "Bearer {{authToken}}" ], "type": "string" } }, { "name": "X-Subscription-Key", "in": "header", "description": "Unique API key used to identify and authorize access to a specific environment", "required": true, "schema": { "enum": [ "{{apiKey}}" ], "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "required": [ "httpAction", "targetUrl" ], "type": "object", "properties": { "httpAction": { "type": "string", "description": "Http action" }, "targetUrl": { "type": "string", "description": "Full target drive URL" }, "body": { "type": "string", "description": "Action body" } } }, "example": { "httpAction": "GET", "targetUrl": "https://graph.microsoft.com/v1.0/me/drive/root/children?$select=id,name", "body": "" } } } }, "responses": { "200": { "description": "" } } } }, "/platform/callback": { "get": { "tags": [ "Callback" ], "summary": "Auth Callback", "description": "Auth Callback", "operationId": "auth-callback", "responses": { "200": { "description": "" } } } }, "/platform/auth/{provider}": { "get": { "tags": [ "Auth" ], "summary": "Auth Proxy", "description": "Auth Proxy", "operationId": "auth-proxy-get", "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": {} } ], "responses": { "200": { "description": "" } } }, "post": { "tags": [ "Auth" ], "summary": "Auth Proxy", "description": "Auth Proxy", "operationId": "auth-proxy-post", "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": {} } ], "responses": { "200": { "description": "" } } } }, "/platform/reply": { "get": { "tags": [ "Reply" ], "summary": "Auth Reply", "description": "Auth Reply", "operationId": "auth-reply", "responses": { "200": { "description": "" } } } }, "/platform/subscription/{subscriptionId}/get": { "get": { "tags": [ "Subscription" ], "summary": "Subscription Get", "description": "Subscription Get", "operationId": "subscription-get", "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "schema": {} } ], "responses": { "200": { "description": "" } } } }, "/platform/subscription/list": { "get": { "tags": [ "Subscription" ], "summary": "Subscription List", "description": "Subscription List", "operationId": "subscription-list", "responses": { "200": { "description": "" } } } }, "/platform/subscription/resolve": { "post": { "tags": [ "Subscription" ], "summary": "Subscription Resolve", "description": "Subscription Resolve", "operationId": "subscription-resolve", "responses": { "200": { "description": "" } } } }, "/platform/subscription/webhook": { "post": { "tags": [ "Subscription" ], "summary": "Subscription Webhook", "description": "Subscription Webhook", "operationId": "subscription-webhook", "responses": { "200": { "description": "" } } } }, "/platform/subscription/{subscriptionId}/activate": { "post": { "tags": [ "Subscription" ], "summary": "Subscription Activate", "description": "Subscription Activate", "operationId": "subscription-activate", "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "schema": {} } ], "responses": { "200": { "description": "" } } } }, "/platform/subscription/{subscriptionId}/cancel": { "post": { "tags": [ "Subscription" ], "summary": "Subscription Cancel", "description": "Subscription Cancel", "operationId": "subscription-cancel", "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "schema": {} } ], "responses": { "200": { "description": "" } } } }, "/platform/subscription/trial/start": { "post": { "summary": "Subscription Trial Start", "operationId": "subscription-trial-start", "responses": { "200": { "description": "" } } } }, "/platform/subscription/{subscriptionId}/audit/list": { "get": { "summary": "Subscription Audit List", "operationId": "subscription-audit-list", "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "schema": {} } ], "responses": { "200": { "description": "" } } } }, "/platform/subscription/{subscriptionId}/user/list": { "get": { "summary": "Subscription User List", "operationId": "subscription-user-list", "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "schema": {} } ], "responses": { "200": { "description": "" } } } }, "/platform/subscription/{subscriptionId}/user/create": { "post": { "summary": "Subscription User Create", "operationId": "subscription-user-create", "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "schema": {} } ], "responses": { "200": { "description": "" } } } }, "/platform/subscription/{subscriptionId}/user/{userId}/update": { "put": { "summary": "Subscription User Update", "operationId": "subscription-user-update", "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "schema": {} }, { "name": "userId", "in": "path", "required": true, "schema": {} } ], "responses": { "200": { "description": "" } } } }, "/platform/subscription/{subscriptionId}/metering/list": { "get": { "summary": "Subscription Metering List", "operationId": "subscription-metering-list", "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "schema": {} } ], "responses": { "200": { "description": "" } } } }, "/platform/subscription/{subscriptionId}/billing/list": { "get": { "summary": "Subscription Billing List", "operationId": "subscription-billing-list", "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "schema": {} } ], "responses": { "200": { "description": "" } } } }, "/platform/subscription/{subscriptionId}/user/{userId}/assign": { "post": { "summary": "Subscription User Assign", "operationId": "subscription-user-assign", "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "schema": {} }, { "name": "userId", "in": "path", "required": true, "schema": {} } ], "responses": { "200": { "description": "" } } } }, "/platform/subscription/{subscriptionId}/user/{userId}/unassign": { "delete": { "summary": "Subscription User Unassign", "operationId": "subscription-user-unassign", "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "schema": {} }, { "name": "userId", "in": "path", "required": true, "schema": {} } ], "responses": { "200": { "description": "" } } } }, "/platform/auth/{provider}/token/revoke": { "post": { "summary": "Auth Revoke", "operationId": "session-revoke", "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": {} } ], "responses": { "200": { "description": "" } } } }, "/platform/auth/{provider}/token/refresh": { "post": { "summary": "Auth Refresh", "operationId": "auth-refresh", "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": {} } ], "responses": { "200": { "description": "" } } } }, "/platform/auth/{provider}/authorize": { "get": { "summary": "Authorization Proxy", "operationId": "authorization-proxy", "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": {} } ], "responses": { "200": { "description": "" } } } }, "/platform/auth/{provider}/token": { "post": { "summary": "Token Proxy", "operationId": "token-proxy", "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": {} } ], "responses": { "200": { "description": "" } } } }, "/platform/lead/create": { "post": { "summary": "Lead Create", "operationId": "lead-create", "responses": { "200": { "description": "" } } } }, "/proxy/auth/{provider}": { "get": { "summary": "Auth Proxy", "description": "Auth Proxy", "operationId": "auth-proxy", "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": {} } ], "responses": { "200": { "description": "" } } }, "post": { "summary": "Auth Proxy", "description": "Auth Proxy", "operationId": "auth-proxy-post", "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": {} } ], "responses": { "200": { "description": "" } } } }, "/proxy/reply": { "get": { "summary": "Reply Proxy", "description": "Reply Proxy", "operationId": "auth-reply", "responses": { "200": { "description": "" } } } }, "/proxy/callback": { "get": { "summary": "Auth Callback", "description": "Auth Callback", "operationId": "auth-callback", "responses": { "200": { "description": "" } } } }, "/tools/barcode/generate": { "get": { "summary": "Barcode Generate ", "description": "Barcode Generate ", "operationId": "generate-barcode", "responses": { "200": { "description": "" } } } }, "/tools/encrypt": { "get": { "summary": "Encrypt", "description": "Enrypts the query input query parameter using Aes.", "operationId": "encrypt", "parameters": [ { "name": "input", "in": "query", "description": "The input sting to be encrypted", "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Schema: Bearer JWT Token", "schema": { "enum": [ "Bearer {{token}}" ], "type": "string" } } ], "responses": { "200": { "description": "" } } } } }, "components": { "schemas": { "DataSourceModel": { "type": "object", "properties": { "dataSourceGuid": { "type": "string", "format": "uuid", "nullable": true }, "subscriptionGuid": { "type": "string", "format": "uuid", "nullable": true }, "ownerGuid": { "type": "string", "format": "uuid", "nullable": true }, "lastModifiedUserGuid": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "urn": { "type": "string", "nullable": true }, "query": { "type": "string", "nullable": true }, "variables": { "type": "string", "nullable": true }, "loadMethod": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "lastModifiedDate": { "type": "string", "format": "date-time" }, "isDeleted": { "type": "boolean" } } }, "DocumentModel": { "type": "object", "properties": { "documentGuid": { "type": "string", "format": "uuid" }, "subscriptionGuid": { "type": "string", "format": "uuid" }, "ownerGuid": { "type": "string", "format": "uuid" }, "lastModifiedUserGuid": { "type": "string", "format": "uuid" }, "title": { "type": "string", "nullable": true }, "urn": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "path": { "type": "string", "nullable": true }, "fileFormat": { "type": "string", "nullable": true }, "deliveryMethod": { "type": "string", "nullable": true }, "viewAnonymousLink": { "type": "string", "nullable": true }, "editAnonymousLink": { "type": "string", "nullable": true }, "viewUserLink": { "type": "string", "nullable": true }, "editUserLink": { "type": "string", "nullable": true }, "viewOrganizationLink": { "type": "string", "nullable": true }, "editOrganizationLink": { "type": "string", "nullable": true }, "succeededViewUserEmailList": { "type": "string", "nullable": true }, "succeededEditUserEmailList": { "type": "string", "nullable": true }, "failedViewUserEmailList": { "type": "string", "nullable": true }, "failedEditUserEmailList": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "lastModifiedDate": { "type": "string", "format": "date-time" }, "isDeleted": { "type": "boolean" } } }, "DocumentRequestModel": { "type": "object", "properties": { "documentRequestGuid": { "type": "string", "format": "uuid" }, "subscriptionGuid": { "type": "string", "format": "uuid" }, "documentTemplateGuid": { "type": "string", "format": "uuid" }, "dataGuid": { "type": "string", "format": "uuid" }, "documentGuid": { "type": "string", "format": "uuid", "nullable": true }, "documentSolutionConfigurationGuid": { "type": "string", "format": "uuid", "nullable": true }, "ownerGuid": { "type": "string", "format": "uuid" }, "lastModifiedUserGuid": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "embeddedData": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "fileFormat": { "type": "string", "nullable": true }, "processingType": { "type": "string", "nullable": true }, "deliveryMethod": { "type": "string", "nullable": true }, "path": { "type": "string", "nullable": true }, "pdfConformanceLevel": { "type": "string", "nullable": true }, "pdfVersion": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "locale": { "type": "string", "nullable": true }, "timeZone": { "type": "string", "nullable": true }, "viewAnonymous": { "type": "boolean" }, "editAnonymous": { "type": "boolean" }, "viewOrganization": { "type": "boolean" }, "editOrganization": { "type": "boolean" }, "viewUser": { "type": "boolean" }, "editUser": { "type": "boolean" }, "viewUserEmailList": { "type": "string", "nullable": true }, "editUserEmailList": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "completedDate": { "type": "string", "format": "date-time", "nullable": true }, "lastModifiedDate": { "type": "string", "format": "date-time", "nullable": true }, "isDeleted": { "type": "boolean" } } }, "DocumentSolutionConfigurationModel": { "type": "object", "properties": { "documentSolutionConfigurationGuid": { "type": "string", "format": "uuid" }, "documentSolutionGuid": { "type": "string", "format": "uuid" }, "subscriptionGuid": { "type": "string", "format": "uuid" }, "ownerGuid": { "type": "string", "format": "uuid" }, "lastModifiedUserGuid": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "fileFormat": { "type": "string", "nullable": true }, "processingType": { "type": "string", "nullable": true }, "deliveryMethod": { "type": "string", "nullable": true }, "path": { "type": "string", "nullable": true }, "pdfConformanceLevel": { "type": "string", "nullable": true }, "pdfVersion": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "locale": { "type": "string", "nullable": true }, "timeZone": { "type": "string", "nullable": true }, "embeddedData": { "type": "string", "nullable": true }, "viewAnonymous": { "type": "boolean" }, "editAnonymous": { "type": "boolean" }, "viewOrganization": { "type": "boolean" }, "editOrganization": { "type": "boolean" }, "viewUser": { "type": "boolean" }, "editUser": { "type": "boolean" }, "viewUserEmailList": { "type": "string", "nullable": true }, "editUserEmailList": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "lastModifiedDate": { "type": "string", "format": "date-time" }, "isDeleted": { "type": "boolean" } } }, "DocumentSolutionModel": { "type": "object", "properties": { "documentSolutionGuid": { "type": "string", "format": "uuid", "nullable": true }, "subscriptionGuid": { "type": "string", "format": "uuid", "nullable": true }, "ownerGuid": { "type": "string", "format": "uuid", "nullable": true }, "lastModifiedUserGuid": { "type": "string", "format": "uuid", "nullable": true }, "dataGuid": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "lastModifiedDate": { "type": "string", "format": "date-time" }, "isDeleted": { "type": "boolean" } } }, "DocumentTemplateModel": { "type": "object", "properties": { "documentTemplateGuid": { "type": "string", "format": "uuid" }, "subscriptionGuid": { "type": "string", "format": "uuid" }, "ownerGuid": { "type": "string", "format": "uuid" }, "lastModifiedUserGuid": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "urn": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "viewAnonymousLink": { "type": "string", "nullable": true }, "editAnonymousLink": { "type": "string", "nullable": true }, "viewUserLink": { "type": "string", "nullable": true }, "editUserLink": { "type": "string", "nullable": true }, "viewOrganizationLink": { "type": "string", "nullable": true }, "editOrganizationLink": { "type": "string", "nullable": true }, "fileFormat": { "type": "string", "nullable": true }, "loadMethod": { "type": "string", "nullable": true }, "path": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "lastModifiedDate": { "type": "string", "format": "date-time" }, "isDeleted": { "type": "boolean" } } }, "OptionValueModel": { "type": "object", "properties": { "optionValueGuid": { "type": "string", "format": "uuid" }, "entityType": { "type": "string", "nullable": true }, "entityId": { "type": "string", "format": "uuid" }, "optionDefinitionId": { "type": "integer", "nullable": true }, "customKey": { "type": "string", "nullable": true }, "customGroup": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "effectiveKey": { "type": "string", "nullable": true }, "effectiveGroup": { "type": "string", "nullable": true }, "systemType": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "lastModifiedDate": { "type": "string", "format": "date-time" } } }, "EnvelopeTemplateEditDTO": { "required": [ "template" ], "type": "object", "properties": { "template": { "type": "object", "properties": { "folderId": { "type": "string", "description": "The GUID of the target folder. If provided as null, the template will be removed from any existing folder.", "format": "uuid", "nullable": true } } }, "externalContext": { "type": "object", "description": "External reference object used for contextual tracking." } } }, "EnvelopeTemplateEditInfoDTO": { "type": "object", "properties": { "folderId": { "type": "string", "description": "The GUID of the target folder. If provided as null, the template will be removed from any existing folder.", "format": "uuid", "nullable": true } } }, "FolderModel": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The internal database identifier for the folder.", "example": 1 }, "FolderGuid": { "type": "string", "description": "The globally unique identifier for the folder.", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "SubscriptionUserId": { "type": "integer", "description": "The ID of the subscription user who owns or created the folder.", "example": 105 }, "Name": { "type": "string", "description": "The display name of the folder.", "example": "Q3 Financial Contracts" }, "NamespaceId": { "type": "integer", "description": "The namespace or tenant context the folder belongs to.", "example": 12 } }, "description": "Represents a folder entity used to organize documents and envelopes." }, "Document-documentId-comment-Post201ApplicationJsonResponse": { "type": "object", "properties": { "result": { "type": "object", "properties": { "statusCode": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "comments": { "type": "object", "properties": { "629d2b7e-378f-88e-4e5646764c4d": { "type": "array", "items": { "required": [ "id", "commentGuid", "documentId", "signerId", "parentCommentId", "parentCommentGuid", "content", "pageNumber", "positionX", "positionY", "visibleTo", "createdAt", "authorName", "authorEmail", "documentGuid" ], "type": "object", "properties": { "id": { "type": "integer" }, "commentGuid": { "type": "string" }, "documentId": { "type": "integer" }, "signerId": { "type": "integer" }, "parentCommentId": {}, "parentCommentGuid": {}, "content": { "type": "string" }, "pageNumber": { "type": "integer" }, "positionX": { "type": "number" }, "positionY": { "type": "number" }, "visibleTo": { "type": "string" }, "createdAt": { "type": "string" }, "authorName": { "type": "string" }, "authorEmail": { "type": "string" }, "documentGuid": { "type": "string" } } } } } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" }, "userId": { "type": "string" } } }, "Document-documentId-comment-Post400ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "string" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage", "urn" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" }, "urn": { "type": "string" } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" } } }, "Document-documentId-download-Get404ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "string" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" } } }, "Document-documentId-get-Get404ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "integer" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" } } }, "Document-documentId-get-Get400ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "integer" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" } } } }, "externalErrors": { "type": "array" } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" }, "userId": { "type": "string" }, "operationId": { "type": "string" } } }, "Document-documentURL-retrieve-Get400ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "string" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage", "urn" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" }, "urn": { "type": "string" } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" } } }, "Document-upload-Post400ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "integer" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" } } } }, "externalErrors": { "type": "array" } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" }, "operationId": { "type": "string" } } }, "Envelope-accept-Get400ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "string" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage", "urn" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" }, "urn": { "type": "string" } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" } } }, "Envelope-envelopeId-attachment-attachmentId-download-Get400ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "string" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage", "urn" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" }, "urn": { "type": "string" } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" } } }, "Envelope-envelopeId-attachment-attachmentId-download-Get404ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "string" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" } } }, "Envelope-envelopeId-attachment-upload-Post400ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "string" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage", "urn" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" }, "urn": { "type": "string" } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" } } }, "Envelope-envelopeId-audit-download-Get400ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "string" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage", "urn" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" }, "urn": { "type": "string" } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" } } }, "Envelope-envelopeId-audit-download-Get404ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "string" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" } } }, "Envelope-envelopeId-audit-get-Get400ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "string" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage", "urn" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" }, "urn": { "type": "string" } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" } } }, "Envelope-envelopeId-audit-get-Get404ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "string" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" } } }, "Envelope-envelopeId-cancel-Get400ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "string" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage", "urn" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" }, "urn": { "type": "string" } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" } } }, "Envelope-envelopeId-cancel-Get404ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "string" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" } } }, "Envelope-check-Get200ApplicationJsonResponse": { "type": "object", "properties": { "result": { "type": "object", "properties": { "statusCode": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "envelope": { "type": "object", "properties": { "id": { "type": "string" }, "uploadDate": { "type": "string" }, "status": { "type": "string" } } }, "recipient": { "type": "object", "properties": { "id": { "type": "string" }, "role": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "status": { "type": "string" }, "isTokenExpired": { "type": "boolean" }, "legalAccepted": { "type": "boolean" }, "isMfaEnabled": { "type": "boolean" }, "isMfaValid": { "type": "boolean" }, "hostEmail": { "type": "string" } } }, "settings": { "type": "array", "items": { "required": [ "settingKey", "label", "type", "application", "category", "subCategory", "value", "isAnonymousSetting", "preserve" ], "type": "object", "properties": { "settingKey": { "type": "string" }, "label": { "type": "string" }, "type": { "type": "string" }, "application": { "type": "string" }, "category": { "type": "string" }, "subCategory": { "type": "string" }, "value": { "type": "string" }, "isAnonymousSetting": { "type": "boolean" }, "preserve": { "type": "boolean" } } } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" } } }, "Envelope-check-Get400ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "string" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage", "urn" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" }, "urn": { "type": "string" } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" } } }, "Envelope-create-Post400ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "integer" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" } } } }, "externalErrors": { "type": "array" } } }, "externalContext": { "type": "object", "properties": { "test1": { "type": "string" } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" }, "userId": { "type": "string" }, "operationId": { "type": "string" } } }, "Envelope-create-Post500ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "integer" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" } } } }, "externalErrors": { "type": "array" } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" }, "operationId": { "type": "string" } } }, "Template-templateId-envelope-create-Post201ApplicationJsonResponse": { "type": "object", "properties": { "result": { "type": "object", "properties": { "statusCode": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "envelope": { "type": "object", "properties": { "id": { "type": "string" }, "uploadDate": { "type": "string" }, "status": { "type": "string" } } }, "documents": { "type": "array", "items": { "required": [ "id", "externalContext" ], "type": "object", "properties": { "id": { "type": "string" }, "externalContext": {} } } }, "recipients": { "type": "array", "items": { "required": [ "id", "externalContext" ], "type": "object", "properties": { "id": { "type": "string" }, "externalContext": {} } } }, "signGroups": { "type": "array" }, "fields": { "type": "array", "items": { "required": [ "id", "recipientId", "signGroupId", "documentId" ], "type": "object", "properties": { "id": { "type": "string" }, "recipientId": { "type": "string" }, "signGroupId": { "type": "string" }, "documentId": { "type": "string" } } } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" }, "userId": { "type": "string" } } }, "Template-templateId-envelope-create-Post400ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "integer" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" } } } }, "externalErrors": { "type": "array" } } }, "externalContext": { "type": "object", "properties": { "test1": { "type": "string" } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" }, "userId": { "type": "string" }, "operationId": { "type": "string" } } }, "Template-templateId-envelope-create-Post500ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "integer" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" } } } }, "externalErrors": { "type": "array" } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" }, "operationId": { "type": "string" } } }, "Envelope-decline-Post400ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "string" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage", "urn" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" }, "urn": { "type": "string" } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" } } }, "Envelope-envelopeId-document-documentId-download-Get400ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "string" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage", "urn" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" }, "urn": { "type": "string" } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" } } }, "Envelope-envelopeId-document-documentId-download-Get404ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "string" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" } } }, "Envelope-envelopeId-edit-Put400ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "integer" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" } } } }, "externalErrors": { "type": "array" } } }, "externalContext": { "type": "object", "properties": { "test1": { "type": "string" } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" }, "userId": { "type": "string" }, "operationId": { "type": "string" } } }, "Envelope-envelopeId-edit-Put404ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "string" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" } } }, "Envelope-list-Get400ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "string" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage", "urn" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" }, "urn": { "type": "string" } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" } } }, "Envelope-open-Get400ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "string" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage", "urn" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" }, "urn": { "type": "string" } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" } } }, "Envelope-reassign-Post200ApplicationJsonResponse": { "type": "object", "properties": { "result": { "type": "object", "properties": { "statusCode": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "envelope": { "type": "object", "properties": { "id": { "type": "string" }, "message": { "type": "string" } } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" } } }, "Envelope-reassign-Post400ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "string" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage", "urn" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" }, "urn": { "type": "string" } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" } } }, "Envelope-resend-Get400ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "string" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage", "urn" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" }, "urn": { "type": "string" } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" } } }, "Envelope-envelopeId-restore-Get400ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "integer" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" } } } }, "externalErrors": { "type": "array" } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" }, "userId": { "type": "string" }, "operationId": { "type": "string" } } }, "Envelope-envelopeId-restore-Get404ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "string" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" } } }, "Envelope-envelopeId-SendGet404ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "string" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" } } }, "Document-manage-Post400ApplicationJsonReponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "string" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage", "eventId" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" }, "eventId": { "type": "string" } } } }, "externalErrors": { "type": "array" } } }, "externalContext": { "type": "object", "properties": { "actionRequestId": { "type": "string" } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" }, "userId": { "type": "string" }, "operationId": { "type": "string" } } }, "Envelope-sign-Post400ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "string" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage", "urn" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" }, "urn": { "type": "string" } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" } } }, "Envelope-envelopeId-update-Put400ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "integer" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" } } } }, "externalErrors": { "type": "array" } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" }, "userId": { "type": "string" }, "operationId": { "type": "string" } } }, "Envelope-envelopeId-update-Put404ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "string" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" } } }, "Mfa-initiate-Post400ApplicationJsonResponse": { "type": "object", "properties": { "result": { "type": "object", "properties": { "statusCode": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "recipient": { "type": "object", "properties": { "method": { "type": "string" }, "destination": { "type": "object", "properties": { "phoneNumber": { "type": "string" }, "email": { "type": "string" } } }, "expiresAt": { "type": "string" }, "message": { "type": "string" } } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" } } }, "Mfa-initiate-Post200ApplicationJsonResponse": { "type": "object", "properties": { "result": { "type": "object", "properties": { "statusCode": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "recipient": { "type": "object", "properties": { "method": { "type": "string" }, "destination": { "type": "object", "properties": { "phoneNumber": { "type": "string" }, "email": { "type": "string" } } }, "expiresAt": { "type": "string" }, "message": { "type": "string" } } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" } } }, "Mfa-verify-Post200ApplicationJsonResponse": { "type": "object", "properties": { "result": { "type": "object", "properties": { "statusCode": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "recipient": { "type": "object", "properties": { "method": { "type": "string" }, "destination": { "type": "string" }, "message": { "type": "string" } } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" } } }, "Mfa-verify-Post400ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "integer" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" } } } }, "externalErrors": { "type": "array" } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" }, "operationId": { "type": "string" } } }, "Signature-create-Post400ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "string" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage", "urn" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" }, "urn": { "type": "string" } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" } } }, "Signature-signatureId-delete-Del400ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "string" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" } } } }, "externalErrors": { "type": "array" } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" }, "userId": { "type": "string" }, "operationId": { "type": "string" } } }, "Signature-signatureId-delete-Del404ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "string" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" } } }, "Signature-signatureId-get-Get400ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "string" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" } } } }, "externalErrors": { "type": "array" } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" }, "userId": { "type": "string" }, "operationId": { "type": "string" } } }, "Signature-signatureId-get-Get404ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "string" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" } } }, "Signature-list-Get400ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "string" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" } } } }, "externalErrors": { "type": "array" } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" }, "userId": { "type": "string" }, "operationId": { "type": "string" } } }, "Signature-list-Get404ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "string" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" } } }, "Signature-signatureId-update-Put400ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "string" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" } } } }, "externalErrors": { "type": "array" } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" }, "userId": { "type": "string" }, "operationId": { "type": "string" } } }, "Signature-signatureId-update-Put404ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "string" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" } } }, "Template-create-Post201ApplicationJsonResponse": { "type": "object", "properties": { "result": { "type": "object", "properties": { "statusCode": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "template": { "type": "object", "properties": { "id": { "type": "string" }, "uploadDate": { "type": "string" } } }, "documents": { "type": "array", "items": { "required": [ "id", "externalContext" ], "type": "object", "properties": { "id": { "type": "string" }, "externalContext": {} } } }, "recipients": { "type": "array", "items": { "required": [ "id", "externalContext" ], "type": "object", "properties": { "id": { "type": "string" }, "externalContext": {} } } }, "signGroups": { "type": "array" }, "fields": { "type": "array", "items": { "required": [ "id", "recipientId", "signGroupId", "documentId" ], "type": "object", "properties": { "id": { "type": "string" }, "recipientId": { "type": "string" }, "signGroupId": { "type": "string" }, "documentId": { "type": "string" } } } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" }, "userId": { "type": "string" } } }, "Template-create-Post400ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "integer" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" } } } }, "externalErrors": { "type": "array" } } }, "externalContext": { "type": "object", "properties": { "test1": { "type": "string" } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" }, "userId": { "type": "string" }, "operationId": { "type": "string" } } }, "Template-create-Post500ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "integer" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" } } } }, "externalErrors": { "type": "array" } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" }, "operationId": { "type": "string" } } }, "Template-templateId-delete-Del200ApplicationJsonResponse": { "type": "object", "properties": { "result": { "type": "object", "properties": { "statusCode": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "template": { "type": "object", "properties": { "id": { "type": "string" }, "message": { "type": "string" } } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" }, "userId": { "type": "string" } } }, "Template-templateId-delete-Del400ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "string" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" } } } }, "externalErrors": { "type": "array" } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" }, "userId": { "type": "string" }, "operationId": { "type": "string" } } }, "Template-templateId-delete-Del404ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "string" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" } } }, "Template-templateId-get-Get200ApplicationJsonResponse": { "type": "object", "properties": { "result": { "type": "object", "properties": { "statusCode": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "template": { "type": "object", "properties": { "id": { "type": "string" }, "createdBy": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } } }, "uploadDate": { "type": "string" }, "sendDate": {}, "status": { "type": "string" }, "subject": { "type": "string" }, "message": { "type": "string" }, "isSignOrder": { "type": "boolean" }, "expireInDays": { "type": "integer" }, "firstReminderDays": {}, "repeatingReminderDays": {}, "notifyWhenOpened": { "type": "boolean" }, "notifyWhenSigned": { "type": "boolean" }, "alertDaysBeforeExpiry": { "type": "integer" }, "templateName": { "type": "string" }, "templateDescription": { "type": "string" } } }, "documents": { "type": "array", "items": { "required": [ "id", "name", "externalContext" ], "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "externalContext": {} } } }, "recipients": { "type": "array", "items": { "required": [ "id", "name", "email", "role", "status", "signDate", "signOrder", "signGroupId", "userId", "mandatory", "isMFAEnabled", "phoneNumber", "hostEmail", "templateRole", "externalContext" ], "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "role": { "type": "string" }, "status": { "type": "string" }, "signDate": { "type": "string" }, "signOrder": { "type": "integer" }, "signGroupId": { "type": "string" }, "userId": {}, "mandatory": { "type": "boolean" }, "isMFAEnabled": { "type": "boolean" }, "phoneNumber": {}, "hostEmail": {}, "templateRole": { "type": "string" }, "externalContext": {} } } }, "signGroups": { "type": "array" }, "fields": { "type": "array", "items": { "required": [ "id", "name", "recipientId", "signGroupId", "documentId", "type", "value", "page", "height", "width", "positionX", "positionY", "isRequired", "properties" ], "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "recipientId": { "type": "string" }, "signGroupId": { "type": "string" }, "documentId": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "page": { "type": "integer" }, "height": { "type": "integer" }, "width": { "type": "integer" }, "positionX": { "type": "number" }, "positionY": { "type": "number" }, "isRequired": { "type": "boolean" }, "properties": {} } } }, "externalContext": {} } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" }, "userId": { "type": "string" } } }, "Template-templateId-get-Get400ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "string" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage", "urn" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" }, "urn": { "type": "string" } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" } } }, "Template-templateId-get-Get404ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "string" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" } } }, "Template-list-Get200ApplicationJsonResponse": { "type": "object", "properties": { "result": { "type": "object", "properties": { "statusCode": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "templates": { "type": "array", "items": { "required": [ "id", "createdBy", "creatorGuid", "status", "uploadDate", "sendDate", "subject", "transactionTokenId", "documents", "recipients", "isSignOrder", "expireInDays", "alertDaysBeforeExpiry", "templateName", "templateDescription", "templateRoles" ], "type": "object", "properties": { "id": { "type": "string" }, "createdBy": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } } }, "creatorGuid": { "type": "string" }, "status": { "type": "string" }, "uploadDate": { "type": "string" }, "sendDate": {}, "subject": { "type": "string" }, "transactionTokenId": {}, "documents": { "type": "string" }, "recipients": { "type": "string" }, "isSignOrder": { "type": "boolean" }, "expireInDays": { "type": "integer" }, "alertDaysBeforeExpiry": { "type": "integer" }, "templateName": { "type": "string" }, "templateDescription": { "type": "string" }, "templateRoles": { "type": "string" } } } }, "rowCount": { "type": "integer" } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" }, "userId": { "type": "string" } } }, "Template-list-Get400ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "string" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage", "urn" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" }, "urn": { "type": "string" } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" } } }, "Template-templateId-update-Put200ApplicationJsonResponse": { "type": "object", "properties": { "result": { "type": "object", "properties": { "statusCode": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "template": { "type": "object", "properties": { "id": { "type": "string" } } }, "documents": { "type": "array", "items": { "required": [ "id", "externalContext" ], "type": "object", "properties": { "id": { "type": "string" }, "externalContext": {} } } }, "recipients": { "type": "array", "items": { "required": [ "id", "externalContext" ], "type": "object", "properties": { "id": { "type": "string" }, "externalContext": {} } } }, "signGroups": { "type": "array" }, "fields": { "type": "array", "items": { "required": [ "id", "recipientId", "signGroupId", "documentId" ], "type": "object", "properties": { "id": { "type": "string" }, "recipientId": { "type": "string" }, "signGroupId": { "type": "string" }, "documentId": { "type": "string" } } } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" }, "userId": { "type": "string" } } }, "Template-templateId-update-Put400ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "integer" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" } } } }, "externalErrors": { "type": "array" } } }, "externalContext": { "type": "object", "properties": { "test1": { "type": "string" } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" }, "userId": { "type": "string" }, "operationId": { "type": "string" } } }, "Template-templateId-update-Put404ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "string" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" } } }, "User-activity-get-Get400ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "string" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage", "urn" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" }, "urn": { "type": "string" } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" } } }, "User-activity-get-Get404ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "string" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" } } }, "Document-documentId-download-Get400ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "string" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage", "urn" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" }, "urn": { "type": "string" } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" } } }, "Envelope-count-Get200ApplicationJsonResponse": { "type": "object", "properties": { "result": { "type": "object", "properties": { "statusCode": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "envelopes": { "type": "object", "properties": { "inbox": { "type": "integer" }, "sent": { "type": "integer" }, "drafts": { "type": "integer" }, "trash": { "type": "integer" }, "todo": { "type": "integer" }, "expiring": { "type": "integer" }, "pending": { "type": "integer" }, "completed": { "type": "integer" } } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" }, "userId": { "type": "string" } } }, "Envelope-count-Get400ApplicationJsonResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "string" }, "message": { "type": "string" }, "innerErrors": { "type": "array", "items": { "required": [ "code", "message", "userMessage", "urn" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "userMessage": { "type": "string" }, "urn": { "type": "string" } } } } } }, "origin": { "type": "string" }, "dateTime": { "type": "string" } } } }, "securitySchemes": { "apiKeyHeader": { "type": "apiKey", "name": "X-Subscription-Key", "in": "header" }, "apiKeyQuery": { "type": "apiKey", "name": "x-subscription-key", "in": "query" } } } }