Qwist Insurances API

openapi: 3.2.0
info:
  title: nrich Insurances API
  version: '2.10'
  contact:
    name: Qwist GmbH
    email: partnersupport@qwist.com
    url: https://qwist.com
  description: This is the reference for Qwist's nrich API
servers:
- url: https://api.nrich.qwist.cloud
  description: Staging environment
tags:
- name: Insurances
paths:
  /rest/access/{access-id}/insurances:
    get:
      summary: List insurances of access
      operationId: listInsurancesOfAccess
      description: Retrieve a list of available insurances for this access.
      tags:
      - Insurances
      parameters:
      - $ref: '#/paths/~1rest~1accesses~1{access-id}/get/parameters/0'
      security:
      - user_auth: []
      responses:
        '200':
          $ref: '#/paths/~1rest~1insurances/get/responses/200'
        '400':
          $ref: '#/paths/~1rest~1user/put/responses/400'
        '401':
          $ref: '#/paths/~1catalog/get/responses/401'
        4XX:
          $ref: '#/paths/~1rest~1loans/get/responses/4XX'
  /rest/insurances:
    get:
      summary: List insurances
      operationId: listInsurances
      description: Retrieve a list of all available insurances.
      tags:
      - Insurances
      security:
      - user_auth: []
      responses:
        '200':
          description: List of insurances
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/paths/~1rest~1insurances~1{insurance-id}/get/responses/200/content/application~1json/schema'
        '400':
          $ref: '#/paths/~1rest~1user/put/responses/400'
        '401':
          $ref: '#/paths/~1catalog/get/responses/401'
        4XX:
          $ref: '#/paths/~1rest~1loans/get/responses/4XX'
  /rest/insurances/{insurance-id}:
    get:
      summary: Get insurance
      operationId: getInsurance
      description: Get insurance by ID.
      tags:
      - Insurances
      parameters:
      - name: insurance-id
        in: path
        required: true
        schema:
          type: string
          example: I12345.6
          description: nrich ID of the insurance.
      security:
      - user_auth: []
      responses:
        '200':
          description: Insurance details
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    $ref: '#/paths/~1rest~1insurances~1{insurance-id}/get/parameters/0/schema'
                  access_id:
                    $ref: '#/paths/~1rest~1accesses~1{access-id}/get/parameters/0/schema'
                  name:
                    type: string
                    description: Name of the insurance product as supplied by the insurance company (e.g. Kaskoversicherung)
                    example: Kaskoversicherung
                  kind:
                    type: string
                    enum:
                    - ACCIDENT
                    - CAR
                    - HEALTH
                    - DEATH
                    - LIABILITY
                    - LIFE
                    - PROPERTY
                    - SAVINGS
                    - TRAVEL
                    - UNKNOWN
                    description: Type of the insurance. Use this field to detect the type of the `details` field
                    example: SAVINGS
                  holder:
                    description: The insurance policy holder, the person who owns the policy
                    type: object
                    properties:
                      reference_id:
                        type: string
                        example: HOLDER-ID-1234
                        description: Reference or identification code of the policy holder provided by the insurance company
                      name:
                        type: string
                        description: Name of the policy holder
                        example: John Doe
                      address:
                        type: string
                        description: The address of the policy holder
                        example: Neuweg 1, 92919 Berlin, Germany
                      phone_number:
                        type: string
                        description: Phone number of the policy holder
                        example: 0123 456789
                      email:
                        $ref: '#/paths/~1rest~1user/put/requestBody/content/application~1json/schema/properties/email'
                        description: E-mail address of the policy holder
                      born_on:
                        description: The date of birth of the person
                        type: string
                        format: date
                        example: '2023-01-14'
                      is_self_employed:
                        type: boolean
                        description: A flag to detect whether the policy holder is self-employed
                    required:
                    - reference_id
                    - name
                    - address
                    - phone_number
                    - email
                    - born_on
                    - is_self_employed
                  premium:
                    $ref: '#/paths/~1uploads/post/requestBody/content/application~1json/schema/properties/accounts/items/properties/balance'
                    description: Insurance premium amount
                  currency:
                    $ref: '#/paths/~1rest~1loans~1{loan-id}/get/responses/200/content/application~1json/schema/properties/currency'
                    description: Currency of the insurance premium
                  payment_frequency:
                    description: The frequency at which the premium is deducted
                    type: string
                    enum:
                    - monthly
                    - quarterly
                    - half-yearly
                    - yearly
                  starts_on:
                    $ref: '#/paths/~1auth~1users/get/parameters/2/schema'
                    description: The start date of the insurance coverage
                  due_on:
                    $ref: '#/paths/~1auth~1users/get/parameters/2/schema'
                    description: The date on which the insurance coverage will end
                  coverages:
                    type: array
                    items:
                      type: string
                      example: Fires, Theft and vandalism
                    description: The list of coverages that are provided by the insurance contract
                  claims:
                    type: array
                    items:
                      type: object
                      properties:
                        reference_id:
                          type: string
                          example: ID1234
                          description: The reference id to the insurance claim provided by the insurance company
                        type:
                          type: string
                          description: Type of the insurance claim (e.g. Burglary and Theft, Fire)
                          example: Fire
                        status:
                          type: string
                          description: The status of the insurance claim (e.g. Submitted, In review, On hold, Closed)
                          example: Submitted
                        filed_at:
                          $ref: '#/paths/~1uploads/post/responses/200/content/application~1json/schema/properties/ended_at'
                          description: Date and time of submission of the insurance claim
                      required:
                      - reference_id
                      - type
                      - status
                      - filed_at
                    description: Insurance claims claimed so far
                  created_at:
                    $ref: '#/paths/~1rest~1accesses/get/responses/200/content/application~1json/schema/items/properties/created_at'
                  modified_at:
                    $ref: '#/paths/~1rest~1loans~1{loan-id}/get/responses/200/content/application~1json/schema/properties/modified_at'
                  details:
                    oneOf:
                    - type: object
                      properties:
                        type:
                          type: string
                          description: Type of the savings insurance
                          example: National Pension Scheme
                        net_plan_value:
                          $ref: '#/paths/~1uploads/post/requestBody/content/application~1json/schema/properties/accounts/items/properties/balance'
                          description: Net plan value of the savings insurance
                      required:
                      - type
                      - net_plan_value
                    - type: object
                      properties:
                        address:
                          type: string
                          description: Address of the insured property
                          example: Neuweg 1, 92919 Berlin, Germany
                        registry_number:
                          type: string
                          description: Registry number of the insured property
                          example: RN1234
                        year_of_construction:
                          type: integer
                          description: Year of construction of the insured property
                          example: 2020
                        area:
                          type: string
                          description: Area the property in square meters
                          example: 220
                        property_type:
                          type: string
                          description: Type of the insured property (e.g. Dwellings, Office)
                          example: Office
                      required:
                      - address
                      - registry_number
                      - year_of_construction
                      - area
                      - property_type
                    - type: object
                      properties:
                        owner:
                          type: object
                          properties:
                            reference_id:
                              type: string
                              description: Reference or identification code of a person supplied by the insurance company. This can be used to identify given person on insurance provider side.
                            name:
                              type: string
                              description: Full name of the person
                              example: John Doe
                            born_on:
                              $ref: '#/paths/~1rest~1insurances~1{insurance-id}/get/responses/200/content/application~1json/schema/properties/holder/properties/born_on'
                            age:
                              type: integer
                              description: The age of the insured person
                            driving_license_issued_on:
                              $ref: '#/paths/~1auth~1users/get/parameters/2/schema'
                              description: Issue date of the person's driving license
                          required:
                          - reference_id
                          - name
                          - born_on
                          - age
                          - driving_license_issued_on
                        main_driver:
                          $ref: '#/paths/~1rest~1insurances~1{insurance-id}/get/responses/200/content/application~1json/schema/properties/details/oneOf/2/properties/owner'
                        additional_drivers:
                          type: array
                          items:
                            $ref: '#/paths/~1rest~1insurances~1{insurance-id}/get/responses/200/content/application~1json/schema/properties/details/oneOf/2/properties/owner'
                        brand:
                          type: string
                          description: Brand of the insured car (e.g. Volkswagen)
                          example: Volkswagen
                        model:
                          type: string
                          description: Model of the insured car (e.g. Golf)
                          example: Golf
                        extended_model_info:
                          type: string
                          description: Extended model info of the car (e.g. GTI 1.6)
                          example: GTI 1.6
                        license_plate:
                          type: string
                          description: The license plate number of the car (e.g. DE 1234)
                          example: DE 1234
                        vehicle_type:
                          type: string
                          description: The type of the vehicle (e.g. Car, Truck, Bus)
                          example: Bus
                        year_of_registration:
                          type: integer
                          description: Year of registration of the car (e.g. 2020)
                          example: 2020
                        coverage_type:
                          type: string
                          description: The coverage type provided (e.g. Comprehensive, Third party)
                          example: Comprehensive
                      required:
                      - owner
                      - main_driver
                      - additional_drivers
                      - brand
                      - model
                      - extended_model_info
                      - license_plate
                      - vehicle_type
                      - year_of_registration
                      - coverage_type
                    - type: object
                      properties:
                        insured_capital:
                          $ref: '#/paths/~1uploads/post/requestBody/content/application~1json/schema/properties/accounts/items/properties/balance'
                          description: The amount of insured capital
                        beneficiaries:
                          type: array
                          items:
                            type: object
                            properties:
                              reference_id:
                                type: string
                                description: Reference or identification code of the beneficiary provided by the insurance company. This ID is used to identify the beneficiary on the insurance provider side.
                              name:
                                type: string
                                description: The full name of the beneficiary
                                example: John Doe
                              born_on:
                                $ref: '#/paths/~1rest~1insurances~1{insurance-id}/get/responses/200/content/application~1json/schema/properties/holder/properties/born_on'
                            required:
                            - reference_id
                            - name
                            - born_on
                        coverage:
                          type: string
                          description: Coverage of the insurance
                      required:
                      - insured_capital
                      - beneficiaries
                      - coverage
                    - type: object
                      properties:
                        beneficiaries:
                          type: array
                          items:
                            $ref: '#/paths/~1rest~1insurances~1{insurance-id}/get/responses/200/content/application~1json/schema/properties/details/oneOf/3/properties/beneficiaries/items'
                        co_payments:
                          type: array
                          items:
                            type: object
                            properties:
                              amount:
                                $ref: '#/paths/~1uploads/post/requestBody/content/application~1json/schema/properties/accounts/items/properties/balance'
                                description: The amount that was co-paid
                              currency:
                                $ref: '#/paths/~1rest~1loans~1{loan-id}/get/responses/200/content/application~1json/schema/properties/currency'
                              beneficiary:
                                type: string
                                description: Name of the beneficiary of the co-payment
                              paid_on:
                                $ref: '#/paths/~1auth~1users/get/parameters/2/schema'
                                description: The date on which the co-payment was done
                            required:
                            - amount
                            - currency
                            - beneficiary
                            - paid_on
                      required:
                      - beneficiaries
                      - co_payments
                    description: "The type of this field depends on the `kind` field. The following mapping defines the relationship between the `kind` and `details` field: <br> <ul>\n  <li><code>SAVINGS</code>  -> <code>SavingsInsurance</code></li>\n  <li><code>PROPERTY</code> -> <code>PropertyInsurance</code></li>\n  <li><code>CAR</code>      -> <code>CarInsurance</code></li>\n  <li><code>LIFE</code>     -> <code>LifeInsurance</code></li>\n  <li><code>HEALTH</code>   -> <code>HealthInsurance</code></li>\n</ul> If <code>kind</code> contains a value that is not listed in the mapping above  (e.g. <code>ACCIDENT</code>) then the <code>details</code> field will be omitted from the response."
                required:
                - id
                - access_id
                - name
                - kind
                - holder
                - premium
                - currency
                - coverages
                - claims
                - created_at
                - modified_at
        '400':
          $ref: '#/paths/~1rest~1user/put/responses/400'
        '401':
          $ref: '#/paths/~1catalog/get/responses/401'
        '404':
          $ref: '#/paths/~1auth~1token/post/responses/404'
        4XX:
          $ref: '#/paths/~1rest~1loans/get/responses/4XX'
components:
  securitySchemes:
    user_auth:
      type: http
      description: 'In order to access any information belonging to a user, a client has to authenticate with a token linking itself to the user.  This token is called an `access token` and contains information on the client, the user and the level of access the client has to the users data. In order to authenticate using such an access token the HTTP header `Authorization` is set to `Bearer <access token>`. The  `access token` is formatted

        as a JSON Web Token according to [RFC7519](https://tools.ietf.org/html/rfc7519)


        Such an `access token` is either returned when


        * exchanging an authorization code after a successful OAuth login flow

        * logging in with the user''s credentials

        * exchanging a refresh token, which is returned at either of the aforementioned points


        **Authentication errors**


        In case of an authentication error a HTTP code 401 response is returned containing further

        details on the kind of error in the `WWW-Authenticate` header.


        In addition to the below listed scope the flags are used for simple boolean permissions.


        | Flag            | Description                                  |

        | --              | --                                           |

        | submit_payments | Allow submission of payments to bank server  |

        | offline         | Access finX API when the user is not present |

        | create_user     | Allow creation of finX accounts              |


        **Example**


        The string `"accounts=rw submit_payments"` is URL-encoded and passed as the URL

        parameter `scope`.'
      scheme: bearer
      bearerFormat: JWT
      x-bearerInfoFunc: app.decode_token
      x-scopes:
        accounts=rw: Modify accounts
        accounts=ro: Read accounts
        balance=ro: Read account balance
        securities=ro: Read securities
        transactions=ro: Read transactions
        transactions=rw: Modify transactions
        payments=ro: Read payments
        payments=rw: Create/modify payments
        submit_payments: Submit payment to service provider
        user=ro: Read user information
        user=rw: Modify user information
    client_auth:
      x-basicInfoFunc: app.basic_auth
      type: http
      scheme: basic
      description: Client authentication is performed via [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication) with client ID as username and client secret as password.
x-provenance:
  method: searched
  source: https://docs.qwist.com/reference
  harvested: '2026-10-21'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.qwist.com/reference/addprovideraccess.md
  - https://docs.qwist.com/reference/categorizetransactions.md
  - https://docs.qwist.com/reference/createaccesstoken.md
  - https://docs.qwist.com/reference/createaccountverification.md
  - https://docs.qwist.com/reference/createcontract.md
  - https://docs.qwist.com/reference/createincomereport.md
  - https://docs.qwist.com/reference/createmanualsync.md
  - https://docs.qwist.com/reference/createnotification.md
  - https://docs.qwist.com/reference/createonetimeaccess.md
  - https://docs.qwist.com/reference/createonetimeincomereport.md
  - https://docs.qwist.com/reference/createonetimepayment.md
  - https://docs.qwist.com/reference/createonetimeriskreport.md
  - https://docs.qwist.com/reference/createongoingaccess.md
  - https://docs.qwist.com/reference/createongoingpayment.md
  - https://docs.qwist.com/reference/createongoingriskreport.md
  - https://docs.qwist.com/reference/createpayment.md
  - https://docs.qwist.com/reference/createpaymentfromaccount.md
  - https://docs.qwist.com/reference/createqwistlink.md
  - https://docs.qwist.com/reference/createriskreport.md
  - https://docs.qwist.com/reference/createsync.md
  - https://docs.qwist.com/reference/createupload.md
  - https://docs.qwist.com/reference/createuser.md
  - https://docs.qwist.com/reference/createverifyandpay.md
  - https://docs.qwist.com/reference/deleteaccount.md
  - https://docs.qwist.com/reference/deleteclientuser.md
  - https://docs.qwist.com/reference/deletecontract.md
  - https://docs.qwist.com/reference/deletenotification.md
  - https://docs.qwist.com/reference/deletepayment.md
  - https://docs.qwist.com/reference/deleteprovideraccess.md
  - https://docs.qwist.com/reference/deleteuser.md
  - https://docs.qwist.com/reference/getaccount.md
  - https://docs.qwist.com/reference/getaccountbalance.md
  - https://docs.qwist.com/reference/getaccountverificationreceipt.md
  - https://docs.qwist.com/reference/getandgenerateincomereport.md
  - https://docs.qwist.com/reference/getartifact.md
  - https://docs.qwist.com/reference/getcategories.md
  - https://docs.qwist.com/reference/getcategoriesforaccess.md
  - https://docs.qwist.com/reference/getcategoriesforaccount.md
  - https://docs.qwist.com/reference/getcategorytree.md
  - https://docs.qwist.com/reference/getcontract.md
  - https://docs.qwist.com/reference/getcredential.md
  - https://docs.qwist.com/reference/getincomereport.md
  - https://docs.qwist.com/reference/getinsurance.md
  - https://docs.qwist.com/reference/getloan.md
  - https://docs.qwist.com/reference/getnotification.md
  - https://docs.qwist.com/reference/getpaymentchallenge.md
  - https://docs.qwist.com/reference/getpaymentchallengeofaccount.md
  - https://docs.qwist.com/reference/getpaymentinitstatus.md
  - https://docs.qwist.com/reference/getpaymentinitstatusofaccount.md
  - https://docs.qwist.com/reference/getpaymentofaccount.md
  - https://docs.qwist.com/reference/getpaymentpartners.md
  - https://docs.qwist.com/reference/getpaymentpartnersforaccess.md
  - https://docs.qwist.com/reference/getpaymentpartnersforaccount.md
  - https://docs.qwist.com/reference/getpaymentreceipt.md
  - https://docs.qwist.com/reference/getprovideraccess.md
  - https://docs.qwist.com/reference/getriskreport.md
  - https://docs.qwist.com/reference/getsecurityofaccount.md
  - https://docs.qwist.com/reference/getsyncchallenge.md
  - https://docs.qwist.com/reference/getsyncstatus.md
  - https://docs.qwist.com/reference/gettimeline.md
  - https://docs.qwist.com/reference/gettimelineforaccess.md
  - https://docs.qwist.com/reference/gettimelineforaccount.md
  - https://docs.qwist.com/reference/gettransaction.md
  - https://docs.qwist.com/reference/gettransactionofaccount.md
  - https://docs.qwist.com/reference/getuploadstatus.md
  - https://docs.qwist.com/reference/getuser.md
  - https://docs.qwist.com/reference/getversion.md
  - https://docs.qwist.com/reference/initpayment.md
  - https://docs.qwist.com/reference/initpaymentofaccount.md
  - https://docs.qwist.com/reference/listaccounts.md
  - https://docs.qwist.com/reference/listaccountsofaccess.md
  - https://docs.qwist.com/reference/listbanks.md
  - https://docs.qwist.com/reference/listcatalog.md
  - https://docs.qwist.com/reference/listcatalogclientauth.md
  - https://docs.qwist.com/reference/listclientusers.md
  - https://docs.qwist.com/reference/listcontracts.md
  - https://docs.qwist.com/reference/listcontractsofaccess.md
  - https://docs.qwist.com/reference/listcontractsofaccount.md
  - https://docs.qwist.com/reference/listcredentials.md
  - https://docs.qwist.com/reference/listinsurances.md
  - https://docs.qwist.com/reference/listinsurancesofaccess.md
  - https://docs.qwist.com/reference/listloans.md
  - https://docs.qwist.com/reference/listloansofaccess.md
  - https://docs.qwist.com/reference/listnotifications.md
  - https://docs.qwist.com/reference/listpaymentchallenges.md
  - https://docs.qwist.com/reference/listpaymentchallengesofaccount.md
  - https://docs.qwist.com/reference/listpayments.md
  - https://docs.qwist.com/reference/listpaymentsofaccount.md
  - https://docs.qwist.com/reference/listprovideraccesses.md
  - https://docs.qwist.com/reference/listsecurities.md
  - https://docs.qwist.com/reference/listsecuritiesofaccount.md
  - https://docs.qwist.com/reference/listservices.md
  - https://docs.qwist.com/reference/listsyncchallenges.md
  - https://docs.qwist.com/reference/listtransactions.md
  - https://docs.qwist.com/reference/listtransactionsofaccount.md
  - https://docs.qwist.com/reference/patchcredential.md
  - https://docs.qwist.com/reference/removepinfromprovideraccess.md
  - https://docs.qwist.com/reference/replacenotifications.md
  - https://docs.qwist.com/reference/revokeoauthtoken.md
  - https://docs.qwist.com/reference/solvepaymentchallenge.md
  - https://docs.qwist.com/reference/solvepaymentchallengeofaccount.md
  - https://docs.qwist.com/reference/solvesyncchallenge.md
  - https://docs.qwist.com/reference/updatecontract.md
  - https://docs.qwist.com/reference/updatenotification.md
  - https://docs.qwist.com/reference/updateuser.md
  merge:
    pages: 105
    deduped: 1107
    conflicts_kept_first: 0