Documents contain metadata describing files belonging to claims, contacts or companies.
Document
objects are metadata wrappers for files uploaded to their parent object. They must belong to a parent object, which can be either a Claim
, Contact
or Company
.
The Document
Object
Document
ObjectAttribute | Data Type | Description |
---|---|---|
id | Integer | The unique ID for the document given by Claimable. |
filename | String | Read Only The original filename of the uploaded file. |
folder | String | Read Only A key representing the folder the document belongs to. |
extension | String | Read Only The file extension based on the filename attribute. |
file_type | String | Read Only The MIME Type of the uploaded file. List of common MIME Types |
size | Integer | Read Only The size in bytes of the uploaded file. |
description | String | Read Only A user-defined description of the document. |
source | String | Read Only Indicates which interface was used to upload the file. Currently this will always be "web" to indicate the file was uploaded by a user via the web user interface. |
download_url | String | Read Only The URL to download the uploaded file. |
created_at | Timestamp | Read Only The date/time the document was created/uploaded. |
updated_at | Timestamp | Read Only The date/time the document was last updated. |
created_by | Integer | Read Only The id of the user who created the document. |
updated_by | Integer | Read Only The id of the user who last updated the document. |
Example Document Object
{
"id": 123456,
"filename": "Final Report.pdf",
"folder": "reports",
"extension": "pdf",
"file_type": "application/pdf",
"size": 753855,
"description": "Latest version of final report. Signed and approved.",
"source": "web",
"download_url": "https://...",
"created_at": "2021-12-01T09:22:19.394Z",
"updated_at": "2021-12-06T16:42:32.541Z",
"created_by": 123,
"updated_by": 456
}