Generate defense document for workflow.

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

Usage Info

Generes a defense document 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 generate defense document for.

Example

{
  "workflow_id": "w_7h1EpxerrZQyLnRC1EQ9Ck",
}

Response

Data

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

Defense Documents Parameters

Parameter	Type	Description
defense_document_id	string	The identifier for the Defense document just created.

Example

{
  "meta": {
    "status": "SUCCESS",
    "trace_id": "trc_6zNzQZHSf26V83BO3uW6dS",
    "version": "2025-03-24"
  },
  "data": {
    "defense_document": {
      "defense_document_id": "wdd_7h1EpxerrZQyLnRC1EQ9Ck"
    }
  }
}

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.