Employer Onboarding

A key piece of the payroll solution for Offerers is employer onboarding. With Zeal's whitelabel Company Onboarding Component employers can provide all the information needed in three simple sections:

1. Profile Information
2. Bank Verification
3. Payroll Paperwork

(Optional) Pre-fill Company Profile Information

In some cases, you may prefer to pre-fill the company profile information with details already collected. This helps reduce friction and provides a better experience for the employer.

1. Call Create Company to submit the company information. This will return a JSON object representing the Company data.

🔔

Note

Remember to replace the placeholders such as {{testApiKey}} in the code samples below.

curl --location --request POST 'https://api.zeal.com/companies'
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json'
     --header 'Authorization: Bearer {{testAPIKey}}'
     --data-raw '{
       "partnerID": "{{partnerID}}",
       "first_name": "Richard",
       "last_name": "Hendricks",
       "email": "[email protected]",
       "business_name": "Pied Piper",
       "business_ein": "12-3456789",
       "business_address": "5941 Newell Rd.",
       "business_city": "Palo Alto",
       "business_state": "CA",
       "business_zip": "94303",
       "business_phone": "6504441234",
       "skip_migration": true
     }'

2. Get the companyID from the returned data and include it in the next step.

Onboarding Flow

1. Call Get Company Onboarding Link. This returns a link to the whitelabel component.

💬

Note

If you previously created the company and want Zeal to pre-fill the first section of the onboarding flow, add the companyID as a query parameter in the call below.

curl --request GET \
     --url 'https://api.zeal.com/companies/onboard?partnerID={{partnerID}}' \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer {{testApiKey}}'

2. Give the employer access to the link. Generally our partners chose to include the link in their application or display the component directly within an iframe.

<a href="{{companyOnboardingLink}}">Click to begin payroll onboarding!</a>

3. The employer accesses the link and they see the whitelabel component on your domain with your logo.
4. The employer completes the Profile Information section.

5. Next, the employer completes the Bank Verification. This step requires a micro-deposit flow where two small deposits are made to the employer’s bank account. The employer will leave the onboarding flow and return later to confirm the deposit amount. The micro-deposit flow generally takes 1 - 3 days.

6. Finally in the Paperwork section, the employer signs and agrees to the documents Zeal needs to process payroll.

📝

Note

When the company onboarding flow is completed successfully, Zeal sends this company's information to the webhook you've set for the Employer Onboarding Event.

Congratulations
You've onboarded your first employer!