> ## Documentation Index
> Fetch the complete documentation index at: https://docs.codaclean.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Banken oplijsten

> Banks for which Codaclean can request a mandate: CODA banks, and banks reachable through a CODAlight connector.

Banks reachable through a connector carry a `connectorId`.

Sorted by country, then name.

**Required scope:** `customers:read`




## OpenAPI

````yaml POST /banks
openapi: 3.1.0
info:
  title: Codaclean API
  version: '1.0'
  description: >
    The Codaclean external API lets partner software (accounting tools, practice
    management software, sync agents) integrate with Codaclean on behalf of an
    accounting firm: manage its customers, request CODA and CODB mandates, and
    retrieve the CODA and CODB files Codaclean receives for them.
servers:
  - url: https://api.codaclean.io/v1
    description: Production
  - url: https://api.test.codaclean.io/v1
    description: Staging
security:
  - apiKeyAuth: []
    bearerAuth: []
tags:
  - name: Authentication
    description: Obtain and refresh the ID token sent with every other call.
  - name: Utilities
    description: Connectivity check.
  - name: Customers
    description: The customers (client companies) managed by the accounting firm.
  - name: Bank accounts
    description: Bank accounts (IBANs) linked to a customer.
  - name: Customer payroll providers
    description: Payroll providers (social secretariats) linked to a customer.
  - name: Mandates
    description: CODA mandates (per bank account) and CODB mandates (per payroll provider).
  - name: Reference data
    description: Banks and payroll providers known to Codaclean.
  - name: CODA files
    description: Bank statement files in CODA format.
  - name: CODB files
    description: Payroll files in CODB format, delivered by payroll providers.
paths:
  /banks:
    post:
      tags:
        - Reference data
      summary: List banks
      description: >
        Banks for which Codaclean can request a mandate: CODA banks, and banks
        reachable through a CODAlight connector.


        Banks reachable through a connector carry a `connectorId`.


        Sorted by country, then name.


        **Required scope:** `customers:read`
      operationId: searchBanks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BankSearch'
            examples:
              byBic:
                summary: By BIC
                value:
                  bic: GEBA BE BB
              page:
                summary: First five banks
                value:
                  limit: 5
      responses:
        '200':
          description: Matching banks.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankList'
              examples:
                byBic:
                  summary: By BIC
                  value:
                    records:
                      - name: BNP Paribas Fortis
                        country: BE
                        bicCodes:
                          - GEBA BE BB
                        available: true
                    recordsTotal: 1980
                    recordsFiltered: 1
                page:
                  summary: First five banks
                  value:
                    records:
                      - name: PayPal
                        country: AD
                        connectorId: 1553
                        bicCodes:
                          - PPLX LU LL
                        available: true
                      - name: PayPal
                        country: AE
                        connectorId: 1547
                        bicCodes:
                          - PPLX LU LL
                        available: true
                      - name: PayPal
                        country: AG
                        connectorId: 1451
                        bicCodes:
                          - PPLX LU LL
                        available: true
                      - name: PayPal
                        country: AI
                        connectorId: 1450
                        bicCodes:
                          - PPLX LU LL
                        available: true
                      - name: PayPal
                        country: AL
                        connectorId: 1552
                        bicCodes:
                          - PPLX LU LL
                        available: true
                    recordsTotal: 1980
                    recordsFiltered: 1980
        '400':
          description: >-
            Invalid request (`invalidPayload`, `unknownField`,
            `invalidIdentifier`…).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                invalidPayload:
                  summary: Body is not valid JSON
                  value:
                    message: Request body is not a valid JSON object
                    code: invalidPayload
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    BankSearch:
      type: object
      properties:
        bic:
          type: string
          description: Spaces are ignored.
        country:
          type: string
          description: Country code, case-insensitive.
        available:
          type: boolean
        limit:
          type: integer
          default: 50
          maximum: 200
        offset:
          type: integer
          default: 0
    BankList:
      type: object
      properties:
        records:
          type: array
          items:
            $ref: '#/components/schemas/Bank'
        recordsTotal:
          type: integer
        recordsFiltered:
          type: integer
    Error:
      type: object
      description: >
        Error body. `code` is a stable, machine-readable token; it is present on
        errors returned by the customers, mandates and reference-data endpoints.
        Some errors carry extra keys, such as `fields` or `candidates`.
      required:
        - message
      properties:
        message:
          type: string
          description: Human-readable description. Do not parse it.
        code:
          type: string
          description: |
            Machine-readable error code.

            **See also:** [Errors](/api/errors#error-codes)
        fields:
          type: array
          items:
            type: string
          description: >-
            Offending fields. Present with `unknownField` and
            `fieldNotUpdatable`.
        candidates:
          type: array
          description: Present with `connectorSelectionRequired`.
          items:
            $ref: '#/components/schemas/ConnectorCandidate'
    Bank:
      type: object
      properties:
        name:
          type: string
        country:
          type: string
        connectorId:
          type: integer
          description: >-
            Present only for banks served through a CODAlight connector. Absent
            for CODA banks.
        bicCodes:
          type: array
          description: >-
            BIC codes of the bank, formatted with spaces, for example `GKCC BE
            BB`.
          items:
            type: string
        available:
          type: boolean
    ConnectorCandidate:
      type: object
      properties:
        connectorId:
          type: integer
        name:
          type: string
        bicCode:
          type: string
        available:
          type: boolean
    Message:
      type: object
      description: Confirmation returned by actions that do not return a resource.
      required:
        - message
      properties:
        message:
          type: string
  responses:
    Unauthorized:
      description: >-
        Missing, invalid or expired ID token, or user not allowed to use the
        API.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Message'
          examples:
            noToken:
              summary: No ID token
              value:
                message: Unauthorized
            invalidToken:
              summary: Invalid or expired ID token
              value:
                message: Unauthorized
    Forbidden:
      description: >-
        Missing or invalid API key, missing scope (`forbiddenScope`), or access
        denied.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            noApiKey:
              summary: No API key
              value:
                message: Forbidden
            invalidApiKey:
              summary: Invalid API key
              value:
                message: Forbidden
    TooManyRequests:
      description: Rate limit or quota exceeded for this API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Message'
          examples:
            tooManyRequests:
              summary: Rate limit exceeded
              value:
                message: Too Many Requests
    InternalError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            internalError:
              summary: Unexpected server error
              value:
                message: Internal server error
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Identifies the partner software. Issued by Codaclean. Required on every
        call, including `POST /token`.
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT (Cognito ID token)
      description: >-
        Identifies the user and their accounting firm. Send the `idToken`
        returned by `POST /token` as `Authorization: Bearer <idToken>`. Valid
        for 1 hour.

````