Generates the employee-facing onboarding URL.

Access: System, Admin, and ClientAdmin users only.

The returned link contains the encrypted onboarding token used by the employee portal. The endpoint validates that the onboarding is in a state where the invitation link can still be used.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

Company identifier from the route.

int32
required

Onboarding identifier from the route.

Headers
string
Defaults to 1.0

The requested API version

string
Defaults to 1.0

The requested API version

Responses

Language
Credentials
Bearer
jwt
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json