bunq Export Annual Overview API

openapi: 3.2.0
info:
  title: bunq Export Annual Overview API
  description: '***UPDATE:*** *We have released a beta version of the new bunq API documentation.*


    ***NOTICE:*** *We have updated the sandbox base url to `https://public-api.sandbox.bunq.com/v1/`. Please update your applications accordingly. Check here: for more info.*


    ***PSD2 NOTICE:*** *The second Payment Services Directive (PSD2) may affect your current or planned usage of our public API, as some of the API services are now subject to a permit. Please be aware that using our public API without the required PSD2 permit is at your own risk and take notice of our updated API Terms and Conditions on for more information.*


    # Introduction


    Welcome to bunq! - The bunq API is organised around REST. JSON will be returned in almost all responses from the API, including errors but excluding binary (image) files. - Please configure your implementation to send its API requests to `https://public-api.sandbox.bunq.com/v1/`

    - There is a version of the Android app that connects to the bunq Sandbox environment. To create accounts for the Sandbox app, please follow the steps in the Android Emulator section. ## Getting started


    Before you start sending API requests, you need to get an API key and activate it. API activation happens when you install the API key and link your IP address and device to it *(create an API context)*. The steps below will guide you through what you need to do to start sending custom API requests. Here is an overview of what you can use to get started with the bunq API:

    1. **Create an API key.** You can do it either in our developer portal or in the bunq app *(Profile → Security & Settings → Developers → API keys)*. If you want to test our sandbox first, our bunq Developer is the best place to start. 2. **Register a device.** A device can be a phone (private), computer or a server (public). You can register a new device by using the `POST /installation` and `POST /device-server` calls. This will activate your API key. You only need to do this once. 3. **Open a session.** Sessions are temporary and expire after the auto-logout time set for the user account. It can be changed by the account owner in the bunq app. 4. **Make your first call!**


    !bunq_API_context


    ## Versioning


    Developments in the financial sector, changing regulatory regimes and new feature requests require us to be flexible. This means we can iterate quickly to improve the API and related tooling. Therefore, we have chosen not to attach any version numbers to the changes just yet. We will inform you in a timely manner of any important changes we make before they are deployed on together.bunq.com. You can also subscribe to our API newsletter to make sure you don''t miss any important updates. # OAuth


    ## What is OAuth? OAuth 2.0 is a protocol that will let your app connect to bunq users in a safe and easy way. Please be aware that if you will gain access to the account information of other bunq users or initiate a payment for them, you may require a PSD2 permit. ## Get started with OAuth for bunq


    To initiate authorization into the bunq user accounts, you need to create an OAuth Client and register at least 1 redirect URL for it. You can have 1 OAuth Client at a time. Reuse your OAuth credentials for every authorization request. The list of steps below will help you to get started:


    1. Register an OAuth Client by creating an app in bunq Developer_._

    2. Add one or more Redirect URLs. 3. Get your `client_id` and `secret` from your app information tab in bunq Developer. 4. Redirect your users to the OAuth authorization request URL. 5. If the user accepts the authorization request, they will be redirected to the previously specified `redirect_uri` with an authorization `code` parameter. 6. Use the token endpoint to exchange the authorization `code` for an `access_token`. 7. Use the `access_token` as a normal API Key. Open a session or use our SDKs to get started. You can set up an OAuth Client and add redirect URLs to it using the dedicated endpoints too.'
  termsOfService: http://bunq.com/terms-api/
  contact:
    name: bunq Developer Support
    url: http://bunq.com/developer
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  version: '1.0'
servers:
- url: https://public-api.sandbox.bunq.com/{basePath}
  description: Sandbox server
  variables:
    basePath:
      default: v1
- url: https://api.bunq.com/{basePath}
  description: Production server
  variables:
    basePath:
      default: v1
tags:
- name: export-annual-overview
  description: ''
paths:
  /user/{userID}/export-annual-overview:
    post:
      tags:
      - export-annual-overview
      summary: CREATE export annual overview for user
      operationId: CREATE_ExportAnnualOverview_for_User
      description: Create a new annual overview for a specific year. An overview can be generated only for a past year.
      parameters:
      - in: path
        name: userID
        description: ''
        required: true
        schema:
          type: integer
      - $ref: '#/components/parameters/Cache-Control'
      - $ref: '#/components/parameters/User-Agent'
      - $ref: '#/components/parameters/X-Bunq-Language'
      - $ref: '#/components/parameters/X-Bunq-Region'
      - $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
      - $ref: '#/components/parameters/X-Bunq-Geolocation'
      - $ref: '#/components/parameters/X-Bunq-Client-Authentication'
      requestBody:
        description: ''
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExportAnnualOverview'
      responses:
        '200':
          description: Used to create new and read existing annual overviews of all the user's monetary accounts. Once created, annual overviews can be downloaded in PDF format via the 'export-annual-overview/{id}/content' endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportAnnualOverviewCreate'
          headers:
            X-Bunq-Client-Response-Id:
              $ref: '#/components/headers/X-Bunq-Client-Response-Id'
            X-Bunq-Client-Request-Id:
              $ref: '#/components/headers/X-Bunq-Client-Request-Id'
            X-Bunq-Server-Signature:
              $ref: '#/components/headers/X-Bunq-Server-Signature'
        '400':
          $ref: '#/components/responses/GenericError'
      x-summary-source: derived
    get:
      tags:
      - export-annual-overview
      summary: List all export annual overview for user
      operationId: List_all_ExportAnnualOverview_for_User
      description: List all the annual overviews for a user.
      parameters:
      - in: path
        name: userID
        description: ''
        required: true
        schema:
          type: integer
      - $ref: '#/components/parameters/Cache-Control'
      - $ref: '#/components/parameters/User-Agent'
      - $ref: '#/components/parameters/X-Bunq-Language'
      - $ref: '#/components/parameters/X-Bunq-Region'
      - $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
      - $ref: '#/components/parameters/X-Bunq-Geolocation'
      - $ref: '#/components/parameters/X-Bunq-Client-Authentication'
      responses:
        '200':
          description: Used to create new and read existing annual overviews of all the user's monetary accounts. Once created, annual overviews can be downloaded in PDF format via the 'export-annual-overview/{id}/content' endpoint.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ExportAnnualOverviewListing'
          headers:
            X-Bunq-Client-Response-Id:
              $ref: '#/components/headers/X-Bunq-Client-Response-Id'
            X-Bunq-Client-Request-Id:
              $ref: '#/components/headers/X-Bunq-Client-Request-Id'
            X-Bunq-Server-Signature:
              $ref: '#/components/headers/X-Bunq-Server-Signature'
        '400':
          $ref: '#/components/responses/GenericError'
      x-summary-source: derived
  /user/{userID}/export-annual-overview/{itemId}:
    get:
      tags:
      - export-annual-overview
      summary: READ export annual overview for user
      operationId: READ_ExportAnnualOverview_for_User
      description: Get an annual overview for a user by its id.
      parameters:
      - in: path
        name: userID
        description: ''
        required: true
        schema:
          type: integer
      - in: path
        name: itemId
        description: ''
        required: true
        schema:
          type: integer
      - $ref: '#/components/parameters/Cache-Control'
      - $ref: '#/components/parameters/User-Agent'
      - $ref: '#/components/parameters/X-Bunq-Language'
      - $ref: '#/components/parameters/X-Bunq-Region'
      - $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
      - $ref: '#/components/parameters/X-Bunq-Geolocation'
      - $ref: '#/components/parameters/X-Bunq-Client-Authentication'
      responses:
        '200':
          description: Used to create new and read existing annual overviews of all the user's monetary accounts. Once created, annual overviews can be downloaded in PDF format via the 'export-annual-overview/{id}/content' endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportAnnualOverviewRead'
          headers:
            X-Bunq-Client-Response-Id:
              $ref: '#/components/headers/X-Bunq-Client-Response-Id'
            X-Bunq-Client-Request-Id:
              $ref: '#/components/headers/X-Bunq-Client-Request-Id'
            X-Bunq-Server-Signature:
              $ref: '#/components/headers/X-Bunq-Server-Signature'
        '400':
          $ref: '#/components/responses/GenericError'
      x-summary-source: derived
    delete:
      tags:
      - export-annual-overview
      summary: DELETE export annual overview for user
      operationId: DELETE_ExportAnnualOverview_for_User
      description: Used to create new and read existing annual overviews of all the user's monetary accounts. Once created, annual overviews can be downloaded in PDF format via the 'export-annual-overview/{id}/content' endpoint.
      parameters:
      - in: path
        name: userID
        description: ''
        required: true
        schema:
          type: integer
      - in: path
        name: itemId
        description: ''
        required: true
        schema:
          type: integer
      - $ref: '#/components/parameters/Cache-Control'
      - $ref: '#/components/parameters/User-Agent'
      - $ref: '#/components/parameters/X-Bunq-Language'
      - $ref: '#/components/parameters/X-Bunq-Region'
      - $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
      - $ref: '#/components/parameters/X-Bunq-Geolocation'
      - $ref: '#/components/parameters/X-Bunq-Client-Authentication'
      responses:
        '200':
          description: Used to create new and read existing annual overviews of all the user's monetary accounts. Once created, annual overviews can be downloaded in PDF format via the 'export-annual-overview/{id}/content' endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportAnnualOverviewDelete'
          headers:
            X-Bunq-Client-Response-Id:
              $ref: '#/components/headers/X-Bunq-Client-Response-Id'
            X-Bunq-Client-Request-Id:
              $ref: '#/components/headers/X-Bunq-Client-Request-Id'
            X-Bunq-Server-Signature:
              $ref: '#/components/headers/X-Bunq-Server-Signature'
        '400':
          $ref: '#/components/responses/GenericError'
      x-summary-source: derived
components:
  parameters:
    X-Bunq-Geolocation:
      description: This header must specify the geolocation of the device. The format of this value is longitude latitude altitude radius country. The country is expected to be formatted of an ISO 3166-1 alpha-2 country code. When no geolocation is available or known the header must still be included but can be zero valued.
      schema:
        type: string
      required: false
      in: header
      name: X-Bunq-Geolocation
    Cache-Control:
      description: The standard HTTP Cache-Control header is required for all signed requests.
      schema:
        type: string
      required: false
      in: header
      name: Cache-Control
    User-Agent:
      description: The User-Agent header field should contain information about the user agent originating the request. There are no restrictions on the value of this header.
      schema:
        type: string
      required: true
      in: header
      name: User-Agent
    X-Bunq-Client-Request-Id:
      description: This header must specify an ID with each request that is unique for the logged in user. There are no restrictions for the format of this ID. However, the server will respond with an error when the same ID is used again on the same DeviceServer.
      schema:
        type: string
      required: false
      in: header
      name: X-Bunq-Client-Request-Id
    X-Bunq-Region:
      description: The X-Bunq-Region header must contain the region (country) of the client device. The value of this header is formatted as a ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code, separated by an underscore.
      schema:
        type: string
      required: false
      in: header
      name: X-Bunq-Region
    X-Bunq-Language:
      description: The X-Bunq-Language header must contain a preferred language indication. The value of this header is formatted as a ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code, separated by an underscore. Currently only the languages en_US and nl_NL are supported. Anything else will default to en_US.
      schema:
        type: string
      required: false
      in: header
      name: X-Bunq-Language
    X-Bunq-Client-Authentication:
      description: The authentication token is used to authenticate the source of the API call. It is required by all API calls except for POST /v1/installation. It is important to note that the device and session calls are using the token from the response of the installation call, while all the other calls use the token from the response of the session-server call
      schema:
        type: string
      required: true
      in: header
      name: X-Bunq-Client-Authentication
  schemas:
    ExportAnnualOverviewRead:
      type: object
      properties:
        id:
          type: integer
          description: The id of the annual overview as created on the server.
          readOnly: true
          writeOnly: false
        created:
          type: string
          description: The timestamp of the annual overview 's creation.
          readOnly: true
          writeOnly: false
        updated:
          type: string
          description: The timestamp of the annual overview 's last update.
          readOnly: true
          writeOnly: false
        year:
          type: integer
          description: The year for which the overview is.
          readOnly: true
          writeOnly: false
        alias_user:
          type: object
          description: The user to which this annual overview belongs.
          readOnly: true
          writeOnly: false
          $ref: '#/components/schemas/LabelUser'
    ExportAnnualOverviewCreate:
      type: object
      properties:
        id:
          type: integer
          description: The id of the annual overview as created on the server.
          readOnly: true
          writeOnly: false
    LabelUser:
      type: object
      properties:
        uuid:
          type: string
          description: The public UUID of the label-user.
          readOnly: false
          writeOnly: false
        display_name:
          type: string
          description: The name to be displayed for this user, as it was given on the request.
          readOnly: false
          writeOnly: false
        country:
          type: string
          description: The country of the user. 000 stands for "unknown"
          readOnly: false
          writeOnly: false
        avatar:
          type: object
          description: The current avatar of the user.
          readOnly: true
          writeOnly: false
          $ref: '#/components/schemas/Avatar'
        public_nick_name:
          type: string
          description: The current nickname of the user.
          readOnly: true
          writeOnly: false
    Error:
      type: array
      items:
        type: object
        properties:
          error_description:
            type: string
            description: The error description in English.
          error_description_translated:
            type: string
            description: The error description translated to the user's language.
    Avatar:
      type: object
      properties:
        uuid:
          type: string
          description: The public UUID of the avatar.
          readOnly: false
          writeOnly: false
        anchor_uuid:
          type: string
          description: The public UUID of object this avatar is anchored to.
          readOnly: true
          writeOnly: false
        image:
          type: array
          description: The actual image information of this avatar.
          readOnly: true
          writeOnly: false
          items:
            $ref: '#/components/schemas/Image'
        style:
          type: string
          description: The style (if applicable) for this Avatar.
          readOnly: true
          writeOnly: false
    ExportAnnualOverview:
      type: object
      properties:
        year:
          type: integer
          description: The year for which the overview is.
          readOnly: false
          writeOnly: false
      required:
      - year
    ExportAnnualOverviewDelete:
      type: object
    Image:
      type: object
      properties:
        attachment_public_uuid:
          type: string
          description: The public UUID of the public attachment containing the image.
          readOnly: true
          writeOnly: false
        content_type:
          type: string
          description: The content-type as a MIME filetype.
          readOnly: true
          writeOnly: false
        height:
          type: integer
          description: The image height in pixels.
          readOnly: true
          writeOnly: false
        width:
          type: integer
          description: The image width in pixels.
          readOnly: true
          writeOnly: false
    ExportAnnualOverviewListing:
      type: object
      properties:
        id:
          type: integer
          description: The id of the annual overview as created on the server.
          readOnly: true
          writeOnly: false
        created:
          type: string
          description: The timestamp of the annual overview 's creation.
          readOnly: true
          writeOnly: false
        updated:
          type: string
          description: The timestamp of the annual overview 's last update.
          readOnly: true
          writeOnly: false
        year:
          type: integer
          description: The year for which the overview is.
          readOnly: true
          writeOnly: false
        alias_user:
          type: object
          description: The user to which this annual overview belongs.
          readOnly: true
          writeOnly: false
          $ref: '#/components/schemas/LabelUser'
  headers:
    X-Bunq-Server-Signature:
      description: The server's signature for this response. See the signing page for details on how to verify this signature.
      schema:
        type: string
    X-Bunq-Client-Request-Id:
      description: This header must specify an ID with each request that is unique for the logged in user. There are no restrictions for the format of this ID. However, the server will respond with an error when the same ID is used again on the same DeviceServer.
      schema:
        type: string
      required: false
    X-Bunq-Client-Response-Id:
      description: A unique ID for the response formatted as a UUID. Clients can use it to add extra protection against replay attacks.
      schema:
        type: string
  responses:
    GenericError:
      description: This is how the error response looks like for 4XX response codes
      headers:
        X-Bunq-Client-Response-Id:
          $ref: '#/components/headers/X-Bunq-Client-Response-Id'
        X-Bunq-Client-Request-Id:
          $ref: '#/components/headers/X-Bunq-Client-Request-Id'
        X-Bunq-Server-Signature:
          $ref: '#/components/headers/X-Bunq-Server-Signature'
      content:
        application/json:
          schema:
            type: object
            properties:
              Error:
                $ref: '#/components/schemas/Error'
x-provenance:
  method: harvested
  publisher: bunq
  source: https://raw.githubusercontent.com/bunq/doc/master/swagger.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)