Generate Contractor Onboarding Link

URL Expired

The URL for this request expired after 30 days.

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

Parameters

• companyID

  • string
  • required
  • Company ID of employer

• contractorID

  • string
  • required
  • ID of Contractor

• contractor_acct

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

• survey

  • boolean
  • Defaults to false
  • If false, the contractor survey step will be left out (Early Access)

• id_scan

  • boolean
  • Defaults to false
  • If false, the ID collection step of contractor onboarding will be left out.

• payment_method_required

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

• paycard

  • boolean
  • Defaults to 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)

Example Request

curl --request POST \
     --url https://api.zeal.com/contractors/onboard \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '  
{  
  "contractor_acct": false,  
  "survey": false,  
  "id_scan": false,  
  "payment_method_required": false,  
  "paycard": false  
}
'  

Responses

• 200 - Success response with data
• 400 - Error response