Generate Contractor Onboarding Link

Generate a secure onboarding link for a contractor.

post/contractors/onboard

Request

Base URL
https://api.zeal.com
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/zeal/apis/zeal-api/docs/contractors/onboard/post.ts
A function with typed inputs. Its response is checked against the schema.

companyIDstring required

Company ID of employer

contractorIDstring required

ID of Contractor

contractor_acctboolean

If false, the contractor account information (username and password) collection step of onboarding will be left out.

surveyboolean

If false, the contractor survey step will be left out (Early Access)

id_scanboolean

If false, the ID collection step of contractor onboarding will be left out.

payment_method_requiredboolean

If false, the onboarding worker will be able to skip the bank account collection section of onboarding

paycardboolean

If false, the paycard enrollment screen will be left out. NOTE: Only applicable for Paycards (Early Access)

instant_payboolean

If false, the instant pay enrollment screen will be left out. NOTE: Only applicable for Instant Pay (Early Access)

200

successboolean

datastring

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

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