Upload a file

Uploads a file as base64 and optionally links it to users or organisations

POST/api/v1/{app_id}/files/upload

API: Auth
OpenAPI: auth-api
Updated: Apr 26, 2026

auth-api:POST:/api/v1/{app_id}/files/upload

Uploads a file as base64 and optionally links it to users or organisations

API ownership

API family: Auth API
Best for: Customer identity, session, token, cart, and wishlist flows.
Do not use from: Merchant admin data syncs or public catalog rendering.
Guide route: /apis/auth/latest

The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.

Operation

Method: POST
Path: /api/v1/\{app_id\}/files/upload
Summary: Upload a file
Description: Uploads a file as base64 and optionally links it to users or organisations
OpenAPI contract: auth-api
Operation ID: Not documented in the OpenAPI contract.

Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.

Parameters1 parameter

Name	In	Required	Type	Description
app_id	path	Yes	string	UUID of the app

Request bodyDocumented body

Required: Yes
Description: File upload data
Content: application/json (object)

Upload File Request

Property	Type	Required	Details
`base64_encoded_image`	string	Yes	-
`custom_fields`	object	No	-
`filename`	string	No	-
`order_reference`	string	No	-
`organisation_number`	string	No	-
`relationship_ids`	string[]	No	-

Generated example (synthetic):

{
  "base64_encoded_image": "string",
  "custom_fields": {},
  "filename": "string",
  "order_reference": "string",
  "organisation_number": "string",
  "relationship_ids": [
    "string"
  ]
}

Responses3 statuses

Status	Description	Content
201	Created	application/json (object)
400	Invalid request	application/json (object)
500	Internal server error	application/json (object)

201 - object

File

Property	Type	Required	Details
`app_id`	string	No	-
`content_type`	string	No	-
`created_at`	string	No	-
`custom_fields`	object	No	-
`filename`	string	No	-
`id`	string	No	-
`updated_at`	string	No	-
`url`	string	No	-

Generated example (synthetic):

{
  "app_id": "string",
  "content_type": "string",
  "created_at": "string",
  "custom_fields": {},
  "filename": "string",
  "id": "string",
  "updated_at": "string",
  "url": "string"
}

400 - object

Error Message

Property	Type	Required	Details
`details`	string[]	No	-
`message`	string	No	-
`success`	boolean	No	-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

500 - object

Error Message

Property	Type	Required	Details
`details`	string[]	No	-
`message`	string	No	-
`success`	boolean	No	-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

Contract identity

Use these fields to confirm you are implementing the intended endpoint contract.

API family: Auth API
Method: POST
Path: /api/v1/\{app_id\}/files/upload
Operation ID: Not documented in the OpenAPI contract.
OpenAPI tag: Files
OpenAPI summary: Upload a file