Working with Files

The Files API allows employers to upload important documents (such as company values, policies, or any other company-related document) to an employee’s profile and later download those documents.

Upload File

Uploads a document to an employee’s profile. The request needs the employee’s ID and the path to file to be uploaded. On success, the API returns a unique file ID which can later be used to download the file.

{
  "data": {
    "file": {
      "id": "9880b711-file-id-ecf8f551bd78",
      "inserted_at": "2025-01-02T17:19:21",
      "name": "id.pdf",
      "sub_type": "personal_id",
      "type": "id"
    }
  }
}

ℹ️ The maximum size limit of a file that can be uploaded is 20 MB. You can upload .png, .jpg, .jpeg, .pdf, .doc, .docx, .xls, .xlsx, .rtf, .asice, .sce, .asics and .scs files as long as they don't exceed the size limit.

Download File

This endpoint downloads a previously uploaded file using its unique file ID. This file ID is the id returned as a response of a successful upload file API call.

{
  "data": {
    "file": {
      "content": "data:application/pdf;base64,iVBORw0KGgoAAAANSUhEUgAAAJUAAACVCAYAAABRorhPAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWF...",
      "id": "9880b711-file-id-ecf8f551bd78",
      "inserted_at": "2025-01-02T17:19:21",
      "name": "id.pdf",
      "sub_type": "personal_id",
      "type": "id"
    }
  }
}