Onboarding

Get Onboarding Config

Resolves the onboarding step configuration for a worker's country and employment type.

GEThttps://api.toku.com/hris/get-onboarding-config

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>'
200 response
{
  "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

Authorizationstringheaderrequired

Bearer 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
countryCodestringrequired
countryNamestringrequired
stepsobject[]required
Show child attributes
stepIdstringrequired
labelstringrequired
descriptionstringrequired
ordernumberrequired
fieldsobject[]required
Show child attributes
fieldIdstringrequired
labelstringrequired
typestringrequired

Available options: text, email, phone, date, select, multi_select, checkbox, ssn, address, file_upload, payment_split, textarea, number, currency, info_text

requiredbooleanrequired
excludeFromPayrollOnlyboolean
placeholderstring
helpTextstring
optionsobject[]
Show child attributes
valuestringrequired
labelstringrequired
conditionalOnobject
Show child attributes
fieldIdstringrequired
valuesstring[]required
retainWhenHiddenboolean
encryptedboolean
maskedboolean
validationMessagestring
validationPatternstring
maxFileSizeBytesnumber
acceptedFileTypesstring[]
legacyUploadFieldIdsstring[]
documentCategorystring
widthstring

Available options: full, half, third

externalLinksobject[]
Show child attributes
labelstringrequired
urlstringrequired
persistenceobject | object | object | object | object
Show child attributes
kindanyrequired
citizenAnswerobject
Show child attributes
countryCodestringrequired
valuesstring[]required

Allowed: at least 1 items

isBlockingbooleanrequired
isSkippablebooleanrequired
categorystringrequired

Available options: consent, personal, emergency, work_auth, tax_identity, documents, employment, banking, benefits, review, insurance, statutory, professional, declarations, provident_fund, country_specific

iconstring
isContractorbooleanrequired
400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits