Skip to content

Get onboarding URL for a task

Request

Security
form_session or user_session or component_session or component_token or api_token
Path
task_idstring(TaskId)^task_required

Task Identifier

Example:task_abc123def456
Query
expired_atstring

Link expiry, in the future and at most 90 days away. Defaults to 30 days.

assignee_typestringrequired
Enum:"employee""employer"
localestring
redirect_tostring
landing_pagestring

Where the link opens. onboarding_flow (the default) opens the onboarding form; candidate_portal opens the candidate portal, which lists all of the employee's tasks. candidate_portal is only allowed when assignee_type is employee, when redirect_to is not set, and for an organization that has the candidate portal enabled.

Enum:"onboarding_flow""candidate_portal"
otp_requiredboolean

Whether OTP verification is required before accessing the onboarding form. Only allowed when assignee_type is employee.

otp_methodsstring

Comma-separated list of allowed OTP delivery methods (sms, email)

user_auth_session_requiredboolean

When true, whoever opens this link must sign in to Onboarded before accessing the onboarding form. Only allowed when assignee_type is employer. The person must have an Onboarded user with edit permission on the link's tasks. Sign-in can add friction when the link is rendered in an iframe, especially in Safari.

curl -i -X GET \
  'https://docs.onboarded.com/_mock/openapi/api/v1/tasks/{task_id}/onboarding?expired_at=string&assignee_type=employee&locale=string&redirect_to=string&landing_page=onboarding_flow&otp_required=true&otp_methods=string&user_auth_session_required=true' \
  -H 'Authorization: Bearer <YOUR_Onboarded form session token_HERE>'

Responses

Success

Bodyapplication/json
urlstringrequired
Response
{ "url": "string" }