--- title: "Get insurance" method: GET path: "/rest/insurances/{insurance-id}" tags: ["Insurances"] --- # Get insurance `GET /rest/insurances/{insurance-id}` ## Request - Base URL: `https://api.nrich.qwist.cloud` - URL: `https://api.nrich.qwist.cloud/rest/insurances/{insurance-id}` - Auth: HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) Get insurance by ID. ## Path parameters - `insurance-id` string, required: nrich ID of the insurance. ## Response `200` Insurance details - object - `id` Schema, required (unresolved $ref) - `access_id` Schema, required (unresolved $ref) - `name` string, required: Name of the insurance product as supplied by the insurance company (e.g. Kaskoversicherung) - `kind` 'ACCIDENT' | 'CAR' | 'HEALTH' | 'DEATH' | 'LIABILITY' | 'LIFE' | 'PROPERTY' | 'SAVINGS' | 'TRAVEL' | 'UNKNOWN', required: Type of the insurance. Use this field to detect the type of the `details` field - `holder` object, required: The insurance policy holder, the person who owns the policy - `reference_id` string, required: Reference or identification code of the policy holder provided by the insurance company - `name` string, required: Name of the policy holder - `address` string, required: The address of the policy holder - `phone_number` string, required: Phone number of the policy holder - `email` Email, required (unresolved $ref) - `born_on` string, date, required: The date of birth of the person - `is_self_employed` boolean, required: A flag to detect whether the policy holder is self-employed - `premium` Balance, required (unresolved $ref) - `currency` Currency, required (unresolved $ref) - `payment_frequency` 'monthly' | 'quarterly' | 'half-yearly' | 'yearly': The frequency at which the premium is deducted - `starts_on` Schema (unresolved $ref) - `due_on` Schema (unresolved $ref) - `coverages` string[], required: The list of coverages that are provided by the insurance contract - `claims` object[], required: Insurance claims claimed so far - `reference_id` string, required: The reference id to the insurance claim provided by the insurance company - `type` string, required: Type of the insurance claim (e.g. Burglary and Theft, Fire) - `status` string, required: The status of the insurance claim (e.g. Submitted, In review, On hold, Closed) - `filed_at` EndedAt, required (unresolved $ref) - `created_at` CreatedAt, required (unresolved $ref) - `modified_at` ModifiedAt, required (unresolved $ref) - `details` union: The type of this field depends on the `kind` field. The following mapping defines the relationship between the `kind` and `details` field:
If kind contains a value that is not listed in the mapping above (e.g. ACCIDENT) then the details field will be omitted from the response. - object - `type` string, required: Type of the savings insurance - `net_plan_value` Balance, required (unresolved $ref) - object - `address` string, required: Address of the insured property - `registry_number` string, required: Registry number of the insured property - `year_of_construction` integer, required: Year of construction of the insured property - `area` string, required: Area the property in square meters - `property_type` string, required: Type of the insured property (e.g. Dwellings, Office) - object - `owner` object, required - `reference_id` string, required: 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` string, required: Full name of the person - `born_on` BornOn, required (unresolved $ref) - `age` integer, required: The age of the insured person - `driving_license_issued_on` Schema, required (unresolved $ref) - `main_driver` Owner, required (unresolved $ref) - `additional_drivers` Owner[], required (unresolved $ref) - `brand` string, required: Brand of the insured car (e.g. Volkswagen) - `model` string, required: Model of the insured car (e.g. Golf) - `extended_model_info` string, required: Extended model info of the car (e.g. GTI 1.6) - `license_plate` string, required: The license plate number of the car (e.g. DE 1234) - `vehicle_type` string, required: The type of the vehicle (e.g. Car, Truck, Bus) - `year_of_registration` integer, required: Year of registration of the car (e.g. 2020) - `coverage_type` string, required: The coverage type provided (e.g. Comprehensive, Third party) - object - `insured_capital` Balance, required (unresolved $ref) - `beneficiaries` object[], required - `reference_id` string, required: 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` string, required: The full name of the beneficiary - `born_on` BornOn, required (unresolved $ref) - `coverage` string, required: Coverage of the insurance - object - `beneficiaries` Items[], required (unresolved $ref) - `co_payments` object[], required - `amount` Balance, required (unresolved $ref) - `currency` Currency, required (unresolved $ref) - `beneficiary` string, required: Name of the beneficiary of the co-payment - `paid_on` Schema, required (unresolved $ref) ## Other responses - `400` (unresolved $ref) - `401` (unresolved $ref) - `404` (unresolved $ref) - `4XX` (unresolved $ref) ## Changes - **2026-11-03** `398592d93b1f`: 4 breaking, 2 info - added `subschema #3, subschema #4, subschema #5` to the `details` response property `oneOf` list for the response status `200` - the `access_id` response's property type changed from no type to `string` for status `200` - the `currency` response's property type changed from no type to `string`, and format from no format to `ISO 4217:2015` for status `200` - the `id` response's property type changed from no type to `string` for status `200` - …2 more [Operation history](https://skmtc.dev/qwist/apis/finx-api/changes/rest/insurances/:insurance-id/get.md) --- [API](https://skmtc.dev/qwist/apis/finx-api.md) - [All operations](https://skmtc.dev/qwist/apis/finx-api/llms.txt) - [OpenAPI document](https://skmtc.dev/qwist/apis/finx-api/revisions/398592d93b1f?raw)