Retrieve a comprehensive list of all Required Document entities within a Workflow.

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

Usage Info

This method returns a list of all Required Document records associated with a specific workflow, providing a complete view of Document Types needed for workflow completion. Each Required Document includes its document type, category, requirement text, and status. Optional filtering by status allows you to retrieve specific subsets of documents.

Use this method to display document collection progress to users, check workflow completion requirements, filter documents by their current state, and get Fulfillment information to retrieve the Documents associated to each RequiredDocument.

Request

Authentication: KSig1-HMAC-SHA256

Parameters

Parameter	Type	Required	Description
workflow_id	string	Yes	The identifier for the Workflow from which to list all the Required Document objects.
filters	object	No	Optional filters to apply to the required documents list. See filters parameters below.

Filters Parameters

Parameter	Type	Required	Description
required_document_status	string	No	Filter by status. Must be one of the REQUIRED_DOCUMENT_STATUSES.

Example

{
  "workflow_id": "w_LKQpQvG7r6BWXBzrvFvI5",
  "filters": {
    "required_document_status": "NEEDS_REVIEW"
  }
}

Response

Data

Parameter	Type	Description
required_documents	array	An array of Required Document objects that contain information about documents required for the Workflow. If the Workflow has no Required Document objects, the array will be empty.

Object Parameters

Parameter	Type	Description
required_document_id	string	The unique identifier for the Required Document.
document_type_code	string	The code identifying the type of document. Must be one of the DOCUMENT_TYPE_CODES.
name	string	The display name for the Required Document type.
category	string	The category of the Required Document. Must be one of the REQUIRED_DOCUMENT_CATEGORIES.
requirement_text	string	The specific requirement or instruction text for this document.
required_document_status	string	The current status of the Required Document. Must be one of the REQUIRED_DOCUMENT_STATUSES.
created_at	string	The timestamp when the Required Document was created (ISO 8601 format).
updated_at	string	The timestamp when the Required Document was last updated (ISO 8601 format).

Example

{
  "meta": {
    "status": "SUCCESS",
    "trace_id": "trc_6OI5blm21ZoSlq0PC3RqJV",
    "version": "2025-03-24"
  },
  "data": {
    "required_documents": [
      {
        "required_document_id": "rd_123456789",
        "document_type_code": "PASSPORT",
        "name": "Passport Document",
        "category": "REQUIREMENT",
        "requirement_text": "Valid passport required",
        "required_document_status": "NEEDS_REVIEW",
        "created_at": "2025-01-01T00:00:00Z",
        "updated_at": "2025-01-01T00:00:00Z"
      },
      {
        "required_document_id": "rd_987654321",
        "document_type_code": "ADDITIONAL",
        "name": "ADDITIONAL",
        "category": "ADDITIONAL",
        "requirement_text": "Additional documents requested by underwriter",
        "required_document_status": "NEEDS_REVIEW",
        "created_at": "2025-01-02T00:00:00Z",
        "updated_at": "2025-01-02T00:00:00Z"
      }
    ]
  }
}

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.