Generate hosted screening links, redirect applicants back to your system, receive callback status updates, and submit payroll reports by API, SFTP, or secure upload each pay period
Call the Generate Screening URL endpoint.
Use the returned URL to launch the hosted survey and e-signature flow.
Send status to the x-callback-url-webhook and return the user through x-return-url.
Check status and qualification by IntegrationID or Confirmation.
Screening Endpoints
Payroll Report Fields
Payroll Delivery Options
Callback Status Support
SEARCH ENDPOINTS AND COPY PATHS FOR IMPLEMENTATION.
| POST |
Create a secure CTI screening UI link for an employee or applicant using partner credentials and optional profile data.
| /tio_ws/rest/screening |
|
Headers x-partnerpassword – Required x-businessid – Required x-locationid – Optional x-callback-url – Optional x-return-url – Optional |
Example
|
Response Result secure screening URL, Code: 200, Message: null |
| POST |
Retrieve survey completion and qualification status using the confirmation number returned after screening is completed.
| /tio_ws/rest/screening/status/{Confirmation} |
|
Headers x-partnerpassword – Required |
Example
|
Response Status: Completed | Incomplete; Qualification; Qualified | Non-Qualified |
| POST |
Retrieve status using the external HRIS employee or applicant identifier supplied when the screening URL was generated.
| /tio_ws/rest/screening/status/{IntegrationID} |
|
Headers x-partnerpassword – Required |
Example
|
Response Status: Completed | Incomplete; Qualification; Qualified | Non-Qualified |
EMPLOYEE DATA FIELDS ACCEPTED BY JSON REQUEST BODY.
| Field | Required | Description |
| FirstName | Optional, preferred | Employee first name |
| LastName | Optional, preferred | Employee last name |
| SSN | Optional, preferred | Employee SSN |
| HireDate | Optional | Employee hire date |
| BirthDate | Optional | Employee birth date |
| JobTitle | Optional | Employee job title |
| HourlyRate | Optional | Employee hourly rate |
| IntegrationID | Optional | Employee ID in external integration system |
| IsApplicant | Optional | Application indicator |
| Optional | Employee email | |
| LocationID | Optional, preferred | Location ID or integration key in TIO |
| Address1, City, State, Zip | Optional | Employee home address |
| Phone | Optional | Employee phone |
Payroll Report RequirementsPay-period report sent as API payload, CSV, or Excel workbook.File name: YYYYMMDD_BUSINESS_VERSION NUMBER Format: CSV with headers and double-quoted fields, or Excel worksheet with one column per field. Dates: MM/DD/YYYY for all date fields. Employee Population: include one record for every employee with non-zero YTD Gross Wages and employees who started after CTI service began. Frequency: preferred each pay period; alternate schedules can be configured. Security: all channels must be encrypted and secured. |
Delivery OptionsWebservives API Submit a structured payroll report payload directly from the payroll or HRIS platform. Use this for near-real-time or automated pay-per delivery. Secure File Transfer Drop the encrypted CSV or Excel file into a configured SFTP location on the agreed pay-period schedule. Portal Upload Manual fallback option for teams that need to upload CSV or Excel files through a secure client portal. |
REQUIRED REPORT COLUMNS FOR PAYROLL INTEGRATION.
| Field | Required | Description |
| Business Name | Required | Legal business name of the company |
| Entity Name | Required | Entity name or FEIN |
| Location ID | Required | Internal store/location number or location name |
| Employee ID | Required | Payroll or HR system employee identifier |
| Social Security Number | Required | Employee 9-digit SSN |
| Last Name | Required | Employee last name |
| First Name | Required | Employee first name |
| Original Date of Hire | Required | Original state-work date in MM/DD/YYYY format |
| Re-Hire Date | If applicable | Latest re-hire date, not the original hire date |
| Termination Date | Required | Latest termination date, when applicable |
| Job Title | Required | Employee position or role |
| Hourly Rate | If applicable | Hourly/pay rate; leave blank for salaried employees |
| Home Address1, City, State, Zip Code | Required | Employee home address, including 5-digit zip |
| Home Address2 | Optional | Employee home address line 2 |
| Birth Date | Required | Employee date of birth in MM/DD/YYYY format |
| Total Gross Wages | Required | Current gross wages earned during the pay period |
| Total Worked Hours | Required | Current hours worked during the pay period |
| YTD Gross Wages | Required | Year-to-date gross wages that would appear on Form W-2 |
| YTD Hours | Required | Year-to-date hours worked |
| Pay Period Start Date | Required | Starting date of the employee pay period |
| Pay Period End Date | Required | Ending date of the employee pay period |
Confirm business ID, partner password, SFTP credentials, API keys, and location mapping strategy for each tenant.
Configure callback and return URLs for each environment, including HTTPS and retry handling.
Normalize dates, phone, SSN, address, applicant flag, and integration ID before submitting.
Validate required headers, MM/DD/YYYY dates, quoted empty strings, non-zero YTD wage population, and pay-period totals.
Confirm payroll file/API cadence for each pay period and document late or corrected report handling.
Keep demo, production, API, and SFTP endpoints separated in confirmation.
Track screening callbacks, payroll delivery receipts, file/API failures, and reconcilation exceptions.
Publish contact, error escalation, samle payloads, and payroll file templates for partner developers.
Agriculture
Architecture
Assisted Living
Construction
Engineering
Food & Beverage
Hospitality
Manufacturing
MEP/HVAC
Oil & Gas
Pharmaceuticals
Restaurants
Retail
Software
Staffing
Winery/ Vineyard