Generate a secure onboarding link for a contractor.
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)
-
ID collection (optional - Zeal collects Driver's License + Social Security Card OR Passport)
NOTE - If passing the onboarding link in asrcof an iframe, theallow="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)
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
| attribute | type | description |
|---|---|---|
| success | boolean | Response status |
| data | string | Web onboarding link for this contractor |
| errors | array | Contains a list of error objects which consists of:message: Error messagecode: Error code as described in Error codes |