Get Company Onboarding Link

Get a link to Zeal's web-based company onboarding.

get/companies/onboard

Request

  • Base URL
    https://api.zeal.com
  • Auth
    API key in header Authorization

Query parameters

partnerIDstring required

PartnerID of the Zeal Partner

base_urlstring

The Base URL is the URL Zeal will redirect the employer to after completion of the company onboarding flow. You may include a custom Base URL in this field. Otherwise, by default, Zeal will use the Base URL found in the admin dashboard.

webhook_correlation_idstring

Provide your own ID, string, etc. to include in the webhook payload. Zeal will include this in the webhook we send you after the company onboards.

companyIDstring

The company ID can be optionally passed to generate a link that will take your company to the current step, and not the first step, of the onboarding process.

Response

200

successboolean
datastring

Example response

{
  "success": true,
  "data": "https://payroll.your-domain.com/employeronboard/10983755744920193854758300657020834"
}

Changes

No recorded changes to this operation across all 1 revision of this API.