---
agentTools:
  projectIndex: https://developer.kompliant.com/llms.txt
---

# Retrieve a list of all Document Request entities for a specified workflow.

Retrieves all document request records for a workflow, showing which documents have been requested, requester details, comments, and timestamps. Optionally filter to show only unfulfilled requests. Use to track outstanding and fulfilled document requests for auditing or workflow management.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Kompliant Web API",
    "description": "The Kompliant Web API provides a robust platform for integrating compliance services into your applications.\nOur APIs enable businesses to manage the entire compliance lifecycle - from application processing to ongoing\nmonitoring and decision defense.\n",
    "version": "2025-03-24",
    "contact": {
      "url": "https://www.kompliant.com/"
    },
    "license": {
      "name": "Proprietary - For Authorized Use Only",
      "url": "https://www.kompliant.com/terms-conditions"
    }
  },
  "x-readme": {
    "explorer-enabled": false,
    "proxy-enabled": false,
    "samples-languages": [
      "http",
      "shell",
      "go",
      "python",
      "node",
      "java"
    ],
    "headers": [
      {
        "key": "X-API-Version",
        "value": "2025-03-24"
      }
    ]
  },
  "servers": [
    {
      "url": "https://api.kompliant.com",
      "description": "Production server"
    }
  ],
  "security": [
    {
      "kompliantSignatureAuth": [],
      "kompliantApiKey": [],
      "kompliantAuthToken": []
    }
  ],
  "tags": [
    {
      "name": "Workflow",
      "description": "Operations for managing workflows that process data in a subject record"
    }
  ],
  "components": {
    "securitySchemes": {
      "kompliantSignatureAuth": {
        "type": "apiKey",
        "description": "Kompliant Signature Version 1 (KSig1) authentication - Authorization header.\nFormat: KSig1-HMAC-SHA256 <signature>\nPart of the KSig1 authentication that requires all three headers:\nAuthorization, X-API-Key, and X-API-Auth-Token.\n\nSee authentication documentation for details on the signature generation process.\n",
        "name": "Authorization",
        "in": "header"
      },
      "kompliantApiKey": {
        "type": "apiKey",
        "description": "Kompliant Signature Version 1 (KSig1) authentication - API Key header.\nYour Kompliant API Key provided during onboarding.\nRequired for all API requests.\n",
        "name": "X-API-Key",
        "in": "header"
      },
      "kompliantAuthToken": {
        "type": "apiKey",
        "description": "Kompliant Signature Version 1 (KSig1) authentication - Auth Token header.\nA valid authentication token obtained through the token endpoint.\nRequired for all authenticated API requests.\n",
        "name": "X-API-Auth-Token",
        "in": "header"
      }
    },
    "responses": {
      "Error401": {
        "description": "Unauthorized - Authentication errors or failures",
        "content": {
          "application/json": {
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/ErrorResponseTemplate"
                },
                {
                  "type": "object",
                  "properties": {
                    "errors": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/Error401"
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "Error403": {
        "description": "Forbidden - Authorization failures",
        "content": {
          "application/json": {
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/ErrorResponseTemplate"
                },
                {
                  "type": "object",
                  "properties": {
                    "errors": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/Error403"
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "Error4XX": {
        "description": "Other 400 level errors",
        "content": {
          "application/json": {
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/ErrorResponseTemplate"
                },
                {
                  "type": "object",
                  "properties": {
                    "errors": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/Error4XX"
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "Error5XX": {
        "description": "Server Error - Server-side issues",
        "content": {
          "application/json": {
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/ErrorResponseTemplate"
                },
                {
                  "type": "object",
                  "properties": {
                    "errors": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/Error5XX"
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "WorkflowRequiredDocumentDocumentRequestListErrorResponse": {
        "description": "Bad Request - Client request errors or validation failures for workflow events list",
        "content": {
          "application/json": {
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/ErrorResponseTemplate"
                },
                {
                  "type": "object",
                  "properties": {
                    "errors": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "code": {
                            "type": "string",
                            "enum": [
                              "BAD_REQUEST",
                              "SYSTEM_RULE_VIOLATION"
                            ]
                          }
                        }
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    },
    "schemas": {
      "MetaSuccessResponse": {
        "type": "object",
        "description": "Standard metadata included in all API responses",
        "required": [
          "status",
          "trace_id",
          "version"
        ],
        "properties": {
          "status": {
            "type": "string",
            "enum": [
              "SUCCESS"
            ],
            "description": "Status of the operation"
          },
          "trace_id": {
            "type": "string",
            "description": "Trace ID for debugging"
          },
          "version": {
            "type": "string",
            "description": "API version in YYYY-MM-DD format",
            "example": "2025-03-24"
          }
        }
      },
      "MetaErrorResponse": {
        "type": "object",
        "description": "Standard metadata included in all API responses",
        "required": [
          "status",
          "trace_id",
          "version"
        ],
        "properties": {
          "status": {
            "type": "string",
            "enum": [
              "ERROR"
            ],
            "description": "Status of the operation"
          },
          "trace_id": {
            "type": "string",
            "description": "Trace ID for debugging"
          },
          "version": {
            "type": "string",
            "description": "API version in YYYY-MM-DD format",
            "example": "2025-03-24"
          }
        }
      },
      "ErrorResponseTemplate": {
        "type": "object",
        "properties": {
          "meta": {
            "$ref": "#/components/schemas/MetaErrorResponse"
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ErrorItem"
            }
          }
        }
      },
      "ErrorItem": {
        "type": "object",
        "required": [
          "code",
          "message"
        ],
        "properties": {
          "code": {
            "type": "string",
            "description": "Error code"
          },
          "sub_code": {
            "type": "string",
            "nullable": true,
            "description": "Error sub-code providing additional context (e.g., WORKFLOW_ENDED)"
          },
          "entity_type": {
            "type": "string",
            "nullable": true,
            "description": "The type of entity related to the error (e.g., Business, RequiredDocument)"
          },
          "message": {
            "type": "string",
            "description": "Error message"
          },
          "details": {
            "type": "array",
            "description": "Array of validation error details (only present for BAD_REQUEST validation errors)",
            "items": {
              "$ref": "#/components/schemas/ValidationDetail"
            }
          }
        }
      },
      "ValidationDetail": {
        "type": "object",
        "required": [
          "path",
          "message"
        ],
        "description": "Detailed validation error information for a specific field",
        "properties": {
          "path": {
            "type": "string",
            "description": "The field path that failed validation (e.g., \"subject_record_id\", \"required_documents[0].document_type_code\")",
            "example": "subject_record_id"
          },
          "message": {
            "type": "string",
            "description": "Specific validation error message for this field",
            "example": "subject_record_id is required."
          }
        }
      },
      "Error401": {
        "type": "object",
        "description": "Standard error structure",
        "required": [
          "code",
          "message"
        ],
        "properties": {
          "code": {
            "type": "string",
            "description": "Error code",
            "enum": [
              "AUTH_INVALID_HEADER",
              "AUTH_INVALID_API_KEY",
              "AUTH_INVALID_AUTH_TOKEN",
              "AUTH_SIGNATURE_MISMATCH",
              "AUTH_MISSING_HEADER"
            ]
          },
          "message": {
            "type": "string",
            "description": "Error message"
          }
        }
      },
      "Error403": {
        "type": "object",
        "description": "Standard error structure",
        "required": [
          "code",
          "message"
        ],
        "properties": {
          "code": {
            "type": "string",
            "description": "Error code",
            "enum": [
              "UNAUTHORIZED"
            ]
          },
          "message": {
            "type": "string",
            "description": "Error message"
          }
        }
      },
      "Error4XX": {
        "type": "object",
        "description": "Standard error structure",
        "required": [
          "code",
          "message"
        ],
        "properties": {
          "code": {
            "type": "string",
            "description": "Error code",
            "enum": [
              "INVALID_ENDPOINT_REQUEST",
              "PAYLOAD_TOO_LARGE",
              "THROTTLED",
              "UNKNOWN_VERSION",
              "UNSUPPORTED_MEDIA_TYPE"
            ]
          },
          "message": {
            "type": "string",
            "description": "Error message"
          }
        }
      },
      "Error5XX": {
        "type": "object",
        "description": "Standard error structure",
        "required": [
          "code",
          "message"
        ],
        "properties": {
          "code": {
            "type": "string",
            "description": "Error code",
            "enum": [
              "GATEWAY_TIMEOUT",
              "INTERNAL_SERVER_ERROR",
              "SERVICE_UNAVAILABLE"
            ]
          },
          "message": {
            "type": "string",
            "description": "Error message"
          }
        }
      },
      "WorkflowRequiredDocumentListRequestDocumentRequest": {
        "type": "object",
        "required": [
          "workflow_id"
        ],
        "description": "Retrieve a list of all Document Request entities for a specified workflow.",
        "properties": {
          "workflow_id": {
            "type": "string",
            "description": "The identifier for the workflow starting with w_ prefix."
          },
          "filters": {
            "type": "object",
            "description": "Optional filters to apply for the results.",
            "properties": {
              "active": {
                "type": "boolean",
                "description": "Filter by document request's fulfilled_at parameter."
              }
            }
          }
        }
      },
      "WorkflowRequiredDocumentListRequestDocumentResponse": {
        "type": "object",
        "properties": {
          "meta": {
            "$ref": "#/components/schemas/MetaSuccessResponse"
          },
          "data": {
            "type": "object",
            "properties": {
              "document_requests": {
                "type": "array",
                "description": "An array of Document Request objects that contain information on all the Document Request submitted for the Workflow. If the Workflow has no Document Request objects, the array will be empty.",
                "items": {
                  "type": "object",
                  "properties": {
                    "required_document_id": {
                      "type": "string",
                      "description": "The unique identifier for Required Document Id."
                    },
                    "document_request_id": {
                      "type": "string",
                      "description": "The unique identifier for Document Request Id."
                    },
                    "document_requested_by": {
                      "type": "object",
                      "description": "Detailed information on the user who made the request.",
                      "properties": {
                        "type": {
                          "type": "string",
                          "description": "The role of the user who made the request."
                        },
                        "email": {
                          "type": "string",
                          "description": "The email of the user who made the request."
                        },
                        "name": {
                          "type": "string",
                          "description": "The name of the user who made the request."
                        }
                      }
                    },
                    "comment": {
                      "type": "string",
                      "description": "The comment provided by the document requester. Will be null if no comment has been made yet."
                    },
                    "requested_at": {
                      "type": "string",
                      "format": "date-time",
                      "description": "The timestamp when the request was made (ISO 8601 format)."
                    },
                    "fulfilled_at": {
                      "type": "string",
                      "format": "date-time",
                      "description": "The timestamp when the request was fulfilled. (ISO 8601 format). Will be null if no decision has been made yet."
                    },
                    "created_at": {
                      "type": "string",
                      "format": "date-time",
                      "description": "The timestamp when the request was created (ISO 8601 format)"
                    },
                    "updated_at": {
                      "type": "string",
                      "format": "date-time",
                      "description": "The timestamp when the request was updated (ISO 8601 format)"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "paths": {
    "/workflow.requiredDocument.listRequestDocument": {
      "post": {
        "summary": "Retrieve a list of all Document Request entities for a specified workflow.",
        "description": "Retrieves all document request records for a workflow, showing which documents have been requested, requester details, comments, and timestamps. Optionally filter to show only unfulfilled requests. Use to track outstanding and fulfilled document requests for auditing or workflow management.\n",
        "operationId": "workflowRequiredDocumentListRequestDocument",
        "tags": [
          "Workflow"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/WorkflowRequiredDocumentListRequestDocumentRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WorkflowRequiredDocumentListRequestDocumentResponse"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/WorkflowRequiredDocumentDocumentRequestListErrorResponse"
          },
          "401": {
            "$ref": "#/components/responses/Error401"
          },
          "403": {
            "$ref": "#/components/responses/Error403"
          },
          "4XX": {
            "$ref": "#/components/responses/Error4XX"
          },
          "5XX": {
            "$ref": "#/components/responses/Error5XX"
          }
        }
      }
    }
  },
  "_id": {
    "buffer": {
      "0": 105,
      "1": 176,
      "2": 56,
      "3": 25,
      "4": 98,
      "5": 188,
      "6": 204,
      "7": 45,
      "8": 222,
      "9": 108,
      "10": 103,
      "11": 82
    }
  }
}
```