Add an insurance record
Record one policy period covering a possession.
The insurer, the status, the insured value and its currency are required.
The change is written to the account log.
Parameters
Sent as JSON. Anything not listed here is ignored.
The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.
The id of the possession. A possession of another vault or of another account answers 404.
Who insures the possession, up to 255 characters. Markup is stripped.
Where the policy stands: active, pending, expired or cancelled.
The value the possession is insured for. Zero or more, up to 9999999999.99. A figure below zero is refused with “Write an amount of zero or more.”
The currency of the insured value and the excess: usd, eur, gbp, cad, aud, chf, jpy, brl, inr or cny.
The number of the policy, up to 255 characters.
What the policy covers, up to 255 characters.
What is paid before the insurer pays. Zero or more, up to 9999999999.99. A figure below zero is refused with “Write an amount of zero or more.”
The day the policy period starts, written as 2026-01-01.
The day the policy period ends or renews, written as 2027-01-01. A day before the start is refused with “The end cannot come before the start.”
Whether the policy names this possession rather than the general contents of the home. False when left out on creation.
Who to call at the insurer, up to 255 characters.
The email of that person, a full email address.
The phone of that person, up to 50 characters.
Conditions, exclusions, what the insurer asked for, up to 5,000 characters.
Returns
The insurance record object that was added.
The possession insurance record.
Always possession_insurance_record. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from.
The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes.
Everything the record holds.
Who insures the possession, as text.
Where the policy stands: active, pending, expired or cancelled. It is the one entered and never follows the dates.
Whether this is the record the possession is insured under now: the active one with the latest start.
The number of the policy, or null.
What the policy covers, or null.
The value the possession is insured for, as a string with two decimals.
What is paid before the insurer pays, or null when it is not recorded.
The currency of the insured value and the excess, in lower case. Nothing is ever converted.
The day the policy period starts, written as 2026-01-01, or null.
The day the policy period ends or renews, or null for a policy with no end date.
Whether the policy names this possession, rather than covering it under the general contents of the home.
Who to call at the insurer, or null.
The email of that person, or null.
The phone of that person, or null.
Conditions, exclusions, what the insurer asked for, or null.
When the record was added, as a count of seconds since 1970.
When it last changed, as a count of seconds, or null.
Where to find this record.
The absolute address this record is read from.
The Insurance section of the possession in the application, which opens for somebody signed in rather than for a key. It is the link to give a person.
Rate limit
Sixty requests per minute, per user, shared by every key and device. Every answer carries the budget left in X-RateLimit-Remaining.
Keys act as you, with exactly the access you have. Make one per integration so you can revoke it alone.