Add a comment to a Fulfillment entity for documentation and review purposes.

POST http://api.kompliant.com/workflow.requiredDocument.fulfillment.addComment (OpenAPI specification)

Usage Info

This method allows you to add comments to fulfillments, providing a way to document review decisions, request clarifications, or communicate feedback about submitted documents. Comments are associated with specific fulfillments and include the commenter's information and timestamp for audit trail purposes.

Use this method when documenting review findings or acceptance criteria, requesting additional information or corrections from document submitters, providing feedback on rejected or accepted documents, creating an audit trail of review conversations and decisions, or communicating specific requirements or issues identified during document review. Each comment is permanently associated with the fulfillment and can be retrieved through the fulfillment details.

Request

Authentication: KSig1-HMAC-SHA256

Parameters

Parameter	Type	Required	Description
fulfillment_id	string	Yes	The identifier for the Fulfillment.
comment_text	string	Yes	The comment text to add to the fulfillment.

Examples

{
  "fulfillment_id": "f_1rQYvnUQdcatd4TcZQu0l8",
  "comment_text": "This document looks good and meets all requirements."
}

Response

Data

Parameter	Type	Description
comment_id	string	The unique identifier for the created comment.

Example

{
  "meta": {
    "status": "SUCCESS",
    "trace_id": "trc_6OI5blm21ZoSlq0PC3RqJV",
    "version": "2025-03-24"
  },
  "data": {
    "comment_id": "de_5Ns5pnChI2KdMrXLd9XNBQ"
  }
}

Errors

Error Code	HTTP Code	Possible Cause
BAD_REQUEST	400	Required parameters not provided. Invalid values provided.
ENTITY_NOT_FOUND	400	The `fulfillment_id` provided does not exit.
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	WORKFLOW_ENDED	The Workflow is in an ENDED state and cannot completed.