Onboarding
Get Onboarding Documents
Resolves which document templates apply to a worker's onboarding and their signing status.
GEThttps://api.toku.com/hris/get-onboarding-documents
Required scope: people:read
curl --request GET \
--url 'https://api.toku.com/hris/get-onboarding-documents?roleInOrgId=%3CroleInOrgId%3E' \
--header 'Authorization: Bearer <token>'200 response
[
{
"templateId": "string",
"templateName": "string",
"category": "string",
"countryCode": "string",
"isRequired": true,
"signingStatus": "NOT_STARTED",
"pendingCountersignature": true,
"finalizing": true,
"envelopeId": "string",
"employeeCompletedAt": "string",
"countersignerCompletedAt": "string",
"templateVersionId": "string",
"scopeId": "string",
"templateInstanceId": "string",
"templateKey": "string",
"versionNumber": 0,
"sourceType": "GOOGLE_DOC",
"signingProfileKey": "EMPLOYEE_ONLY",
"satisfiedOutsideToku": true,
"cancelledByAdmin": true,
"openCopyElsewhere": true
}
]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.
Query parameters
roleInOrgIdstring<uuid>requiredusStateCodeOverridestringNOTE(ck): a .transform() rule is not mirrored here; TGA still enforces it
Allowed: matches ^[A-Za-z]{2}$
Response
200Successful response
templateIdstringrequiredtemplateNamestringrequiredcategorystringrequiredcountryCodestring | nullrequiredisRequiredbooleanrequiredsigningStatusstringrequiredAvailable options: NOT_STARTED, IN_PROGRESS, COMPLETED
pendingCountersignaturebooleanrequiredfinalizingbooleanrequiredenvelopeIdstring | nullrequiredemployeeCompletedAtstring | nullrequiredcountersignerCompletedAtstring | nullrequiredtemplateVersionIdstringscopeIdstringtemplateInstanceIdstring | nulltemplateKeystringversionNumbernumbersourceTypestringAvailable options: GOOGLE_DOC, DOCUSIGN_TEMPLATE
signingProfileKeystringrequiredAvailable options: EMPLOYEE_ONLY, EMPLOYEE_AND_COUNTERSIGNER, COUNTERSIGNER_ONLY, NO_SIGNATURE, CLIENT_AND_COUNTERSIGNERS
satisfiedOutsideTokubooleanrequiredcancelledByAdminbooleanrequiredopenCopyElsewherebooleanrequired400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits