---
title: "List external accounts"
method: GET
path: "/external_accounts"
tags: ["External Accounts"]
---

# List external accounts

`GET /external_accounts`

List and filter external accounts.

## Query parameters

- `limit` integer
- `starting_after` string, uuid
- `sort_order` 'asc' | 'desc'
- `start_date` string, date
- `end_date` string, date
- `holder_name` string
- `account_number` string
- `bank_code` string
- `country` string
- `status` 'pending_approval' | 'approved' | 'denied' | 'disabled' — The status of this external account.

## Response `200`

200

- ExternalAccountsSearchResult
  - `records` ExternalAccountsExternalAccount[]
    - `id` string, uuid, required — The UUID of the external account.
    - `object` string, required — Type of the object, `external_account`.
    - `type` 'individual' | 'legal_entity' — The type of the external account.
    - `name` string — The name of the external account.
    - `holder_name` string, required — The name of the legal entity or individual holding the account.
    - `account_number` string, required — The account number.
    - `account_number_format` 'iban' | 'uk_account_number' | 'us_account_number' | 'tokenized' | 'other' — The format of the account number.
    - `account_holder_id` string, required — The ID of the related account holder.
    - `organization_identification` ExternalAccountsOrganizationIdentification — The organization identification of the external account. See more [here](https://docs.numeral.io/reference/organization-identifications).
      - `legal_entity_identifier` string — The legal entity identifier (LEI) of the external account.
      - `business_identification_code` string — The business identification code of the external account.
      - `default_other_identifier_type` 'bank_identification' | 'central_bank_identification' | 'clearing_house_identification' | 'company_incorporation_number' | 'company_identification' | 'customer_number' | 'duns_number' | 'employee_number' | 'global_location_number' | 'siren' | 'siret' | 'tax_number' | 'telephone_number' | 'business_domain_identification' | 'other_identification' — The identification in `others` to be taken into account when creating a payment with this external account.
      - `others` object[] — The list of other organization identifications of the external account.
        - `type` 'bank_identification' | 'central_bank_identification' | 'clearing_house_identification' | 'company_incorporation_number' | 'company_identification' | 'customer_number' | 'duns_number' | 'employee_number' | 'global_location_number' | 'siren' | 'siret' | 'tax_number' | 'telephone_number' | 'business_domain_identification' | 'other_identification', required — The type of the identification. See supported types [here](https://docs.numeral.io/reference/organization-identifications).
        - `value` string, required — The value of the identification.
    - `company_registration_number` string — The company registration number of the external account, when `type` = `legal_entity`.
    - `company_registration_number_type` 'eu_vat' | 'fr_siren' | 'fr_siret' | 'nl_kvk' | 'nl_kvk_branch' | 'other' | 'uk_crn' — The type of the external account's company registration number, when `type` = `legal_entity`.
    - `bank_code` string, required — The bank code. For example, a BIC or SWIFT code.
    - `bank_code_format` 'bic' | 'uk_sorting_code' | 'us_aba_routing_number' | 'tokenized' | 'other' — The format of the bank code.
    - `holder_address` ExternalAccountsHolderAddress, required — The address of the account holder, as an address object.
      - `line_1` string — Line 1.
      - `line_2` string — Line 2.
      - `building_number` string — Building number.
      - `street_name` string — Street name.
      - `postal_code` string — Postal / zip code.
      - `region_state` string — Region or state.
      - `city` string — City.
      - `country` string — ISO 3166 alpha-2 country code.
    - `bank_name` string — The name of the bank holding the account.
    - `bank_address` CommonAddress — The address of the account holder, as an address object.
      - `line_1` string — Line 1.
      - `line_2` string — Line 2.
      - `building_number` string — Building number.
      - `street_name` string — Street name.
      - `postal_code` string — Postal / zip code.
      - `region_state` string — Region or state.
      - `city` string — City.
      - `country` string — ISO 3166 alpha-2 country code.
      - `department` string, nullable — Department name or code.
      - `sub_department` string, nullable — Sub-department name.
      - `building_name` string, nullable — Name of the building.
      - `floor` string, nullable — Floor number or identifier.
      - `postal_box` string, nullable — Postal box.
      - `room` string, nullable — Room number.
      - `city_location_name` string, nullable — Specific city location or landmark.
      - `district_name` string, nullable — District name or administrative region.
    - `status` 'pending_approval' | 'approved' | 'denied' | 'disabled', required — The status of this external account.
    - `status_details` string, required — The details of the status of this external account.
    - `account_verification` ExternalAccountsAccountVerification — The result of the latest verification ran against the external account.
      - `result` 'valid' | 'invalid' | 'pending_verification', required — The overall result of the specific verification.
      - `created_at` string, date-time — The UTC timestamp the verification was performed at.
      - `valid_account_number` ExternalAccountsAccountVerificationItem — The result of a specific verification.
        - `result` 'valid' | 'invalid' | 'impossible_to_verify' | 'not_verified', required — The result of this specific verification.
        - `details` ExternalAccountsAccountVerificationItemDetails — The details of a specific verification.
          - `reason` string — A specific code that gives additional information on what caused the failure.
          - `expected_value` string — When available, the value that was expected in order to pass the validation.
          - `message` string — A user friendly message describing the failure.
      - `matching_account_number_and_bank_code` ExternalAccountsAccountVerificationItem — The result of a specific verification.
        - `result` 'valid' | 'invalid' | 'impossible_to_verify' | 'not_verified', required — The result of this specific verification.
        - `details` ExternalAccountsAccountVerificationItemDetails — The details of a specific verification.
          - `reason` string — A specific code that gives additional information on what caused the failure.
          - `expected_value` string — When available, the value that was expected in order to pass the validation.
          - `message` string — A user friendly message describing the failure.
      - `matching_account_holder` ExternalAccountsAccountVerificationItem — The result of a specific verification.
        - `result` 'valid' | 'invalid' | 'impossible_to_verify' | 'not_verified', required — The result of this specific verification.
        - `details` ExternalAccountsAccountVerificationItemDetails — The details of a specific verification.
          - `reason` string — A specific code that gives additional information on what caused the failure.
          - `expected_value` string — When available, the value that was expected in order to pass the validation.
          - `message` string — A user friendly message describing the failure.
      - `active_account` ExternalAccountsAccountVerificationItem — The result of a specific verification.
        - `result` 'valid' | 'invalid' | 'impossible_to_verify' | 'not_verified', required — The result of this specific verification.
        - `details` ExternalAccountsAccountVerificationItemDetails — The details of a specific verification.
          - `reason` string — A specific code that gives additional information on what caused the failure.
          - `expected_value` string — When available, the value that was expected in order to pass the validation.
          - `message` string — A user friendly message describing the failure.
    - `created_at` string, date-time, required — The UTC timestamp of the creation of this external account.
    - `disabled_at` string, date-time — The UTC timestamp of the disabling of this external account.
    - `metadata` object — Additional client data in JSON format. See [Metadata](https://docs.numeral.io/reference/metadata).
    - `custom_fields` CommonCustomFields, required — Custom fields in JSON `key:value` format. See [Custom fields](https://docs.numeral.io/reference/custom-fields).

## Other responses

- `400` — Validation error.

---

[API](https://skmtc.net/numeral/apis/payments.md) · [All operations](https://skmtc.net/numeral/apis/payments/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/numeral/payments/versions/220f101cc2ef/schema)