Overview

To authenticate Paylocity, you will need to provide the following information:

• Client ID

• Client Secret

• Company ID

This guide will walk you through finding or creating those credentials within Paylocity.

Prerequisites

Step 1: Fill out a Paylocity Web Services Access Request Form

Fill out and save a copy of the Paylocity Web Services - Access Request Form as outlined below.

1. On the first page:

   • The Paylocity Client Details should be filled in with the details of your company (for example, your HR personnel) and Paylocity instance

   • The Development Resource information should be filled out with information for the company you are connecting to

   • Choose just PRODUCTION for Request Type, unless you are requesting access to or connecting to a sandbox instance

     • If you are requesting access to a sandbox instance, make sure you fill in the Sandbox information at the bottom of the first page

   

2. On the second page:

   • Select the Paylocity’s legacy Web Link API endpoints checkbox

   

3. On the third page, fill in the Signature section

Step 2: Fill out a Paylocity Web Link API endpoint request form

Additionally, fill out and save a copy of the Paylocity Web Services - Legacy Web Link API Access request form as outlined below.

1. On the first page:

   • The Client Contact information, Who Gets the Credentials, and Automated Email Notifications should be filled in with the details of your company (for example, your HR or IT personnel) and Paylocity instance

   • The endpoints required in the Legacy API Access section will depend on your use case and what data you will be sending. Only choose the access relevant to your use case. See below for full details:

     • Get Employee is required for all use cases to retrieve employee information

       • If you want to send over Pay Rate information and SSN, choose Unrestricted

       • Otherwise, choose Restricted

     • New Hire is required for all use cases to retrieve new hire information

     • Employee Update is required for all use cases to effeciently retrieve updates to employee information

     • Get Payment Statements is required if you want to send over pay statement (payroll) data

     • Get Earnings, Add/Update Earnings, and Delete Earnings are required if you want to send over earnings data within pay statements

     • Get Deductions, Add/Update Deductions, and Delete Deductions are required if you want to send over deductions data within pay statements

     • Get Employee Direct Deposit is required if you want to send over employee bank information

   

2. On the second page:

   • Leave the Legacy Webhook Push Notifications, Username, and Password blank

   • Fill in the Signature

Step 3: Send both of your completed forms to [email protected]

The email body should contain the following:

Subject: Requesting Client ID and Client Secret


Hi Paylocity team, can we get access to a Client ID and Client Secret for API access? (https://www.paylocity.com/our-products/integrations/api-library/) We have attached the form specifying relevant permissions. 

Instructions

Step 1: Enter your Client ID & Secret into the linking flow

Paylocity will provide you with your Client ID and Client Secret, which you can enter into the linking flow. For further information, you can find full details on Paylocity's website here.

Step 2: Enter your Company ID into the linking flow

Your Company ID is the ID you used to login into Paylocity, and it will be the same ID you see in the upper left-hand corner of your Paylocity portal. Enter your Company ID into the linking flow.

Step 3: Enter additional company IDs

1. If you are using multiple companies within your Paylocity account which you want to link, enter any additional company IDs on the Enter optional company IDs step.

   1. Company IDs are case-sensitive, so please enter it exactly as it appears in Paylocity.

2. Separate multiple IDs with a comma, for example 12345,ABCDE,F0001.

   1. Do not include a space after the comma.

3. Enter None if you do not want to link multiple companies.

4. Click Next once done.

Notes

• When providing optional companies, be aware that the same person may be employed by more than one company during the course of their employment. In these cases you would see the same employee several times (once for each company).