CheckAI: Self-Service Support for Partners

How to Access CheckAI

CheckAI Actions

• Company (Ex. com_abc23456789)
• Get - Look up company setup (legal name, business type, phone, pay frequency, address, start date, default bank account, tax activation date) and status (onboarding status, standing, processing period, funding failure strikes)
• Create - Create a new company with legal name, EIN, and address
• Update - Modify an existing company's information

• Employee (Ex. emp_abc23456789)
• Get - Look up employee setup (name, email, date of birth, last four SSN, payment method, start date, active status, residence) and attributes (W-2 consent, earning rates, workplace, company). You can share multiple employee IDs (comma separated) to look up information in bulk.
• List - List all employees for a given company, with filters for workplace and active status
• Create - Create a new employee for a company
• Update - Modify an existing employee's information (e.g., name, address, payment method)

• Contractor (Ex. ctr_abc23456789)
• Get - Look up contractor setup (name, email, business name, payment method, start date, active status, residence)
• List - List all contractors for a given company
• Create - Create a new contractor for a company
• Update - Modify an existing contractor's information

• Payroll (Ex. pay_abc23456789)
• Get - Look up payroll details (pay period, check date, approval deadline, status, totals, associated company)

• Payment (Ex. pmt_abc23456789)
• Get - Look up payment details (amount, status, direction, payment method, associated payroll)
• List - List all payments for a given company

• Workplace (Ex. wrk_abc23456789)
• Get - Look up workplace details (name, address, associated company)
• List - List all workplaces for a given company
• Create - Create a new workplace with address details
• Update - Modify an existing workplace's address or details

• Bank Account
• Get - Look up bank account details
• List - List all bank accounts, optionally filtered by company, employee, or contractor
• Create - Add a bank account for a company, employee, or contractor
• Update - Modify a bank account for a company, employee, or contractor

• Earning Code
• Get - Look up a specific earning code
• List - List earning codes, optionally filtered by company
• Create - Create a new earning code for a company
• Update - Modify an existing earning code

• Earning Rate
• Get - Look up a specific earning rate
• List - List earning rates, optionally filtered by employee or active status
• Create - Create a new earning rate for an employee
• Update - Modify an existing earning rate

• Company Benefit
• Get - Look up a specific company benefit
• List - List company benefits, optionally filtered by company
• Create - Create a new company benefit with default contribution and settings
• Update - Modify an existing company benefit
• Delete - Delete a company benefit

• Employee Benefit
• Get - Look up a specific employee benefit
• List - List employee benefits, optionally filtered by employee
• Create - Create a new employee benefit
• Update - Modify an existing employee benefit
• Delete - Delete an employee benefit

• Post-Tax Deduction
• Get - Look up a specific post-tax deduction
• List - List post-tax deductions, optionally filtered by employee
• Create - Create a new post-tax deduction for an employee
• Update - Modify an existing post-tax deduction
• Delete - Delete a post-tax deduction

• Pay Schedule
• Get - Look up a specific pay schedule
• List - List pay schedules, optionally filtered by company
• Create - Create a new pay schedule for a company
• Update - Modify an existing pay schedule
• Delete - Delete a pay schedule

• Paydays
• Get - Look up paydays and their corresponding period start, period end, and approval deadline dates

• Tax Filing
• Get - Look up a specific tax filing by ID
• List - List tax filings for a given company

• Address Validation
• Validate - Validate an address using Check's address validation engine

• Net Pay Split
• Get - Look up a specific net pay split
• List - List net pay splits, optionally filtered by employee or contractor
• Create - Create a new net pay split with bank account allocation rules

• Documents
• Company Tax Documents - List or get company tax documents
• Company Authorization Documents - List or get company authorization documents
• Employee Tax Documents - List or get employee tax documents, with optional employee or company filters
• Contractor Tax Documents - List or get contractor tax documents, with optional contractor or company filters
• Setup Documents - List or get setup documents

• Company Provided Documents
• Get - Look up a specific company provided document
• List - List company provided documents, optionally filtered by company
• Create - Create a new company provided document in a pending state (file must be uploaded separately)

• Forms
• List - List tax forms available for employee withholdings
• Get - Look up a specific form and its parameters
• Render - Render a tax form with provided values (returns a PDF)
• Validate - Validate form values without rendering; returns validation errors if invalid

• Tax Elections
• Company Tax Elections - List, create, or update company tax elections
• Employee Tax Elections - List or update employee tax elections

• Setups
• Get - Look up a specific setup link and its status
• List - List setup links, optionally filtered by company

• Requirements
• Get - Look up a specific requirement and its current status
• List - List requirements, optionally filtered by company, employee, or status

• Notifications
• Get - Look up a specific notification
• List - List notifications, optionally filtered by company or status

• Signatories
• List - List signatories for a given company
• Create - Create a new signatory (authorized person for tax filing purposes) with name, title, and email

• Reports
• Payroll Journal - Fetch the payroll journal report for a company, with optional date range or payroll filter
• Payroll Summary - Fetch the payroll summary report for a company, with optional date range or payroll filter
• Tax Liabilities - Fetch the tax liabilities report for a company, with optional date range filter
• Contractor Payments - Fetch the contractor payments report for a company, with optional date range filter
• W-2 Preview - Fetch the W-2 preview report for a company, with optional year filter
• W-4 Exemption Status - Fetch the W-4 exemption status report for a company
• Applied-for IDs - Fetch the applied-for tax IDs report for a company
• Cash Requirement - Fetch the cash requirement report for a specific payroll
• Paper Checks - Fetch the paper checks report for a specific payroll

• Support Ticket
• Create - If CheckAI is unable to resolve your question, it will prompt you to create a Support ticket for further assistance

How Actions Work

1. You ask a question or request an action — For example, "Can you look up company com_abc123?" or "Create a new employee for this company."

2. CheckAI looks up data or prepares the action — For read operations (lookups), CheckAI retrieves the data and presents it in the conversation. For write operations (create, update, delete), CheckAI presents a confirmation form with the details it will submit.

3. You confirm write actions — Before any data is created, updated, or deleted, CheckAI asks you to review and confirm the details. Nothing is changed until you approve.

4. CheckAI executes the action — The operation runs using your Console session permissions, so you can only affect the companies and records your account has access to.

5. If CheckAI can't help — When a question is outside its knowledge or an action isn't supported, CheckAI will let you know and offer to create a support ticket to escalate to Check's support team.

Instant Answers

Tips for Getting the Best Results

• Be specific — Include IDs when possible (e.g., "Look up employee emp_abc123" rather than "Look up an employee").

• One request at a time — CheckAI works best when handling a single question or action per message.

• Provide context — If you're troubleshooting, describe what you expected to happen vs. what actually happened.

• Use it for common tasks — Creating companies, employees, contractors, workplaces, and bank accounts can all be done directly through CheckAI, saving you time compared to navigating the Console or writing API calls.

When to Contact Support

• Bank account or Social Security number report requests

• Specific payment concerns or adjustments

• Detailed tax calculations or complex tax questions

• Filing amendments or making corrections

• Tax exemptions

• Responding to tax notices

Frequently Asked Questions