v1

latestOpenAPI 3.1.02026-07-1274177461.2 KB
Employees
Documents

Download Employee Document

get/unified/hris/employees/{id}/documents/{subResourceId}/download

Path parameters

idstring required
subResourceIdstring required

Query parameters

formatstring nullable
Example:base64

The format to download the file in

export_formatstring nullable
Example:text/plain

The export format of the file

Headers

x-account-idstring required

The account identifier

Response

The document related to the employee with the given identifiers was retrieved.

datastring binary required

The file data in binary format

Example response

{
  "headers": {
    "content-disposition": "attachment; filename=\"example.pdf\"",
    "content-type": "application/pdf",
    "content-length": 1024,
    "content-range": "bytes 0-1023/2048",
    "content-encoding": "gzip",
    "transfer-encoding": "chunked"
  }
}