Skip to main content
POST
Generate Contractor Onboarding Link
Generate an expirable link to Zeal’s contractor onboarding. Zeal’s onboarding collects:
  • Profile information (e.g. SSN, DOB, Address)
  • Contractor account username and password (optional)
  • Contractor Survey attributes (optional). NOTE: Only applicable for Custom Attributes (Early Access)
  • ID collection (optional - Zeal collects Driver’s License + Social Security Card OR Passport) NOTE - If passing the onboarding link in a src of an iframe, the allow="camera" flag must be passed in order for the iframe to prompt or access a user’s camera.
  • Paperwork (W9 form)
  • Bank Account Information (optional)
  • Paycard enrollment information for the contractor (optional). NOTE: Only applicable for Paycards (Early Access)
  • Instant Pay enrollment information for the contractor (optional). NOTE: Only applicable for Instant Pay (Early Access)
You can choose whether you want to turn on or off these sections of Zeal onboarding by using this endpoint. This onboarding flow was custom-made to take less than 3 minutes to complete. After onboarding is completed, the contractor can start getting paid!

Returns

Authorizations

Authorization
string
header
required

Body

application/json
companyID
string
required

Company ID of employer

contractorID
string
required

ID of Contractor

contractor_acct
boolean
default:false

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

survey
boolean
default:false

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

id_scan
boolean
default:false

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

payment_method_required
boolean
default:false

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

paycard
boolean
default:false

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

instant_pay
boolean

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

Response

200

success
boolean
default:true
Example:

true

data
string
Example:

"https://payroll.your-domain.com/contractoronboarding/10983755744920193854758300657020834"