Developer Resources

Worker

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

Once generated, the IN_PROGRESS worker can have their communications, Compensation and Federal Taxes POSTed and PATCHed using the generated workerId. (The sandbox does not support this functionality.)