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

# List all bank rails

> Return every supported bank rail. Rails the user has activated come from the Bank table (with status / iban_data); rails the user has not activated are returned from the static BANK_INFO registry with status=not_started and iban_data=None. If a rail's provider KYC is APPROVED but no ACTIVE Bank row exists yet, syncs lazily from Swipelux / Align before returning.



## OpenAPI

````yaml /openapi.json get /api/v1/banks
openapi: 3.1.0
info:
  title: HEVN API
  description: Backend API for HEVN mobile neobank
  version: 0.1.2
servers:
  - url: https://api.hevn.finance
    description: Production
security: []
paths:
  /api/v1/banks:
    get:
      tags:
        - Banks
        - banks
      summary: List all bank rails
      description: >-
        Return every supported bank rail. Rails the user has activated come from
        the Bank table (with status / iban_data); rails the user has not
        activated are returned from the static BANK_INFO registry with
        status=not_started and iban_data=None. If a rail's provider KYC is
        APPROVED but no ACTIVE Bank row exists yet, syncs lazily from Swipelux /
        Align before returning.
      operationId: list_banks_api_v1_banks_get
      parameters:
        - name: x-api-key
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Api-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BanksListResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    BanksListResponse:
      properties:
        banks:
          items:
            $ref: '#/components/schemas/BankResponse'
          type: array
          title: Banks
        allOptions:
          items:
            $ref: '#/components/schemas/BankResponse'
          type: array
          title: Alloptions
        rails:
          $ref: '#/components/schemas/BankRequestedRails'
      type: object
      required:
        - banks
        - rails
      title: BanksListResponse
      description: List bank rails plus user's requested rail preferences.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    BankResponse:
      properties:
        rail:
          $ref: '#/components/schemas/BankRail'
        bankName:
          type: string
          title: Bankname
        country:
          type: string
          title: Country
        currency:
          type: string
          title: Currency
        type:
          $ref: '#/components/schemas/FiatPaymentType'
        method:
          $ref: '#/components/schemas/FiatPaymentType'
        methods:
          items:
            $ref: '#/components/schemas/FiatPaymentType'
          type: array
          title: Methods
        pooled:
          type: boolean
          title: Pooled
        compliance:
          type: integer
          title: Compliance
        bankIcon:
          type: string
          title: Bankicon
        depositFee:
          type: number
          title: Depositfee
        timeToOpen:
          $ref: '#/components/schemas/BankTimeToOpen'
        status:
          $ref: '#/components/schemas/IBANStatus'
        accountHolderBusinessName:
          anyOf:
            - type: string
            - type: 'null'
          title: Accountholderbusinessname
        accountHolderFirstName:
          anyOf:
            - type: string
            - type: 'null'
          title: Accountholderfirstname
        accountHolderLastName:
          anyOf:
            - type: string
            - type: 'null'
          title: Accountholderlastname
        ibanData:
          anyOf:
            - $ref: '#/components/schemas/IBANAccountDetails-Output'
            - $ref: '#/components/schemas/USExternalAccountDetails-Output'
            - $ref: '#/components/schemas/SwiftAccountDetails-Output'
            - type: 'null'
          title: Ibandata
        id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Id
        externalAccountId:
          anyOf:
            - type: string
            - type: 'null'
          title: Externalaccountid
        createdAt:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Createdat
      type: object
      required:
        - rail
        - bankName
        - country
        - currency
        - type
        - method
        - methods
        - pooled
        - compliance
        - bankIcon
        - depositFee
        - timeToOpen
        - status
      title: BankResponse
      description: >-
        Bank row as returned to clients.


        Merges static rail metadata (from BANK_INFO) with per-user state. For
        rails

        the user hasn't activated yet, ``id`` / ``external_account_id`` /
        ``created_at``

        are ``None`` and ``status`` is ``not_started``.
    BankRequestedRails:
      properties:
        us:
          $ref: '#/components/schemas/BankRequestedRailSettings'
        swift:
          $ref: '#/components/schemas/BankRequestedRailSettings'
        eu:
          $ref: '#/components/schemas/BankRequestedRailSettings'
        uae:
          $ref: '#/components/schemas/BankRequestedRailSettings'
      type: object
      title: BankRequestedRails
      description: Rails the user is interested in opening.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    BankRail:
      type: string
      enum:
        - uaefts_named-zand
        - ach_pooled-hsbc
        - ach_named-citi
        - ach_named-jpmorgan_chase
        - ach_named-cfsb
        - fedwire_pooled-hsbc
        - fedwire_pooled-jpmorgan_chase
        - fedwire_pooled-cfsb
        - fedwire_named-hsbc
        - fedwire_named-citi
        - fedwire_named-jpmorgan_chase
        - fedwire_named-cfsb
        - sepa_pooled-zen
        - sepa_named-zen
        - swift_pooled-hsbc
        - swift_named-hsbc
      title: BankRail
      description: 'Bank account route: provider rail + bank id (`{rail}-{bank}`).'
    FiatPaymentType:
      type: string
      enum:
        - sepa
        - swift
        - ach
        - uaefts
        - fedwire
      title: FiatPaymentType
      description: |-
        Canonical fiat payment rail used for ``account_type`` discrimination,
        bank-rail methods, and contact/transaction type alignment.
    BankTimeToOpen:
      type: string
      enum:
        - <1 day
        - 1-2 days
        - 2-3 days
        - 5-7 days
      title: BankTimeToOpen
      description: Expected wait time before a bank rail becomes usable.
    IBANStatus:
      type: string
      enum:
        - not_started
        - requested
        - document_requested
        - approved
        - pending_kyc
        - pending
        - active
        - hidden
        - frozen
        - closed
        - rejected
      title: IBANStatus
      description: >-
        IBAN account status.


        State machine:

        ``not_started`` → ``requested`` → ``document_requested`` → ``approved``
        → ``pending`` → ``active``


        - ``not_started``       — default for every rail until the user opts in.

        - ``requested``         — user asked for this rail via /pre-approve;
        awaiting KYC.

        - ``document_requested``— admin asked the user for more documents (KYB).

        - ``approved``          — KYB passed, account ready to be created at
        provider.

        - ``pending_kyc``       — provider rejected creation until KYC is
        approved.

        - ``pending``           — provider accepted/created the account,
        waiting.

        - ``active``            — real bank details are attached to the row.

        - ``frozen`` / ``closed``— terminal/blocked states.
    IBANAccountDetails-Output:
      properties:
        bankName:
          type: string
          title: Bankname
        bankAddress:
          anyOf:
            - type: string
            - type: 'null'
          title: Bankaddress
        currency:
          anyOf:
            - type: string
            - type: 'null'
          title: Currency
        accountHolderType:
          $ref: '#/components/schemas/AlignAccountHolderType'
        accountHolderFirstName:
          anyOf:
            - type: string
            - type: 'null'
          title: Accountholderfirstname
        accountHolderLastName:
          anyOf:
            - type: string
            - type: 'null'
          title: Accountholderlastname
        accountHolderBusinessName:
          anyOf:
            - type: string
            - type: 'null'
          title: Accountholderbusinessname
        accountHolderAddress:
          anyOf:
            - $ref: '#/components/schemas/UserAddress'
            - type: 'null'
        relationship:
          anyOf:
            - $ref: '#/components/schemas/app__schemas__base__ContactRelationship'
            - type: 'null'
        paymentReference:
          anyOf:
            - type: string
            - type: 'null'
          title: Paymentreference
        accountType:
          type: string
          enum:
            - sepa
            - uaefts
          title: Accounttype
          default: sepa
        ibanNumber:
          type: string
          title: Ibannumber
        bic:
          anyOf:
            - type: string
            - type: 'null'
          title: Bic
        beneficiaryName:
          anyOf:
            - type: string
            - type: 'null'
          title: Beneficiaryname
          description: Frontend-only alias derived from account holder fields.
          readOnly: true
      type: object
      required:
        - bankName
        - accountHolderType
        - ibanNumber
        - beneficiaryName
      title: IBANAccountDetails
      description: IBAN (SEPA) external account.
    USExternalAccountDetails-Output:
      properties:
        bankName:
          type: string
          title: Bankname
        bankAddress:
          anyOf:
            - type: string
            - type: 'null'
          title: Bankaddress
        currency:
          anyOf:
            - type: string
            - type: 'null'
          title: Currency
        accountHolderType:
          $ref: '#/components/schemas/AlignAccountHolderType'
        accountHolderFirstName:
          anyOf:
            - type: string
            - type: 'null'
          title: Accountholderfirstname
        accountHolderLastName:
          anyOf:
            - type: string
            - type: 'null'
          title: Accountholderlastname
        accountHolderBusinessName:
          anyOf:
            - type: string
            - type: 'null'
          title: Accountholderbusinessname
        accountHolderAddress:
          anyOf:
            - $ref: '#/components/schemas/UserAddress'
            - type: 'null'
        relationship:
          anyOf:
            - $ref: '#/components/schemas/app__schemas__base__ContactRelationship'
            - type: 'null'
        paymentReference:
          anyOf:
            - type: string
            - type: 'null'
          title: Paymentreference
        accountType:
          type: string
          enum:
            - ach
            - fedwire
          title: Accounttype
          default: ach
        us:
          $ref: '#/components/schemas/USAccountDetails'
        beneficiaryName:
          anyOf:
            - type: string
            - type: 'null'
          title: Beneficiaryname
          description: Frontend-only alias derived from account holder fields.
          readOnly: true
      type: object
      required:
        - bankName
        - accountHolderType
        - us
        - beneficiaryName
      title: USExternalAccountDetails
      description: US domestic (ACH) external account.
    SwiftAccountDetails-Output:
      properties:
        bankName:
          type: string
          title: Bankname
        bankAddress:
          anyOf:
            - type: string
            - type: 'null'
          title: Bankaddress
        currency:
          anyOf:
            - type: string
            - type: 'null'
          title: Currency
        accountHolderType:
          $ref: '#/components/schemas/AlignAccountHolderType'
        accountHolderFirstName:
          anyOf:
            - type: string
            - type: 'null'
          title: Accountholderfirstname
        accountHolderLastName:
          anyOf:
            - type: string
            - type: 'null'
          title: Accountholderlastname
        accountHolderBusinessName:
          anyOf:
            - type: string
            - type: 'null'
          title: Accountholderbusinessname
        accountHolderAddress:
          anyOf:
            - $ref: '#/components/schemas/UserAddress'
            - type: 'null'
        relationship:
          anyOf:
            - $ref: '#/components/schemas/app__schemas__base__ContactRelationship'
            - type: 'null'
        paymentReference:
          anyOf:
            - type: string
            - type: 'null'
          title: Paymentreference
        accountType:
          type: string
          const: swift
          title: Accounttype
          default: swift
        swift:
          $ref: '#/components/schemas/SwiftDetails'
        beneficiaryName:
          anyOf:
            - type: string
            - type: 'null'
          title: Beneficiaryname
          description: Frontend-only alias derived from account holder fields.
          readOnly: true
      type: object
      required:
        - bankName
        - accountHolderType
        - swift
        - beneficiaryName
      title: SwiftAccountDetails
      description: SWIFT (international wire) external account.
    BankRequestedRailSettings:
      properties:
        pooled:
          type: boolean
          title: Pooled
          default: false
        named:
          type: boolean
          title: Named
          default: false
      type: object
      title: BankRequestedRailSettings
      description: User interest in a bank rail group.
    AlignAccountHolderType:
      type: string
      enum:
        - individual
        - business
      title: AlignAccountHolderType
      description: Account holder type.
    UserAddress:
      properties:
        streetAddress:
          anyOf:
            - type: string
            - type: 'null'
          title: Streetaddress
        addressLine2:
          anyOf:
            - type: string
            - type: 'null'
          title: Addressline2
        city:
          anyOf:
            - type: string
            - type: 'null'
          title: City
        state:
          anyOf:
            - type: string
            - type: 'null'
          title: State
        country:
          anyOf:
            - $ref: '#/components/schemas/CountryCode'
            - type: 'null'
        zip:
          anyOf:
            - type: string
            - type: 'null'
          title: Zip
      type: object
      title: UserAddress
      description: >-
        Address schema for user.


        Canonical field names: street_address, address_line_2, city, state,
        country, zip.

        Accepts legacy Align/IBAN field names (street_line_1, street_line_2,
        postal_code)

        for backward compatibility with existing JSONB data.
    app__schemas__base__ContactRelationship:
      type: string
      enum:
        - charity
        - commercial_investment
        - corporate_card
        - credit_card
        - dividend
        - family
        - financial_services
        - good_sold
        - goods_bought
        - government
        - insurance
        - intergroup_transfer
        - intra_group_dividends
        - information_technology
        - leasing
        - loan_charges
        - merchant_settlement
        - mobile_wallet
        - none
        - non_resident_transfer_between_accounts
        - pension
        - personal_expenses
        - prepaid_cards
        - professional
        - rental
        - resident_transfer_between_accounts
        - salaries
        - telecommunications
        - travel
        - utility_bill
      title: ContactRelationship
      description: >-
        Unified contact relationship / transfer purpose.


        Values match Align AlignTransferPurpose (the more granular set).

        Mapped to Swipelux AccountHolderRelationship via
        ``swipelux_relationship``.
    USAccountDetails:
      properties:
        accountNumber:
          type: string
          title: Accountnumber
        routingNumber:
          type: string
          title: Routingnumber
      type: object
      required:
        - accountNumber
        - routingNumber
      title: USAccountDetails
      description: US domestic account details (ACH).
    SwiftDetails:
      properties:
        accountNumber:
          type: string
          title: Accountnumber
        routingNumber:
          anyOf:
            - type: string
            - type: 'null'
          title: Routingnumber
        bic:
          type: string
          title: Bic
      type: object
      required:
        - accountNumber
        - bic
      title: SwiftDetails
      description: SWIFT (international wire) account details.
    CountryCode:
      type: string
      enum:
        - AF
        - AX
        - AL
        - DZ
        - AS
        - AD
        - AO
        - AI
        - AQ
        - AG
        - AR
        - AM
        - AW
        - AU
        - AT
        - AZ
        - BS
        - BH
        - BD
        - BB
        - BY
        - BE
        - BZ
        - BJ
        - BM
        - BT
        - BO
        - BQ
        - BA
        - BW
        - BV
        - BR
        - IO
        - BN
        - BG
        - BF
        - BI
        - CV
        - KH
        - CM
        - CA
        - KY
        - CF
        - TD
        - CL
        - CN
        - CX
        - CC
        - CO
        - KM
        - CG
        - CD
        - CK
        - CR
        - CI
        - HR
        - CU
        - CW
        - CY
        - CZ
        - DK
        - DJ
        - DM
        - DO
        - EC
        - EG
        - SV
        - GQ
        - ER
        - EE
        - SZ
        - ET
        - FK
        - FO
        - FJ
        - FI
        - FR
        - GF
        - PF
        - TF
        - GA
        - GM
        - GE
        - DE
        - GH
        - GI
        - GR
        - GL
        - GD
        - GP
        - GU
        - GT
        - GG
        - GN
        - GW
        - GY
        - HT
        - HM
        - VA
        - HN
        - HK
        - HU
        - IS
        - IN
        - ID
        - IR
        - IQ
        - IE
        - IM
        - IL
        - IT
        - JM
        - JP
        - JE
        - JO
        - KZ
        - KE
        - KI
        - KP
        - KR
        - KW
        - KG
        - LA
        - LV
        - LB
        - LS
        - LR
        - LY
        - LI
        - LT
        - LU
        - MO
        - MG
        - MW
        - MY
        - MV
        - ML
        - MT
        - MH
        - MQ
        - MR
        - MU
        - YT
        - MX
        - FM
        - MD
        - MC
        - MN
        - ME
        - MS
        - MA
        - MZ
        - MM
        - NA
        - NR
        - NP
        - NL
        - NC
        - NZ
        - NI
        - NE
        - NG
        - NU
        - NF
        - MK
        - MP
        - 'NO'
        - OM
        - PK
        - PW
        - PS
        - PA
        - PG
        - PY
        - PE
        - PH
        - PN
        - PL
        - PT
        - PR
        - QA
        - RE
        - RO
        - RU
        - RW
        - BL
        - SH
        - KN
        - LC
        - MF
        - PM
        - VC
        - WS
        - SM
        - ST
        - SA
        - SN
        - RS
        - SC
        - SL
        - SG
        - SX
        - SK
        - SI
        - SB
        - SO
        - ZA
        - GS
        - SS
        - ES
        - LK
        - SD
        - SR
        - SJ
        - SE
        - CH
        - SY
        - TW
        - TJ
        - TZ
        - TH
        - TL
        - TG
        - TK
        - TO
        - TT
        - TN
        - TR
        - TM
        - TC
        - TV
        - UG
        - UA
        - AE
        - GB
        - US
        - UM
        - UY
        - UZ
        - VU
        - VE
        - VN
        - VG
        - VI
        - WF
        - EH
        - YE
        - ZM
        - ZW
      title: CountryCode
      description: ISO 3166-1 alpha-2 country codes.
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
      x-default: Bearer <token>

````