> ## Documentation Index
> Fetch the complete documentation index at: https://nango.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Paycor (Sandbox)

## Overview

> [card] [Pre-built tooling](#pre-built-tooling)

> [card] [Pre-built integrations](#pre-built-integrations)

> [card] [Access requirements](#access-requirements)

> [card] [Setup guide](#setup-guide)

> [card] [Useful links](#useful-links)

> [card] [API gotchas](#api-gotchas)

## Pre-built tooling

> [accordion] ✅ Authorization
>
> | Tools | Status |
> | - | - |
> | Pre-built authorization (OAuth) | ✅ |
> | Credentials auto-refresh | ✅ |
> | Auth parameters validation | ✅ |
> | Pre-built authorization UI | ✅ |
> | Custom authorization UI | ✅ |
> | End-user authorization guide | ✅ |
> | Expired credentials detection | ✅ |

> [accordion] ✅ Read & write data
>
> | Tools | Status |
> | - | - |
> | Pre-built integrations | 🚫 (time to contribute: \<48h) |
> | API unification | ✅ |
> | 2-way sync | ✅ |
> | Webhooks from Nango on data modifications | ✅ |
> | Real-time webhooks from 3rd-party API | 🚫 (time to contribute: \<48h) |
> | Proxy requests | ✅ |

> [accordion] ✅ Observability & data quality
>
> | Tools | Status |
> | - | - |
> | HTTP request logging | ✅ |
> | End-to-end type safety | ✅ |
> | Data runtime validation | ✅ |
> | OpenTelemetry export | ✅ |
> | Slack alerts on errors | ✅ |
> | Integration status API | ✅ |

> [accordion] ✅ Customization
>
> | Tools | Status |
> | - | - |
> | Create or customize use-cases | ✅ |
> | Pre-configured pagination | 🚫 (time to contribute: \<48h) |
> | Pre-configured rate-limit handling | 🚫 (time to contribute: \<48h) |
> | Per-customer configurations | ✅ |

*No pre-built syncs or tools available yet.*

> [!TIP]
>
> Not seeing the integration you need? [Build your own](https://nango.dev/docs/guides/functions/functions-guide.md) independently.

## Access requirements

| Pre-Requisites | Status | Comment |
| - | - | - |
| Paid dev account | ✅ | You need a Paycor developer account with access to **AppCreator** to register your OAuth app and get client credentials. |
| Paid test account | ❌ | Paycor provides a **sandbox environment** (`hcm-demo.paycor.com`) for testing OAuth flows — no paid test account required. |
| Partnership | ✅ | You typically need to be an [approved partner](https://developers.paycor.com/join-developer-portal) to create applications. |
| App review | ✅ | Not required |
| Security audit | ✅ | Not required. |

## Setup guide

**1. Request a Sandbox Account**

1. Log in to your [sandbox](https://hcm-demo.paycor.com/) account.
2. Navigate to the Support form.
3. From the **Category dropdown**, select `Sandbox Environment`.
4. Submit the request.

> **Note**: The expected turnaround time for Sandbox environment creation is 5 business days.

**2. Accessing the Sandbox Environment**

Once your Sandbox account is approved:

1. Navigate to [developers-sandbox.paycor.com](https://developers-sandbox.paycor.com/).
2. Click **Sign Up** on the home screen for existing Paycor Clients.
3. Click **Get Started**.
4. Enter your sandbox Username and Password.
5. Click **Sign In**.
6. Select whom you would like to be the Admin of the Developer Portal Account.
7. Click **Request Access**.
8. Sign out then Sign In again using your previously used credentials.

> **Note**: The account creation process can take up to 5 minutes to complete. Sign out, then sign back in to access Paycor's sandbox Developer Portal.
> The Sandbox API base URL is different from Production (e.g., [https://apis-sandbox.paycor.com/v1/](https://apis-sandbox.paycor.com/v1/)...) and allows testing with mock data before moving to Production.

**3. Build your application**

1. Click **Applications** on the home screen to get started.
2. Click the **+ Application** button to create a new application, enter your application name.
3. Select an **Application Type**: **Standard Application**: For general API access.
4. Click **Create Application**
5. **Copy & Save** the **Application OAuth Client ID** and **Application OAuth Client Secret** as you will need them when configuring your integration in Nango.
6. Click **Got it**
7. Navigate to the **Security Connections** tab to get your **API Subscription Key** (you will need to add this to your Nango connection configuration) and add `https://api.nango.dev/oauth/callback` as the **Approved Return OAuth URL**.
8. Navigate to the **Data Access** tab and select your required Access scopes. This will generate a new version of the scope. You can find the **Scope Name** in the **General** tab, which you will need when configuring your integration in Nango.

> [!TIP]
>
> Need help getting started? Get help in the [community](https://nango.dev/slack).

> [!NOTE]
>
> Contribute improvements to the setup guide by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/paycor-sandbox.mdx)

## Useful links

* [API Documentation](https://developers.paycor.com/guides#welcome)
* [API Reference](https://developers.paycor.com/explore)
* [API Authentication](https://developers.paycor.com/guides#authorization)
* [How to create an OAuth application](https://developers.paycor.com/guides#step-2-build-application)
* [Environments Overview](https://developers.paycor.com/guides#environments-overview)

> [!NOTE]
>
> Contribute useful links by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/paycor-sandbox.mdx)

## API gotchas

* **Scope Name Generation**: After selecting your required Access scopes in the Data Access tab, Paycor generates a new version of the scope. You can find the **Scope Name** in the **General** tab, which you must add to your Nango Paycor integration configuration.
* **Subscription Key Required**: You need to add your **API Subscription Key** (found in the Security Connections tab) as a connection configuration parameter in Nango for all API calls to work properly. See [creating a connect session documentation](https://nango.dev/docs/reference/api/connect/sessions/create.md#body-integrations-config-defaults) for details on how to add `subscriptionKey` to your `connection_config` when creating a Nango session.

> [!NOTE]
>
> Contribute API gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/paycor-sandbox.mdx)

## Going further

> [card] [Connect to Paycor (Sandbox)](https://nango.dev/docs/integrations/all/paycor-sandbox/connect)
>
> Guide to connect to Paycor (Sandbox) using Connect UI


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.