Sign in

v2

latestOpenAPI 3.1.12026-08-0785394779.1 KB
Enrolment Intents

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.

post/enrolment_intents/{enrolment_intent_id}/create_dependents_management_intent

Path parameters

enrolment_intent_idstring required
Example:ei_3b1333d87d9d4fd6ad83ba7f6b0e951a

Headers

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.

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