### Create a Payroll Source: https://docs.checkhq.com/docs/quickstart Example request to create a payroll. ```bash curl -X POST \ https://sandbox.checkhq.com/payrolls \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ' \ -d '{ \ "company": "", \ "period_start": "", \ "period_end": "", \ "payday": "", \ }' ``` -------------------------------- ### Create Payroll Items Source: https://docs.checkhq.com/docs/quickstart This example demonstrates how to create payroll items in bulk by making a POST request to the /payroll_items endpoint. ```bash curl -X POST \ 'https://sandbox.checkhq.com/payroll_items' \ -H 'Authorization: Bearer ' -d '{ "payroll": "pay_1234567890abcdef", "employee": "emp_1234567890abcdeg", "earnings": [ { "type": "hourly", "workplace": "wrk_1234567890abcdef", "amount": "390.00", "hours": 40 } ], "reimbursements": [ { "amount": "50.00", "description": "Travel expenses" } ] }, { "payroll": "pay_1234567890abcdef", "employee": "emp_1234567890abcdeg", "earnings": [ { "type": "salary", "workplace": "wrk_0987654321fedcba", "amount": "1500.00" } ] }' ``` -------------------------------- ### Create a Contractor for Payroll Item Source: https://docs.checkhq.com/docs/quickstart This example shows how to create a contractor by making a POST request to the /payrolls/contractors endpoint. ```bash curl -X POST \ 'https://sandbox.checkhq.com/payrolls/contractors' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ' \ -d '{ "id": "ctr_l4uXhJTcQvPiWorVAtca", "type": "individual", "company": "com_Y6FUq2d9pYOtqfae1aP2", "workplaces": [ "wrk_gXfqxWUV12fE7xP6AVXQ" ], "primary_workplace": "wrk_gXfqxWUV12fE7xP6AVXQ", "first_name": "Steve", "middle_name": null, "last_name": "Rogers", "business_name": null, "dob": "1970-05-29", "start_date": "2019-03-01", "termination_date": null, "email": null, "bank_accounts": [], "ssn_last_four": null, "ssn_validation_status": null, "payment_method_preference": null, "default_net_pay_split": null, "onboard": { "status": "blocking", "blocking_steps": [ "address" ], "remaining_steps": [ "ssn", "address", "payment_method" ], "ssn": [ "ssn_submitted", "ssn_validated" ], "payment_method": [ "payment_method_preference_set", "bank_account_exists", "bank_account_verified" ], "address": [ "address_submitted" ] }, "ein": null, "address": { "line1": null, "line2": null, "city": null, "state": null, "postal_code": null, "country": "US" }, "metadata": {}, "1099_nec_electronic_consent_provided": false } ``` -------------------------------- ### Synchronous Preview Payroll Request Source: https://docs.checkhq.com/docs/quickstart This example shows how to make a synchronous request to preview a payroll, including payroll items and contractor payments. ```bash curl -X GET \ 'https://sandbox.checkhq.com/payrolls//preview?include_items=true?include_contractor_payments=true' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ' ``` -------------------------------- ### Asynchronous Preview Payroll Request Source: https://docs.checkhq.com/docs/quickstart This example demonstrates how to make an asynchronous request to preview a payroll, which is necessary for payrolls with more than 500 items. It also includes a sample JSON payload. ```bash curl -X GET \ 'https://sandbox.checkhq.com/payrolls//preview?async=true' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ' \ -d '{ "id": "pay_bQbbxLQeghmGG7W5HxeY", "company": "com_dFmjg0e9SqJZb9WYEyag", "period_start": "2019-06-16", "period_end": "2025-11-14", "approval_deadline": "2025-11-29T01:00:00Z", "reopen_deadline": null, "approved_at": null, "payday": "2025-11-28", "status": "draft", "managed": true, "type": "regular", "pay_frequency": "biweekly", "pay_schedule": null, "funding_payment_method": "ach", "processing_period": "three_day", "off_cycle_options": null, "is_void": false, "totals": null, "metadata": {}, "warnings": [], "bank_account": "bnk_fpwKprUwnYj9lAbG5KNh", "simulation_mode": "automatic", "preview": { "messages": null, "status": "calculating", "started_at": "2025-11-18T02:41:08.194789Z" } }' ``` -------------------------------- ### Add Contractors to Payroll Items Source: https://docs.checkhq.com/docs/quickstart This example demonstrates how to add a contractor payment to an existing payroll by making a POST request to the /payrolls/contractor_payments endpoint. ```bash curl -X POST \ 'https://sandbox.checkhq.com/payrolls/contractor_payments' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ' \ -d '{ "payroll": "pay_1234567890abcdef", "contractor": "ctr_XyZ1234567890abc", "payment_method": "manual", "amount": "500.00", "reimbursement_amount": "75.00" }' ``` -------------------------------- ### Example: Fetching all employees on a payroll Source: https://docs.checkhq.com/docs/bulk-resource-get-requests This example demonstrates how to fetch multiple employee details using the bulk GET request functionality after retrieving payroll items. ```json { "id": "pay_abc123", "items": [ { "id": "itm_pqngIDA674QGlxaq3FCE", "payroll": "pay_lpeGFBOknAdXfSArMMnB", "employee": "emp_aaa111", "net_pay": "123.45", ... }, { "id": "itm_ZSyIVUmBkr8aKEMj9JS2", "payroll": "pay_lpeGFBOknAdXfSArMMnB", "employee": "emp_bbb222", "net_pay": "678.90", ... }, { "id": "itm_GkUmHOh4FUWNvW7RQ1p0", "payroll": "pay_lpeGFBOknAdXfSArMMnB", "employee": "emp_ccc333", "net_pay": "987.65", ... }, { "id": "itm_cmmDLIYJEPNv7r1WICDS", "payroll": "pay_lpeGFBOknAdXfSArMMnB", "employee": "emp_ddd444", "net_pay": "432.10", ... } ], ... } ``` ```json { "next": null, "previous": null, "results": [ { "id": "emp_aaa111", "first_name": "First", "last_name": "Employee", ... }, { "id": "emp_bbb222", "first_name": "Second", "last_name": "Employee", ... }, { "id": "emp_ccc333", "first_name": "Third", "last_name": "Employee", ... }, { "id": "emp_ddd444", "first_name": "Fourth", "last_name": "Employee", ... } ] } ``` -------------------------------- ### Redirect URI Callback Example Source: https://docs.checkhq.com/docs/check-oauth-integrations This shows the expected format of the callback request made by Check to the Ecosystem Partner's redirect URI, containing query parameters for authorization. ```http GET "https://integration.partner.com/auth/check/callback?code={code}&company={company}&partner={partner}" Query Parameters: code={code} company={company} partner={partner} Expected Response: None Status: 200 ``` -------------------------------- ### Example commands Source: https://docs.checkhq.com/docs/check-command-line-interface-cli Examples of common Check CLI commands. ```shell # List all companies check companies list # Get a specific company check companies get com_xxxxx # List employees in table format check employees list --company com_xxxxx --format table # Preview a payroll before approving check payrolls preview prl_xxxxx # Approve a payroll check payrolls approve prl_xxxxx # Get W-4 tax parameters for an employee check tax params list --employee emp_xxxxx ``` -------------------------------- ### Example: reassigning employees to new workplaces Source: https://docs.checkhq.com/docs/batching-edits Example: reassigning employees to new workplaces ```python async def reassign_employees(assignments: dict[str, str]): items = [ (emp_id, {"workplaces": [workplace_id]}) for emp_id, workplace_id in assignments.items() ] return await run_batch(items, patch_employee) results = asyncio.run( reassign_employees({ "emp_a8Bk2jQ9xLmN4pRsYv0T": "wrk_jK5lN8mQpS3uW7xZbC0f", "emp_cD3fG7hJkW1nP5qUzX8b": "wrk_rT6uV9wXyA2bD4eGhI1k", "emp_eF6gH9iMoR2sV4tYwA1d": "wrk_mN3oP6qRsU8vW0xYzB5c", }) ) ``` -------------------------------- ### Install uv package manager Source: https://docs.checkhq.com/docs/check-command-line-interface-cli Installs the uv package manager on Mac/Linux and Windows. ```shell # Mac / Linux curl -LsSf https://astral.sh/uv/install.sh | sh # Windows powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex" ``` -------------------------------- ### Example list response Source: https://docs.checkhq.com/docs/forms-api This is an example of the JSON response when listing available forms. ```json { "next": null, "previous": null, "results": [ { "id": "frm_ntKOaUm6qIJabIBmqLXU", "description": "Federal I-9", "link": "https://www.uscis.gov/system/files_force/files/form/i-9-paper-version.pdf", "revision_date": "2019-10-21" }, { "id": "frm_FBt3oC1x28IrZELkhb21", "description": "Federal W-4", "link": "https://www.irs.gov/pub/irs-pdf/fw4.pdf", "revision_date": "2020-01-01" }, { "id": "frm_j7NxXAhh4ZlAsJ6tbP1A", "description": "California DE-4", "link": "https://www.edd.ca.gov/pdf_pub_ctr/de4.pdf", "revision_date": "2020-02-01" }, ... ] } ``` -------------------------------- ### Example response for creating an employee benefit Source: https://docs.checkhq.com/docs/defining-benefits Example JSON response after creating an employee benefit. ```json { "id": "ben_QI3vs3213G34AZcwnrFS5", "employee": "emp_FZEOSqW0QTKcE1iVU1C5", "benefit": "401k", "company_benefit": "cbn_QI3vspnG34jAZcwnrFS5", "description": "Riddler Car Repair 401k", "effective_start": "2021-05-01", "effective_end": null, "company_contribution_amount": null, "company_contribution_percent": 5.5, "employee_contribution_amount": "5.00", "employee_contribution_percent": null, } ``` -------------------------------- ### Get a workplace request Source: https://docs.checkhq.com/docs/reciprocity This is an example of a GET request to retrieve workplace information. ```curl curl https://sandbox.checkhq.com/workplaces/wrk_i8nfu8234r8dkjhzlsdv ``` -------------------------------- ### Get an employee request Source: https://docs.checkhq.com/docs/reciprocity This is an example of a GET request to retrieve employee information. ```curl curl GET https://sandbox.checkhq.com/employees/emp_RUDsAQ5OPVpc6o0uh9JW ``` -------------------------------- ### Get reciprocity elections request Source: https://docs.checkhq.com/docs/reciprocity This is an example of a GET request to retrieve an employee's reciprocity elections. ```curl curl GET https://sandbox.checkhq.com/employees/emp_RUDsAQ5OPVpc6o0uh9JW/reciprocity_elections ``` -------------------------------- ### Employee Onboarding Example Source: https://docs.checkhq.com/docs/check-command-line-interface-cli An example demonstrating the employee onboarding process using the CLI, from creating an employee to checking their forms. ```bash # Create an employee check employees create \ --company com_xxxxx \ --first-name Jane \ --last-name Doe \ --email jane@example.com \ --start-date 2026-02-01 # Onboard them check employees onboard emp_xxxxx # Check their forms check employees list-forms emp_xxxxx ``` -------------------------------- ### Webhooks Examples Source: https://docs.checkhq.com/docs/check-command-line-interface-cli Examples for managing webhooks using the CLI, including listing configurations, creating new ones, and testing them. ```bash # List webhook configs check webhooks list-configs # Create a webhook check webhooks create-config \ --url https://example.com/webhooks \ --environment sandbox # Test it check webhooks ping-config whc_xxxxx ``` -------------------------------- ### Example Requests for Employee Tax Statements Source: https://docs.checkhq.com/docs/employee-tax-statements Examples of GET requests to the employee_tax_statements endpoint with various query parameters. ```http GET /employee_tax_statements?employee=emp_123 GET /employee_tax_statements?company=com_123&publication_status=draft GET /employee_tax_statements?company=com_123&publication_status=published GET /employee_tax_statements?company=com_123&type=original ``` -------------------------------- ### Get Payroll Request to Fetch Results Source: https://docs.checkhq.com/docs/payroll-preview-and-approval This is an example of a GET request to the /payrolls/:id endpoint, used to fetch payroll details, especially after an asynchronous preview calculation is complete. ```Shell curl -X GET 'https://sandbox.checkhq.com/payrolls/>' ``` -------------------------------- ### Get a workplace response Source: https://docs.checkhq.com/docs/reciprocity This is an example response for retrieving workplace information, including the work state. ```json { "id": "wrk_i8nfu8234r8dkjhzlsdv", "name": "Pennsylvania Office", "address": { "line1": "526 Market St", "line2": null, "city": "Philadelphia", "state": "PA", "postal_code": "19106", "country": "US" }, "company": "com_sx3svU6K8c5ZkSFlOh5p", "active": true, "metadata": {} } ``` -------------------------------- ### Get an employee response Source: https://docs.checkhq.com/docs/reciprocity This is an example response for retrieving employee information, including their residence state. ```json { "id": "emp_RUDsAQ5OPVpc6o0uh9JW", "first_name": "Gilly", "last_name": "Hopkins", "middle_name": null, "email": "gilly@crowell.org", "dob": "1978-03-28", "bank_accounts": [], "ssn_last_four": "1234", "payment_method_preference": "manual", "active": true, "onboard": { "status": "completed", "blocking_steps": [], "remaining_steps": [] }, "workplaces": ["wrk_i8nfu8234r8dkjhzlsdv"], "company": "com_sx3svU6K8c5ZkSFlOh5p", "start_date": "2019-03-01", "default_net_pay_split": "nps_lk218jk9082mjkjljT1c", "residence": { "line1": "2 S Washington St", "line2": null, "city": "Easton", "state": "MD", "postal_code": "21601", "country": "US" }, "w2_electronic_consent_provided": false, "metadata": {} } ``` -------------------------------- ### Example Request to Create Payroll Items Source: https://docs.checkhq.com/docs/payroll-preview-and-approval This example shows how to create payroll items in bulk by making a POST request to the /payroll_items endpoint. ```shell curl -X POST 'https://sandbox.checkhq.com/payroll_items' -d '[ { "payroll": "pay_1234567890abcdef", "employee": "emp_1234567890abcdef", "earnings": [ { "type": "hourly", "workplace": "wrk_1234567890abcdef", "amount": "390.00", "hours": 40 } ], "reimbursements": [ { "amount": "50.00", "description": "Travel expenses" } ] }, { "payroll": "pay_1234567890abcdef", "employee": "emp_1234567890abcdef", "earnings": [ { "type": "salary", "workplace": "wrk_0987654321fedcba", "amount": "1500.00" } ] } ]' ``` -------------------------------- ### Get reciprocity elections response Source: https://docs.checkhq.com/docs/reciprocity This is an example response for retrieving reciprocity elections, showing which states are applicable and if the employee has opted in. ```json { "next": null, "previous": null, "results": [ { "opt_in": true, "effective_start": "1900-01-01", "jurisdiction": "jur_kVjigoeAzs9NzTsfY4SL", "jurisdiction_name": "Pennsylvania", "applicable": true }, { "opt_in": null, "effective_start": null, "jurisdiction": "jur_PskWgKMZZcPjjiP0sXv8", "jurisdiction_name": "West Virginia", "applicable": false }, { "opt_in": null, "effective_start": null, "jurisdiction": "jur_uCEMiU94k034539Ua04Y", "jurisdiction_name": "Virginia", "applicable": false } ] } ``` -------------------------------- ### Example Request to Create Contractor Payments Source: https://docs.checkhq.com/docs/payroll-preview-and-approval This example shows how to create contractor payments in bulk by making a POST request to the /contractor_payments endpoint. ```shell curl -X POST 'https://sandbox.checkhq.com/contractor_payments' -d '[ { "payroll": "pay_1234567890abcdef", "contractor": "ctr_XyZ1234567890abc", "payment_method": "manual", "amount": "500.00", "reimbursement_amount": "75.00" }, { "payroll": "pay_1234567890abcdef", "contractor": "ctr_LmNoPqRsTuVwXyZ123", "payment_method": "direct_deposit", "amount": "800.00" } ]' ``` -------------------------------- ### Payroll Workflow Example Source: https://docs.checkhq.com/docs/check-command-line-interface-cli A step-by-step example of the payroll workflow using the CLI, including creating a payroll, adding items, previewing, and approving. ```bash # Create a payroll check payrolls create \ --company com_xxxxx \ --period-start 2026-01-01 \ --period-end 2026-01-15 \ --payday 2026-01-20 # Add a payroll item check payroll-items create \ --payroll prl_xxxxx \ --employee emp_xxxxx \ --earnings '[{"amount":"5000.00","earning_code":"ec_xxxxx"}]' # Preview the payroll check payrolls preview prl_xxxxx # Approve it check payrolls approve prl_xxxxx # Simulate processing (sandbox only) check payrolls simulate-start-processing prl_xxxxx check payrolls simulate-complete-funding prl_xxxxx check payrolls simulate-complete-disbursements prl_xxxxx ``` -------------------------------- ### Example Request to Create a Payroll with include_items and include_contractor_payments Source: https://docs.checkhq.com/docs/payroll-preview-and-approval This example demonstrates creating a payroll along with its payroll items and contractor payments using the include_items and include_contractor_payments flags. ```shell curl -X POST 'https://sandbox.checkhq.com/payrolls?include_items=true&include_contractor_payments=true' -d '{ "company": "com_1234567890abcdef", "period_start": "2024-12-01", "period_end": "2024-12-06", "payday": "2024-12-13", "items": [ { "employee": "emp1234567890abcdef", "earnings": [ { "type": "hourly", "workplace": "wrk_1234567890abcdef", "amount": "390.00", "hours": 40 } ] } ], "contractor_payments": [ { "contractor": "ctr_LmNoPqRsTuVwXyZ123", "payment_method": "direct_deposit", "amount": "800.00" } ] }' ``` -------------------------------- ### Create Payroll with Included Items and Contractor Payments Source: https://docs.checkhq.com/docs/quickstart API request to create a payroll with optional flags to include payroll items and contractor payments. ```bash curl -X POST \ 'https://sandbox.checkhq.com/payrolls?include_items=true&include_contractor_payments=true' \ -H 'Authorization: Bearer ' \ -d '{ \ "id": "pay_bQbbxLQeghmGG7W5HxeY", \ "company": "com_dFmjg0e9SqJZb9WYEyag", \ "period_start": "2019-06-16", \ "period_end": "2025-11-14", \ "approval_deadline": "2025-11-29T01:00:00Z", \ "reopen_deadline": null, \ "approved_at": null, \ "payday": "2025-11-28", \ "status": "draft", \ "managed": true, \ "type": "regular", \ "pay_frequency": "biweekly", \ "pay_schedule": null, \ "funding_payment_method": "ach", \ "processing_period": "three_day", \ "off_cycle_options": null, \ "totals": null, \ "items": [ \ { \ "id": "itm_PlLfuNmPzd9NmR5ENQK2", \ "payroll": "pay_bQbbxLQeghmGG7W5HxeY", \ "employee": "emp_TB70nh2y9OZh8tGm9hP0", \ "status": "draft", \ "void_of": null, \ "voided_by": null, \ "payment_method": "manual", \ "supplemental_tax_calc_method": "aggregate", \ "pto_balance_hours": null, \ "sick_balance_hours": null, \ "state_covid_sick_balance_hours": null, \ "net_pay": null, \ "net_pay_split": null, \ "earnings": [ \ { \ "amount": "5384.61", \ "piece_units": null, \ "hours": 40.0, \ "type": "regular", \ "code": null, \ "description": null, \ "earning_code": null, \ "earning_rate": null, \ "workplace": "wrk_Vt1s0wIPTpEbolesJwzj", \ "tip_credit_amount": null, \ "metadata": {} \ } \ ], \ "reimbursements": [], \ "taxes": null, \ "benefits": null, \ "benefit_overrides": [], \ "post_tax_deductions": null, \ "post_tax_deduction_overrides": [], \ "warnings": null, \ "paper_check_number": null, \ "paystub_info": {}, \ "metadata": {} \ } \ ], \ "contractor_payments": [], \ "is_void": false, \ "metadata": {}, \ "warnings": [], \ "bank_account": "bnk_fpwKprUwnYj9lAbG5KNh", \ "simulation_mode": "automatic", \ "preview": null \ }' ``` -------------------------------- ### Create a payroll Source: https://docs.checkhq.com/docs/payroll-preview-and-approval Example request to create a payroll object. ```shell curl -X POST 'https://sandbox.checkhq.com/payrolls' -d '{ "company": "com_1234567890abcdef", "period_start": "2024-12-01", "period_end": "2024-12-06", "payday": "2024-12-13" }' ``` -------------------------------- ### Reports Examples Source: https://docs.checkhq.com/docs/check-command-line-interface-cli Examples of generating various reports using the CLI, including payroll journal, tax liabilities, and W-2 preview. ```bash # Payroll journal check companies get-payroll-journal-report com_xxxxx \ --start-date 2026-01-01 --end-date 2026-03-31 # Tax liabilities check companies get-tax-liabilities-report com_xxxxx \ --start-date 2026-01-01 --end-date 2026-03-31 # W-2 preview check companies get-w2-preview-report com_xxxxx --year 2025 ``` -------------------------------- ### Switching to Production Environment Source: https://docs.checkhq.com/docs/check-command-line-interface-cli Demonstrates how to switch the CLI to use the production environment, either via a flag, an environment variable, or by setting the API base URL and key directly. ```shell # Via flag check --env production payrolls list # Via environment variable export CHECK_ENV=production check payrolls list # Or set the base URL directly export CHECK_API_BASE_URL=https://api.checkhq.com export CHECK_API_KEY=your-production-api-key ``` -------------------------------- ### Authorize Ecosystem Partner Access Source: https://docs.checkhq.com/docs/check-oauth-integrations This is an example of the request a Check Partner must make to grant an Ecosystem Partner access to a specific company's data. ```curl curl \ -H "Authorization: Bearer " \ "https://sandbox.checkhq.com/integrations/partners/{integration_id}/authorize" -d '{ "integration_permission": "{integration_permission_id}", "company": "{company_id}", "tos_timestamp": "{timestamp_of_tos_signature}", "product_purchase_timestamp": "{timestamp_of_product_purchase}" }' ``` -------------------------------- ### Create an employee benefit that inherits from a company benefit Source: https://docs.checkhq.com/docs/defining-benefits This example defines an employee benefit that overrides the default employee contribution amount and effective start in the company benefit it inherits from. ```bash curl -X POST \ https://sandbox.checkhq.com/benefits \ -H 'Authorization: Bearer YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{ "employee":"emp_FZEOSqW0QTKcE1iVU1C5", "company_benefit": "cbn_QI3vspnG34jAZcwnrFS5", "employee_contribution_amount": "5", "effective_start": "2021-05-01", "description": "Riddler Car Repair 401k" }' ``` -------------------------------- ### Create a company Source: https://docs.checkhq.com/docs/quickstart The first action is to create a company, the employer that is paying employees. Each company is a separate tax entity to tax agencies and has one federal Employer Identification Number (EIN). ```cURL curl -X POST \ https://sandbox.checkhq.com/companies \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ' \ -d '{ "address": { "line1": "20 W 34th St", "postal_code": "10001", "city": "New York", "state": "NY" }, "start_date": "2020-05-20", "trade_name": "Good Web Design", "legal_name": "Good Web Design, Inc." }' ``` -------------------------------- ### Approve Payroll Request Source: https://docs.checkhq.com/docs/quickstart This cURL command demonstrates how to approve a payroll after it has been previewed. ```bash curl -X POST \ 'https://sandbox.checkhq.com/payrolls//approve' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ' ``` -------------------------------- ### Handling PostMessage Events from Benbase Iframe Source: https://docs.checkhq.com/docs/check-benbase-integration-guide JavaScript code to listen for and handle postMessage events sent from the Benbase iframe, such as resizing and authorization start signals. ```javascript window.addEventListener("message", (event) => { if (event.data.type === "benbase-embed.height-updated") { // Resize the iframe to match the content height const iframe = document.getElementById("benbase-employer-frame"); iframe.style.height = event.data.height + "px"; } if (event.data.type === "benbase-embed.authorize-start") { // The employer is ready to connect payroll — proceed to Step 2 } }); ``` -------------------------------- ### Initialize npm project and install dependencies Source: https://docs.checkhq.com/docs/adding-check-onboard-to-your-application Initializes a new npm project and installs Express and http-proxy-middleware. ```shell npm init --yes npm install --save express http-proxy-middleware ``` -------------------------------- ### Company onboard object Source: https://docs.checkhq.com/docs/onboard-status Example of a company's onboard object when it is blocking for all three steps, with remaining tax setup and filing authorization required in both Federal and New York jurisdictions. ```json { "status": "blocking", "blocking_steps": [ "bank_account", "setup_parameters", "filing_authorization" ], "remaining_steps": [ "bank_account", "setup_parameters", "filing_authorization" ], "bank_account": [ "bank_account_exists", "bank_account_verified", "bank_account_debit_authorization_submitted" ], "setup_parameters": [ { "id": "jur_NvIot3gvbIitui4Vmy9Z", "name": "Federal", "status": "blocking" }, { "id": "jur_87N4QWPZ38kDSvkqAI7D", "name": "New York", "status": "blocking" }, ], "filing_authorization": [ { "id": "frm_ozhx2ezrVsd2k2ScL7HU", "name": "Federal Form 8655", "status": "blocking" }, { "id": "frm_Iee3dIFvT1uBUYJ4PG7z", "name": "New York TR-2000", "status": "blocking" }, { "id": "frm_Y43LpYf60wEf3bCaN9Rn", "name": "New York TR-579-WT", "status": "blocking" }, ], } ``` -------------------------------- ### Clone repo and install dependencies Source: https://docs.checkhq.com/docs/check-command-line-interface-cli Clones the MCP Server & CLI repository and installs dependencies using uv. ```bash git clone https://github.com/check-technologies/mcp-server-check.git cd mcp-server-check uv sync ``` -------------------------------- ### Get all active integrations or status for a single company Source: https://docs.checkhq.com/docs/check-guideline-integration-guide This endpoint lists all active integrations. The `company` query parameter can be used to retrieve the status for a single company. ```json https://sandbox.checkhq.com/integrations/accesses?company={companyID} ``` -------------------------------- ### Create a one-time benefit Source: https://docs.checkhq.com/docs/defining-benefits This example defines a one-time employee-only contribution of $125 to a section 125 Dental plan. The effective start and effective end dates are the same day. The benefit will be applied to an employee if they have a payroll item on a payroll with a payday of '2021-04-01'. ```bash curl -X POST \ https://sandbox.checkhq.com/benefits \ -H 'Authorization: Bearer YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{ "employee":"emp_FZEOSqW0QTKcE1iVU1C5", "benefit": "125_dental", "company_contribution_amount": "0", "employee_contribution_amount": "125", "effective_start": "2021-04-01", "effective_end": "2021-04-01", "description": "Employee Dental Plan Contribution" }' ```