Get Company Onboarding Link

Time	Status	User Agent
Make a request to see history.

URL Expired

The URL for this request expired after 30 days.

This endpoint allows you to retrieve a link to Zeal's web-based company onboarding flow. Company onboarding collects required information such as legal business name, FEIN, legal business address, and bank account information.

NOTE: This link expires exactly 7 days after generation.

Returns

attribute	type	description
success	boolean	Response status
data	string	Web onboarding link for this company
errors	array	Contains a list of error objects which consists of: `message`: Error message `code`: Error code as described in Error codes

partnerID

string

required

PartnerID of the Zeal Partner

base_url

string

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_id

string

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.

companyID

string

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.

``200 200

``400 400

Updated about 2 months ago

ShellNodeRubyPHPPython

xxxxxxxxxx

curl --request GET \

--url https://api.zeal.com/companies/onboard \

--header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200 - Result400 - Result

Updatedabout 2 months ago