v1
latestOpenAPI 3.0.42026-07-2481154567.6 KBCreate Employee Onboarding
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
The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity. Allowable Values: 9 char max
Headers
Bearer + JWT
Request body
(optional) The Paylocity Employee ID. This is a unique value per Paylocity Company ID. Allowable Values: 10 char max
Employee home 1st address line. <br />Max length: 40
Employee home 2nd address line. <br />Max length: 40
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
Employee base rate, used for Hourly employees. <br />Decimal (12,2)
Employee home city. <br />Max length: 40
Employer defined location, like branch, division, department, etc. Must match Company setup. <br />Max length: 10
Employer defined location, like branch, division, department, etc. Must match Company setup. <br />Max length: 10
Employer defined location, like branch, division, department, etc. Must match Company setup. <br />Max length: 10
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)
Employee current work status. Common values are A (Active), L (Leave of Absence), T (Terminated). <br />Max length: 20
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
Employee federal filing status. Common values M (Married), S (Single). <br />Max length: 10
Employee first name. <br />Max length: 40
Employee gender. Common values M (Male), F (Female). <br />Max length: 1
Employee hired date. Common formats are MM-DD-CCYY, CCYY-MM-DD
Employee home phone number. <br />Max length: 12
Employee last name. <br />Max length: 40
Employee marital status. Common values D (Divorced), M (Married), S (Single), W (Widowed). <br />Max length: 10
Employee personal mobile phone number. <br />Max length: 12
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
Employee personal email address. <br />Max length: 50
Employee pay type. Valid values are Hourly or Salary. <br />Max length: 10
Employee base rate frequency used with payType Hourly. Common values are Hour or Week. Default is Hour <br />Max length: 10
Employee gross salary per pay period used with payType Salary. <br />Decimal (12,2)
Employee home state. <br />Max length: 2
Employee social security number. Leave it blank if valid social security number not available. <br />Max length: 11
Employee state filing status. Common values are M (Married), S (Single). <br />Max length: 50
Employee SUI (State Unemployment Insurance) state. <br />Max length: 2
Employee tax form for reporting income. Valid values are W2, 1099M, 1099R, 1099NEC, Non-US. Default is W2. <br />Max length: 15
Employee primary tax state. <br />Max Length: 2
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)
Employee work email. <br />Max length: 50
Employee home zip code. <br />Max length: 10
Response
Successfully Added