openapi: 3.2.0
info:
  title: check-api Bank Accounts API
  version: '2025-01-01'
servers:
- url: https://sandbox.checkhq.com
security:
- sec0: []
tags:
- name: Bank Accounts
paths:
  /bank_accounts:
    post:
      summary: Create a bank account
      description: 'Defines a bank account, and associates it with an existing company, contractor, or employee.


        One of `employee`, `company`, or `contractor` is required.'
      operationId: create-a-bank-account
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                employee:
                  type: string
                  description: ID of the [employee](https://docs.checkhq.com/reference/the-employee-object) on the account
                company:
                  type: string
                  description: ID of the [company](https://docs.checkhq.com/reference/company) on the account
                contractor:
                  type: string
                  description: ID of the [contractor](https://docs.checkhq.com/reference/the-contractor-object) on the account
                raw_bank_account:
                  type: object
                  required:
                  - account_number
                  - routing_number
                  - subtype
                  properties:
                    account_number:
                      type: string
                      description: The account’s account number
                    routing_number:
                      type: string
                      description: The account’s routing number
                    institution_name:
                      type: string
                      description: The name of the bank holding the account
                    subtype:
                      type: string
                      description: The account’s subtype. Values may be `checking` or `savings`
                plaid_bank_account:
                  type: object
                  required:
                  - plaid_processor_token
                  properties:
                    plaid_processor_token:
                      type: string
                      description: A Check processor token retrieved from the Plaid API
                metadata:
                  type: string
                  description: Additional loosely structured information to associate with this bank account
                  format: json
      responses:
        '201':
          description: '201'
          content:
            application/json:
              examples:
                Result:
                  value: ''
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: ''
      deprecated: false
      tags:
      - Bank Accounts
    get:
      summary: List bank accounts
      description: Lists all bank accounts.
      operationId: list-bank-accounts
      parameters:
      - name: company
        in: query
        description: Return bank accounts for this [company](https://docs.checkhq.com/reference/company) ID.
        schema:
          type: string
      - name: employee
        in: query
        description: 'Return bank accounts for these [employee](https://docs.checkhq.com/reference/the-employee-object) IDs. You can specify multiple employee IDs by repeating this parameter:

          `?employee=emp_abc123&employee=emp_xyz789`. '
        schema:
          type: string
      - name: contractor
        in: query
        description: Return bank accounts for this [contractor](https://docs.checkhq.com/reference/the-contractor-object) ID.
        schema:
          type: string
      - name: limit
        in: query
        description: Number of bank accounts returned per page. The maximum value is 500.
        schema:
          type: integer
          format: int32
          default: 25
      - 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
      - $ref: '#/components/parameters/MetadataListFilter'
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "[\n\t{\n    \"id\": \"bnk_abc\",\n    \"employee\": \"emp_xyz\",\n    \"raw_bank_account\": {\n      \"institution_name\": \"Chase\",\n      \"account_number\": \"112233445\",\n      \"routing_number\": \"011401533\",\n      \"subtype\": \"checking\"\n    },\n    \"metadata\": {}\n\t}\n]"
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      example: bnk_abc
                    employee:
                      type: string
                      example: emp_xyz
                    raw_bank_account:
                      type: object
                      properties:
                        institution_name:
                          type: string
                          example: Chase
                        account_number:
                          type: string
                          example: '112233445'
                        routing_number:
                          type: string
                          example: '011401533'
                        subtype:
                          type: string
                          example: checking
                    metadata:
                      type: object
                      properties: {}
      deprecated: false
      tags:
      - Bank Accounts
  /bank_accounts/{bank_account}:
    patch:
      summary: Update a bank account
      description: 'Updates a bank account.


        **Note: **Only “raw” bank accounts may be updated with this call. Plaid processor token-based bank accounts may not be updated.'
      operationId: update-a-bank-account
      parameters:
      - name: bank_account
        in: path
        description: ID of the bank account
        schema:
          type: string
        required: true
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - raw_bank_account
              properties:
                raw_bank_account:
                  type: object
                  required:
                  - account_number
                  - routing_number
                  - subtype
                  properties:
                    account_number:
                      type: string
                      description: The account’s account number
                    routing_number:
                      type: string
                      description: The account’s routing number
                    institution_name:
                      type: string
                      description: The name of the bank holding the account
                    subtype:
                      type: string
                      description: The account’s subtype. Values may be `checking` or `savings`
                metadata:
                  type: string
                  description: Additional loosely structured information to associate with this bank account
                  format: json
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: ''
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: ''
      deprecated: false
      tags:
      - Bank Accounts
    delete:
      summary: Delete a bank account
      description: Deletes the specified bank account.
      operationId: delete-a-bank-account
      parameters:
      - name: bank_account
        in: path
        description: ID of the bank account to delete
        schema:
          type: string
        required: true
      responses:
        '204':
          description: '204'
          content:
            application/json:
              examples:
                Result:
                  value: ''
      deprecated: false
      tags:
      - Bank Accounts
  /bank_accounts/{bank_account}/reveal:
    get:
      summary: Reveal account number
      description: Reveal the unmasked account number of both raw and plaid bank accounts. Reach out to Check to get support for this feature
      operationId: reveal-account-number
      parameters:
      - name: bank_account
        in: path
        description: The ID of the bank account that you want the account number for
        schema:
          type: string
        required: true
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n    \"id\": \"bnk_Wr8oItjaUJgvLNbN2MJa\",\n    \"company\": \"com_iI59t4yqiBbpkMuabvU6\",\n    \"status\": \"ownership_verified\",\n    \"raw_bank_account\": {\n        \"institution_name\": \"sksrsgitagelm\",\n        \"account_number\": \"770608869\", // New account number in this response only\n        \"account_number_last_four\": \"8869\",\n        \"routing_number\": \"559435723\",\n        \"type\": \"depository\",\n        \"subtype\": \"checking\"\n    },\n    \"metadata\": {},\n    \"supported_payment_types\": []\n}"
              schema:
                type: object
                properties:
                  id:
                    type: string
                    example: bnk_Wr8oItjaUJgvLNbN2MJa
                  company:
                    type: string
                    example: com_iI59t4yqiBbpkMuabvU6
                  status:
                    type: string
                    example: ownership_verified
                  raw_bank_account:
                    type: object
                    properties:
                      institution_name:
                        type: string
                        example: sksrsgitagelm
                      account_number:
                        type: string
                        example: '770608869'
                      account_number_last_four:
                        type: string
                        example: '8869'
                      routing_number:
                        type: string
                        example: '559435723'
                      type:
                        type: string
                        example: depository
                      subtype:
                        type: string
                        example: checking
                  metadata:
                    type: object
                    properties: {}
                  supported_payment_types:
                    type: array
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      tags:
      - Bank Accounts
components:
  parameters:
    MetadataListFilter:
      name: metadata
      in: query
      description: Return only results whose metadata contains every given key and value, for example `metadata[external_id]=123`. Pass keys using bracket notation. Multiple keys are combined with AND. Brackets must be URL-encoded in request URLs (`metadata%5Bkey%5D=value`).
      schema:
        type: object
        additionalProperties:
          type: string
      style: deepObject
      explode: true
  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