Skip to content

Paycor

Paycor is a provider of Human Resources software and services. Its HR (Human Resources) system has been crafted to streamline HR processes and offer a centralized platform for the management of employee data and HR functions. It includes features such as an employee self-service portal, performance management, time tracking, among others.

Paycor Connection Set Up

Hire2Retire will utilize OAuth 2.0 authentication for establishing the connection. You must have a Paycor account for authentication. To setup Paycor as an HR system on Hire2Retire, you have to:

The Hire2Retire platform provides two connection types for Paycor applications:

  1. Service Provider Application - This option lets you connect using the RoboMQ managed application.
  2. Customer Owned Application - This option lets you connect using your own Paycor application credentials.

Set up a Paycor Application

Note: These steps are common for both Paycor production and sandbox environment setup.

  1. Log into the Paycor Development Portal.  

  2. Go to the Applications tab and click on + Application button and type your application name.

    Add Application in Application Tab

    Figure 1. Add Application in Application Tab

  3. You will get the Client ID and Client Secret. These details will be required while creating a connection on Hire2Retire. Once you acknowledge the client ID and Secret, you will be redirected to your newly created application page.

    Client ID and Client Secret pop up

    Figure 2. Client ID and Client Secret pop up

  4. Navigate to the Security Connection tab, you can find the APIm Subscription Key there. The Subscription Key will be required while setting up connection on Hire2Retire. Add the following URL inside the Approved Return OAuth URL Textbox. https://hire2retire.robomq.io/api/auth/callback/Paycor

    Security Connections Tab of your created connection

    Figure 3. Security Connections Tab of your created connection

  5. Navigate to the Data Access tab and create a scope by giving the following permissions.

    • View Legal Entity Employees
      • View Legal Entity Employees Employment Dates
      • View Legal Entity Employees Manager & Position
      • View Legal Entity Employees Position
      • View Legal Entity Employees Status
      • View Legal Entity Employees Work Location
    • View Legal Entity Persons
      • View Person Addresses
      • View Person Demographic Information
      • View Person Email
      • View Person Phone
    • View Person Information
    • View Legal Entity Departments by Department Id
    • View Employee Information
      • Update Employee Contact: To use Paycor writeback feature.
    • View Legal Entity Basic Information
      • View Legal Entity Business Names & Addresses

    Data Access Tab

    Figure 4. Data Access Tab

    To know more about data access scopes, you can refer to Paycor Data Access Scopes.

  6. After creating the scope, navigate to the General tab and you can find the name of the scope you just created.

    General Tab of Paycor Application

    Figure 5. General Tab of Paycor Application

Create Paycor Connection on Hire2Retire

You can configure Paycor in Hire2Retire using either a Service Provider Application connection or a Customer Owned Application connection.

Service Provider Application

Use this option when you want to use the RoboMQ managed Paycor application.

  • Connection Name - A user defined nomenclature for your connection. By default, the connection name is Connection-Service Provider Application-1, you can change it as per your preferences.
  • Environment - Select the Paycor environment that you want to connect, such as Production or Sandbox.

Paycor Service Provider Application Connection

Figure 6. Paycor Service Provider Application Connection Set Up Page

After entering the details, click the Link Account button to continue.

Customer Owned Application

Use this option when you want to use your own Paycor application credentials created in the Paycor developer portal.

  • Connection Name - A user defined nomenclature for your connection. By default, the connection name is Connection-Customer Owned Application-1, you can change it as per your preferences.
  • Environment - Select the Paycor environment that you want to connect, such as Production or Sandbox.
  • Client ID of Paycor - You will get your client ID after adding the application in Paycor or you can find it on the Security Connection tab.
  • Client Secret - You will get your client secret after adding the application in Paycor or you can regenerate it from the Security Connection tab.
  • Scope ID - You can find it on the General tab once you create scopes on the Data Access tab.
  • APIM Subscription Key - You can find your subscription key in the Paycor Security Connection tab.

Environment is important when setting up the connection. A sandbox account in Paycor refers to a test environment provided by Paycor for developers and users to experiment. A sandbox account has sandbox in the development portal URL.

Paycor Developer Page for Sandbox Environment

Figure 7. Paycor Developer Page for Sandbox Environment

Paycor Customer Owned Application Connection

Figure 8. Paycor Customer Owned Application Connection Set Up Page

After entering the required details, click the Link Account button to continue.

Complete Paycor Activation

After clicking the Link Account button for either connection type, Hire2Retire will redirect you to Paycor to review the access being requested, based on the application scope and version. You will be prompted to log in to Paycor if you are not already logged in. In this case, enter your Company/HR/Payroll Administrator credentials, as once the application is created, the Company/HR/Payroll Administrator role is required to complete the activation process in the production environment.

Paycor App Activation

Figure 9. Paycor App Activation

Select the Paycor Legal Entity ID that you want to integrate. This gives your application access to the client's data.

Paycor Select Legal Entity ID

Figure 10. Paycor Select Legal Entity ID

When the connection is created successfully, it becomes active in Hire2Retire and is available for dependent application configurations.

Paycor Available Connections in Hire2Retire

Figure 11. Paycor Connection Available for Downstream Configuration

Note: While setting up connection on Hire2Retire if you see a "403" message. It indicates that the logged-in Paycor user doesn't have access to complete the Activation process. User requires "Company/HR/Payroll Administrator" role to complete this. Your Sandbox credentials already have this access, but Production will need to be done by an authorized user.