---
title: "Activate multiple bank rails"
method: POST
path: "/api/v1/banks/activate"
tags: ["Banks", "banks"]
---

# Activate multiple bank rails

`POST /api/v1/banks/activate`

Create or upsert Bank rows for multiple rails in one request. Returns a per-rail result so one pending or failed rail does not abort the batch.

## Headers

- `x-api-key` string, nullable

## Request body

- BankActivateRailsRequest — Bulk bank activation request.
  - `rails` BankRail[], required

## Response `200`

Successful Response

- BankActivateRailsResponse — Bulk bank activation response.
  - `results` BankActivateRailResult[], required
    - `rail` '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', required — Bank account route: provider rail + bank id (`{rail}-{bank}`).
    - `ok` boolean, required
    - `bank` BankResponse — 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``.
      - `rail` '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', required — Bank account route: provider rail + bank id (`{rail}-{bank}`).
      - `bankName` string, required
      - `country` string, required
      - `currency` string, required
      - `type` 'sepa' | 'swift' | 'ach' | 'uaefts' | 'fedwire', required — Canonical fiat payment rail used for ``account_type`` discrimination, bank-rail methods, and contact/transaction type alignment.
      - `method` 'sepa' | 'swift' | 'ach' | 'uaefts' | 'fedwire', required — Canonical fiat payment rail used for ``account_type`` discrimination, bank-rail methods, and contact/transaction type alignment.
      - `methods` FiatPaymentType[], required
      - `pooled` boolean, required
      - `compliance` integer, required
      - `bankIcon` string, required
      - `depositFee` number, required
      - `timeToOpen` '<1 day' | '1-2 days' | '2-3 days' | '5-7 days', required — Expected wait time before a bank rail becomes usable.
      - `status` 'not_started' | 'requested' | 'document_requested' | 'approved' | 'pending_kyc' | 'pending' | 'active' | 'hidden' | 'frozen' | 'closed' | 'rejected', required — 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.
      - `accountHolderBusinessName` string, nullable
      - `accountHolderFirstName` string, nullable
      - `accountHolderLastName` string, nullable
      - `ibanData` union
        - IBANAccountDetailsOutput — IBAN (SEPA) external account.
          - `bankName` string, required
          - `bankAddress` string, nullable
          - `currency` string, nullable
          - `accountHolderType` 'individual' | 'business', required — Account holder type.
          - `accountHolderFirstName` string, nullable
          - `accountHolderLastName` string, nullable
          - `accountHolderBusinessName` string, nullable
          - `accountHolderAddress` UserAddress — 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.
            - `streetAddress` string, nullable
            - `addressLine2` string, nullable
            - `city` string, nullable
            - `state` string, nullable
            - `country` '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' — ISO 3166-1 alpha-2 country codes.
            - `zip` string, nullable
          - `relationship` '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' — Unified contact relationship / transfer purpose. Values match Align AlignTransferPurpose (the more granular set). Mapped to Swipelux AccountHolderRelationship via ``swipelux_relationship``.
          - `paymentReference` string, nullable
          - `accountType` 'sepa' | 'uaefts'
          - `ibanNumber` string, required
          - `bic` string, nullable
          - `beneficiaryName` string, nullable, required — Frontend-only alias derived from account holder fields.
        - USExternalAccountDetailsOutput — US domestic (ACH) external account.
          - `bankName` string, required
          - `bankAddress` string, nullable
          - `currency` string, nullable
          - `accountHolderType` 'individual' | 'business', required — Account holder type.
          - `accountHolderFirstName` string, nullable
          - `accountHolderLastName` string, nullable
          - `accountHolderBusinessName` string, nullable
          - `accountHolderAddress` UserAddress — 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.
            - `streetAddress` string, nullable
            - `addressLine2` string, nullable
            - `city` string, nullable
            - `state` string, nullable
            - `country` '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' — ISO 3166-1 alpha-2 country codes.
            - `zip` string, nullable
          - `relationship` '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' — Unified contact relationship / transfer purpose. Values match Align AlignTransferPurpose (the more granular set). Mapped to Swipelux AccountHolderRelationship via ``swipelux_relationship``.
          - `paymentReference` string, nullable
          - `accountType` 'ach' | 'fedwire'
          - `us` USAccountDetails, required — US domestic account details (ACH).
            - `accountNumber` string, required
            - `routingNumber` string, required
          - `beneficiaryName` string, nullable, required — Frontend-only alias derived from account holder fields.
        - SwiftAccountDetailsOutput — SWIFT (international wire) external account.
          - `bankName` string, required
          - `bankAddress` string, nullable
          - `currency` string, nullable
          - `accountHolderType` 'individual' | 'business', required — Account holder type.
          - `accountHolderFirstName` string, nullable
          - `accountHolderLastName` string, nullable
          - `accountHolderBusinessName` string, nullable
          - `accountHolderAddress` UserAddress — 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.
            - `streetAddress` string, nullable
            - `addressLine2` string, nullable
            - `city` string, nullable
            - `state` string, nullable
            - `country` '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' — ISO 3166-1 alpha-2 country codes.
            - `zip` string, nullable
          - `relationship` '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' — Unified contact relationship / transfer purpose. Values match Align AlignTransferPurpose (the more granular set). Mapped to Swipelux AccountHolderRelationship via ``swipelux_relationship``.
          - `paymentReference` string, nullable
          - `accountType` 'swift'
          - `swift` SwiftDetails, required — SWIFT (international wire) account details.
            - `accountNumber` string, required
            - `routingNumber` string, nullable
            - `bic` string, required
          - `beneficiaryName` string, nullable, required — Frontend-only alias derived from account holder fields.
      - `id` string, uuid, nullable
      - `externalAccountId` string, nullable
      - `createdAt` string, date-time, nullable
    - `error` BankActivateRailError — Per-rail bulk activation error.
      - `statusCode` integer, required
      - `message` string, required
      - `detail` unknown

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/hevn-inc/apis/hevn-api.md) · [All operations](https://skmtc.net/hevn-inc/apis/hevn-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hevn-inc/hevn-api/versions/e6301d6796bf/schema)