Documents
Create Hris Document
Registers an already-uploaded file as an employee HRIS document, logs activity, and optionally raises in-app notifications.
Not available to API keys yet. It will need documents:write.
curl --request POST \
--url 'https://api.toku.com/hris/create-hris-document' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"roleInOrgID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"fileKey": "string",
"documentName": "string",
"documentDescription": "string",
"documentCategory": "I9_LIST_A_DOCUMENT",
"visibleToEmployee": true,
"notifyEmployee": true,
"notifyClientAdmins": false
}'{
"documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}Authorizations
AuthorizationstringheaderrequiredBearer authentication header of the form Bearer <token>, where <token> is an access token from a Toku sign-in. See Authentication in the API reference.
Body
application/json
roleInOrgIDstring<uuid>requiredfileKeystringrequiredAllowed: at least 1 characters
documentNamestringrequiredAllowed: 1 to 255 characters
documentDescriptionstringAllowed: at most 1000 characters
documentCategorystringrequiredAvailable options: I9_LIST_A_DOCUMENT, I9_LIST_B_DOCUMENT, I9_LIST_C_DOCUMENT, W4_FEDERAL_TAX_FORM, STATE_TAX_FORM, EMPLOYMENT_AGREEMENT, HANDBOOK_ACKNOWLEDGMENT, VISA_DOCUMENT, ID_DOCUMENT, OTHER_ONBOARDING_DOCUMENT, COMPANY_DOCUMENTATION, PERSONAL_DOCUMENT, TAX_DOCUMENT, BENEFITS_DOCUMENT, PAYROLL_DOCUMENT, RESIGNATION_LETTER, PERFORMANCE_IMPROVEMENT_PLAN, TERMINATION_SUPPORTING_DOCUMENT
visibleToEmployeebooleanrequiredDefault: true
notifyEmployeebooleanrequiredDefault: true
notifyClientAdminsbooleanrequiredDefault: false
Response
200Successful response
documentIdstring<uuid>