Generate Employee Onboarding Link

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

Retrieve an expirable link to Zeal's employee payroll onboarding. Zeal’s onboarding collects:

  • Profile information (e.g. SSN, DOB, Address)
  • Employee account username and password (optional)
  • ID collection (optional - Zeal collects Driver's License + Social Security Card OR Passport)
  • Paperwork. This includes the Federal W4, State W4, I-9 (optional--see below), and Bank Account Information (optional).

You can choose whether you want to turn on or off these sections of Zeal onboarding by using this endpoint. This onboarding flow was custom-made to take less than 5 minutes to complete. After onboarding is completed, the employee can start getting paid.


Returns a success response and employee onboarding link.

successbooleanResponse status
dataobjectEmployee onboarding link
errorsarrayIf success is false, errors contains a list of error objects.

Show child attributes

type: string
description: Error message

type: number
description: HTTP response code

type: number
description: Error code (see Error codes )
Click Try It! to start a request and see the response here!