Create cover for a plan

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

Headers

Path parameters

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

POST /api/v1/plans/{plan_uuid}/cover 
curl \
 -X POST https://api.plannrcrm.com/api/v1/plans/plan_uuid/cover \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 -d '{"client_uuid":"48207f33-ed2c-4839-a72f-10a0b45506ef","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
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "client_uuid": "48207f33-ed2c-4839-a72f-10a0b45506ef",
  "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": "0c363824-edcb-4a19-b72d-99a41b90d048",
  "client": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "91274ebf-aa62-45e0-b864-e1f7035c7836",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-01-17T11:18:31+00:00",
    "first_name": "Gareth",
    "updated_at": "2025-01-17T11:18:31+00:00",
    "with_login": true,
    "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-01-17T11:18:31+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-01-17T11:18:31+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2025-01-17T11:18:31+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-01-17T11:18:31+00: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-01-17T11:18:31+00:00",
  "indexation": 1.4,
  "updated_at": "2025-01-17T11:18:31+00: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"
}