Skip to navigation
API ReferenceDependents Management Intents

Add dependents to a dependents management intent

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

Authentication

AuthorizationBearer
Authorization header using the Bearer scheme

Path parameters

dependents_management_intent_idstringRequiredformat: "dmi_.+"

Headers

Idempotency-KeystringOptional

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-IdstringOptional

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

This endpoint expects an object.
associated_person_idslist of stringsRequired
List of associated person IDs to add as dependents. Must not be empty.
dependent_coverage_selectionslist of objects or nullOptional
Optional coverage selections per dependent. Keyed by associated person ID.

Response

OK
idstringformat: "dmi_.+"

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

parent_intent_idstring

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

parent_intent_typeenum
The type of parent intent.
Allowed values:
statusenum
Current status of the dependents management intent.
Allowed values:
dependentslist of objects
List of dependents being managed.
planobject
Plan information including pricing details.
disclosureslist of objects
Disclosures associated with this intent.
objectstringOptionalRead-only
Object type identifier.
coverage_optionslist of objects or nullOptional

Available member-scoped coverage options for the plan. Present when the plan has member-scoped coverage configurations.

action_requiredobjectOptional

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
422
Unprocessable Entity Error