Lifecycle Actions
Manage consumer lifecycle transitions and benefit coverage updates. Lifecycle Actions provide a robust, discovery-driven framework for handling complex offboarding events and mid-year coverage changes. By combining impact analysis, synchronous execution, and asynchronous status tracking, these resources ensure that transitions—such as ending consumer benefit coverage—are accurate, transparent, and compliant with plan rules. Use these tools to automate the complexities of plan bundles, dependent coverage loss, and prorated financial adjustments while maintaining a clear audit trail of all lifecycle events.
Core Termination Services
Discovery: Get Termination Form Data
The Discovery endpoint acts as the prerequisite for any offboarding workflow by retrieving a “menu” of valid options tailored to a specific consumer.
-
Menu Retrieval: Dynamically obtain available_plans, available_bundles, and reason_codes to populate administrative interfaces.
-
Date Validation: Access the
valid_termination_dateslist to ensure the selected date adheres to business rules and plan configurations.
Execution & Impact Analysis (Requests)
The Termination Request engine is the central component for both simulating and committing coverage changes.
-
Impact Analysis (Preview Mode): Use
PREVIEWmode to perform a “dry-run” analysis, which identifiesaffected_dependentslosing coverage and thefinancial_impactof prorated refunds or premium adjustments. -
Commitment (Execute Mode): Transition to
EXECUTEmode to finalize the offboarding process and commit changes. -
Processing Strategies: Choose
SYNCHRONOUSfor immediate results orASYNCHRONOUSto queue high-volume requests for background processing.
Tracking & Auditing
Maintain full visibility into the lifecycle process with dedicated status and history endpoints.
-
Request Tracking: Poll for the status of asynchronous requests to monitor transitions through PENDING, PROCESSING, COMPLETED, or FAILED states.
-
Lifecycle Auditing: Retrieve a paginated list of all historical termination activity for a specific consumer.
Integration Standards
Scopes & Permissions
Lifecycle operations require specific administrative authorizations:
| Scope | Description | Required For |
| read:termination | View eligibility, form data, and request history | GET operations |
| write:termination | Execute or Preview termination requests | POST operations |
Operational Guardrails
-
Retry Safety: All
POSTrequests require anIdempotency-Key(UUID) to ensure the termination is not processed twice if a timeout occurs. -
Organizational Context: Requests must include a
Business-Entity-Id(Max 50 characters) that matches the consumer’s organizational context. -
Standardized Formats: Dates follow ISO 8601 (
YYYY-MM-DD) , and processing timestamps utilize RFC 3339 in UTC. -
Request Identification: Generated Request IDs follow the specific pattern ^REQ-\d{4}-\d{6}$.
Global Error Reference
| Status Code | Meaning | Resolution |
| 400 | Bad Request | Verify UUID formats and ensure the selected date is in the valid_termination_dates list. |
| 403 | Forbidden | Ensure the Business-Entity-Id matches the consumer's organization. |
| 409 | Conflict | Occurs when the Idempotency-Key is reused with different request parameters. |
| 422 | Unprocessable Entity | Indicates a business rule violation, such as terminating a plan that is already closed. |
Endpoints
v1/termination-requests