> ## 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.

# List CODB files

> Processed CODB files, grouped by customer, then by payroll provider and year.

Each file comes with a pre-signed download URL, valid for 30 minutes.

Files already acknowledged with this API key and user are hidden, unless `redownload` is `true`.

The list is not paginated. Only files of customers the user can access are included.

Files arrive in the morning: polling twice a day is enough.

Always send a JSON body, at least `{}`.

**Required scope:** `files:read`




## OpenAPI

````yaml POST /codb-files
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:
  /codb-files:
    post:
      tags:
        - CODB files
      summary: List CODB files
      description: >
        Processed CODB files, grouped by customer, then by payroll provider and
        year.


        Each file comes with a pre-signed download URL, valid for 30 minutes.


        Files already acknowledged with this API key and user are hidden, unless
        `redownload` is `true`.


        The list is not paginated. Only files of customers the user can access
        are included.


        Files arrive in the morning: polling twice a day is enough.


        Always send a JSON body, at least `{}`.


        **Required scope:** `files:read`
      operationId: listCodbFiles
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CodbFilesSearch'
            examples:
              all:
                summary: All files, acknowledged included
                value:
                  redownload: true
              withPdf:
                summary: With PDF
                value:
                  redownload: true
                  includePdf: true
      responses:
        '200':
          description: Matching files, grouped by customer.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CodbFilesCustomer'
              examples:
                all:
                  summary: Files
                  value:
                    - id: 675b4183d350b74dad2f46ec
                      name: Boulangerie Dupont SRL
                      accountingRef: DUPONT
                      enterpriseNumber: 0764.042.472
                      isConfidential: false
                      payrollProviders:
                        - payrollProvider: Twinntax
                          year: 2025
                          files:
                            - id: 68f4fadfc617c0d3dd9b2f7f
                              fileName: >-
                                0006_CODB_TWINNTAX_BE0764042472_202506_20250630.xml
                              statementDate: '2025-06-30'
                              statementNumber: 6
                              accountPeriod: 202506
                              processedOn: '2025-10-19T14:51:43.797Z'
                              urls:
                                codb: >-
                                  https://codaclean-files.s3.eu-west-1.amazonaws.com/3f1c2a9e-7b4d-4e8a-9c21-5d6e7f8a9b0c/DUPONT/2025/CODB/0006_CODB_TWINNTAX_BE0764042472_202506_20250630.xml?AWSAccessKeyId=ASIAIOSFODNN7EXAMPLE&Expires=1790427811&Signature=EXAMPLE_SIGNATURE&x-amz-security-token=IQoJb3JpZ2luX2VjEXAMPLE_SESSION_TOKEN&response-content-disposition=attachment%3B+filename%3D%220006_CODB_TWINNTAX_BE0764042472_202506_20250630.xml%22
                            - id: 68f4fadf189b5fcd1ef94461
                              fileName: >-
                                0007_CODB_TWINNTAX_BE0764042472_202507_20250731.xml
                              statementDate: '2025-07-31'
                              statementNumber: 7
                              accountPeriod: 202507
                              processedOn: '2025-10-19T14:51:43.713Z'
                              urls:
                                codb: >-
                                  https://codaclean-files.s3.eu-west-1.amazonaws.com/3f1c2a9e-7b4d-4e8a-9c21-5d6e7f8a9b0c/DUPONT/2025/CODB/0007_CODB_TWINNTAX_BE0764042472_202507_20250731.xml?AWSAccessKeyId=ASIAIOSFODNN7EXAMPLE&Expires=1790427811&Signature=EXAMPLE_SIGNATURE&x-amz-security-token=IQoJb3JpZ2luX2VjEXAMPLE_SESSION_TOKEN&response-content-disposition=attachment%3B+filename%3D%220007_CODB_TWINNTAX_BE0764042472_202507_20250731.xml%22
                        - payrollProvider: sdworx
                          year: 2025
                          files:
                            - id: 68f39c9f50d2196899901d8f
                              fileName: >-
                                0001_CODB_SDWORX_BE0764042472_202501_20250128.xml
                              statementDate: '2025-01-28'
                              statementNumber: 1
                              accountPeriod: 202501
                              processedOn: '2025-11-12T13:57:19.938Z'
                              urls:
                                codb: >-
                                  https://codaclean-files.s3.eu-west-1.amazonaws.com/3f1c2a9e-7b4d-4e8a-9c21-5d6e7f8a9b0c/DUPONT/2025/CODB/0001_CODB_SDWORX_BE0764042472_202501_20250128.xml?AWSAccessKeyId=ASIAIOSFODNN7EXAMPLE&Expires=1790427811&Signature=EXAMPLE_SIGNATURE&x-amz-security-token=IQoJb3JpZ2luX2VjEXAMPLE_SESSION_TOKEN&response-content-disposition=attachment%3B+filename%3D%220001_CODB_SDWORX_BE0764042472_202501_20250128.xml%22
                            - id: 68f39ca1b8e50f5763f91c53
                              fileName: >-
                                0002_CODB_SDWORX_BE0764042472_202501_20250129.xml
                              statementDate: '2025-01-29'
                              statementNumber: 2
                              accountPeriod: 202501
                              processedOn: '2025-10-18T13:57:20.073Z'
                              urls:
                                codb: >-
                                  https://codaclean-files.s3.eu-west-1.amazonaws.com/3f1c2a9e-7b4d-4e8a-9c21-5d6e7f8a9b0c/DUPONT/2025/CODB/0002_CODB_SDWORX_BE0764042472_202501_20250129.xml?AWSAccessKeyId=ASIAIOSFODNN7EXAMPLE&Expires=1790427811&Signature=EXAMPLE_SIGNATURE&x-amz-security-token=IQoJb3JpZ2luX2VjEXAMPLE_SESSION_TOKEN&response-content-disposition=attachment%3B+filename%3D%220002_CODB_SDWORX_BE0764042472_202501_20250129.xml%22
                    - id: 675b41d6d350b74dad2f46ed
                      name: Garage Peeters BV
                      accountingRef: PEETERS
                      enterpriseNumber: 0755.556.457
                      isConfidential: false
                      payrollProviders:
                        - payrollProvider: partena_professional
                          year: 2025
                          files:
                            - id: 68f39c9f9cb1e80ff7f7bf21
                              fileName: >-
                                0001_CODB_PARTENA_PROFESSIONAL_BE0755556457_202501_20250205.xml
                              statementDate: '2025-02-05'
                              statementNumber: 1
                              accountPeriod: 202501
                              processedOn: '2025-11-12T13:57:19.767Z'
                              urls:
                                codb: >-
                                  https://codaclean-files.s3.eu-west-1.amazonaws.com/3f1c2a9e-7b4d-4e8a-9c21-5d6e7f8a9b0c/PEETERS/2025/CODB/0001_CODB_PARTENA_PROFESSIONAL_BE0755556457_202501_20250205.xml?AWSAccessKeyId=ASIAIOSFODNN7EXAMPLE&Expires=1790427811&Signature=EXAMPLE_SIGNATURE&x-amz-security-token=IQoJb3JpZ2luX2VjEXAMPLE_SESSION_TOKEN&response-content-disposition=attachment%3B+filename%3D%220001_CODB_PARTENA_PROFESSIONAL_BE0755556457_202501_20250205.xml%22
                            - id: 68f39ca1b211cc722e5fa9bc
                              fileName: >-
                                0002_CODB_PARTENA_PROFESSIONAL_BE0755556457_202501_20250205.xml
                              statementDate: '2025-02-05'
                              statementNumber: 2
                              accountPeriod: 202501
                              processedOn: '2025-10-18T13:57:22.042Z'
                              urls:
                                codb: >-
                                  https://codaclean-files.s3.eu-west-1.amazonaws.com/3f1c2a9e-7b4d-4e8a-9c21-5d6e7f8a9b0c/PEETERS/2025/CODB/0002_CODB_PARTENA_PROFESSIONAL_BE0755556457_202501_20250205.xml?AWSAccessKeyId=ASIAIOSFODNN7EXAMPLE&Expires=1790427811&Signature=EXAMPLE_SIGNATURE&x-amz-security-token=IQoJb3JpZ2luX2VjEXAMPLE_SESSION_TOKEN&response-content-disposition=attachment%3B+filename%3D%220002_CODB_PARTENA_PROFESSIONAL_BE0755556457_202501_20250205.xml%22
                withPdf:
                  summary: Files with PDF
                  value:
                    - id: 675b4183d350b74dad2f46ec
                      name: Boulangerie Dupont SRL
                      accountingRef: DUPONT
                      enterpriseNumber: 0764.042.472
                      isConfidential: false
                      payrollProviders:
                        - payrollProvider: Twinntax
                          year: 2025
                          files:
                            - id: 68f4fadfc617c0d3dd9b2f7f
                              fileName: >-
                                0006_CODB_TWINNTAX_BE0764042472_202506_20250630.xml
                              statementDate: '2025-06-30'
                              statementNumber: 6
                              accountPeriod: 202506
                              processedOn: '2025-10-19T14:51:43.797Z'
                              urls:
                                codb: >-
                                  https://codaclean-files.s3.eu-west-1.amazonaws.com/3f1c2a9e-7b4d-4e8a-9c21-5d6e7f8a9b0c/DUPONT/2025/CODB/0006_CODB_TWINNTAX_BE0764042472_202506_20250630.xml?AWSAccessKeyId=ASIAIOSFODNN7EXAMPLE&Expires=1790427812&Signature=EXAMPLE_SIGNATURE&x-amz-security-token=IQoJb3JpZ2luX2VjEXAMPLE_SESSION_TOKEN&response-content-disposition=attachment%3B+filename%3D%220006_CODB_TWINNTAX_BE0764042472_202506_20250630.xml%22
                                pdf: >-
                                  https://codaclean-files.s3.eu-west-1.amazonaws.com/3f1c2a9e-7b4d-4e8a-9c21-5d6e7f8a9b0c/DUPONT/2025/CODB/PDF/0006_CODB_TWINNTAX_BE0764042472_202506_20250630.pdf?AWSAccessKeyId=ASIAIOSFODNN7EXAMPLE&Expires=1790427812&Signature=EXAMPLE_SIGNATURE&x-amz-security-token=IQoJb3JpZ2luX2VjEXAMPLE_SESSION_TOKEN
                            - id: 68f4fadf189b5fcd1ef94461
                              fileName: >-
                                0007_CODB_TWINNTAX_BE0764042472_202507_20250731.xml
                              statementDate: '2025-07-31'
                              statementNumber: 7
                              accountPeriod: 202507
                              processedOn: '2025-10-19T14:51:43.713Z'
                              urls:
                                codb: >-
                                  https://codaclean-files.s3.eu-west-1.amazonaws.com/3f1c2a9e-7b4d-4e8a-9c21-5d6e7f8a9b0c/DUPONT/2025/CODB/0007_CODB_TWINNTAX_BE0764042472_202507_20250731.xml?AWSAccessKeyId=ASIAIOSFODNN7EXAMPLE&Expires=1790427812&Signature=EXAMPLE_SIGNATURE&x-amz-security-token=IQoJb3JpZ2luX2VjEXAMPLE_SESSION_TOKEN&response-content-disposition=attachment%3B+filename%3D%220007_CODB_TWINNTAX_BE0764042472_202507_20250731.xml%22
                                pdf: >-
                                  https://codaclean-files.s3.eu-west-1.amazonaws.com/3f1c2a9e-7b4d-4e8a-9c21-5d6e7f8a9b0c/DUPONT/2025/CODB/PDF/0007_CODB_TWINNTAX_BE0764042472_202507_20250731.pdf?AWSAccessKeyId=ASIAIOSFODNN7EXAMPLE&Expires=1790427812&Signature=EXAMPLE_SIGNATURE&x-amz-security-token=IQoJb3JpZ2luX2VjEXAMPLE_SESSION_TOKEN
                        - payrollProvider: sdworx
                          year: 2025
                          files:
                            - id: 68f39c9f50d2196899901d8f
                              fileName: >-
                                0001_CODB_SDWORX_BE0764042472_202501_20250128.xml
                              statementDate: '2025-01-28'
                              statementNumber: 1
                              accountPeriod: 202501
                              processedOn: '2025-11-12T13:57:19.938Z'
                              urls:
                                codb: >-
                                  https://codaclean-files.s3.eu-west-1.amazonaws.com/3f1c2a9e-7b4d-4e8a-9c21-5d6e7f8a9b0c/DUPONT/2025/CODB/0001_CODB_SDWORX_BE0764042472_202501_20250128.xml?AWSAccessKeyId=ASIAIOSFODNN7EXAMPLE&Expires=1790427812&Signature=EXAMPLE_SIGNATURE&x-amz-security-token=IQoJb3JpZ2luX2VjEXAMPLE_SESSION_TOKEN&response-content-disposition=attachment%3B+filename%3D%220001_CODB_SDWORX_BE0764042472_202501_20250128.xml%22
                                pdf: >-
                                  https://codaclean-files.s3.eu-west-1.amazonaws.com/3f1c2a9e-7b4d-4e8a-9c21-5d6e7f8a9b0c/DUPONT/2025/CODB/PDF/0001_CODB_SDWORX_BE0764042472_202501_20250128.pdf?AWSAccessKeyId=ASIAIOSFODNN7EXAMPLE&Expires=1790427812&Signature=EXAMPLE_SIGNATURE&x-amz-security-token=IQoJb3JpZ2luX2VjEXAMPLE_SESSION_TOKEN
                            - id: 68f39ca1b8e50f5763f91c53
                              fileName: >-
                                0002_CODB_SDWORX_BE0764042472_202501_20250129.xml
                              statementDate: '2025-01-29'
                              statementNumber: 2
                              accountPeriod: 202501
                              processedOn: '2025-10-18T13:57:20.073Z'
                              urls:
                                codb: >-
                                  https://codaclean-files.s3.eu-west-1.amazonaws.com/3f1c2a9e-7b4d-4e8a-9c21-5d6e7f8a9b0c/DUPONT/2025/CODB/0002_CODB_SDWORX_BE0764042472_202501_20250129.xml?AWSAccessKeyId=ASIAIOSFODNN7EXAMPLE&Expires=1790427812&Signature=EXAMPLE_SIGNATURE&x-amz-security-token=IQoJb3JpZ2luX2VjEXAMPLE_SESSION_TOKEN&response-content-disposition=attachment%3B+filename%3D%220002_CODB_SDWORX_BE0764042472_202501_20250129.xml%22
                                pdf: >-
                                  https://codaclean-files.s3.eu-west-1.amazonaws.com/3f1c2a9e-7b4d-4e8a-9c21-5d6e7f8a9b0c/DUPONT/2025/CODB/PDF/0002_CODB_SDWORX_BE0764042472_202501_20250129.pdf?AWSAccessKeyId=ASIAIOSFODNN7EXAMPLE&Expires=1790427812&Signature=EXAMPLE_SIGNATURE&x-amz-security-token=IQoJb3JpZ2luX2VjEXAMPLE_SESSION_TOKEN
                    - id: 675b41d6d350b74dad2f46ed
                      name: Garage Peeters BV
                      accountingRef: PEETERS
                      enterpriseNumber: 0755.556.457
                      isConfidential: false
                      payrollProviders:
                        - payrollProvider: partena_professional
                          year: 2025
                          files:
                            - id: 68f39c9f9cb1e80ff7f7bf21
                              fileName: >-
                                0001_CODB_PARTENA_PROFESSIONAL_BE0755556457_202501_20250205.xml
                              statementDate: '2025-02-05'
                              statementNumber: 1
                              accountPeriod: 202501
                              processedOn: '2025-11-12T13:57:19.767Z'
                              urls:
                                codb: >-
                                  https://codaclean-files.s3.eu-west-1.amazonaws.com/3f1c2a9e-7b4d-4e8a-9c21-5d6e7f8a9b0c/PEETERS/2025/CODB/0001_CODB_PARTENA_PROFESSIONAL_BE0755556457_202501_20250205.xml?AWSAccessKeyId=ASIAIOSFODNN7EXAMPLE&Expires=1790427812&Signature=EXAMPLE_SIGNATURE&x-amz-security-token=IQoJb3JpZ2luX2VjEXAMPLE_SESSION_TOKEN&response-content-disposition=attachment%3B+filename%3D%220001_CODB_PARTENA_PROFESSIONAL_BE0755556457_202501_20250205.xml%22
                                pdf: >-
                                  https://codaclean-files.s3.eu-west-1.amazonaws.com/3f1c2a9e-7b4d-4e8a-9c21-5d6e7f8a9b0c/PEETERS/2025/CODB/PDF/0001_CODB_PARTENA_PROFESSIONAL_BE0755556457_202501_20250205.pdf?AWSAccessKeyId=ASIAIOSFODNN7EXAMPLE&Expires=1790427812&Signature=EXAMPLE_SIGNATURE&x-amz-security-token=IQoJb3JpZ2luX2VjEXAMPLE_SESSION_TOKEN
                            - id: 68f39ca1b211cc722e5fa9bc
                              fileName: >-
                                0002_CODB_PARTENA_PROFESSIONAL_BE0755556457_202501_20250205.xml
                              statementDate: '2025-02-05'
                              statementNumber: 2
                              accountPeriod: 202501
                              processedOn: '2025-10-18T13:57:22.042Z'
                              urls:
                                codb: >-
                                  https://codaclean-files.s3.eu-west-1.amazonaws.com/3f1c2a9e-7b4d-4e8a-9c21-5d6e7f8a9b0c/PEETERS/2025/CODB/0002_CODB_PARTENA_PROFESSIONAL_BE0755556457_202501_20250205.xml?AWSAccessKeyId=ASIAIOSFODNN7EXAMPLE&Expires=1790427812&Signature=EXAMPLE_SIGNATURE&x-amz-security-token=IQoJb3JpZ2luX2VjEXAMPLE_SESSION_TOKEN&response-content-disposition=attachment%3B+filename%3D%220002_CODB_PARTENA_PROFESSIONAL_BE0755556457_202501_20250205.xml%22
                                pdf: >-
                                  https://codaclean-files.s3.eu-west-1.amazonaws.com/3f1c2a9e-7b4d-4e8a-9c21-5d6e7f8a9b0c/PEETERS/2025/CODB/PDF/0002_CODB_PARTENA_PROFESSIONAL_BE0755556457_202501_20250205.pdf?AWSAccessKeyId=ASIAIOSFODNN7EXAMPLE&Expires=1790427812&Signature=EXAMPLE_SIGNATURE&x-amz-security-token=IQoJb3JpZ2luX2VjEXAMPLE_SESSION_TOKEN
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    CodbFilesSearch:
      type: object
      properties:
        redownload:
          type: boolean
          default: false
          description: >
            By default, files already acknowledged with this API key and user
            are hidden. Set to `true` to list them again.
        customer:
          type: string
          description: Customer name.
        enterpriseNumber:
          type: string
          description: Belgian enterprise number, formatted `0123.456.789`.
        payrollProvider:
          type: string
          description: >-
            Payroll provider name as written in the files, as reported in
            `payrollProviders[].payrollProvider` (for example `Twinntax`).
        accountPeriod:
          type: integer
          description: >-
            Exact match on the account period of the file, as `YYYYMM` (for
            example `202609`).
        statementDate:
          type: object
          description: Range (inclusive) on the generation date of the file (`YYYY-MM-DD`).
          properties:
            from:
              type: string
              format: date
            to:
              type: string
              format: date
        processingDate:
          type: object
          description: Range (inclusive) on the date Codaclean processed the file.
          properties:
            from:
              type: string
              format: date-time
            to:
              type: string
              format: date-time
        statementNumber:
          type: object
          description: Range (inclusive) on the sequence number of the file.
          properties:
            from: {}
            to: {}
        includePdf:
          type: boolean
          default: false
          description: Also return a download URL for the PDF version of each file.
    CodbFilesCustomer:
      type: object
      properties:
        id:
          type: string
          description: Customer identifier.
        name:
          type: string
        accountingRef:
          type: string
        enterpriseNumber:
          type: string
          description: Belgian enterprise number, formatted `0123.456.789`.
        isConfidential:
          type: boolean
        payrollProviders:
          type: array
          description: One entry per payroll provider and year.
          items:
            type: object
            properties:
              payrollProvider:
                type: string
                description: >-
                  Name of the payroll provider as written in the files (for
                  example `Twinntax`), which is not always its code.
              year:
                type: integer
              files:
                type: array
                items:
                  $ref: '#/components/schemas/CodbFile'
    CodbFile:
      type: object
      properties:
        id:
          type: string
          description: Use it to acknowledge the download.
        fileName:
          type: string
        statementDate:
          type: string
          format: date
          description: Generation date of the file.
        statementNumber:
          type: string
          description: >
            Sequence number of the file. Usually numeric (for example `"12"`),
            but it can also combine several sequence numbers (for example
            `"0103-0203"`): do not convert it to a number.
        accountPeriod:
          type: integer
          description: Account period of the file, as `YYYYMM` (for example `202609`).
        processedOn:
          type: string
          format: date-time
        urls:
          type: object
          description: Pre-signed download URLs, valid for 30 minutes.
          properties:
            codb:
              type: string
              format: uri
            pdf:
              type: string
              format: uri
              description: Present when `includePdf` is `true`.
    Message:
      type: object
      description: Confirmation returned by actions that do not return a resource.
      required:
        - message
      properties:
        message:
          type: string
    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'
    ConnectorCandidate:
      type: object
      properties:
        connectorId:
          type: integer
        name:
          type: string
        bicCode:
          type: string
        available:
          type: boolean
  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.

````