Skip to main content
POST
cURL
The generated onboarding link is only valid for 30 minutes, and it should be opened in the client’s browser as it cannot be reused once activated. For asynchronous onboarding, use the send-email endpoint.

Authorizations

Authorization
string
header
required

Bearer token obtained from the /v1/auth/token endpoint. Send as: Authorization: Bearer .

Path Parameters

employer_identifier
string<uuid>
required

ID of the employer identifier to create a new onboarding session token for

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
invite
string<uuid>
required

ID of the employer invite to retrieve

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

Employer invite session link created successfully