Configure Connection
Paycor guide
Arrange API access, configure authentication and company details in NIM, and validate workforce data for downstream user provisioning.
Before you beginDirect link to Before you begin
Follow the Paycor API documentation and setup instructions to configure API access for your environment. Work with your Paycor administrator or vendor support if you need assistance obtaining the required values.
NIM requires Tenant URL, Token URI, Client ID, Client Secret, Refresh Token, Subscription ID, and Company ID.
Obtain endpoints, credentials, and identifiersDirect link to Obtain endpoints, credentials, and identifiers
- Complete Paycor's API setup and authorization requirements for the intended environment.
- Obtain the Tenant URL, Token URI, Client ID, and Client Secret.
- Complete the vendor's authorization process to obtain a Refresh Token, and obtain the Subscription ID and Company ID for the integration.
- Confirm access to the company and workforce data required by your process, and store credentials and tokens securely.
Enter the connection settingsDirect link to Enter the connection settings
- In NIM Studio, open Systems > Overview and add a Paycor system, or select the existing system.
- Open Connection, enter the following settings, and save.
| NIM setting | Value |
|---|---|
| Tenant URL | The Paycor API tenant address for your environment, using the format expected by the Connection screen. |
| Token URI | The authentication token endpoint supplied for the integration. |
| Client ID | The client identifier authorized for API access. |
| Client Secret | The secret associated with that client. |
| Refresh Token | The refresh token obtained through the vendor's authorization process. |
| Subscription ID | The subscription identifier supplied for API access. |
| Company ID | The company identifier used as {company_id} in the tenant test endpoint. |
Test tenant retrievalDirect link to Test tenant retrieval
-
Select Test Connection. NIM attempts to retrieve tenant information using:
GET /v1/tenants/{company_id} -
If the test fails, verify the endpoint URLs, client credentials, refresh token, Subscription ID, Company ID, network access, and API authorization.
-
Collect the workforce data required by your process and confirm that the expected company records are present.
-
Validate identity matching and field mappings before using the data for downstream user provisioning.
The connection test checks tenant retrieval. Validate other collections and field access required by your process separately.