Policyholder

Properties

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.

type string
The id type of the policyholder.

number string
The ID or passport number.

country string
The ISO Alpha-2 country code of the country of the id/passport number.

expiration_date string
(Individual policyholders only) The expiration date of the policyholder's passport.

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 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 is allowed. The policyholder or primary contact's legal middle name.

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

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

cellphone string
null and "" allowed. String containing the cellphone number in international format.

phone_other string
null and "" allowed. String containing the cellphone number in international format.

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 is allowed. An object containing additional custom data for the policy holder.

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

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

line_1 string
First line of the policyholder's address.

line_2 string
null is allowed. Optional second line of the policyholder's address.

suburb string
The policyholder's suburb.

city string
The policyholder's city.

country string
The policyholder's country code, in the ISO Alpha-2 format.

area_code string
The policyholder's area code must be 4 characters long for South African addresses.

Example

{
  "policyholder_id": "bf1ada91-eecb-4f47-9bfa-1258bb1e0055",
  "type": "individual",
  "initials": "E",
  "first_name": "Erlich",
  "middle_name": "Aviato",
  "last_name": "Bachman",
  "id": {
    "type": "id",
    "number": "6801015800084",
    "country": "ZA"
  },
  "date_of_birth": "19680101",
  "gender": "male",
  "email": "[email protected]",
  "cellphone": "+27821234567",
  "phone_other": "+27124101337",
  "created_at": "2017-10-12T15:47:34.281Z",
  "app_data": {
    "company": "Aviato"
  },
  "policy_ids": [],
  "created_by": {
    "id": "00000000-0000-0000-0000-000000000001",
    "type": "user"
  },
  "address": {
    "line_1": "5230 Penfield Avenue",
    "suburb": "Woodland Hills",
    "city": "Los Angeles",
    "country": "US",
    "area_code": "CA 91364"
  }
}