Retrieve a list of all Fulfillment entities for a specific Required Document.

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

Usage Info

This method returns a list of all Fulfillment records associated with a specific Required Document, providing a complete view of documents that have been submitted to satisfy a document requirement. Each fulfillment includes the document identifier, decision status, reviewer information, and timestamps. Optional filtering by decision status and document upload status allows you to retrieve specific subsets of fulfillments.

The verbose parameter enables detailed document information including file name, size, and upload details.

Use this method when displaying which documents have been submitted for a requirement, checking the review status of submitted documents, filtering fulfillments by acceptance status or upload completion state, or retrieving comprehensive document metadata for display or processing purposes.

Request

Authentication: KSig1-HMAC-SHA256

Parameters

Parameter	Type	Required	Description
required_document_id	string	Yes	The identifier for the Required Document.
filters	object	No	Optional filters to apply to the list of fulfillments. See filters parameters below.
verbose	boolean	No	Include detailed document information in the response. Defaults to `false` if not provided.

Filters Parameters

Parameter	Type	Required	Description
decision_status	string	No	Filter by decision status. Must be one of the FULFILLMENT_DECISION_STATUSES.
document_upload_status	string	No	Filter by document upload status. Must be one of the DOCUMENT_UPLOAD_STATUSES.

Examples

Example 1: Basic Request Without Filters

{
  "required_document_id": "rd_1rQYvnUQdcatd4TcZQu0l8"
}

Example 2: Filtering by Decision Status

{
  "required_document_id": "rd_1rQYvnUQdcatd4TcZQu0l8",
  "filters": {
    "decision_status": "ACCEPTED"
  }
}

Example 3: Multiple Filters with Verbose Details

{
  "required_document_id": "rd_1rQYvnUQdcatd4TcZQu0l8",
  "filters": {
    "decision_status": "ACCEPTED",
    "document_upload_status": "COMPLETED"
  },
  "verbose": true
}

Response

Data

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

Object Parameters

Parameter	Type	Description
fulfillment_id	string	The unique identifier for the Fulfillment.
document_id	string	The identifier for the Document.
required_document_id	string	The identifier for the Required Document.
document	object	Detailed document information (only included when `verbose=true`). Will be `null` if verbose is not enabled. See document parameters below.
decision_status	string	The current decision status of the fulfillment. Must be one of the FULFILLMENT_DECISION_STATUSES.
decisioned_by	string	The identifier of the user who made the decision. Will be `null` if no decision has been made yet.
decisioned_at	string	The timestamp when the decision was made (ISO 8601 format). Will be `null` if no decision has been made yet.
created_at	string	The timestamp when the fulfillment was created (ISO 8601 format).
updated_at	string	The timestamp when the fulfillment was last updated (ISO 8601 format).
deleted_at	string	The timestamp when the fulfillment was deleted (ISO 8601 format). Will be `null` if not deleted.

Document Parameters (when verbose=true)

Parameter	Type	Description
document_id	string	The unique identifier for the Document.
file_name	string	The name of the uploaded file.
file_size_in_bytes	integer	The file size in bytes.
uploaded_by	string	The identifier of the user who uploaded the document.
deleted_at	string	The timestamp when the document was deleted (ISO 8601 format). Will be `null` if not deleted.

Examples

Example 1: Basic Response Without Verbose Details

{
  "meta": {
    "status": "SUCCESS",
    "trace_id": "trc_6OI5blm21ZoSlq0PC3RqJV",
    "version": "2025-03-24"
  },
  "data": {
    "fulfillments": [
      {
        "fulfillment_id": "f_1rQYvnUQdcatd4TcZQu0l8",
        "document_id": "d_1rQYvnUQdcatd4TcZQu0l8",
        "required_document_id": "rd_1rQYvnUQdcatd4TcZQu0l8",
        "decision_status": "ACCEPTED",
        "decisioned_by": "user_456",
        "decisioned_at": "2025-01-01T12:00:00Z",
        "created_at": "2025-01-01T00:00:00Z",
        "updated_at": "2025-01-01T12:00:00Z",
        "deleted_at": null
      }
    ]
  }
}

Example 2: Response With Verbose Document Details

{
  "meta": {
    "status": "SUCCESS",
    "trace_id": "trc_6OI5blm21ZoSlq0PC3RqJV",
    "version": "2025-03-24"
  },
  "data": {
    "fulfillments": [
      {
        "fulfillment_id": "f_1rQYvnUQdcatd4TcZQu0l8",
        "document_id": "d_1rQYvnUQdcatd4TcZQu0l8",
        "required_document_id": "rd_1rQYvnUQdcatd4TcZQu0l8",
        "document": {
          "document_id": "d_1rQYvnUQdcatd4TcZQu0l8",
          "file_name": "passport.pdf",
          "file_size_in_bytes": 1048576,
          "uploaded_by": "user_123",
          "deleted_at": null
        },
        "decision_status": "ACCEPTED",
        "decisioned_by": "user_456",
        "decisioned_at": "2025-01-01T12:00:00Z",
        "created_at": "2025-01-01T00:00:00Z",
        "updated_at": "2025-01-01T12:00:00Z",
        "deleted_at": null
      }
    ]
  }
}

Errors

Error Code	HTTP Code	Possible Cause
BAD_REQUEST	400	Required parameters not provided. Invalid values provided.
ENTITY_NOT_FOUND	400	The `required_document_id` provided does not exist.