Skip to main content
GET
/
api
/
v2
/
cases
/
{id}
/
docs
List case documents
curl --request GET \
  --url https://api.example.com/api/v2/cases/{id}/docs
[
  {
    "id": "<string>",
    "fileName": "<string>",
    "dateUploaded": "2023-11-07T05:31:56Z",
    "url": "<string>",
    "mimeType": "<string>",
    "fileSizeBytes": 123,
    "createdAt": "2023-11-07T05:31:56Z"
  }
]

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