# List Bank Accounts

List bank accounts from a bank account storage in batches.

Endpoint: GET /bankaccountstorages/{storageId}/bankaccounts
Version: 2
Security: apiKey

## Path parameters:

  - `storageId` (string, required)
    ID of the bank account storage.
    Example: "652697d8eb91545eb14e64e6"

## Query parameters:

  - `startAfter` (string)
    ID of the first bank account.
    Example: "652697d8eb91545eb14e64e6"

  - `limit` (integer)
    Number of results that should be fetched. Maximum 100 results can be returned in one page.
    Example: "100"

## Response 200 fields (application/json):

  - `startAfter` (string)
    The ID which is used to read the page.
    Example: "5712566172571652"

  - `limit` (integer)
    Number of items per page.
    Example: "100"

  - `total` (integer)
    Total number of items which can be paged.
    Example: "67"

  - `values` (array)
    List of bank accounts.

  - `values.internationalBankAccountIdentifier` (string)
    The IBAN of a bank account.
    Example: "CH8800781619278412000"

  - `values.nationalBankAccountIdentifier` (string)
    Identifier of a bank account in a national context, i.e. for a country.
    Example: "619278412000"

  - `values.payees` (array)

  - `values.payees.name` (string)
    The abbreviated variant of a company's full name.
    Example: "CDQ AG"

  - `values.payees.externalId` (string)
    Arbitrary identifier type to mark customer IDs that are "external" from CDQ's perspective. This is the identifier a customer provides to identify its records.
    Example: "The ID managed in the customer's SAP systems."

  - `values.payees.storage` (object)
    Business Partner storage

  - `values.payees.storage.id` (string)
    Unique identifier of the Storage.
    Example: "72d6900fce6b326088f5d9d91049e3e6"

  - `values.payees.dataSource` (object)
    Data source

  - `values.payees.dataSource.id` (string)
    Unique identifier for a Data Source of the Storage.
    Example: "648824a691d8d2503d65103e"

  - `values.bank` (object)
    Financial institution that accepts deposits, facilitates withdrawals and transfers, and provides various financial services such as loans, investments, and currency exchange.

  - `values.bank.cdqId` (string)
    The CDQ ID of the bank.
    Example: "CDQID-1234567890"

  - `values.bank.name` (array)

  - `values.bank.name.shortName` (string)
    Abbreviated name of a bank.
    Example: "SNB"

  - `values.bank.name.type` (object)
    Type of the Bank Name.

  - `values.bank.name.type.url` (string)
    URL to the documentation which summarizes all details of the Bank Name Type.
    Example: "https://meta.cdq.com/Bank_account/bank/name/type"

  - `values.bank.name.type.name` (string)
    Name of the Bank Name Type.
    Example: "Bank name acronym"

  - `values.bank.name.type.technicalKey` (string)
    Technical key of the Bank Name Type.
    Example: "BANK_NAME_TYPE_ACRONYM"

  - `values.bank.name.value` (string)
    Value of the Bank Name.
    Example: "Swiss National Bank"

  - `values.bank.name.version` (object)
    Specifies the version of a bank name in terms of language and charset.

  - `values.bank.name.version.charset` (object)
    Character set.

  - `values.bank.name.version.charset.name` (string)
    Name of character set. Supported character sets can be found [here](https://meta.cdq.com/Address/version/character_set).
    Example: "International"

  - `values.bank.name.version.charset.technicalKey` (string)
    Technical key of character set. Supported character sets can be found [here](https://meta.cdq.com/Address/version/character_set).
    Example: "INTERNATIONAL"

  - `values.bank.name.version.language` (object)
    Naming of a language according to ISO 639-1.

  - `values.bank.name.version.language.name` (string)
    ISO 639-1 name of language.
    Example: "German"

  - `values.bank.name.version.language.technicalKey` (string)
    ISO 639-1 two-letter code of languages.
    Example: "DE"

  - `values.bank.internationalBankIdentifier` (string)
    (BIC/SWIFT) Bank identifier which is globally unique.
    Example: "KBSGCH22XXX"

  - `values.bank.nationalBankIdentifier` (string)
    Bank identifier which is unique in a national context, i.e. for a country.
    Example: "00781"

  - `values.bank.address` (object)
    An address provides information about the physical location of a business partner. It can be specialized in a certain context(e.g. delivery address or invoice address).

  - `values.bank.address.version` (object)
    CDQ supports multiple versions of addresses comprising different charsets and languages. An address version is a unique combination of a character set and a language.

  - `values.bank.address.version.characterSet` (object)
    Character set.

  - `values.bank.address.identifyingName` (object)
    An identifying name assigned to an address. In most cases the identifying name refers to the name of a registered agent.

  - `values.bank.address.identifyingName.value` (string)
    An identifying name assigned to an address. In most cases the identifying name refers to the name of a registered agent.
    Example: "John Doe"

  - `values.bank.address.externalId` (string)
    ID the address has in the external system where the record originates from.
    Example: "1"

  - `values.bank.address.metadata` (object)
    Specifies the language and primary data provenance.

  - `values.bank.address.metadata.primaryProvenance` (object)
    The source of the change or update. Could be the reference data source as VIES or Organization.

  - `values.bank.address.metadata.primaryProvenance.name` (string)
    Display Name of the Provenance Name.
    Example: "VIES"

  - `values.bank.address.metadata.primaryProvenance.url` (string)
    URL to the documentation which summarizes all details of the Provenance Name.
    Example: "https://meta.cdq.com/index.php?title=Property:Has_prefix&limit=500&offset=0&from=&until=&filter="

  - `values.bank.address.metadata.primaryProvenance.technicalKey` (string)
    Technical Key of the Provenance Name.
    Example: "VIES"

  - `values.bank.address.metadata.primaryProvenance.cdqId` (string)
    The ID provided for a linkage with the source by CDQ.
    Example: "VIES:PL8660001429"

  - `values.bank.address.careOf` (object)
    Signifies an intermediary who is responsible for transferring a piece of mail between the postal system and the final addressee. For example, when the addressee has no standard address, is under a corporate mail system, or is being manually forwarded mail sent to a more accessible location.

  - `values.bank.address.careOf.value` (string)
    Value of the CareOf.
    Example: "CDQ GmbH c/o Product Department"

  - `values.bank.address.contexts` (array)

  - `values.bank.address.contexts.value` (string)
    Value of the Address Context.
    Example: "Production hall 7, Storage field 8."

  - `values.bank.address.country` (object)
    Country consisting of the country name and country code (ISO 3166-1 alpha-2).

  - `values.bank.address.country.shortName` (string)
    Country code (ISO 3166-1 alpha-2).
    Example: "CH"

  - `values.bank.address.country.value` (string)
    Country name (ISO 3166-1 alpha-2).
    Example: "Switzerland"

  - `values.bank.address.administrativeAreas` (array)

  - `values.bank.address.administrativeAreas.value` (string)
    Name of the [Administrative Area](https://meta.cdq.com/Address/administrative_area).
    Example: "Sankt Gallen"

  - `values.bank.address.administrativeAreas.shortName` (string)
    Abbreviation for the [Administrative Area](https://meta.cdq.com/Address/administrative_area).
    Example: "SG"

  - `values.bank.address.administrativeAreas.fipsCode` (string)
    FIPS codes are numbers which uniquely identify geographic areas. The number of digits in FIPS codes vary depending on the level of geography. State-level FIPS codes have two digits, county-level FIPS codes have five digits of which the first two are the FIPS code of the state to which the county belongs.
    Example: "SZ15"

  - `values.bank.address.administrativeAreas.isoCode` (string)
    ISO 3166-2 code which uniquely defines the names of countries and their subdivisions (e.g., provinces or states).
    Example: "CH-SG"

  - `values.bank.address.administrativeAreas.type` (object)
    Type of the [Administrative Area](https://meta.cdq.com/Address/administrative_area).

  - `values.bank.address.administrativeAreas.type.name` (string)
    Display label for the Administrative Area Type.
    Example: "COUNTY"

  - `values.bank.address.administrativeAreas.type.url` (string)
    URL to the documentation which summarizes all details of the [Administrative Area](https://meta.cdq.com/Address/administrative_area/type).
    Example: "https://meta.cdq.com/Address/administrative_area/type"

  - `values.bank.address.administrativeAreas.type.technicalKey` (string)
    Technical key of the Administrative Area.
    Example: "COUNTY"

  - `values.bank.address.postCodes` (array)
    Example: ["9000"]

  - `values.bank.address.postCodes.value` (string)
    Effective [post code](https://meta.cdq.com/Address/post_code).
    Example: "9000"

  - `values.bank.address.postCodes.type` (object)
    Type of the Post Code.

  - `values.bank.address.postCodes.type.name` (string)
    Display label for the Post Code Type.
    Example: "Regular"

  - `values.bank.address.postCodes.type.url` (string)
    URL to the documentation which summarizes all details of the [Administrative Area](https://meta.cdq.com/Address/post_code/type).
    Example: "https://meta.cdq.com/Address/post_code/type"

  - `values.bank.address.postCodes.type.technicalKey` (string)
    Technical key of the Post Code.
    Example: "REGULAR"

  - `values.bank.address.localities` (array)

  - `values.bank.address.localities.type` (object)
    Type of the [Locality](https://meta.cdq.com/Address/locality).

  - `values.bank.address.localities.type.name` (string)
    Display label for the Locality Type.
    Example: "City"

  - `values.bank.address.localities.type.url` (string)
    URL to the documentation which summarizes all details of the [Locality Type](https://meta.cdq.com/Address/locality/type).
    Example: "https://meta.cdq.com/Address/locality/type"

  - `values.bank.address.localities.type.technicalKey` (string)
    Technical Key of the Locality Type.
    Example: "CITY"

  - `values.bank.address.localities.shortName` (string)
    Abbreviation of the [Locality](https://meta.cdq.com/Address/locality).
    Example: "St. Gallen"

  - `values.bank.address.localities.value` (string)
    Name of the [Locality](https://meta.cdq.com/Address/locality).
    Example: "Sankt Gallen"

  - `values.bank.address.thoroughfares` (array)

  - `values.bank.address.thoroughfares.type` (object)
    Type of the [Thoroughfare](https://meta.cdq.com/Address/thoroughfare).

  - `values.bank.address.thoroughfares.type.name` (string)
    Display label for the Thoroughfare Type Name.
    Example: "Industrial zone"

  - `values.bank.address.thoroughfares.type.url` (string)
    URL to the documentation which summarizes all details of the [Thoroughfare Type](https://meta.cdq.com/Address/thoroughfare/type).
    Example: "https://meta.cdq.com/Address/thoroughfare/type"

  - `values.bank.address.thoroughfares.type.technicalKey` (string)
    Technical key of the Thoroughfare Type.
    Example: "INDUSTRIAL_ZONE"

  - `values.bank.address.thoroughfares.shortName` (string)
    Abbreviation of the [Thoroughfare](https://meta.cdq.com/Address/thoroughfare).
    Example: "Lukasstr. 4"

  - `values.bank.address.thoroughfares.number` (string)
    Number of the [Thoroughfare](https://meta.cdq.com/Address/thoroughfare).
    Example: "4"

  - `values.bank.address.thoroughfares.value` (string)
    Comprehensive designation of the [Thoroughfare](https://meta.cdq.com/Address/thoroughfare) including the thoroughfare type such as Street, or Rue.
    Example: "Lukasstraße 4"

  - `values.bank.address.thoroughfares.name` (string)
    Pure name of the [Thoroughfare](https://meta.cdq.com/Address/thoroughfare) not comprising the thoroughfare type such as Street, or Rue.
    Example: "Lukasstraße"

  - `values.bank.address.thoroughfares.direction` (string)
    Direction of the [Thoroughfare](https://meta.cdq.com/Address/thoroughfare).
    Example: "221-bis Baker Street, North"

  - `values.bank.address.premises` (array)

  - `values.bank.address.premises.value` (string)
    The actual value of a Premise in the language of the address.
    Example: "Lukasstraße 4"

  - `values.bank.address.premises.shortName` (string)
    Abbreviation of the Premise.
    Example: "Lukasstr. 4"

  - `values.bank.address.premises.number` (string)
    Number of the Premise.
    Example: "4"

  - `values.bank.address.premises.type` (object)
    Type of the Premise.

  - `values.bank.address.premises.type.name` (string)
    Display label for the Premise Type.
    Example: "Factory"

  - `values.bank.address.premises.type.url` (string)
    URL to the documentation which summarizes all details of the [Premise Type](https://meta.cdq.com/Address/premise/type).
    Example: "https://meta.cdq.com/Address/premise/type"

  - `values.bank.address.premises.type.technicalKey` (string)
    Technical key of the Premise Type.
    Example: "FACTORY"

  - `values.bank.address.postalDeliveryPoints` (array)

  - `values.bank.address.postalDeliveryPoints.type` (object)
    A single mailbox or other place at which postal mail is delivered.

  - `values.bank.address.postalDeliveryPoints.type.name` (string)
    Display label for the Postal Delivery Point Type.
    Example: "Mailbox"

  - `values.bank.address.postalDeliveryPoints.type.url` (string)
    URL to the documentation which summarizes all details of the [Postal Delivery Point](https://meta.cdq.com/Address/postal_delivery_point/type)
    Example: "https://meta.cdq.com/Address/postal_delivery_point/type"

  - `values.bank.address.postalDeliveryPoints.type.technicalKey` (string)
    Technical key of the Postal Delivery Point.
    Example: "MAILBOX"

  - `values.bank.address.postalDeliveryPoints.shortName` (string)
    Stort name of the [Postal Delivery Point](https://meta.cdq.com/Address/postal_delivery_point).
    Example: "St Gallen, Postfach 460"

  - `values.bank.address.postalDeliveryPoints.number` (string)
    Number of the [Postal Delivery Point](https://meta.cdq.com/Address/postal_delivery_point).
    Example: "460"

  - `values.bank.address.postalDeliveryPoints.value` (string)
    Value of the [Postal Delivery Point](https://meta.cdq.com/Address/postal_delivery_point).
    Example: "Postfach"

  - `values.bank.address.openingHours` (array)

  - `values.bank.address.openingHours.openingHour` (string)
    Company openning hour.
    Example: "09:00 AM"

  - `values.bank.address.openingHours.closingHour` (string)
    Company closing hour.
    Example: "05:00 PM"

  - `values.bank.address.openingHours.weekday` (string)
    A day in the week in which the company is open.
    Example: "Monday"

  - `values.bank.address.geographicCoordinates` (object)
    Decimal geographic coordinates (WGS 84 - reference coordinate system).

  - `values.bank.address.geographicCoordinates.latitude` (number)
    Plain on the earth's surface north or south of the equator.
    Example: "47.439549"

  - `values.bank.address.geographicCoordinates.longitude` (number)
    Plain on the earth's surface east or west of a meridian.
    Example: "9.395275"

  - `values.bank.address.types` (array)

  - `values.bank.address.types.name` (string)
    Display label for the Address Type.
    Example: "Legal Address"

  - `values.bank.address.types.url` (string)
    URL to the documentation which summarizes all details of the [Address Type](https://meta.cdq.com/Address/type).
    Example: "https://meta.cdq.com/Address/type"

  - `values.bank.address.types.technicalKey` (string)
    Technical key of the Address Type.
    Example: "LEGAL_ADDRESS"

  - `values.bank.address.formattedAddress` (object)
    A formatted address is a structured address of VIES data source.

  - `values.bank.address.formattedAddress.country` (string)
    Country name.
    Example: "Switzerland"

  - `values.bank.address.formattedAddress.administrativeArea` (string)
    A top-level geographical or political area division in a country.
    Example: "Sankt Gallen"

  - `values.bank.address.formattedAddress.region` (string)
    Top level subdivision of a country.
    Example: "Sankt Gallen"

  - `values.bank.address.formattedAddress.regionCode` (string)
    A country specific code for a certain address in the region.
    Example: "9004"

  - `values.bank.address.formattedAddress.locality` (string)
    A locality is a named densely populated area (a place) such as town, village, suburb, etc. A locality composes of many individual addresses.
    Example: "Sankt Gallen"

  - `values.bank.address.formattedAddress.district` (string)
    Type of administrative division that, in some countries, is managed by local government. Across the world, areas known as "districts" vary greatly in size, spanning regions or counties, several municipalities, subdivisions of municipalities, school district, or political district.
    Example: "City center"

  - `values.bank.address.formattedAddress.postalCode` (string)
    A country specific code for a certain address.
    Example: "9000"

  - `values.bank.address.formattedAddress.thoroughfare` (string)
    Details of the access route along which buildings, lots, or land are located, such as street, road, channel, crescent, avenue.
    Example: "Lukassstrasse"

  - `values.bank.address.formattedAddress.premise` (string)
    A premise is a tract of land including its buildings. A premise may have several sub-levels to precisely identify.
    Example: "Lukasstraße 4, Building 2, Floor 3, Room 4"

  - `values.bank.address.formattedAddress.interurbanDeliveryPoint` (string)
    A single mailbox or other place at which postal mail is delivered.
    Example: "Sankt Gallen, Postfach 460"

  - `values.bank.address.formattedAddress.mailbox` (string)
    A location at an address where the post is delivered to.
    Example: "Postfach 460"

  - `values.bank.address.formattedAddress.postOfficeBox` (string)
    A uniquely addressable lockable box located on the premises of a post office station.
    Example: "Postfach 460"

  - `values.vendorPaymentSummary` (object)
    Metadata required for calculation of trust score of bank account.

  - `values.vendorPaymentSummary.firstPaymentDate` (string)
    The date of the first payment to the bank account (ISO 8601-compliant).
    Example: "2025-08-29T09:46:42Z"

  - `values.vendorPaymentSummary.lastPaymentDate` (string)
    The date of the last payment to the bank account (ISO 8601-compliant).
    Example: "2025-08-29T09:46:42Z"

  - `values.vendorPaymentSummary.numberOfPayments` (integer)
    The number of payments to the bank account.
    Example: "1"

  - `values.externalId` (string)
    Arbitrary identifier type to mark bank account IDs that are "external" from CDQ's perspective. This is the identifier a customer provides to identify its records.
    Example: "The ID managed in the customer's SAP systems."

  - `values.id` (string)
    The ID of the bank account.
    Example: "63e635235c06b7396330fe40"

  - `nextStartAfter` (string)
    Provides a value to be used as a startAfter in next page request.
    Example: "5712566172571652"

## Response 400 fields (application/json):

  - `id` (string)
    Unique identifier of the error.
    Example: "5c6a2c7e-9b0a-4e1a-8b0a-4e1a8b0a4e1a"

  - `path` (string)
    Requested path which caused this error.
    Example: "/v2/businesspartners/lookup"

  - `timestamp` (string)
    ISO 8601 representation of the timestamp.
    Example: "2025-08-29T09:46:42Z"

  - `message` (string)
    Details about the error.
    Example: "This user is not allowed to access this service."

  - `error` (string)
    RFC 7231 error which belongs to the status code.
    Example: "BAD_REQUEST"

  - `status` (integer)
    RFC 7231 status code for this error.
    Example: "400"