Skip to main content
Get a link to upload a document

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Body

application/json
file_name
string
required
Required string length: 1 - 255
mime_type
string
required
Maximum string length: 255
Pattern: ^[a-z0-9!#$&^_.+-]+\/[a-z0-9!#$&^_.+-]+$
file_size
integer
required
Required range: 100 <= x <= 52428800
category
enum<string>
Available options:
invoice,
agreement,
other
md5_checksum
string

Base64 MD5 of the file. If you already uploaded a document with the same checksum, size and category, that document is returned instead.

Pattern: ^[A-Za-z0-9+/]{22}==$

Response

You already uploaded this file; no upload is needed.

existing
enum<boolean>
required
Available options:
false
document_id
string<uuid>
required
upload_url
string<uri>
required
headers
object
required
expires_at
string<date-time>
required