Skip to main content
POST
/
files
Upload a file
curl --request POST \
  --url https://api.sandbox.monite.com/v1/files \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-monite-version: <x-monite-version>' \
  --form file='@example-file' \
  --form file_type=ocr_results
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "file_type": "<string>",
  "md5": "<string>",
  "mimetype": "<string>",
  "name": "<string>",
  "region": "<string>",
  "s3_bucket": "<string>",
  "s3_file_path": "<string>",
  "size": 123,
  "url": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-monite-version
string<date>
required

Body

multipart/form-data
​
file
file
required

The file to upload.

​
file_type
enum<string>
required

The intended purpose of the file. Possible values:

  • attachments - supplemental attachments for accounts receivable invoices, quotes, and credit notes.
  • identity_documents - company registration documents or a person's identity documents for payments onboarding.
  • additional_identity_documents - documents that verify a person's address.

Other enum values are not supposed to be used directly.

Available options:
ocr_results,
ocr_files,
payables,
receivables,
delivery_notes,
receipts,
userpics,
entity_logo,
companies_logo,
zip,
identity_documents,
additional_identity_documents,
receivable_signatures,
einvoices_xml,
attachments

Response

Successful Response

​
id
string<uuid>
required

A unique ID assigned to this file.

​
created_at
string<date-time>
required

Date and time when this file was uploaded to or created in Monite. Timestamps follow the ISO 8601 format.

​
updated_at
string<date-time>
required

Date and time when this file was last updated in Monite. Timestamps follow the ISO 8601 format.

​
file_type
string
required

Possible values:

  • additional_identity_documents and identity_documents - entity verification documents uploaded for payments onboarding.
  • attachments - supplementary attachments for accounts receivable invoices, quotes, and credit notes.
  • delivery_notes - auto-generated PDF versions of delivery notes.
  • einvoices_xml - e-invoice XML generated when sending e-invoices.
  • payables - payables (bills) received via email or uploaded via API.
  • receivable_signatures - images of customer signatures provided during quote acceptance.
  • receivables - auto-generated PDF versions of invoices, quotes, and credit notes.
  • zip - data export archives created by POST /data_exports.
​
md5
string
required

The MD5 hash of the file.

Example:

"60997cbcc1a6fb2ec37d389ffa8588db"

​
mimetype
string
required

The file's media type, for example, application/pdf or image/png.

Example:

"application/pdf"

​
name
string
required

The original file name (if available).

Example:

"timesheet.pdf"

​
region
string
required

Geographical region of the data center where the file is stored.

Example:

"eu-central-1"

​
s3_bucket
string
required

Unused.

​
s3_file_path
string
required

Unused.

​
size
integer
required

The file size in bytes.

Example:

120101

​
url
string
required

The URL to download the file.

Example:

"https://bucketname.s3.amazonaws.com/path/to/timesheet.pdf"