Generate Contractor Onboarding Link

post https://api.zeal.com/contractors/onboard

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

  • paperwork (e.g. W9, Bank Account Info (optional), and Bank Authorization Form)

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

attributetypedescription
successbooleanResponse status
datastringWeb onboarding link for this contractor
errorsarrayContains a list of error objects which consists of:
message: Error message
code: Error code as described in Error codes
Language
Authorization
Header
Click Try It! to start a request and see the response here!