> This page is for API, version 2026-01-01 (Stable) (default).
> For other versions, use one of these documentation indexes:
> - 2026-01-01 (Stable) (default): https://developer.deel.com/api/stable/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developer.deel.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer.deel.com/_mcp/server.

# Create a file upload

POST https://api.letsdeel.com/rest/files
Content-Type: application/json

Register an upload and receive presigned S3 upload target(s) plus a file handle (file_id and one_time_secret). Use the returned upload target(s) to send the file directly, then pass the file handle to domain endpoints to claim ownership once the upload completes.

 **Token scopes**: `files:write`, `worker:write`

Reference: https://developer.deel.com/api/reference/endpoints/files/register-file-upload-v-2026-08-05

## Authentication

- `Authorization` header (bearer token, required) — ## Authentication The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail. ```curl curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` [Learn more about authentication](/api/authentication)
- `Authorization` header (bearer token, required) — Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

## Servers

- `https://api.letsdeel.com/rest` (Production, default)
- `https://api-staging.letsdeel.com/rest` (Demo)

## Request

### Headers

- `x-upload-method` (enum, optional) — Declares the client is multipart-capable. The server returns a multipart response only when the declared size exceeds the configured multipart threshold (`MULTIPART_THRESHOLD`); otherwise the standard POST form.
  - Allowed values: `multipart`

### Body (application/json)

This endpoint expects an object.

- `data` (FilesPostRequestBodyContentApplicationJsonSchemaData, required)

## Response

### 201

Upload registered successfully with presigned S3 upload target(s)

- `data` (FilesPostResponsesContentApplicationJsonSchemaData, required)

## Errors

### 400 Bad Request Error

Invalid input parameters

- `any`

### 401 Unauthorized Error

Operation failed.

- `request` (ApiErrorRequest, optional)
- `errors` (list of ApiError, optional)

### 403 Forbidden Error

Operation failed.

- `request` (ApiErrorRequest, optional)
- `errors` (list of ApiError, optional)

### 404 Not Found Error

Operation failed.

- `request` (ApiErrorRequest, optional)
- `errors` (list of ApiError, optional)

### 500 Internal Server Error

Operation failed.

- `request` (ApiErrorRequest, optional)
- `errors` (list of ApiError, optional)

## Types

### FilesPostRequestBodyContentApplicationJsonSchemaData

- `filename` (string, required) — Original filename with extension; used to detect the content type.
- `size` (double, optional) — Actual file size in bytes (max 1GB). Drives the server-side multipart decision when x-upload-method: multipart is set.
- `expiry` (double, optional) — Presigned URL expiry in seconds.
- `is_attachment` (boolean, optional) — Whether the file should be served as an attachment (download) rather than inline.

### FilesPostResponsesContentApplicationJsonSchemaData

- `file_id` (string, required) — Unique file identifier.
- `upload_parts` (list of FilesPostResponsesContentApplicationJsonSchemaDataUploadPartsItems, required) — Presigned upload targets (always present). Single-part: one presigned POST form with fields. Multipart: multiple presigned PUT URLs without fields.
- `one_time_secret` (string, required) — One-time secret for claiming ownership. Pass to domain endpoints when ready to claim the file.
- `upload_id` (string, optional) — S3 multipart upload ID. Present only when the server selected multipart — pass to POST /rest/files/\{fileid}/complete.

### ApiErrorRequest

- `method` (string, optional) — The HTTP method of the failed request
- `url` (string, optional) — The relative URL of the failed request
- `status` (double, optional) — The status code of the response
- `api_req_id` (string, optional) — The request ID of the failed request
- `docs` (string, optional) — A link to the official documentation for the requested endpoint resource
- `source` (string, optional) — The source handler which produced the returned error
- `code` (double, optional) — The code of the source handler which produced the returned error

### ApiError

- `message` (string, optional) — A description of the returned error
- `path` (string, optional) — The JSON path where input validation failed

### FilesPostResponsesContentApplicationJsonSchemaDataUploadPartsItems

- `url` (string, optional) — Presigned upload URL for this part.
- `size` (double, optional) — Maximum bytes for this part.
- `fields` (FilesPostResponsesContentApplicationJsonSchemaDataUploadPartsItemsFields, optional) — Form fields to submit with the presigned POST form. Present for the single-part POST upload; absent for multipart PUT parts.
- `number` (double, optional) — Part number (1-indexed).

### FilesPostResponsesContentApplicationJsonSchemaDataUploadPartsItemsFields

Form fields to submit with the presigned POST form. Present for the single-part POST upload; absent for multipart PUT parts.

## Examples

**Request**

```json
{
  "data": {
    "filename": "contract.pdf"
  }
}
```

**Response**

```json
{
  "data": {
    "file_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "upload_parts": [
      {
        "url": "https://file-service-bucket.s3.amazonaws.com/",
        "size": 10485760,
        "fields": {
          "Content-Type": "application/pdf",
          "key": "uploads/uuid/contract.pdf"
        },
        "number": 1
      }
    ],
    "one_time_secret": "abc123def456ghi789jkl012mno345pqr678stu901vwx234yz",
    "upload_id": "VXBsb2FkIElEIGZvciBteS1tb3ZpZS5tMnRzIHVwbG9hZA"
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.letsdeel.com/rest/files"

payload = { "data": { "filename": "contract.pdf" } }
headers = {
    "x-upload-method": "multipart",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.letsdeel.com/rest/files';
const options = {
  method: 'POST',
  headers: {
    'x-upload-method': 'multipart',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: '{"data":{"filename":"contract.pdf"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.letsdeel.com/rest/files"

	payload := strings.NewReader("{\n  \"data\": {\n    \"filename\": \"contract.pdf\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-upload-method", "multipart")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.letsdeel.com/rest/files")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-upload-method"] = 'multipart'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"data\": {\n    \"filename\": \"contract.pdf\"\n  }\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.letsdeel.com/rest/files")
  .header("x-upload-method", "multipart")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"data\": {\n    \"filename\": \"contract.pdf\"\n  }\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.letsdeel.com/rest/files', [
  'body' => '{
  "data": {
    "filename": "contract.pdf"
  }
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
    'x-upload-method' => 'multipart',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.letsdeel.com/rest/files");
var request = new RestRequest(Method.POST);
request.AddHeader("x-upload-method", "multipart");
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"data\": {\n    \"filename\": \"contract.pdf\"\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "x-upload-method": "multipart",
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["data": ["filename": "contract.pdf"]] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.letsdeel.com/rest/files")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```