Employment and User Statuses

Overview

When you create a new employment through Remote API, in its response, there are status and user_status fields which define the current status of the employment and user at a given time. Let's take a look at these both and their possible values in detail.

Employment statuses

Employment statuses are represented by the status field in the Employments API and its possible values are:

Employment Status	Description
`created`	Indicates that the employment has been created. At this stage, employer can edit employee's data.
`created_awaiting_reserve`	Indicates that the employment has been created but Remote is waiting for a reserve payment before an employer can invite the employee.
`created_reserve_paid`	Indicates that the reserve payment has been paid by the employer.
`invited`	Indicates that the employee has been invited but didn't start the onboarding process. At this stage, employer can no longer make changes to the employee's contract details.
`initiated`	Indicates that the employee has started their onboarding. On completion of every onboarding task, the employment.onboarding_task.completed event is triggered.
`review`	Indicates that the employee has completed onboarding and are being reviewed by the Remote admin.
`pending`	Indicates that employment is missing necessary fields while onboarding.
`active`	Indicates that the employment is active. The status is set to active when all user tasks are completed and the user status is also `active`. (Learn more about user statuses in the section below). On `active`, the employment.onboarding.completed event is triggered.
`archived`	Indicates that the employment has been archived and no longer in use. When an employment is marked as archived, the user status changes to `inactive`.
`deleted`	Indicates that the employment has been soft deleted by the admin. Accounts are deleted at the request of the users. When this is done, the user will no longer appear on the team page.

User status

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`.