Insurances

Get insurance

Get insurance by ID.

get/rest/insurances/{insurance-id}

Request

Base URL
https://api.nrich.qwist.cloud
Auth
HTTP bearer
TypeScript
https://skmtc.dev/qwist/apis/finx-api/docs/rest/insurances/:insurance-id/get.ts
A function with typed inputs. Its response is checked against the schema.

insurance-idstring required

nrich ID of the insurance.

Example:I12345.6

Insurance details

idSchema required(unresolved $ref)

access_idSchema required(unresolved $ref)

namestring required

Name of the insurance product as supplied by the insurance company (e.g. Kaskoversicherung)

Type of the insurance. Use this field to detect the type of the details field

premiumBalance required(unresolved $ref)

currencyCurrency required(unresolved $ref)

payment_frequency'monthly' | 'quarterly' | 'half-yearly' | 'yearly'

The frequency at which the premium is deducted

starts_onSchema (unresolved $ref)

due_onSchema (unresolved $ref)

coveragesstring[] required

The list of coverages that are provided by the insurance contract

created_atCreatedAt required(unresolved $ref)

modified_atModifiedAt required(unresolved $ref)