Generate Employee Onboarding Link

post

https://api.zeal.com/employees/onboard

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

Body Params

companyID

string

required

Company ID of employer

employeeID

string

required

ID of Employee

employee_acct

boolean

Defaults to false

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

survey

boolean

Defaults to false

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

i9_form

boolean

Defaults to false

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

id_scan

boolean

Defaults to false

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

payment_method_required

boolean

Defaults to true

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

paycard

boolean

Defaults to false

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

instant_pay

boolean

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

Responses

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200