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

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

Usage Info

This method returns a list of all Document records associated with a specific Subject Record, providing a complete view of uploaded documents and their metadata. Each document includes its file information, such as name and size as well as upload status and timestamps.

Use this method to display document collection progress to users, track uploaded files for a subject record, verify document upload status, and retrieve document metadata for further processing or validation. When no documents are found for a valid subject_record_id, the endpoint returns a successful response with an empty documents array rather than an error.

Request

Authentication: KSig1-HMAC-SHA256

Parameters

Parameter	Type	Required	Description
subject_record_id	string	Yes	The identifier for the Subject Record with `sr_` prefix format.

Example

{
  "subject_record_id": "sr_6G6k9XmRMEgrPz8126tg3m"
}

Response

Data

Parameter	Type	Description
documents	array	An array of Document objects that contain information about documents uploaded for the Subject Record. If the Subject Record has no Document objects, the array will be empty.

Object Parameters

Parameter	Type	Description
document_id	string	The unique identifier for the Document.
subject_record_id	string	The identifier for the Subject Record.
file_name	string	The name of the uploaded file.
file_size	integer	The file size in bytes.
upload_status	string	The current upload status of the document.
comment	string	Optional comment associated with the document. Will be `null` if no comment was provided.
created_at	string	The timestamp when the document was created (ISO 8601 format).
updated_at	string	The timestamp when the document was last updated (ISO 8601 format).
deleted_at	string	The timestamp when the document was deleted (ISO 8601 format). Will be `null` if not deleted.

Example

{
  "meta": {
    "status": "SUCCESS",
    "trace_id": "trc_6OI5blm21ZoSlq0PC3RqJV",
    "version": "2025-03-24"
  },
  "data": {
    "documents": [
      {
        "document_id": "d_1rQYvnUQdcatd4TcZQu0l8",
        "subject_record_id": "sr_6G6k9XmRMEgrPz8126tg3m",
        "file_name": "passport.pdf",
        "file_size": 1048576,
        "upload_status": "COMPLETED",
        "comment": null,
        "created_at": "2025-01-01T00:00:00Z",
        "updated_at": "2025-01-01T00: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 `subject_record_id`provided does not exist.