A shorter, human-readable policy identifier. This typically used in policy documents and customer notifications for ease of reference.
status
string
The policy status. See the managing policies guide for more details on the policy lifecycle.
policyholder_id
string
Must be a UUID. The system identifier of the policy's policyholder.
package_name
string
The insurance package name.
sum_assured
integer
The amount, in cents, of the maximum value insured.
monthly_premium
integer
The total monthly premium, in cents, that will be billed to the policyholder.
billing_amount
integer
The amount, in cents, that will be billed on the next billing run.
balance
integer
The amount, in cents, that is owed on the policy. If the policyholder makes an adhoc payment to the policy, the amount is credited to this balance. If the policyholder defaults on a payment, it is subtracted from the balance. If the balance is found negative during the next billing run, the amount is added to the monthly premium, else the monthly premium is subtracted from the balance and the remainder is charged.
billing_day
integer, null
null is allowed. The day of month on which the policy is billed. Should be between 1 and 31, or null. If it falls on a day that does not exist in the month (for example, 31 in February) the policy will be billed on the last day of the month. Setting this value to 31 will ensure that the policy is billed on the last day of every month.
billing_frequency
string
The frequency at which the policy is billed. One of [monthly, yearly, once_off]. See the billing settings guide for more details on the billing frequency.
next_billing_date
string
The next date the policy is due to be billed.
currency
string
The currency code of the policy.
beneficiaries
array, null
An array of beneficiaries, or null.
covered_people
array, null
null is allowed. An array of covered people added to the policy.
base_premium
integer
The amount, in cents, of the minimum allowed monthly premium fee. This includes risk pricing and platform fees.
claim_ids
array
An array of claim ids of the claims linked to the policy.
complaint_ids
array
An array of complaint ids of the complaints linked to the policy.
start_date
string
Once the policy reaches its start date, cover commences and regular collection attempts can run against the policy (provided it has an active status). See the Managing policies guide for more details on the policy lifecycle.
end_date
string
When the policy reaches its end date, its status will change to expired. Cover and collections will cease. Policies with no end date do not expire.
current_version
integer, null
null is allowed. The current policy schedule version.
schedule_file_id
string, null
null is allowed. Object ID of the policy document.
policy_schedule_uri
string, null
URI to the policy document in PDF format.
terms_file_id
string, null
null is allowed. Attachment ID of the policy terms document.
terms_uri
string, null
URI to the terms document in PDF format.
supplementary_terms_files
array
Supplementary terms files associated with the policy.
policy_welcome_letter_file_id
string, null
null is allowed. Object ID of the welcome letter.
policy_welcome_letter_uri
string, null
null is allowed. URI to the welcome letter in PDF format.
policy_certificate_file_id
string, null
null is allowed. Object ID of the policy certificate.
policy_certificate_uri
string, null
null is allowed. URI to the certificate in PDF format.
policy_anniversary_file_id
string, null
null is allowed. Object ID of the policy anniversary document.
schedule_versions
array
The policy schedule versions for the policy. A new policy schedule version is typically created when the policy is updated.
created_at
string
The time at which the policy was created.
module
object
Custom, product-specific fields stored against the policy. These parameters are set in the policy issue hook in the product module code. They can be referenced in policy documents, data exports and external integrations.
app_data
object, null
null is allowed. An object containing additional custom data for the policy.
created_by
object, null
null is allowed. An object indicating the user or API key that created the policy.
scheme_type
string
Indicates the policy scheme type, being either individual or group.
payment_method_id
string
Must be a UUID. The ID of the policy's payment method, if set.
status_updated_at
string
Date indicating when the policy status was last updated.
charges
array
Whenever a premium payment is created (including reversals), a breakdown of the payment amount is calculated according to the charges stored on the policy. This allows the premium breakdown to be referenced in policy documents and disclosures, and in the policy's payment data. See the policy issue hook guide for more details on charges and commissions.
Example
{
"h-0": "Properties",
"0-0": "**policy_id** <span style='color:grey;font-size:85%'>string</span>\nMust be a UUID. Object ID of the policy.",
"1-0": "**policy_number** <span style='color:grey;font-size:85%'>string</span>\nA shorter, human-readable policy identifier. This typically used in policy documents and customer notifications for ease of reference.",
"2-0": "**status** <span style='color:grey;font-size:85%'>string</span>\nThe policy status. See the [managing policies](https://docs.rootplatform.com/docs/policy-administration#policy-lifecycle) guide for more details on the policy lifecycle.",
"3-0": "**policyholder_id** <span style='color:grey;font-size:85%'>string</span>\nMust be a UUID. The system identifier of the policy's policyholder.",
"4-0": "**package_name** <span style='color:grey;font-size:85%'>string</span>\nThe insurance package name.",
"5-0": "**sum_assured** <span style='color:grey;font-size:85%'>integer</span>\nThe amount, in cents, of the maximum value insured.",
"6-0": "**monthly_premium** <span style='color:grey;font-size:85%'>integer</span>\nThe total monthly premium, in cents, that will be billed to the policyholder.",
"7-0": "**billing_amount** <span style='color:grey;font-size:85%'>integer</span>\nThe amount, in cents, that will be billed on the next billing run.",
"8-0": "**balance** <span style='color:grey;font-size:85%'>integer</span>\nThe amount, in cents, that is owed on the policy. If the policyholder makes an adhoc payment to the policy, the amount is credited to this balance. If the policyholder defaults on a payment, it is subtracted from the balance. If the balance is found negative during the next billing run, the amount is added to the monthly premium, else the monthly premium is subtracted from the balance and the remainder is charged.",
"9-0": "**billing_day** <span style='color:grey;font-size:85%'>integer,null</span>\n`null` is allowed. The day of month on which the policy is billed. Should be between 1 and 31, or `null`. If it falls on a day that does not exist in the month (for example, 31 in February) the policy will be billed on the last day of the month. Setting this value to 31 will ensure that the policy is billed on the last day of every month.",
"10-0": "**billing_frequency** <span style='color:grey;font-size:85%'>string</span>\nThe frequency at which the policy is billed. One of [`monthly`, `yearly`, `once_off`]. See the [billing settings](https://docs.rootplatform.com/docs/billing-settings#billing-frequency) guide for more details on the billing frequency.",
"11-0": "**next_billing_date** <span style='color:grey;font-size:85%'>string</span>\nThe next date the policy is due to be billed.",
"12-0": "**currency** <span style='color:grey;font-size:85%'>string</span>\nThe currency code of the policy.",
"13-0": "**beneficiaries** <span style='color:grey;font-size:85%'>undefined</span>\nAn array of beneficiaries, or \"null\". Must be one of the below.<p></p><p style=''><strong>Beneficiaries</strong></p><table style='margin:1rem;padding:0.8rem;border-style:solid;border-color:#f8f8f8;border-width:1px'><tr><td>**beneficiary_id** <span style='color:grey;font-size:85%'>string</span>\nMust be a UUID. The unique identifier of the beneficiary.</td></tr><tr><td>**policyholder_id** <span style='color:grey;font-size:85%'>string</span>\nMust be a UUID. The unique identifier of the policyholder. Only relevant if `relationship` is `policyholder`.</td></tr><tr><td>**type** <span style='color:grey;font-size:85%'>string</span>\nThe type of beneficiary.</td></tr><tr><td>**first_name** <span style='color:grey;font-size:85%'>string</span>\nThe beneficiary's first name.</td></tr><tr><td>**last_name** <span style='color:grey;font-size:85%'>string</span>\nThe beneficiary's last name.</td></tr><tr><td>**title** <span style='color:grey;font-size:85%'>string</span>\nThe beneficiary's title.</td></tr><tr><td>**gender** <span style='color:grey;font-size:85%'>string</span>\nThe beneficiary's gender.</td></tr><tr><td>**id** <span style='color:grey;font-size:85%'>object</span>\n(Individual beneficiaries only) The beneficiary's identification number, type and country.</td></tr><tr><td>**date_of_birth** <span style='color:grey;font-size:85%'>string,null</span>\n`null` is allowed. The beneficiary's date of birth.</td></tr><tr><td>**percentage** <span style='color:grey;font-size:85%'>integer</span>\nAn integer representing the percentage of a claim payout that the beneficiary should receive. Note that the percentages across all beneficiaries should add up to 100%.</td></tr><tr><td>**cellphone** <span style='color:grey;font-size:85%'>undefined</span>\n</td></tr><tr><td>**email** <span style='color:grey;font-size:85%'>string</span>\nThe beneficiary's email address.</td></tr><tr><td>**relationship** <span style='color:grey;font-size:85%'>undefined</span>\n</td></tr><tr><td>**company_name** <span style='color:grey;font-size:85%'>string</span>\nThe name of the company that the beneficiary represents. Required when `type = company`.</td></tr><tr><td>**registration_number** <span style='color:grey;font-size:85%'>string</span>\nThe company's registration number. Required when `type = company`.</td></tr><tr><td>**payment_details** <span style='color:grey;font-size:85%'>undefined</span>\n</td></tr></table><p></p>",
"14-0": "**covered_people** <span style='color:grey;font-size:85%'>array,null</span>\n`null` is allowed. An array of covered people added to the policy.",
"15-0": "**base_premium** <span style='color:grey;font-size:85%'>integer</span>\nThe amount, in cents, of the minimum allowed monthly premium fee. This includes risk pricing and platform fees.",
"16-0": "**claim_ids** <span style='color:grey;font-size:85%'>array</span>\nAn array of claim ids of the claims linked to the policy.",
"17-0": "**complaint_ids** <span style='color:grey;font-size:85%'>array</span>\nAn array of complaint ids of the complaints linked to the policy.",
"18-0": "**start_date** <span style='color:grey;font-size:85%'>string</span>\nOnce the policy reaches its start date, cover commences and regular collection attempts can run against the policy (provided it has an `active` status). See the [Managing policies](https://docs.rootplatform.com/docs/policy-administration#policy-lifecycle) guide for more details on the policy lifecycle.",
"19-0": "**end_date** <span style='color:grey;font-size:85%'>string</span>\nWhen the policy reaches its end date, its status will change to `expired`. Cover and collections will cease. Policies with no end date do not expire.",
"20-0": "**current_version** <span style='color:grey;font-size:85%'>integer,null</span>\n`null` is allowed. The current policy schedule version.",
"21-0": "**schedule_file_id** <span style='color:grey;font-size:85%'>string,null</span>\n`null` is allowed. Object ID of the policy document.",
"22-0": "**policy_schedule_uri** <span style='color:grey;font-size:85%'>string,null</span>\nURI to the policy document in PDF format.",
"23-0": "**terms_file_id** <span style='color:grey;font-size:85%'>string,null</span>\n`null` is allowed. Attachment ID of the policy terms document.",
"24-0": "**terms_uri** <span style='color:grey;font-size:85%'>string,null</span>\nURI to the terms document in PDF format.",
"25-0": "**supplementary_terms_files** <span style='color:grey;font-size:85%'>array</span>\nSupplementary terms files associated with the policy.<p></p><table style='margin:1rem;padding:0.8rem;border-style:solid;border-color:#f8f8f8;border-width:1px'><tr><td>**supplementary_terms_file_id** <span style='color:grey;font-size:85%'>string</span>\nAttachment ID of the supplementary terms document.</td></tr><tr><td>**type** <span style='color:grey;font-size:85%'>string</span>\nThe supplementary terms file type, as specified in the product module settings.</td></tr><tr><td>**uri** <span style='color:grey;font-size:85%'>string</span>\nURI to the supplementary terms document in PDF format.</td></tr></table><p></p>",
"26-0": "**policy_welcome_letter_file_id** <span style='color:grey;font-size:85%'>string,null</span>\n`null` is allowed. Object ID of the welcome letter.",
"27-0": "**policy_welcome_letter_uri** <span style='color:grey;font-size:85%'>string,null</span>\n`null` is allowed. URI to the welcome letter in PDF format.",
"28-0": "**policy_certificate_file_id** <span style='color:grey;font-size:85%'>string,null</span>\n`null` is allowed. Object ID of the policy certificate.",
"29-0": "**policy_certificate_uri** <span style='color:grey;font-size:85%'>string,null</span>\n`null` is allowed. URI to the certificate in PDF format.",
"30-0": "**policy_anniversary_file_id** <span style='color:grey;font-size:85%'>string,null</span>\n`null` is allowed. Object ID of the policy anniversary document.",
"31-0": "**schedule_versions** <span style='color:grey;font-size:85%'>array</span>\nThe policy schedule versions for the policy. A new policy schedule version is typically created when the policy is updated.<p></p><table style='margin:1rem;padding:0.8rem;border-style:solid;border-color:#f8f8f8;border-width:1px'><tr><td>**version** <span style='color:grey;font-size:85%'>integer</span>\nThe policy schedule version number.</td></tr><tr><td>**created_at** <span style='color:grey;font-size:85%'>string</span>\nThe date the policy schedule version was created.</td></tr></table><p></p>",
"32-0": "**created_at** <span style='color:grey;font-size:85%'>string</span>\nThe time at which the policy was created.",
"33-0": "**module** <span style='color:grey;font-size:85%'>object</span>\nCustom, product-specific fields stored against the policy. These parameters are set in the [policy issue hook](https://docs.rootplatform.com/docs/policy-issue-hook) in the product module code. They can be referenced in policy documents, data exports and external integrations.",
"34-0": "**app_data** <span style='color:grey;font-size:85%'>object,null</span>\n`null` is allowed. An object containing additional custom data for the policy.",
"35-0": "**created_by** <span style='color:grey;font-size:85%'>object,null</span>\n`null` is allowed. An object indicating the user or API key that created the policy.",
"36-0": "**scheme_type** <span style='color:grey;font-size:85%'>string</span>\nIndicates the policy scheme type, being either `individual` or `group`.",
"37-0": "**payment_method_id** <span style='color:grey;font-size:85%'>string</span>\nMust be a UUID. The ID of the policy's payment method, if set.",
"38-0": "**status_updated_at** <span style='color:grey;font-size:85%'>string</span>\nDate indicating when the policy status was last updated.",
"39-0": "**charges** <span style='color:grey;font-size:85%'>array</span>\nWhenever a premium payment is created (including reversals), a breakdown of the payment amount is calculated according to the charges stored on the policy. This allows the premium breakdown to be referenced in policy documents and disclosures, and in the policy's payment data. See the [policy issue hook](https://docs.rootplatform.com/docs/policy-issue-hook#charges-and-commissions) guide for more details on charges and commissions.<p></p><table style='margin:1rem;padding:0.8rem;border-style:solid;border-color:#f8f8f8;border-width:1px'><tr><td>**type** <span style='color:grey;font-size:85%'>undefined</span>\n</td></tr><tr><td>**name** <span style='color:grey;font-size:85%'>string</span>\nThe name of the charge.</td></tr><tr><td>**description** <span style='color:grey;font-size:85%'>string</span>\nThe description of the charge.</td></tr><tr><td>**amount** <span style='color:grey;font-size:85%'>integer</span>\nThe charged amount. Required when type is `fixed` or `variable`. Either a proportion of the total premium (if `type` is `variable`), or a currency amount in cents (if `type` is `fixed`).</td></tr></table><p></p>"
},
"cols": 1,
"rows": 40
}
