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

# Get fiat external account

> Get a registered fiat settlement (bank) account by id. Pass reveal=true to decrypt account_number and account_holder_name (audit-logged).



## OpenAPI

````yaml /openapi.yaml get /bankAddressBook/{id}
openapi: 3.1.0
info:
  contact:
    email: support@boomfi.xyz
    name: API Support
  description: >-
    The BoomFi Merchants API provides a set of endpoints for merchants to manage
    their accounts, transactions, and more. Hosts differ per brand/environment;
    use the brand-specific base URL from the docs.
  title: ZBX Merchants API
  version: '1.0'
servers:
  - url: https://mapi.zbx.boomfi.xyz/v1
    description: Production
security: []
tags:
  - description: Payment links
    name: Paylinks
  - description: Billing plans
    name: Plans
  - description: Subscriptions
    name: Subscriptions
  - description: Customer records
    name: Customers
  - description: Invoices
    name: Invoices
  - description: Payments
    name: Payments
  - description: Organisation events
    name: Events
  - description: Organisation profile and display settings
    name: Organisation
  - description: Webhook and request-signing secrets
    name: Secrets
  - description: Settlement accounts
    name: Accounts
  - name: Bank Address Book
  - description: Managed virtual accounts, balances, pay-in, and payout
    name: Virtual Accounts
  - description: Partner-managed accounts, virtual accounts, pay-in, and payout
    name: Partners
  - description: Partner virtual account automations and run history
    name: Partner Automations
  - description: Partner maintain-balance automations
    name: Partner Balance Monitoring
  - description: Tradeable currencies, instruments, and swap targets
    name: Instruments
  - description: RFQ quotes
    name: Quotes
  - description: RFQ orders and one-click trades
    name: Orders
  - description: Executed trades
    name: Trades
paths:
  /bankAddressBook/{id}:
    get:
      tags:
        - Bank Address Book
      summary: Get fiat external account
      description: >-
        Get a registered fiat settlement (bank) account by id. Pass reveal=true
        to decrypt account_number and account_holder_name (audit-logged).
      parameters:
        - description: Bank address book entry id
          in: path
          name: id
          required: true
          schema:
            type: integer
        - description: When true, return decrypted account_number and account_holder_name
          in: query
          name: reveal
          schema:
            type: boolean
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/internal.Response-bankaddressbook_BankAccountAddressBookResponse
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/internal.ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/internal.ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/internal.ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/internal.ErrorResponse'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    internal.Response-bankaddressbook_BankAccountAddressBookResponse:
      properties:
        data:
          allOf:
            - $ref: >-
                #/components/schemas/bankaddressbook.BankAccountAddressBookResponse
          description: Response payload when the request succeeded.
        error:
          description: True when the request failed.
          type: boolean
        message:
          description: Human-readable status or error message.
          type: string
      type: object
    internal.ErrorResponse:
      properties:
        error:
          allOf:
            - $ref: '#/components/schemas/internal.ErrorStruct'
          description: Error details including HTTP-style code and message.
      type: object
    bankaddressbook.BankAccountAddressBookResponse:
      properties:
        account_holder_name:
          description: Account holder name for this resource.
          type: string
        account_holder_name_hint:
          description: Account holder name hint for this resource.
          type: string
        account_number:
          description: populated only on explicit reveal
          type: string
        account_number_hint:
          description: Account number hint for this resource.
          type: string
        country:
          description: ISO 3166-1 alpha-2 country code.
          type: string
        created_at:
          description: When the resource was created (RFC3339).
          type: string
        created_by:
          description: User or system that created the resource.
          type: string
        currency:
          description: Currency symbol (for example USDC or USD).
          type: string
        deleted_at:
          description: When the resource was soft-deleted (RFC3339), if applicable.
          type: string
        enabled:
          description: Whether this resource is enabled.
          type: boolean
        id:
          description: Unique resource identifier.
          type: integer
        name:
          description: Display name.
          type: string
        org_id:
          description: Organisation ID that owns this resource.
          type: string
        properties:
          additionalProperties: {}
          description: Additional properties as a key-value map.
          type: object
        state:
          allOf:
            - $ref: '#/components/schemas/docenums.AccountState'
          description: State, province, or region.
        updated_at:
          description: When the resource was last updated (RFC3339).
          type: string
      type: object
    internal.ErrorStruct:
      properties:
        code:
          description: |-
            Error code
            Example: 400
          example: 400
          type: integer
        errors:
          description: List of errors
          items:
            $ref: '#/components/schemas/internal.SingleError'
          type: array
        message:
          description: |-
            Error message
            Example: Insufficient quantity
          example: Insufficient quantity
          type: string
      type: object
    docenums.AccountState:
      enum:
        - Unknown
        - Pending
        - Ready
      type: string
      x-enum-varnames:
        - AccountStateUnknown
        - AccountStatePending
        - AccountStateReady
    internal.SingleError:
      properties:
        domain:
          description: |-
            Domain
            Example: orders
          example: orders
          type: string
        reason:
          description: |-
            Error Reason
            Example: InsufficientQuantity
          example: InsufficientQuantity
          type: string
      type: object
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: X-API-KEY
      type: apiKey

````