post https://api.zeal.com/employees/onboard
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)
NOTE - If passing the onboarding link in asrcof an iframe, theallow="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)
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.
| attribute | type | description |
|---|---|---|
| success | boolean | Response status |
| data | object | Employee onboarding link |
| errors | array | If success is false, errors contains a list of error objects.Show child attributesmessagetype: string description: Error messagestatus type: number description: HTTP response codecode type: number description: Error code (see Error codes ) |