# List System Banks

List system banks with the given parameters.

Endpoint: GET /system/banks
Version: 2
Security: apiKey

## Query parameters:

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

  - `startAfter` (string)
    Indicator for the next page.
    Example: "5c6a2c7e-9b0a-4e1a-8b0a-4e1a8b0a4e1a"

  - `dataSourceIds` (array)
    Data Source IDs.
    Example: ["648824a691d8d2503d65103e"]

  - `externalId` (string)
    External ID.
    Example: "The ID managed in the customer's SAP systems."

## Response 200 fields (application/json):

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

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

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

  - `values` (array)
    List of banks.

  - `values.names` (array)
    Name of a bank.
    Example: "Swiss National Bank"

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

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

  - `values.names.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.names.type.name` (string)
    Name of the Bank Name Type.
    Example: "Bank name acronym"

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

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

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

  - `values.names.version.charset` (object)
    Character set.

  - `values.names.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.names.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.names.version.language` (object)
    Naming of a language according to ISO 639-1.

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

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

  - `values.contact` (object)
    Bank contact information.

  - `values.contact.emails` (array)

  - `values.contact.emails.address` (string)
    An actual email address of the bank.
    Example: "info@cdq.com"

  - `values.contact.emails.type` (object)
    A type of a email address of the bank.

  - `values.contact.emails.type.name` (string)
    Name of the Bank Contact Email Type.
    Example: "Bank contact email"

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

  - `values.contact.emails.type.technicalKey` (string)
    Technical key of the Bank Contact Email Type.
    Example: "BANK_CONTACT_EMAIL_TYPE"

  - `values.contact.phoneNumbers` (array)

  - `values.contact.phoneNumbers.countryPrefix` (string)
    A country prefix of a bank phone number.
    Example: "0041"

  - `values.contact.phoneNumbers.number` (string)
    A complete phone number of the bank without any country prefixes.
    Example: "58 631 00 00"

  - `values.contact.phoneNumbers.type` (object)
    A type of the bank phone number.

  - `values.contact.phoneNumbers.type.name` (string)
    Name of the Bank Contact Phone Number Type.
    Example: "Bank contact phone number"

  - `values.contact.phoneNumbers.type.url` (string)
    URL to the documentation which summarizes all details of the Bank Contact Phone Number Type.
    Example: "https://meta.cdq.com/Bank_account/bank/contact/phone_number/type"

  - `values.contact.phoneNumbers.type.technicalKey` (string)
    Technical key of the Bank Contact Phone Number Type.
    Example: "BANK_CONTACT_PHONE_TYPE_PHONE"

  - `values.contact.phoneNumbers.value` (string)
    The actual complete bank phone number incl. country prefix.
    Example: "0041 58 631 00 00"

  - `values.contact.websites` (array)

  - `values.contact.websites.url` (string)
    The actual URL of the bank's website.
    Example: "https://cdq.com"

  - `values.contact.websites.type` (object)
    A type of the bank's website.

  - `values.contact.websites.type.name` (string)
    Name of the Bank Contact Website Type.
    Example: "Bank contact website"

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

  - `values.contact.websites.type.technicalKey` (string)
    Technical key of the Bank Contact Website Type.
    Example: "BANK_CONTACT_WEBSITE_TYPE"

  - `values.identifiers` (array)

  - `values.identifiers.type` (object)
    Type of the Bank Identifier.

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

  - `values.identifiers.type.name` (string)
    Name of the Bank Identifier Type.
    Example: "Bank SWIFT Code"

  - `values.identifiers.type.technicalKey` (string)
    Technical Key of the Bank Identifier Type.
    Example: "WR_BSC"

  - `values.identifiers.value` (string)
    The actual value of the bank identifier.
    Example: "CH1234567890123456789"

  - `values.identifiers.issuingBody` (object)
    An Issuing Body is an organization or government institution that is responsible for assigning unique identifiers to individuals, organizations, or objects.

  - `values.identifiers.issuingBody.name` (string)
    Name of the Bank Issuing Body.
    Example: "Bank Identifier Code"

  - `values.identifiers.issuingBody.url` (string)
    URL to the documentation which summarizes all details of the Bank Issuing Body.
    Example: "https://meta.cdq.com/Bank_account/bank/identifier/issuing_body"

  - `values.identifiers.issuingBody.technicalKey` (string)
    Technical Key of the Bank Issuing Body.
    Example: "BIC"

  - `values.identifiers.status` (object)
    Status of the identifier.

  - `values.identifiers.status.name` (string)
    Name of the Identifier Status.
    Example: "Active"

  - `values.identifiers.status.technicalKey` (string)
    Technical key of the Identifier Status.
    Example: "ACTIVE"

  - `values.addresses` (array)
    List of addresses.

  - `values.addresses.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.addresses.version.characterSet` (object)
    Character set.

  - `values.addresses.version.characterSet.name` (any)

  - `values.addresses.version.characterSet.technicalKey` (any)

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

  - `values.addresses.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.addresses.externalId` (string)
    ID the address has in the external system where the record originates from.
    Example: "1"

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

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

  - `values.addresses.metadata.primaryProvenance.url` (any)

  - `values.addresses.metadata.primaryProvenance.cdqId` (any)

  - `values.addresses.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.addresses.careOf.value` (string)
    Value of the CareOf.
    Example: "CDQ GmbH c/o Product Department"

  - `values.addresses.contexts` (array)

  - `values.addresses.contexts.value` (any)

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

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

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

  - `values.addresses.administrativeAreas` (array)

  - `values.addresses.administrativeAreas.shortName` (any)

  - `values.addresses.administrativeAreas.fipsCode` (any)

  - `values.addresses.administrativeAreas.isoCode` (any)

  - `values.addresses.administrativeAreas.type` (any)

  - `values.addresses.administrativeAreas.language` (any)

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

  - `values.addresses.localities` (array)

  - `values.addresses.thoroughfares` (array)

  - `values.addresses.thoroughfares.number` (any)

  - `values.addresses.thoroughfares.direction` (any)

  - `values.addresses.premises` (array)

  - `values.addresses.postalDeliveryPoints` (array)

  - `values.addresses.openingHours` (array)

  - `values.addresses.openingHours.openingHour` (any)

  - `values.addresses.openingHours.closingHour` (any)

  - `values.addresses.openingHours.weekday` (any)

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

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

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

  - `values.addresses.types` (array)

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

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

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

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

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

  - `values.addresses.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.addresses.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.addresses.formattedAddress.postalCode` (string)
    A country specific code for a certain address.
    Example: "9000"

  - `values.addresses.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.addresses.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.addresses.formattedAddress.interurbanDeliveryPoint` (string)
    A single mailbox or other place at which postal mail is delivered.
    Example: "Sankt Gallen, Postfach 460"

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

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

  - `values.addresses.cdqId` (string)
    Unique identifier which identifies a Business Partner with one address. The same address versions has the same cdq ID.
    Example: "CDQID-1234567890"

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

  - `values.relations` (array)

  - `values.relations.startedAt` (string)
    ISO 8601 representation of the timestamp when the relation was created.
    Example: "2025-08-29T09:46:42Z"

  - `values.relations.endedAt` (string)
    ISO 8601 representation of the timestamp when the relation ended.
    Example: "2025-08-29T09:46:42Z"

  - `values.relations.type` (object)
    Type of the relation.

  - `values.relations.type.technicalKey` (string)
    Technical key of the relation type.
    Example: "BRANCH"

  - `values.relations.type.name` (string)
    Name of the relation type.
    Example: "Organizational Unit"

  - `values.relations.startNode` (string)
    CDQ ID of the starting node.
    Example: "FR.RC:5664645"

  - `values.relations.endNode` (string)
    CDQ ID of the target node.
    Example: "FR.RC:5664645"

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

  - `values.rawData` (object)
    Raw data of the bank.

  - `values.id` (string)
    The Technical ID of the Bank entry.
    Example: "CH1234567890123456789"

  - `values.createdAt` (string)
    Date of creation (ISO 8601-compliant).
    Example: "2025-08-29T09:46:42Z"

  - `values.lastModifiedAt` (string)
    Date of modification (ISO 8601-compliant).
    Example: "2025-08-29T09:46:42Z"