Retrieve a list of all events for Required Documents within a Workflow.

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

Usage Info

This method returns a comprehensive event log of all activities related to required documents within a specific workflow. The system tracks changes to fulfillments, document status updates, and other document-related actions, and this method provides a complete audit trail of workflow document processing. Each event includes detailed metadata about what changed, who made the change, and when it occurred.

The optional fulfillment_id filter allows you to retrieve events specific to a single fulfillment, making it easy to track the complete lifecycle of a particular document submission.

Use this method when auditing document review activities and decisions, tracking the complete history of a fulfillment from submission to acceptance or rejection, monitoring workflow progress through document-related events, debugging document processing issues by reviewing event sequences, or generating reports on document processing timelines and reviewer activities.

Request

Authentication: KSig1-HMAC-SHA256

Parameters

Parameter	Type	Required	Description
workflow_id	string	Yes	The identifier for the Workflow.
filters	object	No	Optional filters to apply to the events list. See filters below.

Filters Parameters

Parameter	Type	Required	Description
fulfillment_id	string	No	The identifier for the Fulfillment used to filter events.

Examples

Example 1: List All Workflow Events

{
  "workflow_id": "w_1rQYvnUQdcatd4TcZQu0l8"
}

Example 2: Filter Events by Fulfillment

{
  "workflow_id": "w_1rQYvnUQdcatd4TcZQu0l8",
  "filters": {
    "fulfillment_id": "f_3bOToGJOGlIBSq6KjNUVo8"
  }
}

Response

Data

Parameter	Type	Description
events	array	An array of event objects that contain information about required document activities within the workflow. The array will be empty if the workflow has no events or if applied filters match no results.

Event Parameters

Property	Type	Description
event_id	string	The unique identifier for the event.
workflow_id	string	The workflow identifier associated with the event.
subject_record_id	string	The subject record identifier associated with the event.
event_name	string	The name of the event. Must be one of the DOCUMENT_EVENT_NAMES.
created_by	object	Information about who created the event. The created by parameters are defined below.
metadata	array	Event-specific metadata containing details about what changed. Structure varies by event type.
event_timestamp	string	ISO 8601 timestamp when the event occurred.
created_at	string	ISO 8601 timestamp when the event record was created.
updated_at	string	ISO 8601 timestamp when the event record was last updated.

Created By Parameters

Property	Type	Description
user_id	string	The unique identifier for the user in the system or SYSTEM to indicate the system.
type	string	Indicates the type of entity that created the event. USER indicates a person initiated the event. SYSTEM indicates the event was generated by system activity. Must be one of SYSTEM or USER.

Example

{
  "meta": {
    "status": "SUCCESS",
    "trace_id": "trc_6OI5blm21ZoSlq0PC3RqJV",
    "version": "2025-03-24"
  },
  "data": {
    "events": [
      {
        "event_id": "de_44NxVNmSMKAg4cvWgp362Q",
        "version": "v1",
        "workflow_id": "w_1rQYvnUQdcatd4TcZQu0l8",
        "subject_record_id": "sr_7KmNpQrStUvWxYz123456",
        "event_name": "FULFILLMENT_STATUS_CHANGED",
        "created_by": {
          "user_id": "user_123456789",
          "type": "USER"
        },
        "metadata": [
          {
            "fulfillment_id": "f_3bOToGJOGlIBSq6KjNUVo8",
            "old_fulfillment_status": "NEEDS_REVIEW",
            "new_fulfillment_status": "ACCEPTED"
          }
        ],
        "event_timestamp": "2025-01-01T12:00:00Z",
        "created_at": "2025-01-01T12:00:00Z",
        "updated_at": "2025-01-01T12:00:00Z"
      }
    ]
  }
}

Errors

Error Code	HTTP Code	Possible Cause
BAD_REQUEST	400	Required parameters not provided.
ENTITY_NOT_FOUND	400	The `workflow_id` or optional `fulfillment_id` provided does not exist.