Skip to content

Get File

GET/web/v1/files/query/{fileBizId}JWT + Turnstile

Retrieves the metadata of a single file by its business ID. This does not return the file content; use the download endpoints for that.

Authentication

Auth Chain: WEB Chain — requires Authorization: Bearer <jwt> and Turnstile token. These headers are injected by the system (frontend does nothing): X-PORTAL-ACCESS-CODE (Nginx), X-Request-Id (Gateway)

Request Parameters

NameTypeRequiredInDescription
fileBizIdstringYespathFile business ID

Success Response

Success200
{
  "version": "1.3.0",
  "timestamp": 1709337600000,
  "success": true,
  "code": "2000",
  "message": "SUCCESS",
  "data": {
    "bizId": "file_abc123",
    "bucket": "default",
    "objectKey": "uploads/2026/03/21/file_abc123.pdf",
    "originalFilename": "invoice.pdf",
    "fileSize": 102400,
    "contentType": "application/pdf",
    "fileCategory": "DOCUMENT",
    "fileStatus": "ACTIVE",
    "etag": "d41d8cd98f00b204e9800998ecf8427e",
    "remark": "Monthly invoice",
    "createdAt": "2026-03-21T00:00:00Z",
    "createdBy": "acc_user123"
  }
}

Error Responses

Unauthorized401
{
  "success": false,
  "code": "4010",
  "message": "Invalid or expired token"
}
Not Found404
{
  "success": false,
  "code": "4040",
  "message": "File not found"
}

Notes

Internal Documentation