Skip to main content
GET
/
files
List all files
curl --request GET \
  --url https://api.uk.veridox.ai/files \
  --header 'x-api-key: <api-key>'
{
  "files": [
    {
      "file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "case_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "case_label": "<string>",
      "label": "<string>",
      "mime_type": "<string>",
      "thumbnail_url": "<string>",
      "current_risk_score": "<string>",
      "analysis_status": "waiting_for_upload",
      "analysis_outcome": "success",
      "current_analysis_phase": "<string>",
      "uploaded_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123
}
Retrieve a paginated list of all files across all cases belonging to the authenticated user. This endpoint provides a comprehensive view of file metadata, analysis status, and risk scores.

​
Key Features

  • Pagination: Use limit and offset query parameters for large result sets.
  • Reverse Chronological: Files are returned newest first.
  • Unified View: See all user files regardless of which case they belong to.

​
Best Practices

  1. Batch Processing: Use a limit of 100 for batch background processing.
  2. UI Display: Use a limit of 20-50 for optimal UI performance and loading speed.
  3. Status Filtering: Check the analysis_status to determine which files have completed forensic review.

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
limit
integer
default:50

Maximum number of files to return

Required range: 1 <= x <= 100
​
offset
integer
default:0

Number of files to skip for pagination

Required range: 0 <= x <= 9007199254740991
​
sort_by
enum<string>
default:date_created

Field to sort by

Available options:
date_created,
risk_score
​
sort_order
enum<string>
default:desc

Sort order: asc (ascending) or desc (descending)

Available options:
asc,
desc

Response

File list retrieved successfully

​
files
object[]
required
​
total
number
required