Get the download url for a defense document.

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

Usage Info

Retrieve a the download url of a specific generated document.

This method is only supported for Workflows of type BUSINESS_UNDERWRITING.

Request

Parameters

Parameter	Type	Required	Description
defense_document_id	string	Yes	The unique identifier of the Defense Document to request download url for

Example

{
  "defense_document_id": "wdd_7h1EpxerrZQyLnRC1EQ9Ck",
}

Response

Data

Parameter	Type	Description
defense_document	object	The defense document parameter defined in the table below.

Defense Document Parameters

Parameter	Type	Description
download_url	string	The presigned url of the defense document.

Example

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

Errors

Error Code	HTTP Code	Possible Cause
BAD_REQUEST	400	Required parameters not provided. Invalid values provided.
ENTITY_NOT_FOUND	400	The `defense_document_id` provided does not exist.
SYSTEM_EXCEPTION	400	System exceptions are described below

System Exceptions

When a System Exceptions error occurs, the response will include additional entity_type and sub_code fields to provide more specific information:

Entity Type	Sub-code	Description
DefenseDocument	DEFENSE_DOCUMENT_FAILED	The generation for defense document failed and is not possible to generate an url for download.
DefenseDocument	DEFENSE_DOCUMENT_IN_PROGRESS	The defense document is not ready for download yet.