Application

Properties

application_id string
Must be a UUID. Unique identifier of the application.

policyholder_id string
Must be a UUID. The unique identifier of the policyholder linked to the application.

product_module_definition_id string
Must be a UUID. Unique identifier of the product module definition associated with the application. Determined by the product module definition associated with the quote from which the application was created.

status string
The status of the application. One of pending or issued.

package_name string
The package name.

sum_assured integer
The maximum insured value in cents.

base_premium integer
The combined risk and platform fee in cents. monthly_premium is calculated from this.

monthly_premium integer
The total monthly premium, in cents, of the application. This is the total premium that will be billed to the policyholder after the policy is issued.

module object
Custom, product-specific information saved to the application for later reference. These parameters are set in the application hook in the product module code.

restricted_data object
Optional restricted product-specific information saved to the application. This field is only returned when the requestee has access to restricted application module data.

created_at string
The date at which the quote package was created..

created_by object,null
null is allowed. An object indicating the user or API key that created the application.

billing_day integer,null
null is allowed. The day of month on which the policy to write will be billed on. 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 to be written will be billed on the last day of that month. Setting this value to 31 will ensure that the policy to be written will be billed on the last day of every month.

currency string
The currency used for the quote package, in [ISO 4217] (https://en.wikipedia.org/wiki/ISO_4217) format.

billing_frequency string
The frequency at which the policy will be billed. See the billing settings guide for more details on the billing frequency.

beneficiaries array
null is allowed. An array of beneficiaries. If null, the default beneficiary may be the policyholder if enabled in the product module settings. Some product modules may require adding beneficiaries to a policy for claims to be processed.

beneficiary_id string
Must be a UUID. The unique identifier of the beneficiary.

policyholder_id string
Must be a UUID. The unique identifier of the policyholder. Only relevant if relationship is policyholder.

type string
The type of beneficiary.

first_name string
The beneficiary's first name.

last_name string
The beneficiary's last name.

title string
The beneficiary's title.

gender string
The beneficiary's gender.

id object
(Individual beneficiaries only) The beneficiary's identification number, type and country.

date_of_birth string,null
null is allowed. The beneficiary's date of birth.

percentage integer
An 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%.

cellphone undefined

email string
The beneficiary's email address.

relationship undefined

company_name string
The name of the company that the beneficiary represents. Required when type = company.

registration_number string
The company's registration number. Required when type = company.

payment_details undefined

input_data object,null
Application input parameters as received over the create an application endpoint.

payment_method_id string
Must be a UUID. The unique identifier of the payment method linked to the application.

type string
The type of the application. One of requote or new_policy.

quote_package_id string
Must be a UUID. The unique identifier of the quote package from which the application was created.

policy object
Policies are issued from applications, and represent binding insurance agreements. Parameters stored on the policy can be referenced in custom notifications, policy documents, data exports and external integrations.

See the issuing policies guide and the policy issue hook guide for more details.

policy_id string
Must be a UUID. Object ID of the policy.

policy_number string
A shorter, human-readable policy identifier. This typically used in policy documents and customer notifications for ease of reference.

status undefined

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 undefined
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.

restricted_data object
Optional restricted product-specific information saved to the policy. This field is only returned when the requestee has access to restricted policy module data.

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.

policyholder object

policyholder_id string
Must be a UUID. The unique identifier of the policyholder.

type string
The policyholder type.

id object
(Individual policyholders only) Object containing policyholder's identification information.

title string
The policyholders's title.

date_of_birth string
(Individual policyholders only) The policyholder's date of birth in the format YYYYMMDD.

gender string
Null is allowed. (Individual policyholders only) The policyholder's gender.

initials string,null
null is allowed. The policyholder or primary contact's initials.

first_name string
The policyholder or primary contact's legal first name.

middle_name string,null
null is allowed. The policyholder or primary contact's legal middle name.

last_name string
The policyholder or primary contact's legal last name.

company_name string
(Company policyholders only) The name of the company that the policyholder represents.

registration_number string
(Company policyholders only) The company's registration number.

date_of_establishment string
(Company policyholders only) The company's date of establishment in the format YYYYMMDD.

company_website_url string
(Company policyholders only) The company's website URL.

contact_position string
(Company policyholders only) The position or role of the primary contact at the company.

subsidiary_companies array
(Company policyholders only) An array of subsidiary company names.

email string,null
null is allowed. The policyholder or primary contact's contact email address.

cellphone undefined

phone_other undefined

policy_ids array
An array of ids of the policies linked to this policyholder.

policies array
An array of full policy objects owned by the policyholder. This is currently only included when fetching all policyholders or fetching an individual policyholder with ?include=policies.

created_at string
The time at which the policyholder was created.

app_data object,null
null is allowed. An object containing additional custom data for the policy holder.

created_by object,null
null is allowed. An object indicating the user or API key that created the policyholder. See Authentication.

updated_at string
The time at which the policyholder was last updated.

address object,null
null is allowed. The policyholder's physical address. See below for more details.

quote_package object
Quote packages are designed to be low-fidelity and fast to generate, and are used to generate and display new quotes rapidly on a customer-facing front-end. They expire after one week.

See the issing policies guide and the quote hook guide for more details.

quote_package_id string
Must be a UUID. Unique identifier of the quote package.

package_name string
The package name.

sum_assured integer
The maximum insured value in cents.

base_premium integer
The combined risk and platform fee in cents. monthly_premium should be calculated from this.

suggested_premium integer
The suggested monthly_premium amount in cents. This is the total premium for display to the customer.

module object
Custom, product-specific information saved to the quote for later reference. These parameters are set in the quote hook in the product module code.

restricted_data object
Optional restricted product-specific information saved to the quote. This field is only returned when the requestee has access to restricted quote module data.

input_data object
Quote input parameters as received over the create a quote endpoint.

created_at string
The date/time at which the quote package was created.

currency string
The currency used for the quote package, in [ISO 4217] (https://en.wikipedia.org/wiki/ISO_4217) format.

billing_frequency string
The frequency at which the policy will be billed. See the billing settings guide for more details on the billing frequency.

product_module_definition_id string
Must be a UUID. Unique identifier of the product module definition associated with this quote package. If a policy is issued from this quote, this product module definition will be associated with the policy.

Example

{
  "application_id": "02e2ce3b-a235-48ea-8415-c58440f631bd",
  "policyholder_id": "246ee082-9f88-44b7-b51c-22a1f1a9a19e",
  "payment_method_id": "7c3e8f2a-1d4b-5e6f-9a0b-c1d2e3f4a5b6",
  "package_name": "Theft + comprehensive",
  "sum_assured": 1199900,
  "monthly_premium": 16999,
  "base_premium": 16999,
  "module": {
    "make": "Apple",
    "type": "root_gadgets",
    "model": "iPhone 6S 64GB LTE",
    "serial_number": "0123456789"
  },
  "restricted_data": {
    "underwriting_score": 85
  },
  "created_at": "2023-02-03T11:17:49.009Z",
  "created_by": {
    "type": "api_key",
    "id": "b6565862-cc6e-4563-85d3-659894338cda",
    "owner_id": "e17f06ce-2a6a-4864-b826-19a83270eab4"
  },
  "currency": "ZAR",
  "product_module_definition_id": "4889a9e0-d5f9-4971-8ac2-2175a9d15477",
  "billing_frequency": "monthly",
  "billing_day": 1,
  "status": "pending",
  "type": "new_policy",
  "beneficiaries": [
    {
      "beneficiary_id": "cd444567-10d5-47f5-a0cc-34e262266359",
      "policyholder_id": "246ee082-9f88-44b7-b51c-22a1f1a9a19e",
      "percentage": 100,
      "relationship": "policyholder"
    }
  ],
  "quote_package_id": "3822b8fb-43e7-43f7-94ad-63e94e6ce1e3"
}