Create a dependents management intent for an enrolment intent
Creates a dependents management intent as a sub-intent of an enrolment intent. The enrolment intent must be in pending_confirmation status.
Authentication
AuthorizationBearer
Authorization header using the Bearer scheme
Path parameters
enrolment_intent_id
Response
OK
id
Unique identifier for the dependents management intent. Prefixed with dmi_.
parent_intent_id
The parent intent ID (e.g. Policy Amendment Intent ID). Prefixed based on type.
parent_intent_type
The type of parent intent.
Allowed values:
status
Current status of the dependents management intent.
Allowed values:
dependents
List of dependents being managed.
plan
Plan information including pricing details.
disclosures
Disclosures associated with this intent.
object
Object type identifier.
coverage_options
Available member-scoped coverage options for the plan. Present when the plan has member-scoped coverage configurations.
action_required
Details of the action required from the caller. Populated only when status is action_required and a required action has been recorded on the intent (e.g. restricted dependents detected by compliance screening).
Errors
400
Bad Request Error
404
Not Found Error

