Skip to main content
GET
/
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>"
  ],
  "periodDuration": {
    "amount": 123,
    "unit": "YEAR"
  },
  "invoicingConfig": {
    "frequency": "YEARLY",
    "reconciliationMethod": "INSTANT",
    "timing": "IN_ADVANCE",
    "billAtSignature": "EARLY_PAYMENT",
    "spread": "DYNAMIC",
    "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>",
  "customer": "<string>",
  "acceptedEmailDomains": [
    "<string>"
  ],
  "acceptedQuoteOptions": {
    "availableConfigs": [
      {
        "tier": "<string>",
        "excess": "<string>",
        "perils": [
          {
            "id": "<string>",
            "required": true,
            "options": [
              "<string>"
            ]
          }
        ]
      }
    ],
    "defaultConfig": {
      "tier": "<string>",
      "excess": "<string>",
      "perils": [
        {
          "id": "<string>",
          "option": "<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
  },
  "maximumNumberOfBikes": 123,
  "stop": {
    "reason": "<string>",
    "details": [
      {
        "key": "<string>",
        "value": "<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

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

customer
string

Optional: Identifier of the customer associated with the policy

acceptedEmailDomains
string[]

Accepted Email Domains

acceptedQuoteOptions
object
additionalQuoteComponents
object
quote
object

policy quote

maximumNumberOfBikes
number

max number of bike

stop
object

stop reason and details

brokerageFees
object[]

Brokerage fees