Sign in
latestOpenAPI 3.1.12026-08-1585397785.9 KB

85bb8b3c42b4

Dependents Management Intents

Add dependents to a dependents management intent

Adds one or more existing associated persons as dependents to a dependents management intent.

post/dependents_management_intents/{dependents_management_intent_id}/dependents

Path parameters

dependents_management_intent_idstring required
Example:dmi_3b1333d87d9d4fd6ad83ba7f6b0e951a

Headers

Idempotency-Keystring

Unique key to ensure idempotent requests. If the same key is used for multiple identical & successful requests, the same response will be returned. Read more here

X-Platform-Idstring

The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.

Request body

associated_person_idsstring[] required

List of associated person IDs to add as dependents. Must not be empty.

Example request

{
  "associated_person_ids": [
    "ap_3b1333d87d9d4fd6ad83ba7f6b0e951a"
  ],
  "dependent_coverage_selections": [
    {
      "associated_person_id": "ap_3b1333d87d9d4fd6ad83ba7f6b0e951a",
      "coverage_selections": [
        {
          "configuration_id": "pc_3b1333d87d9d4fd6ad83ba7f6b0e951a",
          "options": [
            {
              "option_id": "pco_3b1333d87d9d4fd6ad83ba7f6b0e951a"
            }
          ]
        }
      ]
    }
  ]
}

Response

OK

idstring required

Unique identifier for the dependents management intent. Prefixed with dmi_.

objectstring

Object type identifier.

parent_intent_idstring required

The parent intent ID (e.g. Policy Amendment Intent ID). Prefixed based on type.

parent_intent_type'policy_amendment_intent' | 'enrolment_intent' required
status'action_required' | 'processing' | 'completed' | 'not_undertaken' required

Example response

{
  "id": "dmi_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "dependents": [
    {
      "associated_person_id": "ap_3b1333d87d9d4fd6ad83ba7f6b0e951a",
      "coverage_selections": [
        {
          "configuration_id": "pc_3b1333d87d9d4fd6ad83ba7f6b0e951a",
          "options": [
            {
              "option_id": "pco_3b1333d87d9d4fd6ad83ba7f6b0e951a"
            }
          ]
        }
      ],
      "requirement_id": "ar_3b1333d87d9d4fd6ad83ba7f6b0e951a"
    }
  ],
  "plan": {
    "id": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a",
    "pricing": {
      "per_member": {
        "member_type_pricing": [
          {
            "monthly_premium": 123.45
          }
        ]
      },
      "tier_based": {
        "tiers": [
          {
            "monthly_premium": 123.45,
            "annual_premium": 123.45
          }
        ]
      }
    }
  },
  "coverage_options": [
    {
      "id": "pc_3b1333d87d9d4fd6ad83ba7f6b0e951a",
      "required": true,
      "options": [
        {
          "id": "pco_3b1333d87d9d4fd6ad83ba7f6b0e951a"
        }
      ]
    }
  ],
  "action_required": {
    "due_by": "2024-12-01T00:00:00Z"
  }
}