---
title: "Upload A File"
method: POST
path: "/v1/files/upload"
tags: ["File Service"]
---

# Upload A File

`POST /v1/files/upload`

Upload a file to UQPAY. The maximum size of the upload file is up to `20MB`. Supported file types include `jpeg`, `png`, `jpg`, `doc`, `docx`, `pdf`. When you upload a file, the API responds with a file_id. This file ID can then be referenced as required as part of the attachments object in our other endpoints.

## Query parameters

- `notes` string

## Headers

- `x-on-behalf-of` string
- `x-idempotency-key` string, uuid

## Response `200`

OK - Successfully uploaded a file.

- UploadFileResponse
  - `create_time` string, required — Timestamp when the file was uploaded.
  - `file_id` string, required — Unique identifier for the uploaded file. Use this ID to reference the file in other API calls.
  - `file_name` string, required — Original name of the uploaded file including extension.
  - `file_type` string, required — File extension type (e.g., `png`, `pdf`, `docx`).
  - `size` integer, required — File size in bytes.
  - `notes` string, required — Optional notes associated with the file.

---

[API](https://skmtc.dev/uqpay/apis/authentication-api.md) · [All operations](https://skmtc.dev/uqpay/apis/authentication-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/uqpay/authentication-api/revisions/cef532a10777/schema)