Offerer Guide

As discussed in our guide to Building a Payroll Product, Offerers are looking to provide a payroll product they can sell to employers. As an Offerer, there are 4 main components to get your payroll product started:

  1. Employer Onboarding
  2. Employer Dashboards
  3. Worker Onboarding
  4. Worker Dashboards

In this guide we’ll show you how to get up and running quickly with our white-label components. Remember, you can use as many or as few of the white-label components as you would like, but even if you aren’t planning to use them, they can be helpful to reference when building your custom solutions using our APIs. If you’re interested in building using our API, please reference our Core Component Guides next.

Employer Onboarding

Leading an employer through the onboarding flow is as simple as getting a link to the Company Onboarding Component and sharing it with the employer.

  1. Call Get Company Onboarding Link.

🚧

Code Samples

Remember to replace the placeholders marked with {} in the code samples below.

curl --request GET \
     --url 'https://api.zeal.com/companies/onboard?partnerID={partnerID}' \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer {testApiKey}'
  1. Give the employer access to the link. Generally our partners chose to include the link in their application or display the component directly through an iframe.
<a href="{companyOnboardingLink}">Click to begin payroll onboarding!</a>
  1. When the employer accesses the link, they see the white-label component on your domain with your logo. They complete 3 forms: Profile Information, Bank Verification, and Payroll Paperwork.
22442244
  1. Once the employer completes the onboarding flow, they are redirected to the base URL you set in the Account Setup and API Keys step. Note: the base URL can also be set dynamically when calling Get Company Onboarding Link.

👍

Employer Onboarding Event

When the Employer Onboarding flow is completed successfully through the white-label, Zeal sends this Employer's information to the webhook URL you've set for the Employer Onboarding Event.

Congratulations! You’ve onboarded your first employer. You will now see the employer displayed under the Companies section of your Super Admin Dashboard.

Employer Dashboard

Now that we’ve onboarded an employer, we want to provide them a space where they can manage their workers, run payroll, and view their information. There are a lot of features involved in this section, but thankfully Zeal offers all this functionality and more through our white-label Employer Dashboard which can be access similarly to the Company Onboarding Component.

  1. The employer logs in to your application.
  2. Once they are authenticated by your system, call Get Employer Login Link to get an SSO link specific to this Employer that they can use to access the dashboard without having to log in again.
curl --location --request POST 'https://api.zeal.com/getAuthLink'
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {testApiKey}'
--data-raw '{
   "partnerID": "{partnerID}",
   "companyID": "{companyID}"
}'
  1. Give the employer access to the link. Generally our partners chose include the link in their application or display the component directly through an iframe
<a href="{companyOnboardingLink}">Click to access your payroll dashboard!</a>
  1. When the Employer accesses the link, they see the white-label component on your domain with your logo. Here they can manage their workers, payroll, and profile information.
28802880

Congratulations! With this step you've enabled employers to start using your product. In the following sections, we’ll show a couple of key experiences for workers.

Worker Onboarding

From the Employer Dashboard, an employer can onboard both W-2 Employees and 1099 Contractors. To show the employer experience, let's navigate to a representation of the dashboard as a Super Admin. For the purpose of this guide, we’ll detail the Employee Onboarding process. Please reference our Contractor Onboarding Guide to understand the contractor experience.

  1. Navigate to your Super Admin Dashboard and ensure that Test Mode is enabled.
  2. Click on a Company to access the Employer Dashboard as a Super Admin.
28802880
  1. Navigate to the Work Location page and click Add a New Location. Before we can onboard employees, we’ll need to register a Work Location for the company.
28762876
  1. Enter the taxable address of the location where the employee(s) will be working.
28802880
  1. Next, navigate to the People page and click Add New Employee.
28742874
  1. Fill the employee information and select the proper Work Location from the dropdown, then click Add Employee.
28722872
  1. Back on the People page, find the Employee and click the arrow icon to email the onboarding link directly to the employee or click the copy icon to copy it to your clipboard.
28722872
  1. When the employee navigates to the page, they see the white-label component on your domain with your logo.
22442244
  1. The employee completes the onboarding flow including forms such as: Profile Information, Federal W-4, Bank Account Information.

👍

Employee Onboarding Event

When the Employee Onboarding flow is completed successfully through the white-label, Zeal sends the Employee information to the webhook URL you've set for the Employee Onboarding Event.

Congratulations! You've onboarded your first employee.

Worker Dashboards

The final piece of the Offerer model is to give workers a space where they can review their pay history, view/download paystubs, and access their personal and tax information (such as their end-of-year W-2). Zeal provides all of this out of the box with our Employee/Contractor dashboards. This feature is not available in Test Mode but the flow for an employee will be:

  1. During the Employee Onboarding flow (previous section), the employee can create an account.
22442244
  1. Then, at any point in time, they can navigate to your domain (i.e. payroll.[your-domain].com), and log in to their dashboard using their credentials.
  2. When the employee logs in, they’ll see their Employee Dashboard where they can view paystubs, and view/edit their profile information. Note: Your logo will be present in place of Zeal’s.
28802880

Congratulations
You have the comprehensive knowledge you need to build an excellent payroll product for your customers!


Did this page help you?