openapi: 3.2.0 info: title: check-api Integrations API version: '2025-01-01' servers: - url: https://sandbox.checkhq.com security: - sec0: [] tags: - name: Integrations paths: /integrations/accesses: get: summary: List Integration Accesses description: Returns a list of Integration Access objects, optionally filtered by company. operationId: list-integration-accesses parameters: - name: company in: query description: ID of the company schema: type: string - name: limit in: query description: Number of records to return. Max is 25 schema: type: string - name: id in: query description: Filter the list to the specified IDs. For more details, check out the [Bulk Get Requests guide](https://docs.checkhq.com/docs/bulk-resource-get-requests). schema: type: array items: type: string responses: '200': description: '200' content: application/json: examples: Result: value: next: https://sandbox.checkhq.com/integrations/accesses?cursor=cD0lNUIlMjIyMDIyLTA4LTI5KzE5JTNBMTQlM0E1Ni45OTU2NDMlMkIwMCUzQTAwJTIyJTJDKyUyMjI0OSUyMiU1RA%3D%3D previous: null results: - id: iac_7tbSM8GtZftxyB6I8Fz8 company: com_mzzhkhIvuWnk0uUj1vmK status: pending metadata: {} integration_permission: ipe_LEqUV3zmAwqq1W4X8Bs1 access_type: POLICY_PURCHASED integration_partner: int_Fffk6nOGSHtuCTirWqlp scope: - company:read - company:retrieve - company:federal_ein_verifications:list - company:federal_ein_verifications:retrieve - workplace:list - workplace:retrieve - employee:list - employee:retrieve - payroll:list - payroll:retrieve - payroll_item:retrieve - integration_access:retrieve - integration_partners:list - integration_partners:retrieve - integration_partners:authorize schema: type: object properties: next: type: string example: https://sandbox.checkhq.com/integrations/accesses?cursor=cD0lNUIlMjIyMDIyLTA4LTI5KzE5JTNBMTQlM0E1Ni45OTU2NDMlMkIwMCUzQTAwJTIyJTJDKyUyMjI0OSUyMiU1RA%3D%3D previous: type: string results: type: array items: type: object properties: id: type: string example: iac_7tbSM8GtZftxyB6I8Fz8 company: type: string example: com_mzzhkhIvuWnk0uUj1vmK status: type: string example: pending metadata: type: object properties: {} integration_permission: type: string example: ipe_LEqUV3zmAwqq1W4X8Bs1 access_type: type: string example: POLICY_PURCHASED integration_partner: type: string example: int_Fffk6nOGSHtuCTirWqlp scope: type: array items: type: string example: company:read '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Integrations /integrations/partners: get: summary: List Integration Partners description: '' operationId: integration-partners parameters: - name: id in: query description: The ID of the Integration Partner schema: type: string responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": \"int_tEENJcAPamBRBmffR0hm\",\n \"name\": \"Hurdlr\",\n \"description\": \"Embedded accounting\"\n }\n ]\n}" schema: type: object properties: next: {} previous: {} results: type: array items: type: object properties: id: type: string example: int_tEENJcAPamBRBmffR0hm name: type: string example: Hurdlr description: type: string example: Embedded accounting '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Integrations /integrations/partners/{integration_partner}: get: summary: Get an Integration Partner description: '' operationId: get-an-integration-partner-copy parameters: - name: integration_partner in: path description: ID of the Integration Partner schema: type: string required: true responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"id\": \"int_tEENJcAPamBRBmffR0hm\",\n \"name\": \"Hurdlr\",\n \"description\": \"Embedded accounting\"\n}" schema: type: object properties: id: type: string example: int_tEENJcAPamBRBmffR0hm name: type: string example: Hurdlr description: type: string example: Embedded accounting '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Integrations /integrations/partners/{integration_partner}/authorize: put: summary: Authorize an Integration Partner description: '' operationId: integration-partners-copy parameters: - name: integration_partner in: path description: ID of the Integration Partner schema: type: string required: true requestBody: content: application/json: schema: type: object required: - company - integration_permission - tos_timestamp - product_purchase_timestamp properties: company: type: string description: ID of the company whose data you want to grant the Integration Partner access to integration_permission: type: string description: ID of the Integration Permission you want to grant to the Integration Partner tos_timestamp: type: string description: The timestamp when the customer consented to a terms of service document consenting to sharing their data with the Integration Partner. Must be an ISO 8601 date-time string, e.g. `2026-07-16T14:30:00Z`. Always include a timezone designator (`Z` or a UTC offset like `-05:00`); a value without one is interpreted in the server's default timezone. product_purchase_timestamp: type: string description: The timestamp when the customer purchased the product offered by the Integration Partner. Must be an ISO 8601 date-time string, e.g. `2026-07-16T14:30:00Z`. Always include a timezone designator (`Z` or a UTC offset like `-05:00`); a value without one is interpreted in the server's default timezone. responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"id\": \"\",\n \"company\": \"com_vQHrDCeILCSuI6hkAPpV\",\n \"status\": \"pending\",\n \"integration_permission\": \"ipe_08auhI2IUXcdtFTtOm7c\",\n \"access_type\": \"test\",\n \"integration_partner\": \"int_Xf90bJAKE9Lf2jVjbgne\",\n \"scope\": [\n \"company:read\"\n ]\n}" schema: type: object properties: id: type: string example: company: type: string example: com_vQHrDCeILCSuI6hkAPpV status: type: string example: pending integration_permission: type: string example: ipe_08auhI2IUXcdtFTtOm7c access_type: type: string example: test integration_partner: type: string example: int_Xf90bJAKE9Lf2jVjbgne scope: type: array items: type: string example: company:read '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Integrations /integrations/permissions: get: summary: List Integration Permissions description: '' operationId: list-integration-permissions parameters: - name: integration_partner in: query description: ID of the Integration Partner schema: type: string - name: id in: query description: Filter the list to the specified IDs. For more details, check out the [Bulk Get Requests guide](https://docs.checkhq.com/docs/bulk-resource-get-requests). schema: type: array items: type: string responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": \"ipe_tIUPIBtjl7QwmWilgzYN\",\n \"access_type\": \"Active\",\n \"integration_partner\": \"int_tEENJcAPamBRBmffR0hm\",\n \"scope\": [\n \"integration_access:retrieve\",\n \"integration_partners:list\",\n \"integration_partners:retrieve\",\n \"integration_partners:authorize\",\n \"company:retrieve\",\n \"employee:list\",\n \"employee:retrieve\",\n \"benefits:list\",\n \"benefits:retrieve\",\n \"benefits:partial_update\",\n \"benefits:create\",\n \"benefits:destroy\",\n \"company_benefit:list\",\n \"company_benefit:retrieve\",\n \"company_benefit:partial_update\",\n \"company_benefit:create\",\n \"company_benefit:destroy\",\n \"post_tax_deduction:list\",\n \"post_tax_deduction:retrieve\",\n \"post_tax_deduction:partial_update\",\n \"post_tax_deduction:create\",\n \"post_tax_deduction:destroy\",\n \"payroll:list\",\n \"payroll:retrieve\",\n \"payroll_item:retrieve\",\n \"earning_rate:list\",\n \"earning_rate:retrieve\",\n \"company_tax_setup:setting:retrieve\"\n ]\n }\n ]\n}" schema: type: object properties: next: {} previous: {} results: type: array items: type: object properties: id: type: string example: ipe_tIUPIBtjl7QwmWilgzYN access_type: type: string example: Active integration_partner: type: string example: int_tEENJcAPamBRBmffR0hm scope: type: array items: type: string example: integration_access:retrieve '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Integrations /integrations/permissions/{integration_permission}: get: summary: Get an Integration Permission description: '' operationId: list-integration-permissions-copy parameters: - name: integration_permission in: path description: ID of the Integration Permission schema: type: string required: true responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"id\": \"ipe_tIUPIBtjl7QwmWilgzYN\",\n \"access_type\": \"Active\",\n \"integration_partner\": \"int_tEENJcAPamBRBmffR0hm\",\n \"scope\": [\n \"integration_access:retrieve\",\n \"integration_partners:list\",\n \"integration_partners:retrieve\",\n \"integration_partners:authorize\",\n \"company:retrieve\",\n \"employee:list\",\n \"employee:retrieve\",\n \"benefits:list\",\n \"benefits:retrieve\",\n \"benefits:partial_update\",\n \"benefits:create\",\n \"benefits:destroy\",\n \"company_benefit:list\",\n \"company_benefit:retrieve\",\n \"company_benefit:partial_update\",\n \"company_benefit:create\",\n \"company_benefit:destroy\",\n \"post_tax_deduction:list\",\n \"post_tax_deduction:retrieve\",\n \"post_tax_deduction:partial_update\",\n \"post_tax_deduction:create\",\n \"post_tax_deduction:destroy\",\n \"payroll:list\",\n \"payroll:retrieve\",\n \"payroll_item:retrieve\",\n \"earning_rate:list\",\n \"earning_rate:retrieve\",\n \"company_tax_setup:setting:retrieve\"\n ]\n}" schema: type: object properties: id: type: string example: ipe_tIUPIBtjl7QwmWilgzYN access_type: type: string example: Active integration_partner: type: string example: int_tEENJcAPamBRBmffR0hm scope: type: array items: type: string example: integration_access:retrieve '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Integrations components: securitySchemes: sec0: type: apiKey in: header name: Authorization x-bearer-format: bearer x-default: YOUR_API_KEY x-readme-fauxas: true x-provenance: method: searched source: https://docs.checkhq.com/reference harvested: '2026-10-14' tool: harvest-readme-openapi.py note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored. assembled_from: - https://docs.checkhq.com/reference/add-filing-blockers.md - https://docs.checkhq.com/reference/approve-a-correction.md - https://docs.checkhq.com/reference/approve-an-external-payroll.md - https://docs.checkhq.com/reference/approve-payroll.md - https://docs.checkhq.com/reference/bulk-get-employee-tax-parameter-settings.md - https://docs.checkhq.com/reference/bulk-get-employee-tax-params.md - https://docs.checkhq.com/reference/bulk-update-employee-tax-parameters.md - https://docs.checkhq.com/reference/cancel-a-payment.md - https://docs.checkhq.com/reference/company-business-details.md - https://docs.checkhq.com/reference/company-checklist-component.md - https://docs.checkhq.com/reference/company-connect-bank-account.md - https://docs.checkhq.com/reference/company-employee-setup.md - https://docs.checkhq.com/reference/company-filing-authorization.md - https://docs.checkhq.com/reference/company-pay-history.md - https://docs.checkhq.com/reference/company-payment-setup.md - https://docs.checkhq.com/reference/company-progress-tracker.md - https://docs.checkhq.com/reference/company-signatory-agreements.md - https://docs.checkhq.com/reference/company-tax-setup.md - https://docs.checkhq.com/reference/company-team-setup.md - https://docs.checkhq.com/reference/company-terms-of-service.md - https://docs.checkhq.com/reference/company-verification-documents.md - https://docs.checkhq.com/reference/contractor-roster.md - https://docs.checkhq.com/reference/create-a-bank-account.md - https://docs.checkhq.com/reference/create-a-company-provided-document.md - https://docs.checkhq.com/reference/create-a-contractor-payment.md - https://docs.checkhq.com/reference/create-a-correction.md - https://docs.checkhq.com/reference/create-a-pay-schedule.md - https://docs.checkhq.com/reference/create-a-payroll-item.md - https://docs.checkhq.com/reference/create-a-post-tax-deduction.md - https://docs.checkhq.com/reference/create-a-report-run.md - https://docs.checkhq.com/reference/create-a-workplace.md - https://docs.checkhq.com/reference/create-an-earning-code.md - https://docs.checkhq.com/reference/create-an-earning-rate.md - https://docs.checkhq.com/reference/create-an-external-payroll.md - https://docs.checkhq.com/reference/create-company-tax-elections.md - https://docs.checkhq.com/reference/create-net-pay-split.md - https://docs.checkhq.com/reference/create-payroll.md - https://docs.checkhq.com/reference/create-the-enrollment-profile.md - https://docs.checkhq.com/reference/credit-limits.md - https://docs.checkhq.com/reference/delete-a-bank-account.md - https://docs.checkhq.com/reference/delete-a-company-benefit.md - https://docs.checkhq.com/reference/delete-a-contractor-payment.md - https://docs.checkhq.com/reference/delete-a-correction.md - https://docs.checkhq.com/reference/delete-a-pay-schedule.md - https://docs.checkhq.com/reference/delete-a-payroll-copy-1.md - https://docs.checkhq.com/reference/delete-a-payroll-item-1.md - https://docs.checkhq.com/reference/delete-a-payroll-item.md - https://docs.checkhq.com/reference/delete-a-payroll.md - https://docs.checkhq.com/reference/delete-a-post-tax-deduction.md - https://docs.checkhq.com/reference/delete-a-webhook-config.md - https://docs.checkhq.com/reference/delete-an-employee-benefit.md - https://docs.checkhq.com/reference/download-a-report-run.md - https://docs.checkhq.com/reference/download-a-setup-document.md - https://docs.checkhq.com/reference/download-a-tax-package.md - https://docs.checkhq.com/reference/employee-roster.md - https://docs.checkhq.com/reference/employee-tax-setup.md - https://docs.checkhq.com/reference/employee-tax-statements-1.md - https://docs.checkhq.com/reference/employee-withholdings-setup.md - https://docs.checkhq.com/reference/filing-preview-component.md - https://docs.checkhq.com/reference/full-service-setup-submission.md - https://docs.checkhq.com/reference/generate-contractor-onboard-link.md - https://docs.checkhq.com/reference/generate-onboard-link.md - https://docs.checkhq.com/reference/get-a-communication.md - https://docs.checkhq.com/reference/get-a-company-filing.md - https://docs.checkhq.com/reference/get-a-contractor-pay-statement.md - https://docs.checkhq.com/reference/get-a-contractor-payment.md - https://docs.checkhq.com/reference/get-a-correction-receipt-download.md - https://docs.checkhq.com/reference/get-a-correction-receipt.md - https://docs.checkhq.com/reference/get-a-correction.md - https://docs.checkhq.com/reference/get-a-form.md - https://docs.checkhq.com/reference/get-a-fulfillment-receipt-2.md - https://docs.checkhq.com/reference/get-a-fulfillment.md - https://docs.checkhq.com/reference/get-a-log.md - https://docs.checkhq.com/reference/get-a-notification.md - https://docs.checkhq.com/reference/get-a-paper-check-2.md - https://docs.checkhq.com/reference/get-a-paper-check.md - https://docs.checkhq.com/reference/get-a-pay-schedule.md - https://docs.checkhq.com/reference/get-a-report-run.md - https://docs.checkhq.com/reference/get-a-setup-document.md - https://docs.checkhq.com/reference/get-a-setup.md - https://docs.checkhq.com/reference/get-a-tax-package.md - https://docs.checkhq.com/reference/get-a-tax.md - https://docs.checkhq.com/reference/get-a-webhook-delivery.md - https://docs.checkhq.com/reference/get-an-agency.md - https://docs.checkhq.com/reference/get-an-earning-code.md - https://docs.checkhq.com/reference/get-an-earning-rate.md - https://docs.checkhq.com/reference/get-an-employees-paystubs.md - https://docs.checkhq.com/reference/get-an-external-payroll.md - https://docs.checkhq.com/reference/get-an-integration-partner-copy.md - https://docs.checkhq.com/reference/get-child-support-payments-report.md - https://docs.checkhq.com/reference/get-company-paydays.md - https://docs.checkhq.com/reference/get-paper-checks-report.md - https://docs.checkhq.com/reference/get-paper-checks.md - https://docs.checkhq.com/reference/get-paydays.md - https://docs.checkhq.com/reference/get-payroll-journal.md - https://docs.checkhq.com/reference/get-payroll.md - https://docs.checkhq.com/reference/integration-partners-copy.md - https://docs.checkhq.com/reference/integration-partners.md - https://docs.checkhq.com/reference/list-a-webhook-config.md - https://docs.checkhq.com/reference/list-active-funding-strikes.md - https://docs.checkhq.com/reference/list-agencies.md - https://docs.checkhq.com/reference/list-bank-accounts.md - https://docs.checkhq.com/reference/list-benefits.md - https://docs.checkhq.com/reference/list-communications.md - https://docs.checkhq.com/reference/list-companies.md - https://docs.checkhq.com/reference/list-company-authorization-documents.md - https://docs.checkhq.com/reference/list-company-benefits.md - https://docs.checkhq.com/reference/list-company-filings.md - https://docs.checkhq.com/reference/list-company-tax-documents.md - https://docs.checkhq.com/reference/list-company-tax-elections.md - https://docs.checkhq.com/reference/list-company-tax-parameter-settings.md - https://docs.checkhq.com/reference/list-company-tax-parameters.md - https://docs.checkhq.com/reference/list-contractor-forms.md - https://docs.checkhq.com/reference/list-contractor-payments.md - https://docs.checkhq.com/reference/list-contractor-tax-documents.md - https://docs.checkhq.com/reference/list-contractors.md - https://docs.checkhq.com/reference/list-corrections.md - https://docs.checkhq.com/reference/list-earning-codes.md - https://docs.checkhq.com/reference/list-earning-rates.md - https://docs.checkhq.com/reference/list-employee-tax-documents.md - https://docs.checkhq.com/reference/list-employee-tax-elections.md - https://docs.checkhq.com/reference/list-employee-tax-parameter-settings.md - https://docs.checkhq.com/reference/list-employee-tax-statements.md - https://docs.checkhq.com/reference/list-employees-tax-parameters.md - https://docs.checkhq.com/reference/list-employees.md - https://docs.checkhq.com/reference/list-external-payrolls.md - https://docs.checkhq.com/reference/list-forms.md - https://docs.checkhq.com/reference/list-fulfillments.md - https://docs.checkhq.com/reference/list-integration-accesses-1.md - https://docs.checkhq.com/reference/list-integration-permissions-copy.md - https://docs.checkhq.com/reference/list-integration-permissions.md - https://docs.checkhq.com/reference/list-logs.md - https://docs.checkhq.com/reference/list-net-pay-splits.md - https://docs.checkhq.com/reference/list-notifications.md - https://docs.checkhq.com/reference/list-pay-schedules.md - https://docs.checkhq.com/reference/list-payments.md - https://docs.checkhq.com/reference/list-payroll-items.md - https://docs.checkhq.com/reference/list-payrolls.md - https://docs.checkhq.com/reference/list-post-tax-deductions.md - https://docs.checkhq.com/reference/list-report-runs.md - https://docs.checkhq.com/reference/list-setup-documents.md - https://docs.checkhq.com/reference/list-setups.md - https://docs.checkhq.com/reference/list-tax-deposits.md - https://docs.checkhq.com/reference/list-taxes.md - https://docs.checkhq.com/reference/list-usage-records.md - https://docs.checkhq.com/reference/list-usage-summaries.md - https://docs.checkhq.com/reference/list-webhook-deliveries.md - https://docs.checkhq.com/reference/list-workplaces.md - https://docs.checkhq.com/reference/preview-a-correction.md - https://docs.checkhq.com/reference/preview-an-external-payroll.md - https://docs.checkhq.com/reference/preview-payroll.md - https://docs.checkhq.com/reference/previous-payroll-provider-access.md - https://docs.checkhq.com/reference/refund-a-payment.md - https://docs.checkhq.com/reference/remove-filing-blockers.md - https://docs.checkhq.com/reference/reopen-a-correction.md - https://docs.checkhq.com/reference/reopen-a-pending-payroll.md - https://docs.checkhq.com/reference/reopen-payroll.md - https://docs.checkhq.com/reference/request-a-tax-package.md - https://docs.checkhq.com/reference/request-embedded-setup.md - https://docs.checkhq.com/reference/retry-a-payment.md - https://docs.checkhq.com/reference/retry-a-webhook-delivery-in-sandbox.md - https://docs.checkhq.com/reference/reveal-account-number.md - https://docs.checkhq.com/reference/reveal-contractor-ssn.md - https://docs.checkhq.com/reference/reveal-employee-ssn.md - https://docs.checkhq.com/reference/run-payroll.md - https://docs.checkhq.com/reference/sandbox-complete-disbursements.md - https://docs.checkhq.com/reference/sandbox-complete-funding.md - https://docs.checkhq.com/reference/sandbox-correction-complete-funding.md - https://docs.checkhq.com/reference/sandbox-correction-fail-funding.md - https://docs.checkhq.com/reference/sandbox-correction-start-processing.md - https://docs.checkhq.com/reference/sandbox-fail-funding.md - https://docs.checkhq.com/reference/sandbox-start-processing.md - https://docs.checkhq.com/reference/submit-a-contractor-form.md - https://docs.checkhq.com/reference/update-a-bank-account.md - https://docs.checkhq.com/reference/update-a-company.md - https://docs.checkhq.com/reference/update-a-correction.md - https://docs.checkhq.com/reference/update-a-webhook-config.md - https://docs.checkhq.com/reference/update-a-workplace.md - https://docs.checkhq.com/reference/update-an-earning-rate.md - https://docs.checkhq.com/reference/update-an-external-payroll.md - https://docs.checkhq.com/reference/update-company-tax-elections.md - https://docs.checkhq.com/reference/update-employee-tax-elections.md - https://docs.checkhq.com/reference/update-payroll.md - https://docs.checkhq.com/reference/update-the-enrollment-profile.md - https://docs.checkhq.com/reference/validate-address.md - https://docs.checkhq.com/reference/validate-an-external-payroll.md - https://docs.checkhq.com/reference/void-a-payroll.md - https://docs.checkhq.com/reference/workplace-roster.md merge: pages: 188 deduped: 195 conflicts_kept_first: 0