workflow.agreement.getDownload

Get a download URL of the signed agreement.

POST http://api.kompliant.com/workflow.agreement.getDownload (OpenAPI specification)

Usage Info

Retrieve a download URL of a signed agreement with given agreement_id.

Request

Parameters

Parameter	Type	Required	Description
agreement_id	string	Yes	The unique identifier of the Agreement to retrieve download URL for.

Example

{
  "agreement_id": "agr_7h1EpxerrZQyLnRC1EQ9Ck",
}

Response

Data

Parameter	Type	Description
agreement	object	The agreement parameter defined in the table below.

Agreement Parameters

Parameter	Type	Description
download_url	string	The presigned URL to download the signed agreement PDF. This URL is temporary and will expire.

Example

{
  "meta": {
    "status": "SUCCESS",
    "trace_id": "trc_6zNzQZHSf26V83BO3uW6dS",
    "version": "2025-03-24"
  },
  "data": {
    "agreement": {
      "download_url": "https://mockurl.com"
    }
  }
}

Errors

Error Code	HTTP Code	Possible Cause
BAD_REQUEST	400	Required parameters not provided. Invalid values provided.
ENTITY_NOT_FOUND	400	The `agreement_id` provided does not exist.

Updated 5 months ago