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
undefined

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.

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

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

billing_day integer
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 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
undefined

email string
The beneficiary's email address.

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

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

Example

{
  "application_id": "02e2ce3b-a235-48ea-8415-c58440f631bd",
  "policyholder_id": "246ee082-9f88-44b7-b51c-22a1f1a9a19e",
  "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"
  },
  "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",
  "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"
}