Insurances

Get insurance

Get insurance by ID.

get/rest/insurances/{insurance-id}

Path parameters

insurance-idstring required

finX ID of the insurance.

Example:I12345.6

Response

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)

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

premiumAmount 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