Upload a file
Upload files for use as:
* supplementary attachments for invoices, quotes, and credit notes,
* [entity verification documents](https://docs.monite.com/payments/onboarding/via-api/documents) for payments onboarding.
Maximum file size is 15 MB. Each uploaded file is assigned a unique `id` that you can use to reference this file elsewhere.
Both partner tokens and entity user tokens can be used for authentication.
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>
, where token is your auth token.
Headers
x-monite-version
Request
This endpoint expects a multipart form containing a file.
file
The file to upload.
file_type
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.
Response
Successful Response
id
A unique ID assigned to this file.
created_at
Date and time when this file was uploaded to or created in Monite. Timestamps follow the ISO 8601 format.
updated_at
Date and time when this file was last updated in Monite. Timestamps follow the ISO 8601 format.
file_type
Possible values:
* `additional_identity_documents` and `identity_documents` - [entity verification documents](https://docs.monite.com/payments/onboarding/via-api/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
The MD5 hash of the file.
mimetype
The file’s media type, for example, application/pdf
or image/png
.
name
The original file name (if available).
region
Geographical region of the data center where the file is stored.
s3_bucket
Unused.
s3_file_path
Unused.
size
The file size in bytes.
url
The URL to download the file.