---
agentTools:
  projectIndex: https://developer.kompliant.com/llms.txt
---

# Get download URL for signed agreement in Workflow

Get the download URL for a signed agreement in a workflow.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Kompliant Web API",
    "description": "The Kompliant Web API provides a robust platform for integrating compliance services into your applications.\nOur APIs enable businesses to manage the entire compliance lifecycle - from application processing to ongoing\nmonitoring and decision defense.\n",
    "version": "2025-03-24",
    "contact": {
      "url": "https://www.kompliant.com/"
    },
    "license": {
      "name": "Proprietary - For Authorized Use Only",
      "url": "https://www.kompliant.com/terms-conditions"
    }
  },
  "x-readme": {
    "explorer-enabled": false,
    "proxy-enabled": false,
    "samples-languages": [
      "http",
      "shell",
      "go",
      "python",
      "node",
      "java"
    ],
    "headers": [
      {
        "key": "X-API-Version",
        "value": "2025-03-24"
      }
    ]
  },
  "servers": [
    {
      "url": "https://api.kompliant.com",
      "description": "Production server"
    }
  ],
  "security": [
    {
      "kompliantSignatureAuth": [],
      "kompliantApiKey": [],
      "kompliantAuthToken": []
    }
  ],
  "tags": [
    {
      "name": "Workflow",
      "description": "Operations for managing workflows that process data in a subject record"
    }
  ],
  "components": {
    "securitySchemes": {
      "kompliantSignatureAuth": {
        "type": "apiKey",
        "description": "Kompliant Signature Version 1 (KSig1) authentication - Authorization header.\nFormat: KSig1-HMAC-SHA256 <signature>\nPart of the KSig1 authentication that requires all three headers:\nAuthorization, X-API-Key, and X-API-Auth-Token.\n\nSee authentication documentation for details on the signature generation process.\n",
        "name": "Authorization",
        "in": "header"
      },
      "kompliantApiKey": {
        "type": "apiKey",
        "description": "Kompliant Signature Version 1 (KSig1) authentication - API Key header.\nYour Kompliant API Key provided during onboarding.\nRequired for all API requests.\n",
        "name": "X-API-Key",
        "in": "header"
      },
      "kompliantAuthToken": {
        "type": "apiKey",
        "description": "Kompliant Signature Version 1 (KSig1) authentication - Auth Token header.\nA valid authentication token obtained through the token endpoint.\nRequired for all authenticated API requests.\n",
        "name": "X-API-Auth-Token",
        "in": "header"
      }
    },
    "responses": {
      "Error401": {
        "description": "Unauthorized - Authentication errors or failures",
        "content": {
          "application/json": {
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/ErrorResponseTemplate"
                },
                {
                  "type": "object",
                  "properties": {
                    "errors": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/Error401"
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "Error403": {
        "description": "Forbidden - Authorization failures",
        "content": {
          "application/json": {
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/ErrorResponseTemplate"
                },
                {
                  "type": "object",
                  "properties": {
                    "errors": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/Error403"
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "Error4XX": {
        "description": "Other 400 level errors",
        "content": {
          "application/json": {
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/ErrorResponseTemplate"
                },
                {
                  "type": "object",
                  "properties": {
                    "errors": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/Error4XX"
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "Error5XX": {
        "description": "Server Error - Server-side issues",
        "content": {
          "application/json": {
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/ErrorResponseTemplate"
                },
                {
                  "type": "object",
                  "properties": {
                    "errors": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/Error5XX"
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "WorkflowAgreementGetDownloadErrorResponse": {
        "description": "Bad Request - Client request errors",
        "content": {
          "application/json": {
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/ErrorResponseTemplate"
                },
                {
                  "type": "object",
                  "properties": {
                    "errors": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "code": {
                            "type": "string",
                            "enum": [
                              "BAD_REQUEST",
                              "ENTITY_NOT_FOUND"
                            ]
                          }
                        }
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    },
    "schemas": {
      "MetaSuccessResponse": {
        "type": "object",
        "description": "Standard metadata included in all API responses",
        "required": [
          "status",
          "trace_id",
          "version"
        ],
        "properties": {
          "status": {
            "type": "string",
            "enum": [
              "SUCCESS"
            ],
            "description": "Status of the operation"
          },
          "trace_id": {
            "type": "string",
            "description": "Trace ID for debugging"
          },
          "version": {
            "type": "string",
            "description": "API version in YYYY-MM-DD format",
            "example": "2025-03-24"
          }
        }
      },
      "MetaErrorResponse": {
        "type": "object",
        "description": "Standard metadata included in all API responses",
        "required": [
          "status",
          "trace_id",
          "version"
        ],
        "properties": {
          "status": {
            "type": "string",
            "enum": [
              "ERROR"
            ],
            "description": "Status of the operation"
          },
          "trace_id": {
            "type": "string",
            "description": "Trace ID for debugging"
          },
          "version": {
            "type": "string",
            "description": "API version in YYYY-MM-DD format",
            "example": "2025-03-24"
          }
        }
      },
      "ErrorResponseTemplate": {
        "type": "object",
        "properties": {
          "meta": {
            "$ref": "#/components/schemas/MetaErrorResponse"
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ErrorItem"
            }
          }
        }
      },
      "ErrorItem": {
        "type": "object",
        "required": [
          "code",
          "message"
        ],
        "properties": {
          "code": {
            "type": "string",
            "description": "Error code"
          },
          "sub_code": {
            "type": "string",
            "nullable": true,
            "description": "Error sub-code providing additional context (e.g., WORKFLOW_ENDED)"
          },
          "entity_type": {
            "type": "string",
            "nullable": true,
            "description": "The type of entity related to the error (e.g., Business, RequiredDocument)"
          },
          "message": {
            "type": "string",
            "description": "Error message"
          },
          "details": {
            "type": "array",
            "description": "Array of validation error details (only present for BAD_REQUEST validation errors)",
            "items": {
              "$ref": "#/components/schemas/ValidationDetail"
            }
          }
        }
      },
      "ValidationDetail": {
        "type": "object",
        "required": [
          "path",
          "message"
        ],
        "description": "Detailed validation error information for a specific field",
        "properties": {
          "path": {
            "type": "string",
            "description": "The field path that failed validation (e.g., \"subject_record_id\", \"required_documents[0].document_type_code\")",
            "example": "subject_record_id"
          },
          "message": {
            "type": "string",
            "description": "Specific validation error message for this field",
            "example": "subject_record_id is required."
          }
        }
      },
      "Error401": {
        "type": "object",
        "description": "Standard error structure",
        "required": [
          "code",
          "message"
        ],
        "properties": {
          "code": {
            "type": "string",
            "description": "Error code",
            "enum": [
              "AUTH_INVALID_HEADER",
              "AUTH_INVALID_API_KEY",
              "AUTH_INVALID_AUTH_TOKEN",
              "AUTH_SIGNATURE_MISMATCH",
              "AUTH_MISSING_HEADER"
            ]
          },
          "message": {
            "type": "string",
            "description": "Error message"
          }
        }
      },
      "Error403": {
        "type": "object",
        "description": "Standard error structure",
        "required": [
          "code",
          "message"
        ],
        "properties": {
          "code": {
            "type": "string",
            "description": "Error code",
            "enum": [
              "UNAUTHORIZED"
            ]
          },
          "message": {
            "type": "string",
            "description": "Error message"
          }
        }
      },
      "Error4XX": {
        "type": "object",
        "description": "Standard error structure",
        "required": [
          "code",
          "message"
        ],
        "properties": {
          "code": {
            "type": "string",
            "description": "Error code",
            "enum": [
              "INVALID_ENDPOINT_REQUEST",
              "PAYLOAD_TOO_LARGE",
              "THROTTLED",
              "UNKNOWN_VERSION",
              "UNSUPPORTED_MEDIA_TYPE"
            ]
          },
          "message": {
            "type": "string",
            "description": "Error message"
          }
        }
      },
      "Error5XX": {
        "type": "object",
        "description": "Standard error structure",
        "required": [
          "code",
          "message"
        ],
        "properties": {
          "code": {
            "type": "string",
            "description": "Error code",
            "enum": [
              "GATEWAY_TIMEOUT",
              "INTERNAL_SERVER_ERROR",
              "SERVICE_UNAVAILABLE"
            ]
          },
          "message": {
            "type": "string",
            "description": "Error message"
          }
        }
      },
      "WorkflowAgreementGetDownloadRequest": {
        "type": "object",
        "required": [
          "agreement_id"
        ],
        "description": "Request to get download URL for a signed agreement",
        "properties": {
          "agreement_id": {
            "type": "string",
            "description": "ID of the agreement to get download URL for"
          }
        }
      },
      "WorkflowAgreementGetDownloadResponse": {
        "type": "object",
        "properties": {
          "meta": {
            "$ref": "#/components/schemas/MetaSuccessResponse"
          },
          "data": {
            "type": "object",
            "properties": {
              "agreement": {
                "type": "object",
                "description": "Signed agreement with download URL",
                "properties": {
                  "download_url": {
                    "type": "string",
                    "format": "uri",
                    "description": "Presigned URL to download the signed agreement PDF. This URL is temporary and will expire."
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "paths": {
    "/workflow.agreement.getDownload": {
      "post": {
        "summary": "Get download URL for signed agreement in Workflow",
        "description": "Get the download URL for a signed agreement in a workflow.\n",
        "operationId": "workflowAgreementGetDownload",
        "tags": [
          "Workflow"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/WorkflowAgreementGetDownloadRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WorkflowAgreementGetDownloadResponse"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/WorkflowAgreementGetDownloadErrorResponse"
          },
          "401": {
            "$ref": "#/components/responses/Error401"
          },
          "403": {
            "$ref": "#/components/responses/Error403"
          },
          "4XX": {
            "$ref": "#/components/responses/Error4XX"
          },
          "5XX": {
            "$ref": "#/components/responses/Error5XX"
          }
        }
      }
    }
  },
  "_id": {
    "buffer": {
      "0": 105,
      "1": 176,
      "2": 56,
      "3": 25,
      "4": 98,
      "5": 188,
      "6": 204,
      "7": 45,
      "8": 222,
      "9": 108,
      "10": 103,
      "11": 82
    }
  }
}
```