When you POST workers via our API, the workers are automatically added to People in Paychex Flex. They're marked as IN_PROGRESS until you complete all required fields, at which point their status changes to ACTIVE.

The Paychex Flex UI manages validation, rules, and required fields based on the client’s configuration.

Required fields when POSTing a worker are:

• givenName
• familyName
• workerType

Optional fields include:

• When adding multiple workers at a time, include a "workerCorrelationId" data element on each worker; this is used as an identifier in our responses
• You can include a workers communications object

When a worker is added as IN_PROGRESS, an invitation will automatically be sent prompting them to complete their onboarding in Flex if the IN_PROGRESS worker has been created with a communications type of EMAIL or MOBILE_PHONE. This feature utilizes the following combinations of communication types and usageTypes (in order of operation). These communication types are found within the workers communications object when the worker is initially added.

1. If type = 'EMAIL' & usageType = 'BUSINESS' exists, use that
2. If option 1 does not exist, use type = 'EMAIL' & usageType = 'PERSONAL'
3. If both options 1 & 2 do not exist, use type = 'MOBILE_PHONE' and usageType = 'BUSINESS'
4. If none of options 1-3 exist, do not send a notification

Once generated, the IN_PROGRESS worker can have their Communications, Compensation, Federal Taxes, State Taxes, and Direct Deposit POSTed and PATCHed using the generated workerId.