Generate Contractor Onboarding Link

post

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

Generate a secure onboarding link for a contractor.

Body Params

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)

Responses

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200