Overview
To authenticate with Paycom, you need:
- SID - This is your Client Company Identifier (often referred to as the Client Code or Company ID) provided by Paycom. It uniquely identifies your organization within Paycom.
- API Token - This is a secure token generated by Paycom that, when used with your SID, authorizes your API requests.
This guide will walk you through obtaining your credentials within Paycom.
Prerequisites:
- You must have an account with Paycom.
Instructions:
Step 1: Finding Your Credentials
- Sign in to your Paycom account.
- Navigate to Source > Main data source.
- Copy both your SID and API Token.
Step 2: Whitelist our IP Address to whitelist
100.20.92.101
44.225.181.72
44.227.217.144
Step 3: Enter credentials in the Connect UI
Once you have both your SID and API Token:
- Open the form on AllVoices to authenticate with Paycom.
- Enter your SID and API Token in their respective fields.
- Submit the form, and you should be successfully authenticated.
Fields that will be pulled in
Field |
Value Type |
| id | string |
| firstName | string - Required |
| lastName | string |
| string - Required | |
| displayName | string |
| employeeNumber | string (optional) |
| title | string |
| department.id | string |
| department.name | string |
| employmentType | 'FULL_TIME' | 'PART_TIME' | 'CONTRACTOR' | 'INTERN' | 'TEMPORARY' | 'OTHER' |
| employmentStatus | 'ACTIVE' | 'TERMINATED' | 'ON_LEAVE' | 'SUSPENDED' | 'PENDING' |
| startDate | string (ISO date) |
| terminationDate | string (ISO date, optional) |
| manager.id | string (optional) |
| manager.firstName | string (optional) |
| manager.lastName | string (optional) |
| manager.email | string (optional) |
| workLocation.name | string |
| workLocation.type | 'OFFICE' | 'REMOTE' | 'HYBRID' |
| workLocation.primaryAddress.street | string (optional) |
| workLocation.primaryAddress.city | string (optional) |
| workLocation.primaryAddress.state | string (optional) |
| workLocation.primaryAddress.country | string (optional) |
| workLocation.primaryAddress.postalCode | string (optional) |
| workLocation.primaryAddress.type | 'WORK' | 'HOME' (optional) |
| addresses[].street | string |
| addresses[].city | string |
| addresses[].state | string |
| addresses[].country | string |
| addresses[].postalCode | string |
| addresses[].type | 'HOME' | 'WORK' |
| phones[].type | 'WORK' | 'HOME' | 'MOBILE' |
| phones[].number | string |
| emails[].type | 'WORK' | 'PERSONAL' |
| emails[].address | string |
| createdAt | string |
| updatedAt | string |
Paycom Specific fields that will be pulled:
Paycom Specific Field |
| actual_marital_status |
| actual_marital_status_description |
| age |
| available_health_insurance |
| birth_date |
| clocksequencenumber |
| cobra_end |
| cobra_start |
| comission_only |
| current_key_employee |
| custom_standard_hours |
| eeoc_class |
| eeoc_class_description |
| ee_message |
| eligible_401k |
| emergency_1_contact |
| emergency_1_phone |
| emergency_1_relationship |
| emergency_2_contact |
| emergency_2_phone |
| emergency_2_relationship |
| emergency_3_contact |
| emergency_3_phone |
| emergency_3_relationship |
| employee_gl_code |