Bridge External Accounts API

The External Accounts API from Bridge — 6 operation(s) for external accounts.

Operations 9

GET /customers/{customerID}/external_accounts Get all External Accounts
POST /customers/{customerID}/external_accounts Create a new External Account
GET /customers/{customerID}/external_accounts/{externalAccountID} Retrieve an External Account object
PUT /customers/{customerID}/external_accounts/{externalAccountID} Update an External Account
DELETE /customers/{customerID}/external_accounts/{externalAccountID} Delete a single External Account object
POST /customers/{customerID}/external_accounts/{externalAccountID}/deactivate Deactivate an External Account
POST /customers/{customerID}/external_accounts/{externalAccountID}/verify Verify an External Account
POST /customers/{customerID}/external_accounts/{externalAccountID}/reactivate Reactivate an External Account
GET /external_accounts Get all External Accounts

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/bridge-external-accounts-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

bridge-external-accounts-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Bridge API Keys External Accounts API
  description: APIs to move into, out of, and between any form of a dollar
  version: '1'
servers:
- url: https://api.bridge.xyz/v0
  description: The base path for all resources
security:
- ApiKey: []
tags:
- name: External Accounts
paths:
  /customers/{customerID}/external_accounts:
    parameters:
    - $ref: '#/components/parameters/CustomerIDParameter'
    get:
      summary: Get all External Accounts
      tags:
      - External Accounts
      description: Get all External Accounts for a passed in customer.
      parameters:
      - $ref: '#/components/parameters/LimitParameter'
      - $ref: '#/components/parameters/ExternalAccountStartingAfterParameter'
      - $ref: '#/components/parameters/ExternalAccountEndingBeforeParameter'
      responses:
        '200':
          description: List of External Accounts (the returned list is empty if no External Accounts exist)
          content:
            application/json:
              schema:
                title: ExternalAccount
                type: object
                required:
                - data
                properties:
                  data:
                    type: array
                    minItems: 0
                    items:
                      $ref: '#/components/schemas/ExternalAccountResponse'
                  count:
                    description: total number of items in data
                    type: integer
              examples:
                ExternalAccountsFound:
                  summary: A non-empty list of External Accounts
                  value:
                    data:
                    - $ref: '#/components/examples/SuccessfulExternalAccountResponse/value'
                NoExternalAccountsFound:
                  summary: An empty list of External Accounts
                  value:
                    data: []
                    count: 0
        '401':
          $ref: '#/components/responses/AuthenticationError'
        '500':
          $ref: '#/components/responses/UnexpectedError'
    post:
      summary: Create a new External Account
      tags:
      - External Accounts
      description: '_Note_: If adding US external accounts, we recommend reading through the US Beneficiary Address Validation doc ([link](https://apidocs.bridge.xyz/docs/us-beneficiary-address-validation)) to avoid issues related to incorrect addresses.

        '
      parameters:
      - $ref: '#/components/parameters/IdempotencyKeyParameter'
      requestBody:
        description: New External Account object to be created
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateExternalAccountInput'
            examples:
              ACH:
                $ref: '#/components/examples/CreateAchExternalAccountRequest'
              IBAN:
                $ref: '#/components/examples/CreateIbanExternalAccountRequest'
              SWIFT:
                $ref: '#/components/examples/CreateSwiftExternalAccountRequest'
              CLABE:
                $ref: '#/components/examples/CreateClabeExternalAccountRequest'
              Pix_Key:
                $ref: '#/components/examples/CreatePixExternalAccountRequest'
              Pix_BrCode:
                $ref: '#/components/examples/CreateBrCodeExternalAccountRequest'
              BreB:
                $ref: '#/components/examples/CreateBreBExternalAccountRequest'
              CO_Bank_Transfer:
                $ref: '#/components/examples/CreateCoBankTransferExternalAccountRequest'
      responses:
        '201':
          description: External Account object created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalAccountResponse'
              examples:
                ACH:
                  $ref: '#/components/examples/SuccessfulExternalAccountResponse'
                IBAN:
                  $ref: '#/components/examples/SuccessfulIbanExternalAccountResponse'
                SWIFT:
                  $ref: '#/components/examples/SuccessfulSwiftExternalAccountResponse'
                CLABE:
                  $ref: '#/components/examples/SuccessfulClabeExternalAccountResponse'
                Pix_Key:
                  $ref: '#/components/examples/SuccessfulPixKeyExternalAccountResponse'
                Pix_BrCode:
                  $ref: '#/components/examples/SuccessfulBrCodeExternalAccountResponse'
                BreB:
                  $ref: '#/components/examples/SuccessfulBreBExternalAccountResponse'
                CO_Bank_Transfer:
                  $ref: '#/components/examples/SuccessfulCoBankTransferExternalAccountResponse'
        '401':
          $ref: '#/components/responses/AuthenticationError'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '500':
          $ref: '#/components/responses/UnexpectedError'
  /customers/{customerID}/external_accounts/{externalAccountID}:
    parameters:
    - $ref: '#/components/parameters/CustomerIDParameter'
    - $ref: '#/components/parameters/ExternalAccountIDParameter'
    get:
      summary: Retrieve an External Account object
      description: Retrieve an External Account object (banks, debit cards etc) from the passed in customer ID and External Account ID
      tags:
      - External Accounts
      responses:
        '200':
          description: Successful External Account object response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalAccountResponse'
              examples:
                SuccessfulExternalAccountResponse:
                  $ref: '#/components/examples/SuccessfulExternalAccountResponse'
                SuccessfulIbanExternalAccountResponse:
                  $ref: '#/components/examples/SuccessfulIbanExternalAccountResponse'
                SuccessfulPixKeyExternalAccountResponse:
                  $ref: '#/components/examples/SuccessfulPixKeyExternalAccountResponse'
                SuccessfulBrCodeExternalAccountResponse:
                  $ref: '#/components/examples/SuccessfulBrCodeExternalAccountResponse'
                SuccessfulBreBExternalAccountResponse:
                  $ref: '#/components/examples/SuccessfulBreBExternalAccountResponse'
                SuccessfulCoBankTransferExternalAccountResponse:
                  $ref: '#/components/examples/SuccessfulCoBankTransferExternalAccountResponse'
        '401':
          $ref: '#/components/responses/AuthenticationError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '500':
          $ref: '#/components/responses/UnexpectedError'
    put:
      summary: Update an External Account
      tags:
      - External Accounts
      requestBody:
        description: External Account details to be updated
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateExternalAccountInput'
      responses:
        '200':
          description: External Account object updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalAccountResponse'
        '401':
          $ref: '#/components/responses/AuthenticationError'
        '400':
          $ref: '#/components/responses/BadExternalAccountUpdateError'
        '500':
          $ref: '#/components/responses/UnexpectedError'
    delete:
      summary: Delete a single External Account object
      tags:
      - External Accounts
      description: Delete an External Account object from the passed in External Account ID
      responses:
        '200':
          description: Successfully deleted External Account object response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalAccountResponse'
              examples:
                DeletedExternalAccountResponse:
                  $ref: '#/components/examples/SuccessfulExternalAccountResponse'
        '401':
          $ref: '#/components/responses/AuthenticationError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '500':
          $ref: '#/components/responses/UnexpectedError'
  /customers/{customerID}/external_accounts/{externalAccountID}/deactivate:
    post:
      summary: Deactivate an External Account
      description: Deactivate an active External Account. The External Account is preserved and can be reactivated later via the reactivate endpoint.
      tags:
      - External Accounts
      parameters:
      - $ref: '#/components/parameters/IdempotencyKeyParameter'
      - $ref: '#/components/parameters/CustomerIDParameter'
      - $ref: '#/components/parameters/ExternalAccountIDParameter'
      responses:
        '200':
          description: Deactivated External Account object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalAccountResponse'
              examples:
                DeactivatedExternalAccountResponse:
                  $ref: '#/components/examples/SuccessfulExternalAccountResponse'
        '401':
          $ref: '#/components/responses/AuthenticationError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '500':
          $ref: '#/components/responses/UnexpectedError'
  /customers/{customerID}/external_accounts/{externalAccountID}/verify:
    post:
      summary: Verify an External Account
      description: 'Trigger a verification check for an external account. Verifies that the `account_owner_name` matches the actual account holder at the receiving bank.


        Supported for `iban` (EUR) and `gb` (GBP) account types only. Does not require an Idempotency-Key header.


        After triggering, poll the external account''s `account_verification` field until `completed_at` is populated.

        '
      tags:
      - External Accounts
      parameters:
      - $ref: '#/components/parameters/CustomerIDParameter'
      - $ref: '#/components/parameters/ExternalAccountIDParameter'
      responses:
        '200':
          description: Verification initiated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  account_type:
                    type: string
                    enum:
                    - iban
                    - gb
                    description: The account type that was verified.
                  account_verification:
                    description: The current state of the verification.
                    type: object
                    properties:
                      iban:
                        type: object
                        description: Present when verifying an IBAN account.
                        properties:
                          match_level:
                            type: string
                            enum:
                            - pending
                            - match
                            - close_match
                            - no_match
                            - error
                            description: The result of the name match check.
                          reason_code:
                            type:
                            - string
                            - 'null'
                            description: Additional context from the receiving bank when the result is not a full match.
                          validated_account_owner_name:
                            type:
                            - string
                            - 'null'
                            description: The name on file at the receiving bank.
                      gb:
                        type: object
                        description: Present when verifying a GB account.
                        properties:
                          match_level:
                            type: string
                            enum:
                            - pending
                            - match
                            - close_match
                            - no_match
                            - error
                            description: The result of the name match check.
                          reason_code:
                            type:
                            - string
                            - 'null'
                            description: Additional context from the receiving bank when the result is not a full match.
                          validated_account_owner_name:
                            type:
                            - string
                            - 'null'
                            description: The name on file at the receiving bank.
                      requested_at:
                        type: string
                        format: date-time
                        description: When the verification was requested.
                      completed_at:
                        type:
                        - string
                        - 'null'
                        format: date-time
                        description: When the verification completed. Null while pending.
              examples:
                PendingIbanVerification:
                  summary: A newly triggered IBAN verification
                  value:
                    account_type: iban
                    account_verification:
                      iban:
                        match_level: pending
                        reason_code: null
                        validated_account_owner_name: null
                      requested_at: '2026-01-15T12:00:00.000Z'
                      completed_at: null
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/AuthenticationError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '409':
          description: A verification is already in progress for this external account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          $ref: '#/components/responses/UnexpectedError'
  /customers/{customerID}/external_accounts/{externalAccountID}/reactivate:
    post:
      summary: Reactivate an External Account
      description: Reactivate a previously deactivated External Account
      tags:
      - External Accounts
      parameters:
      - $ref: '#/components/parameters/IdempotencyKeyParameter'
      - $ref: '#/components/parameters/CustomerIDParameter'
      - $ref: '#/components/parameters/ExternalAccountIDParameter'
      responses:
        '200':
          description: Reactivated External Account object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalAccountResponse'
        '400':
          $ref: '#/components/responses/BadExternalAccountReactivateError'
  /external_accounts:
    parameters:
    - $ref: '#/components/parameters/LimitParameter'
    - $ref: '#/components/parameters/ExternalAccountStartingAfterParameter'
    - $ref: '#/components/parameters/ExternalAccountEndingBeforeParameter'
    get:
      summary: Get all External Accounts
      tags:
      - External Accounts
      description: Get all External Accounts.
      responses:
        '200':
          description: List of External Accounts (the returned list is empty if no External Accounts exist)
          content:
            application/json:
              schema:
                title: ExternalAccount
                type: object
                required:
                - data
                properties:
                  data:
                    type: array
                    minItems: 0
                    items:
                      $ref: '#/components/schemas/ExternalAccountResponse'
                  count:
                    description: total number of items in data
                    type: integer
              examples:
                ExternalAccountsFound:
                  summary: A non-empty list of External Accounts
                  value:
                    data:
                    - $ref: '#/components/examples/SuccessfulExternalAccountResponse/value'
                NoExternalAccountsFound:
                  summary: An empty list of External Accounts
                  value:
                    data: []
                    count: 0
components:
  schemas:
    CoBankTransferDocumentType:
      description: 'Colombian document type identifier. `cc` = Cédula de Ciudadanía, `ce` = Cédula de Extranjería, `nit` = NIT (tax ID), `rut` = RUT (worker registration), `pa` = Passport, `ppt` = Permiso de Protección Temporal.

        '
      type: string
      enum:
      - cc
      - ce
      - nit
      - rut
      - pa
      - ppt
      - ti
      - rc
      - te
      - die
      - nd
    BrCodeBankAccount:
      title: br_code
      required:
      - br_code
      - account_preview
      properties:
        br_code:
          type: string
          description: The Copie e cola code for Pix transactions
          minLength: 1
          writeOnly: true
        document_number:
          type: string
          description: Optional document number (CPF/CNPJ) associated with the Pix key.  Must be all numerals (no punctuation) if provided.
          writeOnly: true
        account_preview:
          description: Masked preview of the BR Code
          type: string
          readOnly: true
        document_number_last4:
          description: Last 4 digits of the document number (CPF/CNPJ) when available
          type: string
          readOnly: true
    CreateExternalAccountBrCodeInput:
      title: Pix (BR Code)
      description: Brazilian Pix instant payment system using a BR Code (Copie e cola)
      allOf:
      - $ref: '#/components/schemas/ExternalAccountBaseWithoutOwnerInfo'
      - type: object
        required:
        - account_type
        - currency
        - br_code
        - account_owner_name
        properties:
          currency:
            description: Currency associated with the bank account. Must be `brl` for Pix accounts.
            type: string
            enum:
            - brl
          account_type:
            type: string
            enum:
            - pix
            description: Type of the bank account.
          br_code:
            writeOnly: true
            description: Brazilian BR Code (Copie e cola) bank account information. Required when account type is `pix` and using a BR Code.
            $ref: '#/components/schemas/BrCodeBankAccount'
    SwiftCategory:
      type: string
      description: The category of the Swift account. Can be `client`, `parent_company`, `subsidiary`, or `supplier`
    SwiftPurposeOfFunds:
      type: string
      description: The purpose of funds for the Swift account. Can be `intra_group_transfer`, `invoice_for_goods_and_services`
    BreBBankAccount:
      title: bre_b
      required:
      - bre_b_key
      - last_4
      properties:
        bre_b_key:
          type: string
          description: The Bre-B key of the Colombian bank account
          writeOnly: true
        last_4:
          description: Last 4 digits of the Bre-B key
          minLength: 4
          maxLength: 4
          type: string
          readOnly: true
    IbanBankAccount:
      required:
      - account_number
      - country
      - last_4
      properties:
        account_number:
          type: string
          description: The International Bank Account Number (IBAN) that will be used to send the funds
          minLength: 1
          writeOnly: true
        bic:
          type: string
          description: 'The Bank Identifier Code (BIC/SWIFT code) associated with the beneficiary bank.

            While not strictly required for IBAN-based payments, providing the BIC may improve

            payment success rates.

            '
          minLength: 8
          maxLength: 11
          pattern: ^[A-Za-z]{4}[A-Za-z]{2}[A-Za-z0-9]{2}([A-Za-z0-9]{3})?$
        country:
          description: Country in which the bank account is located. It's a three-letter alpha-3 country code as defined in the ISO 3166-1 spec.
          type: string
          minLength: 3
          maxLength: 3
        last_4:
          description: Last 4 digits of the bank account number
          minLength: 1
          type: string
          readOnly: true
    Address:
      required:
      - street_line_1
      - country
      - city
      properties:
        street_line_1:
          type: string
          minLength: 4
        street_line_2:
          type: string
          minLength: 1
        city:
          type: string
          minLength: 1
        state:
          type: string
          description: ISO 3166-2 subdivision code. Must be supplied for US addresses.
          minLength: 1
          maxLength: 3
        postal_code:
          type: string
          description: Must be supplied for countries that use postal codes.
          minLength: 1
        country:
          description: Three-letter alpha-3 country code as defined in the ISO 3166-1 spec.
          type: string
          minLength: 3
          maxLength: 3
    ExternalAccountUnknown:
      title: SWIFT
      description: SWIFT international wire transfer (account_type `iban` or `unknown`)
      allOf:
      - $ref: '#/components/schemas/ExternalAccountBaseWithOwnerInfo'
      - type: object
        required:
        - account_type
        - currency
        properties:
          account_type:
            type: string
            enum:
            - unknown
            - iban
            description: Type of the bank account.
          currency:
            description: Currency associated with the bank account.
            type: string
            enum:
            - usd
          swift:
            $ref: '#/components/schemas/UnknownBankAccount'
    UnknownBankAccount:
      description: SWIFT international wire transfer (account_type `unknown` or `iban`)
      required:
      - account_number
      - last_4
      - bic
      properties:
        account_number:
          type: string
          description: The number of the bank account
          minLength: 1
          writeOnly: true
        bic:
          type: string
          description: The Bank Identifier Code (BIC) of the bank account
          minLength: 1
        last_4:
          description: Last 4 digits of the bank account number
          minLength: 1
          type: string
          readOnly: true
    GbBankAccount:
      title: gb
      type: object
      required:
      - account_number
      - last_4
      - sort_code
      properties:
        account_number:
          type: string
          description: The bank account number
          minLength: 8
          maxLength: 8
          example: 12345678
          writeOnly: true
        last_4:
          description: Last 4 digits of the bank account number
          minLength: 1
          type: string
          readOnly: true
        sort_code:
          type: string
          description: The sort code, without hyphens
          minLength: 6
          maxLength: 6
          example: 123456
    ClabeBankAccount:
      required:
      - account_number
      - last_4
      properties:
        account_number:
          type: string
          description: The CLABE account number of the bank account
          minLength: 18
          maxLength: 18
          writeOnly: true
        last_4:
          description: Last 4 digits of the CLABE
          minLength: 4
          maxLength: 4
          type: string
          readOnly: true
    UsBankAccountUpdate:
      properties:
        checking_or_savings:
          $ref: '#/components/schemas/CheckingOrSavingsType'
        routing_number:
          type: string
          description: The bank routing number
          minLength: 9
          maxLength: 9
    CreateExternalAccountSWIFTInput:
      title: SWIFT
      description: SWIFT international wire transfer
      allOf:
      - $ref: '#/components/schemas/ExternalAccountBaseWithOwnerInfo'
      - type: object
        required:
        - account_type
        - currency
        - swift
        - account_owner_name
        properties:
          currency:
            description: Currency associated with the bank account.
            type: string
            enum:
            - usd
          account_type:
            type: string
            enum:
            - unknown
            - iban
            description: Type of the bank account.
          swift:
            $ref: '#/components/schemas/SwiftBankAccount'
    SwiftBankAccount:
      required:
      - account
      - address
      - category
      - purpose_of_funds
      - short_business_description
      properties:
        account:
          oneOf:
          - $ref: '#/components/schemas/IbanBankAccount'
          - $ref: '#/components/schemas/UnknownBankAccount'
        address:
          description: The bank address
          $ref: '#/components/schemas/Address'
        category:
          description: The context of business operations. Can be `client`, `parent_company`, `subsidiary`, or `supplier`
          $ref: '#/components/schemas/SwiftCategory'
        purpose_of_funds:
          description: The nature of the transactions this account will participate in. Can be `intra_group_transfer`, `invoice_for_goods_and_services`
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/SwiftPurposeOfFunds'
        short_business_description:
          description: How the business uses the funds
          type: string
    ExternalAccountDeactivationReason:
      description: Reason for deactivating an External Account
      type: string
      enum:
      - plaid_item_error
      - deactivated_due_to_bounceback
      - deleted_by_developer
      - requested_by_developer
      - invalid_account_number
      - invalid_bank_validation
      - rejected_by_bank_provider
    ExternalAccountResponse:
      required:
      - id
      - customer_id
      - created_at
      - updated_at
      - account_owner_name
      - currency
      - account_type
      - active
      allOf:
      - $ref: '#/components/schemas/ExternalAccount'
      - type: object
        properties:
          account_verification:
            description: Present for accounts with a holder verification check; contains the verification result keyed by account type.
            type:
            - object
            - 'null'
            properties:
              iban:
                type: object
                properties:
                  match_level:
                    type: string
                    enum:
                    - pending
                    - match
                    - close_match
                    - no_match
                    - error
                  reason_code:
                    type:
                    - string
                    - 'null'
                  validated_account_owner_name:
                    type:
                    - string
                    - 'null'
              gb:
                type: object
                properties:
                  match_level:
                    type: string
                    enum:
                    - pending
                    - match
                    - close_match
                    - no_match
                    - error
                  reason_code:
                    type:
                    - string
                    - 'null'
                  validated_account_owner_name:
                    type:
                    - string
                    - 'null'
              requested_at:
                type: string
                format: date-time
              completed_at:
                type:
                - string
                - 'null'
                format: date-time
    ExternalAccountBaseWithOwnerInfo:
      description: Properties shared by all external account types
      properties:
        id:
          $ref: '#/components/schemas/Id'
          readOnly: true
        customer_id:
          description: The id of the Bridge customer that this External Account belongs to
          type: string
          minLength: 1
          readOnly: true
        bank_name:
          description: Bank name of the account (e.g. "Chase")
          type: string
          minLength: 1
          maxLength: 256
        account_owner_name:
          description: 'Owner of the account Bank Account (e.g. "John Doe"). For ach, wire, and iban accounts, this field must be at least 3 characters, at most 35 characters, and follow the regex pattern for the given account type:

            - ach: `^(?!\s*$)[\x20-\x7E]*$`

            - wire: ```^[ \w!"#$%&''()+,\-./:;<=>?@\\_`~]*$```

            - iban: `^(?![:\- ]*$)[a-zA-Z0-9\/\-?:().,''+ _]+$`

            '
          type: string
          minLength: 1
          maxLength: 256
        created_at:
          readOnly: true
          type: string
          description: Time of creation of the External Account
          format: date-time
        updated_at:
          readOnly: true
          type: string
          description: Time of last update of the External Account
          format: date-time
        active:
          readOnly: true
          type: boolean
          description: Whether or not this External Account is active
        account_owner_type:
          description: The type of the account ownership. Required when the `account_type` is `iban`. For `individual` ownership, `first_name` and `last_name` are required. For `business` ownership, `business_name` is required.
          $ref: '#/components/schemas/BankAccountOwnerType'
        first_name:
          type: string
          description: First name of the individual account holder. Required when the `account_owner_type` is `individual`
        last_name:
          type: string
          description: Last name of the individual account holder. Required when the `account_owner_type` is `individual`
        business_name:
          type: string
          description: Business name of the business account holder. Required when the `account_owner_type` is `business`
        address:
          description: Address of the beneficiary of this account. Please ensure the address is valid (Google Maps is good for this). US addresses used to receive wires must include a street number.
          $ref: '#/components/schemas/ExternalAccountAddress'
        account_owner_country:
          readOnly: true
          type: string
          minLength: 3
          maxLength: 3
          description: Three-letter alpha-3 country of residence of the account owner (ISO 3166-1), used for regulatory reporting. Omitted when unknown.
        deactivation_reason:
          readOnly: true
          description: Reason for deactivation when this External Account is inactive
          $ref: '#/components/schemas/ExternalAccountDeactivationReason'
        deactivation_details:
          readOnly: true
          type: string
          description: Additional details about the deactivation when this External Account is inactive
    CreateExternalAccountBreBInput:
      title: Bre-B
      description: 'Colombian Bre-B account for COP transfers. Requires `cop` endorsement. Virtual account numbers are not accepted as Bre-B keys.

        '
      allOf:
      - $ref: '#/components/schemas/ExternalAccountBaseWithoutOwnerInfo'
      - type: object
        required:
        - account_type
        - currency
        - account
        - account_owner_name
        properties:
          currency:
            description: Currency associated with the bank account. Must be `cop` for Bre-B accounts.
            type: string
            enum:
            - cop
          account_type:
            type: string
            enum:
            - bre_b
            description: Type of the bank account.
          account:
            writeOnly: true
            description: Colombian Bre-B bank account information. Required when account type is `bre_b`.
            $ref: '#/components/schemas/BreBBankAccount'
    UpdateExternalAccountInput:
      properties:
        address:
          writeOnly: true
          description: Address of the beneficiary of this account.
          $ref: '#/components/schemas/Address'
        account:
          description: US ba

# --- truncated at 32 KB (71 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bridge/refs/heads/main/openapi/bridge-external-accounts-api-openapi.yml