Create cover for a plan

POST /api/v1/plans/{plan_uuid}/cover

Personal access token & O auth2

Headers

X-PLANNR-ACCOUNT-UUID string

Path parameters

plan_uuid string Required

application/json

Body Required

client_uuid string

Client who is claiming this cover. Must be able to access this plan. Only for protection policies.
cover_type string Required

Cover type. For protection policies it must be one of asu, additional_rider_benefit, critical_illness, family_income_benefit, income_insurance, life_assurance, tpd_total_permanent_disability, trauma_insurance, waiver_of_premium, unknown. For insurance policies must be one of 3rd_party, 3rd_party_fire_and_theft, accidental_damage, ambulance, buildings, buildings_and_contents, business, comprehensive, contents, dental, extras, hospital_cash, optical, personal_possessions, private, private_hospital, specialist, unknown
benefit_amount integer Required

Benefit amount in pennies. Only for protection policies.
benefit_frequency string Required

Benefit frequency. Only for protection policies.
benefit_status string Required

Benefit status. Only for protection policies. Valid options are: active, inactive and proposed
indexation number Required

Indexation. Only for protection policies.
excess integer Required

Excess amount in pennies. Only for insurance policies.
beneficiaries array[string]

The beneficiaries of the plan.

Responses

201 application/json
Hide response attributes Show response attributes object
- uuid string
  
  The UUID of the resource.
- created_at string
  
  The timestamp of when the resource was created.
- updated_at string
  
  The timestamp of when the resource was updated.
- cover_type string
  
  Cover type
- benefit_amount object
  
  Benefit amount
  
  Hide benefit_amount attributes Show benefit_amount attributes object
  
  amount object
  
  Hide amount attributes Show amount attributes object
  
  example string
  
  description string
  
  formatted object
  
  Hide formatted attributes Show formatted attributes object
  
  example string
  
  description string
  
  currency object
  
  Hide currency attributes Show currency attributes object
  
  example string
  
  description string
- benefit_frequency string
  
  Benefit frequency
- benefit_status string
  
  Benefit status
- excess object
  
  Excess
  
  Hide excess attributes Show excess attributes object
  
  amount object
  
  Hide amount attributes Show amount attributes object
  
  example string
  
  description string
  
  formatted object
  
  Hide formatted attributes Show formatted attributes object
  
  example string
  
  description string
  
  currency object
  
  Hide currency attributes Show currency attributes object
  
  example string
  
  description string
- indexation number
  
  Indexation percentage
- client object
  
  Client this cover is for
  
  Hide client attributes Show client attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  type string
  
  role string
  
  first_name string
  
  last_name string
  
  name string
  
  email string
  
  firm string
  
  primary_phone_number string
  
  primary_email string
  
  current_time_entry string
  
  assigned_adviser string
  
  assigned_administrator string
  
  assigned_paraplanner string
  
  introduced_by string
  
  groups string
  
  tags string
  
  owners string
  
  first_contact_date string
  
  next_review_date string
  
  previous_review_date string
  
  anniversary_review_date string
  
  with_login boolean
  
  has_joint_account boolean
  
  can_be_deleted string
  
  joint_account_circle string
  
  ownership_percentage integer
  
  inactive_at string
  
  custom_fields string
  
  external_references string

POST /api/v1/plans/{plan_uuid}/cover

curl \
 --request POST 'https://api.plannrcrm.com/api/v1/plans/6ff8f7f6-1eb3-3525-be4a-3932c805afed/cover' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"client_uuid":"f234dde3-d580-45f2-9cb4-d657b3aa5d8f","cover_type":"critical_illness","benefit_amount":892176,"benefit_frequency":"monthly","benefit_status":"active","indexation":1.45,"excess":150000,"beneficiaries":[{"name":"John Smith","percentage":50},{"name":"Jane Doe","percentage":20}]}'

Request examples

# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "client_uuid": "f234dde3-d580-45f2-9cb4-d657b3aa5d8f",
  "cover_type": "critical_illness",
  "benefit_amount": 892176,
  "benefit_frequency": "monthly",
  "benefit_status": "active",
  "indexation": 1.45,
  "excess": 150000,
  "beneficiaries": [
    {
      "name": "John Smith",
      "percentage": 50
    },
    {
      "name": "Jane Doe",
      "percentage": 20
    }
  ]
}

Response examples (201)

{
  "uuid": "3b8016f4-1e51-4657-91e4-77010e66fa14",
  "client": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "a68de513-22f8-4a5b-a245-6f45e908c1e8",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-06-26T11:37:07+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-06-26T11:37:07+01:00",
    "with_login": true,
    "inactive_at": "2025-06-26",
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "can_be_deleted": "false",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "next_review_date": "2025-06-26T11:37:07+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-06-26T11:37:07+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "joint_account_circle": "App\\Http\\Resources\\CircleResource",
    "ownership_percentage": 100,
    "previous_review_date": "2025-06-26T11:37:07+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-06-26T11:37:07+01:00"
  },
  "excess": {
    "amount": {
      "example": "10000",
      "description": "Money amount at their lowest denominator (for example: pennies)"
    },
    "currency": {
      "example": "GBP",
      "description": "Currency of the money"
    },
    "formatted": {
      "example": "£100.00",
      "description": "Money amount formatted with currency"
    }
  },
  "cover_type": "critical_illness",
  "created_at": "2025-06-26T11:37:07+01:00",
  "indexation": 1.4,
  "updated_at": "2025-06-26T11:37:07+01:00",
  "benefit_amount": {
    "amount": {
      "example": "25000000",
      "description": "Money amount at their lowest denominator (for example: pennies)"
    },
    "currency": {
      "example": "GBP",
      "description": "Currency of the money"
    },
    "formatted": {
      "example": "£250,000.00",
      "description": "Money amount formatted with currency"
    }
  },
  "benefit_status": "active",
  "benefit_frequency": "monthly"
}