API · Platform · Files
Upload a file.
Uploads bytes to Matter. Unlike every other Matter endpoint, this one accepts multipart/form-data (not JSON) — file uploads are the single exception to the JSON-only request-body rule.
The purpose field governs validation, retention, and which resources may reference the file. An uploaded file is never served back as bytes via GET /v1/files/{id}; use a FileLink to issue a signed URL for human consumption.
Last updated
Request Body
multipart/form-data
TypeScript Definitions
Use the request body type in TypeScript.
filestring<binary>RequiredpurposestringRequired"kyc_document""cap_table_import""board_attachment""dd_document""resolution_attachment""logo"metadataobjectOptionalFlat string-to-string map. Up to 50 keys. Keys: max 40 chars, charset
[A-Za-z0-9_\\-.]. Values: max 500 chars. Keys prefixed matter_ are reserved
for platform use. Metadata is retrievable but not filterable via query params.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
Request
curl -X POST "https://api.mattermode.com/v1/files" \ -F file="string" \ -F purpose="kyc_document"const body = new FormData();body.set(file, "string")body.set(purpose, "kyc_document")fetch("https://api.mattermode.com/v1/files", { method: "POST", headers: { "Content-Type": "multipart/form-data" }, body})package mainimport ( "fmt" "net/http" "io/ioutil" "mime/multipart" "bytes")func main() { url := "https://api.mattermode.com/v1/files" body := new(bytes.Buffer) mp := multipart.NewWriter(payload) mp.WriteField("file", `string`) mp.WriteField("purpose", `kyc_document`) req, _ := http.NewRequest("POST", url, body) req.Header.Add("Content-Type", "multipart/form-data") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body))}import requestsheaders = { "Authorization": "Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc", "Matter-Version": "2026-06-10", "Idempotency-Key": "ee7c3a9b-3f1a-4d8e-9b2a-7c5e1f0a2d4b",}resp = requests.post( "https://api.mattermode.com/v1/files", headers=headers,)resp.raise_for_status()print(resp.json())import java.net.URI;import java.net.http.HttpClient;import java.net.http.HttpRequest;import java.net.http.HttpResponse;import java.net.http.HttpResponse.BodyHandlers;import java.time.Duration;import java.net.http.HttpRequest.BodyPublishers;var body = BodyPublishers.ofByteArray(new byte[] { ... });HttpClient client = HttpClient.newBuilder() .connectTimeout(Duration.ofSeconds(10)) .build();HttpRequest.Builder requestBuilder = HttpRequest.newBuilder() .uri(URI.create("https://api.mattermode.com/v1/files")) .header("Content-Type", "multipart/form-data") .POST(body) .build();try { HttpResponse<String> response = client.send(requestBuilder.build(), BodyHandlers.ofString()); System.out.println("Status code: " + response.statusCode()); System.out.println("Response body: " + response.body());} catch (Exception e) { e.printStackTrace();}using System;using System.Net.Http;using System.Text;var body = new MultipartFormDataContent();var client = new HttpClient();var response = await client.PostAsync("https://api.mattermode.com/v1/files", body);var responseBody = await response.Content.ReadAsStringAsync();curl --request POST 'https://api.mattermode.com/v1/files' \ --header 'Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc' \ --header 'Matter-Version: 2026-06-10' \ --header 'Idempotency-Key: ee7c3a9b-3f1a-4d8e-9b2a-7c5e1f0a2d4b'const response = await fetch("https://api.mattermode.com/v1/files", { method: "POST", headers: { "Authorization": "Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc", "Matter-Version": "2026-06-10", "Idempotency-Key": "ee7c3a9b-3f1a-4d8e-9b2a-7c5e1f0a2d4b", },});if (!response.ok) { throw new Error(`Matter API ${response.status}: ${await response.text()}`);}const data = await response.json();console.log(data);Response
application/json{
"id": "string",
"object": "file",
"purpose": "kyc_document",
"size": 0,
"type": "application/pdf",
"filename": "string",
"sha256": "string",
"linked_resources": [
{
"id": "stk_abcd1234"
}
],
"expires_at": 1745539200,
"metadata": {},
"created": 1745539200,
"livemode": false
}{
"type": "https://mattermode.com/docs/errors/invalid_request",
"title": "Invalid request",
"status": 400,
"code": "invalid_request",
"detail": "Request body could not be parsed as JSON.",
"doc_url": "https://mattermode.com/docs/guides/errors#invalid_request",
"request_id": "req_Qw9xYz8A"
}{
"type": "https://mattermode.com/docs/errors/authentication_required",
"title": "Authentication required",
"status": 401,
"code": "authentication_required",
"detail": "No bearer token was supplied. Pass `Authorization: Bearer sk_live_...` on every request.",
"doc_url": "https://mattermode.com/docs/guides/errors#authentication_required",
"request_id": "req_Qw9xYz8A"
}{
"type": "https://mattermode.com/docs/errors/invalid_state_transition",
"title": "Invalid state transition",
"status": 409,
"detail": "Entity ent_Nq3KcAbc is in state `dissolved` and cannot be dissolved again.",
"instance": "/requests/req_Qw9xYz8A",
"code": "invalid_state_transition",
"param": "founders[0].equity",
"doc_url": "https://mattermode.com/docs/guides/errors#invalid_state_transition",
"request_id": "req_Qw9xYz8A",
"retry_after": 30,
"authorized_by": {
"human_principal_id": "usr_4Kj2m8pQ",
"agent_id": "agt_Nq3KcAbc"
}
}{
"type": "https://mattermode.com/docs/errors/invalid_state_transition",
"title": "Invalid state transition",
"status": 409,
"detail": "Entity ent_Nq3KcAbc is in state `dissolved` and cannot be dissolved again.",
"instance": "/requests/req_Qw9xYz8A",
"code": "invalid_state_transition",
"param": "founders[0].equity",
"doc_url": "https://mattermode.com/docs/guides/errors#invalid_state_transition",
"request_id": "req_Qw9xYz8A",
"retry_after": 30,
"authorized_by": {
"human_principal_id": "usr_4Kj2m8pQ",
"agent_id": "agt_Nq3KcAbc"
}
}{
"type": "https://mattermode.com/docs/errors/validation_failed",
"title": "Validation failed",
"status": 422,
"code": "validation_failed",
"detail": "One or more fields failed validation. See `errors[]`.",
"doc_url": "https://mattermode.com/docs/guides/errors#validation_failed",
"request_id": "req_Qw9xYz8A",
"errors": [
{
"field": "founders[0].equity",
"code": "out_of_range",
"message": "Equity must sum to 100% across all founders."
}
]
}