Complaint

Properties

complaint_id string
The identifier of the complaint.

created_at string
Time at which the complaint was opened.

policy_id string
The identifier of the policy attached to this complaint. May initially be omitted.

policyholder_id string
The identifier of the policyholder for this complaint. May initially be omitted.

member_id string
The identifier of the member for this complaint. Only used for group scheme policies. May initially be omitted.

complaint_status string
Whether the complaint is 'open' or 'closed'.

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

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

complainant object
Object containing complainant's first name, last name, email and/or cellphone.

first_name string
The first name of the complainant.

last_name string
The last name of the complainant.

email string
The complainant's email address.

cellphone undefined

Example

{
  "complaint_id": "acd6c4af-108e-444d-a90f-e90b67786c74",
  "created_at": "2017-10-16T10:12:02.872Z",
  "policy_id": "8349345c-a6c5-4bf9-8ebb-6bbfc1628715",
  "policyholder_id": "3c74e595-48bc-4dd6-8ac7-2dee1c1f397b",
  "member_id": "673b8081-9668-4136-97cc-6ae0debda083",
  "complaint_status": "open",
  "complainant": {
    "first_name": "Elrich",
    "last_name": "Aviato",
    "cellphone": "+27821234567",
    "email": "elrich@aviato.com"
  },
  "app_data": {
    "key1": "value 1",
    "key2": "value 2"
  },
  "created_by": {
    "id": "00000000-0000-0000-0000-000000000001",
    "type": "user"
  }
}