Worker Payment Readiness

Before you can pay a worker, they must be onboarded. This means gathering personal and employment information for that individual using either our hosted UI elements or APIs. Throughout the onboarding process, you can monitor a worker's status with the Worker Payments Readiness status field, which shows a worker's current ability to receive payments, and any outstanding requirements.

How to track readiness

Worker Payment Readiness data is available from:

The Salsa Dashboard under worker profile
The Worker Capabilities API
The Webhook event :Worker.PaymentReadiness.statusChanged

This is an example of worker payment readiness as seen in the Salsa Dashboard under the worker profile.

States

Use the following states to track a worker's payment readiness based on onboarding status and jurisdictional data requirements:

Status	Description
`ONBOARDING`	When creating a worker, they initially enter the `ONBOARDING` state and remain there until they meet all requirements for payment in at least one jurisdiction. The employer must complete employment data, including classification and overtime eligibility, using the employer onboarding element to collect this information. Additionally, the employer can input other data such as tax setup or bank information into the system, or alternatively, utilize the worker's self-onboarding experience to gather this data.
`READY`	The worker reaches the `READY` state and is eligible to be paid through the run payroll experience once all required data for payment in the assigned work locations is complete.
`NOT_READY`	A previously onboarded worker may transition to the `NOT_READY` state if changes in their jurisdiction's requirements necessitate the collection of new data. Although this is an uncommon scenario, collecting the required new tax information will allow the worker to return to the `READY` state.
`PARTIALLY_READY`	A worker enters the `PARTIALLY_READY` state when they are ready to be paid in at least one jurisdiction but not in others. This occurs when workers are assigned to multiple locations and are only prepared for payment in a subset of these areas, often due to new assignments or updated data requirements similar to those in the `NOT_READY` state. Although possible, this scenario is relatively rare in the small business ecosystem.

The following is a typical worker payment readiness flow:

Transition between states — Worker payment readiness state transitions.