Skip to main content

Policy

A policy that has been issued and is held in the broker's book.

Names no person directly — use the customer query for the people attached to a policy — but the policy number and the fund holdings are still personal data about the policyholder under the GDPR, and must be handled inside your data-processing agreement.

type Policy {
  id: ID!
  active: Boolean!
  startDate: Date!
  endDate: Date
  pickedUpAt: DateTime
  fundAllocation: PolicyFundAllocation
  fundValue: PolicyFundValue
  regularPremium: PolicyRegularPremium
  firstPremiumStatus: PolicyFirstPremiumStatus
}

Fields​

Policy.id ● ID! non-null scalar​

The policy number, e.g. FL-1234567. Identical to the contractID of the offer the policy was issued from, and to the cursor of this policy's edge.

Policy.active ● Boolean! non-null scalar​

Whether the policy is currently in force. false once it has been terminated or has otherwise become inactive.

Policy.startDate ● Date! non-null scalar​

The day cover starts.

Policy.endDate ● Date scalar​

The day cover ends. null for a policy that runs without a fixed end.

Policy.pickedUpAt ● DateTime scalar​

The recorded date when the policyholder retrieved this policy digitally.

null means no digital policy pickup is recorded. App registration, an inbox confirmation, a document download, or receipt of the first premium alone does not mark the policy as picked up.

A null accompanied by an entry in the response's errors array means the status could not be read. Check errors before treating null as a policy awaiting pickup.

Policy.fundAllocation ● PolicyFundAllocation object​

The fund units the policy held at the most recent valuation reported by the insurance system.

null means we hold no valuation for this policy. Usually that is because there is none to hold — no premium has been invested yet, or the product carries no investment component — but it also covers a policy whose first holdings sync has not run yet, so null is "nothing reported", not a positive statement that the policy holds nothing. A null accompanied by an entry in the response's errors array means the holdings could not be read at all; check errors before treating this as an empty portfolio.

Policy.fundValue ● PolicyFundValue object​

What the policy's fund holdings are worth, and the day they are worth it.

Derived from the same unit holdings fundAllocation publishes, priced with the funds' own closing prices and converted into the policy's currency — so the units above multiply out to this figure, and the same number is what the policyholder sees in their app.

0 is a valuation; null means nothing has been valued yet — no premium invested, or a product with no investment component — or, with an entry in the response's errors array, that it could not be read.

Selecting this field draws on a per-broker budget. See RateLimitedError on the policies query.

Policy.regularPremium ● PolicyRegularPremium object​

The policy's recurring premium as it stands today: one payment, and how often it is paid.

This is the premium in force now, not the one quoted on the offer the policy was issued from. The insurance system keeps the premium as a dated schedule, and index increases, premium holidays and changes to the premium-paying term move it away from the offer figure over the life of the contract.

null means no recurring premium is in force today: a single-premium contract, a policy that is paid up, or one whose premium-paying term has ended. It also covers a premium the insurance system states incompletely — a payment in a currency this API does not convert, or under a cadence it cannot name, is published as absent rather than in part. A null accompanied by an entry in the response's errors array means the premium could not be read at all; check errors before treating this as a policy that pays nothing.

Policy.firstPremiumStatus ● PolicyFirstPremiumStatus enum​

Whether the policy's first premium has reached the insurance system.

Every policy has one, so null here never means "no status": it means the status could not be read, and the response then carries an entry in its errors array naming the policy. Check errors before treating a null as a premium that has not arrived.

Member Of​

PolicyEdge object