Skip to main content
POST
Get onboarding progress

Authorizations

Authorization
string
header
required

Personal API token. Create via createUserApiToken endpoint.

Headers

x-role-type
enum<string>
required

Role context for the request. Use CLIENT_ORG_ADMIN for most integrations.

Available options:
CLIENT_ORG_ADMIN,
PAYROLL_ADMIN,
FINANCE_ADMIN,
TOKU_ADMIN

Body

application/json
roleInOrgId
string<uuid> | null

Optional role-in-org identifier to inspect

Response

Successful response

roleInOrgId
string<uuid>
required

Role-in-org identifier

status
string
required

Onboarding status

steps
object[]
required

Detailed onboarding steps

completedStepCount
integer
required

Number of completed steps

totalStepCount
integer
required

Total number of onboarding steps

countryCode
string | null

Country code for onboarding flow

currentStepId
string | null

Current onboarding step identifier

onboardingStartedAt
string<date-time> | null

When onboarding started