---
title: "Create Employee Onboarding"
method: POST
path: "/v1/companies/{companyId}/onboarding/employees"
tags: ["Onboarding"]
---

# Create Employee Onboarding

`POST /v1/companies/{companyId}/onboarding/employees`

## Request

- Base URL: `https://dc1demogw.paylocity.com/api`
- URL: `https://dc1demogw.paylocity.com/api/v1/companies/{companyId}/onboarding/employees`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://api.paylocity.com/IdentityServer/connect/token` scopes: `WebLinkAPI`

Onboarding API sends employee data into Paylocity Onboarding to help ensure an easy and accurate hiring process for subsequent completion into Paylocity Payroll/HR solution.

## Path parameters

- `companyId` string, required

## Headers

- `Authorization` string, required

## Request body

- Onboarding
  - `employeeId` string: (optional) The Paylocity Employee ID. This is a unique value per Paylocity Company ID. **Allowable Values:** 10 char max
  - `address1` string: Employee home 1st address line. <br />Max length: 40
  - `address2` string: Employee home 2nd address line. <br />Max length: 40
  - `autoPayType` string: Valid values are *N, D, S. (N- employee won't automatically receive a salary or hours during payroll, D - employee will be automatically paid in defaultHours during payroll, S - employee will be automatically paid Salary amount during payroll)*. <br />Max length: 3
  - `baseRate` number: Employee base rate, used for Hourly employees. <br />Decimal (12,2)
  - `city` string: Employee home city. <br />Max length: 40
  - `costCenter1` string: Employer defined location, like *branch, division, department, etc.* Must match Company setup. <br />Max length: 10
  - `costCenter2` string: Employer defined location, like *branch, division, department, etc.* Must match Company setup. <br />Max length: 10
  - `costCenter3` string: Employer defined location, like *branch, division, department, etc.* Must match Company setup. <br />Max length: 10
  - `defaultHours` number: Employee default hours consistently worked. If autoPayType is set to D, employee will be paid hourly base rate for the defaultHours. <br />Decimal (12,2)
  - `employeeStatus` string: Employee current work status. Common values are *A (Active), L (Leave of Absence), T (Terminated)*. <br />Max length: 20
  - `employmentType` string: Employee current employment type. Common values RFT *(Regular Full Time), RPT (Regular Part Time), SNL (Seasonal), TFT (Temporary Full Time), TPT (Temporary Part Time)*. <br />Max length: 10
  - `federalFilingStatus` string: Employee federal filing status. Common values *M (Married), S (Single)*. <br />Max length: 10
  - `firstName` string, required: Employee first name. <br />Max length: 40
  - `sex` string: Employee gender. Common values *M (Male), F (Female)*. <br />Max length: 1
  - `hireDate` string: Employee hired date. Common formats are MM-DD-CCYY, CCYY-MM-DD
  - `homePhone` string: Employee home phone number. <br />Max length: 12
  - `lastName` string, required: Employee last name. <br />Max length: 40
  - `maritalStatus` string: Employee marital status. Common values *D (Divorced), M (Married), S (Single), W (Widowed)*. <br />Max length: 10
  - `personalMobilePhone` string: Employee personal mobile phone number. <br />Max length: 12
  - `payFrequency` string: Employee current pay frequency. Common values are *A (Annual), B (Bi-Weekly), D (Daily), M (Monthly), S (Semi-Monthly), Q (Quarterly), W (Weekly)*. <br />Max length: 5
  - `personalEmailAddress` string: Employee personal email address. <br />Max length: 50
  - `payType` string: Employee pay type. Valid values are *Hourly or Salary*. <br />Max length: 10
  - `ratePer` string: Employee base rate frequency used with payType Hourly. Common values are *Hour or Week*. Default is Hour <br />Max length: 10
  - `salary` number: Employee gross salary per pay period used with payType Salary. <br />Decimal (12,2)
  - `state` string: Employee home state. <br />Max length: 2
  - `ssn` string: Employee social security number. Leave it blank if valid social security number not available. <br />Max length: 11
  - `stateFilingStatus` string: Employee state filing status. Common values are *M (Married), S (Single)*. <br />Max length: 50
  - `suiState` string: Employee SUI (State Unemployment Insurance) state. <br />Max length: 2
  - `taxForm` string: Employee tax form for reporting income. Valid values are *W2, 1099M, 1099R, 1099NEC, Non-US*. Default is W2. <br />Max length: 15
  - `taxState` string: Employee primary tax state. <br />Max Length: 2
  - `userName` string: Required. Employer assigned username to log into Onboarding. Duplicate usernames are not allowed. <br />Must be between 3 and 20 characters and cannot have special characters other than . (period) and _ (underscore)
  - `workEmailAddress` string: Employee work email. <br />Max length: 50
  - `zip` string: Employee home zip code. <br />Max length: 10

## Response `201`

Successfully Added

## Other responses

- `400`: Bad Request
- `403`: Forbidden
- `500`: Internal Server Error

---

[API](https://skmtc.dev/paylocity/apis/weblink-api.md) - [All operations](https://skmtc.dev/paylocity/apis/weblink-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paylocity/apis/weblink-api/revisions/8152ed40b412?raw)