Onboarding
Validate Onboarding
Validates every onboarding step against config and reports readiness and incomplete blocking steps.
GEThttps://api.toku.com/hris/validate-onboarding
Not available to API keys.
curl --request GET \
--url 'https://api.toku.com/hris/validate-onboarding' \
--header 'Authorization: Bearer <token>'200 response
{
"ready": true,
"incompleteBlockingSteps": [
"string"
],
"stepValidation": [
{
"stepId": "string",
"label": "string",
"status": "COMPLETED",
"isBlocking": true,
"errors": {}
}
]
}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>Response
200Successful response
readybooleanrequiredincompleteBlockingStepsstring[]requiredstepValidationobject[]requiredShow child attributes
stepIdstringrequiredlabelstringrequiredstatusstringrequiredAvailable options: COMPLETED, SKIPPED, NOT_STARTED, IN_PROGRESS
isBlockingbooleanrequirederrorsobjectrequired400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits