Get a list of the defense documents for a specific workflow.

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

Usage Info

Retrieve a list of all generated documents for specific workflow_id.

This method is only supported for Workflows of type BUSINESS_UNDERWRITING.

Request

Parameters

Parameter	Type	Required	Description
workflow_id	string	Yes	The unique identifier of the Workflow to retrieve defense documents for.

Example

{
  "workflow_id": "w_7h1EpxerrZQyLnRC1EQ9Ck",
}

Response

Data

Parameter	Type	Description
defense_documents	array of objects	The defense document parameter defined in the table below.

Defense Document Parameters

Parameter	Type	Description
defense_document_id	string	The identifier for the Defense document just created.
status	string	The progress status of the defense document generation. Must be one of DEFENSE_DOCUMENT_STATUSES .
created_at	string	The date-time when the defense document was created. The value will be in ISO 8601 date and time format (YYYY-MM-DDTHH:mm:ss.SSSZ).
updated_at	string	The date-time when the defense document was last updated. The value will be in ISO 8601 date and time format (YYYY-MM-DDTHH:mm:ss.SSSZ).

Example

{
  "meta": {
    "status": "SUCCESS",
    "trace_id": "trc_6zNzQZHSf26V83BO3uW6dS",
    "version": "2025-03-24"
  },
  "data": {
    "defense_documents": [
      {
        "defense_document_id": "43b7816d-62af-4820-9e0d-ca95201bb8dd",
        "status": "COMPLETED",
        "created_at": "2025-11-13T22:37:02.703Z",
        "updated_at": "2025-11-13T22:40:57.995Z"
      }
    ]
  }
}

Errors

Error Code	HTTP Code	Possible Cause
BAD_REQUEST	400	Required parameters not provided. Invalid values provided.
ENTITY_NOT_FOUND	400	The `workflow_id` provided does not exist.
SYSTEM_RULE_VIOLATION	400	System rule violations are described below

System Rule Violations

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

Entity Type	Sub-code	Description
Workflow	INVALID_WORKFLOW_TYPE	The method is not supported for the current Workflow type. Currently only `BUSINESS_UNDERWRITING` is supported.