Skip to main content
GET
/
assets
/
{assetId}
Get Asset
curl --request GET \
  --url https://api.example.com/assets/{assetId}
{
  "type": "<string>",
  "id": "<string>",
  "lastModifiedAt": "<string>",
  "createdAt": "<string>",
  "policyId": "<string>",
  "customFields": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "name": "<string>",
  "createdOnBranch": true,
  "editedOnBranch": true,
  "startedAt": "<string>",
  "stoppedAt": "<string>",
  "cancelledAt": "<string>",
  "externalAssetId": "<string>",
  "quote": {
    "id": "<string>",
    "entityId": "<string>",
    "provider": {
      "id": "<string>",
      "version": "<string>"
    },
    "rates": [
      {
        "id": "<string>",
        "rate": 123,
        "inputs": [
          {
            "id": "<string>",
            "value": "<string>"
          }
        ]
      }
    ],
    "totalPremium": {
      "amountPreFeesAndTaxes": 123,
      "fees": [
        {
          "id": "<string>",
          "amount": 123,
          "brokerageFirmId": "<string>"
        }
      ],
      "totalFees": 123,
      "amountWithFeesPreTaxes": 123,
      "taxes": [
        {
          "id": "<string>",
          "amount": 123
        }
      ],
      "totalTaxes": 123,
      "amountWithFeesAndTaxes": 123
    },
    "components": [
      {
        "id": "<string>",
        "premium": {
          "amountPreFeesAndTaxes": 123,
          "fees": [
            {
              "id": "<string>",
              "amount": 123,
              "brokerageFirmId": "<string>"
            }
          ],
          "totalFees": 123,
          "amountWithFeesPreTaxes": 123,
          "taxes": [
            {
              "id": "<string>",
              "amount": 123
            }
          ],
          "totalTaxes": 123,
          "amountWithFeesAndTaxes": 123
        }
      }
    ],
    "options": {
      "tier": "<string>",
      "excess": "<string>",
      "assetId": "<string>",
      "perils": [
        {
          "id": "<string>",
          "option": "<string>",
          "available": true,
          "unavailabilityMessage": "<string>"
        }
      ],
      "brokerageFees": [
        {
          "brokerageFirmId": "<string>",
          "fee": 50
        }
      ]
    },
    "basePrice": 123
  },
  "proratedQuote": {
    "id": "<string>",
    "entityId": "<string>",
    "provider": {
      "id": "<string>",
      "version": "<string>"
    },
    "rates": [
      {
        "id": "<string>",
        "rate": 123,
        "inputs": [
          {
            "id": "<string>",
            "value": "<string>"
          }
        ]
      }
    ],
    "totalPremium": {
      "amountPreFeesAndTaxes": 123,
      "fees": [
        {
          "id": "<string>",
          "amount": 123,
          "brokerageFirmId": "<string>"
        }
      ],
      "totalFees": 123,
      "amountWithFeesPreTaxes": 123,
      "taxes": [
        {
          "id": "<string>",
          "amount": 123
        }
      ],
      "totalTaxes": 123,
      "amountWithFeesAndTaxes": 123
    },
    "components": [
      {
        "id": "<string>",
        "premium": {
          "amountPreFeesAndTaxes": 123,
          "fees": [
            {
              "id": "<string>",
              "amount": 123,
              "brokerageFirmId": "<string>"
            }
          ],
          "totalFees": 123,
          "amountWithFeesPreTaxes": 123,
          "taxes": [
            {
              "id": "<string>",
              "amount": 123
            }
          ],
          "totalTaxes": 123,
          "amountWithFeesAndTaxes": 123
        }
      }
    ],
    "options": {
      "tier": "<string>",
      "excess": "<string>",
      "assetId": "<string>",
      "perils": [
        {
          "id": "<string>",
          "option": "<string>",
          "available": true,
          "unavailabilityMessage": "<string>"
        }
      ],
      "brokerageFees": [
        {
          "brokerageFirmId": "<string>",
          "fee": 50
        }
      ]
    },
    "basePrice": 123
  }
}

Path Parameters

​
assetId
string
required

assetId

Query Parameters

​
whenAt
string

Optional: the whenAt datetime

​
simulatedAt
string

Optional: the simulatedAt datetime

​
branchId
string

Optional: the branchId

Response

​
type
string
required

Entity type

​
id
string
required

assetId

​
lastModifiedAt
string
required

Last modified date of the asset

​
createdAt
string
required

Creation date of the asset

​
status
enum<string>
required

Status of the asset

Available options:
ASSET_CREATED,
ASSET_REMOVED,
ASSET_QUOTED,
ASSET_CONFIRMED,
ASSET_STARTED,
ASSET_STOPPED,
ASSET_CANCELLED
​
policyId
string
required

policyId of asset owner

​
customFields
object[]

custom fields per product

​
name
string

Optional: Name of the entity

​
createdOnBranch
boolean

Whether the asset was created on a branch

​
editedOnBranch
boolean

Whether the asset was edited on a branch

​
startedAt
string

Date the asset starts

​
stoppedAt
string

Date the asset stops

​
cancelledAt
string

Date the asset was cancelled

​
externalAssetId
string

externalAssetId

​
quote
object

asset quote

​
proratedQuote
object

Prorated asset quote based on the invoicing frequency of the policy