User Status

Overview

User statuses refer to the current state of the user that's being onboarded. This value is represented by the user_status field in the Remote API and can one of the following values:

User Status	Description
`created`	Indicates that a user was creates but did not start the onboarding.
`initiated`	Indicates that a user has started their onboarding process. The employment.user_status.initiated event is triggered when a user status changes to `initiated`.
`active`	Indicates that a user has completed onboarding. This status is achieved when all onboarding user tasks are completed and the corresponding employment has a status `review`, `pending`, `active`, or `archived`. The employment.user_status.activated webhook is triggered when a user status changes to `active`.
`cancelled`	Indicates that a user contract was canceled. At this stage, the user can still log in and access their data and documents.
`deleted`	Indicates that a user has been deleted and can no longer log into Remote platform. Deleted users do not show up on the people page but can be searched in the Users table by a Remote admin.
`inactive`	Indicates that a user was deactivated and their employment is suspended. At this stage, the user can still log into the platform to access their data and documents but their invoicing capabilities have been revoked. The employer can reactivate a user at any time. The employment.user_status.deactivated webhook is triggered every time a user status changes to `inactive`.