Files

Get a file by ID

Returns the details of an existing file. To bulk fetch multiple files by their IDs, use GET /files?id__in=<ID1>&id__in=<ID2>.

Both partner tokens and entity user tokens can be used for authentication.

get/files/{file_id}

Request

  • Base URL: https://api.sandbox.monite.com/v1
  • URL: https://api.sandbox.monite.com/v1/files/{file_id}
  • Auth: HTTP bearer

Path parameters

file_idstring required

Headers

x-monite-versionstring required

Response

Successful Response

idstring uuid required

A unique ID assigned to this file.

created_atstring date-time required

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

updated_atstring date-time required

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

file_typestring 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.
md5string required

The MD5 hash of the file.

mimetypestring required

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

namestring required

The original file name (if available).

regionstring required

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

s3_bucketstring required

Unused.

s3_file_pathstring required

Unused.

sizeinteger required

The file size in bytes.

urlstring required

The URL to download the file.

Changes

No recorded changes to this operation across all 1 revision of this API.