Skip to main content
POST
/
hris
/
employees
/
{employee_id}
/
documents
Add document to employee
curl --request POST \
  --url https://api.kombo.dev/v1/hris/employees/{employee_id}/documents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Integration-Id: <x-integration-id>' \
  --data '{
  "category_id": "3Cjwu7nA7pH5cX5X1NAPmb7M",
  "document": {
    "name": "Frank Doe Employment Contract.txt",
    "data": "SGkgdGhlcmUsIEtvbWJvIGlzIGN1cnJlbnRseSBoaXJpbmcgZW5naW5lZXJzIHRoYXQgbG92ZSB0byB3b3JrIG9uIGRldmVsb3BlciBwcm9kdWN0cy4=",
    "content_type": "text/plain"
  }
}'
{
  "status": "<string>",
  "data": {},
  "warnings": [
    {
      "message": "<string>"
    }
  ]
}
This feature is currently available for the following integrations:You’d like to see this feature for another integration? Please reach out! We’re always happy to discuss extending our coverage.
This endpoint requires the permission Manage documents to be enabled in your scope config.

​
Example Request Body

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

Authorizations

​
Authorization
string
header
required

Create an API key on the Secrets page in the Kombo dashboard.

Headers

​
X-Integration-Id
string
required

ID of the integration you want to interact with.

Path Parameters

​
employee_id
string
required

POST /hris/employees/:employee_id/documents Parameter

Body

application/json

POST /hris/employees/:employee_id/documents Request body

​
category_id
string
required
​
document
object
required

Response

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

​
status
string
required
Allowed value: "success"
​
data
object
required
​
warnings
object[]
required

These are the interaction warnings that are shown in the dashboard. They are meant to provide debug information to you. We recommend logging them to the console.

⌘I