CHcheckhq

Employee Onboard

Changed on

Generates an Onboard link for the specified employee. Onboard links can also be embedded like Components. Check out our <a href="https://docs.checkhq.com/docs/adding-check-onboard-to-your-application" target="_blank">guide</a> on how to embed them into your app.

post/employees/{employee}/onboard

Request

Path parameters

employeestring required

Generate an onboard link for this employee ID

Response

200

urlstring

Example response

{
  "url": "{one_time_onboard_link}"
}

Changes