File

A file for a case.

Operations

Every route this entity exposes. Each route links to its own reference on this page.

Examples

One example per SDK, generated from the API model. The argument names are the parameters and fields of this entity, and the values are placeholders. The examples are not compiled or executed.

Golang

Construct client as shown in the Golang setup, then call the operations:

files, err := client.File(nil).List(nil, nil)
if err != nil {
    panic(err)
}
fmt.Println(files)
created, err := client.File(nil).Create(map[string]any{"createdAt": "example", "file": "example", "fileId": "example", "fileName": "example", "profileId": 1, "purpose": "example", "submissionData": map[string]any{}}, nil)
if err != nil {
    panic(err)
}
fmt.Println(created)

Lua

Construct client as shown in the Lua setup, then call the operations:

local files, err = client:File():list()
local created, err = client:File():create({ createdAt = "example", file = "example", fileId = "example", fileName = "example", profileId = 1, purpose = "example", submissionData = {} })

PHP

Construct client as shown in the PHP setup, then call the operations:

$files = $client->File()->list();
$created = $client->File()->create(["createdAt" => "example", "file" => "example", "fileId" => "example", "fileName" => "example", "profileId" => 1, "purpose" => "example", "submissionData" => []]);

Python

Construct client as shown in the Python setup, then call the operations:

files = client.File().list()
created = client.File().create({ "createdAt": "example", "file": "example", "fileId": "example", "fileName": "example", "profileId": 1, "purpose": "example", "submissionData": {} })

Ruby

Construct client as shown in the Ruby setup, then call the operations:

files = client.File.list()
created = client.File.create({ "createdAt" => "example", "file" => "example", "fileId" => "example", "fileName" => "example", "profileId" => 1, "purpose" => "example", "submissionData" => {} })

TypeScript

Construct client as shown in the TypeScript setup, then call the operations:

const files = await client.File().list()
const created = await client.File().create({ createdAt: "example", file: "example", fileId: "example", fileName: "example", profileId: 1, purpose: "example", submissionData: {} })

Fields

create

POST /cases/files

Operation ID: caseFileUpload.

Authentication: bearer token (ClientCredentialsToken).

Parameters

Request body

multipart/form-data

Responses

201: File uploaded successfully

application/json

400: Bad request - validation failed

application/json

The response is object and object.

401: Unauthorized - missing or invalid authentication

application/json

The response is object and object.

Example response:

{
  "detail": "Authentication required",
  "status": 401,
  "title": "Unauthorized",
  "type": "/errors/types/access"
}

403: Forbidden - insufficient permissions

application/json

The response is object and object.

Example response:

{
  "code": "forbidden",
  "detail": "Unauthorized",
  "status": 403,
  "title": "Forbidden",
  "type": "/errors/types/access"
}

429: Too many requests - rate limit exceeded

application/json

The response is object and object.

Example response:

{
  "code": "rate_limit_exceeded",
  "detail": "Too many files uploaded recently. Please try again later.",
  "instance": "/cases/files",
  "status": 429,
  "title": "Too Many Requests",
  "type": "/errors/types/domain"
}

500: Internal server error

application/json

Example response:

{
  "detail": "An unexpected error occurred. Please try again later.",
  "instance": "/cases/files",
  "status": 500,
  "title": "Internal Server Error",
  "type": "/errors/types/internal"
}

list

GET /cases/files

Operation ID: caseFileList.

Authentication: bearer token (ClientCredentialsToken).

Parameters

Responses

200: Paginated list of files

application/json

Example response:

{
  "files": [
    {
      "createdAt": "2026-09-30T10:00:00.123",
      "fileId": "a1b2c3d4-e5f6-4789-abcd-ef1234567890",
      "fileName": "company-registration.pdf",
      "profileId": 14556049,
      "purpose": "GENERAL"
    },
    {
      "createdAt": "2026-09-29T10:00:00.123",
      "fileId": "b2c3d4e5-f6a7-4890-bcde-f12345678901",
      "fileName": "identity-document.png",
      "profileId": 14556049,
      "purpose": "GENERAL"
    }
  ],
  "totalFiles": 5
}

400: Bad request - validation failed

application/json

The response is object and object.

401: Unauthorized - missing or invalid authentication

application/json

The response is object and object.

Example response:

{
  "detail": "Authentication required",
  "status": 401,
  "title": "Unauthorized",
  "type": "/errors/types/access"
}

403: Forbidden - insufficient permissions

application/json

The response is object and object.

Example response:

{
  "code": "forbidden",
  "detail": "Unauthorized",
  "status": 403,
  "title": "Forbidden",
  "type": "/errors/types/access"
}

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

500: Internal server error

application/json

Example response:

{
  "detail": "An unexpected error occurred. Please try again later.",
  "instance": "/cases/files",
  "status": 500,
  "title": "Internal Server Error",
  "type": "/errors/types/internal"
}