Retrieve a comprehensive list of all Workflow entities within a Subject Record.

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

Usage Info

This method returns all Workflow entities associated with a specific Subject Record, providing a complete view of workflows linked to the Subject Record. Each Workflow details are included respective to the workflow type.

Request

Authentication: KSig1-HMAC-SHA256

Parameters

Parameter	Type	Required	Description
subject_record_id	string	Yes	The identifier for the Subject Record from which to list all the Workflow objects.

Example

{
  "subject_record_id": "sr_57WfSCnafMnxDiWMKcy3EW"
}

Response

Data

Parameter	Type	Description
workflows	array	An array of workflow objects that contain information about Workflows within the Subject Record. If the Subject Record has no Workflow objects, the array will be empty.

Workflow Parameters

Parameter	Type	Description
workflow_id	string	The ID for the Workflow.
type	string	The type of Workflow. Must be one of WORKFLOW_TYPES.
subject_record_id	string	The Subject Record to associate with the Workflow. If the value is not supplied then a new Subject Record of the appropriate type is created.
state	string	The state of the Workflow. Must be one of WORKFLOW_STATES.
details	object	One of the Workflow Details object.
started_at	string	The date-time when the Worfkow was started. The value will be in ISO 8601 date and time format (YYYY-MM-DDTHH:mm:ss.SSSZ).
ended_at	string	The date-time when the Workflow was ended. The value will be in ISO 8601 date and time format (YYYY-MM-DDTHH:mm:ss.SSSZ).
created_at	string	The date-time when the Worfkow 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 Workflow was last updated. If there has been no update, the value will be the same as the created_at value. The value will be in ISO 8601 date and time format (YYYY-MM-DDTHH:mm:ss.SSSZ).

Example

{
  "meta": {
    "status": "SUCCESS",
    "trace_id": "trc_6OI5blm21ZoSlq0PC3RqJV",
    "version": "2025-03-24"
  },
  "data": {
    "workflows": [
      {
        "workflow_id": "w_2dJFFW3HY8a3zOjqwUXhQc",
        "type": "BUSINESS_APPLICATION",
        "subject_record_id": "sr_163Gh1ONk6BCHF9iYVDHcv",
        "state": "STARTED",
        "details": {
          "business_application_details": {
            "applying_user": {
              "email": "[email protected]"
            },
            "referrer_value": "UAYACG123"
          }
        },
        "started_at": "2025-01-18T07:29:18.472Z",
        "ended_at": "2025-01-18T07:29:18.472Z",
        "created_at": "2025-01-18T07:29:18.472Z",
        "updated_at": "2025-01-18T07:29:18.472Z"
      }
    ]
  }
}

Errors

Error Code	HTTP Code	Description
BAD_REQUEST	400	Required parameters not provided.
ENTITY_NOT_FOUND	400	The `subject_record_id`provided does not exist.