Set Onboarded Status to True

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

Returns

attribute

type

description

success

boolean

Response status

data

object

Updated employee object

errors

array

If success is false, errors contains a list of error objects.

Show child attributes

message
type: string
description: Error message

status
type: number
description: HTTP response code

code
type: number
description: Error code (see Error codes )

Language
Authentication
Header
Click Try It! to start a request and see the response here!