Generate Employee Onboarding Link

Generates an expirable link to Zeal's employee payroll onboarding for a specified employee.

post/employees/onboard

Request

Base URL
https://api.zeal.com
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/zeal/apis/zeal-api/docs/employees/onboard/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

companyIDstring required

Company ID of employer

employeeIDstring required

ID of Employee

employee_acctboolean

If false, the employee account information (username and password) collection step of the onboarding will be left out

surveyboolean

If false, the employee survey step will be left out (Early Access)

i9_formboolean

If false, the I9 form in the paperwork step of the onboarding will be left out

id_scanboolean

If false, the ID scan step of the onboarding will be left out.

payment_method_requiredboolean

If false, the onboarding worker will be able to skip the bank account collection section of onboarding

paycardboolean

If false, the paycard enrollment screen will be left out. NOTE: Only applicable for Paycards (Early Access)

instant_payboolean

If false, the instant pay enrollment screen will be left out. NOTE: Only applicable for Instant Pay (Early Access)

Response

200

successboolean

datastring

Example response

{
  "success": true,
  "data": "https://payroll.your-domain.com/form/NjE5NmIyNThjZGQwMDIzYWEwMjFiL2NiYzFkMDcyYjAyNTRjZWY5MzUwNTdlZWExNmUyNjNkLzE2Mzc4NzcxMTcwMTIvP3Rlc3Q9dHJ1ZSZwcm9maWxlPXRydWUmwbG95ZWVfYWNjdD10cnVlJmlkX3NjYW49dHJ1ZSZpOT10cnVlJnBhcGVyd29yaz10cnVl"
}

Changes

No recorded changes to this operation across all 1 revision of this API.