Set Onboarded Status to True

Set a contractor as onboarded.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Set onboarded status to true if the contractor has all the legally required information. If the contractor does not have the aforementioned properties, Zeal will return an array of errors stating which properties are missing.

Returns

attributetypedescription
successbooleanResponse status
dataobjectOnboarded Contractor Object
errorsarrayContains a list of error objects which consists of:
message: Error message
code: Error code as described in Error codes
Body Params
string
required

ID of the Contractor being updated

string
required

ID of the Employer that the Contractor belongs to

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json