Skip to main content
GET
/
policies
/
{policyId}
Get Policy
curl --request GET \
  --url https://api.example.com/policies/{policyId}
{
  "claimsHistory": [
    {
      "year": 123,
      "claimsNumber": 123,
      "fleetSize": 123
    }
  ],
  "owners": [
    {
      "userId": "<string>",
      "email": "<string>",
      "roles": [
        {
          "productId": "<string>",
          "roleId": "<string>"
        }
      ]
    }
  ],
  "type": "<string>",
  "id": "<string>",
  "productId": "<string>",
  "createdAt": "<string>",
  "lastModifiedAt": "<string>",
  "status": "POLICY_CREATED",
  "assets": [
    "<string>"
  ],
  "customers": [
    "<string>"
  ],
  "periodDuration": {
    "amount": 123,
    "unit": "YEAR"
  },
  "invoicingConfig": {
    "frequency": "YEARLY",
    "timing": "IN_ADVANCE",
    "billAtSignature": "EARLY_PAYMENT",
    "earlyPayment": {
      "amount": 123,
      "unit": "YEAR"
    }
  },
  "customFields": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "name": "<string>",
  "parent": "<string>",
  "brokerageFirm": "<string>",
  "incrementalId": 123,
  "externalId": "<string>",
  "branchType": "BASE",
  "author": {
    "firstName": "<string>",
    "lastName": "<string>",
    "userId": "<string>",
    "email": "<string>",
    "brokerRole": "<string>"
  },
  "signedAt": "<string>",
  "startedAt": "<string>",
  "endedAt": "<string>",
  "stoppedAt": "<string>",
  "suspendedAt": "<string>",
  "reactivatedAt": "<string>",
  "acceptedEmailDomains": [
    "<string>"
  ],
  "acceptedQuoteOptions": {
    "availableConfigs": [
      {
        "tier": "<string>",
        "excess": "<string>",
        "perils": [
          {
            "id": "<string>",
            "required": true,
            "options": [
              "<string>"
            ],
            "showWhen": {
              "fieldKey": "<string>",
              "fieldValue": "<string>",
              "condition": "<string>",
              "value": "<string>"
            }
          }
        ]
      }
    ],
    "defaultConfig": {
      "tier": "<string>",
      "excess": "<string>",
      "perils": [
        {
          "id": "<string>",
          "option": "<string>",
          "available": true,
          "unavailabilityMessage": "<string>"
        }
      ]
    }
  },
  "additionalQuoteComponents": {
    "id": "<string>",
    "type": "PREMIUM",
    "premium": {
      "amountPreFeesAndTaxes": 123,
      "fees": [
        {
          "id": "<string>",
          "chargeType": "ONE_TIME",
          "amount": 123,
          "brokerageFirmId": "<string>"
        }
      ],
      "totalFees": 123,
      "amountWithFeesPreTaxes": 123,
      "taxes": [
        {
          "id": "<string>",
          "chargeType": "ONE_TIME",
          "amount": 123
        }
      ],
      "totalTaxes": 123,
      "amountWithFeesAndTaxes": 123
    },
    "chargeType": "ONE_TIME"
  },
  "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>",
          "chargeType": "ONE_TIME",
          "amount": 123,
          "brokerageFirmId": "<string>"
        }
      ],
      "totalFees": 123,
      "amountWithFeesPreTaxes": 123,
      "taxes": [
        {
          "id": "<string>",
          "chargeType": "ONE_TIME",
          "amount": 123
        }
      ],
      "totalTaxes": 123,
      "amountWithFeesAndTaxes": 123
    },
    "components": [
      {
        "id": "<string>",
        "type": "PREMIUM",
        "premium": {
          "amountPreFeesAndTaxes": 123,
          "fees": [
            {
              "id": "<string>",
              "chargeType": "ONE_TIME",
              "amount": 123,
              "brokerageFirmId": "<string>"
            }
          ],
          "totalFees": 123,
          "amountWithFeesPreTaxes": 123,
          "taxes": [
            {
              "id": "<string>",
              "chargeType": "ONE_TIME",
              "amount": 123
            }
          ],
          "totalTaxes": 123,
          "amountWithFeesAndTaxes": 123
        },
        "chargeType": "ONE_TIME"
      }
    ],
    "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>",
          "chargeType": "ONE_TIME",
          "amount": 123,
          "brokerageFirmId": "<string>"
        }
      ],
      "totalFees": 123,
      "amountWithFeesPreTaxes": 123,
      "taxes": [
        {
          "id": "<string>",
          "chargeType": "ONE_TIME",
          "amount": 123
        }
      ],
      "totalTaxes": 123,
      "amountWithFeesAndTaxes": 123
    },
    "components": [
      {
        "id": "<string>",
        "type": "PREMIUM",
        "premium": {
          "amountPreFeesAndTaxes": 123,
          "fees": [
            {
              "id": "<string>",
              "chargeType": "ONE_TIME",
              "amount": 123,
              "brokerageFirmId": "<string>"
            }
          ],
          "totalFees": 123,
          "amountWithFeesPreTaxes": 123,
          "taxes": [
            {
              "id": "<string>",
              "chargeType": "ONE_TIME",
              "amount": 123
            }
          ],
          "totalTaxes": 123,
          "amountWithFeesAndTaxes": 123
        },
        "chargeType": "ONE_TIME"
      }
    ],
    "basePrice": 123
  },
  "maximumNumberOfBikes": 123,
  "selectedTier": {},
  "stop": {
    "reason": "<string>",
    "details": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "createdAt": "<string>"
  },
  "brokerageFees": [
    {
      "brokerageFirmId": "<string>",
      "fee": 50
    }
  ]
}

Path Parameters

​
policyId
string
required

the policy's id

Query Parameters

​
whenAt
string

Optional: the whenAt datetime

​
simulatedAt
string

Optional: the simulatedAt datetime

​
branchId
string

Optional: the branchId

Response

​
claimsHistory
object[]
required

Claims history

​
owners
object[]
required
deprecated

Owners of the entity

​
type
string
required

Entity type

​
id
string
required

Unique identifier for the policy

​
productId
string
required

Product ID

​
createdAt
string
required

Date and time when the policy was created

​
lastModifiedAt
string
required

Date and time when the policy was last modified

​
status
enum<string>
required

Status of the policy

Available options:
POLICY_CREATED,
POLICY_QUOTED,
POLICY_CONFIRMED,
POLICY_STARTED,
POLICY_STOPPED,
POLICY_SUSPENDED
​
assets
string[]
required

Array of asset identifiers associated with the policy

​
customers
string[]
required

Identifiers of the customers associated with the policy

​
periodDuration
object
required

Policy period duration

​
invoicingConfig
object
required

Nested DTO for invoicing configuration

​
customFields
object[]

custom fields per product

​
name
string

Optional: Name of the entity

​
parent
string

Unique identifier for the parent policy

​
brokerageFirm
string

Unique identifier for the brokerage firm

​
incrementalId
number

Incremental policy id

​
externalId
string

External policy id

​
branchType
enum<string>

Type of branch associated with the policy

Available options:
BASE,
NEW_BUSINESS,
MTA,
RENEWAL,
REPRICING
​
author
object

Author of the policy

​
signedAt
string

Date and time when the policy was signed

​
startedAt
string

Date and time when the policy started

​
endedAt
string

Date and time when the policy will end

​
stoppedAt
string

Date and time when the policy stopped

​
suspendedAt
string

Date and time when the policy was suspended

​
reactivatedAt
string

Date and time when the policy was reactivated after suspension

​
acceptedEmailDomains
string[]

Accepted Email Domains

​
acceptedQuoteOptions
object
​
additionalQuoteComponents
object
​
quote
object

policy quote

​
proratedQuote
object

Prorated policy quote based on the invoicing frequency of the policy

​
maximumNumberOfBikes
number

max number of bike

​
selectedTier
object

Selected pricing tier with perils and breakdown

​
stop
object

stop reason, details and createdAt

​
brokerageFees
object[]

Brokerage fees