Configure Connection
Paycom guide
Request API access from Paycom, allow the NIM server’s public address, and securely configure the connection.
Before you beginDirect link to Before you begin
To use the Paycom API, your organization must obtain credentials and have its connection origin approved by Paycom.
NIM requires Tenant URL, Username, and Password.
Have the following ready:
- The public IP address or addresses that the NIM server will use to access the Paycom API.
- A contact who can request API access from the Paycom Automation Team.
- A secure location for the API credentials after they are issued.
Request Paycom API accessDirect link to Request Paycom API access
Contact the Paycom Automation Team and provide the public IP address or addresses that will access the API. Request the following credentials:
| Credential | Purpose |
|---|---|
| SID | Identifies your organization’s API connection. |
| Token | Authenticates requests from NIM to Paycom. |
The Paycom API connection will not work until Paycom has approved the supplied public IP address or addresses. If the NIM server’s egress IP changes, contact Paycom to update the approved list.
Configure Paycom in NIMDirect link to Configure Paycom in NIM
- In NIM, add or open the Paycom system.
- Open Connection and enter the following settings.
| NIM setting | Value |
|---|---|
| Tenant URL | The Paycom API tenant address. The public connector defaults to api.paycomonline.net/v4/rest/index.php and adds https://; do not duplicate the prefix. Confirm the address with Paycom for your environment. |
| Username | The SID supplied for API access. |
| Password | The Token supplied by Paycom. |
- Save the system configuration.
Treat the API token as a password. Store it only in approved secret-management locations and do not include it in tickets, email, or documentation.
Validate the connectionDirect link to Validate the connection
-
Select Test Connection. NIM attempts to retrieve employee identifiers using:
GET /api/v1/employeeid?pagesize=1 -
If the connection is rejected, first confirm the SID and token, then verify that the NIM server is using one of the public IP addresses approved by Paycom.
-
Contact the Paycom Automation Team if the IP allowlist or credentials need to be updated.
-
Collect the employee data required by your process and confirm the expected records are present.
-
Validate employee matching and field mappings before using the collected data for downstream user provisioning.
The connection test checks employee identifier retrieval. Validate other collections and field access required by your process separately.