v3

OpenAPI 3.1.02026-07-311255771.3 MB
Unified HRIS API

Add document to employee

Uploads an document file for the specified employee.

<Note> This endpoint requires the permission **Manage documents** to be enabled in [your scope config](/scopes). </Note>

Example Request Body

{
  "category_id": "3Cjwu7nA7pH5cX5X1NAPmb7M",
  "document": {
    "name": "Frank Doe Employment Contract.txt",
    "data": "SGkgdGhlcmUsIEtvbWJvIGlzIGN1cnJlbnRseSBoaXJpbmcgZW5naW5lZXJzIHRoYXQgbG92ZSB0byB3b3JrIG9uIGRldmVsb3BlciBwcm9kdWN0cy4=",
    "content_type": "text/plain"
  }
}
post/hris/employees/{employee_id}/documents

Path parameters

employee_idstring required

POST /hris/employees/:employee_id/documents Parameter

Headers

X-Integration-Idstring required

ID of the integration you want to interact with.

Request body

category_idstring required

Response

POST /hris/employees/:employee_id/documents Positive response

status'success' required
dataobject required