Page Comparison

This page provides supplementary information for the Policy Management API.

Get policy details

Send a request that looks like below to retrieve details of a single policy. Please replace the :id path variable with the actual policy Id.

...

HTTP/2 200 OK
{
  "data": {
    "type": "policies",
    "id": "policy-6f21f713-f977-5ded-a1d0-15d82ee48931",
    "attributes": {
      "reference": "1106467",
      "description": "Sample Customer Name",
      "period": {
        "start": "2024-12-19T00:00:00+00:00",
        "end": "2025-12-18T23:59:59+00:00"
      },
      "currencyCode": "GBP",
      "status": "Created"
    }
  }
}

Get policies belonging to a customer

To get policies belonging to a customer, send a request with parameters for paging, sorting, filtering, and a sparse fieldset selection. Please replace the {{policy-holder-id}} query parameter with the actual policy holder Id (aka the customer Id). For example,

...