API Reference

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

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)
  • Employee Survey attributes (optional). NOTE: Only applicable for Custom Attributes (Early Access)
  • ID collection (optional - Zeal collects Driver's License + Social Security Card OR Passport) NOTE - If passing the onboarding link in a src of an iframe, the allow="camera" flag must be passed in order for the iframe to prompt or access a user's camera.
  • Paperwork. This includes the Federal W4, State W4, I-9 (optional--see below)
  • Bank Account Information (optional)
  • Paycard enrollment information for the employee (optional). NOTE: Only applicable for Paycards (Early Access)
  • Instant Pay enrollment information for the employee (optional). NOTE: Only applicable for Instant Pay (Early Access)

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

Returns a success response and employee onboarding link.

attributetypedescription
successbooleanResponse status
dataobjectEmployee onboarding link
errorsarray

Show child attributes

  • message type: string description: Error message

  • status type: number description: HTTP response code

  • code type: number description: Error code (see Error codes )

Body Params
string
required

Company ID of employer

string
required

ID of Employee

boolean
Defaults to false

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

boolean
Defaults to false

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

boolean
Defaults to false

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

boolean
Defaults to false

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

boolean
Defaults to true

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

boolean
Defaults to false

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

boolean

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

Responses

Updated 12 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 12 months ago