Skip to main content
GET
List case documents

Path Parameters

id
string
required

Case ID

Query Parameters

category
enum<string>

Filter documents by category

Available options:
General,
ClientInformation,
OfficialDocuments,
ProtocolAndEnquiryForms,
ProtocolFormsEvidence,
EnquiryFormsEvidence,
AdditionalDocuments

Response

List of case documents

id
string

Document ID

category
enum<string>

Document category

Available options:
General,
ClientInformation,
OfficialDocuments,
ProtocolAndEnquiryForms,
ProtocolFormsEvidence,
EnquiryFormsEvidence,
AdditionalDocuments
fileName
string

Document title/filename

status
enum<string>

Document status

Available options:
Uploaded,
addLater,
notAvailable,
HMLRPending,
YOTIPending,
SearchBureauPending,
OneSearchPending
dateUploaded
string<date-time> | null

Date and time when document was uploaded

url
string | null

Upload URL (if uploaded)

mimeType
string | null

MIME type of the document

fileSizeBytes
number | null

File size in bytes

createdAt
string<date-time>

Document creation timestamp