> ## Documentation Index
> Fetch the complete documentation index at: https://docs.etherfuse.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Search bank accounts

> Retrieves a paginated list of bank accounts. The request body is optional — omitting it
returns the first page with defaults (pageSize 30, pageNumber 0, no filters).



## OpenAPI

````yaml /openapi.json post /ramp/bank-accounts
openapi: 3.1.0
info:
  title: Etherfuse FX API
  description: Partner-facing ramp API for onramps, offramps, swaps, and KYC.
  license:
    name: Proprietary
  version: 1.0.0
servers:
  - url: https://api.sand.etherfuse.com
    description: Sandbox
security:
  - ApiKeyAuth: []
tags:
  - name: Authentication
    description: >-
      Partner JWT authentication — exchange a JWT for an access token, or launch
      a user into the app.
  - name: Lookup
    description: >-
      Public reference data: exchange rates, stablebonds, bond costs, country
      codes.
  - name: Assets
    description: Rampable stablecoins and stablebonds available per blockchain.
  - name: Onboarding
    description: Hosted and programmatic customer onboarding.
  - name: Agreements
    description: Legal agreement acceptance during onboarding.
  - name: Bank Accounts
    description: Register and retrieve customer bank accounts.
  - name: Quotes
    description: Price quotes for onramps, offramps, and swaps.
  - name: Orders
    description: Create, track, and manage ramp orders.
  - name: Swaps
    description: Crypto-to-crypto swaps.
  - name: Sponsored
    description: Token approvals for sponsored (gasless) offramps.
  - name: Customers
    description: Customer (child-organization) records.
  - name: Wallets
    description: Register and manage customer wallets.
  - name: KYC
    description: Submit and check customer KYC status.
  - name: Webhooks
    description: Event notification subscriptions.
  - name: Organizations
    description: Organization identity, child orgs, and partner fees.
paths:
  /ramp/bank-accounts:
    post:
      tags:
        - Bank Accounts
      summary: Search bank accounts
      description: >-
        Retrieves a paginated list of bank accounts. The request body is
        optional — omitting it

        returns the first page with defaults (pageSize 30, pageNumber 0, no
        filters).
      operationId: get_bank_accounts
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PagedRequest_DateRangeFilter'
        required: true
      responses:
        '200':
          description: Paginated bank accounts
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedBankAccounts'
components:
  schemas:
    PagedRequest_DateRangeFilter:
      type: object
      properties:
        filters:
          type: object
          required:
            - fromDate
          properties:
            fromDate:
              type: string
              format: date-time
            toDate:
              type:
                - string
                - 'null'
              format: date-time
          example:
            fromDate: '2026-01-01T00:00:00Z'
            toDate: '2026-06-01T00:00:00Z'
        pageNumber:
          type: integer
          description: which page of results to return (starts at 0)
          minimum: 0
        pageSize:
          type: integer
          description: The number of items to get back in one page
          minimum: 0
      example:
        pageNumber: 0
        pageSize: 30
    PagedBankAccounts:
      type: object
      description: A page of bank accounts.
      required:
        - items
        - totalItems
        - pageSize
        - pageNumber
        - totalPages
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/BankAccount'
          description: The items on this page.
        next:
          type:
            - string
            - 'null'
          description: URL to fetch the next page of results, if available.
        pageNumber:
          type: integer
          description: Zero-based index of this page.
          example: 0
          minimum: 0
        pageSize:
          type: integer
          description: Number of items per page.
          example: 30
          minimum: 0
        totalItems:
          type: integer
          description: Total number of items across all pages.
          example: 42
          minimum: 0
        totalPages:
          type: integer
          description: Total number of pages.
          example: 2
          minimum: 0
    BankAccount:
      type: object
      required:
        - bankAccountId
        - customerId
        - createdAt
        - updatedAt
        - currency
        - abbrClabe
        - compliant
        - needsWork
        - status
      properties:
        abbrClabe:
          type: string
          description: Abbreviated CLABE number for the bank account.
          deprecated: true
        bankAccountId:
          type: string
          format: uuid
          description: Unique identifier for the bank account. Must be a valid UUID v4.
        compliant:
          type: boolean
          description: >-
            Whether the bank account is compliant and can be used for orders. A
            bank becomes

            compliant once the customer completes the required identity
            verification (or the

            owning organization is approved). **While `false`, the customer must
            complete

            additional verification before the bank can be used** — launch them
            into the

            Identity verification flow (`scope: verification`, `target: /idv`);
            see [User launch

            flows](/guides/user-launch-flows#identity-verification).
        createdAt:
          type: string
          format: date-time
          description: Timestamp when the bank account was created.
        currency:
          type: string
          description: Settlement currency (ISO 4217, e.g. `MXN`).
        customerId:
          type: string
          format: uuid
          description: ID of the customer who owns this bank account.
        deletedAt:
          type:
            - string
            - 'null'
          format: date-time
          description: Timestamp when the bank account was deleted (if applicable).
        etherfuseDepositClabe:
          type:
            - string
            - 'null'
          description: Etherfuse deposit CLABE number.
        label:
          type:
            - string
            - 'null'
          description: Custom label for the bank account.
        needsWork:
          type: boolean
          description: >-
            Whether the bank account still needs work (e.g. failed verification)
            before it

            can be used for transactions.
        status:
          type: string
          description: Current status of the bank account.
        updatedAt:
          type: string
          format: date-time
          description: Timestamp when the bank account was last updated.
      example:
        abbrClabe: •••• 0004
        bankAccountId: b2c3d4e5-f6a7-8901-bcde-f12345678901
        compliant: true
        createdAt: '2026-05-01T14:30:00Z'
        currency: MXN
        customerId: a1b2c3d4-e5f6-7890-abcd-ef1234567890
        etherfuseDepositClabe: '646180157000000004'
        label: Ana's SPEI account
        needsWork: false
        status: active
        updatedAt: '2026-05-02T09:15:00Z'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: API key sent in the Authorization header.

````