API ReferencePolicy Amendment Intents

Create a dependents management intent for a policy amendment

Creates a dependents management intent as a sub-intent of a policy amendment intent. The sub-intent allows the platform to add or remove dependents from the policy. The policy amendment intent must be in action_required status with a dependents requested change.

Authentication

AuthorizationBearer
Authorization header using the Bearer scheme

Path parameters

policy_idstringRequiredformat: "p_.+"
idstringRequiredformat: "pai_.+"

Headers

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.

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.
statusenum
Current status of the dependents management intent.
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