Skip to main content

Get File Information

POST /api/v1/file_info

This API allows the authenticated user to retrieve metadata for a file they have previously uploaded. It requires the file ID to be shared through the request body.

Headers​

NameTypeRequired
x-api-keystringYes
x-api-secretstringYes

Request Body​

Schema​

fileIdstringrequiredThe ID of an uploaded file.

Sample Request​

{
  "fileId": "string"
}

Responses​

Webhook Events​

Schema​

_idstringInternal document identifier.
companystringCurrent company name.
uploadedUserstringID of the user who uploaded the file.
originalNamestringOriginal filename as uploaded.
mimeTypestringMIME type of the file.
sizenumberFile size in bytes.
pathstringServer path of the uploaded file.
md5HashstringMD5 hash of the file contents.
createdAtstringTimestamp when the record was created.
updatedAtstringTimestamp when the record was last updated.
filenamestringFilename on the server.

Sample Response​

{
  "_id": "string",
  "company": "string",
  "uploadedUser": "string",
  "originalName": "string",
  "mimeType": "string",
  "size": 0,
  "path": "string",
  "md5Hash": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "filename": "string"
}
POST/api/v1/file_info
x-api-key
x-api-secret