Skip to main content

​
Asset object

An asset represents an object covered by the insurance contract. Assets will contain object details, the current valid quote, and chosen coverage. Assets are always linked to a policy: the policy’s lifecycle usually directly impacts the asset’s, except that assets each have their own start date so can be active independently. General
  • startedAt: the date at which the asset becomes or became active
  • stoppedAt: the stop date of the asset
    • stop: if the asset is stopped, more details about the stop reason
  • quote: details about the chosen coverage, and a comprehensive breakdown of taxes, fees, and premiums. See quote for more details.
  • policy: link to the policy
Product specific information
  • custom fields: a list of product specific attributes. For more details check out custom fields.

​
Working with assets over the API

Create an asset with POST /assets?branchId=<branchId>, or many at once with POST /assets/batch/create?branchId=<branchId>. Writes are branch-scoped; omitting the branch acts on the wrong copy of the contract. The product’s assetFields go in the customFields array; startedAt, name and externalAssetId are aggregate fields, sent as top-level properties. startedAt deserves attention because it is the most common reason a quote is refused. Most products declare it as required for quoting, and POST /policies/{policyId}/quote rejects an asset without one unless the product starts cover on signature. POST /policies/{policyId}/calculate-quote tolerates its absence, so a price you could preview may still not be quotable. List a policy’s assets with GET /policies/{policyId}/assets?branchId=<branchId>, passing the branch the work was done on — new business happens on its own branch, and listing without it returns nothing. Removing an asset has its own endpoints: DELETE /assets/{assetId}, or POST /assets/batch/remove for several. POST /assets/{originAssetId}/replace swaps one insured item for another mid-contract. Stopping and cancelling are consequences of the contract’s own lifecycle rather than asset calls — see the note below.

​
Asset statuses

Asset statuses usually change at the same time as policy statuses.
There are three distinct ways an asset can leave the picture:
  • Remove drops an asset before it has any effect (for instance while the policy is still being prepared).
  • Stop ends an asset that was active (ASSET_STARTED).
  • Cancel applies to an asset that never started, typically because its policy was cancelled before the start date.