API reference OpenAPI 3.1
POST /documents/{id}:upload

Upload or replace a document file

Bearer API key or staff session multipart/form-data operation uploadDocument

Parameters

NameInTypeRequiredDescription
id path string Yes —

Request

Content type: multipart/form-data · required

FieldTypeRequiredDescription
file string (binary) Yes —
curl -X POST "$MONICHEK_API/documents/{id}:upload" \
  -H "Authorization: Bearer $MONICHEK_API_KEY" \
  -F "[email protected]"
const form = new FormData();
form.append("file", file); // File or Blob

const res = await fetch(`${MONICHEK_API}/documents/{id}:upload`, {
  method: "POST",
  headers: {
    Authorization: `Bearer ${MONICHEK_API_KEY}`,
  },
  body: form,
});

const data = await res.json();
import os
import requests

res = requests.post(
    f"{os.environ['MONICHEK_API']}/documents/{id}:upload",
    headers={"Authorization": f"Bearer {os.environ['MONICHEK_API_KEY']}"},
    files={"file": open("evidence.pdf", "rb")},
)
print(res.json())
$ch = curl_init(getenv('MONICHEK_API') . '/documents/{id}:upload');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('MONICHEK_API_KEY'),
    ],
    CURLOPT_POSTFIELDS => ["file" => new CURLFile("evidence.pdf")],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Replace {id} with the resource id.

Responses

200 OK document with file metadata application/json

No response example is published for this status.

Error responses

StatusMeaningBody
403 Forbidden RFC 9457 problem
404 Not Found RFC 9457 problem
413 Payload Too Large file over 20 MB
422 Unprocessable Entity RFC 9457 problem

Errors use the RFC 9457 problem format with a stable code.