Onboarding
Get Onboarding Config
Resolves the onboarding step configuration for a worker's country and employment type.
Required scope: people:read. With an API key, roleInOrgId must be set: a key has no person of its own.
curl --request GET \
--url 'https://api.toku.com/hris/get-onboarding-config' \
--header 'Authorization: Bearer <token>'{
"countryCode": "string",
"countryName": "string",
"steps": [
{
"stepId": "string",
"label": "string",
"description": "string",
"order": 0,
"fields": [
{
"fieldId": "string",
"label": "string",
"type": "text",
"required": true,
"excludeFromPayrollOnly": true,
"placeholder": "string",
"helpText": "string",
"options": [
{
"value": "string",
"label": "string"
}
],
"conditionalOn": {
"fieldId": "string",
"values": [
"string"
]
},
"retainWhenHidden": true,
"encrypted": true,
"masked": true,
"validationMessage": "string",
"validationPattern": "string",
"maxFileSizeBytes": 0,
"acceptedFileTypes": [
"string"
],
"legacyUploadFieldIds": [
"string"
],
"documentCategory": "string",
"width": "full",
"externalLinks": [
{
"label": "string",
"url": "string"
}
],
"persistence": {},
"citizenAnswer": {
"countryCode": "string",
"values": [
"string"
]
}
}
],
"isBlocking": true,
"isSkippable": true,
"category": "consent",
"icon": "string"
}
],
"isContractor": 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>Response
200Successful response
countryCodestringrequiredcountryNamestringrequiredstepsobject[]requiredShow child attributes
stepIdstringrequiredlabelstringrequireddescriptionstringrequiredordernumberrequiredfieldsobject[]requiredShow child attributes
fieldIdstringrequiredlabelstringrequiredtypestringrequiredAvailable options: text, email, phone, date, select, multi_select, checkbox, ssn, address, file_upload, payment_split, textarea, number, currency, info_text
requiredbooleanrequiredexcludeFromPayrollOnlybooleanplaceholderstringhelpTextstringoptionsobject[]Show child attributes
valuestringrequiredlabelstringrequiredconditionalOnobjectShow child attributes
fieldIdstringrequiredvaluesstring[]requiredretainWhenHiddenbooleanencryptedbooleanmaskedbooleanvalidationMessagestringvalidationPatternstringmaxFileSizeBytesnumberacceptedFileTypesstring[]legacyUploadFieldIdsstring[]documentCategorystringwidthstringAvailable options: full, half, third
externalLinksobject[]Show child attributes
labelstringrequiredurlstringrequiredpersistenceobject | object | object | object | objectShow child attributes
kindanyrequiredcitizenAnswerobjectShow child attributes
countryCodestringrequiredvaluesstring[]requiredAllowed: at least 1 items
isBlockingbooleanrequiredisSkippablebooleanrequiredcategorystringrequiredAvailable options: consent, personal, emergency, work_auth, tax_identity, documents, employment, banking, benefits, review, insurance, statutory, professional, declarations, provident_fund, country_specific
iconstringisContractorbooleanrequired