{
"info": {
"name": "Doctavian",
"description": "Generated from the Doctavian OpenAPI specifications.",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": "Documents",
"description": {
"content": "Generate and manage documents using the prepared templates.",
"type": "text/plain"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"exec": [
"const value = pm.variables.get('documentsSubscriptionKey');",
"if (!value || !value.trim() || value.trim().indexOf('
\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.",
"type": "text/plain"
},
"url": {
"path": [
"documents",
"document",
"manage"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"description": {
"content": "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. (This can only be one of {{clientToken}})",
"type": "text/plain"
},
"key": "X-Client-Authorization",
"value": ""
},
{
"description": {
"content": "Encrypted (AES) JWT token to represent a user that doesn’t have a Microsoft Account and that is allowed to use the subscription. (This can only be one of {{secretToken}})",
"type": "text/plain"
},
"key": "X-Service-Authorization",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"externalContext\": {\n \"id\": \"{{yourExternalContextId}}\"\n },\n \"sourceDocument\": {\n \"urn\": \"{{documentURN}}\",\n \"fileFormat\": \"docx\",\n \"//xlsx\": null,\n \"pdf \\\"loadMethod\\\"\": \"Storage\",\n \"//Salesforce\": null,\n \"OneDrive \\\"remove\\\"\": \"none\",\n \"//delete\": null,\n \"permanentDelete \\\"options\\\"\": {\n \"docxLoadOptions\": \"{ \\\"PreserveUnsupportedFeatures\\\": true }\"\n }\n },\n \"targetDocument\": {\n \"name\": \"{{documentName}}\",\n \"fileFormat\": \"docx\",\n \"//xlsx\": null,\n \"pdf \\\"deliveryMethod\\\"\": \"Storage\",\n \"//Salesforce\": null,\n \"OneDrive \\\"path\\\"\": \"root\",\n \"options\": {\n \"pdfSaveOptions\": \"{ \\\"ConformanceLevel\\\": \\\"PdfA3a\\\", \\\"Version\\\": \\\"PDF_1_7\\\", \\\"ImageDpi\\\": 750 }\",\n \"docxSaveOptions\": \"{}\",\n \"salesforce\": {\n \"networkId\": \"{{siteId}}\",\n \"fileId\": \"{{targetFileId}}\",\n \"fileType\": \"File\",\n \"//Attachment \\\"fileParentId\\\"\": \"{{recordId}}\",\n \"ownerId\": \"{{ownerUserId}}\"\n },\n \"onedrive\": {\n \"viewAnonymous\": true,\n \"//false \\\"editAnonymous\\\"\": true,\n \"//false \\\"editUsers\\\"\": [\n \"user@example.com\"\n ],\n \"viewUsers\": [\n \"user@example.com\"\n ]\n }\n }\n },\n \"data\": {\n \"embedded\": \"key:value\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"response": [
{
"id": "0aac6172-b3c2-40ed-8cc6-25347612e18a",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"documents",
"document",
"manage"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"description": {
"content": "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. (This can only be one of {{clientToken}})",
"type": "text/plain"
},
"key": "X-Client-Authorization",
"value": ""
},
{
"description": {
"content": "Encrypted (AES) JWT token to represent a user that doesn’t have a Microsoft Account and that is allowed to use the subscription. (This can only be one of {{secretToken}})",
"type": "text/plain"
},
"key": "X-Service-Authorization",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"externalContext\": {\n \"id\": \"{{yourExternalContextId}}\"\n },\n \"sourceDocument\": {\n \"urn\": \"{{documentURN}}\",\n \"fileFormat\": \"docx\",\n \"//xlsx\": null,\n \"pdf \\\"loadMethod\\\"\": \"Storage\",\n \"//Salesforce\": null,\n \"OneDrive \\\"remove\\\"\": \"none\",\n \"//delete\": null,\n \"permanentDelete \\\"options\\\"\": {\n \"docxLoadOptions\": \"{ \\\"PreserveUnsupportedFeatures\\\": true }\"\n }\n },\n \"targetDocument\": {\n \"name\": \"{{documentName}}\",\n \"fileFormat\": \"docx\",\n \"//xlsx\": null,\n \"pdf \\\"deliveryMethod\\\"\": \"Storage\",\n \"//Salesforce\": null,\n \"OneDrive \\\"path\\\"\": \"root\",\n \"options\": {\n \"pdfSaveOptions\": \"{ \\\"ConformanceLevel\\\": \\\"PdfA3a\\\", \\\"Version\\\": \\\"PDF_1_7\\\", \\\"ImageDpi\\\": 750 }\",\n \"docxSaveOptions\": \"{}\",\n \"salesforce\": {\n \"networkId\": \"{{siteId}}\",\n \"fileId\": \"{{targetFileId}}\",\n \"fileType\": \"File\",\n \"//Attachment \\\"fileParentId\\\"\": \"{{recordId}}\",\n \"ownerId\": \"{{ownerUserId}}\"\n },\n \"onedrive\": {\n \"viewAnonymous\": true,\n \"//false \\\"editAnonymous\\\"\": true,\n \"//false \\\"editUsers\\\"\": [\n \"user@example.com\"\n ],\n \"viewUsers\": [\n \"user@example.com\"\n ]\n }\n }\n },\n \"data\": {\n \"embedded\": \"key:value\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "Created",
"code": 201,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": \"201\",\n \"message\": \"Created\",\n \"data\": {\n \"document\": {\n \"deliveryMethod\": \"{{deliveryMethod}}\",\n \"name\": \"{{documentName}}\",\n \"fileFormat\": \"{{fileFormat}}\",\n \"urn\": \"{{documentURN}}:{{documentName}}.{{fileFormat}}\"\n }\n }\n },\n \"consumption\": [\n {\n \"dimension\": \"pages-managed\",\n \"value\": \"\"\n },\n {\n \"dimension\": \"documents-managed\",\n \"value\": \"\"\n }\n ],\n \"externalContext\": {\n \"actionRequestId\": \"{{externalContextId}}\"\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\",\n \"userId\": \"{{userId}}\",\n \"operationId\": \"{{operationId}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "362ee297-56a1-4b1e-9137-e6774e756054",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"documents",
"document",
"manage"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"description": {
"content": "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. (This can only be one of {{clientToken}})",
"type": "text/plain"
},
"key": "X-Client-Authorization",
"value": ""
},
{
"description": {
"content": "Encrypted (AES) JWT token to represent a user that doesn’t have a Microsoft Account and that is allowed to use the subscription. (This can only be one of {{secretToken}})",
"type": "text/plain"
},
"key": "X-Service-Authorization",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"externalContext\": {\n \"id\": \"{{yourExternalContextId}}\"\n },\n \"sourceDocument\": {\n \"urn\": \"{{documentURN}}\",\n \"fileFormat\": \"docx\",\n \"//xlsx\": null,\n \"pdf \\\"loadMethod\\\"\": \"Storage\",\n \"//Salesforce\": null,\n \"OneDrive \\\"remove\\\"\": \"none\",\n \"//delete\": null,\n \"permanentDelete \\\"options\\\"\": {\n \"docxLoadOptions\": \"{ \\\"PreserveUnsupportedFeatures\\\": true }\"\n }\n },\n \"targetDocument\": {\n \"name\": \"{{documentName}}\",\n \"fileFormat\": \"docx\",\n \"//xlsx\": null,\n \"pdf \\\"deliveryMethod\\\"\": \"Storage\",\n \"//Salesforce\": null,\n \"OneDrive \\\"path\\\"\": \"root\",\n \"options\": {\n \"pdfSaveOptions\": \"{ \\\"ConformanceLevel\\\": \\\"PdfA3a\\\", \\\"Version\\\": \\\"PDF_1_7\\\", \\\"ImageDpi\\\": 750 }\",\n \"docxSaveOptions\": \"{}\",\n \"salesforce\": {\n \"networkId\": \"{{siteId}}\",\n \"fileId\": \"{{targetFileId}}\",\n \"fileType\": \"File\",\n \"//Attachment \\\"fileParentId\\\"\": \"{{recordId}}\",\n \"ownerId\": \"{{ownerUserId}}\"\n },\n \"onedrive\": {\n \"viewAnonymous\": true,\n \"//false \\\"editAnonymous\\\"\": true,\n \"//false \\\"editUsers\\\"\": [\n \"user@example.com\"\n ],\n \"viewUsers\": [\n \"user@example.com\"\n ]\n }\n }\n },\n \"data\": {\n \"embedded\": \"key:value\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\",\n \"eventId\": \"{{eventId}}\"\n }\n ],\n \"externalErrors\": []\n },\n \"externalContext\": {\n \"actionRequestId\": \"{{externalContextId}}\"\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\",\n \"userId\": \"{{userId}}\",\n \"operationId\": \"{{operationId}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "a8294a45-00c2-459e-841c-b73ad7d79c45",
"name": "Document Merge",
"request": {
"name": "Document Merge",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"documents",
"document",
"merge"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"description": {
"content": "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. (This can only be one of {{clientToken}})",
"type": "text/plain"
},
"key": "X-Client-Authorization",
"value": ""
},
{
"description": {
"content": "Encrypted (AES) JWT token to represent a user that doesn’t have a Microsoft Account and that is allowed to use the subscription. (This can only be one of {{secretToken}})",
"type": "text/plain"
},
"key": "X-Service-Authorization",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"externalContext\": {\n \"id\": \"{{yourExternalContextId}}\"\n },\n \"sourceDocuments\": [\n {\n \"urn\": \"{{document1URN}}\",\n \"loadMethod\": \"Storage\",\n \"order\": 1,\n \"remove\": \"none\"\n },\n {\n \"urn\": \"{{document2URN}}\",\n \"loadMethod\": \"Storage\",\n \"order\": 2,\n \"remove\": \"none\"\n }\n ],\n \"targetDocument\": {\n \"name\": \"{{documentName}}\",\n \"fileFormat\": \"pdf\",\n \"deliveryMethod\": \"Storage\",\n \"path\": \"root\",\n \"options\": {\n \"pdfSaveOptions\": \"{ \\\"ConformanceLevel\\\": \\\"PdfA3a\\\", \\\"Version\\\": \\\"PDF_1_7\\\", \\\"ImageDpi\\\": 750 }\",\n \"salesforce\": {\n \"networkId\": \"{{siteId}}\",\n \"fileId\": \"{{targetFileId}}\",\n \"fileType\": \"File\",\n \"fileParentId\": \"{{recordId}}\",\n \"ownerId\": \"{{ownerUserId}}\"\n },\n \"onedrive\": {\n \"viewAnonymous\": true,\n \"editAnonymous\": true,\n \"editUsers\": [\n \"user@example.com\"\n ],\n \"viewUsers\": [\n \"user@example.com\"\n ]\n }\n }\n },\n \"data\": {\n \"embedded\": \"key:value\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"response": [
{
"id": "fb30372f-1662-4859-9e7d-bd73c5edf9ef",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"documents",
"document",
"merge"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"description": {
"content": "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. (This can only be one of {{clientToken}})",
"type": "text/plain"
},
"key": "X-Client-Authorization",
"value": ""
},
{
"description": {
"content": "Encrypted (AES) JWT token to represent a user that doesn’t have a Microsoft Account and that is allowed to use the subscription. (This can only be one of {{secretToken}})",
"type": "text/plain"
},
"key": "X-Service-Authorization",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"externalContext\": {\n \"id\": \"{{yourExternalContextId}}\"\n },\n \"sourceDocuments\": [\n {\n \"urn\": \"{{document1URN}}\",\n \"loadMethod\": \"Storage\",\n \"order\": 1,\n \"remove\": \"none\"\n },\n {\n \"urn\": \"{{document2URN}}\",\n \"loadMethod\": \"Storage\",\n \"order\": 2,\n \"remove\": \"none\"\n }\n ],\n \"targetDocument\": {\n \"name\": \"{{documentName}}\",\n \"fileFormat\": \"pdf\",\n \"deliveryMethod\": \"Storage\",\n \"path\": \"root\",\n \"options\": {\n \"pdfSaveOptions\": \"{ \\\"ConformanceLevel\\\": \\\"PdfA3a\\\", \\\"Version\\\": \\\"PDF_1_7\\\", \\\"ImageDpi\\\": 750 }\",\n \"salesforce\": {\n \"networkId\": \"{{siteId}}\",\n \"fileId\": \"{{targetFileId}}\",\n \"fileType\": \"File\",\n \"fileParentId\": \"{{recordId}}\",\n \"ownerId\": \"{{ownerUserId}}\"\n },\n \"onedrive\": {\n \"viewAnonymous\": true,\n \"editAnonymous\": true,\n \"editUsers\": [\n \"user@example.com\"\n ],\n \"viewUsers\": [\n \"user@example.com\"\n ]\n }\n }\n },\n \"data\": {\n \"embedded\": \"key:value\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "Created",
"code": 201,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": \"201\",\n \"message\": \"Created\",\n \"data\": {\n \"document\": {\n \"deliveryMethod\": \"{{deliveryMethod}}\",\n \"name\": \"{{documentName}}\",\n \"fileFormat\": \"{{fileFormat}}\",\n \"urn\": \"{{documentURN}}:{{documentName}}.{{fileFormat}}\"\n }\n }\n },\n \"consumption\": [\n {\n \"dimension\": \"pages-merged\",\n \"value\": \"\"\n },\n {\n \"dimension\": \"documents-merged\",\n \"value\": \"\"\n }\n ],\n \"externalContext\": {\n \"actionRequestId\": \"{{externalContextId}}\"\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\",\n \"userId\": \"{{userId}}\",\n \"operationId\": \"{{operationId}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "74e5b59d-d141-4ae4-bd40-bb51ba405f45",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"documents",
"document",
"merge"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"description": {
"content": "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. (This can only be one of {{clientToken}})",
"type": "text/plain"
},
"key": "X-Client-Authorization",
"value": ""
},
{
"description": {
"content": "Encrypted (AES) JWT token to represent a user that doesn’t have a Microsoft Account and that is allowed to use the subscription. (This can only be one of {{secretToken}})",
"type": "text/plain"
},
"key": "X-Service-Authorization",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"externalContext\": {\n \"id\": \"{{yourExternalContextId}}\"\n },\n \"sourceDocuments\": [\n {\n \"urn\": \"{{document1URN}}\",\n \"loadMethod\": \"Storage\",\n \"order\": 1,\n \"remove\": \"none\"\n },\n {\n \"urn\": \"{{document2URN}}\",\n \"loadMethod\": \"Storage\",\n \"order\": 2,\n \"remove\": \"none\"\n }\n ],\n \"targetDocument\": {\n \"name\": \"{{documentName}}\",\n \"fileFormat\": \"pdf\",\n \"deliveryMethod\": \"Storage\",\n \"path\": \"root\",\n \"options\": {\n \"pdfSaveOptions\": \"{ \\\"ConformanceLevel\\\": \\\"PdfA3a\\\", \\\"Version\\\": \\\"PDF_1_7\\\", \\\"ImageDpi\\\": 750 }\",\n \"salesforce\": {\n \"networkId\": \"{{siteId}}\",\n \"fileId\": \"{{targetFileId}}\",\n \"fileType\": \"File\",\n \"fileParentId\": \"{{recordId}}\",\n \"ownerId\": \"{{ownerUserId}}\"\n },\n \"onedrive\": {\n \"viewAnonymous\": true,\n \"editAnonymous\": true,\n \"editUsers\": [\n \"user@example.com\"\n ],\n \"viewUsers\": [\n \"user@example.com\"\n ]\n }\n }\n },\n \"data\": {\n \"embedded\": \"key:value\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\",\n \"eventId\": \"{{eventId}}\"\n }\n ],\n \"externalErrors\": []\n },\n \"externalContext\": {\n \"actionRequestId\": \"{{externalContextId}}\"\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\",\n \"userId\": \"{{userId}}\",\n \"operationId\": \"{{operationId}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "d098e59b-a939-4555-891a-8523e457bf58",
"name": "Document Generate",
"request": {
"name": "Document Generate",
"description": {
"content": "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)",
"type": "text/plain"
},
"url": {
"path": [
"documents",
"document",
"generate"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"description": {
"content": "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. (This can only be one of {{clientToken}})",
"type": "text/plain"
},
"key": "X-Client-Authorization",
"value": ""
},
{
"description": {
"content": "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. (This can only be one of {{secretToken}})",
"type": "text/plain"
},
"key": "X-Service-Authorization",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"externalContext\": {\n \"id\": \"{{yourExternalContextId}}\"\n },\n \"template\": {\n \"name\": \"{{templateName}}\",\n \"urn\": \"{{templateURN}}\",\n \"fileFormat\": \"docx\",\n \"loadMethod\": \"Storage\",\n \"options\": {\n \"docxLoadOptions\": \"{ \\\"PreserveUnsupportedFeatures\\\": true }\"\n },\n \"relatedItems\": [\n {\n \"name\": \"{{relatedTemplateName}}\",\n \"urn\": \"{{relatedTemplateURN}}\",\n \"fileFormat\": \"docx\",\n \"loadMethod\": \"Storage\"\n }\n ]\n },\n \"data\": {\n \"loadMethod\": \"Storage\",\n \"urn\": \"{{dataURN}}\",\n \"variables\": [\n {\n \"name\": \"createdDate\",\n \"value\": \"{!$now()}\",\n \"type\": \"fieldExpression\"\n },\n {\n \"name\": \"requestId\",\n \"value\": \"{!requestId}\",\n \"type\": \"graphql\"\n },\n {\n \"name\": \"customerName\",\n \"value\": \"Jane Doe\",\n \"type\": \"global\"\n }\n ],\n \"query\": \"{\\\"query\\\":\\\"{Account {Name Description Owner.Username Id Opportunities {StageName OpportunityLineItems {Name}} Contacts {Id}}}\\\"}\",\n \"embedded\": \"key:value\"\n },\n \"document\": {\n \"timezone\": \"(GMT+00:00) Greenwich Mean Time (Europe/Dublin)\",\n \"locale\": \"en_IE_EURO\",\n \"name\": \"{{finalDocumentName}}\",\n \"fileFormat\": \"docx\",\n \"deliveryMethod\": \"Storage\",\n \"path\": \"root\",\n \"options\": {\n \"pdfSaveOptions\": \"{ \\\"ConformanceLevel\\\": \\\"PdfA3a\\\", \\\"Version\\\": \\\"PDF_1_7\\\", \\\"ImageDpi\\\": 750 }\",\n \"docxSaveOptions\": \"{}\",\n \"salesforce\": {\n \"fileId\": \"{{targetFileId}}\",\n \"fileType\": \"File\",\n \"fileParentId\": \"{{recordId}}\",\n \"ownerId\": \"{{ownerUserId}}\"\n },\n \"onedrive\": {\n \"viewAnonymous\": true,\n \"editAnonymous\": true,\n \"editUsers\": [\n \"user@example.com\"\n ],\n \"viewUsers\": [\n \"user@example.com\"\n ]\n },\n \"googleDrive\": {\n \"viewAnonymous\": true,\n \"editAnonymous\": true,\n \"editUsers\": [\n \"user@example.com\"\n ],\n \"viewUsers\": [\n \"user@example.com\"\n ]\n },\n \"googleGenerate\": {\n \"nativeMergeEnabled\": true,\n \"nativeImageMergeEnabled\": true\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"response": [
{
"id": "86c33d25-e4fe-4720-8041-882ac8701db8",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"documents",
"document",
"generate"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"description": {
"content": "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. (This can only be one of {{clientToken}})",
"type": "text/plain"
},
"key": "X-Client-Authorization",
"value": ""
},
{
"description": {
"content": "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. (This can only be one of {{secretToken}})",
"type": "text/plain"
},
"key": "X-Service-Authorization",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"externalContext\": {\n \"id\": \"{{yourExternalContextId}}\"\n },\n \"template\": {\n \"name\": \"{{templateName}}\",\n \"urn\": \"{{templateURN}}\",\n \"fileFormat\": \"docx\",\n \"loadMethod\": \"Storage\",\n \"options\": {\n \"docxLoadOptions\": \"{ \\\"PreserveUnsupportedFeatures\\\": true }\"\n },\n \"relatedItems\": [\n {\n \"name\": \"{{relatedTemplateName}}\",\n \"urn\": \"{{relatedTemplateURN}}\",\n \"fileFormat\": \"docx\",\n \"loadMethod\": \"Storage\"\n }\n ]\n },\n \"data\": {\n \"loadMethod\": \"Storage\",\n \"urn\": \"{{dataURN}}\",\n \"variables\": [\n {\n \"name\": \"createdDate\",\n \"value\": \"{!$now()}\",\n \"type\": \"fieldExpression\"\n },\n {\n \"name\": \"requestId\",\n \"value\": \"{!requestId}\",\n \"type\": \"graphql\"\n },\n {\n \"name\": \"customerName\",\n \"value\": \"Jane Doe\",\n \"type\": \"global\"\n }\n ],\n \"query\": \"{\\\"query\\\":\\\"{Account {Name Description Owner.Username Id Opportunities {StageName OpportunityLineItems {Name}} Contacts {Id}}}\\\"}\",\n \"embedded\": \"key:value\"\n },\n \"document\": {\n \"timezone\": \"(GMT+00:00) Greenwich Mean Time (Europe/Dublin)\",\n \"locale\": \"en_IE_EURO\",\n \"name\": \"{{finalDocumentName}}\",\n \"fileFormat\": \"docx\",\n \"deliveryMethod\": \"Storage\",\n \"path\": \"root\",\n \"options\": {\n \"pdfSaveOptions\": \"{ \\\"ConformanceLevel\\\": \\\"PdfA3a\\\", \\\"Version\\\": \\\"PDF_1_7\\\", \\\"ImageDpi\\\": 750 }\",\n \"docxSaveOptions\": \"{}\",\n \"salesforce\": {\n \"fileId\": \"{{targetFileId}}\",\n \"fileType\": \"File\",\n \"fileParentId\": \"{{recordId}}\",\n \"ownerId\": \"{{ownerUserId}}\"\n },\n \"onedrive\": {\n \"viewAnonymous\": true,\n \"editAnonymous\": true,\n \"editUsers\": [\n \"user@example.com\"\n ],\n \"viewUsers\": [\n \"user@example.com\"\n ]\n },\n \"googleDrive\": {\n \"viewAnonymous\": true,\n \"editAnonymous\": true,\n \"editUsers\": [\n \"user@example.com\"\n ],\n \"viewUsers\": [\n \"user@example.com\"\n ]\n },\n \"googleGenerate\": {\n \"nativeMergeEnabled\": true,\n \"nativeImageMergeEnabled\": true\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "Created",
"code": 201,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": \"201\",\n \"message\": \"Created\",\n \"data\": {\n \"document\": {\n \"deliveryMethod\": \"{{deliveryMethod}}\",\n \"name\": \"{{documentName}}\",\n \"fileFormat\": \"{{fileFormat}}\",\n \"urn\": \"{{documentURN}}:{{documentName}}.{{fileFormat}}\"\n }\n }\n },\n \"consumption\": [\n {\n \"dimension\": \"pages-generated\",\n \"value\": \"\"\n },\n {\n \"dimension\": \"documents-generated\",\n \"value\": \"\"\n }\n ],\n \"externalContext\": {\n \"actionRequestId\": \"{{externalContextId}}\"\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\",\n \"userId\": \"{{userId}}\",\n \"operationId\": \"{{operationId}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "283e11e3-216f-4188-87bf-3c68c3843913",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"documents",
"document",
"generate"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"description": {
"content": "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. (This can only be one of {{clientToken}})",
"type": "text/plain"
},
"key": "X-Client-Authorization",
"value": ""
},
{
"description": {
"content": "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. (This can only be one of {{secretToken}})",
"type": "text/plain"
},
"key": "X-Service-Authorization",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"externalContext\": {\n \"id\": \"{{yourExternalContextId}}\"\n },\n \"template\": {\n \"name\": \"{{templateName}}\",\n \"urn\": \"{{templateURN}}\",\n \"fileFormat\": \"docx\",\n \"loadMethod\": \"Storage\",\n \"options\": {\n \"docxLoadOptions\": \"{ \\\"PreserveUnsupportedFeatures\\\": true }\"\n },\n \"relatedItems\": [\n {\n \"name\": \"{{relatedTemplateName}}\",\n \"urn\": \"{{relatedTemplateURN}}\",\n \"fileFormat\": \"docx\",\n \"loadMethod\": \"Storage\"\n }\n ]\n },\n \"data\": {\n \"loadMethod\": \"Storage\",\n \"urn\": \"{{dataURN}}\",\n \"variables\": [\n {\n \"name\": \"createdDate\",\n \"value\": \"{!$now()}\",\n \"type\": \"fieldExpression\"\n },\n {\n \"name\": \"requestId\",\n \"value\": \"{!requestId}\",\n \"type\": \"graphql\"\n },\n {\n \"name\": \"customerName\",\n \"value\": \"Jane Doe\",\n \"type\": \"global\"\n }\n ],\n \"query\": \"{\\\"query\\\":\\\"{Account {Name Description Owner.Username Id Opportunities {StageName OpportunityLineItems {Name}} Contacts {Id}}}\\\"}\",\n \"embedded\": \"key:value\"\n },\n \"document\": {\n \"timezone\": \"(GMT+00:00) Greenwich Mean Time (Europe/Dublin)\",\n \"locale\": \"en_IE_EURO\",\n \"name\": \"{{finalDocumentName}}\",\n \"fileFormat\": \"docx\",\n \"deliveryMethod\": \"Storage\",\n \"path\": \"root\",\n \"options\": {\n \"pdfSaveOptions\": \"{ \\\"ConformanceLevel\\\": \\\"PdfA3a\\\", \\\"Version\\\": \\\"PDF_1_7\\\", \\\"ImageDpi\\\": 750 }\",\n \"docxSaveOptions\": \"{}\",\n \"salesforce\": {\n \"fileId\": \"{{targetFileId}}\",\n \"fileType\": \"File\",\n \"fileParentId\": \"{{recordId}}\",\n \"ownerId\": \"{{ownerUserId}}\"\n },\n \"onedrive\": {\n \"viewAnonymous\": true,\n \"editAnonymous\": true,\n \"editUsers\": [\n \"user@example.com\"\n ],\n \"viewUsers\": [\n \"user@example.com\"\n ]\n },\n \"googleDrive\": {\n \"viewAnonymous\": true,\n \"editAnonymous\": true,\n \"editUsers\": [\n \"user@example.com\"\n ],\n \"viewUsers\": [\n \"user@example.com\"\n ]\n },\n \"googleGenerate\": {\n \"nativeMergeEnabled\": true,\n \"nativeImageMergeEnabled\": true\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\",\n \"eventId\": \"{{eventId}}\"\n }\n ],\n \"externalErrors\": []\n },\n \"externalContext\": {\n \"actionRequestId\": \"{{externalContextId}}\"\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\",\n \"userId\": \"{{userId}}\",\n \"operationId\": \"{{operationId}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "141b235a-cb7d-4a42-9797-a2bf2c67fce7",
"name": "Document Generate Async",
"request": {
"name": "Document Generate Async",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"documents",
"document",
"generate",
"async"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"description": {
"content": "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. (This can only be one of {{clientToken}})",
"type": "text/plain"
},
"key": "X-Client-Authorization",
"value": ""
},
{
"description": {
"content": "Encrypted (AES) JWT token to represent a user that doesn’t have a Microsoft Account and that is allowed to use the subscription. (This can only be one of {{secretToken}})",
"type": "text/plain"
},
"key": "X-Service-Authorization",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"externalContext\": {\n \"id\": \"{{yourExternalContextId}}\"\n },\n \"template\": {\n \"name\": \"{{templateName}}\",\n \"urn\": \"{{templateURN}}\",\n \"fileFormat\": \"docx\",\n \"loadMethod\": \"Storage\",\n \"options\": {\n \"docxLoadOptions\": \"{ \\\"PreserveUnsupportedFeatures\\\": true }\"\n },\n \"relatedItems\": [\n {\n \"name\": \"{{relatedTemplateName}}\",\n \"urn\": \"{{relatedTemplateURN}}\",\n \"fileFormat\": \"docx\",\n \"loadMethod\": \"Storage\"\n }\n ]\n },\n \"data\": {\n \"loadMethod\": \"Storage\",\n \"urn\": \"{{dataURN}}\",\n \"variables\": [\n {\n \"name\": \"createdDate\",\n \"value\": \"{!$now()}\",\n \"type\": \"fieldExpression\"\n },\n {\n \"name\": \"requestId\",\n \"value\": \"{!requestId}\",\n \"type\": \"graphql\"\n },\n {\n \"name\": \"customerName\",\n \"value\": \"Jane Doe\",\n \"type\": \"global\"\n }\n ],\n \"query\": \"{\\\"query\\\":\\\"{Account {Name Description Owner.Username Id Opportunities {StageName OpportunityLineItems {Name}} Contacts {Id}}}\\\"}\",\n \"embedded\": \"key:value\"\n },\n \"document\": {\n \"timezone\": \"(GMT+00:00) Greenwich Mean Time (Europe/Dublin)\",\n \"locale\": \"en_IE_EURO\",\n \"name\": \"{{finalDocumentName}}\",\n \"fileFormat\": \"docx\",\n \"deliveryMethod\": \"Storage\",\n \"path\": \"root\",\n \"options\": {\n \"pdfSaveOptions\": \"{ \\\"ConformanceLevel\\\": \\\"PdfA3a\\\", \\\"Version\\\": \\\"PDF_1_7\\\", \\\"ImageDpi\\\": 750 }\",\n \"docxSaveOptions\": \"{}\",\n \"salesforce\": {\n \"fileId\": \"{{targetFileId}}\",\n \"fileType\": \"File\",\n \"fileParentId\": \"{{recordId}}\",\n \"ownerId\": \"{{ownerUserId}}\"\n },\n \"onedrive\": {\n \"viewAnonymous\": true,\n \"editAnonymous\": true,\n \"editUsers\": [\n \"user@example.com\"\n ],\n \"viewUsers\": [\n \"user@example.com\"\n ]\n },\n \"googleDrive\": {\n \"viewAnonymous\": true,\n \"editAnonymous\": true,\n \"editUsers\": [\n \"user@example.com\"\n ],\n \"viewUsers\": [\n \"user@example.com\"\n ]\n },\n \"googleGenerate\": {\n \"nativeMergeEnabled\": true,\n \"nativeImageMergeEnabled\": true\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"response": [
{
"id": "f8669e2a-015e-46be-ba56-f5e2b94ab424",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"documents",
"document",
"generate",
"async"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"description": {
"content": "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. (This can only be one of {{clientToken}})",
"type": "text/plain"
},
"key": "X-Client-Authorization",
"value": ""
},
{
"description": {
"content": "Encrypted (AES) JWT token to represent a user that doesn’t have a Microsoft Account and that is allowed to use the subscription. (This can only be one of {{secretToken}})",
"type": "text/plain"
},
"key": "X-Service-Authorization",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"externalContext\": {\n \"id\": \"{{yourExternalContextId}}\"\n },\n \"template\": {\n \"name\": \"{{templateName}}\",\n \"urn\": \"{{templateURN}}\",\n \"fileFormat\": \"docx\",\n \"loadMethod\": \"Storage\",\n \"options\": {\n \"docxLoadOptions\": \"{ \\\"PreserveUnsupportedFeatures\\\": true }\"\n },\n \"relatedItems\": [\n {\n \"name\": \"{{relatedTemplateName}}\",\n \"urn\": \"{{relatedTemplateURN}}\",\n \"fileFormat\": \"docx\",\n \"loadMethod\": \"Storage\"\n }\n ]\n },\n \"data\": {\n \"loadMethod\": \"Storage\",\n \"urn\": \"{{dataURN}}\",\n \"variables\": [\n {\n \"name\": \"createdDate\",\n \"value\": \"{!$now()}\",\n \"type\": \"fieldExpression\"\n },\n {\n \"name\": \"requestId\",\n \"value\": \"{!requestId}\",\n \"type\": \"graphql\"\n },\n {\n \"name\": \"customerName\",\n \"value\": \"Jane Doe\",\n \"type\": \"global\"\n }\n ],\n \"query\": \"{\\\"query\\\":\\\"{Account {Name Description Owner.Username Id Opportunities {StageName OpportunityLineItems {Name}} Contacts {Id}}}\\\"}\",\n \"embedded\": \"key:value\"\n },\n \"document\": {\n \"timezone\": \"(GMT+00:00) Greenwich Mean Time (Europe/Dublin)\",\n \"locale\": \"en_IE_EURO\",\n \"name\": \"{{finalDocumentName}}\",\n \"fileFormat\": \"docx\",\n \"deliveryMethod\": \"Storage\",\n \"path\": \"root\",\n \"options\": {\n \"pdfSaveOptions\": \"{ \\\"ConformanceLevel\\\": \\\"PdfA3a\\\", \\\"Version\\\": \\\"PDF_1_7\\\", \\\"ImageDpi\\\": 750 }\",\n \"docxSaveOptions\": \"{}\",\n \"salesforce\": {\n \"fileId\": \"{{targetFileId}}\",\n \"fileType\": \"File\",\n \"fileParentId\": \"{{recordId}}\",\n \"ownerId\": \"{{ownerUserId}}\"\n },\n \"onedrive\": {\n \"viewAnonymous\": true,\n \"editAnonymous\": true,\n \"editUsers\": [\n \"user@example.com\"\n ],\n \"viewUsers\": [\n \"user@example.com\"\n ]\n },\n \"googleDrive\": {\n \"viewAnonymous\": true,\n \"editAnonymous\": true,\n \"editUsers\": [\n \"user@example.com\"\n ],\n \"viewUsers\": [\n \"user@example.com\"\n ]\n },\n \"googleGenerate\": {\n \"nativeMergeEnabled\": true,\n \"nativeImageMergeEnabled\": true\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "Created",
"code": 201,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": \"201\",\n \"message\": \"Created\",\n \"data\": {\n \"document\": {\n \"deliveryMethod\": \"{{deliveryMethod}}\",\n \"name\": \"{{documentName}}\",\n \"fileFormat\": \"{{fileFormat}}\",\n \"urn\": \"{{documentURN}}:{{documentName}}.{{fileFormat}}\"\n }\n }\n },\n \"consumption\": [\n {\n \"dimension\": \"pages-generated\",\n \"value\": \"\"\n },\n {\n \"dimension\": \"documents-generated\",\n \"value\": \"\"\n }\n ],\n \"externalContext\": {\n \"actionRequestId\": \"{{externalContextId}}\"\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\",\n \"userId\": \"{{userId}}\",\n \"operationId\": \"{{operationId}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "23be95bd-8dc0-4469-a007-be029dec6401",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"documents",
"document",
"generate",
"async"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"description": {
"content": "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. (This can only be one of {{clientToken}})",
"type": "text/plain"
},
"key": "X-Client-Authorization",
"value": ""
},
{
"description": {
"content": "Encrypted (AES) JWT token to represent a user that doesn’t have a Microsoft Account and that is allowed to use the subscription. (This can only be one of {{secretToken}})",
"type": "text/plain"
},
"key": "X-Service-Authorization",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"externalContext\": {\n \"id\": \"{{yourExternalContextId}}\"\n },\n \"template\": {\n \"name\": \"{{templateName}}\",\n \"urn\": \"{{templateURN}}\",\n \"fileFormat\": \"docx\",\n \"loadMethod\": \"Storage\",\n \"options\": {\n \"docxLoadOptions\": \"{ \\\"PreserveUnsupportedFeatures\\\": true }\"\n },\n \"relatedItems\": [\n {\n \"name\": \"{{relatedTemplateName}}\",\n \"urn\": \"{{relatedTemplateURN}}\",\n \"fileFormat\": \"docx\",\n \"loadMethod\": \"Storage\"\n }\n ]\n },\n \"data\": {\n \"loadMethod\": \"Storage\",\n \"urn\": \"{{dataURN}}\",\n \"variables\": [\n {\n \"name\": \"createdDate\",\n \"value\": \"{!$now()}\",\n \"type\": \"fieldExpression\"\n },\n {\n \"name\": \"requestId\",\n \"value\": \"{!requestId}\",\n \"type\": \"graphql\"\n },\n {\n \"name\": \"customerName\",\n \"value\": \"Jane Doe\",\n \"type\": \"global\"\n }\n ],\n \"query\": \"{\\\"query\\\":\\\"{Account {Name Description Owner.Username Id Opportunities {StageName OpportunityLineItems {Name}} Contacts {Id}}}\\\"}\",\n \"embedded\": \"key:value\"\n },\n \"document\": {\n \"timezone\": \"(GMT+00:00) Greenwich Mean Time (Europe/Dublin)\",\n \"locale\": \"en_IE_EURO\",\n \"name\": \"{{finalDocumentName}}\",\n \"fileFormat\": \"docx\",\n \"deliveryMethod\": \"Storage\",\n \"path\": \"root\",\n \"options\": {\n \"pdfSaveOptions\": \"{ \\\"ConformanceLevel\\\": \\\"PdfA3a\\\", \\\"Version\\\": \\\"PDF_1_7\\\", \\\"ImageDpi\\\": 750 }\",\n \"docxSaveOptions\": \"{}\",\n \"salesforce\": {\n \"fileId\": \"{{targetFileId}}\",\n \"fileType\": \"File\",\n \"fileParentId\": \"{{recordId}}\",\n \"ownerId\": \"{{ownerUserId}}\"\n },\n \"onedrive\": {\n \"viewAnonymous\": true,\n \"editAnonymous\": true,\n \"editUsers\": [\n \"user@example.com\"\n ],\n \"viewUsers\": [\n \"user@example.com\"\n ]\n },\n \"googleDrive\": {\n \"viewAnonymous\": true,\n \"editAnonymous\": true,\n \"editUsers\": [\n \"user@example.com\"\n ],\n \"viewUsers\": [\n \"user@example.com\"\n ]\n },\n \"googleGenerate\": {\n \"nativeMergeEnabled\": true,\n \"nativeImageMergeEnabled\": true\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\",\n \"eventId\": \"{{eventId}}\"\n }\n ],\n \"externalErrors\": []\n },\n \"externalContext\": {\n \"actionRequestId\": \"{{externalContextId}}\"\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\",\n \"userId\": \"{{userId}}\",\n \"operationId\": \"{{operationId}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "6e587f18-2d37-4171-b858-b33efa6f8fb8",
"name": "Document Download",
"request": {
"name": "Document Download",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"documents",
"document",
":documentId",
"download"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "string",
"key": "documentId",
"disabled": false,
"description": {
"content": "(Required) ",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Accept",
"value": "application/octet-stream"
}
],
"method": "GET",
"body": {}
},
"response": [
{
"id": "8acd3632-8da8-4a05-9a2b-33ba2fc9b6f0",
"name": "This response returns the final document file (e.g. PDF, DOCX, XLSX) as a binary response (octet-stream).",
"originalRequest": {
"url": {
"path": [
"documents",
"document",
":documentId",
"download"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) ",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "documentId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/octet-stream"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/octet-stream"
}
],
"body": "The binary content of the requested document (e.g., PDF)",
"cookie": [],
"_postman_previewlanguage": "text"
},
{
"id": "63d6b3a3-f389-4652-a39c-bea450f199b5",
"name": "400",
"originalRequest": {
"url": {
"path": [
"documents",
"document",
":documentId",
"download"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) ",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "documentId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\",\n \"urn\": \"{{sentUrn}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "9165fb04-18f2-4dff-8ea9-fbe0b315eb1e",
"name": "404",
"originalRequest": {
"url": {
"path": [
"documents",
"document",
":documentId",
"download"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) ",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "documentId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Not Found",
"code": 404,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"404\",\n \"message\": \"Not Found\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "fac1470f-22c6-4488-a1a7-0721fb485a36",
"name": "Document Merge Async",
"request": {
"name": "Document Merge Async",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"documents",
"document",
"merge",
"async"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"description": {
"content": "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. (This can only be one of {{clientToken}})",
"type": "text/plain"
},
"key": "X-Client-Authorization",
"value": ""
},
{
"description": {
"content": "Encrypted (AES) JWT token to represent a user that doesn’t have a Microsoft Account and that is allowed to use the subscription. (This can only be one of {{secretToken}})",
"type": "text/plain"
},
"key": "X-Service-Authorization",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"externalContext\": {\n \"id\": \"{{yourExternalContextId}}\"\n },\n \"sourceDocuments\": [\n {\n \"urn\": \"{{document1URN}}\",\n \"loadMethod\": \"Storage\",\n \"order\": 1,\n \"remove\": \"none\"\n },\n {\n \"urn\": \"{{document2URN}}\",\n \"loadMethod\": \"Storage\",\n \"order\": 2,\n \"remove\": \"none\"\n }\n ],\n \"targetDocument\": {\n \"name\": \"{{documentName}}\",\n \"fileFormat\": \"pdf\",\n \"deliveryMethod\": \"Storage\",\n \"path\": \"root\",\n \"options\": {\n \"pdfSaveOptions\": \"{ \\\"ConformanceLevel\\\": \\\"PdfA3a\\\", \\\"Version\\\": \\\"PDF_1_7\\\", \\\"ImageDpi\\\": 750 }\",\n \"salesforce\": {\n \"networkId\": \"{{siteId}}\",\n \"fileId\": \"{{targetFileId}}\",\n \"fileType\": \"File\",\n \"fileParentId\": \"{{recordId}}\",\n \"ownerId\": \"{{ownerUserId}}\"\n },\n \"onedrive\": {\n \"viewAnonymous\": true,\n \"editAnonymous\": true,\n \"editUsers\": [\n \"user@example.com\"\n ],\n \"viewUsers\": [\n \"user@example.com\"\n ]\n }\n }\n },\n \"data\": {\n \"embedded\": \"key:value\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"response": [
{
"id": "bf8abadb-153a-42a5-a007-1ab7c896cec7",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"documents",
"document",
"merge",
"async"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"description": {
"content": "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. (This can only be one of {{clientToken}})",
"type": "text/plain"
},
"key": "X-Client-Authorization",
"value": ""
},
{
"description": {
"content": "Encrypted (AES) JWT token to represent a user that doesn’t have a Microsoft Account and that is allowed to use the subscription. (This can only be one of {{secretToken}})",
"type": "text/plain"
},
"key": "X-Service-Authorization",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"externalContext\": {\n \"id\": \"{{yourExternalContextId}}\"\n },\n \"sourceDocuments\": [\n {\n \"urn\": \"{{document1URN}}\",\n \"loadMethod\": \"Storage\",\n \"order\": 1,\n \"remove\": \"none\"\n },\n {\n \"urn\": \"{{document2URN}}\",\n \"loadMethod\": \"Storage\",\n \"order\": 2,\n \"remove\": \"none\"\n }\n ],\n \"targetDocument\": {\n \"name\": \"{{documentName}}\",\n \"fileFormat\": \"pdf\",\n \"deliveryMethod\": \"Storage\",\n \"path\": \"root\",\n \"options\": {\n \"pdfSaveOptions\": \"{ \\\"ConformanceLevel\\\": \\\"PdfA3a\\\", \\\"Version\\\": \\\"PDF_1_7\\\", \\\"ImageDpi\\\": 750 }\",\n \"salesforce\": {\n \"networkId\": \"{{siteId}}\",\n \"fileId\": \"{{targetFileId}}\",\n \"fileType\": \"File\",\n \"fileParentId\": \"{{recordId}}\",\n \"ownerId\": \"{{ownerUserId}}\"\n },\n \"onedrive\": {\n \"viewAnonymous\": true,\n \"editAnonymous\": true,\n \"editUsers\": [\n \"user@example.com\"\n ],\n \"viewUsers\": [\n \"user@example.com\"\n ]\n }\n }\n },\n \"data\": {\n \"embedded\": \"key:value\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "Created",
"code": 201,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": \"201\",\n \"message\": \"Created\",\n \"data\": {\n \"document\": {\n \"deliveryMethod\": \"{{deliveryMethod}}\",\n \"name\": \"{{documentName}}\",\n \"fileFormat\": \"{{fileFormat}}\",\n \"urn\": \"{{documentURN}}:{{documentName}}.{{fileFormat}}\"\n }\n }\n },\n \"consumption\": [\n {\n \"dimension\": \"pages-merged\",\n \"value\": \"\"\n },\n {\n \"dimension\": \"documents-merged\",\n \"value\": \"\"\n }\n ],\n \"externalContext\": {\n \"actionRequestId\": \"{{externalContextId}}\"\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\",\n \"userId\": \"{{userId}}\",\n \"operationId\": \"{{operationId}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "b5da215d-e0ed-4265-9df9-8166d7073981",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"documents",
"document",
"merge",
"async"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"description": {
"content": "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. (This can only be one of {{clientToken}})",
"type": "text/plain"
},
"key": "X-Client-Authorization",
"value": ""
},
{
"description": {
"content": "Encrypted (AES) JWT token to represent a user that doesn’t have a Microsoft Account and that is allowed to use the subscription. (This can only be one of {{secretToken}})",
"type": "text/plain"
},
"key": "X-Service-Authorization",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"externalContext\": {\n \"id\": \"{{yourExternalContextId}}\"\n },\n \"sourceDocuments\": [\n {\n \"urn\": \"{{document1URN}}\",\n \"loadMethod\": \"Storage\",\n \"order\": 1,\n \"remove\": \"none\"\n },\n {\n \"urn\": \"{{document2URN}}\",\n \"loadMethod\": \"Storage\",\n \"order\": 2,\n \"remove\": \"none\"\n }\n ],\n \"targetDocument\": {\n \"name\": \"{{documentName}}\",\n \"fileFormat\": \"pdf\",\n \"deliveryMethod\": \"Storage\",\n \"path\": \"root\",\n \"options\": {\n \"pdfSaveOptions\": \"{ \\\"ConformanceLevel\\\": \\\"PdfA3a\\\", \\\"Version\\\": \\\"PDF_1_7\\\", \\\"ImageDpi\\\": 750 }\",\n \"salesforce\": {\n \"networkId\": \"{{siteId}}\",\n \"fileId\": \"{{targetFileId}}\",\n \"fileType\": \"File\",\n \"fileParentId\": \"{{recordId}}\",\n \"ownerId\": \"{{ownerUserId}}\"\n },\n \"onedrive\": {\n \"viewAnonymous\": true,\n \"editAnonymous\": true,\n \"editUsers\": [\n \"user@example.com\"\n ],\n \"viewUsers\": [\n \"user@example.com\"\n ]\n }\n }\n },\n \"data\": {\n \"embedded\": \"key:value\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\",\n \"eventId\": \"{{eventId}}\"\n }\n ],\n \"externalErrors\": []\n },\n \"externalContext\": {\n \"actionRequestId\": \"{{externalContextId}}\"\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\",\n \"userId\": \"{{userId}}\",\n \"operationId\": \"{{operationId}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "c3ba94bd-4636-4d12-9569-28edb5e5ccb0",
"name": "Document Manage Async",
"request": {
"name": "Document Manage Async",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"documents",
"document",
"manage",
"async"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"description": {
"content": "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. (This can only be one of {{clientToken}})",
"type": "text/plain"
},
"key": "X-Client-Authorization",
"value": ""
},
{
"description": {
"content": "Encrypted (AES) JWT token to represent a user that doesn’t have a Microsoft Account and that is allowed to use the subscription. (This can only be one of {{secretToken}})",
"type": "text/plain"
},
"key": "X-Service-Authorization",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"externalContext\": {\n \"id\": \"{{yourExternalContextId}}\"\n },\n \"sourceDocument\": {\n \"urn\": \"{{documentURN}}\",\n \"fileFormat\": \"docx\",\n \"loadMethod\": \"Storage\",\n \"remove\": \"none\",\n \"options\": {\n \"docxLoadOptions\": \"{ \\\"PreserveUnsupportedFeatures\\\": true }\"\n }\n },\n \"targetDocument\": {\n \"name\": \"{{documentName}}\",\n \"fileFormat\": \"docx\",\n \"deliveryMethod\": \"Storage\",\n \"path\": \"root\",\n \"options\": {\n \"pdfSaveOptions\": \"{ \\\"ConformanceLevel\\\": \\\"PdfA3a\\\", \\\"Version\\\": \\\"PDF_1_7\\\", \\\"ImageDpi\\\": 750 }\",\n \"docxSaveOptions\": \"{}\",\n \"salesforce\": {\n \"networkId\": \"{{siteId}}\",\n \"fileId\": \"{{targetFileId}}\",\n \"fileType\": \"File\",\n \"fileParentId\": \"{{recordId}}\",\n \"ownerId\": \"{{ownerUserId}}\"\n },\n \"onedrive\": {\n \"viewAnonymous\": true,\n \"editAnonymous\": true,\n \"editUsers\": [\n \"user@example.com\"\n ],\n \"viewUsers\": [\n \"user@example.com\"\n ]\n },\n \"googleDrive\": {\n \"viewAnonymous\": true,\n \"editAnonymous\": true,\n \"editUsers\": [\n \"user@example.com\"\n ],\n \"viewUsers\": [\n \"user@example.com\"\n ]\n }\n }\n },\n \"data\": {\n \"embedded\": \"key:value\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"response": [
{
"id": "2227a809-c033-4c50-ab1a-873e3bf5f4fd",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"documents",
"document",
"manage",
"async"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"description": {
"content": "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. (This can only be one of {{clientToken}})",
"type": "text/plain"
},
"key": "X-Client-Authorization",
"value": ""
},
{
"description": {
"content": "Encrypted (AES) JWT token to represent a user that doesn’t have a Microsoft Account and that is allowed to use the subscription. (This can only be one of {{secretToken}})",
"type": "text/plain"
},
"key": "X-Service-Authorization",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"externalContext\": {\n \"id\": \"{{yourExternalContextId}}\"\n },\n \"sourceDocument\": {\n \"urn\": \"{{documentURN}}\",\n \"fileFormat\": \"docx\",\n \"loadMethod\": \"Storage\",\n \"remove\": \"none\",\n \"options\": {\n \"docxLoadOptions\": \"{ \\\"PreserveUnsupportedFeatures\\\": true }\"\n }\n },\n \"targetDocument\": {\n \"name\": \"{{documentName}}\",\n \"fileFormat\": \"docx\",\n \"deliveryMethod\": \"Storage\",\n \"path\": \"root\",\n \"options\": {\n \"pdfSaveOptions\": \"{ \\\"ConformanceLevel\\\": \\\"PdfA3a\\\", \\\"Version\\\": \\\"PDF_1_7\\\", \\\"ImageDpi\\\": 750 }\",\n \"docxSaveOptions\": \"{}\",\n \"salesforce\": {\n \"networkId\": \"{{siteId}}\",\n \"fileId\": \"{{targetFileId}}\",\n \"fileType\": \"File\",\n \"fileParentId\": \"{{recordId}}\",\n \"ownerId\": \"{{ownerUserId}}\"\n },\n \"onedrive\": {\n \"viewAnonymous\": true,\n \"editAnonymous\": true,\n \"editUsers\": [\n \"user@example.com\"\n ],\n \"viewUsers\": [\n \"user@example.com\"\n ]\n },\n \"googleDrive\": {\n \"viewAnonymous\": true,\n \"editAnonymous\": true,\n \"editUsers\": [\n \"user@example.com\"\n ],\n \"viewUsers\": [\n \"user@example.com\"\n ]\n }\n }\n },\n \"data\": {\n \"embedded\": \"key:value\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "Created",
"code": 201,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": \"201\",\n \"message\": \"Created\",\n \"data\": {\n \"document\": {\n \"deliveryMethod\": \"{{deliveryMethod}}\",\n \"name\": \"{{documentName}}\",\n \"fileFormat\": \"{{fileFormat}}\",\n \"urn\": \"{{documentURN}}:{{documentName}}.{{fileFormat}}\"\n }\n }\n },\n \"consumption\": [\n {\n \"dimension\": \"pages-managed\",\n \"value\": \"\"\n },\n {\n \"dimension\": \"documents-managed\",\n \"value\": \"\"\n }\n ],\n \"externalContext\": {\n \"actionRequestId\": \"{{externalContextId}}\"\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\",\n \"userId\": \"{{userId}}\",\n \"operationId\": \"{{operationId}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "4154c4f7-61dc-4ad6-9326-d1c503c3d075",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"documents",
"document",
"manage",
"async"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"description": {
"content": "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. (This can only be one of {{clientToken}})",
"type": "text/plain"
},
"key": "X-Client-Authorization",
"value": ""
},
{
"description": {
"content": "Encrypted (AES) JWT token to represent a user that doesn’t have a Microsoft Account and that is allowed to use the subscription. (This can only be one of {{secretToken}})",
"type": "text/plain"
},
"key": "X-Service-Authorization",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"externalContext\": {\n \"id\": \"{{yourExternalContextId}}\"\n },\n \"sourceDocument\": {\n \"urn\": \"{{documentURN}}\",\n \"fileFormat\": \"docx\",\n \"loadMethod\": \"Storage\",\n \"remove\": \"none\",\n \"options\": {\n \"docxLoadOptions\": \"{ \\\"PreserveUnsupportedFeatures\\\": true }\"\n }\n },\n \"targetDocument\": {\n \"name\": \"{{documentName}}\",\n \"fileFormat\": \"docx\",\n \"deliveryMethod\": \"Storage\",\n \"path\": \"root\",\n \"options\": {\n \"pdfSaveOptions\": \"{ \\\"ConformanceLevel\\\": \\\"PdfA3a\\\", \\\"Version\\\": \\\"PDF_1_7\\\", \\\"ImageDpi\\\": 750 }\",\n \"docxSaveOptions\": \"{}\",\n \"salesforce\": {\n \"networkId\": \"{{siteId}}\",\n \"fileId\": \"{{targetFileId}}\",\n \"fileType\": \"File\",\n \"fileParentId\": \"{{recordId}}\",\n \"ownerId\": \"{{ownerUserId}}\"\n },\n \"onedrive\": {\n \"viewAnonymous\": true,\n \"editAnonymous\": true,\n \"editUsers\": [\n \"user@example.com\"\n ],\n \"viewUsers\": [\n \"user@example.com\"\n ]\n },\n \"googleDrive\": {\n \"viewAnonymous\": true,\n \"editAnonymous\": true,\n \"editUsers\": [\n \"user@example.com\"\n ],\n \"viewUsers\": [\n \"user@example.com\"\n ]\n }\n }\n },\n \"data\": {\n \"embedded\": \"key:value\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\",\n \"eventId\": \"{{eventId}}\"\n }\n ],\n \"externalErrors\": []\n },\n \"externalContext\": {\n \"actionRequestId\": \"{{externalContextId}}\"\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\",\n \"userId\": \"{{userId}}\",\n \"operationId\": \"{{operationId}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "856366db-47f1-4a55-8cab-c01fd7fb437b",
"name": "Document Upload",
"request": {
"name": "Document Upload",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"documents",
"document",
"upload"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {}
},
"response": [
{
"id": "640464ef-25ca-4723-a58f-5c74cd56e923",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"documents",
"document",
"upload"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {}
},
"status": "Created",
"code": 201,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"data\": {\n \"files\": [\n {\n \"id\": \"{{uploadedFileId}}\",\n \"fileName\": \"{{uploadedFileName}}\"\n }\n ]\n },\n \"statusCode\": 201,\n \"message\": \"Created\"\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\",\n \"operationId\": \"{{operationId}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "bb63d430-d6e7-4f2e-9bf7-6825192657fb",
"name": "Document Reference",
"request": {
"name": "Document Reference",
"description": {
"content": "Document Reference",
"type": "text/plain"
},
"url": {
"path": [
"documents",
"document",
"reference"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"method": "POST",
"body": {}
},
"response": [
{
"id": "4ea13c21-f9ca-48ad-b2dd-394d13a00fb3",
"name": "200",
"originalRequest": {
"url": {
"path": [
"documents",
"document",
"reference"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"method": "POST",
"body": {}
},
"status": "OK",
"code": 200,
"header": [],
"cookie": [],
"_postman_previewlanguage": "text"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "e8df3d3b-dc19-465e-b2c9-eb90d6c71f55",
"name": "Document Create",
"request": {
"name": "Document Create",
"description": {
"content": "Creates a new document record or metadata entry in the system.",
"type": "text/plain"
},
"url": {
"path": [
"documents",
"document",
"create"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"documentGuid\": \"string\",\n \"subscriptionGuid\": \"string\",\n \"ownerGuid\": \"string\",\n \"lastModifiedUserGuid\": \"string\",\n \"title\": \"string\",\n \"urn\": \"string\",\n \"url\": \"string\",\n \"path\": \"string\",\n \"fileFormat\": \"string\",\n \"deliveryMethod\": \"string\",\n \"viewAnonymousLink\": \"string\",\n \"editAnonymousLink\": \"string\",\n \"viewUserLink\": \"string\",\n \"editUserLink\": \"string\",\n \"viewOrganizationLink\": \"string\",\n \"editOrganizationLink\": \"string\",\n \"succeededViewUserEmailList\": \"string\",\n \"succeededEditUserEmailList\": \"string\",\n \"failedViewUserEmailList\": \"string\",\n \"failedEditUserEmailList\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\",\n \"isDeleted\": true\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"response": [
{
"id": "f3690fa9-07d1-46c7-a5ea-afa6b1bd56c8",
"name": "Document record created successfully.",
"originalRequest": {
"url": {
"path": [
"documents",
"document",
"create"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"documentGuid\": \"string\",\n \"subscriptionGuid\": \"string\",\n \"ownerGuid\": \"string\",\n \"lastModifiedUserGuid\": \"string\",\n \"title\": \"string\",\n \"urn\": \"string\",\n \"url\": \"string\",\n \"path\": \"string\",\n \"fileFormat\": \"string\",\n \"deliveryMethod\": \"string\",\n \"viewAnonymousLink\": \"string\",\n \"editAnonymousLink\": \"string\",\n \"viewUserLink\": \"string\",\n \"editUserLink\": \"string\",\n \"viewOrganizationLink\": \"string\",\n \"editOrganizationLink\": \"string\",\n \"succeededViewUserEmailList\": \"string\",\n \"succeededEditUserEmailList\": \"string\",\n \"failedViewUserEmailList\": \"string\",\n \"failedEditUserEmailList\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\",\n \"isDeleted\": true\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"document\": {\n \"documentGuid\": \"string\",\n \"subscriptionGuid\": \"string\",\n \"ownerGuid\": \"string\",\n \"lastModifiedUserGuid\": \"string\",\n \"title\": \"string\",\n \"urn\": \"string\",\n \"url\": \"string\",\n \"path\": \"string\",\n \"fileFormat\": \"string\",\n \"deliveryMethod\": \"string\",\n \"viewAnonymousLink\": \"string\",\n \"editAnonymousLink\": \"string\",\n \"viewUserLink\": \"string\",\n \"editUserLink\": \"string\",\n \"viewOrganizationLink\": \"string\",\n \"editOrganizationLink\": \"string\",\n \"succeededViewUserEmailList\": \"string\",\n \"succeededEditUserEmailList\": \"string\",\n \"failedViewUserEmailList\": \"string\",\n \"failedEditUserEmailList\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\",\n \"isDeleted\": true\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "5a0f473d-fac9-46cf-bf3e-c55b63e65acf",
"name": "Document Delete",
"request": {
"name": "Document Delete",
"description": {
"content": "Deletes a specific document record from the system.",
"type": "text/plain"
},
"url": {
"path": [
"documents",
"document",
":documentGuid",
"delete"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "eee87915-328e-d59f-cc55-1f881f1ebb9c",
"key": "documentGuid",
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the document to delete.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "DELETE",
"body": {}
},
"response": [
{
"id": "d35acf74-ea41-4766-a13c-2251e2199de3",
"name": "Document record deleted successfully.",
"originalRequest": {
"url": {
"path": [
"documents",
"document",
":documentGuid",
"delete"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the document to delete.",
"type": "text/plain"
},
"type": "any",
"value": "eee87915-328e-d59f-cc55-1f881f1ebb9c",
"key": "documentGuid"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "DELETE",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"documentGuid\": \"string\",\n \"message\": \"Document deleted successfully.\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "9a532ccd-5214-40eb-acfd-1aabc6d17b7c",
"name": "Document Get",
"request": {
"name": "Document Get",
"description": {
"content": "Retrieves the metadata and details of a specific document using its unique GUID.",
"type": "text/plain"
},
"url": {
"path": [
"documents",
"document",
":documentGuid",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "eee87915-328e-d59f-cc55-1f881f1ebb9c",
"key": "documentGuid",
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the document.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"response": [
{
"id": "0032c704-846e-4de4-bdde-5a34a8320de2",
"name": "Document metadata retrieved successfully.",
"originalRequest": {
"url": {
"path": [
"documents",
"document",
":documentGuid",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the document.",
"type": "text/plain"
},
"type": "any",
"value": "eee87915-328e-d59f-cc55-1f881f1ebb9c",
"key": "documentGuid"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"document\": {\n \"documentGuid\": \"string\",\n \"subscriptionGuid\": \"string\",\n \"ownerGuid\": \"string\",\n \"lastModifiedUserGuid\": \"string\",\n \"title\": \"string\",\n \"urn\": \"string\",\n \"url\": \"string\",\n \"path\": \"string\",\n \"fileFormat\": \"string\",\n \"deliveryMethod\": \"string\",\n \"viewAnonymousLink\": \"string\",\n \"editAnonymousLink\": \"string\",\n \"viewUserLink\": \"string\",\n \"editUserLink\": \"string\",\n \"viewOrganizationLink\": \"string\",\n \"editOrganizationLink\": \"string\",\n \"succeededViewUserEmailList\": \"string\",\n \"succeededEditUserEmailList\": \"string\",\n \"failedViewUserEmailList\": \"string\",\n \"failedEditUserEmailList\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\",\n \"isDeleted\": true\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "990d964a-22fc-4e97-9639-f51624539108",
"name": "Document List",
"request": {
"name": "Document List",
"description": {
"content": "Retrieves a paginated list of all document records in the system.",
"type": "text/plain"
},
"url": {
"path": [
"documents",
"document",
"list"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "Number of records to retrieve (for pagination).",
"type": "text/plain"
},
"key": "top",
"value": "9511"
},
{
"disabled": false,
"description": {
"content": "Number of records to skip (for pagination).",
"type": "text/plain"
},
"key": "skip",
"value": "9511"
},
{
"disabled": false,
"description": {
"content": "Field name to sort by.",
"type": "text/plain"
},
"key": "sort",
"value": "string"
},
{
"disabled": false,
"description": {
"content": "Sort order (e.g., asc or desc).",
"type": "text/plain"
},
"key": "order",
"value": "string"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"response": [
{
"id": "6eeb3c0c-1065-4417-8c92-be6f2e5e9245",
"name": "List of documents retrieved successfully.",
"originalRequest": {
"url": {
"path": [
"documents",
"document",
"list"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "Number of records to retrieve (for pagination).",
"type": "text/plain"
},
"key": "top",
"value": "9511"
},
{
"disabled": false,
"description": {
"content": "Number of records to skip (for pagination).",
"type": "text/plain"
},
"key": "skip",
"value": "9511"
},
{
"disabled": false,
"description": {
"content": "Field name to sort by.",
"type": "text/plain"
},
"key": "sort",
"value": "string"
},
{
"disabled": false,
"description": {
"content": "Sort order (e.g., asc or desc).",
"type": "text/plain"
},
"key": "order",
"value": "string"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"documents\": [\n {\n \"documentGuid\": \"string\",\n \"subscriptionGuid\": \"string\",\n \"ownerGuid\": \"string\",\n \"lastModifiedUserGuid\": \"string\",\n \"title\": \"string\",\n \"urn\": \"string\",\n \"url\": \"string\",\n \"path\": \"string\",\n \"fileFormat\": \"string\",\n \"deliveryMethod\": \"string\",\n \"viewAnonymousLink\": \"string\",\n \"editAnonymousLink\": \"string\",\n \"viewUserLink\": \"string\",\n \"editUserLink\": \"string\",\n \"viewOrganizationLink\": \"string\",\n \"editOrganizationLink\": \"string\",\n \"succeededViewUserEmailList\": \"string\",\n \"succeededEditUserEmailList\": \"string\",\n \"failedViewUserEmailList\": \"string\",\n \"failedEditUserEmailList\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\",\n \"isDeleted\": true\n }\n ],\n \"rowCount\": 0\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "b99d43a5-d0a6-4caf-842d-323a11138609",
"name": "Document Update",
"request": {
"name": "Document Update",
"description": {
"content": "Updates the properties or metadata of an existing document record.",
"type": "text/plain"
},
"url": {
"path": [
"documents",
"document",
":documentGuid",
"update"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "eee87915-328e-d59f-cc55-1f881f1ebb9c",
"key": "documentGuid",
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the document to update.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"documentGuid\": \"string\",\n \"subscriptionGuid\": \"string\",\n \"ownerGuid\": \"string\",\n \"lastModifiedUserGuid\": \"string\",\n \"title\": \"string\",\n \"urn\": \"string\",\n \"url\": \"string\",\n \"path\": \"string\",\n \"fileFormat\": \"string\",\n \"deliveryMethod\": \"string\",\n \"viewAnonymousLink\": \"string\",\n \"editAnonymousLink\": \"string\",\n \"viewUserLink\": \"string\",\n \"editUserLink\": \"string\",\n \"viewOrganizationLink\": \"string\",\n \"editOrganizationLink\": \"string\",\n \"succeededViewUserEmailList\": \"string\",\n \"succeededEditUserEmailList\": \"string\",\n \"failedViewUserEmailList\": \"string\",\n \"failedEditUserEmailList\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\",\n \"isDeleted\": true\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"response": [
{
"id": "c1904154-02ab-49aa-82bc-f2e47874a6a2",
"name": "Document record updated successfully.",
"originalRequest": {
"url": {
"path": [
"documents",
"document",
":documentGuid",
"update"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the document to update.",
"type": "text/plain"
},
"type": "any",
"value": "eee87915-328e-d59f-cc55-1f881f1ebb9c",
"key": "documentGuid"
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"documentGuid\": \"string\",\n \"subscriptionGuid\": \"string\",\n \"ownerGuid\": \"string\",\n \"lastModifiedUserGuid\": \"string\",\n \"title\": \"string\",\n \"urn\": \"string\",\n \"url\": \"string\",\n \"path\": \"string\",\n \"fileFormat\": \"string\",\n \"deliveryMethod\": \"string\",\n \"viewAnonymousLink\": \"string\",\n \"editAnonymousLink\": \"string\",\n \"viewUserLink\": \"string\",\n \"editUserLink\": \"string\",\n \"viewOrganizationLink\": \"string\",\n \"editOrganizationLink\": \"string\",\n \"succeededViewUserEmailList\": \"string\",\n \"succeededEditUserEmailList\": \"string\",\n \"failedViewUserEmailList\": \"string\",\n \"failedEditUserEmailList\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\",\n \"isDeleted\": true\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"document\": {\n \"documentGuid\": \"string\",\n \"subscriptionGuid\": \"string\",\n \"ownerGuid\": \"string\",\n \"lastModifiedUserGuid\": \"string\",\n \"title\": \"string\",\n \"urn\": \"string\",\n \"url\": \"string\",\n \"path\": \"string\",\n \"fileFormat\": \"string\",\n \"deliveryMethod\": \"string\",\n \"viewAnonymousLink\": \"string\",\n \"editAnonymousLink\": \"string\",\n \"viewUserLink\": \"string\",\n \"editUserLink\": \"string\",\n \"viewOrganizationLink\": \"string\",\n \"editOrganizationLink\": \"string\",\n \"succeededViewUserEmailList\": \"string\",\n \"succeededEditUserEmailList\": \"string\",\n \"failedViewUserEmailList\": \"string\",\n \"failedEditUserEmailList\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\",\n \"isDeleted\": true\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
}
]
},
{
"name": "Template",
"description": "",
"item": [
{
"id": "52e1416a-c673-4311-b197-1895be3cdd0f",
"name": "Template Upload",
"request": {
"name": "Template Upload",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"documents",
"template",
"upload"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {}
},
"response": [
{
"id": "93095224-68c7-47cd-8429-47918bb85972",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"documents",
"template",
"upload"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {}
},
"status": "Created",
"code": 201,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"data\": {\n \"files\": [\n {\n \"id\": \"{{uploadedTemplateId}}\",\n \"fileName\": \"{{uploadedTemplateName}}\"\n }\n ]\n },\n \"statusCode\": 201,\n \"message\": \"Created\"\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\",\n \"operationId\": \"{{operationId}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "adfb99bc-5f6d-436c-9aa3-32f4c22e8a62",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"documents",
"template",
"upload"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "6b103e13-f155-47ff-8a00-d5e8ecd7fa49",
"name": "Template Create",
"request": {
"name": "Template Create",
"description": {
"content": "Creates a new template definition or metadata record.",
"type": "text/plain"
},
"url": {
"path": [
"documents",
"template",
"create"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"documentTemplateGuid\": \"string\",\n \"subscriptionGuid\": \"string\",\n \"ownerGuid\": \"string\",\n \"lastModifiedUserGuid\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"title\": \"string\",\n \"urn\": \"string\",\n \"url\": \"string\",\n \"viewAnonymousLink\": \"string\",\n \"editAnonymousLink\": \"string\",\n \"viewUserLink\": \"string\",\n \"editUserLink\": \"string\",\n \"viewOrganizationLink\": \"string\",\n \"editOrganizationLink\": \"string\",\n \"fileFormat\": \"string\",\n \"loadMethod\": \"string\",\n \"path\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\",\n \"isDeleted\": true\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"response": [
{
"id": "b5826940-f4bb-447d-a5c2-ce49d4abd4cf",
"name": "Template definition created successfully.",
"originalRequest": {
"url": {
"path": [
"documents",
"template",
"create"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"documentTemplateGuid\": \"string\",\n \"subscriptionGuid\": \"string\",\n \"ownerGuid\": \"string\",\n \"lastModifiedUserGuid\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"title\": \"string\",\n \"urn\": \"string\",\n \"url\": \"string\",\n \"viewAnonymousLink\": \"string\",\n \"editAnonymousLink\": \"string\",\n \"viewUserLink\": \"string\",\n \"editUserLink\": \"string\",\n \"viewOrganizationLink\": \"string\",\n \"editOrganizationLink\": \"string\",\n \"fileFormat\": \"string\",\n \"loadMethod\": \"string\",\n \"path\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\",\n \"isDeleted\": true\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"documentTemplate\": {\n \"documentTemplateGuid\": \"string\",\n \"subscriptionGuid\": \"string\",\n \"ownerGuid\": \"string\",\n \"lastModifiedUserGuid\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"title\": \"string\",\n \"urn\": \"string\",\n \"url\": \"string\",\n \"viewAnonymousLink\": \"string\",\n \"editAnonymousLink\": \"string\",\n \"viewUserLink\": \"string\",\n \"editUserLink\": \"string\",\n \"viewOrganizationLink\": \"string\",\n \"editOrganizationLink\": \"string\",\n \"fileFormat\": \"string\",\n \"loadMethod\": \"string\",\n \"path\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\",\n \"isDeleted\": true\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "129f5e19-ae3c-4319-a633-1cf63ef65025",
"name": "Template Delete",
"request": {
"name": "Template Delete",
"description": {
"content": "Deletes a specific template definition from the system.",
"type": "text/plain"
},
"url": {
"path": [
"documents",
"template",
":documentTemplateGuid",
"delete"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "eee87915-328e-d59f-cc55-1f881f1ebb9c",
"key": "documentTemplateGuid",
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the template to delete.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "DELETE",
"body": {}
},
"response": [
{
"id": "d6b24d86-6b7b-4386-9ed8-cfbd1b7d990e",
"name": "Template deleted successfully.",
"originalRequest": {
"url": {
"path": [
"documents",
"template",
":documentTemplateGuid",
"delete"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the template to delete.",
"type": "text/plain"
},
"type": "any",
"value": "eee87915-328e-d59f-cc55-1f881f1ebb9c",
"key": "documentTemplateGuid"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "DELETE",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"documentTemplateGuid\": \"string\",\n \"message\": \"DocumentTemplate deleted successfully.\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "49945f92-c7dc-451a-a592-30e547d2d55b",
"name": "Template Get",
"request": {
"name": "Template Get",
"description": {
"content": "Retrieves the metadata and details of a specific template record using its unique GUID.",
"type": "text/plain"
},
"url": {
"path": [
"documents",
"template",
":documentTemplateGuid",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "eee87915-328e-d59f-cc55-1f881f1ebb9c",
"key": "documentTemplateGuid",
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the document template.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"response": [
{
"id": "c0ea49c6-2559-427b-bef0-834525dcfbe7",
"name": "Template metadata retrieved successfully.",
"originalRequest": {
"url": {
"path": [
"documents",
"template",
":documentTemplateGuid",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the document template.",
"type": "text/plain"
},
"type": "any",
"value": "eee87915-328e-d59f-cc55-1f881f1ebb9c",
"key": "documentTemplateGuid"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"documentTemplate\": {\n \"documentTemplateGuid\": \"string\",\n \"subscriptionGuid\": \"string\",\n \"ownerGuid\": \"string\",\n \"lastModifiedUserGuid\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"title\": \"string\",\n \"urn\": \"string\",\n \"url\": \"string\",\n \"viewAnonymousLink\": \"string\",\n \"editAnonymousLink\": \"string\",\n \"viewUserLink\": \"string\",\n \"editUserLink\": \"string\",\n \"viewOrganizationLink\": \"string\",\n \"editOrganizationLink\": \"string\",\n \"fileFormat\": \"string\",\n \"loadMethod\": \"string\",\n \"path\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\",\n \"isDeleted\": true\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "fa6fb15c-7c7d-4812-9338-c441e6376c47",
"name": "Template List",
"request": {
"name": "Template List",
"description": {
"content": "Retrieves a paginated list of all available template definitions in the system.",
"type": "text/plain"
},
"url": {
"path": [
"documents",
"template",
"list"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "Number of records to retrieve (for pagination).",
"type": "text/plain"
},
"key": "top",
"value": "9511"
},
{
"disabled": false,
"description": {
"content": "Number of records to skip (for pagination).",
"type": "text/plain"
},
"key": "skip",
"value": "9511"
},
{
"disabled": false,
"description": {
"content": "Field name to sort by.",
"type": "text/plain"
},
"key": "sort",
"value": "string"
},
{
"disabled": false,
"description": {
"content": "Sort order (e.g., asc or desc).",
"type": "text/plain"
},
"key": "order",
"value": "string"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"response": [
{
"id": "a3709c25-24eb-4cb7-a6ba-92bd67e909ba",
"name": "List of templates retrieved successfully.",
"originalRequest": {
"url": {
"path": [
"documents",
"template",
"list"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "Number of records to retrieve (for pagination).",
"type": "text/plain"
},
"key": "top",
"value": "9511"
},
{
"disabled": false,
"description": {
"content": "Number of records to skip (for pagination).",
"type": "text/plain"
},
"key": "skip",
"value": "9511"
},
{
"disabled": false,
"description": {
"content": "Field name to sort by.",
"type": "text/plain"
},
"key": "sort",
"value": "string"
},
{
"disabled": false,
"description": {
"content": "Sort order (e.g., asc or desc).",
"type": "text/plain"
},
"key": "order",
"value": "string"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"documentTemplates\": [\n {\n \"documentTemplateGuid\": \"string\",\n \"subscriptionGuid\": \"string\",\n \"ownerGuid\": \"string\",\n \"lastModifiedUserGuid\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"title\": \"string\",\n \"urn\": \"string\",\n \"url\": \"string\",\n \"viewAnonymousLink\": \"string\",\n \"editAnonymousLink\": \"string\",\n \"viewUserLink\": \"string\",\n \"editUserLink\": \"string\",\n \"viewOrganizationLink\": \"string\",\n \"editOrganizationLink\": \"string\",\n \"fileFormat\": \"string\",\n \"loadMethod\": \"string\",\n \"path\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\",\n \"isDeleted\": true\n }\n ],\n \"rowCount\": 0\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "3f3a825f-b176-4f0f-8473-35161f595e45",
"name": "Template Update",
"request": {
"name": "Template Update",
"description": {
"content": "Updates the metadata, parameters, or configurations of an existing template.",
"type": "text/plain"
},
"url": {
"path": [
"documents",
"template",
":documentTemplateGuid",
"update"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "eee87915-328e-d59f-cc55-1f881f1ebb9c",
"key": "documentTemplateGuid",
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the template to update.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"documentTemplateGuid\": \"string\",\n \"subscriptionGuid\": \"string\",\n \"ownerGuid\": \"string\",\n \"lastModifiedUserGuid\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"title\": \"string\",\n \"urn\": \"string\",\n \"url\": \"string\",\n \"viewAnonymousLink\": \"string\",\n \"editAnonymousLink\": \"string\",\n \"viewUserLink\": \"string\",\n \"editUserLink\": \"string\",\n \"viewOrganizationLink\": \"string\",\n \"editOrganizationLink\": \"string\",\n \"fileFormat\": \"string\",\n \"loadMethod\": \"string\",\n \"path\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\",\n \"isDeleted\": true\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"response": [
{
"id": "2102f217-894b-46c7-836e-8d79e71d0386",
"name": "Template updated successfully.",
"originalRequest": {
"url": {
"path": [
"documents",
"template",
":documentTemplateGuid",
"update"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the template to update.",
"type": "text/plain"
},
"type": "any",
"value": "eee87915-328e-d59f-cc55-1f881f1ebb9c",
"key": "documentTemplateGuid"
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"documentTemplateGuid\": \"string\",\n \"subscriptionGuid\": \"string\",\n \"ownerGuid\": \"string\",\n \"lastModifiedUserGuid\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"title\": \"string\",\n \"urn\": \"string\",\n \"url\": \"string\",\n \"viewAnonymousLink\": \"string\",\n \"editAnonymousLink\": \"string\",\n \"viewUserLink\": \"string\",\n \"editUserLink\": \"string\",\n \"viewOrganizationLink\": \"string\",\n \"editOrganizationLink\": \"string\",\n \"fileFormat\": \"string\",\n \"loadMethod\": \"string\",\n \"path\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\",\n \"isDeleted\": true\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"documentTemplate\": {\n \"documentTemplateGuid\": \"string\",\n \"subscriptionGuid\": \"string\",\n \"ownerGuid\": \"string\",\n \"lastModifiedUserGuid\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"title\": \"string\",\n \"urn\": \"string\",\n \"url\": \"string\",\n \"viewAnonymousLink\": \"string\",\n \"editAnonymousLink\": \"string\",\n \"viewUserLink\": \"string\",\n \"editUserLink\": \"string\",\n \"viewOrganizationLink\": \"string\",\n \"editOrganizationLink\": \"string\",\n \"fileFormat\": \"string\",\n \"loadMethod\": \"string\",\n \"path\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\",\n \"isDeleted\": true\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
}
]
},
{
"name": "Data",
"description": "",
"item": [
{
"id": "4705b5f9-12d7-4b81-b1b8-b910b8a27ad4",
"name": "Data Upload",
"request": {
"name": "Data Upload",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"documents",
"data",
"upload"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {}
},
"response": [
{
"id": "ae1ce707-bfee-47fb-a91c-96d29c459abb",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"documents",
"data",
"upload"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {}
},
"status": "Created",
"code": 201,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"data\": {\n \"files\": [\n {\n \"id\": \"{{uploadedDataId}}\",\n \"fileName\": \"{{uploadedDataName}}\"\n }\n ]\n },\n \"statusCode\": 201,\n \"message\": \"Created\"\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\",\n \"operationId\": \"{{operationId}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "2b3af49f-a67c-4776-b990-fa31b21402dc",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"documents",
"data",
"upload"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
}
]
},
{
"name": "Data Source",
"description": "",
"item": [
{
"id": "eb352652-9982-4c93-bde1-71fff27b10bd",
"name": "Data Source Create",
"request": {
"name": "Data Source Create",
"description": {
"content": "Creates a new data source configuration to be used in document generation.",
"type": "text/plain"
},
"url": {
"path": [
"documents",
"datasource",
"create"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"dataSourceGuid\": \"string\",\n \"subscriptionGuid\": \"string\",\n \"ownerGuid\": \"string\",\n \"lastModifiedUserGuid\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"urn\": \"string\",\n \"query\": \"string\",\n \"variables\": \"string\",\n \"loadMethod\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\",\n \"isDeleted\": true\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"response": [
{
"id": "559f7267-d1da-4ed2-8407-f76f08e38d12",
"name": "Data source created successfully.",
"originalRequest": {
"url": {
"path": [
"documents",
"datasource",
"create"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"dataSourceGuid\": \"string\",\n \"subscriptionGuid\": \"string\",\n \"ownerGuid\": \"string\",\n \"lastModifiedUserGuid\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"urn\": \"string\",\n \"query\": \"string\",\n \"variables\": \"string\",\n \"loadMethod\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\",\n \"isDeleted\": true\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"dataSourceGuid\": \"string\",\n \"subscriptionGuid\": \"string\",\n \"ownerGuid\": \"string\",\n \"lastModifiedUserGuid\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"urn\": \"string\",\n \"query\": \"string\",\n \"variables\": \"string\",\n \"loadMethod\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\",\n \"isDeleted\": true\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "8ef5a02e-c40f-4810-93ee-c774429eeeed",
"name": "Data Source Delete",
"request": {
"name": "Data Source Delete",
"description": {
"content": "Deletes a specific data source configuration from the system.",
"type": "text/plain"
},
"url": {
"path": [
"documents",
"datasource",
":dataSourceGuid",
"delete"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "eee87915-328e-d59f-cc55-1f881f1ebb9c",
"key": "dataSourceGuid",
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the data source to delete.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "DELETE",
"body": {}
},
"response": [
{
"id": "515aec13-e1ce-4739-b0d5-fa15c38f237a",
"name": "Data source deleted successfully.",
"originalRequest": {
"url": {
"path": [
"documents",
"datasource",
":dataSourceGuid",
"delete"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the data source to delete.",
"type": "text/plain"
},
"type": "any",
"value": "eee87915-328e-d59f-cc55-1f881f1ebb9c",
"key": "dataSourceGuid"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "DELETE",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"dataSourceGuid\": \"string\",\n \"message\": \"Data source deleted successfully.\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "778df9d4-8b3e-494e-947b-fbc11227678d",
"name": "Data Source Get",
"request": {
"name": "Data Source Get",
"description": {
"content": "Retrieves the detailed configuration of a specific data source using its unique GUID.",
"type": "text/plain"
},
"url": {
"path": [
"documents",
"datasource",
":dataSourceGuid",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "eee87915-328e-d59f-cc55-1f881f1ebb9c",
"key": "dataSourceGuid",
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the data source.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"response": [
{
"id": "65c1b436-1a74-4680-af1a-f87665ba93fd",
"name": "Data source retrieved successfully.",
"originalRequest": {
"url": {
"path": [
"documents",
"datasource",
":dataSourceGuid",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the data source.",
"type": "text/plain"
},
"type": "any",
"value": "eee87915-328e-d59f-cc55-1f881f1ebb9c",
"key": "dataSourceGuid"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"dataSourceGuid\": \"string\",\n \"subscriptionGuid\": \"string\",\n \"ownerGuid\": \"string\",\n \"lastModifiedUserGuid\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"urn\": \"string\",\n \"query\": \"string\",\n \"variables\": \"string\",\n \"loadMethod\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\",\n \"isDeleted\": true\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "d27e0c24-eabf-4c22-bac8-3a36f785371e",
"name": "Data Source List",
"request": {
"name": "Data Source List",
"description": {
"content": "Retrieves a paginated list of all available data sources configured in the system.",
"type": "text/plain"
},
"url": {
"path": [
"documents",
"datasource",
"list"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "Number of records to retrieve (for pagination).",
"type": "text/plain"
},
"key": "top",
"value": "9511"
},
{
"disabled": false,
"description": {
"content": "Number of records to skip (for pagination).",
"type": "text/plain"
},
"key": "skip",
"value": "9511"
},
{
"disabled": false,
"description": {
"content": "Field name to sort by.",
"type": "text/plain"
},
"key": "sort",
"value": "string"
},
{
"disabled": false,
"description": {
"content": "Sort order (e.g., asc or desc).",
"type": "text/plain"
},
"key": "order",
"value": "string"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"response": [
{
"id": "65dbe583-d4a7-4cbc-9034-c325c53ee903",
"name": "List of data sources retrieved successfully.",
"originalRequest": {
"url": {
"path": [
"documents",
"datasource",
"list"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "Number of records to retrieve (for pagination).",
"type": "text/plain"
},
"key": "top",
"value": "9511"
},
{
"disabled": false,
"description": {
"content": "Number of records to skip (for pagination).",
"type": "text/plain"
},
"key": "skip",
"value": "9511"
},
{
"disabled": false,
"description": {
"content": "Field name to sort by.",
"type": "text/plain"
},
"key": "sort",
"value": "string"
},
{
"disabled": false,
"description": {
"content": "Sort order (e.g., asc or desc).",
"type": "text/plain"
},
"key": "order",
"value": "string"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"dataSources\": [\n {\n \"dataSourceGuid\": \"string\",\n \"subscriptionGuid\": \"string\",\n \"ownerGuid\": \"string\",\n \"lastModifiedUserGuid\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"urn\": \"string\",\n \"query\": \"string\",\n \"variables\": \"string\",\n \"loadMethod\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\",\n \"isDeleted\": true\n }\n ],\n \"rowCount\": 0\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "790461b0-4a0e-4671-9990-50e2e4da7ae4",
"name": "Data Source Update",
"request": {
"name": "Data Source Update",
"description": {
"content": "Updates the properties of an existing data source configuration.",
"type": "text/plain"
},
"url": {
"path": [
"documents",
"datasource",
":dataSourceGuid",
"update"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "eee87915-328e-d59f-cc55-1f881f1ebb9c",
"key": "dataSourceGuid",
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the data source to update.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"dataSourceGuid\": \"string\",\n \"subscriptionGuid\": \"string\",\n \"ownerGuid\": \"string\",\n \"lastModifiedUserGuid\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"urn\": \"string\",\n \"query\": \"string\",\n \"variables\": \"string\",\n \"loadMethod\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\",\n \"isDeleted\": true\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"response": [
{
"id": "03fd5f11-4d25-4b47-9bf6-13934a4a5d34",
"name": "Data source updated successfully.",
"originalRequest": {
"url": {
"path": [
"documents",
"datasource",
":dataSourceGuid",
"update"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the data source to update.",
"type": "text/plain"
},
"type": "any",
"value": "eee87915-328e-d59f-cc55-1f881f1ebb9c",
"key": "dataSourceGuid"
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"dataSourceGuid\": \"string\",\n \"subscriptionGuid\": \"string\",\n \"ownerGuid\": \"string\",\n \"lastModifiedUserGuid\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"urn\": \"string\",\n \"query\": \"string\",\n \"variables\": \"string\",\n \"loadMethod\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\",\n \"isDeleted\": true\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"dataSourceGuid\": \"string\",\n \"subscriptionGuid\": \"string\",\n \"ownerGuid\": \"string\",\n \"lastModifiedUserGuid\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"urn\": \"string\",\n \"query\": \"string\",\n \"variables\": \"string\",\n \"loadMethod\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\",\n \"isDeleted\": true\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
}
]
},
{
"name": "Document Request",
"description": "",
"item": [
{
"id": "d6832850-32e8-4132-83f1-d59f8d54c6db",
"name": "Document Request Create",
"request": {
"name": "Document Request Create",
"description": {
"content": "Initializes a new document generation request, allowing for tracking of the generation lifecycle.",
"type": "text/plain"
},
"url": {
"path": [
"documents",
"request",
"create"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"documentRequestGuid\": \"string\",\n \"subscriptionGuid\": \"string\",\n \"documentTemplateGuid\": \"string\",\n \"dataGuid\": \"string\",\n \"documentGuid\": \"string\",\n \"documentSolutionConfigurationGuid\": \"string\",\n \"ownerGuid\": \"string\",\n \"lastModifiedUserGuid\": \"string\",\n \"recordId\": \"string\",\n \"name\": \"string\",\n \"status\": \"string\",\n \"embeddedData\": \"string\",\n \"title\": \"string\",\n \"fileFormat\": \"string\",\n \"processingType\": \"string\",\n \"deliveryMethod\": \"string\",\n \"path\": \"string\",\n \"pdfConformanceLevel\": \"string\",\n \"pdfVersion\": \"string\",\n \"language\": \"string\",\n \"locale\": \"string\",\n \"timeZone\": \"string\",\n \"viewAnonymous\": true,\n \"editAnonymous\": true,\n \"viewOrganization\": true,\n \"editOrganization\": true,\n \"viewUser\": true,\n \"editUser\": true,\n \"viewUserEmailList\": \"string\",\n \"editUserEmailList\": \"string\",\n \"createdDate\": \"string\",\n \"completedDate\": \"string\",\n \"lastModifiedDate\": \"string\",\n \"isDeleted\": true\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"response": [
{
"id": "3aa4c646-a0f8-461e-bbe4-f7d510f45cc2",
"name": "Document request created successfully.",
"originalRequest": {
"url": {
"path": [
"documents",
"request",
"create"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"documentRequestGuid\": \"string\",\n \"subscriptionGuid\": \"string\",\n \"documentTemplateGuid\": \"string\",\n \"dataGuid\": \"string\",\n \"documentGuid\": \"string\",\n \"documentSolutionConfigurationGuid\": \"string\",\n \"ownerGuid\": \"string\",\n \"lastModifiedUserGuid\": \"string\",\n \"recordId\": \"string\",\n \"name\": \"string\",\n \"status\": \"string\",\n \"embeddedData\": \"string\",\n \"title\": \"string\",\n \"fileFormat\": \"string\",\n \"processingType\": \"string\",\n \"deliveryMethod\": \"string\",\n \"path\": \"string\",\n \"pdfConformanceLevel\": \"string\",\n \"pdfVersion\": \"string\",\n \"language\": \"string\",\n \"locale\": \"string\",\n \"timeZone\": \"string\",\n \"viewAnonymous\": true,\n \"editAnonymous\": true,\n \"viewOrganization\": true,\n \"editOrganization\": true,\n \"viewUser\": true,\n \"editUser\": true,\n \"viewUserEmailList\": \"string\",\n \"editUserEmailList\": \"string\",\n \"createdDate\": \"string\",\n \"completedDate\": \"string\",\n \"lastModifiedDate\": \"string\",\n \"isDeleted\": true\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"documentRequest\": {\n \"documentRequestGuid\": \"string\",\n \"subscriptionGuid\": \"string\",\n \"documentTemplateGuid\": \"string\",\n \"dataGuid\": \"string\",\n \"documentGuid\": \"string\",\n \"documentSolutionConfigurationGuid\": \"string\",\n \"ownerGuid\": \"string\",\n \"lastModifiedUserGuid\": \"string\",\n \"recordId\": \"string\",\n \"name\": \"string\",\n \"status\": \"string\",\n \"embeddedData\": \"string\",\n \"title\": \"string\",\n \"fileFormat\": \"string\",\n \"processingType\": \"string\",\n \"deliveryMethod\": \"string\",\n \"path\": \"string\",\n \"pdfConformanceLevel\": \"string\",\n \"pdfVersion\": \"string\",\n \"language\": \"string\",\n \"locale\": \"string\",\n \"timeZone\": \"string\",\n \"viewAnonymous\": true,\n \"editAnonymous\": true,\n \"viewOrganization\": true,\n \"editOrganization\": true,\n \"viewUser\": true,\n \"editUser\": true,\n \"viewUserEmailList\": \"string\",\n \"editUserEmailList\": \"string\",\n \"createdDate\": \"string\",\n \"completedDate\": \"string\",\n \"lastModifiedDate\": \"string\",\n \"isDeleted\": true\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "1c13a6ff-69a9-4342-a0f1-1de88c6206b7",
"name": "Document Request Delete",
"request": {
"name": "Document Request Delete",
"description": {
"content": "Cancels and deletes a specific document generation request.",
"type": "text/plain"
},
"url": {
"path": [
"documents",
"request",
":documentRequestGuid",
"delete"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "eee87915-328e-d59f-cc55-1f881f1ebb9c",
"key": "documentRequestGuid",
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the document request to delete.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "DELETE",
"body": {}
},
"response": [
{
"id": "f3e5fc34-68b2-4c16-a2d1-24da70400a78",
"name": "Document request deleted successfully.",
"originalRequest": {
"url": {
"path": [
"documents",
"request",
":documentRequestGuid",
"delete"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the document request to delete.",
"type": "text/plain"
},
"type": "any",
"value": "eee87915-328e-d59f-cc55-1f881f1ebb9c",
"key": "documentRequestGuid"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "DELETE",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"documentRequestGuid\": \"string\",\n \"message\": \"DocumentRequest deleted successfully.\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "3e6a806d-3502-43b6-bc8f-6b03190790d0",
"name": "Document Request Get",
"request": {
"name": "Document Request Get",
"description": {
"content": "Retrieves the current status, details, and metadata of a specific document request using its unique GUID.",
"type": "text/plain"
},
"url": {
"path": [
"documents",
"request",
":documentRequestGuid",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "eee87915-328e-d59f-cc55-1f881f1ebb9c",
"key": "documentRequestGuid",
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the document request.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"response": [
{
"id": "62d70353-7e4f-4e90-b77f-6412304c3ff8",
"name": "Document request details retrieved successfully.",
"originalRequest": {
"url": {
"path": [
"documents",
"request",
":documentRequestGuid",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the document request.",
"type": "text/plain"
},
"type": "any",
"value": "eee87915-328e-d59f-cc55-1f881f1ebb9c",
"key": "documentRequestGuid"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"documentRequest\": {\n \"documentRequestGuid\": \"string\",\n \"subscriptionGuid\": \"string\",\n \"documentTemplateGuid\": \"string\",\n \"dataGuid\": \"string\",\n \"documentGuid\": \"string\",\n \"documentSolutionConfigurationGuid\": \"string\",\n \"ownerGuid\": \"string\",\n \"lastModifiedUserGuid\": \"string\",\n \"recordId\": \"string\",\n \"name\": \"string\",\n \"status\": \"string\",\n \"embeddedData\": \"string\",\n \"title\": \"string\",\n \"fileFormat\": \"string\",\n \"processingType\": \"string\",\n \"deliveryMethod\": \"string\",\n \"path\": \"string\",\n \"pdfConformanceLevel\": \"string\",\n \"pdfVersion\": \"string\",\n \"language\": \"string\",\n \"locale\": \"string\",\n \"timeZone\": \"string\",\n \"viewAnonymous\": true,\n \"editAnonymous\": true,\n \"viewOrganization\": true,\n \"editOrganization\": true,\n \"viewUser\": true,\n \"editUser\": true,\n \"viewUserEmailList\": \"string\",\n \"editUserEmailList\": \"string\",\n \"createdDate\": \"string\",\n \"completedDate\": \"string\",\n \"lastModifiedDate\": \"string\",\n \"isDeleted\": true\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "d9e62b9b-68c0-4c7d-9516-539433f25ba1",
"name": "Document Request List",
"request": {
"name": "Document Request List",
"description": {
"content": "Retrieves a paginated list of all document generation requests, useful for auditing or polling status.",
"type": "text/plain"
},
"url": {
"path": [
"documents",
"request",
"list"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "Number of records to retrieve (for pagination).",
"type": "text/plain"
},
"key": "top",
"value": "9511"
},
{
"disabled": false,
"description": {
"content": "Number of records to skip (for pagination).",
"type": "text/plain"
},
"key": "skip",
"value": "9511"
},
{
"disabled": false,
"description": {
"content": "Field name to sort by.",
"type": "text/plain"
},
"key": "sort",
"value": "string"
},
{
"disabled": false,
"description": {
"content": "Sort order (e.g., asc or desc).",
"type": "text/plain"
},
"key": "order",
"value": "string"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"response": [
{
"id": "6c723e9d-af15-4245-ba57-1f10bc6a78f6",
"name": "List of document requests retrieved successfully.",
"originalRequest": {
"url": {
"path": [
"documents",
"request",
"list"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "Number of records to retrieve (for pagination).",
"type": "text/plain"
},
"key": "top",
"value": "9511"
},
{
"disabled": false,
"description": {
"content": "Number of records to skip (for pagination).",
"type": "text/plain"
},
"key": "skip",
"value": "9511"
},
{
"disabled": false,
"description": {
"content": "Field name to sort by.",
"type": "text/plain"
},
"key": "sort",
"value": "string"
},
{
"disabled": false,
"description": {
"content": "Sort order (e.g., asc or desc).",
"type": "text/plain"
},
"key": "order",
"value": "string"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"documentRequests\": [\n {\n \"documentRequestGuid\": \"string\",\n \"subscriptionGuid\": \"string\",\n \"documentTemplateGuid\": \"string\",\n \"dataGuid\": \"string\",\n \"documentGuid\": \"string\",\n \"documentSolutionConfigurationGuid\": \"string\",\n \"ownerGuid\": \"string\",\n \"lastModifiedUserGuid\": \"string\",\n \"recordId\": \"string\",\n \"name\": \"string\",\n \"status\": \"string\",\n \"embeddedData\": \"string\",\n \"title\": \"string\",\n \"fileFormat\": \"string\",\n \"processingType\": \"string\",\n \"deliveryMethod\": \"string\",\n \"path\": \"string\",\n \"pdfConformanceLevel\": \"string\",\n \"pdfVersion\": \"string\",\n \"language\": \"string\",\n \"locale\": \"string\",\n \"timeZone\": \"string\",\n \"viewAnonymous\": true,\n \"editAnonymous\": true,\n \"viewOrganization\": true,\n \"editOrganization\": true,\n \"viewUser\": true,\n \"editUser\": true,\n \"viewUserEmailList\": \"string\",\n \"editUserEmailList\": \"string\",\n \"createdDate\": \"string\",\n \"completedDate\": \"string\",\n \"lastModifiedDate\": \"string\",\n \"isDeleted\": true\n }\n ],\n \"rowCount\": 0\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "b84f4323-c4e6-4208-9e40-20dff4168325",
"name": "Document Request Update",
"request": {
"name": "Document Request Update",
"description": {
"content": "Updates the status or parameters of an existing document request.",
"type": "text/plain"
},
"url": {
"path": [
"documents",
"request",
":documentRequestGuid",
"update"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "eee87915-328e-d59f-cc55-1f881f1ebb9c",
"key": "documentRequestGuid",
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the document request to update.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"documentRequestGuid\": \"string\",\n \"subscriptionGuid\": \"string\",\n \"documentTemplateGuid\": \"string\",\n \"dataGuid\": \"string\",\n \"documentGuid\": \"string\",\n \"documentSolutionConfigurationGuid\": \"string\",\n \"ownerGuid\": \"string\",\n \"lastModifiedUserGuid\": \"string\",\n \"recordId\": \"string\",\n \"name\": \"string\",\n \"status\": \"string\",\n \"embeddedData\": \"string\",\n \"title\": \"string\",\n \"fileFormat\": \"string\",\n \"processingType\": \"string\",\n \"deliveryMethod\": \"string\",\n \"path\": \"string\",\n \"pdfConformanceLevel\": \"string\",\n \"pdfVersion\": \"string\",\n \"language\": \"string\",\n \"locale\": \"string\",\n \"timeZone\": \"string\",\n \"viewAnonymous\": true,\n \"editAnonymous\": true,\n \"viewOrganization\": true,\n \"editOrganization\": true,\n \"viewUser\": true,\n \"editUser\": true,\n \"viewUserEmailList\": \"string\",\n \"editUserEmailList\": \"string\",\n \"createdDate\": \"string\",\n \"completedDate\": \"string\",\n \"lastModifiedDate\": \"string\",\n \"isDeleted\": true\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"response": [
{
"id": "3b2560de-253f-48f1-934e-db57d4f0c189",
"name": "Document request updated successfully.",
"originalRequest": {
"url": {
"path": [
"documents",
"request",
":documentRequestGuid",
"update"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the document request to update.",
"type": "text/plain"
},
"type": "any",
"value": "eee87915-328e-d59f-cc55-1f881f1ebb9c",
"key": "documentRequestGuid"
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"documentRequestGuid\": \"string\",\n \"subscriptionGuid\": \"string\",\n \"documentTemplateGuid\": \"string\",\n \"dataGuid\": \"string\",\n \"documentGuid\": \"string\",\n \"documentSolutionConfigurationGuid\": \"string\",\n \"ownerGuid\": \"string\",\n \"lastModifiedUserGuid\": \"string\",\n \"recordId\": \"string\",\n \"name\": \"string\",\n \"status\": \"string\",\n \"embeddedData\": \"string\",\n \"title\": \"string\",\n \"fileFormat\": \"string\",\n \"processingType\": \"string\",\n \"deliveryMethod\": \"string\",\n \"path\": \"string\",\n \"pdfConformanceLevel\": \"string\",\n \"pdfVersion\": \"string\",\n \"language\": \"string\",\n \"locale\": \"string\",\n \"timeZone\": \"string\",\n \"viewAnonymous\": true,\n \"editAnonymous\": true,\n \"viewOrganization\": true,\n \"editOrganization\": true,\n \"viewUser\": true,\n \"editUser\": true,\n \"viewUserEmailList\": \"string\",\n \"editUserEmailList\": \"string\",\n \"createdDate\": \"string\",\n \"completedDate\": \"string\",\n \"lastModifiedDate\": \"string\",\n \"isDeleted\": true\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"documentRequest\": {\n \"documentRequestGuid\": \"string\",\n \"subscriptionGuid\": \"string\",\n \"documentTemplateGuid\": \"string\",\n \"dataGuid\": \"string\",\n \"documentGuid\": \"string\",\n \"documentSolutionConfigurationGuid\": \"string\",\n \"ownerGuid\": \"string\",\n \"lastModifiedUserGuid\": \"string\",\n \"recordId\": \"string\",\n \"name\": \"string\",\n \"status\": \"string\",\n \"embeddedData\": \"string\",\n \"title\": \"string\",\n \"fileFormat\": \"string\",\n \"processingType\": \"string\",\n \"deliveryMethod\": \"string\",\n \"path\": \"string\",\n \"pdfConformanceLevel\": \"string\",\n \"pdfVersion\": \"string\",\n \"language\": \"string\",\n \"locale\": \"string\",\n \"timeZone\": \"string\",\n \"viewAnonymous\": true,\n \"editAnonymous\": true,\n \"viewOrganization\": true,\n \"editOrganization\": true,\n \"viewUser\": true,\n \"editUser\": true,\n \"viewUserEmailList\": \"string\",\n \"editUserEmailList\": \"string\",\n \"createdDate\": \"string\",\n \"completedDate\": \"string\",\n \"lastModifiedDate\": \"string\",\n \"isDeleted\": true\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
}
]
},
{
"name": "Document Solution Configuration",
"description": "",
"item": [
{
"id": "8eaea086-5588-4b3a-9cf5-5653a7688658",
"name": "Document Solution Configuration Create",
"request": {
"name": "Document Solution Configuration Create",
"description": {
"content": "Creates a new document solution configuration profile.",
"type": "text/plain"
},
"url": {
"path": [
"documents",
"configuration",
"create"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"documentSolutionConfigurationGuid\": \"string\",\n \"documentSolutionGuid\": \"string\",\n \"subscriptionGuid\": \"string\",\n \"ownerGuid\": \"string\",\n \"lastModifiedUserGuid\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"title\": \"string\",\n \"fileFormat\": \"string\",\n \"processingType\": \"string\",\n \"deliveryMethod\": \"string\",\n \"path\": \"string\",\n \"pdfConformanceLevel\": \"string\",\n \"pdfVersion\": \"string\",\n \"language\": \"string\",\n \"locale\": \"string\",\n \"timeZone\": \"string\",\n \"embeddedData\": \"string\",\n \"viewAnonymous\": true,\n \"editAnonymous\": true,\n \"viewOrganization\": true,\n \"editOrganization\": true,\n \"viewUser\": true,\n \"editUser\": true,\n \"viewUserEmailList\": \"string\",\n \"editUserEmailList\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\",\n \"isDeleted\": true\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"response": [
{
"id": "791145fc-5613-4722-96d7-c90f22bb476e",
"name": "Configuration profile created successfully.",
"originalRequest": {
"url": {
"path": [
"documents",
"configuration",
"create"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"documentSolutionConfigurationGuid\": \"string\",\n \"documentSolutionGuid\": \"string\",\n \"subscriptionGuid\": \"string\",\n \"ownerGuid\": \"string\",\n \"lastModifiedUserGuid\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"title\": \"string\",\n \"fileFormat\": \"string\",\n \"processingType\": \"string\",\n \"deliveryMethod\": \"string\",\n \"path\": \"string\",\n \"pdfConformanceLevel\": \"string\",\n \"pdfVersion\": \"string\",\n \"language\": \"string\",\n \"locale\": \"string\",\n \"timeZone\": \"string\",\n \"embeddedData\": \"string\",\n \"viewAnonymous\": true,\n \"editAnonymous\": true,\n \"viewOrganization\": true,\n \"editOrganization\": true,\n \"viewUser\": true,\n \"editUser\": true,\n \"viewUserEmailList\": \"string\",\n \"editUserEmailList\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\",\n \"isDeleted\": true\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"documentSolutionConfiguration\": {\n \"documentSolutionConfigurationGuid\": \"string\",\n \"documentSolutionGuid\": \"string\",\n \"subscriptionGuid\": \"string\",\n \"ownerGuid\": \"string\",\n \"lastModifiedUserGuid\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"title\": \"string\",\n \"fileFormat\": \"string\",\n \"processingType\": \"string\",\n \"deliveryMethod\": \"string\",\n \"path\": \"string\",\n \"pdfConformanceLevel\": \"string\",\n \"pdfVersion\": \"string\",\n \"language\": \"string\",\n \"locale\": \"string\",\n \"timeZone\": \"string\",\n \"embeddedData\": \"string\",\n \"viewAnonymous\": true,\n \"editAnonymous\": true,\n \"viewOrganization\": true,\n \"editOrganization\": true,\n \"viewUser\": true,\n \"editUser\": true,\n \"viewUserEmailList\": \"string\",\n \"editUserEmailList\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\",\n \"isDeleted\": true\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "2b74977f-3fc5-4a9b-a028-11a06aedd387",
"name": "Document Solution Configuration Delete",
"request": {
"name": "Document Solution Configuration Delete",
"description": {
"content": "Deletes a specific document solution configuration.",
"type": "text/plain"
},
"url": {
"path": [
"documents",
"configuration",
":documentSolutionConfigurationGuid",
"delete"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "eee87915-328e-d59f-cc55-1f881f1ebb9c",
"key": "documentSolutionConfigurationGuid",
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the configuration to delete.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "DELETE",
"body": {}
},
"response": [
{
"id": "acdbcfd8-6287-41b4-a16e-66c472d08628",
"name": "Configuration deleted successfully.",
"originalRequest": {
"url": {
"path": [
"documents",
"configuration",
":documentSolutionConfigurationGuid",
"delete"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the configuration to delete.",
"type": "text/plain"
},
"type": "any",
"value": "eee87915-328e-d59f-cc55-1f881f1ebb9c",
"key": "documentSolutionConfigurationGuid"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "DELETE",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"documentSolutionConfigurationGuid\": \"string\",\n \"message\": \"DocumentSolutionConfiguration deleted successfully.\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "d7eca0aa-a9b7-4f4e-888d-55f9683f6800",
"name": "Document Solution Configuration Get",
"request": {
"name": "Document Solution Configuration Get",
"description": {
"content": "Retrieves the details of a specific document solution configuration using its unique GUID.",
"type": "text/plain"
},
"url": {
"path": [
"documents",
"configuration",
":documentSolutionConfigurationGuid",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "eee87915-328e-d59f-cc55-1f881f1ebb9c",
"key": "documentSolutionConfigurationGuid",
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the document solution configuration.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"response": [
{
"id": "9e81cdd3-4ff5-49af-b21f-aa919b7e26e8",
"name": "Configuration details retrieved successfully.",
"originalRequest": {
"url": {
"path": [
"documents",
"configuration",
":documentSolutionConfigurationGuid",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the document solution configuration.",
"type": "text/plain"
},
"type": "any",
"value": "eee87915-328e-d59f-cc55-1f881f1ebb9c",
"key": "documentSolutionConfigurationGuid"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"documentSolutionConfiguration\": {\n \"documentSolutionConfigurationGuid\": \"string\",\n \"documentSolutionGuid\": \"string\",\n \"subscriptionGuid\": \"string\",\n \"ownerGuid\": \"string\",\n \"lastModifiedUserGuid\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"title\": \"string\",\n \"fileFormat\": \"string\",\n \"processingType\": \"string\",\n \"deliveryMethod\": \"string\",\n \"path\": \"string\",\n \"pdfConformanceLevel\": \"string\",\n \"pdfVersion\": \"string\",\n \"language\": \"string\",\n \"locale\": \"string\",\n \"timeZone\": \"string\",\n \"embeddedData\": \"string\",\n \"viewAnonymous\": true,\n \"editAnonymous\": true,\n \"viewOrganization\": true,\n \"editOrganization\": true,\n \"viewUser\": true,\n \"editUser\": true,\n \"viewUserEmailList\": \"string\",\n \"editUserEmailList\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\",\n \"isDeleted\": true\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "e8f4b46f-01f7-4064-a777-f58956a2c5aa",
"name": "Document Solution Configuration List",
"request": {
"name": "Document Solution Configuration List",
"description": {
"content": "Retrieves a paginated list of all document solution configurations.",
"type": "text/plain"
},
"url": {
"path": [
"documents",
"configuration",
"list"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "Number of records to retrieve (for pagination).",
"type": "text/plain"
},
"key": "top",
"value": "9511"
},
{
"disabled": false,
"description": {
"content": "Number of records to skip (for pagination).",
"type": "text/plain"
},
"key": "skip",
"value": "9511"
},
{
"disabled": false,
"description": {
"content": "Field name to sort by.",
"type": "text/plain"
},
"key": "sort",
"value": "string"
},
{
"disabled": false,
"description": {
"content": "Sort order (e.g., asc or desc).",
"type": "text/plain"
},
"key": "order",
"value": "string"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"response": [
{
"id": "4bcff6ec-01f6-40d6-a62e-6c6b11e83a26",
"name": "List of configurations retrieved successfully.",
"originalRequest": {
"url": {
"path": [
"documents",
"configuration",
"list"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "Number of records to retrieve (for pagination).",
"type": "text/plain"
},
"key": "top",
"value": "9511"
},
{
"disabled": false,
"description": {
"content": "Number of records to skip (for pagination).",
"type": "text/plain"
},
"key": "skip",
"value": "9511"
},
{
"disabled": false,
"description": {
"content": "Field name to sort by.",
"type": "text/plain"
},
"key": "sort",
"value": "string"
},
{
"disabled": false,
"description": {
"content": "Sort order (e.g., asc or desc).",
"type": "text/plain"
},
"key": "order",
"value": "string"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"documentSolutionConfigurations\": [\n {\n \"documentSolutionConfigurationGuid\": \"string\",\n \"documentSolutionGuid\": \"string\",\n \"subscriptionGuid\": \"string\",\n \"ownerGuid\": \"string\",\n \"lastModifiedUserGuid\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"title\": \"string\",\n \"fileFormat\": \"string\",\n \"processingType\": \"string\",\n \"deliveryMethod\": \"string\",\n \"path\": \"string\",\n \"pdfConformanceLevel\": \"string\",\n \"pdfVersion\": \"string\",\n \"language\": \"string\",\n \"locale\": \"string\",\n \"timeZone\": \"string\",\n \"embeddedData\": \"string\",\n \"viewAnonymous\": true,\n \"editAnonymous\": true,\n \"viewOrganization\": true,\n \"editOrganization\": true,\n \"viewUser\": true,\n \"editUser\": true,\n \"viewUserEmailList\": \"string\",\n \"editUserEmailList\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\",\n \"isDeleted\": true\n }\n ],\n \"rowCount\": 0\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "433c5036-7fae-469c-b9a8-c09535c502db",
"name": "Document Solution Configuration Update",
"request": {
"name": "Document Solution Configuration Update",
"description": {
"content": "Updates the parameters of an existing document solution configuration.",
"type": "text/plain"
},
"url": {
"path": [
"documents",
"configuration",
":documentSolutionConfigurationGuid",
"update"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "eee87915-328e-d59f-cc55-1f881f1ebb9c",
"key": "documentSolutionConfigurationGuid",
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the configuration to update.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"documentSolutionConfigurationGuid\": \"string\",\n \"documentSolutionGuid\": \"string\",\n \"subscriptionGuid\": \"string\",\n \"ownerGuid\": \"string\",\n \"lastModifiedUserGuid\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"title\": \"string\",\n \"fileFormat\": \"string\",\n \"processingType\": \"string\",\n \"deliveryMethod\": \"string\",\n \"path\": \"string\",\n \"pdfConformanceLevel\": \"string\",\n \"pdfVersion\": \"string\",\n \"language\": \"string\",\n \"locale\": \"string\",\n \"timeZone\": \"string\",\n \"embeddedData\": \"string\",\n \"viewAnonymous\": true,\n \"editAnonymous\": true,\n \"viewOrganization\": true,\n \"editOrganization\": true,\n \"viewUser\": true,\n \"editUser\": true,\n \"viewUserEmailList\": \"string\",\n \"editUserEmailList\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\",\n \"isDeleted\": true\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"response": [
{
"id": "bf026549-4f46-435b-976e-b9f9f9d01660",
"name": "Configuration updated successfully.",
"originalRequest": {
"url": {
"path": [
"documents",
"configuration",
":documentSolutionConfigurationGuid",
"update"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the configuration to update.",
"type": "text/plain"
},
"type": "any",
"value": "eee87915-328e-d59f-cc55-1f881f1ebb9c",
"key": "documentSolutionConfigurationGuid"
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"documentSolutionConfigurationGuid\": \"string\",\n \"documentSolutionGuid\": \"string\",\n \"subscriptionGuid\": \"string\",\n \"ownerGuid\": \"string\",\n \"lastModifiedUserGuid\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"title\": \"string\",\n \"fileFormat\": \"string\",\n \"processingType\": \"string\",\n \"deliveryMethod\": \"string\",\n \"path\": \"string\",\n \"pdfConformanceLevel\": \"string\",\n \"pdfVersion\": \"string\",\n \"language\": \"string\",\n \"locale\": \"string\",\n \"timeZone\": \"string\",\n \"embeddedData\": \"string\",\n \"viewAnonymous\": true,\n \"editAnonymous\": true,\n \"viewOrganization\": true,\n \"editOrganization\": true,\n \"viewUser\": true,\n \"editUser\": true,\n \"viewUserEmailList\": \"string\",\n \"editUserEmailList\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\",\n \"isDeleted\": true\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"documentSolutionConfiguration\": {\n \"documentSolutionConfigurationGuid\": \"string\",\n \"documentSolutionGuid\": \"string\",\n \"subscriptionGuid\": \"string\",\n \"ownerGuid\": \"string\",\n \"lastModifiedUserGuid\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"title\": \"string\",\n \"fileFormat\": \"string\",\n \"processingType\": \"string\",\n \"deliveryMethod\": \"string\",\n \"path\": \"string\",\n \"pdfConformanceLevel\": \"string\",\n \"pdfVersion\": \"string\",\n \"language\": \"string\",\n \"locale\": \"string\",\n \"timeZone\": \"string\",\n \"embeddedData\": \"string\",\n \"viewAnonymous\": true,\n \"editAnonymous\": true,\n \"viewOrganization\": true,\n \"editOrganization\": true,\n \"viewUser\": true,\n \"editUser\": true,\n \"viewUserEmailList\": \"string\",\n \"editUserEmailList\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\",\n \"isDeleted\": true\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
}
]
},
{
"name": "Document Solution",
"description": "",
"item": [
{
"id": "e8223c28-108f-432f-9458-38de08ee3aaa",
"name": "Document Solution Create",
"request": {
"name": "Document Solution Create",
"description": {
"content": "Creates a new document solution grouping.",
"type": "text/plain"
},
"url": {
"path": [
"documents",
"solution",
"create"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"documentSolutionGuid\": \"string\",\n \"subscriptionGuid\": \"string\",\n \"ownerGuid\": \"string\",\n \"lastModifiedUserGuid\": \"string\",\n \"dataGuid\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\",\n \"isDeleted\": true\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"response": [
{
"id": "80497e3f-7f6b-464a-b1ab-c4a7506a12ca",
"name": "Document solution created successfully.",
"originalRequest": {
"url": {
"path": [
"documents",
"solution",
"create"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"documentSolutionGuid\": \"string\",\n \"subscriptionGuid\": \"string\",\n \"ownerGuid\": \"string\",\n \"lastModifiedUserGuid\": \"string\",\n \"dataGuid\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\",\n \"isDeleted\": true\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"documentSolution\": {\n \"documentSolutionGuid\": \"string\",\n \"subscriptionGuid\": \"string\",\n \"ownerGuid\": \"string\",\n \"lastModifiedUserGuid\": \"string\",\n \"dataGuid\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\",\n \"isDeleted\": true\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "0bc238c0-db41-4dc8-9eb1-ede8526aeed3",
"name": "Document Solution Delete",
"request": {
"name": "Document Solution Delete",
"description": {
"content": "Deletes a specific document solution from the system.",
"type": "text/plain"
},
"url": {
"path": [
"documents",
"solution",
":documentSolutionGuid",
"delete"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "eee87915-328e-d59f-cc55-1f881f1ebb9c",
"key": "documentSolutionGuid",
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the solution to delete.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "DELETE",
"body": {}
},
"response": [
{
"id": "a922f616-48f7-4f24-a5cd-1b844a929816",
"name": "Document solution deleted successfully.",
"originalRequest": {
"url": {
"path": [
"documents",
"solution",
":documentSolutionGuid",
"delete"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the solution to delete.",
"type": "text/plain"
},
"type": "any",
"value": "eee87915-328e-d59f-cc55-1f881f1ebb9c",
"key": "documentSolutionGuid"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "DELETE",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"documentSolutionGuid\": \"string\",\n \"message\": \"DocumentSolution deleted successfully.\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "c1e6e456-d739-4d9e-9bba-514bda8764a4",
"name": "Document Solution Get",
"request": {
"name": "Document Solution Get",
"description": {
"content": "Retrieves the properties and details of a specific document solution using its unique GUID.",
"type": "text/plain"
},
"url": {
"path": [
"documents",
"solution",
":documentSolutionGuid",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "eee87915-328e-d59f-cc55-1f881f1ebb9c",
"key": "documentSolutionGuid",
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the document solution.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"response": [
{
"id": "2b975eb5-cb8d-48e7-90f6-ea65e3314e58",
"name": "Solution details retrieved successfully.",
"originalRequest": {
"url": {
"path": [
"documents",
"solution",
":documentSolutionGuid",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the document solution.",
"type": "text/plain"
},
"type": "any",
"value": "eee87915-328e-d59f-cc55-1f881f1ebb9c",
"key": "documentSolutionGuid"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"documentSolution\": {\n \"documentSolutionGuid\": \"string\",\n \"subscriptionGuid\": \"string\",\n \"ownerGuid\": \"string\",\n \"lastModifiedUserGuid\": \"string\",\n \"dataGuid\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\",\n \"isDeleted\": true\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "b3269f67-5d70-45ac-9112-610bfe7f7814",
"name": "Document Solution List",
"request": {
"name": "Document Solution List",
"description": {
"content": "Retrieves a paginated list of all configured document solutions in the system.",
"type": "text/plain"
},
"url": {
"path": [
"documents",
"solution",
"list"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "Number of records to retrieve (for pagination).",
"type": "text/plain"
},
"key": "top",
"value": "9511"
},
{
"disabled": false,
"description": {
"content": "Number of records to skip (for pagination).",
"type": "text/plain"
},
"key": "skip",
"value": "9511"
},
{
"disabled": false,
"description": {
"content": "Field name to sort by.",
"type": "text/plain"
},
"key": "sort",
"value": "string"
},
{
"disabled": false,
"description": {
"content": "Sort order (e.g., asc or desc).",
"type": "text/plain"
},
"key": "order",
"value": "string"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"response": [
{
"id": "965f0edc-c4c3-4e03-acf6-334bc422c106",
"name": "List of solutions retrieved successfully.",
"originalRequest": {
"url": {
"path": [
"documents",
"solution",
"list"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "Number of records to retrieve (for pagination).",
"type": "text/plain"
},
"key": "top",
"value": "9511"
},
{
"disabled": false,
"description": {
"content": "Number of records to skip (for pagination).",
"type": "text/plain"
},
"key": "skip",
"value": "9511"
},
{
"disabled": false,
"description": {
"content": "Field name to sort by.",
"type": "text/plain"
},
"key": "sort",
"value": "string"
},
{
"disabled": false,
"description": {
"content": "Sort order (e.g., asc or desc).",
"type": "text/plain"
},
"key": "order",
"value": "string"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"documentSolutions\": [\n {\n \"documentSolutionGuid\": \"string\",\n \"subscriptionGuid\": \"string\",\n \"ownerGuid\": \"string\",\n \"lastModifiedUserGuid\": \"string\",\n \"dataGuid\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\",\n \"isDeleted\": true\n }\n ],\n \"rowCount\": 0\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "e6a525ad-d217-4021-aebf-14d5de9376a4",
"name": "Document Solution Update",
"request": {
"name": "Document Solution Update",
"description": {
"content": "Updates the properties of an existing document solution.",
"type": "text/plain"
},
"url": {
"path": [
"documents",
"solution",
":documentSolutionGuid",
"update"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "eee87915-328e-d59f-cc55-1f881f1ebb9c",
"key": "documentSolutionGuid",
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the solution to update.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"documentSolutionGuid\": \"string\",\n \"subscriptionGuid\": \"string\",\n \"ownerGuid\": \"string\",\n \"lastModifiedUserGuid\": \"string\",\n \"dataGuid\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\",\n \"isDeleted\": true\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"response": [
{
"id": "32016634-80b7-43aa-8b95-ca4e981ba53c",
"name": "Solution updated successfully.",
"originalRequest": {
"url": {
"path": [
"documents",
"solution",
":documentSolutionGuid",
"update"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the solution to update.",
"type": "text/plain"
},
"type": "any",
"value": "eee87915-328e-d59f-cc55-1f881f1ebb9c",
"key": "documentSolutionGuid"
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"documentSolutionGuid\": \"string\",\n \"subscriptionGuid\": \"string\",\n \"ownerGuid\": \"string\",\n \"lastModifiedUserGuid\": \"string\",\n \"dataGuid\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\",\n \"isDeleted\": true\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"documentSolution\": {\n \"documentSolutionGuid\": \"string\",\n \"subscriptionGuid\": \"string\",\n \"ownerGuid\": \"string\",\n \"lastModifiedUserGuid\": \"string\",\n \"dataGuid\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\",\n \"isDeleted\": true\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
}
]
},
{
"name": "Option Value",
"description": "",
"item": [
{
"id": "31820674-4010-444d-9415-f32f395bb957",
"name": "Document Option Value Create",
"request": {
"name": "Document Option Value Create",
"description": {
"content": "Creates a new configuration option value scoped to a specific entity type and entity ID.",
"type": "text/plain"
},
"url": {
"path": [
"documents",
"option",
":entityType",
":entityId",
"create"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "string",
"key": "entityType",
"disabled": false,
"description": {
"content": "(Required) The type of entity the option belongs to.",
"type": "text/plain"
}
},
{
"type": "any",
"value": "eee87915-328e-d59f-cc55-1f881f1ebb9c",
"key": "entityId",
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the entity.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"optionValueGuid\": \"string\",\n \"entityType\": \"string\",\n \"entityId\": \"string\",\n \"optionDefinitionId\": 0,\n \"customKey\": \"string\",\n \"customGroup\": \"string\",\n \"value\": \"string\",\n \"effectiveKey\": \"string\",\n \"effectiveGroup\": \"string\",\n \"systemType\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"response": [
{
"id": "abda0b66-805f-4b4a-a7ec-fa1929884c1c",
"name": "Option value created successfully.",
"originalRequest": {
"url": {
"path": [
"documents",
"option",
":entityType",
":entityId",
"create"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The type of entity the option belongs to.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "entityType"
},
{
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the entity.",
"type": "text/plain"
},
"type": "any",
"value": "eee87915-328e-d59f-cc55-1f881f1ebb9c",
"key": "entityId"
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"optionValueGuid\": \"string\",\n \"entityType\": \"string\",\n \"entityId\": \"string\",\n \"optionDefinitionId\": 0,\n \"customKey\": \"string\",\n \"customGroup\": \"string\",\n \"value\": \"string\",\n \"effectiveKey\": \"string\",\n \"effectiveGroup\": \"string\",\n \"systemType\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"optionValue\": {\n \"optionValueGuid\": \"string\",\n \"entityType\": \"string\",\n \"entityId\": \"string\",\n \"optionDefinitionId\": 0,\n \"customKey\": \"string\",\n \"customGroup\": \"string\",\n \"value\": \"string\",\n \"effectiveKey\": \"string\",\n \"effectiveGroup\": \"string\",\n \"systemType\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "c91b33e6-03b5-4ada-a2f1-0f264189a54a",
"name": "Document Option Value Delete",
"request": {
"name": "Document Option Value Delete",
"description": {
"content": "Deletes a specific document option value.",
"type": "text/plain"
},
"url": {
"path": [
"documents",
"option",
":optionValueGuid",
"delete"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "eee87915-328e-d59f-cc55-1f881f1ebb9c",
"key": "optionValueGuid",
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the option value to delete.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "DELETE",
"body": {}
},
"response": [
{
"id": "b5684640-a059-45e4-8243-91309dc2fce0",
"name": "Option value deleted successfully.",
"originalRequest": {
"url": {
"path": [
"documents",
"option",
":optionValueGuid",
"delete"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the option value to delete.",
"type": "text/plain"
},
"type": "any",
"value": "eee87915-328e-d59f-cc55-1f881f1ebb9c",
"key": "optionValueGuid"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "DELETE",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"optionValueGuid\": \"string\",\n \"Message\": \"Option value deleted successfully.\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "80863518-7607-4536-9f31-73aecde086d8",
"name": "Document Option Value Get",
"request": {
"name": "Document Option Value Get",
"description": {
"content": "Retrieves the details of a specific document option value using its unique GUID.",
"type": "text/plain"
},
"url": {
"path": [
"documents",
"option",
":optionValueGuid",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "eee87915-328e-d59f-cc55-1f881f1ebb9c",
"key": "optionValueGuid",
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the option value.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"response": [
{
"id": "40eb3bb0-7e9f-4a08-b8e6-f09ecfcfd513",
"name": "Option value retrieved successfully.",
"originalRequest": {
"url": {
"path": [
"documents",
"option",
":optionValueGuid",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the option value.",
"type": "text/plain"
},
"type": "any",
"value": "eee87915-328e-d59f-cc55-1f881f1ebb9c",
"key": "optionValueGuid"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"optionValue\": {\n \"optionValueGuid\": \"string\",\n \"entityType\": \"string\",\n \"entityId\": \"string\",\n \"optionDefinitionId\": 0,\n \"customKey\": \"string\",\n \"customGroup\": \"string\",\n \"value\": \"string\",\n \"effectiveKey\": \"string\",\n \"effectiveGroup\": \"string\",\n \"systemType\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "19ee0c9d-42cb-4562-9de4-20f24621d3a4",
"name": "Document Option Value List",
"request": {
"name": "Document Option Value List",
"description": {
"content": "Retrieves a list of all option values currently associated with a specific entity (e.g., a specific template or solution).",
"type": "text/plain"
},
"url": {
"path": [
"documents",
"option",
":entityType",
":entityId",
"list"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "string",
"key": "entityType",
"disabled": false,
"description": {
"content": "(Required) The type of entity the options belong to.",
"type": "text/plain"
}
},
{
"type": "any",
"value": "eee87915-328e-d59f-cc55-1f881f1ebb9c",
"key": "entityId",
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the entity.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"response": [
{
"id": "af3487e7-dcc2-4eff-827f-1893e1fda91d",
"name": "List of option values retrieved successfully.",
"originalRequest": {
"url": {
"path": [
"documents",
"option",
":entityType",
":entityId",
"list"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The type of entity the options belong to.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "entityType"
},
{
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the entity.",
"type": "text/plain"
},
"type": "any",
"value": "eee87915-328e-d59f-cc55-1f881f1ebb9c",
"key": "entityId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"optionValues\": [\n {\n \"optionValueGuid\": \"string\",\n \"entityType\": \"string\",\n \"entityId\": \"string\",\n \"optionDefinitionId\": 0,\n \"customKey\": \"string\",\n \"customGroup\": \"string\",\n \"value\": \"string\",\n \"effectiveKey\": \"string\",\n \"effectiveGroup\": \"string\",\n \"systemType\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\"\n }\n ],\n \"rowCount\": 0\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "51f6e4d9-253c-4bc3-8322-b4edee42fc7b",
"name": "Document Option Value Replace",
"request": {
"name": "Document Option Value Replace",
"description": {
"content": "Bulk-replaces all existing option values for a specific entity with a new set of values.",
"type": "text/plain"
},
"url": {
"path": [
"documents",
"option",
":entityType",
":entityId",
"replace"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "string",
"key": "entityType",
"disabled": false,
"description": {
"content": "(Required) The type of entity to replace options for.",
"type": "text/plain"
}
},
{
"type": "any",
"value": "eee87915-328e-d59f-cc55-1f881f1ebb9c",
"key": "entityId",
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the entity.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "[\n {\n \"optionValueGuid\": \"string\",\n \"entityType\": \"string\",\n \"entityId\": \"string\",\n \"optionDefinitionId\": 0,\n \"customKey\": \"string\",\n \"customGroup\": \"string\",\n \"value\": \"string\",\n \"effectiveKey\": \"string\",\n \"effectiveGroup\": \"string\",\n \"systemType\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\"\n }\n]",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"response": [
{
"id": "a0347258-4be7-444b-8d49-df175fd506e3",
"name": "Option values replaced successfully.",
"originalRequest": {
"url": {
"path": [
"documents",
"option",
":entityType",
":entityId",
"replace"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The type of entity to replace options for.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "entityType"
},
{
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the entity.",
"type": "text/plain"
},
"type": "any",
"value": "eee87915-328e-d59f-cc55-1f881f1ebb9c",
"key": "entityId"
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "[\n {\n \"optionValueGuid\": \"string\",\n \"entityType\": \"string\",\n \"entityId\": \"string\",\n \"optionDefinitionId\": 0,\n \"customKey\": \"string\",\n \"customGroup\": \"string\",\n \"value\": \"string\",\n \"effectiveKey\": \"string\",\n \"effectiveGroup\": \"string\",\n \"systemType\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\"\n }\n]",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"entityId\": \"string\",\n \"entityType\": \"string\",\n \"Message\": \"Entity options replaced successfully.\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "e13fbb04-40fb-4266-a292-c14e908fea8b",
"name": "Document Option Value Update",
"request": {
"name": "Document Option Value Update",
"description": {
"content": "Updates the contents of a specific document option value.",
"type": "text/plain"
},
"url": {
"path": [
"documents",
"option",
":optionValueGuid",
"update"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "eee87915-328e-d59f-cc55-1f881f1ebb9c",
"key": "optionValueGuid",
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the option value to update.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"optionValueGuid\": \"string\",\n \"entityType\": \"string\",\n \"entityId\": \"string\",\n \"optionDefinitionId\": 0,\n \"customKey\": \"string\",\n \"customGroup\": \"string\",\n \"value\": \"string\",\n \"effectiveKey\": \"string\",\n \"effectiveGroup\": \"string\",\n \"systemType\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"response": [
{
"id": "f485ecbd-76ad-45f7-ae26-5319f4be6059",
"name": "Option value updated successfully.",
"originalRequest": {
"url": {
"path": [
"documents",
"option",
":optionValueGuid",
"update"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the option value to update.",
"type": "text/plain"
},
"type": "any",
"value": "eee87915-328e-d59f-cc55-1f881f1ebb9c",
"key": "optionValueGuid"
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"optionValueGuid\": \"string\",\n \"entityType\": \"string\",\n \"entityId\": \"string\",\n \"optionDefinitionId\": 0,\n \"customKey\": \"string\",\n \"customGroup\": \"string\",\n \"value\": \"string\",\n \"effectiveKey\": \"string\",\n \"effectiveGroup\": \"string\",\n \"systemType\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"optionValue\": {\n \"optionValueGuid\": \"string\",\n \"entityType\": \"string\",\n \"entityId\": \"string\",\n \"optionDefinitionId\": 0,\n \"customKey\": \"string\",\n \"customGroup\": \"string\",\n \"value\": \"string\",\n \"effectiveKey\": \"string\",\n \"effectiveGroup\": \"string\",\n \"systemType\": \"string\",\n \"createdDate\": \"string\",\n \"lastModifiedDate\": \"string\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
}
]
}
]
},
{
"name": "Signatures",
"description": {
"content": "Import from \"func-mavensignature-dev-westeu\" Function App",
"type": "text/plain"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"exec": [
"const value = pm.variables.get('signaturesSubscriptionKey');",
"if (!value || !value.trim() || value.trim().indexOf('\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.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"envelope",
"accept"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"response": [
{
"id": "81c86707-e174-4f1f-a916-80adedbc6492",
"name": "This is the response returned when the agreement to the legal terms or conditions associated with an envelope is successfully recorded.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
"accept"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 200,\n \"message\": \"OK\",\n \"data\": {\n \"recipient\": {\n \"id\": \"b9bb72f7-6a46-468c-8282-997aab21bf2a\",\n \"message\": \"Legal document successfully accepted\"\n }\n }\n },\n \"origin\": \"GET https://dev.headless.mavenmule.com/signatures/envelope/accept\",\n \"dateTime\": \"2025-10-31T13:22:21.1243942+00:00\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "2ddf7b0e-fe6f-4a58-8a7f-f6bab32d15d6",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
"accept"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\",\n \"urn\": \"{{sentUrn}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "5fa446eb-24f8-4ff7-bc6b-d0fb96472e3e",
"name": "Envelope Edit",
"request": {
"name": "Envelope Edit",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"edit"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "string",
"key": "envelopeId",
"disabled": false,
"description": {
"content": "(Required) 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.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"envelope\": {\n \"expireInDays\": 7,\n \"alertDaysBeforeExpiry\": 3\n },\n \"externalContext\": {\n \"id\": \"12345\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"response": [
{
"id": "760ddac2-59d4-4a9c-937d-e2bc0c929e88",
"name": "This is the response returned when the envelope is successfully edited.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"edit"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) 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.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "envelopeId"
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"envelope\": {\n \"expireInDays\": 7,\n \"alertDaysBeforeExpiry\": 3\n },\n \"externalContext\": {\n \"id\": \"12345\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 200,\n \"message\": \"OK\",\n \"data\": {\n \"envelope\": {\n \"id\": \"e08f7851-dc1-d2ff0857c4e4\",\n \"message\": \"EXPIRATION_UPDATED\"\n }\n }\n },\n \"origin\": \"PUT https://dev.headless.mavenmule.com/signatures/envelope/e08f7851-dc1-d2ff0857c4e4/edit\",\n \"dateTime\": \"2025-11-04T07:24:36.5239869+00:00\",\n \"userId\": \"1d8b89c4-0889-f09ac3bc9b\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "d0b4bb29-bc6c-4c4d-9e92-f8255f80a80d",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"edit"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) 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.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "envelopeId"
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"envelope\": {\n \"expireInDays\": 7,\n \"alertDaysBeforeExpiry\": 3\n },\n \"externalContext\": {\n \"id\": \"12345\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": 400,\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"ENVELOPE_ID_INVALID\",\n \"message\": \"Envelope with ID 0f6dca08-c9cc-ba71-76b883c8bbb4 does not exist\",\n \"userMessage\": \"Envelope with ID 0f6dca08-c9cc-ba71-76b883c8bbb4 does not exist\"\n }\n ],\n \"externalErrors\": []\n },\n \"externalContext\": {\n \"test1\": \"testvalue\"\n },\n \"origin\": \"PUT https://dev.headless.mavenmule.com/signatures/envelope/0f6dca08-c9cc-ba71-76b883c8bbb4/edit\",\n \"dateTime\": \"2025-11-04T07:40:12.0000000+00:00\",\n \"userId\": \"1d8b89c4-0-9af09ac3bc9b\",\n \"operationId\": \"5c1354f98690612f2eec2\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "6e9bead4-124e-46c0-b75f-9fe5d88a6f1a",
"name": "This response indicates that there’s no envelope found with the provided ID.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"edit"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) 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.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "envelopeId"
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"envelope\": {\n \"expireInDays\": 7,\n \"alertDaysBeforeExpiry\": 3\n },\n \"externalContext\": {\n \"id\": \"12345\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "Not Found",
"code": 404,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"404\",\n \"message\": \"Not Found\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "5252e673-d39b-4f4a-82e6-6a0e8a2f6021",
"name": "Envelope Decline",
"request": {
"name": "Envelope Decline",
"description": {
"content": "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\".",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"envelope",
"decline"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"envelope\": {\n \"declineReason\": \"test\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"response": [
{
"id": "a3faaa4f-da22-409a-9ad3-920ea92dabb9",
"name": "This is the response returned when the envelope is successfully declined.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
"decline"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"envelope\": {\n \"declineReason\": \"test\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 200,\n \"message\": \"OK\",\n \"data\": {\n \"envelope\": {\n \"id\": \"cc25cdaa-c6c3-4014-b29c-2f741f612ae0\",\n \"message\": \"Envelope successfully declined\"\n }\n }\n },\n \"origin\": \"POST https://dev.headless.mavenmule.com/signatures/envelope/decline\",\n \"dateTime\": \"2025-11-03T12:29:54.7288359+00:00\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "6a935f5f-b1a1-4616-9b0c-ac6fb0c287d3",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
"decline"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"envelope\": {\n \"declineReason\": \"test\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\",\n \"urn\": \"{{sentUrn}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "ce52863f-989d-4201-9e8a-cd56100f5f88",
"name": "Envelope Delete",
"request": {
"name": "Envelope Delete",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"delete"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "string",
"key": "envelopeId",
"disabled": false,
"description": {
"content": "(Required) The ID of the envelope that should be deleted.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "DELETE",
"body": {}
},
"response": [
{
"id": "ff1356d2-2a7e-4da7-8e8d-83560d994a81",
"name": "This is the response returned when the envelope is successfully deleted.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"delete"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the envelope that should be deleted.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "envelopeId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "DELETE",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 200,\n \"message\": \"OK\",\n \"data\": {\n \"envelope\": {\n \"id\": \"789cb83f-fdd\",\n \"message\": \"Envelope successfully deleted\"\n }\n }\n },\n \"origin\": \"DELETE https://dev.headless.mavenmule.com/signatures/envelope/789cb83f-fdd/delete\",\n \"dateTime\": \"2025-11-03T12:40:42.3556288+00:00\",\n \"userId\": \"1d8b89c4--a90c-9af09ac3bc9b\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "53136926-974e-4a1f-be4d-f1d6835ebb61",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"delete"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the envelope that should be deleted.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "envelopeId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "DELETE",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\"\n }\n ],\n \"externalErrors\": []\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\",\n \"userId\": \"{{userId}}\",\n \"operationId\": \"{{operationId}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "7299a7f3-0a45-41fb-a1ce-301931d29424",
"name": "Envelope List",
"request": {
"name": "Envelope List",
"description": {
"content": "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`",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"envelope",
"list"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "Maximum number of envelopes to return.",
"type": "text/plain"
},
"key": "top",
"value": "9201"
},
{
"disabled": false,
"description": {
"content": "Number of envelopes to skip in the sorted results.",
"type": "text/plain"
},
"key": "skip",
"value": "9201"
},
{
"disabled": false,
"description": {
"content": "Column to sort by the results. (This can only be one of Subject,Recipients,Documents,Status,UploadDate,ExpireInDays)",
"type": "text/plain"
},
"key": "sort",
"value": "Status"
},
{
"disabled": false,
"description": {
"content": "The direction of the sort. (This can only be one of ASC,DESC)",
"type": "text/plain"
},
"key": "order",
"value": "ASC"
},
{
"disabled": false,
"description": {
"content": "Specifies the envelope folder to query. (This can only be one of Inbox,Sent,Drafts,Deleted,Action Required,Expiring Soon,Waiting for Others,Completed)",
"type": "text/plain"
},
"key": "folder",
"value": "Deleted"
},
{
"disabled": false,
"description": {
"content": "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. (This can only be one of 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": "text/plain"
},
"key": "filter",
"value": "Null"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"response": [
{
"id": "a10090bc-591f-4acd-b8bc-8b12597dafba",
"name": "This is the response returned when the list of available envelopes is successfully retrieved.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
"list"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "Maximum number of envelopes to return.",
"type": "text/plain"
},
"key": "top",
"value": "9201"
},
{
"disabled": false,
"description": {
"content": "Number of envelopes to skip in the sorted results.",
"type": "text/plain"
},
"key": "skip",
"value": "9201"
},
{
"disabled": false,
"description": {
"content": "Column to sort by the results. (This can only be one of Subject,Recipients,Documents,Status,UploadDate,ExpireInDays)",
"type": "text/plain"
},
"key": "sort",
"value": "Status"
},
{
"disabled": false,
"description": {
"content": "The direction of the sort. (This can only be one of ASC,DESC)",
"type": "text/plain"
},
"key": "order",
"value": "ASC"
},
{
"disabled": false,
"description": {
"content": "Specifies the envelope folder to query. (This can only be one of Inbox,Sent,Drafts,Deleted,Action Required,Expiring Soon,Waiting for Others,Completed)",
"type": "text/plain"
},
"key": "folder",
"value": "Deleted"
},
{
"disabled": false,
"description": {
"content": "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. (This can only be one of 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": "text/plain"
},
"key": "filter",
"value": "Null"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 200,\n \"message\": \"OK\",\n \"data\": {\n \"envelopes\": [\n {\n \"id\": \"e08f7851-d2ff0857c4e4\",\n \"createdBy\": {\n \"id\": \"1d8b89c4-0889-49ac3bc9b\",\n \"name\": \"Roman\",\n \"email\": \"roman.khryshchanovich@mavenmule.com\"\n },\n \"creatorGuid\": \"1d8b89c4-0889-49ac3bc9b\",\n \"status\": \"In Progress\",\n \"uploadDate\": \"2025-11-04T07:23:47.8770000+00:00\",\n \"sendDate\": \"2025-11-04T07:23:48.5600000+00:00\",\n \"subject\": \"Test\",\n \"transactionTokenId\": \"585194c6-af-1bf1f2d\",\n \"documents\": \"Sales Agreement.pdf\",\n \"recipients\": \"roman.khryshchanovich@mavenmule.com\",\n \"isSignOrder\": false,\n \"expireInDays\": 30,\n \"alertDaysBeforeExpiry\": 1\n },\n {\n \"id\": \"05a9ee69-ba1309b9ce\",\n \"createdBy\": {\n \"id\": \"1d8b89c4-0889f09ac3bc9b\",\n \"name\": \"Roman\",\n \"email\": \"roman.khryshchanovich@mavenmule.com\"\n },\n \"creatorGuid\": \"1d8b89c4-09af09ac3bc9b\",\n \"status\": \"Declined\",\n \"uploadDate\": \"2025-11-04T07:07:47.9530000+00:00\",\n \"sendDate\": \"2025-11-04T07:07:49.6970000+00:00\",\n \"subject\": \"Test\",\n \"transactionTokenId\": \"a40194aa-f516de44d\",\n \"documents\": \"Sales Agreement.pdf\",\n \"recipients\": \"roman.khryshchanovich@mavenmule.com\",\n \"isSignOrder\": false,\n \"expireInDays\": 30,\n \"alertDaysBeforeExpiry\": 1\n },\n {\n \"id\": \"b1ddf86c-f16dfe4be11\",\n \"createdBy\": {\n \"id\": \"1d8b89c4-0889-9ac3bc9b\",\n \"name\": \"Roman\",\n \"email\": \"roman.khryshchanovich@mavenmule.com\"\n },\n \"creatorGuid\": \"1d8b89c4-08809ac3bc9b\",\n \"status\": \"Completed\",\n \"uploadDate\": \"2025-11-04T07:05:59.4630000+00:00\",\n \"sendDate\": \"2025-11-04T07:06:00.0130000+00:00\",\n \"subject\": \"Test\",\n \"transactionTokenId\": \"b9e434c9-d09363157a\",\n \"documents\": \"Sales Agreement.pdf\",\n \"recipients\": \"roman.khryshchanovich@mavenmule.com\",\n \"isSignOrder\": false,\n \"expireInDays\": 30,\n \"alertDaysBeforeExpiry\": 1\n },\n {\n \"id\": \"cc25cdaa-c6c3-1f612ae0\",\n \"createdBy\": {\n \"id\": \"1d8b89c4-0889f09ac3bc9b\",\n \"name\": \"Roman\",\n \"email\": \"roman.khryshchanovich@mavenmule.com\"\n },\n \"creatorGuid\": \"1d8b89c4-0f09ac3bc9b\",\n \"status\": \"Declined\",\n \"uploadDate\": \"2025-11-03T12:19:00.3600000+00:00\",\n \"sendDate\": \"2025-11-03T12:19:02.3100000+00:00\",\n \"subject\": \"TestPOstman\",\n \"transactionTokenId\": \"cf04e45d-e4d6b5367\",\n \"documents\": \"Sales Agreement.pdf\",\n \"recipients\": \"roman.khryshchanovich@mavenmule.com\",\n \"isSignOrder\": false,\n \"expireInDays\": 30,\n \"alertDaysBeforeExpiry\": 1\n },\n {\n \"id\": \"7a5d6a40-a222-4ce490ef1\",\n \"createdBy\": {\n \"id\": \"1d8b89c4-0889-409ac3bc9b\",\n \"name\": \"Roman\",\n \"email\": \"roman.khryshchanovich@mavenmule.com\"\n },\n \"creatorGuid\": \"1d8b89c4-0889-4c3bc9b\",\n \"status\": \"Completed\",\n \"uploadDate\": \"2025-11-03T06:46:32.8830000+00:00\",\n \"sendDate\": \"2025-11-03T06:46:34.6300000+00:00\",\n \"subject\": \"TestPostman\",\n \"transactionTokenId\": \"98268dcc-ade3100dab\",\n \"documents\": \"Sales Agreement.pdf\",\n \"recipients\": \"roman.khryshchanovich@mavenmule.com\",\n \"isSignOrder\": false,\n \"expireInDays\": 30,\n \"alertDaysBeforeExpiry\": 1\n },\n {\n \"id\": \"eab98526-e8ec-4ca99dc\",\n \"createdBy\": {\n \"id\": \"1d8b89c4-0889-4d0c3bc9b\",\n \"name\": \"Roman\",\n \"email\": \"roman.khryshchanovich@mavenmule.com\"\n },\n \"creatorGuid\": \"1d8b89c4-0889-4dac3bc9b\",\n \"status\": \"Completed\",\n \"uploadDate\": \"2025-10-31T12:57:01.8400000+00:00\",\n \"sendDate\": \"2025-10-31T12:57:03.8330000+00:00\",\n \"subject\": \"TestConsole\",\n \"transactionTokenId\": \"18b5fc5f-d0f9e3c895\",\n \"documents\": \"Sales Agreement DOCX.pdf\",\n \"recipients\": \"roman.khryshchanovich@mavenmule.com\",\n \"isSignOrder\": false,\n \"expireInDays\": 30,\n \"alertDaysBeforeExpiry\": 1\n },\n {\n \"id\": \"8952012a-b086-de18b4\",\n \"createdBy\": {\n \"id\": \"1d8b89c4-0889-4c3bc9b\",\n \"name\": \"Roman\",\n \"email\": \"roman.khryshchanovich@mavenmule.com\"\n },\n \"creatorGuid\": \"1d8b89c4-088909ac3bc9b\",\n \"status\": \"Canceled\",\n \"uploadDate\": \"2025-10-31T09:37:33.4570000+00:00\",\n \"sendDate\": \"2025-10-31T09:41:07.2470000+00:00\",\n \"subject\": \"TestPostman\",\n \"transactionTokenId\": \"22822556-474c4e8d3d\",\n \"documents\": \"Test Document Name\",\n \"recipients\": \"roman.khryshchanovich@mavenmule.com\",\n \"isSignOrder\": false,\n \"expireInDays\": 5,\n \"alertDaysBeforeExpiry\": 5\n },\n {\n \"id\": \"7bcfe3ed-fc03-f2811cc614\",\n \"createdBy\": {\n \"id\": \"1d8b89c4-0889-49ac3bc9b\",\n \"name\": \"Roman\",\n \"email\": \"roman.khryshchanovich@mavenmule.com\"\n },\n \"creatorGuid\": \"1d8b89c4-0809ac3bc9b\",\n \"status\": \"Completed\",\n \"uploadDate\": \"2025-10-31T06:54:51.5030000+00:00\",\n \"sendDate\": \"2025-10-31T06:54:53.4200000+00:00\",\n \"subject\": \"TestPostman\",\n \"transactionTokenId\": \"4488c59f-8e46e2fd03\",\n \"documents\": \"Sales Agreement.pdf\",\n \"recipients\": \"roman.khryshchanovich@mavenmule.com\",\n \"isSignOrder\": false,\n \"expireInDays\": 30,\n \"alertDaysBeforeExpiry\": 1\n },\n {\n \"id\": \"39318715-3fee-40b2055ea\",\n \"createdBy\": {\n \"id\": \"1d8b89c4-0889-09ac3bc9b\",\n \"name\": \"Roman\",\n \"email\": \"roman.khryshchanovich@mavenmule.com\"\n },\n \"creatorGuid\": \"1d8b89c4-088-9af09ac3bc9b\",\n \"status\": \"In Progress\",\n \"uploadDate\": \"2025-10-31T06:36:22.2870000+00:00\",\n \"sendDate\": \"2025-10-31T06:36:24.0370000+00:00\",\n \"subject\": \"TestPostman\",\n \"transactionTokenId\": null,\n \"documents\": \"Sales Agreement.pdf\",\n \"recipients\": \"doloreskorben@gmail.com\",\n \"isSignOrder\": false,\n \"expireInDays\": 30,\n \"alertDaysBeforeExpiry\": 1\n }\n ],\n \"rowCount\": 9\n }\n },\n \"origin\": \"GET https://dev.headless.mavenmule.com/signatures/envelope/list\",\n \"dateTime\": \"2025-11-04T07:24:14.0335257+00:00\",\n \"userId\": \"1d8b89c4-09af09ac3bc9b\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "fdce803c-73b3-4a6e-9208-538abe31834c",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
"list"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "Maximum number of envelopes to return.",
"type": "text/plain"
},
"key": "top",
"value": "9201"
},
{
"disabled": false,
"description": {
"content": "Number of envelopes to skip in the sorted results.",
"type": "text/plain"
},
"key": "skip",
"value": "9201"
},
{
"disabled": false,
"description": {
"content": "Column to sort by the results. (This can only be one of Subject,Recipients,Documents,Status,UploadDate,ExpireInDays)",
"type": "text/plain"
},
"key": "sort",
"value": "Status"
},
{
"disabled": false,
"description": {
"content": "The direction of the sort. (This can only be one of ASC,DESC)",
"type": "text/plain"
},
"key": "order",
"value": "ASC"
},
{
"disabled": false,
"description": {
"content": "Specifies the envelope folder to query. (This can only be one of Inbox,Sent,Drafts,Deleted,Action Required,Expiring Soon,Waiting for Others,Completed)",
"type": "text/plain"
},
"key": "folder",
"value": "Deleted"
},
{
"disabled": false,
"description": {
"content": "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. (This can only be one of 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": "text/plain"
},
"key": "filter",
"value": "Null"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\",\n \"urn\": \"{{sentUrn}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "4508a53f-300d-4334-b2c9-2dcc5658afb2",
"name": "Envelope Audit Log Get",
"request": {
"name": "Envelope Audit Log Get",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"audit",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "string",
"key": "envelopeId",
"disabled": false,
"description": {
"content": "(Required) The ID of the envelope where the attachment will be added.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"response": [
{
"id": "c8a8e306-3e52-424e-9a51-2dbbeaa79b43",
"name": "The response body contains the data of the Audit trail in the JSON format.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"audit",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the envelope where the attachment will be added.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "envelopeId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 200,\n \"message\": \"OK\",\n \"data\": {\n \"auditTrails\": [\n {\n \"id\": \"{{auditTrailId}}\",\n \"user\": {\n \"id\": \"{{userId}}\",\n \"name\": \"{{userName}}\",\n \"email\": \"{{userEmail}}\"\n },\n \"recipient\": {\n \"id\": \"{{recipientId}}\",\n \"name\": \"{{recipientName}}\",\n \"email\": \"{{recipientEmail}}\"\n },\n \"signGroup\": \"{{signGroupValue}}\",\n \"action\": \"{{actionDescription}}\",\n \"timestamp\": \"{{actionTimestamp}}\",\n \"ipAddress\": \"{{ipAddress}}\",\n \"additionalInfo\": \"{{additionalInfo}}\"\n }\n ]\n }\n },\n \"origin\": \"{{requestOrigin}}\",\n \"dateTime\": \"{{responseTimestamp}}\",\n \"userId\": \"{{requestingUserId}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "c2094b41-6ad3-4354-a389-d1fd8974cdbe",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"audit",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the envelope where the attachment will be added.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "envelopeId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\",\n \"urn\": \"{{sentUrn}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "edd9adbd-bcfa-49c8-86f6-4af7308b0d7b",
"name": "This response indicates that there’s no Audit Trail found in the envelope with the provided ID.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"audit",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the envelope where the attachment will be added.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "envelopeId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Not Found",
"code": 404,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"404\",\n \"message\": \"Not Found\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "e0ac06ce-96bf-498c-968b-7e30763b2e2a",
"name": "Envelope Get",
"request": {
"name": "Envelope Get",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": [
{
"type": "any",
"value": "string",
"key": "envelopeId",
"disabled": false,
"description": {
"content": "(Required) The ID of the needed envelope.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"response": [
{
"id": "85b04af3-20bb-4d04-aff8-67b5a02981eb",
"name": "This is the response returned when the envelope is successfully retrieved.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the needed envelope.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "envelopeId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 200,\n \"message\": \"OK\",\n \"data\": {\n \"envelope\": {\n \"id\": \"e08f7851-dc1d-482ff0857c4e4\",\n \"createdBy\": {\n \"id\": \"1d8b89c4-0889-4dbc9b\",\n \"name\": \"Roman\",\n \"email\": \"roman.khryshchanovich@mavenmule.com\"\n },\n \"uploadDate\": \"2025-11-04T07:23:47.0000000+00:00\",\n \"sendDate\": \"2025-11-04T07:23:48.0000000+00:00\",\n \"status\": \"In Progress\",\n \"subject\": \"Test\",\n \"message\": \"\",\n \"isSignOrder\": false,\n \"expireInDays\": 30,\n \"firstReminderDays\": null,\n \"repeatingReminderDays\": null,\n \"notifyWhenOpened\": false,\n \"notifyWhenSigned\": false,\n \"alertDaysBeforeExpiry\": 1\n },\n \"documents\": [\n {\n \"id\": \"e3dcc1e8-636f3e477d08f\",\n \"name\": \"Sales Agreement.pdf\",\n \"externalContext\": null\n }\n ],\n \"originalDocuments\": [\n {\n \"id\": \"1dfc6687-de8cf82f4e8e39\",\n \"referenceDocumentId\": \"e3dcc1e8-62777d08f\",\n \"name\": \"Sales Agreement.pdf\"\n }\n ],\n \"recipients\": [\n {\n \"id\": \"8e5e0faf-e3226ddbe817fe1\",\n \"name\": \"Roman\",\n \"email\": \"roman.khryshchanovich@mavenmule.com\",\n \"role\": \"signer\",\n \"status\": \"In Progress\",\n \"signDate\": \"\",\n \"signOrder\": 1,\n \"signGroupId\": \"00000000-000000000000\",\n \"userId\": \"1d8b89c4-088909ac3bc9b\",\n \"mandatory\": true,\n \"hostEmail\": \"\",\n \"isMFAEnabled\": false,\n \"phoneNumber\": \"\",\n \"externalContext\": null\n }\n ],\n \"signGroups\": [],\n \"fields\": [\n {\n \"id\": \"37ba1cad-a347-67de11c8dc\",\n \"name\": \"a4b493088d0c4284ba389500c3ad853a\",\n \"recipientId\": \"8e5e0faf-e30-b6ddbe817fe1\",\n \"signGroupId\": \"00000000-0-000000000000\",\n \"documentId\": \"e3dcc1e9-36f3e477d08f\",\n \"type\": \"signature\",\n \"value\": \"\",\n \"page\": 1,\n \"height\": 35,\n \"width\": 100,\n \"positionX\": 69.65325,\n \"positionY\": 24.26785,\n \"isRequired\": true,\n \"properties\": null,\n \"signerInfo\": null\n }\n ],\n \"comments\": {},\n \"externalContext\": null\n }\n },\n \"origin\": \"GET https://dev.headless.mavenmule.com/signatures/envelope/e08f7851-dc1d-482ff0857c4e4/get\",\n \"dateTime\": \"2025-11-04T07:24:16.1567319+00:00\",\n \"userId\": \"1d8b89c4-090c-9af09ac3bc9b\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "e3c93b4b-71ca-484d-8a03-a5cfa4402c14",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the needed envelope.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "envelopeId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"404\",\n \"message\": \"Not Found\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "6096c711-68e3-45c5-8a6e-92af8b3d17dd",
"name": "Envelope Resend",
"request": {
"name": "Envelope Resend",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"envelope",
"resend"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"response": [
{
"id": "284bbe06-93bb-4bf1-bec8-f4d19d3f94b6",
"name": "This is the response returned when the envelope is successfully declined.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
"resend"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 200,\n \"message\": \"OK\",\n \"data\": {\n \"envelope\": {\n \"id\": \"{{envelopeId}}\",\n \"message\": \"{{resendConfirmationMessage}}\"\n }\n }\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "517717e0-344f-48f3-a28f-2bc0b3bac6f1",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
"resend"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\",\n \"urn\": \"{{sentUrn}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "8df90459-97dc-4dc6-9af8-c48bca2c0ebe",
"name": "Envelope Restore",
"request": {
"name": "Envelope Restore",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"restore"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "string",
"key": "envelopeId",
"disabled": false,
"description": {
"content": "(Required) The ID of the envelope that should be restored.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"response": [
{
"id": "f898cb6e-eb4c-4a49-b379-d9683d16af98",
"name": "This is the response returned when the envelope is successfully deleted.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"restore"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the envelope that should be restored.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "envelopeId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 200,\n \"message\": \"OK\",\n \"data\": {\n \"envelope\": {\n \"id\": \"789cb83f-c225-46f00e4bfdd\",\n \"message\": \"Envelope successfully restored\"\n }\n }\n },\n \"origin\": \"GET https://dev.headless.mavenmule.com/signatures/envelope/789cb83f-c225-46f00e4bfdd/restore\",\n \"dateTime\": \"2025-11-04T10:22:31.6356928+00:00\",\n \"userId\": \"1d8b89c4-080c-9af09ac3bc9b\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "5eb09414-70fd-444e-b1c4-4b9e70f2ea8f",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"restore"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the envelope that should be restored.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "envelopeId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": 400,\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"ENVELOPE_ID_INVALID\",\n \"message\": \"Envelope with ID 1df9-be76007e25fc does not exist\",\n \"userMessage\": \"Envelope with ID 1df9-be76007e25fc does not exist\"\n }\n ],\n \"externalErrors\": []\n },\n \"origin\": \"GET https://dev.headless.mavenmule.com/signatures/envelope/1df9-be76007e25fc/restore\",\n \"dateTime\": \"2025-11-04T10:25:22.0000000+00:00\",\n \"userId\": \"1d8b89c4-090c-9af09ac3bc9b\",\n \"operationId\": \"0e1f8c5d78d97f0a5d2dd1\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "787b606a-b1d6-45cf-8b99-b804a6ef225d",
"name": "This response indicates that there’s no envelope found with the provided ID.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"restore"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the envelope that should be restored.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "envelopeId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Not Found",
"code": 404,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"404\",\n \"message\": \"Not Found\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "6d4158cf-a093-42a7-bf51-7c7c07f0cda7",
"name": "Signature Create",
"request": {
"name": "Signature Create",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"signature",
"create"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"signature\": {\n \"isDefault\": true,\n \"value\": \"iVBORw0KGgoAAAANSUhEUgAAAyAAAAEsCAYAAAA7Ldc6AAAQA\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"response": [
{
"id": "c510bf06-db3e-422f-80e2-4f75ebf6f8f7",
"name": "This is the response returned when the envelope is successfully declined.",
"originalRequest": {
"url": {
"path": [
"signatures",
"signature",
"create"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"signature\": {\n \"isDefault\": true,\n \"value\": \"iVBORw0KGgoAAAANSUhEUgAAAyAAAAEsCAYAAAA7Ldc6AAAQA\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "Created",
"code": 201,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 201,\n \"message\": \"Created\",\n \"data\": {\n \"signature\": {\n \"id\": \"3e1346f6-a534-4e53fcb0a4d\",\n \"message\": \"Signature successfully saved\"\n }\n }\n },\n \"origin\": \"POST https://dev.headless.mavenmule.com/signatures/signature/create\",\n \"dateTime\": \"2025-11-04T11:29:04.2445642+00:00\",\n \"userId\": \"1d8b89c4-0889-4d0af09ac3bc9b\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "e4df20ed-c686-495a-a4e0-1f4dee699a9d",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"signature",
"create"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"signature\": {\n \"isDefault\": true,\n \"value\": \"iVBORw0KGgoAAAANSUhEUgAAAyAAAAEsCAYAAAA7Ldc6AAAQA\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\",\n \"urn\": \"{{sentUrn}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "c623a2ce-9fca-4a15-b3c6-42fe9b139a0b",
"name": "Envelope Create",
"request": {
"name": "Envelope Create",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"envelope",
"create"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"documents\": [\n {\n \"referenceDocumentId\": 1,\n \"name\": \"Test Document Name\",\n \"loadMethod\": \"Storage\",\n \"urn\": \"{{uploadedDocument}}\",\n \"externalContext\": {\n \"id\": \"123\"\n }\n }\n ],\n \"recipients\": [\n {\n \"referenceSignerId\": 1,\n \"name\": \"Test Example\",\n \"email\": \"user@example.com\",\n \"role\": \"signer\",\n \"mandatory\": true,\n \"externalContext\": {\n \"id\": \"456\"\n }\n }\n ],\n \"fields\": [\n {\n \"type\": \"text\",\n \"isRequired\": true,\n \"referenceSignerId\": 1,\n \"referenceDocumentId\": 1,\n \"positionX\": 10,\n \"positionY\": 10,\n \"height\": 100,\n \"width\": 100,\n \"page\": 1,\n \"name\": \"mds_signature1\",\n \"properties\": {\n \"fontFamily\": \"Arial\",\n \"fontSize\": 13,\n \"color\": \"red\",\n \"bold\": true,\n \"italic\": true,\n \"underline\": true,\n \"textAlign\": \"center\"\n }\n }\n ],\n \"envelope\": {\n \"subject\": \"Email Subject\",\n \"message\": \"Email Message\",\n \"senderName\": \"Sender Example\",\n \"senderEmail\": \"sender@example.com\",\n \"isSignOrder\": false,\n \"expireInDays\": 5,\n \"alertDaysBeforeExpiry\": 5,\n \"firstReminderDays\": 3,\n \"repeatingReminderDays\": 2,\n \"notifyWhenOpened\": true,\n \"notifyWhenSigned\": true\n },\n \"externalContext\": {\n \"id\": \"789\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"response": [
{
"id": "157b5d4f-8376-4eb0-a794-86ecc56b8d64",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
"create"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"documents\": [\n {\n \"referenceDocumentId\": 1,\n \"name\": \"Test Document Name\",\n \"loadMethod\": \"Storage\",\n \"urn\": \"{{uploadedDocument}}\",\n \"externalContext\": {\n \"id\": \"123\"\n }\n }\n ],\n \"recipients\": [\n {\n \"referenceSignerId\": 1,\n \"name\": \"Test Example\",\n \"email\": \"user@example.com\",\n \"role\": \"signer\",\n \"mandatory\": true,\n \"externalContext\": {\n \"id\": \"456\"\n }\n }\n ],\n \"fields\": [\n {\n \"type\": \"text\",\n \"isRequired\": true,\n \"referenceSignerId\": 1,\n \"referenceDocumentId\": 1,\n \"positionX\": 10,\n \"positionY\": 10,\n \"height\": 100,\n \"width\": 100,\n \"page\": 1,\n \"name\": \"mds_signature1\",\n \"properties\": {\n \"fontFamily\": \"Arial\",\n \"fontSize\": 13,\n \"color\": \"red\",\n \"bold\": true,\n \"italic\": true,\n \"underline\": true,\n \"textAlign\": \"center\"\n }\n }\n ],\n \"envelope\": {\n \"subject\": \"Email Subject\",\n \"message\": \"Email Message\",\n \"senderName\": \"Sender Example\",\n \"senderEmail\": \"sender@example.com\",\n \"isSignOrder\": false,\n \"expireInDays\": 5,\n \"alertDaysBeforeExpiry\": 5,\n \"firstReminderDays\": 3,\n \"repeatingReminderDays\": 2,\n \"notifyWhenOpened\": true,\n \"notifyWhenSigned\": true\n },\n \"externalContext\": {\n \"id\": \"789\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "Created",
"code": 201,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 201,\n \"message\": \"Created\",\n \"data\": {\n \"envelope\": {\n \"id\": \"{{envelopeId}}\",\n \"uploadDate\": \"{{uploadedDate}}\",\n \"status\": \"{{envelopeStatus}}\"\n },\n \"documents\": [\n {\n \"id\": \"{{documentId}}\",\n \"externalContext\": {\n \"id\": \"{{documentExternalContext}}\"\n }\n }\n ],\n \"recipients\": [\n {\n \"id\": \"{{recipientId}}\",\n \"externalContext\": {\n \"id\": \"{{recipientExternalContext}}\"\n }\n }\n ],\n \"signGroups\": [\n {}\n ],\n \"fields\": [\n {\n \"id\": \"{{fieldId}}\",\n \"recipientId\": \"{{recipientId}}\",\n \"signGroupId\": \"{{signGroupId}}\",\n \"documentId\": \"{{documentId}}\"\n }\n ]\n }\n },\n \"externalContext\": {\n \"id\": \"{{envelopeExternalContext}}\"\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\",\n \"userId\": \"{{userId}}\",\n \"operationId\": \"{{operationId}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "4b7a2641-3b07-43c1-a0e1-6833dd2bf650",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
"create"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"documents\": [\n {\n \"referenceDocumentId\": 1,\n \"name\": \"Test Document Name\",\n \"loadMethod\": \"Storage\",\n \"urn\": \"{{uploadedDocument}}\",\n \"externalContext\": {\n \"id\": \"123\"\n }\n }\n ],\n \"recipients\": [\n {\n \"referenceSignerId\": 1,\n \"name\": \"Test Example\",\n \"email\": \"user@example.com\",\n \"role\": \"signer\",\n \"mandatory\": true,\n \"externalContext\": {\n \"id\": \"456\"\n }\n }\n ],\n \"fields\": [\n {\n \"type\": \"text\",\n \"isRequired\": true,\n \"referenceSignerId\": 1,\n \"referenceDocumentId\": 1,\n \"positionX\": 10,\n \"positionY\": 10,\n \"height\": 100,\n \"width\": 100,\n \"page\": 1,\n \"name\": \"mds_signature1\",\n \"properties\": {\n \"fontFamily\": \"Arial\",\n \"fontSize\": 13,\n \"color\": \"red\",\n \"bold\": true,\n \"italic\": true,\n \"underline\": true,\n \"textAlign\": \"center\"\n }\n }\n ],\n \"envelope\": {\n \"subject\": \"Email Subject\",\n \"message\": \"Email Message\",\n \"senderName\": \"Sender Example\",\n \"senderEmail\": \"sender@example.com\",\n \"isSignOrder\": false,\n \"expireInDays\": 5,\n \"alertDaysBeforeExpiry\": 5,\n \"firstReminderDays\": 3,\n \"repeatingReminderDays\": 2,\n \"notifyWhenOpened\": true,\n \"notifyWhenSigned\": true\n },\n \"externalContext\": {\n \"id\": \"789\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": 400,\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"ANCHOR_PROVIDED_POSITION_NOT_REQUIRED\",\n \"message\": \"Field can only be positioned based on an anchor string or manual positioning, not both.\",\n \"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).\"\n }\n ],\n \"externalErrors\": []\n },\n \"externalContext\": {\n \"test1\": \"testvalueenvelope\"\n },\n \"origin\": \"POST https://dev.headless.mavenmule.com/signatures/envelope/create\",\n \"dateTime\": \"2025-10-31T09:27:55.0000000+00:00\",\n \"userId\": \"1d8b89c4-0889-4d03-a90c-9af09ac3bc9b\",\n \"operationId\": \"e6a5c583f9746252cc2fd5ff15fd836c\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "156b208c-290d-47ac-8d4d-c0664e88b5dc",
"name": "This is the response returned when the request has the invalid data.
\nFor example, the referenced file doesn' t exist in Storage.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
"create"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"documents\": [\n {\n \"referenceDocumentId\": 1,\n \"name\": \"Test Document Name\",\n \"loadMethod\": \"Storage\",\n \"urn\": \"{{uploadedDocument}}\",\n \"externalContext\": {\n \"id\": \"123\"\n }\n }\n ],\n \"recipients\": [\n {\n \"referenceSignerId\": 1,\n \"name\": \"Test Example\",\n \"email\": \"user@example.com\",\n \"role\": \"signer\",\n \"mandatory\": true,\n \"externalContext\": {\n \"id\": \"456\"\n }\n }\n ],\n \"fields\": [\n {\n \"type\": \"text\",\n \"isRequired\": true,\n \"referenceSignerId\": 1,\n \"referenceDocumentId\": 1,\n \"positionX\": 10,\n \"positionY\": 10,\n \"height\": 100,\n \"width\": 100,\n \"page\": 1,\n \"name\": \"mds_signature1\",\n \"properties\": {\n \"fontFamily\": \"Arial\",\n \"fontSize\": 13,\n \"color\": \"red\",\n \"bold\": true,\n \"italic\": true,\n \"underline\": true,\n \"textAlign\": \"center\"\n }\n }\n ],\n \"envelope\": {\n \"subject\": \"Email Subject\",\n \"message\": \"Email Message\",\n \"senderName\": \"Sender Example\",\n \"senderEmail\": \"sender@example.com\",\n \"isSignOrder\": false,\n \"expireInDays\": 5,\n \"alertDaysBeforeExpiry\": 5,\n \"firstReminderDays\": 3,\n \"repeatingReminderDays\": 2,\n \"notifyWhenOpened\": true,\n \"notifyWhenSigned\": true\n },\n \"externalContext\": {\n \"id\": \"789\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "Internal Server Error",
"code": 500,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": 500,\n \"message\": \"Internal Server Error\",\n \"innerErrors\": [\n {\n \"code\": \"FILE_NOT_EXISTS_IN_STORAGE\",\n \"message\": \"File with identifier bddd84db-3305-4df7-a2af-52c691d2bfdf not found in storage.\",\n \"userMessage\": \"File with identifier bddd84db-3305-4df7-a2af-52c691d2bfdf not found in storage.\"\n }\n ],\n \"externalErrors\": []\n },\n \"origin\": \"POST https://dev.headless.mavenmule.com/signatures/envelope/create\",\n \"dateTime\": \"2025-10-31T09:33:29.0000000+00:00\",\n \"operationId\": \"4292a54fa4469c01c0ab4cff3b03a1a2\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "d14e1b9b-09c2-4ceb-8267-3be31c565443",
"name": "Envelope Send",
"request": {
"name": "Envelope Send",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"send"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "string",
"key": "envelopeId",
"disabled": false,
"description": {
"content": "(Required) 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.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"response": [
{
"id": "b937198a-873b-4cd3-8a6a-ceedf162f8ce",
"name": "This is the response returned when the envelope is successfully sent.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"send"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) 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.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "envelopeId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 200,\n \"message\": \"OK\",\n \"data\": {\n \"envelope\": {\n \"id\": \"789cb83f-c225-46f00e4bfdd\",\n \"message\": \"Envelope successfully sent\"\n }\n }\n },\n \"origin\": \"GET https://dev.headless.mavenmule.com/signatures/envelope/789cb83f-c225-46f00e4bfdd/send\",\n \"dateTime\": \"2025-11-04T10:39:33.9227311+00:00\",\n \"userId\": \"1d8b89c4-08a90c-9af09ac3bc9b\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "7ce4d767-79b1-4a22-a0d0-e4c4b0657734",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"send"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) 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.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "envelopeId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"DRAFT_ID_INVALID\",\n \"message\": \"Envelope draft with ID 8952012a-b086-4aaf-be18b4 does not exist\",\n \"userMessage\": \"Envelope draft with ID 8952012a-b086-4aaf-be18b4 does not exist\"\n }\n ],\n \"externalErrors\": []\n },\n \"origin\": \"GET https://dev.headless.mavenmule.com/signatures/envelope/8952012a-b086-4aaf-be18b4/send\",\n \"dateTime\": \"2025-11-04T10:41:21.7201070+00:00\",\n \"userId\": \"1d8b89c4-0889-4d-9af09ac3bc9b\",\n \"operationId\": \"148726246e5949f517ac87582\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "4af5caa4-dc5c-4187-a83d-9fd15fe9135d",
"name": "This response indicates that there’s no envelope found with the provided ID.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"send"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) 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.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "envelopeId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Not Found",
"code": 404,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"404\",\n \"message\": \"Not Found\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "8298e489-2640-48a1-9f4c-aafe0a542df1",
"name": "Envelope Sign",
"request": {
"name": "Envelope Sign",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"envelope",
"sign"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"externalContext\": {\n \"id\": \"12345\"\n },\n \"fields\": [\n {\n \"id\": \"{{fieldId}}\",\n \"value\": \"{{fieldValue}}\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"response": [
{
"id": "b1f0ba23-a583-41c0-872c-de606c5f0d93",
"name": "This is the response returned when the envelope is successfully declined.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
"sign"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"externalContext\": {\n \"id\": \"12345\"\n },\n \"fields\": [\n {\n \"id\": \"{{fieldId}}\",\n \"value\": \"{{fieldValue}}\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 200,\n \"message\": \"OK\",\n \"data\": {\n \"envelope\": {\n \"id\": \"73dd243a-9183-4568-9ac2278c\",\n \"message\": \"Envelope successfully signed\"\n }\n }\n },\n \"origin\": \"POST https://dev.headless.mavenmule.com/signatures/envelope/sign\",\n \"dateTime\": \"2025-11-04T10:42:56.2869115+00:00\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "3a1865d6-ad0a-4a8a-8bf7-c6359b809a61",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
"sign"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"externalContext\": {\n \"id\": \"12345\"\n },\n \"fields\": [\n {\n \"id\": \"{{fieldId}}\",\n \"value\": \"{{fieldValue}}\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\",\n \"urn\": \"{{sentUrn}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "29be3718-2cc6-483d-9b1f-16655f9a4526",
"name": "Envelope Open",
"request": {
"name": "Envelope Open",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"envelope",
"open"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"response": [
{
"id": "27e47e8e-5ffa-488a-97d2-6800426a1c84",
"name": "This is the response returned when the envelope is successfully opened.
\nThe response body shows data of the opened envelope.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
"open"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 200,\n \"message\": \"OK\",\n \"data\": {\n \"envelope\": {\n \"id\": \"e08f7851-dc1d-4822ff0857c4e4\",\n \"createdBy\": {\n \"id\": \"1d8b89c4-0889-c-9af09ac3bc9b\"\n },\n \"subject\": \"Test\",\n \"senderName\": null,\n \"senderEmail\": null,\n \"status\": \"In Progress\",\n \"notifyWhenOpened\": false,\n \"isSignOrder\": false\n },\n \"documents\": [\n {\n \"id\": \"e3dcc1e8-627c-436f3e477d08f\",\n \"name\": \"Sales Agreement.pdf\"\n }\n ],\n \"recipients\": [\n {\n \"id\": \"8e5e0faf-e3b6ddbe817fe1\",\n \"name\": \"Roman\",\n \"email\": \"roman.khryshchanovich@mavenmule.com\",\n \"role\": \"signer\",\n \"status\": \"In Progress\",\n \"signDate\": null,\n \"signOrder\": 0,\n \"signGroupId\": \"00000000-0000-000000000000\",\n \"userId\": null,\n \"mandatory\": true\n }\n ],\n \"signGroups\": [],\n \"fields\": [\n {\n \"id\": \"37ba1cad-a347-47de11c8dc\",\n \"name\": \"a4b493088d0c4284ba389500c3ad853a\",\n \"recipientId\": \"8e5e0faf-e322-6ddbe817fe1\",\n \"documentId\": \"e3dcc1e8-627cf3e477d08f\",\n \"type\": \"signature\",\n \"value\": \"\",\n \"page\": 1,\n \"height\": 35,\n \"width\": 100,\n \"positionX\": \"69.65325\",\n \"positionY\": \"24.26785\",\n \"isRequired\": true,\n \"properties\": null,\n \"signerInfo\": null\n }\n ],\n \"signer\": \"8e5e0faf-eddbe817fe1\",\n \"attachments\": [],\n \"comments\": {},\n \"settings\": [\n {\n \"settingKey\": \"ENABLE_COMMENTS\",\n \"label\": \"Enable Comments\",\n \"type\": \"Boolean\",\n \"application\": \"MDS\",\n \"category\": \"Sending Settings\",\n \"subCategory\": \"Comments\",\n \"value\": \"true\",\n \"isAnonymousSetting\": true,\n \"preserve\": true\n },\n {\n \"settingKey\": \"SEND_MFA_CODE_VIA_EMAIL\",\n \"label\": \"Receive MFA codes via email\",\n \"type\": \"Boolean\",\n \"application\": \"MDS\",\n \"category\": \"Signing Settings\",\n \"subCategory\": \"Authentication\",\n \"value\": \"false\",\n \"isAnonymousSetting\": true,\n \"preserve\": true\n },\n {\n \"settingKey\": \"ALLOW_MOBILE_SIGNING\",\n \"label\": \"Mobile Signing\",\n \"type\": \"Boolean\",\n \"application\": \"MDS\",\n \"category\": \"Signing Settings\",\n \"subCategory\": \"Recipient Experience\",\n \"value\": \"true\",\n \"isAnonymousSetting\": true,\n \"preserve\": true\n },\n {\n \"settingKey\": \"ALLOWED_SIGNATURE_INPUT_METHOD\",\n \"label\": \"Signature Input\",\n \"type\": \"Select\",\n \"application\": \"MDS\",\n \"category\": \"Signing Settings\",\n \"subCategory\": \"Recipient Experience\",\n \"value\": \"Typed,Imported\",\n \"isAnonymousSetting\": true,\n \"preserve\": true\n },\n {\n \"settingKey\": \"DECLINE_REASON_REQUIRED\",\n \"label\": \"Decline Reason Required\",\n \"type\": \"Boolean\",\n \"application\": \"MDS\",\n \"category\": \"Signing Settings\",\n \"subCategory\": \"Recipient Experience\",\n \"value\": \"false\",\n \"isAnonymousSetting\": true,\n \"preserve\": true\n },\n {\n \"settingKey\": \"REDIRECT_AFTER_SIGNING_URL\",\n \"label\": \"Redirect After Signing\",\n \"type\": \"String\",\n \"application\": \"MDS\",\n \"category\": \"Signing Settings\",\n \"subCategory\": \"Recipient Experience\",\n \"value\": \"\",\n \"isAnonymousSetting\": true,\n \"preserve\": true\n },\n {\n \"settingKey\": \"SIGNING_ALLOW_REASSIGNMENT\",\n \"label\": \"Allow Responsibility Switch\",\n \"type\": \"Boolean\",\n \"application\": \"MDS\",\n \"category\": \"Signing Settings\",\n \"subCategory\": \"Recipient Experience\",\n \"value\": \"true\",\n \"isAnonymousSetting\": true,\n \"preserve\": true\n },\n {\n \"settingKey\": \"SIGNING_AUTO_NAVIGATION\",\n \"label\": \"Auto Navigation\",\n \"type\": \"Boolean\",\n \"application\": \"MDS\",\n \"category\": \"Signing Settings\",\n \"subCategory\": \"Recipient Experience\",\n \"value\": \"true\",\n \"isAnonymousSetting\": true,\n \"preserve\": true\n }\n ]\n }\n },\n \"origin\": \"GET https://dev.headless.mavenmule.com/signatures/envelope/open\",\n \"dateTime\": \"2025-11-04T07:57:31.4244946+00:00\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "fb4616b7-72a5-41cd-8aa0-32eecd0dcb4e",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
"open"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\",\n \"urn\": \"{{sentUrn}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "b8da4264-fd3c-4f9f-b18c-9aa8e895eb42",
"name": "Signature Update",
"request": {
"name": "Signature Update",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"signature",
":signatureId",
"update"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "string",
"key": "signatureId",
"disabled": false,
"description": {
"content": "(Required) The ID of the signature that should be updated.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"signature\": {\n \"isDefault\": false,\n \"value\": \"base64\"\n },\n \"externalContext\": {\n \"id\": \"12345\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"response": [
{
"id": "af9dc2c1-6a91-44fc-bdf2-054c6adb5770",
"name": "This is the response returned when the signature is successfully updated.",
"originalRequest": {
"url": {
"path": [
"signatures",
"signature",
":signatureId",
"update"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the signature that should be updated.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "signatureId"
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"signature\": {\n \"isDefault\": false,\n \"value\": \"base64\"\n },\n \"externalContext\": {\n \"id\": \"12345\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 200,\n \"message\": \"OK\",\n \"data\": {\n \"signature\": {\n \"id\": \"3e1346f6-a534-4e53fcb0a4d\",\n \"message\": \"Signature successfully saved\"\n }\n }\n },\n \"origin\": \"PUT https://dev.headless.mavenmule.com/signatures/signature/3e1346f6-a534-4e53fcb0a4d/update\",\n \"dateTime\": \"2025-11-04T11:54:42.5961530+00:00\",\n \"userId\": \"1d8b89c4-0889-4d03-a90c-9af09ac3bc9b\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "359a6929-220f-4f0f-a437-bf8879123caa",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"signature",
":signatureId",
"update"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the signature that should be updated.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "signatureId"
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"signature\": {\n \"isDefault\": false,\n \"value\": \"base64\"\n },\n \"externalContext\": {\n \"id\": \"12345\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\"\n }\n ],\n \"externalErrors\": []\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\",\n \"userId\": \"{{userId}}\",\n \"operationId\": \"{{operationId}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "cd121323-0610-4a70-8e42-2a83dd761a8e",
"name": "This response indicates that there’s no signature found with the provided ID.",
"originalRequest": {
"url": {
"path": [
"signatures",
"signature",
":signatureId",
"update"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the signature that should be updated.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "signatureId"
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"signature\": {\n \"isDefault\": false,\n \"value\": \"base64\"\n },\n \"externalContext\": {\n \"id\": \"12345\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "Not Found",
"code": 404,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"404\",\n \"message\": \"Not Found\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "c6c61779-82ce-4886-839f-91b5b56ca111",
"name": "Envelope Update ",
"request": {
"name": "Envelope Update ",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"update"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "string",
"key": "envelopeId",
"disabled": false,
"description": {
"content": "(Required) 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.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"documents\": [\n {\n \"referenceDocumentId\": 1,\n \"name\": \"Test Document Name\",\n \"loadMethod\": \"Storage\",\n \"urn\": \"{{uploadedDocument}}\"\n }\n ],\n \"recipients\": [\n {\n \"referenceSignerId\": 1,\n \"name\": \"Test Example\",\n \"email\": \"user@example.com\",\n \"role\": \"signer\",\n \"mandatory\": true\n }\n ],\n \"fields\": [\n {\n \"type\": \"signature\",\n \"isRequired\": true,\n \"referenceSignerId\": 1,\n \"referenceDocumentId\": 1,\n \"positionX\": 10,\n \"positionY\": 10,\n \"height\": 100,\n \"width\": 100,\n \"page\": 1,\n \"name\": \"mds_signature1\",\n \"properties\": {\n \"fontFamily\": \"Arial\",\n \"fontSize\": 13,\n \"color\": \"red\",\n \"bold\": true,\n \"italic\": true,\n \"underline\": true,\n \"textAlign\": \"center\"\n }\n }\n ],\n \"envelope\": {\n \"subject\": \"Email Subject\",\n \"message\": \"Email Message\",\n \"senderName\": \"Sender\",\n \"senderEmail\": \"sender@example.com\",\n \"isSignOrder\": false,\n \"expireInDays\": 5,\n \"alertDaysBeforeExpiry\": 5,\n \"firstReminderDays\": 3,\n \"repeatingReminderDays\": 2,\n \"notifyWhenOpened\": true,\n \"notifyWhenSigned\": true\n },\n \"externalContext\": {\n \"id\": \"12345\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"response": [
{
"id": "d47953ef-3969-4a35-ac29-e3610aa1539a",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"update"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) 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.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "envelopeId"
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"documents\": [\n {\n \"referenceDocumentId\": 1,\n \"name\": \"Test Document Name\",\n \"loadMethod\": \"Storage\",\n \"urn\": \"{{uploadedDocument}}\"\n }\n ],\n \"recipients\": [\n {\n \"referenceSignerId\": 1,\n \"name\": \"Test Example\",\n \"email\": \"user@example.com\",\n \"role\": \"signer\",\n \"mandatory\": true\n }\n ],\n \"fields\": [\n {\n \"type\": \"signature\",\n \"isRequired\": true,\n \"referenceSignerId\": 1,\n \"referenceDocumentId\": 1,\n \"positionX\": 10,\n \"positionY\": 10,\n \"height\": 100,\n \"width\": 100,\n \"page\": 1,\n \"name\": \"mds_signature1\",\n \"properties\": {\n \"fontFamily\": \"Arial\",\n \"fontSize\": 13,\n \"color\": \"red\",\n \"bold\": true,\n \"italic\": true,\n \"underline\": true,\n \"textAlign\": \"center\"\n }\n }\n ],\n \"envelope\": {\n \"subject\": \"Email Subject\",\n \"message\": \"Email Message\",\n \"senderName\": \"Sender\",\n \"senderEmail\": \"sender@example.com\",\n \"isSignOrder\": false,\n \"expireInDays\": 5,\n \"alertDaysBeforeExpiry\": 5,\n \"firstReminderDays\": 3,\n \"repeatingReminderDays\": 2,\n \"notifyWhenOpened\": true,\n \"notifyWhenSigned\": true\n },\n \"externalContext\": {\n \"id\": \"12345\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 200,\n \"message\": \"OK\",\n \"data\": {\n \"envelope\": {\n \"id\": \"789cb83f-c225-46f0-bfdd\",\n \"status\": \"Draft\"\n },\n \"documents\": [\n {\n \"id\": \"e508516b-9273d-a65b7f8e69d8\",\n \"externalContext\": null\n },\n {\n \"id\": \"16ef36a6-7738-49279b77fd394\",\n \"externalContext\": null\n }\n ],\n \"recipients\": [\n {\n \"id\": \"5c33f8ae-b3ba-3a4f392f680\",\n \"externalContext\": null\n }\n ],\n \"signGroups\": [],\n \"fields\": [\n {\n \"id\": \"ffc6a7e1-26d5-3-bccbc8f7deea\",\n \"recipientId\": \"5c33f8ae-b3ba-23a4f392f680\",\n \"signGroupId\": \"00000000-0000-0000000\",\n \"documentId\": \"e508516b-9275d-a65b7f8e69d8\"\n },\n {\n \"id\": \"dc01bf88-b2fb-45a713acfe382d\",\n \"recipientId\": \"5c33f8ae-b3ba-456f392f680\",\n \"signGroupId\": \"00000000-00000000000\",\n \"documentId\": \"e508516b-925b7f8e69d8\"\n }\n ]\n }\n },\n \"origin\": \"PUT https://dev.headless.mavenmule.com/signatures/envelope/789cb83f-c225-46f0-bfdd/update\",\n \"dateTime\": \"2025-11-04T10:49:44.6418508+00:00\",\n \"userId\": \"1d8b89c4-0889-4c-909ac3bc9b\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "9a08eb4f-7877-41fe-bbd9-38f7dca9ce0d",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"update"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) 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.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "envelopeId"
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"documents\": [\n {\n \"referenceDocumentId\": 1,\n \"name\": \"Test Document Name\",\n \"loadMethod\": \"Storage\",\n \"urn\": \"{{uploadedDocument}}\"\n }\n ],\n \"recipients\": [\n {\n \"referenceSignerId\": 1,\n \"name\": \"Test Example\",\n \"email\": \"user@example.com\",\n \"role\": \"signer\",\n \"mandatory\": true\n }\n ],\n \"fields\": [\n {\n \"type\": \"signature\",\n \"isRequired\": true,\n \"referenceSignerId\": 1,\n \"referenceDocumentId\": 1,\n \"positionX\": 10,\n \"positionY\": 10,\n \"height\": 100,\n \"width\": 100,\n \"page\": 1,\n \"name\": \"mds_signature1\",\n \"properties\": {\n \"fontFamily\": \"Arial\",\n \"fontSize\": 13,\n \"color\": \"red\",\n \"bold\": true,\n \"italic\": true,\n \"underline\": true,\n \"textAlign\": \"center\"\n }\n }\n ],\n \"envelope\": {\n \"subject\": \"Email Subject\",\n \"message\": \"Email Message\",\n \"senderName\": \"Sender\",\n \"senderEmail\": \"sender@example.com\",\n \"isSignOrder\": false,\n \"expireInDays\": 5,\n \"alertDaysBeforeExpiry\": 5,\n \"firstReminderDays\": 3,\n \"repeatingReminderDays\": 2,\n \"notifyWhenOpened\": true,\n \"notifyWhenSigned\": true\n },\n \"externalContext\": {\n \"id\": \"12345\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": 400,\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"DRAFT_ID_INVALID\",\n \"message\": \"Envelope draft with ID 8952012a-b086-4aaf-be18b4 does not exist\",\n \"userMessage\": \"Envelope draft with ID 8952012a-b086-4aaf-be18b4 does not exist\"\n }\n ],\n \"externalErrors\": []\n },\n \"origin\": \"GET https://dev.headless.mavenmule.com/signatures/envelope/8952012a-b086-4aaf-be18b4/send\",\n \"dateTime\": \"2025-11-04T10:41:21.0000000+00:00\",\n \"userId\": \"1d8b89c4-0889-4d-9af09ac3bc9b\",\n \"operationId\": \"148726246e5949f517ac87582\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "8ff2da3e-f7a5-4f6c-a7d7-2c2eb9f92b7f",
"name": "This response indicates that there’s no envelope found with the provided ID.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"update"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) 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.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "envelopeId"
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"documents\": [\n {\n \"referenceDocumentId\": 1,\n \"name\": \"Test Document Name\",\n \"loadMethod\": \"Storage\",\n \"urn\": \"{{uploadedDocument}}\"\n }\n ],\n \"recipients\": [\n {\n \"referenceSignerId\": 1,\n \"name\": \"Test Example\",\n \"email\": \"user@example.com\",\n \"role\": \"signer\",\n \"mandatory\": true\n }\n ],\n \"fields\": [\n {\n \"type\": \"signature\",\n \"isRequired\": true,\n \"referenceSignerId\": 1,\n \"referenceDocumentId\": 1,\n \"positionX\": 10,\n \"positionY\": 10,\n \"height\": 100,\n \"width\": 100,\n \"page\": 1,\n \"name\": \"mds_signature1\",\n \"properties\": {\n \"fontFamily\": \"Arial\",\n \"fontSize\": 13,\n \"color\": \"red\",\n \"bold\": true,\n \"italic\": true,\n \"underline\": true,\n \"textAlign\": \"center\"\n }\n }\n ],\n \"envelope\": {\n \"subject\": \"Email Subject\",\n \"message\": \"Email Message\",\n \"senderName\": \"Sender\",\n \"senderEmail\": \"sender@example.com\",\n \"isSignOrder\": false,\n \"expireInDays\": 5,\n \"alertDaysBeforeExpiry\": 5,\n \"firstReminderDays\": 3,\n \"repeatingReminderDays\": 2,\n \"notifyWhenOpened\": true,\n \"notifyWhenSigned\": true\n },\n \"externalContext\": {\n \"id\": \"12345\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "Not Found",
"code": 404,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"404\",\n \"message\": \"Not Found\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "05fdebfb-3d65-46d0-9cd2-da5194958a03",
"name": "Envelope Audit Log Download",
"request": {
"name": "Envelope Audit Log Download",
"description": {
"content": "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).",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"audit",
"download"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "string",
"key": "envelopeId",
"disabled": false,
"description": {
"content": "(Required) The ID of the envelope where the attachment will be added.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"response": [
{
"id": "4361fcfd-1267-4f44-9027-59086d4d0fa8",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"audit",
"download"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the envelope where the attachment will be added.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "envelopeId"
}
]
},
"header": [],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [],
"cookie": [],
"_postman_previewlanguage": "text"
},
{
"id": "26c0b8f3-e74c-4841-9e29-514a7234fa43",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"audit",
"download"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the envelope where the attachment will be added.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "envelopeId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\",\n \"urn\": \"{{sentUrn}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "e598616c-8d4a-41d3-9375-008168949f5d",
"name": "This response indicates that there’s no Audit Trail found in the envelope with the provided ID.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"audit",
"download"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the envelope where the attachment will be added.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "envelopeId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Not Found",
"code": 404,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"404\",\n \"message\": \"Not Found\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "4d32a152-19f5-4a9a-b0a2-c3b50a0eb6b5",
"name": "Signature Get",
"request": {
"name": "Signature Get",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"signature",
":signatureId",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "string",
"key": "signatureId",
"disabled": false,
"description": {
"content": "(Required) The ID of the signature which information should be retrieved.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"response": [
{
"id": "fe32f30b-3790-4594-8db5-c917e132476d",
"name": "This is the response returned when the signature is successfully retrieved.
\nThe response includes all the needed signature data.",
"originalRequest": {
"url": {
"path": [
"signatures",
"signature",
":signatureId",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the signature which information should be retrieved.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "signatureId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 200,\n \"message\": \"OK\",\n \"data\": {\n \"signature\": {\n \"id\": \"3e1346f6-a534-4e53fcb0a4d\",\n \"data\": \"iVBORw0KGgoAAAANSUhEUgAAAyAAAAEsCAYAAAA7Ldc6AAAQAElEQVR4AeydBbwsR5X/hAGSURBVAMAc/JP7z78b4EAAAAASUVORK5CYII=\",\n \"isDefault\": true\n }\n }\n },\n \"origin\": \"GET https://dev.headless.mavenmule.com/signatures/signature/3e1346f6-a534-4e53fcb0a4d/get\",\n \"dateTime\": \"2025-11-04T11:43:08.3136217+00:00\",\n \"userId\": \"1d8b89c4-0889c-9af09ac3bc9b\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "a2ff281c-1fce-457c-8f13-b77cbe7f3b66",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"signature",
":signatureId",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the signature which information should be retrieved.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "signatureId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\"\n }\n ],\n \"externalErrors\": []\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\",\n \"userId\": \"{{userId}}\",\n \"operationId\": \"{{operationId}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "1142599a-92ff-4d06-a709-aa278c90ec4e",
"name": "This response indicates that there’s no signature found with the provided ID.",
"originalRequest": {
"url": {
"path": [
"signatures",
"signature",
":signatureId",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the signature which information should be retrieved.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "signatureId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Not Found",
"code": 404,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"404\",\n \"message\": \"Not Found\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "8f503716-42b2-454c-b65b-155eb234afdb",
"name": "Envelope Document Download ",
"request": {
"name": "Envelope Document Download ",
"description": {
"content": "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).",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"document",
":documentId",
"download"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": [
{
"type": "any",
"value": "string",
"key": "envelopeId",
"disabled": false,
"description": {
"content": "(Required) The ID of the envelope where the attachment is added.",
"type": "text/plain"
}
},
{
"type": "any",
"value": "string",
"key": "documentId",
"disabled": false,
"description": {
"content": "(Required) The needed string value.\nThe ID(URN) of the document you would like to download from the defined envelope.\n\n",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"response": [
{
"id": "82e6cf4e-58cd-4291-8c3a-a1688f6dcec7",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"document",
":documentId",
"download"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the envelope where the attachment is added.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "envelopeId"
},
{
"disabled": false,
"description": {
"content": "(Required) The needed string value.\nThe ID(URN) of the document you would like to download from the defined envelope.\n\n",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "documentId"
}
]
},
"header": [],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [],
"cookie": [],
"_postman_previewlanguage": "text"
},
{
"id": "3a88f89a-17bb-4c06-a6ea-372a5a60d81b",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"document",
":documentId",
"download"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the envelope where the attachment is added.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "envelopeId"
},
{
"disabled": false,
"description": {
"content": "(Required) The needed string value.\nThe ID(URN) of the document you would like to download from the defined envelope.\n\n",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "documentId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\",\n \"urn\": \"{{sentUrn}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "170fbd70-f25f-44fc-9ed0-bcae2aa80659",
"name": "This response indicates that there’s no envelope found with the provided ID or there’re no documents found in the defined envelope.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"document",
":documentId",
"download"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the envelope where the attachment is added.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "envelopeId"
},
{
"disabled": false,
"description": {
"content": "(Required) The needed string value.\nThe ID(URN) of the document you would like to download from the defined envelope.\n\n",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "documentId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Not Found",
"code": 404,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"404\",\n \"message\": \"Not Found\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "520d748b-b1fd-471a-a39b-d7ef3335ea0f",
"name": "Signature List",
"request": {
"name": "Signature List",
"description": {
"content": "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",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"signature",
"list"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"response": [
{
"id": "d44e280e-948e-40ab-9206-45f3df28c5f9",
"name": "This is the response returned when the list of available signatures is successfully retrieved.",
"originalRequest": {
"url": {
"path": [
"signatures",
"signature",
"list"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 200,\n \"message\": \"OK\",\n \"data\": {\n \"signature\": [\n {\n \"id\": \"3e1346f6-a534-4e53fcb0a4d\",\n \"isDefault\": true\n }\n ]\n }\n },\n \"origin\": \"GET https://dev.headless.mavenmule.com/signatures/signature/list\",\n \"dateTime\": \"2025-11-04T11:43:08.1266236+00:00\",\n \"userId\": \"1d8b89c4-0889-4-9af]3bc9b\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "f6cf30c9-976c-4acc-9324-0e6366c1fc65",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"signature",
"list"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\"\n }\n ],\n \"externalErrors\": []\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\",\n \"userId\": \"{{userId}}\",\n \"operationId\": \"{{operationId}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "bdfc1497-dd07-4561-b86f-9b725afa871e",
"name": "This response indicates that there’s no signature found with the provided ID.",
"originalRequest": {
"url": {
"path": [
"signatures",
"signature",
"list"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Not Found",
"code": 404,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"404\",\n \"message\": \"Not Found\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "2402a99f-a97e-47ea-9383-530405cf1a86",
"name": "Signature Delete",
"request": {
"name": "Signature Delete",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"signature",
":signatureId",
"delete"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "string",
"key": "signatureId",
"disabled": false,
"description": {
"content": "(Required) The ID of the signature that should be deleted.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "DELETE",
"body": {}
},
"response": [
{
"id": "e8bfa99b-01c2-4a77-9ce1-094ece381fb2",
"name": "This response indicates that the signature identified by the provided signatureId was successfully deleted.",
"originalRequest": {
"url": {
"path": [
"signatures",
"signature",
":signatureId",
"delete"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the signature that should be deleted.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "signatureId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "DELETE",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 200,\n \"message\": \"OK\",\n \"data\": {\n \"signature\": {\n \"id\": \"3e1346f6-a534-4e53fcb0a4d\",\n \"message\": \"SIGNATURE_DELETED\"\n }\n }\n },\n \"origin\": \"DELETE https://dev.headless.mavenmule.com/signatures/signature/3e1346f6-a534-4e53fcb0a4d/delete\",\n \"dateTime\": \"2025-11-04T11:33:05.3790992+00:00\",\n \"userId\": \"1d8b89c4-0889-4d0f09ac3bc9b\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "3c35d1f4-6fe5-451f-8aab-3dc32f8d81ed",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"signature",
":signatureId",
"delete"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the signature that should be deleted.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "signatureId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "DELETE",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\"\n }\n ],\n \"externalErrors\": []\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\",\n \"userId\": \"{{userId}}\",\n \"operationId\": \"{{operationId}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "baf4fcc3-ca6c-4276-8e46-739b57706916",
"name": "This response indicates that there’s no signature found with the provided ID.",
"originalRequest": {
"url": {
"path": [
"signatures",
"signature",
":signatureId",
"delete"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the signature that should be deleted.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "signatureId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "DELETE",
"body": {}
},
"status": "Not Found",
"code": 404,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"404\",\n \"message\": \"Not Found\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "fe0449f6-b0d2-423e-99d3-b1a15dfeda38",
"name": "Envelope Cancel ",
"request": {
"name": "Envelope Cancel ",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"cancel"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "string",
"key": "envelopeId",
"disabled": false,
"description": {
"content": "(Required) The ID of the envelope which Audit trail is needed.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"response": [
{
"id": "fb0141d7-78f9-4b5d-86b7-c8fd32d3c724",
"name": "This response indicates that the sent envelope is cancelled successfully.
\nIt includes detailed information about the action.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"cancel"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the envelope which Audit trail is needed.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "envelopeId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 200,\n \"message\": \"OK\",\n \"data\": {\n \"envelope\": {\n \"id\": \"8912a-b086-4aaf-b1de\",\n \"message\": \"Envelope successfully cancelled\"\n }\n }\n },\n \"origin\": \"GET https://dev.headless.mavenmule.com/signatures/envelope/8912a-b086-4aaf-b1de/cancel\",\n \"dateTime\": \"2025-11-03T11:30:04.1831907+00:00\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "9541df80-45d5-4243-a1d2-ddfe79c9c230",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"cancel"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the envelope which Audit trail is needed.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "envelopeId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\",\n \"urn\": \"{{sentUrn}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "f76de329-1658-4924-b0e9-54e5ff147f97",
"name": "This response indicates that there’s no envelope found with the provided ID.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"cancel"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the envelope which Audit trail is needed.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "envelopeId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Not Found",
"code": 404,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"404\",\n \"message\": \"Not Found\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "45524d97-ee61-431c-b6f1-010d1fad7f77",
"name": "Envelope Attachment Upload ",
"request": {
"name": "Envelope Attachment Upload ",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"attachment",
"upload"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": [
{
"type": "any",
"value": "string",
"key": "envelopeId",
"disabled": false,
"description": {
"content": "(Required) The ID of the envelope where the attachment will be added.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {}
},
"response": [
{
"id": "ce50ed2c-71d7-41ed-af81-0b8cc1b71c0d",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"attachment",
"upload"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the envelope where the attachment will be added.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "envelopeId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {}
},
"status": "Created",
"code": 201,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"data\": {\n \"files\": [\n {\n \"id\": \"76bb26-21b1-4d47132c4\",\n \"fileName\": \"SampleAttachment.jpg\"\n }\n ]\n },\n \"statusCode\": 201,\n \"message\": \"Created\"\n },\n \"origin\": \"POST https://dev.headless.mavenmule.com/signatures/envelope/7a5d60-a222-4c3e490ef1/attachment/upload\",\n \"dateTime\": \"2025-11-03T06:48:58.5308568+00:00\",\n \"operationId\": \"ea5716c820f26295b44c2fb2\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "7ef759a4-e938-4250-b232-aff1fce1f4ee",
"name": "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",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"attachment",
"upload"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the envelope where the attachment will be added.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "envelopeId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\",\n \"urn\": \"{{sentUrn}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "a1869520-5db4-4be1-a86f-f0ab602d0607",
"name": "Envelope Attachment Download",
"request": {
"name": "Envelope Attachment Download",
"description": {
"content": "Downloads an attachment associated with an envelope.
\n* The attachment is returned in its original format as uploaded.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"attachment",
":attachmentId",
"download"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": [
{
"type": "any",
"value": "{{envelopeId}}",
"key": "envelopeId",
"disabled": false,
"description": {
"content": "(Required) The ID of the envelope which Audit trail is needed. (This can only be one of {{envelopeId}})",
"type": "text/plain"
}
},
{
"type": "any",
"value": "{{attachmentId}}",
"key": "attachmentId",
"disabled": false,
"description": {
"content": "(Required) The needed string value. The ID of the needed attachment from the defined envelope. (This can only be one of {{attachmentId}})",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"response": [
{
"id": "6ffb933c-ff97-49c6-908f-29a814fd9690",
"name": "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.).",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"attachment",
":attachmentId",
"download"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the envelope which Audit trail is needed. (This can only be one of {{envelopeId}})",
"type": "text/plain"
},
"type": "any",
"value": "{{envelopeId}}",
"key": "envelopeId"
},
{
"disabled": false,
"description": {
"content": "(Required) The needed string value. The ID of the needed attachment from the defined envelope. (This can only be one of {{attachmentId}})",
"type": "text/plain"
},
"type": "any",
"value": "{{attachmentId}}",
"key": "attachmentId"
}
]
},
"header": [],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [],
"cookie": [],
"_postman_previewlanguage": "text"
},
{
"id": "618dd35d-fa62-4875-b584-24dd156207e2",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"attachment",
":attachmentId",
"download"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the envelope which Audit trail is needed. (This can only be one of {{envelopeId}})",
"type": "text/plain"
},
"type": "any",
"value": "{{envelopeId}}",
"key": "envelopeId"
},
{
"disabled": false,
"description": {
"content": "(Required) The needed string value. The ID of the needed attachment from the defined envelope. (This can only be one of {{attachmentId}})",
"type": "text/plain"
},
"type": "any",
"value": "{{attachmentId}}",
"key": "attachmentId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\",\n \"urn\": \"{{sentUrn}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "13a9a6c4-9931-4073-8769-fd87863b37db",
"name": "This response indicates that there’re no attachments found in the envelope with the provided ID.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"attachment",
":attachmentId",
"download"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the envelope which Audit trail is needed. (This can only be one of {{envelopeId}})",
"type": "text/plain"
},
"type": "any",
"value": "{{envelopeId}}",
"key": "envelopeId"
},
{
"disabled": false,
"description": {
"content": "(Required) The needed string value. The ID of the needed attachment from the defined envelope. (This can only be one of {{attachmentId}})",
"type": "text/plain"
},
"type": "any",
"value": "{{attachmentId}}",
"key": "attachmentId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Not Found",
"code": 404,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"404\",\n \"message\": \"Not Found\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "9d515b53-4aa3-4544-9715-99a2b0af97ef",
"name": "Envelope Check",
"request": {
"name": "Envelope Check",
"description": {
"content": "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",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"envelope",
"check"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"response": [
{
"id": "104f31e9-c2c8-45d7-9927-c820da65c762",
"name": "This is the response returned when the envelope is successfully checked.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
"check"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 200,\n \"message\": \"OK\",\n \"data\": {\n \"envelope\": {\n \"id\": \"eab98526-e8-6e99b7cc99dc\",\n \"uploadDate\": \"2025-10-31T12:57:01.0000000+00:00\",\n \"status\": \"In Progress\"\n },\n \"recipient\": {\n \"id\": \"b9bb72f2-997aab21bf2a\",\n \"role\": \"signer\",\n \"name\": \"RomanK\",\n \"email\": \"roman.khryshchanovich@mavenmule.com\",\n \"status\": \"In Progress\",\n \"isTokenExpired\": false,\n \"legalAccepted\": false,\n \"isMfaEnabled\": false,\n \"isMfaValid\": false,\n \"hostEmail\": \"\"\n },\n \"settings\": [\n {\n \"settingKey\": \"ENABLE_COMMENTS\",\n \"label\": \"Enable Comments\",\n \"type\": \"Boolean\",\n \"application\": \"MDS\",\n \"category\": \"Sending Settings\",\n \"subCategory\": \"Comments\",\n \"value\": \"true\",\n \"isAnonymousSetting\": true,\n \"preserve\": true\n },\n {\n \"settingKey\": \"ALLOW_MOBILE_SIGNING\",\n \"label\": \"Mobile Signing\",\n \"type\": \"Boolean\",\n \"application\": \"MDS\",\n \"category\": \"Signing Settings\",\n \"subCategory\": \"Recipient Experience\",\n \"value\": \"true\",\n \"isAnonymousSetting\": true,\n \"preserve\": true\n },\n {\n \"settingKey\": \"ALLOWED_SIGNATURE_INPUT_METHOD\",\n \"label\": \"Signature Input\",\n \"type\": \"Select\",\n \"application\": \"MDS\",\n \"category\": \"Signing Settings\",\n \"subCategory\": \"Recipient Experience\",\n \"value\": \"Typed,Imported\",\n \"isAnonymousSetting\": true,\n \"preserve\": true\n },\n {\n \"settingKey\": \"DECLINE_REASON_REQUIRED\",\n \"label\": \"Decline Reason Required\",\n \"type\": \"Boolean\",\n \"application\": \"MDS\",\n \"category\": \"Signing Settings\",\n \"subCategory\": \"Recipient Experience\",\n \"value\": \"false\",\n \"isAnonymousSetting\": true,\n \"preserve\": true\n },\n {\n \"settingKey\": \"REDIRECT_AFTER_SIGNING_URL\",\n \"label\": \"Redirect After Signing\",\n \"type\": \"String\",\n \"application\": \"MDS\",\n \"category\": \"Signing Settings\",\n \"subCategory\": \"Recipient Experience\",\n \"value\": \"\",\n \"isAnonymousSetting\": true,\n \"preserve\": true\n },\n {\n \"settingKey\": \"SIGNING_ALLOW_REASSIGNMENT\",\n \"label\": \"Allow Responsibility Switch\",\n \"type\": \"Boolean\",\n \"application\": \"MDS\",\n \"category\": \"Signing Settings\",\n \"subCategory\": \"Recipient Experience\",\n \"value\": \"true\",\n \"isAnonymousSetting\": true,\n \"preserve\": true\n },\n {\n \"settingKey\": \"SIGNING_AUTO_NAVIGATION\",\n \"label\": \"Auto Navigation\",\n \"type\": \"Boolean\",\n \"application\": \"MDS\",\n \"category\": \"Signing Settings\",\n \"subCategory\": \"Recipient Experience\",\n \"value\": \"true\",\n \"isAnonymousSetting\": true,\n \"preserve\": true\n }\n ]\n }\n },\n \"origin\": \"GET https://dev.headless.mavenmule.com/signatures/envelope/check\",\n \"dateTime\": \"2025-10-31T01:10:54.0000000+00:00\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "2e8e9ce9-1375-4141-9f47-438bcb08477e",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
"check"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\",\n \"urn\": \"{{sentUrn}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "452d8c91-7b07-481c-a90e-d13ac1bd36ec",
"name": "MFA Initiate",
"request": {
"name": "MFA Initiate",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"mfa",
"initiate"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {}
},
"response": [
{
"id": "0f0ed3f0-77dc-4576-8609-15aa2e0becc1",
"name": "This is the response returned when the multi-factor authentication is initiated successfully.",
"originalRequest": {
"url": {
"path": [
"signatures",
"mfa",
"initiate"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 200,\n \"message\": \"OK\",\n \"data\": {\n \"recipient\": {\n \"method\": \"sms\",\n \"destination\": {\n \"phoneNumber\": \"\",\n \"email\": \"hrishchanovich92@gmail.com\"\n },\n \"expiresAt\": \"2025-11-05T06:48:48.0000000+00:00\",\n \"message\": \"MFA code successfully sent\"\n }\n }\n },\n \"origin\": \"POST https://dev.headless.mavenmule.com/signatures/mfa/initiate\",\n \"dateTime\": \"2025-11-05T06:38:53.0000000+00:00\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "9e7953a5-29f9-4f65-ac2b-d1e124d113b8",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"mfa",
"initiate"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\",\n \"urn\": \"{{sentUrn}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "eded2ae1-85f1-493b-bdf7-c905008a7f57",
"name": "MFA Verify",
"request": {
"name": "MFA Verify",
"description": {
"content": "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",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"mfa",
"verify"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {}
},
"response": [
{
"id": "aa2a8c05-b568-455f-b764-b4fafcfae866",
"name": "This is the response returned when the multi-factor authentication was successfully verified.",
"originalRequest": {
"url": {
"path": [
"signatures",
"mfa",
"verify"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 200,\n \"message\": \"OK\",\n \"data\": {\n \"recipient\": {\n \"method\": \"sms\",\n \"destination\": \"\",\n \"message\": \"MFA code successfully verified\"\n }\n }\n },\n \"origin\": \"POST https://dev.headless.mavenmule.com/signatures/mfa/verify\",\n \"dateTime\": \"2025-11-05T06:42:40.0000000+00:00\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "f9b98306-8936-4afa-825a-c4f8c15ffdfc",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"mfa",
"verify"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": 400,\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"MFA_INVALID_OR_EXPIRED_CODE\",\n \"message\": \"Invalid or expired MFA code.\",\n \"userMessage\": \"Invalid or expired MFA code. Please request a new MFA code.\"\n }\n ],\n \"externalErrors\": []\n },\n \"origin\": \"POST https://test.headless.mavenmule.com/signatures/mfa/verify\",\n \"dateTime\": \"2025-11-05T12:35:38.0000000+00:00\",\n \"operationId\": \"6f728f58d0bdf45c62e9ab24e65\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "fe68cdfc-e8aa-4dfc-947f-fa9d344ca2d6",
"name": "Envelope Create From Template",
"request": {
"name": "Envelope Create From Template",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"template",
":templateId",
"envelope",
"create"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "string",
"key": "templateId",
"disabled": false,
"description": {
"content": "(Required) The ID of the template based on which the envelope is created.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"envelope\": {\n \"subject\": \"TestPostman\",\n \"message\": \"\"\n },\n \"message\": {\n \"subject\": \"TestPostman\",\n \"recipients\": [\n {\n \"templateRole\": \"Role1\",\n \"name\": \"RomanK\",\n \"email\": \"roman.khryshchanovich@mavenmule.com\"\n }\n ]\n },\n \"signGroups\": []\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"response": [
{
"id": "70302154-4294-42fa-b113-ceb808d3ae0b",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"template",
":templateId",
"envelope",
"create"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the template based on which the envelope is created.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "templateId"
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"envelope\": {\n \"subject\": \"TestPostman\",\n \"message\": \"\"\n },\n \"message\": {\n \"subject\": \"TestPostman\",\n \"recipients\": [\n {\n \"templateRole\": \"Role1\",\n \"name\": \"RomanK\",\n \"email\": \"roman.khryshchanovich@mavenmule.com\"\n }\n ]\n },\n \"signGroups\": []\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "Created",
"code": 201,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 201,\n \"message\": \"Created\",\n \"data\": {\n \"envelope\": {\n \"id\": \"cc25cdaa-4-b29c-2f741f612ae0\",\n \"uploadDate\": \"2025-11-03T12:19:00.0000000+00:00\",\n \"status\": \"Draft\"\n },\n \"documents\": [\n {\n \"id\": \"0a01e9d6-897b1-fa5d3b1c3\",\n \"externalContext\": null\n }\n ],\n \"recipients\": [\n {\n \"id\": \"df5c2206-56-00a8be08522d\",\n \"externalContext\": null\n }\n ],\n \"signGroups\": [],\n \"fields\": [\n {\n \"id\": \"558329f7-a425-005077518b\",\n \"recipientId\": \"df5c2206-56e22d\",\n \"signGroupId\": \"0000000-0000000\",\n \"documentId\": \"0a01e-a5cbed3b1c3\"\n }\n ]\n }\n },\n \"origin\": \"POST https://dev.headless.mavenmule.com/signatures/template/816f309c-8e823ee9/envelope/create\",\n \"dateTime\": \"2025-11-03T12:19:00.0000000+00:00\",\n \"userId\": \"1d8b89c4-0889-4d03-a90c-9af09ac3bc9b\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "823f4f15-ab13-4122-8ad8-490b3b79ca11",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"template",
":templateId",
"envelope",
"create"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the template based on which the envelope is created.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "templateId"
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"envelope\": {\n \"subject\": \"TestPostman\",\n \"message\": \"\"\n },\n \"message\": {\n \"subject\": \"TestPostman\",\n \"recipients\": [\n {\n \"templateRole\": \"Role1\",\n \"name\": \"RomanK\",\n \"email\": \"roman.khryshchanovich@mavenmule.com\"\n }\n ]\n },\n \"signGroups\": []\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": 400,\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"ANCHOR_PROVIDED_POSITION_NOT_REQUIRED\",\n \"message\": \"Field can only be positioned based on an anchor string or manual positioning, not both.\",\n \"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).\"\n }\n ],\n \"externalErrors\": []\n },\n \"externalContext\": {\n \"test1\": \"testvalueenvelope\"\n },\n \"origin\": \"POST https://dev.headless.mavenmule.com/signatures/envelope/create\",\n \"dateTime\": \"2025-10-31T09:27:55.0000000+00:00\",\n \"userId\": \"1d8b89c4-0889-4d03-a90c-9af09ac3bc9b\",\n \"operationId\": \"e6a5c583f9746252cc2fd5ff15fd836c\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "b1105c5b-36bc-44a2-8702-780c99392f6f",
"name": "This is the response returned when the request has the invalid data.
\nFor example, the referenced file doesn't exist in Storage.",
"originalRequest": {
"url": {
"path": [
"signatures",
"template",
":templateId",
"envelope",
"create"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the template based on which the envelope is created.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "templateId"
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"envelope\": {\n \"subject\": \"TestPostman\",\n \"message\": \"\"\n },\n \"message\": {\n \"subject\": \"TestPostman\",\n \"recipients\": [\n {\n \"templateRole\": \"Role1\",\n \"name\": \"RomanK\",\n \"email\": \"roman.khryshchanovich@mavenmule.com\"\n }\n ]\n },\n \"signGroups\": []\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "Internal Server Error",
"code": 500,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": 500,\n \"message\": \"Internal Server Error\",\n \"innerErrors\": [\n {\n \"code\": \"FILE_NOT_EXISTS_IN_STORAGE\",\n \"message\": \"File with identifier bddd84db-3305-4df7-a2af-52c691d2bfdf not found in storage.\",\n \"userMessage\": \"File with identifier bddd84db-3305-4df7-a2af-52c691d2bfdf not found in storage.\"\n }\n ],\n \"externalErrors\": []\n },\n \"origin\": \"POST https://dev.headless.mavenmule.com/signatures/envelope/create\",\n \"dateTime\": \"2025-10-31T09:33:29.0000000+00:00\",\n \"operationId\": \"4292a54fa4469c01c0ab4cff3b03a1a2\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "e66bcbe8-4a13-4ce1-8669-f704198ecb48",
"name": "Envelope Reassign",
"request": {
"name": "Envelope Reassign",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"envelope",
"reassign"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {}
},
"response": [
{
"id": "088256db-0232-4da5-852b-c13d73e401b8",
"name": "This is the response returned when the envelope is successfully declined.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
"reassign"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 200,\n \"message\": \"OK\",\n \"data\": {\n \"envelope\": {\n \"id\": \"e08f7851-dc1d-4823-af58-d2ff0857c4e4\",\n \"message\": \"Envelope successfully reassigned\"\n }\n }\n },\n \"origin\": \"POST https://dev.headless.mavenmule.com/signatures/envelope/reassign\",\n \"dateTime\": \"2025-11-04T08:23:29.0000000+00:00\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "0c8da085-9f33-4383-9d54-a97fc25f9a22",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
"reassign"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\",\n \"urn\": \"{{sentUrn}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "9ea6878a-ef7c-4d07-b5a1-ed320488cf49",
"name": "Envelope Count",
"request": {
"name": "Envelope Count",
"description": {
"content": "The endpoint retrieves the number of envelopes and divides them by folders.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"envelope",
"count"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"response": [
{
"id": "0e23b5ca-8421-4832-9c5e-f88957248b1c",
"name": "This response is returned after the amount of envelopes is successfully counted.
The number of envelopes is sorted by folders.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
"count"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 200,\n \"message\": \"OK\",\n \"data\": {\n \"envelopes\": {\n \"inbox\": 39,\n \"sent\": 39,\n \"drafts\": 1,\n \"trash\": 0,\n \"todo\": 5,\n \"expiring\": 2,\n \"pending\": 1,\n \"completed\": 22\n }\n }\n },\n \"origin\": \"GET https://dev.headless.mavenmule.com/signatures/envelope/count\",\n \"dateTime\": \"2025-12-02T11:30:34.0000000+00:00\",\n \"userId\": \"b20878ce-1947-4e52-a2c8\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "de3c97ec-8d49-465d-9659-1dc3cfa793f4",
"name": "This is the response returned when the request was formed incorrectly.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
"count"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\",\n \"urn\": \"{{sentUrn}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
}
]
},
{
"name": "Document",
"description": "",
"item": [
{
"id": "eb059860-4b3a-4a63-a001-c448bee08847",
"name": "Document Manage",
"request": {
"name": "Document Manage",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"document",
"manage"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "X-Client-Authorization",
"value": ""
},
{
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "X-Service-Authorization",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\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}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"response": [
{
"id": "a1519035-39ef-49eb-a358-58db7e6ceffc",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"document",
"manage"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "X-Client-Authorization",
"value": ""
},
{
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "X-Service-Authorization",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\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}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "Created",
"code": 201,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": \"201\",\n \"message\": \"Created\",\n \"data\": {\n \"document\": {\n \"deliveryMethod\": \"Storage\",\n \"name\": \"Sales Agreement DOCX\",\n \"fileFormat\": \"pdf\",\n \"urn\": \"20b8feea-a8e6-929d-5beb67a290b8\"\n }\n }\n },\n \"consumption\": [\n {\n \"dimension\": \"pages-managed\",\n \"value\": 5\n },\n {\n \"dimension\": \"documents-managed\",\n \"value\": 1\n }\n ],\n \"origin\": \"POST https://dev.headless.mavenmule.com/signatures/document/manage\",\n \"dateTime\": \"2025-11-05T11:02:16.4722505+00:00\",\n \"userId\": \"1d8b89c4-0889-0c-9af09ac3bc9b\",\n \"operationId\": \"a9733c420a9e6336ea36ed98f31\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "c1df4ea1-9f2b-445a-becd-bb1c603ce250",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"document",
"manage"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "X-Client-Authorization",
"value": ""
},
{
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "X-Service-Authorization",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\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}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\",\n \"eventId\": \"{{eventId}}\"\n }\n ],\n \"externalErrors\": []\n },\n \"externalContext\": {\n \"actionRequestId\": \"{{externalContextId}}\"\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\",\n \"userId\": \"{{userId}}\",\n \"operationId\": \"{{operationId}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "e53d4ad9-5eae-4075-a3e5-d10152c894d9",
"name": "Document Get",
"request": {
"name": "Document Get",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"document",
":documentId",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": [
{
"type": "any",
"value": "string",
"key": "documentId",
"disabled": false,
"description": {
"content": "(Required) The ID(URN) of the document that is included into an envelope.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"response": [
{
"id": "b475f7b4-d2f2-4333-afce-b3aa3f393cfd",
"name": "The response body contains the data of the respective document in the JSON format.",
"originalRequest": {
"url": {
"path": [
"signatures",
"document",
":documentId",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID(URN) of the document that is included into an envelope.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "documentId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 200,\n \"message\": \"OK\",\n \"data\": {\n \"document\": {\n \"id\": \"629d2b7e-378f-46e-4e5646764c4d\",\n \"name\": \"Test Document Name\",\n \"externalContext\": {\n \"test1\": \"testvaluedocument\"\n }\n }\n }\n },\n \"origin\": \"GET https://dev.headless.mavenmule.com/signatures/document/629d2b7e-378f-46e-4e5646764c4d/get\",\n \"dateTime\": \"2025-10-31T11:03:32.9773740+00:00\",\n \"userId\": \"1d8b89c4-0889-a90c-9af09ac3bc9b\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "109c207c-13e4-4e89-9144-6244856d4753",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"document",
":documentId",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID(URN) of the document that is included into an envelope.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "documentId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": 400,\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"DOCUMENT_ID_INVALID\",\n \"message\": \"Document with ID feea3b5df-9c328c0e does not exist\",\n \"userMessage\": \"Document with ID f-27f0cc328c0e does not exist\"\n }\n ],\n \"externalErrors\": []\n },\n \"origin\": \"GET https://dev.headless.mavenmule.com/signatures/document/feea3b5d-27f0cc328c0e/get\",\n \"dateTime\": \"2025-11-03T07:39:02.0000000+00:00\",\n \"userId\": \"1d8b89c4-09ac3bc9b\",\n \"operationId\": \"7ebd502c3e1ef9792\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "e8717f42-97a2-4166-9e51-4f5c7f7bb1fd",
"name": "This response indicates that the file with the provided ID is not found in the envelope.",
"originalRequest": {
"url": {
"path": [
"signatures",
"document",
":documentId",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID(URN) of the document that is included into an envelope.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "documentId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Not Found",
"code": 404,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"404\",\n \"message\": \"Not Found\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "f88eb8bf-67dd-454a-9deb-8688ef8b558e",
"name": "File Retrieve",
"request": {
"name": "File Retrieve",
"description": {
"content": "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).",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"file",
"retrieve"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"response": [
{
"id": "0d5f2a5a-d5d7-4674-8283-84f6729dc0f1",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"file",
"retrieve"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\",\n \"urn\": \"{{sentUrn}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "46c06c99-e217-4950-baf9-e609e71dd83f",
"name": "Document Upload",
"request": {
"name": "Document Upload",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"document",
"upload"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {}
},
"response": [
{
"id": "79746a13-a0f7-497b-90c9-13af49127585",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"document",
"upload"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {}
},
"status": "Created",
"code": 201,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"data\": {\n \"files\": [\n {\n \"id\": \"b6a5f346-6b60-4c-d55782651280\",\n \"fileName\": \"Sales Agreement DOCX.docx\"\n }\n ]\n },\n \"statusCode\": 201,\n \"message\": \"Created\"\n },\n \"origin\": \"POST https://dev.headless.mavenmule.com/signatures/document/upload\",\n \"dateTime\": \"2025-11-05T11:02:07.0061745+00:00\",\n \"operationId\": \"be40dc606fbf6adc1702572ecb\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "c455d5b6-1336-4d88-8a2f-3e8c1cdccf8a",
"name": "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",
"originalRequest": {
"url": {
"path": [
"signatures",
"document",
"upload"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": 400,\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"FORM_DATA_EXPECTED\",\n \"message\": \"Request must be multipart/form-data.\",\n \"userMessage\": \"Request must be multipart/form-data.\"\n }\n ],\n \"externalErrors\": []\n },\n \"origin\": \"POST https://dev.headless.mavenmule.com/documents/document/upload\",\n \"dateTime\": \"2025-10-31T08:19:03.0000000+00:00\",\n \"operationId\": \"a9733c420a9e6336ea36ed98f31\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "15f7c44d-303e-433e-964d-70107a2f4b10",
"name": "Document Download",
"request": {
"name": "Document Download",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"document",
":documentId",
"download"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": [
{
"type": "any",
"value": "string",
"key": "documentId",
"disabled": false,
"description": {
"content": "(Required) The ID(URN) of the document you would like to download from Storage.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Accept",
"value": "application/octet-stream"
}
],
"method": "GET",
"body": {}
},
"response": [
{
"id": "68d2b8b4-ac6b-4eeb-832f-bb84413b3cfd",
"name": "Response body contains the binary content of the requested document (e.g., a PDF file), streamed directly to the client for download.",
"originalRequest": {
"url": {
"path": [
"signatures",
"document",
":documentId",
"download"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID(URN) of the document you would like to download from Storage.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "documentId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/octet-stream"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/octet-stream"
}
],
"body": "{\n \"summary\": \"Binary document stream\",\n \"description\": \"The binary content of the requested document (e.g., PDF)\",\n \"value\": null\n}",
"cookie": [],
"_postman_previewlanguage": "text"
},
{
"id": "b1531fc8-e809-4981-ae83-d737ac9fac81",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"document",
":documentId",
"download"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID(URN) of the document you would like to download from Storage.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "documentId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\",\n \"urn\": \"{{sentUrn}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "e9f21566-d745-4949-8d85-22719ebba5d2",
"name": "This response indicates that the file with the provided ID is not found in the Storage system.",
"originalRequest": {
"url": {
"path": [
"signatures",
"document",
":documentId",
"download"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID(URN) of the document you would like to download from Storage.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "documentId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Not Found",
"code": 404,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"404\",\n \"message\": \"Not Found\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "7c98bc9a-b6ef-470c-945f-b6fba3420e62",
"name": "Envelope Document Download ",
"request": {
"name": "Envelope Document Download ",
"description": {
"content": "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).",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"document",
":documentId",
"download"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": [
{
"type": "any",
"value": "string",
"key": "envelopeId",
"disabled": false,
"description": {
"content": "(Required) The ID of the envelope where the attachment is added.",
"type": "text/plain"
}
},
{
"type": "any",
"value": "string",
"key": "documentId",
"disabled": false,
"description": {
"content": "(Required) The needed string value.\nThe ID(URN) of the document you would like to download from the defined envelope.\n\n",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"response": [
{
"id": "52257e29-c753-4e70-be68-316241678e7f",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"document",
":documentId",
"download"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the envelope where the attachment is added.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "envelopeId"
},
{
"disabled": false,
"description": {
"content": "(Required) The needed string value.\nThe ID(URN) of the document you would like to download from the defined envelope.\n\n",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "documentId"
}
]
},
"header": [],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [],
"cookie": [],
"_postman_previewlanguage": "text"
},
{
"id": "323bd8a9-96ca-4b99-b303-f065aa5d3a55",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"document",
":documentId",
"download"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the envelope where the attachment is added.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "envelopeId"
},
{
"disabled": false,
"description": {
"content": "(Required) The needed string value.\nThe ID(URN) of the document you would like to download from the defined envelope.\n\n",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "documentId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\",\n \"urn\": \"{{sentUrn}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "f81eec7d-3e51-42f4-87e5-ad6c4cd14f71",
"name": "This response indicates that there’s no envelope found with the provided ID or there’re no documents found in the defined envelope.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"document",
":documentId",
"download"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the envelope where the attachment is added.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "envelopeId"
},
{
"disabled": false,
"description": {
"content": "(Required) The needed string value.\nThe ID(URN) of the document you would like to download from the defined envelope.\n\n",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "documentId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Not Found",
"code": 404,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"404\",\n \"message\": \"Not Found\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "ce8fbbb2-c879-44c9-8a04-e8ca63fd1396",
"name": "Document Comment",
"request": {
"name": "Document Comment",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"document",
":documentId",
"comment"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": [
{
"type": "any",
"value": "string",
"key": "documentId",
"disabled": false,
"description": {
"content": "(Required) The ID(URN) of the document from the envelope, where you’d like to place a comment.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {}
},
"response": [
{
"id": "8fd5de12-a0f0-48f1-844a-d565e4d8b0ef",
"name": "This response is returned after a successful request to place the comment.",
"originalRequest": {
"url": {
"path": [
"signatures",
"document",
":documentId",
"comment"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID(URN) of the document from the envelope, where you’d like to place a comment.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "documentId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {}
},
"status": "Created",
"code": 201,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 201,\n \"message\": \"Created\",\n \"data\": {\n \"comments\": {\n \"629d2b7e-378f-88e-4e5646764c4d\": [\n {\n \"id\": 6,\n \"commentGuid\": \"46e10767-8806-40bbe6fc\",\n \"documentId\": 47,\n \"signerId\": 49,\n \"parentCommentId\": null,\n \"parentCommentGuid\": null,\n \"content\": \"TEST\",\n \"pageNumber\": 1,\n \"positionX\": 1201.95351573992,\n \"positionY\": 134.439541041483,\n \"visibleTo\": \"[\\\"sender\\\",\\\"fc6f00f-f125-4939fa6\\\"]\",\n \"createdAt\": \"2025-10-31T10:44:30.0000000+00:00\",\n \"authorName\": \"RomanK\",\n \"authorEmail\": \"roman.khryshchanovich@mavenmule.com\",\n \"documentGuid\": \"629db7-378f-4e56476c4d\"\n }\n ]\n }\n }\n },\n \"origin\": \"POST https://dev.headless.mavenmule.com/signatures/document/629db7-378f-4e56476c4d/comment\",\n \"dateTime\": \"2025-10-31T10:44:31.0000000+00:00\",\n \"userId\": \"1d8b89c4-0889--9af09ac3bc9b\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "7fe942c4-ad61-4d62-9560-15b3a92992fd",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"document",
":documentId",
"comment"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID(URN) of the document from the envelope, where you’d like to place a comment.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "documentId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\",\n \"urn\": \"{{sentUrn}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
}
]
},
{
"name": "Data",
"description": "",
"item": [
{
"id": "2e3da6d5-5981-4d22-a961-cce784c4038c",
"name": "Document Get",
"request": {
"name": "Document Get",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"document",
":documentId",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": [
{
"type": "any",
"value": "string",
"key": "documentId",
"disabled": false,
"description": {
"content": "(Required) The ID(URN) of the document that is included into an envelope.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"response": [
{
"id": "25d7e9a1-1805-42f0-be10-61b3ff47eff2",
"name": "The response body contains the data of the respective document in the JSON format.",
"originalRequest": {
"url": {
"path": [
"signatures",
"document",
":documentId",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID(URN) of the document that is included into an envelope.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "documentId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 200,\n \"message\": \"OK\",\n \"data\": {\n \"document\": {\n \"id\": \"629d2b7e-378f-46e-4e5646764c4d\",\n \"name\": \"Test Document Name\",\n \"externalContext\": {\n \"test1\": \"testvaluedocument\"\n }\n }\n }\n },\n \"origin\": \"GET https://dev.headless.mavenmule.com/signatures/document/629d2b7e-378f-46e-4e5646764c4d/get\",\n \"dateTime\": \"2025-10-31T11:03:32.9773740+00:00\",\n \"userId\": \"1d8b89c4-0889-a90c-9af09ac3bc9b\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "2ac39a7f-2449-4ea7-9a3b-c6b4c2dcab20",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"document",
":documentId",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID(URN) of the document that is included into an envelope.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "documentId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": 400,\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"DOCUMENT_ID_INVALID\",\n \"message\": \"Document with ID feea3b5df-9c328c0e does not exist\",\n \"userMessage\": \"Document with ID f-27f0cc328c0e does not exist\"\n }\n ],\n \"externalErrors\": []\n },\n \"origin\": \"GET https://dev.headless.mavenmule.com/signatures/document/feea3b5d-27f0cc328c0e/get\",\n \"dateTime\": \"2025-11-03T07:39:02.0000000+00:00\",\n \"userId\": \"1d8b89c4-09ac3bc9b\",\n \"operationId\": \"7ebd502c3e1ef9792\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "8fa3ca83-0b51-439c-ab2e-ccb3b07a866e",
"name": "This response indicates that the file with the provided ID is not found in the envelope.",
"originalRequest": {
"url": {
"path": [
"signatures",
"document",
":documentId",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID(URN) of the document that is included into an envelope.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "documentId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Not Found",
"code": 404,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"404\",\n \"message\": \"Not Found\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "25e0c71e-bf55-4029-9c64-e2e5727b70a2",
"name": "User Activity Get",
"request": {
"name": "User Activity Get",
"description": {
"content": "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).",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"user",
"activity",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"response": [
{
"id": "f5ba55d2-135f-4dbb-9d78-2a5cb1569b8c",
"name": "This is the response returned when the template is successfully retrieved.",
"originalRequest": {
"url": {
"path": [
"signatures",
"user",
"activity",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 200,\n \"message\": \"OK\",\n \"data\": {\n \"activityItems\": [\n {\n \"auditTrailId\": \"f617632c-27560744b5ce\",\n \"envelopeId\": \"21d7d3d8-8-cf357729fdc3\",\n \"subject\": \"TestMFA\",\n \"action\": \"Envelope sent\",\n \"timestamp\": \"2025-11-04T11:25:07.3270000+00:00\",\n \"additionalInfo\": \"hrishchanovich92@gmail.com\",\n \"transactionTokenId\": null\n },\n {\n \"auditTrailId\": \"4dcc8b0368867eb104\",\n \"envelopeId\": \"21d7dcf357729fdc3\",\n \"subject\": \"TestMFA\",\n \"action\": \"Envelope created\",\n \"timestamp\": \"2025-11-04T11:25:07.3130000+00:00\",\n \"additionalInfo\": \"\",\n \"transactionTokenId\": null\n },\n {\n \"auditTrailId\": \"5c9014c1-820e-350e2b8cf12\",\n \"envelopeId\": \"c4426538-4a74d8938a066a\",\n \"subject\": \"TestMFA\",\n \"action\": \"Envelope canceled\",\n \"timestamp\": \"2025-11-04T11:22:47.4400000+00:00\",\n \"additionalInfo\": \"\",\n \"transactionTokenId\": null\n },\n {\n \"auditTrailId\": \"e4671822-84342682d6ea\",\n \"envelopeId\": \"5e84662b-5003520f0e4293\",\n \"subject\": \"TestMFA\",\n \"action\": \"Envelope received confirmation\",\n \"timestamp\": \"2025-11-04T11:19:51.9670000+00:00\",\n \"additionalInfo\": \"\",\n \"transactionTokenId\": \"9aaae92c-87149c1d684\"\n },\n {\n \"auditTrailId\": \"fe55fab4-5c49054d5e4711\",\n \"envelopeId\": \"c4426538-4a70-484d8938a066a\",\n \"subject\": \"TestMFA\",\n \"action\": \"Envelope sent\",\n \"timestamp\": \"2025-11-04T11:19:15.5130000+00:00\",\n \"additionalInfo\": \"hrishchanovich92@gmail.com\",\n \"transactionTokenId\": null\n },\n {\n \"auditTrailId\": \"ecf9083e-f827c4ec32589\",\n \"envelopeId\": \"c4426538-44d8938a066a\",\n \"subject\": \"TestMFA\",\n \"action\": \"Envelope created\",\n \"timestamp\": \"2025-11-04T11:19:15.4970000+00:00\",\n \"additionalInfo\": \"\",\n \"transactionTokenId\": null\n },\n {\n \"auditTrailId\": \"8ee219a3-62a5190980187\",\n \"envelopeId\": \"5e84662b-501b-40f0e4293\",\n \"subject\": \"TestMFA\",\n \"action\": \"Envelope declined\",\n \"timestamp\": \"2025-11-04T11:18:39.5500000+00:00\",\n \"additionalInfo\": \"\",\n \"transactionTokenId\": \"9aaae92c-a7149c1d684\"\n },\n {\n \"auditTrailId\": \"aeffb154-2162-476ee41a2\",\n \"envelopeId\": \"5e84662b-501-03520f0e4293\",\n \"subject\": \"TestMFA\",\n \"action\": \"Accepted legal terms\",\n \"timestamp\": \"2025-11-04T11:18:34.0870000+00:00\",\n \"additionalInfo\": \"\",\n \"transactionTokenId\": \"9aaae92c-8d00-9cd684\"\n },\n {\n \"auditTrailId\": \"2d0d5caf-a5f10-a4adcf232f\",\n \"envelopeId\": \"5e84662b-501b-43520f0e4293\",\n \"subject\": \"TestMFA\",\n \"action\": \"Email opened\",\n \"timestamp\": \"2025-11-04T11:18:13.9770000+00:00\",\n \"additionalInfo\": \"\",\n \"transactionTokenId\": \"9aa92c-8d00-4714d684\"\n },\n {\n \"auditTrailId\": \"a84e6941-3338-49bdfdc8117\",\n \"envelopeId\": \"5e84662b-501b0f0e4293\",\n \"subject\": \"TestMFA\",\n \"action\": \"Envelope sent\",\n \"timestamp\": \"2025-11-04T11:17:43.5330000+00:00\",\n \"additionalInfo\": \"roman.khryshchanovich@mavenmule.com\",\n \"transactionTokenId\": null\n }\n ]\n }\n },\n \"origin\": \"GET https://dev.headless.mavenmule.com/signatures/user/activity/get\",\n \"dateTime\": \"2025-11-04T12:44:32.6360862+00:00\",\n \"userId\": \"1d8b89c4-0889-c-9af09ac3bc9b\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "b7d96ca5-e1f0-48bc-86dc-2e5a9f2b7599",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"user",
"activity",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\",\n \"urn\": \"{{sentUrn}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "b7c984c9-ed64-4245-90b8-c3705b1489d6",
"name": "This response indicates that there’s no template found with the provided ID.",
"originalRequest": {
"url": {
"path": [
"signatures",
"user",
"activity",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Not Found",
"code": 404,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"404\",\n \"message\": \"Not Found\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "51dacb88-29a9-4e8d-b906-6803f4ce259f",
"name": "Signature Get",
"request": {
"name": "Signature Get",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"signature",
":signatureId",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "string",
"key": "signatureId",
"disabled": false,
"description": {
"content": "(Required) The ID of the signature which information should be retrieved.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"response": [
{
"id": "676d83f9-16a6-463e-9059-f73cead7743f",
"name": "This is the response returned when the signature is successfully retrieved.
\nThe response includes all the needed signature data.",
"originalRequest": {
"url": {
"path": [
"signatures",
"signature",
":signatureId",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the signature which information should be retrieved.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "signatureId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 200,\n \"message\": \"OK\",\n \"data\": {\n \"signature\": {\n \"id\": \"3e1346f6-a534-4e53fcb0a4d\",\n \"data\": \"iVBORw0KGgoAAAANSUhEUgAAAyAAAAEsCAYAAAA7Ldc6AAAQAElEQVR4AeydBbwsR5X/hAGSURBVAMAc/JP7z78b4EAAAAASUVORK5CYII=\",\n \"isDefault\": true\n }\n }\n },\n \"origin\": \"GET https://dev.headless.mavenmule.com/signatures/signature/3e1346f6-a534-4e53fcb0a4d/get\",\n \"dateTime\": \"2025-11-04T11:43:08.3136217+00:00\",\n \"userId\": \"1d8b89c4-0889c-9af09ac3bc9b\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "48e80048-8244-4b6f-9985-acc2d5d1e3ff",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"signature",
":signatureId",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the signature which information should be retrieved.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "signatureId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\"\n }\n ],\n \"externalErrors\": []\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\",\n \"userId\": \"{{userId}}\",\n \"operationId\": \"{{operationId}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "dcedade3-8e50-460a-b9e2-cb88b2df4b3d",
"name": "This response indicates that there’s no signature found with the provided ID.",
"originalRequest": {
"url": {
"path": [
"signatures",
"signature",
":signatureId",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the signature which information should be retrieved.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "signatureId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Not Found",
"code": 404,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"404\",\n \"message\": \"Not Found\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "5b693de9-5b59-4645-9a68-9d5501d457a9",
"name": "Template Get",
"request": {
"name": "Template Get",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"template",
":templateId",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "string",
"key": "templateId",
"disabled": false,
"description": {
"content": "(Required) The ID of the needed template.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"response": [
{
"id": "81d7d37a-455e-4c3c-bb76-14394ff3d3b9",
"name": "This is the response returned when the template is successfully retrieved.",
"originalRequest": {
"url": {
"path": [
"signatures",
"template",
":templateId",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the needed template.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "templateId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 200,\n \"message\": \"OK\",\n \"data\": {\n \"template\": {\n \"id\": \"e08f7851-dc1d-482ff0857c4e4\",\n \"createdBy\": {\n \"id\": \"1d8b89c4-0889-4d0c-9af09ac3bc9b\",\n \"name\": \"Roman\",\n \"email\": \"roman.khryshchanovich@mavenmule.com\"\n },\n \"uploadDate\": \"2025-11-04T12:34:20.0000000+00:00\",\n \"sendDate\": null,\n \"status\": \"Template\",\n \"subject\": \"Sample\",\n \"message\": \"\",\n \"isSignOrder\": false,\n \"expireInDays\": 30,\n \"firstReminderDays\": null,\n \"repeatingReminderDays\": null,\n \"notifyWhenOpened\": true,\n \"notifyWhenSigned\": true,\n \"alertDaysBeforeExpiry\": 1,\n \"templateName\": \"Sample Template\",\n \"templateDescription\": \"\"\n },\n \"documents\": [\n {\n \"id\": \"53aa7efc-82fc-49b1330114c68\",\n \"name\": \"Sales Agreement.pdf\",\n \"externalContext\": null\n }\n ],\n \"recipients\": [\n {\n \"id\": \"9ef72bea-765-b957a6ba80e9\",\n \"name\": \"\",\n \"email\": \"\",\n \"role\": \"signer\",\n \"status\": \"Template\",\n \"signDate\": \"\",\n \"signOrder\": 1,\n \"signGroupId\": \"00000000-000-000000000000\",\n \"userId\": null,\n \"mandatory\": true,\n \"isMFAEnabled\": false,\n \"phoneNumber\": null,\n \"hostEmail\": null,\n \"templateRole\": \"Sample Role\",\n \"externalContext\": null\n }\n ],\n \"signGroups\": [],\n \"fields\": [\n {\n \"id\": \"69950844-1206-9711415\",\n \"name\": \"6a19f2a2630241c7e99cbdd34da\",\n \"recipientId\": \"9ef72bea-76fa-4957a6ba80e9\",\n \"signGroupId\": \"00000000-0000-000000000000\",\n \"documentId\": \"53aa7efc-82fc-46330114c68\",\n \"type\": \"signature\",\n \"value\": \"\",\n \"page\": 1,\n \"height\": 35,\n \"width\": 100,\n \"positionX\": 117.2445,\n \"positionY\": 17.8811,\n \"isRequired\": true,\n \"properties\": null\n },\n {\n \"id\": \"ae726cea-1dc0-4df0c989ff30\",\n \"name\": \"d6a1b10eb7a64c891c78d3a85\",\n \"recipientId\": \"9ef72bea-76957a6ba80e9\",\n \"signGroupId\": \"00000000-000000000\",\n \"documentId\": \"53aa7efc-82330114c68\",\n \"type\": \"name\",\n \"value\": \"\",\n \"page\": 1,\n \"height\": 35,\n \"width\": 100,\n \"positionX\": 235.016,\n \"positionY\": 17.8689,\n \"isRequired\": false,\n \"properties\": {\n \"fontFamily\": \"Helvetica\",\n \"fontSize\": 13,\n \"color\": \"#000000\",\n \"bold\": false,\n \"italic\": false,\n \"underline\": false,\n \"textAlign\": \"left\",\n \"isSignedDate\": false,\n \"selectionGroup\": null,\n \"selectionValue\": null\n }\n }\n ],\n \"externalContext\": null\n }\n },\n \"origin\": \"GET https://dev.headless.mavenmule.com/signatures/template/e08f7851-dc1d-482ff0857c4e4/get\",\n \"dateTime\": \"2025-11-04T12:36:06.0000000+00:00\",\n \"userId\": \"1d8b89c4-088af09ac3bc9b\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "3821d084-85d6-4c59-975c-7fcfd41f1f29",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"template",
":templateId",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the needed template.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "templateId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\",\n \"urn\": \"{{sentUrn}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "2c252999-eefa-40c4-9b8a-ce9f1672ca81",
"name": "This response indicates that there’s no template found with the provided ID.",
"originalRequest": {
"url": {
"path": [
"signatures",
"template",
":templateId",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the needed template.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "templateId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Not Found",
"code": 404,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"404\",\n \"message\": \"Not Found\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
}
]
},
{
"name": "AuditTrail",
"description": "",
"item": [
{
"id": "28363c1c-7d1b-4b46-bb56-9371624eac69",
"name": "Envelope Audit Log Get",
"request": {
"name": "Envelope Audit Log Get",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"audit",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "string",
"key": "envelopeId",
"disabled": false,
"description": {
"content": "(Required) The ID of the envelope where the attachment will be added.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"response": [
{
"id": "1df19063-34d0-4f23-8915-f3f40d58bf74",
"name": "The response body contains the data of the Audit trail in the JSON format.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"audit",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the envelope where the attachment will be added.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "envelopeId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 200,\n \"message\": \"OK\",\n \"data\": {\n \"auditTrails\": [\n {\n \"id\": \"{{auditTrailId}}\",\n \"user\": {\n \"id\": \"{{userId}}\",\n \"name\": \"{{userName}}\",\n \"email\": \"{{userEmail}}\"\n },\n \"recipient\": {\n \"id\": \"{{recipientId}}\",\n \"name\": \"{{recipientName}}\",\n \"email\": \"{{recipientEmail}}\"\n },\n \"signGroup\": \"{{signGroupValue}}\",\n \"action\": \"{{actionDescription}}\",\n \"timestamp\": \"{{actionTimestamp}}\",\n \"ipAddress\": \"{{ipAddress}}\",\n \"additionalInfo\": \"{{additionalInfo}}\"\n }\n ]\n }\n },\n \"origin\": \"{{requestOrigin}}\",\n \"dateTime\": \"{{responseTimestamp}}\",\n \"userId\": \"{{requestingUserId}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "d2ffe7b3-1a7d-4701-9a60-3239e0637560",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"audit",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the envelope where the attachment will be added.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "envelopeId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\",\n \"urn\": \"{{sentUrn}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "6b3e97b8-919b-46bf-b3aa-eb233fb8b3d0",
"name": "This response indicates that there’s no Audit Trail found in the envelope with the provided ID.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"audit",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the envelope where the attachment will be added.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "envelopeId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Not Found",
"code": 404,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"404\",\n \"message\": \"Not Found\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "63538e06-10cf-4c19-af0c-80c326b61059",
"name": "Envelope Audit Log Download",
"request": {
"name": "Envelope Audit Log Download",
"description": {
"content": "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).",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"audit",
"download"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "string",
"key": "envelopeId",
"disabled": false,
"description": {
"content": "(Required) The ID of the envelope where the attachment will be added.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"response": [
{
"id": "773a3655-2a69-4510-b78c-1bd2362e5c36",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"audit",
"download"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the envelope where the attachment will be added.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "envelopeId"
}
]
},
"header": [],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [],
"cookie": [],
"_postman_previewlanguage": "text"
},
{
"id": "eb989bbd-02be-4e2d-bb05-ee2e54048d0c",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"audit",
"download"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the envelope where the attachment will be added.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "envelopeId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\",\n \"urn\": \"{{sentUrn}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "63620d16-daa7-4515-91fe-feb34ee7f6c5",
"name": "This response indicates that there’s no Audit Trail found in the envelope with the provided ID.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"audit",
"download"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the envelope where the attachment will be added.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "envelopeId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Not Found",
"code": 404,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"404\",\n \"message\": \"Not Found\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
}
]
},
{
"name": "User",
"description": "",
"item": [
{
"id": "2c6315fe-c421-49c4-8518-b89b660877eb",
"name": "User Activity Get",
"request": {
"name": "User Activity Get",
"description": {
"content": "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).",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"user",
"activity",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"response": [
{
"id": "ca7bf55c-d903-4256-84f7-88f294122a8e",
"name": "This is the response returned when the template is successfully retrieved.",
"originalRequest": {
"url": {
"path": [
"signatures",
"user",
"activity",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 200,\n \"message\": \"OK\",\n \"data\": {\n \"activityItems\": [\n {\n \"auditTrailId\": \"f617632c-27560744b5ce\",\n \"envelopeId\": \"21d7d3d8-8-cf357729fdc3\",\n \"subject\": \"TestMFA\",\n \"action\": \"Envelope sent\",\n \"timestamp\": \"2025-11-04T11:25:07.3270000+00:00\",\n \"additionalInfo\": \"hrishchanovich92@gmail.com\",\n \"transactionTokenId\": null\n },\n {\n \"auditTrailId\": \"4dcc8b0368867eb104\",\n \"envelopeId\": \"21d7dcf357729fdc3\",\n \"subject\": \"TestMFA\",\n \"action\": \"Envelope created\",\n \"timestamp\": \"2025-11-04T11:25:07.3130000+00:00\",\n \"additionalInfo\": \"\",\n \"transactionTokenId\": null\n },\n {\n \"auditTrailId\": \"5c9014c1-820e-350e2b8cf12\",\n \"envelopeId\": \"c4426538-4a74d8938a066a\",\n \"subject\": \"TestMFA\",\n \"action\": \"Envelope canceled\",\n \"timestamp\": \"2025-11-04T11:22:47.4400000+00:00\",\n \"additionalInfo\": \"\",\n \"transactionTokenId\": null\n },\n {\n \"auditTrailId\": \"e4671822-84342682d6ea\",\n \"envelopeId\": \"5e84662b-5003520f0e4293\",\n \"subject\": \"TestMFA\",\n \"action\": \"Envelope received confirmation\",\n \"timestamp\": \"2025-11-04T11:19:51.9670000+00:00\",\n \"additionalInfo\": \"\",\n \"transactionTokenId\": \"9aaae92c-87149c1d684\"\n },\n {\n \"auditTrailId\": \"fe55fab4-5c49054d5e4711\",\n \"envelopeId\": \"c4426538-4a70-484d8938a066a\",\n \"subject\": \"TestMFA\",\n \"action\": \"Envelope sent\",\n \"timestamp\": \"2025-11-04T11:19:15.5130000+00:00\",\n \"additionalInfo\": \"hrishchanovich92@gmail.com\",\n \"transactionTokenId\": null\n },\n {\n \"auditTrailId\": \"ecf9083e-f827c4ec32589\",\n \"envelopeId\": \"c4426538-44d8938a066a\",\n \"subject\": \"TestMFA\",\n \"action\": \"Envelope created\",\n \"timestamp\": \"2025-11-04T11:19:15.4970000+00:00\",\n \"additionalInfo\": \"\",\n \"transactionTokenId\": null\n },\n {\n \"auditTrailId\": \"8ee219a3-62a5190980187\",\n \"envelopeId\": \"5e84662b-501b-40f0e4293\",\n \"subject\": \"TestMFA\",\n \"action\": \"Envelope declined\",\n \"timestamp\": \"2025-11-04T11:18:39.5500000+00:00\",\n \"additionalInfo\": \"\",\n \"transactionTokenId\": \"9aaae92c-a7149c1d684\"\n },\n {\n \"auditTrailId\": \"aeffb154-2162-476ee41a2\",\n \"envelopeId\": \"5e84662b-501-03520f0e4293\",\n \"subject\": \"TestMFA\",\n \"action\": \"Accepted legal terms\",\n \"timestamp\": \"2025-11-04T11:18:34.0870000+00:00\",\n \"additionalInfo\": \"\",\n \"transactionTokenId\": \"9aaae92c-8d00-9cd684\"\n },\n {\n \"auditTrailId\": \"2d0d5caf-a5f10-a4adcf232f\",\n \"envelopeId\": \"5e84662b-501b-43520f0e4293\",\n \"subject\": \"TestMFA\",\n \"action\": \"Email opened\",\n \"timestamp\": \"2025-11-04T11:18:13.9770000+00:00\",\n \"additionalInfo\": \"\",\n \"transactionTokenId\": \"9aa92c-8d00-4714d684\"\n },\n {\n \"auditTrailId\": \"a84e6941-3338-49bdfdc8117\",\n \"envelopeId\": \"5e84662b-501b0f0e4293\",\n \"subject\": \"TestMFA\",\n \"action\": \"Envelope sent\",\n \"timestamp\": \"2025-11-04T11:17:43.5330000+00:00\",\n \"additionalInfo\": \"roman.khryshchanovich@mavenmule.com\",\n \"transactionTokenId\": null\n }\n ]\n }\n },\n \"origin\": \"GET https://dev.headless.mavenmule.com/signatures/user/activity/get\",\n \"dateTime\": \"2025-11-04T12:44:32.6360862+00:00\",\n \"userId\": \"1d8b89c4-0889-c-9af09ac3bc9b\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "5167b027-43fd-4e90-af22-de25f948e72a",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"user",
"activity",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\",\n \"urn\": \"{{sentUrn}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "af5d7854-91f4-4471-af0a-8dab2e2f840a",
"name": "This response indicates that there’s no template found with the provided ID.",
"originalRequest": {
"url": {
"path": [
"signatures",
"user",
"activity",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Not Found",
"code": 404,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"404\",\n \"message\": \"Not Found\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
}
]
},
{
"name": "Signature",
"description": "",
"item": [
{
"id": "d63e32b1-67ed-4e8c-8527-53d11517b565",
"name": "Signature Create",
"request": {
"name": "Signature Create",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"signature",
"create"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"signature\": {\n \"isDefault\": true,\n \"value\": \"iVBORw0KGgoAAAANSUhEUgAAAyAAAAEsCAYAAAA7Ldc6AAAQA\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"response": [
{
"id": "56f0ca84-5504-4873-85ca-289ed1c0c76a",
"name": "This is the response returned when the envelope is successfully declined.",
"originalRequest": {
"url": {
"path": [
"signatures",
"signature",
"create"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"signature\": {\n \"isDefault\": true,\n \"value\": \"iVBORw0KGgoAAAANSUhEUgAAAyAAAAEsCAYAAAA7Ldc6AAAQA\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "Created",
"code": 201,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 201,\n \"message\": \"Created\",\n \"data\": {\n \"signature\": {\n \"id\": \"3e1346f6-a534-4e53fcb0a4d\",\n \"message\": \"Signature successfully saved\"\n }\n }\n },\n \"origin\": \"POST https://dev.headless.mavenmule.com/signatures/signature/create\",\n \"dateTime\": \"2025-11-04T11:29:04.2445642+00:00\",\n \"userId\": \"1d8b89c4-0889-4d0af09ac3bc9b\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "d700ef94-d6de-4e5b-ad84-34a907761497",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"signature",
"create"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"signature\": {\n \"isDefault\": true,\n \"value\": \"iVBORw0KGgoAAAANSUhEUgAAAyAAAAEsCAYAAAA7Ldc6AAAQA\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\",\n \"urn\": \"{{sentUrn}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "b3f5cf5c-91aa-494f-a118-925ec3c3943b",
"name": "Signature Update",
"request": {
"name": "Signature Update",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"signature",
":signatureId",
"update"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "string",
"key": "signatureId",
"disabled": false,
"description": {
"content": "(Required) The ID of the signature that should be updated.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"signature\": {\n \"isDefault\": false,\n \"value\": \"base64\"\n },\n \"externalContext\": {\n \"id\": \"12345\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"response": [
{
"id": "2774a571-c646-471a-ad3e-1b8e6bc7876c",
"name": "This is the response returned when the signature is successfully updated.",
"originalRequest": {
"url": {
"path": [
"signatures",
"signature",
":signatureId",
"update"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the signature that should be updated.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "signatureId"
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"signature\": {\n \"isDefault\": false,\n \"value\": \"base64\"\n },\n \"externalContext\": {\n \"id\": \"12345\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 200,\n \"message\": \"OK\",\n \"data\": {\n \"signature\": {\n \"id\": \"3e1346f6-a534-4e53fcb0a4d\",\n \"message\": \"Signature successfully saved\"\n }\n }\n },\n \"origin\": \"PUT https://dev.headless.mavenmule.com/signatures/signature/3e1346f6-a534-4e53fcb0a4d/update\",\n \"dateTime\": \"2025-11-04T11:54:42.5961530+00:00\",\n \"userId\": \"1d8b89c4-0889-4d03-a90c-9af09ac3bc9b\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "8f9caa71-c204-4bd6-9bd4-b938e8b7f06e",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"signature",
":signatureId",
"update"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the signature that should be updated.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "signatureId"
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"signature\": {\n \"isDefault\": false,\n \"value\": \"base64\"\n },\n \"externalContext\": {\n \"id\": \"12345\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\"\n }\n ],\n \"externalErrors\": []\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\",\n \"userId\": \"{{userId}}\",\n \"operationId\": \"{{operationId}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "ab9c94f0-b718-4085-b3cd-121f06f09835",
"name": "This response indicates that there’s no signature found with the provided ID.",
"originalRequest": {
"url": {
"path": [
"signatures",
"signature",
":signatureId",
"update"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the signature that should be updated.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "signatureId"
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"signature\": {\n \"isDefault\": false,\n \"value\": \"base64\"\n },\n \"externalContext\": {\n \"id\": \"12345\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "Not Found",
"code": 404,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"404\",\n \"message\": \"Not Found\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "6d773b37-47f1-40b3-ae41-9e1c9a94c8fb",
"name": "Signature Get",
"request": {
"name": "Signature Get",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"signature",
":signatureId",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "string",
"key": "signatureId",
"disabled": false,
"description": {
"content": "(Required) The ID of the signature which information should be retrieved.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"response": [
{
"id": "8c989ce6-676d-4601-9758-6a19765c0fee",
"name": "This is the response returned when the signature is successfully retrieved.
\nThe response includes all the needed signature data.",
"originalRequest": {
"url": {
"path": [
"signatures",
"signature",
":signatureId",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the signature which information should be retrieved.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "signatureId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 200,\n \"message\": \"OK\",\n \"data\": {\n \"signature\": {\n \"id\": \"3e1346f6-a534-4e53fcb0a4d\",\n \"data\": \"iVBORw0KGgoAAAANSUhEUgAAAyAAAAEsCAYAAAA7Ldc6AAAQAElEQVR4AeydBbwsR5X/hAGSURBVAMAc/JP7z78b4EAAAAASUVORK5CYII=\",\n \"isDefault\": true\n }\n }\n },\n \"origin\": \"GET https://dev.headless.mavenmule.com/signatures/signature/3e1346f6-a534-4e53fcb0a4d/get\",\n \"dateTime\": \"2025-11-04T11:43:08.3136217+00:00\",\n \"userId\": \"1d8b89c4-0889c-9af09ac3bc9b\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "d11703fb-f55d-4ae1-a47b-2cb741c176e0",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"signature",
":signatureId",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the signature which information should be retrieved.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "signatureId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\"\n }\n ],\n \"externalErrors\": []\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\",\n \"userId\": \"{{userId}}\",\n \"operationId\": \"{{operationId}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "d48e68c6-3d57-4723-90d9-1578311cc309",
"name": "This response indicates that there’s no signature found with the provided ID.",
"originalRequest": {
"url": {
"path": [
"signatures",
"signature",
":signatureId",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the signature which information should be retrieved.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "signatureId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Not Found",
"code": 404,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"404\",\n \"message\": \"Not Found\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "cfad57fc-228c-4ca3-bdc5-d5b0d1b7502e",
"name": "Signature List",
"request": {
"name": "Signature List",
"description": {
"content": "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",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"signature",
"list"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"response": [
{
"id": "b523790e-cc38-4a75-b234-d75c8b641129",
"name": "This is the response returned when the list of available signatures is successfully retrieved.",
"originalRequest": {
"url": {
"path": [
"signatures",
"signature",
"list"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 200,\n \"message\": \"OK\",\n \"data\": {\n \"signature\": [\n {\n \"id\": \"3e1346f6-a534-4e53fcb0a4d\",\n \"isDefault\": true\n }\n ]\n }\n },\n \"origin\": \"GET https://dev.headless.mavenmule.com/signatures/signature/list\",\n \"dateTime\": \"2025-11-04T11:43:08.1266236+00:00\",\n \"userId\": \"1d8b89c4-0889-4-9af]3bc9b\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "95919675-34b4-4112-b807-ad409951b197",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"signature",
"list"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\"\n }\n ],\n \"externalErrors\": []\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\",\n \"userId\": \"{{userId}}\",\n \"operationId\": \"{{operationId}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "29150e74-2ab1-4c96-9483-d31a4bc8e840",
"name": "This response indicates that there’s no signature found with the provided ID.",
"originalRequest": {
"url": {
"path": [
"signatures",
"signature",
"list"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Not Found",
"code": 404,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"404\",\n \"message\": \"Not Found\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "e28531a0-2cf0-428e-8bb0-96cf4e2d477b",
"name": "Signature Delete",
"request": {
"name": "Signature Delete",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"signature",
":signatureId",
"delete"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "string",
"key": "signatureId",
"disabled": false,
"description": {
"content": "(Required) The ID of the signature that should be deleted.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "DELETE",
"body": {}
},
"response": [
{
"id": "d71c97fa-e5b4-431f-9f05-0aba902a1ee2",
"name": "This response indicates that the signature identified by the provided signatureId was successfully deleted.",
"originalRequest": {
"url": {
"path": [
"signatures",
"signature",
":signatureId",
"delete"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the signature that should be deleted.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "signatureId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "DELETE",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 200,\n \"message\": \"OK\",\n \"data\": {\n \"signature\": {\n \"id\": \"3e1346f6-a534-4e53fcb0a4d\",\n \"message\": \"SIGNATURE_DELETED\"\n }\n }\n },\n \"origin\": \"DELETE https://dev.headless.mavenmule.com/signatures/signature/3e1346f6-a534-4e53fcb0a4d/delete\",\n \"dateTime\": \"2025-11-04T11:33:05.3790992+00:00\",\n \"userId\": \"1d8b89c4-0889-4d0f09ac3bc9b\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "9ac0ad30-b060-4387-83e6-d2c7910e78a8",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"signature",
":signatureId",
"delete"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the signature that should be deleted.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "signatureId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "DELETE",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\"\n }\n ],\n \"externalErrors\": []\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\",\n \"userId\": \"{{userId}}\",\n \"operationId\": \"{{operationId}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "ab5fc4bf-4e84-46c9-af27-94ca1136111e",
"name": "This response indicates that there’s no signature found with the provided ID.",
"originalRequest": {
"url": {
"path": [
"signatures",
"signature",
":signatureId",
"delete"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the signature that should be deleted.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "signatureId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "DELETE",
"body": {}
},
"status": "Not Found",
"code": 404,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"404\",\n \"message\": \"Not Found\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
}
]
},
{
"name": "Content",
"description": "",
"item": [
{
"id": "e48eb735-1161-4d95-99c2-7e229f106176",
"name": "Envelope Update ",
"request": {
"name": "Envelope Update ",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"update"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "string",
"key": "envelopeId",
"disabled": false,
"description": {
"content": "(Required) 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.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"documents\": [\n {\n \"referenceDocumentId\": 1,\n \"name\": \"Test Document Name\",\n \"loadMethod\": \"Storage\",\n \"urn\": \"{{uploadedDocument}}\"\n }\n ],\n \"recipients\": [\n {\n \"referenceSignerId\": 1,\n \"name\": \"Test Example\",\n \"email\": \"user@example.com\",\n \"role\": \"signer\",\n \"mandatory\": true\n }\n ],\n \"fields\": [\n {\n \"type\": \"signature\",\n \"isRequired\": true,\n \"referenceSignerId\": 1,\n \"referenceDocumentId\": 1,\n \"positionX\": 10,\n \"positionY\": 10,\n \"height\": 100,\n \"width\": 100,\n \"page\": 1,\n \"name\": \"mds_signature1\",\n \"properties\": {\n \"fontFamily\": \"Arial\",\n \"fontSize\": 13,\n \"color\": \"red\",\n \"bold\": true,\n \"italic\": true,\n \"underline\": true,\n \"textAlign\": \"center\"\n }\n }\n ],\n \"envelope\": {\n \"subject\": \"Email Subject\",\n \"message\": \"Email Message\",\n \"senderName\": \"Sender\",\n \"senderEmail\": \"sender@example.com\",\n \"isSignOrder\": false,\n \"expireInDays\": 5,\n \"alertDaysBeforeExpiry\": 5,\n \"firstReminderDays\": 3,\n \"repeatingReminderDays\": 2,\n \"notifyWhenOpened\": true,\n \"notifyWhenSigned\": true\n },\n \"externalContext\": {\n \"id\": \"12345\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"response": [
{
"id": "ac653e52-ece4-415c-8ff4-a43d19073c1a",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"update"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) 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.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "envelopeId"
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"documents\": [\n {\n \"referenceDocumentId\": 1,\n \"name\": \"Test Document Name\",\n \"loadMethod\": \"Storage\",\n \"urn\": \"{{uploadedDocument}}\"\n }\n ],\n \"recipients\": [\n {\n \"referenceSignerId\": 1,\n \"name\": \"Test Example\",\n \"email\": \"user@example.com\",\n \"role\": \"signer\",\n \"mandatory\": true\n }\n ],\n \"fields\": [\n {\n \"type\": \"signature\",\n \"isRequired\": true,\n \"referenceSignerId\": 1,\n \"referenceDocumentId\": 1,\n \"positionX\": 10,\n \"positionY\": 10,\n \"height\": 100,\n \"width\": 100,\n \"page\": 1,\n \"name\": \"mds_signature1\",\n \"properties\": {\n \"fontFamily\": \"Arial\",\n \"fontSize\": 13,\n \"color\": \"red\",\n \"bold\": true,\n \"italic\": true,\n \"underline\": true,\n \"textAlign\": \"center\"\n }\n }\n ],\n \"envelope\": {\n \"subject\": \"Email Subject\",\n \"message\": \"Email Message\",\n \"senderName\": \"Sender\",\n \"senderEmail\": \"sender@example.com\",\n \"isSignOrder\": false,\n \"expireInDays\": 5,\n \"alertDaysBeforeExpiry\": 5,\n \"firstReminderDays\": 3,\n \"repeatingReminderDays\": 2,\n \"notifyWhenOpened\": true,\n \"notifyWhenSigned\": true\n },\n \"externalContext\": {\n \"id\": \"12345\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 200,\n \"message\": \"OK\",\n \"data\": {\n \"envelope\": {\n \"id\": \"789cb83f-c225-46f0-bfdd\",\n \"status\": \"Draft\"\n },\n \"documents\": [\n {\n \"id\": \"e508516b-9273d-a65b7f8e69d8\",\n \"externalContext\": null\n },\n {\n \"id\": \"16ef36a6-7738-49279b77fd394\",\n \"externalContext\": null\n }\n ],\n \"recipients\": [\n {\n \"id\": \"5c33f8ae-b3ba-3a4f392f680\",\n \"externalContext\": null\n }\n ],\n \"signGroups\": [],\n \"fields\": [\n {\n \"id\": \"ffc6a7e1-26d5-3-bccbc8f7deea\",\n \"recipientId\": \"5c33f8ae-b3ba-23a4f392f680\",\n \"signGroupId\": \"00000000-0000-0000000\",\n \"documentId\": \"e508516b-9275d-a65b7f8e69d8\"\n },\n {\n \"id\": \"dc01bf88-b2fb-45a713acfe382d\",\n \"recipientId\": \"5c33f8ae-b3ba-456f392f680\",\n \"signGroupId\": \"00000000-00000000000\",\n \"documentId\": \"e508516b-925b7f8e69d8\"\n }\n ]\n }\n },\n \"origin\": \"PUT https://dev.headless.mavenmule.com/signatures/envelope/789cb83f-c225-46f0-bfdd/update\",\n \"dateTime\": \"2025-11-04T10:49:44.6418508+00:00\",\n \"userId\": \"1d8b89c4-0889-4c-909ac3bc9b\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "f5b6cd21-816e-4bb5-aa09-30730162060f",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"update"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) 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.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "envelopeId"
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"documents\": [\n {\n \"referenceDocumentId\": 1,\n \"name\": \"Test Document Name\",\n \"loadMethod\": \"Storage\",\n \"urn\": \"{{uploadedDocument}}\"\n }\n ],\n \"recipients\": [\n {\n \"referenceSignerId\": 1,\n \"name\": \"Test Example\",\n \"email\": \"user@example.com\",\n \"role\": \"signer\",\n \"mandatory\": true\n }\n ],\n \"fields\": [\n {\n \"type\": \"signature\",\n \"isRequired\": true,\n \"referenceSignerId\": 1,\n \"referenceDocumentId\": 1,\n \"positionX\": 10,\n \"positionY\": 10,\n \"height\": 100,\n \"width\": 100,\n \"page\": 1,\n \"name\": \"mds_signature1\",\n \"properties\": {\n \"fontFamily\": \"Arial\",\n \"fontSize\": 13,\n \"color\": \"red\",\n \"bold\": true,\n \"italic\": true,\n \"underline\": true,\n \"textAlign\": \"center\"\n }\n }\n ],\n \"envelope\": {\n \"subject\": \"Email Subject\",\n \"message\": \"Email Message\",\n \"senderName\": \"Sender\",\n \"senderEmail\": \"sender@example.com\",\n \"isSignOrder\": false,\n \"expireInDays\": 5,\n \"alertDaysBeforeExpiry\": 5,\n \"firstReminderDays\": 3,\n \"repeatingReminderDays\": 2,\n \"notifyWhenOpened\": true,\n \"notifyWhenSigned\": true\n },\n \"externalContext\": {\n \"id\": \"12345\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": 400,\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"DRAFT_ID_INVALID\",\n \"message\": \"Envelope draft with ID 8952012a-b086-4aaf-be18b4 does not exist\",\n \"userMessage\": \"Envelope draft with ID 8952012a-b086-4aaf-be18b4 does not exist\"\n }\n ],\n \"externalErrors\": []\n },\n \"origin\": \"GET https://dev.headless.mavenmule.com/signatures/envelope/8952012a-b086-4aaf-be18b4/send\",\n \"dateTime\": \"2025-11-04T10:41:21.0000000+00:00\",\n \"userId\": \"1d8b89c4-0889-4d-9af09ac3bc9b\",\n \"operationId\": \"148726246e5949f517ac87582\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "9ff8b126-ad97-4cc0-ba68-58d8a4b998c7",
"name": "This response indicates that there’s no envelope found with the provided ID.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"update"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) 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.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "envelopeId"
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"documents\": [\n {\n \"referenceDocumentId\": 1,\n \"name\": \"Test Document Name\",\n \"loadMethod\": \"Storage\",\n \"urn\": \"{{uploadedDocument}}\"\n }\n ],\n \"recipients\": [\n {\n \"referenceSignerId\": 1,\n \"name\": \"Test Example\",\n \"email\": \"user@example.com\",\n \"role\": \"signer\",\n \"mandatory\": true\n }\n ],\n \"fields\": [\n {\n \"type\": \"signature\",\n \"isRequired\": true,\n \"referenceSignerId\": 1,\n \"referenceDocumentId\": 1,\n \"positionX\": 10,\n \"positionY\": 10,\n \"height\": 100,\n \"width\": 100,\n \"page\": 1,\n \"name\": \"mds_signature1\",\n \"properties\": {\n \"fontFamily\": \"Arial\",\n \"fontSize\": 13,\n \"color\": \"red\",\n \"bold\": true,\n \"italic\": true,\n \"underline\": true,\n \"textAlign\": \"center\"\n }\n }\n ],\n \"envelope\": {\n \"subject\": \"Email Subject\",\n \"message\": \"Email Message\",\n \"senderName\": \"Sender\",\n \"senderEmail\": \"sender@example.com\",\n \"isSignOrder\": false,\n \"expireInDays\": 5,\n \"alertDaysBeforeExpiry\": 5,\n \"firstReminderDays\": 3,\n \"repeatingReminderDays\": 2,\n \"notifyWhenOpened\": true,\n \"notifyWhenSigned\": true\n },\n \"externalContext\": {\n \"id\": \"12345\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "Not Found",
"code": 404,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"404\",\n \"message\": \"Not Found\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
}
]
},
{
"name": "Attachment",
"description": "",
"item": [
{
"id": "0b40e5a3-ceb9-4764-90ce-4f711160737a",
"name": "Envelope Attachment Upload ",
"request": {
"name": "Envelope Attachment Upload ",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"attachment",
"upload"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": [
{
"type": "any",
"value": "string",
"key": "envelopeId",
"disabled": false,
"description": {
"content": "(Required) The ID of the envelope where the attachment will be added.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {}
},
"response": [
{
"id": "195027f7-5df1-487e-ab86-2c9261371365",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"attachment",
"upload"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the envelope where the attachment will be added.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "envelopeId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {}
},
"status": "Created",
"code": 201,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"data\": {\n \"files\": [\n {\n \"id\": \"76bb26-21b1-4d47132c4\",\n \"fileName\": \"SampleAttachment.jpg\"\n }\n ]\n },\n \"statusCode\": 201,\n \"message\": \"Created\"\n },\n \"origin\": \"POST https://dev.headless.mavenmule.com/signatures/envelope/7a5d60-a222-4c3e490ef1/attachment/upload\",\n \"dateTime\": \"2025-11-03T06:48:58.5308568+00:00\",\n \"operationId\": \"ea5716c820f26295b44c2fb2\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "faa9dc40-8b55-434b-9ed5-e30a9d3fc1d0",
"name": "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",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"attachment",
"upload"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the envelope where the attachment will be added.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "envelopeId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\",\n \"urn\": \"{{sentUrn}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "7aa39574-c2c1-4f26-a110-dacf267819b4",
"name": "Envelope Attachment Download",
"request": {
"name": "Envelope Attachment Download",
"description": {
"content": "Downloads an attachment associated with an envelope.
\n* The attachment is returned in its original format as uploaded.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"attachment",
":attachmentId",
"download"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": [
{
"type": "any",
"value": "{{envelopeId}}",
"key": "envelopeId",
"disabled": false,
"description": {
"content": "(Required) The ID of the envelope which Audit trail is needed. (This can only be one of {{envelopeId}})",
"type": "text/plain"
}
},
{
"type": "any",
"value": "{{attachmentId}}",
"key": "attachmentId",
"disabled": false,
"description": {
"content": "(Required) The needed string value. The ID of the needed attachment from the defined envelope. (This can only be one of {{attachmentId}})",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"response": [
{
"id": "16fef36c-3cce-4226-8af2-19de51f063d5",
"name": "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.).",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"attachment",
":attachmentId",
"download"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the envelope which Audit trail is needed. (This can only be one of {{envelopeId}})",
"type": "text/plain"
},
"type": "any",
"value": "{{envelopeId}}",
"key": "envelopeId"
},
{
"disabled": false,
"description": {
"content": "(Required) The needed string value. The ID of the needed attachment from the defined envelope. (This can only be one of {{attachmentId}})",
"type": "text/plain"
},
"type": "any",
"value": "{{attachmentId}}",
"key": "attachmentId"
}
]
},
"header": [],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [],
"cookie": [],
"_postman_previewlanguage": "text"
},
{
"id": "95c1043c-64ea-4272-a149-5c562e04e262",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"attachment",
":attachmentId",
"download"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the envelope which Audit trail is needed. (This can only be one of {{envelopeId}})",
"type": "text/plain"
},
"type": "any",
"value": "{{envelopeId}}",
"key": "envelopeId"
},
{
"disabled": false,
"description": {
"content": "(Required) The needed string value. The ID of the needed attachment from the defined envelope. (This can only be one of {{attachmentId}})",
"type": "text/plain"
},
"type": "any",
"value": "{{attachmentId}}",
"key": "attachmentId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\",\n \"urn\": \"{{sentUrn}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "fc30234b-f059-4569-bc02-a0799bfade45",
"name": "This response indicates that there’re no attachments found in the envelope with the provided ID.",
"originalRequest": {
"url": {
"path": [
"signatures",
"envelope",
":envelopeId",
"attachment",
":attachmentId",
"download"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the envelope which Audit trail is needed. (This can only be one of {{envelopeId}})",
"type": "text/plain"
},
"type": "any",
"value": "{{envelopeId}}",
"key": "envelopeId"
},
{
"disabled": false,
"description": {
"content": "(Required) The needed string value. The ID of the needed attachment from the defined envelope. (This can only be one of {{attachmentId}})",
"type": "text/plain"
},
"type": "any",
"value": "{{attachmentId}}",
"key": "attachmentId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Not Found",
"code": 404,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"404\",\n \"message\": \"Not Found\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
}
]
},
{
"name": "MFA",
"description": "",
"item": [
{
"id": "bc663069-2f4a-41a7-aa42-5e938d9debe9",
"name": "MFA Initiate",
"request": {
"name": "MFA Initiate",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"mfa",
"initiate"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {}
},
"response": [
{
"id": "b3360091-b93d-46b6-a7ee-ffcb36ad1404",
"name": "This is the response returned when the multi-factor authentication is initiated successfully.",
"originalRequest": {
"url": {
"path": [
"signatures",
"mfa",
"initiate"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 200,\n \"message\": \"OK\",\n \"data\": {\n \"recipient\": {\n \"method\": \"sms\",\n \"destination\": {\n \"phoneNumber\": \"\",\n \"email\": \"hrishchanovich92@gmail.com\"\n },\n \"expiresAt\": \"2025-11-05T06:48:48.0000000+00:00\",\n \"message\": \"MFA code successfully sent\"\n }\n }\n },\n \"origin\": \"POST https://dev.headless.mavenmule.com/signatures/mfa/initiate\",\n \"dateTime\": \"2025-11-05T06:38:53.0000000+00:00\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "a36448ff-2054-40fc-9ef6-d6a98dc3bfb4",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"mfa",
"initiate"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\",\n \"urn\": \"{{sentUrn}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "828eb377-bd0a-4ac1-847e-b88d1e0db3a5",
"name": "MFA Verify",
"request": {
"name": "MFA Verify",
"description": {
"content": "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",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"mfa",
"verify"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {}
},
"response": [
{
"id": "bb00150a-ceab-4415-a04c-3bf5de166dee",
"name": "This is the response returned when the multi-factor authentication was successfully verified.",
"originalRequest": {
"url": {
"path": [
"signatures",
"mfa",
"verify"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 200,\n \"message\": \"OK\",\n \"data\": {\n \"recipient\": {\n \"method\": \"sms\",\n \"destination\": \"\",\n \"message\": \"MFA code successfully verified\"\n }\n }\n },\n \"origin\": \"POST https://dev.headless.mavenmule.com/signatures/mfa/verify\",\n \"dateTime\": \"2025-11-05T06:42:40.0000000+00:00\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "5198673f-9a57-4bda-a3c9-dd53ab905406",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"mfa",
"verify"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": 400,\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"MFA_INVALID_OR_EXPIRED_CODE\",\n \"message\": \"Invalid or expired MFA code.\",\n \"userMessage\": \"Invalid or expired MFA code. Please request a new MFA code.\"\n }\n ],\n \"externalErrors\": []\n },\n \"origin\": \"POST https://test.headless.mavenmule.com/signatures/mfa/verify\",\n \"dateTime\": \"2025-11-05T12:35:38.0000000+00:00\",\n \"operationId\": \"6f728f58d0bdf45c62e9ab24e65\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
}
]
},
{
"name": "Template",
"description": "",
"item": [
{
"id": "d32289d2-d4d1-4ebf-8fb4-c7463cf372c4",
"name": "Envelope Create From Template",
"request": {
"name": "Envelope Create From Template",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"template",
":templateId",
"envelope",
"create"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "string",
"key": "templateId",
"disabled": false,
"description": {
"content": "(Required) The ID of the template based on which the envelope is created.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"envelope\": {\n \"subject\": \"TestPostman\",\n \"message\": \"\"\n },\n \"message\": {\n \"subject\": \"TestPostman\",\n \"recipients\": [\n {\n \"templateRole\": \"Role1\",\n \"name\": \"RomanK\",\n \"email\": \"roman.khryshchanovich@mavenmule.com\"\n }\n ]\n },\n \"signGroups\": []\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"response": [
{
"id": "f1cd5681-41d6-4e71-9184-fe8a64794f4c",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"template",
":templateId",
"envelope",
"create"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the template based on which the envelope is created.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "templateId"
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"envelope\": {\n \"subject\": \"TestPostman\",\n \"message\": \"\"\n },\n \"message\": {\n \"subject\": \"TestPostman\",\n \"recipients\": [\n {\n \"templateRole\": \"Role1\",\n \"name\": \"RomanK\",\n \"email\": \"roman.khryshchanovich@mavenmule.com\"\n }\n ]\n },\n \"signGroups\": []\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "Created",
"code": 201,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 201,\n \"message\": \"Created\",\n \"data\": {\n \"envelope\": {\n \"id\": \"cc25cdaa-4-b29c-2f741f612ae0\",\n \"uploadDate\": \"2025-11-03T12:19:00.0000000+00:00\",\n \"status\": \"Draft\"\n },\n \"documents\": [\n {\n \"id\": \"0a01e9d6-897b1-fa5d3b1c3\",\n \"externalContext\": null\n }\n ],\n \"recipients\": [\n {\n \"id\": \"df5c2206-56-00a8be08522d\",\n \"externalContext\": null\n }\n ],\n \"signGroups\": [],\n \"fields\": [\n {\n \"id\": \"558329f7-a425-005077518b\",\n \"recipientId\": \"df5c2206-56e22d\",\n \"signGroupId\": \"0000000-0000000\",\n \"documentId\": \"0a01e-a5cbed3b1c3\"\n }\n ]\n }\n },\n \"origin\": \"POST https://dev.headless.mavenmule.com/signatures/template/816f309c-8e823ee9/envelope/create\",\n \"dateTime\": \"2025-11-03T12:19:00.0000000+00:00\",\n \"userId\": \"1d8b89c4-0889-4d03-a90c-9af09ac3bc9b\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "aed1d20c-7b4d-4a3c-8045-80c2c127b276",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"template",
":templateId",
"envelope",
"create"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the template based on which the envelope is created.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "templateId"
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"envelope\": {\n \"subject\": \"TestPostman\",\n \"message\": \"\"\n },\n \"message\": {\n \"subject\": \"TestPostman\",\n \"recipients\": [\n {\n \"templateRole\": \"Role1\",\n \"name\": \"RomanK\",\n \"email\": \"roman.khryshchanovich@mavenmule.com\"\n }\n ]\n },\n \"signGroups\": []\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": 400,\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"ANCHOR_PROVIDED_POSITION_NOT_REQUIRED\",\n \"message\": \"Field can only be positioned based on an anchor string or manual positioning, not both.\",\n \"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).\"\n }\n ],\n \"externalErrors\": []\n },\n \"externalContext\": {\n \"test1\": \"testvalueenvelope\"\n },\n \"origin\": \"POST https://dev.headless.mavenmule.com/signatures/envelope/create\",\n \"dateTime\": \"2025-10-31T09:27:55.0000000+00:00\",\n \"userId\": \"1d8b89c4-0889-4d03-a90c-9af09ac3bc9b\",\n \"operationId\": \"e6a5c583f9746252cc2fd5ff15fd836c\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "6a5915d7-fe83-4c2c-892b-16b798873116",
"name": "This is the response returned when the request has the invalid data.
\nFor example, the referenced file doesn't exist in Storage.",
"originalRequest": {
"url": {
"path": [
"signatures",
"template",
":templateId",
"envelope",
"create"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the template based on which the envelope is created.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "templateId"
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"envelope\": {\n \"subject\": \"TestPostman\",\n \"message\": \"\"\n },\n \"message\": {\n \"subject\": \"TestPostman\",\n \"recipients\": [\n {\n \"templateRole\": \"Role1\",\n \"name\": \"RomanK\",\n \"email\": \"roman.khryshchanovich@mavenmule.com\"\n }\n ]\n },\n \"signGroups\": []\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "Internal Server Error",
"code": 500,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": 500,\n \"message\": \"Internal Server Error\",\n \"innerErrors\": [\n {\n \"code\": \"FILE_NOT_EXISTS_IN_STORAGE\",\n \"message\": \"File with identifier bddd84db-3305-4df7-a2af-52c691d2bfdf not found in storage.\",\n \"userMessage\": \"File with identifier bddd84db-3305-4df7-a2af-52c691d2bfdf not found in storage.\"\n }\n ],\n \"externalErrors\": []\n },\n \"origin\": \"POST https://dev.headless.mavenmule.com/signatures/envelope/create\",\n \"dateTime\": \"2025-10-31T09:33:29.0000000+00:00\",\n \"operationId\": \"4292a54fa4469c01c0ab4cff3b03a1a2\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "6250e08a-63ff-40e6-8905-f747fb435084",
"name": "Template Create",
"request": {
"name": "Template Create",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"template",
"create"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {}
},
"response": [
{
"id": "df0e3dbb-c3ed-4fa4-88bc-e27ab328e6ca",
"name": "This response is returned after a successful request to create a template of the future envelope.",
"originalRequest": {
"url": {
"path": [
"signatures",
"template",
"create"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {}
},
"status": "Created",
"code": 201,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 201,\n \"message\": \"Created\",\n \"data\": {\n \"template\": {\n \"id\": \"4c935dff-dd5-198f92a4561c\",\n \"uploadDate\": \"2025-11-04T12:22:15.0000000+00:00\"\n },\n \"documents\": [\n {\n \"id\": \"373112d7-aa25cb5b13a\",\n \"externalContext\": null\n }\n ],\n \"recipients\": [\n {\n \"id\": \"d2ccb83c-ad6b7d7bb357cb7\",\n \"externalContext\": null\n }\n ],\n \"signGroups\": [],\n \"fields\": [\n {\n \"id\": \"6723cd7e-980fcc5d1\",\n \"recipientId\": \"d2c83c-ad637cb7\",\n \"signGroupId\": \"000000-00000000\",\n \"documentId\": \"373112d7-aa2-4b1a\"\n }\n ]\n }\n },\n \"origin\": \"POST https://dev.headless.mavenmule.com/signatures/template/create\",\n \"dateTime\": \"2025-11-04T12:22:15.0000000+00:00\",\n \"userId\": \"1d8b89c4-0889-9af09ac3bc9b\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "10fef849-864d-44d0-bbaf-82946d22a8e1",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"template",
"create"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": 400,\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"ANCHOR_PROVIDED_POSITION_NOT_REQUIRED\",\n \"message\": \"Field can only be positioned based on an anchor string or manual positioning, not both.\",\n \"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).\"\n }\n ],\n \"externalErrors\": []\n },\n \"externalContext\": {\n \"test1\": \"testvalueenvelope\"\n },\n \"origin\": \"POST https://dev.headless.mavenmule.com/signatures/template/create\",\n \"dateTime\": \"2025-10-31T09:27:55.0000000+00:00\",\n \"userId\": \"1d8b8990c-9af09ac3bc9b\",\n \"operationId\": \"e6a5c583f2c2fd5ff15fd836c\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "e0099d34-4b42-4955-a513-a84800fc0c17",
"name": "This is the response returned when the request has the invalid data.
\nFor example, the referenced file doesn' t exist in Storage.",
"originalRequest": {
"url": {
"path": [
"signatures",
"template",
"create"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {}
},
"status": "Internal Server Error",
"code": 500,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": 500,\n \"message\": \"Internal Server Error\",\n \"innerErrors\": [\n {\n \"code\": \"FILE_NOT_EXISTS_IN_STORAGE\",\n \"message\": \"File with identifier bddd84db-330dd2bfdf not found in storage.\",\n \"userMessage\": \"File with identifier bddd84db-330dd2bfdf not found in storage.\"\n }\n ],\n \"externalErrors\": []\n },\n \"origin\": \"POST https://dev.headless.mavenmule.com/signatures/template/create\",\n \"dateTime\": \"2025-10-31T09:33:29.0000000+00:00\",\n \"operationId\": \"4292a54fb4cff3b03a1a2\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "e992630e-b6db-424d-98d5-1c1429bf06a9",
"name": "Template Delete",
"request": {
"name": "Template Delete",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"template",
":templateId",
"delete"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "string",
"key": "templateId",
"disabled": false,
"description": {
"content": "(Required) The ID of the template that should be deleted.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "DELETE",
"body": {}
},
"response": [
{
"id": "7131dc1f-9b84-4228-82bf-b18ee60ba00f",
"name": "This response indicates that the template identified by the provided templateId was successfully deleted.",
"originalRequest": {
"url": {
"path": [
"signatures",
"template",
":templateId",
"delete"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the template that should be deleted.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "templateId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "DELETE",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 200,\n \"message\": \"OK\",\n \"data\": {\n \"template\": {\n \"id\": \"4602f79a-5bf16cdf68f\",\n \"message\": \"Template successfully deleted\"\n }\n }\n },\n \"origin\": \"DELETE https://dev.headless.mavenmule.com/signatures/template/4602f79a-9be6-4076-8eb7-85bf16cdf68f/delete\",\n \"dateTime\": \"2025-11-04T12:26:50.0000000+00:00\",\n \"userId\": \"1d8b89c4-0889-4d03-a90c-9af09ac3bc9b\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "7c823f93-1d95-44fb-ab01-0a8fdb48a10a",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"template",
":templateId",
"delete"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the template that should be deleted.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "templateId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "DELETE",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\"\n }\n ],\n \"externalErrors\": []\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\",\n \"userId\": \"{{userId}}\",\n \"operationId\": \"{{operationId}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "9678f794-ea79-4897-a9e5-8b3afb02b104",
"name": "This response indicates that there’s no template found with the provided ID.",
"originalRequest": {
"url": {
"path": [
"signatures",
"template",
":templateId",
"delete"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the template that should be deleted.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "templateId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "DELETE",
"body": {}
},
"status": "Not Found",
"code": 404,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"404\",\n \"message\": \"Not Found\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "1e729193-00b2-4a6b-9422-707b70838d97",
"name": "Template Get",
"request": {
"name": "Template Get",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"template",
":templateId",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "string",
"key": "templateId",
"disabled": false,
"description": {
"content": "(Required) The ID of the needed template.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"response": [
{
"id": "6e0fdddc-8710-4fc2-89d3-a5ed101ee6a7",
"name": "This is the response returned when the template is successfully retrieved.",
"originalRequest": {
"url": {
"path": [
"signatures",
"template",
":templateId",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the needed template.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "templateId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 200,\n \"message\": \"OK\",\n \"data\": {\n \"template\": {\n \"id\": \"e08f7851-dc1d-482ff0857c4e4\",\n \"createdBy\": {\n \"id\": \"1d8b89c4-0889-4d0c-9af09ac3bc9b\",\n \"name\": \"Roman\",\n \"email\": \"roman.khryshchanovich@mavenmule.com\"\n },\n \"uploadDate\": \"2025-11-04T12:34:20.0000000+00:00\",\n \"sendDate\": null,\n \"status\": \"Template\",\n \"subject\": \"Sample\",\n \"message\": \"\",\n \"isSignOrder\": false,\n \"expireInDays\": 30,\n \"firstReminderDays\": null,\n \"repeatingReminderDays\": null,\n \"notifyWhenOpened\": true,\n \"notifyWhenSigned\": true,\n \"alertDaysBeforeExpiry\": 1,\n \"templateName\": \"Sample Template\",\n \"templateDescription\": \"\"\n },\n \"documents\": [\n {\n \"id\": \"53aa7efc-82fc-49b1330114c68\",\n \"name\": \"Sales Agreement.pdf\",\n \"externalContext\": null\n }\n ],\n \"recipients\": [\n {\n \"id\": \"9ef72bea-765-b957a6ba80e9\",\n \"name\": \"\",\n \"email\": \"\",\n \"role\": \"signer\",\n \"status\": \"Template\",\n \"signDate\": \"\",\n \"signOrder\": 1,\n \"signGroupId\": \"00000000-000-000000000000\",\n \"userId\": null,\n \"mandatory\": true,\n \"isMFAEnabled\": false,\n \"phoneNumber\": null,\n \"hostEmail\": null,\n \"templateRole\": \"Sample Role\",\n \"externalContext\": null\n }\n ],\n \"signGroups\": [],\n \"fields\": [\n {\n \"id\": \"69950844-1206-9711415\",\n \"name\": \"6a19f2a2630241c7e99cbdd34da\",\n \"recipientId\": \"9ef72bea-76fa-4957a6ba80e9\",\n \"signGroupId\": \"00000000-0000-000000000000\",\n \"documentId\": \"53aa7efc-82fc-46330114c68\",\n \"type\": \"signature\",\n \"value\": \"\",\n \"page\": 1,\n \"height\": 35,\n \"width\": 100,\n \"positionX\": 117.2445,\n \"positionY\": 17.8811,\n \"isRequired\": true,\n \"properties\": null\n },\n {\n \"id\": \"ae726cea-1dc0-4df0c989ff30\",\n \"name\": \"d6a1b10eb7a64c891c78d3a85\",\n \"recipientId\": \"9ef72bea-76957a6ba80e9\",\n \"signGroupId\": \"00000000-000000000\",\n \"documentId\": \"53aa7efc-82330114c68\",\n \"type\": \"name\",\n \"value\": \"\",\n \"page\": 1,\n \"height\": 35,\n \"width\": 100,\n \"positionX\": 235.016,\n \"positionY\": 17.8689,\n \"isRequired\": false,\n \"properties\": {\n \"fontFamily\": \"Helvetica\",\n \"fontSize\": 13,\n \"color\": \"#000000\",\n \"bold\": false,\n \"italic\": false,\n \"underline\": false,\n \"textAlign\": \"left\",\n \"isSignedDate\": false,\n \"selectionGroup\": null,\n \"selectionValue\": null\n }\n }\n ],\n \"externalContext\": null\n }\n },\n \"origin\": \"GET https://dev.headless.mavenmule.com/signatures/template/e08f7851-dc1d-482ff0857c4e4/get\",\n \"dateTime\": \"2025-11-04T12:36:06.0000000+00:00\",\n \"userId\": \"1d8b89c4-088af09ac3bc9b\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "ceaa2948-c698-4cab-a2f9-6eb4cc917450",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"template",
":templateId",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the needed template.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "templateId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\",\n \"urn\": \"{{sentUrn}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "fb3d140b-b7d5-4530-aaf6-e1f8055f008d",
"name": "This response indicates that there’s no template found with the provided ID.",
"originalRequest": {
"url": {
"path": [
"signatures",
"template",
":templateId",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the needed template.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "templateId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Not Found",
"code": 404,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"404\",\n \"message\": \"Not Found\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "49be517a-bb74-4c08-b3ee-983a448ba982",
"name": "Template List",
"request": {
"name": "Template List",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"template",
"list"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "Maximum number of templates to return.",
"type": "text/plain"
},
"key": "top",
"value": "9201"
},
{
"disabled": false,
"description": {
"content": "Number of templates to skip in the sorted results.",
"type": "text/plain"
},
"key": "skip",
"value": "9201"
},
{
"disabled": false,
"description": {
"content": "Column to sort by the results. (This can only be one of Template Name,Template Roles,Documents,Creation Date)",
"type": "text/plain"
},
"key": "sort",
"value": "Template Name"
},
{
"disabled": false,
"description": {
"content": "The direction of the sort. (This can only be one of ASC,DESC)",
"type": "text/plain"
},
"key": "order",
"value": "ASC"
},
{
"disabled": false,
"description": {
"content": "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. (This can only be one of 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": "text/plain"
},
"key": "filter",
"value": "Starts With"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"response": [
{
"id": "fc08deb0-82a3-42d9-8d9e-94db83e95e6a",
"name": "This is the response returned when the list of available templates is successfully retrieved.",
"originalRequest": {
"url": {
"path": [
"signatures",
"template",
"list"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "Maximum number of templates to return.",
"type": "text/plain"
},
"key": "top",
"value": "9201"
},
{
"disabled": false,
"description": {
"content": "Number of templates to skip in the sorted results.",
"type": "text/plain"
},
"key": "skip",
"value": "9201"
},
{
"disabled": false,
"description": {
"content": "Column to sort by the results. (This can only be one of Template Name,Template Roles,Documents,Creation Date)",
"type": "text/plain"
},
"key": "sort",
"value": "Template Name"
},
{
"disabled": false,
"description": {
"content": "The direction of the sort. (This can only be one of ASC,DESC)",
"type": "text/plain"
},
"key": "order",
"value": "ASC"
},
{
"disabled": false,
"description": {
"content": "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. (This can only be one of 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": "text/plain"
},
"key": "filter",
"value": "Starts With"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 200,\n \"message\": \"OK\",\n \"data\": {\n \"templates\": [\n {\n \"id\": \"4602f79a-9be6-4076-8eb7-85bf16cdf68f\",\n \"createdBy\": {\n \"id\": \"1d8b89c4-0889-4d03-a90c-9af09ac3bc9b\",\n \"name\": \"Roman\",\n \"email\": \"roman.khryshchanovich@mavenmule.com\"\n },\n \"creatorGuid\": \"1d8b89c4-0889-4d03-a90c-9af09ac3bc9b\",\n \"status\": \"Template\",\n \"uploadDate\": \"2025-11-04T12:26:38.0000000+00:00\",\n \"sendDate\": null,\n \"subject\": \"\",\n \"transactionTokenId\": null,\n \"documents\": \"\",\n \"recipients\": \"\",\n \"isSignOrder\": false,\n \"expireInDays\": 30,\n \"alertDaysBeforeExpiry\": 1,\n \"templateName\": \"Template5\",\n \"templateDescription\": \"\",\n \"templateRoles\": \"r1\"\n },\n {\n \"id\": \"4c935dff-d7ee-497b-80d5-198f92a4561c\",\n \"createdBy\": {\n \"id\": \"1d8b89c4-0889-4d03-a90c-9af09ac3bc9b\",\n \"name\": \"Roman\",\n \"email\": \"roman.khryshchanovich@mavenmule.com\"\n },\n \"creatorGuid\": \"1d8b89c4-0889-4d03-a90c-9af09ac3bc9b\",\n \"status\": \"Template\",\n \"uploadDate\": \"2025-11-04T12:22:15.0000000+00:00\",\n \"sendDate\": null,\n \"subject\": \"\",\n \"transactionTokenId\": null,\n \"documents\": \"Sales Agreement.pdf\",\n \"recipients\": \"\",\n \"isSignOrder\": false,\n \"expireInDays\": 30,\n \"alertDaysBeforeExpiry\": 1,\n \"templateName\": \"Sample Template\",\n \"templateDescription\": \"\",\n \"templateRoles\": \"Sample Role 1\"\n },\n {\n \"id\": \"816f309c-8e87-4f10-8873-0de066723ee9\",\n \"createdBy\": {\n \"id\": \"1d8b89c4-0889-4d03-a90c-9af09ac3bc9b\",\n \"name\": \"Roman\",\n \"email\": \"roman.khryshchanovich@mavenmule.com\"\n },\n \"creatorGuid\": \"1d8b89c4-0889-4d03-a90c-9af09ac3bc9b\",\n \"status\": \"Template\",\n \"uploadDate\": \"2025-11-03T12:08:59.0000000+00:00\",\n \"sendDate\": null,\n \"subject\": \"\",\n \"transactionTokenId\": null,\n \"documents\": \"Sales Agreement.pdf\",\n \"recipients\": \"\",\n \"isSignOrder\": false,\n \"expireInDays\": 30,\n \"alertDaysBeforeExpiry\": 1,\n \"templateName\": \"TemplatePostman\",\n \"templateDescription\": \"\",\n \"templateRoles\": \"Role1\"\n }\n ],\n \"rowCount\": 3\n }\n },\n \"origin\": \"GET https://dev.headless.mavenmule.com/signatures/template/list\",\n \"dateTime\": \"2025-11-04T12:26:45.0000000+00:00\",\n \"userId\": \"1d8b89c4-0889-4d03-a90c-9af09ac3bc9b\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "c48decaf-083a-4706-acd6-e5a705d63b79",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"template",
"list"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "Maximum number of templates to return.",
"type": "text/plain"
},
"key": "top",
"value": "9201"
},
{
"disabled": false,
"description": {
"content": "Number of templates to skip in the sorted results.",
"type": "text/plain"
},
"key": "skip",
"value": "9201"
},
{
"disabled": false,
"description": {
"content": "Column to sort by the results. (This can only be one of Template Name,Template Roles,Documents,Creation Date)",
"type": "text/plain"
},
"key": "sort",
"value": "Template Name"
},
{
"disabled": false,
"description": {
"content": "The direction of the sort. (This can only be one of ASC,DESC)",
"type": "text/plain"
},
"key": "order",
"value": "ASC"
},
{
"disabled": false,
"description": {
"content": "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. (This can only be one of 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": "text/plain"
},
"key": "filter",
"value": "Starts With"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\",\n \"urn\": \"{{sentUrn}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "06333a90-3039-4915-861d-adfd1cfad19d",
"name": "Template Update",
"request": {
"name": "Template Update",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"template",
":templateId",
"update"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "string",
"key": "templateId",
"disabled": false,
"description": {
"content": "(Required) The ID of the template that should be edited.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {}
},
"response": [
{
"id": "6ec5ccb1-691b-465d-8cc7-6aded3e8fc46",
"name": "This is the response returned when the template is successfully edited.",
"originalRequest": {
"url": {
"path": [
"signatures",
"template",
":templateId",
"update"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the template that should be edited.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "templateId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 200,\n \"message\": \"OK\",\n \"data\": {\n \"template\": {\n \"id\": \"e08f7851-dc1-d2ff0857c4e4\"\n },\n \"documents\": [\n {\n \"id\": \"174b02df-b89c-6793450ca\",\n \"externalContext\": null\n }\n ],\n \"recipients\": [\n {\n \"id\": \"c491b4bc-79b6-44d0-a34c6ab6\",\n \"externalContext\": null\n }\n ],\n \"signGroups\": [],\n \"fields\": [\n {\n \"id\": \"93e22ca5-cf10-40ab-ecfb75c6\",\n \"recipientId\": \"c491b4bc-79b6-4a334c6ab6\",\n \"signGroupId\": \"00000000-000000000000\",\n \"documentId\": \"174b02df-b89c-4d393450ca\"\n },\n {\n \"id\": \"ba1c7c7f-c05e972c8b406e\",\n \"recipientId\": \"c491b4bc-79b6-44d0-6ab6\",\n \"signGroupId\": \"00000000-0000-000000000\",\n \"documentId\": \"174b02df-bb3f6793450ca\"\n }\n ]\n }\n },\n \"origin\": \"PUT https://dev.headless.mavenmule.com/signatures/template/e08f7851-dc1-d2ff0857c4e4/update\",\n \"dateTime\": \"2025-11-04T12:37:28.0000000+00:00\",\n \"userId\": \"1d8b89c4-0889-9af09ac3bc9b\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "958ee2bd-9eec-47c2-abd2-ae6dc53029b4",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"template",
":templateId",
"update"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the template that should be edited.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "templateId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": 400,\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"TEMPLATE_ID_INVALID\",\n \"message\": \"Template with ID 0f6dca08-76b883c8bbb4 does not exist\",\n \"userMessage\": \"Template with ID 0f6dca08-76b883c8bbb does not exist\"\n }\n ],\n \"externalErrors\": []\n },\n \"externalContext\": {\n \"test1\": \"testvalue\"\n },\n \"origin\": \"PUT https://dev.headless.mavenmule.com/signatures/template/0f6dca08-76b883c8bbb/edit\",\n \"dateTime\": \"2025-11-04T07:40:12.0000000+00:00\",\n \"userId\": \"1d8b89c4-0ac3bc9b\",\n \"operationId\": \"5c1354f98612f2eec2\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "e70698e0-bd82-47d8-90a3-3cc768750318",
"name": "This response indicates that there’s no template found with the provided ID.",
"originalRequest": {
"url": {
"path": [
"signatures",
"template",
":templateId",
"update"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID of the template that should be edited.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "templateId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {}
},
"status": "Not Found",
"code": 404,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"404\",\n \"message\": \"Not Found\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "43b9eb48-57c5-42f6-911b-092bb7cf3d3e",
"name": "Template Edit",
"request": {
"name": "Template Edit",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"template",
":templateId",
"edit"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "c1a7864b-946b-1b6d-2cc0-62d0103cd920",
"key": "templateId",
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the template to be edited.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"template\": {\n \"folderId\": \"123e4567-e89b-12d3-a456-426614174000\"\n },\n \"externalContext\": {\n \"id\": \"12345\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"response": [
{
"id": "497c9214-15b6-4f4c-bb68-5ecf6be115b2",
"name": "This response indicates that the template was successfully edited.",
"originalRequest": {
"url": {
"path": [
"signatures",
"template",
":templateId",
"edit"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the template to be edited.",
"type": "text/plain"
},
"type": "any",
"value": "c1a7864b-946b-1b6d-2cc0-62d0103cd920",
"key": "templateId"
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"template\": {\n \"folderId\": \"123e4567-e89b-12d3-a456-426614174000\"\n },\n \"externalContext\": {\n \"id\": \"12345\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 200,\n \"message\": \"OK\",\n \"data\": {\n \"template\": {\n \"id\": \"1df9-be76007e25fc\",\n \"message\": \"Template successfully edited\"\n }\n }\n },\n \"origin\": \"PUT https://dev.headless.mavenmule.com/signatures/template/1df9-be76007e25fc/edit\",\n \"dateTime\": \"2025-11-04T10:25:22.0000000+00:00\",\n \"userId\": \"1d8b89c4-090c-9af09ac3bc9b\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "bdf141d7-7650-49bb-afab-112364181d1b",
"name": "This response indicates that the request was invalid, improperly formed, or the template edit operation failed in the database.",
"originalRequest": {
"url": {
"path": [
"signatures",
"template",
":templateId",
"edit"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the template to be edited.",
"type": "text/plain"
},
"type": "any",
"value": "c1a7864b-946b-1b6d-2cc0-62d0103cd920",
"key": "templateId"
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"template\": {\n \"folderId\": \"123e4567-e89b-12d3-a456-426614174000\"\n },\n \"externalContext\": {\n \"id\": \"12345\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"TEMPLATE_EDIT_FAILED\",\n \"message\": \"Failed to update the template folder in the database.\",\n \"userMessage\": \"Could not edit the specified template.\"\n }\n ]\n },\n \"externalContext\": {\n \"id\": \"12345\"\n },\n \"origin\": \"PUT https://dev.headless.mavenmule.com/signatures/template/1df9-be76007e25fc/edit\",\n \"dateTime\": \"2025-11-04T10:25:22.0000000+00:00\",\n \"userId\": \"1d8b89c4-090c-9af09ac3bc9b\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
}
]
},
{
"name": "Comment",
"description": "",
"item": [
{
"id": "d105d009-620c-4c6e-a189-0d6c9d8a1bfa",
"name": "Document Comment",
"request": {
"name": "Document Comment",
"description": {
"content": "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.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"document",
":documentId",
"comment"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": [
{
"type": "any",
"value": "string",
"key": "documentId",
"disabled": false,
"description": {
"content": "(Required) The ID(URN) of the document from the envelope, where you’d like to place a comment.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {}
},
"response": [
{
"id": "5a8f889b-91a2-4cca-b7d5-470b225a1f45",
"name": "This response is returned after a successful request to place the comment.",
"originalRequest": {
"url": {
"path": [
"signatures",
"document",
":documentId",
"comment"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID(URN) of the document from the envelope, where you’d like to place a comment.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "documentId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {}
},
"status": "Created",
"code": 201,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 201,\n \"message\": \"Created\",\n \"data\": {\n \"comments\": {\n \"629d2b7e-378f-88e-4e5646764c4d\": [\n {\n \"id\": 6,\n \"commentGuid\": \"46e10767-8806-40bbe6fc\",\n \"documentId\": 47,\n \"signerId\": 49,\n \"parentCommentId\": null,\n \"parentCommentGuid\": null,\n \"content\": \"TEST\",\n \"pageNumber\": 1,\n \"positionX\": 1201.95351573992,\n \"positionY\": 134.439541041483,\n \"visibleTo\": \"[\\\"sender\\\",\\\"fc6f00f-f125-4939fa6\\\"]\",\n \"createdAt\": \"2025-10-31T10:44:30.0000000+00:00\",\n \"authorName\": \"RomanK\",\n \"authorEmail\": \"roman.khryshchanovich@mavenmule.com\",\n \"documentGuid\": \"629db7-378f-4e56476c4d\"\n }\n ]\n }\n }\n },\n \"origin\": \"POST https://dev.headless.mavenmule.com/signatures/document/629db7-378f-4e56476c4d/comment\",\n \"dateTime\": \"2025-10-31T10:44:31.0000000+00:00\",\n \"userId\": \"1d8b89c4-0889--9af09ac3bc9b\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "df1afeab-3bf6-4be8-a9ad-eb00b9ac046e",
"name": "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.",
"originalRequest": {
"url": {
"path": [
"signatures",
"document",
":documentId",
"comment"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "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.",
"type": "text/plain"
},
"key": "tid",
"value": "string"
}
],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The ID(URN) of the document from the envelope, where you’d like to place a comment.",
"type": "text/plain"
},
"type": "any",
"value": "string",
"key": "documentId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"statusCode\": \"400\",\n \"message\": \"Bad Request\",\n \"innerErrors\": [\n {\n \"code\": \"{{errorCode}}\",\n \"message\": \"{{errorMessage}}\",\n \"userMessage\": \"{{message}}\",\n \"urn\": \"{{sentUrn}}\"\n }\n ]\n },\n \"origin\": \"{{originEnvironment}}\",\n \"dateTime\": \"{{responseTimestamp}}\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
}
]
},
{
"name": "Folder",
"description": "",
"item": [
{
"id": "a4e87be8-afb1-4c6f-b957-d6c1a786c443",
"name": "Folder Get",
"request": {
"name": "Folder Get",
"description": {
"content": "Retrieves the details and metadata of a specific folder using its unique ID.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"folder",
":folderId",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "c1a7864b-946b-1b6d-2cc0-62d0103cd920",
"key": "folderId",
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the folder to retrieve.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"response": [
{
"id": "04232bbc-0336-44c2-bc73-df5907aedbf5",
"name": "Folder details retrieved successfully.",
"originalRequest": {
"url": {
"path": [
"signatures",
"folder",
":folderId",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the folder to retrieve.",
"type": "text/plain"
},
"type": "any",
"value": "c1a7864b-946b-1b6d-2cc0-62d0103cd920",
"key": "folderId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 200,\n \"message\": \"OK\",\n \"data\": {\n \"folder\": {\n \"Id\": 1,\n \"FolderGuid\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"SubscriptionUserId\": 105,\n \"Name\": \"Q3 Financial Contracts\",\n \"NamespaceId\": 12\n }\n }\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "a730c735-b3e7-4b56-ab62-255cf5644fdc",
"name": "Folder List",
"request": {
"name": "Folder List",
"description": {
"content": "Retrieves a paginated list of all folders associated with the authenticated user or namespace.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"folder",
"list"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "Maximum number of folders to return.",
"type": "text/plain"
},
"key": "top",
"value": "9201"
},
{
"disabled": false,
"description": {
"content": "Number of folders to skip in the sorted results.",
"type": "text/plain"
},
"key": "skip",
"value": "9201"
},
{
"disabled": false,
"description": {
"content": "Column to sort the results by (e.g., Name).",
"type": "text/plain"
},
"key": "sort",
"value": "string"
},
{
"disabled": false,
"description": {
"content": "Sort direction (ASC or DESC). (This can only be one of ASC,DESC)",
"type": "text/plain"
},
"key": "order",
"value": "ASC"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"response": [
{
"id": "02644bb2-dbaf-4019-819c-4f0ebf758a82",
"name": "List of folders retrieved successfully.",
"originalRequest": {
"url": {
"path": [
"signatures",
"folder",
"list"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "Maximum number of folders to return.",
"type": "text/plain"
},
"key": "top",
"value": "9201"
},
{
"disabled": false,
"description": {
"content": "Number of folders to skip in the sorted results.",
"type": "text/plain"
},
"key": "skip",
"value": "9201"
},
{
"disabled": false,
"description": {
"content": "Column to sort the results by (e.g., Name).",
"type": "text/plain"
},
"key": "sort",
"value": "string"
},
{
"disabled": false,
"description": {
"content": "Sort direction (ASC or DESC). (This can only be one of ASC,DESC)",
"type": "text/plain"
},
"key": "order",
"value": "ASC"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 200,\n \"message\": \"OK\",\n \"data\": {\n \"folders\": [\n {\n \"Id\": 1,\n \"FolderGuid\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"SubscriptionUserId\": 105,\n \"Name\": \"Q3 Financial Contracts\",\n \"NamespaceId\": 12\n }\n ],\n \"rowCount\": 0\n }\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "0cd1cc19-95b8-46b3-aa34-7d9a50647247",
"name": "Folder Update",
"request": {
"name": "Folder Update",
"description": {
"content": "Updates the properties (such as the Name) of an existing folder.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"folder",
":folderId",
"update"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "c1a7864b-946b-1b6d-2cc0-62d0103cd920",
"key": "folderId",
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the folder to update.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"Id\": 1,\n \"FolderGuid\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"SubscriptionUserId\": 105,\n \"Name\": \"Q3 Financial Contracts\",\n \"NamespaceId\": 12\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"response": [
{
"id": "eecd02d9-4644-4d89-9358-f8162c4a93bf",
"name": "Folder updated successfully.",
"originalRequest": {
"url": {
"path": [
"signatures",
"folder",
":folderId",
"update"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the folder to update.",
"type": "text/plain"
},
"type": "any",
"value": "c1a7864b-946b-1b6d-2cc0-62d0103cd920",
"key": "folderId"
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"Id\": 1,\n \"FolderGuid\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"SubscriptionUserId\": 105,\n \"Name\": \"Q3 Financial Contracts\",\n \"NamespaceId\": 12\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 200,\n \"message\": \"OK\",\n \"data\": {\n \"folder\": {\n \"Id\": 1,\n \"FolderGuid\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"SubscriptionUserId\": 105,\n \"Name\": \"Q3 Financial Contracts\",\n \"NamespaceId\": 12\n }\n }\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "f53b2969-2d6c-4512-8a14-fadd32fb24aa",
"name": "Folder Create",
"request": {
"name": "Folder Create",
"description": {
"content": "Creates a new folder in the specified namespace to organize documents and envelopes.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"folder",
"create"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"Id\": 1,\n \"FolderGuid\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"SubscriptionUserId\": 105,\n \"Name\": \"Q3 Financial Contracts\",\n \"NamespaceId\": 12\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"response": [
{
"id": "a1abaa25-59f2-4a38-af13-a2c3482e9896",
"name": "Folder created successfully.",
"originalRequest": {
"url": {
"path": [
"signatures",
"folder",
"create"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"Id\": 1,\n \"FolderGuid\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"SubscriptionUserId\": 105,\n \"Name\": \"Q3 Financial Contracts\",\n \"NamespaceId\": 12\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
}
},
"status": "Created",
"code": 201,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 201,\n \"message\": \"Created\",\n \"data\": {\n \"folder\": {\n \"Id\": 1,\n \"FolderGuid\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"SubscriptionUserId\": 105,\n \"Name\": \"Q3 Financial Contracts\",\n \"NamespaceId\": 12\n }\n }\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "7f50160d-1985-46a3-921e-58cb57816ab1",
"name": "Folder Delete",
"request": {
"name": "Folder Delete",
"description": {
"content": "Deletes a specific folder from the system.",
"type": "text/plain"
},
"url": {
"path": [
"signatures",
"folder",
":folderId",
"delete"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"type": "any",
"value": "c1a7864b-946b-1b6d-2cc0-62d0103cd920",
"key": "folderId",
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the folder to delete.",
"type": "text/plain"
}
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "DELETE",
"body": {}
},
"response": [
{
"id": "3d1c78b7-5d67-47b5-aed3-d9ed8f9851f2",
"name": "Folder deleted successfully.",
"originalRequest": {
"url": {
"path": [
"signatures",
"folder",
":folderId",
"delete"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"description": {
"content": "(Required) The unique identifier (GUID) of the folder to delete.",
"type": "text/plain"
},
"type": "any",
"value": "c1a7864b-946b-1b6d-2cc0-62d0103cd920",
"key": "folderId"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "DELETE",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"result\": {\n \"statusCode\": 200,\n \"message\": \"OK\",\n \"data\": {\n \"folderId\": \"string\",\n \"message\": \"Folder deleted successfully.\"\n }\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
}
]
}
]
},
{
"name": "Clickwrap",
"description": {
"content": "",
"type": "text/plain"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"exec": [
"const value = pm.variables.get('clickwrapSubscriptionKey');",
"if (!value || !value.trim() || value.trim().indexOf('",
"type": "string",
"description": "Subscription key for the Documents API."
},
{
"key": "signaturesSubscriptionKey",
"value": "",
"type": "string",
"description": "Subscription key for the Signatures API."
},
{
"key": "clickwrapSubscriptionKey",
"value": "",
"type": "string",
"description": "Subscription key for the Clickwrap API."
},
{
"key": "commonSubscriptionKey",
"value": "",
"type": "string",
"description": "Subscription key for the Common API."
},
{
"key": "contentSubscriptionKey",
"value": "",
"type": "string",
"description": "Subscription key for the Content API."
},
{
"key": "driveSubscriptionKey",
"value": "",
"type": "string",
"description": "Subscription key for the Drive API."
},
{
"key": "platformSubscriptionKey",
"value": "",
"type": "string",
"description": "Subscription key for the Platform API."
},
{
"key": "proxySubscriptionKey",
"value": "",
"type": "string",
"description": "Subscription key for the Proxy API."
},
{
"key": "toolsSubscriptionKey",
"value": "",
"type": "string",
"description": "Subscription key for the Tools API."
},
{
"key": "baseUrl",
"value": "https://dev.api.doctavian.com",
"type": "string",
"description": "Doctavian API base URL."
},
{
"key": "authProvider",
"value": "microsoft",
"type": "string",
"description": "Identity provider for OAuth 2.0: `microsoft` or `google`."
},
{
"key": "authBaseUrl",
"value": "{{baseUrl}}/platform/auth",
"type": "string",
"description": "Base URL of the Doctavian platform auth endpoints (shares the host with `baseUrl`)."
},
{
"key": "authUrl",
"value": "{{authBaseUrl}}/{{authProvider}}/authorize",
"type": "string",
"description": "OAuth 2.0 authorization endpoint (opens the browser login)."
},
{
"key": "accessTokenUrl",
"value": "{{authBaseUrl}}/{{authProvider}}/token",
"type": "string",
"description": "OAuth 2.0 token endpoint."
},
{
"key": "clientId",
"value": "",
"type": "string",
"description": "OAuth 2.0 client/application id. Populate from your app registration."
},
{
"key": "clientSecret",
"value": "",
"type": "secret",
"description": "OAuth 2.0 client secret. Populate from your app registration."
},
{
"key": "scope",
"value": "api://dfdd1b20-28ad-4576-9e39-a0c68eda8014/.default offline_access",
"type": "string",
"description": "OAuth 2.0 scopes (space-separated)."
},
{
"key": "redirectUri",
"value": "https://oauth.pstmn.io/v1/callback",
"type": "string",
"description": "OAuth 2.0 redirect/callback URL. Must match a redirect URI registered with the IdP. Postman default shown."
},
{
"value": "",
"key": "signedAuth.crypto.privateKey",
"type": "secret",
"description": "RSA private key used to RS256-sign the authorization JWTs. Paste either the raw PKCS#8 base64 body or a full PEM (`-----BEGIN PRIVATE KEY-----`). Used by `X-Client-Authorization` and `X-Service-Authorization`."
},
{
"value": "",
"key": "signedAuth.crypto.aesKey",
"type": "secret",
"description": "Base64-encoded AES-128 key used to encrypt the signed JWT (AES-128-CBC, PKCS#7). Used by `X-Client-Authorization` and `X-Service-Authorization`."
},
{
"value": "",
"key": "signedAuth.crypto.aesIv",
"type": "secret",
"description": "Base64-encoded 16-byte AES initialization vector (CBC mode). Used by `X-Client-Authorization` and `X-Service-Authorization`."
},
{
"value": "3600",
"key": "signedAuth.crypto.ttlSeconds",
"type": "string",
"description": "Lifetime of the generated JWTs in seconds; `exp` is set to `iat` + this value. Used by `X-Client-Authorization` and `X-Service-Authorization`."
},
{
"key": "signedAuth.shared.fullName",
"value": "",
"type": "string",
"description": "Display name for the `full_name` claim. Used by `X-Client-Authorization` and `X-Service-Authorization`."
},
{
"key": "signedAuth.shared.email",
"value": "",
"type": "string",
"description": "Email address for the `email` claim. Used by `X-Client-Authorization` and `X-Service-Authorization`."
},
{
"key": "signedAuth.shared.iss",
"value": "",
"type": "string",
"description": "Issuer (`iss`) — your org domain, e.g. `https://your-domain.example.com`. Used by `X-Client-Authorization` and `X-Service-Authorization`."
},
{
"key": "signedAuth.shared.oid",
"value": "",
"type": "string",
"description": "User id for the `oid` claim. Used by `X-Client-Authorization` and `X-Service-Authorization`."
},
{
"key": "signedAuth.client.orgId",
"value": "",
"type": "string",
"description": "Organization id for the `client_id` claim (distinct from the OAuth `clientId` app-registration id). Used by `X-Client-Authorization` only."
},
{
"key": "signedAuth.client.dest",
"value": "",
"type": "string",
"description": "Callback REST path for the `dest` claim. Used by `X-Client-Authorization` only."
},
{
"key": "signedAuth.client.locale",
"value": "",
"type": "string",
"description": "Locale for the `locale` claim (e.g. `en_US`). Used by `X-Client-Authorization` only."
},
{
"key": "signedAuth.client.zoneinfo",
"value": "",
"type": "string",
"description": "Time zone for the `zoneinfo` claim (e.g. `Europe/Zagreb`). Used by `X-Client-Authorization` only."
},
{
"key": "signedAuth.client.redirectUrl",
"value": "",
"type": "string",
"description": "Optional `redirect_url` claim; left blank it is sent as `null`. Used by `X-Client-Authorization` only."
},
{
"key": "signedAuth.client.subToken",
"value": "",
"type": "secret",
"description": "Token for the `sub` claim: the acquired OAuth access token (copy it from the collection Authorization tab after logging in) or a different token. Used by `X-Client-Authorization` only."
},
{
"key": "signedAuth.service.ampSubscription",
"value": "",
"type": "string",
"description": "AMP subscription id for the `amp_subscription` claim. Used by `X-Service-Authorization` only."
}
],
"auth": {
"type": "oauth2",
"oauth2": [
{
"key": "grant_type",
"value": "authorization_code",
"type": "string"
},
{
"key": "authUrl",
"value": "{{authUrl}}",
"type": "string"
},
{
"key": "accessTokenUrl",
"value": "{{accessTokenUrl}}",
"type": "string"
},
{
"key": "clientId",
"value": "{{clientId}}",
"type": "string"
},
{
"key": "clientSecret",
"value": "{{clientSecret}}",
"type": "string"
},
{
"key": "scope",
"value": "{{scope}}",
"type": "string"
},
{
"key": "redirect_uri",
"value": "{{redirectUri}}",
"type": "string"
},
{
"key": "client_authentication",
"value": "body",
"type": "string"
},
{
"key": "tokenName",
"value": "Doctavian access token",
"type": "string"
},
{
"key": "addTokenTo",
"value": "header",
"type": "string"
}
]
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"exec": [
"// Doctavian managed auth: signed + encrypted JWT headers.",
"(function () {\n const CryptoJS = require('crypto-js');\n const HEADERS = [{\"header\":\"X-Client-Authorization\",\"claims\":[{\"claim\":\"full_name\",\"variable\":\"signedAuth.shared.fullName\"},{\"claim\":\"email\",\"variable\":\"signedAuth.shared.email\"},{\"claim\":\"iss\",\"variable\":\"signedAuth.shared.iss\"},{\"claim\":\"oid\",\"variable\":\"signedAuth.shared.oid\"},{\"claim\":\"client_id\",\"variable\":\"signedAuth.client.orgId\"},{\"claim\":\"dest\",\"variable\":\"signedAuth.client.dest\"},{\"claim\":\"locale\",\"variable\":\"signedAuth.client.locale\"},{\"claim\":\"zoneinfo\",\"variable\":\"signedAuth.client.zoneinfo\"},{\"claim\":\"redirect_url\",\"variable\":\"signedAuth.client.redirectUrl\",\"nullable\":true},{\"claim\":\"sub\",\"variable\":\"signedAuth.client.subToken\"}]},{\"header\":\"X-Service-Authorization\",\"claims\":[{\"claim\":\"full_name\",\"variable\":\"signedAuth.shared.fullName\"},{\"claim\":\"email\",\"variable\":\"signedAuth.shared.email\"},{\"claim\":\"iss\",\"variable\":\"signedAuth.shared.iss\"},{\"claim\":\"oid\",\"variable\":\"signedAuth.shared.oid\"},{\"claim\":\"amp_subscription\",\"variable\":\"signedAuth.service.ampSubscription\"}]}];\n const CRYPTO = {\"privateKey\":\"signedAuth.crypto.privateKey\",\"aesKey\":\"signedAuth.crypto.aesKey\",\"aesIv\":\"signedAuth.crypto.aesIv\",\"ttlSeconds\":\"signedAuth.crypto.ttlSeconds\"};\n const JSRSASIGN_URL = \"https://cdn.jsdelivr.net/npm/jsrsasign@11.1.3/lib/jsrsasign-all-min.js\";\n const CACHE_SOURCE_KEY = 'doctavianJsrsasignSource';\n const CACHE_URL_KEY = 'doctavianJsrsasignUrl';\n\n // jsrsasign reads navigator.appName during init; provide a minimal in-scope shim so the\n // eval'd bundle resolves it (Postman's sandbox defines no navigator and no global object).\n var navigator = { appName: 'Netscape' };\n\n function variable(name) {\n const value = pm.variables.get(name);\n return value == null ? '' : String(value).trim();\n }\n\n function required(name, label) {\n const value = variable(name);\n if (!value) {\n throw new Error('Set the \"' + name + '\" collection variable before sending requests (' + label + ').');\n }\n return value;\n }\n\n // Accept either a full PEM or the raw base64 PKCS#8 body the developer pastes.\n function toPrivateKeyPem(raw) {\n if (raw.indexOf('BEGIN') !== -1) return raw;\n const body = raw.replace(/\\s+/g, '');\n return '-----BEGIN PRIVATE KEY-----\\n' + body.match(/.{1,64}/g).join('\\n') + '\\n-----END PRIVATE KEY-----';\n }\n\n function claimValue(claim) {\n const value = variable(claim.variable);\n if (!value) return claim.nullable ? null : '';\n return value;\n }\n\n // A managed header is injected only when the request declares it (the OpenAPI conversion\n // leaves X-Client-/X-Service-Authorization on exactly those operations) AND the developer\n // hasn't opted out. Opt-outs: disable the header (suppress here) or give it a non-empty\n // value (use your own token). So requests that don't use them need no keys, no fetch.\n function neededHeaders() {\n const headerList = pm.request.headers;\n const items =\n headerList && typeof headerList.all === 'function'\n ? headerList.all()\n : Array.isArray(headerList)\n ? headerList\n : [];\n const state = {};\n for (let i = 0; i < items.length; i++) {\n const header = items[i];\n if (!header || !header.key) continue;\n const value = header.value == null ? '' : String(header.value).trim();\n state[String(header.key).toLowerCase()] = { disabled: header.disabled === true, hasValue: value.length > 0 };\n }\n return HEADERS.filter(function (def) {\n const entry = state[def.header.toLowerCase()];\n return entry && !entry.disabled && !entry.hasValue;\n });\n }\n\n // Run the bundle and capture KEYUTIL/KJUR via a trailing expression inside the same eval,\n // so we don't depend on eval leaking its declarations into this scope.\n function loadJsrsasign(source) {\n const lib = eval(source + '\\n;({ KEYUTIL: KEYUTIL, KJUR: KJUR })');\n if (!lib || !lib.KEYUTIL || !lib.KJUR) {\n throw new Error('jsrsasign loaded from ' + JSRSASIGN_URL + ' but KEYUTIL/KJUR are unavailable.');\n }\n return lib;\n }\n\n function buildHeaders(KEYUTIL, KJUR, headers) {\n const signingKey = KEYUTIL.getKey(toPrivateKeyPem(required(CRYPTO.privateKey, 'RSA private key')));\n const aesKey = CryptoJS.enc.Base64.parse(required(CRYPTO.aesKey, 'AES-128 key'));\n const aesIv = CryptoJS.enc.Base64.parse(required(CRYPTO.aesIv, 'AES-128 IV'));\n const jwtHeader = JSON.stringify({ typ: 'JWT', alg: 'RS256' });\n const iat = Math.floor(Date.now() / 1000);\n const exp = iat + (parseInt(variable(CRYPTO.ttlSeconds), 10) || 3600);\n\n for (let i = 0; i < headers.length; i++) {\n const def = headers[i];\n const payload = { exp: String(exp), iat: String(iat) };\n for (let j = 0; j < def.claims.length; j++) {\n const claim = def.claims[j];\n payload[claim.claim] = claimValue(claim);\n }\n const jwt = KJUR.jws.JWS.sign('RS256', jwtHeader, JSON.stringify(payload), signingKey);\n const encrypted = CryptoJS.AES.encrypt('Bearer ' + jwt, aesKey, {\n iv: aesIv,\n padding: CryptoJS.pad.Pkcs7,\n mode: CryptoJS.mode.CBC,\n }).toString();\n pm.request.headers.upsert({ key: def.header, value: encrypted });\n }\n }\n\n function signWith(source, headers) {\n const lib = loadJsrsasign(source);\n buildHeaders(lib.KEYUTIL, lib.KJUR, headers);\n }\n\n const needed = neededHeaders();\n if (needed.length === 0) return; // This endpoint doesn't use the signed headers.\n\n const cachedSource = pm.globals.get(CACHE_SOURCE_KEY);\n if (cachedSource && pm.globals.get(CACHE_URL_KEY) === JSRSASIGN_URL) {\n signWith(cachedSource, needed);\n return;\n }\n\n // First request that needs them: fetch the bundle, cache it, then sign.\n pm.sendRequest({ url: JSRSASIGN_URL, method: 'GET' }, function (err, res) {\n if (err || !res || res.code !== 200) {\n throw new Error(\n 'Failed to load jsrsasign from ' + JSRSASIGN_URL + ': ' + (err ? err.message : 'HTTP ' + (res && res.code)),\n );\n }\n const source = res.text();\n pm.globals.set(CACHE_SOURCE_KEY, source);\n pm.globals.set(CACHE_URL_KEY, JSRSASIGN_URL);\n signWith(source, needed);\n });\n})();"
]
}
}
]
}